JSDoc: Class: PrivateKey

new PrivateKey(options)

HDPrivateKey

Parameters:

Name Type Description

options

Object | Base58String

Properties

Name	Type	Attributes	Description
`xkey`	Base58String	<nullable>	Serialized base58 key.
`mnemonic`	Mnemonic	<nullable>
`depth`	Number	<nullable>
`parentFingerPrint`	Buffer	<nullable>
`childIndex`	Number	<nullable>
`chainCode`	Buffer	<nullable>
`privateKey`	Buffer	<nullable>

Properties:

Name	Type	Attributes
`network`	Network
`mnemonic`	Mnemonic	<nullable>
`depth`	Number
`parentFingerPrint`	Buffer
`childIndex`	Number
`chainCode`	Buffer
`privateKey`	Buffer

Source:

hd/private.js, line 45

Methods

(static) fromBase58(xkey) → {HDPrivateKey}

Instantiate an HD private key from a base58 string.

Parameters:

Name	Type	Description
`xkey`	Base58String

Source:

hd/private.js, line 819

Returns:

Type: HDPrivateKey

(static) fromExtended(data) → {HDPrivateKey}

Instantiate key from "extended" serialized data.

Parameters:

Name	Type	Description
`data`	Buffer

Source:

hd/private.js, line 809

Returns:

Type: HDPrivateKey

(static) fromExtendedReader(br) → {HDPrivateKey}

Instantiate key from "extended" buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

hd/private.js, line 799

Returns:

Type: HDPrivateKey

(static) fromJSON(json) → {HDPrivateKey}

Instantiate an HDPrivateKey from a jsonified key object.

Parameters:

Name	Type	Description
`json`	Object	The jsonified key object.

Source:

hd/private.js, line 878

Returns:

Type: HDPrivateKey

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

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

Parameters:

Name	Type	Attributes
`key`	Buffer
`entropy`	Buffer
`network`	Network \| NetworkType	<nullable>

Source:

hd/private.js, line 598

Returns:

Type: HDPrivateKey

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

Instantiate an hd private key from a mnemonic.

Parameters:

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

Source:

hd/private.js, line 565

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 113

Returns:

Type: HDPrivateKey

(static) fromRaw(raw) → {HDPrivateKey}

Instantiate key from serialized data.

Parameters:

Name	Type	Description
`raw`	Buffer

Source:

hd/private.js, line 839

Returns:

Type: HDPrivateKey

(static) fromReader(br) → {HDPrivateKey}

Instantiate key from buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

hd/private.js, line 829

Returns:

Type: HDPrivateKey

(static) fromSeed(seed, networknullable) → {HDPrivateKey}

Instantiate an hd private key from a 512 bit seed.

Parameters:

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

Source:

hd/private.js, line 539

Returns:

Type: HDPrivateKey

(static) generate(networknullable) → {HDPrivateKey}

Generate an hd private key.

Parameters:

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

Source:

hd/private.js, line 608

Returns:

Type: HDPrivateKey

(static) isBase58(data) → {Boolean}

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

Parameters:

Name	Type	Description
`data`	String

Source:

hd/private.js, line 357

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 888

Returns:

Type: Boolean

(static) isRaw(data) → {NetworkType}

Test whether a buffer has a valid network prefix.

Parameters:

Name	Type	Description
`data`	Buffer

Source:

hd/private.js, line 379

Returns:

Type: NetworkType

(static) isValidPath(path, hardenednullable) → {Boolean}

Test whether a string is a valid path.

Parameters:

Name	Type	Attributes	Description
`path`	String
`hardened`	Boolean	<nullable>

Source:

hd/private.js, line 407

Returns:

Type: Boolean

compare(obj) → {Boolean}

Compare a key against an object.

Parameters:

Name	Type	Description
`obj`	Object

Source:

hd/private.js, line 461

Returns:

Type: Boolean

derive(index, hardenednullable) → {HDPrivateKey}

Derive a child key.

Parameters:

Name	Type	Attributes	Description
`index`	Number \| String		Child index or path.
`hardened`	Boolean	<nullable>	Whether the derivation should be hardened.

Source:

hd/private.js, line 211

Returns:

Type: HDPrivateKey

deriveAccount44(accountIndex) → {HDPrivateKey}

Derive a BIP44 account key.

Parameters:

Name	Type	Description
`accountIndex`	Number

Source:

hd/private.js, line 304

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 426

Throws:

Error if path is not a valid path.

Returns:

Type: HDPrivateKey

derivePurpose45() → {HDPrivateKey}

Derive a BIP45 purpose key.

Source:

hd/private.js, line 318

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 176

equal(obj) → {Boolean}

Compare a key against an object.

Parameters:

Name	Type	Description
`obj`	Object

Source:

hd/private.js, line 443

Returns:

Type: Boolean

(private) fromBase58(xkey)

Inject properties from base58 key.

Parameters:

Name	Type	Description
`xkey`	Base58String

Source:

hd/private.js, line 620

(private) fromExtended(data)

Inject properties from extended serialized data.

Parameters:

Name	Type	Description
`data`	Buffer

Source:

hd/private.js, line 789

(private) fromExtendedReader(br)

Inject properties from buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

hd/private.js, line 776

(private) fromJSON(json)

Inject properties from json object.

Parameters:

Name	Type	Description
`json`	Object

Source:

hd/private.js, line 861

(private) fromKey(key, entropy, networknullable)

Inject properties from privateKey and entropy.

Parameters:

Name	Type	Attributes
`key`	Buffer
`entropy`	Buffer
`network`	Network \| NetworkType	<nullable>

Source:

hd/private.js, line 577

(private) fromMnemonic(mnemonic, networknullable)

Inject properties from a mnemonic.

Parameters:

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

Source:

hd/private.js, line 550

(private) fromOptions(options)

Inject properties from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

hd/private.js, line 75

(private) fromRaw(raw)

Inject properties from serialized data.

Parameters:

Name	Type	Description
`raw`	Buffer

Source:

hd/private.js, line 665

(private) fromReader(raw)

Inject properties from serialized data.

Parameters:

Name	Type	Description
`raw`	Buffer

Source:

hd/private.js, line 632

(private) fromSeed(seed, networknullable)

Inject properties from seed.

Parameters:

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

Source:

hd/private.js, line 502

getExtendedSize() → {Number}

Calculate extended serialization size.

Source:

hd/private.js, line 727

Returns:

Type: Number

(private) getID(index) → {String}

Unique HD key ID.

Parameters:

Name	Type	Description
`index`	Number

Source:

hd/private.js, line 291

Returns:

Type: String

getSize() → {Number}

Calculate serialization size.

Source:

hd/private.js, line 684

Returns:

Type: Number

isAccount44(accountIndexnullable) → {Boolean}

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

Parameters:

Name	Type	Attributes	Description
`accountIndex`	Number	<nullable>

Source:

hd/private.js, line 338

Returns:

Type: Boolean

isMaster() → {Boolean}

Test whether the key is a master key.

Source:

hd/private.js, line 328

Returns:

Type: Boolean

isPurpose45() → {Boolean}

Test whether the key is a BIP45 purpose key.

Source:

hd/private.js, line 347

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 675

Returns:

Type: Base58String

toExtended(networknullable) → {Buffer}

Serialize the key in "extended" format (includes the mnemonic).

Parameters:

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

Source:

hd/private.js, line 765

Returns:

Type: Buffer

toExtendedWriter(bw, networknullable)

Write the key in "extended" format to a buffer writer.

Parameters:

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

Source:

hd/private.js, line 745

toJSON() → {Object}

Convert key to a more json-friendly object.

Source:

hd/private.js, line 848

Returns:

Type: Object

toPublic() → {HDPublicKey}

Get HD public key.

Source:

hd/private.js, line 122

Returns:

Type: HDPublicKey

toRaw(networknullable) → {Buffer}

Serialize the key.

Parameters:

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

Source:

hd/private.js, line 718

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 694

verifyNetwork(network) → {Boolean}

Verify network.

Parameters:

Name	Type	Description
`network`	NetworkType \| Network

Source:

hd/private.js, line 165

Returns:

Type: Boolean

xprivkey() → {Base58String}

Get cached base58 xprivkey.

Source:

hd/private.js, line 144

Returns:

Type: Base58String

xpubkey() → {Base58String}

Get cached base58 xpubkey.

Source:

hd/private.js, line 155

Returns:

Type: Base58String