From 0a76bed73863dcbeafdf2dd22bfa260e8ff5c633 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Tue, 30 Jul 2019 12:43:04 +0200 Subject: [PATCH 1/4] mention barge in more places --- content/concepts/tools.md | 8 +++++++- data/repositories.yml | 1 + 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/content/concepts/tools.md b/content/concepts/tools.md index df4b6950..eb6512dd 100644 --- a/content/concepts/tools.md +++ b/content/concepts/tools.md @@ -3,6 +3,12 @@ title: Tools description: Some tools that can be useful when working with Ocean Protocol. --- +## Barge + +Barge is a shell script allowing you to run an Ocean network by orchestrating all [core components](/components) locally with Docker and Docker Compose. + + + ## Tuna Tuna is a showcase and provides cross environment examples & tests for the Squid client libraries. @@ -17,7 +23,7 @@ Plecos is a Python tool to check metadata (a JSON file) to see if it conforms to ## Faucet Server -The [Ocean Protocol Faucet Server](https://github.com/oceanprotocol/faucet) is a microservice that allows users to request Ether for a particular Ethereum network (e.g. the Nile Testnet). +The [Ocean Protocol Faucet Server](https://github.com/oceanprotocol/faucet) is a microservice that allows users to request Ether for a particular Ethereum network (e.g. the Nile Testnet). It is [deployed in multiple networks](http://localhost:8000/tutorials/get-ether-and-ocean-tokens/#get-ether), and included when running [Barge](#barge). diff --git a/data/repositories.yml b/data/repositories.yml index 53735ffc..c664f3fd 100644 --- a/data/repositories.yml +++ b/data/repositories.yml @@ -35,6 +35,7 @@ - group: Tools items: + - name: barge - name: tuna - name: plecos - name: faucet From 9dab2f341d429281cd79d1e2b6aedbb8b0003507 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Tue, 30 Jul 2019 12:54:55 +0200 Subject: [PATCH 2/4] limit options to get ETH in Spree --- content/concepts/tools.md | 2 +- .../tutorials/get-ether-and-ocean-tokens.md | 34 +++++++------------ 2 files changed, 13 insertions(+), 23 deletions(-) diff --git a/content/concepts/tools.md b/content/concepts/tools.md index eb6512dd..61f1e6d5 100644 --- a/content/concepts/tools.md +++ b/content/concepts/tools.md @@ -23,7 +23,7 @@ Plecos is a Python tool to check metadata (a JSON file) to see if it conforms to ## Faucet Server -The [Ocean Protocol Faucet Server](https://github.com/oceanprotocol/faucet) is a microservice that allows users to request Ether for a particular Ethereum network (e.g. the Nile Testnet). It is [deployed in multiple networks](http://localhost:8000/tutorials/get-ether-and-ocean-tokens/#get-ether), and included when running [Barge](#barge). +The [Ocean Protocol Faucet Server](https://github.com/oceanprotocol/faucet) is a microservice that allows users to request Ether for a particular Ethereum network (e.g. the Nile Testnet). It is [deployed in multiple networks](/tutorials/get-ether-and-ocean-tokens/#get-ether), and started by default when using [Barge](#barge). diff --git a/content/tutorials/get-ether-and-ocean-tokens.md b/content/tutorials/get-ether-and-ocean-tokens.md index a3b790c3..a714ea9b 100644 --- a/content/tutorials/get-ether-and-ocean-tokens.md +++ b/content/tutorials/get-ether-and-ocean-tokens.md @@ -9,15 +9,15 @@ There are some public testnets you can use to test an Ocean Protocol application ## Get a Compatible Wallet -You will need a [wallet that can hold Ether (for any Ethereum network) and Ocean Tokens (for any Ethereum network)](/concepts/wallets/). For the purpose of this tutorial, you can use MetaMask. See [our tutorial about how to set up MetaMask](/tutorials/metamask-setup/). +You will need a [wallet](/concepts/wallets/) that can hold Ether (for any Ethereum network) and Ocean Tokens (for any Ethereum network). For the purpose of this tutorial, you can use MetaMask. See our tutorial about [how to set up MetaMask](/tutorials/metamask-setup/). -In MetaMask, be sure to switch from the **Main Ethereum Network** to whatever network you're using. +In MetaMask, be sure to switch from the _Main Ethereum Network_ to whatever Ocean network you're using. ## Get Ether ### Get Ether for the Pacific Network -If you're connecting to the Pacific network, you can use the Ocean Faucet. A simple UI for it is deployed as part of the Commons marketplace under: +If you're connecting to the Pacific network, you can use the [Ocean Faucet server](/concepts/tools/#faucet-server). A simple user interface for it is deployed as part of the Commons marketplace under: - client: [commons.oceanprotocol.com/faucet](https://commons.oceanprotocol.com/faucet) @@ -25,15 +25,13 @@ This interface is set up to communicate with the deployed Ocean Faucet Server un - server: [faucet.oceanprotocol.com](https://faucet.oceanprotocol.com) -You can also communicate with that server directly and get some Nile Ether into `` using the following command: +You can also communicate with that server directly and get some Pacific Ether into `` using the following command: ```bash curl --data '{"address": "", "agent": "curl"}' -H "Content-Type: application/json" -X POST https://faucet.oceanprotocol.com/faucet ``` -In the above command you only need to replace `` with your own Ethereum address. - -Check out the [Ocean Faucet Server repository](https://github.com/oceanprotocol/faucet) to learn more about what the server provides. +Check out the [Ocean Faucet server repository](https://github.com/oceanprotocol/faucet) to learn more about what the server provides. The Pacific faucet has a limit of one request every 24 hours for the same Ethereum address. But don't worry, the Ether given is more than enough for interacting with the network. @@ -53,27 +51,21 @@ You can also communicate with that server directly and get some Nile Ether into curl --data '{"address": "", "agent": "curl"}' -H "Content-Type: application/json" -X POST https://faucet.nile.dev-ocean.com/faucet ``` -In the above command you only need to replace `` with your own Ethereum address. - Check out the [Ocean Faucet Server repository](https://github.com/oceanprotocol/faucet) to learn more about what the server provides. The Nile faucet has a limit of one request every 24 hours for the same Ethereum address. But don't worry, the Ether given is more than enough for interacting with the network. -### Get Ether for a Local Ganache-Based Testnet - -If you're running a local Ganache-based testnet, then it creates several accounts at network launch time, and gives each of them some Ether. The addresses and private keys of those accounts should be shared (to logs or the console) during the launch process. You can use those accounts and their Ether. - ### Get Ether for a Local Spree Testnet -**Option 1:** If you're running a local Spree testnet, then you can send some Spree Ether to `` using the following command (a long command that wraps around): +You can use the [Ocean Faucet server](/concepts/tools/#faucet-server) which is stafrted by default when you run [Barge](/concepts/tools/#barge). + +To ask the faucet to send some Spree Ether to ``, use the command: ```bash -curl --data '{"jsonrpc":"2.0","method":"personal_sendTransaction","params":[{"from":"0x00Bd138aBD70e2F00903268F3Db08f2D25677C9e","to":"","value":"0x7FFFFFFFFFFFFFFFFFF"}, "node0"],"id":0}' -H "Content-Type: application/json" -X POST localhost:8545 +curl --data '{"address":""}' -H "Content-Type: application/json" -X POST localhost:3001/faucet ``` -That command uses [Ethereum's JSON RPC API](https://wiki.parity.io/JSONRPC.html). You can also create a new account using the Parity Ethereum CLI. See [the Parity Ethereum CLI documentation](https://wiki.parity.io/CLI-Sub-commands). - -**Option 2:** By default, the Spree testnet is configured to bootstrap ten accounts with a decent amount of Spree Ether in each one. To get access to those accounts, you can import the following seed phrase into MetaMask (e.g. by logging out and then clicking "Import using account seed phrase"): +Alternatively, you can import the seed phrase used to generate the accounts in Spree into MetaMask (e.g. by logging out and then clicking "Import using account seed phrase"). By default, the Spree testnet is configured to bootstrap ten accounts with a decent amount of Spree Ether in each one. `taxi music thumb unique chat sand crew more leg another off lamp` @@ -81,11 +73,9 @@ Details about the bootstrapped accounts can be found in [the README.md file in t > **WARNING!** Never use any of those accounts in any mainnet. They are for testing purposes only. -**Option 3:** Another option is to run [the Ocean faucet server](https://github.com/oceanprotocol/faucet) on your machine, with default configuration settings. The default settings enable it to dispense Spree Ether. To ask the faucet to send some Spree Ether to ``, use the command (a long command that wraps around): +### Get Ether for a Local Ganache-Based Testnet -```bash -curl --data '{"address":""}' -H "Content-Type: application/json" -X POST localhost:3001/faucet -``` +If you're running a local Ganache-based testnet, then it creates several accounts at network launch time, and gives each of them some Ether. The addresses and private keys of those accounts should be shared (to logs or the console) during the launch process. You can use those accounts and their Ether. ## Get Ocean Tokens From 834addebd7be691a0537b997a51ab12292244edc Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Tue, 30 Jul 2019 13:06:09 +0200 Subject: [PATCH 3/4] link to quickstart --- content/concepts/tools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/concepts/tools.md b/content/concepts/tools.md index 61f1e6d5..84b62f46 100644 --- a/content/concepts/tools.md +++ b/content/concepts/tools.md @@ -5,7 +5,7 @@ description: Some tools that can be useful when working with Ocean Protocol. ## Barge -Barge is a shell script allowing you to run an Ocean network by orchestrating all [core components](/components) locally with Docker and Docker Compose. +Barge is a shell script allowing you to run an Ocean network by orchestrating all [core components](/components) locally with Docker and Docker Compose. Extensively used by Ocean developers to develop and test Ocean core components locally, and the [quickest way](/setup/quickstart/) to get a full Ocean network up and running. From 41a3850052c0836c4e09e2ab64a44a2ca7a04c7a Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Tue, 30 Jul 2019 13:12:41 +0200 Subject: [PATCH 4/4] update submarine section --- content/concepts/tools.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/concepts/tools.md b/content/concepts/tools.md index 84b62f46..bb51857b 100644 --- a/content/concepts/tools.md +++ b/content/concepts/tools.md @@ -29,8 +29,12 @@ The [Ocean Protocol Faucet Server](https://github.com/oceanprotocol/faucet) is a ## Submarine Blockchain Explorer -Submarine is based on [BlockScout](https://github.com/poanetwork/blockscout) (by [POA](https://poa.network/)), an open source blockchain explorer for EVM-based blockchain networks. -There is an [Ocean Protocol fork of BlockScout](https://github.com/oceanprotocol/blockscout). An instance is deployed in the Nile Testnet at [https://submarine.dev-ocean.com/](https://submarine.dev-ocean.com/). +Submarine is based on [BlockScout](https://github.com/poanetwork/blockscout) (by [POA](https://poa.network/)), an open source blockchain explorer for EVM-based blockchain networks. We use our own [fork of BlockScout](https://github.com/oceanprotocol/blockscout). + +Instances are deployed for: + +- **Pacific Network: [submarine.oceanprotocol.com](https://submarine.oceanprotocol.com/)** +- **Nile Testnet: [submarine.dev-ocean.com](https://submarine.dev-ocean.com/)**