Update CHANGELOG

.env.sample-dev

@@ -3,21 +3,3 @@
 
 RUST_LOG=info
 RUST_BACKTRACE=1
-
-#########################################
-# geoipupdate (needed for explorer-api) #
-#########################################
-# MaxMind account ID (change it to a valid account ID)
-GEOIPUPDATE_ACCOUNT_ID=xxx
-# MaxMind license key (change it to a valid license key)
-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-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
-# The path to the directory where geoipupdate will download the
-# database.
-GEOIP_DB_DIRECTORY=./explorer-api/geo_ip

.github/workflows/audit.yml

@@ -1,57 +1,36 @@
 name: Daily security audit
 
-on:
-  schedule:
-    - cron: '5 9 * * *'
+on: workflow_dispatch
 jobs:
-  cargo-deny:
-    runs-on: ubuntu-20.04
+  security_audit:
+    runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository code
-        uses: actions/checkout@v2
-      - name: Install rust toolchain
-        uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v1
+      - uses: actions-rs/audit-check@v1
         with:
-          toolchain: stable
-      - name: Install cargo deny
-        run: cargo install --locked cargo-deny
-      - name: Run cargo deny
-        run: |
-          find . -name Cargo.toml -exec cargo deny --manifest-path {} check \
-            advisories -A advisory-not-detected  --hide-inclusion-graph \; &> \
-            >(uniq  &> .github/workflows/support-files/notifications/deny.message )
-      - uses: actions/upload-artifact@v3
-        with:
-          name: report
-          path: .github/workflows/support-files/notifications/deny.message
+          token: ${{ secrets.GITHUB_TOKEN }}
+
   notification:
-    needs: cargo-deny
-    runs-on: custom-runner-linux
+    if: ${{ failure() }}
+    needs: security_audit
+    runs-on: ubuntu-latest
     steps:
       - name: Check out repository code
         uses: actions/checkout@v2
-      - name: Download report from previous job
-        uses: actions/download-artifact@v3
-        with:
-          name: report
-          path: .github/workflows/support-files/notifications
-      - name: install npm
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - name: Matrix - Node Install
+      - name: Keybase - Node Install
         run: npm install
         working-directory: .github/workflows/support-files
-      - name: Matrix - Send Notification
+      - name: Keybase - Send Notification
         env:
-          NYM_NOTIFICATION_KIND: security
-          NYM_PROJECT_NAME: "Daily security report"
+          NYM_NOTIFICATION_KIND: nightly
+          NYM_PROJECT_NAME: "Nym daily audit"
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_AUDIT }}"
-          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
+          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_NYMBTECH_TEAM }}"
+          KEYBASE_NYM_CHANNEL: "test"
         uses: docker://keybaseio/client:stable-node
         with:
           args: .github/workflows/support-files/notifications/entry_point.sh

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

@@ -1,121 +0,0 @@
-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 --all
-
-      - name: Install Rust stable
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          target: wasm32-unknown-unknown
-          override: true
-          components: rustfmt, clippy
-
-      - name: Install wasm-opt
-        run: cargo install --version 0.112.0 wasm-opt
-
-      - 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 target/release/credential $OUTPUT_DIR
-          cp target/release/explorer-api $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
-          cp contracts/target/wasm32-unknown-unknown/release/nym_coconut_bandwidth.wasm $OUTPUT_DIR
-          cp contracts/target/wasm32-unknown-unknown/release/nym_coconut_dkg.wasm $OUTPUT_DIR
-          cp contracts/target/wasm32-unknown-unknown/release/cw3_flex_multisig.wasm $OUTPUT_DIR
-          cp contracts/target/wasm32-unknown-unknown/release/cw4_group.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/"

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

@@ -1,59 +0,0 @@
-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

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

@@ -12,7 +12,6 @@ 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:
@@ -43,10 +42,10 @@ jobs:
         REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
         TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/ts-${{ env.GITHUB_REF_SLUG }}-example
         EXCLUDE: "/dist/, /node_modules/"
-    - name: Matrix - Node Install
+    - name: Keybase - Node Install
       run: npm install
       working-directory: .github/workflows/support-files
-    - name: Matrix - Send Notification
+    - name: Keybase - Send Notification
       env:
         NYM_NOTIFICATION_KIND: ts-packages
         NYM_PROJECT_NAME: "ts-packages"
@@ -54,12 +53,11 @@ jobs:
         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

.github/workflows/build.yml

@@ -2,44 +2,21 @@ name: Continuous integration
 
 on:
   push:
-    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/**'
+    paths-ignore:
+      - 'explorer/**'
   pull_request:
-    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/**'
+    paths-ignore:
+      - 'explorer/**'
 
 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
+        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
 
       - name: Check out repository code
         uses: actions/checkout@v2
@@ -52,46 +29,57 @@ 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:
           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
+          args: --workspace --all-features
 
       - 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 -- --ignored
+          args: --workspace --all-features -- --ignored
+
+      - name: Check formatting
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
 
       - uses: actions-rs/clippy-check@v1
         name: Clippy checks
-        continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --workspace
+          args: --workspace --all-features
 
       - name: Run clippy
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --workspace --all-targets -- -D warnings
+          args: --workspace -- -D warnings
+
+      - 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: --features=coconut -- -D warnings

.github/workflows/build_matrix_includes.json

@@ -1,6 +1,6 @@
 [
   {
-    "os":"ubuntu-20.04",
+    "os":"ubuntu-latest",
     "rust":"stable",
     "runOnEvent":"always"
   },

.github/workflows/build_on_dispatch.yml

@@ -0,0 +1,72 @@
+name: Continuous integration on dispatch
+
+on: workflow_dispatch
+
+jobs:
+  build:
+    runs-on: [ self-hosted, custom-linux ]
+    # 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 squashfs-tools
+
+      - name: Check out repository code
+        uses: actions/checkout@v2
+
+      - name: Install rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+
+      - name: Build all binaries
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --workspace
+
+      - name: Run all tests
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --workspace --all-features
+
+      - name: Check formatting
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
+      - uses: actions-rs/clippy-check@v1
+        name: Clippy checks
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --all-features
+
+      - name: Run clippy
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: --workspace -- -D warnings
+
+      - 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: --features=coconut -- -D warnings

.github/workflows/check-merge-conflicts.yml

@@ -1,61 +0,0 @@
-name: check-merge-conflicts
-
-# Check that the latest release branch merges into master and develop without
-# any conflicts that git is not able to resolve
-
-on:
-  workflow_dispatch:
-  schedule:
-    - cron: '5 6 * * *'
-
-jobs:
-  get_release:
-    runs-on: ubuntu-latest
-    outputs:
-      output1: ${{ steps.step2.outputs.latest_release }}
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set output variable to latest release branch
-        id: step2
-        run: echo "latest_release=$(git branch -r | grep -E 'release/v[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -n 1)" >> $GITHUB_OUTPUT
-
-  check-merge-release-into-master:
-    name: Check that the release branch merges into master
-    needs: get_release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Setup git user
-        run: |
-          git config --global user.name "ci"
-          git config --global user.email "ci@localhost"
-      - name: Check merge release branch into master
-        run: |
-          ./.github/workflows/support-files/git-merge-check.sh origin/master $branch1
-        env:
-          branch1: ${{needs.get_release.outputs.output1}}
-
-  check-merge-release-into-develop:
-    name: Check that the release branch merges into develop
-    needs: get_release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Setup git user
-        run: |
-          git config --global user.name "ci"
-          git config --global user.email "ci@localhost"
-      - name: Check merge release branch into develop
-        run: |
-          ./.github/workflows/support-files/git-merge-check.sh origin/develop $branch1
-        env:
-          branch1: ${{needs.get_release.outputs.output1}}

.github/workflows/ci-binary-checker.yml

@@ -1,56 +0,0 @@
-name: Run config checks on all binaries
-
-on:
-  workflow_dispatch:
-  release:
-    types: [created]
-  push:
-    paths:
-      - 'clients/**'
-      - 'common/**'
-      - 'contracts/**'
-      - 'integrations/**'
-      - 'mixnode/**'
-      - 'sdk/rust/nym-sdk/**'
-      - 'service-providers/**'
-  pull_request:
-    paths:
-      - 'clients/**'
-      - 'common/**'
-      - 'gateway/**'
-      - 'integrations/**'
-      - 'mixnode/**'
-      - 'sdk/rust/nym-sdk/**'
-      - 'service-providers/**'
-
-env:
-  NETWORK: mainnet
-
-jobs:
-  publish-nym:
-    strategy:
-      fail-fast: false
-      matrix:
-        platform: [custom-runner-linux]
-         
-    runs-on: ${{ matrix.platform }}
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Install Dependencies (Linux)
-        run: sudo apt-get update && sudo apt-get -y install jq vim 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: Branch name
-        run: echo running on branch ${GITHUB_REF##*/}
-                    
-      - name: Run tests against binaries
-        run: ./build_and_run.sh ${{ github.head_ref || github.ref_name }}
-        working-directory: tests/
-        
-      

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

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

.github/workflows/connect-desktop.yml

@@ -1,75 +0,0 @@
-name: Nym Connect - desktop (Rust)
-
-on:
-  push:
-    paths:
-      - "nym-connect/desktop/src-tauri/**"
-      - "nym-connect/desktop/src-tauri/Cargo.toml"
-      - "clients/client-core/**"
-      - "clients/socks5/**"
-      - "common/**"
-      - "gateway/gateway-requests/**"
-      - "contracts/vesting/**"
-      - "nym-api/nym-api-requests/**"
-  pull_request:
-    paths:
-      - "nym-connect/desktop/src-tauri/**"
-      - "nym-connect/desktop/src-tauri/Cargo.toml"
-      - "clients/client-core/**"
-      - "clients/socks5/**"
-      - "common/**"
-      - "gateway/gateway-requests/**"
-      - "contracts/vesting/**"
-      - "nym-api/nym-api-requests/**"
-
-jobs:
-  build:
-    runs-on: [self-hosted, custom-linux]
-    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 squashfs-tools libayatana-appindicator3-dev
-        continue-on-error: true
-
-      - name: Check out repository code
-        uses: actions/checkout@v2
-
-      - name: Install rust toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-          components: rustfmt, clippy
-
-      - name: Build all binaries
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --manifest-path nym-connect/desktop/Cargo.toml --workspace
-
-      - name: Run all tests
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --manifest-path nym-connect/desktop/Cargo.toml --workspace
-
-      - name: Check formatting
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --manifest-path nym-connect/desktop/Cargo.toml --all -- --check
-
-      - uses: actions-rs/clippy-check@v1
-        name: Clippy checks
-        continue-on-error: true
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --manifest-path nym-connect/desktop/Cargo.toml --workspace --all-features
-
-      - name: Run clippy
-        uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: --manifest-path nym-connect/desktop/Cargo.toml --workspace --all-features -- -D warnings

.github/workflows/connect-mobile.yml

@@ -1,72 +0,0 @@
-name: Nym Connect - mobile (Rust)
-
-on:
-  push:
-    paths:
-      - "nym-connect/mobile/src-tauri/**"
-      - "nym-connect/mobile/src-tauri/Cargo.toml"
-      - "!nym-connect/mobile/src-tauri/gen/**"
-      - "clients/client-core/**"
-      - "clients/socks5/**"
-      - "common/**"
-      - "gateway/gateway-requests/**"
-      - "contracts/vesting/**"
-      - "nym-api/nym-api-requests/**"
-  pull_request:
-    paths:
-      - "nym-connect/mobile/src-tauri/**"
-      - "nym-connect/mobile/src-tauri/Cargo.toml"
-      - "!nym-connect/mobile/src-tauri/gen/**"
-      - "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/mobile/src-tauri/
-    steps:
-      - name: Install Dependencies (Linux)
-        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
-
-      - 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/mobile/src-tauri/Cargo.toml -- --check
-
-      - name: Build all binaries
-        run: cargo build --manifest-path nym-connect/mobile/src-tauri/Cargo.toml
-
-      - name: Run all tests
-        run: cargo test  --manifest-path nym-connect/mobile/src-tauri/Cargo.toml
-
-      - name: Clippy
-        run: cargo clippy --manifest-path nym-connect/mobile/src-tauri/Cargo.toml --all-targets -- -D warnings

.github/workflows/connect.yml

@@ -0,0 +1,56 @@
+name: Nym Connect (rust)
+
+on:
+  push:
+    paths-ignore:
+      - 'explorer/**'
+
+jobs:
+  build:
+    runs-on: [ self-hosted, custom-linux ]
+    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 squashfs-tools libayatana-appindicator3-dev
+
+      - name: Check out repository code
+        uses: actions/checkout@v2
+
+      - name: Install rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+
+      - name: Build all binaries
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --manifest-path nym-connect/Cargo.toml --workspace
+
+      - name: Run all tests
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --manifest-path nym-connect/Cargo.toml --workspace
+
+      - name: Check formatting
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --manifest-path nym-connect/Cargo.toml --all -- --check
+
+      - uses: actions-rs/clippy-check@v1
+        name: Clippy checks
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --manifest-path nym-connect/Cargo.toml --workspace --all-features
+
+      - name: Run clippy
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: --manifest-path nym-connect/Cargo.toml --workspace --all-features -- -D warnings

.github/workflows/contracts-build.yml

@@ -1,16 +1,17 @@
 name: Build release of Nym smart contracts
 on:
   workflow_dispatch:
-  release:
-    types: [created]
+
+defaults:
+  run:
+    working-directory: contracts
 
 jobs:
   build:
-    if: ${{ (startsWith(github.ref, 'refs/tags/nym-contracts-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
-    runs-on: [self-hosted, custom-runner-linux]
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      
+
       - name: Install Rust stable
         uses: actions-rs/toolchain@v1
         with:
@@ -19,11 +20,8 @@ jobs:
           override: true
           components: rustfmt, clippy
 
-      - name: Install wasm-opt
-        run: cargo install --version 0.112.0 wasm-opt
-
       - name: Build release contracts
-        run: make wasm
+        run: RUSTFLAGS='-C link-arg=-s' cargo build --release --target wasm32-unknown-unknown
 
       - name: Upload Mixnet Contract Artifact
         uses: actions/upload-artifact@v3
@@ -38,11 +36,3 @@ jobs:
           name: vesting_contract.wasm
           path: contracts/target/wasm32-unknown-unknown/release/vesting_contract.wasm
           retention-days: 5
-
-      - name: Upload to release based on tag name
-        uses: softprops/action-gh-release@v1
-        if: github.event_name == 'release'
-        with:
-          files: |
-            contracts/target/wasm32-unknown-unknown/release/vesting_contract.wasm
-            contracts/target/wasm32-unknown-unknown/release/mixnet_contract.wasm

.github/workflows/contracts.yml

@@ -2,17 +2,15 @@ name: Contracts
 
 on:
   push:
-    paths:
-      - 'contracts/**'
-      - 'common/**'
+    paths-ignore:
+      - 'explorer/**'
   pull_request:
     paths-ignore:
-      - 'contracts/**'
-      - 'common/**'
+      - 'explorer/**'
 
 jobs:
   matrix_prep:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
@@ -26,7 +24,7 @@ jobs:
   contracts:
     # since it's going to be compiled into wasm, there's absolutely
     # no point in running CI on different OS-es
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.rust == 'nightly' }}
     needs: matrix_prep
     strategy:

.github/workflows/network-explorer.yml

@@ -17,7 +17,6 @@ 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:
@@ -57,10 +56,10 @@ jobs:
         REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
         TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/ne-sb-${{ env.GITHUB_REF_SLUG }}
         EXCLUDE: "/dist/, /node_modules/"
-    - name: Matrix - Node Install
+    - name: Keybase - Node Install
       run: npm install
       working-directory: .github/workflows/support-files
-    - name: Matrix - Send Notification
+    - name: Keybase - Send Notification
       env:
         NYM_NOTIFICATION_KIND: network-explorer
         NYM_PROJECT_NAME: "Network Explorer"
@@ -69,12 +68,11 @@ jobs:
         NYM_CI_WWW_LOCATION_STORYBOOK: "ne-sb-${{ 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-network-explorer"
         IS_SUCCESS: "${{ job.status == 'success' }}"
-        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
-        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
       uses: docker://keybaseio/client:stable-node
       with:
         args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/nightly_build.yml

@@ -5,12 +5,12 @@ on:
     - cron: '14 1 * * *'
 jobs:
   matrix_prep:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
       # creates the matrix strategy from nightly_build_matrix_includes.json
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - id: set-matrix
         uses: JoshuaTheMiller/conditional-build-matrix@main
         with:
@@ -24,12 +24,11 @@ jobs:
     continue-on-error: ${{ matrix.rust == 'nightly' || matrix.rust == 'beta' || matrix.rust == 'stable' }}
     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'
+        run: sudo apt-get update && sudo apt-get install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools
+        if: matrix.os == 'ubuntu-latest'
 
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2
 
       - name: Install rust toolchain
         uses: actions-rs/toolchain@v1
@@ -39,45 +38,21 @@ 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:
           command: build
           args: --workspace
 
-      - name: Reclaim some disk space
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
-        with:
-          command: clean
-
-      - name: Build all examples
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --workspace --examples
-
-      - name: Reclaim some disk space
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
-        with:
-          command: clean
-
       - name: Run all tests
         uses: actions-rs/cargo@v1
         with:
           command: test
           args: --workspace
 
-      - name: Reclaim some disk space
+      - name: Reclaim some disk space (because Windows is being annoying)
         uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
+        if: ${{ matrix.os == 'windows-latest' }}
         with:
           command: clean
 
@@ -86,20 +61,25 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --workspace -- --ignored
+          args: --workspace --all-features -- --ignored
 
-      - name: Reclaim some disk space
+      - name: Check formatting
         uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
+        with:
+          command: fmt
+          args: --all -- --check
+
+      - name: Reclaim some disk space (because Windows is being annoying)
+        uses: actions-rs/cargo@v1
+        if: ${{ matrix.os == 'windows-latest' }}
         with:
           command: clean
 
       - uses: actions-rs/clippy-check@v1
         name: Clippy checks
-        continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --workspace
+          args: --all-features
 
       - name: Run clippy
         uses: actions-rs/cargo@v1
@@ -110,10 +90,36 @@ jobs:
 
       - name: Reclaim some disk space
         uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
+        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-latest' }}
         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: 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
@@ -142,22 +148,17 @@ jobs:
 
   notification:
     needs: build
-    runs-on: custom-runner-linux
+    runs-on: ubuntu-latest
     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: Matrix - Node Install
+        uses: actions/checkout@v2
+      - name: Keybase - Node Install
         if: env.WORKFLOW_CONCLUSION == 'failure'
         run: npm install
         working-directory: .github/workflows/support-files
-      - name: Matrix - Send Notification
+      - name: Keybase - Send Notification
         if: env.WORKFLOW_CONCLUSION == 'failure'
         env:
           NYM_NOTIFICATION_KIND: nightly
@@ -165,12 +166,11 @@ jobs:
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           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-nightly"
           IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
-          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_NIGHTLY }}"
-          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
         uses: docker://keybaseio/client:stable-node
         with:
           args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/nightly_build_matrix_includes.json

@@ -1,6 +1,6 @@
 [
   {
-    "os":"ubuntu-20.04",
+    "os":"ubuntu-latest",
     "rust":"stable",
     "runOnEvent":"schedule"
   },
@@ -17,7 +17,7 @@
   },
 
   {
-    "os":"ubuntu-20.04",
+    "os":"ubuntu-latest",
     "rust":"beta",
     "runOnEvent":"schedule"
   },
@@ -33,7 +33,7 @@
   },
 
   {
-    "os":"ubuntu-20.04",
+    "os":"ubuntu-latest",
     "rust":"nightly",
     "runOnEvent":"schedule"
   },

.github/workflows/nightly_build_matrix_on_dispatch.json

@@ -0,0 +1,50 @@
+[
+  {
+    "os":"ubuntu-latest",
+    "rust":"stable",
+    "runOnEvent":"workflow_dispatch"
+  },
+
+  {
+    "os":"windows-latest",
+    "rust":"stable",
+    "runOnEvent":"workflow_dispatch"
+  },
+  {
+    "os":"macos-latest",
+    "rust":"stable",
+    "runOnEvent":"workflow_dispatch"
+  },
+
+  {
+    "os":"ubuntu-latest",
+    "rust":"beta",
+    "runOnEvent":"workflow_dispatch"
+  },
+  {
+    "os":"windows-latest",
+    "rust":"beta",
+    "runOnEvent":"workflow_dispatch"
+  },
+  {
+    "os":"macos-latest",
+    "rust":"beta",
+    "runOnEvent":"workflow_dispatch"
+  },
+
+  {
+    "os":"ubuntu-latest",
+    "rust":"nightly",
+    "runOnEvent":"workflow_dispatch"
+  },
+  {
+    "os":"windows-latest",
+    "rust":"nightly",
+    "runOnEvent":"workflow_dispatch"
+  },
+  {
+    "os":"macos-latest",
+    "rust":"nightly",
+    "runOnEvent":"workflow_dispatch"
+  }
+]

.github/workflows/nightly_build_on_dispatch.yml

@@ -1,50 +1,32 @@
-name: Nightly builds on second latest release
+name: Nightly builds on dispatch
 
-on:
-  schedule:
-    - cron: '24 2 * * *'
+on: workflow_dispatch
 jobs:
   matrix_prep:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
       # creates the matrix strategy from nightly_build_matrix_includes.json
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - id: set-matrix
         uses: JoshuaTheMiller/conditional-build-matrix@main
         with:
-          inputFile: '.github/workflows/nightly_build_matrix_includes.json'
+          inputFile: '.github/workflows/nightly_build_matrix_on_dispatch.json'
           filter: '[?runOnEvent==`${{ github.event_name }}` || runOnEvent==`always`]'
-  get_release:
-    runs-on: ubuntu-20.04
-    needs: matrix_prep
-    outputs:
-      output1: ${{ steps.step2.outputs.latest_release }}
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v3
-      - name: Fetch all branches
-        run: git fetch --all
-      - name: Set output variable to latest release branch
-        id: step2
-        run: echo "latest_release=$(git branch -r | grep -E 'release/v[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -n 2 | head -n 1 | sed 's/  origin\///')" >> $GITHUB_OUTPUT
   build:
-    needs: [get_release,matrix_prep]
+    needs: matrix_prep
     strategy:
       matrix: ${{fromJson(needs.matrix_prep.outputs.matrix)}}
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.rust == 'nightly' || matrix.rust == 'beta' || matrix.rust == 'stable' }}
     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'
+        run: sudo apt-get update && sudo apt-get install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools
+        if: matrix.os == 'ubuntu-latest'
 
-      - name: Check out latest release branch
-        uses: actions/checkout@v3
-        with:
-          ref: ${{needs.get_release.outputs.output1}}
+      - name: Check out repository code
+        uses: actions/checkout@v2
 
       - name: Install rust toolchain
         uses: actions-rs/toolchain@v1
@@ -54,36 +36,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:
           command: build
           args: --workspace
 
-      - name: Reclaim some disk space (because Windows is being annoying)
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' }}
-        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:
@@ -92,7 +50,7 @@ jobs:
 
       - name: Reclaim some disk space (because Windows is being annoying)
         uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
+        if: ${{ matrix.os == 'windows-latest' }}
         with:
           command: clean
 
@@ -101,7 +59,13 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --workspace -- --ignored
+          args: --workspace --all-features -- --ignored
+
+      - name: Check formatting
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
 
       - name: Reclaim some disk space (because Windows is being annoying)
         uses: actions-rs/cargo@v1
@@ -111,10 +75,9 @@ jobs:
 
       - uses: actions-rs/clippy-check@v1
         name: Clippy checks
-        continue-on-error: true
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --workspace
+          args: --all-features
 
       - name: Run clippy
         uses: actions-rs/cargo@v1
@@ -125,10 +88,36 @@ jobs:
 
       - name: Reclaim some disk space
         uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
+        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-latest' }}
         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: 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
@@ -156,36 +145,30 @@ jobs:
           args: --manifest-path nym-wallet/Cargo.toml --workspace --all-targets -- -D warnings
 
   notification:
-    needs: [build,get_release]
-    runs-on: custom-runner-linux
+    needs: build
+    runs-on: ubuntu-latest
     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: Matrix - Node Install
+        uses: actions/checkout@v2
+      - name: Keybase - Node Install
         if: env.WORKFLOW_CONCLUSION == 'failure'
         run: npm install
         working-directory: .github/workflows/support-files
-      - name: Matrix - Send Notification
+      - name: Keybase - Send Notification
         if: env.WORKFLOW_CONCLUSION == 'failure'
         env:
           NYM_NOTIFICATION_KIND: nightly
-          NYM_PROJECT_NAME: "Nym nightly build on latest release"
+          NYM_PROJECT_NAME: "Nym nightly build"
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
-          GIT_BRANCH_NAME: "${{needs.get_release.outputs.output1}}"
+          GIT_BRANCH: "${GITHUB_REF##*/}"
+          KEYBASE_NYMBOT_USERNAME: "${{ secrets.KEYBASE_NYMBOT_USERNAME }}"
+          KEYBASE_NYMBOT_PAPERKEY: "${{ secrets.KEYBASE_NYMBOT_PAPERKEY }}"
+          KEYBASE_NYMBOT_TEAM: "${{ secrets.KEYBASE_NYMTECH_TEAM }}"
+          KEYBASE_NYM_CHANNEL: "test"
           IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
-          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_NIGHTLY }}"
-          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
         uses: docker://keybaseio/client:stable-node
         with:
           args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/nightly_build_release.yml

@@ -1,191 +0,0 @@
-name: Nightly builds on latest release
-
-on:
-  schedule:
-    - cron: '14 2 * * *'
-jobs:
-  matrix_prep:
-    runs-on: ubuntu-20.04
-    outputs:
-      matrix: ${{ steps.set-matrix.outputs.matrix }}
-    steps:
-      # creates the matrix strategy from nightly_build_matrix_includes.json
-      - uses: actions/checkout@v3
-      - id: set-matrix
-        uses: JoshuaTheMiller/conditional-build-matrix@main
-        with:
-          inputFile: '.github/workflows/nightly_build_matrix_includes.json'
-          filter: '[?runOnEvent==`${{ github.event_name }}` || runOnEvent==`always`]'
-  get_release:
-    runs-on: ubuntu-20.04
-    needs: matrix_prep
-    outputs:
-      output1: ${{ steps.step2.outputs.latest_release }}
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v3
-      - name: Fetch all branches
-        run: git fetch --all
-      - name: Set output variable to latest release branch
-        id: step2
-        run: echo "latest_release=$(git branch -r | grep -E 'release/v[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -n 1 | sed 's/  origin\///')" >> $GITHUB_OUTPUT
-  build:
-    needs: [get_release,matrix_prep]
-    strategy:
-      matrix: ${{fromJson(needs.matrix_prep.outputs.matrix)}}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.rust == 'nightly' || matrix.rust == 'beta' || matrix.rust == 'stable' }}
-    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
-        uses: actions/checkout@v3
-        with:
-          ref: ${{needs.get_release.outputs.output1}}
-
-      - name: Install rust toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: ${{ matrix.rust }}
-          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:
-          command: build
-          args: --workspace
-
-      - name: Reclaim some disk space
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
-        with:
-          command: clean
-
-      - name: Build all examples
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --workspace --examples
-
-      - name: Reclaim some disk space
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
-        with:
-          command: clean
-
-      - name: Run all tests
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --workspace
-
-      - name: Reclaim some disk space
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
-        with:
-          command: clean
-
-      - 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 -- --ignored
-
-      - name: Reclaim some disk space
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
-        with:
-          command: clean
-
-      - uses: actions-rs/clippy-check@v1
-        name: Clippy checks
-        continue-on-error: true
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --workspace
-
-      - name: Run clippy
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.rust != 'nightly' }}
-        with:
-          command: clippy
-          args: --workspace --all-targets -- -D warnings
-
-      - name: Reclaim some disk space
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.os == 'windows-latest' || matrix.os == 'ubuntu-20.04' }}
-        with:
-          command: clean
-
-      # nym-wallet (the rust part)
-      - name: Build nym-wallet rust code
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --manifest-path nym-wallet/Cargo.toml --workspace
-
-      - name: Run nym-wallet tests
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --manifest-path nym-wallet/Cargo.toml --workspace
-
-      - name: Check nym-wallet formatting
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --manifest-path nym-wallet/Cargo.toml --all -- --check
-
-      - name: Run clippy for nym-wallet
-        uses: actions-rs/cargo@v1
-        if: ${{ matrix.rust != 'nightly' }}
-        with:
-          command: clippy
-          args: --manifest-path nym-wallet/Cargo.toml --workspace --all-targets -- -D warnings
-
-  notification:
-    needs: [build,get_release]
-    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: Matrix - Node Install
-        if: env.WORKFLOW_CONCLUSION == 'failure'
-        run: npm install
-        working-directory: .github/workflows/support-files
-      - name: Matrix - Send Notification
-        if: env.WORKFLOW_CONCLUSION == 'failure'
-        env:
-          NYM_NOTIFICATION_KIND: nightly
-          NYM_PROJECT_NAME: "Nym nightly build on latest release"
-          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-          GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
-          GIT_BRANCH_NAME: "${{needs.get_release.outputs.output1}}"
-          IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
-          MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-          MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_NIGHTLY }}"
-          MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-          MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-          MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
-        uses: docker://keybaseio/client:stable-node
-        with:
-          args: .github/workflows/support-files/notifications/entry_point.sh

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

@@ -0,0 +1,50 @@
+name: Publish Nym CLI binaries
+
+on:
+  workflow_dispatch:
+  release:
+    types: [created]
+    
+env:
+  NETWORK: mainnet
+
+jobs:
+  publish-nym-cli:
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest, windows-latest, macos-latest]
+
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - 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: |
+            core.setFailed('Release tag did not start with nym-cli-...')
+
+      - name: Install Rust stable
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+
+      - name: Build binary
+        run: make build-nym-cli
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: nym-cli-${{ matrix.platform }}
+          path: |
+            target/release/nym-cli*
+          retention-days: 30
+
+      - name: Upload to release based on tag name
+        uses: softprops/action-gh-release@v1
+        if: github.event_name == 'release'
+        with:
+          files: |
+            target/release/nym-cli

.github/workflows/nym-connect-publish-macos.yml

@@ -1,4 +1,4 @@
-name: Publish Nym Connect - desktop (MacOS)
+name: Publish Nym Connect (MacOS)
 on:
   workflow_dispatch:
   release:
@@ -6,11 +6,10 @@ on:
 
 defaults:
   run:
-    working-directory: nym-connect/desktop
+    working-directory: nym-connect
 
 jobs:
   publish-tauri:
-    if: ${{ (startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
     strategy:
       fail-fast: false
       matrix:
@@ -20,6 +19,13 @@ 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:
@@ -73,7 +79,7 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: nym-connect_1.0.0_x64.dmg
-          path: nym-connect/desktop/target/release/bundle/dmg/nym-connect_1.0.0_x64.dmg
+          path: nym-connect/target/release/bundle/dmg/nym-connect_1.0.0_x64.dmg
           retention-days: 30
 
       - name: Clean up keychain
@@ -86,5 +92,5 @@ jobs:
         if: github.event_name == 'release'
         with:
           files: |
-            nym-connect/desktop/target/release/bundle/dmg/*.dmg
-            nym-connect/desktop/target/release/bundle/macos/*.app.tar.gz*
+            nym-connect/target/release/bundle/dmg/*.dmg
+            nym-connect/target/release/bundle/macos/*.app.tar.gz*

.github/workflows/nym-connect-publish-ubuntu.yml

@@ -1,4 +1,4 @@
-name: Publish Nym Connect - desktop (Ubuntu)
+name: Publish Nym Connect (Ubuntu)
 on:
   workflow_dispatch:
   release:
@@ -6,15 +6,14 @@ on:
 
 defaults:
   run:
-    working-directory: nym-connect/desktop
+    working-directory: nym-connect
 
 jobs:
   publish-tauri:
-    if: ${{ (startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
     strategy:
       fail-fast: false
       matrix:
-        platform: [custom-runner-linux]
+        platform: [ubuntu-latest]
 
     runs-on: ${{ matrix.platform }}
     steps:
@@ -24,13 +23,17 @@ jobs:
         run: >
           sudo apt-get update &&
           sudo apt-get install -y webkit2gtk-4.0 libayatana-appindicator3-dev
-        continue-on-error: true
+      - 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:
           node-version: 16
-
       - name: Install Rust stable
         uses: actions-rs/toolchain@v1
         with:
@@ -53,7 +56,7 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: nym-connect.AppImage.tar.gz
-          path: nym-connect/desktop/target/release/bundle/appimage/nym-connect_1.0.0_amd64.AppImage
+          path: nym-connect/target/release/bundle/appimage/nym-connect_1.0.0_amd64.AppImage
           retention-days: 30
 
       - name: Upload to release based on tag name
@@ -61,5 +64,5 @@ jobs:
         if: github.event_name == 'release'
         with:
           files: |
-            nym-connect/desktop/target/release/bundle/appimage/*.AppImage
-            nym-connect/desktop/target/release/bundle/appimage/*.AppImage.tar.gz*
+            nym-connect/target/release/bundle/appimage/*.AppImage
+            nym-connect/target/release/bundle/appimage/*.AppImage.tar.gz*

.github/workflows/nym-connect-publish-windows10.yml

@@ -1,4 +1,4 @@
-name: Publish Nym Connect - desktop (Windows 10)
+name: Publish Nym Connect (Windows 10)
 on:
   workflow_dispatch:
   release:
@@ -6,11 +6,10 @@ on:
 
 defaults:
   run:
-    working-directory: nym-connect/desktop
+    working-directory: nym-connect
 
 jobs:
   publish-tauri:
-    if: ${{ (startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
     strategy:
       fail-fast: false
       matrix:
@@ -28,6 +27,13 @@ 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 }}
@@ -56,7 +62,7 @@ jobs:
           encodedString: ${{ secrets.WALLET_ADMIN_ADDRESS }}
 
       - name: Install app dependencies
-        run: yarn --network-timeout 100000
+        run: yarn
 
       - name: Build and sign it
         env:
@@ -72,7 +78,7 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: nym-connect_1.0.0_x64_en-US.msi
-          path: nym-connect/desktop/target/release/bundle/msi/nym-connect_1.0.0_x64_en-US.msi
+          path: nym-connect/target/release/bundle/msi/nym-connect_1.0.0_x64_en-US.msi
           retention-days: 30
 
       - name: Upload to release based on tag name
@@ -80,5 +86,5 @@ jobs:
         if: github.event_name == 'release'
         with:
           files: |
-            nym-connect/desktop/target/release/bundle/msi/*.msi
-            nym-connect/desktop/target/release/bundle/msi/*.msi.zip*
+            nym-connect/target/release/bundle/msi/*.msi
+            nym-connect/target/release/bundle/msi/*.msi.zip*

.github/workflows/nym-connect.yml

@@ -1,13 +1,13 @@
-name: CI for nym-connect - Desktop
+name: CI for nym-connect
 
 on:
   push:
     paths:
-      - 'nym-connect/desktop/**'
+      - 'nym-connect/**'
 
 defaults:
   run:
-    working-directory: nym-connect/desktop
+    working-directory: nym-connect
 
 jobs:
   build:
@@ -16,7 +16,6 @@ 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:
@@ -34,28 +33,27 @@ jobs:
       env:
         SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
         ARGS: "-rltgoDzvO --delete"
-        SOURCE: "nym-connect/desktop/storybook-static/"
+        SOURCE: "nym-connect/storybook-static/"
         REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
         REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
         TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/nym-connect-${{ env.GITHUB_REF_SLUG }}
         EXCLUDE: "/dist/, /node_modules/"
-    - name: Matrix - Node Install
+    - name: Keybase - Node Install
       run: npm install
       working-directory: .github/workflows/support-files
-    - name: Matrix - Send Notification
-      env:
-        NYM_NOTIFICATION_KIND: nym-connect
-        NYM_PROJECT_NAME: "nym-connect"
-        NYM_CI_WWW_BASE: "${{ secrets.NYM_CI_WWW_BASE }}"
-        NYM_CI_WWW_LOCATION: "nym-connect-${{ env.GITHUB_REF_SLUG }}"
-        GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
-        GIT_BRANCH: "${GITHUB_REF##*/}"
-        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
+#    - name: Keybase - Send Notification
+#      env:
+#        NYM_NOTIFICATION_KIND: nym-connect
+#        NYM_PROJECT_NAME: "nym-connect"
+#        NYM_CI_WWW_BASE: "${{ secrets.NYM_CI_WWW_BASE }}"
+#        NYM_CI_WWW_LOCATION: "nym-connect-${{ 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-nym-connect"
+#        IS_SUCCESS: "${{ job.status == 'success' }}"
+#      uses: docker://keybaseio/client:stable-node
+#      with:
+#        args: .github/workflows/support-files/notifications/entry_point.sh

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

@@ -2,12 +2,6 @@ name: Publish Nym binaries
 
 on:
   workflow_dispatch:
-    inputs:  
-      add_tokio_unstable:
-        description: 'True to add RUSTFLAGS="--cfg tokio_unstable"'
-        required: true
-        default: false
-        type: boolean 
   release:
     types: [created]
     
@@ -16,24 +10,21 @@ env:
 
 jobs:
   publish-nym:
-    if: ${{ (startsWith(github.ref, 'refs/tags/nym-binaries-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
     strategy:
       fail-fast: false
       matrix:
-        platform: [custom-runner-linux]
+        platform: [ubuntu-latest]
 
     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: 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-...')
 
       - name: Install Rust stable
         uses: actions-rs/toolchain@v1
@@ -51,12 +42,11 @@ 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-api
+            target/release/nym-validator-api
             target/release/nym-network-requester
             target/release/nym-network-statistics
             target/release/nym-cli
@@ -67,12 +57,11 @@ 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-api
+            target/release/nym-validator-api
             target/release/nym-network-requester
             target/release/nym-network-statistics
             target/release/nym-cli

.github/workflows/nym-wallet-publish-macos.yml

@@ -10,7 +10,6 @@ defaults:
 
 jobs:
   publish-tauri:
-    if: ${{ (startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
     strategy:
       fail-fast: false
       matrix:
@@ -20,6 +19,13 @@ 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:

.github/workflows/nym-wallet-publish-ubuntu.yml

@@ -9,11 +9,10 @@ defaults:
 
 jobs:
   publish-tauri:
-    if: ${{ (startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
     strategy:
       fail-fast: false
       matrix:
-        platform: [custom-runner-linux]
+        platform: [ubuntu-latest]
 
     runs-on: ${{ matrix.platform }}
     steps:
@@ -23,13 +22,17 @@ jobs:
         run: >
           sudo apt-get update &&
           sudo apt-get install -y webkit2gtk-4.0
-        continue-on-error: true
+      - 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: Node v16
         uses: actions/setup-node@v3
         with:
           node-version: 16
-
       - name: Install Rust stable
         uses: actions-rs/toolchain@v1
         with:

.github/workflows/nym-wallet-publish-windows10.yml

@@ -1,6 +1,5 @@
 name: Publish Nym Wallet (Windows 10)
 on:
-  workflow_dispatch:
   release:
     types: [created]
 
@@ -10,7 +9,6 @@ defaults:
 
 jobs:
   publish-tauri:
-    if: ${{ (startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
     strategy:
       fail-fast: false
       matrix:
@@ -28,6 +26,13 @@ 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 }}
@@ -56,7 +61,7 @@ jobs:
           encodedString: ${{ secrets.WALLET_ADMIN_ADDRESS }}
 
       - name: Install app dependencies
-        run: yarn --network-timeout 100000
+        run: yarn
 
       - name: Build and sign it
         env:
@@ -68,16 +73,8 @@ jobs:
           TAURI_KEY_PASSWORD: ${{ secrets.TAURI_KEY_PASSWORD }}
         run: yarn build
 
-      - name: Upload Artifact
-        uses: actions/upload-artifact@v3
-        with:
-          name: nym-wallet_1.0.0_x64_en-US.msi
-          path: nym-wallet/target/release/bundle/msi/nym-wallet_1.*.msi
-          retention-days: 30
-
       - name: Upload to release based on tag name
         uses: softprops/action-gh-release@v1
-        if: github.event_name == 'release'
         with:
           files: |
             nym-wallet/target/release/bundle/msi/*.msi

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

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        platform: [ubuntu-20.04]
+        platform: [ubuntu-latest]
     runs-on: ${{ matrix.platform }}
     steps:
       - uses: actions/checkout@v2

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

@@ -12,7 +12,6 @@ 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:
@@ -35,10 +34,10 @@ jobs:
         REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
         TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/wallet-${{ env.GITHUB_REF_SLUG }}
         EXCLUDE: "/dist/, /node_modules/"
-    - name: Matrix - Node Install
+    - name: Keybase - Node Install
       run: npm install
       working-directory: .github/workflows/support-files
-    - name: Matrix - Send Notification
+    - name: Keybase - Send Notification
       env:
         NYM_NOTIFICATION_KIND: nym-wallet
         NYM_PROJECT_NAME: "nym-wallet"
@@ -46,12 +45,11 @@ jobs:
         NYM_CI_WWW_LOCATION: "wallet-${{ 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-nym-wallet"
         IS_SUCCESS: "${{ job.status == 'success' }}"
-        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
-        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
       uses: docker://keybaseio/client:stable-node
       with:
         args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/nym_wallet.yml

@@ -12,7 +12,7 @@ defaults:
 jobs:
   test:
     name: wallet tests
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
 
@@ -26,7 +26,6 @@ jobs:
           libappindicator3-dev
           webkit2gtk-driver
           xvfb
-        continue-on-error: true
 
       - name: Install minimal stable
         uses: actions-rs/toolchain@v1

.github/workflows/run-api-tests.yml

@@ -1,36 +0,0 @@
-name: CI for Nym API Tests
-
-on:
-  workflow_dispatch:
-  push:
-    paths:
-      - "nym-api/**"
-
-defaults:
-  run:
-    working-directory: nym-api/tests
-
-jobs:
-  test:
-    name: nym-api tests
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      
-      - name: Install npm
-        run: npm install
-        
-      - name: Node v18
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18.1.0
-
-      - name: Install yarn
-        run: yarn install
-
-      - name: Run yarn
-        run: yarn
-
-      - name: Run tests
-        run: yarn test:qa
-        working-directory: nym-api/tests

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

@@ -1,9 +1,6 @@
-MATRIX_SERVER=
-MATRIX_ROOM=
-MATRIX_ROOM_OF_SHAME=
-MATRIX_USER_ID=
-MATRIX_TOKEN=
-MATRIX_DEVICE_ID=
+KEYBASE_NYM_CHANNEL=
+KEYBASE_NYMBOT_USERNAME=
+KEYBASE_NYMBOT_PAPERKEY=
 
 NYM_NOTIFICATION_KIND=nightly
 NYM_PROJECT_NAME=Nightly Build
@@ -35,4 +32,4 @@ NYM_CI_WWW_BASE=example.com
 # Nightly builds
 WORKFLOW_CONCLUSION=success
 
-SHOW_DEBUG=true
+SHOW_DEBUG=true

.github/workflows/support-files/.gitignore

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

.github/workflows/support-files/README.md

@@ -4,7 +4,7 @@ This is a collection of scripts and files to support GitHub Actions.
 
 ## Sending Notifications
 
-These scripts send CI notifications to Matrix by creating messages from templates and env vars passed from GitHub Actions.
+These scripts send CI notifications to Keybase by creating messages from templates and env vars passed from GitHub Actions.
 
 ### Adding notifications to a GitHub Action
 
@@ -19,11 +19,10 @@ jobs:
       env:
         NYM_NOTIFICATION_KIND: "my-component"
         GIT_BRANCH: "${GITHUB_REF##*/}"
-        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 }}"
+        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-network-explorer"
         IS_SUCCESS: "${{ job.status == 'success' }}"
       uses: docker://keybaseio/client:stable-node
       with:
@@ -35,8 +34,8 @@ Notifications are run by adding the snippet above to a GitHub Action, and:
 1. Installing node packages needed at run time
 2. Set the env vars as required:
     - `NYM_NOTIFICATION_KIND` matches the directory in `.github/workflows/support-files/${NYM_NOTIFICATION_KIND}` to provide the templates and extra scripting in `index.js`
-    - Matrix credentials, room and other env vars for the status of the build and repo
-3. Replacing the default entry point shell script on the `keybaseio/client:stable-node` docker image to run `.github/workflows/support-files/notifications/entry_point.sh`
+    - Keybase credentials, channel and other env vars for the status of the build and repo
+3. Replacing the default entry point shell script on the `keybaseio/client:stable-node` docker image to run `.github/workflows/support-files/notifications/entry_point.sh` 
 
 ### Running locally
 
@@ -44,7 +43,7 @@ You will need:
 - Node 16 LTS
 - npm
 
-Copy `.github/workflows/support-files/.env.example` to `.github/workflows/support-files/.env` and valid Matrix credentials.
+Copy `.github/workflows/support-files/.env.example` to `.github/workflows/support-files/.env` and valid Keybase credentials.
 
 Then run `npm install` to get dependencies.
 
@@ -56,4 +55,4 @@ npm install
 cp .env.example .env
 vi .env
 npm run dev
-```
+```

.github/workflows/support-files/git-merge-check.sh

@@ -1,62 +0,0 @@
-#!/usr/bin/env bash
-
-#
-# Basic usage:
-#   ./git-merge-check origin/develop origin/release/v1.1.9
-#
-
-set -x
-
-set -o nounset
-set -o pipefail
-
-# Start from branch ...
-branch1=$1
-
-# ... and try to merge in
-branch2=$2
-
-echo "Checking if $branch2 merges without conflicts into $branch1..."
-
-git checkout -q $branch1 || exit 1
-
-# There are two options here as far as I see on what we should check for. Either
-#
-#  (A) check for CONFLICT in any file except whitelist (such as .lock files)
-#  (B) check for "Automatic merge failed"
-#
-# Both of these options have drawbacks.
-#
-# The first (A) has the problem in that maybe we don't want to fail if the
-# changes can be automatically merged (duh), but at least we are not pestered
-# about constant lock file changes.
-# The second (B) has the problem that it's difficult to filter out automatic
-# merge fails for files we don't care about (.lock files).
-#
-# The ideal solution would be to check for automatic merge fails for files
-# except those on a whitelist (e.g. lock files).
-
-# For now I choose to use (B) here, because I hope it might be less noisy
-
-# Alternative A
-#output=$(git merge --no-commit --no-ff $branch2 | grep -v .lock)
-#merge_failed=$(echo $output | grep -v "CONFLICT")
-#return_code=$?
-
-# Alternative B
-output=$(git merge --no-commit --no-ff $branch2)
-merge_failed=$(echo $output | grep -v "Automatic merge failed")
-return_code=$?
-
-# Restore
-
-git merge --abort
-git checkout -q -
-
-if [ $return_code -eq 0 ]; then
-    echo "Merge check success"
-else
-    echo "Merge check failed"
-fi
-
-exit $return_code

.github/workflows/support-files/network-explorer/templates/failure

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

.github/workflows/support-files/network-explorer/templates/success

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

.github/workflows/support-files/nightly/index.js

@@ -85,7 +85,7 @@ async function getMessageBody(context) {
             ...
           ],
           check_run_url: 'https://api.github.com/repos/nymtech/nym/check-runs/5182940024',
-          labels: [ 'ubuntu-20.04' ],
+          labels: [ 'ubuntu-latest' ],
           runner_id: 1,
           runner_name: 'Hosted Agent',
           runner_group_id: 2,
@@ -151,7 +151,7 @@ async function getMessageBody(context) {
       return `${icon} ${job.conclusion}: ${job.name} - ${job.html_url}`;
     })
     // and join with newlines for display in the template
-    .join('\n\n');
+    .join('\n');
 
   return template({ ...context, jobResults });
 }

.github/workflows/support-files/nightly/templates/failure

@@ -1,15 +1,9 @@
 🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
 > :rocket: {{ env.NYM_PROJECT_NAME }}
->
 > 🔴 **FAILURE** :cry:
->
 > `when` {{ timestamp }}
->
 > `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
->
 > `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
->
 > `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
->
 
 {{ jobResults }}

.github/workflows/support-files/nightly/templates/success

@@ -1,15 +1,9 @@
 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
 > :rocket: {{ env.NYM_PROJECT_NAME }}
->
 > ✅ **SUCCESS**
->
 > `when` {{ timestamp }}
->
 > `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
->
 > `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
->
 > `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
->
 
-{{ jobResults }}
+{{ jobResults }}

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

@@ -1,9 +1,9 @@
 require('dotenv').config();
 
-const { sendMatrixMessage } = require('./send_message_to_matrix');
+const Bot = require('keybase-bot');
 
 let context = {
-  kinds: ['nym-wallet', 'ts-packages', 'network-explorer', 'nightly', 'nym-connect','security'],
+  kinds: ['nym-wallet', 'ts-packages', 'network-explorer', 'nightly', 'nym-connect'],
 };
 
 /**
@@ -23,27 +23,20 @@ function validateContext() {
       'Please set env var NYM_PROJECT_NAME with the project name for displaying in notification messages',
     );
   }
-  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',
-      );
-    }
+  if (!context.env.KEYBASE_NYM_CHANNEL) {
+    throw new Error(
+      'Please set env var KEYBASE_NYM_CHANNEL with the channel name for the notification message',
+    );
+  }
+  if (!context.env.KEYBASE_NYMBOT_USERNAME) {
+    throw new Error(
+      'Username is not defined. Please set env var KEYBASE_NYMBOT_USERNAME',
+    );
+  }
+  if (!context.env.KEYBASE_NYMBOT_PAPERKEY) {
+    throw new Error(
+      'Paperkey is not defined. Please set env var KEYBASE_NYMBOT_PAPERKEY',
+    );
   }
 }
 
@@ -68,6 +61,12 @@ function createTemplateContext() {
 
   context.kind = context.env.NYM_NOTIFICATION_KIND;
 
+  context.keybase = {
+    channel: context.env.KEYBASE_NYM_CHANNEL,
+    username: context.env.KEYBASE_NYMBOT_USERNAME,
+    paperkey: context.env.KEYBASE_NYMBOT_PAPERKEY,
+  };
+
   if (!context.env.GIT_BRANCH_NAME) {
     context.env.GIT_BRANCH_NAME = context.env.GITHUB_REF.split('/')
       .slice(2)
@@ -77,6 +76,40 @@ function createTemplateContext() {
   context.status = process.env.IS_SUCCESS === 'true' ? 'success' : 'failure';
 }
 
+async function sendKeybaseMessage(messageBody) {
+  const bot = new Bot();
+  try {
+    console.log(
+      `Initialising keybase with user "${
+        context.keybase.username
+      }" and key: "${'*'.repeat(context.keybase.paperkey.length)}"...`,
+    );
+    await bot.init(context.keybase.username, context.keybase.paperkey, {
+      verbose: false,
+    });
+
+    const channel = {
+      name: 'nymtech_bot',
+      membersType: 'team',
+      topicName: context.keybase.channel,
+      topic_type: 'CHAT',
+    };
+    const message = {
+      body: messageBody,
+    };
+
+    console.log(`Sending to ${channel.name}#${channel.topicName}...`);
+    await bot.chat.send(channel, message);
+
+    console.log('Message sent!');
+  } catch (error) {
+    console.error(error);
+    process.exitCode = -1;
+  } finally {
+    await bot.deinit();
+  }
+}
+
 /**
  * Uses the `kind` set in the context to process the context and generate a notification message
  * @returns {Promise<string>} A string notification message body
@@ -113,13 +146,7 @@ async function main() {
     console.log(messageBody);
     console.log('-----------------------------------------');
   }
-  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)
-  }
+  await sendKeybaseMessage(messageBody);
 }
 
 // call main function and let NodeJS handle the promise

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

@@ -1,67 +0,0 @@
-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');
-var showdown  = require('showdown');
-
-// 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 sendMatrixMessage(contextArg, messageAsMarkdown, roomId) {
-  const converter = new showdown.Converter();
-  const messageAsHtml = converter.makeHtml(messageAsMarkdown);
-  const client = createClient(contextArg, roomId, messageAsHtml);
-  await client.initCrypto();
-  await client.startClient({ initialSyncLimit: 1 });
-}
-
-module.exports = {
-  sendMatrixMessage,
-};

.github/workflows/support-files/nym-connect/templates/failure

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

.github/workflows/support-files/nym-connect/templates/success

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

.github/workflows/support-files/nym-wallet/templates/failure

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

.github/workflows/support-files/nym-wallet/templates/success

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

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

@@ -1,6 +1,6 @@
 {
-  "name": "send-matrix-message",
-  "description": "Sends a notification message with the matrix sdk",
+  "name": "send-keybase-message",
+  "description": "Sends a notification message with the keybase package that fails when piped into the keybase CLI",
   "version": "1.0.0",
   "private": true,
   "scripts": {
@@ -10,16 +10,8 @@
   "dependencies": {
     "dotenv": "^16.0.0",
     "handlebars": "^4.7.7",
-    "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",
-    "showdown": "^2.1.0",
-    "to-vfile": "^6.1.0",
-    "unified": "^9.2.2"
+    "keybase-bot": "^3.6.1",
+    "octokit": "^1.7.1"
   },
   "devDependencies": {
     "prettier": "2.3.2"

.github/workflows/support-files/security/index.js

@@ -1,24 +0,0 @@
-const Handlebars = require('handlebars');
-const fs = require('fs');
-const path = require('path');
-const { Octokit, App } = require('octokit');
-
-async function addToContextAndValidate(context) {
-  return
-}
-
-async function getMessageBody(context) {
-  try {
-    const source = fs
-    .readFileSync("deny.message").toString();
-    return source;
-} catch (error) {
-    console.error(error);
-}
-
-}
-
-module.exports = {
-  addToContextAndValidate,
-  getMessageBody,
-};

.github/workflows/support-files/ts-packages/templates/failure

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

.github/workflows/support-files/ts-packages/templates/success

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

.github/workflows/tag-and-release.yml

@@ -1,46 +0,0 @@
-name: tag-and-release
-
-on:
-  workflow_dispatch:
-    inputs:  
-      nym_binaries_version:
-        description: 'Version of the nym-binaries tag'
-        required: false
-        type: string 
-      nym_wallet_version:
-        description: 'Version of the nym-wallet tag'
-        required: false
-        type: string 
-      nym_connect_version:
-        description: 'Version of the nym-connect tag'
-        required: false
-        type: string 
-
-jobs:
-  tag-components:
-    uses: nymtech/reusable-workflows/.github/workflows/tag-components.yml@master
-    with:
-      nym_binaries_version: ${{ input.nym_binaries_version }}
-      nym_wallet_version: ${{ input.nym_wallet_version }}
-      nym_connect_version: ${{ input.nym_connect_version }}
-
-  create-nym-binaries-release:
-    if: ${{ input.nym_binaries_version }}
-    uses: nymtech/reusable-workflows/.github/workflows/create-binaries-release.yml@master
-    with:
-      version: ${{ input.nym_binaries_version }}
-    needs: ["tag-components"]
-
-  create-nym-wallet-release:
-    if: ${{ input.nym_wallet_version }}
-    uses: nymtech/reusable-workflows/.github/workflows/create-wallet-release.yml@master
-    with:
-      version: ${{ input.nym_wallet_version }}
-    needs: ["tag-components"]
-
-  create-nym-connect-release:
-    if: ${{ input.nym_connect_version }}
-    uses: nymtech/reusable-workflows/.github/workflows/create-connect-release.yml@master
-    with:
-      version: ${{ input.nym_connect_version }}
-    needs: ["tag-components"]

.github/workflows/typescript-lint.yml

@@ -1,64 +0,0 @@
-name: CI for linting Typescript
-
-on:
-  push:
-    paths:
-      - 'ts-packages/**'
-      - 'sdk/typescript/**'
-      - 'nym-connect/desktop/src/**'
-      - 'nym-connect/desktop/package.json'
-      - 'nym-connect/mobile/src/**'
-      - 'nym-connect/mobile/package.json'
-      - 'nym-wallet/src/**'
-      - 'nym-wallet/package.json'
-  pull_request:
-    paths:
-      - 'ts-packages/**'
-      - 'sdk/typescript/**'
-      - 'nym-connect/desktop/src/**'
-      - 'nym-connect/desktop/package.json'
-      - 'nym-connect/mobile/src/**'
-      - 'nym-connect/mobile/package.json'
-      - 'nym-wallet/src/**'
-      - 'nym-wallet/package.json'
-
-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: Install
-      run: yarn
-    - name: Build packages
-      run: yarn build
-    - name: Lint
-      run: yarn lint && yarn tsc
-    - name: Matrix - Node Install
-      run: npm install
-      working-directory: .github/workflows/support-files
-    - name: Matrix - 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##*/}"
-        IS_SUCCESS: "${{ job.status == 'success' }}"
-        MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
-        MATRIX_ROOM: "${{ secrets.MATRIX_ROOM }}"
-        MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
-        MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
-        MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
-      uses: docker://keybaseio/client:stable-node
-      with:
-        args: .github/workflows/support-files/notifications/entry_point.sh

.github/workflows/update-versions-and-changelog.yaml

@@ -1,95 +0,0 @@
-name: update-versions-and-changelog
-
-on:
-  workflow_dispatch:
-    inputs:
-      release_version:
-        description: "Release version, usually the milestone title"
-        required: true
-        type: string
-      milestone_id:
-        description: "Milestone ID, check the URL when you're on the specific milestone page"
-        required: true
-        type: string
-
-env:
-  CI_BOT_AUTHOR: "Nym bot"
-  CI_BOT_EMAIL: "nym-bot@users.noreply.github.com"
-
-jobs:
-  update-versions:
-    runs-on: ubuntu-22.04
-    steps:
-      - name: checkout-source
-        uses: actions/checkout@v3
-        with:
-          ref: "release/${{ inputs.release_version }}"
-          path: "nym"
-
-      - name: checkout-ci-tools-repo
-        uses: actions/checkout@v3
-        with: 
-          repository: "nymtech/ci-tools"
-          ref: "master"
-          path: "ci-tools"
-          token: "${{ secrets.ACCESS_TOKEN_PRIVATE_REPOS }}"
-
-      - name: Install Rust stable
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-
-      - name: install-version-bumper
-        run: "cargo install --path ."
-        working-directory: "ci-tools/version-bumper"
-
-      - name: run-version-bumper
-        run: "version-bumper bump binaries --nym-repo-directory nym"
-
-      - name: push-changes-to-branch
-        run: |
-          git config --global user.name "${{ env.CI_BOT_AUTHOR }}"
-          git config --global user.email "${{ env.CI_BOT_EMAIL }}"
-          git checkout -b release/${{ inputs.release_version }}-preparation
-          git commit -am "chore: version bump in preparation for release"
-          git push -u origin release/${{ inputs.release_version }}-preparation
-        working-directory: "nym"
-
-  update-changelog:
-    runs-on: ubuntu-22.04
-    needs: [update-versions]
-    steps:
-      - name: checkout-source
-        uses: actions/checkout@v3
-        with:
-          ref: "release/${{ inputs.release_version }}"
-          path: "nym"
-
-      - name: checkout-ci-tools-repo
-        uses: actions/checkout@v3
-        with: 
-          repository: "nymtech/ci-tools"
-          ref: "master"
-          path: "ci-tools"
-          token: "${{ secrets.ACCESS_TOKEN_PRIVATE_REPOS }}"
-
-      - name: Install Rust stable
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-
-      - name: install-changelog-updater
-        run: "cargo install --path ."
-        working-directory: "ci-tools/changelog-updater"
-
-      - name: run-changelog-updater
-        run: "changelog-updater mix ${{ inputs.milestone_id }} release/${{ inputs.release_version }}"
-
-      - name: push-changes-to-branch
-        run: |
-          git config --global user.name "${{ env.CI_BOT_AUTHOR }}"
-          git config --global user.email "${{ env.CI_BOT_EMAIL }}"
-          git checkout release/${{ inputs.release_version }}-preparation
-          git commit -am "chore: update changelog preparation for release"
-          git push
-        working-directory: "nym"

.github/workflows/wallet.yml

@@ -2,17 +2,11 @@ name: Nym Wallet (rust)
 
 on:
   push:
-    paths:
-      - 'nym-wallet/**'
-      - 'common/**'
-      - 'contracts/vesting/**'
-      - 'nym-api/nym-api-requests/**'
+    paths-ignore:
+      - 'explorer/**'
   pull_request:
-    paths:
-      - 'nym-wallet/**'
-      - 'common/**'
-      - 'contracts/vesting/**'
-      - 'nym-api/nym-api-requests/**'
+    paths-ignore:
+      - 'explorer/**'
 
 jobs:
   build:
@@ -22,7 +16,6 @@ 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
@@ -55,7 +48,6 @@ 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

.github/workflows/wasm_client_build.yml

@@ -2,17 +2,12 @@ name: Wasm Client
 
 on:
   pull_request:
-    paths:
-      - 'clients/webassembly/**'
-      - 'clients/client-core/**'
-      - 'common/**'
-      - 'contracts/**'
-      - 'gateway/gateway-requests/**'
-      - 'nym-api/nym-api-requests/**'
+    paths-ignore:
+      - 'explorer/**'
 
 jobs:
   wasm:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
 
@@ -29,6 +24,16 @@ 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

.gitignore

@@ -37,8 +37,4 @@ validator-config
 *.patch
 validator-api-config.toml
 dist
-storybook-static
-envs/qwerty.env
-.parcel-cache
-**/.DS_Store
-cpu-cycles/libcpucycles/build
+storybook-static

.wellknown/wallet/validators.json

@@ -1,8 +1,6 @@
 {
-  "mainnet": [
-    {
-      "nyxd_url": "https://rpc.nyx.nodes.guru/",
-      "api_url": "https://api.nyx.nodes.guru/"
-    }
-  ]
-}
+  "mainnet":[{
+    "nymd_url":"https://rpc.nyx.nodes.guru/",
+    "api_url":"https://api.nyx.nodes.guru/"
+  }]
+}

CHANGELOG.md

@@ -2,339 +2,22 @@
 
 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]
-
-- nym-network-statistics properly handles signals ([#3209])
-- add socks5 support for Rust SDK ([#3226])
-
-[#3209]: https://github.com/nymtech/nym/issues/3209
-[#3226]: https://github.com/nymtech/nym/pull/3226
-
-## [v1.1.13] (2023-03-15)
-
-- NE - instead of throwing a "Mixnode/Gateway not found" error for blacklisted nodes due to bad performance, show their history but tag them as "Having poor performance" ([#2979])
-- NE - Upgrade Sandbox and make below changes:  ([#2332])
-- Explorer - Updates ([#3168])
-- Fix contracts and nym-api audit findings ([#3026])
-- Website v2 - deploy infrastructure for strapi and CI ([#2213])
-- add blockstream green to sp list ([#3180])
-- mock-nym-api: fix .storybook lint error ([#3178])
-- Validating new interval config parameters to prevent division by zero ([#3153])
-
-[#2979]: https://github.com/nymtech/nym/issues/2979
-[#2332]: https://github.com/nymtech/nym/issues/2332
-[#3168]: https://github.com/nymtech/nym/issues/3168
-[#3026]: https://github.com/nymtech/nym/issues/3026
-[#2213]: https://github.com/nymtech/nym/issues/2213
-[#3180]: https://github.com/nymtech/nym/pull/3180
-[#3178]: https://github.com/nymtech/nym/pull/3178
-[#3153]: https://github.com/nymtech/nym/pull/3153
-
-## [v1.1.12] (2023-03-07)
-
-- Fix generated docs for mixnet and vesting contract on docs.rs ([#3093])
-- Introduce a way of injecting topology into the client ([#3044])
-- Update mixnet TypeScript client methods #1 ([#2783])
-- Update tooltips for routing and average score ([#3133])
-- update selected service provider description style ([#3128])
-
-[#3093]: https://github.com/nymtech/nym/issues/3093
-[#3044]: https://github.com/nymtech/nym/issues/3044
-[#2783]: https://github.com/nymtech/nym/issues/2783
-[#3133]: https://github.com/nymtech/nym/pull/3133
-[#3128]: https://github.com/nymtech/nym/pull/3128
-
-## [v1.1.11] (2023-02-28)
-
-- Fix empty dealer set loop ([#3105])
-- The nym-api db.sqlite is broken when trying to run against it it in `enabled-credentials-mode true` there is an ordering issue with migrations when using the credential binary to purchase bandwidth ([#3100])
-- Feature/latency based gateway selection ([#3081])
-- Fix the credential binary to handle transactions to sleep when in non-inProgress epochs ([#3057])
-- Publish mixnet contract to crates.io ([#1919])
-- Publish vesting contract to crates.io ([#1920])
-- Feature/update checker to use master ([#3097])
-- Feature/improve binary checks ([#3094])
-
-[#3105]: https://github.com/nymtech/nym/issues/3105
-[#3100]: https://github.com/nymtech/nym/issues/3100
-[#3081]: https://github.com/nymtech/nym/pull/3081
-[#3057]: https://github.com/nymtech/nym/issues/3057
-[#1919]: https://github.com/nymtech/nym/issues/1919
-[#1920]: https://github.com/nymtech/nym/issues/1920
-[#3097]: https://github.com/nymtech/nym/pull/3097
-[#3094]: https://github.com/nymtech/nym/pull/3094
-
-## [v1.1.10] (2023-02-21)
-
-- Verloc listener causing mixnode unexpected shutdown ([#3038])
-- rust-sdk - update API following implementation experience with the network-requester ([#3001])
-- Prevent coconut deposits in incompatible states ([#2991])
-- Support unavailable signer within threshold ([#2987])
-- Implement DKG re-sharing ([#2935])
-- contracts: add nym prefix to mixnet and vesting contract packages ([#2855])
-- Introduce common interface for all service providers to allow obtaining information such as whether they're online, what binary version they're running, etc. ([#2758])
-- Add client functionality to nym-network-requester ([#1900])
-- nym-api: uptime rework ([#3053])
-- ci: update typescript-lint.yml ([#3035])
-- contracts: add nym prefix to mixnet and vesting contract packages ([#2855])
-
-[#3038]: https://github.com/nymtech/nym/issues/3038
-[#3001]: https://github.com/nymtech/nym/issues/3001
-[#2991]: https://github.com/nymtech/nym/issues/2991
-[#2987]: https://github.com/nymtech/nym/issues/2987
-[#2935]: https://github.com/nymtech/nym/issues/2935
-[#2855]: https://github.com/nymtech/nym/pull/2855
-[#2758]: https://github.com/nymtech/nym/issues/2758
-[#1900]: https://github.com/nymtech/nym/issues/1900
-[#3053]: https://github.com/nymtech/nym/pull/3053
-[#3035]: https://github.com/nymtech/nym/pull/3035
-[#2855]: https://github.com/nymtech/nym/pull/2855
-
-## [v1.1.9] (2023-02-07)
+## Unreleased
 
 ### Added
 
-- Remove Coconut feature flag ([#2793])
-- Separate `nym-api` endpoints with values of "total-supply" and "circulating-supply" in `nym` ([#2964])
+- validator-client: added `query_contract_smart` and `query_contract_raw` on `NymdClient` ([#1558])
+
 
 ### Changed
 
-- native-client: is now capable of listening for requests on sockets different than `127.0.0.1` ([#2912]). 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])
-
-[#2793]: https://github.com/nymtech/nym/issues/2793
-[#2912]: https://github.com/nymtech/nym/issues/2912
-[#2964]: https://github.com/nymtech/nym/issues/2964
-[#2963]: https://github.com/nymtech/nym/issues/3017
-
-## [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
-
-- 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])
-
-[#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
-
-- 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)
-
-This release adds multiple Single Use Reply Blocks (SURBs) to allow arbitrarily-sized anonymized replies.
-At the moment this is turned off by default, but available for use by application developers.
-We will need to wait for network-requesters to upgrade to this new release, after which multi-SURB anonymization will become the default setting for the SOCKS proxy clients.
-
-The release also include some additional work for distributed key generation in the Coconut signing authority nodes.
-
-### Changed
-
-- Feature/dkg contract threshold by @neacsu in https://github.com/nymtech/nym/pull/1885
-- Multi-surbs by @jstuczyn in https://github.com/nymtech/nym/pull/2667
-- Fix multi-surb backwards compatibility in pre 1.1.4 client config files by @jstuczyn in https://github.com/nymtech/nym/pull/2703
-- fix: ignore corrupted surb storage and instead create fresh one by @jstuczyn in https://github.com/nymtech/nym/pull/2711
-- socks5: rework waiting in inbound.rs by @octol in https://github.com/nymtech/nym/pull/1880
-
-## [v1.1.3] (2022-12-13)
-
-### Changed
-
-- validator-api: can recover from shutdown during DKG process ([#1872])
-- 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]))
-
-### Fixed
-
-- network-requester: fix bug where websocket connection disconnect resulted in success error code
-- clients: fix a few panics handling the gateway-client
-- mixnode, gateway, validator-api: Use mainnet values as defaults for URLs and mixnet contract ([#1884])
-- socks5: fixed bug where connections sometimes where closed too early
-- clients: improve message logging when received message fails to get reconstructed ([#1803])
-
-[#1796]: https://github.com/nymtech/nym/pull/1796
-[#1801]: https://github.com/nymtech/nym/pull/1801
-[#1803]: https://github.com/nymtech/nym/pull/1803
-[#1804]: https://github.com/nymtech/nym/pull/1804
-[#1835]: https://github.com/nymtech/nym/pull/1835
-[#1858]: https://github.com/nymtech/nym/pull/1858
-[#1872]: https://github.com/nymtech/nym/pull/1872
-[#1883]: https://github.com/nymtech/nym/pull/1883
-[#1884]: https://github.com/nymtech/nym/pull/1884
-
-## [v1.1.2]
-
-### Changed
-
-- gateway: Renamed flag from `enabled/disabled_credentials_mode` to `only-coconut-credentials`
-- "Family" feature for node families + layers
-- Initial coconut functionality including credentials and distributed key generation
-
-## [v1.1.1](https://github.com/nymtech/nym/tree/v1.1.1) (2022-11-29)
-
-### Added
-
-- binaries: add `-c` shortform for `--config-env-file`
-- websocket-requests: add server response signalling current packet queue length in the client
-- contracts: DKG contract that handles coconut key generation ([#1678][#1708][#1747])
-- validator-api: generate coconut keys interactively, using DKG and multisig contracts ([#1678][#1708][#1747])
-
-### Changed
-
-- clients: add concept of transmission lanes to better handle multiple data streams ([#1720])
-- clients,validator-api: take coconut signers from the chain instead of specifying them via CLI ([#1747])
-- multisig contract: add DKG contract to the list of addresses that can create proposals ([#1747])
-- socks5-client: wait closing inbound connection until data is sent, and throttle incoming data in general ([#1783])
-- nym-cli: improve error reporting/handling and changed `vesting-schedule` queries to use query client instead of signing client
-
-### Fixed
-
-- gateway-client: fix decrypting stored messages on reconnect ([#1786])
-
-### Fixed
-
-- gateway-client: fix decrypting stored messages on reconnect ([#1786])
-- socks5-client: fix shutting down all tasks if anyone of them panics or errors out ([#1805])
-
-[#1678]: https://github.com/nymtech/nym/pull/1678
-[#1708]: https://github.com/nymtech/nym/pull/1708
-[#1720]: https://github.com/nymtech/nym/pull/1720
-[#1747]: https://github.com/nymtech/nym/pull/1747
-[#1783]: https://github.com/nymtech/nym/pull/1783
-[#1786]: https://github.com/nymtech/nym/pull/1786
-[#1805]: https://github.com/nymtech/nym/pull/1805
-
-## [v1.1.0](https://github.com/nymtech/nym/tree/v1.1.0) (2022-11-09)
-
-### Added
-
-- clients: add testing-only support for two more extended packet sizes (8kb and 16kb).
-- common/ledger: new library for communicating with a Ledger device ([#1640])
-- native-client/socks5-client/wasm-client: `disable_loop_cover_traffic_stream` Debug config option to disable the separate loop cover traffic stream ([#1666])
-- native-client/socks5-client/wasm-client: `disable_main_poisson_packet_distribution` Debug config option to make the client ignore poisson distribution in the main packet stream and ONLY send real message (and as fast as they come) ([#1664])
-- 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 `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
-
-- socks5-client: fix bug where in some cases packet reordering could trigger a connection being closed too early ([#1702],[#1724])
-- validator-api: mixnode, gateway should now prefer values in config.toml over mainnet defaults ([#1645])
-- validator-api: should now correctly update historical uptimes for all mixnodes and gateways every 24h ([#1721])
-
-### Changed
-
-- clients: bound the sphinx packet channel and reduce sending rate if gateway can't keep up ([#1703],[#1725])
-- gateway-client: will attempt to read now as many as 8 websocket messages at once, assuming they're already available on the socket ([#1669])
-- moved `Percent` struct to `contracts-common`, change affects explorer-api
-- socks5 client: graceful shutdown should fix error on disconnect in nym-connect ([#1591])
-- validator-api: changed error serialization on `inclusion_probability`, `stake-saturation` and `reward-estimation` endpoints to provide more accurate information ([#1681])
 - validator-client: made `fee` argument optional for `execute` and `execute_multiple` ([#1541])
 - wasm-client: fixed build errors on MacOS and changed example JS code to use mainnet ([#1585])
-- validator-api: changes to internal SQL schema due to the mixnet contract revamp ([#1472])
-- validator-api: changes to internal data structures due to the mixnet contract revamp ([#1472])
-- validator-api: split epoch-operations into multiple separate transactions ([#1472])
 
-[#1472]: https://github.com/nymtech/nym/pull/1472
 [#1541]: https://github.com/nymtech/nym/pull/1541
 [#1558]: https://github.com/nymtech/nym/pull/1558
-[#1577]: https://github.com/nymtech/nym/pull/1577
 [#1585]: https://github.com/nymtech/nym/pull/1585
-[#1591]: https://github.com/nymtech/nym/pull/1591
-[#1640]: https://github.com/nymtech/nym/pull/1640
-[#1645]: https://github.com/nymtech/nym/pull/1645
-[#1611]: https://github.com/nymtech/nym/pull/1611
-[#1664]: https://github.com/nymtech/nym/pull/1664
-[#1666]: https://github.com/nymtech/nym/pull/1645
-[#1669]: https://github.com/nymtech/nym/pull/1669
-[#1671]: https://github.com/nymtech/nym/pull/1671
-[#1673]: https://github.com/nymtech/nym/pull/1673
-[#1681]: https://github.com/nymtech/nym/pull/1681
-[#1702]: https://github.com/nymtech/nym/pull/1702
-[#1703]: https://github.com/nymtech/nym/pull/1703
-[#1721]: https://github.com/nymtech/nym/pull/1721
-[#1724]: https://github.com/nymtech/nym/pull/1724
-[#1725]: https://github.com/nymtech/nym/pull/1725
+
 
 ## [nym-binaries-1.0.2](https://github.com/nymtech/nym/tree/nym-binaries-1.0.2)
 
@@ -388,8 +71,9 @@ 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 nyxd queries ([#1520])
-- network-requester, socks5 client (nym-connect): send and receive respectively a message error to be displayed about filter check failure ([#1576])
+- validator-api: rewarder set update fails without panicking on possible nymd 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
 [#1256]: https://github.com/nymtech/nym/pull/1256
@@ -483,9 +167,9 @@ The release also include some additional work for distributed key generation in
 - Bump minimist from 1.2.5 to 1.2.6 in /clients/tauri-client [\#1163](https://github.com/nymtech/nym/pull/1163) ([dependabot[bot]](https://github.com/apps/dependabot))
 - Bump minimist from 1.2.5 to 1.2.6 in /clients/webassembly/js-example [\#1162](https://github.com/nymtech/nym/pull/1162) ([dependabot[bot]](https://github.com/apps/dependabot))
 - Bump minimist from 1.2.5 to 1.2.6 in /clients/native/examples/js-examples/websocket [\#1160](https://github.com/nymtech/nym/pull/1160) ([dependabot[bot]](https://github.com/apps/dependabot))
-- Bump minimist from 1.2.5 to 1.2.6 in /docker/typescript_client/upload_contract [\#1159](https://github.com/nymtech/nym/pull/1159) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump minimist from 1.2.5 to 1.2.6 in /docker/typescript\_client/upload\_contract [\#1159](https://github.com/nymtech/nym/pull/1159) ([dependabot[bot]](https://github.com/apps/dependabot))
 - Feature/vesting full [\#1158](https://github.com/nymtech/nym/pull/1158) ([fmtabbara](https://github.com/fmtabbara))
-- get_current_epoch tauri [\#1156](https://github.com/nymtech/nym/pull/1156) ([durch](https://github.com/durch))
+- get\_current\_epoch tauri [\#1156](https://github.com/nymtech/nym/pull/1156) ([durch](https://github.com/durch))
 - Cleanup [\#1155](https://github.com/nymtech/nym/pull/1155) ([durch](https://github.com/durch))
 - Feature flag reward payments [\#1154](https://github.com/nymtech/nym/pull/1154) ([durch](https://github.com/durch))
 - Add Query endpoints for calculating rewards [\#1152](https://github.com/nymtech/nym/pull/1152) ([durch](https://github.com/durch))
@@ -494,7 +178,7 @@ The release also include some additional work for distributed key generation in
 - wallet: use Urls rather than Strings for validator urls [\#1148](https://github.com/nymtech/nym/pull/1148) ([octol](https://github.com/octol))
 - Change accumulated reward to Option, migrate delegations [\#1147](https://github.com/nymtech/nym/pull/1147) ([durch](https://github.com/durch))
 - wallet: fetch validators url remotely if available [\#1146](https://github.com/nymtech/nym/pull/1146) ([octol](https://github.com/octol))
-- Fix delegated_free calculation [\#1145](https://github.com/nymtech/nym/pull/1145) ([durch](https://github.com/durch))
+- Fix delegated\_free calculation [\#1145](https://github.com/nymtech/nym/pull/1145) ([durch](https://github.com/durch))
 - Update Nym wallet dependencies to use `ts-packages` [\#1144](https://github.com/nymtech/nym/pull/1144) ([mmsinclair](https://github.com/mmsinclair))
 - wallet: try validators one by one if available [\#1143](https://github.com/nymtech/nym/pull/1143) ([octol](https://github.com/octol))
 - Update Network Explorer Packages and add mix node identity key copy [\#1142](https://github.com/nymtech/nym/pull/1142) ([mmsinclair](https://github.com/mmsinclair))
@@ -534,13 +218,14 @@ The release also include some additional work for distributed key generation in
 - feature/pedersen-commitments [\#1048](https://github.com/nymtech/nym/pull/1048) ([danielementary](https://github.com/danielementary))
 - Feature/reuse init owner [\#970](https://github.com/nymtech/nym/pull/970) ([neacsu](https://github.com/neacsu))
 
+
 ## [v0.12.1](https://github.com/nymtech/nym/tree/v0.12.1) (2021-12-23)
 
 [Full Changelog](https://github.com/nymtech/nym/compare/v0.12.0...v0.12.1)
 
 **Implemented enhancements:**
 
-- Add version check to binaries [\#967](https://github.com/nymtech/nym/issues/967)
+- Add version check to  binaries [\#967](https://github.com/nymtech/nym/issues/967)
 
 **Fixed bugs:**
 
@@ -570,7 +255,7 @@ The release also include some additional work for distributed key generation in
 - Bugfix/remove mixnode bonding overwrite [\#917](https://github.com/nymtech/nym/pull/917) ([jstuczyn](https://github.com/jstuczyn))
 - Fixes crash condition in validator API when calculating last day uptime [\#909](https://github.com/nymtech/nym/pull/909) ([jstuczyn](https://github.com/jstuczyn))
 - Bugfix/monitor initial values wait [\#907](https://github.com/nymtech/nym/pull/907) ([jstuczyn](https://github.com/jstuczyn))
-- Bug fix: Network Explorer: Add freegeoip API key and split out tasks for country distributions [\#806](https://github.com/nymtech/nym/pull/806) ([mmsinclair](https://github.com/mmsinclair))
+- Bug fix: Network Explorer: Add freegeoip API key and split out tasks for country distributions  [\#806](https://github.com/nymtech/nym/pull/806) ([mmsinclair](https://github.com/mmsinclair))
 - Explorer API: port test now split out address resolution and add units tests [\#755](https://github.com/nymtech/nym/pull/755) ([mmsinclair](https://github.com/mmsinclair))
 
 **Closed issues:**
@@ -585,7 +270,7 @@ The release also include some additional work for distributed key generation in
 - help!!! [\#712](https://github.com/nymtech/nym/issues/712)
 - UX feature request: show all delegated nodes in wallet [\#711](https://github.com/nymtech/nym/issues/711)
 - UX feature request: add current balance on wallet pages [\#710](https://github.com/nymtech/nym/issues/710)
-- got sign issue from bot [\#709](https://github.com/nymtech/nym/issues/709)
+- got sign issue from bot  [\#709](https://github.com/nymtech/nym/issues/709)
 - As a wallet user, I would like to be able to log out of the wallet [\#706](https://github.com/nymtech/nym/issues/706)
 - As a wallet user, I would like to have a "receive" page where I can see my own wallet address [\#705](https://github.com/nymtech/nym/issues/705)
 - Update native client/socks client/mixnode/gateway `upgrade` command [\#689](https://github.com/nymtech/nym/issues/689)
@@ -595,7 +280,7 @@ The release also include some additional work for distributed key generation in
 - nym-socks5-client crash after opening Keybase team "Browse all channels" [\#494](https://github.com/nymtech/nym/issues/494)
 - Mixed Content problem [\#400](https://github.com/nymtech/nym/issues/400)
 - Gateway disk quota [\#137](https://github.com/nymtech/nym/issues/137)
-- Simplify message encapsulation with regards to topology [\#127](https://github.com/nymtech/nym/issues/127)
+- Simplify message encapsulation with regards to topology  [\#127](https://github.com/nymtech/nym/issues/127)
 - Create constants for cli argument names [\#115](https://github.com/nymtech/nym/issues/115)
 - Using Blake3 as a hash function [\#103](https://github.com/nymtech/nym/issues/103)
 - Validator should decide which layer a node is in [\#86](https://github.com/nymtech/nym/issues/86)
@@ -651,10 +336,10 @@ The release also include some additional work for distributed key generation in
 - Feature/pre cosmrs updates [\#935](https://github.com/nymtech/nym/pull/935) ([jstuczyn](https://github.com/jstuczyn))
 - Feature/client on behalf [\#934](https://github.com/nymtech/nym/pull/934) ([neacsu](https://github.com/neacsu))
 - Webpack wallet prod configuration [\#933](https://github.com/nymtech/nym/pull/933) ([tommyv1987](https://github.com/tommyv1987))
-- Adding tx_hash to wallet response [\#932](https://github.com/nymtech/nym/pull/932) ([futurechimp](https://github.com/futurechimp))
+- Adding tx\_hash to wallet response [\#932](https://github.com/nymtech/nym/pull/932) ([futurechimp](https://github.com/futurechimp))
 - Release/1.0.0 pre1 [\#931](https://github.com/nymtech/nym/pull/931) ([durch](https://github.com/durch))
 - Feature/identity verification [\#930](https://github.com/nymtech/nym/pull/930) ([jstuczyn](https://github.com/jstuczyn))
-- Move cleaned up smart contracts to main code repo [\#929](https://github.com/nymtech/nym/pull/929) ([mfahampshire](https://github.com/mfahampshire))
+- Move cleaned up smart contracts to main code repo  [\#929](https://github.com/nymtech/nym/pull/929) ([mfahampshire](https://github.com/mfahampshire))
 - Feature/mixnet contract further adjustments [\#928](https://github.com/nymtech/nym/pull/928) ([jstuczyn](https://github.com/jstuczyn))
 - typo copy change for nodemap [\#926](https://github.com/nymtech/nym/pull/926) ([Aid19801](https://github.com/Aid19801))
 - Feature/UI enhancements for Desktop Wallet [\#925](https://github.com/nymtech/nym/pull/925) ([fmtabbara](https://github.com/fmtabbara))
@@ -667,7 +352,7 @@ The release also include some additional work for distributed key generation in
 - Feature/faucet page react [\#911](https://github.com/nymtech/nym/pull/911) ([fmtabbara](https://github.com/fmtabbara))
 - Feature/mixnet contract refactor [\#910](https://github.com/nymtech/nym/pull/910) ([futurechimp](https://github.com/futurechimp))
 - Update README.md [\#905](https://github.com/nymtech/nym/pull/905) ([tommyv1987](https://github.com/tommyv1987))
-- BUG: Bond cell denom [\#904](https://github.com/nymtech/nym/pull/904) ([Aid19801](https://github.com/Aid19801))
+- BUG: Bond cell denom  [\#904](https://github.com/nymtech/nym/pull/904) ([Aid19801](https://github.com/Aid19801))
 - Explorer UI tests missing data-testid [\#903](https://github.com/nymtech/nym/pull/903) ([tommyv1987](https://github.com/tommyv1987))
 - Fix up Nym-Wallet README.md [\#899](https://github.com/nymtech/nym/pull/899) ([tommyv1987](https://github.com/tommyv1987))
 - Feature/batch delegator rewarding [\#898](https://github.com/nymtech/nym/pull/898) ([jstuczyn](https://github.com/jstuczyn))
@@ -685,7 +370,7 @@ The release also include some additional work for distributed key generation in
 - Reverted gateway registration handshake to its 0.11.0 version [\#882](https://github.com/nymtech/nym/pull/882) ([jstuczyn](https://github.com/jstuczyn))
 - Network Explorer [\#881](https://github.com/nymtech/nym/pull/881) ([mmsinclair](https://github.com/mmsinclair))
 - Feature/rewarding interval updates [\#880](https://github.com/nymtech/nym/pull/880) ([jstuczyn](https://github.com/jstuczyn))
-- Put client_address and id in the correct order [\#875](https://github.com/nymtech/nym/pull/875) ([neacsu](https://github.com/neacsu))
+- Put client\_address and id in the correct order [\#875](https://github.com/nymtech/nym/pull/875) ([neacsu](https://github.com/neacsu))
 - remove gateway selection on delegation and undelegation pages [\#873](https://github.com/nymtech/nym/pull/873) ([fmtabbara](https://github.com/fmtabbara))
 - Set MSRV on all binaries to 1.56 [\#872](https://github.com/nymtech/nym/pull/872) ([jstuczyn](https://github.com/jstuczyn))
 - add native window items \(copy/paste\) via tauri [\#871](https://github.com/nymtech/nym/pull/871) ([fmtabbara](https://github.com/fmtabbara))
@@ -701,7 +386,7 @@ The release also include some additional work for distributed key generation in
 - Overflow checks in release [\#846](https://github.com/nymtech/nym/pull/846) ([jstuczyn](https://github.com/jstuczyn))
 - fix delegate success overflow [\#842](https://github.com/nymtech/nym/pull/842) ([fmtabbara](https://github.com/fmtabbara))
 - Feature NYM wallet webdriverio test [\#841](https://github.com/nymtech/nym/pull/841) ([tommyv1987](https://github.com/tommyv1987))
-- Update nym_wallet.yml [\#840](https://github.com/nymtech/nym/pull/840) ([tommyv1987](https://github.com/tommyv1987))
+- Update nym\_wallet.yml [\#840](https://github.com/nymtech/nym/pull/840) ([tommyv1987](https://github.com/tommyv1987))
 - Feature/vouchers [\#837](https://github.com/nymtech/nym/pull/837) ([aniampio](https://github.com/aniampio))
 - Apply readable ids to elements on Nym Wallet [\#836](https://github.com/nymtech/nym/pull/836) ([tommyv1987](https://github.com/tommyv1987))
 - Feature/removal of monitor good nodes [\#833](https://github.com/nymtech/nym/pull/833) ([jstuczyn](https://github.com/jstuczyn))
@@ -725,8 +410,8 @@ The release also include some additional work for distributed key generation in
 - Created getters for AccountData [\#787](https://github.com/nymtech/nym/pull/787) ([jstuczyn](https://github.com/jstuczyn))
 - Feature/migrate hidden delegations [\#786](https://github.com/nymtech/nym/pull/786) ([neacsu](https://github.com/neacsu))
 - Feature/persistent gateway storage [\#784](https://github.com/nymtech/nym/pull/784) ([jstuczyn](https://github.com/jstuczyn))
-- Replaced unwrap_or_else with unwrap_or_default [\#780](https://github.com/nymtech/nym/pull/780) ([jstuczyn](https://github.com/jstuczyn))
-- Add block_height method to Delegation [\#778](https://github.com/nymtech/nym/pull/778) ([durch](https://github.com/durch))
+- Replaced unwrap\_or\_else with unwrap\_or\_default [\#780](https://github.com/nymtech/nym/pull/780) ([jstuczyn](https://github.com/jstuczyn))
+- Add block\_height method to Delegation [\#778](https://github.com/nymtech/nym/pull/778) ([durch](https://github.com/durch))
 - Make fee helpers public [\#777](https://github.com/nymtech/nym/pull/777) ([durch](https://github.com/durch))
 - re-enable bonding [\#776](https://github.com/nymtech/nym/pull/776) ([fmtabbara](https://github.com/fmtabbara))
 - Explorer-api: add API resource to show the delegations for each mix node [\#774](https://github.com/nymtech/nym/pull/774) ([mmsinclair](https://github.com/mmsinclair))
@@ -735,14 +420,14 @@ The release also include some additional work for distributed key generation in
 - Adding deps for building the Tauri wallet under Ubuntu [\#770](https://github.com/nymtech/nym/pull/770) ([futurechimp](https://github.com/futurechimp))
 - remove alert [\#767](https://github.com/nymtech/nym/pull/767) ([fmtabbara](https://github.com/fmtabbara))
 - Feature/consumable bandwidth [\#766](https://github.com/nymtech/nym/pull/766) ([neacsu](https://github.com/neacsu))
-- Update coconut-rs and use hash_to_scalar from there [\#765](https://github.com/nymtech/nym/pull/765) ([neacsu](https://github.com/neacsu))
+- Update coconut-rs and use hash\_to\_scalar from there [\#765](https://github.com/nymtech/nym/pull/765) ([neacsu](https://github.com/neacsu))
 - Feature/active sets [\#764](https://github.com/nymtech/nym/pull/764) ([jstuczyn](https://github.com/jstuczyn))
 - add app alert banner [\#762](https://github.com/nymtech/nym/pull/762) ([fmtabbara](https://github.com/fmtabbara))
 - Updated cosmos-sdk [\#761](https://github.com/nymtech/nym/pull/761) ([jstuczyn](https://github.com/jstuczyn))
 - Feature/bond blockstamp [\#760](https://github.com/nymtech/nym/pull/760) ([neacsu](https://github.com/neacsu))
 - Feature/revert migration code [\#759](https://github.com/nymtech/nym/pull/759) ([neacsu](https://github.com/neacsu))
 - Bump next from 11.1.0 to 11.1.1 in /wallet-web [\#758](https://github.com/nymtech/nym/pull/758) ([dependabot[bot]](https://github.com/apps/dependabot))
-- Add block_height in the Delegation structure as well [\#757](https://github.com/nymtech/nym/pull/757) ([neacsu](https://github.com/neacsu))
+- Add block\_height in the Delegation structure as well [\#757](https://github.com/nymtech/nym/pull/757) ([neacsu](https://github.com/neacsu))
 - Feature/add blockstamp [\#756](https://github.com/nymtech/nym/pull/756) ([neacsu](https://github.com/neacsu))
 - NetworkMonitorBuilder - starting the monitor after rocket has launched [\#754](https://github.com/nymtech/nym/pull/754) ([jstuczyn](https://github.com/jstuczyn))
 - Enabled validators api argument [\#753](https://github.com/nymtech/nym/pull/753) ([jstuczyn](https://github.com/jstuczyn))
@@ -754,21 +439,21 @@ The release also include some additional work for distributed key generation in
 - Feature/more reliable uptime calculation [\#747](https://github.com/nymtech/nym/pull/747) ([jstuczyn](https://github.com/jstuczyn))
 - Update template toml key [\#746](https://github.com/nymtech/nym/pull/746) ([neacsu](https://github.com/neacsu))
 - Feature/cred after handshake [\#745](https://github.com/nymtech/nym/pull/745) ([neacsu](https://github.com/neacsu))
-- Reinstate the POST method blind_sign [\#744](https://github.com/nymtech/nym/pull/744) ([neacsu](https://github.com/neacsu))
+- Reinstate the POST method blind\_sign [\#744](https://github.com/nymtech/nym/pull/744) ([neacsu](https://github.com/neacsu))
 - explorer-api: add pending field to port check response [\#742](https://github.com/nymtech/nym/pull/742) ([mmsinclair](https://github.com/mmsinclair))
 - Feature/use delegation rates [\#741](https://github.com/nymtech/nym/pull/741) ([neacsu](https://github.com/neacsu))
 - Feature/copy to clipboard [\#740](https://github.com/nymtech/nym/pull/740) ([fmtabbara](https://github.com/fmtabbara))
 - 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/nyxd client integration [\#736](https://github.com/nymtech/nym/pull/736) ([jstuczyn](https://github.com/jstuczyn))
+- Feature/nymd 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 nyxd client api [\#732](https://github.com/nymtech/nym/pull/732) ([jstuczyn](https://github.com/jstuczyn))
+- Feature/completing nymd 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/nyxd client fee handling [\#730](https://github.com/nymtech/nym/pull/730) ([jstuczyn](https://github.com/jstuczyn))
+- Feature/nymd 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 nyxd/cosmwasm client [\#724](https://github.com/nymtech/nym/pull/724) ([jstuczyn](https://github.com/jstuczyn))
+- Rust nymd/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))
@@ -787,8 +472,10 @@ 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 nyxd [\#690](https://github.com/nymtech/nym/pull/690) ([futurechimp](https://github.com/futurechimp))
+- Using validator API instead of nymd [\#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))
 
-\* _This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)_
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

Cargo.toml

@@ -17,33 +17,28 @@ opt-level = 3
 
 resolver = "2"
 members = [
+    "clients/client-core",
     "clients/credential",
     "clients/native",
     "clients/native/websocket-requests",
     "clients/socks5",
-    "common/bin-common",
-    "common/client-core",
+    "common/bandwidth-claim-contract",
     "common/client-libs/gateway-client",
     "common/client-libs/mixnet-client",
     "common/client-libs/validator-client",
     "common/coconut-interface",
-    "common/commands",
     "common/config",
     "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",
-    "common/dkg",
+    "common/crypto/dkg",
     "common/execute",
     "common/inclusion-probability",
-    "common/ledger",
     "common/mixnode-common",
     "common/network-defaults",
     "common/nonexhaustive-delayqueue",
@@ -59,7 +54,6 @@ members = [
     "common/nymsphinx/params",
     "common/nymsphinx/types",
     "common/pemstore",
-    "common/socks5-client-core",
     "common/socks5/proxy-helpers",
     "common/socks5/requests",
     "common/statistics",
@@ -70,16 +64,11 @@ members = [
     "explorer-api",
     "gateway",
     "gateway/gateway-requests",
-    "integrations/bity",
     "mixnode",
-    "sdk/rust/nym-sdk",
-    "service-providers/common",
     "service-providers/network-requester",
     "service-providers/network-statistics",
-    "nym-api",
-    "nym-api/nym-api-requests",
-    "nym-outfox",
-    "tools/nym-cli",
+    "validator-api",
+    "validator-api/validator-api-requests",
     "tools/ts-rs-cli"
 ]
 
@@ -90,42 +79,8 @@ default-members = [
     "service-providers/network-requester",
     "service-providers/network-statistics",
     "mixnode",
-    "nym-api",
+    "validator-api",
     "explorer-api",
 ]
 
-exclude = ["explorer", "contracts", "clients/webassembly", "nym-wallet", "nym-connect/mobile/src-tauri", "nym-connect/desktop", "cpu-cycles"]
-
-[workspace.package]
-authors = ["Nym Technologies SA"]
-repository = "https://github.com/nymtech/nym"
-homepage = "https://nymtech.net"
-documentation = "https://nymtech.net"
-edition = "2021"
-license = "Apache-2.0"
-
-[workspace.dependencies]
-async-trait = "0.1.64"
-bip39 = { version = "2.0.0", features = ["zeroize"] }
-cfg-if = "1.0.0"
-cosmwasm-derive = "=1.0.0"
-cosmwasm-schema = "=1.0.0"
-cosmwasm-std = "=1.0.0"
-cosmwasm-storage = "=1.0.0"
-cw-utils = "=0.13.4"
-cw-storage-plus = "=0.13.4"
-cw2 = { version = "=0.13.4" }
-cw3 = { version = "=0.13.4" }
-cw3-fixed-multisig = { version = "=0.13.4" }
-cw4 = { version = "=0.13.4" }
-dotenvy = "0.15.6"
-lazy_static = "1.4.0"
-log = "0.4"
-once_cell = "1.7.2"
-rand = "0.8.5"
-serde = "1.0.152"
-serde_json = "1.0.91"
-tap = "1.0.1"
-thiserror = "1.0.38"
-tokio = "1.24.1"
-url = "2.2"
+exclude = ["explorer", "contracts", "tokenomics-py", "clients/webassembly", "nym-wallet", "nym-connect"]

Makefile

@@ -1,96 +1,89 @@
-# Default target
-all: test
-
 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-all-main clippy-all-contracts clippy-all-wallet clippy-all-connect
+clippy-happy: clippy-happy-main clippy-happy-contracts clippy-happy-wallet clippy-happy-connect
+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
+fmt: fmt-main fmt-contracts fmt-wallet fmt-connect
 
-# -----------------------------------------------------------------------------
-# Define targets for a given workspace
-#  $(1): name
-#  $(2): path to workspace
-#  $(3): extra arguments to cargo
-# -----------------------------------------------------------------------------
-define add_cargo_workspace
+clippy-happy-main:
+	cargo clippy
 
-clippy-happy-$(1):
-	cargo clippy --manifest-path $(2)/Cargo.toml $(3)
+clippy-happy-contracts:
+	cargo clippy --manifest-path contracts/Cargo.toml --target wasm32-unknown-unknown
 
-clippy-$(1):
-	cargo clippy --manifest-path $(2)/Cargo.toml --workspace $(3) -- -D warnings
+clippy-happy-wallet:
+	cargo clippy --manifest-path nym-wallet/Cargo.toml
 
-clippy-$(1)-examples:
-	cargo clippy --manifest-path $(2)/Cargo.toml --workspace --examples -- -D warnings
+clippy-happy-connect:
+	cargo clippy --manifest-path nym-connect/Cargo.toml
 
-test-$(1):
-	cargo test --manifest-path $(2)/Cargo.toml --workspace
+clippy-all-main:
+	cargo clippy --workspace --all-features -- -D warnings
 
-test-$(1)-expensive:
-	cargo test --manifest-path $(2)/Cargo.toml --workspace -- --ignored
+clippy-all-contracts:
+	cargo clippy --workspace --manifest-path contracts/Cargo.toml --all-features --target wasm32-unknown-unknown -- -D warnings
 
-build-$(1):
-	cargo build --manifest-path $(2)/Cargo.toml --workspace $(3)
+clippy-all-wallet:
+	cargo clippy --workspace --manifest-path nym-wallet/Cargo.toml --all-features -- -D warnings
 
-build-$(1)-examples:
-	cargo build --manifest-path $(2)/Cargo.toml --workspace --examples
+clippy-all-connect:
+	cargo clippy --workspace --manifest-path nym-connect/Cargo.toml --all-features -- -D warnings
 
-fmt-$(1):
-	cargo fmt --manifest-path $(2)/Cargo.toml --all
+test-main:
+	cargo test --all-features --workspace
 
-clippy-happy: clippy-happy-$(1)
-clippy-all: clippy-$(1) clippy-$(1)-examples
-cargo-test: test-$(1)
-cargo-test-expensive: test-$(1)-expensive
-build: build-$(1) build-$(1)-examples
-fmt: fmt-$(1)
+test-main-expensive:
+	cargo test --all-features --workspace -- --ignored
 
-endef
+test-contracts:
+	cargo test --manifest-path contracts/Cargo.toml --all-features
 
-# -----------------------------------------------------------------------------
-# Rust workspaces
-# -----------------------------------------------------------------------------
+test-contracts-expensive:
+	cargo test --manifest-path contracts/Cargo.toml --all-features -- --ignored
 
-# Generate targets for the various cargo workspaces
+test-wallet:
+	cargo test --manifest-path nym-wallet/Cargo.toml --all-features
 
-$(eval $(call add_cargo_workspace,main,.))
-$(eval $(call add_cargo_workspace,contracts,contracts,--target wasm32-unknown-unknown))
-$(eval $(call add_cargo_workspace,wasm-client,clients/webassembly,--target wasm32-unknown-unknown))
-$(eval $(call add_cargo_workspace,wallet,nym-wallet,))
-$(eval $(call add_cargo_workspace,connect,nym-connect/desktop))
-ifndef NYM_NO_MOBILE
-$(eval $(call add_cargo_workspace,connect-mobile,nym-connect/mobile/src-tauri))
-endif
+test-wallet-expensive:
+	cargo test --manifest-path nym-wallet/Cargo.toml --all-features -- --ignored
 
-# -----------------------------------------------------------------------------
-# Convenience targets for crates that are already part of the main workspace
-# -----------------------------------------------------------------------------
+test-connect:
+	cargo test --manifest-path nym-connect/Cargo.toml --all-features
 
-build-explorer-api:
-	cargo build -p explorer-api
+test-connect-expensive:
+	cargo test --manifest-path nym-connect/Cargo.toml --all-features -- --ignored
 
-build-nym-cli:
-	cargo build -p nym-cli --release
+build-main:
+	cargo build --workspace
 
-# -----------------------------------------------------------------------------
-# Misc
-# -----------------------------------------------------------------------------
+build-contracts:
+	cargo build --manifest-path contracts/Cargo.toml --workspace
+
+build-wallet:
+	cargo build --manifest-path nym-wallet/Cargo.toml --workspace
+
+build-connect:
+	cargo build --manifest-path nym-connect/Cargo.toml --workspace
+
+fmt-main:
+	cargo fmt --all
+
+fmt-contracts:
+	cargo fmt --manifest-path contracts/Cargo.toml --all
+
+fmt-wallet:
+	cargo fmt --manifest-path nym-wallet/Cargo.toml --all
+
+fmt-connect:
+	cargo fmt --manifest-path nym-connect/Cargo.toml --all
 
 wasm:
 	RUSTFLAGS='-C link-arg=-s' cargo build --manifest-path contracts/Cargo.toml --release --target wasm32-unknown-unknown
-	wasm-opt --disable-sign-ext -Os contracts/target/wasm32-unknown-unknown/release/vesting_contract.wasm -o contracts/target/wasm32-unknown-unknown/release/vesting_contract.wasm
-	wasm-opt --disable-sign-ext -Os contracts/target/wasm32-unknown-unknown/release/mixnet_contract.wasm -o contracts/target/wasm32-unknown-unknown/release/mixnet_contract.wasm
-
-# NOTE: this seems deprecated an not needed anymore?
-mixnet-opt: wasm
-	cd contracts/mixnet && make opt
 
 generate-typescript:
 	cd tools/ts-rs-cli && cargo run && cd ../..
 	yarn types:lint:fix
-
-run-api-tests:
-	cd nym-api/tests/functional_test && yarn test:qa

README.md

@@ -16,7 +16,7 @@ The platform is composed of multiple Rust crates. Top-level executable binary cr
 * nym-wallet - a desktop wallet implemented using the [Tauri](https://tauri.studio/en/docs/about/intro) framework. 
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
-[![Build Status](https://img.shields.io/github/actions/workflow/status/nymtech/nym/build.yml?branch=develop&style=for-the-badge&logo=github-actions)](https://github.com/nymtech/nym/actions?query=branch%3Adevelop)
+[![Build Status](https://img.shields.io/github/workflow/status/nymtech/nym/Continuous%20integration/develop?style=for-the-badge&logo=github-actions)](https://github.com/nymtech/nym/actions?query=branch%3Adevelop)
 
 
 ### Building

clients/client-core/Cargo.toml

@@ -0,0 +1,35 @@
+[package]
+name = "client-core"
+version = "1.0.1"
+authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+dirs = "4.0"
+futures = "0.3"
+humantime-serde = "1.0"
+log = "0.4"
+rand = { version = "0.7.3", features = ["wasm-bindgen"] }
+serde = { version = "1.0", features = ["derive"] }
+sled = "0.34"
+tokio = { version = "1.19.1", features = ["macros"] }
+url = { version ="2.2", features = ["serde"] }
+
+# internal
+config = { path = "../../common/config" }
+crypto = { path = "../../common/crypto" }
+gateway-client = { path = "../../common/client-libs/gateway-client" }
+gateway-requests = { path = "../../gateway/gateway-requests" }
+nonexhaustive-delayqueue = { path = "../../common/nonexhaustive-delayqueue" }
+nymsphinx = { path = "../../common/nymsphinx" }
+pemstore = { path = "../../common/pemstore" }
+topology = { path = "../../common/topology" }
+validator-client = { path = "../../common/client-libs/validator-client" }
+
+[dev-dependencies]
+tempfile = "3.1.0"
+
+[features]
+coconut = ["gateway-client/coconut", "gateway-requests/coconut"]

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

@@ -3,27 +3,19 @@
 
 use crate::client::mix_traffic::BatchMixMessageSender;
 use crate::client::topology_control::TopologyAccessor;
-use crate::spawn_future;
 use futures::task::{Context, Poll};
 use futures::{Future, Stream, StreamExt};
 use log::*;
-use nym_sphinx::acknowledgements::AckKey;
-use nym_sphinx::addressing::clients::Recipient;
-use nym_sphinx::cover::generate_loop_cover_packet;
-use nym_sphinx::params::PacketSize;
-use nym_sphinx::utils::sample_poisson_duration;
+use nymsphinx::acknowledgements::AckKey;
+use nymsphinx::addressing::clients::Recipient;
+use nymsphinx::cover::generate_loop_cover_packet;
+use nymsphinx::utils::sample_poisson_duration;
 use rand::{rngs::OsRng, CryptoRng, Rng};
 use std::pin::Pin;
 use std::sync::Arc;
-use std::time::Duration;
-use tokio::sync::mpsc::error::TrySendError;
-
-#[cfg(not(target_arch = "wasm32"))]
+use tokio::task::JoinHandle;
 use tokio::time;
 
-#[cfg(target_arch = "wasm32")]
-use wasm_timer;
-
 pub struct LoopCoverTrafficStream<R>
 where
     R: CryptoRng + Rng,
@@ -32,22 +24,18 @@ where
     ack_key: Arc<AckKey>,
 
     /// Average delay an acknowledgement packet is going to get delay at a single mixnode.
-    average_ack_delay: Duration,
+    average_ack_delay: time::Duration,
 
     /// Average delay a data packet is going to get delay at a single mixnode.
-    average_packet_delay: Duration,
+    average_packet_delay: time::Duration,
 
     /// Average delay between sending subsequent cover packets.
-    average_cover_message_sending_delay: Duration,
+    average_cover_message_sending_delay: time::Duration,
 
     /// Internal state, determined by `average_message_sending_delay`,
     /// used to keep track of when a next packet should be sent out.
-    #[cfg(not(target_arch = "wasm32"))]
     next_delay: Pin<Box<time::Sleep>>,
 
-    #[cfg(target_arch = "wasm32")]
-    next_delay: Pin<Box<wasm_timer::Delay>>,
-
     /// Channel used for sending prepared sphinx packets to `MixTrafficController` that sends them
     /// out to the network without any further delays.
     mix_tx: BatchMixMessageSender,
@@ -60,9 +48,6 @@ where
 
     /// Accessor to the common instance of network topology.
     topology_access: TopologyAccessor,
-
-    /// Predefined packet size used for the loop cover messages.
-    packet_size: PacketSize,
 }
 
 impl<R> Stream for LoopCoverTrafficStream<R>
@@ -84,21 +69,13 @@ where
         // we know it's time to send a message, so let's prepare delay for the next one
         // Get the `now` by looking at the current `delay` deadline
         let avg_delay = self.average_cover_message_sending_delay;
+        let now = self.next_delay.deadline();
         let next_poisson_delay = sample_poisson_duration(&mut self.rng, avg_delay);
 
         // The next interval value is `next_poisson_delay` after the one that just
         // yielded.
-        #[cfg(not(target_arch = "wasm32"))]
-        {
-            let now = self.next_delay.deadline();
-            let next = now + next_poisson_delay;
-            self.next_delay.as_mut().reset(next);
-        }
-
-        #[cfg(target_arch = "wasm32")]
-        {
-            self.next_delay.as_mut().reset(next_poisson_delay);
-        }
+        let next = now + next_poisson_delay;
+        self.next_delay.as_mut().reset(next);
 
         Poll::Ready(Some(()))
     }
@@ -107,52 +84,30 @@ where
 // obviously when we finally make shared rng that is on 'higher' level, this should become
 // generic `R`
 impl LoopCoverTrafficStream<OsRng> {
-    #[allow(clippy::too_many_arguments)]
     pub fn new(
         ack_key: Arc<AckKey>,
-        average_ack_delay: Duration,
-        average_packet_delay: Duration,
-        average_cover_message_sending_delay: Duration,
+        average_ack_delay: time::Duration,
+        average_packet_delay: time::Duration,
+        average_cover_message_sending_delay: time::Duration,
         mix_tx: BatchMixMessageSender,
         our_full_destination: Recipient,
         topology_access: TopologyAccessor,
     ) -> Self {
         let rng = OsRng;
 
-        #[cfg(not(target_arch = "wasm32"))]
-        let next_delay = Box::pin(time::sleep(Default::default()));
-
-        #[cfg(target_arch = "wasm32")]
-        let next_delay = Box::pin(wasm_timer::Delay::new(Default::default()));
-
         LoopCoverTrafficStream {
             ack_key,
             average_ack_delay,
             average_packet_delay,
             average_cover_message_sending_delay,
-            next_delay,
+            next_delay: Box::pin(time::sleep(Default::default())),
             mix_tx,
             our_full_destination,
             rng,
             topology_access,
-            packet_size: Default::default(),
         }
     }
 
-    pub fn set_custom_packet_size(&mut self, packet_size: PacketSize) {
-        self.packet_size = packet_size;
-    }
-
-    fn set_next_delay(&mut self, amount: Duration) {
-        #[cfg(not(target_arch = "wasm32"))]
-        let next_delay = Box::pin(time::sleep(amount));
-
-        #[cfg(target_arch = "wasm32")]
-        let next_delay = Box::pin(wasm_timer::Delay::new(amount));
-
-        self.next_delay = next_delay;
-    }
-
     async fn on_new_message(&mut self) {
         trace!("next cover message!");
 
@@ -161,44 +116,31 @@ impl LoopCoverTrafficStream<OsRng> {
         // poisson delay, but is it really a problem?
         let topology_permit = self.topology_access.get_read_permit().await;
         // the ack is sent back to ourselves (and then ignored)
-        let topology_ref = match topology_permit.try_get_valid_topology_ref(
+        let topology_ref_option = topology_permit.try_get_valid_topology_ref(
             &self.our_full_destination,
             Some(&self.our_full_destination),
-        ) {
-            Ok(topology) => topology,
-            Err(err) => {
-                warn!("We're not going to send any loop cover message this time, as the current topology seem to be invalid - {err}");
-                return;
-            }
-        };
+        );
+        if topology_ref_option.is_none() {
+            warn!("No valid topology detected - won't send any loop cover message this time");
+            return;
+        }
+        let topology_ref = topology_ref_option.unwrap();
 
         let cover_message = generate_loop_cover_packet(
             &mut self.rng,
             topology_ref,
-            &self.ack_key,
+            &*self.ack_key,
             &self.our_full_destination,
             self.average_ack_delay,
             self.average_packet_delay,
-            self.packet_size,
         )
         .expect("Somehow failed to generate a loop cover message with a valid topology");
 
-        if let Err(err) = self.mix_tx.try_send(vec![cover_message]) {
-            match err {
-                TrySendError::Full(_) => {
-                    // This isn't a problem, if the channel is full means we're already sending the
-                    // max amount of messages downstream can handle.
-                    log::debug!("Failed to send cover message - channel full");
-                    // However it's still useful to alert the user that the gateway or the link to
-                    // the gateway can't keep up. Either due to insufficient bandwidth on the
-                    // client side, or that the gateway is overloaded.
-                    log::warn!("Failed to send sphinx packet - gateway or connection to gateway can't keep up");
-                }
-                TrySendError::Closed(_) => {
-                    log::warn!("Failed to send cover message - channel closed");
-                }
-            }
-        }
+        // if this one fails, there's no retrying because it means that either:
+        // - we run out of memory
+        // - the receiver channel is closed
+        // in either case there's no recovery and we can only panic
+        self.mix_tx.unbounded_send(vec![cover_message]).unwrap();
 
         // TODO: I'm not entirely sure whether this is really required, because I'm not 100%
         // sure how `yield_now()` works - whether it just notifies the scheduler or whether it
@@ -207,39 +149,24 @@ impl LoopCoverTrafficStream<OsRng> {
 
         // JS: due to identical logical structure to OutQueueControl::on_message(), this is also
         // presumably required to prevent bugs in the future. Exact reason is still unknown to me.
-
-        // TODO: temporary and BAD workaround for wasm (we should find a way to yield here in wasm)
-        #[cfg(not(target_arch = "wasm32"))]
         tokio::task::yield_now().await;
     }
 
-    pub fn start_with_shutdown(mut self, mut shutdown: nym_task::TaskClient) {
+    async fn run(&mut self) {
         // we should set initial delay only when we actually start the stream
-        let sampled =
-            sample_poisson_duration(&mut self.rng, self.average_cover_message_sending_delay);
-        self.set_next_delay(sampled);
+        self.next_delay = Box::pin(time::sleep(sample_poisson_duration(
+            &mut self.rng,
+            self.average_cover_message_sending_delay,
+        )));
 
-        spawn_future(async move {
-            debug!("Started LoopCoverTrafficStream with graceful shutdown support");
+        while self.next().await.is_some() {
+            self.on_new_message().await;
+        }
+    }
 
-            while !shutdown.is_shutdown() {
-                tokio::select! {
-                    biased;
-                    _ = shutdown.recv() => {
-                        log::trace!("LoopCoverTrafficStream: Received shutdown");
-                    }
-                    next = self.next() => {
-                        if next.is_some() {
-                            self.on_new_message().await;
-                        } else {
-                            log::trace!("LoopCoverTrafficStream: Stopping since channel closed");
-                            break;
-                        }
-                    }
-                }
-            }
-            shutdown.recv_timeout().await;
-            log::debug!("LoopCoverTrafficStream: Exiting");
+    pub fn start(mut self) -> JoinHandle<()> {
+        tokio::spawn(async move {
+            self.run().await;
         })
     }
 }

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

@@ -0,0 +1,33 @@
+use futures::channel::mpsc;
+use nymsphinx::addressing::clients::Recipient;
+use nymsphinx::anonymous_replies::ReplySurb;
+
+pub type InputMessageSender = mpsc::UnboundedSender<InputMessage>;
+pub type InputMessageReceiver = mpsc::UnboundedReceiver<InputMessage>;
+
+#[derive(Debug)]
+pub enum InputMessage {
+    Fresh {
+        recipient: Recipient,
+        data: Vec<u8>,
+        with_reply_surb: bool,
+    },
+    Reply {
+        reply_surb: ReplySurb,
+        data: Vec<u8>,
+    },
+}
+
+impl InputMessage {
+    pub fn new_fresh(recipient: Recipient, data: Vec<u8>, with_reply_surb: bool) -> Self {
+        InputMessage::Fresh {
+            recipient,
+            data,
+            with_reply_surb,
+        }
+    }
+
+    pub fn new_reply(reply_surb: ReplySurb, data: Vec<u8>) -> Self {
+        InputMessage::Reply { reply_surb, data }
+    }
+}

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

@@ -2,10 +2,10 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::config::persistence::key_pathfinder::ClientKeyPathfinder;
+use crypto::asymmetric::{encryption, identity};
 use gateway_requests::registration::handshake::SharedKeys;
 use log::*;
-use nym_crypto::asymmetric::{encryption, identity};
-use nym_sphinx::acknowledgements::AckKey;
+use nymsphinx::acknowledgements::AckKey;
 use rand::{CryptoRng, RngCore};
 use std::io;
 use std::sync::Arc;
@@ -17,7 +17,6 @@ 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>,
@@ -42,6 +41,9 @@ 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
@@ -55,161 +57,87 @@ impl KeyManager {
         }
     }
 
-    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),
-        }
+    // 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)
     }
 
-    /// Loads previously stored client keys from the disk.
-    fn load_client_keys(client_pathfinder: &ClientKeyPathfinder) -> io::Result<Self> {
+    /// Loads previously stored keys from the disk.
+    pub fn load_keys(client_pathfinder: &ClientKeyPathfinder) -> io::Result<Self> {
         let identity_keypair: identity::KeyPair =
-            nym_pemstore::load_keypair(&nym_pemstore::KeyPairPath::new(
+            pemstore::load_keypair(&pemstore::KeyPairPath::new(
                 client_pathfinder.private_identity_key().to_owned(),
                 client_pathfinder.public_identity_key().to_owned(),
             ))?;
         let encryption_keypair: encryption::KeyPair =
-            nym_pemstore::load_keypair(&nym_pemstore::KeyPairPath::new(
+            pemstore::load_keypair(&pemstore::KeyPairPath::new(
                 client_pathfinder.private_encryption_key().to_owned(),
                 client_pathfinder.public_encryption_key().to_owned(),
             ))?;
 
-        let ack_key: AckKey = nym_pemstore::load_key(client_pathfinder.ack_key())?;
+        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: None,
+            gateway_shared_key: Some(Arc::new(gateway_shared_key)),
             ack_key: Arc::new(ack_key),
         })
     }
 
-    /// 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 =
-            nym_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> =
-            nym_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)
-    }
-
+    // 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)]
     /// 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
     // during `load_keys` to generate the said key.
     pub fn store_keys(&self, client_pathfinder: &ClientKeyPathfinder) -> io::Result<()> {
-        nym_pemstore::store_keypair(
+        pemstore::store_keypair(
             self.identity_keypair.as_ref(),
-            &nym_pemstore::KeyPairPath::new(
+            &pemstore::KeyPairPath::new(
                 client_pathfinder.private_identity_key().to_owned(),
                 client_pathfinder.public_identity_key().to_owned(),
             ),
         )?;
-        nym_pemstore::store_keypair(
+        pemstore::store_keypair(
             self.encryption_keypair.as_ref(),
-            &nym_pemstore::KeyPairPath::new(
+            &pemstore::KeyPairPath::new(
                 client_pathfinder.private_encryption_key().to_owned(),
                 client_pathfinder.public_encryption_key().to_owned(),
             ),
         )?;
 
-        nym_pemstore::store_key(self.ack_key.as_ref(), client_pathfinder.ack_key())?;
+        pemstore::store_key(self.ack_key.as_ref(), client_pathfinder.ack_key())?;
 
         match self.gateway_shared_key.as_ref() {
-            None => debug!("No gateway shared key available to store!"),
+            None => warn!("No gateway shared key available to store!"),
             Some(gate_key) => {
-                nym_pemstore::store_key(gate_key.as_ref(), client_pathfinder.gateway_shared_key())?
+                pemstore::store_key(gate_key.as_ref(), client_pathfinder.gateway_shared_key())?
             }
         }
 
         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) => {
-                nym_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
@@ -221,7 +149,8 @@ impl KeyManager {
         )
     }
 
-    pub fn is_gateway_key_set(&self) -> bool {
-        self.gateway_shared_key.is_some()
+    /// Gets an atomically reference counted pointer to [`AckKey`].
+    pub fn ack_key(&self) -> Arc<AckKey> {
+        Arc::clone(&self.ack_key)
     }
 }

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

@@ -0,0 +1,79 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use futures::channel::mpsc;
+use futures::StreamExt;
+use gateway_client::GatewayClient;
+use log::*;
+use nymsphinx::forwarding::packet::MixPacket;
+use tokio::task::JoinHandle;
+
+pub type BatchMixMessageSender = mpsc::UnboundedSender<Vec<MixPacket>>;
+pub type BatchMixMessageReceiver = mpsc::UnboundedReceiver<Vec<MixPacket>>;
+
+const MAX_FAILURE_COUNT: usize = 100;
+
+pub struct MixTrafficController {
+    // 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,
+    mix_rx: BatchMixMessageReceiver,
+
+    // TODO: this is temporary work-around.
+    // in long run `gateway_client` will be moved away from `MixTrafficController` anyway.
+    consecutive_gateway_failure_count: usize,
+}
+
+impl MixTrafficController {
+    pub fn new(
+        mix_rx: BatchMixMessageReceiver,
+        gateway_client: GatewayClient,
+    ) -> MixTrafficController {
+        MixTrafficController {
+            gateway_client,
+            mix_rx,
+            consecutive_gateway_failure_count: 0,
+        }
+    }
+
+    async fn on_messages(&mut self, mut mix_packets: Vec<MixPacket>) {
+        debug_assert!(!mix_packets.is_empty());
+
+        let result = if mix_packets.len() == 1 {
+            let mix_packet = mix_packets.pop().unwrap();
+            self.gateway_client.send_mix_packet(mix_packet).await
+        } else {
+            self.gateway_client
+                .batch_send_mix_packets(mix_packets)
+                .await
+        };
+
+        match result {
+            Err(e) => {
+                error!("Failed to send sphinx packet(s) to the gateway! - {:?}", e);
+                self.consecutive_gateway_failure_count += 1;
+                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)
+                }
+            }
+            Ok(_) => {
+                trace!("We *might* have managed to forward sphinx packet(s) to the gateway!");
+                self.consecutive_gateway_failure_count = 0;
+            }
+        }
+    }
+
+    pub async fn run(&mut self) {
+        while let Some(mix_packets) = self.mix_rx.next().await {
+            self.on_messages(mix_packets).await;
+        }
+    }
+
+    pub fn start(mut self) -> JoinHandle<()> {
+        tokio::spawn(async move {
+            self.run().await;
+        })
+    }
+}

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

@@ -0,0 +1,8 @@
+pub mod cover_traffic_stream;
+pub mod inbound_messages;
+pub mod key_manager;
+pub mod mix_traffic;
+pub mod real_messages_control;
+pub mod received_buffer;
+pub mod reply_key_storage;
+pub mod topology_control;

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

@@ -1,11 +1,11 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use super::action_controller::{AckActionSender, Action};
+use super::action_controller::{Action, ActionSender};
 use futures::StreamExt;
 use gateway_client::AcknowledgementReceiver;
 use log::*;
-use nym_sphinx::{
+use nymsphinx::{
     acknowledgements::{identifier::recover_identifier, AckKey},
     chunking::fragment::{FragmentIdentifier, COVER_FRAG_ID},
 };
@@ -16,14 +16,14 @@ use std::sync::Arc;
 pub(super) struct AcknowledgementListener {
     ack_key: Arc<AckKey>,
     ack_receiver: AcknowledgementReceiver,
-    action_sender: AckActionSender,
+    action_sender: ActionSender,
 }
 
 impl AcknowledgementListener {
     pub(super) fn new(
         ack_key: Arc<AckKey>,
         ack_receiver: AcknowledgementReceiver,
-        action_sender: AckActionSender,
+        action_sender: ActionSender,
     ) -> Self {
         AcknowledgementListener {
             ack_key,
@@ -33,7 +33,7 @@ impl AcknowledgementListener {
     }
 
     async fn on_ack(&mut self, ack_content: Vec<u8>) {
-        trace!("Received an ack");
+        debug!("Received an ack");
         let frag_id = match recover_identifier(&self.ack_key, &ack_content)
             .map(FragmentIdentifier::try_from_bytes)
         {
@@ -49,6 +49,11 @@ impl AcknowledgementListener {
         if frag_id == COVER_FRAG_ID {
             trace!("Received an ack for a cover message - no need to do anything");
             return;
+        } else if frag_id.is_reply() {
+            info!("Received an ack for a reply message - no need to do anything! (don't know what to do!)");
+            // TODO: probably there will need to be some extra procedure here, something to notify
+            // user that his reply reached the recipient (since we got an ack)
+            return;
         }
 
         trace!("Received {} from the mix network", frag_id);
@@ -58,31 +63,14 @@ impl AcknowledgementListener {
             .unwrap();
     }
 
-    async fn handle_ack_receiver_item(&mut self, item: Vec<Vec<u8>>) {
-        // realistically we would only be getting one ack at the time
-        for ack in item {
-            self.on_ack(ack).await;
-        }
-    }
-
-    pub(super) async fn run_with_shutdown(&mut self, mut shutdown: nym_task::TaskClient) {
-        debug!("Started AcknowledgementListener with graceful shutdown support");
-
-        while !shutdown.is_shutdown() {
-            tokio::select! {
-                acks = self.ack_receiver.next() => match acks {
-                    Some(acks) => self.handle_ack_receiver_item(acks).await,
-                    None => {
-                        log::trace!("AcknowledgementListener: Stopping since channel closed");
-                        break;
-                    }
-                },
-                _ = shutdown.recv_with_delay() => {
-                    log::trace!("AcknowledgementListener: Received shutdown");
-                }
+    pub(super) async fn run(&mut self) {
+        debug!("Started AcknowledgementListener");
+        while let Some(acks) = self.ack_receiver.next().await {
+            // realistically we would only be getting one ack at the time
+            for ack in acks {
+                self.on_ack(ack).await;
             }
         }
-        shutdown.recv_timeout().await;
-        log::debug!("AcknowledgementListener: Exiting");
+        error!("TODO: error msg. Or maybe panic?")
     }
 }

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

@@ -3,18 +3,17 @@
 
 use super::PendingAcknowledgement;
 use crate::client::real_messages_control::acknowledgement_control::RetransmissionRequestSender;
-use futures::channel::mpsc;
+use futures::channel::mpsc::{self, UnboundedReceiver, UnboundedSender};
 use futures::StreamExt;
 use log::*;
-use nym_nonexhaustive_delayqueue::{Expired, NonExhaustiveDelayQueue, QueueKey};
-use nym_sphinx::chunking::fragment::FragmentIdentifier;
-use nym_sphinx::Delay as SphinxDelay;
+use nonexhaustive_delayqueue::{Expired, NonExhaustiveDelayQueue, QueueKey};
+use nymsphinx::chunking::fragment::FragmentIdentifier;
+use nymsphinx::Delay as SphinxDelay;
 use std::collections::HashMap;
 use std::sync::Arc;
 use std::time::Duration;
 
-pub(crate) type AckActionSender = mpsc::UnboundedSender<Action>;
-pub(crate) type AckActionReceiver = mpsc::UnboundedReceiver<Action>;
+pub(crate) type ActionSender = UnboundedSender<Action>;
 
 // The actual data being sent off as well as potential key to the delay queue
 type PendingAckEntry = (Arc<PendingAcknowledgement>, Option<QueueKey>);
@@ -96,7 +95,7 @@ pub(super) struct ActionController {
     pending_acks_timers: NonExhaustiveDelayQueue<FragmentIdentifier>,
 
     /// Channel for receiving `Action`s from other modules.
-    incoming_actions: AckActionReceiver,
+    incoming_actions: UnboundedReceiver<Action>,
 
     /// Channel for notifying `RetransmissionRequestListener` about expired acknowledgements.
     retransmission_sender: RetransmissionRequestSender,
@@ -106,15 +105,18 @@ impl ActionController {
     pub(super) fn new(
         config: Config,
         retransmission_sender: RetransmissionRequestSender,
-        incoming_actions: AckActionReceiver,
-    ) -> Self {
-        ActionController {
-            config,
-            pending_acks_data: HashMap::new(),
-            pending_acks_timers: NonExhaustiveDelayQueue::new(),
-            incoming_actions,
-            retransmission_sender,
-        }
+    ) -> (Self, ActionSender) {
+        let (sender, receiver) = mpsc::unbounded();
+        (
+            ActionController {
+                config,
+                pending_acks_data: HashMap::new(),
+                pending_acks_timers: NonExhaustiveDelayQueue::new(),
+                incoming_actions: receiver,
+                retransmission_sender,
+            },
+            sender,
+        )
     }
 
     fn handle_insert(&mut self, pending_acks: Vec<PendingAcknowledgement>) {
@@ -136,18 +138,13 @@ impl ActionController {
         trace!("{} is starting its timer", frag_id);
 
         if let Some((pending_ack_data, queue_key)) = self.pending_acks_data.get_mut(&frag_id) {
-            // the fact that this branch is now POSSIBLE is a sign of a need to refactor this whole
-            // retransmission procedure
-            //
-            // (it can happen as timer is started when ack expires to make sure it's not stuck in memory
-            // and the second instance can be fired when we finally get reply surbs for data we failed to retransmit)
-
-            // if queue_key.is_some() {
-            //     // this branch should be IMPOSSIBLE under ANY condition. It would imply starting
-            //     // timer TWICE for the SAME PendingAcknowledgement
-            //     panic!("Tried to start an already started ack timer!")
-            // }
-            let timeout = (pending_ack_data.delay * self.config.ack_wait_multiplier).to_duration()
+            if queue_key.is_some() {
+                // this branch should be IMPOSSIBLE under ANY condition. It would imply starting
+                // timer TWICE for the SAME PendingAcknowledgement
+                panic!("Tried to start an already started ack timer!")
+            }
+            let timeout = (pending_ack_data.delay.clone() * self.config.ack_wait_multiplier)
+                .to_duration()
                 + self.config.ack_wait_addition;
 
             let new_queue_key = self.pending_acks_timers.insert(frag_id, timeout);
@@ -195,8 +192,7 @@ impl ActionController {
         trace!("{} is updating its delay", frag_id);
         // TODO: is it possible to solve this without either locking or temporarily removing the value?
         if let Some((pending_ack_data, queue_key)) = self.pending_acks_data.remove(&frag_id) {
-            // this Action is triggered by `RetransmissionRequestListener` (for 'normal' packets)
-            // or `ReplyController` (for 'reply' packets) which held the other potential
+            // this Action is triggered by `RetransmissionRequestListener` which held the other potential
             // reference to this Arc. HOWEVER, before the Action was pushed onto the queue, the reference
             // was dropped hence this unwrap is safe.
             let mut inner_data = Arc::try_unwrap(pending_ack_data).unwrap();
@@ -213,11 +209,7 @@ 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>,
-        task_client: &mut nym_task::TaskClient,
-    ) {
+    fn handle_expired_ack_timer(&mut self, expired_ack: Expired<FragmentIdentifier>) {
         // 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?
@@ -235,16 +227,9 @@ 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)
-            if self
-                .retransmission_sender
+            self.retransmission_sender
                 .unbounded_send(Arc::downgrade(pending_ack_data))
-                .is_err()
-            {
-                assert!(
-                    task_client.is_shutdown_poll(),
-                    "Failed to send pending ack for retransmission"
-                );
-            }
+                .unwrap()
         } else {
             // this shouldn't cause any issues but shouldn't have happened to begin with!
             error!("An already removed pending ack has expired")
@@ -260,33 +245,15 @@ impl ActionController {
         }
     }
 
-    pub(super) async fn run_with_shutdown(&mut self, mut shutdown: nym_task::TaskClient) {
-        debug!("Started ActionController with graceful shutdown support");
-
-        while !shutdown.is_shutdown() {
+    pub(super) async fn run(&mut self) {
+        loop {
+            // at some point there will be a global shutdown signal here as the third option
             tokio::select! {
-                action = self.incoming_actions.next() => match action {
-                    Some(action) => self.process_action(action),
-                    None => {
-                        log::trace!(
-                            "ActionController: Stopping since incoming actions channel closed"
-                        );
-                        break;
-                    }
-                },
-                expired_ack = self.pending_acks_timers.next() => match expired_ack {
-                    Some(expired_ack) => self.handle_expired_ack_timer(expired_ack, &mut shutdown),
-                    None => {
-                        log::trace!("ActionController: Stopping since ack channel closed");
-                        break;
-                    }
-                },
-                _ = shutdown.recv_with_delay() => {
-                    log::trace!("ActionController: Received shutdown");
-                }
+                // we NEVER expect for ANY sender to get dropped so unwrap here is fine
+                action = self.incoming_actions.next() => self.process_action(action.unwrap()),
+                // pending ack queue Stream CANNOT return a `None` so unwrap here is fine
+                expired_ack = self.pending_acks_timers.next() => self.handle_expired_ack_timer(expired_ack.unwrap())
             }
         }
-        shutdown.recv_timeout().await;
-        log::debug!("ActionController: Exiting");
     }
 }

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

@@ -0,0 +1,190 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use super::action_controller::{Action, ActionSender};
+use super::PendingAcknowledgement;
+use crate::client::reply_key_storage::ReplyKeyStorage;
+use crate::client::{
+    inbound_messages::{InputMessage, InputMessageReceiver},
+    real_messages_control::real_traffic_stream::{BatchRealMessageSender, RealMessage},
+    topology_control::TopologyAccessor,
+};
+use futures::StreamExt;
+use log::*;
+use nymsphinx::anonymous_replies::ReplySurb;
+use nymsphinx::preparer::MessagePreparer;
+use nymsphinx::{acknowledgements::AckKey, addressing::clients::Recipient};
+use rand::{CryptoRng, Rng};
+use std::sync::Arc;
+
+/// Module responsible for dealing with the received messages: splitting them, creating acknowledgements,
+/// putting everything into sphinx packets, etc.
+/// It also makes an initial sending attempt for said messages.
+pub(super) struct InputMessageListener<R>
+where
+    R: CryptoRng + Rng,
+{
+    ack_key: Arc<AckKey>,
+    ack_recipient: Recipient,
+    input_receiver: InputMessageReceiver,
+    message_preparer: MessagePreparer<R>,
+    action_sender: ActionSender,
+    real_message_sender: BatchRealMessageSender,
+    topology_access: TopologyAccessor,
+    reply_key_storage: ReplyKeyStorage,
+}
+
+impl<R> InputMessageListener<R>
+where
+    R: CryptoRng + Rng,
+{
+    // at this point I'm not entirely sure how to deal with this warning without
+    // some considerable refactoring
+    #[allow(clippy::too_many_arguments)]
+    pub(super) fn new(
+        ack_key: Arc<AckKey>,
+        ack_recipient: Recipient,
+        input_receiver: InputMessageReceiver,
+        message_preparer: MessagePreparer<R>,
+        action_sender: ActionSender,
+        real_message_sender: BatchRealMessageSender,
+        topology_access: TopologyAccessor,
+        reply_key_storage: ReplyKeyStorage,
+    ) -> Self {
+        InputMessageListener {
+            ack_key,
+            ack_recipient,
+            input_receiver,
+            message_preparer,
+            action_sender,
+            real_message_sender,
+            topology_access,
+            reply_key_storage,
+        }
+    }
+
+    // we require topology for replies to generate surb_acks
+    async fn handle_reply(&mut self, reply_surb: ReplySurb, data: Vec<u8>) -> Option<RealMessage> {
+        let topology_permit = self.topology_access.get_read_permit().await;
+        let topology = match topology_permit.try_get_valid_topology_ref(&self.ack_recipient, None) {
+            Some(topology_ref) => topology_ref,
+            None => {
+                warn!("Could not process the message - the network topology is invalid");
+                return None;
+            }
+        };
+
+        match self
+            .message_preparer
+            .prepare_reply_for_use(data, reply_surb, topology, &self.ack_key)
+            .await
+        {
+            Ok((mix_packet, reply_id)) => {
+                // TODO: later probably write pending ack here
+                // and deal with them....
+                // ... somehow
+                Some(RealMessage::new(mix_packet, reply_id))
+            }
+            Err(err) => {
+                // TODO: should we have some mechanism to indicate to the user that the `reply_surb`
+                // could be reused since technically it wasn't used up here?
+                warn!("failed to deal with received reply surb - {:?}", err);
+                None
+            }
+        }
+    }
+
+    async fn handle_fresh_message(
+        &mut self,
+        recipient: Recipient,
+        content: Vec<u8>,
+        with_reply_surb: bool,
+    ) -> Option<Vec<RealMessage>> {
+        let topology_permit = self.topology_access.get_read_permit().await;
+        let topology = match topology_permit
+            .try_get_valid_topology_ref(&self.ack_recipient, Some(&recipient))
+        {
+            Some(topology_ref) => topology_ref,
+            None => {
+                warn!("Could not process the message - the network topology is invalid");
+                return None;
+            }
+        };
+
+        // split the message, attach optional reply surb
+        let (split_message, reply_key) = self
+            .message_preparer
+            .prepare_and_split_message(content, with_reply_surb, topology)
+            .expect("somehow the topology was invalid after all!");
+
+        if let Some(reply_key) = reply_key {
+            self.reply_key_storage
+                .insert_encryption_key(reply_key)
+                .expect("Failed to insert surb reply key to the store!")
+        }
+
+        // encrypt chunks, put them inside sphinx packets and generate acks
+        let mut pending_acks = Vec::with_capacity(split_message.len());
+        let mut real_messages = Vec::with_capacity(split_message.len());
+        for message_chunk in split_message {
+            // we need to clone it because we need to keep it in memory in case we had to retransmit
+            // it. And then we'd need to recreate entire ACK again.
+            let chunk_clone = message_chunk.clone();
+            let prepared_fragment = self
+                .message_preparer
+                .prepare_chunk_for_sending(chunk_clone, topology, &self.ack_key, &recipient)
+                .unwrap();
+
+            real_messages.push(RealMessage::new(
+                prepared_fragment.mix_packet,
+                message_chunk.fragment_identifier(),
+            ));
+
+            pending_acks.push(PendingAcknowledgement::new(
+                message_chunk,
+                prepared_fragment.total_delay,
+                recipient,
+            ));
+        }
+
+        // tells the controller to put this into the hashmap
+        self.action_sender
+            .unbounded_send(Action::new_insert(pending_acks))
+            .unwrap();
+
+        Some(real_messages)
+    }
+
+    async fn on_input_message(&mut self, msg: InputMessage) {
+        let real_messages = match msg {
+            InputMessage::Fresh {
+                recipient,
+                data,
+                with_reply_surb,
+            } => {
+                self.handle_fresh_message(recipient, data, with_reply_surb)
+                    .await
+            }
+            InputMessage::Reply { reply_surb, data } => self
+                .handle_reply(reply_surb, data)
+                .await
+                .map(|message| vec![message]),
+        };
+
+        // there's no point in trying to send nothing
+        if let Some(real_messages) = real_messages {
+            // tells real message sender (with the poisson timer) to send this to the mix network
+            self.real_message_sender
+                .unbounded_send(real_messages)
+                .unwrap();
+        }
+    }
+
+    pub(super) async fn run(&mut self) {
+        debug!("Started InputMessageListener");
+        while let Some(input_msg) = self.input_receiver.next().await {
+            self.on_input_message(input_msg).await;
+        }
+        error!("TODO: error msg. Or maybe panic?")
+    }
+}

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

@@ -7,20 +7,17 @@ use self::{
     retransmission_request_listener::RetransmissionRequestListener,
     sent_notification_listener::SentNotificationListener,
 };
-use crate::client::inbound_messages::InputMessageReceiver;
-use crate::client::real_messages_control::message_handler::MessageHandler;
-use crate::client::replies::reply_controller::ReplyControllerSender;
-use crate::spawn_future;
-use action_controller::AckActionReceiver;
+use super::real_traffic_stream::BatchRealMessageSender;
+use crate::client::reply_key_storage::ReplyKeyStorage;
+use crate::client::{inbound_messages::InputMessageReceiver, topology_control::TopologyAccessor};
 use futures::channel::mpsc;
 use gateway_client::AcknowledgementReceiver;
 use log::*;
-use nym_sphinx::anonymous_replies::requests::AnonymousSenderTag;
-use nym_sphinx::params::PacketSize;
-use nym_sphinx::{
+use nymsphinx::{
     acknowledgements::AckKey,
     addressing::clients::Recipient,
     chunking::fragment::{Fragment, FragmentIdentifier},
+    preparer::MessagePreparer,
     Delay as SphinxDelay,
 };
 use rand::{CryptoRng, Rng};
@@ -28,8 +25,7 @@ use std::{
     sync::{Arc, Weak},
     time::Duration,
 };
-
-pub(crate) use action_controller::{AckActionSender, Action};
+use tokio::task::JoinHandle;
 
 mod acknowledgement_listener;
 mod action_controller;
@@ -51,64 +47,24 @@ pub(super) type SentPacketNotificationSender = mpsc::UnboundedSender<FragmentIde
 /// that it is about to be sent to the mix network and its timeout timer should be started.
 type SentPacketNotificationReceiver = mpsc::UnboundedReceiver<FragmentIdentifier>;
 
-#[derive(Debug)]
-pub(crate) enum PacketDestination {
-    Anonymous {
-        recipient_tag: AnonymousSenderTag,
-        // special flag to indicate whether this was an ack for requesting additional surbs,
-        // in that case we have to do everything we can to get it through, even if it means going
-        // below our stored reply surb threshold
-        extra_surb_request: bool,
-    },
-    KnownRecipient(Box<Recipient>),
-}
-
 /// Structure representing a data `Fragment` that is on-route to the specified `Recipient`
 #[derive(Debug)]
 pub(crate) struct PendingAcknowledgement {
     message_chunk: Fragment,
     delay: SphinxDelay,
-    destination: PacketDestination,
+    recipient: Recipient,
 }
 
 impl PendingAcknowledgement {
     /// Creates new instance of `PendingAcknowledgement` using the provided data.
-    pub(crate) fn new_known(
-        message_chunk: Fragment,
-        delay: SphinxDelay,
-        recipient: Recipient,
-    ) -> Self {
+    fn new(message_chunk: Fragment, delay: SphinxDelay, recipient: Recipient) -> Self {
         PendingAcknowledgement {
             message_chunk,
             delay,
-            destination: PacketDestination::KnownRecipient(recipient.into()),
+            recipient,
         }
     }
 
-    pub(crate) fn new_anonymous(
-        message_chunk: Fragment,
-        delay: SphinxDelay,
-        recipient_tag: AnonymousSenderTag,
-        extra_surb_request: bool,
-    ) -> Self {
-        PendingAcknowledgement {
-            message_chunk,
-            delay,
-            destination: PacketDestination::Anonymous {
-                recipient_tag,
-                extra_surb_request,
-            },
-        }
-    }
-
-    pub(crate) fn inner_fragment_identifier(&self) -> FragmentIdentifier {
-        self.message_chunk.fragment_identifier()
-    }
-
-    pub(crate) fn fragment_data(&self) -> Fragment {
-        self.message_chunk.clone()
-    }
-
     fn update_delay(&mut self, new_delay: SphinxDelay) {
         self.delay = new_delay;
     }
@@ -117,6 +73,10 @@ impl PendingAcknowledgement {
 /// AcknowledgementControllerConnectors represents set of channels for communication with
 /// other parts of the system in order to support acknowledgements and retransmission.
 pub(super) struct AcknowledgementControllerConnectors {
+    /// Channel used for forwarding prepared sphinx messages into the poisson sender
+    /// to be sent to the mix network.
+    real_message_sender: BatchRealMessageSender,
+
     /// Channel used for receiving raw messages from a client. The messages need to be put
     /// into sphinx packets first.
     input_receiver: InputMessageReceiver,
@@ -128,28 +88,20 @@ pub(super) struct AcknowledgementControllerConnectors {
 
     /// Channel used for receiving acknowledgements from the mix network.
     ack_receiver: AcknowledgementReceiver,
-
-    /// Channel used for sending request to `ActionController` to deal with anything ack-related,
-    ack_action_sender: AckActionSender,
-
-    /// Channel used for receiving request by `ActionController` to deal with anything ack-related,
-    ack_action_receiver: AckActionReceiver,
 }
 
 impl AcknowledgementControllerConnectors {
     pub(super) fn new(
+        real_message_sender: BatchRealMessageSender,
         input_receiver: InputMessageReceiver,
         sent_notifier: SentPacketNotificationReceiver,
         ack_receiver: AcknowledgementReceiver,
-        ack_action_sender: AckActionSender,
-        ack_action_receiver: AckActionReceiver,
     ) -> Self {
         AcknowledgementControllerConnectors {
+            real_message_sender,
             input_receiver,
             sent_notifier,
             ack_receiver,
-            ack_action_sender,
-            ack_action_receiver,
         }
     }
 }
@@ -162,135 +114,163 @@ pub(super) struct Config {
     /// Given ack timeout in the form a * BASE_DELAY + b, it specifies the multiplier `a`
     ack_wait_multiplier: f64,
 
-    /// Predefined packet size used for the encapsulated messages.
-    packet_size: PacketSize,
+    /// Average delay an acknowledgement packet is going to get delayed at a single mixnode.
+    average_ack_delay: Duration,
+
+    /// Average delay a data packet is going to get delayed at a single mixnode.
+    average_packet_delay: Duration,
 }
 
 impl Config {
-    pub(super) fn new(ack_wait_addition: Duration, ack_wait_multiplier: f64) -> Self {
+    pub(super) fn new(
+        ack_wait_addition: Duration,
+        ack_wait_multiplier: f64,
+        average_ack_delay: Duration,
+        average_packet_delay: Duration,
+    ) -> Self {
         Config {
             ack_wait_addition,
             ack_wait_multiplier,
-            packet_size: Default::default(),
+            average_ack_delay,
+            average_packet_delay,
         }
     }
-
-    pub fn with_custom_packet_size(mut self, packet_size: PacketSize) -> Self {
-        self.packet_size = packet_size;
-        self
-    }
 }
 
 pub(super) struct AcknowledgementController<R>
 where
     R: CryptoRng + Rng,
 {
-    acknowledgement_listener: AcknowledgementListener,
-    input_message_listener: InputMessageListener<R>,
-    retransmission_request_listener: RetransmissionRequestListener<R>,
-    sent_notification_listener: SentNotificationListener,
-    action_controller: ActionController,
+    acknowledgement_listener: Option<AcknowledgementListener>,
+    input_message_listener: Option<InputMessageListener<R>>,
+    retransmission_request_listener: Option<RetransmissionRequestListener<R>>,
+    sent_notification_listener: Option<SentNotificationListener>,
+    action_controller: Option<ActionController>,
 }
 
 impl<R> AcknowledgementController<R>
 where
-    R: 'static + CryptoRng + Rng + Clone + Send + Sync,
+    R: 'static + CryptoRng + Rng + Clone + Send,
 {
     pub(super) fn new(
         config: Config,
+        rng: R,
+        topology_access: TopologyAccessor,
         ack_key: Arc<AckKey>,
+        ack_recipient: Recipient,
+        reply_key_storage: ReplyKeyStorage,
         connectors: AcknowledgementControllerConnectors,
-        message_handler: MessageHandler<R>,
-        reply_controller_sender: ReplyControllerSender,
     ) -> Self {
         let (retransmission_tx, retransmission_rx) = mpsc::unbounded();
 
         let action_config =
             action_controller::Config::new(config.ack_wait_addition, config.ack_wait_multiplier);
-        let action_controller = ActionController::new(
-            action_config,
-            retransmission_tx,
-            connectors.ack_action_receiver,
+        let (action_controller, action_sender) =
+            ActionController::new(action_config, retransmission_tx);
+
+        let message_preparer = MessagePreparer::new(
+            rng,
+            ack_recipient,
+            config.average_packet_delay,
+            config.average_ack_delay,
         );
 
         // will listen for any acks coming from the network
         let acknowledgement_listener = AcknowledgementListener::new(
             Arc::clone(&ack_key),
             connectors.ack_receiver,
-            connectors.ack_action_sender.clone(),
+            action_sender.clone(),
         );
 
         // will listen for any new messages from the client
         let input_message_listener = InputMessageListener::new(
+            Arc::clone(&ack_key),
+            ack_recipient,
             connectors.input_receiver,
-            message_handler.clone(),
-            reply_controller_sender.clone(),
+            message_preparer.clone(),
+            action_sender.clone(),
+            connectors.real_message_sender.clone(),
+            topology_access.clone(),
+            reply_key_storage,
         );
 
         // will listen for any ack timeouts and trigger retransmission
         let retransmission_request_listener = RetransmissionRequestListener::new(
-            connectors.ack_action_sender.clone(),
-            message_handler,
+            Arc::clone(&ack_key),
+            ack_recipient,
+            message_preparer,
+            action_sender.clone(),
+            connectors.real_message_sender,
             retransmission_rx,
-            reply_controller_sender,
+            topology_access,
         );
 
         // will listen for events indicating the packet was sent through the network so that
         // the retransmission timer should be started.
         let sent_notification_listener =
-            SentNotificationListener::new(connectors.sent_notifier, connectors.ack_action_sender);
+            SentNotificationListener::new(connectors.sent_notifier, action_sender);
 
         AcknowledgementController {
-            acknowledgement_listener,
-            input_message_listener,
-            retransmission_request_listener,
-            sent_notification_listener,
-            action_controller,
+            acknowledgement_listener: Some(acknowledgement_listener),
+            input_message_listener: Some(input_message_listener),
+            retransmission_request_listener: Some(retransmission_request_listener),
+            sent_notification_listener: Some(sent_notification_listener),
+            action_controller: Some(action_controller),
         }
     }
 
-    pub(super) fn start_with_shutdown(self, shutdown: nym_task::TaskClient) {
-        let mut acknowledgement_listener = self.acknowledgement_listener;
-        let mut input_message_listener = self.input_message_listener;
-        let mut retransmission_request_listener = self.retransmission_request_listener;
-        let mut sent_notification_listener = self.sent_notification_listener;
-        let mut action_controller = self.action_controller;
+    pub(super) async fn run(&mut self) {
+        let mut acknowledgement_listener = self.acknowledgement_listener.take().unwrap();
+        let mut input_message_listener = self.input_message_listener.take().unwrap();
+        let mut retransmission_request_listener =
+            self.retransmission_request_listener.take().unwrap();
+        let mut sent_notification_listener = self.sent_notification_listener.take().unwrap();
+        let mut action_controller = self.action_controller.take().unwrap();
 
-        let shutdown_handle = shutdown.clone();
-        spawn_future(async move {
+        // the below are log messages are errors as at the current stage we do not expect any of
+        // the task to ever finish. This will of course change once we introduce
+        // graceful shutdowns.
+        let ack_listener_fut = tokio::spawn(async move {
+            acknowledgement_listener.run().await;
+            error!("The acknowledgement listener has finished execution!");
             acknowledgement_listener
-                .run_with_shutdown(shutdown_handle)
-                .await;
-            debug!("The acknowledgement listener has finished execution!");
         });
-
-        let shutdown_handle = shutdown.clone();
-        spawn_future(async move {
+        let input_listener_fut = tokio::spawn(async move {
+            input_message_listener.run().await;
+            error!("The input listener has finished execution!");
             input_message_listener
-                .run_with_shutdown(shutdown_handle)
-                .await;
-            debug!("The input listener has finished execution!");
         });
-
-        let shutdown_handle = shutdown.clone();
-        spawn_future(async move {
+        let retransmission_req_fut = tokio::spawn(async move {
+            retransmission_request_listener.run().await;
+            error!("The retransmission request listener has finished execution!");
             retransmission_request_listener
-                .run_with_shutdown(shutdown_handle)
-                .await;
-            debug!("The retransmission request listener has finished execution!");
         });
-
-        let shutdown_handle = shutdown.clone();
-        spawn_future(async move {
+        let sent_notification_fut = tokio::spawn(async move {
+            sent_notification_listener.run().await;
+            error!("The sent notification listener has finished execution!");
             sent_notification_listener
-                .run_with_shutdown(shutdown_handle)
-                .await;
-            debug!("The sent notification listener has finished execution!");
+        });
+        let action_controller_fut = tokio::spawn(async move {
+            action_controller.run().await;
+            error!("The controller has finished execution!");
+            action_controller
         });
 
-        spawn_future(async move {
-            action_controller.run_with_shutdown(shutdown).await;
-            debug!("The controller has finished execution!");
-        });
+        // technically we don't have to bring `AcknowledgementController` back to a valid state
+        // but we can do it, so why not? Perhaps it might be useful if we wanted to allow
+        // for restarts of certain modules without killing the entire process.
+        self.acknowledgement_listener = Some(ack_listener_fut.await.unwrap());
+        self.input_message_listener = Some(input_listener_fut.await.unwrap());
+        self.retransmission_request_listener = Some(retransmission_req_fut.await.unwrap());
+        self.sent_notification_listener = Some(sent_notification_fut.await.unwrap());
+        self.action_controller = Some(action_controller_fut.await.unwrap());
+    }
+
+    #[allow(dead_code)]
+    pub(super) fn start(mut self) -> JoinHandle<Self> {
+        tokio::spawn(async move {
+            self.run().await;
+            self
+        })
     }
 }

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

@@ -0,0 +1,129 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use super::action_controller::{Action, ActionSender};
+use super::PendingAcknowledgement;
+use super::RetransmissionRequestReceiver;
+use crate::client::{
+    real_messages_control::real_traffic_stream::{BatchRealMessageSender, RealMessage},
+    topology_control::TopologyAccessor,
+};
+use futures::StreamExt;
+use log::*;
+use nymsphinx::preparer::MessagePreparer;
+use nymsphinx::{acknowledgements::AckKey, addressing::clients::Recipient};
+use rand::{CryptoRng, Rng};
+use std::sync::{Arc, Weak};
+
+// responsible for packet retransmission upon fired timer
+pub(super) struct RetransmissionRequestListener<R>
+where
+    R: CryptoRng + Rng,
+{
+    ack_key: Arc<AckKey>,
+    ack_recipient: Recipient,
+    message_preparer: MessagePreparer<R>,
+    action_sender: ActionSender,
+    real_message_sender: BatchRealMessageSender,
+    request_receiver: RetransmissionRequestReceiver,
+    topology_access: TopologyAccessor,
+}
+
+impl<R> RetransmissionRequestListener<R>
+where
+    R: CryptoRng + Rng,
+{
+    pub(super) fn new(
+        ack_key: Arc<AckKey>,
+        ack_recipient: Recipient,
+        message_preparer: MessagePreparer<R>,
+        action_sender: ActionSender,
+        real_message_sender: BatchRealMessageSender,
+        request_receiver: RetransmissionRequestReceiver,
+        topology_access: TopologyAccessor,
+    ) -> Self {
+        RetransmissionRequestListener {
+            ack_key,
+            ack_recipient,
+            message_preparer,
+            action_sender,
+            real_message_sender,
+            request_receiver,
+            topology_access,
+        }
+    }
+
+    async fn on_retransmission_request(&mut self, timed_out_ack: Weak<PendingAcknowledgement>) {
+        let timed_out_ack = match timed_out_ack.upgrade() {
+            Some(timed_out_ack) => timed_out_ack,
+            None => {
+                debug!("We received an ack JUST as we were about to retransmit [1]");
+                return;
+            }
+        };
+        let packet_recipient = &timed_out_ack.recipient;
+        let chunk_clone = timed_out_ack.message_chunk.clone();
+        let frag_id = chunk_clone.fragment_identifier();
+
+        let topology_permit = self.topology_access.get_read_permit().await;
+        let topology_ref = match topology_permit
+            .try_get_valid_topology_ref(&self.ack_recipient, Some(packet_recipient))
+        {
+            Some(topology_ref) => topology_ref,
+            None => {
+                warn!("Could not retransmit the packet - the network topology is invalid");
+                // we NEED to start timer here otherwise we will have this guy permanently stuck in memory
+                self.action_sender
+                    .unbounded_send(Action::new_start_timer(frag_id))
+                    .unwrap();
+                return;
+            }
+        };
+
+        let prepared_fragment = self
+            .message_preparer
+            .prepare_chunk_for_sending(chunk_clone, topology_ref, &self.ack_key, packet_recipient)
+            .unwrap();
+
+        // if we have the ONLY strong reference to the ack data, it means it was removed from the
+        // pending acks
+        if Arc::strong_count(&timed_out_ack) == 1 {
+            // while we were messing with topology, wrapping data in sphinx, etc. we actually received
+            // this ack after all! no need to retransmit then
+            debug!("We received an ack JUST as we were about to retransmit [2]");
+            return;
+        }
+        // we no longer need the reference - let's drop it so that if somehow `UpdateTimer` action
+        // reached the controller before this function terminated, the controller would not panic.
+        drop(timed_out_ack);
+
+        let new_delay = prepared_fragment.total_delay;
+
+        // We know this update will be reflected by the `StartTimer` Action performed when this
+        // message is sent through the mix network.
+        // Reason being: UpdateTimer is now pushed onto the Action queue and `StartTimer` will
+        // only be pushed when the below `RealMessage` (which we are about to create)
+        // is sent to the `OutQueueControl` and has gone through its internal queue
+        // with the additional poisson delay.
+        // And since Actions are executed in order `UpdateTimer` will HAVE TO be executed before `StartTimer`
+        self.action_sender
+            .unbounded_send(Action::new_update_delay(frag_id, new_delay))
+            .unwrap();
+
+        // send to `OutQueueControl` to eventually send to the mix network
+        self.real_message_sender
+            .unbounded_send(vec![RealMessage::new(
+                prepared_fragment.mix_packet,
+                frag_id,
+            )])
+            .unwrap();
+    }
+
+    pub(super) async fn run(&mut self) {
+        debug!("Started RetransmissionRequestListener");
+        while let Some(timed_out_ack) = self.request_receiver.next().await {
+            self.on_retransmission_request(timed_out_ack).await;
+        }
+        error!("TODO: error msg. Or maybe panic?")
+    }
+}

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

@@ -1,11 +1,11 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use super::action_controller::{AckActionSender, Action};
+use super::action_controller::{Action, ActionSender};
 use super::SentPacketNotificationReceiver;
 use futures::StreamExt;
 use log::*;
-use nym_sphinx::chunking::fragment::{FragmentIdentifier, COVER_FRAG_ID};
+use nymsphinx::chunking::fragment::{FragmentIdentifier, COVER_FRAG_ID};
 
 /// Module responsible for starting up retransmission timers.
 /// It is required because when we send our packet to the `real traffic stream` controlled
@@ -13,13 +13,13 @@ use nym_sphinx::chunking::fragment::{FragmentIdentifier, COVER_FRAG_ID};
 /// accidentally fire retransmission way quicker than we should have.
 pub(super) struct SentNotificationListener {
     sent_notifier: SentPacketNotificationReceiver,
-    action_sender: AckActionSender,
+    action_sender: ActionSender,
 }
 
 impl SentNotificationListener {
     pub(super) fn new(
         sent_notifier: SentPacketNotificationReceiver,
-        action_sender: AckActionSender,
+        action_sender: ActionSender,
     ) -> Self {
         SentNotificationListener {
             sent_notifier,
@@ -31,32 +31,22 @@ impl SentNotificationListener {
         if frag_id == COVER_FRAG_ID {
             trace!("sent off a cover message - no need to start retransmission timer!");
             return;
+        } else if frag_id.is_reply() {
+            debug!("sent off a reply message - no need to start retransmission timer!");
+            // TODO: probably there will need to be some extra procedure here, like it would
+            // be nice to know that our reply actually reached the recipient (i.e. we got the ack)
+            return;
         }
         self.action_sender
             .unbounded_send(Action::new_start_timer(frag_id))
             .unwrap();
     }
 
-    pub(super) async fn run_with_shutdown(&mut self, mut shutdown: nym_task::TaskClient) {
-        debug!("Started SentNotificationListener with graceful shutdown support");
-
-        while !shutdown.is_shutdown() {
-            tokio::select! {
-                frag_id = self.sent_notifier.next() => match frag_id {
-                    Some(frag_id) => {
-                        self.on_sent_message(frag_id).await;
-                    }
-                    None => {
-                        log::trace!("SentNotificationListener: Stopping since channel closed");
-                        break;
-                    }
-                },
-                _ = shutdown.recv_with_delay() => {
-                    log::trace!("SentNotificationListener: Received shutdown");
-                }
-            }
+    pub(super) async fn run(&mut self) {
+        debug!("Started SentNotificationListener");
+        while let Some(frag_id) = self.sent_notifier.next().await {
+            self.on_sent_message(frag_id).await;
         }
-        assert!(shutdown.is_shutdown_poll());
-        log::debug!("SentNotificationListener: Exiting");
+        error!("TODO: error msg. Or maybe panic?")
     }
 }

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

@@ -0,0 +1,178 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+// INPUT: InputMessage from user
+// INPUT2: Acks from mix
+// OUTPUT: MixMessage to mix traffic
+
+use self::{
+    acknowledgement_control::AcknowledgementController, real_traffic_stream::OutQueueControl,
+};
+use crate::client::real_messages_control::acknowledgement_control::AcknowledgementControllerConnectors;
+use crate::client::reply_key_storage::ReplyKeyStorage;
+use crate::client::{
+    inbound_messages::InputMessageReceiver, mix_traffic::BatchMixMessageSender,
+    topology_control::TopologyAccessor,
+};
+use futures::channel::mpsc;
+use gateway_client::AcknowledgementReceiver;
+use log::*;
+use nymsphinx::acknowledgements::AckKey;
+use nymsphinx::addressing::clients::Recipient;
+use rand::{rngs::OsRng, CryptoRng, Rng};
+use std::sync::Arc;
+use std::time::Duration;
+use tokio::task::JoinHandle;
+
+mod acknowledgement_control;
+mod real_traffic_stream;
+
+// TODO: ack_key and self_recipient shouldn't really be part of this config
+pub struct Config {
+    /// Key used to decrypt contents of received SURBAcks
+    ack_key: Arc<AckKey>,
+
+    /// Given ack timeout in the form a * BASE_DELAY + b, it specifies the additive part `b`
+    ack_wait_addition: Duration,
+
+    /// Given ack timeout in the form a * BASE_DELAY + b, it specifies the multiplier `a`
+    ack_wait_multiplier: f64,
+
+    /// Address of `this` client.
+    self_recipient: Recipient,
+
+    /// Average delay between sending subsequent packets from this client.
+    average_message_sending_delay: Duration,
+
+    /// Average delay a data packet is going to get delayed at a single mixnode.
+    average_packet_delay_duration: Duration,
+
+    /// Average delay an acknowledgement packet is going to get delayed at a single mixnode.
+    average_ack_delay_duration: Duration,
+}
+
+impl Config {
+    pub fn new(
+        ack_key: Arc<AckKey>,
+        ack_wait_multiplier: f64,
+        ack_wait_addition: Duration,
+        average_ack_delay_duration: Duration,
+        average_message_sending_delay: Duration,
+        average_packet_delay_duration: Duration,
+        self_recipient: Recipient,
+    ) -> Self {
+        Config {
+            ack_key,
+            ack_wait_addition,
+            ack_wait_multiplier,
+            self_recipient,
+            average_message_sending_delay,
+            average_packet_delay_duration,
+            average_ack_delay_duration,
+        }
+    }
+}
+
+pub struct RealMessagesController<R>
+where
+    R: CryptoRng + Rng,
+{
+    out_queue_control: Option<OutQueueControl<R>>,
+    ack_control: Option<AcknowledgementController<R>>,
+}
+
+// obviously when we finally make shared rng that is on 'higher' level, this should become
+// generic `R`
+impl RealMessagesController<OsRng> {
+    pub fn new(
+        config: Config,
+        ack_receiver: AcknowledgementReceiver,
+        input_receiver: InputMessageReceiver,
+        mix_sender: BatchMixMessageSender,
+        topology_access: TopologyAccessor,
+        reply_key_storage: ReplyKeyStorage,
+    ) -> Self {
+        let rng = OsRng;
+
+        let (real_message_sender, real_message_receiver) = mpsc::unbounded();
+        let (sent_notifier_tx, sent_notifier_rx) = mpsc::unbounded();
+
+        let ack_controller_connectors = AcknowledgementControllerConnectors::new(
+            real_message_sender,
+            input_receiver,
+            sent_notifier_rx,
+            ack_receiver,
+        );
+
+        let ack_control_config = acknowledgement_control::Config::new(
+            config.ack_wait_addition,
+            config.ack_wait_multiplier,
+            config.average_ack_delay_duration,
+            config.average_packet_delay_duration,
+        );
+
+        let ack_control = AcknowledgementController::new(
+            ack_control_config,
+            rng,
+            topology_access.clone(),
+            Arc::clone(&config.ack_key),
+            config.self_recipient,
+            reply_key_storage,
+            ack_controller_connectors,
+        );
+
+        let out_queue_config = real_traffic_stream::Config::new(
+            config.average_ack_delay_duration,
+            config.average_packet_delay_duration,
+            config.average_message_sending_delay,
+        );
+
+        let out_queue_control = OutQueueControl::new(
+            out_queue_config,
+            Arc::clone(&config.ack_key),
+            sent_notifier_tx,
+            mix_sender,
+            real_message_receiver,
+            rng,
+            config.self_recipient,
+            topology_access,
+        );
+
+        RealMessagesController {
+            out_queue_control: Some(out_queue_control),
+            ack_control: Some(ack_control),
+        }
+    }
+
+    pub(super) async fn run(&mut self) {
+        let mut out_queue_control = self.out_queue_control.take().unwrap();
+        let mut ack_control = self.ack_control.take().unwrap();
+
+        // the below are log messages are errors as at the current stage we do not expect any of
+        // the task to ever finish. This will of course change once we introduce
+        // graceful shutdowns.
+        let out_queue_control_fut = tokio::spawn(async move {
+            out_queue_control.run_out_queue_control().await;
+            error!("The out queue controller has finished execution!");
+            out_queue_control
+        });
+        let ack_control_fut = tokio::spawn(async move {
+            ack_control.run().await;
+            error!("The acknowledgement controller has finished execution!");
+            ack_control
+        });
+
+        // technically we don't have to bring `RealMessagesController` back to a valid state
+        // but we can do it, so why not? Perhaps it might be useful if we wanted to allow
+        // for restarts of certain modules without killing the entire process.
+        self.out_queue_control = Some(out_queue_control_fut.await.unwrap());
+        self.ack_control = Some(ack_control_fut.await.unwrap());
+    }
+
+    pub fn start(mut self) -> JoinHandle<Self> {
+        tokio::spawn(async move {
+            self.run().await;
+            self
+        })
+    }
+}

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

@@ -0,0 +1,269 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use crate::client::mix_traffic::BatchMixMessageSender;
+use crate::client::real_messages_control::acknowledgement_control::SentPacketNotificationSender;
+use crate::client::topology_control::TopologyAccessor;
+use futures::channel::mpsc;
+use futures::task::{Context, Poll};
+use futures::{Future, Stream, StreamExt};
+use log::*;
+use nymsphinx::acknowledgements::AckKey;
+use nymsphinx::addressing::clients::Recipient;
+use nymsphinx::chunking::fragment::FragmentIdentifier;
+use nymsphinx::cover::generate_loop_cover_packet;
+use nymsphinx::forwarding::packet::MixPacket;
+use nymsphinx::utils::sample_poisson_duration;
+use rand::{CryptoRng, Rng};
+use std::collections::VecDeque;
+use std::pin::Pin;
+use std::sync::Arc;
+use std::time::Duration;
+use tokio::time;
+
+/// Configurable parameters of the `OutQueueControl`
+pub(crate) struct Config {
+    /// Average delay an acknowledgement packet is going to get delay at a single mixnode.
+    average_ack_delay: Duration,
+
+    /// Average delay a data packet is going to get delay at a single mixnode.
+    average_packet_delay: Duration,
+
+    /// Average delay between sending subsequent packets.
+    average_message_sending_delay: Duration,
+}
+
+impl Config {
+    pub(crate) fn new(
+        average_ack_delay: Duration,
+        average_packet_delay: Duration,
+        average_message_sending_delay: Duration,
+    ) -> Self {
+        Config {
+            average_ack_delay,
+            average_packet_delay,
+            average_message_sending_delay,
+        }
+    }
+}
+
+pub(crate) struct OutQueueControl<R>
+where
+    R: CryptoRng + Rng,
+{
+    /// Configurable parameters of the `ActionController`
+    config: Config,
+
+    /// Key used to encrypt and decrypt content of an ACK packet.
+    ack_key: Arc<AckKey>,
+
+    /// Channel used for notifying of a real packet being sent out. Used to start up retransmission timer.
+    sent_notifier: SentPacketNotificationSender,
+
+    /// Internal state, determined by `average_message_sending_delay`,
+    /// used to keep track of when a next packet should be sent out.
+    next_delay: Pin<Box<time::Sleep>>,
+
+    /// Channel used for sending prepared sphinx packets to `MixTrafficController` that sends them
+    /// out to the network without any further delays.
+    mix_tx: BatchMixMessageSender,
+
+    /// Channel used for receiving real, prepared, messages that must be first sufficiently delayed
+    /// before being sent out into the network.
+    real_receiver: BatchRealMessageReceiver,
+
+    /// Represents full address of this client.
+    our_full_destination: Recipient,
+
+    /// Instance of a cryptographically secure random number generator.
+    rng: R,
+
+    /// Accessor to the common instance of network topology.
+    topology_access: TopologyAccessor,
+
+    /// Buffer containing all real messages received. It is first exhausted before more are pulled.
+    received_buffer: VecDeque<RealMessage>,
+}
+
+pub(crate) struct RealMessage {
+    mix_packet: MixPacket,
+    fragment_id: FragmentIdentifier,
+}
+
+impl RealMessage {
+    pub(crate) fn new(mix_packet: MixPacket, fragment_id: FragmentIdentifier) -> Self {
+        RealMessage {
+            mix_packet,
+            fragment_id,
+        }
+    }
+}
+
+// messages are already prepared, etc. the real point of it is to forward it to mix_traffic
+// after sufficient delay
+pub(crate) type BatchRealMessageSender = mpsc::UnboundedSender<Vec<RealMessage>>;
+type BatchRealMessageReceiver = mpsc::UnboundedReceiver<Vec<RealMessage>>;
+
+pub(crate) enum StreamMessage {
+    Cover,
+    Real(Box<RealMessage>),
+}
+
+impl<R> Stream for OutQueueControl<R>
+where
+    R: CryptoRng + Rng + Unpin,
+{
+    type Item = StreamMessage;
+
+    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+        // it is not yet time to return a message
+        if self.next_delay.as_mut().poll(cx).is_pending() {
+            return Poll::Pending;
+        };
+
+        // we know it's time to send a message, so let's prepare delay for the next one
+        // Get the `now` by looking at the current `delay` deadline
+        let avg_delay = self.config.average_message_sending_delay;
+        let now = self.next_delay.deadline();
+        let next_poisson_delay = sample_poisson_duration(&mut self.rng, avg_delay);
+
+        // The next interval value is `next_poisson_delay` after the one that just
+        // yielded.
+        let next = now + next_poisson_delay;
+        self.next_delay.as_mut().reset(next);
+
+        // check if we have anything immediately available
+        if let Some(real_available) = self.received_buffer.pop_front() {
+            return Poll::Ready(Some(StreamMessage::Real(Box::new(real_available))));
+        }
+
+        // decide what kind of message to send
+        match Pin::new(&mut self.real_receiver).poll_next(cx) {
+            // in the case our real message channel stream was closed, we should also indicate we are closed
+            // (and whoever is using the stream should panic)
+            Poll::Ready(None) => Poll::Ready(None),
+
+            // if there are more messages available, return first one and store the rest
+            Poll::Ready(Some(real_messages)) => {
+                self.received_buffer = real_messages.into();
+                // we MUST HAVE received at least ONE message
+                Poll::Ready(Some(StreamMessage::Real(Box::new(
+                    self.received_buffer.pop_front().unwrap(),
+                ))))
+            }
+
+            // otherwise construct a dummy one
+            Poll::Pending => Poll::Ready(Some(StreamMessage::Cover)),
+        }
+    }
+}
+
+impl<R> OutQueueControl<R>
+where
+    R: CryptoRng + Rng + Unpin,
+{
+    // at this point I'm not entirely sure how to deal with this warning without
+    // some considerable refactoring
+    #[allow(clippy::too_many_arguments)]
+    pub(crate) fn new(
+        config: Config,
+        ack_key: Arc<AckKey>,
+        sent_notifier: SentPacketNotificationSender,
+        mix_tx: BatchMixMessageSender,
+        real_receiver: BatchRealMessageReceiver,
+        rng: R,
+        our_full_destination: Recipient,
+        topology_access: TopologyAccessor,
+    ) -> Self {
+        OutQueueControl {
+            config,
+            ack_key,
+            sent_notifier,
+            next_delay: Box::pin(time::sleep(Default::default())),
+            mix_tx,
+            real_receiver,
+            our_full_destination,
+            rng,
+            topology_access,
+            received_buffer: VecDeque::with_capacity(0), // we won't be putting any data into this guy directly
+        }
+    }
+
+    fn sent_notify(&self, frag_id: FragmentIdentifier) {
+        // well technically the message was not sent just yet, but now it's up to internal
+        // queues and client load rather than the required delay. So realistically we can treat
+        // whatever is about to happen as negligible additional delay.
+        trace!("{} is about to get sent to the mixnet", frag_id);
+        self.sent_notifier.unbounded_send(frag_id).unwrap();
+    }
+
+    async fn on_message(&mut self, next_message: StreamMessage) {
+        trace!("created new message");
+
+        let next_message = match next_message {
+            StreamMessage::Cover => {
+                // TODO for way down the line: in very rare cases (during topology update) we might have
+                // to wait a really tiny bit before actually obtaining the permit hence messing with our
+                // poisson delay, but is it really a problem?
+                let topology_permit = self.topology_access.get_read_permit().await;
+                // the ack is sent back to ourselves (and then ignored)
+                let topology_ref_option = topology_permit.try_get_valid_topology_ref(
+                    &self.our_full_destination,
+                    Some(&self.our_full_destination),
+                );
+                if topology_ref_option.is_none() {
+                    warn!(
+                        "No valid topology detected - won't send any loop cover message this time"
+                    );
+                    return;
+                }
+                let topology_ref = topology_ref_option.unwrap();
+
+                generate_loop_cover_packet(
+                    &mut self.rng,
+                    topology_ref,
+                    &*self.ack_key,
+                    &self.our_full_destination,
+                    self.config.average_ack_delay,
+                    self.config.average_packet_delay,
+                )
+                .expect("Somehow failed to generate a loop cover message with a valid topology")
+            }
+            StreamMessage::Real(real_message) => {
+                self.sent_notify(real_message.fragment_id);
+                real_message.mix_packet
+            }
+        };
+
+        // if this one fails, there's no retrying because it means that either:
+        // - we run out of memory
+        // - the receiver channel is closed
+        // in either case there's no recovery and we can only panic
+        self.mix_tx.unbounded_send(vec![next_message]).unwrap();
+
+        // JS: Not entirely sure why or how it fixes stuff, but without the yield call,
+        // the UnboundedReceiver [of mix_rx] will not get a chance to read anything
+        // JS2: Basically it was the case that with high enough rate, the stream had already a next value
+        // ready and hence was immediately re-scheduled causing other tasks to be starved;
+        // yield makes it go back the scheduling queue regardless of its value availability
+        tokio::task::yield_now().await;
+    }
+
+    // Send messages at certain rate and if no real traffic is available, send cover message.
+    async fn run_normal_out_queue(&mut self) {
+        // we should set initial delay only when we actually start the stream
+        self.next_delay = Box::pin(time::sleep(sample_poisson_duration(
+            &mut self.rng,
+            self.config.average_message_sending_delay,
+        )));
+
+        while let Some(next_message) = self.next().await {
+            self.on_message(next_message).await;
+        }
+    }
+
+    pub(crate) async fn run_out_queue_control(&mut self) {
+        debug!("Starting out queue controller...");
+        self.run_normal_out_queue().await
+    }
+}

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

@@ -0,0 +1,362 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use crate::client::reply_key_storage::ReplyKeyStorage;
+use crypto::asymmetric::encryption;
+use crypto::symmetric::stream_cipher;
+use crypto::Digest;
+use futures::channel::mpsc;
+use futures::lock::Mutex;
+use futures::StreamExt;
+use gateway_client::MixnetMessageReceiver;
+use log::*;
+use nymsphinx::anonymous_replies::{encryption_key::EncryptionKeyDigest, SurbEncryptionKey};
+use nymsphinx::params::{ReplySurbEncryptionAlgorithm, ReplySurbKeyDigestAlgorithm};
+use nymsphinx::receiver::{MessageReceiver, MessageRecoveryError, ReconstructedMessage};
+use std::collections::HashSet;
+use std::sync::Arc;
+use tokio::task::JoinHandle;
+
+// Buffer Requests to say "hey, send any reconstructed messages to this channel"
+// or to say "hey, I'm going offline, don't send anything more to me. Just buffer them instead"
+pub type ReceivedBufferRequestSender = mpsc::UnboundedSender<ReceivedBufferMessage>;
+pub type ReceivedBufferRequestReceiver = mpsc::UnboundedReceiver<ReceivedBufferMessage>;
+
+// The channel set for the above
+pub type ReconstructedMessagesSender = mpsc::UnboundedSender<Vec<ReconstructedMessage>>;
+pub type ReconstructedMessagesReceiver = mpsc::UnboundedReceiver<Vec<ReconstructedMessage>>;
+
+struct ReceivedMessagesBufferInner {
+    messages: Vec<ReconstructedMessage>,
+    local_encryption_keypair: Arc<encryption::KeyPair>,
+
+    // TODO: looking how it 'looks' here, perhaps `MessageReceiver` should be renamed to something
+    // else instead.
+    message_receiver: MessageReceiver,
+    message_sender: Option<ReconstructedMessagesSender>,
+
+    // TODO: this will get cleared upon re-running the client
+    // but perhaps it should be changed to include timestamps of when the message was reconstructed
+    // and every now and then remove ids older than X
+    recently_reconstructed: HashSet<i32>,
+}
+
+impl ReceivedMessagesBufferInner {
+    fn process_received_fragment(&mut self, raw_fragment: Vec<u8>) -> Option<ReconstructedMessage> {
+        let fragment_data = match self
+            .message_receiver
+            .recover_plaintext(self.local_encryption_keypair.private_key(), raw_fragment)
+        {
+            Err(e) => {
+                warn!("failed to recover fragment data: {:?}. The whole underlying message might be corrupted and unrecoverable!", e);
+                return None;
+            }
+            Ok(frag_data) => frag_data,
+        };
+
+        if nymsphinx::cover::is_cover(&fragment_data) {
+            trace!("The message was a loop cover message! Skipping it");
+            return None;
+        }
+
+        let fragment = match self.message_receiver.recover_fragment(&fragment_data) {
+            Err(e) => {
+                warn!("failed to recover fragment from raw data: {:?}. The whole underlying message might be corrupted and unrecoverable!", e);
+                return None;
+            }
+            Ok(frag) => frag,
+        };
+
+        if self.recently_reconstructed.contains(&fragment.id()) {
+            debug!("Received a chunk of already re-assembled message ({:?})! It probably got here because the ack got lost", fragment.id());
+            return None;
+        }
+
+        // if we returned an error the underlying message is malformed in some way
+        match self.message_receiver.insert_new_fragment(fragment) {
+            Err(err) => match err {
+                MessageRecoveryError::MalformedReconstructedMessage(message_sets) => {
+                    // TODO: should we really insert reconstructed sets? could this be abused for some attack?
+                    for set_id in message_sets {
+                        if !self.recently_reconstructed.insert(set_id) {
+                            // or perhaps we should even panic at this point?
+                            error!("Reconstructed another message containing already used set id!")
+                        }
+                    }
+                    None
+                }
+                _ => unreachable!(
+                    "no other error kind should have been returned here! If so, it's a bug!"
+                ),
+            },
+            Ok(reconstruction_result) => match reconstruction_result {
+                Some((reconstructed_message, used_sets)) => {
+                    for set_id in used_sets {
+                        if !self.recently_reconstructed.insert(set_id) {
+                            // or perhaps we should even panic at this point?
+                            error!("Reconstructed another message containing already used set id!")
+                        }
+                    }
+                    Some(reconstructed_message)
+                }
+                None => None,
+            },
+        }
+    }
+}
+
+#[derive(Debug, Clone)]
+// Note: you should NEVER create more than a single instance of this using 'new()'.
+// You should always use .clone() to create additional instances
+struct ReceivedMessagesBuffer {
+    inner: Arc<Mutex<ReceivedMessagesBufferInner>>,
+
+    /// Storage containing keys to all [`ReplySURB`]s ever sent out that we did not receive back.
+    // There's no need to put it behind a Mutex since it's already properly concurrent
+    reply_key_storage: ReplyKeyStorage,
+}
+
+impl ReceivedMessagesBuffer {
+    fn new(
+        local_encryption_keypair: Arc<encryption::KeyPair>,
+        reply_key_storage: ReplyKeyStorage,
+    ) -> Self {
+        ReceivedMessagesBuffer {
+            inner: Arc::new(Mutex::new(ReceivedMessagesBufferInner {
+                messages: Vec::new(),
+                local_encryption_keypair,
+                message_receiver: MessageReceiver::new(),
+                message_sender: None,
+                recently_reconstructed: HashSet::new(),
+            })),
+            reply_key_storage,
+        }
+    }
+
+    async fn disconnect_sender(&mut self) {
+        let mut guard = self.inner.lock().await;
+        if guard.message_sender.is_none() {
+            // in theory we could just ignore it, but that situation should have never happened
+            // in the first place, so this way we at least know we have an important bug to fix
+            panic!("trying to disconnect non-existent sender!")
+        }
+        guard.message_sender = None;
+    }
+
+    async fn connect_sender(&mut self, sender: ReconstructedMessagesSender) {
+        let mut guard = self.inner.lock().await;
+        if guard.message_sender.is_some() {
+            // in theory we could just ignore it, but that situation should have never happened
+            // in the first place, so this way we at least know we have an important bug to fix
+            panic!("trying overwrite an existing sender!")
+        }
+
+        // while we're at it, also empty the buffer if we happened to receive anything while
+        // no sender was connected
+        let stored_messages = std::mem::take(&mut guard.messages);
+        if !stored_messages.is_empty() {
+            if let Err(err) = sender.unbounded_send(stored_messages) {
+                error!(
+                    "The sender channel we just received is already invalidated - {:?}",
+                    err
+                );
+                // put the values back to the buffer
+                // the returned error has two fields: err: SendError and val: T,
+                // where val is the value that was failed to get sent;
+                // it's returned by the `into_inner` call
+                guard.messages = err.into_inner();
+                return;
+            }
+        }
+        guard.message_sender = Some(sender);
+    }
+
+    async fn add_reconstructed_messages(&mut self, msgs: Vec<ReconstructedMessage>) {
+        debug!("Adding {:?} new messages to the buffer!", msgs.len());
+        trace!("Adding new messages to the buffer! {:?}", msgs);
+        self.inner.lock().await.messages.extend(msgs)
+    }
+
+    fn process_received_reply(
+        reply_ciphertext: &[u8],
+        reply_key: SurbEncryptionKey,
+    ) -> Option<ReconstructedMessage> {
+        let zero_iv = stream_cipher::zero_iv::<ReplySurbEncryptionAlgorithm>();
+
+        let mut reply_msg = stream_cipher::decrypt::<ReplySurbEncryptionAlgorithm>(
+            reply_key.inner(),
+            &zero_iv,
+            reply_ciphertext,
+        );
+        if let Err(err) = MessageReceiver::remove_padding(&mut reply_msg) {
+            warn!("Received reply had malformed padding! - {:?}", err);
+            None
+        } else {
+            // TODO: perhaps having to say it doesn't have a surb an indication the type should be changed?
+            Some(ReconstructedMessage {
+                message: reply_msg,
+                reply_surb: None,
+            })
+        }
+    }
+
+    async fn handle_new_received(&mut self, msgs: Vec<Vec<u8>>) {
+        debug!(
+            "Processing {:?} new message that might get added to the buffer!",
+            msgs.len()
+        );
+
+        let mut completed_messages = Vec::new();
+        let mut inner_guard = self.inner.lock().await;
+
+        let reply_surb_digest_size = ReplySurbKeyDigestAlgorithm::output_size();
+
+        // first check if this is a reply or a chunked message
+        // TODO: verify with @AP if this way of doing it is safe or whether it could
+        // cause some attacks due to, I don't know, stupid edge case collisions?
+        // Update: this DOES introduce a possible leakage: https://github.com/nymtech/nym/issues/296
+        for msg in msgs {
+            let possible_key_digest =
+                EncryptionKeyDigest::clone_from_slice(&msg[..reply_surb_digest_size]);
+
+            // check first `HasherOutputSize` bytes if they correspond to known encryption key
+            // if yes - this is a reply message
+
+            // TODO: this might be a bottleneck - since the keys are stored on disk we, presumably,
+            // are doing a disk operation every single received fragment
+            if let Some(reply_encryption_key) = self
+                .reply_key_storage
+                .get_and_remove_encryption_key(possible_key_digest)
+                .expect("storage operation failed!")
+            {
+                if let Some(completed_message) = Self::process_received_reply(
+                    &msg[reply_surb_digest_size..],
+                    reply_encryption_key,
+                ) {
+                    completed_messages.push(completed_message)
+                }
+            } else {
+                // otherwise - it's a 'normal' message
+                if let Some(completed_message) = inner_guard.process_received_fragment(msg) {
+                    completed_messages.push(completed_message)
+                }
+            }
+        }
+
+        if !completed_messages.is_empty() {
+            if let Some(sender) = &inner_guard.message_sender {
+                trace!("Sending reconstructed messages to announced sender");
+                if let Err(err) = sender.unbounded_send(completed_messages) {
+                    warn!("The reconstructed message receiver went offline without explicit notification (relevant error: - {:?})", err);
+                    // make sure to drop the lock to not deadlock
+                    // (it is required by `add_reconstructed_messages`)
+                    inner_guard.message_sender = None;
+                    drop(inner_guard);
+                    self.add_reconstructed_messages(err.into_inner()).await;
+                }
+            } else {
+                // make sure to drop the lock to not deadlock
+                // (it is required by `add_reconstructed_messages`)
+                drop(inner_guard);
+                trace!("No sender available - buffering reconstructed messages");
+                self.add_reconstructed_messages(completed_messages).await;
+            }
+        }
+    }
+}
+
+pub enum ReceivedBufferMessage {
+    // Signals a websocket connection (or a native implementation) was established and we should stop buffering messages,
+    // and instead send them directly to the received channel
+    ReceiverAnnounce(ReconstructedMessagesSender),
+
+    // Explicit signal that Receiver connection will no longer accept messages
+    ReceiverDisconnect,
+}
+
+struct RequestReceiver {
+    received_buffer: ReceivedMessagesBuffer,
+    query_receiver: ReceivedBufferRequestReceiver,
+}
+
+impl RequestReceiver {
+    fn new(
+        received_buffer: ReceivedMessagesBuffer,
+        query_receiver: ReceivedBufferRequestReceiver,
+    ) -> Self {
+        RequestReceiver {
+            received_buffer,
+            query_receiver,
+        }
+    }
+
+    fn start(mut self) -> JoinHandle<()> {
+        tokio::spawn(async move {
+            while let Some(request) = self.query_receiver.next().await {
+                match request {
+                    ReceivedBufferMessage::ReceiverAnnounce(sender) => {
+                        self.received_buffer.connect_sender(sender).await;
+                    }
+                    ReceivedBufferMessage::ReceiverDisconnect => {
+                        self.received_buffer.disconnect_sender().await
+                    }
+                }
+            }
+        })
+    }
+}
+
+struct FragmentedMessageReceiver {
+    received_buffer: ReceivedMessagesBuffer,
+    mixnet_packet_receiver: MixnetMessageReceiver,
+}
+
+impl FragmentedMessageReceiver {
+    fn new(
+        received_buffer: ReceivedMessagesBuffer,
+        mixnet_packet_receiver: MixnetMessageReceiver,
+    ) -> Self {
+        FragmentedMessageReceiver {
+            received_buffer,
+            mixnet_packet_receiver,
+        }
+    }
+    fn start(mut self) -> JoinHandle<()> {
+        tokio::spawn(async move {
+            while let Some(new_messages) = self.mixnet_packet_receiver.next().await {
+                self.received_buffer.handle_new_received(new_messages).await;
+            }
+        })
+    }
+}
+
+pub struct ReceivedMessagesBufferController {
+    fragmented_message_receiver: FragmentedMessageReceiver,
+    request_receiver: RequestReceiver,
+}
+
+impl ReceivedMessagesBufferController {
+    pub fn new(
+        local_encryption_keypair: Arc<encryption::KeyPair>,
+        query_receiver: ReceivedBufferRequestReceiver,
+        mixnet_packet_receiver: MixnetMessageReceiver,
+        reply_key_storage: ReplyKeyStorage,
+    ) -> Self {
+        let received_buffer =
+            ReceivedMessagesBuffer::new(local_encryption_keypair, reply_key_storage);
+
+        ReceivedMessagesBufferController {
+            fragmented_message_receiver: FragmentedMessageReceiver::new(
+                received_buffer.clone(),
+                mixnet_packet_receiver,
+            ),
+            request_receiver: RequestReceiver::new(received_buffer, query_receiver),
+        }
+    }
+
+    pub fn start(self) {
+        // TODO: should we do anything with JoinHandle(s) returned by start methods?
+        self.fragmented_message_receiver.start();
+        self.request_receiver.start();
+    }
+}

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

@@ -0,0 +1,94 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use crypto::generic_array::typenum::Unsigned;
+use log::*;
+use nymsphinx::anonymous_replies::{
+    encryption_key::EncryptionKeyDigest, SurbEncryptionKey, SurbEncryptionKeySize,
+};
+use std::path::Path;
+
+#[derive(Debug)]
+pub enum ReplyKeyStorageError {
+    DbReadError(sled::Error),
+    DbWriteError(sled::Error),
+    DbOpenError(sled::Error),
+}
+
+/// Permanent storage for keys in all sent [`ReplySURB`]
+///
+/// Each sent out [`ReplySURB`] has a new key associated with it that is going to be used for
+/// payload encryption. In order to -decrypt whatever reply we receive, we need to know which
+/// key to use for that purpose. We do it based on received `H(t)` which has to be included
+/// with each reply.
+/// Moreover, there is no restriction when the [`ReplySURB`] might get used so we need to
+/// have a permanent storage for all the keys that we might ever see in the future.
+#[derive(Debug, Clone)]
+pub struct ReplyKeyStorage {
+    db: sled::Db,
+}
+
+impl ReplyKeyStorage {
+    pub fn load<P: AsRef<Path>>(path: P) -> Result<Self, ReplyKeyStorageError> {
+        let db = match sled::open(path) {
+            Err(e) => return Err(ReplyKeyStorageError::DbOpenError(e)),
+            Ok(db) => db,
+        };
+
+        Ok(ReplyKeyStorage { db })
+    }
+
+    fn read_encryption_key(&self, raw_key: sled::IVec) -> SurbEncryptionKey {
+        let key_bytes_ref = raw_key.as_ref();
+        // if this fails it means we have some database corruption and we
+        // absolutely can't continue
+
+        if key_bytes_ref.len() != SurbEncryptionKeySize::USIZE {
+            error!("REPLY KEY STORAGE DATA CORRUPTION - ENCRYPTION KEY HAS INVALID LENGTH");
+            panic!("REPLY KEY STORAGE DATA CORRUPTION - ENCRYPTION KEY HAS INVALID LENGTH");
+        }
+
+        // this can only fail if the bytes have invalid length but we already asserted it
+        SurbEncryptionKey::try_from_bytes(key_bytes_ref).unwrap()
+    }
+
+    // TOOD: perhaps we could also store some part of original message here too?
+    pub fn insert_encryption_key(
+        &mut self,
+        encryption_key: SurbEncryptionKey,
+    ) -> Result<(), ReplyKeyStorageError> {
+        let digest = encryption_key.compute_digest();
+
+        let insertion_result = match self.db.insert(digest, encryption_key.to_bytes()) {
+            Err(e) => Err(ReplyKeyStorageError::DbWriteError(e)),
+            Ok(existing_key) => {
+                if existing_key.is_some() {
+                    panic!("HASH COLLISION DETECTED")
+                };
+                Ok(())
+            }
+        };
+
+        // TODO: perhaps we could implement some batching mechanism to avoid frequent flushes?
+        self.db.flush().unwrap();
+        insertion_result
+    }
+
+    // Once we use key once, we do not expect to use it again
+    pub fn get_and_remove_encryption_key(
+        &self,
+        key_digest: EncryptionKeyDigest,
+    ) -> Result<Option<SurbEncryptionKey>, ReplyKeyStorageError> {
+        let removal_result = match self.db.remove(key_digest) {
+            Err(e) => Err(ReplyKeyStorageError::DbReadError(e)),
+            Ok(existing_key) => {
+                Ok(existing_key.map(|existing_key| self.read_encryption_key(existing_key)))
+            }
+        };
+
+        // TODO: not sure how to feel about flushing it every single time here...
+        // same with insertion
+        self.db.flush().unwrap();
+        removal_result
+    }
+}

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

@@ -0,0 +1,314 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use log::*;
+use nymsphinx::addressing::clients::Recipient;
+use nymsphinx::params::DEFAULT_NUM_MIX_HOPS;
+use rand::seq::SliceRandom;
+use rand::thread_rng;
+use std::ops::Deref;
+use std::sync::Arc;
+use std::time;
+use std::time::Duration;
+use tokio::sync::{RwLock, RwLockReadGuard};
+use tokio::task::JoinHandle;
+use topology::{nym_topology_from_bonds, NymTopology};
+use url::Url;
+
+// I'm extremely curious why compiler NEVER complained about lack of Debug here before
+#[derive(Debug)]
+pub struct TopologyAccessorInner(Option<NymTopology>);
+
+impl AsRef<Option<NymTopology>> for TopologyAccessorInner {
+    fn as_ref(&self) -> &Option<NymTopology> {
+        &self.0
+    }
+}
+
+impl TopologyAccessorInner {
+    fn new() -> Self {
+        TopologyAccessorInner(None)
+    }
+
+    fn update(&mut self, new: Option<NymTopology>) {
+        self.0 = new;
+    }
+}
+
+pub struct TopologyReadPermit<'a> {
+    permit: RwLockReadGuard<'a, TopologyAccessorInner>,
+}
+
+impl<'a> Deref for TopologyReadPermit<'a> {
+    type Target = TopologyAccessorInner;
+
+    fn deref(&self) -> &Self::Target {
+        &self.permit
+    }
+}
+
+impl<'a> TopologyReadPermit<'a> {
+    /// Using provided topology read permit, tries to get an immutable reference to the underlying
+    /// topology. For obvious reasons the lifetime of the topology reference is bound to the permit.
+    pub(super) fn try_get_valid_topology_ref(
+        &'a self,
+        ack_recipient: &Recipient,
+        packet_recipient: Option<&Recipient>,
+    ) -> Option<&'a NymTopology> {
+        // Note: implicit deref with Deref for TopologyReadPermit is happening here
+        let topology_ref_option = self.permit.as_ref();
+        match topology_ref_option {
+            None => None,
+            Some(topology_ref) => {
+                // see if it's possible to route the packet to both gateways
+                if !topology_ref.can_construct_path_through(DEFAULT_NUM_MIX_HOPS)
+                    || !topology_ref.gateway_exists(ack_recipient.gateway())
+                    || if let Some(packet_recipient) = packet_recipient {
+                        !topology_ref.gateway_exists(packet_recipient.gateway())
+                    } else {
+                        false
+                    }
+                {
+                    None
+                } else {
+                    Some(topology_ref)
+                }
+            }
+        }
+    }
+}
+
+impl<'a> From<RwLockReadGuard<'a, TopologyAccessorInner>> for TopologyReadPermit<'a> {
+    fn from(read_permit: RwLockReadGuard<'a, TopologyAccessorInner>) -> Self {
+        TopologyReadPermit {
+            permit: read_permit,
+        }
+    }
+}
+
+#[derive(Clone, Debug)]
+pub struct TopologyAccessor {
+    // `RwLock` *seems to* be the better approach for this as write access is only requested every
+    // few seconds, while reads are needed every single packet generated.
+    // However, proper benchmarks will be needed to determine if `RwLock` is indeed a better
+    // approach than a `Mutex`
+    inner: Arc<RwLock<TopologyAccessorInner>>,
+}
+
+impl TopologyAccessor {
+    pub fn new() -> Self {
+        TopologyAccessor {
+            inner: Arc::new(RwLock::new(TopologyAccessorInner::new())),
+        }
+    }
+
+    pub async fn get_read_permit(&self) -> TopologyReadPermit<'_> {
+        self.inner.read().await.into()
+    }
+
+    async fn update_global_topology(&self, new_topology: Option<NymTopology>) {
+        self.inner.write().await.update(new_topology);
+    }
+
+    // only used by the client at startup to get a slightly more reasonable error message
+    // (currently displays as unused because health checker is disabled due to required changes)
+    pub async fn is_routable(&self) -> bool {
+        match &self.inner.read().await.0 {
+            None => false,
+            Some(ref topology) => topology.can_construct_path_through(DEFAULT_NUM_MIX_HOPS),
+        }
+    }
+}
+
+impl Default for TopologyAccessor {
+    fn default() -> Self {
+        TopologyAccessor::new()
+    }
+}
+
+pub struct TopologyRefresherConfig {
+    validator_api_urls: Vec<Url>,
+    refresh_rate: time::Duration,
+    client_version: String,
+}
+
+impl TopologyRefresherConfig {
+    pub fn new(
+        validator_api_urls: Vec<Url>,
+        refresh_rate: time::Duration,
+        client_version: String,
+    ) -> Self {
+        TopologyRefresherConfig {
+            validator_api_urls,
+            refresh_rate,
+            client_version,
+        }
+    }
+}
+
+pub struct TopologyRefresher {
+    validator_client: validator_client::ApiClient,
+    client_version: String,
+
+    validator_api_urls: Vec<Url>,
+    topology_accessor: TopologyAccessor,
+    refresh_rate: Duration,
+
+    currently_used_api: usize,
+    was_latest_valid: bool,
+}
+
+impl TopologyRefresher {
+    pub fn new(mut cfg: TopologyRefresherConfig, topology_accessor: TopologyAccessor) -> Self {
+        cfg.validator_api_urls.shuffle(&mut thread_rng());
+
+        TopologyRefresher {
+            validator_client: validator_client::ApiClient::new(cfg.validator_api_urls[0].clone()),
+            client_version: cfg.client_version,
+            validator_api_urls: cfg.validator_api_urls,
+            topology_accessor,
+            refresh_rate: cfg.refresh_rate,
+            currently_used_api: 0,
+            was_latest_valid: true,
+        }
+    }
+
+    fn use_next_validator_api(&mut self) {
+        if self.validator_api_urls.len() == 1 {
+            warn!("There's only a single validator API available - it won't be possible to use a different one");
+            return;
+        }
+
+        self.currently_used_api = (self.currently_used_api + 1) % self.validator_api_urls.len();
+        self.validator_client
+            .change_validator_api(self.validator_api_urls[self.currently_used_api].clone())
+    }
+
+    /// Verifies whether nodes a reasonably distributed among all mix layers.
+    ///
+    /// In ideal world we would have 33% nodes on layer 1, 33% on layer 2 and 33% on layer 3.
+    /// However, this is a rather unrealistic expectation, instead we check whether there exists
+    /// a layer with more than 66% of nodes or with fewer than 15% and if so, we trigger a failure.
+    ///
+    /// # Arguments
+    ///
+    /// * `topology`: active topology constructed from validator api data
+    /// * `mixnodes_count`: total number of active mixnodes
+    fn check_layer_distribution(
+        &self,
+        active_topology: &NymTopology,
+        mixnodes_count: usize,
+    ) -> bool {
+        let mixes = active_topology.mixes();
+        if active_topology.gateways().is_empty() {
+            return false;
+        }
+
+        // trivial check to see if have at least a single node on each layer (regardless of active set size)
+        if mixes.get(&1).is_none() || mixes.get(&2).is_none() || mixes.get(&3).is_none() {
+            return false;
+        }
+
+        let upper_bound = (mixnodes_count as f32 * 0.66) as usize;
+        let lower_bound = (mixnodes_count as f32 * 0.15) as usize;
+
+        let layer1 = mixes.get(&1).unwrap().len();
+        let layer2 = mixes.get(&2).unwrap().len();
+        let layer3 = mixes.get(&3).unwrap().len();
+
+        if layer1 < lower_bound || layer1 > upper_bound {
+            warn!(
+                "nodes: {}, layer1: {}, layer2: {}, layer3: {}",
+                mixnodes_count, layer1, layer2, layer3
+            );
+            return false;
+        }
+
+        if layer2 < lower_bound || layer2 > upper_bound {
+            warn!(
+                "nodes: {}, layer1: {}, layer2: {}, layer3: {}",
+                mixnodes_count, layer1, layer2, layer3
+            );
+            return false;
+        }
+
+        if layer3 < lower_bound || layer3 > upper_bound {
+            warn!(
+                "nodes: {}, layer1: {}, layer2: {}, layer3: {}",
+                mixnodes_count, layer1, layer2, layer3
+            );
+            return false;
+        }
+
+        true
+    }
+
+    async fn get_current_compatible_topology(&self) -> Option<NymTopology> {
+        // TODO: optimization for the future:
+        // only refresh mixnodes on timer and refresh gateways only when
+        // we have to send to a new, unknown, gateway
+
+        let mixnodes = match self.validator_client.get_cached_active_mixnodes().await {
+            Err(err) => {
+                error!("failed to get network mixnodes - {}", err);
+                return None;
+            }
+            Ok(mixes) => mixes,
+        };
+
+        let gateways = match self.validator_client.get_cached_gateways().await {
+            Err(err) => {
+                error!("failed to get network gateways - {}", err);
+                return None;
+            }
+            Ok(gateways) => gateways,
+        };
+
+        let mixnodes_count = mixnodes.len();
+        let topology =
+            nym_topology_from_bonds(mixnodes, gateways).filter_system_version(&self.client_version);
+
+        if !self.check_layer_distribution(&topology, mixnodes_count) {
+            warn!("The current filtered active topology has extremely skewed layer distribution. It cannot be used.");
+            None
+        } else {
+            Some(topology)
+        }
+    }
+
+    pub async fn refresh(&mut self) {
+        trace!("Refreshing the topology");
+        let new_topology = self.get_current_compatible_topology().await;
+
+        if new_topology.is_none() {
+            self.use_next_validator_api();
+        }
+
+        if new_topology.is_none() && self.was_latest_valid {
+            // if we failed to grab this topology, but the one before it was alright, let's assume
+            // validator had a tiny hiccup and use the old data
+            warn!("we're going to keep on using the old topology for this iteration");
+            self.was_latest_valid = false;
+            return;
+        } else if new_topology.is_some() {
+            self.was_latest_valid = true;
+        }
+
+        self.topology_accessor
+            .update_global_topology(new_topology)
+            .await;
+    }
+
+    pub async fn is_topology_routable(&self) -> bool {
+        self.topology_accessor.is_routable().await
+    }
+
+    pub fn start(mut self) -> JoinHandle<()> {
+        tokio::spawn(async move {
+            loop {
+                tokio::time::sleep(self.refresh_rate).await;
+                self.refresh().await;
+            }
+        })
+    }
+}

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

@@ -0,0 +1,496 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use config::NymConfig;
+use serde::{Deserialize, Serialize};
+use std::marker::PhantomData;
+use std::path::PathBuf;
+use std::time::Duration;
+use url::Url;
+
+pub mod persistence;
+
+pub const MISSING_VALUE: &str = "MISSING VALUE";
+
+// 'DEBUG'
+const DEFAULT_ACK_WAIT_MULTIPLIER: f64 = 1.5;
+
+const DEFAULT_ACK_WAIT_ADDITION: Duration = Duration::from_millis(1_500);
+const DEFAULT_LOOP_COVER_STREAM_AVERAGE_DELAY: Duration = Duration::from_millis(200);
+const DEFAULT_MESSAGE_STREAM_AVERAGE_DELAY: Duration = Duration::from_millis(20);
+const DEFAULT_AVERAGE_PACKET_DELAY: Duration = Duration::from_millis(50);
+const DEFAULT_TOPOLOGY_REFRESH_RATE: Duration = Duration::from_secs(5 * 60); // every 5min
+const DEFAULT_TOPOLOGY_RESOLUTION_TIMEOUT: Duration = Duration::from_millis(5_000);
+// Set this to a high value for now, so that we don't risk sporadic timeouts that might cause
+// bought bandwidth tokens to not have time to be spent; Once we remove the gateway from the
+// bandwidth bridging protocol, we can come back to a smaller timeout value
+const DEFAULT_GATEWAY_RESPONSE_TIMEOUT: Duration = Duration::from_secs(5 * 60);
+
+pub fn missing_string_value() -> String {
+    MISSING_VALUE.to_string()
+}
+
+#[derive(Debug, Deserialize, PartialEq, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct Config<T> {
+    client: Client<T>,
+
+    #[serde(default)]
+    logging: Logging,
+    #[serde(default)]
+    debug: Debug,
+}
+
+impl<T: NymConfig> Config<T> {
+    pub fn new<S: Into<String>>(id: S) -> Self {
+        let mut cfg = Config::default();
+        cfg.with_id(id);
+        cfg
+    }
+
+    pub fn with_id<S: Into<String>>(&mut self, id: S) {
+        let id = id.into();
+
+        // identity key setting
+        if self.client.private_identity_key_file.as_os_str().is_empty() {
+            self.client.private_identity_key_file =
+                self::Client::<T>::default_private_identity_key_file(&id);
+        }
+        if self.client.public_identity_key_file.as_os_str().is_empty() {
+            self.client.public_identity_key_file =
+                self::Client::<T>::default_public_identity_key_file(&id);
+        }
+
+        // encryption key setting
+        if self
+            .client
+            .private_encryption_key_file
+            .as_os_str()
+            .is_empty()
+        {
+            self.client.private_encryption_key_file =
+                self::Client::<T>::default_private_encryption_key_file(&id);
+        }
+        if self
+            .client
+            .public_encryption_key_file
+            .as_os_str()
+            .is_empty()
+        {
+            self.client.public_encryption_key_file =
+                self::Client::<T>::default_public_encryption_key_file(&id);
+        }
+
+        // shared gateway key setting
+        if self.client.gateway_shared_key_file.as_os_str().is_empty() {
+            self.client.gateway_shared_key_file =
+                self::Client::<T>::default_gateway_shared_key_file(&id);
+        }
+
+        // ack key setting
+        if self.client.ack_key_file.as_os_str().is_empty() {
+            self.client.ack_key_file = self::Client::<T>::default_ack_key_file(&id);
+        }
+
+        if self
+            .client
+            .reply_encryption_key_store_path
+            .as_os_str()
+            .is_empty()
+        {
+            self.client.reply_encryption_key_store_path =
+                self::Client::<T>::default_reply_encryption_key_store_path(&id);
+        }
+
+        if self.client.database_path.as_os_str().is_empty() {
+            self.client.database_path = self::Client::<T>::default_database_path(&id);
+        }
+
+        self.client.id = id;
+    }
+
+    pub fn with_disabled_credentials(&mut self, disabled_credentials_mode: bool) {
+        self.client.disabled_credentials_mode = disabled_credentials_mode;
+    }
+
+    pub fn with_gateway_endpoint(&mut self, gateway_endpoint: GatewayEndpoint) {
+        self.client.gateway_endpoint = gateway_endpoint;
+    }
+
+    pub fn with_gateway_id<S: Into<String>>(&mut self, id: S) {
+        self.client.gateway_endpoint.gateway_id = id.into();
+    }
+
+    #[cfg(not(feature = "coconut"))]
+    pub fn with_eth_private_key<S: Into<String>>(&mut self, eth_private_key: S) {
+        self.client.eth_private_key = eth_private_key.into();
+    }
+
+    #[cfg(not(feature = "coconut"))]
+    pub fn with_eth_endpoint<S: Into<String>>(&mut self, eth_endpoint: S) {
+        self.client.eth_endpoint = eth_endpoint.into();
+    }
+
+    pub fn set_custom_validator_apis(&mut self, validator_api_urls: Vec<Url>) {
+        self.client.validator_api_urls = validator_api_urls;
+    }
+
+    pub fn set_high_default_traffic_volume(&mut self) {
+        self.debug.average_packet_delay = Duration::from_millis(10);
+        self.debug.loop_cover_traffic_average_delay = Duration::from_millis(2_000_000); // basically don't really send cover messages
+        self.debug.message_sending_average_delay = Duration::from_millis(4); // 250 "real" messages / s
+    }
+
+    pub fn set_custom_version(&mut self, version: &str) {
+        self.client.version = version.to_string();
+    }
+
+    pub fn get_id(&self) -> String {
+        self.client.id.clone()
+    }
+
+    pub fn get_disabled_credentials_mode(&self) -> bool {
+        self.client.disabled_credentials_mode
+    }
+
+    pub fn get_nym_root_directory(&self) -> PathBuf {
+        self.client.nym_root_directory.clone()
+    }
+
+    pub fn get_private_identity_key_file(&self) -> PathBuf {
+        self.client.private_identity_key_file.clone()
+    }
+
+    pub fn get_public_identity_key_file(&self) -> PathBuf {
+        self.client.public_identity_key_file.clone()
+    }
+
+    pub fn get_private_encryption_key_file(&self) -> PathBuf {
+        self.client.private_encryption_key_file.clone()
+    }
+
+    pub fn get_public_encryption_key_file(&self) -> PathBuf {
+        self.client.public_encryption_key_file.clone()
+    }
+
+    pub fn get_gateway_shared_key_file(&self) -> PathBuf {
+        self.client.gateway_shared_key_file.clone()
+    }
+
+    pub fn get_reply_encryption_key_store_path(&self) -> PathBuf {
+        self.client.reply_encryption_key_store_path.clone()
+    }
+
+    pub fn get_ack_key_file(&self) -> PathBuf {
+        self.client.ack_key_file.clone()
+    }
+
+    pub fn get_validator_api_endpoints(&self) -> Vec<Url> {
+        self.client.validator_api_urls.clone()
+    }
+
+    pub fn get_gateway_id(&self) -> String {
+        self.client.gateway_endpoint.gateway_id.clone()
+    }
+
+    pub fn get_gateway_owner(&self) -> String {
+        self.client.gateway_endpoint.gateway_owner.clone()
+    }
+
+    pub fn get_gateway_listener(&self) -> String {
+        self.client.gateway_endpoint.gateway_listener.clone()
+    }
+
+    pub fn get_gateway_endpoint(&self) -> &GatewayEndpoint {
+        &self.client.gateway_endpoint
+    }
+
+    pub fn get_database_path(&self) -> PathBuf {
+        self.client.database_path.clone()
+    }
+
+    #[cfg(not(feature = "coconut"))]
+    pub fn get_eth_endpoint(&self) -> String {
+        self.client.eth_endpoint.clone()
+    }
+
+    #[cfg(not(feature = "coconut"))]
+    pub fn get_eth_private_key(&self) -> String {
+        self.client.eth_private_key.clone()
+    }
+
+    // Debug getters
+    pub fn get_average_packet_delay(&self) -> Duration {
+        self.debug.average_packet_delay
+    }
+
+    pub fn get_average_ack_delay(&self) -> Duration {
+        self.debug.average_ack_delay
+    }
+
+    pub fn get_ack_wait_multiplier(&self) -> f64 {
+        self.debug.ack_wait_multiplier
+    }
+
+    pub fn get_ack_wait_addition(&self) -> Duration {
+        self.debug.ack_wait_addition
+    }
+
+    pub fn get_loop_cover_traffic_average_delay(&self) -> Duration {
+        self.debug.loop_cover_traffic_average_delay
+    }
+
+    pub fn get_message_sending_average_delay(&self) -> Duration {
+        self.debug.message_sending_average_delay
+    }
+
+    pub fn get_gateway_response_timeout(&self) -> Duration {
+        self.debug.gateway_response_timeout
+    }
+
+    pub fn get_topology_refresh_rate(&self) -> Duration {
+        self.debug.topology_refresh_rate
+    }
+
+    pub fn get_topology_resolution_timeout(&self) -> Duration {
+        self.debug.topology_resolution_timeout
+    }
+
+    pub fn get_version(&self) -> &str {
+        &self.client.version
+    }
+}
+
+impl<T: NymConfig> Default for Config<T> {
+    fn default() -> Self {
+        Config {
+            client: Client::<T>::default(),
+            logging: Default::default(),
+            debug: Default::default(),
+        }
+    }
+}
+
+#[derive(Clone, Debug, Default, Deserialize, PartialEq, Eq, Serialize)]
+pub struct GatewayEndpoint {
+    /// gateway_id specifies ID of the gateway to which the client should send messages.
+    /// If initially omitted, a random gateway will be chosen from the available topology.
+    pub gateway_id: String,
+
+    /// Address of the gateway owner to which the client should send messages.
+    pub gateway_owner: String,
+
+    /// Address of the gateway listener to which all client requests should be sent.
+    pub gateway_listener: String,
+}
+
+impl From<topology::gateway::Node> for GatewayEndpoint {
+    fn from(node: topology::gateway::Node) -> GatewayEndpoint {
+        let gateway_listener = node.clients_address();
+        GatewayEndpoint {
+            gateway_id: node.identity_key.to_base58_string(),
+            gateway_owner: node.owner,
+            gateway_listener,
+        }
+    }
+}
+
+#[derive(Debug, Deserialize, PartialEq, Eq, Serialize)]
+pub struct Client<T> {
+    /// Version of the client for which this configuration was created.
+    #[serde(default = "missing_string_value")]
+    version: String,
+
+    /// ID specifies the human readable ID of this particular client.
+    id: String,
+
+    /// Indicates whether this client is running in a disabled credentials mode, thus attempting
+    /// to claim bandwidth without presenting bandwidth credentials.
+    #[serde(default)]
+    disabled_credentials_mode: bool,
+
+    /// Addresses to APIs running on validator from which the client gets the view of the network.
+    validator_api_urls: Vec<Url>,
+
+    /// Path to file containing private identity key.
+    private_identity_key_file: PathBuf,
+
+    /// Path to file containing public identity key.
+    public_identity_key_file: PathBuf,
+
+    /// Path to file containing private encryption key.
+    private_encryption_key_file: PathBuf,
+
+    /// Path to file containing public encryption key.
+    public_encryption_key_file: PathBuf,
+
+    /// Path to file containing shared key derived with the specified gateway that is used
+    /// for all communication with it.
+    gateway_shared_key_file: PathBuf,
+
+    /// Path to file containing key used for encrypting and decrypting the content of an
+    /// acknowledgement so that nobody besides the client knows which packet it refers to.
+    ack_key_file: PathBuf,
+
+    /// Full path to file containing reply encryption keys of all reply-SURBs we have ever
+    /// sent but not received back.
+    reply_encryption_key_store_path: PathBuf,
+
+    /// Information regarding how the client should send data to gateway.
+    gateway_endpoint: GatewayEndpoint,
+
+    /// Path to the database containing bandwidth credentials of this client.
+    database_path: PathBuf,
+
+    /// Ethereum private key.
+    #[cfg(not(feature = "coconut"))]
+    eth_private_key: String,
+
+    /// Address to an Ethereum full node.
+    #[cfg(not(feature = "coconut"))]
+    eth_endpoint: String,
+
+    /// nym_home_directory specifies absolute path to the home nym Clients directory.
+    /// It is expected to use default value and hence .toml file should not redefine this field.
+    nym_root_directory: PathBuf,
+
+    #[serde(skip)]
+    super_struct: PhantomData<T>,
+}
+
+impl<T: NymConfig> Default for Client<T> {
+    fn default() -> Self {
+        // 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_api_urls: vec![],
+            private_identity_key_file: Default::default(),
+            public_identity_key_file: Default::default(),
+            private_encryption_key_file: Default::default(),
+            public_encryption_key_file: Default::default(),
+            gateway_shared_key_file: Default::default(),
+            ack_key_file: Default::default(),
+            reply_encryption_key_store_path: Default::default(),
+            gateway_endpoint: Default::default(),
+            database_path: Default::default(),
+            #[cfg(not(feature = "coconut"))]
+            eth_private_key: "".to_string(),
+            #[cfg(not(feature = "coconut"))]
+            eth_endpoint: "".to_string(),
+            nym_root_directory: T::default_root_directory(),
+            super_struct: Default::default(),
+        }
+    }
+}
+
+impl<T: NymConfig> Client<T> {
+    fn default_private_identity_key_file(id: &str) -> PathBuf {
+        T::default_data_directory(Some(id)).join("private_identity.pem")
+    }
+
+    fn default_public_identity_key_file(id: &str) -> PathBuf {
+        T::default_data_directory(Some(id)).join("public_identity.pem")
+    }
+
+    fn default_private_encryption_key_file(id: &str) -> PathBuf {
+        T::default_data_directory(Some(id)).join("private_encryption.pem")
+    }
+
+    fn default_public_encryption_key_file(id: &str) -> PathBuf {
+        T::default_data_directory(Some(id)).join("public_encryption.pem")
+    }
+
+    fn default_gateway_shared_key_file(id: &str) -> PathBuf {
+        T::default_data_directory(Some(id)).join("gateway_shared.pem")
+    }
+
+    fn default_ack_key_file(id: &str) -> PathBuf {
+        T::default_data_directory(Some(id)).join("ack_key.pem")
+    }
+
+    fn default_reply_encryption_key_store_path(id: &str) -> PathBuf {
+        T::default_data_directory(Some(id)).join("reply_key_store")
+    }
+    fn default_database_path(id: &str) -> PathBuf {
+        T::default_data_directory(Some(id)).join("db.sqlite")
+    }
+}
+
+#[derive(Debug, Default, Deserialize, PartialEq, Eq, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct Logging {}
+
+#[derive(Debug, Deserialize, PartialEq, Serialize)]
+#[serde(default, deny_unknown_fields)]
+pub struct Debug {
+    /// The parameter of Poisson distribution determining how long, on average,
+    /// sent packet is going to be delayed at any given mix node.
+    /// So for a packet going through three mix nodes, on average, it will take three times this value
+    /// until the packet reaches its destination.
+    #[serde(with = "humantime_serde")]
+    average_packet_delay: Duration,
+
+    /// The parameter of Poisson distribution determining how long, on average,
+    /// sent acknowledgement is going to be delayed at any given mix node.
+    /// So for an ack going through three mix nodes, on average, it will take three times this value
+    /// until the packet reaches its destination.
+    #[serde(with = "humantime_serde")]
+    average_ack_delay: Duration,
+
+    /// Value multiplied with the expected round trip time of an acknowledgement packet before
+    /// it is assumed it was lost and retransmission of the data packet happens.
+    /// In an ideal network with 0 latency, this value would have been 1.
+    ack_wait_multiplier: f64,
+
+    /// Value added to the expected round trip time of an acknowledgement packet before
+    /// it is assumed it was lost and retransmission of the data packet happens.
+    /// In an ideal network with 0 latency, this value would have been 0.
+    #[serde(with = "humantime_serde")]
+    ack_wait_addition: Duration,
+
+    /// The parameter of Poisson distribution determining how long, on average,
+    /// it is going to take for another loop cover traffic message to be sent.
+    #[serde(with = "humantime_serde")]
+    loop_cover_traffic_average_delay: Duration,
+
+    /// The parameter of Poisson distribution determining how long, on average,
+    /// it is going to take another 'real traffic stream' message to be sent.
+    /// If no real packets are available and cover traffic is enabled,
+    /// a loop cover message is sent instead in order to preserve the rate.
+    #[serde(with = "humantime_serde")]
+    message_sending_average_delay: Duration,
+
+    /// How long we're willing to wait for a response to a message sent to the gateway,
+    /// before giving up on it.
+    #[serde(with = "humantime_serde")]
+    gateway_response_timeout: Duration,
+
+    /// The uniform delay every which clients are querying the directory server
+    /// to try to obtain a compatible network topology to send sphinx packets through.
+    #[serde(with = "humantime_serde")]
+    topology_refresh_rate: Duration,
+
+    /// During topology refresh, test packets are sent through every single possible network
+    /// path. This timeout determines waiting period until it is decided that the packet
+    /// did not reach its destination.
+    #[serde(with = "humantime_serde")]
+    topology_resolution_timeout: Duration,
+}
+
+impl Default for Debug {
+    fn default() -> Self {
+        Debug {
+            average_packet_delay: DEFAULT_AVERAGE_PACKET_DELAY,
+            average_ack_delay: DEFAULT_AVERAGE_PACKET_DELAY,
+            ack_wait_multiplier: DEFAULT_ACK_WAIT_MULTIPLIER,
+            ack_wait_addition: DEFAULT_ACK_WAIT_ADDITION,
+            loop_cover_traffic_average_delay: DEFAULT_LOOP_COVER_STREAM_AVERAGE_DELAY,
+            message_sending_average_delay: DEFAULT_MESSAGE_STREAM_AVERAGE_DELAY,
+            gateway_response_timeout: DEFAULT_GATEWAY_RESPONSE_TIMEOUT,
+            topology_refresh_rate: DEFAULT_TOPOLOGY_REFRESH_RATE,
+            topology_resolution_timeout: DEFAULT_TOPOLOGY_RESOLUTION_TIMEOUT,
+        }
+    }
+}

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

@@ -2,17 +2,17 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::config::Config;
-use nym_config::NymConfig;
+use config::NymConfig;
 use std::path::{Path, PathBuf};
 
 #[derive(Debug)]
 pub struct ClientKeyPathfinder {
-    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,
+    identity_private_key: PathBuf,
+    identity_public_key: PathBuf,
+    encryption_private_key: PathBuf,
+    encryption_public_key: PathBuf,
+    gateway_shared_key: PathBuf,
+    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("private_encryption.pem"),
-            encryption_public_key: config_dir.join("public_encryption.pem"),
+            encryption_private_key: config_dir.join("public_encryption.pem"),
+            encryption_public_key: config_dir.join("private_encryption.pem"),
             gateway_shared_key: config_dir.join("gateway_shared.pem"),
             ack_key: config_dir.join("ack_key.pem"),
         }
@@ -40,28 +40,6 @@ 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
     }
@@ -86,10 +64,3 @@ impl ClientKeyPathfinder {
         &self.ack_key
     }
 }
-
-fn file_exists(path: &Path) -> Option<PathBuf> {
-    if matches!(path.try_exists(), Ok(true)) {
-        return Some(path.to_path_buf());
-    }
-    None
-}

clients/client-core/src/init.rs

@@ -0,0 +1,137 @@
+// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+//! Collection of initialization steps used by client implementations
+
+use std::{sync::Arc, time::Duration};
+
+use config::NymConfig;
+use crypto::asymmetric::{encryption, identity};
+use gateway_client::GatewayClient;
+use gateway_requests::registration::handshake::SharedKeys;
+use nymsphinx::addressing::clients::Recipient;
+use nymsphinx::addressing::nodes::NodeIdentity;
+use rand::rngs::OsRng;
+use rand::seq::SliceRandom;
+use rand::thread_rng;
+use topology::{filter::VersionFilterable, gateway};
+use url::Url;
+
+use crate::{
+    client::key_manager::KeyManager,
+    config::{persistence::key_pathfinder::ClientKeyPathfinder, Config},
+};
+
+pub async fn query_gateway_details(
+    validator_servers: Vec<Url>,
+    chosen_gateway_id: Option<&str>,
+) -> gateway::Node {
+    let validator_api = validator_servers
+        .choose(&mut thread_rng())
+        .expect("The list of validator apis is empty");
+    let validator_client = validator_client::ApiClient::new(validator_api.clone());
+
+    log::trace!("Fetching list of gateways from: {}", validator_api);
+    let gateways = validator_client.get_cached_gateways().await.unwrap();
+    let valid_gateways = gateways
+        .into_iter()
+        .filter_map(|gateway| gateway.try_into().ok())
+        .collect::<Vec<gateway::Node>>();
+
+    let filtered_gateways = valid_gateways.filter_by_version(env!("CARGO_PKG_VERSION"));
+
+    // if we have chosen particular gateway - use it, otherwise choose a random one.
+    // (remember that in active topology all gateways have at least 100 reputation so should
+    // be working correctly)
+    if let Some(gateway_id) = chosen_gateway_id {
+        filtered_gateways
+            .iter()
+            .find(|gateway| gateway.identity_key.to_base58_string() == gateway_id)
+            .expect(&*format!("no gateway with id {} exists!", gateway_id))
+            .clone()
+    } else {
+        filtered_gateways
+            .choose(&mut rand::thread_rng())
+            .expect("there are no gateways on the network!")
+            .clone()
+    }
+}
+
+pub async fn register_with_gateway_and_store_keys<T>(
+    gateway_details: gateway::Node,
+    config: &Config<T>,
+) 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);
+    key_manager
+        .store_keys(&pathfinder)
+        .expect("Failed to generated keys");
+}
+
+async fn register_with_gateway(
+    gateway: &gateway::Node,
+    our_identity: Arc<identity::KeyPair>,
+) -> Arc<SharedKeys> {
+    let timeout = Duration::from_millis(1500);
+    let mut gateway_client = GatewayClient::new_init(
+        gateway.clients_address(),
+        gateway.identity_key,
+        gateway.owner.clone(),
+        our_identity.clone(),
+        timeout,
+    );
+    gateway_client
+        .establish_connection()
+        .await
+        .expect("failed to establish connection with the gateway!");
+    gateway_client
+        .perform_initial_authentication()
+        .await
+        .expect("failed to register with the gateway!")
+}
+
+pub fn show_address<T>(config: &Config<T>)
+where
+    T: config::NymConfig,
+{
+    fn load_identity_keys(pathfinder: &ClientKeyPathfinder) -> identity::KeyPair {
+        let identity_keypair: identity::KeyPair =
+            pemstore::load_keypair(&pemstore::KeyPairPath::new(
+                pathfinder.private_identity_key().to_owned(),
+                pathfinder.public_identity_key().to_owned(),
+            ))
+            .expect("Failed to read stored identity key files");
+        identity_keypair
+    }
+
+    fn load_sphinx_keys(pathfinder: &ClientKeyPathfinder) -> encryption::KeyPair {
+        let sphinx_keypair: encryption::KeyPair =
+            pemstore::load_keypair(&pemstore::KeyPairPath::new(
+                pathfinder.private_encryption_key().to_owned(),
+                pathfinder.public_encryption_key().to_owned(),
+            ))
+            .expect("Failed to read stored sphinx key files");
+        sphinx_keypair
+    }
+
+    let pathfinder = ClientKeyPathfinder::new_from_config(config);
+    let identity_keypair = load_identity_keys(&pathfinder);
+    let sphinx_keypair = load_sphinx_keys(&pathfinder);
+
+    let client_recipient = Recipient::new(
+        *identity_keypair.public_key(),
+        *sphinx_keypair.public_key(),
+        // TODO: below only works under assumption that gateway address == gateway id
+        // (which currently is true)
+        NodeIdentity::from_base58_string(config.get_gateway_id()).unwrap(),
+    );
+
+    println!("\nThe address of this client is: {}", client_recipient);
+}

clients/client-core/src/lib.rs

@@ -0,0 +1,3 @@
+pub mod client;
+pub mod config;
+pub mod init;

clients/credential/Cargo.toml

@@ -6,22 +6,25 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-bip39 = { workspace = true }
-clap = { version = "4.0", features = ["cargo", "derive"] }
-log = "0.4"
+async-trait = "0.1.52"
+bip39 = "1.0.1"
+cfg-if = "0.1"
+clap = { version = "3.0.10", features = ["cargo", "derive"] }
+pickledb = "0.4.1"
 rand = "0.7.3"
 serde = { version = "1.0", features = ["derive"] }
 thiserror = "1.0"
 url = "2.2"
-tokio = { version = "1.24.1", features = ["rt-multi-thread", "net", "signal", "macros"] } # async runtime
+tokio = { version = "1.19.1", features = ["rt-multi-thread", "net", "signal", "macros"] } # async runtime
 
-nym-coconut-interface = { path = "../../common/coconut-interface" }
-nym-config = { path = "../../common/config" }
-nym-credentials = { path = "../../common/credentials" }
-nym-credential-storage = { path = "../../common/credential-storage" }
-nym-crypto = { path = "../../common/crypto", features = ["rand", "asymmetric", "symmetric", "aes", "hashing"] }
-nym-bin-common = { path = "../../common/bin-common"}
-nym-network-defaults = { path = "../../common/network-defaults" }
-nym-pemstore = { path = "../../common/pemstore" }
-validator-client = { path = "../../common/client-libs/validator-client", features = ["nyxd-client"] }
+coconut-interface = { path = "../../common/coconut-interface" }
+config = { path = "../../common/config" }
+credentials = { path = "../../common/credentials" }
+credential-storage = { path = "../../common/credential-storage" }
+crypto = { path = "../../common/crypto", features = ["rand", "asymmetric", "symmetric", "aes", "hashing"] }
+network-defaults = { path = "../../common/network-defaults" }
+pemstore = { path = "../../common/pemstore" }
+validator-client = { path = "../../common/client-libs/validator-client", features = ["nymd-client"] }
 
+[features]
+coconut = ["credentials/coconut"]

clients/credential/README.md

@@ -1,32 +0,0 @@
-<!--
-Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
-SPDX-License-Identifier: Apache-2.0
--->
-
-## Credential binary
-
-The credential binary is used to acquire coconut bandwidth credentials in exchange for nym tokens. Those credentials are stored in the client's `data` directory, so that they can be used as the client sees fit.
-
-### Warning
-
-The credential binary is still experimental software. The infrastructure for using it is not yet deployed to mainnet and it's still in the process of being deployed to sandbox.
-
-### Building
-
-From the project's root directory, run:
-```
-cargo build -p credential
-```
-which generates the `credential` binary in `target/debug/credential`.
-
-
-### Running
-
-For example, you can get a credential worth 3 nym (3000000 unym) in a socks5 client that was already initialized like so:
-
-```
-./target/debug/credential --config-env-file envs/sandbox.env --client-home-directory  ~/.nym/socks5-clients/cred_client  --nyxd-url  https://sandbox-validator1.nymtech.net --mnemonic $MNEMONIC  --recovery-dir /tmp/recovery --amount 3000000
-```
-
-More information regarding how to run the binary can be found by running it with the `--help` argument.
-

clients/credential/src/client.rs

@@ -3,30 +3,30 @@
 
 use crate::error::Result;
 use bip39::Mnemonic;
-use nym_network_defaults::{NymNetworkDetails, VOUCHER_INFO};
+use network_defaults::{NymNetworkDetails, VOUCHER_INFO};
 use std::str::FromStr;
 use url::Url;
-use validator_client::nyxd;
-use validator_client::nyxd::traits::CoconutBandwidthSigningClient;
-use validator_client::nyxd::{Coin, DirectSigningNyxdClient, Fee, NyxdClient};
+use validator_client::nymd;
+use validator_client::nymd::traits::CoconutBandwidthSigningClient;
+use validator_client::nymd::{Coin, Fee, NymdClient, SigningNymdClient};
 
 pub(crate) struct Client {
-    nyxd_client: NyxdClient<DirectSigningNyxdClient>,
+    nymd_client: NymdClient<SigningNymdClient>,
     mix_denom_base: String,
 }
 
 impl Client {
-    pub fn new(nyxd_url: &str, mnemonic: &str) -> Self {
-        let nyxd_url = Url::from_str(nyxd_url).unwrap();
+    pub fn new(nymd_url: &str, mnemonic: &str) -> Self {
+        let nymd_url = Url::from_str(nymd_url).unwrap();
         let mnemonic = Mnemonic::from_str(mnemonic).unwrap();
         let network_details = NymNetworkDetails::new_from_env();
-        let config = nyxd::Config::try_from_nym_network_details(&network_details)
+        let config = nymd::Config::try_from_nym_network_details(&network_details)
             .expect("failed to construct valid validator client config with the provided network");
-        let nyxd_client =
-            NyxdClient::connect_with_mnemonic(config, nyxd_url.as_ref(), mnemonic, None).unwrap();
+        let nymd_client =
+            NymdClient::connect_with_mnemonic(config, nymd_url.as_ref(), mnemonic, None).unwrap();
 
         Client {
-            nyxd_client,
+            nymd_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
-            .nyxd_client
+            .nymd_client
             .deposit(
                 amount,
                 String::from(VOUCHER_INFO),

clients/credential/src/commands.rs

@@ -1,162 +1,192 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use clap::{ArgGroup, Args, Subcommand};
-use log::*;
-use nym_bin_common::completions::ArgShell;
-use nym_coconut_interface::{Base58, Parameters};
-use nym_credential_storage::storage::Storage;
-use nym_credential_storage::PersistentStorage;
-use nym_credentials::coconut::bandwidth::{BandwidthVoucher, TOTAL_ATTRIBUTES};
-use nym_credentials::coconut::utils::obtain_aggregate_signature;
-use nym_crypto::asymmetric::{encryption, identity};
-use nym_network_defaults::VOUCHER_INFO;
+use async_trait::async_trait;
+use clap::{Args, Subcommand};
+use pickledb::PickleDb;
 use rand::rngs::OsRng;
 use std::str::FromStr;
-use validator_client::nyxd::traits::DkgQueryClient;
-use validator_client::nyxd::tx::Hash;
-use validator_client::CoconutApiClient;
+
+use coconut_interface::{Attribute, Base58, BlindSignRequest, Bytable, Parameters};
+use credential_storage::storage::Storage;
+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::VOUCHER_INFO;
+use validator_client::nymd::tx::Hash;
 
 use crate::client::Client;
 use crate::error::{CredentialClientError, Result};
-use crate::recovery_storage::RecoveryStorage;
-use crate::state::{KeyPair, State};
+use crate::state::{KeyPair, RequestData, State};
 
 #[derive(Subcommand)]
-pub(crate) enum Command {
-    /// Run the binary to obtain a credential
-    Run(Run),
-
-    /// Generate shell completions
-    Completions(ArgShell),
-
-    /// Generate Fig specification
-    GenerateFigSpec,
+pub(crate) enum Commands {
+    /// Deposit funds for buying coconut credential
+    Deposit(Deposit),
+    /// Lists the tx hashes of previous deposits
+    ListDeposits(ListDeposits),
+    /// Get a credential for a given deposit
+    GetCredential(GetCredential),
 }
 
-#[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 nyxd URL that should be used
-    #[clap(long)]
-    pub(crate) nyxd_url: String,
-
-    /// A mnemonic for the account that buys the credential
-    #[clap(long)]
-    pub(crate) mnemonic: String,
-
-    /// 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,
+#[async_trait]
+pub(crate) trait Execute {
+    async fn execute(&self, db: &mut PickleDb, shared_storage: PersistentStorage) -> Result<()>;
 }
 
-pub(crate) async fn deposit(nyxd_url: &str, mnemonic: &str, amount: u64) -> Result<State> {
-    let mut rng = OsRng;
-    let signing_keypair = KeyPair::from(identity::KeyPair::new(&mut rng));
-    let encryption_keypair = KeyPair::from(encryption::KeyPair::new(&mut rng));
-    let params = Parameters::new(TOTAL_ATTRIBUTES).unwrap();
-
-    let client = Client::new(nyxd_url, mnemonic);
-    let tx_hash = client
-        .deposit(
-            amount,
-            signing_keypair.public_key.clone(),
-            encryption_keypair.public_key.clone(),
-            None,
-        )
-        .await?;
-
-    let voucher = BandwidthVoucher::new(
-        &params,
-        amount.to_string(),
-        VOUCHER_INFO.to_string(),
-        Hash::from_str(&tx_hash).map_err(|_| CredentialClientError::InvalidTxHash)?,
-        identity::PrivateKey::from_base58_string(&signing_keypair.private_key)?,
-        encryption::PrivateKey::from_base58_string(&encryption_keypair.private_key)?,
-    );
-
-    let state = State { voucher, params };
-
-    Ok(state)
+#[derive(Args, Clone)]
+pub(crate) struct Deposit {
+    /// The nymd URL that should be used
+    #[clap(long)]
+    nymd_url: String,
+    /// A mnemonic for the account that does the deposit
+    #[clap(long)]
+    mnemonic: String,
+    /// The amount that needs to be deposited
+    #[clap(long)]
+    amount: u64,
 }
 
-pub(crate) async fn get_credential<C: DkgQueryClient + Send + Sync>(
-    state: &State,
-    client: &C,
-    shared_storage: PersistentStorage,
-) -> Result<()> {
-    let epoch_id = client.get_current_epoch().await?.epoch_id;
-    let threshold = client
-        .get_current_epoch_threshold()
-        .await?
-        .ok_or(CredentialClientError::NoThreshold)?;
-    let coconut_api_clients = CoconutApiClient::all_coconut_api_clients(client, epoch_id).await?;
+#[async_trait]
+impl Execute for Deposit {
+    async fn execute(&self, db: &mut PickleDb, _shared_storage: PersistentStorage) -> Result<()> {
+        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 signature = obtain_aggregate_signature(
-        &state.params,
-        &state.voucher,
-        &coconut_api_clients,
-        threshold,
-    )
-    .await?;
-    info!("Signature: {:?}", signature.to_bs58());
-    shared_storage
-        .insert_coconut_credential(
-            state.voucher.get_voucher_value(),
-            VOUCHER_INFO.to_string(),
-            state.voucher.get_private_attributes()[0].to_bs58(),
-            state.voucher.get_private_attributes()[1].to_bs58(),
-            signature.to_bs58(),
-            epoch_id.to_string(),
-        )
-        .await?;
-
-    Ok(())
-}
-
-pub(crate) async fn recover_credentials<C: DkgQueryClient + Send + Sync>(
-    client: &C,
-    recovery_storage: &RecoveryStorage,
-    shared_storage: PersistentStorage,
-) -> 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, shared_storage.clone()).await {
-            error!(
-                "Could not recover deposit {} due to {:?}, try again later",
-                state.voucher.tx_hash(),
-                e
+        let client = Client::new(&self.nymd_url, &self.mnemonic);
+        let tx_hash = client
+            .deposit(
+                self.amount,
+                signing_keypair.public_key.clone(),
+                encryption_keypair.public_key.clone(),
+                None,
             )
-        } 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);
-            }
-        }
-    }
+            .await?;
 
-    Ok(())
+        let state = State {
+            amount: self.amount,
+            tx_hash: tx_hash.clone(),
+            signing_keypair,
+            encryption_keypair,
+            blind_request_data: None,
+            signature: None,
+        };
+        db.set(&tx_hash, &state).unwrap();
+
+        println!("{:?}", state);
+
+        Ok(())
+    }
+}
+
+#[derive(Args, Clone)]
+pub(crate) struct ListDeposits {}
+
+#[async_trait]
+impl Execute for ListDeposits {
+    async fn execute(&self, db: &mut PickleDb, _shared_storage: PersistentStorage) -> Result<()> {
+        for kv in db.iter() {
+            println!("{:?}", kv.get_value::<State>());
+        }
+
+        Ok(())
+    }
+}
+
+#[derive(Args, Clone)]
+pub(crate) struct GetCredential {
+    /// The hash of a successful deposit transaction
+    #[clap(long)]
+    tx_hash: String,
+    /// The URLs to the validator-api endpoints the are run as coconut signer authorities, separated
+    /// by comma (,)
+    #[clap(long)]
+    signer_authorities: String,
+    /// If we want to get the signature without attaching a blind sign request; it is expected that
+    /// there is already a signature stored on the signer
+    #[clap(long, parse(from_flag))]
+    __no_request: bool,
+}
+
+#[async_trait]
+impl Execute for GetCredential {
+    async fn execute(&self, db: &mut PickleDb, shared_storage: PersistentStorage) -> Result<()> {
+        let mut state = db
+            .get::<State>(&self.tx_hash)
+            .ok_or(CredentialClientError::NoDeposit)?;
+
+        let urls = config::parse_validators(&self.signer_authorities);
+
+        let params = Parameters::new(TOTAL_ATTRIBUTES).unwrap();
+        let bandwidth_credential_attributes = if self.__no_request {
+            if let Some(blind_request_data) = state.blind_request_data {
+                let serial_number =
+                    Attribute::try_from_byte_slice(&blind_request_data.serial_number)
+                        .map_err(|_| CredentialClientError::CorruptedBlindSignRequest)?;
+                let binding_number =
+                    Attribute::try_from_byte_slice(&blind_request_data.binding_number)
+                        .map_err(|_| CredentialClientError::CorruptedBlindSignRequest)?;
+                let pedersen_commitments_openings = vec![
+                    Attribute::try_from_byte_slice(&blind_request_data.first_attribute)
+                        .map_err(|_| CredentialClientError::CorruptedBlindSignRequest)?,
+                    Attribute::try_from_byte_slice(&blind_request_data.second_attribute)
+                        .map_err(|_| CredentialClientError::CorruptedBlindSignRequest)?,
+                ];
+                let blind_sign_request =
+                    BlindSignRequest::from_bytes(blind_request_data.blind_sign_req.as_slice())
+                        .map_err(|_| CredentialClientError::CorruptedBlindSignRequest)?;
+                BandwidthVoucher::new_with_blind_sign_req(
+                    [serial_number, binding_number],
+                    [&state.amount.to_string(), VOUCHER_INFO],
+                    Hash::from_str(&self.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,
+                    )?,
+                    pedersen_commitments_openings,
+                    blind_sign_request,
+                )
+            } else {
+                return Err(CredentialClientError::NoLocalBlindSignRequest);
+            }
+        } else {
+            BandwidthVoucher::new(
+                &params,
+                state.amount.to_string(),
+                VOUCHER_INFO.to_string(),
+                Hash::from_str(&self.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)?,
+            )
+        };
+
+        // Back up the blind sign req data, in case of sporadic failures
+        state.blind_request_data = Some(RequestData::new(
+            bandwidth_credential_attributes.get_private_attributes(),
+            bandwidth_credential_attributes.pedersen_commitments_openings(),
+            bandwidth_credential_attributes.blind_sign_request(),
+        )?);
+        db.set(&self.tx_hash, &state).unwrap();
+
+        let signature =
+            obtain_aggregate_signature(&params, &bandwidth_credential_attributes, &urls).await?;
+        shared_storage
+            .insert_coconut_credential(
+                state.amount.to_string(),
+                VOUCHER_INFO.to_string(),
+                bandwidth_credential_attributes.get_private_attributes()[0].to_bs58(),
+                bandwidth_credential_attributes.get_private_attributes()[1].to_bs58(),
+                signature.to_bs58(),
+            )
+            .await?;
+        state.signature = Some(signature.to_bs58());
+        db.set(&self.tx_hash, &state).unwrap();
+
+        println!("Signature: {:?}", state.signature);
+
+        Ok(())
+    }
 }

clients/credential/src/error.rs

@@ -1,32 +1,36 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use std::time::SystemTimeError;
 use thiserror::Error;
 
-use nym_credential_storage::error::StorageError;
-use nym_credentials::error::Error as CredentialError;
-use nym_crypto::asymmetric::encryption::KeyRecoveryError;
-use nym_crypto::asymmetric::identity::Ed25519RecoveryError;
-use validator_client::nyxd::error::NyxdError;
-use validator_client::ValidatorClientError;
+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;
 
 pub type Result<T> = std::result::Result<T, CredentialClientError>;
 
 #[derive(Error, Debug)]
 pub enum CredentialClientError {
-    #[error("IO error: {0}")]
-    IOError(#[from] std::io::Error),
-
-    #[error("Nyxd error: {0}")]
-    Nyxd(#[from] NyxdError),
-
-    #[error("Validator client error: {0}")]
-    ValidatorClientError(#[from] ValidatorClientError),
+    #[error("Nymd error: {0}")]
+    Nymd(#[from] NymdError),
 
     #[error("Credential error: {0}")]
     Credential(#[from] CredentialError),
 
+    #[error("No previous deposit with that tx hash")]
+    NoDeposit,
+
+    #[error("Wrong number of attributes")]
+    WrongAttributeNumber,
+
+    #[error("Could not find any backed up blind sign request data")]
+    NoLocalBlindSignRequest,
+
+    #[error("The local blind sign request data is corrupted")]
+    CorruptedBlindSignRequest,
+
     #[error("The tx hash provided is not valid")]
     InvalidTxHash,
 
@@ -38,10 +42,4 @@ 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,
 }

clients/credential/src/main.rs

@@ -1,115 +1,68 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-mod client;
-mod commands;
-mod error;
-mod recovery_storage;
-mod state;
+cfg_if::cfg_if! {
+    if #[cfg(feature = "coconut")] {
 
-use commands::*;
-use error::Result;
-use log::*;
-use nym_bin_common::completions::fig_generate;
-use nym_config::{CRED_DB_FILE_NAME, DATA_DIR};
-use nym_network_defaults::{setup_env, NymNetworkDetails};
-use std::process::exit;
-use std::time::{Duration, SystemTime};
+        mod client;
+        mod commands;
+        mod error;
+        mod state;
 
-use clap::{CommandFactory, Parser};
-use nym_bin_common::logging::setup_logging;
-use validator_client::nyxd::traits::DkgQueryClient;
-use validator_client::nyxd::CosmWasmClient;
-use validator_client::Config;
+        use commands::{Commands, Execute};
+        use error::Result;
+        use network_defaults::setup_env;
 
-const SAFETY_BUFFER_SECS: u64 = 60; // 1 minute
+        use clap::Parser;
+        use pickledb::{PickleDb, PickleDbDumpPolicy, SerializationMethod};
 
-#[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(long)]
+            pub(crate) config_env_file: Option<std::path::PathBuf>,
 
-    #[clap(subcommand)]
-    pub(crate) command: Command,
-}
+            /// Path where the sqlite credental database will be located.
+            /// It should point to a $HOME/$CLIENT_ID/data/db.sqlite file of
+            /// the client that is supposed to use the credential.
+            #[clap(long)]
+            pub(crate) credential_db_path: std::path::PathBuf,
 
-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);
+            #[clap(subcommand)]
+            command: Commands,
+        }
+
+        #[tokio::main]
+        async fn main() -> Result<()> {
+            let args = Cli::parse();
+            setup_env(args.config_env_file.clone());
+
+            let shared_storage = credential_storage::initialise_storage(args.credential_db_path.clone()).await;
+            let mut db = match PickleDb::load(
+                "credential.db",
+                PickleDbDumpPolicy::AutoDump,
+                SerializationMethod::Json,
+            ) {
+                Ok(db) => db,
+                Err(_) => PickleDb::new(
+                    "credential.db",
+                    PickleDbDumpPolicy::AutoDump,
+                    SerializationMethod::Json,
+                ),
+            };
+
+            match &args.command {
+                Commands::Deposit(m) => m.execute(&mut db, shared_storage).await?,
+                Commands::ListDeposits(m) => m.execute(&mut db, shared_storage).await?,
+                Commands::GetCredential(m) => m.execute(&mut db, shared_storage).await?,
             }
 
-            break;
-        } else {
-            // Use 1 additional second to not start the next iteration immediately and spam get_current_epoch queries
-            let secs_until_final = epoch
-                .final_timestamp_secs()
-                .saturating_sub(current_timestamp_secs)
-                + 1;
-            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(())
+        }
+    } else {
+        fn main() {
+            println!("Crate only designed for coconut feature");
         }
     }
-
-    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(CRED_DB_FILE_NAME);
-            let shared_storage = nym_credential_storage::initialise_storage(db_path).await;
-            let recovery_storage = recovery_storage::RecoveryStorage::new(r.recovery_dir)?;
-
-            let network_details = NymNetworkDetails::new_from_env();
-            let config = Config::try_from_nym_network_details(&network_details)?;
-            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.nyxd, 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.nyxd, &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(())
 }

clients/credential/src/recovery_storage.rs

@@ -1,56 +0,0 @@
-// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use nym_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)
-    }
-}

clients/credential/src/state.rs

@@ -1,11 +1,14 @@
 // Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use nym_coconut_interface::Parameters;
-use nym_credentials::coconut::bandwidth::BandwidthVoucher;
+use coconut_interface::{Attribute, BlindSignRequest, Bytable, PrivateAttribute};
+use serde::{Deserialize, Serialize};
 
-use nym_crypto::asymmetric::{encryption, identity};
+use crypto::asymmetric::{encryption, identity};
 
+use crate::error::{CredentialClientError, Result};
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
 pub(crate) struct KeyPair {
     pub public_key: String,
     pub private_key: String,
@@ -29,7 +32,41 @@ impl From<encryption::KeyPair> for KeyPair {
     }
 }
 
+#[derive(Clone, Debug, Deserialize, Serialize)]
 pub(crate) struct State {
-    pub voucher: BandwidthVoucher,
-    pub params: Parameters,
+    pub amount: u64,
+    pub tx_hash: String,
+    pub signing_keypair: KeyPair,
+    pub encryption_keypair: KeyPair,
+    pub blind_request_data: Option<RequestData>,
+    pub signature: Option<String>,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub(crate) struct RequestData {
+    pub serial_number: Vec<u8>,
+    pub binding_number: Vec<u8>,
+    pub first_attribute: Vec<u8>,
+    pub second_attribute: Vec<u8>,
+    pub blind_sign_req: Vec<u8>,
+}
+
+impl RequestData {
+    pub fn new(
+        private_attributes: Vec<PrivateAttribute>,
+        attributes: &[Attribute],
+        blind_sign_request: &BlindSignRequest,
+    ) -> Result<Self> {
+        if private_attributes.len() != 2 || attributes.len() != 2 {
+            Err(CredentialClientError::WrongAttributeNumber)
+        } else {
+            Ok(RequestData {
+                serial_number: private_attributes[0].to_byte_vec(),
+                binding_number: private_attributes[1].to_byte_vec(),
+                first_attribute: attributes[0].to_byte_vec(),
+                second_attribute: attributes[1].to_byte_vec(),
+                blind_sign_req: blind_sign_request.to_bytes(),
+            })
+        }
+    }
 }

clients/native/Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "nym-client"
-version = "1.1.13"
+version = "1.0.2"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>", "Jędrzej Stuczyński <andrew@nymtech.net>"]
 description = "Implementation of the Nym Client"
 edition = "2021"
-rust-version = "1.65"
+rust-version = "1.56"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -20,36 +20,39 @@ futures = "0.3" # bunch of futures stuff, however, now that I think about it, it
 # and the single instance of abortable we have should really be refactored anyway
 url = "2.2"
 
-clap = { version = "4.0", features = ["cargo", "derive"] }
+clap = { version = "3.2.8", features = ["cargo", "derive"] }
 dirs = "4.0"
-lazy_static = "1.4.0"
-log = { workspace = true } # self explanatory
+log = "0.4" # 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.24.1", features = ["rt-multi-thread", "net", "signal"] } # async runtime
+sled = "0.34" # for storage of replySURB decryption keys
+tokio = { version = "1.19.1", features = ["rt-multi-thread", "net", "signal"] } # async runtime
 tokio-tungstenite = "0.14" # websocket
 
 ## internal
-nym-bin-common = { path = "../../common/bin-common" }
-client-core = { path = "../../common/client-core", features = ["fs-surb-storage"] }
-nym-coconut-interface = { path = "../../common/coconut-interface" }
-nym-config = { path = "../../common/config" }
-nym-credential-storage = { path = "../../common/credential-storage" }
-nym-credentials = { path = "../../common/credentials" }
-nym-crypto = { path = "../../common/crypto" }
+client-core = { path = "../client-core" }
+coconut-interface = { path = "../../common/coconut-interface", optional = true }
+credentials = { path = "../../common/credentials", optional = true }
+credential-storage = { path = "../../common/credential-storage" }
+config = { path = "../../common/config" }
+crypto = { path = "../../common/crypto" }
 gateway-client = { path = "../../common/client-libs/gateway-client" }
 gateway-requests = { path = "../../gateway/gateway-requests" }
-nym-network-defaults = { path = "../../common/network-defaults" }
-nym-sphinx = { path = "../../common/nymsphinx" }
-nym-pemstore = { path = "../../common/pemstore" }
-nym-task = { path = "../../common/task" }
-nym-topology = { path = "../../common/topology" }
-validator-client = { path = "../../common/client-libs/validator-client", features = ["nyxd-client"] }
+nymsphinx = { path = "../../common/nymsphinx" }
+pemstore = { path = "../../common/pemstore" }
+topology = { path = "../../common/topology" }
 websocket-requests = { path = "websocket-requests" }
+validator-client = { path = "../../common/client-libs/validator-client", features = ["nymd-client"] }
+version-checker = { path = "../../common/version-checker" }
+network-defaults = { path = "../../common/network-defaults" }
+
+[features]
+coconut = ["coconut-interface", "credentials", "credentials/coconut", "gateway-requests/coconut", "gateway-client/coconut", "client-core/coconut"]
+eth = []
 
 [dev-dependencies]
 serde_json = "1.0" # for the "textsend" example
+
+[build-dependencies]
+vergen = { version = "5", default-features = false, features = ["build", "git", "rustc", "cargo"] }

clients/native/build.rs

@@ -0,0 +1,8 @@
+// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use vergen::{vergen, Config};
+
+fn main() {
+    vergen(Config::default()).expect("failed to extract build metadata")
+}

clients/native/examples/websocket_binarysend.rs

@@ -1,5 +1,5 @@
 use futures::{SinkExt, StreamExt};
-use nym_sphinx::addressing::clients::Recipient;
+use nymsphinx::addressing::clients::Recipient;
 use tokio::net::TcpStream;
 use tokio_tungstenite::{
     connect_async, tungstenite::protocol::Message, MaybeTlsStream, WebSocketStream,
@@ -25,59 +25,57 @@ async fn get_self_address(ws_stream: &mut WebSocketStream<MaybeTlsStream<TcpStre
     let response = send_message_and_get_response(ws_stream, self_address_request).await;
 
     match response {
-        ServerResponse::SelfAddress(recipient) => *recipient,
+        ServerResponse::SelfAddress(recipient) => recipient,
         _ => panic!("received an unexpected response!"),
     }
 }
 
 async fn send_file_with_reply() {
-    todo!("reimplement surb usage here : )")
-    // let uri = "ws://localhost:1977";
-    // let (mut ws_stream, _) = connect_async(uri).await.unwrap();
-    //
-    // let recipient = get_self_address(&mut ws_stream).await;
-    // println!("our full address is: {}", recipient);
-    //
-    // let read_data = std::fs::read("examples/dummy_file").unwrap();
-    //
-    // let send_request = ClientRequest::Send {
-    //     recipient,
-    //     message: read_data,
-    //     with_reply_surb: true,
-    //     connection_id: Some(0),
-    // };
-    //
-    // println!("sending content of 'dummy_file' over the mix network...");
-    // let response = send_message_and_get_response(&mut ws_stream, send_request.serialize()).await;
-    //
-    // let received = match response {
-    //     ServerResponse::Received(received) => received,
-    //     _ => panic!("received an unexpected response!"),
-    // };
-    //
-    // println!("writing the file back to the disk!");
-    // std::fs::write("examples/received_file_withreply", received.message).unwrap();
-    //
-    // let reply_message = b"hello from reply SURB! - thanks for sending me the file!".to_vec();
-    // let reply_request = ClientRequest::Reply {
-    //     message: reply_message.clone(),
-    //     reply_surb: received.reply_surb.unwrap(),
-    // };
-    //
-    // println!(
-    //     "sending {:?} (using reply SURB!) over the mix network...",
-    //     String::from_utf8(reply_message).unwrap()
-    // );
-    // let response = send_message_and_get_response(&mut ws_stream, reply_request.serialize()).await;
-    // let received = match response {
-    //     ServerResponse::Received(received) => received,
-    //     _ => panic!("received an unexpected response!"),
-    // };
-    //
-    // println!(
-    //     "received {:#?} from the mix network!",
-    //     String::from_utf8(received.message).unwrap()
-    // );
+    let uri = "ws://localhost:1977";
+    let (mut ws_stream, _) = connect_async(uri).await.unwrap();
+
+    let recipient = get_self_address(&mut ws_stream).await;
+    println!("our full address is: {}", recipient);
+
+    let read_data = std::fs::read("examples/dummy_file").unwrap();
+
+    let send_request = ClientRequest::Send {
+        recipient,
+        message: read_data,
+        with_reply_surb: true,
+    };
+
+    println!("sending content of 'dummy_file' over the mix network...");
+    let response = send_message_and_get_response(&mut ws_stream, send_request.serialize()).await;
+
+    let received = match response {
+        ServerResponse::Received(received) => received,
+        _ => panic!("received an unexpected response!"),
+    };
+
+    println!("writing the file back to the disk!");
+    std::fs::write("examples/received_file_withreply", received.message).unwrap();
+
+    let reply_message = b"hello from reply SURB! - thanks for sending me the file!".to_vec();
+    let reply_request = ClientRequest::Reply {
+        message: reply_message.clone(),
+        reply_surb: received.reply_surb.unwrap(),
+    };
+
+    println!(
+        "sending {:?} (using reply SURB!) over the mix network...",
+        String::from_utf8(reply_message).unwrap()
+    );
+    let response = send_message_and_get_response(&mut ws_stream, reply_request.serialize()).await;
+    let received = match response {
+        ServerResponse::Received(received) => received,
+        _ => panic!("received an unexpected response!"),
+    };
+
+    println!(
+        "received {:#?} from the mix network!",
+        String::from_utf8(received.message).unwrap()
+    );
 }
 
 async fn send_file_without_reply() {
@@ -85,14 +83,14 @@ 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();
 
     let send_request = ClientRequest::Send {
         recipient,
         message: read_data,
-        connection_id: Some(0),
+        with_reply_surb: false,
     };
 
     println!("sending content of 'dummy_file' over the mix network...");