Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 59455d3f13 | |||
| 329346d952 | |||
| 9495d9821b | |||
| 2b8f49f918 |
@@ -1,16 +0,0 @@
|
|||||||
# To get started with Dependabot version updates, you'll need to specify which
|
|
||||||
# package ecosystems to update and where the package manifests are located.
|
|
||||||
# Please see the documentation for all configuration options:
|
|
||||||
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
|
|
||||||
|
|
||||||
version: 2
|
|
||||||
updates:
|
|
||||||
# Maintain dependencies for GitHub Actions
|
|
||||||
- package-ecosystem: "github-actions"
|
|
||||||
directory: "/"
|
|
||||||
schedule:
|
|
||||||
interval: "daily"
|
|
||||||
commit-message:
|
|
||||||
prefix: build
|
|
||||||
prefix-development: chore
|
|
||||||
include: scope
|
|
||||||
@@ -69,7 +69,7 @@ jobs:
|
|||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: build
|
command: build
|
||||||
args: --workspace --release --all
|
args: --workspace --release
|
||||||
|
|
||||||
- name: Install Rust stable
|
- name: Install Rust stable
|
||||||
uses: actions-rs/toolchain@v1
|
uses: actions-rs/toolchain@v1
|
||||||
@@ -79,9 +79,6 @@ jobs:
|
|||||||
override: true
|
override: true
|
||||||
components: rustfmt, clippy
|
components: rustfmt, clippy
|
||||||
|
|
||||||
- name: Install wasm-opt
|
|
||||||
run: cargo install --version 0.112.0 wasm-opt
|
|
||||||
|
|
||||||
- name: Build release contracts
|
- name: Build release contracts
|
||||||
run: make wasm
|
run: make wasm
|
||||||
|
|
||||||
@@ -98,15 +95,9 @@ jobs:
|
|||||||
cp target/release/nym-network-requester $OUTPUT_DIR
|
cp target/release/nym-network-requester $OUTPUT_DIR
|
||||||
cp target/release/nym-network-statistics $OUTPUT_DIR
|
cp target/release/nym-network-statistics $OUTPUT_DIR
|
||||||
cp target/release/nym-cli $OUTPUT_DIR
|
cp target/release/nym-cli $OUTPUT_DIR
|
||||||
cp target/release/nym-credential-client $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/mixnet_contract.wasm $OUTPUT_DIR
|
||||||
cp contracts/target/wasm32-unknown-unknown/release/vesting_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
|
- name: Deploy branch to CI www
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
|
|||||||
@@ -1,76 +0,0 @@
|
|||||||
name: CD dev-portal
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: master
|
|
||||||
paths:
|
|
||||||
- 'documentation/dev-portal/**'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: custom-runner-linux
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- name: Install rsync
|
|
||||||
run: sudo apt-get install rsync
|
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
|
||||||
- uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: "16"
|
|
||||||
- name: Install Rust stable
|
|
||||||
uses: actions-rs/toolchain@v1
|
|
||||||
with:
|
|
||||||
toolchain: stable
|
|
||||||
- name: Install mdbook
|
|
||||||
run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook)
|
|
||||||
- name: Install mdbook plugins
|
|
||||||
run: |
|
|
||||||
cargo install --vers "^0.2.0" mdbook-variables && cargo install \
|
|
||||||
--vers "^1.8.0" mdbook-admonish && cargo install --vers \
|
|
||||||
"^0.1.2" mdbook-last-changed && cargo install --vers "^0.1.2" \
|
|
||||||
mdbook-theme && cargo install --vers "^0.7.7" mdbook-linkcheck
|
|
||||||
- name: Clean website
|
|
||||||
run: cd documentation/dev-portal && mdbook clean
|
|
||||||
- name: Build website
|
|
||||||
run: cd documentation/dev-portal && mdbook build
|
|
||||||
- name: Deploy branch master to dev
|
|
||||||
continue-on-error: true
|
|
||||||
uses: easingthemes/ssh-deploy@main
|
|
||||||
env:
|
|
||||||
SSH_PRIVATE_KEY: ${{ secrets.CD_WWW_SSH_PRIVATE_KEY }}
|
|
||||||
ARGS: "-rltgoDzvO --delete"
|
|
||||||
SOURCE: "documentation/dev-portal/book/html/"
|
|
||||||
REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_DEV }}
|
|
||||||
REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
|
|
||||||
TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET_DEVP }}/
|
|
||||||
EXCLUDE: "/dist/, /node_modules/"
|
|
||||||
- name: Deploy branch master to prod
|
|
||||||
uses: easingthemes/ssh-deploy@main
|
|
||||||
env:
|
|
||||||
SSH_PRIVATE_KEY: ${{ secrets.CD_WWW_SSH_PRIVATE_KEY }}
|
|
||||||
ARGS: "-rltgoDzvO --delete"
|
|
||||||
SOURCE: "documentation/dev-portal/book/html/"
|
|
||||||
REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_PROD }}
|
|
||||||
REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
|
|
||||||
TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET_DEVP }}/
|
|
||||||
EXCLUDE: "/dist/, /node_modules/"
|
|
||||||
- name: Matrix - Node Install
|
|
||||||
run: npm install
|
|
||||||
working-directory: .github/workflows/support-files
|
|
||||||
- name: Matrix - Send Notification
|
|
||||||
env:
|
|
||||||
NYM_NOTIFICATION_KIND: cd-dev
|
|
||||||
NYM_PROJECT_NAME: "Dev portal CD"
|
|
||||||
NYM_CI_WWW_BASE: "${{ secrets.NYM_CD_WWW_BASE }}"
|
|
||||||
NYM_CI_WWW_LOCATION: "${{ env.GITHUB_REF_SLUG }}"
|
|
||||||
GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
|
|
||||||
GIT_BRANCH: "${GITHUB_REF##*/}"
|
|
||||||
MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
|
|
||||||
MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_DEVP }}"
|
|
||||||
MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
|
|
||||||
MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
|
|
||||||
MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
|
|
||||||
IS_SUCCESS: "${{ job.status == 'success' }}"
|
|
||||||
uses: docker://keybaseio/client:stable-node
|
|
||||||
with:
|
|
||||||
args: .github/workflows/support-files/notifications/entry_point.sh
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
name: CD docs
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: master
|
|
||||||
paths:
|
|
||||||
- 'documentation/docs/**'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: custom-runner-linux
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- name: Install rsync
|
|
||||||
run: sudo apt-get install rsync
|
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
|
||||||
- uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: "16"
|
|
||||||
- name: Install Rust stable
|
|
||||||
uses: actions-rs/toolchain@v1
|
|
||||||
with:
|
|
||||||
toolchain: stable
|
|
||||||
- name: Build all binaries
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: build
|
|
||||||
args: --workspace --release --all
|
|
||||||
- name: Install mdbook
|
|
||||||
run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook)
|
|
||||||
- name: Install mdbook plugins
|
|
||||||
run: |
|
|
||||||
cargo install --vers "^0.2.0" mdbook-variables && cargo install \
|
|
||||||
--vers "^1.8.0" mdbook-admonish && cargo install --vers \
|
|
||||||
"^0.1.2" mdbook-last-changed && cargo install --vers "^0.1.2" \
|
|
||||||
mdbook-theme && cargo install --vers "^0.7.7" mdbook-linkcheck && \
|
|
||||||
cargo install --vers "^0.5.0" mdbook-cmdrun
|
|
||||||
- name: Clean website
|
|
||||||
run: cd documentation/docs && mdbook clean
|
|
||||||
- name: Build website
|
|
||||||
run: cd documentation/docs && mdbook build
|
|
||||||
- name: Deploy branch master to dev
|
|
||||||
continue-on-error: true
|
|
||||||
uses: easingthemes/ssh-deploy@main
|
|
||||||
env:
|
|
||||||
SSH_PRIVATE_KEY: ${{ secrets.CD_WWW_SSH_PRIVATE_KEY }}
|
|
||||||
ARGS: "-rltgoDzvO --delete"
|
|
||||||
SOURCE: "documentation/docs/book/"
|
|
||||||
REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_DEV }}
|
|
||||||
REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
|
|
||||||
TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET }}/
|
|
||||||
EXCLUDE: "/dist/, /node_modules/"
|
|
||||||
- name: Deploy branch master to prod
|
|
||||||
uses: easingthemes/ssh-deploy@main
|
|
||||||
env:
|
|
||||||
SSH_PRIVATE_KEY: ${{ secrets.CD_WWW_SSH_PRIVATE_KEY }}
|
|
||||||
ARGS: "-rltgoDzvO --delete"
|
|
||||||
SOURCE: "documentation/docs/book/"
|
|
||||||
REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_PROD }}
|
|
||||||
REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
|
|
||||||
TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET }}/
|
|
||||||
EXCLUDE: "/dist/, /node_modules/"
|
|
||||||
- name: Matrix - Node Install
|
|
||||||
run: npm install
|
|
||||||
working-directory: .github/workflows/support-files
|
|
||||||
- name: Matrix - Send Notification
|
|
||||||
env:
|
|
||||||
NYM_NOTIFICATION_KIND: cd-docs
|
|
||||||
NYM_PROJECT_NAME: "Docs CD"
|
|
||||||
NYM_CI_WWW_BASE: "${{ secrets.NYM_CD_WWW_BASE }}"
|
|
||||||
NYM_CI_WWW_LOCATION: "${{ env.GITHUB_REF_SLUG }}"
|
|
||||||
GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
|
|
||||||
GIT_BRANCH: "${GITHUB_REF##*/}"
|
|
||||||
MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
|
|
||||||
MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_DOCS }}"
|
|
||||||
MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
|
|
||||||
MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
|
|
||||||
MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
|
|
||||||
IS_SUCCESS: "${{ job.status == 'success' }}"
|
|
||||||
uses: docker://keybaseio/client:stable-node
|
|
||||||
with:
|
|
||||||
args: .github/workflows/support-files/notifications/entry_point.sh
|
|
||||||
@@ -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/
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
name: CI dev-portal
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches-ignore: master
|
|
||||||
paths:
|
|
||||||
- 'documentation/dev-portal/**'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: custom-runner-linux
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- name: Install rsync
|
|
||||||
run: sudo apt-get install rsync
|
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
|
||||||
- uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: "16"
|
|
||||||
- name: Install Rust stable
|
|
||||||
uses: actions-rs/toolchain@v1
|
|
||||||
with:
|
|
||||||
toolchain: stable
|
|
||||||
- name: Install mdbook
|
|
||||||
run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook)
|
|
||||||
- name: Install mdbook plugins
|
|
||||||
run: |
|
|
||||||
cargo install --vers "^0.2.0" mdbook-variables && cargo install \
|
|
||||||
--vers "^1.8.0" mdbook-admonish && cargo install --vers \
|
|
||||||
"^0.1.2" mdbook-last-changed && cargo install --vers "^0.1.2" mdbook-theme \
|
|
||||||
&& cargo install --vers "^0.7.7" mdbook-linkcheck
|
|
||||||
- name: Clean website
|
|
||||||
run: cd documentation/dev-portal && mdbook clean
|
|
||||||
- name: Build website
|
|
||||||
run: cd documentation/dev-portal && mdbook build
|
|
||||||
- name: Deploy branch to CI www
|
|
||||||
continue-on-error: true
|
|
||||||
uses: easingthemes/ssh-deploy@main
|
|
||||||
env:
|
|
||||||
SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
|
|
||||||
ARGS: "-rltgoDzvO --delete"
|
|
||||||
SOURCE: "documentation/dev-portal/book/html/"
|
|
||||||
REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
|
|
||||||
REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
|
|
||||||
TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/dev-portal-${{ env.GITHUB_REF_SLUG }}
|
|
||||||
EXCLUDE: "/dist/, /node_modules/"
|
|
||||||
- name: Matrix - Node Install
|
|
||||||
run: npm install
|
|
||||||
working-directory: .github/workflows/support-files
|
|
||||||
- name: Matrix - Send Notification
|
|
||||||
env:
|
|
||||||
NYM_NOTIFICATION_KIND: ci-dev
|
|
||||||
NYM_PROJECT_NAME: "Dev portal CI"
|
|
||||||
NYM_CI_WWW_BASE: "${{ secrets.NYM_CI_WWW_BASE }}"
|
|
||||||
NYM_CI_WWW_LOCATION: "dev-portal-${{ env.GITHUB_REF_SLUG }}"
|
|
||||||
GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
|
|
||||||
GIT_BRANCH: "${GITHUB_REF##*/}"
|
|
||||||
MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
|
|
||||||
MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_DEVP }}"
|
|
||||||
MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
|
|
||||||
MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
|
|
||||||
MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
|
|
||||||
IS_SUCCESS: "${{ job.status == 'success' }}"
|
|
||||||
uses: docker://keybaseio/client:stable-node
|
|
||||||
with:
|
|
||||||
args: .github/workflows/support-files/notifications/entry_point.sh
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
name: CI docs
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches-ignore: master
|
|
||||||
paths:
|
|
||||||
- 'documentation/docs/**'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: custom-runner-linux
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- name: Install rsync
|
|
||||||
run: sudo apt-get install rsync
|
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
|
||||||
- uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: "16"
|
|
||||||
- name: Install Rust stable
|
|
||||||
uses: actions-rs/toolchain@v1
|
|
||||||
with:
|
|
||||||
toolchain: stable
|
|
||||||
- name: Build all binaries
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: build
|
|
||||||
args: --workspace --release --all
|
|
||||||
- name: Install mdbook
|
|
||||||
run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook)
|
|
||||||
- name: Install mdbook plugins
|
|
||||||
run: |
|
|
||||||
cargo install --vers "^0.2.0" mdbook-variables && cargo install \
|
|
||||||
--vers "^1.8.0" mdbook-admonish && cargo install --vers \
|
|
||||||
"^0.1.2" mdbook-last-changed && cargo install --vers "^0.1.2" \
|
|
||||||
mdbook-theme && cargo install --vers "^0.7.7" mdbook-linkcheck && \
|
|
||||||
cargo install --vers "^0.5.0" mdbook-cmdrun
|
|
||||||
- name: Clean website
|
|
||||||
run: cd documentation/docs && mdbook clean
|
|
||||||
- name: Build website
|
|
||||||
run: cd documentation/docs && mdbook build
|
|
||||||
- name: Deploy branch to CI www
|
|
||||||
continue-on-error: true
|
|
||||||
uses: easingthemes/ssh-deploy@main
|
|
||||||
env:
|
|
||||||
SSH_PRIVATE_KEY: ${{ secrets.CI_WWW_SSH_PRIVATE_KEY }}
|
|
||||||
ARGS: "-rltgoDzvO --delete"
|
|
||||||
SOURCE: "documentation/docs/book/"
|
|
||||||
REMOTE_HOST: ${{ secrets.CI_WWW_REMOTE_HOST }}
|
|
||||||
REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
|
|
||||||
TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/docs-${{ env.GITHUB_REF_SLUG }}
|
|
||||||
EXCLUDE: "/dist/, /node_modules/"
|
|
||||||
- name: Matrix - Node Install
|
|
||||||
run: npm install
|
|
||||||
working-directory: .github/workflows/support-files
|
|
||||||
- name: Matrix - Send Notification
|
|
||||||
env:
|
|
||||||
NYM_NOTIFICATION_KIND: ci-docs
|
|
||||||
NYM_PROJECT_NAME: "Docs CI"
|
|
||||||
NYM_CI_WWW_BASE: "${{ secrets.NYM_CI_WWW_BASE }}"
|
|
||||||
NYM_CI_WWW_LOCATION: "docs-${{ env.GITHUB_REF_SLUG }}"
|
|
||||||
GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
|
|
||||||
GIT_BRANCH: "${GITHUB_REF##*/}"
|
|
||||||
MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
|
|
||||||
MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_DOCS }}"
|
|
||||||
MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
|
|
||||||
MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
|
|
||||||
MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
|
|
||||||
IS_SUCCESS: "${{ job.status == 'success' }}"
|
|
||||||
uses: docker://keybaseio/client:stable-node
|
|
||||||
with:
|
|
||||||
args: .github/workflows/support-files/notifications/entry_point.sh
|
|
||||||
@@ -23,12 +23,15 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get -y install \
|
sudo apt-get -y install \
|
||||||
|
libwebkit2gtk-4.0-dev \
|
||||||
build-essential \
|
build-essential \
|
||||||
unzip \
|
unzip \
|
||||||
curl \
|
curl \
|
||||||
wget \
|
wget \
|
||||||
libssl-dev \
|
libssl-dev \
|
||||||
|
libgtk-3-dev \
|
||||||
squashfs-tools \
|
squashfs-tools \
|
||||||
|
libayatana-appindicator3-dev \
|
||||||
librsvg2-dev
|
librsvg2-dev
|
||||||
|
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
@@ -61,11 +64,6 @@ jobs:
|
|||||||
- name: Install Rust toolchain
|
- name: Install Rust toolchain
|
||||||
uses: dtolnay/rust-toolchain@stable
|
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
|
- name: Install tauri cli
|
||||||
run: cargo install tauri-cli --version "^2.0.0-alpha.2"
|
run: cargo install tauri-cli --version "^2.0.0-alpha.2"
|
||||||
|
|
||||||
@@ -95,13 +93,11 @@ jobs:
|
|||||||
- name: Build APK
|
- name: Build APK
|
||||||
working-directory: nym-connect/mobile
|
working-directory: nym-connect/mobile
|
||||||
env:
|
env:
|
||||||
# NODE_TAURI_CLI=${{ github.workspace }}/nym-connect/mobile/node_modules/.bin/tauri
|
|
||||||
ANDROID_SDK_ROOT: ${{ env.ANDROID_HOME }}
|
ANDROID_SDK_ROOT: ${{ env.ANDROID_HOME }}
|
||||||
WRY_ANDROID_PACKAGE: net.nymtech.nym_connect
|
WRY_ANDROID_PACKAGE: net.nymtech.nym_connect
|
||||||
WRY_ANDROID_LIBRARY: nym_connect
|
WRY_ANDROID_LIBRARY: nym_connect
|
||||||
# TODO build with release profile (--release), it will requires
|
# TODO build with release profile (--release), it will requires
|
||||||
# to sign the APK. For now build with debug profile to avoid that
|
# 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
|
run: cargo tauri android build --debug --apk --split-per-abi -t aarch64
|
||||||
|
|
||||||
# TODO add the version number to APK name
|
# TODO add the version number to APK name
|
||||||
|
|||||||
@@ -49,6 +49,7 @@ jobs:
|
|||||||
librsvg2-dev \
|
librsvg2-dev \
|
||||||
libsoup-3.0-dev \
|
libsoup-3.0-dev \
|
||||||
libjavascriptcoregtk-4.1-dev
|
libjavascriptcoregtk-4.1-dev
|
||||||
|
#continue-on-error: true
|
||||||
|
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
if: ${{ (startsWith(github.ref, 'refs/tags/nym-contracts-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
|
if: ${{ startsWith(github.ref, 'refs/tags/nym-contracts-') && github.event_name == 'release' }}
|
||||||
runs-on: [self-hosted, custom-runner-linux]
|
runs-on: [self-hosted, custom-runner-linux]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
@@ -19,9 +19,6 @@ jobs:
|
|||||||
override: true
|
override: true
|
||||||
components: rustfmt, clippy
|
components: rustfmt, clippy
|
||||||
|
|
||||||
- name: Install wasm-opt
|
|
||||||
run: cargo install --version 0.112.0 wasm-opt
|
|
||||||
|
|
||||||
- name: Build release contracts
|
- name: Build release contracts
|
||||||
run: make wasm
|
run: make wasm
|
||||||
|
|
||||||
|
|||||||
@@ -30,7 +30,6 @@ jobs:
|
|||||||
continue-on-error: ${{ matrix.rust == 'nightly' }}
|
continue-on-error: ${{ matrix.rust == 'nightly' }}
|
||||||
needs: matrix_prep
|
needs: matrix_prep
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
|
||||||
matrix: ${{fromJson(needs.matrix_prep.outputs.matrix)}}
|
matrix: ${{fromJson(needs.matrix_prep.outputs.matrix)}}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
@@ -64,4 +63,4 @@ jobs:
|
|||||||
if: ${{ matrix.rust != 'nightly' }}
|
if: ${{ matrix.rust != 'nightly' }}
|
||||||
with:
|
with:
|
||||||
command: clippy
|
command: clippy
|
||||||
args: --manifest-path contracts/Cargo.toml --workspace --all-targets -- -D warnings
|
args: --manifest-path contracts/Cargo.toml --workspace -- -D warnings
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
name: Greetings
|
|
||||||
|
|
||||||
on: [pull_request_target, issues]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
greeting:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/first-interaction@v1
|
|
||||||
with:
|
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
issue-message: 'Thank you for raising this issue'
|
|
||||||
pr-message: 'Thank you for making this first PR'
|
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
name: CI for Network Explorer API
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
release:
|
||||||
|
types: [created]
|
||||||
|
|
||||||
|
env:
|
||||||
|
NETWORK: mainnet
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish-nym:
|
||||||
|
if: ${{ startsWith(github.ref, 'refs/tags/nym-explorer-api-') && (github.event_name == 'release' || github.event_name == 'workflow_dispatch') }}
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
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: Check the release tag starts with `nym-explorer-api-`
|
||||||
|
uses: actions/github-script@v3
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
core.setFailed('Release tag did not start with nym-explorer-api-...')
|
||||||
|
|
||||||
|
- name: Install Rust stable
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: stable
|
||||||
|
|
||||||
|
- name: Build all explorer-api
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: build
|
||||||
|
args: --manifest-path explorer-api/Cargo.toml --workspace --release
|
||||||
|
|
||||||
|
- name: Upload Artifact
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: my-artifact
|
||||||
|
path: |
|
||||||
|
target/release/explorer-api
|
||||||
|
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/explorer-api
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
name: Publish Nym CLI binaries
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
release:
|
||||||
|
types: [created]
|
||||||
|
|
||||||
|
env:
|
||||||
|
NETWORK: mainnet
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish-nym-cli:
|
||||||
|
if: ${{ startsWith(github.ref, 'refs/tags/nym-cli-') && (github.event_name == 'release' || github.event_name == 'workflow_dispatch') }}
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
platform: [ubuntu-20.04, windows-latest, macos-latest]
|
||||||
|
|
||||||
|
runs-on: ${{ matrix.platform }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Check the release tag starts with `nym-cli-`
|
||||||
|
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
|
||||||
@@ -10,7 +10,7 @@ defaults:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish-tauri:
|
publish-tauri:
|
||||||
if: ${{ (startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
|
if: ${{ startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release' }}
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ defaults:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish-tauri:
|
publish-tauri:
|
||||||
if: ${{ (startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
|
if: ${{ startsWith(github.ref, 'refs/tags/nym-connect-') && github.event_name == 'release' }}
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ env:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish-nym:
|
publish-nym:
|
||||||
if: ${{ (startsWith(github.ref, 'refs/tags/nym-binaries-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
|
if: ${{ startsWith(github.ref, 'refs/tags/nym-binaries-') && github.event_name == 'release' }}
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ defaults:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish-tauri:
|
publish-tauri:
|
||||||
if: ${{ (startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
|
if: ${{ startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release' }}
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ defaults:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish-tauri:
|
publish-tauri:
|
||||||
if: ${{ (startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release') || github.event_name == 'workflow_dispatch' }}
|
if: ${{ startsWith(github.ref, 'refs/tags/nym-wallet-') && github.event_name == 'release' }}
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
|
|||||||
@@ -1,29 +0,0 @@
|
|||||||
const Handlebars = require('handlebars');
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
|
|
||||||
async function addToContextAndValidate(context) {
|
|
||||||
if (!context.env.NYM_CI_WWW_LOCATION) {
|
|
||||||
throw new Error('Please ensure the env var NYM_CI_WWW_LOCATION is set');
|
|
||||||
}
|
|
||||||
if (!context.env.NYM_CI_WWW_BASE) {
|
|
||||||
throw new Error('Please ensure the env var NYM_CI_WWW_BASE is set');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function getMessageBody(context) {
|
|
||||||
const source = fs
|
|
||||||
.readFileSync(
|
|
||||||
context.env.IS_SUCCESS === 'true'
|
|
||||||
? path.resolve(__dirname, 'templates', 'success')
|
|
||||||
: path.resolve(__dirname, 'templates', 'failure'),
|
|
||||||
)
|
|
||||||
.toString();
|
|
||||||
const template = Handlebars.compile(source);
|
|
||||||
return template(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
addToContextAndValidate,
|
|
||||||
getMessageBody,
|
|
||||||
};
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
|
||||||
>
|
|
||||||
> 🔴 **FAILURE** :cry:
|
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
|
||||||
>
|
|
||||||
> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
|
|
||||||
>
|
|
||||||
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
|
||||||
>
|
|
||||||
|
|
||||||
Commit message:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{ env.GIT_COMMIT_MESSAGE }}
|
|
||||||
```
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }} ➡️➡️➡️➡️➡️ **View output:** https://{{ env.NYM_CI_WWW_BASE }}/developers/
|
|
||||||
>
|
|
||||||
> ✅ **SUCCESS**
|
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
|
||||||
>
|
|
||||||
> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
|
|
||||||
>
|
|
||||||
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
|
||||||
>
|
|
||||||
|
|
||||||
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{ env.GIT_COMMIT_MESSAGE }}
|
|
||||||
```
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
const Handlebars = require('handlebars');
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
|
|
||||||
async function addToContextAndValidate(context) {
|
|
||||||
if (!context.env.NYM_CI_WWW_LOCATION) {
|
|
||||||
throw new Error('Please ensure the env var NYM_CI_WWW_LOCATION is set');
|
|
||||||
}
|
|
||||||
if (!context.env.NYM_CI_WWW_BASE) {
|
|
||||||
throw new Error('Please ensure the env var NYM_CI_WWW_BASE is set');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function getMessageBody(context) {
|
|
||||||
const source = fs
|
|
||||||
.readFileSync(
|
|
||||||
context.env.IS_SUCCESS === 'true'
|
|
||||||
? path.resolve(__dirname, 'templates', 'success')
|
|
||||||
: path.resolve(__dirname, 'templates', 'failure'),
|
|
||||||
)
|
|
||||||
.toString();
|
|
||||||
const template = Handlebars.compile(source);
|
|
||||||
return template(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
addToContextAndValidate,
|
|
||||||
getMessageBody,
|
|
||||||
};
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
|
||||||
> 🔴 **FAILURE** :cry:
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
|
||||||
> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
|
|
||||||
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
|
||||||
|
|
||||||
Commit message:
|
|
||||||
```
|
|
||||||
{{ env.GIT_COMMIT_MESSAGE }}
|
|
||||||
```
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }} ➡️➡️➡️➡️➡️ **View output:** https://{{ env.NYM_CI_WWW_BASE }}/docs/
|
|
||||||
>
|
|
||||||
> ✅ **SUCCESS**
|
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
|
||||||
>
|
|
||||||
> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
|
|
||||||
>
|
|
||||||
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
|
||||||
>
|
|
||||||
|
|
||||||
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{ env.GIT_COMMIT_MESSAGE }}
|
|
||||||
```
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
const Handlebars = require('handlebars');
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
|
|
||||||
async function addToContextAndValidate(context) {
|
|
||||||
if (!context.env.NYM_CI_WWW_LOCATION) {
|
|
||||||
throw new Error('Please ensure the env var NYM_CI_WWW_LOCATION is set');
|
|
||||||
}
|
|
||||||
if (!context.env.NYM_CI_WWW_BASE) {
|
|
||||||
throw new Error('Please ensure the env var NYM_CI_WWW_BASE is set');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function getMessageBody(context) {
|
|
||||||
const source = fs
|
|
||||||
.readFileSync(
|
|
||||||
context.env.IS_SUCCESS === 'true'
|
|
||||||
? path.resolve(__dirname, 'templates', 'success')
|
|
||||||
: path.resolve(__dirname, 'templates', 'failure'),
|
|
||||||
)
|
|
||||||
.toString();
|
|
||||||
const template = Handlebars.compile(source);
|
|
||||||
return template(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
addToContextAndValidate,
|
|
||||||
getMessageBody,
|
|
||||||
};
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
|
||||||
>
|
|
||||||
> 🔴 **FAILURE** :cry:
|
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
|
||||||
>
|
|
||||||
> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
|
|
||||||
>
|
|
||||||
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
|
||||||
>
|
|
||||||
|
|
||||||
Commit message:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{ env.GIT_COMMIT_MESSAGE }}
|
|
||||||
```
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }} ➡️➡️➡️➡️➡️ **View output:** https://{{ env.NYM_CI_WWW_LOCATION }}.{{ env.NYM_CI_WWW_BASE }}/
|
|
||||||
>
|
|
||||||
> ✅ **SUCCESS**
|
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
|
||||||
>
|
|
||||||
> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
|
|
||||||
>
|
|
||||||
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
|
||||||
>
|
|
||||||
|
|
||||||
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{ env.GIT_COMMIT_MESSAGE }}
|
|
||||||
```
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
const Handlebars = require('handlebars');
|
|
||||||
const fs = require('fs');
|
|
||||||
const path = require('path');
|
|
||||||
|
|
||||||
async function addToContextAndValidate(context) {
|
|
||||||
if (!context.env.NYM_CI_WWW_LOCATION) {
|
|
||||||
throw new Error('Please ensure the env var NYM_CI_WWW_LOCATION is set');
|
|
||||||
}
|
|
||||||
if (!context.env.NYM_CI_WWW_BASE) {
|
|
||||||
throw new Error('Please ensure the env var NYM_CI_WWW_BASE is set');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function getMessageBody(context) {
|
|
||||||
const source = fs
|
|
||||||
.readFileSync(
|
|
||||||
context.env.IS_SUCCESS === 'true'
|
|
||||||
? path.resolve(__dirname, 'templates', 'success')
|
|
||||||
: path.resolve(__dirname, 'templates', 'failure'),
|
|
||||||
)
|
|
||||||
.toString();
|
|
||||||
const template = Handlebars.compile(source);
|
|
||||||
return template(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
addToContextAndValidate,
|
|
||||||
getMessageBody,
|
|
||||||
};
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
|
||||||
>
|
|
||||||
> 🔴 **FAILURE** :cry:
|
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
|
||||||
>
|
|
||||||
> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
|
|
||||||
>
|
|
||||||
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
|
||||||
>
|
|
||||||
|
|
||||||
Commit message:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{ env.GIT_COMMIT_MESSAGE }}
|
|
||||||
```
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }} ➡️➡️➡️➡️➡️ **View output:** https://{{ env.NYM_CI_WWW_LOCATION }}.{{ env.NYM_CI_WWW_BASE }}/
|
|
||||||
>
|
|
||||||
> ✅ **SUCCESS**
|
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
|
||||||
>
|
|
||||||
> `commit` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/commit/{{ env.GITHUB_SHA }}
|
|
||||||
>
|
|
||||||
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
|
||||||
>
|
|
||||||
|
|
||||||
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{ env.GIT_COMMIT_MESSAGE }}
|
|
||||||
```
|
|
||||||
@@ -1,14 +1,9 @@
|
|||||||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
||||||
>
|
|
||||||
> 🔴 **FAILURE** :cry:
|
> 🔴 **FAILURE** :cry:
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
Commit message:
|
Commit message:
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,16 +1,10 @@
|
|||||||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }} ➡️➡️➡️➡️➡️ **View output:** https://{{ env.NYM_CI_WWW_LOCATION }}.{{ env.NYM_CI_WWW_BASE }}/
|
> :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 }}
|
> `storybook`: https://{{ env.NYM_CI_WWW_LOCATION_STORYBOOK }}.{{ env.NYM_CI_WWW_BASE }}
|
||||||
>
|
|
||||||
> ✅ **SUCCESS**
|
> ✅ **SUCCESS**
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ async function getMessageBody(context) {
|
|||||||
return `${icon} ${job.conclusion}: ${job.name} - ${job.html_url}`;
|
return `${icon} ${job.conclusion}: ${job.name} - ${job.html_url}`;
|
||||||
})
|
})
|
||||||
// and join with newlines for display in the template
|
// and join with newlines for display in the template
|
||||||
.join('\n\n');
|
.join('\n');
|
||||||
|
|
||||||
return template({ ...context, jobResults });
|
return template({ ...context, jobResults });
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,15 +1,9 @@
|
|||||||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
||||||
>
|
|
||||||
> 🔴 **FAILURE** :cry:
|
> 🔴 **FAILURE** :cry:
|
||||||
>
|
|
||||||
> `when` {{ timestamp }}
|
> `when` {{ timestamp }}
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
{{ jobResults }}
|
{{ jobResults }}
|
||||||
|
|||||||
@@ -1,15 +1,9 @@
|
|||||||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
||||||
>
|
|
||||||
> ✅ **SUCCESS**
|
> ✅ **SUCCESS**
|
||||||
>
|
|
||||||
> `when` {{ timestamp }}
|
> `when` {{ timestamp }}
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
{{ jobResults }}
|
{{ jobResults }}
|
||||||
@@ -3,7 +3,7 @@ require('dotenv').config();
|
|||||||
const { sendMatrixMessage } = require('./send_message_to_matrix');
|
const { sendMatrixMessage } = require('./send_message_to_matrix');
|
||||||
|
|
||||||
let context = {
|
let context = {
|
||||||
kinds: ['nym-wallet', 'ts-packages', 'network-explorer', 'nightly', 'nym-connect','security','ci-docs','cd-docs','ci-dev','cd-dev'],
|
kinds: ['nym-wallet', 'ts-packages', 'network-explorer', 'nightly', 'nym-connect','security'],
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ const localStorage = new LocalStorage('./scratch');
|
|||||||
const {
|
const {
|
||||||
LocalStorageCryptoStore,
|
LocalStorageCryptoStore,
|
||||||
} = require('matrix-js-sdk/lib/crypto/store/localStorage-crypto-store');
|
} = require('matrix-js-sdk/lib/crypto/store/localStorage-crypto-store');
|
||||||
var showdown = require('showdown');
|
|
||||||
|
|
||||||
// hide all matrix client output
|
// hide all matrix client output
|
||||||
console.error = (error) => console.log('❌ error: ', error);
|
console.error = (error) => console.log('❌ error: ', error);
|
||||||
@@ -55,9 +54,7 @@ function createClient(context, room, message) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async function sendMatrixMessage(contextArg, messageAsMarkdown, roomId) {
|
async function sendMatrixMessage(contextArg, messageAsMarkdown, roomId) {
|
||||||
const converter = new showdown.Converter();
|
const client = createClient(contextArg, roomId, messageAsMarkdown);
|
||||||
const messageAsHtml = converter.makeHtml(messageAsMarkdown);
|
|
||||||
const client = createClient(contextArg, roomId, messageAsHtml);
|
|
||||||
await client.initCrypto();
|
await client.initCrypto();
|
||||||
await client.startClient({ initialSyncLimit: 1 });
|
await client.startClient({ initialSyncLimit: 1 });
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,14 +1,9 @@
|
|||||||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
||||||
>
|
|
||||||
> 🔴 **FAILURE** :cry:
|
> 🔴 **FAILURE** :cry:
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
Commit message:
|
Commit message:
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,14 +1,9 @@
|
|||||||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }} ➡️➡️➡️➡️➡️ **View storybook:** https://{{ env.NYM_CI_WWW_LOCATION }}.{{ env.NYM_CI_WWW_BASE }}/
|
> :rocket: {{ env.NYM_PROJECT_NAME }} ➡️➡️➡️➡️➡️ **View storybook:** https://{{ env.NYM_CI_WWW_LOCATION }}.{{ env.NYM_CI_WWW_BASE }}/
|
||||||
>
|
|
||||||
> ✅ **SUCCESS**
|
> ✅ **SUCCESS**
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,14 +1,9 @@
|
|||||||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
||||||
>
|
|
||||||
> 🔴 **FAILURE** :cry:
|
> 🔴 **FAILURE** :cry:
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
Commit message:
|
Commit message:
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,18 +1,13 @@
|
|||||||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
||||||
>
|
|
||||||
> ✅ **SUCCESS**
|
> ✅ **SUCCESS**
|
||||||
>
|
|
||||||
> ➡️➡️➡️➡️➡️ **View output:**
|
> ➡️➡️➡️➡️➡️ **View output:**
|
||||||
>
|
|
||||||
> `storybook`: https://{{ env.NYM_CI_WWW_LOCATION }}.{{ env.NYM_CI_WWW_BASE }}
|
> `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 }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -17,11 +17,10 @@
|
|||||||
"remark-emoji": "^2.2.0",
|
"remark-emoji": "^2.2.0",
|
||||||
"remark-html": "^13.0.2",
|
"remark-html": "^13.0.2",
|
||||||
"remark-parse": "^9.0.0",
|
"remark-parse": "^9.0.0",
|
||||||
"showdown": "^2.1.0",
|
|
||||||
"to-vfile": "^6.1.0",
|
"to-vfile": "^6.1.0",
|
||||||
"unified": "^9.2.2"
|
"unified": "^9.2.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"prettier": "^2.8.7"
|
"prettier": "2.3.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,14 +1,9 @@
|
|||||||
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
||||||
>
|
|
||||||
> 🔴 **FAILURE** :cry:
|
> 🔴 **FAILURE** :cry:
|
||||||
>
|
|
||||||
> `branch` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/tree/{{ env.GIT_BRANCH_NAME }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
Commit message:
|
Commit message:
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,20 +1,14 @@
|
|||||||
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩
|
||||||
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
> :rocket: {{ env.NYM_PROJECT_NAME }}
|
||||||
>
|
|
||||||
> ✅ **SUCCESS**
|
> ✅ **SUCCESS**
|
||||||
>
|
|
||||||
> ➡️➡️➡️➡️➡️ **View output:**
|
> ➡️➡️➡️➡️➡️ **View output:**
|
||||||
>
|
|
||||||
> `storybook`: https://{{ env.NYM_CI_WWW_LOCATION }}.{{ env.NYM_CI_WWW_BASE }}
|
> `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 }}
|
> `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 }}
|
> `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 }}
|
> `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 }}
|
> `build ` {{ env.GITHUB_SERVER_URL }}/{{ env.GITHUB_REPOSITORY }}/actions/runs/{{ env.GITHUB_RUN_ID }}
|
||||||
>
|
|
||||||
|
|
||||||
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
Commit message by `{{ env.GITHUB_ACTOR }}` at {{ timestamp }}:
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -64,4 +64,4 @@ jobs:
|
|||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: clippy
|
command: clippy
|
||||||
args: --manifest-path nym-wallet/Cargo.toml --workspace --all-features --all-targets -- -D warnings
|
args: --manifest-path nym-wallet/Cargo.toml --workspace --all-features -- -D warnings
|
||||||
|
|||||||
+2
-1
@@ -39,6 +39,7 @@ validator-api-config.toml
|
|||||||
dist
|
dist
|
||||||
storybook-static
|
storybook-static
|
||||||
envs/qwerty.env
|
envs/qwerty.env
|
||||||
|
Cargo.lock
|
||||||
|
nym-connect/Cargo.lock
|
||||||
.parcel-cache
|
.parcel-cache
|
||||||
**/.DS_Store
|
**/.DS_Store
|
||||||
cpu-cycles/libcpucycles/build
|
|
||||||
-100
@@ -4,106 +4,6 @@ Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
- nym-network-statistics properly handles signals ([#3209])
|
|
||||||
- add socks5 support for Rust SDK ([#3226], [#3255])
|
|
||||||
- add coconut bandwidth credential support for Rust SDK ([#3273])
|
|
||||||
|
|
||||||
[#3209]: https://github.com/nymtech/nym/issues/3209
|
|
||||||
[#3226]: https://github.com/nymtech/nym/pull/3226
|
|
||||||
[#3255]: https://github.com/nymtech/nym/pull/3255
|
|
||||||
[#3273]: https://github.com/nymtech/nym/pull/3273
|
|
||||||
|
|
||||||
## [v1.1.15] (2023-04-18)
|
|
||||||
|
|
||||||
- Fix verloc being stuck waiting for shutdown signal ([#3250])
|
|
||||||
- Introduce `--output json` flag to `sign` command to allow to more easily capture the output ([#3249])
|
|
||||||
- Explorer - Dont fetch Service Provider list on Testnet ([#3245])
|
|
||||||
- When determining active set, rather than weighting the nodes by just the `stake`, use `stake * performance` ([#3234])
|
|
||||||
- Introduce dual packet sizes to our clients (as in use two packet sizes at the same time depending on message size) ([#3189])
|
|
||||||
- Experiment with offline signing in our validator client ([#3174])
|
|
||||||
- Modify network requester binary to reload `allowed.list` periodically to pull in any changes made upstream without having to restart the service ([#3149])
|
|
||||||
- Standardise all `--output json` on binary inits, we pass the output json at different points for different binaries. ([#3080])
|
|
||||||
- Service provider directory contract: initial version ([#2759])
|
|
||||||
- Fix issue where network-requester run failed on fresh init due to missing allow file ([#3316])
|
|
||||||
|
|
||||||
[#3250]: https://github.com/nymtech/nym/issues/3250
|
|
||||||
[#3249]: https://github.com/nymtech/nym/issues/3249
|
|
||||||
[#3245]: https://github.com/nymtech/nym/issues/3245
|
|
||||||
[#3234]: https://github.com/nymtech/nym/issues/3234
|
|
||||||
[#3189]: https://github.com/nymtech/nym/issues/3189
|
|
||||||
[#3174]: https://github.com/nymtech/nym/issues/3174
|
|
||||||
[#3149]: https://github.com/nymtech/nym/issues/3149
|
|
||||||
[#3080]: https://github.com/nymtech/nym/issues/3080
|
|
||||||
[#2759]: https://github.com/nymtech/nym/issues/2759
|
|
||||||
[#3316]: https://github.com/nymtech/nym/pull/3316
|
|
||||||
|
|
||||||
## [v1.1.14] (2023-04-04)
|
|
||||||
|
|
||||||
- Investigate cause of qwerty validator being in invalid rewarding state ([#3224])
|
|
||||||
- Fix NR config due to changes in #3199 ([#3223])
|
|
||||||
- [Issue] Mixnodes and gateway do not close connections properly ([#3187])
|
|
||||||
- disable sign-ext when using wasm-opt + update wasm-opt ([#3203])
|
|
||||||
- chore: tidy up client `Debug` config section ([#3199])
|
|
||||||
|
|
||||||
[#3224]: https://github.com/nymtech/nym/issues/3224
|
|
||||||
[#3223]: https://github.com/nymtech/nym/issues/3223
|
|
||||||
[#3187]: https://github.com/nymtech/nym/issues/3187
|
|
||||||
[#3203]: https://github.com/nymtech/nym/pull/3203
|
|
||||||
[#3199]: https://github.com/nymtech/nym/pull/3199
|
|
||||||
>>>>>>> master
|
|
||||||
|
|
||||||
## [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])
|
|
||||||
- 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
|
|
||||||
[#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)
|
## [v1.1.10] (2023-02-21)
|
||||||
|
|
||||||
- Verloc listener causing mixnode unexpected shutdown ([#3038])
|
- Verloc listener causing mixnode unexpected shutdown ([#3038])
|
||||||
|
|||||||
Generated
+1116
-1231
File diff suppressed because it is too large
Load Diff
+6
-19
@@ -17,14 +17,13 @@ opt-level = 3
|
|||||||
|
|
||||||
resolver = "2"
|
resolver = "2"
|
||||||
members = [
|
members = [
|
||||||
|
"clients/client-core",
|
||||||
"clients/credential",
|
"clients/credential",
|
||||||
"clients/native",
|
"clients/native",
|
||||||
"clients/native/websocket-requests",
|
"clients/native/websocket-requests",
|
||||||
"clients/socks5",
|
"clients/socks5",
|
||||||
"common/async-file-watcher",
|
"common/bandwidth-claim-contract",
|
||||||
"common/bandwidth-controller",
|
|
||||||
"common/bin-common",
|
"common/bin-common",
|
||||||
"common/client-core",
|
|
||||||
"common/client-libs/gateway-client",
|
"common/client-libs/gateway-client",
|
||||||
"common/client-libs/mixnet-client",
|
"common/client-libs/mixnet-client",
|
||||||
"common/client-libs/validator-client",
|
"common/client-libs/validator-client",
|
||||||
@@ -37,8 +36,8 @@ members = [
|
|||||||
"common/cosmwasm-smart-contracts/group-contract",
|
"common/cosmwasm-smart-contracts/group-contract",
|
||||||
"common/cosmwasm-smart-contracts/mixnet-contract",
|
"common/cosmwasm-smart-contracts/mixnet-contract",
|
||||||
"common/cosmwasm-smart-contracts/multisig-contract",
|
"common/cosmwasm-smart-contracts/multisig-contract",
|
||||||
"common/cosmwasm-smart-contracts/service-provider-directory",
|
|
||||||
"common/cosmwasm-smart-contracts/vesting-contract",
|
"common/cosmwasm-smart-contracts/vesting-contract",
|
||||||
|
"common/mobile-storage",
|
||||||
"common/credential-storage",
|
"common/credential-storage",
|
||||||
"common/credentials",
|
"common/credentials",
|
||||||
"common/crypto",
|
"common/crypto",
|
||||||
@@ -61,7 +60,6 @@ members = [
|
|||||||
"common/nymsphinx/params",
|
"common/nymsphinx/params",
|
||||||
"common/nymsphinx/types",
|
"common/nymsphinx/types",
|
||||||
"common/pemstore",
|
"common/pemstore",
|
||||||
"common/socks5-client-core",
|
|
||||||
"common/socks5/proxy-helpers",
|
"common/socks5/proxy-helpers",
|
||||||
"common/socks5/requests",
|
"common/socks5/requests",
|
||||||
"common/statistics",
|
"common/statistics",
|
||||||
@@ -96,7 +94,7 @@ default-members = [
|
|||||||
"explorer-api",
|
"explorer-api",
|
||||||
]
|
]
|
||||||
|
|
||||||
exclude = ["explorer", "contracts", "clients/webassembly", "nym-wallet", "nym-connect/mobile/src-tauri", "nym-connect/desktop", "cpu-cycles"]
|
exclude = ["explorer", "contracts", "clients/webassembly", "nym-wallet", "nym-connect/mobile/src-tauri", "nym-connect/desktop"]
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
authors = ["Nym Technologies SA"]
|
authors = ["Nym Technologies SA"]
|
||||||
@@ -107,20 +105,9 @@ edition = "2021"
|
|||||||
license = "Apache-2.0"
|
license = "Apache-2.0"
|
||||||
|
|
||||||
[workspace.dependencies]
|
[workspace.dependencies]
|
||||||
async-trait = "0.1.64"
|
async-trait = "0.1.63"
|
||||||
bip39 = { version = "2.0.0", features = ["zeroize"] }
|
|
||||||
cfg-if = "1.0.0"
|
cfg-if = "1.0.0"
|
||||||
cosmwasm-derive = "=1.0.0"
|
dotenv = "0.15.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"
|
lazy_static = "1.4.0"
|
||||||
log = "0.4"
|
log = "0.4"
|
||||||
once_cell = "1.7.2"
|
once_cell = "1.7.2"
|
||||||
|
|||||||
@@ -1,116 +1,132 @@
|
|||||||
# Default target
|
|
||||||
all: test
|
|
||||||
|
|
||||||
test: clippy-all cargo-test wasm fmt
|
test: clippy-all cargo-test wasm fmt
|
||||||
|
|
||||||
test-all: test cargo-test-expensive
|
test-all: test cargo-test-expensive
|
||||||
|
|
||||||
no-clippy: build cargo-test wasm fmt
|
no-clippy: build cargo-test wasm fmt
|
||||||
|
|
||||||
happy: fmt clippy-happy test
|
happy: fmt clippy-happy test
|
||||||
|
clippy-all: clippy-main clippy-main-examples clippy-all-contracts clippy-all-wallet clippy-all-connect clippy-all-connect-mobile clippy-all-wasm-client
|
||||||
|
clippy-happy: clippy-happy-main clippy-happy-contracts clippy-happy-wallet clippy-happy-connect clippy-happy-connect-mobile
|
||||||
|
cargo-test: test-main test-contracts test-wallet test-connect test-connect-mobile
|
||||||
|
cargo-test-expensive: test-main-expensive test-contracts-expensive test-wallet-expensive test-connect-expensive
|
||||||
|
build: build-contracts build-wallet build-main build-main-examples build-connect build-connect-mobile build-wasm-client
|
||||||
|
fmt: fmt-main fmt-contracts fmt-wallet fmt-connect fmt-connect-mobile fmt-wasm-client
|
||||||
|
|
||||||
# Building release binaries is a little manual as we can't just build --release
|
clippy-happy-main:
|
||||||
# on all workspaces.
|
cargo clippy
|
||||||
build-release: build-release-main wasm
|
|
||||||
|
|
||||||
# -----------------------------------------------------------------------------
|
clippy-happy-contracts:
|
||||||
# Define targets for a given workspace
|
cargo clippy --manifest-path contracts/Cargo.toml --target wasm32-unknown-unknown
|
||||||
# $(1): name
|
|
||||||
# $(2): path to workspace
|
|
||||||
# $(3): extra arguments to cargo
|
|
||||||
# -----------------------------------------------------------------------------
|
|
||||||
define add_cargo_workspace
|
|
||||||
|
|
||||||
clippy-happy-$(1):
|
clippy-happy-wallet:
|
||||||
cargo clippy --manifest-path $(2)/Cargo.toml $(3)
|
cargo clippy --manifest-path nym-wallet/Cargo.toml
|
||||||
|
|
||||||
clippy-$(1):
|
clippy-happy-connect:
|
||||||
cargo clippy --manifest-path $(2)/Cargo.toml --workspace $(3) -- -D warnings
|
cargo clippy --manifest-path nym-connect/desktop/Cargo.toml
|
||||||
|
|
||||||
clippy-examples-$(1):
|
clippy-happy-connect-mobile:
|
||||||
cargo clippy --manifest-path $(2)/Cargo.toml --workspace --examples -- -D warnings
|
cargo clippy --manifest-path nym-connect/mobile/src-tauri/Cargo.toml
|
||||||
|
|
||||||
check-$(1):
|
clippy-main:
|
||||||
cargo check --manifest-path $(2)/Cargo.toml --workspace $(3)
|
cargo clippy --workspace -- -D warnings
|
||||||
|
|
||||||
test-$(1):
|
clippy-main-examples:
|
||||||
cargo test --manifest-path $(2)/Cargo.toml --workspace
|
cargo clippy --workspace --examples -- -D warnings
|
||||||
|
|
||||||
test-expensive-$(1):
|
clippy-wasm:
|
||||||
cargo test --manifest-path $(2)/Cargo.toml --workspace -- --ignored
|
cargo clippy --manifest-path clients/webassembly/Cargo.toml --target wasm32-unknown-unknown --workspace -- -D warnings
|
||||||
|
|
||||||
build-$(1):
|
|
||||||
cargo build --manifest-path $(2)/Cargo.toml --workspace $(3)
|
|
||||||
|
|
||||||
build-examples-$(1):
|
clippy-all-contracts:
|
||||||
cargo build --manifest-path $(2)/Cargo.toml --workspace --examples
|
cargo clippy --workspace --manifest-path contracts/Cargo.toml --all-features --target wasm32-unknown-unknown -- -D warnings
|
||||||
|
|
||||||
build-release-$(1):
|
clippy-all-wallet:
|
||||||
cargo build --manifest-path $(2)/Cargo.toml --workspace --release $(3)
|
cargo clippy --workspace --manifest-path nym-wallet/Cargo.toml --all-features -- -D warnings
|
||||||
|
|
||||||
fmt-$(1):
|
clippy-all-connect:
|
||||||
cargo fmt --manifest-path $(2)/Cargo.toml --all
|
cargo clippy --workspace --manifest-path nym-connect/desktop/Cargo.toml --all-features -- -D warnings
|
||||||
|
|
||||||
clippy-happy: clippy-happy-$(1)
|
clippy-all-connect-mobile:
|
||||||
clippy-all: clippy-$(1) clippy-examples-$(1)
|
cargo clippy --workspace --manifest-path nym-connect/mobile/src-tauri/Cargo.toml --all-features -- -D warnings
|
||||||
check: check-$(1)
|
|
||||||
cargo-test: test-$(1)
|
|
||||||
cargo-test-expensive: test-expensive-$(1)
|
|
||||||
build: build-$(1) build-$(1)-examples
|
|
||||||
build-release-all: build-release-$(1)
|
|
||||||
fmt: fmt-$(1)
|
|
||||||
|
|
||||||
endef
|
clippy-all-wasm-client:
|
||||||
|
cargo clippy --workspace --manifest-path clients/webassembly/Cargo.toml --all-features --target wasm32-unknown-unknown -- -D warnings
|
||||||
|
|
||||||
# -----------------------------------------------------------------------------
|
test-main:
|
||||||
# Rust workspaces
|
cargo test --workspace
|
||||||
# -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
# Generate targets for the various cargo workspaces
|
test-main-expensive:
|
||||||
|
cargo test --workspace -- --ignored
|
||||||
|
|
||||||
$(eval $(call add_cargo_workspace,main,.))
|
test-contracts:
|
||||||
$(eval $(call add_cargo_workspace,contracts,contracts,--target wasm32-unknown-unknown))
|
cargo test --manifest-path contracts/Cargo.toml --all-features
|
||||||
$(eval $(call add_cargo_workspace,wasm-client,clients/webassembly,--target wasm32-unknown-unknown))
|
|
||||||
$(eval $(call add_cargo_workspace,wallet,nym-wallet,))
|
|
||||||
$(eval $(call add_cargo_workspace,connect,nym-connect/desktop))
|
|
||||||
ifdef NYM_MOBILE
|
|
||||||
$(eval $(call add_cargo_workspace,connect-mobile,nym-connect/mobile/src-tauri))
|
|
||||||
endif
|
|
||||||
|
|
||||||
# -----------------------------------------------------------------------------
|
test-contracts-expensive:
|
||||||
# Convenience targets for crates that are already part of the main workspace
|
cargo test --manifest-path contracts/Cargo.toml --all-features -- --ignored
|
||||||
# -----------------------------------------------------------------------------
|
|
||||||
|
test-wallet:
|
||||||
|
cargo test --manifest-path nym-wallet/Cargo.toml --all-features
|
||||||
|
|
||||||
|
test-wallet-expensive:
|
||||||
|
cargo test --manifest-path nym-wallet/Cargo.toml --all-features -- --ignored
|
||||||
|
|
||||||
|
test-connect:
|
||||||
|
cargo test --manifest-path nym-connect/desktop/Cargo.toml --all-features
|
||||||
|
|
||||||
|
test-connect-expensive:
|
||||||
|
cargo test --manifest-path nym-connect/desktop/Cargo.toml --all-features -- --ignored
|
||||||
|
|
||||||
|
test-connect-mobile:
|
||||||
|
cargo test --manifest-path nym-connect/mobile/src-tauri/Cargo.toml --all-features
|
||||||
|
|
||||||
|
test-connect-mobile-expensive:
|
||||||
|
cargo test --manifest-path nym-connect/mobile/src-tauri/Cargo.toml --all-features -- --ignored
|
||||||
|
|
||||||
|
build-main:
|
||||||
|
cargo build --workspace
|
||||||
|
|
||||||
|
build-main-examples:
|
||||||
|
cargo build --workspace --examples
|
||||||
|
|
||||||
|
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/desktop/Cargo.toml --workspace
|
||||||
|
|
||||||
|
build-connect-mobile:
|
||||||
|
cargo build --manifest-path nym-connect/mobile/src-tauri/Cargo.toml --workspace
|
||||||
|
|
||||||
build-explorer-api:
|
build-explorer-api:
|
||||||
cargo build -p explorer-api
|
cargo build --manifest-path explorer-api/Cargo.toml --workspace
|
||||||
|
|
||||||
|
build-wasm-client:
|
||||||
|
cargo build --manifest-path clients/webassembly/Cargo.toml --workspace --target wasm32-unknown-unknown
|
||||||
|
|
||||||
build-nym-cli:
|
build-nym-cli:
|
||||||
cargo build -p nym-cli --release
|
cargo build --release --manifest-path tools/nym-cli/Cargo.toml
|
||||||
|
|
||||||
# -----------------------------------------------------------------------------
|
fmt-main:
|
||||||
# Build contracts ready for deploy
|
cargo fmt --all
|
||||||
# -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
CONTRACTS_OUT_DIR=contracts/target/wasm32-unknown-unknown/release
|
fmt-contracts:
|
||||||
VESTING_CONTRACT=$(CONTRACTS_OUT_DIR)/vesting_contract.wasm
|
cargo fmt --manifest-path contracts/Cargo.toml --all
|
||||||
MIXNET_CONTRACT=$(CONTRACTS_OUT_DIR)/mixnet_contract.wasm
|
|
||||||
SERVICE_PROVIDER_DIRECTORY_CONTRACT=$(CONTRACTS_OUT_DIR)/nym_service_provider_directory.wasm
|
|
||||||
|
|
||||||
wasm: wasm-build wasm-opt
|
fmt-wallet:
|
||||||
|
cargo fmt --manifest-path nym-wallet/Cargo.toml --all
|
||||||
|
|
||||||
wasm-build:
|
fmt-connect:
|
||||||
|
cargo fmt --manifest-path nym-connect/desktop/Cargo.toml --all
|
||||||
|
|
||||||
|
fmt-connect-mobile:
|
||||||
|
cargo fmt --manifest-path nym-connect/mobile/src-tauri/Cargo.toml --all
|
||||||
|
|
||||||
|
fmt-wasm-client:
|
||||||
|
cargo fmt --manifest-path clients/webassembly/Cargo.toml --all
|
||||||
|
|
||||||
|
wasm:
|
||||||
RUSTFLAGS='-C link-arg=-s' cargo build --manifest-path contracts/Cargo.toml --release --target wasm32-unknown-unknown
|
RUSTFLAGS='-C link-arg=-s' cargo build --manifest-path contracts/Cargo.toml --release --target wasm32-unknown-unknown
|
||||||
|
|
||||||
wasm-opt:
|
|
||||||
wasm-opt --disable-sign-ext -Os $(VESTING_CONTRACT) -o $(VESTING_CONTRACT)
|
|
||||||
wasm-opt --disable-sign-ext -Os $(MIXNET_CONTRACT) -o $(MIXNET_CONTRACT)
|
|
||||||
wasm-opt --disable-sign-ext -Os $(SERVICE_PROVIDER_DIRECTORY_CONTRACT) -o $(SERVICE_PROVIDER_DIRECTORY_CONTRACT)
|
|
||||||
|
|
||||||
# -----------------------------------------------------------------------------
|
|
||||||
# Misc
|
|
||||||
# -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
# NOTE: this seems deprecated an not needed anymore?
|
|
||||||
mixnet-opt: wasm
|
mixnet-opt: wasm
|
||||||
cd contracts/mixnet && make opt
|
cd contracts/mixnet && make opt
|
||||||
|
|
||||||
|
|||||||
@@ -16,12 +16,12 @@ 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.
|
* nym-wallet - a desktop wallet implemented using the [Tauri](https://tauri.studio/en/docs/about/intro) framework.
|
||||||
|
|
||||||
[](https://opensource.org/licenses/Apache-2.0)
|
[](https://opensource.org/licenses/Apache-2.0)
|
||||||
[](https://github.com/nymtech/nym/actions?query=branch%3Adevelop)
|
[](https://github.com/nymtech/nym/actions?query=branch%3Adevelop)
|
||||||
|
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
|
|
||||||
Platform build instructions are available on [our docs site](https://nymtech.net/docs/binaries/building-nym.html).
|
Platform build instructions are available on [our docs site](https://nymtech.net/docs/stable/run-nym-nodes/build-nym).
|
||||||
Wallet build instructions are also available on [our docs site](https://nymtech.net/docs/stable/nym-apps/wallet#for-developers).
|
Wallet build instructions are also available on [our docs site](https://nymtech.net/docs/stable/nym-apps/wallet#for-developers).
|
||||||
|
|
||||||
### Developing
|
### Developing
|
||||||
|
|||||||
+3
-3
@@ -3,8 +3,8 @@ Critical bug or security issue 💥
|
|||||||
If you're here because you're trying to figure out how to notify us of a security issue, go to Discord, and alert the core engineers:
|
If you're here because you're trying to figure out how to notify us of a security issue, go to Discord, and alert the core engineers:
|
||||||
|
|
||||||
Dave Hrycyszyn futurechimp#5430
|
Dave Hrycyszyn futurechimp#5430
|
||||||
|
Drazen Urch drazen#4873
|
||||||
Jedrzej Stuczynski "Jedrzej | Nym#5666"
|
Jedrzej Stuczynski "Jedrzej | Nym#5666"
|
||||||
Fran Arbanas | franarbanas#0995
|
|
||||||
Mark Sinclair | marknym#8088
|
|
||||||
|
|
||||||
Please avoid opening public issues on GitHub that contain information about a potential security vulnerability as this makes it difficult to reduce the impact and harm of valid security issues.
|
|
||||||
|
Please avoid opening public issues on GitHub that contain information about a potential security vulnerability as this makes it difficult to reduce the impact and harm of valid security issues.
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "nym-client-core"
|
name = "client-core"
|
||||||
version = "1.1.14"
|
version = "1.1.10"
|
||||||
authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
|
authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
rust-version = "1.66"
|
rust-version = "1.66"
|
||||||
@@ -8,15 +8,15 @@ rust-version = "1.66"
|
|||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
async-trait = { workspace = true }
|
async-trait = { version = "0.1.58" }
|
||||||
dirs = "4.0"
|
dirs = "4.0"
|
||||||
dashmap = "5.4.0"
|
dashmap = "5.4.0"
|
||||||
futures = "0.3"
|
futures = "0.3"
|
||||||
humantime-serde = "1.0"
|
humantime-serde = "1.0"
|
||||||
log = { workspace = true }
|
log = { workspace = true }
|
||||||
rand = { version = "0.7.3", features = ["wasm-bindgen"] }
|
rand = { version = "0.7.3", features = ["wasm-bindgen"] }
|
||||||
serde = { workspace = true, features = ["derive"] }
|
serde = { version = "1.0", features = ["derive"] }
|
||||||
serde_json = { workspace = true }
|
serde_json = "1.0.89"
|
||||||
tap = "1.0.1"
|
tap = "1.0.1"
|
||||||
thiserror = "1.0.34"
|
thiserror = "1.0.34"
|
||||||
url = { version ="2.2", features = ["serde"] }
|
url = { version ="2.2", features = ["serde"] }
|
||||||
@@ -25,23 +25,17 @@ tokio = { version = "1.24.1", features = ["macros"]}
|
|||||||
time = "0.3.17"
|
time = "0.3.17"
|
||||||
|
|
||||||
# internal
|
# internal
|
||||||
nym-bandwidth-controller = { path = "../bandwidth-controller" }
|
nym-config = { path = "../../common/config" }
|
||||||
nym-config = { path = "../config" }
|
nym-crypto = { path = "../../common/crypto" }
|
||||||
nym-crypto = { path = "../crypto" }
|
gateway-client = { path = "../../common/client-libs/gateway-client" }
|
||||||
nym-gateway-client = { path = "../client-libs/gateway-client" }
|
|
||||||
#gateway-client = { path = "../../common/client-libs/gateway-client", default-features = false, features = ["wasm", "coconut"] }
|
#gateway-client = { path = "../../common/client-libs/gateway-client", default-features = false, features = ["wasm", "coconut"] }
|
||||||
nym-gateway-requests = { path = "../../gateway/gateway-requests" }
|
gateway-requests = { path = "../../gateway/gateway-requests" }
|
||||||
nym-nonexhaustive-delayqueue = { path = "../nonexhaustive-delayqueue" }
|
nym-nonexhaustive-delayqueue = { path = "../../common/nonexhaustive-delayqueue" }
|
||||||
nym-sphinx = { path = "../nymsphinx" }
|
nym-sphinx = { path = "../../common/nymsphinx" }
|
||||||
nym-pemstore = { path = "../pemstore" }
|
nym-pemstore = { path = "../../common/pemstore" }
|
||||||
nym-topology = { path = "../topology" }
|
nym-topology = { path = "../../common/topology" }
|
||||||
nym-validator-client = { path = "../client-libs/validator-client", default-features = false }
|
validator-client = { path = "../../common/client-libs/validator-client", default-features = false }
|
||||||
nym-task = { path = "../task" }
|
nym-task = { path = "../../common/task" }
|
||||||
nym-credential-storage = { path = "../credential-storage" }
|
|
||||||
|
|
||||||
[target."cfg(not(target_arch = \"wasm32\"))".dependencies.nym-validator-client]
|
|
||||||
path = "../client-libs/validator-client"
|
|
||||||
features = ["nyxd-client"]
|
|
||||||
|
|
||||||
[target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio-stream]
|
[target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio-stream]
|
||||||
version = "0.1.11"
|
version = "0.1.11"
|
||||||
@@ -74,7 +68,7 @@ version = "0.2.4"
|
|||||||
features = ["futures"]
|
features = ["futures"]
|
||||||
|
|
||||||
[target."cfg(target_arch = \"wasm32\")".dependencies.wasm-utils]
|
[target."cfg(target_arch = \"wasm32\")".dependencies.wasm-utils]
|
||||||
path = "../wasm-utils"
|
path = "../../common/wasm-utils"
|
||||||
features = ["websocket"]
|
features = ["websocket"]
|
||||||
|
|
||||||
[target."cfg(target_arch = \"wasm32\")".dependencies.time]
|
[target."cfg(target_arch = \"wasm32\")".dependencies.time]
|
||||||
@@ -91,5 +85,5 @@ sqlx = { version = "0.6.2", features = ["runtime-tokio-rustls", "sqlite", "macro
|
|||||||
[features]
|
[features]
|
||||||
default = []
|
default = []
|
||||||
fs-surb-storage = ["sqlx"]
|
fs-surb-storage = ["sqlx"]
|
||||||
wasm = ["nym-gateway-client/wasm"]
|
wasm = ["gateway-client/wasm"]
|
||||||
|
|
||||||
+2
-6
@@ -5,11 +5,7 @@ use crate::{client::replies::reply_storage, config::DebugConfig};
|
|||||||
|
|
||||||
pub fn setup_empty_reply_surb_backend(debug_config: &DebugConfig) -> reply_storage::Empty {
|
pub fn setup_empty_reply_surb_backend(debug_config: &DebugConfig) -> reply_storage::Empty {
|
||||||
reply_storage::Empty {
|
reply_storage::Empty {
|
||||||
min_surb_threshold: debug_config
|
min_surb_threshold: debug_config.minimum_reply_surb_storage_threshold,
|
||||||
.reply_surbs
|
max_surb_threshold: debug_config.maximum_reply_surb_storage_threshold,
|
||||||
.minimum_reply_surb_storage_threshold,
|
|
||||||
max_surb_threshold: debug_config
|
|
||||||
.reply_surbs
|
|
||||||
.maximum_reply_surb_storage_threshold,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+56
-86
@@ -1,7 +1,6 @@
|
|||||||
// Copyright 2022-2023 - Nym Technologies SA <contact@nymtech.net>
|
// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use super::received_buffer::ReceivedBufferMessage;
|
|
||||||
use crate::client::cover_traffic_stream::LoopCoverTrafficStream;
|
use crate::client::cover_traffic_stream::LoopCoverTrafficStream;
|
||||||
use crate::client::inbound_messages::{InputMessage, InputMessageReceiver, InputMessageSender};
|
use crate::client::inbound_messages::{InputMessage, InputMessageReceiver, InputMessageSender};
|
||||||
use crate::client::key_manager::KeyManager;
|
use crate::client::key_manager::KeyManager;
|
||||||
@@ -16,7 +15,6 @@ use crate::client::replies::reply_controller::{ReplyControllerReceiver, ReplyCon
|
|||||||
use crate::client::replies::reply_storage::{
|
use crate::client::replies::reply_storage::{
|
||||||
CombinedReplyStorage, PersistentReplyStorage, ReplyStorageBackend, SentReplyKeys,
|
CombinedReplyStorage, PersistentReplyStorage, ReplyStorageBackend, SentReplyKeys,
|
||||||
};
|
};
|
||||||
use crate::client::topology_control::nym_api_provider::NymApiTopologyProvider;
|
|
||||||
use crate::client::topology_control::{
|
use crate::client::topology_control::{
|
||||||
TopologyAccessor, TopologyRefresher, TopologyRefresherConfig,
|
TopologyAccessor, TopologyRefresher, TopologyRefresherConfig,
|
||||||
};
|
};
|
||||||
@@ -24,31 +22,29 @@ use crate::config::{Config, DebugConfig, GatewayEndpointConfig};
|
|||||||
use crate::error::ClientCoreError;
|
use crate::error::ClientCoreError;
|
||||||
use crate::spawn_future;
|
use crate::spawn_future;
|
||||||
use futures::channel::mpsc;
|
use futures::channel::mpsc;
|
||||||
use log::{debug, info};
|
use gateway_client::bandwidth::BandwidthController;
|
||||||
use nym_bandwidth_controller::BandwidthController;
|
#[cfg(target_arch = "wasm32")]
|
||||||
use nym_crypto::asymmetric::{encryption, identity};
|
use gateway_client::wasm_mockups::CosmWasmClient;
|
||||||
use nym_gateway_client::{
|
use gateway_client::{
|
||||||
AcknowledgementReceiver, AcknowledgementSender, GatewayClient, MixnetMessageReceiver,
|
AcknowledgementReceiver, AcknowledgementSender, GatewayClient, MixnetMessageReceiver,
|
||||||
MixnetMessageSender,
|
MixnetMessageSender,
|
||||||
};
|
};
|
||||||
|
use log::{debug, info};
|
||||||
|
use nym_crypto::asymmetric::{encryption, identity};
|
||||||
use nym_sphinx::acknowledgements::AckKey;
|
use nym_sphinx::acknowledgements::AckKey;
|
||||||
use nym_sphinx::addressing::clients::Recipient;
|
use nym_sphinx::addressing::clients::Recipient;
|
||||||
use nym_sphinx::addressing::nodes::NodeIdentity;
|
use nym_sphinx::addressing::nodes::NodeIdentity;
|
||||||
use nym_sphinx::receiver::{ReconstructedMessage, SphinxMessageReceiver};
|
use nym_sphinx::receiver::ReconstructedMessage;
|
||||||
use nym_task::connections::{ConnectionCommandReceiver, ConnectionCommandSender, LaneQueueLengths};
|
use nym_task::connections::{ConnectionCommandReceiver, ConnectionCommandSender, LaneQueueLengths};
|
||||||
use nym_task::{TaskClient, TaskManager};
|
use nym_task::{TaskClient, TaskManager};
|
||||||
use nym_topology::provider_trait::TopologyProvider;
|
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
use tap::TapFallible;
|
use tap::TapFallible;
|
||||||
use url::Url;
|
use url::Url;
|
||||||
|
|
||||||
use nym_credential_storage::storage::Storage;
|
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
use nym_validator_client::nyxd::traits::DkgQueryClient;
|
use validator_client::nyxd::CosmWasmClient;
|
||||||
|
|
||||||
#[cfg(target_arch = "wasm32")]
|
use super::received_buffer::ReceivedBufferMessage;
|
||||||
use nym_bandwidth_controller::wasm_mockups::DkgQueryClient;
|
|
||||||
|
|
||||||
#[cfg(all(not(target_arch = "wasm32"), feature = "fs-surb-storage"))]
|
#[cfg(all(not(target_arch = "wasm32"), feature = "fs-surb-storage"))]
|
||||||
pub mod non_wasm_helpers;
|
pub mod non_wasm_helpers;
|
||||||
@@ -91,11 +87,9 @@ impl ClientOutput {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Clone, Debug)]
|
|
||||||
pub struct ClientState {
|
pub struct ClientState {
|
||||||
pub shared_lane_queue_lengths: LaneQueueLengths,
|
pub shared_lane_queue_lengths: LaneQueueLengths,
|
||||||
pub reply_controller_sender: ReplyControllerSender,
|
pub reply_controller_sender: ReplyControllerSender,
|
||||||
pub topology_accessor: TopologyAccessor,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub enum ClientInputStatus {
|
pub enum ClientInputStatus {
|
||||||
@@ -152,7 +146,7 @@ impl From<bool> for CredentialsToggle {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub struct BaseClientBuilder<'a, B, C, St: Storage> {
|
pub struct BaseClientBuilder<'a, B, C: Clone> {
|
||||||
// due to wasm limitations I had to split it like this : (
|
// due to wasm limitations I had to split it like this : (
|
||||||
gateway_config: &'a GatewayEndpointConfig,
|
gateway_config: &'a GatewayEndpointConfig,
|
||||||
debug_config: &'a DebugConfig,
|
debug_config: &'a DebugConfig,
|
||||||
@@ -160,23 +154,21 @@ pub struct BaseClientBuilder<'a, B, C, St: Storage> {
|
|||||||
nym_api_endpoints: Vec<Url>,
|
nym_api_endpoints: Vec<Url>,
|
||||||
reply_storage_backend: B,
|
reply_storage_backend: B,
|
||||||
|
|
||||||
custom_topology_provider: Option<Box<dyn TopologyProvider>>,
|
bandwidth_controller: Option<BandwidthController<C>>,
|
||||||
bandwidth_controller: Option<BandwidthController<C, St>>,
|
|
||||||
key_manager: KeyManager,
|
key_manager: KeyManager,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, B, C, St> BaseClientBuilder<'a, B, C, St>
|
impl<'a, B, C> BaseClientBuilder<'a, B, C>
|
||||||
where
|
where
|
||||||
B: ReplyStorageBackend + Send + Sync + 'static,
|
B: ReplyStorageBackend + Send + Sync + 'static,
|
||||||
C: DkgQueryClient + Sync + Send + 'static,
|
C: CosmWasmClient + Sync + Send + Clone + 'static,
|
||||||
St: Storage + 'static,
|
|
||||||
{
|
{
|
||||||
pub fn new_from_base_config<T>(
|
pub fn new_from_base_config<T>(
|
||||||
base_config: &'a Config<T>,
|
base_config: &'a Config<T>,
|
||||||
key_manager: KeyManager,
|
key_manager: KeyManager,
|
||||||
bandwidth_controller: Option<BandwidthController<C, St>>,
|
bandwidth_controller: Option<BandwidthController<C>>,
|
||||||
reply_storage_backend: B,
|
reply_storage_backend: B,
|
||||||
) -> BaseClientBuilder<'a, B, C, St> {
|
) -> BaseClientBuilder<'a, B, C> {
|
||||||
BaseClientBuilder {
|
BaseClientBuilder {
|
||||||
gateway_config: base_config.get_gateway_endpoint_config(),
|
gateway_config: base_config.get_gateway_endpoint_config(),
|
||||||
debug_config: base_config.get_debug_config(),
|
debug_config: base_config.get_debug_config(),
|
||||||
@@ -185,7 +177,6 @@ where
|
|||||||
bandwidth_controller,
|
bandwidth_controller,
|
||||||
reply_storage_backend,
|
reply_storage_backend,
|
||||||
key_manager,
|
key_manager,
|
||||||
custom_topology_provider: None,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -193,28 +184,22 @@ where
|
|||||||
gateway_config: &'a GatewayEndpointConfig,
|
gateway_config: &'a GatewayEndpointConfig,
|
||||||
debug_config: &'a DebugConfig,
|
debug_config: &'a DebugConfig,
|
||||||
key_manager: KeyManager,
|
key_manager: KeyManager,
|
||||||
bandwidth_controller: Option<BandwidthController<C, St>>,
|
bandwidth_controller: Option<BandwidthController<C>>,
|
||||||
reply_storage_backend: B,
|
reply_storage_backend: B,
|
||||||
credentials_toggle: CredentialsToggle,
|
credentials_toggle: CredentialsToggle,
|
||||||
nym_api_endpoints: Vec<Url>,
|
nym_api_endpoints: Vec<Url>,
|
||||||
) -> BaseClientBuilder<'a, B, C, St> {
|
) -> BaseClientBuilder<'a, B, C> {
|
||||||
BaseClientBuilder {
|
BaseClientBuilder {
|
||||||
gateway_config,
|
gateway_config,
|
||||||
debug_config,
|
debug_config,
|
||||||
disabled_credentials: credentials_toggle.is_disabled(),
|
disabled_credentials: credentials_toggle.is_disabled(),
|
||||||
nym_api_endpoints,
|
nym_api_endpoints,
|
||||||
reply_storage_backend,
|
reply_storage_backend,
|
||||||
custom_topology_provider: None,
|
|
||||||
bandwidth_controller,
|
bandwidth_controller,
|
||||||
key_manager,
|
key_manager,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn with_topology_provider(mut self, provider: Box<dyn TopologyProvider>) -> Self {
|
|
||||||
self.custom_topology_provider = Some(provider);
|
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn as_mix_recipient(&self) -> Recipient {
|
pub fn as_mix_recipient(&self) -> Recipient {
|
||||||
Recipient::new(
|
Recipient::new(
|
||||||
*self.key_manager.identity_keypair().public_key(),
|
*self.key_manager.identity_keypair().public_key(),
|
||||||
@@ -237,16 +222,21 @@ where
|
|||||||
) {
|
) {
|
||||||
info!("Starting loop cover traffic stream...");
|
info!("Starting loop cover traffic stream...");
|
||||||
|
|
||||||
let stream = LoopCoverTrafficStream::new(
|
let mut stream = LoopCoverTrafficStream::new(
|
||||||
ack_key,
|
ack_key,
|
||||||
debug_config.acknowledgements.average_ack_delay,
|
debug_config.average_ack_delay,
|
||||||
|
debug_config.average_packet_delay,
|
||||||
|
debug_config.loop_cover_traffic_average_delay,
|
||||||
mix_tx,
|
mix_tx,
|
||||||
self_address,
|
self_address,
|
||||||
topology_accessor,
|
topology_accessor,
|
||||||
debug_config.traffic,
|
|
||||||
debug_config.cover_traffic,
|
|
||||||
);
|
);
|
||||||
|
|
||||||
|
if let Some(size) = debug_config.use_extended_packet_size {
|
||||||
|
log::debug!("Setting extended packet size: {:?}", size);
|
||||||
|
stream.set_custom_packet_size(size.into());
|
||||||
|
}
|
||||||
|
|
||||||
stream.start_with_shutdown(shutdown);
|
stream.start_with_shutdown(shutdown);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -292,15 +282,14 @@ where
|
|||||||
shutdown: TaskClient,
|
shutdown: TaskClient,
|
||||||
) {
|
) {
|
||||||
info!("Starting received messages buffer controller...");
|
info!("Starting received messages buffer controller...");
|
||||||
let controller: ReceivedMessagesBufferController<SphinxMessageReceiver> =
|
ReceivedMessagesBufferController::new(
|
||||||
ReceivedMessagesBufferController::new(
|
local_encryption_keypair,
|
||||||
local_encryption_keypair,
|
query_receiver,
|
||||||
query_receiver,
|
mixnet_receiver,
|
||||||
mixnet_receiver,
|
reply_key_storage,
|
||||||
reply_key_storage,
|
reply_controller_sender,
|
||||||
reply_controller_sender,
|
)
|
||||||
);
|
.start_with_shutdown(shutdown)
|
||||||
controller.start_with_shutdown(shutdown)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn start_gateway_client(
|
async fn start_gateway_client(
|
||||||
@@ -308,7 +297,7 @@ where
|
|||||||
mixnet_message_sender: MixnetMessageSender,
|
mixnet_message_sender: MixnetMessageSender,
|
||||||
ack_sender: AcknowledgementSender,
|
ack_sender: AcknowledgementSender,
|
||||||
shutdown: TaskClient,
|
shutdown: TaskClient,
|
||||||
) -> Result<GatewayClient<C, St>, ClientCoreError> {
|
) -> Result<GatewayClient<C>, ClientCoreError> {
|
||||||
let gateway_id = self.gateway_config.gateway_id.clone();
|
let gateway_id = self.gateway_config.gateway_id.clone();
|
||||||
if gateway_id.is_empty() {
|
if gateway_id.is_empty() {
|
||||||
return Err(ClientCoreError::GatewayIdUnknown);
|
return Err(ClientCoreError::GatewayIdUnknown);
|
||||||
@@ -336,9 +325,7 @@ where
|
|||||||
shared_key,
|
shared_key,
|
||||||
mixnet_message_sender,
|
mixnet_message_sender,
|
||||||
ack_sender,
|
ack_sender,
|
||||||
self.debug_config
|
self.debug_config.gateway_response_timeout,
|
||||||
.gateway_connection
|
|
||||||
.gateway_response_timeout,
|
|
||||||
self.bandwidth_controller.take(),
|
self.bandwidth_controller.take(),
|
||||||
shutdown,
|
shutdown,
|
||||||
);
|
);
|
||||||
@@ -354,38 +341,25 @@ where
|
|||||||
Ok(gateway_client)
|
Ok(gateway_client)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn setup_topology_provider(
|
|
||||||
custom_provider: Option<Box<dyn TopologyProvider>>,
|
|
||||||
nym_api_urls: Vec<Url>,
|
|
||||||
) -> Box<dyn TopologyProvider> {
|
|
||||||
// if no custom provider was ... provided ..., create one using nym-api
|
|
||||||
custom_provider.unwrap_or_else(|| {
|
|
||||||
Box::new(NymApiTopologyProvider::new(
|
|
||||||
nym_api_urls,
|
|
||||||
env!("CARGO_PKG_VERSION").to_string(),
|
|
||||||
))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// future responsible for periodically polling directory server and updating
|
// future responsible for periodically polling directory server and updating
|
||||||
// the current global view of topology
|
// the current global view of topology
|
||||||
async fn start_topology_refresher(
|
async fn start_topology_refresher(
|
||||||
topology_provider: Box<dyn TopologyProvider>,
|
nym_api_urls: Vec<Url>,
|
||||||
refresh_rate: Duration,
|
refresh_rate: Duration,
|
||||||
topology_accessor: TopologyAccessor,
|
topology_accessor: TopologyAccessor,
|
||||||
shutdown: TaskClient,
|
shutdown: TaskClient,
|
||||||
) -> Result<(), ClientCoreError> {
|
) -> Result<(), ClientCoreError> {
|
||||||
let topology_refresher_config = TopologyRefresherConfig::new(refresh_rate);
|
let topology_refresher_config = TopologyRefresherConfig::new(
|
||||||
|
nym_api_urls,
|
||||||
let mut topology_refresher = TopologyRefresher::new(
|
refresh_rate,
|
||||||
topology_refresher_config,
|
env!("CARGO_PKG_VERSION").to_string(),
|
||||||
topology_accessor,
|
|
||||||
topology_provider,
|
|
||||||
);
|
);
|
||||||
|
let mut topology_refresher =
|
||||||
|
TopologyRefresher::new(topology_refresher_config, topology_accessor);
|
||||||
// before returning, block entire runtime to refresh the current network view so that any
|
// before returning, block entire runtime to refresh the current network view so that any
|
||||||
// components depending on topology would see a non-empty view
|
// components depending on topology would see a non-empty view
|
||||||
info!("Obtaining initial network topology");
|
info!("Obtaining initial network topology");
|
||||||
topology_refresher.try_refresh().await;
|
topology_refresher.refresh().await;
|
||||||
|
|
||||||
if let Err(err) = topology_refresher.ensure_topology_is_routable().await {
|
if let Err(err) = topology_refresher.ensure_topology_is_routable().await {
|
||||||
log::error!(
|
log::error!(
|
||||||
@@ -405,7 +379,7 @@ where
|
|||||||
// over it. Perhaps GatewayClient needs to be thread-shareable or have some channel for
|
// over it. Perhaps GatewayClient needs to be thread-shareable or have some channel for
|
||||||
// requests?
|
// requests?
|
||||||
fn start_mix_traffic_controller(
|
fn start_mix_traffic_controller(
|
||||||
gateway_client: GatewayClient<C, St>,
|
gateway_client: GatewayClient<C>,
|
||||||
shutdown: TaskClient,
|
shutdown: TaskClient,
|
||||||
) -> BatchMixMessageSender {
|
) -> BatchMixMessageSender {
|
||||||
info!("Starting mix traffic controller...");
|
info!("Starting mix traffic controller...");
|
||||||
@@ -494,13 +468,9 @@ where
|
|||||||
)
|
)
|
||||||
.await?;
|
.await?;
|
||||||
|
|
||||||
let topology_provider = Self::setup_topology_provider(
|
|
||||||
self.custom_topology_provider.take(),
|
|
||||||
self.nym_api_endpoints,
|
|
||||||
);
|
|
||||||
Self::start_topology_refresher(
|
Self::start_topology_refresher(
|
||||||
topology_provider,
|
self.nym_api_endpoints.clone(),
|
||||||
self.debug_config.topology.topology_refresh_rate,
|
self.debug_config.topology_refresh_rate,
|
||||||
shared_topology_accessor.clone(),
|
shared_topology_accessor.clone(),
|
||||||
task_manager.subscribe(),
|
task_manager.subscribe(),
|
||||||
)
|
)
|
||||||
@@ -530,12 +500,17 @@ where
|
|||||||
// primarily to throttle incoming connections (e.g socks5 for attached network-requesters)
|
// primarily to throttle incoming connections (e.g socks5 for attached network-requesters)
|
||||||
let shared_lane_queue_lengths = LaneQueueLengths::new();
|
let shared_lane_queue_lengths = LaneQueueLengths::new();
|
||||||
|
|
||||||
let controller_config = real_messages_control::Config::new(
|
let mut controller_config = real_messages_control::Config::new(
|
||||||
self.debug_config,
|
self.debug_config,
|
||||||
self.key_manager.ack_key(),
|
self.key_manager.ack_key(),
|
||||||
self_address,
|
self_address,
|
||||||
);
|
);
|
||||||
|
|
||||||
|
if let Some(size) = self.debug_config.use_extended_packet_size {
|
||||||
|
log::debug!("Setting extended packet size: {:?}", size);
|
||||||
|
controller_config.set_custom_packet_size(size.into());
|
||||||
|
}
|
||||||
|
|
||||||
Self::start_real_traffic_controller(
|
Self::start_real_traffic_controller(
|
||||||
controller_config,
|
controller_config,
|
||||||
shared_topology_accessor.clone(),
|
shared_topology_accessor.clone(),
|
||||||
@@ -550,16 +525,12 @@ where
|
|||||||
task_manager.subscribe(),
|
task_manager.subscribe(),
|
||||||
);
|
);
|
||||||
|
|
||||||
if !self
|
if !self.debug_config.disable_loop_cover_traffic_stream {
|
||||||
.debug_config
|
|
||||||
.cover_traffic
|
|
||||||
.disable_loop_cover_traffic_stream
|
|
||||||
{
|
|
||||||
Self::start_cover_traffic_stream(
|
Self::start_cover_traffic_stream(
|
||||||
self.debug_config,
|
self.debug_config,
|
||||||
self.key_manager.ack_key(),
|
self.key_manager.ack_key(),
|
||||||
self_address,
|
self_address,
|
||||||
shared_topology_accessor.clone(),
|
shared_topology_accessor,
|
||||||
sphinx_message_sender,
|
sphinx_message_sender,
|
||||||
task_manager.subscribe(),
|
task_manager.subscribe(),
|
||||||
);
|
);
|
||||||
@@ -583,7 +554,6 @@ where
|
|||||||
client_state: ClientState {
|
client_state: ClientState {
|
||||||
shared_lane_queue_lengths,
|
shared_lane_queue_lengths,
|
||||||
reply_controller_sender,
|
reply_controller_sender,
|
||||||
topology_accessor: shared_topology_accessor,
|
|
||||||
},
|
},
|
||||||
task_manager,
|
task_manager,
|
||||||
})
|
})
|
||||||
+4
-12
@@ -30,12 +30,8 @@ async fn setup_fresh_backend<P: AsRef<Path>>(
|
|||||||
// it will only be happening on the very first run and in practice won't incur huge
|
// it will only be happening on the very first run and in practice won't incur huge
|
||||||
// costs since the storage is going to be empty
|
// costs since the storage is going to be empty
|
||||||
let mem_store = CombinedReplyStorage::new(
|
let mem_store = CombinedReplyStorage::new(
|
||||||
debug_config
|
debug_config.minimum_reply_surb_storage_threshold,
|
||||||
.reply_surbs
|
debug_config.maximum_reply_surb_storage_threshold,
|
||||||
.minimum_reply_surb_storage_threshold,
|
|
||||||
debug_config
|
|
||||||
.reply_surbs
|
|
||||||
.maximum_reply_surb_storage_threshold,
|
|
||||||
);
|
);
|
||||||
storage_backend
|
storage_backend
|
||||||
.init_fresh(&mem_store)
|
.init_fresh(&mem_store)
|
||||||
@@ -50,12 +46,8 @@ async fn setup_fresh_backend<P: AsRef<Path>>(
|
|||||||
fn setup_inactive_backend(debug_config: &DebugConfig) -> fs_backend::Backend {
|
fn setup_inactive_backend(debug_config: &DebugConfig) -> fs_backend::Backend {
|
||||||
info!("creating inactive surb database");
|
info!("creating inactive surb database");
|
||||||
fs_backend::Backend::new_inactive(
|
fs_backend::Backend::new_inactive(
|
||||||
debug_config
|
debug_config.minimum_reply_surb_storage_threshold,
|
||||||
.reply_surbs
|
debug_config.maximum_reply_surb_storage_threshold,
|
||||||
.minimum_reply_surb_storage_threshold,
|
|
||||||
debug_config
|
|
||||||
.reply_surbs
|
|
||||||
.maximum_reply_surb_storage_threshold,
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
+27
-45
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
use crate::client::mix_traffic::BatchMixMessageSender;
|
use crate::client::mix_traffic::BatchMixMessageSender;
|
||||||
use crate::client::topology_control::TopologyAccessor;
|
use crate::client::topology_control::TopologyAccessor;
|
||||||
use crate::{config, spawn_future};
|
use crate::spawn_future;
|
||||||
use futures::task::{Context, Poll};
|
use futures::task::{Context, Poll};
|
||||||
use futures::{Future, Stream, StreamExt};
|
use futures::{Future, Stream, StreamExt};
|
||||||
use log::*;
|
use log::*;
|
||||||
@@ -34,8 +34,11 @@ where
|
|||||||
/// Average delay an acknowledgement packet is going to get delay at a single mixnode.
|
/// Average delay an acknowledgement packet is going to get delay at a single mixnode.
|
||||||
average_ack_delay: Duration,
|
average_ack_delay: Duration,
|
||||||
|
|
||||||
/// Defines configuration options related to cover traffic.
|
/// Average delay a data packet is going to get delay at a single mixnode.
|
||||||
cover_traffic: config::CoverTraffic,
|
average_packet_delay: Duration,
|
||||||
|
|
||||||
|
/// Average delay between sending subsequent cover packets.
|
||||||
|
average_cover_message_sending_delay: Duration,
|
||||||
|
|
||||||
/// Internal state, determined by `average_message_sending_delay`,
|
/// Internal state, determined by `average_message_sending_delay`,
|
||||||
/// used to keep track of when a next packet should be sent out.
|
/// used to keep track of when a next packet should be sent out.
|
||||||
@@ -58,11 +61,8 @@ where
|
|||||||
/// Accessor to the common instance of network topology.
|
/// Accessor to the common instance of network topology.
|
||||||
topology_access: TopologyAccessor,
|
topology_access: TopologyAccessor,
|
||||||
|
|
||||||
/// Primary predefined packet size used for the loop cover messages.
|
/// Predefined packet size used for the loop cover messages.
|
||||||
primary_packet_size: PacketSize,
|
packet_size: PacketSize,
|
||||||
|
|
||||||
/// Optional secondary predefined packet size used for the loop cover messages.
|
|
||||||
secondary_packet_size: Option<PacketSize>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R> Stream for LoopCoverTrafficStream<R>
|
impl<R> Stream for LoopCoverTrafficStream<R>
|
||||||
@@ -83,7 +83,7 @@ where
|
|||||||
|
|
||||||
// we know it's time to send a message, so let's prepare delay for the next one
|
// 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
|
// Get the `now` by looking at the current `delay` deadline
|
||||||
let avg_delay = self.cover_traffic.loop_cover_traffic_average_delay;
|
let avg_delay = self.average_cover_message_sending_delay;
|
||||||
let next_poisson_delay = sample_poisson_duration(&mut self.rng, avg_delay);
|
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
|
// The next interval value is `next_poisson_delay` after the one that just
|
||||||
@@ -107,14 +107,15 @@ where
|
|||||||
// obviously when we finally make shared rng that is on 'higher' level, this should become
|
// obviously when we finally make shared rng that is on 'higher' level, this should become
|
||||||
// generic `R`
|
// generic `R`
|
||||||
impl LoopCoverTrafficStream<OsRng> {
|
impl LoopCoverTrafficStream<OsRng> {
|
||||||
|
#[allow(clippy::too_many_arguments)]
|
||||||
pub fn new(
|
pub fn new(
|
||||||
ack_key: Arc<AckKey>,
|
ack_key: Arc<AckKey>,
|
||||||
average_ack_delay: Duration,
|
average_ack_delay: Duration,
|
||||||
|
average_packet_delay: Duration,
|
||||||
|
average_cover_message_sending_delay: Duration,
|
||||||
mix_tx: BatchMixMessageSender,
|
mix_tx: BatchMixMessageSender,
|
||||||
our_full_destination: Recipient,
|
our_full_destination: Recipient,
|
||||||
topology_access: TopologyAccessor,
|
topology_access: TopologyAccessor,
|
||||||
traffic_config: config::Traffic,
|
|
||||||
cover_config: config::CoverTraffic,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
let rng = OsRng;
|
let rng = OsRng;
|
||||||
|
|
||||||
@@ -127,17 +128,21 @@ impl LoopCoverTrafficStream<OsRng> {
|
|||||||
LoopCoverTrafficStream {
|
LoopCoverTrafficStream {
|
||||||
ack_key,
|
ack_key,
|
||||||
average_ack_delay,
|
average_ack_delay,
|
||||||
cover_traffic: cover_config,
|
average_packet_delay,
|
||||||
|
average_cover_message_sending_delay,
|
||||||
next_delay,
|
next_delay,
|
||||||
mix_tx,
|
mix_tx,
|
||||||
our_full_destination,
|
our_full_destination,
|
||||||
rng,
|
rng,
|
||||||
topology_access,
|
topology_access,
|
||||||
primary_packet_size: traffic_config.primary_packet_size,
|
packet_size: Default::default(),
|
||||||
secondary_packet_size: traffic_config.secondary_packet_size,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn set_custom_packet_size(&mut self, packet_size: PacketSize) {
|
||||||
|
self.packet_size = packet_size;
|
||||||
|
}
|
||||||
|
|
||||||
fn set_next_delay(&mut self, amount: Duration) {
|
fn set_next_delay(&mut self, amount: Duration) {
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
let next_delay = Box::pin(time::sleep(amount));
|
let next_delay = Box::pin(time::sleep(amount));
|
||||||
@@ -148,28 +153,9 @@ impl LoopCoverTrafficStream<OsRng> {
|
|||||||
self.next_delay = next_delay;
|
self.next_delay = next_delay;
|
||||||
}
|
}
|
||||||
|
|
||||||
fn loop_cover_message_size(&mut self) -> PacketSize {
|
|
||||||
let Some(secondary_packet_size) = self.secondary_packet_size else {
|
|
||||||
return self.primary_packet_size
|
|
||||||
};
|
|
||||||
|
|
||||||
let use_primary = self
|
|
||||||
.rng
|
|
||||||
.gen_bool(self.cover_traffic.cover_traffic_primary_size_ratio);
|
|
||||||
|
|
||||||
if use_primary {
|
|
||||||
self.primary_packet_size
|
|
||||||
} else {
|
|
||||||
secondary_packet_size
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn on_new_message(&mut self) {
|
async fn on_new_message(&mut self) {
|
||||||
trace!("next cover message!");
|
trace!("next cover message!");
|
||||||
|
|
||||||
let cover_traffic_packet_size = self.loop_cover_message_size();
|
|
||||||
trace!("the next loop cover message will be put in a {cover_traffic_packet_size} packet");
|
|
||||||
|
|
||||||
// TODO for way down the line: in very rare cases (during topology update) we might have
|
// 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
|
// to wait a really tiny bit before actually obtaining the permit hence messing with our
|
||||||
// poisson delay, but is it really a problem?
|
// poisson delay, but is it really a problem?
|
||||||
@@ -192,8 +178,8 @@ impl LoopCoverTrafficStream<OsRng> {
|
|||||||
&self.ack_key,
|
&self.ack_key,
|
||||||
&self.our_full_destination,
|
&self.our_full_destination,
|
||||||
self.average_ack_delay,
|
self.average_ack_delay,
|
||||||
self.cover_traffic.loop_cover_traffic_average_delay,
|
self.average_packet_delay,
|
||||||
cover_traffic_packet_size,
|
self.packet_size,
|
||||||
)
|
)
|
||||||
.expect("Somehow failed to generate a loop cover message with a valid topology");
|
.expect("Somehow failed to generate a loop cover message with a valid topology");
|
||||||
|
|
||||||
@@ -203,6 +189,10 @@ impl LoopCoverTrafficStream<OsRng> {
|
|||||||
// This isn't a problem, if the channel is full means we're already sending the
|
// This isn't a problem, if the channel is full means we're already sending the
|
||||||
// max amount of messages downstream can handle.
|
// max amount of messages downstream can handle.
|
||||||
log::debug!("Failed to send cover message - channel full");
|
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(_) => {
|
TrySendError::Closed(_) => {
|
||||||
log::warn!("Failed to send cover message - channel closed");
|
log::warn!("Failed to send cover message - channel closed");
|
||||||
@@ -224,17 +214,9 @@ impl LoopCoverTrafficStream<OsRng> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn start_with_shutdown(mut self, mut shutdown: nym_task::TaskClient) {
|
pub fn start_with_shutdown(mut self, mut shutdown: nym_task::TaskClient) {
|
||||||
if self.cover_traffic.disable_loop_cover_traffic_stream {
|
|
||||||
// we should have never got here in the first place - the task should have never been created to begin with
|
|
||||||
// so panic and review the code that lead to this branch
|
|
||||||
panic!("attempted to start LoopCoverTrafficStream while config explicitly disabled it.")
|
|
||||||
}
|
|
||||||
|
|
||||||
// we should set initial delay only when we actually start the stream
|
// we should set initial delay only when we actually start the stream
|
||||||
let sampled = sample_poisson_duration(
|
let sampled =
|
||||||
&mut self.rng,
|
sample_poisson_duration(&mut self.rng, self.average_cover_message_sending_delay);
|
||||||
self.cover_traffic.loop_cover_traffic_average_delay,
|
|
||||||
);
|
|
||||||
self.set_next_delay(sampled);
|
self.set_next_delay(sampled);
|
||||||
|
|
||||||
spawn_future(async move {
|
spawn_future(async move {
|
||||||
+1
-1
@@ -2,9 +2,9 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use crate::config::persistence::key_pathfinder::ClientKeyPathfinder;
|
use crate::config::persistence::key_pathfinder::ClientKeyPathfinder;
|
||||||
|
use gateway_requests::registration::handshake::SharedKeys;
|
||||||
use log::*;
|
use log::*;
|
||||||
use nym_crypto::asymmetric::{encryption, identity};
|
use nym_crypto::asymmetric::{encryption, identity};
|
||||||
use nym_gateway_requests::registration::handshake::SharedKeys;
|
|
||||||
use nym_sphinx::acknowledgements::AckKey;
|
use nym_sphinx::acknowledgements::AckKey;
|
||||||
use rand::{CryptoRng, RngCore};
|
use rand::{CryptoRng, RngCore};
|
||||||
use std::io;
|
use std::io;
|
||||||
+12
-16
@@ -2,16 +2,13 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use crate::spawn_future;
|
use crate::spawn_future;
|
||||||
use log::*;
|
|
||||||
use nym_gateway_client::GatewayClient;
|
|
||||||
use nym_sphinx::forwarding::packet::MixPacket;
|
|
||||||
|
|
||||||
use nym_credential_storage::storage::Storage;
|
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
|
||||||
use nym_validator_client::nyxd::traits::DkgQueryClient;
|
|
||||||
|
|
||||||
#[cfg(target_arch = "wasm32")]
|
#[cfg(target_arch = "wasm32")]
|
||||||
use nym_bandwidth_controller::wasm_mockups::DkgQueryClient;
|
use gateway_client::wasm_mockups::CosmWasmClient;
|
||||||
|
use gateway_client::GatewayClient;
|
||||||
|
use log::*;
|
||||||
|
use nym_sphinx::forwarding::packet::MixPacket;
|
||||||
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
|
use validator_client::nyxd::CosmWasmClient;
|
||||||
|
|
||||||
pub type BatchMixMessageSender = tokio::sync::mpsc::Sender<Vec<MixPacket>>;
|
pub type BatchMixMessageSender = tokio::sync::mpsc::Sender<Vec<MixPacket>>;
|
||||||
pub type BatchMixMessageReceiver = tokio::sync::mpsc::Receiver<Vec<MixPacket>>;
|
pub type BatchMixMessageReceiver = tokio::sync::mpsc::Receiver<Vec<MixPacket>>;
|
||||||
@@ -20,10 +17,10 @@ pub type BatchMixMessageReceiver = tokio::sync::mpsc::Receiver<Vec<MixPacket>>;
|
|||||||
pub const MIX_MESSAGE_RECEIVER_BUFFER_SIZE: usize = 32;
|
pub const MIX_MESSAGE_RECEIVER_BUFFER_SIZE: usize = 32;
|
||||||
const MAX_FAILURE_COUNT: usize = 100;
|
const MAX_FAILURE_COUNT: usize = 100;
|
||||||
|
|
||||||
pub struct MixTrafficController<C, St: Storage> {
|
pub struct MixTrafficController<C: Clone> {
|
||||||
// TODO: most likely to be replaced by some higher level construct as
|
// TODO: most likely to be replaced by some higher level construct as
|
||||||
// later on gateway_client will need to be accessible by other entities
|
// later on gateway_client will need to be accessible by other entities
|
||||||
gateway_client: GatewayClient<C, St>,
|
gateway_client: GatewayClient<C>,
|
||||||
mix_rx: BatchMixMessageReceiver,
|
mix_rx: BatchMixMessageReceiver,
|
||||||
|
|
||||||
// TODO: this is temporary work-around.
|
// TODO: this is temporary work-around.
|
||||||
@@ -31,14 +28,13 @@ pub struct MixTrafficController<C, St: Storage> {
|
|||||||
consecutive_gateway_failure_count: usize,
|
consecutive_gateway_failure_count: usize,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<C, St> MixTrafficController<C, St>
|
impl<C> MixTrafficController<C>
|
||||||
where
|
where
|
||||||
C: DkgQueryClient + Sync + Send + 'static,
|
C: CosmWasmClient + Sync + Send + Clone + 'static,
|
||||||
St: Storage + 'static,
|
|
||||||
{
|
{
|
||||||
pub fn new(
|
pub fn new(
|
||||||
gateway_client: GatewayClient<C, St>,
|
gateway_client: GatewayClient<C>,
|
||||||
) -> (MixTrafficController<C, St>, BatchMixMessageSender) {
|
) -> (MixTrafficController<C>, BatchMixMessageSender) {
|
||||||
let (sphinx_message_sender, sphinx_message_receiver) =
|
let (sphinx_message_sender, sphinx_message_receiver) =
|
||||||
tokio::sync::mpsc::channel(MIX_MESSAGE_RECEIVER_BUFFER_SIZE);
|
tokio::sync::mpsc::channel(MIX_MESSAGE_RECEIVER_BUFFER_SIZE);
|
||||||
(
|
(
|
||||||
+1
-1
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
use super::action_controller::{AckActionSender, Action};
|
use super::action_controller::{AckActionSender, Action};
|
||||||
use futures::StreamExt;
|
use futures::StreamExt;
|
||||||
|
use gateway_client::AcknowledgementReceiver;
|
||||||
use log::*;
|
use log::*;
|
||||||
use nym_gateway_client::AcknowledgementReceiver;
|
|
||||||
use nym_sphinx::{
|
use nym_sphinx::{
|
||||||
acknowledgements::{identifier::recover_identifier, AckKey},
|
acknowledgements::{identifier::recover_identifier, AckKey},
|
||||||
chunking::fragment::{FragmentIdentifier, COVER_FRAG_ID},
|
chunking::fragment::{FragmentIdentifier, COVER_FRAG_ID},
|
||||||
+1
-1
@@ -13,8 +13,8 @@ use crate::client::replies::reply_controller::ReplyControllerSender;
|
|||||||
use crate::spawn_future;
|
use crate::spawn_future;
|
||||||
use action_controller::AckActionReceiver;
|
use action_controller::AckActionReceiver;
|
||||||
use futures::channel::mpsc;
|
use futures::channel::mpsc;
|
||||||
|
use gateway_client::AcknowledgementReceiver;
|
||||||
use log::*;
|
use log::*;
|
||||||
use nym_gateway_client::AcknowledgementReceiver;
|
|
||||||
use nym_sphinx::anonymous_replies::requests::AnonymousSenderTag;
|
use nym_sphinx::anonymous_replies::requests::AnonymousSenderTag;
|
||||||
use nym_sphinx::params::PacketSize;
|
use nym_sphinx::params::PacketSize;
|
||||||
use nym_sphinx::{
|
use nym_sphinx::{
|
||||||
+11
-52
@@ -101,11 +101,8 @@ pub(crate) struct Config {
|
|||||||
/// Note that it does not include gateway hops.
|
/// Note that it does not include gateway hops.
|
||||||
num_mix_hops: u8,
|
num_mix_hops: u8,
|
||||||
|
|
||||||
/// Primary predefined packet size used for the encapsulated messages.
|
/// Predefined packet size used for the encapsulated messages.
|
||||||
primary_packet_size: PacketSize,
|
packet_size: PacketSize,
|
||||||
|
|
||||||
/// Optional secondary predefined packet size used for the encapsulated messages.
|
|
||||||
secondary_packet_size: Option<PacketSize>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Config {
|
impl Config {
|
||||||
@@ -121,8 +118,7 @@ impl Config {
|
|||||||
average_packet_delay,
|
average_packet_delay,
|
||||||
average_ack_delay,
|
average_ack_delay,
|
||||||
num_mix_hops: DEFAULT_NUM_MIX_HOPS,
|
num_mix_hops: DEFAULT_NUM_MIX_HOPS,
|
||||||
primary_packet_size: PacketSize::default(),
|
packet_size: PacketSize::default(),
|
||||||
secondary_packet_size: None,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -134,14 +130,8 @@ impl Config {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Allows setting non-default size of the sphinx packets sent out.
|
/// Allows setting non-default size of the sphinx packets sent out.
|
||||||
pub fn with_custom_primary_packet_size(mut self, packet_size: PacketSize) -> Self {
|
pub fn with_custom_packet_size(mut self, packet_size: PacketSize) -> Self {
|
||||||
self.primary_packet_size = packet_size;
|
self.packet_size = packet_size;
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Allows setting non-default size of the sphinx packets sent out.
|
|
||||||
pub fn with_custom_secondary_packet_size(mut self, packet_size: Option<PacketSize>) -> Self {
|
|
||||||
self.secondary_packet_size = packet_size;
|
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -180,6 +170,7 @@ where
|
|||||||
config.average_packet_delay,
|
config.average_packet_delay,
|
||||||
config.average_ack_delay,
|
config.average_ack_delay,
|
||||||
)
|
)
|
||||||
|
.with_custom_real_message_packet_size(config.packet_size)
|
||||||
.with_mix_hops(config.num_mix_hops);
|
.with_mix_hops(config.num_mix_hops);
|
||||||
|
|
||||||
MessageHandler {
|
MessageHandler {
|
||||||
@@ -220,28 +211,6 @@ where
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn optimal_packet_size(&self, msg: &NymMessage) -> PacketSize {
|
|
||||||
// if secondary packet was never set, then it's obvious we have to use the primary packet
|
|
||||||
let Some(secondary_packet) = self.config.secondary_packet_size else {
|
|
||||||
trace!("only primary packet size is available");
|
|
||||||
return self.config.primary_packet_size
|
|
||||||
};
|
|
||||||
|
|
||||||
let primary_count =
|
|
||||||
msg.required_packets(self.config.primary_packet_size, self.config.num_mix_hops);
|
|
||||||
let secondary_count = msg.required_packets(secondary_packet, self.config.num_mix_hops);
|
|
||||||
|
|
||||||
trace!("This message would require: {primary_count} primary packets or {secondary_count} secondary packets...");
|
|
||||||
// if there would be no benefit in using the secondary packet - use the primary (duh)
|
|
||||||
if primary_count <= secondary_count {
|
|
||||||
trace!("so choosing primary for this message");
|
|
||||||
self.config.primary_packet_size
|
|
||||||
} else {
|
|
||||||
trace!("so choosing secondary for this message");
|
|
||||||
secondary_packet
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn generate_reply_surbs_with_keys(
|
async fn generate_reply_surbs_with_keys(
|
||||||
&mut self,
|
&mut self,
|
||||||
amount: usize,
|
amount: usize,
|
||||||
@@ -268,13 +237,9 @@ where
|
|||||||
reply_surb: ReplySurb,
|
reply_surb: ReplySurb,
|
||||||
is_extra_surb_request: bool,
|
is_extra_surb_request: bool,
|
||||||
) -> Result<(), SurbWrappedPreparationError> {
|
) -> Result<(), SurbWrappedPreparationError> {
|
||||||
let msg = NymMessage::new_reply(message);
|
|
||||||
let packet_size = self.optimal_packet_size(&msg);
|
|
||||||
debug!("Using {packet_size} packets for {msg}");
|
|
||||||
|
|
||||||
let mut fragment = self
|
let mut fragment = self
|
||||||
.message_preparer
|
.message_preparer
|
||||||
.pad_and_split_message(msg, packet_size);
|
.pad_and_split_message(NymMessage::new_reply(message));
|
||||||
if fragment.len() > 1 {
|
if fragment.len() > 1 {
|
||||||
// well, it's not a single surb message
|
// well, it's not a single surb message
|
||||||
return Err(SurbWrappedPreparationError {
|
return Err(SurbWrappedPreparationError {
|
||||||
@@ -324,12 +289,10 @@ where
|
|||||||
|
|
||||||
// // TODO: this will require additional argument to make it use different variant of `ReplyMessage`
|
// // TODO: this will require additional argument to make it use different variant of `ReplyMessage`
|
||||||
pub(crate) fn split_reply_message(&mut self, message: Vec<u8>) -> Vec<Fragment> {
|
pub(crate) fn split_reply_message(&mut self, message: Vec<u8>) -> Vec<Fragment> {
|
||||||
let msg = NymMessage::new_reply(ReplyMessage::new_data_message(message));
|
|
||||||
let packet_size = self.optimal_packet_size(&msg);
|
|
||||||
debug!("Using {packet_size} packets for {msg}");
|
|
||||||
|
|
||||||
self.message_preparer
|
self.message_preparer
|
||||||
.pad_and_split_message(msg, packet_size)
|
.pad_and_split_message(NymMessage::new_reply(ReplyMessage::new_data_message(
|
||||||
|
message,
|
||||||
|
)))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) async fn send_retransmission_reply_chunks(
|
pub(crate) async fn send_retransmission_reply_chunks(
|
||||||
@@ -425,11 +388,7 @@ where
|
|||||||
let topology_permit = self.topology_access.get_read_permit().await;
|
let topology_permit = self.topology_access.get_read_permit().await;
|
||||||
let topology = self.get_topology(&topology_permit)?;
|
let topology = self.get_topology(&topology_permit)?;
|
||||||
|
|
||||||
let packet_size = self.optimal_packet_size(&message);
|
let fragments = self.message_preparer.pad_and_split_message(message);
|
||||||
debug!("Using {packet_size} packets for {message}");
|
|
||||||
let fragments = self
|
|
||||||
.message_preparer
|
|
||||||
.pad_and_split_message(message, packet_size);
|
|
||||||
|
|
||||||
let mut pending_acks = Vec::with_capacity(fragments.len());
|
let mut pending_acks = Vec::with_capacity(fragments.len());
|
||||||
let mut real_messages = Vec::with_capacity(fragments.len());
|
let mut real_messages = Vec::with_capacity(fragments.len());
|
||||||
+90
-27
@@ -1,4 +1,4 @@
|
|||||||
// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
|
// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
// INPUT: InputMessage from user
|
// INPUT: InputMessage from user
|
||||||
@@ -22,13 +22,15 @@ use crate::{
|
|||||||
spawn_future,
|
spawn_future,
|
||||||
};
|
};
|
||||||
use futures::channel::mpsc;
|
use futures::channel::mpsc;
|
||||||
|
use gateway_client::AcknowledgementReceiver;
|
||||||
use log::*;
|
use log::*;
|
||||||
use nym_gateway_client::AcknowledgementReceiver;
|
|
||||||
use nym_sphinx::acknowledgements::AckKey;
|
use nym_sphinx::acknowledgements::AckKey;
|
||||||
use nym_sphinx::addressing::clients::Recipient;
|
use nym_sphinx::addressing::clients::Recipient;
|
||||||
|
use nym_sphinx::params::PacketSize;
|
||||||
use nym_task::connections::{ConnectionCommandReceiver, LaneQueueLengths};
|
use nym_task::connections::{ConnectionCommandReceiver, LaneQueueLengths};
|
||||||
use rand::{rngs::OsRng, CryptoRng, Rng};
|
use rand::{rngs::OsRng, CryptoRng, Rng};
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
use crate::client::replies::reply_controller;
|
use crate::client::replies::reply_controller;
|
||||||
use crate::config;
|
use crate::config;
|
||||||
@@ -43,29 +45,61 @@ pub struct Config {
|
|||||||
/// Key used to decrypt contents of received SURBAcks
|
/// Key used to decrypt contents of received SURBAcks
|
||||||
ack_key: Arc<AckKey>,
|
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.
|
/// Address of `this` client.
|
||||||
self_recipient: Recipient,
|
self_recipient: Recipient,
|
||||||
|
|
||||||
/// Specifies all traffic related configuration options.
|
/// Average delay between sending subsequent packets from this client.
|
||||||
traffic: config::Traffic,
|
average_message_sending_delay: Duration,
|
||||||
|
|
||||||
/// Specifies all cover traffic related configuration options.
|
/// Average delay a data packet is going to get delayed at a single mixnode.
|
||||||
cover_traffic: config::CoverTraffic,
|
average_packet_delay_duration: Duration,
|
||||||
|
|
||||||
/// Specifies all acknowledgements related configuration options.
|
/// Average delay an acknowledgement packet is going to get delayed at a single mixnode.
|
||||||
acks: config::Acknowledgements,
|
average_ack_delay_duration: Duration,
|
||||||
|
|
||||||
/// Specifies all reply SURBs related configuration options.
|
/// Controls whether the main packet stream constantly produces packets according to the predefined
|
||||||
reply_surbs: config::ReplySurbs,
|
/// poisson distribution.
|
||||||
|
disable_main_poisson_packet_distribution: bool,
|
||||||
|
|
||||||
|
/// Predefined packet size used for the encapsulated messages.
|
||||||
|
packet_size: PacketSize,
|
||||||
|
|
||||||
|
/// Defines the minimum number of reply surbs the client would request.
|
||||||
|
minimum_reply_surb_request_size: u32,
|
||||||
|
|
||||||
|
/// Defines the maximum number of reply surbs the client would request.
|
||||||
|
maximum_reply_surb_request_size: u32,
|
||||||
|
|
||||||
|
/// Defines the maximum number of reply surbs a remote party is allowed to request from this client at once.
|
||||||
|
maximum_allowed_reply_surb_request_size: u32,
|
||||||
|
|
||||||
|
/// Defines maximum amount of time the client is going to wait for reply surbs before explicitly asking
|
||||||
|
/// for more even though in theory they wouldn't need to.
|
||||||
|
maximum_reply_surb_rerequest_waiting_period: Duration,
|
||||||
|
|
||||||
|
/// Defines maximum amount of time the client is going to wait for reply surbs before
|
||||||
|
/// deciding it's never going to get them and would drop all pending messages
|
||||||
|
maximum_reply_surb_drop_waiting_period: Duration,
|
||||||
|
|
||||||
|
/// Defines maximum amount of time given reply surb is going to be valid for.
|
||||||
|
/// This is going to be superseded by key rotation once implemented.
|
||||||
|
maximum_reply_surb_age: Duration,
|
||||||
|
|
||||||
|
/// Defines maximum amount of time given reply key is going to be valid for.
|
||||||
|
/// This is going to be superseded by key rotation once implemented.
|
||||||
|
maximum_reply_key_age: Duration,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> From<&'a Config> for acknowledgement_control::Config {
|
impl<'a> From<&'a Config> for acknowledgement_control::Config {
|
||||||
fn from(cfg: &'a Config) -> Self {
|
fn from(cfg: &'a Config) -> Self {
|
||||||
acknowledgement_control::Config::new(
|
acknowledgement_control::Config::new(cfg.ack_wait_addition, cfg.ack_wait_multiplier)
|
||||||
cfg.acks.ack_wait_addition,
|
.with_custom_packet_size(cfg.packet_size)
|
||||||
cfg.acks.ack_wait_multiplier,
|
|
||||||
)
|
|
||||||
.with_custom_packet_size(cfg.traffic.primary_packet_size)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -74,16 +108,26 @@ impl<'a> From<&'a Config> for real_traffic_stream::Config {
|
|||||||
real_traffic_stream::Config::new(
|
real_traffic_stream::Config::new(
|
||||||
Arc::clone(&cfg.ack_key),
|
Arc::clone(&cfg.ack_key),
|
||||||
cfg.self_recipient,
|
cfg.self_recipient,
|
||||||
cfg.acks.average_ack_delay,
|
cfg.average_ack_delay_duration,
|
||||||
cfg.traffic,
|
cfg.average_packet_delay_duration,
|
||||||
cfg.cover_traffic.cover_traffic_primary_size_ratio,
|
cfg.average_message_sending_delay,
|
||||||
|
cfg.disable_main_poisson_packet_distribution,
|
||||||
)
|
)
|
||||||
|
.with_custom_cover_packet_size(cfg.packet_size)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> From<&'a Config> for reply_controller::Config {
|
impl<'a> From<&'a Config> for reply_controller::Config {
|
||||||
fn from(cfg: &'a Config) -> Self {
|
fn from(cfg: &'a Config) -> Self {
|
||||||
reply_controller::Config::new(cfg.reply_surbs)
|
reply_controller::Config::new(
|
||||||
|
cfg.minimum_reply_surb_request_size,
|
||||||
|
cfg.maximum_reply_surb_request_size,
|
||||||
|
cfg.maximum_allowed_reply_surb_request_size,
|
||||||
|
cfg.maximum_reply_surb_rerequest_waiting_period,
|
||||||
|
cfg.maximum_reply_surb_drop_waiting_period,
|
||||||
|
cfg.maximum_reply_surb_age,
|
||||||
|
cfg.maximum_reply_key_age,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -92,11 +136,10 @@ impl<'a> From<&'a Config> for message_handler::Config {
|
|||||||
message_handler::Config::new(
|
message_handler::Config::new(
|
||||||
Arc::clone(&cfg.ack_key),
|
Arc::clone(&cfg.ack_key),
|
||||||
cfg.self_recipient,
|
cfg.self_recipient,
|
||||||
cfg.traffic.average_packet_delay,
|
cfg.average_packet_delay_duration,
|
||||||
cfg.acks.average_ack_delay,
|
cfg.average_ack_delay_duration,
|
||||||
)
|
)
|
||||||
.with_custom_primary_packet_size(cfg.traffic.primary_packet_size)
|
.with_custom_packet_size(cfg.packet_size)
|
||||||
.with_custom_secondary_packet_size(cfg.traffic.secondary_packet_size)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -109,12 +152,32 @@ impl Config {
|
|||||||
Config {
|
Config {
|
||||||
ack_key,
|
ack_key,
|
||||||
self_recipient,
|
self_recipient,
|
||||||
traffic: base_client_debug_config.traffic,
|
packet_size: Default::default(),
|
||||||
cover_traffic: base_client_debug_config.cover_traffic,
|
ack_wait_addition: base_client_debug_config.ack_wait_addition,
|
||||||
acks: base_client_debug_config.acknowledgements,
|
ack_wait_multiplier: base_client_debug_config.ack_wait_multiplier,
|
||||||
reply_surbs: base_client_debug_config.reply_surbs,
|
average_message_sending_delay: base_client_debug_config.message_sending_average_delay,
|
||||||
|
average_packet_delay_duration: base_client_debug_config.average_packet_delay,
|
||||||
|
average_ack_delay_duration: base_client_debug_config.average_ack_delay,
|
||||||
|
disable_main_poisson_packet_distribution: base_client_debug_config
|
||||||
|
.disable_main_poisson_packet_distribution,
|
||||||
|
minimum_reply_surb_request_size: base_client_debug_config
|
||||||
|
.minimum_reply_surb_request_size,
|
||||||
|
maximum_reply_surb_request_size: base_client_debug_config
|
||||||
|
.maximum_reply_surb_request_size,
|
||||||
|
maximum_allowed_reply_surb_request_size: base_client_debug_config
|
||||||
|
.maximum_allowed_reply_surb_request_size,
|
||||||
|
maximum_reply_surb_rerequest_waiting_period: base_client_debug_config
|
||||||
|
.maximum_reply_surb_rerequest_waiting_period,
|
||||||
|
maximum_reply_surb_drop_waiting_period: base_client_debug_config
|
||||||
|
.maximum_reply_surb_drop_waiting_period,
|
||||||
|
maximum_reply_surb_age: base_client_debug_config.maximum_reply_surb_age,
|
||||||
|
maximum_reply_key_age: base_client_debug_config.maximum_reply_key_age,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn set_custom_packet_size(&mut self, packet_size: PacketSize) {
|
||||||
|
self.packet_size = packet_size;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) struct RealMessagesController<R>
|
pub(crate) struct RealMessagesController<R>
|
||||||
+51
-54
@@ -6,7 +6,6 @@ use crate::client::mix_traffic::BatchMixMessageSender;
|
|||||||
use crate::client::real_messages_control::acknowledgement_control::SentPacketNotificationSender;
|
use crate::client::real_messages_control::acknowledgement_control::SentPacketNotificationSender;
|
||||||
use crate::client::topology_control::TopologyAccessor;
|
use crate::client::topology_control::TopologyAccessor;
|
||||||
use crate::client::transmission_buffer::TransmissionBuffer;
|
use crate::client::transmission_buffer::TransmissionBuffer;
|
||||||
use crate::config;
|
|
||||||
use futures::task::{Context, Poll};
|
use futures::task::{Context, Poll};
|
||||||
use futures::{Future, Stream, StreamExt};
|
use futures::{Future, Stream, StreamExt};
|
||||||
use log::*;
|
use log::*;
|
||||||
@@ -28,6 +27,7 @@ use std::time::Duration;
|
|||||||
|
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
use tokio::time;
|
use tokio::time;
|
||||||
|
|
||||||
#[cfg(target_arch = "wasm32")]
|
#[cfg(target_arch = "wasm32")]
|
||||||
use wasm_timer;
|
use wasm_timer;
|
||||||
|
|
||||||
@@ -44,12 +44,18 @@ pub(crate) struct Config {
|
|||||||
/// Average delay an acknowledgement packet is going to get delay at a single mixnode.
|
/// Average delay an acknowledgement packet is going to get delay at a single mixnode.
|
||||||
average_ack_delay: Duration,
|
average_ack_delay: Duration,
|
||||||
|
|
||||||
/// Defines all configuration options related to this traffic stream.
|
/// Average delay a data packet is going to get delay at a single mixnode.
|
||||||
traffic: config::Traffic,
|
average_packet_delay: Duration,
|
||||||
|
|
||||||
/// Specifies the ratio of `primary_packet_size` to `secondary_packet_size` used in cover traffic.
|
/// Average delay between sending subsequent packets.
|
||||||
/// Only applicable if `secondary_packet_size` is enabled.
|
average_message_sending_delay: Duration,
|
||||||
cover_traffic_primary_size_ratio: f64,
|
|
||||||
|
/// Controls whether the stream constantly produces packets according to the predefined
|
||||||
|
/// poisson distribution.
|
||||||
|
disable_poisson_packet_distribution: bool,
|
||||||
|
|
||||||
|
/// Predefined packet size used for the loop cover messages.
|
||||||
|
cover_packet_size: PacketSize,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Config {
|
impl Config {
|
||||||
@@ -57,17 +63,25 @@ impl Config {
|
|||||||
ack_key: Arc<AckKey>,
|
ack_key: Arc<AckKey>,
|
||||||
our_full_destination: Recipient,
|
our_full_destination: Recipient,
|
||||||
average_ack_delay: Duration,
|
average_ack_delay: Duration,
|
||||||
traffic: config::Traffic,
|
average_packet_delay: Duration,
|
||||||
cover_traffic_primary_size_ratio: f64,
|
average_message_sending_delay: Duration,
|
||||||
|
disable_poisson_packet_distribution: bool,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
Config {
|
Config {
|
||||||
ack_key,
|
ack_key,
|
||||||
our_full_destination,
|
our_full_destination,
|
||||||
average_ack_delay,
|
average_ack_delay,
|
||||||
traffic,
|
average_packet_delay,
|
||||||
cover_traffic_primary_size_ratio,
|
average_message_sending_delay,
|
||||||
|
disable_poisson_packet_distribution,
|
||||||
|
cover_packet_size: Default::default(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn with_custom_cover_packet_size(mut self, packet_size: PacketSize) -> Self {
|
||||||
|
self.cover_packet_size = packet_size;
|
||||||
|
self
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) struct OutQueueControl<R>
|
pub(crate) struct OutQueueControl<R>
|
||||||
@@ -198,30 +212,11 @@ where
|
|||||||
self.sent_notifier.unbounded_send(frag_id).unwrap();
|
self.sent_notifier.unbounded_send(frag_id).unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
fn loop_cover_message_size(&mut self) -> PacketSize {
|
|
||||||
let Some(secondary_packet_size) = self.config.traffic.secondary_packet_size else {
|
|
||||||
return self.config.traffic.primary_packet_size
|
|
||||||
};
|
|
||||||
|
|
||||||
let use_primary = self
|
|
||||||
.rng
|
|
||||||
.gen_bool(self.config.cover_traffic_primary_size_ratio);
|
|
||||||
|
|
||||||
if use_primary {
|
|
||||||
self.config.traffic.primary_packet_size
|
|
||||||
} else {
|
|
||||||
secondary_packet_size
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async fn on_message(&mut self, next_message: StreamMessage) {
|
async fn on_message(&mut self, next_message: StreamMessage) {
|
||||||
trace!("created new message");
|
trace!("created new message");
|
||||||
|
|
||||||
let (next_message, fragment_id) = match next_message {
|
let (next_message, fragment_id) = match next_message {
|
||||||
StreamMessage::Cover => {
|
StreamMessage::Cover => {
|
||||||
let cover_traffic_packet_size = self.loop_cover_message_size();
|
|
||||||
trace!("the next loop cover message will be put in a {cover_traffic_packet_size} packet");
|
|
||||||
|
|
||||||
// TODO for way down the line: in very rare cases (during topology update) we might have
|
// 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
|
// to wait a really tiny bit before actually obtaining the permit hence messing with our
|
||||||
// poisson delay, but is it really a problem?
|
// poisson delay, but is it really a problem?
|
||||||
@@ -245,8 +240,8 @@ where
|
|||||||
&self.config.ack_key,
|
&self.config.ack_key,
|
||||||
&self.config.our_full_destination,
|
&self.config.our_full_destination,
|
||||||
self.config.average_ack_delay,
|
self.config.average_ack_delay,
|
||||||
self.config.traffic.average_packet_delay,
|
self.config.average_packet_delay,
|
||||||
cover_traffic_packet_size,
|
self.config.cover_packet_size,
|
||||||
)
|
)
|
||||||
.expect(
|
.expect(
|
||||||
"Somehow failed to generate a loop cover message with a valid topology",
|
"Somehow failed to generate a loop cover message with a valid topology",
|
||||||
@@ -291,7 +286,7 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn current_average_message_sending_delay(&self) -> Duration {
|
fn current_average_message_sending_delay(&self) -> Duration {
|
||||||
self.config.traffic.message_sending_average_delay
|
self.config.average_message_sending_delay
|
||||||
* self.sending_delay_controller.current_multiplier()
|
* self.sending_delay_controller.current_multiplier()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -302,34 +297,24 @@ where
|
|||||||
self.sending_delay_controller.current_multiplier()
|
self.sending_delay_controller.current_multiplier()
|
||||||
);
|
);
|
||||||
|
|
||||||
if self
|
// Even just a single used slot is enough to signal backpressure
|
||||||
.sending_delay_controller
|
if used_slots > 0 {
|
||||||
.is_backpressure_currently_detected(used_slots)
|
|
||||||
{
|
|
||||||
log::trace!("Backpressure detected");
|
log::trace!("Backpressure detected");
|
||||||
self.sending_delay_controller.record_backpressure_detected();
|
self.sending_delay_controller.record_backpressure_detected();
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the buffer is running out, slow down the sending rate by increasing the delay
|
// If the buffer is running out, slow down the sending rate
|
||||||
// multiplier.
|
|
||||||
if self.mix_tx.capacity() == 0
|
if self.mix_tx.capacity() == 0
|
||||||
&& self.sending_delay_controller.not_increased_delay_recently()
|
&& self.sending_delay_controller.not_increased_delay_recently()
|
||||||
{
|
{
|
||||||
self.sending_delay_controller.increase_delay_multiplier();
|
self.sending_delay_controller.increase_delay_multiplier();
|
||||||
}
|
}
|
||||||
|
|
||||||
// If it looks like we are sending reliably, increase the sending rate by decreasing the
|
// Very carefully step up the sending rate in case it seems like we can solidly handle the
|
||||||
// sending delay multiplier.
|
// current rate.
|
||||||
if !self
|
if self.sending_delay_controller.is_sending_reliable() {
|
||||||
.sending_delay_controller
|
|
||||||
.was_backpressure_detected_recently()
|
|
||||||
&& self.sending_delay_controller.not_decreased_delay_recently()
|
|
||||||
{
|
|
||||||
self.sending_delay_controller.decrease_delay_multiplier();
|
self.sending_delay_controller.decrease_delay_multiplier();
|
||||||
}
|
}
|
||||||
|
|
||||||
// Keep track of multiplier changes, and log if necessary.
|
|
||||||
self.sending_delay_controller.record_delay_multiplier();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn pop_next_message(&mut self) -> Option<RealMessage> {
|
fn pop_next_message(&mut self) -> Option<RealMessage> {
|
||||||
@@ -415,10 +400,8 @@ where
|
|||||||
// we never set an initial delay - let's do it now
|
// we never set an initial delay - let's do it now
|
||||||
cx.waker().wake_by_ref();
|
cx.waker().wake_by_ref();
|
||||||
|
|
||||||
let sampled = sample_poisson_duration(
|
let sampled =
|
||||||
&mut self.rng,
|
sample_poisson_duration(&mut self.rng, self.config.average_message_sending_delay);
|
||||||
self.config.traffic.message_sending_average_delay,
|
|
||||||
);
|
|
||||||
|
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
let next_delay = Box::pin(time::sleep(sampled));
|
let next_delay = Box::pin(time::sleep(sampled));
|
||||||
@@ -469,7 +452,7 @@ where
|
|||||||
mut self: Pin<&mut Self>,
|
mut self: Pin<&mut Self>,
|
||||||
cx: &mut Context<'_>,
|
cx: &mut Context<'_>,
|
||||||
) -> Poll<Option<StreamMessage>> {
|
) -> Poll<Option<StreamMessage>> {
|
||||||
if self.config.traffic.disable_main_poisson_packet_distribution {
|
if self.config.disable_poisson_packet_distribution {
|
||||||
self.poll_immediate(cx)
|
self.poll_immediate(cx)
|
||||||
} else {
|
} else {
|
||||||
self.poll_poisson(cx)
|
self.poll_poisson(cx)
|
||||||
@@ -485,7 +468,7 @@ where
|
|||||||
let lanes = self.transmission_buffer.num_lanes();
|
let lanes = self.transmission_buffer.num_lanes();
|
||||||
let mult = self.sending_delay_controller.current_multiplier();
|
let mult = self.sending_delay_controller.current_multiplier();
|
||||||
let delay = self.current_average_message_sending_delay().as_millis();
|
let delay = self.current_average_message_sending_delay().as_millis();
|
||||||
let status_str = if self.config.traffic.disable_main_poisson_packet_distribution {
|
let status_str = if self.config.disable_poisson_packet_distribution {
|
||||||
format!("Status: {lanes} lanes, backlog: {backlog:.2} kiB ({packets}), no delay")
|
format!("Status: {lanes} lanes, backlog: {backlog:.2} kiB ({packets}), no delay")
|
||||||
} else {
|
} else {
|
||||||
format!(
|
format!(
|
||||||
@@ -508,12 +491,23 @@ where
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
|
fn log_status_infrequent(&self) {
|
||||||
|
if self.sending_delay_controller.current_multiplier() > 1 {
|
||||||
|
log::warn!(
|
||||||
|
"Unable to send packets at the default rate - rate reduced by setting the delay multiplier set to: {}",
|
||||||
|
self.sending_delay_controller.current_multiplier()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub(super) async fn run_with_shutdown(&mut self, mut shutdown: nym_task::TaskClient) {
|
pub(super) async fn run_with_shutdown(&mut self, mut shutdown: nym_task::TaskClient) {
|
||||||
debug!("Started OutQueueControl with graceful shutdown support");
|
debug!("Started OutQueueControl with graceful shutdown support");
|
||||||
|
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
{
|
{
|
||||||
let mut status_timer = tokio::time::interval(Duration::from_secs(5));
|
let mut status_timer = tokio::time::interval(Duration::from_secs(5));
|
||||||
|
let mut infrequent_status_timer = tokio::time::interval(Duration::from_secs(60));
|
||||||
|
|
||||||
while !shutdown.is_shutdown() {
|
while !shutdown.is_shutdown() {
|
||||||
tokio::select! {
|
tokio::select! {
|
||||||
@@ -524,6 +518,9 @@ where
|
|||||||
_ = status_timer.tick() => {
|
_ = status_timer.tick() => {
|
||||||
self.log_status(&mut shutdown);
|
self.log_status(&mut shutdown);
|
||||||
}
|
}
|
||||||
|
_ = infrequent_status_timer.tick() => {
|
||||||
|
self.log_status_infrequent();
|
||||||
|
}
|
||||||
next_message = self.next() => if let Some(next_message) = next_message {
|
next_message = self.next() => if let Some(next_message) = next_message {
|
||||||
self.on_message(next_message).await;
|
self.on_message(next_message).await;
|
||||||
} else {
|
} else {
|
||||||
+16
-68
@@ -11,20 +11,15 @@ const INCREASE_DELAY_MIN_CHANGE_INTERVAL_SECS: u64 = 1;
|
|||||||
// The minimum time between decreasing the average delay between packets. We don't want to change
|
// The minimum time between decreasing the average delay between packets. We don't want to change
|
||||||
// to quickly to keep things somewhat stable. Also there are buffers downstreams meaning we need to
|
// to quickly to keep things somewhat stable. Also there are buffers downstreams meaning we need to
|
||||||
// wait a little to see the effect before we decrease further.
|
// wait a little to see the effect before we decrease further.
|
||||||
const DECREASE_DELAY_MIN_CHANGE_INTERVAL_SECS: u64 = 2;
|
const DECREASE_DELAY_MIN_CHANGE_INTERVAL_SECS: u64 = 30;
|
||||||
// The queue length that is required for us to register that backpressure occured. If there are
|
|
||||||
// more than this many packets waiting to be sent, we consider the channel to be under
|
|
||||||
// backpressure.
|
|
||||||
const BACKPRESSURE_THRESHOLD: usize = 10;
|
|
||||||
// If we enough time passes without any sign of backpressure in the channel, we can consider
|
// If we enough time passes without any sign of backpressure in the channel, we can consider
|
||||||
// lowering the average delay.
|
// lowering the average delay. The goal is to keep somewhat stable, rather than maxing out
|
||||||
const ACCEPTABLE_TIME_WITHOUT_BACKPRESSURE_SECS: u64 = 2;
|
// bandwidth at all times.
|
||||||
|
const ACCEPTABLE_TIME_WITHOUT_BACKPRESSURE_SECS: u64 = 30;
|
||||||
// The maximum multiplier we apply to the base average Poisson delay.
|
// The maximum multiplier we apply to the base average Poisson delay.
|
||||||
const MAX_DELAY_MULTIPLIER: u32 = 6;
|
const MAX_DELAY_MULTIPLIER: u32 = 6;
|
||||||
// The minium multiplier we apply to the base average Poisson delay.
|
// The minium multiplier we apply to the base average Poisson delay.
|
||||||
const MIN_DELAY_MULTIPLIER: u32 = 1;
|
const MIN_DELAY_MULTIPLIER: u32 = 1;
|
||||||
// If the multipler increases we log it, but we don't want to log about it too often.
|
|
||||||
const INTERVAL_BETWEEN_WARNING_ABOUT_ELEVATED_MULTIPLIER_SECS: u64 = 60;
|
|
||||||
|
|
||||||
pub(crate) struct SendingDelayController {
|
pub(crate) struct SendingDelayController {
|
||||||
/// Multiply the average sending delay.
|
/// Multiply the average sending delay.
|
||||||
@@ -38,14 +33,6 @@ pub(crate) struct SendingDelayController {
|
|||||||
/// Minimum delay multiplier
|
/// Minimum delay multiplier
|
||||||
lower_bound: u32,
|
lower_bound: u32,
|
||||||
|
|
||||||
/// We counter the number of times the multiplier has been elevated. If it is elevated for long
|
|
||||||
/// enough we need to log about it.
|
|
||||||
multiplier_elevated_counter: u32,
|
|
||||||
|
|
||||||
/// We can't log about the elevated multiplier too often, so we keep track of the last time we
|
|
||||||
/// did,
|
|
||||||
time_when_logged_about_elevated_multiplier: Instant,
|
|
||||||
|
|
||||||
/// To make sure we don't change the multiplier to fast, we limit a change to some duration
|
/// To make sure we don't change the multiplier to fast, we limit a change to some duration
|
||||||
time_when_changed: Instant,
|
time_when_changed: Instant,
|
||||||
|
|
||||||
@@ -68,9 +55,6 @@ impl SendingDelayController {
|
|||||||
current_multiplier: MIN_DELAY_MULTIPLIER,
|
current_multiplier: MIN_DELAY_MULTIPLIER,
|
||||||
upper_bound,
|
upper_bound,
|
||||||
lower_bound,
|
lower_bound,
|
||||||
multiplier_elevated_counter: 0,
|
|
||||||
time_when_logged_about_elevated_multiplier: now
|
|
||||||
- Duration::from_secs(INTERVAL_BETWEEN_WARNING_ABOUT_ELEVATED_MULTIPLIER_SECS),
|
|
||||||
time_when_changed: now,
|
time_when_changed: now,
|
||||||
time_when_backpressure_detected: now,
|
time_when_backpressure_detected: now,
|
||||||
}
|
}
|
||||||
@@ -95,7 +79,7 @@ impl SendingDelayController {
|
|||||||
self.current_multiplier =
|
self.current_multiplier =
|
||||||
(self.current_multiplier + 1).clamp(self.lower_bound, self.upper_bound);
|
(self.current_multiplier + 1).clamp(self.lower_bound, self.upper_bound);
|
||||||
self.time_when_changed = get_time_now();
|
self.time_when_changed = get_time_now();
|
||||||
log::debug!(
|
log::warn!(
|
||||||
"Increasing sending delay multiplier to: {}",
|
"Increasing sending delay multiplier to: {}",
|
||||||
self.current_multiplier
|
self.current_multiplier
|
||||||
);
|
);
|
||||||
@@ -116,58 +100,22 @@ impl SendingDelayController {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub(crate) fn record_backpressure_detected(&mut self) {
|
||||||
|
self.time_when_backpressure_detected = get_time_now();
|
||||||
|
}
|
||||||
|
|
||||||
pub(crate) fn not_increased_delay_recently(&self) -> bool {
|
pub(crate) fn not_increased_delay_recently(&self) -> bool {
|
||||||
get_time_now()
|
get_time_now()
|
||||||
> self.time_when_changed + Duration::from_secs(INCREASE_DELAY_MIN_CHANGE_INTERVAL_SECS)
|
> self.time_when_changed + Duration::from_secs(INCREASE_DELAY_MIN_CHANGE_INTERVAL_SECS)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn not_decreased_delay_recently(&self) -> bool {
|
pub(crate) fn is_sending_reliable(&self) -> bool {
|
||||||
get_time_now()
|
|
||||||
> self.time_when_changed + Duration::from_secs(DECREASE_DELAY_MIN_CHANGE_INTERVAL_SECS)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn is_backpressure_currently_detected(&self, queue_length: usize) -> bool {
|
|
||||||
queue_length > BACKPRESSURE_THRESHOLD
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn record_backpressure_detected(&mut self) {
|
|
||||||
self.time_when_backpressure_detected = get_time_now();
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn was_backpressure_detected_recently(&self) -> bool {
|
|
||||||
get_time_now()
|
|
||||||
< self.time_when_backpressure_detected
|
|
||||||
+ Duration::from_secs(ACCEPTABLE_TIME_WITHOUT_BACKPRESSURE_SECS)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn record_delay_multiplier(&mut self) {
|
|
||||||
// Count the number of times the multiplier has been elevated.
|
|
||||||
let multiplier_elevated = self.current_multiplier - self.lower_bound;
|
|
||||||
if multiplier_elevated == 0 {
|
|
||||||
self.multiplier_elevated_counter = 0;
|
|
||||||
} else {
|
|
||||||
self.multiplier_elevated_counter += 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// If needed, log about the elevated multiplier.
|
|
||||||
let now = get_time_now();
|
let now = get_time_now();
|
||||||
if self.multiplier_elevated_counter > 20
|
let delay_change_interval = Duration::from_secs(DECREASE_DELAY_MIN_CHANGE_INTERVAL_SECS);
|
||||||
&& now
|
let acceptable_time_without_backpressure =
|
||||||
> self.time_when_logged_about_elevated_multiplier
|
Duration::from_secs(ACCEPTABLE_TIME_WITHOUT_BACKPRESSURE_SECS);
|
||||||
+ Duration::from_secs(INTERVAL_BETWEEN_WARNING_ABOUT_ELEVATED_MULTIPLIER_SECS)
|
|
||||||
{
|
now > self.time_when_backpressure_detected + acceptable_time_without_backpressure
|
||||||
let status_str = format!(
|
&& now > self.time_when_changed + delay_change_interval
|
||||||
"Poisson delay currently scaled by: {}",
|
|
||||||
self.current_multiplier()
|
|
||||||
);
|
|
||||||
if self.current_multiplier() > 0 {
|
|
||||||
log::debug!("{}", status_str);
|
|
||||||
} else if self.current_multiplier() > 1 {
|
|
||||||
log::info!("{}", status_str);
|
|
||||||
} else if self.current_multiplier() > 2 {
|
|
||||||
log::warn!("{}", status_str);
|
|
||||||
}
|
|
||||||
self.time_when_logged_about_elevated_multiplier = now;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+29
-41
@@ -7,10 +7,10 @@ use crate::spawn_future;
|
|||||||
use futures::channel::mpsc;
|
use futures::channel::mpsc;
|
||||||
use futures::lock::Mutex;
|
use futures::lock::Mutex;
|
||||||
use futures::StreamExt;
|
use futures::StreamExt;
|
||||||
|
use gateway_client::MixnetMessageReceiver;
|
||||||
use log::*;
|
use log::*;
|
||||||
use nym_crypto::asymmetric::encryption;
|
use nym_crypto::asymmetric::encryption;
|
||||||
use nym_crypto::Digest;
|
use nym_crypto::Digest;
|
||||||
use nym_gateway_client::MixnetMessageReceiver;
|
|
||||||
use nym_sphinx::anonymous_replies::requests::{
|
use nym_sphinx::anonymous_replies::requests::{
|
||||||
RepliableMessage, RepliableMessageContent, ReplyMessage, ReplyMessageContent,
|
RepliableMessage, RepliableMessageContent, ReplyMessage, ReplyMessageContent,
|
||||||
};
|
};
|
||||||
@@ -30,13 +30,13 @@ pub type ReceivedBufferRequestReceiver = mpsc::UnboundedReceiver<ReceivedBufferM
|
|||||||
pub type ReconstructedMessagesSender = mpsc::UnboundedSender<Vec<ReconstructedMessage>>;
|
pub type ReconstructedMessagesSender = mpsc::UnboundedSender<Vec<ReconstructedMessage>>;
|
||||||
pub type ReconstructedMessagesReceiver = mpsc::UnboundedReceiver<Vec<ReconstructedMessage>>;
|
pub type ReconstructedMessagesReceiver = mpsc::UnboundedReceiver<Vec<ReconstructedMessage>>;
|
||||||
|
|
||||||
struct ReceivedMessagesBufferInner<R: MessageReceiver> {
|
struct ReceivedMessagesBufferInner {
|
||||||
messages: Vec<ReconstructedMessage>,
|
messages: Vec<ReconstructedMessage>,
|
||||||
local_encryption_keypair: Arc<encryption::KeyPair>,
|
local_encryption_keypair: Arc<encryption::KeyPair>,
|
||||||
|
|
||||||
// TODO: looking how it 'looks' here, perhaps `MessageReceiver` should be renamed to something
|
// TODO: looking how it 'looks' here, perhaps `MessageReceiver` should be renamed to something
|
||||||
// else instead.
|
// else instead.
|
||||||
message_receiver: R,
|
message_receiver: MessageReceiver,
|
||||||
message_sender: Option<ReconstructedMessagesSender>,
|
message_sender: Option<ReconstructedMessagesSender>,
|
||||||
|
|
||||||
// TODO: this will get cleared upon re-running the client
|
// TODO: this will get cleared upon re-running the client
|
||||||
@@ -45,7 +45,7 @@ struct ReceivedMessagesBufferInner<R: MessageReceiver> {
|
|||||||
recently_reconstructed: HashSet<i32>,
|
recently_reconstructed: HashSet<i32>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R: MessageReceiver> ReceivedMessagesBufferInner<R> {
|
impl ReceivedMessagesBufferInner {
|
||||||
fn recover_from_fragment(&mut self, fragment_data: &[u8]) -> Option<NymMessage> {
|
fn recover_from_fragment(&mut self, fragment_data: &[u8]) -> Option<NymMessage> {
|
||||||
if nym_sphinx::cover::is_cover(fragment_data) {
|
if nym_sphinx::cover::is_cover(fragment_data) {
|
||||||
trace!("The message was a loop cover message! Skipping it");
|
trace!("The message was a loop cover message! Skipping it");
|
||||||
@@ -102,13 +102,13 @@ impl<R: MessageReceiver> ReceivedMessagesBufferInner<R> {
|
|||||||
&mut self,
|
&mut self,
|
||||||
reply_ciphertext: &mut [u8],
|
reply_ciphertext: &mut [u8],
|
||||||
reply_key: SurbEncryptionKey,
|
reply_key: SurbEncryptionKey,
|
||||||
) -> Result<Option<NymMessage>, MessageRecoveryError> {
|
) -> Option<NymMessage> {
|
||||||
// note: this performs decryption IN PLACE without extra allocation
|
// note: this performs decryption IN PLACE without extra allocation
|
||||||
self.message_receiver
|
self.message_receiver
|
||||||
.recover_plaintext_from_reply(reply_ciphertext, reply_key)?;
|
.recover_plaintext_from_reply(reply_ciphertext, reply_key);
|
||||||
let fragment_data = reply_ciphertext;
|
let fragment_data = reply_ciphertext;
|
||||||
|
|
||||||
Ok(self.recover_from_fragment(fragment_data))
|
self.recover_from_fragment(fragment_data)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn process_received_regular_packet(&mut self, mut raw_fragment: Vec<u8>) -> Option<NymMessage> {
|
fn process_received_regular_packet(&mut self, mut raw_fragment: Vec<u8>) -> Option<NymMessage> {
|
||||||
@@ -130,13 +130,13 @@ impl<R: MessageReceiver> ReceivedMessagesBufferInner<R> {
|
|||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
// Note: you should NEVER create more than a single instance of this using 'new()'.
|
// Note: you should NEVER create more than a single instance of this using 'new()'.
|
||||||
// You should always use .clone() to create additional instances
|
// You should always use .clone() to create additional instances
|
||||||
struct ReceivedMessagesBuffer<R: MessageReceiver> {
|
struct ReceivedMessagesBuffer {
|
||||||
inner: Arc<Mutex<ReceivedMessagesBufferInner<R>>>,
|
inner: Arc<Mutex<ReceivedMessagesBufferInner>>,
|
||||||
reply_key_storage: SentReplyKeys,
|
reply_key_storage: SentReplyKeys,
|
||||||
reply_controller_sender: ReplyControllerSender,
|
reply_controller_sender: ReplyControllerSender,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R: MessageReceiver> ReceivedMessagesBuffer<R> {
|
impl ReceivedMessagesBuffer {
|
||||||
fn new(
|
fn new(
|
||||||
local_encryption_keypair: Arc<encryption::KeyPair>,
|
local_encryption_keypair: Arc<encryption::KeyPair>,
|
||||||
reply_key_storage: SentReplyKeys,
|
reply_key_storage: SentReplyKeys,
|
||||||
@@ -146,7 +146,7 @@ impl<R: MessageReceiver> ReceivedMessagesBuffer<R> {
|
|||||||
inner: Arc::new(Mutex::new(ReceivedMessagesBufferInner {
|
inner: Arc::new(Mutex::new(ReceivedMessagesBufferInner {
|
||||||
messages: Vec::new(),
|
messages: Vec::new(),
|
||||||
local_encryption_keypair,
|
local_encryption_keypair,
|
||||||
message_receiver: R::new(),
|
message_receiver: MessageReceiver::new(),
|
||||||
message_sender: None,
|
message_sender: None,
|
||||||
recently_reconstructed: HashSet::new(),
|
recently_reconstructed: HashSet::new(),
|
||||||
})),
|
})),
|
||||||
@@ -328,10 +328,7 @@ impl<R: MessageReceiver> ReceivedMessagesBuffer<R> {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn handle_new_received(
|
async fn handle_new_received(&mut self, msgs: Vec<Vec<u8>>) {
|
||||||
&mut self,
|
|
||||||
msgs: Vec<Vec<u8>>,
|
|
||||||
) -> Result<(), MessageRecoveryError> {
|
|
||||||
trace!(
|
trace!(
|
||||||
"Processing {:?} new message that might get added to the buffer!",
|
"Processing {:?} new message that might get added to the buffer!",
|
||||||
msgs.len()
|
msgs.len()
|
||||||
@@ -347,7 +344,7 @@ impl<R: MessageReceiver> ReceivedMessagesBuffer<R> {
|
|||||||
// if yes - this is a reply message
|
// if yes - this is a reply message
|
||||||
let completed_message =
|
let completed_message =
|
||||||
if let Some((reply_key, reply_message)) = self.get_reply_key(&mut msg) {
|
if let Some((reply_key, reply_message)) = self.get_reply_key(&mut msg) {
|
||||||
inner_guard.process_received_reply(reply_message, reply_key)?
|
inner_guard.process_received_reply(reply_message, reply_key)
|
||||||
} else {
|
} else {
|
||||||
inner_guard.process_received_regular_packet(msg)
|
inner_guard.process_received_regular_packet(msg)
|
||||||
};
|
};
|
||||||
@@ -363,7 +360,6 @@ impl<R: MessageReceiver> ReceivedMessagesBuffer<R> {
|
|||||||
if !completed_messages.is_empty() {
|
if !completed_messages.is_empty() {
|
||||||
self.handle_reconstructed_messages(completed_messages).await
|
self.handle_reconstructed_messages(completed_messages).await
|
||||||
}
|
}
|
||||||
Ok(())
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -376,14 +372,14 @@ pub enum ReceivedBufferMessage {
|
|||||||
ReceiverDisconnect,
|
ReceiverDisconnect,
|
||||||
}
|
}
|
||||||
|
|
||||||
struct RequestReceiver<R: MessageReceiver> {
|
struct RequestReceiver {
|
||||||
received_buffer: ReceivedMessagesBuffer<R>,
|
received_buffer: ReceivedMessagesBuffer,
|
||||||
query_receiver: ReceivedBufferRequestReceiver,
|
query_receiver: ReceivedBufferRequestReceiver,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R: MessageReceiver> RequestReceiver<R> {
|
impl RequestReceiver {
|
||||||
fn new(
|
fn new(
|
||||||
received_buffer: ReceivedMessagesBuffer<R>,
|
received_buffer: ReceivedMessagesBuffer,
|
||||||
query_receiver: ReceivedBufferRequestReceiver,
|
query_receiver: ReceivedBufferRequestReceiver,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
RequestReceiver {
|
RequestReceiver {
|
||||||
@@ -426,14 +422,14 @@ impl<R: MessageReceiver> RequestReceiver<R> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
struct FragmentedMessageReceiver<R: MessageReceiver> {
|
struct FragmentedMessageReceiver {
|
||||||
received_buffer: ReceivedMessagesBuffer<R>,
|
received_buffer: ReceivedMessagesBuffer,
|
||||||
mixnet_packet_receiver: MixnetMessageReceiver,
|
mixnet_packet_receiver: MixnetMessageReceiver,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R: MessageReceiver> FragmentedMessageReceiver<R> {
|
impl FragmentedMessageReceiver {
|
||||||
fn new(
|
fn new(
|
||||||
received_buffer: ReceivedMessagesBuffer<R>,
|
received_buffer: ReceivedMessagesBuffer,
|
||||||
mixnet_packet_receiver: MixnetMessageReceiver,
|
mixnet_packet_receiver: MixnetMessageReceiver,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
FragmentedMessageReceiver {
|
FragmentedMessageReceiver {
|
||||||
@@ -442,16 +438,13 @@ impl<R: MessageReceiver> FragmentedMessageReceiver<R> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn run_with_shutdown(
|
async fn run_with_shutdown(&mut self, mut shutdown: nym_task::TaskClient) {
|
||||||
&mut self,
|
|
||||||
mut shutdown: nym_task::TaskClient,
|
|
||||||
) -> Result<(), MessageRecoveryError> {
|
|
||||||
debug!("Started FragmentedMessageReceiver with graceful shutdown support");
|
debug!("Started FragmentedMessageReceiver with graceful shutdown support");
|
||||||
while !shutdown.is_shutdown() {
|
while !shutdown.is_shutdown() {
|
||||||
tokio::select! {
|
tokio::select! {
|
||||||
new_messages = self.mixnet_packet_receiver.next() => {
|
new_messages = self.mixnet_packet_receiver.next() => {
|
||||||
if let Some(new_messages) = new_messages {
|
if let Some(new_messages) = new_messages {
|
||||||
self.received_buffer.handle_new_received(new_messages).await?;
|
self.received_buffer.handle_new_received(new_messages).await;
|
||||||
} else {
|
} else {
|
||||||
log::trace!("FragmentedMessageReceiver: Stopping since channel closed");
|
log::trace!("FragmentedMessageReceiver: Stopping since channel closed");
|
||||||
break;
|
break;
|
||||||
@@ -464,16 +457,15 @@ impl<R: MessageReceiver> FragmentedMessageReceiver<R> {
|
|||||||
}
|
}
|
||||||
shutdown.recv_timeout().await;
|
shutdown.recv_timeout().await;
|
||||||
log::debug!("FragmentedMessageReceiver: Exiting");
|
log::debug!("FragmentedMessageReceiver: Exiting");
|
||||||
Ok(())
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) struct ReceivedMessagesBufferController<R: MessageReceiver> {
|
pub(crate) struct ReceivedMessagesBufferController {
|
||||||
fragmented_message_receiver: FragmentedMessageReceiver<R>,
|
fragmented_message_receiver: FragmentedMessageReceiver,
|
||||||
request_receiver: RequestReceiver<R>,
|
request_receiver: RequestReceiver,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R: MessageReceiver + Clone + Send + 'static> ReceivedMessagesBufferController<R> {
|
impl ReceivedMessagesBufferController {
|
||||||
pub(crate) fn new(
|
pub(crate) fn new(
|
||||||
local_encryption_keypair: Arc<encryption::KeyPair>,
|
local_encryption_keypair: Arc<encryption::KeyPair>,
|
||||||
query_receiver: ReceivedBufferRequestReceiver,
|
query_receiver: ReceivedBufferRequestReceiver,
|
||||||
@@ -502,13 +494,9 @@ impl<R: MessageReceiver + Clone + Send + 'static> ReceivedMessagesBufferControll
|
|||||||
|
|
||||||
let shutdown_handle = shutdown.clone();
|
let shutdown_handle = shutdown.clone();
|
||||||
spawn_future(async move {
|
spawn_future(async move {
|
||||||
match fragmented_message_receiver
|
fragmented_message_receiver
|
||||||
.run_with_shutdown(shutdown_handle)
|
.run_with_shutdown(shutdown_handle)
|
||||||
.await
|
.await;
|
||||||
{
|
|
||||||
Ok(_) => {}
|
|
||||||
Err(e) => error!("{e}"),
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
spawn_future(async move {
|
spawn_future(async move {
|
||||||
request_receiver.run_with_shutdown(shutdown).await;
|
request_receiver.run_with_shutdown(shutdown).await;
|
||||||
+33
-36
@@ -22,21 +22,38 @@ use time::OffsetDateTime;
|
|||||||
|
|
||||||
use crate::client::helpers::new_interval_stream;
|
use crate::client::helpers::new_interval_stream;
|
||||||
use crate::client::transmission_buffer::TransmissionBuffer;
|
use crate::client::transmission_buffer::TransmissionBuffer;
|
||||||
use crate::config;
|
|
||||||
pub(crate) use requests::{ReplyControllerMessage, ReplyControllerReceiver, ReplyControllerSender};
|
pub(crate) use requests::{ReplyControllerMessage, ReplyControllerReceiver, ReplyControllerSender};
|
||||||
|
|
||||||
pub mod requests;
|
pub mod requests;
|
||||||
|
|
||||||
// this is still left as a separate config so I wouldn't need to replace it everywhere
|
|
||||||
// plus its not unreasonable to think that we might need something outside config::ReplySurbs struct
|
|
||||||
pub struct Config {
|
pub struct Config {
|
||||||
reply_surbs: config::ReplySurbs,
|
min_surb_request_size: u32,
|
||||||
|
max_surb_request_size: u32,
|
||||||
|
maximum_allowed_reply_surb_request_size: u32,
|
||||||
|
max_surb_rerequest_waiting_period: Duration,
|
||||||
|
max_surb_drop_waiting_period: Duration,
|
||||||
|
max_reply_surb_age: Duration,
|
||||||
|
max_reply_key_age: Duration,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Config {
|
impl Config {
|
||||||
pub(crate) fn new(reply_surbs_cfg: config::ReplySurbs) -> Self {
|
pub(crate) fn new(
|
||||||
|
min_surb_request_size: u32,
|
||||||
|
max_surb_request_size: u32,
|
||||||
|
maximum_allowed_reply_surb_request_size: u32,
|
||||||
|
max_surb_rerequest_waiting_period: Duration,
|
||||||
|
max_surb_drop_waiting_period: Duration,
|
||||||
|
max_reply_surb_age: Duration,
|
||||||
|
max_reply_key_age: Duration,
|
||||||
|
) -> Self {
|
||||||
Self {
|
Self {
|
||||||
reply_surbs: reply_surbs_cfg,
|
min_surb_request_size,
|
||||||
|
max_surb_request_size,
|
||||||
|
maximum_allowed_reply_surb_request_size,
|
||||||
|
max_surb_rerequest_waiting_period,
|
||||||
|
max_surb_drop_waiting_period,
|
||||||
|
max_reply_surb_age,
|
||||||
|
max_reply_key_age,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -492,17 +509,9 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
// 2. check whether the requested amount is within sane range
|
// 2. check whether the requested amount is within sane range
|
||||||
if amount
|
if amount > self.config.maximum_allowed_reply_surb_request_size {
|
||||||
> self
|
warn!("The requested reply surb amount is larger than our maximum allowed ({amount} > {}). Lowering it to a more sane value...", self.config.maximum_allowed_reply_surb_request_size);
|
||||||
.config
|
amount = self.config.maximum_allowed_reply_surb_request_size;
|
||||||
.reply_surbs
|
|
||||||
.maximum_allowed_reply_surb_request_size
|
|
||||||
{
|
|
||||||
warn!("The requested reply surb amount is larger than our maximum allowed ({amount} > {}). Lowering it to a more sane value...", self.config.reply_surbs.maximum_allowed_reply_surb_request_size);
|
|
||||||
amount = self
|
|
||||||
.config
|
|
||||||
.reply_surbs
|
|
||||||
.maximum_allowed_reply_surb_request_size;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// 3. construct and send the surbs away
|
// 3. construct and send the surbs away
|
||||||
@@ -698,11 +707,8 @@ where
|
|||||||
}
|
}
|
||||||
|
|
||||||
let request_size = min(
|
let request_size = min(
|
||||||
self.config.reply_surbs.maximum_reply_surb_request_size,
|
self.config.max_surb_request_size,
|
||||||
max(
|
max(total_queue, self.config.min_surb_request_size),
|
||||||
total_queue,
|
|
||||||
self.config.reply_surbs.minimum_reply_surb_request_size,
|
|
||||||
),
|
|
||||||
);
|
);
|
||||||
|
|
||||||
if let Err(err) = self
|
if let Err(err) = self
|
||||||
@@ -738,17 +744,9 @@ where
|
|||||||
};
|
};
|
||||||
|
|
||||||
let diff = now - last_received_time;
|
let diff = now - last_received_time;
|
||||||
let max_rerequest_wait = self
|
|
||||||
.config
|
|
||||||
.reply_surbs
|
|
||||||
.maximum_reply_surb_rerequest_waiting_period;
|
|
||||||
let max_drop_wait = self
|
|
||||||
.config
|
|
||||||
.reply_surbs
|
|
||||||
.maximum_reply_surb_drop_waiting_period;
|
|
||||||
|
|
||||||
if diff > max_rerequest_wait {
|
if diff > self.config.max_surb_rerequest_waiting_period {
|
||||||
if diff > max_drop_wait {
|
if diff > self.config.max_surb_drop_waiting_period {
|
||||||
to_remove.push(*pending_reply_target)
|
to_remove.push(*pending_reply_target)
|
||||||
} else {
|
} else {
|
||||||
debug!("We haven't received any surbs in {:?} from {pending_reply_target}. Going to explicitly ask for more", diff);
|
debug!("We haven't received any surbs in {:?} from {pending_reply_target}. Going to explicitly ask for more", diff);
|
||||||
@@ -795,7 +793,7 @@ where
|
|||||||
};
|
};
|
||||||
let diff = now - last_received_time;
|
let diff = now - last_received_time;
|
||||||
|
|
||||||
if diff > self.config.reply_surbs.maximum_reply_surb_age {
|
if diff > self.config.max_reply_surb_age {
|
||||||
info!("it's been {diff:?} since we last received any reply surb from {sender}. Going to remove all stored entries...");
|
info!("it's been {diff:?} since we last received any reply surb from {sender}. Going to remove all stored entries...");
|
||||||
|
|
||||||
to_remove_surbs.push(*sender);
|
to_remove_surbs.push(*sender);
|
||||||
@@ -815,7 +813,7 @@ where
|
|||||||
|
|
||||||
let diff = now - sent_at;
|
let diff = now - sent_at;
|
||||||
|
|
||||||
if diff > self.config.reply_surbs.maximum_reply_key_age {
|
if diff > self.config.max_reply_key_age {
|
||||||
debug!("it's been {diff:?} since we created this reply key. it's probably never going to get used, so we're going to purge it...");
|
debug!("it's been {diff:?} since we created this reply key. it's probably never going to get used, so we're going to purge it...");
|
||||||
to_remove_keys.push(*digest);
|
to_remove_keys.push(*digest);
|
||||||
}
|
}
|
||||||
@@ -844,8 +842,7 @@ where
|
|||||||
let mut stale_inspection = new_interval_stream(polling_rate);
|
let mut stale_inspection = new_interval_stream(polling_rate);
|
||||||
|
|
||||||
// this is in the order of hours/days so we don't have to poll it that often
|
// this is in the order of hours/days so we don't have to poll it that often
|
||||||
let polling_rate =
|
let polling_rate = Duration::from_secs(self.config.max_reply_surb_age.as_secs() / 10);
|
||||||
Duration::from_secs(self.config.reply_surbs.maximum_reply_surb_age.as_secs() / 10);
|
|
||||||
let mut invalidation_inspection = new_interval_stream(polling_rate);
|
let mut invalidation_inspection = new_interval_stream(polling_rate);
|
||||||
|
|
||||||
while !shutdown.is_shutdown() {
|
while !shutdown.is_shutdown() {
|
||||||
+2
-6
@@ -35,12 +35,8 @@ impl ReplyStorageBackend for Backend {
|
|||||||
) -> Result<Self, Self::StorageError> {
|
) -> Result<Self, Self::StorageError> {
|
||||||
Ok(Backend {
|
Ok(Backend {
|
||||||
empty: Empty {
|
empty: Empty {
|
||||||
min_surb_threshold: debug_config
|
min_surb_threshold: debug_config.minimum_reply_surb_storage_threshold,
|
||||||
.reply_surbs
|
max_surb_threshold: debug_config.maximum_reply_surb_storage_threshold,
|
||||||
.minimum_reply_surb_storage_threshold,
|
|
||||||
max_surb_threshold: debug_config
|
|
||||||
.reply_surbs
|
|
||||||
.maximum_reply_surb_storage_threshold,
|
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
+6
-9
@@ -155,21 +155,18 @@ impl Backend {
|
|||||||
// (assuming no key rotation has happened)
|
// (assuming no key rotation has happened)
|
||||||
// but the way it's currently coded, everyone will purge old data
|
// but the way it's currently coded, everyone will purge old data
|
||||||
let since_last_flush = OffsetDateTime::now_utc() - last_flush;
|
let since_last_flush = OffsetDateTime::now_utc() - last_flush;
|
||||||
let days = since_last_flush.whole_days();
|
if since_last_flush.whole_days() > 0 {
|
||||||
let hours = since_last_flush.whole_hours() % 24;
|
info!("it's been over {} days and {} hours since we last used our data store. our reply surbs are already outdated - we're going to purge them now.", since_last_flush.whole_days(), since_last_flush.whole_hours());
|
||||||
|
|
||||||
if days > 0 {
|
|
||||||
info!("it's been over {days} days and {hours} hours since we last used our data store. our reply surbs are already outdated - we're going to purge them now.");
|
|
||||||
manager.delete_all_reply_surb_data().await?;
|
manager.delete_all_reply_surb_data().await?;
|
||||||
}
|
}
|
||||||
|
|
||||||
if days > 1 {
|
if since_last_flush.whole_days() > 1 {
|
||||||
info!("it's been over {days} days and {hours} hours since we last used our data store. our reply keys are already outdated - we're going to purge them now.");
|
info!("it's been over {} days and {} hours since we last used our data store. our reply keys are already outdated - we're going to purge them now.", since_last_flush.whole_days(), since_last_flush.whole_hours());
|
||||||
manager.delete_all_reply_keys().await?;
|
manager.delete_all_reply_keys().await?;
|
||||||
}
|
}
|
||||||
|
|
||||||
if days > 2 {
|
if since_last_flush.whole_days() > 2 {
|
||||||
info!("it's been over {days} days and {hours} hours since we last used our data store. our used sender tags are already outdated - we're going to purge them now.");
|
info!("it's been over {} days and {} hours since we last used our data store. our used sender tags are already outdated - we're going to purge them now.", since_last_flush.whole_days(), since_last_flush.whole_hours());
|
||||||
manager.delete_all_tags().await?;
|
manager.delete_all_tags().await?;
|
||||||
}
|
}
|
||||||
|
|
||||||
+2
-6
@@ -35,12 +35,8 @@ impl ReplyStorageBackend for Empty {
|
|||||||
_db_path: Option<PathBuf>,
|
_db_path: Option<PathBuf>,
|
||||||
) -> Result<Self, Self::StorageError> {
|
) -> Result<Self, Self::StorageError> {
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
min_surb_threshold: debug_config
|
min_surb_threshold: debug_config.minimum_reply_surb_storage_threshold,
|
||||||
.reply_surbs
|
max_surb_threshold: debug_config.maximum_reply_surb_storage_threshold,
|
||||||
.minimum_reply_surb_storage_threshold,
|
|
||||||
max_surb_threshold: debug_config
|
|
||||||
.reply_surbs
|
|
||||||
.maximum_reply_surb_storage_threshold,
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -0,0 +1,336 @@
|
|||||||
|
// Copyright 2021-2022 - Nym Technologies SA <contact@nymtech.net>
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
use crate::spawn_future;
|
||||||
|
use futures::StreamExt;
|
||||||
|
use log::*;
|
||||||
|
use nym_sphinx::addressing::clients::Recipient;
|
||||||
|
use nym_sphinx::params::DEFAULT_NUM_MIX_HOPS;
|
||||||
|
use nym_topology::{nym_topology_from_detailed, NymTopology, NymTopologyError};
|
||||||
|
use rand::seq::SliceRandom;
|
||||||
|
use rand::thread_rng;
|
||||||
|
use std::ops::Deref;
|
||||||
|
use std::sync::Arc;
|
||||||
|
use std::time::Duration;
|
||||||
|
use tokio::sync::{RwLock, RwLockReadGuard};
|
||||||
|
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>,
|
||||||
|
) -> Result<&'a NymTopology, NymTopologyError> {
|
||||||
|
// 1. Have we managed to get anything from the refresher, i.e. have the nym-api queries gone through?
|
||||||
|
let topology = self
|
||||||
|
.permit
|
||||||
|
.as_ref()
|
||||||
|
.as_ref()
|
||||||
|
.ok_or(NymTopologyError::EmptyNetworkTopology)?;
|
||||||
|
|
||||||
|
// 2. does it have any mixnode at all?
|
||||||
|
// 3. does it have any gateways at all?
|
||||||
|
// 4. does it have a mixnode on each layer?
|
||||||
|
topology.ensure_can_construct_path_through(DEFAULT_NUM_MIX_HOPS)?;
|
||||||
|
|
||||||
|
// 5. does it contain OUR gateway (so that we could create an ack packet)?
|
||||||
|
if !topology.gateway_exists(ack_recipient.gateway()) {
|
||||||
|
return Err(NymTopologyError::NonExistentGatewayError {
|
||||||
|
identity_key: ack_recipient.gateway().to_base58_string(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// 6. for our target recipient, does it contain THEIR gateway (so that we could create
|
||||||
|
if let Some(recipient) = packet_recipient {
|
||||||
|
if !topology.gateway_exists(recipient.gateway()) {
|
||||||
|
return Err(NymTopologyError::NonExistentGatewayError {
|
||||||
|
identity_key: recipient.gateway().to_base58_string(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(topology)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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 ensure_is_routable(&self) -> Result<(), NymTopologyError> {
|
||||||
|
match &self.inner.read().await.0 {
|
||||||
|
None => Err(NymTopologyError::EmptyNetworkTopology),
|
||||||
|
Some(ref topology) => topology.ensure_can_construct_path_through(DEFAULT_NUM_MIX_HOPS),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for TopologyAccessor {
|
||||||
|
fn default() -> Self {
|
||||||
|
TopologyAccessor::new()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct TopologyRefresherConfig {
|
||||||
|
nym_api_urls: Vec<Url>,
|
||||||
|
refresh_rate: Duration,
|
||||||
|
client_version: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TopologyRefresherConfig {
|
||||||
|
pub fn new(nym_api_urls: Vec<Url>, refresh_rate: Duration, client_version: String) -> Self {
|
||||||
|
TopologyRefresherConfig {
|
||||||
|
nym_api_urls,
|
||||||
|
refresh_rate,
|
||||||
|
client_version,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct TopologyRefresher {
|
||||||
|
validator_client: validator_client::client::NymApiClient,
|
||||||
|
client_version: String,
|
||||||
|
|
||||||
|
nym_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.nym_api_urls.shuffle(&mut thread_rng());
|
||||||
|
|
||||||
|
TopologyRefresher {
|
||||||
|
validator_client: validator_client::client::NymApiClient::new(
|
||||||
|
cfg.nym_api_urls[0].clone(),
|
||||||
|
),
|
||||||
|
client_version: cfg.client_version,
|
||||||
|
nym_api_urls: cfg.nym_api_urls,
|
||||||
|
topology_accessor,
|
||||||
|
refresh_rate: cfg.refresh_rate,
|
||||||
|
currently_used_api: 0,
|
||||||
|
was_latest_valid: true,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn use_next_nym_api(&mut self) {
|
||||||
|
if self.nym_api_urls.len() == 1 {
|
||||||
|
warn!("There's only a single nym API available - it won't be possible to use a different one");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
self.currently_used_api = (self.currently_used_api + 1) % self.nym_api_urls.len();
|
||||||
|
self.validator_client
|
||||||
|
.change_nym_api(self.nym_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
|
||||||
|
fn check_layer_distribution(&self, active_topology: &NymTopology) -> bool {
|
||||||
|
let mixes = active_topology.mixes();
|
||||||
|
let mixnodes_count = active_topology.num_mixnodes();
|
||||||
|
|
||||||
|
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 topology = nym_topology_from_detailed(mixnodes, gateways)
|
||||||
|
.filter_system_version(&self.client_version);
|
||||||
|
|
||||||
|
if !self.check_layer_distribution(&topology) {
|
||||||
|
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_nym_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 ensure_topology_is_routable(&self) -> Result<(), NymTopologyError> {
|
||||||
|
self.topology_accessor.ensure_is_routable().await
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn start_with_shutdown(mut self, mut shutdown: nym_task::TaskClient) {
|
||||||
|
spawn_future(async move {
|
||||||
|
debug!("Started TopologyRefresher with graceful shutdown support");
|
||||||
|
|
||||||
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
|
let mut interval = tokio_stream::wrappers::IntervalStream::new(tokio::time::interval(
|
||||||
|
self.refresh_rate,
|
||||||
|
));
|
||||||
|
|
||||||
|
#[cfg(target_arch = "wasm32")]
|
||||||
|
let mut interval =
|
||||||
|
gloo_timers::future::IntervalStream::new(self.refresh_rate.as_millis() as u32);
|
||||||
|
|
||||||
|
while !shutdown.is_shutdown() {
|
||||||
|
tokio::select! {
|
||||||
|
_ = interval.next() => {
|
||||||
|
self.refresh().await;
|
||||||
|
},
|
||||||
|
_ = shutdown.recv() => {
|
||||||
|
log::trace!("TopologyRefresher: Received shutdown");
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
shutdown.recv_timeout().await;
|
||||||
|
log::debug!("TopologyRefresher: Exiting");
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
+4
@@ -171,6 +171,8 @@ impl<T> TransmissionBuffer<T> {
|
|||||||
&mut self,
|
&mut self,
|
||||||
n: usize,
|
n: usize,
|
||||||
) -> Option<Vec<(TransmissionLane, T)>> {
|
) -> Option<Vec<(TransmissionLane, T)>> {
|
||||||
|
// let start = Instant::now();
|
||||||
|
|
||||||
if self.buffer.is_empty() {
|
if self.buffer.is_empty() {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
@@ -185,6 +187,8 @@ impl<T> TransmissionBuffer<T> {
|
|||||||
items.push(next)
|
items.push(next)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// todo!("time time taken");
|
||||||
|
|
||||||
Some(items)
|
Some(items)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use nym_config::defaults::NymNetworkDetails;
|
use nym_config::defaults::NymNetworkDetails;
|
||||||
use nym_config::{NymConfig, OptionalSet, CRED_DB_FILE_NAME};
|
use nym_config::{NymConfig, OptionalSet, DB_FILE_NAME};
|
||||||
use nym_sphinx::params::PacketSize;
|
use nym_sphinx::params::PacketSize;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use std::marker::PhantomData;
|
use std::marker::PhantomData;
|
||||||
@@ -13,7 +13,6 @@ use url::Url;
|
|||||||
#[cfg(target_arch = "wasm32")]
|
#[cfg(target_arch = "wasm32")]
|
||||||
use wasm_bindgen::prelude::*;
|
use wasm_bindgen::prelude::*;
|
||||||
|
|
||||||
pub mod old_config_v1_1_13;
|
|
||||||
pub mod persistence;
|
pub mod persistence;
|
||||||
|
|
||||||
pub const MISSING_VALUE: &str = "MISSING VALUE";
|
pub const MISSING_VALUE: &str = "MISSING VALUE";
|
||||||
@@ -32,8 +31,6 @@ const DEFAULT_TOPOLOGY_RESOLUTION_TIMEOUT: Duration = Duration::from_millis(5_00
|
|||||||
// bandwidth bridging protocol, we can come back to a smaller timeout value
|
// bandwidth bridging protocol, we can come back to a smaller timeout value
|
||||||
const DEFAULT_GATEWAY_RESPONSE_TIMEOUT: Duration = Duration::from_secs(5 * 60);
|
const DEFAULT_GATEWAY_RESPONSE_TIMEOUT: Duration = Duration::from_secs(5 * 60);
|
||||||
|
|
||||||
const DEFAULT_COVER_TRAFFIC_PRIMARY_SIZE_RATIO: f64 = 0.70;
|
|
||||||
|
|
||||||
// reply-surbs related:
|
// reply-surbs related:
|
||||||
|
|
||||||
// define when to request
|
// define when to request
|
||||||
@@ -92,11 +89,6 @@ impl<T> Config<T> {
|
|||||||
Config::default().with_id(id)
|
Config::default().with_id(id)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn validate(&self) -> bool {
|
|
||||||
// no other sections have explicit requirements (yet)
|
|
||||||
self.debug.validate()
|
|
||||||
}
|
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub fn with_id<S: Into<String>>(mut self, id: S) -> Self
|
pub fn with_id<S: Into<String>>(mut self, id: S) -> Self
|
||||||
where
|
where
|
||||||
@@ -218,12 +210,11 @@ impl<T> Config<T> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn set_high_default_traffic_volume(&mut self) {
|
pub fn set_high_default_traffic_volume(&mut self) {
|
||||||
self.debug.traffic.average_packet_delay = Duration::from_millis(10);
|
self.debug.average_packet_delay = Duration::from_millis(10);
|
||||||
// basically don't really send cover messages
|
// basically don't really send cover messages
|
||||||
self.debug.cover_traffic.loop_cover_traffic_average_delay =
|
self.debug.loop_cover_traffic_average_delay = Duration::from_millis(2_000_000);
|
||||||
Duration::from_millis(2_000_000);
|
|
||||||
// 250 "real" messages / s
|
// 250 "real" messages / s
|
||||||
self.debug.traffic.message_sending_average_delay = Duration::from_millis(4);
|
self.debug.message_sending_average_delay = Duration::from_millis(4);
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn with_disabled_cover_traffic(mut self, disabled: bool) -> Self {
|
pub fn with_disabled_cover_traffic(mut self, disabled: bool) -> Self {
|
||||||
@@ -234,8 +225,8 @@ impl<T> Config<T> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn set_no_cover_traffic(&mut self) {
|
pub fn set_no_cover_traffic(&mut self) {
|
||||||
self.debug.cover_traffic.disable_loop_cover_traffic_stream = true;
|
self.debug.disable_loop_cover_traffic_stream = true;
|
||||||
self.debug.traffic.disable_main_poisson_packet_distribution = true;
|
self.debug.disable_main_poisson_packet_distribution = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn set_custom_version(&mut self, version: &str) {
|
pub fn set_custom_version(&mut self, version: &str) {
|
||||||
@@ -320,89 +311,87 @@ impl<T> Config<T> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_average_packet_delay(&self) -> Duration {
|
pub fn get_average_packet_delay(&self) -> Duration {
|
||||||
self.debug.traffic.average_packet_delay
|
self.debug.average_packet_delay
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_average_ack_delay(&self) -> Duration {
|
pub fn get_average_ack_delay(&self) -> Duration {
|
||||||
self.debug.acknowledgements.average_ack_delay
|
self.debug.average_ack_delay
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_ack_wait_multiplier(&self) -> f64 {
|
pub fn get_ack_wait_multiplier(&self) -> f64 {
|
||||||
self.debug.acknowledgements.ack_wait_multiplier
|
self.debug.ack_wait_multiplier
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_ack_wait_addition(&self) -> Duration {
|
pub fn get_ack_wait_addition(&self) -> Duration {
|
||||||
self.debug.acknowledgements.ack_wait_addition
|
self.debug.ack_wait_addition
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_loop_cover_traffic_average_delay(&self) -> Duration {
|
pub fn get_loop_cover_traffic_average_delay(&self) -> Duration {
|
||||||
self.debug.cover_traffic.loop_cover_traffic_average_delay
|
self.debug.loop_cover_traffic_average_delay
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_message_sending_average_delay(&self) -> Duration {
|
pub fn get_message_sending_average_delay(&self) -> Duration {
|
||||||
self.debug.traffic.message_sending_average_delay
|
self.debug.message_sending_average_delay
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_gateway_response_timeout(&self) -> Duration {
|
pub fn get_gateway_response_timeout(&self) -> Duration {
|
||||||
self.debug.gateway_connection.gateway_response_timeout
|
self.debug.gateway_response_timeout
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_topology_refresh_rate(&self) -> Duration {
|
pub fn get_topology_refresh_rate(&self) -> Duration {
|
||||||
self.debug.topology.topology_refresh_rate
|
self.debug.topology_refresh_rate
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_topology_resolution_timeout(&self) -> Duration {
|
pub fn get_topology_resolution_timeout(&self) -> Duration {
|
||||||
self.debug.topology.topology_resolution_timeout
|
self.debug.topology_resolution_timeout
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_disabled_loop_cover_traffic_stream(&self) -> bool {
|
pub fn get_disabled_loop_cover_traffic_stream(&self) -> bool {
|
||||||
self.debug.cover_traffic.disable_loop_cover_traffic_stream
|
self.debug.disable_loop_cover_traffic_stream
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_disabled_main_poisson_packet_distribution(&self) -> bool {
|
pub fn get_disabled_main_poisson_packet_distribution(&self) -> bool {
|
||||||
self.debug.traffic.disable_main_poisson_packet_distribution
|
self.debug.disable_main_poisson_packet_distribution
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn get_use_extended_packet_size(&self) -> Option<ExtendedPacketSize> {
|
||||||
|
self.debug.use_extended_packet_size
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_minimum_reply_surb_storage_threshold(&self) -> usize {
|
pub fn get_minimum_reply_surb_storage_threshold(&self) -> usize {
|
||||||
self.debug.reply_surbs.minimum_reply_surb_storage_threshold
|
self.debug.minimum_reply_surb_storage_threshold
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_maximum_reply_surb_storage_threshold(&self) -> usize {
|
pub fn get_maximum_reply_surb_storage_threshold(&self) -> usize {
|
||||||
self.debug.reply_surbs.maximum_reply_surb_storage_threshold
|
self.debug.maximum_reply_surb_storage_threshold
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_minimum_reply_surb_request_size(&self) -> u32 {
|
pub fn get_minimum_reply_surb_request_size(&self) -> u32 {
|
||||||
self.debug.reply_surbs.minimum_reply_surb_request_size
|
self.debug.minimum_reply_surb_request_size
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_maximum_reply_surb_request_size(&self) -> u32 {
|
pub fn get_maximum_reply_surb_request_size(&self) -> u32 {
|
||||||
self.debug.reply_surbs.maximum_reply_surb_request_size
|
self.debug.maximum_reply_surb_request_size
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_maximum_allowed_reply_surb_request_size(&self) -> u32 {
|
pub fn get_maximum_allowed_reply_surb_request_size(&self) -> u32 {
|
||||||
self.debug
|
self.debug.maximum_allowed_reply_surb_request_size
|
||||||
.reply_surbs
|
|
||||||
.maximum_allowed_reply_surb_request_size
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_maximum_reply_surb_rerequest_waiting_period(&self) -> Duration {
|
pub fn get_maximum_reply_surb_rerequest_waiting_period(&self) -> Duration {
|
||||||
self.debug
|
self.debug.maximum_reply_surb_rerequest_waiting_period
|
||||||
.reply_surbs
|
|
||||||
.maximum_reply_surb_rerequest_waiting_period
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_maximum_reply_surb_drop_waiting_period(&self) -> Duration {
|
pub fn get_maximum_reply_surb_drop_waiting_period(&self) -> Duration {
|
||||||
self.debug
|
self.debug.maximum_reply_surb_drop_waiting_period
|
||||||
.reply_surbs
|
|
||||||
.maximum_reply_surb_drop_waiting_period
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_maximum_reply_surb_age(&self) -> Duration {
|
pub fn get_maximum_reply_surb_age(&self) -> Duration {
|
||||||
self.debug.reply_surbs.maximum_reply_surb_age
|
self.debug.maximum_reply_surb_age
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_maximum_reply_key_age(&self) -> Duration {
|
pub fn get_maximum_reply_key_age(&self) -> Duration {
|
||||||
self.debug.reply_surbs.maximum_reply_key_age
|
self.debug.maximum_reply_key_age
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -461,63 +450,63 @@ impl From<nym_topology::gateway::Node> for GatewayEndpointConfig {
|
|||||||
pub struct Client<T> {
|
pub struct Client<T> {
|
||||||
/// Version of the client for which this configuration was created.
|
/// Version of the client for which this configuration was created.
|
||||||
#[serde(default = "missing_string_value")]
|
#[serde(default = "missing_string_value")]
|
||||||
pub version: String,
|
version: String,
|
||||||
|
|
||||||
/// ID specifies the human readable ID of this particular client.
|
/// ID specifies the human readable ID of this particular client.
|
||||||
pub id: String,
|
id: String,
|
||||||
|
|
||||||
/// Indicates whether this client is running in a disabled credentials mode, thus attempting
|
/// Indicates whether this client is running in a disabled credentials mode, thus attempting
|
||||||
/// to claim bandwidth without presenting bandwidth credentials.
|
/// to claim bandwidth without presenting bandwidth credentials.
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub disabled_credentials_mode: bool,
|
disabled_credentials_mode: bool,
|
||||||
|
|
||||||
/// Addresses to nyxd validators via which the client can communicate with the chain.
|
/// Addresses to nyxd validators via which the client can communicate with the chain.
|
||||||
#[serde(alias = "validator_urls")]
|
#[serde(alias = "validator_urls")]
|
||||||
pub nyxd_urls: Vec<Url>,
|
nyxd_urls: Vec<Url>,
|
||||||
|
|
||||||
/// Addresses to APIs running on validator from which the client gets the view of the network.
|
/// Addresses to APIs running on validator from which the client gets the view of the network.
|
||||||
#[serde(alias = "validator_api_urls")]
|
#[serde(alias = "validator_api_urls")]
|
||||||
pub nym_api_urls: Vec<Url>,
|
nym_api_urls: Vec<Url>,
|
||||||
|
|
||||||
/// Path to file containing private identity key.
|
/// Path to file containing private identity key.
|
||||||
pub private_identity_key_file: PathBuf,
|
private_identity_key_file: PathBuf,
|
||||||
|
|
||||||
/// Path to file containing public identity key.
|
/// Path to file containing public identity key.
|
||||||
pub public_identity_key_file: PathBuf,
|
public_identity_key_file: PathBuf,
|
||||||
|
|
||||||
/// Path to file containing private encryption key.
|
/// Path to file containing private encryption key.
|
||||||
pub private_encryption_key_file: PathBuf,
|
private_encryption_key_file: PathBuf,
|
||||||
|
|
||||||
/// Path to file containing public encryption key.
|
/// Path to file containing public encryption key.
|
||||||
pub public_encryption_key_file: PathBuf,
|
public_encryption_key_file: PathBuf,
|
||||||
|
|
||||||
/// Path to file containing shared key derived with the specified gateway that is used
|
/// Path to file containing shared key derived with the specified gateway that is used
|
||||||
/// for all communication with it.
|
/// for all communication with it.
|
||||||
pub gateway_shared_key_file: PathBuf,
|
gateway_shared_key_file: PathBuf,
|
||||||
|
|
||||||
/// Path to file containing key used for encrypting and decrypting the content of an
|
/// 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.
|
/// acknowledgement so that nobody besides the client knows which packet it refers to.
|
||||||
pub ack_key_file: PathBuf,
|
ack_key_file: PathBuf,
|
||||||
|
|
||||||
/// Information regarding how the client should send data to gateway.
|
/// Information regarding how the client should send data to gateway.
|
||||||
pub gateway_endpoint: GatewayEndpointConfig,
|
gateway_endpoint: GatewayEndpointConfig,
|
||||||
|
|
||||||
/// Path to the database containing bandwidth credentials of this client.
|
/// Path to the database containing bandwidth credentials of this client.
|
||||||
pub database_path: PathBuf,
|
database_path: PathBuf,
|
||||||
|
|
||||||
/// Path to the persistent store for received reply surbs, unused encryption keys and used sender tags.
|
/// Path to the persistent store for received reply surbs, unused encryption keys and used sender tags.
|
||||||
// this was set to use #[serde(default)] for the purposes of compatibility for multi-surbs introduced in 1.1.4.
|
// this was set to use #[serde(default)] for the purposes of compatibility for multi-surbs introduced in 1.1.4.
|
||||||
// if you're reading this message and we have already introduced some breaking changes, feel free
|
// if you're reading this message and we have already introduced some breaking changes, feel free
|
||||||
// to remove that attribute since at this point the client configs should have gotten regenerated
|
// to remove that attribute since at this point the client configs should have gotten regenerated
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub reply_surb_database_path: PathBuf,
|
reply_surb_database_path: PathBuf,
|
||||||
|
|
||||||
/// nym_home_directory specifies absolute path to the home nym Clients directory.
|
/// 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.
|
/// It is expected to use default value and hence .toml file should not redefine this field.
|
||||||
pub nym_root_directory: PathBuf,
|
nym_root_directory: PathBuf,
|
||||||
|
|
||||||
#[serde(skip)]
|
#[serde(skip)]
|
||||||
pub super_struct: PhantomData<T>,
|
super_struct: PhantomData<T>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T: NymConfig> Default for Client<T> {
|
impl<T: NymConfig> Default for Client<T> {
|
||||||
@@ -590,7 +579,7 @@ impl<T: NymConfig> Client<T> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn default_database_path(id: &str) -> PathBuf {
|
fn default_database_path(id: &str) -> PathBuf {
|
||||||
T::default_data_directory(id).join(CRED_DB_FILE_NAME)
|
T::default_data_directory(id).join(DB_FILE_NAME)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -598,9 +587,9 @@ impl<T: NymConfig> Client<T> {
|
|||||||
#[serde(deny_unknown_fields)]
|
#[serde(deny_unknown_fields)]
|
||||||
pub struct Logging {}
|
pub struct Logging {}
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Serialize)]
|
#[derive(Debug, Clone, Deserialize, PartialEq, Serialize)]
|
||||||
#[serde(default)]
|
#[serde(default, deny_unknown_fields)]
|
||||||
pub struct Traffic {
|
pub struct DebugConfig {
|
||||||
/// The parameter of Poisson distribution determining how long, on average,
|
/// The parameter of Poisson distribution determining how long, on average,
|
||||||
/// sent packet is going to be delayed at any given mix node.
|
/// 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
|
/// So for a packet going through three mix nodes, on average, it will take three times this value
|
||||||
@@ -608,99 +597,6 @@ pub struct Traffic {
|
|||||||
#[serde(with = "humantime_serde")]
|
#[serde(with = "humantime_serde")]
|
||||||
pub average_packet_delay: Duration,
|
pub average_packet_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")]
|
|
||||||
pub message_sending_average_delay: Duration,
|
|
||||||
|
|
||||||
/// Controls whether the main packet stream constantly produces packets according to the predefined
|
|
||||||
/// poisson distribution.
|
|
||||||
pub disable_main_poisson_packet_distribution: bool,
|
|
||||||
|
|
||||||
/// Specifies the packet size used for sent messages.
|
|
||||||
/// Do not override it unless you understand the consequences of that change.
|
|
||||||
pub primary_packet_size: PacketSize,
|
|
||||||
|
|
||||||
/// Specifies the optional auxiliary packet size for optimizing message streams.
|
|
||||||
/// Note that its use decreases overall anonymity.
|
|
||||||
/// Do not set it it unless you understand the consequences of that change.
|
|
||||||
pub secondary_packet_size: Option<PacketSize>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Traffic {
|
|
||||||
pub fn validate(&self) -> bool {
|
|
||||||
if let Some(secondary_packet_size) = self.secondary_packet_size {
|
|
||||||
if secondary_packet_size == PacketSize::AckPacket
|
|
||||||
|| secondary_packet_size == self.primary_packet_size
|
|
||||||
{
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for Traffic {
|
|
||||||
fn default() -> Self {
|
|
||||||
Traffic {
|
|
||||||
average_packet_delay: DEFAULT_AVERAGE_PACKET_DELAY,
|
|
||||||
message_sending_average_delay: DEFAULT_MESSAGE_STREAM_AVERAGE_DELAY,
|
|
||||||
disable_main_poisson_packet_distribution: false,
|
|
||||||
primary_packet_size: PacketSize::RegularPacket,
|
|
||||||
secondary_packet_size: None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Serialize)]
|
|
||||||
#[serde(default, deny_unknown_fields)]
|
|
||||||
pub struct CoverTraffic {
|
|
||||||
/// The parameter of Poisson distribution determining how long, on average,
|
|
||||||
/// it is going to take for another loop cover traffic message to be sent.
|
|
||||||
#[serde(with = "humantime_serde")]
|
|
||||||
pub loop_cover_traffic_average_delay: Duration,
|
|
||||||
|
|
||||||
/// Specifies the ratio of `primary_packet_size` to `secondary_packet_size` used in cover traffic.
|
|
||||||
/// Only applicable if `secondary_packet_size` is enabled.
|
|
||||||
pub cover_traffic_primary_size_ratio: f64,
|
|
||||||
|
|
||||||
/// Controls whether the dedicated loop cover traffic stream should be enabled.
|
|
||||||
/// (and sending packets, on average, every [Self::loop_cover_traffic_average_delay])
|
|
||||||
pub disable_loop_cover_traffic_stream: bool,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for CoverTraffic {
|
|
||||||
fn default() -> Self {
|
|
||||||
CoverTraffic {
|
|
||||||
loop_cover_traffic_average_delay: DEFAULT_LOOP_COVER_STREAM_AVERAGE_DELAY,
|
|
||||||
cover_traffic_primary_size_ratio: DEFAULT_COVER_TRAFFIC_PRIMARY_SIZE_RATIO,
|
|
||||||
disable_loop_cover_traffic_stream: false,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Serialize)]
|
|
||||||
#[serde(default, deny_unknown_fields)]
|
|
||||||
pub struct GatewayConnection {
|
|
||||||
/// How long we're willing to wait for a response to a message sent to the gateway,
|
|
||||||
/// before giving up on it.
|
|
||||||
#[serde(with = "humantime_serde")]
|
|
||||||
pub gateway_response_timeout: Duration,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for GatewayConnection {
|
|
||||||
fn default() -> Self {
|
|
||||||
GatewayConnection {
|
|
||||||
gateway_response_timeout: DEFAULT_GATEWAY_RESPONSE_TIMEOUT,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Serialize)]
|
|
||||||
#[serde(default, deny_unknown_fields)]
|
|
||||||
pub struct Acknowledgements {
|
|
||||||
/// The parameter of Poisson distribution determining how long, on average,
|
/// The parameter of Poisson distribution determining how long, on average,
|
||||||
/// sent acknowledgement is going to be delayed at any given mix node.
|
/// 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
|
/// So for an ack going through three mix nodes, on average, it will take three times this value
|
||||||
@@ -718,21 +614,24 @@ pub struct Acknowledgements {
|
|||||||
/// In an ideal network with 0 latency, this value would have been 0.
|
/// In an ideal network with 0 latency, this value would have been 0.
|
||||||
#[serde(with = "humantime_serde")]
|
#[serde(with = "humantime_serde")]
|
||||||
pub ack_wait_addition: Duration,
|
pub ack_wait_addition: Duration,
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for Acknowledgements {
|
/// The parameter of Poisson distribution determining how long, on average,
|
||||||
fn default() -> Self {
|
/// it is going to take for another loop cover traffic message to be sent.
|
||||||
Acknowledgements {
|
#[serde(with = "humantime_serde")]
|
||||||
average_ack_delay: DEFAULT_AVERAGE_PACKET_DELAY,
|
pub loop_cover_traffic_average_delay: Duration,
|
||||||
ack_wait_multiplier: DEFAULT_ACK_WAIT_MULTIPLIER,
|
|
||||||
ack_wait_addition: DEFAULT_ACK_WAIT_ADDITION,
|
/// 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")]
|
||||||
|
pub 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")]
|
||||||
|
pub gateway_response_timeout: Duration,
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Serialize)]
|
|
||||||
#[serde(default, deny_unknown_fields)]
|
|
||||||
pub struct Topology {
|
|
||||||
/// The uniform delay every which clients are querying the directory server
|
/// The uniform delay every which clients are querying the directory server
|
||||||
/// to try to obtain a compatible network topology to send sphinx packets through.
|
/// to try to obtain a compatible network topology to send sphinx packets through.
|
||||||
#[serde(with = "humantime_serde")]
|
#[serde(with = "humantime_serde")]
|
||||||
@@ -743,20 +642,18 @@ pub struct Topology {
|
|||||||
/// did not reach its destination.
|
/// did not reach its destination.
|
||||||
#[serde(with = "humantime_serde")]
|
#[serde(with = "humantime_serde")]
|
||||||
pub topology_resolution_timeout: Duration,
|
pub topology_resolution_timeout: Duration,
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for Topology {
|
/// Controls whether the dedicated loop cover traffic stream should be enabled.
|
||||||
fn default() -> Self {
|
/// (and sending packets, on average, every [Self::loop_cover_traffic_average_delay])
|
||||||
Topology {
|
pub disable_loop_cover_traffic_stream: bool,
|
||||||
topology_refresh_rate: DEFAULT_TOPOLOGY_REFRESH_RATE,
|
|
||||||
topology_resolution_timeout: DEFAULT_TOPOLOGY_RESOLUTION_TIMEOUT,
|
/// Controls whether the main packet stream constantly produces packets according to the predefined
|
||||||
}
|
/// poisson distribution.
|
||||||
}
|
pub disable_main_poisson_packet_distribution: bool,
|
||||||
}
|
|
||||||
|
/// Controls whether the sent sphinx packet use a NON-DEFAULT bigger size.
|
||||||
|
pub use_extended_packet_size: Option<ExtendedPacketSize>,
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Serialize)]
|
|
||||||
#[serde(default, deny_unknown_fields)]
|
|
||||||
pub struct ReplySurbs {
|
|
||||||
/// Defines the minimum number of reply surbs the client wants to keep in its storage at all times.
|
/// Defines the minimum number of reply surbs the client wants to keep in its storage at all times.
|
||||||
/// It can only allow to go below that value if its to request additional reply surbs.
|
/// It can only allow to go below that value if its to request additional reply surbs.
|
||||||
pub minimum_reply_surb_storage_threshold: usize,
|
pub minimum_reply_surb_storage_threshold: usize,
|
||||||
@@ -794,9 +691,29 @@ pub struct ReplySurbs {
|
|||||||
pub maximum_reply_key_age: Duration,
|
pub maximum_reply_key_age: Duration,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Default for ReplySurbs {
|
#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq)]
|
||||||
|
#[serde(rename_all = "lowercase")]
|
||||||
|
pub enum ExtendedPacketSize {
|
||||||
|
Extended8,
|
||||||
|
Extended16,
|
||||||
|
Extended32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for DebugConfig {
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
ReplySurbs {
|
DebugConfig {
|
||||||
|
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,
|
||||||
|
disable_loop_cover_traffic_stream: false,
|
||||||
|
disable_main_poisson_packet_distribution: false,
|
||||||
|
use_extended_packet_size: None,
|
||||||
minimum_reply_surb_storage_threshold: DEFAULT_MINIMUM_REPLY_SURB_STORAGE_THRESHOLD,
|
minimum_reply_surb_storage_threshold: DEFAULT_MINIMUM_REPLY_SURB_STORAGE_THRESHOLD,
|
||||||
maximum_reply_surb_storage_threshold: DEFAULT_MAXIMUM_REPLY_SURB_STORAGE_THRESHOLD,
|
maximum_reply_surb_storage_threshold: DEFAULT_MAXIMUM_REPLY_SURB_STORAGE_THRESHOLD,
|
||||||
minimum_reply_surb_request_size: DEFAULT_MINIMUM_REPLY_SURB_REQUEST_SIZE,
|
minimum_reply_surb_request_size: DEFAULT_MINIMUM_REPLY_SURB_REQUEST_SIZE,
|
||||||
@@ -811,47 +728,12 @@ impl Default for ReplySurbs {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Serialize)]
|
impl From<ExtendedPacketSize> for PacketSize {
|
||||||
#[serde(default, deny_unknown_fields)]
|
fn from(size: ExtendedPacketSize) -> PacketSize {
|
||||||
pub struct DebugConfig {
|
match size {
|
||||||
/// Defines all configuration options related to traffic streams.
|
ExtendedPacketSize::Extended8 => PacketSize::ExtendedPacket8,
|
||||||
pub traffic: Traffic,
|
ExtendedPacketSize::Extended16 => PacketSize::ExtendedPacket16,
|
||||||
|
ExtendedPacketSize::Extended32 => PacketSize::ExtendedPacket32,
|
||||||
/// Defines all configuration options related to cover traffic stream(s).
|
|
||||||
pub cover_traffic: CoverTraffic,
|
|
||||||
|
|
||||||
/// Defines all configuration options related to the gateway connection.
|
|
||||||
pub gateway_connection: GatewayConnection,
|
|
||||||
|
|
||||||
/// Defines all configuration options related to acknowledgements, such as delays or wait timeouts.
|
|
||||||
pub acknowledgements: Acknowledgements,
|
|
||||||
|
|
||||||
/// Defines all configuration options related topology, such as refresh rates or timeouts.
|
|
||||||
pub topology: Topology,
|
|
||||||
|
|
||||||
/// Defines all configuration options related to reply SURBs.
|
|
||||||
pub reply_surbs: ReplySurbs,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl DebugConfig {
|
|
||||||
pub fn validate(&self) -> bool {
|
|
||||||
// no other sections have explicit requirements (yet)
|
|
||||||
self.traffic.validate()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// it could be derived, sure, but I'd rather have an explicit implementation in case we had to change
|
|
||||||
// something manually at some point
|
|
||||||
#[allow(clippy::derivable_impls)]
|
|
||||||
impl Default for DebugConfig {
|
|
||||||
fn default() -> Self {
|
|
||||||
DebugConfig {
|
|
||||||
traffic: Default::default(),
|
|
||||||
cover_traffic: Default::default(),
|
|
||||||
gateway_connection: Default::default(),
|
|
||||||
acknowledgements: Default::default(),
|
|
||||||
topology: Default::default(),
|
|
||||||
reply_surbs: Default::default(),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
|
// Copyright 2022 - Nym Technologies SA <contact@nymtech.net>
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
use gateway_client::error::GatewayClientError;
|
||||||
use nym_crypto::asymmetric::identity::Ed25519RecoveryError;
|
use nym_crypto::asymmetric::identity::Ed25519RecoveryError;
|
||||||
use nym_gateway_client::error::GatewayClientError;
|
|
||||||
use nym_topology::gateway::GatewayConversionError;
|
use nym_topology::gateway::GatewayConversionError;
|
||||||
use nym_topology::NymTopologyError;
|
use nym_topology::NymTopologyError;
|
||||||
use nym_validator_client::ValidatorClientError;
|
use validator_client::ValidatorClientError;
|
||||||
|
|
||||||
#[derive(thiserror::Error, Debug)]
|
#[derive(thiserror::Error, Debug)]
|
||||||
pub enum ClientCoreError {
|
pub enum ClientCoreError {
|
||||||
@@ -7,11 +7,11 @@ use crate::{
|
|||||||
error::ClientCoreError,
|
error::ClientCoreError,
|
||||||
};
|
};
|
||||||
use futures::{SinkExt, StreamExt};
|
use futures::{SinkExt, StreamExt};
|
||||||
|
use gateway_client::GatewayClient;
|
||||||
|
use gateway_requests::registration::handshake::SharedKeys;
|
||||||
use log::{debug, info, trace, warn};
|
use log::{debug, info, trace, warn};
|
||||||
use nym_config::NymConfig;
|
use nym_config::NymConfig;
|
||||||
use nym_crypto::asymmetric::identity;
|
use nym_crypto::asymmetric::identity;
|
||||||
use nym_gateway_client::GatewayClient;
|
|
||||||
use nym_gateway_requests::registration::handshake::SharedKeys;
|
|
||||||
use nym_topology::{filter::VersionFilterable, gateway};
|
use nym_topology::{filter::VersionFilterable, gateway};
|
||||||
use rand::{seq::SliceRandom, thread_rng, Rng};
|
use rand::{seq::SliceRandom, thread_rng, Rng};
|
||||||
use std::{sync::Arc, time::Duration};
|
use std::{sync::Arc, time::Duration};
|
||||||
@@ -19,8 +19,6 @@ use tap::TapFallible;
|
|||||||
use tungstenite::Message;
|
use tungstenite::Message;
|
||||||
use url::Url;
|
use url::Url;
|
||||||
|
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
|
||||||
use nym_validator_client::nyxd::DirectSigningNyxdClient;
|
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
use tokio::net::TcpStream;
|
use tokio::net::TcpStream;
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
@@ -29,13 +27,14 @@ use tokio::time::Instant;
|
|||||||
use tokio_tungstenite::connect_async;
|
use tokio_tungstenite::connect_async;
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
use tokio_tungstenite::{MaybeTlsStream, WebSocketStream};
|
use tokio_tungstenite::{MaybeTlsStream, WebSocketStream};
|
||||||
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
|
use validator_client::nyxd::SigningNyxdClient;
|
||||||
|
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
type WsConn = WebSocketStream<MaybeTlsStream<TcpStream>>;
|
type WsConn = WebSocketStream<MaybeTlsStream<TcpStream>>;
|
||||||
use nym_credential_storage::storage::Storage;
|
|
||||||
|
|
||||||
#[cfg(target_arch = "wasm32")]
|
#[cfg(target_arch = "wasm32")]
|
||||||
use nym_bandwidth_controller::wasm_mockups::DirectSigningNyxdClient;
|
use gateway_client::wasm_mockups::SigningNyxdClient;
|
||||||
#[cfg(target_arch = "wasm32")]
|
#[cfg(target_arch = "wasm32")]
|
||||||
use wasm_timer::Instant;
|
use wasm_timer::Instant;
|
||||||
#[cfg(target_arch = "wasm32")]
|
#[cfg(target_arch = "wasm32")]
|
||||||
@@ -68,7 +67,7 @@ async fn current_gateways<R: Rng>(
|
|||||||
let nym_api = nym_apis
|
let nym_api = nym_apis
|
||||||
.choose(rng)
|
.choose(rng)
|
||||||
.ok_or(ClientCoreError::ListOfNymApisIsEmpty)?;
|
.ok_or(ClientCoreError::ListOfNymApisIsEmpty)?;
|
||||||
let client = nym_validator_client::client::NymApiClient::new(nym_api.clone());
|
let client = validator_client::client::NymApiClient::new(nym_api.clone());
|
||||||
|
|
||||||
log::trace!("Fetching list of gateways from: {}", nym_api);
|
log::trace!("Fetching list of gateways from: {}", nym_api);
|
||||||
|
|
||||||
@@ -177,7 +176,10 @@ async fn choose_gateway_by_latency<R: Rng>(
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
debug!("{id}: {:?}", with_latency.latency);
|
debug!(
|
||||||
|
"{id} ({}): {:?}",
|
||||||
|
with_latency.gateway.location, with_latency.latency
|
||||||
|
);
|
||||||
gateways_with_latency.push(with_latency)
|
gateways_with_latency.push(with_latency)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -186,8 +188,8 @@ async fn choose_gateway_by_latency<R: Rng>(
|
|||||||
.expect("invalid selection weight!");
|
.expect("invalid selection weight!");
|
||||||
|
|
||||||
info!(
|
info!(
|
||||||
"chose gateway {} with average latency of {:?}",
|
"chose gateway {} (located at {}) with average latency of {:?}",
|
||||||
chosen.gateway.identity_key, chosen.latency
|
chosen.gateway.identity_key, chosen.gateway.location, chosen.latency
|
||||||
);
|
);
|
||||||
|
|
||||||
Ok(chosen.gateway.clone())
|
Ok(chosen.gateway.clone())
|
||||||
@@ -224,12 +226,12 @@ pub(super) async fn query_gateway_details(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(super) async fn register_with_gateway<St: Storage>(
|
pub(super) async fn register_with_gateway(
|
||||||
gateway: &gateway::Node,
|
gateway: &gateway::Node,
|
||||||
our_identity: Arc<identity::KeyPair>,
|
our_identity: Arc<identity::KeyPair>,
|
||||||
) -> Result<Arc<SharedKeys>, ClientCoreError> {
|
) -> Result<Arc<SharedKeys>, ClientCoreError> {
|
||||||
let timeout = Duration::from_millis(1500);
|
let timeout = Duration::from_millis(1500);
|
||||||
let mut gateway_client: GatewayClient<DirectSigningNyxdClient, St> = GatewayClient::new_init(
|
let mut gateway_client: GatewayClient<SigningNyxdClient> = GatewayClient::new_init(
|
||||||
gateway.clients_address(),
|
gateway.clients_address(),
|
||||||
gateway.identity_key,
|
gateway.identity_key,
|
||||||
our_identity.clone(),
|
our_identity.clone(),
|
||||||
@@ -11,7 +11,6 @@ use serde::Serialize;
|
|||||||
use tap::TapFallible;
|
use tap::TapFallible;
|
||||||
|
|
||||||
use nym_config::NymConfig;
|
use nym_config::NymConfig;
|
||||||
use nym_credential_storage::storage::Storage;
|
|
||||||
use nym_crypto::asymmetric::{encryption, identity};
|
use nym_crypto::asymmetric::{encryption, identity};
|
||||||
use url::Url;
|
use url::Url;
|
||||||
|
|
||||||
@@ -74,7 +73,7 @@ pub fn new_client_keys() -> KeyManager {
|
|||||||
/// Either pick one at random by querying the available gateways from the nym-api, or use the
|
/// Either pick one at random by querying the available gateways from the nym-api, or use the
|
||||||
/// chosen one if it's among the available ones.
|
/// chosen one if it's among the available ones.
|
||||||
/// The shared key is added to the supplied `KeyManager` and the endpoint details are returned.
|
/// The shared key is added to the supplied `KeyManager` and the endpoint details are returned.
|
||||||
pub async fn register_with_gateway<St: Storage>(
|
pub async fn register_with_gateway(
|
||||||
key_manager: &mut KeyManager,
|
key_manager: &mut KeyManager,
|
||||||
nym_api_endpoints: Vec<Url>,
|
nym_api_endpoints: Vec<Url>,
|
||||||
chosen_gateway_id: Option<identity::PublicKey>,
|
chosen_gateway_id: Option<identity::PublicKey>,
|
||||||
@@ -88,7 +87,7 @@ pub async fn register_with_gateway<St: Storage>(
|
|||||||
let our_identity = key_manager.identity_keypair();
|
let our_identity = key_manager.identity_keypair();
|
||||||
|
|
||||||
// Establish connection, authenticate and generate keys for talking with the gateway
|
// Establish connection, authenticate and generate keys for talking with the gateway
|
||||||
let shared_keys = helpers::register_with_gateway::<St>(&gateway, our_identity).await?;
|
let shared_keys = helpers::register_with_gateway(&gateway, our_identity).await?;
|
||||||
key_manager.insert_gateway_shared_key(shared_keys);
|
key_manager.insert_gateway_shared_key(shared_keys);
|
||||||
|
|
||||||
Ok(gateway.into())
|
Ok(gateway.into())
|
||||||
@@ -101,7 +100,7 @@ pub async fn register_with_gateway<St: Storage>(
|
|||||||
/// b. Create a new gateway configuration but keep existing keys. This assumes that the caller
|
/// b. Create a new gateway configuration but keep existing keys. This assumes that the caller
|
||||||
/// knows what they are doing and that the keys match the requested gateway.
|
/// knows what they are doing and that the keys match the requested gateway.
|
||||||
/// c. Create a new gateway configuration with a newly registered gateway and keys.
|
/// c. Create a new gateway configuration with a newly registered gateway and keys.
|
||||||
pub async fn setup_gateway_from_config<C, T, St>(
|
pub async fn setup_gateway_from_config<C, T>(
|
||||||
register_gateway: bool,
|
register_gateway: bool,
|
||||||
user_chosen_gateway_id: Option<identity::PublicKey>,
|
user_chosen_gateway_id: Option<identity::PublicKey>,
|
||||||
config: &Config<T>,
|
config: &Config<T>,
|
||||||
@@ -110,18 +109,17 @@ pub async fn setup_gateway_from_config<C, T, St>(
|
|||||||
where
|
where
|
||||||
C: NymConfig + ClientCoreConfigTrait,
|
C: NymConfig + ClientCoreConfigTrait,
|
||||||
T: NymConfig,
|
T: NymConfig,
|
||||||
St: Storage,
|
|
||||||
{
|
{
|
||||||
let id = config.get_id();
|
let id = config.get_id();
|
||||||
|
|
||||||
// If we are not going to register gateway, and an explicitly chosen gateway is not passed in,
|
// If we are not going to register gateway, and an explicitly chosed gateway is not passed in,
|
||||||
// load the existing configuration file
|
// load the existing configuration file
|
||||||
if !register_gateway && user_chosen_gateway_id.is_none() {
|
if !register_gateway && user_chosen_gateway_id.is_none() {
|
||||||
eprintln!("Not registering gateway, will reuse existing config and keys");
|
println!("Not registering gateway, will reuse existing config and keys");
|
||||||
return load_existing_gateway_config::<C>(&id);
|
return load_existing_gateway_config::<C>(&id);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Else, we proceed by querying the nym-api
|
// Else, we preceed by querying the nym-api
|
||||||
let gateway = helpers::query_gateway_details(
|
let gateway = helpers::query_gateway_details(
|
||||||
config.get_nym_api_endpoints(),
|
config.get_nym_api_endpoints(),
|
||||||
user_chosen_gateway_id,
|
user_chosen_gateway_id,
|
||||||
@@ -133,7 +131,7 @@ where
|
|||||||
// If we are not registering, just return this and assume the caller has the keys already and
|
// If we are not registering, just return this and assume the caller has the keys already and
|
||||||
// wants to keep the,
|
// wants to keep the,
|
||||||
if !register_gateway && user_chosen_gateway_id.is_some() {
|
if !register_gateway && user_chosen_gateway_id.is_some() {
|
||||||
eprintln!("Using gateway provided by user, keeping existing keys");
|
println!("Using gateway provided by user, keeping existing keys");
|
||||||
return Ok(gateway.into());
|
return Ok(gateway.into());
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -142,8 +140,8 @@ where
|
|||||||
let our_identity = key_manager.identity_keypair();
|
let our_identity = key_manager.identity_keypair();
|
||||||
|
|
||||||
// Establish connection, authenticate and generate keys for talking with the gateway
|
// Establish connection, authenticate and generate keys for talking with the gateway
|
||||||
eprintln!("Registering with new gateway");
|
println!("Registering with new gateway");
|
||||||
let shared_keys = helpers::register_with_gateway::<St>(&gateway, our_identity).await?;
|
let shared_keys = helpers::register_with_gateway(&gateway, our_identity).await?;
|
||||||
key_manager.insert_gateway_shared_key(shared_keys);
|
key_manager.insert_gateway_shared_key(shared_keys);
|
||||||
|
|
||||||
// Write all keys to storage and just return the gateway endpoint config. It is assumed that we
|
// Write all keys to storage and just return the gateway endpoint config. It is assumed that we
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user