mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
GITBOOK-168: Removed developer tutorials and moved the content in the developers section
This commit is contained in:
Ana Loznianu
gitbook-bot
parent
f24d95a5a7
commit
19c699a467
BIN
.gitbook/assets/balance-of (1) (1).png
Normal file
BIN
.gitbook/assets/balance-of (1) (1).png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
@ -7,4 +7,4 @@ layout: landing
|
||||
|
||||
# 👋 Welcome
|
||||
|
||||
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/discover.md">discover.md</a></td><td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td><td></td><td></td><td><a href="discover/discover.md">discover.md</a></td><td><a href=".gitbook/assets/landing/ocean.png">ocean.png</a></td></tr><tr><td><a href="how-tos/">how-tos</a></td><td>Whether you're new to Ocean or just need a refresher on a particular task, the "How to's" section is a great resource for quickly finding the information step-by-step instructions for what you need.</td><td></td><td></td><td><a href="how-tos/">how-tos</a></td><td><a href=".gitbook/assets/landing/developers.png">developers.png</a></td></tr><tr><td><a href="tutorials/">tutorials</a></td><td>Get access to a wealth of tutorials and resources to help you get started with Ocean Protocol. Learn how to create and publish data assets, build data marketplaces, and more. Whether you're a beginner or an experienced user, there's something for everyone.</td><td></td><td></td><td><a href="tutorials/">tutorials</a></td><td><a href=".gitbook/assets/landing/tutorials.png">tutorials.png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/landing/rewards.png">rewards.png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/landing/developers.png">developers.png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>Learn how to deploy your own components on the Ocean Protocol network. Discover how the platform leverages blockchain technology, decentralized storage, and other cutting-edge tools to enable secure and scalable data sharing.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/landing/building-blocks.png">building-blocks.png</a></td></tr><tr><td><a href="contribute/contributing.md">contributing.md</a></td><td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td><td></td><td></td><td><a href="contribute/contributing.md">contributing.md</a></td><td><a href=".gitbook/assets/landing/contribute.png">contribute.png</a></td></tr><tr><td><a href="defi.md">defi.md</a></td><td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td><td></td><td></td><td></td><td><a href=".gitbook/assets/landing/rewards.png">rewards.png</a></td></tr><tr><td><a href="data-science.md">data-science.md</a></td><td>Data science is the key to unlocking the true potential of decentralized data sharing. In this category, you'll find an abundance of tutorials and guides on various data science topics.</td><td></td><td></td><td></td><td><a href=".gitbook/assets/landing/tutorials.png">tutorials.png</a></td></tr><tr><td></td><td></td><td></td><td></td><td></td><td></td></tr></tbody></table>
|
||||
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/discover.md">discover.md</a></td><td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td><td></td><td></td><td><a href="discover/discover.md">discover.md</a></td><td><a href=".gitbook/assets/landing/ocean.png">ocean.png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Whether you're new to Ocean or just need a refresher on a particular task, the "How to's" section is a great resource for quickly finding the information step-by-step instructions for what you need.</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td><a href=".gitbook/assets/landing/developers.png">developers.png</a></td></tr><tr><td><a href="broken-reference">Broken link</a></td><td>Get access to a wealth of tutorials and resources to help you get started with Ocean Protocol. Learn how to create and publish data assets, build data marketplaces, and more. Whether you're a beginner or an experienced user, there's something for everyone.</td><td></td><td></td><td><a href="broken-reference">Broken link</a></td><td><a href=".gitbook/assets/landing/tutorials.png">tutorials.png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/landing/rewards.png">rewards.png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/landing/developers.png">developers.png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>Learn how to deploy your own components on the Ocean Protocol network. Discover how the platform leverages blockchain technology, decentralized storage, and other cutting-edge tools to enable secure and scalable data sharing.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/landing/building-blocks.png">building-blocks.png</a></td></tr><tr><td><a href="contribute/contributing.md">contributing.md</a></td><td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td><td></td><td></td><td><a href="contribute/contributing.md">contributing.md</a></td><td><a href=".gitbook/assets/landing/contribute.png">contribute.png</a></td></tr><tr><td><a href="defi.md">defi.md</a></td><td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td><td></td><td></td><td></td><td><a href=".gitbook/assets/landing/rewards.png">rewards.png</a></td></tr><tr><td><a href="data-science.md">data-science.md</a></td><td>Data science is the key to unlocking the true potential of decentralized data sharing. In this category, you'll find an abundance of tutorials and guides on various data science topics.</td><td></td><td></td><td></td><td><a href=".gitbook/assets/landing/tutorials.png">tutorials.png</a></td></tr><tr><td></td><td></td><td></td><td></td><td></td><td></td></tr></tbody></table>
|
||||
|
||||
81
SUMMARY.md
81
SUMMARY.md
@ -11,47 +11,22 @@
|
||||
* [Manage Your OCEAN Tokens](discover/wallets-and-ocean-tokens.md)
|
||||
* [Glossary](discover/glossary.md)
|
||||
* [FAQ](discover/faq.md)
|
||||
* [📜 How To's](how-tos/README.md)
|
||||
* [Publish an NFT](how-tos/marketplace-publish-data-asset.md)
|
||||
* [Download NFT Assets](how-tos/marketplace-download-data-asset.md)
|
||||
* [Sell NFT Outputs](how-tos/compute-to-data/README.md)
|
||||
* [Make a Boss C2D Algorithm](how-tos/compute-to-data/make-a-boss-c2d-algorithm.md)
|
||||
* [Publish a C2D Algorithm NFT](how-tos/compute-to-data/publish-a-c2d-algorithm-nft.md)
|
||||
* [Publish a C2D Data NFT](how-tos/compute-to-data/publish-a-c2d-data-nft.md)
|
||||
* [Host Assets](how-tos/asset-hosting/README.md)
|
||||
* [Arweave](how-tos/asset-hosting/arweave.md)
|
||||
* [AWS](how-tos/asset-hosting/aws.md)
|
||||
* [Azure Cloud](how-tos/asset-hosting/azure-cloud.md)
|
||||
* [Get veOCEAN Tokens](how-tos/get-veocean-tokens.md)
|
||||
* [How to Data Farm](how-tos/how-to-data-farm.md)
|
||||
* [Claim OCEAN Rewards](how-tos/claim-ocean-rewards.md)
|
||||
* [Guide to Ocean Market](how-tos/using-ocean-market.md)
|
||||
* [Liquidity Pools \[deprecated\]](how-tos/remove-liquidity-using-etherscan.md)
|
||||
* [📚 Developer Tutorials](tutorials/README.md)
|
||||
* [Build a Marketplace](tutorials/build-a-marketplace/README.md)
|
||||
* [Forking Ocean Market](tutorials/build-a-marketplace/forking-ocean-market.md)
|
||||
* [Customising a Market](tutorials/build-a-marketplace/customising-your-market.md)
|
||||
* [Deploying a Market](tutorials/build-a-marketplace/deploying-market.md)
|
||||
* [Using Ocean Subgraph](tutorials/using-ocean-subgraph/README.md)
|
||||
* [List data NFTs](tutorials/using-ocean-subgraph/list-data-nfts.md)
|
||||
* [List all Tokens](tutorials/using-ocean-subgraph/list-datatokens.md)
|
||||
* [Get Data NFT Information](tutorials/using-ocean-subgraph/get-data-nft-information.md)
|
||||
* [Get Datatoken Information](tutorials/using-ocean-subgraph/get-datatoken-information.md)
|
||||
* [List Fixed Rate Exchanges](tutorials/using-ocean-subgraph/list-fixed-rate-exchanges.md)
|
||||
* [Using Ocean Libraries](tutorials/using-ocean-libraries/README.md)
|
||||
* [Configuration](tutorials/using-ocean-libraries/configuration.md)
|
||||
* [Creating a data NFT](tutorials/using-ocean-libraries/creating-dataNFT.md)
|
||||
* [Publish with Fixed Pricing](tutorials/using-ocean-libraries/create-datatoken-with-fixed-pricing.md)
|
||||
* [Mint Datatokens](tutorials/using-ocean-libraries/mint-datatoken.md)
|
||||
* [Update Metadata](tutorials/using-ocean-libraries/update-metadata.md)
|
||||
* [🤑 DeFi](defi.md)
|
||||
* [💰 Rewards](rewards/README.md)
|
||||
* [Data Farming 101](rewards/df-intro.md)
|
||||
* [veOCEAN](rewards/veocean.md)
|
||||
* [Data Farming Background](rewards/df-background.md)
|
||||
* [Emissions & APYs](rewards/emissions-apys.md)
|
||||
* [Rewards Tutorial](rewards/veOcean-Data-Farming-Tutorial.md)
|
||||
* [📊 Data Science](data-science.md)
|
||||
* [📚 User Guides](user-guides/README.md)
|
||||
* [Publish an NFT](user-guides/marketplace-publish-data-asset.md)
|
||||
* [Download NFT Assets](user-guides/marketplace-download-data-asset.md)
|
||||
* [Sell NFT Outputs](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)
|
||||
* [Arweave](user-guides/asset-hosting/arweave.md)
|
||||
* [AWS](user-guides/asset-hosting/aws.md)
|
||||
* [Azure Cloud](user-guides/asset-hosting/azure-cloud.md)
|
||||
* [Get veOCEAN Tokens](user-guides/get-veocean-tokens.md)
|
||||
* [How to Data Farm](user-guides/how-to-data-farm.md)
|
||||
* [Claim OCEAN Rewards](user-guides/claim-ocean-rewards.md)
|
||||
* [Guide to Ocean Market](user-guides/using-ocean-market.md)
|
||||
* [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-using-etherscan.md)
|
||||
* [👨💻 Developers](developers/README.md)
|
||||
* [Architecture Overview](developers/architecture.md)
|
||||
* [Data NFTs and Datatokens](developers/datanft-and-datatoken.md)
|
||||
@ -62,6 +37,22 @@
|
||||
* [DDO Specification](developers/ddo-specification.md)
|
||||
* [Storage Specifications](developers/storage-specifications.md)
|
||||
* [Fine-Grained Permissions](developers/Fine-Grained-Permissions.md)
|
||||
* [Build a Marketplace](developers/build-a-marketplace/README.md)
|
||||
* [Forking Ocean Market](developers/build-a-marketplace/forking-ocean-market.md)
|
||||
* [Customising a Market](developers/build-a-marketplace/customising-your-market.md)
|
||||
* [Deploying a Market](developers/build-a-marketplace/deploying-market.md)
|
||||
* [Using Ocean Subgraph](developers/using-ocean-subgraph/README.md)
|
||||
* [List data NFTs](developers/using-ocean-subgraph/list-data-nfts.md)
|
||||
* [List all Tokens](developers/using-ocean-subgraph/list-datatokens.md)
|
||||
* [Get Data NFT Information](developers/using-ocean-subgraph/get-data-nft-information.md)
|
||||
* [Get Datatoken Information](developers/using-ocean-subgraph/get-datatoken-information.md)
|
||||
* [List Fixed Rate Exchanges](developers/using-ocean-subgraph/list-fixed-rate-exchanges.md)
|
||||
* [Using Ocean Libraries](developers/using-ocean-libraries/README.md)
|
||||
* [Configuration](developers/using-ocean-libraries/configuration.md)
|
||||
* [Creating a data NFT](developers/using-ocean-libraries/creating-datanft.md)
|
||||
* [Publish with Fixed Pricing](developers/using-ocean-libraries/create-datatoken-with-fixed-pricing.md)
|
||||
* [Mint Datatokens](developers/using-ocean-libraries/mint-datatoken.md)
|
||||
* [Update Metadata](developers/using-ocean-libraries/update-metadata.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)
|
||||
@ -71,6 +62,7 @@
|
||||
* [Aquarius](developers/apis/aquarius.md)
|
||||
* [Provider](developers/apis/provider.md)
|
||||
* [Subgraph](developers/apis/subgraph.md)
|
||||
* [📊 Data Science](data-science.md)
|
||||
* [🔨 Infrastructure](infrastructure/README.md)
|
||||
* [Setup a Server](infrastructure/setup-server.md)
|
||||
* [Deploying Marketplace](infrastructure/deploying-marketplace.md)
|
||||
@ -79,6 +71,13 @@
|
||||
* [Deploying Ocean Subgraph](infrastructure/deploying-ocean-subgraph.md)
|
||||
* [C2D - Minikube Environment](infrastructure/compute-to-data-minikube.md)
|
||||
* [C2D - Private Docker Registry](infrastructure/compute-to-data-docker-registry.md)
|
||||
* [🤑 DeFi](defi.md)
|
||||
* [💰 Rewards](rewards/README.md)
|
||||
* [Data Farming 101](rewards/df-intro.md)
|
||||
* [veOCEAN](rewards/veocean.md)
|
||||
* [Data Farming Background](rewards/df-background.md)
|
||||
* [Emissions & APYs](rewards/emissions-apys.md)
|
||||
* [Rewards Tutorial](rewards/veOcean-Data-Farming-Tutorial.md)
|
||||
* [🤝 Contribute](contribute/contributing.md)
|
||||
* [Partners & Collaborators](contribute/projects-using-ocean.md)
|
||||
* [Contributor Code of Conduct](contribute/code-of-conduct.md)
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Core concepts
|
||||
# 👨💻 Developers
|
||||
|
||||
## What is Ocean?
|
||||
|
||||
@ -6,14 +6,14 @@ Ocean provides the next generation of tools to unlock data at a large scale. Oce
|
||||
|
||||
Ocean uses Data NFTs (ERC721) and datatokens (ERC20) as the interface to connect data assets with blockchain and DeFi tools. Crypto wallets become data wallets, crypto exchanges become data marketplaces, DAOs for data co-ops, and more via DeFi composability.
|
||||
|
||||
|
||||
|
||||
|
||||
The following guides are a greate place to start if you are new to Ocean:
|
||||
|
||||
* [Architecture Overview](architecture.md)
|
||||
* [Data NFTs and Datatokens](datanft-and-datatoken.md)
|
||||
* [Publish a data asset](../../how-tos/marketplace-publish-data-asset.md)
|
||||
* [Download a data asset](../../how-tos/marketplace-download-data-asset.md)
|
||||
* [Publish a data asset](../user-guides/marketplace-publish-data-asset.md)
|
||||
* [Download a data asset](../user-guides/marketplace-download-data-asset.md)
|
||||
|
||||
## What is our Mission?
|
||||
|
||||
@ -33,25 +33,25 @@ Use Ocean Market to publish and sell data, or browse and buy data. Data is publi
|
||||
|
||||
As a data scientist or AI practitioner, you can benefit from access to more data (including private data), crypto-secured provenance in data & AI training, and income opportunities for selling data and curating data.
|
||||
|
||||
|
||||
|
||||
|
||||
The following guides will help you get started with buying and selling data:
|
||||
|
||||
* [Publish a data asset](../../how-tos/marketplace-publish-data-asset.md)
|
||||
* [Download a data asset](../../how-tos/marketplace-download-data-asset.md)
|
||||
* [Publishing with hosting services](../../how-tos/asset-hosting/)
|
||||
* [Publish a data asset](../user-guides/marketplace-publish-data-asset.md)
|
||||
* [Download a data asset](../user-guides/marketplace-download-data-asset.md)
|
||||
* [Publishing with hosting services](../user-guides/asset-hosting/)
|
||||
|
||||
### Build Your Own Data Market
|
||||
|
||||
Use Ocean Protocol software tools to build your own data marketplace, by either forking [Ocean Market](https://v4.market.oceanprotocol.com/) code or building up with Ocean components.
|
||||
|
||||
|
||||
|
||||
|
||||
If you're interested in starting your own marketplace checkout the following guides:
|
||||
|
||||
* [Forking Ocean Market](../../tutorials/build-a-marketplace/forking-ocean-market.md)
|
||||
* [Customising your market](../../tutorials/build-a-marketplace/customising-your-market.md)
|
||||
* [Deploying your market](../../tutorials/build-a-marketplace/deploying-market.md)
|
||||
* [Forking Ocean Market](build-a-marketplace/forking-ocean-market.md)
|
||||
* [Customising your market](build-a-marketplace/customising-your-market.md)
|
||||
* [Deploying your market](build-a-marketplace/deploying-market.md)
|
||||
|
||||
### Manage datatokens and data NFTs for use in DeFi
|
||||
|
||||
@ -61,7 +61,7 @@ Use Ocean [JavaScript](https://github.com/oceanprotocol/ocean.js) or [Python](ht
|
||||
|
||||
Ocean-based apps make data asset on-ramps and off-ramps easy for end users. Ocean smart contracts and libraries make this easy for developers. The data itself does not need to be on-chain, just the access control.
|
||||
|
||||
|
||||
|
||||
|
||||
Data NFTs are ERC721 tokens representing the unique asset and datatokens are ERC20 tokens to access data services. Each data service gets its own data NFT and one or more type of datatokens.
|
||||
|
||||
@ -81,7 +81,7 @@ Compute-to-data resolves the tradeoff between the benefits of using private data
|
||||
|
||||
The most valuable data is private data — using it can improve research and business outcomes. But concerns over privacy and control make it hard to access. With Compute-to-Data, private data isn’t directly shared but rather specific access to it is granted.
|
||||
|
||||
|
||||
|
||||
|
||||
It can be used for data sharing in science or technology contexts, or in marketplaces for selling private data while preserving privacy, as an opportunity for companies to monetize their data assets.
|
||||
|
||||
@ -91,9 +91,9 @@ Checkout these guides if you are aiming to get a deeper understanding on how com
|
||||
|
||||
* [Architecture](compute-to-data-architecture.md)
|
||||
* [Datasets & Algorithms](compute-to-data-datasets-algorithms.md)
|
||||
* [Minikube Environment](../../infrastructure/compute-to-data-minikube.md)
|
||||
* [Minikube Environment](../infrastructure/compute-to-data-minikube.md)
|
||||
* [Writing Algorithms](compute-to-data-algorithms.md)
|
||||
* [Private docker registry](../../infrastructure/compute-to-data-docker-registry.md)
|
||||
* [Private docker registry](../infrastructure/compute-to-data-docker-registry.md)
|
||||
|
||||
## How does it work?
|
||||
|
||||
@ -103,23 +103,23 @@ Ocean Protocol provides tools for developers to _build data markets_, and to _ma
|
||||
|
||||
If you are new to web3 and blockchain technologies then we suggest you first read these introductory guides:
|
||||
|
||||
* [Wallet Basics](../../discover/wallets.md)
|
||||
* [Set Up MetaMask Wallet](../../discover/metamask-setup.md)
|
||||
* [Manage Your OCEAN Tokens](../../discover/wallets-and-ocean-tokens.md)
|
||||
* [Wallet Basics](../discover/wallets.md)
|
||||
* [Set Up MetaMask Wallet](../discover/metamask-setup.md)
|
||||
* [Manage Your OCEAN Tokens](../discover/wallets-and-ocean-tokens.md)
|
||||
|
||||
If ou are looking to get to grips with the inner workings of Ocean, then you'll be interested in the following guides:
|
||||
|
||||
* [Architecture Overview](architecture.md)
|
||||
* [Data NFTs and Datatokens](datanft-and-datatoken.md)
|
||||
* [Networks](../../discover/networks/)
|
||||
* [Networks](../discover/networks/)
|
||||
* [Fees](fees.md)
|
||||
* [Asset pricing](asset-pricing.md)
|
||||
* [DID & DDO](did-ddo.md)
|
||||
* [Roles](roles.md)
|
||||
* [Set Up a Marketplace](../../tutorials/build-a-marketplace/marketplace.md)
|
||||
* [Set Up a Marketplace](../tutorials/build-a-marketplace/marketplace.md)
|
||||
* [Compute-to-Data](compute-to-data/)
|
||||
* [Deploying components](../../infrastructure/)
|
||||
* [Contributing](../../contribute/contributing.md)
|
||||
* [Deploying components](../infrastructure/)
|
||||
* [Contributing](../contribute/contributing.md)
|
||||
|
||||
## Supporters
|
||||
|
||||
|
||||
@ -9,16 +9,16 @@ description: Data NFTs and datatokens architecture
|
||||
|
||||
Here is the Ocean architecture.
|
||||
|
||||
|
||||
|
||||
|
||||
Here’s an overview of the figure.
|
||||
|
||||
- The top layer is **applications** like Ocean Market. With these apps, users can onboard services like data, algorithms, compute-to-data into crypto (publish and mint data NFTs and datatokens), hold datatokens as assets (data wallets), discover assets, and buy/sell datatokens for a fixed or auto-determined price (data marketplaces), and use data services (spend datatokens).
|
||||
- Below are **libraries** used by the applications: Ocean.js (JavaScript library) and Ocean.py (Python library). This also includes middleware to assist discovery:
|
||||
- **Aquarius**: Provides metadata cache for faster search by caching on-chain data into elasticsearch
|
||||
- **Provider**: Facilitates downloading assets, DDO encryption, and communicating with `operator-service` for Compute-to-Data jobs.
|
||||
- **The Graph**: It is a 3rd party tool that developers can utilize the libraries to build their custom applications and marketplaces.
|
||||
- The lowest level has the **smart contracts**. The smart contracts are deployed on the Ethereum mainnet and other compatible networks. Libraries encapsulate the calls to these smart contracts and provide features like publishing new assets, facilitating consumption, managing pricing, and much more. To see the supported networks click [here](networks.md).
|
||||
* The top layer is **applications** like Ocean Market. With these apps, users can onboard services like data, algorithms, compute-to-data into crypto (publish and mint data NFTs and datatokens), hold datatokens as assets (data wallets), discover assets, and buy/sell datatokens for a fixed or auto-determined price (data marketplaces), and use data services (spend datatokens).
|
||||
* Below are **libraries** used by the applications: Ocean.js (JavaScript library) and Ocean.py (Python library). This also includes middleware to assist discovery:
|
||||
* **Aquarius**: Provides metadata cache for faster search by caching on-chain data into elasticsearch
|
||||
* **Provider**: Facilitates downloading assets, DDO encryption, and communicating with `operator-service` for Compute-to-Data jobs.
|
||||
* **The Graph**: It is a 3rd party tool that developers can utilize the libraries to build their custom applications and marketplaces.
|
||||
* The lowest level has the **smart contracts**. The smart contracts are deployed on the Ethereum mainnet and other compatible networks. Libraries encapsulate the calls to these smart contracts and provide features like publishing new assets, facilitating consumption, managing pricing, and much more. To see the supported networks click [here](core-concepts/networks.md).
|
||||
|
||||
### Data NFTs, Datatokens and Access Control Tools
|
||||
|
||||
@ -52,9 +52,9 @@ Complementary to Ocean Market, Ocean has reference code to ease building **third
|
||||
|
||||
### Metadata Tools
|
||||
|
||||
Marketplaces use the Metadata of the asset for discovery. Metadata consists of information like the type of asset, name of the asset, creation date, license, etc. Each data asset can have a [decentralized identifier](https://w3c-ccg.github.io/did-spec/) (DID) that resolves to a DID document (DDO) for associated metadata. The DDO is essentially [JSON](https://www.json.org/) filling in metadata fields. For more details on working with OCEAN DIDs check out the [DID concept documentation](did-ddo.md). The [DDO Metadata documentation](did-ddo.md#metadata) goes into more depth regarding metadata structure.
|
||||
Marketplaces use the Metadata of the asset for discovery. Metadata consists of information like the type of asset, name of the asset, creation date, license, etc. Each data asset can have a [decentralized identifier](https://w3c-ccg.github.io/did-spec/) (DID) that resolves to a DID document (DDO) for associated metadata. The DDO is essentially [JSON](https://www.json.org/) filling in metadata fields. For more details on working with OCEAN DIDs check out the [DID concept documentation](broken-reference). The [DDO Metadata documentation](broken-reference) goes into more depth regarding metadata structure.
|
||||
|
||||
[OEP8](did-ddo.md) specifies Ocean metadata schema, including fields that must be filled. It’s based on the public [DataSet schema from schema.org](https://schema.org/Dataset).
|
||||
[OEP8](broken-reference) specifies Ocean metadata schema, including fields that must be filled. It’s based on the public [DataSet schema from schema.org](https://schema.org/Dataset).
|
||||
|
||||
Ocean uses the Ethereum mainnet and other compatible networks as an **on-chain metadata store**, i.e. to store both DID and DDO. This means that once the transaction fee is paid, there are no further expenses or devops work needed to ensure metadata availability into the future, aiding in the discoverability of data assets. It also simplifies integration with the rest of the Ocean system, which is Ethereum-based. Storage cost on Ethereum mainnet is not negligible, but not prohibitive and the other benefits are currently worth the trade-off compared to alternatives.
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ A [FixedRateExchange](https://github.com/oceanprotocol/contracts/blob/v4main/con
|
||||
|
||||
The image below shows how to set the fixed pricing of an asset in the Ocean's Marketplace. Here, the price of the asset is set to 10 Ocean tokens.
|
||||
|
||||
|
||||
|
||||
|
||||
### Free pricing
|
||||
|
||||
@ -29,4 +29,4 @@ Free pricing is suitable for individuals and organizations working in the public
|
||||
|
||||
The image below shows how to set free access to an asset in the Ocean's Marketplace.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,9 +19,9 @@ Using Ocean Market is already a big improvement on the alternatives that are out
|
||||
|
||||
The tutorial covers:
|
||||
|
||||
- Forking and running Ocean Market locally
|
||||
- Customising your fork of Ocean market
|
||||
- Quick deployment of Ocean Market
|
||||
* Forking and running Ocean Market locally
|
||||
* Customising your fork of Ocean market
|
||||
* Quick deployment of Ocean Market
|
||||
|
||||
## Preparation
|
||||
|
||||
@ -29,14 +29,14 @@ The tutorial covers:
|
||||
|
||||
If you’re completely unfamiliar with Ocean Market or web3 applications in general, you will benefit from reading these guides first:
|
||||
|
||||
- To use your clone of Ocean Market, you’ll need a [wallet](../wallets.md). We recommend [getting set up with metamask](../../orientation/metamask-setup.md).
|
||||
- You’ll also need some [Ocean tokens on a testnet](../wallets-and-ocean-tokens.md) to use your marketplace.
|
||||
- When you have the testnet tokens, have a go at [publishing a data asset](../../using-ocean-market/marketplace-publish-data-asset.md) on Ocean Market.
|
||||
- Run through the process of [consuming a data asset](../../using-ocean-market/marketplace-download-data-asset.md) on Ocean Market.
|
||||
* To use your clone of Ocean Market, you’ll need a [wallet](../../tutorials/wallets.md). We recommend [getting set up with metamask](../../orientation/metamask-setup.md).
|
||||
* You’ll also need some [Ocean tokens on a testnet](../../tutorials/wallets-and-ocean-tokens.md) to use your marketplace.
|
||||
* When you have the testnet tokens, have a go at [publishing a data asset](../../using-ocean-market/marketplace-publish-data-asset.md) on Ocean Market.
|
||||
* Run through the process of [consuming a data asset](../../using-ocean-market/marketplace-download-data-asset.md) on Ocean Market.
|
||||
|
||||
**Required Prerequisites**
|
||||
|
||||
- Git. Instructions for installing Git can be found [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
|
||||
- Node.js can be downloaded from [here](https://nodejs.org/en/download/) (we’re using version 16 in this guide)
|
||||
- A decent code editor, such as [Visual Studio Code](https://code.visualstudio.com/).
|
||||
- You’ll need a Github account to fork Ocean market via [Github](https://github.com/).
|
||||
* Git. Instructions for installing Git can be found [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
|
||||
* Node.js can be downloaded from [here](https://nodejs.org/en/download/) (we’re using version 16 in this guide)
|
||||
* A decent code editor, such as [Visual Studio Code](https://code.visualstudio.com/).
|
||||
* You’ll need a Github account to fork Ocean market via [Github](https://github.com/).
|
||||
@ -11,7 +11,7 @@ A non-fungible token stored on the blockchain represents a unique asset. NFTs ca
|
||||
|
||||
Fungible tokens represent fungible assets. If you have 5 ETH and Alice has 5 ETH, you and Alice could swap your ETH and your final holdings remain the same. They're apples-to-apples. Licenses (contracts) to access a copyrighted asset are naturally fungible - they can be swapped with each other.
|
||||
|
||||
|
||||
|
||||
|
||||
## What is a Data NFT?
|
||||
|
||||
@ -62,7 +62,7 @@ Ocean provides convenient methods to list ERC20 datatokens for sale, with fixed-
|
||||
|
||||
### High-Level Behavior
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
Here's an example.
|
||||
|
||||
@ -77,7 +77,7 @@ In some situations, you may want the revenue to be sent to another account rathe
|
||||
|
||||
In order to set a new payment collector, you need to visit the asset detail page and then click on “Edit Asset” and then scroll down to the field call “Payment Collector Address”. Add the new Ethereum address in this field and then click “Submit“. Finally, you will then need to sign two transactions to finalize the update.
|
||||
|
||||
|
||||
|
||||
|
||||
### TemplateIds
|
||||
|
||||
|
||||
@ -41,7 +41,7 @@ These are a few examples of what can be built on top of Ocean.
|
||||
|
||||
You can choose from two options:
|
||||
|
||||
1. **Fork the** [**Ocean Marketplace**](https://github.com/oceanprotocol/market) **and customize it**: You have the ability to fork the existing [Ocean Marketplace](https://github.com/oceanprotocol/market) codebase and customize it according to your needs. This allows you to leverage the foundational infrastructure and functionality already built by Ocean Protocol while tailoring the user interface, features, and branding to align with your marketplace vision. Follow this [tutorial](../tutorials/build-a-marketplace/) to learn how to do it.
|
||||
1. **Fork the** [**Ocean Marketplace**](https://github.com/oceanprotocol/market) **and customize it**: You have the ability to fork the existing [Ocean Marketplace](https://github.com/oceanprotocol/market) codebase and customize it according to your needs. This allows you to leverage the foundational infrastructure and functionality already built by Ocean Protocol while tailoring the user interface, features, and branding to align with your marketplace vision. Follow this [tutorial](../developers/build-a-marketplace/) to learn how to do it.
|
||||
2. **Build your marketplace with Ocean components**: Alternatively, you can build your data marketplace from scratch using Ocean Protocol's modular components. Ocean provides a comprehensive set of building blocks, such as the [**Aquarius**](https://github.com/oceanprotocol/aquarius), [**Provider**](https://github.com/oceanprotocol/provider), Ocean [contracts](https://github.com/oceanprotocol/contracts), and Ocean libraries([**ocean.js**](https://github.com/oceanprotocol/ocean.js) & [**ocean.py**](https://github.com/oceanprotocol/ocean.py)), which you can integrate into your own marketplace development. This empowers you to create a unique and customized data marketplace experience while leveraging the underlying capabilities and standards provided by Ocean Protocol.
|
||||
|
||||
</details>
|
||||
@ -64,9 +64,9 @@ To showcase these capabilities, Ocean developed a demonstrator marketplace known
|
||||
|
||||
The following guides will help you get started with buying and selling data:
|
||||
|
||||
* [Publish an NFT](../how-tos/marketplace-publish-data-asset.md)
|
||||
* [Download an NFT](../how-tos/marketplace-download-data-asset.md)
|
||||
* [Host Assets](../how-tos/asset-hosting/)
|
||||
* [Publish an NFT](../user-guides/marketplace-publish-data-asset.md)
|
||||
* [Download an NFT](../user-guides/marketplace-download-data-asset.md)
|
||||
* [Host Assets](../user-guides/asset-hosting/)
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
@ -1,2 +0,0 @@
|
||||
# 📜 How To's
|
||||
|
||||
@ -28,7 +28,7 @@ Select Ubuntu OS and choose a plan. The required CPU, Memory depends on the numb
|
||||
|
||||
Also, select the region where you want Aquarius to be hosted and a root password.
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,2 +0,0 @@
|
||||
# 📚 Tutorials
|
||||
|
||||
2
user-guides/README.md
Normal file
2
user-guides/README.md
Normal file
@ -0,0 +1,2 @@
|
||||
# 📚 User Guides
|
||||
|
||||
@ -24,7 +24,7 @@ Read on, anon, if you are interested in the security details!
|
||||
These guys know what's up
|
||||
{% endembed %}
|
||||
|
||||
When you publish your asset as an NFT, then the URL/TX ID/CID required to access the asset is encrypted and stored as a part of the NFT's [DDO](../../developers/core-concepts/did-ddo.md) on the blockchain. Buyers don't have access directly to this information, but they interact with the [Provider](https://github.com/oceanprotocol/provider#provider), which decrypts the DDO and acts as a proxy to serve the asset. 
|
||||
When you publish your asset as an NFT, then the URL/TX ID/CID required to access the asset is encrypted and stored as a part of the NFT's [DDO](broken-reference) on the blockchain. Buyers don't have access directly to this information, but they interact with the [Provider](https://github.com/oceanprotocol/provider#provider), which decrypts the DDO and acts as a proxy to serve the asset. 
|
||||
|
||||
We recommend implementing a security policy that allows **only the Provider's IP address to access the file** and blocks requests from other unauthorized actors is recommended. Since not all hosting services provide this feature, **you must carefully consider the security features while choosing a hosting service.**
|
||||
|
||||
@ -18,41 +18,41 @@ Create an account on [Azure](https://azure.microsoft.com/en-us/). Users might al
|
||||
|
||||
Go to the Azure portal: https://portal.azure.com/#home and select `Storage accounts` as shown below.
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Create a new storage account**
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
**Fill in the details**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Storage account created**
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
**Step 2 - Create a blob container**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Step 3 - Upload a file**
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
**Step 4 - Share the file**
|
||||
|
||||
**Select the file to be published and click Generate SAS**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Configure the SAS details and click `Generate SAS token and URL`**
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
**Copy the generated link**
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
**Step 5 - Publish the asset using the generated link**
|
||||
|
||||
@ -12,7 +12,7 @@ Want to begin [data farming](https://df.oceandao.org)? Start [here](get-veocean-
|
||||
|
||||
Go to [https://df.oceandao.org/](https://df.oceandao.org), and click the Rewards [link](https://df.oceandao.org/activerewards) at the top of the page.
|
||||
|
||||
<figure><img src="../.gitbook/assets/Rewards-Tab (1).png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/Rewards-Tab.png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
|
||||
|
||||
### Step 2 - Click the pink 'Claim # OCEAN' buttons 🛎️
|
||||
|
||||
@ -48,7 +48,7 @@ description: How to publish a C2D algorithm NFT on the Ocean Market
|
||||
|
||||
* Your preview should look like the following:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/preview-publish (1).png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/preview-publish.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
#### Step 8 - Submit the transactions
|
||||
|
||||
@ -76,7 +76,7 @@ description: How to publish a data NFT with C2D configurations
|
||||
|
||||
#### 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:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/double-check-work.png" alt="" width="375"><figcaption><p>Your algorithm should appear now on the data NFT's page!</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/double-check-work (1).png" alt="" width="375"><figcaption><p>Your algorithm should appear now on the data NFT's page!</p></figcaption></figure>
|
||||
|
||||
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.
|
||||
|
||||
@ -93,9 +93,9 @@ With the _fixed pricing_ schema, the publisher sets the price that buyers will p
|
||||
|
||||
With the _free pricing_ schema, the publisher provides an asset that is free to be downloaded by anyone.
|
||||
|
||||
For more information on the pricing models, please refer this [document](../developers/core-concepts/asset-pricing.md).
|
||||
For more information on the pricing models, please refer this [document](../developers/asset-pricing.md).
|
||||
|
||||
For a deep dive into the fee structure, please refer to this [document](../developers/core-concepts/fees.md).
|
||||
For a deep dive into the fee structure, please refer to this [document](../developers/fees.md).
|
||||
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ Liquidity pools and dynamic pricing used to be supported in previous versions of
|
||||
|
||||
4\. Go to field `20. balanceOf` and insert your ETH address. This will retrieve your pool share token balance in wei.
|
||||
|
||||
<figure><img src="../.gitbook/assets/balance-of.png" alt=""><figcaption><p>Balance Of</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/balance-of (1).png" alt=""><figcaption><p>Balance Of</p></figcaption></figure>
|
||||
|
||||
5\. Copy this number as later you will use it as the `poolAmountIn` parameter.
|
||||
|
||||
@ -39,4 +39,4 @@ Liquidity pools and dynamic pricing used to be supported in previous versions of
|
||||
|
||||
10\. Confirm transaction in Metamask
|
||||
|
||||
<figure><img src="../.gitbook/assets/confirm-metamask.png" alt=""><figcaption><p>Confirm transaction</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/liquidity/remove-liquidity-6.png" alt=""><figcaption><p>Confirm transaction</p></figcaption></figure>
|
||||
Loading…
Reference in New Issue
Block a user