diff --git a/.gitbook/assets/cover/contribute (1) (1).png b/.gitbook/assets/cover/contribute (1) (1).png new file mode 100644 index 00000000..9f2be28a Binary files /dev/null and b/.gitbook/assets/cover/contribute (1) (1).png differ diff --git a/.gitbook/assets/wallet/balance-of (1).png b/.gitbook/assets/wallet/balance-of (1).png new file mode 100644 index 00000000..c99a54ac Binary files /dev/null and b/.gitbook/assets/wallet/balance-of (1).png differ diff --git a/.gitbook/assets/wallet/balance-of (2).png b/.gitbook/assets/wallet/balance-of (2).png new file mode 100644 index 00000000..c99a54ac Binary files /dev/null and b/.gitbook/assets/wallet/balance-of (2).png differ diff --git a/README.md b/README.md index 2b5641e8..2248cef3 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ --- description: Help for wherever you are on your Ocean Protocol journey. -cover: .gitbook/assets/cover/contribute (1).png +cover: .gitbook/assets/cover/contribute (2).png coverY: 0 layout: landing --- # 👋 Welcome -
discoverLearn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.discoverdiscover_card.png
user-guidesWhether you're new to Ocean or just need a refresher on a particular task, the "User Guiders" section is a great resource for quickly finding step-by-step instructions for what you need.user-guidesuser_guides_card.png
developersWhether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.developersdeveloper_tutorials_card.png
data-scienceData science is the key to unlocking the true potential of decentralized data sharing.data-sciencedata_science_card.png
infrastructureLearn how to deploy your own components on the Ocean Protocol network.infrastructureinfrastructure_card.png
defiDeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.defirewards_card (1).png
rewardsDiscover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.rewardsrewards_card (1).png
contributeLearn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.contributecontribute_card.png
+
discoverLearn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.discoverdiscover_card (1).png
user-guidesWhether you're new to Ocean or just need a refresher on a particular task, the "User Guiders" section is a great resource for quickly finding step-by-step instructions for what you need.user-guidesuser_guides_card (1).png
developersWhether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.developersdeveloper_tutorials_card (1).png
data-scienceData science is the key to unlocking the true potential of decentralized data sharing.data-sciencedata_science_card (1).png
infrastructureLearn how to deploy your own components on the Ocean Protocol network.infrastructureinfrastructure_card (1).png
defiDeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.defirewards_card.png
rewardsDiscover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.rewardsrewards_card.png
contributeLearn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.contributecontribute_card (1).png
diff --git a/SUMMARY.md b/SUMMARY.md index 2d2287a2..2d4dc656 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) @@ -63,7 +63,6 @@ * [Chain Requests](developers/aquarius/chain-requests.md) * [Other Requests](developers/aquarius/other-requests.md) * [APIs](developers/APIs/README.md) - * [Aquarius](developers/apis/aquarius.md) * [Provider](developers/apis/provider.md) * [📊 Data Science](data-science/README.md) * [🔨 Infrastructure](infrastructure/README.md) diff --git a/contribute/README.md b/contribute/README.md index 2ae1933c..c9cce198 100644 --- a/contribute/README.md +++ b/contribute/README.md @@ -1,7 +1,7 @@ --- title: Ways to Contribute description: Help to improve and develop Ocean core software. -cover: ../.gitbook/assets/cover/contribute (2).png +cover: ../.gitbook/assets/cover/contribute (1).png coverY: 0 --- diff --git a/developers/APIs/README.md b/developers/APIs/README.md new file mode 100644 index 00000000..56ecb400 --- /dev/null +++ b/developers/APIs/README.md @@ -0,0 +1,2 @@ +# APIs + diff --git a/developers/apis/aquarius.md b/developers/apis/aquarius.md deleted file mode 100644 index eab143de..00000000 --- a/developers/apis/aquarius.md +++ /dev/null @@ -1,524 +0,0 @@ -# Aquarius - -The universal Aquarius Endpoint is [`https://v4.aquarius.oceanprotocol.com`](https://v4.aquarius.oceanprotocol.com). - -## Assets - -### **Get** `/api/aquarius/assets/ddo/` - -#### Description - -Get DDO of a particular asset. - -#### Parameters - -| name | description | type | in | required | -| ----- | ---------------- | ------ | ---- | -------- | -| `did` | DID of the asset | string | path | true | - -#### Curl Example - -``` -curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/ddo/did:op:cd086344c275bc7c560e91d472be069a24921e73a2c3798fb2b8caadf8d245d6' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') -const did = 'did:op:ce3f161fb98c64a2ded37fd34e25f28343f2c88d0c8205242df9c621770d4b3b' -const response = await axios(`https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/ddo/${did}`) -console.log(response.status) -console.log(response.data.nftAddress) -console.log(response.data.metadata.name) -console.log(response.data.metadata.description) - -``` - -#### Responses - -`200` - -* content-type: json -* description: On successful operation returns DDO information. - -`404` - -* content-type: json -* description: This asset DID is not in ES. -* response body: - - ``` - { - "error": "Asset DID not found in Elasticsearch." - } - ``` - -### **GET** `/api/aquarius/assets/metadata/` - -#### Description - -Get metadata of a particular asset. - -#### Parameters - -| name | description | type | in | required | -| ----- | ---------------- | ------ | ---- | -------- | -| `did` | DID of the asset | string | path | true | - -#### Curl Example - -```bash -curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/metadata/did:op:cd086344c275bc7c560e91d472be069a24921e73a2c3798fb2b8caadf8d245d6' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') -const did = 'did:op:ce3f161fb98c64a2ded37fd34e25f28343f2c88d0c8205242df9c621770d4b3b' -const response = await axios(`https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/metadata/${did}`) -console.log(response.status) -console.log(response.data.name) -console.log(response.data.description) - -``` - -#### Responses - -`200` - -* content-type: json -* description: successful operation. - -`404` - -* content-type: json -* description: This asset DID is not in ES. -* response body: - - ``` - { - "error": "Error encountered while retrieving metadata: NotFoundError(404, '{\"_index\":\"aquarius\",\"_type\":\"_doc\",\"_id\":\"\",\"found\":false}')." - } - ``` - -### **POST** `/api/aquarius/assets/names` - -#### Description - -Get names of assets as specified in the payload. - -#### Parameters - -| name | description | type | in | required | -| --------- | ------------------ | ---- | ---- | -------- | -| `didList` | list of asset DIDs | list | body | true | - -#### Curl Example - -```bash -curl --location --request POST 'https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/names' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "didList" : ["did:op:cd086344c275bc7c560e91d472be069a24921e73a2c3798fb2b8caadf8d245d6"] -}' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') - -const body = {didList : ["did:op:cd086344c275bc7c560e91d472be069a24921e73a2c3798fb2b8caadf8d245d6", "did:op:ce3f161fb98c64a2ded37fd34e25f28343f2c88d0c8205242df9c621770d4b3b"]} - -const response = await axios.post('https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/names', body) -console.log(response.status) -for (let key in response.data) { - console.log(key + ': ' + response.data[key]); -} - -``` - -#### Responses - -`200` - -* content-type: json -* description: successful operation. -* response body: - - ``` - {"did:op:cd086344c275bc7c560e91d472be069a24921e73a2c3798fb2b8caadf8d245d6": "Ocean CEX Aggregator: OHLC history for OCEAN/USDT "} - ``` - -`400` - -* content-type: json -* description: This asset DID is not in ES. -* response body: - - ``` - { - "error": "The requested didList can not be empty." - } - ``` - -### **POST** `/api/aquarius/assets/query` - -#### **Description** - -Run a native ES query. Body must be a valid json object. - -#### Curl Example - -```bash -curl --location --request POST 'https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/query' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "query": { - "match_all": {} - } -}' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') - -const body = { "query": { "match_all": { } } } - - -const response = await axios.post('https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/query', body) -console.log(response.status) -console.log(response.data.hits.hits[0]) -for (const value of response.data.hits.hits) { - console.log(value); -} - -``` - -#### Responses - -`200` - -* content-type: json - -`500` - -* description: elasticsearch exception - -### **POST** `/api/aquarius/assets/ddo/validate` - -#### Description - -Validate DDO content. Cosumes `application/octet-stream` - -#### Curl Example - -```bash -curl --location --request POST 'https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/query/api/v1/aquarius/assets/ddo/validate' \ ---header 'Content-Type: application/json' \ ---data-raw '' -``` - -#### Javascript Example - -{% embed url="https://runkit.com/oceanprotocol/646b68e10611080008c6a640" %} - -#### Valid body - -``` - { - "@context": ["https://w3id.org/did/v1"], - "id": "did:op:56c3d0ac76c02cc5cec98993be2b23c8a681800c08f2ff77d40c895907517280", - "version": "4.1.0", - "chainId": 1337, - "nftAddress": "0xabc", - "metadata": { - "created": "2000-10-31T01:30:00.000-05:00Z", - "updated": "2000-10-31T01:30:00.000-05:00", - "name": "Ocean protocol white paper", - "type": "dataset", - "description": "Ocean protocol white paper -- description", - "author": "Ocean Protocol Foundation Ltd.", - "license": "CC-BY", - "contentLanguage": "en-US", - "tags": ["white-papers"], - "additionalInformation": {"test-key": "test-value"}, - "links": [ - "http://data.ceda.ac.uk/badc/ukcp09/data/gridded-land-obs/gridded-land-obs-daily/", - "http://data.ceda.ac.uk/badc/ukcp09/data/gridded-land-obs/gridded-land-obs-averages-25km/", - "http://data.ceda.ac.uk/badc/ukcp09/" - ] - }, - "services": [ - { - "id": "test", - "type": "access", - "datatokenAddress": "0xC7EC1970B09224B317c52d92f37F5e1E4fF6B687", - "name": "Download service", - "description": "Download service", - "serviceEndpoint": "http://172.15.0.4:8030/", - "timeout": 0, - "files": "encryptedFiles" - } - ] - } -``` - -#### Responses: - -`200` - -Successfull request. - -`400` - -Invalid DDO format - -`500` - -Error - -### **POST** `/api/aquarius/assets/triggerCaching` - -#### Description - -Manually triggers DDO caching based on a `transacionId` containing either MetadataCreated or MetadataUpdated event(s). - -#### Parameters - -| name | description | type | in | required | -| --------------- | ------------------------------------ | ------ | ---- | -------- | -| `transactionId` | DID of the asset | string | path | true | -| `logIndex` | custom log index for the transaction | int | path | false | - -#### Curl Example - -```bash -curl --location --request POST 'https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/triggerCaching' \ ---header 'Content-Type: application/json' \ ---data-raw '' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') - -const body = { "transactionId": "0x945596edf2a26d127514a78ed94fea86b199e68e9bed8b6f6d6c8bb24e451f27", "logIndex": 0} -const response = await axios.post( 'https://v4.aquarius.oceanprotocol.com/api/aquarius/assets/triggerCaching', body) -console.log(response.status) -console.log(response.data) - -``` - -#### Valid body - -``` - { - "transactionId": "0x945596edf2a26d127514a78ed94fea86b199e68e9bed8b6f6d6c8bb24e451f27", - "logIndex": 0 - } -``` - -#### Responses: - -`200` - -Description: triggering successful, updated asset returned - -`400` - -Description: request issues: either log index not found, or neither of MetadataCreated, MetadataUpdated found in tx log - -`500` - -Description: Error - -## Chains - -### **GET** `/api/aquarius/chains/list` - -#### Description - -Get chains list - -#### Curl Example - -```bash -curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/api/aquarius/chains/list' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') - -const response = await axios( 'https://v4.aquarius.oceanprotocol.com/api/aquarius/chains/list') -console.log(response.status) -console.log(response.data) - -``` - -#### Response - -`200` - -Description: Successful request - -Body: - -``` -{ "246": true, "3": true, "137": true, - "2021000": true, "4": true, "1": true, - "56": true, "80001": true, "1287": true -} -``` - -### **GET** `/api/aquarius/chains/status/{chain_id}` - -#### Description - -Get index status for a specific chain\_id - -#### Curl Example - -```bash -curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/api/aquarius/chains/status/137' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') -const chainId = 1 - -const response = await axios( `https://v4.aquarius.oceanprotocol.com/api/aquarius/chains/status/${chainId}`) -console.log(response.status) -console.log(response.data) - -``` - -#### Response - -`200` - -Description: Successful request - -Body: - -``` -{"last_block": 25198729} -``` - -## Others - -### **GET** `/` - -#### Description - -Get version, plugin, and software information. - -#### Curl Example - -```bash -curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') - -const response = await axios( 'https://v4.aquarius.oceanprotocol.com/') -console.log(response.status) -console.log(response.data) - -``` - -#### Response - -`200` - -Description: Successful request - -Body: - -``` -{ - "plugin": "elasticsearch", - "software": "Aquarius", - "version": "4.2.0" -} -``` - -### **GET** `/health` - -**Description** - -Get health status - -**Curl Example** - -```bash -curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/health' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') - -const response = await axios( 'https://v4.aquarius.oceanprotocol.com/health') -console.log(response.status) -console.log(response.data) - -``` - -**Response** - -`200` - -Description: Successful request - -Body: - -``` -Elasticsearch connected -``` - -### **GET** /spec - -#### Description - -Get swagger spec - -#### Example - -```bash -curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/spec' -``` - -#### Javascript Example - -```runkit nodeVersion="18.x.x" -const axios = require('axios') - -const response = await axios( 'https://v4.aquarius.oceanprotocol.com/spec') -console.log(response.status) -console.log(response.data.info) - -``` - -#### Response - -`200` - -Successful request - -### Postman documentation - -Click [here](https://documenter.getpostman.com/view/2151723/UVkmQc7r) to explore the documentation and more examples in postman. diff --git a/developers/datanft-and-datatoken.md b/developers/datanft-and-datatoken.md index 6bb83d28..349159d1 100644 --- a/developers/datanft-and-datatoken.md +++ b/developers/datanft-and-datatoken.md @@ -62,7 +62,7 @@ Ocean provides convenient methods to list ERC20 datatokens for sale, with fixed- ### High-Level Behavior -![High-Level Flow](../.gitbook/assets/architecture/high-level-flow.png) +![High-Level Flow](<../.gitbook/assets/architecture/high-level-flow (1).png>) Here's an example. diff --git a/infrastructure/setup-server.md b/infrastructure/setup-server.md index 9654f6fb..cf250bac 100644 --- a/infrastructure/setup-server.md +++ b/infrastructure/setup-server.md @@ -28,7 +28,7 @@ Select Ubuntu OS and choose a plan. The required CPU, Memory depends on the numb Also, select the region where you want Aquarius to be hosted and a root password. -![Select region](<../.gitbook/assets/server-setup/server-setup3 (1).png>) +![Select region](../.gitbook/assets/server-setup/server-setup3.png) ![Click create Droplet](../.gitbook/assets/server-setup/server-setup4.png) diff --git a/user-guides/asset-hosting/azure-cloud.md b/user-guides/asset-hosting/azure-cloud.md index ff761e2e..975b6f35 100644 --- a/user-guides/asset-hosting/azure-cloud.md +++ b/user-guides/asset-hosting/azure-cloud.md @@ -18,41 +18,41 @@ Create an account on [Azure](https://azure.microsoft.com/en-us/). Users might al Go to the Azure portal: https://portal.azure.com/#home and select `Storage accounts` as shown below. -![Select storage accounts](../../.gitbook/assets/hosting/azure1.png) +![Select storage accounts](<../../.gitbook/assets/hosting/azure1 (1).png>) **Create a new storage account** -![Create a storage account](<../../.gitbook/assets/hosting/azure2 (1).png>) +![Create a storage account](../../.gitbook/assets/hosting/azure2.png) **Fill in the details** -![Add details](../../.gitbook/assets/hosting/azure3.png) +![Add details](<../../.gitbook/assets/hosting/azure3 (1).png>) **Storage account created** -![Storage account created](<../../.gitbook/assets/hosting/azure4 (1).png>) +![Storage account created](../../.gitbook/assets/hosting/azure4.png) **Step 2 - Create a blob container** -![Create a blob container](../../.gitbook/assets/hosting/azure5.png) +![Create a blob container](<../../.gitbook/assets/hosting/azure5 (1).png>) **Step 3 - Upload a file** -![Upload a file](<../../.gitbook/assets/hosting/azure6 (1).png>) +![Upload a file](../../.gitbook/assets/hosting/azure6.png) **Step 4 - Share the file** **Select the file to be published and click Generate SAS** -![Click generate SAS](../../.gitbook/assets/hosting/azure7.png) +![Click generate SAS](<../../.gitbook/assets/hosting/azure7 (1).png>) **Configure the SAS details and click `Generate SAS token and URL`** -![Generate link to file](<../../.gitbook/assets/hosting/azure8 (1).png>) +![Generate link to file](../../.gitbook/assets/hosting/azure8.png) **Copy the generated link** -![Copy the link](<../../.gitbook/assets/hosting/azure9 (1).png>) +![Copy the link](../../.gitbook/assets/hosting/azure9.png) **Step 5 - Publish the asset using the generated link** diff --git a/user-guides/claim-ocean-rewards.md b/user-guides/claim-ocean-rewards.md index 8d230d21..a57f97f9 100644 --- a/user-guides/claim-ocean-rewards.md +++ b/user-guides/claim-ocean-rewards.md @@ -12,7 +12,7 @@ Want to begin [data farming](https://df.oceandao.org)? Start [here](get-veocean- Go to [https://df.oceandao.org/](https://df.oceandao.org), and click the Rewards [link](https://df.oceandao.org/activerewards) at the top of the page. -

Click the Rewards link at the top of the page

+

Click the Rewards link at the top of the page

### Step 2 - Click the pink 'Claim # OCEAN' buttons 🛎️ diff --git a/user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md b/user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md index 91dd5c5e..99867447 100644 --- a/user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md +++ b/user-guides/compute-to-data/publish-a-c2d-algorithm-nft.md @@ -52,7 +52,7 @@ You're an algorithm guru after all! * Your preview should look like the following: -
+
#### Step 8 - Submit the transactions diff --git a/user-guides/compute-to-data/publish-a-c2d-data-nft.md b/user-guides/compute-to-data/publish-a-c2d-data-nft.md index c4e408e3..ff497f30 100644 --- a/user-guides/compute-to-data/publish-a-c2d-data-nft.md +++ b/user-guides/compute-to-data/publish-a-c2d-data-nft.md @@ -78,7 +78,7 @@ description: How to publish a data NFT with C2D configurations #### Congratulations! You have fully finished the C2D flow. Check your work by verifying that your algorithm appears on the data NFT's page, like in the following example: -

Your algorithm should appear now on the data NFT's page!

+

Your algorithm should appear now on the data NFT's page!

If you would like to run the compute job, then simply click the radio button to the left of the algorithm's name and click Buy Compute Job. diff --git a/user-guides/remove-liquidity-using-etherscan.md b/user-guides/remove-liquidity-using-etherscan.md index 0e6ac1b1..73ebd643 100644 --- a/user-guides/remove-liquidity-using-etherscan.md +++ b/user-guides/remove-liquidity-using-etherscan.md @@ -14,7 +14,7 @@ Liquidity pools and dynamic pricing used to be supported in previous versions of 4\. Go to field `20. balanceOf` and insert your ETH address. This will retrieve your pool share token balance in wei. -

Balance Of

+

Balance Of

5\. Copy this number as later you will use it as the `poolAmountIn` parameter.