Expand description
Rust SDK for the Nym platform
The main component currently is mixnet.
tcp_proxy is probably a good place to start for anyone wanting to integrate with existing app code and read/write from a socket.
client_pool is a configurable client pool.
Modules§
- bandwidth
- The coconut bandwidth component of the Rust SDK for the Nym platform
- client_
pool - A variable-size pool of ephemeral Nym Clients to quickly grab and use.
- mixnet
- The mixnet component of the Rust SDK for the Nym platform
- tcp_
proxy - The TcpProxy Module of the Nym SDK which exposes a socket interface for the Mixnet
Structs§
- Chain
Details - Debug
Config - Denom
Details - Denom
Details Owned - Erased
Gateway Error - Local
Gateway - Gateway running within the same process.
- Mock
Gateway - Mock
Gateway Error - NymApi
Topology Provider - NymApi
Topology Provider Config - NymContracts
- NymNetwork
Details - Packet
Router - Remember
Me - Remote
Gateway - Gateway to which the client is connected through a socket. Most likely through a websocket.
- Shutdown
Token - A wrapped CancellationToken that is used for signalling and listening for cancellation requests.
- Shutdown
Tracker - Extracted TaskTracker and ShutdownToken to more easily allow tracking nested tasks without having to pass whole ShutdownManager around.
- User
Agent - Characteristic elements sent to the API providing basic context information of the requesting client.
- Validator
Details
Enums§
- Error
- Top-level Error enum for the mixnet client and its relevant types.
- Local
Gateway Error
Traits§
- Gateway
Packet Router - Gateway
Receiver - this trait defines the functionality of being able to correctly route packets received from the mixnet, i.e. acks and ‘proper’ messages.
- Gateway
Sender - This trait defines the functionality of sending
MixPacketinto the mixnet, usually through a gateway. - Gateway
Transceiver - This combines the functionalities of being able to send and receive mix packets.
- Topology
Provider