Transaction Basics
Working with transactions and its various options
The MeshTxBuilder
is a powerful low-level APIs that allows you to build and sign transactions.
The MeshTxBuilder
is a powerful interface where the higher level Transaction
class is indeed a pre-built combination of the MeshTxBuilder
APIs. With these lower level APIs, it builds the object to be passing to the serialization libraries like cardano-sdk and Whisky SDK to construct transactions.
In this page, we will cover how to initialize the MeshTxBuilder
and the basic operations of building a transaction.
Initialize Tx Builder
To start building an customized transaction, you need to first initialize MeshTxBuilder
:
The MeshTxBuilder
instance has the following signature:
There are 6 optional fields to pass in to initialized the lower level APIs instance:
serializer
: The default serializer isCSLSerializer
. You can pass in your own serializer instance.fetcher
: When you build the transaction without sufficient fields as required by the serialization library, we would index the blockchain to fill the information for you. Affected APIs aretxIn
,txInCollateral
,spendingTxInReference
.submitter
: It is used if you would like to use thesubmitter
submitTx API directly from the instance.evaluator
: It would perform redeemer execution unit optimization, returning error message in case of invalid transaction.isHydra
: Use another set of default protocol parameters for building transactions.params
: You can pass in the protocol parameters directly.verbose
: Set totrue
to enable verbose logging.
Send Value
Sending value with MeshTxBuilder
come with the .txOut()
endpoint:
In order to send values (so as every Cardano transaction), we have to fund the transaction to do so. There are 2 ways to provide values in a transaction:
Specifying which input to spend with
Providing an array of UTxOs, and perform auto UTxO selection:
Since the input and output values might not be the same, we have to specify the address (usually own's address) to receive change:
The following shows a simple example of building a transaction to send values with UTxO selection:
Send assets to a recipient.
Connect wallet to run this demo
Multi-signature Transaction
The main idea of a multi-signature transaction is to have multiple signatures to authorize a transaction.
In the above code snippet, we are signing the transaction with the user wallet and then signing the transaction with the minting wallet. ThesignTx
function is used to sign the transaction. The second argument is a boolean value that indicates whether the transaction is a multi-signature transaction.
Create a multi-signature transaction. In this demo, we will create a transaction with two signatures, where one signature is from the user wallet and the other is from a minting wallet.
Connect wallet to run this demo
Multi-signature Transaction with Native Script
Create native script
First, we need to create a native script. In this example, we will create a native script with two signatures. That means we need to get the key hashes of the two wallets.
Next, we will create a native script object with the two key hashes. The native script object will be used to create a multi-signature transaction.
The native script object is then serialized into a CBOR object and an address.
Create transaction
Now that we have the native script, we can create a transaction with the script. We first need to get the UTXO from the script address.
Finally, we sign the transaction with the two wallets and submit the transaction.
Create a multi-signature transaction with a native script. In this demo, we will create a transaction with two signatures, where one signature is from the user wallet and the other is from a minting wallet.
Connect wallet to run this demo
Build with Object
One alternative to use the lower level APIs is to build the transaction with JSON.
The following shows a simple example of building a transaction to send values to a recipient:
Send lovelace to a recipient
Connect wallet to run this demo
Coin selection
You can select UTxOs from a list of UTxOs using the selectUtxosFrom
method. This method allows you to specify the conditions for selecting UTxOs. The method signature is as follows:
The second parameter of selectUtxosFrom
is the strategy to be used for selecting UTxOs. There are 4 strategies (UtxoSelectionStrategy
) available for selecting UTxOs:
- experimental
- keepRelevant
- largestFirst
- largestFirstMultiAsset
We may introduce more strategies in the future. Check the Mesh Docs for more details.
The threshold
parameter is used to specify the minimum amount of lovelace to be selected. You may specify a larger amount to if the transactions requires it.
The last parameter is includeTxFees
which is a boolean value to include transaction fees in the selection.
Set Metadata - Taransaction message
Add messages / comments / memos as transaction metadata. This is useful for attaching additional information to a transaction. This is an example of setting metadata with transaction message.
The specification for the individual strings follow the general design specification for JSON metadata, which is already implemented and in operation on the cardano blockchain. The used metadatum label is 674
: this number was choosen because it is the T9 encoding of the stringmsg
. The message content has the key msg
: and consists of an array of individual message-strings. The number of theses message-strings must be at least one for a single message, more for multiple messages/lines. Each of theses individual message-strings array entries must be at most 64 bytes when UTF-8 encoded.
Add messages/comments/memos as transaction metadata
Connect wallet to run this demo
Set Required Signers
Sets the required signers for the transaction. This is useful when you want to include multiple signers, such as in a multi-signature transaction or smart contracts.
Set Start and Expire Time
We can define the time-to-live (TTL) for the transaction. TTL is the time limit for our transaction to be included in a blockchain, if it is not in a blockchain by then the transaction will be cancelled. This time limit is defined as slot
.
In order to get the slot
of the time you wish the transaction would expire, you can use resolveSlotNo
. For example, if you would like the transaction to expire in 5 minutes, you can get the slot
in the following way:
Next, we set the TTL with invalidHereafter
and providing the slot
, this means that if the transaction is submitted after after slot
will not be valid.
Likewise, we can set a "validity start interval" for the transaction, where it is the time the transaction will be valid. We can define the start time with invalidBefore
and providing the slot
:
Set Network
Sets the network to use, this is mainly to know the cost models to be used to calculate script integrity hash. You can set the network for the transaction with setNetwork
.
The network parameter is a string that can be one of the following:
Set Fee
Set the fee for the transaction.
The following shows a simple example of building a transaction to send values with UTxO selection: