mfahampshire
cfcf804b47
* add semver validator action * update runner * update runner with sed for old version in CI * Add no commit to publish for the moment * fix version bump command * configure git bot * error check * make dryrun less opaque * Reintroduce error check - keep logging dryrun in for debug (commented out) * fix grep check * bring non-dry-run to parity * add node for npx semver check to action * updated sed command * revert erroneous version bump * added semver check to publish workflow * allow from other branches * allow from other branches again * publishing guide * update publication runner * Release 1.20.3 nym-api-requests@1.20.3 nym-async-file-watcher@1.20.3 nym-authenticator-requests@1.20.3 nym-bandwidth-controller@1.20.3 nym-bin-common@1.20.3 nym-cache@1.20.3 nym-cli-commands@1.20.3 nym-client-core@1.20.3 nym-client-core-config-types@1.20.3 nym-client-core-gateways-storage@1.20.3 nym-client-core-surb-storage@1.20.3 nym-client-websocket-requests@1.20.3 nym-coconut-dkg-common@1.20.3 nym-common@1.20.3 nym-compact-ecash@1.20.3 nym-config@1.20.3 nym-contracts-common@1.20.3 nym-contracts-common-testing@1.20.3 nym-cpp-ffi@1.20.3 nym-credential-proxy-lib@1.20.3 nym-credential-proxy-requests@1.20.3 nym-credential-storage@1.20.3 nym-credential-utils@1.20.3 nym-credential-verification@1.20.3 nym-credentials@1.20.3 nym-credentials-interface@1.20.3 nym-crypto@1.20.3 nym-dkg@1.20.3 nym-ecash-contract-common@1.20.3 nym-ecash-signer-check@1.20.3 nym-ecash-signer-check-types@1.20.3 nym-ecash-time@1.20.3 nym-exit-policy@1.20.3 nym-ffi-shared@1.20.3 nym-gateway-client@1.20.3 nym-gateway-requests@1.20.3 nym-gateway-stats-storage@1.20.3 nym-gateway-storage@1.20.3 nym-go-ffi@1.20.3 nym-group-contract-common@1.20.3 nym-http-api-client@1.20.3 nym-http-api-client-macro@1.20.3 nym-http-api-common@1.20.3 nym-id@1.20.3 nym-inclusion-probability@1.20.3 nym-ip-packet-client@1.20.3 nym-ip-packet-requests@1.20.3 nym-metrics@1.20.3 nym-mixnet-client@1.20.3 nym-mixnet-contract-common@1.20.3 nym-mixnode-common@1.20.3 nym-multisig-contract-common@1.20.3 nym-network-defaults@1.20.3 nym-node-metrics@1.20.3 nym-node-requests@1.20.3 nym-node-tester-utils@1.20.3 nym-noise@1.20.3 nym-noise-keys@1.20.3 nym-nonexhaustive-delayqueue@1.20.3 nym-ordered-buffer@1.20.3 nym-outfox@1.20.3 nym-pemstore@1.20.3 nym-performance-contract-common@1.20.3 nym-pool-contract-common@1.20.3 nym-registration-common@1.20.3 nym-sdk@1.20.3 nym-serde-helpers@1.20.3 nym-service-provider-requests-common@1.20.3 nym-service-providers-common@1.20.3 nym-socks5-client-core@1.20.3 nym-socks5-proxy-helpers@1.20.3 nym-socks5-requests@1.20.3 nym-sphinx@1.20.3 nym-sphinx-acknowledgements@1.20.3 nym-sphinx-addressing@1.20.3 nym-sphinx-anonymous-replies@1.20.3 nym-sphinx-chunking@1.20.3 nym-sphinx-cover@1.20.3 nym-sphinx-forwarding@1.20.3 nym-sphinx-framing@1.20.3 nym-sphinx-params@1.20.3 nym-sphinx-routing@1.20.3 nym-sphinx-types@1.20.3 nym-sqlx-pool-guard@1.20.3 nym-statistics-common@1.20.3 nym-store-cipher@1.20.3 nym-task@1.20.3 nym-test-utils@1.20.3 nym-ticketbooks-merkle@1.20.3 nym-topology@1.20.3 nym-tun@1.20.3 nym-types@1.20.3 nym-upgrade-mode-check@1.20.3 nym-validator-client@1.20.3 nym-verloc@1.20.3 nym-vesting-contract-common@1.20.3 nym-wasm-client-core@1.20.3 nym-wasm-storage@1.20.3 nym-wasm-utils@1.20.3 nym-wireguard@1.20.3 nym-wireguard-private-metadata-client@1.20.3 nym-wireguard-private-metadata-server@1.20.3 nym-wireguard-private-metadata-shared@1.20.3 nym-wireguard-private-metadata-tests@1.20.3 nym-wireguard-types@1.20.3 nyxd-scraper-shared@1.20.3 Generated by cargo-workspaces * remove --allow-branch ; no commit, doesn't need branch restrictions * remove another clashing flag * again * exclude build.rs from crate for crates.io * various in process scripts to pick up deployment where it left off * rename workflows * Version bump fix from borked publish run * add publishing doc + updated publish-resume ci * move example from service-providers to sdk examples/ to remove circular dev dependency for cargo publication * remove wildcard version import * Workflows and documentation for publication * add contracts/ patch + imports * Reintroduce missing kkt dep from rebase * fix borked rebase cargo lock --------- Co-authored-by: Nym bot <nym-bot@users.noreply.github.com>
The Nym Privacy Platform
The platform is composed of multiple Rust crates. Top-level executable binary crates include:
nym-node- a tool for running a node within the Nym network. Nym Nodes containing functionality such asmixnode,entry-gatewayandexit-gatewayare fundamental components of Nym Mixnet architecture. Nym Nodes are ran by decentralised node operators. Read more aboutnym-nodein Operators Guide documentation. Network functionality ofnym-node(labeled with--modeflag) can be:mixnode- shuffles Sphinx packets together to provide privacy against network-level attackers.gateway- acts sort of like a mailbox for mixnet messages, which removes the need for direct delivery to potentially offline or firewalled devices. Gateways can be further categorized asentry-gatewayandexit-gateway. The latter has an extra embedded IP packet router and Network requester to route data to the internet.
nym-client- an executable which you can build into your own applications. Use it for interacting with Nym nodes.nym-socks5-client- a Socks5 proxy you can run on your machine and use with existing applications.nym-explorer- a (projected) block explorer and (existing) mixnet viewer.nym-wallet- a desktop wallet implemented using the Tauri) framework.nym-cli- a tool for interacting with the network from the CLI.
┌─►mix──┐ mix mix
│ │
Entry │ │ Exit
client ───► Gateway ──┘ mix │ mix ┌─►mix ───► Gateway ───► internet
│ │
│ │
mix └─►mix──┘ mix
Building
- Platform build instructions are available on Nym Operators Guide documentation.
- Wallet build instructions are available here.
Developing
References for developers:
Developer chat
You can chat to us in the #dev channel on Matrix or on the Nym Forum.
Tokenomics & Rewards
Nym network economic incentives, operator and validator rewards, and scalability of the network are determined according to the principles laid out in the section 6 of Nym Whitepaper. Initial reward pool is set to 250 million Nym, making the circulating supply 750 million Nym.
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.
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
Nym Node Operators and Validators Terms and Conditions can be found here.
Getting Started
yarn install
yarn build