StatefulCovenant

bitcoinjs-lib v0.2.9-beta.16

---

bitcoinjs-lib / StatefulCovenant

Class: StatefulCovenant\<StateT>

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

Stateful covenant base class.

Extends

• Covenant

Type Parameters

• StateT extends StructObject

Constructors

new StatefulCovenant()

new StatefulCovenant\<StateT>(state, subContracts, options): StatefulCovenant\<StateT>

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

Parameters

state

StateT

subContracts

AliasedContract\<StateT>[]

options

network?

SupportedNetwork

Returns

StatefulCovenant\<StateT>

Overrides

Covenant.constructor

Properties

accessedInputStateProofs

readonly accessedInputStateProofs: boolean

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

Inherited from

Covenant.accessedInputStateProofs

---

address

readonly address: string

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

Inherited from

Covenant.address

---

lockingScript

readonly lockingScript: Script

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

Inherited from

Covenant.lockingScript

---

subContracts

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

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

Inherited from

Covenant.subContracts

---

tpubkey

readonly tpubkey: string

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

Inherited from

Covenant.tpubkey

---

utxo?

optional utxo: StateProvableUtxo

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

Overrides

Covenant.utxo

---

stateTypeBearer

static stateTypeBearer: typeof SmartContract

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

Accessors

lockingScriptHex

Get Signature

get lockingScriptHex(): ByteString

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

Returns

ByteString

Inherited from

Covenant.lockingScriptHex

---

state

Get Signature

get state(): StateT

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

Returns

StateT

Set Signature

set state(newState): void

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

Parameters

newState

StateT

Returns

void

---

stateHash

Get Signature

get stateHash(): ByteString

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

Returns

ByteString

Overrides

Covenant.stateHash

Methods

bindToUtxo()

bindToUtxo(utxo): this

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

Parameters

utxo

Optional\<StateProvableUtxo, "script">

Returns

this

Overrides

Covenant.bindToUtxo

---

clone()

clone(): StatefulCovenant\<StateT>

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

Clone the covenant.

Returns

StatefulCovenant\<StateT>

---

getSubContract()

getSubContract(alias): SmartContract\<StructObject>

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

Parameters

alias

string = 'default'

Returns

SmartContract\<StructObject>

Inherited from

Covenant.getSubContract

---

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

Inherited from

Covenant.getSubContractCallArg

---

next()

next(newState): StatefulCovenant\<StateT>

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

Get a new covenant instance with the new state.

Parameters

newState

StateT

the new state

Returns

StatefulCovenant\<StateT>

the new covenant

---

verifyWitnessProgram()

verifyWitnessProgram(witness): void

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

Parameters

witness

Witness

Returns

void

Inherited from

Covenant.verifyWitnessProgram

---

createCovenant()

static createCovenant\<StateT>(contract, options?): StatefulCovenant\<StateT>

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

Type Parameters

• StateT extends StructObject

Parameters

contract

SmartContract\<StateT>

options?

network?

SupportedNetwork

verify?

boolean

Returns

StatefulCovenant\<StateT>

Overrides

Covenant.createCovenant