Struct TransactionBuilder 

pub struct TransactionBuilder(/* private fields */);

Implementations

impl TransactionBuilder

pub fn select_utxos( &mut self, strategy: CoinSelectionStrategyCIP2, ) -> Result<(), JsError>

This automatically selects and adds inputs from {inputs} consisting of just enough to cover the outputs that have already been added. This should be called after adding all certs/outputs/etc and will be an error otherwise. Uses CIP2: https://github.com/cardano-foundation/CIPs/blob/master/CIP-0002/CIP-0002.md Adding a change output must be called after via TransactionBuilder::add_change_if_needed() This function, diverging from CIP2, takes into account fees and will attempt to add additional inputs to cover the minimum fees. This does not, however, set the txbuilder’s fee.

pub fn add_input(&mut self, result: &InputBuilderResult) -> Result<(), JsError>

pub fn add_utxo(&mut self, result: &InputBuilderResult)

pub fn fee_for_input( &self, result: &InputBuilderResult, ) -> Result<Coin, JsError>

calculates how much the fee would increase if you added a given output

pub fn add_reference_input(&mut self, utxo: &TransactionUnspentOutput)

Add a reference input. Must be called BEFORE adding anything (inputs, certs, etc) that refer to this reference input.

pub fn add_output( &mut self, builder_result: &SingleOutputBuilderResult, ) -> Result<(), JsError>

Add explicit output via a TransactionOutput object

pub fn fee_for_output( &self, builder: &SingleOutputBuilderResult, ) -> Result<Coin, JsError>

calculates how much the fee would increase if you added a given output

pub fn set_fee(&mut self, fee: Coin)

pub fn set_donation(&mut self, donation: Coin)

pub fn set_current_treasury_value(&mut self, current_treasury_value: Coin)

pub fn set_ttl(&mut self, ttl: Slot)

pub fn set_validity_start_interval(&mut self, validity_start_interval: Slot)

pub fn add_cert(&mut self, result: &CertificateBuilderResult)

pub fn add_proposal(&mut self, result: ProposalBuilderResult)

pub fn add_vote(&mut self, result: VoteBuilderResult)

pub fn get_withdrawals(&self) -> Option<Withdrawals>

pub fn add_withdrawal(&mut self, result: &WithdrawalBuilderResult)

pub fn get_auxiliary_data(&self) -> Option<AuxiliaryData>

pub fn set_auxiliary_data(&mut self, new_aux_data: &AuxiliaryData)

pub fn add_auxiliary_data(&mut self, new_aux_data: &AuxiliaryData)

pub fn add_mint(&mut self, result: &MintBuilderResult) -> Result<(), JsError>

pub fn get_mint(&self) -> Option<Mint>

Returns a copy of the current mint state in the builder

pub fn new(cfg: &TransactionBuilderConfig) -> Self

pub fn add_collateral( &mut self, result: &InputBuilderResult, ) -> Result<(), JsError>

pub fn add_required_signer(&mut self, hash: &Ed25519KeyHash)

pub fn set_network_id(&mut self, network_id: &NetworkId)

pub fn network_id(&self) -> Option<NetworkId>

pub fn get_explicit_input(&self) -> Result<Value, JsError>

does not include refunds or withdrawals

pub fn get_implicit_input(&self) -> Result<Value, JsError>

withdrawals and refunds

pub fn get_total_input(&self) -> Result<Value, JsError>

Return explicit input plus implicit input plus mint

pub fn get_total_output(&self) -> Result<Value, JsError>

Return explicit output plus implicit output plus burn (does not consider fee directly)

pub fn get_explicit_output(&self) -> Result<Value, JsError>

does not include fee

pub fn get_deposit(&self) -> Result<Coin, JsError>

pub fn get_fee_if_set(&self) -> Option<Coin>

pub fn set_collateral_return(&mut self, output: &TransactionOutput)

pub fn full_size(&self) -> Result<usize, JsError>

pub fn output_sizes(&self) -> Vec<usize>

pub fn build_for_evaluation( &self, algo: ChangeSelectionAlgo, change_address: &Address, ) -> Result<TxRedeemerBuilder, JsError>

Builds the transaction and moves to the next step redeemer units can be added and a draft tx can be evaluated NOTE: is_valid set to true

pub fn build( &mut self, algo: ChangeSelectionAlgo, change_address: &Address, ) -> Result<SignedTxBuilder, JsError>

Builds the transaction and moves to the next step where any real witness can be added NOTE: is_valid set to true

pub fn set_exunits(&mut self, redeemer: &RedeemerWitnessKey, ex_units: &ExUnits)

used to override the exunit values initially provided when adding inputs

pub fn min_fee(&self, script_calulation: bool) -> Result<Coin, JsError>

warning: sum of all parts of a transaction must equal 0. You cannot just set the fee to the min value and forget about it warning: min_fee may be slightly larger than the actual minimum fee (ex: a few lovelaces) this is done to simplify the library code, but can be fixed later

pub fn add_change_if_needed( &mut self, address: &Address, include_exunits: bool, ) -> Result<bool, JsError>

Warning: this function will mutate the /fee/ field Make sure to call this function last after setting all other tx-body properties Editing inputs, outputs, mint, etc. after change been calculated might cause a mismatch in calculated fee versus the required fee

Trait Implementations

impl AsRef<TransactionBuilder> for TransactionBuilder

fn as_ref(&self) -> &TransactionBuilder

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TransactionBuilder

fn clone(&self) -> TransactionBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<TransactionBuilder> for JsValue

fn from(value: TransactionBuilder) -> Self

Converts to this type from the input type.

impl From<TransactionBuilder> for TransactionBuilder

fn from(native: TransactionBuilder) -> Self

Converts to this type from the input type.

impl FromWasmAbi for TransactionBuilder

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 Into<TransactionBuilder> for TransactionBuilder

fn into(self) -> TransactionBuilder

Converts this type into the (usually inferred) input type.

impl IntoWasmAbi for TransactionBuilder

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 TransactionBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<TransactionBuilder>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for TransactionBuilder

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 TransactionBuilder

fn none() -> Self::Abi

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

impl RefFromWasmAbi for TransactionBuilder

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<TransactionBuilder>

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 TransactionBuilder

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<TransactionBuilder>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for TransactionBuilder

type Error = JsValue

The type returned in the event of a conversion error.

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

Performs the conversion.

impl VectorFromWasmAbi for TransactionBuilder

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

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

impl VectorIntoJsValue for TransactionBuilder

fn vector_into_jsvalue(vector: Box<[TransactionBuilder]>) -> JsValue

impl VectorIntoWasmAbi for TransactionBuilder

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

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

impl WasmDescribe for TransactionBuilder

fn describe()

impl WasmDescribeVector for TransactionBuilder

fn describe_vector()

impl SupportsConstructor for TransactionBuilder

impl SupportsInstanceProperty for TransactionBuilder

impl SupportsStaticProperty for TransactionBuilder