diff --git a/.gitbook.yaml b/.gitbook.yaml index 6f4cb6b7..be299974 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -17,6 +17,10 @@ redirects: tutorials/wallets-and-ocean-tokens: discover/wallets-and-ocean.md discover/explore: discover/README.md discover/ocean-101: discover/README.md + discover/basic-concepts: user-guides/basic-concepts.md + discover/wallets/README: user-guides/wallets/README.md + discover/wallets/metamask-setup: user-guides/wallets/metamask-setup.md + discover/wallets-and-ocean: user-guides/wallets-and-ocean.md using-ocean-market: user-guides/using-ocean-market.md using-ocean-market/marketplace-publish-data-asset: user-guides/publish-data-nfts.md using-ocean-market/marketplace-download-data-asset: user-guides/buy-data-nfts.md diff --git a/.gitbook/assets/general/purchase-and-compute_and_ocean-network.png b/.gitbook/assets/general/purchase-and-compute_and_ocean-network.png new file mode 100644 index 00000000..2cc13fd5 Binary files /dev/null and b/.gitbook/assets/general/purchase-and-compute_and_ocean-network.png differ diff --git a/.gitbook/assets/general/whirlpool.png b/.gitbook/assets/general/whirlpool.png new file mode 100644 index 00000000..c3b1422b Binary files /dev/null and b/.gitbook/assets/general/whirlpool.png differ diff --git a/SUMMARY.md b/SUMMARY.md index e56bc916..b7c6d552 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -5,15 +5,16 @@ - [Why Ocean?](discover/why-ocean.md) - [What is Ocean?](discover/what-is-ocean.md) - [What can you do with Ocean?](discover/benefits.md) -- [📚 User Guides](user-guides/README.md) - - [Basic Concepts](discover/basic-concepts.md) - - [Wallets](discover/wallets/README.md) - - [Set Up MetaMask Wallet](discover/wallets/metamask-setup.md) - - [Manage Your OCEAN](discover/wallets-and-ocean.md) + - [OCEAN: The Ocean token](discover/ocean-token.md) - [Networks](discover/networks/README.md) - [Bridges](discover/networks/bridges.md) - - [Glossary](discover/glossary.md) - [FAQ](discover/faq.md) + - [Glossary](discover/glossary.md) +- [📚 User Guides](user-guides/README.md) + - [Basic Concepts](user-guides/basic-concepts.md) + - [Wallets](user-guides/wallets/README.md) + - [Set Up MetaMask Wallet](user-guides/wallets/metamask-setup.md) + - [Manage Your OCEAN](user-guides/wallets-and-ocean.md) - [Guide to the Ocean Market](user-guides/using-ocean-market.md) - [Publish Data NFTs](user-guides/publish-data-nfts.md) - [Buy NFT Data](user-guides/buy-data-nfts.md) @@ -112,8 +113,8 @@ * [👀 Predictoor](predictoor/README.md) * [Introduction](predictoor/pdr-intro.md) * [Architecture](predictoor/pdr-architecture.md) - * [Parameters](predictoor/pdr-parameters.md) - * [How to Earn](predictoor/pdr-earn.md) + * [How to Earn](predictoor/pdr-earn.md) + * [Parameters](predictoor/pdr-parameters.md) * [Pdr FAQ](predictoor/pdr-faq.md) * [Pdr Resources](predictoor/pdr-resources.md) * [💰 Data Farming](data-farming/README.md) diff --git a/discover/README.md b/discover/README.md index 56488c27..05aeffb5 100644 --- a/discover/README.md +++ b/discover/README.md @@ -14,11 +14,20 @@ Ocean is a decentralized data exchange protocol. Its core tech is: - Data NFTs & datatokens, to enable token-gated access control, data wallets, data DAOs, and more. - Compute-to-data: buy & sell private data, while preserving privacy -**Ocean users are:** +### Ocean Users Are... + - **[Developers](../developers/README.md).** Build token-gated AI dApps & APIs - **[Data scientists](../data-scientists/README.md).** Earn via predictions & challenges - **[OCEAN holders](../data-farming/README.md).** Get rewards by locking OCEAN & curating data, via Data Farming. -- **[Ocean ambassadors](https://oceanprotocol.com/explore/community)** +- **[Ocean ambassadors](https://oceanprotocol.com/explore/community)** + +### Quick Links + +- [Why Ocean?](why-ocean.md) and [What is Ocean?](what-is-ocean.md) +- [What can you do with Ocean?](benefits.md) +- [OCEAN: The Ocean token](ocean-token.md) +- [Networks](networks/README.md), [Bridges](networks/bridges.md) +- [FAQ](faq.md), [Glossary](glossary.md) ---- diff --git a/discover/benefits.md b/discover/benefits.md index f66d2985..c0d7fd7d 100644 --- a/discover/benefits.md +++ b/discover/benefits.md @@ -112,8 +112,6 @@ To become a member of the Ambassador Program, follow these steps: ---- -Congrats! You've completed this quick introduction to Ocean. - -_Next: If you're a blockchain newcomer, go to [User Guides](../user-guides/README.md). Otherwise jump to [Docs main](../README.md) and click on your interest._ +_Next: [OCEAN: The Ocean token](ocean-token.md)_ _Back: [What is Ocean?](what-is-ocean.md)_ diff --git a/discover/faq.md b/discover/faq.md index 8ac49b4c..e22a4701 100644 --- a/discover/faq.md +++ b/discover/faq.md @@ -209,3 +209,11 @@ Fees are generated Ocean Market from Ocean Market that head to Ocean community. For collaborations, please fill in this [form](https://docs.google.com/forms/d/e/1FAIpQLSdBz7cblsz5yuOKMVoPVfK0Pp1Xuqjwner1kCkRibIIbYMe-w/viewform). One member of our team will reach out to you 🤝 + + +---- + +_Next: [Glossary](glossary.md)_ + +_Back: [Bridges](networks/bridges.md)_ + diff --git a/discover/glossary.md b/discover/glossary.md index 2b460c4d..059f20f0 100644 --- a/discover/glossary.md +++ b/discover/glossary.md @@ -1,7 +1,6 @@ --- description: >- - A comprehensive list of key terms, concepts, and acronyms used in the Ocean - Protocol ecosystem + Key terms, concepts, and acronyms used in Ocean --- # Glossary @@ -11,7 +10,6 @@ description: >-
Ocean Protocol - Ocean Protocol is a decentralized data exchange protocol that enables individuals and organizations to share, sell, and consume data in a secure, transparent, and privacy-preserving manner. The protocol is designed to address the current challenges in data sharing, such as data silos, lack of interoperability, and data privacy concerns. Ocean Protocol uses blockchain technology, smart contracts, and cryptographic techniques to create a network where data providers can offer their data assets for sale, data consumers can purchase and access the data, and developers can build data-driven applications and services on top of the protocol.
@@ -28,7 +26,7 @@ The Ocean Protocol's token (OCEAN) is a utility token used in the Ocean Protocol Data Consume Volume (DCV) -The data consume value (DCV) is a key metric that refers to the amount of $ spent to buy data assets where the data assets are subsequently consumed. +The data consume value (DCV) is a key metric that refers to the amount of $ spent over a time period, to buy data assets where the data assets are subsequently consumed. @@ -36,49 +34,7 @@ The data consume value (DCV) is a key metric that refers to the amount of $ spen Transaction Volume (TV) -The transaction value is a key metric that refers to the value of transactions within the ecosystem. - -Transaction volume(TV) is often used interchangeably with data consume volume (DCV). DCV is a more refined metric that excludes activities like wash trading. DCV measures the actual consumption or processing of data within the protocol, which is a more accurate measure of the value generated by the ecosystem. - - - -
- -Base IP - -**Base IP** means the artifact being copyrighted. Represented by the {ERC721 address, tokenId} from the publish transactions. - -
- -
- -Base IP holder - -**Base IP holder** means the holder of the Base IP. Represented as the actor that did the initial "publish" action. - -
- -
- -Sub-licensee - -**Sub-licensee** is the holder of the sub-license. Represented as the entity that controls address ERC721.\_owners\[tokenId=x]. - -
- -
- -To Publish - -Claim copyright or exclusive base license. - -
- -
- -To Sub-license - -Transfer one (of many) sub-licenses to new licensee: ERC20.transfer(to=licensee, value=1.0). +The transaction value is a key metric that refers to the number of blockchain transactions done over a time period.
@@ -151,47 +107,47 @@ When a user allocates veOCEAN to Ocean Market projects, then weekly OCEAN reward +### Intellectual Property (IP) Concepts +
-Challenge DF +Base IP -When users submit accurate predictions for the price of Ethereum to the [Challenge DF program](https://df.oceandao.org/challenge-df), they have a chance to win OCEAN rewards by being in the top 3 submissions based on predicted value accuracy. - -These rewards are classified as [Challenge DF](../data-farming/README.md) rewards since they require active participation in the challenge. Rewards can be claimed every Thursday on the [Rewards page](https://df.oceandao.org/rewards). +**Base IP** means the artifact being copyrighted. Represented by the {ERC721 address, tokenId} from the publish transactions.
-H2O +Base IP holder -[H2O](https://www.h2odata.xyz/) is a decentralized protocol that introduced the first non-pegged stable asset, $H2O. Initially, it is backed by OCEAN but there are plans to be backed by other data tokens. - -The H2O non-pegged stable asset is a friendly fork of RAI. Whereas RAI uses ether (ETH) as its asset for collateral, H2O uses OCEAN. The price of H2O is managed by an algorithm that rebalances to bring the redemption price close to the market price and participants are incentivized to aid in this process. Traditional stable assets are pegged to a price such as 1 USD. In contrast, RAI (and soon H2O) are free-floating but typically settle around a price; for RAI this has been \~$3. +**Base IP holder** means the holder of the Base IP. Represented as the actor that did the initial "publish" action.
-$POSEIDON +Sub-licensee -The [POSEIDON token](https://docs.h2odata.xyz/protocol-overview/poseidon-mechanics) is the governance token of the H2O protocol. With the following function inside the protocol: - -* Ungovernance: once governance minimization is finalized, POSEIDON holders will be able to remove control from any remaining components in H2O or, if needed, continue to manage components that may be challenging to ungovern (such as oracles or any other component interacting with other protocols). +**Sub-licensee** is the holder of the sub-license. Represented as the entity that controls address ERC721.\_owners\[tokenId=x].
-$psdnOcean +To Publish -[psdnOCEAN](https://docs.h2odata.xyz/protocol-overview/psdnocean-veocean-liquid-staking) is the liquid staking wrapper for veOCEAN. - -* Convert OCEAN to psdnOCEAN with a 1:1 ratio. -* Gain access to a liquid asset and receive a share of the revenue of veOCEAN. +Claim copyright or exclusive base license.
+
+ +To Sub-license + +Transfer one (of many) sub-licenses to new licensee: ERC20.transfer(to=licensee, value=1.0). + +
### Web3 Fundamentals @@ -465,4 +421,14 @@ Machine learning is a subfield of artificial intelligence (AI) that involves tea +---- + + +Congrats! You've completed this quick introduction to Ocean. + +_Next: Jump to [Docs main](../README.md) and click on your interest._ + +_Back: [FAQ](faq.md)_ + + diff --git a/discover/networks/README.md b/discover/networks/README.md index 4dc586b8..be176027 100644 --- a/discover/networks/README.md +++ b/discover/networks/README.md @@ -1,13 +1,39 @@ --- -title: Supported Networks +title: description: All the public networks the Ocean Protocol contracts are deployed to. --- # Networks -Ocean Protocol contracts are deployed on multiple public networks. You can always find the most up-to-date deployment addresses for all individual contracts in the [address.json](https://github.com/oceanprotocol/contracts/blob/v4main/addresses/address.json). +Ocean Protocol's smart contracts and OCEAN are deployed on multiple public networks: several production chains, and several testnets too. -In each network, whether it's the Ethereum mainnet, a testnet, or the Polygon/Matic network, you'll need ETH or Matic to pay for gas and OCEAN for certain actions on the Ocean Protocol network. The Ethereum mainnet and the Polygon network are both live networks and the tokens on these networks have real value. However, the tokens on the test networks are not of real value and are only used for testing purposes. You can obtain testnet ETH and OCEAN from faucets, which are services that provide small amounts of tokens for free. +[address.json](https://github.com/oceanprotocol/contracts/blob/v4main/addresses/address.json) holds up-to-date deployment addresses for all Ocean contracts. + +You need the network's native token to pay for gas to make transactions: ETH for Ethereum mainnet, MATIC for Polygon, etc; you typically get these from exchanges. You also need "fake" native tokens for testnets; you typically get these from faucets. + +## Networks Summary + +Here are the networks that Ocean is deployed to. + +**Production Networks:** +- [Ethereum mainnet](#ethereum-mainnet) +- [Polygon mainnet](#polygon-mainnet) +- [Oasis Sapphire mainnet](#oasis-sapphire-mainnet) +- [BNB Smart Chain](#bnb-smart-chain) +- [Energy Web Chain](#energy-web-chain) +- [Optimism Mainnet](#optimism-mainnet) +- [Moonriver](#moonriver) + +**Test Networks:** +- [Görli](#görli) +- [Sepolia](#sepolia) +- [Mumbai](#mumbai) +- [Oasis Sapphire testnet](#oasis-sapphire-testnet) +- [Optimism Sepolia](#optimism-sepolia) + +The rest of this doc gives details for each network. You can skip it until you need the reference information. + +## Production Networks ### Ethereum Mainnet @@ -35,18 +61,6 @@ Ocean Protocol is also deployed to Oasis Sapphire Mainnet, which is a production Check out our Celer Bridge [guide](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/get-ocean-on-sapphire.md#2-transfer-ocean-to-sapphire-mainnet-via-celer) to learn how you can bridge your OCEAN tokens from Ethereum Mainnet to Oasis Sapphire Mainnet. -### Oasis Sapphire Testnet - -Ocean Protocol is also deployed to Oasis Sapphire Testnet, which is a test network that Ocean Protocol uses for [Predictoor](https://predictoor.ai). Ocean Protocol does do not currently support ocean.js, ocean.py, or Ocean Market on Oasis Sapphire. The native token of Oasis Sapphire is ROSE. If you cannot find Oasis Sapphire Testnet as a predefined network in your wallet, you can manually connect to it by entering the following information during the import process: Network Name: `Oasis Sapphire Testnet`, RPC URL: `https://testnet.sapphire.oasis.dev`, Chain ID: `23295`, Token: `ROSE`. - -
Gas TokenROSE(Native token)
OCEAN0x973e69303259B0c2543a38665122b773D28405fB
Explorerhttps://explorer.oasis.io/testnet/sapphire/
- -**Get (fake) OCEAN on Sapphire Testnet** - -Check out our [guide](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/testnet-faucet.md#get-fake-ocean-on-sapphire-testnet) for how to get fake OCEAN tokens on Sapphire Testnet. - -Check out our [guide](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/testnet-faucet.md#get-fake-rose-on-sapphire-testnet) for how to get fake ROSE tokens on Oasis Sapphire Testnet. - ### BNB Smart Chain Ocean Protocol is also deployed to BNB Smart Chain, which is another production network. The native token of the BNB Smart Chain is BNB, which is the token of the Binance exchange. If BNB Smart Chain is not listed as a predefined network in your wallet, you can manually connect to it by following Binance's [guide](https://academy.binance.com/en/articles/connecting-metamask-to-binance-smart-chain), which provides detailed instructions on how to connect to BNB Smart Chain. @@ -67,7 +81,7 @@ Ocean Protocol is also deployed to [Energy Web Chain](https://energy-web-foundat To bridge assets between Energy Web Chain and Ethereum mainnet, you can use [this](https://bridge.carbonswap.exchange/) bridge. -### OP Mainnet(Optimism) +### Optimism Mainnet Ocean Protocol is also deployed to OP Mainnet (Optimism), which is another production network. The native token of Optimism is ETH, which needs to be bridged from Ethereum Mainnet. If you cannot find Optimism as a predefined network in your wallet, you can manually connect to it by following OP's [guide](https://community.optimism.io/docs/useful-tools/networks/#op-mainnet), which provides step-by-step instructions for connecting to OP Mainnet. @@ -87,12 +101,22 @@ Ocean Protocol is also deployed to [Moonriver](https://docs.moonbeam.network/bui To bridge assets between Moonriver and Ethereum mainnet, you can use [this](https://anyswap.exchange/#/bridge) bridge. + +## Test Networks + + ### Görli Ocean Protocol is deployed on the Görli test network, which is used for testing and experimentation. Tokens on Görli do not hold real economic value, as it is a non-production network. To connect to Görli using a wallet like MetaMask, simply click on the network name dropdown and select _Goerli_ from the list of available networks.
Gas TokenGörli ETH(Native token)
Görli ETHFaucet. You may find others by searching.
Görli OCEANFaucet
OCEAN0xCfDdA22C9837aE76E0faA845354f33C62E03653a
Explorerhttps://blockscout.moonriver.moonbeam.network
+### Sepolia + +Ocean Protocol is deployed on the Sepolia test network, which is designed for testing and experimentation purposes. Tokens in Sepolia do not hold any real economic value, as it is not a production network. To connect to Sepolia using a wallet like MetaMask, you can select "Sepolia" from the network dropdown list(enable "Show test networks"). + +
Gas TokenSepoliaETH (Native token)
SepoliaETHFaucet
Sepolia OCEANFaucet
OCEAN0x1B083D8584dd3e6Ff37d04a6e7e82b5F622f3985
Explorerhttps://sepolia.etherscan.io/
+ ### Mumbai Ocean Protocol is deployed on the Mumbai test network Matic / Polygon, which is designed for testing and experimentation purposes. Tokens in Mumbai do not hold any real economic value, as it is not a production network. To connect to Mumbai using a wallet like MetaMask, you can select "Görli" from the network dropdown list. @@ -101,14 +125,20 @@ If Mumbai is not listed as a predefined network in your wallet, you can connect
Mumbai MATIC(Native token)
Mumbai MATICFaucet. You may find others by searching.
Mumbai OCEANFaucet
OCEAN0xd8992Ed72C445c35Cb4A2be468568Ed1079357c8
Explorerhttps://mumbai.polygonscan.com
-### Sepolia +### Oasis Sapphire Testnet -Ocean Protocol is deployed on the Sepolia test network, which is designed for testing and experimentation purposes. Tokens in Sepolia do not hold any real economic value, as it is not a production network. To connect to Sepolia using a wallet like MetaMask, you can select "Sepolia" from the network dropdown list(enable "Show test networks"). +Ocean Protocol is also deployed to Oasis Sapphire Testnet, which is a test network that Ocean Protocol uses for [Predictoor](https://predictoor.ai). Ocean Protocol does do not currently support ocean.js, ocean.py, or Ocean Market on Oasis Sapphire. The native token of Oasis Sapphire is ROSE. If you cannot find Oasis Sapphire Testnet as a predefined network in your wallet, you can manually connect to it by entering the following information during the import process: Network Name: `Oasis Sapphire Testnet`, RPC URL: `https://testnet.sapphire.oasis.dev`, Chain ID: `23295`, Token: `ROSE`. -
Gas TokenSepoliaETH (Native token)
SepoliaETHFaucet
Sepolia OCEANFaucet
OCEAN0x1B083D8584dd3e6Ff37d04a6e7e82b5F622f3985
Explorerhttps://sepolia.etherscan.io/
+
Gas TokenROSE(Native token)
OCEAN0x973e69303259B0c2543a38665122b773D28405fB
Explorerhttps://explorer.oasis.io/testnet/sapphire/
+ +**Get (fake) OCEAN on Sapphire Testnet** + +Check out our [guide](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/testnet-faucet.md#get-fake-ocean-on-sapphire-testnet) for how to get fake OCEAN tokens on Sapphire Testnet. + +Check out our [guide](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/testnet-faucet.md#get-fake-rose-on-sapphire-testnet) for how to get fake ROSE tokens on Oasis Sapphire Testnet. -### OP Sepolia(Optimism) +### Optimism Sepolia Ocean Protocol is deployed on the OP Sepolia test network, which is designed for testing and experimentation purposes. Tokens in Sepolia do not hold any real economic value, as it is not a production network. If OP Sepolia is not listed as a predefined network in your wallet, you can manually connect to it by following OP's [guide](https://community.optimism.io/docs/useful-tools/networks/#op-sepolia), which provides detailed instructions on how to connect to OP Seploia. @@ -117,3 +147,11 @@ Ocean Protocol is deployed on the OP Sepolia test network, which is designed for **Bridge** Check out the OP Bridge [guide](https://https://app.optimism.io/bridge/deposit) to deposit, withdraw and send tokens. + + +---- + +_Next: [Bridges](bridges.md)_ + +_Back: [OCEAN: the Ocean token](../ocean-token.md)_ + diff --git a/discover/networks/bridges.md b/discover/networks/bridges.md index 0afb6a47..392c7c94 100644 --- a/discover/networks/bridges.md +++ b/discover/networks/bridges.md @@ -7,7 +7,13 @@ description: Transfer tokens between two blockchain networks. A bridge is a mechanism that connects two or more separate blockchain networks, enabling communication and interoperability between them. Bridges can be designed to facilitate the transfer of assets, data, or messages between different blockchain networks that may operate on different protocols, and consensus mechanisms, or have different native currencies. -We suggest using the following solutions to transfer OCEAN between Ethereum mainnet and Polygon or BSC. +This page covers: +- [Celer Bridge](#celer-bridge) - bridge OCEAN from Eth mainnet <> Oasis Sapphire mainnet +- [BNB Smart Chain Bridge](#bnb-smart-chain-bridge) - bridge OCEAN from Eth mainnet <> BNB Smart Chain + +For other bridges and networks, see the [Networks page](README.md). + +The rest of this doc gives bridging details. You can skip it until you need the reference information. ## Celer Bridge @@ -81,3 +87,11 @@ Alternatively, you can manually configure the network on Metamask by using the f | Currency Symbol | `MATIC` | | Block Explorer URL | [`https://polygonscan.com`](https://polygonscan.com) | + + +---- + +_Next: [FAQ](../faq.md)_ + +_Back: [Networks](README.md)_ + diff --git a/discover/ocean-token.md b/discover/ocean-token.md new file mode 100644 index 00000000..51901187 --- /dev/null +++ b/discover/ocean-token.md @@ -0,0 +1,134 @@ +--- +description: +--- + +# OCEAN: The Ocean Token + +OCEAN is a utility token. It's used to stake on data for curation, buy & sell data, and more. Its supply is disbursed over time to drive near-term growth and long-term sustainability. + +**Contents:** +- [Getting and storing OCEAN](#getting-and-storing-ocean) +- [Staking OCEAN](#staking-ocean) +- [OCEAN supply](#ocean-supply) +- [Token design](#ocean-token-design) +- [OCEAN addresses](#ocean-addresses) + + +
+ + + +### Getting and Storing OCEAN + +OCEAN is available on most leading CEXes and DEXes. The [Ocean Token page at oceanprotocol.com](https://oceanprotocol.com/about-us/ocean-token) has details. + +The [Wallets User Guide](../user-guides/wallets/README.md) here in Ocean docs shows how to set up wallets and store OCEAN. + +### Staking OCEAN + +You can lock OCEAN and earn rewards via [Ocean Data Farming](../data-farming/README.md). + +### OCEAN supply + +Total # tokens: 1.41B. All tokens are minted; all control is [revoked](https://blog.oceanprotocol.com/control-over-the-ocean-contract-to-be-revoked-soon-overview-6c5b15be2db). + +OCEAN supply is divided as follows: + +- 51% (719.1M OCEAN) - to Data Farming and incentives programs. Distributed via vesting: burn-in period then 4-year half-life. For details, see section 5.1 "OCEAN Emissions Schedule" of [Data Farming Main](https://blog.oceanprotocol.com/ocean-data-farming-main-is-here-49c99602419e#5a8f). +- 15% (211.5M OCEAN) - to Ocean community (grants, more) and foundation operations. +- 10% (141.0M OCEAN) - to the founding company, and in turn to its investors, employees & operations +- 24% (338.4M OCEAN) - to token acquirors. This completed in early 2019. All acquiror vesting is complete as well. + +### OCEAN Token Design + +The system-level design of the OCEAN token is based on [The Web3 Sustainability Loop](https://blog.oceanprotocol.com/the-web3-sustainability-loop-b2a4097a36e), a general design pattern. The Ocean-specific version of this design is described in [section (7) of that same article](https://blog.oceanprotocol.com/the-web3-sustainability-loop-b2a4097a36e#e0f6). + +This design gives flexibility to adapt the Ocean products for traction and growth. The flexibility is due to the goal to "drive network revenue", subject to the constraints of the mission & values of Ocean Protocol. + +
+ + +### OCEAN addresses + +The "root" OCEAN token is deployed on Ethereum mainnet with address [`0x967da4048cd07ab37855c090aaf366e4ce1b9f48`](https://etherscan.io/token/0x967da4048cd07ab37855c090aaf366e4ce1b9f48). + +The OCEAN token has bridges to several [other chains](networks/README.md). It has a unique address on each chain. + +
+ +OCEAN address per chain: (expand me) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Network nameContract AddressSymbolDecimals
Mainnet0x967da4048cD07aB37855c090aAF366e4ce1b9F48OCEAN18
Polygon
(ex Matic)		0x282d8efCe846A88B159800bd4130ad77443Fa1A1mOCEAN18
BNB
BNB Smart Chain		0xdce07662ca8ebc241316a15b611c89711414dd1aOCEAN18
Oasis Sapphire0x39d22B78A7651A76Ffbde2aaAB5FD92666Aca520OCEAN18
Optimism0xf26c6c93f9f1d725e149d95f8e7b2334a406ad10OCEAN18
Görli0xCfDdA22C9837aE76E0faA845354f33C62E03653aOCEAN18
Mumbai0xd8992Ed72C445c35Cb4A2be468568Ed1079357c8OCEAN18
Sepolia0x1B083D8584dd3e6Ff37d04a6e7e82b5F622f3985OCEAN18
Oasis Sapphire Testnet0x973e69303259B0c2543a38665122b773D28405fBOCEAN18
+ +
+ +---- + +_Next: [Networks](networks/README.md)_ + +_Back: [What can you do with Ocean?](benefits.md)_ diff --git a/discover/wallets-and-ocean.md b/discover/wallets-and-ocean.md deleted file mode 100644 index 4faee76f..00000000 --- a/discover/wallets-and-ocean.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -description: >- - How to use a crypto wallet to check your OCEAN balance and send OCEAN - Tokens to others ---- - -# Manage Your OCEAN - -If you don't see any OCEAN in your crypto wallet software 🔎 (e.g. MetaMask or MyEtherWallet), don't worry! It might not know how to manage OCEAN yet. - -### Token Information - -Almost all ERC-20 wallets require these values for adding a custom token: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Network nameContract AddressSymbolDecimals
Mainnet0x967da4048cD07aB37855c090aAF366e4ce1b9F48OCEAN18
Polygon
(ex Matic)		0x282d8efCe846A88B159800bd4130ad77443Fa1A1mOCEAN18
BNB
BNB Smart Chain		0xdce07662ca8ebc241316a15b611c89711414dd1aOCEAN18
Oasis Sapphire0x39d22B78A7651A76Ffbde2aaAB5FD92666Aca520OCEAN18
Optimism0xf26c6c93f9f1d725e149d95f8e7b2334a406ad10OCEAN18
Görli0xCfDdA22C9837aE76E0faA845354f33C62E03653aOCEAN18
Mumbai0xd8992Ed72C445c35Cb4A2be468568Ed1079357c8OCEAN18
Sepolia0x1B083D8584dd3e6Ff37d04a6e7e82b5F622f3985OCEAN18
Oasis Sapphire Testnet0x973e69303259B0c2543a38665122b773D28405fBOCEAN18
- -The [token page](https://oceanprotocol.com/token) at oceanprotocol.com has further details. - -### MetaMask - -1. Make sure MetaMask is connected to the Ethereum Mainnet. -2. Select the account you want to manage. -3. Scroll down until the `Import Tokens` link is visible, then click on it. -4. Click on `Custom Tokens`. -5. Paste the OCEAN contract address listed above into the _Token Contract Address_ field. The other two fields should auto-fill. If not, add `OCEAN` for the symbol and `18` for the precision. -6. Click `Add custom token`. -7. Click `Import Tokens`. - -If you prefer visual demonstrations, we have prepared a visual demo that illustrates the steps mentioned above. - -{% embed url="https://app.arcade.software/share/yHiKKN336QGdAkhTlsIh" fullWidth="false" %} -{% endembed %} - -MetaMask should now show your OCEAN balance, and when you're looking at that, there should be a `Send` button to send OCEAN to others. For help with that, see [the MetaMask docs about how to send tokens](https://metamask.zendesk.com/hc/en-us/articles/360015488931-How-to-Send-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. diff --git a/predictoor/README.md b/predictoor/README.md index 429ef0f7..f8b68fa3 100644 --- a/predictoor/README.md +++ b/predictoor/README.md @@ -28,7 +28,11 @@ Ocean Predictoor provides on-chain "prediction feeds" on whether ETH, BTC, etc w Finally, join us on [**Discord**](https://discord.gg/TnXjkR5) to chat with other predictoors, traders, or devs in the Predictoor ecosystem. -## Next step -If you're going through docs sequentially: next is [Introduction](pdr-intro.md). +---- + +_Next: [Introduction](pdr-intro.md)_ + +_Back: [Docs main](../README.md)_ + diff --git a/predictoor/pdr-architecture.md b/predictoor/pdr-architecture.md index 81e2e551..c0c84271 100644 --- a/predictoor/pdr-architecture.md +++ b/predictoor/pdr-architecture.md @@ -83,7 +83,9 @@ The implementation is in templates/ERC20Template3.sol at at [Ocean’s contracts **- Predictoor behavior.** Each datatoken contract has additional methods specific to Predictoor: submitting predictions, submitting truevals, computing aggregated predictions, etc. +---- -## Next step +_Next: [How to earn](pdr-earn.md)_ + +_Back: [Introduction](pdr-intro.md)_ -If you're going through docs sequentially: next is [How to earn](pdr-earn.md). diff --git a/predictoor/pdr-earn.md b/predictoor/pdr-earn.md index b0e36b6c..28fb1881 100644 --- a/predictoor/pdr-earn.md +++ b/predictoor/pdr-earn.md @@ -64,12 +64,13 @@ The image below has the same experimental setup, but for BTC/USDT pair. The size
Simulated returns vs time of BTC/USDT trading on Binance. Trade size has little impact.
+---- -## Next step +_Next: [Parameters](pdr-parameters.md)_ -If you're going through docs sequentially: next is [Parameters](pdr-parameters.md). +_Back: [Architecture](pdr-architecture.md)_ -Or to drill into earning further: +_Or, drill into earning further:_ - [Pdr-backend repo](https://github.com/oceanprotocol/pdr-backend) - how to run bots, specifically - [Predictoor Data Farming](../data-farming/predictoordf.md) - baseline sales $ for running predictoor bots diff --git a/predictoor/pdr-faq.md b/predictoor/pdr-faq.md index e82cebb4..8b59deb1 100644 --- a/predictoor/pdr-faq.md +++ b/predictoor/pdr-faq.md @@ -158,6 +158,9 @@ Predictoor needs to leverage a privacy-preserving EVM chain which is in producti -## Next step +---- + +_Next: [Further Resources](pdr-resources.md)_ + +_Back: [Parameters](pdr-parameters.md)_ -If you're going through docs sequentially: next is [Further Resources](pdr-resources.md). diff --git a/predictoor/pdr-intro.md b/predictoor/pdr-intro.md index 88e48b16..426223a7 100644 --- a/predictoor/pdr-intro.md +++ b/predictoor/pdr-intro.md @@ -33,8 +33,8 @@ Alas, accurate predictions are *hard*. Worse, typical prediction feeds have no a
Screenshot from predictoor.ai
-## Next step - -If you're going through docs sequentially: next is [Architecture](pdr-architecture.md). +---- +_Next: [Architecture](pdr-architecture.md)_ +_Back: [Predictoor Docs main](README.md)_ diff --git a/predictoor/pdr-parameters.md b/predictoor/pdr-parameters.md index d9172f57..4a5b8e20 100644 --- a/predictoor/pdr-parameters.md +++ b/predictoor/pdr-parameters.md @@ -32,6 +32,9 @@ The price to subscribe to one feed for 24 hours is 3.00 OCEAN. This includes all Pricing is subject to change based on learnings, and feedback from community. -## Next step +---- + +_Next: [FAQ](pdr-faq.md)_ + +_Back: [How to earn](pdr-earn.md)_ -If you're going through docs sequentially: next is [FAQ](pdr-faq.md). diff --git a/predictoor/pdr-resources.md b/predictoor/pdr-resources.md index 5186f517..5cdbf86e 100644 --- a/predictoor/pdr-resources.md +++ b/predictoor/pdr-resources.md @@ -14,10 +14,11 @@ For thoroughness: - All blog posts & media: ["Ocean Predictoor Series"](https://blog.oceanprotocol.com/ocean-predictoor-series-6a9122754a4d) - Webapp code is at [pdr-web](https://github.com/oceanprotocol/pdr-web/) repo -## Next step +---- Congrats, you've gone through all the Predictoor docs! -Follow-up links: -- Go earn! Start at [how to earn](pdr-earn.md) -- [Predictoor docs Homepage](README.md) +_Next: Go earn! Start at [how to earn](pdr-earn.md). Or, go to [Predictoor docs homepage](README.md)_ + +_Back: [FAQ](pdr-faq.md)_ + diff --git a/user-guides/README.md b/user-guides/README.md index 1e67970e..c414ea5f 100644 --- a/user-guides/README.md +++ b/user-guides/README.md @@ -10,6 +10,25 @@ coverY: 0
+### For Blockchain / Web3 Beginners + +{% content-ref url="publish-data-nfts.md" %} +[basic-concepts.md](basic-concepts.md) +{% endcontent-ref %} + +{% content-ref url="publish-data-nfts.md" %} +[wallets/README.md.md](wallets/README.md.md) +{% endcontent-ref %} + +{% content-ref url="publish-data-nfts.md" %} +[wallets/metamask-setup.md.md](wallets/metamask-setup.md.md) +{% endcontent-ref %} + +{% content-ref url="publish-data-nfts.md" %} +[wallets-and-ocean.md](wallets-and-ocean.md) +{% endcontent-ref %} + + ### Tokenize & sell your data Buy, mint, and sell NFTs using the Ocean Market following the guides below. @@ -34,14 +53,6 @@ Buy, mint, and sell NFTs using the Ocean Market following the guides below. [using-ocean-market.md](using-ocean-market.md) {% endcontent-ref %} -### Data Farming - -Earn rewards by locking OCEAN, curating data assets, and more. - -{% content-ref url="../data-farming/README.md" %} -[../data-farming/README.md](../data-farming/README.md) -{% endcontent-ref %} - ### Antique Stuff 🏺 If you have OCEAN in old pools, this will help. diff --git a/discover/basic-concepts.md b/user-guides/basic-concepts similarity index 100% rename from discover/basic-concepts.md rename to user-guides/basic-concepts diff --git a/discover/wallets/README.md b/user-guides/wallets/README.md similarity index 100% rename from discover/wallets/README.md rename to user-guides/wallets/README.md diff --git a/discover/wallets/metamask-setup.md b/user-guides/wallets/metamask-setup.md similarity index 100% rename from discover/wallets/metamask-setup.md rename to user-guides/wallets/metamask-setup.md diff --git a/user-guides/wallets/wallets-and-ocean.md b/user-guides/wallets/wallets-and-ocean.md new file mode 100644 index 00000000..b082399b --- /dev/null +++ b/user-guides/wallets/wallets-and-ocean.md @@ -0,0 +1,35 @@ +--- +description: >- + How to use a crypto wallet to check your OCEAN balance and send OCEAN + Tokens to others +--- + +# Manage Your OCEAN + +If you don't see any OCEAN in your crypto wallet software 🔎 (e.g. MetaMask or MyEtherWallet), don't worry! It might not know how to manage OCEAN yet. + +For an ERC-20 wallet to see OCEAN, the wallet typically needs to have OCEAN's address added as a custom token. +- The [OCEAN docs page](../discover/ocean-token.md) has the OCEAN address for each network. +- Then, use that information for the wallet instructions below. + + +### MetaMask + +1. Make sure MetaMask is connected to the Ethereum Mainnet. +2. Select the account you want to manage. +3. Scroll down until the `Import Tokens` link is visible, then click on it. +4. Click on `Custom Tokens`. +5. Paste the OCEAN contract address listed above into the _Token Contract Address_ field. The other two fields should auto-fill. If not, add `OCEAN` for the symbol and `18` for the precision. +6. Click `Add custom token`. +7. Click `Import Tokens`. + +If you prefer visual demonstrations, we have prepared a visual demo that illustrates the steps mentioned above. + +{% embed url="https://app.arcade.software/share/yHiKKN336QGdAkhTlsIh" fullWidth="false" %} +{% endembed %} + +MetaMask should now show your OCEAN balance, and when you're looking at that, there should be a `Send` button to send OCEAN to others. For help with that, see [the MetaMask docs about how to send tokens](https://metamask.zendesk.com/hc/en-us/articles/360015488931-How-to-Send-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.