@oceanprotocol/lib 0.19.2 → 0.19.3

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;

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>;
+    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): 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

@@ -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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "0.19.2",
+  "version": "0.19.3",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/node/lib.js",
   "exports": "./dist/node/lib.js",
@@ -60,15 +60,15 @@
     "web3-eth-contract": "^1.5.2"
   },
   "devDependencies": {
-    "@truffle/hdwallet-provider": "^1.4.1",
+    "@truffle/hdwallet-provider": "^1.6.0",
     "@types/chai": "^4.2.19",
     "@types/chai-spies": "^1.0.3",
     "@types/crypto-js": "^4.0.1",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^16.10.2",
+    "@types/node": "^16.11.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",
+    "microbundle": "^0.14.1",
+    "mocha": "^9.1.3",
     "mock-local-storage": "^1.1.17",
     "nyc": "^15.1.0",
     "ora": "5.4.1",
     "prettier": "^2.3.1",
-    "release-it": "^14.10.0",
+    "release-it": "^14.11.7",
     "source-map-support": "^0.5.19",
-    "ts-node": "^10.0.0",
+    "ts-node": "^10.4.0",
     "ts-node-register": "^1.0.0",
-    "typedoc": "0.22.5",
-    "typescript": "^4.3.4"
+    "typedoc": "0.22.9",
+    "typescript": "^4.4.4"
   },
   "nyc": {
     "include": [

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
-```
-