@oceanprotocol/lib 6.1.2 → 7.0.0-next.1

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

@@ -155,3 +155,4 @@ export interface dockerRegistryAuth {
     password?: string;
     auth?: string;
 }
+export type ComputeResultStream = AsyncIterable<Uint8Array>;

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

@@ -1,12 +1,19 @@
 export interface HeadersObject {
     [key: string]: string;
 }
+export declare enum FileObjectType {
+    URL = "url",
+    IPFS = "ipfs",
+    ARWEAVE = "arweave",
+    S3 = "s3",
+    FTP = "ftp"
+}
 export declare enum EncryptMethod {
     AES = "AES",
     ECIES = "ECIES"
 }
 export interface BaseFileObject {
-    type: string;
+    type: FileObjectType | string;
     encryptedBy?: string;
     encryptMethod?: EncryptMethod;
 }

package/dist/types/config/ConfigHelper.d.ts

@@ -1,6 +1,7 @@
 import { Config } from '.';
 export declare const configHelperNetworks: Config[];
 export declare const KNOWN_CONFIDENTIAL_EVMS: number[];
+export declare const getNodeEndpointConfig: () => Partial<Config>;
 export declare class ConfigHelper {
     getAddressesFromEnv(network: string, customAddresses?: any): Partial<Config>;
     /**

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

@@ -16,7 +16,6 @@ export declare class Aquarius {
      * @param {String} aquariusURL
      */
     constructor(aquariusURL: string);
-    private getAuthorization;
     /** Resolves a DID
      * @param {string} did DID of the asset.
      * @param {AbortSignal} signal abort signal

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

@@ -1,270 +1,3 @@
-import { Signer } from 'ethers';
-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;
-    private getAuthorization;
-    /**
-     * Returns the provider endpoints
-     * @param {string} providerUri - the provider url
-     * @return {Promise<any>}
-     */
-    getEndpoints(providerUri: string, authorization?: string): Promise<any>;
-    /**
-     * Returns the node public key
-     * @return {string} The node public key
-     */
-    private getNodePublicKey;
-    /**
-     * This function returns the endpoint URL for a given service name.
-     * @param {ServiceEndpoint[]} servicesEndpoints - The array of service endpoints
-     * @param {string} serviceName - The name of the service
-     * @returns {ServiceEndpoint} The endpoint URL for the given service name
-     */
-    getEndpointURL(servicesEndpoints: ServiceEndpoint[], serviceName: string): ServiceEndpoint;
-    /**
-     * This function returns an array of service endpoints for a given provider endpoint.
-     * @param {string} providerEndpoint - The provider endpoint
-     * @param {any} endpoints - The endpoints object
-     * @returns {ServiceEndpoint[]} An array of service endpoints
-     */
-    getServiceEndpoints(providerEndpoint: string, endpoints: any): Promise<ServiceEndpoint[]>;
-    /**
-     * Get current nonce from the provider.
-     * @param {string} providerUri provider uri address
-     * @param {string} consumerAddress Publisher address
-     * @param {AbortSignal} signal abort signal
-     * @param {string} providerEndpoints Identifier of the asset to be registered in ocean
-     * @param {string} serviceEndpoints document description object (DDO)=
-     * @return {Promise<string>} urlDetails
-     */
-    getNonce(providerUri: string, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[]): Promise<number>;
-    /**
-     * Encrypt data using the Provider's own symmetric key
-     * @param {string} data data in json format that needs to be sent , it can either be a DDO or a File array
-     * @param {number} chainId network's id so provider can choose the corresponding Signer object
-     * @param {string} providerUri provider uri address
-     * @param {AbortSignal} signal abort signal
-     * @return {Promise<string>} urlDetails
-     */
-    encrypt(data: any, chainId: number, providerUri: string, signerOrAuthToken: Signer | string, policyServer?: any, signal?: AbortSignal): Promise<string>;
-    /**
-     * Get file details for a given DID and service ID.
-     * @param {string} did - The DID to check.
-     * @param {string} serviceId - The service ID to check.
-     * @param {string} providerUri - The URI of the provider.
-     * @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.
-     */
-    checkDidFiles(did: string, serviceId: string, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
-    /**
-     * Get File details (if possible)
-     * @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: StorageObject, 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): Promise<ComputeEnvironment[]>;
-    /**
-     * Initializes the provider for a service request.
-     * @param {string} did - The asset DID .
-     * @param {string} serviceId - The asset service ID.
-     * @param {number} fileIndex - The file index.
-     * @param {string} consumerAddress - The consumer address.
-     * @param {string} providerUri - The URI of the provider.
-     * @param {AbortSignal} [signal] - The abort signal if any.
-     * @param {UserCustomParameters} [userCustomParameters] - The custom parameters if any.
-     * @param {string} [computeEnv] - The compute environment if any.
-     * @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): 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.
-     * @param {string} computeEnv The compute environment.
-     * @param {string} token The payment token address.
-     * @param {number} validUntil  The job expiration date.
-     * @param {string} providerUri The provider URI.
-     * @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 {any} policyServer Policy server data.
-     * @param {AbortSignal} signal abort signal
-     * @param {ComputeOutput} output The compute job output settings.
-     * @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, signal?: AbortSignal, output?: ComputeOutput, dockerRegistryAuth?: dockerRegistryAuth): Promise<ProviderComputeInitializeResults>;
-    /**
-     * Gets the download URL.
-     * @param {string} did - The DID.
-     * @param {string} serviceId - The service ID.
-     * @param {number} fileIndex - The file index.
-     * @param {string} transferTxId - The transfer transaction ID.
-     * @param {string} providerUri - The provider URI.
-     * @param {SignerOrAuthToken} signerOrAuthToken - The signer or auth token.
-     * @param {any} policyServer Policy server data.
-     * @param {UserCustomParameters} userCustomParameters - The user custom parameters.
-     * @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 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.
-     * @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 {number} maxJobDuration The compute job max execution time.
-     * @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 {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, 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.
-     * @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 {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, dockerRegistryAuth?: dockerRegistryAuth): Promise<ComputeJob | ComputeJob[]>;
-    /**
-     *
-     * @param providerUri provider URL
-     * @param signerOrAuthToken signer or auth token
-     * @param jobId jobId
-     * @param signal abort signal
-     * @returns logs response
-     */
-    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} jobId the compute job id
-     * @param {string} providerUri The provider URI.
-     * @param {SignerOrAuthToken} signerOrAuthToken The consumer signer or auth token.
-     * @param {string} agreementId The agreement id.
-     * @param {AbortSignal} signal abort signal
-     * @return {Promise<ComputeJob | ComputeJob[]>}
-     */
-    computeStop(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
-     * @param {string} jobId The ID of a compute job.
-     * @param {string} agreementId The ID of the service agreement (tx id)
-     * @param {AbortSignal} signal abort signal
-     * @return {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 {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, signerOrAuthToken: Signer | string, jobId: string, index: number): Promise<string>;
-    /** 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
-     * @return {Promise<boolean>} valid or not
-     */
-    isValidProvider(url: string, signal?: AbortSignal): Promise<boolean>;
-    /** Sends a PolicyServer request to node to be passthrough to PS
-     * @param {string} providerUri The provider URI.
-     * @param {PolicyServerPassthroughCommand} request The request to be passed through to the Policy Server.
-     * @param {AbortSignal} signal abort signal
-     */
-    PolicyServerPassthrough(providerUri: string, request: PolicyServerPassthroughCommand, signal?: AbortSignal): Promise<any>;
-    /** Initialize Policy Server verification
-     * @param {string} providerUri The provider URI.
-     * @param {PolicyServerInitializeCommand} request The request to be sent to the Policy Server.
-     * @param {AbortSignal} signal abort signal
-     */
-    initializePSVerification(providerUri: string, request: PolicyServerInitializeCommand, signal?: AbortSignal): Promise<any>;
-    /**
-     * Download node logs as an admin.
-     * @param {string} providerUri - The provider URI.
-     * @param {Signer} signer - The admin signer.
-     * @param {string} startTime - Start time (epoch ms) to get logs from.
-     * @param {string} endTime - End time (epoch ms) to get logs to.
-     * @param {number} [maxLogs] - Maximum number of logs to retrieve (default: 100, max: 1000).
-     * @param {string} [moduleName] - Filter logs by module name.
-     * @param {string} [level] - Filter logs by log level.
-     * @param {number} [page] - Pagination page number.
-     * @param {AbortSignal} [signal] - An optional abort signal.
-     * @returns {Promise<any>} The logs response body stream.
-     */
-    downloadNodeLogs(providerUri: string, signer: Signer, startTime: string, endTime: string, maxLogs?: number, moduleName?: string, level?: string, page?: number, signal?: AbortSignal): Promise<any>;
-    /**
-     * Private method that removes the leading 0x from a string.
-     * @param {string} input - The input string.
-     * @returns The transformed string.
-     */
-    private noZeroX;
-    /**
-     * Private method that removes the leading 0x from a string.
-     * @param {string} input - The input string.
-     * @param {boolean} zeroOutput - Whether to include 0x in the output if the input is valid and zeroOutput is true.
-     * @returns The transformed string.
-     */
-    private zeroXTransformer;
-    /**
-     * Private method that matches an input string against a regular expression and returns the first capture group.
-     * @param {string} input - The input string to match.
-     * @param {RegExp} regexp - The regular expression to match against.
-     * @param {string} conversorName - The name of the method calling this function.
-     * @returns An object with two properties: `valid` (a boolean indicating whether the input matched the regular expression) and `output` (the first capture group of the match, or the original input if there was no match).
-     */
-    private inputMatch;
-    /**
-     * Private method that fetches data from a URL using the GET method.
-     * @param {string} url - The URL to fetch data from.
-     * @returns A Promise that resolves to a Response object.
-     */
-    private getData;
-}
-export declare const ProviderInstance: Provider;
+import { BaseProvider } from './providers/BaseProvider.js';
+export { BaseProvider as Provider, isP2pUri, OCEAN_P2P_PROTOCOL, type P2PConfig } from './providers/BaseProvider.js';
+export declare const ProviderInstance: BaseProvider;

package/dist/types/services/providers/BaseProvider.d.ts

@@ -0,0 +1,48 @@
+import { Signer } from 'ethers';
+import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ComputeResultStream, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse } from '../../@types/index.js';
+import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
+import { HttpProvider } from './HttpProvider.js';
+import { P2pProvider, type P2PConfig } from './P2pProvider.js';
+export { OCEAN_P2P_PROTOCOL, type P2PConfig } from './P2pProvider.js';
+export declare function getConsumerAddress(signerOrAuthToken: Signer | string): Promise<string>;
+export declare function getSignature(signerOrAuthToken: Signer | string, nonce: string, command: string): Promise<string | null>;
+export declare function getAuthorization(signerOrAuthToken: Signer | string): string | undefined;
+export declare function isP2pUri(nodeUri: string): boolean;
+export declare class BaseProvider {
+    private httpProvider;
+    private p2pProvider;
+    protected getImpl(nodeUri: string): HttpProvider | P2pProvider;
+    getNonce(nodeUri: string, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[]): Promise<number>;
+    encrypt(data: any, chainId: number, nodeUri: string, signerOrAuthToken: Signer | string, policyServer?: any, signal?: AbortSignal): Promise<string>;
+    checkDidFiles(did: string, serviceId: string, nodeUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
+    getFileInfo(file: StorageObject, nodeUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
+    getComputeEnvironments(nodeUri: string, signal?: AbortSignal): Promise<ComputeEnvironment[]>;
+    initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, nodeUri: string, signal?: AbortSignal, userCustomParameters?: UserCustomParameters, computeEnv?: string, validUntil?: number): Promise<ProviderInitialize>;
+    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, nodeUri: string, signerOrAuthToken: Signer | string, resources: ComputeResourceRequest[], chainId: number, policyServer?: any, signal?: AbortSignal, output?: ComputeOutput, dockerRegistryAuth?: dockerRegistryAuth): Promise<ProviderComputeInitializeResults>;
+    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, nodeUri: string, signerOrAuthToken: Signer | string, policyServer?: any, userCustomParameters?: UserCustomParameters): Promise<string | DownloadResponse>;
+    computeStart(nodeUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, maxJobDuration: number, token: string, resources: ComputeResourceRequest[], chainId: number, metadata?: ComputeJobMetadata, additionalViewers?: string[], output?: ComputeOutput, policyServer?: any, signal?: AbortSignal, queueMaxWaitTime?: number, dockerRegistryAuth?: dockerRegistryAuth): Promise<ComputeJob | ComputeJob[]>;
+    freeComputeStart(nodeUri: 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[]>;
+    computeStreamableLogs(nodeUri: string, signerOrAuthToken: Signer | string, jobId: string, signal?: AbortSignal): Promise<any>;
+    computeStop(jobId: string, nodeUri: string, signerOrAuthToken: Signer | string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    computeStatus(nodeUri: string, signerOrAuthToken: Signer | string, jobId?: string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    getComputeResultUrl(nodeUri: string, signerOrAuthToken: Signer | string, jobId: string, index: number): Promise<string>;
+    getComputeResult(nodeUri: string, signerOrAuthToken: Signer | string, jobId: string, index: number, offset?: number): Promise<ComputeResultStream>;
+    generateAuthToken(consumer: Signer, nodeUri: string, signal?: AbortSignal): Promise<string>;
+    invalidateAuthToken(consumer: Signer, token: string, nodeUri: string, signal?: AbortSignal): Promise<{
+        success: boolean;
+    }>;
+    resolveDdo(nodeUri: string, did: string, signal?: AbortSignal): Promise<any>;
+    validateDdo(nodeUri: string, ddo: DDO, signer: Signer, signal?: AbortSignal): Promise<ValidateMetadata>;
+    isValidProvider(url: string, signal?: AbortSignal): Promise<boolean>;
+    PolicyServerPassthrough(nodeUri: string, request: PolicyServerPassthroughCommand, signal?: AbortSignal): Promise<any>;
+    initializePSVerification(nodeUri: string, request: PolicyServerInitializeCommand, signal?: AbortSignal): Promise<any>;
+    downloadNodeLogs(nodeUri: string, signer: Signer, startTime: string, endTime: string, maxLogs?: number, moduleName?: string, level?: string, page?: number, signal?: AbortSignal): Promise<any>;
+    setupP2P(config: P2PConfig): Promise<void>;
+    getDiscoveredNodes(): Array<{
+        peerId: string;
+        multiaddrs: string[];
+    }>;
+    getMultiaddrFromPeerId(peerId: string): Promise<string>;
+    fetchConfig(nodeUri: string, payload: Record<string, any>): Promise<any>;
+    pushConfig(nodeUri: string, payload: Record<string, any>): Promise<any>;
+}

package/dist/types/services/providers/HttpProvider.d.ts

@@ -0,0 +1,246 @@
+import { Signer } from 'ethers';
+import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, ComputeResultStream } from '../../@types/index.js';
+import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
+export declare class HttpProvider {
+    protected getConsumerAddress(s: Signer | string): Promise<string>;
+    protected getSignature(s: Signer | string, nonce: string, command: string): Promise<string>;
+    protected getAuthorization(s: Signer | string): string;
+    /**
+     * Returns the provider endpoints
+     * @param {string} nodeUri - the provider url
+     * @return {Promise<any>}
+     */
+    getEndpoints(nodeUri: string, authorization?: string): Promise<any>;
+    /**
+     * Returns the node public key
+     * @return {string} The node public key
+     */
+    private getNodePublicKey;
+    /**
+     * This function returns the endpoint URL for a given service name.
+     * @param {ServiceEndpoint[]} servicesEndpoints - The array of service endpoints
+     * @param {string} serviceName - The name of the service
+     * @returns {ServiceEndpoint} The endpoint URL for the given service name
+     */
+    getEndpointURL(servicesEndpoints: ServiceEndpoint[], serviceName: string): ServiceEndpoint;
+    /**
+     * This function returns an array of service endpoints for a given provider endpoint.
+     * @param {string} providerEndpoint - The provider endpoint
+     * @param {any} endpoints - The endpoints object
+     * @returns {ServiceEndpoint[]} An array of service endpoints
+     */
+    getServiceEndpoints(providerEndpoint: string, endpoints: any): Promise<ServiceEndpoint[]>;
+    /**
+     * Get current nonce from the provider.
+     * @param {string} nodeUri provider uri address
+     * @param {string} consumerAddress Publisher address
+     * @param {AbortSignal} signal abort signal
+     * @param {string} providerEndpoints Identifier of the asset to be registered in ocean
+     * @param {string} serviceEndpoints document description object (DDO)=
+     * @return {Promise<string>} urlDetails
+     */
+    getNonce(nodeUri: string, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[]): Promise<number>;
+    /**
+     * Encrypt data using the Provider's own symmetric key
+     * @param {string} data data in json format that needs to be sent , it can either be a DDO or a File array
+     * @param {number} chainId network's id so provider can choose the corresponding Signer object
+     * @param {string} nodeUri provider uri address
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<string>} urlDetails
+     */
+    encrypt(data: any, chainId: number, nodeUri: string, signerOrAuthToken: Signer | string, policyServer?: any, signal?: AbortSignal): Promise<string>;
+    /**
+     * Get file details for a given DID and service ID.
+     * @param {string} did - The DID to check.
+     * @param {string} serviceId - The service ID to check.
+     * @param {string} nodeUri - The URI of the provider.
+     * @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.
+     */
+    checkDidFiles(did: string, serviceId: string, nodeUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
+    /**
+     * Get File details (if possible)
+     * @param {StorageObject} file one of the supported file structures
+     * @param {string} nodeUri 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: StorageObject, nodeUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
+    /**
+     * Returns compute environments from a provider.
+     * @param {string} nodeUri - The URI of the provider.
+     * @param {AbortSignal} [signal] - An optional abort signal.
+     * @returns {Promise<ComputeEnvironment[]>} A promise that resolves with compute environments.
+     */
+    getComputeEnvironments(nodeUri: string, signal?: AbortSignal): Promise<ComputeEnvironment[]>;
+    /**
+     * Initializes the provider for a service request.
+     * @param {string} did - The asset DID .
+     * @param {string} serviceId - The asset service ID.
+     * @param {number} fileIndex - The file index.
+     * @param {string} consumerAddress - The consumer address.
+     * @param {string} nodeUri - The URI of the provider.
+     * @param {AbortSignal} [signal] - The abort signal if any.
+     * @param {UserCustomParameters} [userCustomParameters] - The custom parameters if any.
+     * @param {string} [computeEnv] - The compute environment if any.
+     * @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, nodeUri: 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.
+     * @param {string} computeEnv The compute environment.
+     * @param {string} token The payment token address.
+     * @param {number} validUntil  The job expiration date.
+     * @param {string} nodeUri The provider URI.
+     * @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 {any} policyServer Policy server 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, nodeUri: string, signerOrAuthToken: Signer | string, resources: ComputeResourceRequest[], chainId: number, policyServer?: any, signal?: AbortSignal, output?: ComputeOutput, dockerRegistryAuth?: dockerRegistryAuth): Promise<ProviderComputeInitializeResults>;
+    /**
+     * Gets the download URL.
+     * @param {string} did - The DID.
+     * @param {string} serviceId - The service ID.
+     * @param {number} fileIndex - The file index.
+     * @param {string} transferTxId - The transfer transaction ID.
+     * @param {string} nodeUri - The provider URI.
+     * @param {SignerOrAuthToken} signerOrAuthToken - The signer or auth token.
+     * @param {any} policyServer Policy server data.
+     * @param {UserCustomParameters} userCustomParameters - The user custom parameters.
+     * @returns {Promise<any>} The download URL.
+     */
+    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, nodeUri: string, signerOrAuthToken: Signer | string, policyServer?: any, userCustomParameters?: UserCustomParameters): Promise<any>;
+    /** Instruct the provider to start a PAYED compute job
+     * @param {string} nodeUri The provider URI.
+     * @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 {number} maxJobDuration The compute job max execution time.
+     * @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 {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(nodeUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, maxJobDuration: number, token: string, resources: ComputeResourceRequest[], chainId: number, 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} nodeUri The provider URI.
+     * @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 {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(nodeUri: 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 nodeUri provider URL
+     * @param signerOrAuthToken signer or auth token
+     * @param jobId jobId
+     * @param signal abort signal
+     * @returns logs response
+     */
+    computeStreamableLogs(nodeUri: string, signerOrAuthToken: Signer | string, jobId: string, signal?: AbortSignal): Promise<any>;
+    /** Instruct the provider to Stop the execution of a to stop a compute job.
+     * @param {string} jobId the compute job id
+     * @param {string} nodeUri The provider URI.
+     * @param {SignerOrAuthToken} signerOrAuthToken The consumer signer or auth token.
+     * @param {string} agreementId The agreement id.
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    computeStop(jobId: string, nodeUri: string, signerOrAuthToken: Signer | string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    /** Get compute status for a specific jobId/documentId/owner.
+     * @param {string} nodeUri The URI of the provider we want to query
+     * @param {string} consumerAddress The consumer ethereum address
+     * @param {string} jobId The ID of a compute job.
+     * @param {string} agreementId The ID of the service agreement (tx id)
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    computeStatus(nodeUri: string, signerOrAuthToken: Signer | string, jobId?: string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    /** Get compute result url
+     * @param {string} nodeUri The URI of the provider we want to query
+     * @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(nodeUri: string, signerOrAuthToken: Signer | string, jobId: string, index: number): Promise<string>;
+    getComputeResult(nodeUri: string, signerOrAuthToken: Signer | string, jobId: string, index: number, offset?: number): Promise<ComputeResultStream>;
+    /** Generates an auth token
+     * @param {Signer} consumer consumer Signer wallet object
+     * @param {string} nodeUri The URI of the provider we want to query
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<string>}
+     */
+    generateAuthToken(consumer: Signer, nodeUri: string, signal?: AbortSignal): Promise<string>;
+    /** Invalidates an auth token
+     * @param {Signer} consumer consumer Signer wallet object
+     * @param {string} token The auth token to invalidate
+     * @param {string} nodeUri The URI of the provider we want to query
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<{ success: boolean }>}
+     */
+    invalidateAuthToken(consumer: Signer, token: string, nodeUri: string, signal?: AbortSignal): Promise<{
+        success: boolean;
+    }>;
+    /** Check for a valid provider at URL
+     * @param {String} url provider uri address
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<boolean>} valid or not
+     */
+    isValidProvider(url: string, signal?: AbortSignal): Promise<boolean>;
+    /** Sends a PolicyServer request to node to be passthrough to PS
+     * @param {string} nodeUri The provider URI.
+     * @param {PolicyServerPassthroughCommand} request The request to be passed through to the Policy Server.
+     * @param {AbortSignal} signal abort signal
+     */
+    PolicyServerPassthrough(nodeUri: string, request: PolicyServerPassthroughCommand, signal?: AbortSignal): Promise<any>;
+    /** Initialize Policy Server verification
+     * @param {string} nodeUri The provider URI.
+     * @param {PolicyServerInitializeCommand} request The request to be sent to the Policy Server.
+     * @param {AbortSignal} signal abort signal
+     */
+    initializePSVerification(nodeUri: string, request: PolicyServerInitializeCommand, signal?: AbortSignal): Promise<any>;
+    /**
+     * Download node logs as an admin.
+     * @param {string} nodeUri - The provider URI.
+     * @param {Signer} signer - The admin signer.
+     * @param {string} startTime - Start time (epoch ms) to get logs from.
+     * @param {string} endTime - End time (epoch ms) to get logs to.
+     * @param {number} [maxLogs] - Maximum number of logs to retrieve (default: 100, max: 1000).
+     * @param {string} [moduleName] - Filter logs by module name.
+     * @param {string} [level] - Filter logs by log level.
+     * @param {number} [page] - Pagination page number.
+     * @param {AbortSignal} [signal] - An optional abort signal.
+     * @returns {Promise<any>} The logs response body stream.
+     */
+    downloadNodeLogs(nodeUri: string, signer: Signer, startTime: string, endTime: string, maxLogs?: number, moduleName?: string, level?: string, page?: number, signal?: AbortSignal): Promise<any>;
+    private noZeroX;
+    private zeroXTransformer;
+    private inputMatch;
+    resolveDdo(nodeUri: string, did: string, signal?: AbortSignal): Promise<any>;
+    validateDdo(nodeUri: string, ddo: DDO, signer: Signer, signal?: AbortSignal): Promise<ValidateMetadata>;
+    private getData;
+}