From 1be81b96b35e6a038eaaa7c320604ffe5b08641c Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 7 Nov 2023 14:56:14 +0100 Subject: [PATCH 1/7] upped default sdk surbs from 5 -> 20 --- sdk/rust/nym-sdk/src/mixnet/client.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/rust/nym-sdk/src/mixnet/client.rs b/sdk/rust/nym-sdk/src/mixnet/client.rs index 3c6e6cf3f4..acfd85b061 100644 --- a/sdk/rust/nym-sdk/src/mixnet/client.rs +++ b/sdk/rust/nym-sdk/src/mixnet/client.rs @@ -35,7 +35,7 @@ use std::path::PathBuf; use url::Url; // The number of surbs to include in a message by default -const DEFAULT_NUMBER_OF_SURBS: u32 = 5; +const DEFAULT_NUMBER_OF_SURBS: u32 = 20; #[derive(Default)] pub struct MixnetClientBuilder { From 9549d3b681496696425ecf042358032e6f9aaac7 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 7 Nov 2023 15:12:33 +0100 Subject: [PATCH 2/7] revert change of file name --- documentation/docs/src/sdk/rust/examples/surbs.md | 2 +- sdk/rust/nym-sdk/examples/{surb-reply.rs => surb_reply.rs} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename sdk/rust/nym-sdk/examples/{surb-reply.rs => surb_reply.rs} (100%) diff --git a/documentation/docs/src/sdk/rust/examples/surbs.md b/documentation/docs/src/sdk/rust/examples/surbs.md index 404d74ba1d..13de2ec98c 100644 --- a/documentation/docs/src/sdk/rust/examples/surbs.md +++ b/documentation/docs/src/sdk/rust/examples/surbs.md @@ -12,5 +12,5 @@ You can read more about how SURBs function under the hood [here](../../../archit 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}} +{{#include ../../../../../../sdk/rust/nym-sdk/examples/surb_reply.rs}} ``` diff --git a/sdk/rust/nym-sdk/examples/surb-reply.rs b/sdk/rust/nym-sdk/examples/surb_reply.rs similarity index 100% rename from sdk/rust/nym-sdk/examples/surb-reply.rs rename to sdk/rust/nym-sdk/examples/surb_reply.rs From 427f205a58b90a1edc1c7bc9024c1647ce193545 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Thu, 9 Nov 2023 16:26:58 +0100 Subject: [PATCH 3/7] upped default attached number of surbs from 0 -> 10 --- sdk/typescript/packages/nodejs-client/src/worker.ts | 2 +- sdk/typescript/packages/sdk/src/mixnet/wasm/worker.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/typescript/packages/nodejs-client/src/worker.ts b/sdk/typescript/packages/nodejs-client/src/worker.ts index 75c7fadd46..a4e4eaeaf5 100644 --- a/sdk/typescript/packages/nodejs-client/src/worker.ts +++ b/sdk/typescript/packages/nodejs-client/src/worker.ts @@ -107,7 +107,7 @@ class ClientWrapper { send = async ({ payload, recipient, - replySurbs = 0, + replySurbs = 10, }: { payload: Uint8Array; recipient: string; diff --git a/sdk/typescript/packages/sdk/src/mixnet/wasm/worker.ts b/sdk/typescript/packages/sdk/src/mixnet/wasm/worker.ts index 0f848433b8..0c65d27d79 100644 --- a/sdk/typescript/packages/sdk/src/mixnet/wasm/worker.ts +++ b/sdk/typescript/packages/sdk/src/mixnet/wasm/worker.ts @@ -118,7 +118,7 @@ class ClientWrapper { send = async ({ payload, recipient, - replySurbs = 0, + replySurbs = 10, }: { payload: Uint8Array; recipient: string; From 6d37d7df8e24d4e837fdaa7a8dbde288d86539bb Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Thu, 9 Nov 2023 16:38:07 +0100 Subject: [PATCH 4/7] dropped default surbs to 10 for uniformity across sdks --- sdk/rust/nym-sdk/src/mixnet/client.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/rust/nym-sdk/src/mixnet/client.rs b/sdk/rust/nym-sdk/src/mixnet/client.rs index acfd85b061..227ee5868c 100644 --- a/sdk/rust/nym-sdk/src/mixnet/client.rs +++ b/sdk/rust/nym-sdk/src/mixnet/client.rs @@ -35,7 +35,7 @@ use std::path::PathBuf; use url::Url; // The number of surbs to include in a message by default -const DEFAULT_NUMBER_OF_SURBS: u32 = 20; +const DEFAULT_NUMBER_OF_SURBS: u32 = 10; #[derive(Default)] pub struct MixnetClientBuilder { From 9b4262bb364b6be7d7b90d4d8270cc156d4e13e4 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Thu, 9 Nov 2023 17:44:05 +0100 Subject: [PATCH 5/7] added flag to socks5 info --- documentation/docs/src/clients/socks5-client.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/docs/src/clients/socks5-client.md b/documentation/docs/src/clients/socks5-client.md index 292848ff8a..96fded72f1 100644 --- a/documentation/docs/src/clients/socks5-client.md +++ b/documentation/docs/src/clients/socks5-client.md @@ -89,7 +89,7 @@ You can check the necessary parameters for the available commands by running: Before you can use the client, you need to initalise a new instance of it, which can be done with the following command: ``` -./nym-socks5-client init --id docs-example --provider Entztfv6Uaz2hpYHQJ6JKoaCTpDL5dja18SuQWVJAmmx.Cvhn9rBJw5Ay9wgHcbgCnVg89MPSV5s2muPV2YF1BXYu@Fo4f4SQLdoyoGkFae5TpVhRVoXCF8UiypLVGtGjujVPf +./nym-socks5-client init --id docs-example --use-reply-surbs true --provider Entztfv6Uaz2hpYHQJ6JKoaCTpDL5dja18SuQWVJAmmx.Cvhn9rBJw5Ay9wgHcbgCnVg89MPSV5s2muPV2YF1BXYu@Fo4f4SQLdoyoGkFae5TpVhRVoXCF8UiypLVGtGjujVPf ``` ~~~admonish example collapsible=true title="Console output" @@ -102,6 +102,8 @@ The `--id` in the example above is a local identifier so that you can name your The `--provider` field needs to be filled with the Nym address of a Network Requester that can make network requests on your behalf. If you don't want to [run your own](../nodes/network-requester.md) you can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/service-providers) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [this list](https://harbourmaster.nymtech.net/). +The `--use-reply-surbs` field denotes whether you wish to send [SURBs](../architecture/traffic-flow.md#private-replies-using-surbs) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with older versions of the [Network Requester](../nodes/network-requester.md). + Since the nodes on this list are the infrastructure for [Nymconnect](https://nymtech.net/developers/quickstart/nymconnect-gui.html) they will support all apps on the [default whitelist](../nodes/network-requester.md#network-requester-whitelist): Keybase, Telegram, Electrum, Blockstream Green, and Helios. #### Choosing a Gateway From 8e3f4ce08dd9374054080aab6d23af1bc30ce1a9 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Thu, 9 Nov 2023 17:45:19 +0100 Subject: [PATCH 6/7] format change --- documentation/docs/src/clients/socks5-client.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/docs/src/clients/socks5-client.md b/documentation/docs/src/clients/socks5-client.md index 96fded72f1..1299ade47e 100644 --- a/documentation/docs/src/clients/socks5-client.md +++ b/documentation/docs/src/clients/socks5-client.md @@ -100,9 +100,9 @@ Before you can use the client, you need to initalise a new instance of it, which The `--id` in the example above is a local identifier so that you can name your clients and keep track of them on your local system; it is **never** transmitted over the network. -The `--provider` field needs to be filled with the Nym address of a Network Requester that can make network requests on your behalf. If you don't want to [run your own](../nodes/network-requester.md) you can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/service-providers) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [this list](https://harbourmaster.nymtech.net/). +The `--use-reply-surbs` field denotes whether you wish to send [SURBs](../architecture/traffic-flow.md#private-replies-using-surbs) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with older versions of the [Network Requester](../nodes/network-requester.md). -The `--use-reply-surbs` field denotes whether you wish to send [SURBs](../architecture/traffic-flow.md#private-replies-using-surbs) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with older versions of the [Network Requester](../nodes/network-requester.md). +The `--provider` field needs to be filled with the Nym address of a Network Requester that can make network requests on your behalf. If you don't want to [run your own](../nodes/network-requester.md) you can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/service-providers) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [this list](https://harbourmaster.nymtech.net/). Since the nodes on this list are the infrastructure for [Nymconnect](https://nymtech.net/developers/quickstart/nymconnect-gui.html) they will support all apps on the [default whitelist](../nodes/network-requester.md#network-requester-whitelist): Keybase, Telegram, Electrum, Blockstream Green, and Helios. From f47e1793a28e306b387bd33c320e8427b7daf389 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Mon, 13 Nov 2023 10:45:52 +0100 Subject: [PATCH 7/7] typo fix --- documentation/docs/src/clients/socks5-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/src/clients/socks5-client.md b/documentation/docs/src/clients/socks5-client.md index 1299ade47e..6366c0af4f 100644 --- a/documentation/docs/src/clients/socks5-client.md +++ b/documentation/docs/src/clients/socks5-client.md @@ -150,7 +150,7 @@ Alternatively, a custom host can be set in the `config.toml` file under the `soc ### Running the socks5 client -You can run the initalised client by doing this: +You can run the initialised client by doing this: ``` ./nym-socks5-client run --id docs-example