@oceanprotocol/lib 3.4.3 → 4.0.0-next.1

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

@@ -16,6 +16,7 @@ export interface ComputeEnvironment {
     storageExpiry: number;
     maxJobDuration: number;
     lastSeen: number;
+    free: boolean;
 }
 export interface ComputeResult {
     filename: string;
@@ -49,7 +50,36 @@ export interface ComputeOutput {
     secretStoreUri?: string;
     whitelist?: string[];
 }
+export declare enum FileObjectType {
+    URL = "url",
+    IPFS = "ipfs",
+    ARWEAVE = "arweave"
+}
+export declare enum EncryptMethod {
+    AES = "AES",
+    ECIES = "ECIES"
+}
+export interface HeadersObject {
+    [key: string]: string;
+}
+export interface BaseFileObject {
+    type: string;
+    encryptedBy?: string;
+    encryptMethod?: EncryptMethod;
+}
+export interface UrlFileObject extends BaseFileObject {
+    url: string;
+    method: string;
+    headers?: [HeadersObject];
+}
+export interface IpfsFileObject extends BaseFileObject {
+    hash: string;
+}
+export interface ArweaveFileObject extends BaseFileObject {
+    transactionId: string;
+}
 export interface ComputeAsset {
+    fileObject?: BaseFileObject;
     documentId: string;
     serviceId: string;
     transferTxId?: string;
@@ -58,6 +88,7 @@ export interface ComputeAsset {
     };
 }
 export interface ComputeAlgorithm {
+    fileObject?: BaseFileObject;
     documentId?: string;
     serviceId?: string;
     meta?: MetadataAlgorithm;

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

@@ -99,7 +99,18 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ProviderComputeInitialize>} ProviderComputeInitialize data
      */
-    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, validUntil: number, providerUri: string, accountId: string, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
+    initializeComputeV1(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, validUntil: number, providerUri: string, accountId: string, 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.
+     * @param {string} computeEnv The compute environment.
+     * @param {number} validUntil  The job expiration date.
+     * @param {string} providerUri The provider URI.
+     * @param {Signer} signer caller address
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ProviderComputeInitialize>} ProviderComputeInitialize data
+     */
+    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, validUntil: number, providerUri: string, signer: Signer, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
     /**
      * Gets the download URL.
      * @param {string} did - The DID.
@@ -112,7 +123,7 @@ export declare class Provider {
      * @returns {Promise<any>} The download URL.
      */
     getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, signer: Signer, userCustomParameters?: UserCustomParameters): Promise<any>;
-    /** Instruct the provider to start a compute job
+    /** 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.
      * @param {string} computeEnv The compute environment.
@@ -123,7 +134,19 @@ export declare class Provider {
      * @param {ComputeOutput} output The compute job output settings.
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      */
-    computeStart(providerUri: string, consumer: Signer, computeEnv: string, dataset: ComputeAsset, algorithm: ComputeAlgorithm, signal?: AbortSignal, additionalDatasets?: ComputeAsset[], output?: ComputeOutput): 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 compute job (new C2D V2)
+     * @param {string} providerUri The provider URI.
+     * @param {Signer} signer The consumer signer object.
+     * @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 {AbortSignal} signal abort signal
+     * @param {ComputeOutput} output The compute job output settings.
+     * @param {boolean} freeEnvironment is it a free environment? uses different route
+     * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
+     */
+    computeStart(providerUri: string, consumer: Signer, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, signal?: AbortSignal, output?: ComputeOutput, freeEnvironment?: boolean): Promise<ComputeJob | ComputeJob[]>;
     /** 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.

package/docs/classes/Provider.md

@@ -485,7 +485,7 @@ Initializes the provider for a compute request.
 | `computeEnv` | `string` | The compute environment. |
 | `validUntil` | `number` | The job expiration date. |
 | `providerUri` | `string` | The provider URI. |
-| `accountId` | `string` | caller address |
+| `signer` | `Signer` | caller account |
 | `signal?` | `AbortSignal` | abort signal |
 
 #### Returns

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "3.4.3",
+  "version": "4.0.0-next.1",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.js",
   "umd:main": "dist/lib.umd.js",