From 195f1169bc955e8a5c7fa53f732173d2f2de4830 Mon Sep 17 00:00:00 2001 From: Jamie Hewitt Date: Mon, 17 Jun 2024 12:34:26 +0000 Subject: [PATCH] GITBOOK-3: Deleting C2D section --- README.md | 73 +----- SUMMARY.md | 231 +++++++++--------- data-farming/README.md | 42 ++-- data-farming/apys/README.md | 2 + data-farming/apys/estimated-apy-vs-time.md | 2 + data-farming/apys/guide-to-estimating-apy.md | 2 + data-farming/claim-rewards.md | 2 + data-farming/passive-df-and-veocean/README.md | 2 + .../guide-to-passive-df.md | 2 + .../passive-df-and-veocean/liquid-staking.md | 2 + data-farming/reward-schedule.md | 2 + data-farming/volume-df/README.md | 2 + .../volume-df/delegation-in-volume-df.md | 2 + data-farming/volume-df/guide-to-volume-df.md | 2 + data-scientists/README.md | 23 +- developers/README.md | 48 ++-- developers/architecture.md | 20 +- developers/compute-to-data/README.md | 8 +- .../compute-to-data-architecture.md | 6 +- developers/contracts/pricing-schemas.md | 4 +- developers/contracts/revenue.md | 4 +- developers/contracts/roles.md | 4 +- developers/ocean-cli/README.md | 16 +- discover/README.md | 33 ++- discover/benefits.md | 74 +++--- predictoor/README.md | 5 +- user-guides/README.md | 27 +- user-guides/compute-to-data/README.md | 24 -- .../make-a-boss-c2d-algorithm.md | 98 -------- .../publish-a-c2d-algorithm-nft.md | 63 ----- .../compute-to-data/publish-a-c2d-data-nft.md | 91 ------- 31 files changed, 293 insertions(+), 623 deletions(-) create mode 100644 data-farming/apys/README.md create mode 100644 data-farming/apys/estimated-apy-vs-time.md create mode 100644 data-farming/apys/guide-to-estimating-apy.md create mode 100644 data-farming/claim-rewards.md create mode 100644 data-farming/passive-df-and-veocean/README.md create mode 100644 data-farming/passive-df-and-veocean/guide-to-passive-df.md create mode 100644 data-farming/passive-df-and-veocean/liquid-staking.md create mode 100644 data-farming/reward-schedule.md create mode 100644 data-farming/volume-df/README.md create mode 100644 data-farming/volume-df/delegation-in-volume-df.md create mode 100644 data-farming/volume-df/guide-to-volume-df.md delete mode 100644 user-guides/compute-to-data/README.md delete mode 100644 user-guides/compute-to-data/make-a-boss-c2d-algorithm.md delete mode 100644 user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md delete mode 100644 user-guides/compute-to-data/publish-a-c2d-data-nft.md diff --git a/README.md b/README.md index 585e93e3..833b7dfd 100644 --- a/README.md +++ b/README.md @@ -3,73 +3,6 @@ description: Help for wherever you are on your Ocean Protocol journey. layout: landing --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
discoverLearn how Ocean Protocol transforms data sharing and monetization with its powerful Web3 open source tools.discoverdiscover_card.png
user-guidesFollow the step-by-step instructions for a no-code solution to unleash the power of Ocean Protocol technologies!user-guidesuser_guides_card.png
developersFind APIs, libraries, and other tools to build awesome dApps or integrate with the Ocean Protocol ecosystem.developersdeveloper_card.png
data-scientistsEarn $ from AI models, track provenance, get more data.data-scientistsdata_scientists_card.png
predictoorRun AI-powered prediction bots or trading bots to earn $.predictoorpredictoor_card.jpg
infrastructureFor software architects and developers - deploy your own components in Ocean Protocol ecosystem.infrastructureinfrastructure_card.png
contributeGet involved! Learn how to contribute to Ocean Protocol.contributecontribute_card.png
+# ๐Ÿ‘‹ Ocean docs + +
discoverLearn how Ocean Protocol transforms data sharing and monetization with its powerful Web3 open source tools.discoverdiscover_card.png
user-guidesFollow the step-by-step instructions for a no-code solution to unleash the power of Ocean Protocol technologies!user-guidesuser_guides_card.png
developersFind APIs, libraries, and other tools to build awesome dApps or integrate with the Ocean Protocol ecosystem.developersdeveloper_card.png
data-scientistsEarn $ from AI models, track provenance, get more data.data-scientistsdata_scientists_card.png
predictoorRun AI-powered prediction bots or trading bots to earn $.predictoorpredictoor_card.jpg
infrastructureFor software architects and developers - deploy your own components in Ocean Protocol ecosystem.infrastructureinfrastructure_card.png
contributeGet involved! Learn how to contribute to Ocean Protocol.contributecontribute_card.png
diff --git a/SUMMARY.md b/SUMMARY.md index a3aef554..5707c28f 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,127 +1,124 @@ # Table of contents -- [Ocean docs](README.md) -- [๐ŸŒŠ Discover Ocean](discover/README.md) - - [Why Ocean?](discover/why-ocean.md) - - [What is Ocean?](discover/what-is-ocean.md) - - [What can you do with Ocean?](discover/benefits.md) - - [OCEAN: The Ocean token](discover/ocean-token.md) - - [Networks](discover/networks/README.md) - - [Network Bridges](discover/networks/bridges.md) - - [FAQ](discover/faq.md) - - [Glossary](discover/glossary.md) -- [๐Ÿ“š User Guides](user-guides/README.md) - - [Basic concepts](user-guides/basic-concepts.md) - - [Using Wallets](user-guides/wallets/README.md) - - [Set Up MetaMask](user-guides/wallets/metamask-setup.md) - - [Manage Your OCEAN](user-guides/wallets/wallets-and-ocean.md) - - [Compute-to-Data in Ocean Market](user-guides/compute-to-data/README.md) - - [Make a Boss C2D Algorithm](user-guides/compute-to-data/make-a-boss-c2d-algorithm.md) - - [Publish a C2D Algorithm NFT](user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md) - - [Publish a C2D Data NFT](user-guides/compute-to-data/publish-a-c2d-data-nft.md) - - [Host Assets](user-guides/asset-hosting/README.md) - - [Uploader](user-guides/asset-hosting/uploader.md) - - [Arweave](user-guides/asset-hosting/arweave.md) - - [AWS](user-guides/asset-hosting/aws.md) - - [Azure Cloud](user-guides/asset-hosting/azure-cloud.md) - - [Google Storage](user-guides/asset-hosting/google-storage.md) - - [Github](user-guides/asset-hosting/github.md) - - [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md) -- [๐Ÿ’ป Developers](developers/README.md) - - [Architecture Overview](developers/architecture.md) - - [Contracts](developers/contracts/README.md) - - [Data NFTs](developers/contracts/data-nfts.md) - - [Datatokens](developers/contracts/datatokens.md) - - [Data NFTs and Datatokens](developers/contracts/datanft-and-datatoken.md) - - [Datatoken Templates](developers/contracts/datatoken-templates.md) - - [Roles](developers/contracts/roles.md) - - [Pricing Schemas](developers/contracts/pricing-schemas.md) - - [Fees](developers/contracts/fees.md) - - [Revenue](developers/contracts/revenue.md) - - [Fractional Ownership](developers/fractional-ownership.md) - - [Community Monetization](developers/community-monetization.md) - - [Metadata](developers/metadata.md) - - [Identifiers (DIDs)](developers/identifiers.md) - - [DDO Specification](developers/ddo-specification.md) - - [Storage Specifications](developers/storage.md) - - [Fine-Grained Permissions](developers/fg-permissions.md) - - [Retrieve datatoken/data NFT addresses & Chain ID](developers/retrieve-datatoken-address.md) - - [Get API Keys for Blockchain Access](developers/get-api-keys-for-blockchain-access.md) - - [Barge](developers/barge/README.md) - - [Local Setup](developers/barge/local-setup-ganache.md) - - [Subgraph](developers/subgraph/README.md) - - [Get data NFTs](developers/subgraph/list-data-nfts.md) - - [Get data NFT information](developers/subgraph/get-data-nft-information.md) - - [Get datatokens](developers/subgraph/list-datatokens.md) - - [Get datatoken information](developers/subgraph/get-datatoken-information.md) - - [Get datatoken buyers](developers/subgraph/get-datatoken-buyers.md) - - [Get fixed-rate exchanges](developers/subgraph/list-fixed-rate-exchanges.md) - - [Get veOCEAN stats](developers/subgraph/get-veocean-stats.md) - - [Ocean.js](developers/ocean.js/README.md) - - [Configuration](developers/ocean.js/configuration.md) - - [Creating a data NFT](developers/ocean.js/creating-datanft.md) - - [Publish](developers/ocean.js/publish.md) - - [Mint Datatokens](developers/ocean.js/mint-datatoken.md) - - [Update Metadata](developers/ocean.js/update-metadata.md) - - [Asset Visibility](developers/ocean.js/asset-visibility.md) - - [Consume Asset](developers/ocean.js/consume-asset.md) - - [Run C2D Jobs](developers/ocean.js/cod-asset.md) - - [Ocean CLI](developers/ocean-cli/README.md) - - [Install](developers/ocean-cli/install.md) - - [Publish](developers/ocean-cli/publish.md) - - [Edit](developers/ocean-cli/edit.md) - - [Consume](developers/ocean-cli/consume.md) - - [Run C2D Jobs](developers/ocean-cli/run-c2d.md) - - [Compute to data](developers/compute-to-data/README.md) - - [Architecture](developers/compute-to-data/compute-to-data-architecture.md) - - [Datasets & Algorithms](developers/compute-to-data/compute-to-data-datasets-algorithms.md) - - [Workflow](developers/compute-to-data/compute-workflow.md) - - [Writing Algorithms](developers/compute-to-data/compute-to-data-algorithms.md) - - [Compute Options](developers/compute-to-data/compute-options.md) - - [Aquarius](developers/aquarius/README.md) - - [Asset Requests](developers/aquarius/asset-requests.md) - - [Chain Requests](developers/aquarius/chain-requests.md) - - [Other Requests](developers/aquarius/other-requests.md) - - [Provider](developers/provider/README.md) - - [General Endpoints](developers/provider/general-endpoints.md) - - [Encryption / Decryption](developers/provider/encryption-decryption.md) - - [Compute Endpoints](developers/provider/compute-endpoints.md) - - [Authentication Endpoints](developers/provider/authentication-endpoints.md) - - [Uploader](developers/uploader/README.md) - - [Uploader.js](developers/uploader/uploader-js.md) - - [Uploader UI](developers/uploader/uploader-ui.md) - - [Uploader UI to Market](developers/uploader/uploader-ui-marketplace.md) - - [Developer FAQ](developers/dev-faq.md) -- [๐Ÿ“Š Data Scientists](data-scientists/README.md) - - [Ocean.py](data-scientists/ocean.py/README.md) - - [Install](data-scientists/ocean.py/install.md) - - [Local Setup](data-scientists/ocean.py/local-setup.md) - - [Remote Setup](data-scientists/ocean.py/remote-setup.md) - - [Publish Flow](data-scientists/ocean.py/publish-flow.md) - - [Consume Flow](data-scientists/ocean.py/consume-flow.md) - - [Compute Flow](data-scientists/ocean.py/compute-flow.md) - - [Ocean Instance Tech Details](data-scientists/ocean.py/technical-details.md) - - [Ocean Assets Tech Details](data-scientists/ocean.py/ocean-assets-tech-details.md) - - [Ocean Compute Tech Details](data-scientists/ocean.py/ocean-compute-tech-details.md) - - [Datatoken Interface Tech Details](data-scientists/ocean.py/datatoken-interface-tech-details.md) - - [Join a Data Challenge](data-scientists/join-a-data-challenge.md) - - [Sponsor a Data Challenge](data-scientists/sponsor-a-data-challenge.md) - - [Data Value-Creation Loop](data-scientists/the-data-value-creation-loop.md) - - [What data is valuable?](data-scientists/data-engineers.md) + +* [๐Ÿ‘‹ Ocean docs](README.md) +* [๐ŸŒŠ Discover Ocean](discover/README.md) + * [Why Ocean?](discover/why-ocean.md) + * [What is Ocean?](discover/what-is-ocean.md) + * [What can you do with Ocean?](discover/benefits.md) + * [OCEAN: The Ocean token](discover/ocean-token.md) + * [Networks](discover/networks/README.md) + * [Network Bridges](discover/networks/bridges.md) + * [FAQ](discover/faq.md) + * [Glossary](discover/glossary.md) +* [๐Ÿ“š User Guides](user-guides/README.md) + * [Basic concepts](user-guides/basic-concepts.md) + * [Using Wallets](user-guides/wallets/README.md) + * [Set Up MetaMask](user-guides/wallets/metamask-setup.md) + * [Manage Your OCEAN](user-guides/wallets/wallets-and-ocean.md) + * [Host Assets](user-guides/asset-hosting/README.md) + * [Uploader](user-guides/asset-hosting/uploader.md) + * [Arweave](user-guides/asset-hosting/arweave.md) + * [AWS](user-guides/asset-hosting/aws.md) + * [Azure Cloud](user-guides/asset-hosting/azure-cloud.md) + * [Google Storage](user-guides/asset-hosting/google-storage.md) + * [Github](user-guides/asset-hosting/github.md) + * [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-pools.md) +* [๐Ÿ’ป Developers](developers/README.md) + * [Architecture Overview](developers/architecture.md) + * [Contracts](developers/contracts/README.md) + * [Data NFTs](developers/contracts/data-nfts.md) + * [Datatokens](developers/contracts/datatokens.md) + * [Data NFTs and Datatokens](developers/contracts/datanft-and-datatoken.md) + * [Datatoken Templates](developers/contracts/datatoken-templates.md) + * [Roles](developers/contracts/roles.md) + * [Pricing Schemas](developers/contracts/pricing-schemas.md) + * [Fees](developers/contracts/fees.md) + * [Revenue](developers/contracts/revenue.md) + * [Fractional Ownership](developers/fractional-ownership.md) + * [Community Monetization](developers/community-monetization.md) + * [Metadata](developers/metadata.md) + * [Identifiers (DIDs)](developers/identifiers.md) + * [DDO Specification](developers/ddo-specification.md) + * [Storage Specifications](developers/storage.md) + * [Fine-Grained Permissions](developers/fg-permissions.md) + * [Retrieve datatoken/data NFT addresses & Chain ID](developers/retrieve-datatoken-address.md) + * [Get API Keys for Blockchain Access](developers/get-api-keys-for-blockchain-access.md) + * [Barge](developers/barge/README.md) + * [Local Setup](developers/barge/local-setup-ganache.md) + * [Subgraph](developers/subgraph/README.md) + * [Get data NFTs](developers/subgraph/list-data-nfts.md) + * [Get data NFT information](developers/subgraph/get-data-nft-information.md) + * [Get datatokens](developers/subgraph/list-datatokens.md) + * [Get datatoken information](developers/subgraph/get-datatoken-information.md) + * [Get datatoken buyers](developers/subgraph/get-datatoken-buyers.md) + * [Get fixed-rate exchanges](developers/subgraph/list-fixed-rate-exchanges.md) + * [Get veOCEAN stats](developers/subgraph/get-veocean-stats.md) + * [Ocean.js](developers/ocean.js/README.md) + * [Configuration](developers/ocean.js/configuration.md) + * [Creating a data NFT](developers/ocean.js/creating-datanft.md) + * [Publish](developers/ocean.js/publish.md) + * [Mint Datatokens](developers/ocean.js/mint-datatoken.md) + * [Update Metadata](developers/ocean.js/update-metadata.md) + * [Asset Visibility](developers/ocean.js/asset-visibility.md) + * [Consume Asset](developers/ocean.js/consume-asset.md) + * [Run C2D Jobs](developers/ocean.js/cod-asset.md) + * [Ocean CLI](developers/ocean-cli/README.md) + * [Install](developers/ocean-cli/install.md) + * [Publish](developers/ocean-cli/publish.md) + * [Edit](developers/ocean-cli/edit.md) + * [Consume](developers/ocean-cli/consume.md) + * [Run C2D Jobs](developers/ocean-cli/run-c2d.md) + * [Compute to data](developers/compute-to-data/README.md) + * [Architecture](developers/compute-to-data/compute-to-data-architecture.md) + * [Datasets & Algorithms](developers/compute-to-data/compute-to-data-datasets-algorithms.md) + * [Workflow](developers/compute-to-data/compute-workflow.md) + * [Writing Algorithms](developers/compute-to-data/compute-to-data-algorithms.md) + * [Compute Options](developers/compute-to-data/compute-options.md) + * [Aquarius](developers/aquarius/README.md) + * [Asset Requests](developers/aquarius/asset-requests.md) + * [Chain Requests](developers/aquarius/chain-requests.md) + * [Other Requests](developers/aquarius/other-requests.md) + * [Provider](developers/provider/README.md) + * [General Endpoints](developers/provider/general-endpoints.md) + * [Encryption / Decryption](developers/provider/encryption-decryption.md) + * [Compute Endpoints](developers/provider/compute-endpoints.md) + * [Authentication Endpoints](developers/provider/authentication-endpoints.md) + * [Uploader](developers/uploader/README.md) + * [Uploader.js](developers/uploader/uploader-js.md) + * [Uploader UI](developers/uploader/uploader-ui.md) + * [Uploader UI to Market](developers/uploader/uploader-ui-marketplace.md) + * [Developer FAQ](developers/dev-faq.md) +* [๐Ÿ“Š Data Scientists](data-scientists/README.md) + * [Ocean.py](data-scientists/ocean.py/README.md) + * [Install](data-scientists/ocean.py/install.md) + * [Local Setup](data-scientists/ocean.py/local-setup.md) + * [Remote Setup](data-scientists/ocean.py/remote-setup.md) + * [Publish Flow](data-scientists/ocean.py/publish-flow.md) + * [Consume Flow](data-scientists/ocean.py/consume-flow.md) + * [Compute Flow](data-scientists/ocean.py/compute-flow.md) + * [Ocean Instance Tech Details](data-scientists/ocean.py/technical-details.md) + * [Ocean Assets Tech Details](data-scientists/ocean.py/ocean-assets-tech-details.md) + * [Ocean Compute Tech Details](data-scientists/ocean.py/ocean-compute-tech-details.md) + * [Datatoken Interface Tech Details](data-scientists/ocean.py/datatoken-interface-tech-details.md) + * [Join a Data Challenge](data-scientists/join-a-data-challenge.md) + * [Sponsor a Data Challenge](data-scientists/sponsor-a-data-challenge.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) * [๐Ÿ’ฐ Data Farming](data-farming/README.md) - * [Passive DF (and veOCEAN)](data-farming/passivedf.md) - * [Guide to Passive DF](data-farming/passivedf-guide.md) - * [Liquid Staking](data-farming/liquid-staking.md) - * [Volume DF](data-farming/volumedf.md) - * [Guide to Volume DF](data-farming/volumedf-guide.md) - * [Delegation in Volume DF](data-farming/delegate.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.md) - * [Estimated APY vs Time](data-farming/apys-plot.md) - * [Guide to Estimating APY](data-farming/apys-guide.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) * [Set Up a Server](infrastructure/setup-server.md) diff --git a/data-farming/README.md b/data-farming/README.md index 5d950684..245d23cf 100644 --- a/data-farming/README.md +++ b/data-farming/README.md @@ -4,18 +4,17 @@ cover: ../.gitbook/assets/cover/data_farming_banner.png coverY: 0 --- -# What is Data Farming? +# ๐Ÿ’ฐ 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. +[**The DF webapp**](https://df.oceandao.org) is where users perform most DF actions. - ## Current DF Streams & Budgets -DF currently has one stream: +DF currently has one stream: -- **[Predictoor DF](predictoordf.md).** Run prediction bots to earn continuously. 37,500 OCEAN/week + ROSE rewards. +* [**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. @@ -24,22 +23,23 @@ DF Streams evolve over time. The next two sections cover past & future DF stream ## 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. + +* 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).) + +* 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 @@ -47,18 +47,16 @@ To engage in Predictoor DF, users submit Predictions on Oasis Sapphire. Rewards Passive DF and Volume DF reward payouts are on Ethereum network. -The [networks docs](../discover/networks/README.md) have more info. +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. +* 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](../README.md)_ +_Next:_ [_Predictoor DF_](predictoordf.md) +_Back:_ [_Docs main_](../) diff --git a/data-farming/apys/README.md b/data-farming/apys/README.md new file mode 100644 index 00000000..7884c934 --- /dev/null +++ b/data-farming/apys/README.md @@ -0,0 +1,2 @@ +# APYs + diff --git a/data-farming/apys/estimated-apy-vs-time.md b/data-farming/apys/estimated-apy-vs-time.md new file mode 100644 index 00000000..f57ce99d --- /dev/null +++ b/data-farming/apys/estimated-apy-vs-time.md @@ -0,0 +1,2 @@ +# Estimated APY vs Time + diff --git a/data-farming/apys/guide-to-estimating-apy.md b/data-farming/apys/guide-to-estimating-apy.md new file mode 100644 index 00000000..1e09d1ba --- /dev/null +++ b/data-farming/apys/guide-to-estimating-apy.md @@ -0,0 +1,2 @@ +# Guide to Estimating APY + diff --git a/data-farming/claim-rewards.md b/data-farming/claim-rewards.md new file mode 100644 index 00000000..3622172c --- /dev/null +++ b/data-farming/claim-rewards.md @@ -0,0 +1,2 @@ +# Claim Rewards + diff --git a/data-farming/passive-df-and-veocean/README.md b/data-farming/passive-df-and-veocean/README.md new file mode 100644 index 00000000..82b24b47 --- /dev/null +++ b/data-farming/passive-df-and-veocean/README.md @@ -0,0 +1,2 @@ +# Passive DF (and veOCEAN) + diff --git a/data-farming/passive-df-and-veocean/guide-to-passive-df.md b/data-farming/passive-df-and-veocean/guide-to-passive-df.md new file mode 100644 index 00000000..cdc92534 --- /dev/null +++ b/data-farming/passive-df-and-veocean/guide-to-passive-df.md @@ -0,0 +1,2 @@ +# Guide to Passive DF + diff --git a/data-farming/passive-df-and-veocean/liquid-staking.md b/data-farming/passive-df-and-veocean/liquid-staking.md new file mode 100644 index 00000000..156cc211 --- /dev/null +++ b/data-farming/passive-df-and-veocean/liquid-staking.md @@ -0,0 +1,2 @@ +# Liquid Staking + diff --git a/data-farming/reward-schedule.md b/data-farming/reward-schedule.md new file mode 100644 index 00000000..d0815ce4 --- /dev/null +++ b/data-farming/reward-schedule.md @@ -0,0 +1,2 @@ +# Reward Schedule + diff --git a/data-farming/volume-df/README.md b/data-farming/volume-df/README.md new file mode 100644 index 00000000..23b36c6e --- /dev/null +++ b/data-farming/volume-df/README.md @@ -0,0 +1,2 @@ +# Volume DF + diff --git a/data-farming/volume-df/delegation-in-volume-df.md b/data-farming/volume-df/delegation-in-volume-df.md new file mode 100644 index 00000000..986164dd --- /dev/null +++ b/data-farming/volume-df/delegation-in-volume-df.md @@ -0,0 +1,2 @@ +# Delegation in Volume DF + diff --git a/data-farming/volume-df/guide-to-volume-df.md b/data-farming/volume-df/guide-to-volume-df.md new file mode 100644 index 00000000..1055c35e --- /dev/null +++ b/data-farming/volume-df/guide-to-volume-df.md @@ -0,0 +1,2 @@ +# Guide to Volume DF + diff --git a/data-scientists/README.md b/data-scientists/README.md index 4109f6ee..99b36e08 100644 --- a/data-scientists/README.md +++ b/data-scientists/README.md @@ -4,32 +4,33 @@ cover: ../.gitbook/assets/cover/data_scientists_banner.png coverY: 0 --- -# ๐Ÿ“Š Data Science +# ๐Ÿ“Š Data Scientists ### How does Ocean benefit data scientists? 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. -- **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! + +* **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. +* **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? 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. -- 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). - +* 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. +* [**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? 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 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. -
+
diff --git a/developers/README.md b/developers/README.md index 004f93a1..e33a05c5 100644 --- a/developers/README.md +++ b/developers/README.md @@ -1,43 +1,43 @@ --- -description: cover: ../.gitbook/assets/cover/developer_banner.png coverY: 0 --- -# ๐Ÿ‘จ๐Ÿ’ป Developers +# ๐Ÿ’ป Developers ## 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. **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) -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). +2. **AI dApps**: monetize your AI dApp by token-gating on AI training data, feature vectors, models, or predictions. +3. **Data Markets**: build a decentralized data market. [Here's how](https://github.com/oceanprotocol/market) +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: -- **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. -- **Token-gated feeds**: [Ocean Predictoor](https://predictoor.ai) for AI prediction feeds + +* **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. +* **Token-gated feeds**: [Ocean Predictoor](https://predictoor.ai) for AI prediction feeds ## How do developers start using Ocean? -- **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. -- **Contract level: [Call Ocean contracts](contracts/README.md)** on Eth mainnet [or other chains](../discover/networks/README.md). +* **App level:** [**Use an Ocean Template**](https://oceanprotocol.com/templates). +* **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/) on Eth mainnet [or other chains](../discover/networks/). ## Developer Docs Quick-links -- [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) -- Schemas: [Metadata](metadata.md), [identifiers/DIDs](identifiers.md), [identifier objects/DDOs](ddo-specification.md), [storage](storage.md), [fine-grained permissions](fg-permissions.md) -- Components: - - [Barge](barge/README.md) - local chain for testing - - [Ocean subgraph](subgraph/README.md) - grabbing event data from the chain - - [Ocean CLI](ocean-cli/README.md) - command-line interface - - [Compute-to-data](compute-to-data/README.md) - practical privacy approach - - [Aquarius](aquarius/README.md) - metadata cache - - [Provider](provider/README.md) - handshaking for access control -- [FAQ](dev-faq.md) +* [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) +* Schemas: [Metadata](metadata.md), [identifiers/DIDs](identifiers.md), [identifier objects/DDOs](ddo-specification.md), [storage](storage.md), [fine-grained permissions](fg-permissions.md) +* Components: + * [Barge](barge/) - local chain for testing + * [Ocean subgraph](subgraph/) - grabbing event data from the chain + * [Ocean CLI](ocean-cli/) - command-line interface + * [Compute-to-data](compute-to-data/) - practical privacy approach + * [Aquarius](aquarius/) - metadata cache + * [Provider](provider/) - handshaking for access control +* [FAQ](dev-faq.md) ----- +*** -_Next: [Architecture](architecture.md)_ +_Next:_ [_Architecture_](architecture.md) diff --git a/developers/architecture.md b/developers/architecture.md index 865f5d02..0dc5e6d1 100644 --- a/developers/architecture.md +++ b/developers/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 -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 @@ -20,22 +20,22 @@ Above the smart contracts, you'll find essential [libraries](architecture.md#lib #### 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. -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. +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/): 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 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. -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. -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. +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/): 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/): 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/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 @@ -45,6 +45,6 @@ Prominently featured within this layer is [Ocean Market](https://market.oceanpro ### 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. diff --git a/developers/compute-to-data/README.md b/developers/compute-to-data/README.md index a2d1ef3a..34b9027b 100644 --- a/developers/compute-to-data/README.md +++ b/developers/compute-to-data/README.md @@ -29,14 +29,14 @@ We suggest reading these guides to get an understanding of how compute-to-data w ### User Guides -* [How to write compute to data algorithms](../../user-guides/compute-to-data/make-a-boss-c2d-algorithm.md) -* [How to publish a compute-to-data algorithm](../../user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md) -* [How to publish a dataset for compute to data](../../user-guides/compute-to-data/publish-a-c2d-data-nft.md) +* [How to write compute to data algorithms](broken-reference) +* [How to publish a compute-to-data algorithm](broken-reference) +* [How to publish a dataset for compute to data](broken-reference) ### Developer Guides * [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 diff --git a/developers/compute-to-data/compute-to-data-architecture.md b/developers/compute-to-data/compute-to-data-architecture.md index d3db7d4b..dc64ce15 100644 --- a/developers/compute-to-data/compute-to-data-architecture.md +++ b/developers/compute-to-data/compute-to-data-architecture.md @@ -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. {% 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 %} 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 -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 diff --git a/developers/contracts/pricing-schemas.md b/developers/contracts/pricing-schemas.md index 20875754..7a1b2fc4 100644 --- a/developers/contracts/pricing-schemas.md +++ b/developers/contracts/pricing-schemas.md @@ -181,8 +181,8 @@ function createNftWithErc20WithDispenser( -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. -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. diff --git a/developers/contracts/revenue.md b/developers/contracts/revenue.md index 68aba74d..112f383e 100644 --- a/developers/contracts/revenue.md +++ b/developers/contracts/revenue.md @@ -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. {% 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: @@ -33,7 +33,7 @@ paymentCollectorAddress = 'New payment collector address' 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 datatokenAddress = 'Your datatoken address' diff --git a/developers/contracts/roles.md b/developers/contracts/roles.md index f5f2280e..f8555fca 100644 --- a/developers/contracts/roles.md +++ b/developers/contracts/roles.md @@ -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. {% 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. @@ -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). {% embed url="https://app.arcade.software/share/qC8QpkLsFIQk3NxPzB8p" fullWidth="false" %} -{% endembed %} ### Metadata Updater @@ -294,7 +293,6 @@ function removeMinter(address _minter) external onlyERC20Deployer { {% embed url="https://app.arcade.software/share/OHlwsPbf29S1PLh03FM7" fullWidth="false" %} -{% endembed %} ### Fee Manager diff --git a/developers/ocean-cli/README.md b/developers/ocean-cli/README.md index 24c5db2a..b6e2bdd1 100644 --- a/developers/ocean-cli/README.md +++ b/developers/ocean-cli/README.md @@ -1,22 +1,22 @@ --- 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. ๐Ÿš€ The Ocean CLI offers a wide range of functionalities, enabling you to: -- [**Publish**](./publish.md) ๐Ÿ“ค data services: downloadable files or compute-to-data. -- [**Edit**](./edit.md) โœ๏ธ existing assets. -- [**Consume**](./consume.md) ๐Ÿ“ฅ data services, ordering datatokens and downloading data. -- [**Compute to Data**](./run-c2d.md) ๐Ÿ’ป on public available datasets using a published algorithm. +* [**Publish**](publish.md) ๐Ÿ“ค data services: downloadable files or compute-to-data. +* [**Edit**](edit.md) โœ๏ธ existing assets. +* [**Consume**](consume.md) ๐Ÿ“ฅ data services, ordering datatokens and downloading data. +* [**Compute to Data**](run-c2d.md) ๐Ÿ’ป on public available datasets using a published algorithm. ## 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. - diff --git a/discover/README.md b/discover/README.md index 0c519dd0..bb704955 100644 --- a/discover/README.md +++ b/discover/README.md @@ -1,5 +1,4 @@ --- -description: cover: ../.gitbook/assets/cover/discover_banner.png coverY: 7.413145539906106 --- @@ -8,30 +7,30 @@ coverY: 7.413145539906106 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: -- 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... -- **[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)** +* [**Developers**](../developers/)**.** Build token-gated AI dApps & APIs +* [**Data scientists**](../data-scientists/)**.** Earn via predictions & challenges +* [**OCEAN holders**](../data-farming/)**.** Get rewards by locking OCEAN & curating data, via Data Farming. +* [**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) +* [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/), [Bridges](networks/bridges.md) +* [FAQ](faq.md), [Glossary](glossary.md) ----- +*** -_Next: [Why Ocean?](why-ocean.md)_ - -_Back: [Docs main](../README.md)_ +_Next:_ [_Why Ocean?_](why-ocean.md) +_Back:_ [_Docs main_](../) diff --git a/discover/benefits.md b/discover/benefits.md index ee376504..b12bf6bd 100644 --- a/discover/benefits.md +++ b/discover/benefits.md @@ -1,118 +1,116 @@ ---- -description: ---- - # What can you do with Ocean? This page shows things you can do with Ocean... -- As a builder -- As a data scientist -- As an OCEAN holder -- Become an Ocean ambassador + +* As a builder +* As a data scientist +* As an OCEAN holder +* Become an Ocean ambassador Let's explore each... ## What builders can do -
+
+ +
+ +
-Build Your Token-gated AI dApp +Build Your Token-gated AI dApp 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.
-
-Build Your Token-gated REST API +Build Your Token-gated REST API 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.
-
-Build Your Data Market +Build Your Data Market 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.
-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
-
+ +
+
-Use Ocean in Python +Use Ocean in Python -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.
-
-Do crypto price predictions +Do crypto price predictions -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.
-
-Compete in a Data Challenge +Compete in a Data Challenge Ocean regularly offer [data science challenges](../data-scientists/join-a-data-challenge.md) on real-world problems. Showcase your skills, and earn $ prizes.
-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
-Earn Rewards via Data Farming +Earn Rewards via Data Farming -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.
## Become an Ocean Ambassador -
-Become an Ambassador + +Become an Ambassador 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: -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 -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." -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. +
+*** ----- +_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) diff --git a/predictoor/README.md b/predictoor/README.md index a42648cf..cff267d1 100644 --- a/predictoor/README.md +++ b/predictoor/README.md @@ -2,7 +2,8 @@ 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 -
+**Predictoor docs are now at** [**docs.predictoor.ai**](https://docs.predictoor.ai)**.** +
diff --git a/user-guides/README.md b/user-guides/README.md index 6616afcb..f0ae22e7 100644 --- a/user-guides/README.md +++ b/user-guides/README.md @@ -1,6 +1,5 @@ --- -description: >- - Guides to use Ocean, with no coding needed. +description: Guides to use Ocean, with no coding needed. cover: ../.gitbook/assets/cover/user_guides_banner.png coverY: 0 --- @@ -10,11 +9,12 @@ coverY: 0
**Contents:** -- Basic concepts -- Using wallets -- Using Ocean Market -- C2D in Ocean Market -- Host assets + +* Basic concepts +* Using wallets +* Using Ocean Market +* C2D in Ocean Market +* Host assets Let's dive in! @@ -28,15 +28,14 @@ For blockchain beginners ## Using wallets -{% content-ref url="wallets/README.md" %} -[wallets/README.md.md](wallets/README.md) +{% content-ref url="wallets/" %} +[wallets](wallets/) {% endcontent-ref %} {% content-ref url="wallets/metamask-setup.md" %} -[wallets/metamask-setup.md](wallets/metamask-setup.md) +[metamask-setup.md](wallets/metamask-setup.md) {% endcontent-ref %} - ## Using Ocean Market {% content-ref url="using-ocean-market.md" %} @@ -53,14 +52,14 @@ For blockchain beginners ## C2D in Ocean Market -{% content-ref url="compute-to-data/" %} -[compute-to-data](compute-to-data/README.md) +{% content-ref url="broken-reference" %} +[Broken link](broken-reference) {% endcontent-ref %} ## Host Assets {% content-ref url="asset-hosting/" %} -[asset-hosting](asset-hosting/README.md) +[asset-hosting](asset-hosting/) {% endcontent-ref %} ## Antique Stuff ๐Ÿบ diff --git a/user-guides/compute-to-data/README.md b/user-guides/compute-to-data/README.md deleted file mode 100644 index 2983438b..00000000 --- a/user-guides/compute-to-data/README.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -description: >- - How to sell compute jobs on your datasets while keeping your data and - algorithms private ---- - -# Sell NFT Computations (Compute-to-Data) - -### Introducing, The Problem - -{% embed url="https://media0.giphy.com/media/v1.Y2lkPTc5MGI3NjExNjNmMTc3MjFjNTg2MjQwZTQyY2VkNzFiNjk1YzM5ZmJkM2NjMzA4ZiZlcD12MV9pbnRlcm5hbF9naWZzX2dpZklkJmN0PWc/17FxSFyYNOgThnonDK/giphy.gif" fullWidth="false" %} - -**Anyone could buy your data on the Ocean Market and then publicly share it all over the internet.** Pretty scary, right? But what if there was a way that buyers could access valuable insights from your data and algorithms without actually \*seeing\* the data or algorithms themselves? We have a solution for that! - -Enter, **Compute-to-Data** (also lovingly called C2D ๐Ÿฅฐ). Ocean Protocol's C2D feature enables you to monetize the OUTPUT of compute jobs on your datasets without revealing the contents of the data/algorithms themselves. Let's dive in how! - -## How to Compute-to-Data ๐Ÿ’ƒ - -You will need to accomplish **3 main steps** in establishing a compute-to-data flow: [create an algorithm](make-a-boss-c2d-algorithm.md) that's compatible with C2D, [publish your C2D-specific algorithm NFT](publish-a-c2d-algorithm-nft.md), then [publish your data NFT with C2D configurations](publish-a-c2d-data-nft.md) allowing the algorithm to compute on it. That's it! Then you'll be able to sell compute jobs ๐Ÿคฉ Read the steps in this section's three subpages to create & sell a compute job from start to finish. ๐Ÿ’ช๐Ÿ˜ƒ - -Or you could watch this video tutorial about it below: - -{% embed url="https://youtu.be/2AF9mkqlf5Y" %} - diff --git a/user-guides/compute-to-data/make-a-boss-c2d-algorithm.md b/user-guides/compute-to-data/make-a-boss-c2d-algorithm.md deleted file mode 100644 index e83d80ca..00000000 --- a/user-guides/compute-to-data/make-a-boss-c2d-algorithm.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -description: >- - How to construct the beginnings of an awesome algorithm for C2D compute jobs - on datasets ---- - -# Make a Boss C2D Algorithm - -
- -The beginning of any algorithm for Compute-to-Data starts by loading the dataset correctly. Read on, anon ๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป - -### Open the local dataset file - -This code goes at the top of your algorithm file for your algorithm NFT asset to use with Compute-to-Data. It references your data NFT asset file on the Docker container you selected. - -{% tabs %} -{% tab title="Python" %} -```python -import csv -import json -import os - -def get_input(local=False): - - dids = os.getenv("DIDS", None) - - if not dids: - print("No DIDs found in the environment. Aborting.") - return - - dids = json.loads(dids) - - for did in dids: - filename = f"data/inputs/{did}/0" # 0 for metadata service - print(f"Reading asset file {filename}.") - return filename - -# Get the input filename using the get_input function -input_filename = get_input() - -if not input_filename: - # No input filename returned - exit() - -# Open the file & run your code -with open(input_filename, 'r') as file: - # Read the CSV file - csv_reader = csv.DictReader(file) - - -``` -{% endtab %} - -{% tab title="Javascript" %} -```javascript -const fs = require("fs"); - -var input_folder = "/data/inputs"; -var output_folder = "/data/outputs"; - -async function processfolder(Path) { - var files = fs.readdirSync(Path); - for (var i =0; i < files.length; i++) { - var file = files[i]; - var fullpath = Path + "/" + file; - if (fs.statSync(fullpath).isDirectory()) { - await processfolder(fullpath); - } else { - - } - } -} - - - -// Open the file & run your code -processfolder(input_folder); - -``` -{% endtab %} -{% endtabs %} - -**Note:** Here are the following Python libraries that you can use in your code: - -```python -// Python modules -numpy==1.16.3 -pandas==0.24.2 -python-dateutil==2.8.0 -pytz==2019.1 -six==1.12.0 -sklearn -xlrd == 1.2.0 -openpyxl >= 3.0.3 -wheel -matplotlib -``` diff --git a/user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md b/user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md deleted file mode 100644 index 910e1ba6..00000000 --- a/user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: How to publish a C2D algorithm NFT on the Ocean Market ---- - -# Publish a C2D Algorithm NFT - -

You're an algorithm guru after all!

- -### Publish Your Algorithm NFT - -#### Step 1 - Navigate to the Ocean Market - -* Go to [https://market.oceanprotocol.com](https://market.oceanprotocol.com) - -#### Step 2 - Connect your wallet - -* Click the top right Connect Wallet button to connect your self-custody wallet to the Ocean Market - -

Connect your self-custody wallet

- -#### Step 3 - Click the Publish link in the top left corner of the page - -* Click the Publish link - -

Navigate to the Publish page

- -#### Step 4 - Enter the metadata - -* Enter the metadata for your algorithm NFT paying special attention to select the Algorithm asset type button: - -

Be sure to select the Algorithm asset type

- -* Select the appropriate Docker image to run your code - most algorithms are written in Javascript or Python, so you can use either of these Docker images or your own custom image! - -

Select the appropriate Docker image for your algorithm type

- -#### Step 5 - Enter the Access information - -* Make sure to keep this option checked! โœ… - -

Keep this option checked for Compute-to-Data

- -#### Step 6 - Set a price, Fixed or Free, for your algorithm - -* It is recommended that you set a fixed price since the price that you choose for your algorithm will be charged any time that someone selects to run your algorithm on a dataset, including datasets that aren't yours! - -

Set a price for your C2D algorithm NFT

- -#### Step 7 - Approve the preview - -* Your preview should look like the following: - -
- -#### Step 8 - Submit the transactions - -* Click the pink Submit button at the bottom of the page and sign the two transactions with your wallet. You'll have to pay for gas when you sign to publish your algorithm asset. - -

Sign and pay gas for 2 transactions on the final publishing step

- -#### Congratulations on publishing your algorithm! - -* On to the next step -> [Publish a C2D Data NFT](publish-a-c2d-data-nft.md) diff --git a/user-guides/compute-to-data/publish-a-c2d-data-nft.md b/user-guides/compute-to-data/publish-a-c2d-data-nft.md deleted file mode 100644 index fc0c0843..00000000 --- a/user-guides/compute-to-data/publish-a-c2d-data-nft.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -description: How to publish a data NFT with C2D configurations ---- - -# Publish a C2D Data NFT - -
- -#### Step 1 - Navigate to the Ocean Market - -* Go to [https://market.oceanprotocol.com](https://market.oceanprotocol.com) - -#### Step 2 - Connect your wallet - -* Click the top right Connect Wallet button to connect your self-custody wallet to the Ocean Market - -

Connect your self-custody wallet

- -#### Step 3 - Click the Publish link in the top left corner of the page - -* Click the Publish link - -

Navigate to the Publish page

- -#### Step 4 - Enter the metadata - -* Enter the metadata for your data NFT keeping the Dataset asset type selected by default: - -

Keep the default Dataset Asset Type selected

- -#### Step 5 - Enter the Access information - -* You must select the Compute access type in this step! - -

Make sure that you select Compute access type

- -#### Step 6 - Set a price, Fixed or Free, for your dataset - -* Toggle the tab to decide whether you want to set a fixed or free price for your dataset. - -

Set a price for your C2D data NFT

- -#### Step 7 - Approve the preview - -* Your preview should look like the following (this will change soon!): - -
- -#### Step 8 - Submit the transactions - -* Click the pink Submit button at the bottom of the page and sign the two transactions with your wallet. You'll have to pay for gas when you sign to publish your algorithm asset. - -

Sign and pay gas for 2 transactions on the final publishing step

- -**Ok, you've published a Data NFT that is \*almost\* ready for Compute-to-Data. Just a few tiny steps left and you're done!** - -#### Step 9 - Edit the asset (yes, again!) - -* On the webpage for your Data NFT, you need to click the Edit Asset link to change the C2D settings. - -

Click the Edit Asset link

- -#### Step 10 - Edit the Compute settings - -* You must select the Edit Compute Settings button to add your algorithm to the data NFT for computation. - -

Select the Edit Compute Settings tab button

- -* Then, search for your algorithm in the Selected algorithms search bar and check the box next to it to add it as an algorithm able to compute on the dataset. - -

Search for and select your algorithm to compute on your dataset

- -#### Step 11 - Submit the transactions - -* Click the pink Submit button at the bottom of the page and sign all the transactions. - -

Click the Submit button to finalize the transaction

- -#### Congratulations! You have fully finished the C2D flow. Check your work by verifying that your algorithm appears on the data NFT's page, like in the following example: - -

Your algorithm should appear now on the data NFT's page!

- -If you would like to run the compute job, then simply click the radio button to the left of the algorithm's name and click Buy Compute Job. - -

Buy the compute job to check your work!

- -The output of your algorithm's computation on the dataset will appear in the Algorithm.log output. Voilรก! - -#### Now do a little dance, because you're done! - -{% embed url="https://media4.giphy.com/media/CxhWJeIicfOEynsEn6/giphy.gif?cid=ecf05e478eb1zzixmsjwbwx37a0d4e1096812j513crzr18j&ct=g&ep=v1_gifs_search&rid=giphy.gif" %}