GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added links

Browse Source
This commit is contained in:
mfahampshire
2023-08-07 15:52:48 +02:00
parent 2dd3e031bd
commit baebbe4e4d
3 changed files with 11 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/docs/src/nodes/gateway.md
+4 -5
View File
@@ -3,10 +3,9 @@
> 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.
* Act as a mailbox for connected clients. Clients create a lasting relationship with a gateway on initialisation, binding themselves to always use a particular gateway as their egress point for mixnet traffic, and always receive mixnet traffic from it (see the [mixnet traffic flow page](../architecture/traffic-flow.md) for further details). If a client is offline and the Gateway can't deliver packets addressed to it, they will hold these packets until the client comes back online.
* In the future (when the mixnet is no longer running in 'free to use' mode), to check for zkNym credentials (previously referred to as [Coconut Credentials](../bandwidth-credentials.md)) with which users can anonymously prove they have 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 the higher the rewards for the gateway operator and their delegators. 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.
* Act as a mailbox for connected clients. Clients create a lasting relationship with a gateway on initialisation, binding themselves to always use a particular gateway as their egress point for mixnet traffic, and always receive mixnet traffic from it (see the [mixnet traffic flow page](../architecture/traffic-flow.md) and the [addressing scheme](../clients/addressing-system.md) for further details). If a client is offline and the Gateway can't deliver packets addressed to it, they will hold these packets until the client comes back online.
## Further Reading
* TODO whitepaper section
* TODO loopix paper section
* TODO blogpost
* [Nym Whitepaper](https://nymtech.net/nym-whitepaper.pdf) section 4.2
* [Nym Blog: Gateways to Privacy](https://blog.nymtech.net/gateways-to-privacy-51196005bf5)
documentation/docs/src/nodes/mixnode.md
+6 -9
View File
@@ -2,19 +2,16 @@
> 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'.
Mix nodes are the backbone of the mixnet. These are the nodes that perform 'mix mining', otherwise known simply as 'mixing'.
Mix nodes perform one task: receiving packets, decrypting their outer 'layer', and holding them for a variable amount of time before passing them to their next destination - either another mix node, or a gateway. In doing so, they 'mix' packets by sending them to their next destination in a different order than they were recieved.
The aim of this mixing is to protect against timing-based deanonymisation attempts by a global adversary able to monitor the entire network with a 'God's Eye View'.
Mix nodes, after receiving a packet, decrypt its outer 'layer', and hold them for a variable amount of time before passing them to their next destination - either another mix node, or a gateway. In doing so, they 'mix' packets by sending them to their next destination in a different order than they were received.
Mix nodes are rewarded according to their quality of service, and their inclusion in the active set (i.e. the nodes that mix traffic for the next epoch) affected by this (as well as their delegation-based reputation - see [further reading](#further-reading) for more on this).
## (Coming soon) Mixing: a Step-by-Step Breakdown
## Further reading
TODO
* TODO SECTION OF WHITEPAPER
* TODO LOOPIX PAPER SECTION
* <LINK TO CODEBASE>
* <ANY VIDEOS>
* [Nym Whitepaper](https://nymtech.net/nym-whitepaper.pdf) section 4
* [Nym Blog: Mix node deepdive](https://blog.nymtech.net/nym-mixnodes-deep-dive-d2b91917f097)
* [Mixnet Traffic Flow overview](../architecture/traffic-flow.md)
* [Reward Sharing for Mixnets](https://nymtech.net/nym-cryptoecon-paper.pdf)
documentation/docs/src/nodes/validator.md
+1 -5
View File
@@ -1,6 +1,4 @@
- [x] TODO section of whitepaper
- [x] TODO blogpost
- [ ] TODO gaias link(s)
# Validators
@@ -8,7 +6,6 @@
> 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.
@@ -16,10 +13,9 @@ The blockchain plays a supporting but fundamental role in the mixnet: the `NYM`
![Nym Token Flow](../images/nym-token-flow.png)
## Further Reading
* 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.
* [Nym Whitepaper](https://nymtech.net/nym-whitepaper.pdf) section 3.1