oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-01 15:55:34 +01:00
Code Releases Activity

code snippets markdown fixes

Browse Source
This commit is contained in:
Bogdan Fazakas 2023-09-28 17:26:35 +03:00
parent e6e9320810
commit 4a21fdd340
6 changed files with 71 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
developers/ocean-cli/consuming-an-asset.md
View File

@ -6,4 +6,4 @@ In this command, replace 'assetDID' with the specific DID of the asset you want
Once executed, this command seamlessly orchestrates both the ordering of datatoken and the subsequent download operation. The asset's content will be automatically retrieved and saved at the specified location, simplifying the consumption process for users. Once executed, this command seamlessly orchestrates both the ordering of datatoken and the subsequent download operation. The asset's content will be automatically retrieved and saved at the specified location, simplifying the consumption process for users.
<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzQlpIJEeu8x5yl0OLuXn%2Fuploads%2Fqiex0R1FVw2XSzqmSdu6%2FScreenshot%202023-09-28%20at%2001.25.23.png?alt=media&token=70f5e7b7-6698-4817-824c-28ea7483d39c alt=""><figcaption>dowload method example</figcaption></figure> <figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzQlpIJEeu8x5yl0OLuXn%2Fuploads%2Fqiex0R1FVw2XSzqmSdu6%2FScreenshot%202023-09-28%20at%2001.25.23.png?alt=media&token=70f5e7b7-6698-4817-824c-28ea7483d39c" alt=""><figcaption>dowload method example</figcaption></figure>

2
developers/ocean-cli/downloading-compute-results.md
View File

@ -8,4 +8,4 @@ For the first method, you'll need both the dataset DID and the compute job DID.
For the second method, the dataset DID is no longer required. Instead, you'll need to specify the job ID, the index of the result you wish to download from the available results for that job, and the destination folder where you want to save the downloaded content. The corresponding command is as follows: <code> npm run cli downloadJobResults 'JOB_ID' 'RESULT_INDEX' 'DESTINATION_FOLDER'</code> For the second method, the dataset DID is no longer required. Instead, you'll need to specify the job ID, the index of the result you wish to download from the available results for that job, and the destination folder where you want to save the downloaded content. The corresponding command is as follows: <code> npm run cli downloadJobResults 'JOB_ID' 'RESULT_INDEX' 'DESTINATION_FOLDER'</code>
<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzQlpIJEeu8x5yl0OLuXn%2Fuploads%2FjvvCAOQVQvAv2ygNtPby%2FScreenshot%202023-09-28%20at%2002.01.42.png?alt=media&token=da8868d7-6fdb-4dce-ac9a-6b395a0960e5 alt=""><figcaption>downloadJobResults</figcaption></figure> <figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzQlpIJEeu8x5yl0OLuXn%2Fuploads%2FjvvCAOQVQvAv2ygNtPby%2FScreenshot%202023-09-28%20at%2002.01.42.png?alt=media&token=da8868d7-6fdb-4dce-ac9a-6b395a0960e5" alt=""><figcaption>downloadJobResults</figcaption></figure>

12
developers/ocean-cli/installation.md
View File

@ -2,26 +2,20 @@
**Clone the Repository**: Begin by cloning the repository. You can achieve this by executing the following command in your terminal: **Clone the Repository**: Begin by cloning the repository. You can achieve this by executing the following command in your terminal:
<pre><code>```bash ```bash
#!/bin/bash
$ git clone https://github.com/oceanprotocol/ocean.js-cli.git $ git clone https://github.com/oceanprotocol/ocean.js-cli.git
``` ```
</code></pre>
Cloning the repository will create a local copy on your machine, allowing you to access and work with its contents. Cloning the repository will create a local copy on your machine, allowing you to access and work with its contents.
**Install NPM Dependencies**: After successfully cloning the repository, you should install the necessary npm dependencies to ensure that the project functions correctly. This can be done with the following command: **Install NPM Dependencies**: After successfully cloning the repository, you should install the necessary npm dependencies to ensure that the project functions correctly. This can be done with the following command:
<pre><code>```bash ```bash
#!/bin/bash
npm install npm install
``` ```
</code></pre>
Build the TypeScript code Build the TypeScript code
<pre><code>```bash ```bash
#!/bin/bash
npm run build npm run build
``` ```
</code></pre>

129
developers/ocean-cli/publish-a-dataset.md
View File

@ -2,78 +2,71 @@
Once the RPC environment variable has been configured, we can proceed to publish a new dataset on the connected network. The flexibility of our setup allows us to easily switch to a different network by simply substituting the RPC endpoint with one corresponding to another network. Once the RPC environment variable has been configured, we can proceed to publish a new dataset on the connected network. The flexibility of our setup allows us to easily switch to a different network by simply substituting the RPC endpoint with one corresponding to another network.
To initiate this process, we'll begin by updating the helper DDO example named "SimpleDownloadDataset.json." This example can be found in the "./metadata" folder, which is located at the root directory of the cloned Ocean CLI project. To initiate this process, we'll begin by updating the helper DDO example named "SimpleDownloadDataset.json". This example can be found in the "./metadata" folder, which is located at the root directory of the cloned Ocean CLI project.
<pre><code>```json ```json
{ {
"@context": [ "@context": ["https://w3id.org/did/v1"],
"https://w3id.org/did/v1" "id": "",
], "nftAddress": "",
"id": "", "version": "4.1.0",
"nftAddress": "", "chainId": 80001,
"version": "4.1.0", "metadata": {
"chainId": 80001, "created": "2021-12-20T14:35:20Z",
"metadata": { "updated": "2021-12-20T14:35:20Z",
"created": "2021-12-20T14:35:20Z", "type": "dataset",
"updated": "2021-12-20T14:35:20Z", "name": "ocean-cli demo asset",
"type": "dataset", "description": "asset published using ocean cli tool",
"name": "ocean-cli demo asset", "tags": ["test"],
"description": "asset published using ocean cli tool", "author": "oceanprotocol",
"tags": [ "license": "https://market.oceanprotocol.com/terms",
"test" "additionalInformation": {
], "termsAndConditions": true
"author": "oceanprotocol", }
"license": "https://market.oceanprotocol.com/terms", },
"additionalInformation": { "services": [
"termsAndConditions": true {
} "id": "ccb398c50d6abd5b456e8d7242bd856a1767a890b537c2f8c10ba8b8a10e6025",
}, "type": "access",
"services": [ "files": {
{ "datatokenAddress": "0x0",
"id": "ccb398c50d6abd5b456e8d7242bd856a1767a890b537c2f8c10ba8b8a10e6025", "nftAddress": "0x0",
"type": "access", "files": [
"files": { {
"datatokenAddress": "0x0", "type": "url",
"nftAddress": "0x0", "url": "https://dumps.wikimedia.org/enwiki/latest/enwiki-latest-abstract10.xml.gz-rss.xml",
"files": [ "method": "GET"
{ }
"type": "url", ]
"url": "https://dumps.wikimedia.org/enwiki/latest/enwiki-latest-abstract10.xml.gz-rss.xml", },
"method": "GET" "datatokenAddress": "",
} "serviceEndpoint": "https://v4.provider.oceanprotocol.com",
] "timeout": 86400
}, }
"datatokenAddress": "", ],
"serviceEndpoint": "https://v4.provider.oceanprotocol.com", "event": {},
"timeout": 86400 "nft": {
} "address": "",
], "name": "Ocean Data NFT",
"event": { "symbol": "OCEAN-NFT",
}, "state": 5,
"nft": { "tokenURI": "",
"address": "", "owner": "",
"name": "Ocean Data NFT", "created": ""
"symbol": "OCEAN-NFT", },
"state": 5, "purgatory": {
"tokenURI": "", "state": false
"owner": "", },
"created": "" "datatokens": [],
}, "stats": {
"purgatory": { "allocated": 0,
"state": false "orders": 0,
}, "price": {
"datatokens": [ "value": "2"
], }
"stats": { }
"allocated": 0,
"orders": 0,
"price": {
"value": "2"
}
}
} }
``` ```
</code></pre>
Note: The provided example creates a consumable asset with a predetermined price of 2 OCEAN tokens. If you wish to modify this and create an asset that is freely accessible, you can do so by replacing the value of "stats.price.value" with 0 in the JSON example mentioned above. Note: The provided example creates a consumable asset with a predetermined price of 2 OCEAN tokens. If you wish to modify this and create an asset that is freely accessible, you can do so by replacing the value of "stats.price.value" with 0 in the JSON example mentioned above.
Next step is to run the npm run cli publish metadata/simpleDownloadDataset.json command Next step is to run the npm run cli publish metadata/simpleDownloadDataset.json command

12
developers/ocean-cli/setting-environment-variables.md
View File

@ -4,26 +4,20 @@ To successfully configure the CLI tool, two essential steps must be undertaken:
**Private Key Configuration**: The CLI tool necessitates the configuration of the account's private key. This private key serves as the means by which the CLI tool establishes a connection to the associated wallet. It plays a crucial role in authenticating and authorizing operations performed by the tool. **Private Key Configuration**: The CLI tool necessitates the configuration of the account's private key. This private key serves as the means by which the CLI tool establishes a connection to the associated wallet. It plays a crucial role in authenticating and authorizing operations performed by the tool.
<pre><code>```bash ```bash
#!/bin/bash
export MNEMONIC="XXXX" export MNEMONIC="XXXX"
``` ```
</code></pre>
**RPC Endpoint Specification**: Additionally, it is imperative to specify the RPC endpoint that corresponds to the desired network for executing operations. The CLI tool relies on this user-provided RPC endpoint to connect to the network required for its functions. This connection to the network is vital as it enables the CLI tool to interact with the blockchain and execute operations seamlessly. **RPC Endpoint Specification**: Additionally, it is imperative to specify the RPC endpoint that corresponds to the desired network for executing operations. The CLI tool relies on this user-provided RPC endpoint to connect to the network required for its functions. This connection to the network is vital as it enables the CLI tool to interact with the blockchain and execute operations seamlessly.
<pre><code>```bash ```bash
#!/bin/bash
export RPC='XXXX' export RPC='XXXX'
``` ```
</code></pre>
Furthermore, there are additional environment variables that can be configured to enhance the flexibility and customization of the environment. These variables include options such as the metadataCache URL and Provider URL, which can be specified if you prefer to utilize a custom deployment of Aquarius or Provider in contrast of the default settings. Moreover, you have the option to provide a custom address file path if you wish to use customized smart contracts or deployments for your specific use case. Remeber setting the next envariament variables is optional. Furthermore, there are additional environment variables that can be configured to enhance the flexibility and customization of the environment. These variables include options such as the metadataCache URL and Provider URL, which can be specified if you prefer to utilize a custom deployment of Aquarius or Provider in contrast of the default settings. Moreover, you have the option to provide a custom address file path if you wish to use customized smart contracts or deployments for your specific use case. Remeber setting the next envariament variables is optional.
<pre><code>```bash ```bash
#!/bin/bash
export AQUARIUS_URL='XXXX' export AQUARIUS_URL='XXXX'
export PROVIDER_URL='XXXX' export PROVIDER_URL='XXXX'
export ADDRESS_FILE='../path/to/your/address-file' export ADDRESS_FILE='../path/to/your/address-file'
``` ```
</code></pre>

6
developers/ocean-cli/usage.md
View File

@ -2,10 +2,8 @@
The command <code>npm run cli h</code> returns a list of all commands and option flags. The command <code>npm run cli h</code> returns a list of all commands and option flags.
<pre><code>```bash ```bash
#!/bin/bash
npm run cli h npm run cli h
``` ```
</code></pre>
<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzQlpIJEeu8x5yl0OLuXn%2Fuploads%2FBCFAxxcCjwVPJfiKOOt1%2FScreenshot%202023-09-27%20at%2023.55.43.png?alt=media&token=76114c63-da9c-4d34-afdb-97b6bafca9d9" alt=""><figcaption></figcaption></figure> <figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzQlpIJEeu8x5yl0OLuXn%2Fuploads%2FBCFAxxcCjwVPJfiKOOt1%2FScreenshot%202023-09-27%20at%2023.55.43.png?alt=media&token=76114c63-da9c-4d34-afdb-97b6bafca9d9" alt=""><figcaption>available options</figcaption></figure>