mx-core 0.1.0

Core utilities for MultiversX Rust services.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! Shared WebSocket wire-format types for relayer ↔ stress communication.
//!
//! These types define the JSON contract between `mx-relayer` (serializer) and
//! `mx-stress` (deserializer). Both crates MUST use these types instead of
//! defining their own — this prevents silent field-name divergence (e.g.
//! `camelCase` vs `snake_case`) that causes runtime parse failures.

use serde::{Deserialize, Serialize};

// ─────────────────────────────────────────────────────────────────────────────
// Proto broadcast (binary WebSocket frame path)
// ─────────────────────────────────────────────────────────────────────────────

/// Response to a proto-encoded binary broadcast via WebSocket.
///
/// Sent by the relayer after processing a binary frame of protobuf-encoded
/// transaction batches. Deserialized by stress tooling to track success/failure.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ProtoBroadcastResponse {
    pub action: String,
    pub status: String,
    pub success_count: usize,
    pub failure_count: usize,
}

impl ProtoBroadcastResponse {
    /// Convenience constructor for the relayer (avoids `.into()` noise at call sites).
    pub fn completed(success_count: usize, failure_count: usize) -> Self {
        Self {
            action: "broadcast_proto".into(),
            status: "completed".into(),
            success_count,
            failure_count,
        }
    }
}

// ─────────────────────────────────────────────────────────────────────────────
// JSON broadcast (text WebSocket frame path)
// ─────────────────────────────────────────────────────────────────────────────

/// Response to a JSON-encoded transaction broadcast via WebSocket.
///
/// Two-phase protocol:
/// - Phase 1: `status: "accepted"` with `batch_size` (immediate ack)
/// - Phase 2: `status: "completed"` | `"partial"` | `"failed"` with `hashes` and `failed`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BatchBroadcastResponse {
    pub action: String,
    pub status: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub request_id: Option<String>,
    /// Batch size (present in "accepted" ack)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub batch_size: Option<usize>,
    /// Transaction hashes (present in final response)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub hashes: Vec<String>,
    /// Failed transactions (present in final response)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub failed: Vec<TxErrorResponse>,
}

/// Error details for a single failed transaction in a batch response.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TxErrorResponse {
    pub index: usize,
    pub reason: String,
}