diff --git a/documentation/docs/src/images/nym-token-flow.png b/documentation/docs/src/images/nym-token-flow.png new file mode 100644 index 0000000000..eb026e2325 Binary files /dev/null and b/documentation/docs/src/images/nym-token-flow.png differ diff --git a/documentation/docs/src/nodes/gateway.md b/documentation/docs/src/nodes/gateway.md index ad2da8e8ca..ebdae64574 100644 --- a/documentation/docs/src/nodes/gateway.md +++ b/documentation/docs/src/nodes/gateway.md @@ -1,6 +1,6 @@ # Gateways -> The gateway setup and maintenance guide has migrated to the [Operator Guides book](TO_DO). +> The gateway setup and maintenance guide has migrated to the [Operator Guides book](https://nymtech.net/operators/nodes/gateway-setup.html). Gateways are key to both the usability of the mixnet, and the operation of the mixnet's tokenomics. They serve two main functions: * (When the mixnet is no longer in 'free' mode) to act literally as gateways; checking for zkNym credentials (previously referred to as [Coconut Credentials](../bandwidth-credentials.md)) that prove a user has paid to send traffic through the mixnet. A % of the worth of these credentials will be distributed to the operator of the gateway periodically as payment for providing their service. The more credentials user clients 'spend' with them (because of their quality of service) the higher the rewards. The rest of this value will be sent to the Mixmining Pool, a pool of tokens from which `NYM` rewards are distributed to mix node operators. @@ -9,4 +9,4 @@ Gateways are key to both the usability of the mixnet, and the operation of the m ## Further Reading * TODO whitepaper section * TODO loopix paper section -* TODO blogpost \ No newline at end of file +* TODO blogpost diff --git a/documentation/docs/src/nodes/mixnode.md b/documentation/docs/src/nodes/mixnode.md index 14e42a54b9..2d1911a990 100644 --- a/documentation/docs/src/nodes/mixnode.md +++ b/documentation/docs/src/nodes/mixnode.md @@ -1,6 +1,6 @@ # Mix Nodes -> The mix node setup and maintenance guide has migrated to the [Operator Guides book](TO_DO). +> The mix node setup and maintenance guide has migrated to the [Operator Guides book](https://nymtech.net/developers/nodes/mix-node-setup.html). Mix nodes are the backbone of the mixnet. These are the nodes that perform 'mix mining', otherwise known simply as 'mixing' or performing the 'poisson mix'. diff --git a/documentation/docs/src/nodes/network-requester.md b/documentation/docs/src/nodes/network-requester.md index 747efbe62a..83778e18a4 100644 --- a/documentation/docs/src/nodes/network-requester.md +++ b/documentation/docs/src/nodes/network-requester.md @@ -1,6 +1,6 @@ # Network Requesters -> The network requester setup and maintenance guide has moved to the [Operator Guides book](TO_DO). +> The network requester setup and maintenance guide has moved to the [Operator Guides book](https://nymtech.net/developers/nodes/network-requester-setup.html). Network requesters are the first instance of the catch-all term 'service', or 'service providers'. In essence, think of services as being the part of the mixnet infrastructure that let you _do_ something, such as access emails, messaging service backends, or blockchains via the mixnet. diff --git a/documentation/docs/src/nodes/validator.md b/documentation/docs/src/nodes/validator.md index 0ef86744a8..ac3d896bca 100644 --- a/documentation/docs/src/nodes/validator.md +++ b/documentation/docs/src/nodes/validator.md @@ -1,12 +1,25 @@ +- [x] TODO section of whitepaper +- [x] TODO blogpost +- [ ] TODO gaias link(s) + # Validators -> The validator setup and maintenance guide has moved to the [Operator Guides book](TO_DO). +> The validator setup and maintenance guide has moved to the [Operator Guides book](https://nymtech.net/operators/nodes/validator-setup.html). -Validators secure the Nyx blockchain via Proof of Stake consensus. The Nyx validators are run via the `nyxd` binary ([codebase](https://github.com/nymtech/nyxd)), maintaining a CosmWasm- and IBC-enabled blockchain. +> We are currently working towards building up a closed set of reputable validators. You can ask us for coins to get in, but please don't be offended if we say no - validators are part of our system's core security and we are starting out with people we already know or who have a solid reputation. + + +Validators secure the Nyx blockchain via Proof of Stake consensus. The Nyx blockchain records the ledger of NYM transactions and executes the smart contracts for distributing NYM rewards. The Nyx validators are run via the `nyxd` binary ([codebase](https://github.com/nymtech/nyxd)), maintaining a CosmWasm- and IBC-enabled blockchain. The blockchain plays a supporting but fundamental role in the mixnet: the `NYM` token used to incentivise node operators is one of two native tokens of the chain, and the chain is where the [Mixnet](../nyx/mixnet-contract.md) and [Vesting](../nyx/vesting-contract.md) smart contracts are deployed. +![Nym Token Flow](../images/nym-token-flow.png) + ## Further Reading -* TODO section of whitepaper -* TODO blogpost -* TODO gaiad link(s) \ No newline at end of file + +* Detailed info on Nyx Validators and token flow can be found in [Nym Reward Sharing for Mixnets document](https://nymtech.net/nym-cryptoecon-paper.pdf) in section 2.3 and 2.4. +* For more detailed calculation, read our blog post [Nym Token Economics update](https://blog.nymtech.net/nym-token-economics-update-fedff0ed5267). +* More info on staking can be found [here](https://blog.nymtech.net/staking-in-nym-introducing-mainnet-mixmining-f9bb1cbc7c36). +* [Here](https://blog.nymtech.net/want-to-stake-in-nym-here-is-how-to-choose-a-mix-node-to-delegate-nym-to-c3b862add165) is more info on how to choose a mix node for delegation. +* Our [quarterly update](https://blog.nymtech.net/quarterly-token-economic-parameter-update-b2862948710f) on token economics from July 2023. + diff --git a/documentation/operators/src/nodes/maintenance.md b/documentation/operators/src/nodes/maintenance.md index 7ffe1d6d58..05723461f2 100644 --- a/documentation/operators/src/nodes/maintenance.md +++ b/documentation/operators/src/nodes/maintenance.md @@ -7,7 +7,8 @@ TODO - copy that dir over to the new vps - re-run init - remember that init doesn't overwrite existing keys - to generate a config with the new listening address etc - change the node info via the wallet - - Since otherwise their keys will point to the old IP address in the smart contract, and their node will (a) not be able to be connected to, and (b) fail uptime checks + - Since otherwise their keys will point to the old IP address in the smart contract, and their node will (a) not be able to be connected to, and (b) fail uptime checks +- [ ] Test the scp -3 command in the moving a node section ---> ## Useful commands diff --git a/documentation/operators/src/preliminary-steps.md b/documentation/operators/src/preliminary-steps.md index d36ca76da4..ec13e7ea59 100644 --- a/documentation/operators/src/preliminary-steps.md +++ b/documentation/operators/src/preliminary-steps.md @@ -1,6 +1,6 @@ # Preliminary Steps -> The Nym `mix node`, `gateway` and `network-requester` binaries were built in the [building nym](../binaries/building-nym.md) section. If you haven't yet built Nym and want to run the code, go there first. +> The Nym `mix node`, `gateway` and `network-requester` binaries were built in the [building nym](./binaries/building-nym.md) section. If you haven't yet built Nym and want to run the code, go there first. ## Preliminary steps