Add extended packet sizes

Increase sampling time
Change benchmark name
2023-02-15 09:17:30 +00:00 · 2023-02-14 21:15:33 +00:00 · 2023-02-14 21:13:13 +00:00 · 2023-02-14 17:44:19 +00:00 · 2023-02-13 15:22:39 +01:00 · 2023-02-13 15:00:24 +01:00
1130 changed files with 46953 additions and 29544 deletions
@@ -14,7 +14,7 @@ GEOIPUPDATE_LICENSE_KEY=xxx
 # List of space-separated database edition IDs. Edition IDs may
 # consist of letters, digits, and dashes. For example, GeoIP2-City
 # would download the GeoIP2 City database (GeoIP2-City).
-GEOIPUPDATE_EDITION_IDS=GeoLite2-Country
+GEOIPUPDATE_EDITION_IDS=GeoLite2-City
 # The number of hours between geoipupdate runs. If this is not set
 # or is set to 0, geoipupdate will run once and exit.
 GEOIPUPDATE_FREQUENCY=72
@@ -26,7 +26,7 @@ jobs:
          path: .github/workflows/support-files/notifications/deny.message
  notification:
    needs: cargo-deny
-    runs-on: ubuntu-20.04
+    runs-on: custom-runner-linux
    steps:
      - name: Check out repository code
        uses: actions/checkout@v2
@@ -35,6 +35,10 @@ jobs:
        with:
          name: report
          path: .github/workflows/support-files/notifications
+      - name: install npm
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
      - name: Keybase - Node Install
        run: npm install
        working-directory: .github/workflows/support-files
@@ -47,6 +51,11 @@ jobs:
          KEYBASE_NYMBOT_PAPERKEY: "${{ secrets.KEYBASE_NYMBOT_PAPERKEY }}"
          KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
          KEYBASE_NYM_CHANNEL: "security"
+          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
        uses: docker://keybaseio/client:stable-node
        with:
          args: .github/workflows/support-files/notifications/entry_point.sh
@@ -0,0 +1,112 @@
+name: Build and upload binaries to CI
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'clients/**'
+      - 'common/**'
+      - 'contracts/**'
+      - 'explorer-api/**'
+      - 'gateway/**'
+      - 'integrations/**'
+      - 'mixnode/**'
+      - 'sdk/rust/nym-sdk/**'
+      - 'service-providers/**'
+      - 'nym-api/**'
+      - 'nym-outfox/**'
+      - 'tools/nym-cli/**'
+      - 'tools/ts-rs-cli/**'
+  pull_request:
+    paths:
+      - 'clients/**'
+      - 'common/**'
+      - 'contracts/**'
+      - 'explorer-api/**'
+      - 'gateway/**'
+      - 'integrations/**'
+      - 'mixnode/**'
+      - 'sdk/rust/nym-sdk/**'
+      - 'service-providers/**'
+      - 'nym-api/**'
+      - 'nym-outfox/**'
+      - 'tools/nym-cli/**'
+      - 'tools/ts-rs-cli/**'
+
+env:
+  NETWORK: mainnet
+
+jobs:
+  publish-nym:
+    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/${{ github.ref_name }}
+        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 libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools
+        continue-on-error: true
+
+      - 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
+
+      - name: Install Rust stable
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          target: wasm32-unknown-unknown
+          override: true
+          components: rustfmt, clippy
+
+      - name: Build release contracts
+        run: make wasm
+
+      - name: Prepare build output
+        shell: bash
+        env:
+          OUTPUT_DIR: ci-builds/${{ github.ref_name }}
+        run: |
+          cp target/release/nym-client $OUTPUT_DIR
+          cp target/release/nym-gateway $OUTPUT_DIR
+          cp target/release/nym-mixnode $OUTPUT_DIR
+          cp target/release/nym-socks5-client $OUTPUT_DIR
+          cp target/release/nym-api $OUTPUT_DIR
+          cp target/release/nym-network-requester $OUTPUT_DIR
+          cp target/release/nym-network-statistics $OUTPUT_DIR
+          cp target/release/nym-cli $OUTPUT_DIR
+
+          cp contracts/target/wasm32-unknown-unknown/release/mixnet_contract.wasm $OUTPUT_DIR
+          cp contracts/target/wasm32-unknown-unknown/release/vesting_contract.wasm $OUTPUT_DIR
+
+      - 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: "-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/"
@@ -0,0 +1,59 @@
+name: Build and upload binaries to artifact storage
+
+on:
+  workflow_dispatch:
+    inputs:  
+      add_tokio_unstable:
+        description: 'True to add RUSTFLAGS="--cfg tokio_unstable"'
+        required: true
+        default: false
+        type: boolean 
+    
+env:
+  NETWORK: mainnet    
+
+jobs:
+  publish-nym:
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-20.04]
+
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Dependencies (Linux)
+        run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools
+        continue-on-error: true
+
+      - name: Sets env vars for tokio if set in manual dispatch inputs
+        run: |
+          echo 'RUSTFLAGS="--cfg tokio_unstable"' >> $GITHUB_ENV
+        if: github.event_name == 'workflow_dispatch' && inputs.add_tokio_unstable == true
+
+      - 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
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: nym-binaries-artifacts
+          path: |
+            target/release/nym-client
+            target/release/nym-gateway
+            target/release/nym-mixnode
+            target/release/nym-socks5-client
+            target/release/nym-api
+            target/release/nym-network-requester
+            target/release/nym-network-statistics
+            target/release/nym-cli
+          retention-days: 30
@@ -12,6 +12,7 @@ jobs:
    - uses: actions/checkout@v2
    - name: Install rsync
      run: sudo apt-get install rsync
+      continue-on-error: true
    - uses: rlespinasse/github-slug-action@v3.x
    - uses: actions/setup-node@v3
      with:
@@ -58,6 +59,11 @@ jobs:
        KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
        KEYBASE_NYM_CHANNEL: "ci-ts-packages"
        IS_SUCCESS: "${{ job.status == 'success' }}"
+        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
      uses: docker://keybaseio/client:stable-node
      with:
        args: .github/workflows/support-files/notifications/entry_point.sh
@@ -2,21 +2,44 @@ name: Continuous integration

 on:
  push:
-    paths-ignore:
-      - 'explorer/**'
+    paths:
+      - 'clients/**'
+      - 'common/**'
+      - 'explorer-api/**'
+      - 'gateway/**'
+      - 'integrations/**'
+      - 'mixnode/**'
+      - 'sdk/rust/nym-sdk/**'
+      - 'service-providers/**'
+      - 'nym-api/**'
+      - 'nym-outfox/**'
+      - 'tools/nym-cli/**'
+      - 'tools/ts-rs-cli/**'
  pull_request:
-    paths-ignore:
-      - 'explorer/**'
+    paths:
+      - 'clients/**'
+      - 'common/**'
+      - 'explorer-api/**'
+      - 'gateway/**'
+      - 'integrations/**'
+      - 'mixnode/**'
+      - 'sdk/rust/nym-sdk/**'
+      - 'service-providers/**'
+      - 'nym-api/**'
+      - 'nym-outfox/**'
+      - 'tools/nym-cli/**'
+      - 'tools/ts-rs-cli/**'

 jobs:
  build:
    runs-on: [ self-hosted, custom-linux ]
-    # Enable sccache via environment variable
+    # Enable sccache via environment variable
    env:
      RUSTC_WRAPPER: /home/ubuntu/.cargo/bin/sccache
    steps:
      - name: Install Dependencies (Linux)
        run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools
+        continue-on-error: true

      - name: Check out repository code
        uses: actions/checkout@v2
@@ -41,47 +64,34 @@ jobs:
          command: build
          args: --workspace

+      - name: Build all examples
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --workspace --examples
+
      - name: Run all tests
        uses: actions-rs/cargo@v1
        with:
          command: test
-          args: --workspace --all-features
+          args: --workspace

      - name: Run expensive tests
        if: github.ref == 'refs/heads/develop' || github.event.pull_request.base.ref == 'develop' || github.event.pull_request.base.ref == 'master'
        uses: actions-rs/cargo@v1
        with:
          command: test
-          args: --workspace --all-features -- --ignored
+          args: --workspace -- --ignored

      - uses: actions-rs/clippy-check@v1
        name: Clippy checks
+        continue-on-error: true
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --workspace --all-features
+          args: --workspace

      - name: Run clippy
        uses: actions-rs/cargo@v1
        with:
          command: clippy
-          args: --workspace -- -D warnings
-
-      # COCONUT stuff
-
-      - name: Build all binaries with coconut enabled
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --workspace --features=coconut
-
-      - name: Run all tests with coconut enabled
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --workspace --features=coconut
-
-      - name: Run clippy with coconut enabled
-        uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: --all-targets --features=coconut -- -D warnings
+          args: --workspace --all-targets -- -D warnings
@@ -0,0 +1,70 @@
+name: Nym Connect for Android (rust)
+
+on:
+  push:
+    paths:
+      - "nym-connect-android/src-tauri/**"
+      - "clients/client-core/**"
+      - "clients/socks5/**"
+      - "common/**"
+      - "gateway/gateway-requests/**"
+      - "contracts/vesting/**"
+      - "nym-api/nym-api-requests/**"
+  pull_request:
+    paths:
+      - "nym-connect-android/src-tauri/**"
+      - "clients/client-core/**"
+      - "clients/socks5/**"
+      - "common/**"
+      - "gateway/gateway-requests/**"
+      - "contracts/vesting/**"
+      - "nym-api/nym-api-requests/**"
+
+jobs:
+  build:
+    #runs-on: [self-hosted, custom-linux]
+    runs-on: ubuntu-22.04
+    #env:
+      #RUSTC_WRAPPER: /home/ubuntu/.cargo/bin/sccache
+    #defaults:
+      #run:
+        #working-directory: nym-connect-android/src-tauri/
+    steps:
+      - name: Install Dependencies (Linux)
+        if: ${{ !env.ACT }}
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install \
+          libwebkit2gtk-4.1-dev \
+          build-essential \
+          curl \
+          wget \
+          libssl-dev \
+          libgtk-3-dev \
+          squashfs-tools \
+          libayatana-appindicator3-dev \
+          librsvg2-dev \
+          libsoup-3.0-dev \
+          libjavascriptcoregtk-4.1-dev
+        #continue-on-error: true
+
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          components: clippy, rustfmt
+
+      - name: Check formatting
+        run: cargo fmt --manifest-path nym-connect-android/src-tauri/Cargo.toml -- --check
+
+      - name: Build all binaries
+        run: cargo build --manifest-path nym-connect-android/src-tauri/Cargo.toml
+
+      - name: Run all tests
+        run: cargo test  --manifest-path nym-connect-android/src-tauri/Cargo.toml
+
+      - name: Clippy
+        run: cargo clippy --manifest-path nym-connect-android/src-tauri/Cargo.toml --all-targets -- -D warnings
@@ -2,8 +2,23 @@ name: Nym Connect (rust)

 on:
  push:
-    paths-ignore:
-      - 'explorer/**'
+    paths:
+      - 'nym-connect/**'
+      - 'clients/client-core/**'
+      - 'clients/socks5/**'
+      - 'common/**'
+      - 'gateway/gateway-requests/**'
+      - 'contracts/vesting/**'
+      - 'nym-api/nym-api-requests/**'
+  pull_request:
+    paths:
+      - 'nym-connect/**'
+      - 'clients/client-core/**'
+      - 'clients/socks5/**'
+      - 'common/**'
+      - 'gateway/gateway-requests/**'
+      - 'contracts/vesting/**'
+      - 'nym-api/nym-api-requests/**'

 jobs:
  build:
@@ -13,6 +28,7 @@ jobs:
    steps:
      - name: Install Dependencies (Linux)
        run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools libayatana-appindicator3-dev
+        continue-on-error: true

      - name: Check out repository code
        uses: actions/checkout@v2
@@ -45,6 +61,7 @@ jobs:

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

 jobs:
  build:
-    runs-on: ubuntu-20.04
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-contracts-') && github.event_name == 'release' }}
+    runs-on: [self-hosted, custom-runner-linux]
    steps:
      - uses: actions/checkout@v2
      
-      - name: Check the release tag starts with `nym-contracts-`
-        if: startsWith(github.ref, 'refs/tags/nym-contracts-') == false && github.event_name != 'workflow_dispatch'
-        uses: actions/github-script@v3
-        with:
-          script: |
-            core.setFailed('Release tag did not start with nym-contracts-...')      
-
      - name: Install Rust stable
        uses: actions-rs/toolchain@v1
        with:
@@ -2,11 +2,13 @@ name: Contracts

 on:
  push:
-    paths-ignore:
-      - 'explorer/**'
+    paths:
+      - 'contracts/**'
+      - 'common/**'
  pull_request:
    paths-ignore:
-      - 'explorer/**'
+      - 'contracts/**'
+      - 'common/**'

 jobs:
  matrix_prep:
@@ -0,0 +1,134 @@
+name: NC Android APK Release
+
+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 \
+          libwebkit2gtk-4.0-dev \
+          build-essential \
+          unzip \
+          curl \
+          wget \
+          libssl-dev \
+          libgtk-3-dev \
+          squashfs-tools \
+          libayatana-appindicator3-dev \
+          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
+
+      - 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-android webpack:prod
+
+      - name: Build APK
+        working-directory: nym-connect-android
+        env:
+          ANDROID_SDK_ROOT: ${{ env.ANDROID_HOME }}
+          WRY_ANDROID_PACKAGE: net.nymtech.nym_connect_android
+          WRY_ANDROID_LIBRARY: nym_connect_android
+        # TODO build with release profile (--release), it will requires
+        # to sign the APK. For now build with debug profile to avoid that
+        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-android/src-tauri/gen/android/nym_connect_android/app/build/outputs/apk/arm64/debug/app-arm64-debug.apk \
+            apk/nym-connect-arm64-debug.apk
+          mv nym-connect-android/src-tauri/gen/android/nym_connect_android/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: ???
@@ -10,6 +10,7 @@ env:

 jobs:
  publish-nym:
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-explorer-api-') && (github.event_name == 'release' || github.event_name == 'workflow_dispatch') }}
    strategy:
      fail-fast: false
      matrix:
@@ -21,9 +22,9 @@ jobs:

      - name: Install Dependencies (Linux)
        run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools
+        continue-on-error: true

      - name: Check the release tag starts with `nym-explorer-api-`
-        if: startsWith(github.ref, 'refs/tags/nym-explorer-api-') == false && github.event_name != 'workflow_dispatch'
        uses: actions/github-script@v3
        with:
          script: |
@@ -17,6 +17,7 @@ jobs:
    - uses: actions/checkout@v2
    - name: Install rsync
      run: sudo apt-get install rsync
+      continue-on-error: true
    - uses: rlespinasse/github-slug-action@v3.x
    - uses: actions/setup-node@v3
      with:
@@ -73,6 +74,11 @@ jobs:
        KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
        KEYBASE_NYM_CHANNEL: "ci-network-explorer"
        IS_SUCCESS: "${{ job.status == 'success' }}"
+        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
      uses: docker://keybaseio/client:stable-node
      with:
        args: .github/workflows/support-files/notifications/entry_point.sh
@@ -10,7 +10,7 @@ jobs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
      # creates the matrix strategy from nightly_build_matrix_includes.json
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
      - id: set-matrix
        uses: JoshuaTheMiller/conditional-build-matrix@main
        with:
@@ -25,10 +25,11 @@ jobs:
    steps:
      - name: Install Dependencies (Linux)
        run: sudo apt-get update && sudo apt-get install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools
+        continue-on-error: true
        if: matrix.os == 'ubuntu-20.04'

      - name: Check out repository code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3

      - name: Install rust toolchain
        uses: actions-rs/toolchain@v1
@@ -38,6 +39,12 @@ jobs:
          override: true
          components: rustfmt, clippy

+      - name: Check formatting
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
      - name: Build all binaries
        uses: actions-rs/cargo@v1
        with:
@@ -50,6 +57,18 @@ jobs:
        with:
          command: clean

+      - name: Build all examples
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --workspace --examples
+
+      - name: Reclaim some disk space (because Windows is being annoying)
+        uses: actions-rs/cargo@v1
+        if: ${{ matrix.os == 'windows-latest' }}
+        with:
+          command: clean
+
      - name: Run all tests
        uses: actions-rs/cargo@v1
        with:
@@ -58,7 +77,7 @@ jobs:

      - name: Reclaim some disk space (because Windows is being annoying)
        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
+        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
        with:
          command: clean

@@ -67,13 +86,7 @@ jobs:
        uses: actions-rs/cargo@v1
        with:
          command: test
-          args: --workspace --all-features -- --ignored
-
-      - name: Check formatting
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
+          args: --workspace -- --ignored

      - name: Reclaim some disk space (because Windows is being annoying)
        uses: actions-rs/cargo@v1
@@ -83,9 +96,10 @@ jobs:

      - uses: actions-rs/clippy-check@v1
        name: Clippy checks
+        continue-on-error: true
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-features
+          args: --workspace

      - name: Run clippy
        uses: actions-rs/cargo@v1
@@ -100,38 +114,6 @@ jobs:
        with:
          command: clean

-      # COCONUT stuff
-      - name: Build all binaries with coconut enabled
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --workspace --features=coconut
-
-      - name: Reclaim some disk space (because Windows is being annoying)
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
-        with:
-          command: clean
-
-      - name: Run all tests with coconut enabled
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --workspace --features=coconut
-
-      - name: Reclaim some disk space (because Windows is being annoying)
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
-        with:
-          command: clean
-
-      - name: Run clippy with coconut enabled
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.rust != 'nightly' }}
-        with:
-          command: clippy
-          args: --workspace --all-targets --features=coconut -- -D warnings
-
      # nym-wallet (the rust part)
      - name: Build nym-wallet rust code
        uses: actions-rs/cargo@v1
@@ -160,12 +142,17 @@ jobs:

  notification:
    needs: build
-    runs-on: ubuntu-20.04
+    runs-on: custom-runner-linux
    steps:
      - name: Collect jobs status
        uses: technote-space/workflow-conclusion-action@v2
      - name: Check out repository code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+      - name: install npm
+        uses: actions/setup-node@v3
+        if: env.WORKFLOW_CONCLUSION == 'failure'
+        with:
+          node-version: 16
      - name: Keybase - Node Install
        if: env.WORKFLOW_CONCLUSION == 'failure'
        run: npm install
@@ -183,6 +170,11 @@ jobs:
          KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
          KEYBASE_NYM_CHANNEL: "ci-nightly"
          IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
+          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
        uses: docker://keybaseio/client:stable-node
        with:
          args: .github/workflows/support-files/notifications/entry_point.sh
@@ -38,6 +38,7 @@ jobs:
    steps:
      - name: Install Dependencies (Linux)
        run: sudo apt-get update && sudo apt-get install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools
+        continue-on-error: true
        if: matrix.os == 'ubuntu-20.04'

      - name: Check out latest release branch
@@ -53,6 +54,12 @@ jobs:
          override: true
          components: rustfmt, clippy

+      - name: Check formatting
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
      - name: Build all binaries
        uses: actions-rs/cargo@v1
        with:
@@ -65,6 +72,18 @@ jobs:
        with:
          command: clean

+      - name: Build all examples
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --workspace --examples
+
+      - name: Reclaim some disk space (because Windows is being annoying)
+        uses: actions-rs/cargo@v1
+        if: ${{ matrix.os == 'windows-latest' }}
+        with:
+          command: clean
+
      - name: Run all tests
        uses: actions-rs/cargo@v1
        with:
@@ -73,7 +92,7 @@ jobs:

      - name: Reclaim some disk space (because Windows is being annoying)
        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
+        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
        with:
          command: clean

@@ -82,13 +101,7 @@ jobs:
        uses: actions-rs/cargo@v1
        with:
          command: test
-          args: --workspace --all-features -- --ignored
-
-      - name: Check formatting
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
+          args: --workspace -- --ignored

      - name: Reclaim some disk space (because Windows is being annoying)
        uses: actions-rs/cargo@v1
@@ -98,9 +111,10 @@ jobs:

      - uses: actions-rs/clippy-check@v1
        name: Clippy checks
+        continue-on-error: true
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-features
+          args: --workspace

      - name: Run clippy
        uses: actions-rs/cargo@v1
@@ -115,38 +129,6 @@ jobs:
        with:
          command: clean

-      # COCONUT stuff
-      - name: Build all binaries with coconut enabled
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --workspace --features=coconut
-
-      - name: Reclaim some disk space (because Windows is being annoying)
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
-        with:
-          command: clean
-
-      - name: Run all tests with coconut enabled
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --workspace --features=coconut
-
-      - name: Reclaim some disk space (because Windows is being annoying)
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
-        with:
-          command: clean
-
-      - name: Run clippy with coconut enabled
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.rust != 'nightly' }}
-        with:
-          command: clippy
-          args: --workspace --all-targets --features=coconut -- -D warnings
-
      # nym-wallet (the rust part)
      - name: Build nym-wallet rust code
        uses: actions-rs/cargo@v1
@@ -175,12 +157,17 @@ jobs:

  notification:
    needs: [build,get_release]
-    runs-on: ubuntu-20.04
+    runs-on: custom-runner-linux
    steps:
      - name: Collect jobs status
        uses: technote-space/workflow-conclusion-action@v2
      - name: Check out repository code
        uses: actions/checkout@v3
+      - name: install npm
+        uses: actions/setup-node@v3
+        if: env.WORKFLOW_CONCLUSION == 'failure'
+        with:
+          node-version: 16
      - name: Keybase - Node Install
        if: env.WORKFLOW_CONCLUSION == 'failure'
        run: npm install
@@ -198,6 +185,11 @@ jobs:
          KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
          KEYBASE_NYM_CHANNEL: "ci-nightly-release"
          IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
+          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
        uses: docker://keybaseio/client:stable-node
        with:
          args: .github/workflows/support-files/notifications/entry_point.sh
@@ -38,6 +38,7 @@ jobs:
    steps:
      - name: Install Dependencies (Linux)
        run: sudo apt-get update && sudo apt-get install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools
+        continue-on-error: true
        if: matrix.os == 'ubuntu-20.04'

      - name: Check out latest release branch
@@ -53,6 +54,12 @@ jobs:
          override: true
          components: rustfmt, clippy

+      - name: Check formatting
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
      - name: Build all binaries
        uses: actions-rs/cargo@v1
        with:
@@ -65,6 +72,18 @@ jobs:
        with:
          command: clean

+      - name: Build all examples
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --workspace --examples
+
+      - name: Reclaim some disk space (because Windows is being annoying)
+        uses: actions-rs/cargo@v1
+        if: ${{ matrix.os == 'windows-latest' }}
+        with:
+          command: clean
+
      - name: Run all tests
        uses: actions-rs/cargo@v1
        with:
@@ -73,7 +92,7 @@ jobs:

      - name: Reclaim some disk space (because Windows is being annoying)
        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
+        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
        with:
          command: clean

@@ -82,13 +101,7 @@ jobs:
        uses: actions-rs/cargo@v1
        with:
          command: test
-          args: --workspace --all-features -- --ignored
-
-      - name: Check formatting
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
+          args: --workspace -- --ignored

      - name: Reclaim some disk space (because Windows is being annoying)
        uses: actions-rs/cargo@v1
@@ -98,9 +111,10 @@ jobs:

      - uses: actions-rs/clippy-check@v1
        name: Clippy checks
+        continue-on-error: true
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-features
+          args: --workspace

      - name: Run clippy
        uses: actions-rs/cargo@v1
@@ -115,38 +129,6 @@ jobs:
        with:
          command: clean

-      # COCONUT stuff
-      - name: Build all binaries with coconut enabled
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --workspace --features=coconut
-
-      - name: Reclaim some disk space (because Windows is being annoying)
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
-        with:
-          command: clean
-
-      - name: Run all tests with coconut enabled
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --workspace --features=coconut
-
-      - name: Reclaim some disk space (because Windows is being annoying)
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
-        with:
-          command: clean
-
-      - name: Run clippy with coconut enabled
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.rust != 'nightly' }}
-        with:
-          command: clippy
-          args: --workspace --all-targets --features=coconut -- -D warnings
-
      # nym-wallet (the rust part)
      - name: Build nym-wallet rust code
        uses: actions-rs/cargo@v1
@@ -175,12 +157,17 @@ jobs:

  notification:
    needs: [build,get_release]
-    runs-on: ubuntu-20.04
+    runs-on: custom-runner-linux
    steps:
      - name: Collect jobs status
        uses: technote-space/workflow-conclusion-action@v2
      - name: Check out repository code
        uses: actions/checkout@v3
+      - name: install npm
+        uses: actions/setup-node@v3
+        if: env.WORKFLOW_CONCLUSION == 'failure'
+        with:
+          node-version: 16
      - name: Keybase - Node Install
        if: env.WORKFLOW_CONCLUSION == 'failure'
        run: npm install
@@ -198,6 +185,11 @@ jobs:
          KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
          KEYBASE_NYM_CHANNEL: "ci-nightly-release"
          IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
+          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
        uses: docker://keybaseio/client:stable-node
        with:
          args: .github/workflows/support-files/notifications/entry_point.sh
@@ -10,6 +10,7 @@ env:

 jobs:
  publish-nym-cli:
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-cli-') && (github.event_name == 'release' || github.event_name = 'workflow_dispatch') }}
    strategy:
      fail-fast: false
      matrix:
@@ -20,7 +21,6 @@ jobs:
      - uses: actions/checkout@v3

      - name: Check the release tag starts with `nym-cli-`
-        if: startsWith(github.ref, 'refs/tags/nym-cli-') == false && github.event_name != 'workflow_dispatch'
        uses: actions/github-script@v3
        with:
          script: |
@@ -10,6 +10,7 @@ defaults:

 jobs:
  publish-tauri:
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release' }}
    strategy:
      fail-fast: false
      matrix:
@@ -19,13 +20,6 @@ jobs:
    steps:
      - uses: actions/checkout@v2

-      - name: Check the release tag starts with `nym-connect-`
-        if: startsWith(github.ref, 'refs/tags/nym-connect-') == false && github.event_name != 'workflow_dispatch'
-        uses: actions/github-script@v3
-        with:
-          script: |
-            core.setFailed('Release tag did not start with nym-connect-...')
-
      - name: Node v16
        uses: actions/setup-node@v3
        with:
@@ -10,10 +10,11 @@ defaults:

 jobs:
  publish-tauri:
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release' }}
    strategy:
      fail-fast: false
      matrix:
-        platform: [ubuntu-20.04]
+        platform: [custom-runner-linux]

    runs-on: ${{ matrix.platform }}
    steps:
@@ -23,17 +24,13 @@ jobs:
        run: >
          sudo apt-get update &&
          sudo apt-get install -y webkit2gtk-4.0 libayatana-appindicator3-dev
-      - name: Check the release tag starts with `nym-connect-`
-        if: startsWith(github.ref, 'refs/tags/nym-connect-') == false && github.event_name != 'workflow_dispatch'
-        uses: actions/github-script@v3
-        with:
-          script: |
-            core.setFailed('Release tag did not start with nym-connect-...')
+        continue-on-error: true

      - name: Node v16
        uses: actions/setup-node@v3
        with:
          node-version: 16
+
      - name: Install Rust stable
        uses: actions-rs/toolchain@v1
        with:
@@ -10,6 +10,7 @@ defaults:

 jobs:
  publish-tauri:
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release' }}
    strategy:
      fail-fast: false
      matrix:
@@ -27,13 +28,6 @@ jobs:

      - uses: actions/checkout@v3

-      - name: Check the release tag starts with `nym-connect-`
-        if: startsWith(github.ref, 'refs/tags/nym-connect-') == false && github.event_name != 'workflow_dispatch'
-        uses: actions/github-script@v3
-        with:
-          script: |
-            core.setFailed('Release tag did not start with nym-connect-...')
-
      - name: Import signing certificate
        env:
          WINDOWS_CERTIFICATE: ${{ secrets.WINDOWS_CERTIFICATE }}
@@ -16,6 +16,7 @@ jobs:
    - uses: actions/checkout@v2
    - name: Install rsync
      run: sudo apt-get install rsync
+      continue-on-error: true
    - uses: rlespinasse/github-slug-action@v3.x
    - uses: actions/setup-node@v3
      with:
@@ -54,6 +55,11 @@ jobs:
        KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
        KEYBASE_NYM_CHANNEL: "ci-nym-connect"
        IS_SUCCESS: "${{ job.status == 'success' }}"
+        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
      uses: docker://keybaseio/client:stable-node
      with:
        args: .github/workflows/support-files/notifications/entry_point.sh
@@ -16,10 +16,11 @@ env:

 jobs:
  publish-nym:
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-binaries-') && github.event_name == 'release' }}
    strategy:
      fail-fast: false
      matrix:
-        platform: [ubuntu-20.04]
+        platform: [custom-runner-linux]

    runs-on: ${{ matrix.platform }}
    steps:
@@ -27,13 +28,7 @@ jobs:

      - name: Install Dependencies (Linux)
        run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools
-
-      - name: Check the release tag starts with `nym-binaries-`
-        if: startsWith(github.ref, 'refs/tags/nym-binaries-') == false && github.event_name != 'workflow_dispatch'
-        uses: actions/github-script@v3
-        with:
-          script: |
-            core.setFailed('Release tag did not start with nym-binaries-...')
+        continue-on-error: true
            
      - name: Sets env vars for tokio if set in manual dispatch inputs
        run: |
@@ -56,11 +51,12 @@ jobs:
        with:
          name: my-artifact
          path: |
+            target/release/explorer-api
            target/release/nym-client
            target/release/nym-gateway
            target/release/nym-mixnode
            target/release/nym-socks5-client
-            target/release/nym-validator-api
+            target/release/nym-api
            target/release/nym-network-requester
            target/release/nym-network-statistics
            target/release/nym-cli
@@ -71,11 +67,12 @@ jobs:
        if: github.event_name == 'release'
        with:
          files: |
+            target/release/explorer-api
            target/release/nym-client
            target/release/nym-gateway
            target/release/nym-mixnode
            target/release/nym-socks5-client
-            target/release/nym-validator-api
+            target/release/nym-api
            target/release/nym-network-requester
            target/release/nym-network-statistics
            target/release/nym-cli
@@ -10,6 +10,7 @@ defaults:

 jobs:
  publish-tauri:
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release' }}
    strategy:
      fail-fast: false
      matrix:
@@ -19,13 +20,6 @@ jobs:
    steps:
      - uses: actions/checkout@v2

-      - name: Check the release tag starts with `nym-wallet-`
-        if: startsWith(github.ref, 'refs/tags/nym-wallet-') == false && github.event_name != 'workflow_dispatch'
-        uses: actions/github-script@v3
-        with:
-          script: |
-            core.setFailed('Release tag did not start with nym-wallet-...')
-
      - name: Node v16
        uses: actions/setup-node@v3
        with:
@@ -9,10 +9,11 @@ defaults:

 jobs:
  publish-tauri:
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release' }}
    strategy:
      fail-fast: false
      matrix:
-        platform: [ubuntu-20.04]
+        platform: [custom-runner-linux]

    runs-on: ${{ matrix.platform }}
    steps:
@@ -22,17 +23,13 @@ jobs:
        run: >
          sudo apt-get update &&
          sudo apt-get install -y webkit2gtk-4.0
-      - name: Check the release tag starts with `nym-wallet-`
-        if: startsWith(github.ref, 'refs/tags/nym-wallet-') == false
-        uses: actions/github-script@v3
-        with:
-          script: |
-            core.setFailed('Release tag did not start with nym-wallet-...')
+        continue-on-error: true

      - name: Node v16
        uses: actions/setup-node@v3
        with:
          node-version: 16
+
      - name: Install Rust stable
        uses: actions-rs/toolchain@v1
        with:
@@ -9,6 +9,7 @@ defaults:

 jobs:
  publish-tauri:
+    if: ${{ startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release' }}
    strategy:
      fail-fast: false
      matrix:
@@ -26,13 +27,6 @@ jobs:

      - uses: actions/checkout@v3

-      - name: Check the release tag starts with `nym-wallet-`
-        if: startsWith(github.ref, 'refs/tags/nym-wallet-') == false
-        uses: actions/github-script@v3
-        with:
-          script: |
-            core.setFailed('Release tag did not start with nym-wallet-...')
-
      - name: Import signing certificate
        env:
          WINDOWS_CERTIFICATE: ${{ secrets.WINDOWS_CERTIFICATE }}
@@ -12,6 +12,7 @@ jobs:
    - uses: actions/checkout@v2
    - name: Install rsync
      run: sudo apt-get install rsync
+      continue-on-error: true
    - uses: rlespinasse/github-slug-action@v3.x
    - uses: actions/setup-node@v3
      with:
@@ -50,6 +51,11 @@ jobs:
        KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
        KEYBASE_NYM_CHANNEL: "ci-nym-wallet"
        IS_SUCCESS: "${{ job.status == 'success' }}"
+        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
      uses: docker://keybaseio/client:stable-node
      with:
        args: .github/workflows/support-files/notifications/entry_point.sh
@@ -26,6 +26,7 @@ jobs:
          libappindicator3-dev
          webkit2gtk-driver
          xvfb
+        continue-on-error: true

      - name: Install minimal stable
        uses: actions-rs/toolchain@v1
@@ -2,6 +2,13 @@ KEYBASE_NYM_CHANNEL=
 KEYBASE_NYMBOT_USERNAME=
 KEYBASE_NYMBOT_PAPERKEY=

+MATRIX_SERVER=
+MATRIX_ROOM=
+MATRIX_ROOM_OF_SHAME=
+MATRIX_USER_ID=
+MATRIX_TOKEN=
+MATRIX_DEVICE_ID=
+
 NYM_NOTIFICATION_KIND=nightly
 NYM_PROJECT_NAME=Nightly Build

@@ -2,4 +2,6 @@ node_modules
 .idea

 # don't commit the lock file to avoid cross-platform issues
-package-lock.json
+package-lock.json
+
+scratch
@@ -1,6 +1,7 @@
 require('dotenv').config();

 const Bot = require('keybase-bot');
+const { sendMatrixMessage } = require('./send_message_to_matrix');

 let context = {
  kinds: ['nym-wallet', 'ts-packages', 'network-explorer', 'nightly', 'nym-connect','security'],
@@ -38,6 +39,28 @@ function validateContext() {
      'Paperkey is not defined. Please set env var KEYBASE_NYMBOT_PAPERKEY',
    );
  }
+  if (context.env.MATRIX_ROOM) {
+    if (!context.env.MATRIX_SERVER) {
+      throw new Error(
+        'Matrix server is not defined. Please set env var MATRIX_SERVER',
+      );
+    }
+    if (!context.env.MATRIX_USER_ID) {
+      throw new Error(
+        'Matrix user id is not defined. Please set env var MATRIX_USER_ID',
+      );
+    }
+    if (!context.env.MATRIX_TOKEN) {
+      throw new Error(
+        'Matrix token is not defined. Please set env var MATRIX_TOKEN',
+      );
+    }
+    if (!context.env.MATRIX_DEVICE_ID) {
+      throw new Error(
+        'Matrix device id is not defined. Please set env var MATRIX_DEVICE_ID',
+      );
+    }
+  }
 }

 /**
@@ -147,6 +170,13 @@ async function main() {
    console.log('-----------------------------------------');
  }
  await sendKeybaseMessage(messageBody);
+  if(context.env.MATRIX_ROOM) {
+    await sendMatrixMessage(context, messageBody, context.env.MATRIX_ROOM)
+  }
+  if(context.env.MATRIX_ROOM_OF_SHAME && context.env.IS_SUCCESS !== 'true') {
+    // when a job fails
+    await sendMatrixMessage(context, messageBody, context.env.MATRIX_ROOM_OF_SHAME)
+  }
 }

 // call main function and let NodeJS handle the promise
@@ -0,0 +1,80 @@
+const sdk = require('matrix-js-sdk');
+global.Olm = require('olm');
+const { LocalStorage } = require('node-localstorage');
+const localStorage = new LocalStorage('./scratch');
+const {
+  LocalStorageCryptoStore,
+} = require('matrix-js-sdk/lib/crypto/store/localStorage-crypto-store');
+
+const vfile = require('to-vfile');
+const unified = require('unified');
+const remarkParse = require('remark-parse');
+const remarkHtml = require('remark-html');
+const emoji = require('remark-emoji');
+
+// hide all matrix client output
+console.error = (error) => console.log('❌ error: ', error);
+process.stderr.write = () => {};
+process.stdout.write = () => {};
+
+
+function createClient(context, room, message) {
+  const server = context.env.MATRIX_SERVER;
+  const token = context.env.MATRIX_TOKEN;
+  const deviceId = context.env.MATRIX_DEVICE_ID;
+  const userId = context.env.MATRIX_USER_ID;
+
+  const client = sdk.createClient({
+    baseUrl: server,
+    accessToken: token,
+    userId,
+    deviceId,
+    sessionStore: new sdk.WebStorageSessionStore(localStorage),
+    cryptoStore: new LocalStorageCryptoStore(localStorage),
+  });
+
+  client.on('sync', async function(state, prevState, res) {
+    if (state !== 'PREPARED') return;
+    client.setGlobalErrorOnUnknownDevices(false);
+    try {
+      await client.joinRoom(room);
+      await client.sendEvent(
+        room,
+        'm.room.message',
+        {
+          msgtype: 'm.text',
+          format: 'org.matrix.custom.html',
+          body: message,
+          formatted_body: message,
+        },
+        '',
+      );
+    } catch (error) {
+      console.error('Job failed: ' + error.message);
+    }
+    client.stopClient();
+    process.exit(0);
+  });
+
+  return client;
+}
+
+async function markdownToHtml(messageAsMarkdown) {
+  const file = await unified()
+    .use(emoji)
+    .use(remarkParse)
+    .use(remarkHtml)
+    .process(await vfile({ path: 'test.md', contents: messageAsMarkdown}));
+  return String(file);
+}
+
+async function sendMatrixMessage(contextArg, messageAsMarkdown, roomId) {
+  const messageAsHtml = await markdownToHtml(messageAsMarkdown);
+  const client = createClient(contextArg, roomId, messageAsHtml);
+  await client.initCrypto();
+  await client.startClient({ initialSyncLimit: 1 });
+}
+
+module.exports = {
+  sendMatrixMessage,
+};
@@ -11,7 +11,15 @@
    "dotenv": "^16.0.0",
    "handlebars": "^4.7.7",
    "keybase-bot": "^3.6.1",
-    "octokit": "^1.7.1"
+    "matrix-js-sdk": "^9.3.0",
+    "node-localstorage": "^2.1.6",
+    "octokit": "^1.7.1",
+    "olm": "https://packages.matrix.org/npm/olm/olm-3.2.1.tgz",
+    "remark-emoji": "^2.2.0",
+    "remark-html": "^13.0.2",
+    "remark-parse": "^9.0.0",
+    "to-vfile": "^6.1.0",
+    "unified": "^9.2.2"
  },
  "devDependencies": {
    "prettier": "2.3.2"
@@ -0,0 +1,51 @@
+name: CI for linting Typescript
+
+on:
+  push:
+    paths:
+      - 'ts-packages/**'
+      - 'sdk/typescript/**'
+      - nym-connect
+      - nym-connect-android
+      - nym-wallet
+
+jobs:
+  build:
+    runs-on: custom-runner-linux
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install rsync
+      run: sudo apt-get install rsync
+      continue-on-error: true
+    - uses: rlespinasse/github-slug-action@v3.x
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 16
+    - name: Setup yarn
+      run: npm install -g yarn
+    - name: Lint
+      run: yarn && yarn lint && yarn tsc
+    - name: Keybase - Node Install
+      run: npm install
+      working-directory: .github/workflows/support-files
+    - name: Keybase - Send Notification
+      env:
+        NYM_NOTIFICATION_KIND: ts-packages
+        NYM_PROJECT_NAME: "ts-packages"
+        NYM_CI_WWW_BASE: "${{ secrets.NYM_CI_WWW_BASE }}"
+        NYM_CI_WWW_LOCATION: "ts-${{ env.GITHUB_REF_SLUG }}"
+        GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
+        GIT_BRANCH: "${GITHUB_REF##*/}"
+        KEYBASE_NYMBOT_USERNAME: "${{ secrets.KEYBASE_NYMBOT_USERNAME }}"
+        KEYBASE_NYMBOT_PAPERKEY: "${{ secrets.KEYBASE_NYMBOT_PAPERKEY }}"
+        KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMBOT_TEAM }}"
+        KEYBASE_NYM_CHANNEL: "ci-ts-packages"
+        IS_SUCCESS: "${{ job.status == 'success' }}"
+        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
+        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
+        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
+        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
+        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
+      uses: docker://keybaseio/client:stable-node
+      with:
+        args: .github/workflows/support-files/notifications/entry_point.sh
@@ -2,11 +2,17 @@ name: Nym Wallet (rust)

 on:
  push:
-    paths-ignore:
-      - 'explorer/**'
+    paths:
+      - 'nym-wallet/**'
+      - 'common/**'
+      - 'contracts/vesting/**'
+      - 'nym-api/nym-api-requests/**'
  pull_request:
-    paths-ignore:
-      - 'explorer/**'
+    paths:
+      - 'nym-wallet/**'
+      - 'common/**'
+      - 'contracts/vesting/**'
+      - 'nym-api/nym-api-requests/**'

 jobs:
  build:
@@ -16,6 +22,7 @@ jobs:
    steps:
      - name: Install Dependencies (Linux)
        run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools
+        continue-on-error: true

      - name: Check out repository code
        uses: actions/checkout@v2
@@ -48,6 +55,7 @@ jobs:

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

 on:
  pull_request:
-    paths-ignore:
-      - 'explorer/**'
+    paths:
+      - 'clients/webassembly/**'
+      - 'clients/client-core/**'
+      - 'common/**'
+      - 'contracts/**'
+      - 'gateway/gateway-requests/**'
+      - 'nym-api/nym-api-requests/**'

 jobs:
  wasm:
@@ -24,16 +29,6 @@ jobs:
          command: build
          args: --manifest-path clients/webassembly/Cargo.toml --target wasm32-unknown-unknown

-      - uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --manifest-path clients/webassembly/Cargo.toml --target wasm32-unknown-unknown --features=coconut
-
-      - uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --manifest-path clients/webassembly/Cargo.toml
-
      - uses: actions-rs/cargo@v1
        with:
          command: fmt
@@ -38,4 +38,8 @@ validator-config
 validator-api-config.toml
 dist
 storybook-static
-envs/qwerty.env
+envs/qwerty.env
+Cargo.lock
+nym-connect/Cargo.lock
+.parcel-cache
+**/.DS_Store
@@ -1,6 +1,8 @@
 {
-  "mainnet":[{
-    "nymd_url":"https://rpc.nyx.nodes.guru/",
-    "api_url":"https://api.nyx.nodes.guru/"
-  }]
-}
+  "mainnet": [
+    {
+      "nyxd_url": "https://rpc.nyx.nodes.guru/",
+      "api_url": "https://api.nyx.nodes.guru/"
+    }
+  ]
+}
@@ -2,27 +2,127 @@

 Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

-## [Unreleased]
+# [Unreleased]

 ### Added

- socks5: send status message for service ready, and network-requester error response
+- dkg resharing mode ([#2936])
+
+[#2936]: https://github.com/nymtech/nym/pull/2936
+
+
+# [v1.1.9] (2023-02-07)
+
+### Added
+
+- Separate `nym-api` endpoints with values of "total-supply" and "circulating-supply" in `nym` ([#2964])
+- Add `host` option to client init ([#2912])
+- Remove Coconut feature flag ([#2793])
+- Don't drop in mixnet connection handler ([#2963])
+
+### Changed
+- native-client: is now capable of listening for requests on sockets different than `127.0.0.1` ([#2939]). This can be specified via `--host` flag during `init` or `run`. Alternatively a custom `host` can be set in `config.toml` file under `socket` section.
+- mixnode, gateway: fix unexpected shutdown on corrupted connection ([#2963])
+
+[#2939]: https://github.com/nymtech/nym/pull/2939
+[#2963]: https://github.com/nymtech/nym/pull/2963
+
+
+# [v1.1.8] (2023-01-31)
+
+### Added
+
+- Rust SDK - Support SURBS (anonymous send + storage) ([#2754])
+- dkg rerun from scratch and dkg-specific epochs ([#2810])
+- Rename `'initial_supply'` field to `'total_supply'` in the circulating supply endpoint ([#2931])
+- Circulating supply api endpoint (read the note inside before testing/deploying) ([#1902])

 ### Changed

- all-binaries: improved error logging ([#2686])
- native client: bring shutdown logic up to the same level as socks5-client
- nym-api, coconut-dkg contract: automatic, time-based dkg epoch state advancement ([#2670])
+- nym-api: an `--id` flag is now always explicitly required ([#2873])
+
+[#2754]: https://github.com/nymtech/nym/issues/2754
+[#2810]: https://github.com/nymtech/nym/issues/2810
+[#2931]: https://github.com/nymtech/nym/issues/2931
+[#1902]: https://github.com/nymtech/nym/issues/1902
+[#2873]: https://github.com/nymtech/nym/issues/2873
+
+
+# [v1.1.7] (2023-01-24)
+
+### Added
+
+- Gateways now shut down gracefully ([#2019]).
+- Rust SDK - Initial version for nym-client ([#2669]).
+- Introduce vesting contract query for addresses of all vesting accounts (required for the circulating supply calculation) ([#2778]).
+- Add threshold value to the contract storage ([#1893])
+
+### Changed
+
+- Refactor vesting account storage (and in particular, ACCOUNTS saving) ([#2795]).
+- Move from manual advancing DKG state to an automatic process ([#2670]).
+
+### Fixed
+
+- Gateways now shut down gracefully ([#2019]).
+
+[#2019]: https://github.com/nymtech/nym/issues/2019
+[#2669]: https://github.com/nymtech/nym/issues/2669
+[#2795]: https://github.com/nymtech/nym/issues/2795
+[#2778]: https://github.com/nymtech/nym/issues/2778
+[#2670]: https://github.com/nymtech/nym/issues/2670
+[#1893]: https://github.com/nymtech/nym/issues/1893
+
+## [v1.1.6] (2023-01-17)
+
+### Added
+
+- nym-sdk: added initial version of a Rust client sdk
+- nym-api: added `/circulating-supply` endpoint ([#2814])
+- nym-api: add endpoint listing detailed gateway info by @octol in https://github.com/nymtech/nym/pull/2833
+
+### Changed
+
+- streamline override_config functions -> there's a lot of duplicate if statements everywhere ([#2774])
+- clean-up nym-api startup arguments/flags to use clap 3 and its macro-derived arguments ([#2772])
+- renamed all references to validator_api to nym_api
+- renamed all references to nymd to nyxd ([#2696])
 - all-binaries: standarised argument names (note: old names should still be accepted) ([#2762]

 ### Fixed

 - nym-api: should now correctly use `rewarding.enabled` config flag ([#2753])

-[#2686]: https://github.com/nymtech/nym/pull/2686
-[#2670]: https://github.com/nymtech/nym/pull/2670
+[#2696]: https://github.com/nymtech/nym/pull/2696
 [#2753]: https://github.com/nymtech/nym/pull/2753
 [#2762]: https://github.com/nymtech/nym/pull/2762
+[#2814]: https://github.com/nymtech/nym/pull/2814
+[#2772]: https://github.com/nymtech/nym/pull/2772
+[#2774]: https://github.com/nymtech/nym/pull/2774
+
+## [v1.1.5] (2023-01-10)
+
+### Added
+
+### Changed
+
+## [v1.1.5] (2023-01-10)
+
+### Added
+
+- socks5: send status message for service ready, and network-requester error response in https://github.com/nymtech/nym/pull/2715
+
+### Changed
+
+- all-binaries: improved error logging in https://github.com/nymtech/nym/pull/2686
+- native client: bring shutdown logic up to the same level as socks5-client in https://github.com/nymtech/nym/pull/2695
+- nym-api, coconut-dkg contract: automatic, time-based dkg epoch state advancement in https://github.com/nymtech/nym/pull/2670
+- DKG resharing unit test by @neacsu in https://github.com/nymtech/nym/pull/2668
+- Renaming validator-api to nym-api by @futurechimp in https://github.com/nymtech/nym/pull/1863
+- Modify wasm specific make targets by @neacsu in https://github.com/nymtech/nym/pull/2693
+- client: create websocket handler builder by @octol in https://github.com/nymtech/nym/pull/2700
+- Outfox and Lion by @durch in https://github.com/nymtech/nym/pull/2730
+- Feature/multi surb transmission lanes by @jstuczyn in https://github.com/nymtech/nym/pull/2723

 ## [v1.1.4] (2022-12-20)

@@ -45,7 +145,7 @@ The release also include some additional work for distributed key generation in
 ### Changed

 - validator-api: can recover from shutdown during DKG process ([#1872])
- clients: deduplicate gateway inititialization, part of work towards a rust-sdk
+- clients: deduplicate gateway initialization, part of work towards a rust-sdk
 - clients: keep all transmission lanes going at all times by making priority probabilistic
 - clients: ability to use multi-reply SURBs to send arbitrarily long messages fully anonymously whilst requesting additional reply blocks whenever they're about to run out ([#1796], [#1801], [#1804], [#1835], [#1858], [#1883]))

@@ -120,7 +220,7 @@ The release also include some additional work for distributed key generation in
 - native-client/socks5-client/wasm-client: `use_extended_packet_size` Debug config option to make the client use 'ExtendedPacketSize' for its traffic (32kB as opposed to 2kB in 1.0.2) ([#1671])
 - network-requester: added additional Blockstream Green wallet endpoint to `example.allowed.list` ([#1611])
 - validator-api: add `interval_operating_cost` and `profit_margin_percent` to compute reward estimation endpoint
- validator-client: added `query_contract_smart` and `query_contract_raw` on `NymdClient` ([#1558])
+- validator-client: added `query_contract_smart` and `query_contract_raw` on `NyxdClient` ([#1558])
 - wasm-client: uses updated wasm-compatible `client-core` so that it's now capable of packet retransmission, cover traffic and poisson delay (among other things!) ([#1673])

 ### Fixed
@@ -215,7 +315,7 @@ The release also include some additional work for distributed key generation in
 - All binaries and cosmwasm blobs are configured at runtime now; binaries are configured using environment variables or .env files and contracts keep the configuration parameters in storage ([#1463])
 - gateway, network-statistics: include gateway id in the sent statistical data ([#1478])
 - network explorer: tweak how active set probability is shown ([#1503])
- validator-api: rewarder set update fails without panicking on possible nymd queries ([#1520])
+- validator-api: rewarder set update fails without panicking on possible nyxd queries ([#1520])
 - network-requester, socks5 client (nym-connect): send and receive respectively a message error to be displayed about filter check failure ([#1576])

 [#1249]: https://github.com/nymtech/nym/pull/1249
@@ -588,14 +688,14 @@ The release also include some additional work for distributed key generation in
 - Feature/update wallet with stake rates [\#739](https://github.com/nymtech/nym/pull/739) ([neacsu](https://github.com/neacsu))
 - Add stake reward rates and bump version of client [\#738](https://github.com/nymtech/nym/pull/738) ([neacsu](https://github.com/neacsu))
 - Bump next from 10.1.3 to 11.1.0 in /wallet-web [\#737](https://github.com/nymtech/nym/pull/737) ([dependabot[bot]](https://github.com/apps/dependabot))
- Feature/nymd client integration [\#736](https://github.com/nymtech/nym/pull/736) ([jstuczyn](https://github.com/jstuczyn))
+- Feature/nyxd client integration [\#736](https://github.com/nymtech/nym/pull/736) ([jstuczyn](https://github.com/jstuczyn))
 - Bug/fix parking lot on wasm [\#735](https://github.com/nymtech/nym/pull/735) ([neacsu](https://github.com/neacsu))
 - Explorer API: add new HTTP resource to decorate mix nodes with geoip locations [\#734](https://github.com/nymtech/nym/pull/734) ([mmsinclair](https://github.com/mmsinclair))
- Feature/completing nymd client api [\#732](https://github.com/nymtech/nym/pull/732) ([jstuczyn](https://github.com/jstuczyn))
+- Feature/completing nyxd client api [\#732](https://github.com/nymtech/nym/pull/732) ([jstuczyn](https://github.com/jstuczyn))
 - Explorer API - add port check and node description/stats proxy [\#731](https://github.com/nymtech/nym/pull/731) ([mmsinclair](https://github.com/mmsinclair))
- Feature/nymd client fee handling [\#730](https://github.com/nymtech/nym/pull/730) ([jstuczyn](https://github.com/jstuczyn))
+- Feature/nyxd client fee handling [\#730](https://github.com/nymtech/nym/pull/730) ([jstuczyn](https://github.com/jstuczyn))
 - Update DelegationCheck.tsx [\#725](https://github.com/nymtech/nym/pull/725) ([jessgess](https://github.com/jessgess))
- Rust nymd/cosmwasm client [\#724](https://github.com/nymtech/nym/pull/724) ([jstuczyn](https://github.com/jstuczyn))
+- Rust nyxd/cosmwasm client [\#724](https://github.com/nymtech/nym/pull/724) ([jstuczyn](https://github.com/jstuczyn))
 - Removed wasm feature bypassing cyclic dependencies [\#723](https://github.com/nymtech/nym/pull/723) ([jstuczyn](https://github.com/jstuczyn))
 - Updated used sphinx dependency to the most recent revision [\#722](https://github.com/nymtech/nym/pull/722) ([jstuczyn](https://github.com/jstuczyn))
 - update state management and validation [\#721](https://github.com/nymtech/nym/pull/721) ([fmtabbara](https://github.com/fmtabbara))
@@ -614,7 +714,7 @@ The release also include some additional work for distributed key generation in
 - Bond and delegation alerts [\#698](https://github.com/nymtech/nym/pull/698) ([fmtabbara](https://github.com/fmtabbara))
 - Bugfix/network monitor version check [\#697](https://github.com/nymtech/nym/pull/697) ([jstuczyn](https://github.com/jstuczyn))
 - Feature/other containers [\#692](https://github.com/nymtech/nym/pull/692) ([neacsu](https://github.com/neacsu))
- Using validator API instead of nymd [\#690](https://github.com/nymtech/nym/pull/690) ([futurechimp](https://github.com/futurechimp))
+- Using validator API instead of nyxd [\#690](https://github.com/nymtech/nym/pull/690) ([futurechimp](https://github.com/futurechimp))
 - Hang coconut issuance off the validator-api [\#679](https://github.com/nymtech/nym/pull/679) ([durch](https://github.com/durch))
 - Update hmac and blake3 [\#673](https://github.com/nymtech/nym/pull/673) ([durch](https://github.com/durch))

@@ -34,9 +34,11 @@ members = [
    "common/cosmwasm-smart-contracts/coconut-bandwidth-contract",
    "common/cosmwasm-smart-contracts/coconut-dkg",
    "common/cosmwasm-smart-contracts/contracts-common",
+    "common/cosmwasm-smart-contracts/group-contract",
    "common/cosmwasm-smart-contracts/mixnet-contract",
    "common/cosmwasm-smart-contracts/multisig-contract",
    "common/cosmwasm-smart-contracts/vesting-contract",
+    "common/mobile-storage",
    "common/credential-storage",
    "common/credentials",
    "common/crypto",
@@ -73,6 +75,8 @@ members = [
    "gateway/gateway-requests",
    "integrations/bity",
    "mixnode",
+    "sdk/rust/nym-sdk",
+    "service-providers/common",
    "service-providers/network-requester",
    "service-providers/network-statistics",
    "nym-api",
@@ -93,4 +97,21 @@ default-members = [
    "explorer-api",
 ]

-exclude = ["explorer", "contracts", "clients/webassembly", "nym-wallet", "nym-connect"]
+exclude = ["explorer", "contracts", "clients/webassembly", "nym-wallet", "nym-connect", "nym-connect-android"]
+
+[workspace.package]
+authors = ["Nym Technologies SA"]
+repository = "https://github.com/nymtech/nym"
+homepage = "https://nymtech.net"
+edition = "2021"
+
+[workspace.dependencies]
+async-trait = "0.1.63"
+lazy_static = "1.4.0"
+log = "0.4"
+serde = "1.0.152"
+serde_json = "1.0.91"
+tap = "1.0.1"
+thiserror = "1.0.38"
+tokio = "1.24.1"
+url = "2.2"
@@ -2,10 +2,10 @@ test: clippy-all cargo-test wasm fmt
 test-all: test cargo-test-expensive
 no-clippy: build cargo-test wasm fmt
 happy: fmt clippy-happy test
-clippy-all: clippy-main clippy-coconut clippy-all-contracts clippy-all-wallet clippy-all-connect clippy-all-wasm-client
+clippy-all: clippy-main clippy-all-contracts clippy-all-wallet clippy-all-connect clippy-all-wasm-client
 clippy-happy: clippy-happy-main clippy-happy-contracts clippy-happy-wallet clippy-happy-connect
-cargo-test: test-main test-contracts test-wallet test-connect test-coconut test-wasm-client
-cargo-test-expensive: test-main-expensive test-contracts-expensive test-wallet-expensive test-connect-expensive test-coconut-expensive
+cargo-test: test-main test-contracts test-wallet test-connect
+cargo-test-expensive: test-main-expensive test-contracts-expensive test-wallet-expensive test-connect-expensive
 build: build-contracts build-wallet build-main build-connect build-wasm-client
 fmt: fmt-main fmt-contracts fmt-wallet fmt-connect fmt-wasm-client

@@ -24,9 +24,6 @@ clippy-happy-connect:
 clippy-main:
 	cargo clippy --workspace -- -D warnings

-clippy-coconut:
-	cargo clippy --workspace --features coconut -- -D warnings
-
 clippy-wasm:
 	cargo clippy --manifest-path clients/webassembly/Cargo.toml --target wasm32-unknown-unknown --workspace -- -D warnings

@@ -46,16 +43,9 @@ clippy-all-wasm-client:
 test-main:
 	cargo test --workspace

-test-coconut:
-	cargo test --workspace --features coconut
-
-
 test-main-expensive:
 	cargo test --workspace -- --ignored

-test-coconut-expensive:
-	cargo test --workspace --features coconut -- --ignored
-
 test-contracts:
 	cargo test --manifest-path contracts/Cargo.toml --all-features

@@ -68,9 +58,6 @@ test-wallet:
 test-wallet-expensive:
 	cargo test --manifest-path nym-wallet/Cargo.toml --all-features -- --ignored

-test-wasm-client:
-	cargo test --workspace --manifest-path clients/webassembly/Cargo.toml --all-features
-
 test-connect:
 	cargo test --manifest-path nym-connect/Cargo.toml --all-features

@@ -122,3 +109,6 @@ mixnet-opt: wasm
 generate-typescript:
 	cd tools/ts-rs-cli && cargo run && cd ../..
 	yarn types:lint:fix
+
+run-validator-tests:
+	cd nym-api/tests/functional_test && yarn test:qa
@@ -1,6 +1,6 @@
 [package]
 name = "client-core"
-version = "1.1.4"
+version = "1.1.8"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
 edition = "2021"
 rust-version = "1.66"
@@ -13,14 +13,14 @@ dirs = "4.0"
 dashmap = "5.4.0"
 futures = "0.3"
 humantime-serde = "1.0"
-log = "0.4"
+log = { workspace = true }
 rand = { version = "0.7.3", features = ["wasm-bindgen"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0.89"
 tap = "1.0.1"
 thiserror = "1.0.34"
 url = { version ="2.2", features = ["serde"] }
-tokio = { version = "1.21.2", features = ["macros"]}
+tokio = { version = "1.24.1", features = ["macros"]}
 time = "0.3.17"

 # internal
@@ -38,11 +38,11 @@ validator-client = { path = "../../common/client-libs/validator-client", default
 task = { path = "../../common/task" }

 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio-stream]
-version = "0.1.9"
+version = "0.1.11"
 features = ["time"]

 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio]
-version = "1.21.2"
+version = "1.24.1"
 features = ["time"]

 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.sqlx]
@@ -75,12 +75,11 @@ features = ["wasm-bindgen"]
 tempfile = "3.1.0"

 [build-dependencies]
-tokio = { version = "1.21.2", features = ["rt-multi-thread", "macros"] }
+tokio = { version = "1.24.1", features = ["rt-multi-thread", "macros"] }
 sqlx = { version = "0.6.2", features = ["runtime-tokio-rustls", "sqlite", "macros", "migrate"] }

 [features]
 default = []
 fs-surb-storage = ["sqlx"]
 wasm = ["gateway-client/wasm"]
-coconut = ["gateway-client/coconut", "gateway-requests/coconut"]

@@ -9,9 +9,9 @@ async fn main() {
        use std::env;

        let out_dir = env::var("OUT_DIR").unwrap();
-        let database_path = format!("{}/fs-surbs-example.sqlite", out_dir);
+        let database_path = format!("{out_dir}/fs-surbs-example.sqlite");

-        let mut conn = SqliteConnection::connect(&format!("sqlite://{}?mode=rwc", database_path))
+        let mut conn = SqliteConnection::connect(&format!("sqlite://{database_path}?mode=rwc"))
            .await
            .expect("Failed to create SQLx database connection");

@@ -0,0 +1,11 @@
+// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+//
+use crate::{client::replies::reply_storage, config::DebugConfig};
+
+pub fn setup_empty_reply_surb_backend(debug_config: &DebugConfig) -> reply_storage::Empty {
+    reply_storage::Empty {
+        min_surb_threshold: debug_config.minimum_reply_surb_storage_threshold,
+        max_surb_threshold: debug_config.maximum_reply_surb_storage_threshold,
+    }
+}
@@ -25,6 +25,8 @@ use client_connections::{ConnectionCommandReceiver, ConnectionCommandSender, Lan
 use crypto::asymmetric::{encryption, identity};
 use futures::channel::mpsc;
 use gateway_client::bandwidth::BandwidthController;
+#[cfg(target_arch = "wasm32")]
+use gateway_client::wasm_mockups::CosmWasmClient;
 use gateway_client::{
    AcknowledgementReceiver, AcknowledgementSender, GatewayClient, MixnetMessageReceiver,
    MixnetMessageSender,
@@ -33,25 +35,63 @@ use log::{debug, info};
 use nymsphinx::acknowledgements::AckKey;
 use nymsphinx::addressing::clients::Recipient;
 use nymsphinx::addressing::nodes::NodeIdentity;
+use nymsphinx::receiver::ReconstructedMessage;
 use std::sync::Arc;
 use std::time::Duration;
 use tap::TapFallible;
 use task::{TaskClient, TaskManager};
 use url::Url;
+#[cfg(not(target_arch = "wasm32"))]
+use validator_client::nyxd::CosmWasmClient;
+
+use super::received_buffer::ReceivedBufferMessage;

 #[cfg(all(not(target_arch = "wasm32"), feature = "fs-surb-storage"))]
 pub mod non_wasm_helpers;

+pub mod helpers;
+
+#[derive(Clone)]
 pub struct ClientInput {
    pub connection_command_sender: ConnectionCommandSender,
    pub input_sender: InputMessageSender,
 }

+impl ClientInput {
+    pub async fn send(
+        &self,
+        message: InputMessage,
+    ) -> Result<(), tokio::sync::mpsc::error::SendError<InputMessage>> {
+        self.input_sender.send(message).await
+    }
+}
+
+#[derive(Clone)]
 pub struct ClientOutput {
-    pub shared_lane_queue_lengths: LaneQueueLengths,
    pub received_buffer_request_sender: ReceivedBufferRequestSender,
 }

+impl ClientOutput {
+    pub fn register_receiver(
+        &mut self,
+    ) -> Result<mpsc::UnboundedReceiver<Vec<ReconstructedMessage>>, ClientCoreError> {
+        let (reconstructed_sender, reconstructed_receiver) = mpsc::unbounded();
+
+        self.received_buffer_request_sender
+            .unbounded_send(ReceivedBufferMessage::ReceiverAnnounce(
+                reconstructed_sender,
+            ))
+            .map_err(|_| ClientCoreError::FailedToRegisterReceiver)?;
+
+        Ok(reconstructed_receiver)
+    }
+}
+
+pub struct ClientState {
+    pub shared_lane_queue_lengths: LaneQueueLengths,
+    pub reply_controller_sender: ReplyControllerSender,
+}
+
 pub enum ClientInputStatus {
    AwaitingProducer { client_input: ClientInput },
    Connected,
@@ -80,7 +120,33 @@ impl ClientOutputStatus {
    }
 }

-pub struct BaseClientBuilder<'a, B> {
+#[derive(Copy, Clone, PartialEq, Eq)]
+pub enum CredentialsToggle {
+    Enabled,
+    Disabled,
+}
+
+impl CredentialsToggle {
+    pub fn is_enabled(&self) -> bool {
+        self == &CredentialsToggle::Enabled
+    }
+
+    pub fn is_disabled(&self) -> bool {
+        self == &CredentialsToggle::Disabled
+    }
+}
+
+impl From<bool> for CredentialsToggle {
+    fn from(value: bool) -> Self {
+        if value {
+            CredentialsToggle::Enabled
+        } else {
+            CredentialsToggle::Disabled
+        }
+    }
+}
+
+pub struct BaseClientBuilder<'a, B, C: Clone> {
    // due to wasm limitations I had to split it like this : (
    gateway_config: &'a GatewayEndpointConfig,
    debug_config: &'a DebugConfig,
@@ -88,20 +154,21 @@ pub struct BaseClientBuilder<'a, B> {
    nym_api_endpoints: Vec<Url>,
    reply_storage_backend: B,

-    bandwidth_controller: Option<BandwidthController>,
+    bandwidth_controller: Option<BandwidthController<C>>,
    key_manager: KeyManager,
 }

-impl<'a, B> BaseClientBuilder<'a, B>
+impl<'a, B, C> BaseClientBuilder<'a, B, C>
 where
    B: ReplyStorageBackend + Send + Sync + 'static,
+    C: CosmWasmClient + Sync + Send + Clone + 'static,
 {
    pub fn new_from_base_config<T>(
        base_config: &'a Config<T>,
        key_manager: KeyManager,
-        bandwidth_controller: Option<BandwidthController>,
+        bandwidth_controller: Option<BandwidthController<C>>,
        reply_storage_backend: B,
-    ) -> BaseClientBuilder<'a, B> {
+    ) -> BaseClientBuilder<'a, B, C> {
        BaseClientBuilder {
            gateway_config: base_config.get_gateway_endpoint_config(),
            debug_config: base_config.get_debug_config(),
@@ -117,15 +184,15 @@ where
        gateway_config: &'a GatewayEndpointConfig,
        debug_config: &'a DebugConfig,
        key_manager: KeyManager,
-        bandwidth_controller: Option<BandwidthController>,
+        bandwidth_controller: Option<BandwidthController<C>>,
        reply_storage_backend: B,
-        disabled_credentials: bool,
+        credentials_toggle: CredentialsToggle,
        nym_api_endpoints: Vec<Url>,
-    ) -> BaseClientBuilder<'a, B> {
+    ) -> BaseClientBuilder<'a, B, C> {
        BaseClientBuilder {
            gateway_config,
            debug_config,
-            disabled_credentials,
+            disabled_credentials: credentials_toggle.is_disabled(),
            nym_api_endpoints,
            reply_storage_backend,
            bandwidth_controller,
@@ -230,15 +297,11 @@ where
        mixnet_message_sender: MixnetMessageSender,
        ack_sender: AcknowledgementSender,
        shutdown: TaskClient,
-    ) -> Result<GatewayClient, ClientCoreError> {
+    ) -> Result<GatewayClient<C>, ClientCoreError> {
        let gateway_id = self.gateway_config.gateway_id.clone();
        if gateway_id.is_empty() {
            return Err(ClientCoreError::GatewayIdUnknown);
        }
-        let gateway_owner = self.gateway_config.gateway_owner.clone();
-        if gateway_owner.is_empty() {
-            return Err(ClientCoreError::GatewayOwnerUnknown);
-        }
        let gateway_address = self.gateway_config.gateway_listener.clone();
        if gateway_address.is_empty() {
            return Err(ClientCoreError::GatwayAddressUnknown);
@@ -248,9 +311,10 @@ where
            .map_err(ClientCoreError::UnableToCreatePublicKeyFromGatewayId)?;

        // disgusting wasm workaround since there's no key persistence there (nor `client init`)
-        let shared_key = if self.key_manager.gateway_key_set() {
+        let shared_key = if self.key_manager.is_gateway_key_set() {
            Some(self.key_manager.gateway_shared_key())
        } else {
+            log::info!("Gateway key not set! Will proceed anyway.");
            None
        };

@@ -258,7 +322,6 @@ where
            gateway_address,
            self.key_manager.identity_keypair(),
            gateway_identity,
-            gateway_owner,
            shared_key,
            mixnet_message_sender,
            ack_sender,
@@ -316,7 +379,7 @@ where
    // over it. Perhaps GatewayClient needs to be thread-shareable or have some channel for
    // requests?
    fn start_mix_traffic_controller(
-        gateway_client: GatewayClient,
+        gateway_client: GatewayClient<C>,
        shutdown: TaskClient,
    ) -> BatchMixMessageSender {
        info!("Starting mix traffic controller...");
@@ -332,22 +395,32 @@ where
    where
        <B as ReplyStorageBackend>::StorageError: Sync + Send,
    {
-        let persistent_storage = PersistentReplyStorage::new(backend);
-        let mem_store = persistent_storage
-            .load_state_from_backend()
-            .await
-            .map_err(|err| ClientCoreError::SurbStorageError {
-                source: Box::new(err),
-            })?;
-
-        let store_clone = mem_store.clone();
-        spawn_future(async move {
-            persistent_storage
-                .flush_on_shutdown(store_clone, shutdown)
+        if backend.is_active() {
+            log::trace!("Setup persistent reply storage");
+            let persistent_storage = PersistentReplyStorage::new(backend);
+            let mem_store = persistent_storage
+                .load_state_from_backend()
                .await
-        });
+                .map_err(|err| ClientCoreError::SurbStorageError {
+                    source: Box::new(err),
+                })?;

-        Ok(mem_store)
+            let store_clone = mem_store.clone();
+            spawn_future(async move {
+                persistent_storage
+                    .flush_on_shutdown(store_clone, shutdown)
+                    .await
+            });
+
+            Ok(mem_store)
+        } else {
+            log::trace!("Setup inactive reply storage");
+            Ok(backend
+                .get_inactive_storage()
+                .map_err(|err| ClientCoreError::SurbStorageError {
+                    source: Box::new(err),
+                })?)
+        }
    }

    pub async fn start_base(mut self) -> Result<BaseClient, ClientCoreError>
@@ -475,11 +548,13 @@ where
            },
            client_output: ClientOutputStatus::AwaitingConsumer {
                client_output: ClientOutput {
-                    shared_lane_queue_lengths,
                    received_buffer_request_sender,
                },
            },
-            reply_controller_sender,
+            client_state: ClientState {
+                shared_lane_queue_lengths,
+                reply_controller_sender,
+            },
            task_manager,
        })
    }
@@ -488,9 +563,7 @@ where
 pub struct BaseClient {
    pub client_input: ClientInputStatus,
    pub client_output: ClientOutputStatus,
-
-    // it feels very wrong to put this channel here, but I can't think of any other way of passing it to the native client
-    pub reply_controller_sender: ReplyControllerSender,
+    pub client_state: ClientState,

    pub task_manager: TaskManager,
 }
@@ -43,6 +43,14 @@ async fn setup_fresh_backend<P: AsRef<Path>>(
    Ok(storage_backend)
 }

+fn setup_inactive_backend(debug_config: &DebugConfig) -> fs_backend::Backend {
+    info!("creating inactive surb database");
+    fs_backend::Backend::new_inactive(
+        debug_config.minimum_reply_surb_storage_threshold,
+        debug_config.maximum_reply_surb_storage_threshold,
+    )
+}
+
 fn archive_corrupted_database<P: AsRef<Path>>(db_path: P) -> io::Result<()> {
    let db_path = db_path.as_ref();
    debug_assert!(db_path.exists());
@@ -53,7 +61,7 @@ fn archive_corrupted_database<P: AsRef<Path>>(db_path: P) -> io::Result<()> {

    let new_extension =
        if let Some(existing_extension) = db_path.extension().and_then(|ext| ext.to_str()) {
-            format!("{existing_extension}.{}", suffix)
+            format!("{existing_extension}.{suffix}")
        } else {
            suffix
        };
@@ -65,23 +73,28 @@ fn archive_corrupted_database<P: AsRef<Path>>(db_path: P) -> io::Result<()> {
 }

 pub async fn setup_fs_reply_surb_backend<P: AsRef<Path>>(
-    db_path: P,
+    db_path: Option<P>,
    debug_config: &DebugConfig,
 ) -> Result<fs_backend::Backend, ClientCoreError> {
-    // if the database file doesnt exist, initialise fresh storage, otherwise attempt to load the existing one
-    let db_path = db_path.as_ref();
-    if db_path.exists() {
-        info!("loading existing surb database");
-        match fs_backend::Backend::try_load(db_path).await {
-            Ok(backend) => Ok(backend),
-            Err(err) => {
-                error!("failed to setup persistent storage backend for our reply needs: {err}. We're going to create a fresh database instead. This behaviour might change in the future");
+    if let Some(db_path) = db_path {
+        // if the database file doesnt exist, initialise fresh storage, otherwise attempt to load
+        // the existing one
+        let db_path = db_path.as_ref();
+        if db_path.exists() {
+            info!("loading existing surb database");
+            match fs_backend::Backend::try_load(db_path).await {
+                Ok(backend) => Ok(backend),
+                Err(err) => {
+                    error!("failed to setup persistent storage backend for our reply needs: {err}. We're going to create a fresh database instead. This behaviour might change in the future");

-                archive_corrupted_database(db_path)?;
-                setup_fresh_backend(db_path, debug_config).await
+                    archive_corrupted_database(db_path)?;
+                    setup_fresh_backend(db_path, debug_config).await
+                }
            }
+        } else {
+            setup_fresh_backend(db_path, debug_config).await
        }
    } else {
-        setup_fresh_backend(db_path, debug_config).await
+        Ok(setup_inactive_backend(debug_config))
    }
 }
@@ -77,4 +77,12 @@ impl InputMessage {
            lane,
        }
    }
+
+    pub fn lane(&self) -> &TransmissionLane {
+        match self {
+            InputMessage::Regular { lane, .. }
+            | InputMessage::Anonymous { lane, .. }
+            | InputMessage::Reply { lane, .. } => lane,
+        }
+    }
 }
@@ -17,6 +17,7 @@ use std::sync::Arc;
 // use the old key after new one was issued.

 // Remember that Arc<T> has Deref implementation for T
+#[derive(Clone)]
 pub struct KeyManager {
    /// identity key associated with the client instance.
    identity_keypair: Arc<identity::KeyPair>,
@@ -41,9 +42,6 @@ pub struct KeyManager {
 */

 impl KeyManager {
-    // this is actually **NOT** dead code
-    // I have absolutely no idea why the compiler insists it's unused. The call happens during client::init::execute
-    #[allow(dead_code)]
    /// Creates new instance of a [`KeyManager`]
    pub fn new<R>(rng: &mut R) -> Self
    where
@@ -57,16 +55,22 @@ impl KeyManager {
        }
    }

-    // this is actually **NOT** dead code
-    // I have absolutely no idea why the compiler insists it's unused. The call happens during client::init::execute
-    #[allow(dead_code)]
-    /// After shared key with the gateway is derived, puts its ownership to this instance of a [`KeyManager`].
-    pub fn insert_gateway_shared_key(&mut self, gateway_shared_key: Arc<SharedKeys>) {
-        self.gateway_shared_key = Some(gateway_shared_key)
+    pub fn from_keys(
+        id_keypair: identity::KeyPair,
+        enc_keypair: encryption::KeyPair,
+        gateway_shared_key: SharedKeys,
+        ack_key: AckKey,
+    ) -> Self {
+        Self {
+            identity_keypair: Arc::new(id_keypair),
+            encryption_keypair: Arc::new(enc_keypair),
+            gateway_shared_key: Some(Arc::new(gateway_shared_key)),
+            ack_key: Arc::new(ack_key),
+        }
    }

-    /// Loads previously stored keys from the disk.
-    pub fn load_keys(client_pathfinder: &ClientKeyPathfinder) -> io::Result<Self> {
+    /// Loads previously stored client keys from the disk.
+    fn load_client_keys(client_pathfinder: &ClientKeyPathfinder) -> io::Result<Self> {
        let identity_keypair: identity::KeyPair =
            pemstore::load_keypair(&pemstore::KeyPairPath::new(
                client_pathfinder.private_identity_key().to_owned(),
@@ -78,24 +82,51 @@ impl KeyManager {
                client_pathfinder.public_encryption_key().to_owned(),
            ))?;

-        let gateway_shared_key: SharedKeys =
-            pemstore::load_key(client_pathfinder.gateway_shared_key())?;
-
        let ack_key: AckKey = pemstore::load_key(client_pathfinder.ack_key())?;

-        // TODO: ack key is never stored so it is generated now. But perhaps it should be stored
-        // after all for consistency sake?
        Ok(KeyManager {
            identity_keypair: Arc::new(identity_keypair),
            encryption_keypair: Arc::new(encryption_keypair),
-            gateway_shared_key: Some(Arc::new(gateway_shared_key)),
+            gateway_shared_key: None,
            ack_key: Arc::new(ack_key),
        })
    }

-    // this is actually **NOT** dead code
-    // I have absolutely no idea why the compiler insists it's unused. The call happens during client::init::execute
-    #[allow(dead_code)]
+    /// Loads previously stored keys from the disk. Fails if not all, including the shared gateway
+    /// key, is available.
+    pub fn load_keys(client_pathfinder: &ClientKeyPathfinder) -> io::Result<Self> {
+        let mut key_manager = Self::load_client_keys(client_pathfinder)?;
+
+        let gateway_shared_key: SharedKeys =
+            pemstore::load_key(client_pathfinder.gateway_shared_key())?;
+
+        key_manager.gateway_shared_key = Some(Arc::new(gateway_shared_key));
+
+        Ok(key_manager)
+    }
+
+    /// Loads previously stored keys from the disk. Fails if client keys are not availabe, but the
+    /// shared gateway key is optional.
+    pub fn load_keys_but_gateway_is_optional(
+        client_pathfinder: &ClientKeyPathfinder,
+    ) -> io::Result<Self> {
+        let mut key_manager = Self::load_client_keys(client_pathfinder)?;
+
+        let gateway_shared_key: Result<SharedKeys, io::Error> =
+            pemstore::load_key(client_pathfinder.gateway_shared_key());
+
+        // It's ok if the gateway key was not found
+        let gateway_shared_key = match gateway_shared_key {
+            Err(err) if err.kind() == io::ErrorKind::NotFound => Ok(None),
+            Err(err) => Err(err),
+            Ok(key) => Ok(Some(key)),
+        }?;
+
+        key_manager.gateway_shared_key = gateway_shared_key.map(Arc::new);
+
+        Ok(key_manager)
+    }
+
    /// Stores all available keys on the disk.
    // While perhaps there is no much point in storing the `AckKey` on the disk,
    // it is done so for the consistency sake so that you wouldn't require an rng instance
@@ -119,7 +150,7 @@ impl KeyManager {
        pemstore::store_key(self.ack_key.as_ref(), client_pathfinder.ack_key())?;

        match self.gateway_shared_key.as_ref() {
-            None => warn!("No gateway shared key available to store!"),
+            None => debug!("No gateway shared key available to store!"),
            Some(gate_key) => {
                pemstore::store_key(gate_key.as_ref(), client_pathfinder.gateway_shared_key())?
            }
@@ -128,16 +159,57 @@ impl KeyManager {
        Ok(())
    }

+    pub fn store_gateway_key(&self, client_pathfinder: &ClientKeyPathfinder) -> io::Result<()> {
+        match self.gateway_shared_key.as_ref() {
+            None => {
+                return Err(io::Error::new(
+                    io::ErrorKind::Other,
+                    "trying to store a non-existing key",
+                ))
+            }
+            Some(gate_key) => {
+                pemstore::store_key(gate_key.as_ref(), client_pathfinder.gateway_shared_key())?
+            }
+        }
+
+        Ok(())
+    }
+
+    /// Overwrite the existing identity keypair
+    pub fn set_identity_keypair(&mut self, id_keypair: identity::KeyPair) {
+        self.identity_keypair = Arc::new(id_keypair);
+    }
+
    /// Gets an atomically reference counted pointer to [`identity::KeyPair`].
    pub fn identity_keypair(&self) -> Arc<identity::KeyPair> {
        Arc::clone(&self.identity_keypair)
    }

+    /// Overwrite the existing encryption keypair
+    pub fn set_encryption_keypair(&mut self, enc_keypair: encryption::KeyPair) {
+        self.encryption_keypair = Arc::new(enc_keypair);
+    }
+
    /// Gets an atomically reference counted pointer to [`encryption::KeyPair`].
    pub fn encryption_keypair(&self) -> Arc<encryption::KeyPair> {
        Arc::clone(&self.encryption_keypair)
    }

+    /// Overwrite the existing ack key
+    pub fn set_ack_key(&mut self, ack_key: AckKey) {
+        self.ack_key = Arc::new(ack_key);
+    }
+
+    /// Gets an atomically reference counted pointer to [`AckKey`].
+    pub fn ack_key(&self) -> Arc<AckKey> {
+        Arc::clone(&self.ack_key)
+    }
+
+    /// After shared key with the gateway is derived, puts its ownership to this instance of a [`KeyManager`].
+    pub fn insert_gateway_shared_key(&mut self, gateway_shared_key: Arc<SharedKeys>) {
+        self.gateway_shared_key = Some(gateway_shared_key)
+    }
+
    /// Gets an atomically reference counted pointer to [`SharedKey`].
    // since this function is not fully public, it is not expected to be used externally and
    // hence it's up to us to ensure it's called in correct context
@@ -149,12 +221,7 @@ impl KeyManager {
        )
    }

-    pub fn gateway_key_set(&self) -> bool {
+    pub fn is_gateway_key_set(&self) -> bool {
        self.gateway_shared_key.is_some()
    }
-
-    /// Gets an atomically reference counted pointer to [`AckKey`].
-    pub fn ack_key(&self) -> Arc<AckKey> {
-        Arc::clone(&self.ack_key)
-    }
 }
@@ -2,9 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0

 use crate::spawn_future;
+#[cfg(target_arch = "wasm32")]
+use gateway_client::wasm_mockups::CosmWasmClient;
 use gateway_client::GatewayClient;
 use log::*;
 use nymsphinx::forwarding::packet::MixPacket;
+#[cfg(not(target_arch = "wasm32"))]
+use validator_client::nyxd::CosmWasmClient;

 pub type BatchMixMessageSender = tokio::sync::mpsc::Sender<Vec<MixPacket>>;
 pub type BatchMixMessageReceiver = tokio::sync::mpsc::Receiver<Vec<MixPacket>>;
@@ -13,10 +17,10 @@ pub type BatchMixMessageReceiver = tokio::sync::mpsc::Receiver<Vec<MixPacket>>;
 pub const MIX_MESSAGE_RECEIVER_BUFFER_SIZE: usize = 32;
 const MAX_FAILURE_COUNT: usize = 100;

-pub struct MixTrafficController {
+pub struct MixTrafficController<C: Clone> {
    // TODO: most likely to be replaced by some higher level construct as
    // later on gateway_client will need to be accessible by other entities
-    gateway_client: GatewayClient,
+    gateway_client: GatewayClient<C>,
    mix_rx: BatchMixMessageReceiver,

    // TODO: this is temporary work-around.
@@ -24,8 +28,13 @@ pub struct MixTrafficController {
    consecutive_gateway_failure_count: usize,
 }

-impl MixTrafficController {
-    pub fn new(gateway_client: GatewayClient) -> (MixTrafficController, BatchMixMessageSender) {
+impl<C> MixTrafficController<C>
+where
+    C: CosmWasmClient + Sync + Send + Clone + 'static,
+{
+    pub fn new(
+        gateway_client: GatewayClient<C>,
+    ) -> (MixTrafficController<C>, BatchMixMessageSender) {
        let (sphinx_message_sender, sphinx_message_receiver) =
            tokio::sync::mpsc::channel(MIX_MESSAGE_RECEIVER_BUFFER_SIZE);
        (
@@ -57,7 +66,7 @@ impl MixTrafficController {
                if self.consecutive_gateway_failure_count == MAX_FAILURE_COUNT {
                    // todo: in the future this should initiate a 'graceful' shutdown or try
                    // to reconnect?
-                    panic!("failed to send sphinx packet to the gateway {} times in a row - assuming the gateway is dead. Can't do anything about it yet :(", MAX_FAILURE_COUNT)
+                    panic!("failed to send sphinx packet to the gateway {MAX_FAILURE_COUNT} times in a row - assuming the gateway is dead. Can't do anything about it yet :(")
                }
            }
            Ok(_) => {
@@ -213,7 +213,11 @@ impl ActionController {
    }

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

    /// Defines maximum amount of time the client is going to wait for reply surbs before explicitly asking
    /// for more even though in theory they wouldn't need to.
-    maximum_reply_surb_waiting_period: Duration,
+    maximum_reply_surb_rerequest_waiting_period: Duration,
+
+    /// Defines maximum amount of time the client is going to wait for reply surbs before
+    /// deciding it's never going to get them and would drop all pending messages
+    maximum_reply_surb_drop_waiting_period: Duration,

    /// Defines maximum amount of time given reply surb is going to be valid for.
    /// This is going to be superseded by key rotation once implemented.
@@ -119,7 +123,8 @@ impl<'a> From<&'a Config> for reply_controller::Config {
            cfg.minimum_reply_surb_request_size,
            cfg.maximum_reply_surb_request_size,
            cfg.maximum_allowed_reply_surb_request_size,
-            cfg.maximum_reply_surb_waiting_period,
+            cfg.maximum_reply_surb_rerequest_waiting_period,
+            cfg.maximum_reply_surb_drop_waiting_period,
            cfg.maximum_reply_surb_age,
            cfg.maximum_reply_key_age,
        )
@@ -161,8 +166,10 @@ impl Config {
                .maximum_reply_surb_request_size,
            maximum_allowed_reply_surb_request_size: base_client_debug_config
                .maximum_allowed_reply_surb_request_size,
-            maximum_reply_surb_waiting_period: base_client_debug_config
-                .maximum_reply_surb_waiting_period,
+            maximum_reply_surb_rerequest_waiting_period: base_client_debug_config
+                .maximum_reply_surb_rerequest_waiting_period,
+            maximum_reply_surb_drop_waiting_period: base_client_debug_config
+                .maximum_reply_surb_drop_waiting_period,
            maximum_reply_surb_age: base_client_debug_config.maximum_reply_surb_age,
            maximum_reply_key_age: base_client_debug_config.maximum_reply_key_age,
        }
@@ -471,14 +471,10 @@ where
        let mult = self.sending_delay_controller.current_multiplier();
        let delay = self.current_average_message_sending_delay().as_millis();
        let status_str = if self.config.disable_poisson_packet_distribution {
-            format!(
-                "Status: {lanes} lanes, backlog: {:.2} kiB ({packets}), no delay",
-                backlog
-            )
+            format!("Status: {lanes} lanes, backlog: {backlog:.2} kiB ({packets}), no delay")
        } else {
            format!(
-                "Status: {lanes} lanes, backlog: {:.2} kiB ({packets}), avg delay: {}ms ({mult})",
-                backlog, delay
+                "Status: {lanes} lanes, backlog: {backlog:.2} kiB ({packets}), avg delay: {delay}ms ({mult})"
            )
        };
        if packets > 1000 {
@@ -535,9 +531,7 @@ where
                    }
                }
            }
-            tokio::time::timeout(Duration::from_secs(5), shutdown.recv())
-                .await
-                .expect("Task stopped without shutdown called");
+            shutdown.recv_timeout().await;
        }

        #[cfg(target_arch = "wasm32")]
@@ -30,7 +30,8 @@ pub struct Config {
    min_surb_request_size: u32,
    max_surb_request_size: u32,
    maximum_allowed_reply_surb_request_size: u32,
-    max_surb_waiting_period: Duration,
+    max_surb_rerequest_waiting_period: Duration,
+    max_surb_drop_waiting_period: Duration,
    max_reply_surb_age: Duration,
    max_reply_key_age: Duration,
 }
@@ -40,7 +41,8 @@ impl Config {
        min_surb_request_size: u32,
        max_surb_request_size: u32,
        maximum_allowed_reply_surb_request_size: u32,
-        max_surb_waiting_period: Duration,
+        max_surb_rerequest_waiting_period: Duration,
+        max_surb_drop_waiting_period: Duration,
        max_reply_surb_age: Duration,
        max_reply_key_age: Duration,
    ) -> Self {
@@ -48,7 +50,8 @@ impl Config {
            min_surb_request_size,
            max_surb_request_size,
            maximum_allowed_reply_surb_request_size,
-            max_surb_waiting_period,
+            max_surb_rerequest_waiting_period,
+            max_surb_drop_waiting_period,
            max_reply_surb_age,
            max_reply_key_age,
        }
@@ -742,9 +745,13 @@ where

            let diff = now - last_received_time;

-            if diff > self.config.max_surb_waiting_period {
-                warn!("We haven't received any surbs in {:?} from {pending_reply_target}. Going to explicitly ask for more", diff);
-                to_request.push(*pending_reply_target);
+            if diff > self.config.max_surb_rerequest_waiting_period {
+                if diff > self.config.max_surb_drop_waiting_period {
+                    to_remove.push(*pending_reply_target)
+                } else {
+                    debug!("We haven't received any surbs in {:?} from {pending_reply_target}. Going to explicitly ask for more", diff);
+                    to_request.push(*pending_reply_target);
+                }
            }
        }

@@ -99,6 +99,24 @@ impl ReplyControllerSender {
    }
 }

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

 #[derive(Debug)]
@@ -5,8 +5,11 @@ use crate::client::replies::reply_storage::backend::Empty;
 use crate::client::replies::reply_storage::{CombinedReplyStorage, ReplyStorageBackend};
 use async_trait::async_trait;

+use std::path::PathBuf;
+
 // well, right now we don't have the browser storage : (
 // so we keep everything in memory
+#[derive(Debug)]
 pub struct Backend {
    empty: Empty,
 }
@@ -26,6 +29,18 @@ impl Backend {
 impl ReplyStorageBackend for Backend {
    type StorageError = <Empty as ReplyStorageBackend>::StorageError;

+    async fn new(
+        debug_config: &crate::config::DebugConfig,
+        _db_path: Option<PathBuf>,
+    ) -> Result<Self, Self::StorageError> {
+        Ok(Backend {
+            empty: Empty {
+                min_surb_threshold: debug_config.minimum_reply_surb_storage_threshold,
+                max_surb_threshold: debug_config.maximum_reply_surb_storage_threshold,
+            },
+        })
+    }
+
    async fn flush_surb_storage(
        &mut self,
        storage: &CombinedReplyStorage,
@@ -40,4 +55,8 @@ impl ReplyStorageBackend for Backend {
    async fn load_surb_storage(&self) -> Result<CombinedReplyStorage, Self::StorageError> {
        self.empty.load_surb_storage().await
    }
+
+    fn get_inactive_storage(&self) -> Result<CombinedReplyStorage, Self::StorageError> {
+        self.empty.get_inactive_storage()
+    }
 }
@@ -10,6 +10,12 @@ pub enum StorageError {
    #[error("the provided database path doesn't have a filename defined")]
    DatabasePathWithoutFilename { provided_path: PathBuf },

+    #[error("unable to create the directory for the database")]
+    DatabasePathUnableToCreateParentDirectory {
+        provided_path: PathBuf,
+        source: io::Error,
+    },
+
    #[error("failed to rename our databse file - {source}")]
    DatabaseRenameError {
        #[source]
@@ -50,4 +56,9 @@ pub enum StorageError {
        details: String,
        // err: Option<Box<dyn std::error::Error>>
    },
+
+    #[error("failed to create storage")]
+    FailedToCreateStorage {
+        source: Box<dyn std::error::Error + Send + Sync>,
+    },
 }
@@ -20,6 +20,16 @@ impl StorageManager {
        database_path: P,
        fresh: bool,
    ) -> Result<Self, StorageError> {
+        // ensure the whole directory structure exists
+        if let Some(parent_dir) = database_path.as_ref().parent() {
+            std::fs::create_dir_all(parent_dir).map_err(|source| {
+                StorageError::DatabasePathUnableToCreateParentDirectory {
+                    provided_path: database_path.as_ref().to_path_buf(),
+                    source,
+                }
+            })?;
+        }
+
        let mut opts = sqlx::sqlite::SqliteConnectOptions::new()
            .filename(database_path)
            .create_if_missing(fresh);
@@ -1,6 +1,7 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

+use crate::client::base_client::non_wasm_helpers;
 use crate::client::replies::reply_storage::backend::fs_backend::manager::StorageManager;
 use crate::client::replies::reply_storage::backend::fs_backend::models::{
    ReplySurbStorageMetadata, StoredReplyKey, StoredReplySurb, StoredSenderTag, StoredSurbSender,
@@ -22,11 +23,49 @@ mod error;
 mod manager;
 mod models;

+#[derive(Debug)]
+enum StorageManagerState {
+    Storage(StorageManager),
+    Inactive(InactiveMetadata),
+}
+
+// When the storage backaed is initialized as inactive, it will still contain metadata parameters
+// that will be needed when the in-mem storage is fetched for use.
+#[derive(Debug)]
+struct InactiveMetadata {
+    pub minimum_reply_surb_storage_threshold: usize,
+    pub maximum_reply_surb_storage_threshold: usize,
+}
+
+impl StorageManagerState {
+    fn get(&self) -> &StorageManager {
+        match self {
+            StorageManagerState::Storage(manager) => manager,
+            StorageManagerState::Inactive(_) => {
+                panic!("tried to get storage of an inactive backend")
+            }
+        }
+    }
+
+    fn get_mut(&mut self) -> &mut StorageManager {
+        match self {
+            StorageManagerState::Storage(manager) => manager,
+            StorageManagerState::Inactive(_) => {
+                panic!("tried to get storage of an inactive backend")
+            }
+        }
+    }
+
+    fn is_active(&self) -> bool {
+        matches!(self, StorageManagerState::Storage(_))
+    }
+}
+
 #[derive(Debug)]
 pub struct Backend {
    temporary_old_path: Option<PathBuf>,
    database_path: PathBuf,
-    manager: StorageManager,
+    manager: StorageManagerState,
 }

 impl Backend {
@@ -40,17 +79,32 @@ impl Backend {
            });
        }

+        let manager = StorageManager::init(database_path, true).await?;
+        manager.create_status_table().await?;
+
        let backend = Backend {
            temporary_old_path: None,
            database_path: owned_path,
-            manager: StorageManager::init(database_path, true).await?,
+            manager: StorageManagerState::Storage(manager),
        };

-        backend.manager.create_status_table().await?;
-
        Ok(backend)
    }

+    pub fn new_inactive(
+        minimum_reply_surb_storage_threshold: usize,
+        maximum_reply_surb_storage_threshold: usize,
+    ) -> Self {
+        Backend {
+            temporary_old_path: None,
+            database_path: PathBuf::new(),
+            manager: StorageManagerState::Inactive(InactiveMetadata {
+                minimum_reply_surb_storage_threshold,
+                maximum_reply_surb_storage_threshold,
+            }),
+        }
+    }
+
    pub async fn try_load<P: AsRef<Path>>(database_path: P) -> Result<Self, StorageError> {
        let owned_path: PathBuf = database_path.as_ref().into();
        if owned_path.file_name().is_none() {
@@ -119,12 +173,12 @@ impl Backend {
        Ok(Backend {
            temporary_old_path: None,
            database_path: owned_path,
-            manager,
+            manager: StorageManagerState::Storage(manager),
        })
    }

    async fn close_pool(&mut self) {
-        self.manager.connection_pool.close().await;
+        self.manager.get_mut().connection_pool.close().await;
    }

    async fn rotate(&mut self) -> Result<(), StorageError> {
@@ -143,8 +197,9 @@ impl Backend {

        fs::rename(&self.database_path, &temp_old)
            .map_err(|err| StorageError::DatabaseRenameError { source: err })?;
-        self.manager = StorageManager::init(&self.database_path, true).await?;
-        self.manager.create_status_table().await?;
+        self.manager =
+            StorageManagerState::Storage(StorageManager::init(&self.database_path, true).await?);
+        self.manager.get_mut().create_status_table().await?;

        self.temporary_old_path = Some(temp_old);
        Ok(())
@@ -161,26 +216,27 @@ impl Backend {
    }

    async fn start_storage_flush(&self) -> Result<(), StorageError> {
-        Ok(self.manager.set_flush_status(true).await?)
+        Ok(self.manager.get().set_flush_status(true).await?)
    }

    async fn end_storage_flush(&self) -> Result<(), StorageError> {
        self.manager
+            .get()
            .set_previous_flush_timestamp(OffsetDateTime::now_utc().unix_timestamp())
            .await?;
-        Ok(self.manager.set_flush_status(false).await?)
+        Ok(self.manager.get().set_flush_status(false).await?)
    }

    async fn start_client_use(&self) -> Result<(), StorageError> {
-        Ok(self.manager.set_client_in_use_status(true).await?)
+        Ok(self.manager.get().set_client_in_use_status(true).await?)
    }

    async fn stop_client_use(&self) -> Result<(), StorageError> {
-        Ok(self.manager.set_client_in_use_status(false).await?)
+        Ok(self.manager.get().set_client_in_use_status(false).await?)
    }

    async fn get_stored_tags(&self) -> Result<UsedSenderTags, StorageError> {
-        let stored = self.manager.get_tags().await?;
+        let stored = self.manager.get().get_tags().await?;

        // stop at the first instance of corruption. if even a single entry is malformed,
        // something weird has happened and we can't trust the rest of the data
@@ -196,6 +252,7 @@ impl Backend {
        for map_ref in tags.as_raw_iter() {
            let (recipient, tag) = map_ref.pair();
            self.manager
+                .get()
                .insert_tag(StoredSenderTag::new(*recipient, *tag))
                .await?;
        }
@@ -203,7 +260,7 @@ impl Backend {
    }

    async fn get_stored_reply_keys(&self) -> Result<SentReplyKeys, StorageError> {
-        let stored = self.manager.get_reply_keys().await?;
+        let stored = self.manager.get().get_reply_keys().await?;

        // stop at the first instance of corruption. if even a single entry is malformed,
        // something weird has happened and we can't trust the rest of the data
@@ -219,6 +276,7 @@ impl Backend {
        for map_ref in reply_keys.as_raw_iter() {
            let (digest, key) = map_ref.pair();
            self.manager
+                .get()
                .insert_reply_key(StoredReplyKey::new(*digest, *key))
                .await?;
        }
@@ -226,7 +284,7 @@ impl Backend {
    }

    async fn get_stored_reply_surbs(&self) -> Result<ReceivedReplySurbsMap, StorageError> {
-        let surb_senders = self.manager.get_surb_senders().await?;
+        let surb_senders = self.manager.get().get_surb_senders().await?;

        let metadata = self.get_reply_surb_storage_metadata().await?;
        let mut received_surbs = Vec::with_capacity(surb_senders.len());
@@ -236,6 +294,7 @@ impl Backend {
                sender.try_into()?;
            let stored_surbs = self
                .manager
+                .get()
                .get_reply_surbs(sender_id)
                .await?
                .into_iter()
@@ -263,6 +322,7 @@ impl Backend {
            let (tag, received_surbs) = map_ref.pair();
            let sender_id = self
                .manager
+                .get()
                .insert_surb_sender(StoredSurbSender::new(
                    *tag,
                    received_surbs.surbs_last_received_at(),
@@ -271,6 +331,7 @@ impl Backend {

            for reply_surb in received_surbs.surbs_ref() {
                self.manager
+                    .get()
                    .insert_reply_surb(StoredReplySurb::new(sender_id, reply_surb))
                    .await?
            }
@@ -282,6 +343,7 @@ impl Backend {
        &self,
    ) -> Result<ReplySurbStorageMetadata, StorageError> {
        self.manager
+            .get()
            .get_reply_surb_storage_metadata()
            .await
            .map_err(Into::into)
@@ -292,6 +354,7 @@ impl Backend {
        reply_surbs: &ReceivedReplySurbsMap,
    ) -> Result<(), StorageError> {
        self.manager
+            .get()
            .insert_reply_surb_storage_metadata(ReplySurbStorageMetadata::new(
                reply_surbs.min_surb_threshold(),
                reply_surbs.max_surb_threshold(),
@@ -305,6 +368,24 @@ impl Backend {
 impl ReplyStorageBackend for Backend {
    type StorageError = error::StorageError;

+    async fn new(
+        debug_config: &crate::config::DebugConfig,
+        db_path: Option<PathBuf>,
+    ) -> Result<Self, Self::StorageError> {
+        non_wasm_helpers::setup_fs_reply_surb_backend(db_path, debug_config)
+            .await
+            .map_err(|err| {
+                log::error!("Failed to create storage: {err}");
+                Self::StorageError::FailedToCreateStorage {
+                    source: Box::new(err),
+                }
+            })
+    }
+
+    fn is_active(&self) -> bool {
+        self.manager.is_active()
+    }
+
    async fn start_storage_session(&self) -> Result<(), Self::StorageError> {
        self.start_client_use().await
    }
@@ -342,6 +423,18 @@ impl ReplyStorageBackend for Backend {
        Ok(CombinedReplyStorage::load(reply_keys, reply_surbs, tags))
    }

+    fn get_inactive_storage(&self) -> Result<CombinedReplyStorage, Self::StorageError> {
+        match self.manager {
+            StorageManagerState::Storage(_) => {
+                panic!("tried to get inactive storage from an active storage backend")
+            }
+            StorageManagerState::Inactive(ref state) => Ok(CombinedReplyStorage::new(
+                state.minimum_reply_surb_storage_threshold,
+                state.maximum_reply_surb_storage_threshold,
+            )),
+        }
+    }
+
    async fn stop_storage_session(self) -> Result<(), Self::StorageError> {
        self.stop_client_use().await
    }
@@ -44,8 +44,7 @@ impl TryFrom<StoredSenderTag> for (RecipientBytes, AnonymousSenderTag) {
        let Ok(sender_tag_bytes) = value.tag.try_into() else {
            return Err(StorageError::CorruptedData {
                details: format!(
-                    "the retrieved sender tag has length of {tag_len} while {} was expected",
-                    SENDER_TAG_SIZE
+                    "the retrieved sender tag has length of {tag_len} while {SENDER_TAG_SIZE} was expected",
                ),
            });
        };
@@ -132,8 +131,7 @@ impl TryFrom<StoredSurbSender> for (AnonymousSenderTag, i64) {
        let Ok(sender_tag_bytes) = value.tag.try_into() else {
            return Err(StorageError::CorruptedData {
                details: format!(
-                    "the retrieved sender tag has length of {tag_len} while {} was expected",
-                    SENDER_TAG_SIZE
+                    "the retrieved sender tag has length of {tag_len} while {SENDER_TAG_SIZE} was expected",
                ),
            });
        };
@@ -3,7 +3,7 @@

 use crate::client::replies::reply_storage::CombinedReplyStorage;
 use async_trait::async_trait;
-use std::error::Error;
+use std::{error::Error, path::PathBuf};
 use thiserror::Error;

 #[cfg(target_arch = "wasm32")]
@@ -19,16 +19,27 @@ pub mod fs_backend;
 #[error("no information provided")]
 pub struct UndefinedError;

+#[derive(Debug)]
 pub struct Empty {
    // we need to keep 'basic' metadata here to "load" the CombinedReplyStorage
-    min_surb_threshold: usize,
-    max_surb_threshold: usize,
+    pub min_surb_threshold: usize,
+    pub max_surb_threshold: usize,
 }

 #[async_trait]
 impl ReplyStorageBackend for Empty {
    type StorageError = UndefinedError;

+    async fn new(
+        debug_config: &crate::config::DebugConfig,
+        _db_path: Option<PathBuf>,
+    ) -> Result<Self, Self::StorageError> {
+        Ok(Self {
+            min_surb_threshold: debug_config.minimum_reply_surb_storage_threshold,
+            max_surb_threshold: debug_config.maximum_reply_surb_storage_threshold,
+        })
+    }
+
    async fn flush_surb_storage(
        &mut self,
        _storage: &CombinedReplyStorage,
@@ -49,12 +60,28 @@ impl ReplyStorageBackend for Empty {
            self.max_surb_threshold,
        ))
    }
+
+    fn get_inactive_storage(&self) -> Result<CombinedReplyStorage, Self::StorageError> {
+        Ok(CombinedReplyStorage::new(
+            self.min_surb_threshold,
+            self.max_surb_threshold,
+        ))
+    }
 }

 #[async_trait]
 pub trait ReplyStorageBackend: Sized {
    type StorageError: Error + 'static;

+    async fn new(
+        debug_config: &crate::config::DebugConfig,
+        db_path: Option<PathBuf>,
+    ) -> Result<Self, Self::StorageError>;
+
+    fn is_active(&self) -> bool {
+        true
+    }
+
    async fn start_storage_session(&self) -> Result<(), Self::StorageError> {
        Ok(())
    }
@@ -72,6 +99,11 @@ pub trait ReplyStorageBackend: Sized {

    async fn load_surb_storage(&self) -> Result<CombinedReplyStorage, Self::StorageError>;

+    /// In the case the storage backend is initialized in an inactive state (persisting data is
+    /// disabled), we might still need to fetch the (in-mem) storage and the parameters it was
+    /// created with.
+    fn get_inactive_storage(&self) -> Result<CombinedReplyStorage, Self::StorageError>;
+
    async fn stop_storage_session(self) -> Result<(), Self::StorageError> {
        Ok(())
    }
@@ -152,7 +152,7 @@ impl TopologyRefresherConfig {
 }

 pub struct TopologyRefresher {
-    validator_client: validator_client::client::ApiClient,
+    validator_client: validator_client::client::NymApiClient,
    client_version: String,

    nym_api_urls: Vec<Url>,
@@ -168,7 +168,9 @@ impl TopologyRefresher {
        cfg.nym_api_urls.shuffle(&mut thread_rng());

        TopologyRefresher {
-            validator_client: validator_client::client::ApiClient::new(cfg.nym_api_urls[0].clone()),
+            validator_client: validator_client::client::NymApiClient::new(
+                cfg.nym_api_urls[0].clone(),
+            ),
            client_version: cfg.client_version,
            nym_api_urls: cfg.nym_api_urls,
            topology_accessor,
@@ -1,7 +1,8 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

-use config::{NymConfig, DB_FILE_NAME};
+use config::defaults::NymNetworkDetails;
+use config::{NymConfig, OptionalSet, DB_FILE_NAME};
 use nymsphinx::params::PacketSize;
 use serde::{Deserialize, Serialize};
 use std::marker::PhantomData;
@@ -44,7 +45,8 @@ const DEFAULT_MAXIMUM_REPLY_SURB_REQUEST_SIZE: u32 = 100;

 const DEFAULT_MAXIMUM_ALLOWED_SURB_REQUEST_SIZE: u32 = 500;

-const DEFAULT_MAXIMUM_REPLY_SURB_WAITING_PERIOD: Duration = Duration::from_secs(10);
+const DEFAULT_MAXIMUM_REPLY_SURB_REREQUEST_WAITING_PERIOD: Duration = Duration::from_secs(10);
+const DEFAULT_MAXIMUM_REPLY_SURB_DROP_WAITING_PERIOD: Duration = Duration::from_secs(5 * 60);

 // 12 hours
 const DEFAULT_MAXIMUM_REPLY_SURB_AGE: Duration = Duration::from_secs(12 * 60 * 60);
@@ -70,12 +72,15 @@ pub struct Config<T> {
    #[serde(default)]
    debug: DebugConfig,
 }
+
 impl<T> ClientCoreConfigTrait for Config<T> {
    fn get_gateway_endpoint(&self) -> &GatewayEndpointConfig {
        &self.client.gateway_endpoint
    }
 }

+impl<T> OptionalSet for Config<T> where T: NymConfig {}
+
 impl<T> Config<T> {
    pub fn new<S: Into<String>>(id: S) -> Self
    where
@@ -84,6 +89,7 @@ impl<T> Config<T> {
        Config::default().with_id(id)
    }

+    #[must_use]
    pub fn with_id<S: Into<String>>(mut self, id: S) -> Self
    where
        T: NymConfig,
@@ -160,26 +166,49 @@ impl<T> Config<T> {
        changes_made
    }

-    pub fn with_disabled_credentials(&mut self, disabled_credentials_mode: bool) {
+    pub fn with_disabled_credentials(mut self, disabled_credentials_mode: bool) -> Self {
        self.client.disabled_credentials_mode = disabled_credentials_mode;
+        self
    }

-    pub fn with_gateway_endpoint(&mut self, gateway_endpoint: GatewayEndpointConfig) {
+    pub fn set_gateway_endpoint(&mut self, gateway_endpoint: GatewayEndpointConfig) {
        self.client.gateway_endpoint = gateway_endpoint;
    }

+    pub fn with_gateway_endpoint(mut self, gateway_endpoint: GatewayEndpointConfig) -> Self {
+        self.client.gateway_endpoint = gateway_endpoint;
+        self
+    }
+
    pub fn with_gateway_id<S: Into<String>>(&mut self, id: S) {
        self.client.gateway_endpoint.gateway_id = id.into();
    }

-    pub fn set_custom_validators(&mut self, validator_urls: Vec<Url>) {
-        self.client.validator_urls = validator_urls;
+    pub fn with_custom_nyxd(mut self, urls: Vec<Url>) -> Self {
+        self.client.nyxd_urls = urls;
+        self
+    }
+
+    pub fn set_custom_nyxd(&mut self, nyxd_urls: Vec<Url>) {
+        self.client.nyxd_urls = nyxd_urls;
+    }
+
+    pub fn with_custom_nym_apis(mut self, nym_api_urls: Vec<Url>) -> Self {
+        self.client.nym_api_urls = nym_api_urls;
+        self
    }

    pub fn set_custom_nym_apis(&mut self, nym_api_urls: Vec<Url>) {
        self.client.nym_api_urls = nym_api_urls;
    }

+    pub fn with_high_default_traffic_volume(mut self, enabled: bool) -> Self {
+        if enabled {
+            self.set_high_default_traffic_volume();
+        }
+        self
+    }
+
    pub fn set_high_default_traffic_volume(&mut self) {
        self.debug.average_packet_delay = Duration::from_millis(10);
        // basically don't really send cover messages
@@ -188,6 +217,13 @@ impl<T> Config<T> {
        self.debug.message_sending_average_delay = Duration::from_millis(4);
    }

+    pub fn with_disabled_cover_traffic(mut self, disabled: bool) -> Self {
+        if disabled {
+            self.set_no_cover_traffic()
+        }
+        self
+    }
+
    pub fn set_no_cover_traffic(&mut self) {
        self.debug.disable_loop_cover_traffic_stream = true;
        self.debug.disable_main_poisson_packet_distribution = true;
@@ -234,7 +270,7 @@ impl<T> Config<T> {
    }

    pub fn get_validator_endpoints(&self) -> Vec<Url> {
-        self.client.validator_urls.clone()
+        self.client.nyxd_urls.clone()
    }

    pub fn get_nym_api_endpoints(&self) -> Vec<Url> {
@@ -342,8 +378,12 @@ impl<T> Config<T> {
        self.debug.maximum_allowed_reply_surb_request_size
    }

-    pub fn get_maximum_reply_surb_waiting_period(&self) -> Duration {
-        self.debug.maximum_reply_surb_waiting_period
+    pub fn get_maximum_reply_surb_rerequest_waiting_period(&self) -> Duration {
+        self.debug.maximum_reply_surb_rerequest_waiting_period
+    }
+
+    pub fn get_maximum_reply_surb_drop_waiting_period(&self) -> Duration {
+        self.debug.maximum_reply_surb_drop_waiting_period
    }

    pub fn get_maximum_reply_surb_age(&self) -> Duration {
@@ -420,9 +460,9 @@ pub struct Client<T> {
    #[serde(default)]
    disabled_credentials_mode: bool,

-    /// Addresses to nymd validators via which the client can communicate with the chain.
-    #[serde(default)]
-    validator_urls: Vec<Url>,
+    /// Addresses to nyxd validators via which the client can communicate with the chain.
+    #[serde(alias = "validator_urls")]
+    nyxd_urls: Vec<Url>,

    /// Addresses to APIs running on validator from which the client gets the view of the network.
    #[serde(alias = "validator_api_urls")]
@@ -471,13 +511,29 @@ pub struct Client<T> {

 impl<T: NymConfig> Default for Client<T> {
    fn default() -> Self {
+        let network = NymNetworkDetails::new_mainnet();
+        let nyxd_urls = network
+            .endpoints
+            .iter()
+            .map(|validator| validator.nyxd_url())
+            .collect();
+        let nym_api_urls = network
+            .endpoints
+            .iter()
+            .filter_map(|validator| validator.api_url())
+            .collect::<Vec<_>>();
+
+        if nym_api_urls.is_empty() {
+            panic!("we do not have any default nym-api urls available!")
+        }
+
        // there must be explicit checks for whether id is not empty later
        Client {
            version: env!("CARGO_PKG_VERSION").to_string(),
            id: "".to_string(),
            disabled_credentials_mode: true,
-            validator_urls: vec![],
-            nym_api_urls: vec![],
+            nyxd_urls,
+            nym_api_urls,
            private_identity_key_file: Default::default(),
            public_identity_key_file: Default::default(),
            private_encryption_key_file: Default::default(),
@@ -495,35 +551,35 @@ impl<T: NymConfig> Default for Client<T> {

 impl<T: NymConfig> Client<T> {
    fn default_private_identity_key_file(id: &str) -> PathBuf {
-        T::default_data_directory(Some(id)).join("private_identity.pem")
+        T::default_data_directory(id).join("private_identity.pem")
    }

    fn default_public_identity_key_file(id: &str) -> PathBuf {
-        T::default_data_directory(Some(id)).join("public_identity.pem")
+        T::default_data_directory(id).join("public_identity.pem")
    }

    fn default_private_encryption_key_file(id: &str) -> PathBuf {
-        T::default_data_directory(Some(id)).join("private_encryption.pem")
+        T::default_data_directory(id).join("private_encryption.pem")
    }

    fn default_public_encryption_key_file(id: &str) -> PathBuf {
-        T::default_data_directory(Some(id)).join("public_encryption.pem")
+        T::default_data_directory(id).join("public_encryption.pem")
    }

    fn default_gateway_shared_key_file(id: &str) -> PathBuf {
-        T::default_data_directory(Some(id)).join("gateway_shared.pem")
+        T::default_data_directory(id).join("gateway_shared.pem")
    }

    fn default_ack_key_file(id: &str) -> PathBuf {
-        T::default_data_directory(Some(id)).join("ack_key.pem")
+        T::default_data_directory(id).join("ack_key.pem")
    }

    fn default_reply_surb_database_path(id: &str) -> PathBuf {
-        T::default_data_directory(Some(id)).join("persistent_reply_store.sqlite")
+        T::default_data_directory(id).join("persistent_reply_store.sqlite")
    }

    fn default_database_path(id: &str) -> PathBuf {
-        T::default_data_directory(Some(id)).join(DB_FILE_NAME)
+        T::default_data_directory(id).join(DB_FILE_NAME)
    }
 }

@@ -617,7 +673,12 @@ pub struct DebugConfig {
    /// Defines maximum amount of time the client is going to wait for reply surbs before explicitly asking
    /// for more even though in theory they wouldn't need to.
    #[serde(with = "humantime_serde")]
-    pub maximum_reply_surb_waiting_period: Duration,
+    pub maximum_reply_surb_rerequest_waiting_period: Duration,
+
+    /// Defines maximum amount of time the client is going to wait for reply surbs before
+    /// deciding it's never going to get them and would drop all pending messages
+    #[serde(with = "humantime_serde")]
+    pub maximum_reply_surb_drop_waiting_period: Duration,

    /// Defines maximum amount of time given reply surb is going to be valid for.
    /// This is going to be superseded by key rotation once implemented.
@@ -658,7 +719,9 @@ impl Default for DebugConfig {
            minimum_reply_surb_request_size: DEFAULT_MINIMUM_REPLY_SURB_REQUEST_SIZE,
            maximum_reply_surb_request_size: DEFAULT_MAXIMUM_REPLY_SURB_REQUEST_SIZE,
            maximum_allowed_reply_surb_request_size: DEFAULT_MAXIMUM_ALLOWED_SURB_REQUEST_SIZE,
-            maximum_reply_surb_waiting_period: DEFAULT_MAXIMUM_REPLY_SURB_WAITING_PERIOD,
+            maximum_reply_surb_rerequest_waiting_period:
+                DEFAULT_MAXIMUM_REPLY_SURB_REREQUEST_WAITING_PERIOD,
+            maximum_reply_surb_drop_waiting_period: DEFAULT_MAXIMUM_REPLY_SURB_DROP_WAITING_PERIOD,
            maximum_reply_surb_age: DEFAULT_MAXIMUM_REPLY_SURB_AGE,
            maximum_reply_key_age: DEFAULT_MAXIMUM_REPLY_KEY_AGE,
        }
@@ -7,12 +7,12 @@ use std::path::{Path, PathBuf};

 #[derive(Debug)]
 pub struct ClientKeyPathfinder {
-    identity_private_key: PathBuf,
-    identity_public_key: PathBuf,
-    encryption_private_key: PathBuf,
-    encryption_public_key: PathBuf,
-    gateway_shared_key: PathBuf,
-    ack_key: PathBuf,
+    pub identity_private_key: PathBuf,
+    pub identity_public_key: PathBuf,
+    pub encryption_private_key: PathBuf,
+    pub encryption_public_key: PathBuf,
+    pub gateway_shared_key: PathBuf,
+    pub ack_key: PathBuf,
 }

 impl ClientKeyPathfinder {
@@ -22,8 +22,8 @@ impl ClientKeyPathfinder {
        ClientKeyPathfinder {
            identity_private_key: config_dir.join("private_identity.pem"),
            identity_public_key: config_dir.join("public_identity.pem"),
-            encryption_private_key: config_dir.join("public_encryption.pem"),
-            encryption_public_key: config_dir.join("private_encryption.pem"),
+            encryption_private_key: config_dir.join("private_encryption.pem"),
+            encryption_public_key: config_dir.join("public_encryption.pem"),
            gateway_shared_key: config_dir.join("gateway_shared.pem"),
            ack_key: config_dir.join("ack_key.pem"),
        }
@@ -40,6 +40,28 @@ impl ClientKeyPathfinder {
        }
    }

+    pub fn any_file_exists(&self) -> bool {
+        matches!(self.identity_public_key.try_exists(), Ok(true))
+            || matches!(self.identity_private_key.try_exists(), Ok(true))
+            || matches!(self.encryption_public_key.try_exists(), Ok(true))
+            || matches!(self.encryption_private_key.try_exists(), Ok(true))
+            || matches!(self.gateway_shared_key.try_exists(), Ok(true))
+            || matches!(self.ack_key.try_exists(), Ok(true))
+    }
+
+    pub fn any_file_exists_and_return(&self) -> Option<PathBuf> {
+        file_exists(&self.identity_public_key)
+            .or_else(|| file_exists(&self.identity_private_key))
+            .or_else(|| file_exists(&self.encryption_public_key))
+            .or_else(|| file_exists(&self.encryption_private_key))
+            .or_else(|| file_exists(&self.gateway_shared_key))
+            .or_else(|| file_exists(&self.ack_key))
+    }
+
+    pub fn gateway_key_file_exists(&self) -> bool {
+        matches!(self.gateway_shared_key.try_exists(), Ok(true))
+    }
+
    pub fn private_identity_key(&self) -> &Path {
        &self.identity_private_key
    }
@@ -64,3 +86,10 @@ impl ClientKeyPathfinder {
        &self.ack_key
    }
 }
+
+fn file_exists(path: &Path) -> Option<PathBuf> {
+    if matches!(path.try_exists(), Ok(true)) {
+        return Some(path.to_path_buf());
+    }
+    None
+}
@@ -55,6 +55,9 @@ pub enum ClientCoreError {
    #[error("The address of the gateway is unknown - did you run init?")]
    GatwayAddressUnknown,

+    #[error("failed to register receiver for reconstructed mixnet messages")]
+    FailedToRegisterReceiver,
+
    #[error("Unexpected exit")]
    UnexpectedExit,
 }
@@ -62,8 +65,10 @@ pub enum ClientCoreError {
 /// Set of messages that the client can send to listeners via the task manager
 #[derive(thiserror::Error, Debug)]
 pub enum ClientCoreStatusMessage {
+    // NOTE: The nym-connect frontend listens for these strings, so don't change them until we have a more robust mechanism in place
    #[error("The connected gateway is slow, or the connection to it is slow")]
    GatewayIsSlow,
+    // NOTE: The nym-connect frontend listens for these strings, so don't change them until we have a more robust mechanism in place
    #[error("The connected gateway is very slow, or the connection to it is very slow")]
    GatewayIsVerySlow,
 }
@@ -8,22 +8,26 @@ use crate::{
 };
 use config::NymConfig;
 use crypto::asymmetric::identity;
+#[cfg(target_arch = "wasm32")]
+use gateway_client::wasm_mockups::SigningNyxdClient;
 use gateway_client::GatewayClient;
 use gateway_requests::registration::handshake::SharedKeys;
-use rand::{rngs::OsRng, seq::SliceRandom, thread_rng};
+use rand::{seq::SliceRandom, thread_rng};
 use std::{sync::Arc, time::Duration};
 use tap::TapFallible;
 use topology::{filter::VersionFilterable, gateway};
 use url::Url;
+#[cfg(not(target_arch = "wasm32"))]
+use validator_client::nyxd::SigningNyxdClient;

 pub(super) async fn query_gateway_details(
    validator_servers: Vec<Url>,
-    chosen_gateway_id: Option<String>,
+    chosen_gateway_id: Option<identity::PublicKey>,
 ) -> Result<gateway::Node, ClientCoreError> {
    let nym_api = validator_servers
        .choose(&mut thread_rng())
        .ok_or(ClientCoreError::ListOfNymApisIsEmpty)?;
-    let validator_client = validator_client::client::ApiClient::new(nym_api.clone());
+    let validator_client = validator_client::client::NymApiClient::new(nym_api.clone());

    log::trace!("Fetching list of gateways from: {}", nym_api);
    let gateways = validator_client.get_cached_gateways().await?;
@@ -40,7 +44,7 @@ pub(super) async fn query_gateway_details(
    if let Some(gateway_id) = chosen_gateway_id {
        filtered_gateways
            .iter()
-            .find(|gateway| gateway.identity_key.to_base58_string() == gateway_id)
+            .find(|gateway| gateway.identity_key == gateway_id)
            .ok_or_else(|| ClientCoreError::NoGatewayWithId(gateway_id.to_string()))
            .cloned()
    } else {
@@ -51,15 +55,14 @@ pub(super) async fn query_gateway_details(
    }
 }

-async fn register_with_gateway(
+pub(super) async fn register_with_gateway(
    gateway: &gateway::Node,
    our_identity: Arc<identity::KeyPair>,
 ) -> Result<Arc<SharedKeys>, ClientCoreError> {
    let timeout = Duration::from_millis(1500);
-    let mut gateway_client = GatewayClient::new_init(
+    let mut gateway_client: GatewayClient<SigningNyxdClient> = GatewayClient::new_init(
        gateway.clients_address(),
        gateway.identity_key,
-        gateway.owner.clone(),
        our_identity.clone(),
        timeout,
    );
@@ -74,20 +77,13 @@ async fn register_with_gateway(
    Ok(shared_keys)
 }

-pub(super) async fn register_with_gateway_and_store_keys<T>(
-    gateway_details: gateway::Node,
+pub(super) fn store_keys<T>(
+    key_manager: &KeyManager,
    config: &Config<T>,
 ) -> Result<(), ClientCoreError>
 where
    T: NymConfig,
 {
-    let mut rng = OsRng;
-    let mut key_manager = KeyManager::new(&mut rng);
-
-    let shared_keys =
-        register_with_gateway(&gateway_details, key_manager.identity_keypair()).await?;
-    key_manager.insert_gateway_shared_key(shared_keys);
-
    let pathfinder = ClientKeyPathfinder::new_from_config(config);
    Ok(key_manager
        .store_keys(&pathfinder)
@@ -6,23 +6,26 @@
 use std::fmt::Display;

 use nymsphinx::addressing::{clients::Recipient, nodes::NodeIdentity};
+use rand::rngs::OsRng;
 use serde::Serialize;
 use tap::TapFallible;

 use config::NymConfig;
 use crypto::asymmetric::{encryption, identity};
+use url::Url;

+use crate::client::key_manager::KeyManager;
 use crate::{
    config::{
        persistence::key_pathfinder::ClientKeyPathfinder, ClientCoreConfigTrait, Config,
        GatewayEndpointConfig,
    },
    error::ClientCoreError,
-    init::helpers::{query_gateway_details, register_with_gateway_and_store_keys},
 };

 mod helpers;

+/// Struct describing the results of the client initialization procedure.
 #[derive(Debug, Serialize)]
 pub struct InitResults {
    version: String,
@@ -60,12 +63,44 @@ impl Display for InitResults {
    }
 }

-/// Convenience function for setting up the gateway for a client. Depending on the arguments given
-/// it will do the sensible thing.
-pub async fn setup_gateway<C, T>(
+/// Create a new set of client keys.
+pub fn new_client_keys() -> KeyManager {
+    let mut rng = OsRng;
+    KeyManager::new(&mut rng)
+}
+
+/// Authenticate and register with a gateway.
+/// Either pick one at random by querying the available gateways from the nym-api, or use the
+/// chosen one if it's among the available ones.
+/// The shared key is added to the supplied `KeyManager` and the endpoint details are returned.
+pub async fn register_with_gateway(
+    key_manager: &mut KeyManager,
+    nym_api_endpoints: Vec<Url>,
+    chosen_gateway_id: Option<identity::PublicKey>,
+) -> Result<GatewayEndpointConfig, ClientCoreError> {
+    // Get the gateway details of the gateway we will use
+    let gateway = helpers::query_gateway_details(nym_api_endpoints, chosen_gateway_id).await?;
+    log::debug!("Querying gateway gives: {}", gateway);
+
+    let our_identity = key_manager.identity_keypair();
+
+    // Establish connection, authenticate and generate keys for talking with the gateway
+    let shared_keys = helpers::register_with_gateway(&gateway, our_identity).await?;
+    key_manager.insert_gateway_shared_key(shared_keys);
+
+    Ok(gateway.into())
+}
+
+/// Convenience function for setting up the gateway for a client given a `Config`. Depending on the
+/// arguments given it will do the sensible thing. Either it will
+///
+/// a. Reuse existing gateway configuration from storage.
+/// b. Create a new gateway configuration but keep existing keys. This assumes that the caller
+///    knows what they are doing and that the keys match the requested gateway.
+/// c. Create a new gateway configuration with a newly registered gateway and keys.
+pub async fn setup_gateway_from_config<C, T>(
    register_gateway: bool,
-    // TODO: this should get refactored to instead take Option<identity::PublicKey>
-    user_chosen_gateway_id: Option<String>,
+    user_chosen_gateway_id: Option<identity::PublicKey>,
    config: &Config<T>,
 ) -> Result<GatewayEndpointConfig, ClientCoreError>
 where
@@ -73,63 +108,48 @@ where
    T: NymConfig,
 {
    let id = config.get_id();
-    if register_gateway {
-        register_with_gateway(user_chosen_gateway_id, config).await
-    } else if let Some(user_chosen_gateway_id) = user_chosen_gateway_id {
-        config_gateway_with_existing_keys(user_chosen_gateway_id, config).await
-    } else {
-        reuse_existing_gateway_config::<C>(&id)
+
+    // If we are not going to register gateway, and an explicitly chosed gateway is not passed in,
+    // load the existing configuration file
+    if !register_gateway && user_chosen_gateway_id.is_none() {
+        println!("Not registering gateway, will reuse existing config and keys");
+        return load_existing_gateway_config::<C>(&id);
    }
-}

-/// Get the gateway details by querying the validator-api. Either pick one at random or use
-/// the chosen one if it's among the available ones.
-/// Saves keys to disk, specified by the paths in `config`.
-pub async fn register_with_gateway<T>(
-    user_chosen_gateway_id: Option<String>,
-    config: &Config<T>,
-) -> Result<GatewayEndpointConfig, ClientCoreError>
-where
-    T: NymConfig,
-{
-    println!("Configuring gateway");
+    // Else, we preceed by querying the nym-api
    let gateway =
-        query_gateway_details(config.get_nym_api_endpoints(), user_chosen_gateway_id).await?;
+        helpers::query_gateway_details(config.get_nym_api_endpoints(), user_chosen_gateway_id)
+            .await?;
    log::debug!("Querying gateway gives: {}", gateway);

-    // Registering with gateway by setting up and writing shared keys to disk
-    log::trace!("Registering gateway");
-    register_with_gateway_and_store_keys(gateway.clone(), config).await?;
-    println!("Saved all generated keys");
+    // If we are not registering, just return this and assume the caller has the keys already and
+    // wants to keep the,
+    if !register_gateway && user_chosen_gateway_id.is_some() {
+        println!("Using gateway provided by user, keeping existing keys");
+        return Ok(gateway.into());
+    }

-    Ok(gateway.into())
-}
+    // Create new keys and derive our identity
+    let mut key_manager = new_client_keys();
+    let our_identity = key_manager.identity_keypair();

-/// Set the gateway using the usual procedue of querying the validator-api, but don't register or
-/// create any keys.
-/// This assumes that the user knows what they are doing, and that the existing keys are valid for
-/// the gateway being used
-pub async fn config_gateway_with_existing_keys<T>(
-    user_chosen_gateway_id: String,
-    config: &Config<T>,
-) -> Result<GatewayEndpointConfig, ClientCoreError>
-where
-    T: NymConfig,
-{
-    println!("Using gateway provided by user, keeping existing keys");
-    let gateway =
-        query_gateway_details(config.get_nym_api_endpoints(), Some(user_chosen_gateway_id)).await?;
-    log::debug!("Querying gateway gives: {}", gateway);
+    // Establish connection, authenticate and generate keys for talking with the gateway
+    println!("Registering with new gateway");
+    let shared_keys = helpers::register_with_gateway(&gateway, our_identity).await?;
+    key_manager.insert_gateway_shared_key(shared_keys);
+
+    // Write all keys to storage and just return the gateway endpoint config. It is assumed that we
+    // will load keys from storage when actually connecting.
+    helpers::store_keys(&key_manager, config)?;
    Ok(gateway.into())
 }

 /// Read and reuse the existing gateway configuration from a file that was generate earlier.
-pub fn reuse_existing_gateway_config<T>(id: &str) -> Result<GatewayEndpointConfig, ClientCoreError>
+pub fn load_existing_gateway_config<T>(id: &str) -> Result<GatewayEndpointConfig, ClientCoreError>
 where
    T: NymConfig + ClientCoreConfigTrait,
 {
-    println!("Not registering gateway, will reuse existing config and keys");
-    T::load_from_file(Some(id))
+    T::load_from_file(id)
        .map(|existing_config| existing_config.get_gateway_endpoint().clone())
        .map_err(|err| {
            log::error!(
@@ -143,6 +163,20 @@ where
        })
 }

+/// Get the full client address from the client keys and the gateway identity
+pub fn get_client_address(
+    key_manager: &KeyManager,
+    gateway_config: &GatewayEndpointConfig,
+) -> Recipient {
+    Recipient::new(
+        *key_manager.identity_keypair().public_key(),
+        *key_manager.encryption_keypair().public_key(),
+        // TODO: below only works under assumption that gateway address == gateway id
+        // (which currently is true)
+        NodeIdentity::from_base58_string(&gateway_config.gateway_id).unwrap(),
+    )
+}
+
 /// Get the client address by loading the keys from stored files.
 pub fn get_client_address_from_stored_keys<T>(
    config: &Config<T>,
@@ -192,9 +226,9 @@ where
 pub fn output_to_json<T: Serialize>(init_results: &T, output_file: &str) {
    match std::fs::File::create(output_file) {
        Ok(file) => match serde_json::to_writer_pretty(file, init_results) {
-            Ok(_) => println!("Saved: {}", output_file),
-            Err(err) => eprintln!("Could not save {}: {err}", output_file),
+            Ok(_) => println!("Saved: {output_file}"),
+            Err(err) => eprintln!("Could not save {output_file}: {err}"),
        },
-        Err(err) => eprintln!("Could not save {}: {err}", output_file),
+        Err(err) => eprintln!("Could not save {output_file}: {err}"),
    }
 }
@@ -7,13 +7,13 @@ edition = "2021"

 [dependencies]
 bip39 = "1.0.1"
-cfg-if = "0.1"
 clap = { version = "4.0", features = ["cargo", "derive"] }
+log = "0.4"
 rand = "0.7.3"
 serde = { version = "1.0", features = ["derive"] }
 thiserror = "1.0"
 url = "2.2"
-tokio = { version = "1.21.2", features = ["rt-multi-thread", "net", "signal", "macros"] } # async runtime
+tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal", "macros"] } # async runtime

 coconut-interface = { path = "../../common/coconut-interface" }
 config = { path = "../../common/config" }
@@ -21,9 +21,8 @@ completions = { path = "../../common/completions" }
 credentials = { path = "../../common/credentials" }
 credential-storage = { path = "../../common/credential-storage" }
 crypto = { path = "../../common/crypto", features = ["rand", "asymmetric", "symmetric", "aes", "hashing"] }
+logging = { path = "../../common/logging"}
 network-defaults = { path = "../../common/network-defaults" }
 pemstore = { path = "../../common/pemstore" }
-validator-client = { path = "../../common/client-libs/validator-client", features = ["nymd-client"] }
+validator-client = { path = "../../common/client-libs/validator-client", features = ["nyxd-client"] }

-[features]
-coconut = ["credentials/coconut"]
@@ -6,27 +6,27 @@ use bip39::Mnemonic;
 use network_defaults::{NymNetworkDetails, VOUCHER_INFO};
 use std::str::FromStr;
 use url::Url;
-use validator_client::nymd;
-use validator_client::nymd::traits::CoconutBandwidthSigningClient;
-use validator_client::nymd::{Coin, Fee, NymdClient, SigningNymdClient};
+use validator_client::nyxd;
+use validator_client::nyxd::traits::CoconutBandwidthSigningClient;
+use validator_client::nyxd::{Coin, Fee, NyxdClient, SigningNyxdClient};

 pub(crate) struct Client {
-    nymd_client: NymdClient<SigningNymdClient>,
+    nyxd_client: NyxdClient<SigningNyxdClient>,
    mix_denom_base: String,
 }

 impl Client {
-    pub fn new(nymd_url: &str, mnemonic: &str) -> Self {
-        let nymd_url = Url::from_str(nymd_url).unwrap();
+    pub fn new(nyxd_url: &str, mnemonic: &str) -> Self {
+        let nyxd_url = Url::from_str(nyxd_url).unwrap();
        let mnemonic = Mnemonic::from_str(mnemonic).unwrap();
        let network_details = NymNetworkDetails::new_from_env();
-        let config = nymd::Config::try_from_nym_network_details(&network_details)
+        let config = nyxd::Config::try_from_nym_network_details(&network_details)
            .expect("failed to construct valid validator client config with the provided network");
-        let nymd_client =
-            NymdClient::connect_with_mnemonic(config, nymd_url.as_ref(), mnemonic, None).unwrap();
+        let nyxd_client =
+            NyxdClient::connect_with_mnemonic(config, nyxd_url.as_ref(), mnemonic, None).unwrap();

        Client {
-            nymd_client,
+            nyxd_client,
            mix_denom_base: network_details.chain_details.mix_denom.base,
        }
    }
@@ -40,7 +40,7 @@ impl Client {
    ) -> Result<String> {
        let amount = Coin::new(amount as u128, self.mix_denom_base.clone());
        Ok(self
-            .nymd_client
+            .nyxd_client
            .deposit(
                amount,
                String::from(VOUCHER_INFO),
@@ -1,8 +1,9 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

-use clap::{Args, Subcommand};
+use clap::{ArgGroup, Args, Subcommand};
 use completions::ArgShell;
+use log::*;
 use rand::rngs::OsRng;
 use std::str::FromStr;

@@ -12,17 +13,20 @@ use credential_storage::PersistentStorage;
 use credentials::coconut::bandwidth::{BandwidthVoucher, TOTAL_ATTRIBUTES};
 use credentials::coconut::utils::obtain_aggregate_signature;
 use crypto::asymmetric::{encryption, identity};
-use network_defaults::{NymNetworkDetails, VOUCHER_INFO};
-use validator_client::nymd::tx::Hash;
-use validator_client::{CoconutApiClient, Config};
+use network_defaults::VOUCHER_INFO;
+use validator_client::nyxd::traits::DkgQueryClient;
+use validator_client::nyxd::tx::Hash;
+use validator_client::nyxd::CosmWasmClient;
+use validator_client::CoconutApiClient;

 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 {
-    /// Run the binary
+    /// Run the binary to obtain a credential
    Run(Run),

    /// Generate shell completions
@@ -33,30 +37,45 @@ pub(crate) enum Command {
 }

 #[derive(Args)]
+#[clap(group(
+ArgGroup::new("recov")
+.required(true)
+.args(&["amount", "recovery_mode"]),
+))]
 pub(crate) struct Run {
    /// Home directory of the client that is supposed to use the credential.
    #[clap(long)]
    pub(crate) client_home_directory: std::path::PathBuf,

-    /// The nymd URL that should be used
+    /// The nyxd URL that should be used
    #[clap(long)]
-    pub(crate) nymd_url: String,
+    pub(crate) nyxd_url: String,

    /// A mnemonic for the account that buys the credential
    #[clap(long)]
    pub(crate) mnemonic: String,

-    /// The amount of utokens the credential will hold
-    #[clap(long)]
+    /// The amount of utokens the credential will hold. If recovery mode is enabled, this value
+    /// is not needed
+    #[clap(long, default_value = "0")]
    pub(crate) amount: u64,
+
+    /// Path to a directory used to store recovery files for unconsumed deposits
+    #[clap(long)]
+    pub(crate) recovery_dir: std::path::PathBuf,
+
+    /// Recovery mode, when enabled, tries to recover any deposit data dumped in recovery_dir
+    #[clap(long)]
+    pub(crate) recovery_mode: bool,
 }

-pub(crate) async fn deposit(nymd_url: &str, mnemonic: &str, amount: u64) -> Result<State> {
+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(nymd_url, mnemonic);
+    let client = Client::new(nyxd_url, mnemonic);
    let tx_hash = client
        .deposit(
            amount,
@@ -66,48 +85,81 @@ pub(crate) async fn deposit(nymd_url: &str, mnemonic: &str, amount: u64) -> Resu
        )
        .await?;

-    let state = State {
-        amount,
-        tx_hash,
-        signing_keypair,
-        encryption_keypair,
-    };
+    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(state: &State, shared_storage: PersistentStorage) -> Result<()> {
-    let network_details = NymNetworkDetails::new_from_env();
-    let config = Config::try_from_nym_network_details(&network_details)?;
-    let client = validator_client::Client::new_query(config)?;
-    let coconut_api_clients = CoconutApiClient::all_coconut_api_clients(&client).await?;
-
-    let params = Parameters::new(TOTAL_ATTRIBUTES).unwrap();
-    let bandwidth_credential_attributes = BandwidthVoucher::new(
-        &params,
-        state.amount.to_string(),
-        VOUCHER_INFO.to_string(),
-        Hash::from_str(&state.tx_hash).map_err(|_| CredentialClientError::InvalidTxHash)?,
-        identity::PrivateKey::from_base58_string(&state.signing_keypair.private_key)?,
-        encryption::PrivateKey::from_base58_string(&state.encryption_keypair.private_key)?,
-    );
+pub(crate) async fn get_credential<C: Clone + CosmWasmClient + Send + Sync>(
+    state: &State,
+    client: validator_client::Client<C>,
+    shared_storage: PersistentStorage,
+) -> Result<()> {
+    let epoch_id = client.nyxd.get_current_epoch().await?.epoch_id;
+    let threshold = client
+        .nyxd
+        .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(
-        &params,
-        &bandwidth_credential_attributes,
+        &state.params,
+        &state.voucher,
        &coconut_api_clients,
+        threshold,
    )
    .await?;
-    println!("Signature: {:?}", signature.to_bs58());
+    info!("Signature: {:?}", signature.to_bs58());
    shared_storage
        .insert_coconut_credential(
-            state.amount.to_string(),
+            state.voucher.get_voucher_value(),
            VOUCHER_INFO.to_string(),
-            bandwidth_credential_attributes.get_private_attributes()[0].to_bs58(),
-            bandwidth_credential_attributes.get_private_attributes()[1].to_bs58(),
+            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: Clone + CosmWasmClient + Send + Sync>(
+    client: validator_client::Client<C>,
+    recovery_storage: &RecoveryStorage,
+    shared_storage: PersistentStorage,
+) -> Result<()> {
+    for voucher in recovery_storage.unconsumed_vouchers()? {
+        let state = State {
+            voucher,
+            params: Parameters::new(TOTAL_ATTRIBUTES).unwrap(),
+        };
+        if let Err(e) = get_credential(&state, client.clone(), shared_storage.clone()).await {
+            error!(
+                "Could not recover deposit {} due to {:?}, try again later",
+                state.voucher.tx_hash(),
+                e
+            )
+        } else {
+            info!(
+                "Converted deposit {} to a credential, removing recovery data for it",
+                state.voucher.tx_hash()
+            );
+            if let Err(e) = recovery_storage.remove_voucher(state.voucher.tx_hash().to_string()) {
+                warn!("Could not remove recovery data - {:?}", e);
+            }
+        }
+    }
+
+    Ok(())
+}
@@ -1,21 +1,25 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

+use std::time::SystemTimeError;
 use thiserror::Error;

 use credential_storage::error::StorageError;
 use credentials::error::Error as CredentialError;
 use crypto::asymmetric::encryption::KeyRecoveryError;
 use crypto::asymmetric::identity::Ed25519RecoveryError;
-use validator_client::nymd::error::NymdError;
+use validator_client::nyxd::error::NyxdError;
 use validator_client::ValidatorClientError;

 pub type Result<T> = std::result::Result<T, CredentialClientError>;

 #[derive(Error, Debug)]
 pub enum CredentialClientError {
-    #[error("Nymd error: {0}")]
-    Nymd(#[from] NymdError),
+    #[error("IO error: {0}")]
+    IOError(#[from] std::io::Error),
+
+    #[error("Nyxd error: {0}")]
+    Nyxd(#[from] NyxdError),

    #[error("Validator client error: {0}")]
    ValidatorClientError(#[from] ValidatorClientError),
@@ -34,4 +38,10 @@ pub enum CredentialClientError {

    #[error("Could not use shared storage")]
    SharedStorageError(#[from] StorageError),
+
+    #[error("Could not get system time")]
+    SysTimeError(#[from] SystemTimeError),
+
+    #[error("Threshold not set yet")]
+    NoThreshold,
 }
@@ -1,56 +1,109 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

-cfg_if::cfg_if! {
-    if #[cfg(feature = "coconut")] {
+mod client;
+mod commands;
+mod error;
+mod recovery_storage;
+mod state;

-        mod client;
-        mod commands;
-        mod error;
-        mod state;
+use commands::*;
+use completions::fig_generate;
+use config::{DATA_DIR, DB_FILE_NAME};
+use error::Result;
+use log::*;
+use network_defaults::{setup_env, NymNetworkDetails};
+use std::process::exit;
+use std::time::{Duration, SystemTime};

-        use error::Result;
-        use network_defaults::setup_env;
-        use completions::fig_generate;
-        use commands::*;
-        use config::{DATA_DIR, DB_FILE_NAME};
+use clap::{CommandFactory, Parser};
+use logging::setup_logging;
+use validator_client::nyxd::traits::DkgQueryClient;
+use validator_client::nyxd::CosmWasmClient;
+use validator_client::Config;

-        use clap::{CommandFactory, Parser};
+const SAFETY_BUFFER_SECS: u64 = 60; // 1 minute

-        #[derive(Parser)]
-        #[clap(author = "Nymtech", version, about)]
-        struct Cli {
-            /// Path pointing to an env file that configures the client.
-            #[clap(short, long)]
-            pub(crate) config_env_file: Option<std::path::PathBuf>,
+#[derive(Parser)]
+#[clap(author = "Nymtech", version, about)]
+struct Cli {
+    /// Path pointing to an env file that configures the client.
+    #[clap(short, long)]
+    pub(crate) config_env_file: Option<std::path::PathBuf>,

-            #[clap(subcommand)]
-            pub(crate) command: Command,
-        }
+    #[clap(subcommand)]
+    pub(crate) command: Command,
+}

-        #[tokio::main]
-        async fn main() -> Result<()> {
-            let args = Cli::parse();
-            setup_env(args.config_env_file.as_ref());
-            let bin_name = "nym-credential-client";
-
-            match args.command {
-                Command::Run(r) => {
-                    let db_path = r.client_home_directory.join(DATA_DIR).join(DB_FILE_NAME);
-                    let shared_storage = credential_storage::initialise_storage(db_path).await;
-
-                    let state = deposit(&r.nymd_url, &r.mnemonic, r.amount).await?;
-                    get_credential(&state, shared_storage).await?;
-                }
-                Command::Completions(c) => c.generate(&mut crate::Cli::command(), bin_name),
-                Command::GenerateFigSpec => fig_generate(&mut crate::Cli::command(), bin_name)
+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?;
+        let current_timestamp_secs = SystemTime::now()
+            .duration_since(SystemTime::UNIX_EPOCH)?
+            .as_secs();
+        if epoch.state.is_final() {
+            if current_timestamp_secs + SAFETY_BUFFER_SECS >= epoch.finish_timestamp.seconds() {
+                info!("In the next {} minute(s), a transition will take place in the coconut system. Deposits should be halted in this time for safety reasons.", SAFETY_BUFFER_SECS / 60);
+                exit(0);
            }

-            Ok(())
-        }
-    } else {
-        fn main() {
-            println!("Crate only designed for coconut feature");
+            break;
+        } else {
+            // Use 20 additional seconds to avoid the exact moment of going into the final epoch state
+            let secs_until_final = epoch.final_timestamp_secs() + 20 - current_timestamp_secs;
+            info!("Approximately {} seconds until coconut is available. Sleeping until then. You can safely kill the process at any moment.", secs_until_final);
+            std::thread::sleep(Duration::from_secs(secs_until_final));
        }
    }
+
+    Ok(())
+}
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let args = Cli::parse();
+    setup_logging();
+    setup_env(args.config_env_file.as_ref());
+    let bin_name = "nym-credential-client";
+
+    match args.command {
+        Command::Run(r) => {
+            let db_path = r.client_home_directory.join(DATA_DIR).join(DB_FILE_NAME);
+            let shared_storage = 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)?;
+            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 = deposit(&r.nyxd_url, &r.mnemonic, r.amount).await?;
+                if get_credential(&state, client, shared_storage)
+                    .await
+                    .is_err()
+                {
+                    warn!("Failed to obtain credential. Dumping recovery data.",);
+                    match recovery_storage.insert_voucher(&state.voucher) {
+                        Ok(file_path) => {
+                            warn!("Dumped recovery data to {:?}. Try using recovery mode to convert it to a credential", file_path);
+                        }
+                        Err(e) => {
+                            error!("Could not dump recovery data to file system due to {:?}, the deposit will be lost!", e)
+                        }
+                    }
+                }
+            } else {
+                recover_credentials(client, &recovery_storage, shared_storage).await?;
+            }
+        }
+        Command::Completions(c) => c.generate(&mut crate::Cli::command(), bin_name),
+        Command::GenerateFigSpec => fig_generate(&mut crate::Cli::command(), bin_name),
+    }
+
+    Ok(())
 }
@@ -0,0 +1,56 @@
+// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use credentials::coconut::bandwidth::BandwidthVoucher;
+use std::fs::{create_dir_all, read_dir, File};
+use std::io::{Read, Write};
+use std::path::PathBuf;
+
+pub struct RecoveryStorage {
+    recovery_dir: PathBuf,
+}
+
+impl RecoveryStorage {
+    pub fn new(recovery_dir: PathBuf) -> std::io::Result<Self> {
+        create_dir_all(&recovery_dir)?;
+        Ok(Self { recovery_dir })
+    }
+
+    pub fn unconsumed_vouchers(&self) -> std::io::Result<impl Iterator<Item = BandwidthVoucher>> {
+        Ok(read_dir(&self.recovery_dir)?
+            .filter_map(|entry| entry.ok())
+            .filter_map(|entry| {
+                let path = entry.path();
+                if path.is_file() {
+                    Some(path)
+                } else {
+                    None
+                }
+            })
+            .filter_map(|path| File::open(path).ok())
+            .filter_map(|mut f| {
+                let mut buff = Vec::new();
+                if f.read_to_end(&mut buff).is_ok() {
+                    Some(buff)
+                } else {
+                    None
+                }
+            })
+            .filter_map(|buff| BandwidthVoucher::try_from_bytes(&buff).ok()))
+    }
+
+    pub fn insert_voucher(&self, voucher: &BandwidthVoucher) -> std::io::Result<PathBuf> {
+        let file_name = voucher.tx_hash().to_string();
+        let file_path = self.recovery_dir.join(file_name);
+        let mut file = File::create(&file_path)?;
+        let buff = voucher.to_bytes();
+        file.write_all(&buff)?;
+
+        Ok(file_path)
+    }
+
+    pub fn remove_voucher(&self, file_name: String) -> std::io::Result<()> {
+        let file_path = self.recovery_dir.join(file_name);
+        std::fs::remove_file(file_path)
+    }
+}
@@ -1,11 +1,11 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

-use serde::{Deserialize, Serialize};
+use coconut_interface::Parameters;
+use credentials::coconut::bandwidth::BandwidthVoucher;

 use crypto::asymmetric::{encryption, identity};

-#[derive(Clone, Debug, Deserialize, Serialize)]
 pub(crate) struct KeyPair {
    pub public_key: String,
    pub private_key: String,
@@ -29,10 +29,7 @@ impl From<encryption::KeyPair> for KeyPair {
    }
 }

-#[derive(Clone, Debug, Deserialize, Serialize)]
 pub(crate) struct State {
-    pub amount: u64,
-    pub tx_hash: String,
-    pub signing_keypair: KeyPair,
-    pub encryption_keypair: KeyPair,
+    pub voucher: BandwidthVoucher,
+    pub params: Parameters,
 }
@@ -1,6 +1,6 @@
 [package]
 name = "nym-client"
-version = "1.1.4"
+version = "1.1.8"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>", "Jędrzej Stuczyński <andrew@nymtech.net>"]
 description = "Implementation of the Nym Client"
 edition = "2021"
@@ -23,25 +23,25 @@ url = "2.2"
 clap = { version = "4.0", features = ["cargo", "derive"] }
 dirs = "4.0"
 lazy_static = "1.4.0"
-log = "0.4" # self explanatory
+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 = { 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.21.2", features = ["rt-multi-thread", "net", "signal"] } # async runtime
+tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal"] } # async runtime
 tokio-tungstenite = "0.14" # websocket

 ## internal
 build-information = { path = "../../common/build-information" }
 client-core = { path = "../client-core", features = ["fs-surb-storage"] }
 client-connections = { path = "../../common/client-connections" }
-coconut-interface = { path = "../../common/coconut-interface", optional = true }
+coconut-interface = { path = "../../common/coconut-interface" }
 config = { path = "../../common/config" }
 completions = { path = "../../common/completions" }
 credential-storage = { path = "../../common/credential-storage" }
-credentials = { path = "../../common/credentials", optional = true }
+credentials = { path = "../../common/credentials" }
 crypto = { path = "../../common/crypto" }
 logging = { path = "../../common/logging"}
 gateway-client = { path = "../../common/client-libs/gateway-client" }
@@ -51,12 +51,9 @@ nymsphinx = { path = "../../common/nymsphinx" }
 pemstore = { path = "../../common/pemstore" }
 task = { path = "../../common/task" }
 topology = { path = "../../common/topology" }
-validator-client = { path = "../../common/client-libs/validator-client", features = ["nymd-client"] }
+validator-client = { path = "../../common/client-libs/validator-client", features = ["nyxd-client"] }
 version-checker = { path = "../../common/version-checker" }
 websocket-requests = { path = "websocket-requests" }

-[features]
-coconut = ["coconut-interface", "credentials", "credentials/coconut", "gateway-requests/coconut", "gateway-client/coconut", "client-core/coconut"]
-
 [dev-dependencies]
 serde_json = "1.0" # for the "textsend" example
@@ -85,7 +85,7 @@ async fn send_file_without_reply() {
    let (mut ws_stream, _) = connect_async(uri).await.unwrap();

    let recipient = get_self_address(&mut ws_stream).await;
-    println!("our full address is: {}", recipient);
+    println!("our full address is: {recipient}");

    let read_data = std::fs::read("examples/dummy_file").unwrap();

@@ -36,7 +36,7 @@ async fn send_text_with_reply() {
    let (mut ws_stream, _) = connect_async(uri).await.unwrap();

    let recipient = get_self_address(&mut ws_stream).await;
-    println!("our full address is: {}", recipient);
+    println!("our full address is: {recipient}");

    let send_request = json!({
        "type" : "send",
@@ -45,10 +45,7 @@ async fn send_text_with_reply() {
        "withReplySurb": true,
    });

-    println!(
-        "sending {:?} (*with* reply SURB) over the mix network...",
-        message
-    );
+    println!("sending {message:?} (*with* reply SURB) over the mix network...");
    let response =
        send_message_and_get_json_response(&mut ws_stream, send_request.to_string()).await;

@@ -59,10 +56,7 @@ async fn send_text_with_reply() {
        "replySurb": response["replySurb"]
    });

-    println!(
-        "sending {:?} (using reply SURB!) over the mix network...",
-        reply_message
-    );
+    println!("sending {reply_message:?} (using reply SURB!) over the mix network...");

    let response =
        send_message_and_get_json_response(&mut ws_stream, reply_request.to_string()).await;
@@ -76,7 +70,7 @@ async fn send_text_without_reply() {
    let (mut ws_stream, _) = connect_async(uri).await.unwrap();

    let recipient = get_self_address(&mut ws_stream).await;
-    println!("our full address is: {}", recipient);
+    println!("our full address is: {recipient}");

    let send_request = json!({
        "type" : "send",
@@ -85,10 +79,7 @@ async fn send_text_without_reply() {
        "withReplySurb": false,
    });

-    println!(
-        "sending {:?} (*without* reply SURB) over the mix network...",
-        message
-    );
+    println!("sending {message:?} (*without* reply SURB) over the mix network...");
    let response =
        send_message_and_get_json_response(&mut ws_stream, send_request.to_string()).await;

@@ -2,12 +2,18 @@
 // SPDX-License-Identifier: Apache-2.0

 use crate::client::config::template::config_template;
-pub use client_core::config::MISSING_VALUE;
-use client_core::config::{ClientCoreConfigTrait, Config as BaseConfig, DebugConfig};
+use client_core::config::ClientCoreConfigTrait;
 use config::defaults::DEFAULT_WEBSOCKET_LISTENING_PORT;
-use config::NymConfig;
+use config::{NymConfig, OptionalSet};
 use serde::{Deserialize, Serialize};
+use std::fmt::Debug;
+use std::net::{IpAddr, Ipv4Addr};
 use std::path::PathBuf;
+use std::str::FromStr;
+
+pub use client_core::config::Config as BaseConfig;
+pub use client_core::config::MISSING_VALUE;
+pub use client_core::config::{DebugConfig, GatewayEndpointConfig};

 mod template;

@@ -92,6 +98,20 @@ impl Config {
        self
    }

+    pub fn with_disabled_socket(mut self, disabled: bool) -> Self {
+        if disabled {
+            self.socket.socket_type = SocketType::None;
+        } else {
+            self.socket.socket_type = SocketType::WebSocket;
+        }
+        self
+    }
+
+    pub fn with_host(mut self, host: IpAddr) -> Self {
+        self.socket.host = host;
+        self
+    }
+
    pub fn with_port(mut self, port: u16) -> Self {
        self.socket.listening_port = port;
        self
@@ -118,15 +138,64 @@ impl Config {
        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(BaseConfig<Self>, T) -> BaseConfig<Self>,
+    {
+        self.base = f(self.base, val);
+        self
+    }
+
+    // helper methods to use `OptionalSet` trait. Those are defined due to very... ehm. 'specific' structure of this config
+    // (plz, lets refactor it)
+    pub fn with_optional_ext<F, T>(mut self, f: F, val: Option<T>) -> Self
+    where
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
+    {
+        self.base = self.base.with_optional(f, val);
+        self
+    }
+
+    pub fn with_optional_env_ext<F, T>(mut self, f: F, val: Option<T>, env_var: &str) -> Self
+    where
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
+        T: FromStr,
+        <T as FromStr>::Err: Debug,
+    {
+        self.base = self.base.with_optional_env(f, val, env_var);
+        self
+    }
+
+    pub fn with_optional_custom_env_ext<F, T, G>(
+        mut self,
+        f: F,
+        val: Option<T>,
+        env_var: &str,
+        parser: G,
+    ) -> Self
+    where
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
+        G: Fn(&str) -> T,
+    {
+        self.base = self.base.with_optional_custom_env(f, val, env_var, parser);
+        self
+    }
 }

 #[derive(Debug, Deserialize, PartialEq, Eq, Serialize)]
-#[serde(deny_unknown_fields)]
+#[serde(default, deny_unknown_fields)]
 pub struct Socket {
    socket_type: SocketType,
+    host: IpAddr,
    listening_port: u16,
 }

@@ -134,6 +203,7 @@ impl Default for Socket {
    fn default() -> Self {
        Socket {
            socket_type: SocketType::WebSocket,
+            host: IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)),
            listening_port: DEFAULT_WEBSOCKET_LISTENING_PORT,
        }
    }
@@ -23,9 +23,9 @@ id = '{{ client.id }}'
 # to claim bandwidth without presenting bandwidth credentials.
 disabled_credentials_mode = {{ client.disabled_credentials_mode }}

-# Addresses to nymd validators via which the client can communicate with the chain.
-validator_urls = [
-    {{#each client.validator_urls }}
+# Addresses to nyxd validators via which the client can communicate with the chain.
+nyxd_urls = [
+    {{#each client.nyxd_urls }}
        '{{this}}',
    {{/each}}
 ]
@@ -93,6 +93,9 @@ socket_type = '{{ socket.socket_type }}'
 # will be listening for incoming requests
 listening_port = {{ socket.listening_port }}

+# if applicable (for the case of 'WebSocket'), the ip address on which the client
+# will be listening for incoming requests
+host = '{{ socket.host }}'

 ##### logging configuration options #####

@@ -8,22 +8,25 @@ use crate::error::ClientError;
 use crate::websocket;
 use client_connections::TransmissionLane;
 use client_core::client::base_client::{
-    non_wasm_helpers, BaseClientBuilder, ClientInput, ClientOutput,
+    non_wasm_helpers, BaseClientBuilder, ClientInput, ClientOutput, ClientState,
 };
 use client_core::client::inbound_messages::InputMessage;
-use client_core::client::key_manager::KeyManager;
-use client_core::client::received_buffer::{ReceivedBufferMessage, ReconstructedMessagesReceiver};
-use client_core::client::replies::reply_controller::requests::ReplyControllerSender;
+use client_core::client::received_buffer::{
+    ReceivedBufferMessage, ReceivedBufferRequestSender, ReconstructedMessagesReceiver,
+};
 use client_core::config::persistence::key_pathfinder::ClientKeyPathfinder;
 use futures::channel::mpsc;
 use gateway_client::bandwidth::BandwidthController;
 use log::*;
-use nymsphinx::addressing::clients::Recipient;
 use nymsphinx::anonymous_replies::requests::AnonymousSenderTag;
-use nymsphinx::receiver::ReconstructedMessage;
 use task::TaskManager;
+use tokio::sync::watch::error::SendError;
+use validator_client::nyxd::QueryNyxdClient;

-pub(crate) mod config;
+pub use client_core::client::key_manager::KeyManager;
+pub use nymsphinx::addressing::clients::Recipient;
+pub use nymsphinx::receiver::ReconstructedMessage;
+pub mod config;

 pub struct SocketClient {
    /// Client configuration options, including, among other things, packet sending rates,
@@ -45,50 +48,43 @@ impl SocketClient {
        }
    }

-    async fn create_bandwidth_controller(config: &Config) -> BandwidthController {
-        #[cfg(feature = "coconut")]
-        let bandwidth_controller = {
-            let details = 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 nymd_url = config
-                .get_base()
-                .get_validator_endpoints()
-                .pop()
-                .expect("No nymd 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(nymd_url, api_url);
-            let client = validator_client::Client::new_query(client_config)
-                .expect("Could not construct query client");
-            let coconut_api_clients =
-                validator_client::CoconutApiClient::all_coconut_api_clients(&client)
-                    .await
-                    .expect("Could not query api clients");
-            BandwidthController::new(
-                credential_storage::initialise_storage(config.get_base().get_database_path()).await,
-                coconut_api_clients,
-            )
-        };
-        #[cfg(not(feature = "coconut"))]
-        let bandwidth_controller = BandwidthController::new(
+    pub fn new_with_keys(config: Config, key_manager: KeyManager) -> Self {
+        SocketClient {
+            config,
+            key_manager,
+        }
+    }
+
+    async fn create_bandwidth_controller(config: &Config) -> BandwidthController<QueryNyxdClient> {
+        let details = 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(
            credential_storage::initialise_storage(config.get_base().get_database_path()).await,
+            client,
        )
-        .expect("Could not create bandwidth controller");
-        bandwidth_controller
    }

    fn start_websocket_listener(
        config: &Config,
        client_input: ClientInput,
        client_output: ClientOutput,
+        client_state: ClientState,
        self_address: &Recipient,
-        reply_controller_sender: ReplyControllerSender,
        shutdown: task::TaskClient,
    ) {
        info!("Starting websocket listener...");
@@ -99,10 +95,14 @@ impl SocketClient {
        } = client_input;

        let ClientOutput {
-            shared_lane_queue_lengths,
            received_buffer_request_sender,
        } = client_output;

+        let ClientState {
+            shared_lane_queue_lengths,
+            reply_controller_sender,
+        } = client_state;
+
        let websocket_handler = websocket::HandlerBuilder::new(
            input_sender,
            connection_command_sender,
@@ -112,21 +112,15 @@ impl SocketClient {
            reply_controller_sender,
        );

-        websocket::Listener::new(config.get_listening_port()).start(websocket_handler, shutdown);
+        websocket::Listener::new(config.get_listening_ip(), config.get_listening_port())
+            .start(websocket_handler, shutdown);
    }

    /// blocking version of `start_socket` method. Will run forever (or until SIGINT is sent)
    pub async fn run_socket_forever(self) -> Result<(), Box<dyn Error + Send + Sync>> {
-        let mut shutdown = self.start_socket().await?;
-
-        let res = task::wait_for_signal_and_error(&mut shutdown).await;
-
-        log::info!("Sending shutdown");
-        shutdown.signal_shutdown().ok();
-
-        log::info!("Waiting for tasks to finish... (Press ctrl-c to force)");
-        shutdown.wait_for_shutdown().await;
+        let shutdown = self.start_socket().await?;

+        let res = shutdown.catch_interrupt().await;
        log::info!("Stopping nym-client");
        res
    }
@@ -136,12 +130,19 @@ impl SocketClient {
            return Err(ClientError::InvalidSocketMode);
        }

+        // 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_builder = BaseClientBuilder::new_from_base_config(
            self.config.get_base(),
            self.key_manager,
-            Some(Self::create_bandwidth_controller(&self.config).await),
+            bandwidth_controller,
            non_wasm_helpers::setup_fs_reply_surb_backend(
-                self.config.get_base().get_reply_surb_database_path(),
+                Some(self.config.get_base().get_reply_surb_database_path()),
                self.config.get_debug_settings(),
            )
            .await?,
@@ -151,13 +152,14 @@ impl SocketClient {
        let mut started_client = base_builder.start_base().await?;
        let client_input = started_client.client_input.register_producer();
        let client_output = started_client.client_output.register_consumer();
+        let client_state = started_client.client_state;

        Self::start_websocket_listener(
            &self.config,
            client_input,
            client_output,
+            client_state,
            &self_address,
-            started_client.reply_controller_sender,
            started_client.task_manager.subscribe(),
        );

@@ -172,17 +174,26 @@ impl SocketClient {
            return Err(ClientError::InvalidSocketMode);
        }

+        // 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,
-            Some(Self::create_bandwidth_controller(&self.config).await),
+            bandwidth_controller,
            non_wasm_helpers::setup_fs_reply_surb_backend(
-                self.config.get_base().get_reply_surb_database_path(),
+                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();
@@ -200,21 +211,38 @@ impl SocketClient {

        Ok(DirectClient {
            client_input,
+            _received_buffer_request_sender: client_output.received_buffer_request_sender,
            reconstructed_receiver,
-            _shutdown_notifier: started_client.task_manager,
+            address,
+            shutdown_notifier: started_client.task_manager,
        })
    }
 }

 pub struct DirectClient {
    client_input: ClientInput,
+    // make sure to not drop the channel
+    _received_buffer_request_sender: ReceivedBufferRequestSender,
    reconstructed_receiver: ReconstructedMessagesReceiver,
+    address: Recipient,

    // we need to keep reference to this guy otherwise things will start dropping
-    _shutdown_notifier: TaskManager,
+    shutdown_notifier: TaskManager,
 }

 impl DirectClient {
+    pub fn address(&self) -> &Recipient {
+        &self.address
+    }
+
+    pub fn signal_shutdown(&self) -> Result<(), SendError<()>> {
+        self.shutdown_notifier.signal_shutdown()
+    }
+
+    pub async fn wait_for_shutdown(&mut self) {
+        self.shutdown_notifier.wait_for_shutdown().await
+    }
+
    /// EXPERIMENTAL DIRECT RUST API
    /// It's untested and there are absolutely no guarantees about it (but seems to have worked
    /// well enough in local tests)
@@ -12,6 +12,7 @@ use crypto::asymmetric::identity;
 use nymsphinx::addressing::clients::Recipient;
 use serde::Serialize;
 use std::fmt::Display;
+use std::net::IpAddr;
 use tap::TapFallible;

 #[derive(Args, Clone)]
@@ -29,10 +30,9 @@ pub(crate) struct Init {
    #[clap(long)]
    force_register_gateway: bool,

-    /// Comma separated list of rest endpoints of the nymd validators
-    #[cfg(feature = "coconut")]
-    #[clap(long, value_delimiter = ',')]
-    nymd_validators: Option<Vec<url::Url>>,
+    /// Comma separated list of rest endpoints of the nyxd validators
+    #[clap(long, alias = "nymd_validators", value_delimiter = ',', hide = true)]
+    nyxd_urls: Option<Vec<url::Url>>,

    /// Comma separated list of rest endpoints of the API validators
    #[clap(long, alias = "api_validators", value_delimiter = ',')]
@@ -41,12 +41,16 @@ pub(crate) struct Init {

    /// Whether to not start the websocket
    #[clap(long)]
-    disable_socket: bool,
+    disable_socket: Option<bool>,

    /// Port for the socket (if applicable) to listen on in all subsequent runs
    #[clap(short, long)]
    port: Option<u16>,

+    /// Ip for the socket (if applicable) to listen for requests.
+    #[clap(long)]
+    host: Option<IpAddr>,
+
    /// Mostly debug-related option to increase default traffic rate so that you would not need to
    /// modify config post init
    #[clap(long, hide = true)]
@@ -58,9 +62,8 @@ pub(crate) struct Init {

    /// Set this client to work in a enabled credentials mode that would attempt to use gateway
    /// with bandwidth credential requirement.
-    #[cfg(feature = "coconut")]
-    #[clap(long)]
-    enabled_credentials_mode: bool,
+    #[clap(long, hide = true)]
+    enabled_credentials_mode: Option<bool>,

    /// Save a summary of the initialization to a json file
    #[clap(long)]
@@ -73,12 +76,11 @@ impl From<Init> for OverrideConfig {
            nym_apis: init_config.nym_apis,
            disable_socket: init_config.disable_socket,
            port: init_config.port,
+            host: init_config.host,
            fastmode: init_config.fastmode,
            no_cover: init_config.no_cover,

-            #[cfg(feature = "coconut")]
-            nymd_validators: init_config.nymd_validators,
-            #[cfg(feature = "coconut")]
+            nyxd_urls: init_config.nyxd_urls,
            enabled_credentials_mode: init_config.enabled_credentials_mode,
        }
    }
@@ -112,18 +114,17 @@ pub(crate) async fn execute(args: &Init) -> Result<(), ClientError> {

    let id = &args.id;

-    let already_init = Config::default_config_file_path(Some(id)).exists();
+    let already_init = Config::default_config_file_path(id).exists();
    if already_init {
-        println!(
-            "Client \"{}\" was already initialised before! \
-            Config information will be overwritten (but keys will be kept)!",
-            id
-        );
+        println!("Client \"{id}\" was already initialised before");
    }

    // Usually you only register with the gateway on the first init, however you can force
    // re-registering if wanted.
    let user_wants_force_register = args.force_register_gateway;
+    if user_wants_force_register {
+        println!("Instructed to force registering gateway. This might overwrite keys!");
+    }

    // If the client was already initialized, don't generate new keys and don't re-register with
    // the gateway (because this would create a new shared key).
@@ -138,15 +139,15 @@ pub(crate) async fn execute(args: &Init) -> Result<(), ClientError> {

    // Setup gateway by either registering a new one, or creating a new config from the selected
    // one but with keys kept, or reusing the gateway configuration.
-    let gateway = client_core::init::setup_gateway::<Config, _>(
+    let gateway = client_core::init::setup_gateway_from_config::<Config, _>(
        register_gateway,
-        user_chosen_gateway_id.map(|id| id.to_base58_string()),
+        user_chosen_gateway_id,
        config.get_base(),
    )
    .await
    .tap_err(|err| eprintln!("Failed to setup gateway\nError: {err}"))?;

-    config.get_base_mut().with_gateway_endpoint(gateway);
+    config.get_base_mut().set_gateway_endpoint(gateway);

    config.save_to_file(None).tap_err(|_| {
        log::error!("Failed to save the config file");
@@ -169,7 +170,7 @@ pub(crate) async fn execute(args: &Init) -> Result<(), ClientError> {

 fn print_saved_config(config: &Config) {
    let config_save_location = config.get_config_file_save_location();
-    println!("Saved configuration file to {:?}", config_save_location);
+    println!("Saved configuration file to {config_save_location:?}");
    println!("Using gateway: {}", config.get_base().get_gateway_id());
    log::debug!("Gateway id: {}", config.get_base().get_gateway_id());
    log::debug!("Gateway owner: {}", config.get_base().get_gateway_owner());
@@ -1,13 +1,15 @@
-// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

-use crate::client::config::{Config, SocketType};
+use crate::client::config::{BaseConfig, Config};
 use build_information::BinaryBuildInformation;
 use clap::CommandFactory;
 use clap::{Parser, Subcommand};
 use completions::{fig_generate, ArgShell};
+use config::OptionalSet;
 use lazy_static::lazy_static;
 use std::error::Error;
+use std::net::IpAddr;

 pub(crate) mod init;
 pub(crate) mod run;
@@ -53,15 +55,13 @@ pub(crate) enum Commands {
 // Configuration that can be overridden.
 pub(crate) struct OverrideConfig {
    nym_apis: Option<Vec<url::Url>>,
-    disable_socket: bool,
+    disable_socket: Option<bool>,
    port: Option<u16>,
+    host: Option<IpAddr>,
    fastmode: bool,
    no_cover: bool,
-
-    #[cfg(feature = "coconut")]
-    nymd_validators: Option<Vec<url::Url>>,
-    #[cfg(feature = "coconut")]
-    enabled_credentials_mode: bool,
+    nyxd_urls: Option<Vec<url::Url>>,
+    enabled_credentials_mode: Option<bool>,
 }

 pub(crate) async fn execute(args: &Cli) -> Result<(), Box<dyn Error + Send + Sync>> {
@@ -77,50 +77,29 @@ pub(crate) async fn execute(args: &Cli) -> Result<(), Box<dyn Error + Send + Syn
    Ok(())
 }

-pub(crate) fn override_config(mut config: Config, args: OverrideConfig) -> Config {
-    if let Some(nym_apis) = args.nym_apis {
-        config.get_base_mut().set_custom_nym_apis(nym_apis);
-    } else if std::env::var(network_defaults::var_names::CONFIGURED).is_ok() {
-        let raw_validators = std::env::var(network_defaults::var_names::API_VALIDATOR)
-            .expect("api validator not set");
-        config
-            .get_base_mut()
-            .set_custom_nym_apis(config::parse_urls(&raw_validators));
-    }
-
-    if args.disable_socket {
-        config = config.with_socket(SocketType::None);
-    }
-
-    if let Some(port) = args.port {
-        config = config.with_port(port);
-    }
-
-    #[cfg(feature = "coconut")]
-    {
-        if let Some(nymd_validators) = args.nymd_validators {
-            config.get_base_mut().set_custom_validators(nymd_validators);
-        } else if std::env::var(network_defaults::var_names::CONFIGURED).is_ok() {
-            let raw_validators = std::env::var(network_defaults::var_names::NYMD_VALIDATOR)
-                .expect("nymd validator not set");
-            config
-                .get_base_mut()
-                .set_custom_validators(config::parse_urls(&raw_validators));
-        }
-        if args.enabled_credentials_mode {
-            config.get_base_mut().with_disabled_credentials(false)
-        }
-    }
-
-    if args.fastmode {
-        config.get_base_mut().set_high_default_traffic_volume();
-    }
-
-    if args.no_cover {
-        config.get_base_mut().set_no_cover_traffic();
-    }
-
+pub(crate) fn override_config(config: Config, args: OverrideConfig) -> Config {
    config
+        .with_optional(Config::with_disabled_socket, args.disable_socket)
+        .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(
+            BaseConfig::with_custom_nym_apis,
+            args.nym_apis,
+            network_defaults::var_names::NYM_API,
+            config::parse_urls,
+        )
+        .with_optional_custom_env_ext(
+            BaseConfig::with_custom_nyxd,
+            args.nyxd_urls,
+            network_defaults::var_names::NYXD,
+            config::parse_urls,
+        )
+        .with_optional_ext(
+            BaseConfig::with_disabled_credentials,
+            args.enabled_credentials_mode.map(|b| !b),
+        )
 }

 #[cfg(test)]
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0

 use std::error::Error;
+use std::net::IpAddr;

 use crate::{
    client::{config::Config, SocketClient},
@@ -21,10 +22,9 @@ pub(crate) struct Run {
    #[clap(long)]
    id: String,

-    /// Comma separated list of rest endpoints of the nymd validators
-    #[cfg(feature = "coconut")]
-    #[clap(long, value_delimiter = ',')]
-    nymd_validators: Option<Vec<url::Url>>,
+    /// Comma separated list of rest endpoints of the nyxd validators
+    #[clap(long, alias = "nymd_validators", value_delimiter = ',', hide = true)]
+    nyxd_urls: Option<Vec<url::Url>>,

    /// Comma separated list of rest endpoints of the API validators
    #[clap(long, alias = "api_validators", value_delimiter = ',')]
@@ -38,12 +38,16 @@ pub(crate) struct Run {

    /// Whether to not start the websocket
    #[clap(long)]
-    disable_socket: bool,
+    disable_socket: Option<bool>,

    /// Port for the socket to listen on
    #[clap(short, long)]
    port: Option<u16>,

+    /// Ip for the socket (if applicable) to listen for requests.
+    #[clap(long)]
+    host: Option<IpAddr>,
+
    /// Mostly debug-related option to increase default traffic rate so that you would not need to
    /// modify config post init
    #[clap(long, hide = true)]
@@ -55,9 +59,8 @@ pub(crate) struct Run {

    /// Set this client to work in a enabled credentials mode that would attempt to use gateway
    /// with bandwidth credential requirement.
-    #[cfg(feature = "coconut")]
-    #[clap(long)]
-    enabled_credentials_mode: bool,
+    #[clap(long, hide = true)]
+    enabled_credentials_mode: Option<bool>,
 }

 impl From<Run> for OverrideConfig {
@@ -66,12 +69,10 @@ impl From<Run> for OverrideConfig {
            nym_apis: run_config.nym_apis,
            disable_socket: run_config.disable_socket,
            port: run_config.port,
+            host: run_config.host,
            fastmode: run_config.fastmode,
            no_cover: run_config.no_cover,
-
-            #[cfg(feature = "coconut")]
-            nymd_validators: run_config.nymd_validators,
-            #[cfg(feature = "coconut")]
+            nyxd_urls: run_config.nyxd_urls,
            enabled_credentials_mode: run_config.enabled_credentials_mode,
        }
    }
@@ -99,7 +100,7 @@ fn version_check(cfg: &Config) -> bool {
 pub(crate) async fn execute(args: &Run) -> Result<(), Box<dyn Error + Send + Sync>> {
    let id = &args.id;

-    let mut config = match Config::load_from_file(Some(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);
@@ -17,36 +17,26 @@ fn fail_upgrade<D1: Display, D2: Display>(from_version: D1, to_version: D2) -> !
 }

 fn print_start_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
-    println!(
-        "\n==================\nTrying to upgrade client from {} to {} ...",
-        from, to
-    );
+    println!("\n==================\nTrying to upgrade client from {from} to {to} ...");
 }

 fn print_failed_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
-    eprintln!(
-        "Upgrade from {} to {} failed!\n==================\n",
-        from, to
-    );
+    eprintln!("Upgrade from {from} to {to} failed!\n==================\n");
 }

 fn print_successful_upgrade<D1: Display, D2: Display>(from: D1, to: D2) {
-    println!(
-        "Upgrade from {} to {} was successful!\n==================\n",
-        from, to
-    );
+    println!("Upgrade from {from} to {to} was successful!\n==================\n");
 }

 fn outdated_upgrade(config_version: &Version, package_version: &Version) -> ! {
    eprintln!(
-        "Cannot perform upgrade from {} to {}. Your version is too old to perform the upgrade.!",
-        config_version, package_version
+        "Cannot perform upgrade from {config_version} to {package_version}. Your version is too old to perform the upgrade.!"
    );
    process::exit(1)
 }

 fn unsupported_upgrade(current_version: &Version, config_version: &Version) -> ! {
-    eprintln!("Cannot perform upgrade from {} to {}. Please let the developers know about this issue if you expected it to work!", config_version, current_version);
+    eprintln!("Cannot perform upgrade from {config_version} to {current_version}. Please let the developers know about this issue if you expected it to work!");
    process::exit(1)
 }

@@ -65,8 +55,7 @@ fn parse_config_version(config: &Config) -> Version {

    if version.is_prerelease() || !version.build.is_empty() {
        eprintln!(
-            "Trying to upgrade from a non-released version {}. This is not supported!",
-            version
+            "Trying to upgrade from a non-released version {version}. This is not supported!"
        );
        process::exit(1)
    }
@@ -81,10 +70,7 @@ fn parse_package_version() -> Version {
    // however, we are not using them ourselves at the moment and hence it should be fine.
    // if we change our mind, we could easily tweak this code
    if version.is_prerelease() || !version.build.is_empty() {
-        eprintln!(
-            "Trying to upgrade to a non-released version {}. This is not supported!",
-            version
-        );
+        eprintln!("Trying to upgrade to a non-released version {version}. This is not supported!");
        process::exit(1)
    }

@@ -145,7 +131,7 @@ pub(crate) fn execute(args: &Upgrade) {

    let id = &args.id;

-    let existing_config = Config::load_from_file(Some(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)
    });
@@ -3,7 +3,7 @@

 use std::error::Error;

-use clap::{crate_version, Parser};
+use clap::{crate_name, crate_version, Parser};
 use logging::setup_logging;
 use network_defaults::setup_env;

@@ -15,26 +15,9 @@ pub mod websocket;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    setup_logging();
-    println!("{}", banner());
+    println!("{}", logging::banner(crate_name!(), crate_version!()));

    let args = commands::Cli::parse();
    setup_env(args.config_env_file.as_ref());
    commands::execute(&args).await
 }
-
-fn banner() -> String {
-    format!(
-        r#"
-
-      _ __  _   _ _ __ ___
-     | '_ \| | | | '_ \ _ \
-     | | | | |_| | | | | | |
-     |_| |_|\__, |_| |_| |_|
-            |___/
-
-             (client - version {:})
-
-    "#,
-        crate_version!()
-    )
-}
@@ -27,17 +27,13 @@ use tokio_tungstenite::{
 };
 use websocket_requests::{requests::ClientRequest, responses::ServerResponse};

+#[derive(Default)]
 enum ReceivedResponseType {
+    #[default]
    Binary,
    Text,
 }

-impl Default for ReceivedResponseType {
-    fn default() -> Self {
-        ReceivedResponseType::Binary
-    }
-}
-
 pub(crate) struct HandlerBuilder {
    msg_input: InputMessageSender,
    client_connection_tx: ConnectionCommandSender,
@@ -3,6 +3,7 @@

 use super::handler::HandlerBuilder;
 use log::*;
+use std::net::IpAddr;
 use std::{net::SocketAddr, process, sync::Arc};
 use tokio::io::AsyncWriteExt;
 use tokio::{sync::Notify, task::JoinHandle};
@@ -24,10 +25,9 @@ pub(crate) struct Listener {
 }

 impl Listener {
-    pub(crate) fn new(port: u16) -> Self {
+    pub(crate) fn new(host: IpAddr, port: u16) -> Self {
        Listener {
-            // unless we find compelling reason not to, just listen on local only
-            address: SocketAddr::new("127.0.0.1".parse().unwrap(), port),
+            address: SocketAddr::new(host, port),
            state: State::AwaitingConnection,
        }
    }
@@ -84,7 +84,7 @@ impl TryFrom<u8> for ErrorKind {

            n => Err(Error::new(
                ErrorKind::MalformedResponse,
-                format!("invalid error code {}", n),
+                format!("invalid error code {n}"),
            )),
        }
    }
@@ -1,6 +1,6 @@
 [package]
 name = "nym-socks5-client"
-version = "1.1.4"
+version = "1.1.8"
 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"
@@ -15,26 +15,27 @@ clap = { version = "4.0", features = ["cargo", "derive"] }
 dirs = "4.0"
 futures = "0.3"
 lazy_static = "1.4.0"
-log = "0.4"
+log = { workspace = true }
 pin-project = "1.0"
 pretty_env_logger = "0.4"
 rand = { version = "0.7.3", features = ["wasm-bindgen"] }
-serde = { version = "1.0", features = ["derive"] } # for config serialization/deserialization
-serde_json = "1.0.89"
+serde = { workspace = true, features = ["derive"] } # for config serialization/deserialization
+serde_json = { workspace = true }
 tap = "1.0.1"
 thiserror = "1.0.34"
-tokio = { version = "1.21.2", features = ["rt-multi-thread", "net", "signal"] }
+tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal"] }
 url = "2.2"

 # internal
 build-information = { path = "../../common/build-information" }
 client-core = { path = "../client-core", features = ["fs-surb-storage"] }
 client-connections = { path = "../../common/client-connections" }
-coconut-interface = { path = "../../common/coconut-interface", optional = true }
+coconut-interface = { path = "../../common/coconut-interface" }
 config = { path = "../../common/config" }
 completions = { path = "../../common/completions" }
-credential-storage = { path = "../../common/credential-storage" }
-credentials = { path = "../../common/credentials", optional = true }
+credential-storage = { path = "../../common/credential-storage", optional = true }
+mobile-storage = { path = "../../common/mobile-storage", optional = true }
+credentials = { path = "../../common/credentials" }
 crypto = { path = "../../common/crypto" }
 logging = { path = "../../common/logging"}
 gateway-client = { path = "../../common/client-libs/gateway-client" }
@@ -44,12 +45,14 @@ nymsphinx = { path = "../../common/nymsphinx" }
 ordered-buffer = { path = "../../common/socks5/ordered-buffer" }
 pemstore = { path = "../../common/pemstore" }
 proxy-helpers = { path = "../../common/socks5/proxy-helpers" }
+service-providers-common = { path = "../../service-providers/common" }
 socks5-requests = { path = "../../common/socks5/requests" }
 task = { path = "../../common/task" }
 topology = { path = "../../common/topology" }
-validator-client = { path = "../../common/client-libs/validator-client", features = ["nymd-client"] }
+validator-client = { path = "../../common/client-libs/validator-client", features = ["nyxd-client"] }
 version-checker = { path = "../../common/version-checker" }

 [features]
-coconut = ["coconut-interface", "credentials", "gateway-requests/coconut", "gateway-client/coconut", "credentials/coconut", "client-core/coconut"]
+default = ["credential-storage"]
 eth = []
+mobile = ["mobile-storage", "gateway-client/mobile"]
@@ -1,21 +1,26 @@
-// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

 use crate::client::config::template::config_template;
+pub use client_core::config::Config as BaseConfig;
 pub use client_core::config::MISSING_VALUE;
-use client_core::config::{ClientCoreConfigTrait, Config as BaseConfig, DebugConfig};
+use client_core::config::{ClientCoreConfigTrait, DebugConfig};
 use config::defaults::DEFAULT_SOCKS5_LISTENING_PORT;
-use config::NymConfig;
+use config::{NymConfig, OptionalSet};
 use nymsphinx::addressing::clients::Recipient;
 use serde::{Deserialize, Serialize};
+use service_providers_common::interface::ProviderInterfaceVersion;
+use socks5_requests::Socks5ProtocolVersion;
+use std::fmt::Debug;
 use std::path::PathBuf;
+use std::str::FromStr;

 mod template;

 const DEFAULT_CONNECTION_START_SURBS: u32 = 20;
 const DEFAULT_PER_REQUEST_SURBS: u32 = 3;

-#[derive(Debug, Default, Deserialize, PartialEq, Serialize)]
+#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct Config {
    #[serde(flatten)]
@@ -33,10 +38,12 @@ impl NymConfig for Config {
    }

    fn default_root_directory() -> PathBuf {
-        dirs::home_dir()
-            .expect("Failed to evaluate $HOME value")
-            .join(".nym")
-            .join("socks5-clients")
+        #[cfg(not(feature = "mobile"))]
+        let base_dir = dirs::home_dir().expect("Failed to evaluate $HOME value");
+        #[cfg(feature = "mobile")]
+        let base_dir = PathBuf::from("/tmp");
+
+        base_dir.join(".nym").join("socks5-clients")
    }

    fn try_default_root_directory() -> Option<PathBuf> {
@@ -85,6 +92,16 @@ impl Config {
        self
    }

+    pub fn with_provider_interface_version(mut self, version: ProviderInterfaceVersion) -> Self {
+        self.socks5.provider_interface_version = version;
+        self
+    }
+
+    pub fn with_socks5_protocol_version(mut self, version: Socks5ProtocolVersion) -> Self {
+        self.socks5.socks5_protocol_version = version;
+        self
+    }
+
    pub fn with_anonymous_replies(mut self, anonymous_replies: bool) -> Self {
        self.socks5.send_anonymously = anonymous_replies;
        self
@@ -112,6 +129,14 @@ impl Config {
            .expect("malformed provider address")
    }

+    pub fn get_provider_interface_version(&self) -> ProviderInterfaceVersion {
+        self.socks5.provider_interface_version
+    }
+
+    pub fn get_socks5_protocol_version(&self) -> Socks5ProtocolVersion {
+        self.socks5.socks5_protocol_version
+    }
+
    pub fn get_send_anonymously(&self) -> bool {
        self.socks5.send_anonymously
    }
@@ -127,9 +152,53 @@ impl Config {
    pub fn get_per_request_surbs(&self) -> u32 {
        self.socks5_debug.per_request_surbs
    }
+
+    // poor man's 'builder' method
+    pub fn with_base<F, T>(mut self, f: F, val: T) -> Self
+    where
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
+    {
+        self.base = f(self.base, val);
+        self
+    }
+
+    // helper methods to use `OptionalSet` trait. Those are defined due to very... ehm. 'specific' structure of this config
+    // (plz, lets refactor it)
+    pub fn with_optional_ext<F, T>(mut self, f: F, val: Option<T>) -> Self
+    where
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
+    {
+        self.base = self.base.with_optional(f, val);
+        self
+    }
+
+    pub fn with_optional_env_ext<F, T>(mut self, f: F, val: Option<T>, env_var: &str) -> Self
+    where
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
+        T: FromStr,
+        <T as FromStr>::Err: Debug,
+    {
+        self.base = self.base.with_optional_env(f, val, env_var);
+        self
+    }
+
+    pub fn with_optional_custom_env_ext<F, T, G>(
+        mut self,
+        f: F,
+        val: Option<T>,
+        env_var: &str,
+        parser: G,
+    ) -> Self
+    where
+        F: Fn(BaseConfig<Self>, T) -> BaseConfig<Self>,
+        G: Fn(&str) -> T,
+    {
+        self.base = self.base.with_optional_custom_env(f, val, env_var, parser);
+        self
+    }
 }

-#[derive(Debug, Deserialize, PartialEq, Eq, Serialize)]
+#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct Socks5 {
    /// The port on which the client will be listening for incoming requests
@@ -138,6 +207,15 @@ pub struct Socks5 {
    /// The mix address of the provider to which all requests are going to be sent.
    provider_mix_address: String,

+    /// The version of the 'service provider' this client is going to use in its communication with the
+    /// specified socks5 provider.
+    // if in doubt, use the legacy version as initially nobody will be using the updated binaries
+    #[serde(default = "ProviderInterfaceVersion::new_legacy")]
+    provider_interface_version: ProviderInterfaceVersion,
+
+    #[serde(default = "Socks5ProtocolVersion::new_legacy")]
+    socks5_protocol_version: Socks5ProtocolVersion,
+
    /// 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.
@@ -152,6 +230,8 @@ impl Socks5 {
        Socks5 {
            listening_port: DEFAULT_SOCKS5_LISTENING_PORT,
            provider_mix_address: provider_mix_address.into(),
+            provider_interface_version: ProviderInterfaceVersion::Legacy,
+            socks5_protocol_version: Socks5ProtocolVersion::Legacy,
            send_anonymously: false,
        }
    }
@@ -162,12 +242,14 @@ impl Default for Socks5 {
        Socks5 {
            listening_port: DEFAULT_SOCKS5_LISTENING_PORT,
            provider_mix_address: "".into(),
+            provider_interface_version: ProviderInterfaceVersion::Legacy,
+            socks5_protocol_version: Socks5ProtocolVersion::Legacy,
            send_anonymously: false,
        }
    }
 }

-#[derive(Debug, Deserialize, PartialEq, Eq, Serialize)]
+#[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct Socks5Debug {
    /// Number of reply SURBs attached to each `Request::Connect` message.
@@ -23,9 +23,9 @@ id = '{{ client.id }}'
 # to claim bandwidth without presenting bandwidth credentials.
 disabled_credentials_mode = {{ client.disabled_credentials_mode }}

-# Addresses to nymd validators via which the client can communicate with the chain.
-validator_urls = [
-    {{#each client.validator_urls }}
+# Addresses to nyxd validators via which the client can communicate with the chain.
+nyxd_urls = [
+    {{#each client.nyxd_urls }}
        '{{this}}',
    {{/each}}
 ]
@@ -8,18 +8,23 @@ use crate::socks::{
    authentication::{AuthenticationMethods, Authenticator, User},
    server::SphinxSocksServer,
 };
-use client_core::client::base_client::{
-    non_wasm_helpers, BaseClientBuilder, ClientInput, ClientOutput,
-};
+
+#[cfg(feature = "mobile")]
+use client_core::client::base_client::helpers::setup_empty_reply_surb_backend;
+#[cfg(not(feature = "mobile"))]
+use client_core::client::base_client::non_wasm_helpers;
+use client_core::client::base_client::{BaseClientBuilder, ClientInput, ClientOutput, ClientState};
 use client_core::client::key_manager::KeyManager;
 use client_core::config::persistence::key_pathfinder::ClientKeyPathfinder;
 use futures::channel::mpsc;
 use futures::StreamExt;
+#[cfg(not(feature = "mobile"))]
 use gateway_client::bandwidth::BandwidthController;
 use log::*;
 use nymsphinx::addressing::clients::Recipient;
 use std::error::Error;
-use task::{wait_for_signal_and_error, TaskClient, TaskManager};
+use task::{TaskClient, TaskManager};
+use validator_client::nyxd::QueryNyxdClient;

 pub mod config;

@@ -53,48 +58,53 @@ impl NymClient {
        }
    }

-    async fn create_bandwidth_controller(config: &Config) -> BandwidthController {
-        #[cfg(feature = "coconut")]
-        let bandwidth_controller = {
-            let details = 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 nymd_url = config
-                .get_base()
-                .get_validator_endpoints()
-                .pop()
-                .expect("No nymd 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(nymd_url, api_url);
-            let client = validator_client::Client::new_query(client_config)
-                .expect("Could not construct query client");
-            let coconut_api_clients =
-                validator_client::CoconutApiClient::all_coconut_api_clients(&client)
-                    .await
-                    .expect("Could not query api clients");
-            BandwidthController::new(
-                credential_storage::initialise_storage(config.get_base().get_database_path()).await,
-                coconut_api_clients,
-            )
-        };
-        #[cfg(not(feature = "coconut"))]
-        let bandwidth_controller = BandwidthController::new(
-            credential_storage::initialise_storage(config.get_base().get_database_path()).await,
-        )
-        .expect("Could not create bandwidth controller");
-        bandwidth_controller
+    pub fn new_with_keys(config: Config, key_manager: Option<KeyManager>) -> Self {
+        let key_manager = key_manager.unwrap_or_else(|| {
+            let pathfinder = ClientKeyPathfinder::new_from_config(config.get_base());
+            KeyManager::load_keys(&pathfinder).expect("failed to load stored keys")
+        });
+
+        NymClient {
+            config,
+            key_manager,
+        }
+    }
+
+    #[cfg(not(feature = "mobile"))]
+    async fn create_bandwidth_controller(config: &Config) -> BandwidthController<QueryNyxdClient> {
+        let details = 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");
+
+        #[cfg(not(feature = "mobile"))]
+        let storage =
+            credential_storage::initialise_storage(config.get_base().get_database_path()).await;
+
+        #[cfg(feature = "mobile")]
+        let storage = mobile_storage::PersistentStorage {};
+
+        BandwidthController::new(storage, client)
    }

    fn start_socks5_listener(
        config: &Config,
        client_input: ClientInput,
        client_output: ClientOutput,
+        client_status: ClientState,
        self_address: Recipient,
        shutdown: TaskClient,
    ) {
@@ -108,10 +118,14 @@ impl NymClient {
        } = client_input;

        let ClientOutput {
-            shared_lane_queue_lengths,
            received_buffer_request_sender,
        } = client_output;

+        let ClientState {
+            shared_lane_queue_lengths,
+            reply_controller_sender: _,
+        } = client_status;
+
        let authenticator = Authenticator::new(auth_methods, allowed_users);
        let mut sphinx_socks = SphinxSocksServer::new(
            config.get_listening_port(),
@@ -120,6 +134,8 @@ impl NymClient {
            self_address,
            shared_lane_queue_lengths,
            socks::client::Config::new(
+                config.get_provider_interface_version(),
+                config.get_socks5_protocol_version(),
                config.get_send_anonymously(),
                config.get_connection_start_surbs(),
                config.get_per_request_surbs(),
@@ -142,16 +158,9 @@ impl NymClient {

    /// blocking version of `start` method. Will run forever (or until SIGINT is sent)
    pub async fn run_forever(self) -> Result<(), Box<dyn Error + Send + Sync>> {
-        let mut shutdown = self.start().await?;
-
-        let res = wait_for_signal_and_error(&mut shutdown).await;
-
-        log::info!("Sending shutdown");
-        shutdown.signal_shutdown().ok();
-
-        log::info!("Waiting for tasks to finish... (Press ctrl-c to force)");
-        shutdown.wait_for_shutdown().await;
+        let shutdown = self.start().await?;

+        let res = shutdown.catch_interrupt().await;
        log::info!("Stopping nym-socks5-client");
        res
    }
@@ -203,26 +212,37 @@ impl NymClient {
    }

    pub async fn start(self) -> Result<TaskManager, Socks5ClientError> {
+        #[cfg(not(feature = "mobile"))]
        let base_builder = BaseClientBuilder::new_from_base_config(
            self.config.get_base(),
            self.key_manager,
            Some(Self::create_bandwidth_controller(&self.config).await),
            non_wasm_helpers::setup_fs_reply_surb_backend(
-                self.config.get_base().get_reply_surb_database_path(),
+                Some(self.config.get_base().get_reply_surb_database_path()),
                self.config.get_debug_settings(),
            )
            .await?,
        );

+        #[cfg(feature = "mobile")]
+        let base_builder = BaseClientBuilder::<_, QueryNyxdClient>::new_from_base_config(
+            self.config.get_base(),
+            self.key_manager,
+            None,
+            setup_empty_reply_surb_backend(self.config.get_debug_settings()),
+        );
+
        let self_address = base_builder.as_mix_recipient();
        let mut started_client = base_builder.start_base().await?;
        let client_input = started_client.client_input.register_producer();
        let client_output = started_client.client_output.register_consumer();
+        let client_state = started_client.client_state;

        Self::start_socks5_listener(
            &self.config,
            client_input,
            client_output,
+            client_state,
            self_address,
            started_client.task_manager.subscribe(),
        );
@@ -31,7 +31,7 @@ pub(crate) struct Init {
    /// Note that some service providers might not support this.
    // the alias here is included for backwards compatibility (1.1.4 and before)
    #[clap(long, alias = "use_anonymous_sender_tag")]
-    use_reply_surbs: bool,
+    use_reply_surbs: Option<bool>,

    /// Id of the gateway we are going to connect to.
    #[clap(long)]
@@ -42,10 +42,9 @@ pub(crate) struct Init {
    #[clap(long)]
    force_register_gateway: bool,

-    /// Comma separated list of rest endpoints of the nymd validators
-    #[cfg(feature = "coconut")]
-    #[clap(long, value_delimiter = ',')]
-    nymd_validators: Option<Vec<url::Url>>,
+    /// Comma separated list of rest endpoints of the nyxd validators
+    #[clap(long, alias = "nymd_validators", value_delimiter = ',', hide = true)]
+    nyxd_urls: Option<Vec<url::Url>>,

    /// Comma separated list of rest endpoints of the API validators
    #[clap(long, alias = "api_validators", value_delimiter = ',')]
@@ -67,9 +66,8 @@ pub(crate) struct Init {

    /// Set this client to work in a enabled credentials mode that would attempt to use gateway
    /// with bandwidth credential requirement.
-    #[cfg(feature = "coconut")]
-    #[clap(long)]
-    enabled_credentials_mode: bool,
+    #[clap(long, hide = true)]
+    enabled_credentials_mode: Option<bool>,

    /// Save a summary of the initialization to a json file
    #[clap(long)]
@@ -84,10 +82,7 @@ impl From<Init> for OverrideConfig {
            use_anonymous_replies: init_config.use_reply_surbs,
            fastmode: init_config.fastmode,
            no_cover: init_config.no_cover,
-
-            #[cfg(feature = "coconut")]
-            nymd_validators: init_config.nymd_validators,
-            #[cfg(feature = "coconut")]
+            nyxd_urls: init_config.nyxd_urls,
            enabled_credentials_mode: init_config.enabled_credentials_mode,
        }
    }
@@ -122,18 +117,17 @@ pub(crate) async fn execute(args: &Init) -> Result<(), Socks5ClientError> {
    let id = &args.id;
    let provider_address = &args.provider;

-    let already_init = Config::default_config_file_path(Some(id)).exists();
+    let already_init = Config::default_config_file_path(id).exists();
    if already_init {
-        println!(
-            "SOCKS5 client \"{}\" was already initialised before! \
-            Config information will be overwritten (but keys will be kept)!",
-            id
-        );
+        println!("SOCKS5 client \"{id}\" was already initialised before");
    }

    // Usually you only register with the gateway on the first init, however you can force
    // re-registering if wanted.
    let user_wants_force_register = args.force_register_gateway;
+    if user_wants_force_register {
+        println!("Instructed to force registering gateway. This might overwrite keys!");
+    }

    // If the client was already initialized, don't generate new keys and don't re-register with
    // the gateway (because this would create a new shared key).
@@ -151,15 +145,17 @@ pub(crate) async fn execute(args: &Init) -> Result<(), Socks5ClientError> {

    // Setup gateway by either registering a new one, or creating a new config from the selected
    // one but with keys kept, or reusing the gateway configuration.
-    let gateway = client_core::init::setup_gateway::<Config, _>(
+    let gateway = client_core::init::setup_gateway_from_config::<Config, _>(
        register_gateway,
-        user_chosen_gateway_id.map(|id| id.to_base58_string()),
+        user_chosen_gateway_id,
        config.get_base(),
    )
    .await
    .tap_err(|err| eprintln!("Failed to setup gateway\nError: {err}"))?;

-    config.get_base_mut().with_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

    config.save_to_file(None).tap_err(|_| {
        log::error!("Failed to save the config file");
@@ -1,12 +1,12 @@
 // Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0

-use crate::client::config::Config;
+use crate::client::config::{BaseConfig, Config};
 use build_information::BinaryBuildInformation;
 use clap::CommandFactory;
 use clap::{Parser, Subcommand};
 use completions::{fig_generate, ArgShell};
-use config::parse_urls;
+use config::OptionalSet;
 use lazy_static::lazy_static;
 use std::error::Error;

@@ -57,14 +57,11 @@ pub(crate) enum Commands {
 pub(crate) struct OverrideConfig {
    nym_apis: Option<Vec<url::Url>>,
    port: Option<u16>,
-    use_anonymous_replies: bool,
+    use_anonymous_replies: Option<bool>,
    fastmode: bool,
    no_cover: bool,
-
-    #[cfg(feature = "coconut")]
-    nymd_validators: Option<Vec<url::Url>>,
-    #[cfg(feature = "coconut")]
-    enabled_credentials_mode: bool,
+    nyxd_urls: Option<Vec<url::Url>>,
+    enabled_credentials_mode: Option<bool>,
 }

 pub(crate) async fn execute(args: &Cli) -> Result<(), Box<dyn Error + Send + Sync>> {
@@ -80,48 +77,28 @@ pub(crate) async fn execute(args: &Cli) -> Result<(), Box<dyn Error + Send + Syn
    Ok(())
 }

-pub(crate) fn override_config(mut config: Config, args: OverrideConfig) -> Config {
-    if let Some(nym_apis) = args.nym_apis {
-        config.get_base_mut().set_custom_nym_apis(nym_apis);
-    } else if let Ok(raw_validators) = std::env::var(network_defaults::var_names::API_VALIDATOR) {
-        config
-            .get_base_mut()
-            .set_custom_nym_apis(parse_urls(&raw_validators));
-    }
-
-    if args.use_anonymous_replies {
-        config = config.with_anonymous_replies(true)
-    }
-
-    if let Some(port) = args.port {
-        config = config.with_port(port);
-    }
-
-    #[cfg(feature = "coconut")]
-    {
-        if let Some(nymd_validators) = args.nymd_validators {
-            config.get_base_mut().set_custom_validators(nymd_validators);
-        } else if let Ok(raw_validators) =
-            std::env::var(network_defaults::var_names::NYMD_VALIDATOR)
-        {
-            config
-                .get_base_mut()
-                .set_custom_validators(parse_urls(&raw_validators));
-        }
-        if args.enabled_credentials_mode {
-            config.get_base_mut().with_disabled_credentials(false)
-        }
-    }
-
-    if args.fastmode {
-        config.get_base_mut().set_high_default_traffic_volume();
-    }
-
-    if args.no_cover {
-        config.get_base_mut().set_no_cover_traffic();
-    }
-
+pub(crate) fn override_config(config: Config, args: OverrideConfig) -> Config {
    config
+        .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_custom_env_ext(
+            BaseConfig::with_custom_nym_apis,
+            args.nym_apis,
+            network_defaults::var_names::NYM_API,
+            config::parse_urls,
+        )
+        .with_optional_custom_env_ext(
+            BaseConfig::with_custom_nyxd,
+            args.nyxd_urls,
+            network_defaults::var_names::NYXD,
+            config::parse_urls,
+        )
+        .with_optional_ext(
+            BaseConfig::with_disabled_credentials,
+            args.enabled_credentials_mode.map(|b| !b),
+        )
 }

 #[cfg(test)]
@@ -31,7 +31,7 @@ pub(crate) struct Run {
    /// Note that some service providers might not support this.
    // the alias here is included for backwards compatibility (1.1.4 and before)
    #[clap(long, alias = "use_anonymous_sender_tag")]
-    use_anonymous_replies: bool,
+    use_anonymous_replies: Option<bool>,

    /// Address of the socks5 provider to send messages to.
    #[clap(long)]
@@ -42,10 +42,9 @@ pub(crate) struct Run {
    #[clap(long)]
    gateway: Option<identity::PublicKey>,

-    /// Comma separated list of rest endpoints of the nymd validators
-    #[cfg(feature = "coconut")]
-    #[clap(long, value_delimiter = ',')]
-    nymd_validators: Option<Vec<url::Url>>,
+    /// Comma separated list of rest endpoints of the nyxd validators
+    #[clap(long, alias = "nymd_validators", value_delimiter = ',', hide = true)]
+    nyxd_urls: Option<Vec<url::Url>>,

    /// Comma separated list of rest endpoints of the Nym APIs
    #[clap(long, value_delimiter = ',')]
@@ -66,9 +65,8 @@ pub(crate) struct Run {

    /// Set this client to work in a enabled credentials mode that would attempt to use gateway
    /// with bandwidth credential requirement.
-    #[cfg(feature = "coconut")]
-    #[clap(long)]
-    enabled_credentials_mode: bool,
+    #[clap(long, hide = true)]
+    enabled_credentials_mode: Option<bool>,
 }

 impl From<Run> for OverrideConfig {
@@ -79,10 +77,7 @@ impl From<Run> for OverrideConfig {
            use_anonymous_replies: run_config.use_anonymous_replies,
            fastmode: run_config.fastmode,
            no_cover: run_config.no_cover,
-
-            #[cfg(feature = "coconut")]
-            nymd_validators: run_config.nymd_validators,
-            #[cfg(feature = "coconut")]
+            nyxd_urls: run_config.nyxd_urls,
            enabled_credentials_mode: run_config.enabled_credentials_mode,
        }
    }
@@ -113,7 +108,7 @@ fn version_check(cfg: &Config) -> bool {
 pub(crate) async fn execute(args: &Run) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let id = &args.id;

-    let mut config = match Config::load_from_file(Some(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);
@@ -144,7 +144,7 @@ pub(crate) fn execute(args: &Upgrade) {

    let id = &args.id;

-    let existing_config = Config::load_from_file(Some(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)
    });
@@ -1,6 +1,6 @@
 use crate::socks::types::SocksProxyError;
 use client_core::error::ClientCoreError;
-use socks5_requests::ConnectionId;
+use socks5_requests::{ConnectionError, ConnectionId};

 #[derive(thiserror::Error, Debug)]
 pub enum Socks5ClientError {
@@ -28,3 +28,12 @@ pub enum Socks5ClientError {
        error: String,
    },
 }
+
+impl From<ConnectionError> for Socks5ClientError {
+    fn from(value: ConnectionError) -> Self {
+        Socks5ClientError::NetworkRequesterError {
+            connection_id: value.connection_id,
+            error: value.network_requester_error,
+        }
+    }
+}
@@ -3,7 +3,7 @@

 use std::error::Error;

-use clap::{crate_version, Parser};
+use clap::{crate_name, crate_version, Parser};
 use logging::setup_logging;
 use network_defaults::setup_env;

@@ -15,26 +15,9 @@ pub mod socks;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    setup_logging();
-    println!("{}", banner());
+    println!("{}", logging::banner(crate_name!(), crate_version!()));

    let args = commands::Cli::parse();
    setup_env(args.config_env_file.as_ref());
    commands::execute(&args).await
 }
-
-fn banner() -> String {
-    format!(
-        r#"
-
-      _ __  _   _ _ __ ___
-     | '_ \| | | | '_ \ _ \
-     | | | | |_| | | | | | |
-     |_| |_|\__, |_| |_| |_|
-            |___/
-
-             (socks5 proxy - version {:})
-
-    "#,
-        crate_version!()
-    )
-}
@@ -16,7 +16,10 @@ use proxy_helpers::connection_controller::{
 };
 use proxy_helpers::proxy_runner::ProxyRunner;
 use rand::RngCore;
-use socks5_requests::{ConnectionId, Message, RemoteAddress, Request};
+use service_providers_common::interface::{ProviderInterfaceVersion, RequestVersion};
+use socks5_requests::{
+    ConnectionId, RemoteAddress, Socks5ProtocolVersion, Socks5ProviderRequest, Socks5Request,
+};
 use std::io;
 use std::net::SocketAddr;
 use std::pin::Pin;
@@ -128,6 +131,8 @@ impl AsyncWrite for StreamState {

 #[derive(Debug, Copy, Clone)]
 pub(crate) struct Config {
+    provider_interface_version: ProviderInterfaceVersion,
+    socks5_protocol_version: Socks5ProtocolVersion,
    use_surbs_for_responses: bool,
    connection_start_surbs: u32,
    per_request_surbs: u32,
@@ -135,16 +140,27 @@ pub(crate) struct Config {

 impl Config {
    pub(crate) fn new(
+        provider_interface_version: ProviderInterfaceVersion,
+        socks5_protocol_version: Socks5ProtocolVersion,
        use_surbs_for_responses: bool,
        connection_start_surbs: u32,
        per_request_surbs: u32,
    ) -> Self {
        Self {
+            provider_interface_version,
+            socks5_protocol_version,
            use_surbs_for_responses,
            connection_start_surbs,
            per_request_surbs,
        }
    }
+
+    fn request_version(&self) -> RequestVersion<Socks5Request> {
+        RequestVersion {
+            provider_interface: self.provider_interface_version,
+            provider_protocol: self.socks5_protocol_version,
+        }
+    }
 }

 /// A client connecting to the Socks proxy server, because
@@ -173,7 +189,9 @@ impl Drop for SocksClient {
        // if we never managed to start a proxy, the entry will not exist in the controller
        if self.started_proxy {
            self.controller_sender
-                .unbounded_send(ControllerCommand::Remove(self.connection_id))
+                .unbounded_send(ControllerCommand::Remove {
+                    connection_id: self.connection_id,
+                })
                .unwrap();
        }
    }
@@ -248,19 +266,26 @@ impl SocksClient {

    // Send an error back to the client
    pub async fn send_error_v4(&mut self, r: ResponseCodeV4) -> Result<(), SocksProxyError> {
-        self.stream.write_all(&[SOCKS4_VERSION, r as u8]).await?;
-        Ok(())
+        self.stream
+            .write_all(&[SOCKS4_VERSION, r as u8])
+            .await
+            .map_err(|source| SocksProxyError::SocketWriteError { source })
    }

    pub async fn send_error_v5(&mut self, r: ResponseCodeV5) -> Result<(), SocksProxyError> {
-        self.stream.write_all(&[SOCKS5_VERSION, r as u8]).await?;
-        Ok(())
+        self.stream
+            .write_all(&[SOCKS5_VERSION, r as u8])
+            .await
+            .map_err(|source| SocksProxyError::SocketWriteError { source })
    }

    /// Shutdown the `TcpStream` to the client and end the session
    pub async fn shutdown(&mut self) -> Result<(), SocksProxyError> {
        info!("client is shutting down its TCP stream");
-        self.stream.shutdown().await?;
+        self.stream
+            .shutdown()
+            .await
+            .map_err(|source| SocksProxyError::SocketShutdownFailure { source })?;
        self.shutdown_listener.mark_as_success();
        Ok(())
    }
@@ -268,11 +293,20 @@ impl SocksClient {
    /// Initializes the new client, checking that the correct Socks version (5)
    /// is in use and that the client is authenticated, then runs the request.
    pub async fn run(&mut self) -> Result<(), SocksProxyError> {
-        debug!("New connection from: {}", self.stream.peer_addr()?.ip());
+        debug!(
+            "New connection from: {}",
+            self.stream
+                .peer_addr()
+                .map_err(|source| SocksProxyError::PeerAddrExtractionFailure { source })?
+                .ip()
+        );

        // Read a byte from the stream and determine the version being requested
        let mut header = [0u8];
-        self.stream.read_exact(&mut header).await?;
+        self.stream
+            .read_exact(&mut header)
+            .await
+            .map_err(|source| SocksProxyError::SocketReadError { source })?;

        self.socks_version = match SocksVersion::try_from(header[0]) {
            Ok(version) => Some(version),
@@ -284,7 +318,10 @@ impl SocksClient {

        if self.socks_version == Some(SocksVersion::V5) {
            let mut auth = [0u8];
-            self.stream.read_exact(&mut auth).await?;
+            self.stream
+                .read_exact(&mut auth)
+                .await
+                .map_err(|source| SocksProxyError::SocketReadError { source })?;
            self.auth_nmethods = auth[0];
            self.authenticate_socks5().await?;
        }
@@ -293,8 +330,15 @@ impl SocksClient {
    }

    async fn send_anonymous_connect_to_mixnet(&mut self, remote_address: RemoteAddress) {
-        let req = Request::new_connect(self.connection_id, remote_address, None);
-        let msg = Message::Request(req);
+        // TODO: simplify by using `request_version`
+        let req = Socks5Request::new_connect(
+            self.config.socks5_protocol_version,
+            self.connection_id,
+            remote_address,
+            None,
+        );
+        let msg =
+            Socks5ProviderRequest::new_provider_data(self.config.provider_interface_version, req);

        let input_message = InputMessage::new_anonymous(
            self.service_provider,
@@ -309,8 +353,15 @@ impl SocksClient {
    }

    async fn send_connect_to_mixnet_with_return_address(&mut self, remote_address: RemoteAddress) {
-        let req = Request::new_connect(self.connection_id, remote_address, Some(self.self_address));
-        let msg = Message::Request(req);
+        // TODO: simplify by using `request_version`
+        let req = Socks5Request::new_connect(
+            self.config.socks5_protocol_version,
+            self.connection_id,
+            remote_address,
+            Some(self.self_address),
+        );
+        let msg =
+            Socks5ProviderRequest::new_provider_data(self.config.provider_interface_version, req);

        let input_message = InputMessage::new_regular(
            self.service_provider,
@@ -350,6 +401,7 @@ impl SocksClient {
        let input_sender = self.input_sender.clone();
        let anonymous = self.config.use_surbs_for_responses;
        let per_request_surbs = self.config.per_request_surbs;
+        let request_version = self.config.request_version();

        let recipient = self.service_provider;
        let (stream, _) = ProxyRunner::new(
@@ -363,8 +415,16 @@ impl SocksClient {
            self.shutdown_listener.clone(),
        )
        .run(move |conn_id, read_data, socket_closed| {
-            let provider_request = Request::new_send(conn_id, read_data, socket_closed);
-            let provider_message = Message::Request(provider_request);
+            let provider_request = Socks5Request::new_send(
+                request_version.provider_protocol,
+                conn_id,
+                read_data,
+                socket_closed,
+            );
+            let provider_message = Socks5ProviderRequest::new_provider_data(
+                request_version.provider_interface,
+                provider_request,
+            );
            let lane = TransmissionLane::ConnectionId(conn_id);
            if anonymous {
                InputMessage::new_anonymous(
@@ -413,7 +473,10 @@ impl SocksClient {

                self.started_proxy = true;
                self.controller_sender
-                    .unbounded_send(ControllerCommand::Insert(self.connection_id, mix_sender))
+                    .unbounded_send(ControllerCommand::Insert {
+                        connection_id: self.connection_id,
+                        connection_sender: mix_sender,
+                    })
                    .unwrap();

                info!(
@@ -491,7 +554,13 @@ impl SocksClient {
    /// into the Authenticator (where it'll be more easily testable)
    /// would be a good next step.
    async fn authenticate_socks5(&mut self) -> Result<(), SocksProxyError> {
-        debug!("Authenticating w/ {}", self.stream.peer_addr()?.ip());
+        debug!(
+            "Authenticating w/ {}",
+            self.stream
+                .peer_addr()
+                .map_err(|source| SocksProxyError::PeerAddrExtractionFailure { source })?
+                .ip()
+        );
        // Get valid auth methods
        let methods = self.get_available_methods().await?;
        trace!("methods: {:?}", methods);
@@ -505,27 +574,45 @@ impl SocksClient {
            response[1] = AuthenticationMethods::UserPass as u8;

            debug!("Sending USER/PASS packet");
-            self.stream.write_all(&response).await?;
+            self.stream
+                .write_all(&response)
+                .await
+                .map_err(|source| SocksProxyError::SocketWriteError { source })?;

            let mut header = [0u8; 2];

            // Read a byte from the stream and determine the version being requested
-            self.stream.read_exact(&mut header).await?;
+            self.stream
+                .read_exact(&mut header)
+                .await
+                .map_err(|source| SocksProxyError::SocketReadError { source })?;

            // debug!("Auth Header: [{}, {}]", header[0], header[1]);

            // Username parsing
            let ulen = header[1];
            let mut username = vec![0; ulen as usize];
-            self.stream.read_exact(&mut username).await?;
+            self.stream
+                .read_exact(&mut username)
+                .await
+                .map_err(|source| SocksProxyError::SocketReadError { source })?;

            // Password Parsing
-            let plen = self.stream.read_u8().await?;
+            let plen = self
+                .stream
+                .read_u8()
+                .await
+                .map_err(|source| SocksProxyError::SocketReadError { source })?;
            let mut password = vec![0; plen as usize];
-            self.stream.read_exact(&mut password).await?;
+            self.stream
+                .read_exact(&mut password)
+                .await
+                .map_err(|source| SocksProxyError::SocketReadError { source })?;

-            let username_str = String::from_utf8(username)?;
-            let password_str = String::from_utf8(password)?;
+            let username_str = String::from_utf8(username)
+                .map_err(|source| SocksProxyError::MalformedAuthUsername { source })?;
+            let password_str = String::from_utf8(password)
+                .map_err(|source| SocksProxyError::MalformedAuthPassword { source })?;

            let user = User {
                username: username_str,
@@ -536,11 +623,17 @@ impl SocksClient {
            if self.authenticator.is_allowed(&user) {
                debug!("Access Granted. User: {}", user.username);
                let response = [1, ResponseCodeV5::Success as u8];
-                self.stream.write_all(&response).await?;
+                self.stream
+                    .write_all(&response)
+                    .await
+                    .map_err(|source| SocksProxyError::SocketWriteError { source })?;
            } else {
                debug!("Access Denied. User: {}", user.username);
                let response = [1, ResponseCodeV5::Failure as u8];
-                self.stream.write_all(&response).await?;
+                self.stream
+                    .write_all(&response)
+                    .await
+                    .map_err(|source| SocksProxyError::SocketWriteError { source })?;

                // Shutdown
                self.shutdown().await?;
@@ -551,12 +644,18 @@ impl SocksClient {
            // set the default auth method (no auth)
            response[1] = AuthenticationMethods::NoAuth as u8;
            debug!("Sending NOAUTH packet");
-            self.stream.write_all(&response).await?;
+            self.stream
+                .write_all(&response)
+                .await
+                .map_err(|source| SocksProxyError::SocketWriteError { source })?;
            Ok(())
        } else {
            warn!("Client has no suitable authentication methods!");
            response[1] = AuthenticationMethods::NoMethods as u8;
-            self.stream.write_all(&response).await?;
+            self.stream
+                .write_all(&response)
+                .await
+                .map_err(|source| SocksProxyError::SocketWriteError { source })?;
            self.shutdown().await?;
            Err(ResponseCodeV5::Failure.into())
        }
@@ -567,7 +666,10 @@ impl SocksClient {
        let mut methods: Vec<u8> = Vec::with_capacity(self.auth_nmethods as usize);
        for _ in 0..self.auth_nmethods {
            let mut method = [0u8; 1];
-            self.stream.read_exact(&mut method).await?;
+            self.stream
+                .read_exact(&mut method)
+                .await
+                .map_err(|source| SocksProxyError::SocketReadError { source })?;
            if self.authenticator.auth_methods.contains(&method[0]) {
                methods.append(&mut method.to_vec());
            }
@@ -1,5 +1,3 @@
-use std::time::Duration;
-
 use futures::channel::mpsc;
 use futures::StreamExt;
 use log::*;
@@ -7,8 +5,9 @@ use log::*;
 use client_core::client::received_buffer::ReconstructedMessagesReceiver;
 use client_core::client::received_buffer::{ReceivedBufferMessage, ReceivedBufferRequestSender};
 use nymsphinx::receiver::ReconstructedMessage;
-use proxy_helpers::connection_controller::{ControllerCommand, ControllerSender};
-use socks5_requests::Message;
+use proxy_helpers::connection_controller::ControllerSender;
+use service_providers_common::interface::{ControlResponse, ResponseContent};
+use socks5_requests::{Socks5ProviderResponse, Socks5Response, Socks5ResponseContent};
 use task::TaskClient;

 use crate::error::Socks5ClientError;
@@ -54,6 +53,39 @@ impl MixnetResponseListener {
        }
    }

+    fn on_control_response(
+        &self,
+        control_response: ControlResponse,
+    ) -> Result<(), Socks5ClientError> {
+        error!("received a control response which we don't know how to handle yet!");
+        error!("got: {:?}", control_response);
+
+        // I guess we'd need another channel here to forward those to where they need to go
+
+        Ok(())
+    }
+
+    fn on_provider_data_response(
+        &self,
+        provider_response: Socks5Response,
+    ) -> Result<(), Socks5ClientError> {
+        match provider_response.content {
+            Socks5ResponseContent::ConnectionError(err_response) => {
+                error!(
+                    "Network requester failed on connection id {} with error: {}",
+                    err_response.connection_id, err_response.network_requester_error
+                );
+                Err(err_response.into())
+            }
+            Socks5ResponseContent::NetworkData(response) => {
+                self.controller_sender
+                    .unbounded_send(response.into())
+                    .unwrap();
+                Ok(())
+            }
+        }
+    }
+
    fn on_message(
        &self,
        reconstructed_message: ReconstructedMessage,
@@ -62,38 +94,28 @@ impl MixnetResponseListener {
        if reconstructed_message.sender_tag.is_some() {
            warn!("this message was sent anonymously - it couldn't have come from the service provider");
        }
-
-        let response = match Message::try_from_bytes(&raw_message) {
+        match Socks5ProviderResponse::try_from_bytes(&raw_message) {
            Err(err) => {
-                warn!("failed to parse received response - {err}");
-                return Ok(());
+                warn!("failed to parse received response: {err}");
+                Ok(())
            }
-            Ok(Message::Request(_)) => {
-                warn!("unexpected request");
-                return Ok(());
-            }
-            Ok(Message::Response(data)) => data,
-            Ok(Message::NetworkRequesterResponse(r)) => {
-                error!(
-                    "Network requester failed on connection id {} with error: {}",
-                    r.connection_id, r.network_requester_error
+            Ok(response) => {
+                // as long as the client used the same (or older) interface than the service provider,
+                // the response should have used exactly the same version
+                trace!(
+                    "the received response was sent with {:?} interface version",
+                    response.interface_version
                );
-                return Err(Socks5ClientError::NetworkRequesterError {
-                    connection_id: r.connection_id,
-                    error: r.network_requester_error,
-                });
+                match response.content {
+                    ResponseContent::Control(control_response) => {
+                        self.on_control_response(control_response)
+                    }
+                    ResponseContent::ProviderData(provider_response) => {
+                        self.on_provider_data_response(provider_response)
+                    }
+                }
            }
-        };
-
-        self.controller_sender
-            .unbounded_send(ControllerCommand::Send(
-                response.connection_id,
-                response.data,
-                response.is_closed,
-            ))
-            .unwrap();
-
-        Ok(())
+        }
    }

    pub(crate) async fn run(&mut self) {
@@ -116,10 +138,7 @@ impl MixnetResponseListener {
                }
            }
        }
-        #[cfg(not(target_arch = "wasm32"))]
-        tokio::time::timeout(Duration::from_secs(5), self.shutdown.recv())
-            .await
-            .expect("Task stopped without shutdown called");
+        self.shutdown.recv_timeout().await;
        log::debug!("MixnetResponseListener: Exiting");
    }
 }
--- a/Show More
+++ b/Show More