diff --git a/SUMMARY.md b/SUMMARY.md index b2c92e07..c8797a7d 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -27,7 +27,7 @@ * [Claim OCEAN Rewards](user-guides/claim-ocean-rewards.md) * [Guide to Ocean Market](user-guides/using-ocean-market.md) * [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-using-etherscan.md) -* [Developers](developers/README.md) +* [👨💻 Developers](developers/README.md) * [Architecture Overview](developers/architecture.md) * [Data NFTs and Datatokens](developers/datanft-and-datatoken.md) * [Roles](developers/roles.md) @@ -42,17 +42,17 @@ * [Customising a Market](developers/build-a-marketplace/customising-your-market.md) * [Deploying a Market](developers/build-a-marketplace/deploying-market.md) * [Ocean Subgraph](developers/ocean-subgraph/README.md) - * [List data NFTs](developers/ocean-subgraph/list-data-nfts.md) - * [List all Tokens](developers/ocean-subgraph/list-datatokens.md) - * [Get Data NFT Information](developers/ocean-subgraph/get-data-nft-information.md) - * [Get Datatoken Information](developers/ocean-subgraph/get-datatoken-information.md) - * [List Fixed Rate Exchanges](developers/ocean-subgraph/list-fixed-rate-exchanges.md) + * [List data NFTs](developers/using-ocean-subgraph/list-data-nfts.md) + * [List all Tokens](developers/using-ocean-subgraph/list-datatokens.md) + * [Get Data NFT Information](developers/using-ocean-subgraph/get-data-nft-information.md) + * [Get Datatoken Information](developers/using-ocean-subgraph/get-datatoken-information.md) + * [List Fixed Rate Exchanges](developers/using-ocean-subgraph/list-fixed-rate-exchanges.md) * [Ocean Libraries](developers/ocean-libraries/README.md) - * [Configuration](developers/ocean-libraries/configuration.md) - * [Creating a data NFT](developers/ocean-libraries/creating-datanft.md) - * [Publish with Fixed Pricing](developers/ocean-libraries/create-datatoken-with-fixed-pricing.md) - * [Mint Datatokens](developers/ocean-libraries/mint-datatoken.md) - * [Update Metadata](developers/ocean-libraries/update-metadata.md) + * [Configuration](developers/using-ocean-libraries/configuration.md) + * [Creating a data NFT](developers/using-ocean-libraries/creating-datanft.md) + * [Publish with Fixed Pricing](developers/using-ocean-libraries/create-datatoken-with-fixed-pricing.md) + * [Mint Datatokens](developers/using-ocean-libraries/mint-datatoken.md) + * [Update Metadata](developers/using-ocean-libraries/update-metadata.md) * [Compute to data](developers/compute-to-data/README.md) * [Architecture](developers/compute-to-data/compute-to-data-architecture.md) * [Datasets & Algorithms](developers/compute-to-data/compute-to-data-datasets-algorithms.md) diff --git a/developers/ocean-libraries/configuration.md b/developers/using-ocean-libraries/configuration.md similarity index 100% rename from developers/ocean-libraries/configuration.md rename to developers/using-ocean-libraries/configuration.md diff --git a/developers/ocean-libraries/create-datatoken-with-fixed-pricing.md b/developers/using-ocean-libraries/create-datatoken-with-fixed-pricing.md similarity index 94% rename from developers/ocean-libraries/create-datatoken-with-fixed-pricing.md rename to developers/using-ocean-libraries/create-datatoken-with-fixed-pricing.md index b7f64804..048d3b5f 100644 --- a/developers/ocean-libraries/create-datatoken-with-fixed-pricing.md +++ b/developers/using-ocean-libraries/create-datatoken-with-fixed-pricing.md @@ -4,14 +4,14 @@ This tutorial guides you through the process of creating your own data NFT and a #### Prerequisites -- [Obtain an API key](configuration.md#obtaining-api-key-for-ethereum-node-provider) -- [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) +* [Obtain an API key](configuration.md#obtaining-api-key-for-ethereum-node-provider) +* [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 data NFT and datatoken with fixed pricing. -Create a new file in the same working directory where configuration file (`config.py`/`config.js`) and `.env` files are present, and copy the code as listed below. +Create a new file in the same working directory where configuration file (`config.py`/`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 @@ -170,11 +170,10 @@ print(f"Created fixed rate exchange with ID {exchange_id.hex()}") ``` {% endcode %} -#### Execute script +**Execute script** ``` python create_datatoken_with_fre.py ``` {% endtab %} {% endtabs %} - diff --git a/developers/ocean-libraries/creating-datanft.md b/developers/using-ocean-libraries/creating-datanft.md similarity index 88% rename from developers/ocean-libraries/creating-datanft.md rename to developers/using-ocean-libraries/creating-datanft.md index 9eee6e76..6aac2d81 100644 --- a/developers/ocean-libraries/creating-datanft.md +++ b/developers/using-ocean-libraries/creating-datanft.md @@ -1,17 +1,17 @@ -# Creating a dataNFT +# 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). #### Prerequisites -- [Obtain an API key](configuration.md#obtaining-api-key-for-ethereum-node-provider) -- [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) +* [Obtain an API key](configuration.md#obtaining-api-key-for-ethereum-node-provider) +* [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 -Create a new file in the same working directory where configuration file (`config.py`/`config.js`) and `.env` files are present, and copy the code as listed below. +Create a new file in the same working directory where configuration file (`config.py`/`config.js`) and `.env` files are present, and copy the code as listed below. {% tabs %} {% tab title="ocean.js" %} diff --git a/developers/ocean-libraries/mint-datatoken.md b/developers/using-ocean-libraries/mint-datatoken.md similarity index 88% rename from developers/ocean-libraries/mint-datatoken.md rename to developers/using-ocean-libraries/mint-datatoken.md index f91d41af..0f0c17d0 100644 --- a/developers/ocean-libraries/mint-datatoken.md +++ b/developers/using-ocean-libraries/mint-datatoken.md @@ -1,17 +1,17 @@ # Mint Datatokens -This tutorial guides you through the process of minting datatokens and sending them to a receiver address. The tutorial assumes that you already have the address of the datatoken contract which is owned by you. +This tutorial guides you through the process of minting datatokens and sending them to a receiver address. The tutorial assumes that you already have the address of the datatoken contract which is owned by you. #### Prerequisites -- [Obtain an API key](configuration.md#obtaining-api-key-for-ethereum-node-provider) -- [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) +* [Obtain an API key](configuration.md#obtaining-api-key-for-ethereum-node-provider) +* [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 -Create a new file in the same working directory where configuration file (`config.py`/`config.js`) and `.env` files are present, and copy the code as listed below. +Create a new file in the same working directory where configuration file (`config.py`/`config.js`) and `.env` files are present, and copy the code as listed below. {% tabs %} {% tab title="ocean.js" %} @@ -75,7 +75,7 @@ mintDatatoken(datatokenAddress, receiverAddress) ``` {% endcode %} -#### Execute script +**Execute script** ``` node mint_datatoken.js @@ -108,7 +108,7 @@ nt_d ``` {% endcode %} -#### Execute script +**Execute script** ``` python mint_datatoken.py diff --git a/developers/ocean-libraries/update-metadata.md b/developers/using-ocean-libraries/update-metadata.md similarity index 90% rename from developers/ocean-libraries/update-metadata.md rename to developers/using-ocean-libraries/update-metadata.md index d78e3758..ddd86ed7 100644 --- a/developers/ocean-libraries/update-metadata.md +++ b/developers/using-ocean-libraries/update-metadata.md @@ -4,10 +4,10 @@ This tutorial will guide you to update an existing asset published on-chain usin #### Prerequisites -- [Obtain an API key](configuration.md#obtaining-api-key-for-ethereum-node-provider) -- [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) +* [Obtain an API key](configuration.md#obtaining-api-key-for-ethereum-node-provider) +* [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 @@ -15,7 +15,7 @@ The variable **AQUARIUS\_URL** and **PROVIDER\_URL** should be set correctly in #### Create a script to update the metadata -Create a new file in the same working directory where configuration file (`config.py`/`config.js`) and `.env` files are present, and copy the code as listed below. +Create a new file in the same working directory where configuration file (`config.py`/`config.js`) and `.env` files are present, and copy the code as listed below. {% tabs %} {% tab title="ocean.js" %} diff --git a/developers/ocean-subgraph/get-data-nft-information.md b/developers/using-ocean-subgraph/get-data-nft-information.md similarity index 96% rename from developers/ocean-subgraph/get-data-nft-information.md rename to developers/using-ocean-subgraph/get-data-nft-information.md index 0a95b7f2..af2137d8 100644 --- a/developers/ocean-subgraph/get-data-nft-information.md +++ b/developers/using-ocean-subgraph/get-data-nft-information.md @@ -3,7 +3,7 @@ The result of following GraphQL query returns the information about a particular datatoken. Here, `0x1c161d721e6d99f58d47f709cdc77025056c544c` is the address of the dataNFT. {% hint style="info" %} -Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](./#ocean-subgraph-graphiql). +Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](../ocean-subgraph/#ocean-subgraph-graphiql). {% endhint %} #### Query @@ -40,7 +40,7 @@ Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprot {% tab title="Python" %} The python script below can be used to run the the query. If you wish to change the network, then replace the value of variable `base_url` as needed. Change the value of the variable dataNFT\_address with the address of the datatoken of your choice. -#### Create script +**Create script** {% code title="dataNFT_information.py" %} ```python @@ -91,13 +91,14 @@ print(json.dumps(result, indent=4, sort_keys=True)) **Execute script** -
python dataNFT_information.py
+python dataNFT_information.py
+
{% endtab %}
{% tab title="Javascript" %}
The javascript below can be used to run the the query. If you wish to change the network, then replace the value of variable `baseUrl` as needed. Change the value of the variable `datanftAddress` with the address of the datatoken of your choice.
-#### Create script
+**Create script**
{% code title="dataNFTInfo.js" %}
```javascript
@@ -152,7 +153,7 @@ axios(config)
```
{% endcode %}
-#### Execute script
+**Execute script**
```bash
node dataNFTInfo.js
diff --git a/developers/ocean-subgraph/get-datatoken-information.md b/developers/using-ocean-subgraph/get-datatoken-information.md
similarity index 97%
rename from developers/ocean-subgraph/get-datatoken-information.md
rename to developers/using-ocean-subgraph/get-datatoken-information.md
index 3fb61ec1..a9b3e1c6 100644
--- a/developers/ocean-subgraph/get-datatoken-information.md
+++ b/developers/using-ocean-subgraph/get-datatoken-information.md
@@ -1,9 +1,9 @@
-# Get datatoken information
+# Get Datatoken Information
The result of following GraphQL query returns the information about a particular datatoken. Here, `0x122d10d543bc600967b4db0f45f80cb1ddee43eb` is the address of the datatoken.
{% hint style="info" %}
-Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](./#ocean-subgraph-graphiql).
+Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](../ocean-subgraph/#ocean-subgraph-graphiql).
{% endhint %}
#### Query
@@ -115,7 +115,8 @@ print(json.dumps(result, indent=4, sort_keys=True))
**Execute script**
-python datatoken_information.py
+python datatoken_information.py
+
{% endtab %}
{% tab title="Javascript" %}
diff --git a/developers/ocean-subgraph/list-data-nfts.md b/developers/using-ocean-subgraph/list-data-nfts.md
similarity index 98%
rename from developers/ocean-subgraph/list-data-nfts.md
rename to developers/using-ocean-subgraph/list-data-nfts.md
index b4dfb57b..a2d2e019 100644
--- a/developers/ocean-subgraph/list-data-nfts.md
+++ b/developers/using-ocean-subgraph/list-data-nfts.md
@@ -3,7 +3,7 @@
The result of following GraphQL query returns the information about data nfts.
{% hint style="info" %}
-Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](./#ocean-subgraph-graphiql).
+Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](../ocean-subgraph/#ocean-subgraph-graphiql).
{% endhint %}
#### Query
diff --git a/developers/ocean-subgraph/list-datatokens.md b/developers/using-ocean-subgraph/list-datatokens.md
similarity index 97%
rename from developers/ocean-subgraph/list-datatokens.md
rename to developers/using-ocean-subgraph/list-datatokens.md
index 36475b98..a0474625 100644
--- a/developers/ocean-subgraph/list-datatokens.md
+++ b/developers/using-ocean-subgraph/list-datatokens.md
@@ -3,7 +3,7 @@
The result of following GraphQL query returns the information about datatokens.
{% hint style="info" %}
-Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](./#ocean-subgraph-graphiql).
+Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](../ocean-subgraph/#ocean-subgraph-graphiql).
{% endhint %}
#### Query
@@ -112,7 +112,7 @@ python list_all_tokens.py
{% tab title="Javascript" %}
The javascript below can be used to run the the query. If you wish to change the network, then replace the value of variable `baseUrl` as needed.
-#### Create script
+**Create script**
{% code title="listAllTokens.js" %}
```javascript
@@ -171,7 +171,7 @@ axios(config)
```
{% endcode %}
-#### Execute script
+**Execute script**
```bash
node listAllTokens.js
diff --git a/developers/ocean-subgraph/list-fixed-rate-exchanges.md b/developers/using-ocean-subgraph/list-fixed-rate-exchanges.md
similarity index 98%
rename from developers/ocean-subgraph/list-fixed-rate-exchanges.md
rename to developers/using-ocean-subgraph/list-fixed-rate-exchanges.md
index 25c1151f..c887d098 100644
--- a/developers/ocean-subgraph/list-fixed-rate-exchanges.md
+++ b/developers/using-ocean-subgraph/list-fixed-rate-exchanges.md
@@ -3,7 +3,7 @@
The result of following GraphQL query returns the information about the Fixed Rate Exchanges.
{% hint style="info" %}
-Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](./#ocean-subgraph-graphiql).
+Copy the query in the [GraphiQL interface](https://v4.subgraph.mainnet.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) to fetch the results from the mainnet. For other networks use [this table](../ocean-subgraph/#ocean-subgraph-graphiql).
{% endhint %}
#### Query
@@ -118,7 +118,7 @@ python list_fixed_rate_exchanges.py
{% tab title="Javascript" %}
The javascript below can be used to run the the query. If you wish to change the network, then replace the value of variable `baseUrl` as needed.
-#### Create script
+**Create script**
{% code title="listFRE.js" %}
```javascript
@@ -180,7 +180,7 @@ axios(config)
```
{% endcode %}
-#### Execute script
+**Execute script**
```bash
node listFRE.js
diff --git a/user-guides/how-to-data-farm.md b/user-guides/how-to-data-farm.md
index 3b16d1c4..acf037c0 100644
--- a/user-guides/how-to-data-farm.md
+++ b/user-guides/how-to-data-farm.md
@@ -6,4 +6,5 @@ description: How to capitalize with Ocean Protocol's Data Farming dapp
-The bread and butter of the Ocean Protocol Data Farming dapp is
+The bread and butter of the Data Farming dApp is incentivizing OCEAN rewards for curating high quality datasets and algorithms on the Ocean Market. The way that users curate high quality assets on the Ocean Market is by allocating veOCEAN to them using the Data Farming dApp. We'll show you how!
+