@oceanprotocol/lib 6.0.0 → 6.1.0

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

@@ -1,4 +1,5 @@
-import { Metadata, MetadataAlgorithm, ConsumerParameter } from '@oceanprotocol/ddo-js';
+import { MetadataAlgorithm, ConsumerParameter } from '@oceanprotocol/ddo-js';
+import { StorageObject, EncryptMethod } from './File';
 export type ComputeResultType = 'algorithmLog' | 'output' | 'configrationLog' | 'publishLog';
 export interface RunningPlatform {
     architecture: string;
@@ -94,48 +95,16 @@ export interface ComputeJob {
         OOMKilled?: boolean;
     };
 }
+export interface ComputeOutputEncryption {
+    encryptMethod: EncryptMethod.AES;
+    key: string;
+}
 export interface ComputeOutput {
-    publishAlgorithmLog?: boolean;
-    publishOutput?: boolean;
-    providerAddress?: string;
-    providerUri?: string;
-    metadata?: Metadata;
-    metadataUri?: string;
-    nodeUri?: string;
-    owner?: string;
-    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;
+    remoteStorage?: StorageObject;
+    encryption?: ComputeOutputEncryption;
 }
 export interface ComputeAsset {
-    fileObject?: BaseFileObject;
+    fileObject?: StorageObject;
     documentId: string;
     serviceId: string;
     transferTxId?: string;
@@ -157,7 +126,7 @@ export interface ExtendedMetadataAlgorithm extends MetadataAlgorithm {
     };
 }
 export interface ComputeAlgorithm {
-    fileObject?: BaseFileObject;
+    fileObject?: StorageObject;
     documentId?: string;
     serviceId?: string;
     meta?: ExtendedMetadataAlgorithm;

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

@@ -1,4 +1,9 @@
-import { ProviderFees } from '.';
+import { ProviderFees, StorageObject } from '.';
+export interface AssetFiles {
+    nftAddress: string;
+    datatokenAddress: string;
+    files: StorageObject[];
+}
 export interface DatatokenCreateParams {
     templateIndex: number;
     minter: string;
@@ -9,7 +14,7 @@ export interface DatatokenCreateParams {
     cap: string;
     name?: string;
     symbol?: string;
-    filesObject?: any;
+    filesObject?: AssetFiles;
     accessListFactory?: string;
     allowAccessList?: string;
     denyAccessList?: string;

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

@@ -1,48 +1,41 @@
-interface FileTypeHeaders {
+export interface HeadersObject {
     [key: string]: string;
 }
-export interface UrlFile {
-    type: 'url';
-    /**
-     * File index.
-     * @type {number}
-     */
-    index?: number;
-    /**
-     * File URL.
-     * @type {string}
-     */
+export declare enum EncryptMethod {
+    AES = "AES",
+    ECIES = "ECIES"
+}
+export interface BaseFileObject {
+    type: string;
+    encryptedBy?: string;
+    encryptMethod?: EncryptMethod;
+}
+export interface UrlFileObject extends BaseFileObject {
     url: string;
-    /**
-     * HTTP method used
-     * @type {string}
-     */
     method: string;
-    /**
-     * Headers key value pairs associated with the asset GET request
-     * @type {string}
-     */
-    headers?: FileTypeHeaders;
-}
-export interface Arweave {
-    type: 'arweave';
-    /**
-     * transactionId
-     * @type {string}
-     */
-    transactionId: string;
+    headers?: HeadersObject;
 }
-export interface Ipfs {
-    type: 'ipfs';
-    /**
-     * hash
-     * @type {string}
-     */
+export interface IpfsFileObject extends BaseFileObject {
     hash: string;
 }
-export interface Files {
-    nftAddress: string;
-    datatokenAddress: string;
-    files: UrlFile[] | Arweave[] | Ipfs[];
+export interface ArweaveFileObject extends BaseFileObject {
+    transactionId: string;
+}
+export interface S3Object {
+    endpoint: string;
+    region?: string;
+    objectKey: string;
+    bucket: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+    /** If true, use path-style addressing (e.g. endpoint/bucket/key). Required for some S3-compatible services (e.g. MinIO). Default false (virtual-host style, e.g. bucket.endpoint/key). */
+    forcePathStyle?: boolean;
+}
+export interface S3FileObject extends BaseFileObject {
+    s3Access: S3Object;
+}
+export interface FtpFileObject extends BaseFileObject {
+    /** Full FTP or FTPS URL: ftp://[user:password@]host[:port]/path or ftps://... */
+    url: string;
 }
-export {};
+export type StorageObject = UrlFileObject | IpfsFileObject | ArweaveFileObject | S3FileObject | FtpFileObject;

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

@@ -1,5 +1,5 @@
 import { Signer } from 'ethers';
-import { Arweave, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UrlFile, UserCustomParameters, Ipfs, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth } from '../@types';
+import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth } from '../@types';
 export declare class Provider {
     private getConsumerAddress;
     private getSignature;
@@ -60,13 +60,13 @@ export declare class Provider {
     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
+     * @param {StorageObject} file one of the supported file structures
      * @param {string} providerUri uri of the provider that will be used to check the file
      * @param {boolean} [withChecksum=false] - Whether or not to include a checksum.
      * @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): Promise<FileInfo[]>;
+    getFileInfo(file: StorageObject, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
     /**
      * Returns compute environments from a provider.
      * @param {string} providerUri - The URI of the provider.
@@ -112,11 +112,11 @@ export declare class Provider {
      * @param {ComputeResourceRequest[]} resources The resources to start compute job with.
      * @param {number} chainId The chain used to do payments
      * @param {any} policyServer Policy server data.
-     * @param {dockerRegistryAuth} dockerRegistryAuth Docker registry authentication data.
      * @param {AbortSignal} signal abort signal
+     * @param {dockerRegistryAuth} dockerRegistryAuth Docker registry authentication data.
      * @return {Promise<ProviderComputeInitialize>} ProviderComputeInitialize data
      */
-    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, providerUri: string, signerOrAuthToken: Signer | string, resources: ComputeResourceRequest[], chainId: number, policyServer?: any, dockerRegistryAuth?: dockerRegistryAuth, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
+    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, providerUri: string, signerOrAuthToken: Signer | string, resources: ComputeResourceRequest[], chainId: number, policyServer?: any, signal?: AbortSignal, dockerRegistryAuth?: dockerRegistryAuth): Promise<ProviderComputeInitializeResults>;
     /**
      * Gets the download URL.
      * @param {string} did - The DID.
@@ -130,20 +130,7 @@ export declare class Provider {
      * @returns {Promise<any>} The download URL.
      */
     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} consumer The consumer signer object.
-     * @param {string} computeEnv The compute environment.
-     * @param {ComputeAsset} dataset The dataset to start compute on
-     * @param {ComputeAlgorithm} algorithm The algorithm to start compute with.
-     * @param {AbortSignal} signal abort signal
-     * @param {ComputeAsset[]} additionalDatasets The additional datasets if that is the case.
-     * @param {ComputeOutput} output The compute job output settings.
-     * @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): Promise<ComputeJob | ComputeJob[]>;
-    /** Instruct the provider to start a PAYED compute job (new C2D V2)
+    /** Instruct the provider to start a PAYED compute job
      * @param {string} providerUri The provider URI.
      * @param {SignerOrAuthToken} signerOrAuthToken The consumer signer object or auth token.
      * @param {string} computeEnv The compute environment.
@@ -158,11 +145,12 @@ export declare class Provider {
      * @param {any} policyServer Policy server data.
      * @param {AbortSignal} signal abort signal
      * @param {number} queueMaxWaitTime Maximum time in seconds to wait in the compute queue if resources are not available
+     * @param {dockerRegistryAuth} dockerRegistryAuth Docker registry authentication data.
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or 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)
-    metadata?: ComputeJobMetadata, additionalViewers?: string[], output?: ComputeOutput, policyServer?: any, signal?: AbortSignal, queueMaxWaitTime?: number): Promise<ComputeJob | ComputeJob[]>;
-    /** Instruct the provider to start a FREE compute job (new C2D V2)
+    metadata?: ComputeJobMetadata, additionalViewers?: string[], output?: ComputeOutput, policyServer?: any, signal?: AbortSignal, queueMaxWaitTime?: number, dockerRegistryAuth?: dockerRegistryAuth): Promise<ComputeJob | ComputeJob[]>;
+    /** Instruct the provider to start a FREE compute job
      * @param {string} providerUri The provider URI.
      * @param {SignerOrAuthToken} signerOrAuthToken The consumer signer object or auth token.
      * @param {string} computeEnv The compute environment.
@@ -174,9 +162,10 @@ export declare class Provider {
      * @param {any} policyServer Policy server data.
      * @param {AbortSignal} signal abort signal
      * @param {number} queueMaxWaitTime Maximum time in seconds to wait in the compute queue if resources are not available
+     * @param {dockerRegistryAuth} dockerRegistryAuth Docker registry authentication data.
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      */
-    freeComputeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], metadata?: ComputeJobMetadata, additionalViewers?: string[], output?: ComputeOutput, policyServer?: any, signal?: AbortSignal, queueMaxWaitTime?: number): Promise<ComputeJob | ComputeJob[]>;
+    freeComputeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], metadata?: ComputeJobMetadata, additionalViewers?: string[], output?: ComputeOutput, policyServer?: any, signal?: AbortSignal, queueMaxWaitTime?: number, dockerRegistryAuth?: dockerRegistryAuth): Promise<ComputeJob | ComputeJob[]>;
     /**
      *
      * @param providerUri provider URL

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

@@ -1,6 +1,7 @@
 import { Signer } from 'ethers';
 import { Aquarius } from '../services/Aquarius.js';
 import { DDO } from '@oceanprotocol/ddo-js';
+import { StorageObject } from '../@types/File.js';
 export declare const DEVELOPMENT_CHAIN_ID = 8996;
 export declare function useOasisSDK(network: string | number): boolean;
 /**
@@ -8,7 +9,7 @@ export declare function useOasisSDK(network: string | number): boolean;
  * @param name asset name
  * @param symbol asse symbol
  * @param owner owner address
- * @param assetUrl asset url, if present and confidential evm, add it to token create params
+ * @param assetUrl An array of StorageObjects
  * @param templateIDorAddress either template address or id
  * @param ddo ddo
  * @param encryptDDO encrypt or not?
@@ -19,7 +20,7 @@ export declare function useOasisSDK(network: string | number): boolean;
  * @param denyAccessList?: string
  * @returns ddo id as string
  */
-export declare function createAsset(name: string, symbol: string, owner: Signer, assetUrl: any, // files object
+export declare function createAsset(name: string, symbol: string, owner: Signer, assetUrls: StorageObject[], // files object
 templateIDorAddress: string | number, // If string, it's template address , otherwise, it's templateId
 ddo: DDO, encryptDDO: boolean, // default is true
 providerUrl: string, providerFeeToken: string, aquariusInstance: Aquarius, accessListFactory?: string, // access list factory address

package/package.json

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