Merge pull request #1445 from oceanprotocol/node-release
Re-introducing DF content
BIN
.gitbook/assets/data-farming/Rewards-Tab.png
Normal file
After Width: | Height: | Size: 74 KiB |
BIN
.gitbook/assets/data-farming/allocations.png
Normal file
After Width: | Height: | Size: 387 KiB |
BIN
.gitbook/assets/data-farming/claim-rewards.png
Normal file
After Width: | Height: | Size: 370 KiB |
BIN
.gitbook/assets/data-farming/curate-datasets.png
Normal file
After Width: | Height: | Size: 184 KiB |
BIN
.gitbook/assets/data-farming/df_rewards_page.png
Normal file
After Width: | Height: | Size: 358 KiB |
BIN
.gitbook/assets/data-farming/emissions_first_20years.png
Normal file
After Width: | Height: | Size: 167 KiB |
BIN
.gitbook/assets/data-farming/emissions_first_5years.png
Normal file
After Width: | Height: | Size: 68 KiB |
BIN
.gitbook/assets/data-farming/emissions_lifetime.png
Normal file
After Width: | Height: | Size: 81 KiB |
BIN
.gitbook/assets/data-farming/example_apys.png
Normal file
After Width: | Height: | Size: 165 KiB |
BIN
.gitbook/assets/data-farming/flow_of_value.png
Normal file
After Width: | Height: | Size: 127 KiB |
BIN
.gitbook/assets/data-farming/predictoordf_main.png
Normal file
After Width: | Height: | Size: 251 KiB |
BIN
.gitbook/assets/data-farming/ranked_rewards_study.png
Normal file
After Width: | Height: | Size: 182 KiB |
BIN
.gitbook/assets/data-farming/reward_schedule.png
Normal file
After Width: | Height: | Size: 506 KiB |
BIN
.gitbook/assets/data-farming/update-allocations.png
Normal file
After Width: | Height: | Size: 277 KiB |
BIN
.gitbook/assets/data-farming/veOCEAN-Delegation.png
Normal file
After Width: | Height: | Size: 158 KiB |
BIN
.gitbook/assets/data-farming/volumeDF-page.png
Normal file
After Width: | Height: | Size: 72 KiB |
73
README.md
@ -3,73 +3,6 @@ description: Help for wherever you are on your Ocean Protocol journey.
|
|||||||
layout: landing
|
layout: landing
|
||||||
---
|
---
|
||||||
|
|
||||||
<table data-view="cards">
|
# 👋 Ocean docs
|
||||||
<thead>
|
|
||||||
<tr>
|
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/">discover</a></td><td>Learn how Ocean Protocol transforms data sharing and monetization with its powerful Web3 open source tools.</td><td></td><td></td><td><a href="discover/">discover</a></td><td><a href=".gitbook/assets/cover/discover_card.png">discover_card.png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Follow the step-by-step instructions for a no-code solution to unleash the power of Ocean Protocol technologies!</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td><a href=".gitbook/assets/cover/user_guides_card.png">user_guides_card.png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Find APIs, libraries, and other tools to build awesome dApps or integrate with the Ocean Protocol ecosystem.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/cover/developer_card.png">developer_card.png</a></td></tr><tr><td><a href="data-scientists/">data-scientists</a></td><td>Earn $ from AI models, track provenance, get more data.</td><td></td><td></td><td><a href="data-scientists/">data-scientists</a></td><td><a href=".gitbook/assets/cover/data_scientists_card.png">data_scientists_card.png</a></td></tr><tr><td><a href="predictoor/">predictoor</a></td><td>Run AI-powered prediction bots or trading bots to earn $.</td><td></td><td></td><td><a href="predictoor/">predictoor</a></td><td><a href=".gitbook/assets/cover/predictoor_card.jpg">predictoor_card.jpg</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>For software architects and developers - deploy your own components in Ocean Protocol ecosystem.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/cover/infrastructure_card.png">infrastructure_card.png</a></td></tr><tr><td><a href="contribute/">contribute</a></td><td>Get involved! Learn how to contribute to Ocean Protocol.</td><td></td><td></td><td><a href="contribute/">contribute</a></td><td><a href=".gitbook/assets/cover/contribute_card.png">contribute_card.png</a></td></tr></tbody></table>
|
||||||
<th data-type="content-ref"></th>
|
|
||||||
<th></th>
|
|
||||||
<th data-hidden data-type="files"></th>
|
|
||||||
<th data-hidden data-type="files"></th>
|
|
||||||
<th data-hidden data-card-target data-type="content-ref"></th>
|
|
||||||
<th data-hidden data-card-cover data-type="files"></th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td><a href="discover/">discover</a></td>
|
|
||||||
<td>Learn how Ocean Protocol transforms data sharing and monetization with its powerful Web3 open source tools.</td>
|
|
||||||
<td></td>
|
|
||||||
<td></td>
|
|
||||||
<td><a href="discover/">discover</a></td>
|
|
||||||
<td><a href=".gitbook/assets/cover/discover_card.png">discover_card.png</a></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="user-guides/">user-guides</a></td>
|
|
||||||
<td>Follow the step-by-step instructions for a no-code solution to unleash the power of Ocean Protocol technologies!</td>
|
|
||||||
<td></td>
|
|
||||||
<td></td>
|
|
||||||
<td><a href="user-guides/">user-guides</a></td>
|
|
||||||
<td><a href=".gitbook/assets/cover/user_guides_card.png">user_guides_card.png</a></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="developers/">developers</a></td>
|
|
||||||
<td>Find APIs, libraries, and other tools to build awesome dApps or integrate with the Ocean Protocol ecosystem.</td>
|
|
||||||
<td></td>
|
|
||||||
<td></td>
|
|
||||||
<td><a href="developers/">developers</a></td>
|
|
||||||
<td><a href=".gitbook/assets/cover/developer_card.png">developer_card.png</a></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="data-scientists/">data-scientists</a></td>
|
|
||||||
<td>Earn $ from AI models, track provenance, get more data.</td>
|
|
||||||
<td></td>
|
|
||||||
<td></td>
|
|
||||||
<td><a href="data-scientists/">data-scientists</a></td>
|
|
||||||
<td><a href=".gitbook/assets/cover/data_scientists_card.png">data_scientists_card.png</a></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="predictoor/">predictoor</a></td>
|
|
||||||
<td>Run AI-powered prediction bots or trading bots to earn $.</td>
|
|
||||||
<td></td>
|
|
||||||
<td></td>
|
|
||||||
<td><a href="predictoor/">predictoor</a></td>
|
|
||||||
<td><a href=".gitbook/assets/cover/predictoor_card.jpg">predictoor_card.jpg</a></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="infrastructure/">infrastructure</a></td>
|
|
||||||
<td>For software architects and developers - deploy your own components in Ocean Protocol ecosystem.</td>
|
|
||||||
<td></td>
|
|
||||||
<td></td>
|
|
||||||
<td><a href="infrastructure/">infrastructure</a></td>
|
|
||||||
<td><a href=".gitbook/assets/cover/infrastructure_card.png">infrastructure_card.png</a></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="contribute/">contribute</a></td>
|
|
||||||
<td>Get involved! Learn how to contribute to Ocean Protocol.</td>
|
|
||||||
<td></td>
|
|
||||||
<td></td>
|
|
||||||
<td><a href="contribute/">contribute</a></td>
|
|
||||||
<td><a href=".gitbook/assets/cover/contribute_card.png">contribute_card.png</a></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
224
SUMMARY.md
@ -1,109 +1,125 @@
|
|||||||
# Table of contents
|
# Table of contents
|
||||||
- [Ocean docs](README.md)
|
|
||||||
- [🌊 Discover Ocean](discover/README.md)
|
* [👋 Ocean docs](README.md)
|
||||||
- [Why Ocean?](discover/why-ocean.md)
|
* [🌊 Discover Ocean](discover/README.md)
|
||||||
- [What is Ocean?](discover/what-is-ocean.md)
|
* [Why Ocean?](discover/why-ocean.md)
|
||||||
- [What can you do with Ocean?](discover/benefits.md)
|
* [What is Ocean?](discover/what-is-ocean.md)
|
||||||
- [OCEAN: The Ocean token](discover/ocean-token.md)
|
* [What can you do with Ocean?](discover/benefits.md)
|
||||||
- [Networks](discover/networks/README.md)
|
* [OCEAN: The Ocean token](discover/ocean-token.md)
|
||||||
- [Network Bridges](discover/networks/bridges.md)
|
* [Networks](discover/networks/README.md)
|
||||||
- [FAQ](discover/faq.md)
|
* [Network Bridges](discover/networks/bridges.md)
|
||||||
- [Glossary](discover/glossary.md)
|
* [FAQ](discover/faq.md)
|
||||||
- [📚 User Guides](user-guides/README.md)
|
* [Glossary](discover/glossary.md)
|
||||||
- [Basic concepts](user-guides/basic-concepts.md)
|
* [📚 User Guides](user-guides/README.md)
|
||||||
- [Using Wallets](user-guides/wallets/README.md)
|
* [Basic concepts](user-guides/basic-concepts.md)
|
||||||
- [Set Up MetaMask](user-guides/wallets/metamask-setup.md)
|
* [Using Wallets](user-guides/wallets/README.md)
|
||||||
- [Manage Your OCEAN](user-guides/wallets/wallets-and-ocean.md)
|
* [Set Up MetaMask](user-guides/wallets/metamask-setup.md)
|
||||||
- [Data Storage](user-guides/asset-hosting/README.md)
|
* [Manage Your OCEAN](user-guides/wallets/wallets-and-ocean.md)
|
||||||
- [Uploader](user-guides/asset-hosting/uploader.md)
|
* [Host Assets](user-guides/asset-hosting/README.md)
|
||||||
- [Arweave](user-guides/asset-hosting/arweave.md)
|
* [Uploader](user-guides/asset-hosting/uploader.md)
|
||||||
- [AWS](user-guides/asset-hosting/aws.md)
|
* [Arweave](user-guides/asset-hosting/arweave.md)
|
||||||
- [Azure Cloud](user-guides/asset-hosting/azure-cloud.md)
|
* [AWS](user-guides/asset-hosting/aws.md)
|
||||||
- [Google Storage](user-guides/asset-hosting/google-storage.md)
|
* [Azure Cloud](user-guides/asset-hosting/azure-cloud.md)
|
||||||
- [Github](user-guides/asset-hosting/github.md)
|
* [Google Storage](user-guides/asset-hosting/google-storage.md)
|
||||||
- [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md)
|
* [Github](user-guides/asset-hosting/github.md)
|
||||||
- [💻 Developers](developers/README.md)
|
* [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md)
|
||||||
- [Architecture Overview](developers/architecture.md)
|
* [💻 Developers](developers/README.md)
|
||||||
- [Contracts](developers/contracts/README.md)
|
* [Architecture Overview](developers/architecture.md)
|
||||||
- [Data NFTs](developers/contracts/data-nfts.md)
|
* [Contracts](developers/contracts/README.md)
|
||||||
- [Datatokens](developers/contracts/datatokens.md)
|
* [Data NFTs](developers/contracts/data-nfts.md)
|
||||||
- [Data NFTs and Datatokens](developers/contracts/datanft-and-datatoken.md)
|
* [Datatokens](developers/contracts/datatokens.md)
|
||||||
- [Datatoken Templates](developers/contracts/datatoken-templates.md)
|
* [Data NFTs and Datatokens](developers/contracts/datanft-and-datatoken.md)
|
||||||
- [Roles](developers/contracts/roles.md)
|
* [Datatoken Templates](developers/contracts/datatoken-templates.md)
|
||||||
- [Pricing Schemas](developers/contracts/pricing-schemas.md)
|
* [Roles](developers/contracts/roles.md)
|
||||||
- [Fees](developers/contracts/fees.md)
|
* [Pricing Schemas](developers/contracts/pricing-schemas.md)
|
||||||
- [Revenue](developers/contracts/revenue.md)
|
* [Fees](developers/contracts/fees.md)
|
||||||
- [Fractional Ownership](developers/fractional-ownership.md)
|
* [Revenue](developers/contracts/revenue.md)
|
||||||
- [Community Monetization](developers/community-monetization.md)
|
* [Fractional Ownership](developers/fractional-ownership.md)
|
||||||
- [Metadata](developers/metadata.md)
|
* [Community Monetization](developers/community-monetization.md)
|
||||||
- [Identifiers (DIDs)](developers/identifiers.md)
|
* [Metadata](developers/metadata.md)
|
||||||
- [DDO Specification](developers/ddo-specification.md)
|
* [Identifiers (DIDs)](developers/identifiers.md)
|
||||||
- [Storage Specifications](developers/storage.md)
|
* [DDO Specification](developers/ddo-specification.md)
|
||||||
- [Fine-Grained Permissions](developers/fg-permissions.md)
|
* [Storage Specifications](developers/storage.md)
|
||||||
- [Retrieve datatoken/data NFT addresses & Chain ID](developers/retrieve-datatoken-address.md)
|
* [Fine-Grained Permissions](developers/fg-permissions.md)
|
||||||
- [Get API Keys for Blockchain Access](developers/get-api-keys-for-blockchain-access.md)
|
* [Retrieve datatoken/data NFT addresses & Chain ID](developers/retrieve-datatoken-address.md)
|
||||||
- [Barge](developers/barge/README.md)
|
* [Get API Keys for Blockchain Access](developers/get-api-keys-for-blockchain-access.md)
|
||||||
- [Local Setup](developers/barge/local-setup-ganache.md)
|
* [Barge](developers/barge/README.md)
|
||||||
- [Subgraph](developers/subgraph/README.md)
|
* [Local Setup](developers/barge/local-setup-ganache.md)
|
||||||
- [Get data NFTs](developers/subgraph/list-data-nfts.md)
|
* [Subgraph](developers/subgraph/README.md)
|
||||||
- [Get data NFT information](developers/subgraph/get-data-nft-information.md)
|
* [Get data NFTs](developers/subgraph/list-data-nfts.md)
|
||||||
- [Get datatokens](developers/subgraph/list-datatokens.md)
|
* [Get data NFT information](developers/subgraph/get-data-nft-information.md)
|
||||||
- [Get datatoken information](developers/subgraph/get-datatoken-information.md)
|
* [Get datatokens](developers/subgraph/list-datatokens.md)
|
||||||
- [Get datatoken buyers](developers/subgraph/get-datatoken-buyers.md)
|
* [Get datatoken information](developers/subgraph/get-datatoken-information.md)
|
||||||
- [Get fixed-rate exchanges](developers/subgraph/list-fixed-rate-exchanges.md)
|
* [Get datatoken buyers](developers/subgraph/get-datatoken-buyers.md)
|
||||||
- [Get veOCEAN stats](developers/subgraph/get-veocean-stats.md)
|
* [Get fixed-rate exchanges](developers/subgraph/list-fixed-rate-exchanges.md)
|
||||||
- [Ocean.js](developers/ocean.js/README.md)
|
* [Get veOCEAN stats](developers/subgraph/get-veocean-stats.md)
|
||||||
- [Configuration](developers/ocean.js/configuration.md)
|
* [Ocean.js](developers/ocean.js/README.md)
|
||||||
- [Creating a data NFT](developers/ocean.js/creating-datanft.md)
|
* [Configuration](developers/ocean.js/configuration.md)
|
||||||
- [Publish](developers/ocean.js/publish.md)
|
* [Creating a data NFT](developers/ocean.js/creating-datanft.md)
|
||||||
- [Mint Datatokens](developers/ocean.js/mint-datatoken.md)
|
* [Publish](developers/ocean.js/publish.md)
|
||||||
- [Update Metadata](developers/ocean.js/update-metadata.md)
|
* [Mint Datatokens](developers/ocean.js/mint-datatoken.md)
|
||||||
- [Asset Visibility](developers/ocean.js/asset-visibility.md)
|
* [Update Metadata](developers/ocean.js/update-metadata.md)
|
||||||
- [Consume Asset](developers/ocean.js/consume-asset.md)
|
* [Asset Visibility](developers/ocean.js/asset-visibility.md)
|
||||||
- [Run C2D Jobs](developers/ocean.js/cod-asset.md)
|
* [Consume Asset](developers/ocean.js/consume-asset.md)
|
||||||
- [Ocean CLI](developers/ocean-cli/README.md)
|
* [Run C2D Jobs](developers/ocean.js/cod-asset.md)
|
||||||
- [Install](developers/ocean-cli/install.md)
|
* [Ocean CLI](developers/ocean-cli/README.md)
|
||||||
- [Publish](developers/ocean-cli/publish.md)
|
* [Install](developers/ocean-cli/install.md)
|
||||||
- [Edit](developers/ocean-cli/edit.md)
|
* [Publish](developers/ocean-cli/publish.md)
|
||||||
- [Consume](developers/ocean-cli/consume.md)
|
* [Edit](developers/ocean-cli/edit.md)
|
||||||
- [Run C2D Jobs](developers/ocean-cli/run-c2d.md)
|
* [Consume](developers/ocean-cli/consume.md)
|
||||||
- [Compute to data](developers/compute-to-data/README.md)
|
* [Run C2D Jobs](developers/ocean-cli/run-c2d.md)
|
||||||
- [Architecture](developers/compute-to-data/compute-to-data-architecture.md)
|
* [Compute to data](developers/compute-to-data/README.md)
|
||||||
- [Datasets & Algorithms](developers/compute-to-data/compute-to-data-datasets-algorithms.md)
|
* [Architecture](developers/compute-to-data/compute-to-data-architecture.md)
|
||||||
- [Workflow](developers/compute-to-data/compute-workflow.md)
|
* [Datasets & Algorithms](developers/compute-to-data/compute-to-data-datasets-algorithms.md)
|
||||||
- [Writing Algorithms](developers/compute-to-data/compute-to-data-algorithms.md)
|
* [Workflow](developers/compute-to-data/compute-workflow.md)
|
||||||
- [Compute Options](developers/compute-to-data/compute-options.md)
|
* [Writing Algorithms](developers/compute-to-data/compute-to-data-algorithms.md)
|
||||||
- [Aquarius](developers/aquarius/README.md)
|
* [Compute Options](developers/compute-to-data/compute-options.md)
|
||||||
- [Asset Requests](developers/aquarius/asset-requests.md)
|
* [Aquarius](developers/aquarius/README.md)
|
||||||
- [Chain Requests](developers/aquarius/chain-requests.md)
|
* [Asset Requests](developers/aquarius/asset-requests.md)
|
||||||
- [Other Requests](developers/aquarius/other-requests.md)
|
* [Chain Requests](developers/aquarius/chain-requests.md)
|
||||||
- [Provider](developers/provider/README.md)
|
* [Other Requests](developers/aquarius/other-requests.md)
|
||||||
- [General Endpoints](developers/provider/general-endpoints.md)
|
* [Provider](developers/provider/README.md)
|
||||||
- [Encryption / Decryption](developers/provider/encryption-decryption.md)
|
* [General Endpoints](developers/provider/general-endpoints.md)
|
||||||
- [Compute Endpoints](developers/provider/compute-endpoints.md)
|
* [Encryption / Decryption](developers/provider/encryption-decryption.md)
|
||||||
- [Authentication Endpoints](developers/provider/authentication-endpoints.md)
|
* [Compute Endpoints](developers/provider/compute-endpoints.md)
|
||||||
- [Uploader](developers/uploader/README.md)
|
* [Authentication Endpoints](developers/provider/authentication-endpoints.md)
|
||||||
- [Uploader.js](developers/uploader/uploader-js.md)
|
* [Uploader](developers/uploader/README.md)
|
||||||
- [Uploader UI](developers/uploader/uploader-ui.md)
|
* [Uploader.js](developers/uploader/uploader-js.md)
|
||||||
- [Uploader UI to Market](developers/uploader/uploader-ui-marketplace.md)
|
* [Uploader UI](developers/uploader/uploader-ui.md)
|
||||||
- [Developer FAQ](developers/dev-faq.md)
|
* [Uploader UI to Market](developers/uploader/uploader-ui-marketplace.md)
|
||||||
- [📊 Data Scientists](data-scientists/README.md)
|
* [Developer FAQ](developers/dev-faq.md)
|
||||||
- [Ocean.py](data-scientists/ocean.py/README.md)
|
* [📊 Data Scientists](data-scientists/README.md)
|
||||||
- [Install](data-scientists/ocean.py/install.md)
|
* [Ocean.py](data-scientists/ocean.py/README.md)
|
||||||
- [Local Setup](data-scientists/ocean.py/local-setup.md)
|
* [Install](data-scientists/ocean.py/install.md)
|
||||||
- [Remote Setup](data-scientists/ocean.py/remote-setup.md)
|
* [Local Setup](data-scientists/ocean.py/local-setup.md)
|
||||||
- [Publish Flow](data-scientists/ocean.py/publish-flow.md)
|
* [Remote Setup](data-scientists/ocean.py/remote-setup.md)
|
||||||
- [Consume Flow](data-scientists/ocean.py/consume-flow.md)
|
* [Publish Flow](data-scientists/ocean.py/publish-flow.md)
|
||||||
- [Compute Flow](data-scientists/ocean.py/compute-flow.md)
|
* [Consume Flow](data-scientists/ocean.py/consume-flow.md)
|
||||||
- [Ocean Instance Tech Details](data-scientists/ocean.py/technical-details.md)
|
* [Compute Flow](data-scientists/ocean.py/compute-flow.md)
|
||||||
- [Ocean Assets Tech Details](data-scientists/ocean.py/ocean-assets-tech-details.md)
|
* [Ocean Instance Tech Details](data-scientists/ocean.py/technical-details.md)
|
||||||
- [Ocean Compute Tech Details](data-scientists/ocean.py/ocean-compute-tech-details.md)
|
* [Ocean Assets Tech Details](data-scientists/ocean.py/ocean-assets-tech-details.md)
|
||||||
- [Datatoken Interface Tech Details](data-scientists/ocean.py/datatoken-interface-tech-details.md)
|
* [Ocean Compute Tech Details](data-scientists/ocean.py/ocean-compute-tech-details.md)
|
||||||
- [Join a Data Challenge](data-scientists/join-a-data-challenge.md)
|
* [Datatoken Interface Tech Details](data-scientists/ocean.py/datatoken-interface-tech-details.md)
|
||||||
- [Sponsor a Data Challenge](data-scientists/sponsor-a-data-challenge.md)
|
* [Join a Data Challenge](data-scientists/join-a-data-challenge.md)
|
||||||
- [Data Value-Creation Loop](data-scientists/the-data-value-creation-loop.md)
|
* [Sponsor a Data Challenge](data-scientists/sponsor-a-data-challenge.md)
|
||||||
- [What data is valuable?](data-scientists/data-engineers.md)
|
* [Data Value-Creation Loop](data-scientists/the-data-value-creation-loop.md)
|
||||||
|
* [What data is valuable?](data-scientists/data-engineers.md)
|
||||||
* [👀 Predictoor](predictoor/README.md)
|
* [👀 Predictoor](predictoor/README.md)
|
||||||
|
* [💰 Data Farming](data-farming/README.md)
|
||||||
|
* [Passive DF (and veOCEAN)](data-farming/passive-df-and-veocean/README.md)
|
||||||
|
* [Guide to Passive DF](data-farming/passive-df-and-veocean/guide-to-passive-df.md)
|
||||||
|
* [Liquid Staking](data-farming/passive-df-and-veocean/liquid-staking.md)
|
||||||
|
* [Volume DF](data-farming/volume-df/README.md)
|
||||||
|
* [Guide to Volume DF](data-farming/volume-df/guide-to-volume-df.md)
|
||||||
|
* [Delegation in Volume DF](data-farming/volume-df/delegation-in-volume-df.md)
|
||||||
|
* [Predictoor DF](data-farming/predictoordf.md)
|
||||||
|
* [Guide to Predictoor DF](data-farming/predictoordf-guide.md)
|
||||||
|
* [Claim Rewards](data-farming/claim-rewards.md)
|
||||||
|
* [Reward Schedule](data-farming/reward-schedule.md)
|
||||||
|
* [APYs](data-farming/apys/README.md)
|
||||||
|
* [Estimated APY vs Time](data-farming/apys/estimated-apy-vs-time.md)
|
||||||
|
* [Guide to Estimating APY](data-farming/apys/guide-to-estimating-apy.md)
|
||||||
|
* [FAQ](data-farming/faq.md)
|
||||||
* [🔨 Infrastructure](infrastructure/README.md)
|
* [🔨 Infrastructure](infrastructure/README.md)
|
||||||
* [Set Up a Server](infrastructure/setup-server.md)
|
* [Set Up a Server](infrastructure/setup-server.md)
|
||||||
* [Deploy Aquarius](infrastructure/deploying-aquarius.md)
|
* [Deploy Aquarius](infrastructure/deploying-aquarius.md)
|
||||||
|
62
data-farming/README.md
Normal file
@ -0,0 +1,62 @@
|
|||||||
|
---
|
||||||
|
description: Earn OCEAN rewards by predicting (and more streams to come).
|
||||||
|
cover: ../.gitbook/assets/cover/data_farming_banner.png
|
||||||
|
coverY: 0
|
||||||
|
---
|
||||||
|
|
||||||
|
# 💰 Data Farming
|
||||||
|
|
||||||
|
**Data Farming (DF) is Ocean's incentive program.** It rewards OCEAN to participants who make predictions (and more streams to come).
|
||||||
|
|
||||||
|
[**The DF webapp**](https://df.oceandao.org) is where users perform most DF actions.
|
||||||
|
|
||||||
|
## Current DF Streams & Budgets
|
||||||
|
|
||||||
|
DF currently has one stream:
|
||||||
|
|
||||||
|
* [**Predictoor DF**](predictoordf.md)**.** Run prediction bots to earn continuously. 37,500 OCEAN/week + ROSE rewards.
|
||||||
|
|
||||||
|
All streams repeat **weekly** that start on Thursdays 00:00 at UTC and end on Wed at 23:59 UTC.
|
||||||
|
|
||||||
|
DF Streams evolve over time. The next two sections cover past & future DF streams.
|
||||||
|
|
||||||
|
## Past DF Streams
|
||||||
|
|
||||||
|
In **Passive DF**, users locked OCEAN for veOCEAN. In **Active DF**, users allocated veOCEAN to curate data assets.
|
||||||
|
|
||||||
|
* veOCEAN, Passive DF, and Active DF were [retired](https://blog.oceanprotocol.com/passive-volume-data-farming-airdrop-has-completed-they-are-now-retired-6933520b5fcb) on May 3, 2024, alongside an an airdrop to veOCEAN holders.
|
||||||
|
* **veOCEAN holders can claim airdrop & past rewards at** [**df.oceandao.org/rewards**](https://df.oceandao.org/rewards).
|
||||||
|
* The locked OCEAN will unlock according to its schedule (up to 4 years)
|
||||||
|
* [This article](https://blog.oceanprotocol.com/passive-volume-data-farming-airdrop-has-completed-they-are-now-retired-6933520b5fcb) has details.
|
||||||
|
|
||||||
|
In **Challenge DF**, users did weekly one-off predictions. It was [retired](https://blog.oceanprotocol.com/df62-completes-and-df63-launches-predictoor-df-is-here-081fc78ceb70) on Nov 30, 2023.
|
||||||
|
|
||||||
|
For further details, the ["Data Farming Series" article](https://blog.oceanprotocol.com/ocean-data-farming-series-c7922f1d0e45) chronicles week-by-week rewards and DF evolution.
|
||||||
|
|
||||||
|
## Future DF Streams
|
||||||
|
|
||||||
|
Potential DF evolution includes:
|
||||||
|
|
||||||
|
* Scaling up Predictoor DF rewards. [Details](https://blog.oceanprotocol.com/ocean-protocol-update-2024-e463bf855b03#4da0).
|
||||||
|
* New stream: run Unified Backend nodes. [Details](https://blog.oceanprotocol.com/ocean-protocol-update-2024-e463bf855b03#f779).
|
||||||
|
* New stream: decentralized model training for world-world models. [Details](\[Details]\(https:/blog.oceanprotocol.com/ocean-protocol-update-2024-e463bf855b03/#4da0\).)
|
||||||
|
|
||||||
|
## Networks
|
||||||
|
|
||||||
|
To engage in Predictoor DF, users submit Predictions on Oasis Sapphire. Rewards for Predictoor DF are on Oasis Sapphire as well (it's intertwined).
|
||||||
|
|
||||||
|
Passive DF and Volume DF reward payouts are on Ethereum network.
|
||||||
|
|
||||||
|
The [networks docs](../discover/networks/) have more info.
|
||||||
|
|
||||||
|
## Further resources
|
||||||
|
|
||||||
|
* The [**DF FAQ**](faq.md) answers more questions.
|
||||||
|
* Main DF github repos: [df-py (backend)](https://github.com/oceanprotocol/df-py), [df-web (frontend)](https://github.com/oceanprotocol/df-web)
|
||||||
|
* The [Ocean Data Farming Series](https://blog.oceanprotocol.com/ocean-data-farming-series-c7922f1d0e45) article has a chronological account of all Data Farming activities since its inception. It links to related blog posts.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
_Next:_ [_Predictoor DF_](predictoordf.md)
|
||||||
|
|
||||||
|
_Back:_ [_Docs main_](../)
|
2
data-farming/apys/README.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# APYs
|
||||||
|
|
2
data-farming/apys/estimated-apy-vs-time.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Estimated APY vs Time
|
||||||
|
|
2
data-farming/apys/guide-to-estimating-apy.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Guide to Estimating APY
|
||||||
|
|
2
data-farming/claim-rewards.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Claim Rewards
|
||||||
|
|
72
data-farming/faq.md
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
---
|
||||||
|
title: Data Farming FAQ
|
||||||
|
description: Frequently Asked Questions about Data Farming
|
||||||
|
---
|
||||||
|
## Data Farming FAQ
|
||||||
|
|
||||||
|
### Staking and Risk
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>What does "staking" mean in an Ocean context?</summary>
|
||||||
|
|
||||||
|
Its precise meaning depends on the DF stream.
|
||||||
|
|
||||||
|
- Predictoor DF: put OCEAN into a prediction transaction
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>Are there any risks associated with DF?</summary>
|
||||||
|
|
||||||
|
As with any system, inherent risks exist. We try to minimize them, as follows.
|
||||||
|
|
||||||
|
- Predictoor DF: you stake a small amount of OCEAN in each epoch (eg every 5min). If issues arise, you can get out quickly.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>Is there any impermanent loss (IL) in my staking?</summary>
|
||||||
|
|
||||||
|
No. IL is typically associated with providing liquidity to decentralized exchange or pools. There are no pools involved in any of the DF streams [1].
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
|
### Rewards Payout
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>What APYs can I expect?</summary>
|
||||||
|
|
||||||
|
For Predictoor DF, it varies a lot based on your prediction accuracy, and more.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>Can the DF rewards change during a given week?</summary>
|
||||||
|
|
||||||
|
No. At the beginning of a new DF round, rules are laid out, either implicitly if no change from the previous round, or explicitly in a blog post if there are new rules.
|
||||||
|
|
||||||
|
Caveat: it’s "no" at least in theory! Sometimes there may be tweaks if there is community consensus or a bug.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>Where do I learn more about Predictoor DF?</summary>
|
||||||
|
|
||||||
|
In its [docs page](predictoordf.md).
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Congrats! You've completed reading Data Farming docs.
|
||||||
|
|
||||||
|
_Next: Jump to [DF main](README.md)._
|
||||||
|
|
||||||
|
_Or: Jump to [Docs main](../README.md) and click on your interest._
|
||||||
|
|
||||||
|
_Back: [Predictoor DF Guide](predictoordf-guide.md)_
|
2
data-farming/passive-df-and-veocean/README.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Passive DF (and veOCEAN)
|
||||||
|
|
@ -0,0 +1,2 @@
|
|||||||
|
# Guide to Passive DF
|
||||||
|
|
2
data-farming/passive-df-and-veocean/liquid-staking.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Liquid Staking
|
||||||
|
|
34
data-farming/predictoordf-guide.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
description: >-
|
||||||
|
How to earn $ via predictoor DF
|
||||||
|
---
|
||||||
|
|
||||||
|
# Guide to Predictoor DF
|
||||||
|
|
||||||
|
<figure><img src="../.gitbook/assets/gif/money-robot.gif" alt=""></figure>
|
||||||
|
|
||||||
|
In Predictoor DF (and Predictoor proper), you run prediction bots to earn continuously. This guide describes how to become eligible for OCEAN rewards and claim them; and the same for Oasis ROSE rewards. And of course first thing you need to do is become a predictoor.
|
||||||
|
|
||||||
|
## How to become a predictoor
|
||||||
|
|
||||||
|
- Play with the dapp: http://predictoor.ai
|
||||||
|
- Then go through "How to earn as a Predictoor" in [Predictoor docs](https://docs.predictoor.ai)
|
||||||
|
- Or, go straight to the [quickstart README](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/predictoor.md) :) 🏎️
|
||||||
|
|
||||||
|
## On OCEAN Rewards in Predictoor DF
|
||||||
|
|
||||||
|
- **Duration:** ongoing
|
||||||
|
- **To be eligible:** predictoors are automatically eligible 🧘
|
||||||
|
- **To claim:** recall that the OCEAN rewards act as more sales coming to you (as a predictoor). So you claim your OCEAN from sales in the usual way, by running the OCEAN payout script. See the [payout README](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/payout.md) for specific instructions.
|
||||||
|
|
||||||
|
|
||||||
|
## On ROSE rewards in Predictoor DF
|
||||||
|
|
||||||
|
- ⚠️ **To be eligible** for a given DF round: you MUST run [OCEAN payout script](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/payout.md) <= 4 days after the round ends, i.e. between Thu 00:00 UTC & Sun 11:59 PM UTC
|
||||||
|
- **To claim:** See the [payout README](https://github.com/oceanprotocol/pdr-backend/blob/main/READMEs/payout.md) for specific instructions.
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
_Next: Jump to [DF FAQ](faq.md)._
|
||||||
|
|
||||||
|
_Back: [Predictoor DF](predictoordf.md)_
|
55
data-farming/predictoordf.md
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
---
|
||||||
|
description: >-
|
||||||
|
Baseline sales for predictoors
|
||||||
|
---
|
||||||
|
|
||||||
|
<figure><img src="../.gitbook/assets/data-farming/predictoordf_main.png" alt=""></figure>
|
||||||
|
|
||||||
|
**This page** is about Predictoor DF, and [this page](predictoordf-guide.md) is a guide.
|
||||||
|
|
||||||
|
# Predictoor DF Overview
|
||||||
|
|
||||||
|
**Predictoor DF** is a DF stream that amplifies predictoors’ earnings, via extra sales to Ocean Predictoor data feeds.
|
||||||
|
|
||||||
|
Predictoor DF has 37,500 OCEAN weekly rewards (ongoing) and 20,000 ROSE weekly rewards (throughout 2024).
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
**[Ocean Predictoor](../predictoor/README.md)** data feeds predict whether BTC, ETH etc will rise or fall 5min or 1h into the future. These feeds are crowdsourced by “predictoors”: people running AI-powered prediction bots.
|
||||||
|
|
||||||
|
**[Data Farming (DF)](../data-farming/README.md)** is Ocean’s incentive program, that rewards OCEAN to people who lock OCEAN or do active DF activities.
|
||||||
|
|
||||||
|
You should be familiar with both Predictoor and DF before reading on.
|
||||||
|
|
||||||
|
## Predictoor DF Timing
|
||||||
|
|
||||||
|
Predictoor DF started counting on Nov 9, 2023, at the beginning of Data Farming Round 63 (DF63). It runs indefinitely.
|
||||||
|
|
||||||
|
## Predictoor DF Rewards
|
||||||
|
|
||||||
|
Predictoor DF has two components: [OCEAN](https://oceanprotocol.com/about-us/ocean-token) rewards and [Oasis ROSE](https://www.coingecko.com/en/coins/oasis-network) rewards.
|
||||||
|
|
||||||
|
### OCEAN Rewards
|
||||||
|
|
||||||
|
- A special “DF buyer” bot purchases Predictoor feeds. It started operating on Nov 9, 2023. Every day, it spends 1/7 of the weekly Predictoor OCEAN budget for another 24h subscription. It spends an equal amount per feed. (Currently there are feeds: 10 x 5min, 10 x 1h.)
|
||||||
|
- The OCEAN comes from the Ocean DF budget, and specifically, the Active DF budget.
|
||||||
|
|
||||||
|
### ROSE Rewards
|
||||||
|
|
||||||
|
- Payout happens on Mondays, 4 days after the end of the DF round.
|
||||||
|
- ⚠️ To be counted for ROSE rewards of a given DF round, you must claim your OCEAN rewards for that DF round. See [Predictoor DF user guide](predictoordf-guide.md).
|
||||||
|
- Payout for a given predictoor is pro-rata to the net earnings of that predictoor over that DF round, specifically (total sales $ to the predictoor) minus (predictoor stake slashed due to being wrong).
|
||||||
|
- The ROSE comes from a generous contribution of[ Oasis Protocol Foundation](https://oasisprotocol.org/) 👪🙏.
|
||||||
|
|
||||||
|
|
||||||
|
## How to Earn $ Via Predictoor DF
|
||||||
|
|
||||||
|
**Running a predictoor bot will automatically make you eligible for Predictoor DF rewards.**
|
||||||
|
|
||||||
|
The [Predictoor DF user guide](predictoordf-guide.md) tells how to get started as a predictoor, and how to claim rewards.
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
_Next: [Predictoor DF Guide](predictoordf-guide.md)_
|
||||||
|
|
||||||
|
_Back: [DF Main](README.md)_
|
2
data-farming/reward-schedule.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Reward Schedule
|
||||||
|
|
2
data-farming/volume-df/README.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Volume DF
|
||||||
|
|
2
data-farming/volume-df/delegation-in-volume-df.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Delegation in Volume DF
|
||||||
|
|
2
data-farming/volume-df/guide-to-volume-df.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Guide to Volume DF
|
||||||
|
|
@ -4,32 +4,33 @@ cover: ../.gitbook/assets/cover/data_scientists_banner.png
|
|||||||
coverY: 0
|
coverY: 0
|
||||||
---
|
---
|
||||||
|
|
||||||
# 📊 Data Science
|
# 📊 Data Scientists
|
||||||
|
|
||||||
### How does Ocean benefit data scientists?
|
### How does Ocean benefit data scientists?
|
||||||
|
|
||||||
It offers three main benefits:
|
It offers three main benefits:
|
||||||
- **Earn.** You can earn $ by doing crypto price predictions via [Predictoor](../predictoor/README.md), by curating data in [Data Farming](../data-farming/README.md), competing in a [data challenge](join-a-data-challenge.md), and by selling data & models.
|
|
||||||
- **More Data.** Use [Compute-to-Data](../developers/compute-to-data/README.md) to access private data to run your AI modeling algorithms against, data which was previously inaccessible. Browse [Ocean Market](https://market.oceanprotocol.com) and other Ocean-powered markets to find more data to improve your AI models.
|
* **Earn.** You can earn $ by doing crypto price predictions via [Predictoor](../predictoor/), by curating data in [Data Farming](../data-farming/), competing in a [data challenge](join-a-data-challenge.md), and by selling data & models.
|
||||||
- **Provenance.** The acts of publishing data, purchasing data, and consuming data are all recorded on the blockchain to make a tamper-proof audit trail. Know where your AI training data came from!
|
* **More Data.** Use [Compute-to-Data](../developers/compute-to-data/) to access private data to run your AI modeling algorithms against, data which was previously inaccessible. Browse [Ocean Market](https://market.oceanprotocol.com) and other Ocean-powered markets to find more data to improve your AI models.
|
||||||
|
* **Provenance.** The acts of publishing data, purchasing data, and consuming data are all recorded on the blockchain to make a tamper-proof audit trail. Know where your AI training data came from!
|
||||||
|
|
||||||
### How do data scientists start using Ocean?
|
### How do data scientists start using Ocean?
|
||||||
|
|
||||||
Here are the most relevant Ocean tools to work with:
|
Here are the most relevant Ocean tools to work with:
|
||||||
|
|
||||||
- The **[ocean.py](ocean.py/README.md)** library is built for the key environment of data scientists: Python. It can simply be imported alongside other Python data science tools like numpy, matplotlib, scikit-learn and tensorflow. You can use it to publish & sell data assets, buy assets, transfer ownership, and more.
|
* The [**ocean.py**](ocean.py/) library is built for the key environment of data scientists: Python. It can simply be imported alongside other Python data science tools like numpy, matplotlib, scikit-learn and tensorflow. You can use it to publish & sell data assets, buy assets, transfer ownership, and more.
|
||||||
- Predictoor's **[pdr-backend repo](https://github.com/oceanprotocol/pdr-backend)** has Python-based tools to run bots for crypto prediction or trading.
|
* Predictoor's [**pdr-backend repo**](https://github.com/oceanprotocol/pdr-backend) has Python-based tools to run bots for crypto prediction or trading.
|
||||||
- **[Compete in a data challenge](join-a-data-challenge.md)**, or [sponsor one](sponsor-a-data-challenge.md).
|
* [**Compete in a data challenge**](join-a-data-challenge.md), or [sponsor one](sponsor-a-data-challenge.md).
|
||||||
|
|
||||||
|
|
||||||
### Are there mental models for earning $ in data?
|
### Are there mental models for earning $ in data?
|
||||||
|
|
||||||
Yes. This section has two other pages which elaborate:
|
Yes. This section has two other pages which elaborate:
|
||||||
- [The Data Value Creation Loop](the-data-value-creation-loop.md) lays out the life cycle of data, and how to focus towards high-value use cases.
|
|
||||||
- [What data is valuable](data-engineers.md) helps think about pricing data.
|
* [The Data Value Creation Loop](the-data-value-creation-loop.md) lays out the life cycle of data, and how to focus towards high-value use cases.
|
||||||
|
* [What data is valuable](data-engineers.md) helps think about pricing data.
|
||||||
|
|
||||||
### Further resources
|
### Further resources
|
||||||
|
|
||||||
The blog post ["How Ocean Can Benefit Data Scientists"](https://blog.oceanprotocol.com/how-ocean-can-benefit-data-scientists-7e502e5f1a5f) elaborates further on the benefits of more data, provenance, and earning.
|
The blog post ["How Ocean Can Benefit Data Scientists"](https://blog.oceanprotocol.com/how-ocean-can-benefit-data-scientists-7e502e5f1a5f) elaborates further on the benefits of more data, provenance, and earning.
|
||||||
|
|
||||||
<figure><img src="../.gitbook/assets/gif/my-data.gif" alt="" width="360"></figure>
|
<figure><img src="../.gitbook/assets/gif/my-data.gif" alt="" width="360"><figcaption></figcaption></figure>
|
||||||
|
@ -1,43 +1,43 @@
|
|||||||
---
|
---
|
||||||
description:
|
|
||||||
cover: ../.gitbook/assets/cover/developer_banner.png
|
cover: ../.gitbook/assets/cover/developer_banner.png
|
||||||
coverY: 0
|
coverY: 0
|
||||||
---
|
---
|
||||||
|
|
||||||
# 👨💻 Developers
|
# 💻 Developers
|
||||||
|
|
||||||
## What can you build with Ocean?
|
## What can you build with Ocean?
|
||||||
|
|
||||||
1. **Token-gated dApps & REST APIs**: monetize by making your dApp or its REST API token-gated. [Here's how](https://github.com/oceanprotocol/token-gating-template).
|
1. **Token-gated dApps & REST APIs**: monetize by making your dApp or its REST API token-gated. [Here's how](https://github.com/oceanprotocol/token-gating-template).
|
||||||
1. **AI dApps**: monetize your AI dApp by token-gating on AI training data, feature vectors, models, or predictions.
|
2. **AI dApps**: monetize your AI dApp by token-gating on AI training data, feature vectors, models, or predictions.
|
||||||
1. **Data Markets**: build a decentralized data market. [Here's how](https://github.com/oceanprotocol/market)
|
3. **Data Markets**: build a decentralized data market. [Here's how](https://github.com/oceanprotocol/market)
|
||||||
1. **Private user profile data**: storing user profile data on your centralized server exposes you to liability. Instead, have it on-chain encrypted by the user's wallet, and just-in-time decrypt for the app. [Video](https://www.youtube.com/watch?v=xTfI8spLq1k&ab_channel=ParticleNetwork), [slides](https://docs.google.com/presentation/d/1_lkDVUkA0Rx1R7RpkaSeLkX3PeOBoMQyRhvxjwTvd6A/edit?usp=sharing).
|
4. **Private user profile data**: storing user profile data on your centralized server exposes you to liability. Instead, have it on-chain encrypted by the user's wallet, and just-in-time decrypt for the app. [Video](https://www.youtube.com/watch?v=xTfI8spLq1k\&ab\_channel=ParticleNetwork), [slides](https://docs.google.com/presentation/d/1\_lkDVUkA0Rx1R7RpkaSeLkX3PeOBoMQyRhvxjwTvd6A/edit?usp=sharing).
|
||||||
|
|
||||||
Example live dapps:
|
Example live dapps:
|
||||||
- **Data Markets**: [Acentrik Market](https://market.acentrik.io/) for enterprises, and [Ocean Market](https://market.oceanprotocol.com) for general.
|
|
||||||
- **Token-gated dapps**: [Autobot](https://autobotocean.com/) for analytics, and [Ocean Waves](https://waves.oceanprotocol.com/) for music.
|
* **Data Markets**: [Acentrik Market](https://market.acentrik.io/) for enterprises, and [Ocean Market](https://market.oceanprotocol.com) for general.
|
||||||
- **Token-gated feeds**: [Ocean Predictoor](https://predictoor.ai) for AI prediction feeds
|
* **Token-gated dapps**: [Autobot](https://autobotocean.com/) for analytics, and [Ocean Waves](https://waves.oceanprotocol.com/) for music.
|
||||||
|
* **Token-gated feeds**: [Ocean Predictoor](https://predictoor.ai) for AI prediction feeds
|
||||||
|
|
||||||
## How do developers start using Ocean?
|
## How do developers start using Ocean?
|
||||||
|
|
||||||
- **App level: [Use an Ocean Template](https://oceanprotocol.com/templates)**.
|
* **App level:** [**Use an Ocean Template**](https://oceanprotocol.com/templates).
|
||||||
- **Library level: [Use ocean.js](ocean.js/README.md)** is a library built for the key environment of dApp developers: JavaScript. Import it & use it your frontend or NodeJS.
|
* **Library level:** [**Use ocean.js**](ocean.js/) is a library built for the key environment of dApp developers: JavaScript. Import it & use it your frontend or NodeJS.
|
||||||
- **Contract level: [Call Ocean contracts](contracts/README.md)** on Eth mainnet [or other chains](../discover/networks/README.md).
|
* **Contract level:** [**Call Ocean contracts**](contracts/) on Eth mainnet [or other chains](../discover/networks/).
|
||||||
|
|
||||||
## Developer Docs Quick-links
|
## Developer Docs Quick-links
|
||||||
|
|
||||||
- [Architecture](architecture.md) - blockchain/contracts layer, middleware, dapps
|
* [Architecture](architecture.md) - blockchain/contracts layer, middleware, dapps
|
||||||
- Earning revenue: [code to get payment](contracts/revenue.md), [fractional $](fractional-ownership.md), [community $](community-monetization.md)
|
* Earning revenue: [code to get payment](contracts/revenue.md), [fractional $](fractional-ownership.md), [community $](community-monetization.md)
|
||||||
- Schemas: [Metadata](metadata.md), [identifiers/DIDs](identifiers.md), [identifier objects/DDOs](ddo-specification.md), [storage](storage.md), [fine-grained permissions](fg-permissions.md)
|
* Schemas: [Metadata](metadata.md), [identifiers/DIDs](identifiers.md), [identifier objects/DDOs](ddo-specification.md), [storage](storage.md), [fine-grained permissions](fg-permissions.md)
|
||||||
- Components:
|
* Components:
|
||||||
- [Barge](barge/README.md) - local chain for testing
|
* [Barge](barge/) - local chain for testing
|
||||||
- [Ocean subgraph](subgraph/README.md) - grabbing event data from the chain
|
* [Ocean subgraph](subgraph/) - grabbing event data from the chain
|
||||||
- [Ocean CLI](ocean-cli/README.md) - command-line interface
|
* [Ocean CLI](ocean-cli/) - command-line interface
|
||||||
- [Compute-to-data](compute-to-data/README.md) - practical privacy approach
|
* [Compute-to-data](compute-to-data/) - practical privacy approach
|
||||||
- [Aquarius](aquarius/README.md) - metadata cache
|
* [Aquarius](aquarius/) - metadata cache
|
||||||
- [Provider](provider/README.md) - handshaking for access control
|
* [Provider](provider/) - handshaking for access control
|
||||||
- [FAQ](dev-faq.md)
|
* [FAQ](dev-faq.md)
|
||||||
|
|
||||||
----
|
***
|
||||||
|
|
||||||
_Next: [Architecture](architecture.md)_
|
_Next:_ [_Architecture_](architecture.md)
|
||||||
|
@ -10,9 +10,9 @@ Embark on an exploration of the innovative realm of Ocean Protocol, where data f
|
|||||||
|
|
||||||
### Layer 1: The Foundational Blockchain Layer
|
### Layer 1: The Foundational Blockchain Layer
|
||||||
|
|
||||||
At the core of Ocean Protocol lies the robust [Blockchain Layer](contracts/README.md). Powered by blockchain technology, this layer ensures secure and transparent transactions. It forms the bedrock of decentralized trust, where data providers and consumers come together to trade valuable assets.
|
At the core of Ocean Protocol lies the robust [Blockchain Layer](contracts/). Powered by blockchain technology, this layer ensures secure and transparent transactions. It forms the bedrock of decentralized trust, where data providers and consumers come together to trade valuable assets.
|
||||||
|
|
||||||
The [smart contracts](contracts/README.md) are deployed on the Ethereum mainnet and other compatible [networks](../discover/networks/README.md). The libraries encapsulate the calls to these smart contracts and provide features like publishing new assets, facilitating consumption, managing pricing, and much more. To explore the contracts in more depth, go ahead to the [contracts](contracts/README.md) section.
|
The [smart contracts](contracts/) are deployed on the Ethereum mainnet and other compatible [networks](../discover/networks/). The libraries encapsulate the calls to these smart contracts and provide features like publishing new assets, facilitating consumption, managing pricing, and much more. To explore the contracts in more depth, go ahead to the [contracts](contracts/) section.
|
||||||
|
|
||||||
### Layer 2: The Empowering Middle Layer
|
### Layer 2: The Empowering Middle Layer
|
||||||
|
|
||||||
@ -20,22 +20,22 @@ Above the smart contracts, you'll find essential [libraries](architecture.md#lib
|
|||||||
|
|
||||||
#### Libraries
|
#### Libraries
|
||||||
|
|
||||||
These libraries include [Ocean.js](ocean.js/README.md), a JavaScript library, and [Ocean.py](../data-scientists/ocean.py/README.md), a Python library. They serve as powerful tools for developers, enabling integration and interaction with the protocol.
|
These libraries include [Ocean.js](ocean.js/), a JavaScript library, and [Ocean.py](../data-scientists/ocean.py/), a Python library. They serve as powerful tools for developers, enabling integration and interaction with the protocol.
|
||||||
|
|
||||||
1. [Ocean.js](ocean.js/README.md): Ocean.js is a JavaScript library that serves as a powerful tool for developers looking to integrate their applications with the Ocean Protocol ecosystem. Designed to facilitate interaction with the protocol, Ocean.js provides a comprehensive set of functionalities, including data tokenization, asset management, and smart contract interaction. Ocean.js simplifies the process of implementing data access controls, building dApps, and exploring data sets within a decentralized environment.
|
1. [Ocean.js](ocean.js/): Ocean.js is a JavaScript library that serves as a powerful tool for developers looking to integrate their applications with the Ocean Protocol ecosystem. Designed to facilitate interaction with the protocol, Ocean.js provides a comprehensive set of functionalities, including data tokenization, asset management, and smart contract interaction. Ocean.js simplifies the process of implementing data access controls, building dApps, and exploring data sets within a decentralized environment.
|
||||||
2. [Ocean.py](../data-scientists/ocean.py/README.md): Ocean.py is a Python library that empowers developers to integrate their applications with the Ocean Protocol ecosystem. With its rich set of functionalities, Ocean.py provides a comprehensive toolkit for interacting with the protocol. Developers and [data scientists](../data-scientists/README.md) can leverage Ocean.py to perform a wide range of tasks, including data tokenization, asset management, and smart contract interactions. This library serves as a bridge between Python and the decentralized world of Ocean Protocol, enabling you to harness the power of decentralized data.
|
2. [Ocean.py](../data-scientists/ocean.py/): Ocean.py is a Python library that empowers developers to integrate their applications with the Ocean Protocol ecosystem. With its rich set of functionalities, Ocean.py provides a comprehensive toolkit for interacting with the protocol. Developers and [data scientists](../data-scientists/) can leverage Ocean.py to perform a wide range of tasks, including data tokenization, asset management, and smart contract interactions. This library serves as a bridge between Python and the decentralized world of Ocean Protocol, enabling you to harness the power of decentralized data.
|
||||||
|
|
||||||
#### Middleware components
|
#### Middleware components
|
||||||
|
|
||||||
Additionally, in supporting the discovery process, middleware components come into play:
|
Additionally, in supporting the discovery process, middleware components come into play:
|
||||||
|
|
||||||
1. [Aquarius](aquarius/README.md): Aquarius acts as a metadata cache, enhancing search efficiency by caching on-chain data into Elasticsearch. By accelerating metadata retrieval, Aquarius enables faster and more efficient data discovery.
|
1. [Aquarius](aquarius/): Aquarius acts as a metadata cache, enhancing search efficiency by caching on-chain data into Elasticsearch. By accelerating metadata retrieval, Aquarius enables faster and more efficient data discovery.
|
||||||
2. [Provider](provider/README.md): The Provider component plays a crucial role in facilitating various operations within the ecosystem. It assists in asset downloading, handles [DDO](ddo-specification.md) (Decentralized Data Object) encryption, and establishes communication with the operator-service for Compute-to-Data jobs. This ensures secure and streamlined interactions between different participants.
|
2. [Provider](provider/): The Provider component plays a crucial role in facilitating various operations within the ecosystem. It assists in asset downloading, handles [DDO](ddo-specification.md) (Decentralized Data Object) encryption, and establishes communication with the operator-service for Compute-to-Data jobs. This ensures secure and streamlined interactions between different participants.
|
||||||
3. [Subgraph](subgraph/README.md): The Subgraph is an off-chain service that utilizes GraphQL to offer efficient access to information related to datatokens, users, and balances. By leveraging the subgraph, data retrieval becomes faster compared to an on-chain query. This enhances the overall performance and responsiveness of applications that rely on accessing this information.
|
3. [Subgraph](subgraph/): The Subgraph is an off-chain service that utilizes GraphQL to offer efficient access to information related to datatokens, users, and balances. By leveraging the subgraph, data retrieval becomes faster compared to an on-chain query. This enhances the overall performance and responsiveness of applications that rely on accessing this information.
|
||||||
|
|
||||||
#### Compute-to-Data
|
#### Compute-to-Data
|
||||||
|
|
||||||
[Compute-to-Data](compute-to-data/README.md) (C2D) represents a groundbreaking paradigm within the Ocean Protocol ecosystem, revolutionizing the way data is processed and analyzed. With C2D, the traditional approach of moving data to the computation is inverted, ensuring privacy and security. Instead, algorithms are securely transported to the data sources, enabling computation to be performed locally, without the need to expose sensitive data. This innovative framework facilitates collaborative data analysis while preserving data privacy, making it ideal for scenarios where data owners want to retain control over their valuable assets. C2D provides a powerful tool for enabling secure and privacy-preserving data analysis and encourages collaboration among data providers, ensuring the utilization of valuable data resources while maintaining strict privacy protocols.
|
[Compute-to-Data](compute-to-data/) (C2D) represents a groundbreaking paradigm within the Ocean Protocol ecosystem, revolutionizing the way data is processed and analyzed. With C2D, the traditional approach of moving data to the computation is inverted, ensuring privacy and security. Instead, algorithms are securely transported to the data sources, enabling computation to be performed locally, without the need to expose sensitive data. This innovative framework facilitates collaborative data analysis while preserving data privacy, making it ideal for scenarios where data owners want to retain control over their valuable assets. C2D provides a powerful tool for enabling secure and privacy-preserving data analysis and encourages collaboration among data providers, ensuring the utilization of valuable data resources while maintaining strict privacy protocols.
|
||||||
|
|
||||||
### Layer 3: The Accessible Application Layer
|
### Layer 3: The Accessible Application Layer
|
||||||
|
|
||||||
@ -45,6 +45,6 @@ Prominently featured within this layer is [Ocean Market](https://market.oceanpro
|
|||||||
|
|
||||||
### Layer 4: The Friendly Wallets
|
### Layer 4: The Friendly Wallets
|
||||||
|
|
||||||
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../user-guides/wallets/README.md), the gateway for users to immerse themselves in the world of decentralized data transactions. These wallets serve as trusted companions, enabling users to seamlessly transact within the ecosystem, purchase and sell data NFTs, and acquire valuable datatokens. For a more detailed exploration of Web 3 Wallets and their capabilities, you can refer to the [wallet intro page](../user-guides/wallets/README.md).
|
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../user-guides/wallets/), the gateway for users to immerse themselves in the world of decentralized data transactions. These wallets serve as trusted companions, enabling users to seamlessly transact within the ecosystem, purchase and sell data NFTs, and acquire valuable datatokens. For a more detailed exploration of Web 3 Wallets and their capabilities, you can refer to the [wallet intro page](../user-guides/wallets/).
|
||||||
|
|
||||||
With the layers of the architecture clearly delineated, the stage is set for a comprehensive exploration of their underlying logic and intricate design. By examining each individually, we can gain a deeper understanding of their unique characteristics and functionalities.
|
With the layers of the architecture clearly delineated, the stage is set for a comprehensive exploration of their underlying logic and intricate design. By examining each individually, we can gain a deeper understanding of their unique characteristics and functionalities.
|
||||||
|
@ -29,14 +29,14 @@ We suggest reading these guides to get an understanding of how compute-to-data w
|
|||||||
|
|
||||||
### User Guides
|
### User Guides
|
||||||
|
|
||||||
* [How to write compute to data algorithms](../../user-guides/compute-to-data/make-a-boss-c2d-algorithm.md)
|
* [How to write compute to data algorithms](broken-reference)
|
||||||
* [How to publish a compute-to-data algorithm](../../user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md)
|
* [How to publish a compute-to-data algorithm](broken-reference)
|
||||||
* [How to publish a dataset for compute to data](../../user-guides/compute-to-data/publish-a-c2d-data-nft.md)
|
* [How to publish a dataset for compute to data](broken-reference)
|
||||||
|
|
||||||
### Developer Guides
|
### Developer Guides
|
||||||
|
|
||||||
* [How to use compute to data with ocean.js](../ocean.js/cod-asset.md)
|
* [How to use compute to data with ocean.js](../ocean.js/cod-asset.md)
|
||||||
* [How to use compute to data with ocean.py](../../data-scientists/ocean.py/README.md)
|
* [How to use compute to data with ocean.py](../../data-scientists/ocean.py/)
|
||||||
|
|
||||||
### Infrastructure Deployment Guides
|
### Infrastructure Deployment Guides
|
||||||
|
|
||||||
|
@ -24,7 +24,7 @@ The interaction between the Consumer and the Provider follows a specific workflo
|
|||||||
Throughout the computation process, the Consumer has the ability to check the status of the job by making a query to the Provider using the `getJobDetails(XXXX)` function, providing the job identifier (`XXXX`) as a reference.
|
Throughout the computation process, the Consumer has the ability to check the status of the job by making a query to the Provider using the `getJobDetails(XXXX)` function, providing the job identifier (`XXXX`) as a reference.
|
||||||
|
|
||||||
{% hint style="info" %}
|
{% hint style="info" %}
|
||||||
You have the option to initiate a compute job using one or more data assets. You can explore this functionality by utilizing the [ocean.py](../../data-scientists/ocean.py/README.md) and [ocean.js](../ocean.js/README.md) libraries.
|
You have the option to initiate a compute job using one or more data assets. You can explore this functionality by utilizing the [ocean.py](../../data-scientists/ocean.py/) and [ocean.js](../ocean.js/) libraries.
|
||||||
{% endhint %}
|
{% endhint %}
|
||||||
|
|
||||||
Now, let's delve into the inner workings of the Provider. Initially, it verifies whether the Consumer has sent the appropriate datatokens to gain access to the desired data. Once validated, the Provider interacts with the Operator-Service, a microservice responsible for coordinating the job execution. The Provider submits a request to the Operator-Service, which subsequently forwards the request to the Operator-Engine, the actual compute system in operation.
|
Now, let's delve into the inner workings of the Provider. Initially, it verifies whether the Consumer has sent the appropriate datatokens to gain access to the desired data. Once validated, the Provider interacts with the Operator-Service, a microservice responsible for coordinating the job execution. The Provider submits a request to the Operator-Service, which subsequently forwards the request to the Operator-Engine, the actual compute system in operation.
|
||||||
@ -46,9 +46,9 @@ Before the flow can begin, these pre-conditions must be met:
|
|||||||
|
|
||||||
### Access Control using Ocean Provider
|
### Access Control using Ocean Provider
|
||||||
|
|
||||||
Similar to the `access service`, the `compute service` within Ocean Protocol relies on the [Ocean Provider](../provider/README.md), which is a crucial component managed by the asset Publishers. The role of the Ocean Provider is to facilitate interactions with users and handle the fundamental aspects of a Publisher's infrastructure, enabling seamless integration into the Ocean Protocol ecosystem. It serves as the primary interface for direct interaction with the infrastructure where the data is located.
|
Similar to the `access service`, the `compute service` within Ocean Protocol relies on the [Ocean Provider](../provider/), which is a crucial component managed by the asset Publishers. The role of the Ocean Provider is to facilitate interactions with users and handle the fundamental aspects of a Publisher's infrastructure, enabling seamless integration into the Ocean Protocol ecosystem. It serves as the primary interface for direct interaction with the infrastructure where the data is located.
|
||||||
|
|
||||||
The [Ocean Provider](../provider/README.md) encompasses the necessary credentials to establish secure and authorized interactions with the underlying infrastructure. Initially, this infrastructure may be hosted in cloud providers, although it also has the flexibility to extend to on-premise environments if required. By encompassing the necessary credentials, the Ocean Provider ensures the smooth and controlled access to the infrastructure, allowing Publishers to effectively leverage the compute service within Ocean Protocol.
|
The [Ocean Provider](../provider/) encompasses the necessary credentials to establish secure and authorized interactions with the underlying infrastructure. Initially, this infrastructure may be hosted in cloud providers, although it also has the flexibility to extend to on-premise environments if required. By encompassing the necessary credentials, the Ocean Provider ensures the smooth and controlled access to the infrastructure, allowing Publishers to effectively leverage the compute service within Ocean Protocol.
|
||||||
|
|
||||||
### Operator Service
|
### Operator Service
|
||||||
|
|
||||||
|
@ -181,8 +181,8 @@ function createNftWithErc20WithDispenser(
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
To make the most of these pricing models, you can rely on user-friendly libraries such as [Ocean.js ](../ocean.js/README.md)and [Ocean.py](../../data-scientists/ocean.py/README.md), specifically developed for interacting with Ocean Protocol.
|
To make the most of these pricing models, you can rely on user-friendly libraries such as [Ocean.js ](../ocean.js/)and [Ocean.py](../../data-scientists/ocean.py/), specifically developed for interacting with Ocean Protocol.
|
||||||
|
|
||||||
With Ocean.js, you can use the [createFRE() ](../ocean.js/publish.md)function to effortlessly deploy a data NFT (non-fungible token) and datatoken with a fixed-rate exchange pricing model. Similarly, in Ocean.py, the [create\_url\_asset()](../../data-scientists/ocean.py/publish-flow.md#create-an-asset--pricing-schema-simultaneously) function allows you to create an asset with fixed pricing. These libraries simplify the process of interacting with Ocean Protocol, managing pricing, and handling asset creation.
|
With Ocean.js, you can use the [createFRE() ](../ocean.js/publish.md)function to effortlessly deploy a data NFT (non-fungible token) and datatoken with a fixed-rate exchange pricing model. Similarly, in Ocean.py, the [create\_url\_asset()](../../data-scientists/ocean.py/publish-flow.md#create-an-asset--pricing-schema-simultaneously) function allows you to create an asset with fixed pricing. These libraries simplify the process of interacting with Ocean Protocol, managing pricing, and handling asset creation.
|
||||||
|
|
||||||
By taking advantage of Ocean Protocol's pricing options and leveraging the capabilities of [Ocean.js](../ocean.js/README.md) and [Ocean.py](../../data-scientists/ocean.py/README.md) (or by using the [Market](https://market.oceanprotocol.com)), you can effectively monetize your data assets while ensuring transparent and seamless access for data consumers.
|
By taking advantage of Ocean Protocol's pricing options and leveraging the capabilities of [Ocean.js](../ocean.js/) and [Ocean.py](../../data-scientists/ocean.py/) (or by using the [Market](https://market.oceanprotocol.com)), you can effectively monetize your data assets while ensuring transparent and seamless access for data consumers.
|
||||||
|
@ -20,7 +20,7 @@ In the case of [ERC20TemplateEnterprise](datatoken-templates.md#enterprise-templ
|
|||||||
On the other hand, with [ERC20Template](datatoken-templates.md#regular-template), for a fixed rate exchange, the revenue is available at the fixed rate exchange level. The owner or the payment collector has the authority to manually retrieve the revenue.
|
On the other hand, with [ERC20Template](datatoken-templates.md#regular-template), for a fixed rate exchange, the revenue is available at the fixed rate exchange level. The owner or the payment collector has the authority to manually retrieve the revenue.
|
||||||
{% endhint %}
|
{% endhint %}
|
||||||
|
|
||||||
There are several methods available for establishing a new **payment collector**. You have the option to utilize the ERC20Template/ERC20TemplateEnterprise contract directly. Another approach is to leverage the [ocean.py](../../data-scientists/ocean.py/README.md) and [ocean.js](../ocean.js/README.md) libraries. Alternatively, you can employ the network explorer associated with your asset. Lastly, you can directly set it up within the Ocean Market.
|
There are several methods available for establishing a new **payment collector**. You have the option to utilize the ERC20Template/ERC20TemplateEnterprise contract directly. Another approach is to leverage the [ocean.py](../../data-scientists/ocean.py/) and [ocean.js](../ocean.js/) libraries. Alternatively, you can employ the network explorer associated with your asset. Lastly, you can directly set it up within the Ocean Market.
|
||||||
|
|
||||||
Here are some examples of how to set up a new payment collector using the mentioned methods:
|
Here are some examples of how to set up a new payment collector using the mentioned methods:
|
||||||
|
|
||||||
@ -33,7 +33,7 @@ paymentCollectorAddress = 'New payment collector address'
|
|||||||
await datatoken.setPaymentCollector(datatokenAddress, callerAddress, paymentCollectorAddress)
|
await datatoken.setPaymentCollector(datatokenAddress, callerAddress, paymentCollectorAddress)
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Using [Ocean.py](https://github.com/oceanprotocol/ocean.py/blob/bad11fb3a4cb00be8bab8febf3173682e1c091fd/ocean_lib/models/test/test_datatoken.py#L39).
|
2. Using [Ocean.py](https://github.com/oceanprotocol/ocean.py/blob/bad11fb3a4cb00be8bab8febf3173682e1c091fd/ocean\_lib/models/test/test\_datatoken.py#L39).
|
||||||
|
|
||||||
```python
|
```python
|
||||||
datatokenAddress = 'Your datatoken address'
|
datatokenAddress = 'Your datatoken address'
|
||||||
|
@ -23,7 +23,7 @@ The NFT owner is the owner of the base-IP and is therefore at the highest level.
|
|||||||
With the exception of the NFT owner role, all other roles can be assigned to multiple users.
|
With the exception of the NFT owner role, all other roles can be assigned to multiple users.
|
||||||
{% endhint %}
|
{% endhint %}
|
||||||
|
|
||||||
There are several methods available to assign roles and permissions. One option is to utilize the [ocean.py](../../data-scientists/ocean.py/README.md) and [ocean.js](../ocean.js/README.md) libraries that we provide. These libraries offer a streamlined approach for assigning roles and permissions programmatically.
|
There are several methods available to assign roles and permissions. One option is to utilize the [ocean.py](../../data-scientists/ocean.py/) and [ocean.js](../ocean.js/) libraries that we provide. These libraries offer a streamlined approach for assigning roles and permissions programmatically.
|
||||||
|
|
||||||
Alternatively, for a more straightforward solution that doesn't require coding, you can utilize the network explorer of your asset's network. By accessing the network explorer, you can directly interact with the contracts associated with your asset. Below, we provide a few examples to help guide you through the process.
|
Alternatively, for a more straightforward solution that doesn't require coding, you can utilize the network explorer of your asset's network. By accessing the network explorer, you can directly interact with the contracts associated with your asset. Below, we provide a few examples to help guide you through the process.
|
||||||
|
|
||||||
@ -63,7 +63,6 @@ function removeManager(address _managerAddress) external onlyNFTOwner {
|
|||||||
The **manager** can assign or revoke three main roles (**deployer, metadata updater, and store updater**). The manager is also able to call any other contract (ERC725X implementation).
|
The **manager** can assign or revoke three main roles (**deployer, metadata updater, and store updater**). The manager is also able to call any other contract (ERC725X implementation).
|
||||||
|
|
||||||
{% embed url="https://app.arcade.software/share/qC8QpkLsFIQk3NxPzB8p" fullWidth="false" %}
|
{% embed url="https://app.arcade.software/share/qC8QpkLsFIQk3NxPzB8p" fullWidth="false" %}
|
||||||
{% endembed %}
|
|
||||||
|
|
||||||
### Metadata Updater
|
### Metadata Updater
|
||||||
|
|
||||||
@ -294,7 +293,6 @@ function removeMinter(address _minter) external onlyERC20Deployer {
|
|||||||
</details>
|
</details>
|
||||||
|
|
||||||
{% embed url="https://app.arcade.software/share/OHlwsPbf29S1PLh03FM7" fullWidth="false" %}
|
{% embed url="https://app.arcade.software/share/OHlwsPbf29S1PLh03FM7" fullWidth="false" %}
|
||||||
{% endembed %}
|
|
||||||
|
|
||||||
### Fee Manager
|
### Fee Manager
|
||||||
|
|
||||||
|
@ -1,22 +1,22 @@
|
|||||||
---
|
---
|
||||||
description: >-
|
description: >-
|
||||||
CLI tool to interact with the oceanprotocol's JavaScript library to privately & securely publish, consume and run compute on data.
|
CLI tool to interact with the oceanprotocol's JavaScript library to privately
|
||||||
|
& securely publish, consume and run compute on data.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Ocean CLI 🌊
|
# Ocean CLI
|
||||||
|
|
||||||
Welcome to the Ocean CLI, your powerful command-line tool for seamless interaction with Ocean Protocol's data-sharing capabilities. 🚀
|
Welcome to the Ocean CLI, your powerful command-line tool for seamless interaction with Ocean Protocol's data-sharing capabilities. 🚀
|
||||||
|
|
||||||
The Ocean CLI offers a wide range of functionalities, enabling you to:
|
The Ocean CLI offers a wide range of functionalities, enabling you to:
|
||||||
|
|
||||||
- [**Publish**](./publish.md) 📤 data services: downloadable files or compute-to-data.
|
* [**Publish**](publish.md) 📤 data services: downloadable files or compute-to-data.
|
||||||
- [**Edit**](./edit.md) ✏️ existing assets.
|
* [**Edit**](edit.md) ✏️ existing assets.
|
||||||
- [**Consume**](./consume.md) 📥 data services, ordering datatokens and downloading data.
|
* [**Consume**](consume.md) 📥 data services, ordering datatokens and downloading data.
|
||||||
- [**Compute to Data**](./run-c2d.md) 💻 on public available datasets using a published algorithm.
|
* [**Compute to Data**](run-c2d.md) 💻 on public available datasets using a published algorithm.
|
||||||
|
|
||||||
## Key Information
|
## Key Information
|
||||||
|
|
||||||
The Ocean CLI is powered by the [ocean.js](../ocean.js/README.md) JavaScript library, an integral part of the [Ocean Protocol](https://oceanprotocol.com) toolset. 🌐
|
The Ocean CLI is powered by the [ocean.js](../ocean.js/) JavaScript library, an integral part of the [Ocean Protocol](https://oceanprotocol.com) toolset. 🌐
|
||||||
|
|
||||||
Let's dive into the CLI's capabilities and unlock the full potential of Ocean Protocol together! If you're ready to explore each functionality in detail, simply go through the next pages.
|
Let's dive into the CLI's capabilities and unlock the full potential of Ocean Protocol together! If you're ready to explore each functionality in detail, simply go through the next pages.
|
||||||
|
|
||||||
|
57
developers/retrieve-datatoken-address.md
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
---
|
||||||
|
description: >-
|
||||||
|
Use these steps to reveal the information contained within an asset's DID and
|
||||||
|
list the buyers of a datatoken
|
||||||
|
---
|
||||||
|
|
||||||
|
# Retrieve datatoken/data NFT addresses & Chain ID
|
||||||
|
|
||||||
|
### How to find the network, datatoken address, and data NFT address from an Ocean Market link?
|
||||||
|
|
||||||
|
If you are given an Ocean Market link, then the network and datatoken address for the asset is visible on the Ocean Market webpage. For example, given this asset's Ocean Market link: [https://odc.oceanprotocol.com/asset/did:op:1b26eda361c6b6d307c8a139c4aaf36aa74411215c31b751cad42e59881f92c1](https://odc.oceanprotocol.com/asset/did:op:1b26eda361c6b6d307c8a139c4aaf36aa74411215c31b751cad42e59881f92c1) the webpage shows that this asset is hosted on the Mumbai network, and one simply clicks the datatoken's hyperlink to reveal the datatoken's address as shown in the screenshot below:
|
||||||
|
|
||||||
|
<figure><img src="../.gitbook/assets/market/marketplace_data.jpg" alt="" width="563"><figcaption><p>See the Network and Datatoken Address for an Ocean Market asset by visiting the asset's Ocean Market page.</p></figcaption></figure>
|
||||||
|
|
||||||
|
#### More Detailed Info:
|
||||||
|
|
||||||
|
You can access all the information for the Ocean Market asset also by **enabling Debug mode**. To do this, follow these steps:
|
||||||
|
|
||||||
|
**Step 1** - Click the Settings button in the top right corner of the Ocean Market
|
||||||
|
|
||||||
|
<figure><img src="../.gitbook/assets/market/Click-Settings.png" alt=""><figcaption><p>Click the Settings button</p></figcaption></figure>
|
||||||
|
|
||||||
|
**Step 2** - Check the Activate Debug Mode box in the dropdown menu
|
||||||
|
|
||||||
|
<figure><img src="../.gitbook/assets/market/Check-Debug-Mode.png" alt=""><figcaption><p>Check 'Active Debug Mode'</p></figcaption></figure>
|
||||||
|
|
||||||
|
**Step 3** - Go to the page for the asset you would like to examine, and scroll through the DDO information to find the NFT address, datatoken address, chain ID, and other information.
|
||||||
|
|
||||||
|
<figure><img src="../.gitbook/assets/market/Scroll-DDO-Info.png" alt=""><figcaption></figcaption></figure>
|
||||||
|
|
||||||
|
### How to use Aquarius to find the chainID and datatoken address from a DID?
|
||||||
|
|
||||||
|
If you know the DID:op but you don't know the source link, then you can use Ocean Aquarius to resolve the metadata for the DID:op to find the `chainId`+ `datatoken address` of the asset. Simply enter in your browser "[https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/ddo/](https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/ddo/did:op:1b26eda361c6b6d307c8a139c4aaf36aa74411215c31b751cad42e59881f92c1)\<your did:op:XXX>" to fetch the metadata.
|
||||||
|
|
||||||
|
For example, for the following DID:op: "did:op:1b26eda361c6b6d307c8a139c4aaf36aa74411215c31b751cad42e59881f92c1" the Ocean Aquarius URL can be modified to add the DID:op and resolve its metadata. Simply add "[https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/ddo/](https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/ddo/did:op:1b26eda361c6b6d307c8a139c4aaf36aa74411215c31b751cad42e59881f92c1)" to the beginning of the DID:op and enter the link in your browser like this: [https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/ddo/did:op:1b26eda361c6b6d307c8a139c4aaf36aa74411215c31b751cad42e59881f92c1](https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/ddo/did:op:1b26eda361c6b6d307c8a139c4aaf36aa74411215c31b751cad42e59881f92c1)
|
||||||
|
|
||||||
|
<figure><img src="../.gitbook/assets/market/network-and-datatoken-address.png" alt=""><figcaption><p>The metadata printout for this DID:op with the network's Chain ID and datatoken address circled in red</p></figcaption></figure>
|
||||||
|
|
||||||
|
Here are the networks and their corresponding chain IDs:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"mumbai: 80001"
|
||||||
|
"polygon: 137"
|
||||||
|
"bsc: 56"
|
||||||
|
"energyweb: 246"
|
||||||
|
"moonriver: 1285"
|
||||||
|
"mainnet: 1"
|
||||||
|
"goerli: 5"
|
||||||
|
"polygonedge: 81001"
|
||||||
|
"gaiaxtestnet: 2021000"
|
||||||
|
"alfajores: 44787"
|
||||||
|
"gen-x-testnet: 100"
|
||||||
|
"filecointestnet: 3141"
|
||||||
|
"oasis_saphire_testnet: 23295"
|
||||||
|
"development: 8996"
|
||||||
|
```
|
||||||
|
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
description:
|
|
||||||
cover: ../.gitbook/assets/cover/discover_banner.png
|
cover: ../.gitbook/assets/cover/discover_banner.png
|
||||||
coverY: 7.413145539906106
|
coverY: 7.413145539906106
|
||||||
---
|
---
|
||||||
@ -8,30 +7,30 @@ coverY: 7.413145539906106
|
|||||||
|
|
||||||
Ocean's mission is to level the playing field for AI and data.
|
Ocean's mission is to level the playing field for AI and data.
|
||||||
|
|
||||||
How? **By helping _you_ monetize AI models and data, while preserving privacy.**
|
How? **By helping **_**you**_** monetize AI models and data, while preserving privacy.**
|
||||||
|
|
||||||
Ocean is a decentralized data exchange protocol to drive AI. Its core tech is:
|
Ocean is a decentralized data exchange protocol to drive AI. 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
|
* 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
|
* [**Developers**](../developers/)**.** Build token-gated AI dApps & APIs
|
||||||
- **[Data scientists](../data-scientists/README.md).** Earn via predictions & challenges
|
* [**Data scientists**](../data-scientists/)**.** Earn via predictions & challenges
|
||||||
- **[OCEAN holders](../data-farming/README.md).** Get rewards by locking OCEAN & curating data, via Data Farming.
|
* [**OCEAN holders**](../data-farming/)**.** 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
|
### Quick Links
|
||||||
|
|
||||||
- [Why Ocean?](why-ocean.md) and [What is Ocean?](what-is-ocean.md)
|
* [Why Ocean?](why-ocean.md) and [What is Ocean?](what-is-ocean.md)
|
||||||
- [What can you do with Ocean?](benefits.md)
|
* [What can you do with Ocean?](benefits.md)
|
||||||
- [OCEAN: The Ocean token](ocean-token.md)
|
* [OCEAN: The Ocean token](ocean-token.md)
|
||||||
- [Networks](networks/README.md), [Bridges](networks/bridges.md)
|
* [Networks](networks/), [Bridges](networks/bridges.md)
|
||||||
- [FAQ](faq.md), [Glossary](glossary.md)
|
* [FAQ](faq.md), [Glossary](glossary.md)
|
||||||
|
|
||||||
----
|
***
|
||||||
|
|
||||||
_Next: [Why Ocean?](why-ocean.md)_
|
_Next:_ [_Why Ocean?_](why-ocean.md)
|
||||||
|
|
||||||
_Back: [Docs main](../README.md)_
|
|
||||||
|
|
||||||
|
_Back:_ [_Docs main_](../)
|
||||||
|
@ -1,118 +1,116 @@
|
|||||||
---
|
|
||||||
description:
|
|
||||||
---
|
|
||||||
|
|
||||||
# What can you do with Ocean?
|
# What can you do with Ocean?
|
||||||
|
|
||||||
This page shows things you can do with Ocean...
|
This page shows things you can do with Ocean...
|
||||||
- As a builder
|
|
||||||
- As a data scientist
|
* As a builder
|
||||||
- As an OCEAN holder
|
* As a data scientist
|
||||||
- Become an Ocean ambassador
|
* As an OCEAN holder
|
||||||
|
* Become an Ocean ambassador
|
||||||
|
|
||||||
Let's explore each...
|
Let's explore each...
|
||||||
|
|
||||||
## What builders can do
|
## What builders can do
|
||||||
|
|
||||||
<div align="center"><figure><img src="../.gitbook/assets/general/dapps.png" width="75%"></figure></div>
|
<div align="center">
|
||||||
|
|
||||||
|
<figure><img src="../.gitbook/assets/general/dapps.png" alt="" width="75%"><figcaption></figcaption></figure>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
||||||
<summary><mark style="color:black;">Build Your Token-gated AI dApp</mark></summary>
|
<summary>Build Your Token-gated AI dApp</summary>
|
||||||
|
|
||||||
Monetize by making your dApp token-gated. Users no longer have to use credit cards or manage OAuth credentials. Rather, they buy & spend ERC20 datatokens to access your dApp content.
|
Monetize by making your dApp token-gated. Users no longer have to use credit cards or manage OAuth credentials. Rather, they buy & spend ERC20 datatokens to access your dApp content.
|
||||||
|
|
||||||
Go further yet: rather than storing user profile data on your centralized server -- which exposes you to liability -- have it on-chain encrypted by the user's wallet, and just-in-time decrypt for the app.
|
Go further yet: rather than storing user profile data on your centralized server -- which exposes you to liability -- have it on-chain encrypted by the user's wallet, and just-in-time decrypt for the app.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
||||||
<summary><mark style="color:black;">Build Your Token-gated REST API</mark></summary>
|
<summary>Build Your Token-gated REST API</summary>
|
||||||
|
|
||||||
Focus on the backend: make a Web3-native REST API. Like the token-gated dApps, consumers of the REST API buy access with crypto, not credit cards.
|
Focus on the backend: make a Web3-native REST API. Like the token-gated dApps, consumers of the REST API buy access with crypto, not credit cards.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
||||||
<summary><mark style="color:black;">Build Your Data Market</mark></summary>
|
<summary>Build Your Data Market</summary>
|
||||||
|
|
||||||
Build a decentralized data marketplace by [forking Ocean Market code](../developers/build-a-marketplace/) to quickly get something good, or by building up from Ocean components for a more custom look.
|
Build a decentralized data marketplace by [forking Ocean Market code](../developers/build-a-marketplace/) to quickly get something good, or by building up from Ocean components for a more custom look.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
To dive deeper, please go to [Developers page](../developers/README.md).
|
To dive deeper, please go to [Developers page](../developers/).
|
||||||
|
|
||||||
|
|
||||||
## What data scientists can do
|
## What data scientists can do
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<figure><img src="../.gitbook/assets/predictoor/predictoor_ui_crop.png"></figure>
|
|
||||||
|
<figure><img src="../.gitbook/assets/predictoor/predictoor_ui_crop.png" alt=""><figcaption></figcaption></figure>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
||||||
<summary><mark style="color:black;">Use Ocean in Python</mark></summary>
|
<summary>Use Ocean in Python</summary>
|
||||||
|
|
||||||
The **[ocean.py](../data-scientists/ocean.py/README.md)** library is built for the key environment of data scientists: Python. Use it to earn $ from your data, share your data, get more data from others, and see provenance of data usage.
|
The [**ocean.py**](../data-scientists/ocean.py/) library is built for the key environment of data scientists: Python. Use it to earn $ from your data, share your data, get more data from others, and see provenance of data usage.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
||||||
<summary><mark style="color:black;">Do crypto price predictions</mark></summary>
|
<summary>Do crypto price predictions</summary>
|
||||||
|
|
||||||
With [Ocean Predictoor](../predictoor/README.md), you submit predictions for the future price of BTC, ETH etc, and earn. The more accurate your predictions, the more $ you can earn.
|
With [Ocean Predictoor](../predictoor/), you submit predictions for the future price of BTC, ETH etc, and earn. The more accurate your predictions, the more $ you can earn.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
||||||
<summary><mark style="color:black;">Compete in a Data Challenge</mark></summary>
|
<summary>Compete in a Data Challenge</summary>
|
||||||
|
|
||||||
Ocean regularly offer [data science challenges](../data-scientists/join-a-data-challenge.md) on real-world problems. Showcase your skills, and earn $ prizes.
|
Ocean regularly offer [data science challenges](../data-scientists/join-a-data-challenge.md) on real-world problems. Showcase your skills, and earn $ prizes.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
To dive deeper, please go to [Data Scientists page](../data-scientists/README.md).
|
To dive deeper, please go to [Data Scientists page](../data-scientists/).
|
||||||
|
|
||||||
|
|
||||||
## What OCEAN holders can do
|
## What OCEAN holders can do
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
|
||||||
<summary><mark style="color:black;">Earn Rewards via Data Farming</mark></summary>
|
<summary>Earn Rewards via Data Farming</summary>
|
||||||
|
|
||||||
Ocean's [Data Farming](../data-farming/README.md) incentives program enables OCEAN holders to earn by locking OCEAN, and curating data.
|
Ocean's [Data Farming](../data-farming/) incentives program enables OCEAN holders to earn by locking OCEAN, and curating data.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
## Become an Ocean Ambassador
|
## Become an Ocean Ambassador
|
||||||
|
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><mark style="color:black;">Become an Ambassador</mark></summary>
|
|
||||||
|
<summary>Become an Ambassador</summary>
|
||||||
|
|
||||||
As an ambassador, you are an advocate for the protocol, promoting its vision and mission. By sharing your knowledge and enthusiasm, you can educate others about the benefits of Ocean Protocol, inspiring them to join the ecosystem. As part of a global community of like-minded individuals, you gain access to exclusive resources, networking opportunities, and collaborations that further enhance your expertise in the data economy. Of course, the Ocean Protocol Ambassador Program rewards contributors with weekly bounties and discretionary grants for growing the Ocean Protocol communtiy worldwide.
|
As an ambassador, you are an advocate for the protocol, promoting its vision and mission. By sharing your knowledge and enthusiasm, you can educate others about the benefits of Ocean Protocol, inspiring them to join the ecosystem. As part of a global community of like-minded individuals, you gain access to exclusive resources, networking opportunities, and collaborations that further enhance your expertise in the data economy. Of course, the Ocean Protocol Ambassador Program rewards contributors with weekly bounties and discretionary grants for growing the Ocean Protocol communtiy worldwide.
|
||||||
|
|
||||||
Follow the steps below to become an ambassador:
|
Follow the steps below to become an ambassador:
|
||||||
|
|
||||||
To become a member of the Ambassador Program, follow these steps:
|
To become a member of the Ambassador Program, follow these steps:
|
||||||
|
|
||||||
1. Join Ocean Protocol's [Discord](https://discord.com/invite/TnXjkR5) server
|
1. Join Ocean Protocol's [Discord](https://discord.com/invite/TnXjkR5) server
|
||||||
2. Join the Discord channel called #treasure-hunter.
|
2. Join the Discord channel called #treasure-hunter.
|
||||||
3. Access the application form: "[Apply](https://discord.com/channels/612953348487905282/1133478278531911790) to use this channel."
|
3. Access the application form: "[Apply](https://discord.com/channels/612953348487905282/1133478278531911790) to use this channel."
|
||||||
4. Answer the questions in the application form.
|
4. Answer the questions in the application form.
|
||||||
5. Once you've completed the application process, you can start earning experience points (XP) by actively engaging in discussions on various topics related to the Ocean Protocol.
|
5. Once you've completed the application process, you can start earning experience points (XP) by actively engaging in discussions on various topics related to the Ocean Protocol.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
----
|
_Next:_ [_OCEAN: The Ocean token_](ocean-token.md)
|
||||||
|
|
||||||
_Next: [OCEAN: The Ocean token](ocean-token.md)_
|
_Back:_ [_What is Ocean?_](what-is-ocean.md)
|
||||||
|
|
||||||
_Back: [What is Ocean?](what-is-ocean.md)_
|
|
||||||
|
@ -2,7 +2,8 @@
|
|||||||
description: Run AI-powered prediction bots or trading bots on crypto price feeds to earn $
|
description: Run AI-powered prediction bots or trading bots on crypto price feeds to earn $
|
||||||
---
|
---
|
||||||
|
|
||||||
**Predictoor docs are now at [docs.predictoor.ai](https://docs.predictoor.ai).**
|
# 👀 Predictoor
|
||||||
|
|
||||||
<figure><img src="../.gitbook/assets/cover/predictoor_banner.png" alt=""></figure>
|
**Predictoor docs are now at** [**docs.predictoor.ai**](https://docs.predictoor.ai)**.**
|
||||||
|
|
||||||
|
<figure><img src="../.gitbook/assets/cover/predictoor_banner.png" alt=""><figcaption></figcaption></figure>
|
||||||
|