JSDoc: Class: HDPrivateKey

Constructor

new HDPrivateKey(options)

Create an hd private key.

Parameters:

Name Type Description

options

Object | String

Properties

Name	Type	Attributes
`depth`	Number	<nullable>
`parentFingerPrint`	Number	<nullable>
`childIndex`	Number	<nullable>
`chainCode`	Buffer	<nullable>
`privateKey`	Buffer	<nullable>

Properties:

Name	Type	Description
`depth`	Number
`parentFingerPrint`	Number
`childIndex`	Number
`chainCode`	Buffer
`privateKey`	Buffer

Source:

hd/private.js, line 52

Methods

(static) fromBase58(xkey, networknullable) → {HDPrivateKey}

Instantiate an HD private key from a base58 string.

Parameters:

Name	Type	Attributes	Description
`xkey`	Base58String
`network`	Network	<nullable>

Source:

hd/private.js, line 650

Returns:

Type: HDPrivateKey

(static) fromJSON(json, networknullable) → {HDPrivateKey}

Instantiate an HDPrivateKey from a jsonified key object.

Parameters:

Name	Type	Attributes	Description
`json`	Object		The jsonified key object.
`network`	Network	<nullable>

Source:

hd/private.js, line 709

Returns:

Type: HDPrivateKey

(static) fromKey(key, entropy) → {HDPrivateKey}

Create an hd private key from a key and entropy bytes.

Parameters:

Name	Type	Description
`key`	Buffer
`entropy`	Buffer

Source:

hd/private.js, line 530

Returns:

Type: HDPrivateKey

(static) fromMnemonic(mnemonic, passphrasenullable) → {HDPrivateKey}

Instantiate an hd private key from a mnemonic.

Parameters:

Name	Type	Attributes	Description
`mnemonic`	Mnemonic
`passphrase`	String	<nullable>

Source:

hd/private.js, line 478

Returns:

Type: HDPrivateKey

(static) fromOptions(options) → {HDPrivateKey}

Instantiate HD private key from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

hd/private.js, line 98

Returns:

Type: HDPrivateKey

(static) fromPhrase(phrase) → {HDPrivateKey}

Instantiate an hd private key from a phrase.

Parameters:

Name	Type	Description
`phrase`	String

Source:

hd/private.js, line 500

Returns:

Type: HDPrivateKey

(static) fromRaw(data, networknullable) → {HDPrivateKey}

Instantiate key from serialized data.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer
`network`	Network \| NetworkType	<nullable>

Source:

hd/private.js, line 672

Returns:

Type: HDPrivateKey

(static) fromReader(br, networknullable) → {HDPrivateKey}

Instantiate key from buffer reader.

Parameters:

Name	Type	Attributes	Description
`br`	BufferReader
`network`	Network \| NetworkType	<nullable>

Source:

hd/private.js, line 661

Returns:

Type: HDPrivateKey

(static) fromSeed(seed) → {HDPrivateKey}

Instantiate an hd private key from a 512 bit seed.

Parameters:

Name	Type	Description
`seed`	Buffer

Source:

hd/private.js, line 455

Returns:

Type: HDPrivateKey

(static) generate() → {HDPrivateKey}

Generate an hd private key.

Source:

hd/private.js, line 539

Returns:

Type: HDPrivateKey

(static) isBase58(data, networknullable) → {Boolean}

Test whether an object is in the form of a base58 xprivkey.

Parameters:

Name	Type	Attributes	Description
`data`	String
`network`	Network	<nullable>

Source:

hd/private.js, line 290

Returns:

Type: Boolean

(static) isHDPrivateKey(obj) → {Boolean}

Test whether an object is an HDPrivateKey.

Parameters:

Name	Type	Description
`obj`	Object

Source:

hd/private.js, line 719

Returns:

Type: Boolean

(static) isRaw(data, networknullable) → {Boolean}

Test whether a buffer has a valid network prefix.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer
`network`	Network	<nullable>

Source:

hd/private.js, line 314

Returns:

Type: Boolean

(static) isValidPath(path) → {Boolean}

Test whether a string is a valid path.

Parameters:

Name	Type	Description
`path`	String

Source:

hd/private.js, line 337

Returns:

Type: Boolean

compare(obj) → {Boolean}

Compare a key against an object.

Parameters:

Name	Type	Description
`obj`	Object

Source:

hd/private.js, line 386

Returns:

Type: Boolean

derive(index, hardenednullable) → {HDPrivateKey}

Derive a child key.

Parameters:

Name	Type	Attributes	Description
`index`	Number		Derivation index.
`hardened`	Boolean	<nullable>	Whether the derivation should be hardened.

Source:

hd/private.js, line 171

Returns:

Type: HDPrivateKey

deriveAccount(purpose, type, account) → {HDPrivateKey}

Derive a BIP44 account key.

Parameters:

Name	Type	Description
`purpose`	Number
`type`	Number
`account`	Number

Source:

hd/private.js, line 253

Throws:

Error if key is not a master key.

Returns:

Type: HDPrivateKey

derivePath(path) → {HDPrivateKey}

Derive a key from a derivation path.

Parameters:

Name	Type	Description
`path`	String

Source:

hd/private.js, line 353

Throws:

Error if path is not a valid path.

Returns:

Type: HDPrivateKey

destroy(pub)

Destroy the key (zeroes chain code, privkey, and pubkey).

Parameters:

Name	Type	Description
`pub`	Boolean	Destroy hd public key as well.

Source:

hd/private.js, line 146

equals(obj) → {Boolean}

Compare a key against an object.

Parameters:

Name	Type	Description
`obj`	Object

Source:

hd/private.js, line 370

Returns:

Type: Boolean

(private) fromBase58(xkey, networknullable)

Inject properties from base58 key.

Parameters:

Name	Type	Attributes	Description
`xkey`	Base58String
`network`	Network	<nullable>

Source:

hd/private.js, line 552

(private) fromJSON(json, networknullable)

Inject properties from json object.

Parameters:

Name	Type	Attributes	Description
`json`	Object
`network`	Network	<nullable>

Source:

hd/private.js, line 694

(private) fromKey(key, entropy)

Inject properties from privateKey and entropy.

Parameters:

Name	Type	Description
`key`	Buffer
`entropy`	Buffer

Source:

hd/private.js, line 511

(private) fromMnemonic(mnemonic, passphrasenullable)

Inject properties from a mnemonic.

Parameters:

Name	Type	Attributes	Description
`mnemonic`	Mnemonic
`passphrase`	String	<nullable>

Source:

hd/private.js, line 466

(private) fromOptions(options)

Inject properties from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

hd/private.js, line 74

(private) fromPhrase(mnemonic)

Inject properties from a mnemonic.

Parameters:

Name	Type	Description
`mnemonic`	String

Source:

hd/private.js, line 488

(private) fromRaw(data, networknullable)

Inject properties from serialized data.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer
`network`	Network \| NetworkType	<nullable>

Source:

hd/private.js, line 589

(private) fromReader(br, networknullable)

Inject properties from serialized data.

Parameters:

Name	Type	Attributes	Description
`br`	BufferReader
`network`	Network \| NetworkType	<nullable>

Source:

hd/private.js, line 564

(private) fromSeed(seed)

Inject properties from seed.

Parameters:

Name	Type	Description
`seed`	Buffer

Source:

hd/private.js, line 423

(private) getID(index) → {String}

Unique HD key ID.

Parameters:

Name	Type	Description
`index`	Number

Source:

hd/private.js, line 240

Returns:

Type: String

getSize() → {Number}

Calculate serialization size.

Source:

hd/private.js, line 608

Returns:

Type: Number

isAccount(accountnullable) → {Boolean}

Test whether the key is (most likely) a BIP44 account key.

Parameters:

Name	Type	Attributes	Description
`account`	Number	<nullable>

Source:

hd/private.js, line 279

Returns:

Type: Boolean

isMaster() → {Boolean}

Test whether the key is a master key.

Source:

hd/private.js, line 269

Returns:

Type: Boolean

toBase58(networknullable) → {Base58String}

Serialize key to a base58 string.

Parameters:

Name	Type	Attributes	Description
`network`	Network \| NetworkType	<nullable>

Source:

hd/private.js, line 599

Returns:

Type: Base58String

toJSON() → {Object}

Convert key to a more json-friendly object.

Source:

hd/private.js, line 681

Returns:

Type: Object

toPublic() → {HDPublicKey}

Get HD public key.

Source:

hd/private.js, line 107

Returns:

Type: HDPublicKey

toRaw(networknullable) → {Buffer}

Serialize the key.

Parameters:

Name	Type	Attributes	Description
`network`	Network \| NetworkType	<nullable>

Source:

hd/private.js, line 639

Returns:

Type: Buffer

toWriter(bw, networknullable)

Write the key to a buffer writer.

Parameters:

Name	Type	Attributes	Description
`bw`	BufferWriter
`network`	Network \| NetworkType	<nullable>

Source:

hd/private.js, line 618

xprivkey() → {Base58String}

Get cached base58 xprivkey.

Source:

hd/private.js, line 128

Returns:

Type: Base58String

xpubkey() → {Base58String}

Get cached base58 xpubkey.

Source:

hd/private.js, line 137

Returns:

Type: Base58String