tx3-sdk 0.11.0

Tx3 Rust SDK
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

use schemars::schema::Schema;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use crate::core::TirEnvelope;

/// Root structure for TII (Transaction Invocation Interface) JSON files.
///
/// This structure represents the complete contents of a TII file, which defines
/// a TX3 protocol including its transactions, parties, profiles, and configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TiiFile {
    /// TII specification version information.
    pub tii: TiiInfo,

    /// Protocol metadata (name, version, description).
    pub protocol: Protocol,

    /// Optional JSON schema for environment parameters.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub environment: Option<Schema>,

    /// Map of party names to their definitions.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub parties: HashMap<String, Party>,

    /// Map of transaction names to their definitions.
    pub transactions: HashMap<String, Transaction>,

    /// Map of profile names to their environment configurations.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub profiles: HashMap<String, Profile>,

    /// Optional reusable components (schemas, etc.).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub components: Option<Components>,
}

/// TII version information.
///
/// Specifies the version of the TII specification used by this file.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TiiInfo {
    /// The TII specification version (e.g., "1.0.0").
    pub version: String,
}

/// Protocol metadata.
///
/// Contains descriptive information about the TX3 protocol.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Protocol {
    /// The protocol name.
    pub name: String,

    /// The protocol version.
    pub version: String,

    /// The protocol scope (e.g., "mainnet", "public").
    #[serde(default)]
    pub scope: String,

    /// Optional protocol description.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

/// Transaction definition.
///
/// Defines a single transaction within a TX3 protocol, including its
/// intermediate representation and parameter schema.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Transaction {
    /// The Transaction Intermediate Representation envelope.
    pub tir: TirEnvelope,

    /// JSON schema defining the transaction parameters.
    pub params: Schema,

    /// Optional transaction description.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

/// Party definition.
///
/// Represents a participant in a TX3 protocol (e.g., sender, receiver).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Party {
    /// Optional party description.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

/// Environment profile definition.
///
/// Profiles allow pre-configuration of environment-specific values for different
/// networks or contexts (mainnet, preview, testnet, etc.).
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Profile {
    /// Optional profile description.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Environment variables as JSON object.
    #[serde(default)]
    pub environment: serde_json::Value,

    /// Party addresses for this profile.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub parties: HashMap<String, String>,
}

/// Components section containing reusable schemas.
///
/// This section defines reusable components that can be referenced
/// throughout the TII file.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Components {
    /// Map of reusable JSON schemas.
    #[serde(skip_serializing_if = "HashMap::is_empty")]
    pub schemas: HashMap<String, Schema>,
}