@oceanprotocol/lib 0.19.2 → 0.20.2

package/dist/node/metadatacache/MetadataCache.d.ts

@@ -26,7 +26,7 @@ export declare class MetadataCache {
     private logger;
     private metadataCacheUri;
     private get url();
-    constructor(metadataCacheUri: string, logger: Logger);
+    constructor(metadataCacheUri: string, logger: Logger, requestTimeout?: number);
     getVersionInfo(): Promise<any>;
     getAccessUrl(accessToken: any, payload: any): Promise<string>;
     queryMetadata(query: SearchQuery): Promise<any>;

package/dist/node/metadatacache/OnChainMetaData.d.ts

@@ -4,6 +4,7 @@ import { Contract } from 'web3-eth-contract';
 import { AbiItem } from 'web3-utils/types';
 import Web3 from 'web3';
 import { Logger } from '../utils';
+import { ConfigHelperConfig } from '../utils/ConfigHelper';
 import { MetadataCache } from '../metadatacache/MetadataCache';
 export interface rawMetadata {
     flags: number;
@@ -17,7 +18,8 @@ export declare class OnChainMetadata {
     DDOContract: Contract;
     private logger;
     metadataCache: MetadataCache;
-    constructor(web3: Web3, logger: Logger, DDOContractAddress: string, DDOContractABI: AbiItem | AbiItem[], metadataCache: MetadataCache);
+    private config;
+    constructor(web3: Web3, logger: Logger, DDOContractAddress: string, DDOContractABI: AbiItem | AbiItem[], metadataCache: MetadataCache, config?: ConfigHelperConfig);
     compressDDO(data: any): Promise<string>;
     publish(did: string, ddo: DDO, consumerAccount: string, encrypt?: boolean, validate?: boolean): Promise<TransactionReceipt>;
     update(did: string, ddo: DDO, consumerAccount: string, encrypt?: boolean, validate?: boolean): Promise<TransactionReceipt>;

package/dist/node/models/Config.d.ts

@@ -5,6 +5,7 @@ export declare class Config {
     providerAddress?: string;
     metadataCacheUri?: string;
     providerUri?: string;
+    rbacUri?: string;
     web3Provider?: any;
     oceanTokenAddress?: string;
     factoryAddress?: string;
@@ -25,5 +26,6 @@ export declare class Config {
     authTokenExpiration?: number;
     parityUri?: string;
     threshold?: number;
+    requestTimeout?: number;
 }
 export default Config;

package/dist/node/ocean/Assets.d.ts

@@ -8,7 +8,6 @@ import { SubscribablePromise } from '../utils';
 import { Instantiable, InstantiableConfig } from '../Instantiable.abstract';
 import { UserCustomParameters } from '../provider/Provider';
 import { TransactionReceipt } from 'web3-core';
-import { CredentialType } from '../ddo/interfaces/Credentials';
 import { Consumable } from '../ddo/interfaces/Consumable';
 export declare enum CreateProgressStep {
     CreatingDataToken = 0,
@@ -37,8 +36,8 @@ export declare class Assets extends Instantiable {
     create(metadata: Metadata, publisher: Account, services?: Service[], dtAddress?: string, cap?: string, name?: string, symbol?: string, providerUri?: string): SubscribablePromise<CreateProgressStep, DDO>;
     resolve(did: string): Promise<DDO>;
     editMetadata(ddo: DDO, newMetadata: EditableMetadata): Promise<DDO>;
-    updateCredentials(ddo: DDO, credentialType: CredentialType, allowList: string[], denyList: string[]): Promise<DDO>;
-    checkCredential(ddo: DDO, credentialType: CredentialType, value: string): Consumable;
+    updateCredentials(ddo: DDO, credentialType: string, allowList: string[], denyList: string[]): Promise<DDO>;
+    checkCredential(ddo: DDO, credentialType: string, value: string): Consumable;
     publishDdo(ddo: DDO, consumerAccount: string, encrypt?: boolean): Promise<TransactionReceipt>;
     updateMetadata(ddo: DDO, consumerAccount: string): Promise<TransactionReceipt>;
     editServiceTimeout(ddo: DDO, serviceIndex: number, timeout: number): Promise<DDO>;
@@ -48,10 +47,10 @@ export declare class Assets extends Instantiable {
     query(query: SearchQuery): Promise<any>;
     createAccessServiceAttributes(creator: Account, cost: string, datePublished: string, timeout?: number, providerUri?: string, requiredParameters?: ServiceCustomParametersRequired): Promise<ServiceAccess>;
     initialize(asset: DDO | string, serviceType: string, consumerAddress: string, serviceIndex: number, serviceEndpoint: string, userCustomParameters?: UserCustomParameters): Promise<any>;
-    order(asset: DDO | string, serviceType: string, payerAddress: string, serviceIndex?: number, mpAddress?: string, consumerAddress?: string, userCustomParameters?: UserCustomParameters, searchPreviousOrders?: boolean): Promise<string>;
-    download(asset: DDO | string, txId: string, tokenAddress: string, consumerAccount: Account, destination: string): Promise<string | true>;
+    order(asset: DDO | string, serviceType: string, payerAddress: string, serviceIndex?: number, mpAddress?: string, consumerAddress?: string, userCustomParameters?: UserCustomParameters, authService?: string, searchPreviousOrders?: boolean): Promise<string>;
+    download(asset: DDO | string, txId: string, tokenAddress: string, consumerAccount: Account, destination: string, index?: number, userCustomParameters?: UserCustomParameters): Promise<string | true>;
     simpleDownload(dtAddress: string, serviceEndpoint: string, txId: string, account: string): Promise<string>;
     getOrderHistory(account: Account, serviceType?: string, fromBlock?: number): Promise<Order[]>;
-    isConsumable(ddo: DDO, consumer?: string): Promise<Consumable>;
+    isConsumable(ddo: DDO, consumer?: string, credentialsType?: string, authService?: string): Promise<Consumable>;
     isUserCustomParametersValid(serviceCustomParameters: ServiceCustomParameter[], userCustomParameters?: UserCustomParameters): Promise<boolean>;
 }

package/dist/node/ocean/AssetsCredential.d.ts

@@ -1,6 +1,6 @@
 import { DDO } from '../ddo/DDO';
-import { Credentials, CredentialType, CredentialAction } from '../ddo/interfaces/Credentials';
-export declare function checkCredentialExist(credentials: Credentials, credentialType: CredentialType, credentialAction: CredentialAction): boolean;
-export declare function removeCredentialDetail(ddo: DDO, credentialType: CredentialType, credentialAction: CredentialAction): DDO;
-export declare function updateCredentialDetail(ddo: DDO, credentialType: CredentialType, list: string[], credentialAction: CredentialAction): DDO;
-export declare function addCredentialDetail(ddo: DDO, credentialType: CredentialType, list: string[], credentialAction: CredentialAction): DDO;
+import { Credentials, CredentialAction } from '../ddo/interfaces/Credentials';
+export declare function checkCredentialExist(credentials: Credentials, credentialType: string, credentialAction: CredentialAction): boolean;
+export declare function removeCredentialDetail(ddo: DDO, credentialType: string, credentialAction: CredentialAction): DDO;
+export declare function updateCredentialDetail(ddo: DDO, credentialType: string, list: string[], credentialAction: CredentialAction): DDO;
+export declare function addCredentialDetail(ddo: DDO, credentialType: string, list: string[], credentialAction: CredentialAction): DDO;

package/dist/node/ocean/Compute.d.ts

@@ -44,11 +44,11 @@ export declare const ComputeJobStatus: Readonly<{
 export declare class Compute extends Instantiable {
     static getInstance(config: InstantiableConfig): Promise<Compute>;
     getComputeAddress(did: string, serviceIndex?: number): Promise<string>;
-    start(asset: DDO | string, txId: string, tokenAddress: string, consumerAccount: Account, algorithm: ComputeAlgorithm, output?: ComputeOutput, serviceIndex?: string, serviceType?: string, additionalInputs?: ComputeInput[]): Promise<ComputeJob>;
+    start(asset: DDO | string, txId: string, tokenAddress: string, consumerAccount: Account, algorithm: ComputeAlgorithm, output?: ComputeOutput, serviceIndex?: string, serviceType?: string, additionalInputs?: ComputeInput[], userCustomParameters?: UserCustomParameters): Promise<ComputeJob>;
     stop(consumerAccount: Account, asset: DDO | string, jobId: string): Promise<ComputeJob>;
     delete(consumerAccount: Account, asset: DDO | string, jobId: string): Promise<ComputeJob>;
-    status(consumerAccount: Account, did?: string, ddo?: DDO, service?: ServiceCompute, jobId?: string, txId?: string, sign?: boolean): Promise<ComputeJob[]>;
-    result(consumerAccount: Account, asset: DDO | string, jobId: string): Promise<ComputeJob>;
+    status(consumerAccount: Account, did?: string, ddo?: DDO, service?: ServiceCompute, jobId?: string, txId?: string): Promise<ComputeJob[]>;
+    getResult(consumerAccount: Account, jobId: string, index: number, destination: string, did?: string, ddo?: DDO, service?: ServiceCompute): Promise<any>;
     createServerAttributes(serverId: string, serverType: string, cost: string, cpu: string, gpu: string, memory: string, disk: string, maxExecutionTime: number): Server;
     createContainerAttributes(image: string, tag: string, checksum: string): Container;
     createClusterAttributes(type: string, url: string): Cluster;
@@ -64,8 +64,8 @@ export declare class Compute extends Instantiable {
     createComputeService(consumerAccount: Account, cost: string, datePublished: string, providerAttributes: any, computePrivacy?: ServiceComputePrivacy, timeout?: number, providerUri?: string, requiredCustomParameters?: ServiceCustomParametersRequired): ServiceCompute;
     private checkOutput;
     isOrderable(dataset: DDO | string, serviceIndex: number, algorithm: ComputeAlgorithm, algorithmDDO?: DDO): Promise<boolean>;
-    orderAsset(consumerAccount: string, dataset: DDO | string, serviceIndex: number, algorithm: ComputeAlgorithm, mpAddress?: string, computeAddress?: string, userCustomParameters?: UserCustomParameters, searchPreviousOrders?: boolean): SubscribablePromise<OrderProgressStep, string>;
-    orderAlgorithm(asset: DDO | string, serviceType: string, payerAddress: string, serviceIndex?: number, mpAddress?: string, consumerAddress?: string, userCustomParameters?: UserCustomParameters, searchPreviousOrders?: boolean): Promise<string>;
+    orderAsset(consumerAccount: string, dataset: DDO | string, serviceIndex: number, algorithm: ComputeAlgorithm, mpAddress?: string, computeAddress?: string, userCustomParameters?: UserCustomParameters, authService?: string, searchPreviousOrders?: boolean): SubscribablePromise<OrderProgressStep, string>;
+    orderAlgorithm(asset: DDO | string, serviceType: string, payerAddress: string, serviceIndex?: number, mpAddress?: string, consumerAddress?: string, userCustomParameters?: UserCustomParameters, authService?: string, searchPreviousOrders?: boolean): Promise<string>;
     editComputePrivacy(ddo: DDO, serviceIndex: number, computePrivacy: ServiceComputePrivacy): Promise<DDO>;
     toggleAllowAllPublishedAlgorithms(ddo: DDO, serviceIndex: number, newState: boolean): Promise<DDO>;
     createPublisherTrustedAlgorithmfromDID(did: string, ddo?: DDO): Promise<publisherTrustedAlgorithm>;

package/dist/node/ocean/EventAccessControl.d.ts

@@ -0,0 +1,9 @@
+import { Instantiable, InstantiableConfig } from '../Instantiable.abstract';
+export declare class EventAccessControl extends Instantiable {
+    private baseUrl;
+    static getInstance(config: InstantiableConfig): Promise<EventAccessControl>;
+    setBaseUrl(url: string): Promise<void>;
+    get url(): string;
+    private getIsPermitArgs;
+    isPermit(component: string, eventType: string, authService: string, credentials: string, credentialsType: string, did?: string): Promise<boolean>;
+}

package/dist/node/ocean/Ocean.d.ts

@@ -13,10 +13,12 @@ import { Compute } from './Compute';
 import { OceanPool } from '../balancer/OceanPool';
 import { OceanFixedRateExchange } from '../exchange/FixedRateExchange';
 import { OceanDispenser } from '../dispenser/Dispenser';
+import { EventAccessControl } from './EventAccessControl';
 export declare class Ocean extends Instantiable {
     static getInstance(config: Config): Promise<Ocean>;
     network: Network;
     provider: Provider;
+    eventAccessControl: EventAccessControl;
     web3Provider: any;
     metadataCache: MetadataCache;
     onChainMetadata: OnChainMetadata;

package/dist/node/ocean/interfaces/Compute.d.ts

@@ -1,6 +1,13 @@
-import DID from '../DID';
 import { Metadata } from '../../ddo/interfaces/Metadata';
 import { MetadataAlgorithm } from '../../ddo/interfaces/MetadataAlgorithm';
+import { UserCustomParameters } from '../../provider/Provider';
+export declare type ComputeResultType = 'algorithmLog' | 'output';
+export interface ComputeResult {
+    filename: string;
+    filesize: number;
+    type: ComputeResultType;
+    index: number;
+}
 export interface ComputeJob {
     owner: string;
     did?: string;
@@ -9,12 +16,11 @@ export interface ComputeJob {
     dateFinished: string;
     status: number;
     statusText: string;
-    algorithmLogUrl: string;
-    resultsUrl: string[];
-    resultsDid?: DID;
+    results: ComputeResult[];
     inputDID?: string[];
     algoDID?: string;
     agreementId?: string;
+    expireTimestamp: number;
 }
 export interface ComputeOutput {
     publishAlgorithmLog?: boolean;
@@ -32,6 +38,7 @@ export interface ComputeInput {
     documentId: string;
     serviceId: number;
     transferTxId?: string;
+    userCustomParameters?: UserCustomParameters;
 }
 export interface ComputeAlgorithm {
     did?: string;
@@ -42,4 +49,5 @@ export interface ComputeAlgorithm {
     algoCustomParameters?: {
         [key: string]: any;
     };
+    userCustomParameters?: UserCustomParameters;
 }

package/dist/node/ocean/utils/WebServiceConnector.d.ts

@@ -2,7 +2,8 @@ import { Response } from 'node-fetch';
 import { Logger } from '../../utils';
 export declare class WebServiceConnector {
     logger: Logger;
-    constructor(logger: Logger);
+    requestTimeout: number;
+    constructor(logger: Logger, requestTimeout?: number);
     post(url: string, payload: BodyInit): Promise<Response>;
     postWithOctet(url: string, payload: BodyInit): Promise<Response>;
     postWithHeaders(url: string, payload: BodyInit, headers: any): Promise<Response>;

package/dist/node/provider/Provider.d.ts

@@ -9,6 +9,10 @@ export interface ServiceEndpoint {
     method: string;
     urlPath: string;
 }
+export interface ComputeLimits {
+    algoTimeLimit?: string;
+    storageExpiry?: string;
+}
 export interface UserCustomParameters {
     [key: string]: any;
 }
@@ -19,6 +23,7 @@ export declare class Provider extends Instantiable {
     computeAddress: string;
     providerAddress: string;
     providerVersion: string;
+    computeLimits: ComputeLimits;
     static getInstance(config: InstantiableConfig): Promise<Provider>;
     setBaseUrl(url: string): Promise<boolean>;
     get url(): string;
@@ -35,7 +40,8 @@ export declare class Provider extends Instantiable {
     computeStart(did: string, consumerAccount: Account, algorithm: ComputeAlgorithm, output?: ComputeOutput, txId?: string, serviceIndex?: string, serviceType?: string, tokenAddress?: string, additionalInputs?: ComputeInput[], userCustomParameters?: UserCustomParameters): Promise<ComputeJob | ComputeJob[]>;
     computeStop(did: string, consumerAccount: Account, jobId: string): Promise<ComputeJob | ComputeJob[]>;
     computeDelete(did: string, consumerAccount: Account, jobId: string): Promise<ComputeJob | ComputeJob[]>;
-    computeStatus(did: string, consumerAccount: Account, jobId?: string, txId?: string, sign?: boolean): Promise<ComputeJob | ComputeJob[]>;
+    computeStatus(did: string, consumerAccount: Account, jobId?: string, txId?: string): Promise<ComputeJob | ComputeJob[]>;
+    computeResult(jobId: string, index: number, destination: string, account: Account): Promise<any>;
     getInitializeEndpoint(): ServiceEndpoint;
     getNonceEndpoint(): ServiceEndpoint;
     getEncryptEndpoint(): ServiceEndpoint;
@@ -44,6 +50,7 @@ export declare class Provider extends Instantiable {
     getComputeStopEndpoint(): ServiceEndpoint;
     getComputeStatusEndpoint(): ServiceEndpoint;
     getComputeDeleteEndpoint(): ServiceEndpoint;
+    getComputeResultEndpoint(): ServiceEndpoint;
     getDownloadEndpoint(): ServiceEndpoint;
     isValidProvider(url: string): Promise<boolean>;
 }

package/dist/node/utils/ConfigHelper.d.ts

@@ -5,6 +5,10 @@ export interface ConfigHelperConfig extends Config {
     subgraphUri: string;
     explorerUri: string;
     oceanTokenSymbol: string;
+    transactionBlockTimeout: number;
+    transactionConfirmationBlocks: number;
+    transactionPollingTimeout: number;
+    gasFeeMultiplier: number;
 }
 export declare const configHelperNetworks: ConfigHelperConfig[];
 export declare class ConfigHelper {

package/dist/node/utils/ContractUtils.d.ts

@@ -0,0 +1,5 @@
+import Web3 from 'web3';
+import { Contract } from 'web3-eth-contract';
+import { ConfigHelperConfig } from './ConfigHelper';
+export declare function getFairGasPrice(web3: Web3, config: ConfigHelperConfig): Promise<string>;
+export declare function setContractDefaults(contract: Contract, config: ConfigHelperConfig): Contract;

package/dist/node/utils/index.d.ts

@@ -4,6 +4,6 @@ export * from './ConversionTypeHelpers';
 export * from './GeneratorHelpers';
 export * from './SubscribablePromise';
 export * from './SubscribableObserver';
-export * from './GasUtils';
+export * from './ContractUtils';
 export * from './AssetResolverHelper';
 export * from './Datatokens';

package/docs/beginners_guide.md

@@ -168,8 +168,8 @@ The process of creating and deploying the ERC20 datatokens has been automated by
 const Web3 = require("web3");
 const { Ocean, DataTokens } = require("@oceanprotocol/lib");
  
-const { factoryABI } = require("@oceanprotocol/contracts/artifacts/DTFactory.json");
-const { datatokensABI } = require("@oceanprotocol/contracts/artifacts/DataTokenTemplate.json");
+const factoryABI = require("@oceanprotocol/contracts/artifacts/DTFactory.json").abi;
+const datatokensABI = require("@oceanprotocol/contracts/artifacts/DataTokenTemplate.json").abi;
 const { config, contracts, urls } = require("./config");
  
 const init = async () => {

package/docs/quickstart_simple.md

@@ -114,8 +114,8 @@ Now open the `index.js` file in your text editor. Enter the following code and s
 const Web3 = require("web3");
 const { Ocean, DataTokens } = require("@oceanprotocol/lib");
 
-const { factoryABI } = require("@oceanprotocol/contracts/artifacts/DTFactory.json");
-const { datatokensABI } = require("@oceanprotocol/contracts/artifacts/DataTokenTemplate.json");
+const factoryABI = require("@oceanprotocol/contracts/artifacts/DTFactory.json").abi;
+const datatokensABI = require("@oceanprotocol/contracts/artifacts/DataTokenTemplate.json").abi;
 const { config, contracts, urls } = require("./config");
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "0.19.2",
+  "version": "0.20.2",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/node/lib.js",
   "exports": "./dist/node/lib.js",
@@ -55,20 +55,20 @@
     "node-abort-controller": "^2.0.0",
     "save-file": "^2.3.1",
     "uuid": "^8.3.2",
-    "web3": "^1.6.0",
+    "web3": "^1.6.1",
     "web3-core": "^1.5.3",
     "web3-eth-contract": "^1.5.2"
   },
   "devDependencies": {
-    "@truffle/hdwallet-provider": "^1.4.1",
-    "@types/chai": "^4.2.19",
+    "@truffle/hdwallet-provider": "^2.0.0",
+    "@types/chai": "^4.3.0",
     "@types/chai-spies": "^1.0.3",
-    "@types/crypto-js": "^4.0.1",
+    "@types/crypto-js": "^4.1.0",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^16.10.2",
+    "@types/node": "^17.0.7",
     "@types/node-fetch": "^3.0.3",
-    "@typescript-eslint/eslint-plugin": "^4.32.0",
-    "@typescript-eslint/parser": "^4.32.0",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
     "auto-changelog": "^2.3.0",
     "chai": "^4.3.4",
     "chai-spies": "^1.0.0",
@@ -77,18 +77,18 @@
     "eslint-config-oceanprotocol": "^1.5.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "microbundle": "^0.13.3",
-    "mocha": "^9.1.2",
-    "mock-local-storage": "^1.1.17",
+    "microbundle": "^0.14.2",
+    "mocha": "^9.1.3",
+    "mock-local-storage": "^1.1.19",
     "nyc": "^15.1.0",
     "ora": "5.4.1",
-    "prettier": "^2.3.1",
-    "release-it": "^14.10.0",
-    "source-map-support": "^0.5.19",
-    "ts-node": "^10.0.0",
+    "prettier": "^2.5.1",
+    "release-it": "^14.11.8",
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.4.0",
     "ts-node-register": "^1.0.0",
-    "typedoc": "0.22.5",
-    "typescript": "^4.3.4"
+    "typedoc": "0.22.10",
+    "typescript": "^4.5.4"
   },
   "nyc": {
     "include": [

package/dist/node/utils/GasUtils.d.ts

@@ -1,2 +0,0 @@
-import Web3 from 'web3';
-export declare function getFairGasPrice(web3: Web3): Promise<string>;

package/docs/parameters.md

@@ -1,63 +0,0 @@
-<!--
-Copyright 2021 Ocean Protocol Foundation
-SPDX-License-Identifier: Apache-2.0
--->
-
-# On Config Parameters
-
-We can set any config parameter (a) via an envvar, or (b) via a config file. Envvar values override config file values.
-
-An `Ocean` instance will hold a `Config` instance that holds various config parameters. These parameters need to get set. This is set based on what's input to `Ocean` constructor:
-
-1.  dict input: `Ocean({'network':..})`
-2.  Config object input: `Ocean(Config('config.ini'))`
-3.  no input, so it uses CONFIG_FILE envvar
-
-Here are examples.
-
-## 1. dict input, filled from envvars
-
-First, in console:
-
-```console
-export NETWORK_URL=https://rinkeby.infura.io/v3/<your Infura project id>
-export AQUARIUS_URL=https://aquarius.rinkeby.oceanprotocol.com
-export PROVIDER_URL=https://provider.rinkeby.oceanprotocol.com
-```
-
-For legacy support, you can also use `metadataStoreUri` instead of `metadataCacheUri`.
-
-## 1a. Unsetting envvars
-
-Recall that parameters set by envvars override config file values. So, to use a config value in a file, we must remove its envvar.
-
-Here's how. In the console:
-
-```console
-    unset NETWORK_URL AQUARIUS_URL PROVIDER_URL
-```
-
-## 2. Config object input, filled from config file
-
-First, in your working directory, create `config.ini` file and fill as follows:
-
-```console
-    [eth-network]
-    network = https://rinkeby.infura.io/v3/<your infura project id>
-
-    [resources]
-    aquarius.url = https://provider.rinkeby.oceanprotocol.com
-    provider.url = https://aquarius.rinkeby.oceanprotocol.com
-```
-
-
-## 3. No input, so it uses CONFIG_FILE envvar
-
-We'll use the `config.ini` file created from the previous example.
-
-Then, set an envvar for the config file. In the console:
-
-```console
-export CONFIG_FILE=config.ini
-```
-