Add policyServer object in compute routes. (#1964)

* Add policyServer object in compute routes.

* Fix datasets samples. Fix node logs file location from ci.

* Added print for payment assert.

* Fix assert.

* Update ddo.js

* Update lock file.

* Tweak dataset.

* Test.

* Put back the updated structure.

* Updating ComputeExamples.md

---------

Co-authored-by: GitHub Actions Bot <>

Author: mariacarmina

.github/workflows/ci.yml

@@ -173,7 +173,7 @@ jobs:
         if: ${{ failure() }}
         run: |
           echo "========== Ocean Node Logs =========="
-          tac ${{ github.workspace }}/ocean-node/start-node.log || echo "Log file not found"
+          tac ${{ github.workspace }}/barge/start-node.log || echo "Log file not found"
       - name: Upload coverage
         uses: actions/upload-artifact@v4
         with:

ComputeExamples.md

@@ -214,7 +214,13 @@ const DATASET_DDO: DDO = {
       timeout: 300,
       compute: {
         publisherTrustedAlgorithmPublishers: ['*'] as any,
-        publisherTrustedAlgorithms: ['*'] as any,
+        publisherTrustedAlgorithms: [
+          {
+            did: '*',
+            filesChecksum: '*',
+            containerSectionChecksum: '*'
+          }
+        ] as any,
         allowRawAlgorithm: false,
         allowNetworkAccess: true
       }

package-lock.json

@@ -58,7 +58,7 @@
   "dependencies": {
     "@oasisprotocol/sapphire-paratime": "^1.3.2",
     "@oceanprotocol/contracts": "^2.3.0",
-    "@oceanprotocol/ddo-js": "^0.1.0",
+    "@oceanprotocol/ddo-js": "^0.1.2",
     "@rdfjs/dataset": "^2.0.2",
     "@rdfjs/formats-common": "^3.1.0",
     "@zazuko/env-node": "^2.1.4",

package.json

@@ -0,0 +1,7 @@
+export interface PolicyServer {
+  sessionId?: string
+  successRedirectUri?: string
+  errorRedirectUri?: string
+  responseRedirectUri?: string
+  presentationDefinitionUri?: string
+}

src/@types/PolicyServer.ts

@@ -20,6 +20,7 @@ import {
   ComputeJobMetadata
 } from '../@types'
 import { decodeJwt } from '../utils/Jwt.js'
+import { PolicyServer } from '../@types/PolicyServer.js'
 
 export class Provider {
   private async getConsumerAddress(signerOrAuthToken: Signer | string): Promise<string> {
@@ -512,6 +513,7 @@ export class Provider {
    * @param {SignerOrAuthToken} signerOrAuthToken Signer or auth token
    * @param {ComputeResourceRequest[]} resources The resources to start compute job with.
    * @param {number} chainId The chain used to do payments
+   * @param {PolicyServer} policyServer The policy server object.
    * @param {AbortSignal} signal abort signal
    * @return {Promise<ProviderComputeInitialize>} ProviderComputeInitialize data
    */
@@ -525,6 +527,7 @@ export class Provider {
     signerOrAuthToken: Signer | string,
     resources: ComputeResourceRequest[],
     chainId: number,
+    policyServer?: PolicyServer,
     signal?: AbortSignal
   ): Promise<ProviderComputeInitializeResults> {
     const providerEndpoints = await this.getEndpoints(providerUri)
@@ -556,7 +559,7 @@ export class Provider {
     signatureMessage += nonce
     const signature = await this.getSignature(signerOrAuthToken, signatureMessage)
 
-    const providerData: Object = {
+    const providerData: Record<string, any> = {
       datasets: assets,
       algorithm,
       environment: computeEnv,
@@ -570,6 +573,8 @@ export class Provider {
       signature
     }
 
+    if (policyServer) providerData.policyServer = policyServer
+
     let response
     try {
       console.log('Initialize compute url:', initializeUrl)
@@ -615,7 +620,7 @@ export class Provider {
    * @param {string} transferTxId - The transfer transaction ID.
    * @param {string} providerUri - The provider URI.
    * @param {SignerOrAuthToken} signerOrAuthToken - The signer or auth token.
-   * @param {any} policyServer - The policy server (if any is to be used).
+   * @param {PolicyServer} policyServer - The policy server (if any is to be used).
    * @param {UserCustomParameters} userCustomParameters - The user custom parameters.
    * @returns {Promise<any>} The download URL.
    */
@@ -626,7 +631,7 @@ export class Provider {
     transferTxId: string,
     providerUri: string,
     signerOrAuthToken: Signer | string,
-    policyServer?: any,
+    policyServer?: PolicyServer,
     userCustomParameters?: UserCustomParameters
   ): Promise<any> {
     const providerEndpoints = await this.getEndpoints(providerUri)
@@ -763,6 +768,7 @@ export class Provider {
    * @param {chainId} chainId The chain used to do payments
    * @param {ComputeJobMetadata} metadata The compute job metadata. Additional metadata to be stored in the database.
    * @param {ComputeOutput} output The compute job output settings.
+   * @param {PolicyServer} policyServer The policy server object.
    * @param {AbortSignal} signal abort signal
    * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
    */
@@ -778,6 +784,7 @@ export class Provider {
     chainId: number, // network used by payment (only for payed compute jobs)
     metadata?: ComputeJobMetadata,
     output?: ComputeOutput,
+    policyServer?: PolicyServer,
     signal?: AbortSignal
   ): Promise<ComputeJob | ComputeJob[]> {
     console.log('called new compute start method...')
@@ -837,6 +844,7 @@ export class Provider {
     if (metadata) payload.metadata = metadata
     // if (additionalDatasets) payload.additionalDatasets = additionalDatasets
     if (output) payload.output = output
+    if (policyServer) payload.policyServer = policyServer
     let response
     try {
       response = await fetch(computeStartUrl, {
@@ -877,6 +885,7 @@ export class Provider {
    * @param {ComputeResourceRequest} resources The resources to start compute job with.
    * @param {ComputeJobMetadata} metadata The compute job metadata. Additional metadata to be stored in the database.
    * @param {ComputeOutput} output The compute job output settings.
+   * @param {PolicyServer} policyServer The policy server object.
    * @param {AbortSignal} signal abort signal
    * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
    */
@@ -889,6 +898,7 @@ export class Provider {
     resources?: ComputeResourceRequest[],
     metadata?: ComputeJobMetadata,
     output?: ComputeOutput,
+    policyServer?: PolicyServer,
     signal?: AbortSignal
   ): Promise<ComputeJob | ComputeJob[]> {
     console.log('called new free compute start method...')
@@ -939,6 +949,7 @@ export class Provider {
     if (metadata) payload.metadata = metadata
     // if (additionalDatasets) payload.additionalDatasets = additionalDatasets
     payload.output = output
+    if (policyServer) payload.policyServer = policyServer
     let response
     try {
       response = await fetch(computeStartUrl, {

src/services/Provider.ts

@@ -220,7 +220,7 @@ const DATASET_DDO: DDO = {
             filesChecksum: '*',
             containerSectionChecksum: '*'
           }
-        ],
+        ] as any,
         allowRawAlgorithm: false,
         allowNetworkAccess: true
       }

test/integration/ComputeExamples.test.ts

@@ -55,6 +55,7 @@ let escrow: EscrowContract
 let freeComputeRouteSupport = null
 
 const computeJobDuration = 60 * 15 // 15 minutes
+let computeMinutes: number
 
 const assetUrl: Files = {
   datatokenAddress: '0x0',
@@ -495,7 +496,7 @@ describe('Compute flow tests', async () => {
 
   it('Should fast forward time and set a new computeValidUntil', async () => {
     const mytime = new Date()
-    const computeMinutes = 2
+    computeMinutes = 2
     mytime.setMinutes(mytime.getMinutes() + computeMinutes)
     computeValidUntil = Math.floor(mytime.getTime() / 1000)
   })
@@ -613,8 +614,8 @@ describe('Compute flow tests', async () => {
     assert(
       Number(
         ethers.utils.formatUnits(providerInitializeComputeResults.payment.amount, 18)
-      ) >=
-        (computeEnv.maxJobDuration / 60) * price,
+      ) ===
+        (computeEnv.maxJobDuration / 60) * price * computeMinutes,
       'Incorrect payment token amount'
     ) // 60 minutes per price 1 -> amount = 60
     assert(