diff --git a/documentation/docs/pages/network/_meta.json b/documentation/docs/pages/network/_meta.json index fe484849a7..3f4845974c 100644 --- a/documentation/docs/pages/network/_meta.json +++ b/documentation/docs/pages/network/_meta.json @@ -2,8 +2,8 @@ "index": "Introduction", "concepts": "Core Concepts", "architecture": "Architecture", - "cryptography": "Crypto", "traffic": "Traffic Flow", + "cryptography": "Crypto", "rewards": "Rewards", "---": { "type": "separator" diff --git a/documentation/docs/pages/network/architecture.mdx b/documentation/docs/pages/network/architecture.mdx new file mode 100644 index 0000000000..630eb45387 --- /dev/null +++ b/documentation/docs/pages/network/architecture.mdx @@ -0,0 +1,13 @@ +# Network Components + +The Nym platform knits together several privacy technologies, integrating them into a system of cooperating networked nodes in order to provide network-level privacy and metadata anonymity. + +The core components are: +* a **mixnet**, which encrypts and mixes Sphinx packet traffic so that it cannot be determined who is communicating with whom. Our mixnet is based on a modified version of the **Loopix TODO LINK** design. +* **Sphinx**, a way of transmitting armoured, layer-encrypted information packets which are indistinguishable from each other at a binary level. +* various **Nym clients** LINK which manage sending and receiving Sphinx packets, encrypting/decrypting traffic, and providing cover traffic TODO LINK to hide 'real' traffic timing. +* a privacy enhancing signature scheme called **zk-nym**, based on the Coconut and Ecash schemes. This allows a shift in thinking about resource access control, from an identity-based paradigm based on _who you are_ to a privacy-preserving paradigm based on _right to use_. +* A CosmWasm-enabled blockchain called **Nyx**, the home of the various smart contracts used by the mixnet. + +TODO REDO DIAGRAM +![Nym Platform](./images/nym-platform-dark.png) diff --git a/documentation/docs/pages/network/cryptography/sphinx.mdx b/documentation/docs/pages/network/cryptography/sphinx.mdx new file mode 100644 index 0000000000..3852ef7cfd --- /dev/null +++ b/documentation/docs/pages/network/cryptography/sphinx.mdx @@ -0,0 +1 @@ +[Sphinx](https://cypherpunks.ca/~iang/pubs/Sphinx_Oakland09.pdf) diff --git a/documentation/docs/pages/network/index.md b/documentation/docs/pages/network/index.md index 03c3797fa0..9b8f348be6 100644 --- a/documentation/docs/pages/network/index.md +++ b/documentation/docs/pages/network/index.md @@ -1,5 +1,11 @@ # Introduction - Nym's network documentation covering network architecture, node types, tokenomics, and crypto systems. -TODO INCLUDE SITEMAP COMPONENT FOR SUBDIR +## Technical Motivations for Nym +When you send data across the internet, it can be recorded by a wide range of observers: your ISP, internet infrastructure providers, large tech companies, and governments. + +Even if the content of a network request is encrypted, observers can still see that data was transmitted, its size, frequency of transmission, and gather metadata from unencrypted parts of the data (such as IP routing information). Adversaries may then combine all the leaked information to probabilistically de-anonymize users. + +The Nym mixnet provides very strong security guarantees against this sort of surveillance. It _packetises_ and _mixes_ together IP traffic from many users inside the _mixnet_. + +> If you're into comparisons, the Nym mixnet is conceptually similar to other systems such as Tor, but provides improved protections against end-to-end timing attacks which can de-anonymize users. When Tor was first fielded, in 2002, those kinds of attacks were regarded as science fiction. But the future is now here. diff --git a/documentation/docs/pages/network/rewards.mdx b/documentation/docs/pages/network/rewards.mdx index f04628f108..13c8d66fe2 100644 --- a/documentation/docs/pages/network/rewards.mdx +++ b/documentation/docs/pages/network/rewards.mdx @@ -4,6 +4,8 @@ Node operator and delegator rewards are determined according to the principles l Below is a TLDR of the variables and formulas involved in calculating these rewards per epoch. The initial reward pool contains 250 million NYM, leaving a circulating supply of 750 million NYM. +TODO FIX + |Symbol|Definition| |---|---| ||global share of rewards available, starts at 2% of the reward pool.