cardano-web3-js / CML / TransactionBuilder

Class: TransactionBuilder

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7089

Methods

add_auxiliary_data()

add_auxiliary_data(new_aux_data): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7132

Parameters

new_aux_data

AuxiliaryData

Returns

void

---

add_cert()

add_cert(result): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7125

Parameters

result

CertificateBuilderResult

Returns

void

---

add_change_if_needed()

add_change_if_needed(address, include_exunits): boolean

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7195

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

Parameters

address

Address

include_exunits

boolean

Returns

boolean

---

add_collateral()

add_collateral(result): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7139

Parameters

result

InputBuilderResult

Returns

void

---

add_input()

add_input(result): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7102

Parameters

result

InputBuilderResult

Returns

void

---

add_mint()

add_mint(result): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7133

Parameters

result

MintBuilderResult

Returns

void

---

add_output()

add_output(builder_result): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7115

Add explicit output via a TransactionOutput object

Parameters

builder_result

SingleOutputBuilderResult

Returns

void

---

add_proposal()

add_proposal(result): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7126

Parameters

result

ProposalBuilderResult

Returns

void

---

add_reference_input()

add_reference_input(utxo): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7111

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

Parameters

utxo

TransactionUnspentOutput

Returns

void

---

add_required_signer()

add_required_signer(hash): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7140

Parameters

hash

Ed25519KeyHash

Returns

void

---

add_utxo()

add_utxo(result): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7103

Parameters

result

InputBuilderResult

Returns

void

---

add_vote()

add_vote(result): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7127

Parameters

result

VoteBuilderResult

Returns

void

---

add_withdrawal()

add_withdrawal(result): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7129

Parameters

result

WithdrawalBuilderResult

Returns

void

---

build()

build(algo, change_address): SignedTxBuilder

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7178

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

Parameters

algo

Default

change_address

Address

Returns

SignedTxBuilder

---

build_for_evaluation()

build_for_evaluation(algo, change_address): TxRedeemerBuilder

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7173

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

Parameters

algo

Default

change_address

Address

Returns

TxRedeemerBuilder

---

fee_for_input()

fee_for_input(result): bigint

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7107

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

Parameters

result

InputBuilderResult

Returns

bigint

---

fee_for_output()

fee_for_output(builder): bigint

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7119

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

Parameters

builder

SingleOutputBuilderResult

Returns

bigint

---

free()

free(): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7091

Returns

void

---

full_size()

full_size(): number

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7166

Returns

number

---

get_auxiliary_data()

get_auxiliary_data(): AuxiliaryData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7130

Returns

AuxiliaryData

---

get_deposit()

get_deposit(): bigint

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7163

Returns

bigint

---

get_explicit_input()

get_explicit_input(): Value

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7146

does not include refunds or withdrawals

Returns

Value

---

get_explicit_output()

get_explicit_output(): Value

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7162

does not include fee

Returns

Value

---

get_fee_if_set()

get_fee_if_set(): bigint

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7164

Returns

bigint

---

get_implicit_input()

get_implicit_input(): Value

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7150

withdrawals and refunds

Returns

Value

---

get_mint()

get_mint(): Mint

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7137

Returns a copy of the current mint state in the builder

Returns

Mint

---

get_total_input()

get_total_input(): Value

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7154

Return explicit input plus implicit input plus mint

Returns

Value

---

get_total_output()

get_total_output(): Value

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7158

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

Returns

Value

---

get_withdrawals()

get_withdrawals(): MapRewardAccountToCoin

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7128

Returns

MapRewardAccountToCoin

---

min_fee()

min_fee(script_calulation): bigint

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7188

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

Parameters

script_calulation

boolean

Returns

bigint

---

network_id()

network_id(): NetworkId

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7142

Returns

NetworkId

---

output_sizes()

output_sizes(): Uint32Array

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7167

Returns

Uint32Array

---

select_utxos()

select_utxos(strategy): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7101

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.

Parameters

strategy

CoinSelectionStrategyCIP2

Returns

void

---

set_auxiliary_data()

set_auxiliary_data(new_aux_data): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7131

Parameters

new_aux_data

AuxiliaryData

Returns

void

---

set_collateral_return()

set_collateral_return(output): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7165

Parameters

output

TransactionOutput

Returns

void

---

set_current_treasury_value()

set_current_treasury_value(current_treasury_value): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7122

Parameters

current_treasury_value

bigint

Returns

void

---

set_donation()

set_donation(donation): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7121

Parameters

donation

bigint

Returns

void

---

set_exunits()

set_exunits(redeemer, ex_units): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7182

used to override the exunit values initially provided when adding inputs

Parameters

redeemer

RedeemerWitnessKey

ex_units

ExUnits

Returns

void

---

set_fee()

set_fee(fee): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7120

Parameters

fee

bigint

Returns

void

---

set_network_id()

set_network_id(network_id): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7141

Parameters

network_id

NetworkId

Returns

void

---

set_ttl()

set_ttl(ttl): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7123

Parameters

ttl

bigint

Returns

void

---

set_validity_start_interval()

set_validity_start_interval(validity_start_interval): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7124

Parameters

validity_start_interval

bigint

Returns

void

---

new()

static new(cfg): TransactionBuilder

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:7138

Parameters

cfg

TransactionBuilderConfig

Returns

TransactionBuilder