Fix broken links
This commit is contained in:
Ana Loznianu
parent
ae2c663aa7
commit
a6b09d4673
Binary file not shown.
|
Before Width: | Height: | Size: 31 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 56 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 99 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 51 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 123 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 70 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 42 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 104 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 224 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
10
SUMMARY.md
10
SUMMARY.md
|
|
@ -59,12 +59,12 @@
|
|||
* [Customising a Market](developers/build-a-marketplace/customising-your-market.md)
|
||||
* [Build and host your Data Marketplace](developers/build-a-marketplace/deploying-market.md)
|
||||
* [Subgraph](developers/subgraph/README.md)
|
||||
* [Get data NFTs](developers/using-ocean-subgraph/list-data-nfts.md)
|
||||
* [Get data NFT information](developers/using-ocean-subgraph/get-data-nft-information.md)
|
||||
* [Get datatokens](developers/using-ocean-subgraph/list-datatokens.md)
|
||||
* [Get datatoken information](developers/using-ocean-subgraph/get-datatoken-information.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/using-ocean-subgraph/list-fixed-rate-exchanges.md)
|
||||
* [Get fixed-rate exchanges](developers/subgraph/list-fixed-rate-exchanges.md)
|
||||
* [Get veOCEAN stats](developers/subgraph/get-veocean-stats.md)
|
||||
* [Ocean.py](developers/ocean.py/README.md)
|
||||
* [Install](developers/ocean.py/install.md)
|
||||
|
|
|
|||
|
|
@ -22,9 +22,9 @@ Ocean Protocol is built for data scientists to **monetize data effectively and**
|
|||
|
||||
### How to design a ML system using Ocean Protocol?
|
||||
|
||||
The first step is to tokenize data into data NFTs and datatokens on the blockchain. We offer a no-code way to tokenize data via the [Ocean Market](https://market.oceanprotocol.com). But we also offer code options for data scientists to use the [Ocean.py](../developers/ocean.py) and [Ocean.js](../developers/ocean.js) libraries. Data scientists can then build sophisticated ML systems on top of the tokenized data by using composable Ocean Protocol tools. ML models can use a variety of Ocean smart contracts, including Ocean's [Compute-to-Data](../developers/compute-to-data/), to build model outputs all the way to the last-mile delivery for businesses.
|
||||
The first step is to tokenize data into data NFTs and datatokens on the blockchain. We offer a no-code way to tokenize data via the [Ocean Market](https://market.oceanprotocol.com). But we also offer code options for data scientists to use the [Ocean.py](../developers/ocean.py/README.md) and [Ocean.js](../developers/ocean.js/README.md) libraries. Data scientists can then build sophisticated ML systems on top of the tokenized data by using composable Ocean Protocol tools. ML models can use a variety of Ocean smart contracts, including Ocean's [Compute-to-Data](../developers/compute-to-data/README.md), to build model outputs all the way to the last-mile delivery for businesses.
|
||||
|
||||
### **Key Links for Data Scientists:**
|
||||
|
||||
* Learn the difference between Ocean Protocol [data NFTs and datatokens](../developers/contracts/datanft-and-datatoken.md), the two types of tokenized data assets you need to start building your ML systems.
|
||||
* Discover Ocean's [Compute-to-Data](../developers/compute-to-data/) engine that can help you to solve the difficult problem of selling algorithmic compute jobs on your datasets without actually revealing the contents of the algorithm & dataset to the consumer.
|
||||
* Discover Ocean's [Compute-to-Data](../developers/compute-to-data/README.md) engine that can help you to solve the difficult problem of selling algorithmic compute jobs on your datasets without actually revealing the contents of the algorithm & dataset to the consumer.
|
||||
|
|
|
|||
|
|
@ -11,14 +11,14 @@ coverY: 0
|
|||
|
||||
With Ocean, crypto wallets transform into magical data wallets, where your data can roam freely and securely. Crypto exchanges? Well, they've taken on a new role as data marketplaces, where you can showcase and trade your valuable data treasures. And hold on tight because DAOs are here to create epic data co-ops, where collaboration and innovation reign supreme! 🤝
|
||||
|
||||
But hold on tight, because we have even more in store for you! With Ocean Protocol, you gain access to a treasure trove of tools that will unlock your data scientist superpowers and allow you to unleash your creativity. Whether you're a Python aficionado or a JavaScript maestro, we have you covered with [ocean.py](ocean.py) and [ocean.js](ocean.js) libraries. So, get ready to dive into the depths of data innovation and create the next groundbreaking dAapp (that's a decentralized App, by the way) using [ocean.js's](ocean.js) powerful capabilities or unleash your skills with [ocean.py](ocean.py). It's time to shake up the data world like never before! 🌐🚀
|
||||
But hold on tight, because we have even more in store for you! With Ocean Protocol, you gain access to a treasure trove of tools that will unlock your data scientist superpowers and allow you to unleash your creativity. Whether you're a Python aficionado or a JavaScript maestro, we have you covered with [ocean.py](ocean.py/README.md) and [ocean.js](ocean.js) libraries. So, get ready to dive into the depths of data innovation and create the next groundbreaking dAapp (that's a decentralized App, by the way) using [ocean.js's](ocean.js) powerful capabilities or unleash your skills with [ocean.py](ocean.py/README.md). It's time to shake up the data world like never before! 🌐🚀
|
||||
|
||||
<figure><img src="../.gitbook/assets/developers.png" alt=""><figcaption><p>Ocean Protocol Explorer</p></figcaption></figure>
|
||||
|
||||
At the core of the Ocean Protocol, you'll find a constellation of [smart contracts](contracts/) that bring extraordinary capabilities to every data asset. Here's where the magic happens! Every asset gets its own cool and unique [**ERC721 data NFT**](contracts/data-nfts.md#what-is-a-data-nft), along with one (or more) [**ERC20 datatokens**](contracts/datanft-and-datatoken.md). It's like giving your data its very own superhero cape! 🦸♂️
|
||||
At the core of the Ocean Protocol, you'll find a constellation of [smart contracts](contracts/README.md) that bring extraordinary capabilities to every data asset. Here's where the magic happens! Every asset gets its own cool and unique [**ERC721 data NFT**](contracts/data-nfts.md#what-is-a-data-nft), along with one (or more) [**ERC20 datatokens**](contracts/datanft-and-datatoken.md). It's like giving your data its very own superhero cape! 🦸♂️
|
||||
|
||||
These [smart contracts](contracts/) form the backbone of Ocean Protocol, empowering data assets with unparalleled value and enabling seamless integration with the wider blockchain ecosystem. Through the [contracts](contracts/), data becomes not only valuable but also tradable, allowing you to unleash the true potential of your data treasures.
|
||||
These [smart contracts](contracts/README.md) form the backbone of Ocean Protocol, empowering data assets with unparalleled value and enabling seamless integration with the wider blockchain ecosystem. Through the [contracts](contracts/README.md), data becomes not only valuable but also tradable, allowing you to unleash the true potential of your data treasures.
|
||||
|
||||
<figure><img src="../.gitbook/assets/smart-contracts.png" alt=""><figcaption><p>Smart Contracts</p></figcaption></figure>
|
||||
|
||||
Now, if you're new to the world of web3 and blockchain technologies, fear not! We've got you covered. Before diving into the depths of Ocean Protocol, we recommend starting with some introductory guides. These [guides](../user-guides/) will gently introduce you to the magical world of [web3](../discover/wallets/) and help you understand the [basics](../discover/wallets-and-ocean-tokens.md) before you embark on your epic data-driven adventure.
|
||||
Now, if you're new to the world of web3 and blockchain technologies, fear not! We've got you covered. Before diving into the depths of Ocean Protocol, we recommend starting with some introductory guides. These [guides](../user-guides/README.md) will gently introduce you to the magical world of [web3](../discover/wallets/README.md) and help you understand the [basics](../discover/wallets-and-ocean-tokens.md) before you embark on your epic data-driven adventure.
|
||||
|
|
|
|||
|
|
@ -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](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](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](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-science/) 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](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-science/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,7 +45,7 @@ Prominently featured within this layer is [Ocean Market](../user-guides/using-oc
|
|||
|
||||
### Layer 4: The Friendly Wallets
|
||||
|
||||
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../discover/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](../discover/wallets/).
|
||||
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../discover/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](../discover/wallets/README.md).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ description: 🧑🏽💻 Local Development Environment for Ocean Protocol
|
|||
|
||||
The Barge component of Ocean Protocol is a powerful tool designed to simplify the development process by providing Docker Compose files for running the full Ocean Protocol stack locally. It allows developers to set up and configure the various services required by Ocean Protocol for local testing and development purposes.
|
||||
|
||||
By using the Barge component, developers can spin up an environment that includes default versions of [Aquarius](../aquarius/), [Provider](../provider/), [Subgraph](../subgraph/), and [Compute-to-Data](../compute-to-data/). Additionally, it deploys all the [smart contracts](../contracts/) from the ocean-contracts repository, ensuring a complete and functional local setup. Barge component also starts additional services like [Ganache](https://trufflesuite.com/ganache/), which is a local blockchain simulator used for smart contract development, and [Elasticsearch](https://www.elastic.co/elasticsearch/), a powerful search and analytics engine required by Aquarius for efficient indexing and querying of data sets. A full list of components and exposed ports is available in the GitHub [repository](https://github.com/oceanprotocol/barge#component-versions-and-exposed-ports).
|
||||
By using the Barge component, developers can spin up an environment that includes default versions of [Aquarius](../aquarius/README.md), [Provider](../provider/README.md), [Subgraph](../subgraph/README.md), and [Compute-to-Data](../compute-to-data/README.md). Additionally, it deploys all the [smart contracts](../contracts/README.md) from the ocean-contracts repository, ensuring a complete and functional local setup. Barge component also starts additional services like [Ganache](https://trufflesuite.com/ganache/), which is a local blockchain simulator used for smart contract development, and [Elasticsearch](https://www.elastic.co/elasticsearch/), a powerful search and analytics engine required by Aquarius for efficient indexing and querying of data sets. A full list of components and exposed ports is available in the GitHub [repository](https://github.com/oceanprotocol/barge#component-versions-and-exposed-ports).
|
||||
|
||||
<figure><img src="../../.gitbook/assets/barge.png" alt=""><figcaption><p>Load Ocean components locally by using Barge</p></figcaption></figure>
|
||||
|
||||
|
|
@ -17,6 +17,6 @@ By utilizing the Barge component, developers gain the freedom to conduct experim
|
|||
{% hint style="warning" %}
|
||||
⚠️ We've got an important heads-up about Barge that we want to share with you. Brace yourself, because **Barge is not for the faint-hearted**! Here's the deal: the barge works great on Linux, but we need to be honest about its limitations on macOS. And, well, it doesn't work at all on Windows. Sorry, Windows users!
|
||||
|
||||
To make things easier for everyone, we **strongly** recommend giving a try first on a **testnet**. Everything is configured already so it should be sufficient for your needs as well. Visit our [networks](../../discover/networks/) page to have clarity on the available test networks. ⚠️\
|
||||
To make things easier for everyone, we **strongly** recommend giving a try first on a **testnet**. Everything is configured already so it should be sufficient for your needs as well. Visit our [networks](../../discover/networks/README.md) page to have clarity on the available test networks. ⚠️\
|
||||
|
||||
{% endhint %}
|
||||
|
|
|
|||
|
|
@ -29,10 +29,10 @@ 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](../../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.
|
||||
* To use your clone of Ocean Market, you’ll need a [wallet](../../discover/wallets/README.md). We recommend [getting set up with metamask](../../discover/wallets/metamask-setup.md).
|
||||
* You’ll also need some [Ocean tokens on a testnet](../../discover/wallets-and-ocean-tokens.md) to use your marketplace.
|
||||
* When you have the testnet tokens, have a go at [publishing a data NFT](../../user-guides/publish-data-nfts.md) on Ocean Market.
|
||||
* Run through the process of [consuming a data asset](../../user-guides/buy-data-nfts.md) on Ocean Market.
|
||||
|
||||
**Required Prerequisites**
|
||||
|
||||
|
|
|
|||
|
|
@ -184,7 +184,7 @@ You need to replace “0x123abc” with your Ethereum address (this is where the
|
|||
|
||||
You can also alter the fees to the levels that you intend them to be at. If you change your mind, these fees can always be altered later.
|
||||
|
||||
Go to [Fees page](https://docs.oceanprotocol.com/concepts/fees/) to know more details about each type of fee and its relevance.
|
||||
Go to [Fees page](../contracts/fees.md) to know more details about each type of fee and its relevance.
|
||||
|
||||
|
||||
|
||||
|
|
@ -202,7 +202,7 @@ You have the flexibility to tailor the ocean market according to your preference
|
|||
|
||||
### Using a custom MetadataCache
|
||||
|
||||
If you intend to utilize the ocean market with a custom [Aquarius](../aquarius/) deployment, you can also make set a custom MetadataCache flag. To do this, you will need to update the same file mentioned earlier. However, instead of modifying the `NEXT_PUBLIC_PROVIDER_URL` key, you should update the `NEXT_PUBLIC_METADATACACHE_URI` key. By updating this key, you can specify the URI for your custom Aquarius deployment, enabling you to take advantage of the ocean market with your preferred metadata cache setup.
|
||||
If you intend to utilize the ocean market with a custom [Aquarius](../aquarius/README.md) deployment, you can also make set a custom MetadataCache flag. To do this, you will need to update the same file mentioned earlier. However, instead of modifying the `NEXT_PUBLIC_PROVIDER_URL` key, you should update the `NEXT_PUBLIC_METADATACACHE_URI` key. By updating this key, you can specify the URI for your custom Aquarius deployment, enabling you to take advantage of the ocean market with your preferred metadata cache setup.
|
||||
|
||||
### Using a custom subgraph
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Ocean V3 introduced the new crypto primitives of “data on-ramp” and “data
|
|||
|
||||
The datasets can take one of many shapes. For AI use cases, they may be raw datasets, cleaned-up datasets, feature-engineered **data**, **AI models**, **AI model predictions**, or otherwise. (They can even be other forms of copyright-style IP such as **photos**, **videos**, or **music**!) Algorithms themselves may be sold as part of Ocean’s Compute-to-Data feature.
|
||||
|
||||
The first opportunity of data NFTs is the potential to sell the base intellectual property (IP) as an exclusive license to others. This is akin to EMI selling the Beatles’ master tapes to Universal Music: whoever owns the masters has the right to create records, CDs, and digital [sub-licenses](../discover/glossary.md#sub-licensee). It’s the same for data: as the data NFT owner you have the **exclusive right** to create ERC20 datatoken sub-licenses. With Ocean V4, this right is now transferable as a data NFT. You can sell these data NFTs in **OpenSea** and other NFT marketplaces.
|
||||
The first opportunity of data NFTs is the potential to sell the base intellectual property (IP) as an exclusive license to others. This is akin to EMI selling the Beatles’ master tapes to Universal Music: whoever owns the masters has the right to create records, CDs, and digital [sub-licenses](../discover/glossary.md). It’s the same for data: as the data NFT owner you have the **exclusive right** to create ERC20 datatoken sub-licenses. With Ocean V4, this right is now transferable as a data NFT. You can sell these data NFTs in **OpenSea** and other NFT marketplaces.
|
||||
|
||||
If you’re part of an established organization or a growing startup, you’ll also love the new role structure that comes with data NFTs. For example, you can specify a different address to collect [revenue](contracts/revenue.md) compared to the address that owns the NFT. It’s now possible to fully administer your project through these [roles](contracts/roles.md).
|
||||
|
||||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ Define your entry point according to your dependencies. E.g. if you have multipl
|
|||
|
||||
There are plenty of Docker containers that work out of the box. However, if you have custom dependencies, you may want to configure your own Docker Image. To do so, create a Dockerfile with the appropriate instructions for dependency management and publish the container, e.g. using Dockerhub.
|
||||
|
||||
We also collect some [example images](https://github.com/oceanprotocol/algo\_dockers) which you can also view in Dockerhub.
|
||||
We also collect some [example images](https://github.com/oceanprotocol/algo_dockers) which you can also view in Dockerhub.
|
||||
|
||||
When publishing an algorithm through the [Ocean Market](https://market.oceanprotocol.com), these properties can be set via the publish UI.
|
||||
|
||||
|
|
@ -248,7 +248,7 @@ To run this algorithm, use the following `container` object:
|
|||
|
||||
An asset of type `algorithm` has additional attributes under `metadata.algorithm`, describing the algorithm and the Docker environment it is supposed to be run under.
|
||||
|
||||
<table><thead><tr><th>Attribute</th><th width="221.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><strong><code>language</code></strong></td><td><code>string</code></td><td>Language used to implement the software.</td></tr><tr><td><strong><code>version</code></strong></td><td><code>string</code></td><td>Version of the software preferably in <a href="https://semver.org">SemVer</a> notation. E.g. <code>1.0.0</code>.</td></tr><tr><td><strong><code>consumerParameters</code></strong></td><td><a href="did-ddo.md#consumer-parameters">Consumer Parameters</a></td><td>An object that defines required consumer input before running the algorithm</td></tr><tr><td><strong><code>container</code></strong>*</td><td><code>container</code></td><td>Object describing the Docker container image. See below</td></tr></tbody></table>
|
||||
<table><thead><tr><th>Attribute</th><th width="221.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><strong><code>language</code></strong></td><td><code>string</code></td><td>Language used to implement the software.</td></tr><tr><td><strong><code>version</code></strong></td><td><code>string</code></td><td>Version of the software preferably in <a href="https://semver.org">SemVer</a> notation. E.g. <code>1.0.0</code>.</td></tr><tr><td><strong><code>consumerParameters</code></strong></td><td><a href="../compute-to-data/compute-options.md#consumer-parameters">Consumer Parameters</a></td><td>An object that defines required consumer input before running the algorithm</td></tr><tr><td><strong><code>container</code></strong>*</td><td><code>container</code></td><td>Object describing the Docker container image. See below</td></tr></tbody></table>
|
||||
|
||||
\* Required
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,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](../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](../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.
|
||||
|
|
@ -36,9 +36,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 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 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
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ The most basic scenario for a Publisher is to provide access to the datasets the
|
|||
|
||||
* [Compute-to-Data architecture](compute-to-data-architecture.md)
|
||||
* [Tutorial: Writing Algorithms](compute-to-data-algorithms.md)
|
||||
* [Tutorial: Set Up a Compute-to-Data Environment](compute-to-data-minikube.md)
|
||||
* [Tutorial: Set Up a Compute-to-Data Environment](../../infrastructure/compute-to-data-minikube.md)
|
||||
* [Use Compute-to-Data in Ocean Market](https://blog.oceanprotocol.com/compute-to-data-is-now-available-in-ocean-market-58868be52ef7)
|
||||
* [Build ML models via Ocean Market or Python](https://medium.com/ravenprotocol/machine-learning-series-using-logistic-regression-for-classification-in-oceans-compute-to-data-18df49b6b165)
|
||||
* [Compute-to-Data Python Quickstart](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/c2d-flow.md)
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ The publisher now must provide the file URL as `https://example.org` while publi
|
|||
|
||||
|
||||
|
||||
For a complete tutorial on publishing asset using Ocean Marketplace read [our guide on publishing with Ocean Market](../../using-ocean-market/marketplace-publish-data-asset.md).
|
||||
For a complete tutorial on publishing asset using Ocean Marketplace read [our guide on publishing with Ocean Market](../../user-guides//publish-data-nfts.md).
|
||||
|
||||
### Publish an algorithm that uses custom parameters
|
||||
|
||||
|
|
@ -107,18 +107,16 @@ The publisher now must provide the file URL as `https://example.org` while publi
|
|||
|
||||
|
||||
|
||||
For a complete tutorial on publishing asset using Ocean Marketplace read [our guide on publishing with Ocean Market](../../using-ocean-market/marketplace-publish-data-asset.md).
|
||||
For a complete tutorial on publishing asset using Ocean Marketplace read [our guide on publishing with Ocean Market](../../user-guides/publish-data-nfts.md).
|
||||
|
||||
### Starting compute job with custom parameters
|
||||
|
||||
In this example, the buyer wants to run the algorithm with certain parameters on a selected dataset. The code snippet below shows how the buyer can start the compute job with custom parameter values. Before embarking on this tutorial you should familiarize yourself with how to:
|
||||
|
||||
- Search for a dataset using [Ocean market](https://market.oceanprotocol.com/) or [Aquarius API](../../api-references/aquarius-rest-api.md)
|
||||
- Search for a dataset using [Ocean market](https://market.oceanprotocol.com/) or [Aquarius](../aquarius/README.md)
|
||||
- [Allow an algorithm to run on the dataset](https://github.com/oceanprotocol/ocean.py/blob/6eb068df338abc7376430cc5ba7fe2d381508328/READMEs/c2d-flow.md#5-alice-allows-the-algorithm-for-c2d-for-that-data-asset)
|
||||
- Buy datatokens using [Ocean market](https://market.oceanprotocol.com/) or [ocean.py](https://github.com/oceanprotocol/ocean.py)
|
||||
- [Set up ocean.py](../ocean-libraries/configuration.md)
|
||||
|
||||
For configuring ocean.py/ocean.js, please refer this [guide](../ocean-libraries/configuration.md). Copy the below code snippet to a file locally after completing required configurations and execute the script.
|
||||
- [Set up ocean.py](../ocean.py/install.md)
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Python" %}
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ description: Empowering the Decentralised Data Economy
|
|||
|
||||
The [V4 release](https://blog.oceanprotocol.com/ocean-v4-overview-1ccd4a7ce150) of Ocean Protocol introduces a comprehensive and enhanced suite of s[mart contracts](https://github.com/oceanprotocol/contracts/tree/main/contracts) that serve as the backbone of the decentralized data economy. These contracts facilitate secure, transparent, and efficient interactions among data providers, consumers, and ecosystem participants. With the introduction of V4 contracts, Ocean Protocol propels itself forward, delivering substantial functionality, scalability, and flexibility advancements.
|
||||
|
||||
The V4 smart contracts have been deployed across multiple [networks](../../discover/networks/) and are readily accessible through the GitHub [repository](https://github.com/oceanprotocol/contracts/tree/main/contracts). The V4 introduces significant enhancements that encompass the following key **features**:
|
||||
The V4 smart contracts have been deployed across multiple [networks](../../discover/networks/README.md) and are readily accessible through the GitHub [repository](https://github.com/oceanprotocol/contracts/tree/main/contracts). The V4 introduces significant enhancements that encompass the following key **features**:
|
||||
|
||||
### [**Data NFTs**](data-nfts.md) **for Enhanced Data IP Management**
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ However, Ocean V3 faced limitations in terms of flexibility. It lacked support f
|
|||
|
||||
Ocean V4 effectively tackles these challenges by adopting **ERC721** **tokens** to explicitly represent the **base IP** as "data NFTs" (Non-Fungible Tokens). [**Data NFT**](data-nfts.md) owners can now deploy ERC20 "datatoken" contracts specific to their data NFTs, with each datatoken contract offering its own distinct licensing terms.
|
||||
|
||||
By utilizing ERC721 tokens, Ocean V4 **grants data creators greater flexibility and control over licensing arrangements**. The introduction of data NFTs allows for the representation of [base IP](../../discover/glossary.md#base-ip) and the creation of customized ERC20 datatoken contracts tailored to individual licensing requirements.
|
||||
By utilizing ERC721 tokens, Ocean V4 **grants data creators greater flexibility and control over licensing arrangements**. The introduction of data NFTs allows for the representation of [base IP](../../discover/glossary.md) and the creation of customized ERC20 datatoken contracts tailored to individual licensing requirements.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/contracts/v4_contracts_overview.png" alt=""><figcaption><p>Ocean Protocol V4 Smart Contracts</p></figcaption></figure>
|
||||
|
||||
|
|
@ -26,9 +26,9 @@ Ocean V4 brings forth enhanced opportunities for marketplace operators, creating
|
|||
|
||||
With Ocean V4, marketplace operators can unlock additional benefits. Firstly, the V4 smart contracts empower marketplace operators to collect [fees](fees.md) not only during **data consumption** but also through **fixed-rate exchanges**. This expanded revenue model allows operators to derive more value from the ecosystem. Moreover, in Ocean V4, the marketplace operator has the authority to determine the fee value, providing them with **increased control** over their pricing strategies.
|
||||
|
||||
In addition to empowering marketplace operators, Ocean V4 facilitates the participation of third-party [Providers](../provider/) who can offer compute services in exchange for a fee. This paves the way for the development of a diverse marketplace of Providers. This model supports both centralized trusted providers, where data publishers and consumers have established trust relationships, as well as trustless providers that leverage decentralization or other privacy-preserving mechanisms.
|
||||
In addition to empowering marketplace operators, Ocean V4 facilitates the participation of third-party [Providers](../provider/README.md) who can offer compute services in exchange for a fee. This paves the way for the development of a diverse marketplace of Providers. This model supports both centralized trusted providers, where data publishers and consumers have established trust relationships, as well as trustless providers that leverage decentralization or other privacy-preserving mechanisms.
|
||||
|
||||
By enabling a marketplace of [Providers](../provider/), Ocean V4 fosters competition, innovation, and choice. It creates an ecosystem where various providers can offer their compute services, catering to the diverse needs of data publishers and consumers. Whether based on trust or privacy-preserving mechanisms, this expansion in provider options enhances the overall functionality and accessibility of the Ocean Protocol ecosystem.
|
||||
By enabling a marketplace of [Providers](../provider/README.md), Ocean V4 fosters competition, innovation, and choice. It creates an ecosystem where various providers can offer their compute services, catering to the diverse needs of data publishers and consumers. Whether based on trust or privacy-preserving mechanisms, this expansion in provider options enhances the overall functionality and accessibility of the Ocean Protocol ecosystem.
|
||||
|
||||
Key features of the V4 smart contracts:
|
||||
|
||||
|
|
|
|||
|
|
@ -11,9 +11,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](./). 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](./) 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](./) 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
|
||||
|
||||
|
|
@ -21,22 +21,22 @@ Above the smart contracts, you'll find essential [libraries](architecture.md#lib
|
|||
|
||||
#### Libraries
|
||||
|
||||
These libraries include [Ocean.js](broken-reference), a JavaScript library, and [Ocean.py](../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](../ocean.py/README.md), a Python library. They serve as powerful tools for developers, enabling integration and interaction with the protocol.
|
||||
|
||||
1. [Ocean.js](broken-reference): 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](../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-science/) 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](../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-science/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
|
||||
|
||||
|
|
@ -46,8 +46,7 @@ Prominently featured within this layer is [Ocean Market](../../user-guides/using
|
|||
|
||||
### Layer 4: The Friendly Wallets
|
||||
|
||||
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../../discover/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](../../discover/wallets/).
|
||||
|
||||
At the top of the Ocean Protocol ecosystem, we find the esteemed [Web 3 Wallets](../../discover/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](../../discover/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.
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ export interface DatatokenCreateParams {
|
|||
{% endtab %}
|
||||
|
||||
{% tab title="Ocean.py" %}
|
||||
To specify the datatoken template via ocean.py, you need to customize the [DatatokenArguments](https://github.com/oceanprotocol/ocean.py/blob/bad11fb3a4cb00be8bab8febf3173682e1c091fd/ocean\_lib/models/datatoken\_base.py#L64) with your desired template\_index. 
|
||||
To specify the datatoken template via ocean.py, you need to customize the [DatatokenArguments](https://github.com/oceanprotocol/ocean.py/blob/bad11fb3a4cb00be8bab8febf3173682e1c091fd/ocean_lib/models/datatoken_base.py#L64) with your desired template\_index. 
|
||||
|
||||
The default template used is 1.
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ When a user exchanges a [datatoken](datatokens.md) for the privilege of download
|
|||
2. **Consume Market** Consumption Fee 
|
||||
*  A market can specify what fee it wants on the order function.
|
||||
3. **Provider Consumption** Fees 
|
||||
* Defined by the [Provider](../provider/) for any consumption.
|
||||
* Defined by the [Provider](../provider/README.md) for any consumption.
|
||||
* Expressed in: Address, Token, Amount (absolute), Timeout.
|
||||
* You can retrieve them when calling the initialize endpoint. 
|
||||
* Eg: A provider can charge a fixed fee of 10 USDT per consume, irrespective of the pricing schema used (e.g., fixed rate with ETH, BTC, dispenser).
|
||||
|
|
@ -81,16 +81,16 @@ Each of these fees plays a role in ensuring fair compensation and supporting the
|
|||
|
||||
### Provider fee
|
||||
|
||||
[Providers](../provider/) facilitate data consumption, initiate compute jobs, encrypt and decrypt DDOs, and verify user access to specific data assets or services. 
|
||||
[Providers](../provider/README.md) facilitate data consumption, initiate compute jobs, encrypt and decrypt DDOs, and verify user access to specific data assets or services. 
|
||||
|
||||
Provider fees serve as [compensation](../community-monetization.md#3.-running-your-own-provider) to the individuals or organizations operating their own provider instances when users request assets. 
|
||||
|
||||
* Defined by the [Provider](../provider/) for any consumption.
|
||||
* Defined by the [Provider](../provider/README.md) for any consumption.
|
||||
* Expressed in: Address, Token, Amount (absolute), Timeout.
|
||||
* You can retrieve them when calling the initialize endpoint. 
|
||||
* These fees can be set as a **fixed amount** rather than a percentage. 
|
||||
* Providers have the flexibility to specify the token in which the fees must be paid, which can differ from the token used in the consuming market.
|
||||
* Provider fees can be utilized to charge for [computing](../compute-to-data/) resources. Consumers can select the desired payment amount based on the compute resources required to execute an algorithm within the [Compute-to-Data](../compute-to-data/) environment, aligning with their specific needs.
|
||||
* Provider fees can be utilized to charge for [computing](../compute-to-data/README.md) resources. Consumers can select the desired payment amount based on the compute resources required to execute an algorithm within the [Compute-to-Data](../compute-to-data/README.md) environment, aligning with their specific needs.
|
||||
* Eg: A provider can charge a fixed fee of 10 USDT per consume, irrespective of the pricing schema used (e.g., fixed rate with ETH, BTC, dispenser).
|
||||
* Eg: A provider may impose a fixed fee of 15 DAI to reserve compute resources for 1 hour, enabling the initiation of compute jobs.
|
||||
|
||||
|
|
|
|||
|
|
@ -182,8 +182,8 @@ function createNftWithErc20WithDispenser(
|
|||
|
||||
</details>
|
||||
|
||||
To make the most of these pricing models, you can rely on user-friendly libraries such as [Ocean.js ](../ocean.js)and [Ocean.py](../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](../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()](../ocean.py/publish-flow.md#create-an-asset-and-pricing-schema-simultaneously) function allows you to create an asset with fixed pricing. These libraries simplify the process of interacting with Ocean Protocol, managing pricing, and handling asset creation.
|
||||
With Ocean.js, you can use the [createFRE() ](../ocean.js/publish.md)function to effortlessly deploy a data NFT (non-fungible token) and datatoken with a fixed-rate exchange pricing model. Similarly, in Ocean.py, the [create_url_asset()](../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](../ocean.py) (or by using the [Market](../../user-guides/using-ocean-market.md)), 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](../ocean.py/README.md) (or by using the [Market](../../user-guides/using-ocean-market.md)), you can effectively monetize your data assets while ensuring transparent and seamless access for data consumers.
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ On the other hand, with [ERC20Template](datatoken-templates.md#regular-template)
|
|||
|
||||
|
||||
|
||||
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](../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](../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:
|
||||
|
||||
|
|
@ -37,7 +37,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'
|
||||
|
|
|
|||
|
|
@ -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](../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](../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.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,39 +16,39 @@ The below diagram shows the high-level DDO schema depicting the content of each
|
|||
Please note that some data structures apply only on certain types of services or assets.
|
||||
|
||||
```mermaid
|
||||
---
|
||||
---
|
||||
title: DDO High Level Diagram
|
||||
---
|
||||
classDiagram
|
||||
|
||||
class DDO{
|
||||
}
|
||||
|
||||
class Metadata{
|
||||
}
|
||||
class Credentials{
|
||||
}
|
||||
|
||||
class AlgorithmMetadata["AlgorithmMetadata\n(for algorithm type)"] {
|
||||
}
|
||||
|
||||
class Container{
|
||||
}
|
||||
class Service{
|
||||
}
|
||||
class ConsumerParameters["Consumer\nParameters"]{
|
||||
}
|
||||
class Compute{
|
||||
}
|
||||
DDO "1" --> "1" Metadata
|
||||
DDO "1" --> "0..n" Credentials
|
||||
DDO "1" --> "1..*" Service
|
||||
|
||||
Metadata "1" --> "0..1" AlgorithmMetadata
|
||||
AlgorithmMetadata "1" --> "1..*" Container
|
||||
AlgorithmMetadata "1" --> "1..*" ConsumerParameters
|
||||
|
||||
Service "1" --> "0..n" Compute
|
||||
---
|
||||
classDiagram
|
||||
|
||||
class DDO{
|
||||
}
|
||||
|
||||
class Metadata{
|
||||
}
|
||||
class Credentials{
|
||||
}
|
||||
|
||||
class AlgorithmMetadata["AlgorithmMetadata\n(for algorithm type)"] {
|
||||
}
|
||||
|
||||
class Container{
|
||||
}
|
||||
class Service{
|
||||
}
|
||||
class ConsumerParameters["Consumer\nParameters"]{
|
||||
}
|
||||
class Compute{
|
||||
}
|
||||
DDO "1" --> "1" Metadata
|
||||
DDO "1" --> "0..n" Credentials
|
||||
DDO "1" --> "1..*" Service
|
||||
|
||||
Metadata "1" --> "0..1" AlgorithmMetadata
|
||||
AlgorithmMetadata "1" --> "1..*" Container
|
||||
AlgorithmMetadata "1" --> "1..*" ConsumerParameters
|
||||
|
||||
Service "1" --> "0..n" Compute
|
||||
Service "1" --> "0..n" ConsumerParameters
|
||||
```
|
||||
|
||||
|
|
@ -201,7 +201,7 @@ A DDO in Ocean has these required attributes:
|
|||
|
||||
This object holds information describing the actual asset.
|
||||
|
||||
<table><thead><tr><th width="260.3333333333333">Attribute</th><th width="166">Type</th><th>Description</th></tr></thead><tbody><tr><td><strong><code>created</code></strong></td><td><code>ISO date/time string</code></td><td>Contains the date of the creation of the dataset content in ISO 8601 format preferably with timezone designators, e.g. <code>2000-10-31T01:30:00Z</code>.</td></tr><tr><td><strong><code>updated</code></strong></td><td><code>ISO date/time string</code></td><td>Contains the date of last update of the dataset content in ISO 8601 format preferably with timezone designators, e.g. <code>2000-10-31T01:30:00Z</code>.</td></tr><tr><td><strong><code>description</code></strong>*</td><td><code>string</code></td><td>Details of what the resource is. For a dataset, this attribute explains what the data represents and what it can be used for.</td></tr><tr><td><strong><code>copyrightHolder</code></strong></td><td><code>string</code></td><td>The party holding the legal copyright. Empty by default.</td></tr><tr><td><strong><code>name</code></strong>*</td><td><code>string</code></td><td>Descriptive name or title of the asset.</td></tr><tr><td><strong><code>type</code></strong>*</td><td><code>string</code></td><td>Asset type. Includes <code>"dataset"</code> (e.g. csv file), <code>"algorithm"</code> (e.g. Python script). Each type needs a different subset of metadata attributes.</td></tr><tr><td><strong><code>author</code></strong>*</td><td><code>string</code></td><td>Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).</td></tr><tr><td><strong><code>license</code></strong>*</td><td><code>string</code></td><td>Short name referencing the license of the asset (e.g. Public Domain, CC-0, CC-BY, No License Specified, etc. ). If it's not specified, the following value will be added: "No License Specified".</td></tr><tr><td><strong><code>links</code></strong></td><td>Array of <code>string</code></td><td>Mapping of URL strings for data samples, or links to find out more information. Links may be to either a URL or another asset.</td></tr><tr><td><strong><code>contentLanguage</code></strong></td><td><code>string</code></td><td>The language of the content. Use one of the language codes from the <a href="https://tools.ietf.org/html/bcp47">IETF BCP 47 standard</a></td></tr><tr><td><strong><code>tags</code></strong></td><td>Array of <code>string</code></td><td>Array of keywords or tags used to describe this content. Empty by default.</td></tr><tr><td><strong><code>categories</code></strong></td><td>Array of <code>string</code></td><td>Array of categories associated to the asset. Note: recommended to use <code>tags</code> instead of this.</td></tr><tr><td><strong><code>additionalInformation</code></strong></td><td>Object</td><td>Stores additional information, this is customizable by publisher</td></tr><tr><td><strong><code>algorithm</code></strong>**</td><td><a href="did-ddo.md#algorithm-metadata">Algorithm Metadata</a></td><td>Information about asset of <code>type</code> <code>algorithm</code></td></tr></tbody></table>
|
||||
<table><thead><tr><th width="260.3333333333333">Attribute</th><th width="166">Type</th><th>Description</th></tr></thead><tbody><tr><td><strong><code>created</code></strong></td><td><code>ISO date/time string</code></td><td>Contains the date of the creation of the dataset content in ISO 8601 format preferably with timezone designators, e.g. <code>2000-10-31T01:30:00Z</code>.</td></tr><tr><td><strong><code>updated</code></strong></td><td><code>ISO date/time string</code></td><td>Contains the date of last update of the dataset content in ISO 8601 format preferably with timezone designators, e.g. <code>2000-10-31T01:30:00Z</code>.</td></tr><tr><td><strong><code>description</code></strong>*</td><td><code>string</code></td><td>Details of what the resource is. For a dataset, this attribute explains what the data represents and what it can be used for.</td></tr><tr><td><strong><code>copyrightHolder</code></strong></td><td><code>string</code></td><td>The party holding the legal copyright. Empty by default.</td></tr><tr><td><strong><code>name</code></strong>*</td><td><code>string</code></td><td>Descriptive name or title of the asset.</td></tr><tr><td><strong><code>type</code></strong>*</td><td><code>string</code></td><td>Asset type. Includes <code>"dataset"</code> (e.g. csv file), <code>"algorithm"</code> (e.g. Python script). Each type needs a different subset of metadata attributes.</td></tr><tr><td><strong><code>author</code></strong>*</td><td><code>string</code></td><td>Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).</td></tr><tr><td><strong><code>license</code></strong>*</td><td><code>string</code></td><td>Short name referencing the license of the asset (e.g. Public Domain, CC-0, CC-BY, No License Specified, etc. ). If it's not specified, the following value will be added: "No License Specified".</td></tr><tr><td><strong><code>links</code></strong></td><td>Array of <code>string</code></td><td>Mapping of URL strings for data samples, or links to find out more information. Links may be to either a URL or another asset.</td></tr><tr><td><strong><code>contentLanguage</code></strong></td><td><code>string</code></td><td>The language of the content. Use one of the language codes from the <a href="https://tools.ietf.org/html/bcp47">IETF BCP 47 standard</a></td></tr><tr><td><strong><code>tags</code></strong></td><td>Array of <code>string</code></td><td>Array of keywords or tags used to describe this content. Empty by default.</td></tr><tr><td><strong><code>categories</code></strong></td><td>Array of <code>string</code></td><td>Array of categories associated to the asset. Note: recommended to use <code>tags</code> instead of this.</td></tr><tr><td><strong><code>additionalInformation</code></strong></td><td>Object</td><td>Stores additional information, this is customizable by publisher</td></tr><tr><td><strong><code>algorithm</code></strong>**</td><td><a href="compute-to-data/compute-to-data-algorithms.md#algorithm-metadata">Algorithm Metadata</a></td><td>Information about asset of <code>type</code> <code>algorithm</code></td></tr></tbody></table>
|
||||
|
||||
\* Required
|
||||
|
||||
|
|
@ -233,7 +233,7 @@ Services define the access for an asset, and each service is represented by its
|
|||
|
||||
An asset should have at least one service to be actually accessible and can have as many services which make sense for a specific use case.
|
||||
|
||||
<table><thead><tr><th width="259.3333333333333">Attribute</th><th width="121">Type</th><th>Description</th></tr></thead><tbody><tr><td><strong><code>id</code></strong>*</td><td><code>string</code></td><td>Unique ID</td></tr><tr><td><strong><code>type</code></strong>*</td><td><code>string</code></td><td>Type of service <code>access</code>, <code>compute</code>, <code>wss</code> etc.</td></tr><tr><td><strong><code>name</code></strong></td><td><code>string</code></td><td>Service friendly name</td></tr><tr><td><strong><code>description</code></strong></td><td><code>string</code></td><td>Service description</td></tr><tr><td><strong><code>datatokenAddress</code></strong>*</td><td><code>string</code></td><td>Datatoken</td></tr><tr><td><strong><code>serviceEndpoint</code></strong>*</td><td><code>string</code></td><td>Provider URL (schema + host)</td></tr><tr><td><strong><code>files</code></strong>*</td><td><a href="did-ddo.md#files">Files</a></td><td>Encrypted file.</td></tr><tr><td><strong><code>timeout</code></strong>*</td><td><code>number</code></td><td>Describing how long the service can be used after consumption is initiated. A timeout of <code>0</code> represents no time limit. Expressed in seconds.</td></tr><tr><td><strong><code>compute</code></strong>**</td><td><a href="developers/compute-to-data/compute-options.md">Compute</a></td><td>If service is of <code>type</code> <code>compute</code>, holds information about the compute-related privacy settings & resources.</td></tr><tr><td><strong><code>consumerParameters</code></strong></td><td><a href="developers/compute-to-data/compute-options.md#consumer-parameters">Consumer Parameters</a></td><td>An object the defines required consumer input before consuming the asset</td></tr><tr><td><strong><code>additionalInformation</code></strong></td><td>Object</td><td>Stores additional information, this is customizable by publisher</td></tr></tbody></table>
|
||||
<table><thead><tr><th width="259.3333333333333">Attribute</th><th width="121">Type</th><th>Description</th></tr></thead><tbody><tr><td><strong><code>id</code></strong>*</td><td><code>string</code></td><td>Unique ID</td></tr><tr><td><strong><code>type</code></strong>*</td><td><code>string</code></td><td>Type of service <code>access</code>, <code>compute</code>, <code>wss</code> etc.</td></tr><tr><td><strong><code>name</code></strong></td><td><code>string</code></td><td>Service friendly name</td></tr><tr><td><strong><code>description</code></strong></td><td><code>string</code></td><td>Service description</td></tr><tr><td><strong><code>datatokenAddress</code></strong>*</td><td><code>string</code></td><td>Datatoken</td></tr><tr><td><strong><code>serviceEndpoint</code></strong>*</td><td><code>string</code></td><td>Provider URL (schema + host)</td></tr><tr><td><strong><code>files</code></strong>*</td><td><a href="#files">Files</a></td><td>Encrypted file.</td></tr><tr><td><strong><code>timeout</code></strong>*</td><td><code>number</code></td><td>Describing how long the service can be used after consumption is initiated. A timeout of <code>0</code> represents no time limit. Expressed in seconds.</td></tr><tr><td><strong><code>compute</code></strong>**</td><td><a href="compute-to-data/compute-options.md">Compute</a></td><td>If service is of <code>type</code> <code>compute</code>, holds information about the compute-related privacy settings & resources.</td></tr><tr><td><strong><code>consumerParameters</code></strong></td><td><a href="compute-to-data/compute-options.md#consumer-parameters">Consumer Parameters</a></td><td>An object the defines required consumer input before consuming the asset</td></tr><tr><td><strong><code>additionalInformation</code></strong></td><td>Object</td><td>Stores additional information, this is customizable by publisher</td></tr></tbody></table>
|
||||
|
||||
\* Required
|
||||
|
||||
|
|
@ -526,7 +526,7 @@ classDiagram
|
|||
+contentLanguage
|
||||
+categories
|
||||
+copyrightHolder
|
||||
+additionalInformation
|
||||
+additionalInformation
|
||||
+AlgorithmMetadata [for "algorithm" type]
|
||||
}
|
||||
class Credentials{
|
||||
|
|
|
|||
|
|
@ -16,6 +16,6 @@ Choose any API provider of your choice. Some of the commonly used are:
|
|||
* [Alchemy](https://www.alchemy.com/)
|
||||
* [Moralis](https://moralis.io/)
|
||||
|
||||
The supported networks are listed [here](../discover/networks/).
|
||||
The supported networks are listed [here](../discover/networks/README.md).
|
||||
|
||||
Let's configure the remote setup for the mentioned components in the following sections.
|
||||
|
|
|
|||
|
|
@ -40,11 +40,11 @@ An _asset_ in Ocean represents a downloadable file, compute service, or similar.
|
|||
|
||||
An _asset_ has a DID and DDO. The DDO should include metadata about the asset, and define access in at least one [service](ddo-specification.md#services). Only _owners_ or _delegated users_ can modify the DDO.
|
||||
|
||||
All DDOs are stored on-chain in encrypted form to be fully GDPR-compatible. A metadata cache like [_Aquarius_](aquarius/) can help in reading, decrypting, and searching through encrypted DDO data from the chain. Because the file URLs are encrypted on top of the full DDO encryption, returning unencrypted DDOs e.g. via an API is safe to do as the file URLs will still stay encrypted.
|
||||
All DDOs are stored on-chain in encrypted form to be fully GDPR-compatible. A metadata cache like [_Aquarius_](aquarius/README.md) can help in reading, decrypting, and searching through encrypted DDO data from the chain. Because the file URLs are encrypted on top of the full DDO encryption, returning unencrypted DDOs e.g. via an API is safe to do as the file URLs will still stay encrypted.
|
||||
|
||||
#### Publishing & Retrieving DDOs
|
||||
|
||||
The DDO is stored on-chain as part of the NFT contract and stored in encrypted form using the private key of the [_Provider_](provider/). To resolve it, a metadata cache like [_Aquarius_](aquarius/) must query the [Provider](provider/) to decrypt the DDO.
|
||||
The DDO is stored on-chain as part of the NFT contract and stored in encrypted form using the private key of the [_Provider_](provider/README.md). To resolve it, a metadata cache like [_Aquarius_](aquarius/README.md) must query the [Provider](provider/README.md) to decrypt the DDO.
|
||||
|
||||
Here is the flow:
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ To set up the metadata for an asset, you'll need to call the [**setMetaData**](h
|
|||
* **\_metaDataDecryptorUrl** - You create the DDO and then the Provider encrypts it with its private key. Only that Provider can decrypt it.
|
||||
* **\_metaDataDecryptorAddress** - The decryptor address.
|
||||
* **flags** - Additional information to represent the state of the data. One of two values: 0 - plain text, 1 - compressed, 2 - encrypted. Used by Aquarius.
|
||||
* **data -** The [DDO](ddo-specification.md) of the asset. You create the DDO as a JSON, send it to the [Provider](provider/) that encrypts it, and then you set it up at the contract level.
|
||||
* **data -** The [DDO](ddo-specification.md) of the asset. You create the DDO as a JSON, send it to the [Provider](provider/README.md) that encrypts it, and then you set it up at the contract level.
|
||||
* **\_metaDataHash** - Hash of the clear data **generated before the encryption.** It is used by Provider to check the validity of the data after decryption.
|
||||
* **\_metadataProofs** - Array with signatures of entities who validated data (before the encryption). Pass an empty array if you don't have any.
|
||||
|
||||
|
|
|
|||
|
|
@ -20,10 +20,10 @@ Please note that the implementation details of Compute-to-Data can vary dependin
|
|||
|
||||
#### Prerequisites
|
||||
|
||||
* [Obtain an API key](broken-reference)
|
||||
* [Set up the .env file](broken-reference)
|
||||
* [Install the dependencies](broken-reference)
|
||||
* [Create a configuration file](configuration.md)
|
||||
* [Obtain an API key](../get-api-keys-for-blockchain-access.md)
|
||||
* [Set up the .env file](configuration.md#create-a-env-file)
|
||||
* [Install the dependencies](configuration.md#setup-dependencies)
|
||||
* [Create a configuration file](configuration.md#create-a-configuration-file)
|
||||
|
||||
{% hint style="info" %}
|
||||
The variable **AQUARIUS\_URL** and **PROVIDER\_URL** should be set correctly in `.env` file
|
||||
|
|
|
|||
|
|
@ -18,10 +18,10 @@ Later on, when working with the ocean.js library, you can use this order transac
|
|||
|
||||
#### Prerequisites
|
||||
|
||||
* [Obtain an API key](broken-reference)
|
||||
* [Set up the .env file](broken-reference)
|
||||
* [Install the dependencies](broken-reference)
|
||||
* [Create a configuration file](configuration.md)
|
||||
* [Obtain an API key](../get-api-keys-for-blockchain-access.md)
|
||||
* [Set up the .env file](configuration.md#create-a-env-file)
|
||||
* [Install the dependencies](configuration.md#setup-dependencies)
|
||||
* [Create a configuration file](configuration.md#create-a-configuration-file)
|
||||
|
||||
{% hint style="info" %}
|
||||
The variable **AQUARIUS\_URL** and **PROVIDER\_URL** should be set correctly in `.env` file
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
# Creating a data NFT
|
||||
|
||||
This tutorial guides you through the process of creating your own data NFT using Ocean libraries. To know more about data NFT please refer [this page](../../core-concepts/datanft-and-datatoken.md).
|
||||
This tutorial guides you through the process of creating your own data NFT using Ocean libraries. To know more about data NFT please refer [this page](../contracts/data-nfts.md).
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
* [Obtain an API key](configuration.md)
|
||||
* [Set up the .env file](configuration.md)
|
||||
* [Install the dependencies](configuration.md)
|
||||
* [Create a configuration file](configuration.md)
|
||||
* [Obtain an API key](../get-api-keys-for-blockchain-access.md)
|
||||
* [Set up the .env file](configuration.md#create-a-env-file)
|
||||
* [Install the dependencies](configuration.md#setup-dependencies)
|
||||
* [Create a configuration file](configuration.md#create-a-configuration-file)
|
||||
|
||||
#### Create a script to deploy dataNFT
|
||||
|
||||
|
|
|
|||
|
|
@ -4,10 +4,10 @@ This tutorial guides you through the process of minting datatokens and sending t
|
|||
|
||||
#### Prerequisites
|
||||
|
||||
* [Obtain an API key](broken-reference)
|
||||
* [Set up the .env file](broken-reference)
|
||||
* [Install the dependencies](broken-reference)
|
||||
* [Create a configuration file](configuration.md)
|
||||
* [Obtain an API key](../get-api-keys-for-blockchain-access.md)
|
||||
* [Set up the .env file](configuration.md#create-a-env-file)
|
||||
* [Install the dependencies](configuration.md#setup-dependencies)
|
||||
* [Create a configuration file](configuration.md#create-a-configuration-file)
|
||||
|
||||
#### Create a script to mint datatokens
|
||||
|
||||
|
|
|
|||
|
|
@ -4,17 +4,17 @@ This tutorial guides you through the process of creating your own data NFT and a
|
|||
|
||||
#### Prerequisites
|
||||
|
||||
* [Obtain an API key](broken-reference)
|
||||
* [Set up the .env file](broken-reference)
|
||||
* [Install the dependencies](broken-reference)
|
||||
* [Create a configuration file](configuration.md)
|
||||
* [Obtain an API key](../get-api-keys-for-blockchain-access.md)
|
||||
* [Set up the .env file](configuration.md#create-a-env-file)
|
||||
* [Install the dependencies](configuration.md#setup-dependencies)
|
||||
* [Create a configuration file](configuration.md#create-a-configuration-file)
|
||||
|
||||
#### Create a script to deploy a data NFT and datatoken with the price schema you chose.
|
||||
|
||||
Create a new file in the same working directory where configuration file (`config.js`) and `.env` files are present, and copy the code as listed below.
|
||||
|
||||
{% hint style="info" %}
|
||||
**Fees**: The code snippets below define fees related parameters. Please refer [fees page ](../../core-concepts/fees.md)for more details
|
||||
**Fees**: The code snippets below define fees related parameters. Please refer [fees page ](../contracts/fees.md)for more details
|
||||
{% endhint %}
|
||||
|
||||
The code utilizes methods such as `NftFactory` and `Datatoken` from the Ocean libraries to enable you to interact with the Ocean Protocol and perform various operations related to data NFTs and datatokens. 
|
||||
|
|
|
|||
|
|
@ -28,10 +28,10 @@ We can utilize a portion of the previous tutorial on updating metadata and incor
|
|||
|
||||
#### Prerequisites
|
||||
|
||||
* [Obtain an API key](broken-reference)
|
||||
* [Set up the .env file](broken-reference)
|
||||
* [Install the dependencies](broken-reference)
|
||||
* [Create a configuration file](configuration.md)
|
||||
* [Obtain an API key](../get-api-keys-for-blockchain-access.md)
|
||||
* [Set up the .env file](configuration.md#create-a-env-file)
|
||||
* [Install the dependencies](configuration.md#setup-dependencies)
|
||||
* [Create a configuration file](configuration.md#create-a-configuration-file)
|
||||
|
||||
{% hint style="info" %}
|
||||
The variable **AQUARIUS\_URL** and **PROVIDER\_URL** should be set correctly in `.env` file
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
# Update Metadata
|
||||
|
||||
This tutorial will guide you to update an existing asset published on-chain using Ocean libraries. The tutorial assumes that you already have the `did` of the asset which needs to be updated. In this tutorial, we will update the name, description, tags of the data NFT. Please refer [the page on DDO](../../core-concepts/did-ddo.md) to know more about additional the fields which can be updated.
|
||||
This tutorial will guide you to update an existing asset published on-chain using Ocean libraries. The tutorial assumes that you already have the `did` of the asset which needs to be updated. In this tutorial, we will update the name, description, tags of the data NFT. Please refer [the page on DDO](../ddo-specification.md) to know more about additional the fields which can be updated.
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
* [Obtain an API key](broken-reference)
|
||||
* [Set up the .env file](broken-reference)
|
||||
* [Install the dependencies](broken-reference)
|
||||
* [Create a configuration file](configuration.md)
|
||||
* [Obtain an API key](../get-api-keys-for-blockchain-access.md)
|
||||
* [Set up the .env file](configuration.md#create-a-env-file)
|
||||
* [Install the dependencies](configuration.md#setup-dependencies)
|
||||
* [Create a configuration file](configuration.md#create-a-configuration-file)
|
||||
|
||||
{% hint style="info" %}
|
||||
The variable **AQUARIUS\_URL** and **PROVIDER\_URL** should be set correctly in `.env` file
|
||||
|
|
|
|||
|
|
@ -204,10 +204,10 @@ This README has a simple ML algorithm. However, Ocean C2D is not limited to usag
|
|||
|
||||
In the "publish algorithm" step, to replace the sample algorithm with another one:
|
||||
|
||||
* Use one of the standard [Ocean algo\_dockers images](https://github.com/oceanprotocol/algo\_dockers) or publish a custom docker image.
|
||||
* Use one of the standard [Ocean algo_dockers images](https://github.com/oceanprotocol/algo_dockers) or publish a custom docker image.
|
||||
* Use the image name and tag in the `container` part of the algorithm metadata.
|
||||
* The image must have basic support for installing dependencies. E.g. "pip" for the case of Python. You can use other languages, of course.
|
||||
* More info: [https://docs.oceanprotocol.com/tutorials/compute-to-data-algorithms/](https://docs.oceanprotocol.com/tutorials/compute-to-data-algorithms/))
|
||||
* More info: [https://docs.oceanprotocol.com/tutorials/compute-to-data-algorithms/](../compute-to-data/compute-to-data-algorithms.md)
|
||||
|
||||
The function to `pay_for_compute_service` automates order starting, order reusing and performs all the necessary Provider and on-chain requests. It modifies the contents of the given ComputeInput as follows:
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Return value is a hex string which denotes the transaction hash of dispenser dep
|
|||
|
||||
**Defined in**
|
||||
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL336C5-L377C18)
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL336C5-L377C18)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -103,7 +103,7 @@ Return value is a hex string which denotes the transaction hash of dispensed dat
|
|||
|
||||
**Defined in**
|
||||
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL379C5-L400C18)
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL379C5-L400C18)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -147,9 +147,9 @@ It is implemented in `Datatoken2`, so it can be called within `Datatoken2` class
|
|||
**Parameters**
|
||||
|
||||
* `consumer` - address of the consumer wallet that needs funding
|
||||
* `service_index` - service index as int for identifying the service that you want to further call [`start_order`](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL169C5-L197C10).
|
||||
* `service_index` - service index as int for identifying the service that you want to further call [`start_order`](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL169C5-L197C10).
|
||||
* `transaction_parameters` - is the configuration `dictionary` for that specific transaction. Usually for `development` we include just the `from` wallet, but for remote networks, you can provide gas fees, required confirmations for that block etc. For more info, check [Brownie docs](https://eth-brownie.readthedocs.io/en/stable/).
|
||||
* `consume_market_fees` - [`TokenInfo` ](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#L31)object which contains the consume market fee amount, address & token address. If it is not explicitly specified, by default it has an empty `TokenInfo` object.
|
||||
* `consume_market_fees` - [`TokenInfo` ](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#L31)object which contains the consume market fee amount, address & token address. If it is not explicitly specified, by default it has an empty `TokenInfo` object.
|
||||
|
||||
**Returns**
|
||||
|
||||
|
|
@ -159,7 +159,7 @@ Return value is a hex string which denotes the transaction hash of dispensed dat
|
|||
|
||||
**Defined in**
|
||||
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL439C5-L483C1)
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL439C5-L483C1)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -242,7 +242,7 @@ It is implemented in `DatatokenBase`, inherited by `Datatoken2`, so it can be ca
|
|||
|
||||
**Defined in**
|
||||
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL402C1-L409C43)
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL402C1-L409C43)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -293,7 +293,7 @@ This wraps the smart contract method `Datatoken.createFixedRate()` with a simple
|
|||
|
||||
**Defined in**
|
||||
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL236C4-L310C1)
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL236C4-L310C1)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -368,9 +368,9 @@ It is implemented in `Datatoken` class and it is also inherited in `Datatoken2`
|
|||
**Parameters**
|
||||
|
||||
* `consumer` - address of the consumer wallet that needs funding
|
||||
* `service_index` - service index as int for identifying the service that you want to further call [`start_order`](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL169C5-L197C10).
|
||||
* `service_index` - service index as int for identifying the service that you want to further call [`start_order`](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL169C5-L197C10).
|
||||
* `transaction_parameters` - is the configuration `dictionary` for that specific transaction. Usually for `development` we include just the `from` wallet, but for remote networks, you can provide gas fees, required confirmations for that block etc. For more info, check [Brownie docs](https://eth-brownie.readthedocs.io/en/stable/).
|
||||
* `consume_market_fees` - [`TokenInfo` ](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#L31)object which contains the consume market fee amount, address & token address. If it is not explicitly specified, by default it has an empty `TokenInfo` object.
|
||||
* `consume_market_fees` - [`TokenInfo` ](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#L31)object which contains the consume market fee amount, address & token address. If it is not explicitly specified, by default it has an empty `TokenInfo` object.
|
||||
|
||||
**Returns**
|
||||
|
||||
|
|
@ -380,7 +380,7 @@ Return value is a hex string for transaction hash which denotes the proof of sta
|
|||
|
||||
**Defined in**
|
||||
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL484C4-L518C10)
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL484C4-L518C10)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -442,7 +442,7 @@ It is implemented in `DatatokenBase`, inherited by `Datatoken2`, so it can be ca
|
|||
|
||||
**Defined in**
|
||||
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL311C4-L322C25)
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL311C4-L322C25)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -481,7 +481,7 @@ It is implemented in Datatoken class and it is also inherited in Datatoken2 clas
|
|||
* `service_index` - service index as int for identifying the service that you want to apply `start_order`.
|
||||
* `provider_fees` - dictionary which includes provider fees generated when `initialize` endpoint from `Provider` was called.
|
||||
* `transaction_parameters` - is the configuration `dictionary` for that specific transaction. Usually for `development` we include just the `from` wallet, but for remote networks, you can provide gas fees, required confirmations for that block etc. For more info, check [Brownie docs](https://eth-brownie.readthedocs.io/en/stable/).
|
||||
* `consume_market_fees` - [`TokenInfo` ](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#L31)object which contains the consume market fee amount, address & token address. If it is not explicitly specified, by default it has an empty `TokenInfo` object.
|
||||
* `consume_market_fees` - [`TokenInfo` ](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#L31)object which contains the consume market fee amount, address & token address. If it is not explicitly specified, by default it has an empty `TokenInfo` object.
|
||||
|
||||
**Returns**
|
||||
|
||||
|
|
@ -491,7 +491,7 @@ Return value is a hex string for transaction hash which denotes the proof of sta
|
|||
|
||||
**Defined in**
|
||||
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL169C5-L197C10)
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL169C5-L197C10)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -553,7 +553,7 @@ Return value is a hex string for transaction hash which denotes the proof of reu
|
|||
|
||||
**Defined in**
|
||||
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL199C5-L219C10)
|
||||
[models/datatoken.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL199C5-L219C10)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB |
|
|
@ -30,7 +30,7 @@ pip install wheel
|
|||
pip install ocean-lib
|
||||
```
|
||||
|
||||
### Potential issues & workarounds <a href="#60e8" id="60e8"></a>
|
||||
### Potential issues & workarounds
|
||||
|
||||
Issue: M1 \* `coincurve` or `cryptography`
|
||||
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ A tuple which contains the data NFT, datatoken and the data asset.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL178C1-L185C82)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL178C1-L185C82)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -78,7 +78,7 @@ A tuple which contains the algorithm NFT, algorithm datatoken and the algorithm
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL146C4-L176C82)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL146C4-L176C82)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -145,7 +145,7 @@ A tuple which contains the data NFT, datatoken and the data asset.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL187C5-L198C82)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL187C5-L198C82)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -194,7 +194,7 @@ A tuple which contains the data NFT, datatoken and the data asset.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL200C5-L212C82)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL200C5-L212C82)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -244,7 +244,7 @@ A tuple which contains the data NFT, datatoken and the data asset.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL214C5-L229C1)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL214C5-L229C1)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -304,7 +304,7 @@ A tuple which contains the data NFT, datatoken and the data asset.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL259C5-L390C43)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL259C5-L390C43)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -541,7 +541,7 @@ The updated DDO, or `None` if updated DDO not found in Aquarius.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL392C5-L454C19)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL392C5-L454C19)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -627,7 +627,7 @@ Returns DDO instance.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL456C5-L458C43)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL456C5-L458C43)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -659,7 +659,7 @@ A list of DDOs which have matches with the text provided as parameter.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL460C4-L475C10)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL460C4-L475C10)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -704,7 +704,7 @@ A list of DDOs which have matches with the query provided as parameter.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL477C4-L490C10)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL477C4-L490C10)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -758,7 +758,7 @@ The full path to the downloaded file as `string`.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL492C5-L516C20)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL492C5-L516C20)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -822,7 +822,7 @@ Return value is a hex string for transaction hash which denotes the proof of sta
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL518C5-L571C28)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL518C5-L571C28)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -916,7 +916,7 @@ Return value is a tuple composed of list of datasets and algorithm data (if exis
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/ocean/ocean\_assets.py#LL573C5-L627C30)
|
||||
[ocean/ocean_assets.py](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/ocean/ocean_assets.py#LL573C5-L627C30)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ Returns a string type job ID.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_compute.py#LL32C4-L70C33)
|
||||
[ocean/ocean_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_compute.py#LL32C4-L70C33)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -108,7 +108,7 @@ A dictionary which contains the status for an existing compute job, keys are `(o
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_compute.py#LL72C5-L88C24)
|
||||
[ocean/ocean_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_compute.py#LL72C5-L88C24)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -162,7 +162,7 @@ A dictionary wich contains the results/logs urls for an existing compute job, ke
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_compute.py#LL90C5-L106C22)
|
||||
[ocean/ocean_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_compute.py#LL90C5-L106C22)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -216,7 +216,7 @@ A dictionary which includes the results/logs urls for an existing compute job, k
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_compute.py#LL108C5-L130C22)
|
||||
[ocean/ocean_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_compute.py#LL108C5-L130C22)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -275,7 +275,7 @@ A dictionary which contains the status for the stopped compute job, keys are `(o
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_compute.py#LL132C5-L146C24)
|
||||
[ocean/ocean_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_compute.py#LL132C5-L146C24)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -324,7 +324,7 @@ A list of objects containing information about each compute environment. For eac
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_compute.py#LL148C4-L150C84)
|
||||
[ocean/ocean_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_compute.py#LL148C4-L150C84)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -363,7 +363,7 @@ A list of objects containing information about each compute environment. For eac
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean\_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_compute.py#LL152C5-L155C87)
|
||||
[ocean/ocean_compute.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_compute.py#LL152C5-L155C87)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
# Page 1
|
||||
|
||||
|
|
@ -85,9 +85,9 @@ The DDO is stored on-chain. It's encrypted and compressed by default. Therefore
|
|||
|
||||
You can control this during `create()`:
|
||||
|
||||
* To disable encryption, use [`ocean.assets.create(..., encrypt_flag=False)`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_assets.py#L425).
|
||||
* To disable compression, use [`ocean.assets.create(..., compress_flag=False)`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_assets.py#L426).
|
||||
* To disable both, use [`ocean.assetspy.create(..., encrypt_flag=False, compress_flag=False)`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean\_assets.py#LL425C8-L426C46).
|
||||
* To disable encryption, use [`ocean.assets.create(..., encrypt_flag=False)`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_assets.py#L425).
|
||||
* To disable compression, use [`ocean.assets.create(..., compress_flag=False)`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_assets.py#L426).
|
||||
* To disable both, use [`ocean.assetspy.create(..., encrypt_flag=False, compress_flag=False)`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean_assets.py#LL425C8-L426C46).
|
||||
|
||||
#### Create a data NFT
|
||||
|
||||
|
|
@ -113,7 +113,7 @@ If you call `create()` after this, you can pass in an argument `deployed_datatok
|
|||
|
||||
Ocean Assets allows you to bundle several common scenarios as a single transaction, thus lowering gas fees.
|
||||
|
||||
Any of the `ocean.assets.create_<type>_asset()` functions can also take an optional parameter that describes a bundled [pricing schema](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean\_lib/models/datatoken.py#LL199C5-L219C10) (Dispenser or Fixed Rate Exchange). 
|
||||
Any of the `ocean.assets.create_<type>_asset()` functions can also take an optional parameter that describes a bundled [pricing schema](https://github.com/oceanprotocol/ocean.py/blob/4aa12afd8a933d64bc2ed68d1e5359d0b9ae62f9/ocean_lib/models/datatoken.py#LL199C5-L219C10) (Dispenser or Fixed Rate Exchange). 
|
||||
|
||||
Here is an example involving an exchange:
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ description: Technical details about most used ocean.py functions
|
|||
|
||||
# Ocean Instance Tech Details
|
||||
|
||||
At the beginning of most flows, we create an `ocean` object, which is an instance of class [`Ocean`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py). It exposes useful information, including the following:
|
||||
At the beginning of most flows, we create an `ocean` object, which is an instance of class [`Ocean`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py). It exposes useful information, including the following:
|
||||
|
||||
* properties for config & OCEAN token
|
||||
* contract objects retrieval
|
||||
|
|
@ -30,7 +30,7 @@ In order to initialize a Ocean object, you must provide `config_dict` which is a
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#L43)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#L43)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -112,7 +112,7 @@ Configuration fields as dictionary.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL265C1-L268C32)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL265C1-L268C32)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -129,7 +129,7 @@ Configuration fields as dictionary.
|
|||
|
||||
### OCEAN Token Address
|
||||
|
||||
* **OCEAN\_address**(`self`) -> `str`
|
||||
* **ocean_address**(`self`) -> `str`
|
||||
|
||||
It is a helper method for retrieving the OCEAN's token address.\
|
||||
It can be called only by Ocean object and returns the address as a `string`.
|
||||
|
|
@ -142,7 +142,7 @@ OCEAN token address for that network.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL100C1-L103C52)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL100C1-L103C52)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -155,7 +155,7 @@ OCEAN token address for that network.
|
|||
return get_ocean_token_address(self.config)
|
||||
```
|
||||
|
||||
[`get_ocean_token_address`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/util.py#LL31C1-L38C89) function is an utilitary function which gets the address from `address.json` file
|
||||
[`get_ocean_token_address`](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/util.py#LL31C1-L38C89) function is an utilitary function which gets the address from `address.json` file
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```python
|
||||
|
|
@ -174,7 +174,7 @@ def get_ocean_token_address(config_dict: dict) -> str:
|
|||
|
||||
### OCEAN Token Object
|
||||
|
||||
* **OCEAN\_token**(`self`) -> `DatatokenBase`
|
||||
* **ocean_token**(`self`) -> `DatatokenBase`
|
||||
* **OCEAN**(`self`) -> `DatatokenBase` as alias for the above option
|
||||
|
||||
It is a helper method for retrieving the OCEAN token object (Datatoken class).\
|
||||
|
|
@ -188,7 +188,7 @@ OCEAN token as `DatatokenBase` object.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL105C1-L113C32)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL105C1-L113C32)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -223,7 +223,7 @@ Data NFT Factory contract object which access all the functionalities available
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL117C1-L120C80)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL117C1-L120C80)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -256,7 +256,7 @@ Dispenser contract object which access all the functionalities available from sm
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL122C1-L125C63)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL122C1-L125C63)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -287,7 +287,7 @@ Fixed Rate Exchange contract object which access all the functionalities availab
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL127C1-L130C72)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL127C1-L130C72)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -321,7 +321,7 @@ Data NFT object which access all the functionalities available for ERC721 templa
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL139C5-L145C51)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL139C5-L145C51)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -358,7 +358,7 @@ Datatoken object which access all the functionalities available for ERC20 templa
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL147C5-L153C67)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL147C5-L153C67)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -398,7 +398,7 @@ List of all the orders on that `datatoken` done by the specified `user`.
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL157C5-L173C23)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL157C5-L173C23)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -450,7 +450,7 @@ A dictionary which contains the following keys (`providerFeeAddress`, `providerF
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL177C4-L189C1)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL177C4-L189C1)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
@ -497,7 +497,7 @@ A dictionary which contains the following keys (`providerFeeAddress`, `providerF
|
|||
|
||||
**Defined in**
|
||||
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean\_lib/ocean/ocean.py#LL190C4-L210C1)
|
||||
[ocean/ocean.py](https://github.com/oceanprotocol/ocean.py/blob/main/ocean_lib/ocean/ocean.py#LL190C4-L210C1)
|
||||
|
||||
<details>
|
||||
|
||||
|
|
|
|||
|
|
@ -40,4 +40,4 @@ We recommend checking the README in the Provider [GitHub repository](https://git
|
|||
|
||||
The following pages in this section specify the endpoints for Ocean Provider that have been implemented by the core developers.
|
||||
|
||||
For inspecting the errors received from `Provider` and their reasons, please revise this [document](https://github.com/oceanprotocol/provider/blob/main/ocean\_provider/routes/README.md).
|
||||
For inspecting the errors received from `Provider` and their reasons, please revise this [document](https://github.com/oceanprotocol/provider/blob/main/ocean_provider/routes/README.md).
|
||||
|
|
|
|||
|
|
@ -154,7 +154,7 @@ Example:
|
|||
}
|
||||
```
|
||||
|
||||
To get information about the files after encryption, the `/fileinfo` endpoint of the [_Provider_](provider/) returns based on a passed DID an array of file metadata (based on the file type):
|
||||
To get information about the files after encryption, the `/fileinfo` endpoint of the [_Provider_](provider/README.md) returns based on a passed DID an array of file metadata (based on the file type):
|
||||
|
||||
```json
|
||||
[
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ You can utilize the Subgraph instances provided by Ocean Protocol or deploy your
|
|||
If you're eager to use the Ocean Subgraph, here's some important information for you: We've deployed an Ocean Subgraph for each of the supported networks. Take a look at the table below, where you'll find handy links to both the subgraph instance and GraphiQL for each network. With the user-friendly GraphiQL interface, you can execute GraphQL queries directly, without any additional setup. It's a breeze! :ocean:
|
||||
|
||||
{% hint style="info" %}
|
||||
When it comes to fetching valuable information about [Data NFTs](../contracts/data-nfts.md) and [datatokens](../contracts/datatokens.md), the subgraph queries play a crucial role. They retrieve numerous details and information, but, the Subgraph cannot decrypt the DDO. But worry not, we have a dedicated component for that—[Aquarius](../aquarius/)! 🐬 Aquarius communicates with the provider and decrypts the encrypted information, making it readily available for queries. 
|
||||
When it comes to fetching valuable information about [Data NFTs](../contracts/data-nfts.md) and [datatokens](../contracts/datatokens.md), the subgraph queries play a crucial role. They retrieve numerous details and information, but, the Subgraph cannot decrypt the DDO. But worry not, we have a dedicated component for that—[Aquarius](../aquarius/README.md)! 🐬 Aquarius communicates with the provider and decrypts the encrypted information, making it readily available for queries. 
|
||||
{% endhint %}
|
||||
|
||||
### Ocean Subgraph deployments
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Now that you are familiar with the process of retrieving a list of data NFTs
|
|||
|
||||
The result of the following GraphQL query returns the information about a particular data NFT. In this example, `0x1c161d721e6d99f58d47f709cdc77025056c544c`.
|
||||
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](README.md#ocean-subgraph-deployments)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ description: Query the Subgraph to see the buyers of a datatoken.
|
|||
|
||||
The result of the following GraphQL query returns the list of buyers for a particular datatoken. Here, `0xc22bfd40f81c4a28c809f80d05070b95a11829d9` is the address of the datatoken.
|
||||
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the **Mumbai** network. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the **Mumbai** network. If you want to change the network, please refer to_ [_this table_](README.md#ocean-subgraph-deployments)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="JavaScript" %}
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ To fetch detailed information about a specific datatoken, you can utilize the po
|
|||
|
||||
The result of the following GraphQL query returns the information about a particular datatoken. Here, `0x122d10d543bc600967b4db0f45f80cb1ddee43eb` is the address of the datatoken.
|
||||
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](README.md#ocean-subgraph-deployments)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ There are several options available to see this query in action. Below, you will
|
|||
2. Execute the query in Python by following the code snippet.
|
||||
3. Execute the query in JavaScript by clicking on the "Run" button of the Javascript tab.
|
||||
|
||||
_PS: In these examples, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
_PS: In these examples, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](README.md#ocean-subgraph-deployments)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ With your newfound knowledge of fetching data NFTs and retrieving the associated
|
|||
|
||||
|
||||
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](README.md#ocean-subgraph-deployments)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Having gained knowledge about fetching lists of data NFTs and datatokens and ext
|
|||
|
||||
|
||||
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the mainnet. If you want to change the network, please refer to_ [_this table_](README.md#ocean-subgraph-deployments)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
|
|
|
|||
|
|
@ -1,196 +0,0 @@
|
|||
---
|
||||
description: >-
|
||||
Explore the Power of Querying: Unveiling In-Depth Details of Individual Data
|
||||
NFTs
|
||||
---
|
||||
|
||||
# Get data NFT information
|
||||
|
||||
Now that you are familiar with the process of retrieving a list of data NFTs 😎, let's explore how to obtain more specific details about a particular NFT through querying. By utilizing the knowledge you have gained, you can customize your GraphQL query to include additional parameters such as the NFT's metadata, creator information, template, or any other relevant data points. This will enable you to delve deeper into the intricacies of a specific NFT and gain a comprehensive understanding of its attributes. With this newfound capability, you can unlock valuable insights and make informed decisions based on the specific details retrieved. So, let's dive into the fascinating world of querying and unravel the unique characteristics of individual data NFTs.
|
||||
|
||||
|
||||
|
||||
The result of the following GraphQL query returns the information about a particular data NFT. In this example, `0x1c161d721e6d99f58d47f709cdc77025056c544c`.
|
||||
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the **mainnet**. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
The javascript below can be used to run the query and fetch the information of a data NFT. If you wish to change the network, replace the variable's value `network` as needed. Change the value of the variable `datanftAddress` with the address of your choice.
|
||||
|
||||
```runkit nodeVersion="18.x.x"
|
||||
var axios = require('axios');
|
||||
|
||||
const datanftAddress = "0x1c161d721e6d99f58d47f709cdc77025056c544c";
|
||||
|
||||
const query = `{
|
||||
nft (id:"${datanftAddress}", subgraphError:deny){
|
||||
id
|
||||
name
|
||||
symbol
|
||||
owner
|
||||
address
|
||||
assetState
|
||||
tx
|
||||
block
|
||||
transferable
|
||||
creator
|
||||
createdTimestamp
|
||||
providerUrl
|
||||
managerRole
|
||||
erc20DeployerRole
|
||||
storeUpdateRole
|
||||
metadataRole
|
||||
tokenUri
|
||||
template
|
||||
orderCount
|
||||
}
|
||||
}`
|
||||
|
||||
const network = "mainnet"
|
||||
var config = {
|
||||
method: 'post',
|
||||
url: `https://v4.subgraph.${network}.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph`,
|
||||
headers: { "Content-Type": "application/json" },
|
||||
data: JSON.stringify({ "query": query })
|
||||
};
|
||||
|
||||
axios(config)
|
||||
.then(function (response) {
|
||||
let result = JSON.stringify(response.data)
|
||||
console.log(result)
|
||||
})
|
||||
.catch(function (error) {
|
||||
console.log(error);
|
||||
});
|
||||
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Python" %}
|
||||
The Python script below can be used to run the query and fetch the details about an NFT. If you wish to change the network, replace the variable's value `base_url` as needed. Change the value of the variable dataNFT\_address with the address of the datatoken of your choice.
|
||||
|
||||
**Create script**
|
||||
|
||||
{% code title="dataNFT_information.py" %}
|
||||
```python
|
||||
import requests
|
||||
import json
|
||||
|
||||
dataNFT_address = "0x1c161d721e6d99f58d47f709cdc77025056c544c"
|
||||
query = """
|
||||
{{
|
||||
nft (id:"{0}", subgraphError:deny){{
|
||||
id
|
||||
name
|
||||
symbol
|
||||
owner
|
||||
address
|
||||
assetState
|
||||
tx
|
||||
block
|
||||
transferable
|
||||
creator
|
||||
createdTimestamp
|
||||
providerUrl
|
||||
managerRole
|
||||
erc20DeployerRole
|
||||
storeUpdateRole
|
||||
metadataRole
|
||||
tokenUri
|
||||
template
|
||||
orderCount
|
||||
}}
|
||||
}}""".format(
|
||||
dataNFT_address
|
||||
)
|
||||
|
||||
base_url = "https://v4.subgraph.mainnet.oceanprotocol.com"
|
||||
route = "/subgraphs/name/oceanprotocol/ocean-subgraph"
|
||||
|
||||
url = base_url + route
|
||||
|
||||
headers = {"Content-Type": "application/json"}
|
||||
payload = json.dumps({"query": query})
|
||||
response = requests.request("POST", url, headers=headers, data=payload)
|
||||
result = json.loads(response.text)
|
||||
|
||||
print(json.dumps(result, indent=4, sort_keys=True))
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
**Execute script**
|
||||
|
||||
<pre class="language-bash"><code class="lang-bash"><strong>python dataNFT_information.py
|
||||
</strong></code></pre>
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Query" %}
|
||||
Copy the query to fetch the information about a data NFT in the Ocean Subgraph [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql). If you want to fetch the information about another NFT, replace the `id` with the address of your choice.
|
||||
|
||||
```graphql
|
||||
{
|
||||
nft (id:"0x1c161d721e6d99f58d47f709cdc77025056c544c", subgraphError:deny){
|
||||
id
|
||||
name
|
||||
symbol
|
||||
owner
|
||||
address
|
||||
assetState
|
||||
tx
|
||||
block
|
||||
transferable
|
||||
creator
|
||||
createdTimestamp
|
||||
providerUrl
|
||||
managerRole
|
||||
erc20DeployerRole
|
||||
storeUpdateRole
|
||||
metadataRole
|
||||
tokenUri
|
||||
template
|
||||
orderCount
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Sample response</summary>
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"nft": {
|
||||
"address": "0x1c161d721e6d99f58d47f709cdc77025056c544c",
|
||||
"assetState": 0,
|
||||
"block": 15185270,
|
||||
"createdTimestamp": 1658397870,
|
||||
"erc20DeployerRole": [
|
||||
"0x1706df1f2d93558d1d77bed49ccdb8b88fafc306"
|
||||
],
|
||||
"id": "0x1c161d721e6d99f58d47f709cdc77025056c544c",
|
||||
"managerRole": [
|
||||
"0xd30dd83132f2227f114db8b90f565bca2832afbd"
|
||||
],
|
||||
"metadataRole": null,
|
||||
"name": "Ocean Data NFT",
|
||||
"orderCount": "1",
|
||||
"providerUrl": "https://v4.provider.mainnet.oceanprotocol.com",
|
||||
"storeUpdateRole": null,
|
||||
"symbol": "OCEAN-NFT",
|
||||
"template": "",
|
||||
"tokenUri": "data:application/json;base64,eyJuYW1lIjoiT2NlYW4gRGF0YSBORlQiLCJzeW1ib2wiOiJPQ0VBTi1ORlQiLCJkZXNjcmlwdGlvbiI6IlRoaXMgTkZUIHJlcHJlc2VudHMgYW4gYXNzZXQgaW4gdGhlIE9jZWFuIFByb3RvY29sIHY0IGVjb3N5c3RlbS5cblxuVmlldyBvbiBPY2VhbiBNYXJrZXQ6IGh0dHBzOi8vbWFya2V0Lm9jZWFucHJvdG9jb2wuY29tL2Fzc2V0L2RpZDpvcDo1YzdjNThjYWNhNDAzMmU2NzNhNDE2NWM3N2YxOGQ0MDVmYmVlODc3YzA3OGFhMjU3ZjY1ODdhZjM5NzhkYTVmIiwiZXh0ZXJuYWxfdXJsIjoiaHR0cHM6Ly9tYXJrZXQub2NlYW5wcm90b2NvbC5jb20vYXNzZXQvZGlkOm9wOjVjN2M1OGNhY2E0MDMyZTY3M2E0MTY1Yzc3ZjE4ZDQwNWZiZWU4NzdjMDc4YWEyNTdmNjU4N2FmMzk3OGRhNWYiLCJiYWNrZ3JvdW5kX2NvbG9yIjoiMTQxNDE0IiwiaW1hZ2VfZGF0YSI6ImRhdGE6aW1hZ2Uvc3ZnK3htbCwlM0Nzdmcgdmlld0JveD0nMCAwIDk5IDk5JyBmaWxsPSd1bmRlZmluZWQnIHhtbG5zPSdodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyclM0UlM0NwYXRoIGZpbGw9JyUyM2ZmNDA5Mjc3JyBkPSdNMCw5OUwwLDI3QzgsMjkgMTcsMzEgMjUsMzBDMzIsMjggMzgsMjQgNDYsMjVDNTMsMjUgNjIsMjkgNzIsMzFDODEsMzIgOTAsMzEgOTksMzBMOTksOTlaJy8lM0UlM0NwYXRoIGZpbGw9JyUyM2ZmNDA5MmJiJyBkPSdNMCw5OUwwLDU0QzgsNTIgMTcsNTAgMjYsNTFDMzQsNTEgNDIsNTUgNTEsNTVDNTksNTQgNjcsNDkgNzYsNDlDODQsNDggOTEsNTIgOTksNTZMOTksOTlaJyUzRSUzQy9wYXRoJTNFJTNDcGF0aCBmaWxsPSclMjNmZjQwOTJmZicgZD0nTTAsOTlMMCw4MEM4LDc4IDE3LDc3IDI3LDc3QzM2LDc2IDQ1LDc3IDUyLDc3QzU4LDc2IDYzLDc0IDcxLDczQzc4LDcxIDg4LDcxIDk5LDcxTDk5LDk5WiclM0UlM0MvcGF0aCUzRSUzQy9zdmclM0UifQ==",
|
||||
"transferable": true,
|
||||
"tx": "0x327a9da0d2e9df945fd2f8e10b1caa77acf98e803c5a2f588597172a0bcbb93a"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
</details>
|
||||
|
|
@ -1,320 +0,0 @@
|
|||
---
|
||||
description: >-
|
||||
Explore the Power of Querying: Unveiling In-Depth Details of Individual
|
||||
Datatokens
|
||||
---
|
||||
|
||||
# Get datatoken information
|
||||
|
||||
To fetch detailed information about a specific datatoken, you can utilize the power of GraphQL queries. By constructing a query tailored to your needs, you can access key parameters such as the datatoken's `ID`, `name`, `symbol`, `total supply`, and `creator`. This allows you to gain a deeper understanding of the datatoken's characteristics and properties. With this information at your disposal, you can make informed decisions, analyze market trends, and explore the vast potential of datatokens within the Ocean ecosystem. 
|
||||
|
||||
|
||||
|
||||
The result of the following GraphQL query returns the information about a particular datatoken. Here, `0x122d10d543bc600967b4db0f45f80cb1ddee43eb` is the address of the datatoken.
|
||||
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the **mainnet**. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
The javascript below can be used to run the query and fetch the information of a datatoken. If you wish to change the network, replace the variable's value `network` as needed. Change the value of the variable `datatokenAddress` with the address of your choice.
|
||||
|
||||
```runkit nodeVersion="18.x.x"
|
||||
var axios = require('axios');
|
||||
|
||||
const datatokenAddress = "0x122d10d543bc600967b4db0f45f80cb1ddee43eb";
|
||||
|
||||
const query = `{
|
||||
token(id:"${datatokenAddress}", subgraphError: deny){
|
||||
id
|
||||
symbol
|
||||
nft {
|
||||
name
|
||||
symbol
|
||||
address
|
||||
}
|
||||
name
|
||||
symbol
|
||||
cap
|
||||
isDatatoken
|
||||
holderCount
|
||||
orderCount
|
||||
orders(skip:0,first:1){
|
||||
amount
|
||||
serviceIndex
|
||||
payer {
|
||||
id
|
||||
}
|
||||
consumer{
|
||||
id
|
||||
}
|
||||
estimatedUSDValue
|
||||
lastPriceToken
|
||||
lastPriceValue
|
||||
}
|
||||
}
|
||||
fixedRateExchanges(subgraphError:deny){
|
||||
id
|
||||
price
|
||||
active
|
||||
}
|
||||
}`
|
||||
|
||||
const network = "mainnet"
|
||||
var config = {
|
||||
method: 'post',
|
||||
url: `https://v4.subgraph.${network}.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph`,
|
||||
headers: { "Content-Type": "application/json" },
|
||||
data: JSON.stringify({ "query": query })
|
||||
};
|
||||
|
||||
axios(config)
|
||||
.then(function (response) {
|
||||
let result = JSON.stringify(response.data)
|
||||
console.log(result);
|
||||
})
|
||||
.catch(function (error) {
|
||||
console.log(error);
|
||||
});
|
||||
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Python" %}
|
||||
The Python script below can be used to run the query and fetch the datatoken information. If you wish to change the network, replace the variable's value `base_url` as needed. Change the value of the variable `datatoken_address` with the address of the datatoken of your choice.
|
||||
|
||||
**Create script**
|
||||
|
||||
{% code title="datatoken_information.py" %}
|
||||
```python
|
||||
import requests
|
||||
import json
|
||||
|
||||
|
||||
import requests
|
||||
import json
|
||||
|
||||
datatoken_address = "0x122d10d543bc600967b4db0f45f80cb1ddee43eb"
|
||||
query = """
|
||||
{{
|
||||
token(id:"{0}", subgraphError: deny){{
|
||||
id
|
||||
symbol
|
||||
nft {{
|
||||
name
|
||||
symbol
|
||||
address
|
||||
}}
|
||||
name
|
||||
symbol
|
||||
cap
|
||||
isDatatoken
|
||||
holderCount
|
||||
orderCount
|
||||
orders(skip:0,first:1){{
|
||||
amount
|
||||
serviceIndex
|
||||
payer {{
|
||||
id
|
||||
}}
|
||||
consumer{{
|
||||
id
|
||||
}}
|
||||
estimatedUSDValue
|
||||
lastPriceToken
|
||||
lastPriceValue
|
||||
}}
|
||||
}}
|
||||
fixedRateExchanges(subgraphError:deny){{
|
||||
id
|
||||
price
|
||||
active
|
||||
}}
|
||||
}}""".format(
|
||||
datatoken_address
|
||||
)
|
||||
|
||||
base_url = "https://v4.subgraph.mainnet.oceanprotocol.com/"
|
||||
route = "subgraphs/name/oceanprotocol/ocean-subgraph"
|
||||
|
||||
url = base_url + route
|
||||
|
||||
headers = {"Content-Type": "application/json"}
|
||||
payload = json.dumps({"query": query})
|
||||
response = requests.request("POST", url, headers=headers, data=payload)
|
||||
result = response.json()
|
||||
|
||||
print(json.dumps(result, indent=4, sort_keys=True))
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
**Execute script**
|
||||
|
||||
<pre class="language-bash"><code class="lang-bash"><strong>python datatoken_information.py
|
||||
</strong></code></pre>
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Query" %}
|
||||
Copy the query to fetch the information of a datatoken in the Ocean Subgraph [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql). 
|
||||
|
||||
```
|
||||
{
|
||||
token(id:"0x122d10d543bc600967b4db0f45f80cb1ddee43eb", subgraphError: deny){
|
||||
id
|
||||
symbol
|
||||
nft {
|
||||
name
|
||||
symbol
|
||||
address
|
||||
}
|
||||
name
|
||||
symbol
|
||||
cap
|
||||
isDatatoken
|
||||
holderCount
|
||||
orderCount
|
||||
orders(skip:0,first:1){
|
||||
amount
|
||||
serviceIndex
|
||||
payer {
|
||||
id
|
||||
}
|
||||
consumer{
|
||||
id
|
||||
}
|
||||
estimatedUSDValue
|
||||
lastPriceToken
|
||||
lastPriceValue
|
||||
}
|
||||
}
|
||||
fixedRateExchanges(subgraphError:deny){
|
||||
id
|
||||
price
|
||||
active
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Sample response</summary>
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"fixedRateExchanges": [
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x06284c39b48afe5f01a04d56f1aae45dbb29793b190ee11e93a4a77215383d44",
|
||||
"price": "600"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x103714d9d215b971253ef72b4f5de6b0cb0df1ad9a3763cec698262c64cbecfe",
|
||||
"price": "1000"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x2719862ebc4ed253f09088c878e00ef8ee2a792e1c5c765fac35dc18d7ef4deb",
|
||||
"price": "35"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x2dccaa373e4b65d5ec153c150270e989d1bda1efd3794c851e45314c40809f9c",
|
||||
"price": "33"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x43b8de24276d304c2dead8560db460aab3f81f173b4f3710f7d9bda4ae3cef22",
|
||||
"price": "600"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x4d81e7e5944b819df7e978147fd2a94b09705938861bbbb496077913f80d824c",
|
||||
"price": "5"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x6e4d73b0f346d03c82ebe7d41501d06d3c38f15ca19ee973029bc0a8d2da95fc",
|
||||
"price": "50"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x82a659688a4df76226768ec49d9e994a83fb87410d00d88958eb603da0462341",
|
||||
"price": "5"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x86162b68bcfcc3d8efb726e0c3ff85809e8e45568f3fd986eafe89eb8fa96b3f",
|
||||
"price": "1"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x8d7ccaa8354664556735c75807f75a00ad3e8fa9e7b72d9ca5dc22eb852c5088",
|
||||
"price": "5"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0xb02d83434f392b295def216c5763e277265d3c0a414e73192961495408817d40",
|
||||
"price": "1"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0xb32cd1971f1a3e69b823a5b27caea8232fdcca9546e72cc34b569ce13aa78530",
|
||||
"price": "250"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0xb3fcb7ab8c771ddbf56bc3b6cd9f68dd8a5193dfcec68c17306f8c464eac6314",
|
||||
"price": "6000"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0xbceef39ad618897160748717cefe79fd49b9e9be37ae5021998cf82b3a345a78",
|
||||
"price": "1000000"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0xce52c09d65a8988096f274601247ebc63fed02fd3bfd56e991637f5ac4e44b2c",
|
||||
"price": "40000"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0xe3ac2efddaa5446436fb25560756d82ebcb865d4605a41997c4d4a6ca32e7273",
|
||||
"price": "5800"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0xf96208141ec3f5bc80cc05d265a5e13a71b1be7e66415ec241ebd100107d6a6d",
|
||||
"price": "10"
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0xfcf20144a14c7b2f51319d938436e34041acbd65e1e29319549ed7923b9fd86e",
|
||||
"price": "1000000"
|
||||
}
|
||||
],
|
||||
"token": {
|
||||
"cap": "115792089237316195423570985008687900000000000000000000000000",
|
||||
"holderCount": "0",
|
||||
"id": "0x122d10d543bc600967b4db0f45f80cb1ddee43eb",
|
||||
"isDatatoken": true,
|
||||
"name": "Brave Lobster Token",
|
||||
"nft": {
|
||||
"address": "0xea615374949a2405c3ee555053eca4d74ec4c2f0",
|
||||
"name": "Ocean Data NFT",
|
||||
"symbol": "OCEAN-NFT"
|
||||
},
|
||||
"orderCount": "0",
|
||||
"orders": [],
|
||||
"symbol": "BRALOB-11"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
</details>
|
||||
|
|
@ -1,252 +0,0 @@
|
|||
---
|
||||
description: 'Discover the World of NFTs: Retrieving a List of Data NFTs'
|
||||
---
|
||||
|
||||
# Get data NFTs
|
||||
|
||||
If you are already familiarized with the concept of NFTs, you're off to a great start. However, if you require a refresher, we recommend visiting the [data NFTs and datatokens page](../contracts/datanft-and-datatoken.md) for a quick overview. 
|
||||
|
||||
Now, let us delve into the realm of utilizing the subgraph to extract a list of data NFTs that have been published using the Ocean contracts. By employing GraphQL queries, we can seamlessly retrieve the desired information from the subgraph. You'll see how simple it is :sunglasses:
|
||||
|
||||
You'll find below an example of a GraphQL query that retrieves the first 10 data NFTs from the subgraph. The GraphQL query is structured to access the "nfts" route, extracting the first 10 elements. For each item retrieved, it retrieves the "id," "name," "symbol," "owner," "address," "assetState," "tx," "block," and "transferable" parameters.
|
||||
|
||||
There are several options available to see this query in action. Below, you will find three:
|
||||
|
||||
1. Run the GraphQL query in the GraphiQL interface.
|
||||
2. Execute the query in Python by following the code snippet.
|
||||
3. Execute the query in JavaScript by clicking on the "Run" button of the Javascript tab.
|
||||
|
||||
_PS: In these examples, the query is executed on the Ocean subgraph deployed on the **mainnet**. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
The javascript below can be used to run the query and retrieve a list of NFTs. If you wish to change the network, then replace the value of `network` variable as needed.
|
||||
|
||||
```runkit nodeVersion="18.x.x"
|
||||
const axios = require('axios')
|
||||
|
||||
const query = `{
|
||||
nfts (skip:0, first: 10, subgraphError:deny){
|
||||
id
|
||||
name
|
||||
symbol
|
||||
owner
|
||||
address
|
||||
assetState
|
||||
tx
|
||||
block
|
||||
transferable
|
||||
}
|
||||
}`
|
||||
|
||||
const network = "mainnet"
|
||||
const config = {
|
||||
method: 'post',
|
||||
url: `https://v4.subgraph.${network}.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph`,
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
data: JSON.stringify({ query: query })
|
||||
}
|
||||
|
||||
const response = await axios(config)
|
||||
for (let nft of response.data.data.nfts) {
|
||||
console.log(' id:' + nft.id + ' name: ' + nft.name + ' address: ' + nft.address)
|
||||
}
|
||||
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Python" %}
|
||||
The Python script below can be used to run the query to fetch a list of data NFTs from the subgraph. If you wish to change the network, replace the value of the variable `base_url` as needed.
|
||||
|
||||
**Create script**
|
||||
|
||||
{% code title="list_dataNFTs.py" %}
|
||||
```python
|
||||
import requests
|
||||
import json
|
||||
|
||||
|
||||
query = """
|
||||
{
|
||||
nfts (skip:0, first: 10, subgraphError:deny){
|
||||
id
|
||||
name
|
||||
symbol
|
||||
owner
|
||||
address
|
||||
assetState
|
||||
tx
|
||||
block
|
||||
transferable
|
||||
}
|
||||
}"""
|
||||
|
||||
|
||||
base_url = "https://v4.subgraph.mainnet.oceanprotocol.com"
|
||||
route = "/subgraphs/name/oceanprotocol/ocean-subgraph"
|
||||
|
||||
url = base_url + route
|
||||
|
||||
headers = {"Content-Type": "application/json"}
|
||||
payload = json.dumps({"query": query})
|
||||
response = requests.request("POST", url, headers=headers, data=payload)
|
||||
result = json.loads(response.text)
|
||||
|
||||
print(json.dumps(result, indent=4, sort_keys=True))
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
**Execute script**
|
||||
|
||||
```bash
|
||||
python list_dataNFTs.py
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Query" %}
|
||||
Copy the query to fetch a list of data NFTs in the Ocean Subgraph [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql).
|
||||
|
||||
```graphql
|
||||
{
|
||||
nfts (skip:0, first: 10, subgraphError:deny){
|
||||
id
|
||||
name
|
||||
symbol
|
||||
owner
|
||||
address
|
||||
assetState
|
||||
tx
|
||||
block
|
||||
transferable
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Sample response</summary>
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"nfts": [
|
||||
{
|
||||
"address": "0x1c161d721e6d99f58d47f709cdc77025056c544c",
|
||||
"assetState": 0,
|
||||
"block": 15185270,
|
||||
"id": "0x1c161d721e6d99f58d47f709cdc77025056c544c",
|
||||
"name": "Ocean Data NFT",
|
||||
"owner": "0xd30dd83132f2227f114db8b90f565bca2832afbd",
|
||||
"symbol": "OCEAN-NFT",
|
||||
"transferable": true,
|
||||
"tx": "0x327a9da0d2e9df945fd2f8e10b1caa77acf98e803c5a2f588597172a0bcbb93a"
|
||||
},
|
||||
{
|
||||
"address": "0x1e06501660623aa973474e3c59efb8ba542cb083",
|
||||
"assetState": 0,
|
||||
"block": 15185119,
|
||||
"id": "0x1e06501660623aa973474e3c59efb8ba542cb083",
|
||||
"name": "Ocean Data NFT",
|
||||
"owner": "0xd30dd83132f2227f114db8b90f565bca2832afbd",
|
||||
"symbol": "OCEAN-NFT",
|
||||
"transferable": true,
|
||||
"tx": "0xd351ccee22b505d811c29fa524db920815936672b20b8f3a09485e389902fd27"
|
||||
},
|
||||
{
|
||||
"address": "0x2eaa55236f799c6ebec72e77a1a6296ea2e704b1",
|
||||
"assetState": 0,
|
||||
"block": 15185009,
|
||||
"id": "0x2eaa55236f799c6ebec72e77a1a6296ea2e704b1",
|
||||
"name": "Ocean Data NFT",
|
||||
"owner": "0xd30dd83132f2227f114db8b90f565bca2832afbd",
|
||||
"symbol": "OCEAN-NFT",
|
||||
"transferable": true,
|
||||
"tx": "0xf6d55306ab4dc339dc1655a2d119af468a79a70fa62ea11de78879da61e89e7b"
|
||||
},
|
||||
{
|
||||
"address": "0x2fbe924f6c92825929dc7785fe05d15e35f2612b",
|
||||
"assetState": 0,
|
||||
"block": 15185235,
|
||||
"id": "0x2fbe924f6c92825929dc7785fe05d15e35f2612b",
|
||||
"name": "Ocean Data NFT",
|
||||
"owner": "0xd30dd83132f2227f114db8b90f565bca2832afbd",
|
||||
"symbol": "OCEAN-NFT",
|
||||
"transferable": true,
|
||||
"tx": "0xa9ff9d461b4b7344ea181de32fa6412c7ea8e21f485ab4d8a7b9cfcdb68d9d51"
|
||||
},
|
||||
{
|
||||
"address": "0x4c04433bb1760a66be7713884bb6370e9c567cef",
|
||||
"assetState": 0,
|
||||
"block": 15185169,
|
||||
"id": "0x4c04433bb1760a66be7713884bb6370e9c567cef",
|
||||
"name": "Ocean Data NFT",
|
||||
"owner": "0xd30dd83132f2227f114db8b90f565bca2832afbd",
|
||||
"symbol": "OCEAN-NFT",
|
||||
"transferable": true,
|
||||
"tx": "0x54c5463e8988b5fa4e4cfe71ee391505801931abe9e94bf1588dd538ec3aa4c9"
|
||||
},
|
||||
{
|
||||
"address": "0x619c500dcb0251b31cd480030db2dcc19866c0c3",
|
||||
"assetState": 0,
|
||||
"block": 15236619,
|
||||
"id": "0x619c500dcb0251b31cd480030db2dcc19866c0c3",
|
||||
"name": "abc",
|
||||
"owner": "0x12fe650c86cd4346933ef1bcab21a1979d4c6786",
|
||||
"symbol": "GOAL-9956",
|
||||
"transferable": true,
|
||||
"tx": "0x6178b03589cda98573ff52a1afbcc07b14a2fddacc0132595949e9d8a0ed1b32"
|
||||
},
|
||||
{
|
||||
"address": "0x6d45a5b38a122a6dbc042601236d6ecc5c8e343e",
|
||||
"assetState": 0,
|
||||
"block": 15109853,
|
||||
"id": "0x6d45a5b38a122a6dbc042601236d6ecc5c8e343e",
|
||||
"name": "Ocean Data NFT",
|
||||
"owner": "0xbbd33afa85539fa65cc08a2e61a001876d2f13fe",
|
||||
"symbol": "OCEAN-NFT",
|
||||
"transferable": true,
|
||||
"tx": "0x27aa77a0bf3f7878910dc7bfe2116d9271138c222b3d898381a5c72eefefe624"
|
||||
},
|
||||
{
|
||||
"address": "0x7400078c5d4fd7704afca45a928d9fc97cbea744",
|
||||
"assetState": 0,
|
||||
"block": 15185056,
|
||||
"id": "0x7400078c5d4fd7704afca45a928d9fc97cbea744",
|
||||
"name": "Ocean Data NFT",
|
||||
"owner": "0xd30dd83132f2227f114db8b90f565bca2832afbd",
|
||||
"symbol": "OCEAN-NFT",
|
||||
"transferable": true,
|
||||
"tx": "0x2025374cd347e25e2651feec2f2faa2feb26664698eaea42b5dad1a31eda57f8"
|
||||
},
|
||||
{
|
||||
"address": "0x81decdb59dce5b4323e683a76f8fa8dd0eabc560",
|
||||
"assetState": 0,
|
||||
"block": 15185003,
|
||||
"id": "0x81decdb59dce5b4323e683a76f8fa8dd0eabc560",
|
||||
"name": "Ocean Data NFT",
|
||||
"owner": "0xd30dd83132f2227f114db8b90f565bca2832afbd",
|
||||
"symbol": "OCEAN-NFT",
|
||||
"transferable": true,
|
||||
"tx": "0x6ad6ec2ce86bb70e077590a64c886d72975374bd2e993f143d9da8edcaace82b"
|
||||
},
|
||||
{
|
||||
"address": "0x8684119ecf77c5be41f01760ad466725ffd9b960",
|
||||
"assetState": 0,
|
||||
"block": 14933034,
|
||||
"id": "0x8684119ecf77c5be41f01760ad466725ffd9b960",
|
||||
"name": "Ocean Data NFT",
|
||||
"owner": "0x87b5606fba13529e1812319d25c6c2cd5c3f3cbc",
|
||||
"symbol": "OCEAN-NFT",
|
||||
"transferable": true,
|
||||
"tx": "0x55ba746cd8e8fb4c739b8544a9034848082b627500b854cb8db0802dd7beb172"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
</details>
|
||||
|
|
@ -1,209 +0,0 @@
|
|||
---
|
||||
description: 'Discover the World of datatokens: Retrieving a List of datatokens'
|
||||
---
|
||||
|
||||
# Get datatokens
|
||||
|
||||
With your newfound knowledge of fetching data NFTs and retrieving the associated information, fetching a list of datatokens will be a breeze :ocean:. Building upon your understanding, let's now delve into the process of retrieving a list of datatokens. By applying similar techniques and leveraging the power of GraphQL queries, you'll be able to effortlessly navigate the landscape of datatokens and access the wealth of information they hold. So, let's dive right in and unlock the potential of exploring datatokens with ease and efficiency.
|
||||
|
||||
|
||||
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the **mainnet**. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
The javascript below can be used to run the query. If you wish to change the network, replace the variable's value `network` as needed. 
|
||||
|
||||
```runkit nodeVersion="18.x.x"
|
||||
var axios = require('axios');
|
||||
|
||||
const query = `{
|
||||
tokens(skip:0, first: 2, subgraphError: deny){
|
||||
id
|
||||
symbol
|
||||
nft {
|
||||
name
|
||||
symbol
|
||||
address
|
||||
}
|
||||
name
|
||||
symbol
|
||||
cap
|
||||
isDatatoken
|
||||
holderCount
|
||||
orderCount
|
||||
orders(skip:0,first:1){
|
||||
amount
|
||||
serviceIndex
|
||||
payer {
|
||||
id
|
||||
}
|
||||
consumer{
|
||||
id
|
||||
}
|
||||
estimatedUSDValue
|
||||
lastPriceToken
|
||||
lastPriceValue
|
||||
}
|
||||
}
|
||||
}`
|
||||
|
||||
const network = "mainnet"
|
||||
var config = {
|
||||
method: 'post',
|
||||
url: `https://v4.subgraph.${network}.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph`,
|
||||
headers: { "Content-Type": "application/json" },
|
||||
data: JSON.stringify({ "query": query })
|
||||
};
|
||||
|
||||
axios(config)
|
||||
.then(function (response) {
|
||||
let result = JSON.stringify(response.data)
|
||||
console.log(result);
|
||||
})
|
||||
.catch(function (error) {
|
||||
console.log(error);
|
||||
});
|
||||
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Python" %}
|
||||
The Python script below can be used to run the query and fetch a list of datatokens. If you wish to change the network, then replace the value of the variable `base_url` as needed.
|
||||
|
||||
**Create script**
|
||||
|
||||
{% code title="list_all_tokens.py" %}
|
||||
```python
|
||||
import requests
|
||||
import json
|
||||
|
||||
query = """
|
||||
{
|
||||
tokens(skip:0, first:2, subgraphError:deny) {
|
||||
id
|
||||
symbol
|
||||
nft {
|
||||
name
|
||||
symbol
|
||||
address
|
||||
}
|
||||
name
|
||||
symbol
|
||||
cap
|
||||
isDatatoken
|
||||
holderCount
|
||||
orderCount
|
||||
orders(skip:0, first:1) {
|
||||
amount
|
||||
serviceIndex
|
||||
payer {
|
||||
id
|
||||
}
|
||||
consumer {
|
||||
id
|
||||
}
|
||||
estimatedUSDValue
|
||||
lastPriceToken
|
||||
lastPriceValue
|
||||
}
|
||||
}
|
||||
}"""
|
||||
|
||||
base_url = "https://v4.subgraph.mainnet.oceanprotocol.com"
|
||||
route = "/subgraphs/name/oceanprotocol/ocean-subgraph"
|
||||
|
||||
url = base_url + route
|
||||
|
||||
headers = {"Content-Type": "application/json"}
|
||||
payload = json.dumps({"query": query})
|
||||
response = requests.request("POST", url, headers=headers, data=payload)
|
||||
result = json.loads(response.text)
|
||||
|
||||
print(json.dumps(result, indent=4, sort_keys=True))
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
**Execute script**
|
||||
|
||||
```bash
|
||||
python list_all_tokens.py
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Query" %}
|
||||
Copy the query to fetch a list of datatokens in the Ocean Subgraph [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql). 
|
||||
|
||||
```graphql
|
||||
{
|
||||
tokens(skip:0, first: 2, subgraphError: deny){
|
||||
id
|
||||
symbol
|
||||
nft {
|
||||
name
|
||||
symbol
|
||||
address
|
||||
}
|
||||
name
|
||||
symbol
|
||||
cap
|
||||
isDatatoken
|
||||
holderCount
|
||||
orderCount
|
||||
orders(skip:0,first:1){
|
||||
amount
|
||||
serviceIndex
|
||||
payer {
|
||||
id
|
||||
}
|
||||
consumer{
|
||||
id
|
||||
}
|
||||
estimatedUSDValue
|
||||
lastPriceToken
|
||||
lastPriceValue
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Sample Response</summary>
|
||||
|
||||
{% code overflow="wrap" %}
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"tokens": [
|
||||
{
|
||||
"cap": null,
|
||||
"holderCount": "0",
|
||||
"id": "0x0000000000000000000000000000000000000000",
|
||||
"isDatatoken": false,
|
||||
"name": null,
|
||||
"nft": null,
|
||||
"orderCount": "0",
|
||||
"orders": [],
|
||||
"symbol": null
|
||||
},
|
||||
{
|
||||
"cap": null,
|
||||
"holderCount": "0",
|
||||
"id": "0x0642026e7f0b6ccac5925b4e7fa61384250e1701",
|
||||
"isDatatoken": false,
|
||||
"name": "H2O",
|
||||
"nft": null,
|
||||
"orderCount": "0",
|
||||
"orders": [],
|
||||
"symbol": "H2O"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
</details>
|
||||
|
|
@ -1,244 +0,0 @@
|
|||
---
|
||||
description: 'Discover the World of NFTs: Retrieving a List of Fixed-rate exchanges'
|
||||
---
|
||||
|
||||
# Get fixed-rate exchanges
|
||||
|
||||
Having gained knowledge about fetching lists of data NFTs and datatokens and extracting specific information about each, let's now explore the process of retrieving the information of fixed-rate exchanges. A fixed-rate exchange refers to a mechanism where data assets can be traded at a predetermined rate or price. These exchanges offer stability and predictability in data transactions, enabling users to securely and reliably exchange data assets based on fixed rates. If you need a refresher on fixed-rate exchanges, visit the [asset pricing](../contracts/pricing-schemas.md#fixed-pricing) page.
|
||||
|
||||
|
||||
|
||||
_PS: In this example, the query is executed on the Ocean subgraph deployed on the **mainnet**. If you want to change the network, please refer to_ [_this table_](broken-reference)_._
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Javascript" %}
|
||||
The javascript below can be used to run the query and fetch a list of fixed-rate exchanges. If you wish to change the network, replace the variable's value `network` as needed. 
|
||||
|
||||
```runkit nodeVersion="18.x.x"
|
||||
var axios = require('axios');
|
||||
|
||||
const query = `{
|
||||
fixedRateExchanges(skip:0, first:2, subgraphError:deny){
|
||||
id
|
||||
contract
|
||||
exchangeId
|
||||
owner{id}
|
||||
datatoken{
|
||||
id
|
||||
name
|
||||
symbol
|
||||
}
|
||||
price
|
||||
datatokenBalance
|
||||
active
|
||||
totalSwapValue
|
||||
swaps(skip:0, first:1){
|
||||
tx
|
||||
by {
|
||||
id
|
||||
}
|
||||
baseTokenAmount
|
||||
dataTokenAmount
|
||||
createdTimestamp
|
||||
}
|
||||
updates(skip:0, first:1){
|
||||
oldPrice
|
||||
newPrice
|
||||
newActive
|
||||
createdTimestamp
|
||||
tx
|
||||
}
|
||||
}
|
||||
}`
|
||||
|
||||
const network = "mainnet"
|
||||
var config = {
|
||||
method: 'post',
|
||||
url: `https://v4.subgraph.${network}.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph`,
|
||||
headers: { "Content-Type": "application/json" },
|
||||
data: JSON.stringify({ "query": query })
|
||||
};
|
||||
|
||||
axios(config)
|
||||
.then(function (response) {
|
||||
let result = JSON.stringify(response.data)
|
||||
console.log(result)
|
||||
})
|
||||
.catch(function (error) {
|
||||
console.log(error);
|
||||
});
|
||||
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Python" %}
|
||||
The Python script below can be used to run the query and retrieve a list of fixed-rate exchanges. If you wish to change the network, then replace the value of the variable `base_url` as needed.
|
||||
|
||||
**Create script**
|
||||
|
||||
{% code title="list_fixed_rate_exchanges.py" %}
|
||||
```python
|
||||
import requests
|
||||
import json
|
||||
|
||||
|
||||
query = """
|
||||
{
|
||||
fixedRateExchanges(skip:0, first:2, subgraphError:deny){
|
||||
id
|
||||
contract
|
||||
exchangeId
|
||||
owner{id}
|
||||
datatoken{
|
||||
id
|
||||
name
|
||||
symbol
|
||||
}
|
||||
price
|
||||
datatokenBalance
|
||||
active
|
||||
totalSwapValue
|
||||
swaps(skip:0, first:1){
|
||||
tx
|
||||
by {
|
||||
id
|
||||
}
|
||||
baseTokenAmount
|
||||
dataTokenAmount
|
||||
createdTimestamp
|
||||
}
|
||||
updates(skip:0, first:1){
|
||||
oldPrice
|
||||
newPrice
|
||||
newActive
|
||||
createdTimestamp
|
||||
tx
|
||||
}
|
||||
}
|
||||
}"""
|
||||
|
||||
|
||||
base_url = "https://v4.subgraph.mainnet.oceanprotocol.com"
|
||||
route = "/subgraphs/name/oceanprotocol/ocean-subgraph"
|
||||
|
||||
url = base_url + route
|
||||
|
||||
headers = {"Content-Type": "application/json"}
|
||||
payload = json.dumps({"query": query})
|
||||
response = requests.request("POST", url, headers=headers, data=payload)
|
||||
result = json.loads(response.text)
|
||||
|
||||
print(json.dumps(result, indent=4, sort_keys=True))
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
**Execute script**
|
||||
|
||||
```
|
||||
python list_fixed_rate_exchanges.py
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Query" %}
|
||||
Copy the query to fetch a list of fixed-rate exchanges in the Ocean Subgraph [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql). 
|
||||
|
||||
```
|
||||
{
|
||||
fixedRateExchanges(skip:0, first:2, subgraphError:deny){
|
||||
id
|
||||
contract
|
||||
exchangeId
|
||||
owner{id}
|
||||
datatoken{
|
||||
id
|
||||
name
|
||||
symbol
|
||||
}
|
||||
price
|
||||
datatokenBalance
|
||||
active
|
||||
totalSwapValue
|
||||
swaps(skip:0, first:1){
|
||||
tx
|
||||
by {
|
||||
id
|
||||
}
|
||||
baseTokenAmount
|
||||
dataTokenAmount
|
||||
createdTimestamp
|
||||
}
|
||||
updates(skip:0, first:1){
|
||||
oldPrice
|
||||
newPrice
|
||||
newActive
|
||||
createdTimestamp
|
||||
tx
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Sample response</summary>
|
||||
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"fixedRateExchanges": [
|
||||
{
|
||||
"active": true,
|
||||
"contract": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02",
|
||||
"datatoken": {
|
||||
"id": "0x9b39a17cc72c8be4813d890172eff746470994ac",
|
||||
"name": "Delightful Pelican Token",
|
||||
"symbol": "DELPEL-79"
|
||||
},
|
||||
"datatokenBalance": "0",
|
||||
"exchangeId": "0x06284c39b48afe5f01a04d56f1aae45dbb29793b190ee11e93a4a77215383d44",
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x06284c39b48afe5f01a04d56f1aae45dbb29793b190ee11e93a4a77215383d44",
|
||||
"owner": {
|
||||
"id": "0x03ef3f422d429bcbd4ee5f77da2917a699f237ed"
|
||||
},
|
||||
"price": "33",
|
||||
"swaps": [
|
||||
{
|
||||
"baseTokenAmount": "33.033",
|
||||
"by": {
|
||||
"id": "0x9b39a17cc72c8be4813d890172eff746470994ac"
|
||||
},
|
||||
"createdTimestamp": 1656563684,
|
||||
"dataTokenAmount": "1",
|
||||
"tx": "0x0b55482f69169c103563062e109f9d71afa01d18f201c425b24b1c74d3c282a3"
|
||||
}
|
||||
],
|
||||
"totalSwapValue": "0",
|
||||
"updates": []
|
||||
},
|
||||
{
|
||||
"active": true,
|
||||
"contract": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02",
|
||||
"datatoken": {
|
||||
"id": "0x2cf074e36a802241f2f8ddb35f4a4557b8f1179b",
|
||||
"name": "Arcadian Eel Token",
|
||||
"symbol": "ARCEEL-17"
|
||||
},
|
||||
"datatokenBalance": "0",
|
||||
"exchangeId": "0x2719862ebc4ed253f09088c878e00ef8ee2a792e1c5c765fac35dc18d7ef4deb",
|
||||
"id": "0xfa48673a7c36a2a768f89ac1ee8c355d5c367b02-0x2719862ebc4ed253f09088c878e00ef8ee2a792e1c5c765fac35dc18d7ef4deb",
|
||||
"owner": {
|
||||
"id": "0x87b5606fba13529e1812319d25c6c2cd5c3f3cbc"
|
||||
},
|
||||
"price": "35",
|
||||
"swaps": [],
|
||||
"totalSwapValue": "0",
|
||||
"updates": []
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
|
@ -30,4 +30,4 @@ Ocean tokens (**OCEAN**) are the native cryptocurrency of the Ocean Protocol eco
|
|||
|
||||
1. **Data Ownership**: Ocean tokens empower data owners by providing them with control over their data assets. Through the use of smart contracts, data owners can define access permissions, usage rights, and pricing terms for their data. By holding and staking Ocean tokens, data owners can exercise even greater control over their data assets.
|
||||
2. **Data Monetization and Consumption**: Ocean tokens facilitate seamless and secure transactions between data providers and consumers, fostering a thriving new data economy. Data owners can set a price in Ocean tokens for consumers to access and utilize their data. This creates opportunities for unlocking value from siloed or otherwise unused data.
|
||||
3. **Stake for veOcean and Curate Datasets**: Through the Data Farming initiative, you are incentivized to lock Ocean tokens for [veOCEAN](../rewards/veocean.md). By staking your OCEAN, you not only support the growth and sustainability of the ecosystem but also earn a share of data asset sales 💰. The Data Farming initiative offers participants a unique opportunity to earn [rewards](../rewards/) while making a meaningful impact in the data marketplace.
|
||||
3. **Stake for veOcean and Curate Datasets**: Through the Data Farming initiative, you are incentivized to lock Ocean tokens for [veOCEAN](../rewards/veocean.md). By staking your OCEAN, you not only support the growth and sustainability of the ecosystem but also earn a share of data asset sales 💰. The Data Farming initiative offers participants a unique opportunity to earn [rewards](../rewards/README.md) while making a meaningful impact in the data marketplace.
|
||||
|
|
|
|||
|
|
@ -48,7 +48,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](../developers/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/README.md) 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>
|
||||
|
|
@ -57,7 +57,7 @@ You can choose from two options:
|
|||
|
||||
<summary><mark style="color:blue;"><strong>Tokengate Your dApp or Content</strong></mark><br><br>Are you interested in token gating your dApp or content using an Ocean data NFT? We offer you all the code and support that you need to make this happen.</summary>
|
||||
|
||||
Feel free to fork the [Ocean Token Gate template](https://github.com/oceanprotocol/token-gating-template) code and customize it to start building your dApp from scratch. If you already have an existing dApp of yours, then you can also modify it simply to use an Ocean data NFT. The [Ocean Token Gate repo](https://github.com/oceanprotocol/token-gating-template) will be helpful to inform your coding to do this, of course. But we also explain the [smart contract mechanics](../developers/contracts/) of Data NFTs and Datatokens[ in our docs](../developers/contracts/) for you to understand the code better. Remember, we're always here to help guide you with any coding questions on [Discord](https://discord.gg/TnXjkR5).
|
||||
Feel free to fork the [Ocean Token Gate template](https://github.com/oceanprotocol/token-gating-template) code and customize it to start building your dApp from scratch. If you already have an existing dApp of yours, then you can also modify it simply to use an Ocean data NFT. The [Ocean Token Gate repo](https://github.com/oceanprotocol/token-gating-template) will be helpful to inform your coding to do this, of course. But we also explain the [smart contract mechanics](../developers/contracts/README.md) of Data NFTs and Datatokens[ in our docs](../developers/contracts/README.md) for you to understand the code better. Remember, we're always here to help guide you with any coding questions on [Discord](https://discord.gg/TnXjkR5).
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -73,7 +73,7 @@ The following guides will help you get started with buying and selling data:
|
|||
|
||||
* [Publish an NFT](../user-guides/publish-data-nfts.md)
|
||||
* [Download an NFT](../user-guides/buy-data-nfts.md)
|
||||
* [Host Assets](../user-guides/asset-hosting/)
|
||||
* [Host Assets](../user-guides/asset-hosting/README.md)
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -81,7 +81,7 @@ The following guides will help you get started with buying and selling data:
|
|||
|
||||
<summary><mark style="color:blue;">Manage datatokens and data NFTs for use in DeFi</mark><br><br>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.</summary>
|
||||
|
||||
Use Ocean [JavaScript](../developers/ocean.js) or [Python](../developers/ocean.py) drivers to manage data NFTs and datatokens:
|
||||
Use Ocean [JavaScript](../developers/ocean.js/README.md) or [Python](../developers/ocean.py/README.md) drivers to manage data NFTs and datatokens:
|
||||
|
||||
Ocean-based apps make data assets 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.
|
||||
|
||||
|
|
@ -101,7 +101,7 @@ Since datatokens are ERC20, and live on Ethereum mainnet, there's a whole ecosys
|
|||
|
||||
<summary><a href="https://medium.com/p/477b3decad51#7922"><mark style="color:orange;">Run Your Own Provider</mark></a><br><br>You have the option to generate revenue by running your own <a href="../developers/provider/">provider</a>. It has come to our attention that many of you have not pursued this opportunity, primarily due to the lack of compelling incentives.</summary>
|
||||
|
||||
If you're not familiar with it, the Ocean [Provider](../developers/provider/) serves as the proxy service responsible for encrypting/decrypting data and streaming it to the consumer. It also verifies user access privileges for specific data assets or services. It plays a vital role in the Ocean architecture.
|
||||
If you're not familiar with it, the Ocean [Provider](../developers/provider/README.md) serves as the proxy service responsible for encrypting/decrypting data and streaming it to the consumer. It also verifies user access privileges for specific data assets or services. It plays a vital role in the Ocean architecture.
|
||||
|
||||
Fees are now paid to the individual or organization running the provider when a user downloads a data asset. The download fees are set based on the cost per MB, and there is also a provider fee for compute jobs, which is priced per minute.
|
||||
|
||||
|
|
@ -115,7 +115,7 @@ Furthermore, provider fees are not restricted to data consumption; they can also
|
|||
|
||||
<summary><mark style="color:purple;">Earn Rewards</mark><br><br>The <a href="../rewards/df-max-out-yield.md">Data Farming</a> initiative is a key feature of Ocean Protocol that empowers participants to earn <a href="../rewards/">rewards</a> while contributing to a decentralized data economy. By staking Ocean tokens and actively participating in data markets, users play a vital role in enhancing the availability and accessibility of valuable data assets</summary>
|
||||
|
||||
Through the Data Farming initiative, you are incentivized to lock Ocean tokens for [veOcean](../rewards/veocean.md). By staking your tokens, you not only support the growth and sustainability of the ecosystem but also earn a share of the generated incentives💰. The Data Farming initiative offers participants a unique opportunity to earn [rewards](../rewards/) while making a meaningful impact in the data marketplace.
|
||||
Through the Data Farming initiative, you are incentivized to lock Ocean tokens for [veOcean](../rewards/veocean.md). By staking your tokens, you not only support the growth and sustainability of the ecosystem but also earn a share of the generated incentives💰. The Data Farming initiative offers participants a unique opportunity to earn [rewards](../rewards/README.md) while making a meaningful impact in the data marketplace.
|
||||
|
||||
Participating in the Data Farming initiative demonstrates a commitment to the principles of **fairness**, **transparency**, and **collaboration** that underpin Ocean Protocol. It allows you to actively engage with the ecosystem, promoting innovation, and driving the evolution of the decentralized data economy.
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ Ocean gives you two different options for pricing your data - [fixed price](../d
|
|||
|
||||
<summary>Is my data secure?</summary>
|
||||
|
||||
Yes. Ocean Protocol understands that some data is too sensitive to be shared — potentially due to GDPR or other reasons. For these types of datasets, we offer a unique service called [compute-to-data](../developers/compute-to-data/). This enables you to monetize the dataset that sits behind a firewall without ever revealing the raw data to the consumer. For example, researchers and data scientists pay to run their algorithms on the data set, and the computation is performed behind a firewall; all the researchers or data scientists receive is the results generated by their algorithm.
|
||||
Yes. Ocean Protocol understands that some data is too sensitive to be shared — potentially due to GDPR or other reasons. For these types of datasets, we offer a unique service called [compute-to-data](../developers/compute-to-data/README.md). This enables you to monetize the dataset that sits behind a firewall without ever revealing the raw data to the consumer. For example, researchers and data scientists pay to run their algorithms on the data set, and the computation is performed behind a firewall; all the researchers or data scientists receive is the results generated by their algorithm.
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -330,7 +330,7 @@ Yes, from the get-go! It doesn’t matter how data is priced, this works for all
|
|||
|
||||
Data assets for DF may published in any network where Ocean’s deployed in production: Eth Mainnet, Polygon, BSC, and more.
|
||||
|
||||
You can find a list of [all supported chains here](https://docs.oceanprotocol.com/discover/networks).
|
||||
You can find a list of [all supported chains here](networks/README.md).
|
||||
|
||||
</details>
|
||||
|
||||
|
|
|
|||
|
|
@ -139,7 +139,7 @@ In exchange for locking tokens, users can earn rewards. The amount of reward dep
|
|||
|
||||
<summary>DF Passive Rewards</summary>
|
||||
|
||||
When a user locks their OCEAN tokens for a finite period of time, they get veOCEAN tokens in return. Based on the quantity of veOCEAN, the user accumulates weekly OCEAN [rewards](../rewards/df-basic.md#passive-rewards). Because rewards are generated without human intervention, these are called "passive" OCEAN rewards. OCEAN rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
When a user locks their OCEAN tokens for a finite period of time, they get veOCEAN tokens in return. Based on the quantity of veOCEAN, the user accumulates weekly OCEAN [rewards](../rewards/df-intro.md#what-are-active-rewards). Because rewards are generated without human intervention, these are called "passive" OCEAN rewards. OCEAN rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
|
||||
</details>
|
||||
|
||||
|
|
@ -147,7 +147,7 @@ When a user locks their OCEAN tokens for a finite period of time, they get veOCE
|
|||
|
||||
<summary>DF Active Rewards</summary>
|
||||
|
||||
When a user allocates veOCEAN tokens 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, they are categorized as "active" [rewards](../rewards/df-basic.md#active-rewards) instead of passive rewards. OCEAN rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
When a user allocates veOCEAN tokens 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, they are categorized as "active" [rewards](../rewards/df-intro.md#what-are-passive-rewards) instead of passive rewards. OCEAN rewards are claimable every Thursday on the [Rewards page](https://df.oceandao.org/rewards).
|
||||
|
||||
</details>
|
||||
|
||||
|
|
|
|||
|
|
@ -9,14 +9,14 @@ Ocean Protocol utilizes a combination of blockchain technology, decentralized ne
|
|||
1. **Asset Registration**: Data providers register their data assets on the Ocean blockchain, providing metadata that describes the asset, its usage terms, and pricing information. This metadata is stored on-chain and can be accessed by potential data consumers.
|
||||
2. **Discovery and Access Control**: Data consumers can discover available data assets through decentralized metadata services like Aquarius. Access control mechanisms, such as smart contracts, verify the consumer's permissions and handle the transfer of data access tokens.
|
||||
3. **Secure Data Exchange**: When a data consumer purchases access to a data asset, the asset's metadata, and access instructions are encrypted by the data provider using the Provider service. The encrypted asset is then securely transferred to the consumer, who can decrypt and utilize it without revealing the asset's URL.
|
||||
4. [**Compute-to-Data**](../developers/compute-to-data/) **(C2D)**: Ocean Protocol supports C2D capabilities, allowing data consumers to perform computations on data assets without direct access to the underlying data. The compute operations are executed in a secure and controlled environment, ensuring data privacy and compliance.
|
||||
4. [**Compute-to-Data**](../developers/compute-to-data/README.md) **(C2D)**: Ocean Protocol supports C2D capabilities, allowing data consumers to perform computations on data assets without direct access to the underlying data. The compute operations are executed in a secure and controlled environment, ensuring data privacy and compliance.
|
||||
5. **Incentives and Governance**: Ocean Protocol incorporates tokeconomics and a governance framework to incentivize participants and ensure the sustainability and evolution of the ecosystem. Participants can earn and stake Ocean tokens (OCEAN) for veOCEANs, curate data, contribute to the network, and participate in governance decisions.
|
||||
|
||||
Ocean Protocol also combines advanced technologies and web components to create a robust and efficient data ecosystem.
|
||||
|
||||
Powerful libraries such as [Ocean.js](../developers/ocean.js/) (JavaScript) and [Ocean.py](../developers/ocean.py/) (Python) facilitate seamless integration and interaction with the protocol, offering a wide range of functionalities. 
|
||||
Powerful libraries such as [Ocean.js](../developers/ocean.js/README.md) (JavaScript) and [Ocean.py](../developers/ocean.py/README.md) (Python) facilitate seamless integration and interaction with the protocol, offering a wide range of functionalities. 
|
||||
|
||||
Ocean Protocol incorporates middleware components that enhance efficiency and streamline interactions. Components such as [Aquarius](../developers/aquarius/) act as a metadata cache, improving search efficiency by caching on-chain data into Elasticsearch while [Provider](../developers/provider/) plays a crucial role in various ecosystem operations, assisting in asset downloading, handling encryption of [Decentralized Data Objects](../developers/ddo-specification.md) (DDOs), and facilitating communication with the operator-service for Compute-to-Data jobs. And finally, the [Subgraph](../developers/subgraph/), an off-chain service leveraging GraphQL, offers efficient access to information related to datatokens, users, and balances. 
|
||||
Ocean Protocol incorporates middleware components that enhance efficiency and streamline interactions. Components such as [Aquarius](../developers/aquarius/README.md) act as a metadata cache, improving search efficiency by caching on-chain data into Elasticsearch while [Provider](../developers/provider/README.md) plays a crucial role in various ecosystem operations, assisting in asset downloading, handling encryption of [Decentralized Data Objects](../developers/ddo-specification.md) (DDOs), and facilitating communication with the operator-service for Compute-to-Data jobs. And finally, the [Subgraph](../developers/subgraph/README.md), an off-chain service leveraging GraphQL, offers efficient access to information related to datatokens, users, and balances. 
|
||||
|
||||
These libraries and middleware components contribute to efficient data discovery and secure interactions within the Ocean Protocol ecosystem.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ coverY: 0
|
|||
|
||||
There are many ways in which the components can be deployed, from simple configurations used for development and testing to complex configurations, used for production systems. 
|
||||
|
||||
All the Ocean Protocol components ([Provider](../developers/provider/), [Aquarius](../developers/aquarius/), [Subgraph](../developers/subgraph/)) are designed to run in Docker containers, on a Linux operating system. For simple configurations, we rely on Docker Engine and Docker Compose products to deploy and run our components, while for complex configurations we use Kubernetes. The guides included in this section will present both deployment options. 
|
||||
All the Ocean Protocol components ([Provider](../developers/provider/README.md), [Aquarius](../developers/aquarius/README.md), [Subgraph](../developers/subgraph/README.md)) are designed to run in Docker containers, on a Linux operating system. For simple configurations, we rely on Docker Engine and Docker Compose products to deploy and run our components, while for complex configurations we use Kubernetes. The guides included in this section will present both deployment options. 
|
||||
|
||||
Please note that deploying the Ocean components requires a good understanding of:
|
||||
|
||||
|
|
|
|||
|
|
@ -310,5 +310,5 @@ You can publish an algorithm asset with the metadata containing the registry URL
|
|||
### Further references
|
||||
|
||||
* [Setup Compute-to-Data environment](compute-to-data-minikube.md)
|
||||
* [Writing algorithms](compute-to-data-algorithms.md)
|
||||
* [Writing algorithms](../developers//compute-to-data/compute-to-data-algorithms.md)
|
||||
* [C2D example](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/c2d-flow.md)
|
||||
|
|
|
|||
|
|
@ -16,12 +16,12 @@ Ocean Subgraph is deployed on top of [graph-node](https://github.com/graphprotoc
|
|||
|
||||
### Steps
|
||||
|
||||
1. [Create the /etc/docker/compose/graph-node/docker-compose.yml file](deploying-ocean-subgraph.md#1.-create-the-etc-docker-compose-graph-node-docker-compose.yml-file)
|
||||
2. [Create the /etc/systemd/system/docker-compose@graph-node.service file](deploying-ocean-subgraph.md#2.-create-the-etc-systemd-system-docker-compose-graph-node.service-file)
|
||||
1. [Create the /etc/docker/compose/graph-node/docker-compose.yml file](deploying-ocean-subgraph.md#1-create-the-etcdockercomposegraph-nodedocker-composeyml-file)
|
||||
2. [Create the /etc/systemd/system/docker-compose@graph-node.service file](deploying-ocean-subgraph.md#2-create-the-etcsystemdsystemdocker-composegraph-nodeservice-file)
|
||||
3. [Reload the systemd manager configuration](deploying-ocean-subgraph.md#3.-reload-the-systemd-manager-configuration)
|
||||
4. [Start the Ocean Subgraph service](deploying-ocean-subgraph.md#4.-start-the-ocean-subgraph-service)
|
||||
4. [Start the Ocean Subgraph service](deploying-ocean-subgraph.md#4-deploy-ocean-subgraph)
|
||||
5. [Check the service's status](deploying-ocean-subgraph.md#5.-check-the-services-status)
|
||||
6. [Check Ocean Subgraph's service logs](deploying-ocean-subgraph.md#6.-check-ocean-subgraphs-service-logs)
|
||||
6. [Check Ocean Subgraph's service logs](deploying-ocean-subgraph.md#6-check-graph-node-service-logs)
|
||||
|
||||
#### 1. Create the /etc/docker/compose/graph-node/docker-compose.yml file
|
||||
|
||||
|
|
@ -440,7 +440,7 @@ After you deployed graph-node, either using Kubernetes or Docker Compose, you ca
|
|||
### Steps
|
||||
|
||||
1. [Install Node.js locally](deploying-ocean-subgraph.md#1.-install-node.js-locally)
|
||||
2. [Download and extract Ocean-subgraph](deploying-ocean-subgraph.md#2.-download-and-extract-ocean-subgraph)
|
||||
2. [Download and extract Ocean-subgraph](#2.-download-and-extract-ocean-subgraph)
|
||||
|
||||
#### 1. Install Node.js locally
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ veOCEAN is a fork of veCRV. This enables participants to become a governance del
|
|||
|
||||
## Data Farming
|
||||
|
||||
|
||||
|
||||
|
||||
[Data Farming 101](df-intro.md) introduces the different reward systems, how they work, and how to access them. By the end of the page, you should be more familiar with how Data Farming works and able to take next steps to curate assets.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ description: Learn the basic moves to start kicking a** Data Farming
|
|||
|
||||
### Get Started
|
||||
|
||||
Our [User Guides](../user-guides/) get you started Data Farming quickly to do the basic operations. Follow these guides to earn your blue belt in Data Farming understanding.
|
||||
Our [User Guides](../user-guides/README.md) get you started Data Farming quickly to do the basic operations. Follow these guides to earn your blue belt in Data Farming understanding.
|
||||
|
||||
{% content-ref url="../user-guides/get-started-df.md" %}
|
||||
[get-started-df.md](../user-guides/get-started-df.md)
|
||||
|
|
|
|||
|
|
@ -56,4 +56,4 @@ You can read more about the implementation [in this blog post](https://blog.ocea
|
|||
|
||||
## [GET STARTED DATA FARMING HERE.](https://df.oceandao.org)
|
||||
|
||||
### Unsure how? Our [guides](../user-guides/) will show you how to do the basics.
|
||||
### Unsure how? Our [guides](../user-guides/README.md) will show you how to do the basics.
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ The Reward Function (RF) governs how active rewards are allocated to Data Farmer
|
|||
1. Distribute OCEAN across each asset **based on rank**: highest-DCV asset gets the most OCEAN, etc.
|
||||
2. For each asset and each veOCEAN holder: If the holder is a publisher, 2x the effective allocation – Baseline rewards = (% allocation in asset) \* (OCEAN for an asset) – Bound rewards to the asset by 125% APY – Bound rewards by asset’s DCV \* 0.1%.
|
||||
|
||||
For mathematicians and coders, you can find this code inside [calcrewards.py](https://github.com/oceanprotocol/df-py/blob/main/df\_py/volume/calcrewards.py) in the Ocean Protocol [df-py repo](https://github.com/oceanprotocol/df-py/)!
|
||||
For mathematicians and coders, you can find this code inside [calcrewards.py](https://github.com/oceanprotocol/df-py/blob/main/df_py/volume/calc_rewards.py) in the Ocean Protocol [df-py repo](https://github.com/oceanprotocol/df-py/)!
|
||||
|
||||
### What are Ranked Rewards?
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ At the top-end, this helps increase the quality and diversification of inventory
|
|||
|
||||
At the bottom-end, this eliminates some potential free-rider issues and smooths out the reward distribution.
|
||||
|
||||
|
||||
|
||||
|
||||
You can read more about the why, what, and how of Ranked Rewards [in this blog post](https://blog.oceanprotocol.com/data-farming-df22-completed-df23-started-reward-function-tuned-ffd4359657ee) and find the full study [in these slides](https://docs.google.com/presentation/d/1HIA2zV8NUPpCELmi2WFwnAbHmFFrcXjNQiCpEqJ2Jdg/).
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ The asset may be of any type — dataset, an algorithm for Compute-to-Data, or a
|
|||
|
||||
To qualify for DF, an asset must also:
|
||||
|
||||
* Have been created by Ocean Smart contracts [deployed](https://github.com/oceanprotocol/contracts/blob/v4main/addresses/address.json) by OPF to [production networks](../discover/networks/)
|
||||
* Have been created by Ocean Smart contracts [deployed](https://github.com/oceanprotocol/contracts/blob/v4main/addresses/address.json) by OPF to [production networks](../discover/networks/README.md)
|
||||
* Can’t be in [purgatory](https://github.com/oceanprotocol/list-purgatory/blob/main/policies/README.md)
|
||||
|
||||
### A Brief History of Data Farming
|
||||
|
|
|
|||
|
|
@ -23,11 +23,11 @@ Buy, mint, and sell NFTs using the Ocean Market following the guides below.
|
|||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="compute-to-data/" %}
|
||||
[compute-to-data](compute-to-data/)
|
||||
[compute-to-data](compute-to-data/README.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="asset-hosting/" %}
|
||||
[asset-hosting](asset-hosting/)
|
||||
[asset-hosting](asset-hosting/README.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="using-ocean-market.md" %}
|
||||
|
|
|
|||
|
|
@ -27,5 +27,5 @@ When you publish your asset as an NFT, then the URL/TX ID/CID required to access
|
|||
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.**
|
||||
|
||||
{% hint style="warning" %}
|
||||
**Please use a proper hosting solution to keep your files.** Systems like `Google Drive` are not specifically designed for this use case. They include various virus checks and rate limiters that prevent the [`Provider`](../../developers/provider/)downloading the asset once it was purchased.
|
||||
**Please use a proper hosting solution to keep your files.** Systems like `Google Drive` are not specifically designed for this use case. They include various virus checks and rate limiters that prevent the [`Provider`](../../developers/provider/README.md)downloading the asset once it was purchased.
|
||||
{% endhint %}
|
||||
|
|
|
|||
|
|
@ -48,7 +48,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).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ Go to the Azure portal: https://portal.azure.com/#home and select `Storage accou
|
|||
|
||||
**Create a new storage account**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Fill in the details**
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ Go to the Azure portal: https://portal.azure.com/#home and select `Storage accou
|
|||
|
||||
**Storage account created**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Step 2 - Create a blob container**
|
||||
|
||||
|
|
@ -38,7 +38,7 @@ Go to the Azure portal: https://portal.azure.com/#home and select `Storage accou
|
|||
|
||||
**Step 3 - Upload a file**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Step 4 - Share the file**
|
||||
|
||||
|
|
@ -48,11 +48,11 @@ Go to the Azure portal: https://portal.azure.com/#home and select `Storage accou
|
|||
|
||||
**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**
|
||||
|
||||
|
|
|
|||
|
|
@ -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/liquidity/remove-liquidity-2 (1) (1) (2) (1) (1).png" alt=""><figcaption><p>Balance Of</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/liquidity/remove-liquidity-2.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>
|
||||
|
|
|
|||
|
|
@ -19,12 +19,12 @@ The Ocean Market is a place for buyers + sellers of top-notch data and algorithm
|
|||
|
||||
* [Publish an NFT](publish-data-nfts.md)
|
||||
* [Download NFT Assets](buy-data-nfts.md)
|
||||
* [Host Your Assets](asset-hosting/)
|
||||
* [Host Your Assets](asset-hosting/README.md)
|
||||
|
||||
#### Getting Basic 💁♀️
|
||||
|
||||
**If you are new to web3** and blockchain technologies then we suggest you first get familiar with some Web3 basics:
|
||||
|
||||
* [Wallet Basics](../discover/wallets/) 👛
|
||||
* [Wallet Basics](../discover/wallets/README.md) 👛
|
||||
* [Set Up MetaMask](../discover/wallets/metamask-setup.md) [Wallet ](../discover/wallets/metamask-setup.md)🦊
|
||||
* [Manage Your OCEAN Tokens](../discover/wallets-and-ocean-tokens.md) 🪙
|
||||
|
|
|
|||
Loading…
Reference in New Issue