cardano-web3-js / CW3Types / TxBuilder

Class: TxBuilder

Defined in: src/core/txBuilder.ts:6

Constructors

Constructor

new TxBuilder(cw3): TxBuilder

Defined in: src/core/txBuilder.ts:20

Parameters

cw3

CardanoWeb3

Returns

TxBuilder

Properties

__txBuilder

__txBuilder: TransactionBuilder

Defined in: src/core/txBuilder.ts:18

---

governance

governance: object

Defined in: src/core/txBuilder.ts:572

Governance related methods

delegateToDRep()

delegateToDRep: (rewardAddress, drep, redeemer?) => TxBuilder

Parameters

rewardAddress

string

drep

DRep

redeemer?

string

Returns

TxBuilder

deregisterDRep()

deregisterDRep: (rewardAddress, redeemer?) => TxBuilder

Parameters

rewardAddress

string

redeemer?

string

Returns

TxBuilder

registerDRep()

registerDRep: (rewardAddress, drepInfo?, redeemer?) => TxBuilder

Parameters

rewardAddress

string

drepInfo?

DrepAnchor

redeemer?

string

Returns

TxBuilder

updateDRep()

updateDRep: (rewardAddress, drepAnchor?, redeemer?) => TxBuilder

Parameters

rewardAddress

string

drepAnchor?

DrepAnchor

redeemer?

string

Returns

TxBuilder

---

stake

stake: object

Defined in: src/core/txBuilder.ts:363

Stake related methods

delegateTo()

delegateTo: (rewardAddress, poolId, redeemer?) => TxBuilder

Parameters

rewardAddress

string

poolId

string

redeemer?

string

Returns

TxBuilder

deregister()

deregister: (rewardAddress, redeemer?) => TxBuilder

Parameters

rewardAddress

string

redeemer?

string

Returns

TxBuilder

register()

register: (rewardAddress) => TxBuilder

Parameters

rewardAddress

string

Returns

TxBuilder

withdrawRewards()

withdrawRewards: (rewardAddress, amount, redeemer?) => TxBuilder

Parameters

rewardAddress

string

amount

bigint

redeemer?

string

Returns

TxBuilder

Methods

addInputs()

addInputs(utxos): TxBuilder

Defined in: src/core/txBuilder.ts:122

Add UTXOs to spend from

Parameters

utxos

Utxo[]

UTXOs to spend from

Returns

TxBuilder

TxBuilder instance

---

addMetadataJson()

addMetadataJson(label, metadata, conversion): TxBuilder

Defined in: src/core/txBuilder.ts:347

Add metadata as JSON (with conversion) to transaction

Parameters

label

number

Metadata label

metadata

any

Metadata to attach

conversion

Conversion type (optional, 0: default, 1: detailed, 2: more detailed)

0 | 1 | 2

Returns

TxBuilder

TxBuilder instance

---

addMetadataString()

addMetadataString(label, metadata): TxBuilder

Defined in: src/core/txBuilder.ts:328

Add metadata as string to transaction

Parameters

label

number

Metadata label

metadata

any

Metadata to attach

Returns

TxBuilder

TxBuilder instance

---

addMint()

addMint(assets, redeemer?): TxBuilder

Defined in: src/core/txBuilder.ts:278

Add minting of assets

Parameters

assets

Asset[]

Assets to mint

redeemer?

string

Redeemer to use (optional)

Returns

TxBuilder

TxBuilder instance

---

addOutputs()

addOutputs(outputs, datum?, script?): TxBuilder

Defined in: src/core/txBuilder.ts:184

Add Outputs to pay to addresses

Parameters

outputs

Output[]

Outputs to pay to

datum?

DatumOutput

Datum to attach (optional)

script?

Script

Script to attach (optional)

Returns

TxBuilder

TxBuilder instance

---

addRequiredSignerByAddress()

addRequiredSignerByAddress(address): TxBuilder

Defined in: src/core/txBuilder.ts:245

Add Required Signer by address

Parameters

address

string

Address of required signer

Returns

TxBuilder

TxBuilder instance

---

addRequiredSignerByKeyHash()

addRequiredSignerByKeyHash(keyHash): TxBuilder

Defined in: src/core/txBuilder.ts:265

Add Required Signer by key hash

Parameters

keyHash

string

Key hash of required signer

Returns

TxBuilder

TxBuilder instance

---

apply()

apply(): Promise<TxBuilder>

Defined in: src/core/txBuilder.ts:858

Apply all methods and return TxFinalizer instance

Returns

Promise<TxBuilder>

TxFinalizer instance

---

applyAndBuild()

applyAndBuild(): Promise<TxFinalizer>

Defined in: src/core/txBuilder.ts:970

Apply all methods, build TX and return TxFinalizer instance

Returns

Promise<TxFinalizer>

TxFinalizer instance

---

attachScript()

attachScript(script): TxBuilder

Defined in: src/core/txBuilder.ts:28

Attach script to transaction builder for using in next operations

Parameters

script

Script

Script to attach

Returns

TxBuilder

TxBuilder instance

---

collectFrom()

collectFrom(utxos, redeemer?): TxBuilder

Defined in: src/core/txBuilder.ts:60

Add script UTXOs to spend from

Parameters

utxos

Utxo[]

UTXOs to collect from

redeemer?

string

Redeemer to use (optional)

Returns

TxBuilder

TxBuilder instance

---

payToContract()

payToContract(output, datum, script?): TxBuilder

Defined in: src/core/txBuilder.ts:168

Add Output with data to pay to contract with address check

Parameters

output

Output

Output to pay to

datum

DatumOutput

Datum to attach

script?

Script

Script to attach

Returns

TxBuilder

TxBuilder instance

Throws

Error if address is not script type

---

readFrom()

readFrom(utxos): TxBuilder

Defined in: src/core/txBuilder.ts:39

Add UTXOs to read referenced data from

Parameters

utxos

Utxo[]

UTXOs to read from

Returns

TxBuilder

TxBuilder instance

---

setChangeAddress()

setChangeAddress(address): TxBuilder

Defined in: src/core/txBuilder.ts:235

Set change address

Parameters

address

string

Change address

Returns

TxBuilder

TxBuilder instance

---

setCoinSelection()

setCoinSelection(strategy): TxBuilder

Defined in: src/core/txBuilder.ts:849

Set coin selection strategy

-1: Include all inputs

0: LargestFirst: Performs CIP2's Largest First ada-only selection. Will error if outputs contain non-ADA assets

1: RandomImprove: Performs CIP2's Random Improve ada-only selection. Will error if outputs contain non-ADA assets

2: LargestFirstMultiAsset: Same as LargestFirst, but before adding ADA, will insert by largest-first for each asset type

3: RandomImproveMultiAsset: Same as RandomImprove, but before adding ADA, will insert by random-improve for each asset type

Parameters

strategy

Coin selection strategy

-1 | 0 | 1 | 2 | 3

Returns

TxBuilder

TxBuilder instance

---

setTtl()

setTtl(slotsOffset): TxBuilder

Defined in: src/core/txBuilder.ts:222

Set transaction validity end interval (TTL) in slots from now

Parameters

slotsOffset

number

Slots offset

Returns

TxBuilder

TxBuilder instance

---

validFrom()

validFrom(unixTime): TxBuilder

Defined in: src/core/txBuilder.ts:196

Set transaction validity start interval

Parameters

unixTime

number

Unix timestamp

Returns

TxBuilder

TxBuilder instance

---

validTo()

validTo(unixTime): TxBuilder

Defined in: src/core/txBuilder.ts:209

Set transaction validity end interval by Unix timestamp

Parameters

unixTime

number

Unix timestamp

Returns

TxBuilder

TxBuilder instance

---

withRemoteProtocolParams()

withRemoteProtocolParams(remoteProtocolParams): TxBuilder

Defined in: src/core/txBuilder.ts:818

Fetch protocol parameters from remote on TX build

Parameters

remoteProtocolParams

boolean

Fetch protocol parameters from remote

Returns

TxBuilder

TxBuilder instance

---

withRemoteTxEvaluate()

withRemoteTxEvaluate(remoteTxEvaluate): TxBuilder

Defined in: src/core/txBuilder.ts:828

Evaluate TX execution cost remotely

Parameters

remoteTxEvaluate

boolean

Evaluate TX execution cost remotely

Returns

TxBuilder

TxBuilder instance