mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
Merge branch 'master' into feature/api-docs
This commit is contained in:
commit
49bedb37b8
@ -11,16 +11,12 @@ The [Kovan Testnet](https://github.com/kovan-testnet/proposal) (or just "Kovan")
|
||||
|
||||
Moreover, there is a [Secret Store](/concepts/components/#secret-store) operated by the Ocean Protocol Foundation which is connected to the Kovan Testnet: the Ocean Secret Store for Kovan.
|
||||
|
||||
There's a [tutorial about how to get set up to use a testnet](/tutorials/use-a-testnet/).
|
||||
|
||||
## Ocean Testnet
|
||||
|
||||
The Ocean Testnet (also called the Ocean POA Testnet) is similar to the Kovan Testnet, except all the nodes are operated by the Ocean Protocol Foundation. The Ocean Protocol [keeper contracts](https://github.com/oceanprotocol/keeper-contracts) (smart contracts) are deployed there.
|
||||
|
||||
Moreover, there is a [Secret Store](/concepts/components/#secret-store) operated by the Ocean Protocol Foundation which is connected to the Ocean Testnet: the Ocean Secret Store.
|
||||
|
||||
For now, there's no easy way to get Ether for the Ocean Testnet, so we recommend using the Kovan Testnet (for now).
|
||||
|
||||
## Technical Details about the Public Testnets
|
||||
|
||||
- [Details about the Ocean Testnet](https://github.com/oceanprotocol/dev-ocean/blob/master/doc/devops/secret-store-cluster.md) (which is called the "Parity Secret Store Cluster" on that page).
|
||||
|
@ -5,13 +5,20 @@ description: Set up and run a data marketplace in the Ocean network.
|
||||
|
||||
If you want to set up and run a marketplace in the Ocean network, then at a technical level, you must:
|
||||
|
||||
1. Have [Data Assets](/concepts/terminology/#asset-or-data-asset) to offer in your marketplace.
|
||||
1. Develop a marketplace application (app).
|
||||
2. Run your marketplace app in production.
|
||||
1. Run your marketplace app in production.
|
||||
|
||||
**Note 1: At the time of writing (late November 2018), it was _possible_ to start developing a marketplace, but very challenging. We anticipate that it will become much easier in December 2018, especially once the docker-images scripts and Docker Compose files are refactored.**
|
||||
|
||||
**Note 2: In the early days of the Ocean network, there won't be many marketplaces or publishers, so marketplaces will often also act as publishers.**
|
||||
|
||||
## Prepare Data Assets
|
||||
|
||||
At the time of writing, the only kind of [data assets](/concepts/terminology/#asset-or-data-asset) supported by Ocean Protocol were datasets stored in Azure Storage. See [the tutorial about setting up Azure Storage to work with Ocean Protocol](/tutorials/azure-for-brizo/).
|
||||
|
||||
Support for other kinds of data assets (e.g. storage in AWS, computing in Azure) is coming soon.
|
||||
|
||||
## Develop a Marketplace App
|
||||
|
||||
An Ocean marketplace app is one of the primary ways that end users use the Ocean network. For example, a data scientist could use a marketplace app to see what data sets and data services (data assets) a marketplace has on offer. They can use the marketplace app to buy access to assets. Publishers make those data assets available.
|
||||
@ -41,11 +48,11 @@ Of course, you could always write your own Squid library in the language of your
|
||||
|
||||
## Run Your Marketplace App in Production
|
||||
|
||||
Before running your marketplace app in production with the Ocean Mainnet, you may want to test it with an Ocean Testnet.
|
||||
The Ocean Testnets are similar to the Ocean Mainnet.
|
||||
The main difference is that there is less risk on the Ocean Testnets.
|
||||
Before running your marketplace app in production with the Ocean Mainnet, you may want to test it with an Ocean testnet.
|
||||
The Ocean testnets are similar to the Ocean Mainnet.
|
||||
The main difference is that there is less risk on the Ocean testnets.
|
||||
|
||||
**Note: At the time of writing, the Ocean Mainnet hadn't gone live yet, but the testnets were about to go live. See [the page about testnets](/concepts/testnets/).**
|
||||
**Note: At the time of writing, the Ocean Mainnet hadn't gone live yet, but the Ocean testnets were about to go live. See [the page about Ocean testnets](/concepts/testnets/).**
|
||||
|
||||
Of course, there are many other things that must be handled for live production apps:
|
||||
|
||||
|
51
content/tutorials/get-ether-and-ocean-tokens.md
Normal file
51
content/tutorials/get-ether-and-ocean-tokens.md
Normal file
@ -0,0 +1,51 @@
|
||||
---
|
||||
title: Get Ether and Ocean Tokens for Testnets
|
||||
description: A tutorial about how to get Ether and Ocean Tokens for testnets.
|
||||
---
|
||||
|
||||
If you want to interact with a testnet, then you'll eventually need Ether or Ocean Tokens _for that testnet_. (Every Ethereum-based network has its own Ether and its own Ocean Tokens, and you can't use those in other networks, or at least it wasn't possible when we wrote this.)
|
||||
|
||||
At the time of writing, there were two public testnets you could use to test an Ocean Protocol application: the Kovan Testnet and the Ocean Testnet. For more information about those, see the page about [testnets](/concepts/testnets/). You could also run a local testnet (i.e. on your local machine).
|
||||
|
||||
## Get a Compatible Wallet
|
||||
|
||||
You will need a wallet that can hold Ether (for any Ethereum network) and Ocean Tokens (for any Ethereum network). For now, we recommend using [MetaMask](https://metamask.io/).
|
||||
|
||||
- Follow the MetaMask instructions to install it on your machine.
|
||||
- In MetaMask, switch from the **Main Ethereum Network** to the **Kovan Test Network** or the test network you're using.
|
||||
|
||||
## Get Ether
|
||||
|
||||
### Get Ether for the Kovan Testnet
|
||||
|
||||
You can get Kovan Ether (KEth), for the Kovan Testnet, from a Kovan faucet: see [the official list of Kovan faucets](https://github.com/kovan-testnet/faucet). You have to give the faucet your Kovan address (wallet account address). You can get that from MetaMask. It's a string that looks like:
|
||||
|
||||
```text
|
||||
0xa0A9d7f78bF293514e7cA2789A0Af689eEC99282
|
||||
```
|
||||
|
||||
### Get Ether for the Ocean Testnet
|
||||
|
||||
At the time of writing, there was no easy way to get Ether for the Ocean Testnet.
|
||||
|
||||
### 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 Parity-Ethereum-Based Testnet
|
||||
|
||||
If you're running a local Parity-Ethereum-based testnet based on [docker-images](https://github.com/oceanprotocol/docker-images), then you can send some Ether to `<YOUR ADDRESS>` using the command:
|
||||
|
||||
```bash
|
||||
curl --data '{"jsonrpc":"2.0","method":"personal_sendTransaction","params":[{"from":"0x00Bd138aBD70e2F00903268F3Db08f2D25677C9e","to":"<YOUR ADDRESS>","value":"0x7FFFFFFFFFFFFFFFFFF"}, "node0"],"id":0}' -H "Content-Type: application/json" -X POST localhost:8545
|
||||
```
|
||||
|
||||
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).
|
||||
|
||||
## Get Ocean Tokens
|
||||
|
||||
One way to get some Ocean Tokens, for the network you're connected to, is by running Pleuston (a demo Ocean marketplace web app) and then clicking in the top right corner of the Pleuston user interface. If you see "Make it rain" then click that.
|
||||
|
||||
Running Pleuston, along with all the software it needs to work, is beyond the scope of this tutorial. If you want to do _that_, then the current best option is to use the scripts and Docker Compose files in the [🐳 docker-images repository](https://github.com/oceanprotocol/docker-images).
|
||||
|
||||
<repo name="docker-images"></repo>
|
@ -1,31 +0,0 @@
|
||||
---
|
||||
title: How to Use a Testnet
|
||||
description: A tutorial showing how to get set up to use one of the public testnets.
|
||||
---
|
||||
|
||||
At the time of writing, there were two public testnets you could use to test an Ocean Protocol application: the Kovan Testnet and the Ocean Testnet. For more information about those, see the page about [testnets](/concepts/testnets/). Also at the time of writing, there was no easy was to get Ether for the Ocean Testnet, so this tutorial is for the Kovan Testnet (for now).
|
||||
|
||||
## Get a Compatible Wallet
|
||||
|
||||
You will need a wallet that can hold Ether (for any Ethereum network) and Ocean Tokens (for any Ethereum network). For now, we recommend using [MetaMask](https://metamask.io/).
|
||||
|
||||
- Follow the MetaMask instructions to install it on your machine.
|
||||
- In MetaMask, switch from the **Main Ethereum Network** to the **Kovan Test Network**.
|
||||
|
||||
## Get Kovan Ether (KEth)
|
||||
|
||||
You can get Kovan Ether (KEth) from a Kovan faucet: see [the official list of Kovan faucets](https://github.com/kovan-testnet/faucet). You have to give the faucet your Kovan address (wallet account address). You can get that from MetaMask. It's a string that looks like:
|
||||
|
||||
```text
|
||||
0xa0A9d7f78bF293514e7cA2789A0Af689eEC99282
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
You may want to get some Ocean Tokens for the Kovan Testnet (e.g. so you can buy assets). Currently, the easiest way to get some Ocean Tokens is by running Pleuston (a demo Ocean marketplace web app) and then clicking in the top right corner of the Pleuston user interface. If you see "Make it rain" then click that.
|
||||
|
||||
Running Pleuston, along with all the software it needs to work, and configuring everything to work together (and connect to Kovan) is beyond the scope of this tutorial. If you want to do _that_, then the current best option is to use the scripts and Docker Compose files in the [🐳 docker-images repository](https://github.com/oceanprotocol/docker-images).
|
||||
|
||||
<repo name="docker-images"></repo>
|
||||
|
||||
Note that Kovan Ocean Tokens can't be transferred to or used in other Ethereum networks (or at least it wasn't possible at the time of writing).
|
@ -2,9 +2,9 @@
|
||||
items:
|
||||
- title: Introduction
|
||||
link: /tutorials/introduction/
|
||||
- title: How to Use a Testnet
|
||||
link: /tutorials/use-a-testnet/
|
||||
- title: Create Azure Credentials for Brizo
|
||||
- title: Get Ether and Ocean Tokens for Testnets
|
||||
link: /tutorials/get-ether-and-ocean-tokens/
|
||||
- title: Set Up Azure Storage
|
||||
link: /tutorials/azure-for-brizo/
|
||||
|
||||
- group: Publish
|
||||
|
2
external/dev-ocean
vendored
2
external/dev-ocean
vendored
@ -1 +1 @@
|
||||
Subproject commit 947a1a71e31698bb2dd0be5ae1f5c78bc3dc7b8f
|
||||
Subproject commit 958316426a441f34d05a2240806577008713b5a7
|
@ -7,7 +7,6 @@
|
||||
-webkit-overflow-scrolling: touch;
|
||||
margin-left: calc(-50vw + 50%);
|
||||
margin-right: calc(-50vw + 50%);
|
||||
padding-right: $spacer;
|
||||
display: flex;
|
||||
|
||||
@media (min-width: $break-point--medium) {
|
||||
@ -31,10 +30,12 @@
|
||||
margin-left: 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
&:last-child {
|
||||
margin-right: $spacer * 1.4;
|
||||
}
|
||||
// add final right margin
|
||||
&:after {
|
||||
content: '';
|
||||
flex: 0 0 $spacer;
|
||||
}
|
||||
|
||||
// custom scrollbar
|
||||
@ -45,16 +46,14 @@
|
||||
|
||||
&::-webkit-scrollbar {
|
||||
opacity: 0;
|
||||
width: 3px;
|
||||
height: 3px;
|
||||
width: 7px;
|
||||
height: 7px;
|
||||
transition: opacity .2s ease-out;
|
||||
}
|
||||
|
||||
&:hover {
|
||||
&::-webkit-scrollbar {
|
||||
opacity: 1;
|
||||
width: 3px;
|
||||
height: 3px;
|
||||
}
|
||||
|
||||
&::-webkit-scrollbar-thumb {
|
||||
|
Loading…
Reference in New Issue
Block a user