@oceanprotocol/lib 8.0.5 → 8.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib.cjs +4 -4
- package/dist/lib.module.mjs +3 -3
- package/dist/lib.umd.js +3 -3
- package/dist/types/@types/Provider.d.ts +14 -0
- package/dist/types/services/providers/BaseProvider.d.ts +43 -47
- package/dist/types/services/providers/HttpProvider.d.ts +20 -22
- package/dist/types/services/providers/P2pProvider.d.ts +50 -47
- package/package.json +1 -1
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
import { type Multiaddr } from '@multiformats/multiaddr';
|
|
2
|
+
import { Signer } from 'ethers';
|
|
3
|
+
import type { PeerId } from '@libp2p/interface';
|
|
1
4
|
import type { AccessList } from './AccessList.js';
|
|
2
5
|
export interface ProviderFees {
|
|
3
6
|
providerFeeAddress: string;
|
|
@@ -38,6 +41,11 @@ export interface ServiceEndpoint {
|
|
|
38
41
|
method: string;
|
|
39
42
|
urlPath: string;
|
|
40
43
|
}
|
|
44
|
+
export interface NodeP2P {
|
|
45
|
+
nodeId: string;
|
|
46
|
+
multiaddress?: Multiaddr[];
|
|
47
|
+
}
|
|
48
|
+
export type OceanNode = string | NodeP2P | PeerId;
|
|
41
49
|
export interface NodeStatusProvider {
|
|
42
50
|
chainId: string;
|
|
43
51
|
network: string;
|
|
@@ -144,3 +152,9 @@ export interface NodeLogEntry {
|
|
|
144
152
|
message: string;
|
|
145
153
|
meta?: Record<string, any>;
|
|
146
154
|
}
|
|
155
|
+
export interface CompleteSignature {
|
|
156
|
+
consumerAddress: string;
|
|
157
|
+
nonce: string;
|
|
158
|
+
signature: string;
|
|
159
|
+
}
|
|
160
|
+
export type SignerOrAuthTokenOrSignature = string | Signer | CompleteSignature;
|
|
@@ -1,45 +1,46 @@
|
|
|
1
|
-
import { type Multiaddr } from '@multiformats/multiaddr';
|
|
2
1
|
import { Signer } from 'ethers';
|
|
3
|
-
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ComputeResultStream, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, NodeStatus, NodeComputeJob,
|
|
2
|
+
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ComputeResultStream, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, NodeStatus, NodeComputeJob, NodeLogEntry, PersistentStorageAccessList, PersistentStorageBucket, PersistentStorageCreateBucketRequest, PersistentStorageDeleteFileResponse, PersistentStorageFileEntry, PersistentStorageObject, OceanNode, CompleteSignature, SignerOrAuthTokenOrSignature } from '../../@types/index.js';
|
|
4
3
|
import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
|
|
5
|
-
import { type P2PConfig, type P2PRequestBodyStream } from './P2pProvider.js';
|
|
4
|
+
import { P2pProvider, type P2PConfig, type P2PRequestBodyStream } from './P2pProvider.js';
|
|
6
5
|
export { OCEAN_P2P_PROTOCOL, type P2PConfig } from './P2pProvider.js';
|
|
7
|
-
export declare function getConsumerAddress(signerOrAuthToken:
|
|
8
|
-
export declare function getSignature(signerOrAuthToken:
|
|
9
|
-
export declare function getAuthorization(signerOrAuthToken:
|
|
10
|
-
export declare function
|
|
6
|
+
export declare function getConsumerAddress(signerOrAuthToken: SignerOrAuthTokenOrSignature): Promise<string>;
|
|
7
|
+
export declare function getSignature(signerOrAuthToken: SignerOrAuthTokenOrSignature, nonce: string, command: string): Promise<string | null>;
|
|
8
|
+
export declare function getAuthorization(signerOrAuthToken: SignerOrAuthTokenOrSignature): string | undefined;
|
|
9
|
+
export declare function isAgentSignature(v: unknown): v is CompleteSignature;
|
|
10
|
+
export declare function isP2pUri(node: OceanNode): boolean;
|
|
11
11
|
export declare class BaseProvider {
|
|
12
12
|
private httpProvider;
|
|
13
13
|
private p2pProvider;
|
|
14
|
-
protected getImpl(
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
14
|
+
protected getImpl(node: OceanNode): any;
|
|
15
|
+
getP2PProvider(): P2pProvider;
|
|
16
|
+
getNonce(nodeUri: OceanNode, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[]): Promise<number>;
|
|
17
|
+
encrypt(data: any, chainId: number, nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, policyServer?: any, signal?: AbortSignal): Promise<string>;
|
|
18
|
+
checkDidFiles(did: string, serviceId: string, nodeUri: OceanNode, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
|
|
19
|
+
getFileInfo(file: StorageObject, nodeUri: OceanNode, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
|
|
20
|
+
getComputeEnvironments(nodeUri: OceanNode, signal?: AbortSignal): Promise<ComputeEnvironment[]>;
|
|
21
|
+
initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, nodeUri: OceanNode, signal?: AbortSignal, userCustomParameters?: UserCustomParameters, computeEnv?: string, validUntil?: number): Promise<ProviderInitialize>;
|
|
22
|
+
initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, nodeUri: OceanNode, consumerAddress: string, resources: ComputeResourceRequest[], chainId: number, policyServer?: any, signal?: AbortSignal, queueMaxWaitTime?: number, dockerRegistryAuthData?: dockerRegistryAuth, output?: ComputeOutput): Promise<ProviderComputeInitializeResults>;
|
|
23
|
+
getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, policyServer?: any, userCustomParameters?: UserCustomParameters): Promise<string | DownloadResponse>;
|
|
24
|
+
computeStart(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, 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[]>;
|
|
25
|
+
freeComputeStart(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, 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[]>;
|
|
26
|
+
computeStreamableLogs(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId: string, signal?: AbortSignal): Promise<any>;
|
|
27
|
+
computeStop(jobId: string, nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
|
|
28
|
+
computeStatus(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId?: string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
|
|
29
|
+
getComputeResultUrl(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId: string, index: number): Promise<string>;
|
|
30
|
+
getComputeResult(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId: string, index: number, offset?: number): Promise<ComputeResultStream>;
|
|
31
|
+
generateAuthToken(consumer: Signer, nodeUri: OceanNode, signal?: AbortSignal): Promise<string>;
|
|
32
|
+
generateSignedAuthToken(address: string, signature: string, nonce: string, nodeUri: OceanNode, signal?: AbortSignal): Promise<string>;
|
|
33
|
+
invalidateAuthToken(consumer: Signer, token: string, nodeUri: OceanNode, signal?: AbortSignal): Promise<{
|
|
33
34
|
success: boolean;
|
|
34
35
|
}>;
|
|
35
|
-
resolveDdo(nodeUri:
|
|
36
|
-
validateDdo(nodeUri:
|
|
37
|
-
isValidProvider(url:
|
|
38
|
-
PolicyServerPassthrough(nodeUri:
|
|
39
|
-
initializePSVerification(nodeUri:
|
|
40
|
-
downloadNodeLogs(nodeUri:
|
|
41
|
-
getNodeStatus(nodeUri:
|
|
42
|
-
getNodeJobs(nodeUri:
|
|
36
|
+
resolveDdo(nodeUri: OceanNode, did: string, signal?: AbortSignal): Promise<any>;
|
|
37
|
+
validateDdo(nodeUri: OceanNode, ddo: DDO, signerOrAuthToken: SignerOrAuthTokenOrSignature, signal?: AbortSignal): Promise<ValidateMetadata>;
|
|
38
|
+
isValidProvider(url: OceanNode, signal?: AbortSignal): Promise<boolean>;
|
|
39
|
+
PolicyServerPassthrough(nodeUri: OceanNode, request: PolicyServerPassthroughCommand, signal?: AbortSignal): Promise<any>;
|
|
40
|
+
initializePSVerification(nodeUri: OceanNode, request: PolicyServerInitializeCommand, signal?: AbortSignal): Promise<any>;
|
|
41
|
+
downloadNodeLogs(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, startTime: string, endTime: string, maxLogs?: number, moduleName?: string, level?: string, page?: number, signal?: AbortSignal): Promise<NodeLogEntry[]>;
|
|
42
|
+
getNodeStatus(nodeUri: OceanNode, signal?: AbortSignal): Promise<NodeStatus>;
|
|
43
|
+
getNodeJobs(nodeUri: OceanNode, fromTimestamp?: number, signal?: AbortSignal): Promise<NodeComputeJob[]>;
|
|
43
44
|
setupP2P(config: P2PConfig): Promise<void>;
|
|
44
45
|
getLibp2pNode(): import("libp2p").Libp2p<import("@libp2p/interface").ServiceMap>;
|
|
45
46
|
getDiscoveredNodes(): Promise<Array<{
|
|
@@ -47,21 +48,16 @@ export declare class BaseProvider {
|
|
|
47
48
|
multiaddrs: string[];
|
|
48
49
|
}>>;
|
|
49
50
|
getMultiaddrFromPeerId(peerId: string): Promise<string>;
|
|
50
|
-
|
|
51
|
-
* Fetch node logs via P2P with a pre-signed payload.
|
|
52
|
-
* For auto-signed log fetching (HTTP or P2P), use downloadNodeLogs().
|
|
53
|
-
*/
|
|
54
|
-
fetchNodeLogs(nodeUri: string | Multiaddr[], address: string, signature: string, nonce: string, logParams?: NodeLogsParams): Promise<NodeLogEntry[]>;
|
|
55
|
-
createPersistentStorageBucket(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, payload: PersistentStorageCreateBucketRequest, signal?: AbortSignal): Promise<{
|
|
51
|
+
createPersistentStorageBucket(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, payload: PersistentStorageCreateBucketRequest, signal?: AbortSignal): Promise<{
|
|
56
52
|
bucketId: string;
|
|
57
53
|
owner: string;
|
|
58
54
|
accessList: PersistentStorageAccessList[];
|
|
59
55
|
}>;
|
|
60
|
-
getPersistentStorageBuckets(nodeUri:
|
|
61
|
-
listPersistentStorageFiles(nodeUri:
|
|
62
|
-
getPersistentStorageFileObject(nodeUri:
|
|
63
|
-
uploadPersistentStorageFile(nodeUri:
|
|
64
|
-
deletePersistentStorageFile(nodeUri:
|
|
65
|
-
fetchConfig(nodeUri:
|
|
66
|
-
pushConfig(nodeUri:
|
|
56
|
+
getPersistentStorageBuckets(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, owner: string, signal?: AbortSignal): Promise<PersistentStorageBucket[]>;
|
|
57
|
+
listPersistentStorageFiles(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, signal?: AbortSignal): Promise<PersistentStorageFileEntry[]>;
|
|
58
|
+
getPersistentStorageFileObject(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, fileName: string, signal?: AbortSignal): Promise<PersistentStorageObject>;
|
|
59
|
+
uploadPersistentStorageFile(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, fileName: string, content: P2PRequestBodyStream, signal?: AbortSignal): Promise<PersistentStorageFileEntry>;
|
|
60
|
+
deletePersistentStorageFile(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, fileName: string, signal?: AbortSignal): Promise<PersistentStorageDeleteFileResponse>;
|
|
61
|
+
fetchConfig(nodeUri: OceanNode, payload: Record<string, any>): Promise<any>;
|
|
62
|
+
pushConfig(nodeUri: OceanNode, payload: Record<string, any>): Promise<any>;
|
|
67
63
|
}
|
|
@@ -1,12 +1,10 @@
|
|
|
1
1
|
import { Signer } from 'ethers';
|
|
2
|
-
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, ComputeResultStream, NodeStatus, NodeComputeJob, NodeLogEntry, PersistentStorageAccessList, PersistentStorageBucket, PersistentStorageCreateBucketRequest, PersistentStorageDeleteFileResponse, PersistentStorageFileEntry, PersistentStorageObject } from '../../@types/index.js';
|
|
2
|
+
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, ComputeResultStream, NodeStatus, NodeComputeJob, NodeLogEntry, PersistentStorageAccessList, PersistentStorageBucket, PersistentStorageCreateBucketRequest, PersistentStorageDeleteFileResponse, PersistentStorageFileEntry, PersistentStorageObject, SignerOrAuthTokenOrSignature } from '../../@types/index.js';
|
|
3
3
|
import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
|
|
4
4
|
import { type P2PRequestBodyStream } from './P2pProvider.js';
|
|
5
5
|
export declare class HttpProvider {
|
|
6
|
-
protected
|
|
7
|
-
|
|
8
|
-
protected getAuthorization(s: Signer | string): string;
|
|
9
|
-
private getPersistentStorageSignaturePayload;
|
|
6
|
+
protected getAuthorization(s: SignerOrAuthTokenOrSignature): string;
|
|
7
|
+
private getSignedCommandParams;
|
|
10
8
|
private resolvePersistentStorageRoute;
|
|
11
9
|
/**
|
|
12
10
|
* Returns the provider endpoints
|
|
@@ -53,7 +51,7 @@ export declare class HttpProvider {
|
|
|
53
51
|
* @param {AbortSignal} signal abort signal
|
|
54
52
|
* @return {Promise<string>} urlDetails
|
|
55
53
|
*/
|
|
56
|
-
encrypt(data: any, chainId: number, nodeUri: string, signerOrAuthToken:
|
|
54
|
+
encrypt(data: any, chainId: number, nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, policyServer?: any, signal?: AbortSignal): Promise<string>;
|
|
57
55
|
/**
|
|
58
56
|
* Get file details for a given DID and service ID.
|
|
59
57
|
* @param {string} did - The DID to check.
|
|
@@ -122,7 +120,7 @@ export declare class HttpProvider {
|
|
|
122
120
|
* @param {UserCustomParameters} userCustomParameters - The user custom parameters.
|
|
123
121
|
* @returns {Promise<any>} The download URL.
|
|
124
122
|
*/
|
|
125
|
-
getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, nodeUri: string, signerOrAuthToken:
|
|
123
|
+
getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, policyServer?: any, userCustomParameters?: UserCustomParameters): Promise<any>;
|
|
126
124
|
/** Instruct the provider to start a PAYED compute job
|
|
127
125
|
* @param {string} nodeUri The provider URI.
|
|
128
126
|
* @param {SignerOrAuthToken} signerOrAuthToken The consumer signer object or auth token.
|
|
@@ -141,7 +139,7 @@ export declare class HttpProvider {
|
|
|
141
139
|
* @param {dockerRegistryAuth} dockerRegistryAuth Docker registry authentication data.
|
|
142
140
|
* @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
|
|
143
141
|
*/
|
|
144
|
-
computeStart(nodeUri: string, signerOrAuthToken:
|
|
142
|
+
computeStart(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, 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[]>;
|
|
145
143
|
/** Instruct the provider to start a FREE compute job
|
|
146
144
|
* @param {string} nodeUri The provider URI.
|
|
147
145
|
* @param {SignerOrAuthToken} signerOrAuthToken The consumer signer object or auth token.
|
|
@@ -157,7 +155,7 @@ export declare class HttpProvider {
|
|
|
157
155
|
* @param {dockerRegistryAuth} dockerRegistryAuth Docker registry authentication data.
|
|
158
156
|
* @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
|
|
159
157
|
*/
|
|
160
|
-
freeComputeStart(nodeUri: string, signerOrAuthToken:
|
|
158
|
+
freeComputeStart(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, 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[]>;
|
|
161
159
|
/**
|
|
162
160
|
* @param nodeUri provider URL
|
|
163
161
|
* @param signerOrAuthToken signer or auth token
|
|
@@ -165,7 +163,7 @@ export declare class HttpProvider {
|
|
|
165
163
|
* @param signal abort signal
|
|
166
164
|
* @returns logs response
|
|
167
165
|
*/
|
|
168
|
-
computeStreamableLogs(nodeUri: string, signerOrAuthToken:
|
|
166
|
+
computeStreamableLogs(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId: string, signal?: AbortSignal): Promise<any>;
|
|
169
167
|
/** Instruct the provider to Stop the execution of a to stop a compute job.
|
|
170
168
|
* @param {string} jobId the compute job id
|
|
171
169
|
* @param {string} nodeUri The provider URI.
|
|
@@ -174,7 +172,7 @@ export declare class HttpProvider {
|
|
|
174
172
|
* @param {AbortSignal} signal abort signal
|
|
175
173
|
* @return {Promise<ComputeJob | ComputeJob[]>}
|
|
176
174
|
*/
|
|
177
|
-
computeStop(jobId: string, nodeUri: string, signerOrAuthToken:
|
|
175
|
+
computeStop(jobId: string, nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
|
|
178
176
|
/** Get compute status for a specific jobId/documentId/owner.
|
|
179
177
|
* @param {string} nodeUri The URI of the provider we want to query
|
|
180
178
|
* @param {string} consumerAddress The consumer ethereum address
|
|
@@ -183,7 +181,7 @@ export declare class HttpProvider {
|
|
|
183
181
|
* @param {AbortSignal} signal abort signal
|
|
184
182
|
* @return {Promise<ComputeJob | ComputeJob[]>}
|
|
185
183
|
*/
|
|
186
|
-
computeStatus(nodeUri: string, signerOrAuthToken:
|
|
184
|
+
computeStatus(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId?: string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
|
|
187
185
|
/** Get compute result url
|
|
188
186
|
* @param {string} nodeUri The URI of the provider we want to query
|
|
189
187
|
* @param {SignerOrAuthToken} signerOrAuthToken signer or auth token
|
|
@@ -191,8 +189,8 @@ export declare class HttpProvider {
|
|
|
191
189
|
* @param {number} index Result index
|
|
192
190
|
* @return {Promise<string>}
|
|
193
191
|
*/
|
|
194
|
-
getComputeResultUrl(nodeUri: string, signerOrAuthToken:
|
|
195
|
-
getComputeResult(nodeUri: string, signerOrAuthToken:
|
|
192
|
+
getComputeResultUrl(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId: string, index: number): Promise<string>;
|
|
193
|
+
getComputeResult(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId: string, index: number, offset?: number): Promise<ComputeResultStream>;
|
|
196
194
|
/** Generates an auth token
|
|
197
195
|
* @param {Signer} consumer consumer Signer wallet object
|
|
198
196
|
* @param {string} nodeUri The URI of the provider we want to query
|
|
@@ -241,21 +239,21 @@ export declare class HttpProvider {
|
|
|
241
239
|
* @param {AbortSignal} [signal] - An optional abort signal.
|
|
242
240
|
* @returns {Promise<any>} The logs response body stream.
|
|
243
241
|
*/
|
|
244
|
-
downloadNodeLogs(nodeUri: string,
|
|
242
|
+
downloadNodeLogs(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, startTime: string, endTime: string, maxLogs?: number, moduleName?: string, level?: string, page?: number, signal?: AbortSignal): Promise<NodeLogEntry[]>;
|
|
245
243
|
private noZeroX;
|
|
246
244
|
private zeroXTransformer;
|
|
247
245
|
private inputMatch;
|
|
248
246
|
resolveDdo(nodeUri: string, did: string, signal?: AbortSignal): Promise<any>;
|
|
249
|
-
validateDdo(nodeUri: string, ddo: DDO,
|
|
247
|
+
validateDdo(nodeUri: string, ddo: DDO, signerOrAuthToken: SignerOrAuthTokenOrSignature, signal?: AbortSignal): Promise<ValidateMetadata>;
|
|
250
248
|
private getData;
|
|
251
|
-
createPersistentStorageBucket(nodeUri: string, signerOrAuthToken:
|
|
249
|
+
createPersistentStorageBucket(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, payload: PersistentStorageCreateBucketRequest, signal?: AbortSignal): Promise<{
|
|
252
250
|
bucketId: string;
|
|
253
251
|
owner: string;
|
|
254
252
|
accessList: PersistentStorageAccessList[];
|
|
255
253
|
}>;
|
|
256
|
-
getPersistentStorageBuckets(nodeUri: string, signerOrAuthToken:
|
|
257
|
-
listPersistentStorageFiles(nodeUri: string, signerOrAuthToken:
|
|
258
|
-
getPersistentStorageFileObject(nodeUri: string, signerOrAuthToken:
|
|
259
|
-
uploadPersistentStorageFile(nodeUri: string, signerOrAuthToken:
|
|
260
|
-
deletePersistentStorageFile(nodeUri: string, signerOrAuthToken:
|
|
254
|
+
getPersistentStorageBuckets(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, owner: string, signal?: AbortSignal): Promise<PersistentStorageBucket[]>;
|
|
255
|
+
listPersistentStorageFiles(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, signal?: AbortSignal): Promise<PersistentStorageFileEntry[]>;
|
|
256
|
+
getPersistentStorageFileObject(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, fileName: string, signal?: AbortSignal): Promise<PersistentStorageObject>;
|
|
257
|
+
uploadPersistentStorageFile(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, fileName: string, content: P2PRequestBodyStream, signal?: AbortSignal): Promise<PersistentStorageFileEntry>;
|
|
258
|
+
deletePersistentStorageFile(nodeUri: string, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, fileName: string, signal?: AbortSignal): Promise<PersistentStorageDeleteFileResponse>;
|
|
261
259
|
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { type Libp2p, type Libp2pOptions } from 'libp2p';
|
|
2
|
-
import { type Multiaddr } from '@multiformats/multiaddr';
|
|
3
2
|
import { Signer } from 'ethers';
|
|
4
|
-
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, ComputeResultStream, NodeStatus, NodeComputeJob, PersistentStorageAccessList, PersistentStorageBucket, PersistentStorageCreateBucketRequest, PersistentStorageDeleteFileResponse, PersistentStorageFileEntry, PersistentStorageObject } from '../../@types/index.js';
|
|
5
|
-
import {
|
|
3
|
+
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, ComputeResultStream, NodeStatus, NodeComputeJob, PersistentStorageAccessList, PersistentStorageBucket, PersistentStorageCreateBucketRequest, PersistentStorageDeleteFileResponse, PersistentStorageFileEntry, PersistentStorageObject, OceanNode, SignerOrAuthTokenOrSignature } from '../../@types/index.js';
|
|
4
|
+
import { NodeLogEntry } from '../../@types/Provider.js';
|
|
6
5
|
import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
|
|
6
|
+
import { CID } from 'multiformats/cid';
|
|
7
7
|
export declare const OCEAN_P2P_PROTOCOL = "/ocean/nodes/1.0.0";
|
|
8
8
|
/**
|
|
9
9
|
* Optional request payload sent as LP frames after the command JSON; ends with an empty LP frame.
|
|
@@ -68,146 +68,149 @@ export declare class P2pProvider {
|
|
|
68
68
|
private handleProtocolCommands;
|
|
69
69
|
private getOrCreateLibp2pNode;
|
|
70
70
|
private toUint8Array;
|
|
71
|
+
cidFromRawString(data: string): Promise<CID<unknown, 85, 18, 1>>;
|
|
72
|
+
getProvidersForString(input: string, signal?: AbortSignal): Promise<Array<{
|
|
73
|
+
id: string;
|
|
74
|
+
multiaddrs: any[];
|
|
75
|
+
}>>;
|
|
71
76
|
private isDialable;
|
|
77
|
+
/**
|
|
78
|
+
* True when the multiaddr does not include the relay `p2p-circuit` protocol segment.
|
|
79
|
+
* (Direct / transport paths omit it; relay paths contain `/p2p-circuit/...`.)
|
|
80
|
+
*/
|
|
81
|
+
private isNotP2PCircuit;
|
|
72
82
|
private peerIdFromMultiaddr;
|
|
73
83
|
private getConnection;
|
|
74
|
-
private dialByPeerId;
|
|
75
|
-
protected getConsumerAddress(s: Signer | string): Promise<string>;
|
|
76
|
-
protected getSignature(s: Signer | string, nonce: string, command: string): Promise<string>;
|
|
77
84
|
private getNodePublicKey;
|
|
78
|
-
protected getAuthorization(s:
|
|
85
|
+
protected getAuthorization(s: SignerOrAuthTokenOrSignature): string;
|
|
86
|
+
private getSignedCommandParams;
|
|
79
87
|
private dialAndStream;
|
|
80
88
|
private sendP2pCommand;
|
|
81
89
|
/**
|
|
82
90
|
* Returns node status via P2P STATUS command.
|
|
83
91
|
* @param {string} nodeUri - multiaddr of the node
|
|
84
92
|
*/
|
|
85
|
-
getEndpoints(nodeUri:
|
|
86
|
-
getNodeStatus(nodeUri:
|
|
87
|
-
getNodeJobs(nodeUri:
|
|
93
|
+
getEndpoints(nodeUri: OceanNode): Promise<any>;
|
|
94
|
+
getNodeStatus(nodeUri: OceanNode, signal?: AbortSignal): Promise<NodeStatus>;
|
|
95
|
+
getNodeJobs(nodeUri: OceanNode, fromTimestamp?: number, signal?: AbortSignal): Promise<NodeComputeJob[]>;
|
|
88
96
|
/**
|
|
89
97
|
* Get current nonce from the node via P2P.
|
|
90
98
|
*/
|
|
91
|
-
getNonce(nodeUri:
|
|
99
|
+
getNonce(nodeUri: OceanNode, consumerAddress: string, signal?: AbortSignal): Promise<number>;
|
|
92
100
|
/**
|
|
93
101
|
* Encrypt data via P2P ENCRYPT command.
|
|
94
102
|
*/
|
|
95
|
-
encrypt(data: any, chainId: number, nodeUri:
|
|
103
|
+
encrypt(data: any, chainId: number, nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, _policyServer?: any, signal?: AbortSignal): Promise<string>;
|
|
96
104
|
/**
|
|
97
105
|
* Get file details for a given DID and service ID via P2P.
|
|
98
106
|
*/
|
|
99
|
-
checkDidFiles(did: string, serviceId: string, nodeUri:
|
|
107
|
+
checkDidFiles(did: string, serviceId: string, nodeUri: OceanNode, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
|
|
100
108
|
/**
|
|
101
109
|
* Get File details via P2P.
|
|
102
110
|
*/
|
|
103
|
-
getFileInfo(file: StorageObject, nodeUri:
|
|
111
|
+
getFileInfo(file: StorageObject, nodeUri: OceanNode, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
|
|
104
112
|
/**
|
|
105
113
|
* Returns compute environments via P2P.
|
|
106
114
|
*/
|
|
107
|
-
getComputeEnvironments(nodeUri:
|
|
115
|
+
getComputeEnvironments(nodeUri: OceanNode, signal?: AbortSignal): Promise<ComputeEnvironment[]>;
|
|
108
116
|
/**
|
|
109
117
|
* Initializes the provider for a service (download) request via P2P.
|
|
110
118
|
*/
|
|
111
|
-
initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, nodeUri:
|
|
119
|
+
initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, nodeUri: OceanNode, signal?: AbortSignal, userCustomParameters?: UserCustomParameters, computeEnv?: string, validUntil?: number): Promise<ProviderInitialize>;
|
|
112
120
|
/**
|
|
113
121
|
* Initializes compute request via P2P. No auth required -- the node only
|
|
114
122
|
* validates parameters and applies rate limits.
|
|
115
123
|
*/
|
|
116
|
-
initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, nodeUri:
|
|
124
|
+
initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, nodeUri: OceanNode, consumerAddress: string, resources: ComputeResourceRequest[], chainId: number, policyServer?: any, signal?: AbortSignal, queueMaxWaitTime?: number, dockerRegistryAuthData?: dockerRegistryAuth, output?: ComputeOutput): Promise<ProviderComputeInitializeResults>;
|
|
117
125
|
/**
|
|
118
126
|
* Sends a DOWNLOAD command to the peer via P2P, reads the binary stream
|
|
119
127
|
* directly from the lpStream, and returns a DownloadResponse.
|
|
120
128
|
* The node decrypts the service file and streams raw file data back.
|
|
121
129
|
*/
|
|
122
|
-
getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, nodeUri:
|
|
130
|
+
getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, policyServer?: any, userCustomParameters?: UserCustomParameters): Promise<DownloadResponse>;
|
|
123
131
|
/**
|
|
124
132
|
* Start a paid compute job via P2P.
|
|
125
133
|
*/
|
|
126
|
-
computeStart(nodeUri:
|
|
134
|
+
computeStart(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, 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[]>;
|
|
127
135
|
/**
|
|
128
136
|
* Start a free compute job via P2P.
|
|
129
137
|
*/
|
|
130
|
-
freeComputeStart(nodeUri:
|
|
138
|
+
freeComputeStart(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, 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[]>;
|
|
131
139
|
/**
|
|
132
140
|
* Get streamable compute logs via P2P. Returns an async generator of Uint8Array chunks.
|
|
133
141
|
*/
|
|
134
|
-
computeStreamableLogs(nodeUri:
|
|
142
|
+
computeStreamableLogs(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId: string, signal?: AbortSignal): Promise<any>;
|
|
135
143
|
/**
|
|
136
144
|
* Stop a compute job via P2P.
|
|
137
145
|
*/
|
|
138
|
-
computeStop(jobId: string, nodeUri:
|
|
146
|
+
computeStop(jobId: string, nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
|
|
139
147
|
/**
|
|
140
148
|
* Get compute status via P2P.
|
|
141
149
|
*/
|
|
142
|
-
computeStatus(nodeUri:
|
|
150
|
+
computeStatus(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId?: string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
|
|
143
151
|
/**
|
|
144
152
|
* Get compute result as an async generator of Uint8Array chunks via P2P.
|
|
145
153
|
* Supports resumable downloads via `offset` (byte position to resume from).
|
|
146
154
|
*/
|
|
147
|
-
getComputeResult(nodeUri:
|
|
148
|
-
getComputeResultUrl(nodeUri:
|
|
155
|
+
getComputeResult(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId: string, index: number, offset?: number): Promise<ComputeResultStream>;
|
|
156
|
+
getComputeResultUrl(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, jobId: string, index: number): Promise<string>;
|
|
149
157
|
/**
|
|
150
158
|
* Generate an auth token via P2P (auto-signs with Signer).
|
|
151
159
|
*/
|
|
152
|
-
generateAuthToken(consumer: Signer, nodeUri:
|
|
160
|
+
generateAuthToken(consumer: Signer, nodeUri: OceanNode, signal?: AbortSignal): Promise<string>;
|
|
153
161
|
/**
|
|
154
162
|
* Generate an auth token from a pre-signed request (no Signer needed).
|
|
155
163
|
*/
|
|
156
|
-
generateSignedAuthToken(address: string, signature: string, nonce: string, nodeUri:
|
|
164
|
+
generateSignedAuthToken(address: string, signature: string, nonce: string, nodeUri: OceanNode, signal?: AbortSignal): Promise<string>;
|
|
157
165
|
/**
|
|
158
166
|
* Resolve a DDO by DID via P2P GET_DDO command.
|
|
159
167
|
*/
|
|
160
|
-
resolveDdo(nodeUri:
|
|
168
|
+
resolveDdo(nodeUri: OceanNode, did: string, signal?: AbortSignal): Promise<any>;
|
|
161
169
|
/**
|
|
162
170
|
* Validate a DDO via P2P VALIDATE_DDO command.
|
|
163
171
|
*/
|
|
164
|
-
validateDdo(nodeUri:
|
|
172
|
+
validateDdo(nodeUri: OceanNode, ddo: DDO, signerOrAuthToken: SignerOrAuthTokenOrSignature, signal?: AbortSignal): Promise<ValidateMetadata>;
|
|
165
173
|
/**
|
|
166
174
|
* Invalidate an auth token via P2P.
|
|
167
175
|
*/
|
|
168
|
-
invalidateAuthToken(consumer: Signer, token: string, nodeUri:
|
|
176
|
+
invalidateAuthToken(consumer: Signer, token: string, nodeUri: OceanNode, signal?: AbortSignal): Promise<{
|
|
169
177
|
success: boolean;
|
|
170
178
|
}>;
|
|
171
179
|
/**
|
|
172
180
|
* Check if a P2P node is reachable by calling STATUS.
|
|
173
181
|
*/
|
|
174
|
-
isValidProvider(nodeUri:
|
|
182
|
+
isValidProvider(nodeUri: OceanNode, signal?: AbortSignal): Promise<boolean>;
|
|
175
183
|
/**
|
|
176
184
|
* PolicyServer passthrough via P2P.
|
|
177
185
|
*/
|
|
178
|
-
PolicyServerPassthrough(nodeUri:
|
|
186
|
+
PolicyServerPassthrough(nodeUri: OceanNode, request: PolicyServerPassthroughCommand, signal?: AbortSignal): Promise<any>;
|
|
179
187
|
/**
|
|
180
188
|
* Initialize Policy Server verification via P2P.
|
|
181
189
|
*/
|
|
182
|
-
initializePSVerification(nodeUri:
|
|
190
|
+
initializePSVerification(nodeUri: OceanNode, request: PolicyServerInitializeCommand, signal?: AbortSignal): Promise<any>;
|
|
183
191
|
/**
|
|
184
192
|
* Download node logs via P2P.
|
|
185
193
|
*/
|
|
186
|
-
downloadNodeLogs(nodeUri:
|
|
187
|
-
/**
|
|
188
|
-
* Fetch node logs via P2P with a pre-signed payload.
|
|
189
|
-
* P2P only — use downloadNodeLogs() for the auto-signed variant.
|
|
190
|
-
*/
|
|
191
|
-
fetchNodeLogs(nodeUri: string | Multiaddr[], address: string, signature: string, nonce: string, logParams?: NodeLogsParams): Promise<NodeLogEntry[]>;
|
|
194
|
+
downloadNodeLogs(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, startTime: string, endTime: string, maxLogs?: number, moduleName?: string, level?: string, page?: number, signal?: AbortSignal): Promise<NodeLogEntry[]>;
|
|
192
195
|
/**
|
|
193
196
|
* Fetch node configuration via P2P. Accepts a pre-signed payload —
|
|
194
197
|
* the caller is responsible for nonce retrieval and signing.
|
|
195
198
|
*/
|
|
196
|
-
fetchConfig(nodeUri:
|
|
199
|
+
fetchConfig(nodeUri: OceanNode, payload: Record<string, any>): Promise<any>;
|
|
197
200
|
/**
|
|
198
201
|
* Push node configuration via P2P. Accepts a pre-signed payload —
|
|
199
202
|
* the caller is responsible for nonce retrieval and signing.
|
|
200
203
|
*/
|
|
201
|
-
pushConfig(nodeUri:
|
|
204
|
+
pushConfig(nodeUri: OceanNode, payload: Record<string, any>): Promise<any>;
|
|
202
205
|
private getPersistentStorageSignaturePayload;
|
|
203
|
-
createPersistentStorageBucket(nodeUri:
|
|
206
|
+
createPersistentStorageBucket(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, payload: PersistentStorageCreateBucketRequest, signal?: AbortSignal): Promise<{
|
|
204
207
|
bucketId: string;
|
|
205
208
|
owner: string;
|
|
206
209
|
accessList: PersistentStorageAccessList[];
|
|
207
210
|
}>;
|
|
208
|
-
getPersistentStorageBuckets(nodeUri:
|
|
209
|
-
listPersistentStorageFiles(nodeUri:
|
|
210
|
-
getPersistentStorageFileObject(nodeUri:
|
|
211
|
-
uploadPersistentStorageFile(nodeUri:
|
|
212
|
-
deletePersistentStorageFile(nodeUri:
|
|
211
|
+
getPersistentStorageBuckets(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, owner: string, signal?: AbortSignal): Promise<PersistentStorageBucket[]>;
|
|
212
|
+
listPersistentStorageFiles(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, signal?: AbortSignal): Promise<PersistentStorageFileEntry[]>;
|
|
213
|
+
getPersistentStorageFileObject(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, fileName: string, signal?: AbortSignal): Promise<PersistentStorageObject>;
|
|
214
|
+
uploadPersistentStorageFile(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, fileName: string, content: P2PRequestBodyStream, signal?: AbortSignal): Promise<PersistentStorageFileEntry>;
|
|
215
|
+
deletePersistentStorageFile(nodeUri: OceanNode, signerOrAuthToken: SignerOrAuthTokenOrSignature, bucketId: string, fileName: string, signal?: AbortSignal): Promise<PersistentStorageDeleteFileResponse>;
|
|
213
216
|
}
|