Update README.md

ping-pub · Sep 9, 2023 · 13112b9 · 13112b9
1 parent 026947a
commit 13112b9
Showing 1 changed file with 103 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 <div align="center">
 
-![Ping Wallet](./public/logo.svg)
+![Ping Wallet](https://github.com/ping-pub/explorer/raw/master/public/logo.svg)
 
 <h1>Ping Dashboard</h1>
 
 **Ping Dashboard is not only an explorer but also a wallet and more ... 🛠**
 
 [![version](https://img.shields.io/github/tag/ping-pub/ping.pub.svg)](https://github.com/ping-pub/explorer/releases/latest)
 [![GitHub](https://img.shields.io/github/license/ping-pub/ping.pub.svg)](https://github.com/ping-pub/explorer/blob/master/LICENSE)
-[![Ping Deploy](https://github.com/ping-pub/ping.pub/actions/workflows/mainnet-deploy.yaml/badge.svg)](https://github.com/ping-pub/ping.pub/actions/workflows/mainnet-deploy.yaml)
+[![Ping Deploy](https://github.com/ping-pub/ping.pub/actions/workflows/deploy.yaml/badge.svg)](https://github.com/ping-pub/ping.pub/actions/workflows/deploy.yaml)
 [![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/bukotsunikki.svg?style=social&label=Follow%20%40ping_pub)](https://twitter.com/ping_pub)
 [![https://discord.gg/CmjYVSr6GW](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/CmjYVSr6GW)
 
@@ -35,15 +35,110 @@ Your donation will help us make better products. Thanks in advance.
 0x88BFec573Dd3E4b7d2E6BfD4D0D6B11F843F8aa1
 ```
 
-#### Donations from project
+# Directory Layout
+
+**We accept all blockchains which have 10+ independent validators.**
+
+- Submit configs for mainnet, go to https://github.com/ping-pub/ping.pub/tree/main/chains/mainnet
+
+- Submit configs for testnet, go to https://github.com/ping-pub/ping.pub/tree/main/chains/testnet
+
+# Sample of Config
+
+```json
+{
+    "chain_name": "cosmos",
+    "api": [
+        {
+            "address": "https://cosmos.api.ping.pub", 
+            "provider": "Ping"
+        }
+    ], 
+    "rpc": [
+        {
+            "address": "https://cosmos.api.ping.pub", 
+            "provider": "Ping"
+        }
+    ],
+    "sdk_version": "0.42.6",
+    "coin_type": "118",
+    "min_tx_fee": "800",
+    "assets": [{
+        "base": "uatom",
+        "symbol": "ATOM",
+        "exponent": "6",
+        "coingecko_id": "cosmos", 
+        "logo": "https://dl.airtable.com/.attachments/e54f814bba8c0f9af8a3056020210de0/2d1155fb/cosmos-hub.svg"
+    }],
+    "addr_prefix": "cosmos",
+    "theme_color": "#ce4747",
+    "logo": "https://dl.airtable.com/.attachments/e54f814bba8c0f9af8a3056020210de0/2d1155fb/cosmos-hub.svg"
+}
+```
+- **chain_name** the name to identify the chain on ping.pub, would be better to use the same one as registry
+- **api** the rest api endpoint.(make sure that CORS is enabled: `Allow-Control-Allow-Origin: *`)
+- **rpc** the rpc endpoint, make sure that the port is added. rpc endpoint is only used for state sync. it's optional.
+- **assets** Native Assets on blockchain. 
+
+Endpoint providers will be listed in the "Popular" tab of the staking.
+
+# Token Unit conversion
+
+We have two methods to load token metadata for token unit conversion:
+
+## Loading from a REST endpoint (recommended).
+
+you can define the metadata in the `bank` -> `metadata` section of the blockchain's genesis file. if you don't define, the `[]` will return.
+
+```json
+{
+  "name": "atom",
+  "description": "The native staking token of the Cosmos Hub.",
+  "denom_units": [
+    {
+      "denom": "uatom",
+      "exponent": 0,
+      "aliases": [
+        "microatom"
+      ],
+    },
+    {
+      "denom": "matom",
+      "exponent": 3,
+      "aliases": [
+        "milliatom"
+      ]
+    },
+    {
+      "denom": "atom",
+      "exponent": 6,
+    }
+  ],
+  "base": "uatom",
+  "display": "atom",
+}
+```
+you can see more details here:
+https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-024-coin-metadata.md
+
+## Loading from Cosmos Registry:
 
-- Point Network: 1000USDC and $1000 worth of POINT
-- Bitsong: 50k BTSG
-- IRISnet: 100k IRIS
+https://github.com/cosmos/chain-registry
 
-## Hire us
+# Test 
 
-You can hire us by submiting an issue and fund the issue on [IssueHunter](https://issuehunt.io/r/ping-pub/explorer)
+please add these check points in comments with your PR, and adding your test result by clicking the checkbox of each line
+```
+Test Result:
+- [ ] Connect wallet, check if address is correct? 
+- [ ] Transfer
+- [ ] Delegate
+- [ ] Redelegate
+- [ ] Unbond
+- [ ] withdraw Validator's Commission
+- [ ] withdraw Rewards
+```
+Test is very important for us and our users.