oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-07-01 06:02:10 +02:00
Code Releases Activity

Merge pull request #514 from oceanprotocol/feature/networks-consolidation

Browse Source 
consolidate all network infos
This commit is contained in:
Matthias Kretschmann 2021-01-18 16:31:43 +01:00 committed by GitHub
commit fc5d6a6513
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 118 additions and 179 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.markdownlint.json
View File

@ -10,5 +10,6 @@
"first-heading-h1": false,
"no-trailing-punctuation": false,
"ol-prefix": false,
"ul-style": { "style": "dash" }
"ul-style": { "style": "dash" },
"no-emphasis-as-header": false
}

24
config.js
View File

@ -44,6 +44,30 @@ module.exports = {
{
from: '/setup/compute-to-data/',
to: '/tutorials/compute-to-data/'
},
{
from: '/concepts/networks-overview/',
to: '/concepts/networks/'
},
{
from: '/concepts/network-ethmainnet/',
to: '/concepts/networks/'
},
{
from: '/concepts/network-rinkeby/',
to: '/concepts/networks/'
},
{
from: '/concepts/network-ropsten/',
to: '/concepts/networks/'
},
{
from: '/concepts/network-local/',
to: '/concepts/networks/'
},
{
from: '/concepts/connect-to-networks/',
to: '/concepts/networks/'
}
]
}

22
content/concepts/connect-to-networks.md
View File

@ -1,22 +0,0 @@
---
title: Connect Wallets to Networks
description:
---
## Connect to Ethereum mainnet
Ocean's on Ethereum mainnet, for production usage.
Metamask and other ERC20 wallets default to Ethereum mainnet. Therefore your wallet is almost certainly pointing to Ethereum by default.
## Connect to public testnets
`Rinkeby` and `Ropsten` are prominent Ethereum testnets. Ocean is deployed to both.
In MetaMask, click on the network name dropdown, then select `Rinkeby` or `Ropsten`. That's it.
## Connect to local Ganache testnet
In MetaMask, click on the network name then click on `Custom RPC` in the drop-down list. Scroll down to the `New Network` section. Enter the above RPC URL. You don't need to add a port number to the end of the RPC URL. Enter the ChainID, Symbol and Nickname if you like. See the [MetaMask docs about how it uses the ChainID](https://metamask.github.io/metamask-docs/Main_Concepts/Sending_Transactions).

41
content/concepts/get-ether-and-ocean-tokens.md
View File

@ -1,41 +0,0 @@
---
title: Get ETH and OCEAN Tokens
description: How to get tokens for each network
---
## Overview
In each network, you'll need ETH to pay for gas, and OCEAN for certain Ocean actions.
Ethereum mainnet is a network for production settings. Accordingly, ETH and OCEAN tokens have _real_ value.
Other networks are test networks. The ETH and OCEAN tokens in each of these networks don't have real value. The tokens are simply stand-ins to be able to test. They have "faucets" to dole out ETH and OCEAN.
## Ethereum mainnet
- **ETH** [Exchanges to purchase ETH](https://www.coingecko.com/en/coins/ethereum#markets).
- **OCEAN** [Official exchanges to purchase OCEAN](https://oceanprotocol.com/token#get).
## Rinkeby testnet
- **ETH** [ETH faucet for Rinkeby](https://faucet.rinkeby.io/). You may find others by [searching](https://www.google.com/search?q=rinkeby+ether+faucet&oq=rinkeby+ether+faucet).
- **OCEAN** [OCEAN faucet for Rinkeby](https://faucet.rinkeby.oceanprotocol.com).
## Ropsten testnet
Ropsten has a faucet to dole out ETH, and another for OCEAN.
- **ETH** [ETH faucet for Ropsten](https://faucet.dimensions.network/). You may find others by [searching](https://www.google.com/search?q=ropsten+ether+faucet&oq=ropsten+ether+faucet).
- **OCEAN** [OCEAN faucet for Ropsten](https://faucet.ropsten.oceanprotocol.com).
## Local network
Ganache is a local test network.
- **ETH.** By default, Ganache creates several Ethereum accounts at launch, gives each some ETH, and makes their private keys available in the logs. You can also instruct Ganache to give ETH to specific Ethereum addresses.
- **OCEAN.** You can deploy an ERC20 token with label OCEAN. You'll see examples in the quickstarts for the Ocean JavaScript and Python drivers.

17
content/concepts/network-ethmainnet.md
View File

@ -1,17 +0,0 @@
---
title: Ethereum Mainnet
description: Details of Ethereum deployment & services
---
## Smart Contracts
Ocean contracts are deployed to Ethereum mainnet at **[these addresses](https://github.com/oceanprotocol/contracts/blob/master/artifacts/address.json)**.
## Mainnet-Related Services
| What | URL |
| ----------------------- | ------------------------------------------ |
| Etherscan explorer | https://etherscan.io/ |
| Ocean Market main | https://market.oceanprotocol.com |
| Ocean Market - Provider | https://provider.mainnet.oceanprotocol.com |
| Ocean Market - Aquarius | https://aquarius.mainnet.oceanprotocol.com |

16
content/concepts/network-local.md
View File

@ -1,16 +0,0 @@
---
title: Ganache Local Testnet
description: Details of Ganache deployment & services
---
## Smart Contracts
[Ganache](https://www.trufflesuite.com/ganache) is a local Ethereum "network" that you run on your machine for fast iterations while developing your app.
The most straighforward case for local development is to use Ocean [Barge](https://www.github.com/oceanprotocol/barge). It runs Ganache in addition to Aquarius and Provider.
Alternatively, you can run Ganache independently. Install it according to [the Ganache docs](https://www.trufflesuite.com/ganache). Then deploy Ocean contracts onto Ganache following [docs in Ocean contracts repo](https://www.github.com/oceanprotocol/contracts).
Ganache is at the RPC URL [http://localhost:8545](http://localhost:8545).
To connect from Metamask: in Metamask, connect to the network called "Localhost 8545".

17
content/concepts/network-rinkeby.md
View File

@ -1,17 +0,0 @@
---
title: Rinkeby Testnet
description: Details of Rinkeby deployment & services
---
## Smart Contracts
Ocean contracts are deployed to Rinkeby network at **[these addresses](https://github.com/oceanprotocol/contracts/blob/master/artifacts/address.json)**.
## Rinkeby-Related Services
| What | URL |
| ----------------------- | ------------------------------------------------------------------------------------------- |
| Etherscan explorer | https://rinkeby.etherscan.io/ |
| Ocean Market | Point wallet to Rinkeby network, at usual Ocean Market url: https://market.oceanprotocol.com |
| Ocean Market - Provider | https://provider.rinkeby.oceanprotocol.com |
| Ocean Market - Aquarius | https://aquarius.rinkeby.oceanprotocol.com |

17
content/concepts/network-ropsten.md
View File

@ -1,17 +0,0 @@
---
title: Ropsten Testnet
description: Details of Ropsten deployment & services
---
## Smart Contracts
Ocean contracts are deployed to Ropsten network at **[these addresses](https://github.com/oceanprotocol/contracts/blob/master/artifacts/address.json)**.
## Ropsten-Related Services
| What | URL |
| ----------------------- | ------------------------------------------------------------------------------------------- |
| Etherscan explorer | https://ropsten.etherscan.io/ |
| Ocean Market | Point wallet to Ropsten network, at usual Ocean Market url: https://market.oceanprotocol.com |
| Ocean Market - Provider | https://provider.ropsten.oceanprotocol.com |
| Ocean Market - Aquarius | https://aquarius.ropsten.oceanprotocol.com |

28
content/concepts/networks-overview.md
View File

@ -1,28 +0,0 @@
---
title: Supported Networks
description:
---
## Summary
Ocean is deployed to these public networks:
- [Ethereum mainnet](/concepts/network-ethmainnet/) - production
- [Rinkeby](/concepts/network-rinkeby/) - testnet
- [Ropsten](/concepts/network-ropsten) - testnet
You can also run your own local testnet:
- [Ganache](/concepts/network-local) - local testnet
## Chain ids
Some apps may need `network_id` and `chain_id`. Here's a [list of values for major Ethereum networks](https://medium.com/@piyopiyo/list-of-ethereums-major-network-and-chain-ids-2bc58e928508).
## Barge
**Barge** is a shell script to help developers run Ocean Provider (data service) and Ocean Aquarius (metadata cache). It points to Ganache by default.
Barge is used used extensively by the Ocean core devs (with Ganache or Rinkeby).
<repo name="barge"></repo>

90
content/concepts/networks.md Normal file
View File

@ -0,0 +1,90 @@
---
title: Supported Networks
description: All the public networks the Ocean Protocol contracts are deployed to, and additional core components deployed to them.
---
Ocean Protocol contracts are deployed on multiple public Ethereum networks. You can always find the most up-to-date deployment addresses for all individual contracts in the [address.json](https://github.com/oceanprotocol/contracts/blob/master/artifacts/address.json) artifact.
In each network, you’ll need ETH to pay for gas, and OCEAN for certain Ocean actions. Because the Ethereum mainnet is a network for production settings, ETH and OCEAN tokens have real value on there. The ETH and OCEAN tokens in each test network don’t have real value and are used for testing-purposes only. They can be obtained with _faucets_ to dole out ETH and OCEAN.
## Mainnet
The Ethereum Mainnet is Ocean’s production network.
MetaMask and other ERC20 wallets default to Ethereum mainnet, therefore your wallet is almost certainly pointing to Ethereum by default.
**Get Tokens**
- ETH: [Exchanges to purchase](https://www.coingecko.com/en/coins/ethereum#markets)
- OCEAN: [Official exchanges to purchase](https://oceanprotocol.com/token#get).
**Additional Components**
| What | URL |
| ------------ | -------------------------------------------- |
| Explorer | `https://etherscan.io` |
| Ocean Market | `https://market.oceanprotocol.com` |
| Provider | `https://provider.mainnet.oceanprotocol.com` |
| Aquarius | `https://aquarius.mainnet.oceanprotocol.com` |
| Subgraph | `https://subgraph.mainnet.oceanprotocol.com` |
## Ropsten
Ropsten is a test network.
In MetaMask and other ERC20 wallets, click on the network name dropdown, then select _Ropsten_.
**Get Tokens**
- ETH: [Faucet for Ropsten](https://faucet.dimensions.network/). You may find others by [searching](https://www.google.com/search?q=ropsten+ether+faucet&oq=ropsten+ether+faucet).
- OCEAN: [Faucet for Ropsten](https://faucet.ropsten.oceanprotocol.com/)
**Additional Components**
| What | URL |
| ------------ | ---------------------------------------------------------------------- |
| Explorer | `https://ropsten.etherscan.io` |
| Ocean Market | Point wallet to Ropsten network, at `https://market.oceanprotocol.com` |
| Provider | `https://provider.ropsten.oceanprotocol.com` |
| Aquarius | `https://aquarius.ropsten.oceanprotocol.com` |
| Subgraph | `https://subgraph.ropsten.oceanprotocol.com` |
## Rinkeby
Rinkeby is a test network.
In MetaMask and other ERC20 wallets, click on the network name dropdown, then select _Rinkeby_.
**Get Tokens**
- ETH: [Faucet for Rinkeby](https://faucet.rinkeby.io/). You may find others by [searching](https://www.google.com/search?q=rinkeby+ether+faucet&oq=rinkeby+ether+faucet).
- OCEAN: [Faucet for Rinkeby](https://faucet.rinkeby.oceanprotocol.com/)
**Additional Components**
| What | URL |
| ------------ | ---------------------------------------------------------------------- |
| Explorer | `https://rinkeby.etherscan.io` |
| Ocean Market | Point wallet to Rinkeby network, at `https://market.oceanprotocol.com` |
| Provider | `https://provider.rinkeby.oceanprotocol.com` |
| Aquarius | `https://aquarius.rinkeby.oceanprotocol.com` |
| Subgraph | `https://subgraph.rinkeby.oceanprotocol.com` |
## Local
The most straightforward way for local-only development is to use [Barge](https://www.github.com/oceanprotocol/barge), which runs [Ganache](https://www.trufflesuite.com/ganache), Aquarius, and Provider. It is used extensively by the Ocean core devs (with Ganache or Rinkeby) and for automated integration testing.
<repo name="barge"></repo>
To connect to it from MetaMask, select the network called _Localhost 8545_.
Alternatively, you can run Ganache independently. Install it according to [the Ganache docs](https://www.trufflesuite.com/ganache). Then deploy Ocean contracts onto Ganache following [docs in Ocean contracts repo](https://www.github.com/oceanprotocol/contracts). Ganache is at the RPC URL [http://localhost:8545](http://localhost:8545).
**Get Tokens**
- ETH: By default, Ganache creates several Ethereum accounts at launch, gives each some ETH, and makes their private keys available in the logs. You can also instruct Ganache to give ETH to specific Ethereum addresses.
- OCEAN: You can deploy an ERC20 token with label OCEAN. You’ll see examples in the quickstarts for the Ocean JavaScript and Python drivers.
## Chain IDs
Some apps may need `network_id` and `chain_id`. Here's a [list of values for major Ethereum networks](https://medium.com/@piyopiyo/list-of-ethereums-major-network-and-chain-ids-2bc58e928508).

20
data/sidebars/concepts.yml
View File

@ -6,26 +6,8 @@
link: /concepts/quickstart/
- title: Architecture Overview
link: /concepts/architecture/
- group: Networks & Tokens
items:
- title: Supported Networks
link: /concepts/networks-overview/
- title: Connect Wallets to Networks
link: /concepts/connect-to-networks/
- title: Get ETH and OCEAN Tokens
link: /concepts/get-ether-and-ocean-tokens/
- group: Specific Network Info
items:
- title: Ethereum Mainnet
link: /concepts/network-ethmainnet/
- title: Rinkeby Testnet
link: /concepts/network-rinkeby/
- title: Ropsten Testnet
link: /concepts/network-ropsten/
- title: Ganache Local Testnet
link: /concepts/network-local/
link: /concepts/networks/
- group: Compute-to-Data
items:

2
src/templates/Doc.jsx
View File

@ -118,7 +118,7 @@ export const pageQuery = graphql`
query DocBySlug($slug: String!) {
markdownRemark(fields: { slug: { eq: $slug } }) {
id
tableOfContents(maxDepth: 3)
tableOfContents(maxDepth: 2)
html
htmlAst
frontmatter {