Struct Protocol 

pub struct Protocol { /* private fields */ }

A TX3 protocol loaded from a TII file.

This structure represents a loaded TX3 protocol definition and provides methods for inspecting transactions and creating invocations.

Example

use tx3_sdk::tii::Protocol;

let protocol = Protocol::from_file("protocol.tii")?;

// List all available transactions
for (name, tx) in protocol.txs() {
    println!("Transaction: {}", name);
}

// Invoke a specific transaction
let invocation = protocol.invoke("transfer", Some("mainnet"))?;

Implementations

impl Protocol

pub fn from_json(json: Value) -> Result<Protocol, Error>

Creates a Protocol from a JSON value.

Arguments

• json - A serde_json::Value containing the TII file content

Returns

Returns a Protocol on success, or an error if the JSON is invalid.

Example

use tx3_sdk::tii::Protocol;
use serde_json::json;

let json = json!({
    "tii": { "version": "1.0.0" },
    "protocol": { "name": "MyProtocol", "version": "1.0.0" },
    "transactions": {}
});

let protocol = Protocol::from_json(json)?;

pub fn from_string(code: String) -> Result<Protocol, Error>

Creates a Protocol from a JSON string.

Arguments

• code - A string containing the TII JSON content

Returns

Returns a Protocol on success, or an error if the JSON is invalid.

Example

use tx3_sdk::tii::Protocol;

let tii_content = r#"{
    "tii": { "version": "1.0.0" },
    "protocol": { "name": "MyProtocol", "version": "1.0.0" },
    "transactions": {}
}"#;

let protocol = Protocol::from_string(tii_content.to_string())?;

pub fn from_file(path: impl AsRef<Path>) -> Result<Protocol, Error>

Creates a Protocol from a file path.

Arguments

• path - Path to the TII file

Returns

Returns a Protocol on success, or an error if the file cannot be read or the JSON is invalid.

Example

use tx3_sdk::tii::Protocol;

let protocol = Protocol::from_file("./my_protocol.tii")?;

pub fn invoke( &self, tx: &str, profile: Option<&str>, ) -> Result<Invocation, Error>

Creates an invocation for a transaction.

This method initializes an invocation for the specified transaction, optionally applying a profile to pre-populate arguments.

Arguments

• tx - The name of the transaction to invoke
• profile - Optional profile name to apply (e.g., “mainnet”, “preview”)

Returns

Returns an Invocation that can be configured with arguments and converted to a TRP resolve request.

Errors

Returns an error if:

• The transaction name is not found
• The profile name is not found (if specified)

Example

use tx3_sdk::tii::Protocol;

let protocol = Protocol::from_file("protocol.tii")?;

// Invoke with a profile
let invocation = protocol.invoke("transfer", Some("mainnet"))?;

// Invoke without a profile
let invocation = protocol.invoke("transfer", None)?;

pub fn txs(&self) -> &HashMap<String, Transaction>

Returns all transactions defined in the protocol.

Returns

Returns a reference to the map of transaction names to their definitions.

pub fn parties(&self) -> &HashMap<String, Party>

Returns all parties defined in the protocol.

Returns

Returns a reference to the map of party names to their definitions.

Trait Implementations

impl Clone for Protocol

fn clone(&self) -> Protocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Protocol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Protocol

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Protocol

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

where __S: Serializer,

Serialize this value into the given Serde serializer.