Add 2 new tutorials re/ wallets
This commit is contained in:
Troy McConaghy
parent
c1cd598dac
commit
e7dc8b41f5
|
|
@ -3,28 +3,16 @@ title: Testnets
|
|||
description: An overview of public test networks that you can test Ocean Protocol applications against.
|
||||
---
|
||||
|
||||
You can test an Ocean Protocol application (such as a marketplace) against the test networks (testnets) described below.
|
||||
You can test an Ocean Protocol application (such as a marketplace) against the test networks (testnets) described below. This page is a brief overview of those testnets. The [tutorials](/tutorials/) cover more details (e.g. how to connect to specific ones).
|
||||
|
||||
## The Kovan Testnet
|
||||
|
||||
The [Kovan Testnet](https://github.com/kovan-testnet/proposal) (or just "Kovan") is a public Ethereum Testnet operated by members of the Ethereum community.
|
||||
|
||||
Most Ethereum wallets and libraries know how to connect to the Kovan Testnet. If you're using [Barge](https://github.com/oceanprotocol/barge) to run a local Kovan node, you can connect to that local Kovan node at RPC URL [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask).
|
||||
|
||||
### Kovan Blockchain Explorers
|
||||
|
||||
There are some Kovan blockchain explorers, e.g. [Etherscan for Kovan](https://kovan.etherscan.io/) and [BlockScout for Kovan](https://blockscout.com/eth/kovan). You can use those to check the status of a transaction, the balance of an account, and more.
|
||||
|
||||
### Keeper Contracts on Kovan
|
||||
|
||||
The Ocean Protocol [keeper contracts](https://github.com/oceanprotocol/keeper-contracts) (smart contracts) are deployed on Kovan. In fact, several versions of the keeper contracts have been deployed there. You can find the addresses of recently-deployed keeper contracts (including the OceanToken contract) as follows:
|
||||
|
||||
1. Go to [the list of keeper-contracts releases (Git tags) on GitHub](https://github.com/oceanprotocol/keeper-contracts/releases).
|
||||
1. Click on the name of a release's Git tag in the left sidebar. It will look something like `v0.8.3`.
|
||||
1. Scroll down to the **Kovan Testnet** section of the README.md file. The contract addresses are listed there. Note: Sometimes there is a disconnect between the release number and the listed version number.
|
||||
|
||||
Note: Because Ocean Protocol uses ZeppelinOS to manage smart contract upgrades, a keeper contract address might not change over time (because it's just the address _of the proxy contract_) but the actually-used smart contract might change, along with its functionality.
|
||||
|
||||
### Ocean Components Connected to Kovan
|
||||
|
||||
There is a [Secret Store](/concepts/components/#secret-store) connected to the Kovan Testnet for use by Ocean Protocol projects (including your projects). It's operated by BigchainDB GmbH. Its URL is:
|
||||
|
|
@ -39,21 +27,6 @@ _Formerly called the Ocean POA Testnet._
|
|||
|
||||
The Nile Testnet is similar to the Kovan Testnet, except all the nodes are operated by BigchainDB GmbH.
|
||||
|
||||
### Nile Testnet Parameters
|
||||
|
||||
Parameter | Value
|
||||
-------------------|---------------
|
||||
RPC URL (required) | [https://nile.dev-ocean.com/](https://nile.dev-ocean.com/)
|
||||
ChainID | 8995 (decimal for MetaMask) or 0x2323 (hexadecimal)
|
||||
Symbol | Whatever you like
|
||||
Nickname | Whatever you like
|
||||
|
||||
- In MetaMask, you don't need to include the port number with the RPC URL.
|
||||
- If you're using MetaMask, see the [MetaMask docs about how it uses the ChainID](https://metamask.github.io/metamask-docs/Main_Concepts/Sending_Transactions).
|
||||
- If you're using [Barge](https://github.com/oceanprotocol/barge) to run a local Nile node:
|
||||
- You can connect to that local Nile node at RPC URL [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask).
|
||||
- You can configure that local Nile node by editing the files in the `barge/networks/nile/config/` directory.
|
||||
|
||||
### Nile Blockchain Explorers
|
||||
|
||||
There is a Nile blockchain explorer at [https://submarine.dev-ocean.com/](https://submarine.dev-ocean.com/). You can use it to check the status of a transaction, the balance of an account, and more. It uses the following symbols for Nile Ether and Nile Ocean Tokens:
|
||||
|
|
@ -63,10 +36,6 @@ Cryptocurrency | Symbol used
|
|||
Nile Ether | POA
|
||||
Nile Ocean Tokens | OCEAN or SBT-OCN
|
||||
|
||||
### Keeper Contracts on Nile
|
||||
|
||||
See the subsection about the [Keeper Contracts on Kovan](#keeper-contracts-on-kovan). The Nile contract addresses can be found in the same way.
|
||||
|
||||
### Ocean Components Connected to Nile
|
||||
|
||||
There are several Ocean Protocol software components that are live, connected to the Nile Testnet, and operated by BigchainDB GmbH:
|
||||
|
|
@ -81,10 +50,12 @@ There are several Ocean Protocol software components that are live, connected to
|
|||
|
||||
## A Spree Testnet
|
||||
|
||||
When Ocean Protocol developers run [Barge](https://github.com/oceanprotocol/barge) with the `--local-spree-node` option, a "Spree Testnet" is deployed on their local machine: a local testnet not connected to any external public testnet. The RPC URL is [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask).
|
||||
When Ocean Protocol developers run [Barge](https://github.com/oceanprotocol/barge) with the `--local-spree-node` option, a "Spree Testnet" is deployed on their local machine: a local testnet not connected to any external public testnet.
|
||||
|
||||
Spree Testnet details can be found in the [Barge README.md file](https://github.com/oceanprotocol/barge/blob/develop/README.md).
|
||||
|
||||
You can configure the Spree nodes by editing the files in the `barge/networks/spree/` directory.
|
||||
Spree Testnet details can be found in the [Barge README.md file](https://github.com/oceanprotocol/barge/blob/develop/README.md). You can configure the Spree nodes by editing the files in the `barge/networks/spree/` directory.
|
||||
|
||||
Note: Spree testnets are named after the Spree River, the main river flowing through Berlin, Germany, where many Ocean Protocol developers are located.
|
||||
|
||||
## A Ganache-Based Testnet
|
||||
|
||||
A local testnet similar to Spree but launched by using the `--local-ganache-node` option with Barge.
|
||||
|
|
|
|||
|
|
@ -34,6 +34,11 @@ Each account has one **private key**, one **public key** and one **address**. Th
|
|||
|
||||
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](http://localhost:8000/tutorials/introduction/).
|
||||
|
||||
|
||||
[1]: https://metamask.io/
|
||||
[2]: https://trezor.io/
|
||||
[3]: https://www.ledger.com/
|
||||
|
|
|
|||
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
title: Connect to Ocean-Related Networks
|
||||
description: How to connect to the Kovan testnet, Nile testnet and other Ocean-related networks.
|
||||
---
|
||||
|
||||
## Connect to the Kovan Testnet
|
||||
|
||||
Most Ethereum wallets and libraries know how to connect to the [Kovan Testnet](/concepts/testnets/#the-kovan-testnet). In MetaMask, click on the network name then click on "Kovan Test Network" in the drop-down list.
|
||||
|
||||
If you're using [Barge](https://github.com/oceanprotocol/barge) to run a local Kovan node, you can connect to that local Kovan node at RPC URL [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask).
|
||||
|
||||
## Connect to the Nile Testnet
|
||||
|
||||
Here are the parameters you might need to connect to the [Nile Testnet](/concepts/testnets/#the-nile-testnet):
|
||||
|
||||
Parameter | Value
|
||||
-------------------|---------------
|
||||
RPC URL (required) | [https://nile.dev-ocean.com/](https://nile.dev-ocean.com/)
|
||||
ChainID | 8995 (decimal for MetaMask) or 0x2323 (hexadecimal)
|
||||
Symbol | Whatever you like
|
||||
Nickname | Whatever you like
|
||||
|
||||
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).
|
||||
|
||||
If you're using [Barge](https://github.com/oceanprotocol/barge) to run a local Nile node, you can connect to that local Nile node at RPC URL [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask). You can configure that local Nile node by editing the files in the `barge/networks/nile/config/` directory.
|
||||
|
||||
## Connect to a Local Spree Testnet or Ganache-Based Testnet
|
||||
|
||||
When using [Barge](https://github.com/oceanprotocol/barge) to run a purely-local testnet (Spree or Ganache-based), you can connect to a local node at RPC URL [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask).
|
||||
|
|
@ -3,4 +3,8 @@ title: Overview of the Tutorials
|
|||
description: What you can expect to find in these Ocean Protocol tutorials.
|
||||
---
|
||||
|
||||
The idea of these tutorials is to show you how to use squid-js (JavaScript), squid-py (Python) and squid-java to publish a data set, to get & use a data set, and to do other things.
|
||||
These tutorials cover:
|
||||
|
||||
- The basics of using wallets with Ocean Protocol.
|
||||
- How to set up storage (e.g. in Azure or AWS) to be used with Ocean Protocol.
|
||||
- Examples of using squid-js (JavaScript), squid-py (Python) and squid-java to publish a data set, to get & use a data set, and to do other things.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,56 @@
|
|||
---
|
||||
title: Teach Your Wallet to Track Ocean Tokens
|
||||
description: How to teach various crypto wallet software to track Ocean Tokens.
|
||||
---
|
||||
|
||||
If you don't see any Ocean Tokens in your wallet software (e.g. MetaMask or MyEtherWallet), don't worry! It might not know how to track Ocean Tokens yet. You can teach it how.
|
||||
|
||||
## Step 1: Determine the Ocean Token Contract Address in the Network You're Using
|
||||
|
||||
### Kovan or Nile Testnet
|
||||
|
||||
Testnet | Ocean Token Contract Address
|
||||
--------------|-----------------------------
|
||||
Kovan | `0xB57C4D626548eB8AC0B82b086721516493E2908d`
|
||||
Nile | `0xcDae1AFa8025BE03Bc56D112eB4da3277913563d`
|
||||
|
||||
If the above addresses are out-of-date, then you can find newer ones in the [keeper-contracts repository on GitHub](https://github.com/oceanprotocol/keeper-contracts):
|
||||
|
||||
1. Click on the "Branch: **develop**" button and switch to the tag of the latest release (e.g. `v0.8.6`).
|
||||
1. In the `README.md` file, check the address of the OceanToken contract (in Nile or Kovan).
|
||||
1. Double-check the address by looking in the file named `zos.kovan.json` (for Kovan) or `zos.dev-8995.json` (for Nile). Check for a block of JSON that looks like:
|
||||
|
||||
```json
|
||||
"@oceanprotocol/keeper-contracts/OceanToken": [
|
||||
{
|
||||
"address": "0xB57C4D626548eB8AC0B82b086721516493E2908d",
|
||||
"version": "v0.8.6",
|
||||
"implementation": "0x6E2c2D9c1fA947FAE47AD3EFF86A97C0e1E82EE4",
|
||||
"admin": "0xA18999a10D9e7d8116c406D284fa31541e019177"
|
||||
}
|
||||
```
|
||||
|
||||
Compare the `"address"` value to the value from the `README.md` file.
|
||||
|
||||
### Spree or Ganache-Based Testnet
|
||||
|
||||
If you're using [Barge](https://github.com/oceanprotocol/barge) to run a local Spree Testnet or a local Ganache-based testnet, then you can get the address of the OceanToken contract by looking at the value of `"address"` in:
|
||||
|
||||
- `$HOME/.ocean/keeper-contracts/artifacts/OceanToken.spree.json` for Spree
|
||||
- `$HOME/.ocean/keeper-contracts/artifacts/OceanToken.development.json` for Ganache
|
||||
|
||||
## Step 2: Teach Your Wallet Software about Ocean Tokens
|
||||
|
||||
### MetaMask Instructions
|
||||
|
||||
1. Make sure MetaMask is connected to the correct network (Nile, Kovan or whatever). See [the tutorial about how to do that](/tutorials/connect-to-networks/).
|
||||
1. For the account you want to manage, click the `☰` (hamburger menu icon).
|
||||
1. Scroll down until the `ADD TOKEN` link is visible, then click on it.
|
||||
1. Click on `Custom Token`.
|
||||
1. Paste the OceanToken contract address (from Step 1 above) into the "Token Contract Address" field. The other two fields should auto-fill. If they don't then something is wrong.
|
||||
1. Click `NEXT`.
|
||||
1. Click `ADD TOKENS`.
|
||||
|
||||
### Other Wallet Software
|
||||
|
||||
Do a web search to find out how to add a custom ERC-20 token to the wallet software you're using.
|
||||
|
|
@ -1,11 +1,21 @@
|
|||
- group: Basics
|
||||
- group: Overview
|
||||
items:
|
||||
- title: Introduction
|
||||
link: /tutorials/introduction/
|
||||
|
||||
- group: Wallets & Ocean Protocol
|
||||
items:
|
||||
- title: Set Up MetaMask
|
||||
link: /tutorials/metamask-setup/
|
||||
- title: Connect to Ocean-Related Networks
|
||||
link: /tutorials/connect-to-networks/
|
||||
- title: Teach Your Wallet to Track Ocean Tokens
|
||||
link: /tutorials/wallets-and-ocean-tokens/
|
||||
- title: Get Ether and Ocean Tokens
|
||||
link: /tutorials/get-ether-and-ocean-tokens/
|
||||
|
||||
- group: Storage Setup
|
||||
items:
|
||||
- title: Set Up Azure Storage
|
||||
link: /tutorials/azure-for-brizo/
|
||||
- title: Set Up Amazon S3 Storage
|
||||
|
|
|
|||
Loading…
Reference in New Issue