Merge pull request #598 from chainstack/feature/oasis-protocol

Oasis protocol onboarding
chainstack · Mar 29, 2023 · 3e2063b · 3e2063b
2 parents 6aef7db + 2dbfe52
commit 3e2063b
Show file tree

Hide file tree

Showing 17 changed files with 903 additions and 2 deletions.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-3.11.1+{BUILD_NUM}
+3.11.2+{BUILD_NUM}
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -208,6 +208,17 @@ module.exports = {
                             '/operations/aptos/tools',
                         ]
                     },
+                    {
+                        title: 'Oasis Sapphire',
+                        collapsable: true,
+                        children: [
+                            '/operations/oasis-sapphire/',
+                            '/operations/oasis-sapphire/networks',
+                            '/operations/oasis-sapphire/types',
+                            '/operations/oasis-sapphire/modes',
+                            '/operations/oasis-sapphire/tools',
+                        ]
+                    },
                     {
                         title: 'Gnosis Chain',
                         collapsable: true,
@@ -454,6 +465,14 @@ module.exports = {
                             '/tutorials/aptos/publish-module-to-save-and-retrieve-message-on-aptos',
                         ]
                     },
+                    {
+                        title: 'Oasis Sapphire',
+                        collapsable: true,
+                        children: [
+                            '/tutorials/oasis-sapphire/',
+                            '/tutorials/oasis-sapphire/understanding-confidential-smart-contracts-using-oasis-sapphire',
+                        ]
+                    },
                     {
                         title: 'Gnosis Chain',
                         collapsable: true,
@@ -836,6 +855,7 @@ module.exports = {
                     '/blockchains/aurora',
                     '/blockchains/solana',
                     '/blockchains/aptos',
+                    '/blockchains/oasis-sapphire',
                     '/blockchains/gnosis',
                     '/blockchains/cronos',
                     '/blockchains/filecoin',

diff --git a/docs/blockchains/oasis-sapphire.md b/docs/blockchains/oasis-sapphire.md
@@ -0,0 +1,20 @@
+---
+meta:
+  - name: description
+    content: The Oasis Sapphire is a layer 1 protocol secured by proof-of-stake.
+  - name: keywords
+    content: oasis sapphire network blockchain protocol pos paratime
+---
+
+# Oasis Sapphire
+
+Oasis Sapphire is a layer 1 EVM-compatible blockchain protocol that uses its own parallel runtime technology called ParaTimes and is secured by the proof-of-stake consensus.
+
+The Oasis Sapphire ParaTime allows for confidential smart contracts execution with another Oasis unique technology—Secure Enclave. Secure Enclave serves as a black box for smart contracts: a smart contract and encrypted data get decrypted and processed inside it, and then re-encrypted before being sent out of the box. By following this process, the confidentiality of the data is maintained and it is kept from being disclosed to the node operator or the DApp developer.
+
+::: tip See also
+
+* [The Oasis Network overview](https://docs.oasis.io/general/oasis-network/)
+* [Sapphire ParaTime](https://docs.oasis.io/dapp/sapphire/)
+
+:::
diff --git a/docs/operations/oasis-sapphire/README.md b/docs/operations/oasis-sapphire/README.md
@@ -0,0 +1,15 @@
+---
+meta:
+  - name: description
+    content: Learn what Oasis Sapphire networks you can deploy your nodes on, difference between full and archive nodes, and how to connect to your Oasis Sapphire node.
+  - name: keywords
+    content: oasis network node deploy contract full archive
+---
+
+# Introduction
+
+This section outlines the fundamentals of and operations for the Oasis Sapphire.
+
+Deploying an Oasis node with Chainstack provides you with a near-instantly fully synchronized Oasis node through the use of [Bolt](/glossary/bolt).
+
+Learn about [the supported networks](/operations/oasis-sapphire/networks), [full and archive node modes](/operations/oasis-sapphire/modes), and how to [interact with your node](/operations/oasis-sapphire/tools).
diff --git a/docs/operations/oasis-sapphire/modes.md b/docs/operations/oasis-sapphire/modes.md
@@ -0,0 +1,30 @@
+---
+meta:
+  - name: description
+    content: Learn about which Oasis Sapphire node you can deploy using the Chainstack platform
+  - name: keywords
+    content: oasis sapphire paratime network full node
+---
+
+# Modes
+
+Chainstack currently supports deploying Oasis Sapphire nodes in the full mode only.
+
+A full Oasis Sapphire node stores the complete blockchain data and enables transactions and calls to confidential smart contracts deployed onto the network.
+
+See [Geth JSON-RPC methods](https://eth.wiki/json-rpc/API#the-default-block-parameter) that support querying at a block number.
+
+Query example to get the balance of an address at a block number:
+
+``` js
+> eth.getBalance("0x4EA0911033792C93639bEd297B9289E136d86F89")
+924207076563996860320
+```
+
+::: tip See also
+
+* [Networks](/operations/oasis-sapphire/networks)
+* [Tools](/operations/oasis-sapphire/tools)
+* [Tutorials](/tutorials/oasis-sapphire/)
+
+:::
diff --git a/docs/operations/oasis-sapphire/networks.md b/docs/operations/oasis-sapphire/networks.md
@@ -0,0 +1,23 @@
+---
+meta:
+  - name: description
+    content: Deploy a public Oasis Sapphire mainnet or testnet node with the Chainstack managed blockchain services in minutes.
+  - name: keywords
+    content: oasis network sapphire mainnet testnet node
+---
+
+# Networks
+
+Chainstack supports joining the following Oasis Sapphire networks:
+
+* Mainnet — public Oasis Sapphire mainnet.
+* Testnet — public Oasis Sapphire testnet.
+
+For development purposes on the Sapphire testnet, use [the Oasis Network faucet](https://faucet.testnet.oasis.dev).
+
+::: tip See also
+
+* [Tools](/operations/oasis-sapphire/tools)
+* [Tutorials](/tutorials/oasis-sapphire/)
+
+:::
diff --git a/docs/operations/oasis-sapphire/tools.md b/docs/operations/oasis-sapphire/tools.md
@@ -0,0 +1,227 @@
+---
+meta:
+  - name: description
+    content: Learn how to interact with your Oasis Sapphire node and develop DApps.
+  - name: keywords
+    content: oasis sapphire api dapp cli javascript geth truffle hardhat
+---
+
+# Tools
+
+::: tip Information
+Due to confidential nature of smart contracts in the Sapphire ParaTime, reading contents of smart contracts with `eth_call` is not currently supported.
+:::
+
+## Interaction tools
+
+### Geth
+
+Interact with your Oasis Sapphire node using [Geth](https://geth.ethereum.org/docs/getting-started).
+
+1. Install [Geth](https://github.com/ethereum/go-ethereum).
+2. Use `geth attach` command with the node endpoint.
+
+    ``` sh
+    geth attach YOUR_CHAINSTACK_ENDPOINT
+    ```
+
+    where YOUR_CHAINSTACK_ENDPOINT — your node HTTPS or WSS endpoint protected either with the key or password. See [View node access and credentials](/platform/view-node-access-and-credentials).
+
+1. Invoke any methods from [Web3 JavaScript API (opens new window)](https://web3js.readthedocs.io/).
+
+Example below demonstrates how to get the balance of an address in wei value and convert it to ether value:
+
+``` js
+web3.fromWei(web3.eth.getBalance("0x4EA0911033792C93639bEd297B9289E136d86F89"))
+```
+
+### MetaMask
+
+On [node access details](/platform/view-node-access-and-credentials), click **Add to MetaMask**.
+
+## Development tools
+
+### Truffle
+
+Configure [Truffle Suite](https://truffleframework.com/) to deploy contracts to your Oasis Sapphire nodes.
+
+1. Install [Truffle Suite](https://truffleframework.com/), [HD Wallet-enabled Web3 provider](https://github.com/trufflesuite/truffle/tree/develop/packages/hdwallet-provider), and create a project.
+1. Install the [sapphire-hardhat](https://www.npmjs.com/package/@oasisprotocol/sapphire-hardhat) plugin.
+1. Install the [dotenv](https://www.npmjs.com/package/dotenv) package to securely load your sensitive variables from a `.env` file
+1. Create a new environment, and define a new network, in `truffle-config.js`:
+
+    ``` js
+    require('dotenv').config();
+    const sapphire = require("@oasisprotocol/sapphire-paratime");
+    const HDWalletProvider = require("@truffle/hdwallet-provider");
+    module.exports = {
+      networks: {
+        sapphire_testnet: {
+          provider: () => {
+			     sapphire.wrap(
+            new HDWalletProvider([process.env.YOUR_PRIVATE_KEY], `${process.env.YOUR_CHAINSTACK_ENDPOINT}`));
+               },
+          network_id: 0x5aff,
+        },
+      },
+    compilers: {
+        solc: {
+          version: "0.8.13",
+        },
+      },
+
+
+    };
+    ```
+
+### Hardhat
+
+Configure [Hardhat](https://hardhat.org/) to deploy contracts and interact through your Oasis Sapphire nodes.
+
+1. Install [Hardhat](https://hardhat.org/) and create a project.
+1. Install the [sapphire-hardhat](https://www.npmjs.com/package/@oasisprotocol/sapphire-hardhat) plugin.
+2. Install the [dotenv](https://www.npmjs.com/package/dotenv) package to securely load your sensitive variables from a `.env` file
+3. Create a new environment in `hardhat.config.js`:  
+
+    ``` js
+    require("@nomicfoundation/hardhat-toolbox");
+    require('@oasisprotocol/sapphire-hardhat');
+    require('dotenv').config();
+
+    module.exports = {
+      solidity: "0.8.18",
+      defaultNetwork: "sapphire_testnet",
+      networks: {
+        sapphire_testnet: {
+            url: `${process.env.YOUR_CHAINSTACK_ENDPOINT}`,
+            accounts: [process.env.YOUR_PRIVATE_KEY],
+    				chainId: 0x5aff,
+        },
+    },
+
+    };
+    ```
+
+    where
+
+    - YOUR_CHAINSTACK_ENDPOINT — your node HTTPS or WSS endpoint protected either with the key or password. See [node access details](/platform/view-node-access-and-credentials).
+    - YOUR_PRIVATE_KEY — the private key of the account that you use to deploy the contract
+
+5. Run `npx hardhat run --network sapphire_testnet scripts/deploy.js`, and Hardhat will deploy using Chainstack.
+
+### web3.js
+
+Build DApps using [web3.js](https://github.com/ethereum/web3.js/) and Oasis Sapphire nodes deployed with Chainstack.
+
+1. Install [web3.js](https://web3js.readthedocs.io/).
+2. Connect over HTTP or WebSocket.
+
+#### HTTPS
+
+Use the `HttpProvider` object to connect to your node HTTPS endpoint and get the latest block number:
+
+``` js
+const Web3 = require('web3');
+
+const web3 = new Web3(new Web3.providers.HttpProvider('YOUR_CHAINSTACK_ENDPOINT'));
+
+web3.eth.getBlockNumber().then(console.log);
+
+```
+
+where YOUR_CHAINSTACK_ENDPOINT is your node HTTPS endpoint protected either with the key or password.
+
+#### WSS
+
+Use the `WebsocketProvider` object to connect to your node WSS endpoint and get the latest block number:
+
+``` js
+const Web3 = require('web3');
+
+const web3 = new Web3(new Web3.providers.WebsocketProvider('YOUR_CHAINSTACK_ENDPOINT'));
+
+web3.eth.getBlockNumber().then(console.log);
+
+```
+
+where YOUR_CHAINSTACK_ENDPOINT is your node WSS endpoint protected either with the key or password.
+
+### Node.js
+
+You can build a web app to query data using node.js and [axios](https://www.npmjs.com/package/axios):
+
+``` js
+const axios = require("axios");
+
+const payload = {
+    jsonrpc: "2.0",
+    id: 0,
+    method: "eth_blockNumber",
+    params: []
+
+};
+
+(async () => {
+    const response = await axios.post(`YOUR_CHAINSTACK_ENDPOINT`, payload)
+    console.log(response.data)
+})();
+```
+
+- YOUR_CHAINSTACK_ENDPOINT — your Chainstack node endpoint protected either with the key or password. See [node access details](/platform/view-node-access-and-credentials).
+- `query` — your JSON-RPC query. In this case, to get the latest block number.
+
+### ethers.js
+
+Build DApps using [ethers.js](https://github.com/ethers-io/ethers.js/) and Oasis Sapphire nodes deployed with Chainstack.
+
+1. Install [ethers.js](https://www.npmjs.com/package/ethers).
+2. Connect over HTTPS or WebSocket. See also [EVM node connection: HTTP vs WebSocket](https://support.chainstack.com/hc/en-us/articles/900002187586-Ethereum-node-connection-HTTP-vs-WebSocket).
+
+#### HTTPS
+
+Use the `JsonRpcProvider` object to connect to your node endpoint and get the balance of any address:
+
+``` js
+const ethers = require('ethers');
+const NODE_URL = "YOUR_CHAINSTACK_ENDPOINT ";
+const provider = new ethers.JsonRpcProvider(NODE_URL, 23295);
+const eth_getBalance = async () => {
+    const balance = await provider.getBalance("ACCOUNT_ADDRESS");
+    console.log(balance);
+  };
+eth_getBalance()
+```
+
+where
+- YOUR_CHAINSTACK_ENDPOINT — your node HTTPS endpoint protected either with the key or password
+- `23295` — the Oasis Sapphire test network ID
+- ACCOUNT_ADDRESS — the Oasis Sapphire account address
+
+#### WebSocket
+
+Use the `WebSocketProvider` object to connect to your node WSS endpoint and get the latest block number:
+
+``` js
+const ethers = require('ethers');
+const NODE_URL = "YOUR_CHAINSTACK_ENDPOINT";
+const provider = new ethers.WebSocketProvider(NODE_URL, NETWORK_ID);
+const eth_getBalance = async () => {
+    const balance = await provider.getBalance("ACCOUNT_ADDRESS");
+    console.log(balance);
+  };
+eth_getBalance()
+```
+
+where
+- YOUR_CHAINSTACK_ENDPOINT — your node WSS endpoint endpoint protected either with the key or password
+- `23295` — the Oasis Sapphire test network ID
+- ACCOUNT_ADDRESS — the Oasis Sapphire account address
+
+### Remix IDE
+
+To make Remix IDE interact with the network through a zkEVM node deployed with Chainstack:
+
+1. Get [MetaMask](https://metamask.io/) and set it to interact through a Chainstack node. See [Interacting through MetaMask](#metamask).
+2. In Remix IDE, navigate to the **Deploy** tab. Select **Injected Provider - MetaMask** in **Environment**.
+
+This will engage MetaMask and make Remix IDE interact with the network through a Chainstack node.
diff --git a/docs/operations/oasis-sapphire/types.md b/docs/operations/oasis-sapphire/types.md
@@ -0,0 +1,19 @@
+---
+meta:
+  - name: description
+    content: Learn the difference between an elastic and a dedicated Oasis Sapphire node deployed with the Chainstack managed blockchain services.
+  - name: keywords
+    content: oasis network node elastic dedicated blockchain
+---
+
+# Types
+
+Chainstack currently supports deploying elastic Oasis Sapphire nodes only.
+
+::: tip See also
+
+* [Modes](/operations/oasis-sapphire/modes)
+* [Tools](/operations/oasis-sapphire/tools)
+* [Tutorials](/tutorials/oasis-sapphire/)
+
+:::
diff --git a/docs/operations/polygon-zkevm/networks.md b/docs/operations/polygon-zkevm/networks.md
@@ -8,7 +8,10 @@ meta:
 
 # Networks
 
-Chainstack currently supports joining Polygon zkEVM testnet.
+Chainstack supports joining the following Polygon zkEVM networks:
+
+* Testnet - public Polygon zkEVM testnet
+* Mainnet - public Polygon zkEVM mainnet
 
 For development purposes on the testnet, fund your accounts with [Goerli testnet ether](https://goerli-faucet.pk910.de) and bridge them to Polygon zkEVM testnet.