Update all chain documentation using document.sh script (#917)

akash-network · Nov 19, 2024 · 453f338 · 453f338
1 parent 8a706bd
commit 453f338
Show file tree

Hide file tree

Showing 195 changed files with 1,836 additions and 2,016 deletions.
diff --git a/agoric/README.MD b/agoric/README.MD
@@ -12,23 +12,26 @@
 ## Examples
 
 - Run on Akash with the [example deploy.yml](./deploy.yml)
-- Run locally using the [example docker-compose.yml](./docker-compose.yml)
+- Run with Docker using the [example docker-compose.yml](./docker-compose.yml)
 
 ## Chain information
 
-The [Cosmos Chain Registry](https://github.com/cosmos/chain-registry) publishes up to date chain info for Agoric.
+The [Cosmos Chain Registry](https://github.com/cosmos/chain-registry) publishes [up to date chain info](https://raw.githubusercontent.com/cosmos/chain-registry/master/agoric/chain.json) for Agoric.
 
-|Variable|Value|
-|---|---|
-|`CHAIN_JSON`|`https://raw.githubusercontent.com/cosmos/chain-registry/master/agoric/chain.json`|
+This will be used automatically unless overridden with the `CHAIN_JSON` variable (use `0` to disable).
 
 ## Polkachu Chain Services
 
-[Polkachu's Chain Services](https://www.polkachu.com/) make bootstrapping a node extremely easy. They provide live peers, statesync and pruned snapshots.
+[Polkachu's Chain Services](https://www.polkachu.com/) make bootstrapping a node extremely easy. They provide live peers, seeds, statesync, addrbooks and pruned snapshots among other features.
 
-Note you should choose between statesync and snapshot bootstrapping, snapshot will take precedence.
+The following configuration is available for Agoric nodes. [See the documentation](../README.md#polkachu-services) for more information.
 
 |Variable|Value|
 |---|---|
 |`P2P_POLKACHU`|`1`|
+|`P2P_SEEDS_POLKACHU`|`1`|
+|`P2P_PEERS_POLKACHU`|`1`|
 |`STATESYNC_POLKACHU`|`1`|
+|`ADDRBOOK_POLKACHU`|`1`|
+
+Polkachu also provide pruned snapshots for Agoric. Find the [latest snapshot](https://polkachu.com/tendermint_snapshots/akash) and apply it using the `SNAPSHOT_URL` variable.
diff --git a/agoric/deploy.yml b/agoric/deploy.yml
@@ -1,27 +1,24 @@
 ---
 version: "2.0"
-
 services:
   node:
     image: ghcr.io/akash-network/cosmos-omnibus:v0.4.33-agoric-agoric-upgrade-7-2
     env:
-      - MONIKER=node_1
-      - CHAIN_JSON=https://raw.githubusercontent.com/cosmos/chain-registry/master/agoric/chain.json
+      - MONIKER=Cosmos Omnibus Node
       - P2P_POLKACHU=1
       - STATESYNC_POLKACHU=1
+      - ADDRBOOK_POLKACHU=1
     expose:
       - port: 26657
-        as: 80
         to:
           - global: true
       - port: 26656
         to:
           - global: true
-    # params:
-    #   storage:
-    #     data:
-    #       mount: /root/.agoric
-
+    params: # remove for non-persistent storage
+      storage:
+        data:
+          mount: /root/.agoric
 profiles:
   compute:
     node:
@@ -31,12 +28,11 @@ profiles:
         memory:
           size: 8Gi
         storage:
-          size: 100Gi
-          # - size: 100Mi
-          # - name: data
-          #   size: 400Gi
-          #   attributes:
-          #     persistent: true
+          - size: 10Gi
+          - name: data # remove for non-persistent storage
+            size: 400Gi
+            attributes:
+              persistent: true
   placement:
     dcloud:
       attributes:
@@ -48,7 +44,6 @@ profiles:
         node:
           denom: uakt
           amount: 1000
-
 deployment:
   node:
     dcloud:

diff --git a/agoric/docker-compose.yml b/agoric/docker-compose.yml
@@ -1,16 +1,14 @@
-version: '3.4'
-
 services:
-  node_1:
+  node:
     image: ghcr.io/akash-network/cosmos-omnibus:v0.4.33-agoric-agoric-upgrade-7-2
     ports:
       - '26656:26656'
       - '26657:26657'
       - '1317:1317'
     environment:
-      - MONIKER=node_1
-      - CHAIN_JSON=https://raw.githubusercontent.com/cosmos/chain-registry/master/agoric/chain.json
+      - MONIKER=Cosmos Omnibus Node
       - P2P_POLKACHU=1
       - STATESYNC_POLKACHU=1
+      - ADDRBOOK_POLKACHU=1
     volumes:
       - ./node-data:/root/.agoric
diff --git a/akash/README.md b/akash/README.md
@@ -12,32 +12,35 @@
 ## Examples
 
 - Run on Akash with the [example deploy.yml](./deploy.yml)
-- Run locally using the [example docker-compose.yml](./docker-compose.yml)
+- Run with Docker using the [example docker-compose.yml](./docker-compose.yml)
 
 ## Chain information
 
-Akash provide up to date chain information in their [akash-network/net](https://github.com/akash-network/net) repository.
+The [Cosmos Chain Registry](https://github.com/cosmos/chain-registry) publishes [up to date chain info](https://raw.githubusercontent.com/cosmos/chain-registry/master/akash/chain.json) for Akash.
 
-|Variable|Value|
-|---|---|
-|`CHAIN_JSON`|`https://raw.githubusercontent.com/akash-network/net/main/mainnet/meta.json`|
+This will be used automatically unless overridden with the `CHAIN_JSON` variable (use `0` to disable).
 
 ## Suggested configuration
 
-Akash suggests setting a minimum gas price and using Fastsync v0.
+The following configuration is recommended for Akash nodes.
 
 |Variable|Value|
 |---|---|
-|`MINIMUM_GAS_PRICES`|`0.025uakt`|
+|`CHAIN_JSON`|`https://raw.githubusercontent.com/akash-network/net/main/mainnet/meta.json`|
 |`FASTSYNC_VERSION`|`v0`|
 
 ## Polkachu Chain Services
 
-[Polkachu's Chain Services](https://www.polkachu.com/) make bootstrapping a node extremely easy. They provide live peers, statesync and pruned snapshots.
+[Polkachu's Chain Services](https://www.polkachu.com/) make bootstrapping a node extremely easy. They provide live peers, seeds, statesync, addrbooks and pruned snapshots among other features.
 
-Note you should choose between statesync and snapshot bootstrapping, snapshot will take precedence.
+The following configuration is available for Akash nodes. [See the documentation](../README.md#polkachu-services) for more information.
 
 |Variable|Value|
 |---|---|
 |`P2P_POLKACHU`|`1`|
+|`P2P_SEEDS_POLKACHU`|`1`|
+|`P2P_PEERS_POLKACHU`|`1`|
 |`STATESYNC_POLKACHU`|`1`|
+|`ADDRBOOK_POLKACHU`|`1`|
+
+Polkachu also provide pruned snapshots for Akash. Find the [latest snapshot](https://polkachu.com/tendermint_snapshots/akash) and apply it using the `SNAPSHOT_URL` variable.
diff --git a/akash/deploy.yml b/akash/deploy.yml
@@ -1,29 +1,26 @@
 ---
 version: "2.0"
-
 services:
   node:
     image: ghcr.io/akash-network/cosmos-omnibus:v0.4.33-akash-v0.36.0
     env:
-      - MONIKER=my-moniker-1
+      - MONIKER=Cosmos Omnibus Node
       - CHAIN_JSON=https://raw.githubusercontent.com/akash-network/net/main/mainnet/meta.json
-      - MINIMUM_GAS_PRICES=0.025uakt
       - FASTSYNC_VERSION=v0
       - P2P_POLKACHU=1
       - STATESYNC_POLKACHU=1
+      - ADDRBOOK_POLKACHU=1
     expose:
       - port: 26657
-        as: 80
         to:
           - global: true
       - port: 26656
         to:
           - global: true
-    # params:
-    #   storage:
-    #     data:
-    #       mount: /root/.akash
-
+    params: # remove for non-persistent storage
+      storage:
+        data:
+          mount: /root/.akash
 profiles:
   compute:
     node:
@@ -33,13 +30,11 @@ profiles:
         memory:
           size: 8Gi
         storage:
-          size: 100Gi
-          # - size: 100Mi
-          # - name: data
-          #   size: 400Gi
-          #   attributes:
-          #     persistent: true
-
+          - size: 10Gi
+          - name: data # remove for non-persistent storage
+            size: 400Gi
+            attributes:
+              persistent: true
   placement:
     dcloud:
       attributes:
@@ -51,7 +46,6 @@ profiles:
         node:
           denom: uakt
           amount: 1000
-
 deployment:
   node:
     dcloud:

diff --git a/akash/docker-compose.yml b/akash/docker-compose.yml
@@ -1,18 +1,16 @@
-version: '3.4'
-
 services:
-  node_1:
+  node:
     image: ghcr.io/akash-network/cosmos-omnibus:v0.4.33-akash-v0.36.0
     ports:
       - '26656:26656'
       - '26657:26657'
       - '1317:1317'
     environment:
-      - MONIKER=node_1
+      - MONIKER=Cosmos Omnibus Node
       - CHAIN_JSON=https://raw.githubusercontent.com/akash-network/net/main/mainnet/meta.json
-      - MINIMUM_GAS_PRICES=0.025uakt
       - FASTSYNC_VERSION=v0
       - P2P_POLKACHU=1
       - STATESYNC_POLKACHU=1
+      - ADDRBOOK_POLKACHU=1
     volumes:
       - ./node-data:/root/.akash
diff --git a/archway/README.md b/archway/README.md
@@ -1,23 +1,37 @@
-# archway
+# Archway
 
 | | |
 |---|---|
 |Version|`v7.0.0`|
 |Binary|`archwayd`|
 |Directory|`.archway`|
-|ENV namespace|`archway`|
+|ENV namespace|`ARCHWAYD`|
 |Repository|`https://github.com/archway-network/archway`|
 |Image|`ghcr.io/akash-network/cosmos-omnibus:v0.4.33-archway-v7.0.0`|
 
 ## Examples
 
 - Run on Akash with the [example deploy.yml](./deploy.yml)
-- Run locally using the [example docker-compose.yml](./docker-compose.yml)
+- Run with Docker using the [example docker-compose.yml](./docker-compose.yml)
 
 ## Chain information
 
-The [Cosmos Chain Registry](https://github.com/cosmos/chain-registry) publishes up to date chain info for archway chain.
+The [Cosmos Chain Registry](https://github.com/cosmos/chain-registry) publishes [up to date chain info](https://raw.githubusercontent.com/cosmos/chain-registry/master/archway/chain.json) for Archway.
+
+This will be used automatically unless overridden with the `CHAIN_JSON` variable (use `0` to disable).
+
+## Polkachu Chain Services
+
+[Polkachu's Chain Services](https://www.polkachu.com/) make bootstrapping a node extremely easy. They provide live peers, seeds, statesync, addrbooks and pruned snapshots among other features.
+
+The following configuration is available for Archway nodes. [See the documentation](../README.md#polkachu-services) for more information.
 
 |Variable|Value|
 |---|---|
-|`CHAIN_JSON`|`https://raw.githubusercontent.com/cosmos/chain-registry/master/archway/chain.json`|
+|`P2P_POLKACHU`|`1`|
+|`P2P_SEEDS_POLKACHU`|`1`|
+|`P2P_PEERS_POLKACHU`|`1`|
+|`STATESYNC_POLKACHU`|`1`|
+|`ADDRBOOK_POLKACHU`|`1`|
+
+Polkachu also provide pruned snapshots for Archway. Find the [latest snapshot](https://polkachu.com/tendermint_snapshots/akash) and apply it using the `SNAPSHOT_URL` variable.
diff --git a/archway/deploy.yml b/archway/deploy.yml
@@ -1,28 +1,24 @@
 ---
 version: "2.0"
-
 services:
   node:
     image: ghcr.io/akash-network/cosmos-omnibus:v0.4.33-archway-v7.0.0
     env:
-      - MONIKER=node_1
-      - CHAIN_JSON=https://raw.githubusercontent.com/cosmos/chain-registry/master/archway/chain.json
-      - MINIMUM_GAS_PRICES=0.025uarch
+      - MONIKER=Cosmos Omnibus Node
       - P2P_POLKACHU=1
       - STATESYNC_POLKACHU=1
+      - ADDRBOOK_POLKACHU=1
     expose:
       - port: 26657
-        as: 80
         to:
           - global: true
       - port: 26656
         to:
           - global: true
-    # params:
-    #   storage:
-    #     data:
-    #       mount: /root/.archway
-
+    params: # remove for non-persistent storage
+      storage:
+        data:
+          mount: /root/.archway
 profiles:
   compute:
     node:
@@ -32,12 +28,11 @@ profiles:
         memory:
           size: 8Gi
         storage:
-          size: 100Gi
-          # - size: 100Mi
-          # - name: data
-          #   size: 400Gi
-          #   attributes:
-          #     persistent: true
+          - size: 10Gi
+          - name: data # remove for non-persistent storage
+            size: 400Gi
+            attributes:
+              persistent: true
   placement:
     dcloud:
       attributes:
@@ -49,7 +44,6 @@ profiles:
         node:
           denom: uakt
           amount: 1000
-
 deployment:
   node:
     dcloud:

diff --git a/archway/docker-compose.yml b/archway/docker-compose.yml
@@ -1,17 +1,14 @@
-version: '3.4'
-
 services:
-  node_1:
+  node:
     image: ghcr.io/akash-network/cosmos-omnibus:v0.4.33-archway-v7.0.0
     ports:
       - '26656:26656'
       - '26657:26657'
       - '1317:1317'
     environment:
-      - MONIKER=node_1
-      - CHAIN_JSON=https://raw.githubusercontent.com/cosmos/chain-registry/master/archway/chain.json
-      - MINIMUM_GAS_PRICES=0.025aarch
+      - MONIKER=Cosmos Omnibus Node
       - P2P_POLKACHU=1
       - STATESYNC_POLKACHU=1
+      - ADDRBOOK_POLKACHU=1
     volumes:
       - ./node-data:/root/.archway