Struct TransactionReport 

pub struct TransactionReport {
    pub receipts: Vec<Report>,
    pub client_request_id: Option<Arc<str>>,
    pub timestamp_ms: u64,
    pub success: bool,
    pub errors: Option<HashMap<String, Errors>>,
    pub rate_limit: RateLimitInfo,
    pub warnings: Vec<Warning>,
}

A comprehensive report of a transaction containing one or more trading operations.

This structure aggregates multiple operation receipts (order submissions, cancellations) into a single transaction report with overall success/failure status, timestamp, and optional error details.

Fields

receipts: Vec<Report>

Individual receipts for each operation in this transaction. Omitted from serialization if empty.

client_request_id: Option<Arc<str>>

Optional client-provided request ID for tracking and correlation. Omitted from serialization if None.

timestamp_ms: u64

When the report was generated, in milliseconds since the Unix epoch.

success: bool

Whether the transaction was admitted and executed. true once the engine has run it; false only when admission rejected the whole transaction, in which case receipts is empty and errors is populated. An individual order the engine refuses still arrives under success: true, as a receipt whose order.status is Rejected and whose order.error says why — check the receipts, not just this flag.

errors: Option<HashMap<String, Errors>>

Detailed error information if the transaction failed. Maps error identifiers to specific error details. Omitted from serialization if None.

rate_limit: RateLimitInfo

Rate-limit snapshot captured at admission time. Always present so clients can pace requests on every outcome (success, validation error, rate-limit rejection).

warnings: Vec<Warning>

Conditions this transaction was accepted with but that a future release will reject — see [crate::api::warnings]. Each carries the release it becomes an error in. Omitted from serialization when empty, so a client that never triggers one never sees the field.

Implementations

impl TransactionReport

pub fn new_error( client_request_id: Option<Arc<str>>, errors: HashMap<String, Errors>, rate_limit: RateLimitInfo, ) -> TransactionReport

Creates a new error transaction report.

Use this constructor when a transaction fails due to validation errors, system errors, or other issues preventing successful execution.

Arguments

• client_request_id - Optional client request ID for tracking
• errors - Map of error identifiers to error details

Returns

A TransactionReport with success: false, the current timestamp, and no receipts.

pub fn new_success( client_request_id: Option<Arc<str>>, receipts: Vec<Report>, rate_limit: RateLimitInfo, ) -> TransactionReport

Creates a new success transaction report.

Use this constructor when a transaction completes successfully, potentially with one or more operation receipts.

Arguments

• client_request_id - Optional client request ID for tracking
• receipts - Vector of operation receipts (orders placed, canceled, etc.)

Returns

A TransactionReport with success: true, the current timestamp, and no errors.

Example

use types::api::transaction_report::{TransactionReport, Report};
use types::api::RateLimitInfo;
use types::core::AccountId;

let rate_limit = RateLimitInfo {
    account_id: AccountId::default(),
    account_remaining: 0,
    account_burst: 0,
    account_reset_secs: 0,
    global_remaining: 0,
    global_burst: 0,
    global_reset_secs: 0,
    is_exempt: false,
    retry_after_ms: None,
    rejected_by: None,
};

let receipts = vec![]; // Would contain actual receipts
let report = TransactionReport::new_success(
    Some("req-456".into()),
    receipts,
    rate_limit,
);
assert!(report.success);
assert!(report.errors.is_none());

pub fn with_warnings(self, warnings: Vec<Warning>) -> TransactionReport

Attaches advisories to a report.

A setter rather than a constructor parameter: new_success / new_error are public SDK API, and most reports carry no warnings, so call sites stay untouched.

let report = TransactionReport::new_success(client_request_id, receipts, rate_limit)
    .with_warnings(warnings);

Trait Implementations

impl Clone for TransactionReport

fn clone(&self) -> TransactionReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TransactionReport

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.