Merge pull request #940 from oasisprotocol/xz/update-above-the-fold-s…

…apphire docs: Improve Emerald and Sapphire content
oasisprotocol · Sep 22, 2024 · 6e9047b · 6e9047b
2 parents 5a6b167 + 55ecaff
commit 6e9047b
Show file tree

Hide file tree

Showing 9 changed files with 116 additions and 109 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
 
@@ -9,9 +8,8 @@ Emerald is our official ParaTime which executes smart contracts inside the
 
 Emerald allows for:
 
-* Full EVM compatibility
-* Easy integration with EVM-based dApps, such as DeFi, NFT, Metaverse and crypto
-  gaming
+* Full EVM compatibility and easy integration with EVM-based dApps, such as
+DeFi, NFT, Metaverse and crypto gaming
 * Scalability: increased throughput of transactions
 * Low-cost: 99%+ lower fees than Ethereum
 * 6 second finality (1 block)
@@ -22,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/network.mdx b/docs/dapp/emerald/network.mdx
@@ -0,0 +1,97 @@
+---
+description: Network Information for Emerald
+---
+
+import {AddEmeraldToMetaMask as E, AddEmeraldTestnetToMetaMask as ET} from '@site/src/AddToMetaMask';
+
+# Network 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/emerald/writing-dapps-on-emerald.mdx b/docs/dapp/emerald/writing-dapps-on-emerald.mdx
@@ -76,8 +76,8 @@ ParaTime.
 
 [network-parameters]: ../../node/mainnet/README.md
 [Testnet]: ../../node/testnet/README.md
-[Emerald Mainnet]: ./README.mdx#mainnet
-[Emerald Testnet]: ./README.mdx#testnet
+[Emerald Mainnet]: ./network.mdx#mainnet
+[Emerald Testnet]: ./network.mdx#testnet
 
 ## Running a Private Oasis Network Locally
 

diff --git a/docs/dapp/tools/README.md b/docs/dapp/tools/README.md
@@ -1,10 +1,11 @@
 # Tools & Services
 
 Oasis integrates with a number of services and provides tooling support for
-developers using [Remix] (*unencrypted transactions only*), [Docker][localnet],
-and more. Please reach out to us on [Discord][discord] if you are using a tool
-that has problems integrating with Oasis.
+developers using [Remix] (*unencrypted transactions only*), [Sourcify],
+[Docker][localnet], and more. Please reach out to us on [Discord][discord] if
+you are using a tool that has problems integrating with Oasis.
 
 [Remix]: https://remix.run/docs/en/main
+[Sourcify]: /dapp/sapphire/verification
 [localnet]: /dapp/sapphire/guide#running-a-private-oasis-network-locally
 [discord]: https://oasis.io/discord
diff --git a/docs/general/manage-tokens/README.mdx b/docs/general/manage-tokens/README.mdx
@@ -105,8 +105,8 @@ chapter.
 ![Metamask - Adding Sapphire Mainnet Network Configuration](../images/wallet/metamask/settings.png)
 
 [MetaMask]: https://metamask.io/download/
-[Sapphire]: ../../dapp/sapphire/README.mdx#rpc-endpoints
-[Emerald]: ../../dapp/emerald/README.mdx#rpc-endpoints
+[Sapphire]: ../../dapp/sapphire/network.mdx#rpc-endpoints
+[Emerald]: ../../dapp/emerald/network.mdx#rpc-endpoints
 
 ### Ledger
 

diff --git a/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md b/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md
@@ -93,6 +93,6 @@ Now you can start using that wrapped assets across new Oasis dApps like the firs
 :::info
 
 Make sure that your MetaMask is connected to the Emerald Mainnet chain. You
-can find the network parameters [here](../../dapp/emerald/README.mdx#rpc-endpoints).
+can find the network parameters [here](../../dapp/emerald/network.mdx#rpc-endpoints).
 
 :::
diff --git a/docs/node/mainnet/README.md b/docs/node/mainnet/README.md
@@ -111,7 +111,7 @@ Feel free to use other IAS proxies besides the one provided here or
 
 :::info
 
-Check the [Emerald ParaTime page](/dapp/emerald/#rpc-endpoints) on how to access
+Check the [Emerald ParaTime page](/dapp/emerald/network#rpc-endpoints) on how to access
 the public Web3 endpoint.
 
 :::

diff --git a/docs/node/web3.mdx b/docs/node/web3.mdx
@@ -264,17 +264,17 @@ extended downtime while the Web3 Gateway is reindexing the blocks.
 [Emerald]: ../dapp/emerald/README.mdx
 [Emerald Mainnet launch]:
   https://medium.com/oasis-protocol-project/oasis-emerald-evm-paratime-is-live-on-mainnet-13afe953a4c9
-[emerald-mainnet]: ../dapp/emerald/README.mdx#mainnet
-[emerald-testnet]: ../dapp/emerald/README.mdx#testnet
+[emerald-mainnet]: ../dapp/emerald/network.mdx#mainnet
+[emerald-testnet]: ../dapp/emerald/network.mdx#testnet
 [github-releases]: https://github.com/oasisprotocol/oasis-web3-gateway/releases
 [Mainnet]: mainnet/README.md
 [mainnet-emerald]: mainnet/README.md#emerald
 [mainnet-sapphire]: mainnet/README.md#sapphire
 [Oasis archive node]: run-your-node/archive-node.md
 [README.md]: https://github.com/oasisprotocol/oasis-web3-gateway/blob/main/README.md#building-and-testing
 [Sapphire]: ../dapp/sapphire/README.mdx
-[sapphire-testnet]: ../dapp/sapphire/README.mdx#testnet
-[sapphire-mainnet]: ../dapp/sapphire/README.mdx#mainnet
+[sapphire-testnet]: ../dapp/sapphire/network.mdx#testnet
+[sapphire-mainnet]: ../dapp/sapphire/network.mdx#mainnet
 [system service]: run-your-node/prerequisites/system-configuration.mdx#create-a-user
 [Testnet]: testnet/README.md
 [testnet-emerald]: testnet/README.md#emerald

diff --git a/sidebarDapp.ts b/sidebarDapp.ts
@@ -16,9 +16,11 @@ export const sidebarDapp: SidebarsConfig = {
       },
       items: [
         'dapp/sapphire/quickstart',
+        'dapp/sapphire/network',
         'dapp/sapphire/guide',
         'dapp/sapphire/browser',
         'dapp/sapphire/authentication',
+        'dapp/sapphire/verification',
         'dapp/sapphire/gasless',
         'dapp/sapphire/addresses',
         'dapp/sapphire/deployment',
@@ -77,6 +79,7 @@ export const sidebarDapp: SidebarsConfig = {
         id: 'dapp/emerald/README',
       },
       items: [
+        'dapp/emerald/network',
         'dapp/emerald/writing-dapps-on-emerald',
       ],
     },