@oceanprotocol/lib 3.0.4 → 3.1.0

package/dist/src/utils/Logger.d.ts

@@ -1,19 +1,19 @@
-export declare enum LogLevel {
-    None = -1,
-    Error = 0,
-    Warn = 1,
-    Log = 2,
-    Verbose = 3
-}
-export declare class Logger {
-    private logLevel;
-    constructor(logLevel?: LogLevel);
-    setLevel(logLevel: LogLevel): void;
-    bypass(...args: any[]): void;
-    debug(...args: any[]): void;
-    log(...args: any[]): void;
-    warn(...args: any[]): void;
-    error(...args: any[]): void;
-    private dispatch;
-}
-export declare const LoggerInstance: Logger;
+export declare enum LogLevel {
+    None = -1,
+    Error = 0,
+    Warn = 1,
+    Log = 2,
+    Verbose = 3
+}
+export declare class Logger {
+    private logLevel?;
+    constructor(logLevel?: LogLevel);
+    setLevel(logLevel: LogLevel): void;
+    bypass(...args: any[]): void;
+    debug(...args: any[]): void;
+    log(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+    private dispatch;
+}
+export declare const LoggerInstance: Logger;

package/dist/src/utils/OrderUtils.d.ts

@@ -0,0 +1,17 @@
+import { Signer } from 'ethers';
+import { Datatoken, Config, Asset, ConsumeMarketFee } from '../index';
+/**
+ * Orders an asset based on the specified pricing schema and configuration.
+ * @param {Asset} asset - The asset to be ordered.
+ * @param {Signer} consumerAccount - The signer account of the consumer.
+ * @param {Config} config - The configuration settings.
+ * @param {Datatoken} datatoken - The Datatoken instance.
+ * @param {ConsumeMarketFee} [consumeMarketOrderFee] - Optional consume market fee.
+ * @param {string} [consumeMarketFixedSwapFee='0'] - Fixed swap fee for consuming the market.
+ * @param {number} [datatokenIndex=0] - Index of the datatoken within the asset.
+ * @param {number} [serviceIndex=0] - Index of the service within the asset.
+ * @param {number} [fixedRateIndex=0] - Index of the fixed rate within the pricing schema.
+ * @returns {Promise<void>} - A promise that resolves when the asset order process is completed.
+ * @throws {Error} If the pricing schema is not supported or if required indexes are invalid.
+ */
+export declare function orderAsset(asset: Asset, consumerAccount: Signer, config: Config, datatoken: Datatoken, consumeMarketOrderFee?: ConsumeMarketFee, consumeMarketFixedSwapFee?: string, datatokenIndex?: number, serviceIndex?: number, fixedRateIndex?: number): Promise<import("@ethersproject/abstract-provider").TransactionResponse>;

package/dist/src/utils/ProviderErrors.d.ts

@@ -1 +1 @@
-export declare function getErrorMessage(error: Object): string;
+export declare function getErrorMessage(error: Object): string;

package/dist/src/utils/SignatureUtils.d.ts

@@ -1,12 +1,12 @@
-import { Signer } from 'ethers';
-/**
- * Signs the hash of a message using the provided signer.
- * @param {Signer} signer - The signer to use for signing the hash.
- * @param {string} message - The message to sign.
- * @returns {Promise<string>} - A Promise that resolves to the signature of the hash of the message.
- */
-export declare function signHash(signer: Signer, message: string): Promise<{
-    v: string;
-    r: string;
-    s: string;
-}>;
+import { Signer } from 'ethers';
+/**
+ * Signs the hash of a message using the provided signer.
+ * @param {Signer} signer - The signer to use for signing the hash.
+ * @param {string} message - The message to sign.
+ * @returns {Promise<string>} - A Promise that resolves to the signature of the hash of the message.
+ */
+export declare function signHash(signer: Signer, message: string): Promise<{
+    v: string;
+    r: string;
+    s: string;
+}>;

package/dist/src/utils/TokenUtils.d.ts

@@ -1,70 +1,70 @@
-import { Signer } from 'ethers';
-import { Config } from '../config';
-import { ReceiptOrEstimate, ReceiptOrDecimal } from '../@types';
-/**
- * Approve spender to spent amount tokens
- * @param {Signer} signer - The signer object
- * @param {Config} config - The config object
- * @param {string} account - The address of the caller
- * @param {string} tokenAddress - The address of the token
- * @param {string} spender - The address of the spender
- * @param {String} amount amount of ERC20 Datatokens (always expressed as wei)
- * @param {boolean} force  if true, will overwrite any previous allowence. Else, will check if allowence is enough and will not send a transaction if it's not needed
- * @param {number} [tokenDecimals] optional number of decimals of the token
- * @param {boolean} [estimateGas]  if true, returns the estimate gas cost for calling the method
- */
-export declare function approve<G extends boolean = false>(signer: Signer, config: Config, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean, tokenDecimals?: number, estimateGas?: G): Promise<ReceiptOrDecimal<G> | number>;
-/**
- * Approve spender to spent amount tokens
- * @param {Signer} signer - The signer object
- * @param {Config} config - The config object
- * @param {string} account - The address of the caller
- * @param {string} tokenAddress - The address of the token
- * @param {string} spender - The address of the spender
- * @param {string} amount amount of ERC20 tokens (always expressed as wei)
- * @param {boolean} force  if true, will overwrite any previous allowence. Else, will check if allowence is enough and will not send a transaction if it's not needed
- * @param {boolean} [estimateGas]  if true, returns the estimate gas cost for calling the method
- */
-export declare function approveWei<G extends boolean = false>(signer: Signer, config: Config, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-/**
- * Moves amount tokens from the caller’s account to recipient.
- * @param {Signer} signer - The signer object
- * @param {Config} config - The config object
- * @param {string} tokenAddress - The address of the token
- * @param {string} recipient - The address of the tokens receiver
- * @param {String} amount amount of ERC20 Datatokens (not as wei)
- * @param {String} estimateGas  if true returns the gas estimate
- */
-export declare function transfer<G extends boolean = false>(signer: Signer, config: Config, tokenAddress: string, recipient: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
-/**
- * Get Allowance for any Datatoken
- * @param {Signer} signer - The signer object
- * @param {string} tokenAddress - The address of the token
- * @param {string} account - The address of the caller
- * @param {string} spender - The address of the spender
- * @param {number} tokenDecimals optional number of decimals of the token
- */
-export declare function allowance(signer: Signer, tokenAddress: string, account: string, spender: string, tokenDecimals?: number): Promise<string>;
-/**
- * Get balance for any Datatoken
- * @param {Signer} signer - The signer object
- * @param {string} tokenAddress - The address of the token
- * @param {string} account - The address of the caller
- * @param {number} [tokenDecimals] optional number of decimals of the token
- */
-export declare function balance(signer: Signer, tokenAddress: string, account: string, tokenDecimals?: number): Promise<string>;
-/**
- * Get Allowance in wei for any erc20
- * @param {Signer} signer - The signer object
- * @param {string} tokenAddress - The address of the token
- * @param {string} account - The address of the caller
- * @param {string} spender - The address of the spneder
- */
-export declare function allowanceWei(signer: Signer, tokenAddress: string, account: string, spender: string): Promise<string>;
-/**
- * Get decimals for any Datatoken
- * @param {Signer} signer - The signer object
- * @param {String} tokenAddress - The address of the token
- * @return {Promise<number>} Number of decimals of the token
- */
-export declare function decimals(signer: Signer, tokenAddress: string): Promise<number>;
+import { Signer } from 'ethers';
+import { Config } from '../config';
+import { ReceiptOrEstimate, ReceiptOrDecimal } from '../@types';
+/**
+ * Approve spender to spent amount tokens
+ * @param {Signer} signer - The signer object
+ * @param {Config} config - The config object
+ * @param {string} account - The address of the caller
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} spender - The address of the spender
+ * @param {String} amount amount of ERC20 Datatokens (always expressed as wei)
+ * @param {boolean} force  if true, will overwrite any previous allowence. Else, will check if allowence is enough and will not send a transaction if it's not needed
+ * @param {number} [tokenDecimals] optional number of decimals of the token
+ * @param {boolean} [estimateGas]  if true, returns the estimate gas cost for calling the method
+ */
+export declare function approve<G extends boolean = false>(signer: Signer, config: Config, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean, tokenDecimals?: number, estimateGas?: G): Promise<ReceiptOrDecimal<G> | number>;
+/**
+ * Approve spender to spent amount tokens
+ * @param {Signer} signer - The signer object
+ * @param {Config} config - The config object
+ * @param {string} account - The address of the caller
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} spender - The address of the spender
+ * @param {string} amount amount of ERC20 tokens (always expressed as wei)
+ * @param {boolean} force  if true, will overwrite any previous allowence. Else, will check if allowence is enough and will not send a transaction if it's not needed
+ * @param {boolean} [estimateGas]  if true, returns the estimate gas cost for calling the method
+ */
+export declare function approveWei<G extends boolean = false>(signer: Signer, config: Config, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+/**
+ * Moves amount tokens from the caller’s account to recipient.
+ * @param {Signer} signer - The signer object
+ * @param {Config} config - The config object
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} recipient - The address of the tokens receiver
+ * @param {String} amount amount of ERC20 Datatokens (not as wei)
+ * @param {String} estimateGas  if true returns the gas estimate
+ */
+export declare function transfer<G extends boolean = false>(signer: Signer, config: Config, tokenAddress: string, recipient: string, amount: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+/**
+ * Get Allowance for any Datatoken
+ * @param {Signer} signer - The signer object
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} account - The address of the caller
+ * @param {string} spender - The address of the spender
+ * @param {number} tokenDecimals optional number of decimals of the token
+ */
+export declare function allowance(signer: Signer, tokenAddress: string, account: string, spender: string, tokenDecimals?: number): Promise<string>;
+/**
+ * Get balance for any Datatoken
+ * @param {Signer} signer - The signer object
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} account - The address of the caller
+ * @param {number} [tokenDecimals] optional number of decimals of the token
+ */
+export declare function balance(signer: Signer, tokenAddress: string, account: string, tokenDecimals?: number): Promise<string>;
+/**
+ * Get Allowance in wei for any erc20
+ * @param {Signer} signer - The signer object
+ * @param {string} tokenAddress - The address of the token
+ * @param {string} account - The address of the caller
+ * @param {string} spender - The address of the spneder
+ */
+export declare function allowanceWei(signer: Signer, tokenAddress: string, account: string, spender: string): Promise<string>;
+/**
+ * Get decimals for any Datatoken
+ * @param {Signer} signer - The signer object
+ * @param {String} tokenAddress - The address of the token
+ * @return {Promise<number>} Number of decimals of the token
+ */
+export declare function decimals(signer: Signer, tokenAddress: string): Promise<number>;

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

@@ -1,11 +1,12 @@
-export * from './Constants';
-export * from './ContractUtils';
-export * from './DatatokenName';
-export * from './DdoHelpers';
-export * from './FetchHelper';
-export * from './General';
-export * from './Logger';
-export * from './minAbi';
-export * from './SignatureUtils';
-export * from './TokenUtils';
-export * from './ProviderErrors';
+export * from './Constants';
+export * from './ContractUtils';
+export * from './DatatokenName';
+export * from './DdoHelpers';
+export * from './FetchHelper';
+export * from './General';
+export * from './Logger';
+export * from './minAbi';
+export * from './SignatureUtils';
+export * from './TokenUtils';
+export * from './ProviderErrors';
+export * from './OrderUtils';

package/dist/src/utils/minAbi.d.ts

@@ -1,38 +1,38 @@
-export declare const minAbi: ({
-    constant: boolean;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        name: string;
-        type: string;
-    }[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-} | {
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    constant?: undefined;
-    inputs?: undefined;
-    name?: undefined;
-    outputs?: undefined;
-    anonymous?: undefined;
-} | {
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    constant?: undefined;
-    outputs?: undefined;
-    payable?: undefined;
-    stateMutability?: undefined;
-})[];
+export declare const minAbi: ({
+    constant: boolean;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        name: string;
+        type: string;
+    }[];
+    payable: boolean;
+    stateMutability: string;
+    type: string;
+    anonymous?: undefined;
+} | {
+    payable: boolean;
+    stateMutability: string;
+    type: string;
+    constant?: undefined;
+    inputs?: undefined;
+    name?: undefined;
+    outputs?: undefined;
+    anonymous?: undefined;
+} | {
+    anonymous: boolean;
+    inputs: {
+        indexed: boolean;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    type: string;
+    constant?: undefined;
+    outputs?: undefined;
+    payable?: undefined;
+    stateMutability?: undefined;
+})[];

package/dist/test/config.d.ts

@@ -1,19 +1,19 @@
-import { providers, Signer } from 'ethers';
-export interface Addresses {
-    opfCommunityFeeCollectorAddress: string;
-    datatokenTemplateAddress: string;
-    nftTemplateAddress: string;
-    oceanAddress: string;
-    routerAddress: string;
-    sideStakingAddress: string;
-    fixedRateAddress: string;
-    dispenserAddress: string;
-    nftFactoryAddress: string;
-    daiAddress: string;
-    usdcAddress: string;
-    poolTemplateAddress: string;
-}
-export declare const GAS_PRICE = "3000000000";
-export declare const provider: providers.JsonRpcProvider;
-export declare const getTestConfig: (signer: Signer) => Promise<import("../src/config").Config>;
-export declare const getAddresses: () => any;
+import { providers, Signer } from 'ethers';
+export interface Addresses {
+    opfCommunityFeeCollectorAddress: string;
+    datatokenTemplateAddress: string;
+    nftTemplateAddress: string;
+    oceanAddress: string;
+    routerAddress: string;
+    sideStakingAddress: string;
+    fixedRateAddress: string;
+    dispenserAddress: string;
+    nftFactoryAddress: string;
+    daiAddress: string;
+    usdcAddress: string;
+    poolTemplateAddress: string;
+}
+export declare const GAS_PRICE = "3000000000";
+export declare const provider: providers.JsonRpcProvider;
+export declare const getTestConfig: (signer: Signer) => Promise<import("../src/config").Config>;
+export declare const getAddresses: () => any;

package/dist/test/integration/CodeExamples.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/integration/ComputeExamples.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/integration/ComputeFlow.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/integration/Provider.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/integration/PublishEditConsume.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/integration/PublishFlows.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/integration/helpers.d.ts

@@ -1,7 +1,7 @@
-import { ethers, Signer } from 'ethers';
-import { Aquarius, ProviderComputeInitialize, ConsumeMarketFee, Datatoken, Config, DDO } from '../../src';
-export declare function createAsset(name: string, symbol: string, owner: Signer, assetUrl: any, ddo: any, providerUrl: string, nftContractAddress: string, // addresses.ERC721Factory,
-aquariusInstance: Aquarius): Promise<any>;
-export declare function updateAssetMetadata(owner: Signer, updatedDdo: DDO, providerUrl: string, aquariusInstance: Aquarius): Promise<ethers.providers.TransactionResponse>;
-export declare function handleComputeOrder(order: ProviderComputeInitialize, datatokenAddress: string, payerAccount: Signer, consumerAccount: string, serviceIndex: number, datatoken: Datatoken, config: Config, consumeMarkerFee?: ConsumeMarketFee): Promise<any>;
-export declare function orderAsset(did: string, datatokenAddress: string, consumerAccount: string, serviceId: string, serviceIndex: number, datatoken: Datatoken, providerUrl: string): Promise<any>;
+import { ethers, Signer } from 'ethers';
+import { Aquarius, ProviderComputeInitialize, ConsumeMarketFee, Datatoken, Config, DDO } from '../../src';
+export declare function createAsset(name: string, symbol: string, owner: Signer, assetUrl: any, ddo: any, providerUrl: string, nftContractAddress: string, // addresses.ERC721Factory,
+aquariusInstance: Aquarius): Promise<any>;
+export declare function updateAssetMetadata(owner: Signer, updatedDdo: DDO, providerUrl: string, aquariusInstance: Aquarius): Promise<ethers.providers.TransactionResponse>;
+export declare function handleComputeOrder(order: ProviderComputeInitialize, datatokenAddress: string, payerAccount: Signer, consumerAccount: string, serviceIndex: number, datatoken: Datatoken, config: Config, consumeMarkerFee?: ConsumeMarketFee): Promise<any>;
+export declare function orderAsset(did: string, datatokenAddress: string, consumerAccount: string, serviceId: string, serviceIndex: number, datatoken: Datatoken, providerUrl: string): Promise<any>;

package/dist/test/unit/DFRewards.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/unit/Datatoken.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/unit/Dispenser.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/unit/FixedRateExchange.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/unit/Nft.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/unit/NftFactory.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/unit/Router.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/test/unit/veOcean.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "3.0.4",
+  "version": "3.1.0",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.js",
   "umd:main": "dist/lib.umd.js",
@@ -67,8 +67,8 @@
     "@types/mocha": "^10.0.0",
     "@types/node": "^18.0.1",
     "@types/node-fetch": "^3.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^5.45.0",
+    "@typescript-eslint/eslint-plugin": "^6.4.1",
+    "@typescript-eslint/parser": "^6.4.1",
     "auto-changelog": "^2.4.0",
     "chai": "^4.3.6",
     "chai-spies": "^1.0.0",
@@ -88,9 +88,9 @@
     "source-map-support": "^0.5.19",
     "ts-node": "^10.9.1",
     "ts-node-register": "^1.0.0",
-    "typedoc": "^0.24.6",
+    "typedoc": "^0.24.8",
     "typedoc-plugin-markdown": "^3.15.2",
-    "typescript": "^4.7.4"
+    "typescript": "^5.1.6"
   },
   "nyc": {
     "include": [