(abstract) new HD(options)
HD - Abstract class for HD keys. Will potentially return an HDPublicKey or HDPrivateKey.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object | HDPublicKey or HDPrivateKey options. |
- Source:
Methods
(static) fromBase58(xkey) → {HDPrivateKey|HDPublicKey}
Instantiate an HD key (public or private) from an base58 string.
Parameters:
| Name | Type | Description |
|---|---|---|
xkey |
Base58String |
- Source:
Returns:
- Type
- HDPrivateKey | HDPublicKey
(static) fromSeed(options, networkTypenullable) → {HDPrivateKey}
Generate an HDPrivateKey from a seed.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
Object | HDSeed | HD seed or HD seed options. |
|
networkType |
String |
<nullable> |
- Source:
Returns:
- Type
- HDPrivateKey
(static) generate(options, networkTypenullable) → {HDPrivateKey}
Generate an HDPrivateKey.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Properties
|
|||||||||||||
networkType |
String |
<nullable> |
- Source:
Returns:
- Type
- HDPrivateKey
(static) isHD(obj) → {Boolean}
Test an object to see if it is an HD key.
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
Object |
- Source:
Returns:
- Type
- Boolean