Add rollup config to output CommonJS bundle

The WASM bundle is embedded as a base64 encoded resource and loaded synchronously, because this is the only mechanism widely supported to load WASM inside a web worker currently. Hopefully in the future this can be changed to pure modules.

.github/workflows/audit.yml

@@ -26,7 +26,7 @@ jobs:
           path: .github/workflows/support-files/notifications/deny.message
   notification:
     needs: cargo-deny
-    runs-on: ubuntu-20.04
+    runs-on: custom-runner-linux
     steps:
       - name: Check out repository code
         uses: actions/checkout@v2
@@ -47,6 +47,11 @@ jobs:
           KEYBASE_NYMBOT_PAPERKEY: "${{ secrets.KEYBASE_NYMBOT_PAPERKEY }}"
           KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
           KEYBASE_NYM_CHANNEL: "security"
+          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
         uses: docker://keybaseio/client:stable-node
         with:
           args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/audit_on_dispatch.yml

@@ -0,0 +1,58 @@
+name: Daily security audit
+
+on: workflow_dispatch
+jobs:
+  cargo-deny:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout repository code
+        uses: actions/checkout@v2
+      - name: Install rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+      - name: Install cargo deny
+        run: cargo install --locked cargo-deny
+      - name: Run cargo deny
+        run: |
+          find . -name Cargo.toml -exec cargo deny --manifest-path {} check \
+            advisories -A advisory-not-detected  --hide-inclusion-graph \; &> \
+            >(uniq  &> .github/workflows/support-files/notifications/deny.message )
+      - uses: actions/upload-artifact@v3
+        with:
+          name: report
+          path: .github/workflows/support-files/notifications/deny.message
+  notification:
+    needs: cargo-deny
+    runs-on: custom-runner-linux
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - name: Download report from previous job
+        uses: actions/download-artifact@v3
+        with:
+          name: report
+          path: .github/workflows/support-files/notifications
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: Keybase - Node Install
+        run: npm install
+        working-directory: .github/workflows/support-files
+      - name: Keybase - Send Notification
+        env:
+          NYM_NOTIFICATION_KIND: security
+          NYM_PROJECT_NAME: "Daily security report"
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          KEYBASE_NYMBOT_USERNAME: "${{ secrets.KEYBASE_NYMBOT_USERNAME }}"
+          KEYBASE_NYMBOT_PAPERKEY: "${{ secrets.KEYBASE_NYMBOT_PAPERKEY }}"
+          KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
+          KEYBASE_NYM_CHANNEL: "security"
+          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
+        uses: docker://keybaseio/client:stable-node
+        with:
+          args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/build-ts-packages.yml

@@ -58,6 +58,11 @@ jobs:
         KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
         KEYBASE_NYM_CHANNEL: "ci-ts-packages"
         IS_SUCCESS: "${{ job.status == 'success' }}"
+        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
       uses: docker://keybaseio/client:stable-node
       with:
         args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/build.yml

@@ -11,7 +11,7 @@ on:
 jobs:
   build:
     runs-on: [ self-hosted, custom-linux ]
-    # Enable sccache via environment variable
+    # Enable sccache via environment variable
     env:
       RUSTC_WRAPPER: /home/ubuntu/.cargo/bin/sccache
     steps:
@@ -56,6 +56,7 @@ jobs:
 
       - uses: actions-rs/clippy-check@v1
         name: Clippy checks
+        continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --workspace --all-features

.github/workflows/connect.yml

@@ -45,6 +45,7 @@ jobs:
 
       - uses: actions-rs/clippy-check@v1
         name: Clippy checks
+        continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --manifest-path nym-connect/Cargo.toml --workspace --all-features

.github/workflows/network-explorer.yml

@@ -73,6 +73,11 @@ jobs:
         KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
         KEYBASE_NYM_CHANNEL: "ci-network-explorer"
         IS_SUCCESS: "${{ job.status == 'success' }}"
+        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
       uses: docker://keybaseio/client:stable-node
       with:
         args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/nightly_build.yml

@@ -83,6 +83,7 @@ jobs:
 
       - uses: actions-rs/clippy-check@v1
         name: Clippy checks
+        continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --all-features
@@ -160,7 +161,7 @@ jobs:
 
   notification:
     needs: build
-    runs-on: ubuntu-20.04
+    runs-on: custom-runner-linux
     steps:
       - name: Collect jobs status
         uses: technote-space/workflow-conclusion-action@v2
@@ -183,6 +184,11 @@ jobs:
           KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
           KEYBASE_NYM_CHANNEL: "ci-nightly"
           IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
+          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
         uses: docker://keybaseio/client:stable-node
         with:
           args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/nightly_build_release.yml

@@ -98,6 +98,7 @@ jobs:
 
       - uses: actions-rs/clippy-check@v1
         name: Clippy checks
+        continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --all-features
@@ -175,7 +176,7 @@ jobs:
 
   notification:
     needs: [build,get_release]
-    runs-on: ubuntu-20.04
+    runs-on: custom-runner-linux
     steps:
       - name: Collect jobs status
         uses: technote-space/workflow-conclusion-action@v2
@@ -198,6 +199,11 @@ jobs:
           KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
           KEYBASE_NYM_CHANNEL: "ci-nightly-release"
           IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
+          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
         uses: docker://keybaseio/client:stable-node
         with:
           args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/nightly_build_release2.yml

@@ -98,6 +98,7 @@ jobs:
 
       - uses: actions-rs/clippy-check@v1
         name: Clippy checks
+        continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --all-features
@@ -175,7 +176,7 @@ jobs:
 
   notification:
     needs: [build,get_release]
-    runs-on: ubuntu-20.04
+    runs-on: custom-runner-linux
     steps:
       - name: Collect jobs status
         uses: technote-space/workflow-conclusion-action@v2
@@ -198,6 +199,11 @@ jobs:
           KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
           KEYBASE_NYM_CHANNEL: "ci-nightly-release"
           IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
+          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
         uses: docker://keybaseio/client:stable-node
         with:
           args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/nym-connect.yml

@@ -54,6 +54,11 @@ jobs:
         KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
         KEYBASE_NYM_CHANNEL: "ci-nym-connect"
         IS_SUCCESS: "${{ job.status == 'success' }}"
+        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
       uses: docker://keybaseio/client:stable-node
       with:
         args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/nym-release-publish.yml

@@ -60,7 +60,7 @@ jobs:
             target/release/nym-gateway
             target/release/nym-mixnode
             target/release/nym-socks5-client
-            target/release/nym-api
+            target/release/nym-validator-api
             target/release/nym-network-requester
             target/release/nym-network-statistics
             target/release/nym-cli
@@ -75,7 +75,7 @@ jobs:
             target/release/nym-gateway
             target/release/nym-mixnode
             target/release/nym-socks5-client
-            target/release/nym-api
+            target/release/nym-validator-api
             target/release/nym-network-requester
             target/release/nym-network-statistics
             target/release/nym-cli

.github/workflows/nym-wallet-storybook.yml

@@ -50,6 +50,11 @@ jobs:
         KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
         KEYBASE_NYM_CHANNEL: "ci-nym-wallet"
         IS_SUCCESS: "${{ job.status == 'success' }}"
+        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
       uses: docker://keybaseio/client:stable-node
       with:
         args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/support-files/.env.example

@@ -2,6 +2,13 @@ KEYBASE_NYM_CHANNEL=
 KEYBASE_NYMBOT_USERNAME=
 KEYBASE_NYMBOT_PAPERKEY=
 
+MATRIX_SERVER=
+MATRIX_ROOM=
+MATRIX_ROOM_OF_SHAME=
+MATRIX_USER_ID=
+MATRIX_TOKEN=
+MATRIX_DEVICE_ID=
+
 NYM_NOTIFICATION_KIND=nightly
 NYM_PROJECT_NAME=Nightly Build
 

.github/workflows/support-files/.gitignore

@@ -2,4 +2,6 @@ node_modules
 .idea
 
 # don't commit the lock file to avoid cross-platform issues
-package-lock.json
+package-lock.json
+
+scratch

.github/workflows/support-files/notifications/send_message.js

@@ -1,6 +1,7 @@
 require('dotenv').config();
 
 const Bot = require('keybase-bot');
+const { sendMatrixMessage } = require('./send_message_to_matrix');
 
 let context = {
   kinds: ['nym-wallet', 'ts-packages', 'network-explorer', 'nightly', 'nym-connect','security'],
@@ -38,6 +39,28 @@ function validateContext() {
       'Paperkey is not defined. Please set env var KEYBASE_NYMBOT_PAPERKEY',
     );
   }
+  if (context.env.MATRIX_ROOM) {
+    if (!context.env.MATRIX_SERVER) {
+      throw new Error(
+        'Matrix server is not defined. Please set env var MATRIX_SERVER',
+      );
+    }
+    if (!context.env.MATRIX_USER_ID) {
+      throw new Error(
+        'Matrix user id is not defined. Please set env var MATRIX_USER_ID',
+      );
+    }
+    if (!context.env.MATRIX_TOKEN) {
+      throw new Error(
+        'Matrix token is not defined. Please set env var MATRIX_TOKEN',
+      );
+    }
+    if (!context.env.MATRIX_DEVICE_ID) {
+      throw new Error(
+        'Matrix device id is not defined. Please set env var MATRIX_DEVICE_ID',
+      );
+    }
+  }
 }
 
 /**
@@ -147,6 +170,13 @@ async function main() {
     console.log('-----------------------------------------');
   }
   await sendKeybaseMessage(messageBody);
+  if(context.env.MATRIX_ROOM) {
+    await sendMatrixMessage(context, messageBody, context.env.MATRIX_ROOM)
+  }
+  if(context.env.MATRIX_ROOM_OF_SHAME && context.env.IS_SUCCESS !== 'true') {
+    // when a job fails
+    await sendMatrixMessage(context, messageBody, context.env.MATRIX_ROOM_OF_SHAME)
+  }
 }
 
 // call main function and let NodeJS handle the promise

.github/workflows/support-files/notifications/send_message_to_matrix.js

@@ -0,0 +1,80 @@
+const sdk = require('matrix-js-sdk');
+global.Olm = require('olm');
+const { LocalStorage } = require('node-localstorage');
+const localStorage = new LocalStorage('./scratch');
+const {
+  LocalStorageCryptoStore,
+} = require('matrix-js-sdk/lib/crypto/store/localStorage-crypto-store');
+
+const vfile = require('to-vfile');
+const unified = require('unified');
+const remarkParse = require('remark-parse');
+const remarkHtml = require('remark-html');
+const emoji = require('remark-emoji');
+
+// hide all matrix client output
+console.error = (error) => console.log('❌ error: ', error);
+process.stderr.write = () => {};
+process.stdout.write = () => {};
+
+
+function createClient(context, room, message) {
+  const server = context.env.MATRIX_SERVER;
+  const token = context.env.MATRIX_TOKEN;
+  const deviceId = context.env.MATRIX_DEVICE_ID;
+  const userId = context.env.MATRIX_USER_ID;
+
+  const client = sdk.createClient({
+    baseUrl: server,
+    accessToken: token,
+    userId,
+    deviceId,
+    sessionStore: new sdk.WebStorageSessionStore(localStorage),
+    cryptoStore: new LocalStorageCryptoStore(localStorage),
+  });
+
+  client.on('sync', async function(state, prevState, res) {
+    if (state !== 'PREPARED') return;
+    client.setGlobalErrorOnUnknownDevices(false);
+    try {
+      await client.joinRoom(room);
+      await client.sendEvent(
+        room,
+        'm.room.message',
+        {
+          msgtype: 'm.text',
+          format: 'org.matrix.custom.html',
+          body: message,
+          formatted_body: message,
+        },
+        '',
+      );
+    } catch (error) {
+      console.error('Job failed: ' + error.message);
+    }
+    client.stopClient();
+    process.exit(0);
+  });
+
+  return client;
+}
+
+async function markdownToHtml(messageAsMarkdown) {
+  const file = await unified()
+    .use(emoji)
+    .use(remarkParse)
+    .use(remarkHtml)
+    .process(await vfile({ path: 'test.md', contents: messageAsMarkdown}));
+  return String(file);
+}
+
+async function sendMatrixMessage(contextArg, messageAsMarkdown, roomId) {
+  const messageAsHtml = await markdownToHtml(messageAsMarkdown);
+  const client = createClient(contextArg, roomId, messageAsHtml);
+  await client.initCrypto();
+  await client.startClient({ initialSyncLimit: 1 });
+}
+
+module.exports = {
+  sendMatrixMessage,
+};

.github/workflows/support-files/package.json

@@ -11,7 +11,15 @@
     "dotenv": "^16.0.0",
     "handlebars": "^4.7.7",
     "keybase-bot": "^3.6.1",
-    "octokit": "^1.7.1"
+    "matrix-js-sdk": "^9.3.0",
+    "node-localstorage": "^2.1.6",
+    "octokit": "^1.7.1",
+    "olm": "https://packages.matrix.org/npm/olm/olm-3.2.1.tgz",
+    "remark-emoji": "^2.2.0",
+    "remark-html": "^13.0.2",
+    "remark-parse": "^9.0.0",
+    "to-vfile": "^6.1.0",
+    "unified": "^9.2.2"
   },
   "devDependencies": {
     "prettier": "2.3.2"

.github/workflows/wallet.yml

@@ -48,6 +48,7 @@ jobs:
 
       - uses: actions-rs/clippy-check@v1
         name: Clippy checks
+        continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --manifest-path nym-wallet/Cargo.toml --workspace --all-features

.gitignore

@@ -41,3 +41,4 @@ storybook-static
 envs/qwerty.env
 Cargo.lock
 nym-connect/Cargo.lock
+.parcel-cache

CHANGELOG.md

@@ -2,35 +2,28 @@
 
 Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [v1.1.6] (2023-01-17)
+## [Unreleased]
 
 ### Added
 
+- nym-sdk: added initial version of a Rust client sdk
+- nym-api: added `/circulating-supply` endpoint ([#2814])
+
 ### Changed
 
-- streamline override_config functions -> there's a lot of duplicate if statements everywhere ([#2774])
-- clean-up nym-api startup arguments/flags to use clap 3 and its macro-derived arguments ([#2772])
 - renamed all references to validator_api to nym_api
-- renamed all references to nymd to nyxd ([#2696])
+- renamed all references to nymd to nyxd
 - all-binaries: standarised argument names (note: old names should still be accepted) ([#2762]
 
 ### Fixed
 
 - nym-api: should now correctly use `rewarding.enabled` config flag ([#2753])
 
-[#2696]: https://github.com/nymtech/nym/pull/2696
 [#2753]: https://github.com/nymtech/nym/pull/2753
 [#2762]: https://github.com/nymtech/nym/pull/2762
-[#2772]: https://github.com/nymtech/nym/pull/2772
-[#2774]: https://github.com/nymtech/nym/pull/2774
+[#2814]: https://github.com/nymtech/nym/pull/2814
 
-## [v1.1.5] (2023-01-10)
-
-### Added
-
-### Changed
-
-## [v1.1.5] (2023-01-10)
+## [v1.1.5] (2022-01-10)
 
 ### Added
 

Cargo.lock

@@ -426,6 +426,13 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "build-information"
+version = "0.1.0"
+dependencies = [
+ "vergen 7.2.1",
+]
+
 [[package]]
 name = "bumpalo"
 version = "3.9.1"
@@ -598,41 +605,51 @@ version = "3.2.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "190814073e85d238f31ff738fcb0bf6910cedeb73376c87cd69291028966fd83"
 dependencies = [
- "atty",
  "bitflags",
- "clap_derive",
- "clap_lex",
+ "clap_lex 0.2.4",
  "indexmap",
- "once_cell",
- "strsim",
- "termcolor",
  "textwrap 0.15.0",
 ]
 
 [[package]]
-name = "clap_complete"
-version = "3.2.4"
+name = "clap"
+version = "4.0.26"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e4179da71abd56c26b54dd0c248cc081c1f43b0a1a7e8448e28e57a29baa993d"
+checksum = "2148adefda54e14492fb9bddcc600b4344c5d1a3123bd666dcb939c6f0e0e57e"
 dependencies = [
- "clap 3.2.8",
+ "atty",
+ "bitflags",
+ "clap_derive",
+ "clap_lex 0.3.0",
+ "once_cell",
+ "strsim",
+ "termcolor",
+]
+
+[[package]]
+name = "clap_complete"
+version = "4.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "10861370d2ba66b0f5989f83ebf35db6421713fd92351790e7fdd6c36774c56b"
+dependencies = [
+ "clap 4.0.26",
 ]
 
 [[package]]
 name = "clap_complete_fig"
-version = "3.2.4"
+version = "4.0.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ed37b4c0c1214673eba6ad8ea31666626bf72be98ffb323067d973c48b4964b9"
+checksum = "46b30e010e669cd021e5004f3be26cff6b7c08d2a8a0d65b48d43a8cc0efd6c3"
 dependencies = [
- "clap 3.2.8",
+ "clap 4.0.26",
  "clap_complete",
 ]
 
 [[package]]
 name = "clap_derive"
-version = "3.2.7"
+version = "4.0.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "759bf187376e1afa7b85b959e6a664a3e7a95203415dba952ad19139e798f902"
+checksum = "0177313f9f02afc995627906bbd8967e2be069f5261954222dac78290c2b9014"
 dependencies = [
  "heck 0.4.0",
  "proc-macro-error",
@@ -650,6 +667,15 @@ dependencies = [
  "os_str_bytes",
 ]
 
+[[package]]
+name = "clap_lex"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0d4198f73e42b4936b35b5bb248d81d2b595ecb170da0bac7655c54eedfa8da8"
+dependencies = [
+ "os_str_bytes",
+]
+
 [[package]]
 name = "client-connections"
 version = "0.1.0"
@@ -766,7 +792,7 @@ dependencies = [
 name = "completions"
 version = "0.1.0"
 dependencies = [
- "clap 3.2.8",
+ "clap 4.0.26",
  "clap_complete",
  "clap_complete_fig",
 ]
@@ -1005,7 +1031,7 @@ version = "0.1.0"
 dependencies = [
  "bip39",
  "cfg-if 0.1.10",
- "clap 3.2.8",
+ "clap 4.0.26",
  "coconut-interface",
  "completions",
  "config",
@@ -1765,7 +1791,7 @@ name = "explorer-api"
 version = "1.1.2"
 dependencies = [
  "chrono",
- "clap 3.2.8",
+ "clap 4.0.26",
  "contracts-common",
  "dotenv",
  "humantime-serde",
@@ -1778,6 +1804,9 @@ dependencies = [
  "network-defaults",
  "okapi",
  "pretty_env_logger",
+ "rand 0.8.5",
+ "rand_pcg 0.3.1",
+ "rand_seeder",
  "reqwest",
  "rocket",
  "rocket_cors",
@@ -1941,9 +1970,9 @@ checksum = "e6d5a32815ae3f33302d95fdcb2ce17862f8c65363dcfd29360480ba1001fc9c"
 
 [[package]]
 name = "futures"
-version = "0.3.24"
+version = "0.3.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7f21eda599937fba36daeb58a22e8f5cee2d14c4a17b5b7739c7c8e5e3b8230c"
+checksum = "38390104763dc37a5145a53c29c63c1290b5d316d6086ec32c293f6736051bb0"
 dependencies = [
  "futures-channel",
  "futures-core",
@@ -1956,9 +1985,9 @@ dependencies = [
 
 [[package]]
 name = "futures-channel"
-version = "0.3.24"
+version = "0.3.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "30bdd20c28fadd505d0fd6712cdfcb0d4b5648baf45faef7f852afb2399bb050"
+checksum = "52ba265a92256105f45b719605a571ffe2d1f0fea3807304b522c1d778f79eed"
 dependencies = [
  "futures-core",
  "futures-sink",
@@ -1966,15 +1995,15 @@ dependencies = [
 
 [[package]]
 name = "futures-core"
-version = "0.3.24"
+version = "0.3.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4e5aa3de05362c3fb88de6531e6296e85cde7739cccad4b9dfeeb7f6ebce56bf"
+checksum = "04909a7a7e4633ae6c4a9ab280aeb86da1236243a77b694a49eacd659a4bd3ac"
 
 [[package]]
 name = "futures-executor"
-version = "0.3.24"
+version = "0.3.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9ff63c23854bee61b6e9cd331d523909f238fc7636290b96826e9cfa5faa00ab"
+checksum = "7acc85df6714c176ab5edf386123fafe217be88c0840ec11f199441134a074e2"
 dependencies = [
  "futures-core",
  "futures-task",
@@ -1994,15 +2023,15 @@ dependencies = [
 
 [[package]]
 name = "futures-io"
-version = "0.3.24"
+version = "0.3.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bbf4d2a7a308fd4578637c0b17c7e1c7ba127b8f6ba00b29f717e9655d85eb68"
+checksum = "00f5fb52a06bdcadeb54e8d3671f8888a39697dcb0b81b23b55174030427f4eb"
 
 [[package]]
 name = "futures-macro"
-version = "0.3.24"
+version = "0.3.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "42cd15d1c7456c04dbdf7e88bcd69760d74f3a798d6444e16974b505b0e62f17"
+checksum = "bdfb8ce053d86b91919aad980c220b1fb8401a9394410e1c289ed7e66b61835d"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -2011,21 +2040,21 @@ dependencies = [
 
 [[package]]
 name = "futures-sink"
-version = "0.3.24"
+version = "0.3.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "21b20ba5a92e727ba30e72834706623d94ac93a725410b6a6b6fbc1b07f7ba56"
+checksum = "39c15cf1a4aa79df40f1bb462fb39676d0ad9e366c2a33b590d7c66f4f81fcf9"
 
 [[package]]
 name = "futures-task"
-version = "0.3.24"
+version = "0.3.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a6508c467c73851293f390476d4491cf4d227dbabcd4170f3bb6044959b294f1"
+checksum = "2ffb393ac5d9a6eaa9d3fdf37ae2776656b706e200c8e16b1bdb227f5198e6ea"
 
 [[package]]
 name = "futures-util"
-version = "0.3.24"
+version = "0.3.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "44fb6cb1be61cc1d2e43b262516aafcf63b241cffdb1d3fa115f91d9c7b09c90"
+checksum = "197676987abd2f9cadff84926f410af1c183608d36641465df73ae8211dc65d6"
 dependencies = [
  "futures-channel",
  "futures-core",
@@ -2056,6 +2085,7 @@ dependencies = [
  "nymsphinx",
  "pemstore",
  "rand 0.7.3",
+ "serde",
  "task",
  "thiserror",
  "tokio",
@@ -2245,7 +2275,7 @@ dependencies = [
  "indexmap",
  "slab",
  "tokio",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
  "tracing",
 ]
 
@@ -3005,8 +3035,9 @@ dependencies = [
  "futures",
  "log",
  "nymsphinx",
+ "task",
  "tokio",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
 ]
 
 [[package]]
@@ -3037,6 +3068,7 @@ dependencies = [
  "futures",
  "humantime-serde",
  "log",
+ "network-defaults",
  "nymsphinx-acknowledgements",
  "nymsphinx-addressing",
  "nymsphinx-forwarding",
@@ -3048,7 +3080,7 @@ dependencies = [
  "task",
  "thiserror",
  "tokio",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
  "url",
  "validator-client",
  "version-checker",
@@ -3148,7 +3180,7 @@ dependencies = [
  "slab",
  "tokio",
  "tokio-stream",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
  "wasm-timer",
 ]
 
@@ -3202,6 +3234,73 @@ dependencies = [
  "libc",
 ]
 
+[[package]]
+name = "nym-api"
+version = "1.1.5"
+dependencies = [
+ "anyhow",
+ "async-trait",
+ "bip39",
+ "bs58",
+ "build-information",
+ "cfg-if 1.0.0",
+ "clap 4.0.26",
+ "coconut-bandwidth-contract-common",
+ "coconut-dkg-common",
+ "coconut-interface",
+ "config",
+ "console-subscriber",
+ "contracts-common",
+ "cosmwasm-std",
+ "credential-storage",
+ "credentials",
+ "crypto",
+ "cw-utils",
+ "cw3",
+ "dirs",
+ "dkg",
+ "dotenv",
+ "futures",
+ "gateway-client",
+ "getset",
+ "humantime-serde",
+ "inclusion-probability",
+ "lazy_static",
+ "log",
+ "logging",
+ "mixnet-contract-common",
+ "multisig-contract-common",
+ "nym-api-requests",
+ "nymcoconut",
+ "nymsphinx",
+ "okapi",
+ "pemstore",
+ "pin-project",
+ "pretty_env_logger",
+ "rand 0.7.3",
+ "rand 0.8.5",
+ "reqwest",
+ "rocket",
+ "rocket_cors",
+ "rocket_okapi",
+ "schemars",
+ "serde",
+ "serde_json",
+ "sqlx 0.6.2",
+ "tap",
+ "task",
+ "thiserror",
+ "time 0.3.17",
+ "tokio",
+ "tokio-stream",
+ "topology",
+ "ts-rs",
+ "url",
+ "validator-client",
+ "version-checker",
+ "vesting-contract-common",
+]
+
 [[package]]
 name = "nym-api-requests"
 version = "0.1.0"
@@ -3240,7 +3339,7 @@ dependencies = [
  "base64",
  "bip39",
  "bs58",
- "clap 3.2.8",
+ "clap 4.0.26",
  "clap_complete",
  "clap_complete_fig",
  "dotenv",
@@ -3264,15 +3363,19 @@ dependencies = [
  "bip39",
  "bs58",
  "cfg-if 1.0.0",
- "clap 3.2.8",
+ "clap 4.0.26",
+ "coconut-bandwidth-contract-common",
+ "coconut-dkg-common",
  "comfy-table",
  "cosmrs",
  "cosmwasm-std",
+ "cw-utils",
  "handlebars",
  "humantime-serde",
  "k256",
  "log",
  "mixnet-contract-common",
+ "multisig-contract-common",
  "network-defaults",
  "rand 0.6.5",
  "serde",
@@ -3290,7 +3393,8 @@ dependencies = [
 name = "nym-client"
 version = "1.1.5"
 dependencies = [
- "clap 3.2.8",
+ "build-information",
+ "clap 4.0.26",
  "client-connections",
  "client-core",
  "coconut-interface",
@@ -3303,6 +3407,7 @@ dependencies = [
  "futures",
  "gateway-client",
  "gateway-requests",
+ "lazy_static",
  "log",
  "logging",
  "network-defaults",
@@ -3320,7 +3425,6 @@ dependencies = [
  "topology",
  "url",
  "validator-client",
- "vergen 5.1.17",
  "version-checker",
  "websocket-requests",
 ]
@@ -3331,9 +3435,11 @@ version = "1.1.5"
 dependencies = [
  "anyhow",
  "async-trait",
+ "atty",
  "bip39",
  "bs58",
- "clap 3.2.8",
+ "build-information",
+ "clap 4.0.26",
  "coconut-interface",
  "colored",
  "completions",
@@ -3346,29 +3452,32 @@ dependencies = [
  "futures",
  "gateway-requests",
  "humantime-serde",
+ "lazy_static",
  "log",
  "logging",
  "mixnet-client",
  "mixnode-common",
  "network-defaults",
  "nym-api-requests",
+ "nym-types",
  "nymsphinx",
  "once_cell",
  "pemstore",
  "pretty_env_logger",
  "rand 0.7.3",
  "serde",
+ "serde_json",
  "sqlx 0.5.11",
  "statistics-common",
  "subtle-encoding",
+ "task",
  "thiserror",
  "tokio",
  "tokio-stream",
  "tokio-tungstenite 0.14.0",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
  "url",
  "validator-client",
- "vergen 5.1.17",
  "version-checker",
 ]
 
@@ -3377,8 +3486,10 @@ name = "nym-mixnode"
 version = "1.1.5"
 dependencies = [
  "anyhow",
+ "atty",
  "bs58",
- "clap 3.2.8",
+ "build-information",
+ "clap 4.0.26",
  "colored",
  "completions",
  "config",
@@ -3394,6 +3505,7 @@ dependencies = [
  "mixnet-client",
  "mixnode-common",
  "nonexhaustive-delayqueue",
+ "nym-types",
  "nymsphinx",
  "nymsphinx-params",
  "nymsphinx-types",
@@ -3402,15 +3514,15 @@ dependencies = [
  "rand 0.7.3",
  "rocket",
  "serde",
+ "serde_json",
  "sysinfo",
  "task",
  "tokio",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
  "toml",
  "topology",
  "url",
  "validator-client",
- "vergen 5.1.17",
  "version-checker",
 ]
 
@@ -3419,7 +3531,7 @@ name = "nym-network-requester"
 version = "1.1.5"
 dependencies = [
  "async-trait",
- "clap 3.2.8",
+ "clap 4.0.26",
  "client-connections",
  "completions",
  "dirs",
@@ -3478,11 +3590,36 @@ dependencies = [
  "zeroize",
 ]
 
+[[package]]
+name = "nym-sdk"
+version = "0.1.0"
+dependencies = [
+ "client-connections",
+ "client-core",
+ "crypto",
+ "futures",
+ "gateway-client",
+ "gateway-requests",
+ "log",
+ "logging",
+ "network-defaults",
+ "nymsphinx",
+ "pretty_env_logger",
+ "rand 0.7.3",
+ "tap",
+ "task",
+ "thiserror",
+ "tokio",
+ "toml",
+ "url",
+]
+
 [[package]]
 name = "nym-socks5-client"
 version = "1.1.5"
 dependencies = [
- "clap 3.2.8",
+ "build-information",
+ "clap 4.0.26",
  "client-connections",
  "client-core",
  "coconut-interface",
@@ -3495,6 +3632,7 @@ dependencies = [
  "futures",
  "gateway-client",
  "gateway-requests",
+ "lazy_static",
  "log",
  "logging",
  "network-defaults",
@@ -3515,7 +3653,6 @@ dependencies = [
  "topology",
  "url",
  "validator-client",
- "vergen 5.1.17",
  "version-checker",
 ]
 
@@ -3545,70 +3682,6 @@ dependencies = [
  "vesting-contract-common",
 ]
 
-[[package]]
-name = "nym-validator-api"
-version = "1.1.5"
-dependencies = [
- "anyhow",
- "async-trait",
- "bs58",
- "cfg-if 1.0.0",
- "clap 3.2.8",
- "coconut-bandwidth-contract-common",
- "coconut-dkg-common",
- "coconut-interface",
- "config",
- "console-subscriber",
- "contracts-common",
- "cosmwasm-std",
- "credential-storage",
- "credentials",
- "crypto",
- "cw-utils",
- "cw3",
- "dirs",
- "dkg",
- "dotenv",
- "futures",
- "gateway-client",
- "getset",
- "humantime-serde",
- "inclusion-probability",
- "log",
- "logging",
- "mixnet-contract-common",
- "multisig-contract-common",
- "nym-api-requests",
- "nymcoconut",
- "nymsphinx",
- "okapi",
- "pemstore",
- "pin-project",
- "pretty_env_logger",
- "rand 0.7.3",
- "rand 0.8.5",
- "reqwest",
- "rocket",
- "rocket_cors",
- "rocket_okapi",
- "schemars",
- "serde",
- "serde_json",
- "sqlx 0.6.2",
- "tap",
- "task",
- "thiserror",
- "time 0.3.17",
- "tokio",
- "tokio-stream",
- "topology",
- "ts-rs",
- "url",
- "validator-client",
- "vergen 7.2.1",
- "version-checker",
-]
-
 [[package]]
 name = "nym-wallet-types"
 version = "1.0.0"
@@ -3761,7 +3834,7 @@ dependencies = [
  "nymsphinx-params",
  "nymsphinx-types",
  "thiserror",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
 ]
 
 [[package]]
@@ -4332,7 +4405,7 @@ dependencies = [
  "task",
  "tokio",
  "tokio-test",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
 ]
 
 [[package]]
@@ -4390,7 +4463,7 @@ dependencies = [
  "rand_isaac",
  "rand_jitter",
  "rand_os",
- "rand_pcg",
+ "rand_pcg 0.1.2",
  "rand_xorshift",
  "winapi",
 ]
@@ -4554,6 +4627,24 @@ dependencies = [
  "rand_core 0.4.2",
 ]
 
+[[package]]
+name = "rand_pcg"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "59cad018caf63deb318e5a4586d99a24424a364f40f1e5778c29aca23f4fc73e"
+dependencies = [
+ "rand_core 0.6.3",
+]
+
+[[package]]
+name = "rand_seeder"
+version = "0.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf2890aaef0aa82719a50e808de264f9484b74b442e1a3a0e5ee38243ac40bdb"
+dependencies = [
+ "rand_core 0.6.3",
+]
+
 [[package]]
 name = "rand_xorshift"
 version = "0.1.1"
@@ -4779,7 +4870,7 @@ dependencies = [
  "time 0.3.17",
  "tokio",
  "tokio-stream",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
  "ubyte",
  "version_check",
  "yansi",
@@ -5925,18 +6016,18 @@ checksum = "b1141d4d61095b28419e22cb0bbf02755f5e54e0526f97f1e3d1d160e60885fb"
 
 [[package]]
 name = "thiserror"
-version = "1.0.37"
+version = "1.0.38"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "10deb33631e3c9018b9baf9dcbbc4f737320d2b576bac10f6aefa048fa407e3e"
+checksum = "6a9cd18aa97d5c45c6603caea1da6628790b37f7a34b6ca89522331c5180fed0"
 dependencies = [
  "thiserror-impl",
 ]
 
 [[package]]
 name = "thiserror-impl"
-version = "1.0.37"
+version = "1.0.38"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "982d17546b47146b28f7c22e3d08465f6b8903d0ea13c1660d9d84a6e7adcdbb"
+checksum = "1fb327af4685e4d03fa8cbcf1716380da910eeb2bb8be417e7f9fd3fb164f36f"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -6003,9 +6094,9 @@ dependencies = [
 
 [[package]]
 name = "tokio"
-version = "1.22.0"
+version = "1.24.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d76ce4a75fb488c605c54bf610f221cea8b0dafb53333c1a67e8ee199dcd2ae3"
+checksum = "1d9f76183f91ecfb55e1d7d5602bd1d979e38a3a522fe900241cf195624d67ae"
 dependencies = [
  "autocfg 1.1.0",
  "bytes",
@@ -6019,7 +6110,7 @@ dependencies = [
  "socket2",
  "tokio-macros",
  "tracing",
- "winapi",
+ "windows-sys 0.42.0",
 ]
 
 [[package]]
@@ -6077,14 +6168,14 @@ dependencies = [
 
 [[package]]
 name = "tokio-stream"
-version = "0.1.9"
+version = "0.1.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "df54d54117d6fdc4e4fea40fe1e4e566b3505700e148a6827e59b34b0d2600d9"
+checksum = "d660770404473ccd7bc9f8b28494a811bc18542b915c0855c51e8f419d5223ce"
 dependencies = [
  "futures-core",
  "pin-project-lite",
  "tokio",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
 ]
 
 [[package]]
@@ -6141,9 +6232,9 @@ dependencies = [
 
 [[package]]
 name = "tokio-util"
-version = "0.7.3"
+version = "0.7.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cc463cd8deddc3770d20f9852143d50bf6094e640b485cb2e189a2099085ff45"
+checksum = "0bb2e075f03b3d66d8d8785356224ba688d2906a371015e225beeb65ca92c740"
 dependencies = [
  "bytes",
  "futures-core",
@@ -6156,9 +6247,9 @@ dependencies = [
 
 [[package]]
 name = "toml"
-version = "0.5.8"
+version = "0.5.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a31142970826733df8241ef35dc040ef98c679ab14d7c3e54d827099b3acecaa"
+checksum = "1333c76748e868a4d9d1017b5ab53171dfd095f70c712fdb4653a406547f598f"
 dependencies = [
  "serde",
 ]
@@ -6235,7 +6326,7 @@ dependencies = [
  "rand 0.8.5",
  "slab",
  "tokio",
- "tokio-util 0.7.3",
+ "tokio-util 0.7.4",
  "tower-layer",
  "tower-service",
  "tracing",

Cargo.toml

@@ -73,6 +73,7 @@ members = [
     "gateway/gateway-requests",
     "integrations/bity",
     "mixnode",
+    "sdk/rust/nym-sdk",
     "service-providers/network-requester",
     "service-providers/network-statistics",
     "nym-api",

clients/client-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "client-core"
-version = "1.1.6"
+version = "1.1.5"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
 edition = "2021"
 rust-version = "1.66"
@@ -20,7 +20,7 @@ serde_json = "1.0.89"
 tap = "1.0.1"
 thiserror = "1.0.34"
 url = { version ="2.2", features = ["serde"] }
-tokio = { version = "1.21.2", features = ["macros"]}
+tokio = { version = "1.24.1", features = ["macros"]}
 time = "0.3.17"
 
 # internal
@@ -38,11 +38,11 @@ validator-client = { path = "../../common/client-libs/validator-client", default
 task = { path = "../../common/task" }
 
 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio-stream]
-version = "0.1.9"
+version = "0.1.11"
 features = ["time"]
 
 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio]
-version = "1.21.2"
+version = "1.24.1"
 features = ["time"]
 
 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.sqlx]
@@ -75,7 +75,7 @@ features = ["wasm-bindgen"]
 tempfile = "3.1.0"
 
 [build-dependencies]
-tokio = { version = "1.21.2", features = ["rt-multi-thread", "macros"] }
+tokio = { version = "1.24.1", features = ["rt-multi-thread", "macros"] }
 sqlx = { version = "0.6.2", features = ["runtime-tokio-rustls", "sqlite", "macros", "migrate"] }
 
 [features]

clients/client-core/build.rs

@@ -9,9 +9,9 @@ async fn main() {
         use std::env;
 
         let out_dir = env::var("OUT_DIR").unwrap();
-        let database_path = format!("{}/fs-surbs-example.sqlite", out_dir);
+        let database_path = format!("{out_dir}/fs-surbs-example.sqlite");
 
-        let mut conn = SqliteConnection::connect(&format!("sqlite://{}?mode=rwc", database_path))
+        let mut conn = SqliteConnection::connect(&format!("sqlite://{database_path}?mode=rwc"))
             .await
             .expect("Failed to create SQLx database connection");
 

clients/client-core/src/client/base_client/mod.rs

@@ -33,12 +33,15 @@ use log::{debug, info};
 use nymsphinx::acknowledgements::AckKey;
 use nymsphinx::addressing::clients::Recipient;
 use nymsphinx::addressing::nodes::NodeIdentity;
+use nymsphinx::receiver::ReconstructedMessage;
 use std::sync::Arc;
 use std::time::Duration;
 use tap::TapFallible;
 use task::{TaskClient, TaskManager};
 use url::Url;
 
+use super::received_buffer::ReceivedBufferMessage;
+
 #[cfg(all(not(target_arch = "wasm32"), feature = "fs-surb-storage"))]
 pub mod non_wasm_helpers;
 
@@ -48,10 +51,30 @@ pub struct ClientInput {
 }
 
 pub struct ClientOutput {
-    pub shared_lane_queue_lengths: LaneQueueLengths,
     pub received_buffer_request_sender: ReceivedBufferRequestSender,
 }
 
+impl ClientOutput {
+    pub fn register_receiver(
+        &mut self,
+    ) -> Result<mpsc::UnboundedReceiver<Vec<ReconstructedMessage>>, ClientCoreError> {
+        let (reconstructed_sender, reconstructed_receiver) = mpsc::unbounded();
+
+        self.received_buffer_request_sender
+            .unbounded_send(ReceivedBufferMessage::ReceiverAnnounce(
+                reconstructed_sender,
+            ))
+            .map_err(|_| ClientCoreError::FailedToRegisterReceiver)?;
+
+        Ok(reconstructed_receiver)
+    }
+}
+
+pub struct ClientState {
+    pub shared_lane_queue_lengths: LaneQueueLengths,
+    pub reply_controller_sender: ReplyControllerSender,
+}
+
 pub enum ClientInputStatus {
     AwaitingProducer { client_input: ClientInput },
     Connected,
@@ -80,6 +103,32 @@ impl ClientOutputStatus {
     }
 }
 
+#[derive(Copy, Clone, PartialEq, Eq)]
+pub enum CredentialsToggle {
+    Enabled,
+    Disabled,
+}
+
+impl CredentialsToggle {
+    pub fn is_enabled(&self) -> bool {
+        self == &CredentialsToggle::Enabled
+    }
+
+    pub fn is_disabled(&self) -> bool {
+        self == &CredentialsToggle::Disabled
+    }
+}
+
+impl From<bool> for CredentialsToggle {
+    fn from(value: bool) -> Self {
+        if value {
+            CredentialsToggle::Enabled
+        } else {
+            CredentialsToggle::Disabled
+        }
+    }
+}
+
 pub struct BaseClientBuilder<'a, B> {
     // due to wasm limitations I had to split it like this : (
     gateway_config: &'a GatewayEndpointConfig,
@@ -119,13 +168,13 @@ where
         key_manager: KeyManager,
         bandwidth_controller: Option<BandwidthController>,
         reply_storage_backend: B,
-        disabled_credentials: bool,
+        credentials_toggle: CredentialsToggle,
         nym_api_endpoints: Vec<Url>,
     ) -> BaseClientBuilder<'a, B> {
         BaseClientBuilder {
             gateway_config,
             debug_config,
-            disabled_credentials,
+            disabled_credentials: credentials_toggle.is_disabled(),
             nym_api_endpoints,
             reply_storage_backend,
             bandwidth_controller,
@@ -248,7 +297,7 @@ where
             .map_err(ClientCoreError::UnableToCreatePublicKeyFromGatewayId)?;
 
         // disgusting wasm workaround since there's no key persistence there (nor `client init`)
-        let shared_key = if self.key_manager.gateway_key_set() {
+        let shared_key = if self.key_manager.is_gateway_key_set() {
             Some(self.key_manager.gateway_shared_key())
         } else {
             None
@@ -475,11 +524,13 @@ where
             },
             client_output: ClientOutputStatus::AwaitingConsumer {
                 client_output: ClientOutput {
-                    shared_lane_queue_lengths,
                     received_buffer_request_sender,
                 },
             },
-            reply_controller_sender,
+            client_state: ClientState {
+                shared_lane_queue_lengths,
+                reply_controller_sender,
+            },
             task_manager,
         })
     }
@@ -488,9 +539,7 @@ where
 pub struct BaseClient {
     pub client_input: ClientInputStatus,
     pub client_output: ClientOutputStatus,
-
-    // it feels very wrong to put this channel here, but I can't think of any other way of passing it to the native client
-    pub reply_controller_sender: ReplyControllerSender,
+    pub client_state: ClientState,
 
     pub task_manager: TaskManager,
 }

clients/client-core/src/client/base_client/non_wasm_helpers.rs

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::client::replies::reply_storage::{
-    fs_backend, CombinedReplyStorage, ReplyStorageBackend,
+    self, fs_backend, CombinedReplyStorage, ReplyStorageBackend,
 };
 use crate::config::DebugConfig;
 use crate::error::ClientCoreError;
@@ -53,7 +53,7 @@ fn archive_corrupted_database<P: AsRef<Path>>(db_path: P) -> io::Result<()> {
 
     let new_extension =
         if let Some(existing_extension) = db_path.extension().and_then(|ext| ext.to_str()) {
-            format!("{existing_extension}.{}", suffix)
+            format!("{existing_extension}.{suffix}")
         } else {
             suffix
         };
@@ -85,3 +85,10 @@ pub async fn setup_fs_reply_surb_backend<P: AsRef<Path>>(
         setup_fresh_backend(db_path, debug_config).await
     }
 }
+
+pub fn setup_empty_reply_surb_backend(debug_config: &DebugConfig) -> reply_storage::Empty {
+    reply_storage::Empty {
+        min_surb_threshold: debug_config.minimum_reply_surb_storage_threshold,
+        max_surb_threshold: debug_config.maximum_reply_surb_storage_threshold,
+    }
+}

clients/client-core/src/client/key_manager.rs

@@ -17,6 +17,7 @@ use std::sync::Arc;
 // use the old key after new one was issued.
 
 // Remember that Arc<T> has Deref implementation for T
+#[derive(Clone)]
 pub struct KeyManager {
     /// identity key associated with the client instance.
     identity_keypair: Arc<identity::KeyPair>,
@@ -41,9 +42,6 @@ pub struct KeyManager {
 */
 
 impl KeyManager {
-    // this is actually **NOT** dead code
-    // I have absolutely no idea why the compiler insists it's unused. The call happens during client::init::execute
-    #[allow(dead_code)]
     /// Creates new instance of a [`KeyManager`]
     pub fn new<R>(rng: &mut R) -> Self
     where
@@ -57,16 +55,22 @@ impl KeyManager {
         }
     }
 
-    // this is actually **NOT** dead code
-    // I have absolutely no idea why the compiler insists it's unused. The call happens during client::init::execute
-    #[allow(dead_code)]
-    /// After shared key with the gateway is derived, puts its ownership to this instance of a [`KeyManager`].
-    pub fn insert_gateway_shared_key(&mut self, gateway_shared_key: Arc<SharedKeys>) {
-        self.gateway_shared_key = Some(gateway_shared_key)
+    pub fn from_keys(
+        id_keypair: identity::KeyPair,
+        enc_keypair: encryption::KeyPair,
+        gateway_shared_key: SharedKeys,
+        ack_key: AckKey,
+    ) -> Self {
+        Self {
+            identity_keypair: Arc::new(id_keypair),
+            encryption_keypair: Arc::new(enc_keypair),
+            gateway_shared_key: Some(Arc::new(gateway_shared_key)),
+            ack_key: Arc::new(ack_key),
+        }
     }
 
-    /// Loads previously stored keys from the disk.
-    pub fn load_keys(client_pathfinder: &ClientKeyPathfinder) -> io::Result<Self> {
+    /// Loads previously stored client keys from the disk.
+    fn load_client_keys(client_pathfinder: &ClientKeyPathfinder) -> io::Result<Self> {
         let identity_keypair: identity::KeyPair =
             pemstore::load_keypair(&pemstore::KeyPairPath::new(
                 client_pathfinder.private_identity_key().to_owned(),
@@ -78,24 +82,51 @@ impl KeyManager {
                 client_pathfinder.public_encryption_key().to_owned(),
             ))?;
 
-        let gateway_shared_key: SharedKeys =
-            pemstore::load_key(client_pathfinder.gateway_shared_key())?;
-
         let ack_key: AckKey = pemstore::load_key(client_pathfinder.ack_key())?;
 
-        // TODO: ack key is never stored so it is generated now. But perhaps it should be stored
-        // after all for consistency sake?
         Ok(KeyManager {
             identity_keypair: Arc::new(identity_keypair),
             encryption_keypair: Arc::new(encryption_keypair),
-            gateway_shared_key: Some(Arc::new(gateway_shared_key)),
+            gateway_shared_key: None,
             ack_key: Arc::new(ack_key),
         })
     }
 
-    // this is actually **NOT** dead code
-    // I have absolutely no idea why the compiler insists it's unused. The call happens during client::init::execute
-    #[allow(dead_code)]
+    /// Loads previously stored keys from the disk. Fails if not all, including the shared gateway
+    /// key, is available.
+    pub fn load_keys(client_pathfinder: &ClientKeyPathfinder) -> io::Result<Self> {
+        let mut key_manager = Self::load_client_keys(client_pathfinder)?;
+
+        let gateway_shared_key: SharedKeys =
+            pemstore::load_key(client_pathfinder.gateway_shared_key())?;
+
+        key_manager.gateway_shared_key = Some(Arc::new(gateway_shared_key));
+
+        Ok(key_manager)
+    }
+
+    /// Loads previously stored keys from the disk. Fails if client keys are not availabe, but the
+    /// shared gateway key is optional.
+    pub fn load_keys_but_gateway_is_optional(
+        client_pathfinder: &ClientKeyPathfinder,
+    ) -> io::Result<Self> {
+        let mut key_manager = Self::load_client_keys(client_pathfinder)?;
+
+        let gateway_shared_key: Result<SharedKeys, io::Error> =
+            pemstore::load_key(client_pathfinder.gateway_shared_key());
+
+        // It's ok if the gateway key was not found
+        let gateway_shared_key = match gateway_shared_key {
+            Err(err) if err.kind() == io::ErrorKind::NotFound => Ok(None),
+            Err(err) => Err(err),
+            Ok(key) => Ok(Some(key)),
+        }?;
+
+        key_manager.gateway_shared_key = gateway_shared_key.map(Arc::new);
+
+        Ok(key_manager)
+    }
+
     /// Stores all available keys on the disk.
     // While perhaps there is no much point in storing the `AckKey` on the disk,
     // it is done so for the consistency sake so that you wouldn't require an rng instance
@@ -119,7 +150,7 @@ impl KeyManager {
         pemstore::store_key(self.ack_key.as_ref(), client_pathfinder.ack_key())?;
 
         match self.gateway_shared_key.as_ref() {
-            None => warn!("No gateway shared key available to store!"),
+            None => debug!("No gateway shared key available to store!"),
             Some(gate_key) => {
                 pemstore::store_key(gate_key.as_ref(), client_pathfinder.gateway_shared_key())?
             }
@@ -128,16 +159,57 @@ impl KeyManager {
         Ok(())
     }
 
+    pub fn store_gateway_key(&self, client_pathfinder: &ClientKeyPathfinder) -> io::Result<()> {
+        match self.gateway_shared_key.as_ref() {
+            None => {
+                return Err(io::Error::new(
+                    io::ErrorKind::Other,
+                    "trying to store a non-existing key",
+                ))
+            }
+            Some(gate_key) => {
+                pemstore::store_key(gate_key.as_ref(), client_pathfinder.gateway_shared_key())?
+            }
+        }
+
+        Ok(())
+    }
+
+    /// Overwrite the existing identity keypair
+    pub fn set_identity_keypair(&mut self, id_keypair: identity::KeyPair) {
+        self.identity_keypair = Arc::new(id_keypair);
+    }
+
     /// Gets an atomically reference counted pointer to [`identity::KeyPair`].
     pub fn identity_keypair(&self) -> Arc<identity::KeyPair> {
         Arc::clone(&self.identity_keypair)
     }
 
+    /// Overwrite the existing encryption keypair
+    pub fn set_encryption_keypair(&mut self, enc_keypair: encryption::KeyPair) {
+        self.encryption_keypair = Arc::new(enc_keypair);
+    }
+
     /// Gets an atomically reference counted pointer to [`encryption::KeyPair`].
     pub fn encryption_keypair(&self) -> Arc<encryption::KeyPair> {
         Arc::clone(&self.encryption_keypair)
     }
 
+    /// Overwrite the existing ack key
+    pub fn set_ack_key(&mut self, ack_key: AckKey) {
+        self.ack_key = Arc::new(ack_key);
+    }
+
+    /// Gets an atomically reference counted pointer to [`AckKey`].
+    pub fn ack_key(&self) -> Arc<AckKey> {
+        Arc::clone(&self.ack_key)
+    }
+
+    /// After shared key with the gateway is derived, puts its ownership to this instance of a [`KeyManager`].
+    pub fn insert_gateway_shared_key(&mut self, gateway_shared_key: Arc<SharedKeys>) {
+        self.gateway_shared_key = Some(gateway_shared_key)
+    }
+
     /// Gets an atomically reference counted pointer to [`SharedKey`].
     // since this function is not fully public, it is not expected to be used externally and
     // hence it's up to us to ensure it's called in correct context
@@ -149,12 +221,7 @@ impl KeyManager {
         )
     }
 
-    pub fn gateway_key_set(&self) -> bool {
+    pub fn is_gateway_key_set(&self) -> bool {
         self.gateway_shared_key.is_some()
     }
-
-    /// Gets an atomically reference counted pointer to [`AckKey`].
-    pub fn ack_key(&self) -> Arc<AckKey> {
-        Arc::clone(&self.ack_key)
-    }
 }

clients/client-core/src/client/mix_traffic.rs

@@ -57,7 +57,7 @@ impl MixTrafficController {
                 if self.consecutive_gateway_failure_count == MAX_FAILURE_COUNT {
                     // todo: in the future this should initiate a 'graceful' shutdown or try
                     // to reconnect?
-                    panic!("failed to send sphinx packet to the gateway {} times in a row - assuming the gateway is dead. Can't do anything about it yet :(", MAX_FAILURE_COUNT)
+                    panic!("failed to send sphinx packet to the gateway {MAX_FAILURE_COUNT} times in a row - assuming the gateway is dead. Can't do anything about it yet :(")
                 }
             }
             Ok(_) => {

clients/client-core/src/client/real_messages_control/acknowledgement_control/action_controller.rs

@@ -213,7 +213,11 @@ impl ActionController {
     }
 
     // note: when the entry expires it's automatically removed from pending_acks_timers
-    fn handle_expired_ack_timer(&mut self, expired_ack: Expired<FragmentIdentifier>) {
+    fn handle_expired_ack_timer(
+        &mut self,
+        expired_ack: Expired<FragmentIdentifier>,
+        task_client: &mut task::TaskClient,
+    ) {
         // I'm honestly not sure how to handle it, because getting it means other things in our
         // system are already misbehaving. If we ever see this panic, then I guess we should worry
         // about it. Perhaps just reschedule it at later point?
@@ -231,9 +235,16 @@ impl ActionController {
             // downgrading an arc and then upgrading vs cloning is difference of 30ns vs 15ns
             // so it's literally a NO difference while it might prevent us from unnecessarily
             // resending data (in maybe 1 in 1 million cases, but it's something)
-            self.retransmission_sender
+            if self
+                .retransmission_sender
                 .unbounded_send(Arc::downgrade(pending_ack_data))
-                .unwrap()
+                .is_err()
+            {
+                assert!(
+                    task_client.is_shutdown_poll(),
+                    "Failed to send pending ack for retransmission"
+                );
+            }
         } else {
             // this shouldn't cause any issues but shouldn't have happened to begin with!
             error!("An already removed pending ack has expired")
@@ -264,7 +275,7 @@ impl ActionController {
                     }
                 },
                 expired_ack = self.pending_acks_timers.next() => match expired_ack {
-                    Some(expired_ack) => self.handle_expired_ack_timer(expired_ack),
+                    Some(expired_ack) => self.handle_expired_ack_timer(expired_ack, &mut shutdown),
                     None => {
                         log::trace!("ActionController: Stopping since ack channel closed");
                         break;
@@ -275,10 +286,7 @@ impl ActionController {
                 }
             }
         }
-        #[cfg(not(target_arch = "wasm32"))]
-        tokio::time::timeout(Duration::from_secs(5), shutdown.recv())
-            .await
-            .expect("Task stopped without shutdown called");
+        shutdown.recv_timeout().await;
         log::debug!("ActionController: Exiting");
     }
 }

clients/client-core/src/client/real_messages_control/real_traffic_stream.rs

@@ -471,14 +471,10 @@ where
         let mult = self.sending_delay_controller.current_multiplier();
         let delay = self.current_average_message_sending_delay().as_millis();
         let status_str = if self.config.disable_poisson_packet_distribution {
-            format!(
-                "Status: {lanes} lanes, backlog: {:.2} kiB ({packets}), no delay",
-                backlog
-            )
+            format!("Status: {lanes} lanes, backlog: {backlog:.2} kiB ({packets}), no delay")
         } else {
             format!(
-                "Status: {lanes} lanes, backlog: {:.2} kiB ({packets}), avg delay: {}ms ({mult})",
-                backlog, delay
+                "Status: {lanes} lanes, backlog: {backlog:.2} kiB ({packets}), avg delay: {delay}ms ({mult})"
             )
         };
         if packets > 1000 {
@@ -535,9 +531,7 @@ where
                     }
                 }
             }
-            tokio::time::timeout(Duration::from_secs(5), shutdown.recv())
-                .await
-                .expect("Task stopped without shutdown called");
+            shutdown.recv_timeout().await;
         }
 
         #[cfg(target_arch = "wasm32")]

clients/client-core/src/client/replies/reply_controller/requests.rs

@@ -99,6 +99,24 @@ impl ReplyControllerSender {
     }
 }
 
+pub struct ReplyQueueLengths {
+    reply_controller_sender: ReplyControllerSender,
+}
+
+impl ReplyQueueLengths {
+    pub fn new(reply_controller_sender: ReplyControllerSender) -> Self {
+        Self {
+            reply_controller_sender,
+        }
+    }
+
+    pub async fn get_lane_queue_length(&self, connection_id: ConnectionId) -> usize {
+        self.reply_controller_sender
+            .get_lane_queue_length(connection_id)
+            .await
+    }
+}
+
 pub(crate) type ReplyControllerReceiver = mpsc::UnboundedReceiver<ReplyControllerMessage>;
 
 #[derive(Debug)]

clients/client-core/src/client/replies/reply_storage/backend/browser_backend.rs

@@ -7,6 +7,7 @@ use async_trait::async_trait;
 
 // well, right now we don't have the browser storage : (
 // so we keep everything in memory
+#[derive(Debug)]
 pub struct Backend {
     empty: Empty,
 }

clients/client-core/src/client/replies/reply_storage/backend/fs_backend/models.rs

@@ -44,8 +44,7 @@ impl TryFrom<StoredSenderTag> for (RecipientBytes, AnonymousSenderTag) {
         let Ok(sender_tag_bytes) = value.tag.try_into() else {
             return Err(StorageError::CorruptedData {
                 details: format!(
-                    "the retrieved sender tag has length of {tag_len} while {} was expected",
-                    SENDER_TAG_SIZE
+                    "the retrieved sender tag has length of {tag_len} while {SENDER_TAG_SIZE} was expected",
                 ),
             });
         };
@@ -132,8 +131,7 @@ impl TryFrom<StoredSurbSender> for (AnonymousSenderTag, i64) {
         let Ok(sender_tag_bytes) = value.tag.try_into() else {
             return Err(StorageError::CorruptedData {
                 details: format!(
-                    "the retrieved sender tag has length of {tag_len} while {} was expected",
-                    SENDER_TAG_SIZE
+                    "the retrieved sender tag has length of {tag_len} while {SENDER_TAG_SIZE} was expected",
                 ),
             });
         };

clients/client-core/src/client/replies/reply_storage/backend/mod.rs

@@ -19,10 +19,11 @@ pub mod fs_backend;
 #[error("no information provided")]
 pub struct UndefinedError;
 
+#[derive(Debug)]
 pub struct Empty {
     // we need to keep 'basic' metadata here to "load" the CombinedReplyStorage
-    min_surb_threshold: usize,
-    max_surb_threshold: usize,
+    pub min_surb_threshold: usize,
+    pub max_surb_threshold: usize,
 }
 
 #[async_trait]

clients/client-core/src/config/mod.rs

@@ -88,6 +88,7 @@ impl<T> Config<T> {
         Config::default().with_id(id)
     }
 
+    #[must_use]
     pub fn with_id<S: Into<String>>(mut self, id: S) -> Self
     where
         T: NymConfig,

clients/client-core/src/config/persistence/key_pathfinder.rs

@@ -7,12 +7,12 @@ use std::path::{Path, PathBuf};
 
 #[derive(Debug)]
 pub struct ClientKeyPathfinder {
-    identity_private_key: PathBuf,
-    identity_public_key: PathBuf,
-    encryption_private_key: PathBuf,
-    encryption_public_key: PathBuf,
-    gateway_shared_key: PathBuf,
-    ack_key: PathBuf,
+    pub identity_private_key: PathBuf,
+    pub identity_public_key: PathBuf,
+    pub encryption_private_key: PathBuf,
+    pub encryption_public_key: PathBuf,
+    pub gateway_shared_key: PathBuf,
+    pub ack_key: PathBuf,
 }
 
 impl ClientKeyPathfinder {
@@ -22,8 +22,8 @@ impl ClientKeyPathfinder {
         ClientKeyPathfinder {
             identity_private_key: config_dir.join("private_identity.pem"),
             identity_public_key: config_dir.join("public_identity.pem"),
-            encryption_private_key: config_dir.join("public_encryption.pem"),
-            encryption_public_key: config_dir.join("private_encryption.pem"),
+            encryption_private_key: config_dir.join("private_encryption.pem"),
+            encryption_public_key: config_dir.join("public_encryption.pem"),
             gateway_shared_key: config_dir.join("gateway_shared.pem"),
             ack_key: config_dir.join("ack_key.pem"),
         }
@@ -40,6 +40,28 @@ impl ClientKeyPathfinder {
         }
     }
 
+    pub fn any_file_exists(&self) -> bool {
+        matches!(self.identity_public_key.try_exists(), Ok(true))
+            || matches!(self.identity_private_key.try_exists(), Ok(true))
+            || matches!(self.encryption_public_key.try_exists(), Ok(true))
+            || matches!(self.encryption_private_key.try_exists(), Ok(true))
+            || matches!(self.gateway_shared_key.try_exists(), Ok(true))
+            || matches!(self.ack_key.try_exists(), Ok(true))
+    }
+
+    pub fn any_file_exists_and_return(&self) -> Option<PathBuf> {
+        file_exists(&self.identity_public_key)
+            .or_else(|| file_exists(&self.identity_private_key))
+            .or_else(|| file_exists(&self.encryption_public_key))
+            .or_else(|| file_exists(&self.encryption_private_key))
+            .or_else(|| file_exists(&self.gateway_shared_key))
+            .or_else(|| file_exists(&self.ack_key))
+    }
+
+    pub fn gateway_key_file_exists(&self) -> bool {
+        matches!(self.gateway_shared_key.try_exists(), Ok(true))
+    }
+
     pub fn private_identity_key(&self) -> &Path {
         &self.identity_private_key
     }
@@ -64,3 +86,10 @@ impl ClientKeyPathfinder {
         &self.ack_key
     }
 }
+
+fn file_exists(path: &Path) -> Option<PathBuf> {
+    if matches!(path.try_exists(), Ok(true)) {
+        return Some(path.to_path_buf());
+    }
+    None
+}

clients/client-core/src/error.rs

@@ -55,6 +55,9 @@ pub enum ClientCoreError {
     #[error("The address of the gateway is unknown - did you run init?")]
     GatwayAddressUnknown,
 
+    #[error("failed to register receiver for reconstructed mixnet messages")]
+    FailedToRegisterReceiver,
+
     #[error("Unexpected exit")]
     UnexpectedExit,
 }
@@ -62,8 +65,10 @@ pub enum ClientCoreError {
 /// Set of messages that the client can send to listeners via the task manager
 #[derive(thiserror::Error, Debug)]
 pub enum ClientCoreStatusMessage {
+    // NOTE: The nym-connect frontend listens for these strings, so don't change them until we have a more robust mechanism in place
     #[error("The connected gateway is slow, or the connection to it is slow")]
     GatewayIsSlow,
+    // NOTE: The nym-connect frontend listens for these strings, so don't change them until we have a more robust mechanism in place
     #[error("The connected gateway is very slow, or the connection to it is very slow")]
     GatewayIsVerySlow,
 }

clients/client-core/src/init/helpers.rs

@@ -10,7 +10,7 @@ use config::NymConfig;
 use crypto::asymmetric::identity;
 use gateway_client::GatewayClient;
 use gateway_requests::registration::handshake::SharedKeys;
-use rand::{rngs::OsRng, seq::SliceRandom, thread_rng};
+use rand::{seq::SliceRandom, thread_rng};
 use std::{sync::Arc, time::Duration};
 use tap::TapFallible;
 use topology::{filter::VersionFilterable, gateway};
@@ -18,7 +18,7 @@ use url::Url;
 
 pub(super) async fn query_gateway_details(
     validator_servers: Vec<Url>,
-    chosen_gateway_id: Option<String>,
+    chosen_gateway_id: Option<identity::PublicKey>,
 ) -> Result<gateway::Node, ClientCoreError> {
     let nym_api = validator_servers
         .choose(&mut thread_rng())
@@ -40,7 +40,7 @@ pub(super) async fn query_gateway_details(
     if let Some(gateway_id) = chosen_gateway_id {
         filtered_gateways
             .iter()
-            .find(|gateway| gateway.identity_key.to_base58_string() == gateway_id)
+            .find(|gateway| gateway.identity_key == gateway_id)
             .ok_or_else(|| ClientCoreError::NoGatewayWithId(gateway_id.to_string()))
             .cloned()
     } else {
@@ -51,7 +51,7 @@ pub(super) async fn query_gateway_details(
     }
 }
 
-async fn register_with_gateway(
+pub(super) async fn register_with_gateway(
     gateway: &gateway::Node,
     our_identity: Arc<identity::KeyPair>,
 ) -> Result<Arc<SharedKeys>, ClientCoreError> {
@@ -74,20 +74,13 @@ async fn register_with_gateway(
     Ok(shared_keys)
 }
 
-pub(super) async fn register_with_gateway_and_store_keys<T>(
-    gateway_details: gateway::Node,
+pub(super) fn store_keys<T>(
+    key_manager: &KeyManager,
     config: &Config<T>,
 ) -> Result<(), ClientCoreError>
 where
     T: NymConfig,
 {
-    let mut rng = OsRng;
-    let mut key_manager = KeyManager::new(&mut rng);
-
-    let shared_keys =
-        register_with_gateway(&gateway_details, key_manager.identity_keypair()).await?;
-    key_manager.insert_gateway_shared_key(shared_keys);
-
     let pathfinder = ClientKeyPathfinder::new_from_config(config);
     Ok(key_manager
         .store_keys(&pathfinder)

clients/client-core/src/init/mod.rs

@@ -6,23 +6,26 @@
 use std::fmt::Display;
 
 use nymsphinx::addressing::{clients::Recipient, nodes::NodeIdentity};
+use rand::rngs::OsRng;
 use serde::Serialize;
 use tap::TapFallible;
 
 use config::NymConfig;
 use crypto::asymmetric::{encryption, identity};
+use url::Url;
 
+use crate::client::key_manager::KeyManager;
 use crate::{
     config::{
         persistence::key_pathfinder::ClientKeyPathfinder, ClientCoreConfigTrait, Config,
         GatewayEndpointConfig,
     },
     error::ClientCoreError,
-    init::helpers::{query_gateway_details, register_with_gateway_and_store_keys},
 };
 
 mod helpers;
 
+/// Struct describing the results of the client initialization procedure.
 #[derive(Debug, Serialize)]
 pub struct InitResults {
     version: String,
@@ -60,12 +63,44 @@ impl Display for InitResults {
     }
 }
 
-/// Convenience function for setting up the gateway for a client. Depending on the arguments given
-/// it will do the sensible thing.
-pub async fn setup_gateway<C, T>(
+/// Create a new set of client keys.
+pub fn new_client_keys() -> KeyManager {
+    let mut rng = OsRng;
+    KeyManager::new(&mut rng)
+}
+
+/// Authenticate and register with a gateway.
+/// Either pick one at random by querying the available gateways from the nym-api, or use the
+/// chosen one if it's among the available ones.
+/// The shared key is added to the supplied `KeyManager` and the endpoint details are returned.
+pub async fn register_with_gateway(
+    key_manager: &mut KeyManager,
+    nym_api_endpoints: Vec<Url>,
+    chosen_gateway_id: Option<identity::PublicKey>,
+) -> Result<GatewayEndpointConfig, ClientCoreError> {
+    // Get the gateway details of the gateway we will use
+    let gateway = helpers::query_gateway_details(nym_api_endpoints, chosen_gateway_id).await?;
+    log::debug!("Querying gateway gives: {}", gateway);
+
+    let our_identity = key_manager.identity_keypair();
+
+    // Establish connection, authenticate and generate keys for talking with the gateway
+    let shared_keys = helpers::register_with_gateway(&gateway, our_identity).await?;
+    key_manager.insert_gateway_shared_key(shared_keys);
+
+    Ok(gateway.into())
+}
+
+/// Convenience function for setting up the gateway for a client given a `Config`. Depending on the
+/// arguments given it will do the sensible thing. Either it will
+///
+/// a. Reuse existing gateway configuration from storage.
+/// b. Create a new gateway configuration but keep existing keys. This assumes that the caller
+///    knows what they are doing and that the keys match the requested gateway.
+/// c. Create a new gateway configuration with a newly registered gateway and keys.
+pub async fn setup_gateway_from_config<C, T>(
     register_gateway: bool,
-    // TODO: this should get refactored to instead take Option<identity::PublicKey>
-    user_chosen_gateway_id: Option<String>,
+    user_chosen_gateway_id: Option<identity::PublicKey>,
     config: &Config<T>,
 ) -> Result<GatewayEndpointConfig, ClientCoreError>
 where
@@ -73,62 +108,47 @@ where
     T: NymConfig,
 {
     let id = config.get_id();
-    if register_gateway {
-        register_with_gateway(user_chosen_gateway_id, config).await
-    } else if let Some(user_chosen_gateway_id) = user_chosen_gateway_id {
-        config_gateway_with_existing_keys(user_chosen_gateway_id, config).await
-    } else {
-        reuse_existing_gateway_config::<C>(&id)
+
+    // If we are not going to register gateway, and an explicitly chosed gateway is not passed in,
+    // load the existing configuration file
+    if !register_gateway && user_chosen_gateway_id.is_none() {
+        println!("Not registering gateway, will reuse existing config and keys");
+        return load_existing_gateway_config::<C>(&id);
     }
-}
 
-/// Get the gateway details by querying the validator-api. Either pick one at random or use
-/// the chosen one if it's among the available ones.
-/// Saves keys to disk, specified by the paths in `config`.
-pub async fn register_with_gateway<T>(
-    user_chosen_gateway_id: Option<String>,
-    config: &Config<T>,
-) -> Result<GatewayEndpointConfig, ClientCoreError>
-where
-    T: NymConfig,
-{
-    println!("Configuring gateway");
+    // Else, we preceed by querying the nym-api
     let gateway =
-        query_gateway_details(config.get_nym_api_endpoints(), user_chosen_gateway_id).await?;
+        helpers::query_gateway_details(config.get_nym_api_endpoints(), user_chosen_gateway_id)
+            .await?;
     log::debug!("Querying gateway gives: {}", gateway);
 
-    // Registering with gateway by setting up and writing shared keys to disk
-    log::trace!("Registering gateway");
-    register_with_gateway_and_store_keys(gateway.clone(), config).await?;
-    println!("Saved all generated keys");
+    // If we are not registering, just return this and assume the caller has the keys already and
+    // wants to keep the,
+    if !register_gateway && user_chosen_gateway_id.is_some() {
+        println!("Using gateway provided by user, keeping existing keys");
+        return Ok(gateway.into());
+    }
 
-    Ok(gateway.into())
-}
+    // Create new keys and derive our identity
+    let mut key_manager = new_client_keys();
+    let our_identity = key_manager.identity_keypair();
 
-/// Set the gateway using the usual procedue of querying the validator-api, but don't register or
-/// create any keys.
-/// This assumes that the user knows what they are doing, and that the existing keys are valid for
-/// the gateway being used
-pub async fn config_gateway_with_existing_keys<T>(
-    user_chosen_gateway_id: String,
-    config: &Config<T>,
-) -> Result<GatewayEndpointConfig, ClientCoreError>
-where
-    T: NymConfig,
-{
-    println!("Using gateway provided by user, keeping existing keys");
-    let gateway =
-        query_gateway_details(config.get_nym_api_endpoints(), Some(user_chosen_gateway_id)).await?;
-    log::debug!("Querying gateway gives: {}", gateway);
+    // Establish connection, authenticate and generate keys for talking with the gateway
+    println!("Registering with new gateway");
+    let shared_keys = helpers::register_with_gateway(&gateway, our_identity).await?;
+    key_manager.insert_gateway_shared_key(shared_keys);
+
+    // Write all keys to storage and just return the gateway endpoint config. It is assumed that we
+    // will load keys from storage when actually connecting.
+    helpers::store_keys(&key_manager, config)?;
     Ok(gateway.into())
 }
 
 /// Read and reuse the existing gateway configuration from a file that was generate earlier.
-pub fn reuse_existing_gateway_config<T>(id: &str) -> Result<GatewayEndpointConfig, ClientCoreError>
+pub fn load_existing_gateway_config<T>(id: &str) -> Result<GatewayEndpointConfig, ClientCoreError>
 where
     T: NymConfig + ClientCoreConfigTrait,
 {
-    println!("Not registering gateway, will reuse existing config and keys");
     T::load_from_file(Some(id))
         .map(|existing_config| existing_config.get_gateway_endpoint().clone())
         .map_err(|err| {
@@ -143,6 +163,20 @@ where
         })
 }
 
+/// Get the full client address from the client keys and the gateway identity
+pub fn get_client_address(
+    key_manager: &KeyManager,
+    gateway_config: &GatewayEndpointConfig,
+) -> Recipient {
+    Recipient::new(
+        *key_manager.identity_keypair().public_key(),
+        *key_manager.encryption_keypair().public_key(),
+        // TODO: below only works under assumption that gateway address == gateway id
+        // (which currently is true)
+        NodeIdentity::from_base58_string(&gateway_config.gateway_id).unwrap(),
+    )
+}
+
 /// Get the client address by loading the keys from stored files.
 pub fn get_client_address_from_stored_keys<T>(
     config: &Config<T>,
@@ -192,9 +226,9 @@ where
 pub fn output_to_json<T: Serialize>(init_results: &T, output_file: &str) {
     match std::fs::File::create(output_file) {
         Ok(file) => match serde_json::to_writer_pretty(file, init_results) {
-            Ok(_) => println!("Saved: {}", output_file),
-            Err(err) => eprintln!("Could not save {}: {err}", output_file),
+            Ok(_) => println!("Saved: {output_file}"),
+            Err(err) => eprintln!("Could not save {output_file}: {err}"),
         },
-        Err(err) => eprintln!("Could not save {}: {err}", output_file),
+        Err(err) => eprintln!("Could not save {output_file}: {err}"),
     }
 }

clients/credential/Cargo.toml

@@ -13,7 +13,7 @@ rand = "0.7.3"
 serde = { version = "1.0", features = ["derive"] }
 thiserror = "1.0"
 url = "2.2"
-tokio = { version = "1.21.2", features = ["rt-multi-thread", "net", "signal", "macros"] } # async runtime
+tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal", "macros"] } # async runtime
 
 coconut-interface = { path = "../../common/coconut-interface" }
 config = { path = "../../common/config" }

clients/native/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-client"
-version = "1.1.6"
+version = "1.1.5"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>", "Jędrzej Stuczyński <andrew@nymtech.net>"]
 description = "Implementation of the Nym Client"
 edition = "2021"
@@ -30,7 +30,7 @@ serde = { version = "1.0.104", features = ["derive"] } # for config serializatio
 serde_json = "1.0"
 thiserror = "1.0.34"
 tap = "1.0.1"
-tokio = { version = "1.21.2", features = ["rt-multi-thread", "net", "signal"] } # async runtime
+tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal"] } # async runtime
 tokio-tungstenite = "0.14" # websocket
 
 ## internal

clients/native/examples/websocket_binarysend.rs

@@ -85,7 +85,7 @@ async fn send_file_without_reply() {
     let (mut ws_stream, _) = connect_async(uri).await.unwrap();
 
     let recipient = get_self_address(&mut ws_stream).await;
-    println!("our full address is: {}", recipient);
+    println!("our full address is: {recipient}");
 
     let read_data = std::fs::read("examples/dummy_file").unwrap();
 

clients/native/examples/websocket_textsend.rs

@@ -36,7 +36,7 @@ async fn send_text_with_reply() {
     let (mut ws_stream, _) = connect_async(uri).await.unwrap();
 
     let recipient = get_self_address(&mut ws_stream).await;
-    println!("our full address is: {}", recipient);
+    println!("our full address is: {recipient}");
 
     let send_request = json!({
         "type" : "send",
@@ -45,10 +45,7 @@ async fn send_text_with_reply() {
         "withReplySurb": true,
     });
 
-    println!(
-        "sending {:?} (*with* reply SURB) over the mix network...",
-        message
-    );
+    println!("sending {message:?} (*with* reply SURB) over the mix network...");
     let response =
         send_message_and_get_json_response(&mut ws_stream, send_request.to_string()).await;
 
@@ -59,10 +56,7 @@ async fn send_text_with_reply() {
         "replySurb": response["replySurb"]
     });
 
-    println!(
-        "sending {:?} (using reply SURB!) over the mix network...",
-        reply_message
-    );
+    println!("sending {reply_message:?} (using reply SURB!) over the mix network...");
 
     let response =
         send_message_and_get_json_response(&mut ws_stream, reply_request.to_string()).await;
@@ -76,7 +70,7 @@ async fn send_text_without_reply() {
     let (mut ws_stream, _) = connect_async(uri).await.unwrap();
 
     let recipient = get_self_address(&mut ws_stream).await;
-    println!("our full address is: {}", recipient);
+    println!("our full address is: {recipient}");
 
     let send_request = json!({
         "type" : "send",
@@ -85,10 +79,7 @@ async fn send_text_without_reply() {
         "withReplySurb": false,
     });
 
-    println!(
-        "sending {:?} (*without* reply SURB) over the mix network...",
-        message
-    );
+    println!("sending {message:?} (*without* reply SURB) over the mix network...");
     let response =
         send_message_and_get_json_response(&mut ws_stream, send_request.to_string()).await;
 

clients/native/src/client/mod.rs

@@ -8,12 +8,11 @@ use crate::error::ClientError;
 use crate::websocket;
 use client_connections::TransmissionLane;
 use client_core::client::base_client::{
-    non_wasm_helpers, BaseClientBuilder, ClientInput, ClientOutput,
+    non_wasm_helpers, BaseClientBuilder, ClientInput, ClientOutput, ClientState,
 };
 use client_core::client::inbound_messages::InputMessage;
 use client_core::client::key_manager::KeyManager;
 use client_core::client::received_buffer::{ReceivedBufferMessage, ReconstructedMessagesReceiver};
-use client_core::client::replies::reply_controller::requests::ReplyControllerSender;
 use client_core::config::persistence::key_pathfinder::ClientKeyPathfinder;
 use futures::channel::mpsc;
 use gateway_client::bandwidth::BandwidthController;
@@ -87,8 +86,8 @@ impl SocketClient {
         config: &Config,
         client_input: ClientInput,
         client_output: ClientOutput,
+        client_state: ClientState,
         self_address: &Recipient,
-        reply_controller_sender: ReplyControllerSender,
         shutdown: task::TaskClient,
     ) {
         info!("Starting websocket listener...");
@@ -99,10 +98,14 @@ impl SocketClient {
         } = client_input;
 
         let ClientOutput {
-            shared_lane_queue_lengths,
             received_buffer_request_sender,
         } = client_output;
 
+        let ClientState {
+            shared_lane_queue_lengths,
+            reply_controller_sender,
+        } = client_state;
+
         let websocket_handler = websocket::HandlerBuilder::new(
             input_sender,
             connection_command_sender,
@@ -117,16 +120,9 @@ impl SocketClient {
 
     /// blocking version of `start_socket` method. Will run forever (or until SIGINT is sent)
     pub async fn run_socket_forever(self) -> Result<(), Box<dyn Error + Send + Sync>> {
-        let mut shutdown = self.start_socket().await?;
-
-        let res = task::wait_for_signal_and_error(&mut shutdown).await;
-
-        log::info!("Sending shutdown");
-        shutdown.signal_shutdown().ok();
-
-        log::info!("Waiting for tasks to finish... (Press ctrl-c to force)");
-        shutdown.wait_for_shutdown().await;
+        let shutdown = self.start_socket().await?;
 
+        let res = shutdown.catch_interrupt().await;
         log::info!("Stopping nym-client");
         res
     }
@@ -151,13 +147,14 @@ impl SocketClient {
         let mut started_client = base_builder.start_base().await?;
         let client_input = started_client.client_input.register_producer();
         let client_output = started_client.client_output.register_consumer();
+        let client_state = started_client.client_state;
 
         Self::start_websocket_listener(
             &self.config,
             client_input,
             client_output,
+            client_state,
             &self_address,
-            started_client.reply_controller_sender,
             started_client.task_manager.subscribe(),
         );
 

clients/native/src/commands/init.rs

@@ -114,16 +114,15 @@ pub(crate) async fn execute(args: &Init) -> Result<(), ClientError> {
 
     let already_init = Config::default_config_file_path(Some(id)).exists();
     if already_init {
-        println!(
-            "Client \"{}\" was already initialised before! \
-            Config information will be overwritten (but keys will be kept)!",
-            id
-        );
+        println!("Client \"{id}\" was already initialised before");
     }
 
     // Usually you only register with the gateway on the first init, however you can force
     // re-registering if wanted.
     let user_wants_force_register = args.force_register_gateway;
+    if user_wants_force_register {
+        println!("Instructed to force registering gateway. This might overwrite keys!");
+    }
 
     // If the client was already initialized, don't generate new keys and don't re-register with
     // the gateway (because this would create a new shared key).
@@ -138,9 +137,9 @@ pub(crate) async fn execute(args: &Init) -> Result<(), ClientError> {
 
     // Setup gateway by either registering a new one, or creating a new config from the selected
     // one but with keys kept, or reusing the gateway configuration.
-    let gateway = client_core::init::setup_gateway::<Config, _>(
+    let gateway = client_core::init::setup_gateway_from_config::<Config, _>(
         register_gateway,
-        user_chosen_gateway_id.map(|id| id.to_base58_string()),
+        user_chosen_gateway_id,
         config.get_base(),
     )
     .await
@@ -169,7 +168,7 @@ pub(crate) async fn execute(args: &Init) -> Result<(), ClientError> {
 
 fn print_saved_config(config: &Config) {
     let config_save_location = config.get_config_file_save_location();
-    println!("Saved configuration file to {:?}", config_save_location);
+    println!("Saved configuration file to {config_save_location:?}");
     println!("Using gateway: {}", config.get_base().get_gateway_id());
     log::debug!("Gateway id: {}", config.get_base().get_gateway_id());
     log::debug!("Gateway owner: {}", config.get_base().get_gateway_owner());

clients/native/src/commands/upgrade.rs

@@ -17,36 +17,26 @@ fn fail_upgrade<D1: Display, D2: Display>(from_version: D1, to_version: D2) -> !
 }
 
 fn print_start_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
-    println!(
-        "\n==================\nTrying to upgrade client from {} to {} ...",
-        from, to
-    );
+    println!("\n==================\nTrying to upgrade client from {from} to {to} ...");
 }
 
 fn print_failed_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
-    eprintln!(
-        "Upgrade from {} to {} failed!\n==================\n",
-        from, to
-    );
+    eprintln!("Upgrade from {from} to {to} failed!\n==================\n");
 }
 
 fn print_successful_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
-    println!(
-        "Upgrade from {} to {} was successful!\n==================\n",
-        from, to
-    );
+    println!("Upgrade from {from} to {to} was successful!\n==================\n");
 }
 
 fn outdated_upgrade(config_version: &Version, package_version: &Version) -> ! {
     eprintln!(
-        "Cannot perform upgrade from {} to {}. Your version is too old to perform the upgrade.!",
-        config_version, package_version
+        "Cannot perform upgrade from {config_version} to {package_version}. Your version is too old to perform the upgrade.!"
     );
     process::exit(1)
 }
 
 fn unsupported_upgrade(current_version: &Version, config_version: &Version) -> ! {
-    eprintln!("Cannot perform upgrade from {} to {}. Please let the developers know about this issue if you expected it to work!", config_version, current_version);
+    eprintln!("Cannot perform upgrade from {config_version} to {current_version}. Please let the developers know about this issue if you expected it to work!");
     process::exit(1)
 }
 
@@ -65,8 +55,7 @@ fn parse_config_version(config: &Config) -> Version {
 
     if version.is_prerelease() || !version.build.is_empty() {
         eprintln!(
-            "Trying to upgrade from a non-released version {}. This is not supported!",
-            version
+            "Trying to upgrade from a non-released version {version}. This is not supported!"
         );
         process::exit(1)
     }
@@ -81,10 +70,7 @@ fn parse_package_version() -> Version {
     // however, we are not using them ourselves at the moment and hence it should be fine.
     // if we change our mind, we could easily tweak this code
     if version.is_prerelease() || !version.build.is_empty() {
-        eprintln!(
-            "Trying to upgrade to a non-released version {}. This is not supported!",
-            version
-        );
+        eprintln!("Trying to upgrade to a non-released version {version}. This is not supported!");
         process::exit(1)
     }
 

clients/native/src/main.rs

@@ -3,7 +3,7 @@
 
 use std::error::Error;
 
-use clap::{crate_version, Parser};
+use clap::{crate_name, crate_version, Parser};
 use logging::setup_logging;
 use network_defaults::setup_env;
 
@@ -15,26 +15,9 @@ pub mod websocket;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     setup_logging();
-    println!("{}", banner());
+    println!("{}", logging::banner(crate_name!(), crate_version!()));
 
     let args = commands::Cli::parse();
     setup_env(args.config_env_file.as_ref());
     commands::execute(&args).await
 }
-
-fn banner() -> String {
-    format!(
-        r#"
-
-      _ __  _   _ _ __ ___
-     | '_ \| | | | '_ \ _ \
-     | | | | |_| | | | | | |
-     |_| |_|\__, |_| |_| |_|
-            |___/
-
-             (client - version {:})
-
-    "#,
-        crate_version!()
-    )
-}

clients/native/src/websocket/handler.rs

@@ -27,17 +27,13 @@ use tokio_tungstenite::{
 };
 use websocket_requests::{requests::ClientRequest, responses::ServerResponse};
 
+#[derive(Default)]
 enum ReceivedResponseType {
+    #[default]
     Binary,
     Text,
 }
 
-impl Default for ReceivedResponseType {
-    fn default() -> Self {
-        ReceivedResponseType::Binary
-    }
-}
-
 pub(crate) struct HandlerBuilder {
     msg_input: InputMessageSender,
     client_connection_tx: ConnectionCommandSender,

clients/native/websocket-requests/src/error.rs

@@ -84,7 +84,7 @@ impl TryFrom<u8> for ErrorKind {
 
             n => Err(Error::new(
                 ErrorKind::MalformedResponse,
-                format!("invalid error code {}", n),
+                format!("invalid error code {n}"),
             )),
         }
     }

clients/socks5/Cargo.toml

@@ -23,7 +23,7 @@ serde = { version = "1.0", features = ["derive"] } # for config serialization/de
 serde_json = "1.0.89"
 tap = "1.0.1"
 thiserror = "1.0.34"
-tokio = { version = "1.21.2", features = ["rt-multi-thread", "net", "signal"] }
+tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal"] }
 url = "2.2"
 
 # internal

clients/socks5/src/client/mod.rs

@@ -9,7 +9,7 @@ use crate::socks::{
     server::SphinxSocksServer,
 };
 use client_core::client::base_client::{
-    non_wasm_helpers, BaseClientBuilder, ClientInput, ClientOutput,
+    non_wasm_helpers, BaseClientBuilder, ClientInput, ClientOutput, ClientState,
 };
 use client_core::client::key_manager::KeyManager;
 use client_core::config::persistence::key_pathfinder::ClientKeyPathfinder;
@@ -19,7 +19,7 @@ use gateway_client::bandwidth::BandwidthController;
 use log::*;
 use nymsphinx::addressing::clients::Recipient;
 use std::error::Error;
-use task::{wait_for_signal_and_error, TaskClient, TaskManager};
+use task::{TaskClient, TaskManager};
 
 pub mod config;
 
@@ -95,6 +95,7 @@ impl NymClient {
         config: &Config,
         client_input: ClientInput,
         client_output: ClientOutput,
+        client_status: ClientState,
         self_address: Recipient,
         shutdown: TaskClient,
     ) {
@@ -108,10 +109,14 @@ impl NymClient {
         } = client_input;
 
         let ClientOutput {
-            shared_lane_queue_lengths,
             received_buffer_request_sender,
         } = client_output;
 
+        let ClientState {
+            shared_lane_queue_lengths,
+            reply_controller_sender: _,
+        } = client_status;
+
         let authenticator = Authenticator::new(auth_methods, allowed_users);
         let mut sphinx_socks = SphinxSocksServer::new(
             config.get_listening_port(),
@@ -142,16 +147,9 @@ impl NymClient {
 
     /// blocking version of `start` method. Will run forever (or until SIGINT is sent)
     pub async fn run_forever(self) -> Result<(), Box<dyn Error + Send + Sync>> {
-        let mut shutdown = self.start().await?;
-
-        let res = wait_for_signal_and_error(&mut shutdown).await;
-
-        log::info!("Sending shutdown");
-        shutdown.signal_shutdown().ok();
-
-        log::info!("Waiting for tasks to finish... (Press ctrl-c to force)");
-        shutdown.wait_for_shutdown().await;
+        let shutdown = self.start().await?;
 
+        let res = shutdown.catch_interrupt().await;
         log::info!("Stopping nym-socks5-client");
         res
     }
@@ -218,11 +216,13 @@ impl NymClient {
         let mut started_client = base_builder.start_base().await?;
         let client_input = started_client.client_input.register_producer();
         let client_output = started_client.client_output.register_consumer();
+        let client_state = started_client.client_state;
 
         Self::start_socks5_listener(
             &self.config,
             client_input,
             client_output,
+            client_state,
             self_address,
             started_client.task_manager.subscribe(),
         );

clients/socks5/src/commands/init.rs

@@ -124,16 +124,15 @@ pub(crate) async fn execute(args: &Init) -> Result<(), Socks5ClientError> {
 
     let already_init = Config::default_config_file_path(Some(id)).exists();
     if already_init {
-        println!(
-            "SOCKS5 client \"{}\" was already initialised before! \
-            Config information will be overwritten (but keys will be kept)!",
-            id
-        );
+        println!("SOCKS5 client \"{id}\" was already initialised before");
     }
 
     // Usually you only register with the gateway on the first init, however you can force
     // re-registering if wanted.
     let user_wants_force_register = args.force_register_gateway;
+    if user_wants_force_register {
+        println!("Instructed to force registering gateway. This might overwrite keys!");
+    }
 
     // If the client was already initialized, don't generate new keys and don't re-register with
     // the gateway (because this would create a new shared key).
@@ -151,9 +150,9 @@ pub(crate) async fn execute(args: &Init) -> Result<(), Socks5ClientError> {
 
     // Setup gateway by either registering a new one, or creating a new config from the selected
     // one but with keys kept, or reusing the gateway configuration.
-    let gateway = client_core::init::setup_gateway::<Config, _>(
+    let gateway = client_core::init::setup_gateway_from_config::<Config, _>(
         register_gateway,
-        user_chosen_gateway_id.map(|id| id.to_base58_string()),
+        user_chosen_gateway_id,
         config.get_base(),
     )
     .await

clients/socks5/src/main.rs

@@ -3,7 +3,7 @@
 
 use std::error::Error;
 
-use clap::{crate_version, Parser};
+use clap::{crate_name, crate_version, Parser};
 use logging::setup_logging;
 use network_defaults::setup_env;
 
@@ -15,26 +15,9 @@ pub mod socks;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     setup_logging();
-    println!("{}", banner());
+    println!("{}", logging::banner(crate_name!(), crate_version!()));
 
     let args = commands::Cli::parse();
     setup_env(args.config_env_file.as_ref());
     commands::execute(&args).await
 }
-
-fn banner() -> String {
-    format!(
-        r#"
-
-      _ __  _   _ _ __ ___
-     | '_ \| | | | '_ \ _ \
-     | | | | |_| | | | | | |
-     |_| |_|\__, |_| |_| |_|
-            |___/
-
-             (socks5 proxy - version {:})
-
-    "#,
-        crate_version!()
-    )
-}

clients/socks5/src/socks/mixnet_responses.rs

@@ -1,5 +1,3 @@
-use std::time::Duration;
-
 use futures::channel::mpsc;
 use futures::StreamExt;
 use log::*;
@@ -116,10 +114,7 @@ impl MixnetResponseListener {
                 }
             }
         }
-        #[cfg(not(target_arch = "wasm32"))]
-        tokio::time::timeout(Duration::from_secs(5), self.shutdown.recv())
-            .await
-            .expect("Task stopped without shutdown called");
+        self.shutdown.recv_timeout().await;
         log::debug!("MixnetResponseListener: Exiting");
     }
 }

clients/webassembly/Cargo.toml

@@ -22,8 +22,10 @@ futures = "0.3"
 js-sys = "0.3"
 rand = { version = "0.7.3", features = ["wasm-bindgen"] }
 serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+anyhow = "1.0"
 serde-wasm-bindgen = "0.4"
-tokio = { version = "1.21.2", features = ["sync"] }
+tokio = { version = "1.24.1", features = ["sync"] }
 url = "2.2"
 wasm-bindgen = { version = "=0.2.83", features = ["serde-serialize"]  }
 wasm-bindgen-futures = "0.4"

clients/webassembly/README.md

@@ -16,11 +16,7 @@ They should be implemented soon. You can build your applications, but don't rely
 
 ## Using it
 
-See the [Nym docs](https://nymtech.net/docs).
-
-### Demo
-
-There's a demo web application in the `js-example` folder. To run it, first make sure you've got a recent `npm` installed, then follow the instructions in its README.
+See the [SDK directory](../../sdk/typescript/examples) for examples on how to use it and the NPM packages available.
 
 ## Developing
 
@@ -36,8 +32,13 @@ To be clear, this is not something that most JS developers need to worry about,
 
 ### Packaging
 
-If you're a Nym platform developer who's made changes to the Rust (or JS) files and wants to re-publish the package to NPM, here's how you do it: 
+If you're a Nym platform developer who's made changes to the Rust files and wants to re-publish the package to NPM, here's how you do it: 
 
 1. bump version numbers as necessary for SemVer
-2. `wasm-pack build --scope nymproject` builds the wasm binaries into the `pkg` directory (not in source control)
-3. `cd pkg && npm publish --access=public` will publish your changed package to NPM
+2. go the `sdk/typescript` directory (off the project root)
+3. run:
+```
+yarn
+yarn build
+yarn publish
+```

clients/webassembly/js-example/.bin/create-wasm-app.js

@@ -1,24 +0,0 @@
-#!/usr/bin/env node
-
-const { spawn } = require("child_process");
-const fs = require("fs");
-
-let folderName = '.';
-
-if (process.argv.length >= 3) {
-  folderName = process.argv[2];
-  if (!fs.existsSync(folderName)) {
-    fs.mkdirSync(folderName);
-  }
-}
-
-const clone = spawn("git", ["clone", "https://github.com/rustwasm/create-wasm-app.git", folderName]);
-
-clone.on("close", code => {
-  if (code !== 0) {
-    console.error("cloning the template failed!")
-    process.exit(code);
-  } else {
-    console.log("🦀 Rust + 🕸 Wasm = ❤");
-  }
-});

clients/webassembly/js-example/.gitignore

@@ -1,2 +0,0 @@
-node_modules
-dist

clients/webassembly/js-example/.travis.yml

@@ -1,5 +0,0 @@
-language: node_js
-node_js: "10"
-
-script:
-  - ./node_modules/.bin/webpack

clients/webassembly/js-example/LICENSE-APACHE

@@ -1,201 +0,0 @@
-                              Apache License
-                        Version 2.0, January 2004
-                     http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-   "License" shall mean the terms and conditions for use, reproduction,
-   and distribution as defined by Sections 1 through 9 of this document.
-
-   "Licensor" shall mean the copyright owner or entity authorized by
-   the copyright owner that is granting the License.
-
-   "Legal Entity" shall mean the union of the acting entity and all
-   other entities that control, are controlled by, or are under common
-   control with that entity. For the purposes of this definition,
-   "control" means (i) the power, direct or indirect, to cause the
-   direction or management of such entity, whether by contract or
-   otherwise, or (ii) ownership of fifty percent (50%) or more of the
-   outstanding shares, or (iii) beneficial ownership of such entity.
-
-   "You" (or "Your") shall mean an individual or Legal Entity
-   exercising permissions granted by this License.
-
-   "Source" form shall mean the preferred form for making modifications,
-   including but not limited to software source code, documentation
-   source, and configuration files.
-
-   "Object" form shall mean any form resulting from mechanical
-   transformation or translation of a Source form, including but
-   not limited to compiled object code, generated documentation,
-   and conversions to other media types.
-
-   "Work" shall mean the work of authorship, whether in Source or
-   Object form, made available under the License, as indicated by a
-   copyright notice that is included in or attached to the work
-   (an example is provided in the Appendix below).
-
-   "Derivative Works" shall mean any work, whether in Source or Object
-   form, that is based on (or derived from) the Work and for which the
-   editorial revisions, annotations, elaborations, or other modifications
-   represent, as a whole, an original work of authorship. For the purposes
-   of this License, Derivative Works shall not include works that remain
-   separable from, or merely link (or bind by name) to the interfaces of,
-   the Work and Derivative Works thereof.
-
-   "Contribution" shall mean any work of authorship, including
-   the original version of the Work and any modifications or additions
-   to that Work or Derivative Works thereof, that is intentionally
-   submitted to Licensor for inclusion in the Work by the copyright owner
-   or by an individual or Legal Entity authorized to submit on behalf of
-   the copyright owner. For the purposes of this definition, "submitted"
-   means any form of electronic, verbal, or written communication sent
-   to the Licensor or its representatives, including but not limited to
-   communication on electronic mailing lists, source code control systems,
-   and issue tracking systems that are managed by, or on behalf of, the
-   Licensor for the purpose of discussing and improving the Work, but
-   excluding communication that is conspicuously marked or otherwise
-   designated in writing by the copyright owner as "Not a Contribution."
-
-   "Contributor" shall mean Licensor and any individual or Legal Entity
-   on behalf of whom a Contribution has been received by Licensor and
-   subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   copyright license to reproduce, prepare Derivative Works of,
-   publicly display, publicly perform, sublicense, and distribute the
-   Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   (except as stated in this section) patent license to make, have made,
-   use, offer to sell, sell, import, and otherwise transfer the Work,
-   where such license applies only to those patent claims licensable
-   by such Contributor that are necessarily infringed by their
-   Contribution(s) alone or by combination of their Contribution(s)
-   with the Work to which such Contribution(s) was submitted. If You
-   institute patent litigation against any entity (including a
-   cross-claim or counterclaim in a lawsuit) alleging that the Work
-   or a Contribution incorporated within the Work constitutes direct
-   or contributory patent infringement, then any patent licenses
-   granted to You under this License for that Work shall terminate
-   as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-   Work or Derivative Works thereof in any medium, with or without
-   modifications, and in Source or Object form, provided that You
-   meet the following conditions:
-
-   (a) You must give any other recipients of the Work or
-       Derivative Works a copy of this License; and
-
-   (b) You must cause any modified files to carry prominent notices
-       stating that You changed the files; and
-
-   (c) You must retain, in the Source form of any Derivative Works
-       that You distribute, all copyright, patent, trademark, and
-       attribution notices from the Source form of the Work,
-       excluding those notices that do not pertain to any part of
-       the Derivative Works; and
-
-   (d) If the Work includes a "NOTICE" text file as part of its
-       distribution, then any Derivative Works that You distribute must
-       include a readable copy of the attribution notices contained
-       within such NOTICE file, excluding those notices that do not
-       pertain to any part of the Derivative Works, in at least one
-       of the following places: within a NOTICE text file distributed
-       as part of the Derivative Works; within the Source form or
-       documentation, if provided along with the Derivative Works; or,
-       within a display generated by the Derivative Works, if and
-       wherever such third-party notices normally appear. The contents
-       of the NOTICE file are for informational purposes only and
-       do not modify the License. You may add Your own attribution
-       notices within Derivative Works that You distribute, alongside
-       or as an addendum to the NOTICE text from the Work, provided
-       that such additional attribution notices cannot be construed
-       as modifying the License.
-
-   You may add Your own copyright statement to Your modifications and
-   may provide additional or different license terms and conditions
-   for use, reproduction, or distribution of Your modifications, or
-   for any such Derivative Works as a whole, provided Your use,
-   reproduction, and distribution of the Work otherwise complies with
-   the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-   any Contribution intentionally submitted for inclusion in the Work
-   by You to the Licensor shall be under the terms and conditions of
-   this License, without any additional terms or conditions.
-   Notwithstanding the above, nothing herein shall supersede or modify
-   the terms of any separate license agreement you may have executed
-   with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-   names, trademarks, service marks, or product names of the Licensor,
-   except as required for reasonable and customary use in describing the
-   origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-   agreed to in writing, Licensor provides the Work (and each
-   Contributor provides its Contributions) on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-   implied, including, without limitation, any warranties or conditions
-   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-   PARTICULAR PURPOSE. You are solely responsible for determining the
-   appropriateness of using or redistributing the Work and assume any
-   risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-   whether in tort (including negligence), contract, or otherwise,
-   unless required by applicable law (such as deliberate and grossly
-   negligent acts) or agreed to in writing, shall any Contributor be
-   liable to You for damages, including any direct, indirect, special,
-   incidental, or consequential damages of any character arising as a
-   result of this License or out of the use or inability to use the
-   Work (including but not limited to damages for loss of goodwill,
-   work stoppage, computer failure or malfunction, or any and all
-   other commercial damages or losses), even if such Contributor
-   has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-   the Work or Derivative Works thereof, You may choose to offer,
-   and charge a fee for, acceptance of support, warranty, indemnity,
-   or other liability obligations and/or rights consistent with this
-   License. However, in accepting such obligations, You may act only
-   on Your own behalf and on Your sole responsibility, not on behalf
-   of any other Contributor, and only if You agree to indemnify,
-   defend, and hold each Contributor harmless for any liability
-   incurred by, or claims asserted against, such Contributor by reason
-   of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-   To apply the Apache License to your work, attach the following
-   boilerplate notice, with the fields enclosed by brackets "[]"
-   replaced with your own identifying information. (Don't include
-   the brackets!)  The text should be enclosed in the appropriate
-   comment syntax for the file format. We also recommend that a
-   file or class name and description of purpose be included on the
-   same "printed page" as the copyright notice for easier
-   identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

clients/webassembly/js-example/README.md

@@ -1,28 +0,0 @@
-# Nym Sphinx Wasm Demo
-
-This example application demonstrates how to use WebAssembly to create Sphinx packets, in the browser, and forward them to a Nym gateway.
-
-## 🚴 Usage
-
-Build the WASM package for bundling:
-
-```
-wasm-pack build --scope nymproject --target no-modules
-```
-
-in the `clients/webassembly` directory (one up).
-
-Start the webpack dev server:
-
-```
-npm install         # set up dependencies
-npm run start       # starts a web server at http://localhost:8001
-```
-
-Check your dev console for output.
-
-### Rebuild after Rust source changes
-
-Install `wasm-pack`. Instruction are at the [Rust WASM tutorial](https://rustwasm.github.io/docs/book/game-of-life/hello-world.html). 
-
-`wasm-pack build --scope nymproject --target no-modules` in the `clients/webassembly` directory (one up) will rebuild the wasm package if you make changes to the Rust source. That will be automatically picked up (and reloaded, if need be) by the npm dev server.

clients/webassembly/js-example/bootstrap.js

@@ -1,5 +0,0 @@
-// A dependency graph that contains any wasm must all be imported
-// asynchronously. This `bootstrap.js` file does the single async import, so
-// that no one else needs to worry about it again.
-import('./index.js')
-  .catch(e => console.error('Error importing `index.js`:', e));

clients/webassembly/js-example/index.html

@@ -1,36 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Nym WebAssembly Demo</title>
-</head>
-
-<body>
-  <p>
-    <label>Sender: </label><input disabled="true" size="85" type="text" id="sender" value="">
-  </p>
-
-  <p>
-    <label>Recipient: </label><input size="85" type="text" id="recipient" value="">
-  </p>
-  <p>
-    <label>Message: </label><input type="text" id="message" value="Hello mixnet!">
-  </p>
-  <p>
-    <button id="send-button">Send</button>
-  </p>
-
-  <p>Send messages from your browser, through the mixnet, and to the recipient using the "send" button.</p>
-  <p><span style='color: blue;'>Sent</span> messages show in blue, <span style='color: green;'>received</span>
-    messages show in green.</p>
-
-  <hr>
-  <p>
-    <span id="output"></div>
-  </p>
-  <script src="./bootstrap.js"></script>
-</body>
-
-</html>

clients/webassembly/js-example/index.js

@@ -1,128 +0,0 @@
-// Copyright 2020-2022 Nym Technologies SA
-// 
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-// 
-//     http://www.apache.org/licenses/LICENSE-2.0
-// 
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-class WebWorkerClient {
-  worker = null;
-
-  constructor() {
-    this.worker = new Worker('./worker.js');
-
-    this.worker.onmessage = (ev) => {
-      if (ev.data && ev.data.kind) {
-        switch (ev.data.kind) {
-          case 'Ready':
-            const { selfAddress } = ev.data.args;
-            displaySenderAddress(selfAddress);
-            break;
-          case 'ReceiveMessage':
-            const { message } = ev.data.args;
-            displayReceived(message);
-            break;
-        }
-      }
-    };
-  }
-
-  sendMessage = (message, recipient) => {
-    if (!this.worker) {
-      console.error('Could not send message because worker does not exist');
-      return;
-    }
-
-    this.worker.postMessage({
-      kind: 'SendMessage',
-      args: {
-        message, recipient,
-      },
-    });
-  };
-}
-
-let client = null;
-
-async function main() {
-  client = new WebWorkerClient();
-
-  const sendButton = document.querySelector('#send-button');
-  sendButton.onclick = function() {
-    sendMessageTo();
-  };
-}
-
-/**
- * Create a Sphinx packet and send it to the mixnet through the gateway node.
- *
- * Message and recipient are taken from the values in the user interface.
- *
- */
-async function sendMessageTo() {
-  const message = document.getElementById('message').value;
-  const recipient = document.getElementById('recipient').value;
-
-  await client.sendMessage(message, recipient);
-  displaySend(message);
-}
-
-/**
- * Display messages that have been sent up the websocket. Colours them blue.
- *
- * @param {string} message
- */
-function displaySend(message) {
-  let timestamp = new Date().toISOString().substr(11, 12);
-
-  let sendDiv = document.createElement('div');
-  let paragraph = document.createElement('p');
-  paragraph.setAttribute('style', 'color: blue');
-  let paragraphContent = document.createTextNode(timestamp + ' sent >>> ' + message);
-  paragraph.appendChild(paragraphContent);
-
-  sendDiv.appendChild(paragraph);
-  document.getElementById('output').appendChild(sendDiv);
-}
-
-/**
- * Display received text messages in the browser. Colour them green.
- *
- * @param {Uint8Array} raw
- */
-function displayReceived(raw, sender_tag) {
-  const content = new TextDecoder().decode(raw);
-  if (sender_tag !== undefined) {
-    console.log("this message also contained some surbs from", sender_tag)
-  }
-
-  let timestamp = new Date().toISOString().substr(11, 12);
-  let receivedDiv = document.createElement('div');
-  let paragraph = document.createElement('p');
-  paragraph.setAttribute('style', 'color: green');
-  let paragraphContent = document.createTextNode(timestamp + ' received >>> ' + content);
-  // let paragraphContent = document.createTextNode(timestamp + " received >>> " + content + ((replySurb != null) ? "Reply SURB was attached here (but we can't do anything with it yet" : " (NO REPLY-SURB AVAILABLE)"))
-  paragraph.appendChild(paragraphContent);
-  receivedDiv.appendChild(paragraph);
-  document.getElementById('output').appendChild(receivedDiv);
-}
-
-
-/**
- * Display the nymClient's sender address in the user interface
- *
- * @param {String} address
- */
-function displaySenderAddress(address) {
-  document.getElementById('sender').value = address;
-}
-
-// Let's get started!
-main();

clients/webassembly/js-example/package.json

@@ -1,39 +0,0 @@
-{
-  "name": "create-wasm-app",
-  "version": "0.1.0",
-  "description": "create an app to consume rust-generated wasm packages",
-  "main": "index.js",
-  "bin": {
-    "create-wasm-app": ".bin/create-wasm-app.js"
-  },
-  "scripts": {
-    "build": "webpack --config webpack.config.js",
-    "start": "webpack-dev-server --port 8001"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/rustwasm/create-wasm-app.git"
-  },
-  "keywords": [
-    "webassembly",
-    "wasm",
-    "rust",
-    "webpack"
-  ],
-  "author": "Dave Hrycyszyn <futurechimp@users.noreply.github.com>",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/nymtech/nym/issues"
-  },
-  "homepage": "https://nymtech.net/docs",
-  "devDependencies": {
-    "copy-webpack-plugin": "^10.2.4",
-    "hello-wasm-pack": "^0.1.0",
-    "webpack": "^5.70.0",
-    "webpack-cli": "^4.9.2",
-    "webpack-dev-server": "^4.7.4"
-  },
-  "dependencies": {
-    "@nymproject/nym-client-wasm": "file:../pkg"
-  }
-}

clients/webassembly/js-example/webpack.config.js

@@ -1,33 +0,0 @@
-const CopyWebpackPlugin = require('copy-webpack-plugin');
-const path = require('path');
-
-module.exports = {
-  performance: {
-    hints: false,
-    maxEntrypointSize: 512000,
-    maxAssetSize: 512000
-  },
-  entry: {
-    bootstrap: './bootstrap.js',
-    worker: './worker.js',
-  },
-  output: {
-    path: path.resolve(__dirname, 'dist'),
-    filename: '[name].js',
-  },
-  // mode: 'development',
-  mode: 'production',
-  plugins: [
-    new CopyWebpackPlugin({
-      patterns: [
-        'index.html',
-        {
-          from: 'node_modules/@nymproject/nym-client-wasm/*.(js|wasm)',
-          to: '[name][ext]',
-        },
-      ],
-    }),
-
-  ],
-  experiments: { syncWebAssembly: true },
-};

clients/webassembly/js-example/worker.js

@@ -1,101 +0,0 @@
-// Copyright 2020-2022 Nym Technologies SA
-// 
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-// 
-//     http://www.apache.org/licenses/LICENSE-2.0
-// 
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-importScripts('nym_client_wasm.js');
-
-console.log('Initializing worker');
-
-// wasm_bindgen creates a global variable (with the exports attached) that is in scope after `importScripts`
-const { default_debug, NymClientBuilder, set_panic_hook, Config, GatewayEndpointConfig } = wasm_bindgen;
-
-let client = null;
-
-async function main() {
-  // load WASM package
-  await wasm_bindgen('nym_client_wasm_bg.wasm');
-
-  console.log('Loaded WASM');
-
-  // sets up better stack traces in case of in-rust panics
-  set_panic_hook();
-
-  // validator server we will use to get topology from
-  const validator = 'https://qwerty-validator-api.qa.nymte.ch/api';
-  
-  const gatewayId = 'EVupP2tRUeZo5Y6RpBHAbm8kSntpgNyZNL6yCr7BDEoG';
-  const gatewayOwner = 'n1rmlew3euapuq7rs4s4j9apv00whrsazr764kl7';
-  const gatewayListener = 'ws://176.58.120.72:9000';
-  const gatewayEndpoint = new GatewayEndpointConfig(gatewayId, gatewayOwner, gatewayListener)
-
-  // only really useful if you want to adjust some settings like traffic rate
-  // (if not needed you can just pass a null)
-  const debug = default_debug();
-
-  debug.disable_main_poisson_packet_distribution = true;
-  debug.disable_loop_cover_traffic_stream = true;
-  debug.use_extended_packet_size = true;
-  // debug.average_packet_delay_ms = BigInt(10);
-  // debug.average_ack_delay_ms = BigInt(10);
-  // debug.ack_wait_addition_ms = BigInt(3000);
-  // debug.ack_wait_multiplier = 10;
-
-  debug.topology_refresh_rate_ms = BigInt(60000)
-
-  const config = new Config('my-awesome-wasm-client', validator, gatewayEndpoint, debug);
-
-  const onMessageHandler = (message) => {
-    self.postMessage({
-      kind: 'ReceiveMessage',
-      args: {
-        message,
-      },
-    });
-  };
-
-  console.log('Instantiating WASM client...');
-  
-  let clientBuilder = new NymClientBuilder(config, onMessageHandler)
-  console.log('Web worker creating WASM client...');
-  let local_client = await clientBuilder.start_client();
-  console.log('WASM client running!');
-  
-  const selfAddress = local_client.self_address();
-  
-  // set the global (I guess we don't have to anymore?)
-  client = local_client;
-  
-  console.log(`Client address is ${selfAddress}`);
-  self.postMessage({
-    kind: 'Ready',
-    args: {
-      selfAddress,
-    },
-  });
-
-  // Set callback to handle messages passed to the worker.
-  self.onmessage = async event => {
-    if (event.data && event.data.kind) {
-      switch (event.data.kind) {
-        case 'SendMessage': {
-          const { message, recipient } = event.data.args;
-          let uint8Array = new TextEncoder().encode(message);
-          await client.send_regular_message(uint8Array, recipient);
-        }
-      }
-    }
-  };
-}
-
-// Let's get started!
-main();

clients/webassembly/src/binary_message_helper.rs

@@ -1,217 +0,0 @@
-// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use serde::{Deserialize, Serialize};
-use wasm_bindgen::prelude::*;
-use wasm_bindgen::JsCast;
-
-#[wasm_bindgen(typescript_custom_section)]
-const TS_DEFS: &'static str = r#"
-export interface BinaryMessage {
-    kind: number,
-    payload: Uint8Array;
-    headers: string,
-}
-
-export interface StringMessage {
-    kind: number,
-    payload: string;
-}
-"#;
-
-#[wasm_bindgen]
-extern "C" {
-    #[wasm_bindgen(typescript_type = "BinaryMessage")]
-    pub type IBinaryMessage;
-    #[wasm_bindgen(typescript_type = "StringMessage")]
-    pub type IStringMessage;
-}
-
-#[derive(Serialize, Deserialize)]
-pub struct BinaryMessage {
-    pub kind: u8,
-    pub payload: Vec<u8>,
-    pub headers: String,
-}
-
-#[derive(Serialize, Deserialize)]
-pub struct StringMessage {
-    pub kind: u8,
-    pub payload: String,
-}
-
-/// Create a new binary message with a user-specified `kind`.
-#[wasm_bindgen]
-pub fn create_binary_message(kind: u8, payload: Vec<u8>) -> Vec<u8> {
-    create_binary_message_with_headers(kind, payload, "".to_string())
-}
-
-/// Create a new message with a UTF-8 encoded string `payload` and a user-specified `kind`.
-#[wasm_bindgen]
-pub fn create_binary_message_from_string(kind: u8, payload: String) -> Vec<u8> {
-    create_binary_message_with_headers(kind, payload.as_bytes().to_vec(), "".to_string())
-}
-
-/// Create a new binary message with a user-specified `kind`, and `headers` as a string.
-#[wasm_bindgen]
-pub fn create_binary_message_with_headers(kind: u8, payload: Vec<u8>, headers: String) -> Vec<u8> {
-    let headers = headers.as_bytes().to_vec();
-    let size = (headers.len() as u64).to_be_bytes().to_vec();
-    vec![vec![kind], size, headers, payload].concat()
-}
-
-/// Parse the `kind` and byte array `payload` from a byte array
-#[wasm_bindgen]
-pub async fn parse_binary_message(message: Vec<u8>) -> Result<IBinaryMessage, JsError> {
-    if message.len() < 2 {
-        return Err(JsError::new(
-            "Could not parse message, as less than 2 bytes long",
-        ));
-    }
-
-    let (kind, _headers, payload) = parse_binary_payload(&message);
-
-    Ok(serde_wasm_bindgen::to_value(&BinaryMessage {
-        kind,
-        payload: payload.to_vec(),
-        headers: "".to_string(),
-    })
-    .unwrap()
-    .unchecked_into::<IBinaryMessage>())
-}
-
-/// Parse the `kind` and byte array `payload` from a byte array with headers
-#[wasm_bindgen]
-pub async fn parse_binary_message_with_headers(
-    message: Vec<u8>,
-) -> Result<IBinaryMessage, JsError> {
-    if message.len() < 2 {
-        return Err(JsError::new(
-            "Could not parse message, as less than 2 bytes long",
-        ));
-    }
-
-    let (kind, headers, payload) = parse_binary_payload(&message);
-
-    Ok(serde_wasm_bindgen::to_value(&BinaryMessage {
-        kind,
-        payload: payload.to_vec(),
-        headers,
-    })
-    .unwrap()
-    .unchecked_into::<IBinaryMessage>())
-}
-
-/// Parse the `kind` and UTF-8 string `payload` from a byte array with headers
-#[wasm_bindgen]
-pub async fn parse_string_message_with_headers(
-    message: Vec<u8>,
-) -> Result<IStringMessage, JsError> {
-    if message.len() < 2 {
-        return Err(JsError::new(
-            "Could not parse message, as less than 2 bytes long",
-        ));
-    }
-
-    let (kind, _headers, payload) = parse_binary_payload(&message);
-    let payload = String::from_utf8_lossy(payload).into_owned();
-
-    Ok(
-        serde_wasm_bindgen::to_value(&StringMessage { kind, payload })
-            .unwrap()
-            .unchecked_into::<IStringMessage>(),
-    )
-}
-pub(crate) fn parse_binary_payload(message: &[u8]) -> (u8, String, &[u8]) {
-    // 1st byte is the kind
-    let kind = message[0];
-
-    // then the size as u64 big endian
-    let mut size = [0u8; 8];
-    size.clone_from_slice(&message[1..9]);
-    let size = u64::from_be_bytes(size) as usize;
-
-    // then the headers
-    let headers = String::from_utf8_lossy(&message[9..9 + size]).into_owned();
-
-    // finally the payload
-    let payload = &message[9 + size..];
-
-    (kind, headers, payload)
-}
-
-/// Parse the `kind` and UTF-8 string `payload` from a byte array
-#[wasm_bindgen]
-pub async fn parse_string_message(message: Vec<u8>) -> Result<IStringMessage, JsError> {
-    if message.len() < 2 {
-        return Err(JsError::new(
-            "Could not parse message, as less than 2 bytes long",
-        ));
-    }
-
-    let kind = message[0];
-    let payload = String::from_utf8_lossy(&message[1..]).into_owned();
-
-    Ok(
-        serde_wasm_bindgen::to_value(&StringMessage { kind, payload })
-            .unwrap()
-            .unchecked_into::<IStringMessage>(),
-    )
-}
-
-#[cfg(test)]
-mod tests {
-    use super::{create_binary_message_with_headers, parse_binary_payload};
-    use wasm_bindgen_test::*;
-
-    #[wasm_bindgen_test]
-    fn test_binary_with_headers() {
-        let message_as_bytes = create_binary_message_with_headers(
-            42u8,
-            vec![0u8, 1u8, 2u8],
-            "test headers".to_string(),
-        );
-
-        // calculate header size
-        let headers = "test headers".as_bytes().to_vec();
-        let size = headers.len();
-
-        // the expected size
-        let expected_size = 12;
-        assert_eq!(size, expected_size);
-
-        assert_eq!(message_as_bytes[0], 42u8);
-        assert_eq!(message_as_bytes[1..9], 12u64.to_be_bytes());
-        assert_eq!(
-            message_as_bytes[9 + expected_size..9 + expected_size + 3],
-            vec![0u8, 1u8, 2u8]
-        );
-
-        let res = parse_binary_payload(&message_as_bytes);
-
-        assert_eq!(res.0, 42u8);
-        assert_eq!(res.1, "test headers".to_string());
-        assert_eq!(res.2, vec![0u8, 1u8, 2u8]);
-    }
-
-    #[wasm_bindgen_test]
-    fn test_binary_with_empty_headers() {
-        let message_as_bytes =
-            create_binary_message_with_headers(42u8, vec![0u8, 1u8, 2u8], "".to_string());
-
-        let expected_size = 0;
-
-        assert_eq!(message_as_bytes[0], 42u8);
-        assert_eq!(message_as_bytes[1..9], 0u64.to_be_bytes());
-        assert_eq!(
-            message_as_bytes[9 + expected_size..9 + expected_size + 3],
-            vec![0u8, 1u8, 2u8]
-        );
-
-        let res = parse_binary_payload(&message_as_bytes);
-
-        assert_eq!(res.0, 42u8);
-        assert_eq!(res.1, "".to_string());
-        assert_eq!(res.2, vec![0u8, 1u8, 2u8]);
-    }
-}

clients/webassembly/src/client/mod.rs

@@ -5,7 +5,9 @@ use self::config::Config;
 use crate::client::helpers::InputSender;
 use crate::client::response_pusher::ResponsePusher;
 use client_connections::TransmissionLane;
-use client_core::client::base_client::{BaseClientBuilder, ClientInput, ClientOutput};
+use client_core::client::base_client::{
+    BaseClientBuilder, ClientInput, ClientOutput, CredentialsToggle,
+};
 use client_core::client::replies::reply_storage::browser_backend;
 use client_core::client::{inbound_messages::InputMessage, key_manager::KeyManager};
 use gateway_client::bandwidth::BandwidthController;
@@ -92,13 +94,19 @@ impl NymClientBuilder {
         future_to_promise(async move {
             console_log!("Starting the wasm client");
 
+            let disabled_credentials = if self.disabled_credentials {
+                CredentialsToggle::Disabled
+            } else {
+                CredentialsToggle::Enabled
+            };
+
             let base_builder = BaseClientBuilder::new(
                 &self.config.gateway_endpoint,
                 &self.config.debug,
                 self.key_manager,
                 self.bandwidth_controller,
                 self.reply_surb_storage_backend,
-                self.disabled_credentials,
+                disabled_credentials,
                 vec![self.config.nym_api_url.clone()],
             );
 

clients/webassembly/src/encoded_payload_helper.rs

@@ -0,0 +1,238 @@
+// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use serde::{Deserialize, Serialize};
+use wasm_bindgen::prelude::*;
+use wasm_bindgen::JsCast;
+
+#[wasm_bindgen(typescript_custom_section)]
+const TS_DEFS: &'static str = r#"
+export interface EncodedPayload {
+    mimeType: string,
+    payload: Uint8Array;
+    headers: string,
+}
+"#;
+
+#[wasm_bindgen]
+extern "C" {
+    #[wasm_bindgen(typescript_type = "EncodedPayload")]
+    pub type IEncodedPayload;
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct EncodedPayload {
+    pub mime_type: String,
+    pub payload: Vec<u8>,
+    pub headers: Option<String>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct EncodedPayloadMetadata {
+    pub mime_type: String,
+    pub headers: Option<String>,
+}
+
+/// Encode a payload
+#[wasm_bindgen]
+pub fn encode_payload(mime_type: String, payload: Vec<u8>) -> Result<Vec<u8>, JsValue> {
+    encode_payload_with_headers(mime_type, payload, None)
+}
+
+/// Create a new binary message with a user-specified `kind`, and `headers` as a string.
+#[wasm_bindgen]
+pub fn encode_payload_with_headers(
+    mime_type: String,
+    payload: Vec<u8>,
+    headers: Option<String>,
+) -> Result<Vec<u8>, JsValue> {
+    match serde_json::to_string(&EncodedPayloadMetadata { mime_type, headers }) {
+        Ok(metadata) => {
+            let metadata = metadata.as_bytes().to_vec();
+            let size = (metadata.len() as u64).to_be_bytes().to_vec();
+            Ok(vec![size, metadata, payload].concat())
+        }
+        Err(e) => Err(JsValue::from(JsError::new(
+            format!("Could not encode message: {}", e).as_str(),
+        ))),
+    }
+}
+
+/// Parse the `kind` and byte array `payload` from a byte array
+#[wasm_bindgen]
+pub fn decode_payload(message: Vec<u8>) -> Result<IEncodedPayload, JsValue> {
+    if message.len() < 8 {
+        return Err(JsValue::from(JsError::new(
+            "Could not parse message, as less than 8 bytes long",
+        )));
+    }
+
+    match parse_payload(&message) {
+        Ok((metadata, payload)) => Ok(serde_wasm_bindgen::to_value(&EncodedPayload {
+            mime_type: metadata.mime_type,
+            payload: payload.to_vec(),
+            headers: metadata.headers,
+        })
+        .unwrap()
+        .unchecked_into::<IEncodedPayload>()),
+        Err(e) => Err(JsValue::from(JsError::new(
+            format!("Could not parse message: {}", e).as_str(),
+        ))),
+    }
+}
+
+pub(crate) fn parse_payload(message: &[u8]) -> anyhow::Result<(EncodedPayloadMetadata, &[u8])> {
+    // 1st 8 bytes are the size (as u64 big endian)
+    let mut size = [0u8; 8];
+    size.clone_from_slice(&message[0..8]);
+    let size = u64::from_be_bytes(size) as usize;
+
+    // then the metadata
+    let metadata = String::from_utf8_lossy(&message[8..8 + size]).into_owned();
+    let metadata: EncodedPayloadMetadata = serde_json::from_str(metadata.as_str())?;
+
+    // finally the payload
+    let payload = &message[8 + size..];
+
+    Ok((metadata, payload))
+}
+
+/// Try parse a UTF-8 string from an array of bytes
+#[wasm_bindgen]
+pub fn parse_utf8_string(payload: Vec<u8>) -> String {
+    String::from_utf8_lossy(&payload).into_owned()
+}
+
+/// Converts a UTF-8 string into an array of bytes
+///
+/// This method is provided as a replacement for the mess of `atob`
+/// (https://developer.mozilla.org/en-US/docs/Web/API/atob) helpers provided by browsers and NodeJS.
+///
+/// Feel free to use `atob` if you know you won't have problems with polyfills or encoding issues.
+#[wasm_bindgen]
+pub fn utf8_string_to_byte_array(message: String) -> Vec<u8> {
+    message.into_bytes()
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use wasm_bindgen_test::*;
+
+    #[wasm_bindgen_test]
+    async fn test_encode_payload_with_headers() {
+        let message_as_bytes = encode_payload_with_headers(
+            "text/plain".to_string(),
+            vec![0u8, 1u8, 2u8],
+            Some("test headers".to_string()),
+        )
+        .unwrap();
+
+        // the expected message size
+        let size = message_as_bytes.len();
+        let expected_size = 61;
+        assert_eq!(size, expected_size);
+
+        let expected_header_size = 50usize;
+        assert_eq!(
+            message_as_bytes[0..8],
+            (expected_header_size as u64).to_be_bytes()
+        );
+
+        assert_eq!(
+            message_as_bytes[8 + expected_header_size..8 + expected_header_size + 3],
+            vec![0u8, 1u8, 2u8]
+        );
+
+        let res = parse_payload(&message_as_bytes).unwrap();
+
+        assert_eq!(res.0.mime_type, "text/plain");
+        assert_eq!(res.0.headers.unwrap(), "test headers".to_string());
+        assert_eq!(res.1, vec![0u8, 1u8, 2u8]);
+    }
+
+    #[wasm_bindgen_test]
+    async fn test_encode_payload_with_empty_headers() {
+        let message_as_bytes =
+            encode_payload_with_headers("text/plain".to_string(), vec![0u8, 1u8, 2u8], None)
+                .unwrap();
+
+        // the expected message size
+        let size = message_as_bytes.len();
+        let expected_size = 51;
+        assert_eq!(size, expected_size);
+
+        let expected_header_size = 40usize;
+        assert_eq!(
+            message_as_bytes[0..8],
+            (expected_header_size as u64).to_be_bytes()
+        );
+
+        assert_eq!(
+            message_as_bytes[8 + expected_header_size..8 + expected_header_size + 3],
+            vec![0u8, 1u8, 2u8]
+        );
+        let res = parse_payload(&message_as_bytes).unwrap();
+
+        assert_eq!(res.0.mime_type, "text/plain");
+        assert_eq!(res.0.headers, None);
+        assert_eq!(res.1, vec![0u8, 1u8, 2u8]);
+    }
+
+    #[wasm_bindgen_test]
+    async fn test_encode_payload_with_empty_headers_and_empty_mime_type() {
+        let message_as_bytes =
+            encode_payload_with_headers("".to_string(), vec![0u8, 1u8, 2u8], None).unwrap();
+
+        // the expected message size
+        let size = message_as_bytes.len();
+        let expected_size = 41;
+        assert_eq!(size, expected_size);
+
+        let expected_header_size = 30usize;
+        assert_eq!(
+            message_as_bytes[0..8],
+            (expected_header_size as u64).to_be_bytes()
+        );
+
+        assert_eq!(
+            message_as_bytes[8 + expected_header_size..8 + expected_header_size + 3],
+            vec![0u8, 1u8, 2u8]
+        );
+        let res = parse_payload(&message_as_bytes).unwrap();
+
+        assert_eq!(res.0.mime_type, "");
+        assert_eq!(res.0.headers, None);
+        assert_eq!(res.1, vec![0u8, 1u8, 2u8]);
+    }
+
+    #[wasm_bindgen_test]
+    async fn test_encode_payload_with_all_empty() {
+        let empty: Vec<u8> = vec![];
+        let message_as_bytes =
+            encode_payload_with_headers("".to_string(), empty.clone(), None).unwrap();
+
+        // the expected message size
+        let size = message_as_bytes.len();
+        let expected_size = 38;
+        assert_eq!(size, expected_size);
+
+        let expected_header_size = 30usize;
+        assert_eq!(
+            message_as_bytes[0..8],
+            (expected_header_size as u64).to_be_bytes()
+        );
+
+        assert_eq!(
+            message_as_bytes[8 + expected_header_size..8 + expected_header_size],
+            empty
+        );
+        let res = parse_payload(&message_as_bytes).unwrap();
+
+        assert_eq!(res.0.mime_type, "");
+        assert_eq!(res.0.headers, None);
+        assert_eq!(res.1, empty);
+    }
+}

clients/webassembly/src/lib.rs

@@ -3,12 +3,14 @@
 
 use wasm_bindgen::prelude::*;
 
-#[cfg(target_arch = "wasm32")]
-pub mod binary_message_helper;
 #[cfg(target_arch = "wasm32")]
 mod client;
 #[cfg(target_arch = "wasm32")]
+pub mod encoded_payload_helper;
+#[cfg(target_arch = "wasm32")]
 pub mod gateway_selector;
+#[cfg(target_arch = "wasm32")]
+pub mod validation;
 
 #[wasm_bindgen]
 pub fn set_panic_hook() {

clients/webassembly/src/validation.rs

@@ -0,0 +1,35 @@
+use nymsphinx::addressing::clients::Recipient;
+use wasm_bindgen::prelude::*;
+
+#[wasm_bindgen]
+pub fn validate_recipient(recipient: String) -> Result<(), JsError> {
+    match Recipient::try_from_base58_string(recipient) {
+        Ok(_) => Ok(()),
+        Err(e) => Err(JsError::new(format!("{}", e).as_str())),
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::validate_recipient;
+    use wasm_bindgen_test::*;
+
+    #[wasm_bindgen_test]
+    fn test_recipient_validation_ok() {
+        let res = validate_recipient("DyQmXnst5NGGjzUZxRC5Bjs5bd7CBF3xMpsSmbRiizr2.GH6YTBP2NXU3AVqd8WjiTMVyeMjunXMEsp7gVCMEJqpD@336yuXAeGEgedRfqTJZsG2YV7P13QH1bHv1SjCZYarc9".to_string());
+        assert!(res.is_ok())
+    }
+
+    #[wasm_bindgen_test]
+    fn test_recipient_validation_fails() {
+        assert!(validate_recipient("  DyQmXnst5NGGjzUZxRC5Bjs5bd7CBF3xMpsSmbRiizr2.GH6YTBP2NXU3AVqd8WjiTMVyeMjunXMEsp7gVCMEJqpD@336yuXAeGEgedRfqTJZsG2YV7P13QH1bHv1SjCZYarc9".to_string()).is_err());
+        assert!(validate_recipient(
+            "DyQmXnst5NGGjzUZxRC5BjbRiizr2.GH6YTBP2NXU3AVqd8WD@336yuXAeGEgedRfqTJZQH1bHv1SjCZYarc9"
+                .to_string()
+        )
+        .is_err());
+        assert!(validate_recipient("🙀🙀🙀🙀".to_string()).is_err());
+        assert!(validate_recipient("".to_string()).is_err());
+        assert!(validate_recipient(" ".to_string()).is_err());
+    }
+}

common/client-libs/gateway-client/Cargo.toml

@@ -15,7 +15,7 @@ thiserror = "1.0"
 url = "2.2"
 rand = { version = "0.7.3", features = ["wasm-bindgen"] }
 async-trait = { version = "0.1.51" }
-tokio = { version = "1.21.2", features = ["macros"] }
+tokio = { version = "1.24.1", features = ["macros"] }
 
 # internal
 coconut-interface = { path = "../../coconut-interface", optional = true }
@@ -36,11 +36,11 @@ default-features = false
 
 # non-wasm-only dependencies
 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio]
-version = "1.21.2"
+version = "1.24.1"
 features = ["macros", "rt", "net", "sync", "time"]
 
 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio-stream]
-version = "0.1.9"
+version = "0.1.11"
 features = ["net", "sync", "time"]
 
 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio-tungstenite]

common/client-libs/mixnet-client/Cargo.toml

@@ -9,8 +9,9 @@ edition = "2021"
 [dependencies]
 futures = "0.3"
 log = "0.4.8"
-tokio = { version = "1.21.2", features = ["time", "net", "rt"] }
-tokio-util = { version = "0.7.3", features = ["codec"] }
+tokio = { version = "1.24.1", features = ["time", "net", "rt"] }
+tokio-util = { version = "0.7.4", features = ["codec"] }
 
 # internal
-nymsphinx = {path = "../../nymsphinx" }
+nymsphinx = { path = "../../nymsphinx" }
+task = { path = "../../task" }

common/client-libs/mixnet-client/src/forwarder.rs

@@ -16,6 +16,7 @@ type MixForwardingReceiver = mpsc::UnboundedReceiver<MixPacket>;
 pub struct PacketForwarder {
     mixnet_client: Client,
     packet_receiver: MixForwardingReceiver,
+    shutdown: task::TaskClient,
 }
 
 impl PacketForwarder {
@@ -25,6 +26,7 @@ impl PacketForwarder {
         initial_connection_timeout: Duration,
         maximum_connection_buffer_size: usize,
         use_legacy_version: bool,
+        shutdown: task::TaskClient,
     ) -> (PacketForwarder, MixForwardingSender) {
         let client_config = Config::new(
             initial_reconnection_backoff,
@@ -40,26 +42,35 @@ impl PacketForwarder {
             PacketForwarder {
                 mixnet_client: Client::new(client_config),
                 packet_receiver,
+                shutdown,
             },
             packet_sender,
         )
     }
 
     pub async fn run(&mut self) {
-        while let Some(mix_packet) = self.packet_receiver.next().await {
-            trace!("Going to forward packet to {:?}", mix_packet.next_hop());
+        while !self.shutdown.is_shutdown() {
+            tokio::select! {
+                biased;
+                _ = self.shutdown.recv() => {
+                    log::trace!("PacketForwarder: Received shutdown");
+                }
+                Some(mix_packet) = self.packet_receiver.next() => {
+                     trace!("Going to forward packet to {:?}", mix_packet.next_hop());
 
-            let next_hop = mix_packet.next_hop();
-            let packet_mode = mix_packet.packet_mode();
-            let sphinx_packet = mix_packet.into_sphinx_packet();
-            // we don't care about responses, we just want to fire packets
-            // as quickly as possible
+                    let next_hop = mix_packet.next_hop();
+                    let packet_mode = mix_packet.packet_mode();
+                    let sphinx_packet = mix_packet.into_sphinx_packet();
+                    // we don't care about responses, we just want to fire packets
+                    // as quickly as possible
 
-            if let Err(err) =
-                self.mixnet_client
-                    .send_without_response(next_hop, sphinx_packet, packet_mode)
-            {
-                debug!("failed to forward the packet - {err}")
+                    if let Err(err) =
+                        self.mixnet_client
+                            .send_without_response(next_hop, sphinx_packet, packet_mode)
+                    {
+                        debug!("failed to forward the packet - {err}")
+                    }
+                }
             }
         }
     }

common/client-libs/validator-client/Cargo.toml

@@ -24,7 +24,7 @@ reqwest = { version = "0.11", features = ["json"] }
 thiserror = "1"
 log = "0.4"
 url = { version = "2.2", features = ["serde"] }
-tokio = { version = "1.21.2", features = ["sync", "time"] }
+tokio = { version = "1.24.1", features = ["sync", "time"] }
 futures = "0.3"
 
 coconut-interface = { path = "../../coconut-interface" }

common/client-libs/validator-client/src/error.rs

@@ -6,7 +6,7 @@ use thiserror::Error;
 
 #[derive(Error, Debug)]
 pub enum ValidatorClientError {
-    #[error("There was an issue with the validator api request - {source}")]
+    #[error("nym api request failed - {source}")]
     NymAPIError {
         #[from]
         source: nym_api::error::NymAPIError,
@@ -16,7 +16,7 @@ pub enum ValidatorClientError {
     MalformedUrlProvided(#[from] url::ParseError),
 
     #[cfg(feature = "nyxd-client")]
-    #[error("There was an issue with the Nyxd client - {0}")]
+    #[error("nyxd request failed - {0}")]
     NyxdError(#[from] crate::nyxd::error::NyxdError),
 
     #[error("No validator API url has been provided")]

common/client-libs/validator-client/src/lib.rs

@@ -9,10 +9,8 @@ pub mod nym_api;
 #[cfg(feature = "nyxd-client")]
 pub mod nyxd;
 
-#[cfg(feature = "nyxd-client")]
-pub use crate::client::{CoconutApiClient, NymApiClient};
 pub use crate::error::ValidatorClientError;
 pub use nym_api_requests::*;
 
 #[cfg(feature = "nyxd-client")]
-pub use client::{Client, Config};
+pub use client::{Client, CoconutApiClient, Config, NymApiClient};

common/client-libs/validator-client/src/nyxd/error.rs

@@ -46,25 +46,25 @@ pub enum NyxdError {
     #[error("{0} is not a valid tx hash")]
     InvalidTxHash(String),
 
-    #[error("There was an issue with a tendermint RPC request - {0}")]
+    #[error("Tendermint RPC request failed - {0}")]
     TendermintError(#[from] TendermintRpcError),
 
-    #[error("There was an issue when attempting to serialize data ({0})")]
+    #[error("Failed when attempting to serialize data ({0})")]
     SerializationError(String),
 
-    #[error("There was an issue when attempting to deserialize data ({0})")]
+    #[error("Failed when attempting to deserialize data ({0})")]
     DeserializationError(String),
 
-    #[error("There was an issue when attempting to encode our protobuf data - {0}")]
+    #[error("Failed when attempting to encode our protobuf data - {0}")]
     ProtobufEncodingError(#[from] prost::EncodeError),
 
-    #[error("There was an issue when attempting to decode our protobuf data - {0}")]
+    #[error("Failed to decode our protobuf data - {0}")]
     ProtobufDecodingError(#[from] prost::DecodeError),
 
     #[error("Account {0} does not exist on the chain")]
     NonExistentAccountError(AccountId),
 
-    #[error("There was an issue with the serialization/deserialization - {0}")]
+    #[error("Failed on json serialization/deserialization - {0}")]
     SerdeJsonError(#[from] serde_json::Error),
 
     #[error("Account {0} is not a valid account address")]

common/client-libs/validator-client/src/nyxd/mod.rs

@@ -17,11 +17,13 @@ use cosmrs::rpc::HttpClientUrl;
 use cosmrs::tx::Msg;
 use execute::execute;
 use log::debug;
+use mixnet_contract_common::MixId;
 use network_defaults::{ChainDetails, NymNetworkDetails};
 use serde::{Deserialize, Serialize};
 use std::convert::TryInto;
 use std::time::SystemTime;
 use vesting_contract_common::ExecuteMsg as VestingExecuteMsg;
+use vesting_contract_common::PledgeCap;
 
 pub use crate::nyxd::cosmwasm_client::client::CosmWasmClient;
 pub use crate::nyxd::cosmwasm_client::signing_client::SigningCosmWasmClient;
@@ -43,10 +45,8 @@ pub use cosmrs::Coin as CosmosCoin;
 pub use cosmrs::{bip32, AccountId, Decimal, Denom};
 pub use cosmwasm_std::Coin as CosmWasmCoin;
 pub use fee::{gas_price::GasPrice, GasAdjustable, GasAdjustment};
-use mixnet_contract_common::MixId;
 pub use signing_client::Client as SigningNyxdClient;
 pub use traits::{VestingQueryClient, VestingSigningClient};
-use vesting_contract_common::PledgeCap;
 
 pub mod coin;
 pub mod cosmwasm_client;

common/client-libs/validator-client/src/nyxd/traits/vesting_query_client.rs

@@ -12,8 +12,9 @@ use mixnet_contract_common::MixId;
 use serde::Deserialize;
 use vesting_contract::vesting::Account;
 use vesting_contract_common::{
-    messages::QueryMsg as VestingQueryMsg, AllDelegationsResponse, DelegationTimesResponse,
-    OriginalVestingResponse, Period, PledgeData, VestingDelegation,
+    messages::QueryMsg as VestingQueryMsg, AccountVestingCoins, AccountsResponse,
+    AllDelegationsResponse, BaseVestingAccountInfo, DelegationTimesResponse,
+    OriginalVestingResponse, Period, PledgeData, VestingCoinsResponse, VestingDelegation,
 };
 
 #[async_trait]
@@ -27,74 +28,187 @@ pub trait VestingQueryClient {
             .await
     }
 
+    async fn get_all_accounts_paged(
+        &self,
+        start_next_after: Option<String>,
+        limit: Option<u32>,
+    ) -> Result<AccountsResponse, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetAccountsPaged {
+            start_next_after,
+            limit,
+        })
+        .await
+    }
+
+    async fn get_all_accounts_vesting_coins_paged(
+        &self,
+        start_next_after: Option<String>,
+        limit: Option<u32>,
+    ) -> Result<VestingCoinsResponse, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetAccountsVestingCoinsPaged {
+            start_next_after,
+            limit,
+        })
+        .await
+    }
+
     async fn locked_coins(
         &self,
-        address: &str,
+        vesting_account_address: &str,
         block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError>;
+    ) -> Result<Coin, NyxdError> {
+        self.query_vesting_contract::<CosmWasmCoin>(VestingQueryMsg::LockedCoins {
+            vesting_account_address: vesting_account_address.to_string(),
+            block_time,
+        })
+        .await
+        .map(Into::into)
+    }
 
     async fn spendable_coins(
         &self,
         vesting_account_address: &str,
         block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError>;
+    ) -> Result<Coin, NyxdError> {
+        self.query_vesting_contract::<CosmWasmCoin>(VestingQueryMsg::SpendableCoins {
+            vesting_account_address: vesting_account_address.to_string(),
+            block_time,
+        })
+        .await
+        .map(Into::into)
+    }
 
     async fn vested_coins(
         &self,
         vesting_account_address: &str,
         block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError>;
+    ) -> Result<Coin, NyxdError> {
+        self.query_vesting_contract::<CosmWasmCoin>(VestingQueryMsg::GetVestedCoins {
+            vesting_account_address: vesting_account_address.to_string(),
+            block_time,
+        })
+        .await
+        .map(Into::into)
+    }
 
     async fn vesting_coins(
         &self,
         vesting_account_address: &str,
         block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError>;
+    ) -> Result<Coin, NyxdError> {
+        self.query_vesting_contract::<CosmWasmCoin>(VestingQueryMsg::GetVestingCoins {
+            vesting_account_address: vesting_account_address.to_string(),
+            block_time,
+        })
+        .await
+        .map(Into::into)
+    }
 
     async fn vesting_start_time(
         &self,
         vesting_account_address: &str,
-    ) -> Result<Timestamp, NyxdError>;
+    ) -> Result<Timestamp, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetStartTime {
+            vesting_account_address: vesting_account_address.to_string(),
+        })
+        .await
+    }
 
-    async fn vesting_end_time(&self, vesting_account_address: &str)
-        -> Result<Timestamp, NyxdError>;
+    async fn vesting_end_time(
+        &self,
+        vesting_account_address: &str,
+    ) -> Result<Timestamp, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetEndTime {
+            vesting_account_address: vesting_account_address.to_string(),
+        })
+        .await
+    }
 
     async fn original_vesting(
         &self,
         vesting_account_address: &str,
-    ) -> Result<OriginalVestingResponse, NyxdError>;
+    ) -> Result<OriginalVestingResponse, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetOriginalVesting {
+            vesting_account_address: vesting_account_address.to_string(),
+        })
+        .await
+    }
 
     async fn delegated_free(
         &self,
         vesting_account_address: &str,
         block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError>;
+    ) -> Result<Coin, NyxdError> {
+        self.query_vesting_contract::<CosmWasmCoin>(VestingQueryMsg::GetDelegatedFree {
+            vesting_account_address: vesting_account_address.to_string(),
+            block_time,
+        })
+        .await
+        .map(Into::into)
+    }
 
+    /// Returns the total amount of delegated tokens that have vested
     async fn delegated_vesting(
         &self,
         vesting_account_address: &str,
         block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError>;
+    ) -> Result<Coin, NyxdError> {
+        self.query_vesting_contract::<CosmWasmCoin>(VestingQueryMsg::GetDelegatedVesting {
+            vesting_account_address: vesting_account_address.to_string(),
+            block_time,
+        })
+        .await
+        .map(Into::into)
+    }
 
-    async fn get_account(&self, address: &str) -> Result<Account, NyxdError>;
-    async fn get_mixnode_pledge(&self, address: &str) -> Result<Option<PledgeData>, NyxdError>;
-    async fn get_gateway_pledge(&self, address: &str) -> Result<Option<PledgeData>, NyxdError>;
-    async fn get_current_vesting_period(
-        &self,
-        vesting_account_address: &str,
-    ) -> Result<Period, NyxdError>;
+    async fn get_account(&self, address: &str) -> Result<Account, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetAccount {
+            address: address.to_string(),
+        })
+        .await
+    }
+
+    async fn get_mixnode_pledge(&self, address: &str) -> Result<Option<PledgeData>, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetMixnode {
+            address: address.to_string(),
+        })
+        .await
+    }
+
+    async fn get_gateway_pledge(&self, address: &str) -> Result<Option<PledgeData>, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetGateway {
+            address: address.to_string(),
+        })
+        .await
+    }
+
+    async fn get_current_vesting_period(&self, address: &str) -> Result<Period, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetCurrentVestingPeriod {
+            address: address.to_string(),
+        })
+        .await
+    }
 
     async fn get_delegation_timestamps(
         &self,
         address: &str,
         mix_id: MixId,
-    ) -> Result<DelegationTimesResponse, NyxdError>;
+    ) -> Result<DelegationTimesResponse, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetDelegationTimes {
+            address: address.to_string(),
+            mix_id,
+        })
+        .await
+    }
 
     async fn get_all_vesting_delegations_paged(
         &self,
         start_after: Option<(u32, MixId, u64)>,
         limit: Option<u32>,
-    ) -> Result<AllDelegationsResponse, NyxdError>;
+    ) -> Result<AllDelegationsResponse, NyxdError> {
+        self.query_vesting_contract(VestingQueryMsg::GetAllDelegations { start_after, limit })
+            .await
+    }
 
     async fn get_all_vesting_delegations(&self) -> Result<Vec<VestingDelegation>, NyxdError> {
         let mut delegations = Vec::new();
@@ -114,6 +228,44 @@ pub trait VestingQueryClient {
 
         Ok(delegations)
     }
+
+    async fn get_all_accounts_info(&self) -> Result<Vec<BaseVestingAccountInfo>, NyxdError> {
+        let mut accounts = Vec::new();
+        let mut start_after = None;
+        loop {
+            let mut paged_response = self
+                .get_all_accounts_paged(start_after.take(), None)
+                .await?;
+            accounts.append(&mut paged_response.accounts);
+
+            if let Some(start_after_res) = paged_response.start_next_after {
+                start_after = Some(start_after_res.into_string())
+            } else {
+                break;
+            }
+        }
+
+        Ok(accounts)
+    }
+
+    async fn get_all_accounts_vesting_coins(&self) -> Result<Vec<AccountVestingCoins>, NyxdError> {
+        let mut accounts = Vec::new();
+        let mut start_after = None;
+        loop {
+            let mut paged_response = self
+                .get_all_accounts_vesting_coins_paged(start_after.take(), None)
+                .await?;
+            accounts.append(&mut paged_response.accounts);
+
+            if let Some(start_after_res) = paged_response.start_next_after {
+                start_after = Some(start_after_res.into_string())
+            } else {
+                break;
+            }
+        }
+
+        Ok(accounts)
+    }
 }
 
 #[async_trait]
@@ -126,188 +278,4 @@ impl<C: CosmWasmClient + Sync + Send> VestingQueryClient for NyxdClient<C> {
             .query_contract_smart(self.vesting_contract_address(), &query)
             .await
     }
-
-    async fn locked_coins(
-        &self,
-        vesting_account_address: &str,
-        block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError> {
-        let request = VestingQueryMsg::LockedCoins {
-            vesting_account_address: vesting_account_address.to_string(),
-            block_time,
-        };
-        self.client
-            .query_contract_smart::<_, CosmWasmCoin>(self.vesting_contract_address(), &request)
-            .await
-            .map(Into::into)
-    }
-
-    async fn spendable_coins(
-        &self,
-        vesting_account_address: &str,
-        block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError> {
-        let request = VestingQueryMsg::SpendableCoins {
-            vesting_account_address: vesting_account_address.to_string(),
-            block_time,
-        };
-        self.client
-            .query_contract_smart::<_, CosmWasmCoin>(self.vesting_contract_address(), &request)
-            .await
-            .map(Into::into)
-    }
-    async fn vested_coins(
-        &self,
-        vesting_account_address: &str,
-        block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError> {
-        let request = VestingQueryMsg::GetVestedCoins {
-            vesting_account_address: vesting_account_address.to_string(),
-            block_time,
-        };
-        self.client
-            .query_contract_smart::<_, CosmWasmCoin>(self.vesting_contract_address(), &request)
-            .await
-            .map(Into::into)
-    }
-    async fn vesting_coins(
-        &self,
-        vesting_account_address: &str,
-        block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError> {
-        let request = VestingQueryMsg::GetVestingCoins {
-            vesting_account_address: vesting_account_address.to_string(),
-            block_time,
-        };
-        self.client
-            .query_contract_smart::<_, CosmWasmCoin>(self.vesting_contract_address(), &request)
-            .await
-            .map(Into::into)
-    }
-
-    async fn vesting_start_time(
-        &self,
-        vesting_account_address: &str,
-    ) -> Result<Timestamp, NyxdError> {
-        let request = VestingQueryMsg::GetStartTime {
-            vesting_account_address: vesting_account_address.to_string(),
-        };
-        self.client
-            .query_contract_smart(self.vesting_contract_address(), &request)
-            .await
-    }
-
-    async fn vesting_end_time(
-        &self,
-        vesting_account_address: &str,
-    ) -> Result<Timestamp, NyxdError> {
-        let request = VestingQueryMsg::GetEndTime {
-            vesting_account_address: vesting_account_address.to_string(),
-        };
-        self.client
-            .query_contract_smart(self.vesting_contract_address(), &request)
-            .await
-    }
-
-    async fn original_vesting(
-        &self,
-        vesting_account_address: &str,
-    ) -> Result<OriginalVestingResponse, NyxdError> {
-        let request = VestingQueryMsg::GetOriginalVesting {
-            vesting_account_address: vesting_account_address.to_string(),
-        };
-        self.client
-            .query_contract_smart(self.vesting_contract_address(), &request)
-            .await
-    }
-
-    async fn delegated_free(
-        &self,
-        vesting_account_address: &str,
-        block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError> {
-        let request = VestingQueryMsg::GetDelegatedFree {
-            vesting_account_address: vesting_account_address.to_string(),
-            block_time,
-        };
-        self.client
-            .query_contract_smart::<_, CosmWasmCoin>(self.vesting_contract_address(), &request)
-            .await
-            .map(Into::into)
-    }
-
-    /// Returns the total amount of delegated tokens that have vested
-    async fn delegated_vesting(
-        &self,
-        vesting_account_address: &str,
-        block_time: Option<Timestamp>,
-    ) -> Result<Coin, NyxdError> {
-        let request = VestingQueryMsg::GetDelegatedVesting {
-            vesting_account_address: vesting_account_address.to_string(),
-            block_time,
-        };
-        self.client
-            .query_contract_smart::<_, CosmWasmCoin>(self.vesting_contract_address(), &request)
-            .await
-            .map(Into::into)
-    }
-
-    async fn get_account(&self, address: &str) -> Result<Account, NyxdError> {
-        let request = VestingQueryMsg::GetAccount {
-            address: address.to_string(),
-        };
-        self.client
-            .query_contract_smart(self.vesting_contract_address(), &request)
-            .await
-    }
-    async fn get_mixnode_pledge(&self, address: &str) -> Result<Option<PledgeData>, NyxdError> {
-        let request = VestingQueryMsg::GetMixnode {
-            address: address.to_string(),
-        };
-        self.client
-            .query_contract_smart(self.vesting_contract_address(), &request)
-            .await
-    }
-    async fn get_gateway_pledge(&self, address: &str) -> Result<Option<PledgeData>, NyxdError> {
-        let request = VestingQueryMsg::GetGateway {
-            address: address.to_string(),
-        };
-        self.client
-            .query_contract_smart(self.vesting_contract_address(), &request)
-            .await
-    }
-
-    async fn get_current_vesting_period(&self, address: &str) -> Result<Period, NyxdError> {
-        let request = VestingQueryMsg::GetCurrentVestingPeriod {
-            address: address.to_string(),
-        };
-        self.client
-            .query_contract_smart(self.vesting_contract_address(), &request)
-            .await
-    }
-
-    async fn get_delegation_timestamps(
-        &self,
-        address: &str,
-        mix_id: MixId,
-    ) -> Result<DelegationTimesResponse, NyxdError> {
-        let request = VestingQueryMsg::GetDelegationTimes {
-            address: address.to_string(),
-            mix_id,
-        };
-        self.client
-            .query_contract_smart(self.vesting_contract_address(), &request)
-            .await
-    }
-
-    async fn get_all_vesting_delegations_paged(
-        &self,
-        start_after: Option<(u32, MixId, u64)>,
-        limit: Option<u32>,
-    ) -> Result<AllDelegationsResponse, NyxdError> {
-        let request = VestingQueryMsg::GetAllDelegations { start_after, limit };
-        self.client
-            .query_contract_smart(self.vesting_contract_address(), &request)
-            .await
-    }
 }

common/client-libs/validator-client/src/nyxd/traits/vesting_signing_client.rs

@@ -106,12 +106,14 @@ pub trait VestingSigningClient {
         &self,
         mix_id: MixId,
         amount: Coin,
+        on_behalf_of: Option<String>,
         fee: Option<Fee>,
     ) -> Result<ExecuteResult, NyxdError>;
 
     async fn vesting_undelegate_from_mixnode(
         &self,
         mix_id: MixId,
+        on_behalf_of: Option<String>,
         fee: Option<Fee>,
     ) -> Result<ExecuteResult, NyxdError>;
 
@@ -367,6 +369,7 @@ impl<C: SigningCosmWasmClient + Sync + Send> VestingSigningClient for NyxdClient
         &self,
         mix_id: MixId,
         amount: Coin,
+        on_behalf_of: Option<String>,
         fee: Option<Fee>,
     ) -> Result<ExecuteResult, NyxdError> {
         self.execute_vesting_contract(
@@ -374,6 +377,7 @@ impl<C: SigningCosmWasmClient + Sync + Send> VestingSigningClient for NyxdClient
             VestingExecuteMsg::DelegateToMixnode {
                 mix_id,
                 amount: amount.into(),
+                on_behalf_of,
             },
             vec![],
         )
@@ -383,11 +387,15 @@ impl<C: SigningCosmWasmClient + Sync + Send> VestingSigningClient for NyxdClient
     async fn vesting_undelegate_from_mixnode(
         &self,
         mix_id: MixId,
+        on_behalf_of: Option<String>,
         fee: Option<Fee>,
     ) -> Result<ExecuteResult, NyxdError> {
         self.execute_vesting_contract(
             fee,
-            VestingExecuteMsg::UndelegateFromMixnode { mix_id },
+            VestingExecuteMsg::UndelegateFromMixnode {
+                mix_id,
+                on_behalf_of,
+            },
             vec![],
         )
         .await

common/commands/src/context/mod.rs

@@ -80,7 +80,7 @@ pub fn create_signing_client(
 
     match NyxdClient::connect_with_mnemonic(client_config, nyxd_url, mnemonic, None) {
         Ok(client) => Ok(client),
-        Err(e) => Err(ContextError::NyxdError(format!("{:?}", e))),
+        Err(e) => Err(ContextError::NyxdError(format!("{e}"))),
     }
 }
 
@@ -99,7 +99,7 @@ pub fn create_query_client(
 
     match NyxdClient::connect(client_config, nyxd_url) {
         Ok(client) => Ok(client),
-        Err(e) => Err(ContextError::NyxdError(format!("{:?}", e))),
+        Err(e) => Err(ContextError::NyxdError(format!("{e}"))),
     }
 }
 
@@ -122,7 +122,7 @@ pub fn create_signing_client_with_nym_api(
 
     match validator_client::client::Client::new_signing(client_config, mnemonic) {
         Ok(client) => Ok(client),
-        Err(e) => Err(ContextError::NyxdError(format!("{:?}", e))),
+        Err(e) => Err(ContextError::NyxdError(format!("{e}"))),
     }
 }
 
@@ -134,6 +134,6 @@ pub fn create_query_client_with_nym_api(
 
     match validator_client::client::Client::new_query(client_config) {
         Ok(client) => Ok(client),
-        Err(e) => Err(ContextError::NyxdError(format!("{:?}", e))),
+        Err(e) => Err(ContextError::NyxdError(format!("{e}"))),
     }
 }

common/commands/src/utils.rs

@@ -15,7 +15,7 @@ pub fn pretty_coin(coin: &Coin) -> String {
     } else {
         &coin.denom
     };
-    format!("{} {}", amount, denom)
+    format!("{amount} {denom}")
 }
 
 pub fn pretty_cosmwasm_coin(coin: &CosmWasmCoin) -> String {
@@ -25,12 +25,12 @@ pub fn pretty_cosmwasm_coin(coin: &CosmWasmCoin) -> String {
     } else {
         &coin.denom
     };
-    format!("{} {}", amount, denom)
+    format!("{amount} {denom}")
 }
 
 pub fn pretty_decimal_with_denom(value: Decimal, denom: &str) -> String {
     // TODO: we might have to truncate the value here (that's why I moved it to separate function)
-    format!("{} {}", value, denom)
+    format!("{value} {denom}")
 }
 
 pub fn show_error<E>(e: E)

common/commands/src/validator/account/balance.rs

@@ -57,7 +57,7 @@ pub async fn query_balance(
                 if denom.is_empty() || denom.eq_ignore_ascii_case(&coin.denom) {
                     if args.raw {
                         if !args.hide_denom {
-                            println!("{}", coin);
+                            println!("{coin}");
                         } else {
                             println!("{}", coin.amount);
                         }

common/commands/src/validator/account/pubkey.rs

@@ -77,12 +77,12 @@ pub async fn get_pubkey_from_chain(address: AccountId, client: &QueryClient) {
                 if let Some(pubkey) = base_account.pubkey {
                     println!("{}", pubkey.to_string());
                 } else {
-                    println!("No account associated with address {}", address);
+                    println!("No account associated with address {address}");
                 }
             }
         }
         Ok(None) => {
-            println!("No account associated with address {}", address);
+            println!("No account associated with address {address}");
         }
         Err(e) => show_error(e),
     }

common/commands/src/validator/cosmwasm/generators/coconut_bandwidth.rs

@@ -43,5 +43,5 @@ pub async fn generate(args: Args) {
     let res =
         serde_json::to_string(&instantiate_msg).expect("failed to convert instantiate msg to json");
 
-    println!("{}", res)
+    println!("{res}")
 }

common/commands/src/validator/cosmwasm/generators/coconut_dkg.rs

@@ -3,8 +3,10 @@
 
 use clap::Parser;
 use log::{debug, info};
+use std::str::FromStr;
 
 use coconut_dkg_common::msg::InstantiateMsg;
+use coconut_dkg_common::types::TimeConfiguration;
 
 #[derive(Debug, Parser)]
 pub struct Args {
@@ -14,6 +16,24 @@ pub struct Args {
     #[clap(long)]
     pub multisig_addr: Option<String>,
 
+    #[clap(long)]
+    pub public_key_submission_time_secs: Option<u64>,
+
+    #[clap(long)]
+    pub dealing_exchange_time_secs: Option<u64>,
+
+    #[clap(long)]
+    pub verification_key_submission_time_secs: Option<u64>,
+
+    #[clap(long)]
+    pub verification_key_validation_time_secs: Option<u64>,
+
+    #[clap(long)]
+    pub verification_key_finalization_time_secs: Option<u64>,
+
+    #[clap(long)]
+    pub in_progress_time_secs: Option<u64>,
+
     #[clap(long)]
     pub mix_denom: Option<String>,
 }
@@ -32,9 +52,42 @@ pub async fn generate(args: Args) {
         std::env::var(network_defaults::var_names::MIX_DENOM).expect("Mix denom has to be set")
     });
 
+    let mut time_configuration =
+        if let Ok(config) = std::env::var(network_defaults::var_names::DKG_TIME_CONFIGURATION) {
+            TimeConfiguration::from_str(&config).expect("Invalid env variable value")
+        } else {
+            TimeConfiguration::default()
+        };
+    if let Some(public_key_submission_time_secs) = args.public_key_submission_time_secs {
+        time_configuration.public_key_submission_time_secs = public_key_submission_time_secs;
+    }
+    if let Some(dealing_exchange_time_secs) = args.dealing_exchange_time_secs {
+        time_configuration.dealing_exchange_time_secs = dealing_exchange_time_secs;
+    }
+    if let Some(verification_key_submission_time_secs) = args.verification_key_submission_time_secs
+    {
+        time_configuration.verification_key_submission_time_secs =
+            verification_key_submission_time_secs;
+    }
+    if let Some(verification_key_validation_time_secs) = args.verification_key_validation_time_secs
+    {
+        time_configuration.verification_key_validation_time_secs =
+            verification_key_validation_time_secs;
+    }
+    if let Some(verification_key_finalization_time_secs) =
+        args.verification_key_finalization_time_secs
+    {
+        time_configuration.verification_key_finalization_time_secs =
+            verification_key_finalization_time_secs;
+    }
+    if let Some(in_progress_time_secs) = args.in_progress_time_secs {
+        time_configuration.in_progress_time_secs = in_progress_time_secs;
+    }
+
     let instantiate_msg = InstantiateMsg {
         group_addr: args.group_addr,
         multisig_addr,
+        time_configuration: Some(time_configuration),
         mix_denom,
     };
 
@@ -43,5 +96,5 @@ pub async fn generate(args: Args) {
     let res =
         serde_json::to_string(&instantiate_msg).expect("failed to convert instantiate msg to json");
 
-    println!("{}", res)
+    println!("{res}")
 }

common/commands/src/validator/cosmwasm/generators/mixnet.rs

@@ -105,5 +105,5 @@ pub async fn generate(args: Args) {
     let res =
         serde_json::to_string(&instantiate_msg).expect("failed to convert instantiate msg to json");
 
-    println!("{}", res)
+    println!("{res}")
 }

common/commands/src/validator/cosmwasm/generators/multisig.rs

@@ -58,5 +58,5 @@ pub async fn generate(args: Args) {
     let res =
         serde_json::to_string(&instantiate_msg).expect("failed to convert instantiate msg to json");
 
-    println!("{}", res)
+    println!("{res}")
 }

common/commands/src/validator/cosmwasm/generators/vesting.rs

@@ -39,5 +39,5 @@ pub async fn generate(args: Args) {
     let res =
         serde_json::to_string(&instantiate_msg).expect("failed to convert instantiate msg to json");
 
-    println!("{}", res)
+    println!("{res}")
 }

common/commands/src/validator/mixnet/delegators/vesting_delegate_to_mixnode.rs

@@ -18,6 +18,9 @@ pub struct Args {
     #[clap(long)]
     pub identity_key: Option<String>,
 
+    #[clap(long)]
+    pub on_behalf_of: Option<String>,
+
     #[clap(long)]
     pub amount: u128,
 }
@@ -45,7 +48,7 @@ pub async fn vesting_delegate_to_mixnode(args: Args, client: SigningClient) {
     let coin = Coin::new(args.amount, denom);
 
     let res = client
-        .vesting_delegate_to_mixnode(mix_id, coin.into(), None)
+        .vesting_delegate_to_mixnode(mix_id, coin.into(), args.on_behalf_of, None)
         .await
         .expect("failed to delegate to mixnode!");
 

common/commands/src/validator/mixnet/delegators/vesting_undelegate_from_mixnode.rs

@@ -16,6 +16,9 @@ pub struct Args {
 
     #[clap(long)]
     pub identity_key: Option<String>,
+
+    #[clap(long)]
+    pub on_behalf_of: Option<String>,
 }
 
 pub async fn vesting_undelegate_from_mixnode(args: Args, client: SigningClient) {
@@ -37,7 +40,7 @@ pub async fn vesting_undelegate_from_mixnode(args: Args, client: SigningClient)
     };
 
     let res = client
-        .vesting_undelegate_from_mixnode(mix_id, None)
+        .vesting_undelegate_from_mixnode(mix_id, args.on_behalf_of, None)
         .await
         .expect("failed to remove stake from vesting account on mixnode!");
 

common/commands/src/validator/mixnet/operators/mixnode/keys/decode_mixnode_key.rs

@@ -13,5 +13,5 @@ pub fn decode_mixnode_key(args: Args) {
     let b64_decoded = base64::decode(args.key).expect("failed to decode base64 string");
     let b58_encoded = bs58::encode(&b64_decoded).into_string();
 
-    println!("{}", b58_encoded)
+    println!("{b58_encoded}")
 }

common/config/src/lib.rs

@@ -148,6 +148,25 @@ pub trait OptionalSet {
         }
     }
 
+    fn with_validated_optional<F, T, V, E>(
+        self,
+        f: F,
+        value: Option<T>,
+        validate: V,
+    ) -> Result<Self, E>
+    where
+        F: Fn(Self, T) -> Self,
+        V: Fn(&T) -> Result<(), E>,
+        Self: Sized,
+    {
+        if let Some(val) = value {
+            validate(&val)?;
+            Ok(f(self, val))
+        } else {
+            Ok(self)
+        }
+    }
+
     fn with_optional_env<F, T>(self, f: F, val: Option<T>, env_var: &str) -> Self
     where
         F: Fn(Self, T) -> Self,

common/cosmwasm-smart-contracts/coconut-dkg/src/msg.rs

@@ -1,7 +1,7 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::types::{ContractSafeBytes, EncodedBTEPublicKeyWithProof};
+use crate::types::{ContractSafeBytes, EncodedBTEPublicKeyWithProof, TimeConfiguration};
 use crate::verification_key::VerificationKeyShare;
 use cosmwasm_std::Addr;
 use schemars::JsonSchema;
@@ -11,6 +11,7 @@ use serde::{Deserialize, Serialize};
 pub struct InstantiateMsg {
     pub group_addr: String,
     pub multisig_addr: String,
+    pub time_configuration: Option<TimeConfiguration>,
     pub mix_denom: String,
 }
 

common/cosmwasm-smart-contracts/coconut-dkg/src/types.rs

@@ -1,8 +1,10 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use std::fmt::{Display, Formatter};
+use std::str::FromStr;
 
 pub use crate::dealer::{DealerDetails, PagedDealerResponse};
 pub use contracts_common::dealings::ContractSafeBytes;
@@ -12,37 +14,91 @@ pub type EncodedBTEPublicKeyWithProof = String;
 pub type EncodedBTEPublicKeyWithProofRef<'a> = &'a str;
 pub type NodeIndex = u64;
 
-// The time sign-up is open for dealers to join (2 minutes)
-pub const PUBLIC_KEY_SUBMISSION_TIME_SECS: u64 = 60 * 2;
-pub const DEALING_EXCHANGE_TIME_SECS: u64 = 60 * 5;
-pub const VERIFICATION_KEY_SUBMISSION_TIME_SECS: u64 = 60 * 5;
-pub const VERIFICATION_KEY_VALIDATION_TIME_SECS: u64 = 60;
-pub const VERIFICATION_KEY_FINALIZATION_TIME_SECS: u64 = 60;
-// The time an epoch lasts (2 weeks)
-pub const IN_PROGRESS_TIME_SECS: u64 = 60 * 60 * 24 * 14;
-
 // 2 public attributes, 2 private attributes, 1 fixed for coconut credential
 pub const TOTAL_DEALINGS: usize = 2 + 2 + 1;
 
+#[derive(
+    Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq, Ord, PartialOrd, JsonSchema,
+)]
+pub struct TimeConfiguration {
+    // The time sign-up is open for dealers to join
+    pub public_key_submission_time_secs: u64,
+    pub dealing_exchange_time_secs: u64,
+    pub verification_key_submission_time_secs: u64,
+    pub verification_key_validation_time_secs: u64,
+    pub verification_key_finalization_time_secs: u64,
+    // The time an epoch lasts
+    pub in_progress_time_secs: u64,
+}
+
+impl FromStr for TimeConfiguration {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let times = s
+            .split(',')
+            .map(|t| t.parse())
+            .collect::<Result<Vec<u64>, _>>()
+            .map_err(|_| String::from("Could not parse string"))?;
+        if times.len() != 6 {
+            Err(String::from("Not enough time specified"))
+        } else {
+            Ok(TimeConfiguration {
+                public_key_submission_time_secs: times[0],
+                dealing_exchange_time_secs: times[1],
+                verification_key_submission_time_secs: times[2],
+                verification_key_validation_time_secs: times[3],
+                verification_key_finalization_time_secs: times[4],
+                in_progress_time_secs: times[5],
+            })
+        }
+    }
+}
+
+impl Default for TimeConfiguration {
+    fn default() -> Self {
+        Self {
+            public_key_submission_time_secs: 60 * 10,      // 10 minutes
+            dealing_exchange_time_secs: 60 * 5,            // 5 minutes
+            verification_key_submission_time_secs: 60 * 5, // 5 minutes
+            verification_key_validation_time_secs: 60,     // 1 minute
+            verification_key_finalization_time_secs: 60,   // 1 minute
+            in_progress_time_secs: 60 * 60 * 24 * 14,      // 2 weeks
+        }
+    }
+}
+
 #[derive(Serialize, Deserialize, Default, Clone, Copy, Debug, PartialEq, Eq, Ord, PartialOrd)]
 #[serde(rename_all = "snake_case")]
 pub struct Epoch {
     pub state: EpochState,
+    pub time_configuration: TimeConfiguration,
     pub finish_timestamp: Timestamp,
 }
 
 impl Epoch {
-    pub fn new(state: EpochState, current_timestamp: Timestamp) -> Self {
+    pub fn new(
+        state: EpochState,
+        time_configuration: TimeConfiguration,
+        current_timestamp: Timestamp,
+    ) -> Self {
         let duration = match state {
-            EpochState::PublicKeySubmission => PUBLIC_KEY_SUBMISSION_TIME_SECS,
-            EpochState::DealingExchange => DEALING_EXCHANGE_TIME_SECS,
-            EpochState::VerificationKeySubmission => VERIFICATION_KEY_SUBMISSION_TIME_SECS,
-            EpochState::VerificationKeyValidation => VERIFICATION_KEY_VALIDATION_TIME_SECS,
-            EpochState::VerificationKeyFinalization => VERIFICATION_KEY_FINALIZATION_TIME_SECS,
-            EpochState::InProgress => IN_PROGRESS_TIME_SECS,
+            EpochState::PublicKeySubmission => time_configuration.public_key_submission_time_secs,
+            EpochState::DealingExchange => time_configuration.dealing_exchange_time_secs,
+            EpochState::VerificationKeySubmission => {
+                time_configuration.verification_key_submission_time_secs
+            }
+            EpochState::VerificationKeyValidation => {
+                time_configuration.verification_key_validation_time_secs
+            }
+            EpochState::VerificationKeyFinalization => {
+                time_configuration.verification_key_finalization_time_secs
+            }
+            EpochState::InProgress => time_configuration.in_progress_time_secs,
         };
         Epoch {
             state,
+            time_configuration,
             finish_timestamp: current_timestamp.plus_seconds(duration),
         }
     }

common/cosmwasm-smart-contracts/contracts-common/src/dealings.rs

@@ -31,7 +31,7 @@ impl Display for ContractSafeBytes {
             write!(f, "0x")?;
         }
         for byte in self.0.iter().take(MAX_DISPLAY_SIZE) {
-            write!(f, "{:02X}", byte)?;
+            write!(f, "{byte:02X}")?;
         }
         // just some sanity safeguards
         if self.0.len() > MAX_DISPLAY_SIZE {