Struct 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.

For example, the following would build a 2-of-3 multisig script for usage in a pay-to-script-hash (although in this situation MultiSigScript() would be a better choice to generate the script):

use kaspa_txscript::opcodes::codes::*;
use kaspa_txscript::script_builder::{ScriptBuilderResult, ScriptBuilder};
fn build_multisig_script(pub_key1: &[u8], pub_key2: &[u8], pub_key3: &[u8]) -> ScriptBuilderResult<Vec<u8>> {
    Ok(ScriptBuilder::new()
        .add_op(Op2)?
        .add_data(pub_key1)?.add_data(pub_key2)?.add_data(pub_key3)?
        .add_op(Op3)?
        .add_op(OpCheckMultiSig)?
        .drain())
}

Implementations

impl ScriptBuilder

pub fn new() -> Self

pub fn script(&self) -> &[u8]

pub fn drain(&mut self) -> Vec<u8>

pub fn add_op(&mut self, opcode: u8) -> ScriptBuilderResult<&mut Self>

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(&mut self, opcodes: &[u8]) -> ScriptBuilderResult<&mut Self>

pub fn canonical_data_size(data: &[u8]) -> usize

Returns the number of bytes the canonical encoding of the data will take.

pub fn add_data(&mut self, data: &[u8]) -> ScriptBuilderResult<&mut Self>

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(&mut self, val: i64) -> ScriptBuilderResult<&mut Self>

pub fn add_lock_time( &mut self, lock_time: u64, ) -> ScriptBuilderResult<&mut Self>

Gets a u64 lock time, converts it to byte array in little-endian, and then used the add_data function.

pub fn add_sequence(&mut self, sequence: u64) -> ScriptBuilderResult<&mut Self>

Gets a u64 sequence, converts it to byte array in little-endian, and then used the add_data function.

pub fn hex_view_builder(&self) -> HexViewBuilder<'_>

Return HexViewBuilder for the script

pub fn hex_view(&self, offset: usize, width: usize) -> HexView<'_>

Return ready to use HexView for the script

Trait Implementations

impl Default for ScriptBuilder

fn default() -> Self

Returns the “default value” for a type.