dashphrase-cli

1.0.4 • Public • Published

DashPhrase CLI

A Recovery Phrase generator for Mac, Linux, & Windows
(BIP-39 "mnemonic" compliant)

Production-ready reference implementation built with DASH SDK Core.

dashphrase generate -o ./words.txt
cat swing flag economy stadium alone churn speed unique patch report train
dashphrase seed ./words.txt "" -o ./seed.hex
7ea73b3a398f8a71f7dde589d972b0358d3fa8b9e91317ecc544e42752b1bb251a1926b1f4c69eec0a80c0396aa0f7df29f7d73411d3106eba539f3d584fcdf8

Use for anything that needs entropy that can be communicated over the phone,
or printed and stored in a safe place.

(this is what a cryptocurrency "Wallet" is, by the way - just 12 words)

Developed for (but not specific to) DASH.

Table of Contents

  • Install
  • Usage
    • help
  • Test Values
    • Zoomonic (easy-to-remember)
    • Catmonic (pleasant, looks random)
  • JavaScript SDK
  • License

Install

  1. Install node.js

    # Mac, Linux
    curl -sS https://webi.sh/node | sh
    source ~/.config/envman/PATH.env
    # Windows
    curl.exe https://webi.ms/node | powershell
  2. Install dashphrase-cli

    npm install --location=global dashphrase-cli@1
  3. Use the dashphrase command to generate recovery phrases (mnemonics)

    dashphrase generate -o ./words.txt
    

Usage

You can generate a recovery phrase

dashphrase generate [-o ./words.txt]

And convert it into a seed (e.g. for DashHD or DashWallet)

dashphrase seed <./words.txt> <./secret.txt> [-o ./seed.hex]

Help

See the latest help:

dashphrase help

It's probably still pretty close to this:

dashphrase-cli v1.0.0 SDK v1.3.5

USAGE:
    dashphrase <subcommand> [...]

EXAMPLES:
    dashphrase gen --bits 128 -o ./words.txt
    dashphrase decode ./words.txt -o ./entropy.hex
    dashphrase encode ./entropy.hex -o ./words.txt
    dashphrase seed ./words.txt "" -o ./seed.hex

SUBCOMMANDS:
    gen|generate [--bits 128] [-o ./words.txt]
    decode                    <./words.txt> [-o ./entropy.hex]
    encode                    <./entropy.hex> [-o ./words.txt]
    seed        [--no-verify] <./words.txt> <./secret.txt> [-o seed.hex]
    zoomonic                  [secret-salt]   prints zoomonic & seed
    catmonic                  [secret-salt]   prints catmonic & seed

    help
    version

TEST VALUES:

    Catmonic:
      cat swing flag economy stadium alone churn speed unique patch report train

    Zoomonic: zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong
    Zecret:   TREZOR
    Zeed:
      ac27495480225222079d7be181583751e86f571027b0497b5b5d11218e0a8a13332572917f0f8e5a589620c6f15b11c61dee327651a14c34e18231052e48c069

Test Values

These are values for use in documentation, examples, test fixtures, debugging, etc

Zoomonic

Words:

zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong

(easy to remember because it's a zoo, and the checksum is wrong)

Seed (Zeed), using "TREZOR" as secret salt:

ac27495480225222079d7be181583751e86f571027b0497b5b5d11218e0a8a13332572917f0f8e5a589620c6f15b11c61dee327651a14c34e18231052e48c069

Catmonic

Words:

cat swing flag economy stadium alone churn speed unique patch report train

Catmonic Seed, with empty ("") secret salt:

7ea73b3a398f8a71f7dde589d972b0358d3fa8b9e91317ecc544e42752b1bb251a1926b1f4c69eec0a80c0396aa0f7df29f7d73411d3106eba539f3d584fcdf8

DashPhrase JavaScript SDK

DashPhrase CLI was created to make it easier for developers to get involved in developing apps for themselves and online merchants using DASH.

It is part of the DASH SDK Core, which is a suite of ready-for-production-use reference implementations in JavaScript.

License

MIT License

Copyright (c) 2023 AJ ONeal
Copyright (c) 2023 Dash Incubator

Package Sidebar

Install

npm i dashphrase-cli

Weekly Downloads

1

Version

1.0.4

License

SEE LICENSE IN LICENSE

Unpacked Size

17.8 kB

Total Files

5

Last publish

Collaborators

  • jojobyte
  • coolaj86