JSDoc: Class: PrivateKey

Constructor

new PrivateKey(optionsopt)

Create an hd private key.

Parameters:

Name	Type	Attributes	Description
`options`	HDPrivateKeyOptions	<optional>

Properties:

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

Source:

hd/private.js, line 53

Methods

(static) fromBase58(xkey, networkopt, nullable) → {HDPrivateKey}

Instantiate an HD private key from a base58 string.

Parameters:

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

Source:

hd/private.js, line 634

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 535

Returns:

Type: HDPrivateKey

(static) fromMnemonic(mnemonic, passphraseopt, nullable) → {HDPrivateKey}

Instantiate an hd private key from a mnemonic.

Parameters:

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

Source:

hd/private.js, line 484

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 505

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 462

Returns:

Type: HDPrivateKey

(static) generate() → {HDPrivateKey}

Generate an hd private key.

Source:

hd/private.js, line 544

Returns:

Type: HDPrivateKey

(static) isBase58(data, networkopt, nullable) → {Boolean}

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

Parameters:

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

Source:

hd/private.js, line 296

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 670

Returns:

Type: Boolean

(static) isRaw(data, networkopt, nullable) → {Boolean}

Test whether a buffer has a valid network prefix.

Parameters:

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

Source:

hd/private.js, line 320

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 343

Returns:

Type: Boolean

compare(key) → {Number}

Compare a key against an object.

Parameters:

Name	Type	Description
`key`	HDPrivateKey

Source:

hd/private.js, line 393

Returns:

Type: Number

derive(index, hardenedopt, nullable) → {HDPrivateKey}

Derive a child key.

Parameters:

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

Source:

hd/private.js, line 172

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 259

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 359

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 147

equals(obj) → {Boolean}

Compare a key against an object.

Parameters:

Name	Type	Description
`obj`	HDPrivateKey

Source:

hd/private.js, line 377

Returns:

Type: Boolean

(private) fromBase58(xkey, networkopt, nullable)

Inject properties from base58 key.

Parameters:

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

Source:

hd/private.js, line 557

fromJSON(json, networkopt, nullable)

Inject properties from json object.

Parameters:

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

Source:

hd/private.js, line 656

(private) fromKey(key, entropy)

Inject properties from privateKey and entropy.

Parameters:

Name	Type	Description
`key`	Buffer
`entropy`	Buffer

Source:

hd/private.js, line 516

fromMnemonic(mnemonic, passphraseopt, nullable)

Inject properties from a mnemonic.

Parameters:

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

Source:

hd/private.js, line 472

fromOptions(options)

Inject properties from options object.

Parameters:

Name	Type	Description
`options`	HDPrivateKeyOptions

Source:

hd/private.js, line 83

fromPhrase(phrase)

Inject properties from a mnemonic.

Parameters:

Name	Type	Description
`phrase`	String

Source:

hd/private.js, line 493

(private) fromSeed(seed)

Inject properties from seed.

Parameters:

Name	Type	Description
`seed`	Buffer

Source:

hd/private.js, line 430

(private) getID(index) → {String}

Unique HD key ID.

Parameters:

Name	Type	Description
`index`	Number

Source:

hd/private.js, line 246

Returns:

Type: String

getJSON(networkopt, nullable) → {Object}

Convert key to a more json-friendly object.

Parameters:

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

Source:

hd/private.js, line 644

Returns:

Type: Object

getSize() → {Number}

Calculate serialization size.

Source:

hd/private.js, line 601

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 285

Returns:

Type: Boolean

isMaster() → {Boolean}

Test whether the key is a master key.

Source:

hd/private.js, line 275

Returns:

Type: Boolean

read(br, networkopt, nullable)

Inject properties from serialized data.

Parameters:

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

Source:

hd/private.js, line 568

toBase58(networknullable) → {Base58String}

Serialize key to a base58 string.

Parameters:

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

Source:

hd/private.js, line 592

Returns:

Type: Base58String

toPublic() → {HDPublicKey}

Get HD public key.

Source:

hd/private.js, line 106

Returns:

Type: HDPublicKey

write(bw, networkopt, nullable) → {BufioWriter}

Write the key to a buffer writer.

Parameters:

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

Source:

hd/private.js, line 612

Returns:

Type: BufioWriter

xprivkey(networkopt, nullable) → {Base58String}

Get cached base58 xprivkey.

Parameters:

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

Source:

hd/private.js, line 128

Returns:

Type: Base58String

xpubkey(networkopt, nullable) → {Base58String}

Get cached base58 xpubkey.

Parameters:

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

Source:

hd/private.js, line 138

Returns:

Type: Base58String