@oceanprotocol/lib 4.2.0 → 4.3.0

package/dist/types/@types/Compute.d.ts

@@ -56,6 +56,9 @@ export interface ComputeResult {
     type: ComputeResultType;
     index?: number;
 }
+export type ComputeJobMetadata = {
+    [key: string]: string | number | boolean;
+};
 export interface ComputeJob {
     owner: string;
     did?: string;
@@ -69,6 +72,7 @@ export interface ComputeJob {
     algoDID?: string;
     agreementId?: string;
     expireTimestamp: number;
+    metadata?: ComputeJobMetadata;
 }
 export interface ComputeOutput {
     publishAlgorithmLog?: boolean;

package/dist/types/@types/Jwt.d.ts

@@ -0,0 +1,5 @@
+export interface JwtPayload {
+    address: string;
+    nonce: string;
+    createdAt: number;
+}

package/dist/types/@types/PolicyServer.d.ts

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

package/dist/types/services/Provider.d.ts

@@ -1,6 +1,10 @@
 import { Signer } from 'ethers';
-import { Arweave, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UrlFile, UserCustomParameters, Ipfs, ComputeResourceRequest } from '../@types';
+import { Arweave, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UrlFile, UserCustomParameters, Ipfs, ComputeResourceRequest, ComputeJobMetadata } from '../@types';
+import { PolicyServer } from '../@types/PolicyServer.js';
 export declare class Provider {
+    private getConsumerAddress;
+    private getSignature;
+    private getAuthorization;
     /**
      * Returns the provider endpoints
      * @param {string} providerUri - the provider url
@@ -30,7 +34,7 @@ export declare class Provider {
      * @param {string} serviceEndpoints document description object (DDO)=
      * @return {Promise<string>} urlDetails
      */
-    getNonce(providerUri: string, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[], authorization?: string): Promise<number>;
+    getNonce(providerUri: string, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[]): Promise<number>;
     /**
      * Sign a provider request with a signer.
      * @param {Signer} signer - The signer to use.
@@ -46,7 +50,7 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<string>} urlDetails
      */
-    encrypt(data: any, chainId: number, providerUri: string, signal?: AbortSignal, authorization?: string): Promise<string>;
+    encrypt(data: any, chainId: number, providerUri: string, signal?: AbortSignal): Promise<string>;
     /**
      * Get file details for a given DID and service ID.
      * @param {string} did - The DID to check.
@@ -56,7 +60,7 @@ export declare class Provider {
      * @param {AbortSignal} [signal] - An optional abort signal.
      * @returns {Promise<FileInfo[]>} A promise that resolves with an array of file info objects.
      */
-    checkDidFiles(did: string, serviceId: string, providerUri: string, withChecksum?: boolean, signal?: AbortSignal, authorization?: string): Promise<FileInfo[]>;
+    checkDidFiles(did: string, serviceId: string, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
     /**
      * Get File details (if possible)
      * @param {UrlFile | Arweave | Ipfs | GraphqlQuery | Smartcontract} file one of the supported file structures
@@ -65,14 +69,14 @@ export declare class Provider {
      * @param {AbortSignal} [signal] - An optional abort signal.
      * @returns {Promise<FileInfo[]>} A promise that resolves with an array of file info objects.
      */
-    getFileInfo(file: UrlFile | Arweave | Ipfs, providerUri: string, withChecksum?: boolean, signal?: AbortSignal, authorization?: string): Promise<FileInfo[]>;
+    getFileInfo(file: UrlFile | Arweave | Ipfs, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
     /**
      * Returns compute environments from a provider.
      * @param {string} providerUri - The URI of the provider.
      * @param {AbortSignal} [signal] - An optional abort signal.
      * @returns {Promise<{[chainId: number]: ComputeEnvironment[]}>} A promise that resolves with an object containing compute environments for each chain ID.
      */
-    getComputeEnvironments(providerUri: string, signal?: AbortSignal, authorization?: string): Promise<ComputeEnvironment[]>;
+    getComputeEnvironments(providerUri: string, signal?: AbortSignal): Promise<ComputeEnvironment[]>;
     /**
      * Initializes the provider for a service request.
      * @param {string} did - The asset DID .
@@ -86,7 +90,7 @@ export declare class Provider {
      * @param {number} [validUntil] - The validity time if any.
      * @returns {Promise<ProviderInitialize>} A promise that resolves with ProviderInitialize response.
      */
-    initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, providerUri: string, signal?: AbortSignal, userCustomParameters?: UserCustomParameters, computeEnv?: string, validUntil?: number, authorization?: string): Promise<ProviderInitialize>;
+    initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, providerUri: string, signal?: AbortSignal, userCustomParameters?: UserCustomParameters, computeEnv?: string, validUntil?: number): Promise<ProviderInitialize>;
     /** Initializes the provider for a compute request.
      * @param {ComputeAsset[]} assets The datasets array to initialize compute request.
      * @param {ComputeAlgorithmber} algorithm The algorithm to use.
@@ -97,7 +101,7 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ProviderComputeInitialize>} ProviderComputeInitialize data
      */
-    initializeComputeV1(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, providerUri: string, accountId: string, chainId: number, token: string, maxJobDuration: number, signal?: AbortSignal, authorization?: string): Promise<ProviderComputeInitializeResults>;
+    initializeComputeV1(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, providerUri: string, accountId: string, chainId: number, token: string, maxJobDuration: number, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
     /** Initializes the provider for a compute request.
      * @param {ComputeAsset[]} assets The datasets array to initialize compute request.
      * @param {ComputeAlgorithmber} algorithm The algorithm to use.
@@ -105,11 +109,14 @@ export declare class Provider {
      * @param {string} token The payment token address.
      * @param {number} validUntil  The job expiration date.
      * @param {string} providerUri The provider URI.
-     * @param {Signer} signer caller address
+     * @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
      */
-    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, providerUri: string, signer: Signer, resources: ComputeResourceRequest[], signal?: AbortSignal, authorization?: string): Promise<ProviderComputeInitializeResults>;
+    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, providerUri: string, signerOrAuthToken: Signer | string, resources: ComputeResourceRequest[], chainId: number, policyServer?: PolicyServer, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
     /**
      * Gets the download URL.
      * @param {string} did - The DID.
@@ -117,12 +124,12 @@ export declare class Provider {
      * @param {number} fileIndex - The file index.
      * @param {string} transferTxId - The transfer transaction ID.
      * @param {string} providerUri - The provider URI.
-     * @param {Signer} signer - The signer.
-     * @param {any} policyServer - The policy server (if any is to be used).
+     * @param {SignerOrAuthToken} signerOrAuthToken - The signer or auth token.
+     * @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.
      */
-    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, signer: Signer, policyServer?: any, userCustomParameters?: UserCustomParameters, authorization?: string): Promise<any>;
+    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, signerOrAuthToken: Signer | string, policyServer?: PolicyServer, userCustomParameters?: UserCustomParameters): Promise<any>;
     /** Instruct the provider to start a compute job (Old C2D V1) Kept for now, for backwards compatibility
      * @param {string} providerUri The provider URI.
      * @param {Signer} signer The consumer signer object.
@@ -135,10 +142,10 @@ export declare class Provider {
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      * @deprecated Use {@link computeStart} instead.
      */
-    computeStartV1(providerUri: string, consumer: Signer, computeEnv: string, dataset: ComputeAsset, algorithm: ComputeAlgorithm, signal?: AbortSignal, additionalDatasets?: ComputeAsset[], output?: ComputeOutput, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
+    computeStartV1(providerUri: string, consumer: Signer, computeEnv: string, dataset: ComputeAsset, algorithm: ComputeAlgorithm, signal?: AbortSignal, additionalDatasets?: ComputeAsset[], output?: ComputeOutput): Promise<ComputeJob | ComputeJob[]>;
     /** Instruct the provider to start a PAYED compute job (new C2D V2)
      * @param {string} providerUri The provider URI.
-     * @param {Signer} signer The consumer signer object.
+     * @param {SignerOrAuthToken} signerOrAuthToken The consumer signer object or auth token.
      * @param {string} computeEnv The compute environment.
      * @param {ComputeAsset} datasets The dataset to start compute on + additionalDatasets (the additional datasets if that is the case)
      * @param {ComputeAlgorithm} algorithm The algorithm to start compute with.
@@ -146,44 +153,48 @@ export declare class Provider {
      * @param {string} token The token address for compute payment.
      * @param {ComputeResourceRequest} resources The resources to start compute job with.
      * @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.
      */
-    computeStart(providerUri: string, consumer: Signer, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, maxJobDuration: number, token: string, resources: ComputeResourceRequest[], chainId?: number, // network used by payment (only for payed compute jobs)
-    output?: ComputeOutput, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
+    computeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, maxJobDuration: number, token: string, resources: ComputeResourceRequest[], chainId: number, // network used by payment (only for payed compute jobs)
+    metadata?: ComputeJobMetadata, output?: ComputeOutput, policyServer?: PolicyServer, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
     /** Instruct the provider to start a FREE compute job (new C2D V2)
      * @param {string} providerUri The provider URI.
-     * @param {Signer} signer The consumer signer object.
+     * @param {SignerOrAuthToken} signerOrAuthToken The consumer signer object or auth token.
      * @param {string} computeEnv The compute environment.
      * @param {ComputeAsset} datasets The dataset to start compute on + additionalDatasets (the additional datasets if that is the case)
      * @param {ComputeAlgorithm} algorithm The algorithm to start compute with.
      * @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.
      */
-    freeComputeStart(providerUri: string, consumer: Signer, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], output?: ComputeOutput, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
+    freeComputeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], metadata?: ComputeJobMetadata, output?: ComputeOutput, policyServer?: PolicyServer, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
     /**
      *
      * @param providerUri provider URL
-     * @param consumer consumer
+     * @param signerOrAuthToken signer or auth token
      * @param jobId jobId
      * @param signal abort signal
      * @returns logs response
      */
-    computeStreamableLogs(providerUri: string, signer: Signer, jobId: string, signal?: AbortSignal, authorization?: string): Promise<any>;
+    computeStreamableLogs(providerUri: string, signerOrAuthToken: Signer | string, jobId: string, signal?: AbortSignal): Promise<any>;
     getComputeStartRoutes(providerUri: string, isFreeCompute?: boolean): Promise<string | null>;
     /** Instruct the provider to Stop the execution of a to stop a compute job.
      * @param {string} did the asset did
      * @param {string} consumerAddress The consumer address.
      * @param {string} jobId the compute job id
      * @param {string} providerUri The provider URI.
-     * @param {Signer} signer The consumer signer object.
+     * @param {SignerOrAuthToken} signerOrAuthToken The consumer signer or auth token.
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ComputeJob | ComputeJob[]>}
      */
-    computeStop(did: string, consumerAddress: string, jobId: string, providerUri: string, signer: Signer, agreementId?: string, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
+    computeStop(did: string, consumerAddress: string, jobId: string, providerUri: string, signerOrAuthToken: Signer | string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
     /** Get compute status for a specific jobId/documentId/owner.
      * @param {string} providerUri The URI of the provider we want to query
      * @param {string} consumerAddress The consumer ethereum address
@@ -195,21 +206,21 @@ export declare class Provider {
     computeStatus(providerUri: string, consumerAddress: string, jobId?: string, agreementId?: string, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
     /** Get compute result url
      * @param {string} providerUri The URI of the provider we want to query
-     * @param {Signer} consumer consumer Signer wallet object
+     * @param {SignerOrAuthToken} signerOrAuthToken signer or auth token
      * @param {string} jobId The ID of a compute job.
      * @param {number} index Result index
      * @return {Promise<string>}
      */
-    getComputeResultUrl(providerUri: string, consumer: Signer, jobId: string, index: number, authorization?: string): Promise<string>;
+    getComputeResultUrl(providerUri: string, signerOrAuthToken: Signer | string, jobId: string, index: number): Promise<string>;
     /** Deletes a compute job.
      * @param {string} did asset did
-     * @param {Signer} consumer consumer Signer wallet object
+     * @param {SignerOrAuthToken} signerOrAuthToken signer or auth token
      * @param {string} jobId the compute job ID
      * @param {string} providerUri The URI of the provider we want to query
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ComputeJob | ComputeJob[]>}
      */
-    computeDelete(did: string, consumer: Signer, jobId: string, providerUri: string, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
+    computeDelete(did: string, signerOrAuthToken: Signer | string, jobId: string, providerUri: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
     /** Generates an auth token
      * @param {Signer} consumer consumer Signer wallet object
      * @param {string} providerUri The URI of the provider we want to query
@@ -232,7 +243,7 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<boolean>} valid or not
      */
-    isValidProvider(url: string, signal?: AbortSignal, authorization?: string): Promise<boolean>;
+    isValidProvider(url: string, signal?: AbortSignal): Promise<boolean>;
     /**
      * Private method that removes the leading 0x from a string.
      * @param {string} input - The input string.

package/dist/types/utils/Jwt.d.ts

@@ -0,0 +1,2 @@
+import { JwtPayload } from '../@types/Jwt';
+export declare function decodeJwt(token: string): JwtPayload;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.cjs",
   "umd:main": "dist/lib.umd.js",
@@ -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",
@@ -66,7 +66,8 @@
     "crypto-js": "^4.1.1",
     "decimal.js": "^10.4.1",
     "ethers": "^5.7.2",
-    "form-data": "^2.3.3"
+    "form-data": "^2.3.3",
+    "jsonwebtoken": "^9.0.2"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
@@ -74,6 +75,7 @@
     "@types/chai": "^4.3.1",
     "@types/chai-spies": "^1.0.3",
     "@types/crypto-js": "^4.1.1",
+    "@types/jsonwebtoken": "^9.0.10",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.0.1",
     "@types/node-fetch": "^3.0.3",