GITBOOK-486: oceanjs c2d

SUMMARY.md

@@ -48,8 +48,8 @@
   * [DDO Specification](developers/ddo-specification.md)
   * [Storage Specifications](developers/storage-specifications.md)
   * [Fine-Grained Permissions](developers/Fine-Grained-Permissions.md)
-  * [Barge](developers/barge.md)
-  * [Local Setup - Barge](developers/local-setup-ganache.md)
+  * [Barge](developers/barge/README.md)
+    * [Local Setup](developers/barge/local-setup-ganache.md)
   * [Build a Marketplace](developers/build-a-marketplace/README.md)
     * [Forking Ocean Market](developers/build-a-marketplace/forking-ocean-market.md)
     * [Customising a Market](developers/build-a-marketplace/customising-your-market.md)

developers/barge/local-setup-ganache.md

@@ -2,9 +2,7 @@
 description: 🧑🏽‍💻 Your Local Development Environment for Ocean Protocol
 ---
 
-# Local Setup - Barge
-
-Barge is a powerful tool designed to provide developers with a local development environment for working with Ocean Protocol. It simplifies the setup process by using Docker Compose files to deploy the entire Ocean Protocol stack locally. With Barge, you can quickly set up and run the latest versions of Aquarius, Provider, Ganache, TheGraph, ocean-contracts, and more.
+# Local Setup
 
 **Functionalities of Barge**
 

developers/ocean.js/cod-asset.md

@@ -1,4 +1,4 @@
-# CoD Asset
+# Run C2D Jobs
 
 **Overview**
 
@@ -16,4 +16,167 @@ To get started with Compute-to-Data using Ocean.js, follow these steps:
 4. **Searching and Consuming Compute-to-Data Services**: As a data consumer, you can search for Compute-to-Data services available on the Ocean Protocol network. Utilize Ocean.js to discover services based on data types, pricing, and other parameters.
 5. **Executing Computations on Data**: Once you have identified a suitable Compute-to-Data service, use Ocean.js to execute computations on the provided data. The actual computation is performed by the service provider, and the results are securely returned to you.
 
-Please note that the implementation details of Compute-to-Data can vary depending on your specific use case. The code examples available in the Ocean.js GitHub repository provide comprehensive illustrations of working with Compute-to-Data in Ocean Protocol. Visit [CodeExample.md](https://github.com/oceanprotocol/ocean.js/blob/main/ComputeExamples.md) for detailed code snippets and explanations that guide you through leveraging Compute-to-Data capabilities.
+Please note that the implementation details of Compute-to-Data can vary depending on your specific use case. The code examples available in the Ocean.js GitHub repository provide comprehensive illustrations of working with Compute-to-Data in Ocean Protocol. Visit [ComputeExamples.md](https://github.com/oceanprotocol/ocean.js/blob/main/ComputeExamples.md) for detailed code snippets and explanations that guide you through leveraging Compute-to-Data capabilities.
+
+#### 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)
+
+{% hint style="info" %}
+The variable **AQUARIUS\_URL** and **PROVIDER\_URL** should be set correctly in `.env` file
+{% endhint %}
+
+#### Create a script that starts compute to data using an already published dataset and algorithm
+
+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.
+
+<pre class="language-javascript"><code class="lang-javascript">// Note: Make sure .env file and config.js are created and setup correctly
+const { oceanConfig } = require('./config.js');
+const { ZERO_ADDRESS, NftFactory, getHash, Nft } = require ('@oceanprotocol/lib');
+
+// replace the did here
+const datasetDid = "did:op:a419f07306d71f3357f8df74807d5d12bddd6bcd738eb0b461470c64859d6f0f";
+const algorithmDid = "did:op:a419f07306d71f3357f8df74807d5d12bddd6bcd738eb0b461470c64859d6f0f";
+
+// This function takes dataset and algorithm dids as a parameters,
+// and starts a compute job for them
+<strong>const startComputeJob = async (datasetDid, algorithmDid) => {
+</strong>  
+  const consumer = await oceanConfig.consumerAccount.getAddress();
+  
+   // Fetch the dataset and the algorithm from Aquarius
+  const dataset = await await oceanConfig.aquarius.resolve(datasetDid);
+  const algorithm = await await oceanConfig.aquarius.resolve(algorithmDid);
+  
+  // Let's fetch the compute environments and choose the free one
+  const computeEnv = computeEnvs[resolvedDatasetDdo.chainId].find(
+    (ce) => ce.priceMin === 0
+  )
+  
+  // Request five minutes of compute access
+  const mytime = new Date()
+  const computeMinutes = 5
+  mytime.setMinutes(mytime.getMinutes() + computeMinutes)
+  const computeValidUntil = Math.floor(mytime.getTime() / 1000
+  
+  // Let's initialize the provider for the compute job
+  const asset: ComputeAsset[] = {
+    documentId: dataset.id,
+    serviceId: dataset.services[0].id
+  }
+
+  const algo: ComputeAlgorithm = {
+    documentId: algorithm.id,
+    serviceId: algorithm.services[0].id
+  }
+  
+  const providerInitializeComputeResults = await ProviderInstance.initializeCompute(
+    assets,
+    algo,
+    computeEnv.id,
+    computeValidUntil,
+    providerUrl,
+    await consumerAccount.getAddress()
+  )
+  
+  await approve(
+    consumerAccount,
+    config,
+    await consumerAccount.getAddress(),
+    addresses.Ocean,
+    datasetFreAddress,
+    '100'
+  )
+  
+  await approve(
+    consumerAccount,
+    config,
+    await consumerAccount.getAddress(),
+    addresses.Ocean,
+    algoFreAddress,
+    '100'
+  )
+    
+  const fixedRate = new FixedRateExchange(fixedRateExchangeAddress, consumerAccount)
+  const buyDatasetTx = await fixedRate.buyDatatokens(datasetFreAddress, '1', '2')
+  const buyAlgoTx = await fixedRate.buyDatatokens(algoFreAddress, '1', '2')
+ 
+  
+  // We now order both the dataset and the algorithm
+  algo.transferTxId = await handleOrder(
+    providerInitializeComputeResults.algorithm,
+    algorithm.services[0].datatokenAddress,
+    consumerAccount,
+    computeEnv.consumerAddress,
+    0
+  )
+  
+  asset.transferTxId = await handleOrder(
+    providerInitializeComputeResults.datasets[0],
+    dataset.services[0].datatokenAddress,,
+    consumerAccount,
+    computeEnv.consumerAddress,
+    0
+  )
+  
+  // Start the compute job for the given dataset and algorithm
+  const computeJobs = await ProviderInstance.computeStart(
+    providerUrl,
+    consumerAccount,
+    computeEnv.id,
+    assets[0],
+    algo
+  )
+  
+  return  computeJobs[0].jobId
+  
+};
+
+const checkIfJobFinished = async (jobId) => {
+  const jobStatus = await ProviderInstance.computeStatus(
+      providerUrl,
+      await consumerAccount.getAddress(),
+      computeJobId,
+      DATASET_DDO.id
+    )
+  if (jobStatus?.status === 70) return true
+  else checkIfJobFinished(jobId)
+}
+
+const checkIfJobFinished = async (jobId) => {
+  const jobStatus = await ProviderInstance.computeStatus(
+      providerUrl,
+      await consumerAccount.getAddress(),
+      computeJobId,
+      DATASET_DDO.id
+    )
+  if (jobStatus?.status === 70) return true
+  else checkIfJobFinished(jobId)
+}
+
+const downloadComputeResults = async (jobId) => {
+  const downloadURL = await ProviderInstance.getComputeResultUrl(
+      oceanConfig.providerURI,
+      oceanConfig.consumerAccount,
+      jobId,
+      0
+    )
+}
+
+// Call startComputeJob(...) checkIfJobFinished(...) downloadComputeResults(...)
+// functions defined above in that particular order 
+startComputeJob(datasetDid, algorithmDid).then((jobId) => {
+  checkIfJobFinished(jobId).then((result) => {
+    downloadComputeResults(jobId).then((result) => {
+      process.exit();
+    })
+  })
+}).catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
+</code></pre>
+

developers/ocean.js/consume-asset.md

@@ -41,12 +41,12 @@ const did = "did:op:a419f07306d71f3357f8df74807d5d12bddd6bcd738eb0b461470c64859d
 // This function takes did as a parameter and updates the data NFT information
 const consumeAsset = async (did) => {
   
-  const consumer = await oceanConfig.consumer.getAddress();
+  const consumer = await oceanConfig.consumerAccount.getAddress();
   
    // Fetch ddo from Aquarius
   const asset = await await oceanConfig.aquarius.resolve(did);
 
-  const nft = new Nft(oceanConfig.ethersProvider);
+  const nft = new Nft(oceanConfig.consumerAccount);
   
   await approve(
     consumerAccount,
@@ -58,9 +58,9 @@ const consumeAsset = async (did) => {
   )
     
  const fixedRate = new FixedRateExchange(fixedRateExchangeAddress, consumerAccount)
-<strong> const tx =await fixedRate.buyDatatokens(fixedRateId, '1', '2')
-</strong><strong> 
-</strong><strong> const initializeData = await ProviderInstance.initialize(
+ const tx = await fixedRate.buyDatatokens(fixedRateId, '1', '2')
+ 
+<strong> const initializeData = await ProviderInstance.initialize(
 </strong>    resolvedDDO.id,
     resolvedDDO.services[0].id,
     0,
@@ -105,7 +105,7 @@ const consumeAsset = async (did) => {
 };
 
 // Call setMetadata(...) function defined above
-updateAssetState(did).then(() => {
+consumeAsset(did).then(() => {
   process.exit();
 }).catch((err) => {
   console.error(err);