rustfmt

.github/CODEOWNERS

@@ -11,25 +11,30 @@
 # In each subsection folders are ordered first by depth, then alphabetically.
 # This should make it easy to add new rules without breaking existing ones.
 
-# contracts
-/contracts/mixnet @durch @jstuczyn
-/contracts/vesting @durch @jstuczyn
-/contracts/service-provider-directory @octol
+# Something weird not covered by anything else
+* @futurechimp @mmsinclair
 
-# crypto code
-/common/crypto/ @jstuczyn
-/common/nymcoconut/ @jstuczyn
-/common/dkg/ @jstuczyn
-/common/nymsphinx/ @jstuczyn
+# Rust rules:
+*.rs @durch @futurechimp @jstuczyn @neacsu @octol
+Cargo.* @durch @futurechimp @jstuczyn @neacsu @octol
 
-# rust sdk
-/sdk/rust/ @octol
+# JS rules:
+*.js @mmsinclair @fmtabbara
+*.ts @mmsinclair @fmtabbara
+*.tsx @mmsinclair @fmtabbara
+*.jsx @mmsinclair @fmtabbara
 
-# nym-connect (rust)
-/nym-connect/desktop/src-tauri/ @octol
+# Something looking like possible documentation rules:
+*.md @mfahampshire
 
-# nym-wallet (rust)
-/nym-wallet/src-tauri/ @octol
+# our docker scripts
+/docker/ @neacsu
 
-# documentation
-/documentation @mfahampshire
+# if there are any changes in the core crypto, I feel like Ania should take a look:
+/common/crypto/ @aniampio
+/common/nymsphinx/ @aniampio
+
+# Explorer and wallet should probably get looked by the product team
+/explorer/ @nymtech/product 
+/nym-wallet/ @nymtech/product 
+/wallet-web/ @nymtech/product

.github/ISSUE_TEMPLATE/documentation.md

@@ -1,14 +0,0 @@
----
-name: 'Documentation'
-about: Suggest a fix or enhancement to the documentation or developer portal content
-title: "[DOCS]"
-labels: documentation
-assignees: mfahampshire
-
----
-
-Is your issue either: 
-- [ ] a fix to existing documentation (e.g. fixing a broken link or incorrect command) 
-- [ ] an enhancement (e.g. adding a description for an undocumented feature)
-
-Please briefly describe your issue:

.github/dependabot.yml

@@ -1,16 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  # Maintain dependencies for GitHub Actions
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"
-    commit-message:
-        prefix: build
-        prefix-development: chore
-        include: scope

.github/workflows/build-and-upload-binaries-ci.yml

@@ -63,7 +63,7 @@ jobs:
       - name: Install Rust stable
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.69.0
+          toolchain: stable
 
       - name: Build all binaries
         uses: actions-rs/cargo@v1
@@ -74,7 +74,7 @@ jobs:
       - name: Install Rust stable
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.69.0
+          toolchain: stable
           target: wasm32-unknown-unknown
           override: true
           components: rustfmt, clippy
@@ -98,7 +98,7 @@ jobs:
           cp target/release/nym-network-requester $OUTPUT_DIR
           cp target/release/nym-network-statistics $OUTPUT_DIR
           cp target/release/nym-cli $OUTPUT_DIR
-          cp target/release/nym-credential-client $OUTPUT_DIR
+          cp target/release/credential $OUTPUT_DIR
           cp target/release/explorer-api $OUTPUT_DIR
           
           cp contracts/target/wasm32-unknown-unknown/release/mixnet_contract.wasm $OUTPUT_DIR

.github/workflows/build.yml

@@ -9,14 +9,12 @@ on:
       - 'gateway/**'
       - 'integrations/**'
       - 'mixnode/**'
-      - 'sdk/lib/socks5-listener/**'
       - 'sdk/rust/nym-sdk/**'
       - 'service-providers/**'
       - 'nym-api/**'
       - 'nym-outfox/**'
       - 'tools/nym-cli/**'
       - 'tools/ts-rs-cli/**'
-      - 'Cargo.toml'
   pull_request:
     paths:
       - 'clients/**'
@@ -25,14 +23,12 @@ on:
       - 'gateway/**'
       - 'integrations/**'
       - 'mixnode/**'
-      - 'sdk/lib/socks5-listener/**'
       - 'sdk/rust/nym-sdk/**'
       - 'service-providers/**'
       - 'nym-api/**'
       - 'nym-outfox/**'
       - 'tools/nym-cli/**'
       - 'tools/ts-rs-cli/**'
-      - 'Cargo.toml'
 
 jobs:
   build:

.github/workflows/cd-dev.yml

@@ -1,76 +0,0 @@
-name: CD dev-portal
-
-on:
-  push:
-    branches: master
-    paths:
-      - 'documentation/dev-portal/**'
-
-jobs:
-  build:
-    runs-on: custom-runner-linux
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install rsync
-        run: sudo apt-get install rsync
-      - uses: rlespinasse/github-slug-action@v3.x
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "16"
-      - name: Install Rust stable
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-      - name: Install mdbook
-        run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook)
-      - name: Install mdbook plugins
-        run: |
-          cargo install --vers "^0.2.0" mdbook-variables && cargo install \
-            --vers "^1.8.0" mdbook-admonish && cargo install --vers \
-            "^0.1.2" mdbook-last-changed && cargo install --vers "^0.1.2" \
-            mdbook-theme && cargo install --vers "^0.7.7" mdbook-linkcheck
-      - name: Clean website
-        run: cd documentation/dev-portal && mdbook clean
-      - name: Build website
-        run: cd documentation/dev-portal && mdbook build
-      - name: Deploy branch master to dev
-        continue-on-error: true
-        uses: easingthemes/ssh-deploy@main
-        env:
-          SSH_PRIVATE_KEY: ${{ secrets.CD_WWW_SSH_PRIVATE_KEY }}
-          ARGS: "-rltgoDzvO --delete"
-          SOURCE: "documentation/dev-portal/book/html/"
-          REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_DEV }}
-          REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
-          TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET_DEVP }}/
-          EXCLUDE: "/dist/, /node_modules/"
-      - name: Deploy branch master to prod
-        uses: easingthemes/ssh-deploy@main
-        env:
-          SSH_PRIVATE_KEY: ${{ secrets.CD_WWW_SSH_PRIVATE_KEY }}
-          ARGS: "-rltgoDzvO --delete"
-          SOURCE: "documentation/dev-portal/book/html/"
-          REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_PROD }}
-          REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
-          TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET_DEVP }}/
-          EXCLUDE: "/dist/, /node_modules/"
-      - name: Matrix - Node Install
-        run: npm install
-        working-directory: .github/workflows/support-files
-      - name: Matrix - Send Notification
-        env:
-          NYM_NOTIFICATION_KIND: cd-dev
-          NYM_PROJECT_NAME: "Dev portal CD"
-          NYM_CI_WWW_BASE: "${{ secrets.NYM_CD_WWW_BASE }}"
-          NYM_CI_WWW_LOCATION: "${{ env.GITHUB_REF_SLUG }}"
-          GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
-          GIT_BRANCH: "${GITHUB_REF##*/}"
-          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_DEVP }}"
-          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
-          IS_SUCCESS: "${{ job.status == 'success' }}"
-        uses: docker://keybaseio/client:stable-node
-        with:
-          args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/cd-docs.yml

@@ -1,82 +0,0 @@
-name: CD docs
-
-on:
-  push:
-    branches: master
-    paths:
-      - 'documentation/docs/**'
-
-jobs:
-  build:
-    runs-on: custom-runner-linux
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install rsync
-        run: sudo apt-get install rsync
-      - uses: rlespinasse/github-slug-action@v3.x
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "16"
-      - name: Install Rust stable
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-      - name: Build all binaries
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --workspace --release --all
-      - name: Install mdbook
-        run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook)
-      - name: Install mdbook plugins
-        run: |
-          cargo install --vers "^0.2.0" mdbook-variables && cargo install \
-            --vers "^1.8.0" mdbook-admonish && cargo install --vers \
-            "^0.1.2" mdbook-last-changed && cargo install --vers "^0.1.2" \
-            mdbook-theme && cargo install --vers "^0.7.7" mdbook-linkcheck && \
-            cargo install --vers "^0.5.0" mdbook-cmdrun
-      - name: Clean website
-        run: cd documentation/docs && mdbook clean
-      - name: Build website
-        run: cd documentation/docs && mdbook build
-      - name: Deploy branch master to dev
-        continue-on-error: true
-        uses: easingthemes/ssh-deploy@main
-        env:
-          SSH_PRIVATE_KEY: ${{ secrets.CD_WWW_SSH_PRIVATE_KEY }}
-          ARGS: "-rltgoDzvO --delete"
-          SOURCE: "documentation/docs/book/"
-          REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_DEV }}
-          REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
-          TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET }}/
-          EXCLUDE: "/dist/, /node_modules/"
-      - name: Deploy branch master to prod
-        uses: easingthemes/ssh-deploy@main
-        env:
-          SSH_PRIVATE_KEY: ${{ secrets.CD_WWW_SSH_PRIVATE_KEY }}
-          ARGS: "-rltgoDzvO --delete"
-          SOURCE: "documentation/docs/book/"
-          REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_PROD }}
-          REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
-          TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET }}/
-          EXCLUDE: "/dist/, /node_modules/"
-      - name: Matrix - Node Install
-        run: npm install
-        working-directory: .github/workflows/support-files
-      - name: Matrix - Send Notification
-        env:
-          NYM_NOTIFICATION_KIND: cd-docs
-          NYM_PROJECT_NAME: "Docs CD"
-          NYM_CI_WWW_BASE: "${{ secrets.NYM_CD_WWW_BASE }}"
-          NYM_CI_WWW_LOCATION: "${{ env.GITHUB_REF_SLUG }}"
-          GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
-          GIT_BRANCH: "${GITHUB_REF##*/}"
-          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_DOCS }}"
-          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
-          IS_SUCCESS: "${{ job.status == 'success' }}"
-        uses: docker://keybaseio/client:stable-node
-        with:
-          args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/ci-dev.yml

@@ -1,66 +0,0 @@
-name: CI dev-portal
-
-on:
-  push:
-    branches-ignore: master
-    paths:
-      - 'documentation/dev-portal/**'
-
-jobs:
-  build:
-    runs-on: custom-runner-linux
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install rsync
-        run: sudo apt-get install rsync
-      - uses: rlespinasse/github-slug-action@v3.x
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "16"
-      - name: Install Rust stable
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-      - name: Install mdbook
-        run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook)
-      - name: Install mdbook plugins
-        run: |
-          cargo install --vers "^0.2.0" mdbook-variables && cargo install \
-            --vers "^1.8.0" mdbook-admonish && cargo install --vers \
-            "^0.1.2" mdbook-last-changed && cargo install --vers "^0.1.2" mdbook-theme \
-            && cargo install --vers "^0.7.7" mdbook-linkcheck 
-      - name: Clean website
-        run: cd documentation/dev-portal && mdbook clean
-      - name: Build website
-        run: cd documentation/dev-portal && mdbook build
-      - name: Deploy branch to CI www
-        continue-on-error: true
-        uses: easingthemes/ssh-deploy@main
-        env:
-          SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
-          ARGS: "-rltgoDzvO --delete"
-          SOURCE: "documentation/dev-portal/book/html/"
-          REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
-          REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
-          TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/dev-portal-${{ env.GITHUB_REF_SLUG }}
-          EXCLUDE: "/dist/, /node_modules/"
-      - name: Matrix - Node Install
-        run: npm install
-        working-directory: .github/workflows/support-files
-      - name: Matrix - Send Notification
-        env:
-          NYM_NOTIFICATION_KIND: ci-dev
-          NYM_PROJECT_NAME: "Dev portal CI"
-          NYM_CI_WWW_BASE: "${{ secrets.NYM_CI_WWW_BASE }}"
-          NYM_CI_WWW_LOCATION: "dev-portal-${{ env.GITHUB_REF_SLUG }}"
-          GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
-          GIT_BRANCH: "${GITHUB_REF##*/}"
-          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_DEVP }}"
-          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
-          IS_SUCCESS: "${{ job.status == 'success' }}"
-        uses: docker://keybaseio/client:stable-node
-        with:
-          args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/ci-docs.yml

@@ -1,72 +0,0 @@
-name: CI docs
-
-on:
-  push:
-    branches-ignore: master
-    paths:
-      - 'documentation/docs/**'
-
-jobs:
-  build:
-    runs-on: custom-runner-linux
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install rsync
-        run: sudo apt-get install rsync
-      - uses: rlespinasse/github-slug-action@v3.x
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "16"
-      - name: Install Rust stable
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-      - name: Build all binaries
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --workspace --release --all
-      - name: Install mdbook
-        run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook)
-      - name: Install mdbook plugins
-        run: |
-          cargo install --vers "^0.2.0" mdbook-variables && cargo install \
-            --vers "^1.8.0" mdbook-admonish && cargo install --vers \
-            "^0.1.2" mdbook-last-changed && cargo install --vers "^0.1.2" \
-            mdbook-theme && cargo install --vers "^0.7.7" mdbook-linkcheck && \
-            cargo install --vers "^0.5.0" mdbook-cmdrun
-      - name: Clean website
-        run: cd documentation/docs && mdbook clean
-      - name: Build website
-        run: cd documentation/docs && mdbook build
-      - name: Deploy branch to CI www
-        continue-on-error: true
-        uses: easingthemes/ssh-deploy@main
-        env:
-          SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
-          ARGS: "-rltgoDzvO --delete"
-          SOURCE: "documentation/docs/book/"
-          REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
-          REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
-          TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/docs-${{ env.GITHUB_REF_SLUG }}
-          EXCLUDE: "/dist/, /node_modules/"
-      - name: Matrix - Node Install
-        run: npm install
-        working-directory: .github/workflows/support-files
-      - name: Matrix - Send Notification
-        env:
-          NYM_NOTIFICATION_KIND: ci-docs
-          NYM_PROJECT_NAME: "Docs CI"
-          NYM_CI_WWW_BASE: "${{ secrets.NYM_CI_WWW_BASE }}"
-          NYM_CI_WWW_LOCATION: "docs-${{ env.GITHUB_REF_SLUG }}"
-          GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
-          GIT_BRANCH: "${GITHUB_REF##*/}"
-          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_DOCS }}"
-          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
-          IS_SUCCESS: "${{ job.status == 'success' }}"
-        uses: docker://keybaseio/client:stable-node
-        with:
-          args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/connect-android-build.yml

@@ -0,0 +1,138 @@
+name: Nym Connect - Android APK Build
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "release/nc-android-v[0-9].[0-9].[0-9]*"
+
+jobs:
+  build:
+    name: Build APK
+    runs-on: custom-runner-linux
+    env:
+      ANDROID_HOME: ${{ github.workspace }}/android-sdk
+      NDK_VERSION: 25.1.8937393
+      NDK_HOME: ${{ github.workspace }}/android-sdk/ndk/25.1.8937393
+      SDK_PLATFORM_VERSION: android-33
+      SDK_BUILDTOOLS_VERSION: 33.0.1
+
+    steps:
+      - name: Install Dependencies (Linux)
+        # https://next--tauri.netlify.app/next/guides/getting-started/prerequisites/linux/#1-system-dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install \
+          build-essential \
+          unzip \
+          curl \
+          wget \
+          libssl-dev \
+          squashfs-tools \
+          librsvg2-dev
+
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: "temurin"
+          java-version: "17"
+
+      - name: Install Android SDK manager
+        # https://developer.android.com/studio/command-line/sdkmanager
+        run: |
+          curl -sS https://dl.google.com/android/repository/commandlinetools-linux-9477386_latest.zip -o cmdline-tools.zip
+          unzip cmdline-tools.zip
+          mkdir -p $ANDROID_HOME/cmdline-tools/latest
+          mv cmdline-tools/* $ANDROID_HOME/cmdline-tools/latest
+          rm -rf cmdline-tools
+
+      - name: Install Android S/NDK
+        run: |
+          echo y | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses
+          echo y | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager \
+            "platforms;$SDK_PLATFORM_VERSION" \
+            "platform-tools" \
+            "ndk;$NDK_VERSION" \
+            "build-tools;$SDK_BUILDTOOLS_VERSION"
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      # TODO this step takes a considerable amount of time
+      # We could avoid to compile from source tauri-cli and use instead
+      # pre-compiled binary provided by the node package `@tauri-apps/cli`
+      # But when using the later the build fails for some reason
+      # so keep installing and using tauri-cli
+      - name: Install tauri cli
+        run: cargo install tauri-cli --version "^2.0.0-alpha.2"
+
+      - name: Install rust android targets
+        run: |
+          rustup target add aarch64-linux-android \
+            armv7-linux-androideabi \
+            i686-linux-android \
+            x86_64-linux-android
+
+      - name: Setup Nodejs
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install yarn
+        run: |
+          npm i -g yarn
+          yarn --version
+
+      - name: Build frontend code
+        run: |
+          yarn install --frozen-lockfile
+          yarn build
+          yarn workspace @nym/nym-connect-mobile webpack:prod
+
+      - name: Build APK
+        working-directory: nym-connect/mobile
+        env:
+          # NODE_TAURI_CLI=${{ github.workspace }}/nym-connect/mobile/node_modules/.bin/tauri
+          ANDROID_SDK_ROOT: ${{ env.ANDROID_HOME }}
+          WRY_ANDROID_PACKAGE: net.nymtech.nym_connect
+          WRY_ANDROID_LIBRARY: nym_connect
+        # TODO build with release profile (--release), it will requires
+        # to sign the APK. For now build with debug profile to avoid that
+        # TODO build using `yarn tauri`, provide NODE_TAURI_CLI, see TODO notes above
+        run: cargo tauri android build --debug --apk --split-per-abi -t aarch64
+
+      # TODO add the version number to APK name
+      - name: Rename APK artifact
+        run: |
+          mkdir apk/
+          mv nym-connect/mobile/src-tauri/gen/android/nym_connect/app/build/outputs/apk/arm64/debug/app-arm64-debug.apk \
+            apk/nym-connect-arm64-debug.apk
+          mv nym-connect/mobile/src-tauri/gen/android/nym_connect/app/build/outputs/apk/x86_64/debug/app-x86_64-debug.apk \
+            apk/nym-connect-x86_64-debug.apk
+
+      - name: Upload APK artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: nc-apk-debug
+          path: |
+            apk/nym-connect-arm64-debug.apk
+            apk/nym-connect-x86_64-debug.apk
+
+  # publish:
+  #   name: Publish APK
+  #   needs: build
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+  #     - name: Download binary artifact
+  #       uses: actions/download-artifact@v3
+  #       with:
+  #         name: nc-apk-debug
+  #         path: apk
+  #     # TODO add a step to upload the APK somewhere
+  #     - name: Publish
+  #       uses: ???

.github/workflows/contracts.yml

@@ -30,7 +30,6 @@ jobs:
     continue-on-error: ${{ matrix.rust == 'nightly' }}
     needs: matrix_prep
     strategy:
-      fail-fast: false
       matrix: ${{fromJson(needs.matrix_prep.outputs.matrix)}}
     steps:
       - uses: actions/checkout@v2
@@ -64,4 +63,4 @@ jobs:
         if: ${{ matrix.rust != 'nightly' }}
         with:
           command: clippy
-          args: --manifest-path contracts/Cargo.toml --workspace --all-targets -- -D warnings
+          args: --manifest-path contracts/Cargo.toml --workspace -- -D warnings

.github/workflows/greetings.yml

@@ -1,13 +0,0 @@
-name: Greetings
-
-on: [pull_request_target, issues]
-
-jobs:
-  greeting:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/first-interaction@v1
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        issue-message: 'Thank you for raising this issue'
-        pr-message: 'Thank you for making this first PR'

.github/workflows/nightly_build_matrix_includes.json

@@ -6,7 +6,7 @@
   },
 
   {
-    "os":"windows10",
+    "os":"windows-latest",
     "rust":"stable",
     "runOnEvent":"schedule"
   },
@@ -22,7 +22,7 @@
     "runOnEvent":"schedule"
   },
   {
-    "os":"windows10",
+    "os":"windows-latest",
     "rust":"beta",
     "runOnEvent":"schedule"
   },
@@ -38,7 +38,7 @@
     "runOnEvent":"schedule"
   },
   {
-    "os":"windows10",
+    "os":"windows-latest",
     "rust":"nightly",
     "runOnEvent":"schedule"
   },

.github/workflows/nyms5-android-build.yml

@@ -1,102 +0,0 @@
-name: Nyms5 Android
-# unsigned APKs only, supported archs:
-# - arm64-v8a (arm64)
-# - x86_64
-
-on:
-  workflow_dispatch:
-  push:
-    tags:
-      - nyms5-android-v*
-
-jobs:
-  build:
-    name: Build APK
-    runs-on: custom-runner-linux
-    env:
-      ANDROID_HOME: ${{ github.workspace }}/android-sdk
-      NDK_VERSION: 25.2.9519653
-      NDK_HOME: ${{ github.workspace }}/android-sdk/ndk/25.2.9519653
-      SDK_PLATFORM_VERSION: android-33
-      SDK_BUILDTOOLS_VERSION: 33.0.2
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Install Java
-        uses: actions/setup-java@v3
-        with:
-          distribution: "temurin"
-          java-version: "17"
-
-      - name: Install Android SDK manager
-        # https://developer.android.com/studio/command-line/sdkmanager
-        run: |
-          curl -sS https://dl.google.com/android/repository/commandlinetools-linux-9477386_latest.zip -o cmdline-tools.zip
-          unzip cmdline-tools.zip
-          mkdir -p $ANDROID_HOME/cmdline-tools/latest
-          mv cmdline-tools/* $ANDROID_HOME/cmdline-tools/latest
-          rm -rf cmdline-tools
-
-      - name: Install Android S/NDK
-        run: |
-          echo y | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses
-          echo y | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager \
-            "platforms;$SDK_PLATFORM_VERSION" \
-            "platform-tools" \
-            "ndk;$NDK_VERSION" \
-            "build-tools;$SDK_BUILDTOOLS_VERSION"
-
-      - name: Install Rust toolchain
-        uses: dtolnay/rust-toolchain@stable
-
-      - name: Install rust android targets
-        run: |
-          rustup target add aarch64-linux-android \
-            x86_64-linux-android
-
-      - name: Build lib nym-socks5-listener
-        working-directory: sdk/lib/socks5-listener/
-        env:
-          RELEASE: true
-        # build for arm64 and x86_64
-        run: ./build-android.sh aarch64 x86_64
-
-      - name: Build APKs (unsigned)
-        working-directory: nym-connect/native/android
-        env:
-          ANDROID_SDK_ROOT: ${{ env.ANDROID_HOME }}
-        # build for arm64 and x86_64
-        run: ./gradlew :app:assembleArch64Release
-
-      - name: Prepare APKs
-        run: |
-          mkdir apk
-          mv nym-connect/native/android/app/build/outputs/apk/arch64/release/app-arch64-release-unsigned.apk \
-            apk/nyms5-arch64-release.apk
-
-      - name: Upload APKs
-        uses: actions/upload-artifact@v3
-        with:
-          name: nyms5-apk-arch64-release
-          path: |
-            apk/nyms5-arch64-release.apk
-
-  gh-release:
-    name: Publish APK (GH release)
-    needs: build
-    runs-on: custom-runner-linux
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Download binary artifact
-        uses: actions/download-artifact@v3
-        with:
-          name: nyms5-apk-arch64-release
-          path: apk
-      - name: Release
-        uses: softprops/action-gh-release@v1
-        with:
-          files: apk/nyms5-arch64-release.apk
-

.github/workflows/support-files/cd-dev/index.js

@@ -1,29 +0,0 @@
-const Handlebars = require('handlebars');
-const fs = require('fs');
-const path = require('path');
-
-async function addToContextAndValidate(context) {
-  if (!context.env.NYM_CI_WWW_LOCATION) {
-    throw new Error('Please ensure the env var NYM_CI_WWW_LOCATION is set');
-  }
-  if (!context.env.NYM_CI_WWW_BASE) {
-    throw new Error('Please ensure the env var NYM_CI_WWW_BASE is set');
-  }
-}
-
-async function getMessageBody(context) {
-  const source = fs
-    .readFileSync(
-      context.env.IS_SUCCESS === 'true'
-        ? path.resolve(__dirname, 'templates', 'success')
-        : path.resolve(__dirname, 'templates', 'failure'),
-    )
-    .toString();
-  const template = Handlebars.compile(source);
-  return template(context);
-}
-
-module.exports = {
-  addToContextAndValidate,
-  getMessageBody,
-};

.github/workflows/support-files/cd-dev/templates/failure

@@ -1,17 +0,0 @@
-🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
-> :rocket: {{ env.NYM_PROJECT_NAME }}
->
-> 🔴 **FAILURE** :cry:
->
-> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
->
-> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
->
-> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
->
-
-Commit message:
-
-```
-{{ env.GIT_COMMIT_MESSAGE }}
-```

.github/workflows/support-files/cd-dev/templates/success

@@ -1,17 +0,0 @@
-🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
-> :rocket: {{ env.NYM_PROJECT_NAME }}  ➡️➡️➡️➡️➡️ **View output:** https://{{ env.NYM_CI_WWW_BASE }}/developers/
->
-> ✅ **SUCCESS**
->
-> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
->
-> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
->
-> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
->
-
-Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
-
-```
-{{ env.GIT_COMMIT_MESSAGE }}
-```

.github/workflows/support-files/cd-docs/index.js

@@ -1,29 +0,0 @@
-const Handlebars = require('handlebars');
-const fs = require('fs');
-const path = require('path');
-
-async function addToContextAndValidate(context) {
-  if (!context.env.NYM_CI_WWW_LOCATION) {
-    throw new Error('Please ensure the env var NYM_CI_WWW_LOCATION is set');
-  }
-  if (!context.env.NYM_CI_WWW_BASE) {
-    throw new Error('Please ensure the env var NYM_CI_WWW_BASE is set');
-  }
-}
-
-async function getMessageBody(context) {
-  const source = fs
-    .readFileSync(
-      context.env.IS_SUCCESS === 'true'
-        ? path.resolve(__dirname, 'templates', 'success')
-        : path.resolve(__dirname, 'templates', 'failure'),
-    )
-    .toString();
-  const template = Handlebars.compile(source);
-  return template(context);
-}
-
-module.exports = {
-  addToContextAndValidate,
-  getMessageBody,
-};

.github/workflows/support-files/cd-docs/templates/failure

@@ -1,11 +0,0 @@
-🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
-> :rocket: {{ env.NYM_PROJECT_NAME }}
-> 🔴 **FAILURE** :cry:
-> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
-> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
-> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
-
-Commit message:
-```
-{{ env.GIT_COMMIT_MESSAGE }}
-```

.github/workflows/support-files/cd-docs/templates/success

@@ -1,17 +0,0 @@
-🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
-> :rocket: {{ env.NYM_PROJECT_NAME }}  ➡️➡️➡️➡️➡️ **View output:** https://{{ env.NYM_CI_WWW_BASE }}/docs/
->
-> ✅ **SUCCESS**
->
-> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
->
-> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
->
-> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
->
-
-Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
-
-```
-{{ env.GIT_COMMIT_MESSAGE }}
-```

.github/workflows/support-files/ci-dev/index.js

@@ -1,29 +0,0 @@
-const Handlebars = require('handlebars');
-const fs = require('fs');
-const path = require('path');
-
-async function addToContextAndValidate(context) {
-  if (!context.env.NYM_CI_WWW_LOCATION) {
-    throw new Error('Please ensure the env var NYM_CI_WWW_LOCATION is set');
-  }
-  if (!context.env.NYM_CI_WWW_BASE) {
-    throw new Error('Please ensure the env var NYM_CI_WWW_BASE is set');
-  }
-}
-
-async function getMessageBody(context) {
-  const source = fs
-    .readFileSync(
-      context.env.IS_SUCCESS === 'true'
-        ? path.resolve(__dirname, 'templates', 'success')
-        : path.resolve(__dirname, 'templates', 'failure'),
-    )
-    .toString();
-  const template = Handlebars.compile(source);
-  return template(context);
-}
-
-module.exports = {
-  addToContextAndValidate,
-  getMessageBody,
-};

.github/workflows/support-files/ci-dev/templates/failure

@@ -1,17 +0,0 @@
-🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
-> :rocket: {{ env.NYM_PROJECT_NAME }}
->
-> 🔴 **FAILURE** :cry:
->
-> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
->
-> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
->
-> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
->
-
-Commit message:
-
-```
-{{ env.GIT_COMMIT_MESSAGE }}
-```

.github/workflows/support-files/ci-dev/templates/success

@@ -1,17 +0,0 @@
-🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
-> :rocket: {{ env.NYM_PROJECT_NAME }}  ➡️➡️➡️➡️➡️ **View output:** https://{{ env.NYM_CI_WWW_LOCATION }}.{{ env.NYM_CI_WWW_BASE }}/
->
-> ✅ **SUCCESS**
->
-> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
->
-> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
->
-> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
->
-
-Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
-
-```
-{{ env.GIT_COMMIT_MESSAGE }}
-```

.github/workflows/support-files/ci-docs/index.js

@@ -1,29 +0,0 @@
-const Handlebars = require('handlebars');
-const fs = require('fs');
-const path = require('path');
-
-async function addToContextAndValidate(context) {
-  if (!context.env.NYM_CI_WWW_LOCATION) {
-    throw new Error('Please ensure the env var NYM_CI_WWW_LOCATION is set');
-  }
-  if (!context.env.NYM_CI_WWW_BASE) {
-    throw new Error('Please ensure the env var NYM_CI_WWW_BASE is set');
-  }
-}
-
-async function getMessageBody(context) {
-  const source = fs
-    .readFileSync(
-      context.env.IS_SUCCESS === 'true'
-        ? path.resolve(__dirname, 'templates', 'success')
-        : path.resolve(__dirname, 'templates', 'failure'),
-    )
-    .toString();
-  const template = Handlebars.compile(source);
-  return template(context);
-}
-
-module.exports = {
-  addToContextAndValidate,
-  getMessageBody,
-};

.github/workflows/support-files/ci-docs/templates/failure

@@ -1,17 +0,0 @@
-🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
-> :rocket: {{ env.NYM_PROJECT_NAME }}
->
-> 🔴 **FAILURE** :cry:
->
-> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
->
-> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
->
-> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
->
-
-Commit message:
-
-```
-{{ env.GIT_COMMIT_MESSAGE }}
-```

.github/workflows/support-files/ci-docs/templates/success

@@ -1,17 +0,0 @@
-🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
-> :rocket: {{ env.NYM_PROJECT_NAME }}  ➡️➡️➡️➡️➡️ **View output:** https://{{ env.NYM_CI_WWW_LOCATION }}.{{ env.NYM_CI_WWW_BASE }}/
->
-> ✅ **SUCCESS**
->
-> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
->
-> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
->
-> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
->
-
-Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
-
-```
-{{ env.GIT_COMMIT_MESSAGE }}
-```

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

@@ -3,7 +3,7 @@ require('dotenv').config();
 const { sendMatrixMessage } = require('./send_message_to_matrix');
 
 let context = {
-  kinds: ['nym-wallet', 'ts-packages', 'network-explorer', 'nightly', 'nym-connect','security','ci-docs','cd-docs','ci-dev','cd-dev'],
+  kinds: ['nym-wallet', 'ts-packages', 'network-explorer', 'nightly', 'nym-connect','security'],
 };
 
 /**

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

@@ -22,6 +22,6 @@
     "unified": "^9.2.2"
   },
   "devDependencies": {
-    "prettier": "^2.8.7"
+    "prettier": "2.3.2"
   }
 }

.github/workflows/upload-nyxd-ci.yml

@@ -1,79 +0,0 @@
-name: Upload nyxd to CI
-
-on:
-  workflow_dispatch:
-
-jobs:
-  publish-nyxd:
-    strategy:
-      fail-fast: false
-      matrix:
-        platform: [ubuntu-20.04]
-
-    runs-on: ${{ matrix.platform }}
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Prepare build output directory
-        shell: bash
-        env:
-          OUTPUT_DIR: ci-builds/nyxd
-        run: |
-          rm -rf ci-builds || true
-          mkdir -p $OUTPUT_DIR
-          echo $OUTPUT_DIR
-
-      - name: Install Dependencies (Linux)
-        run: sudo apt-get update && sudo apt-get -y install build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools git
-        continue-on-error: true
-      
-      - name: Update env variables to include go
-        run: | 
-          sudo rm -rf /usr/local/go
-          curl https://dl.google.com/go/go1.19.2.linux-amd64.tar.gz | sudo tar -C/usr/local -zxvf -
-          cat <<'EOF' >>$HOME/.profile
-          export GOROOT=/usr/local/go
-          export GOPATH=$HOME/go
-          export GO111MODULE=on
-          export PATH=$PATH:/usr/local/go/bin:$HOME/go/bin
-          EOF
-          source $HOME/.profile
-
-      - name: Verify Go is installed
-        run: go version
-
-      - name: Clone nyxd repo
-        run: | 
-          git clone https://github.com/tommyv1987/nyxd
-          cd nyxd
-          git checkout release/v0.30.2
-
-      - name: Run nyxd
-        run: |
-          pwd
-          cd nyxd && make build
-          sleep 10
-          ls /home/runner/work/nym/nym/nyxd/build
-
-      - name: Prepare build output
-        shell: bash
-        env:
-          OUTPUT_DIR: ci-builds/nyxd
-        run: |
-          cp /home/runner/work/nym/nym/nyxd/build/nyxd $OUTPUT_DIR
-          WASMVM_SO=$(ldd /home/runner/work/nym/nym/nyxd/build/nyxd | grep "libwasm*" | awk '{ print $3 }')
-          ls $WASMVM_SO
-          sleep 3
-          cp $(echo $WASMVM_SO) $OUTPUT_DIR
-
-      - name: Deploy nyxd to CI www
-        continue-on-error: true
-        uses: easingthemes/ssh-deploy@main
-        env:
-          SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
-          ARGS: "-avzr"
-          SOURCE: "ci-builds/"
-          REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
-          REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
-          TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/builds/
-          EXCLUDE: "/dist/, /node_modules/"

.github/workflows/wallet.yml

@@ -64,4 +64,4 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --manifest-path nym-wallet/Cargo.toml --workspace --all-features --all-targets -- -D warnings
+          args: --manifest-path nym-wallet/Cargo.toml --workspace --all-features -- -D warnings

.gitignore

@@ -8,7 +8,6 @@
 .idea
 target
 .env
-.env.dev
 /.vscode/settings.json
 validator/.vscode
 sample-configs/validator-config.toml
@@ -42,5 +41,4 @@ storybook-static
 envs/qwerty.env
 .parcel-cache
 **/.DS_Store
-cpu-cycles/libcpucycles/build
-foxyfox.env
+cpu-cycles/libcpucycles/build

CHANGELOG.md

@@ -4,114 +4,18 @@ Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://
 
 ## [Unreleased]
 
-## [v1.1.19] (2023-05-16)
+- nym-network-statistics properly handles signals ([#3209])
+- add socks5 support for Rust SDK ([#3226])
 
-- nym-name-service endpoint in nym-api ([#3403])
-- Implement key storage for WASM client using IndexedDB (for browser) ([#3329])
-- Initial version of nym-name-service contract providing name aliases for nym-addresses ([#3274])
-- Update Cargo.lock ([#3410])
-
-[#3403]: https://github.com/nymtech/nym/issues/3403
-[#3329]: https://github.com/nymtech/nym/issues/3329
-[#3274]: https://github.com/nymtech/nym/issues/3274
-[#3410]: https://github.com/nymtech/nym/pull/3410
-
-## [v1.1.18] (2023-05-09)
-
-- Implement heartbeat messages between socks5 proxy and network requester ([#3215])
-
-[#3215]: https://github.com/nymtech/nym/issues/3215
-
-## [v1.1.17] (2023-05-02)
-
-- Add service-provider-directory-contract support to nym-cli ([#3334])
-- Start using the node-testing-utils (implemented in #3270) in nym-api Network monitor to simplify the logic there ([#3312])
-- Add service-provider-directory support to validator-client ([#3296])
-- Allow topology injection in our WASM client ('test my node' feature) ([#3270])
-- Expose service-provider-directory contract data in nym-api endpoints ([#3242])
-- Cache service provider contract in nym-api ([#3241])
-- Feature/1 1 17 docs ([#3370])
-- adding a test for SP endpoint ([#3367])
-- Feature/store cipher ([#3350])
-
-[#3334]: https://github.com/nymtech/nym/issues/3334
-[#3312]: https://github.com/nymtech/nym/issues/3312
-[#3296]: https://github.com/nymtech/nym/issues/3296
-[#3270]: https://github.com/nymtech/nym/issues/3270
-[#3242]: https://github.com/nymtech/nym/issues/3242
-[#3241]: https://github.com/nymtech/nym/issues/3241
-[#3370]: https://github.com/nymtech/nym/pull/3370
-[#3367]: https://github.com/nymtech/nym/pull/3367
-[#3350]: https://github.com/nymtech/nym/pull/3350
-
-## [v1.1.16] (2023-04-25)
-
-- Explorer - Fix sorting function on Stake Saturation. It is currently working per page and not globally ([#3320])
-- Poisson process gets stuck at too slow rate. Rework to more aggressively up-regulate ([#3309])
-- decrease the logging level of warnings associated with clients dropping packets due to gateway being overloaded (I'd say reduce it to debug/trace) - there are few sources of those, e.g. in real and cover traffic streams ([#3299])
-- Make the buffer size in `AvailableReader` depend on packet sizes the client is using + introduce read timeouts ([#3213])
-- Rust SDK - Support coconut, credential storage etc ([#2755])
-- version bump for next release ([#3349])
-- added coconut credential generation example ([#3339])
-- update mix-node setup docs with node description ([#3325])
-- exposed missing gateway commands in nym-cli ([#3324])
-- make sure to clear inner 'ack_map' in 'GatewaysReader' ([#3300])
-
-[#3320]: https://github.com/nymtech/nym/issues/3320
-[#3309]: https://github.com/nymtech/nym/issues/3309
-[#3299]: https://github.com/nymtech/nym/issues/3299
-[#3213]: https://github.com/nymtech/nym/issues/3213
-[#2755]: https://github.com/nymtech/nym/issues/2755
-[#3349]: https://github.com/nymtech/nym/pull/3349
-[#3339]: https://github.com/nymtech/nym/pull/3339
-[#3325]: https://github.com/nymtech/nym/pull/3325
-[#3324]: https://github.com/nymtech/nym/pull/3324
-[#3300]: https://github.com/nymtech/nym/pull/3300
-
-## [v1.1.15] (2023-04-18)
-
-- Fix verloc being stuck waiting for shutdown signal ([#3250])
-- Introduce `--output json` flag to `sign` command to allow to more easily capture the output ([#3249])
-- Explorer - Dont fetch Service Provider list on Testnet ([#3245])
-- When determining active set, rather than weighting the nodes by just the `stake`, use `stake * performance` ([#3234])
-- Introduce dual packet sizes to our clients (as in use two packet sizes at the same time depending on message size) ([#3189])
-- Experiment with offline signing in our validator client ([#3174])
-- Modify network requester binary to reload `allowed.list` periodically to pull in any changes made upstream without having to restart the service ([#3149])
-- Standardise all `--output json` on binary inits, we pass the output json at different points for different binaries. ([#3080])
-- Service provider directory contract: initial version ([#2759])
-- Fix issue where network-requester run failed on fresh init due to missing allow file ([#3316])
-
-[#3250]: https://github.com/nymtech/nym/issues/3250
-[#3249]: https://github.com/nymtech/nym/issues/3249
-[#3245]: https://github.com/nymtech/nym/issues/3245
-[#3234]: https://github.com/nymtech/nym/issues/3234
-[#3189]: https://github.com/nymtech/nym/issues/3189
-[#3174]: https://github.com/nymtech/nym/issues/3174
-[#3149]: https://github.com/nymtech/nym/issues/3149
-[#3080]: https://github.com/nymtech/nym/issues/3080
-[#2759]: https://github.com/nymtech/nym/issues/2759
-[#3316]: https://github.com/nymtech/nym/pull/3316
-
-## [v1.1.14] (2023-04-04)
-
-- Investigate cause of qwerty validator being in invalid rewarding state ([#3224])
-- Fix NR config due to changes in #3199 ([#3223])
-- [Issue] Mixnodes and gateway do not close connections properly  ([#3187])
-- disable sign-ext when using wasm-opt + update wasm-opt ([#3203])
-- chore: tidy up client `Debug` config section ([#3199])
-
-[#3224]: https://github.com/nymtech/nym/issues/3224
-[#3223]: https://github.com/nymtech/nym/issues/3223
-[#3187]: https://github.com/nymtech/nym/issues/3187
-[#3203]: https://github.com/nymtech/nym/pull/3203
-[#3199]: https://github.com/nymtech/nym/pull/3199
->>>>>>> master
+[#3209]: https://github.com/nymtech/nym/issues/3209
+[#3226]: https://github.com/nymtech/nym/pull/3226
 
 ## [v1.1.13] (2023-03-15)
 
 - NE - instead of throwing a "Mixnode/Gateway not found" error for blacklisted nodes due to bad performance, show their history but tag them as "Having poor performance" ([#2979])
 - NE - Upgrade Sandbox and make below changes:  ([#2332])
 - Explorer - Updates ([#3168])
+- Fix contracts and nym-api audit findings ([#3026])
 - Website v2 - deploy infrastructure for strapi and CI ([#2213])
 - add blockstream green to sp list ([#3180])
 - mock-nym-api: fix .storybook lint error ([#3178])
@@ -120,6 +24,7 @@ Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://
 [#2979]: https://github.com/nymtech/nym/issues/2979
 [#2332]: https://github.com/nymtech/nym/issues/2332
 [#3168]: https://github.com/nymtech/nym/issues/3168
+[#3026]: https://github.com/nymtech/nym/issues/3026
 [#2213]: https://github.com/nymtech/nym/issues/2213
 [#3180]: https://github.com/nymtech/nym/pull/3180
 [#3178]: https://github.com/nymtech/nym/pull/3178

Cargo.toml

@@ -21,8 +21,6 @@ members = [
     "clients/native",
     "clients/native/websocket-requests",
     "clients/socks5",
-    "common/async-file-watcher",
-    "common/bandwidth-controller",
     "common/bin-common",
     "common/client-core",
     "common/client-libs/gateway-client",
@@ -37,9 +35,8 @@ members = [
     "common/cosmwasm-smart-contracts/group-contract",
     "common/cosmwasm-smart-contracts/mixnet-contract",
     "common/cosmwasm-smart-contracts/multisig-contract",
-    "common/cosmwasm-smart-contracts/name-service",
-    "common/cosmwasm-smart-contracts/service-provider-directory",
     "common/cosmwasm-smart-contracts/vesting-contract",
+    "common/mobile-storage",
     "common/credential-storage",
     "common/credentials",
     "common/crypto",
@@ -49,7 +46,6 @@ members = [
     "common/ledger",
     "common/mixnode-common",
     "common/network-defaults",
-    "common/node-tester-utils",
     "common/nonexhaustive-delayqueue",
     "common/nymcoconut",
     "common/nymsphinx",
@@ -61,14 +57,12 @@ members = [
     "common/nymsphinx/forwarding",
     "common/nymsphinx/framing",
     "common/nymsphinx/params",
-    "common/nymsphinx/routing",
     "common/nymsphinx/types",
     "common/pemstore",
     "common/socks5-client-core",
     "common/socks5/proxy-helpers",
     "common/socks5/requests",
     "common/statistics",
-    "common/store-cipher",
     "common/task",
     "common/topology",
     "common/types",
@@ -78,7 +72,6 @@ members = [
     "gateway/gateway-requests",
     "integrations/bity",
     "mixnode",
-    "sdk/lib/socks5-listener",
     "sdk/rust/nym-sdk",
     "service-providers/common",
     "service-providers/network-requester",
@@ -113,7 +106,6 @@ license = "Apache-2.0"
 
 [workspace.dependencies]
 async-trait = "0.1.64"
-anyhow = "1.0.71"
 bip39 = { version = "2.0.0", features = ["zeroize"] }
 cfg-if = "1.0.0"
 cosmwasm-derive = "=1.0.0"
@@ -127,7 +119,6 @@ cw3 = { version = "=0.13.4" }
 cw3-fixed-multisig = { version = "=0.13.4" }
 cw4 = { version = "=0.13.4" }
 dotenvy = "0.15.6"
-generic-array = "0.14.7"
 lazy_static = "1.4.0"
 log = "0.4"
 once_cell = "1.7.2"
@@ -138,4 +129,3 @@ tap = "1.0.1"
 thiserror = "1.0.38"
 tokio = "1.24.1"
 url = "2.2"
-zeroize = "1.6.0"

Makefile

@@ -9,14 +9,6 @@ no-clippy: build cargo-test wasm fmt
 
 happy: fmt clippy-happy test
 
-# Building release binaries is a little manual as we can't just build --release
-# on all workspaces.
-build-release: build-release-main wasm
-
-# Deprecated
-# For backwards compatibility
-clippy-all: clippy
-
 # -----------------------------------------------------------------------------
 # Define targets for a given workspace
 #  $(1): name
@@ -31,37 +23,29 @@ clippy-happy-$(1):
 clippy-$(1):
 	cargo clippy --manifest-path $(2)/Cargo.toml --workspace $(3) -- -D warnings
 
-clippy-examples-$(1):
+clippy-$(1)-examples:
 	cargo clippy --manifest-path $(2)/Cargo.toml --workspace --examples -- -D warnings
 
-check-$(1):
-	cargo check --manifest-path $(2)/Cargo.toml --workspace $(3)
-
 test-$(1):
 	cargo test --manifest-path $(2)/Cargo.toml --workspace
 
-test-expensive-$(1):
+test-$(1)-expensive:
 	cargo test --manifest-path $(2)/Cargo.toml --workspace -- --ignored
 
 build-$(1):
 	cargo build --manifest-path $(2)/Cargo.toml --workspace $(3)
 
-build-examples-$(1):
+build-$(1)-examples:
 	cargo build --manifest-path $(2)/Cargo.toml --workspace --examples
 
-build-release-$(1):
-	cargo build --manifest-path $(2)/Cargo.toml --workspace --release $(3)
-
 fmt-$(1):
 	cargo fmt --manifest-path $(2)/Cargo.toml --all
 
 clippy-happy: clippy-happy-$(1)
-clippy: clippy-$(1) clippy-examples-$(1)
-check: check-$(1)
+clippy-all: clippy-$(1) clippy-$(1)-examples
 cargo-test: test-$(1)
-cargo-test-expensive: test-expensive-$(1)
-build: build-$(1) build-examples-$(1)
-build-release-all: build-release-$(1)
+cargo-test-expensive: test-$(1)-expensive
+build: build-$(1) build-$(1)-examples
 fmt: fmt-$(1)
 
 endef
@@ -77,7 +61,7 @@ $(eval $(call add_cargo_workspace,contracts,contracts,--target wasm32-unknown-un
 $(eval $(call add_cargo_workspace,wasm-client,clients/webassembly,--target wasm32-unknown-unknown))
 $(eval $(call add_cargo_workspace,wallet,nym-wallet,))
 $(eval $(call add_cargo_workspace,connect,nym-connect/desktop))
-ifdef NYM_MOBILE
+ifndef NYM_NO_MOBILE
 $(eval $(call add_cargo_workspace,connect-mobile,nym-connect/mobile/src-tauri))
 endif
 
@@ -91,31 +75,15 @@ build-explorer-api:
 build-nym-cli:
 	cargo build -p nym-cli --release
 
-# -----------------------------------------------------------------------------
-# Build contracts ready for deploy
-# -----------------------------------------------------------------------------
-
-CONTRACTS_OUT_DIR=contracts/target/wasm32-unknown-unknown/release
-VESTING_CONTRACT=$(CONTRACTS_OUT_DIR)/vesting_contract.wasm
-MIXNET_CONTRACT=$(CONTRACTS_OUT_DIR)/mixnet_contract.wasm
-SERVICE_PROVIDER_DIRECTORY_CONTRACT=$(CONTRACTS_OUT_DIR)/nym_service_provider_directory.wasm
-NAME_SERVICE_CONTRACT=$(CONTRACTS_OUT_DIR)/nym_name_service.wasm
-
-wasm: wasm-build wasm-opt
-
-wasm-build:
-	RUSTFLAGS='-C link-arg=-s' cargo build --manifest-path contracts/Cargo.toml --release --target wasm32-unknown-unknown
-
-wasm-opt:
-	wasm-opt --disable-sign-ext -Os $(VESTING_CONTRACT) -o $(VESTING_CONTRACT)
-	wasm-opt --disable-sign-ext -Os $(MIXNET_CONTRACT) -o $(MIXNET_CONTRACT)
-	wasm-opt --disable-sign-ext -Os $(SERVICE_PROVIDER_DIRECTORY_CONTRACT) -o $(SERVICE_PROVIDER_DIRECTORY_CONTRACT)
-	wasm-opt --disable-sign-ext -Os $(NAME_SERVICE_CONTRACT) -o $(NAME_SERVICE_CONTRACT)
-
 # -----------------------------------------------------------------------------
 # Misc
 # -----------------------------------------------------------------------------
 
+wasm:
+	RUSTFLAGS='-C link-arg=-s' cargo build --manifest-path contracts/Cargo.toml --release --target wasm32-unknown-unknown
+	wasm-opt --disable-sign-ext -Os contracts/target/wasm32-unknown-unknown/release/vesting_contract.wasm -o contracts/target/wasm32-unknown-unknown/release/vesting_contract.wasm
+	wasm-opt --disable-sign-ext -Os contracts/target/wasm32-unknown-unknown/release/mixnet_contract.wasm -o contracts/target/wasm32-unknown-unknown/release/mixnet_contract.wasm
+
 # NOTE: this seems deprecated an not needed anymore?
 mixnet-opt: wasm
 	cd contracts/mixnet && make opt

README.md

@@ -21,7 +21,7 @@ The platform is composed of multiple Rust crates. Top-level executable binary cr
 
 ### Building
 
-Platform build instructions are available on [our docs site](https://nymtech.net/docs/binaries/building-nym.html).
+Platform build instructions are available on [our docs site](https://nymtech.net/docs/stable/run-nym-nodes/build-nym).
 Wallet build instructions are also available on [our docs site](https://nymtech.net/docs/stable/nym-apps/wallet#for-developers).
 
 ### Developing
@@ -32,7 +32,7 @@ For Typescript components, please see [ts-packages](./ts-packages).
 
 ### Developer chat
 
-You can chat with us in [Keybase](https://keybase.io). Download their chat app, then click **Teams -> Join a team**. Type **nymtech.friends** into the team name and hit **continue**. For general chat, hang out in the **#general** channel. Our development takes place in the **#dev** channel. Node operators should be in the **#node-operators** channel.
+You can chat to us in [Keybase](https://keybase.io). Download their chat app, then click **Teams -> Join a team**. Type **nymtech.friends** into the team name and hit **continue**. For general chat, hang out in the **#general** channel. Our development takes places in the **#dev** channel. Node operators should be in the **#node-operators** channel.
 
 ### Rewards
 
@@ -46,7 +46,7 @@ Node, node operator and delegator rewards are determined according to the princi
 |<img src="https://render.githubusercontent.com/render/math?math=\lambda_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\lambda_{i}#gh-dark-mode-only">|ratio of stake operator has pledged to their node to the token circulating supply.
 |<img src="https://render.githubusercontent.com/render/math?math=\omega_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\omega_{i}#gh-dark-mode-only">|fraction of total effort undertaken by node `i`, set to `1/k`.
 |<img src="https://render.githubusercontent.com/render/math?math=k#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}k#gh-dark-mode-only">|number of nodes stakeholders are incentivised to create, set by the validators, a matter of governance. Currently determined by the `reward set` size, and set to 720 in testnet Sandbox.
-|<img src="https://render.githubusercontent.com/render/math?math=\alpha#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\alpha#gh-dark-mode-only">|Sybil attack resistance parameter - the higher this parameter is set the stronger the reduction in competitiveness gets for a Sybil attacker.
+|<img src="https://render.githubusercontent.com/render/math?math=\alpha#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\alpha#gh-dark-mode-only">|Sybil attack resistance parameter - the higher this parameter is set the stronger the reduction in competitivness gets for a Sybil attacker.
 |<img src="https://render.githubusercontent.com/render/math?math=PM_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PM_{i}#gh-dark-mode-only">|declared profit margin of operator `i`, defaults to 10% in.
 |<img src="https://render.githubusercontent.com/render/math?math=PF_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PF_{i}#gh-dark-mode-only">|uptime of node `i`, scaled to 0 - 1, for the rewarding epoch
 |<img src="https://render.githubusercontent.com/render/math?math=PP_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PP_{i}#gh-dark-mode-only">|cost of operating node `i` for the duration of the rewarding epoch, set to 40 NYMT.
@@ -70,7 +70,7 @@ Operator of node `i` is credited with the following amount:
 <img src="https://render.githubusercontent.com/render/math?math=min\{PP_{i},R_{i})\} %2b max\{0, (PM_{i} %2b (1 - PM_{i}) \cdot \lambda_{i}/\delta_{i}) \cdot (R_{i} - PP_{i})\}#gh-light-mode-only">
 <img src="https://render.githubusercontent.com/render/math?math=\color{white}min\{PP_{i},R_{i})\} %2b max\{0, (PM_{i} %2b (1 - PM_{i}) \cdot \lambda_{i}/\delta_{i}) \cdot (R_{i} - PP_{i})\}#gh-dark-mode-only">
 
-Delegate with stake `s` receives:
+Delegate with stake `s` recieves:
 
 <img src="https://render.githubusercontent.com/render/math?math=max\{0, (1-PM_{i}) \cdot (s^'/\sigma_{i}) \cdot (R_{i} - PP_{i})\}#gh-light-mode-only">
 <img src="https://render.githubusercontent.com/render/math?math=\color{white}max\{0, (1-PM_{i}) \cdot (s^'/\sigma_{i}) \cdot (R_{i} - PP_{i})\}#gh-dark-mode-only">

SECURITY.md

@@ -3,8 +3,8 @@ Critical bug or security issue 💥
 If you're here because you're trying to figure out how to notify us of a security issue, go to Discord, and alert the core engineers:
 
     Dave Hrycyszyn futurechimp#5430
+    Drazen Urch drazen#4873
     Jedrzej Stuczynski "Jedrzej | Nym#5666"
-    Fran Arbanas | franarbanas#0995
-    Mark Sinclair | marknym#8088 
 
-Please avoid opening public issues on GitHub that contain information about a potential security vulnerability as this makes it difficult to reduce the impact and harm of valid security issues.
+
+Please avoid opening public issues on GitHub that contain information about a potential security vulnerability as this makes it difficult to reduce the impact and harm of valid security issues.

clients/credential/Cargo.toml

@@ -1,25 +1,27 @@
 [package]
-name = "nym-credential-client"
+name = "credential"
 version = "0.1.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+bip39 = { workspace = true }
 clap = { version = "4.0", features = ["cargo", "derive"] }
 log = "0.4"
-serde = { workspace = true, features = ["derive"] }
+rand = "0.7.3"
+serde = { version = "1.0", features = ["derive"] }
 thiserror = "1.0"
+url = "2.2"
 tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal", "macros"] } # async runtime
 
-
-nym-bandwidth-controller = { path = "../../common/bandwidth-controller" }
-nym-client-core = { path = "../../common/client-core" }
+nym-coconut-interface = { path = "../../common/coconut-interface" }
 nym-config = { path = "../../common/config" }
 nym-credentials = { path = "../../common/credentials" }
 nym-credential-storage = { path = "../../common/credential-storage" }
+nym-crypto = { path = "../../common/crypto", features = ["rand", "asymmetric", "symmetric", "aes", "hashing"] }
 nym-bin-common = { path = "../../common/bin-common"}
 nym-network-defaults = { path = "../../common/network-defaults" }
 nym-pemstore = { path = "../../common/pemstore" }
-nym-validator-client = { path = "../../common/client-libs/validator-client", features = ["nyxd-client"] }
+validator-client = { path = "../../common/client-libs/validator-client", features = ["nyxd-client"] }
 

clients/credential/src/client.rs

@@ -4,11 +4,11 @@
 use crate::error::Result;
 use bip39::Mnemonic;
 use nym_network_defaults::{NymNetworkDetails, VOUCHER_INFO};
-use nym_validator_client::nyxd;
-use nym_validator_client::nyxd::traits::CoconutBandwidthSigningClient;
-use nym_validator_client::nyxd::{Coin, DirectSigningNyxdClient, Fee, NyxdClient};
 use std::str::FromStr;
 use url::Url;
+use validator_client::nyxd;
+use validator_client::nyxd::traits::CoconutBandwidthSigningClient;
+use validator_client::nyxd::{Coin, DirectSigningNyxdClient, Fee, NyxdClient};
 
 pub(crate) struct Client {
     nyxd_client: NyxdClient<DirectSigningNyxdClient>,

clients/credential/src/commands.rs

@@ -3,13 +3,24 @@
 
 use clap::{ArgGroup, Args, Subcommand};
 use log::*;
-use nym_bandwidth_controller::acquire::state::State;
 use nym_bin_common::completions::ArgShell;
-use nym_credential_storage::persistent_storage::PersistentStorage;
-use nym_validator_client::nyxd::traits::DkgQueryClient;
+use nym_coconut_interface::{Base58, Parameters};
+use nym_credential_storage::storage::Storage;
+use nym_credential_storage::PersistentStorage;
+use nym_credentials::coconut::bandwidth::{BandwidthVoucher, TOTAL_ATTRIBUTES};
+use nym_credentials::coconut::utils::obtain_aggregate_signature;
+use nym_crypto::asymmetric::{encryption, identity};
+use nym_network_defaults::VOUCHER_INFO;
+use rand::rngs::OsRng;
+use std::str::FromStr;
+use validator_client::nyxd::traits::DkgQueryClient;
+use validator_client::nyxd::tx::Hash;
+use validator_client::CoconutApiClient;
 
-use crate::error::Result;
+use crate::client::Client;
+use crate::error::{CredentialClientError, Result};
 use crate::recovery_storage::RecoveryStorage;
+use crate::state::{KeyPair, State};
 
 #[derive(Subcommand)]
 pub(crate) enum Command {
@@ -34,6 +45,10 @@ pub(crate) struct Run {
     #[clap(long)]
     pub(crate) client_home_directory: std::path::PathBuf,
 
+    /// The nyxd URL that should be used
+    #[clap(long)]
+    pub(crate) nyxd_url: String,
+
     /// A mnemonic for the account that buys the credential
     #[clap(long)]
     pub(crate) mnemonic: String,
@@ -52,16 +67,81 @@ pub(crate) struct Run {
     pub(crate) recovery_mode: bool,
 }
 
+pub(crate) async fn deposit(nyxd_url: &str, mnemonic: &str, amount: u64) -> Result<State> {
+    let mut rng = OsRng;
+    let signing_keypair = KeyPair::from(identity::KeyPair::new(&mut rng));
+    let encryption_keypair = KeyPair::from(encryption::KeyPair::new(&mut rng));
+    let params = Parameters::new(TOTAL_ATTRIBUTES).unwrap();
+
+    let client = Client::new(nyxd_url, mnemonic);
+    let tx_hash = client
+        .deposit(
+            amount,
+            signing_keypair.public_key.clone(),
+            encryption_keypair.public_key.clone(),
+            None,
+        )
+        .await?;
+
+    let voucher = BandwidthVoucher::new(
+        &params,
+        amount.to_string(),
+        VOUCHER_INFO.to_string(),
+        Hash::from_str(&tx_hash).map_err(|_| CredentialClientError::InvalidTxHash)?,
+        identity::PrivateKey::from_base58_string(&signing_keypair.private_key)?,
+        encryption::PrivateKey::from_base58_string(&encryption_keypair.private_key)?,
+    );
+
+    let state = State { voucher, params };
+
+    Ok(state)
+}
+
+pub(crate) async fn get_credential<C: DkgQueryClient + Send + Sync>(
+    state: &State,
+    client: &C,
+    shared_storage: PersistentStorage,
+) -> Result<()> {
+    let epoch_id = client.get_current_epoch().await?.epoch_id;
+    let threshold = client
+        .get_current_epoch_threshold()
+        .await?
+        .ok_or(CredentialClientError::NoThreshold)?;
+    let coconut_api_clients = CoconutApiClient::all_coconut_api_clients(client, epoch_id).await?;
+
+    let signature = obtain_aggregate_signature(
+        &state.params,
+        &state.voucher,
+        &coconut_api_clients,
+        threshold,
+    )
+    .await?;
+    info!("Signature: {:?}", signature.to_bs58());
+    shared_storage
+        .insert_coconut_credential(
+            state.voucher.get_voucher_value(),
+            VOUCHER_INFO.to_string(),
+            state.voucher.get_private_attributes()[0].to_bs58(),
+            state.voucher.get_private_attributes()[1].to_bs58(),
+            signature.to_bs58(),
+            epoch_id.to_string(),
+        )
+        .await?;
+
+    Ok(())
+}
+
 pub(crate) async fn recover_credentials<C: DkgQueryClient + Send + Sync>(
     client: &C,
     recovery_storage: &RecoveryStorage,
-    shared_storage: &PersistentStorage,
+    shared_storage: PersistentStorage,
 ) -> Result<()> {
     for voucher in recovery_storage.unconsumed_vouchers()? {
-        let state = State::new(voucher);
-        if let Err(e) =
-            nym_bandwidth_controller::acquire::get_credential(&state, client, shared_storage).await
-        {
+        let state = State {
+            voucher,
+            params: Parameters::new(TOTAL_ATTRIBUTES).unwrap(),
+        };
+        if let Err(e) = get_credential(&state, client, shared_storage.clone()).await {
             error!(
                 "Could not recover deposit {} due to {:?}, try again later",
                 state.voucher.tx_hash(),

clients/credential/src/error.rs

@@ -6,8 +6,10 @@ use thiserror::Error;
 
 use nym_credential_storage::error::StorageError;
 use nym_credentials::error::Error as CredentialError;
-use nym_validator_client::nyxd::error::NyxdError;
-use nym_validator_client::ValidatorClientError;
+use nym_crypto::asymmetric::encryption::KeyRecoveryError;
+use nym_crypto::asymmetric::identity::Ed25519RecoveryError;
+use validator_client::nyxd::error::NyxdError;
+use validator_client::ValidatorClientError;
 
 pub type Result<T> = std::result::Result<T, CredentialClientError>;
 
@@ -16,9 +18,6 @@ pub enum CredentialClientError {
     #[error("IO error: {0}")]
     IOError(#[from] std::io::Error),
 
-    #[error("Bandwidth controller error: {0}")]
-    BandwidthControllerError(#[from] nym_bandwidth_controller::error::BandwidthControllerError),
-
     #[error("Nyxd error: {0}")]
     Nyxd(#[from] NyxdError),
 
@@ -28,9 +27,21 @@ pub enum CredentialClientError {
     #[error("Credential error: {0}")]
     Credential(#[from] CredentialError),
 
+    #[error("The tx hash provided is not valid")]
+    InvalidTxHash,
+
+    #[error("Could not parse Ed25519 data")]
+    Ed25519ParseError(#[from] Ed25519RecoveryError),
+
+    #[error("Could not parse X25519 data")]
+    X25519ParseError(#[from] KeyRecoveryError),
+
     #[error("Could not use shared storage")]
     SharedStorageError(#[from] StorageError),
 
     #[error("Could not get system time")]
     SysTimeError(#[from] SystemTimeError),
+
+    #[error("Threshold not set yet")]
+    NoThreshold,
 }

clients/credential/src/main.rs

@@ -1,25 +1,26 @@
-// Copyright 2022-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
+mod client;
 mod commands;
 mod error;
 mod recovery_storage;
+mod state;
 
 use commands::*;
 use error::Result;
 use log::*;
 use nym_bin_common::completions::fig_generate;
-use nym_config::DEFAULT_DATA_DIR;
+use nym_config::{CRED_DB_FILE_NAME, DATA_DIR};
 use nym_network_defaults::{setup_env, NymNetworkDetails};
 use std::process::exit;
 use std::time::{Duration, SystemTime};
 
 use clap::{CommandFactory, Parser};
 use nym_bin_common::logging::setup_logging;
-use nym_client_core::config::disk_persistence::CommonClientPaths;
-use nym_validator_client::nyxd::traits::DkgQueryClient;
-use nym_validator_client::nyxd::{Coin, CosmWasmClient};
-use nym_validator_client::Config;
+use validator_client::nyxd::traits::DkgQueryClient;
+use validator_client::nyxd::CosmWasmClient;
+use validator_client::Config;
 
 const SAFETY_BUFFER_SECS: u64 = 60; // 1 minute
 
@@ -34,8 +35,8 @@ struct Cli {
     pub(crate) command: Command,
 }
 
-async fn block_until_coconut_is_available<C: CosmWasmClient + Send + Sync>(
-    client: &nym_validator_client::Client<C>,
+async fn block_until_coconut_is_available<C: Clone + CosmWasmClient + Send + Sync>(
+    client: &validator_client::Client<C>,
 ) -> Result<()> {
     loop {
         let epoch = client.nyxd.get_current_epoch().await?;
@@ -72,39 +73,25 @@ async fn main() -> Result<()> {
 
     match args.command {
         Command::Run(r) => {
-            // we assume the structure of <home-dir>/data
-            let data_dir = r.client_home_directory.join(DEFAULT_DATA_DIR);
-            let paths = CommonClientPaths::new_default(data_dir);
-            let db_path = paths.credentials_database;
-
-            let shared_storage =
-                nym_credential_storage::initialise_persistent_storage(db_path).await;
+            let db_path = r
+                .client_home_directory
+                .join(DATA_DIR)
+                .join(CRED_DB_FILE_NAME);
+            let shared_storage = nym_credential_storage::initialise_storage(db_path).await;
             let recovery_storage = recovery_storage::RecoveryStorage::new(r.recovery_dir)?;
 
             let network_details = NymNetworkDetails::new_from_env();
-            let config = Config::try_from_nym_network_details(&network_details).expect(
-                "failed to construct valid validator client config with the provided network",
-            );
-            let amount = Coin::new(
-                r.amount as u128,
-                network_details.chain_details.mix_denom.base,
-            );
-            let client =
-                nym_validator_client::Client::new_signing(config, r.mnemonic.parse().unwrap())?;
+            let config = Config::try_from_nym_network_details(&network_details)?;
+            let client = validator_client::Client::new_query(config)?;
 
             block_until_coconut_is_available(&client).await?;
             info!("Starting depositing funds, don't kill the process");
 
             if !r.recovery_mode {
-                let state =
-                    nym_bandwidth_controller::acquire::deposit(&client.nyxd, amount).await?;
-                if nym_bandwidth_controller::acquire::get_credential(
-                    &state,
-                    &client,
-                    &shared_storage,
-                )
-                .await
-                .is_err()
+                let state = deposit(&r.nyxd_url, &r.mnemonic, r.amount).await?;
+                if get_credential(&state, &client.nyxd, shared_storage)
+                    .await
+                    .is_err()
                 {
                     warn!("Failed to obtain credential. Dumping recovery data.",);
                     match recovery_storage.insert_voucher(&state.voucher) {
@@ -117,11 +104,11 @@ async fn main() -> Result<()> {
                     }
                 }
             } else {
-                recover_credentials(&client.nyxd, &recovery_storage, &shared_storage).await?;
+                recover_credentials(&client.nyxd, &recovery_storage, shared_storage).await?;
             }
         }
-        Command::Completions(c) => c.generate(&mut Cli::command(), bin_name),
-        Command::GenerateFigSpec => fig_generate(&mut Cli::command(), bin_name),
+        Command::Completions(c) => c.generate(&mut crate::Cli::command(), bin_name),
+        Command::GenerateFigSpec => fig_generate(&mut crate::Cli::command(), bin_name),
     }
 
     Ok(())

clients/credential/src/state.rs

@@ -1,8 +1,8 @@
-// Copyright 2022-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
 use nym_coconut_interface::Parameters;
-use nym_credentials::coconut::bandwidth::{BandwidthVoucher, TOTAL_ATTRIBUTES};
+use nym_credentials::coconut::bandwidth::BandwidthVoucher;
 
 use nym_crypto::asymmetric::{encryption, identity};
 
@@ -29,16 +29,7 @@ impl From<encryption::KeyPair> for KeyPair {
     }
 }
 
-pub struct State {
+pub(crate) struct State {
     pub voucher: BandwidthVoucher,
     pub params: Parameters,
 }
-
-impl State {
-    pub fn new(voucher: BandwidthVoucher) -> Self {
-        State {
-            voucher,
-            params: Parameters::new(TOTAL_ATTRIBUTES).unwrap(),
-        }
-    }
-}

clients/native/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-client"
-version = "1.1.19"
+version = "1.1.13"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>", "Jędrzej Stuczyński <andrew@nymtech.net>"]
 description = "Implementation of the Nym Client"
 edition = "2021"
@@ -26,29 +26,30 @@ lazy_static = "1.4.0"
 log = { workspace = true } # self explanatory
 pretty_env_logger = "0.4" # for formatting log messages
 rand = { version = "0.7.3", features = ["wasm-bindgen"] } # rng-related traits + some rng implementation to use
-serde = { workspace = true, features = ["derive"] } # for config serialization/deserialization
-serde_json = { workspace = true }
+serde = { version = "1.0.104", features = ["derive"] } # for config serialization/deserialization
+serde_json = "1.0"
 thiserror = "1.0.34"
 tap = "1.0.1"
 tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal"] } # async runtime
 tokio-tungstenite = "0.14" # websocket
 
 ## internal
-nym-bandwidth-controller = { path = "../../common/bandwidth-controller" }
-nym-bin-common = { path = "../../common/bin-common", features = ["output_format"] }
-nym-client-core = { path = "../../common/client-core", features = ["fs-surb-storage"] }
+nym-bin-common = { path = "../../common/bin-common" }
+client-core = { path = "../../common/client-core", features = ["fs-surb-storage"] }
 nym-coconut-interface = { path = "../../common/coconut-interface" }
 nym-config = { path = "../../common/config" }
 nym-credential-storage = { path = "../../common/credential-storage" }
 nym-credentials = { path = "../../common/credentials" }
 nym-crypto = { path = "../../common/crypto" }
-nym-gateway-requests = { path = "../../gateway/gateway-requests" }
+gateway-client = { path = "../../common/client-libs/gateway-client" }
+gateway-requests = { path = "../../gateway/gateway-requests" }
 nym-network-defaults = { path = "../../common/network-defaults" }
 nym-sphinx = { path = "../../common/nymsphinx" }
 nym-pemstore = { path = "../../common/pemstore" }
 nym-task = { path = "../../common/task" }
 nym-topology = { path = "../../common/topology" }
-nym-validator-client = { path = "../../common/client-libs/validator-client", features = ["nyxd-client"] }
-nym-client-websocket-requests = { path = "websocket-requests" }
+validator-client = { path = "../../common/client-libs/validator-client", features = ["nyxd-client"] }
+websocket-requests = { path = "websocket-requests" }
 
 [dev-dependencies]
+serde_json = "1.0" # for the "textsend" example

clients/native/examples/js-examples/websocket/package-lock.json

@@ -13,7 +13,7 @@
       },
       "devDependencies": {
         "clean-webpack-plugin": "^4.0.0",
-        "webpack": "^5.76.0",
+        "webpack": "^5.70.0",
         "webpack-cli": "^4.9.2",
         "webpack-dev-server": "^4.7.4"
       }
@@ -490,9 +490,9 @@
       }
     },
     "node_modules/acorn": {
-      "version": "8.8.2",
-      "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.2.tgz",
-      "integrity": "sha512-xjIYgE8HBrkpd/sJqOGNspf8uHG+NOHGOw6a/Urj8taM2EXfdNAH2oFcPeIFfsv3+kz/mJrS5VuMqbNLjCa2vw==",
+      "version": "8.7.0",
+      "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz",
+      "integrity": "sha512-V/LGr1APy+PXIwKebEWrkZPwoeoF+w1jiOBUmuxuiUIaOHtob8Qc9BTrYo7VuI5fR8tqsy+buA2WFooR5olqvQ==",
       "bin": {
         "acorn": "bin/acorn"
       },
@@ -1327,9 +1327,9 @@
       }
     },
     "node_modules/enhanced-resolve": {
-      "version": "5.12.0",
-      "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.12.0.tgz",
-      "integrity": "sha512-QHTXI/sZQmko1cbDoNAa3mJ5qhWUUNAq3vR0/YiD379fWQrcfuoX1+HW2S0MTt7XmoPLapdaDKUtelUSPic7hQ==",
+      "version": "5.9.2",
+      "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.9.2.tgz",
+      "integrity": "sha512-GIm3fQfwLJ8YZx2smuHpBKkXC1yOk+OBEmKckVyL0i/ea8mqDEykK3ld5dgH1QYPNyT/lIllxV2LULnxCHaHkA==",
       "dependencies": {
         "graceful-fs": "^4.2.4",
         "tapable": "^2.2.0"
@@ -2380,10 +2380,10 @@
         "node": ">= 10.13.0"
       }
     },
-    "node_modules/json-parse-even-better-errors": {
-      "version": "2.3.1",
-      "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz",
-      "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w=="
+    "node_modules/json-parse-better-errors": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz",
+      "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw=="
     },
     "node_modules/json-schema-traverse": {
       "version": "0.4.1",
@@ -3824,9 +3824,9 @@
       }
     },
     "node_modules/watchpack": {
-      "version": "2.4.0",
-      "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.0.tgz",
-      "integrity": "sha512-Lcvm7MGST/4fup+ifyKi2hjyIAwcdI4HRgtvTpIUxBRhB+RFtUh8XtDOxUfctVCnhVi+QQj49i91OyvzkJl6cg==",
+      "version": "2.3.1",
+      "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.3.1.tgz",
+      "integrity": "sha512-x0t0JuydIo8qCNctdDrn1OzH/qDzk2+rdCOC3YzumZ42fiMqmQ7T3xQurykYMhYfHaPHTp4ZxAx2NfUo1K6QaA==",
       "dependencies": {
         "glob-to-regexp": "^0.4.1",
         "graceful-fs": "^4.1.2"
@@ -3845,33 +3845,33 @@
       }
     },
     "node_modules/webpack": {
-      "version": "5.76.0",
-      "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.76.0.tgz",
-      "integrity": "sha512-l5sOdYBDunyf72HW8dF23rFtWq/7Zgvt/9ftMof71E/yUb1YLOBmTgA2K4vQthB3kotMrSj609txVE0dnr2fjA==",
+      "version": "5.70.0",
+      "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.70.0.tgz",
+      "integrity": "sha512-ZMWWy8CeuTTjCxbeaQI21xSswseF2oNOwc70QSKNePvmxE7XW36i7vpBMYZFAUHPwQiEbNGCEYIOOlyRbdGmxw==",
       "dependencies": {
         "@types/eslint-scope": "^3.7.3",
         "@types/estree": "^0.0.51",
         "@webassemblyjs/ast": "1.11.1",
         "@webassemblyjs/wasm-edit": "1.11.1",
         "@webassemblyjs/wasm-parser": "1.11.1",
-        "acorn": "^8.7.1",
+        "acorn": "^8.4.1",
         "acorn-import-assertions": "^1.7.6",
         "browserslist": "^4.14.5",
         "chrome-trace-event": "^1.0.2",
-        "enhanced-resolve": "^5.10.0",
+        "enhanced-resolve": "^5.9.2",
         "es-module-lexer": "^0.9.0",
         "eslint-scope": "5.1.1",
         "events": "^3.2.0",
         "glob-to-regexp": "^0.4.1",
         "graceful-fs": "^4.2.9",
-        "json-parse-even-better-errors": "^2.3.1",
+        "json-parse-better-errors": "^1.0.2",
         "loader-runner": "^4.2.0",
         "mime-types": "^2.1.27",
         "neo-async": "^2.6.2",
         "schema-utils": "^3.1.0",
         "tapable": "^2.1.1",
         "terser-webpack-plugin": "^5.1.3",
-        "watchpack": "^2.4.0",
+        "watchpack": "^2.3.1",
         "webpack-sources": "^3.2.3"
       },
       "bin": {
@@ -4894,9 +4894,9 @@
       }
     },
     "acorn": {
-      "version": "8.8.2",
-      "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.2.tgz",
-      "integrity": "sha512-xjIYgE8HBrkpd/sJqOGNspf8uHG+NOHGOw6a/Urj8taM2EXfdNAH2oFcPeIFfsv3+kz/mJrS5VuMqbNLjCa2vw=="
+      "version": "8.7.0",
+      "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz",
+      "integrity": "sha512-V/LGr1APy+PXIwKebEWrkZPwoeoF+w1jiOBUmuxuiUIaOHtob8Qc9BTrYo7VuI5fR8tqsy+buA2WFooR5olqvQ=="
     },
     "acorn-import-assertions": {
       "version": "1.8.0",
@@ -5527,9 +5527,9 @@
       "dev": true
     },
     "enhanced-resolve": {
-      "version": "5.12.0",
-      "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.12.0.tgz",
-      "integrity": "sha512-QHTXI/sZQmko1cbDoNAa3mJ5qhWUUNAq3vR0/YiD379fWQrcfuoX1+HW2S0MTt7XmoPLapdaDKUtelUSPic7hQ==",
+      "version": "5.9.2",
+      "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.9.2.tgz",
+      "integrity": "sha512-GIm3fQfwLJ8YZx2smuHpBKkXC1yOk+OBEmKckVyL0i/ea8mqDEykK3ld5dgH1QYPNyT/lIllxV2LULnxCHaHkA==",
       "requires": {
         "graceful-fs": "^4.2.4",
         "tapable": "^2.2.0"
@@ -6305,10 +6305,10 @@
         "supports-color": "^8.0.0"
       }
     },
-    "json-parse-even-better-errors": {
-      "version": "2.3.1",
-      "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz",
-      "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w=="
+    "json-parse-better-errors": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz",
+      "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw=="
     },
     "json-schema-traverse": {
       "version": "0.4.1",
@@ -7396,9 +7396,9 @@
       "dev": true
     },
     "watchpack": {
-      "version": "2.4.0",
-      "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.0.tgz",
-      "integrity": "sha512-Lcvm7MGST/4fup+ifyKi2hjyIAwcdI4HRgtvTpIUxBRhB+RFtUh8XtDOxUfctVCnhVi+QQj49i91OyvzkJl6cg==",
+      "version": "2.3.1",
+      "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.3.1.tgz",
+      "integrity": "sha512-x0t0JuydIo8qCNctdDrn1OzH/qDzk2+rdCOC3YzumZ42fiMqmQ7T3xQurykYMhYfHaPHTp4ZxAx2NfUo1K6QaA==",
       "requires": {
         "glob-to-regexp": "^0.4.1",
         "graceful-fs": "^4.1.2"
@@ -7414,33 +7414,33 @@
       }
     },
     "webpack": {
-      "version": "5.76.0",
-      "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.76.0.tgz",
-      "integrity": "sha512-l5sOdYBDunyf72HW8dF23rFtWq/7Zgvt/9ftMof71E/yUb1YLOBmTgA2K4vQthB3kotMrSj609txVE0dnr2fjA==",
+      "version": "5.70.0",
+      "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.70.0.tgz",
+      "integrity": "sha512-ZMWWy8CeuTTjCxbeaQI21xSswseF2oNOwc70QSKNePvmxE7XW36i7vpBMYZFAUHPwQiEbNGCEYIOOlyRbdGmxw==",
       "requires": {
         "@types/eslint-scope": "^3.7.3",
         "@types/estree": "^0.0.51",
         "@webassemblyjs/ast": "1.11.1",
         "@webassemblyjs/wasm-edit": "1.11.1",
         "@webassemblyjs/wasm-parser": "1.11.1",
-        "acorn": "^8.7.1",
+        "acorn": "^8.4.1",
         "acorn-import-assertions": "^1.7.6",
         "browserslist": "^4.14.5",
         "chrome-trace-event": "^1.0.2",
-        "enhanced-resolve": "^5.10.0",
+        "enhanced-resolve": "^5.9.2",
         "es-module-lexer": "^0.9.0",
         "eslint-scope": "5.1.1",
         "events": "^3.2.0",
         "glob-to-regexp": "^0.4.1",
         "graceful-fs": "^4.2.9",
-        "json-parse-even-better-errors": "^2.3.1",
+        "json-parse-better-errors": "^1.0.2",
         "loader-runner": "^4.2.0",
         "mime-types": "^2.1.27",
         "neo-async": "^2.6.2",
         "schema-utils": "^3.1.0",
         "tapable": "^2.1.1",
         "terser-webpack-plugin": "^5.1.3",
-        "watchpack": "^2.4.0",
+        "watchpack": "^2.3.1",
         "webpack-sources": "^3.2.3"
       }
     },

clients/native/examples/js-examples/websocket/package.json

@@ -19,7 +19,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "clean-webpack-plugin": "^4.0.0",
-    "webpack": "^5.76.0",
+    "webpack": "^5.70.0",
     "webpack-cli": "^4.9.2",
     "webpack-dev-server": "^4.7.4"
   },

clients/native/examples/websocket_binarysend.rs

@@ -1,10 +1,10 @@
 use futures::{SinkExt, StreamExt};
-use nym_client_websocket_requests::{requests::ClientRequest, responses::ServerResponse};
 use nym_sphinx::addressing::clients::Recipient;
 use tokio::net::TcpStream;
 use tokio_tungstenite::{
     connect_async, tungstenite::protocol::Message, MaybeTlsStream, WebSocketStream,
 };
+use websocket_requests::{requests::ClientRequest, responses::ServerResponse};
 
 // just helpers functions that work in this very particular context because we are sending to ourselves
 // and hence will always get a response back (i.e. the message we sent)

clients/native/src/client/config/mod.rs

@@ -1,57 +1,23 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::client::config::persistence::ClientPaths;
-use crate::client::config::template::CONFIG_TEMPLATE;
-use nym_bin_common::logging::LoggingSettings;
+use crate::client::config::template::config_template;
+use client_core::config::ClientCoreConfigTrait;
 use nym_config::defaults::DEFAULT_WEBSOCKET_LISTENING_PORT;
-use nym_config::{
-    must_get_home, read_config_from_toml_file, save_formatted_config_to_file, NymConfigTemplate,
-    OptionalSet, DEFAULT_CONFIG_DIR, DEFAULT_CONFIG_FILENAME, DEFAULT_DATA_DIR, NYM_DIR,
-};
+use nym_config::{NymConfig, OptionalSet};
 use serde::{Deserialize, Serialize};
 use std::fmt::Debug;
-use std::io;
 use std::net::{IpAddr, Ipv4Addr};
-use std::path::{Path, PathBuf};
+use std::path::PathBuf;
 use std::str::FromStr;
 
-pub use nym_client_core::config::Config as BaseClientConfig;
-pub use nym_client_core::config::{DebugConfig, GatewayEndpointConfig};
+pub use client_core::config::Config as BaseConfig;
+pub use client_core::config::MISSING_VALUE;
+pub use client_core::config::{DebugConfig, GatewayEndpointConfig};
 
 pub mod old_config_v1_1_13;
-pub mod old_config_v1_1_19;
-mod persistence;
 mod template;
 
-const DEFAULT_CLIENTS_DIR: &str = "clients";
-
-/// Derive default path to clients's config directory.
-/// It should get resolved to `$HOME/.nym/mixnodes/<id>/config`
-pub fn default_config_directory<P: AsRef<Path>>(id: P) -> PathBuf {
-    must_get_home()
-        .join(NYM_DIR)
-        .join(DEFAULT_CLIENTS_DIR)
-        .join(id)
-        .join(DEFAULT_CONFIG_DIR)
-}
-
-/// Derive default path to client's config file.
-/// It should get resolved to `$HOME/.nym/clients/<id>/config/config.toml`
-pub fn default_config_filepath<P: AsRef<Path>>(id: P) -> PathBuf {
-    default_config_directory(id).join(DEFAULT_CONFIG_FILENAME)
-}
-
-/// Derive default path to client's data directory where files, such as keys, are stored.
-/// It should get resolved to `$HOME/.nym/clients/<id>/data`
-pub fn default_data_directory<P: AsRef<Path>>(id: P) -> PathBuf {
-    must_get_home()
-        .join(NYM_DIR)
-        .join(DEFAULT_CLIENTS_DIR)
-        .join(id)
-        .join(DEFAULT_DATA_DIR)
-}
-
 #[derive(Debug, Deserialize, PartialEq, Eq, Serialize, Clone, Copy)]
 #[serde(deny_unknown_fields)]
 pub enum SocketType {
@@ -60,62 +26,74 @@ pub enum SocketType {
 }
 
 impl SocketType {
+    pub fn from_string<S: Into<String>>(val: S) -> Self {
+        let mut upper = val.into();
+        upper.make_ascii_uppercase();
+        match upper.as_ref() {
+            "WEBSOCKET" | "WS" => SocketType::WebSocket,
+            _ => SocketType::None,
+        }
+    }
+
     pub fn is_websocket(&self) -> bool {
         matches!(self, SocketType::WebSocket)
     }
 }
 
-#[derive(Debug, Deserialize, PartialEq, Serialize)]
+#[derive(Debug, Default, Deserialize, PartialEq, Serialize)]
+#[serde(deny_unknown_fields)]
 pub struct Config {
     #[serde(flatten)]
-    pub base: BaseClientConfig,
+    base: BaseConfig<Config>,
 
-    pub socket: Socket,
-
-    // pub paths: CommonClientPathfinder,
-    pub storage_paths: ClientPaths,
-
-    pub logging: LoggingSettings,
+    socket: Socket,
 }
 
-impl NymConfigTemplate for Config {
+impl NymConfig for Config {
     fn template() -> &'static str {
-        CONFIG_TEMPLATE
+        config_template()
+    }
+
+    fn default_root_directory() -> PathBuf {
+        dirs::home_dir()
+            .expect("Failed to evaluate $HOME value")
+            .join(".nym")
+            .join("clients")
+    }
+
+    fn try_default_root_directory() -> Option<PathBuf> {
+        dirs::home_dir().map(|path| path.join(".nym").join("clients"))
+    }
+
+    fn root_directory(&self) -> PathBuf {
+        self.base.get_nym_root_directory()
+    }
+
+    fn config_directory(&self) -> PathBuf {
+        self.root_directory()
+            .join(self.base.get_id())
+            .join("config")
+    }
+
+    fn data_directory(&self) -> PathBuf {
+        self.root_directory().join(self.base.get_id()).join("data")
+    }
+}
+
+impl ClientCoreConfigTrait for Config {
+    fn get_gateway_endpoint(&self) -> &client_core::config::GatewayEndpointConfig {
+        self.base.get_gateway_endpoint()
     }
 }
 
 impl Config {
-    pub fn new<S: AsRef<str>>(id: S) -> Self {
+    pub fn new<S: Into<String>>(id: S) -> Self {
         Config {
-            base: BaseClientConfig::new(id.as_ref()),
-            storage_paths: ClientPaths::new_default(default_data_directory(id.as_ref())),
-            logging: Default::default(),
+            base: BaseConfig::new(id),
             socket: Default::default(),
         }
     }
 
-    pub fn read_from_toml_file<P: AsRef<Path>>(path: P) -> io::Result<Self> {
-        read_config_from_toml_file(path)
-    }
-
-    pub fn read_from_default_path<P: AsRef<Path>>(id: P) -> io::Result<Self> {
-        Self::read_from_toml_file(default_config_filepath(id))
-    }
-
-    pub fn default_location(&self) -> PathBuf {
-        default_config_filepath(&self.base.client.id)
-    }
-
-    pub fn save_to_default_location(&self) -> io::Result<()> {
-        let config_save_location: PathBuf = self.default_location();
-        save_formatted_config_to_file(self, config_save_location)
-    }
-
-    pub fn validate(&self) -> bool {
-        // no other sections have explicit requirements (yet)
-        self.base.validate()
-    }
-
     pub fn with_socket(mut self, socket_type: SocketType) -> Self {
         self.socket.socket_type = socket_type;
         self
@@ -140,10 +118,39 @@ impl Config {
         self
     }
 
+    // getters
+    pub fn get_config_file_save_location(&self) -> PathBuf {
+        self.config_directory().join(Self::config_file_name())
+    }
+
+    pub fn get_base(&self) -> &BaseConfig<Self> {
+        &self.base
+    }
+
+    pub fn get_base_mut(&mut self) -> &mut BaseConfig<Self> {
+        &mut self.base
+    }
+
+    pub fn get_debug_settings(&self) -> &DebugConfig {
+        self.get_base().get_debug_config()
+    }
+
+    pub fn get_socket_type(&self) -> SocketType {
+        self.socket.socket_type
+    }
+
+    pub fn get_listening_ip(&self) -> IpAddr {
+        self.socket.host
+    }
+
+    pub fn get_listening_port(&self) -> u16 {
+        self.socket.listening_port
+    }
+
     // poor man's 'builder' method
     pub fn with_base<F, T>(mut self, f: F, val: T) -> Self
     where
-        F: Fn(BaseClientConfig, T) -> BaseClientConfig,
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
     {
         self.base = f(self.base, val);
         self
@@ -153,7 +160,7 @@ impl Config {
     // (plz, lets refactor it)
     pub fn with_optional_ext<F, T>(mut self, f: F, val: Option<T>) -> Self
     where
-        F: Fn(BaseClientConfig, T) -> BaseClientConfig,
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
     {
         self.base = self.base.with_optional(f, val);
         self
@@ -161,7 +168,7 @@ impl Config {
 
     pub fn with_optional_env_ext<F, T>(mut self, f: F, val: Option<T>, env_var: &str) -> Self
     where
-        F: Fn(BaseClientConfig, T) -> BaseClientConfig,
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
         T: FromStr,
         <T as FromStr>::Err: Debug,
     {
@@ -177,7 +184,7 @@ impl Config {
         parser: G,
     ) -> Self
     where
-        F: Fn(BaseClientConfig, T) -> BaseClientConfig,
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
         G: Fn(&str) -> T,
     {
         self.base = self.base.with_optional_custom_env(f, val, env_var, parser);
@@ -185,21 +192,19 @@ impl Config {
     }
 }
 
-// define_optional_set_inner!(Config, base, BaseClientConfig);
-
 #[derive(Debug, Deserialize, PartialEq, Eq, Serialize)]
 #[serde(default, deny_unknown_fields)]
 pub struct Socket {
-    pub socket_type: SocketType,
-    pub host: IpAddr,
-    pub listening_port: u16,
+    socket_type: SocketType,
+    host: IpAddr,
+    listening_port: u16,
 }
 
 impl Default for Socket {
     fn default() -> Self {
         Socket {
             socket_type: SocketType::WebSocket,
-            host: IpAddr::V4(Ipv4Addr::LOCALHOST),
+            host: IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)),
             listening_port: DEFAULT_WEBSOCKET_LISTENING_PORT,
         }
     }

clients/native/src/client/config/old_config_v1_1_13.rs

@@ -1,33 +1,58 @@
 // Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::client::config::old_config_v1_1_19::{ConfigV1_1_19, SocketV1_1_19};
-use nym_client_core::config::old_config_v1_1_13::OldConfigV1_1_13 as OldBaseConfigV1_1_13;
-use nym_config::legacy_helpers::nym_config::MigrationNymConfig;
+use crate::client::config::{Config, Socket};
+use client_core::config::old_config_v1_1_13::OldConfigV1_1_13 as OldBaseConfigV1_1_13;
+use nym_config::NymConfig;
 use serde::{Deserialize, Serialize};
 use std::path::PathBuf;
 
-#[derive(Debug, Deserialize, PartialEq, Serialize)]
+#[derive(Debug, Default, Deserialize, PartialEq, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct OldConfigV1_1_13 {
     #[serde(flatten)]
-    pub base: OldBaseConfigV1_1_13<OldConfigV1_1_13>,
+    base: OldBaseConfigV1_1_13<OldConfigV1_1_13>,
 
-    pub socket: SocketV1_1_19,
+    socket: Socket,
 }
 
-impl MigrationNymConfig for OldConfigV1_1_13 {
+impl NymConfig for OldConfigV1_1_13 {
+    fn template() -> &'static str {
+        // not intended to be used
+        unimplemented!()
+    }
+
     fn default_root_directory() -> PathBuf {
         dirs::home_dir()
             .expect("Failed to evaluate $HOME value")
             .join(".nym")
             .join("clients")
     }
+
+    fn try_default_root_directory() -> Option<PathBuf> {
+        dirs::home_dir().map(|path| path.join(".nym").join("clients"))
+    }
+
+    fn root_directory(&self) -> PathBuf {
+        self.base.client.nym_root_directory.clone()
+    }
+
+    fn config_directory(&self) -> PathBuf {
+        self.root_directory()
+            .join(&self.base.client.id)
+            .join("config")
+    }
+
+    fn data_directory(&self) -> PathBuf {
+        self.root_directory()
+            .join(&self.base.client.id)
+            .join("data")
+    }
 }
 
-impl From<OldConfigV1_1_13> for ConfigV1_1_19 {
+impl From<OldConfigV1_1_13> for Config {
     fn from(value: OldConfigV1_1_13) -> Self {
-        ConfigV1_1_19 {
+        Config {
             base: value.base.into(),
             socket: value.socket,
         }

clients/native/src/client/config/old_config_v1_1_19.rs

@@ -1,112 +0,0 @@
-// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use crate::client::config::persistence::ClientPaths;
-use crate::client::config::{Config, Socket, SocketType};
-use nym_bin_common::logging::LoggingSettings;
-use nym_client_core::config::disk_persistence::keys_paths::ClientKeysPaths;
-use nym_client_core::config::disk_persistence::CommonClientPaths;
-use nym_client_core::config::old_config_v1_1_19::ConfigV1_1_19 as BaseConfigV1_1_19;
-use nym_client_core::config::{Client, Config as BaseConfig};
-use nym_config::defaults::DEFAULT_WEBSOCKET_LISTENING_PORT;
-use nym_config::legacy_helpers::nym_config::MigrationNymConfig;
-use serde::{Deserialize, Serialize};
-use std::fmt::Debug;
-use std::net::{IpAddr, Ipv4Addr};
-use std::path::PathBuf;
-
-#[derive(Debug, Deserialize, PartialEq, Eq, Serialize, Clone, Copy)]
-#[serde(deny_unknown_fields)]
-pub enum SocketTypeV1_1_19 {
-    WebSocket,
-    None,
-}
-
-impl From<SocketTypeV1_1_19> for SocketType {
-    fn from(value: SocketTypeV1_1_19) -> Self {
-        match value {
-            SocketTypeV1_1_19::WebSocket => SocketType::WebSocket,
-            SocketTypeV1_1_19::None => SocketType::None,
-        }
-    }
-}
-
-#[derive(Debug, Deserialize, PartialEq, Serialize)]
-#[serde(deny_unknown_fields)]
-pub struct ConfigV1_1_19 {
-    #[serde(flatten)]
-    pub base: BaseConfigV1_1_19<ConfigV1_1_19>,
-
-    pub socket: SocketV1_1_19,
-}
-
-impl From<ConfigV1_1_19> for Config {
-    fn from(value: ConfigV1_1_19) -> Self {
-        Config {
-            base: BaseConfig {
-                client: Client {
-                    version: value.base.client.version,
-                    id: value.base.client.id,
-                    disabled_credentials_mode: value.base.client.disabled_credentials_mode,
-                    nyxd_urls: value.base.client.nyxd_urls,
-                    nym_api_urls: value.base.client.nym_api_urls,
-                    gateway_endpoint: value.base.client.gateway_endpoint.into(),
-                },
-                debug: value.base.debug.into(),
-            },
-            socket: value.socket.into(),
-            storage_paths: ClientPaths {
-                common_paths: CommonClientPaths {
-                    keys: ClientKeysPaths {
-                        private_identity_key_file: value.base.client.private_identity_key_file,
-                        public_identity_key_file: value.base.client.public_identity_key_file,
-                        private_encryption_key_file: value.base.client.private_encryption_key_file,
-                        public_encryption_key_file: value.base.client.public_encryption_key_file,
-                        gateway_shared_key_file: value.base.client.gateway_shared_key_file,
-                        ack_key_file: value.base.client.ack_key_file,
-                    },
-                    credentials_database: value.base.client.database_path,
-                    reply_surb_database: value.base.client.reply_surb_database_path,
-                },
-            },
-            logging: LoggingSettings::default(),
-        }
-    }
-}
-
-impl MigrationNymConfig for ConfigV1_1_19 {
-    fn default_root_directory() -> PathBuf {
-        dirs::home_dir()
-            .expect("Failed to evaluate $HOME value")
-            .join(".nym")
-            .join("clients")
-    }
-}
-
-#[derive(Debug, Deserialize, PartialEq, Eq, Serialize)]
-#[serde(default, deny_unknown_fields)]
-pub struct SocketV1_1_19 {
-    socket_type: SocketTypeV1_1_19,
-    host: IpAddr,
-    listening_port: u16,
-}
-
-impl From<SocketV1_1_19> for Socket {
-    fn from(value: SocketV1_1_19) -> Self {
-        Socket {
-            socket_type: value.socket_type.into(),
-            host: value.host,
-            listening_port: value.listening_port,
-        }
-    }
-}
-
-impl Default for SocketV1_1_19 {
-    fn default() -> Self {
-        SocketV1_1_19 {
-            socket_type: SocketTypeV1_1_19::WebSocket,
-            host: IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)),
-            listening_port: DEFAULT_WEBSOCKET_LISTENING_PORT,
-        }
-    }
-}

clients/native/src/client/config/persistence.rs

@@ -1,20 +0,0 @@
-// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use nym_client_core::config::disk_persistence::CommonClientPaths;
-use serde::{Deserialize, Serialize};
-use std::path::Path;
-
-#[derive(Debug, Deserialize, PartialEq, Eq, Serialize, Clone)]
-pub struct ClientPaths {
-    #[serde(flatten)]
-    pub common_paths: CommonClientPaths,
-}
-
-impl ClientPaths {
-    pub fn new_default<P: AsRef<Path>>(base_data_directory: P) -> Self {
-        ClientPaths {
-            common_paths: CommonClientPaths::new_default(base_data_directory),
-        }
-    }
-}

clients/native/src/client/config/template.rs

@@ -1,11 +1,12 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-// While using normal toml marshalling would have been way simpler with less overhead,
-// I think it's useful to have comments attached to the saved config file to explain behaviour of
-// particular fields.
-// Note: any changes to the template must be reflected in the appropriate structs.
-pub(crate) const CONFIG_TEMPLATE: &str = r#"
+pub(crate) fn config_template() -> &'static str {
+    // While using normal toml marshalling would have been way simpler with less overhead,
+    // I think it's useful to have comments attached to the saved config file to explain behaviour of
+    // particular fields.
+    // Note: any changes to the template must be reflected in the appropriate structs.
+    r#"
 # This is a TOML config file.
 # For more information, see https://github.com/toml-lang/toml
 
@@ -36,35 +37,39 @@ nym_api_urls = [
     {{/each}}
 ]
 
-[storage_paths] 
-
 # Path to file containing private identity key.
-keys.private_identity_key_file = '{{ storage_paths.keys.private_identity_key_file }}'
+private_identity_key_file = '{{ client.private_identity_key_file }}'
 
 # Path to file containing public identity key.
-keys.public_identity_key_file = '{{ storage_paths.keys.public_identity_key_file }}'
+public_identity_key_file = '{{ client.public_identity_key_file }}'
 
 # Path to file containing private encryption key.
-keys.private_encryption_key_file = '{{ storage_paths.keys.private_encryption_key_file }}'
+private_encryption_key_file = '{{ client.private_encryption_key_file }}'
 
 # Path to file containing public encryption key.
-keys.public_encryption_key_file = '{{ storage_paths.keys.public_encryption_key_file }}'
+public_encryption_key_file = '{{ client.public_encryption_key_file }}'
+
+# Path to the database containing bandwidth credentials
+database_path = '{{ client.database_path }}'
+
+# Path to the persistent store for received reply surbs, unused encryption keys and used sender tags.
+reply_surb_database_path = '{{ client.reply_surb_database_path }}'
+
+##### additional client config options #####
 
 # A gateway specific, optional, base58 stringified shared key used for
 # communication with particular gateway.
-keys.gateway_shared_key_file = '{{ storage_paths.keys.gateway_shared_key_file }}'
+gateway_shared_key_file = '{{ client.gateway_shared_key_file }}'
 
 # Path to file containing key used for encrypting and decrypting the content of an
 # acknowledgement so that nobody besides the client knows which packet it refers to.
-keys.ack_key_file = '{{ storage_paths.keys.ack_key_file }}'
+ack_key_file = '{{ client.ack_key_file }}'
+    
+##### advanced configuration options #####
 
-# Path to the database containing bandwidth credentials
-credentials_database = '{{ storage_paths.credentials_database }}'
+# Absolute path to the home Nym Clients directory.
+nym_root_directory = '{{ client.nym_root_directory }}'
 
-# Path to the persistent store for received reply surbs, unused encryption keys and used sender tags.
-reply_surb_database = '{{ storage_paths.reply_surb_database }}'
-
-# DEPRECATED
 [client.gateway_endpoint]
 # ID of the gateway from which the client should be fetching messages.
 gateway_id = '{{ client.gateway_endpoint.gateway_id }}'
@@ -115,5 +120,5 @@ average_ack_delay = '{{ debug.acknowledgements.average_ack_delay }}'
 [debug.cover_traffic]
 loop_cover_traffic_average_delay = '{{ debug.cover_traffic.loop_cover_traffic_average_delay }}'
 
-
-"#;
+"#
+}

clients/native/src/client/mod.rs

@@ -1,59 +1,85 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021-2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::client::config::Config;
 use crate::error::ClientError;
 use crate::websocket;
-use futures::channel::mpsc;
-use log::*;
-use nym_bandwidth_controller::BandwidthController;
-use nym_client_core::client::base_client::non_wasm_helpers::create_bandwidth_controller;
-use nym_client_core::client::base_client::storage::OnDiskPersistent;
-use nym_client_core::client::base_client::{
+use client_core::client::base_client::{
     non_wasm_helpers, BaseClientBuilder, ClientInput, ClientOutput, ClientState,
 };
-use nym_client_core::client::inbound_messages::InputMessage;
-use nym_client_core::client::key_manager::persistence::OnDiskKeys;
-use nym_client_core::client::received_buffer::{
+use client_core::client::inbound_messages::InputMessage;
+use client_core::client::received_buffer::{
     ReceivedBufferMessage, ReceivedBufferRequestSender, ReconstructedMessagesReceiver,
 };
-use nym_credential_storage::persistent_storage::PersistentStorage;
+use client_core::config::persistence::key_pathfinder::ClientKeyPathfinder;
+use futures::channel::mpsc;
+use gateway_client::bandwidth::BandwidthController;
+use log::*;
 use nym_sphinx::anonymous_replies::requests::AnonymousSenderTag;
-use nym_sphinx::params::PacketType;
 use nym_task::connections::TransmissionLane;
 use nym_task::TaskManager;
-use nym_validator_client::nyxd::QueryNyxdClient;
-use nym_validator_client::Client;
 use std::error::Error;
 use tokio::sync::watch::error::SendError;
+use validator_client::nyxd::QueryNyxdClient;
 
+pub use client_core::client::key_manager::KeyManager;
 pub use nym_sphinx::addressing::clients::Recipient;
 pub use nym_sphinx::receiver::ReconstructedMessage;
+use validator_client::Client;
 
 pub mod config;
 
-type NativeClientBuilder<'a> = BaseClientBuilder<'a, Client<QueryNyxdClient>, OnDiskPersistent>;
-
 pub struct SocketClient {
     /// Client configuration options, including, among other things, packet sending rates,
     /// key filepaths, etc.
     config: Config,
+
+    /// KeyManager object containing smart pointers to all relevant keys used by the client.
+    key_manager: KeyManager,
 }
 
 impl SocketClient {
     pub fn new(config: Config) -> Self {
-        SocketClient { config }
+        let pathfinder = ClientKeyPathfinder::new_from_config(config.get_base());
+        let key_manager = KeyManager::load_keys(&pathfinder).expect("failed to load stored keys");
+
+        SocketClient {
+            config,
+            key_manager,
+        }
+    }
+
+    pub fn new_with_keys(config: Config, key_manager: KeyManager) -> Self {
+        SocketClient {
+            config,
+            key_manager,
+        }
     }
 
     async fn create_bandwidth_controller(
         config: &Config,
-    ) -> BandwidthController<Client<QueryNyxdClient>, PersistentStorage> {
-        let storage = nym_credential_storage::initialise_persistent_storage(
-            &config.storage_paths.common_paths.credentials_database,
+    ) -> BandwidthController<Client<QueryNyxdClient>> {
+        let details = nym_network_defaults::NymNetworkDetails::new_from_env();
+        let mut client_config = validator_client::Config::try_from_nym_network_details(&details)
+            .expect("failed to construct validator client config");
+        let nyxd_url = config
+            .get_base()
+            .get_validator_endpoints()
+            .pop()
+            .expect("No nyxd validator endpoint provided");
+        let api_url = config
+            .get_base()
+            .get_nym_api_endpoints()
+            .pop()
+            .expect("No validator api endpoint provided");
+        // overwrite env configuration with config URLs
+        client_config = client_config.with_urls(nyxd_url, api_url);
+        let client = validator_client::Client::new_query(client_config)
+            .expect("Could not construct query client");
+        BandwidthController::new(
+            nym_credential_storage::initialise_storage(config.get_base().get_database_path()).await,
+            client,
         )
-        .await;
-
-        create_bandwidth_controller(&config.base, storage)
     }
 
     fn start_websocket_listener(
@@ -63,7 +89,6 @@ impl SocketClient {
         client_state: ClientState,
         self_address: &Recipient,
         shutdown: nym_task::TaskClient,
-        packet_type: PacketType,
     ) {
         info!("Starting websocket listener...");
 
@@ -89,10 +114,9 @@ impl SocketClient {
             self_address,
             shared_lane_queue_lengths,
             reply_controller_sender,
-            Some(packet_type),
         );
 
-        websocket::Listener::new(config.socket.host, config.socket.listening_port)
+        websocket::Listener::new(config.get_listening_ip(), config.get_listening_port())
             .start(websocket_handler, shutdown);
     }
 
@@ -105,42 +129,31 @@ impl SocketClient {
         res
     }
 
-    fn key_store(&self) -> OnDiskKeys {
-        OnDiskKeys::new(self.config.storage_paths.common_paths.keys.clone())
-    }
+    pub async fn start_socket(self) -> Result<TaskManager, ClientError> {
+        if !self.config.get_socket_type().is_websocket() {
+            return Err(ClientError::InvalidSocketMode);
+        }
 
-    // TODO: see if this could also be shared with socks5 client / nym-sdk maybe
-    async fn create_base_client_builder(&self) -> Result<NativeClientBuilder, ClientError> {
         // don't create bandwidth controller if credentials are disabled
-        let bandwidth_controller = if self.config.base.client.disabled_credentials_mode {
+        let bandwidth_controller = if self.config.get_base().get_disabled_credentials_mode() {
             None
         } else {
             Some(Self::create_bandwidth_controller(&self.config).await)
         };
 
-        let base_client = BaseClientBuilder::new_from_base_config(
-            &self.config.base,
-            self.key_store(),
+        let base_builder = BaseClientBuilder::new_from_base_config(
+            self.config.get_base(),
+            self.key_manager,
             bandwidth_controller,
             non_wasm_helpers::setup_fs_reply_surb_backend(
-                &self.config.storage_paths.common_paths.reply_surb_database,
-                &self.config.base.debug.reply_surbs,
+                Some(self.config.get_base().get_reply_surb_database_path()),
+                self.config.get_debug_settings(),
             )
             .await?,
         );
 
-        Ok(base_client)
-    }
-
-    pub async fn start_socket(self) -> Result<TaskManager, ClientError> {
-        if !self.config.socket.socket_type.is_websocket() {
-            return Err(ClientError::InvalidSocketMode);
-        }
-
-        let base_builder = self.create_base_client_builder().await?;
-        let packet_type = self.config.base.debug.traffic.packet_type;
+        let self_address = base_builder.as_mix_recipient();
         let mut started_client = base_builder.start_base().await?;
-        let self_address = started_client.address;
         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;
@@ -152,24 +165,40 @@ impl SocketClient {
             client_state,
             &self_address,
             started_client.task_manager.subscribe(),
-            packet_type,
         );
 
         info!("Client startup finished!");
-        info!("The address of this client is: {self_address}");
+        info!("The address of this client is: {}", self_address);
 
         Ok(started_client.task_manager)
     }
 
     pub async fn start_direct(self) -> Result<DirectClient, ClientError> {
-        if self.config.socket.socket_type.is_websocket() {
+        if self.config.get_socket_type().is_websocket() {
             return Err(ClientError::InvalidSocketMode);
         }
 
-        let base_builder = self.create_base_client_builder().await?;
-        let packet_type = self.config.base.debug.traffic.packet_type;
-        let mut started_client = base_builder.start_base().await?;
-        let address = started_client.address;
+        // don't create bandwidth controller if credentials are disabled
+        let bandwidth_controller = if self.config.get_base().get_disabled_credentials_mode() {
+            None
+        } else {
+            Some(Self::create_bandwidth_controller(&self.config).await)
+        };
+
+        let base_client = BaseClientBuilder::new_from_base_config(
+            self.config.get_base(),
+            self.key_manager,
+            bandwidth_controller,
+            non_wasm_helpers::setup_fs_reply_surb_backend(
+                Some(self.config.get_base().get_reply_surb_database_path()),
+                self.config.get_debug_settings(),
+            )
+            .await?,
+        );
+
+        let address = base_client.as_mix_recipient();
+
+        let mut started_client = base_client.start_base().await?;
         let client_input = started_client.client_input.register_producer();
         let client_output = started_client.client_output.register_consumer();
 
@@ -190,7 +219,6 @@ impl SocketClient {
             reconstructed_receiver,
             address,
             shutdown_notifier: started_client.task_manager,
-            packet_type,
         })
     }
 }
@@ -204,7 +232,6 @@ pub struct DirectClient {
 
     // we need to keep reference to this guy otherwise things will start dropping
     shutdown_notifier: TaskManager,
-    packet_type: PacketType,
 }
 
 impl DirectClient {
@@ -225,7 +252,7 @@ impl DirectClient {
     /// well enough in local tests)
     pub async fn send_regular_message(&mut self, recipient: Recipient, message: Vec<u8>) {
         let lane = TransmissionLane::General;
-        let input_msg = InputMessage::new_regular(recipient, message, lane, Some(self.packet_type));
+        let input_msg = InputMessage::new_regular(recipient, message, lane);
 
         self.client_input
             .input_sender
@@ -244,13 +271,7 @@ impl DirectClient {
         reply_surbs: u32,
     ) {
         let lane = TransmissionLane::General;
-        let input_msg = InputMessage::new_anonymous(
-            recipient,
-            message,
-            reply_surbs,
-            lane,
-            Some(self.packet_type),
-        );
+        let input_msg = InputMessage::new_anonymous(recipient, message, reply_surbs, lane);
 
         self.client_input
             .input_sender
@@ -264,8 +285,7 @@ impl DirectClient {
     /// well enough in local tests)
     pub async fn send_reply(&mut self, recipient_tag: AnonymousSenderTag, message: Vec<u8>) {
         let lane = TransmissionLane::General;
-        let input_msg =
-            InputMessage::new_reply(recipient_tag, message, lane, Some(self.packet_type));
+        let input_msg = InputMessage::new_reply(recipient_tag, message, lane);
 
         self.client_input
             .input_sender

clients/native/src/commands/init.rs

@@ -1,24 +1,19 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::client::config::{
-    default_config_directory, default_config_filepath, default_data_directory,
-};
-use crate::commands::try_upgrade_config;
+use crate::commands::try_upgrade_v1_1_13_config;
 use crate::{
     client::config::Config,
     commands::{override_config, OverrideConfig},
     error::ClientError,
 };
 use clap::Args;
-use nym_bin_common::output_format::OutputFormat;
-use nym_client_core::client::key_manager::persistence::OnDiskKeys;
+use nym_config::NymConfig;
 use nym_crypto::asymmetric::identity;
 use nym_sphinx::addressing::clients::Recipient;
 use serde::Serialize;
 use std::fmt::Display;
 use std::net::IpAddr;
-use std::{fs, io};
 use tap::TapFallible;
 
 #[derive(Args, Clone)]
@@ -76,8 +71,9 @@ pub(crate) struct Init {
     #[clap(long, hide = true)]
     enabled_credentials_mode: Option<bool>,
 
-    #[clap(short, long, default_value_t = OutputFormat::default())]
-    output: OutputFormat,
+    /// Save a summary of the initialization to a json file
+    #[clap(long)]
+    output_json: bool,
 }
 
 impl From<Init> for OverrideConfig {
@@ -99,17 +95,15 @@ impl From<Init> for OverrideConfig {
 #[derive(Debug, Serialize)]
 pub struct InitResults {
     #[serde(flatten)]
-    client_core: nym_client_core::init::InitResults,
-    client_listening_port: u16,
-    client_address: String,
+    client_core: client_core::init::InitResults,
+    client_listening_port: String,
 }
 
 impl InitResults {
     fn new(config: &Config, address: &Recipient) -> Self {
         Self {
-            client_core: nym_client_core::init::InitResults::new(&config.base, address),
-            client_listening_port: config.socket.listening_port,
-            client_address: address.to_string(),
+            client_core: client_core::init::InitResults::new(config.get_base(), address),
+            client_listening_port: config.get_listening_port().to_string(),
         }
     }
 }
@@ -117,37 +111,28 @@ impl InitResults {
 impl Display for InitResults {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         writeln!(f, "{}", self.client_core)?;
-        writeln!(f, "Client listening port: {}", self.client_listening_port)?;
-        write!(f, "Address of this client: {}", self.client_address)
+        write!(f, "Client listening port: {}", self.client_listening_port)
     }
 }
 
-fn init_paths(id: &str) -> io::Result<()> {
-    fs::create_dir_all(default_data_directory(id))?;
-    fs::create_dir_all(default_config_directory(id))
-}
-
 pub(crate) async fn execute(args: &Init) -> Result<(), ClientError> {
-    eprintln!("Initialising client...");
+    println!("Initialising client...");
 
     let id = &args.id;
 
-    let already_init = if default_config_filepath(id).exists() {
+    let already_init = Config::default_config_file_path(id).exists();
+    if already_init {
         // in case we're using old config, try to upgrade it
         // (if we're using the current version, it's a no-op)
-        try_upgrade_config(id)?;
-        eprintln!("Client \"{id}\" was already initialised before");
-        true
-    } else {
-        init_paths(id)?;
-        false
-    };
+        try_upgrade_v1_1_13_config(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 {
-        eprintln!("Instructed to force registering gateway. This might overwrite keys!");
+        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
@@ -163,37 +148,45 @@ 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 key_store = OnDiskKeys::new(config.storage_paths.common_paths.keys.clone());
-    let gateway = nym_client_core::init::setup_gateway_from_config::<_>(
-        &key_store,
+    let gateway = client_core::init::setup_gateway_from_config::<Config, _>(
         register_gateway,
         user_chosen_gateway_id,
-        &config.base,
+        config.get_base(),
         args.latency_based_selection,
     )
     .await
     .tap_err(|err| eprintln!("Failed to setup gateway\nError: {err}"))?;
 
-    config.base.set_gateway_endpoint(gateway);
+    config.get_base_mut().set_gateway_endpoint(gateway);
 
-    let config_save_location = config.default_location();
-    config.save_to_default_location().tap_err(|_| {
+    config.save_to_file(None).tap_err(|_| {
         log::error!("Failed to save the config file");
     })?;
-    eprintln!(
-        "Saved configuration file to {}",
-        config_save_location.display()
-    );
 
-    let address = nym_client_core::init::get_client_address_from_stored_ondisk_keys(
-        &config.storage_paths.common_paths.keys,
-        &config.base.client.gateway_endpoint,
-    )?;
-
-    eprintln!("Client configuration completed.\n");
+    print_saved_config(&config);
 
+    let address = client_core::init::get_client_address_from_stored_keys(config.get_base())?;
     let init_results = InitResults::new(&config, &address);
-    println!("{}", args.output.format(&init_results));
+    println!("{init_results}");
 
+    // Output summary to a json file, if specified
+    if args.output_json {
+        client_core::init::output_to_json(&init_results, "client_init_results.json");
+    }
+
+    println!("\nThe address of this client is: {address}\n");
     Ok(())
 }
+
+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!("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());
+    log::debug!(
+        "Gateway listener: {}",
+        config.get_base().get_gateway_listener()
+    );
+    println!("Client configuration completed.\n");
+}

clients/native/src/commands/mod.rs

@@ -2,16 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::client::config::old_config_v1_1_13::OldConfigV1_1_13;
-use crate::client::config::old_config_v1_1_19::ConfigV1_1_19;
-use crate::client::config::{BaseClientConfig, Config};
-use crate::error::ClientError;
+use crate::client::config::{BaseConfig, Config};
 use clap::CommandFactory;
 use clap::{Parser, Subcommand};
 use lazy_static::lazy_static;
-use log::{error, info};
+use log::info;
 use nym_bin_common::build_information::BinaryBuildInformation;
 use nym_bin_common::completions::{fig_generate, ArgShell};
-use nym_config::OptionalSet;
+use nym_config::{NymConfig, OptionalSet};
 use std::error::Error;
 use std::net::IpAddr;
 
@@ -84,92 +82,40 @@ pub(crate) async fn execute(args: &Cli) -> Result<(), Box<dyn Error + Send + Syn
 pub(crate) fn override_config(config: Config, args: OverrideConfig) -> Config {
     config
         .with_optional(Config::with_disabled_socket, args.disable_socket)
-        .with_base(
-            BaseClientConfig::with_high_default_traffic_volume,
-            args.fastmode,
-        )
-        .with_base(BaseClientConfig::with_disabled_cover_traffic, args.no_cover)
+        .with_base(BaseConfig::with_high_default_traffic_volume, args.fastmode)
+        .with_base(BaseConfig::with_disabled_cover_traffic, args.no_cover)
         .with_optional(Config::with_port, args.port)
         .with_optional(Config::with_host, args.host)
         .with_optional_custom_env_ext(
-            BaseClientConfig::with_custom_nym_apis,
+            BaseConfig::with_custom_nym_apis,
             args.nym_apis,
             nym_network_defaults::var_names::NYM_API,
             nym_config::parse_urls,
         )
         .with_optional_custom_env_ext(
-            BaseClientConfig::with_custom_nyxd,
+            BaseConfig::with_custom_nyxd,
             args.nyxd_urls,
             nym_network_defaults::var_names::NYXD,
             nym_config::parse_urls,
         )
         .with_optional_ext(
-            BaseClientConfig::with_disabled_credentials,
+            BaseConfig::with_disabled_credentials,
             args.enabled_credentials_mode.map(|b| !b),
         )
 }
 
-fn try_upgrade_v1_1_13_config(id: &str) -> Result<bool, ClientError> {
-    use nym_config::legacy_helpers::nym_config::MigrationNymConfig;
-
-    // explicitly load it as v1.1.13 (which is incompatible with the next step, i.e. 1.1.19)
+fn try_upgrade_v1_1_13_config(id: &str) -> std::io::Result<()> {
+    // explicitly load it as v1.1.13 (which is incompatible with the current, i.e. 1.1.14+)
     let Ok(old_config) = OldConfigV1_1_13::load_from_file(id) else {
         // if we failed to load it, there might have been nothing to upgrade
         // or maybe it was an even older file. in either way. just ignore it and carry on with our day
-        return Ok(false);
+        return Ok(());
     };
     info!("It seems the client is using <= v1.1.13 config template.");
     info!("It is going to get updated to the current specification.");
 
-    let updated_step1: ConfigV1_1_19 = old_config.into();
-    let updated: Config = updated_step1.into();
-
-    updated.save_to_default_location()?;
-    Ok(true)
-}
-
-fn try_upgrade_v1_1_19_config(id: &str) -> Result<bool, ClientError> {
-    use nym_config::legacy_helpers::nym_config::MigrationNymConfig;
-
-    // explicitly load it as v1.1.19 (which is incompatible with the current one, i.e. +1.1.20)
-    let Ok(old_config) = ConfigV1_1_19::load_from_file(id) else {
-        // if we failed to load it, there might have been nothing to upgrade
-        // or maybe it was an even older file. in either way. just ignore it and carry on with our day
-        return Ok(false);
-    };
-    info!("It seems the client is using <= v1.1.19 config template.");
-    info!("It is going to get updated to the current specification.");
-
     let updated: Config = old_config.into();
-    updated.save_to_default_location()?;
-    Ok(true)
-}
-
-fn try_upgrade_config(id: &str) -> Result<(), ClientError> {
-    let upgraded = try_upgrade_v1_1_13_config(id)?;
-    if !upgraded {
-        try_upgrade_v1_1_19_config(id)?;
-    }
-
-    Ok(())
-}
-
-fn try_load_current_config(id: &str) -> Result<Config, ClientError> {
-    try_upgrade_config(id)?;
-
-    let config = match Config::read_from_default_path(id) {
-        Ok(cfg) => cfg,
-        Err(err) => {
-            error!("Failed to load config for {id}. Are you sure you have run `init` before? (Error was: {err})");
-            return Err(ClientError::FailedToLoadConfig(id.to_string()));
-        }
-    };
-
-    if !config.validate() {
-        return Err(ClientError::ConfigValidationFailure);
-    }
-
-    Ok(config)
+    updated.save_to_file(None)
 }
 
 #[cfg(test)]

clients/native/src/commands/run.rs

@@ -1,7 +1,10 @@
 // Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::commands::try_load_current_config;
+use std::error::Error;
+use std::net::IpAddr;
+
+use crate::commands::try_upgrade_v1_1_13_config;
 use crate::{
     client::{config::Config, SocketClient},
     commands::{override_config, OverrideConfig},
@@ -10,9 +13,8 @@ use crate::{
 use clap::Args;
 use log::*;
 use nym_bin_common::version_checker::is_minor_version_compatible;
+use nym_config::NymConfig;
 use nym_crypto::asymmetric::identity;
-use std::error::Error;
-use std::net::IpAddr;
 
 #[derive(Args, Clone)]
 pub(crate) struct Run {
@@ -80,7 +82,7 @@ impl From<Run> for OverrideConfig {
 // network version. It might do so in the future.
 fn version_check(cfg: &Config) -> bool {
     let binary_version = env!("CARGO_PKG_VERSION");
-    let config_version = &cfg.base.client.version;
+    let config_version = cfg.get_base().get_version();
     if binary_version == config_version {
         true
     } else {
@@ -96,10 +98,26 @@ fn version_check(cfg: &Config) -> bool {
 }
 
 pub(crate) async fn execute(args: &Run) -> Result<(), Box<dyn Error + Send + Sync>> {
-    eprintln!("Starting client {}...", args.id);
+    let id = &args.id;
 
-    let mut config = try_load_current_config(&args.id)?;
-    config = override_config(config, OverrideConfig::from(args.clone()));
+    // in case we're using old config, try to upgrade it
+    // (if we're using the current version, it's a no-op)
+    try_upgrade_v1_1_13_config(id)?;
+
+    let mut config = match Config::load_from_file(id) {
+        Ok(cfg) => cfg,
+        Err(err) => {
+            error!("Failed to load config for {}. Are you sure you have run `init` before? (Error was: {err})", id);
+            return Err(Box::new(ClientError::FailedToLoadConfig(id.to_string())));
+        }
+    };
+
+    let override_config_fields = OverrideConfig::from(args.clone());
+    config = override_config(config, override_config_fields);
+
+    if config.get_base_mut().set_empty_fields_to_defaults() {
+        warn!("some of the core config options were left unset. the default values are going to get used instead.");
+    }
 
     if !version_check(&config) {
         error!("failed the local version check");

clients/native/src/commands/upgrade.rs

@@ -1,14 +1,42 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::client::config::Config;
-use crate::commands::try_load_current_config;
-use clap::Args;
+use crate::client::config::{Config, MISSING_VALUE};
+
 use nym_bin_common::version_checker::Version;
+use nym_config::NymConfig;
+
+use clap::Args;
+use std::fmt::Display;
 use std::process;
 
-fn unimplemented_upgrade(current_version: &Version, config_version: &Version) -> ! {
-    eprintln!("Cannot perform upgrade from {config_version} to {current_version} as it hasn't been implemented yet");
+#[allow(dead_code)]
+fn fail_upgrade<D1: Display, D2: Display>(from_version: D1, to_version: D2) -> ! {
+    print_failed_upgrade(from_version, to_version);
+    process::exit(1)
+}
+
+fn print_start_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
+    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 {from} to {to} failed!\n==================\n");
+}
+
+fn print_successful_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
+    println!("Upgrade from {from} to {to} was successful!\n==================\n");
+}
+
+fn outdated_upgrade(config_version: &Version, package_version: &Version) -> ! {
+    eprintln!(
+        "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 {config_version} to {current_version}. Please let the developers know about this issue if you expected it to work!");
     process::exit(1)
 }
 
@@ -20,7 +48,7 @@ pub(crate) struct Upgrade {
 }
 
 fn parse_config_version(config: &Config) -> Version {
-    let version = Version::parse(&config.base.client.version).unwrap_or_else(|err| {
+    let version = Version::parse(config.get_base().get_version()).unwrap_or_else(|err| {
         eprintln!("failed to parse client version! - {err}");
         process::exit(1)
     });
@@ -49,14 +77,53 @@ fn parse_package_version() -> Version {
     version
 }
 
-fn do_upgrade(config: Config, _args: &Upgrade, package_version: &Version) {
-    let config_version = parse_config_version(&config);
-    if &config_version == package_version {
-        println!("You're using the most recent version!");
-        return;
-    }
+fn minor_0_12_upgrade(
+    mut config: Config,
+    _matches: &Upgrade,
+    config_version: &Version,
+    package_version: &Version,
+) -> Config {
+    let to_version = if package_version.major == 0 && package_version.minor == 12 {
+        package_version.clone()
+    } else {
+        Version::new(0, 12, 0)
+    };
 
-    unimplemented_upgrade(package_version, &config_version)
+    print_start_upgrade(config_version, &to_version);
+
+    config
+        .get_base_mut()
+        .set_custom_version(to_version.to_string().as_ref());
+
+    config.save_to_file(None).unwrap_or_else(|err| {
+        eprintln!("failed to overwrite config file! - {err}");
+        print_failed_upgrade(config_version, &to_version);
+        process::exit(1);
+    });
+
+    print_successful_upgrade(config_version, to_version);
+
+    config
+}
+
+fn do_upgrade(mut config: Config, args: &Upgrade, package_version: &Version) {
+    loop {
+        let config_version = parse_config_version(&config);
+
+        if &config_version == package_version {
+            println!("You're using the most recent version!");
+            return;
+        }
+
+        config = match config_version.major {
+            0 => match config_version.minor {
+                9 | 10 => outdated_upgrade(&config_version, package_version),
+                11 => minor_0_12_upgrade(config, args, &config_version, package_version),
+                _ => unsupported_upgrade(&config_version, package_version),
+            },
+            _ => unsupported_upgrade(&config_version, package_version),
+        }
+    }
 }
 
 pub(crate) fn execute(args: &Upgrade) {
@@ -64,15 +131,16 @@ pub(crate) fn execute(args: &Upgrade) {
 
     let id = &args.id;
 
-    let existing_config = try_load_current_config(id).unwrap_or_else(|err| {
+    let existing_config = Config::load_from_file(id).unwrap_or_else(|err| {
         eprintln!("failed to load existing config file! - {err}");
         process::exit(1)
     });
 
-    if existing_config.base.client.version.is_empty() {
+    if existing_config.get_base().get_version() == MISSING_VALUE {
         eprintln!("the existing configuration file does not seem to contain version number.");
         process::exit(1);
     }
 
+    // here be upgrade path to 0.9.X and beyond based on version number from config
     do_upgrade(existing_config, args, &package_version)
 }

clients/native/src/error.rs

@@ -1,4 +1,4 @@
-use nym_client_core::error::ClientCoreError;
+use client_core::error::ClientCoreError;
 
 #[derive(thiserror::Error, Debug)]
 pub enum ClientError {
@@ -11,10 +11,6 @@ pub enum ClientError {
     #[error("Failed to load config for: {0}")]
     FailedToLoadConfig(String),
 
-    // TODO: add more details here
-    #[error("Failed to validate the loaded config")]
-    ConfigValidationFailure,
-
     #[error("Failed local version check, client and config mismatch")]
     FailedLocalVersionCheck,
 

clients/native/src/main.rs

@@ -4,7 +4,7 @@
 use std::error::Error;
 
 use clap::{crate_name, crate_version, Parser};
-use nym_bin_common::logging::{maybe_print_banner, setup_logging};
+use nym_bin_common::logging::{banner, setup_logging};
 use nym_network_defaults::setup_env;
 
 pub mod client;
@@ -15,7 +15,7 @@ pub mod websocket;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     setup_logging();
-    maybe_print_banner(crate_name!(), crate_version!());
+    println!("{}", banner(crate_name!(), crate_version!()));
 
     let args = commands::Cli::parse();
     setup_env(args.config_env_file.as_ref());

clients/native/src/websocket/handler.rs

@@ -1,20 +1,18 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use futures::channel::mpsc;
-use futures::{SinkExt, StreamExt};
-use log::*;
-use nym_client_core::client::replies::reply_controller::requests::ReplyControllerSender;
-use nym_client_core::client::{
+use client_core::client::replies::reply_controller::requests::ReplyControllerSender;
+use client_core::client::{
     inbound_messages::{InputMessage, InputMessageSender},
     received_buffer::{
         ReceivedBufferMessage, ReceivedBufferRequestSender, ReconstructedMessagesReceiver,
     },
 };
-use nym_client_websocket_requests::{requests::ClientRequest, responses::ServerResponse};
+use futures::channel::mpsc;
+use futures::{SinkExt, StreamExt};
+use log::*;
 use nym_sphinx::addressing::clients::Recipient;
 use nym_sphinx::anonymous_replies::requests::AnonymousSenderTag;
-use nym_sphinx::params::PacketType;
 use nym_sphinx::receiver::ReconstructedMessage;
 use nym_task::connections::{
     ConnectionCommand, ConnectionCommandSender, ConnectionId, LaneQueueLengths, TransmissionLane,
@@ -27,6 +25,7 @@ use tokio_tungstenite::{
     tungstenite::{protocol::Message as WsMessage, Error as WsError},
     WebSocketStream,
 };
+use websocket_requests::{requests::ClientRequest, responses::ServerResponse};
 
 #[derive(Default)]
 enum ReceivedResponseType {
@@ -42,7 +41,6 @@ pub(crate) struct HandlerBuilder {
     self_full_address: Recipient,
     lane_queue_lengths: LaneQueueLengths,
     reply_controller_sender: ReplyControllerSender,
-    packet_type: Option<PacketType>,
 }
 
 impl HandlerBuilder {
@@ -53,7 +51,6 @@ impl HandlerBuilder {
         self_full_address: &Recipient,
         lane_queue_lengths: LaneQueueLengths,
         reply_controller_sender: ReplyControllerSender,
-        packet_type: Option<PacketType>,
     ) -> Self {
         Self {
             msg_input,
@@ -62,7 +59,6 @@ impl HandlerBuilder {
             self_full_address: *self_full_address,
             lane_queue_lengths,
             reply_controller_sender,
-            packet_type,
         }
     }
 
@@ -77,7 +73,6 @@ impl HandlerBuilder {
             received_response_type: Default::default(),
             lane_queue_lengths: self.lane_queue_lengths.clone(),
             reply_controller_sender: self.reply_controller_sender.clone(),
-            packet_type: self.packet_type,
         }
     }
 }
@@ -91,7 +86,6 @@ pub(crate) struct Handler {
     received_response_type: ReceivedResponseType,
     lane_queue_lengths: LaneQueueLengths,
     reply_controller_sender: ReplyControllerSender,
-    packet_type: Option<PacketType>,
 }
 
 impl Drop for Handler {
@@ -166,7 +160,7 @@ impl Handler {
         });
 
         // the ack control is now responsible for chunking, etc.
-        let input_msg = InputMessage::new_regular(recipient, message, lane, self.packet_type);
+        let input_msg = InputMessage::new_regular(recipient, message, lane);
         self.msg_input
             .send(input_msg)
             .await
@@ -197,8 +191,7 @@ impl Handler {
             TransmissionLane::ConnectionId(id)
         });
 
-        let input_msg =
-            InputMessage::new_anonymous(recipient, message, reply_surbs, lane, self.packet_type);
+        let input_msg = InputMessage::new_anonymous(recipient, message, reply_surbs, lane);
         self.msg_input
             .send(input_msg)
             .await
@@ -225,7 +218,7 @@ impl Handler {
             TransmissionLane::ConnectionId(id)
         });
 
-        let input_msg = InputMessage::new_reply(recipient_tag, message, lane, self.packet_type);
+        let input_msg = InputMessage::new_reply(recipient_tag, message, lane);
         self.msg_input
             .send(input_msg)
             .await

clients/native/websocket-requests/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "nym-client-websocket-requests"
+name = "websocket-requests"
 version = "0.1.0"
 authors = ["Jędrzej Stuczyński <andrew@nymtech.net>"]
 edition = "2021"
@@ -7,7 +7,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-serde = { workspace = true, features = ["derive"] }
-serde_json = { workspace = true }
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
 
 nym-sphinx = { path = "../../../common/nymsphinx" }

clients/socks5/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-socks5-client"
-version = "1.1.19"
+version = "1.1.13"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
 description = "A SOCKS5 localhost proxy that converts incoming messages to Sphinx and sends them to a Nym address"
 edition = "2021"
@@ -19,14 +19,14 @@ tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal"] }
 url = "2.2"
 
 # internal
-nym-bin-common = { path = "../../common/bin-common", features = ["output_format"] }
-nym-client-core = { path = "../../common/client-core", features = ["fs-surb-storage"] }
+nym-bin-common = { path = "../../common/bin-common" }
+client-core = { path = "../../common/client-core", features = ["fs-surb-storage"] }
 nym-coconut-interface = { path = "../../common/coconut-interface" }
 nym-config = { path = "../../common/config" }
+mobile-storage = { path = "../../common/mobile-storage", optional = true }
 nym-credentials = { path = "../../common/credentials" }
 nym-crypto = { path = "../../common/crypto" }
-nym-gateway-requests = { path = "../../gateway/gateway-requests" }
-nym-credential-storage = { path = "../../common/credential-storage" }
+gateway-requests = { path = "../../gateway/gateway-requests" }
 nym-network-defaults = { path = "../../common/network-defaults" }
 nym-sphinx = { path = "../../common/nymsphinx" }
 nym-ordered-buffer = { path = "../../common/socks5/ordered-buffer" }
@@ -37,3 +37,4 @@ nym-socks5-client-core = { path = "../../common/socks5-client-core" }
 [features]
 default = []
 eth = []
+mobile = ["mobile-storage", "nym-socks5-client-core/mobile"]

clients/socks5/src/commands/init.rs

@@ -1,22 +1,18 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::commands::try_upgrade_config;
-use crate::config::{
-    default_config_directory, default_config_filepath, default_data_directory, Config,
-};
+use crate::commands::try_upgrade_v1_1_13_config;
 use crate::{
     commands::{override_config, OverrideConfig},
     error::Socks5ClientError,
 };
 use clap::Args;
-use nym_bin_common::output_format::OutputFormat;
-use nym_client_core::client::key_manager::persistence::OnDiskKeys;
+use nym_config::NymConfig;
 use nym_crypto::asymmetric::identity;
+use nym_socks5_client_core::config::Config;
 use nym_sphinx::addressing::clients::Recipient;
 use serde::Serialize;
 use std::fmt::Display;
-use std::{fs, io};
 use tap::TapFallible;
 
 #[derive(Args, Clone)]
@@ -79,8 +75,9 @@ pub(crate) struct Init {
     #[clap(long, hide = true)]
     enabled_credentials_mode: Option<bool>,
 
-    #[clap(short, long, default_value_t = OutputFormat::default())]
-    output: OutputFormat,
+    /// Save a summary of the initialization to a json file
+    #[clap(long)]
+    output_json: bool,
 }
 
 impl From<Init> for OverrideConfig {
@@ -93,7 +90,6 @@ impl From<Init> for OverrideConfig {
             no_cover: init_config.no_cover,
             nyxd_urls: init_config.nyxd_urls,
             enabled_credentials_mode: init_config.enabled_credentials_mode,
-            outfox: false,
         }
     }
 }
@@ -101,17 +97,15 @@ impl From<Init> for OverrideConfig {
 #[derive(Debug, Serialize)]
 pub struct InitResults {
     #[serde(flatten)]
-    client_core: nym_client_core::init::InitResults,
-    socks5_listening_port: u16,
-    client_address: String,
+    client_core: client_core::init::InitResults,
+    socks5_listening_port: String,
 }
 
 impl InitResults {
     fn new(config: &Config, address: &Recipient) -> Self {
         Self {
-            client_core: nym_client_core::init::InitResults::new(&config.core.base, address),
-            socks5_listening_port: config.core.socks5.listening_port,
-            client_address: address.to_string(),
+            client_core: client_core::init::InitResults::new(config.get_base(), address),
+            socks5_listening_port: config.get_listening_port().to_string(),
         }
     }
 }
@@ -119,38 +113,29 @@ impl InitResults {
 impl Display for InitResults {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         writeln!(f, "{}", self.client_core)?;
-        writeln!(f, "SOCKS5 listening port: {}", self.socks5_listening_port)?;
-        write!(f, "Address of this client: {}", self.client_address)
+        write!(f, "SOCKS5 listening port: {}", self.socks5_listening_port)
     }
 }
 
-fn init_paths(id: &str) -> io::Result<()> {
-    fs::create_dir_all(default_data_directory(id))?;
-    fs::create_dir_all(default_config_directory(id))
-}
-
 pub(crate) async fn execute(args: &Init) -> Result<(), Socks5ClientError> {
-    eprintln!("Initialising client...");
+    println!("Initialising client...");
 
     let id = &args.id;
     let provider_address = &args.provider;
 
-    let already_init = if default_config_filepath(id).exists() {
+    let already_init = Config::default_config_file_path(id).exists();
+    if already_init {
         // in case we're using old config, try to upgrade it
         // (if we're using the current version, it's a no-op)
-        try_upgrade_config(id)?;
-        eprintln!("SOCKS5 client \"{id}\" was already initialised before");
-        true
-    } else {
-        init_paths(id)?;
-        false
-    };
+        try_upgrade_v1_1_13_config(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 {
-        eprintln!("Instructed to force registering gateway. This might overwrite keys!");
+        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
@@ -169,36 +154,47 @@ 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 key_store = OnDiskKeys::new(config.storage_paths.common_paths.keys.clone());
-    let gateway = nym_client_core::init::setup_gateway_from_config::<_>(
-        &key_store,
+    let gateway = client_core::init::setup_gateway_from_config::<Config, _>(
         register_gateway,
         user_chosen_gateway_id,
-        &config.core.base,
+        config.get_base(),
         args.latency_based_selection,
     )
     .await
     .tap_err(|err| eprintln!("Failed to setup gateway\nError: {err}"))?;
 
-    config.core.base.set_gateway_endpoint(gateway);
+    config.get_base_mut().set_gateway_endpoint(gateway);
 
     // TODO: ask the service provider we specified for its interface version and set it in the config
 
-    let config_save_location = config.default_location();
-    config.save_to_default_location().tap_err(|_| {
+    config.save_to_file(None).tap_err(|_| {
         log::error!("Failed to save the config file");
     })?;
-    eprintln!(
-        "Saved configuration file to {}",
-        config_save_location.display()
-    );
 
-    let address = nym_client_core::init::get_client_address_from_stored_ondisk_keys(
-        &config.storage_paths.common_paths.keys,
-        &config.core.base.client.gateway_endpoint,
-    )?;
+    print_saved_config(&config);
+
+    let address = client_core::init::get_client_address_from_stored_keys(config.get_base())?;
     let init_results = InitResults::new(&config, &address);
-    println!("{}", args.output.format(&init_results));
+    println!("{}", init_results);
 
+    // Output summary to a json file, if specified
+    if args.output_json {
+        client_core::init::output_to_json(&init_results, "socks5_client_init_results.json");
+    }
+
+    println!("\nThe address of this client is: {}\n", address);
     Ok(())
 }
+
+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!("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());
+    log::debug!(
+        "Gateway listener: {}",
+        config.get_base().get_gateway_listener()
+    );
+    println!("Client configuration completed.\n");
+}

clients/socks5/src/commands/mod.rs

@@ -1,18 +1,15 @@
 // Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::config::old_config_v1_1_13::OldConfigV1_1_13;
-use crate::config::old_config_v1_1_19::ConfigV1_1_19;
-use crate::config::{BaseClientConfig, Config};
-use crate::error::Socks5ClientError;
 use clap::CommandFactory;
 use clap::{Parser, Subcommand};
 use lazy_static::lazy_static;
-use log::{error, info};
+use log::info;
 use nym_bin_common::build_information::BinaryBuildInformation;
 use nym_bin_common::completions::{fig_generate, ArgShell};
-use nym_config::OptionalSet;
-use nym_sphinx::params::PacketType;
+use nym_config::{NymConfig, OptionalSet};
+use nym_socks5_client_core::config::old_config_v1_1_13::OldConfigV1_1_13;
+use nym_socks5_client_core::config::{BaseConfig, Config};
 use std::error::Error;
 
 pub mod init;
@@ -67,7 +64,6 @@ pub(crate) struct OverrideConfig {
     no_cover: bool,
     nyxd_urls: Option<Vec<url::Url>>,
     enabled_credentials_mode: Option<bool>,
-    outfox: bool,
 }
 
 pub(crate) async fn execute(args: &Cli) -> Result<(), Box<dyn Error + Send + Sync>> {
@@ -84,99 +80,41 @@ pub(crate) async fn execute(args: &Cli) -> Result<(), Box<dyn Error + Send + Syn
 }
 
 pub(crate) fn override_config(config: Config, args: OverrideConfig) -> Config {
-    let packet_type = if args.outfox {
-        PacketType::Outfox
-    } else {
-        PacketType::Mix
-    };
     config
-        .with_base(
-            BaseClientConfig::with_high_default_traffic_volume,
-            args.fastmode,
-        )
-        .with_base(BaseClientConfig::with_disabled_cover_traffic, args.no_cover)
-        .with_base(BaseClientConfig::with_packet_type, packet_type)
+        .with_base(BaseConfig::with_high_default_traffic_volume, args.fastmode)
+        .with_base(BaseConfig::with_disabled_cover_traffic, args.no_cover)
         .with_optional(Config::with_anonymous_replies, args.use_anonymous_replies)
         .with_optional(Config::with_port, args.port)
-        .with_optional_base_custom_env(
-            BaseClientConfig::with_custom_nym_apis,
+        .with_optional_custom_env_ext(
+            BaseConfig::with_custom_nym_apis,
             args.nym_apis,
             nym_network_defaults::var_names::NYM_API,
             nym_config::parse_urls,
         )
-        .with_optional_base_custom_env(
-            BaseClientConfig::with_custom_nyxd,
+        .with_optional_custom_env_ext(
+            BaseConfig::with_custom_nyxd,
             args.nyxd_urls,
             nym_network_defaults::var_names::NYXD,
             nym_config::parse_urls,
         )
-        .with_optional_base(
-            BaseClientConfig::with_disabled_credentials,
+        .with_optional_ext(
+            BaseConfig::with_disabled_credentials,
             args.enabled_credentials_mode.map(|b| !b),
         )
 }
 
-fn try_upgrade_v1_1_13_config(id: &str) -> Result<bool, Socks5ClientError> {
-    use nym_config::legacy_helpers::nym_config::MigrationNymConfig;
-
-    // explicitly load it as v1.1.13 (which is incompatible with the next step, i.e. 1.1.19)
+fn try_upgrade_v1_1_13_config(id: &str) -> std::io::Result<()> {
+    // explicitly load it as v1.1.13 (which is incompatible with the current, i.e. 1.1.14+)
     let Ok(old_config) = OldConfigV1_1_13::load_from_file(id) else {
         // if we failed to load it, there might have been nothing to upgrade
         // or maybe it was an even older file. in either way. just ignore it and carry on with our day
-        return Ok(false);
+        return Ok(());
     };
     info!("It seems the client is using <= v1.1.13 config template.");
     info!("It is going to get updated to the current specification.");
 
-    let updated_step1: ConfigV1_1_19 = old_config.into();
-    let updated: Config = updated_step1.into();
-
-    updated.save_to_default_location()?;
-    Ok(true)
-}
-
-fn try_upgrade_v1_1_19_config(id: &str) -> Result<bool, Socks5ClientError> {
-    use nym_config::legacy_helpers::nym_config::MigrationNymConfig;
-
-    // explicitly load it as v1.1.19 (which is incompatible with the current one, i.e. +1.1.20)
-    let Ok(old_config) = ConfigV1_1_19::load_from_file(id) else {
-        // if we failed to load it, there might have been nothing to upgrade
-        // or maybe it was an even older file. in either way. just ignore it and carry on with our day
-        return Ok(false);
-    };
-    info!("It seems the client is using <= v1.1.19 config template.");
-    info!("It is going to get updated to the current specification.");
-
     let updated: Config = old_config.into();
-    updated.save_to_default_location()?;
-    Ok(true)
-}
-
-fn try_upgrade_config(id: &str) -> Result<(), Socks5ClientError> {
-    let upgraded = try_upgrade_v1_1_13_config(id)?;
-    if !upgraded {
-        try_upgrade_v1_1_19_config(id)?;
-    }
-
-    Ok(())
-}
-
-fn try_load_current_config(id: &str) -> Result<Config, Socks5ClientError> {
-    try_upgrade_config(id)?;
-
-    let config = match Config::read_from_default_path(id) {
-        Ok(cfg) => cfg,
-        Err(err) => {
-            error!("Failed to load config for {id}. Are you sure you have run `init` before? (Error was: {err})");
-            return Err(Socks5ClientError::FailedToLoadConfig(id.to_string()));
-        }
-    };
-
-    if !config.validate() {
-        return Err(Socks5ClientError::ConfigValidationFailure);
-    }
-
-    Ok(config)
+    updated.save_to_file(None)
 }
 
 #[cfg(test)]

clients/socks5/src/commands/run.rs

@@ -1,8 +1,7 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::commands::try_load_current_config;
-use crate::config::Config;
+use crate::commands::try_upgrade_v1_1_13_config;
 use crate::{
     commands::{override_config, OverrideConfig},
     error::Socks5ClientError,
@@ -10,9 +9,9 @@ use crate::{
 use clap::Args;
 use log::*;
 use nym_bin_common::version_checker::is_minor_version_compatible;
-use nym_client_core::client::base_client::storage::OnDiskPersistent;
+use nym_config::NymConfig;
 use nym_crypto::asymmetric::identity;
-use nym_socks5_client_core::NymClient;
+use nym_socks5_client_core::{config::Config, NymClient};
 use nym_sphinx::addressing::clients::Recipient;
 
 #[derive(Args, Clone)]
@@ -21,6 +20,10 @@ pub(crate) struct Run {
     #[clap(long)]
     id: String,
 
+    /// Custom path to the nym-mixnet-client configuration file
+    #[clap(long)]
+    config: Option<String>,
+
     /// Specifies whether this client is going to use an anonymous sender tag for communication with the service provider.
     /// While this is going to hide its actual address information, it will make the actual communication
     /// slower and consume nearly double the bandwidth as it will require sending reply SURBs.
@@ -64,9 +67,6 @@ pub(crate) struct Run {
     /// with bandwidth credential requirement.
     #[clap(long, hide = true)]
     enabled_credentials_mode: Option<bool>,
-
-    #[clap(long, hide = true, action)]
-    outfox: bool,
 }
 
 impl From<Run> for OverrideConfig {
@@ -79,7 +79,6 @@ impl From<Run> for OverrideConfig {
             no_cover: run_config.no_cover,
             nyxd_urls: run_config.nyxd_urls,
             enabled_credentials_mode: run_config.enabled_credentials_mode,
-            outfox: run_config.outfox,
         }
     }
 }
@@ -88,12 +87,13 @@ impl From<Run> for OverrideConfig {
 // network version. It might do so in the future.
 fn version_check(cfg: &Config) -> bool {
     let binary_version = env!("CARGO_PKG_VERSION");
-    let config_version = &cfg.core.base.client.version;
+    let config_version = cfg.get_base().get_version();
     if binary_version == config_version {
         true
     } else {
         warn!(
-            "The socks5-client binary has different version than what is specified in config file! {binary_version} and {config_version}",
+            "The mixnode binary has different version than what is specified in config file! {} and {}",
+            binary_version, config_version
         );
         if is_minor_version_compatible(binary_version, config_version) {
             info!("but they are still semver compatible. However, consider running the `upgrade` command");
@@ -106,18 +106,33 @@ fn version_check(cfg: &Config) -> bool {
 }
 
 pub(crate) async fn execute(args: &Run) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
-    eprintln!("Starting client {}...", args.id);
+    let id = &args.id;
 
-    let mut config = try_load_current_config(&args.id)?;
-    config = override_config(config, OverrideConfig::from(args.clone()));
+    // in case we're using old config, try to upgrade it
+    // (if we're using the current version, it's a no-op)
+    try_upgrade_v1_1_13_config(id)?;
+
+    let mut config = match Config::load_from_file(id) {
+        Ok(cfg) => cfg,
+        Err(err) => {
+            error!("Failed to load config for {}. Are you sure you have run `init` before? (Error was: {err})", id);
+            return Err(Box::new(Socks5ClientError::FailedToLoadConfig(
+                id.to_string(),
+            )));
+        }
+    };
+
+    let override_config_fields = OverrideConfig::from(args.clone());
+    config = override_config(config, override_config_fields);
+
+    if config.get_base_mut().set_empty_fields_to_defaults() {
+        warn!("some of the core config options were left unset. the default values are going to get used instead.");
+    }
 
     if !version_check(&config) {
         error!("failed the local version check");
         return Err(Box::new(Socks5ClientError::FailedLocalVersionCheck));
     }
 
-    let storage =
-        OnDiskPersistent::from_paths(config.storage_paths.common_paths, &config.core.base.debug)
-            .await?;
-    NymClient::new(config.core, storage).run_forever().await
+    NymClient::new(config).run_forever().await
 }

clients/socks5/src/commands/upgrade.rs

@@ -1,14 +1,50 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::commands::try_load_current_config;
-use crate::config::Config;
-use clap::Args;
 use nym_bin_common::version_checker::Version;
-use std::process;
+use nym_config::NymConfig;
+use nym_socks5_client_core::config::{Config, MISSING_VALUE};
 
-fn unimplemented_upgrade(current_version: &Version, config_version: &Version) -> ! {
-    eprintln!("Cannot perform upgrade from {config_version} to {current_version} as it hasn't been implemented yet");
+use clap::Args;
+use std::{fmt::Display, process};
+
+#[allow(dead_code)]
+fn fail_upgrade<D1: Display, D2: Display>(from_version: D1, to_version: D2) -> ! {
+    print_failed_upgrade(from_version, to_version);
+    process::exit(1)
+}
+
+fn print_start_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
+    println!(
+        "\n==================\nTrying to upgrade client from {} to {} ...",
+        from, to
+    );
+}
+
+fn print_failed_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
+    eprintln!(
+        "Upgrade from {} to {} failed!\n==================\n",
+        from, to
+    );
+}
+
+fn print_successful_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
+    println!(
+        "Upgrade from {} to {} was successful!\n==================\n",
+        from, to
+    );
+}
+
+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
+    );
+    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);
     process::exit(1)
 }
 
@@ -20,14 +56,15 @@ pub(crate) struct Upgrade {
 }
 
 fn parse_config_version(config: &Config) -> Version {
-    let version = Version::parse(&config.core.base.client.version).unwrap_or_else(|err| {
+    let version = Version::parse(config.get_base().get_version()).unwrap_or_else(|err| {
         eprintln!("failed to parse client version! - {err}");
         process::exit(1)
     });
 
     if version.is_prerelease() || !version.build.is_empty() {
         eprintln!(
-            "Trying to upgrade from a non-released version {version}. This is not supported!"
+            "Trying to upgrade from a non-released version {}. This is not supported!",
+            version
         );
         process::exit(1)
     }
@@ -42,21 +79,63 @@ 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 {version}. This is not supported!");
+        eprintln!(
+            "Trying to upgrade to a non-released version {}. This is not supported!",
+            version
+        );
         process::exit(1)
     }
 
     version
 }
 
-fn do_upgrade(config: Config, _args: &Upgrade, package_version: &Version) {
-    let config_version = parse_config_version(&config);
-    if &config_version == package_version {
-        println!("You're using the most recent version!");
-        return;
-    }
+fn minor_0_12_upgrade(
+    mut config: Config,
+    _args: &Upgrade,
+    config_version: &Version,
+    package_version: &Version,
+) -> Config {
+    let to_version = if package_version.major == 0 && package_version.minor == 12 {
+        package_version.clone()
+    } else {
+        Version::new(0, 12, 0)
+    };
 
-    unimplemented_upgrade(package_version, &config_version)
+    print_start_upgrade(config_version, &to_version);
+
+    config
+        .get_base_mut()
+        .set_custom_version(to_version.to_string().as_ref());
+
+    config.save_to_file(None).unwrap_or_else(|err| {
+        eprintln!("failed to overwrite config file! - {err}");
+        print_failed_upgrade(config_version, &to_version);
+        process::exit(1);
+    });
+
+    print_successful_upgrade(config_version, to_version);
+
+    config
+}
+
+fn do_upgrade(mut config: Config, args: &Upgrade, package_version: &Version) {
+    loop {
+        let config_version = parse_config_version(&config);
+
+        if &config_version == package_version {
+            println!("You're using the most recent version!");
+            return;
+        }
+
+        config = match config_version.major {
+            0 => match config_version.minor {
+                9 | 10 => outdated_upgrade(&config_version, package_version),
+                11 => minor_0_12_upgrade(config, args, &config_version, package_version),
+                _ => unsupported_upgrade(&config_version, package_version),
+            },
+            _ => unsupported_upgrade(&config_version, package_version),
+        }
+    }
 }
 
 pub(crate) fn execute(args: &Upgrade) {
@@ -64,15 +143,16 @@ pub(crate) fn execute(args: &Upgrade) {
 
     let id = &args.id;
 
-    let existing_config = try_load_current_config(id).unwrap_or_else(|err| {
+    let existing_config = Config::load_from_file(id).unwrap_or_else(|err| {
         eprintln!("failed to load existing config file! - {err}");
         process::exit(1)
     });
 
-    if existing_config.core.base.client.version.is_empty() {
+    if existing_config.get_base().get_version() == MISSING_VALUE {
         eprintln!("the existing configuration file does not seem to contain version number.");
         process::exit(1);
     }
 
+    // here be upgrade path to 0.9.X and beyond based on version number from config
     do_upgrade(existing_config, args, &package_version)
 }

clients/socks5/src/config/mod.rs

@@ -1,155 +0,0 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use crate::config::persistence::SocksClientPaths;
-use crate::config::template::CONFIG_TEMPLATE;
-use nym_bin_common::logging::LoggingSettings;
-use nym_config::{
-    must_get_home, read_config_from_toml_file, save_formatted_config_to_file, NymConfigTemplate,
-    DEFAULT_CONFIG_DIR, DEFAULT_CONFIG_FILENAME, DEFAULT_DATA_DIR, NYM_DIR,
-};
-use serde::{Deserialize, Serialize};
-use std::fmt::Debug;
-use std::io;
-use std::path::{Path, PathBuf};
-use std::str::FromStr;
-
-pub use nym_client_core::config::Config as BaseClientConfig;
-pub use nym_socks5_client_core::config::Config as CoreConfig;
-
-pub mod old_config_v1_1_13;
-pub mod old_config_v1_1_19;
-mod persistence;
-mod template;
-
-const DEFAULT_SOCKS5_CLIENTS_DIR: &str = "socks5-clients";
-
-/// Derive default path to clients's config directory.
-/// It should get resolved to `$HOME/.nym/socks5-clients/<id>/config`
-pub fn default_config_directory<P: AsRef<Path>>(id: P) -> PathBuf {
-    must_get_home()
-        .join(NYM_DIR)
-        .join(DEFAULT_SOCKS5_CLIENTS_DIR)
-        .join(id)
-        .join(DEFAULT_CONFIG_DIR)
-}
-
-/// Derive default path to client's config file.
-/// It should get resolved to `$HOME/.nym/socks5-clients/<id>/config/config.toml`
-pub fn default_config_filepath<P: AsRef<Path>>(id: P) -> PathBuf {
-    default_config_directory(id).join(DEFAULT_CONFIG_FILENAME)
-}
-
-/// Derive default path to client's data directory where files, such as keys, are stored.
-/// It should get resolved to `$HOME/.nym/socks5-clients/<id>/data`
-pub fn default_data_directory<P: AsRef<Path>>(id: P) -> PathBuf {
-    must_get_home()
-        .join(NYM_DIR)
-        .join(DEFAULT_SOCKS5_CLIENTS_DIR)
-        .join(id)
-        .join(DEFAULT_DATA_DIR)
-}
-
-#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
-#[serde(deny_unknown_fields)]
-pub struct Config {
-    pub core: CoreConfig,
-
-    pub storage_paths: SocksClientPaths,
-
-    pub logging: LoggingSettings,
-}
-
-impl NymConfigTemplate for Config {
-    fn template() -> &'static str {
-        CONFIG_TEMPLATE
-    }
-}
-
-impl Config {
-    pub fn new<S: AsRef<str>>(id: S, provider_mix_address: S) -> Self {
-        Config {
-            core: CoreConfig::new(id.as_ref(), provider_mix_address.as_ref()),
-            storage_paths: SocksClientPaths::new_default(default_data_directory(id.as_ref())),
-            logging: Default::default(),
-        }
-    }
-
-    pub fn read_from_toml_file<P: AsRef<Path>>(path: P) -> io::Result<Self> {
-        read_config_from_toml_file(path)
-    }
-
-    pub fn read_from_default_path<P: AsRef<Path>>(id: P) -> io::Result<Self> {
-        Self::read_from_toml_file(default_config_filepath(id))
-    }
-
-    pub fn default_location(&self) -> PathBuf {
-        default_config_filepath(&self.core.base.client.id)
-    }
-
-    pub fn save_to_default_location(&self) -> io::Result<()> {
-        let config_save_location: PathBuf = self.default_location();
-        save_formatted_config_to_file(self, config_save_location)
-    }
-
-    pub fn validate(&self) -> bool {
-        // no other sections have explicit requirements (yet)
-        self.core.validate()
-    }
-
-    pub fn with_port(mut self, port: u16) -> Self {
-        self.core.socks5.listening_port = port;
-        self
-    }
-
-    pub fn with_anonymous_replies(mut self, anonymous_replies: bool) -> Self {
-        self.core.socks5.send_anonymously = anonymous_replies;
-        self
-    }
-
-    // poor man's 'builder' method
-
-    pub fn with_base<F, T>(mut self, f: F, val: T) -> Self
-    where
-        F: Fn(BaseClientConfig, T) -> BaseClientConfig,
-    {
-        self.core = self.core.with_base(f, val);
-        self
-    }
-
-    pub fn with_optional_base<F, T>(mut self, f: F, val: Option<T>) -> Self
-    where
-        F: Fn(BaseClientConfig, T) -> BaseClientConfig,
-    {
-        self.core = self.core.with_optional_base(f, val);
-        self
-    }
-
-    #[allow(unused)]
-    pub fn with_optional_base_env<F, T>(mut self, f: F, val: Option<T>, env_var: &str) -> Self
-    where
-        F: Fn(BaseClientConfig, T) -> BaseClientConfig,
-        T: FromStr,
-        <T as FromStr>::Err: Debug,
-    {
-        self.core = self.core.with_optional_base_env(f, val, env_var);
-        self
-    }
-
-    pub fn with_optional_base_custom_env<F, T, G>(
-        mut self,
-        f: F,
-        val: Option<T>,
-        env_var: &str,
-        parser: G,
-    ) -> Self
-    where
-        F: Fn(BaseClientConfig, T) -> BaseClientConfig,
-        G: Fn(&str) -> T,
-    {
-        self.core = self
-            .core
-            .with_optional_base_custom_env(f, val, env_var, parser);
-        self
-    }
-}

clients/socks5/src/config/old_config_v1_1_13.rs

@@ -1,38 +0,0 @@
-// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use crate::config::old_config_v1_1_19::{ConfigV1_1_19, Socks5V1_1_19};
-use nym_client_core::config::old_config_v1_1_13::OldConfigV1_1_13 as OldBaseConfigV1_1_13;
-use nym_config::legacy_helpers::nym_config::MigrationNymConfig;
-use nym_config::must_get_home;
-use serde::{Deserialize, Serialize};
-use std::path::PathBuf;
-
-#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
-#[serde(deny_unknown_fields)]
-pub struct OldConfigV1_1_13 {
-    #[serde(flatten)]
-    pub base: OldBaseConfigV1_1_13<OldConfigV1_1_13>,
-
-    pub socks5: Socks5V1_1_19,
-}
-
-impl MigrationNymConfig for OldConfigV1_1_13 {
-    fn default_root_directory() -> PathBuf {
-        #[cfg(not(any(target_os = "android", target_os = "ios")))]
-        let base_dir = must_get_home();
-        #[cfg(any(target_os = "android", target_os = "ios"))]
-        let base_dir = PathBuf::from("/tmp");
-
-        base_dir.join(".nym").join("socks5-clients")
-    }
-}
-
-impl From<OldConfigV1_1_13> for ConfigV1_1_19 {
-    fn from(value: OldConfigV1_1_13) -> Self {
-        ConfigV1_1_19 {
-            base: value.base.into(),
-            socks5: value.socks5,
-        }
-    }
-}

clients/socks5/src/config/old_config_v1_1_19.rs

@@ -1,135 +0,0 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use crate::config::persistence::SocksClientPaths;
-use crate::config::{BaseClientConfig, Config, CoreConfig};
-use nym_bin_common::logging::LoggingSettings;
-use nym_client_core::config::disk_persistence::keys_paths::ClientKeysPaths;
-use nym_client_core::config::disk_persistence::CommonClientPaths;
-use nym_client_core::config::old_config_v1_1_19::ConfigV1_1_19 as BaseConfigV1_1_19;
-use nym_client_core::config::Client;
-use nym_config::legacy_helpers::nym_config::MigrationNymConfig;
-use nym_config::must_get_home;
-use nym_socks5_client_core::config::{
-    ProviderInterfaceVersion, Socks5, Socks5Debug, Socks5ProtocolVersion,
-};
-use serde::{Deserialize, Serialize};
-use std::fmt::Debug;
-use std::path::PathBuf;
-
-const DEFAULT_CONNECTION_START_SURBS: u32 = 20;
-const DEFAULT_PER_REQUEST_SURBS: u32 = 3;
-
-#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
-#[serde(deny_unknown_fields)]
-pub struct ConfigV1_1_19 {
-    #[serde(flatten)]
-    pub base: BaseConfigV1_1_19<ConfigV1_1_19>,
-
-    pub socks5: Socks5V1_1_19,
-}
-
-impl From<ConfigV1_1_19> for Config {
-    fn from(value: ConfigV1_1_19) -> Self {
-        Config {
-            core: CoreConfig {
-                base: BaseClientConfig {
-                    client: Client {
-                        version: value.base.client.version,
-                        id: value.base.client.id,
-                        disabled_credentials_mode: value.base.client.disabled_credentials_mode,
-                        nyxd_urls: value.base.client.nyxd_urls,
-                        nym_api_urls: value.base.client.nym_api_urls,
-                        gateway_endpoint: value.base.client.gateway_endpoint.into(),
-                    },
-                    debug: value.base.debug.into(),
-                },
-                socks5: value.socks5.into(),
-            },
-            storage_paths: SocksClientPaths {
-                common_paths: CommonClientPaths {
-                    keys: ClientKeysPaths {
-                        private_identity_key_file: value.base.client.private_identity_key_file,
-                        public_identity_key_file: value.base.client.public_identity_key_file,
-                        private_encryption_key_file: value.base.client.private_encryption_key_file,
-                        public_encryption_key_file: value.base.client.public_encryption_key_file,
-                        gateway_shared_key_file: value.base.client.gateway_shared_key_file,
-                        ack_key_file: value.base.client.ack_key_file,
-                    },
-                    credentials_database: value.base.client.database_path,
-                    reply_surb_database: value.base.client.reply_surb_database_path,
-                },
-            },
-            logging: LoggingSettings::default(),
-        }
-    }
-}
-
-impl MigrationNymConfig for ConfigV1_1_19 {
-    fn default_root_directory() -> PathBuf {
-        #[cfg(not(any(target_os = "android", target_os = "ios")))]
-        let base_dir = must_get_home();
-        #[cfg(any(target_os = "android", target_os = "ios"))]
-        let base_dir = PathBuf::from("/tmp");
-
-        base_dir.join(".nym").join("socks5-clients")
-    }
-}
-
-#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
-#[serde(deny_unknown_fields)]
-pub struct Socks5V1_1_19 {
-    pub listening_port: u16,
-
-    pub provider_mix_address: String,
-
-    #[serde(default = "ProviderInterfaceVersion::new_legacy")]
-    pub provider_interface_version: ProviderInterfaceVersion,
-
-    #[serde(default = "Socks5ProtocolVersion::new_legacy")]
-    pub socks5_protocol_version: Socks5ProtocolVersion,
-
-    #[serde(default)]
-    pub send_anonymously: bool,
-
-    #[serde(default)]
-    pub socks5_debug: Socks5DebugV1_1_19,
-}
-
-impl From<Socks5V1_1_19> for Socks5 {
-    fn from(value: Socks5V1_1_19) -> Self {
-        Socks5 {
-            listening_port: value.listening_port,
-            provider_mix_address: value.provider_mix_address,
-            provider_interface_version: value.provider_interface_version,
-            socks5_protocol_version: value.socks5_protocol_version,
-            send_anonymously: value.send_anonymously,
-            socks5_debug: value.socks5_debug.into(),
-        }
-    }
-}
-
-#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
-#[serde(deny_unknown_fields)]
-pub struct Socks5DebugV1_1_19 {
-    connection_start_surbs: u32,
-    per_request_surbs: u32,
-}
-
-impl From<Socks5DebugV1_1_19> for Socks5Debug {
-    fn from(value: Socks5DebugV1_1_19) -> Self {
-        Socks5Debug {
-            connection_start_surbs: value.connection_start_surbs,
-            per_request_surbs: value.per_request_surbs,
-        }
-    }
-}
-
-impl Default for Socks5DebugV1_1_19 {
-    fn default() -> Self {
-        Socks5DebugV1_1_19 {
-            connection_start_surbs: DEFAULT_CONNECTION_START_SURBS,
-            per_request_surbs: DEFAULT_PER_REQUEST_SURBS,
-        }
-    }
-}

clients/socks5/src/config/persistence.rs

@@ -1,20 +0,0 @@
-// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use nym_client_core::config::disk_persistence::CommonClientPaths;
-use serde::{Deserialize, Serialize};
-use std::path::Path;
-
-#[derive(Debug, Deserialize, PartialEq, Eq, Serialize, Clone)]
-pub struct SocksClientPaths {
-    #[serde(flatten)]
-    pub common_paths: CommonClientPaths,
-}
-
-impl SocksClientPaths {
-    pub fn new_default<P: AsRef<Path>>(base_data_directory: P) -> Self {
-        SocksClientPaths {
-            common_paths: CommonClientPaths::new_default(base_data_directory),
-        }
-    }
-}

clients/socks5/src/error.rs

@@ -1,4 +1,4 @@
-use nym_client_core::error::ClientCoreError;
+use client_core::error::ClientCoreError;
 
 #[derive(thiserror::Error, Debug)]
 pub enum Socks5ClientError {
@@ -8,10 +8,6 @@ pub enum Socks5ClientError {
     #[error("Failed to load config for: {0}")]
     FailedToLoadConfig(String),
 
-    // TODO: add more details here
-    #[error("Failed to validate the loaded config")]
-    ConfigValidationFailure,
-
     #[error("Failed local version check, client and config mismatch")]
     FailedLocalVersionCheck,
 

clients/socks5/src/main.rs

@@ -4,17 +4,16 @@
 use std::error::Error;
 
 use clap::{crate_name, crate_version, Parser};
-use nym_bin_common::logging::{maybe_print_banner, setup_logging};
+use nym_bin_common::logging::{banner, setup_logging};
 use nym_network_defaults::setup_env;
 
 mod commands;
-mod config;
 pub mod error;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
     setup_logging();
-    maybe_print_banner(crate_name!(), crate_version!());
+    println!("{}", banner(crate_name!(), crate_version!()));
 
     let args = commands::Cli::parse();
     setup_env(args.config_env_file.as_ref());

clients/validator/package.json

@@ -48,7 +48,7 @@
     "eslint-plugin-mocha": "^10.0.3",
     "eslint-plugin-prettier": "^4.0.0",
     "mocha": "^10.0.0",
-    "prettier": "^2.8.7",
+    "prettier": "^2.5.1",
     "ts-mocha": "^10.0.0",
     "typedoc": "^0.22.13",
     "typescript": "^4.6.2",

clients/validator/src/index.ts

@@ -34,18 +34,10 @@ import {
   StakeSaturationResponse,
   UnbondedMixnodeResponse,
   VestingAccountInfo,
-  ContractState,
-  VestingAccountsCoinPaged,
-  VestingAccountsPaged,
-  DelegationTimes,
-  Delegations,
-  Period,
-  VestingAccountNode,
-  DelegationBlock,
+  ContractState, VestingAccountsCoinPaged, VestingAccountsPaged, DelegationTimes, Delegations, Period, VestingAccountNode
 } from '@nymproject/types';
 import QueryClient from './query-client';
 import SigningClient, { ISigningClient } from './signing-client';
-// import { DelegationBlock } from './types/shared';
 
 export interface INymClient {
   readonly mixnetContract: string;
@@ -214,7 +206,7 @@ export default class ValidatorClient implements INymClient {
     let mixNodes: UnbondedMixnodeResponse[] = [];
     const limit = 50;
     let startAfter;
-    for (;;) {
+    for (; ;) {
       // eslint-disable-next-line no-await-in-loop
       const pagedResponse: PagedUnbondedMixnodesResponse = await this.client.getUnbondedMixNodes(
         this.mixnetContract,
@@ -237,7 +229,7 @@ export default class ValidatorClient implements INymClient {
     let mixNodes: MixNodeBond[] = [];
     const limit = 50;
     let startAfter;
-    for (;;) {
+    for (; ;) {
       // eslint-disable-next-line no-await-in-loop
       const pagedResponse: PagedMixNodeBondResponse = await this.client.getMixNodeBonds(
         this.mixnetContract,
@@ -259,7 +251,7 @@ export default class ValidatorClient implements INymClient {
     let mixNodes: MixNodeDetails[] = [];
     const limit = 50;
     let startAfter;
-    for (;;) {
+    for (; ;) {
       // eslint-disable-next-line no-await-in-loop
       const pagedResponse: PagedMixNodeDetailsResponse = await this.client.getMixNodesDetailed(
         this.mixnetContract,
@@ -291,7 +283,7 @@ export default class ValidatorClient implements INymClient {
     let delegations: Delegation[] = [];
     const limit = 250;
     let startAfter;
-    for (;;) {
+    for (; ;) {
       // eslint-disable-next-line no-await-in-loop
       const pagedResponse: PagedMixDelegationsResponse = await this.client.getMixNodeDelegationsPaged(
         this.mixnetContract,
@@ -314,7 +306,7 @@ export default class ValidatorClient implements INymClient {
     let delegations: Delegation[] = [];
     const limit = 250;
     let startAfter;
-    for (;;) {
+    for (; ;) {
       // eslint-disable-next-line no-await-in-loop
       const pagedResponse: PagedDelegatorDelegationsResponse = await this.client.getDelegatorDelegationsPaged(
         this.mixnetContract,
@@ -337,7 +329,7 @@ export default class ValidatorClient implements INymClient {
     let delegations: Delegation[] = [];
     const limit = 250;
     let startAfter;
-    for (;;) {
+    for (; ;) {
       // eslint-disable-next-line no-await-in-loop
       const pagedResponse: PagedAllDelegationsResponse = await this.client.getAllDelegationsPaged(
         this.mixnetContract,
@@ -525,9 +517,11 @@ export default class ValidatorClient implements INymClient {
     return (this.client as ISigningClient).updateContractStateParams(this.mixnetContract, newParams, fee, memo);
   }
 
-  // VESTING
+
+  // VESTING 
   // TODO - MOVE TO A DIFFERENT FILE
 
+
   public async getVestingAccountsPaged(): Promise<VestingAccountsPaged> {
     return this.client.getVestingAccountsPaged(this.vestingContract);
   }
@@ -612,21 +606,7 @@ export default class ValidatorClient implements INymClient {
     return this.client.getAllDelegations(this.vestingContract);
   }
 
-  public async getDelegation(address: string, mix_id: number): Promise<DelegationBlock> {
-    return this.client.getDelegation(this.vestingContract, address, mix_id);
-  }
-
-  public async getTotalDelegationAmount(address: string, mix_id: number, block_timestamp_sec: number): Promise<Coin> {
-    return this.client.getTotalDelegationAmount(this.vestingContract, address, mix_id, block_timestamp_sec);
-  }
-
   public async getCurrentVestingPeriod(address: string): Promise<Period> {
     return this.client.getCurrentVestingPeriod(this.vestingContract, address);
   }
-
-  // SIMULATE
-
-  public async simulateSend(signingAddress: string, from: string, to: string, amount: Coin[]) {
-    return (this.client as SigningClient).simulateSend(signingAddress, from, to, amount);
-  }
 }

clients/validator/src/nyxd-querier.ts

@@ -18,7 +18,7 @@ import {
   PagedMixNodeDetailsResponse,
   PagedUnbondedMixnodesResponse,
   LayerDistribution,
-  ContractState, VestingAccountsCoinPaged, VestingAccountsPaged, DelegationTimes, Delegations, Period, VestingAccountNode, DelegationBlock
+  ContractState, VestingAccountsCoinPaged, VestingAccountsPaged, DelegationTimes, Delegations, Period, VestingAccountNode
 } from '@nymproject/types';
 import { SmartContractQuery } from './types/shared';
 import { Coin } from 'cosmjs-types/cosmos/base/v1beta1/coin';
@@ -317,18 +317,6 @@ export default class NyxdQuerier implements INyxdQuery {
     });
   }
 
-  getDelegation(vestingContractAddress: string, address: string, mix_id: number): Promise<DelegationBlock> {
-    return this.client.queryContractSmart(vestingContractAddress, {
-      get_all_delegations: {address: address, mix_id: mix_id}
-    });
-  }
-
-  getTotalDelegationAmount(vestingContractAddress: string, address: string, mix_id: number, block_timestamp_sec: number): Promise<Coin> {
-    return this.client.queryContractSmart(vestingContractAddress, {
-      get_all_delegations: {address: address, mix_id: mix_id, block_timestamp_sec: block_timestamp_sec}
-    });
-  }
-
   getCurrentVestingPeriod(vestingContractAddress: string, address: string): Promise<Period> {
     return this.client.queryContractSmart(vestingContractAddress, {
       get_current_vesting_period: { address: address }

clients/validator/src/query-client.ts

@@ -22,7 +22,7 @@ import {
   MixNodeRewarding,
   OriginalVestingResponse,
   VestingAccountInfo,
-  ContractState, VestingAccountsCoinPaged, VestingAccountsPaged, DelegationTimes, Delegations, Period, VestingAccountNode, DelegationBlock
+  ContractState, VestingAccountsCoinPaged, VestingAccountsPaged, DelegationTimes, Delegations, Period, VestingAccountNode
 } from '@nymproject/types';
 import NymApiQuerier, { INymApiQuery } from './nym-api-querier';
 import { ICosmWasmQuery } from './types/shared';
@@ -288,14 +288,6 @@ export default class QueryClient extends CosmWasmClient implements IQueryClient
     return this.nyxdQuerier.getAllDelegations(vestingContractAddress);
   }
 
-  getDelegation(vestingContractAddress: string, vestingAccountAddress: string, mix_id: number): Promise<DelegationBlock> {
-    return this.nyxdQuerier.getDelegation(vestingContractAddress, vestingAccountAddress, mix_id);
-  }
-
-  getTotalDelegationAmount(vestingContractAddress: string, vestingAccountAddress: string, mix_id: number, block_timestamp_sec: number): Promise<Coin> {
-    return this.nyxdQuerier.getTotalDelegationAmount(vestingContractAddress, vestingAccountAddress, mix_id, block_timestamp_sec);
-  }
-
   getCurrentVestingPeriod(vestingContractAddress: string, address: string): Promise<Period> {
     return this.nyxdQuerier.getCurrentVestingPeriod(vestingContractAddress, address);
   }

clients/validator/src/signing-client.ts

@@ -40,18 +40,9 @@ import {
   RewardingParams,
   UnbondedMixnodeResponse,
   VestingAccountInfo,
-  ContractState,
-  VestingAccountsCoinPaged,
-  VestingAccountsPaged,
-  DelegationTimes,
-  Delegations,
-  Period,
-  VestingAccountNode,
-  DelegationBlock,
+  ContractState, VestingAccountsCoinPaged, VestingAccountsPaged, DelegationTimes, Delegations, Period, VestingAccountNode
 } from '@nymproject/types';
 import NymApiQuerier from './nym-api-querier';
-import { makeBankMsgSend } from './utils';
-import { ISimulateClient } from './types/simulate';
 
 // methods exposed by `SigningCosmWasmClient`
 export interface ICosmWasmSigning {
@@ -157,7 +148,7 @@ export interface INymSigning {
   clientAddress: string;
 }
 
-export interface ISigningClient extends IQueryClient, ICosmWasmSigning, INymSigning, ISimulateClient {
+export interface ISigningClient extends IQueryClient, ICosmWasmSigning, INymSigning {
   bondMixNode(
     mixnetContractAddress: string,
     mixNode: MixNode,
@@ -520,11 +511,11 @@ export default class SigningClient extends SigningCosmWasmClient implements ISig
     );
   }
 
-  // vesting related
+  // vesting related 
 
   getVestingAccountsPaged(vestingContractAddress: string): Promise<VestingAccountsPaged> {
     return this.nyxdQuerier.getVestingAccountsPaged(vestingContractAddress);
-  }
+  };
 
   getVestingAmountsAccountsPaged(vestingContractAddress: string): Promise<VestingAccountsCoinPaged> {
     return this.nyxdQuerier.getVestingAmountsAccountsPaged(vestingContractAddress);
@@ -578,10 +569,7 @@ export default class SigningClient extends SigningCosmWasmClient implements ISig
     return this.nyxdQuerier.getEndTime(vestingContractAddress, vestingAccountAddress);
   }
 
-  getOriginalVestingDetails(
-    vestingContractAddress: string,
-    vestingAccountAddress: string,
-  ): Promise<OriginalVestingResponse> {
+  getOriginalVestingDetails(vestingContractAddress: string, vestingAccountAddress: string): Promise<OriginalVestingResponse> {
     return this.nyxdQuerier.getOriginalVestingDetails(vestingContractAddress, vestingAccountAddress);
   }
 
@@ -601,11 +589,7 @@ export default class SigningClient extends SigningCosmWasmClient implements ISig
     return this.nyxdQuerier.getGateway(vestingContractAddress, address);
   }
 
-  getDelegationTimes(
-    vestingContractAddress: string,
-    mix_id: number,
-    delegatorAddress: string,
-  ): Promise<DelegationTimes> {
+  getDelegationTimes(vestingContractAddress: string, mix_id: number, delegatorAddress: string): Promise<DelegationTimes> {
     return this.nyxdQuerier.getDelegationTimes(vestingContractAddress, mix_id, delegatorAddress);
   }
 
@@ -613,38 +597,7 @@ export default class SigningClient extends SigningCosmWasmClient implements ISig
     return this.nyxdQuerier.getAllDelegations(vestingContractAddress);
   }
 
-  getDelegation(
-    vestingContractAddress: string,
-    vestingAccountAddress: string,
-    mix_id: number,
-  ): Promise<DelegationBlock> {
-    return this.nyxdQuerier.getDelegation(vestingContractAddress, vestingAccountAddress, mix_id);
-  }
-
-  getTotalDelegationAmount(
-    vestingContractAddress: string,
-    vestingAccountAddress: string,
-    mix_id: number,
-    block_timestamp_sec: number,
-  ): Promise<Coin> {
-    return this.nyxdQuerier.getTotalDelegationAmount(
-      vestingContractAddress,
-      vestingAccountAddress,
-      mix_id,
-      block_timestamp_sec,
-    );
-  }
-
   getCurrentVestingPeriod(vestingContractAddress: string, address: string): Promise<Period> {
     return this.nyxdQuerier.getCurrentVestingPeriod(vestingContractAddress, address);
   }
-
-  // simulation
-
-  // TODO consider adding multipling factor
-
-  simulateSend(signingAddress: string, from: string, to: string, amount: Coin[]) {
-    const sendMsg = makeBankMsgSend(from, to, amount);
-    return this.simulate(signingAddress, [sendMsg], 'simulate send tx');
-  }
 }

clients/validator/src/tests/simulate/simulateTx.test.ts

@@ -1,31 +0,0 @@
-import expect from 'expect';
-import ValidatorClient from '../..';
-
-const dotenv = require('dotenv');
-
-dotenv.config();
-
-// TODO: implement for QA with .env for mnemonics
-describe('Simualtions', () => {
-  let client: ValidatorClient;
-
-  beforeEach(async () => {
-    client = await ValidatorClient.connect(
-      process.env.mnemonic || '',
-      process.env.rpcAddress || '',
-      process.env.validatorAddress || '',
-      process.env.prefix || '',
-      process.env.mixnetContractAddress || '',
-      process.env.vestingContractAddress || '',
-      process.env.denom || '',
-    );
-  });
-
-  it('can simulate sending tokens', async () => {
-    const res = await client.simulateSend(client.address, client.address, client.address, [
-      { amount: '400000', denom: 'unym' },
-    ]);
-
-    expect(typeof res).toBe('number');
-  }).timeout(10000);
-});

clients/validator/src/types/simulate.ts

@@ -1,5 +0,0 @@
-import { Coin } from '@cosmjs/proto-signing';
-
-export interface ISimulateClient {
-  simulateSend(signingAddress: string, from: string, to: string, amount: Coin[]): Promise<number>;
-}

clients/webassembly/.cargo/config.toml

@@ -1,2 +0,0 @@
-[build]
-target = "wasm32-unknown-unknown"

clients/webassembly/.gitignore

@@ -1,5 +1,6 @@
 /target
 **/*.rs.bk
+Cargo.lock
 bin/
 pkg/
 wasm-pack.log

clients/webassembly/Cargo.toml

@@ -17,39 +17,28 @@ default = ["console_error_panic_hook"]
 offline-test = []
 
 [dependencies]
-async-trait = "0.1.68"
-bs58 = "0.4.0"
 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.5"
+serde-wasm-bindgen = "0.4"
 tokio = { version = "1.24.1", features = ["sync"] }
 url = "2.2"
 wasm-bindgen = { version = "=0.2.83", features = ["serde-serialize"]  }
 wasm-bindgen-futures = "0.4"
-thiserror = "1.0.40"
-zeroize = "1.6.0"
-
-wasm-timer = { git = "https://github.com/mmsinclair/wasm-timer", rev = "b9d1a54ad514c2f230a026afe0dde341e98cd7b6"}
 
 # internal
-nym-node-tester-utils = { path = "../../common/node-tester-utils" }
-nym-client-core = { path = "../../common/client-core", default-features = false, features = ["wasm"] }
-nym-bandwidth-controller = { path = "../../common/bandwidth-controller" }
+client-core = { path = "../../common/client-core", default-features = false, features = ["wasm"] }
 nym-coconut-interface = { path = "../../common/coconut-interface" }
 nym-credentials = { path = "../../common/credentials" }
-nym-credential-storage = { path = "../../common/credential-storage" }
-nym-crypto = { path = "../../common/crypto", features = ["asymmetric", "serde"] }
+nym-crypto = { path = "../../common/crypto" }
 nym-sphinx = { path = "../../common/nymsphinx" }
-nym-sphinx-acknowledgements = { path = "../../common/nymsphinx/acknowledgements", features = ["serde"]}
-nym-topology = { path = "../../common/topology" }
-nym-gateway-client = { path = "../../common/client-libs/gateway-client", default-features = false, features = ["wasm"] }
-nym-validator-client = { path = "../../common/client-libs/validator-client", default-features = false }
+gateway-client = { path = "../../common/client-libs/gateway-client", default-features = false, features = ["wasm"] }
+validator-client = { path = "../../common/client-libs/validator-client", default-features = false }
+wasm-utils = { path = "../../common/wasm-utils" }
 nym-task = { path = "../../common/task" }
-wasm-utils = { path = "../../common/wasm-utils", features = ["storage"], default-features = false }
 # The `console_error_panic_hook` crate provides better debugging of panics by
 # logging them with `console.error`. This is great for development, but requires
 # all the `std::fmt` and `std::panicking` infrastructure, so isn't great for
@@ -67,7 +56,7 @@ wee_alloc = { version = "0.4", optional = true }
 wasm-bindgen-test = "0.3"
 
 [package.metadata.wasm-pack.profile.release]
-wasm-opt = false
+wasm-opt = true
 
 [profile.release]
 lto = true

clients/webassembly/internal-dev/.gitignore

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

clients/webassembly/internal-dev/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/internal-dev/index.html

@@ -1,43 +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>
-
-<div>
-    <label>Mixnode Identity: </label>
-    <input type="text" size = "60" id="mixnode_identity" value="...">
-    <button id="magic-button">✨ Magic Test Button ✨</button>
-</div>
-
-
-<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"></span>
-</p>
-<script src="./bootstrap.js"></script>
-</body>
-
-</html>

clients/webassembly/internal-dev/index.js

@@ -1,170 +0,0 @@
-// Copyright 2020-2023 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, senderTag, isTestPacket } = ev.data.args;
-                        displayReceived(message, senderTag, isTestPacket);
-                        break;
-                    case 'DisableMagicTestButton':
-                        const magicButton = document.querySelector('#magic-button');
-                        magicButton.setAttribute('disabled', "true")
-                        break;
-                    case 'DisplayTesterResults':
-                        const {score, sentPackets, receivedPackets, receivedAcks, duplicatePackets, duplicateAcks} = ev.data.args;
-                        const resultText = `Test score: ${score}. Sent ${sentPackets} packets. Received ${receivedPackets} packets and ${receivedAcks} acks back. We also got ${duplicatePackets} duplicate packets and ${duplicateAcks} duplicate acks.`
-                        displayReceivedRawString(resultText)
-                        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,
-            },
-        });
-    };
-
-    sendTestPacket = (mixnodeIdentity) => {
-        if (!this.worker) {
-            console.error('Could not send message because worker does not exist');
-            return;
-        }
-
-        this.worker.postMessage({
-            kind: 'TestPacket',
-            args: {
-                mixnodeIdentity,
-            },
-        });
-    }
-}
-
-let client = null;
-
-async function main() {
-    client = new WebWorkerClient();
-
-    const sendButton = document.querySelector('#send-button');
-    sendButton.onclick = function () {
-        sendMessageTo();
-    };
-
-    const magicButton = document.querySelector('#magic-button');
-    magicButton.onclick = function () {
-        sendTestPacket();
-    }
-}
-
-/**
- * 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);
-}
-
-async function sendTestPacket() {
-    const mixnodeIdentity = document.getElementById('mixnode_identity').value;
-
-    await client.sendTestPacket(mixnodeIdentity)
-    displaySend(`sending test packets to: ${mixnodeIdentity}...`);
-}
-
-/**
- * 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, isTestPacket) {
-    let content = new TextDecoder().decode(raw);
-    if (sender_tag !== undefined) {
-        console.log("this message also contained some surbs from", sender_tag)
-    }
-
-    if (isTestPacket) {
-        const decoded = JSON.parse(content)
-        content = `Received packet ${decoded.msg_id} / ${decoded.total_msgs} for node ${decoded.encoded_node_identity} (test: ${decoded.test_id})`
-    }
-
-    displayReceivedRawString(content)
-}
-
-
-function displayReceivedRawString(raw) {
-    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 >>> ' + raw);
-    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;
-}
-
-main();

clients/webassembly/internal-dev/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/internal-dev/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/internal-dev/worker.js

@@ -1,344 +0,0 @@
-// Copyright 2020-2023 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 {
-    NymNodeTester,
-    WasmGateway,
-    WasmMixNode,
-    WasmNymTopology,
-    default_debug,
-    NymClientBuilder,
-    NymClient,
-    set_panic_hook,
-    Config,
-    GatewayEndpointConfig,
-    ClientStorage,
-    current_network_topology,
-    make_key,
-    make_key2
-} = wasm_bindgen;
-
-let client = null;
-let tester = null;
-
-function dummyTopology() {
-    const l1Mixnode = new WasmMixNode(
-        1,
-        'n1fzv4jc7fanl9s0qj02ge2ezk3kts545kjtek47',
-        '178.79.143.65',
-        1789,
-        '4Yr4qmEHd9sgsuQ83191FR2hD88RfsbMmB4tzhhZWriz',
-        '8ndjk5oZ6HxUZNScLJJ7hk39XtUqGexdKgW7hSX6kpWG',
-        1,
-        '1.10.0',
-    );
-    const l2Mixnode = new WasmMixNode(
-        2,
-        'n1z93z44vf8ssvdhujjvxcj4rd5e3lz0l60wdk70',
-        '109.74.197.180',
-        1789,
-        '7sVjiMrPYZrDWRujku9QLxgE8noT7NTgBAqizCsu7AoK',
-        'GepXwRnKZDd8x2nBWAajGGBVvF3mrpVMQBkgfrGuqRCN',
-        2,
-        '1.10.0',
-    );
-    const l3Mixnode = new WasmMixNode(
-        3,
-        'n1ptg680vnmef2cd8l0s9uyc4f0hgf3x8sed6w77',
-        '176.58.101.80',
-        1789,
-        'FoM5Mx9Pxk1g3zEqkS3APgtBeTtTo3M8k7Yu4bV6kK1R',
-        'DeYjrDC2AcQRVFshiKnbUo6bRvPyZ33QGYR2DLeFJ9qD',
-        3,
-        '1.10.0',
-    );
-
-    const gateway = new WasmGateway(
-        'n16evnn8glr0sham3matj8rg2s24m6x56ayk87ts',
-        '85.159.212.96',
-        1789,
-        9000,
-        '336yuXAeGEgedRfqTJZsG2YV7P13QH1bHv1SjCZYarc9',
-        'BtYjoWihiuFihGKQypmpSspbhmWDPxzqeTVSd8ciCpWL',
-        '1.10.1',
-    );
-
-    const mixnodes = new Map();
-    mixnodes.set(1, [l1Mixnode]);
-    mixnodes.set(2, [l2Mixnode]);
-    mixnodes.set(3, [l3Mixnode]);
-
-
-    const gateways = [gateway];
-
-    return new WasmNymTopology(mixnodes, gateways)
-}
-
-function printAndDisplayTestResult(result) {
-    result.log_details();
-
-    self.postMessage({
-        kind: 'DisplayTesterResults',
-        args: {
-            score: result.score(),
-            sentPackets: result.sent_packets,
-            receivedPackets: result.received_packets,
-            receivedAcks: result.received_acks,
-            duplicatePackets: result.duplicate_packets,
-            duplicateAcks: result.duplicate_acks,
-        },
-    });
-}
-
-async function testWithTester() {
-    const preferredGateway = "336yuXAeGEgedRfqTJZsG2YV7P13QH1bHv1SjCZYarc9";
-
-    // A) construct with hardcoded topology
-    const topology = dummyTopology()
-    const nodeTester = await new NymNodeTester(topology, preferredGateway);
-
-    // B) first get topology directly from nym-api
-    // const validator = 'https://qwerty-validator-api.qa.nymte.ch/api';
-    // const topology = await current_network_topology(validator)
-    // const nodeTester = await new NymNodeTester(topology, preferredGateway);
-    //
-    // C) use nym-api in the constructor (note: it does no filtering for 'good' nodes on other layers)
-    // const validator = 'https://qwerty-validator-api.qa.nymte.ch/api';
-    // const nodeTester = await NymNodeTester.new_with_api(validator, preferredGateway)
-
-    // D, E, F) you also don't have to specify the gateway. if you don't, a random one (from your topology) will be used
-    // const topology = dummyTopology()
-    // const nodeTester = await new NymNodeTester(topology);
-
-    self.onmessage = async event => {
-        if (event.data && event.data.kind) {
-            switch (event.data.kind) {
-                case 'TestPacket': {
-                    const {mixnodeIdentity} = event.data.args;
-                    console.log("starting node test...");
-
-                    let result = await nodeTester.test_node(mixnodeIdentity);
-                    printAndDisplayTestResult(result)
-                }
-            }
-        }
-    };
-}
-
-async function testWithNymClient() {
-    const preferredGateway = "336yuXAeGEgedRfqTJZsG2YV7P13QH1bHv1SjCZYarc9";
-    const topology = dummyTopology()
-
-    let received = 0
-
-    const onMessageHandler = (message) => {
-        received += 1;
-        self.postMessage({
-            kind: 'ReceiveMessage',
-            args: {
-                message,
-                senderTag: undefined,
-                isTestPacket: true,
-            },
-        });
-
-        // it's really up to the user to create proper callback here...
-        console.log(`received ${received} packets so far`)
-    };
-
-    console.log('Instantiating WASM client...');
-
-    let clientBuilder = NymClientBuilder.new_tester(topology, onMessageHandler, preferredGateway)
-    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 => {
-        console.log(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);
-                    break;
-                }
-                case 'TestPacket': {
-                    const {mixnodeIdentity} = event.data.args;
-                    const req = await client.try_construct_test_packet_request(mixnodeIdentity);
-                    await client.change_hardcoded_topology(req.injectable_topology());
-                    await client.try_send_test_packets(req);
-                    break;
-                }
-            }
-        }
-    };
-}
-
-async function normalNymClientUsage() {
-    self.postMessage({kind: 'DisableMagicTestButton'});
-
-    // 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 = false;
-    // 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 preferredGateway = "336yuXAeGEgedRfqTJZsG2YV7P13QH1bHv1SjCZYarc9";
-    const validator = 'https://qwerty-validator-api.qa.nymte.ch/api';
-
-    const config = new Config('my-awesome-wasm-client', validator, debug);
-
-    const onMessageHandler = (message) => {
-        console.log(message);
-        self.postMessage({
-            kind: 'ReceiveMessage',
-            args: {
-                message,
-            },
-        });
-    };
-
-    console.log('Instantiating WASM client...');
-
-    let localClient = await new NymClient(config, onMessageHandler)
-    console.log('WASM client running!');
-
-    const selfAddress = localClient.self_address();
-
-    // set the global (I guess we don't have to anymore?)
-    client = localClient;
-
-    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 => {
-        console.log(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);
-                    break;
-                }
-            }
-        }
-    };
-}
-
-async function messWithStorage() {
-    self.onmessage = async event => {
-        if (event.data && event.data.kind) {
-            switch (event.data.kind) {
-                case 'TestPacket': {
-                    const { mixnodeIdentity } = event.data.args;
-                    console.log("button clicked...", mixnodeIdentity);
-
-                    let id1 = "one";
-                    let id2 = "two";
-
-                    console.log("making store1 NO-ENC");
-                    let _storage1 = await ClientStorage.new_unencrypted(id1);
-
-                    console.log("making store2 ENC")
-                    let _storage2 = await new ClientStorage(id2, "my-secret-password");
-                    //
-                    //
-                    //
-                    //     console.log("attempting to use store1 WITH PASSWORD")
-                    //     let _storage1_alt = await new ClientStorage(id1, "password");
-                    //
-                    //
-                    //
-                    //     console.log("attempting to use store2 WITHOUT PASSWORD")
-                    //     let _storage2_alt = await ClientStorage.new_unencrypted(id2);
-                    //
-                    //
-                    //
-                    //     console.log("attempting to use store2 with WRONG PASSWORD")
-                    //     let _storage2_bad = await new ClientStorage(id2, "bad-password")
-
-
-                    //
-                    // console.log("read1: ", await storage1.read());
-                    // console.log("read2: ", await storage2.read());
-                    //
-                    // console.log("store1: ", await storage1.store("FOOMP"));
-                    //
-                    // console.log("read1: ", await storage1.read());
-                    // console.log("read2: ", await storage2.read());
-                }
-            }
-        }
-    };
-
-
-
-
-}
-
-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();
-
-    // run test on simplified and dedicated tester:
-    // await testWithTester()
-
-    // hook-up the whole client for testing
-    // await testWithNymClient()
-
-    // 'Normal' client setup (to send 'normal' messages)
-    await normalNymClientUsage()
-}
-
-// Let's get started!
-main();

clients/webassembly/src/client/config.rs

@@ -1,4 +1,4 @@
-// Copyright 2022-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
 // due to expansion of #[wasm_bindgen] macro on `Debug` Config struct
@@ -6,50 +6,58 @@
 // another issue due to #[wasm_bindgen] and `Copy` trait
 #![allow(clippy::drop_copy)]
 
-use nym_client_core::config::{
-    Acknowledgements as ConfigAcknowledgements, Config as BaseClientConfig,
-    CoverTraffic as ConfigCoverTraffic, DebugConfig as ConfigDebug,
-    GatewayConnection as ConfigGatewayConnection, ReplySurbs as ConfigReplySurbs,
-    Topology as ConfigTopology, Traffic as ConfigTraffic,
+use client_core::config::{
+    Acknowledgements as ConfigAcknowledgements, CoverTraffic as ConfigCoverTraffic,
+    DebugConfig as ConfigDebug, ExtendedPacketSize, GatewayConnection as ConfigGatewayConnection,
+    GatewayEndpointConfig, ReplySurbs as ConfigReplySurbs, Topology as ConfigTopology,
+    Traffic as ConfigTraffic,
 };
-use nym_sphinx::params::{PacketSize, PacketType};
 use serde::{Deserialize, Serialize};
 use std::time::Duration;
+use url::Url;
 use wasm_bindgen::prelude::*;
 
 #[wasm_bindgen]
 #[derive(Debug, Deserialize, PartialEq, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct Config {
-    pub(crate) base: BaseClientConfig,
+    /// ID specifies the human readable ID of this particular client.
+    pub(crate) id: String,
+
+    pub(crate) nym_api_url: Url,
+
+    pub(crate) disabled_credentials_mode: bool,
+
+    /// Information regarding how the client should send data to gateway.
+    pub(crate) gateway_endpoint: GatewayEndpointConfig,
+
+    pub(crate) debug: ConfigDebug,
 }
 
 #[wasm_bindgen]
 impl Config {
     #[wasm_bindgen(constructor)]
-    pub fn new(id: String, validator_server: String, debug: Option<DebugWasm>) -> Self {
+    pub fn new(
+        id: String,
+        validator_server: String,
+        gateway_endpoint: GatewayEndpointConfig,
+        debug: Option<Debug>,
+    ) -> Self {
         Config {
-            base: BaseClientConfig::new(id)
-                .with_custom_nyxd(vec![validator_server
-                    .parse()
-                    .expect("provided url was malformed")])
-                .with_debug_config(debug.map(Into::into).unwrap_or_default()),
-        }
-    }
-
-    pub(crate) fn new_tester_config<S: Into<String>>(id: S) -> Self {
-        Config {
-            base: BaseClientConfig::new(id)
-                .with_disabled_credentials(true)
-                .with_disabled_cover_traffic(true)
-                .with_disabled_topology_refresh(true),
+            id,
+            nym_api_url: validator_server
+                .parse()
+                .expect("provided url was malformed"),
+            disabled_credentials_mode: true,
+            gateway_endpoint,
+            debug: debug.map(Into::into).unwrap_or_default(),
         }
     }
 }
 
 #[wasm_bindgen]
 #[derive(Debug, Copy, Clone)]
-pub struct TrafficWasm {
+pub struct Traffic {
     /// The parameter of Poisson distribution determining how long, on average,
     /// sent packet is going to be delayed at any given mix node.
     /// So for a packet going through three mix nodes, on average, it will take three times this value
@@ -68,22 +76,13 @@ pub struct TrafficWasm {
 
     /// Controls whether the sent sphinx packet use the NON-DEFAULT bigger size.
     pub use_extended_packet_size: bool,
-
-    /// Controls whether the sent packets should use outfox as opposed to the default sphinx.
-    pub use_outfox: bool,
 }
 
-impl From<TrafficWasm> for ConfigTraffic {
-    fn from(traffic: TrafficWasm) -> Self {
+impl From<Traffic> for ConfigTraffic {
+    fn from(traffic: Traffic) -> Self {
         let use_extended_packet_size = traffic
             .use_extended_packet_size
-            .then(|| PacketSize::ExtendedPacket32);
-
-        let packet_type = if traffic.use_outfox {
-            PacketType::Outfox
-        } else {
-            PacketType::Mix
-        };
+            .then(|| ExtendedPacketSize::Extended32);
 
         ConfigTraffic {
             average_packet_delay: Duration::from_millis(traffic.average_packet_delay_ms),
@@ -92,62 +91,53 @@ impl From<TrafficWasm> for ConfigTraffic {
             ),
             disable_main_poisson_packet_distribution: traffic
                 .disable_main_poisson_packet_distribution,
-            primary_packet_size: PacketSize::RegularPacket,
-            secondary_packet_size: use_extended_packet_size,
-            packet_type,
+            use_extended_packet_size,
         }
     }
 }
 
-impl From<ConfigTraffic> for TrafficWasm {
+impl From<ConfigTraffic> for Traffic {
     fn from(traffic: ConfigTraffic) -> Self {
-        TrafficWasm {
+        Traffic {
             average_packet_delay_ms: traffic.average_packet_delay.as_millis() as u64,
             message_sending_average_delay_ms: traffic.message_sending_average_delay.as_millis()
                 as u64,
             disable_main_poisson_packet_distribution: traffic
                 .disable_main_poisson_packet_distribution,
-            use_extended_packet_size: traffic.secondary_packet_size.is_some(),
-            use_outfox: traffic.packet_type == PacketType::Outfox,
+            use_extended_packet_size: traffic.use_extended_packet_size.is_some(),
         }
     }
 }
 
 #[wasm_bindgen]
 #[derive(Debug, Copy, Clone)]
-pub struct CoverTrafficWasm {
+pub struct CoverTraffic {
     /// The parameter of Poisson distribution determining how long, on average,
     /// it is going to take for another loop cover traffic message to be sent.
     pub loop_cover_traffic_average_delay_ms: u64,
 
-    /// Specifies the ratio of `primary_packet_size` to `secondary_packet_size` used in cover traffic.
-    /// Only applicable if `secondary_packet_size` is enabled.
-    pub cover_traffic_primary_size_ratio: f64,
-
     /// Controls whether the dedicated loop cover traffic stream should be enabled.
     /// (and sending packets, on average, every [Self::loop_cover_traffic_average_delay])
     pub disable_loop_cover_traffic_stream: bool,
 }
 
-impl From<CoverTrafficWasm> for ConfigCoverTraffic {
-    fn from(cover_traffic: CoverTrafficWasm) -> Self {
+impl From<CoverTraffic> for ConfigCoverTraffic {
+    fn from(cover_traffic: CoverTraffic) -> Self {
         ConfigCoverTraffic {
             loop_cover_traffic_average_delay: Duration::from_millis(
                 cover_traffic.loop_cover_traffic_average_delay_ms,
             ),
-            cover_traffic_primary_size_ratio: cover_traffic.cover_traffic_primary_size_ratio,
             disable_loop_cover_traffic_stream: cover_traffic.disable_loop_cover_traffic_stream,
         }
     }
 }
 
-impl From<ConfigCoverTraffic> for CoverTrafficWasm {
+impl From<ConfigCoverTraffic> for CoverTraffic {
     fn from(cover_traffic: ConfigCoverTraffic) -> Self {
-        CoverTrafficWasm {
+        CoverTraffic {
             loop_cover_traffic_average_delay_ms: cover_traffic
                 .loop_cover_traffic_average_delay
                 .as_millis() as u64,
-            cover_traffic_primary_size_ratio: cover_traffic.cover_traffic_primary_size_ratio,
             disable_loop_cover_traffic_stream: cover_traffic.disable_loop_cover_traffic_stream,
         }
     }
@@ -155,14 +145,14 @@ impl From<ConfigCoverTraffic> for CoverTrafficWasm {
 
 #[wasm_bindgen]
 #[derive(Debug, Copy, Clone)]
-pub struct GatewayConnectionWasm {
+pub struct GatewayConnection {
     /// How long we're willing to wait for a response to a message sent to the gateway,
     /// before giving up on it.
     pub gateway_response_timeout_ms: u64,
 }
 
-impl From<GatewayConnectionWasm> for ConfigGatewayConnection {
-    fn from(gateway_connection: GatewayConnectionWasm) -> Self {
+impl From<GatewayConnection> for ConfigGatewayConnection {
+    fn from(gateway_connection: GatewayConnection) -> Self {
         ConfigGatewayConnection {
             gateway_response_timeout: Duration::from_millis(
                 gateway_connection.gateway_response_timeout_ms,
@@ -171,9 +161,9 @@ impl From<GatewayConnectionWasm> for ConfigGatewayConnection {
     }
 }
 
-impl From<ConfigGatewayConnection> for GatewayConnectionWasm {
+impl From<ConfigGatewayConnection> for GatewayConnection {
     fn from(gateway_connection: ConfigGatewayConnection) -> Self {
-        GatewayConnectionWasm {
+        GatewayConnection {
             gateway_response_timeout_ms: gateway_connection.gateway_response_timeout.as_millis()
                 as u64,
         }
@@ -182,7 +172,7 @@ impl From<ConfigGatewayConnection> for GatewayConnectionWasm {
 
 #[wasm_bindgen]
 #[derive(Debug, Copy, Clone)]
-pub struct AcknowledgementsWasm {
+pub struct Acknowledgements {
     /// The parameter of Poisson distribution determining how long, on average,
     /// sent acknowledgement is going to be delayed at any given mix node.
     /// So for an ack going through three mix nodes, on average, it will take three times this value
@@ -200,8 +190,8 @@ pub struct AcknowledgementsWasm {
     pub ack_wait_addition_ms: u64,
 }
 
-impl From<AcknowledgementsWasm> for ConfigAcknowledgements {
-    fn from(acknowledgements: AcknowledgementsWasm) -> Self {
+impl From<Acknowledgements> for ConfigAcknowledgements {
+    fn from(acknowledgements: Acknowledgements) -> Self {
         ConfigAcknowledgements {
             average_ack_delay: Duration::from_millis(acknowledgements.average_ack_delay_ms),
             ack_wait_multiplier: acknowledgements.ack_wait_multiplier,
@@ -210,9 +200,9 @@ impl From<AcknowledgementsWasm> for ConfigAcknowledgements {
     }
 }
 
-impl From<ConfigAcknowledgements> for AcknowledgementsWasm {
+impl From<ConfigAcknowledgements> for Acknowledgements {
     fn from(acknowledgements: ConfigAcknowledgements) -> Self {
-        AcknowledgementsWasm {
+        Acknowledgements {
             average_ack_delay_ms: acknowledgements.average_ack_delay.as_millis() as u64,
             ack_wait_multiplier: acknowledgements.ack_wait_multiplier,
             ack_wait_addition_ms: acknowledgements.ack_wait_addition.as_millis() as u64,
@@ -222,7 +212,7 @@ impl From<ConfigAcknowledgements> for AcknowledgementsWasm {
 
 #[wasm_bindgen]
 #[derive(Debug, Copy, Clone)]
-pub struct TopologyWasm {
+pub struct Topology {
     /// The uniform delay every which clients are querying the directory server
     /// to try to obtain a compatible network topology to send sphinx packets through.
     pub topology_refresh_rate_ms: u64,
@@ -231,38 +221,31 @@ pub struct TopologyWasm {
     /// path. This timeout determines waiting period until it is decided that the packet
     /// did not reach its destination.
     pub topology_resolution_timeout_ms: u64,
-
-    /// Specifies whether the client should not refresh the network topology after obtaining
-    /// the first valid instance.
-    /// Supersedes `topology_refresh_rate_ms`.
-    pub disable_refreshing: bool,
 }
 
-impl From<TopologyWasm> for ConfigTopology {
-    fn from(topology: TopologyWasm) -> Self {
+impl From<Topology> for ConfigTopology {
+    fn from(topology: Topology) -> Self {
         ConfigTopology {
             topology_refresh_rate: Duration::from_millis(topology.topology_refresh_rate_ms),
             topology_resolution_timeout: Duration::from_millis(
                 topology.topology_resolution_timeout_ms,
             ),
-            disable_refreshing: topology.disable_refreshing,
         }
     }
 }
 
-impl From<ConfigTopology> for TopologyWasm {
+impl From<ConfigTopology> for Topology {
     fn from(topology: ConfigTopology) -> Self {
-        TopologyWasm {
+        Topology {
             topology_refresh_rate_ms: topology.topology_refresh_rate.as_millis() as u64,
             topology_resolution_timeout_ms: topology.topology_resolution_timeout.as_millis() as u64,
-            disable_refreshing: topology.disable_refreshing,
         }
     }
 }
 
 #[wasm_bindgen]
 #[derive(Debug, Copy, Clone)]
-pub struct ReplySurbsWasm {
+pub struct ReplySurbs {
     /// Defines the minimum number of reply surbs the client wants to keep in its storage at all times.
     /// It can only allow to go below that value if its to request additional reply surbs.
     pub minimum_reply_surb_storage_threshold: usize,
@@ -296,8 +279,8 @@ pub struct ReplySurbsWasm {
     pub maximum_reply_key_age_ms: u64,
 }
 
-impl From<ReplySurbsWasm> for ConfigReplySurbs {
-    fn from(reply_surbs: ReplySurbsWasm) -> Self {
+impl From<ReplySurbs> for ConfigReplySurbs {
+    fn from(reply_surbs: ReplySurbs) -> Self {
         ConfigReplySurbs {
             minimum_reply_surb_storage_threshold: reply_surbs.minimum_reply_surb_storage_threshold,
             maximum_reply_surb_storage_threshold: reply_surbs.maximum_reply_surb_storage_threshold,
@@ -317,9 +300,9 @@ impl From<ReplySurbsWasm> for ConfigReplySurbs {
     }
 }
 
-impl From<ConfigReplySurbs> for ReplySurbsWasm {
+impl From<ConfigReplySurbs> for ReplySurbs {
     fn from(reply_surbs: ConfigReplySurbs) -> Self {
-        ReplySurbsWasm {
+        ReplySurbs {
             minimum_reply_surb_storage_threshold: reply_surbs.minimum_reply_surb_storage_threshold,
             maximum_reply_surb_storage_threshold: reply_surbs.maximum_reply_surb_storage_threshold,
             minimum_reply_surb_request_size: reply_surbs.minimum_reply_surb_request_size,
@@ -341,28 +324,28 @@ impl From<ConfigReplySurbs> for ReplySurbsWasm {
 // just a helper structure to more easily pass through the JS boundary
 #[wasm_bindgen]
 #[derive(Debug, Copy, Clone)]
-pub struct DebugWasm {
+pub struct Debug {
     /// Defines all configuration options related to traffic streams.
-    pub traffic: TrafficWasm,
+    pub traffic: Traffic,
 
     /// Defines all configuration options related to cover traffic stream(s).
-    pub cover_traffic: CoverTrafficWasm,
+    pub cover_traffic: CoverTraffic,
 
     /// Defines all configuration options related to the gateway connection.
-    pub gateway_connection: GatewayConnectionWasm,
+    pub gateway_connection: GatewayConnection,
 
     /// Defines all configuration options related to acknowledgements, such as delays or wait timeouts.
-    pub acknowledgements: AcknowledgementsWasm,
+    pub acknowledgements: Acknowledgements,
 
     /// Defines all configuration options related topology, such as refresh rates or timeouts.
-    pub topology: TopologyWasm,
+    pub topology: Topology,
 
     /// Defines all configuration options related to reply SURBs.
-    pub reply_surbs: ReplySurbsWasm,
+    pub reply_surbs: ReplySurbs,
 }
 
-impl From<DebugWasm> for ConfigDebug {
-    fn from(debug: DebugWasm) -> Self {
+impl From<Debug> for ConfigDebug {
+    fn from(debug: Debug) -> Self {
         ConfigDebug {
             traffic: debug.traffic.into(),
             cover_traffic: debug.cover_traffic.into(),
@@ -374,9 +357,9 @@ impl From<DebugWasm> for ConfigDebug {
     }
 }
 
-impl From<ConfigDebug> for DebugWasm {
+impl From<ConfigDebug> for Debug {
     fn from(debug: ConfigDebug) -> Self {
-        DebugWasm {
+        Debug {
             traffic: debug.traffic.into(),
             cover_traffic: debug.cover_traffic.into(),
             gateway_connection: debug.gateway_connection.into(),
@@ -388,6 +371,6 @@ impl From<ConfigDebug> for DebugWasm {
 }
 
 #[wasm_bindgen]
-pub fn default_debug() -> DebugWasm {
+pub fn default_debug() -> Debug {
     ConfigDebug::default().into()
 }

clients/webassembly/src/client/helpers.rs

@@ -1,42 +1,16 @@
-// Copyright 2022-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::error::WasmClientError;
-use crate::tester::helpers::WasmTestMessageExt;
-use crate::tester::{NodeTestMessage, DEFAULT_TEST_PACKETS};
-use crate::topology::WasmNymTopology;
+use client_core::client::base_client::ClientInput;
+use client_core::client::inbound_messages::InputMessage;
 use js_sys::Promise;
-use nym_client_core::client::base_client::{ClientInput, ClientState};
-use nym_client_core::client::inbound_messages::InputMessage;
-use nym_topology::{MixLayer, NymTopology};
 use std::sync::Arc;
-use wasm_bindgen::prelude::*;
 use wasm_bindgen::JsValue;
 use wasm_bindgen_futures::future_to_promise;
-use wasm_utils::{console_log, simple_js_error};
-
-#[wasm_bindgen]
-pub struct NymClientTestRequest {
-    // serialized NodeTestMessage
-    pub(crate) test_msgs: Vec<Vec<u8>>,
-
-    // specially constructed network topology that only contains the target
-    // node on the tested layer
-    pub(crate) testable_topology: NymTopology,
-}
-
-#[wasm_bindgen]
-impl NymClientTestRequest {
-    pub fn injectable_topology(&self) -> WasmNymTopology {
-        self.testable_topology.clone().into()
-    }
-}
 
 // defining helper trait as we could directly call the method on the wrapper
 pub(crate) trait InputSender {
     fn send_message(&self, message: InputMessage) -> Promise;
-
-    fn send_messages(&self, messages: Vec<InputMessage>) -> Promise;
 }
 
 impl InputSender for Arc<ClientInput> {
@@ -45,114 +19,12 @@ impl InputSender for Arc<ClientInput> {
         future_to_promise(async move {
             match this.input_sender.send(message).await {
                 Ok(_) => Ok(JsValue::null()),
-                Err(_) => Err(simple_js_error(
-                    "InputMessageReceiver has stopped receiving!",
-                )),
-            }
-        })
-    }
-
-    fn send_messages(&self, messages: Vec<InputMessage>) -> Promise {
-        let this = Arc::clone(self);
-        future_to_promise(async move {
-            for message in messages {
-                if this.input_sender.send(message).await.is_err() {
-                    return Err(simple_js_error(
-                        "InputMessageReceiver has stopped receiving!",
-                    ));
+                Err(_) => {
+                    let js_error =
+                        js_sys::Error::new("InputMessageReceiver has stopped receiving!");
+                    Err(JsValue::from(js_error))
                 }
             }
-            Ok(JsValue::null())
-        })
-    }
-}
-
-pub(crate) trait WasmTopologyExt {
-    /// Changes the current network topology to the provided value.
-    fn change_hardcoded_topology(&self, topology: WasmNymTopology) -> Promise;
-
-    /// Returns the current network topology.
-    fn current_topology(&self) -> Promise;
-
-    /// Checks whether the provided node exists in the known network topology and if so, returns its layer.
-    fn check_for_mixnode_existence(&self, mixnode_identity: String) -> Promise;
-
-    /// Creates a `NymClientTestRequest` with a variant of `this` topology where the target node is the only one on its layer.
-    fn mix_test_request(
-        &self,
-        test_id: u32,
-        mixnode_identity: String,
-        num_test_packets: Option<u32>,
-    ) -> Promise;
-}
-
-impl WasmTopologyExt for Arc<ClientState> {
-    fn change_hardcoded_topology(&self, topology: WasmNymTopology) -> Promise {
-        let this = Arc::clone(self);
-        future_to_promise(async move {
-            let nym_topology: NymTopology = topology.into();
-            console_log!("changing topology to {nym_topology:?}");
-            this.topology_accessor
-                .manually_change_topology(nym_topology)
-                .await;
-            Ok(JsValue::null())
-        })
-    }
-
-    fn current_topology(&self) -> Promise {
-        let this = Arc::clone(self);
-        future_to_promise(async move {
-            match this.topology_accessor.current_topology().await {
-                Some(topology) => Ok(JsValue::from(WasmNymTopology::from(topology))),
-                None => Err(WasmClientError::UnavailableNetworkTopology.into()),
-            }
-        })
-    }
-
-    /// Checks whether the target mixnode exists in the known network topology and returns its layer.
-    fn check_for_mixnode_existence(&self, mixnode_identity: String) -> Promise {
-        let this = Arc::clone(self);
-        future_to_promise(async move {
-            let Some(current_topology) = this.topology_accessor.current_topology().await else {
-                return Err(WasmClientError::UnavailableNetworkTopology.into())
-            };
-
-            match current_topology.find_mix_by_identity(&mixnode_identity) {
-                None => Err(WasmClientError::NonExistentMixnode { mixnode_identity }.into()),
-                Some(node) => Ok(JsValue::from(MixLayer::from(node.layer))),
-            }
-        })
-    }
-
-    fn mix_test_request(
-        &self,
-        test_id: u32,
-        mixnode_identity: String,
-        num_test_packets: Option<u32>,
-    ) -> Promise {
-        let num_test_packets = num_test_packets.unwrap_or(DEFAULT_TEST_PACKETS);
-
-        let this = Arc::clone(self);
-        future_to_promise(async move {
-            let Some(current_topology) = this.topology_accessor.current_topology().await else {
-                return Err(WasmClientError::UnavailableNetworkTopology.into())
-            };
-
-            let Some(mix) = current_topology.find_mix_by_identity(&mixnode_identity) else {
-                return Err(WasmClientError::NonExistentMixnode { mixnode_identity }.into());
-            };
-
-            let ext = WasmTestMessageExt::new(test_id);
-            let test_msgs = NodeTestMessage::mix_plaintexts(mix, num_test_packets, ext)
-                .map_err(WasmClientError::from)?;
-
-            let mut updated = current_topology.clone();
-            updated.set_mixes_in_layer(mix.layer.into(), vec![mix.to_owned()]);
-
-            Ok(JsValue::from(NymClientTestRequest {
-                test_msgs,
-                testable_topology: updated,
-            }))
         })
     }
 }

clients/webassembly/src/client/mod.rs

@@ -1,39 +1,26 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021-2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
 use self::config::Config;
-use crate::client::helpers::{InputSender, NymClientTestRequest, WasmTopologyExt};
+use crate::client::helpers::InputSender;
 use crate::client::response_pusher::ResponsePusher;
-use crate::constants::NODE_TESTER_CLIENT_ID;
-use crate::error::WasmClientError;
-use crate::helpers::{
-    choose_gateway, gateway_from_topology, parse_recipient, parse_sender_tag,
-    setup_reply_surb_storage_backend,
+use client_core::client::base_client::{
+    BaseClientBuilder, ClientInput, ClientOutput, CredentialsToggle,
 };
-use crate::storage::traits::FullWasmClientStorage;
-use crate::storage::ClientStorage;
-use crate::topology::WasmNymTopology;
+use client_core::client::replies::reply_storage::browser_backend;
+use client_core::client::{inbound_messages::InputMessage, key_manager::KeyManager};
+use gateway_client::bandwidth::BandwidthController;
+use gateway_client::wasm_mockups::{Client as FakeClient, DirectSigningNyxdClient};
 use js_sys::Promise;
-use nym_bandwidth_controller::wasm_mockups::{Client as FakeClient, DirectSigningNyxdClient};
-use nym_bandwidth_controller::BandwidthController;
-use nym_client_core::client::base_client::{
-    BaseClientBuilder, ClientInput, ClientOutput, ClientState, CredentialsToggle,
-};
-use nym_client_core::client::inbound_messages::InputMessage;
-use nym_client_core::client::replies::reply_storage::browser_backend;
-use nym_credential_storage::ephemeral_storage::EphemeralStorage;
-use nym_sphinx::params::PacketType;
+use nym_sphinx::addressing::clients::Recipient;
+use nym_sphinx::anonymous_replies::requests::AnonymousSenderTag;
 use nym_task::connections::TransmissionLane;
 use nym_task::TaskManager;
-use nym_topology::provider_trait::{HardcodedTopologyProvider, TopologyProvider};
-use nym_topology::NymTopology;
-use nym_validator_client::client::IdentityKey;
 use rand::rngs::OsRng;
-use rand::{thread_rng, RngCore};
 use std::sync::Arc;
 use wasm_bindgen::prelude::*;
 use wasm_bindgen_futures::future_to_promise;
-use wasm_utils::{check_promise_result, console_log, PromisableResult};
+use wasm_utils::{console_error, console_log};
 
 pub mod config;
 mod helpers;
@@ -43,247 +30,146 @@ mod response_pusher;
 pub struct NymClient {
     self_address: String,
     client_input: Arc<ClientInput>,
-    client_state: Arc<ClientState>,
-
-    // keep track of the "old" topology for the purposes of node tester
-    // so that it could be restored after the check is done
-    _full_topology: Option<NymTopology>,
 
     // even though we don't use graceful shutdowns, other components rely on existence of this struct
     // and if it's dropped, everything will start going offline
     _task_manager: TaskManager,
-
-    packet_type: PacketType,
 }
 
 #[wasm_bindgen]
 pub struct NymClientBuilder {
     config: Config,
-    custom_topology: Option<NymTopology>,
-    preferred_gateway: Option<IdentityKey>,
 
-    storage_passphrase: Option<String>,
+    /// KeyManager object containing smart pointers to all relevant keys used by the client.
+    key_manager: KeyManager,
+
     reply_surb_storage_backend: browser_backend::Backend,
 
     on_message: js_sys::Function,
 
     // unimplemented:
-    bandwidth_controller:
-        Option<BandwidthController<FakeClient<DirectSigningNyxdClient>, EphemeralStorage>>,
+    bandwidth_controller: Option<BandwidthController<FakeClient<DirectSigningNyxdClient>>>,
     disabled_credentials: bool,
 }
 
 #[wasm_bindgen]
 impl NymClientBuilder {
     #[wasm_bindgen(constructor)]
-    pub fn new(
-        config: Config,
-        on_message: js_sys::Function,
-        preferred_gateway: Option<IdentityKey>,
-        storage_passphrase: Option<String>,
-    ) -> Self {
+    pub fn new(config: Config, on_message: js_sys::Function) -> Self {
+        //, key_manager: Option<KeyManager>) {
         NymClientBuilder {
-            reply_surb_storage_backend: setup_reply_surb_storage_backend(
-                config.base.debug.reply_surbs,
-            ),
+            reply_surb_storage_backend: Self::setup_reply_surb_storage_backend(&config),
             config,
-            custom_topology: None,
-            storage_passphrase,
+            key_manager: Self::setup_key_manager(),
             on_message,
             bandwidth_controller: None,
             disabled_credentials: true,
-            preferred_gateway,
         }
     }
 
-    // no cover traffic
-    // no poisson delay
-    // hardcoded topology
-    // NOTE: you most likely want to use `[NymNodeTester]` instead.
-    pub fn new_tester(
-        topology: WasmNymTopology,
-        on_message: js_sys::Function,
-        gateway: Option<IdentityKey>,
-    ) -> Self {
-        if let Some(gateway_id) = &gateway {
-            if !topology.ensure_contains_gateway_id(gateway_id) {
-                panic!("the specified topology does not contain the gateway used by the client")
-            }
-        }
+    // TODO: once we make keys persistent, we'll require some kind of `init` method to generate
+    // a prior shared keypair between the client and the gateway
 
-        let full_config = Config::new_tester_config(NODE_TESTER_CLIENT_ID);
+    // perhaps this should be public?
+    fn setup_key_manager() -> KeyManager {
+        let mut rng = OsRng;
+        // for time being generate new keys each time...
+        console_log!("generated new set of keys");
+        KeyManager::new(&mut rng)
+    }
 
-        NymClientBuilder {
-            reply_surb_storage_backend: setup_reply_surb_storage_backend(
-                full_config.base.debug.reply_surbs,
-            ),
-            config: full_config,
-            custom_topology: Some(topology.into()),
-            on_message,
-            bandwidth_controller: None,
-            disabled_credentials: true,
-            storage_passphrase: None,
-            preferred_gateway: gateway,
-        }
+    // don't get too excited about the name, under the hood it's just a big fat placeholder
+    // with no persistence
+    fn setup_reply_surb_storage_backend(config: &Config) -> browser_backend::Backend {
+        browser_backend::Backend::new(
+            config
+                .debug
+                .reply_surbs
+                .minimum_reply_surb_storage_threshold,
+            config
+                .debug
+                .reply_surbs
+                .maximum_reply_surb_storage_threshold,
+        )
     }
 
     fn start_reconstructed_pusher(client_output: ClientOutput, on_message: js_sys::Function) {
         ResponsePusher::new(client_output, on_message).start()
     }
 
-    fn topology_provider(&mut self) -> Option<Box<dyn TopologyProvider + Send + Sync>> {
-        if let Some(hardcoded_topology) = self.custom_topology.take() {
-            Some(Box::new(HardcodedTopologyProvider::new(hardcoded_topology)))
-        } else {
-            None
-        }
-    }
+    pub async fn start_client(self) -> Promise {
+        future_to_promise(async move {
+            console_log!("Starting the wasm client");
 
-    async fn start_client_async(mut self) -> Result<NymClient, WasmClientError> {
-        console_log!("Starting the wasm client");
+            let disabled_credentials = if self.disabled_credentials {
+                CredentialsToggle::Disabled
+            } else {
+                CredentialsToggle::Enabled
+            };
 
-        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,
+                disabled_credentials,
+                vec![self.config.nym_api_url.clone()],
+            );
 
-        let nym_api_endpoints = self.config.base.client.nym_api_urls.clone();
+            let self_address = base_builder.as_mix_recipient().to_string();
+            let mut started_client = match base_builder.start_base().await {
+                Ok(base_client) => base_client,
+                Err(err) => {
+                    let error_msg = format!("failed to start the base client components - {err}");
+                    console_error!("{}", error_msg);
+                    let js_error = js_sys::Error::new(&error_msg);
+                    return Err(JsValue::from(js_error));
+                }
+            };
 
-        // TODO: this will have to be re-used for surbs. but this is a problem for another PR.
-        let client_store =
-            ClientStorage::new_async(&self.config.base.client.id, self.storage_passphrase.take())
-                .await?;
+            let client_input = started_client.client_input.register_producer();
+            let client_output = started_client.client_output.register_consumer();
 
-        // if we provided hardcoded topology, get gateway from it, otherwise get it the 'standard' way
-        let gateway_endpoint = if let Some(topology) = &self.custom_topology {
-            gateway_from_topology(
-                &mut thread_rng(),
-                self.preferred_gateway.as_deref(),
-                topology,
-                &client_store,
-            )
-            .await?
-        } else {
-            choose_gateway(
-                &client_store,
-                self.preferred_gateway.clone(),
-                &nym_api_endpoints,
-            )
-            .await?
-        };
+            Self::start_reconstructed_pusher(client_output, self.on_message);
 
-        let maybe_topology_provider = self.topology_provider();
-
-        let mut base_builder: BaseClientBuilder<_, FullWasmClientStorage> = BaseClientBuilder::new(
-            &gateway_endpoint,
-            &self.config.base.debug,
-            client_store,
-            self.bandwidth_controller,
-            self.reply_surb_storage_backend,
-            disabled_credentials,
-            nym_api_endpoints,
-        );
-        if let Some(topology_provider) = maybe_topology_provider {
-            base_builder = base_builder.with_topology_provider(topology_provider);
-        }
-
-        let mut started_client = base_builder.start_base().await?;
-        let self_address = started_client.address.to_string();
-
-        let client_input = started_client.client_input.register_producer();
-        let client_output = started_client.client_output.register_consumer();
-
-        Self::start_reconstructed_pusher(client_output, self.on_message);
-
-        Ok(NymClient {
-            self_address,
-            client_input: Arc::new(client_input),
-            client_state: Arc::new(started_client.client_state),
-            _full_topology: None,
-            _task_manager: started_client.task_manager,
-            packet_type: self.config.base.debug.traffic.packet_type,
+            Ok(JsValue::from(NymClient {
+                self_address,
+                client_input: Arc::new(client_input),
+                _task_manager: started_client.task_manager,
+            }))
         })
     }
-
-    pub fn start_client(self) -> Promise {
-        future_to_promise(async move { self.start_client_async().await.into_promise_result() })
-    }
 }
 
 #[wasm_bindgen]
 impl NymClient {
-    async fn _new(
-        config: Config,
-        on_message: js_sys::Function,
-        preferred_gateway: Option<IdentityKey>,
-        storage_passphrase: Option<String>,
-    ) -> Result<NymClient, WasmClientError> {
-        NymClientBuilder::new(config, on_message, preferred_gateway, storage_passphrase)
-            .start_client_async()
-            .await
-    }
-
-    #[wasm_bindgen(constructor)]
-    #[allow(clippy::new_ret_no_self)]
-    pub fn new(
-        config: Config,
-        on_message: js_sys::Function,
-        preferred_gateway: Option<IdentityKey>,
-        storage_passphrase: Option<String>,
-    ) -> Promise {
-        future_to_promise(async move {
-            Self::_new(config, on_message, preferred_gateway, storage_passphrase)
-                .await
-                .into_promise_result()
-        })
-    }
-
     pub fn self_address(&self) -> String {
         self.self_address.clone()
     }
 
-    pub fn try_construct_test_packet_request(
-        &self,
-        mixnode_identity: String,
-        num_test_packets: Option<u32>,
-    ) -> Promise {
-        // TODO: improve the source of rng (i.e. don't make it ephemeral...)
-        let mut ephemeral_rng = OsRng;
-        let test_id = ephemeral_rng.next_u32();
-        self.client_state
-            .mix_test_request(test_id, mixnode_identity, num_test_packets)
+    fn parse_recipient(recipient: &str) -> Result<Recipient, JsValue> {
+        match Recipient::try_from_base58_string(recipient) {
+            Ok(recipient) => Ok(recipient),
+            Err(err) => {
+                let error_msg = format!("{recipient} is not a valid Nym network recipient - {err}");
+                console_error!("{}", error_msg);
+                let js_error = js_sys::Error::new(&error_msg);
+                Err(JsValue::from(js_error))
+            }
+        }
     }
 
-    pub fn change_hardcoded_topology(&self, topology: WasmNymTopology) -> Promise {
-        self.client_state.change_hardcoded_topology(topology)
-    }
-
-    pub fn current_network_topology(&self) -> Promise {
-        self.client_state.current_topology()
-    }
-
-    /// Sends a test packet through the current network topology.
-    /// It's the responsibility of the caller to ensure the correct topology has been injected and
-    /// correct onmessage handlers have been setup.
-    pub fn try_send_test_packets(&mut self, request: NymClientTestRequest) -> Promise {
-        // TOOD: use the premade packets instead
-        console_log!(
-            "Attempting to send {} test packets",
-            request.test_msgs.len()
-        );
-
-        // our address MUST BE valid
-        let recipient = parse_recipient(&self.self_address()).unwrap();
-
-        let lane = TransmissionLane::General;
-        let input_msgs = request
-            .test_msgs
-            .into_iter()
-            .map(|p| InputMessage::new_regular(recipient, p, lane, None))
-            .collect();
-
-        self.client_input.send_messages(input_msgs)
+    fn parse_sender_tag(tag: &str) -> Result<AnonymousSenderTag, JsValue> {
+        match AnonymousSenderTag::try_from_base58_string(tag) {
+            Ok(tag) => Ok(tag),
+            Err(err) => {
+                let error_msg = format!("{tag} is not a valid Nym AnonymousSenderTag - {err}");
+                console_error!("{}", error_msg);
+                let js_error = js_sys::Error::new(&error_msg);
+                Err(JsValue::from(js_error))
+            }
+        }
     }
 
     /// The simplest message variant where no additional information is attached.
@@ -296,11 +182,13 @@ impl NymClient {
             message.len() as f64 / 1024.0
         );
 
-        let recipient = check_promise_result!(parse_recipient(&recipient));
-
+        let recipient = match Self::parse_recipient(&recipient) {
+            Ok(recipient) => recipient,
+            Err(err) => return Promise::reject(&err),
+        };
         let lane = TransmissionLane::General;
 
-        let input_msg = InputMessage::new_regular(recipient, message, lane, Some(self.packet_type));
+        let input_msg = InputMessage::new_regular(recipient, message, lane);
         self.client_input.send_message(input_msg)
     }
 
@@ -323,17 +211,13 @@ impl NymClient {
             message.len() as f64 / 1024.0
         );
 
-        let recipient = check_promise_result!(parse_recipient(&recipient));
-
+        let recipient = match Self::parse_recipient(&recipient) {
+            Ok(recipient) => recipient,
+            Err(err) => return Promise::reject(&err),
+        };
         let lane = TransmissionLane::General;
 
-        let input_msg = InputMessage::new_anonymous(
-            recipient,
-            message,
-            reply_surbs,
-            lane,
-            Some(self.packet_type),
-        );
+        let input_msg = InputMessage::new_anonymous(recipient, message, reply_surbs, lane);
         self.client_input.send_message(input_msg)
     }
 
@@ -347,11 +231,13 @@ impl NymClient {
             message.len() as f64 / 1024.0
         );
 
-        let sender_tag = check_promise_result!(parse_sender_tag(&recipient_tag));
-
+        let sender_tag = match Self::parse_sender_tag(&recipient_tag) {
+            Ok(recipient) => recipient,
+            Err(err) => return Promise::reject(&err),
+        };
         let lane = TransmissionLane::General;
 
-        let input_msg = InputMessage::new_reply(sender_tag, message, lane, Some(self.packet_type));
+        let input_msg = InputMessage::new_reply(sender_tag, message, lane);
         self.client_input.send_message(input_msg)
     }
 }

clients/webassembly/src/client/response_pusher.rs

@@ -1,13 +1,11 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
+use client_core::client::base_client::ClientOutput;
+use client_core::client::received_buffer::{ReceivedBufferMessage, ReconstructedMessagesReceiver};
 use futures::channel::mpsc;
 use futures::StreamExt;
 use js_sys::Uint8Array;
-use nym_client_core::client::base_client::ClientOutput;
-use nym_client_core::client::received_buffer::{
-    ReceivedBufferMessage, ReconstructedMessagesReceiver,
-};
 use wasm_bindgen::JsValue;
 use wasm_bindgen_futures::spawn_local;
 use wasm_utils::console_error;

clients/webassembly/src/constants.rs

@@ -1,5 +0,0 @@
-// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-pub(crate) const NODE_TESTER_ID: &str = "_nym-node-tester";
-pub(crate) const NODE_TESTER_CLIENT_ID: &str = "_nym-node-tester-client";

clients/webassembly/src/error.rs

@@ -1,122 +0,0 @@
-// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use crate::storage::errors::ClientStorageError;
-use crate::topology::WasmTopologyError;
-use js_sys::Promise;
-use nym_client_core::config::GatewayEndpointConfig;
-use nym_client_core::error::ClientCoreError;
-use nym_crypto::asymmetric::identity::Ed25519RecoveryError;
-use nym_gateway_client::error::GatewayClientError;
-use nym_node_tester_utils::error::NetworkTestingError;
-use nym_sphinx::addressing::clients::RecipientFormattingError;
-use nym_sphinx::anonymous_replies::requests::InvalidAnonymousSenderTagRepresentation;
-use nym_topology::NymTopologyError;
-use nym_validator_client::ValidatorClientError;
-use thiserror::Error;
-use wasm_bindgen::JsValue;
-use wasm_utils::simple_js_error;
-
-// might as well start using well-defined error enum...
-#[derive(Debug, Error)]
-pub enum WasmClientError {
-    #[error(
-        "A node test is already in progress. Wait for it to finish before starting another one."
-    )]
-    TestInProgress,
-
-    #[error("experienced an issue with internal client components: {source}")]
-    BaseClientError {
-        #[from]
-        source: ClientCoreError,
-    },
-
-    #[error("The provided gateway identity is invalid: {source}")]
-    InvalidGatewayIdentity { source: Ed25519RecoveryError },
-
-    #[error("Gateway communication failure: {source}")]
-    GatewayClientError {
-        #[from]
-        source: GatewayClientError,
-    },
-
-    #[error("failed to query nym api: {source}")]
-    NymApiError {
-        #[from]
-        source: ValidatorClientError,
-    },
-
-    #[error("The provided wasm topology was invalid: {source}")]
-    WasmTopologyError {
-        #[from]
-        source: WasmTopologyError,
-    },
-
-    #[error("The provided nym topology was invalid: {source}")]
-    TopologyError {
-        #[from]
-        source: NymTopologyError,
-    },
-
-    #[error("failed to test the node: {source}")]
-    NodeTestingFailure {
-        #[from]
-        source: NetworkTestingError,
-    },
-
-    #[error("{raw} is not a valid url: {source}")]
-    MalformedUrl {
-        raw: String,
-        source: url::ParseError,
-    },
-
-    #[error("Network topology is currently unavailable")]
-    UnavailableNetworkTopology,
-
-    #[error("Mixnode {mixnode_identity} is not present in the current network topology")]
-    NonExistentMixnode { mixnode_identity: String },
-
-    #[error("Gateway {gateway_identity} is not present in the current network topology")]
-    NonExistentGateway { gateway_identity: String },
-
-    #[error("{raw} is not a valid Nym network recipient: {source}")]
-    MalformedRecipient {
-        raw: String,
-        source: RecipientFormattingError,
-    },
-
-    #[error("{raw} is not a valid Nym AnonymousSenderTag: {source}")]
-    MalformedSenderTag {
-        raw: String,
-        source: InvalidAnonymousSenderTagRepresentation,
-    },
-
-    #[error(transparent)]
-    StorageError {
-        #[from]
-        source: ClientStorageError,
-    },
-
-    #[error("this client has already registered with a gateway: {gateway_config:?}")]
-    AlreadyRegistered {
-        gateway_config: GatewayEndpointConfig,
-    },
-}
-
-impl WasmClientError {
-    pub fn into_rejected_promise(self) -> Promise {
-        self.into()
-    }
-}
-
-impl From<WasmClientError> for JsValue {
-    fn from(value: WasmClientError) -> Self {
-        simple_js_error(value.to_string())
-    }
-}
-
-impl From<WasmClientError> for Promise {
-    fn from(value: WasmClientError) -> Self {
-        Promise::reject(&value.into())
-    }
-}

clients/webassembly/src/gateway_selector.rs

@@ -1,13 +1,12 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use nym_client_core::config::GatewayEndpointConfig;
+use client_core::config::GatewayEndpointConfig;
 use wasm_bindgen::prelude::*;
 
 #[wasm_bindgen]
 pub async fn get_gateway(api_server: String, preferred: Option<String>) -> GatewayEndpointConfig {
-    let validator_client =
-        nym_validator_client::client::NymApiClient::new(api_server.parse().unwrap());
+    let validator_client = validator_client::client::NymApiClient::new(api_server.parse().unwrap());
 
     let gateways = match validator_client.get_cached_gateways().await {
         Err(err) => panic!("failed to obtain list of all gateways - {err}"),

clients/webassembly/src/helpers.rs

@@ -1,165 +0,0 @@
-// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use crate::error::WasmClientError;
-use crate::storage::ClientStorage;
-use crate::topology::WasmNymTopology;
-use js_sys::Promise;
-use nym_client_core::client::replies::reply_storage::browser_backend;
-use nym_client_core::config;
-use nym_client_core::config::GatewayEndpointConfig;
-use nym_client_core::init::GatewaySetup;
-use nym_crypto::asymmetric::identity;
-use nym_sphinx::addressing::clients::Recipient;
-use nym_sphinx::anonymous_replies::requests::AnonymousSenderTag;
-use nym_topology::NymTopology;
-use nym_validator_client::client::{IdentityKey, IdentityKeyRef};
-use nym_validator_client::NymApiClient;
-use rand::{CryptoRng, Rng};
-use url::Url;
-use wasm_bindgen::prelude::wasm_bindgen;
-use wasm_bindgen_futures::future_to_promise;
-use wasm_utils::{console_log, PromisableResult};
-
-// don't get too excited about the name, under the hood it's just a big fat placeholder
-// with no disk_persistence
-pub(crate) fn setup_reply_surb_storage_backend(
-    config: config::ReplySurbs,
-) -> browser_backend::Backend {
-    browser_backend::Backend::new(
-        config.minimum_reply_surb_storage_threshold,
-        config.maximum_reply_surb_storage_threshold,
-    )
-}
-
-pub(crate) fn parse_recipient(recipient: &str) -> Result<Recipient, WasmClientError> {
-    Recipient::try_from_base58_string(recipient).map_err(|source| {
-        WasmClientError::MalformedRecipient {
-            raw: recipient.to_string(),
-            source,
-        }
-    })
-}
-
-pub(crate) fn parse_sender_tag(tag: &str) -> Result<AnonymousSenderTag, WasmClientError> {
-    AnonymousSenderTag::try_from_base58_string(tag).map_err(|source| {
-        WasmClientError::MalformedSenderTag {
-            raw: tag.to_string(),
-            source,
-        }
-    })
-}
-
-pub(crate) async fn current_network_topology_async(
-    nym_api_url: String,
-) -> Result<WasmNymTopology, WasmClientError> {
-    let url: Url = match nym_api_url.parse() {
-        Ok(url) => url,
-        Err(source) => {
-            return Err(WasmClientError::MalformedUrl {
-                raw: nym_api_url,
-                source,
-            })
-        }
-    };
-
-    let api_client = NymApiClient::new(url);
-    let mixnodes = api_client.get_cached_active_mixnodes().await?;
-    let gateways = api_client.get_cached_gateways().await?;
-
-    Ok(NymTopology::from_detailed(mixnodes, gateways).into())
-}
-
-#[wasm_bindgen]
-pub fn current_network_topology(nym_api_url: String) -> Promise {
-    future_to_promise(async move {
-        current_network_topology_async(nym_api_url)
-            .await
-            .into_promise_result()
-    })
-}
-
-pub(crate) async fn choose_gateway(
-    client_store: &ClientStorage,
-    chosen_gateway: Option<IdentityKey>,
-    nym_apis: &[Url],
-) -> Result<GatewayEndpointConfig, WasmClientError> {
-    let existing_gateway_config = client_store.read_gateway_config().await?;
-
-    console_log!("loaded: {:?}", existing_gateway_config);
-
-    if let Some(existing) = existing_gateway_config {
-        if let Some(provided) = &chosen_gateway {
-            if provided != &existing.gateway_id {
-                return Err(WasmClientError::AlreadyRegistered {
-                    gateway_config: existing,
-                });
-            }
-        }
-        return Ok(existing);
-    };
-
-    // if NOTHING is specified nor available, choose gateway randomly.
-    let setup = GatewaySetup::new(None, chosen_gateway, None);
-    let config = setup.try_get_gateway_details(nym_apis).await?;
-
-    // perform registration + persist the new gateway info
-    // TODO: this is actually quite bad. we shouldn't be persisting gateway info here since we did not have persisted
-    // the shared key yet. this will only happen when we start the base client itself.
-    // but unfortunately, we can't do much more until we do a bit more refactoring.
-    client_store.store_gateway_config(&config).await?;
-
-    console_log!("stored: {:?}", config);
-
-    Ok(config)
-}
-
-pub(crate) async fn gateway_from_topology<R: Rng + CryptoRng>(
-    rng: &mut R,
-    explicit_gateway: Option<IdentityKeyRef<'_>>,
-    topology: &NymTopology,
-    client_store: &ClientStorage,
-) -> Result<GatewayEndpointConfig, WasmClientError> {
-    let existing_gateway_config = client_store.read_gateway_config().await?;
-    console_log!("loaded: {:?}", existing_gateway_config);
-
-    let new_gateway: GatewayEndpointConfig = if let Some(provided) = explicit_gateway {
-        if let Some(existing) = existing_gateway_config {
-            // we have stored gateway info and explicitly provided identity key
-            //
-            // check if they match, otherwise return an error
-            return if provided != existing.gateway_id {
-                Err(WasmClientError::AlreadyRegistered {
-                    gateway_config: existing,
-                })
-            } else {
-                Ok(existing)
-            };
-        } else {
-            // we have explicitly provided identity key and didn't have any prior stored data
-            //
-            // try to grab details from the topology
-            let gateway_identity = identity::PublicKey::from_base58_string(provided)
-                .map_err(|source| WasmClientError::InvalidGatewayIdentity { source })?;
-            if let Some(gateway) = topology.get_gateway(&gateway_identity) {
-                gateway.clone().into()
-            } else {
-                return Err(WasmClientError::NonExistentGateway {
-                    gateway_identity: gateway_identity.to_base58_string(),
-                });
-            }
-        }
-    } else if let Some(existing) = existing_gateway_config {
-        // we have stored data and didn't provide anything separately - use what's stored!
-        return Ok(existing);
-    } else {
-        // we don't have anything stored nor we have provided anything
-        //
-        // just grab random gateway from our topology
-        topology.random_gateway(rng)?.clone().into()
-    };
-
-    console_log!("storing: {:?}", new_gateway);
-    client_store.store_gateway_config(&new_gateway).await?;
-    Ok(new_gateway)
-}

clients/webassembly/src/lib.rs

@@ -1,4 +1,4 @@
-// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
 use wasm_bindgen::prelude::*;
@@ -8,23 +8,10 @@ mod client;
 #[cfg(target_arch = "wasm32")]
 pub mod encoded_payload_helper;
 #[cfg(target_arch = "wasm32")]
-pub mod error;
-#[cfg(target_arch = "wasm32")]
 pub mod gateway_selector;
 #[cfg(target_arch = "wasm32")]
-pub mod storage;
-#[cfg(target_arch = "wasm32")]
-pub mod tester;
-#[cfg(target_arch = "wasm32")]
-pub mod topology;
-#[cfg(target_arch = "wasm32")]
 pub mod validation;
 
-#[cfg(target_arch = "wasm32")]
-mod helpers;
-
-mod constants;
-
 #[wasm_bindgen]
 pub fn set_panic_hook() {
     // When the `console_error_panic_hook` feature is enabled, we can call the