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 45

Members

(static) flags :Number

Script and locktime flags. See VerifyFlags.

Type:

Number

Source:

script/script.js, line 2363

(static) hashType :SighashType

Sighash Types.

Type:

SighashType

Source:

script/script.js, line 2371

(static, constant) hashTypeByVal :RevMap

Sighash types by value.

Type:

RevMap

Source:

script/script.js, line 2378

(static) opcodes :Number

Script opcodes.

Type:

Number

Source:

script/script.js, line 2349

(static, constant) opcodesByVal :RevMap

Opcodes by value.

Type:

RevMap

Source:

script/script.js, line 2356

(static) types :Number

Output script types.

Type:

Number

Source:

script/script.js, line 2385

(static, constant) typesByVal :RevMap

Output script types by value.

Type:

RevMap

Source:

script/script.js, line 2392

length

Get length.

Source:

script/script.js, line 67

length

Set length.

Source:

script/script.js, line 76

Methods

(static) fromArray(code) → {Script}

Instantiate script from an array of buffers and numbers.

Parameters:

Name	Type	Description
`code`	Array

Source:

script/script.js, line 176

Returns:

Type: Script

(static) fromItems(items) → {Script}

Instantiate script from stack items.

Parameters:

Name	Type	Description
`items`	Array.<Buffer>

Source:

script/script.js, line 224

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 1432

Returns:

Type: Script

(static) fromPubkey(key) → {Script}

Create a pay-to-pubkey script.

Parameters:

Name	Type	Description
`key`	Buffer

Source:

script/script.js, line 1353

Returns:

Type: Script

(static) fromPubkeyhash(hash) → {Script}

Create a pay-to-pubkeyhash script.

Parameters:

Name	Type	Description
`hash`	Buffer

Source:

script/script.js, line 1392

Returns:

Type: Script

(static) fromStack(stack) → {Script}

Instantiate script from stack.

Parameters:

Name	Type	Description
`stack`	Stack

Source:

script/script.js, line 254

Returns:

Type: Script

(static) isScript(obj) → {Boolean}

Test whether an object a Script.

Parameters:

Name	Type	Description
`obj`	Object

Source:

script/script.js, line 2338

Returns:

Type: Boolean

(static) verify(witness, addr, tx, index, value, flags)

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

Parameters:

Name	Type	Description
`witness`	Witness
`addr`	Address
`tx`	TX
`index`	Number
`value`	Amount
`flags`	VerifyFlags

Source:

script/script.js, line 2246

Throws:

ScriptError

clear() → {Script}

Clear the script.

Source:

script/script.js, line 299

Returns:

Type: Script

compare(script) → {Number}

Compare against another script.

Parameters:

Name	Type	Description
`script`	Script

Source:

script/script.js, line 289

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 349

Returns:

Type: Script

(private) decode(data)

Inject properties from serialized data.

Parameters:

Name	Type	Description
`data`	Buffer

Source:

script/script.js, line 2321

encode(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 384

Returns:

Serialized script.

Type: Buffer | String

entries() → {ScriptIterator}

Instantiate a key and value iterator.

Source:

script/script.js, line 126

Returns:

Type: ScriptIterator

equals(script) → {Boolean}

Test equality against script.

Parameters:

Name	Type	Description
`script`	Script

Source:

script/script.js, line 278

Returns:

Type: Boolean

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

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.

Source:

script/script.js, line 484

Throws:

Will be thrown on VERIFY failures.
Type ScriptError

format() → {String}

Inspect the script.

Source:

script/script.js, line 310

Returns:

Human-readable script code.

Type: String

(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 158

Returns:

Type: Script

(private) fromItems(items) → {Script}

Inject data from stack items.

Parameters:

Name	Type	Description
`items`	Array.<Buffer>

Source:

script/script.js, line 207

Returns:

Type: Script

(private) fromJSON(json)

Inject properties from json object.

Parameters:

Name	Type	Description
`json`	String

Source:

script/script.js, line 403

(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 1404

(private) fromOptions(options)

Inject properties from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

script/script.js, line 86

(private) fromPubkey(key)

Inject properties from a pay-to-pubkey script.

Parameters:

Name	Type	Description
`key`	Buffer

Source:

script/script.js, line 1330

(private) fromPubkeyhash(hash)

Inject properties from a pay-to-pubkeyhash script.

Parameters:

Name	Type	Description
`hash`	Buffer

Source:

script/script.js, line 1363

(private) fromStack(stack) → {Script}

Inject data from stack.

Parameters:

Name	Type	Description
`stack`	Stack

Source:

script/script.js, line 244

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 2179

Throws:

Parse error.

getJSON() → {String}

Convert script to a hex string.

Source:

script/script.js, line 393

Returns:

Type: String

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 1637

Returns:

[m, n]

Type: Array

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 1540

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 1582

Returns:

Type: Buffer | null

getSigops() → {Number}

Count the sigops in the script.

Source:

script/script.js, line 1700

Returns:

sigop count

Type: Number

getSize() → {Number}

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

Source:

script/script.js, line 1490

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 414

Returns:

Subscript.

Type: Script

getType() → {ScriptType}

Get the standard script type.

Source:

script/script.js, line 1441

Returns:

Type: ScriptType

getVarSize() → {Number}

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

Source:

script/script.js, line 1500

Returns:

Type: Number

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 1275

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 266

Returns:

Type: Script

isCode() → {Boolean}

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

Source:

script/script.js, line 1298

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 1598

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 1519

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 1556

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 1683

Returns:

Type: Boolean

isStandard() → {Boolean}

Test whether the script is standard by policy standards.

Source:

script/script.js, line 1468

Returns:

Type: Boolean

isUnknown() → {Boolean}

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

Source:

script/script.js, line 1459

Returns:

Type: Boolean

isUnspendable() → {Boolean}

Test whether the output script is unspendable.

Source:

script/script.js, line 1649

Returns:

Type: Boolean

(private) read(br)

Inject properties from buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

script/script.js, line 2311

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: