nym-sdk 1.21.4

Nym's 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

// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
// SPDX-License-Identifier: Apache-2.0

//! Demonstrates the stream/message mode mutual exclusion guard.
//!
//! A `MixnetClient` operates in one of two modes: message mode (default)
//! or stream mode (activated by `open_stream()` or `listener()`). Once
//! stream mode is active, message-based methods like `send_plain_message`
//! return `Error::StreamModeActive`. This is a one-way transition — the
//! two modes share a single inbound channel from the gateway, so they
//! cannot coexist.
//!
//! This example shows:
//! - Using the message API before stream mode
//! - Activating stream mode via `listener()`
//! - Observing `StreamModeActive` errors on message sends
//! - `split_sender()` shares the mode flag (via `Arc<AtomicBool>`)
//!
//! Run with: cargo run --example stream_mode_guard

use nym_sdk::mixnet;
use nym_sdk::mixnet::MixnetMessageSender;
use nym_sdk::Error;

#[tokio::main]
async fn main() {
    nym_bin_common::logging::setup_tracing_logger();

    let mut client = mixnet::MixnetClient::connect_new().await.unwrap();
    let our_address = *client.nym_address();
    println!("Our client nym address is: {our_address}");

    // Message-based API works before stream mode is activated.
    println!("\nTesting message-based API (should work)");
    client
        .send_plain_message(our_address, "hello via message API")
        .await
        .unwrap();
    println!("Message sent successfully via message-based API");

    // Activate stream mode by creating a listener.
    // This is a one-way transition — the two modes share a single inbound
    // channel from the gateway, so they cannot coexist.
    println!("\nActivating stream mode via listener()");
    let _listener = client.listener().unwrap();
    println!("Stream mode is now active");

    // Message-based API now returns Error::StreamModeActive.
    println!("\nTesting message-based API again (should fail)");
    let result = client
        .send_plain_message(our_address, "this should fail")
        .await;

    match result {
        Err(Error::StreamModeActive) => {
            println!("Got expected error: StreamModeActive");
        }
        Err(e) => {
            println!("Got unexpected error: {e:?}");
        }
        Ok(()) => {
            println!("ERROR: send() should have failed but succeeded!");
        }
    }

    // split_sender() shares the mode flag (Arc<AtomicBool>),
    // so it also returns StreamModeActive.
    println!("\nTesting split_sender (shares stream_mode flag)");
    let sender = client.split_sender();
    let result = sender
        .send_plain_message(our_address, "this should also fail")
        .await;

    match result {
        Err(Error::StreamModeActive) => {
            println!("Got expected error: StreamModeActive on split sender");
        }
        Err(e) => {
            println!("Got unexpected error: {e:?}");
        }
        Ok(()) => {
            println!("ERROR: split_sender.send() should have failed but succeeded!");
        }
    }

    client.disconnect().await;
}