Struct ergo_lib_wasm::tx_builder::TxBuilder

pub struct TxBuilder(_);

Unsigned transaction builder

Implementations

impl TxBuilder

pub fn SUGGESTED_TX_FEE() -> BoxValue

Suggested transaction fee (semi-default value used across wallets and dApps as of Oct 2020)

pub fn new(
    box_selection: &BoxSelection,
    output_candidates: &ErgoBoxCandidates,
    current_height: u32,
    fee_amount: &BoxValue,
    change_address: &Address,
    min_change_value: &BoxValue
) -> TxBuilder

Creates new TxBuilder box_selection - selected input boxes (via super::box_selector) output_candidates - output boxes to be "created" in this transaction, current_height - chain height that will be used in additionally created boxes (change, miner's fee, etc.), fee_amount - miner's fee, change_address - change (inputs - outputs) will be sent to this address, min_change_value - minimal value of the change to be sent to change_address, value less than that will be given to miners,

pub fn set_data_inputs(&mut self, data_inputs: &DataInputs)

Set transaction's data inputs

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

Build the unsigned transaction

pub fn box_selection(&self) -> BoxSelection

Get inputs

pub fn data_inputs(&self) -> DataInputs

Get data inputs

pub fn output_candidates(&self) -> ErgoBoxCandidates

Get outputs EXCLUDING fee and change

pub fn current_height(&self) -> u32

Get current height

pub fn fee_amount(&self) -> BoxValue

Get fee amount

pub fn change_address(&self) -> Address

Get change

pub fn min_change_value(&self) -> BoxValue

Get min change value

Trait Implementations

impl FromWasmAbi for TxBuilder

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 TxBuilder

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 OptionFromWasmAbi for TxBuilder

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 TxBuilder

fn none() -> Self::Abi

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

impl RefFromWasmAbi for TxBuilder

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, TxBuilder>

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 TxBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, TxBuilder>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for TxBuilder

fn describe()