@oceanprotocol/lib 7.0.0-next.5 → 7.0.0-next.7
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 +2 -2
- package/dist/lib.module.mjs +3 -3
- package/dist/lib.umd.js +2 -2
- package/dist/types/@types/Compute.d.ts +21 -0
- package/dist/types/@types/Provider.d.ts +39 -0
- package/dist/types/services/providers/BaseProvider.d.ts +3 -1
- package/dist/types/services/providers/HttpProvider.d.ts +3 -1
- package/dist/types/services/providers/P2pProvider.d.ts +3 -1
- package/package.json +7 -1
- package/.mocharc.json +0 -8
- package/.nvmrc +0 -1
- package/CHANGELOG.md +0 -3263
- package/Cheatsheet.md +0 -326
- package/CodeExamples.md +0 -881
- package/ComputeExamples.md +0 -941
- package/dist/lib.cjs.map +0 -1
- package/dist/lib.module.mjs.map +0 -1
- package/dist/lib.umd.js.map +0 -1
- package/docs/.nojekyll +0 -1
- package/docs/README.md +0 -195
- package/docs/classes/Aquarius.md +0 -175
- package/docs/classes/Config.md +0 -481
- package/docs/classes/ConfigHelper.md +0 -66
- package/docs/classes/Datatoken.md +0 -1123
- package/docs/classes/Dispenser.md +0 -502
- package/docs/classes/Escrow.md +0 -285
- package/docs/classes/FixedRateExchange.md +0 -1068
- package/docs/classes/Logger.md +0 -191
- package/docs/classes/Nft.md +0 -970
- package/docs/classes/NftFactory.md +0 -861
- package/docs/classes/Provider.md +0 -727
- package/docs/classes/Router.md +0 -645
- package/docs/classes/SmartContract.md +0 -193
- package/docs/classes/SmartContractWithAddress.md +0 -268
- package/docs/enums/LogLevel.md +0 -63
- package/docs/interfaces/AbiInput.md +0 -63
- package/docs/interfaces/AbiItem.md +0 -107
- package/docs/interfaces/AbiOutput.md +0 -52
- package/docs/interfaces/Arweave.md +0 -32
- package/docs/interfaces/Asset.md +0 -227
- package/docs/interfaces/AssetDatatoken.md +0 -60
- package/docs/interfaces/AssetLastEvent.md +0 -63
- package/docs/interfaces/AssetNft.md +0 -105
- package/docs/interfaces/AssetPrice.md +0 -47
- package/docs/interfaces/ComputeAlgorithm.md +0 -82
- package/docs/interfaces/ComputeAsset.md +0 -56
- package/docs/interfaces/ComputeEnvFees.md +0 -30
- package/docs/interfaces/ComputeEnvFeesStructure.md +0 -20
- package/docs/interfaces/ComputeEnvironment.md +0 -177
- package/docs/interfaces/ComputeJob.md +0 -173
- package/docs/interfaces/ComputeOutput.md +0 -118
- package/docs/interfaces/ComputeResourcesPricingInfo.md +0 -30
- package/docs/interfaces/ComputeResourcesRequest.md +0 -34
- package/docs/interfaces/ComputeResult.md +0 -52
- package/docs/interfaces/ConsumeMarketFee.md +0 -41
- package/docs/interfaces/Credential.md +0 -30
- package/docs/interfaces/Credentials.md +0 -30
- package/docs/interfaces/DDO.md +0 -137
- package/docs/interfaces/DatatokenCreateParams.md +0 -107
- package/docs/interfaces/DatatokenRoles.md +0 -30
- package/docs/interfaces/DispenserCreationParams.md +0 -63
- package/docs/interfaces/DispenserParams.md +0 -52
- package/docs/interfaces/DispenserToken.md +0 -85
- package/docs/interfaces/DownloadResponse.md +0 -30
- package/docs/interfaces/Event.md +0 -73
- package/docs/interfaces/FeesInfo.md +0 -74
- package/docs/interfaces/FileInfo.md +0 -118
- package/docs/interfaces/Files.md +0 -41
- package/docs/interfaces/FixedPriceExchange.md +0 -162
- package/docs/interfaces/FreCreationParams.md +0 -118
- package/docs/interfaces/FreOrderParams.md +0 -85
- package/docs/interfaces/GraphqlQuery.md +0 -69
- package/docs/interfaces/Ipfs.md +0 -32
- package/docs/interfaces/Metadata.md +0 -193
- package/docs/interfaces/MetadataAlgorithm.md +0 -69
- package/docs/interfaces/MetadataAndTokenURI.md +0 -107
- package/docs/interfaces/MetadataProof.md +0 -52
- package/docs/interfaces/NftCreateData.md +0 -74
- package/docs/interfaces/NftRoles.md +0 -52
- package/docs/interfaces/Operation.md +0 -145
- package/docs/interfaces/OrderParams.md +0 -52
- package/docs/interfaces/PriceAndFees.md +0 -52
- package/docs/interfaces/ProviderComputeInitialize.md +0 -41
- package/docs/interfaces/ProviderComputeInitializeResults.md +0 -43
- package/docs/interfaces/ProviderFees.md +0 -96
- package/docs/interfaces/ProviderInitialize.md +0 -52
- package/docs/interfaces/PublisherTrustedAlgorithm.md +0 -47
- package/docs/interfaces/PublishingMarketFee.md +0 -41
- package/docs/interfaces/Purgatory.md +0 -34
- package/docs/interfaces/RunningPlatform.md +0 -30
- package/docs/interfaces/SearchQuery.md +0 -67
- package/docs/interfaces/Service.md +0 -138
- package/docs/interfaces/ServiceComputeOptions.md +0 -63
- package/docs/interfaces/ServiceEndpoint.md +0 -41
- package/docs/interfaces/Smartcontract-1.md +0 -58
- package/docs/interfaces/Stats.md +0 -47
- package/docs/interfaces/Template.md +0 -30
- package/docs/interfaces/TokenOrder.md +0 -63
- package/docs/interfaces/UrlFile.md +0 -71
- package/docs/interfaces/UserCustomParameters.md +0 -7
- package/docs/interfaces/ValidateMetadata.md +0 -52
- package/docs/modules.md +0 -850
- package/typedoc.json +0 -4
|
@@ -95,6 +95,27 @@ export interface ComputeJob {
|
|
|
95
95
|
OOMKilled?: boolean;
|
|
96
96
|
};
|
|
97
97
|
}
|
|
98
|
+
export interface ComputeJobPayment {
|
|
99
|
+
chainId: number;
|
|
100
|
+
token: string;
|
|
101
|
+
lockTx: string | null;
|
|
102
|
+
claimTx: string | null;
|
|
103
|
+
cancelTx: string | null;
|
|
104
|
+
cost: number;
|
|
105
|
+
}
|
|
106
|
+
export interface NodeComputeJob extends ComputeJob {
|
|
107
|
+
environment?: string;
|
|
108
|
+
stopRequested?: boolean;
|
|
109
|
+
resources?: ComputeResourceRequest[];
|
|
110
|
+
isFree?: boolean;
|
|
111
|
+
algoStartTimestamp?: string;
|
|
112
|
+
algoStopTimestamp?: string;
|
|
113
|
+
payment?: ComputeJobPayment;
|
|
114
|
+
algoDuration?: number;
|
|
115
|
+
queueMaxWaitTime?: number;
|
|
116
|
+
jobIdHash?: string;
|
|
117
|
+
maxJobDuration?: number;
|
|
118
|
+
}
|
|
98
119
|
export interface ComputeOutputEncryption {
|
|
99
120
|
encryptMethod: EncryptMethod.AES;
|
|
100
121
|
key: string;
|
|
@@ -37,6 +37,45 @@ export interface ServiceEndpoint {
|
|
|
37
37
|
method: string;
|
|
38
38
|
urlPath: string;
|
|
39
39
|
}
|
|
40
|
+
export interface NodeStatusProvider {
|
|
41
|
+
chainId: string;
|
|
42
|
+
network: string;
|
|
43
|
+
}
|
|
44
|
+
export interface NodeStatusIndexer {
|
|
45
|
+
chainId: string;
|
|
46
|
+
network: string;
|
|
47
|
+
block: string;
|
|
48
|
+
}
|
|
49
|
+
export interface NodeStatus {
|
|
50
|
+
id: string;
|
|
51
|
+
publicKey: string;
|
|
52
|
+
friendlyName: string;
|
|
53
|
+
address: string;
|
|
54
|
+
version: string;
|
|
55
|
+
http: boolean;
|
|
56
|
+
p2p: boolean;
|
|
57
|
+
provider: NodeStatusProvider[];
|
|
58
|
+
indexer: NodeStatusIndexer[];
|
|
59
|
+
escrowAddress: Record<string, string>;
|
|
60
|
+
supportedStorage: Record<string, boolean>;
|
|
61
|
+
platform: {
|
|
62
|
+
cpus: number;
|
|
63
|
+
freemem: number;
|
|
64
|
+
totalmem: number;
|
|
65
|
+
loadavg: number[];
|
|
66
|
+
arch: string;
|
|
67
|
+
machine: string;
|
|
68
|
+
platform: string;
|
|
69
|
+
osType: string;
|
|
70
|
+
node: string;
|
|
71
|
+
};
|
|
72
|
+
codeHash: string;
|
|
73
|
+
allowedAdmins: {
|
|
74
|
+
addresses: string[];
|
|
75
|
+
accessLists: string[] | null;
|
|
76
|
+
};
|
|
77
|
+
uptime: number;
|
|
78
|
+
}
|
|
40
79
|
export interface UserCustomParameters {
|
|
41
80
|
[key: string]: any;
|
|
42
81
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type Multiaddr } from '@multiformats/multiaddr';
|
|
2
2
|
import { Signer } from 'ethers';
|
|
3
|
-
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ComputeResultStream, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse } from '../../@types/index.js';
|
|
3
|
+
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ComputeResultStream, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, NodeStatus, NodeComputeJob } from '../../@types/index.js';
|
|
4
4
|
import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
|
|
5
5
|
import { type P2PConfig } from './P2pProvider.js';
|
|
6
6
|
export { OCEAN_P2P_PROTOCOL, type P2PConfig } from './P2pProvider.js';
|
|
@@ -37,6 +37,8 @@ export declare class BaseProvider {
|
|
|
37
37
|
PolicyServerPassthrough(nodeUri: string | Multiaddr[], request: PolicyServerPassthroughCommand, signal?: AbortSignal): Promise<any>;
|
|
38
38
|
initializePSVerification(nodeUri: string | Multiaddr[], request: PolicyServerInitializeCommand, signal?: AbortSignal): Promise<any>;
|
|
39
39
|
downloadNodeLogs(nodeUri: string | Multiaddr[], signer: Signer, startTime: string, endTime: string, maxLogs?: number, moduleName?: string, level?: string, page?: number, signal?: AbortSignal): Promise<any>;
|
|
40
|
+
getNodeStatus(nodeUri: string | Multiaddr[], signal?: AbortSignal): Promise<NodeStatus>;
|
|
41
|
+
getNodeJobs(nodeUri: string | Multiaddr[], jobId?: string, fromTimestamp?: number, signal?: AbortSignal): Promise<NodeComputeJob[]>;
|
|
40
42
|
setupP2P(config: P2PConfig): Promise<void>;
|
|
41
43
|
getDiscoveredNodes(): Array<{
|
|
42
44
|
peerId: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
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 } 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 } from '../../@types/index.js';
|
|
3
3
|
import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
|
|
4
4
|
export declare class HttpProvider {
|
|
5
5
|
protected getConsumerAddress(s: Signer | string): Promise<string>;
|
|
@@ -11,6 +11,8 @@ export declare class HttpProvider {
|
|
|
11
11
|
* @return {Promise<any>}
|
|
12
12
|
*/
|
|
13
13
|
getEndpoints(nodeUri: string, authorization?: string): Promise<any>;
|
|
14
|
+
getNodeStatus(nodeUri: string, signal?: AbortSignal): Promise<NodeStatus>;
|
|
15
|
+
getNodeJobs(nodeUri: string, jobId?: string, fromTimestamp?: number, signal?: AbortSignal): Promise<NodeComputeJob[]>;
|
|
14
16
|
/**
|
|
15
17
|
* Returns the node public key
|
|
16
18
|
* @return {string} The node public key
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type Libp2pOptions } from 'libp2p';
|
|
2
2
|
import { type Multiaddr } from '@multiformats/multiaddr';
|
|
3
3
|
import { Signer } from 'ethers';
|
|
4
|
-
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, ComputeResultStream } from '../../@types/index.js';
|
|
4
|
+
import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, ComputeResultStream, NodeStatus, NodeComputeJob } from '../../@types/index.js';
|
|
5
5
|
import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
|
|
6
6
|
export declare const OCEAN_P2P_PROTOCOL = "/ocean/nodes/1.0.0";
|
|
7
7
|
export interface P2PConfig {
|
|
@@ -73,6 +73,8 @@ export declare class P2pProvider {
|
|
|
73
73
|
* @param {string} nodeUri - multiaddr of the node
|
|
74
74
|
*/
|
|
75
75
|
getEndpoints(nodeUri: string | Multiaddr[]): Promise<any>;
|
|
76
|
+
getNodeStatus(nodeUri: string | Multiaddr[], signal?: AbortSignal): Promise<NodeStatus>;
|
|
77
|
+
getNodeJobs(nodeUri: string | Multiaddr[], jobId?: string, fromTimestamp?: number, signal?: AbortSignal): Promise<NodeComputeJob[]>;
|
|
76
78
|
/**
|
|
77
79
|
* Get current nonce from the node via P2P.
|
|
78
80
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@oceanprotocol/lib",
|
|
3
3
|
"source": "./src/index.ts",
|
|
4
|
-
"version": "7.0.0-next.
|
|
4
|
+
"version": "7.0.0-next.7",
|
|
5
5
|
"description": "JavaScript client library for Ocean Protocol",
|
|
6
6
|
"main": "./dist/lib.cjs",
|
|
7
7
|
"umd:main": "dist/lib.umd.js",
|
|
@@ -16,6 +16,12 @@
|
|
|
16
16
|
}
|
|
17
17
|
},
|
|
18
18
|
"types": "./dist/types/index.d.ts",
|
|
19
|
+
"files": [
|
|
20
|
+
"dist",
|
|
21
|
+
"!dist/*.map",
|
|
22
|
+
"README.md",
|
|
23
|
+
"LICENSE"
|
|
24
|
+
],
|
|
19
25
|
"scripts": {
|
|
20
26
|
"start": "npm run clean && npm run build:metadata && tsc -w",
|
|
21
27
|
"build": "npm run clean && npm run build:metadata && microbundle build --format modern,esm,cjs,umd --compress --tsconfig tsconfig.json",
|
package/.mocharc.json
DELETED
package/.nvmrc
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
20
|