Compare commits
45 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 9f766549e8 | |||
| 98131d1277 | |||
| 42c2d4de7a | |||
| 688ffaf59a | |||
| 270d065661 | |||
| 25d66b5241 | |||
| a5d8a5071f | |||
| 6c51696cfd | |||
| f2196366e1 | |||
| ac22a9d4d9 | |||
| d77bcbb241 | |||
| a6f0fbff3d | |||
| 07e6d7750a | |||
| fcce6b435c | |||
| c7a66fc451 | |||
| 6dc7fc92bd | |||
| 215f927f0d | |||
| 7477337807 | |||
| 44db2b8d71 | |||
| 3260ba84fe | |||
| 89cddc62cc | |||
| fe3b47f103 | |||
| 636bbd9d12 | |||
| 2a338458b9 | |||
| ee2026e53d | |||
| 8f2cb95ffa | |||
| 79ef88dd49 | |||
| 216b32811c | |||
| baf7178dc8 | |||
| 00cdc5010a | |||
| 04bf153701 | |||
| e6eb83f350 | |||
| e8eb031fbd | |||
| 0ce5ba2668 | |||
| e8d601df67 | |||
| ca6b09ce8d | |||
| b8e27c67d9 | |||
| 8dbb72296b | |||
| c2893e5ca0 | |||
| 0489e5aa65 | |||
| eda8b6bf85 | |||
| a1aff09b91 | |||
| 5de218bca9 | |||
| 50960e7bf3 | |||
| 723e729f3b |
@@ -1,37 +0,0 @@
|
|||||||
name: 'Install wasm-opt'
|
|
||||||
description: 'Installs wasm-opt from binaryen'
|
|
||||||
inputs:
|
|
||||||
version:
|
|
||||||
description: 'Version of wasm-opt to install'
|
|
||||||
default: '116'
|
|
||||||
runs:
|
|
||||||
using: 'composite'
|
|
||||||
steps:
|
|
||||||
- name: Check platform compatibility
|
|
||||||
run: |
|
|
||||||
if [[ "$(uname)" != "Linux" ]]; then
|
|
||||||
echo "Error: This action is only compatible with Linux."
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
shell: bash
|
|
||||||
|
|
||||||
- name: Download wasm-opt
|
|
||||||
run: |
|
|
||||||
set -e
|
|
||||||
SOURCE="https://github.com/WebAssembly/binaryen/releases/download/version_${{ inputs.version }}/binaryen-version_${{ inputs.version }}-x86_64-linux.tar.gz"
|
|
||||||
TEMP_ARCHIVE="$RUNNER_TEMP/binaryen-version_${{ inputs.version }}-x86_64-linux.tar.gz"
|
|
||||||
curl -L -o "$TEMP_ARCHIVE" "$SOURCE"
|
|
||||||
tar -xvzf $TEMP_ARCHIVE -C $RUNNER_TEMP
|
|
||||||
echo "$RUNNER_TEMP/binaryen-version_${{ inputs.version }}/bin" >> $GITHUB_PATH
|
|
||||||
shell: bash
|
|
||||||
id: install-binary
|
|
||||||
|
|
||||||
- name: Verify installation
|
|
||||||
run: |
|
|
||||||
if ! command -v wasm-opt &> /dev/null; then
|
|
||||||
echo "Error: wasm-opt binary was not installed successfully."
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
shell: bash
|
|
||||||
id: verify-installation
|
|
||||||
|
|
||||||
@@ -3,27 +3,8 @@ import fetch from "node-fetch";
|
|||||||
import { Octokit } from "@octokit/rest";
|
import { Octokit } from "@octokit/rest";
|
||||||
import fs from "fs";
|
import fs from "fs";
|
||||||
import path from "path";
|
import path from "path";
|
||||||
import { execSync } from "child_process";
|
|
||||||
|
|
||||||
function getBinInfo(path) {
|
|
||||||
// let's be super naive about it. add a+x bits on the file and try to run the command
|
|
||||||
try {
|
|
||||||
let mode = fs.statSync(path).mode
|
|
||||||
fs.chmodSync(path, mode | 0o111)
|
|
||||||
|
|
||||||
const raw = execSync(`${path} build-info --output=json`, { stdio: 'pipe', encoding: "utf8" });
|
|
||||||
const parsed = JSON.parse(raw)
|
|
||||||
return parsed
|
|
||||||
} catch (_) {
|
|
||||||
return undefined
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function run(assets, algorithm, filename, cache) {
|
async function run(assets, algorithm, filename, cache) {
|
||||||
if (!cache) {
|
|
||||||
console.warn("cache is set to 'false', but we we no longer support it")
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
fs.mkdirSync('.tmp');
|
fs.mkdirSync('.tmp');
|
||||||
} catch(e) {
|
} catch(e) {
|
||||||
@@ -38,25 +19,26 @@ async function run(assets, algorithm, filename, cache) {
|
|||||||
|
|
||||||
let buffer = null;
|
let buffer = null;
|
||||||
let sig = null;
|
let sig = null;
|
||||||
|
if(cache) {
|
||||||
|
// cache in `${WORKING_DIR}/.tmp/`
|
||||||
|
const cacheFilename = path.resolve(`.tmp/${asset.name}`);
|
||||||
|
if(!fs.existsSync(cacheFilename)) {
|
||||||
|
console.log(`Downloading ${asset.browser_download_url}... to ${cacheFilename}`);
|
||||||
|
buffer = Buffer.from(await fetch(asset.browser_download_url).then(res => res.arrayBuffer()));
|
||||||
|
fs.writeFileSync(cacheFilename, buffer);
|
||||||
|
} else {
|
||||||
|
console.log(`Loading from ${cacheFilename}`);
|
||||||
|
buffer = Buffer.from(fs.readFileSync(cacheFilename));
|
||||||
|
|
||||||
// cache in `${WORKING_DIR}/.tmp/`
|
// console.log('Reading signature from content');
|
||||||
const cacheFilename = path.resolve(`.tmp/${asset.name}`);
|
// if(asset.name.endsWith('.sig')) {
|
||||||
if(!fs.existsSync(cacheFilename)) {
|
// sig = fs.readFileSync(cacheFilename).toString();
|
||||||
console.log(`Downloading ${asset.browser_download_url}... to ${cacheFilename}`);
|
// }
|
||||||
buffer = Buffer.from(await fetch(asset.browser_download_url).then(res => res.arrayBuffer()));
|
}
|
||||||
fs.writeFileSync(cacheFilename, buffer);
|
|
||||||
} else {
|
} else {
|
||||||
console.log(`Loading from ${cacheFilename}`);
|
// fetch always
|
||||||
buffer = Buffer.from(fs.readFileSync(cacheFilename));
|
buffer = Buffer.from(await fetch(asset.browser_download_url).then(res => res.arrayBuffer()));
|
||||||
|
|
||||||
// console.log('Reading signature from content');
|
|
||||||
// if(asset.name.endsWith('.sig')) {
|
|
||||||
// sig = fs.readFileSync(cacheFilename).toString();
|
|
||||||
// }
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const binInfo = getBinInfo(cacheFilename)
|
|
||||||
|
|
||||||
if(!hashes[asset.name]) {
|
if(!hashes[asset.name]) {
|
||||||
hashes[asset.name] = {};
|
hashes[asset.name] = {};
|
||||||
}
|
}
|
||||||
@@ -117,9 +99,6 @@ async function run(assets, algorithm, filename, cache) {
|
|||||||
if(kind) {
|
if(kind) {
|
||||||
hashes[asset.name].kind = kind;
|
hashes[asset.name].kind = kind;
|
||||||
}
|
}
|
||||||
if(binInfo) {
|
|
||||||
hashes[asset.name].details = binInfo;
|
|
||||||
}
|
|
||||||
|
|
||||||
// process Tauri signature files
|
// process Tauri signature files
|
||||||
if(asset.name.endsWith('.sig')) {
|
if(asset.name.endsWith('.sig')) {
|
||||||
@@ -246,8 +225,6 @@ export async function createHashesFromReleaseTagOrNameOrId({ releaseTagOrNameOrI
|
|||||||
assets: hashes,
|
assets: hashes,
|
||||||
};
|
};
|
||||||
|
|
||||||
console.log(output)
|
|
||||||
|
|
||||||
if(upload) {
|
if(upload) {
|
||||||
console.log(`🚚 Uploading ${filename} to release name="${release.name}" id=${release.id} (${release.upload_url})...`);
|
console.log(`🚚 Uploading ${filename} to release name="${release.name}" id=${release.id} (${release.upload_url})...`);
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,61 @@
|
|||||||
|
name: Build and upload binaries to artifact storage
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
add_tokio_unstable:
|
||||||
|
description: 'True to add RUSTFLAGS="--cfg tokio_unstable"'
|
||||||
|
required: true
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
|
||||||
|
env:
|
||||||
|
NETWORK: mainnet
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish-nym:
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
platform: [ubuntu-20.04]
|
||||||
|
|
||||||
|
runs-on: ${{ matrix.platform }}
|
||||||
|
env:
|
||||||
|
CARGO_TERM_COLOR: always
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Install Dependencies (Linux)
|
||||||
|
run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Sets env vars for tokio if set in manual dispatch inputs
|
||||||
|
run: |
|
||||||
|
echo 'RUSTFLAGS="--cfg tokio_unstable"' >> $GITHUB_ENV
|
||||||
|
if: github.event_name == 'workflow_dispatch' && inputs.add_tokio_unstable == true
|
||||||
|
|
||||||
|
- name: Install Rust stable
|
||||||
|
uses: actions-rs/toolchain@v1
|
||||||
|
with:
|
||||||
|
toolchain: stable
|
||||||
|
|
||||||
|
- name: Build all binaries
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: build
|
||||||
|
args: --workspace --release
|
||||||
|
|
||||||
|
- name: Upload Artifact
|
||||||
|
uses: actions/upload-artifact@v3
|
||||||
|
with:
|
||||||
|
name: nym-binaries-artifacts
|
||||||
|
path: |
|
||||||
|
target/release/nym-client
|
||||||
|
target/release/nym-gateway
|
||||||
|
target/release/nym-mixnode
|
||||||
|
target/release/nym-socks5-client
|
||||||
|
target/release/nym-api
|
||||||
|
target/release/nym-network-requester
|
||||||
|
target/release/nym-network-statistics
|
||||||
|
target/release/nym-cli
|
||||||
|
retention-days: 30
|
||||||
@@ -1,15 +1,17 @@
|
|||||||
name: cd-docs
|
name: CD docs
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
push:
|
||||||
|
branches: master
|
||||||
|
paths:
|
||||||
|
- 'documentation/docs/**'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-20.04-16-core
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
- name: Install Dependencies (Linux)
|
|
||||||
run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler
|
|
||||||
- name: Install rsync
|
- name: Install rsync
|
||||||
run: sudo apt-get install rsync
|
run: sudo apt-get install rsync
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
- uses: rlespinasse/github-slug-action@v3.x
|
||||||
@@ -24,16 +26,43 @@ jobs:
|
|||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: build
|
command: build
|
||||||
args: --workspace --release
|
args: --workspace --release --all
|
||||||
- name: Install mdbook and plugins
|
- name: Install mdbook
|
||||||
run: cd documentation && ./install_mdbook_deps.sh
|
run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4.33" mdbook)
|
||||||
- name: Remove existing Nym config directory (`~/.nym/`)
|
- name: Install mdbook plugins
|
||||||
run: cd documentation && ./remove_existing_config.sh
|
run: |
|
||||||
continue-on-error: false
|
cargo install --vers "=0.2.2" 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: Build all projects in documentation/ & move to ~/dist/docs/
|
- name: Build all projects in documentation/ & move to ~/dist/docs/
|
||||||
run: cd documentation && ./build_all_to_dist.sh
|
run: cd documentation && ./build_all_to_dist.sh
|
||||||
continue-on-error: false
|
continue-on-error: false
|
||||||
|
|
||||||
|
- 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: "dist/docs/"
|
||||||
|
REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_DEV }}
|
||||||
|
REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
|
||||||
|
TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET }}/
|
||||||
|
EXCLUDE: "/node_modules/"
|
||||||
|
|
||||||
|
- name: Deploy branch master to prod
|
||||||
|
if: github.ref == 'refs/heads/master'
|
||||||
|
uses: easingthemes/ssh-deploy@main
|
||||||
|
env:
|
||||||
|
SSH_PRIVATE_KEY: ${{ secrets.CD_WWW_SSH_PRIVATE_KEY }}
|
||||||
|
ARGS: "-rltgoDzvO --delete"
|
||||||
|
SOURCE: "dist/docs/"
|
||||||
|
REMOTE_HOST: ${{ secrets.CD_WWW_REMOTE_HOST_PROD }}
|
||||||
|
REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
|
||||||
|
TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET }}/
|
||||||
|
EXCLUDE: "/node_modules/"
|
||||||
|
|
||||||
- name: Post process
|
- name: Post process
|
||||||
run: cd documentation && ./post_process.sh
|
run: cd documentation && ./post_process.sh
|
||||||
continue-on-error: false
|
continue-on-error: false
|
||||||
@@ -48,7 +77,6 @@ jobs:
|
|||||||
|
|
||||||
- name: Install Vercel CLI
|
- name: Install Vercel CLI
|
||||||
run: npm install --global vercel@latest
|
run: npm install --global vercel@latest
|
||||||
continue-on-error: false
|
|
||||||
|
|
||||||
- name: Pull Vercel Environment Information (preview)
|
- name: Pull Vercel Environment Information (preview)
|
||||||
if: github.ref != 'refs/heads/master'
|
if: github.ref != 'refs/heads/master'
|
||||||
@@ -58,18 +86,15 @@ jobs:
|
|||||||
if: github.ref == 'refs/heads/master'
|
if: github.ref == 'refs/heads/master'
|
||||||
run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
|
run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
|
||||||
working-directory: dist/docs
|
working-directory: dist/docs
|
||||||
continue-on-error: false
|
|
||||||
|
|
||||||
- name: Build Project Artifacts (preview)
|
- name: Build Project Artifacts (preview)
|
||||||
if: github.ref != 'refs/heads/master'
|
if: github.ref != 'refs/heads/master'
|
||||||
run: vercel build --token=${{ secrets.VERCEL_TOKEN }}
|
run: vercel build --token=${{ secrets.VERCEL_TOKEN }}
|
||||||
working-directory: dist/docs
|
working-directory: dist/docs
|
||||||
continue-on-error: false
|
|
||||||
- name: Build Project Artifacts (production)
|
- name: Build Project Artifacts (production)
|
||||||
if: github.ref == 'refs/heads/master'
|
if: github.ref == 'refs/heads/master'
|
||||||
run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
|
run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
|
||||||
working-directory: dist/docs
|
working-directory: dist/docs
|
||||||
continue-on-error: false
|
|
||||||
|
|
||||||
- name: Deploy Project Artifacts to Vercel (preview)
|
- name: Deploy Project Artifacts to Vercel (preview)
|
||||||
if: github.ref != 'refs/heads/master'
|
if: github.ref != 'refs/heads/master'
|
||||||
@@ -79,7 +104,6 @@ jobs:
|
|||||||
if: github.ref == 'refs/heads/master'
|
if: github.ref == 'refs/heads/master'
|
||||||
run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}
|
run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}
|
||||||
working-directory: dist/docs
|
working-directory: dist/docs
|
||||||
continue-on-error: false
|
|
||||||
|
|
||||||
- name: Matrix - Node Install
|
- name: Matrix - Node Install
|
||||||
run: npm install
|
run: npm install
|
||||||
|
|||||||
+7
-7
@@ -1,4 +1,4 @@
|
|||||||
name: ci-binary-config-checker
|
name: Run config checks on all binaries
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
@@ -31,8 +31,8 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
platform: [custom-linux]
|
platform: [custom-runner-linux]
|
||||||
|
|
||||||
runs-on: ${{ matrix.platform }}
|
runs-on: ${{ matrix.platform }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
@@ -45,12 +45,12 @@ jobs:
|
|||||||
uses: actions-rs/toolchain@v1
|
uses: actions-rs/toolchain@v1
|
||||||
with:
|
with:
|
||||||
toolchain: stable
|
toolchain: stable
|
||||||
|
|
||||||
- name: Branch name
|
- name: Branch name
|
||||||
run: echo running on branch ${GITHUB_REF##*/}
|
run: echo running on branch ${GITHUB_REF##*/}
|
||||||
|
|
||||||
- name: Run tests against binaries
|
- name: Run tests against binaries
|
||||||
run: ./build_and_run.sh ${{ github.head_ref || github.ref_name }}
|
run: ./build_and_run.sh ${{ github.head_ref || github.ref_name }}
|
||||||
working-directory: tests/
|
working-directory: tests/
|
||||||
|
|
||||||
|
|
||||||
@@ -1,14 +1,13 @@
|
|||||||
name: ci-build-ts
|
name: ci-build-ts
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
push:
|
||||||
paths:
|
paths:
|
||||||
- "ts-packages/**"
|
- 'ts-packages/**'
|
||||||
- "sdk/typescript/**"
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-20.04-16-core
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- name: Install rsync
|
- name: Install rsync
|
||||||
@@ -21,7 +20,7 @@ jobs:
|
|||||||
- name: Setup yarn
|
- name: Setup yarn
|
||||||
run: npm install -g yarn
|
run: npm install -g yarn
|
||||||
- name: Build
|
- name: Build
|
||||||
run: yarn && yarn build && yarn build:ci:storybook
|
run: yarn && yarn build && yarn build:ci
|
||||||
- name: Deploy branch to CI www (storybook)
|
- name: Deploy branch to CI www (storybook)
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
uses: easingthemes/ssh-deploy@main
|
uses: easingthemes/ssh-deploy@main
|
||||||
|
|||||||
@@ -2,34 +2,37 @@ name: ci-build-upload-binaries
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
push:
|
||||||
add_tokio_unstable:
|
paths:
|
||||||
description: 'True to add RUSTFLAGS="--cfg tokio_unstable"'
|
- 'clients/**'
|
||||||
required: true
|
- 'common/**'
|
||||||
default: false
|
- 'explorer-api/**'
|
||||||
type: boolean
|
- 'gateway/**'
|
||||||
enable_wireguard:
|
- 'integrations/**'
|
||||||
description: 'Add --features wireguard'
|
- 'mixnode/**'
|
||||||
required: true
|
- 'sdk/rust/nym-sdk/**'
|
||||||
default: false
|
- 'service-providers/**'
|
||||||
type: boolean
|
- 'nym-api/**'
|
||||||
schedule:
|
- 'nym-outfox/**'
|
||||||
- cron: '14 0 * * *'
|
- 'tools/nym-cli/**'
|
||||||
|
- 'tools/ts-rs-cli/**'
|
||||||
pull_request:
|
pull_request:
|
||||||
paths:
|
paths:
|
||||||
- "clients/**"
|
- 'clients/**'
|
||||||
- "common/**"
|
- 'common/**'
|
||||||
- "explorer-api/**"
|
- 'explorer-api/**'
|
||||||
- "gateway/**"
|
- 'gateway/**'
|
||||||
- "integrations/**"
|
- 'integrations/**'
|
||||||
- "mixnode/**"
|
- 'mixnode/**'
|
||||||
- "nym-api/**"
|
- 'sdk/rust/nym-sdk/**'
|
||||||
- "nym-node/**"
|
- 'service-providers/**'
|
||||||
- "nym-outfox/**"
|
- 'nym-api/**'
|
||||||
- "nym-validator-rewarder/**"
|
- 'nym-outfox/**'
|
||||||
- "sdk/rust/nym-sdk/**"
|
- 'tools/nym-cli/**'
|
||||||
- "service-providers/**"
|
- 'tools/ts-rs-cli/**'
|
||||||
- "tools/**"
|
|
||||||
|
env:
|
||||||
|
NETWORK: mainnet
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish-nym:
|
publish-nym:
|
||||||
@@ -41,6 +44,8 @@ jobs:
|
|||||||
runs-on: ${{ matrix.platform }}
|
runs-on: ${{ matrix.platform }}
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
|
# a push event from the origin repo, or a PR from external repo
|
||||||
|
if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'nymtech/nym' }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
@@ -54,19 +59,8 @@ jobs:
|
|||||||
echo $OUTPUT_DIR
|
echo $OUTPUT_DIR
|
||||||
|
|
||||||
- name: Install Dependencies (Linux)
|
- name: Install Dependencies (Linux)
|
||||||
run: sudo apt update && sudo apt install libudev-dev
|
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 protobuf-compiler
|
||||||
|
continue-on-error: true
|
||||||
- name: Sets env vars for tokio if set in manual dispatch inputs
|
|
||||||
run: |
|
|
||||||
echo 'RUSTFLAGS="--cfg tokio_unstable"' >> $GITHUB_ENV
|
|
||||||
if: github.event_name == 'workflow_dispatch' && inputs.add_tokio_unstable == true
|
|
||||||
|
|
||||||
- name: Set CARGO_FEATURES
|
|
||||||
run: |
|
|
||||||
echo 'CARGO_FEATURES=--features wireguard' >> $GITHUB_ENV
|
|
||||||
if: >
|
|
||||||
github.event_name == 'schedule' ||
|
|
||||||
(github.event_name == 'workflow_dispatch' && inputs.enable_wireguard == true)
|
|
||||||
|
|
||||||
- name: Install Rust stable
|
- name: Install Rust stable
|
||||||
uses: actions-rs/toolchain@v1
|
uses: actions-rs/toolchain@v1
|
||||||
@@ -77,40 +71,9 @@ jobs:
|
|||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: build
|
command: build
|
||||||
args: --workspace --release ${{ env.CARGO_FEATURES }}
|
args: --workspace --release
|
||||||
|
|
||||||
- name: Install cargo-deb
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: install
|
|
||||||
args: cargo-deb
|
|
||||||
|
|
||||||
- name: Build deb packages
|
|
||||||
shell: bash
|
|
||||||
run: make deb
|
|
||||||
|
|
||||||
# If this was a manual workflow_dispatch, publish binaries.
|
|
||||||
|
|
||||||
- name: Upload Artifact
|
|
||||||
if: github.event_name == 'workflow_dispatch'
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
with:
|
|
||||||
name: nym-binaries-artifacts
|
|
||||||
path: |
|
|
||||||
target/release/nym-client
|
|
||||||
target/release/nym-gateway
|
|
||||||
target/release/nym-mixnode
|
|
||||||
target/release/nym-socks5-client
|
|
||||||
target/release/nym-api
|
|
||||||
target/release/nym-network-requester
|
|
||||||
target/release/nym-network-statistics
|
|
||||||
target/release/nym-cli
|
|
||||||
retention-days: 30
|
|
||||||
|
|
||||||
# If this was a pull_request or nightly, upload to build server
|
|
||||||
|
|
||||||
- name: Prepare build output
|
- name: Prepare build output
|
||||||
# if: github.event_name == 'schedule' || github.event_name == 'pull_request'
|
|
||||||
shell: bash
|
shell: bash
|
||||||
env:
|
env:
|
||||||
OUTPUT_DIR: ci-builds/${{ github.ref_name }}
|
OUTPUT_DIR: ci-builds/${{ github.ref_name }}
|
||||||
@@ -124,10 +87,8 @@ jobs:
|
|||||||
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/explorer-api $OUTPUT_DIR
|
cp target/release/explorer-api $OUTPUT_DIR
|
||||||
cp target/debian/*.deb $OUTPUT_DIR
|
|
||||||
|
|
||||||
- name: Deploy branch to CI www
|
- name: Deploy branch to CI www
|
||||||
# if: github.event_name == 'schedule' || github.event_name == 'pull_request'
|
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
uses: easingthemes/ssh-deploy@main
|
uses: easingthemes/ssh-deploy@main
|
||||||
env:
|
env:
|
||||||
|
|||||||
@@ -48,6 +48,9 @@ jobs:
|
|||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
|
# Enable sccache via environment variable
|
||||||
|
# env:
|
||||||
|
# RUSTC_WRAPPER: /home/ubuntu/.cargo/bin/sccache
|
||||||
steps:
|
steps:
|
||||||
- name: Install Dependencies (Linux)
|
- 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 protobuf-compiler
|
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 protobuf-compiler
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
name: ci-cargo-deny
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
pull_request:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
cargo-deny:
|
|
||||||
runs-on: ubuntu-22.04
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
checks:
|
|
||||||
# - advisories
|
|
||||||
- licenses bans sources
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- uses: EmbarkStudios/cargo-deny-action@v1
|
|
||||||
with:
|
|
||||||
log-level: warn
|
|
||||||
command: check ${{ matrix.checks }}
|
|
||||||
argument: --all-features
|
|
||||||
@@ -2,6 +2,10 @@ name: ci-contracts-schema
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
push:
|
||||||
|
paths:
|
||||||
|
- 'contracts/**'
|
||||||
|
- 'common/**'
|
||||||
pull_request:
|
pull_request:
|
||||||
paths:
|
paths:
|
||||||
- 'contracts/**'
|
- 'contracts/**'
|
||||||
@@ -10,7 +14,7 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
check-schema:
|
check-schema:
|
||||||
name: Generate and check schema
|
name: Generate and check schema
|
||||||
runs-on: custom-linux
|
runs-on: custom-runner-linux
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
steps:
|
steps:
|
||||||
|
|||||||
@@ -2,6 +2,10 @@ name: ci-contracts-upload-binaries
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
push:
|
||||||
|
paths:
|
||||||
|
- 'common/**'
|
||||||
|
- 'contracts/**'
|
||||||
pull_request:
|
pull_request:
|
||||||
paths:
|
paths:
|
||||||
- 'common/**'
|
- 'common/**'
|
||||||
@@ -20,6 +24,8 @@ jobs:
|
|||||||
runs-on: ${{ matrix.platform }}
|
runs-on: ${{ matrix.platform }}
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
|
# a push event from the origin repo, or a PR from external repo
|
||||||
|
if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'nymtech/nym' }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
@@ -32,17 +38,19 @@ jobs:
|
|||||||
mkdir -p $OUTPUT_DIR
|
mkdir -p $OUTPUT_DIR
|
||||||
echo $OUTPUT_DIR
|
echo $OUTPUT_DIR
|
||||||
|
|
||||||
|
- name: Install Dependencies (Linux)
|
||||||
|
run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools protobuf-compiler
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
- name: Install Rust stable
|
- name: Install Rust stable
|
||||||
uses: actions-rs/toolchain@v1
|
uses: actions-rs/toolchain@v1
|
||||||
with:
|
with:
|
||||||
toolchain: stable
|
toolchain: 1.69.0
|
||||||
target: wasm32-unknown-unknown
|
target: wasm32-unknown-unknown
|
||||||
override: true
|
override: true
|
||||||
|
|
||||||
- name: Install wasm-opt
|
- name: Install wasm-opt
|
||||||
uses: ./.github/actions/install-wasm-opt
|
run: cargo install --version 0.112.0 wasm-opt
|
||||||
with:
|
|
||||||
version: '114'
|
|
||||||
|
|
||||||
- name: Build release contracts
|
- name: Build release contracts
|
||||||
run: make contracts
|
run: make contracts
|
||||||
|
|||||||
@@ -9,11 +9,9 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-20.04-16-core
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
- name: Install Dependencies (Linux)
|
|
||||||
run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler
|
|
||||||
- name: Install rsync
|
- name: Install rsync
|
||||||
run: sudo apt-get install rsync
|
run: sudo apt-get install rsync
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
- uses: rlespinasse/github-slug-action@v3.x
|
||||||
@@ -28,16 +26,18 @@ jobs:
|
|||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: build
|
command: build
|
||||||
args: --workspace --release
|
args: --workspace --release --all
|
||||||
- name: Install mdbook and plugins
|
- name: Install mdbook
|
||||||
run: cd documentation && ./install_mdbook_deps.sh
|
run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4.33" mdbook)
|
||||||
- name: Remove existing Nym config directory (`~/.nym/`)
|
- name: Install mdbook plugins
|
||||||
run: cd documentation && ./remove_existing_config.sh
|
run: |
|
||||||
continue-on-error: false
|
cargo install --vers "=0.2.2" 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: Build all projects in documentation/ & move to ~/dist/docs/
|
- name: Build all projects in documentation/ & move to ~/dist/docs/
|
||||||
run: cd documentation && ./build_all_to_dist.sh
|
run: cd documentation && ./build_all_to_dist.sh
|
||||||
continue-on-error: false
|
continue-on-error: false
|
||||||
|
|
||||||
- name: Deploy branch to CI www
|
- name: Deploy branch to CI www
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
uses: easingthemes/ssh-deploy@main
|
uses: easingthemes/ssh-deploy@main
|
||||||
@@ -49,7 +49,6 @@ jobs:
|
|||||||
REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
|
REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
|
||||||
TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/docs-${{ env.GITHUB_REF_SLUG }}
|
TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/docs-${{ env.GITHUB_REF_SLUG }}
|
||||||
EXCLUDE: "/node_modules/"
|
EXCLUDE: "/node_modules/"
|
||||||
|
|
||||||
- name: Matrix - Node Install
|
- name: Matrix - Node Install
|
||||||
run: npm install
|
run: npm install
|
||||||
working-directory: .github/workflows/support-files
|
working-directory: .github/workflows/support-files
|
||||||
|
|||||||
@@ -1,6 +1,15 @@
|
|||||||
name: ci-lint-typescript
|
name: ci-lint-typescript
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
push:
|
||||||
|
paths:
|
||||||
|
- "ts-packages/**"
|
||||||
|
- "sdk/typescript/**"
|
||||||
|
- "nym-connect/desktop/src/**"
|
||||||
|
- "nym-connect/desktop/package.json"
|
||||||
|
- "nym-wallet/src/**"
|
||||||
|
- "nym-wallet/package.json"
|
||||||
|
- "explorer/**"
|
||||||
pull_request:
|
pull_request:
|
||||||
paths:
|
paths:
|
||||||
- "ts-packages/**"
|
- "ts-packages/**"
|
||||||
@@ -13,7 +22,7 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-20.04-16-core
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
- uses: rlespinasse/github-slug-action@v3.x
|
||||||
@@ -28,15 +37,9 @@ jobs:
|
|||||||
uses: actions-rs/toolchain@v1
|
uses: actions-rs/toolchain@v1
|
||||||
with:
|
with:
|
||||||
toolchain: stable
|
toolchain: stable
|
||||||
|
|
||||||
- name: Install wasm-pack
|
- name: Install wasm-pack
|
||||||
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
||||||
|
|
||||||
- name: Install wasm-opt
|
|
||||||
uses: ./.github/actions/install-wasm-opt
|
|
||||||
with:
|
|
||||||
version: '116'
|
|
||||||
|
|
||||||
- name: Set up Go
|
- name: Set up Go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
@@ -46,7 +49,7 @@ jobs:
|
|||||||
run: yarn
|
run: yarn
|
||||||
|
|
||||||
- name: Build packages
|
- name: Build packages
|
||||||
run: yarn build:ci
|
run: yarn build:ci:sdk
|
||||||
|
|
||||||
- name: Lint
|
- name: Lint
|
||||||
run: yarn lint
|
run: yarn lint
|
||||||
|
|||||||
@@ -1,6 +1,16 @@
|
|||||||
name: ci-nym-connect-desktop-rust
|
name: ci-nym-connect-desktop-rust
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
push:
|
||||||
|
paths:
|
||||||
|
- "nym-connect/desktop/src-tauri/**"
|
||||||
|
- "nym-connect/desktop/src-tauri/Cargo.toml"
|
||||||
|
- "clients/client-core/**"
|
||||||
|
- "clients/socks5/**"
|
||||||
|
- "common/**"
|
||||||
|
- "gateway/gateway-requests/**"
|
||||||
|
- "contracts/vesting/**"
|
||||||
|
- "nym-api/nym-api-requests/**"
|
||||||
pull_request:
|
pull_request:
|
||||||
paths:
|
paths:
|
||||||
- "nym-connect/desktop/src-tauri/**"
|
- "nym-connect/desktop/src-tauri/**"
|
||||||
@@ -17,6 +27,8 @@ jobs:
|
|||||||
runs-on: [self-hosted, custom-linux]
|
runs-on: [self-hosted, custom-linux]
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
|
# env:
|
||||||
|
# RUSTC_WRAPPER: /home/ubuntu/.cargo/bin/sccache
|
||||||
steps:
|
steps:
|
||||||
- name: Install Dependencies (Linux)
|
- name: Install Dependencies (Linux)
|
||||||
run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools libayatana-appindicator3-dev
|
run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools libayatana-appindicator3-dev
|
||||||
@@ -33,12 +45,6 @@ jobs:
|
|||||||
override: true
|
override: true
|
||||||
components: rustfmt, clippy
|
components: rustfmt, clippy
|
||||||
|
|
||||||
- name: Check formatting
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: fmt
|
|
||||||
args: --manifest-path nym-connect/desktop/Cargo.toml --all -- --check
|
|
||||||
|
|
||||||
- name: Build all binaries
|
- name: Build all binaries
|
||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
@@ -51,6 +57,12 @@ jobs:
|
|||||||
command: test
|
command: test
|
||||||
args: --manifest-path nym-connect/desktop/Cargo.toml --workspace
|
args: --manifest-path nym-connect/desktop/Cargo.toml --workspace
|
||||||
|
|
||||||
|
- name: Check formatting
|
||||||
|
uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: fmt
|
||||||
|
args: --manifest-path nym-connect/desktop/Cargo.toml --all -- --check
|
||||||
|
|
||||||
- uses: actions-rs/clippy-check@v1
|
- uses: actions-rs/clippy-check@v1
|
||||||
name: Clippy checks
|
name: Clippy checks
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
name: ci-nym-connect-desktop
|
name: ci-nym-connect-desktop
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
push:
|
||||||
paths:
|
paths:
|
||||||
- 'nym-connect/desktop/**'
|
- 'nym-connect/desktop/**'
|
||||||
|
|
||||||
@@ -11,7 +11,7 @@ defaults:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: custom-linux
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- name: Install rsync
|
- name: Install rsync
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ defaults:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: custom-linux
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- name: Install rsync
|
- name: Install rsync
|
||||||
|
|||||||
@@ -19,6 +19,8 @@ jobs:
|
|||||||
runs-on: [ self-hosted, custom-linux ]
|
runs-on: [ self-hosted, custom-linux ]
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
|
# env:
|
||||||
|
# RUSTC_WRAPPER: /home/ubuntu/.cargo/bin/sccache
|
||||||
steps:
|
steps:
|
||||||
- name: Install Dependencies (Linux)
|
- name: Install Dependencies (Linux)
|
||||||
run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools
|
run: sudo apt-get update && sudo apt-get -y install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools
|
||||||
|
|||||||
@@ -1,44 +1,35 @@
|
|||||||
name: ci-nym-wallet-storybook
|
name: Nym Wallet Storybook
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
push:
|
||||||
paths:
|
paths:
|
||||||
- 'nym-wallet/**'
|
- 'nym-wallet/**'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: custom-linux
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: Install rsync
|
- name: Install rsync
|
||||||
run: sudo apt-get install rsync
|
run: sudo apt-get install rsync
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
|
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
- uses: rlespinasse/github-slug-action@v3.x
|
||||||
|
|
||||||
- uses: actions/setup-node@v3
|
- uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: 18
|
node-version: 18
|
||||||
|
|
||||||
- name: Setup yarn
|
- name: Setup yarn
|
||||||
run: npm install -g yarn
|
run: npm install -g yarn
|
||||||
|
|
||||||
- name: Install Rust stable
|
- name: Install Rust stable
|
||||||
uses: actions-rs/toolchain@v1
|
uses: actions-rs/toolchain@v1
|
||||||
with:
|
with:
|
||||||
toolchain: stable
|
toolchain: stable
|
||||||
|
|
||||||
- name: Install wasm-pack
|
- name: Install wasm-pack
|
||||||
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
||||||
|
|
||||||
- name: Build dependencies
|
- name: Build dependencies
|
||||||
run: yarn && yarn build
|
run: yarn && yarn build
|
||||||
|
|
||||||
- name: Build storybook
|
- name: Build storybook
|
||||||
run: yarn storybook:build
|
run: yarn storybook:build
|
||||||
working-directory: ./nym-wallet
|
working-directory: ./nym-wallet
|
||||||
|
|
||||||
- name: Deploy branch to CI www (storybook)
|
- name: Deploy branch to CI www (storybook)
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
uses: easingthemes/ssh-deploy@main
|
uses: easingthemes/ssh-deploy@main
|
||||||
@@ -50,11 +41,9 @@ jobs:
|
|||||||
REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
|
REMOTE_USER: ${{ secrets.CI_WWW_REMOTE_USER }}
|
||||||
TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/wallet-${{ env.GITHUB_REF_SLUG }}
|
TARGET: ${{ secrets.CI_WWW_REMOTE_TARGET }}/wallet-${{ env.GITHUB_REF_SLUG }}
|
||||||
EXCLUDE: "/dist/, /node_modules/"
|
EXCLUDE: "/dist/, /node_modules/"
|
||||||
|
|
||||||
- name: Matrix - Node Install
|
- name: Matrix - Node Install
|
||||||
run: npm install
|
run: npm install
|
||||||
working-directory: .github/workflows/support-files
|
working-directory: .github/workflows/support-files
|
||||||
|
|
||||||
- name: Matrix - Send Notification
|
- name: Matrix - Send Notification
|
||||||
env:
|
env:
|
||||||
NYM_NOTIFICATION_KIND: nym-wallet
|
NYM_NOTIFICATION_KIND: nym-wallet
|
||||||
|
|||||||
@@ -1,6 +1,10 @@
|
|||||||
name: ci-sdk-docs-typescript
|
name: ci-sdk-docs-typescript
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
push:
|
||||||
|
paths:
|
||||||
|
- "sdk/typescript/**"
|
||||||
|
- "wasm/**"
|
||||||
pull_request:
|
pull_request:
|
||||||
paths:
|
paths:
|
||||||
- "sdk/typescript/**"
|
- "sdk/typescript/**"
|
||||||
@@ -8,7 +12,7 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: custom-linux
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- name: Install rsync
|
- name: Install rsync
|
||||||
@@ -30,14 +34,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
go-version: '1.20'
|
go-version: '1.20'
|
||||||
|
|
||||||
- name: Install wasm-pack
|
|
||||||
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
|
||||||
|
|
||||||
- name: Install wasm-opt
|
|
||||||
uses: ./.github/actions/install-wasm-opt
|
|
||||||
with:
|
|
||||||
version: '116'
|
|
||||||
|
|
||||||
- name: Build branch WASM packages
|
- name: Build branch WASM packages
|
||||||
run: make sdk-wasm-build
|
run: make sdk-wasm-build
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
wasm:
|
wasm:
|
||||||
runs-on: [custom-linux]
|
runs-on: [custom-runner-linux]
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
steps:
|
steps:
|
||||||
@@ -18,7 +18,7 @@ jobs:
|
|||||||
- uses: actions/setup-node@v3
|
- uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: 18
|
node-version: 18
|
||||||
|
|
||||||
- uses: actions-rs/toolchain@v1
|
- uses: actions-rs/toolchain@v1
|
||||||
with:
|
with:
|
||||||
profile: minimal
|
profile: minimal
|
||||||
@@ -32,13 +32,12 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
go-version: '1.20'
|
go-version: '1.20'
|
||||||
|
|
||||||
|
|
||||||
- name: Install wasm-pack
|
- name: Install wasm-pack
|
||||||
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
||||||
|
|
||||||
- name: Install wasm-opt
|
- name: Install wasm-opt
|
||||||
uses: ./.github/actions/install-wasm-opt
|
run: cargo install wasm-opt
|
||||||
with:
|
|
||||||
version: '116'
|
|
||||||
|
|
||||||
- name: Install wasm-bindgen-cli
|
- name: Install wasm-bindgen-cli
|
||||||
run: cargo install wasm-bindgen-cli
|
run: cargo install wasm-bindgen-cli
|
||||||
|
|||||||
@@ -1,43 +0,0 @@
|
|||||||
# Simple workflow for deploying static content to GitHub Pages
|
|
||||||
name: Deploy static content to Pages
|
|
||||||
|
|
||||||
on:
|
|
||||||
# Runs on pushes targeting the default branch
|
|
||||||
push:
|
|
||||||
branches: ["feature/ppa-repo"]
|
|
||||||
|
|
||||||
# Allows you to run this workflow manually from the Actions tab
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pages: write
|
|
||||||
id-token: write
|
|
||||||
|
|
||||||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
|
||||||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
|
||||||
concurrency:
|
|
||||||
group: "pages"
|
|
||||||
cancel-in-progress: false
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
# Single deploy job since we're just deploying
|
|
||||||
deploy:
|
|
||||||
environment:
|
|
||||||
name: github-pages
|
|
||||||
url: ${{ steps.deployment.outputs.page_url }}
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
- name: Setup Pages
|
|
||||||
uses: actions/configure-pages@v3
|
|
||||||
- name: Upload artifact
|
|
||||||
uses: actions/upload-pages-artifact@v2
|
|
||||||
with:
|
|
||||||
# Upload entire repository
|
|
||||||
path: './ppa'
|
|
||||||
- name: Deploy to GitHub Pages
|
|
||||||
id: deployment
|
|
||||||
uses: actions/deploy-pages@v2
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
name: greetings
|
name: Greetings
|
||||||
|
|
||||||
on: [pull_request_target, issues]
|
on: [pull_request_target, issues]
|
||||||
|
|
||||||
|
|||||||
@@ -4,25 +4,25 @@ on:
|
|||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
schedule:
|
schedule:
|
||||||
- cron: '14 1 * * *'
|
- cron: '14 1 * * *'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
rust: [stable, beta]
|
rust: [stable, beta]
|
||||||
os: [ubuntu-20.04, windows-latest, macos-latest]
|
os: [custom-linux, windows10, custom-runner-mac-m1]
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
steps:
|
steps:
|
||||||
- name: Check out repository code
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Install Dependencies (Linux)
|
- name: Install Dependencies (Linux)
|
||||||
run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler
|
run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler
|
||||||
if: matrix.os == 'ubuntu-20.04'
|
continue-on-error: true
|
||||||
|
if: matrix.os == 'custom-linux'
|
||||||
|
|
||||||
|
- name: Check out repository code
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
- name: Install Rust toolchain
|
- name: Install Rust toolchain
|
||||||
uses: actions-rs/toolchain@v1
|
uses: actions-rs/toolchain@v1
|
||||||
@@ -32,12 +32,6 @@ jobs:
|
|||||||
override: true
|
override: true
|
||||||
components: rustfmt, clippy
|
components: rustfmt, clippy
|
||||||
|
|
||||||
- name: Install Protoc
|
|
||||||
uses: arduino/setup-protoc@v2
|
|
||||||
if: matrix.os == 'macos-latest' || matrix.os == 'windows-latest'
|
|
||||||
with:
|
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Check formatting
|
- name: Check formatting
|
||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
@@ -48,27 +42,13 @@ jobs:
|
|||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: build
|
command: build
|
||||||
args: --release --workspace
|
args: --workspace
|
||||||
|
|
||||||
- name: Build examples
|
- name: Build examples
|
||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: build
|
command: build
|
||||||
args: --release --workspace --examples
|
args: --workspace --examples
|
||||||
|
|
||||||
# To avoid running out of disk space, skip generating debug symbols
|
|
||||||
- name: Set debug to false (unix)
|
|
||||||
if: matrix.os == 'ubuntu-20.04' || matrix.os == 'macos-latest'
|
|
||||||
run: |
|
|
||||||
sed -i.bak 's/\[profile.dev\]/\[profile.dev\]\ndebug = false/' Cargo.toml
|
|
||||||
git diff
|
|
||||||
|
|
||||||
- name: Set debug to false (win)
|
|
||||||
if: matrix.os == 'windows-latest'
|
|
||||||
shell: pwsh
|
|
||||||
run: |
|
|
||||||
(Get-Content Cargo.toml) -replace '\[profile.dev\]', "`$&`ndebug = false" | Set-Content Cargo.toml
|
|
||||||
git diff
|
|
||||||
|
|
||||||
- name: Run unit tests
|
- name: Run unit tests
|
||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
@@ -82,11 +62,6 @@ jobs:
|
|||||||
command: test
|
command: test
|
||||||
args: --workspace -- --ignored
|
args: --workspace -- --ignored
|
||||||
|
|
||||||
- name: Clean
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: clean
|
|
||||||
|
|
||||||
- name: Clippy
|
- name: Clippy
|
||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
@@ -95,7 +70,7 @@ jobs:
|
|||||||
|
|
||||||
notification:
|
notification:
|
||||||
needs: build
|
needs: build
|
||||||
runs-on: custom-linux
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- name: Collect jobs status
|
- name: Collect jobs status
|
||||||
uses: technote-space/workflow-conclusion-action@v2
|
uses: technote-space/workflow-conclusion-action@v2
|
||||||
|
|||||||
@@ -1,92 +0,0 @@
|
|||||||
name: nightly-nym-connect-desktop-build
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
schedule:
|
|
||||||
- cron: '14 1 * * *'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
os: [ubuntu-20.04, macos-latest, windows-latest]
|
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
env:
|
|
||||||
CARGO_TERM_COLOR: always
|
|
||||||
MANIFEST_PATH: --manifest-path nym-connect/desktop/Cargo.toml
|
|
||||||
continue-on-error: true
|
|
||||||
steps:
|
|
||||||
- name: Check out repository code
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Install Dependencies (Linux)
|
|
||||||
run: sudo apt-get update && sudo apt-get install -y libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools
|
|
||||||
if: matrix.os == 'ubuntu-20.04'
|
|
||||||
|
|
||||||
- name: Install rust toolchain
|
|
||||||
uses: actions-rs/toolchain@v1
|
|
||||||
with:
|
|
||||||
profile: minimal
|
|
||||||
toolchain: stable
|
|
||||||
override: true
|
|
||||||
components: rustfmt, clippy
|
|
||||||
|
|
||||||
- name: Check formatting
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: fmt
|
|
||||||
args: ${{ env.MANIFEST_PATH }} --all -- --check
|
|
||||||
|
|
||||||
- name: Build
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: build
|
|
||||||
args: ${{ env.MANIFEST_PATH }} --release --workspace
|
|
||||||
|
|
||||||
- name: Unit tests
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: test
|
|
||||||
args: ${{ env.MANIFEST_PATH }} --workspace
|
|
||||||
|
|
||||||
- name: Clippy
|
|
||||||
uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: clippy
|
|
||||||
args: ${{ env.MANIFEST_PATH }} --workspace --all-targets -- -D warnings
|
|
||||||
|
|
||||||
notification:
|
|
||||||
needs: build
|
|
||||||
runs-on: custom-linux
|
|
||||||
steps:
|
|
||||||
- name: Collect jobs status
|
|
||||||
uses: technote-space/workflow-conclusion-action@v2
|
|
||||||
- name: Check out repository code
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
- name: install npm
|
|
||||||
uses: actions/setup-node@v3
|
|
||||||
if: env.WORKFLOW_CONCLUSION == 'failure'
|
|
||||||
with:
|
|
||||||
node-version: 18
|
|
||||||
- name: Matrix - Node Install
|
|
||||||
if: env.WORKFLOW_CONCLUSION == 'failure'
|
|
||||||
run: npm install
|
|
||||||
working-directory: .github/workflows/support-files
|
|
||||||
- name: Matrix - Send Notification
|
|
||||||
if: env.WORKFLOW_CONCLUSION == 'failure'
|
|
||||||
env:
|
|
||||||
NYM_NOTIFICATION_KIND: nightly
|
|
||||||
NYM_PROJECT_NAME: "nym-connect-desktop-nightly-build"
|
|
||||||
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|
|
||||||
GIT_COMMIT_MESSAGE: "${{ github.event.head_commit.message }}"
|
|
||||||
GIT_BRANCH: "${GITHUB_REF##*/}"
|
|
||||||
IS_SUCCESS: "${{ env.WORKFLOW_CONCLUSION == 'success' }}"
|
|
||||||
MATRIX_SERVER: "${{ secrets.MATRIX_SERVER }}"
|
|
||||||
MATRIX_ROOM: "${{ secrets.MATRIX_ROOM_NIGHTLY }}"
|
|
||||||
MATRIX_USER_ID: "${{ secrets.MATRIX_USER_ID }}"
|
|
||||||
MATRIX_TOKEN: "${{ secrets.MATRIX_TOKEN }}"
|
|
||||||
MATRIX_DEVICE_ID: "${{ secrets.MATRIX_DEVICE_ID }}"
|
|
||||||
uses: docker://keybaseio/client:stable-node
|
|
||||||
with:
|
|
||||||
args: .github/workflows/support-files/notifications/entry_point.sh
|
|
||||||
@@ -5,24 +5,27 @@ on:
|
|||||||
schedule:
|
schedule:
|
||||||
- cron: '14 1 * * *'
|
- cron: '14 1 * * *'
|
||||||
|
|
||||||
|
defaults:
|
||||||
|
run:
|
||||||
|
working-directory: nym-wallet
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-20.04, macos-latest, windows-latest]
|
os: [custom-ubuntu-20.04, macos-latest, windows10]
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
MANIFEST_PATH: --manifest-path nym-wallet/Cargo.toml
|
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
steps:
|
steps:
|
||||||
- name: Check out repository code
|
- name: Check out repository code
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
- name: Install Dependencies (Linux)
|
- name: Install Dependencies (Linux)
|
||||||
run: sudo apt-get update && sudo apt-get install -y libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev squashfs-tools
|
run: sudo apt-get update && sudo apt-get install -y libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libudev-dev squashfs-tools protobuf-compiler
|
||||||
if: matrix.os == 'ubuntu-20.04'
|
if: matrix.os == 'custom-linux'
|
||||||
|
|
||||||
- name: Install rust toolchain
|
- name: Install rust toolchain
|
||||||
uses: actions-rs/toolchain@v1
|
uses: actions-rs/toolchain@v1
|
||||||
@@ -36,29 +39,36 @@ jobs:
|
|||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: fmt
|
command: fmt
|
||||||
args: ${{ env.MANIFEST_PATH }} --all -- --check
|
args: --all -- --check
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: build
|
command: build
|
||||||
args: ${{ env.MANIFEST_PATH }} --release --workspace
|
args: --workspace
|
||||||
|
|
||||||
- name: Unit tests
|
- name: Unit tests
|
||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: test
|
command: test
|
||||||
args: ${{ env.MANIFEST_PATH }} --workspace
|
args: --workspace
|
||||||
|
|
||||||
|
- name: Annotate with clippy warnings
|
||||||
|
uses: actions-rs/clippy-check@v1
|
||||||
|
continue-on-error: true
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
args: --workspace
|
||||||
|
|
||||||
- name: Clippy
|
- name: Clippy
|
||||||
uses: actions-rs/cargo@v1
|
uses: actions-rs/cargo@v1
|
||||||
with:
|
with:
|
||||||
command: clippy
|
command: clippy
|
||||||
args: ${{ env.MANIFEST_PATH }} --workspace --all-targets -- -D warnings
|
args: --workspace --all-targets -- -D warnings
|
||||||
|
|
||||||
notification:
|
notification:
|
||||||
needs: build
|
needs: build
|
||||||
runs-on: custom-linux
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- name: Collect jobs status
|
- name: Collect jobs status
|
||||||
uses: technote-space/workflow-conclusion-action@v2
|
uses: technote-space/workflow-conclusion-action@v2
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: nightly-security-audit
|
name: Daily security audit
|
||||||
|
|
||||||
on:
|
on:
|
||||||
schedule:
|
schedule:
|
||||||
@@ -26,7 +26,7 @@ jobs:
|
|||||||
path: .github/workflows/support-files/notifications/deny.message
|
path: .github/workflows/support-files/notifications/deny.message
|
||||||
notification:
|
notification:
|
||||||
needs: cargo-deny
|
needs: cargo-deny
|
||||||
runs-on: custom-linux
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- name: Check out repository code
|
- name: Check out repository code
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: publish-nym-binaries
|
name: Publish Nym binaries
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: publish-nym-connect-macos
|
name: Publish Nym Connect - desktop (MacOS)
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
release:
|
release:
|
||||||
@@ -14,7 +14,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
platform: [macos-12-large]
|
platform: [macos-latest]
|
||||||
runs-on: ${{ matrix.platform }}
|
runs-on: ${{ matrix.platform }}
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: publish-nym-connect-ubuntu
|
name: Publish Nym Connect - desktop (Ubuntu)
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
release:
|
release:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: publish-nym-connect-win10
|
name: Publish Nym Connect - desktop (Windows 10)
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
release:
|
release:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: publish-nym-contracts
|
name: Build release of Nym smart contracts
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
release:
|
release:
|
||||||
@@ -14,13 +14,13 @@ jobs:
|
|||||||
- name: Install Rust stable
|
- name: Install Rust stable
|
||||||
uses: actions-rs/toolchain@v1
|
uses: actions-rs/toolchain@v1
|
||||||
with:
|
with:
|
||||||
toolchain: stable
|
toolchain: 1.69.0
|
||||||
target: wasm32-unknown-unknown
|
target: wasm32-unknown-unknown
|
||||||
override: true
|
override: true
|
||||||
components: rustfmt, clippy
|
components: rustfmt, clippy
|
||||||
|
|
||||||
- name: Install wasm-opt
|
- name: Install wasm-opt
|
||||||
run: cargo install --version 0.114.0 wasm-opt
|
run: cargo install --version 0.112.0 wasm-opt
|
||||||
|
|
||||||
- name: Build release contracts
|
- name: Build release contracts
|
||||||
run: make contracts
|
run: make contracts
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: publish-nym-wallet-macos
|
name: Publish Nym Wallet (MacOS)
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
release:
|
release:
|
||||||
@@ -14,7 +14,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
platform: [macos-12-large]
|
platform: [macos-latest]
|
||||||
runs-on: ${{ matrix.platform }}
|
runs-on: ${{ matrix.platform }}
|
||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
@@ -39,7 +39,6 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
|
APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
|
||||||
APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
|
APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
|
||||||
APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
|
|
||||||
KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }}
|
KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }}
|
||||||
run: |
|
run: |
|
||||||
# create variables
|
# create variables
|
||||||
@@ -74,7 +73,6 @@ jobs:
|
|||||||
ENABLE_CODE_SIGNING: ${{ secrets.APPLE_CERTIFICATE }}
|
ENABLE_CODE_SIGNING: ${{ secrets.APPLE_CERTIFICATE }}
|
||||||
APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
|
APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
|
||||||
APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
|
APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
|
||||||
APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
|
|
||||||
APPLE_SIGNING_IDENTITY: ${{ secrets.APPLE_IDENTITY_ID }}
|
APPLE_SIGNING_IDENTITY: ${{ secrets.APPLE_IDENTITY_ID }}
|
||||||
APPLE_ID: ${{ secrets.APPLE_ID }}
|
APPLE_ID: ${{ secrets.APPLE_ID }}
|
||||||
APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }}
|
APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: publish-nym-wallet-ubuntu
|
name: Publish Nym Wallet (Ubuntu)
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
release:
|
release:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: publish-nym-wallet-win10
|
name: Publish Nym Wallet (Windows 10)
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
release:
|
release:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: publish-nyms5-android-apk
|
name: Nyms5 Android
|
||||||
# unsigned APKs only, supported archs:
|
# unsigned APKs only, supported archs:
|
||||||
# - arm64-v8a (arm64)
|
# - arm64-v8a (arm64)
|
||||||
# - x86_64
|
# - x86_64
|
||||||
@@ -94,7 +94,7 @@ jobs:
|
|||||||
gh-release:
|
gh-release:
|
||||||
name: Publish APK (GH release)
|
name: Publish APK (GH release)
|
||||||
needs: build
|
needs: build
|
||||||
runs-on: custom-linux
|
runs-on: custom-runner-linux
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
name: publish-sdk-npm
|
name: Publish Typescript SDK
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish:
|
publish:
|
||||||
runs-on: ubuntu-20.04-16-core
|
runs-on: [custom-ubuntu-20.04]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
@@ -12,7 +12,7 @@ jobs:
|
|||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: 18
|
node-version: 18
|
||||||
registry-url: "https://registry.npmjs.org"
|
registry-url: 'https://registry.npmjs.org'
|
||||||
|
|
||||||
- name: Setup yarn
|
- name: Setup yarn
|
||||||
run: npm install -g yarn
|
run: npm install -g yarn
|
||||||
@@ -25,19 +25,6 @@ jobs:
|
|||||||
- name: Install wasm-pack
|
- name: Install wasm-pack
|
||||||
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
||||||
|
|
||||||
- name: Install wasm-opt
|
|
||||||
run: cargo install wasm-opt
|
|
||||||
|
|
||||||
- name: Set up Go
|
|
||||||
uses: actions/setup-go@v4
|
|
||||||
with:
|
|
||||||
go-version: "1.20"
|
|
||||||
|
|
||||||
- name: Install TinyGo
|
|
||||||
uses: acifani/setup-tinygo@v1
|
|
||||||
with:
|
|
||||||
tinygo-version: "0.27.0"
|
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: yarn
|
run: yarn
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: release-calculate-hash
|
name: Releases - calculate file hashes
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_call:
|
workflow_call:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: ci-nym-api-tests
|
name: CI for Nym API Tests
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
@@ -16,13 +16,10 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: install yarn in root
|
|
||||||
run: cd ../.. && yarn install
|
|
||||||
|
|
||||||
- name: Install npm
|
- name: Install npm
|
||||||
run: npm install
|
run: npm install
|
||||||
|
|
||||||
- name: Node v18
|
- name: Node v18
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
+1
-4
@@ -9,7 +9,6 @@
|
|||||||
target
|
target
|
||||||
.env
|
.env
|
||||||
.env.dev
|
.env.dev
|
||||||
envs/devnet.env
|
|
||||||
/.vscode/settings.json
|
/.vscode/settings.json
|
||||||
validator/.vscode
|
validator/.vscode
|
||||||
sample-configs/validator-config.toml
|
sample-configs/validator-config.toml
|
||||||
@@ -46,6 +45,4 @@ envs/qwerty.env
|
|||||||
cpu-cycles/libcpucycles/build
|
cpu-cycles/libcpucycles/build
|
||||||
foxyfox.env
|
foxyfox.env
|
||||||
|
|
||||||
.next
|
.next
|
||||||
ppa-private-key.b64
|
|
||||||
ppa-private-key.asc
|
|
||||||
+3
-60
@@ -3,66 +3,9 @@
|
|||||||
Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
- add client registry to Gateway ([#3955])
|
||||||
## [2023.5-rolo] (2023-11-28)
|
- add HTTP API to Gateway ([#3955])
|
||||||
|
- add `/client/<pub-key>`, `clients` and `register` routes to the gateway ([#3955])
|
||||||
- Gateway won't open websocket listener until embedded Network Requester becomes available ([#4166])
|
|
||||||
- Feature/gateway described nr ([#4147])
|
|
||||||
- Bugfix/prerelease versionbump ([#4145])
|
|
||||||
- returning 'nil' for non-existing origin as opposed to an empty string ([#4135])
|
|
||||||
- using performance^20 when calculating active set selection weight ([#4126])
|
|
||||||
- Change default http API timeout from 3s to 10s ([#4117])
|
|
||||||
|
|
||||||
[#4166]: https://github.com/nymtech/nym/issues/4166
|
|
||||||
[#4147]: https://github.com/nymtech/nym/pull/4147
|
|
||||||
[#4145]: https://github.com/nymtech/nym/pull/4145
|
|
||||||
[#4135]: https://github.com/nymtech/nym/pull/4135
|
|
||||||
[#4126]: https://github.com/nymtech/nym/pull/4126
|
|
||||||
[#4117]: https://github.com/nymtech/nym/pull/4117
|
|
||||||
|
|
||||||
## [2023.nyxd-upgrade] (2023-11-22)
|
|
||||||
|
|
||||||
- Chore/nyxd 043 upgrade ([#3968])
|
|
||||||
|
|
||||||
[#3968]: https://github.com/nymtech/nym/pull/3968
|
|
||||||
|
|
||||||
## [2023.4-galaxy] (2023-11-07)
|
|
||||||
|
|
||||||
- DRY up client cli ([#4077])
|
|
||||||
- [mixnode] replace rocket with axum ([#4071])
|
|
||||||
- incorporate the nym node HTTP api into the mixnode ([#4070])
|
|
||||||
- replaced '--disable-sign-ext' with '--signext-lowering' when running wasm-opt ([#3896])
|
|
||||||
- Added PPA repo hosting support and nym-mixnode package with tooling for publishing ([#4165])
|
|
||||||
|
|
||||||
[#4077]: https://github.com/nymtech/nym/pull/4077
|
|
||||||
[#4071]: https://github.com/nymtech/nym/pull/4071
|
|
||||||
[#4070]: https://github.com/nymtech/nym/issues/4070
|
|
||||||
[#3896]: https://github.com/nymtech/nym/pull/3896
|
|
||||||
[#4165]: https://github.com/nymtech/nym/pull/4165
|
|
||||||
|
|
||||||
## [2023.3-kinder] (2023-10-31)
|
|
||||||
|
|
||||||
- suppress error output ([#4056])
|
|
||||||
- Update frontend type for current vesting period ([#4042])
|
|
||||||
- re-exported additional types for tx queries ([#4036])
|
|
||||||
- fixed fmt::Display impl for GatewayNetworkRequesterDetails ([#4033])
|
|
||||||
- Add exit node policy from TorNull and Tor Exit Node Policy ([#4024])
|
|
||||||
- basic self-described api for gateways to dynamically announce its details + nym-api aggregation ([#4017])
|
|
||||||
- use saturating sub in case outfox is not enabled ([#3986])
|
|
||||||
- Fix sorting for mixnodes and gateways ([#3985])
|
|
||||||
- Gateway client registry and api routes ([#3955])
|
|
||||||
- Feature/configurable socks5 bind address ([#3992])
|
|
||||||
|
|
||||||
[#4056]: https://github.com/nymtech/nym/pull/4056
|
|
||||||
[#4042]: https://github.com/nymtech/nym/pull/4042
|
|
||||||
[#4036]: https://github.com/nymtech/nym/pull/4036
|
|
||||||
[#4033]: https://github.com/nymtech/nym/pull/4033
|
|
||||||
[#4024]: https://github.com/nymtech/nym/issues/4024
|
|
||||||
[#4017]: https://github.com/nymtech/nym/issues/4017
|
|
||||||
[#3986]: https://github.com/nymtech/nym/pull/3986
|
|
||||||
[#3985]: https://github.com/nymtech/nym/pull/3985
|
|
||||||
[#3955]: https://github.com/nymtech/nym/pull/3955
|
|
||||||
[#3992]: https://github.com/nymtech/nym/pull/3992
|
|
||||||
|
|
||||||
## [2023.1-milka] (2023-09-24)
|
## [2023.1-milka] (2023-09-24)
|
||||||
|
|
||||||
|
|||||||
Generated
+1184
-1462
File diff suppressed because it is too large
Load Diff
+19
-51
@@ -46,10 +46,8 @@ members = [
|
|||||||
"common/crypto",
|
"common/crypto",
|
||||||
"common/dkg",
|
"common/dkg",
|
||||||
"common/execute",
|
"common/execute",
|
||||||
"common/exit-policy",
|
|
||||||
"common/http-api-client",
|
"common/http-api-client",
|
||||||
"common/inclusion-probability",
|
"common/inclusion-probability",
|
||||||
"common/ip-packet-requests",
|
|
||||||
"common/ledger",
|
"common/ledger",
|
||||||
"common/mixnode-common",
|
"common/mixnode-common",
|
||||||
"common/network-defaults",
|
"common/network-defaults",
|
||||||
@@ -67,7 +65,6 @@ members = [
|
|||||||
"common/nymsphinx/params",
|
"common/nymsphinx/params",
|
||||||
"common/nymsphinx/routing",
|
"common/nymsphinx/routing",
|
||||||
"common/nymsphinx/types",
|
"common/nymsphinx/types",
|
||||||
"common/nyxd-scraper",
|
|
||||||
"common/pemstore",
|
"common/pemstore",
|
||||||
"common/socks5-client-core",
|
"common/socks5-client-core",
|
||||||
"common/socks5/proxy-helpers",
|
"common/socks5/proxy-helpers",
|
||||||
@@ -76,13 +73,11 @@ members = [
|
|||||||
"common/store-cipher",
|
"common/store-cipher",
|
||||||
"common/task",
|
"common/task",
|
||||||
"common/topology",
|
"common/topology",
|
||||||
"common/tun",
|
|
||||||
"common/types",
|
"common/types",
|
||||||
"common/wasm/client-core",
|
"common/wasm/client-core",
|
||||||
"common/wasm/storage",
|
"common/wasm/storage",
|
||||||
"common/wasm/utils",
|
"common/wasm/utils",
|
||||||
"common/wireguard",
|
"common/wireguard",
|
||||||
"common/wireguard-types",
|
|
||||||
"explorer-api",
|
"explorer-api",
|
||||||
"explorer-api/explorer-api-requests",
|
"explorer-api/explorer-api-requests",
|
||||||
"explorer-api/explorer-client",
|
"explorer-api/explorer-client",
|
||||||
@@ -93,7 +88,6 @@ members = [
|
|||||||
"sdk/lib/socks5-listener",
|
"sdk/lib/socks5-listener",
|
||||||
"sdk/rust/nym-sdk",
|
"sdk/rust/nym-sdk",
|
||||||
"service-providers/common",
|
"service-providers/common",
|
||||||
"service-providers/ip-packet-router",
|
|
||||||
"service-providers/network-requester",
|
"service-providers/network-requester",
|
||||||
"service-providers/network-statistics",
|
"service-providers/network-statistics",
|
||||||
"nym-api",
|
"nym-api",
|
||||||
@@ -102,15 +96,13 @@ members = [
|
|||||||
"nym-node",
|
"nym-node",
|
||||||
"nym-node/nym-node-requests",
|
"nym-node/nym-node-requests",
|
||||||
"nym-outfox",
|
"nym-outfox",
|
||||||
"nym-validator-rewarder",
|
|
||||||
"tools/internal/ssl-inject",
|
"tools/internal/ssl-inject",
|
||||||
"tools/internal/sdk-version-bump",
|
"tools/internal/sdk-version-bump",
|
||||||
"tools/nym-cli",
|
"tools/nym-cli",
|
||||||
"tools/nym-nr-query",
|
"tools/nym-nr-query",
|
||||||
"tools/nymvisor",
|
|
||||||
"tools/ts-rs-cli",
|
"tools/ts-rs-cli",
|
||||||
"wasm/client",
|
"wasm/client",
|
||||||
# "wasm/full-nym-wasm",
|
"wasm/full-nym-wasm",
|
||||||
"wasm/mix-fetch",
|
"wasm/mix-fetch",
|
||||||
"wasm/node-tester",
|
"wasm/node-tester",
|
||||||
]
|
]
|
||||||
@@ -123,12 +115,10 @@ default-members = [
|
|||||||
"service-providers/network-statistics",
|
"service-providers/network-statistics",
|
||||||
"mixnode",
|
"mixnode",
|
||||||
"nym-api",
|
"nym-api",
|
||||||
"tools/nymvisor",
|
|
||||||
"explorer-api",
|
"explorer-api",
|
||||||
"nym-validator-rewarder",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
exclude = ["explorer", "contracts", "nym-wallet", "nym-connect/mobile/src-tauri", "nym-connect/desktop", "nym-vpn/ui/src-tauri", "cpu-cycles", "sdk/ffi/cpp"]
|
exclude = ["explorer", "contracts", "nym-wallet", "nym-connect/mobile/src-tauri", "nym-connect/desktop", "cpu-cycles"]
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
authors = ["Nym Technologies SA"]
|
authors = ["Nym Technologies SA"]
|
||||||
@@ -144,8 +134,22 @@ async-trait = "0.1.68"
|
|||||||
axum = "0.6.20"
|
axum = "0.6.20"
|
||||||
base64 = "0.21.4"
|
base64 = "0.21.4"
|
||||||
bip39 = { version = "2.0.0", features = ["zeroize"] }
|
bip39 = { version = "2.0.0", features = ["zeroize"] }
|
||||||
clap = "4.4.7"
|
|
||||||
cfg-if = "1.0.0"
|
cfg-if = "1.0.0"
|
||||||
|
cosmwasm-derive = "=1.3.0"
|
||||||
|
cosmwasm-schema = "=1.3.0"
|
||||||
|
cosmwasm-std = "=1.3.0"
|
||||||
|
# use 0.5.0 as that's the version used by cosmwasm-std 1.3.0
|
||||||
|
# (and ideally we don't want to pull the same dependency twice)
|
||||||
|
serde-json-wasm = "=0.5.0"
|
||||||
|
cosmwasm-storage = "=1.3.0"
|
||||||
|
cosmrs = "=0.14.0"
|
||||||
|
# same version as used by cosmrs
|
||||||
|
cw-utils = "=1.0.1"
|
||||||
|
cw-storage-plus = "=1.1.0"
|
||||||
|
cw2 = { version = "=1.1.0" }
|
||||||
|
cw3 = { version = "=1.1.0" }
|
||||||
|
cw4 = { version = "=1.1.0" }
|
||||||
|
cw-controllers = { version = "=1.1.0" }
|
||||||
dashmap = "5.5.3"
|
dashmap = "5.5.3"
|
||||||
dotenvy = "0.15.6"
|
dotenvy = "0.15.6"
|
||||||
futures = "0.3.28"
|
futures = "0.3.28"
|
||||||
@@ -162,12 +166,10 @@ reqwest = "0.11.22"
|
|||||||
schemars = "0.8.1"
|
schemars = "0.8.1"
|
||||||
serde = "1.0.152"
|
serde = "1.0.152"
|
||||||
serde_json = "1.0.91"
|
serde_json = "1.0.91"
|
||||||
sqlx = "0.6.3"
|
|
||||||
tap = "1.0.1"
|
tap = "1.0.1"
|
||||||
time = "0.3.30"
|
tendermint-rpc = "0.32" # same version as used by cosmrs
|
||||||
thiserror = "1.0.48"
|
thiserror = "1.0.48"
|
||||||
tokio = "1.33.0"
|
tokio = "1.24.1"
|
||||||
tokio-util = "0.7.10"
|
|
||||||
tokio-tungstenite = "0.20.1"
|
tokio-tungstenite = "0.20.1"
|
||||||
tracing = "0.1.37"
|
tracing = "0.1.37"
|
||||||
tungstenite = { version = "0.20.1", default-features = false }
|
tungstenite = { version = "0.20.1", default-features = false }
|
||||||
@@ -177,40 +179,6 @@ utoipa-swagger-ui = "3.1.5"
|
|||||||
url = "2.4"
|
url = "2.4"
|
||||||
zeroize = "1.6.0"
|
zeroize = "1.6.0"
|
||||||
|
|
||||||
# coconut/DKG related
|
|
||||||
# unfortunately until https://github.com/zkcrypto/bls12_381/issues/10 is resolved, we have to rely on the fork
|
|
||||||
# as we need to be able to serialize Gt so that we could create the lookup table for baby-step-giant-step algorithm
|
|
||||||
bls12_381 = { git = "https://github.com/jstuczyn/bls12_381", branch ="feature/gt-serialization-0.8.0" }
|
|
||||||
group = "0.13.0"
|
|
||||||
ff = "0.13.0"
|
|
||||||
|
|
||||||
|
|
||||||
# cosmwasm-related
|
|
||||||
cosmwasm-derive = "=1.3.0"
|
|
||||||
cosmwasm-schema = "=1.3.0"
|
|
||||||
cosmwasm-std = "=1.3.0"
|
|
||||||
# use 0.5.0 as that's the version used by cosmwasm-std 1.3.0
|
|
||||||
# (and ideally we don't want to pull the same dependency twice)
|
|
||||||
serde-json-wasm = "=0.5.0"
|
|
||||||
cosmwasm-storage = "=1.3.0"
|
|
||||||
# same version as used by cosmwasm
|
|
||||||
cw-utils = "=1.0.1"
|
|
||||||
cw-storage-plus = "=1.1.0"
|
|
||||||
cw2 = { version = "=1.1.0" }
|
|
||||||
cw3 = { version = "=1.1.0" }
|
|
||||||
cw4 = { version = "=1.1.0" }
|
|
||||||
cw-controllers = { version = "=1.1.0" }
|
|
||||||
|
|
||||||
# cosmrs-related
|
|
||||||
bip32 = "0.5.1"
|
|
||||||
|
|
||||||
# temporarily using a fork again (yay.) because we need staking and slashing support
|
|
||||||
cosmrs = { git = "https://github.com/jstuczyn/cosmos-rust", branch ="nym-temp/all-validator-features" }
|
|
||||||
#cosmrs = { git = "https://github.com/jstuczyn/cosmos-rust", branch = "nym-temp/all-validator-features" } # unfortuntely we need a fork by yours truly to get the staking support
|
|
||||||
tendermint = "0.34" # same version as used by cosmrs
|
|
||||||
tendermint-rpc = "0.34" # same version as used by cosmrs
|
|
||||||
prost = "0.12"
|
|
||||||
|
|
||||||
# wasm-related dependencies
|
# wasm-related dependencies
|
||||||
gloo-utils = "0.1.7"
|
gloo-utils = "0.1.7"
|
||||||
js-sys = "0.3.63"
|
js-sys = "0.3.63"
|
||||||
|
|||||||
@@ -1,439 +0,0 @@
|
|||||||
Attribution-NonCommercial-ShareAlike 4.0 International
|
|
||||||
|
|
||||||
=======================================================================
|
|
||||||
|
|
||||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
|
||||||
does not provide legal services or legal advice. Distribution of
|
|
||||||
Creative Commons public licenses does not create a lawyer-client or
|
|
||||||
other relationship. Creative Commons makes its licenses and related
|
|
||||||
information available on an "as-is" basis. Creative Commons gives no
|
|
||||||
warranties regarding its licenses, any material licensed under their
|
|
||||||
terms and conditions, or any related information. Creative Commons
|
|
||||||
disclaims all liability for damages resulting from their use to the
|
|
||||||
fullest extent possible.
|
|
||||||
|
|
||||||
Using Creative Commons Public Licenses
|
|
||||||
|
|
||||||
Creative Commons public licenses provide a standard set of terms and
|
|
||||||
conditions that creators and other rights holders may use to share
|
|
||||||
original works of authorship and other material subject to copyright
|
|
||||||
and certain other rights specified in the public license below. The
|
|
||||||
following considerations are for informational purposes only, are not
|
|
||||||
exhaustive, and do not form part of our licenses.
|
|
||||||
|
|
||||||
Considerations for licensors: Our public licenses are
|
|
||||||
intended for use by those authorized to give the public
|
|
||||||
permission to use material in ways otherwise restricted by
|
|
||||||
copyright and certain other rights. Our licenses are
|
|
||||||
irrevocable. Licensors should read and understand the terms
|
|
||||||
and conditions of the license they choose before applying it.
|
|
||||||
Licensors should also secure all rights necessary before
|
|
||||||
applying our licenses so that the public can reuse the
|
|
||||||
material as expected. Licensors should clearly mark any
|
|
||||||
material not subject to the license. This includes other CC-
|
|
||||||
licensed material, or material used under an exception or
|
|
||||||
limitation to copyright. More considerations for licensors:
|
|
||||||
wiki.creativecommons.org/Considerations_for_licensors
|
|
||||||
|
|
||||||
Considerations for the public: By using one of our public
|
|
||||||
licenses, a licensor grants the public permission to use the
|
|
||||||
licensed material under specified terms and conditions. If
|
|
||||||
the licensor's permission is not necessary for any reason--for
|
|
||||||
example, because of any applicable exception or limitation to
|
|
||||||
copyright--then that use is not regulated by the license. Our
|
|
||||||
licenses grant only permissions under copyright and certain
|
|
||||||
other rights that a licensor has authority to grant. Use of
|
|
||||||
the licensed material may still be restricted for other
|
|
||||||
reasons, including because others have copyright or other
|
|
||||||
rights in the material. A licensor may make special requests,
|
|
||||||
such as asking that all changes be marked or described.
|
|
||||||
Although not required by our licenses, you are encouraged to
|
|
||||||
respect those requests where reasonable. More considerations
|
|
||||||
for the public:
|
|
||||||
wiki.creativecommons.org/Considerations_for_licensees
|
|
||||||
|
|
||||||
=======================================================================
|
|
||||||
|
|
||||||
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
|
|
||||||
Public License
|
|
||||||
|
|
||||||
By exercising the Licensed Rights (defined below), You accept and agree
|
|
||||||
to be bound by the terms and conditions of this Creative Commons
|
|
||||||
Attribution-NonCommercial-ShareAlike 4.0 International Public License
|
|
||||||
("Public License"). To the extent this Public License may be
|
|
||||||
interpreted as a contract, You are granted the Licensed Rights in
|
|
||||||
consideration of Your acceptance of these terms and conditions, and the
|
|
||||||
Licensor grants You such rights in consideration of benefits the
|
|
||||||
Licensor receives from making the Licensed Material available under
|
|
||||||
these terms and conditions.
|
|
||||||
|
|
||||||
|
|
||||||
Section 1 -- Definitions.
|
|
||||||
|
|
||||||
a. Adapted Material means material subject to Copyright and Similar
|
|
||||||
Rights that is derived from or based upon the Licensed Material
|
|
||||||
and in which the Licensed Material is translated, altered,
|
|
||||||
arranged, transformed, or otherwise modified in a manner requiring
|
|
||||||
permission under the Copyright and Similar Rights held by the
|
|
||||||
Licensor. For purposes of this Public License, where the Licensed
|
|
||||||
Material is a musical work, performance, or sound recording,
|
|
||||||
Adapted Material is always produced where the Licensed Material is
|
|
||||||
synched in timed relation with a moving image.
|
|
||||||
|
|
||||||
b. Adapter's License means the license You apply to Your Copyright
|
|
||||||
and Similar Rights in Your contributions to Adapted Material in
|
|
||||||
accordance with the terms and conditions of this Public License.
|
|
||||||
|
|
||||||
c. BY-NC-SA Compatible License means a license listed at
|
|
||||||
creativecommons.org/compatiblelicenses, approved by Creative
|
|
||||||
Commons as essentially the equivalent of this Public License.
|
|
||||||
|
|
||||||
d. Copyright and Similar Rights means copyright and/or similar rights
|
|
||||||
closely related to copyright including, without limitation,
|
|
||||||
performance, broadcast, sound recording, and Sui Generis Database
|
|
||||||
Rights, without regard to how the rights are labeled or
|
|
||||||
categorized. For purposes of this Public License, the rights
|
|
||||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
|
||||||
Rights.
|
|
||||||
|
|
||||||
e. Effective Technological Measures means those measures that, in the
|
|
||||||
absence of proper authority, may not be circumvented under laws
|
|
||||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
|
||||||
Treaty adopted on December 20, 1996, and/or similar international
|
|
||||||
agreements.
|
|
||||||
|
|
||||||
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
|
||||||
any other exception or limitation to Copyright and Similar Rights
|
|
||||||
that applies to Your use of the Licensed Material.
|
|
||||||
|
|
||||||
g. License Elements means the license attributes listed in the name
|
|
||||||
of a Creative Commons Public License. The License Elements of this
|
|
||||||
Public License are Attribution, NonCommercial, and ShareAlike.
|
|
||||||
|
|
||||||
h. Licensed Material means the artistic or literary work, database,
|
|
||||||
or other material to which the Licensor applied this Public
|
|
||||||
License.
|
|
||||||
|
|
||||||
i. Licensed Rights means the rights granted to You subject to the
|
|
||||||
terms and conditions of this Public License, which are limited to
|
|
||||||
all Copyright and Similar Rights that apply to Your use of the
|
|
||||||
Licensed Material and that the Licensor has authority to license.
|
|
||||||
|
|
||||||
j. Licensor means the individual(s) or entity(ies) granting rights
|
|
||||||
under this Public License.
|
|
||||||
|
|
||||||
k. NonCommercial means not primarily intended for or directed towards
|
|
||||||
commercial advantage or monetary compensation. For purposes of
|
|
||||||
this Public License, the exchange of the Licensed Material for
|
|
||||||
other material subject to Copyright and Similar Rights by digital
|
|
||||||
file-sharing or similar means is NonCommercial provided there is
|
|
||||||
no payment of monetary compensation in connection with the
|
|
||||||
exchange.
|
|
||||||
|
|
||||||
l. Share means to provide material to the public by any means or
|
|
||||||
process that requires permission under the Licensed Rights, such
|
|
||||||
as reproduction, public display, public performance, distribution,
|
|
||||||
dissemination, communication, or importation, and to make material
|
|
||||||
available to the public including in ways that members of the
|
|
||||||
public may access the material from a place and at a time
|
|
||||||
individually chosen by them.
|
|
||||||
|
|
||||||
m. Sui Generis Database Rights means rights other than copyright
|
|
||||||
resulting from Directive 96/9/EC of the European Parliament and of
|
|
||||||
the Council of 11 March 1996 on the legal protection of databases,
|
|
||||||
as amended and/or succeeded, as well as other essentially
|
|
||||||
equivalent rights anywhere in the world.
|
|
||||||
|
|
||||||
n. You means the individual or entity exercising the Licensed Rights
|
|
||||||
under this Public License. Your has a corresponding meaning.
|
|
||||||
|
|
||||||
|
|
||||||
Section 2 -- Scope.
|
|
||||||
|
|
||||||
a. License grant.
|
|
||||||
|
|
||||||
1. Subject to the terms and conditions of this Public License,
|
|
||||||
the Licensor hereby grants You a worldwide, royalty-free,
|
|
||||||
non-sublicensable, non-exclusive, irrevocable license to
|
|
||||||
exercise the Licensed Rights in the Licensed Material to:
|
|
||||||
|
|
||||||
a. reproduce and Share the Licensed Material, in whole or
|
|
||||||
in part, for NonCommercial purposes only; and
|
|
||||||
|
|
||||||
b. produce, reproduce, and Share Adapted Material for
|
|
||||||
NonCommercial purposes only.
|
|
||||||
|
|
||||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
|
||||||
Exceptions and Limitations apply to Your use, this Public
|
|
||||||
License does not apply, and You do not need to comply with
|
|
||||||
its terms and conditions.
|
|
||||||
|
|
||||||
3. Term. The term of this Public License is specified in Section
|
|
||||||
6(a).
|
|
||||||
|
|
||||||
4. Media and formats; technical modifications allowed. The
|
|
||||||
Licensor authorizes You to exercise the Licensed Rights in
|
|
||||||
all media and formats whether now known or hereafter created,
|
|
||||||
and to make technical modifications necessary to do so. The
|
|
||||||
Licensor waives and/or agrees not to assert any right or
|
|
||||||
authority to forbid You from making technical modifications
|
|
||||||
necessary to exercise the Licensed Rights, including
|
|
||||||
technical modifications necessary to circumvent Effective
|
|
||||||
Technological Measures. For purposes of this Public License,
|
|
||||||
simply making modifications authorized by this Section 2(a)
|
|
||||||
(4) never produces Adapted Material.
|
|
||||||
|
|
||||||
5. Downstream recipients.
|
|
||||||
|
|
||||||
a. Offer from the Licensor -- Licensed Material. Every
|
|
||||||
recipient of the Licensed Material automatically
|
|
||||||
receives an offer from the Licensor to exercise the
|
|
||||||
Licensed Rights under the terms and conditions of this
|
|
||||||
Public License.
|
|
||||||
|
|
||||||
b. Additional offer from the Licensor -- Adapted Material.
|
|
||||||
Every recipient of Adapted Material from You
|
|
||||||
automatically receives an offer from the Licensor to
|
|
||||||
exercise the Licensed Rights in the Adapted Material
|
|
||||||
under the conditions of the Adapter's License You apply.
|
|
||||||
|
|
||||||
c. No downstream restrictions. You may not offer or impose
|
|
||||||
any additional or different terms or conditions on, or
|
|
||||||
apply any Effective Technological Measures to, the
|
|
||||||
Licensed Material if doing so restricts exercise of the
|
|
||||||
Licensed Rights by any recipient of the Licensed
|
|
||||||
Material.
|
|
||||||
|
|
||||||
6. No endorsement. Nothing in this Public License constitutes or
|
|
||||||
may be construed as permission to assert or imply that You
|
|
||||||
are, or that Your use of the Licensed Material is, connected
|
|
||||||
with, or sponsored, endorsed, or granted official status by,
|
|
||||||
the Licensor or others designated to receive attribution as
|
|
||||||
provided in Section 3(a)(1)(A)(i).
|
|
||||||
|
|
||||||
b. Other rights.
|
|
||||||
|
|
||||||
1. Moral rights, such as the right of integrity, are not
|
|
||||||
licensed under this Public License, nor are publicity,
|
|
||||||
privacy, and/or other similar personality rights; however, to
|
|
||||||
the extent possible, the Licensor waives and/or agrees not to
|
|
||||||
assert any such rights held by the Licensor to the limited
|
|
||||||
extent necessary to allow You to exercise the Licensed
|
|
||||||
Rights, but not otherwise.
|
|
||||||
|
|
||||||
2. Patent and trademark rights are not licensed under this
|
|
||||||
Public License.
|
|
||||||
|
|
||||||
3. To the extent possible, the Licensor waives any right to
|
|
||||||
collect royalties from You for the exercise of the Licensed
|
|
||||||
Rights, whether directly or through a collecting society
|
|
||||||
under any voluntary or waivable statutory or compulsory
|
|
||||||
licensing scheme. In all other cases the Licensor expressly
|
|
||||||
reserves any right to collect such royalties, including when
|
|
||||||
the Licensed Material is used other than for NonCommercial
|
|
||||||
purposes.
|
|
||||||
|
|
||||||
|
|
||||||
Section 3 -- License Conditions.
|
|
||||||
|
|
||||||
Your exercise of the Licensed Rights is expressly made subject to the
|
|
||||||
following conditions.
|
|
||||||
|
|
||||||
a. Attribution.
|
|
||||||
|
|
||||||
1. If You Share the Licensed Material (including in modified
|
|
||||||
form), You must:
|
|
||||||
|
|
||||||
a. retain the following if it is supplied by the Licensor
|
|
||||||
with the Licensed Material:
|
|
||||||
|
|
||||||
i. identification of the creator(s) of the Licensed
|
|
||||||
Material and any others designated to receive
|
|
||||||
attribution, in any reasonable manner requested by
|
|
||||||
the Licensor (including by pseudonym if
|
|
||||||
designated);
|
|
||||||
|
|
||||||
ii. a copyright notice;
|
|
||||||
|
|
||||||
iii. a notice that refers to this Public License;
|
|
||||||
|
|
||||||
iv. a notice that refers to the disclaimer of
|
|
||||||
warranties;
|
|
||||||
|
|
||||||
v. a URI or hyperlink to the Licensed Material to the
|
|
||||||
extent reasonably practicable;
|
|
||||||
|
|
||||||
b. indicate if You modified the Licensed Material and
|
|
||||||
retain an indication of any previous modifications; and
|
|
||||||
|
|
||||||
c. indicate the Licensed Material is licensed under this
|
|
||||||
Public License, and include the text of, or the URI or
|
|
||||||
hyperlink to, this Public License.
|
|
||||||
|
|
||||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
|
||||||
reasonable manner based on the medium, means, and context in
|
|
||||||
which You Share the Licensed Material. For example, it may be
|
|
||||||
reasonable to satisfy the conditions by providing a URI or
|
|
||||||
hyperlink to a resource that includes the required
|
|
||||||
information.
|
|
||||||
3. If requested by the Licensor, You must remove any of the
|
|
||||||
information required by Section 3(a)(1)(A) to the extent
|
|
||||||
reasonably practicable.
|
|
||||||
|
|
||||||
b. ShareAlike.
|
|
||||||
|
|
||||||
In addition to the conditions in Section 3(a), if You Share
|
|
||||||
Adapted Material You produce, the following conditions also apply.
|
|
||||||
|
|
||||||
1. The Adapter's License You apply must be a Creative Commons
|
|
||||||
license with the same License Elements, this version or
|
|
||||||
later, or a BY-NC-SA Compatible License.
|
|
||||||
|
|
||||||
2. You must include the text of, or the URI or hyperlink to, the
|
|
||||||
Adapter's License You apply. You may satisfy this condition
|
|
||||||
in any reasonable manner based on the medium, means, and
|
|
||||||
context in which You Share Adapted Material.
|
|
||||||
|
|
||||||
3. You may not offer or impose any additional or different terms
|
|
||||||
or conditions on, or apply any Effective Technological
|
|
||||||
Measures to, Adapted Material that restrict exercise of the
|
|
||||||
rights granted under the Adapter's License You apply.
|
|
||||||
|
|
||||||
|
|
||||||
Section 4 -- Sui Generis Database Rights.
|
|
||||||
|
|
||||||
Where the Licensed Rights include Sui Generis Database Rights that
|
|
||||||
apply to Your use of the Licensed Material:
|
|
||||||
|
|
||||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
|
||||||
to extract, reuse, reproduce, and Share all or a substantial
|
|
||||||
portion of the contents of the database for NonCommercial purposes
|
|
||||||
only;
|
|
||||||
|
|
||||||
b. if You include all or a substantial portion of the database
|
|
||||||
contents in a database in which You have Sui Generis Database
|
|
||||||
Rights, then the database in which You have Sui Generis Database
|
|
||||||
Rights (but not its individual contents) is Adapted Material,
|
|
||||||
including for purposes of Section 3(b); and
|
|
||||||
|
|
||||||
c. You must comply with the conditions in Section 3(a) if You Share
|
|
||||||
all or a substantial portion of the contents of the database.
|
|
||||||
|
|
||||||
For the avoidance of doubt, this Section 4 supplements and does not
|
|
||||||
replace Your obligations under this Public License where the Licensed
|
|
||||||
Rights include other Copyright and Similar Rights.
|
|
||||||
|
|
||||||
|
|
||||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
|
||||||
|
|
||||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
|
||||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
|
||||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
|
||||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
|
||||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
|
||||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
|
||||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
|
||||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
|
||||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
|
||||||
|
|
||||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
|
||||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
|
||||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
|
||||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
|
||||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
|
||||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
|
||||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
|
||||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
|
||||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
|
||||||
|
|
||||||
c. The disclaimer of warranties and limitation of liability provided
|
|
||||||
above shall be interpreted in a manner that, to the extent
|
|
||||||
possible, most closely approximates an absolute disclaimer and
|
|
||||||
waiver of all liability.
|
|
||||||
|
|
||||||
|
|
||||||
Section 6 -- Term and Termination.
|
|
||||||
|
|
||||||
a. This Public License applies for the term of the Copyright and
|
|
||||||
Similar Rights licensed here. However, if You fail to comply with
|
|
||||||
this Public License, then Your rights under this Public License
|
|
||||||
terminate automatically.
|
|
||||||
|
|
||||||
b. Where Your right to use the Licensed Material has terminated under
|
|
||||||
Section 6(a), it reinstates:
|
|
||||||
|
|
||||||
1. automatically as of the date the violation is cured, provided
|
|
||||||
it is cured within 30 days of Your discovery of the
|
|
||||||
violation; or
|
|
||||||
|
|
||||||
2. upon express reinstatement by the Licensor.
|
|
||||||
|
|
||||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
|
||||||
right the Licensor may have to seek remedies for Your violations
|
|
||||||
of this Public License.
|
|
||||||
|
|
||||||
c. For the avoidance of doubt, the Licensor may also offer the
|
|
||||||
Licensed Material under separate terms or conditions or stop
|
|
||||||
distributing the Licensed Material at any time; however, doing so
|
|
||||||
will not terminate this Public License.
|
|
||||||
|
|
||||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
|
||||||
License.
|
|
||||||
|
|
||||||
|
|
||||||
Section 7 -- Other Terms and Conditions.
|
|
||||||
|
|
||||||
a. The Licensor shall not be bound by any additional or different
|
|
||||||
terms or conditions communicated by You unless expressly agreed.
|
|
||||||
|
|
||||||
b. Any arrangements, understandings, or agreements regarding the
|
|
||||||
Licensed Material not stated herein are separate from and
|
|
||||||
independent of the terms and conditions of this Public License.
|
|
||||||
|
|
||||||
|
|
||||||
Section 8 -- Interpretation.
|
|
||||||
|
|
||||||
a. For the avoidance of doubt, this Public License does not, and
|
|
||||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
|
||||||
conditions on any use of the Licensed Material that could lawfully
|
|
||||||
be made without permission under this Public License.
|
|
||||||
|
|
||||||
b. To the extent possible, if any provision of this Public License is
|
|
||||||
deemed unenforceable, it shall be automatically reformed to the
|
|
||||||
minimum extent necessary to make it enforceable. If the provision
|
|
||||||
cannot be reformed, it shall be severed from this Public License
|
|
||||||
without affecting the enforceability of the remaining terms and
|
|
||||||
conditions.
|
|
||||||
|
|
||||||
c. No term or condition of this Public License will be waived and no
|
|
||||||
failure to comply consented to unless expressly agreed to by the
|
|
||||||
Licensor.
|
|
||||||
|
|
||||||
d. Nothing in this Public License constitutes or may be interpreted
|
|
||||||
as a limitation upon, or waiver of, any privileges and immunities
|
|
||||||
that apply to the Licensor or You, including from the legal
|
|
||||||
processes of any jurisdiction or authority.
|
|
||||||
|
|
||||||
=======================================================================
|
|
||||||
|
|
||||||
Creative Commons is not a party to its public
|
|
||||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
|
||||||
its public licenses to material it publishes and in those instances
|
|
||||||
will be considered the “Licensor.†The text of the Creative Commons
|
|
||||||
public licenses is dedicated to the public domain under the CC0 Public
|
|
||||||
Domain Dedication. Except for the limited purpose of indicating that
|
|
||||||
material is shared under a Creative Commons public license or as
|
|
||||||
otherwise permitted by the Creative Commons policies published at
|
|
||||||
creativecommons.org/policies, Creative Commons does not authorize the
|
|
||||||
use of the trademark "Creative Commons" or any other trademark or logo
|
|
||||||
of Creative Commons without its prior written consent including,
|
|
||||||
without limitation, in connection with any unauthorized modifications
|
|
||||||
to any of its public licenses or any other arrangements,
|
|
||||||
understandings, or agreements concerning use of licensed material. For
|
|
||||||
the avoidance of doubt, this paragraph does not form part of the
|
|
||||||
public licenses.
|
|
||||||
|
|
||||||
Creative Commons may be contacted at creativecommons.org.
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,675 +0,0 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
|
||||||
or can get the source code. And you must show them these terms so they
|
|
||||||
know their rights.
|
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
|
||||||
that there is no warranty for this free software. For both users' and
|
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
|
||||||
changed, so that their problems will not be attributed erroneously to
|
|
||||||
authors of previous versions.
|
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means tocopy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the special requirements of the GNU Affero General Public License,
|
|
||||||
section 13, concerning interaction through a network will apply to the
|
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
|
|
||||||
@@ -12,7 +12,6 @@ help:
|
|||||||
@echo " clippy: run clippy for all workspaces"
|
@echo " clippy: run clippy for all workspaces"
|
||||||
@echo " test: run clippy, unit tests, and formatting."
|
@echo " test: run clippy, unit tests, and formatting."
|
||||||
@echo " test-all: like test, but also includes the expensive tests"
|
@echo " test-all: like test, but also includes the expensive tests"
|
||||||
@echo " deb: build debian packages
|
|
||||||
|
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
# Meta targets
|
# Meta targets
|
||||||
@@ -94,6 +93,10 @@ $(eval $(call add_cargo_workspace,contracts,contracts,--lib --target wasm32-unkn
|
|||||||
$(eval $(call add_cargo_workspace,wallet,nym-wallet))
|
$(eval $(call add_cargo_workspace,wallet,nym-wallet))
|
||||||
$(eval $(call add_cargo_workspace,connect,nym-connect/desktop))
|
$(eval $(call add_cargo_workspace,connect,nym-connect/desktop))
|
||||||
|
|
||||||
|
# OVERRIDE: wasm-opt fails if the binary has been built with the latest rustc.
|
||||||
|
# Pin to the last working version.
|
||||||
|
contracts_BUILD_RELEASE_TOOLCHAIN := +1.69.0
|
||||||
|
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
# SDK
|
# SDK
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
@@ -105,7 +108,7 @@ sdk-wasm-build:
|
|||||||
$(MAKE) -C wasm/client
|
$(MAKE) -C wasm/client
|
||||||
$(MAKE) -C wasm/node-tester
|
$(MAKE) -C wasm/node-tester
|
||||||
$(MAKE) -C wasm/mix-fetch
|
$(MAKE) -C wasm/mix-fetch
|
||||||
#$(MAKE) -C wasm/full-nym-wasm
|
$(MAKE) -C wasm/full-nym-wasm
|
||||||
|
|
||||||
# run this from npm/yarn to ensure tools are in the path, e.g. yarn build:sdk from root of repo
|
# run this from npm/yarn to ensure tools are in the path, e.g. yarn build:sdk from root of repo
|
||||||
sdk-typescript-build:
|
sdk-typescript-build:
|
||||||
@@ -115,7 +118,7 @@ sdk-typescript-build:
|
|||||||
yarn --cwd sdk/typescript/codegen/contract-clients build
|
yarn --cwd sdk/typescript/codegen/contract-clients build
|
||||||
|
|
||||||
# NOTE: These targets are part of the main workspace (but not as wasm32-unknown-unknown)
|
# NOTE: These targets are part of the main workspace (but not as wasm32-unknown-unknown)
|
||||||
WASM_CRATES = extension-storage nym-client-wasm nym-node-tester-wasm
|
WASM_CRATES = extension-storage nym-client-wasm nym-node-tester-wasm nym-wasm-sdk
|
||||||
|
|
||||||
sdk-wasm-test:
|
sdk-wasm-test:
|
||||||
#cargo test $(addprefix -p , $(WASM_CRATES)) --target wasm32-unknown-unknown -- -Dwarnings
|
#cargo test $(addprefix -p , $(WASM_CRATES)) --target wasm32-unknown-unknown -- -Dwarnings
|
||||||
@@ -141,7 +144,7 @@ contracts: build-release-contracts wasm-opt-contracts
|
|||||||
|
|
||||||
wasm-opt-contracts:
|
wasm-opt-contracts:
|
||||||
for contract in $(CONTRACTS_WASM); do \
|
for contract in $(CONTRACTS_WASM); do \
|
||||||
wasm-opt --signext-lowering -Os $(CONTRACTS_OUT_DIR)/$$contract -o $(CONTRACTS_OUT_DIR)/$$contract; \
|
wasm-opt --disable-sign-ext -Os $(CONTRACTS_OUT_DIR)/$$contract -o $(CONTRACTS_OUT_DIR)/$$contract; \
|
||||||
done
|
done
|
||||||
|
|
||||||
# Consider adding 's' to make plural consistent (beware: used in github workflow)
|
# Consider adding 's' to make plural consistent (beware: used in github workflow)
|
||||||
@@ -158,12 +161,6 @@ build-explorer-api:
|
|||||||
build-nym-cli:
|
build-nym-cli:
|
||||||
cargo build -p nym-cli --release
|
cargo build -p nym-cli --release
|
||||||
|
|
||||||
build-nym-gateway:
|
|
||||||
cargo build -p nym-gateway --release
|
|
||||||
|
|
||||||
build-nym-mixnode:
|
|
||||||
cargo build -p nym-mixnode --release
|
|
||||||
|
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
# Misc
|
# Misc
|
||||||
# -----------------------------------------------------------------------------
|
# -----------------------------------------------------------------------------
|
||||||
@@ -175,14 +172,3 @@ generate-typescript:
|
|||||||
run-api-tests:
|
run-api-tests:
|
||||||
cd nym-api/tests/functional_test && yarn test:qa
|
cd nym-api/tests/functional_test && yarn test:qa
|
||||||
|
|
||||||
# Build debian package, and update PPA
|
|
||||||
deb-mixnode: build-nym-mixnode
|
|
||||||
cargo deb -p nym-mixnode
|
|
||||||
|
|
||||||
deb-gateway: build-nym-gateway
|
|
||||||
cargo deb -p nym-gateway
|
|
||||||
|
|
||||||
deb-cli: build-nym-cli
|
|
||||||
cargo deb -p nym-cli
|
|
||||||
|
|
||||||
deb: deb-mixnode deb-gateway deb-cli
|
|
||||||
@@ -15,6 +15,7 @@ The platform is composed of multiple Rust crates. Top-level executable binary cr
|
|||||||
* nym-explorer - a (projected) block explorer and (existing) mixnet viewer.
|
* nym-explorer - a (projected) block explorer and (existing) mixnet viewer.
|
||||||
* 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://github.com/nymtech/nym/actions?query=branch%3Adevelop)
|
[](https://github.com/nymtech/nym/actions?query=branch%3Adevelop)
|
||||||
|
|
||||||
|
|
||||||
@@ -49,10 +50,10 @@ Node, node operator and delegator rewards are determined according to the princi
|
|||||||
|<img src="https://render.githubusercontent.com/render/math?math=\lambda_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\lambda_{i}#gh-dark-mode-only">|ratio of stake operator has pledged to their node to the token circulating supply.
|
|<img src="https://render.githubusercontent.com/render/math?math=\lambda_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\lambda_{i}#gh-dark-mode-only">|ratio of stake operator has pledged to their node to the token circulating supply.
|
||||||
|<img src="https://render.githubusercontent.com/render/math?math=\omega_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\omega_{i}#gh-dark-mode-only">|fraction of total effort undertaken by node `i`, set to `1/k`.
|
|<img src="https://render.githubusercontent.com/render/math?math=\omega_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\omega_{i}#gh-dark-mode-only">|fraction of total effort undertaken by node `i`, set to `1/k`.
|
||||||
|<img src="https://render.githubusercontent.com/render/math?math=k#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}k#gh-dark-mode-only">|number of nodes stakeholders are incentivised to create, set by the validators, a matter of governance. Currently determined by the `reward set` size, and set to 720 in testnet Sandbox.
|
|<img src="https://render.githubusercontent.com/render/math?math=k#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}k#gh-dark-mode-only">|number of nodes stakeholders are incentivised to create, set by the validators, a matter of governance. Currently determined by the `reward set` size, and set to 720 in testnet Sandbox.
|
||||||
|<img src="https://render.githubusercontent.com/render/math?math=\alpha#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\alpha#gh-dark-mode-only">|A Sybil attack resistance parameter - the higher this parameter is set, the stronger the reduction in competitiveness for a Sybil attacker.
|
|<img src="https://render.githubusercontent.com/render/math?math=\alpha#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}\alpha#gh-dark-mode-only">|Sybil attack resistance parameter - the higher this parameter is set the stronger the reduction in competitiveness gets for a Sybil attacker.
|
||||||
|<img src="https://render.githubusercontent.com/render/math?math=PM_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PM_{i}#gh-dark-mode-only">|declared profit margin of operator `i`, defaults to 10%.
|
|<img src="https://render.githubusercontent.com/render/math?math=PM_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PM_{i}#gh-dark-mode-only">|declared profit margin of operator `i`, defaults to 10% in.
|
||||||
|<img src="https://render.githubusercontent.com/render/math?math=PF_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PF_{i}#gh-dark-mode-only">|uptime of node `i`, scaled to 0 - 1, for the rewarding epoch
|
|<img src="https://render.githubusercontent.com/render/math?math=PF_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PF_{i}#gh-dark-mode-only">|uptime of node `i`, scaled to 0 - 1, for the rewarding epoch
|
||||||
|<img src="https://render.githubusercontent.com/render/math?math=PP_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PP_{i}#gh-dark-mode-only">|cost of operating node `i` for the duration of the rewarding epoch, set to 40 NYMs.
|
|<img src="https://render.githubusercontent.com/render/math?math=PP_{i}#gh-light-mode-only"><img src="https://render.githubusercontent.com/render/math?math=\color{white}PP_{i}#gh-dark-mode-only">|cost of operating node `i` for the duration of the rewarding epoch, set to 40 NYMT.
|
||||||
|
|
||||||
Node reward for node `i` is determined as:
|
Node reward for node `i` is determined as:
|
||||||
|
|
||||||
@@ -82,11 +83,4 @@ where `s'` is stake `s` scaled over total token circulating supply.
|
|||||||
|
|
||||||
### Licensing and copyright information
|
### Licensing and copyright information
|
||||||
|
|
||||||
This is a monorepo and components that make up Nym as a system are licensed individually, so for accurate information, please check individual files.
|
This program is available as open source under the terms of the Apache 2.0 license. However, some elements are being licensed under CC0-1.0 and MIT. For accurate information, please check individual files.
|
||||||
|
|
||||||
As a general approach, licensing is as follows this pattern:
|
|
||||||
- applications and binaries are GPLv3
|
|
||||||
- libraries and components are Apache 2.0 or MIT
|
|
||||||
- documentation is Apache 2.0 or CC0-1.0
|
|
||||||
|
|
||||||
Again, for accurate information, please check individual files.
|
|
||||||
|
|||||||
+5
-85
@@ -1,90 +1,10 @@
|
|||||||
Critical bug or security issue 💥
|
Critical bug or security issue 💥
|
||||||
|
|
||||||
If you're here because you're trying to figure out how to notify us of a security issue, send us a PGP encrypted email to:
|
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
|
||||||
security@nymte.ch
|
Jedrzej Stuczynski "Jedrzej | Nym#5666"
|
||||||
```
|
Fran Arbanas | franarbanas#0995
|
||||||
|
Mark Sinclair | marknym#8088
|
||||||
Encrypted with our public key which is available below in plain text and also on keyservers:
|
|
||||||
|
|
||||||
```
|
|
||||||
pub rsa4096 2023-10-30 [SC] [expire : 2026-10-29]
|
|
||||||
24B2592E801A5AAA8666C8BA7C3C727F05090550
|
|
||||||
uid [ ultime ] Security Nym Technologies <security@nymte.ch>
|
|
||||||
sub rsa4096 2023-10-30 [E] [expire : 2026-10-29]
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
The fingerprint of the key is on the second line above.
|
|
||||||
|
|
||||||
If you need to chat __urgently__ to our team for a __critical__ security issue:
|
|
||||||
|
|
||||||
go to Matrix, and alert the core engineers with a private direct message:
|
|
||||||
|
|
||||||
Jedrzej Stuczynski @jstuczyn:nymtech.chat
|
|
||||||
Mark Sinclair @mark:nymtech.chat
|
|
||||||
Raphaël Walther @raphael:nymtech.chat
|
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
If you don't know what Matrix is, you can follow this documentation to create an account on this federation of instant messaging servers:
|
|
||||||
|
|
||||||
[Matrix for Instant Messaging](https://matrix.org/docs/chat_basics/matrix-for-im/)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```
|
|
||||||
-----BEGIN PGP PUBLIC KEY BLOCK-----
|
|
||||||
|
|
||||||
mQINBGU/XpcBEAC+ykz0yxn8FferjEBooptXlOH/v/28aa0Nv8DfImTgj9BNY5cR
|
|
||||||
UdLk+Wa3CSXQVE7PIsi0egEjAMfyxPEywbvPlgklW4XAKDVUCf3gxpQNN47VuVgV
|
|
||||||
VwrN0VBurhhIKoEw9daO6A0P44+6nmXGIfUulCr4fMxYq82SOooog/j5w0/LfITu
|
|
||||||
rQXxVABLkXHGN/NGf4BE52QI/ppeXWoshlNVU1wdZIIYWwte+9ukikWpN+LYfJUR
|
|
||||||
ybtyCjQ4Gdf8ap1GmkKHmAru24wbUuFsBWGVgHsXAwYlKxyiNGR9YwgAxmFk6vNf
|
|
||||||
1PqKGO3i4erx5X/+mzylzNbFlCqFuksZRyUSDZvQ8fxkm8ra1zWbO38eOTp8Vhgg
|
|
||||||
SKfRTzOKeZYURZicJPxmEIfA88U4tx+YWJ54YWT/gERZkjIJL5mzIuY9UulVvKUM
|
|
||||||
vMFUIzBMHOPXH16036zGyFMC1esRd2qqil4b9KtLgCOkrD1VgpjcveoA0VyMJCN6
|
|
||||||
LmKTrVjwjjDMxby+d49BolRWGnCofXozXwvNQx+CYv8M2WPErTpyYoofYFtpqr7A
|
|
||||||
fIufc/e0+um3zoGIbHejrhsbuH9Qf+MKsI+Ng93bdDtjeHz6MEgAlsTm0qeizYpj
|
|
||||||
IyKZIObPmfvrAm08hFZ8JnGk+XuooF36XWbJYjCCy0bOyMw1r7ZG99TcSwARAQAB
|
|
||||||
tC1TZWN1cml0eSBOeW0gVGVjaG5vbG9naWVzIDxzZWN1cml0eUBueW10ZS5jaD6J
|
|
||||||
AlQEEwEKAD4WIQQkslkugBpaqoZmyLp8PHJ/BQkFUAUCZT9elwIbAwUJBaOagAUL
|
|
||||||
CQgHAwUVCgkICwUWAgMBAAIeAQIXgAAKCRB8PHJ/BQkFUL7dD/9zO73uI5VR+SWx
|
|
||||||
PFmJW+9QsPiQbVRvGwNZurctmQ2s2Pe0vHRELFeqD5oYvSx2Lequ3Ir+zn/C3kDM
|
|
||||||
kNs40obSL6jCBiLPkxEY0JqzPM9jZr7EjvlibWV3f6DxooRIqEyfN57I3OBGlqZE
|
|
||||||
0Mx7sQuCcgau8C70DF952QhKUwXC2cmpmDKHVEEoio1xGSD4dQhGapCB32RQGtna
|
|
||||||
OGfAO9celNMvSq0Lp+aJxeACmWFY5T4/y79JPcT5vSs/yEIRmaH/fn2piwaFBsIq
|
|
||||||
gHJJMxO3740P1hF8j7KWUoUofuFaEALHBpEpjWTOj8ej1wmFlu+5F+jSVoc781Wb
|
|
||||||
ZZXu04cOBXnGTogzSxMpBe9TtLb28zd6WzFotC25KTI3pngMzXsQGLJLOwvoZKiS
|
|
||||||
LFjPRjg1rwobmB3Q3J2W5GYSveia0CDsZGP+g87GVVf/oD2Djpa68xyVYwIYeA6T
|
|
||||||
3DNdS77qHiRuGiS4kWXyVjDqOICboR4uCvt09zlkBuLDdTWqWYARUvZjtjs4w/Ol
|
|
||||||
rdrBI3A88ti8fRldYaNpu17ME1ilpN44yKoJtqiWc3Tisk8eYLfx6c7FQF3PrRva
|
|
||||||
mr7FZvhFsYML5CeNFHTEzN6Y3jjKN/60DvCfodWnWFK47Txkl8UAXGY2W9B0fWqQ
|
|
||||||
wUVr8uLuMyyMiKbeoufi7rGOj6AMErkCDQRlP16XARAA8FGmD5J3tM1BOM1niJxZ
|
|
||||||
JTdCauzEtxEoBL0RuqGBkR8U29sRM6DwuzjU7PwscFnBaGyU+eU73GwGkH3ozFfF
|
|
||||||
tllYhQrhP/kkN+0rEO5Xi+nR+4JCFRqrf3nJXAAPfiksURMp8er1dUOY2/e1ZSoL
|
|
||||||
tS+nzUivV8CfE+pgj/5YtGwPC+KYHLATkKkMELCrbW4UO06VWOqQsvr6kivXuJQQ
|
|
||||||
LdEAMpBlADmXFG45DmPKQzsBWUgvTwyGy3LX0nys8cgpex9BH8hhr01QmGyP469s
|
|
||||||
N3cNrtFuu8U6RAsiCD/8mlBuD3EQEU5SF0lc7kCICAZk+wElmXnimEi0TOYsbz6k
|
|
||||||
90lteicX70rA9GNeyI76H+VSOYvWpkRwaJAgUdzrAM1o9SHASq+cZ6nD85OZioQk
|
|
||||||
DWM6+Q+sf2oen0qJnnGmUr93kJIC0PIdgrXRrtiNfeRa1Z/H0LmREyyEMoFiVivn
|
|
||||||
z1vVk85Oq6Sf3ltUwvmDzuuJOtsp2Qp6+x6Snn/yKauI4uf4Cf/wKUch4r6Bwgg5
|
|
||||||
Dw49ky7lwlnALio4GIVoGLpLef93wWoDmp4Klyh3ZPf2nB0U91u3bHRUo7m+D7QJ
|
|
||||||
98cyKtqLLzjg7szGf60pIWNWRsadYQT3bSncynqknAjOV3BCvx6/ivsnpj//QjYR
|
|
||||||
HtviUAcQ1DBB6UC6q23FIs0AEQEAAYkCPAQYAQoAJhYhBCSyWS6AGlqqhmbIunw8
|
|
||||||
cn8FCQVQBQJlP16XAhsMBQkFo5qAAAoJEHw8cn8FCQVQzukP/iLxjOxT+UpPR//c
|
|
||||||
prDVSLkP4pF5bmw36U07jvqpS+/KTXsxiiQleffRabOpNLcd+K1ueavyt9nnIwHH
|
|
||||||
tHS9kM9A7DBw3LnpEbXki46QDCCI6niGijlLOEeAWqnocwMNTT05wVVgCtO3DQP2
|
|
||||||
MoSCcqHpXDChvOyr5d5xjYLVJhlctIMSomcVzGryjknPu0Yj/TkC/4c+m86ZWQUD
|
|
||||||
HqMHQIuiEenvb62/F4c5OJIRZPEn70wdddkgJuJU3eHdHrnuhCkjCC93GQGbGj03
|
|
||||||
Zqos6699y6hmPeD3U5IUv8ujwZYVCCuDm8gJfrp3R6WLfeZeK9WmTVBpCzsDg3fV
|
|
||||||
hSwmOk6pp8DAq1/Dev3yRkFggCEyGK6c9b+a0CRBncl8e5Q0QQIzNiS/uExQP3h+
|
|
||||||
ELJs3P0MLP+6FWhNUry09n3lnWkr1hY+v1M0GAxbfdv/tsCN1Pq/VQEz+CTqXqya
|
|
||||||
ftWldOHWw6Hh+gtwxcHjG4MBOrO5oICQ3lh2hGwQ58cDgZYSK/OGgJ9BggFl1CcM
|
|
||||||
0uGC0/TRCI1zt/4y+7efSZQMZkHo7VC/3MFbp2hcNejpW+BxVuwKTunFvWK3TLhq
|
|
||||||
sSlQ5yyhqchooepsFHq9bosKFjLJC01uprBv1rinoNduOy43FbyS7JPRRspANN0R
|
|
||||||
iC2pMbWdE0ZTQaFq6tPIg058pjqi
|
|
||||||
=nqgX
|
|
||||||
-----END PGP PUBLIC KEY BLOCK-----
|
|
||||||
```
|
|
||||||
|
|||||||
@@ -1,70 +0,0 @@
|
|||||||
<html>
|
|
||||||
|
|
||||||
<head>
|
|
||||||
<style>
|
|
||||||
@media (prefers-color-scheme: dark) {
|
|
||||||
body {
|
|
||||||
background: #333;
|
|
||||||
color: white;
|
|
||||||
}
|
|
||||||
a {
|
|
||||||
color: skyblue;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
.container {
|
|
||||||
font-family: sans-serif;
|
|
||||||
max-width: 800px;
|
|
||||||
margin: 0 auto;
|
|
||||||
}
|
|
||||||
.intro {
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
.licenses-list {
|
|
||||||
list-style-type: none;
|
|
||||||
margin: 0;
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
.license-used-by {
|
|
||||||
margin-top: -10px;
|
|
||||||
}
|
|
||||||
.license-text {
|
|
||||||
max-height: 200px;
|
|
||||||
overflow-y: scroll;
|
|
||||||
white-space: pre-wrap;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<main class="container">
|
|
||||||
<div class="intro">
|
|
||||||
<h1>Third Party Licenses</h1>
|
|
||||||
<p>This page lists the licenses of the projects used in cargo-about.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<h2>Overview of licenses:</h2>
|
|
||||||
<ul class="licenses-overview">
|
|
||||||
{{#each overview}}
|
|
||||||
<li><a href="#{{id}}">{{name}}</a> ({{count}})</li>
|
|
||||||
{{/each}}
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h2>All license text:</h2>
|
|
||||||
<ul class="licenses-list">
|
|
||||||
{{#each licenses}}
|
|
||||||
<li class="license">
|
|
||||||
<h3 id="{{id}}">{{name}}</h3>
|
|
||||||
<h4>Used by:</h4>
|
|
||||||
<ul class="license-used-by">
|
|
||||||
{{#each used_by}}
|
|
||||||
<li><a href="{{#if crate.repository}} {{crate.repository}} {{else}} https://crates.io/crates/{{crate.name}} {{/if}}">{{crate.name}} {{crate.version}}</a></li>
|
|
||||||
{{/each}}
|
|
||||||
</ul>
|
|
||||||
<pre class="license-text">{{text}}</pre>
|
|
||||||
</li>
|
|
||||||
{{/each}}
|
|
||||||
</ul>
|
|
||||||
</main>
|
|
||||||
</body>
|
|
||||||
|
|
||||||
</html>
|
|
||||||
-19
@@ -1,19 +0,0 @@
|
|||||||
private = { ignore = true }
|
|
||||||
|
|
||||||
accepted = [
|
|
||||||
"0BSD",
|
|
||||||
"Apache-2.0",
|
|
||||||
"BSD-2-Clause",
|
|
||||||
"BSD-3-Clause",
|
|
||||||
"CC0-1.0",
|
|
||||||
"ISC",
|
|
||||||
"MIT",
|
|
||||||
"MPL-2.0",
|
|
||||||
"Unicode-DFS-2016",
|
|
||||||
"OpenSSL",
|
|
||||||
]
|
|
||||||
|
|
||||||
workarounds = [
|
|
||||||
"ring",
|
|
||||||
"rustls",
|
|
||||||
]
|
|
||||||
@@ -1,11 +1,10 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "nym-client"
|
name = "nym-client"
|
||||||
version = "1.1.32"
|
version = "1.1.30"
|
||||||
authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>", "Jędrzej Stuczyński <andrew@nymtech.net>"]
|
authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>", "Jędrzej Stuczyński <andrew@nymtech.net>"]
|
||||||
description = "Implementation of the Nym Client"
|
description = "Implementation of the Nym Client"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
rust-version = "1.65"
|
rust-version = "1.65"
|
||||||
license.workspace = true
|
|
||||||
|
|
||||||
# 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
|
||||||
|
|
||||||
@@ -21,7 +20,7 @@ futures = { workspace = true } # bunch of futures stuff, however, now that I thi
|
|||||||
# and the single instance of abortable we have should really be refactored anyway
|
# and the single instance of abortable we have should really be refactored anyway
|
||||||
url = { workspace = true }
|
url = { workspace = true }
|
||||||
|
|
||||||
clap = { workspace = true, features = ["cargo", "derive"] }
|
clap = { version = "4.0", features = ["cargo", "derive"] }
|
||||||
dirs = "4.0"
|
dirs = "4.0"
|
||||||
lazy_static = "1.4.0"
|
lazy_static = "1.4.0"
|
||||||
log = { workspace = true } # self explanatory
|
log = { workspace = true } # self explanatory
|
||||||
@@ -37,7 +36,7 @@ tokio-tungstenite = { workspace = true }
|
|||||||
## internal
|
## internal
|
||||||
nym-bandwidth-controller = { path = "../../common/bandwidth-controller" }
|
nym-bandwidth-controller = { path = "../../common/bandwidth-controller" }
|
||||||
nym-bin-common = { path = "../../common/bin-common", features = ["output_format"] }
|
nym-bin-common = { path = "../../common/bin-common", features = ["output_format"] }
|
||||||
nym-client-core = { path = "../../common/client-core", features = ["fs-surb-storage", "cli"] }
|
nym-client-core = { path = "../../common/client-core", features = ["fs-surb-storage"] }
|
||||||
nym-coconut-interface = { path = "../../common/coconut-interface" }
|
nym-coconut-interface = { path = "../../common/coconut-interface" }
|
||||||
nym-config = { path = "../../common/config" }
|
nym-config = { path = "../../common/config" }
|
||||||
nym-credential-storage = { path = "../../common/credential-storage" }
|
nym-credential-storage = { path = "../../common/credential-storage" }
|
||||||
|
|||||||
@@ -1667,9 +1667,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/follow-redirects": {
|
"node_modules/follow-redirects": {
|
||||||
"version": "1.15.4",
|
"version": "1.14.9",
|
||||||
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz",
|
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.9.tgz",
|
||||||
"integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==",
|
"integrity": "sha512-MQDfihBQYMcyy5dhRDJUHcw7lb2Pv/TuE6xP1vyraLukNDHKbDxDNaOE3NbCAdKQApno+GPRyo1YAp89yCjK4w==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"funding": [
|
"funding": [
|
||||||
{
|
{
|
||||||
@@ -5800,9 +5800,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"follow-redirects": {
|
"follow-redirects": {
|
||||||
"version": "1.15.4",
|
"version": "1.14.9",
|
||||||
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz",
|
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.9.tgz",
|
||||||
"integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==",
|
"integrity": "sha512-MQDfihBQYMcyy5dhRDJUHcw7lb2Pv/TuE6xP1vyraLukNDHKbDxDNaOE3NbCAdKQApno+GPRyo1YAp89yCjK4w==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"forwarded": {
|
"forwarded": {
|
||||||
|
|||||||
@@ -4,8 +4,6 @@
|
|||||||
use crate::client::config::persistence::ClientPaths;
|
use crate::client::config::persistence::ClientPaths;
|
||||||
use crate::client::config::template::CONFIG_TEMPLATE;
|
use crate::client::config::template::CONFIG_TEMPLATE;
|
||||||
use nym_bin_common::logging::LoggingSettings;
|
use nym_bin_common::logging::LoggingSettings;
|
||||||
use nym_client_core::cli_helpers::client_init::ClientConfig;
|
|
||||||
use nym_client_core::config::disk_persistence::CommonClientPaths;
|
|
||||||
use nym_config::defaults::DEFAULT_WEBSOCKET_LISTENING_PORT;
|
use nym_config::defaults::DEFAULT_WEBSOCKET_LISTENING_PORT;
|
||||||
use nym_config::{
|
use nym_config::{
|
||||||
must_get_home, read_config_from_toml_file, save_formatted_config_to_file, NymConfigTemplate,
|
must_get_home, read_config_from_toml_file, save_formatted_config_to_file, NymConfigTemplate,
|
||||||
@@ -74,24 +72,6 @@ impl NymConfigTemplate for Config {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl ClientConfig for Config {
|
|
||||||
fn common_paths(&self) -> &CommonClientPaths {
|
|
||||||
&self.storage_paths.common_paths
|
|
||||||
}
|
|
||||||
|
|
||||||
fn core_config(&self) -> &BaseClientConfig {
|
|
||||||
&self.base
|
|
||||||
}
|
|
||||||
|
|
||||||
fn default_store_location(&self) -> PathBuf {
|
|
||||||
self.default_location()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn save_to<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
|
|
||||||
save_formatted_config_to_file(self, path)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Config {
|
impl Config {
|
||||||
pub fn new<S: AsRef<str>>(id: S) -> Self {
|
pub fn new<S: AsRef<str>>(id: S) -> Self {
|
||||||
Config {
|
Config {
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ use crate::{
|
|||||||
use nym_bin_common::logging::LoggingSettings;
|
use nym_bin_common::logging::LoggingSettings;
|
||||||
use nym_client_core::config::disk_persistence::old_v1_1_20_2::CommonClientPathsV1_1_20_2;
|
use nym_client_core::config::disk_persistence::old_v1_1_20_2::CommonClientPathsV1_1_20_2;
|
||||||
use nym_client_core::config::old_config_v1_1_20_2::ConfigV1_1_20_2 as BaseConfigV1_1_20_2;
|
use nym_client_core::config::old_config_v1_1_20_2::ConfigV1_1_20_2 as BaseConfigV1_1_20_2;
|
||||||
use nym_client_core::config::old_config_v1_1_30::ConfigV1_1_30 as BaseConfigV1_1_30;
|
|
||||||
use nym_client_core::config::GatewayEndpointConfig;
|
use nym_client_core::config::GatewayEndpointConfig;
|
||||||
use nym_config::read_config_from_toml_file;
|
use nym_config::read_config_from_toml_file;
|
||||||
use nym_network_defaults::DEFAULT_WEBSOCKET_LISTENING_PORT;
|
use nym_network_defaults::DEFAULT_WEBSOCKET_LISTENING_PORT;
|
||||||
@@ -52,7 +51,7 @@ impl ConfigV1_1_20_2 {
|
|||||||
pub fn upgrade(self) -> Result<(Config, GatewayEndpointConfig), ClientError> {
|
pub fn upgrade(self) -> Result<(Config, GatewayEndpointConfig), ClientError> {
|
||||||
let gateway_details = self.base.client.gateway_endpoint.clone().into();
|
let gateway_details = self.base.client.gateway_endpoint.clone().into();
|
||||||
let config = Config {
|
let config = Config {
|
||||||
base: BaseConfigV1_1_30::from(self.base).into(),
|
base: self.base.into(),
|
||||||
socket: self.socket.into(),
|
socket: self.socket.into(),
|
||||||
storage_paths: ClientPaths {
|
storage_paths: ClientPaths {
|
||||||
common_paths: self.storage_paths.common_paths.upgrade_default()?,
|
common_paths: self.storage_paths.common_paths.upgrade_default()?,
|
||||||
|
|||||||
@@ -12,49 +12,55 @@ use crate::{
|
|||||||
};
|
};
|
||||||
use clap::Args;
|
use clap::Args;
|
||||||
use nym_bin_common::output_format::OutputFormat;
|
use nym_bin_common::output_format::OutputFormat;
|
||||||
use nym_client_core::cli_helpers::client_init::{
|
use nym_client_core::client::base_client::storage::gateway_details::OnDiskGatewayDetails;
|
||||||
initialise_client, CommonClientInitArgs, InitResultsWithConfig, InitialisableClient,
|
use nym_client_core::client::key_manager::persistence::OnDiskKeys;
|
||||||
};
|
use nym_client_core::config::GatewayEndpointConfig;
|
||||||
|
use nym_client_core::error::ClientCoreError;
|
||||||
|
use nym_client_core::init::helpers::current_gateways;
|
||||||
|
use nym_client_core::init::types::{GatewayDetails, GatewaySelectionSpecification, GatewaySetup};
|
||||||
|
use nym_crypto::asymmetric::identity;
|
||||||
|
use nym_sphinx::addressing::clients::Recipient;
|
||||||
|
use nym_topology::NymTopology;
|
||||||
use serde::Serialize;
|
use serde::Serialize;
|
||||||
use std::fmt::Display;
|
use std::fmt::Display;
|
||||||
use std::fs;
|
|
||||||
use std::net::IpAddr;
|
use std::net::IpAddr;
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
|
use std::{fs, io};
|
||||||
|
use tap::TapFallible;
|
||||||
|
|
||||||
struct NativeClientInit;
|
#[derive(Args, Clone)]
|
||||||
|
|
||||||
impl InitialisableClient for NativeClientInit {
|
|
||||||
const NAME: &'static str = "native";
|
|
||||||
type Error = ClientError;
|
|
||||||
type InitArgs = Init;
|
|
||||||
type Config = Config;
|
|
||||||
|
|
||||||
fn try_upgrade_outdated_config(id: &str) -> Result<(), Self::Error> {
|
|
||||||
try_upgrade_config(id)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn initialise_storage_paths(id: &str) -> Result<(), Self::Error> {
|
|
||||||
fs::create_dir_all(default_data_directory(id))?;
|
|
||||||
fs::create_dir_all(default_config_directory(id))?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn default_config_path(id: &str) -> PathBuf {
|
|
||||||
default_config_filepath(id)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn construct_config(init_args: &Self::InitArgs) -> Self::Config {
|
|
||||||
override_config(
|
|
||||||
Config::new(&init_args.common_args.id),
|
|
||||||
OverrideConfig::from(init_args.clone()),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Args, Clone, Debug)]
|
|
||||||
pub(crate) struct Init {
|
pub(crate) struct Init {
|
||||||
#[command(flatten)]
|
/// Id of the nym-mixnet-client we want to create config for.
|
||||||
common_args: CommonClientInitArgs,
|
#[clap(long)]
|
||||||
|
id: String,
|
||||||
|
|
||||||
|
/// Id of the gateway we are going to connect to.
|
||||||
|
#[clap(long)]
|
||||||
|
gateway: Option<identity::PublicKey>,
|
||||||
|
|
||||||
|
/// Specifies whether the new gateway should be determined based by latency as opposed to being chosen
|
||||||
|
/// uniformly.
|
||||||
|
#[clap(long, conflicts_with = "gateway")]
|
||||||
|
latency_based_selection: bool,
|
||||||
|
|
||||||
|
/// Force register gateway. WARNING: this will overwrite any existing keys for the given id,
|
||||||
|
/// potentially causing loss of access.
|
||||||
|
#[clap(long)]
|
||||||
|
force_register_gateway: bool,
|
||||||
|
|
||||||
|
/// Comma separated list of rest endpoints of the nyxd validators
|
||||||
|
#[clap(long, alias = "nyxd_validators", value_delimiter = ',', hide = true)]
|
||||||
|
nyxd_urls: Option<Vec<url::Url>>,
|
||||||
|
|
||||||
|
/// Comma separated list of rest endpoints of the API validators
|
||||||
|
#[clap(
|
||||||
|
long,
|
||||||
|
alias = "api_validators",
|
||||||
|
value_delimiter = ',',
|
||||||
|
group = "network"
|
||||||
|
)]
|
||||||
|
// the alias here is included for backwards compatibility (1.1.4 and before)
|
||||||
|
nym_apis: Option<Vec<url::Url>>,
|
||||||
|
|
||||||
/// Whether to not start the websocket
|
/// Whether to not start the websocket
|
||||||
#[clap(long)]
|
#[clap(long)]
|
||||||
@@ -68,28 +74,40 @@ pub(crate) struct Init {
|
|||||||
#[clap(long)]
|
#[clap(long)]
|
||||||
host: Option<IpAddr>,
|
host: Option<IpAddr>,
|
||||||
|
|
||||||
|
/// Path to .json file containing custom network specification.
|
||||||
|
#[clap(long, group = "network", hide = true)]
|
||||||
|
custom_mixnet: Option<PathBuf>,
|
||||||
|
|
||||||
|
/// Mostly debug-related option to increase default traffic rate so that you would not need to
|
||||||
|
/// modify config post init
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
fastmode: bool,
|
||||||
|
|
||||||
|
/// Disable loop cover traffic and the Poisson rate limiter (for debugging only)
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
no_cover: bool,
|
||||||
|
|
||||||
|
/// Set this client to work in a enabled credentials mode that would attempt to use gateway
|
||||||
|
/// with bandwidth credential requirement.
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
enabled_credentials_mode: Option<bool>,
|
||||||
|
|
||||||
#[clap(short, long, default_value_t = OutputFormat::default())]
|
#[clap(short, long, default_value_t = OutputFormat::default())]
|
||||||
output: OutputFormat,
|
output: OutputFormat,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl AsRef<CommonClientInitArgs> for Init {
|
|
||||||
fn as_ref(&self) -> &CommonClientInitArgs {
|
|
||||||
&self.common_args
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<Init> for OverrideConfig {
|
impl From<Init> for OverrideConfig {
|
||||||
fn from(init_config: Init) -> Self {
|
fn from(init_config: Init) -> Self {
|
||||||
OverrideConfig {
|
OverrideConfig {
|
||||||
nym_apis: init_config.common_args.nym_apis,
|
nym_apis: init_config.nym_apis,
|
||||||
disable_socket: init_config.disable_socket,
|
disable_socket: init_config.disable_socket,
|
||||||
port: init_config.port,
|
port: init_config.port,
|
||||||
host: init_config.host,
|
host: init_config.host,
|
||||||
fastmode: init_config.common_args.fastmode,
|
fastmode: init_config.fastmode,
|
||||||
no_cover: init_config.common_args.no_cover,
|
no_cover: init_config.no_cover,
|
||||||
|
|
||||||
nyxd_urls: init_config.common_args.nyxd_urls,
|
nyxd_urls: init_config.nyxd_urls,
|
||||||
enabled_credentials_mode: init_config.common_args.enabled_credentials_mode,
|
enabled_credentials_mode: init_config.enabled_credentials_mode,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -103,11 +121,15 @@ pub struct InitResults {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl InitResults {
|
impl InitResults {
|
||||||
fn new(res: InitResultsWithConfig<Config>) -> Self {
|
fn new(config: &Config, address: &Recipient, gateway: &GatewayEndpointConfig) -> Self {
|
||||||
Self {
|
Self {
|
||||||
client_address: res.init_results.address.to_string(),
|
client_core: nym_client_core::init::types::InitResults::new(
|
||||||
client_core: res.init_results,
|
&config.base,
|
||||||
client_listening_port: res.config.socket.listening_port,
|
address,
|
||||||
|
gateway,
|
||||||
|
),
|
||||||
|
client_listening_port: config.socket.listening_port,
|
||||||
|
client_address: address.to_string(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -120,14 +142,97 @@ impl Display for InitResults {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn init_paths(id: &str) -> io::Result<()> {
|
||||||
|
fs::create_dir_all(default_data_directory(id))?;
|
||||||
|
fs::create_dir_all(default_config_directory(id))
|
||||||
|
}
|
||||||
|
|
||||||
pub(crate) async fn execute(args: Init) -> Result<(), ClientError> {
|
pub(crate) async fn execute(args: Init) -> Result<(), ClientError> {
|
||||||
eprintln!("Initialising client...");
|
eprintln!("Initialising client...");
|
||||||
|
|
||||||
let output = args.output;
|
let id = &args.id;
|
||||||
let res = initialise_client::<NativeClientInit>(args).await?;
|
|
||||||
|
|
||||||
let init_results = InitResults::new(res);
|
let already_init = if default_config_filepath(id).exists() {
|
||||||
println!("{}", output.format(&init_results));
|
// in case we're using old config, try to upgrade it
|
||||||
|
// (if we're using the current version, it's a no-op)
|
||||||
|
try_upgrade_config(id)?;
|
||||||
|
eprintln!("Client \"{id}\" was already initialised before");
|
||||||
|
true
|
||||||
|
} else {
|
||||||
|
init_paths(id)?;
|
||||||
|
false
|
||||||
|
};
|
||||||
|
|
||||||
|
// Usually you only register with the gateway on the first init, however you can force
|
||||||
|
// re-registering if wanted.
|
||||||
|
let user_wants_force_register = args.force_register_gateway;
|
||||||
|
if user_wants_force_register {
|
||||||
|
eprintln!("Instructed to force registering gateway. This will overwrite keys!");
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the client was already initialized, don't generate new keys and don't re-register with
|
||||||
|
// the gateway (because this would create a new shared key).
|
||||||
|
// Unless the user really wants to.
|
||||||
|
let register_gateway = !already_init || user_wants_force_register;
|
||||||
|
|
||||||
|
// Attempt to use a user-provided gateway, if possible
|
||||||
|
let user_chosen_gateway_id = args.gateway;
|
||||||
|
let selection_spec = GatewaySelectionSpecification::new(
|
||||||
|
user_chosen_gateway_id.map(|id| id.to_base58_string()),
|
||||||
|
Some(args.latency_based_selection),
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Load and potentially override config
|
||||||
|
let config = override_config(Config::new(id), OverrideConfig::from(args.clone()));
|
||||||
|
|
||||||
|
// Setup gateway by either registering a new one, or creating a new config from the selected
|
||||||
|
// one but with keys kept, or reusing the gateway configuration.
|
||||||
|
let key_store = OnDiskKeys::new(config.storage_paths.common_paths.keys.clone());
|
||||||
|
let details_store =
|
||||||
|
OnDiskGatewayDetails::new(&config.storage_paths.common_paths.gateway_details);
|
||||||
|
|
||||||
|
let available_gateways = if let Some(hardcoded_topology) = args
|
||||||
|
.custom_mixnet
|
||||||
|
.map(NymTopology::new_from_file)
|
||||||
|
.transpose()?
|
||||||
|
{
|
||||||
|
// hardcoded_topology
|
||||||
|
hardcoded_topology.get_gateways()
|
||||||
|
} else {
|
||||||
|
let mut rng = rand::thread_rng();
|
||||||
|
current_gateways(&mut rng, &config.base.client.nym_api_urls).await?
|
||||||
|
};
|
||||||
|
|
||||||
|
let gateway_setup = GatewaySetup::New {
|
||||||
|
specification: selection_spec,
|
||||||
|
available_gateways,
|
||||||
|
overwrite_data: register_gateway,
|
||||||
|
};
|
||||||
|
|
||||||
|
let init_details =
|
||||||
|
nym_client_core::init::setup_gateway(gateway_setup, &key_store, &details_store)
|
||||||
|
.await
|
||||||
|
.tap_err(|err| eprintln!("Failed to setup gateway\nError: {err}"))?;
|
||||||
|
|
||||||
|
let config_save_location = config.default_location();
|
||||||
|
config.save_to_default_location().tap_err(|_| {
|
||||||
|
log::error!("Failed to save the config file");
|
||||||
|
})?;
|
||||||
|
eprintln!(
|
||||||
|
"Saved configuration file to {}",
|
||||||
|
config_save_location.display()
|
||||||
|
);
|
||||||
|
|
||||||
|
let address = init_details.client_address()?;
|
||||||
|
|
||||||
|
eprintln!("Client configuration completed.\n");
|
||||||
|
|
||||||
|
let GatewayDetails::Configured(gateway_details) = init_details.gateway_details else {
|
||||||
|
return Err(ClientCoreError::UnexpectedPersistedCustomGatewayDetails)?;
|
||||||
|
};
|
||||||
|
let init_results = InitResults::new(&config, &address, &gateway_details);
|
||||||
|
println!("{}", args.output.format(&init_results));
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,14 +10,35 @@ use crate::{
|
|||||||
use clap::Args;
|
use clap::Args;
|
||||||
use log::*;
|
use log::*;
|
||||||
use nym_bin_common::version_checker::is_minor_version_compatible;
|
use nym_bin_common::version_checker::is_minor_version_compatible;
|
||||||
use nym_client_core::cli_helpers::client_run::CommonClientRunArgs;
|
use nym_crypto::asymmetric::identity;
|
||||||
use std::error::Error;
|
use std::error::Error;
|
||||||
use std::net::IpAddr;
|
use std::net::IpAddr;
|
||||||
|
use std::path::PathBuf;
|
||||||
|
|
||||||
#[derive(Args, Clone)]
|
#[derive(Args, Clone)]
|
||||||
pub(crate) struct Run {
|
pub(crate) struct Run {
|
||||||
#[command(flatten)]
|
/// Id of the nym-mixnet-client we want to run.
|
||||||
common_args: CommonClientRunArgs,
|
#[clap(long)]
|
||||||
|
id: String,
|
||||||
|
|
||||||
|
/// Comma separated list of rest endpoints of the nyxd validators
|
||||||
|
#[clap(long, alias = "nyxd_validators", value_delimiter = ',', hide = true)]
|
||||||
|
nyxd_urls: Option<Vec<url::Url>>,
|
||||||
|
|
||||||
|
/// Comma separated list of rest endpoints of the API validators
|
||||||
|
#[clap(
|
||||||
|
long,
|
||||||
|
alias = "api_validators",
|
||||||
|
value_delimiter = ',',
|
||||||
|
group = "network"
|
||||||
|
)]
|
||||||
|
// the alias here is included for backwards compatibility (1.1.4 and before)
|
||||||
|
nym_apis: Option<Vec<url::Url>>,
|
||||||
|
|
||||||
|
/// Id of the gateway we want to connect to. If overridden, it is user's responsibility to
|
||||||
|
/// ensure prior registration happened
|
||||||
|
#[clap(long)]
|
||||||
|
gateway: Option<identity::PublicKey>,
|
||||||
|
|
||||||
/// Whether to not start the websocket
|
/// Whether to not start the websocket
|
||||||
#[clap(long)]
|
#[clap(long)]
|
||||||
@@ -30,19 +51,37 @@ pub(crate) struct Run {
|
|||||||
/// Ip for the socket (if applicable) to listen for requests.
|
/// Ip for the socket (if applicable) to listen for requests.
|
||||||
#[clap(long)]
|
#[clap(long)]
|
||||||
host: Option<IpAddr>,
|
host: Option<IpAddr>,
|
||||||
|
|
||||||
|
/// Path to .json file containing custom network specification.
|
||||||
|
#[clap(long, group = "network", hide = true)]
|
||||||
|
custom_mixnet: Option<PathBuf>,
|
||||||
|
|
||||||
|
/// Mostly debug-related option to increase default traffic rate so that you would not need to
|
||||||
|
/// modify config post init
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
fastmode: bool,
|
||||||
|
|
||||||
|
/// Disable loop cover traffic and the Poisson rate limiter (for debugging only)
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
no_cover: bool,
|
||||||
|
|
||||||
|
/// Set this client to work in a enabled credentials mode that would attempt to use gateway
|
||||||
|
/// with bandwidth credential requirement.
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
enabled_credentials_mode: Option<bool>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<Run> for OverrideConfig {
|
impl From<Run> for OverrideConfig {
|
||||||
fn from(run_config: Run) -> Self {
|
fn from(run_config: Run) -> Self {
|
||||||
OverrideConfig {
|
OverrideConfig {
|
||||||
nym_apis: run_config.common_args.nym_apis,
|
nym_apis: run_config.nym_apis,
|
||||||
disable_socket: run_config.disable_socket,
|
disable_socket: run_config.disable_socket,
|
||||||
port: run_config.port,
|
port: run_config.port,
|
||||||
host: run_config.host,
|
host: run_config.host,
|
||||||
fastmode: run_config.common_args.fastmode,
|
fastmode: run_config.fastmode,
|
||||||
no_cover: run_config.common_args.no_cover,
|
no_cover: run_config.no_cover,
|
||||||
nyxd_urls: run_config.common_args.nyxd_urls,
|
nyxd_urls: run_config.nyxd_urls,
|
||||||
enabled_credentials_mode: run_config.common_args.enabled_credentials_mode,
|
enabled_credentials_mode: run_config.enabled_credentials_mode,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -67,9 +106,9 @@ fn version_check(cfg: &Config) -> bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) async fn execute(args: Run) -> Result<(), Box<dyn Error + Send + Sync>> {
|
pub(crate) async fn execute(args: Run) -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||||
eprintln!("Starting client {}...", args.common_args.id);
|
eprintln!("Starting client {}...", args.id);
|
||||||
|
|
||||||
let mut config = try_load_current_config(&args.common_args.id)?;
|
let mut config = try_load_current_config(&args.id)?;
|
||||||
config = override_config(config, OverrideConfig::from(args.clone()));
|
config = override_config(config, OverrideConfig::from(args.clone()));
|
||||||
|
|
||||||
if !version_check(&config) {
|
if !version_check(&config) {
|
||||||
@@ -77,7 +116,7 @@ pub(crate) async fn execute(args: Run) -> Result<(), Box<dyn Error + Send + Sync
|
|||||||
return Err(Box::new(ClientError::FailedLocalVersionCheck));
|
return Err(Box::new(ClientError::FailedLocalVersionCheck));
|
||||||
}
|
}
|
||||||
|
|
||||||
SocketClient::new(config, args.common_args.custom_mixnet)
|
SocketClient::new(config, args.custom_mixnet)
|
||||||
.run_socket_forever()
|
.run_socket_forever()
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -22,10 +22,5 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||||||
}
|
}
|
||||||
setup_logging();
|
setup_logging();
|
||||||
|
|
||||||
if let Err(err) = commands::execute(args).await {
|
commands::execute(args).await
|
||||||
log::error!("{err}");
|
|
||||||
println!("An error occurred: {err}");
|
|
||||||
std::process::exit(1);
|
|
||||||
}
|
|
||||||
Ok(())
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ name = "nym-client-websocket-requests"
|
|||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
authors = ["Jędrzej Stuczyński <andrew@nymtech.net>"]
|
authors = ["Jędrzej Stuczyński <andrew@nymtech.net>"]
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
license.workspace = true
|
|
||||||
|
|
||||||
# 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
|
||||||
|
|
||||||
|
|||||||
@@ -1,14 +1,13 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "nym-socks5-client"
|
name = "nym-socks5-client"
|
||||||
version = "1.1.32"
|
version = "1.1.30"
|
||||||
authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
|
authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
|
||||||
description = "A SOCKS5 localhost proxy that converts incoming messages to Sphinx and sends them to a Nym address"
|
description = "A SOCKS5 localhost proxy that converts incoming messages to Sphinx and sends them to a Nym address"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
rust-version = "1.56"
|
rust-version = "1.56"
|
||||||
license.workspace = true
|
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
clap = { workspace = true, features = ["cargo", "derive"] }
|
clap = { version = "4.0", features = ["cargo", "derive"] }
|
||||||
lazy_static = "1.4.0"
|
lazy_static = "1.4.0"
|
||||||
log = { workspace = true }
|
log = { workspace = true }
|
||||||
pretty_env_logger = "0.4"
|
pretty_env_logger = "0.4"
|
||||||
@@ -22,7 +21,7 @@ url = { workspace = true }
|
|||||||
|
|
||||||
# internal
|
# internal
|
||||||
nym-bin-common = { path = "../../common/bin-common", features = ["output_format"] }
|
nym-bin-common = { path = "../../common/bin-common", features = ["output_format"] }
|
||||||
nym-client-core = { path = "../../common/client-core", features = ["fs-surb-storage", "cli"] }
|
nym-client-core = { path = "../../common/client-core", features = ["fs-surb-storage"] }
|
||||||
nym-coconut-interface = { path = "../../common/coconut-interface" }
|
nym-coconut-interface = { path = "../../common/coconut-interface" }
|
||||||
nym-config = { path = "../../common/config" }
|
nym-config = { path = "../../common/config" }
|
||||||
nym-credentials = { path = "../../common/credentials" }
|
nym-credentials = { path = "../../common/credentials" }
|
||||||
|
|||||||
@@ -11,50 +11,26 @@ use crate::{
|
|||||||
};
|
};
|
||||||
use clap::Args;
|
use clap::Args;
|
||||||
use nym_bin_common::output_format::OutputFormat;
|
use nym_bin_common::output_format::OutputFormat;
|
||||||
use nym_client_core::cli_helpers::client_init::{
|
use nym_client_core::client::base_client::storage::gateway_details::OnDiskGatewayDetails;
|
||||||
initialise_client, CommonClientInitArgs, InitResultsWithConfig, InitialisableClient,
|
use nym_client_core::client::key_manager::persistence::OnDiskKeys;
|
||||||
};
|
use nym_client_core::config::GatewayEndpointConfig;
|
||||||
|
use nym_client_core::error::ClientCoreError;
|
||||||
|
use nym_client_core::init::helpers::current_gateways;
|
||||||
|
use nym_client_core::init::types::{GatewayDetails, GatewaySelectionSpecification, GatewaySetup};
|
||||||
|
use nym_crypto::asymmetric::identity;
|
||||||
use nym_sphinx::addressing::clients::Recipient;
|
use nym_sphinx::addressing::clients::Recipient;
|
||||||
|
use nym_topology::NymTopology;
|
||||||
use serde::Serialize;
|
use serde::Serialize;
|
||||||
use std::fmt::Display;
|
use std::fmt::Display;
|
||||||
use std::fs;
|
|
||||||
use std::net::{IpAddr, SocketAddr};
|
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
|
use std::{fs, io};
|
||||||
|
use tap::TapFallible;
|
||||||
|
|
||||||
struct Socks5ClientInit;
|
#[derive(Args, Clone)]
|
||||||
|
|
||||||
impl InitialisableClient for Socks5ClientInit {
|
|
||||||
const NAME: &'static str = "socks5";
|
|
||||||
type Error = Socks5ClientError;
|
|
||||||
type InitArgs = Init;
|
|
||||||
type Config = Config;
|
|
||||||
|
|
||||||
fn try_upgrade_outdated_config(id: &str) -> Result<(), Self::Error> {
|
|
||||||
try_upgrade_config(id)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn initialise_storage_paths(id: &str) -> Result<(), Self::Error> {
|
|
||||||
fs::create_dir_all(default_data_directory(id))?;
|
|
||||||
fs::create_dir_all(default_config_directory(id))?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn default_config_path(id: &str) -> PathBuf {
|
|
||||||
default_config_filepath(id)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn construct_config(init_args: &Self::InitArgs) -> Self::Config {
|
|
||||||
override_config(
|
|
||||||
Config::new(&init_args.common_args.id, &init_args.provider.to_string()),
|
|
||||||
OverrideConfig::from(init_args.clone()),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Args, Clone, Debug)]
|
|
||||||
pub(crate) struct Init {
|
pub(crate) struct Init {
|
||||||
#[command(flatten)]
|
/// Id of the nym-mixnet-client we want to create config for.
|
||||||
common_args: CommonClientInitArgs,
|
#[clap(long)]
|
||||||
|
id: String,
|
||||||
|
|
||||||
/// Address of the socks5 provider to send messages to.
|
/// Address of the socks5 provider to send messages to.
|
||||||
#[clap(long)]
|
#[clap(long)]
|
||||||
@@ -69,37 +45,72 @@ pub(crate) struct Init {
|
|||||||
#[clap(long, alias = "use_anonymous_sender_tag")]
|
#[clap(long, alias = "use_anonymous_sender_tag")]
|
||||||
use_reply_surbs: Option<bool>,
|
use_reply_surbs: Option<bool>,
|
||||||
|
|
||||||
|
/// Id of the gateway we are going to connect to.
|
||||||
|
#[clap(long)]
|
||||||
|
gateway: Option<identity::PublicKey>,
|
||||||
|
|
||||||
|
/// Specifies whether the new gateway should be determined based by latency as opposed to being chosen
|
||||||
|
/// uniformly.
|
||||||
|
#[clap(long, conflicts_with = "gateway")]
|
||||||
|
latency_based_selection: bool,
|
||||||
|
|
||||||
|
/// Force register gateway. WARNING: this will overwrite any existing keys for the given id,
|
||||||
|
/// potentially causing loss of access.
|
||||||
|
#[clap(long)]
|
||||||
|
force_register_gateway: bool,
|
||||||
|
|
||||||
|
/// Comma separated list of rest endpoints of the nyxd validators
|
||||||
|
#[clap(long, alias = "nyxd_validators", value_delimiter = ',', hide = true)]
|
||||||
|
nyxd_urls: Option<Vec<url::Url>>,
|
||||||
|
|
||||||
|
/// Comma separated list of rest endpoints of the API validators
|
||||||
|
#[clap(
|
||||||
|
long,
|
||||||
|
alias = "api_validators",
|
||||||
|
value_delimiter = ',',
|
||||||
|
group = "network"
|
||||||
|
)]
|
||||||
|
// the alias here is included for backwards compatibility (1.1.4 and before)
|
||||||
|
nym_apis: Option<Vec<url::Url>>,
|
||||||
|
|
||||||
/// Port for the socket to listen on in all subsequent runs
|
/// Port for the socket to listen on in all subsequent runs
|
||||||
#[clap(short, long)]
|
#[clap(short, long)]
|
||||||
port: Option<u16>,
|
port: Option<u16>,
|
||||||
|
|
||||||
/// The custom host on which the socks5 client will be listening for requests
|
/// Path to .json file containing custom network specification.
|
||||||
#[clap(long)]
|
#[clap(long, group = "network", hide = true)]
|
||||||
host: Option<IpAddr>,
|
custom_mixnet: Option<PathBuf>,
|
||||||
|
|
||||||
|
/// Mostly debug-related option to increase default traffic rate so that you would not need to
|
||||||
|
/// modify config post init
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
fastmode: bool,
|
||||||
|
|
||||||
|
/// Disable loop cover traffic and the Poisson rate limiter (for debugging only)
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
no_cover: bool,
|
||||||
|
|
||||||
|
/// Set this client to work in a enabled credentials mode that would attempt to use gateway
|
||||||
|
/// with bandwidth credential requirement.
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
enabled_credentials_mode: Option<bool>,
|
||||||
|
|
||||||
#[clap(short, long, default_value_t = OutputFormat::default())]
|
#[clap(short, long, default_value_t = OutputFormat::default())]
|
||||||
output: OutputFormat,
|
output: OutputFormat,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl AsRef<CommonClientInitArgs> for Init {
|
|
||||||
fn as_ref(&self) -> &CommonClientInitArgs {
|
|
||||||
&self.common_args
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<Init> for OverrideConfig {
|
impl From<Init> for OverrideConfig {
|
||||||
fn from(init_config: Init) -> Self {
|
fn from(init_config: Init) -> Self {
|
||||||
OverrideConfig {
|
OverrideConfig {
|
||||||
nym_apis: init_config.common_args.nym_apis,
|
nym_apis: init_config.nym_apis,
|
||||||
ip: init_config.host,
|
|
||||||
port: init_config.port,
|
port: init_config.port,
|
||||||
use_anonymous_replies: init_config.use_reply_surbs,
|
use_anonymous_replies: init_config.use_reply_surbs,
|
||||||
fastmode: init_config.common_args.fastmode,
|
fastmode: init_config.fastmode,
|
||||||
no_cover: init_config.common_args.no_cover,
|
no_cover: init_config.no_cover,
|
||||||
geo_routing: None,
|
geo_routing: None,
|
||||||
medium_toggle: false,
|
medium_toggle: false,
|
||||||
nyxd_urls: init_config.common_args.nyxd_urls,
|
nyxd_urls: init_config.nyxd_urls,
|
||||||
enabled_credentials_mode: init_config.common_args.enabled_credentials_mode,
|
enabled_credentials_mode: init_config.enabled_credentials_mode,
|
||||||
outfox: false,
|
outfox: false,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -109,16 +120,20 @@ impl From<Init> for OverrideConfig {
|
|||||||
pub struct InitResults {
|
pub struct InitResults {
|
||||||
#[serde(flatten)]
|
#[serde(flatten)]
|
||||||
client_core: nym_client_core::init::types::InitResults,
|
client_core: nym_client_core::init::types::InitResults,
|
||||||
socks5_listening_address: SocketAddr,
|
socks5_listening_port: u16,
|
||||||
client_address: String,
|
client_address: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl InitResults {
|
impl InitResults {
|
||||||
fn new(res: InitResultsWithConfig<Config>) -> Self {
|
fn new(config: &Config, address: &Recipient, gateway: &GatewayEndpointConfig) -> Self {
|
||||||
Self {
|
Self {
|
||||||
client_address: res.init_results.address.to_string(),
|
client_core: nym_client_core::init::types::InitResults::new(
|
||||||
client_core: res.init_results,
|
&config.core.base,
|
||||||
socks5_listening_address: res.config.core.socks5.bind_adddress,
|
address,
|
||||||
|
gateway,
|
||||||
|
),
|
||||||
|
socks5_listening_port: config.core.socks5.listening_port,
|
||||||
|
client_address: address.to_string(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -126,23 +141,106 @@ impl InitResults {
|
|||||||
impl Display for InitResults {
|
impl Display for InitResults {
|
||||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
writeln!(f, "{}", self.client_core)?;
|
writeln!(f, "{}", self.client_core)?;
|
||||||
writeln!(
|
writeln!(f, "SOCKS5 listening port: {}", self.socks5_listening_port)?;
|
||||||
f,
|
|
||||||
"SOCKS5 listening address: {}",
|
|
||||||
self.socks5_listening_address
|
|
||||||
)?;
|
|
||||||
write!(f, "Address of this client: {}", self.client_address)
|
write!(f, "Address of this client: {}", self.client_address)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn init_paths(id: &str) -> io::Result<()> {
|
||||||
|
fs::create_dir_all(default_data_directory(id))?;
|
||||||
|
fs::create_dir_all(default_config_directory(id))
|
||||||
|
}
|
||||||
|
|
||||||
pub(crate) async fn execute(args: Init) -> Result<(), Socks5ClientError> {
|
pub(crate) async fn execute(args: Init) -> Result<(), Socks5ClientError> {
|
||||||
eprintln!("Initialising client...");
|
eprintln!("Initialising client...");
|
||||||
|
|
||||||
let output = args.output;
|
let id = &args.id;
|
||||||
let res = initialise_client::<Socks5ClientInit>(args).await?;
|
let provider_address = &args.provider;
|
||||||
|
|
||||||
let init_results = InitResults::new(res);
|
let already_init = if default_config_filepath(id).exists() {
|
||||||
println!("{}", output.format(&init_results));
|
// in case we're using old config, try to upgrade it
|
||||||
|
// (if we're using the current version, it's a no-op)
|
||||||
|
try_upgrade_config(id)?;
|
||||||
|
eprintln!("SOCKS5 client \"{id}\" was already initialised before");
|
||||||
|
true
|
||||||
|
} else {
|
||||||
|
init_paths(id)?;
|
||||||
|
false
|
||||||
|
};
|
||||||
|
|
||||||
|
// Usually you only register with the gateway on the first init, however you can force
|
||||||
|
// re-registering if wanted.
|
||||||
|
let user_wants_force_register = args.force_register_gateway;
|
||||||
|
if user_wants_force_register {
|
||||||
|
eprintln!("Instructed to force registering gateway. This might overwrite keys!");
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the client was already initialized, don't generate new keys and don't re-register with
|
||||||
|
// the gateway (because this would create a new shared key).
|
||||||
|
// Unless the user really wants to.
|
||||||
|
let register_gateway = !already_init || user_wants_force_register;
|
||||||
|
|
||||||
|
// Attempt to use a user-provided gateway, if possible
|
||||||
|
let user_chosen_gateway_id = args.gateway;
|
||||||
|
let selection_spec = GatewaySelectionSpecification::new(
|
||||||
|
user_chosen_gateway_id.map(|id| id.to_base58_string()),
|
||||||
|
Some(args.latency_based_selection),
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Load and potentially override config
|
||||||
|
let config = override_config(
|
||||||
|
Config::new(id, &provider_address.to_string()),
|
||||||
|
OverrideConfig::from(args.clone()),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Setup gateway by either registering a new one, or creating a new config from the selected
|
||||||
|
// one but with keys kept, or reusing the gateway configuration.
|
||||||
|
let key_store = OnDiskKeys::new(config.storage_paths.common_paths.keys.clone());
|
||||||
|
let details_store =
|
||||||
|
OnDiskGatewayDetails::new(&config.storage_paths.common_paths.gateway_details);
|
||||||
|
|
||||||
|
let available_gateways = if let Some(hardcoded_topology) = args
|
||||||
|
.custom_mixnet
|
||||||
|
.map(NymTopology::new_from_file)
|
||||||
|
.transpose()?
|
||||||
|
{
|
||||||
|
// hardcoded_topology
|
||||||
|
hardcoded_topology.get_gateways()
|
||||||
|
} else {
|
||||||
|
let mut rng = rand::thread_rng();
|
||||||
|
current_gateways(&mut rng, &config.core.base.client.nym_api_urls).await?
|
||||||
|
};
|
||||||
|
|
||||||
|
let gateway_setup = GatewaySetup::New {
|
||||||
|
specification: selection_spec,
|
||||||
|
available_gateways,
|
||||||
|
overwrite_data: register_gateway,
|
||||||
|
};
|
||||||
|
|
||||||
|
let init_details =
|
||||||
|
nym_client_core::init::setup_gateway(gateway_setup, &key_store, &details_store)
|
||||||
|
.await
|
||||||
|
.tap_err(|err| eprintln!("Failed to setup gateway\nError: {err}"))?;
|
||||||
|
|
||||||
|
// TODO: ask the service provider we specified for its interface version and set it in the config
|
||||||
|
|
||||||
|
let config_save_location = config.default_location();
|
||||||
|
config.save_to_default_location().tap_err(|_| {
|
||||||
|
log::error!("Failed to save the config file");
|
||||||
|
})?;
|
||||||
|
eprintln!(
|
||||||
|
"Saved configuration file to {}",
|
||||||
|
config_save_location.display()
|
||||||
|
);
|
||||||
|
|
||||||
|
let address = init_details.client_address()?;
|
||||||
|
|
||||||
|
let GatewayDetails::Configured(gateway_details) = init_details.gateway_details else {
|
||||||
|
return Err(ClientCoreError::UnexpectedPersistedCustomGatewayDetails)?;
|
||||||
|
};
|
||||||
|
let init_results = InitResults::new(&config, &address, &gateway_details);
|
||||||
|
println!("{}", args.output.format(&init_results));
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,8 +4,7 @@
|
|||||||
use crate::config::old_config_v1_1_13::OldConfigV1_1_13;
|
use crate::config::old_config_v1_1_13::OldConfigV1_1_13;
|
||||||
use crate::config::old_config_v1_1_20::ConfigV1_1_20;
|
use crate::config::old_config_v1_1_20::ConfigV1_1_20;
|
||||||
use crate::config::old_config_v1_1_20_2::ConfigV1_1_20_2;
|
use crate::config::old_config_v1_1_20_2::ConfigV1_1_20_2;
|
||||||
use crate::config::old_config_v1_1_30::ConfigV1_1_30;
|
use crate::config::{BaseClientConfig, Config};
|
||||||
use crate::config::{BaseClientConfig, Config, SocksClientPaths};
|
|
||||||
use crate::error::Socks5ClientError;
|
use crate::error::Socks5ClientError;
|
||||||
use clap::CommandFactory;
|
use clap::CommandFactory;
|
||||||
use clap::{Parser, Subcommand};
|
use clap::{Parser, Subcommand};
|
||||||
@@ -23,7 +22,6 @@ use nym_client_core::error::ClientCoreError;
|
|||||||
use nym_config::OptionalSet;
|
use nym_config::OptionalSet;
|
||||||
use nym_sphinx::params::{PacketSize, PacketType};
|
use nym_sphinx::params::{PacketSize, PacketType};
|
||||||
use std::error::Error;
|
use std::error::Error;
|
||||||
use std::net::IpAddr;
|
|
||||||
|
|
||||||
pub(crate) mod build_info;
|
pub(crate) mod build_info;
|
||||||
pub mod init;
|
pub mod init;
|
||||||
@@ -74,7 +72,6 @@ pub(crate) enum Commands {
|
|||||||
// Configuration that can be overridden.
|
// Configuration that can be overridden.
|
||||||
pub(crate) struct OverrideConfig {
|
pub(crate) struct OverrideConfig {
|
||||||
nym_apis: Option<Vec<url::Url>>,
|
nym_apis: Option<Vec<url::Url>>,
|
||||||
ip: Option<IpAddr>,
|
|
||||||
port: Option<u16>,
|
port: Option<u16>,
|
||||||
use_anonymous_replies: Option<bool>,
|
use_anonymous_replies: Option<bool>,
|
||||||
fastmode: bool,
|
fastmode: bool,
|
||||||
@@ -148,7 +145,6 @@ pub(crate) fn override_config(config: Config, args: OverrideConfig) -> Config {
|
|||||||
)
|
)
|
||||||
.with_optional(Config::with_anonymous_replies, args.use_anonymous_replies)
|
.with_optional(Config::with_anonymous_replies, args.use_anonymous_replies)
|
||||||
.with_optional(Config::with_port, args.port)
|
.with_optional(Config::with_port, args.port)
|
||||||
.with_optional(Config::with_ip, args.ip)
|
|
||||||
.with_optional_base_custom_env(
|
.with_optional_base_custom_env(
|
||||||
BaseClientConfig::with_custom_nym_apis,
|
BaseClientConfig::with_custom_nym_apis,
|
||||||
args.nym_apis,
|
args.nym_apis,
|
||||||
@@ -168,11 +164,12 @@ pub(crate) fn override_config(config: Config, args: OverrideConfig) -> Config {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn persist_gateway_details(
|
fn persist_gateway_details(
|
||||||
storage_paths: &SocksClientPaths,
|
config: &Config,
|
||||||
details: GatewayEndpointConfig,
|
details: GatewayEndpointConfig,
|
||||||
) -> Result<(), Socks5ClientError> {
|
) -> Result<(), Socks5ClientError> {
|
||||||
let details_store = OnDiskGatewayDetails::new(&storage_paths.common_paths.gateway_details);
|
let details_store =
|
||||||
let keys_store = OnDiskKeys::new(storage_paths.common_paths.keys.clone());
|
OnDiskGatewayDetails::new(&config.storage_paths.common_paths.gateway_details);
|
||||||
|
let keys_store = OnDiskKeys::new(config.storage_paths.common_paths.keys.clone());
|
||||||
let shared_keys = keys_store.ephemeral_load_gateway_keys().map_err(|source| {
|
let shared_keys = keys_store.ephemeral_load_gateway_keys().map_err(|source| {
|
||||||
Socks5ClientError::ClientCoreError(ClientCoreError::KeyStoreError {
|
Socks5ClientError::ClientCoreError(ClientCoreError::KeyStoreError {
|
||||||
source: Box::new(source),
|
source: Box::new(source),
|
||||||
@@ -202,10 +199,9 @@ fn try_upgrade_v1_1_13_config(id: &str) -> Result<bool, Socks5ClientError> {
|
|||||||
|
|
||||||
let updated_step1: ConfigV1_1_20 = old_config.into();
|
let updated_step1: ConfigV1_1_20 = old_config.into();
|
||||||
let updated_step2: ConfigV1_1_20_2 = updated_step1.into();
|
let updated_step2: ConfigV1_1_20_2 = updated_step1.into();
|
||||||
let (updated_step3, gateway_config) = updated_step2.upgrade()?;
|
let (updated, gateway_config) = updated_step2.upgrade()?;
|
||||||
persist_gateway_details(&updated_step3.storage_paths, gateway_config)?;
|
persist_gateway_details(&updated, gateway_config)?;
|
||||||
|
|
||||||
let updated: Config = updated_step3.into();
|
|
||||||
updated.save_to_default_location()?;
|
updated.save_to_default_location()?;
|
||||||
Ok(true)
|
Ok(true)
|
||||||
}
|
}
|
||||||
@@ -223,10 +219,9 @@ fn try_upgrade_v1_1_20_config(id: &str) -> Result<bool, Socks5ClientError> {
|
|||||||
info!("It is going to get updated to the current specification.");
|
info!("It is going to get updated to the current specification.");
|
||||||
|
|
||||||
let updated_step1: ConfigV1_1_20_2 = old_config.into();
|
let updated_step1: ConfigV1_1_20_2 = old_config.into();
|
||||||
let (updated_step2, gateway_config) = updated_step1.upgrade()?;
|
let (updated, gateway_config) = updated_step1.upgrade()?;
|
||||||
persist_gateway_details(&updated_step2.storage_paths, gateway_config)?;
|
persist_gateway_details(&updated, gateway_config)?;
|
||||||
|
|
||||||
let updated: Config = updated_step2.into();
|
|
||||||
updated.save_to_default_location()?;
|
updated.save_to_default_location()?;
|
||||||
Ok(true)
|
Ok(true)
|
||||||
}
|
}
|
||||||
@@ -241,25 +236,9 @@ fn try_upgrade_v1_1_20_2_config(id: &str) -> Result<bool, Socks5ClientError> {
|
|||||||
info!("It seems the client is using <= v1.1.20_2 config template.");
|
info!("It seems the client is using <= v1.1.20_2 config template.");
|
||||||
info!("It is going to get updated to the current specification.");
|
info!("It is going to get updated to the current specification.");
|
||||||
|
|
||||||
let (updated_step1, gateway_config) = old_config.upgrade()?;
|
let (updated, gateway_config) = old_config.upgrade()?;
|
||||||
persist_gateway_details(&updated_step1.storage_paths, gateway_config)?;
|
persist_gateway_details(&updated, gateway_config)?;
|
||||||
|
|
||||||
let updated: Config = updated_step1.into();
|
|
||||||
updated.save_to_default_location()?;
|
|
||||||
Ok(true)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn try_upgrade_v1_1_30_config(id: &str) -> Result<bool, Socks5ClientError> {
|
|
||||||
// explicitly load it as v1.1.30 (which is incompatible with the current one, i.e. +1.1.31)
|
|
||||||
let Ok(old_config) = ConfigV1_1_30::read_from_default_path(id) else {
|
|
||||||
// if we failed to load it, there might have been nothing to upgrade
|
|
||||||
// or maybe it was an even older file. in either way. just ignore it and carry on with our day
|
|
||||||
return Ok(false);
|
|
||||||
};
|
|
||||||
info!("It seems the client is using <= v1.1.30 config template.");
|
|
||||||
info!("It is going to get updated to the current specification.");
|
|
||||||
|
|
||||||
let updated: Config = old_config.into();
|
|
||||||
updated.save_to_default_location()?;
|
updated.save_to_default_location()?;
|
||||||
Ok(true)
|
Ok(true)
|
||||||
}
|
}
|
||||||
@@ -274,9 +253,6 @@ fn try_upgrade_config(id: &str) -> Result<(), Socks5ClientError> {
|
|||||||
if try_upgrade_v1_1_20_2_config(id)? {
|
if try_upgrade_v1_1_20_2_config(id)? {
|
||||||
return Ok(());
|
return Ok(());
|
||||||
}
|
}
|
||||||
if try_upgrade_v1_1_30_config(id)? {
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,17 +10,18 @@ use crate::{
|
|||||||
use clap::Args;
|
use clap::Args;
|
||||||
use log::*;
|
use log::*;
|
||||||
use nym_bin_common::version_checker::is_minor_version_compatible;
|
use nym_bin_common::version_checker::is_minor_version_compatible;
|
||||||
use nym_client_core::cli_helpers::client_run::CommonClientRunArgs;
|
|
||||||
use nym_client_core::client::base_client::storage::OnDiskPersistent;
|
use nym_client_core::client::base_client::storage::OnDiskPersistent;
|
||||||
use nym_client_core::client::topology_control::geo_aware_provider::CountryGroup;
|
use nym_client_core::client::topology_control::geo_aware_provider::CountryGroup;
|
||||||
|
use nym_crypto::asymmetric::identity;
|
||||||
use nym_socks5_client_core::NymClient;
|
use nym_socks5_client_core::NymClient;
|
||||||
use nym_sphinx::addressing::clients::Recipient;
|
use nym_sphinx::addressing::clients::Recipient;
|
||||||
use std::net::IpAddr;
|
use std::path::PathBuf;
|
||||||
|
|
||||||
#[derive(Args, Clone)]
|
#[derive(Args, Clone)]
|
||||||
pub(crate) struct Run {
|
pub(crate) struct Run {
|
||||||
#[command(flatten)]
|
/// Id of the nym-mixnet-client we want to run.
|
||||||
common_args: CommonClientRunArgs,
|
#[clap(long)]
|
||||||
|
id: String,
|
||||||
|
|
||||||
/// Specifies whether this client is going to use an anonymous sender tag for communication with the service provider.
|
/// Specifies whether this client is going to use an anonymous sender tag for communication with the service provider.
|
||||||
/// While this is going to hide its actual address information, it will make the actual communication
|
/// While this is going to hide its actual address information, it will make the actual communication
|
||||||
@@ -35,13 +36,35 @@ pub(crate) struct Run {
|
|||||||
#[clap(long)]
|
#[clap(long)]
|
||||||
provider: Option<Recipient>,
|
provider: Option<Recipient>,
|
||||||
|
|
||||||
|
/// Id of the gateway we want to connect to. If overridden, it is user's responsibility to
|
||||||
|
/// ensure prior registration happened
|
||||||
|
#[clap(long)]
|
||||||
|
gateway: Option<identity::PublicKey>,
|
||||||
|
|
||||||
|
/// Comma separated list of rest endpoints of the nyxd validators
|
||||||
|
#[clap(long, alias = "nyxd_validators", value_delimiter = ',', hide = true)]
|
||||||
|
nyxd_urls: Option<Vec<url::Url>>,
|
||||||
|
|
||||||
|
/// Comma separated list of rest endpoints of the Nym APIs
|
||||||
|
#[clap(long, value_delimiter = ',', group = "network")]
|
||||||
|
nym_apis: Option<Vec<url::Url>>,
|
||||||
|
|
||||||
/// Port for the socket to listen on
|
/// Port for the socket to listen on
|
||||||
#[clap(short, long)]
|
#[clap(short, long)]
|
||||||
port: Option<u16>,
|
port: Option<u16>,
|
||||||
|
|
||||||
/// The custom host on which the socks5 client will be listening for requests
|
/// Path to .json file containing custom network specification.
|
||||||
#[clap(long)]
|
#[clap(long, group = "network", group = "routing", hide = true)]
|
||||||
host: Option<IpAddr>,
|
custom_mixnet: Option<PathBuf>,
|
||||||
|
|
||||||
|
/// Mostly debug-related option to increase default traffic rate so that you would not need to
|
||||||
|
/// modify config post init
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
fastmode: bool,
|
||||||
|
|
||||||
|
/// Disable loop cover traffic and the Poisson rate limiter (for debugging only)
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
no_cover: bool,
|
||||||
|
|
||||||
/// Set geo-aware mixnode selection when sending mixnet traffic, for experiments only.
|
/// Set geo-aware mixnode selection when sending mixnet traffic, for experiments only.
|
||||||
#[clap(long, hide = true, value_parser = validate_country_group, group="routing")]
|
#[clap(long, hide = true, value_parser = validate_country_group, group="routing")]
|
||||||
@@ -52,6 +75,11 @@ pub(crate) struct Run {
|
|||||||
#[clap(long, hide = true)]
|
#[clap(long, hide = true)]
|
||||||
medium_toggle: bool,
|
medium_toggle: bool,
|
||||||
|
|
||||||
|
/// Set this client to work in a enabled credentials mode that would attempt to use gateway
|
||||||
|
/// with bandwidth credential requirement.
|
||||||
|
#[clap(long, hide = true)]
|
||||||
|
enabled_credentials_mode: Option<bool>,
|
||||||
|
|
||||||
#[clap(long, hide = true, action)]
|
#[clap(long, hide = true, action)]
|
||||||
outfox: bool,
|
outfox: bool,
|
||||||
}
|
}
|
||||||
@@ -59,16 +87,15 @@ pub(crate) struct Run {
|
|||||||
impl From<Run> for OverrideConfig {
|
impl From<Run> for OverrideConfig {
|
||||||
fn from(run_config: Run) -> Self {
|
fn from(run_config: Run) -> Self {
|
||||||
OverrideConfig {
|
OverrideConfig {
|
||||||
nym_apis: run_config.common_args.nym_apis,
|
nym_apis: run_config.nym_apis,
|
||||||
ip: run_config.host,
|
|
||||||
port: run_config.port,
|
port: run_config.port,
|
||||||
use_anonymous_replies: run_config.use_anonymous_replies,
|
use_anonymous_replies: run_config.use_anonymous_replies,
|
||||||
fastmode: run_config.common_args.fastmode,
|
fastmode: run_config.fastmode,
|
||||||
no_cover: run_config.common_args.no_cover,
|
no_cover: run_config.no_cover,
|
||||||
geo_routing: run_config.geo_routing,
|
geo_routing: run_config.geo_routing,
|
||||||
medium_toggle: run_config.medium_toggle,
|
medium_toggle: run_config.medium_toggle,
|
||||||
nyxd_urls: run_config.common_args.nyxd_urls,
|
nyxd_urls: run_config.nyxd_urls,
|
||||||
enabled_credentials_mode: run_config.common_args.enabled_credentials_mode,
|
enabled_credentials_mode: run_config.enabled_credentials_mode,
|
||||||
outfox: run_config.outfox,
|
outfox: run_config.outfox,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -103,9 +130,9 @@ fn version_check(cfg: &Config) -> bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) async fn execute(args: Run) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
pub(crate) async fn execute(args: Run) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
||||||
eprintln!("Starting client {}...", args.common_args.id);
|
eprintln!("Starting client {}...", args.id);
|
||||||
|
|
||||||
let mut config = try_load_current_config(&args.common_args.id)?;
|
let mut config = try_load_current_config(&args.id)?;
|
||||||
config = override_config(config, OverrideConfig::from(args.clone()));
|
config = override_config(config, OverrideConfig::from(args.clone()));
|
||||||
|
|
||||||
if !version_check(&config) {
|
if !version_check(&config) {
|
||||||
@@ -116,7 +143,7 @@ pub(crate) async fn execute(args: Run) -> Result<(), Box<dyn std::error::Error +
|
|||||||
let storage =
|
let storage =
|
||||||
OnDiskPersistent::from_paths(config.storage_paths.common_paths, &config.core.base.debug)
|
OnDiskPersistent::from_paths(config.storage_paths.common_paths, &config.core.base.debug)
|
||||||
.await?;
|
.await?;
|
||||||
NymClient::new(config.core, storage, args.common_args.custom_mixnet)
|
NymClient::new(config.core, storage, args.custom_mixnet)
|
||||||
.run_forever()
|
.run_forever()
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
|
// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
use crate::config::persistence::SocksClientPaths;
|
||||||
use crate::config::template::CONFIG_TEMPLATE;
|
use crate::config::template::CONFIG_TEMPLATE;
|
||||||
use nym_bin_common::logging::LoggingSettings;
|
use nym_bin_common::logging::LoggingSettings;
|
||||||
use nym_client_core::cli_helpers::client_init::ClientConfig;
|
|
||||||
use nym_client_core::config::disk_persistence::CommonClientPaths;
|
|
||||||
use nym_config::{
|
use nym_config::{
|
||||||
must_get_home, read_config_from_toml_file, save_formatted_config_to_file, NymConfigTemplate,
|
must_get_home, read_config_from_toml_file, save_formatted_config_to_file, NymConfigTemplate,
|
||||||
DEFAULT_CONFIG_DIR, DEFAULT_CONFIG_FILENAME, DEFAULT_DATA_DIR, NYM_DIR,
|
DEFAULT_CONFIG_DIR, DEFAULT_CONFIG_FILENAME, DEFAULT_DATA_DIR, NYM_DIR,
|
||||||
@@ -12,18 +11,15 @@ use nym_config::{
|
|||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use std::fmt::Debug;
|
use std::fmt::Debug;
|
||||||
use std::io;
|
use std::io;
|
||||||
use std::net::IpAddr;
|
|
||||||
use std::path::{Path, PathBuf};
|
use std::path::{Path, PathBuf};
|
||||||
use std::str::FromStr;
|
use std::str::FromStr;
|
||||||
|
|
||||||
pub use crate::config::persistence::SocksClientPaths;
|
|
||||||
pub use nym_client_core::config::Config as BaseClientConfig;
|
pub use nym_client_core::config::Config as BaseClientConfig;
|
||||||
pub use nym_socks5_client_core::config::Config as CoreConfig;
|
pub use nym_socks5_client_core::config::Config as CoreConfig;
|
||||||
|
|
||||||
pub mod old_config_v1_1_13;
|
pub mod old_config_v1_1_13;
|
||||||
pub mod old_config_v1_1_20;
|
pub mod old_config_v1_1_20;
|
||||||
pub mod old_config_v1_1_20_2;
|
pub mod old_config_v1_1_20_2;
|
||||||
pub mod old_config_v1_1_30;
|
|
||||||
mod persistence;
|
mod persistence;
|
||||||
mod template;
|
mod template;
|
||||||
|
|
||||||
@@ -71,24 +67,6 @@ impl NymConfigTemplate for Config {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl ClientConfig for Config {
|
|
||||||
fn common_paths(&self) -> &CommonClientPaths {
|
|
||||||
&self.storage_paths.common_paths
|
|
||||||
}
|
|
||||||
|
|
||||||
fn core_config(&self) -> &BaseClientConfig {
|
|
||||||
&self.core.base
|
|
||||||
}
|
|
||||||
|
|
||||||
fn default_store_location(&self) -> PathBuf {
|
|
||||||
self.default_location()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn save_to<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
|
|
||||||
save_formatted_config_to_file(self, path)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Config {
|
impl Config {
|
||||||
pub fn new<S: AsRef<str>>(id: S, provider_mix_address: S) -> Self {
|
pub fn new<S: AsRef<str>>(id: S, provider_mix_address: S) -> Self {
|
||||||
Config {
|
Config {
|
||||||
@@ -124,15 +102,8 @@ impl Config {
|
|||||||
self.core.validate()
|
self.core.validate()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[must_use]
|
|
||||||
pub fn with_port(mut self, port: u16) -> Self {
|
pub fn with_port(mut self, port: u16) -> Self {
|
||||||
self.core = self.core.with_port(port);
|
self.core.socks5.listening_port = port;
|
||||||
self
|
|
||||||
}
|
|
||||||
|
|
||||||
#[must_use]
|
|
||||||
pub fn with_ip(mut self, ip: IpAddr) -> Self {
|
|
||||||
self.core = self.core.with_ip(ip);
|
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,11 +1,11 @@
|
|||||||
// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
|
// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use crate::config::old_config_v1_1_30::ConfigV1_1_30;
|
|
||||||
use crate::{
|
use crate::{
|
||||||
config::{default_config_filepath, persistence::SocksClientPaths},
|
config::{default_config_filepath, persistence::SocksClientPaths, Config},
|
||||||
error::Socks5ClientError,
|
error::Socks5ClientError,
|
||||||
};
|
};
|
||||||
|
|
||||||
use nym_bin_common::logging::LoggingSettings;
|
use nym_bin_common::logging::LoggingSettings;
|
||||||
use nym_client_core::config::disk_persistence::old_v1_1_20_2::CommonClientPathsV1_1_20_2;
|
use nym_client_core::config::disk_persistence::old_v1_1_20_2::CommonClientPathsV1_1_20_2;
|
||||||
use nym_client_core::config::GatewayEndpointConfig;
|
use nym_client_core::config::GatewayEndpointConfig;
|
||||||
@@ -43,9 +43,9 @@ impl ConfigV1_1_20_2 {
|
|||||||
|
|
||||||
// in this upgrade, gateway endpoint configuration was moved out of the config file,
|
// in this upgrade, gateway endpoint configuration was moved out of the config file,
|
||||||
// so its returned to be stored elsewhere.
|
// so its returned to be stored elsewhere.
|
||||||
pub fn upgrade(self) -> Result<(ConfigV1_1_30, GatewayEndpointConfig), Socks5ClientError> {
|
pub fn upgrade(self) -> Result<(Config, GatewayEndpointConfig), Socks5ClientError> {
|
||||||
let gateway_details = self.core.base.client.gateway_endpoint.clone().into();
|
let gateway_details = self.core.base.client.gateway_endpoint.clone().into();
|
||||||
let config = ConfigV1_1_30 {
|
let config = Config {
|
||||||
core: self.core.into(),
|
core: self.core.into(),
|
||||||
storage_paths: SocksClientPaths {
|
storage_paths: SocksClientPaths {
|
||||||
common_paths: self.storage_paths.common_paths.upgrade_default()?,
|
common_paths: self.storage_paths.common_paths.upgrade_default()?,
|
||||||
|
|||||||
@@ -1,44 +0,0 @@
|
|||||||
// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
use crate::config::persistence::SocksClientPaths;
|
|
||||||
use crate::config::{default_config_filepath, Config};
|
|
||||||
use nym_bin_common::logging::LoggingSettings;
|
|
||||||
use nym_config::read_config_from_toml_file;
|
|
||||||
use nym_socks5_client_core::config::old_config_v1_1_30::ConfigV1_1_30 as CoreConfigV1_1_30;
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
use std::io;
|
|
||||||
use std::path::Path;
|
|
||||||
|
|
||||||
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
|
|
||||||
#[serde(deny_unknown_fields)]
|
|
||||||
pub struct ConfigV1_1_30 {
|
|
||||||
pub core: CoreConfigV1_1_30,
|
|
||||||
|
|
||||||
// I'm leaving a landmine here for when the paths actually do change the next time,
|
|
||||||
// but propagating the change right now (in ALL clients) would be such a hassle...,
|
|
||||||
// so sorry for the next person looking at it : )
|
|
||||||
pub storage_paths: SocksClientPaths,
|
|
||||||
|
|
||||||
pub logging: LoggingSettings,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<ConfigV1_1_30> for Config {
|
|
||||||
fn from(value: ConfigV1_1_30) -> Self {
|
|
||||||
Config {
|
|
||||||
core: value.core.into(),
|
|
||||||
storage_paths: value.storage_paths,
|
|
||||||
logging: LoggingSettings::default(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ConfigV1_1_30 {
|
|
||||||
pub fn read_from_toml_file<P: AsRef<Path>>(path: P) -> io::Result<Self> {
|
|
||||||
read_config_from_toml_file(path)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn read_from_default_path<P: AsRef<Path>>(id: P) -> io::Result<Self> {
|
|
||||||
Self::read_from_toml_file(default_config_filepath(id))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -75,9 +75,8 @@ gateway_details = '{{ storage_paths.gateway_details }}'
|
|||||||
# The mix address of the provider to which all requests are going to be sent.
|
# The mix address of the provider to which all requests are going to be sent.
|
||||||
provider_mix_address = '{{ core.socks5.provider_mix_address }}'
|
provider_mix_address = '{{ core.socks5.provider_mix_address }}'
|
||||||
|
|
||||||
# The address on which the client will be listening for incoming requests
|
# The port on which the client will be listening for incoming requests
|
||||||
# (default: 127.0.0.1:1080)
|
listening_port = {{ core.socks5.listening_port }}
|
||||||
bind_adddress = '{{ core.socks5.bind_adddress }}'
|
|
||||||
|
|
||||||
# Specifies whether this client is going to use an anonymous sender tag for communication with the service provider.
|
# Specifies whether this client is going to use an anonymous sender tag for communication with the service provider.
|
||||||
# While this is going to hide its actual address information, it will make the actual communication
|
# While this is going to hide its actual address information, it will make the actual communication
|
||||||
|
|||||||
@@ -21,10 +21,5 @@ async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||||||
}
|
}
|
||||||
setup_logging();
|
setup_logging();
|
||||||
|
|
||||||
if let Err(err) = commands::execute(args).await {
|
commands::execute(args).await
|
||||||
log::error!("{err}");
|
|
||||||
println!("An error occurred: {err}");
|
|
||||||
std::process::exit(1);
|
|
||||||
}
|
|
||||||
Ok(())
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
module.exports = {
|
|
||||||
ConfigHandler: require('./config/configHandler.ts'),
|
|
||||||
RestClient: require('./restClient/RestClient.ts')
|
|
||||||
};
|
|
||||||
@@ -2,7 +2,6 @@
|
|||||||
name = "async-file-watcher"
|
name = "async-file-watcher"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
license.workspace = true
|
|
||||||
|
|
||||||
# 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
|
||||||
|
|
||||||
|
|||||||
@@ -10,8 +10,6 @@ use std::path::{Path, PathBuf};
|
|||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
use tokio::time::Instant;
|
use tokio::time::Instant;
|
||||||
|
|
||||||
pub use notify::{Error as NotifyError, Result as NotifyResult};
|
|
||||||
|
|
||||||
pub type FileWatcherEventSender = mpsc::UnboundedSender<Event>;
|
pub type FileWatcherEventSender = mpsc::UnboundedSender<Event>;
|
||||||
pub type FileWatcherEventReceiver = mpsc::UnboundedReceiver<Event>;
|
pub type FileWatcherEventReceiver = mpsc::UnboundedReceiver<Event>;
|
||||||
|
|
||||||
@@ -24,7 +22,7 @@ pub struct AsyncFileWatcher {
|
|||||||
last_received: HashMap<EventKind, Instant>,
|
last_received: HashMap<EventKind, Instant>,
|
||||||
tick_duration: Duration,
|
tick_duration: Duration,
|
||||||
|
|
||||||
inner_rx: mpsc::UnboundedReceiver<NotifyResult<Event>>,
|
inner_rx: mpsc::UnboundedReceiver<notify::Result<Event>>,
|
||||||
event_sender: FileWatcherEventSender,
|
event_sender: FileWatcherEventSender,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -32,7 +30,7 @@ impl AsyncFileWatcher {
|
|||||||
pub fn new_file_changes_watcher<P: AsRef<Path>>(
|
pub fn new_file_changes_watcher<P: AsRef<Path>>(
|
||||||
path: P,
|
path: P,
|
||||||
event_sender: FileWatcherEventSender,
|
event_sender: FileWatcherEventSender,
|
||||||
) -> NotifyResult<Self> {
|
) -> notify::Result<Self> {
|
||||||
Self::new(
|
Self::new(
|
||||||
path,
|
path,
|
||||||
event_sender,
|
event_sender,
|
||||||
@@ -50,7 +48,7 @@ impl AsyncFileWatcher {
|
|||||||
event_sender: FileWatcherEventSender,
|
event_sender: FileWatcherEventSender,
|
||||||
filters: Option<Vec<EventKind>>,
|
filters: Option<Vec<EventKind>>,
|
||||||
tick_duration: Option<Duration>,
|
tick_duration: Option<Duration>,
|
||||||
) -> NotifyResult<Self> {
|
) -> notify::Result<Self> {
|
||||||
let watcher_config = Config::default();
|
let watcher_config = Config::default();
|
||||||
let (inner_tx, inner_rx) = mpsc::unbounded();
|
let (inner_tx, inner_rx) = mpsc::unbounded();
|
||||||
let watcher = RecommendedWatcher::new(
|
let watcher = RecommendedWatcher::new(
|
||||||
@@ -114,17 +112,17 @@ impl AsyncFileWatcher {
|
|||||||
false
|
false
|
||||||
}
|
}
|
||||||
|
|
||||||
fn start_watching(&mut self) -> NotifyResult<()> {
|
fn start_watching(&mut self) -> notify::Result<()> {
|
||||||
self.is_watching = true;
|
self.is_watching = true;
|
||||||
self.watcher.watch(&self.path, RecursiveMode::NonRecursive)
|
self.watcher.watch(&self.path, RecursiveMode::NonRecursive)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn stop_watching(&mut self) -> NotifyResult<()> {
|
fn stop_watching(&mut self) -> notify::Result<()> {
|
||||||
self.is_watching = false;
|
self.is_watching = false;
|
||||||
self.watcher.unwatch(&self.path)
|
self.watcher.unwatch(&self.path)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub async fn watch(&mut self) -> NotifyResult<()> {
|
pub async fn watch(&mut self) -> notify::Result<()> {
|
||||||
self.start_watching()?;
|
self.start_watching()?;
|
||||||
|
|
||||||
while let Some(event) = self.inner_rx.next().await {
|
while let Some(event) = self.inner_rx.next().await {
|
||||||
|
|||||||
@@ -2,7 +2,6 @@
|
|||||||
name = "nym-bandwidth-controller"
|
name = "nym-bandwidth-controller"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
license.workspace = true
|
|
||||||
|
|
||||||
# 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
|
||||||
|
|
||||||
@@ -11,7 +10,6 @@ bip39 = { workspace = true }
|
|||||||
rand = "0.7.3"
|
rand = "0.7.3"
|
||||||
thiserror = { workspace = true }
|
thiserror = { workspace = true }
|
||||||
url = { workspace = true }
|
url = { workspace = true }
|
||||||
zeroize = { workspace = true }
|
|
||||||
|
|
||||||
nym-coconut-interface = { path = "../coconut-interface" }
|
nym-coconut-interface = { path = "../coconut-interface" }
|
||||||
nym-credential-storage = { path = "../credential-storage" }
|
nym-credential-storage = { path = "../credential-storage" }
|
||||||
|
|||||||
@@ -2,9 +2,9 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use crate::error::BandwidthControllerError;
|
use crate::error::BandwidthControllerError;
|
||||||
use nym_coconut_interface::Base58;
|
use nym_coconut_interface::{Base58, Parameters};
|
||||||
use nym_credential_storage::storage::Storage;
|
use nym_credential_storage::storage::Storage;
|
||||||
use nym_credentials::coconut::bandwidth::BandwidthVoucher;
|
use nym_credentials::coconut::bandwidth::{BandwidthVoucher, TOTAL_ATTRIBUTES};
|
||||||
use nym_credentials::coconut::utils::obtain_aggregate_signature;
|
use nym_credentials::coconut::utils::obtain_aggregate_signature;
|
||||||
use nym_crypto::asymmetric::{encryption, identity};
|
use nym_crypto::asymmetric::{encryption, identity};
|
||||||
use nym_network_defaults::VOUCHER_INFO;
|
use nym_network_defaults::VOUCHER_INFO;
|
||||||
@@ -12,8 +12,10 @@ use nym_validator_client::coconut::all_coconut_api_clients;
|
|||||||
use nym_validator_client::nyxd::contract_traits::CoconutBandwidthSigningClient;
|
use nym_validator_client::nyxd::contract_traits::CoconutBandwidthSigningClient;
|
||||||
use nym_validator_client::nyxd::contract_traits::DkgQueryClient;
|
use nym_validator_client::nyxd::contract_traits::DkgQueryClient;
|
||||||
use nym_validator_client::nyxd::Coin;
|
use nym_validator_client::nyxd::Coin;
|
||||||
|
use nym_validator_client::nyxd::Hash;
|
||||||
use rand::rngs::OsRng;
|
use rand::rngs::OsRng;
|
||||||
use state::State;
|
use state::{KeyPair, State};
|
||||||
|
use std::str::FromStr;
|
||||||
|
|
||||||
pub mod state;
|
pub mod state;
|
||||||
|
|
||||||
@@ -22,29 +24,30 @@ where
|
|||||||
C: CoconutBandwidthSigningClient + Sync,
|
C: CoconutBandwidthSigningClient + Sync,
|
||||||
{
|
{
|
||||||
let mut rng = OsRng;
|
let mut rng = OsRng;
|
||||||
let signing_key = identity::PrivateKey::new(&mut rng);
|
let signing_keypair = KeyPair::from(identity::KeyPair::new(&mut rng));
|
||||||
let encryption_key = encryption::PrivateKey::new(&mut rng);
|
let encryption_keypair = KeyPair::from(encryption::KeyPair::new(&mut rng));
|
||||||
let params = BandwidthVoucher::default_parameters();
|
let params = Parameters::new(TOTAL_ATTRIBUTES).unwrap();
|
||||||
let voucher_value = amount.amount.to_string();
|
let voucher_value = amount.amount.to_string();
|
||||||
|
|
||||||
let tx_hash = client
|
let tx_hash = client
|
||||||
.deposit(
|
.deposit(
|
||||||
amount,
|
amount,
|
||||||
String::from(VOUCHER_INFO),
|
String::from(VOUCHER_INFO),
|
||||||
signing_key.public_key().to_base58_string(),
|
signing_keypair.public_key.clone(),
|
||||||
encryption_key.public_key().to_base58_string(),
|
encryption_keypair.public_key.clone(),
|
||||||
None,
|
None,
|
||||||
)
|
)
|
||||||
.await?
|
.await?
|
||||||
.transaction_hash;
|
.transaction_hash
|
||||||
|
.to_string();
|
||||||
|
|
||||||
let voucher = BandwidthVoucher::new(
|
let voucher = BandwidthVoucher::new(
|
||||||
¶ms,
|
¶ms,
|
||||||
voucher_value,
|
voucher_value,
|
||||||
VOUCHER_INFO.to_string(),
|
VOUCHER_INFO.to_string(),
|
||||||
tx_hash,
|
Hash::from_str(&tx_hash).map_err(|_| BandwidthControllerError::InvalidTxHash)?,
|
||||||
signing_key,
|
identity::PrivateKey::from_base58_string(&signing_keypair.private_key)?,
|
||||||
encryption_key,
|
encryption::PrivateKey::from_base58_string(&encryption_keypair.private_key)?,
|
||||||
);
|
);
|
||||||
|
|
||||||
let state = State { voucher, params };
|
let state = State { voucher, params };
|
||||||
|
|||||||
@@ -2,7 +2,32 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use nym_coconut_interface::Parameters;
|
use nym_coconut_interface::Parameters;
|
||||||
use nym_credentials::coconut::bandwidth::BandwidthVoucher;
|
use nym_credentials::coconut::bandwidth::{BandwidthVoucher, TOTAL_ATTRIBUTES};
|
||||||
|
|
||||||
|
use nym_crypto::asymmetric::{encryption, identity};
|
||||||
|
|
||||||
|
pub(crate) struct KeyPair {
|
||||||
|
pub public_key: String,
|
||||||
|
pub private_key: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<identity::KeyPair> for KeyPair {
|
||||||
|
fn from(kp: identity::KeyPair) -> Self {
|
||||||
|
Self {
|
||||||
|
public_key: kp.public_key().to_base58_string(),
|
||||||
|
private_key: kp.private_key().to_base58_string(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<encryption::KeyPair> for KeyPair {
|
||||||
|
fn from(kp: encryption::KeyPair) -> Self {
|
||||||
|
Self {
|
||||||
|
public_key: kp.public_key().to_base58_string(),
|
||||||
|
private_key: kp.private_key().to_base58_string(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub struct State {
|
pub struct State {
|
||||||
pub voucher: BandwidthVoucher,
|
pub voucher: BandwidthVoucher,
|
||||||
@@ -13,7 +38,7 @@ impl State {
|
|||||||
pub fn new(voucher: BandwidthVoucher) -> Self {
|
pub fn new(voucher: BandwidthVoucher) -> Self {
|
||||||
State {
|
State {
|
||||||
voucher,
|
voucher,
|
||||||
params: BandwidthVoucher::default_parameters(),
|
params: Parameters::new(TOTAL_ATTRIBUTES).unwrap(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ use nym_credential_storage::storage::Storage;
|
|||||||
use nym_validator_client::coconut::all_coconut_api_clients;
|
use nym_validator_client::coconut::all_coconut_api_clients;
|
||||||
use nym_validator_client::nyxd::contract_traits::DkgQueryClient;
|
use nym_validator_client::nyxd::contract_traits::DkgQueryClient;
|
||||||
use std::str::FromStr;
|
use std::str::FromStr;
|
||||||
use zeroize::Zeroizing;
|
|
||||||
use {
|
use {
|
||||||
nym_coconut_interface::Base58,
|
nym_coconut_interface::Base58,
|
||||||
nym_credentials::coconut::{
|
nym_credentials::coconut::{
|
||||||
@@ -47,12 +46,10 @@ impl<C, St: Storage> BandwidthController<C, St> {
|
|||||||
let voucher_value = u64::from_str(&bandwidth_credential.voucher_value)
|
let voucher_value = u64::from_str(&bandwidth_credential.voucher_value)
|
||||||
.map_err(|_| StorageError::InconsistentData)?;
|
.map_err(|_| StorageError::InconsistentData)?;
|
||||||
let voucher_info = bandwidth_credential.voucher_info.clone();
|
let voucher_info = bandwidth_credential.voucher_info.clone();
|
||||||
let serial_number = Zeroizing::new(nym_coconut_interface::Attribute::try_from_bs58(
|
let serial_number =
|
||||||
bandwidth_credential.serial_number,
|
nym_coconut_interface::Attribute::try_from_bs58(bandwidth_credential.serial_number)?;
|
||||||
)?);
|
let binding_number =
|
||||||
let binding_number = Zeroizing::new(nym_coconut_interface::Attribute::try_from_bs58(
|
nym_coconut_interface::Attribute::try_from_bs58(bandwidth_credential.binding_number)?;
|
||||||
bandwidth_credential.binding_number,
|
|
||||||
)?);
|
|
||||||
let signature =
|
let signature =
|
||||||
nym_coconut_interface::Signature::try_from_bs58(bandwidth_credential.signature)?;
|
nym_coconut_interface::Signature::try_from_bs58(bandwidth_credential.signature)?;
|
||||||
let epoch_id = u64::from_str(&bandwidth_credential.epoch_id)
|
let epoch_id = u64::from_str(&bandwidth_credential.epoch_id)
|
||||||
@@ -67,8 +64,8 @@ impl<C, St: Storage> BandwidthController<C, St> {
|
|||||||
prepare_for_spending(
|
prepare_for_spending(
|
||||||
voucher_value,
|
voucher_value,
|
||||||
voucher_info,
|
voucher_info,
|
||||||
&serial_number,
|
serial_number,
|
||||||
&binding_number,
|
binding_number,
|
||||||
epoch_id,
|
epoch_id,
|
||||||
&signature,
|
&signature,
|
||||||
&verification_key,
|
&verification_key,
|
||||||
|
|||||||
@@ -9,8 +9,7 @@ repository = { workspace = true }
|
|||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
atty = "0.2"
|
atty = "0.2"
|
||||||
const-str = "0.5.6"
|
clap = { version = "4.0", features = ["derive"] }
|
||||||
clap = { workspace = true, features = ["derive"] }
|
|
||||||
clap_complete = "4.0"
|
clap_complete = "4.0"
|
||||||
clap_complete_fig = "4.0"
|
clap_complete_fig = "4.0"
|
||||||
log = { workspace = true }
|
log = { workspace = true }
|
||||||
@@ -36,10 +35,9 @@ opentelemetry = { version = "0.19.0", optional = true, features = ["rt-tokio"] }
|
|||||||
|
|
||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
vergen = { version = "=8.2.6", default-features = false, features = [
|
vergen = { version = "=7.4.3", default-features = false, features = [
|
||||||
"build",
|
"build",
|
||||||
"git",
|
"git",
|
||||||
"gitcl",
|
|
||||||
"rustc",
|
"rustc",
|
||||||
"cargo",
|
"cargo",
|
||||||
] }
|
] }
|
||||||
@@ -49,9 +47,8 @@ default = []
|
|||||||
openapi = ["utoipa"]
|
openapi = ["utoipa"]
|
||||||
output_format = ["serde_json"]
|
output_format = ["serde_json"]
|
||||||
bin_info_schema = ["schemars"]
|
bin_info_schema = ["schemars"]
|
||||||
basic_tracing = ["tracing-subscriber"]
|
|
||||||
tracing = [
|
tracing = [
|
||||||
"basic_tracing",
|
"tracing-subscriber",
|
||||||
"tracing-tree",
|
"tracing-tree",
|
||||||
"opentelemetry-jaeger",
|
"opentelemetry-jaeger",
|
||||||
"tracing-opentelemetry",
|
"tracing-opentelemetry",
|
||||||
|
|||||||
@@ -1,14 +1,13 @@
|
|||||||
// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
|
// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use vergen::EmitBuilder;
|
use vergen::{vergen, Config};
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
EmitBuilder::builder()
|
let mut config = Config::default();
|
||||||
.all_build()
|
if std::env::var("DOCS_RS").is_ok() {
|
||||||
.all_git()
|
// If we don't have access to git information, such as in a docs.rs build, don't error
|
||||||
.all_rustc()
|
*config.git_mut().skip_if_error_mut() = true;
|
||||||
.all_cargo()
|
}
|
||||||
.emit()
|
vergen(config).expect("failed to extract build metadata");
|
||||||
.expect("failed to extract build metadata");
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -40,22 +40,14 @@ pub struct BinaryBuildInformation {
|
|||||||
/// Provides the rustc channel that was used for the build, for example `nightly`.
|
/// Provides the rustc channel that was used for the build, for example `nightly`.
|
||||||
pub rustc_channel: &'static str,
|
pub rustc_channel: &'static str,
|
||||||
|
|
||||||
// VERGEN_CARGO_DEBUG
|
// VERGEN_CARGO_PROFILE
|
||||||
/// Provides the cargo debug mode that was used for the build.
|
/// Provides the cargo profile that was used for the build, for example `debug`.
|
||||||
// NOTE: keep the old name cargo_profile instead of cargo_debug for backwards compatibility
|
|
||||||
pub cargo_profile: &'static str,
|
pub cargo_profile: &'static str,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl BinaryBuildInformation {
|
impl BinaryBuildInformation {
|
||||||
// explicitly require the build_version to be passed as it's binary specific
|
// explicitly require the build_version to be passed as it's binary specific
|
||||||
pub const fn new(binary_name: &'static str, build_version: &'static str) -> Self {
|
pub const fn new(binary_name: &'static str, build_version: &'static str) -> Self {
|
||||||
let cargo_debug = env!("VERGEN_CARGO_DEBUG");
|
|
||||||
let cargo_profile = if const_str::equal!(cargo_debug, "true") {
|
|
||||||
"debug"
|
|
||||||
} else {
|
|
||||||
"release"
|
|
||||||
};
|
|
||||||
|
|
||||||
BinaryBuildInformation {
|
BinaryBuildInformation {
|
||||||
binary_name,
|
binary_name,
|
||||||
build_timestamp: env!("VERGEN_BUILD_TIMESTAMP"),
|
build_timestamp: env!("VERGEN_BUILD_TIMESTAMP"),
|
||||||
@@ -65,7 +57,7 @@ impl BinaryBuildInformation {
|
|||||||
commit_branch: env!("VERGEN_GIT_BRANCH"),
|
commit_branch: env!("VERGEN_GIT_BRANCH"),
|
||||||
rustc_version: env!("VERGEN_RUSTC_SEMVER"),
|
rustc_version: env!("VERGEN_RUSTC_SEMVER"),
|
||||||
rustc_channel: env!("VERGEN_RUSTC_CHANNEL"),
|
rustc_channel: env!("VERGEN_RUSTC_CHANNEL"),
|
||||||
cargo_profile,
|
cargo_profile: env!("VERGEN_CARGO_PROFILE"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -88,7 +80,7 @@ impl BinaryBuildInformation {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
|
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||||
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
|
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
|
||||||
#[cfg_attr(feature = "bin_info_schema", derive(schemars::JsonSchema))]
|
#[cfg_attr(feature = "bin_info_schema", derive(schemars::JsonSchema))]
|
||||||
pub struct BinaryBuildInformationOwned {
|
pub struct BinaryBuildInformationOwned {
|
||||||
@@ -123,9 +115,8 @@ pub struct BinaryBuildInformationOwned {
|
|||||||
/// Provides the rustc channel that was used for the build, for example `nightly`.
|
/// Provides the rustc channel that was used for the build, for example `nightly`.
|
||||||
pub rustc_channel: String,
|
pub rustc_channel: String,
|
||||||
|
|
||||||
// VERGEN_CARGO_DEBUG
|
// VERGEN_CARGO_PROFILE
|
||||||
/// Provides the cargo debug mode that was used for the build.
|
/// Provides the cargo profile that was used for the build, for example `debug`.
|
||||||
// NOTE: keep the old name cargo_profile instead of cargo_debug for backwards compatibility
|
|
||||||
pub cargo_profile: String,
|
pub cargo_profile: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -43,30 +43,6 @@ pub fn setup_logging() {
|
|||||||
.init();
|
.init();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "basic_tracing")]
|
|
||||||
pub fn setup_tracing_logger() {
|
|
||||||
let log_builder = tracing_subscriber::fmt()
|
|
||||||
// Use a more compact, abbreviated log format
|
|
||||||
.compact()
|
|
||||||
// Display source code file paths
|
|
||||||
.with_file(true)
|
|
||||||
// Display source code line numbers
|
|
||||||
.with_line_number(true)
|
|
||||||
// Don't display the event's target (module path)
|
|
||||||
.with_target(false);
|
|
||||||
|
|
||||||
if ::std::env::var("RUST_LOG").is_ok() {
|
|
||||||
log_builder
|
|
||||||
.with_env_filter(tracing_subscriber::filter::EnvFilter::from_default_env())
|
|
||||||
.init()
|
|
||||||
} else {
|
|
||||||
// default to 'Info
|
|
||||||
log_builder
|
|
||||||
.with_max_level(tracing_subscriber::filter::LevelFilter::INFO)
|
|
||||||
.init()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO: This has to be a macro, running it as a function does not work for the file_appender for some reason
|
// TODO: This has to be a macro, running it as a function does not work for the file_appender for some reason
|
||||||
#[cfg(feature = "tracing")]
|
#[cfg(feature = "tracing")]
|
||||||
#[macro_export]
|
#[macro_export]
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ version = "1.1.15"
|
|||||||
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"
|
||||||
license.workspace = true
|
|
||||||
|
|
||||||
# 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
|
||||||
|
|
||||||
@@ -12,7 +11,6 @@ license.workspace = true
|
|||||||
async-trait = { workspace = true }
|
async-trait = { workspace = true }
|
||||||
base64 = "0.21.2"
|
base64 = "0.21.2"
|
||||||
cfg-if = "1.0.0"
|
cfg-if = "1.0.0"
|
||||||
clap = { workspace = true, optional = true }
|
|
||||||
dashmap = { workspace = true }
|
dashmap = { workspace = true }
|
||||||
dirs = "4.0"
|
dirs = "4.0"
|
||||||
futures = { workspace = true }
|
futures = { workspace = true }
|
||||||
@@ -46,7 +44,6 @@ nym-validator-client = { path = "../client-libs/validator-client", default-featu
|
|||||||
nym-task = { path = "../task" }
|
nym-task = { path = "../task" }
|
||||||
nym-credential-storage = { path = "../credential-storage" }
|
nym-credential-storage = { path = "../credential-storage" }
|
||||||
nym-network-defaults = { path = "../network-defaults" }
|
nym-network-defaults = { path = "../network-defaults" }
|
||||||
si-scale = "0.2.2"
|
|
||||||
|
|
||||||
[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"
|
||||||
@@ -60,7 +57,7 @@ features = ["time"]
|
|||||||
version = "0.20.1"
|
version = "0.20.1"
|
||||||
|
|
||||||
[target."cfg(not(target_arch = \"wasm32\"))".dependencies.sqlx]
|
[target."cfg(not(target_arch = \"wasm32\"))".dependencies.sqlx]
|
||||||
workspace = true
|
version = "0.6.2"
|
||||||
features = ["runtime-tokio-rustls", "sqlite", "macros", "migrate"]
|
features = ["runtime-tokio-rustls", "sqlite", "macros", "migrate"]
|
||||||
optional = true
|
optional = true
|
||||||
|
|
||||||
@@ -91,11 +88,10 @@ tempfile = "3.1.0"
|
|||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
tokio = { workspace = true, features = ["rt-multi-thread", "macros"] }
|
tokio = { workspace = true, features = ["rt-multi-thread", "macros"] }
|
||||||
sqlx = { workspace = true, features = ["runtime-tokio-rustls", "sqlite", "macros", "migrate"] }
|
sqlx = { version = "0.6.2", features = ["runtime-tokio-rustls", "sqlite", "macros", "migrate"] }
|
||||||
|
|
||||||
[features]
|
[features]
|
||||||
default = []
|
default = []
|
||||||
cli = ["clap"]
|
|
||||||
fs-surb-storage = ["sqlx"]
|
fs-surb-storage = ["sqlx"]
|
||||||
wasm = ["nym-gateway-client/wasm"]
|
wasm = ["nym-gateway-client/wasm"]
|
||||||
|
|
||||||
|
|||||||
@@ -1,227 +0,0 @@
|
|||||||
// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
use crate::config::disk_persistence::CommonClientPaths;
|
|
||||||
use crate::error::ClientCoreError;
|
|
||||||
use crate::{
|
|
||||||
client::{
|
|
||||||
base_client::storage::gateway_details::OnDiskGatewayDetails,
|
|
||||||
key_manager::persistence::OnDiskKeys,
|
|
||||||
},
|
|
||||||
init::types::{GatewayDetails, GatewaySelectionSpecification, GatewaySetup, InitResults},
|
|
||||||
};
|
|
||||||
use log::info;
|
|
||||||
use nym_crypto::asymmetric::identity;
|
|
||||||
use nym_topology::NymTopology;
|
|
||||||
use std::path::{Path, PathBuf};
|
|
||||||
|
|
||||||
pub trait InitialisableClient {
|
|
||||||
const NAME: &'static str;
|
|
||||||
type Error: From<ClientCoreError>;
|
|
||||||
type InitArgs: AsRef<CommonClientInitArgs>;
|
|
||||||
type Config: ClientConfig;
|
|
||||||
|
|
||||||
fn try_upgrade_outdated_config(id: &str) -> Result<(), Self::Error>;
|
|
||||||
|
|
||||||
fn initialise_storage_paths(id: &str) -> Result<(), Self::Error>;
|
|
||||||
|
|
||||||
fn default_config_path(id: &str) -> PathBuf;
|
|
||||||
|
|
||||||
fn construct_config(init_args: &Self::InitArgs) -> Self::Config;
|
|
||||||
}
|
|
||||||
|
|
||||||
pub trait ClientConfig {
|
|
||||||
fn common_paths(&self) -> &CommonClientPaths;
|
|
||||||
|
|
||||||
fn core_config(&self) -> &crate::config::Config;
|
|
||||||
|
|
||||||
fn default_store_location(&self) -> PathBuf;
|
|
||||||
|
|
||||||
fn save_to<P: AsRef<Path>>(&self, path: P) -> std::io::Result<()>;
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg_attr(feature = "cli", derive(clap::Args))]
|
|
||||||
#[derive(Debug, Clone)]
|
|
||||||
pub struct CommonClientInitArgs {
|
|
||||||
/// Id of client we want to create config for.
|
|
||||||
#[cfg_attr(feature = "cli", clap(long))]
|
|
||||||
pub id: String,
|
|
||||||
|
|
||||||
/// Id of the gateway we are going to connect to.
|
|
||||||
#[cfg_attr(feature = "cli", clap(long))]
|
|
||||||
pub gateway: Option<identity::PublicKey>,
|
|
||||||
|
|
||||||
/// Specifies whether the new gateway should be determined based by latency as opposed to being chosen
|
|
||||||
/// uniformly.
|
|
||||||
#[cfg_attr(feature = "cli", clap(long, conflicts_with = "gateway"))]
|
|
||||||
pub latency_based_selection: bool,
|
|
||||||
|
|
||||||
/// Force register gateway. WARNING: this will overwrite any existing keys for the given id,
|
|
||||||
/// potentially causing loss of access.
|
|
||||||
#[cfg_attr(feature = "cli", clap(long))]
|
|
||||||
pub force_register_gateway: bool,
|
|
||||||
|
|
||||||
/// Comma separated list of rest endpoints of the nyxd validators
|
|
||||||
#[cfg_attr(
|
|
||||||
feature = "cli",
|
|
||||||
clap(long, alias = "nyxd_validators", value_delimiter = ',', hide = true)
|
|
||||||
)]
|
|
||||||
pub nyxd_urls: Option<Vec<url::Url>>,
|
|
||||||
|
|
||||||
/// Comma separated list of rest endpoints of the API validators
|
|
||||||
#[cfg_attr(
|
|
||||||
feature = "cli",
|
|
||||||
clap(
|
|
||||||
long,
|
|
||||||
alias = "api_validators",
|
|
||||||
value_delimiter = ',',
|
|
||||||
group = "network"
|
|
||||||
)
|
|
||||||
)]
|
|
||||||
pub nym_apis: Option<Vec<url::Url>>,
|
|
||||||
|
|
||||||
/// Path to .json file containing custom network specification.
|
|
||||||
#[cfg_attr(feature = "cli", clap(long, group = "network", hide = true))]
|
|
||||||
pub custom_mixnet: Option<PathBuf>,
|
|
||||||
|
|
||||||
/// Set this client to work in a enabled credentials mode that would attempt to use gateway
|
|
||||||
/// with bandwidth credential requirement.
|
|
||||||
#[cfg_attr(feature = "cli", clap(long, hide = true))]
|
|
||||||
pub enabled_credentials_mode: Option<bool>,
|
|
||||||
|
|
||||||
/// Mostly debug-related option to increase default traffic rate so that you would not need to
|
|
||||||
/// modify config post init
|
|
||||||
#[cfg_attr(feature = "cli", clap(long, hide = true))]
|
|
||||||
pub fastmode: bool,
|
|
||||||
|
|
||||||
/// Disable loop cover traffic and the Poisson rate limiter (for debugging only)
|
|
||||||
#[cfg_attr(feature = "cli", clap(long, hide = true))]
|
|
||||||
pub no_cover: bool,
|
|
||||||
}
|
|
||||||
|
|
||||||
pub struct InitResultsWithConfig<T> {
|
|
||||||
pub config: T,
|
|
||||||
pub init_results: InitResults,
|
|
||||||
}
|
|
||||||
|
|
||||||
pub async fn initialise_client<C>(
|
|
||||||
init_args: C::InitArgs,
|
|
||||||
) -> Result<InitResultsWithConfig<C::Config>, C::Error>
|
|
||||||
where
|
|
||||||
C: InitialisableClient,
|
|
||||||
<C as InitialisableClient>::Config: std::fmt::Debug,
|
|
||||||
<C as InitialisableClient>::InitArgs: std::fmt::Debug,
|
|
||||||
{
|
|
||||||
info!("initialising {} client", C::NAME);
|
|
||||||
|
|
||||||
let common_args = init_args.as_ref();
|
|
||||||
let id = &common_args.id;
|
|
||||||
|
|
||||||
let already_init = if C::default_config_path(id).exists() {
|
|
||||||
// in case we're using old config, try to upgrade it
|
|
||||||
// (if we're using the current version, it's a no-op)
|
|
||||||
C::try_upgrade_outdated_config(id)?;
|
|
||||||
eprintln!("{} client \"{id}\" was already initialised before", C::NAME);
|
|
||||||
true
|
|
||||||
} else {
|
|
||||||
C::initialise_storage_paths(id)?;
|
|
||||||
false
|
|
||||||
};
|
|
||||||
|
|
||||||
// Usually you only register with the gateway on the first init, however you can force
|
|
||||||
// re-registering if wanted.
|
|
||||||
let user_wants_force_register = common_args.force_register_gateway;
|
|
||||||
if user_wants_force_register {
|
|
||||||
eprintln!("Instructed to force registering gateway. This might overwrite keys!");
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the client was already initialized, don't generate new keys and don't re-register with
|
|
||||||
// the gateway (because this would create a new shared key).
|
|
||||||
// Unless the user really wants to.
|
|
||||||
let register_gateway = !already_init || user_wants_force_register;
|
|
||||||
|
|
||||||
// Attempt to use a user-provided gateway, if possible
|
|
||||||
let user_chosen_gateway_id = common_args.gateway;
|
|
||||||
log::debug!("User chosen gateway id: {user_chosen_gateway_id:?}");
|
|
||||||
|
|
||||||
let selection_spec = GatewaySelectionSpecification::new(
|
|
||||||
user_chosen_gateway_id.map(|id| id.to_base58_string()),
|
|
||||||
Some(common_args.latency_based_selection),
|
|
||||||
false,
|
|
||||||
);
|
|
||||||
log::debug!("Gateway selection specification: {selection_spec:?}");
|
|
||||||
|
|
||||||
// Load and potentially override config
|
|
||||||
log::debug!("Init arguments: {init_args:#?}");
|
|
||||||
let config = C::construct_config(&init_args);
|
|
||||||
log::debug!("Constructed config: {config:#?}");
|
|
||||||
let paths = config.common_paths();
|
|
||||||
let core = config.core_config();
|
|
||||||
|
|
||||||
log::info!(
|
|
||||||
"Using nym-api: {}",
|
|
||||||
core.client
|
|
||||||
.nym_api_urls
|
|
||||||
.iter()
|
|
||||||
.map(|url| url.as_str())
|
|
||||||
.collect::<Vec<&str>>()
|
|
||||||
.join(",")
|
|
||||||
);
|
|
||||||
|
|
||||||
// Setup gateway by either registering a new one, or creating a new config from the selected
|
|
||||||
// one but with keys kept, or reusing the gateway configuration.
|
|
||||||
let key_store = OnDiskKeys::new(paths.keys.clone());
|
|
||||||
let details_store = OnDiskGatewayDetails::new(&paths.gateway_details);
|
|
||||||
|
|
||||||
let available_gateways = if let Some(custom_mixnet) = common_args.custom_mixnet.as_ref() {
|
|
||||||
let hardcoded_topology = NymTopology::new_from_file(custom_mixnet).map_err(|source| {
|
|
||||||
ClientCoreError::CustomTopologyLoadFailure {
|
|
||||||
file_path: custom_mixnet.clone(),
|
|
||||||
source,
|
|
||||||
}
|
|
||||||
})?;
|
|
||||||
hardcoded_topology.get_gateways()
|
|
||||||
} else {
|
|
||||||
let mut rng = rand::thread_rng();
|
|
||||||
crate::init::helpers::current_gateways(&mut rng, &core.client.nym_api_urls).await?
|
|
||||||
};
|
|
||||||
|
|
||||||
let gateway_setup = GatewaySetup::New {
|
|
||||||
specification: selection_spec,
|
|
||||||
available_gateways,
|
|
||||||
overwrite_data: register_gateway,
|
|
||||||
};
|
|
||||||
|
|
||||||
let init_details =
|
|
||||||
crate::init::setup_gateway(gateway_setup, &key_store, &details_store).await?;
|
|
||||||
|
|
||||||
// TODO: ask the service provider we specified for its interface version and set it in the config
|
|
||||||
|
|
||||||
let config_save_location = config.default_store_location();
|
|
||||||
if let Err(err) = config.save_to(&config_save_location) {
|
|
||||||
return Err(ClientCoreError::ConfigSaveFailure {
|
|
||||||
typ: C::NAME.to_string(),
|
|
||||||
id: id.to_string(),
|
|
||||||
path: config_save_location,
|
|
||||||
source: err,
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
|
|
||||||
eprintln!(
|
|
||||||
"Saved configuration file to {}",
|
|
||||||
config_save_location.display()
|
|
||||||
);
|
|
||||||
|
|
||||||
let address = init_details.client_address()?;
|
|
||||||
|
|
||||||
let GatewayDetails::Configured(gateway_details) = init_details.gateway_details else {
|
|
||||||
return Err(ClientCoreError::UnexpectedPersistedCustomGatewayDetails)?;
|
|
||||||
};
|
|
||||||
let init_results = InitResults::new(config.core_config(), address, &gateway_details);
|
|
||||||
|
|
||||||
Ok(InitResultsWithConfig {
|
|
||||||
config,
|
|
||||||
init_results,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -1,59 +0,0 @@
|
|||||||
// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
use nym_crypto::asymmetric::identity;
|
|
||||||
use std::path::PathBuf;
|
|
||||||
|
|
||||||
#[cfg_attr(feature = "cli", derive(clap::Args))]
|
|
||||||
#[derive(Debug, Clone)]
|
|
||||||
pub struct CommonClientRunArgs {
|
|
||||||
/// Id of client we want to create config for.
|
|
||||||
#[cfg_attr(feature = "cli", clap(long))]
|
|
||||||
pub id: String,
|
|
||||||
|
|
||||||
/// Id of the gateway we want to connect to. If overridden, it is user's responsibility to
|
|
||||||
/// ensure prior registration happened
|
|
||||||
#[cfg_attr(feature = "cli", clap(long))]
|
|
||||||
pub gateway: Option<identity::PublicKey>,
|
|
||||||
|
|
||||||
/// Comma separated list of rest endpoints of the nyxd validators
|
|
||||||
#[cfg_attr(
|
|
||||||
feature = "cli",
|
|
||||||
clap(long, alias = "nyxd_validators", value_delimiter = ',', hide = true)
|
|
||||||
)]
|
|
||||||
pub nyxd_urls: Option<Vec<url::Url>>,
|
|
||||||
|
|
||||||
/// Comma separated list of rest endpoints of the API validators
|
|
||||||
#[cfg_attr(
|
|
||||||
feature = "cli",
|
|
||||||
clap(
|
|
||||||
long,
|
|
||||||
alias = "api_validators",
|
|
||||||
value_delimiter = ',',
|
|
||||||
group = "network"
|
|
||||||
)
|
|
||||||
)]
|
|
||||||
pub nym_apis: Option<Vec<url::Url>>,
|
|
||||||
|
|
||||||
/// Path to .json file containing custom network specification.
|
|
||||||
#[cfg_attr(feature = "cli", clap(long, group = "network", hide = true))]
|
|
||||||
pub custom_mixnet: Option<PathBuf>,
|
|
||||||
|
|
||||||
/// Set this client to work in a enabled credentials mode that would attempt to use gateway
|
|
||||||
/// with bandwidth credential requirement.
|
|
||||||
#[cfg_attr(feature = "cli", clap(long, hide = true))]
|
|
||||||
pub enabled_credentials_mode: Option<bool>,
|
|
||||||
|
|
||||||
/// Mostly debug-related option to increase default traffic rate so that you would not need to
|
|
||||||
/// modify config post init
|
|
||||||
// note: we removed the 'conflicts_with = medium_toggle', but that's fine since NR
|
|
||||||
// has defined the conflict on that field itself
|
|
||||||
#[cfg_attr(feature = "cli", clap(long, hide = true))]
|
|
||||||
pub fastmode: bool,
|
|
||||||
|
|
||||||
/// Disable loop cover traffic and the Poisson rate limiter (for debugging only)
|
|
||||||
// note: we removed the 'conflicts_with = medium_toggle', but that's fine since NR
|
|
||||||
// has defined the conflict on that field itself
|
|
||||||
#[cfg_attr(feature = "cli", clap(long, hide = true))]
|
|
||||||
pub no_cover: bool,
|
|
||||||
}
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
// Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
|
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
|
||||||
|
|
||||||
pub mod client_init;
|
|
||||||
pub mod client_run;
|
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
// Copyright 2022-2023 - Nym Technologies SA <contact@nymtech.net>
|
// Copyright 2022-2023 - Nym Technologies SA <contact@nymtech.net>
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use super::packet_statistics_control::PacketStatisticsReporter;
|
|
||||||
use super::received_buffer::ReceivedBufferMessage;
|
use super::received_buffer::ReceivedBufferMessage;
|
||||||
use super::topology_control::geo_aware_provider::GeoAwareTopologyProvider;
|
use super::topology_control::geo_aware_provider::GeoAwareTopologyProvider;
|
||||||
use crate::client::base_client::storage::gateway_details::GatewayDetailsStore;
|
use crate::client::base_client::storage::gateway_details::GatewayDetailsStore;
|
||||||
@@ -11,7 +10,6 @@ use crate::client::inbound_messages::{InputMessage, InputMessageReceiver, InputM
|
|||||||
use crate::client::key_manager::persistence::KeyStore;
|
use crate::client::key_manager::persistence::KeyStore;
|
||||||
use crate::client::mix_traffic::transceiver::{GatewayReceiver, GatewayTransceiver, RemoteGateway};
|
use crate::client::mix_traffic::transceiver::{GatewayReceiver, GatewayTransceiver, RemoteGateway};
|
||||||
use crate::client::mix_traffic::{BatchMixMessageSender, MixTrafficController};
|
use crate::client::mix_traffic::{BatchMixMessageSender, MixTrafficController};
|
||||||
use crate::client::packet_statistics_control::PacketStatisticsControl;
|
|
||||||
use crate::client::real_messages_control;
|
use crate::client::real_messages_control;
|
||||||
use crate::client::real_messages_control::RealMessagesController;
|
use crate::client::real_messages_control::RealMessagesController;
|
||||||
use crate::client::received_buffer::{
|
use crate::client::received_buffer::{
|
||||||
@@ -52,7 +50,6 @@ use nym_topology::provider_trait::TopologyProvider;
|
|||||||
use nym_topology::HardcodedTopologyProvider;
|
use nym_topology::HardcodedTopologyProvider;
|
||||||
use nym_validator_client::nyxd::contract_traits::DkgQueryClient;
|
use nym_validator_client::nyxd::contract_traits::DkgQueryClient;
|
||||||
use std::fmt::Debug;
|
use std::fmt::Debug;
|
||||||
use std::os::fd::RawFd;
|
|
||||||
use std::path::Path;
|
use std::path::Path;
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
use url::Url;
|
use url::Url;
|
||||||
@@ -257,7 +254,6 @@ where
|
|||||||
self_address: Recipient,
|
self_address: Recipient,
|
||||||
topology_accessor: TopologyAccessor,
|
topology_accessor: TopologyAccessor,
|
||||||
mix_tx: BatchMixMessageSender,
|
mix_tx: BatchMixMessageSender,
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
shutdown: TaskClient,
|
shutdown: TaskClient,
|
||||||
) {
|
) {
|
||||||
info!("Starting loop cover traffic stream...");
|
info!("Starting loop cover traffic stream...");
|
||||||
@@ -270,7 +266,6 @@ where
|
|||||||
topology_accessor,
|
topology_accessor,
|
||||||
debug_config.traffic,
|
debug_config.traffic,
|
||||||
debug_config.cover_traffic,
|
debug_config.cover_traffic,
|
||||||
stats_tx,
|
|
||||||
);
|
);
|
||||||
|
|
||||||
stream.start_with_shutdown(shutdown);
|
stream.start_with_shutdown(shutdown);
|
||||||
@@ -290,7 +285,6 @@ where
|
|||||||
client_connection_rx: ConnectionCommandReceiver,
|
client_connection_rx: ConnectionCommandReceiver,
|
||||||
shutdown: TaskClient,
|
shutdown: TaskClient,
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
) {
|
) {
|
||||||
info!("Starting real traffic stream...");
|
info!("Starting real traffic stream...");
|
||||||
|
|
||||||
@@ -305,7 +299,6 @@ where
|
|||||||
reply_controller_receiver,
|
reply_controller_receiver,
|
||||||
lane_queue_lengths,
|
lane_queue_lengths,
|
||||||
client_connection_rx,
|
client_connection_rx,
|
||||||
stats_tx,
|
|
||||||
)
|
)
|
||||||
.start_with_shutdown(shutdown, packet_type);
|
.start_with_shutdown(shutdown, packet_type);
|
||||||
}
|
}
|
||||||
@@ -319,7 +312,6 @@ where
|
|||||||
reply_key_storage: SentReplyKeys,
|
reply_key_storage: SentReplyKeys,
|
||||||
reply_controller_sender: ReplyControllerSender,
|
reply_controller_sender: ReplyControllerSender,
|
||||||
shutdown: TaskClient,
|
shutdown: TaskClient,
|
||||||
packet_statistics_control: PacketStatisticsReporter,
|
|
||||||
) {
|
) {
|
||||||
info!("Starting received messages buffer controller...");
|
info!("Starting received messages buffer controller...");
|
||||||
let controller: ReceivedMessagesBufferController<SphinxMessageReceiver> =
|
let controller: ReceivedMessagesBufferController<SphinxMessageReceiver> =
|
||||||
@@ -329,7 +321,6 @@ where
|
|||||||
mixnet_receiver,
|
mixnet_receiver,
|
||||||
reply_key_storage,
|
reply_key_storage,
|
||||||
reply_controller_sender,
|
reply_controller_sender,
|
||||||
packet_statistics_control,
|
|
||||||
);
|
);
|
||||||
controller.start_with_shutdown(shutdown)
|
controller.start_with_shutdown(shutdown)
|
||||||
}
|
}
|
||||||
@@ -515,13 +506,6 @@ where
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn start_packet_statistics_control(shutdown: TaskClient) -> PacketStatisticsReporter {
|
|
||||||
info!("Starting packet statistics control...");
|
|
||||||
let (packet_statistics_control, packet_stats_reporter) = PacketStatisticsControl::new();
|
|
||||||
packet_statistics_control.start_with_shutdown(shutdown);
|
|
||||||
packet_stats_reporter
|
|
||||||
}
|
|
||||||
|
|
||||||
fn start_mix_traffic_controller(
|
fn start_mix_traffic_controller(
|
||||||
gateway_transceiver: Box<dyn GatewayTransceiver + Send>,
|
gateway_transceiver: Box<dyn GatewayTransceiver + Send>,
|
||||||
shutdown: TaskClient,
|
shutdown: TaskClient,
|
||||||
@@ -649,9 +633,6 @@ where
|
|||||||
)
|
)
|
||||||
.await?;
|
.await?;
|
||||||
|
|
||||||
let packet_stats_reporter =
|
|
||||||
Self::start_packet_statistics_control(shutdown.fork("packet_statistics_control"));
|
|
||||||
|
|
||||||
let gateway_packet_router = PacketRouter::new(
|
let gateway_packet_router = PacketRouter::new(
|
||||||
ack_sender,
|
ack_sender,
|
||||||
mixnet_messages_sender,
|
mixnet_messages_sender,
|
||||||
@@ -681,10 +662,8 @@ where
|
|||||||
reply_storage.key_storage(),
|
reply_storage.key_storage(),
|
||||||
reply_controller_sender.clone(),
|
reply_controller_sender.clone(),
|
||||||
shutdown.fork("received_messages_buffer"),
|
shutdown.fork("received_messages_buffer"),
|
||||||
packet_stats_reporter.clone(),
|
|
||||||
);
|
);
|
||||||
|
|
||||||
let gateway_fd = gateway_transceiver.ws_fd();
|
|
||||||
// The message_sender is the transmitter for any component generating sphinx packets
|
// The message_sender is the transmitter for any component generating sphinx packets
|
||||||
// that are to be sent to the mixnet. They are used by cover traffic stream and real
|
// that are to be sent to the mixnet. They are used by cover traffic stream and real
|
||||||
// traffic stream.
|
// traffic stream.
|
||||||
@@ -721,7 +700,6 @@ where
|
|||||||
client_connection_rx,
|
client_connection_rx,
|
||||||
shutdown.fork("real_traffic_controller"),
|
shutdown.fork("real_traffic_controller"),
|
||||||
self.config.debug.traffic.packet_type,
|
self.config.debug.traffic.packet_type,
|
||||||
packet_stats_reporter.clone(),
|
|
||||||
);
|
);
|
||||||
|
|
||||||
if !self
|
if !self
|
||||||
@@ -736,7 +714,6 @@ where
|
|||||||
self_address,
|
self_address,
|
||||||
shared_topology_accessor.clone(),
|
shared_topology_accessor.clone(),
|
||||||
message_sender,
|
message_sender,
|
||||||
packet_stats_reporter,
|
|
||||||
shutdown.fork("cover_traffic_stream"),
|
shutdown.fork("cover_traffic_stream"),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -757,7 +734,6 @@ where
|
|||||||
received_buffer_request_sender,
|
received_buffer_request_sender,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
gateway_fd,
|
|
||||||
client_state: ClientState {
|
client_state: ClientState {
|
||||||
shared_lane_queue_lengths,
|
shared_lane_queue_lengths,
|
||||||
reply_controller_sender,
|
reply_controller_sender,
|
||||||
@@ -773,7 +749,6 @@ pub struct BaseClient {
|
|||||||
pub client_input: ClientInputStatus,
|
pub client_input: ClientInputStatus,
|
||||||
pub client_output: ClientOutputStatus,
|
pub client_output: ClientOutputStatus,
|
||||||
pub client_state: ClientState,
|
pub client_state: ClientState,
|
||||||
pub gateway_fd: Option<RawFd>,
|
|
||||||
|
|
||||||
pub task_handle: TaskHandle,
|
pub task_handle: TaskHandle,
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ pub struct PersistedGatewayConfig {
|
|||||||
key_hash: Vec<u8>,
|
key_hash: Vec<u8>,
|
||||||
|
|
||||||
/// Actual gateway details being persisted.
|
/// Actual gateway details being persisted.
|
||||||
pub details: GatewayEndpointConfig,
|
pub(crate) details: GatewayEndpointConfig,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||||
|
|||||||
@@ -2,7 +2,6 @@
|
|||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
use crate::client::mix_traffic::BatchMixMessageSender;
|
use crate::client::mix_traffic::BatchMixMessageSender;
|
||||||
use crate::client::packet_statistics_control::{PacketStatisticsEvent, PacketStatisticsReporter};
|
|
||||||
use crate::client::topology_control::TopologyAccessor;
|
use crate::client::topology_control::TopologyAccessor;
|
||||||
use crate::{config, spawn_future};
|
use crate::{config, spawn_future};
|
||||||
use futures::task::{Context, Poll};
|
use futures::task::{Context, Poll};
|
||||||
@@ -62,8 +61,6 @@ where
|
|||||||
secondary_packet_size: Option<PacketSize>,
|
secondary_packet_size: Option<PacketSize>,
|
||||||
|
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
|
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R> Stream for LoopCoverTrafficStream<R>
|
impl<R> Stream for LoopCoverTrafficStream<R>
|
||||||
@@ -100,8 +97,7 @@ 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(crate) fn new(
|
|
||||||
ack_key: Arc<AckKey>,
|
ack_key: Arc<AckKey>,
|
||||||
average_ack_delay: Duration,
|
average_ack_delay: Duration,
|
||||||
mix_tx: BatchMixMessageSender,
|
mix_tx: BatchMixMessageSender,
|
||||||
@@ -109,7 +105,6 @@ impl LoopCoverTrafficStream<OsRng> {
|
|||||||
topology_access: TopologyAccessor,
|
topology_access: TopologyAccessor,
|
||||||
traffic_config: config::Traffic,
|
traffic_config: config::Traffic,
|
||||||
cover_config: config::CoverTraffic,
|
cover_config: config::CoverTraffic,
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
let rng = OsRng;
|
let rng = OsRng;
|
||||||
|
|
||||||
@@ -127,7 +122,6 @@ impl LoopCoverTrafficStream<OsRng> {
|
|||||||
primary_packet_size: traffic_config.primary_packet_size,
|
primary_packet_size: traffic_config.primary_packet_size,
|
||||||
secondary_packet_size: traffic_config.secondary_packet_size,
|
secondary_packet_size: traffic_config.secondary_packet_size,
|
||||||
packet_type: traffic_config.packet_type,
|
packet_type: traffic_config.packet_type,
|
||||||
stats_tx,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -197,10 +191,6 @@ impl LoopCoverTrafficStream<OsRng> {
|
|||||||
log::warn!("Failed to send cover message - channel closed");
|
log::warn!("Failed to send cover message - channel closed");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
|
||||||
self.stats_tx.report(PacketStatisticsEvent::CoverPacketSent(
|
|
||||||
cover_traffic_packet_size.size(),
|
|
||||||
));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO: I'm not entirely sure whether this is really required, because I'm not 100%
|
// TODO: I'm not entirely sure whether this is really required, because I'm not 100%
|
||||||
|
|||||||
@@ -1,8 +1,6 @@
|
|||||||
// 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
|
||||||
|
|
||||||
#![allow(unused_imports)]
|
|
||||||
|
|
||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
|
|
||||||
pub use wasmtimer::{std::Instant, tokio::*};
|
pub use wasmtimer::{std::Instant, tokio::*};
|
||||||
|
|||||||
@@ -28,7 +28,6 @@ pub enum InputMessage {
|
|||||||
recipient: Recipient,
|
recipient: Recipient,
|
||||||
data: Vec<u8>,
|
data: Vec<u8>,
|
||||||
lane: TransmissionLane,
|
lane: TransmissionLane,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
},
|
},
|
||||||
|
|
||||||
/// Creates a message used for a duplex anonymous communication where the recipient
|
/// Creates a message used for a duplex anonymous communication where the recipient
|
||||||
@@ -44,7 +43,6 @@ pub enum InputMessage {
|
|||||||
data: Vec<u8>,
|
data: Vec<u8>,
|
||||||
reply_surbs: u32,
|
reply_surbs: u32,
|
||||||
lane: TransmissionLane,
|
lane: TransmissionLane,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
},
|
},
|
||||||
|
|
||||||
/// Attempt to use our internally received and stored `ReplySurb` to send the message back
|
/// Attempt to use our internally received and stored `ReplySurb` to send the message back
|
||||||
@@ -94,29 +92,6 @@ impl InputMessage {
|
|||||||
recipient,
|
recipient,
|
||||||
data,
|
data,
|
||||||
lane,
|
lane,
|
||||||
mix_hops: None,
|
|
||||||
};
|
|
||||||
if let Some(packet_type) = packet_type {
|
|
||||||
InputMessage::new_wrapper(message, packet_type)
|
|
||||||
} else {
|
|
||||||
message
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IMHO `new_regular` should take `mix_hops: Option<u8>` as an argument instead of creating
|
|
||||||
// this function, but that would potentially break backwards compatibility with the current API
|
|
||||||
pub fn new_regular_with_custom_hops(
|
|
||||||
recipient: Recipient,
|
|
||||||
data: Vec<u8>,
|
|
||||||
lane: TransmissionLane,
|
|
||||||
packet_type: Option<PacketType>,
|
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) -> Self {
|
|
||||||
let message = InputMessage::Regular {
|
|
||||||
recipient,
|
|
||||||
data,
|
|
||||||
lane,
|
|
||||||
mix_hops,
|
|
||||||
};
|
};
|
||||||
if let Some(packet_type) = packet_type {
|
if let Some(packet_type) = packet_type {
|
||||||
InputMessage::new_wrapper(message, packet_type)
|
InputMessage::new_wrapper(message, packet_type)
|
||||||
@@ -137,31 +112,6 @@ impl InputMessage {
|
|||||||
data,
|
data,
|
||||||
reply_surbs,
|
reply_surbs,
|
||||||
lane,
|
lane,
|
||||||
mix_hops: None,
|
|
||||||
};
|
|
||||||
if let Some(packet_type) = packet_type {
|
|
||||||
InputMessage::new_wrapper(message, packet_type)
|
|
||||||
} else {
|
|
||||||
message
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IMHO `new_anonymous` should take `mix_hops: Option<u8>` as an argument instead of creating
|
|
||||||
// this function, but that would potentially break backwards compatibility with the current API
|
|
||||||
pub fn new_anonymous_with_custom_hops(
|
|
||||||
recipient: Recipient,
|
|
||||||
data: Vec<u8>,
|
|
||||||
reply_surbs: u32,
|
|
||||||
lane: TransmissionLane,
|
|
||||||
packet_type: Option<PacketType>,
|
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) -> Self {
|
|
||||||
let message = InputMessage::Anonymous {
|
|
||||||
recipient,
|
|
||||||
data,
|
|
||||||
reply_surbs,
|
|
||||||
lane,
|
|
||||||
mix_hops,
|
|
||||||
};
|
};
|
||||||
if let Some(packet_type) = packet_type {
|
if let Some(packet_type) = packet_type {
|
||||||
InputMessage::new_wrapper(message, packet_type)
|
InputMessage::new_wrapper(message, packet_type)
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ use nym_gateway_client::GatewayClient;
|
|||||||
pub use nym_gateway_client::{GatewayPacketRouter, PacketRouter};
|
pub use nym_gateway_client::{GatewayPacketRouter, PacketRouter};
|
||||||
use nym_sphinx::forwarding::packet::MixPacket;
|
use nym_sphinx::forwarding::packet::MixPacket;
|
||||||
use std::fmt::Debug;
|
use std::fmt::Debug;
|
||||||
use std::os::fd::RawFd;
|
|
||||||
use thiserror::Error;
|
use thiserror::Error;
|
||||||
|
|
||||||
#[cfg(not(target_arch = "wasm32"))]
|
#[cfg(not(target_arch = "wasm32"))]
|
||||||
@@ -26,7 +25,6 @@ fn erase_err<E: std::error::Error + Send + Sync + 'static>(err: E) -> ErasedGate
|
|||||||
/// This combines combines the functionalities of being able to send and receive mix packets.
|
/// This combines combines the functionalities of being able to send and receive mix packets.
|
||||||
pub trait GatewayTransceiver: GatewaySender + GatewayReceiver {
|
pub trait GatewayTransceiver: GatewaySender + GatewayReceiver {
|
||||||
fn gateway_identity(&self) -> identity::PublicKey;
|
fn gateway_identity(&self) -> identity::PublicKey;
|
||||||
fn ws_fd(&self) -> Option<RawFd>;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// This trait defines the functionality of sending `MixPacket` into the mixnet,
|
/// This trait defines the functionality of sending `MixPacket` into the mixnet,
|
||||||
@@ -68,9 +66,6 @@ impl<G: GatewayTransceiver + ?Sized + Send> GatewayTransceiver for Box<G> {
|
|||||||
fn gateway_identity(&self) -> identity::PublicKey {
|
fn gateway_identity(&self) -> identity::PublicKey {
|
||||||
(**self).gateway_identity()
|
(**self).gateway_identity()
|
||||||
}
|
}
|
||||||
fn ws_fd(&self) -> Option<RawFd> {
|
|
||||||
(**self).ws_fd()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
|
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
|
||||||
@@ -117,9 +112,6 @@ where
|
|||||||
fn gateway_identity(&self) -> identity::PublicKey {
|
fn gateway_identity(&self) -> identity::PublicKey {
|
||||||
self.gateway_client.gateway_identity()
|
self.gateway_client.gateway_identity()
|
||||||
}
|
}
|
||||||
fn ws_fd(&self) -> Option<RawFd> {
|
|
||||||
self.gateway_client.ws_fd()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
|
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
|
||||||
@@ -195,9 +187,6 @@ mod nonwasm_sealed {
|
|||||||
fn gateway_identity(&self) -> identity::PublicKey {
|
fn gateway_identity(&self) -> identity::PublicKey {
|
||||||
self.local_identity
|
self.local_identity
|
||||||
}
|
}
|
||||||
fn ws_fd(&self) -> Option<RawFd> {
|
|
||||||
None
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
@@ -270,7 +259,4 @@ impl GatewayTransceiver for MockGateway {
|
|||||||
fn gateway_identity(&self) -> identity::PublicKey {
|
fn gateway_identity(&self) -> identity::PublicKey {
|
||||||
self.dummy_identity
|
self.dummy_identity
|
||||||
}
|
}
|
||||||
fn ws_fd(&self) -> Option<RawFd> {
|
|
||||||
None
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ pub(crate) mod helpers;
|
|||||||
pub mod inbound_messages;
|
pub mod inbound_messages;
|
||||||
pub mod key_manager;
|
pub mod key_manager;
|
||||||
pub mod mix_traffic;
|
pub mod mix_traffic;
|
||||||
pub(crate) mod packet_statistics_control;
|
|
||||||
pub mod real_messages_control;
|
pub mod real_messages_control;
|
||||||
pub mod received_buffer;
|
pub mod received_buffer;
|
||||||
pub mod replies;
|
pub mod replies;
|
||||||
|
|||||||
@@ -1,503 +0,0 @@
|
|||||||
use std::{
|
|
||||||
collections::VecDeque,
|
|
||||||
time::{Duration, Instant},
|
|
||||||
};
|
|
||||||
|
|
||||||
use si_scale::helpers::bibytes2;
|
|
||||||
|
|
||||||
use crate::spawn_future;
|
|
||||||
|
|
||||||
// Time interval between reporting packet statistics
|
|
||||||
const PACKET_REPORT_INTERVAL_SECS: u64 = 2;
|
|
||||||
// Interval for taking snapshots of the packet statistics
|
|
||||||
const SNAPSHOT_INTERVAL_MS: u64 = 500;
|
|
||||||
// When computing rates, we include snapshots that are up to this old. We set it to some odd number
|
|
||||||
// a tad larger than an integer number of snapshot intervals, so that we don't have to worry about
|
|
||||||
// threshold effects.
|
|
||||||
// Also, set it larger than the packet report interval so that we don't miss notable singular events
|
|
||||||
const RECORDING_WINDOW_MS: u64 = 2300;
|
|
||||||
|
|
||||||
#[derive(Default, Debug, Clone)]
|
|
||||||
struct PacketStatistics {
|
|
||||||
// Sent
|
|
||||||
real_packets_sent: u64,
|
|
||||||
real_packets_sent_size: usize,
|
|
||||||
cover_packets_sent: u64,
|
|
||||||
cover_packets_sent_size: usize,
|
|
||||||
|
|
||||||
// Received
|
|
||||||
real_packets_received: u64,
|
|
||||||
real_packets_received_size: usize,
|
|
||||||
cover_packets_received: u64,
|
|
||||||
cover_packets_received_size: usize,
|
|
||||||
|
|
||||||
// Acks
|
|
||||||
total_acks_received: u64,
|
|
||||||
total_acks_received_size: usize,
|
|
||||||
real_acks_received: u64,
|
|
||||||
real_acks_received_size: usize,
|
|
||||||
cover_acks_received: u64,
|
|
||||||
cover_acks_received_size: usize,
|
|
||||||
|
|
||||||
// Types of packets queued
|
|
||||||
// TODO: track the type sent instead
|
|
||||||
real_packets_queued: u64,
|
|
||||||
retransmissions_queued: u64,
|
|
||||||
reply_surbs_queued: u64,
|
|
||||||
additional_reply_surbs_queued: u64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PacketStatistics {
|
|
||||||
fn handle_event(&mut self, event: PacketStatisticsEvent) {
|
|
||||||
match event {
|
|
||||||
PacketStatisticsEvent::RealPacketSent(packet_size) => {
|
|
||||||
self.real_packets_sent += 1;
|
|
||||||
self.real_packets_sent_size += packet_size;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::CoverPacketSent(packet_size) => {
|
|
||||||
self.cover_packets_sent += 1;
|
|
||||||
self.cover_packets_sent_size += packet_size;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::RealPacketReceived(packet_size) => {
|
|
||||||
self.real_packets_received += 1;
|
|
||||||
self.real_packets_received_size += packet_size;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::CoverPacketReceived(packet_size) => {
|
|
||||||
self.cover_packets_received += 1;
|
|
||||||
self.cover_packets_received_size += packet_size;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::AckReceived(packet_size) => {
|
|
||||||
self.total_acks_received += 1;
|
|
||||||
self.total_acks_received_size += packet_size;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::RealAckReceived(packet_size) => {
|
|
||||||
self.real_acks_received += 1;
|
|
||||||
self.real_acks_received_size += packet_size;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::CoverAckReceived(packet_size) => {
|
|
||||||
self.cover_acks_received += 1;
|
|
||||||
self.cover_acks_received_size += packet_size;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::RealPacketQueued => {
|
|
||||||
self.real_packets_queued += 1;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::RetransmissionQueued => {
|
|
||||||
self.retransmissions_queued += 1;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::ReplySurbRequestQueued => {
|
|
||||||
self.reply_surbs_queued += 1;
|
|
||||||
}
|
|
||||||
PacketStatisticsEvent::AdditionalReplySurbRequestQueued => {
|
|
||||||
self.additional_reply_surbs_queued += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn summary(&self) -> (String, String) {
|
|
||||||
(
|
|
||||||
format!(
|
|
||||||
"packets sent: {} (real: {}, cover: {}, retransmissions: {})",
|
|
||||||
self.real_packets_sent + self.cover_packets_sent,
|
|
||||||
self.real_packets_sent,
|
|
||||||
self.cover_packets_sent,
|
|
||||||
self.retransmissions_queued,
|
|
||||||
),
|
|
||||||
format!(
|
|
||||||
"packets received: {}, (real: {}, cover: {}, acks: {}, acks for cover: {})",
|
|
||||||
self.real_packets_received + self.cover_packets_received,
|
|
||||||
self.real_packets_received,
|
|
||||||
self.cover_packets_received,
|
|
||||||
self.real_acks_received,
|
|
||||||
self.cover_acks_received,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl std::ops::Sub for PacketStatistics {
|
|
||||||
type Output = Self;
|
|
||||||
|
|
||||||
fn sub(self, rhs: Self) -> Self::Output {
|
|
||||||
Self {
|
|
||||||
real_packets_sent: self.real_packets_sent - rhs.real_packets_sent,
|
|
||||||
real_packets_sent_size: self.real_packets_sent_size - rhs.real_packets_sent_size,
|
|
||||||
cover_packets_sent: self.cover_packets_sent - rhs.cover_packets_sent,
|
|
||||||
cover_packets_sent_size: self.cover_packets_sent_size - rhs.cover_packets_sent_size,
|
|
||||||
|
|
||||||
real_packets_received: self.real_packets_received - rhs.real_packets_received,
|
|
||||||
real_packets_received_size: self.real_packets_received_size
|
|
||||||
- rhs.real_packets_received_size,
|
|
||||||
cover_packets_received: self.cover_packets_received - rhs.cover_packets_received,
|
|
||||||
cover_packets_received_size: self.cover_packets_received_size
|
|
||||||
- rhs.cover_packets_received_size,
|
|
||||||
|
|
||||||
total_acks_received: self.total_acks_received - rhs.total_acks_received,
|
|
||||||
total_acks_received_size: self.total_acks_received_size - rhs.total_acks_received_size,
|
|
||||||
real_acks_received: self.real_acks_received - rhs.real_acks_received,
|
|
||||||
real_acks_received_size: self.real_acks_received_size - rhs.real_acks_received_size,
|
|
||||||
cover_acks_received: self.cover_acks_received - rhs.cover_acks_received,
|
|
||||||
cover_acks_received_size: self.cover_acks_received_size - rhs.cover_acks_received_size,
|
|
||||||
|
|
||||||
real_packets_queued: self.real_packets_queued - rhs.real_packets_queued,
|
|
||||||
retransmissions_queued: self.retransmissions_queued - rhs.retransmissions_queued,
|
|
||||||
reply_surbs_queued: self.reply_surbs_queued - rhs.reply_surbs_queued,
|
|
||||||
additional_reply_surbs_queued: self.additional_reply_surbs_queued
|
|
||||||
- rhs.additional_reply_surbs_queued,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone)]
|
|
||||||
struct PacketRates {
|
|
||||||
real_packets_sent: f64,
|
|
||||||
real_packets_sent_size: f64,
|
|
||||||
cover_packets_sent: f64,
|
|
||||||
cover_packets_sent_size: f64,
|
|
||||||
|
|
||||||
real_packets_received: f64,
|
|
||||||
real_packets_received_size: f64,
|
|
||||||
cover_packets_received: f64,
|
|
||||||
cover_packets_received_size: f64,
|
|
||||||
|
|
||||||
total_acks_received: f64,
|
|
||||||
total_acks_received_size: f64,
|
|
||||||
real_acks_received: f64,
|
|
||||||
real_acks_received_size: f64,
|
|
||||||
cover_acks_received: f64,
|
|
||||||
cover_acks_received_size: f64,
|
|
||||||
|
|
||||||
real_packets_queued: f64,
|
|
||||||
retransmissions_queued: f64,
|
|
||||||
reply_surbs_queued: f64,
|
|
||||||
additional_reply_surbs_queued: f64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<PacketStatistics> for PacketRates {
|
|
||||||
fn from(stats: PacketStatistics) -> Self {
|
|
||||||
Self {
|
|
||||||
real_packets_sent: stats.real_packets_sent as f64,
|
|
||||||
real_packets_sent_size: stats.real_packets_sent_size as f64,
|
|
||||||
cover_packets_sent: stats.cover_packets_sent as f64,
|
|
||||||
cover_packets_sent_size: stats.cover_packets_sent_size as f64,
|
|
||||||
|
|
||||||
real_packets_received: stats.real_packets_received as f64,
|
|
||||||
real_packets_received_size: stats.real_packets_received_size as f64,
|
|
||||||
cover_packets_received: stats.cover_packets_received as f64,
|
|
||||||
cover_packets_received_size: stats.cover_packets_received_size as f64,
|
|
||||||
|
|
||||||
total_acks_received: stats.total_acks_received as f64,
|
|
||||||
total_acks_received_size: stats.total_acks_received_size as f64,
|
|
||||||
real_acks_received: stats.real_acks_received as f64,
|
|
||||||
real_acks_received_size: stats.real_acks_received_size as f64,
|
|
||||||
cover_acks_received: stats.cover_acks_received as f64,
|
|
||||||
cover_acks_received_size: stats.cover_acks_received_size as f64,
|
|
||||||
|
|
||||||
real_packets_queued: stats.real_packets_queued as f64,
|
|
||||||
retransmissions_queued: stats.retransmissions_queued as f64,
|
|
||||||
reply_surbs_queued: stats.reply_surbs_queued as f64,
|
|
||||||
additional_reply_surbs_queued: stats.additional_reply_surbs_queued as f64,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl std::ops::Sub for PacketRates {
|
|
||||||
type Output = Self;
|
|
||||||
|
|
||||||
fn sub(self, rhs: Self) -> Self::Output {
|
|
||||||
Self {
|
|
||||||
real_packets_sent: self.real_packets_sent - rhs.real_packets_sent,
|
|
||||||
real_packets_sent_size: self.real_packets_sent_size - rhs.real_packets_sent_size,
|
|
||||||
cover_packets_sent: self.cover_packets_sent - rhs.cover_packets_sent,
|
|
||||||
cover_packets_sent_size: self.cover_packets_sent_size - rhs.cover_packets_sent_size,
|
|
||||||
|
|
||||||
real_packets_received: self.real_packets_received - rhs.real_packets_received,
|
|
||||||
real_packets_received_size: self.real_packets_received_size
|
|
||||||
- rhs.real_packets_received_size,
|
|
||||||
cover_packets_received: self.cover_packets_received - rhs.cover_packets_received,
|
|
||||||
cover_packets_received_size: self.cover_packets_received_size
|
|
||||||
- rhs.cover_packets_received_size,
|
|
||||||
|
|
||||||
total_acks_received: self.total_acks_received - rhs.total_acks_received,
|
|
||||||
total_acks_received_size: self.total_acks_received_size - rhs.total_acks_received_size,
|
|
||||||
real_acks_received: self.real_acks_received - rhs.real_acks_received,
|
|
||||||
real_acks_received_size: self.real_acks_received_size - rhs.real_acks_received_size,
|
|
||||||
cover_acks_received: self.cover_acks_received - rhs.cover_acks_received,
|
|
||||||
cover_acks_received_size: self.cover_acks_received_size - rhs.cover_acks_received_size,
|
|
||||||
|
|
||||||
real_packets_queued: self.real_packets_queued - rhs.real_packets_queued,
|
|
||||||
retransmissions_queued: self.retransmissions_queued - rhs.retransmissions_queued,
|
|
||||||
reply_surbs_queued: self.reply_surbs_queued - rhs.reply_surbs_queued,
|
|
||||||
additional_reply_surbs_queued: self.additional_reply_surbs_queued
|
|
||||||
- rhs.additional_reply_surbs_queued,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl std::ops::Div<f64> for PacketRates {
|
|
||||||
type Output = Self;
|
|
||||||
|
|
||||||
fn div(self, rhs: f64) -> Self::Output {
|
|
||||||
Self {
|
|
||||||
real_packets_sent: self.real_packets_sent / rhs,
|
|
||||||
real_packets_sent_size: self.real_packets_sent_size / rhs,
|
|
||||||
cover_packets_sent: self.cover_packets_sent / rhs,
|
|
||||||
cover_packets_sent_size: self.cover_packets_sent_size / rhs,
|
|
||||||
|
|
||||||
real_packets_received: self.real_packets_received / rhs,
|
|
||||||
real_packets_received_size: self.real_packets_received_size / rhs,
|
|
||||||
cover_packets_received: self.cover_packets_received / rhs,
|
|
||||||
cover_packets_received_size: self.cover_packets_received_size / rhs,
|
|
||||||
|
|
||||||
total_acks_received: self.total_acks_received / rhs,
|
|
||||||
total_acks_received_size: self.total_acks_received_size / rhs,
|
|
||||||
real_acks_received: self.real_acks_received / rhs,
|
|
||||||
real_acks_received_size: self.real_acks_received_size / rhs,
|
|
||||||
cover_acks_received: self.cover_acks_received / rhs,
|
|
||||||
cover_acks_received_size: self.cover_acks_received_size / rhs,
|
|
||||||
|
|
||||||
real_packets_queued: self.real_packets_queued / rhs,
|
|
||||||
retransmissions_queued: self.retransmissions_queued / rhs,
|
|
||||||
reply_surbs_queued: self.reply_surbs_queued / rhs,
|
|
||||||
additional_reply_surbs_queued: self.additional_reply_surbs_queued / rhs,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PacketRates {
|
|
||||||
fn summary(&self) -> String {
|
|
||||||
format!(
|
|
||||||
"down: {}/s, up: {}/s (cover down: {}/s, cover up: {}/s)",
|
|
||||||
bibytes2(self.real_packets_received_size),
|
|
||||||
bibytes2(self.real_packets_sent_size),
|
|
||||||
bibytes2(self.cover_packets_received_size),
|
|
||||||
bibytes2(self.cover_packets_sent_size),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn detailed_summary(&self) -> String {
|
|
||||||
format!(
|
|
||||||
"RX: {:.1} mixpkt/s, {}/s (real: {}/s, acks: {}/s), TX: {:.1} mixpkt/s, {}/s (real: {}/s)",
|
|
||||||
self.real_packets_received + self.cover_packets_received,
|
|
||||||
bibytes2(self.real_packets_received_size + self.cover_packets_received_size),
|
|
||||||
bibytes2(self.real_packets_received_size),
|
|
||||||
bibytes2(self.total_acks_received_size),
|
|
||||||
self.real_packets_sent + self.cover_packets_sent,
|
|
||||||
bibytes2(self.real_packets_sent_size + self.cover_packets_sent_size),
|
|
||||||
bibytes2(self.real_packets_sent_size),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
|
||||||
pub(crate) enum PacketStatisticsEvent {
|
|
||||||
// The real packets sent. Recall that acks are sent by the gateway, so it's not included here.
|
|
||||||
RealPacketSent(usize),
|
|
||||||
// The cover packets sent
|
|
||||||
CoverPacketSent(usize),
|
|
||||||
|
|
||||||
// Real packets received
|
|
||||||
RealPacketReceived(usize),
|
|
||||||
// Cover packets received
|
|
||||||
CoverPacketReceived(usize),
|
|
||||||
|
|
||||||
// Ack of any type received. This is mostly used as a consistency check, and should be the sum
|
|
||||||
// of real and cover acks received.
|
|
||||||
AckReceived(usize),
|
|
||||||
// Out of the total acks received, this is the subset of those that were real
|
|
||||||
RealAckReceived(usize),
|
|
||||||
// Out of the total acks received, this is the subset of those that were for cover traffic
|
|
||||||
CoverAckReceived(usize),
|
|
||||||
|
|
||||||
// Types of packets queued
|
|
||||||
RealPacketQueued,
|
|
||||||
RetransmissionQueued,
|
|
||||||
ReplySurbRequestQueued,
|
|
||||||
AdditionalReplySurbRequestQueued,
|
|
||||||
}
|
|
||||||
|
|
||||||
type PacketStatisticsReceiver = tokio::sync::mpsc::UnboundedReceiver<PacketStatisticsEvent>;
|
|
||||||
|
|
||||||
#[derive(Clone)]
|
|
||||||
pub(crate) struct PacketStatisticsReporter {
|
|
||||||
stats_tx: tokio::sync::mpsc::UnboundedSender<PacketStatisticsEvent>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PacketStatisticsReporter {
|
|
||||||
pub(crate) fn new(stats_tx: tokio::sync::mpsc::UnboundedSender<PacketStatisticsEvent>) -> Self {
|
|
||||||
Self { stats_tx }
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn report(&self, event: PacketStatisticsEvent) {
|
|
||||||
self.stats_tx.send(event).unwrap_or_else(|err| {
|
|
||||||
log::error!("Failed to report packet stat: {:?}", err);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) struct PacketStatisticsControl {
|
|
||||||
// Incoming packet stats events from other tasks
|
|
||||||
stats_rx: PacketStatisticsReceiver,
|
|
||||||
|
|
||||||
// Keep track of packet statistics over time
|
|
||||||
stats: PacketStatistics,
|
|
||||||
|
|
||||||
// We keep snapshots of the statistics over time so we can compute rates, and also keeping the
|
|
||||||
// full history allows for some more fancy averaging if we want to do that.
|
|
||||||
history: VecDeque<(Instant, PacketStatistics)>,
|
|
||||||
|
|
||||||
// Keep previous rates so that we can detect notable events
|
|
||||||
rates: VecDeque<(Instant, PacketRates)>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PacketStatisticsControl {
|
|
||||||
pub(crate) fn new() -> (Self, PacketStatisticsReporter) {
|
|
||||||
let (stats_tx, stats_rx) = tokio::sync::mpsc::unbounded_channel();
|
|
||||||
|
|
||||||
(
|
|
||||||
Self {
|
|
||||||
stats_rx,
|
|
||||||
stats: PacketStatistics::default(),
|
|
||||||
history: VecDeque::new(),
|
|
||||||
rates: VecDeque::new(),
|
|
||||||
},
|
|
||||||
PacketStatisticsReporter::new(stats_tx),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add the current stats to the history, and remove old ones.
|
|
||||||
fn update_history(&mut self) {
|
|
||||||
// Update latest
|
|
||||||
self.history.push_back((Instant::now(), self.stats.clone()));
|
|
||||||
|
|
||||||
// Filter out old ones
|
|
||||||
let recording_window = Instant::now() - Duration::from_millis(RECORDING_WINDOW_MS);
|
|
||||||
while self
|
|
||||||
.history
|
|
||||||
.front()
|
|
||||||
.map_or(false, |&(t, _)| t < recording_window)
|
|
||||||
{
|
|
||||||
self.history.pop_front();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn compute_rates(&self) -> Option<PacketRates> {
|
|
||||||
// NOTE: consider changing this to compute rates over the history instead of using current
|
|
||||||
// stats. Currently it should not make much of a difference since we call this just after
|
|
||||||
// updating the history, but it seems like it could be more internally consistent to do it
|
|
||||||
// that way.
|
|
||||||
|
|
||||||
// Do basic averaging over the entire history, which just uses the first and last
|
|
||||||
if let Some((start, start_stats)) = self.history.front() {
|
|
||||||
let duration_secs = Instant::now().duration_since(*start).as_secs_f64();
|
|
||||||
let delta = self.stats.clone() - start_stats.clone();
|
|
||||||
let rates = PacketRates::from(delta) / duration_secs;
|
|
||||||
Some(rates)
|
|
||||||
} else {
|
|
||||||
None
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn update_rates(&mut self) {
|
|
||||||
// Update latest
|
|
||||||
if let Some(rates) = self.compute_rates() {
|
|
||||||
self.rates.push_back((Instant::now(), rates));
|
|
||||||
}
|
|
||||||
|
|
||||||
// Filter out old ones
|
|
||||||
let recording_window = Instant::now() - Duration::from_millis(RECORDING_WINDOW_MS);
|
|
||||||
while self
|
|
||||||
.rates
|
|
||||||
.front()
|
|
||||||
.map_or(false, |&(t, _)| t < recording_window)
|
|
||||||
{
|
|
||||||
self.rates.pop_front();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn report_rates(&self) {
|
|
||||||
if let Some((_, rates)) = self.rates.back() {
|
|
||||||
log::info!("{}", rates.summary());
|
|
||||||
log::debug!("{}", rates.detailed_summary());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn report_counters(&self) {
|
|
||||||
log::trace!("packet statistics: {:?}", &self.stats);
|
|
||||||
let (summary_sent, summary_recv) = self.stats.summary();
|
|
||||||
log::debug!("{}", summary_sent);
|
|
||||||
log::debug!("{}", summary_recv);
|
|
||||||
}
|
|
||||||
|
|
||||||
fn check_for_notable_events(&self) {
|
|
||||||
let Some((_, latest_rates)) = self.rates.back() else {
|
|
||||||
return;
|
|
||||||
};
|
|
||||||
|
|
||||||
// If we get a burst of retransmissions
|
|
||||||
// TODO: consider making this the number of retransmissions since last report instead.
|
|
||||||
if latest_rates.retransmissions_queued > 0.0 {
|
|
||||||
log::debug!(
|
|
||||||
"retransmissions: {:.2} pkt/s",
|
|
||||||
latest_rates.retransmissions_queued
|
|
||||||
);
|
|
||||||
|
|
||||||
// Check what the number of retransmissions was during the recording window
|
|
||||||
if let Some((_, start_stats)) = self.history.front() {
|
|
||||||
let delta = self.stats.clone() - start_stats.clone();
|
|
||||||
log::info!(
|
|
||||||
"mix packet retransmissions/real mix packets: {}/{}",
|
|
||||||
delta.retransmissions_queued,
|
|
||||||
delta.real_packets_queued,
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
log::warn!("Unable to check retransmissions during recording window");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IDEA: if there is a burst of acks, that could indicate tokio task starvation.
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) async fn run_with_shutdown(&mut self, mut shutdown: nym_task::TaskClient) {
|
|
||||||
log::debug!("Started PacketStatisticsControl with graceful shutdown support");
|
|
||||||
|
|
||||||
let report_interval = Duration::from_secs(PACKET_REPORT_INTERVAL_SECS);
|
|
||||||
let mut report_interval = tokio::time::interval(report_interval);
|
|
||||||
let snapshot_interval = Duration::from_millis(SNAPSHOT_INTERVAL_MS);
|
|
||||||
let mut snapshot_interval = tokio::time::interval(snapshot_interval);
|
|
||||||
|
|
||||||
loop {
|
|
||||||
tokio::select! {
|
|
||||||
stats_event = self.stats_rx.recv() => match stats_event {
|
|
||||||
Some(stats_event) => {
|
|
||||||
log::trace!("PacketStatisticsControl: Received stats event");
|
|
||||||
self.stats.handle_event(stats_event);
|
|
||||||
},
|
|
||||||
None => {
|
|
||||||
log::trace!("PacketStatisticsControl: stopping since stats channel was closed");
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
},
|
|
||||||
_ = snapshot_interval.tick() => {
|
|
||||||
self.update_history();
|
|
||||||
self.update_rates();
|
|
||||||
}
|
|
||||||
_ = report_interval.tick() => {
|
|
||||||
self.report_rates();
|
|
||||||
self.check_for_notable_events();
|
|
||||||
self.report_counters();
|
|
||||||
}
|
|
||||||
_ = shutdown.recv_with_delay() => {
|
|
||||||
log::trace!("PacketStatisticsControl: Received shutdown");
|
|
||||||
break;
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
log::debug!("PacketStatisticsControl: Exiting");
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn start_with_shutdown(mut self, task_client: nym_task::TaskClient) {
|
|
||||||
spawn_future(async move {
|
|
||||||
self.run_with_shutdown(task_client).await;
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+1
-12
@@ -1,8 +1,6 @@
|
|||||||
// Copyright 2021 - 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
|
||||||
|
|
||||||
use crate::client::packet_statistics_control::{PacketStatisticsEvent, PacketStatisticsReporter};
|
|
||||||
|
|
||||||
use super::action_controller::{AckActionSender, Action};
|
use super::action_controller::{AckActionSender, Action};
|
||||||
use futures::StreamExt;
|
use futures::StreamExt;
|
||||||
use log::*;
|
use log::*;
|
||||||
@@ -19,7 +17,6 @@ pub(super) struct AcknowledgementListener {
|
|||||||
ack_key: Arc<AckKey>,
|
ack_key: Arc<AckKey>,
|
||||||
ack_receiver: AcknowledgementReceiver,
|
ack_receiver: AcknowledgementReceiver,
|
||||||
action_sender: AckActionSender,
|
action_sender: AckActionSender,
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl AcknowledgementListener {
|
impl AcknowledgementListener {
|
||||||
@@ -27,21 +24,16 @@ impl AcknowledgementListener {
|
|||||||
ack_key: Arc<AckKey>,
|
ack_key: Arc<AckKey>,
|
||||||
ack_receiver: AcknowledgementReceiver,
|
ack_receiver: AcknowledgementReceiver,
|
||||||
action_sender: AckActionSender,
|
action_sender: AckActionSender,
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
AcknowledgementListener {
|
AcknowledgementListener {
|
||||||
ack_key,
|
ack_key,
|
||||||
ack_receiver,
|
ack_receiver,
|
||||||
action_sender,
|
action_sender,
|
||||||
stats_tx,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn on_ack(&mut self, ack_content: Vec<u8>) {
|
async fn on_ack(&mut self, ack_content: Vec<u8>) {
|
||||||
trace!("Received an ack");
|
trace!("Received an ack");
|
||||||
self.stats_tx
|
|
||||||
.report(PacketStatisticsEvent::AckReceived(ack_content.len()));
|
|
||||||
|
|
||||||
let frag_id = match recover_identifier(&self.ack_key, &ack_content)
|
let frag_id = match recover_identifier(&self.ack_key, &ack_content)
|
||||||
.map(FragmentIdentifier::try_from_bytes)
|
.map(FragmentIdentifier::try_from_bytes)
|
||||||
{
|
{
|
||||||
@@ -56,14 +48,11 @@ impl AcknowledgementListener {
|
|||||||
// because nothing was inserted in the first place
|
// because nothing was inserted in the first place
|
||||||
if frag_id == COVER_FRAG_ID {
|
if frag_id == COVER_FRAG_ID {
|
||||||
trace!("Received an ack for a cover message - no need to do anything");
|
trace!("Received an ack for a cover message - no need to do anything");
|
||||||
self.stats_tx
|
|
||||||
.report(PacketStatisticsEvent::CoverAckReceived(ack_content.len()));
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
trace!("Received {} from the mix network", frag_id);
|
trace!("Received {} from the mix network", frag_id);
|
||||||
self.stats_tx
|
|
||||||
.report(PacketStatisticsEvent::RealAckReceived(ack_content.len()));
|
|
||||||
self.action_sender
|
self.action_sender
|
||||||
.unbounded_send(Action::new_remove(frag_id))
|
.unbounded_send(Action::new_remove(frag_id))
|
||||||
.unwrap();
|
.unwrap();
|
||||||
|
|||||||
+2
-5
@@ -127,9 +127,7 @@ impl ActionController {
|
|||||||
.insert(frag_id, (Arc::new(pending_ack), None))
|
.insert(frag_id, (Arc::new(pending_ack), None))
|
||||||
.is_some()
|
.is_some()
|
||||||
{
|
{
|
||||||
// This used to be a panic, however since we've seen this actually happen in the
|
panic!("Tried to insert duplicate pending ack")
|
||||||
// wild, let's not take the whole client (and possibly gateway) down because of it.
|
|
||||||
error!("Tried to insert duplicate pending ack! This should not be possible!")
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -265,7 +263,7 @@ impl ActionController {
|
|||||||
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 ActionController with graceful shutdown support");
|
debug!("Started ActionController with graceful shutdown support");
|
||||||
|
|
||||||
loop {
|
while !shutdown.is_shutdown() {
|
||||||
tokio::select! {
|
tokio::select! {
|
||||||
action = self.incoming_actions.next() => match action {
|
action = self.incoming_actions.next() => match action {
|
||||||
Some(action) => self.process_action(action),
|
Some(action) => self.process_action(action),
|
||||||
@@ -285,7 +283,6 @@ impl ActionController {
|
|||||||
},
|
},
|
||||||
_ = shutdown.recv_with_delay() => {
|
_ = shutdown.recv_with_delay() => {
|
||||||
log::trace!("ActionController: Received shutdown");
|
log::trace!("ActionController: Received shutdown");
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+8
-35
@@ -73,11 +73,10 @@ where
|
|||||||
content: Vec<u8>,
|
content: Vec<u8>,
|
||||||
lane: TransmissionLane,
|
lane: TransmissionLane,
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) {
|
) {
|
||||||
if let Err(err) = self
|
if let Err(err) = self
|
||||||
.message_handler
|
.message_handler
|
||||||
.try_send_plain_message(recipient, content, lane, packet_type, mix_hops)
|
.try_send_plain_message(recipient, content, lane, packet_type)
|
||||||
.await
|
.await
|
||||||
{
|
{
|
||||||
warn!("failed to send a plain message - {err}")
|
warn!("failed to send a plain message - {err}")
|
||||||
@@ -91,18 +90,10 @@ where
|
|||||||
reply_surbs: u32,
|
reply_surbs: u32,
|
||||||
lane: TransmissionLane,
|
lane: TransmissionLane,
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) {
|
) {
|
||||||
if let Err(err) = self
|
if let Err(err) = self
|
||||||
.message_handler
|
.message_handler
|
||||||
.try_send_message_with_reply_surbs(
|
.try_send_message_with_reply_surbs(recipient, content, reply_surbs, lane, packet_type)
|
||||||
recipient,
|
|
||||||
content,
|
|
||||||
reply_surbs,
|
|
||||||
lane,
|
|
||||||
packet_type,
|
|
||||||
mix_hops,
|
|
||||||
)
|
|
||||||
.await
|
.await
|
||||||
{
|
{
|
||||||
warn!("failed to send a repliable message - {err}")
|
warn!("failed to send a repliable message - {err}")
|
||||||
@@ -115,9 +106,8 @@ where
|
|||||||
recipient,
|
recipient,
|
||||||
data,
|
data,
|
||||||
lane,
|
lane,
|
||||||
mix_hops,
|
|
||||||
} => {
|
} => {
|
||||||
self.handle_plain_message(recipient, data, lane, PacketType::Mix, mix_hops)
|
self.handle_plain_message(recipient, data, lane, PacketType::Mix)
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
InputMessage::Anonymous {
|
InputMessage::Anonymous {
|
||||||
@@ -125,17 +115,9 @@ where
|
|||||||
data,
|
data,
|
||||||
reply_surbs,
|
reply_surbs,
|
||||||
lane,
|
lane,
|
||||||
mix_hops,
|
|
||||||
} => {
|
} => {
|
||||||
self.handle_repliable_message(
|
self.handle_repliable_message(recipient, data, reply_surbs, lane, PacketType::Mix)
|
||||||
recipient,
|
.await
|
||||||
data,
|
|
||||||
reply_surbs,
|
|
||||||
lane,
|
|
||||||
PacketType::Mix,
|
|
||||||
mix_hops,
|
|
||||||
)
|
|
||||||
.await
|
|
||||||
}
|
}
|
||||||
InputMessage::Reply {
|
InputMessage::Reply {
|
||||||
recipient_tag,
|
recipient_tag,
|
||||||
@@ -153,9 +135,8 @@ where
|
|||||||
recipient,
|
recipient,
|
||||||
data,
|
data,
|
||||||
lane,
|
lane,
|
||||||
mix_hops,
|
|
||||||
} => {
|
} => {
|
||||||
self.handle_plain_message(recipient, data, lane, packet_type, mix_hops)
|
self.handle_plain_message(recipient, data, lane, packet_type)
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
InputMessage::Anonymous {
|
InputMessage::Anonymous {
|
||||||
@@ -163,17 +144,9 @@ where
|
|||||||
data,
|
data,
|
||||||
reply_surbs,
|
reply_surbs,
|
||||||
lane,
|
lane,
|
||||||
mix_hops,
|
|
||||||
} => {
|
} => {
|
||||||
self.handle_repliable_message(
|
self.handle_repliable_message(recipient, data, reply_surbs, lane, packet_type)
|
||||||
recipient,
|
.await
|
||||||
data,
|
|
||||||
reply_surbs,
|
|
||||||
lane,
|
|
||||||
packet_type,
|
|
||||||
mix_hops,
|
|
||||||
)
|
|
||||||
.await
|
|
||||||
}
|
}
|
||||||
InputMessage::Reply {
|
InputMessage::Reply {
|
||||||
recipient_tag,
|
recipient_tag,
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ use self::{
|
|||||||
sent_notification_listener::SentNotificationListener,
|
sent_notification_listener::SentNotificationListener,
|
||||||
};
|
};
|
||||||
use crate::client::inbound_messages::InputMessageReceiver;
|
use crate::client::inbound_messages::InputMessageReceiver;
|
||||||
use crate::client::packet_statistics_control::PacketStatisticsReporter;
|
|
||||||
use crate::client::real_messages_control::message_handler::MessageHandler;
|
use crate::client::real_messages_control::message_handler::MessageHandler;
|
||||||
use crate::client::replies::reply_controller::ReplyControllerSender;
|
use crate::client::replies::reply_controller::ReplyControllerSender;
|
||||||
use crate::spawn_future;
|
use crate::spawn_future;
|
||||||
@@ -70,7 +69,6 @@ pub(crate) struct PendingAcknowledgement {
|
|||||||
message_chunk: Fragment,
|
message_chunk: Fragment,
|
||||||
delay: SphinxDelay,
|
delay: SphinxDelay,
|
||||||
destination: PacketDestination,
|
destination: PacketDestination,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PendingAcknowledgement {
|
impl PendingAcknowledgement {
|
||||||
@@ -79,13 +77,11 @@ impl PendingAcknowledgement {
|
|||||||
message_chunk: Fragment,
|
message_chunk: Fragment,
|
||||||
delay: SphinxDelay,
|
delay: SphinxDelay,
|
||||||
recipient: Recipient,
|
recipient: Recipient,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
PendingAcknowledgement {
|
PendingAcknowledgement {
|
||||||
message_chunk,
|
message_chunk,
|
||||||
delay,
|
delay,
|
||||||
destination: PacketDestination::KnownRecipient(recipient.into()),
|
destination: PacketDestination::KnownRecipient(recipient.into()),
|
||||||
mix_hops,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -102,9 +98,6 @@ impl PendingAcknowledgement {
|
|||||||
recipient_tag,
|
recipient_tag,
|
||||||
extra_surb_request,
|
extra_surb_request,
|
||||||
},
|
},
|
||||||
// Messages sent using SURBs are using the number of mix hops set by the recipient when
|
|
||||||
// they provided the SURBs, so it doesn't make sense to include it here.
|
|
||||||
mix_hops: None,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -209,7 +202,6 @@ where
|
|||||||
connectors: AcknowledgementControllerConnectors,
|
connectors: AcknowledgementControllerConnectors,
|
||||||
message_handler: MessageHandler<R>,
|
message_handler: MessageHandler<R>,
|
||||||
reply_controller_sender: ReplyControllerSender,
|
reply_controller_sender: ReplyControllerSender,
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
let (retransmission_tx, retransmission_rx) = mpsc::unbounded();
|
let (retransmission_tx, retransmission_rx) = mpsc::unbounded();
|
||||||
|
|
||||||
@@ -226,7 +218,6 @@ where
|
|||||||
Arc::clone(&ack_key),
|
Arc::clone(&ack_key),
|
||||||
connectors.ack_receiver,
|
connectors.ack_receiver,
|
||||||
connectors.ack_action_sender.clone(),
|
connectors.ack_action_sender.clone(),
|
||||||
stats_tx,
|
|
||||||
);
|
);
|
||||||
|
|
||||||
// will listen for any new messages from the client
|
// will listen for any new messages from the client
|
||||||
|
|||||||
+1
-8
@@ -49,18 +49,12 @@ where
|
|||||||
packet_recipient: Recipient,
|
packet_recipient: Recipient,
|
||||||
chunk_data: Fragment,
|
chunk_data: Fragment,
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) -> Result<PreparedFragment, PreparationError> {
|
) -> Result<PreparedFragment, PreparationError> {
|
||||||
debug!("retransmitting normal packet...");
|
debug!("retransmitting normal packet...");
|
||||||
|
|
||||||
// TODO: Figure out retransmission packet type signaling
|
// TODO: Figure out retransmission packet type signaling
|
||||||
self.message_handler
|
self.message_handler
|
||||||
.try_prepare_single_chunk_for_sending(
|
.try_prepare_single_chunk_for_sending(packet_recipient, chunk_data, packet_type)
|
||||||
packet_recipient,
|
|
||||||
chunk_data,
|
|
||||||
packet_type,
|
|
||||||
mix_hops,
|
|
||||||
)
|
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -95,7 +89,6 @@ where
|
|||||||
**recipient,
|
**recipient,
|
||||||
timed_out_ack.message_chunk.clone(),
|
timed_out_ack.message_chunk.clone(),
|
||||||
packet_type,
|
packet_type,
|
||||||
timed_out_ack.mix_hops,
|
|
||||||
)
|
)
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-2
@@ -40,7 +40,7 @@ impl SentNotificationListener {
|
|||||||
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 SentNotificationListener with graceful shutdown support");
|
debug!("Started SentNotificationListener with graceful shutdown support");
|
||||||
|
|
||||||
loop {
|
while !shutdown.is_shutdown() {
|
||||||
tokio::select! {
|
tokio::select! {
|
||||||
frag_id = self.sent_notifier.next() => match frag_id {
|
frag_id = self.sent_notifier.next() => match frag_id {
|
||||||
Some(frag_id) => {
|
Some(frag_id) => {
|
||||||
@@ -53,7 +53,6 @@ impl SentNotificationListener {
|
|||||||
},
|
},
|
||||||
_ = shutdown.recv_with_delay() => {
|
_ = shutdown.recv_with_delay() => {
|
||||||
log::trace!("SentNotificationListener: Received shutdown");
|
log::trace!("SentNotificationListener: Received shutdown");
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -418,10 +418,9 @@ where
|
|||||||
message: Vec<u8>,
|
message: Vec<u8>,
|
||||||
lane: TransmissionLane,
|
lane: TransmissionLane,
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) -> Result<(), PreparationError> {
|
) -> Result<(), PreparationError> {
|
||||||
let message = NymMessage::new_plain(message);
|
let message = NymMessage::new_plain(message);
|
||||||
self.try_split_and_send_non_reply_message(message, recipient, lane, packet_type, mix_hops)
|
self.try_split_and_send_non_reply_message(message, recipient, lane, packet_type)
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -431,7 +430,6 @@ where
|
|||||||
recipient: Recipient,
|
recipient: Recipient,
|
||||||
lane: TransmissionLane,
|
lane: TransmissionLane,
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) -> Result<(), PreparationError> {
|
) -> Result<(), PreparationError> {
|
||||||
debug!("Sending non-reply message with packet type {packet_type}");
|
debug!("Sending non-reply message with packet type {packet_type}");
|
||||||
// TODO: I really dislike existence of this assertion, it implies code has to be re-organised
|
// TODO: I really dislike existence of this assertion, it implies code has to be re-organised
|
||||||
@@ -463,7 +461,6 @@ where
|
|||||||
&self.config.ack_key,
|
&self.config.ack_key,
|
||||||
&recipient,
|
&recipient,
|
||||||
packet_type,
|
packet_type,
|
||||||
mix_hops,
|
|
||||||
)?;
|
)?;
|
||||||
|
|
||||||
let real_message = RealMessage::new(
|
let real_message = RealMessage::new(
|
||||||
@@ -471,8 +468,7 @@ where
|
|||||||
Some(fragment.fragment_identifier()),
|
Some(fragment.fragment_identifier()),
|
||||||
);
|
);
|
||||||
let delay = prepared_fragment.total_delay;
|
let delay = prepared_fragment.total_delay;
|
||||||
let pending_ack =
|
let pending_ack = PendingAcknowledgement::new_known(fragment, delay, recipient);
|
||||||
PendingAcknowledgement::new_known(fragment, delay, recipient, mix_hops);
|
|
||||||
|
|
||||||
real_messages.push(real_message);
|
real_messages.push(real_message);
|
||||||
pending_acks.push(pending_ack);
|
pending_acks.push(pending_ack);
|
||||||
@@ -489,7 +485,6 @@ where
|
|||||||
recipient: Recipient,
|
recipient: Recipient,
|
||||||
amount: u32,
|
amount: u32,
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) -> Result<(), PreparationError> {
|
) -> Result<(), PreparationError> {
|
||||||
debug!("Sending additional reply SURBs with packet type {packet_type}");
|
debug!("Sending additional reply SURBs with packet type {packet_type}");
|
||||||
let sender_tag = self.get_or_create_sender_tag(&recipient);
|
let sender_tag = self.get_or_create_sender_tag(&recipient);
|
||||||
@@ -506,7 +501,6 @@ where
|
|||||||
recipient,
|
recipient,
|
||||||
TransmissionLane::AdditionalReplySurbs,
|
TransmissionLane::AdditionalReplySurbs,
|
||||||
packet_type,
|
packet_type,
|
||||||
mix_hops,
|
|
||||||
)
|
)
|
||||||
.await?;
|
.await?;
|
||||||
|
|
||||||
@@ -523,7 +517,6 @@ where
|
|||||||
num_reply_surbs: u32,
|
num_reply_surbs: u32,
|
||||||
lane: TransmissionLane,
|
lane: TransmissionLane,
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) -> Result<(), SurbWrappedPreparationError> {
|
) -> Result<(), SurbWrappedPreparationError> {
|
||||||
debug!("Sending message with reply SURBs with packet type {packet_type}");
|
debug!("Sending message with reply SURBs with packet type {packet_type}");
|
||||||
let sender_tag = self.get_or_create_sender_tag(&recipient);
|
let sender_tag = self.get_or_create_sender_tag(&recipient);
|
||||||
@@ -534,7 +527,7 @@ where
|
|||||||
let message =
|
let message =
|
||||||
NymMessage::new_repliable(RepliableMessage::new_data(message, sender_tag, reply_surbs));
|
NymMessage::new_repliable(RepliableMessage::new_data(message, sender_tag, reply_surbs));
|
||||||
|
|
||||||
self.try_split_and_send_non_reply_message(message, recipient, lane, packet_type, mix_hops)
|
self.try_split_and_send_non_reply_message(message, recipient, lane, packet_type)
|
||||||
.await?;
|
.await?;
|
||||||
|
|
||||||
log::trace!("storing {} reply keys", reply_keys.len());
|
log::trace!("storing {} reply keys", reply_keys.len());
|
||||||
@@ -548,7 +541,6 @@ where
|
|||||||
recipient: Recipient,
|
recipient: Recipient,
|
||||||
chunk: Fragment,
|
chunk: Fragment,
|
||||||
packet_type: PacketType,
|
packet_type: PacketType,
|
||||||
mix_hops: Option<u8>,
|
|
||||||
) -> Result<PreparedFragment, PreparationError> {
|
) -> Result<PreparedFragment, PreparationError> {
|
||||||
debug!("Sending single chunk with packet type {packet_type}");
|
debug!("Sending single chunk with packet type {packet_type}");
|
||||||
let topology_permit = self.topology_access.get_read_permit().await;
|
let topology_permit = self.topology_access.get_read_permit().await;
|
||||||
@@ -562,7 +554,6 @@ where
|
|||||||
&self.config.ack_key,
|
&self.config.ack_key,
|
||||||
&recipient,
|
&recipient,
|
||||||
packet_type,
|
packet_type,
|
||||||
mix_hops,
|
|
||||||
)
|
)
|
||||||
.unwrap();
|
.unwrap();
|
||||||
|
|
||||||
|
|||||||
@@ -35,8 +35,6 @@ use crate::client::replies::reply_controller;
|
|||||||
use crate::config;
|
use crate::config;
|
||||||
pub(crate) use acknowledgement_control::{AckActionSender, Action};
|
pub(crate) use acknowledgement_control::{AckActionSender, Action};
|
||||||
|
|
||||||
use super::packet_statistics_control::PacketStatisticsReporter;
|
|
||||||
|
|
||||||
pub(crate) mod acknowledgement_control;
|
pub(crate) mod acknowledgement_control;
|
||||||
pub(crate) mod message_handler;
|
pub(crate) mod message_handler;
|
||||||
pub(crate) mod real_traffic_stream;
|
pub(crate) mod real_traffic_stream;
|
||||||
@@ -145,7 +143,6 @@ impl RealMessagesController<OsRng> {
|
|||||||
reply_controller_receiver: ReplyControllerReceiver,
|
reply_controller_receiver: ReplyControllerReceiver,
|
||||||
lane_queue_lengths: LaneQueueLengths,
|
lane_queue_lengths: LaneQueueLengths,
|
||||||
client_connection_rx: ConnectionCommandReceiver,
|
client_connection_rx: ConnectionCommandReceiver,
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
let rng = OsRng;
|
let rng = OsRng;
|
||||||
|
|
||||||
@@ -184,7 +181,6 @@ impl RealMessagesController<OsRng> {
|
|||||||
ack_controller_connectors,
|
ack_controller_connectors,
|
||||||
message_handler.clone(),
|
message_handler.clone(),
|
||||||
reply_controller_sender,
|
reply_controller_sender,
|
||||||
stats_tx.clone(),
|
|
||||||
);
|
);
|
||||||
|
|
||||||
let reply_control = ReplyController::new(
|
let reply_control = ReplyController::new(
|
||||||
@@ -203,7 +199,6 @@ impl RealMessagesController<OsRng> {
|
|||||||
topology_access,
|
topology_access,
|
||||||
lane_queue_lengths,
|
lane_queue_lengths,
|
||||||
client_connection_rx,
|
client_connection_rx,
|
||||||
stats_tx,
|
|
||||||
);
|
);
|
||||||
|
|
||||||
RealMessagesController {
|
RealMessagesController {
|
||||||
|
|||||||
@@ -3,7 +3,6 @@
|
|||||||
|
|
||||||
use self::sending_delay_controller::SendingDelayController;
|
use self::sending_delay_controller::SendingDelayController;
|
||||||
use crate::client::mix_traffic::BatchMixMessageSender;
|
use crate::client::mix_traffic::BatchMixMessageSender;
|
||||||
use crate::client::packet_statistics_control::{PacketStatisticsEvent, PacketStatisticsReporter};
|
|
||||||
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;
|
||||||
@@ -114,9 +113,6 @@ where
|
|||||||
|
|
||||||
/// Report queue lengths so that upstream can backoff sending data, and keep connections open.
|
/// Report queue lengths so that upstream can backoff sending data, and keep connections open.
|
||||||
lane_queue_lengths: LaneQueueLengths,
|
lane_queue_lengths: LaneQueueLengths,
|
||||||
|
|
||||||
/// Channel used for sending statistics events to `PacketStatisticsControl`.
|
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
@@ -175,7 +171,6 @@ where
|
|||||||
topology_access: TopologyAccessor,
|
topology_access: TopologyAccessor,
|
||||||
lane_queue_lengths: LaneQueueLengths,
|
lane_queue_lengths: LaneQueueLengths,
|
||||||
client_connection_rx: ConnectionCommandReceiver,
|
client_connection_rx: ConnectionCommandReceiver,
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
OutQueueControl {
|
OutQueueControl {
|
||||||
config,
|
config,
|
||||||
@@ -189,7 +184,6 @@ where
|
|||||||
transmission_buffer: TransmissionBuffer::new(),
|
transmission_buffer: TransmissionBuffer::new(),
|
||||||
client_connection_rx,
|
client_connection_rx,
|
||||||
lane_queue_lengths,
|
lane_queue_lengths,
|
||||||
stats_tx,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -220,7 +214,7 @@ where
|
|||||||
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, packet_size) = 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();
|
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");
|
trace!("the next loop cover message will be put in a {cover_traffic_packet_size} packet");
|
||||||
@@ -256,28 +250,15 @@ where
|
|||||||
"Somehow failed to generate a loop cover message with a valid topology",
|
"Somehow failed to generate a loop cover message with a valid topology",
|
||||||
),
|
),
|
||||||
None,
|
None,
|
||||||
cover_traffic_packet_size.size(),
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
StreamMessage::Real(real_message) => {
|
StreamMessage::Real(real_message) => {
|
||||||
let packet_size = real_message.packet_size();
|
(real_message.mix_packet, real_message.fragment_id)
|
||||||
(
|
|
||||||
real_message.mix_packet,
|
|
||||||
real_message.fragment_id,
|
|
||||||
packet_size,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
if let Err(err) = self.mix_tx.send(vec![next_message]).await {
|
if let Err(err) = self.mix_tx.send(vec![next_message]).await {
|
||||||
log::error!("Failed to send: {err}");
|
log::error!("Failed to send: {err}");
|
||||||
} else {
|
|
||||||
let event = if fragment_id.is_some() {
|
|
||||||
PacketStatisticsEvent::RealPacketSent(packet_size)
|
|
||||||
} else {
|
|
||||||
PacketStatisticsEvent::CoverPacketSent(packet_size)
|
|
||||||
};
|
|
||||||
self.stats_tx.report(event);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// notify ack controller about sending our message only after we actually managed to push it
|
// notify ack controller about sending our message only after we actually managed to push it
|
||||||
@@ -359,28 +340,6 @@ where
|
|||||||
let lane_length = self.transmission_buffer.lane_length(&lane);
|
let lane_length = self.transmission_buffer.lane_length(&lane);
|
||||||
self.lane_queue_lengths.set(&lane, lane_length);
|
self.lane_queue_lengths.set(&lane, lane_length);
|
||||||
|
|
||||||
// This is the last step in the pipeline where we know the type of the message, so
|
|
||||||
// lets count the number of retransmissions and reply surb messages sent here.
|
|
||||||
let stat_event = match lane {
|
|
||||||
TransmissionLane::General => None,
|
|
||||||
TransmissionLane::ConnectionId(_) => None,
|
|
||||||
TransmissionLane::ReplySurbRequest => {
|
|
||||||
Some(PacketStatisticsEvent::ReplySurbRequestQueued)
|
|
||||||
}
|
|
||||||
TransmissionLane::AdditionalReplySurbs => {
|
|
||||||
Some(PacketStatisticsEvent::AdditionalReplySurbRequestQueued)
|
|
||||||
}
|
|
||||||
TransmissionLane::Retransmission => Some(PacketStatisticsEvent::RetransmissionQueued),
|
|
||||||
};
|
|
||||||
if let Some(stat_event) = stat_event {
|
|
||||||
self.stats_tx.report(stat_event);
|
|
||||||
}
|
|
||||||
// To avoid comparing apples to oranges when presenting the fraction of packets that are
|
|
||||||
// retransmissions, we also need to keep track to the total number of real messages queued,
|
|
||||||
// even though we also track the actual number of messages sent later in the pipeline.
|
|
||||||
self.stats_tx
|
|
||||||
.report(PacketStatisticsEvent::RealPacketQueued);
|
|
||||||
|
|
||||||
Some(real_next)
|
Some(real_next)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -474,13 +433,6 @@ where
|
|||||||
Poll::Ready(Some((real_messages, conn_id))) => {
|
Poll::Ready(Some((real_messages, conn_id))) => {
|
||||||
log::trace!("handling real_messages: size: {}", real_messages.len());
|
log::trace!("handling real_messages: size: {}", real_messages.len());
|
||||||
|
|
||||||
// This is the last step in the pipeline where we know the type of the message, so
|
|
||||||
// lets count the number of retransmissions here.
|
|
||||||
if conn_id == TransmissionLane::Retransmission {
|
|
||||||
self.stats_tx
|
|
||||||
.report(PacketStatisticsEvent::RetransmissionQueued);
|
|
||||||
}
|
|
||||||
|
|
||||||
// First store what we got for the given connection id
|
// First store what we got for the given connection id
|
||||||
self.transmission_buffer.store(&conn_id, real_messages);
|
self.transmission_buffer.store(&conn_id, real_messages);
|
||||||
let real_next = self.pop_next_message().expect("we just added one");
|
let real_next = self.pop_next_message().expect("we just added one");
|
||||||
@@ -519,10 +471,10 @@ where
|
|||||||
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.traffic.disable_main_poisson_packet_distribution {
|
||||||
format!("Packet backlog: {backlog:.2} kiB ({packets}), {lanes} lanes, no delay")
|
format!("Status: {lanes} lanes, backlog: {backlog:.2} kiB ({packets}), no delay")
|
||||||
} else {
|
} else {
|
||||||
format!(
|
format!(
|
||||||
"Packet backlog: {backlog:.2} kiB ({packets}), {lanes} lanes, avg delay: {delay}ms ({mult})"
|
"Status: {lanes} lanes, backlog: {backlog:.2} kiB ({packets}), avg delay: {delay}ms ({mult})"
|
||||||
)
|
)
|
||||||
};
|
};
|
||||||
if packets > 1000 {
|
if packets > 1000 {
|
||||||
@@ -548,12 +500,11 @@ where
|
|||||||
{
|
{
|
||||||
let mut status_timer = tokio::time::interval(Duration::from_secs(5));
|
let mut status_timer = tokio::time::interval(Duration::from_secs(5));
|
||||||
|
|
||||||
loop {
|
while !shutdown.is_shutdown() {
|
||||||
tokio::select! {
|
tokio::select! {
|
||||||
biased;
|
biased;
|
||||||
_ = shutdown.recv_with_delay() => {
|
_ = shutdown.recv_with_delay() => {
|
||||||
log::trace!("OutQueueControl: Received shutdown");
|
log::trace!("OutQueueControl: Received shutdown");
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
_ = status_timer.tick() => {
|
_ = status_timer.tick() => {
|
||||||
self.log_status(&mut shutdown);
|
self.log_status(&mut shutdown);
|
||||||
|
|||||||
@@ -1,10 +1,8 @@
|
|||||||
// Copyright 2021 - 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
|
||||||
|
|
||||||
use crate::client::{
|
use crate::client::replies::reply_controller::ReplyControllerSender;
|
||||||
packet_statistics_control::{PacketStatisticsEvent, PacketStatisticsReporter},
|
use crate::client::replies::reply_storage::SentReplyKeys;
|
||||||
replies::{reply_controller::ReplyControllerSender, reply_storage::SentReplyKeys},
|
|
||||||
};
|
|
||||||
use crate::spawn_future;
|
use crate::spawn_future;
|
||||||
use futures::channel::mpsc;
|
use futures::channel::mpsc;
|
||||||
use futures::lock::Mutex;
|
use futures::lock::Mutex;
|
||||||
@@ -45,33 +43,15 @@ struct ReceivedMessagesBufferInner<R: MessageReceiver> {
|
|||||||
// but perhaps it should be changed to include timestamps of when the message was reconstructed
|
// but perhaps it should be changed to include timestamps of when the message was reconstructed
|
||||||
// and every now and then remove ids older than X
|
// and every now and then remove ids older than X
|
||||||
recently_reconstructed: HashSet<i32>,
|
recently_reconstructed: HashSet<i32>,
|
||||||
|
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<R: MessageReceiver> ReceivedMessagesBufferInner<R> {
|
impl<R: MessageReceiver> ReceivedMessagesBufferInner<R> {
|
||||||
fn recover_from_fragment(
|
fn recover_from_fragment(&mut self, fragment_data: &[u8]) -> Option<NymMessage> {
|
||||||
&mut self,
|
|
||||||
fragment_data: &[u8],
|
|
||||||
fragment_data_size: usize,
|
|
||||||
) -> 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");
|
||||||
// NOTE: it's important to note that there is quite a bit of difference in size of
|
|
||||||
// received and sent packets due to the sphinx layers being removed by the exit gateway
|
|
||||||
// before it reaches the mixnet client.
|
|
||||||
self.stats_tx
|
|
||||||
.report(PacketStatisticsEvent::CoverPacketReceived(
|
|
||||||
fragment_data_size,
|
|
||||||
));
|
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
|
|
||||||
self.stats_tx
|
|
||||||
.report(PacketStatisticsEvent::RealPacketReceived(
|
|
||||||
fragment_data_size,
|
|
||||||
));
|
|
||||||
|
|
||||||
let fragment = match self.message_receiver.recover_fragment(fragment_data) {
|
let fragment = match self.message_receiver.recover_fragment(fragment_data) {
|
||||||
Err(err) => {
|
Err(err) => {
|
||||||
warn!("failed to recover fragment from raw data: {err}. The whole underlying message might be corrupted and unrecoverable!");
|
warn!("failed to recover fragment from raw data: {err}. The whole underlying message might be corrupted and unrecoverable!");
|
||||||
@@ -123,17 +103,15 @@ impl<R: MessageReceiver> ReceivedMessagesBufferInner<R> {
|
|||||||
reply_ciphertext: &mut [u8],
|
reply_ciphertext: &mut [u8],
|
||||||
reply_key: SurbEncryptionKey,
|
reply_key: SurbEncryptionKey,
|
||||||
) -> Result<Option<NymMessage>, MessageRecoveryError> {
|
) -> Result<Option<NymMessage>, MessageRecoveryError> {
|
||||||
let reply_ciphertext_size = reply_ciphertext.len();
|
|
||||||
// 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, reply_ciphertext_size))
|
Ok(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> {
|
||||||
let raw_fragment_size = raw_fragment.len();
|
|
||||||
let fragment_data = match self.message_receiver.recover_plaintext_from_regular_packet(
|
let fragment_data = match self.message_receiver.recover_plaintext_from_regular_packet(
|
||||||
self.local_encryption_keypair.private_key(),
|
self.local_encryption_keypair.private_key(),
|
||||||
&mut raw_fragment,
|
&mut raw_fragment,
|
||||||
@@ -145,7 +123,7 @@ impl<R: MessageReceiver> ReceivedMessagesBufferInner<R> {
|
|||||||
Ok(frag_data) => frag_data,
|
Ok(frag_data) => frag_data,
|
||||||
};
|
};
|
||||||
|
|
||||||
self.recover_from_fragment(fragment_data, raw_fragment_size)
|
self.recover_from_fragment(fragment_data)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -163,7 +141,6 @@ impl<R: MessageReceiver> ReceivedMessagesBuffer<R> {
|
|||||||
local_encryption_keypair: Arc<encryption::KeyPair>,
|
local_encryption_keypair: Arc<encryption::KeyPair>,
|
||||||
reply_key_storage: SentReplyKeys,
|
reply_key_storage: SentReplyKeys,
|
||||||
reply_controller_sender: ReplyControllerSender,
|
reply_controller_sender: ReplyControllerSender,
|
||||||
stats_tx: PacketStatisticsReporter,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
ReceivedMessagesBuffer {
|
ReceivedMessagesBuffer {
|
||||||
inner: Arc::new(Mutex::new(ReceivedMessagesBufferInner {
|
inner: Arc::new(Mutex::new(ReceivedMessagesBufferInner {
|
||||||
@@ -172,7 +149,6 @@ impl<R: MessageReceiver> ReceivedMessagesBuffer<R> {
|
|||||||
message_receiver: R::new(),
|
message_receiver: R::new(),
|
||||||
message_sender: None,
|
message_sender: None,
|
||||||
recently_reconstructed: HashSet::new(),
|
recently_reconstructed: HashSet::new(),
|
||||||
stats_tx,
|
|
||||||
})),
|
})),
|
||||||
reply_key_storage,
|
reply_key_storage,
|
||||||
reply_controller_sender,
|
reply_controller_sender,
|
||||||
@@ -377,7 +353,7 @@ impl<R: MessageReceiver> ReceivedMessagesBuffer<R> {
|
|||||||
};
|
};
|
||||||
|
|
||||||
if let Some(completed) = completed_message {
|
if let Some(completed) = completed_message {
|
||||||
debug!("received {completed}");
|
info!("received {completed}");
|
||||||
completed_messages.push(completed)
|
completed_messages.push(completed)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -504,13 +480,11 @@ impl<R: MessageReceiver + Clone + Send + 'static> ReceivedMessagesBufferControll
|
|||||||
mixnet_packet_receiver: MixnetMessageReceiver,
|
mixnet_packet_receiver: MixnetMessageReceiver,
|
||||||
reply_key_storage: SentReplyKeys,
|
reply_key_storage: SentReplyKeys,
|
||||||
reply_controller_sender: ReplyControllerSender,
|
reply_controller_sender: ReplyControllerSender,
|
||||||
packet_statistics_reporter: PacketStatisticsReporter,
|
|
||||||
) -> Self {
|
) -> Self {
|
||||||
let received_buffer = ReceivedMessagesBuffer::new(
|
let received_buffer = ReceivedMessagesBuffer::new(
|
||||||
local_encryption_keypair,
|
local_encryption_keypair,
|
||||||
reply_key_storage,
|
reply_key_storage,
|
||||||
reply_controller_sender,
|
reply_controller_sender,
|
||||||
packet_statistics_reporter,
|
|
||||||
);
|
);
|
||||||
|
|
||||||
ReceivedMessagesBufferController {
|
ReceivedMessagesBufferController {
|
||||||
|
|||||||
@@ -516,7 +516,6 @@ where
|
|||||||
recipient,
|
recipient,
|
||||||
to_send,
|
to_send,
|
||||||
nym_sphinx::params::PacketType::Mix,
|
nym_sphinx::params::PacketType::Mix,
|
||||||
self.config.reply_surbs.surb_mix_hops,
|
|
||||||
)
|
)
|
||||||
.await
|
.await
|
||||||
{
|
{
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user