Skip to content

Commit 1afcb6c

Browse files
author
AJ ONeal
committed
doc: Passphrase => Recovery Phrase
1 parent 33dc5a1 commit 1afcb6c

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ HD Wallet Seed: ac27495480225222079d7be181583751e86f571027b0497b5b5d11218e0a8a1
6262
- DashHd derivations & encodings
6363
- HD Key Types
6464
- [Tutorial Walkthrough](#walkthrough)
65-
- Passphrase, Secret, Seed
65+
- Recovery Phrase, Secret, Seed
6666
- Wallet Derivation
6767
- HD Path Derivation
6868
- _Wallet_, _Account_, and _X Key_ Derivation
@@ -162,7 +162,7 @@ let DashPhrase = window.DashPhrase;
162162

163163
However, production code will look more like this:
164164

165-
1. Get a _Seed_ from the user's _Passphrase Mnemonic_ and _Secret Salt_
165+
1. Get a _Seed_ from the user's _Recovery Phrase_ and _Secret Salt_
166166
167167
```js
168168
let wordList = "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong";
@@ -173,7 +173,7 @@ However, production code will look more like this:
173173
```
174174
175175
2. Derive a _Wallet_, _Account_, and _X Key_, if possible. \
176-
(reject the _Passphrase_ or _Seed_ if _Account_ index 0 is not valid)
176+
(reject the _Recovery Phrase_ or _Seed_ if _Account_ index 0 is not valid)
177177
178178
```js
179179
let accountIndex = 0;
@@ -187,7 +187,7 @@ However, production code will look more like this:
187187
void (await accountKey.deriveXKey(DashHd.CHANGE));
188188
xprvKey = await accountKey.deriveXKey(DashHd.RECEIVE);
189189
} catch (e) {
190-
window.alert("Error: The passphrase can't generate a valid 1st account!");
190+
window.alert("Error: The recovery phrase can't generate a valid 1st account!");
191191
}
192192
```
193193
@@ -862,16 +862,16 @@ than the root).
862862
This will focus on the **most typical** use case, where you intend to generate
863863
**multiple addresses** as part of your application's lifecycle.
864864
865-
## Part 1: Passphrase, Secret, Seed
865+
## Part 1: Recovery Phrase, Secret, Seed
866866
867-
The Passphrase (or Seed), **is** the Wallet.
867+
The Recovery Phrase (or Seed), **is** the Wallet.
868868
869869
- A _Wallet_ is derived from a _Seed_.
870-
- A _Seed_ is typically derived from a _Passphrase Mnemonic_ and _Secret Salt_.
870+
- A _Seed_ is typically derived from a _Recovery Phrase_ and _Secret Salt_.
871871
872872
From a code perspective:
873873
874-
1. If your user doesn't supply a _Passphrase Mnemonic_, you can generate one:
874+
1. If your user doesn't supply a _Recovery Phrase_, you can generate one:
875875
```js
876876
let targetBitEntropy = 128;
877877
let wordList = await DashPhrase.generate(targetBitEntropy);
@@ -887,18 +887,18 @@ From a code perspective:
887887
let wordList = "zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong";
888888
let secretSalt = "TREZOR";
889889
```
890-
4. _Key Expansion_ derives the _Seed_ from the _Passphrase_ + _Secret_ \
890+
4. _Key Expansion_ derives the _Seed_ from the _Recovery Phrase_ + _Secret_ \
891891
(FYI: it's a specific configuration of PBKDF2 under the hood)
892892
```js
893893
let seedBytes = await DashPhrase.toSeed(wordList, secretSalt);
894894
```
895895
896-
Prompt the user **to make a backup** of their _Passphrase_. \
897-
(or their _Seed_, if you're not implementing *Passphrase*s)
896+
Prompt the user **to make a backup** of their _Recovery Phrase_. \
897+
(or their _Seed_, if you're not implementing *Recovery Phrase*s)
898898
899899
It's common to print this out and put it in a safe.
900900
901-
If the **_Passphrase_ is lost**, the Wallet (and all money) is
901+
If the **_Recovery Phrase_ is lost**, the Wallet (and all money) is
902902
**unrecoverable**.
903903
904904
## Part 2: The Wallet Derivation
@@ -916,10 +916,10 @@ nonetheless.
916916
try {
917917
walletKey = await DashHd.fromSeed(seedBytes);
918918
} catch (e) {
919-
window.alert("the passphrass (or seed) could not be used to derive keys");
919+
window.alert("the recovery phrase (or seed) could not be used to derive keys");
920920
}
921921
```
922-
2. Notify the user and retry a different Passphrase on failure.
922+
2. Notify the user and retry a different Recovery Phrase on failure.
923923
924924
### Part 2a: HD Path Derivation
925925
@@ -1044,7 +1044,7 @@ See also [Dash Tools Glossary](https://github.com/dashhive/dash-tools#glossary).
10441044
- [HD Account](#hd-account)
10451045
- [HD Address Key](#hd-address-key)
10461046
- [HD Keys](#hd-keys)
1047-
- [HD Passphrase Mnemonic](#hd-passphrase-mnemonic)
1047+
- [HD Recovery Phrase](#hd-recovery-phrase)
10481048
- [HD Path](#hd-path)
10491049
- [HD Wallet](#hd-wallet)
10501050
- [HD X Key](#hd-x-key)
@@ -1068,7 +1068,7 @@ If you use 2048 words, each word represents 11 _bits_. \
10681068
12 words represent 131 _bits_ of information. \
10691069
Any extra bits are used for checksumming the data. \
10701070
1071-
See [_HD Passphrase Mnemonic_](#hd-passphrase-mnemonic).
1071+
See [_HD Recovery Phrase_](#hd-recovery-phrase).
10721072
10731073
## Base58Check
10741074
@@ -1098,7 +1098,7 @@ See [_HD Keys_](#hd-keys).
10981098
10991099
Also: Base2048, _BIP39_, _BIP-0039_
11001100
1101-
BIP for [_HD Passphrase Mnemonic_](#hd-passphrase-mnemonic).
1101+
BIP for [_HD Recovery Phrase_](#hd-recovery-phrase).
11021102
11031103
## BIP-43
11041104
@@ -1150,7 +1150,7 @@ Usually intentionally slow. \
11501150
May run a high number of "Rounds" in succession. \
11511151
(typically hundreds or thousands).
11521152
1153-
_Passhrase Mnemonics_ to _Seed_ (BIP-39) uses _PBKDF2_. \
1153+
_Recovery Phrase_ to _Seed_ (BIP-39) uses _PBKDF2_. \
11541154
_HD Keys_ (BIP-44) use HMAC and *Secp256k1 Tweak*ing for each index.
11551155
11561156
See also:
@@ -1182,7 +1182,7 @@ Any of generic or purpose-specific keys derived deterministically form a seed.
11821182
11831183
See more at [API: Key Types](#key-types) (code above) and [HD Path](#hd-path).
11841184
1185-
## HD Passphrase Mnemonic
1185+
## HD Recovery Phrase
11861186
11871187
Also: _Recovery Phrase_, _Mnemonic for Generating Hierarchical Deterministic
11881188
Keys_, _HD Wallet_, _BIP-39_
@@ -1250,7 +1250,7 @@ Also: Master Seed, Seed, HD Seed
12501250
Either:
12511251
12521252
- 64 random bytes
1253-
- a 64-byte hash derived from a _Passphrase Mnemonic_
1253+
- a 64-byte hash derived from a _Recovery Phrase_
12541254
12551255
**Cannot be reversed**.
12561256
@@ -1335,9 +1335,9 @@ ac27495480225222079d7be181583751e86f571027b0497b5b5d11218e0a8a13332572917f0f8e5a
13351335
## Zoomonic
13361336
13371337
```txt
1338-
Passphrase (Mnemonic) : zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong
1339-
Secret (Salt Password) : TREZOR
1340-
Seed : ac27495480225222079d7be181583751e86f571027b0497b5b5d11218e0a8a13332572917f0f8e5a589620c6f15b11c61dee327651a14c34e18231052e48c069
1338+
Recovery Phrase (Mnemonic) : zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong
1339+
Secret (Salt Password) : TREZOR
1340+
Seed : ac27495480225222079d7be181583751e86f571027b0497b5b5d11218e0a8a13332572917f0f8e5a589620c6f15b11c61dee327651a14c34e18231052e48c069
13411341
```
13421342
13431343
# References

0 commit comments

Comments
 (0)