taproot_builder.md

Module 0x4::taproot_builder

Taproot is a module that provides Bitcoin Taproot related functions.

• Struct TaprootBuilder
• Struct NodeInfo
• Constants
• Function new
• Function add_leaf
• Function finalize

use 0x1::option;
use 0x1::vector;
use 0x2::bcs;
use 0x2::compare;
use 0x2::consensus_codec;
use 0x2::hash;
use 0x2::result;
use 0x4::script_buf;

Struct TaprootBuilder

struct TaprootBuilder has drop, store

Struct NodeInfo

struct NodeInfo has drop, store

Constants

const ErrorInvalidMerkleTreeDepth: u64 = 1;

const ErrorNodeNotInDfsOrder: u64 = 2;

const ErrorOverCompleteTree: u64 = 3;

const ErrorUnreachable: u64 = 4;

const TAG_TAP_BRANCH: vector<u8> = [84, 97, 112, 66, 114, 97, 110, 99, 104];

const TAG_TAP_LEAF: vector<u8> = [84, 97, 112, 76, 101, 97, 102];

const TAPROOT_CONTROL_MAX_NODE_COUNT: u64 = 128;

Tapscript leaf version.

const TAPROOT_LEAF_TAPSCRIPT: u8 = 192;

Function new

public fun new(): taproot_builder::TaprootBuilder

Function add_leaf

public fun add_leaf(builder: &mut taproot_builder::TaprootBuilder, depth: u8, script_buf: script_buf::ScriptBuf): &mut taproot_builder::TaprootBuilder

Function finalize

Finalize the builder, return the state root, We use the address to represent the hash.

public fun finalize(builder: taproot_builder::TaprootBuilder): result::Result<address, taproot_builder::TaprootBuilder>