Struct Transaction 

pub struct Transaction {
    pub client_request_id: Option<Arc<str>>,
    pub version: Option<u8>,
    pub payload: Arc<str>,
    pub signature: Arc<str>,
    pub signer: Option<Arc<str>>,
}

A complete transaction with payload and cryptographic signature.

This structure represents a signed transaction ready to be submitted to the matching engine. It contains the transaction payload (base64-encoded), a cryptographic signature, and optional metadata for tracking and versioning.

Fields

• client_request_id - Optional client-provided identifier for tracking requests
• version - Optional protocol version number
• payload - Base64-encoded JSON representation of the TransactionPayload
• signature - Base64-encoded Ed25519 signature of the payload
• signer - Optional v2 envelope signer; may differ from payload.owner for multisig

Validation Flow

When a transaction is validated:

1. The base64 payload is decoded
2. The JSON is parsed into a TransactionPayload
3. Each command in the payload is validated
4. The signature is verified against the payload and sender’s public key

Examples

Create and sign a transaction

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("iotaprivkey1qrsd...")
    .expect("Failed to sign");

JSON serialization

{
  "client_request_id": "393e6d50-7cf7-4069-a758-0e837e7178bc",
  "version": 1,
  "payload": "eyJzZW5kZXIi...",
  "signature": "AHhtdGhlLWJhc2U2NC1zaWduYXR1cmUtZ29lcy1oZXJl"
}

Fields

client_request_id: Option<Arc<str>>

version: Option<u8>

payload: Arc<str>

signature: Arc<str>

signer: Option<Arc<str>>

Implementations

impl Transaction

pub fn builder() -> TransactionBuilder

Creates a new builder for constructing a Transaction.

This is the recommended way to create new Transaction instances.

Returns

A new TransactionBuilder instance

Examples

use types::api::Transaction;

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

pub fn new( client_request_id: Option<Arc<str>>, version: Option<u8>, payload: impl Into<Arc<str>>, signature: impl Into<Arc<str>>, ) -> Transaction

Creates a new Transaction directly from components.

This constructor is useful when you have all the components ready and want to create a transaction without using the builder pattern.

Arguments

• client_request_id - Optional client-provided identifier for tracking
• version - Optional protocol version number
• payload - Base64-encoded JSON representation of the TransactionPayload
• signature - Base64-encoded Ed25519 signature

Returns

A new Transaction instance

Examples

use types::api::Transaction;

let tx = Transaction::new(
    Some("393e6d50-7cf7-4069-a758-0e837e7178bc".into()),
    Some(1),
    "eyJzZW5kZXIi...",
    "0x1a2b3c...",
);

pub fn hash_of(payload: &str, signature: &str) -> String

The transaction’s hash: SHA3-256 over the base64 payload and the signature, as the indexer records it. Compute it locally to look a submitted transaction up by tx_hash — the report does not carry one.

Trait Implementations

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transaction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Transaction

fn deserialize<__D>( __deserializer: __D, ) -> Result<Transaction, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Transaction

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.