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

more fixes

Browse Source
This commit is contained in:
Matthias Kretschmann 2019-07-08 18:24:40 +02:00
parent 817a3ba33c
commit b7b57c272a
Signed by: m
GPG Key ID: 606EEEF3C479A91F
7 changed files with 82 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
content/concepts/pacific-network.md
View File

@ -1,26 +1,11 @@
---
title: The Pacific Network
description: An introduction to the Pacific Network.
description: An introduction to Ocean Protocol's main network, named Pacific.
---
## Overview
You can use the Ocean Protocol in several EVM-compatible networks, including:
- the Ethereum Mainnet (also called the Main Ethereum Network),
- various [testnets](/concepts/testnets/), and
- the Pacific Network.
The Pacific Network is an EVM-compatible network of nodes ("keepers") running [Parity Ethereum](https://www.parity.io/ethereum/) software. Various Ocean Protocol smart contracts ("keeper contracts") are deployed to it.
The Pacific Network is (or was) also known by other names, including:
- Pacific
- The Main Ocean Network
- The Ocean Mainnet
- The Ocean Live Network
"Network" is sometimes shortened to just "Net."
The _Pacific Network_[^1] is an EVM-compatible [Proof of Authority (POA) network](https://github.com/poanetwork/wiki/wiki/What-is-POA) of nodes ("keepers") running [Parity Ethereum](https://www.parity.io/ethereum/) software. Various Ocean Protocol smart contracts ("keeper contracts") are deployed to it.
Initially, all the nodes in the Pacific Network were operated solely by BigchainDB GmbH (i.e. one company), but the goal was for the nodes to be operated by many independent operators in the future.
@ -31,13 +16,17 @@ Eventually, the goal is for it to be used in production by many projects.
[Ocean Tokens](/concepts/ocean-tokens/) can, in principle, live in any EVM-compatible network. The ones sold in the Ocean Protocol token sale were in the Ethereum Mainnet. There is a token bridge between the Ethereum Mainnet and the Pacific Network, allowing anyone with Ocean Tokens to move them from the Ethereum Mainnet to the Pacific Network. However, please be aware that doing so would put those Ocean Tokens at risk. For more information, see [the page about Ocean Tokens](/concepts/ocean-tokens/).
[^1]: The Pacific Network is (or was) also known by other names, including _Pacific_, _Main Ocean Network_, _Ocean Mainnet_, _Ocean Live Network_.
## Connect to the Pacific Network
See the [tutorial page about connecting to Ocean-related networks](/tutorials/connect-to-networks/#connect-to-the-pacific-network).
See the tutorial page about [connecting to Ocean-related networks](/tutorials/connect-to-networks/#connect-to-the-pacific-network) to connect to Pacific in your browser with MetaMask.
## Pacific Blockchain Explorers
There is a Pacific blockchain explorer at [https://submarine.oceanprotocol.com/](https://submarine.oceanprotocol.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 Pacific Ether and Pacific Ocean Tokens:
There is a Pacific blockchain explorer at [submarine.oceanprotocol.com](https://submarine.oceanprotocol.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 Pacific Ether and Pacific Ocean Tokens:
| Cryptocurrency | Symbol used |
| -------------------- | ---------------- |
@ -48,19 +37,22 @@ There is a Pacific blockchain explorer at [https://submarine.oceanprotocol.com/]
There are several Ocean Protocol software components that are live, connected to the Pacific Network, and operated by BigchainDB GmbH:
| Component | URL |
| ---------------------- | ---------------------------------------------------------------------------------------- |
| Secret Store | [https://secret-store.oceanprotocol.com](https://secret-store.oceanprotocol.com) |
| Aquarius Test instance | [https://aquarius.test.oceanprotocol.com](https://aquarius.test.oceanprotocol.com) |
| Brizo Test instance | [https://brizo.test.oceanprotocol.com](https://brizo.test.oceanprotocol.com) |
| Aquarius for Commons | [https://aquarius.commons.oceanprotocol.com](https://aquarius.commons.oceanprotocol.com) |
| Brizo for Commons | [https://brizo.commons.oceanprotocol.com](https://brizo.commons.oceanprotocol.com) |
| Commons Marketplace | [https://commons.oceanprotocol.com](https://commons.oceanprotocol.com) |
| Faucet Server | [https://faucet.oceanprotocol.com](https://faucet.oceanprotocol.com) |
| Token Bridge Frontend | [https://bridge.oceanprotocol.com/](https://bridge.oceanprotocol.com/) |
| Component | URL |
| ---------------------- | -------------------------------------------- |
| Node | `https://pacific.oceanprotocol.com` |
| Secret Store | `https://secret-store.oceanprotocol.com` |
| Aquarius Test instance | `https://aquarius.test.oceanprotocol.com` |
| Brizo Test instance | `https://brizo.test.oceanprotocol.com` |
| Aquarius for Commons | `https://aquarius.commons.oceanprotocol.com` |
| Brizo for Commons | `https://brizo.commons.oceanprotocol.com` |
| Commons Marketplace | `https://commons.oceanprotocol.com` |
| Faucet Server | `https://faucet.oceanprotocol.com` |
| Token Bridge Frontend | `https://bridge.oceanprotocol.com` |
> Internal note: The private "atlantic" repo documents the internal details of the Pacific Network in `networks/pacific/deployment.md`.
## Using Barge with Pacific
If you run [Barge](https://github.com/oceanprotocol/barge) with the `--local-pacific-node` option, then Barge will run a Pacific node on your local machine (along with everything else Barge runs). There might be many blocks in the Pacific Network's blockchain, so it might take a long time for your local Pacific node to sync, i.e. to download a local copy of all the blocks. **In the meantime, the local Pacific node won't be able to do certain things.**
If you run [Barge](https://github.com/oceanprotocol/barge) with the `--local-pacific-node` option, then Barge will run a Pacific node on your local machine (along with everything else Barge runs).
There might be many blocks in the Pacific Network's blockchain, so it might take a long time for your local Pacific node to sync, i.e. to download a local copy of all the blocks. **In the meantime, the local Pacific node won't be able to do certain things.**

8
content/concepts/terminology.md
View File

@ -5,9 +5,11 @@ description: Terminology specific to Ocean Protocol.
## Ocean Network
Any EVM-compatible network where all[^1] the Ocean Protocol smart contracts ([keeper contracts](https://github.com/oceanprotocol/keeper-contracts)) are deployed. There can be many Ocean networks. Examples include the [testnets](/concepts/testnets/) and [the Pacific Network](/concepts/pacific-network/).
Any EVM-compatible network where all[^1] the Ocean Protocol smart contracts ([keeper contracts](https://github.com/oceanprotocol/keeper-contracts)) are deployed. There can be many Ocean networks and you can use the Ocean Protocol in several EVM-compatible networks, including:
Note: Some old documentation refers to "the Ocean Network" or "the Ocean Protocol Network." You will have to guess which network was meant, based on the context.
- the Ethereum Mainnet (also called the Main Ethereum Network)
- the Ocean [Pacific Network](/concepts/pacific-network/)
- various Ocean [test networks](/concepts/testnets/)
## Asset or Data Asset
@ -48,4 +50,4 @@ We published an [Ocean Protocol blog post that explains SEAs in more detail](htt
- See [the page about Ocean's Software Components](/concepts/components/).
- See [the page about wallets (and other Ethereum terminology)](/concepts/wallets/).
[^1]: The "Dispenser" smart contract should only be deployed to testnets.
[^1]: The _Dispenser_ smart contract should only be deployed to testnets.

42
content/concepts/testnets.md
View File

@ -3,27 +3,23 @@ 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. This page is a brief overview of those testnets. The [tutorials](/tutorials/) cover more details (e.g. how to connect to specific ones).
This page is a brief overview of available testnets. The [tutorials](/tutorials/) cover more details (e.g. how to connect to specific ones).
## A Spree Testnet (for Local Development)
_Formerly called Ocean Protocol Testnet v0.1, it was announced as part of the Plankton milestone._
By default, [Barge](https://github.com/oceanprotocol/barge) will deploy a local "Spree Testnet" on your machine: a local testnet not connected to any external public testnet.
By default, [Barge](https://github.com/oceanprotocol/barge) will deploy a local _Spree Testnet_[^1] on your machine: a local testnet not connected to any external public testnet.
When running a Spree Testnet, you can connect to a node at RPC URL [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask).
Spree Testnet details can be found in the [Barge README.md file](https://github.com/oceanprotocol/barge#spree-network). 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.
> Spree testnets are named after the Spree River, the main river flowing through Berlin, Germany, where many Ocean Protocol developers are located.
## The Nile Testnet
_Also known as the Nile Beta Network. Formerly called the Ocean POA Testnet._
In the _Nile Testnet_[^2] all nodes are operated by BigchainDB GmbH.
In the Nile Testnet all nodes are operated by BigchainDB GmbH.
For developers building on Ocean Protocol, we recommend starting with a [Spree Testnet](#a-spree-testnet-for-local-development).
> For developers building on Ocean Protocol, we recommend starting with a [Spree Testnet](#a-spree-testnet-for-local-development).
### Connect to the Nile Testnet
@ -42,29 +38,37 @@ There is a Nile blockchain explorer at [https://submarine.dev-ocean.com/](https:
There are several Ocean Protocol software components that are live, connected to the Nile Testnet, and operated by BigchainDB GmbH:
- Secret Store at [https://secret-store.nile.dev-ocean.com](https://secret-store.nile.dev-ocean.com)
- Aquarius at [https://aquarius.nile.dev-ocean.com/](https://aquarius.nile.dev-ocean.com/)
- Brizo at [https://brizo.nile.dev-ocean.com/](https://brizo.nile.dev-ocean.com/)
- Jupyter Hub at [https://mantaray.dev-ocean.com](https://mantaray.dev-ocean.com)
- Commons Marketplace at [https://commons.nile.dev-ocean.com](https://commons.nile.dev-ocean.com)
- Aquarius for Commons Marketplace at [https://aquarius.marketplace.dev-ocean.com](https://aquarius.marketplace.dev-ocean.com)
- Brizo for Commons Marketplace at [https://brizo.marketplace.dev-ocean.com](https://brizo.marketplace.dev-ocean.com)
- Faucet Server at [https://faucet.nile.dev-ocean.com](https://faucet.nile.dev-ocean.com)
| Component | URL |
| ---------------------- | ------------------------------------------------- |
| Node | `https://nile.dev-ocean.com` |
| Secret Store | `https://secret-store.nile.dev-ocean.com` |
| Aquarius Test instance | `https://aquarius.nile.dev-ocean.com` |
| Brizo Test instance | `https://brizo.nile.dev-ocean.com` |
| Aquarius for Commons | `https://aquarius.marketplace.nile.dev-ocean.com` |
| Brizo for Commons | `https://brizo.marketplace.nile.dev-ocean.com` |
| Commons Marketplace | `https://commons.nile.dev-ocean.com` |
| Jupyter Hub | `https://mantaray.dev-ocean.com` |
| Faucet Server | `https://faucet.nile.dev-ocean.com` |
> Internal note: The private "atlantic" repo documents the internal details of the Nile Testnet in `networks/nile/README.md`.
### Using Barge with Nile
If you run [Barge](https://github.com/oceanprotocol/barge) with the `--local-nile-node` option, then Barge will run a Nile node on your local machine (along with everything else Barge runs). There might be many blocks in the Nile Testnet's blockchain, so it might take a long time for your local Nile node to sync, i.e. to download a local copy of all the blocks. **In the meantime, the local Nile node won't be able to do certain things.**
If you run [Barge](https://github.com/oceanprotocol/barge) with the `--local-nile-node` option, then Barge will run a Nile node on your local machine (along with everything else Barge runs).
There might be many blocks in the Nile Testnet's blockchain, so it might take a long time for your local Nile node to sync, i.e. to download a local copy of all the blocks. **In the meantime, the local Nile node won't be able to do certain things.**
## A Ganache-Based Testnet (for Local Development)
A local testnet similar to Spree but launched by using the `--local-ganache-node` option with Barge.
Note: You shouldn't use a Ganache-Based Testnet unless you know why you're doing so. For example, a Ganache-based testnet can be used to test some smart contracts, but it can't be used with a Secret Store.
> You shouldn't use a Ganache-Based Testnet unless you know why you're doing so. For example, a Ganache-based testnet can be used to test some smart contracts, but it can't be used with a Secret Store.
## The Duero Testnet
The Duero Testnet is similar to the Nile Testnet, but it's only for internal use by the Ocean Protocol dev team. They test new things in the Duero Testnet before deploying them in the Nile Testnet (which is for use by anyone). That is, the testing order is Spree (local), Duero (private), Nile (public).
If you need to know something technical about the Duero Testnet, such as the RPC URL, please contact the Ocean Protocol dev team.
[^1]: Formerly called Ocean Protocol Testnet v0.1, it was announced as part of the Plankton milestone.
[^2]: Also known as the Nile Beta Network. Formerly called the Ocean POA Testnet.

20
content/tutorials/connect-to-networks.md
View File

@ -1,6 +1,6 @@
---
title: Connect to Ocean-Related Networks
description: How to connect to the Pacific network, Nile testnet and other Ocean-related networks.
description: Learn how to connect to the Pacific network, Nile testnet and other Ocean-related networks in your browser with MetaMask.
---
## Connect to the Pacific Network
@ -9,7 +9,7 @@ Here are the parameters you might need to connect to the [Pacific Network](/conc
| Parameter | Value |
| ------------------ | ---------------------------------------------------------- |
| RPC URL (required) | [https://pacific.oceanprotocol.com][rpc-url] |
| RPC URL (required) | `https://pacific.oceanprotocol.com` |
| ChainID | `846353` (decimal for MetaMask) or `0xcea11` (hexadecimal) |
| Symbol | Whatever you like, e.g. `PACIFIC ETH` |
| Nickname | Whatever you like, e.g. `Pacific` |
@ -18,18 +18,16 @@ In MetaMask, click on the network name then click on `Custom RPC` in the drop-do
If you're using [Barge](https://github.com/oceanprotocol/barge) to run a local Pacific node, you can connect to that local Pacific node at RPC URL [http://localhost:8545](http://localhost:8545) (called "Localhost 8545" in MetaMask). You can configure that local Pacific node by editing the files in the `barge/networks/pacific/config/` directory.
[rpc-url]: https://pacific.oceanprotocol.com
## 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, e.g. `NILE ETH` |
| Nickname | Whatever you like, e.g. `Nile Testnet` |
| Parameter | Value |
| ------------------ | ------------------------------------------------------- |
| RPC URL (required) | `https://nile.dev-ocean.com` |
| ChainID | `8995` (decimal for MetaMask) or `0x2323` (hexadecimal) |
| Symbol | Whatever you like, e.g. `NILE ETH` |
| Nickname | Whatever you like, e.g. `Nile 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).
@ -37,4 +35,4 @@ If you're using [Barge](https://github.com/oceanprotocol/barge) to run a local N
## 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).
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).

4
data/sidebars/concepts.yml
View File

@ -8,10 +8,10 @@
link: /concepts/components/
- title: Tools
link: /concepts/tools/
- title: Testnets
link: /concepts/testnets/
- title: Pacific Network
link: /concepts/pacific-network/
- title: Testnets
link: /concepts/testnets/
- title: Ocean Tokens
link: /concepts/ocean-tokens/
- title: Wallet Basics

1
gatsby-node.js
View File

@ -200,7 +200,6 @@ const createTypeDocPage = async (createPage, name, downloadUrl) => {
const typedocTemplate = path.resolve(
'./src/templates/Typedoc/index.jsx'
)
console.log(name)
const slug = `/references/${name}/`
createPage({

23
src/components/DocContent.module.scss
View File

@ -27,8 +27,11 @@
word-wrap: normal;
word-break: normal;
}
// stylelint-disable selector-no-qualifying-type, declaration-no-important
a > code {
color: $brand-pink !important;
}
// stylelint-disable selector-no-qualifying-type
:not(pre) > code,
:not(pre) > code[class*='language-'] {
background: darken($brand-white, 5%);
@ -37,7 +40,7 @@
padding-left: .3rem;
padding-right: .3rem;
}
// stylelint-enable selector-no-qualifying-type
// stylelint-enable selector-no-qualifying-type, declaration-no-important
pre {
display: block;
@ -66,3 +69,19 @@
font-style: italic;
margin-bottom: $spacer * 2;
}
:global(.footnotes) {
font-size: $font-size-small;
p {
margin: 0;
}
}
:global(.footnote-ref) {
font-size: $font-size-mini;
font-weight: $font-weight-bold;
padding-left: .2rem;
padding-right: .2rem;
display: inline-block;
}