JSDoc: Class: Script

Constructor

new Script(code)

Create a script.

Parameters:

Name	Type	Description
`code`	Buffer \| Array \| Object

Properties:

Name	Type	Attributes	Description
`code`	Array		Parsed script code.
`raw`	Buffer	<nullable>	Serialized script.
`length`	Number		Number of parsed opcodes.

Source:

script/script.js, line 54

Members

(static) flags :Number

Script and locktime flags. See VerifyFlags.

Type:

Number

Source:

script/script.js, line 3346

(static) hashType :SighashType

Sighash Types.

Type:

SighashType

Source:

script/script.js, line 3354

(static, constant) hashTypeByVal :RevMap

Sighash types by value.

Type:

RevMap

Source:

script/script.js, line 3361

(static) opcodes :Number

Script opcodes.

Type:

Number

Source:

script/script.js, line 3332

(static, constant) opcodesByVal :RevMap

Opcodes by value.

Type:

RevMap

Source:

script/script.js, line 3339

(static) types :Number

Output script types.

Type:

Number

Source:

script/script.js, line 3368

(static, constant) typesByVal :RevMap

Output script types by value.

Type:

RevMap

Source:

script/script.js, line 3375

length

Get length.

Source:

script/script.js, line 67

length

Set length.

Source:

script/script.js, line 76

Methods

(static) fromAddress(address) → {Script}

Create an output script from an address.

Parameters:

Name	Type	Description
`address`	Address \| AddressString

Source:

script/script.js, line 1646

Returns:

Type: Script

(static) fromArray(code) → {Script}

Instantiate script from an array of buffers and numbers.

Parameters:

Name	Type	Description
`code`	Array

Source:

script/script.js, line 186

Returns:

Type: Script

(static) fromCommitment(hash, flags) → {Script}

Create a witness block commitment.

Parameters:

Name	Type	Description
`hash`	Buffer
`flags`	String \| Buffer

Source:

script/script.js, line 1680

Returns:

Type: Script

(static) fromItems(items) → {Script}

Instantiate script from stack items.

Parameters:

Name	Type	Description
`items`	Array.<Buffer>

Source:

script/script.js, line 234

Returns:

Type: Script

(static) fromJSON() → {Script}

Instantiate script from a hex string.

Source:

script/script.js, line 436

Returns:

Type: Script

(static) fromMultisig(m, n, keys) → {Script}

Create a pay-to-multisig script.

Parameters:

Name	Type	Description
`m`	Number
`n`	Number
`keys`	Array.<Buffer>

Source:

script/script.js, line 1514

Returns:

Type: Script

(static) fromNulldata(flags) → {Script}

Create a nulldata/opreturn script.

Parameters:

Name	Type	Description
`flags`	Buffer

Source:

script/script.js, line 1576

Returns:

Type: Script

(static) fromOptions(options) → {Script}

Insantiate script from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

script/script.js, line 118

Returns:

Type: Script

(static) fromProgram(version, data) → {Script}

Create a witness program.

Parameters:

Name	Type	Description
`version`	Number
`data`	Buffer

Source:

script/script.js, line 1612

Returns:

Type: Script

(static) fromPubkey(key) → {Script}

Create a pay-to-pubkey script.

Parameters:

Name	Type	Description
`key`	Buffer

Source:

script/script.js, line 1435

Returns:

Type: Script

(static) fromPubkeyhash(hash) → {Script}

Create a pay-to-pubkeyhash script.

Parameters:

Name	Type	Description
`hash`	Buffer

Source:

script/script.js, line 1474

Returns:

Type: Script

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

Create a script from a serialized buffer.

Parameters:

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

Source:

script/script.js, line 3309

Returns:

Type: Script

(static) fromReader(br, encnullable) → {Script}

Create a script from buffer reader.

Parameters:

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

Source:

script/script.js, line 3298

Returns:

Type: Script

(static) fromScripthash(hash) → {Script}

Create a pay-to-scripthash script.

Parameters:

Name	Type	Description
`hash`	Buffer

Source:

script/script.js, line 1549

Returns:

Type: Script

(static) fromStack(stack) → {Script}

Instantiate script from stack.

Parameters:

Name	Type	Description
`stack`	Stack

Source:

script/script.js, line 264

Returns:

Type: Script

(static) fromString(items) → {Script}

Parse a bitcoind test script string into a script object.

Parameters:

Name	Type	Description
`items`	String	Script string.

Source:

script/script.js, line 3079

Throws:

Parse error.

Returns:

Type: Script

(static) getCoinbaseHeight(raw) → {Number}

Get coinbase height.

Parameters:

Name	Type	Description
`raw`	Buffer	Raw script.

Source:

script/script.js, line 2413

Returns:

-1 if not present.

Type: Number

(static) isScript(obj) → {Boolean}

Test whether an object a Script.

Parameters:

Name	Type	Description
`obj`	Object

Source:

script/script.js, line 3321

Returns:

Type: Boolean

(static) verify(input, witness, output, tx, index, value, flags)

Verify an input and output script, and a witness if present.

Parameters:

Name	Type	Description
`input`	Script
`witness`	Witness
`output`	Script
`tx`	TX
`index`	Number
`value`	Amount
`flags`	VerifyFlags

Source:

script/script.js, line 3095

Throws:

ScriptError

(static) verifyProgram(witness, output, flags, tx, index, value)

Verify a witness program. This runs after regular script execution if a witness program is present. It will convert the witness to a stack and execute the program.

Parameters:

Name	Type	Description
`witness`	Witness
`output`	Script
`flags`	VerifyFlags
`tx`	TX
`index`	Number
`value`	Amount

Source:

script/script.js, line 3205

Throws:

ScriptError

clear() → {Script}

Clear the script.

Source:

script/script.js, line 318

Returns:

Type: Script

clone() → {Script}

Clone the script.

Source:

script/script.js, line 273

Returns:

Cloned script.

Type: Script

compare(script) → {Number}

Compare against another script.

Parameters:

Name	Type	Description
`script`	Script

Source:

script/script.js, line 308

Returns:

Type: Number

compile() → {Script}

Re-encode the script internally. Useful if you changed something manually in the code array.

Source:

script/script.js, line 371

Returns:

Type: Script

entries() → {ScriptIterator}

Instantiate a key and value iterator.

Source:

script/script.js, line 136

Returns:

Type: ScriptIterator

equals(script) → {Boolean}

Test equality against script.

Parameters:

Name	Type	Description
`script`	Script

Source:

script/script.js, line 297

Returns:

Type: Boolean

execute(stack, flagsnullable, txnullable, indexnullable, valuenullable, versionnullable)

Execute and interpret the script.

Parameters:

Name	Type	Attributes	Description
`stack`	Stack		Script execution stack.
`flags`	Number	<nullable>	Script standard flags.
`tx`	TX	<nullable>	Transaction being verified.
`index`	Number	<nullable>	Index of input being verified.
`value`	Amount	<nullable>	Previous output value.
`version`	Number	<nullable>	Signature hash version (0=legacy, 1=segwit).

Source:

script/script.js, line 517

Throws:

Will be thrown on VERIFY failures.
Type ScriptError

findAndDelete(data) → {Number}

Remove all matched data elements from a script's code (used to remove signatures before verification). Note that this compares and removes data on the byte level. It also reserializes the data to a single script with minimaldata encoding beforehand. A signature will not be removed if it is not minimaldata.

Parameters:

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

Source:

script/script.js, line 1307

See:

Returns:

Total.

Type: Number

forWitness() → {Script|null}

Get the script to the equivalent witness program (mimics bitcoind's scriptForWitness).

Source:

script/script.js, line 2124

Returns:

Type: Script | null

(private) fromAddress(address)

Inject properties from an address.

Parameters:

Name	Type	Description
`address`	Address \| AddressString

Source:

script/script.js, line 1622

(private) fromArray(code) → {Script}

Inject properties from an array of of buffers and numbers.

Parameters:

Name	Type	Description
`code`	Array

Source:

script/script.js, line 168

Returns:

Type: Script

(private) fromCommitment(hash, flags)

Inject properties from a witness block commitment.

Parameters:

Name	Type	Description
`hash`	Buffer
`flags`	String \| Buffer

Source:

script/script.js, line 1657

(private) fromItems(items) → {Script}

Inject data from stack items.

Parameters:

Name	Type	Description
`items`	Array.<Buffer>

Source:

script/script.js, line 217

Returns:

Type: Script

(private) fromJSON(json)

Inject properties from json object.

Parameters:

Name	Type	Description
`json`	String

Source:

script/script.js, line 425

(private) fromMultisig(m, n, keys)

Inject properties from pay-to-multisig script.

Parameters:

Name	Type	Description
`m`	Number
`n`	Number
`keys`	Array.<Buffer>

Source:

script/script.js, line 1486

(private) fromNulldata(flags)

Inject properties from a nulldata/opreturn script.

Parameters:

Name	Type	Description
`flags`	Buffer

Source:

script/script.js, line 1559

(private) fromOptions(options)

Inject properties from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

script/script.js, line 86

(private) fromProgram(version, data)

Inject properties from a witness program.

Parameters:

Name	Type	Description
`version`	Number
`data`	Buffer

Source:

script/script.js, line 1587

(private) fromPubkey(key)

Inject properties from a pay-to-pubkey script.

Parameters:

Name	Type	Description
`key`	Buffer

Source:

script/script.js, line 1412

(private) fromPubkeyhash(hash)

Inject properties from a pay-to-pubkeyhash script.

Parameters:

Name	Type	Description
`hash`	Buffer

Source:

script/script.js, line 1445

(private) fromRaw(data)

Inject properties from serialized data.

Parameters:

Name	Type	Description
`data`	Buffer

Source:

script/script.js, line 3280

(private) fromReader(br)

Inject properties from buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

script/script.js, line 3270

(private) fromScripthash(hash)

Inject properties from a pay-to-scripthash script.

Parameters:

Name	Type	Description
`hash`	Buffer

Source:

script/script.js, line 1524

(private) fromStack(stack) → {Script}

Inject data from stack.

Parameters:

Name	Type	Description
`stack`	Stack

Source:

script/script.js, line 254

Returns:

Type: Script

(private) fromString(items)

Inject properties from bitcoind test string.

Parameters:

Name	Type	Description
`items`	String	Script string.

Source:

script/script.js, line 3015

Throws:

Parse error.

getAddress() → {Address|null}

Get the address of the script if present. Note that pubkey and multisig scripts will be treated as though they are pubkeyhash and scripthashes respectively.

Source:

script/script.js, line 1808

Returns:

Type: Address | null

getCoinbaseHeight() → {Number}

Get coinbase height.

Source:

script/script.js, line 2403

Returns:

-1 if not present.

Type: Number

getCommitment() → {Buffer|null}

Get the commitment hash if present.

Source:

script/script.js, line 2074

Returns:

Type: Buffer | null

getInputAddress() → {Address|null}

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

Source:

script/script.js, line 1797

Returns:

Type: Address | null

getInputType() → {ScriptType}

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

Source:

script/script.js, line 2207

Returns:

Type: ScriptType

getMultisig(minimalopt) → {Array}

Get multisig m and n values if present.

Parameters:

Name	Type	Attributes	Default	Description
`minimal`	Boolean	<optional>	false	Minimaldata only.

Source:

script/script.js, line 1965

Returns:

[m, n]

Type: Array

getMultisigInput() → {Array.<Buffer>|null}

Get multisig signatures if present.

Source:

script/script.js, line 2324

Returns:

Type: Array.<Buffer> | null

getNulldata(minimalopt) → {Buffer|null}

Get OP_RETURN data if present.

Parameters:

Name	Type	Attributes	Default	Description
`minimal`	Boolean	<optional>	false	Minimaldata only.

Source:

script/script.js, line 2042

Returns:

Type: Buffer | null

getProgram() → {Program|null}

Get the witness program if present.

Source:

script/script.js, line 2108

Returns:

Type: Program | null

getPubkey(minimalopt) → {Buffer|null}

Get P2PK key if present.

Parameters:

Name	Type	Attributes	Default	Description
`minimal`	Boolean	<optional>	false	Minimaldata only.

Source:

script/script.js, line 1867

Returns:

Type: Buffer | null

getPubkeyhash(minimalopt) → {Buffer|null}

Get P2PKH hash if present.

Parameters:

Name	Type	Attributes	Default	Description
`minimal`	Boolean	<optional>	false	Minimaldata only.

Source:

script/script.js, line 1909

Returns:

Type: Buffer | null

getPubkeyhashInput() → {Array}

Get P2PKH signature and key if present.

Source:

script/script.js, line 2282

Returns:

[sig, key]

Type: Array

getPubkeyInput() → {Buffer|null}

Get P2PK signature if present.

Source:

script/script.js, line 2253

Returns:

Type: Buffer | null

getRedeem() → {Script|null}

Grab and deserialize the redeem script.

Source:

script/script.js, line 1689

Returns:

Redeem script.

Type: Script | null

getScripthash() → {Buffer|null}

Get P2SH hash if present.

Source:

script/script.js, line 1992

Returns:

Type: Buffer | null

getScripthashInput() → {Buffer|null}

Get P2SH redeem script if present.

Source:

script/script.js, line 2391

Returns:

Type: Buffer | null

getScripthashSigops(input) → {Number}

Count the sigops in the script, taking into account redeem scripts.

Parameters:

Name	Type	Description
`input`	Script	Input script, needed for access to redeem script.

Source:

script/script.js, line 2518

Returns:

sigop count

Type: Number

getSigops(accurate) → {Number}

Count the sigops in the script.

Parameters:

Name	Type	Description
`accurate`	Boolean	Whether to enable accurate counting. This will take into account the `n` value for OP_CHECKMULTISIG(VERIFY).

Source:

script/script.js, line 2484

Returns:

sigop count

Type: Number

getSize() → {Number}

Calculate the size of the script excluding the varint size bytes.

Source:

script/script.js, line 1777

Returns:

Type: Number

getSubscript(index) → {Script}

Get the script's "subscript" starting at a separator.

Parameters:

Name	Type	Description
`index`	Number	The last separator to sign/verify beyond.

Source:

script/script.js, line 446

Returns:

Subscript.

Type: Script

getType() → {ScriptType}

Get the standard script type.

Source:

script/script.js, line 1713

Returns:

Type: ScriptType

getVarSize() → {Number}

Calculate the size of the script including the varint size bytes.

Source:

script/script.js, line 1787

Returns:

Type: Number

getWitnessPubkeyhash() → {Buffer|null}

Get P2WPKH hash if present.

Source:

script/script.js, line 2158

Returns:

Type: Buffer | null

getWitnessScripthash() → {Buffer|null}

Get P2WSH hash if present.

Source:

script/script.js, line 2182

Returns:

Type: Buffer | null

getWitnessSigops(input, witness) → {Number}

Count the sigops in a script, taking into account witness programs.

Parameters:

Name	Type	Description
`input`	Script
`witness`	Witness

Source:

script/script.js, line 2537

Returns:

sigop count

Type: Number

hash160(encnullable) → {Hash}

Get the hash160 of the raw script.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>

Source:

script/script.js, line 1818

Returns:

Type: Hash

indexOf(data) → {Number}

Find a data element in a script.

Parameters:

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

Source:

script/script.js, line 1356

Returns:

Index (-1 if not present).

Type: Number

(private) inject(script) → {Script}

Inject properties from script. Used for cloning.

Parameters:

Name	Type	Description
`script`	Script

Source:

script/script.js, line 285

Returns:

Type: Script

inspectSymbol() → {String}

Inspect the script.

Source:

script/script.js, line 329

Returns:

Human-readable script code.

Type: String

isCode() → {Boolean}

Test a script to see if it is likely to be script code (no weird opcodes).

Source:

script/script.js, line 1379

Returns:

Type: Boolean

isCommitment() → {Boolean}

Test whether the output script is a segregated witness commitment.

Source:

script/script.js, line 2062

Returns:

Type: Boolean

isMultisig(minimalopt) → {Boolean}

Test whether the output script is pay-to-multisig.

Parameters:

Name	Type	Attributes	Default	Description
`minimal`	Boolean	<optional>	false	Minimaldata only.

Source:

script/script.js, line 1925

Returns:

Type: Boolean

isMultisigInput() → {Boolean}

"Guess" whether the input script is pay-to-multisig. This method is not 100% reliable.

Source:

script/script.js, line 2295

Returns:

Type: Boolean

isNulldata(minimalopt) → {Boolean}

Test whether the output script is nulldata/opreturn.

Parameters:

Name	Type	Attributes	Default	Description
`minimal`	Boolean	<optional>	false	Minimaldata only.

Source:

script/script.js, line 2005

Returns:

Type: Boolean

isProgram() → {Boolean}

Test whether the output script is a witness program. Note that this will return true even for malformed witness v0 programs.

Source:

script/script.js, line 2088

Returns:

Type: Boolean

isPubkey(minimalopt) → {Boolean}

Test whether the output script is pay-to-pubkey.

Parameters:

Name	Type	Attributes	Default	Description
`minimal`	Boolean	<optional>	false	Minimaldata only.

Source:

script/script.js, line 1844

Returns:

Type: Boolean

isPubkeyhash(minimalopt) → {Boolean}

Test whether the output script is pay-to-pubkeyhash.

Parameters:

Name	Type	Attributes	Default	Description
`minimal`	Boolean	<optional>	false	Minimaldata only.

Source:

script/script.js, line 1883

Returns:

Type: Boolean

isPubkeyhashInput() → {Boolean}

"Guess" whether the input script is pay-to-pubkeyhash. This method is not 100% reliable.

Source:

script/script.js, line 2266

Returns:

Type: Boolean

isPubkeyInput() → {Boolean}

"Guess" whether the input script is pay-to-pubkey. This method is not 100% reliable.

Source:

script/script.js, line 2239

Returns:

Type: Boolean

isPushOnly() → {Boolean}

Test the script to see if it contains only push ops. Push ops are: OP_1NEGATE, OP_0-OP_16 and all PUSHDATAs.

Source:

script/script.js, line 2465

Returns:

Type: Boolean

isScripthash() → {Boolean}

Test whether the output script is pay-to-scripthash. Note that bitcoin itself requires scripthashes to be in strict minimaldata encoding. Using OP_HASH160 OP_PUSHDATA1 [hash] OP_EQUAL will not be recognized as a scripthash.

Source:

script/script.js, line 1980

Returns:

Type: Boolean

isScripthashInput() → {Boolean}

"Guess" whether the input script is pay-to-scripthash. This method is not 100% reliable.

Source:

script/script.js, line 2342

Returns:

Type: Boolean

isStandard() → {Boolean}

Test whether the script is standard by policy standards.

Source:

script/script.js, line 1752

Returns:

Type: Boolean

isUnknown() → {Boolean}

Test whether a script is of an unknown/non-standard type.

Source:

script/script.js, line 1743

Returns:

Type: Boolean

isUnknownInput() → {Boolean}

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

Source:

script/script.js, line 2229

Returns:

Type: Boolean

isUnspendable() → {Boolean}

Test whether the output script is unspendable.

Source:

script/script.js, line 2194

Returns:

Type: Boolean

isWitnessPubkeyhash() → {Boolean}

Test whether the output script is a pay-to-witness-pubkeyhash program.

Source:

script/script.js, line 2147

Returns:

Type: Boolean

isWitnessScripthash() → {Boolean}

Test whether the output script is a pay-to-witness-scripthash program.

Source:

script/script.js, line 2171

Returns:

Type: Boolean

removeSeparators() → {Script}

Get the script's "subscript" starting at a separator. Remove all OP_CODESEPARATORs if present. This bizarre behavior is necessary for signing and verification when code separators are present.

Source:

script/script.js, line 472

Returns:

Subscript.

Type: Script

sha256(encnullable) → {Hash}

Get the sha256 of the raw script.

Parameters:

Name	Type	Attributes	Description
`enc`	String	<nullable>

Source:

script/script.js, line 1831

Returns:

Type: Hash

Symbol.iterator() → {ScriptIterator}

Instantiate a value-only iterator.

Source:

script/script.js, line 145

Returns:

Type: ScriptIterator

test(filter) → {Boolean}

Test the script against a bloom filter.

Parameters:

Name	Type	Description
`filter`	Bloom

Source:

script/script.js, line 2444

Returns:

Type: Boolean

toArray() → {Array}

Convert the script to an array of Buffers (pushdatas) and Numbers (opcodes).

Source:

script/script.js, line 156

Returns:

Type: Array

toASM(decodenullable) → {String}

Format the script as bitcoind asm.

Parameters:

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

Source:

script/script.js, line 353

Returns:

Human-readable script.

Type: String

toItems() → {Array.<Buffer>}

Convert script to stack items.

Source:

script/script.js, line 195

Returns:

Type: Array.<Buffer>

toJSON() → {String}

Convert script to a hex string.

Source:

script/script.js, line 415

Returns:

Type: String

toRaw(enc) → {Buffer|String}

Encode the script to a Buffer. See Script#encode.

Parameters:

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

Source:

script/script.js, line 406

Returns:

Serialized script.

Type: Buffer | String

toStack() → {Stack}

Convert script to stack.

Source:

script/script.js, line 243

Returns:

Type: Stack

toString() → {String}

Convert the script to a bitcoind test string.

Source:

script/script.js, line 338

Returns:

Human-readable script code.

Type: String

toWriter(bw)

Write the script to a buffer writer.

Parameters:

Name	Type	Description
`bw`	BufferWriter

Source:

script/script.js, line 395

values() → {ScriptIterator}

Instantiate a value-only iterator.

Source:

script/script.js, line 127

Returns:

Type: ScriptIterator