Struct MixnetClient 

pub struct MixnetClient { /* private fields */ }

Client connected to the Nym mixnet.

Implementations

impl MixnetClient

pub async fn connect_new() -> Result<Self>

Create a new client and connect to the mixnet using ephemeral in-memory keys that are discarded at application close.

Examples

use nym_sdk::mixnet;

#[tokio::main]
async fn main() {
    let mut client = mixnet::MixnetClient::connect_new().await;
}

pub fn nym_address(&self) -> &Recipient

Get the nym address for this client, if it is available. The nym address is composed of the client identity, the client encryption key, and the gateway identity.

pub fn cancellation_token(&self) -> CancellationToken

Get a child token of the root, to monitor unexpected shutdown, without causing one

pub fn client_request_sender(&self) -> ClientRequestSender

pub fn identity_keypair(&self) -> Arc<KeyPair>

Get the client’s identity keys.

pub fn sign(&self, data: &[u8]) -> Signature

Sign a message with the client’s private identity key.

pub fn sign_text(&self, text: &str) -> String

Sign a message with the client’s private identity key and return it as a base58 encoded signature.

pub fn gateway_connection(&self) -> GatewayConnection

Get gateway connection information, like the file descriptor of the WebSocket

pub fn split_sender(&self) -> MixnetClientSender

Get a shallow clone of MixnetClientSender. Useful if you want split the send and receive logic in different locations.

pub fn connection_command_sender(&self) -> ConnectionCommandSender

Get a shallow clone of ConnectionCommandSender. This is useful if you want to e.g explicitly close a transmission lane that is still sending data even though it should cancel.

pub fn shared_lane_queue_lengths(&self) -> LaneQueueLengths

Get a shallow clone of LaneQueueLengths. This is useful to manually implement some form of backpressure logic.

pub async fn manually_overwrite_topology(&self, new_topology: NymTopology)

Change the network topology used by this client for constructing sphinx packets into the provided one.

pub async fn read_current_route_provider( &self, ) -> Option<RwLockReadGuard<'_, NymRouteProvider>>

Gets the value of the currently used network topology.

pub fn restore_automatic_topology_refreshing(&self)

Restore default topology refreshing behaviour of this client.

pub async fn wait_for_messages(&mut self) -> Option<Vec<ReconstructedMessage>>

Wait for messages from the mixnet

pub async fn on_messages<F>(&mut self, fun: F)

where F: Fn(ReconstructedMessage),

Provide a callback to execute on incoming messages from the mixnet.

pub fn send_stats_event(&self, event: ClientStatsEvents)

pub fn stats_events_reporter(&self) -> ClientStatsSender

Get a clone of stats_events_reporter for easier use

pub async fn disconnect(self)

Disconnect from the mixnet. Currently, it is not supported to reconnect a disconnected client.

pub async fn send_forget_me(&self) -> Result<()>

pub async fn send_remember_me(&self) -> Result<()>

Trait Implementations

impl MixnetMessageSender for MixnetClient

fn packet_type(&self) -> Option<PacketType>

fn send<'life0, 'async_trait>( &'life0 self, message: InputMessage, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a InputMessage to the mixnet. This is the most low-level sending function, for full customization.

fn send_plain_message<'life0, 'async_trait, M>( &'life0 self, address: Recipient, message: M, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where M: AsRef<[u8]> + Send + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait,

Sends data to the supplied Nym address with the default surb behaviour.

fn send_message<'life0, 'async_trait, M>( &'life0 self, address: Recipient, message: M, surbs: IncludedSurbs, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where M: AsRef<[u8]> + Send + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait,

Sends bytes to the supplied Nym address. There is the option to specify the number of reply-SURBs to include.

fn send_reply<'life0, 'async_trait, M>( &'life0 self, recipient_tag: AnonymousSenderTag, message: M, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where M: AsRef<[u8]> + Send + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait,

Sends reply data to the supplied anonymous recipient.

impl Stream for MixnetClient

type Item = ReconstructedMessage

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.