@oceanprotocol/lib 4.1.4 → 4.2.1

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

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

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

@@ -21,7 +21,7 @@ export declare class Aquarius {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<Asset>} Asset
      */
-    resolve(did: string, signal?: AbortSignal): Promise<Asset>;
+    resolve(did: string, signal?: AbortSignal, authorization?: string): Promise<Asset>;
     /**
      * Blocks until Indexer will cache the did (or the update for that did) or timeouts
      * @param {string} did DID of the asset.
@@ -29,7 +29,7 @@ export declare class Aquarius {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<Asset>} DDO of the asset.
      */
-    waitForIndexer(did: string, txid?: string, signal?: AbortSignal, interval?: number, maxRetries?: number): Promise<Asset>;
+    waitForIndexer(did: string, txid?: string, signal?: AbortSignal, interval?: number, maxRetries?: number, authorization?: string): Promise<Asset>;
     /**
      * Validate DDO content
      * @param {DDO} ddo DID Descriptor Object content.
@@ -38,19 +38,19 @@ export declare class Aquarius {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ValidateMetadata>}.
      */
-    validate(ddo: DDO, signer: Signer, providerUrl: string, signal?: AbortSignal): Promise<ValidateMetadata>;
+    validate(ddo: DDO, signer: Signer, providerUrl: string, signal?: AbortSignal, authorization?: string): Promise<ValidateMetadata>;
     /**
      * Search over the DDOs using a query.
      * @param {string} did DID of the asset
      * @param {AbortSignal} signal abort signal
      * @return {Promise<QueryResult>}
      */
-    getAssetMetadata(did: string, signal?: AbortSignal): Promise<any>;
+    getAssetMetadata(did: string, signal?: AbortSignal, authorization?: string): Promise<any>;
     /**
      * Search over the DDOs using a query.
      * @param  {SearchQuery} query Query to filter the DDOs.
      * @param {AbortSignal} signal abort signal
      * @return {Promise<QueryResult>}
      */
-    querySearch(query: SearchQuery, signal?: AbortSignal): Promise<any>;
+    querySearch(query: SearchQuery, signal?: AbortSignal, authorization?: string): Promise<any>;
 }

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

@@ -1,12 +1,15 @@
 import { Signer } from 'ethers';
 import { Arweave, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UrlFile, UserCustomParameters, Ipfs, ComputeResourceRequest } from '../@types';
 export declare class Provider {
+    private getConsumerAddress;
+    private getSignature;
+    private getAuthorization;
     /**
      * Returns the provider endpoints
      * @param {string} providerUri - the provider url
      * @return {Promise<any>}
      */
-    getEndpoints(providerUri: string): Promise<any>;
+    getEndpoints(providerUri: string, authorization?: string): Promise<any>;
     /**
      * This function returns the endpoint URL for a given service name.
      * @param {ServiceEndpoint[]} servicesEndpoints - The array of service endpoints
@@ -105,11 +108,13 @@ 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 {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): Promise<ProviderComputeInitializeResults>;
+    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, providerUri: string, signerOrAuthToken: Signer | string, resources: ComputeResourceRequest[], chainId: number, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
     /**
      * Gets the download URL.
      * @param {string} did - The DID.
@@ -117,12 +122,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 {SignerOrAuthToken} signerOrAuthToken - The signer or auth token.
      * @param {any} 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): Promise<any>;
+    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, signerOrAuthToken: Signer | string, policyServer?: any, 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.
@@ -138,7 +143,7 @@ export declare class Provider {
     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.
@@ -150,11 +155,11 @@ export declare class Provider {
      * @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)
+    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)
     output?: ComputeOutput, 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.
@@ -163,27 +168,27 @@ export declare class Provider {
      * @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): Promise<ComputeJob | ComputeJob[]>;
+    freeComputeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], output?: ComputeOutput, 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): 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): 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
@@ -192,24 +197,41 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ComputeJob | ComputeJob[]>}
      */
-    computeStatus(providerUri: string, consumerAddress: string, jobId?: string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    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): 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): 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
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    generateAuthToken(consumer: Signer, providerUri: string, signal?: AbortSignal): Promise<string>;
+    /** Generates an auth token
+     * @param {Signer} consumer consumer Signer wallet object
+     * @param {string} token The auth token to invalidate
+     * @param {string} providerUri The URI of the provider we want to query
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    invalidateAuthToken(consumer: Signer, token: string, providerUri: string, signal?: AbortSignal): Promise<{
+        success: boolean;
+    }>;
     /** Check for a valid provider at URL
      * @param {String} url provider uri address
      * @param {AbortSignal} signal abort signal

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

@@ -20,4 +20,4 @@ export declare function getOceanArtifactsAddressesByChainId(chain: number): any;
  * @returns index of the template on the list
  */
 export declare function calculateActiveTemplateIndex(owner: Signer, nftContractAddress: string, // addresses.ERC721Factory,
-template: string | number, chainID: number): Promise<number>;
+template: string | number, chainID?: number): Promise<number>;

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.1.4",
+  "version": "4.2.1",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.cjs",
   "umd:main": "dist/lib.umd.js",
@@ -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",
@@ -86,7 +88,7 @@
     "cross-env": "^7.0.3",
     "eslint": "^8.23.1",
     "eslint-config-oceanprotocol": "^2.0.3",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^10.1.5",
     "eslint-plugin-prettier": "^4.2.1",
     "fs": "0.0.1-security",
     "microbundle": "0.14.2",