oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
Code Releases Activity

Add Ropsten. Rearrange things

Browse Source
This commit is contained in:
trentmc 2020-12-10 13:24:35 +01:00
parent f6f7bb637c
commit c3eb69b5e0
10 changed files with 114 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -3,6 +3,7 @@ yarn.lock
yarn-error.log
.cache
/public
/external
.DS_Store
.env
.env.*

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

@ -1,9 +1,13 @@
---
title: Network - Ethereum Mainnet
description: Tools for development on Ethereum Mainnet
title: Ethereum Mainnet
description:
---
Ocean is deployed to Ethereum mainnet. This network is for your app's production deployment. Here are tools related to this deployment. [Here](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/mainnet.md) are the addresses of the deployed contracts.
## Smart Contracts
Ocean contracts are deployed to Ethereum mainnet. [Here](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/mainnet.md) are the addresses.
## Mainnet-Related Services
| What | URL |
| ----------------------- | ------------------------------------------ |

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

@ -1,14 +1,18 @@
---
title: Network - Local / Barge
description: Tools for development on a local Ethereum network
title: Ganache Local Testnet
description:
---
You can deploy Ocean onto [Ganache](https://www.trufflesuite.com/ganache) - a local Ethereum "network" that you run on your machine for fast iterations while developing your app. You can easily do that with Barge.
## Smart Contracts
**Barge** is a shell script to help run Ocean components (Provider, Aquarius), which runs Ganache by default.
[Ganache](https://www.trufflesuite.com/ganache) is a local Ethereum "network" that you run on your machine for fast iterations while developing your app.
<repo name="barge"></repo>
You can deploy Ocean contracts onto Ganache. The [Ocean contracts repo](https://www.github.com/oceanprotocol/contracts) has further instructions.
Barge launches Docker and Docker Compose, to run Ganache with Ocean smart contracts on top, along with Provider and Aquarius metadata cache. It's used extensively by the Ocean core devs (with Ganache or Rinkeby).
## Connect Metamask wallet to Ganache
The [Connect-to-Networks](/tutorials/connect-to-networks/) tutorial has more information about connecting your wallet / app to Ganache.
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).
## Connect Barge to Ganache
If you're using [Barge](https://www.github.com/oceanprotocol/barge) to help run a local network, you can connect to that local node at RPC URL [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask). You can configure that local node by editing the files in the `barge/networks/pacific/config/` directory.

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

@ -1,17 +1,17 @@
---
title: Network - Rinkeby / Barge
description: Tools for development on Ethereum Rinkeby testnet
title: Rinkeby Testnet
description:
---
Ocean is deployed to Rinkeby network. Rinkeby is useful for testing your app's deployment before final production deployment. [Here](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/rinkeby.md) are the addresses of the deployed contracts.
## Smart Contracts
**Barge** can be run with Rinkeby as well. This is a useful configuration for development flows.
Ocean contracts are deployed to Rinkeby network. [Here](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/rinkeby.md) are the addresses.
Here are tools related to Rinkeby deployment.
## 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 | 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 Normal file
View File

@ -0,0 +1,17 @@
---
title: Ropsten Testnet
description:
---
## Smart Contracts
Ocean contracts are deployed to Ropsten network. [Here](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/ropsten.md) are the addresses.
## 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 |

29
content/concepts/networks-overview.md Normal file
View File

@ -0,0 +1,29 @@
---
title: Networks Overview
description: Development on various Ethereum networks
---
## Supported Networks
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
## 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>
## Chain ids
Some apps may need `network_id` and `chain_id`. [Here's](https://medium.com/@piyopiyo/list-of-ethereums-major-network-and-chain-ids-2bc58e928508) a list of values for major Ethereum networks.

26
content/tutorials/connect-to-networks.md
View File

@ -1,30 +1,26 @@
---
title: Connect to Ocean-Related Networks
description: On connecting to Ethereum, Rinkeby and Your Local Network.
description: On connecting your wallet to Ethereum networks
---
## 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.
Some apps may need `network_id` and `chain_id`. The values are both `1` for Ethereum mainnet. `Symbol` and `nickname` can be whatever value you like.
## Connect to Rinkeby testnet
## Connect to testnets
In MetaMask, click on the network name dropdown, then select `Rinkeby`.
`Rinkeby` and `Ropsten` are prominent Ethereum test nets. Ocean is deployed to both.
To connect: In MetaMask, click on the network name dropdown, then select `Rinkeby` or `Ropsten`. That's it.
## For Developers
[Here's](/concepts/networks-overview) documentation about networks for developers.
Its `network_id` is 3 and `chain_id` is 3.
## Connect to local Ganache network
**Metamask.** 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).
**Barge.** If you're using Ocean [Barge](https://github.com/oceanprotocol/barge) to help run a local network, you can connect to that local node at RPC URL [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask). You can configure that local node by editing the files in the `barge/networks/pacific/config/` directory.
## More info
- [List of Ethereum's Major Networks and Chain ids](https://medium.com/@piyopiyo/list-of-ethereums-major-network-and-chain-ids-2bc58e928508).
- [Ganache documentation](https://www.trufflesuite.com/ganache)

28
content/tutorials/get-ether-and-ocean-tokens.md
View File

@ -1,32 +1,40 @@
---
title: Get ETH and OCEAN Tokens
description: How to get tokens for each network deployment
description: How to get tokens for each network
---
### Overview
## Overview
In each network, you'll need ETH to pay for gas. Certain Ocean actions will need OCEAN tokens.
In each network, you'll need ETH and OCEAN: ETH to pay for gas, and OCEAN for certain Ocean actions.
The ETH and OCEAN in Rinkeby and local networks are not "real" ETH or OCEAN tokens of any value. They're simply stand-ins to be able to test.
Ethereum mainnet is a network for production settings. Accordingly, ETH and OCEAN tokens have "real" value.
### Ethereum mainnet
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.** [Here are exchanges](https://www.coingecko.com/en/coins/ethereum#markets) to purchase ETH.
- **OCEAN.** [Here are exchanges](https://www.coingecko.com/en/coins/ocean-protocol#markets) to purchase OCEAN.
### Rinkeby testnet
Testnets like Rinkeby have faucets to dole out ETH and OCEAN.
## Rinkeby testnet
- **ETH.** [Here's an ETH faucet](https://faucet.rinkeby.io/) for Rinkeby. You may find others by [searching](https://www.google.com/search?q=rinkeby+ether+faucet&oq=rinkeby+ether+faucet).
- **OCEAN.** [Here's an OCEAN faucet](https://faucet.rinkeby.oceanprotocol.com) for Rinkeby.
### Local network
## Ropsten testnet
Ganache is the local network. Ocean Barge is a tool to help use it.
Ropsten has a faucet to dole out ETH, and another for OCEAN.
- **ETH.** [Here's an ETH faucet](https://faucet.dimensions.network/) for Ropsten. You may find others by [searching](https://www.google.com/search?q=ropsten+ether+faucet&oq=ropsten+ether+faucet).
- **OCEAN.** [Here's an OCEAN faucet](https://faucet.ropsten.oceanprotocol.com) for Rinkeby.
## 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.

17
data/sidebars/concepts.yml
View File

@ -6,18 +6,25 @@
link: /concepts/quickstart/
- title: Architecture Overview
link: /concepts/architecture/
- title: Compute-to-Data
link: /concepts/compute-to-data/
- group: Networks
items:
- title: Network - Ethereum Mainnet
- title: Networks Overview
link: /concepts/networks-overview/
- title: Ethereum Mainnet
link: /concepts/network-ethmainnet/
- title: Network - Rinkeby
- title: Rinkeby Testnet
link: /concepts/network-rinkeby/
- title: Network - Local / Barge
- title: Ropsten Testnet
link: /concepts/network-ropsten/
- title: Ganache Local Testnet
link: /concepts/network-local/
- group: Advanced
items:
- title: Compute-to-Data
link: /concepts/compute-to-data/
- group: Contribute
items:
- title: Ways to Contribute

4
data/sidebars/tutorials.yml
View File

@ -9,10 +9,10 @@
link: /tutorials/metamask-setup/
- title: Use Your Wallet to Manage OCEAN Tokens
link: /tutorials/wallets-and-ocean-tokens/
- title: Get ETH and OCEAN Tokens
link: /tutorials/get-ether-and-ocean-tokens/
- title: Connect to Ocean-Related Networks
link: /tutorials/connect-to-networks/
- title: Get ETH and OCEAN Tokens
link: /tutorials/get-ether-and-ocean-tokens/
- group: Marketplaces
items: