docs: testnet faucet (#508)

* docs: testnet * link * link * docs: added faucet screenshot + updated the amount sent (#509) * buf * todos * latex Co-authored-by: Guillermo Paoletti <[email protected]>
evmos · Aug 30, 2021 · c6c9330 · c6c9330
1 parent 7b3ceec
commit c6c9330
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 22 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -141,11 +141,16 @@ module.exports = {
               directory: false,
               path: '/testnet/join'
             },
+            {
+              title: 'Token Faucet',
+              directory: false,
+              path: '/testnet/faucet'
+            },
             {
               title: 'Deploy Node on Cloud',
               directory: false,
               path: '/testnet/cloud_providers'
-            },
+            }
           ]
         },
         {

diff --git a/docs/basics/accounts.md b/docs/basics/accounts.md
@@ -35,7 +35,7 @@ There are 3 main types of HRP for the `Addresses`/`PubKeys` available by default
 
 |                    | Address bech32 Prefix | Pubkey bech32 Prefix | Curve           | Address byte length | Pubkey byte length |
 |--------------------|-----------------------|----------------------|-----------------|---------------------|--------------------|
-| Accounts           | `ethm`                | `ethmpub`             | `eth_secp256k1` | `20`                | `33` (compressed)  |
+| Accounts           | `ethm`                | `ethmpub`            | `eth_secp256k1` | `20`                | `33` (compressed)  |
 | Validator Operator | `ethmvaloper`         | `ethmvaloperpub`     | `eth_secp256k1` | `20`                | `33` (compressed)  |
 | Consensus Nodes    | `ethmvalcons`         | `ethmvalconspub`     | `ed25519`       | `20`                | `32`               |
 

diff --git a/docs/basics/tokens.md b/docs/basics/tokens.md
@@ -20,15 +20,11 @@ The denomination used for staking, governance and gas consumption on the EVM is
 
 Ethermint uses [Atto](https://en.wikipedia.org/wiki/Atto-) Photon as the base denomination to maintain parity with Ethereum.
 
-```
-1 photon = 1×10⁻¹⁸ aphoton
-```
+$$1 photon = 1 ~ * ~ 10^{18} aphoton$$
 
 This matches Ethereum denomination of:
 
-```
-1 ETH = 1x10⁻¹⁸ wei
-```
+$$1 ETH = 1 ~ * ~ 10^{18} wei$$
 
 ### EVM Tokens
 

diff --git a/docs/testnet/README.md b/docs/testnet/README.md
@@ -6,7 +6,8 @@ parent:
 
 # Testnet
 
-This section contains different client and API reference document.
+This section contains different documents for how to access and join the Ethermint testnets.
 
 1. [Join Testnet](./join)
+1. [Faucet](./faucet)
 1. [Cloud Providers](./cloud_providers)
diff --git a/docs/testnet/cloud_providers.md b/docs/testnet/cloud_providers.md
@@ -1,5 +1,5 @@
 <!--
-order: 2
+order: 3
 -->
 
 # Deploy Node on Cloud

diff --git a/docs/testnet/faucet.md b/docs/testnet/faucet.md
@@ -0,0 +1,32 @@
+<!--
+order: 2
+-->
+
+# Faucet
+
+Check how to obtain testnet tokens from the Ethermint faucet website {synopsis}
+
+## Requesting tokens
+
+You can request tokens for the testnet by using the Ethermint [faucet](https://ethermint.io/faucet).
+Simply fill in your address on the input field in bech32 (`ethm1...`) or hex (`0x...`) format.
+
+::: warning
+If you use your bech32 address, make sure you input the [account address](./../basics/accounts#addresses-and-public-keys) (`ethm1...`) and **NOT** the validator operator address (`ethmvaloper1...`)
+:::
+
+<!-- TODO: update with final website design -->
+![faucet site](./img/faucet_web_page.png)
+
+## Rate limits
+
+To prevent the faucet account from draining the available funds, the Ethermint testnet faucet
+imposes a maximum number of request for a period of time. By default the faucet service accepts 1
+request per day per address. All addresses **must** be authenticated using
+[Auth0](https://auth0.com/) before requesting tokens.
+
+<!-- TODO: add screenshots of authentication window -->
+
+## Amount
+
+For each request, the faucet transfers $1 ~ * ~ 10^{18}$ aphotons (i.e 1 Photon) to the given address.
diff --git a/docs/testnet/img/faucet_web_page.png b/docs/testnet/img/faucet_web_page.png
diff --git a/proto/buf.yaml b/proto/buf.yaml
@@ -14,17 +14,6 @@ lint:
     - RPC_RESPONSE_STANDARD_NAME
     - RPC_REQUEST_RESPONSE_UNIQUE
     - COMMENT_MESSAGE
-  ignore:
-    - tendermint
-    - gogoproto
-    - cosmos_proto
-    - google
-    - confio
 breaking:
   use:
-    - FILE
-  ignore:
-    - tendermint
-    - gogoproto
-    - cosmos_proto
-    - google
+    - FILE