updating nyx section

2024-09-26 18:16:57 +02:00
parent 393bbc188e
commit 4fa3bd4b72
6 changed files with 31 additions and 6 deletions
@@ -1,6 +1,12 @@
+import { Callout } from 'nextra/components'
+
 # Mixnet Nodes

-> The node setup and maintenance guides can be found in the [Operator Guides book](../../operators/index).
+<Callout type="info" emoji="ℹ️">
+
+If you want to run a node, the setup and maintenance guides can be found in the [Operator Guides book](../../operators/index).
+
+</Callout>

 Although a large proportion of the Nym mixnet's functionality is implemented client-side, several key anonymity features rely on the decentralised node network that make up the Mixnet.

@@ -1,4 +1,5 @@
 {
  "validator": "Validators",
+  "nym-api": "(Coming soon) NymAPI",
  "smart-contracts": "Smart Contracts"
 }
@@ -2,7 +2,8 @@

 The Nyx blockchain is based on [CosmWasm](https://cosmwasm.com/).

-TODO ADD ECASH CONTRACT INFO
-There are currently two smart contracts on the Nyx chain:
-* the [Mixnet contract](./mixnet-contract.md) which manages the network topology of the mixnet, tracking delegations and rewarding.
-* the [Vesting contract](./vesting-contract.md) which manages `NYM` token vesting functionality.
+The following contracts are deployed to the chain:
+* the [Mixnet contract](./mixnet-contract.md) which manages the network topology of the mixnet and tracks delegations & rewarding.
+* the [Vesting contract](./vesting-contract.md) which manages `NYM` token vesting functionality. This will soon be deprecated.
+* the [Quorum Multisig](./multisig.md) used by the subset of the Nyx Validators that generate and validate [zk-nyms](../../cryptography/zk-nym) to manage reward payouts for nodes.
+* the [zk-nym contract](./ecash.md) which keeps track of `NYM` deposits used as payment for zk-nym generation.
@@ -0,0 +1,8 @@
+NOTE the contract repo is called 'ecash' from back in the day: this is the contract that is responsible fr zk-nyms tho
+
+functions - these are controlled by the multisig:
+- get blacklisted
+- set blacklisted
+- deposit funds for tickets (called by zk-nym payment backend)
+- propose to redeem tickets (gws call this)
+- execute proposals (multisig)
@@ -0,0 +1,5 @@
+# Multisig Contract
+
+The multisig contract used by the [NymAPI Quroum]() - a subset of the Nyx Validator set taking on the additional work of generating and validating zk-nyms - to execute certain actions in the [zk-nym](./ecash.md) contract.
+
+It is essentially an instance of the [canonical](https://github.com/CosmWasm/cw-plus/tree/main/contracts) `cw3-flex-multisig` using the `cw4-group` contract, with one minor change to restrict the addresses allowed to submit proposals.
@@ -1,6 +1,10 @@
+import { Callout } from 'nextra/components'
+
 # Validators

-> The validator setup and maintenance guide has moved to the [Operator Guides book](https://nymtech.net/operators/nodes/validator-setup.html).
+<Callout type="info" emoji="ℹ️">
+The validator setup and maintenance guide has moved to the [Operator Guides book](../../operators/index).
+</Callout>

 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.