Class Script

DelegateVtxo.Script extends DefaultVtxo.Script and adds a delegate path.

Example

const vtxoScript = new DelegateVtxo.Script({
    pubKey: new Uint8Array(32),
    serverPubKey: new Uint8Array(32),
    delegatePubKey: new Uint8Array(32),
    csvTimelock: {
        value: 605184n,
        type: "seconds"
    }
});

console.log("script pub key:", vtxoScript.pkScript)

Hierarchy (View Summary)

VtxoScript
- Script

Index

Constructors

constructor

new Script(options: DelegateVtxo.Options): DelegateVtxo.Script
Create a delegated virtual output script with forfeit, exit, and delegate paths.
Parameters
- options: DelegateVtxo.Options
Returns DelegateVtxo.Script
Overrides VtxoScript.constructor
- Defined in packages/ts-sdk/src/script/delegate.ts:40

Properties

`Readonly`defaultVtxo

defaultVtxo: DefaultVtxo.Script

`Readonly`delegateScript

delegateScript: string

`Readonly`leaves

leaves: TapLeafScript[]

`Readonly`options

options: DelegateVtxo.Options

`Readonly`pkScript

pkScript: Bytes

`Readonly`scripts

scripts: Bytes[]

Raw tapscript bytes for each leaf

`Readonly`tweakedPublicKey

tweakedPublicKey: Bytes

Methods

address

address(prefix?: string, serverPubKey: Bytes): ArkAddress
Build the Arkade address corresponding to this virtual output script.
Parameters
- prefix: string = DEFAULT_NETWORK.hrp
  Bech32 human-readable prefix
- serverPubKey: Bytes
  32-byte Arkade server public key
Returns ArkAddress
Arkade address for this script

See
ArkAddress
Inherited from VtxoScript.address
- Defined in packages/ts-sdk/src/script/base.ts:112

delegate

delegate(): TapLeafScript
Return the delegate tapleaf script.

Returns TapLeafScript
- Defined in packages/ts-sdk/src/script/delegate.ts:64

encode

encode(): Bytes
Encode the virtual output script to a TapTree byte representation.

Returns Bytes
Encoded TapTree bytes

See
decode
Inherited from VtxoScript.encode
- Defined in packages/ts-sdk/src/script/base.ts:93

exit

exit(): TapLeafScript
Return the unilateral exit tapleaf script.

Returns TapLeafScript
- Defined in packages/ts-sdk/src/script/delegate.ts:59

exitPaths

exitPaths(): (ConditionCSVMultisigTapscript.Type | CSVMultisigTapscript.Type)[]
Return all unilateral exit paths embedded in the virtual output script.

Returns (ConditionCSVMultisigTapscript.Type | CSVMultisigTapscript.Type)[]
CSV-based exit paths found in the leaves

See
getSequence
Inherited from VtxoScript.exitPaths
- Defined in packages/ts-sdk/src/script/base.ts:153

findLeaf

findLeaf(scriptHex: string): TapLeafScript
Look up a tapleaf script by its hex-encoded tapscript body.
Parameters
- scriptHex: string
  Hex-encoded tapscript body without the leaf version byte
Returns TapLeafScript
Matching tapleaf script

Throws
Error if no matching leaf exists
Inherited from VtxoScript.findLeaf
- Defined in packages/ts-sdk/src/script/base.ts:137

forfeit

forfeit(): TapLeafScript
Return the forfeit tapleaf script.

Returns TapLeafScript
- Defined in packages/ts-sdk/src/script/delegate.ts:54

onchainAddress

onchainAddress(network?: BTC_NETWORK): string
Build the Taproot onchain address corresponding to this virtual output script.
Parameters
- network: BTC_NETWORK = DEFAULT_NETWORK
  Bitcoin network descriptor
Returns string
Taproot onchain address

See
address
Inherited from VtxoScript.onchainAddress
- Defined in packages/ts-sdk/src/script/base.ts:123

`Static`decode

decode(tapTree: Bytes): VtxoScript
Decode a virtual output script from an encoded TapTree.
Parameters
- tapTree: Bytes
  Encoded TapTree bytes
Returns VtxoScript
Decoded virtual output script

Throws
Error if the TapTree cannot be decoded into a valid script set

See
encode
Inherited from VtxoScript.decode
- Defined in packages/ts-sdk/src/script/base.ts:55

Class Script

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DelegateVtxo.Script

Properties

ReadonlydefaultVtxo

ReadonlydelegateScript

Readonlyleaves

Readonlyoptions

ReadonlypkScript

Readonlyscripts

ReadonlytweakedPublicKey

Methods

address

Parameters

Returns ArkAddress

See

delegate

Returns TapLeafScript

encode

Returns Bytes

See

exit

Returns TapLeafScript

exitPaths

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

See

findLeaf

Parameters

Returns TapLeafScript

Throws

forfeit

Returns TapLeafScript

onchainAddress

Parameters

Returns string

See

Staticdecode

Parameters

Returns VtxoScript

Throws

See

Settings

On This Page

`Readonly`defaultVtxo

`Readonly`delegateScript

`Readonly`leaves

`Readonly`options

`Readonly`pkScript

`Readonly`scripts

`Readonly`tweakedPublicKey

`Static`decode