9db748e8dd
* Improve SDK rustdoc and add ARCHITECTURE.md files - Rewrite lib.rs module docs with quick-start example and module overview - Add stream example and include_str! ARCHITECTURE.md to mixnet module - Add ARCHITECTURE.md for mixnet, client_pool, and stream modules - Add rustdoc to MixnetClientBuilder, MixnetClientSender, MixnetMessageSender - Add cancel safety and drop behavior annotations to async methods - Add TcpProxy deprecation notice pointing to stream module * Fix rustdoc errors and add stepwise comments to remaining examples Rustdoc fixes: - Add missing .unwrap() on connect_new example - Replace broken turbofish intra-doc link in MixnetClientBuilder - Fix NymProxyServer::new args in tcp_proxy example - Wrap BandwidthImporter example in scoped block to fix borrow-then-move - Change misleading "5-hop routing" to "multi-hop routing" - Fix copy-paste "forget me" in send_remember_me error message - Fix wrong cargo run command in stream_simple_read_write - Fix DecayWrapper description * Cut down doc comment length * Trimmed down SDK ARCHITECTURE files * Slim Rust SDK docs and rename opener to dialer - Merge tour page into SDK landing page, delete tour.mdx - Trim all three tutorials: cut boilerplate, duplicated code, and misplaced content - Make FFI page evergreen with Go and C++ snippets, link to repo examples - Rename "opener" to "dialer" in stream docs, source ARCHITECTURE.md, and rustdoc - Add reply-to-open arrow in stream mermaid diagram - Replace remaining Unicode dashes in mermaid flowchart * - elevate streams in rustdoc: examples on lib.rs, MixnetClient, open_stream, listener - add stream quick reference to mixnet ARCHITECTURE.md - add stream types to key types list in ARCHITECTURE.md - add docs.rs links for AsyncRead/AsyncWrite and stream submodule - tcp_proxy: replace bold deprecation with warning box * - replace individual example doc pages with GitHub-linked tables - add step-by-step inline comments to all SDK example source files - add doc comments to examples missing them (simple, surb_reply, builder, etc.) - expand mixnet tutorial with persistent identity and split_sender sections - add tcpproxy tutorial - rename "API Reference" to "TypeDoc Reference" in TS SDK sidebar - rename "Misc" to "Extras" in developer sidebar, move VPN CLI up - remove echo server from tools - update message-queue callout to reference actual modules - fix mixnet/examples redirect collision * Add missing mut to example code * Update ARCHITECTURE.md with LP Framing + stream examples with sequencing * Update doc comment in utils.rs * Standardise commenting style across Rust SDK examples * Fix inline doc examples and trim re-export boilerplate * Update sdk/rust/nym-sdk/examples/bandwidth.rs Co-authored-by: Simon Wicky <simon@nymtech.net> * Fix review comments --------- Co-authored-by: Simon Wicky <simon@nymtech.net>
54 lines
1.8 KiB
Rust
54 lines
1.8 KiB
Rust
//! Paid bandwidth credentials using the Ecash scheme.
|
|
//!
|
|
//! Acquires a bandwidth credential from the sandbox network, connects
|
|
//! with it, and sends a message to self. Requires the sandbox `.env`.
|
|
//!
|
|
//! Run with: cargo run --example bandwidth
|
|
|
|
use futures::StreamExt;
|
|
use nym_credentials_interface::TicketType;
|
|
use nym_network_defaults::setup_env;
|
|
use nym_sdk::mixnet;
|
|
use nym_sdk::mixnet::MixnetMessageSender;
|
|
|
|
#[tokio::main]
|
|
async fn main() -> anyhow::Result<()> {
|
|
nym_bin_common::logging::setup_tracing_logger();
|
|
|
|
// Load the sandbox environment.
|
|
// Run from the `sdk/rust/nym-sdk` directory so the relative path resolves.
|
|
setup_env(Some("../../../envs/sandbox.env"));
|
|
|
|
// Build a credentials-enabled client (not yet connected).
|
|
let sandbox_network = mixnet::NymNetworkDetails::new_from_env();
|
|
let mnemonic = String::from("my super secret mnemonic");
|
|
|
|
let mixnet_client = mixnet::MixnetClientBuilder::new_ephemeral()
|
|
.network_details(sandbox_network)
|
|
.enable_credentials_mode()
|
|
.build()?;
|
|
|
|
// Acquire a bandwidth credential (ticketbook) before connecting.
|
|
let bandwidth_client = mixnet_client
|
|
.create_bandwidth_client(mnemonic, TicketType::V1MixnetEntry)
|
|
.await?;
|
|
bandwidth_client.acquire().await?;
|
|
|
|
// Connect to the mixnet using the acquired credential.
|
|
let mut client = mixnet_client.connect_to_mixnet().await?;
|
|
let our_address = client.nym_address();
|
|
|
|
// Send a message to ourselves and wait for it.
|
|
client
|
|
.send_plain_message(*our_address, "hello there")
|
|
.await?;
|
|
|
|
println!("Waiting for message");
|
|
let received = client.next().await.unwrap();
|
|
println!("Received: {}", String::from_utf8_lossy(&received.message));
|
|
|
|
// Disconnect for clean shutdown.
|
|
client.disconnect().await;
|
|
Ok(())
|
|
}
|