Struct kaspa_wasm::ScriptBuilder

pub struct ScriptBuilder { /* private fields */ }

ScriptBuilder provides a facility for building custom scripts. It allows you to push opcodes, ints, and data while respecting canonical encoding. In general it does not ensure the script will execute correctly, however any data pushes which would exceed the maximum allowed script engine limits and are therefore guaranteed not to execute will not be pushed and will result in the Script function returning an error.

Implementations

impl ScriptBuilder

pub fn inner(&self) -> MutexGuard<'_, ScriptBuilder>

impl ScriptBuilder

pub fn script(&self) -> String

Get script bytes represented by a hex string.

pub fn drain(&self) -> String

Drains (empties) the script builder, returning the script bytes represented by a hex string.

pub fn add_op(&self, opcode: u8) -> Result<ScriptBuilder, Error>

Pushes the passed opcode to the end of the script. The script will not be modified if pushing the opcode would cause the script to exceed the maximum allowed script engine size.

pub fn add_ops(&self, opcodes: JsValue) -> Result<ScriptBuilder, Error>

pub fn add_data(&self, data: JsValue) -> Result<ScriptBuilder, Error>

AddData pushes the passed data to the end of the script. It automatically chooses canonical opcodes depending on the length of the data.

A zero length buffer will lead to a push of empty data onto the stack (Op0 = OpFalse) and any push of data greater than MAX_SCRIPT_ELEMENT_SIZE will not modify the script since that is not allowed by the script engine.

Also, the script will not be modified if pushing the data would cause the script to exceed the maximum allowed script engine size MAX_SCRIPTS_SIZE.

pub fn add_i64(&self, val: i64) -> Result<ScriptBuilder, Error>

pub fn add_lock_time(&self, lock_time: u64) -> Result<ScriptBuilder, Error>

pub fn add_sequence(&self, sequence: u64) -> Result<ScriptBuilder, Error>

Trait Implementations

impl Clone for ScriptBuilder

fn clone(&self) -> ScriptBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<ScriptBuilder> for JsValue

fn from(value: ScriptBuilder) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for ScriptBuilder

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> ScriptBuilder

Recover a Self from Self::Abi.

impl IntoWasmAbi for ScriptBuilder

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for ScriptBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, ScriptBuilder>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <ScriptBuilder as LongRefFromWasmAbi>::Abi ) -> <ScriptBuilder as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for ScriptBuilder

fn is_none(abi: &<ScriptBuilder as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for ScriptBuilder

fn none() -> <ScriptBuilder as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for ScriptBuilder

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, ScriptBuilder>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <ScriptBuilder as RefFromWasmAbi>::Abi ) -> <ScriptBuilder as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for ScriptBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, ScriptBuilder>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <ScriptBuilder as RefMutFromWasmAbi>::Abi ) -> <ScriptBuilder as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi