From c3eb69b5e0b54c28f3f46f765b3eb752d716b540 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Thu, 10 Dec 2020 13:24:35 +0100 Subject: [PATCH 01/30] Add Ropsten. Rearrange things --- .gitignore | 1 + content/concepts/network-ethmainnet.md | 10 +++++-- content/concepts/network-local.md | 18 +++++++----- content/concepts/network-rinkeby.md | 12 ++++---- content/concepts/network-ropsten.md | 17 +++++++++++ content/concepts/networks-overview.md | 29 +++++++++++++++++++ content/tutorials/connect-to-networks.md | 26 +++++++---------- .../tutorials/get-ether-and-ocean-tokens.md | 28 +++++++++++------- data/sidebars/concepts.yml | 17 +++++++---- data/sidebars/tutorials.yml | 4 +-- 10 files changed, 114 insertions(+), 48 deletions(-) create mode 100644 content/concepts/network-ropsten.md create mode 100644 content/concepts/networks-overview.md diff --git a/.gitignore b/.gitignore index d5124dc3..58b18cb1 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ yarn.lock yarn-error.log .cache /public +/external .DS_Store .env .env.* diff --git a/content/concepts/network-ethmainnet.md b/content/concepts/network-ethmainnet.md index 80db4e66..6ca6bae8 100644 --- a/content/concepts/network-ethmainnet.md +++ b/content/concepts/network-ethmainnet.md @@ -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 | | ----------------------- | ------------------------------------------ | diff --git a/content/concepts/network-local.md b/content/concepts/network-local.md index 3531ff20..7322d8ee 100644 --- a/content/concepts/network-local.md +++ b/content/concepts/network-local.md @@ -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. - +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. \ No newline at end of file diff --git a/content/concepts/network-rinkeby.md b/content/concepts/network-rinkeby.md index b586e281..1b40a761 100644 --- a/content/concepts/network-rinkeby.md +++ b/content/concepts/network-rinkeby.md @@ -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 | diff --git a/content/concepts/network-ropsten.md b/content/concepts/network-ropsten.md new file mode 100644 index 00000000..ef7733e3 --- /dev/null +++ b/content/concepts/network-ropsten.md @@ -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 | diff --git a/content/concepts/networks-overview.md b/content/concepts/networks-overview.md new file mode 100644 index 00000000..bff9aeb4 --- /dev/null +++ b/content/concepts/networks-overview.md @@ -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). + + + +## 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. + diff --git a/content/tutorials/connect-to-networks.md b/content/tutorials/connect-to-networks.md index 4f787824..a08f96f6 100644 --- a/content/tutorials/connect-to-networks.md +++ b/content/tutorials/connect-to-networks.md @@ -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) diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index 6f9cf8d5..ad1242ea 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -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. diff --git a/data/sidebars/concepts.yml b/data/sidebars/concepts.yml index 6bcd77d7..34ca4be1 100644 --- a/data/sidebars/concepts.yml +++ b/data/sidebars/concepts.yml @@ -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 diff --git a/data/sidebars/tutorials.yml b/data/sidebars/tutorials.yml index 78306a52..579f37ff 100644 --- a/data/sidebars/tutorials.yml +++ b/data/sidebars/tutorials.yml @@ -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: From 9048388fc9c6bdd761e65801c247435b4b6bec99 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Thu, 10 Dec 2020 14:07:19 +0100 Subject: [PATCH 02/30] Cleanup: now all the networks stuff is in one place. Far less confusing --- config.js | 4 -- content/concepts/network-local.md | 18 -------- content/concepts/ocean-tokens.md | 6 --- content/concepts/resources.md | 10 ----- content/concepts/wallets.md | 45 ------------------- .../code-of-conduct.md | 0 content/tutorials/connect-to-networks.md | 16 +++---- .../{concepts => tutorials}/contributing.md | 6 +-- .../{concepts => tutorials}/get-funding.md | 0 content/tutorials/introduction.md | 7 ++- content/{concepts => tutorials}/legal-reqs.md | 0 .../network-ethmainnet.md | 6 ++- content/tutorials/network-local.md | 14 ++++++ .../network-rinkeby.md | 6 ++- .../network-ropsten.md | 6 ++- .../networks-overview.md | 25 +++++------ .../vulnerabilities.md | 0 content/tutorials/wallets.md | 41 +++++++++++++++++ data/sidebars/concepts.yml | 35 +-------------- data/sidebars/tutorials.yml | 33 +++++++++++++- 20 files changed, 125 insertions(+), 153 deletions(-) delete mode 100644 content/concepts/network-local.md delete mode 100644 content/concepts/ocean-tokens.md delete mode 100644 content/concepts/resources.md delete mode 100644 content/concepts/wallets.md rename content/{concepts => tutorials}/code-of-conduct.md (100%) rename content/{concepts => tutorials}/contributing.md (80%) rename content/{concepts => tutorials}/get-funding.md (100%) rename content/{concepts => tutorials}/legal-reqs.md (100%) rename content/{concepts => tutorials}/network-ethmainnet.md (70%) create mode 100644 content/tutorials/network-local.md rename content/{concepts => tutorials}/network-rinkeby.md (79%) rename content/{concepts => tutorials}/network-ropsten.md (79%) rename content/{concepts => tutorials}/networks-overview.md (61%) rename content/{concepts => tutorials}/vulnerabilities.md (100%) create mode 100644 content/tutorials/wallets.md diff --git a/config.js b/config.js index a131a195..a18c803a 100644 --- a/config.js +++ b/config.js @@ -28,10 +28,6 @@ module.exports = { { from: '/references/', to: '/references/introduction/' - }, - { - from: '/tutorials/wallets/', - to: '/concepts/wallets/' } ] } diff --git a/content/concepts/network-local.md b/content/concepts/network-local.md deleted file mode 100644 index 7322d8ee..00000000 --- a/content/concepts/network-local.md +++ /dev/null @@ -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. \ No newline at end of file diff --git a/content/concepts/ocean-tokens.md b/content/concepts/ocean-tokens.md deleted file mode 100644 index 9f19c3a7..00000000 --- a/content/concepts/ocean-tokens.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Ocean Tokens -description: Information about OCEAN ---- - -Please go to https://oceanprotocol.com/token. diff --git a/content/concepts/resources.md b/content/concepts/resources.md deleted file mode 100644 index 80e80871..00000000 --- a/content/concepts/resources.md +++ /dev/null @@ -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) diff --git a/content/concepts/wallets.md b/content/concepts/wallets.md deleted file mode 100644 index 5c4461fe..00000000 --- a/content/concepts/wallets.md +++ /dev/null @@ -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/ diff --git a/content/concepts/code-of-conduct.md b/content/tutorials/code-of-conduct.md similarity index 100% rename from content/concepts/code-of-conduct.md rename to content/tutorials/code-of-conduct.md diff --git a/content/tutorials/connect-to-networks.md b/content/tutorials/connect-to-networks.md index a08f96f6..422eae09 100644 --- a/content/tutorials/connect-to-networks.md +++ b/content/tutorials/connect-to-networks.md @@ -1,6 +1,6 @@ --- -title: Connect to Ocean-Related Networks -description: On connecting your wallet to Ethereum networks +title: Connect Wallets to Networks +description: --- ## 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. - -## Connect to testnets +## Connect to public testnets `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. - +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). diff --git a/content/concepts/contributing.md b/content/tutorials/contributing.md similarity index 80% rename from content/concepts/contributing.md rename to content/tutorials/contributing.md index 92d90a3f..4740e214 100644 --- a/content/concepts/contributing.md +++ b/content/tutorials/contributing.md @@ -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. - 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. -- Finally, here's the [Contributor Code of Conduct](/concepts/code-of-conduct/). +- 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](/tutorials/code-of-conduct/). ### 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 -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. diff --git a/content/concepts/get-funding.md b/content/tutorials/get-funding.md similarity index 100% rename from content/concepts/get-funding.md rename to content/tutorials/get-funding.md diff --git a/content/tutorials/introduction.md b/content/tutorials/introduction.md index 660ec242..e5114f66 100644 --- a/content/tutorials/introduction.md +++ b/content/tutorials/introduction.md @@ -3,12 +3,15 @@ title: Overview of Tutorials description: --- -These tutorials go beyond the Quickstarts to cover: +These tutorials cover: - 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 - Run a compute-to-data environment - Storage setup - Azure, AWS or local +- Ways to contribute diff --git a/content/concepts/legal-reqs.md b/content/tutorials/legal-reqs.md similarity index 100% rename from content/concepts/legal-reqs.md rename to content/tutorials/legal-reqs.md diff --git a/content/concepts/network-ethmainnet.md b/content/tutorials/network-ethmainnet.md similarity index 70% rename from content/concepts/network-ethmainnet.md rename to content/tutorials/network-ethmainnet.md index 6ca6bae8..90a76b0b 100644 --- a/content/concepts/network-ethmainnet.md +++ b/content/tutorials/network-ethmainnet.md @@ -1,11 +1,13 @@ --- title: Ethereum Mainnet -description: +description: Details of Ethereum deployment & services --- ## 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 diff --git a/content/tutorials/network-local.md b/content/tutorials/network-local.md new file mode 100644 index 00000000..1efaa48e --- /dev/null +++ b/content/tutorials/network-local.md @@ -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. \ No newline at end of file diff --git a/content/concepts/network-rinkeby.md b/content/tutorials/network-rinkeby.md similarity index 79% rename from content/concepts/network-rinkeby.md rename to content/tutorials/network-rinkeby.md index 1b40a761..d38990df 100644 --- a/content/concepts/network-rinkeby.md +++ b/content/tutorials/network-rinkeby.md @@ -1,11 +1,13 @@ --- title: Rinkeby Testnet -description: +description: Details of Rinkeby deployment & services --- ## 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 diff --git a/content/concepts/network-ropsten.md b/content/tutorials/network-ropsten.md similarity index 79% rename from content/concepts/network-ropsten.md rename to content/tutorials/network-ropsten.md index ef7733e3..4f83397d 100644 --- a/content/concepts/network-ropsten.md +++ b/content/tutorials/network-ropsten.md @@ -1,11 +1,13 @@ --- title: Ropsten Testnet -description: +description: Details of Ropsten deployment & services --- ## 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 diff --git a/content/concepts/networks-overview.md b/content/tutorials/networks-overview.md similarity index 61% rename from content/concepts/networks-overview.md rename to content/tutorials/networks-overview.md index bff9aeb4..c77f4721 100644 --- a/content/concepts/networks-overview.md +++ b/content/tutorials/networks-overview.md @@ -1,19 +1,23 @@ --- -title: Networks Overview -description: Development on various Ethereum networks +title: Supported Networks +description: --- -## Supported Networks +## Summary Ocean is deployed to these public networks: -* [Ethereum mainnet](/concepts/network-ethmainnet/) - production -* [Rinkeby](/concepts/network-rinkeby/) - testnet -* [Ropsten](/concepts/network-ropsten) - testnet +* [Ethereum mainnet](/tutorials/network-ethmainnet/) - production +* [Rinkeby](/tutorials/network-rinkeby/) - testnet +* [Ropsten](/tutorials/network-ropsten) - 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 @@ -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). - - -## 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. - + \ No newline at end of file diff --git a/content/concepts/vulnerabilities.md b/content/tutorials/vulnerabilities.md similarity index 100% rename from content/concepts/vulnerabilities.md rename to content/tutorials/vulnerabilities.md diff --git a/content/tutorials/wallets.md b/content/tutorials/wallets.md new file mode 100644 index 00000000..29334bfa --- /dev/null +++ b/content/tutorials/wallets.md @@ -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/ diff --git a/data/sidebars/concepts.yml b/data/sidebars/concepts.yml index 34ca4be1..ca60c434 100644 --- a/data/sidebars/concepts.yml +++ b/data/sidebars/concepts.yml @@ -7,40 +7,7 @@ - title: Architecture Overview 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 items: - title: 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/ + link: /concepts/compute-to-data/ \ No newline at end of file diff --git a/data/sidebars/tutorials.yml b/data/sidebars/tutorials.yml index 579f37ff..6f9e44f9 100644 --- a/data/sidebars/tutorials.yml +++ b/data/sidebars/tutorials.yml @@ -3,16 +3,31 @@ - title: Introduction link: /tutorials/introduction/ -- group: Wallets & Ocean Protocol +- group: Wallets items: + - title: Wallet Basics + link: /tutorials/wallets/ - title: Set Up MetaMask Wallet link: /tutorials/metamask-setup/ - title: Use Your Wallet to Manage 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/ - title: Get ETH 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 items: @@ -32,3 +47,17 @@ link: /tutorials/amazon-s3-for-brizo/ - title: Set Up On-Premise Storage 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/ + From 1ce033eadad5f6c20e5da015f5d6d54837882325 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:07:07 +0100 Subject: [PATCH 03/30] ran: npm run format --- data/sidebars/concepts.yml | 2 +- data/sidebars/tutorials.yml | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/data/sidebars/concepts.yml b/data/sidebars/concepts.yml index ca60c434..f863aa89 100644 --- a/data/sidebars/concepts.yml +++ b/data/sidebars/concepts.yml @@ -10,4 +10,4 @@ - group: Advanced items: - title: Compute-to-Data - link: /concepts/compute-to-data/ \ No newline at end of file + link: /concepts/compute-to-data/ diff --git a/data/sidebars/tutorials.yml b/data/sidebars/tutorials.yml index 6f9e44f9..d5d349b7 100644 --- a/data/sidebars/tutorials.yml +++ b/data/sidebars/tutorials.yml @@ -11,8 +11,8 @@ link: /tutorials/metamask-setup/ - title: Use Your Wallet to Manage OCEAN Tokens link: /tutorials/wallets-and-ocean-tokens/ - -- group: Networks + +- group: Networks items: - title: Supported Networks link: /tutorials/networks-overview/ @@ -60,4 +60,3 @@ link: /tutorials/legal-reqs/ - title: Code of Conduct link: /tutorials/code-of-conduct/ - From eb77dec6a2fff191646f7dab1c41199c41e38f50 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Thu, 10 Dec 2020 16:10:09 +0100 Subject: [PATCH 04/30] fix remaining errors found via: npm run lint --- content/tutorials/network-local.md | 2 +- content/tutorials/networks-overview.md | 10 +++++----- content/tutorials/wallets.md | 10 +++++----- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/content/tutorials/network-local.md b/content/tutorials/network-local.md index 1efaa48e..276d4d83 100644 --- a/content/tutorials/network-local.md +++ b/content/tutorials/network-local.md @@ -11,4 +11,4 @@ You can deploy Ocean contracts onto Ganache. To do so, please go to [Ocean contr ## 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. \ No newline at end of file +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. diff --git a/content/tutorials/networks-overview.md b/content/tutorials/networks-overview.md index c77f4721..b128b624 100644 --- a/content/tutorials/networks-overview.md +++ b/content/tutorials/networks-overview.md @@ -7,13 +7,13 @@ description: Ocean is deployed to these public networks: -* [Ethereum mainnet](/tutorials/network-ethmainnet/) - production -* [Rinkeby](/tutorials/network-rinkeby/) - testnet -* [Ropsten](/tutorials/network-ropsten) - testnet +- [Ethereum mainnet](/tutorials/network-ethmainnet/) - production +- [Rinkeby](/tutorials/network-rinkeby/) - testnet +- [Ropsten](/tutorials/network-ropsten) - testnet You can also run your own local testnet: -* [Ganache](/tutorials/network-local) - local testnet +- [Ganache](/tutorials/network-local) - local testnet ## Chain ids @@ -25,4 +25,4 @@ Some apps may need `network_id` and `chain_id`. [Here's](https://medium.com/@piy Barge is used used extensively by the Ocean core devs (with Ganache or Rinkeby). - \ No newline at end of file + diff --git a/content/tutorials/wallets.md b/content/tutorials/wallets.md index 29334bfa..306b1e17 100644 --- a/content/tutorials/wallets.md +++ b/content/tutorials/wallets.md @@ -34,8 +34,8 @@ Note that unlike traditional pocket wallets, crypto wallets don't actually store ## Resources -* Metamask: https://metamask.io/ -* Trezor: https://trezor.io/ -* Ledger: https://www.ledger.com/ -* MyEtherWallet: https://www.myetherwallet.com/ -* MyCrypto: https://www.mycrypto.com/ +- Metamask: https://metamask.io/ +- Trezor: https://trezor.io/ +- Ledger: https://www.ledger.com/ +- MyEtherWallet: https://www.myetherwallet.com/ +- MyCrypto: https://www.mycrypto.com/ From 3c8f3980dc240b3c6c6ea8fc7ea2a489c432d244 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 12:59:08 +0100 Subject: [PATCH 05/30] not needed. Matthias: you can delete this folder locally, no need to ignore it. It's legacy when we used git submodules which was removed some weeks ago --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 58b18cb1..d5124dc3 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,6 @@ yarn.lock yarn-error.log .cache /public -/external .DS_Store .env .env.* From 8e2ce5fa5b35379bd79a601f907e29e33a6abeba Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:19:43 +0100 Subject: [PATCH 06/30] fix: stay consistent, either testnets like in title, or just write it out here, test networks --- content/tutorials/connect-to-networks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/connect-to-networks.md b/content/tutorials/connect-to-networks.md index 422eae09..b7976f89 100644 --- a/content/tutorials/connect-to-networks.md +++ b/content/tutorials/connect-to-networks.md @@ -11,7 +11,7 @@ Metamask and other ERC20 wallets default to Ethereum mainnet. Therefore your wal ## Connect to public testnets -`Rinkeby` and `Ropsten` are prominent Ethereum test nets. Ocean is deployed to both. +`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. From dad2cd6df55bd74e979a670870f6f7d39cd21efd Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:21:30 +0100 Subject: [PATCH 07/30] fix w/ Matthias suggestion --- content/tutorials/get-ether-and-ocean-tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index ad1242ea..3b88e006 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -5,7 +5,7 @@ description: How to get tokens for each network ## Overview -In each network, you'll need ETH and OCEAN: ETH to pay for gas, and OCEAN for certain Ocean actions. +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. From a4c0e101237f4224a561225c8fa9f058d00adb4f Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:21:52 +0100 Subject: [PATCH 08/30] fix w/ Matthias suggestion --- content/tutorials/get-ether-and-ocean-tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index 3b88e006..d10515fe 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -7,7 +7,7 @@ description: How to get tokens for each network 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. +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. From 9da7447fc1fa7a62705e26af87a2bd1e211a4afd Mon Sep 17 00:00:00 2001 From: Trent McConaghy <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:22:55 +0100 Subject: [PATCH 09/30] Update content/tutorials/get-ether-and-ocean-tokens.md Co-authored-by: Matthias Kretschmann --- content/tutorials/get-ether-and-ocean-tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index d10515fe..2bb1434a 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -20,7 +20,7 @@ Other networks are test networks. The ETH and OCEAN tokens in each of these netw ## 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). +- **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.** [Here's an OCEAN faucet](https://faucet.rinkeby.oceanprotocol.com) for Rinkeby. From 96bd9d0352e9df55aa396d61562e99badabfee4e Mon Sep 17 00:00:00 2001 From: Trent McConaghy <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:23:05 +0100 Subject: [PATCH 10/30] Update content/tutorials/get-ether-and-ocean-tokens.md Co-authored-by: Matthias Kretschmann --- content/tutorials/get-ether-and-ocean-tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index 2bb1434a..0b7f5d9c 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -22,7 +22,7 @@ Other networks are test networks. The ETH and OCEAN tokens in each of these netw - **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.** [Here's an OCEAN faucet](https://faucet.rinkeby.oceanprotocol.com) for Rinkeby. +- **OCEAN** [OCEAN faucet for Rinkeby](https://faucet.rinkeby.oceanprotocol.com). ## Ropsten testnet From 546958e2f98ef547d9cc1b2f6b9b4e067f790040 Mon Sep 17 00:00:00 2001 From: Trent McConaghy <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:23:39 +0100 Subject: [PATCH 11/30] Update content/tutorials/get-ether-and-ocean-tokens.md Co-authored-by: Matthias Kretschmann --- content/tutorials/get-ether-and-ocean-tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index 0b7f5d9c..7bec7cb2 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -13,7 +13,7 @@ Other networks are test networks. The ETH and OCEAN tokens in each of these netw ## Ethereum mainnet -- **ETH.** [Here are exchanges](https://www.coingecko.com/en/coins/ethereum#markets) to purchase ETH. +- **ETH** [Exchanges to purchase ETH](https://www.coingecko.com/en/coins/ethereum#markets). - **OCEAN.** [Here are exchanges](https://www.coingecko.com/en/coins/ocean-protocol#markets) to purchase OCEAN. From 14163701e68bb093b77041987b69dbee1fe4d634 Mon Sep 17 00:00:00 2001 From: Trent McConaghy <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:23:49 +0100 Subject: [PATCH 12/30] Update content/tutorials/get-ether-and-ocean-tokens.md Co-authored-by: Matthias Kretschmann --- content/tutorials/get-ether-and-ocean-tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index 7bec7cb2..48940343 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -15,7 +15,7 @@ Other networks are test networks. The ETH and OCEAN tokens in each of these netw - **ETH** [Exchanges to purchase ETH](https://www.coingecko.com/en/coins/ethereum#markets). -- **OCEAN.** [Here are exchanges](https://www.coingecko.com/en/coins/ocean-protocol#markets) to purchase OCEAN. +- **OCEAN** [Official exchanges to purchase OCEAN](https://oceanprotocol.com/token#get). ## Rinkeby testnet From 0a7e3d7d5e80b8e089891f535ef97cd4afbf7a38 Mon Sep 17 00:00:00 2001 From: Trent McConaghy <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:23:57 +0100 Subject: [PATCH 13/30] Update content/tutorials/get-ether-and-ocean-tokens.md Co-authored-by: Matthias Kretschmann --- content/tutorials/get-ether-and-ocean-tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index 48940343..3395bbd1 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -28,7 +28,7 @@ Other networks are test networks. The ETH and OCEAN tokens in each of these netw 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). +- **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.** [Here's an OCEAN faucet](https://faucet.ropsten.oceanprotocol.com) for Rinkeby. From 4ab1dcb5aac16fdad8fcebde95bec56d50b3bd2e Mon Sep 17 00:00:00 2001 From: Trent McConaghy <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:24:14 +0100 Subject: [PATCH 14/30] Update content/tutorials/get-ether-and-ocean-tokens.md Co-authored-by: Matthias Kretschmann --- content/tutorials/get-ether-and-ocean-tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index 3395bbd1..2ccbefa3 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -30,7 +30,7 @@ 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.** [Here's an OCEAN faucet](https://faucet.ropsten.oceanprotocol.com) for Rinkeby. +- **OCEAN** [OCEAN faucet for Rinkeby](https://faucet.ropsten.oceanprotocol.com). ## Local network From 3f383721217af100017bdc12a53ab901a52de871 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:27:09 +0100 Subject: [PATCH 15/30] Fix, wrt suggestion: never use here for a link, always describe what's behind. --- content/tutorials/network-ethmainnet.md | 4 +--- content/tutorials/network-rinkeby.md | 4 +--- content/tutorials/network-ropsten.md | 4 +--- 3 files changed, 3 insertions(+), 9 deletions(-) diff --git a/content/tutorials/network-ethmainnet.md b/content/tutorials/network-ethmainnet.md index 90a76b0b..6643c856 100644 --- a/content/tutorials/network-ethmainnet.md +++ b/content/tutorials/network-ethmainnet.md @@ -5,9 +5,7 @@ description: Details of Ethereum deployment & services ## 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 at **[these addresses](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/mainnet.md)**. ## Mainnet-Related Services diff --git a/content/tutorials/network-rinkeby.md b/content/tutorials/network-rinkeby.md index d38990df..62432d3f 100644 --- a/content/tutorials/network-rinkeby.md +++ b/content/tutorials/network-rinkeby.md @@ -5,9 +5,7 @@ description: Details of Rinkeby deployment & services ## 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 at &&[these addresses](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/rinkeby.md)**. ## Rinkeby-Related Services diff --git a/content/tutorials/network-ropsten.md b/content/tutorials/network-ropsten.md index 4f83397d..a1cd15e6 100644 --- a/content/tutorials/network-ropsten.md +++ b/content/tutorials/network-ropsten.md @@ -5,9 +5,7 @@ description: Details of Ropsten deployment & services ## 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 at **[these addresses](https://github.com/oceanprotocol/contracts/blob/master/docs/deployments/ropsten.md)**. ## Ropsten-Related Services From 0a71aa4ed90cb9271a527d09508785434318e82d Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:34:34 +0100 Subject: [PATCH 16/30] Respond to comment: Barge is running ganache so this sounds a bit confusing. The main use case would be to run only barge which comes then with ganache, aquarius, provider. --- content/tutorials/network-local.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/content/tutorials/network-local.md b/content/tutorials/network-local.md index 276d4d83..131cb98c 100644 --- a/content/tutorials/network-local.md +++ b/content/tutorials/network-local.md @@ -7,8 +7,10 @@ description: Details of Ganache deployment & services [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. +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. -## Connect Barge to Ganache +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). -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. +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". From 1ac396538b1eb9e64c425c2d75de19bf9135f24d Mon Sep 17 00:00:00 2001 From: Trent McConaghy <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:35:45 +0100 Subject: [PATCH 17/30] Update content/tutorials/networks-overview.md Co-authored-by: Matthias Kretschmann --- content/tutorials/networks-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/networks-overview.md b/content/tutorials/networks-overview.md index b128b624..1387c155 100644 --- a/content/tutorials/networks-overview.md +++ b/content/tutorials/networks-overview.md @@ -17,7 +17,7 @@ You can also run your own 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. +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 From 5492c48c95a9b3980825d90c1194eca09df29ef4 Mon Sep 17 00:00:00 2001 From: Trent McConaghy <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 13:35:58 +0100 Subject: [PATCH 18/30] Update content/tutorials/wallets.md Co-authored-by: Matthias Kretschmann --- content/tutorials/wallets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/wallets.md b/content/tutorials/wallets.md index 306b1e17..383090ea 100644 --- a/content/tutorials/wallets.md +++ b/content/tutorials/wallets.md @@ -3,7 +3,7 @@ title: Wallet Basics description: --- -Ocean users need a wallet to manage their ETH and OCEAN tokens. +Ocean users need an ERC-20 compatible wallet to manage their ETH and OCEAN tokens. ## Recommendations From 8e613f404b3f287330744f44da3dfd91d98da653 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 15:23:31 +0100 Subject: [PATCH 19/30] fix, as response to: 'that tutorial link does not exist anymore' --- content/tutorials/wallets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/wallets.md b/content/tutorials/wallets.md index 383090ea..a752f015 100644 --- a/content/tutorials/wallets.md +++ b/content/tutorials/wallets.md @@ -7,7 +7,7 @@ Ocean users need an ERC-20 compatible wallet to manage their ETH and OCEAN token ## Recommendations -- **Easiest:** Use MetaMask. See the tutorial about [how to set up MetaMask](/tutorials/metamask-setup/). OR +- **Easiest:** Use MetaMask browser plug-in. _OR_ - **Still easy, but more secure:** Get a Trezor or Ledger hardware wallet, and use MetaMask to interact with it. ## The Meaning of "Wallet" From 665aaea1a0d9b4e44c4a1511d74e93f7286a7a91 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 15:28:22 +0100 Subject: [PATCH 20/30] address comment 'link here also to ... list of wallets .. oceanprotocol.com --- content/tutorials/wallets.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/tutorials/wallets.md b/content/tutorials/wallets.md index a752f015..a8dfd321 100644 --- a/content/tutorials/wallets.md +++ b/content/tutorials/wallets.md @@ -9,6 +9,7 @@ Ocean users need an ERC-20 compatible wallet to manage their ETH and OCEAN token - **Easiest:** Use MetaMask browser plug-in. _OR_ - **Still easy, but more secure:** Get a Trezor or Ledger hardware wallet, and use MetaMask to interact with it. +- The [OCEAN Token page](https://oceanprotocol.com/token) at oceanprotocol.com lists some other possible wallets. ## The Meaning of "Wallet" From df4a033ec8524c079b11b4bb1e84420849d67740 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 15:31:51 +0100 Subject: [PATCH 21/30] address: 'Link them all up instead of showing the urls' --- content/tutorials/wallets.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/content/tutorials/wallets.md b/content/tutorials/wallets.md index a8dfd321..1016494d 100644 --- a/content/tutorials/wallets.md +++ b/content/tutorials/wallets.md @@ -7,15 +7,15 @@ Ocean users need an ERC-20 compatible wallet to manage their ETH and OCEAN token ## Recommendations -- **Easiest:** Use MetaMask browser plug-in. _OR_ -- **Still easy, but more secure:** Get a Trezor or Ledger hardware wallet, and use MetaMask to interact with it. +- **Easiest:** Use [MetaMask](https://metamask.io/) browser plug-in. _OR_ +- **Still easy, but more secure:** Get a [Trezor](https://trezor.io/) or [Ledger](https://www.ledger.com/) hardware wallet, and use MetaMask to interact with it. - The [OCEAN Token page](https://oceanprotocol.com/token) at oceanprotocol.com lists some other possible wallets. ## 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. +A wallet can sometimes mean (web3) _software_ for interacting with a thing that stores private keys. Examples include MetaMask, [MyEtherWallet](https://www.myetherwallet.com/), and [MyCrypto](https://www.mycrypto.com/). Note how MetaMask is in both lists! @@ -32,11 +32,3 @@ An account's Ether balance might be 7.1 ETH in the Ethereum Mainnet, 2.39 ETH in 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/ From b20b7875dd7609a4c46b71f2919a1f17cdae223c Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 15:36:08 +0100 Subject: [PATCH 22/30] fix typo --- content/tutorials/network-local.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/network-local.md b/content/tutorials/network-local.md index 131cb98c..2feefb48 100644 --- a/content/tutorials/network-local.md +++ b/content/tutorials/network-local.md @@ -7,7 +7,7 @@ description: Details of Ganache deployment & services [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. +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). From 8efcbbee4e8fc16ed6389cd950b5b190f7b26e98 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 15:36:24 +0100 Subject: [PATCH 23/30] remove this, it's ugly --- content/tutorials/wallets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/wallets.md b/content/tutorials/wallets.md index 1016494d..deb556e4 100644 --- a/content/tutorials/wallets.md +++ b/content/tutorials/wallets.md @@ -7,7 +7,7 @@ Ocean users need an ERC-20 compatible wallet to manage their ETH and OCEAN token ## Recommendations -- **Easiest:** Use [MetaMask](https://metamask.io/) browser plug-in. _OR_ +- **Easiest:** Use [MetaMask](https://metamask.io/) browser plug-in. - **Still easy, but more secure:** Get a [Trezor](https://trezor.io/) or [Ledger](https://www.ledger.com/) hardware wallet, and use MetaMask to interact with it. - The [OCEAN Token page](https://oceanprotocol.com/token) at oceanprotocol.com lists some other possible wallets. From fbf7414795c61ff9e706e9f4e14eb1dc911e9ec5 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 15:41:03 +0100 Subject: [PATCH 24/30] Point to further info at Token page --- content/tutorials/wallets-and-ocean-tokens.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/tutorials/wallets-and-ocean-tokens.md b/content/tutorials/wallets-and-ocean-tokens.md index 74b793dc..ff8c0f0f 100644 --- a/content/tutorials/wallets-and-ocean-tokens.md +++ b/content/tutorials/wallets-and-ocean-tokens.md @@ -11,7 +11,9 @@ Almost all ERC-20 wallets require these values for adding a custom token: - Contract Address: `0x967da4048cD07aB37855c090aAF366e4ce1b9F48` - Symbol: `OCEAN` -- Number of precision: `18` +- Decimals: `18` + +The [OCEAN Token page](https://oceanprotocol.com/token) at oceanprotocol.com has further details. ## MetaMask From 6adb6a278df95978f240bd7583b8b8872ac88002 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:35:32 +0100 Subject: [PATCH 25/30] move several things back to 'concepts' --- .../code-of-conduct.md | 0 .../connect-to-networks.md | 0 .../{tutorials => concepts}/contributing.md | 0 .../get-ether-and-ocean-tokens.md | 0 .../{tutorials => concepts}/get-funding.md | 0 content/{tutorials => concepts}/legal-reqs.md | 0 .../network-ethmainnet.md | 0 .../{tutorials => concepts}/network-local.md | 0 .../network-rinkeby.md | 0 .../network-ropsten.md | 0 .../networks-overview.md | 0 .../vulnerabilities.md | 0 content/tutorials/introduction.md | 4 -- data/sidebars/concepts.yml | 38 ++++++++++++++++++- data/sidebars/setup.yml | 9 ----- data/sidebars/tutorials.yml | 30 --------------- 16 files changed, 36 insertions(+), 45 deletions(-) rename content/{tutorials => concepts}/code-of-conduct.md (100%) rename content/{tutorials => concepts}/connect-to-networks.md (100%) rename content/{tutorials => concepts}/contributing.md (100%) rename content/{tutorials => concepts}/get-ether-and-ocean-tokens.md (100%) rename content/{tutorials => concepts}/get-funding.md (100%) rename content/{tutorials => concepts}/legal-reqs.md (100%) rename content/{tutorials => concepts}/network-ethmainnet.md (100%) rename content/{tutorials => concepts}/network-local.md (100%) rename content/{tutorials => concepts}/network-rinkeby.md (100%) rename content/{tutorials => concepts}/network-ropsten.md (100%) rename content/{tutorials => concepts}/networks-overview.md (100%) rename content/{tutorials => concepts}/vulnerabilities.md (100%) delete mode 100644 data/sidebars/setup.yml diff --git a/content/tutorials/code-of-conduct.md b/content/concepts/code-of-conduct.md similarity index 100% rename from content/tutorials/code-of-conduct.md rename to content/concepts/code-of-conduct.md diff --git a/content/tutorials/connect-to-networks.md b/content/concepts/connect-to-networks.md similarity index 100% rename from content/tutorials/connect-to-networks.md rename to content/concepts/connect-to-networks.md diff --git a/content/tutorials/contributing.md b/content/concepts/contributing.md similarity index 100% rename from content/tutorials/contributing.md rename to content/concepts/contributing.md diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/concepts/get-ether-and-ocean-tokens.md similarity index 100% rename from content/tutorials/get-ether-and-ocean-tokens.md rename to content/concepts/get-ether-and-ocean-tokens.md diff --git a/content/tutorials/get-funding.md b/content/concepts/get-funding.md similarity index 100% rename from content/tutorials/get-funding.md rename to content/concepts/get-funding.md diff --git a/content/tutorials/legal-reqs.md b/content/concepts/legal-reqs.md similarity index 100% rename from content/tutorials/legal-reqs.md rename to content/concepts/legal-reqs.md diff --git a/content/tutorials/network-ethmainnet.md b/content/concepts/network-ethmainnet.md similarity index 100% rename from content/tutorials/network-ethmainnet.md rename to content/concepts/network-ethmainnet.md diff --git a/content/tutorials/network-local.md b/content/concepts/network-local.md similarity index 100% rename from content/tutorials/network-local.md rename to content/concepts/network-local.md diff --git a/content/tutorials/network-rinkeby.md b/content/concepts/network-rinkeby.md similarity index 100% rename from content/tutorials/network-rinkeby.md rename to content/concepts/network-rinkeby.md diff --git a/content/tutorials/network-ropsten.md b/content/concepts/network-ropsten.md similarity index 100% rename from content/tutorials/network-ropsten.md rename to content/concepts/network-ropsten.md diff --git a/content/tutorials/networks-overview.md b/content/concepts/networks-overview.md similarity index 100% rename from content/tutorials/networks-overview.md rename to content/concepts/networks-overview.md diff --git a/content/tutorials/vulnerabilities.md b/content/concepts/vulnerabilities.md similarity index 100% rename from content/tutorials/vulnerabilities.md rename to content/concepts/vulnerabilities.md diff --git a/content/tutorials/introduction.md b/content/tutorials/introduction.md index e5114f66..228e00fa 100644 --- a/content/tutorials/introduction.md +++ b/content/tutorials/introduction.md @@ -6,12 +6,8 @@ description: These tutorials cover: - Using Web3 wallets with Ocean -- Supported networks -- Getting ETH and OCEAN on Ethereum mainnet and testnets -- Details of each supported network - Set up a marketplace - Run a compute-to-data environment - Storage setup - Azure, AWS or local -- Ways to contribute diff --git a/data/sidebars/concepts.yml b/data/sidebars/concepts.yml index f863aa89..22d9d435 100644 --- a/data/sidebars/concepts.yml +++ b/data/sidebars/concepts.yml @@ -7,7 +7,41 @@ - title: Architecture Overview link: /concepts/architecture/ -- group: Advanced +- group: Networks & Tokens items: - - title: Compute-to-Data + - 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/ + +- group: Compute-to-Data + items: + - title: Compute-to-Data Overview 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/ + diff --git a/data/sidebars/setup.yml b/data/sidebars/setup.yml deleted file mode 100644 index 1eecbe34..00000000 --- a/data/sidebars/setup.yml +++ /dev/null @@ -1,9 +0,0 @@ -- group: Marketplaces - items: - - title: Set Up a Marketplace - link: /setup/marketplace/ - -- group: Compute-to-Data - items: - - title: Run a Compute-to-Data Environment - link: /setup/compute-to-data/ diff --git a/data/sidebars/tutorials.yml b/data/sidebars/tutorials.yml index d5d349b7..e07049ef 100644 --- a/data/sidebars/tutorials.yml +++ b/data/sidebars/tutorials.yml @@ -12,23 +12,6 @@ - title: Use Your Wallet to Manage OCEAN Tokens link: /tutorials/wallets-and-ocean-tokens/ -- group: Networks - items: - - title: Supported Networks - link: /tutorials/networks-overview/ - - title: Connect Wallets to Networks - link: /tutorials/connect-to-networks/ - - title: Get ETH 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 items: - title: Set Up a Marketplace @@ -47,16 +30,3 @@ link: /tutorials/amazon-s3-for-brizo/ - title: Set Up On-Premise Storage 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/ From 846df047c992077b75223a327987fa57b009ca92 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:44:13 +0100 Subject: [PATCH 26/30] tweak --- content/tutorials/compute-to-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/compute-to-data.md b/content/tutorials/compute-to-data.md index 1c1ce6be..93b621d0 100644 --- a/content/tutorials/compute-to-data.md +++ b/content/tutorials/compute-to-data.md @@ -1,6 +1,6 @@ --- title: Set Up a Compute-to-Data Environment -description: Set Up a Compute-to-Data environment. +description: --- ## Requirements From 36c21d4157f9870de27354317e767cbbfa636e79 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 18:48:58 +0100 Subject: [PATCH 27/30] fix lint issue --- data/sidebars/concepts.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/data/sidebars/concepts.yml b/data/sidebars/concepts.yml index 22d9d435..151c7750 100644 --- a/data/sidebars/concepts.yml +++ b/data/sidebars/concepts.yml @@ -15,7 +15,7 @@ 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 @@ -44,4 +44,3 @@ link: /concepts/legal-reqs/ - title: Code of Conduct link: /concepts/code-of-conduct/ - From 1e82a85e1255b45ed5ee32f1057fddfa26124452 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 19:32:22 +0100 Subject: [PATCH 28/30] add redirects --- config.js | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/config.js b/config.js index a18c803a..1ee4fdd2 100644 --- a/config.js +++ b/config.js @@ -28,6 +28,18 @@ module.exports = { { from: '/references/', to: '/references/introduction/' + }, + { + from: '/concepts/wallets/', + to: '/tutorials/wallets/' + }, + { + from: '/tutorials/get-ether-and-ocean-tokens/', + to: '/concepts/get-ether-and-ocean-tokens/' + }, + { + from: '/tutorials/connect-to-networks/', + to: '/concepts/connect-to-networks/' } ] } From 3400eff828dc209445884ebd4005821704c6c49e Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 19:34:59 +0100 Subject: [PATCH 29/30] fix links --- content/concepts/contributing.md | 6 +++--- content/concepts/networks-overview.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/content/concepts/contributing.md b/content/concepts/contributing.md index 4740e214..92d90a3f 100644 --- a/content/concepts/contributing.md +++ b/content/concepts/contributing.md @@ -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. - 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](/tutorials/legal-reqs/). Please be aware of this. -- Finally, here's the [Contributor Code of Conduct](/tutorials/code-of-conduct/). +- 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. +- Finally, here's the [Contributor Code of Conduct](/concepts/code-of-conduct/). ### 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 -To report a vulnerability, [go here](/tutorials/vulnerabilities/). +To report a vulnerability, [go here](/concepts/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. diff --git a/content/concepts/networks-overview.md b/content/concepts/networks-overview.md index 1387c155..522c42e1 100644 --- a/content/concepts/networks-overview.md +++ b/content/concepts/networks-overview.md @@ -7,13 +7,13 @@ description: Ocean is deployed to these public networks: -- [Ethereum mainnet](/tutorials/network-ethmainnet/) - production -- [Rinkeby](/tutorials/network-rinkeby/) - testnet -- [Ropsten](/tutorials/network-ropsten) - testnet +- [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](/tutorials/network-local) - local testnet +- [Ganache](/concepts/network-local) - local testnet ## Chain ids From 4614c964bd24361266d7a1359858dcc6ab65c118 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 11 Dec 2020 20:11:10 +0100 Subject: [PATCH 30/30] fix link{ --- content/concepts/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/concepts/contributing.md b/content/concepts/contributing.md index 92d90a3f..fc0396c4 100644 --- a/content/concepts/contributing.md +++ b/content/concepts/contributing.md @@ -31,4 +31,4 @@ These docs can always be improved. Here's the repo. ### Other ways to get involved -Please go to the [Ocean Community Page](www.oceanprotocol.com/community) for more ideas on how to get involved. +Please go to the [Ocean Community Page](https://www.oceanprotocol.com/community) for more ideas on how to get involved.