From 83d7de21cd98553aeaf16893eb2c57fa17578c65 Mon Sep 17 00:00:00 2001 From: trentmc <5305452+trentmc@users.noreply.github.com> Date: Fri, 16 Oct 2020 16:55:53 +0200 Subject: [PATCH] rework so that three types of networs: local, test, main. Did not rename webpages themselves --- content/concepts/ocean-tokens.md | 98 +---------------------------- content/concepts/pacific-network.md | 66 +++---------------- content/concepts/testnets.md | 73 +++------------------ content/concepts/tools.md | 65 ++----------------- data/sidebars/concepts.yml | 8 +-- 5 files changed, 29 insertions(+), 281 deletions(-) diff --git a/content/concepts/ocean-tokens.md b/content/concepts/ocean-tokens.md index 30e8a037..23f32aa3 100644 --- a/content/concepts/ocean-tokens.md +++ b/content/concepts/ocean-tokens.md @@ -1,102 +1,8 @@ --- title: Ocean Tokens -description: The technical basics and most important infos about Ocean Tokens in different networks. +description: Information about OCEAN --- -## Basics +Please go to https://oceanprotocol.com/token. -**Ocean Tokens** are the [cryptocurrency](https://en.wikipedia.org/wiki/Cryptocurrency) associated with Ocean Protocol. They are standards-compliant [ERC-20 tokens](https://en.wikipedia.org/wiki/ERC-20). -Ocean Tokens can, in principle, live in any EVM-compatible network. The Ocean Token contract is deployed in the Ethereum Mainnet, Pacific Mainnet, and the Nile Testnet. - -Only OCEAN within the Ethereum Mainnet carry any value, reflected [on our token page](https://oceanprotocol.com/token). - -| Property | Value | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Token Contract Addresses | _Ethereum Mainnet_
[`0x967da4048cD07aB37855c090aAF366e4ce1b9F48`](https://etherscan.io/token/0x967da4048cD07aB37855c090aAF366e4ce1b9F48)

_Pacific Mainnet_
[`0x012578f9381e876A9E2a9111Dfd436FF91A451ae`](https://submarine.oceanprotocol.com/address/0x012578f9381e876a9e2a9111dfd436ff91a451ae/transactions)

_Nile Testnet_
[`0x9861Da395d7da984D5E8C712c2EDE44b41F777Ad`](https://submarine.nile.dev-ocean.com/address/0x9861Da395d7da984D5E8C712c2EDE44b41F777Ad) | -| Token Symbol | OCEAN | -| Decimals of Precision | 18 | - -## Ethereum Mainnet Ocean Tokens - -There were several ways to acquire some of the Ethereum Mainnet Ocean Tokens in the initial circulating supply, including: - -- participation in the seed round -- participation in the pre-sale -- participation in the token sale -- participation in the initial exchange offering (IEO) -- completion of a [bounty](/concepts/bounties/) - -After [the initial exchange offering on Bittrex International](https://blog.oceanprotocol.com/initial-exchange-offering-of-ocean-protocol-on-bittrex-international-a454688f466a), Ethereum Mainnet Ocean Tokens became available in the Ethereum Mainnet (and not in any other network). - -The initial circulating supply of Ethereum Mainnet Ocean Tokens became available on the Ethereum Mainnet in May 2019. If you acquired Ocean Tokens in the initial circulating supply, they should have been, or will be, sent to the address you provided, in the Ethereum Mainnet. - -At the time of writing, you could use Ethereum Mainnet Ocean Tokens to do various things in the Ethereum Mainnet, including but not limited to: - -- buy other cryptocurrencies -- provide liquidity in decentralized exchanges like Uniswap or Balancer - -### Check Your Ethereum Mainnet Ocean Token Balance - -There are many ways to check your Ethereum Mainnet Ocean Token balance. Starting with the easiest, here are some ways: - -#### Ocean Token Tool - -Enter your account address into the form on the [Ocean Token page on our website](https://oceanprotocol.com/token#balance). - -[![Ocean Token Tool](images/token-tool.png)](https://oceanprotocol.com/token#balance) - -#### Blowfish - -Download and use [Blowfish](https://github.com/kremalicious/blowfish), a desktop app that tells you your Ocean Token balance (and other things). - -[![Blowfish](images/blowfish.png)](https://github.com/kremalicious/blowfish) - -#### MetaMask - -Use MetaMask or other ERC-20-compatible wallet software. See the page about [using wallet software to manage Ocean Tokens](/tutorials/wallets-and-ocean-tokens/). You can also use wallet software to send Ocean Tokens to some other account. - -#### Etherscan - -Go to [Etherscan](https://etherscan.io/), enter your account address into the search field, click **Search**, click on **Erc20 Token Txns**, look for an _OceanToken_ transaction in the _Token_ colum, and click on **OceanToken** there. - -### Buy or Sell Ethereum Mainnet Ocean Tokens - -You can buy or sell Ethereum Mainnet Ocean Tokens (OCEAN) via any exchange that lists them. An always up-to-date _official list_ of exchanges can be found on the [Ocean Token page on our website](https://oceanprotocol.com/token#balance). - -## Pacific Network Ocean Tokens - -Ocean Tokens in Ocean's Mainnet, [Pacific](/concepts/pacific-network/), represent the same value as in the Ethereum Mainnet. The only way to get Ocean Tokens in Pacific is to transfer them from the Ethereum Mainnet. - -## Testnet Ocean Tokens - -There are Ocean Tokens in several testnets, including the Nile testnet. They are just testnet Ocean Tokens (i.e. for testing purposes only) and they aren't interchangeable with Ethereum Mainnet Ocean Tokens. For more details, see the the [page about Testnets](/concepts/testnets/) and the [tutorials](/tutorials/introduction/). - -Once you have some Testnet Ocean Tokens, you can use them for all currently-implemented Ocean Protocol tasks _in that testnet_ (e.g. buying assets). - -### Get Testnet Ocean Tokens - -All Squid libraries have methods to request Ocean Tokens. They work by calling the _Dispenser_ keeper contract, a contract which is only deployed to testnets. Therefore they will only work in testnets. - -They're documented in the following places: - -- The squid-js docs for: - - [`OceanAccounts.requestTokens()`](/references/squid-js/#OceanAccounts-requestTokens) - - [`Account.requestTokens()`](/references/squid-js/#Account-requestTokens) -- The squid-py docs for: - - [the `squid_py.ocean.ocean_tokens` module](https://squid-py.readthedocs.io/en/develop/api/squid_py.ocean.ocean_tokens.html): see the `request()` method. - - [the `squid_py.ocean.ocean_accounts` module](https://squid-py.readthedocs.io/en/develop/api/squid_py.ocean.ocean_accounts.html): see the `request_tokens()` method. -- [The squid-java docs](https://www.javadoc.io/doc/com.oceanprotocol/squid/): click _All Classes_ then _AccountsManager_ then scroll to the bottom of the Class _AccountsManager_ page where you'll find the `requestTokens()` method. - -The [Example Code page](/tutorials/example-code/) has links to example Squid code (in all of the languages), including examples of using the above methods. - -## Further Reading about Ocean Tokens - -- [Ocean Token page](https://oceanprotocol.com/token) -- [Tutorial: Use Your Wallet to Manage Ocean Tokens](/tutorials/wallets-and-ocean-tokens/) -- [Blog: Ocean Tokenomics](https://blog.oceanprotocol.com/ocean-tokenomics-d34f28c480a8) -- [Blog: Ocean Tokenomics II](https://blog.oceanprotocol.com/https-blog-oceanprotocol-com-ocean-tokenomics-ii-faf05854314b) -- [Ocean Protocol Technical Whitepaper](https://oceanprotocol.com/tech-whitepaper.pdf) -- [Blog: What Happened with the IEO?](https://blog.oceanprotocol.com/what-happened-with-the-ieo-54cc5c6c3db9) -- [Blog: Ocean Protocol — Token Sale](https://blog.oceanprotocol.com/ocean-protocol-token-sale-96d03f968e22) -- [Blog: Ocean Protocol Pre-Launch is Target Reached](https://blog.oceanprotocol.com/ocean-protocol-pre-launch-is-target-reached-d10e53272a2e) diff --git a/content/concepts/pacific-network.md b/content/concepts/pacific-network.md index a2198389..f61b8d18 100644 --- a/content/concepts/pacific-network.md +++ b/content/concepts/pacific-network.md @@ -1,62 +1,12 @@ --- -title: The Pacific Network -description: An introduction to Ocean Protocol's main network, named Pacific. +title: Network - Ethereum Mainnet +description: Tools for development on Ethereum Mainnet --- -## Overview +| Component | URL | +| ---------------------- | ------------------------------------------ | +| Etherscan explorer | https://etherscan.io/ | +| Ocean Market main | https://oceanmarket.io | +| Ocean Market - Provider | https://FIXME | +| Ocean Market - Aquarius | https://FIXME | -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. - -We expect vulnerabilities to be discovered and will conduct security audits over time, but the Ocean Protocol smart contracts will be in the wild for all intents and purposes. -Over time, the Pacific Network will be upgraded and improved. -There is no intent to shut it down. -Eventually, the goal is for it to be used in production by many projects. - -[^1]: The Pacific Network is (or was) also known by other names, including _Pacific_, _Main Ocean Network_, _Ocean Mainnet_, _Ocean Live Network_. - -## Ocean Tokens in Pacific - -To be able to use [Ocean Tokens](/concepts/ocean-tokens/) in Pacific, they need to be transferred from the Ethereum Mainnet with a token bridge. - -For more information, see [Pacific Network Ocean Tokens](/concepts/ocean-tokens/#pacific-network-ocean-tokens). - -## Connect to the Pacific Network - -To connect to Pacific in your browser with MetaMask, see [Tutorial: Connect to the Pacific Network](/tutorials/connect-to-networks/#connect-to-the-pacific-network). - -## Pacific Blockchain Explorers - -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 | -| -------------------- | ---------------- | -| Pacific Ether | POA | -| Pacific Ocean Tokens | OCEAN or SBT-OCN | - -## Ocean Components Connected to Pacific - -There are several Ocean Protocol software components that are live, connected to the Pacific Network, and operated by BigchainDB GmbH: - -| 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.** diff --git a/content/concepts/testnets.md b/content/concepts/testnets.md index f36ccf2f..5c5cb286 100644 --- a/content/concepts/testnets.md +++ b/content/concepts/testnets.md @@ -1,68 +1,13 @@ --- -title: Testnets -description: An overview of public test networks that you can test Ocean Protocol applications against. +title: Network - Ropsten Testnet +description: Tools for development on Ethereum Ropsten testnet --- -This page is a brief overview of available testnets. The [tutorials](/tutorials/) cover more details (e.g. how to connect to specific ones). +| Component | URL | +| ---------------------- | ------------------------------------------ | +| Etherscan explorer | https://ropsten.etherscan.io/ | +| Ocean Market on Ropsten | https://FIXME +| Ocean Market - Provider | https://FIXME +| Ocean Market - Aquarius | https://FIXME +| OCEAN Faucet Server | https://FIXME | -## A Spree Testnet (for Local Development) - -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. - -> 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 - -In the _Nile Testnet_[^2] 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). - -### Connect to the Nile Testnet - -See [Tutorial: Connect to the Nile Testnet](/tutorials/connect-to-networks/#connect-to-the-nile-testnet). - -### Nile Blockchain Explorers - -There is a Nile blockchain explorer at [https://submarine.nile.dev-ocean.com/](https://submarine.nile.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: - -| Cryptocurrency | Symbol used | -| ----------------- | ---------------- | -| Nile Ether | POA | -| Nile Ocean Tokens | OCEAN or SBT-OCN | - -### 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: - -| 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.dev-ocean.com` | -| Brizo for Commons | `https://brizo.marketplace.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.** - -## A Ganache-Based Testnet (for Local Development) - -A local testnet similar to Spree but launched by using the `--local-ganache-node` option with Barge. - -> 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. - -[^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. diff --git a/content/concepts/tools.md b/content/concepts/tools.md index bf9572b4..edc5f431 100644 --- a/content/concepts/tools.md +++ b/content/concepts/tools.md @@ -1,67 +1,14 @@ --- -title: Tools -description: Some tools that can be useful when working with Ocean Protocol. +title: Local Development +description: Tools for local deployment --- -## Barge +Barge is a tool to help for fast iterations in a local development. -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. +It's a shell script that 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. You'll also find it in the [Quickstart](/setup/quickstart/). -## Tuna -Tuna is a showcase and provides cross environment examples & tests for the Squid client libraries. - - - -## Plecos - -Plecos is a Python tool to check metadata (a JSON file) to see if it conforms to the [OEP-8 schema](https://github.com/oceanprotocol/OEPs/tree/master/8). It wraps the [jsonschema](https://github.com/Julian/jsonschema) validator. Aquarius uses Plecos for checking metadata and other Ocean Protocol software will probably use it in the future. - - - -## 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](/tutorials/get-ether-and-ocean-tokens/#get-ether), and started by default when using [Barge](#barge). - - - -## 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. 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/)** - - - -## Ocean Network Status - -The Ocean status page checks all Ocean network connections from your browser. - -- [**Ocean Network Status**](https://status.oceanprotocol.com) - - - -## Command-Line Interfaces - -There are a few Ocean Protocol command-line interfaces (CLIs). All of them were under development at the time of writing, so you may have issues with using them. - -- [ocean-cli](https://github.com/bigchaindb-gmbh/ocean-cli) was built using squid-java -- [ocean-cli-py](https://github.com/bigchaindb-gmbh/ocean-cli-py) was built using squid-py - -## IPFS - -The IPFS protocol is integrated into the Ocean Protocol stack in various places. For this, we run and maintain our own IPFS node and gateway with a custom frontpage for simple adding of files to that IPFS node. - -- [**Ocean Protocol 💖 IPFS**](https://ipfs.oceanprotocol.com) - - - -To learn more about how IPFS is used, have a look at OEP-15 and the respective blog post: - -- [OEP-15: Distributed Asset File Storage with IPFS](https://github.com/oceanprotocol/OEPs/tree/master/15) -- [Ocean Protocol and IPFS, Sitting In The Merkle Tree](https://blog.oceanprotocol.com/ocean-ipfs-integration-store-asset-files-43c623c356d7) diff --git a/data/sidebars/concepts.yml b/data/sidebars/concepts.yml index e9afa60f..2e5f16f4 100644 --- a/data/sidebars/concepts.yml +++ b/data/sidebars/concepts.yml @@ -6,12 +6,12 @@ link: /concepts/terminology/ - title: Software Components link: /concepts/components/ - - title: Tools + - title: Network - Local link: /concepts/tools/ - - title: Pacific Network - link: /concepts/pacific-network/ - - title: Testnets + - title: Network - Ropsten Testnet link: /concepts/testnets/ + - title: Network - Ethereum Mainnet + link: /concepts/pacific-network/ - title: Ocean Tokens link: /concepts/ocean-tokens/ - title: Wallet Basics