diff --git a/documentation/docs/src/sdk/rust.md b/documentation/docs/src/sdk/rust.md index 68004b7576..aec482359b 100644 --- a/documentation/docs/src/sdk/rust.md +++ b/documentation/docs/src/sdk/rust.md @@ -46,6 +46,26 @@ The example above involves ephemeral keys - if we want to create and then mainta As seen in the example above, the `mixnet::MixnetClientBuilder::new()` function handles checking for keys in a storage location, loading them if present, or creating them and storing them if not, making client key management very simple. +Assuming our client config is stored in `/tmp/mixnet-client`, the following files are generated: +``` +$ tree /tmp/mixnet-client + +mixnet-client +├── ack_key.pem +├── db.sqlite +├── db.sqlite-shm +├── db.sqlite-wal +├── gateway_details.json +├── gateway_shared.pem +├── persistent_reply_store.sqlite +├── private_encryption.pem +├── private_identity.pem +├── public_encryption.pem +└── public_identity.pem + +1 directory, 11 files +``` + ### Manually handling storage If you're integrating mixnet functionality into an existing app and want to integrate saving client configs and keys into your existing storage logic, you can manually perform the actions taken automatically above (`examples/manually_handle_keys_and_config.rs`) @@ -64,7 +84,7 @@ The number of SURBs is set [here](https://github.com/nymtech/nym/blob/release/{{ You can read more about how SURBs function under the hood [here](../architecture/traffic-flow.md#private-replies-using-surbs). -In order to reply to an incoming message using SURBs, you can construct a `recipient` from the `sender_tag` sent along with the message you wish to reply to: +In order to reply to an incoming message using SURBs, you can construct a `recipient` from the `sender_tag` sent along with the message you wish to reply to: ```rust,noplayground {{#include ../../../../sdk/rust/nym-sdk/examples/surb-reply.rs}}