Skip to main content

Covenant

bitcoinjs-lib v0.2.9-beta.16

bitcoinjs-lib / Covenant

Class: Covenant

Defined in: packages/scrypt-ts-btc/src/covenant.ts:40

Covenant base class. Covenant is a wrapper for Taproot. Covenant can contain multiple SmartContract. Each SmartContract is an script path to spend the Taproot locking script.

Extended by​

Constructors​

new Covenant()​

new Covenant(subContracts, options): Covenant

Defined in: packages/scrypt-ts-btc/src/covenant.ts:49

Parameters​

subContracts​

AliasedContract\<StructObject>[]

options​
network?​

SupportedNetwork

Returns​

Covenant

Properties​

accessedInputStateProofs​

readonly accessedInputStateProofs: boolean

Defined in: packages/scrypt-ts-btc/src/covenant.ts:46

address​

readonly address: string

Defined in: packages/scrypt-ts-btc/src/covenant.ts:45

lockingScript​

readonly lockingScript: Script

Defined in: packages/scrypt-ts-btc/src/covenant.ts:44

subContracts​

subContracts: Record\<string, SmartContract\<StructObject>>

Defined in: packages/scrypt-ts-btc/src/covenant.ts:41

tpubkey​

readonly tpubkey: string

Defined in: packages/scrypt-ts-btc/src/covenant.ts:43

utxo?​

optional utxo: UTXO

Defined in: packages/scrypt-ts-btc/src/covenant.ts:47

Accessors​

lockingScriptHex​

Get Signature​

get lockingScriptHex(): ByteString

Defined in: packages/scrypt-ts-btc/src/covenant.ts:116

Returns​

ByteString

stateHash​

Get Signature​

get stateHash(): ByteString

Defined in: packages/scrypt-ts-btc/src/covenant.ts:139

Returns​

ByteString

Methods​

bindToUtxo()​

bindToUtxo(utxo): this

Defined in: packages/scrypt-ts-btc/src/covenant.ts:106

Parameters​

utxo​

Optional\<UTXO, "script">

Returns​

this

getSubContract()​

getSubContract(alias): SmartContract\<StructObject>

Defined in: packages/scrypt-ts-btc/src/covenant.ts:120

Parameters​

alias​

string = 'default'

Returns​

SmartContract\<StructObject>

getSubContractCallArg()​

getSubContractCallArg(inputWitness, method, argName, alias?): SupportedParamType

Defined in: packages/scrypt-ts-btc/src/covenant.ts:124

Parameters​

inputWitness​

Witness

method​

string

argName​

string

alias?​

string

Returns​

SupportedParamType

verifyWitnessProgram()​

verifyWitnessProgram(witness): void

Defined in: packages/scrypt-ts-btc/src/covenant.ts:130

Parameters​

witness​

Witness

Returns​

void

createCovenant()​

static createCovenant\<T>(contract, options?): Covenant

Defined in: packages/scrypt-ts-btc/src/covenant.ts:83

Type Parameters​

• T extends StructObject

Parameters​

contract​

SmartContract\<T>

options?​
network?​

SupportedNetwork

verify?​

boolean

Returns​

Covenant