diff --git a/.gitbook/assets/OceanONDA.png b/.gitbook/assets/OceanONDA.png new file mode 100644 index 00000000..ee0bd6c5 Binary files /dev/null and b/.gitbook/assets/OceanONDA.png differ diff --git a/.gitbook/assets/architecture/high-level-flow (1).png b/.gitbook/assets/architecture/high-level-flow (1).png new file mode 100644 index 00000000..a581963f Binary files /dev/null and b/.gitbook/assets/architecture/high-level-flow (1).png differ diff --git a/.gitbook/assets/building-blocks.png b/.gitbook/assets/building-blocks.png new file mode 100644 index 00000000..f11e6bbd Binary files /dev/null and b/.gitbook/assets/building-blocks.png differ diff --git a/.gitbook/assets/contribute.png b/.gitbook/assets/contribute.png new file mode 100644 index 00000000..df4bf290 Binary files /dev/null and b/.gitbook/assets/contribute.png differ diff --git a/.gitbook/assets/developers.png b/.gitbook/assets/developers.png new file mode 100644 index 00000000..aacdef6e Binary files /dev/null and b/.gitbook/assets/developers.png differ diff --git a/.gitbook/assets/hosting/azure1 (1).png b/.gitbook/assets/hosting/azure1 (1).png new file mode 100644 index 00000000..fa00009a Binary files /dev/null and b/.gitbook/assets/hosting/azure1 (1).png differ diff --git a/.gitbook/assets/hosting/azure2 (1).png b/.gitbook/assets/hosting/azure2 (1).png new file mode 100644 index 00000000..511ff199 Binary files /dev/null and b/.gitbook/assets/hosting/azure2 (1).png differ diff --git a/.gitbook/assets/hosting/azure3 (1).png b/.gitbook/assets/hosting/azure3 (1).png new file mode 100644 index 00000000..4cf63916 Binary files /dev/null and b/.gitbook/assets/hosting/azure3 (1).png differ diff --git a/.gitbook/assets/hosting/azure4 (1).png b/.gitbook/assets/hosting/azure4 (1).png new file mode 100644 index 00000000..2b074641 Binary files /dev/null and b/.gitbook/assets/hosting/azure4 (1).png differ diff --git a/.gitbook/assets/hosting/azure5 (1).png b/.gitbook/assets/hosting/azure5 (1).png new file mode 100644 index 00000000..c07525e5 Binary files /dev/null and b/.gitbook/assets/hosting/azure5 (1).png differ diff --git a/.gitbook/assets/hosting/azure6 (1).png b/.gitbook/assets/hosting/azure6 (1).png new file mode 100644 index 00000000..4c576189 Binary files /dev/null and b/.gitbook/assets/hosting/azure6 (1).png differ diff --git a/.gitbook/assets/hosting/azure7 (1).png b/.gitbook/assets/hosting/azure7 (1).png new file mode 100644 index 00000000..000dc780 Binary files /dev/null and b/.gitbook/assets/hosting/azure7 (1).png differ diff --git a/.gitbook/assets/hosting/azure8 (1).png b/.gitbook/assets/hosting/azure8 (1).png new file mode 100644 index 00000000..d424ccae Binary files /dev/null and b/.gitbook/assets/hosting/azure8 (1).png differ diff --git a/.gitbook/assets/hosting/azure9 (1).png b/.gitbook/assets/hosting/azure9 (1).png new file mode 100644 index 00000000..f46b3c23 Binary files /dev/null and b/.gitbook/assets/hosting/azure9 (1).png differ diff --git a/.gitbook/assets/ocean.png b/.gitbook/assets/ocean.png new file mode 100644 index 00000000..8547af99 Binary files /dev/null and b/.gitbook/assets/ocean.png differ diff --git a/.gitbook/assets/rewards-background.png b/.gitbook/assets/rewards-background.png new file mode 100644 index 00000000..0ba8025a Binary files /dev/null and b/.gitbook/assets/rewards-background.png differ diff --git a/.gitbook/assets/tutorials.png b/.gitbook/assets/tutorials.png new file mode 100644 index 00000000..351ecef5 Binary files /dev/null and b/.gitbook/assets/tutorials.png differ diff --git a/.gitbook/assets/wallet/login-options (1).png b/.gitbook/assets/wallet/login-options (1).png new file mode 100644 index 00000000..187f2446 Binary files /dev/null and b/.gitbook/assets/wallet/login-options (1).png differ diff --git a/.gitbook/assets/wallet/matic-bridge (1).png b/.gitbook/assets/wallet/matic-bridge (1).png new file mode 100644 index 00000000..2c35cbdb Binary files /dev/null and b/.gitbook/assets/wallet/matic-bridge (1).png differ diff --git a/.gitbook/assets/wallet/transferring (1).png b/.gitbook/assets/wallet/transferring (1).png new file mode 100644 index 00000000..f131fc78 Binary files /dev/null and b/.gitbook/assets/wallet/transferring (1).png differ diff --git a/.gitbook/assets/wallet/wallet-page (1).png b/.gitbook/assets/wallet/wallet-page (1).png new file mode 100644 index 00000000..bbae9830 Binary files /dev/null and b/.gitbook/assets/wallet/wallet-page (1).png differ diff --git a/README (1).md b/README (1).md new file mode 100644 index 00000000..4257e437 --- /dev/null +++ b/README (1).md @@ -0,0 +1,130 @@ +--- +description: Ocean Protocol - Tools for the Web3 Data Economy +--- + +# 🌊 Discover + +## What is Ocean? + +Ocean provides the next generation of tools to unlock data at a large scale. Ocean makes it easy to publish and consume data services. + +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. + +![Creating a New Data Economy](.gitbook/assets/architecture/feature-datascience@2x.webp) + +The following guides are a greate place to start if you are new to Ocean: + +- [Architecture Overview](developers/core-concepts/architecture.md) +- [Data NFTs and Datatokens](developers/core-concepts/datanft-and-datatoken.md) +- [Publish a data asset](tutorials/using-ocean-market/marketplace-publish-data-asset.md) +- [Download a data asset](tutorials/using-ocean-market/marketplace-download-data-asset.md) + +## What is our Mission? + +**To unlock data, for more equitable outcomes for users of data, using a thoughtful application of both technology and governance.** + +Society is becoming increasingly reliant on data, especially with the advent of AI. However, a small handful of organizations with both massive data assets and AI capabilities attained worrying levels of control which is a danger to a free and open society. + +Our team and community is committed to kick-starting a New Data Economy that reaches every single person, company and device, giving power back to data owners and enabling people to capture value from data to better our world. + +Find out more about the people building Ocean on our [site](https://oceanprotocol.com/about). + +## What can you do with Ocean? + +### Buy or Sell Data + +Use Ocean Market to publish and sell data, or browse and buy data. Data is published as interoperable ERC721 data NFTs & ERC20 datatokens. It's a decentralized exchange (DEX), tuned for data. The acts of publishing data, purchasing data, and consuming data are all recorded on the blockchain to make a tamper-proof audit trail. + +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. + +![Decentralized Exchange Marketplaces](.gitbook/assets/architecture/feature-marketplaces@2x.webp) + +The following guides will help you get started with buying and selling data: + +- [Publish a data asset](tutorials/using-ocean-market/marketplace-publish-data-asset.md) +- [Download a data asset](tutorials/using-ocean-market/marketplace-download-data-asset.md) +- [Publishing with hosting services](tutorials/using-ocean-market/asset-hosting.md) + +### 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. + +![Ocean Market Homepage](.gitbook/assets/market/ocean-market-homepage.png) + +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) + +### Manage datatokens and data NFTs for use in DeFi + +Ocean makes it easy to publish data services (deploy ERC721 data NFTs and ERC20 datatokens), and to consume data services (spend datatokens). Crypto wallets, exchanges, and DAOs become data wallets, exchanges, and DAOs. + +Use Ocean [JavaScript](https://github.com/oceanprotocol/ocean.js) or [Python](https://github.com/oceanprotocol/ocean.py) drivers to manage data NFTs and datatokens: + +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. + +![New Data on-ramp and off-ramp](.gitbook/assets/architecture/new-ramp-on-crypto-ramp-off.webp) + +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. + +To access the dataset, you send 1.0 datatokens to the data provider (running Ocean Provider). To give access to someone else, send them 1.0 datatokens. That's it. + +Since datatokens are ERC20, and live on Ethereum mainnet, there's a whole ecosystem to leverage. + +- _Publish and access data services:_ downloadable files or compute-to-data. Use Ocean to deploy a new [ERC721](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md) and [ERC20](https://github.com/ethereum/EIPs/blob/7f4f0377730f5fc266824084188cc17cf246932e/EIPS/eip-20.md) datatoken contract for each data service, then mint datatokens. +- _Transfer datatokens_ to another owner (or approve & transferFrom). +- _And more._ Use ERC20 support in [web3.js](https://web3js.readthedocs.io/), [web3.py](https://web3py.readthedocs.io/en/stable/examples.html#working-with-an-erc20-token-contract) and Solidity to connect datatokens with crypto wallets and other DeFi services. + +### Compute-to-Data + +Ocean's "Compute-to-Data" feature enables private data to be bought & sold. You can sell compute access to privately-held data, which never leaves the data owner’s premises. Ocean-based marketplaces enable the monetization of private data while preserving privacy. + +Compute-to-data resolves the tradeoff between the benefits of using private data, and the risks of exposing it. It lets the data stay on-premise, yet allows 3rd parties to run specific compute jobs on it to get useful compute results like averaging or building an AI model. + +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. + +![Compute-to-data](.gitbook/assets/architecture/feature-compute@2x.webp) + +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. + +Private data can help research, leading to life-altering innovations in science and technology. For example, more data improves the predictive accuracy of modern Artificial Intelligence (AI) models. Private data is often considered the most valuable data because it’s so hard to get at, and using it can lead to potentially big payoffs. + +Checkout these guides if you are aiming to get a deeper understanding on how compute-to-data works: + +- [Architecture](developers/core-concepts/compute-to-data-architecture.md) +- [Datasets & Algorithms](developers/core-concepts/compute-to-data-datasets-algorithms.md) +- [Minikube Environment](infrastructure/compute-to-data-minikube.md) +- [Writing Algorithms](developers/core-concepts/compute-to-data-algorithms.md) +- [Private docker registry](infrastructure/compute-to-data-docker-registry.md) + +## How does it work? + +In Ocean Protocol, each asset gets its own ERC721 **data NFT** and one(or more) ERC20 **datatokens**. This enables data wallets, data exchanges, and data co-ops by directly leveraging crypto wallets, exchanges, and more. + +Ocean Protocol provides tools for developers to _build data markets_, and to _manage data NFTs and datatokens_ for use in DeFi. + +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) + +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](developers/core-concepts/architecture.md) +- [Data NFTs and Datatokens](developers/core-concepts/datanft-and-datatoken.md) +- [Networks](discover/networks.md) +- [Fees](developers/core-concepts/fees.md) +- [Asset pricing](developers/core-concepts/asset-pricing.md) +- [DID & DDO](developers/core-concepts/did-ddo.md) +- [Roles](developers/core-concepts/roles.md) +- [Set Up a Marketplace](tutorials/build-a-marketplace/marketplace.md) +- [Compute-to-Data](developers/core-concepts/compute-to-data) +- [Deploying components](infrastructure/README.md) +- [Contributing](contribute/contributing.md) + +## Supporters + +[GitBook](https://www.gitbook.com/) is a supporter of this open source project by providing hosting for this documentation. diff --git a/README.md b/README.md index 4257e437..3add7c47 100644 --- a/README.md +++ b/README.md @@ -1,130 +1,12 @@ --- -description: Ocean Protocol - Tools for the Web3 Data Economy +description: Help for wherever you are on your Ocean journey. +cover: .gitbook/assets/OceanONDA.png +coverY: 0 +layout: landing --- -# 🌊 Discover +# 👋 Welcome -## What is Ocean? -Ocean provides the next generation of tools to unlock data at a large scale. Ocean makes it easy to publish and consume data services. -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. - -![Creating a New Data Economy](.gitbook/assets/architecture/feature-datascience@2x.webp) - -The following guides are a greate place to start if you are new to Ocean: - -- [Architecture Overview](developers/core-concepts/architecture.md) -- [Data NFTs and Datatokens](developers/core-concepts/datanft-and-datatoken.md) -- [Publish a data asset](tutorials/using-ocean-market/marketplace-publish-data-asset.md) -- [Download a data asset](tutorials/using-ocean-market/marketplace-download-data-asset.md) - -## What is our Mission? - -**To unlock data, for more equitable outcomes for users of data, using a thoughtful application of both technology and governance.** - -Society is becoming increasingly reliant on data, especially with the advent of AI. However, a small handful of organizations with both massive data assets and AI capabilities attained worrying levels of control which is a danger to a free and open society. - -Our team and community is committed to kick-starting a New Data Economy that reaches every single person, company and device, giving power back to data owners and enabling people to capture value from data to better our world. - -Find out more about the people building Ocean on our [site](https://oceanprotocol.com/about). - -## What can you do with Ocean? - -### Buy or Sell Data - -Use Ocean Market to publish and sell data, or browse and buy data. Data is published as interoperable ERC721 data NFTs & ERC20 datatokens. It's a decentralized exchange (DEX), tuned for data. The acts of publishing data, purchasing data, and consuming data are all recorded on the blockchain to make a tamper-proof audit trail. - -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. - -![Decentralized Exchange Marketplaces](.gitbook/assets/architecture/feature-marketplaces@2x.webp) - -The following guides will help you get started with buying and selling data: - -- [Publish a data asset](tutorials/using-ocean-market/marketplace-publish-data-asset.md) -- [Download a data asset](tutorials/using-ocean-market/marketplace-download-data-asset.md) -- [Publishing with hosting services](tutorials/using-ocean-market/asset-hosting.md) - -### 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. - -![Ocean Market Homepage](.gitbook/assets/market/ocean-market-homepage.png) - -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) - -### Manage datatokens and data NFTs for use in DeFi - -Ocean makes it easy to publish data services (deploy ERC721 data NFTs and ERC20 datatokens), and to consume data services (spend datatokens). Crypto wallets, exchanges, and DAOs become data wallets, exchanges, and DAOs. - -Use Ocean [JavaScript](https://github.com/oceanprotocol/ocean.js) or [Python](https://github.com/oceanprotocol/ocean.py) drivers to manage data NFTs and datatokens: - -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. - -![New Data on-ramp and off-ramp](.gitbook/assets/architecture/new-ramp-on-crypto-ramp-off.webp) - -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. - -To access the dataset, you send 1.0 datatokens to the data provider (running Ocean Provider). To give access to someone else, send them 1.0 datatokens. That's it. - -Since datatokens are ERC20, and live on Ethereum mainnet, there's a whole ecosystem to leverage. - -- _Publish and access data services:_ downloadable files or compute-to-data. Use Ocean to deploy a new [ERC721](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md) and [ERC20](https://github.com/ethereum/EIPs/blob/7f4f0377730f5fc266824084188cc17cf246932e/EIPS/eip-20.md) datatoken contract for each data service, then mint datatokens. -- _Transfer datatokens_ to another owner (or approve & transferFrom). -- _And more._ Use ERC20 support in [web3.js](https://web3js.readthedocs.io/), [web3.py](https://web3py.readthedocs.io/en/stable/examples.html#working-with-an-erc20-token-contract) and Solidity to connect datatokens with crypto wallets and other DeFi services. - -### Compute-to-Data - -Ocean's "Compute-to-Data" feature enables private data to be bought & sold. You can sell compute access to privately-held data, which never leaves the data owner’s premises. Ocean-based marketplaces enable the monetization of private data while preserving privacy. - -Compute-to-data resolves the tradeoff between the benefits of using private data, and the risks of exposing it. It lets the data stay on-premise, yet allows 3rd parties to run specific compute jobs on it to get useful compute results like averaging or building an AI model. - -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. - -![Compute-to-data](.gitbook/assets/architecture/feature-compute@2x.webp) - -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. - -Private data can help research, leading to life-altering innovations in science and technology. For example, more data improves the predictive accuracy of modern Artificial Intelligence (AI) models. Private data is often considered the most valuable data because it’s so hard to get at, and using it can lead to potentially big payoffs. - -Checkout these guides if you are aiming to get a deeper understanding on how compute-to-data works: - -- [Architecture](developers/core-concepts/compute-to-data-architecture.md) -- [Datasets & Algorithms](developers/core-concepts/compute-to-data-datasets-algorithms.md) -- [Minikube Environment](infrastructure/compute-to-data-minikube.md) -- [Writing Algorithms](developers/core-concepts/compute-to-data-algorithms.md) -- [Private docker registry](infrastructure/compute-to-data-docker-registry.md) - -## How does it work? - -In Ocean Protocol, each asset gets its own ERC721 **data NFT** and one(or more) ERC20 **datatokens**. This enables data wallets, data exchanges, and data co-ops by directly leveraging crypto wallets, exchanges, and more. - -Ocean Protocol provides tools for developers to _build data markets_, and to _manage data NFTs and datatokens_ for use in DeFi. - -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) - -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](developers/core-concepts/architecture.md) -- [Data NFTs and Datatokens](developers/core-concepts/datanft-and-datatoken.md) -- [Networks](discover/networks.md) -- [Fees](developers/core-concepts/fees.md) -- [Asset pricing](developers/core-concepts/asset-pricing.md) -- [DID & DDO](developers/core-concepts/did-ddo.md) -- [Roles](developers/core-concepts/roles.md) -- [Set Up a Marketplace](tutorials/build-a-marketplace/marketplace.md) -- [Compute-to-Data](developers/core-concepts/compute-to-data) -- [Deploying components](infrastructure/README.md) -- [Contributing](contribute/contributing.md) - -## Supporters - -[GitBook](https://www.gitbook.com/) is a supporter of this open source project by providing hosting for this documentation. +
README (1).mdLearn about Ocean Protocol's powerful data sharing capabilities and its potential to transform the way data is shared and monetized.README (1).mdocean.png
tutorialsGet 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.tutorialstutorials.png
rewardsDiscover 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.rewardsrewards-background.png
developersWhether 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.developersdevelopers.png
infrastructureLearn 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. infrastructurebuilding-blocks.png
contributing.mdLearn 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.contributing.mdcontribute.png
diff --git a/SUMMARY.md b/SUMMARY.md index d7abb261..be24a328 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,65 +1,64 @@ # Table of contents -- [🌊 Discover](README.md) - - - [Wallet Basics](discover/wallets.md) - - [Set Up MetaMask Wallet](discover/metamask-setup.md) - - [Manage Your OCEAN Tokens](discover/wallets-and-ocean-tokens.md) - - [Networks](discover/networks.md) - - [Bridges](discover/bridges.md) - - [FAQ](discover/faq.md) - -- [📚 Tutorials](tutorials/README.md) - - [Using Ocean Market](tutorials/using-ocean-market/README.md) - - [Publish a Data Asset](tutorials/using-ocean-market/marketplace-publish-data-asset.md) - - [Download a Data Asset](tutorials/using-ocean-market/marketplace-download-data-asset.md) - - [Publishing with Hosting Services](tutorials/using-ocean-market/asset-hosting.md) - - [Liquidity Pools \[deprecated\]](tutorials/using-ocean-market/remove-liquidity-using-etherscan.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) -- [💰 Rewards](rewards/README.md) - - [veOCEAN](rewards/veocean.md) - - [Data Farming 101](rewards/df-intro.md) - - [Data Farming Background](rewards/df-background.md) - - [Emissions & APYs](rewards/emissions-apys.md) - - [Rewards Tutorial](rewards/veOcean-Data-Farming-Tutorial.md) -- [👨‍💻 Developers](developers/README.md) - - [Core concepts](developers/core-concepts/README.md) - - [Architecture Overview](developers/core-concepts/architecture.md) - - [Data NFTs and Datatokens](developers/core-concepts/datanft-and-datatoken.md) - - [Roles](developers/core-concepts/roles.md) - - [Fees](developers/core-concepts/fees.md) - - [Asset Pricing](developers/core-concepts/asset-pricing.md) - - [DID & DDO](developers/core-concepts/did-ddo.md) - - [C2D - Architecture](developers/core-concepts/compute-to-data-architecture.md) - - [C2D - Datasets & Algorithms](developers/core-concepts/compute-to-data-datasets-algorithms.md) - - [C2D - Writing Algorithms](developers/core-concepts/compute-to-data-algorithms.md) - - [C2D - User defined parameters](developers/core-concepts/user-defined-parameters.md) - - [Aquarius REST API](developers/aquarius-rest-api.md) - - [Provider REST API](developers/provider-rest-api.md) -- [🔨 Infrastructure](infrastructure/README.md) - - [Setup a Server](infrastructure/setup-server.md) - - [Deploying Marketplace](infrastructure/deploying-marketplace.md) - - [Deploying Aquarius](infrastructure/deploying-aquarius.md) - - [Deploying Provider](infrastructure/deploying-provider.md) - - [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) -- [🤝 Contribute](contribute/contributing.md) - - [Partners & Collaborators](contribute/projects-using-ocean.md) - - [Contributor Code of Conduct](contribute/code-of-conduct.md) - - [Legal Requirements](contribute/legal-reqs.md) +* [👋 Welcome](README.md) +* [🌊 Discover]() + * [Wallet Basics](discover/wallets.md) + * [Set Up MetaMask Wallet](discover/metamask-setup.md) + * [Manage Your OCEAN Tokens](discover/wallets-and-ocean-tokens.md) + * [Networks](discover/networks.md) + * [Bridges](discover/bridges.md) + * [FAQ](discover/faq.md) +* [📚 Tutorials](tutorials/README.md) + * [Using Ocean Market](tutorials/using-ocean-market/README.md) + * [Publish a Data Asset](tutorials/using-ocean-market/marketplace-publish-data-asset.md) + * [Download a Data Asset](tutorials/using-ocean-market/marketplace-download-data-asset.md) + * [Publishing with Hosting Services](tutorials/using-ocean-market/asset-hosting.md) + * [Liquidity Pools \[deprecated\]](tutorials/using-ocean-market/remove-liquidity-using-etherscan.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) +* [💰 Rewards](rewards/README.md) + * [veOCEAN](rewards/veocean.md) + * [Data Farming 101](rewards/df-intro.md) + * [Data Farming Background](rewards/df-background.md) + * [Emissions & APYs](rewards/emissions-apys.md) + * [Rewards Tutorial](rewards/veOcean-Data-Farming-Tutorial.md) +* [👨💻 Developers](developers/README.md) + * [Core concepts](developers/core-concepts/README.md) + * [Architecture Overview](developers/core-concepts/architecture.md) + * [Data NFTs and Datatokens](developers/core-concepts/datanft-and-datatoken.md) + * [Roles](developers/core-concepts/roles.md) + * [Fees](developers/core-concepts/fees.md) + * [Asset Pricing](developers/core-concepts/asset-pricing.md) + * [DID & DDO](developers/core-concepts/did-ddo.md) + * [C2D - Architecture](developers/core-concepts/compute-to-data-architecture.md) + * [C2D - Datasets & Algorithms](developers/core-concepts/compute-to-data-datasets-algorithms.md) + * [C2D - Writing Algorithms](developers/core-concepts/compute-to-data-algorithms.md) + * [C2D - User defined parameters](developers/core-concepts/user-defined-parameters.md) + * [Aquarius REST API](developers/aquarius-rest-api.md) + * [Provider REST API](developers/provider-rest-api.md) +* [🔨 Infrastructure](infrastructure/README.md) + * [Setup a Server](infrastructure/setup-server.md) + * [Deploying Marketplace](infrastructure/deploying-marketplace.md) + * [Deploying Aquarius](infrastructure/deploying-aquarius.md) + * [Deploying Provider](infrastructure/deploying-provider.md) + * [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) +* [🤝 Contribute](contribute/contributing.md) + * [Partners & Collaborators](contribute/projects-using-ocean.md) + * [Contributor Code of Conduct](contribute/code-of-conduct.md) + * [Legal Requirements](contribute/legal-reqs.md) diff --git a/developers/core-concepts/datanft-and-datatoken.md b/developers/core-concepts/datanft-and-datatoken.md index c554ee61..308593ec 100644 --- a/developers/core-concepts/datanft-and-datatoken.md +++ b/developers/core-concepts/datanft-and-datatoken.md @@ -29,16 +29,16 @@ With data NFTs, you are able to take advantage of the wider NFT ecosystem and al The image above describes how ERC721 data NFTs and ERC20 datatokens relate. -- Bottom: The publisher deploys an ERC721 data NFT contract representing the base IP for the data asset. They are now the manager of the data NFT. -- Top: The manager then deploys an ERC20 datatoken contract against the data NFT. The ERC20 represents a license with specific terms like "can download for the next 3 days". They could even publish further ERC20 datatoken contracts, to represent different license terms or for compute-to-data. +* Bottom: The publisher deploys an ERC721 data NFT contract representing the base IP for the data asset. They are now the manager of the data NFT. +* Top: The manager then deploys an ERC20 datatoken contract against the data NFT. The ERC20 represents a license with specific terms like "can download for the next 3 days". They could even publish further ERC20 datatoken contracts, to represent different license terms or for compute-to-data. ### Terminology -- **Base IP** means the artifact being copyrighted. Represented by the {ERC721 address, tokenId} from the publish transactions. -- **Base IP holder** means the holder of the Base IP. Represented as the actor that did the initial "publish" action. -- **Sub-licensee** is the holder of the sub-license. Represented as the entity that controls address ERC721.\_owners\[tokenId=x]. -- **To Publish**: Claim copyright or exclusive base license. -- **To Sub-license**: Transfer one (of many) sub-licenses to new licensee: ERC20.transfer(to=licensee, value=1.0). +* **Base IP** means the artifact being copyrighted. Represented by the {ERC721 address, tokenId} from the publish transactions. +* **Base IP holder** means the holder of the Base IP. Represented as the actor that did the initial "publish" action. +* **Sub-licensee** is the holder of the sub-license. Represented as the entity that controls address ERC721.\_owners\[tokenId=x]. +* **To Publish**: Claim copyright or exclusive base license. +* **To Sub-license**: Transfer one (of many) sub-licenses to new licensee: ERC20.transfer(to=licensee, value=1.0). ### Implementation in Ocean Protocol @@ -62,12 +62,12 @@ Ocean provides convenient methods to list ERC20 datatokens for sale, with fixed- ### High-Level Behavior -![High-Level Flow](../../.gitbook/assets/architecture/high-level-flow.png) +![High-Level Flow](<../../.gitbook/assets/architecture/high-level-flow (1).png>) Here's an example. -- In step 1, Alice **publishes** her dataset with Ocean: this means deploying an ERC721 data NFT contract (claiming copyright/base IP), then an ERC20 datatoken contract (license against base IP). -- In step 2, she **mints** some ERC20 datatokens and **transfers** 1.0 of them to Bob's wallet; now he has a license to be able to download that dataset. +* In step 1, Alice **publishes** her dataset with Ocean: this means deploying an ERC721 data NFT contract (claiming copyright/base IP), then an ERC20 datatoken contract (license against base IP). +* In step 2, she **mints** some ERC20 datatokens and **transfers** 1.0 of them to Bob's wallet; now he has a license to be able to download that dataset. ### Revenue @@ -87,8 +87,8 @@ The only data NFT template currently available has templateId `1` and the source The details regarding currently supported datatoken templates are as follows: -- **Regular template**: The regular template allows users to buy/sell/hold datatokens. The datatokens can be minted by the address having a `MINTER` role, making the supply of datatoken variable. This template is assigned templateID `1` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20Template.sol). -- **Enterprise template**: The enterprise template has additional functions apart from methods in the ERC20 interface. This additional feature allows access to the service by paying in the basetoken instead of datatoken. Internally, the smart contract handles conversion of basetoken to datatoken, initiating an order to access the service, and minting/burning the datatoken. The total supply of the datatoken effectively remains 0 in the case of the enterprise template. This template is assigned templateID `2` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20TemplateEnterprise.sol). +* **Regular template**: The regular template allows users to buy/sell/hold datatokens. The datatokens can be minted by the address having a `MINTER` role, making the supply of datatoken variable. This template is assigned templateID `1` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20Template.sol). +* **Enterprise template**: The enterprise template has additional functions apart from methods in the ERC20 interface. This additional feature allows access to the service by paying in the basetoken instead of datatoken. Internally, the smart contract handles conversion of basetoken to datatoken, initiating an order to access the service, and minting/burning the datatoken. The total supply of the datatoken effectively remains 0 in the case of the enterprise template. This template is assigned templateID `2` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20TemplateEnterprise.sol). _NOTE: Ocean Protocol might support additional variations of data NFT/datatoken by adding new templates._ @@ -98,8 +98,8 @@ Fractional ownership is an exciting sub-niche of Web3, at the intersection of NF Ocean provides two approaches to fractional ownership: -- Sharded holding of ERC20 datatokens, where each ERC20 holder has the usual datatoken rights as described above, e.g. 1.0 datatokens to consume an asset. This comes out-of-the-box with Ocean. -- Sharding ERC721 data NFT, where each co-holder has right to some earnings against base IP, and co-controls the data NFT. For example, there’s a DAO with the sole purpose to hold the data NFT; this DAO has its own ERC20 token; DAO members vote with tokens to update data NFT roles or deploy ERC20 datatokens against the ERC721. +* Sharded holding of ERC20 datatokens, where each ERC20 holder has the usual datatoken rights as described above, e.g. 1.0 datatokens to consume an asset. This comes out-of-the-box with Ocean. +* Sharding ERC721 data NFT, where each co-holder has right to some earnings against base IP, and co-controls the data NFT. For example, there’s a DAO with the sole purpose to hold the data NFT; this DAO has its own ERC20 token; DAO members vote with tokens to update data NFT roles or deploy ERC20 datatokens against the ERC721. Note: For (2), one might consider doing sharding with something like Niftex. But then there are questions: what rights do the shard-holders get exactly? It could be zero; for example, Amazon shareholders don’t have the right to walk the hallways of the Amazon offices just because they hold shares. Secondly, how do the shard-holders control the data NFT? These questions get resolved by using a tokenized DAO, as described above. @@ -111,7 +111,7 @@ This has several variants. Each member’s data feed could be its own data NFT w ### Other References -- [Data & NFTs 1: Practical Connections of ERC721 with Intellectual Property](https://blog.oceanprotocol.com/nfts-ip-1-practical-connections-of-erc721-with-intellectual-property-dc216aaf005d) -- [Data & NFTs 2: Leveraging ERC20 Fungibility](https://blog.oceanprotocol.com/nfts-ip-2-leveraging-erc20-fungibility-bcee162290e3) -- [Data & NFTs 3: Combining ERC721 & ERC20](https://blog.oceanprotocol.com/nfts-ip-3-combining-erc721-erc20-b69ea659115e) -- [Fungibility sightings in NFTs](https://blog.oceanprotocol.com/on-difficult-to-explain-fungibility-sightings-in-nfts-26bc18620f70) +* [Data & NFTs 1: Practical Connections of ERC721 with Intellectual Property](https://blog.oceanprotocol.com/nfts-ip-1-practical-connections-of-erc721-with-intellectual-property-dc216aaf005d) +* [Data & NFTs 2: Leveraging ERC20 Fungibility](https://blog.oceanprotocol.com/nfts-ip-2-leveraging-erc20-fungibility-bcee162290e3) +* [Data & NFTs 3: Combining ERC721 & ERC20](https://blog.oceanprotocol.com/nfts-ip-3-combining-erc721-erc20-b69ea659115e) +* [Fungibility sightings in NFTs](https://blog.oceanprotocol.com/on-difficult-to-explain-fungibility-sightings-in-nfts-26bc18620f70) diff --git a/discover/bridges.md b/discover/bridges.md index 3502ed7c..82063d99 100644 --- a/discover/bridges.md +++ b/discover/bridges.md @@ -10,24 +10,24 @@ title: Bridges BSC provides several bridge options, including: -- withdraw crypto from Binance.com, and -- use Binance bridge. +* withdraw crypto from Binance.com, and +* use Binance bridge. The article [How to Get Started with BSC](https://academy.binance.com/en/articles/how-to-get-started-with-binance-smart-chain-bsc) by Binance Academy provides further details. #### Links -- [BSC Wallet Support](https://docs.binance.org/wallets/bsc-wallets.html). Includes MetaMask and Trust Wallet. -- [BSC Bridge](https://www.bnbchain.org/en/bridge) -- [How to set up a custom network in MetaMask](metamask-setup.md#set-up-custom-network) +* [BSC Wallet Support](https://docs.binance.org/wallets/bsc-wallets.html). Includes MetaMask and Trust Wallet. +* [BSC Bridge](https://www.bnbchain.org/en/bridge) +* [How to set up a custom network in MetaMask](metamask-setup.md#set-up-custom-network) ## Polygon (ex Matic) Bridge #### Links -- [Matic Wallet](https://wallet.polygon.technology/) -- [Matic Bridge](https://wallet.polygon.technology/bridge/) -- [How to set up a custom network in MetaMask](metamask-setup.md#set-up-custom-network) +* [Matic Wallet](https://wallet.polygon.technology/) +* [Matic Bridge](https://wallet.polygon.technology/bridge/) +* [How to set up a custom network in MetaMask](metamask-setup.md#set-up-custom-network) #### Intro to Polygon's Bridge @@ -35,7 +35,7 @@ The Polygon Network (ex Matic) provide us with a bridge (connecting Ethereum & P When you open the wallet link, the wallet will ask to log in. Select your preferred way of connecting and confirm the action. In our guide we'll use Metamask. -![Login options](../.gitbook/assets/wallet/login-options.png) +![Login options](<../.gitbook/assets/wallet/login-options (1).png>) In some places, the Polygon Network is still using its old brand Matic. Either you run into Matic or Polygon - it's the exact same thing. For the purpose of this guide, we'll use Matic in the next few paragraphs since the interfaces you're going to use still use the old brand. @@ -49,7 +49,7 @@ On the main page of the wallet, you can see all tokens you own on the Matic Main Both options will redirect you to the bridge interface. In case you chose the second one, use the dropdown and select the token you want to transfer from the Ethereum Mainnet. -![Bridge interface](../.gitbook/assets/wallet/matic-bridge.png) +![Bridge interface](<../.gitbook/assets/wallet/matic-bridge (1).png>) Choose the amount to transfer and click the “Transfer” button. Matic’s bridge interface will guide you through the whole process and the different steps that will occur. You’ll need to sign two transactions on the Ethereum Mainnet. The first being the approval for your token to be traded on the Matic’s bridge and the second one being the deposit. diff --git a/tutorials/using-ocean-market/asset-hosting.md b/tutorials/using-ocean-market/asset-hosting.md index bf440bcd..3af8938f 100644 --- a/tutorials/using-ocean-market/asset-hosting.md +++ b/tutorials/using-ocean-market/asset-hosting.md @@ -105,7 +105,7 @@ Now, the asset can be uploaded by selecting the bucket name and choosing `Upload Get the files and add them to the bucket. -The file is an example used in multiple Ocean repositories, and it can be found [here](https://raw.githubusercontent.com/oceanprotocol/c2d-examples/main/branin_and_gpr/branin.arff). +The file is an example used in multiple Ocean repositories, and it can be found [here](https://raw.githubusercontent.com/oceanprotocol/c2d-examples/main/branin\_and\_gpr/branin.arff). ![Upload asset on S3 bucket - 3](../../.gitbook/assets/hosting/aws-7.png) @@ -182,7 +182,7 @@ 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. -![Create a storage account - 1](../../.gitbook/assets/hosting/azure1.png) +![Create a storage account - 1](<../../.gitbook/assets/hosting/azure1 (1).png>) **Create a new storage account** @@ -190,7 +190,7 @@ Go to the Azure portal: https://portal.azure.com/#home and select `Storage accou **Fill in the details** -![Add details](../../.gitbook/assets/hosting/azure3.png) +![Add details](<../../.gitbook/assets/hosting/azure3 (1).png>) **Storage account created** @@ -198,7 +198,7 @@ Go to the Azure portal: https://portal.azure.com/#home and select `Storage accou **Step 2 - Create a blob container** -![Create a blob container](../../.gitbook/assets/hosting/azure5.png) +![Create a blob container](<../../.gitbook/assets/hosting/azure5 (1).png>) **Step 3 - Upload a file** @@ -208,7 +208,7 @@ Go to the Azure portal: https://portal.azure.com/#home and select `Storage accou **Select the file to be published and click Generate SAS** -![Click generate SAS](../../.gitbook/assets/hosting/azure7.png) +![Click generate SAS](<../../.gitbook/assets/hosting/azure7 (1).png>) **Configure the SAS details and click `Generate SAS token and URL`**