Merge pull request #876 from oasisprotocol/kostko/reorder-pts

docs/node: Reorder paratimes and minor fixes
oasisprotocol · Jul 8, 2024 · bbd28da · bbd28da
2 parents 08c51a7 + 3d66796
commit bbd28da
Show file tree

Hide file tree

Showing 5 changed files with 93 additions and 83 deletions.
diff --git a/docs/get-involved/run-node/paratime-node.mdx b/docs/get-involved/run-node/paratime-node.mdx
@@ -58,6 +58,7 @@ the use of EVM smart contracts on the Oasis network.
 
 * Fully decentralized with node operators distributed across the world.
 * Oasis **ROSE** tokens are the native token used in the ParaTime for gas fees.
+* Support for EVM smart contracts.
 * Support for confidential compute.
 
 ### Mainnet Requirements
@@ -69,72 +70,73 @@ committee on Mainnet, your entity needs to:
 - Have at least **5,000,000.00 ROSE staked/delegated** to it.
 
 </TabItem>
-<TabItem value="Emerald ParaTime">
+<TabItem value="Cipher ParaTime">
 
-### Emerald ParaTime
+### Cipher ParaTime
 
-An EVM-compatible Oasis Foundation developed ParaTime that enables the use of
-EVM smart contracts on the Oasis network.
+An Oasis Foundation developed ParaTime that enables WebAssembly-based
+confidential smart contracts.
 
 ### Overview
 
 * **Leading Developer:** [Oasis Protocol Foundation], with contributions from
   community developers
 * **Status:** Deployed on Mainnet and Testnet
-* **Testnet Launch Date:** October 2021
-* **Mainnet Launch Date:** November 2021
+* **Testnet Launch Date:** June 2021
+* **Mainnet Launch Date:** October 2021
 * **Discord Channel:** [#node-operators][connect-with-us]
-* **Requires SGX:** No
+* **Requires SGX:** Yes
 * **Parameters:**
-  * [Mainnet](../../node/mainnet/README.md#emerald)
-  * [Testnet](../../node/testnet/README.md#emerald)
+  * [Mainnet](../../node/mainnet/README.md#cipher)
+  * [Testnet](../../node/testnet/README.md#cipher)
 
 ### Features
 
 * Fully decentralized with node operators distributed across the world.
 * Oasis **ROSE** tokens are the native token used in the ParaTime for gas fees.
+* Support for WebAssembly smart contracts.
+* Support for confidential compute.
 
 ### Mainnet Requirements
 
-For your Emerald ParaTime node to be eligible to be elected into the Emerald
+For your Cipher ParaTime node to be eligible to be elected into the Cipher
 committee on Mainnet, your entity needs to:
 
 - Have a validator in the **validator set**.
-- Have at least **5,000,000.00 ROSE staked/delegated** to it.
 
 </TabItem>
-<TabItem value="Cipher ParaTime">
+<TabItem value="Emerald ParaTime">
 
-### Cipher ParaTime
+### Emerald ParaTime
 
-An Oasis Foundation developed ParaTime that will enable WebAssembly-based
-confidential smart contracts.
+An EVM-compatible Oasis Foundation developed ParaTime that enables the use of
+EVM smart contracts on the Oasis network.
 
 ### Overview
 
-* **Leading Developer:** [Oasis Protocol Foundation]
+* **Leading Developer:** [Oasis Protocol Foundation], with contributions from
+  community developers
 * **Status:** Deployed on Mainnet and Testnet
-* **Testnet Launch Date:** June 2021
-* **Mainnet Launch Date:** October 2021
+* **Testnet Launch Date:** October 2021
+* **Mainnet Launch Date:** November 2021
 * **Discord Channel:** [#node-operators][connect-with-us]
-* **Requires SGX:** Yes
+* **Requires SGX:** No
 * **Parameters:**
-  * [Mainnet](../../node/mainnet/README.md#cipher)
-  * [Testnet](../../node/testnet/README.md#cipher)
+  * [Mainnet](../../node/mainnet/README.md#emerald)
+  * [Testnet](../../node/testnet/README.md#emerald)
 
 ### Features
 
 * Fully decentralized with node operators distributed across the world.
 * Oasis **ROSE** tokens are the native token used in the ParaTime for gas fees.
-* Support for WebAssembly smart contracts.
-* Support for confidential compute.
 
 ### Mainnet Requirements
 
-For your Cipher ParaTime node to be eligible to be elected into the Cipher
+For your Emerald ParaTime node to be eligible to be elected into the Emerald
 committee on Mainnet, your entity needs to:
 
 - Have a validator in the **validator set**.
+- Have at least **5,000,000.00 ROSE staked/delegated** to it.
 
 </TabItem>
 </Tabs>

diff --git a/docs/node/grpc.mdx b/docs/node/grpc.mdx
@@ -54,10 +54,18 @@ the following behavior:
 - whitelisted methods for checking the network status, performing queries and
   submitting transactions,
 - no control methods allowed and no queries that are CPU or I/O intensive,
-- lives on `grpc.my-oasis-node.com` with TLS-enabled connection and certificates
+- lives on `grpc.example.com` with TLS-enabled connection and certificates
   that you already have from Let's Encrypt,
 - `internal.sock` of the Oasis node is accessible at `/node/data/internal.sock`.
 
+:::info Example hostnames
+
+This chapter uses various hostnames under the `example.com` domain. These only
+serve as an example and in a real deployment you should replace them with your
+own domain.
+
+:::
+
 Envoy already has built-in support for gRPC so after installing Envoy, simply
 put the configuration below inside your `envoy.yaml` and then execute the proxy
 with `envoy -c envoy.yaml`.
@@ -227,9 +235,9 @@ static_resources:
                   - h2,http/1.1
                 tls_certificates:
                   - certificate_chain:
-                      filename: /etc/letsencrypt/live/grpc.my-oasis-node.com/fullchain.pem
+                      filename: /etc/letsencrypt/live/grpc.example.com/fullchain.pem
                     private_key:
-                      filename: /etc/letsencrypt/live/grpc.my-oasis-node.com/privkey.pem
+                      filename: /etc/letsencrypt/live/grpc.example.com/privkey.pem
   clusters:
     - name: oasis_node_grpc
       connect_timeout: 0.25s
@@ -260,12 +268,12 @@ layered_runtime:
 ## Tunnel Unix socket via SSH
 
 SSH supports forwarding a Unix socket over a secure layer. The command below
-will establish a secure shell to the `my-oasis-node.com` server and then tunnel
+will establish a secure shell to the `example.com` server and then tunnel
 the `internal.sock` file inside the data directory to a Unix socket inside your
 home folder:
 
 ```shell
-ssh oasis@my-oasis-node.com -L /home/user/oasis-node-internal.sock:/node/data/internal.sock
+ssh oasis@example.com -L /home/user/oasis-node-internal.sock:/node/data/internal.sock
 ```
 
 The `/home/user/oasis-node-internal.sock` can now be used to safely connect to

diff --git a/docs/node/mainnet/README.md b/docs/node/mainnet/README.md
@@ -56,6 +56,27 @@ for the current Testnet parameters.
 
 This section contains parameters for various ParaTimes known to be deployed on the Mainnet.
 
+### Sapphire
+
+* Oasis Core version:
+  * [24.0](https://github.com/oasisprotocol/oasis-core/releases/tag/v24.0)
+* Runtime identifier:
+  * `000000000000000000000000000000000000000000000000f80306c9858e7279`
+* Runtime bundle version:
+  * [0.7.3](https://github.com/oasisprotocol/sapphire-paratime/releases/tag/v0.7.3)
+* Oasis Web3 Gateway version:
+  * [5.1.0](https://github.com/oasisprotocol/oasis-web3-gateway/releases/tag/v5.1.0)
+* IAS proxy address:
+  * `[email protected]:8650`
+  * `tuDyXwaajTEbNWb1QIlf8FWHsdkaB4W1+TjzP1QID/[email protected]:8650`
+
+:::tip
+
+Feel free to use other IAS proxies besides the one provided here or
+[run your own](../../node/run-your-node/ias-proxy.md).
+
+:::
+
 ### Cipher
 
 * Oasis Core version:
@@ -93,27 +114,6 @@ the public Web3 endpoint.
 
 :::
 
-### Sapphire
-
-* Oasis Core version:
-  * [24.0](https://github.com/oasisprotocol/oasis-core/releases/tag/v24.0)
-* Runtime identifier:
-  * `000000000000000000000000000000000000000000000000f80306c9858e7279`
-* Runtime bundle version:
-  * [0.7.3](https://github.com/oasisprotocol/sapphire-paratime/releases/tag/v0.7.3)
-* Oasis Web3 Gateway version:
-  * [5.1.0](https://github.com/oasisprotocol/oasis-web3-gateway/releases/tag/v5.1.0)
-* IAS proxy address:
-  * `[email protected]:8650`
-  * `tuDyXwaajTEbNWb1QIlf8FWHsdkaB4W1+TjzP1QID/[email protected]:8650`
-
-:::tip
-
-Feel free to use other IAS proxies besides the one provided here or
-[run your own](../../node/run-your-node/ias-proxy.md).
-
-:::
-
 ### Key Manager
 
 * Oasis Core version:

diff --git a/docs/node/testnet/README.md b/docs/node/testnet/README.md
@@ -57,15 +57,17 @@ The Oasis Node is part of the Oasis Core release.
 
 This chapter contains parameters for various ParaTimes known to be deployed on the Testnet. Similar to the Testnet, these may be subject to frequent version upgrades and/or state resets.
 
-### Cipher
+### Sapphire
 
 * Oasis Core version:
   * [24.1](https://github.com/oasisprotocol/oasis-core/releases/tag/v24.1)
 * Runtime identifier:
-  * `0000000000000000000000000000000000000000000000000000000000000000`
+  * `000000000000000000000000000000000000000000000000a6d1e3ebf60dff6c`
 * Runtime bundle version:
-  * [3.1.0-testnet](https://github.com/oasisprotocol/cipher-paratime/releases/tag/v3.1.0-testnet)
-  * [3.0.5-testnet](https://github.com/oasisprotocol/cipher-paratime/releases/tag/v3.0.5-testnet)
+  * [0.8.0-testnet](https://github.com/oasisprotocol/sapphire-paratime/releases/tag/v0.8.0-testnet)
+  * [0.7.3-testnet](https://github.com/oasisprotocol/sapphire-paratime/releases/tag/v0.7.3-testnet)
+* Web3 Gateway version:
+  * [5.1.0](https://github.com/oasisprotocol/oasis-web3-gateway/releases/tag/v5.1.0)
 * IAS proxy address:
   * `[email protected]:8650`
   * `[email protected]:8650`
@@ -76,28 +78,15 @@ Feel free to use other IAS proxies besides the ones provided here or [run your o
 
 :::
 
-### Emerald
-
-* Oasis Core version:
-  * [24.1](https://github.com/oasisprotocol/oasis-core/releases/tag/v24.1)
-* Runtime identifier:
-  * `00000000000000000000000000000000000000000000000072c8215e60d5bca7`
-* Runtime bundle version (or [build your own](https://github.com/oasisprotocol/emerald-paratime/tree/v11.0.0-testnet#building)):
-  * [11.0.0-testnet](https://github.com/oasisprotocol/emerald-paratime/releases/tag/v11.0.0-testnet)
-* Web3 Gateway version:
-  * [5.1.0](https://github.com/oasisprotocol/oasis-web3-gateway/releases/tag/v5.1.0)
-
-### Sapphire
+### Cipher
 
 * Oasis Core version:
   * [24.1](https://github.com/oasisprotocol/oasis-core/releases/tag/v24.1)
 * Runtime identifier:
-  * `000000000000000000000000000000000000000000000000a6d1e3ebf60dff6c`
+  * `0000000000000000000000000000000000000000000000000000000000000000`
 * Runtime bundle version:
-  * [0.8.0-testnet](https://github.com/oasisprotocol/sapphire-paratime/releases/tag/v0.8.0-testnet)
-  * [0.7.3-testnet](https://github.com/oasisprotocol/sapphire-paratime/releases/tag/v0.7.3-testnet)
-* Web3 Gateway version:
-  * [5.1.0](https://github.com/oasisprotocol/oasis-web3-gateway/releases/tag/v5.1.0)
+  * [3.1.0-testnet](https://github.com/oasisprotocol/cipher-paratime/releases/tag/v3.1.0-testnet)
+  * [3.0.5-testnet](https://github.com/oasisprotocol/cipher-paratime/releases/tag/v3.0.5-testnet)
 * IAS proxy address:
   * `[email protected]:8650`
   * `[email protected]:8650`
@@ -108,6 +97,17 @@ Feel free to use other IAS proxies besides the ones provided here or [run your o
 
 :::
 
+### Emerald
+
+* Oasis Core version:
+  * [24.1](https://github.com/oasisprotocol/oasis-core/releases/tag/v24.1)
+* Runtime identifier:
+  * `00000000000000000000000000000000000000000000000072c8215e60d5bca7`
+* Runtime bundle version (or [build your own](https://github.com/oasisprotocol/emerald-paratime/tree/v11.0.0-testnet#building)):
+  * [11.0.0-testnet](https://github.com/oasisprotocol/emerald-paratime/releases/tag/v11.0.0-testnet)
+* Web3 Gateway version:
+  * [5.1.0](https://github.com/oasisprotocol/oasis-web3-gateway/releases/tag/v5.1.0)
+
 ### Key Manager
 
 * Oasis Core version:

diff --git a/sidebarDapp.ts b/sidebarDapp.ts
@@ -51,18 +51,6 @@ export const sidebarDapp: SidebarsConfig = {
         'dapp/opl/frontend',
       ],
     },
-    {
-      type: 'category',
-      label: 'Emerald',
-      link: {
-        type: 'doc',
-        id: 'dapp/emerald/README',
-      },
-      items: [
-        'dapp/emerald/writing-dapps-on-emerald',
-        'dapp/emerald/integrating-band-oracle-smart-contract',
-      ],
-    },
     {
       type: 'category',
       label: 'Cipher',
@@ -81,5 +69,17 @@ export const sidebarDapp: SidebarsConfig = {
         },
       ],
     },
+    {
+      type: 'category',
+      label: 'Emerald',
+      link: {
+        type: 'doc',
+        id: 'dapp/emerald/README',
+      },
+      items: [
+        'dapp/emerald/writing-dapps-on-emerald',
+        'dapp/emerald/integrating-band-oracle-smart-contract',
+      ],
+    },
   ],
 };