From 2ef4c89f2b7de6d779fb1a51d47e6fa68ae9eacb Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Thu, 26 Sep 2024 18:20:16 +0200 Subject: [PATCH] note on where to find deployed info --- .../network/architecture/nyx/smart-contracts/ecash.md | 2 ++ .../architecture/nyx/smart-contracts/mixnet-contract.md | 2 +- .../network/architecture/nyx/smart-contracts/multisig.md | 3 +++ .../architecture/nyx/smart-contracts/vesting-contract.md | 9 ++++----- 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/documentation/docs/pages/network/architecture/nyx/smart-contracts/ecash.md b/documentation/docs/pages/network/architecture/nyx/smart-contracts/ecash.md index e1a082e9c5..a9ff414add 100644 --- a/documentation/docs/pages/network/architecture/nyx/smart-contracts/ecash.md +++ b/documentation/docs/pages/network/architecture/nyx/smart-contracts/ecash.md @@ -1,3 +1,5 @@ +# Zk-Nym Contract + 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: diff --git a/documentation/docs/pages/network/architecture/nyx/smart-contracts/mixnet-contract.md b/documentation/docs/pages/network/architecture/nyx/smart-contracts/mixnet-contract.md index 8120b4ab25..7b4baa8bbf 100644 --- a/documentation/docs/pages/network/architecture/nyx/smart-contracts/mixnet-contract.md +++ b/documentation/docs/pages/network/architecture/nyx/smart-contracts/mixnet-contract.md @@ -11,4 +11,4 @@ The Mixnet contract has multiple functions: * storing delegation and bond amounts. * storing reward amounts. -The addresses of deployed smart contracts can be found in the [`network-defaults`](https://github.com/nymtech/nym/blob/master/common/network-defaults/src/mainnet.rs) directory of the codebase alongside other network default values. +> The addresses of deployed smart contracts can be found in the [`network-defaults`](https://github.com/nymtech/nym/blob/master/common/network-defaults/src/mainnet.rs) directory of the codebase alongside other network default values. diff --git a/documentation/docs/pages/network/architecture/nyx/smart-contracts/multisig.md b/documentation/docs/pages/network/architecture/nyx/smart-contracts/multisig.md index 97eb02d8fd..d407983150 100644 --- a/documentation/docs/pages/network/architecture/nyx/smart-contracts/multisig.md +++ b/documentation/docs/pages/network/architecture/nyx/smart-contracts/multisig.md @@ -3,3 +3,6 @@ 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. + + +> The addresses of deployed smart contracts can be found in the [`network-defaults`](https://github.com/nymtech/nym/blob/master/common/network-defaults/src/mainnet.rs) directory of the codebase alongside other network default values. diff --git a/documentation/docs/pages/network/architecture/nyx/smart-contracts/vesting-contract.md b/documentation/docs/pages/network/architecture/nyx/smart-contracts/vesting-contract.md index cbc5bfbcee..9c3a676eeb 100644 --- a/documentation/docs/pages/network/architecture/nyx/smart-contracts/vesting-contract.md +++ b/documentation/docs/pages/network/architecture/nyx/smart-contracts/vesting-contract.md @@ -1,11 +1,10 @@ # Vesting Contract -The vesting contract allows for the creation of vesting accounts, allowing `NYM` tokens to vest over time, and for users to minimally interact with the Mixnet using their unvested tokens. You can find the code and build instructions [here](https://github.com/nymtech/nym/tree/master/contracts/vesting). +The vesting contract allows for the creation of vesting accounts, allowing `NYM` tokens to vest over time, and for users to minimally interact with the Mixnet using their unvested tokens. You can find the code and build instructions [here](https://github.com/nymtech/nym/tree/master/contracts/vesting). -### Functionality +### Functionality The Vesting contract has multiple functions: * Creating and storing vesting `NYM` token vesting accounts. -* Interacting with the Mixnet using vesting (i.e. non-transferable) tokens, allowing users to delegate their unvested tokens. - -The addresses of deployed smart contracts can be found in the [`network-defaults`](https://github.com/nymtech/nym/blob/master/common/network-defaults/src/mainnet.rs) directory of the codebase alongside other network default values. +* Interacting with the Mixnet using vesting (i.e. non-transferable) tokens, allowing users to delegate their unvested tokens. +> The addresses of deployed smart contracts can be found in the [`network-defaults`](https://github.com/nymtech/nym/blob/master/common/network-defaults/src/mainnet.rs) directory of the codebase alongside other network default values.