mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
GITBOOK-221: change request with no subject merged in GitBook
This commit is contained in:
Jamie Hewitt
gitbook-bot
parent
14508b91c4
commit
296ffc7611
BIN
.gitbook/assets/cover/contribute (1) (1).png
Normal file
BIN
.gitbook/assets/cover/contribute (1) (1).png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 320 KiB |
BIN
.gitbook/assets/wallet/balance-of (1).png
Normal file
BIN
.gitbook/assets/wallet/balance-of (1).png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
BIN
.gitbook/assets/wallet/balance-of (2).png
Normal file
BIN
.gitbook/assets/wallet/balance-of (2).png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
@ -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
|
||||
|
||||
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/">discover</a></td><td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td><td></td><td></td><td><a href="discover/">discover</a></td><td><a href=".gitbook/assets/cover/discover_card.png">discover_card.png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Whether you're new to Ocean or just need a refresher on a particular task, the "User Guiders" section is a great resource for quickly finding step-by-step instructions for what you need.</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td><a href=".gitbook/assets/cover/user_guides_card.png">user_guides_card.png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/cover/developer_tutorials_card.png">developer_tutorials_card.png</a></td></tr><tr><td><a href="data-science/">data-science</a></td><td>Data science is the key to unlocking the true potential of decentralized data sharing.</td><td></td><td></td><td><a href="data-science/">data-science</a></td><td><a href=".gitbook/assets/cover/data_science_card.png">data_science_card.png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>Learn how to deploy your own components on the Ocean Protocol network.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/cover/infrastructure_card.png">infrastructure_card.png</a></td></tr><tr><td><a href="defi/">defi</a></td><td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td><td></td><td></td><td><a href="defi/">defi</a></td><td><a href=".gitbook/assets/cover/rewards_card (1).png">rewards_card (1).png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/cover/rewards_card (1).png">rewards_card (1).png</a></td></tr><tr><td><a href="contribute/">contribute</a></td><td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td><td></td><td></td><td><a href="contribute/">contribute</a></td><td><a href=".gitbook/assets/cover/contribute_card.png">contribute_card.png</a></td></tr></tbody></table>
|
||||
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="files"></th><th data-hidden data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="discover/">discover</a></td><td>Learn about Ocean Protocol's powerful data-sharing capabilities and its potential to transform the way data is shared and monetized.</td><td></td><td></td><td><a href="discover/">discover</a></td><td><a href=".gitbook/assets/cover/discover_card (1).png">discover_card (1).png</a></td></tr><tr><td><a href="user-guides/">user-guides</a></td><td>Whether you're new to Ocean or just need a refresher on a particular task, the "User Guiders" section is a great resource for quickly finding step-by-step instructions for what you need.</td><td></td><td></td><td><a href="user-guides/">user-guides</a></td><td><a href=".gitbook/assets/cover/user_guides_card (1).png">user_guides_card (1).png</a></td></tr><tr><td><a href="developers/">developers</a></td><td>Whether you're building a dApp or integrating with the ecosystem, you'll find plenty of APIs, libraries, and other tools to help you get the job done.</td><td></td><td></td><td><a href="developers/">developers</a></td><td><a href=".gitbook/assets/cover/developer_tutorials_card (1).png">developer_tutorials_card (1).png</a></td></tr><tr><td><a href="data-science/">data-science</a></td><td>Data science is the key to unlocking the true potential of decentralized data sharing.</td><td></td><td></td><td><a href="data-science/">data-science</a></td><td><a href=".gitbook/assets/cover/data_science_card (1).png">data_science_card (1).png</a></td></tr><tr><td><a href="infrastructure/">infrastructure</a></td><td>Learn how to deploy your own components on the Ocean Protocol network.</td><td></td><td></td><td><a href="infrastructure/">infrastructure</a></td><td><a href=".gitbook/assets/cover/infrastructure_card (1).png">infrastructure_card (1).png</a></td></tr><tr><td><a href="defi/">defi</a></td><td>DeFi (Decentralized Finance) has taken the financial world by storm, and Ocean Protocol has been at the forefront of this movement. In this category, you'll find a wealth of tutorials and guides on various DeFi topics.</td><td></td><td></td><td><a href="defi/">defi</a></td><td><a href=".gitbook/assets/cover/rewards_card.png">rewards_card.png</a></td></tr><tr><td><a href="rewards/">rewards</a></td><td>Discover ways to earn rewards for contributing to the Ocean Protocol ecosystem. Explore bounty programs, grants, and other initiatives that can help you make an impact and earn recognition for your contributions.</td><td></td><td></td><td><a href="rewards/">rewards</a></td><td><a href=".gitbook/assets/cover/rewards_card.png">rewards_card.png</a></td></tr><tr><td><a href="contribute/">contribute</a></td><td>Learn how you can contribute to the growth and development of Ocean Protocol. Whether you're interested in community initiatives, open-source projects, or other opportunities, there are many ways to get involved and make a difference.</td><td></td><td></td><td><a href="contribute/">contribute</a></td><td><a href=".gitbook/assets/cover/contribute_card (1).png">contribute_card (1).png</a></td></tr></tbody></table>
|
||||
|
||||
@ -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)
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
|
||||
2
developers/APIs/README.md
Normal file
2
developers/APIs/README.md
Normal file
@ -0,0 +1,2 @@
|
||||
# APIs
|
||||
|
||||
@ -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/<did>`
|
||||
|
||||
#### 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 <did> not found in Elasticsearch."
|
||||
}
|
||||
```
|
||||
|
||||
### **GET** `/api/aquarius/assets/metadata/<did>`
|
||||
|
||||
#### 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\":\"<did>\",\"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 '<json_body>'
|
||||
```
|
||||
|
||||
#### 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 '<json_body>'
|
||||
```
|
||||
|
||||
#### 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.
|
||||
@ -62,7 +62,7 @@ Ocean provides convenient methods to list ERC20 datatokens for sale, with fixed-
|
||||
|
||||
### High-Level Behavior
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
Here's an example.
|
||||
|
||||
|
||||
@ -28,7 +28,7 @@ Select Ubuntu OS and choose a plan. The required CPU, Memory depends on the numb
|
||||
|
||||
Also, select the region where you want Aquarius to be hosted and a root password.
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -18,41 +18,41 @@ Create an account on [Azure](https://azure.microsoft.com/en-us/). Users might al
|
||||
|
||||
Go to the Azure portal: https://portal.azure.com/#home and select `Storage accounts` as shown below.
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
**Create a new storage account**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Fill in the details**
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
**Storage account created**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Step 2 - Create a blob container**
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
**Step 3 - Upload a file**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Step 4 - Share the file**
|
||||
|
||||
**Select the file to be published and click Generate SAS**
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
**Configure the SAS details and click `Generate SAS token and URL`**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Copy the generated link**
|
||||
|
||||
.png>)
|
||||
|
||||
|
||||
**Step 5 - Publish the asset using the generated link**
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ Want to begin [data farming](https://df.oceandao.org)? Start [here](get-veocean-
|
||||
|
||||
Go to [https://df.oceandao.org/](https://df.oceandao.org), and click the Rewards [link](https://df.oceandao.org/activerewards) at the top of the page.
|
||||
|
||||
<figure><img src="../.gitbook/assets/rewards/Rewards-Tab.png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/rewards/Rewards-Tab (1).png" alt=""><figcaption><p>Click the Rewards link at the top of the page</p></figcaption></figure>
|
||||
|
||||
### Step 2 - Click the pink 'Claim # OCEAN' buttons 🛎️
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ You're an algorithm guru after all!
|
||||
|
||||
* Your preview should look like the following:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/c2d/preview-publish (1).png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/c2d/preview-publish.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
#### Step 8 - Submit the transactions
|
||||
|
||||
|
||||
@ -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:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/c2d/double-check-work (1).png" alt="" width="375"><figcaption><p>Your algorithm should appear now on the data NFT's page!</p></figcaption></figure>
|
||||
<figure><img src="../../.gitbook/assets/c2d/double-check-work.png" alt="" width="375"><figcaption><p>Your algorithm should appear now on the data NFT's page!</p></figcaption></figure>
|
||||
|
||||
If you would like to run the compute job, then simply click the radio button to the left of the algorithm's name and click Buy Compute Job.
|
||||
|
||||
|
||||
@ -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/wallet/balance-of.png" alt=""><figcaption><p>Balance Of</p></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/liquidity/remove-liquidity-2 (1).png" alt=""><figcaption><p>Balance Of</p></figcaption></figure>
|
||||
|
||||
5\. Copy this number as later you will use it as the `poolAmountIn` parameter.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user