JSDoc: Class: Witness

new Witness(items)

Refers to the witness field of segregated witness transactions.

Parameters:

Name	Type	Description
`items`	Array:.<Buffer:> \| NakedWitness	Array of stack items.

Properties:

Name	Type	Attributes
`items`	Array:.<Buffer:>
`redeem`	Script	<nullable>
`length`	Number

Source:

script/witness.js, line 37

Methods

(static) encodeItem(data) → {Buffer}

Encode a witness item.

Parameters:

Name	Type	Description
`data`	Number \| String \| Buffer \| BN

Source:

script/witness.js, line 555

Returns:

Type: Buffer

(static) fromArray(items) → {Witness}

Insantiate witness from an array of buffers.

Parameters:

Name	Type	Description
`items`	Array:.<Buffer:>

Source:

script/witness.js, line 131

Returns:

Type: Witness

(static) fromJSON(json) → {Witness}

Insantiate witness from a hex string.

Parameters:

Name	Type	Description
`json`	String

Source:

script/witness.js, line 414

Returns:

Type: Witness

(static) fromOptions(options) → {Witness}

Instantiate witness from options.

Parameters:

Name	Type	Description
`options`	Object

Source:

script/witness.js, line 100

Returns:

Type: Witness

(static) fromRaw(data, encnullable) → {Witness}

Create a witness from a serialized buffer.

Parameters:

Name	Type	Attributes	Description
`data`	Buffer \| String		Serialized witness.
`enc`	String	<nullable>	Either `"hex"` or `null`.

Source:

script/witness.js, line 623

Returns:

Type: Witness

(static) fromReader(br)

Create a witness from a buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

script/witness.js, line 612

(static) fromString(items) → {Witness}

Parse a test script/array string into a witness object. Must contain only stack items (no non-push opcodes).

Parameters:

Name	Type	Description
`items`	String \| Array:.<String:>	Script string.

Source:

script/witness.js, line 665

Throws:

Parse error.

Returns:

Type: Witness

(static) isWitness(obj) → {Boolean}

Test an object to see if it is a Witness.

Parameters:

Name	Type	Description
`obj`	Object

Source:

script/witness.js, line 675

Returns:

Type: Boolean

clear()

Clear the witness items.

Source:

script/witness.js, line 534

clone() → {Witness}

Clone the witness object.

Source:

script/witness.js, line 168

Returns:

A clone of the current witness object.

Type: Witness

compile()

Does nothing currently.

Source:

script/witness.js, line 319

(private) fromArray(items)

Inject properties from an array of buffers.

Parameters:

Name	Type	Description
`items`	Array:.<Buffer:>

Source:

script/witness.js, line 119

(private) fromJSON(json)

Inject properties from json object.

Parameters:

Name	Type	Description
`json`	String

Source:

script/witness.js, line 403

(private) fromOptions(options)

Inject properties from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

script/witness.js, line 78

(private) fromRaw(data)

Inject properties from serialized data.

Parameters:

Name	Type	Description
`data`	Buffer

Source:

script/witness.js, line 603

(private) fromReader(br)

Inject properties from buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

script/witness.js, line 587

(private) fromString(items)

Inject items from string.

Parameters:

Name	Type	Description
`items`	String \| Array:.<String:>

Source:

script/witness.js, line 635

get(index) → {Buffer}

Get an item from the witness vector.

Parameters:

Name	Type	Description
`index`	Number

Source:

script/witness.js, line 483

Returns:

Type: Buffer

getInputAddress() → {Address|null}

"Guess" the address of the witness. This method is not 100% reliable.

Source:

script/witness.js, line 218

Returns:

Type: Address | null

getInputType() → {ScriptType}

"Guess" the type of the witness. This method is not 100% reliable.

Source:

script/witness.js, line 202

Returns:

Type: ScriptType

getNumber(index) → {BN}

Get a number from the witness vector.

Parameters:

Name	Type	Description
`index`	Number

Source:

script/witness.js, line 510

Returns:

Type: BN

getRedeem() → {Script}

Grab and deserialize the redeem script from the witness.

Source:

script/witness.js, line 301

Returns:

Redeem script.

Type: Script

getSize() → {Number}

Calculate size of the witness excluding the varint size bytes.

Source:

script/witness.js, line 339

Returns:

Type: Number

getSmall(index) → {Number}

Get a small int (0-16) from the witness vector.

Parameters:

Name	Type	Description
`index`	Number

Source:

script/witness.js, line 493

Returns:

-1 on non-existent.

Type: Number

getString(index) → {String}

Get a string from the witness vector.

Parameters:

Name	Type	Description
`index`	Number

Source:

script/witness.js, line 523

Returns:

Type: String

getVarSize() → {Number}

Calculate size of the witness including the varint size bytes.

Source:

script/witness.js, line 357

Returns:

Type: Number

indexOf(data) → {Number}

Find a data element in a witness.

Parameters:

Name	Type	Description
`data`	Buffer	Data element to match against.

Source:

script/witness.js, line 329

Returns:

Index (-1 if not present).

Type: Number

(private) inject(witness) → {Witness}

Inject properties from witness. Used for cloning.

Parameters:

Name	Type	Description
`witness`	Witness

Source:

script/witness.js, line 180

Returns:

Type: Witness

insert(index, data)

Insert an item into the witness vector.

Parameters:

Name	Type	Description
`index`	Number
`data`	Number \| String \| Buffer \| BN

Source:

script/witness.js, line 472

inspect() → {String}

Inspect a Witness object.

Source:

script/witness.js, line 140

Returns:

Human-readable script.

Type: String

isMultisigInput() → {Boolean}

"Test" whether the witness is a multisig input. Always returns false.

Source:

script/witness.js, line 250

Returns:

Type: Boolean

isPubkeyhashInput() → {Boolean}

"Guess" whether the witness is a pubkeyhash input. This method is not 100% reliable.

Source:

script/witness.js, line 238

Returns:

Type: Boolean

isPubkeyInput() → {Boolean}

"Test" whether the witness is a pubkey input. Always returns false.

Source:

script/witness.js, line 228

Returns:

Type: Boolean

isScripthashInput() → {Boolean}

"Guess" whether the witness is a scripthash input. This method is not 100% reliable.

Source:

script/witness.js, line 260

Returns:

Type: Boolean

isUnknownInput() → {Boolean}

"Guess" whether the witness is an unknown/non-standard type. This method is not 100% reliable.

Source:

script/witness.js, line 270

Returns:

Type: Boolean

(private) length_getter() → {Number}

Getter to retrieve witness vector length.

Source:

script/witness.js, line 47

Returns:

Type: Number

(private) length_setter(value) → {Number}

Setter to set witness vector length.

Parameters:

Name	Type	Description
`value`	Number

Source:

script/witness.js, line 59

Returns:

Type: Number

pop() → {Buffer}

Shift an item off the witness vector.

Source:

script/witness.js, line 452

Returns:

Type: Buffer

push(data) → {Number}

Push an item onto the witness vector.

Parameters:

Name	Type	Description
`data`	Number \| String \| Buffer \| BN

Source:

script/witness.js, line 434

Returns:

Type: Number

remove(index) → {Buffer}

Remove an item from the witness vector.

Parameters:

Name	Type	Description
`index`	Number

Source:

script/witness.js, line 462

Returns:

Type: Buffer

set(index, data)

Set an item in the witness vector.

Parameters:

Name	Type	Description
`index`	Number
`data`	Number \| String \| Buffer \| BN

Source:

script/witness.js, line 544

shift() → {Buffer}

Shift an item off the witness vector.

Source:

script/witness.js, line 443

Returns:

Type: Buffer

test(filter) → {Boolean}

Test the witness against a bloom filter.

Parameters:

Name	Type	Description
`filter`	Bloom

Source:

script/witness.js, line 280

Returns:

Type: Boolean

toArray() → {Array:.<Buffer:>}

Convert witness to an array of buffers.

Source:

script/witness.js, line 109

Returns:

Type: Array:.<Buffer:>

toASM(decodenullable) → {String}

Format the witness object as bitcoind asm.

Parameters:

Name	Type	Attributes	Description
`decode`	Boolean	<nullable>	Attempt to decode hash types.

Source:

script/witness.js, line 159

Returns:

Human-readable script.

Type: String

toJSON() → {String}

Convert witness to a hex string.

Source:

script/witness.js, line 393

Returns:

Type: String

toRaw(enc) → {Buffer|String}

Encode the witness to a Buffer.

Parameters:

Name	Type	Description
`enc`	String	Encoding, either `'hex'` or `null`.

Source:

script/witness.js, line 383

Returns:

Serialized script.

Type: Buffer | String

toStack() → {Stack}

Convert the Witness to a Stack object. This is usually done before executing a witness program.

Source:

script/witness.js, line 192

Returns:

Type: Stack

toString() → {String}

Convert a Witness object to a String.

Source:

script/witness.js, line 149

Returns:

Human-readable script.

Type: String

toWriter(bw)

Write witness to a buffer writer.

Parameters:

Name	Type	Description
`bw`	BufferWriter

Source:

script/witness.js, line 366

unshift(data) → {Number}

Unshift an item onto the witness vector.

Parameters:

Name	Type	Description
`data`	Number \| String \| Buffer \| BN

Source:

script/witness.js, line 424

Returns:

Type: Number