Move Chain Information to separate page

oasisprotocol · Sep 18, 2024 · 2ec44b0 · 2ec44b0
1 parent 10ed82d
commit 2ec44b0
Show file tree

Hide file tree

Showing 4 changed files with 120 additions and 198 deletions.
diff --git a/docs/dapp/emerald/README.mdx b/docs/dapp/emerald/README.mdx
@@ -1,6 +1,5 @@
 import DocCardList from '@theme/DocCardList';
 import {findSidebarItem} from '@site/src/sidebarUtils';
-import {AddEmeraldToMetaMask as E, AddEmeraldTestnetToMetaMask as ET} from '@site/src/AddToMetaMask';
 
 # Emerald ParaTime
 
@@ -21,98 +20,6 @@ If you're looking for EVM, but with confidentiality, check out the
 
 [Ethereum Virtual Machine (EVM)]: https://ethereum.org/en/developers/docs/evm/
 
-## Chain Information
-
-### Mainnet
-
-- Network name: `emerald`
-- Long network name: `Oasis Emerald`
-- Chain ID:
-  - Hex: `0xa516`
-  - Decimal: `42262`
-
-### Testnet
-
-- Network name: `emerald-testnet`
-- Long network name: `Oasis Emerald Testnet`
-- Chain ID:
-  - Hex: `0xa515`
-  - Decimal: `42261`
-
-## RPC Endpoints
-
-:::danger
-
-The RPC endpoint is a *point of trust*. Beside traffic rate limiting, it can
-also perform censorship or even a man-in-the-middle attack. If you have security
-considerations, we strongly recommend that you set up your own [ParaTime client
-node][paratime-client-node] and the [Web3-compatible gateway].
-
-:::
-
-
-[Web3-compatible gateway]: ../../node/web3.mdx
-[paratime-client-node]: ../../node/run-your-node/paratime-client-node.mdx
-
-You can connect to one of the public Web3 gateways below (in alphabetic order):
-
-| Provider                    | Mainnet RPC URLs                                                        | Testnet RPC URLs                                                                         |
-|-----------------------------|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
-| [1RPC]                      | <E rpcs={['https://1rpc.io/oasis/emerald']} />                          | N/A                                                                                      |
-| [Oasis Protocol Foundation] | <E rpcs={['https://emerald.oasis.io','wss://emerald.oasis.io/ws']} /> | <ET rpcs={['https://testnet.emerald.oasis.io','wss://testnet.emerald.oasis.io/ws']} /> |
-
-[Oasis Protocol Foundation]: https://oasisprotocol.org
-
-Public RPCs may have rate limits or traffic restrictions. For professional,
-dedicated RPC endpoints, consider the following providers (in alphabetic order):
-
-| Provider                  | Instructions              | Pricing                 |
-|---------------------------|---------------------------|-------------------------|
-| [1RPC]                    | [docs.1rpc.io][1RPC-docs] | [Pricing][1RPC-pricing] |
-
-
-[1RPC]: https://www.1rpc.io/
-[1RPC-docs]: https://docs.1rpc.io/guide/how-to-use-1rpc
-[1RPC-pricing]: https://www.1rpc.io/#pricing
-
-## Block Explorers
-
-| Name/Provider               | Mainnet URL                               | Testnet URL                               | EIP-3091 compatible |
-|-----------------------------|-------------------------------------------|-------------------------------------------|---------------------|
-| [Oasis Explorer][Oasis Protocol Foundation] | https://explorer.oasis.io/mainnet/emerald | https://explorer.oasis.io/testnet/emerald | Yes                 |
-| Oasis Scan ([Bit Cat])                      | [https://www.oasisscan.com/paratimes/000…87f](https://www.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000e2eaa99fc008f87f) | [https://testnet.oasisscan.com/paratimes/000…ca7](https://testnet.oasisscan.com/paratimes/00000000000000000000000000000000000000000000000072c8215e60d5bca7) | No |
-
-[Bit Cat]: https://www.bitcat365.com/
-
-## Indexers
-
-| Name (Provider)                           | Mainnet URL                                           | Testnet URL                          | Documentation     |
-|-------------------------------------------|-------------------------------------------------------|--------------------------------------|-------------------|
-| [Covalent]                                | `https://api.covalenthq.com/v1/oasis-emerald-mainnet` | *N/A*                                | [Unified API docs][Covalent-docs] |
-| Oasis Nexus ([Oasis Protocol Foundation]) | `https://nexus.oasis.io/v1/`                          | `https://testnet.nexus.oasis.io/v1/` | [API][Nexus-docs] |
-| Oasis Scan ([Bit Cat])                    | `https://api.oasisscan.com/mainnet/v2`                | `https://api.oasisscan.com/testnet/v2` | [Mainnet Runtime API][OasisScan-Mainnet-docs], [Testnet Runtime API][OasisScan-Testnet-docs] |
-| [SubQuery Network][SubQuery]              | *N/A*                                                 | *N/A*                                | [SubQuery Academy][SubQuery-docs], [QuickStart][SubQuery-quickstart], [Starter project][SubQuery-starter] |
-
-[Covalent]: https://www.covalenthq.com/
-[Covalent-docs]: https://www.covalenthq.com/docs/unified-api/
-[Nexus-docs]: https://nexus.oasis.io/v1/spec/v1.html
-[OasisScan-Testnet-docs]: https://api.oasisscan.com/testnet/swagger-ui/#/runtime-controller
-[OasisScan-Mainnet-docs]: https://api.oasisscan.com/mainnet/swagger-ui/#/runtime-controller
-[SubQuery]: https://subquery.network
-[SubQuery-docs]: https://academy.subquery.network/
-[SubQuery-quickstart]: https://academy.subquery.network/quickstart/quickstart.html
-[SubQuery-starter]: https://github.com/subquery/ethereum-subql-starter/tree/main/Oasis/oasis-emerald-starter
-
-:::note
-
-If you are running your own Emerald endpoint, a block explorer, or an indexer
-and wish to be added to these docs, open an issue at
-[github.com/oasisprotocol/docs].
-
-:::
-
-[github.com/oasisprotocol/docs]: https://github.com/oasisprotocol/docs
-
 ## See also
 
 <DocCardList items={[

diff --git a/docs/dapp/emerald/chain.mdx b/docs/dapp/emerald/chain.mdx
@@ -0,0 +1,97 @@
+---
+description: Chain Information for Emerald
+---
+
+import {AddEmeraldToMetaMask as E, AddEmeraldTestnetToMetaMask as ET} from '@site/src/AddToMetaMask';
+
+# Chain Information
+
+### Mainnet
+
+- Network name: `emerald`
+- Long network name: `Oasis Emerald`
+- Chain ID:
+  - Hex: `0xa516`
+  - Decimal: `42262`
+
+### Testnet
+
+- Network name: `emerald-testnet`
+- Long network name: `Oasis Emerald Testnet`
+- Chain ID:
+  - Hex: `0xa515`
+  - Decimal: `42261`
+
+## RPC Endpoints
+
+:::danger
+
+The RPC endpoint is a *point of trust*. Beside traffic rate limiting, it can
+also perform censorship or even a man-in-the-middle attack. If you have security
+considerations, we strongly recommend that you set up your own [ParaTime client
+node][paratime-client-node] and the [Web3-compatible gateway].
+
+:::
+
+
+[Web3-compatible gateway]: ../../node/web3.mdx
+[paratime-client-node]: ../../node/run-your-node/paratime-client-node.mdx
+
+You can connect to one of the public Web3 gateways below (in alphabetic order):
+
+| Provider                    | Mainnet RPC URLs                                                        | Testnet RPC URLs                                                                         |
+|-----------------------------|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
+| [1RPC]                      | <E rpcs={['https://1rpc.io/oasis/emerald']} />                          | N/A                                                                                      |
+| [Oasis Protocol Foundation] | <E rpcs={['https://emerald.oasis.io','wss://emerald.oasis.io/ws']} /> | <ET rpcs={['https://testnet.emerald.oasis.io','wss://testnet.emerald.oasis.io/ws']} /> |
+
+[Oasis Protocol Foundation]: https://oasisprotocol.org
+
+Public RPCs may have rate limits or traffic restrictions. For professional,
+dedicated RPC endpoints, consider the following providers (in alphabetic order):
+
+| Provider                  | Instructions              | Pricing                 |
+|---------------------------|---------------------------|-------------------------|
+| [1RPC]                    | [docs.1rpc.io][1RPC-docs] | [Pricing][1RPC-pricing] |
+
+
+[1RPC]: https://www.1rpc.io/
+[1RPC-docs]: https://docs.1rpc.io/guide/how-to-use-1rpc
+[1RPC-pricing]: https://www.1rpc.io/#pricing
+
+## Block Explorers
+
+| Name/Provider               | Mainnet URL                               | Testnet URL                               | EIP-3091 compatible |
+|-----------------------------|-------------------------------------------|-------------------------------------------|---------------------|
+| [Oasis Explorer][Oasis Protocol Foundation] | https://explorer.oasis.io/mainnet/emerald | https://explorer.oasis.io/testnet/emerald | Yes                 |
+| Oasis Scan ([Bit Cat])                      | [https://www.oasisscan.com/paratimes/000…87f](https://www.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000e2eaa99fc008f87f) | [https://testnet.oasisscan.com/paratimes/000…ca7](https://testnet.oasisscan.com/paratimes/00000000000000000000000000000000000000000000000072c8215e60d5bca7) | No |
+
+[Bit Cat]: https://www.bitcat365.com/
+
+## Indexers
+
+| Name (Provider)                           | Mainnet URL                                           | Testnet URL                          | Documentation     |
+|-------------------------------------------|-------------------------------------------------------|--------------------------------------|-------------------|
+| [Covalent]                                | `https://api.covalenthq.com/v1/oasis-emerald-mainnet` | *N/A*                                | [Unified API docs][Covalent-docs] |
+| Oasis Nexus ([Oasis Protocol Foundation]) | `https://nexus.oasis.io/v1/`                          | `https://testnet.nexus.oasis.io/v1/` | [API][Nexus-docs] |
+| Oasis Scan ([Bit Cat])                    | `https://api.oasisscan.com/mainnet/v2`                | `https://api.oasisscan.com/testnet/v2` | [Mainnet Runtime API][OasisScan-Mainnet-docs], [Testnet Runtime API][OasisScan-Testnet-docs] |
+| [SubQuery Network][SubQuery]              | *N/A*                                                 | *N/A*                                | [SubQuery Academy][SubQuery-docs], [QuickStart][SubQuery-quickstart], [Starter project][SubQuery-starter] |
+
+[Covalent]: https://www.covalenthq.com/
+[Covalent-docs]: https://www.covalenthq.com/docs/unified-api/
+[Nexus-docs]: https://nexus.oasis.io/v1/spec/v1.html
+[OasisScan-Testnet-docs]: https://api.oasisscan.com/testnet/swagger-ui/#/runtime-controller
+[OasisScan-Mainnet-docs]: https://api.oasisscan.com/mainnet/swagger-ui/#/runtime-controller
+[SubQuery]: https://subquery.network
+[SubQuery-docs]: https://academy.subquery.network/
+[SubQuery-quickstart]: https://academy.subquery.network/quickstart/quickstart.html
+[SubQuery-starter]: https://github.com/subquery/ethereum-subql-starter/tree/main/Oasis/oasis-emerald-starter
+
+:::note
+
+If you are running your own Emerald endpoint, a block explorer, or an indexer
+and wish to be added to these docs, open an issue at
+[github.com/oasisprotocol/docs].
+
+:::
+
+[github.com/oasisprotocol/docs]: https://github.com/oasisprotocol/docs
diff --git a/docs/dapp/sapphire/README.mdx b/docs/dapp/sapphire/README.mdx
@@ -1,6 +1,5 @@
 import DocCardList from '@theme/DocCardList';
 import {findSidebarItem} from '@site/src/sidebarUtils';
-import {AddSapphireToMetaMask as S, AddSapphireTestnetToMetaMask as ST} from '@site/src/AddToMetaMask';
 
 # Sapphire ParaTime
 
@@ -19,126 +18,43 @@ If you are not bound to EVM and you wish to develop dApps with more
 fine-grained confidentiality, check out the
 [Cipher ParaTime](../cipher/README.mdx).
 
-:::tip
+[Ethereum Virtual Machine (EVM)]: https://ethereum.org/en/developers/docs/evm/
 
-See a list of [dApps][playground] or start with a demo [project][demo].
+### Getting Started
 
-:::
+Develop and deploy a dApp on Sapphire:
+- follow along with a video walkthrough via [quickstart][quickstart]
+- start with a working dApp [demo][demo]
+- explore showcase dApps deployed on Sapphire on the [playground][playground]
 
+[quickstart]: ./quickstart.mdx
 [playground]: https://playground.oasis.io/
 [demo]: https://github.com/oasisprotocol/demo-starter
-[Ethereum Virtual Machine (EVM)]: https://ethereum.org/en/developers/docs/evm/
-
-## Chain Information
-
-### Mainnet
-
-- Network name: `sapphire`
-- Long network name: `Oasis Sapphire`
-- Chain ID:
-  - Hex: `0x5afe`
-  - Decimal: `23294`
-
-### Testnet
-
-- Network name: `sapphire-testnet`
-- Long network name: `Oasis Sapphire Testnet`
-- Chain ID:
-  - Hex: `0x5aff`
-  - Decimal: `23295`
-- Testing token [Faucet][faucet]
-
-[faucet]: https://faucet.testnet.oasis.io/
-
-### Localnet
-
-- Network name: `sapphire-localnet`
-- Long network name: `Localnet`
-- Chain ID:
-  - Hex: `0x5afd`
-  - Decimal: `23293`
-- Local development Docker [image][localnet]
-
-[localnet]: https://github.com/oasisprotocol/oasis-web3-gateway/tree/main/docker
-## RPC Endpoints
 
-:::danger
+### Understanding EVM compatibility
 
-The RPC endpoint is a *point of trust*. Beside traffic rate limiting, it can
-also perform censorship or even a man-in-the-middle attack. If you have security
-considerations, we strongly recommend that you set up your own [ParaTime client
-node][paratime-client-node] and the [Web3-compatible gateway].
+Get to know the differences between Sapphire and Ethereum, and learn about
+the high level concepts of developing a confidential smart contract with our
+[guide][guide].
 
-:::
+[guide]: ./guide.mdx
 
-[Web3-compatible gateway]: ../../node/web3.mdx
-[paratime-client-node]: ../../node/run-your-node/paratime-client-node.mdx
+### Building on Sapphire
 
-You can connect to one of the public Web3 gateways below (in alphabetic order):
+Take your existing dApp building knowledge and add Sapphire with our developer
+[cheatsheet](./images/cheatsheet.pdf).
 
-| Provider                    | Mainnet RPC URLs                                                        | Testnet RPC URLs                                                                           | Supports Confidential Queries |
-|-----------------------------|-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|-------------------------------|
-| [1RPC]                      | <S rpcs={['https://1rpc.io/oasis/sapphire']} />                         | *N/A*                                                                                      | Yes                           |
-| [Oasis Protocol Foundation] | <S rpcs={['https://sapphire.oasis.io','wss://sapphire.oasis.io/ws']} /> | <ST rpcs={['https://testnet.sapphire.oasis.io','wss://testnet.sapphire.oasis.io/ws']} /> | Yes                           |
+### Chain Information
 
-[Oasis Protocol Foundation]: https://oasisprotocol.org
+See crucial network information [here][chain-info].
 
-Public RPCs may have rate limits or traffic restrictions. For professional,
-dedicated RPC endpoints, consider the following providers (in alphabetic order):
+[chain-info]: ./chain.mdx
 
-| Provider     | Instructions                           | Pricing                       | Supports Confidential Queries |
-|--------------|----------------------------------------|-------------------------------|-------------------------------|
-| [1RPC]       | [docs.1rpc.io][1RPC-docs]              | [Pricing][1RPC-pricing]       | Yes                           |
-| [Chainstack] | [docs.chainstack.com][Chainstack-docs] | [Pricing][Chainstack-pricing] | Yes                           |
+### Faucet
 
+Visit the [faucet][faucet] to obtain testnet tokens for development purposes.
 
-[1RPC]: https://www.1rpc.io/
-[1RPC-docs]: https://docs.1rpc.io/guide/how-to-use-1rpc
-[1RPC-pricing]: https://www.1rpc.io/#pricing
-[Chainstack]: https://chainstack.com/build-better-with-oasis-sapphire/
-[Chainstack-docs]: https://docs.chainstack.com/docs/oasis-sapphire-tooling
-[Chainstack-pricing]: https://chainstack.com/pricing/
-
-## Block Explorers
-
-| Name (Provider)                               | Mainnet URL                                | Testnet URL                                | EIP-3091 compatible |
-|-----------------------------------------------|--------------------------------------------|--------------------------------------------|---------------------|
-| Oasis Explorer ([Oasis Protocol Foundation])  | https://explorer.oasis.io/mainnet/sapphire | https://explorer.oasis.io/testnet/sapphire | Yes                 |
-| Oasis Scan ([Bit Cat])                        | [https://www.oasisscan.com/paratimes/000…279](https://www.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000f80306c9858e7279) | [https://testnet.oasisscan.com/paratimes/000…f6c](https://testnet.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000a6d1e3ebf60dff6c) | No |
-
-[Bit Cat]: https://www.bitcat365.com/
-
-## Indexers
-
-| Name (Provider)      | Mainnet URL                                                    | Testnet URL                                            | Documentation                              |
-|--------------------|------------------------------------------------------------------|--------------------------------------------------------|--------------------------------------------|
-| [Covalent]                   | `https://api.covalenthq.com/v1/oasis-sapphire-mainnet` | `https://api.covalenthq.com/v1/oasis-sapphire-testnet` | [Unified API docs][Covalent-docs]          |
-| [Goldsky Subgraph][Goldsky]  | *N/A*                                                  | *N/A*                                                  | [Documentation site][Goldsky-docs]         |
-| Oasis Nexus ([Oasis Protocol Foundation]) | `https://nexus.oasis.io/v1/`              | `https://testnet.nexus.oasis.io/v1/`                   | [API][Nexus-docs]                          |
-| Oasis Scan ([Bit Cat])       | `https://api.oasisscan.com/mainnet/v2`                 | `https://api.oasisscan.com/testnet/v2`                 | [Mainnet Runtime API][OasisScan-Mainnet-docs], [Testnet Runtime API][OasisScan-Testnet-docs] |
-| [SubQuery Network][SubQuery] | *N/A*                                                  | *N/A*                                                  | [SubQuery Academy][SubQuery-docs], [QuickStart][SubQuery-quickstart], [Starter project][SubQuery-starter] |
-
-[Covalent]: https://www.covalenthq.com/
-[Covalent-docs]: https://www.covalenthq.com/docs/unified-api/
-[Nexus-docs]: https://nexus.oasis.io/v1/spec/v1.html
-[Goldsky]: https://goldsky.com
-[Goldsky-docs]: https://docs.goldsky.com/subgraphs/deploying-subgraphs
-[OasisScan-Testnet-docs]: https://api.oasisscan.com/testnet/swagger-ui/#/runtime-controller
-[OasisScan-Mainnet-docs]: https://api.oasisscan.com/mainnet/swagger-ui/#/runtime-controller
-[SubQuery]: https://subquery.network
-[SubQuery-docs]: https://academy.subquery.network/
-[SubQuery-quickstart]: https://academy.subquery.network/quickstart/quickstart.html
-[SubQuery-starter]: https://github.com/subquery/ethereum-subql-starter/tree/main/Oasis/oasis-sapphire-starter
-
-:::note
-
-If you are running your own Sapphire endpoint, a block explorer, or an indexer
-and wish to be added to these docs, open an issue at
-[github.com/oasisprotocol/docs].
-
-:::
-
-[github.com/oasisprotocol/docs]: https://github.com/oasisprotocol/docs
+[faucet]: https://faucet.testnet.oasis.io/
 
 ## See also
 

diff --git a/sidebarDapp.ts b/sidebarDapp.ts
@@ -16,6 +16,7 @@ export const sidebarDapp: SidebarsConfig = {
       },
       items: [
         'dapp/sapphire/quickstart',
+        'dapp/sapphire/chain',
         'dapp/sapphire/guide',
         'dapp/sapphire/browser',
         'dapp/sapphire/authentication',
@@ -77,6 +78,7 @@ export const sidebarDapp: SidebarsConfig = {
         id: 'dapp/emerald/README',
       },
       items: [
+        'dapp/emerald/chain',
         'dapp/emerald/writing-dapps-on-emerald',
       ],
     },