JSDoc: Class: KeyRing

Constructor

new KeyRing(options)

Create a key ring.

Parameters:

Name	Type	Description
`options`	Object

Source:

primitives/keyring.js, line 42

Methods

(static) fromJSON(json) → {KeyRing}

Instantiate an KeyRing from a jsonified transaction object.

Parameters:

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

Source:

primitives/keyring.js, line 815

Returns:

Type: KeyRing

(static) fromKey(publicKey, compressnullable) → {KeyRing}

Instantiate keyring from a public key.

Parameters:

Name	Type	Attributes	Description
`publicKey`	Buffer
`compress`	Boolean	<nullable>

Source:

primitives/keyring.js, line 222

Returns:

Type: KeyRing

(static) fromMultisigScript(script, i) → {KeyRing}

Instantiate keyring from ith key in multisig script.

Parameters:

Name	Type	Description
`script`	Script
`i`	Number

Source:

primitives/keyring.js, line 282

Returns:

Type: KeyRing

(static) fromOptions(options) → {KeyRing}

Instantiate key ring from options.

Parameters:

Name	Type	Description
`options`	Object

Source:

primitives/keyring.js, line 107

Returns:

Type: KeyRing

(static) fromPrivate(key, compressnullable) → {KeyRing}

Instantiate keyring from a private key.

Parameters:

Name	Type	Attributes	Description
`key`	Buffer
`compress`	Boolean	<nullable>

Source:

primitives/keyring.js, line 150

Returns:

Type: KeyRing

(static) fromPublic(publicKey) → {KeyRing}

Instantiate keyring from a public key.

Parameters:

Name	Type	Description
`publicKey`	Buffer

Source:

primitives/keyring.js, line 195

Returns:

Type: KeyRing

(static) fromRaw(data) → {KeyRing}

Instantiate a keyring from serialized data.

Parameters:

Name	Type	Description
`data`	Buffer

Source:

primitives/keyring.js, line 935

Returns:

Type: KeyRing

(static) fromReader(br) → {KeyRing}

Instantiate a keyring from buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

primitives/keyring.js, line 925

Returns:

Type: KeyRing

(static) fromScript(key, script, compressnullable) → {KeyRing}

Instantiate keyring from script.

Parameters:

Name	Type	Attributes
`key`	Buffer
`script`	Script
`compress`	Boolean	<nullable>

Source:

primitives/keyring.js, line 251

Returns:

Type: KeyRing

(static) fromSecret(secret, networknullable) → {KeyRing}

Instantiate a keyring from a serialized CBitcoinSecret.

Parameters:

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

Source:

primitives/keyring.js, line 365

Returns:

Type: KeyRing

(static) generate(compressnullable) → {KeyRing}

Generate a keyring.

Parameters:

Name	Type	Attributes	Description
`compress`	Boolean	<nullable>

Source:

primitives/keyring.js, line 185

Returns:

Type: KeyRing

(static) isKeyRing(obj) → {Boolean}

Test whether an object is a KeyRing.

Parameters:

Name	Type	Description
`obj`	Object

Source:

primitives/keyring.js, line 945

Returns:

Type: Boolean

(private) fromJSON(json)

Inject properties from json object.

Parameters:

Name	Type	Description
`json`	Object

Source:

primitives/keyring.js, line 792

(private) fromKey(privateKey, compressnullable)

Inject data from public key.

Parameters:

Name	Type	Attributes	Description
`privateKey`	Buffer
`compress`	Boolean	<nullable>

Source:

primitives/keyring.js, line 206

(private) fromMultisigScript(script, i) → {KeyRing}

Get ith public key from multisig script.

Parameters:

Name	Type	Description
`script`	Script
`i`	Number

Source:

primitives/keyring.js, line 263

Returns:

Type: KeyRing

(private) fromOptions(options)

Inject properties from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

primitives/keyring.js, line 68

(private) fromPrivate(key, compressnullable)

Inject data from private key.

Parameters:

Name	Type	Attributes	Description
`key`	Buffer
`compress`	Boolean	<nullable>

Source:

primitives/keyring.js, line 133

(private) fromPublic(key)

Inject data from public key.

Parameters:

Name	Type	Description
`key`	Buffer

Source:

primitives/keyring.js, line 160

(private) fromRaw(data)

Inject properties from serialized data.

Parameters:

Name	Type	Description
`data`	Buffer

Source:

primitives/keyring.js, line 915

(private) fromReader(br)

Inject properties from buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

primitives/keyring.js, line 884

(private) fromScript(key, script, compressnullable)

Inject data from script.

Parameters:

Name	Type	Attributes
`key`	Buffer
`script`	Script
`compress`	Boolean	<nullable>

Source:

primitives/keyring.js, line 234

(private) fromSecret(secret, networknullable)

Inject properties from serialized CBitcoinSecret.

Parameters:

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

Source:

primitives/keyring.js, line 337

(private) generate(compressnullable) → {KeyRing}

Generate a keyring.

Parameters:

Name	Type	Attributes	Description
`compress`	Boolean	<nullable>

Source:

primitives/keyring.js, line 174

Returns:

Type: KeyRing

getAddress(encnullable) → {Address|AddressString}

Get base58 address.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"base58"` or `null`.

Source:

primitives/keyring.js, line 625

Returns:

Type: Address | AddressString

getHash(encnullable) → {Buffer}

Get hash.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"hex"` or `null`.

Source:

primitives/keyring.js, line 609

Returns:

Type: Buffer

getKeyAddress(encnullable) → {Address|AddressString}

Get pubkeyhash address.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"base58"` or `null`.

Source:

primitives/keyring.js, line 581

Returns:

Type: Address | AddressString

getKeyHash(encnullable) → {Buffer}

Get public key hash.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"hex"` or `null`.

Source:

primitives/keyring.js, line 566

Returns:

Type: Buffer

getNestedAddress(encnullable) → {Address|AddressString}

Get address' scripthash address for witness program.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"base58"` or `null`.

Source:

primitives/keyring.js, line 462

Returns:

Type: Address | AddressString

getNestedHash(encnullable) → {Buffer}

Get address' ripemd160 program scripthash (for witness programs behind a scripthash).

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"hex"` or `null`.

Source:

primitives/keyring.js, line 444

Returns:

Type: Buffer

getPrivateKey(encnullable) → {Buffer}

Get private key.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	Can be `"hex"`, `"base58"`, or `null`.

Source:

primitives/keyring.js, line 375

Returns:

Private key.

Type: Buffer

getProgram() → {Buffer}

Get witness program.

Source:

primitives/keyring.js, line 418

Returns:

Type: Buffer

getPublicKey(encnullable) → {Buffer}

Get public key.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"hex"` or `null`.

Source:

primitives/keyring.js, line 394

Returns:

Type: Buffer

getRedeem(hash) → {Script|null}

Test a hash against script hashes to find the correct redeem script, if any.

Parameters:

Name	Type	Description
`hash`	Buffer

Source:

primitives/keyring.js, line 688

Returns:

Type: Script | null

getScript() → {Script}

Get redeem script.

Source:

primitives/keyring.js, line 409

Returns:

Type: Script

getScriptAddress(encnullable) → {Address|AddressString}

Get scripthash address.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"base58"` or `null`.

Source:

primitives/keyring.js, line 535

Returns:

Type: Address | AddressString

getScriptHash(encnullable) → {Buffer}

Get scripthash.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"hex"` or `null`.

Source:

primitives/keyring.js, line 487

Returns:

Type: Buffer

getScriptHash160(encnullable) → {Buffer}

Get ripemd160 scripthash.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"hex"` or `null`.

Source:

primitives/keyring.js, line 499

Returns:

Type: Buffer

getScriptHash256(encnullable) → {Buffer}

Get sha256 scripthash.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>	`"hex"` or `null`.

Source:

primitives/keyring.js, line 517

Returns:

Type: Buffer

getSecretSize() → {Number}

Calculate WIF serialization size.

Source:

primitives/keyring.js, line 291

Returns:

Type: Number

getSize() → {Number}

Calculate serialization size.

Source:

primitives/keyring.js, line 824

Returns:

Type: Number

getType() → {ScriptType}

Get address type.

Source:

primitives/keyring.js, line 747

Returns:

Type: ScriptType

getVersion() → {Number}

Get witness program version.

Source:

primitives/keyring.js, line 732

Returns:

Type: Number

inspectSymbol() → {Object}

Inspect keyring.

Source:

primitives/keyring.js, line 765

Returns:

Type: Object

ownHash(hash) → {Boolean}

Test an address hash against hash and program hash.

Parameters:

Name	Type	Description
`hash`	Buffer

Source:

primitives/keyring.js, line 641

Returns:

Type: Boolean

ownOutput(tx, indexnullable) → {Boolean}

Check whether transaction output belongs to this address.

Parameters:

Name	Type	Attributes	Description
`tx`	TX \| Output		Transaction or Output.
`index`	Number	<nullable>	Output index.

Source:

primitives/keyring.js, line 668

Returns:

Type: Boolean

refresh()

Clear cached key/script hashes.

Source:

primitives/keyring.js, line 115

sign(msg) → {Buffer}

Sign a message.

Parameters:

Name	Type	Description
`msg`	Buffer

Source:

primitives/keyring.js, line 711

Returns:

Signature in DER format.

Type: Buffer

toJSON() → {Object}

Convert an KeyRing to a more json-friendly object.

Source:

primitives/keyring.js, line 774

Returns:

Type: Object

toRaw() → {Buffer}

Serialize the keyring.

Source:

primitives/keyring.js, line 873

Returns:

Type: Buffer

toSecret(networknullable) → {Base58String}

Convert key to a CBitcoinSecret.

Parameters:

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

Source:

primitives/keyring.js, line 311

Returns:

Type: Base58String

toWriter(bw)

Write the keyring to a buffer writer.

Parameters:

Name	Type	Description
`bw`	BufferWriter

Source:

primitives/keyring.js, line 842

verify(msg, sig) → {Boolean}

Verify a message.

Parameters:

Name	Type	Description
`msg`	Buffer
`sig`	Buffer	Signature in DER format.

Source:

primitives/keyring.js, line 723

Returns:

Type: Boolean