diff --git a/README.md b/README.md index 833b7dfd..585e93e3 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,73 @@ description: Help for wherever you are on your Ocean Protocol journey. layout: landing --- -# 👋 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
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 55f13700..a3aef554 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,114 +1,128 @@ # 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) + - [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) * [👀 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) + * [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) + * [FAQ](data-farming/faq.md) * [🔨 Infrastructure](infrastructure/README.md) * [Set Up a Server](infrastructure/setup-server.md) * [Deploy Aquarius](infrastructure/deploying-aquarius.md) @@ -120,21 +134,3 @@ * [Collaborators](contribute/projects-using-ocean.md) * [Contributor Code of Conduct](contribute/code-of-conduct.md) * [Legal Requirements](contribute/legal-reqs.md) - -## Archive - -* [💰 Data Farming](archive/data-farming/README.md) - * [Passive DF (and veOCEAN)](archive/data-farming/passive-df-and-veocean/README.md) - * [Guide to Passive DF](archive/data-farming/passive-df-and-veocean/guide-to-passive-df.md) - * [Liquid Staking](archive/data-farming/passive-df-and-veocean/liquid-staking.md) - * [Volume DF](archive/data-farming/volume-df/README.md) - * [Guide to Volume DF](archive/data-farming/volume-df/guide-to-volume-df.md) - * [Delegation in Volume DF](archive/data-farming/volume-df/delegation-in-volume-df.md) - * [Predictoor DF](archive/data-farming/predictoordf/README.md) - * [Guide to Predictoor DF](archive/data-farming/predictoordf/predictoordf-guide.md) - * [Claim Rewards](archive/data-farming/claim-rewards.md) - * [Reward Schedule](archive/data-farming/reward-schedule.md) - * [APYs](archive/data-farming/apys/README.md) - * [Estimated APY vs Time](archive/data-farming/apys/estimated-apy-vs-time.md) - * [Guide to Estimating APY](archive/data-farming/apys/guide-to-estimating-apy.md) - * [FAQ](archive/data-farming/faq.md) diff --git a/archive/data-farming/apys/README.md b/archive/data-farming/apys/README.md deleted file mode 100644 index 7884c934..00000000 --- a/archive/data-farming/apys/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# APYs - diff --git a/archive/data-farming/apys/estimated-apy-vs-time.md b/archive/data-farming/apys/estimated-apy-vs-time.md deleted file mode 100644 index f57ce99d..00000000 --- a/archive/data-farming/apys/estimated-apy-vs-time.md +++ /dev/null @@ -1,2 +0,0 @@ -# Estimated APY vs Time - diff --git a/archive/data-farming/apys/guide-to-estimating-apy.md b/archive/data-farming/apys/guide-to-estimating-apy.md deleted file mode 100644 index 1e09d1ba..00000000 --- a/archive/data-farming/apys/guide-to-estimating-apy.md +++ /dev/null @@ -1,2 +0,0 @@ -# Guide to Estimating APY - diff --git a/archive/data-farming/claim-rewards.md b/archive/data-farming/claim-rewards.md deleted file mode 100644 index 3622172c..00000000 --- a/archive/data-farming/claim-rewards.md +++ /dev/null @@ -1,2 +0,0 @@ -# Claim Rewards - diff --git a/archive/data-farming/passive-df-and-veocean/README.md b/archive/data-farming/passive-df-and-veocean/README.md deleted file mode 100644 index 82b24b47..00000000 --- a/archive/data-farming/passive-df-and-veocean/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Passive DF (and veOCEAN) - diff --git a/archive/data-farming/passive-df-and-veocean/guide-to-passive-df.md b/archive/data-farming/passive-df-and-veocean/guide-to-passive-df.md deleted file mode 100644 index cdc92534..00000000 --- a/archive/data-farming/passive-df-and-veocean/guide-to-passive-df.md +++ /dev/null @@ -1,2 +0,0 @@ -# Guide to Passive DF - diff --git a/archive/data-farming/passive-df-and-veocean/liquid-staking.md b/archive/data-farming/passive-df-and-veocean/liquid-staking.md deleted file mode 100644 index 156cc211..00000000 --- a/archive/data-farming/passive-df-and-veocean/liquid-staking.md +++ /dev/null @@ -1,2 +0,0 @@ -# Liquid Staking - diff --git a/archive/data-farming/predictoordf/README.md b/archive/data-farming/predictoordf/README.md deleted file mode 100644 index e116da86..00000000 --- a/archive/data-farming/predictoordf/README.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: Baseline sales for predictoors ---- - -# Predictoor DF - -
- -**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/) 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)**](../) 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_](../) diff --git a/archive/data-farming/reward-schedule.md b/archive/data-farming/reward-schedule.md deleted file mode 100644 index d0815ce4..00000000 --- a/archive/data-farming/reward-schedule.md +++ /dev/null @@ -1,2 +0,0 @@ -# Reward Schedule - diff --git a/archive/data-farming/volume-df/README.md b/archive/data-farming/volume-df/README.md deleted file mode 100644 index 23b36c6e..00000000 --- a/archive/data-farming/volume-df/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Volume DF - diff --git a/archive/data-farming/volume-df/delegation-in-volume-df.md b/archive/data-farming/volume-df/delegation-in-volume-df.md deleted file mode 100644 index 986164dd..00000000 --- a/archive/data-farming/volume-df/delegation-in-volume-df.md +++ /dev/null @@ -1,2 +0,0 @@ -# Delegation in Volume DF - diff --git a/archive/data-farming/volume-df/guide-to-volume-df.md b/archive/data-farming/volume-df/guide-to-volume-df.md deleted file mode 100644 index 1055c35e..00000000 --- a/archive/data-farming/volume-df/guide-to-volume-df.md +++ /dev/null @@ -1,2 +0,0 @@ -# Guide to Volume DF - diff --git a/archive/data-farming/README.md b/data-farming/README.md similarity index 60% rename from archive/data-farming/README.md rename to data-farming/README.md index ba64a5bc..5d950684 100644 --- a/archive/data-farming/README.md +++ b/data-farming/README.md @@ -1,20 +1,21 @@ --- description: Earn OCEAN rewards by predicting (and more streams to come). -cover: ../../.gitbook/assets/cover/data_farming_banner.png +cover: ../.gitbook/assets/cover/data_farming_banner.png coverY: 0 --- -# 💰 Data Farming +# What is 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/)**.** 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. @@ -23,23 +24,22 @@ 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](../../data-farming/\[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,16 +47,18 @@ 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/) have more info. +The [networks docs](../discover/networks/README.md) 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/) +---- + +_Next: [Predictoor DF](predictoordf.md)_ + +_Back: [Docs main](../README.md)_ -_Back:_ [_Docs main_](../../) diff --git a/archive/data-farming/faq.md b/data-farming/faq.md similarity index 73% rename from archive/data-farming/faq.md rename to data-farming/faq.md index 64e55934..76a31865 100644 --- a/archive/data-farming/faq.md +++ b/data-farming/faq.md @@ -2,10 +2,9 @@ title: Data Farming FAQ description: Frequently Asked Questions about Data Farming --- +## Data Farming FAQ -# FAQ - -## Staking and Risk +### Staking and Risk
@@ -13,8 +12,8 @@ description: Frequently Asked Questions about Data Farming Its precise meaning depends on the DF stream. -* Predictoor DF: put OCEAN into a prediction transaction - +- Predictoor DF: put OCEAN into a prediction transaction +
@@ -23,7 +22,7 @@ Its precise meaning depends on the DF stream. 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. +- Predictoor DF: you stake a small amount of OCEAN in each epoch (eg every 5min). If issues arise, you can get out quickly.
@@ -31,18 +30,18 @@ As with any system, inherent risks exist. We try to minimize them, as follows. Is there any impermanent loss (IL) in my staking? -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]. - +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]. -## Rewards Payout + +### Rewards Payout
What APYs can I expect? For Predictoor DF, it varies a lot based on your prediction accuracy, and more. - +
@@ -59,14 +58,15 @@ Caveat: it’s "no" at least in theory! Sometimes there may be tweaks if there i Where do I learn more about Predictoor DF? -In its [docs page](predictoordf/). - +In its [docs page](predictoordf.md).
+ + Congrats! You've completed reading Data Farming docs. -_Next: Jump to_ [_DF main_](./)_._ +_Next: Jump to [DF main](README.md)._ -_Or: Jump to_ [_Docs main_](../../) _and click on your interest._ +_Or: Jump to [Docs main](../README.md) and click on your interest._ -_Back:_ [_Predictoor DF Guide_](predictoordf/predictoordf-guide.md) +_Back: [Predictoor DF Guide](predictoordf-guide.md)_ diff --git a/archive/data-farming/predictoordf/predictoordf-guide.md b/data-farming/predictoordf-guide.md similarity index 60% rename from archive/data-farming/predictoordf/predictoordf-guide.md rename to data-farming/predictoordf-guide.md index 00a06d22..fed32b71 100644 --- a/archive/data-farming/predictoordf/predictoordf-guide.md +++ b/data-farming/predictoordf-guide.md @@ -1,32 +1,34 @@ --- -description: How to earn $ via predictoor DF +description: >- + How to earn $ via predictoor DF --- # Guide to Predictoor DF -
+
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) :) 🏎️ +- 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. +- **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. +- ⚠️ **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)_._ +_Next: Jump to [DF FAQ](faq.md)._ -_Back:_ [_Predictoor DF_](./) +_Back: [Predictoor DF](predictoordf.md)_ diff --git a/data-farming/predictoordf.md b/data-farming/predictoordf.md new file mode 100644 index 00000000..9991cb37 --- /dev/null +++ b/data-farming/predictoordf.md @@ -0,0 +1,55 @@ +--- +description: >- + Baseline sales for predictoors +--- + +
+ +**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)_ diff --git a/data-scientists/README.md b/data-scientists/README.md index beb4326a..4109f6ee 100644 --- a/data-scientists/README.md +++ b/data-scientists/README.md @@ -4,33 +4,32 @@ cover: ../.gitbook/assets/cover/data_scientists_banner.png coverY: 0 --- -# 📊 Data Scientists +# 📊 Data Science ### How does Ocean benefit data scientists? It offers three main benefits: - -* **Earn.** You can earn $ by doing crypto price predictions via [Predictoor](../predictoor/), by curating data in [Data Farming](../archive/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! +- **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! ### How do data scientists start using Ocean? Here are the most relevant Ocean tools to work with: -* 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). +- 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). + ### 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 e33a05c5..004f93a1 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). -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). +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). 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/) 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/). +- **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). ## 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/) - 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) +- [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) -*** +---- -_Next:_ [_Architecture_](architecture.md) +_Next: [Architecture](architecture.md)_ diff --git a/developers/architecture.md b/developers/architecture.md index 0dc5e6d1..865f5d02 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/). 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/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. -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. +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. ### 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/), 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. +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. -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. +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. #### Middleware components Additionally, in supporting the discovery process, middleware components come into play: -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. +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. #### Compute-to-Data -[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. +[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. ### 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/), 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/). +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). 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/community-monetization.md b/developers/community-monetization.md index 89f0ccc2..d374c6ff 100644 --- a/developers/community-monetization.md +++ b/developers/community-monetization.md @@ -24,7 +24,7 @@ If you’re part of an established organization or a growing startup, you’ll a We have always been super encouraging of anyone who wishes to build a dApp on top of Ocean or to fork Ocean Market and make their own data marketplace. And now, we have taken this to the next level and introduced more opportunities and even more fee customization options. -Ocean empowers dApp owners like yourself to have greater flexibility and control over the fees you can charge. This means you can tailor the fee structure to suit your specific needs and ensure the sustainability of your project. **The smart contracts enable you to collect a fee not only in consume, but also in fixed-rate exchange, also you can set the fee value.** For more detailed information regarding the fees, we invite you to visit the [fees](contracts/fees.md) page. +Ocean empowers dApp owners like yourself to have greater flexibility and control over the fees you can charge. This means you can tailor the fee structure to suit your specific needs and ensure the sustainability of your project. **The smart contracts enable you to collect a fee not only in consume, but also in fixed-rate exchange, also you can set the fee value.** For more detailed information regarding the fees, we invite you to visit the [fees](contracts/fees.md) page. Another new opportunity is using your own **ERC20** token in your dApp, where it’s used as the unit of exchange. This is fully supported and can be a great way to ensure the sustainability of your project. @@ -32,7 +32,7 @@ Another new opportunity is using your own **ERC20** token in your dApp, where it Now this is a completely brand new opportunity to start generating [revenue](contracts/revenue.md) — running your own [provider](https://github.com/oceanprotocol/provider). We have been aware for a while now that many of you haven’t taken up the opportunity to run your own provider, and the reason seems obvious — there aren’t strong enough incentives to do so. -For those that aren’t aware, [Ocean Provider](provider/) is the proxy service that’s responsible for encrypting/ decrypting the data and streaming it to the consumer. It also validates if the user is allowed to access a particular data asset or service. It’s a crucial component in Ocean’s architecture. +For those that aren’t aware, [Ocean Provider](provider/README.md) is the proxy service that’s responsible for encrypting/ decrypting the data and streaming it to the consumer. It also validates if the user is allowed to access a particular data asset or service. It’s a crucial component in Ocean’s architecture. Now, as mentioned above, fees are now paid to the individual or organization running the provider whenever a user downloads a data asset. The fees for downloading an asset are set as a cost per MB. In addition, there is also a provider fee that is paid whenever a compute job is run, which is set as a price per minute. @@ -40,6 +40,8 @@ The download and compute fees can both be set to any absolute amount and you can Additionally, provider fees are not limited to data consumption — they can also be used to charge for compute resources. So, for example, this means a provider can charge a fixed fee of 15 DAI to reserve compute resources for 1 hour. This has a huge upside for both the user and the provider host. From the user’s perspective, this means that they can now reserve a suitable amount of compute resources according to what they require. For the host of the provider, this presents another great opportunity to create an income. -**Benefits to the Ocean Community** We’re always looking to give back to the Ocean community and collecting fees is an important part of that. As mentioned above, the Ocean Protocol Foundation retains the ability to implement community fees on data consumption. The tokens that we receive will either be burned or invested in the community via projects that they are building. These investments will take place either through [Data Farming](../archive/data-farming/), [Ocean Shipyard](https://oceanprotocol.com/shipyard), or Ocean Ventures. + +**Benefits to the Ocean Community** +We’re always looking to give back to the Ocean community and collecting fees is an important part of that. As mentioned above, the Ocean Protocol Foundation retains the ability to implement community fees on data consumption. The tokens that we receive will either be burned or invested in the community via projects that they are building. These investments will take place either through [Data Farming](../data-farming/README.md), [Ocean Shipyard](https://oceanprotocol.com/shipyard), or Ocean Ventures. Projects that utilize OCEAN or H2O are subject to a 0.1% fee. In the case of projects that opt to use different tokens, an additional 0.1% fee will be applied. We want to support marketplaces that use other tokens but we also recognize that they don’t bring the same wider benefit to the Ocean community, so we feel this small additional fee is proportionate. diff --git a/developers/compute-to-data/README.md b/developers/compute-to-data/README.md index be13d429..a2d1ef3a 100644 --- a/developers/compute-to-data/README.md +++ b/developers/compute-to-data/README.md @@ -36,7 +36,7 @@ We suggest reading these guides to get an understanding of how compute-to-data w ### 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/) +* [How to use compute to data with ocean.py](../../data-scientists/ocean.py/README.md) ### 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 dc64ce15..d3db7d4b 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/) and [ocean.js](../ocean.js/) 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/README.md) and [ocean.js](../ocean.js/README.md) 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/), 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/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. -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. +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. ### Operator Service diff --git a/developers/contracts/pricing-schemas.md b/developers/contracts/pricing-schemas.md index 7a1b2fc4..20875754 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/)and [Ocean.py](../../data-scientists/ocean.py/), 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/README.md)and [Ocean.py](../../data-scientists/ocean.py/README.md), 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/) 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. +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. diff --git a/developers/contracts/revenue.md b/developers/contracts/revenue.md index 112f383e..68aba74d 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/) 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. +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. 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 f8555fca..f5f2280e 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/) and [ocean.js](../ocean.js/) 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/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. 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,6 +63,7 @@ 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 @@ -293,6 +294,7 @@ 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 b6e2bdd1..24c5db2a 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/) JavaScript library, an integral part of the [Ocean Protocol](https://oceanprotocol.com) toolset. 🌐 +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. 🌐 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 643000f5..0c519dd0 100644 --- a/discover/README.md +++ b/discover/README.md @@ -1,4 +1,5 @@ --- +description: cover: ../.gitbook/assets/cover/discover_banner.png coverY: 7.413145539906106 --- @@ -7,30 +8,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/)**.** Build token-gated AI dApps & APIs -* [**Data scientists**](../data-scientists/)**.** Earn via predictions & challenges -* [**OCEAN holders**](../archive/data-farming/)**.** Get rewards by locking OCEAN & curating data, via Data Farming. -* [**Ocean ambassadors**](https://oceanprotocol.com/explore/community) +- **[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)** ### 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/), [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/README.md), [Bridges](networks/bridges.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_](../) diff --git a/discover/benefits.md b/discover/benefits.md index c959908b..ee376504 100644 --- a/discover/benefits.md +++ b/discover/benefits.md @@ -1,116 +1,118 @@ +--- +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/). +To dive deeper, please go to [Developers page](../developers/README.md). + ## What data scientists can do
- -
- +
-Use Ocean in Python +Use Ocean in Python -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. +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.
+
-Do crypto price predictions +Do crypto price predictions -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. +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.
+
-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/). +To dive deeper, please go to [Data Scientists page](../data-scientists/README.md). + ## What OCEAN holders can do
-Earn Rewards via Data Farming +Earn Rewards via Data Farming -Ocean's [Data Farming](../archive/data-farming/) incentives program enables OCEAN holders to earn by locking OCEAN, and curating data. +Ocean's [Data Farming](../data-farming/README.md) 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) +---- -_Back:_ [_What is Ocean?_](what-is-ocean.md) +_Next: [OCEAN: The Ocean token](ocean-token.md)_ + +_Back: [What is Ocean?](what-is-ocean.md)_ diff --git a/discover/glossary.md b/discover/glossary.md index 32c0e674..c0e917a9 100644 --- a/discover/glossary.md +++ b/discover/glossary.md @@ -1,5 +1,6 @@ --- -description: Key terms, concepts, and acronyms used in Ocean +description: >- + Key terms, concepts, and acronyms used in Ocean --- # Glossary @@ -9,7 +10,6 @@ description: Key terms, concepts, and acronyms used in Ocean
Ocean Protocol - Ocean Protocol is a decentralized data exchange protocol that enables individuals and organizations to share, sell, and consume data in a secure, transparent, and privacy-preserving manner. The protocol is designed to address the current challenges in data sharing, such as data silos, lack of interoperability, and data privacy concerns. Ocean Protocol uses blockchain technology, smart contracts, and cryptographic techniques to create a network where data providers can offer their data assets for sale, data consumers can purchase and access the data, and developers can build data-driven applications and services on top of the protocol.
@@ -84,7 +84,7 @@ In exchange for locking tokens, users can earn rewards. The amount of reward dep Ocean Data Farming (DF) -[Ocean Data Farming (DF)](https://df.oceandao.org/) incentivizes for growth of Data Consume Volume (DCV) in the Ocean ecosystem. [DF](../archive/data-farming/) is like DeFi liquidity mining, but tuned for DCV. DF emits OCEAN for passive rewards and active rewards. +[Ocean Data Farming (DF)](https://df.oceandao.org/) incentivizes for growth of Data Consume Volume (DCV) in the Ocean ecosystem. [DF](../data-farming/README.md) is like DeFi liquidity mining, but tuned for DCV. DF emits OCEAN for passive rewards and active rewards. * As a veOCEAN holder, you get _passive_ rewards by default. * If you _actively_ curate data by allocating veOCEAN towards data assets with high Data Consume Volume (DCV), then you can earn more. @@ -95,7 +95,7 @@ In exchange for locking tokens, users can earn rewards. The amount of reward dep Passive Rewards -When a user locks their OCEAN for a finite period of time, they get veOCEAN in return. Based on the quantity of veOCEAN, the user accumulates weekly OCEAN rewards. Because rewards are generated without human intervention, these are called [Passive Rewards](../archive/data-farming/). OCEAN Data Farming Passive Rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards). +When a user locks their OCEAN for a finite period of time, they get veOCEAN in return. Based on the quantity of veOCEAN, the user accumulates weekly OCEAN rewards. Because rewards are generated without human intervention, these are called [Passive Rewards](../data-farming/README.md). OCEAN Data Farming Passive Rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
@@ -103,7 +103,7 @@ When a user locks their OCEAN for a finite period of time, they get veOCEAN in r Volume DF -When a user allocates veOCEAN to Ocean Market projects, then weekly OCEAN rewards are given to a user based on the sales of those projects. Since these rewards depend on human intervention to decide the allocations, these are categorized as [Volume DF](../archive/data-farming/) rewards. OCEAN Data Farming Volume DF rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards). +When a user allocates veOCEAN to Ocean Market projects, then weekly OCEAN rewards are given to a user based on the sales of those projects. Since these rewards depend on human intervention to decide the allocations, these are categorized as [Volume DF](../data-farming/README.md) rewards. OCEAN Data Farming Volume DF rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards). @@ -149,6 +149,7 @@ Transfer one (of many) sub-licenses to new licensee: ERC20.transfer(to=licensee, + ## Web3 Fundamentals
@@ -419,10 +420,15 @@ Machine learning is a subfield of artificial intelligence (AI) that involves tea
-*** + +---- + Congrats! You've completed this quick introduction to Ocean. -_Next: Jump to_ [_Docs main_](../) _and click on your interest._ +_Next: Jump to [Docs main](../README.md) and click on your interest._ + +_Back: [FAQ](faq.md)_ + + -_Back:_ [_FAQ_](faq.md) diff --git a/discover/ocean-token.md b/discover/ocean-token.md index d47df7f5..04ec3fcc 100644 --- a/discover/ocean-token.md +++ b/discover/ocean-token.md @@ -1,30 +1,30 @@ -# OCEAN: The Ocean token +--- +description: +--- + +# OCEAN: The Ocean Token OCEAN is a utility token. It's used to stake on data for curation, buy & sell data, and more. Its supply is disbursed over time to drive near-term growth and long-term sustainability. **Contents:** +- Getting and storing OCEAN +- Staking OCEAN +- OCEAN supply +- Token design +- OCEAN addresses -* Getting and storing OCEAN -* Staking OCEAN -* OCEAN supply -* Token design -* OCEAN addresses +
-
- -
- -
## Getting and Storing OCEAN -OCEAN is available on most leading CEXes and DEXes. The [Ocean Token page at oceanprotocol.com](https://oceanprotocol.com/about-us/ocean-token) has details. +OCEAN is available on most leading CEXes and DEXes. The [Ocean Token page at oceanprotocol.com](https://oceanprotocol.com/about-us/ocean-token) has details. -The [Wallets User Guide](../user-guides/wallets/) here in Ocean docs shows how to set up wallets and store OCEAN. +The [Wallets User Guide](../user-guides/wallets/README.md) here in Ocean docs shows how to set up wallets and store OCEAN. ## Staking OCEAN -You can lock OCEAN and earn rewards via [Ocean Data Farming](../archive/data-farming/). +You can lock OCEAN and earn rewards via [Ocean Data Farming](../data-farming/README.md). ## OCEAN supply @@ -32,10 +32,10 @@ Total # tokens: 1.41B. All tokens are minted; all control is [revoked](https://b OCEAN supply is divided as follows: -* 51% (719.1M OCEAN) - to Data Farming and incentives programs. Distributed via vesting: burn-in period then 4-year half-life. For [Data Farming: Reward Schedule](../data-farming/reward-schedule.md) docs. -* 15% (211.5M OCEAN) - to Ocean community (grants, more) and foundation operations. -* 10% (141.0M OCEAN) - to the founding company, and in turn to its investors, employees & operations -* 24% (338.4M OCEAN) - to token acquirors. This completed in early 2019. All acquiror vesting is complete as well. +- 51% (719.1M OCEAN) - to Data Farming and incentives programs. Distributed via vesting: burn-in period then 4-year half-life. For [Data Farming: Reward Schedule](../data-farming/reward-schedule.md) docs. +- 15% (211.5M OCEAN) - to Ocean community (grants, more) and foundation operations. +- 10% (141.0M OCEAN) - to the founding company, and in turn to its investors, employees & operations +- 24% (338.4M OCEAN) - to token acquirors. This completed in early 2019. All acquiror vesting is complete as well. ## OCEAN Token Design @@ -45,20 +45,16 @@ This design gives flexibility to adapt the Ocean products for traction and growt In the design, a % of revenue is used to buy back & burn OCEAN. The remaining % drives growth. -
- -
- -
+
## OCEAN on Networks The "root" OCEAN token is deployed on Ethereum mainnet with address [`0x967da4048cd07ab37855c090aaf366e4ce1b9f48`](https://etherscan.io/token/0x967da4048cd07ab37855c090aaf366e4ce1b9f48). -The OCEAN token has bridges to several other chains. The [Networks docs](networks/) give the address of OCEAN on each network, and how to get OCEAN on each of those networks. +The OCEAN token has bridges to several other chains. The [Networks docs](networks/README.md) give the address of OCEAN on each network, and how to get OCEAN on each of those networks. -*** +---- -_Next:_ [_Networks_](networks/) +_Next: [Networks](networks/README.md)_ -_Back:_ [_What can you do with Ocean?_](benefits.md) +_Back: [What can you do with Ocean?](benefits.md)_ diff --git a/predictoor/README.md b/predictoor/README.md index cff267d1..a42648cf 100644 --- a/predictoor/README.md +++ b/predictoor/README.md @@ -2,8 +2,7 @@ description: Run AI-powered prediction bots or trading bots on crypto price feeds to earn $ --- -# 👀 Predictoor +**Predictoor docs are now at [docs.predictoor.ai](https://docs.predictoor.ai).** -**Predictoor docs are now at** [**docs.predictoor.ai**](https://docs.predictoor.ai)**.** +
-