Struct WasmTxBuilder 

pub struct WasmTxBuilder { /* private fields */ }

Implementations

impl WasmTxBuilder

pub fn new(fee_per_word: Nicks) -> Self

Create an empty transaction builder

pub fn from_tx( tx: WasmRawTx, notes: Vec<WasmNote>, spend_conditions: Vec<WasmSpendCondition>, ) -> Result<Self, JsValue>

Reconstruct a builder from raw transaction and its input notes.

To get the builder back, you must pass the notes and their corresponding spend conditions. If serializing the builder, call WasmTxBuilder::all_notes.

pub fn simple_spend( &mut self, notes: Vec<WasmNote>, spend_conditions: Vec<WasmSpendCondition>, recipient: WasmDigest, gift: Nicks, fee_override: Option<Nicks>, refund_pkh: WasmDigest, include_lock_data: bool, ) -> Result<(), JsValue>

Perform a simple-spend on this builder.

It is HIGHLY recommended to not mix simpleSpend with other types of spends.

This performs a fairly complex set of operations, in order to mimic behavior of nockchain CLI wallet’s create-tx option. Note that we do not do 1-1 mapping of that functionality, most notably - if recipient is the same as refund_pkh, we will create 1 seed, while the CLI wallet will create 2.

Another difference is that you should call sign and validate after calling this method.

Internally, the transaction builder takes ALL of the notes provided, and stores them for fee adjustments. If there are multiple notes being used, our fee setup also differs from the CLI, because we first greedily spend the notes out, and then take fees from any remaining refunds.

This function prioritizes using the least number of notes possible, because that lowers the fee used.

You may choose to override the fee with fee_override, but do note that validate will fail, in case this fee is too small.

include_lock_data can be used to include %lock key in note-data, with the SpendCondition used. However, note-data costs 1 << 15 nicks, which means, it can get expensive.

Optional parameter remove_unused_notes, if set to false, will keep the notes in the transaction builder. This is meant to be used whenever additional operations are performed on the builder, such as additional spends, or addPreimage calls. All of these increase the required fee (which can be checked with calcFee), and unused notes can then be used to adjust fees with setFeeAndBalanceRefund or recalcAndSetFee. Once all operations are done, one should call removeUnusedNotes to ensure these notes are not used within the transaction.

pub fn spend(&mut self, spend: WasmSpendBuilder) -> Option<WasmSpendBuilder>

Append a SpendBuilder to this transaction

pub fn set_fee_and_balance_refund( &mut self, fee: Nicks, adjust_fee: bool, include_lock_data: bool, ) -> Result<(), JsValue>

Distributes fee across builder’s spends, and balances refunds out

adjust_fee parameter allows the fee to be slightly tweaked, whenever notes are added or removed to/from the builder’s fee note pool. This is because using more or less notes impacts the exact fee being required. If the caller estimates fee and sets it, adding more notes will change the exact fee needed, and setting this parameter to true will allow one to not have to call this function multiple times.

pub fn recalc_and_set_fee( &mut self, include_lock_data: bool, ) -> Result<(), JsValue>

Recalculate fee and set it, balancing things out with refunds

pub fn add_preimage( &mut self, preimage_jam: &[u8], ) -> Result<Option<WasmDigest>, JsValue>

Appends preimage_jam to all spend conditions that expect this preimage.

pub fn sign(&mut self, signing_key_bytes: &[u8]) -> Result<(), JsValue>

Sign the transaction with a private key.

This will sign all spends that are still missing signature from

pub fn validate(&mut self) -> Result<(), JsValue>

Validate the transaction.

pub fn cur_fee(&self) -> Nicks

Gets the current fee set on all spends.

pub fn calc_fee(&self) -> Nicks

Calculates the fee needed for the transaction.

NOTE: if the transaction is unsigned, this function will estimate the fee needed, supposing all signatures are added. However, this heuristic is only accurate for one signature. In addition, this fee calculation does not estimate the size of missing preimages.

So, first, add missing preimages, and only then calc the fee. If you’re building a multisig transaction, this value might be incorrect.

pub fn all_notes(&self) -> WasmTxNotes

pub fn build(&self) -> Result<WasmRawTx, JsValue>

Trait Implementations

impl From<WasmTxBuilder> for JsValue

fn from(value: WasmTxBuilder) -> Self

Converts to this type from the input type.

impl FromWasmAbi for WasmTxBuilder

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) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for WasmTxBuilder

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 WasmTxBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<WasmTxBuilder>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for WasmTxBuilder

fn is_none(abi: &Self::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 WasmTxBuilder

fn none() -> Self::Abi

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

impl RefFromWasmAbi for WasmTxBuilder

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<WasmTxBuilder>

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: Self::Abi) -> Self::Anchor

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

impl RefMutFromWasmAbi for WasmTxBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<WasmTxBuilder>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for WasmTxBuilder

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for WasmTxBuilder

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[WasmTxBuilder]>

impl VectorIntoWasmAbi for WasmTxBuilder

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[WasmTxBuilder]>) -> Self::Abi

impl WasmDescribe for WasmTxBuilder

fn describe()

impl WasmDescribeVector for WasmTxBuilder

fn describe_vector()

impl SupportsConstructor for WasmTxBuilder

impl SupportsInstanceProperty for WasmTxBuilder

impl SupportsStaticProperty for WasmTxBuilder