Class Script

VtxoScript is a script that contains a list of tapleaf scripts. It is used to create vtxo scripts.

Example

const vtxoScript = new VtxoScript([new Uint8Array(32), new Uint8Array(32

Hierarchy (View Summary)

VtxoScript
- Script

Constructors

constructor

new Script(options: VHTLC.Options): VHTLC.Script
Parameters
- options: VHTLC.Options
Returns VHTLC.Script
Overrides VtxoScript.constructor
- Defined in src/script/vhtlc.ts:61

Properties

`Readonly`claimScript

claimScript: string

`Readonly`leaves

leaves: TapLeafScript[]

`Readonly`options

options: VHTLC.Options

`Readonly`refundScript

refundScript: string

`Readonly`refundWithoutReceiverScript

refundWithoutReceiverScript: string

`Readonly`scripts

scripts: Bytes[]

`Readonly`tweakedPublicKey

tweakedPublicKey: Bytes

`Readonly`unilateralClaimScript

unilateralClaimScript: string

`Readonly`unilateralRefundScript

unilateralRefundScript: string

`Readonly`unilateralRefundWithoutReceiverScript

unilateralRefundWithoutReceiverScript: string

Accessors

pkScript

get pkScript(): Bytes
Returns Bytes
Inherited from VtxoScript.pkScript
- Defined in src/script/base.ts:78

Methods

address

address(prefix: string, serverPubKey: Bytes): ArkAddress
Parameters
- prefix: string
- serverPubKey: Bytes
Returns ArkAddress
Inherited from VtxoScript.address
- Defined in src/script/base.ts:74

claim

claim(): TapLeafScript
Returns TapLeafScript
- Defined in src/script/vhtlc.ts:127

encode

encode(): Bytes
Returns Bytes
Inherited from VtxoScript.encode
- Defined in src/script/base.ts:69

exitPaths

exitPaths(): (ConditionCSVMultisigTapscript.Type | CSVMultisigTapscript.Type)[]
Returns (ConditionCSVMultisigTapscript.Type | CSVMultisigTapscript.Type)[]
Inherited from VtxoScript.exitPaths
- Defined in src/script/base.ts:99

findLeaf

findLeaf(scriptHex: string): TapLeafScript
Parameters
- scriptHex: string
Returns TapLeafScript
Inherited from VtxoScript.findLeaf
- Defined in src/script/base.ts:89

onchainAddress

onchainAddress(network: BTC_NETWORK): string
Parameters
- network: BTC_NETWORK
Returns string
Inherited from VtxoScript.onchainAddress
- Defined in src/script/base.ts:82

unilateralRefundWithoutReceiver

unilateralRefundWithoutReceiver(): TapLeafScript
Returns TapLeafScript
- Defined in src/script/vhtlc.ts:147

`Static`decode

decode(tapTree: Bytes): VtxoScript
Parameters
- tapTree: Bytes
Returns VtxoScript
Inherited from VtxoScript.decode
- Defined in src/script/base.ts:46

Class Script

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VHTLC.Script

Properties

ReadonlyclaimScript

Readonlyleaves

Readonlyoptions

ReadonlyrefundScript

ReadonlyrefundWithoutReceiverScript

Readonlyscripts

ReadonlytweakedPublicKey

ReadonlyunilateralClaimScript

ReadonlyunilateralRefundScript

ReadonlyunilateralRefundWithoutReceiverScript

Accessors

pkScript

Returns Bytes

Methods

address

Parameters

Returns ArkAddress

claim

Returns TapLeafScript

encode

Returns Bytes

exitPaths

Returns (ConditionCSVMultisigTapscript.Type | CSVMultisigTapscript.Type)[]

findLeaf

Parameters

Returns TapLeafScript

onchainAddress

Parameters

Returns string

refund

Returns TapLeafScript

refundWithoutReceiver

Returns TapLeafScript

unilateralClaim

Returns TapLeafScript

unilateralRefund

Returns TapLeafScript

unilateralRefundWithoutReceiver

Returns TapLeafScript

Staticdecode

Parameters

Returns VtxoScript

Settings

On This Page

`Readonly`claimScript

`Readonly`leaves

`Readonly`options

`Readonly`refundScript

`Readonly`refundWithoutReceiverScript

`Readonly`scripts

`Readonly`tweakedPublicKey

`Readonly`unilateralClaimScript

`Readonly`unilateralRefundScript

`Readonly`unilateralRefundWithoutReceiverScript

`Static`decode