Merge pull request #159 from gnosischain/127-validators

Revamp Validator Docs
gnosischain · Nov 23, 2022 · f6c3512 · f6c3512
2 parents 1ca876b + 07edf86
commit f6c3512
Show file tree

Hide file tree

Showing 107 changed files with 4,820 additions and 1,174 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,7 @@ build
 yarn.lock
 .obsidian
 docs/.obsidian
+
+#remote files copied in build time
+#see "docusaurus-plugin-remote-content" sections in "docusaurus.config.js" file
+docs/node/guide/validator/generate-keys-cli-tool/README.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -131,34 +131,6 @@ Message
 ```
 Refer to [docusaurus docs](https://docusaurus.io/docs/next/markdown-features/admonitions) for more admonition types.
 
-### Files
-
-#### Gitbook
-
-```
-{% file src="somepath/somefile.zip" %}
-```
-
-#### Docusaurus
-
-```
-{@file: /somefile.zip}
-```
-Place files in ```/static/files/```
-
-### Youtube Videos
-
-#### Gitbook
-
-```
-{% embed url="https://www.youtube.com/watch?v=yPYYKz0u9K0t=10s" %}
-```
-
-#### Docusaurus
-
-```
-{@youtube: yPYYKz0u9K0t,start=10}
-```
 
 ### Tabs
 

diff --git a/docs/about/networks/README.md b/docs/about/networks/README.md
@@ -1,7 +1,7 @@
 ---
 ---
 
-# Networks Summary
+# Networks
 
 | Network Name       | Gnosis (mainnet)                  | Chiado (testnet)                          |
 |--------------------|-----------------------------------|-------------------------------------------|

diff --git a/docs/about/networks/chiado.md b/docs/about/networks/chiado.md
@@ -30,7 +30,8 @@ Image: Trams in Lisbon (credit: [Lisa Fotios](https://www.pexels.com/photo/peopl
 ### How to Participate
 
 * [Nethermind Sedge](https://docs.sedge.nethermind.io/) can generate the [Docker Compose files for Chiado](https://docs.sedge.nethermind.io/docs/quickstart/chiado)
-* (Here be Dragons): If you can get your hands on Testnet GNO on Chiado, you will need to interact with the [deposit contract](https://blockscout.chiadochain.net/address/0xc5be8bf53755a41c2385e7aa86f6a9e28746f466) programmatically, or deploy your own [Deposit UI](https://github.com/gnosischain/gbc-deposit-ui) with the updated config files
+* (Here by Dragons): If you can get your hands on Testnet GNO on Chiado, you will need to interact with the [deposit contract](https://blockscout.chiadochain.net/address/0xc5be8bf53755a41c2385e7aa86f6a9e28746f466) programmatically, or deploy your own [Deposit UI](/node/guide/validator/deposit#depositing-for-chiado-testnet) with the updated config files
+
 ## Summary
 ### Key Infra
 
@@ -68,9 +69,9 @@ To mimic Ethereum-Gnosis conditions, Chiado uses a "Testnet GNO" token that is i
 | Token                  | Address                                                                                                                             |
 | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
 | Testnet GNO on Goerli  | [0x7f477c3f03213970d939104cc436dc995cf615b5](https://goerli.etherscan.io/address/0x7f477c3f03213970d939104cc436dc995cf615b5)        |
-| Testnet GNO on Chiado  | [0xf907903Be10FC3a885d331C4E225794436a34c9f](https://blockscout.chiadochain.net/address/0xf907903Be10FC3a885d331C4E225794436a34c9f) |
+| Testnet GNO on Chiado  | [0x19C653Da7c37c66208fbfbE8908A5051B57b4C70](https://blockscout.chiadochain.net/address/0x19C653Da7c37c66208fbfbE8908A5051B57b4C70) |
 | Testnet mGNO on Chiado | [0xc5be8bf53755a41c2385e7aa86f6a9e28746f466](https://blockscout.chiadochain.net/address/0xc5be8bf53755a41c2385e7aa86f6a9e28746f466) |
-| Deposit Contract       | [0xb97036A26259B7147018913bD58a774cf91acf25](https://blockscout.chiadochain.net/address/0xc5be8bf53755a41c2385e7aa86f6a9e28746f466) |
+| Deposit Contract       | [0xb97036A26259B7147018913bD58a774cf91acf25](https://blockscout.chiadochain.net/address/0xb97036A26259B7147018913bD58a774cf91acf25) |
 
 ## Network Config
 ### Config Repo

diff --git a/docs/about/networks/mainnet.md b/docs/about/networks/mainnet.md
@@ -10,4 +10,139 @@ title: Mainnet
   - [ ] Native asset
 - [ ] Include links to User Guide
   - [ ] Add to Metamask
-  - [ ] Supported wallets
+  - [ ] Supported wallets
+
+:::danger
+
+Chiado is current **in-development** and is not ready for public participation. 
+
+Please wait for Core Devs to release official Chiado images before attempting to run a Chiado validator.
+
+:::
+
+## Overview
+
+* Chiado is a Gnosis testnet that is scheduled for launch in Q4 2022. 
+* Chiado's primary purpose is to test "The Merge", Gnosis' transition from [Proof-of-Authority](../../specs/consensus/aura.md) to the [Beacon Chain](../../specs/consensus/gbc.md). 
+* Post-Merge, Chiado will transition to a long-running testnet for developers. 
+* Chiado is named after the [Chiado metro station](https://en.wikipedia.org/wiki/Baixa-Chiado_(Lisbon_Metro)) in Lisbon, Portugal. 
+
+### Key Information
+
+| Network Name                   | Chiado                                                        |
+| ------------------------------ | ------------------------------------------------------------- |
+| Native (fee) token             | Chiado-xDAI                                                   |
+| Staking token                  | Chiado-GNO                                                    |
+| Chain ID                       | 10200                                                         |
+| Execution Layer RPC (Archival) | https://rpc.eu-central-2.gateway.fm/v3/gnosis/archival/chiado |
+| Execution Layer RPC            | https://rpc.chiadochain.net                                   |
+| Execution Layer Explorer       | https://blockscout.chiadochain.net                            |
+| Consensus Layer Explorer       | https://beacon.chiadochain.net/                               |
+| Fork monitor                   | https://forkmon.chiadochain.net/                              |
+| EthStats                       | https://ethstats.chiadochain.net/                             |
+| Faucet                         | https://gnosisfaucet.com                                      |
+
+### Key Parameters
+| Param             | Value        |
+| ----------------- | ------------ |
+| Slot Time         | 5s           |
+| Epoch             | 16 slots     |
+| Finalization Time | 2.7 min      |
+| Staking Deposit   | 1 GNO on Chiado |
+
+## Tokens
+
+### Fee Token
+
+* Name: xDai on Chiado
+* Type: Native Asset
+### Staking Token [^1]
+
+To mimic Ethereum-Gnosis conditions, Chiado uses a "GNO" token that is isseud on Goerli and bridged over via the AMB.
+
+| Token            | Address                                                                                                                             |
+| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| Testnet GNO on Goerli    | [0x7f477c3f03213970d939104cc436dc995cf615b5](https://goerli.etherscan.io/address/0x7f477c3f03213970d939104cc436dc995cf615b5)        |
+| Testnet GNO on Chiado    | [0x19C653Da7c37c66208fbfbE8908A5051B57b4C70](https://blockscout.chiadochain.net/address/0x19C653Da7c37c66208fbfbE8908A5051B57b4C70) |
+| Testnet mGNO on Chiado   | [0xc5be8bf53755a41c2385e7aa86f6a9e28746f466](https://blockscout.chiadochain.net/address/0xc5be8bf53755a41c2385e7aa86f6a9e28746f466) |
+| Deposit Contract | [0xb97036A26259B7147018913bD58a774cf91acf25](https://blockscout.chiadochain.net/address/0xb97036A26259B7147018913bD58a774cf91acf25) |
+
+## Network Config
+
+:::danger
+
+Chiado is current **in-development** and is not ready for public participation. 
+
+Please wait for Core Devs to release official Chiado images before attempting to run a Chiado validator.
+
+:::
+### Config Repo
+
+:::danger
+
+Warning! These are subject to further changes
+
+:::
+
+Gnosis maintains a [Configs Repo](https://github.com/gnosischain/configs/) that is the canonical source for Gnosis Chain networks. 
+
+### Consensus Layer
+
+:::danger
+
+Warning! These are subject to further changes
+
+:::
+
+* [config.yaml](https://github.com/gnosischain/configs/blob/main/chiado/config.yaml)
+* [genesis.ssz](https://github.com/gnosischain/configs/blob/main/chiado/genesis.ssz)
+* [GnosisDAO's Recommended Chiado CL Bootnodes](https://github.com/gnosischain/configs/blob/main/chiado/bootnodes.yaml)
+* [Nethermind's Recommended Chiado CL Bootnodes](https://github.com/NethermindEth/ansible-deployments/blob/main/chiado/inventory/data/bootnodes-beacon.json)
+
+### Execution Layer
+
+:::danger
+
+Warning! These are subject to further changes
+
+:::
+
+* [genesis.json](https://github.com/gnosischain/configs/blob/main/chiado/genesis.json)
+* [nethermind.cfg](https://github.com/gnosischain/configs/blob/main/chiado/nethermind.cfg)
+* [GnosisDAO's Recommended Chiado EL Bootnodes](https://github.com/gnosischain/consensus-deployment-ansible/blob/master/chiado/custom_config_data/bootnodes_execution.txt)
+* [Nethermind's Recommended Chiado EL Bootnodes](https://github.com/NethermindEth/ansible-deployments/blob/main/chiado/inventory/data/bootnodes-execution.json)
+
+## Key Contracts
+
+### Bridges [^2]
+| Contract                   | Address                                                                                                                             |
+| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| Chiado Omnibridge Mediator | [0x09D549a48AC52F3f9945E7de6402c609c92aa2E1](https://blockscout.chiadochain.net/address/0x09D549a48AC52F3f9945E7de6402c609c92aa2E1) |
+| Chiado AMB                 | [0x99Ca51a3534785ED619f46A79C7Ad65Fa8d85e7a](https://blockscout.chiadochain.net/address/0x99Ca51a3534785ED619f46A79C7Ad65Fa8d85e7a) |
+| Goerli Omnibridge Mediator | [0x00147c84f13764dCDAbAF1cbAe622fa6f6839085](https://goerli.etherscan.io/address/0x00147c84f13764dCDAbAF1cbAe622fa6f6839085)        |
+| Goerli AMB                 | [0x87A19d769D875964E9Cd41dDBfc397B2543764E](https://goerli.etherscan.io/address/0x87A19d769D875964E9Cd41dDBfc397B2543764E6)         |
+| Bridge Validator           | 0xc9ADb79B8A6e7C6e90c765A3B4d16d81213c9D49                                                                                          |
+
+### DApps
+
+| DApp      |     |
+| --------- | --- |
+| Uniswap   | TBD |
+| Chainlink | TBD |
+
+## Previous Iterations
+
+### Chiado 0.2
+
+TODO
+
+### Chiado 0.1
+
+TODO
+
+
+
+### Appendix
+
+[^1]: See [Github Issue on Chiado GNO Staking Contracts](https://github.com/gnosischain/pm/issues/100)
+[^2]: See [Github Issue on Goerli-Chiado Bridge Deployment](https://github.com/gnosischain/pm/issues/40)
diff --git a/docs/about/tokens/gno.md b/docs/about/tokens/gno.md
@@ -86,13 +86,13 @@ Check out [Chiado Testnet specs](/about/networks/chiado#gno-token) for more info
 
 #### mGNO token
 
-To create a more accurate ETH-mirrored environment, a minimum of 32 tokens are used for staking purposes on the Gnosis Beacon Chain. The mGNO token is a meta-token similar to a wrapped token created for this purpose. During deposits, 1 GNO is automatically converted to 32 mGNO. Check the [deposit process](/node/validator-deposits) for more details.
+To create a more accurate ETH-mirrored environment, a minimum of 32 tokens are used for staking purposes on the Gnosis Beacon Chain. The mGNO token is a meta-token similar to a wrapped token created for this purpose. During deposits, 1 GNO is automatically converted to 32 mGNO. Check the [validator deposit process](../../node/guide/validator/deposit.md) for more details.
 
 - mGNO contract on Gnosis: [0x722fc4DAABFEaff81b97894fC623f91814a1BF68](https://gnosisscan.io/address/0x722fc4DAABFEaff81b97894fC623f91814a1BF68)
 
 #### Staking
 
-Stake your GNO tokens to secure Gnosis validating blocks as part of the PoS consensus. Check the [deposit process](/node/validator-deposits) for more details.
+Stake your GNO tokens to secure Gnosis validating blocks as part of the PoS consensus. Check the [validator deposit process](../../node/guide/validator/deposit.md) for more details.
 
 Liquid staking providers allow anyone to stake without running the infrastructure themselves. Check the [Stakewise](/tools/beacon-chain/liquid-staking#tokens-sgno--rgno) page for more details on sGNO and rGNO tokens.
 
@@ -102,7 +102,40 @@ Liquid staking providers allow anyone to stake without running the infrastructur
 - [GNO Utility and Value Proposition](https://forum.gnosis.io/t/gno-utility-and-value-proposition/2344)
 - [Community](/about/overview/community)
 
-
 ## GNO Token Audit
 
 - [GNO Token v2.0.0 Audit](https://hackmd.io/@verilog/gno-token-v2-audit) by Verilog Solutions
+
+
+## Converting GNO to mGNO
+
+::: note
+GNO is automatically wrapped by the deposit contract, you only need to do this to top off your balance. The following instructions use the older swap UI
+:::
+
+:::danger
+Note that currently there is not a mechanism to swap mGNO back to GNO.
+:::
+
+1\) Go to [https://deposit.gnosischain.com/](https://deposit.gnosischain.com) and connect your web3 wallet toGnosis on the application.
+
+In this example we use MetaMask.
+
+![](/img/node/UI-1A.png)
+
+![](/img/node/UI-2A.png)
+
+2\) Select the Swap tab. Enter the amount you would like to convert and click **Convert**. You can convert any amount, be sure to **start with a leading 0 to convert less than 1 GNO. For example, 0.1 GNO will be converted to 3.2 mGNO.**
+
+![](/img/node/swap-1.png)
+
+3\) Sign 2 transactions in your wallet. The first is a free signature request to allow the application to make the conversion.
+
+![](/img/node/pt2.png)
+
+The second processes the transaction. This will require a small amount of xDai to complete.
+
+![](/img/node/2tx.png)
+
+4\) The transaction should be initiated and completed within a few seconds. Once completed you can click the link to see the tx in BlockScout and add mGNO to your MetaMask wallet. The mGNO contract address is 0x722fc4DAABFEaff81b97894fC623f91814a1BF68.
+