Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: network pages update #961

Merged
merged 1 commit into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions docs/dapp/cipher/network.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
description: Network Information for Cipher, with detailed information about RPCs, block explorer and indexer
---

# Network Information

## 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].

:::

Cipher endpoints share the gRPC protocol with the Oasis Core. You can connect to
one of the public endpoints below (in alphabetic order):

[paratime-client-node]: ../../node/run-your-node/paratime-client-node.mdx

| Provider | Mainnet RPC URLs | Testnet RPC URLs |
|-----------------------------|---------------------|-----------------------------|
| [Oasis Protocol Foundation] | `grpc.oasis.io:443` | `testnet.grpc.oasis.io:443` |

[Oasis Protocol Foundation]: https://oasisprotocol.org

## Block Explorers

| Name/Provider | Mainnet URL | Testnet URL | EIP-3091 compatible |
|-----------------------------|-------------------------------------------|-------------------------------------------|---------------------|
| Oasis Scan ([Bit Cat]) | [https://www.oasisscan.com/paratimes/000…7cb](https://www.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000e199119c992377cb) | [https://testnet.oasisscan.com/paratimes/000…000](https://testnet.oasisscan.com/paratimes/0000000000000000000000000000000000000000000000000000000000000000) | No |

[Bit Cat]: https://www.bitcat365.com/

:::tip

Only rudimentary block explorer features exist for Cipher. Consider debugging
Cipher transactions with the [`oasis paratime show`] command using the
[Oasis CLI].

:::

[`oasis paratime show`]: ../../general/manage-tokens/cli/paratime.md#show
[Oasis CLI]: ../../general/manage-tokens/cli/README.md

## Indexers

| Name (Provider) | Mainnet URL | Testnet URL | Documentation |
|-------------------------------------------|-------------------------------------------------------|--------------------------------------|-------------------|
| 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] |

[OasisScan-Testnet-docs]: https://api.oasisscan.com/testnet/swagger-ui/#/runtime-controller
[OasisScan-Mainnet-docs]: https://api.oasisscan.com/mainnet/swagger-ui/#/runtime-controller

:::note

If you are running your own Cipher 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
24 changes: 10 additions & 14 deletions docs/dapp/emerald/network.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,22 @@
---
description: Network Information for Emerald
description: Network Information for Emerald, with detailed information about chains, RPCs, block explorer and indexer
---

import {AddEmeraldToMetaMask as E, AddEmeraldTestnetToMetaMask as ET} from '@site/src/AddToMetaMask';

# Network Information

### Mainnet
## Networks

- Network name: `emerald`
- Long network name: `Oasis Emerald`
- Chain ID:
- Hex: `0xa516`
- Decimal: `42262`
| | Mainnet | Testnet | Localnet |
| ------------------| ----------------------------------- | ----------------------------------- |---------------------------------------- |
| Network name | `emerald` | `emerald-testnet` | `emerald-localnet`
| Long network name | `Oasis Emerald` | `Oasis Emerald Testnet` | `Oasis Emerald Localnet`
| Chain ID | Hex:`0xa516`<br /> Decimal: `42262` | Hex:`0xa515`<br /> Decimal: `42261` | Hex:`0xa514`<br /> Decimal: `42260`
| Tools | | [Testing token Faucet][faucet] | [Local development Docker image][localnet]

### Testnet

- Network name: `emerald-testnet`
- Long network name: `Oasis Emerald Testnet`
- Chain ID:
- Hex: `0xa515`
- Decimal: `42261`
[faucet]: https://faucet.testnet.oasis.io/
[localnet]: https://github.com/oasisprotocol/oasis-web3-gateway/tree/main/docker

## RPC Endpoints

Expand Down
4 changes: 2 additions & 2 deletions docs/dapp/emerald/writing-dapps-on-emerald.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ ParaTime.

[network-parameters]: ../../node/mainnet/README.md
[Testnet]: ../../node/testnet/README.md
[Emerald Mainnet]: ./network.mdx#mainnet
[Emerald Testnet]: ./network.mdx#testnet
[Emerald Mainnet]: ./network.mdx
[Emerald Testnet]: ./network.mdx

## Running a Private Oasis Network Locally

Expand Down
8 changes: 4 additions & 4 deletions docs/node/web3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/network.mdx#mainnet
[emerald-testnet]: ../dapp/emerald/network.mdx#testnet
[emerald-mainnet]: ../dapp/emerald/network.mdx
[emerald-testnet]: ../dapp/emerald/network.mdx
[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/network.mdx#testnet
[sapphire-mainnet]: ../dapp/sapphire/network.mdx#mainnet
[sapphire-testnet]: ../dapp/sapphire/network.mdx
[sapphire-mainnet]: ../dapp/sapphire/network.mdx
[system service]: run-your-node/prerequisites/system-configuration.mdx#create-a-user
[Testnet]: testnet/README.md
[testnet-emerald]: testnet/README.md#emerald
Expand Down
2 changes: 1 addition & 1 deletion external/sapphire-paratime
1 change: 1 addition & 0 deletions sidebarDapp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ export const sidebarDapp: SidebarsConfig = {
},
items: [
'dapp/cipher/prerequisites',
'dapp/cipher/network',
'dapp/cipher/hello-world',
'dapp/cipher/confidential-smart-contract',
{
Expand Down