Struct TransactionBuilder 

pub struct TransactionBuilder { /* private fields */ }

Builder for constructing Transaction instances.

This builder provides methods for creating transactions either by:

• Providing a pre-signed payload and signature
• Providing a payload and using sign_and_build() to sign automatically

Examples

Sign and build in one step

use types::api::{Transaction, TransactionPayload};

let payload = TransactionPayload::builder()
    .nonce(1)
    .chain_id("real-1")
    .build()
    .expect("Failed to build");

let tx = Transaction::builder()
    .payload(payload)
    .sign_and_build("iotaprivkey1qrsd...")
    .expect("Failed to sign");

Build with existing signature

use types::api::Transaction;

let tx = Transaction::builder()
    .payload_base64("eyJzZW5kZXIi...")
    .signature_base64("0x1a2b3c...")
    .build()
    .expect("Failed to build");

Implementations

impl TransactionBuilder

pub fn new() -> TransactionBuilder

Creates a new TransactionBuilder with all fields initially unset.

pub fn client_request_id<S>(self, client_request_id: S) -> TransactionBuilder

where S: Into<String>,

Sets an optional client request identifier for tracking purposes.

This identifier can be used to track the transaction through the system and correlate requests with responses.

Arguments

• client_request_id - Any value that can be converted to a String (e.g., UUID)

Examples

use types::api::Transaction;

let builder = Transaction::builder()
    .client_request_id("393e6d50-7cf7-4069-a758-0e837e7178bc");

pub fn signer<S>(self, signer: S) -> TransactionBuilder

where S: Into<String>,

Sets the envelope signer for v2 transactions.

v1 envelopes ignore this field. v2 envelopes require it: it is the wallet address that actually signed this envelope, which may differ from payload.owner when owner is a multisig address.

If left unset, sign_and_build will populate it automatically with the signing key’s address when version is Some(2).

pub fn version(self, version: u8) -> TransactionBuilder

Sets an optional protocol version number.

Arguments

• version - The protocol version number (e.g., 1)

pub fn payload_base64<S>(self, payload: S) -> TransactionBuilder

where S: Into<Arc<str>>,

Sets the transaction payload as a base64-encoded string.

Use this method when you have a pre-encoded payload string.

Arguments

• payload - Base64-encoded JSON representation of TransactionPayload

Examples

use types::api::Transaction;

let builder = Transaction::builder()
    .payload_base64("eyJzZW5kZXIi...");

pub fn signature_base64<S>(self, signature: S) -> TransactionBuilder

where S: Into<Arc<str>>,

Sets the transaction signature as a base64-encoded string.

Use this method when you have a pre-computed signature.

Arguments

• signature - Base64-encoded Ed25519 signature

Examples

use types::api::Transaction;

let builder = Transaction::builder()
    .signature_base64("0x1a2b3c...");

pub fn payload(self, payload: TransactionPayload) -> TransactionBuilder

Sets the transaction payload from a TransactionPayload instance.

Use this method when building a transaction from a structured payload that will be signed using sign_and_build().

Arguments

• payload - A TransactionPayload instance

Examples

use types::api::{Transaction, TransactionPayload};

let payload = TransactionPayload::builder()
    .nonce(1)
    .chain_id("real-1")
    .build()
    .expect("Failed to build");

let builder = Transaction::builder()
    .payload(payload);

pub fn sign_and_build<S>( self, signer: S, ) -> Result<Transaction, TransactionBuilderError>

where S: Into<Signer>,

Signs the transaction payload and builds a complete Transaction.

This method takes a signer (private key), encodes the payload, signs it, and constructs a complete transaction ready for submission.

Arguments

• signer - Any value that can be converted into a Signer (e.g., private key string)

Returns

• Ok(Transaction) - Successfully signed and built transaction
• Err(TransactionBuilderError) - Missing payload

Behavior

• If the payload’s sender field is empty, it will be automatically set from the signer’s address
• The payload is serialized to JSON and base64-encoded
• The base64 payload is signed using Ed25519
• A complete Transaction is constructed with the encoded payload and signature

Examples

use types::api::{Transaction, TransactionPayload};

let payload = TransactionPayload::builder()
    .nonce(1)
    .chain_id("real-1")
    .build()
    .expect("Failed to build");

let tx = Transaction::builder()
    .client_request_id("393e6d50-7cf7-4069-a758-0e837e7178bc")
    .payload(payload)
    .sign_and_build("iotaprivkey1qrsd2u9ztqr6z2y78sp2ch8kcyak9cx3ezphkpp4acqaqruajxr6qye2645")
    .expect("Failed to sign");

pub fn build(self) -> Result<Transaction, TransactionBuilderError>

Builds the Transaction from the configured builder.

Use this method when you have a pre-signed transaction with base64-encoded payload and signature strings.

Returns

• Ok(Transaction) - Successfully built transaction
• Err(TransactionBuilderError) - Missing required field(s)

Errors

Returns TransactionBuilderError::MissingField if:

• payload (base64 string) has not been set
• signature (base64 string) has not been set

Examples

use types::api::Transaction;

let tx = Transaction::builder()
    .client_request_id("393e6d50-7cf7-4069-a758-0e837e7178bc")
    .payload_base64("eyJzZW5kZXIi...")
    .signature_base64("0x1a2b3c...")
    .build()
    .expect("Failed to build");

Trait Implementations

impl Debug for TransactionBuilder

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

Formats the value using the given formatter.

impl Default for TransactionBuilder

fn default() -> TransactionBuilder

Returns the “default value” for a type.