@oceanprotocol/lib 3.4.2 → 3.4.3

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

@@ -0,0 +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>;

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

@@ -0,0 +1,13 @@
+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';
+export * from './Assets';

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

@@ -0,0 +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;
+})[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "3.4.2",
+  "version": "3.4.3",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.js",
   "umd:main": "dist/lib.umd.js",
@@ -10,7 +10,7 @@
     "require": "./dist/lib.js",
     "default": "./dist/lib.modern.js"
   },
-  "types": "./dist/src/index.d.ts",
+  "types": "./dist/types/index.d.ts",
   "scripts": {
     "start": "npm run clean && npm run build:metadata && tsc -w",
     "build": "npm run clean && npm run build:metadata && microbundle build --format modern,esm,cjs,umd --compress --tsconfig tsconfig.json",