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

Cleanup: now all the networks stuff is in one place. Far less confusing

This commit is contained in:
trentmc 2020-12-10 14:07:19 +01:00
parent c3eb69b5e0
commit 9048388fc9
20 changed files with 125 additions and 153 deletions

View File

@ -28,10 +28,6 @@ module.exports = {
{ {
from: '/references/', from: '/references/',
to: '/references/introduction/' to: '/references/introduction/'
},
{
from: '/tutorials/wallets/',
to: '/concepts/wallets/'
} }
] ]
} }

View File

@ -1,18 +0,0 @@
---
title: Ganache Local Testnet
description:
---
## 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.
You can deploy Ocean contracts onto Ganache. The [Ocean contracts repo](https://www.github.com/oceanprotocol/contracts) has further instructions.
## Connect Metamask wallet 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.

View File

@ -1,6 +0,0 @@
---
title: Ocean Tokens
description: Information about OCEAN
---
Please go to https://oceanprotocol.com/token.

View File

@ -1,10 +0,0 @@
---
title: Resources
description:
---
Here are a few places for more information.
- [Ocean homepage](https://www.oceanprotocol.com)
- [Ocean blog](https://blog.oceanprotocol.com)
- [Ocean whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf)

View File

@ -1,45 +0,0 @@
---
title: Wallet Basics
description: Ocean users need a wallet to manage their Ocean Tokens and Ether. This page explains the basics of wallets.
---
To get and manage Ocean Tokens or Ether, you need a _cryptocurrency wallet_, _crypto wallet_ or just "wallet." More generally, you need a wallet to store your private keys (explained below).
## Recommendations
- **Easiest:** Use [MetaMask][1]. See the tutorial about [how to set up MetaMask](/tutorials/metamask-setup/). OR
- **Still easy, but more secure:** Get a [TREZOR][2] or [Ledger][3] wallet, and use [MetaMask][1] to interact with it.
## The Meaning of "Wallet"
A **wallet** usually means "a thing that stores private keys (and maybe signs transactions)" (explained below). Examples include [MetaMask][1], [TREZOR][2] wallets and a [Ledger][3] wallets.
A wallet can sometimes mean (web3) _software_ for interacting with a thing that stores private keys. Examples include [MetaMask][1], [MyEtherWallet][4], and [MyCrypto][5].
Note how MetaMask is in both lists!
You can also have a _chain_ of software which ultimately connects to the thing that stores the private keys. An example would be [Commons](/concepts/components/#commons) connecting to MetaMask connecting to a TREZOR wallet.
## Related Terminology
When you set up a new wallet, it might generate a **seed phrase** for you. Store that seed phrase somewhere secure and non-digital (e.g. on paper in a safe). It's extremely secret and sensitive. Anyone with your wallet's seed phrase could spend all the Ether and Ocean Tokens in all the accounts in your wallet.
Once your wallet is set up, it will have one or more **accounts**.
Each account has several **balances**, e.g. an Ether balance, an Ocean Token balance, and maybe other balances. All balances start at zero.
An account's Ether balance might be 7.1 ETH in the Ethereum Mainnet, 2.39 ETH in Ropsten testnet. You can move ETH from one network to another only with a specially setup exchange or bridge. The same is true of Ocean Token balances.
Each account has one **private key**, one **public key** and one **address**. The public key and address can be calculated from the private key. You must keep the private key secret because it's what's needed to spend/transfer Ether and Ocean Tokens (or to sign transactions of any kind). You can share the address with others. In fact, if you want someone to send some Ether or Ocean Tokens to an account, you give them the account's address.
Note that unlike traditional pocket wallets, crypto wallets don't actually store tokens or Ether. They store private keys.
## Tutorials
See the [tutorials about using wallets with Ocean Protocol](/tutorials/introduction/).
[1]: https://metamask.io/
[2]: https://trezor.io/
[3]: https://www.ledger.com/
[4]: https://www.myetherwallet.com/
[5]: https://www.mycrypto.com/

View File

@ -1,6 +1,6 @@
--- ---
title: Connect to Ocean-Related Networks title: Connect Wallets to Networks
description: On connecting your wallet to Ethereum networks description:
--- ---
## Connect to Ethereum mainnet ## Connect to Ethereum mainnet
@ -9,18 +9,14 @@ 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. Metamask and other ERC20 wallets default to Ethereum mainnet. Therefore your wallet is almost certainly pointing to Ethereum by default.
## Connect to public testnets
## Connect to testnets
`Rinkeby` and `Ropsten` are prominent Ethereum test nets. Ocean is deployed to both. `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. 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.
## 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).

View File

@ -9,8 +9,8 @@ We'd love to have you help contribute to the Ocean core software! Here are ways
- _Just do it:)_ Branch from the code, improve it, submit a Pull Request. - _Just do it:)_ Branch from the code, improve it, submit a Pull Request.
- Chat with other Ocean developers in [Discord](https://discord.gg/TnXjkR5). - Chat with other Ocean developers in [Discord](https://discord.gg/TnXjkR5).
- Because of the weird world of intellectual property, before it can go through, we need to follow the [legal requirements](/concepts/legal-reqs/). Please be aware of this. - Because of the weird world of intellectual property, before it can go through, we need to follow the [legal requirements](/tutorials/legal-reqs/). Please be aware of this.
- Finally, here's the [Contributor Code of Conduct](/concepts/code-of-conduct/). - Finally, here's the [Contributor Code of Conduct](/tutorials/code-of-conduct/).
### Develop an app or integration, using Ocean as a tool ### Develop an app or integration, using Ocean as a tool
@ -20,7 +20,7 @@ Ocean documentation will help. And... you're here:)
### Report a bug ### Report a bug
To report a vulnerability, [go here](/concepts/vulnerabilities/). To report a vulnerability, [go here](/tutorials/vulnerabilities/).
To report a bug that isn't a vulnerability, go to the relevant GitHub repository, click on the Issues tab, click on the New issue button, and read the instructions. To report a bug that isn't a vulnerability, go to the relevant GitHub repository, click on the Issues tab, click on the New issue button, and read the instructions.

View File

@ -3,12 +3,15 @@ title: Overview of Tutorials
description: description:
--- ---
These tutorials go beyond the Quickstarts to cover: These tutorials cover:
- Using Web3 wallets with Ocean - Using Web3 wallets with Ocean
- Getting ETH and OCEAN on Ethereum mainnet, and Rinkeby testnet - Supported networks
- Getting ETH and OCEAN on Ethereum mainnet and testnets
- Details of each supported network
- Set up a marketplace - Set up a marketplace
- Run a compute-to-data environment - Run a compute-to-data environment
- Storage setup - Azure, AWS or local - Storage setup - Azure, AWS or local
- Ways to contribute

View File

@ -1,11 +1,13 @@
--- ---
title: Ethereum Mainnet title: Ethereum Mainnet
description: description: Details of Ethereum deployment & services
--- ---
## Smart 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. 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 ## Mainnet-Related Services

View File

@ -0,0 +1,14 @@
---
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.
You can deploy Ocean contracts onto Ganache. To do so, please go to [Ocean contracts repo](https://www.github.com/oceanprotocol/contracts) and follow the instructions there.
## 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.

View File

@ -1,11 +1,13 @@
--- ---
title: Rinkeby Testnet title: Rinkeby Testnet
description: description: Details of Rinkeby deployment & services
--- ---
## Smart Contracts ## Smart Contracts
Ocean contracts are deployed to Rinkeby network. [Here](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/rinkeby.md) are the addresses. Ocean contracts are deployed to Rinkeby network.
[Here](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/rinkeby.md) are the addresses.
## Rinkeby-Related Services ## Rinkeby-Related Services

View File

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

View File

@ -1,19 +1,23 @@
--- ---
title: Networks Overview title: Supported Networks
description: Development on various Ethereum networks description:
--- ---
## Supported Networks ## Summary
Ocean is deployed to these public networks: Ocean is deployed to these public networks:
* [Ethereum mainnet](/concepts/network-ethmainnet/) - production * [Ethereum mainnet](/tutorials/network-ethmainnet/) - production
* [Rinkeby](/concepts/network-rinkeby/) - testnet * [Rinkeby](/tutorials/network-rinkeby/) - testnet
* [Ropsten](/concepts/network-ropsten) - testnet * [Ropsten](/tutorials/network-ropsten) - testnet
You can also run your own local testnet: You can also run your own local testnet:
* [Ganache](/concepts/network-local) - local testnet * [Ganache](/tutorials/network-local) - local testnet
## 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.
## Barge ## Barge
@ -21,9 +25,4 @@ You can also run your own local testnet:
Barge is used used extensively by the Ocean core devs (with Ganache or Rinkeby). Barge is used used extensively by the Ocean core devs (with Ganache or Rinkeby).
<repo name="barge"></repo> <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.

View File

@ -0,0 +1,41 @@
---
title: Wallet Basics
description:
---
Ocean users need a wallet to manage their ETH and OCEAN tokens.
## Recommendations
- **Easiest:** Use MetaMask. See the tutorial about [how to set up MetaMask](/tutorials/metamask-setup/). OR
- **Still easy, but more secure:** Get a Trezor or Ledger hardware wallet, and use MetaMask to interact with it.
## The Meaning of "Wallet"
A wallet usually means "a thing that stores private keys (and maybe signs transactions)" (explained below). Examples include MetaMask, Trezor, and Ledger wallets.
A wallet can sometimes mean (web3) _software_ for interacting with a thing that stores private keys. Examples include MetaMask, MyEtherWallet, and MyCrypto.
Note how MetaMask is in both lists!
## Related Terminology
When you set up a new wallet, it might generate a **seed phrase** for you. Store that seed phrase somewhere secure and non-digital (e.g. on paper in a safe). It's extremely secret and sensitive. Anyone with your wallet's seed phrase could spend all the Ether and Ocean Tokens in all the accounts in your wallet.
Once your wallet is set up, it will have one or more **accounts**.
Each account has several **balances**, e.g. an Ether balance, an Ocean Token balance, and maybe other balances. All balances start at zero.
An account's Ether balance might be 7.1 ETH in the Ethereum Mainnet, 2.39 ETH in Ropsten testnet. You can move ETH from one network to another only with a specially setup exchange or bridge. The same is true of OCEAN token balances.
Each account has one **private key** and one **address**. The address can be calculated from the private key. You must keep the private key secret because it's what's needed to spend/transfer ETH and OCEAN (or to sign transactions of any kind). You can share the address with others. In fact, if you want someone to send some ETH or OCEAN to an account, you give them the account's address.
Note that unlike traditional pocket wallets, crypto wallets don't actually store ETH or OCEAN. They store private keys.
## Resources
* Metamask: https://metamask.io/
* Trezor: https://trezor.io/
* Ledger: https://www.ledger.com/
* MyEtherWallet: https://www.myetherwallet.com/
* MyCrypto: https://www.mycrypto.com/

View File

@ -7,40 +7,7 @@
- title: Architecture Overview - title: Architecture Overview
link: /concepts/architecture/ link: /concepts/architecture/
- group: Networks
items:
- title: Networks Overview
link: /concepts/networks-overview/
- 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/
- group: Advanced - group: Advanced
items: items:
- title: Compute-to-Data - title: Compute-to-Data
link: /concepts/compute-to-data/ link: /concepts/compute-to-data/
- group: Contribute
items:
- title: Ways to Contribute
link: /concepts/contributing/
- title: Get Funding
link: /concepts/get-funding/
- title: Reporting Vulnerabilities
link: /concepts/vulnerabilities/
- title: Legal Requirements when Contributing Code
link: /concepts/legal-reqs/
- title: Code of Conduct
link: /concepts/code-of-conduct/
- group: Extras
items:
- title: Wallet Basics
link: /concepts/wallets/
- title: Resources
link: /concepts/resources/

View File

@ -3,16 +3,31 @@
- title: Introduction - title: Introduction
link: /tutorials/introduction/ link: /tutorials/introduction/
- group: Wallets & Ocean Protocol - group: Wallets
items: items:
- title: Wallet Basics
link: /tutorials/wallets/
- title: Set Up MetaMask Wallet - title: Set Up MetaMask Wallet
link: /tutorials/metamask-setup/ link: /tutorials/metamask-setup/
- title: Use Your Wallet to Manage OCEAN Tokens - title: Use Your Wallet to Manage OCEAN Tokens
link: /tutorials/wallets-and-ocean-tokens/ link: /tutorials/wallets-and-ocean-tokens/
- title: Connect to Ocean-Related Networks
- group: Networks
items:
- title: Supported Networks
link: /tutorials/networks-overview/
- title: Connect Wallets to Networks
link: /tutorials/connect-to-networks/ link: /tutorials/connect-to-networks/
- title: Get ETH and OCEAN Tokens - title: Get ETH and OCEAN Tokens
link: /tutorials/get-ether-and-ocean-tokens/ link: /tutorials/get-ether-and-ocean-tokens/
- title: Ethereum Mainnet
link: /tutorials/network-ethmainnet/
- title: Rinkeby Testnet
link: /tutorials/network-rinkeby/
- title: Ropsten Testnet
link: /tutorials/network-ropsten/
- title: Ganache Local Testnet
link: /tutorials/network-local/
- group: Marketplaces - group: Marketplaces
items: items:
@ -32,3 +47,17 @@
link: /tutorials/amazon-s3-for-brizo/ link: /tutorials/amazon-s3-for-brizo/
- title: Set Up On-Premise Storage - title: Set Up On-Premise Storage
link: /tutorials/on-premise-for-brizo/ link: /tutorials/on-premise-for-brizo/
- group: Contribute
items:
- title: Ways to Contribute
link: /tutorials/contributing/
- title: Get Funding
link: /tutorials/get-funding/
- title: Reporting Vulnerabilities
link: /tutorials/vulnerabilities/
- title: Legal Requirements when Contributing Code
link: /tutorials/legal-reqs/
- title: Code of Conduct
link: /tutorials/code-of-conduct/