Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
aefhm committed Sep 21, 2024
1 parent 81fb377 commit d2732f0
Showing 1 changed file with 135 additions and 0 deletions.
135 changes: 135 additions & 0 deletions docs/README.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
import DocCardList from '@theme/DocCardList';
import {findSidebarItem} from '@site/src/sidebarUtils';
import {AddSapphireToMetaMask as S, AddSapphireTestnetToMetaMask as ST} from '@site/src/AddToMetaMask';

# Sapphire ParaTime

Sapphire is our official confidential ParaTime providing a smart contract
development environment with [Ethereum Virtual Machine (EVM)] compatibility.

As the official confidential EVM-compatible ParaTime on the Oasis Network,
Sapphire allows for:

* Confidential state, end-to-end encryption, confidential randomness
* EVM compatibility
* 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)
* Cross-chain bridge to enable cross-chain interoperability (upcoming)

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).

[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`

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

[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 | Supports Confidential Queries |
|--------------|----------------------------------------|-------------------------------|-------------------------------|
| [1RPC] | [docs.1rpc.io][1RPC-docs] | [Pricing][1RPC-pricing] | Yes |
| [Chainstack] | [docs.chainstack.com][Chainstack-docs] | [Pricing][Chainstack-pricing] | Yes |


[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

## See also

<DocCardList items={[
findSidebarItem('/general/manage-tokens/'),
findSidebarItem('/node/run-your-node/paratime-node'),
findSidebarItem('/node/run-your-node/paratime-client-node'),
findSidebarItem('/node/web3'),
findSidebarItem('/dapp/emerald/'),
findSidebarItem('/dapp/cipher/'),
]} />

0 comments on commit d2732f0

Please sign in to comment.