@oceanprotocol/lib 1.0.0-next.38 → 1.0.0-next.39

package/dist/src/@types/Pool.d.ts

@@ -21,6 +21,8 @@ export interface TokenInOutMarket {
     tokenIn: string;
     tokenOut: string;
     marketFeeAddress: string;
+    tokenInDecimals?: number;
+    tokenOutDecimals?: number;
 }
 export interface AmountsInMaxFee {
     tokenAmountIn: string;

package/dist/src/factories/NFTFactory.d.ts

@@ -39,7 +39,7 @@ export declare class NftFactory {
      * @param {AbiItem | AbiItem[]} factory721ABI
      * @param {Web3} web3
      */
-    constructor(factory721Address: string, web3: Web3, factory721Abi?: AbiItem | AbiItem[], config?: Config);
+    constructor(factory721Address: string, web3: Web3, network?: string | number, factory721Abi?: AbiItem | AbiItem[], config?: Config);
     /**
      * Get estimated gas cost for deployERC721Contract value
      * @param {String} address

package/dist/src/pools/Router.d.ts

@@ -20,7 +20,7 @@ export declare class Router {
      * @param {AbiItem | AbiItem[]} Router
      * @param {Web3} web3
      */
-    constructor(routerAddress: string, web3: Web3, RouterAbi?: AbiItem | AbiItem[], config?: Config);
+    constructor(routerAddress: string, web3: Web3, network?: string | number, RouterAbi?: AbiItem | AbiItem[], config?: Config);
     /**
      * Estimate gas cost for buyDTBatch method
      * @param {String} address

package/dist/src/pools/balancer/Pool.d.ts

@@ -12,7 +12,9 @@ export declare class Pool {
     web3: Web3;
     GASLIMIT_DEFAULT: number;
     private config;
-    constructor(web3: Web3, poolAbi?: AbiItem | AbiItem[], config?: Config);
+    constructor(web3: Web3, network?: string | number, poolAbi?: AbiItem | AbiItem[], config?: Config);
+    amountToUnits(token: string, amount: string, tokenDecimals?: number): Promise<string>;
+    unitsToAmount(token: string, amount: string, tokenDecimals?: number): Promise<string>;
     /**
      * Get user shares of pool tokens
      * @param {String} account
@@ -112,9 +114,10 @@ export declare class Pool {
      * Returns the current token reserve amount
      * @param {String} poolAddress
      * @param {String} token  Address of the token to be checked
+     * @param {number} tokenDecimals optional number of decimals of the token
      * @return {String}
      */
-    getReserve(poolAddress: string, token: string): Promise<string>;
+    getReserve(poolAddress: string, token: string, tokenDecimals?: number): Promise<string>;
     /**
      * Get if a pool is finalized
      * Returns true if pool is finalized
@@ -156,9 +159,10 @@ export declare class Pool {
      * Get Market Fees available to be collected for a specific token
      * @param {String} poolAddress
      * @param {String} token token we want to check fees
+     * @param {number} tokenDecimals optional number of decimals of the token
      * @return {String}
      */
-    getMarketFees(poolAddress: string, token: string): Promise<string>;
+    getMarketFees(poolAddress: string, token: string, tokenDecimals?: number): Promise<string>;
     /**
      * Get Community  Get the current amount of fees which can be withdrawned by the Market
      * @return {CurrentFees}
@@ -173,9 +177,10 @@ export declare class Pool {
      * Get Community Fees available to be collected for a specific token
      * @param {String} poolAddress
      * @param {String} token token we want to check fees
+     * @param {number} tokenDecimals optional number of decimals of the token
      * @return {String}
      */
-    getCommunityFees(poolAddress: string, token: string): Promise<string>;
+    getCommunityFees(poolAddress: string, token: string, tokenDecimals?: number): Promise<string>;
     /**
      * Estimate gas cost for collectOPF
      * @param {String} address
@@ -330,41 +335,53 @@ export declare class Pool {
      * @param tokenOut token to get
      * @param tokenAmountOut exact amount of tokenOut
      * @param swapMarketFee consume market swap fee
+     * @param {number} tokenInDecimals optional number of decimals of the token to be swaped
+     * @param {number} tokenOutDecimals optional number of decimals of the token to get
      */
-    getAmountInExactOut(poolAddress: string, tokenIn: string, tokenOut: string, tokenAmountOut: string, swapMarketFee: string): Promise<PoolPriceAndFees>;
+    getAmountInExactOut(poolAddress: string, tokenIn: string, tokenOut: string, tokenAmountOut: string, swapMarketFee: string, tokenInDecimals?: number, tokenOutDecimals?: number): Promise<PoolPriceAndFees>;
     /**
      *  How many tokensOut you will get for a exact tokenAmountIn
      *  Returns: tokenAmountOut, LPFee, opcFee ,  publishMarketSwapFee, consumeMarketSwapFee
      * @param tokenIn token to be swaped
      * @param tokenOut token to get
-     * @param tokenAmountOut exact amount of tokenOut
-     * @param _consumeMarketSwapFee consume market swap fee
+     * @param tokenAmountIn exact amount of tokenIn
+     * @param swapMarketFee
+     * @param {number} tokenInDecimals optional number of decimals of the token to be swaped
+     * @param {number} tokenOutDecimals optional number of decimals of the token to get
      */
-    getAmountOutExactIn(poolAddress: string, tokenIn: string, tokenOut: string, tokenAmountIn: string, swapMarketFee: string): Promise<PoolPriceAndFees>;
+    getAmountOutExactIn(poolAddress: string, tokenIn: string, tokenOut: string, tokenAmountIn: string, swapMarketFee: string, tokenInDecimals?: number, tokenOutDecimals?: number): Promise<PoolPriceAndFees>;
     /**
      * Returns number of poolshares obtain by staking exact tokenAmountIn tokens
      * @param tokenIn tokenIn
      * @param tokenAmountIn exact number of tokens staked
+     * @param {number} poolDecimals optional number of decimals of the poool
+     * @param {number} tokenInDecimals optional number of decimals of the token
      */
-    calcPoolOutGivenSingleIn(poolAddress: string, tokenIn: string, tokenAmountIn: string): Promise<string>;
+    calcPoolOutGivenSingleIn(poolAddress: string, tokenIn: string, tokenAmountIn: string, poolDecimals?: number, tokenInDecimals?: number): Promise<string>;
     /**
      * Returns number of tokens to be staked to the pool in order to get an exact number of poolshares
      * @param tokenIn tokenIn
      * @param poolAmountOut expected amount of pool shares
+     * @param {number} poolDecimals optional number of decimals of the pool
+     * @param {number} tokenInDecimals optional number of decimals of the token
      */
-    calcSingleInGivenPoolOut(poolAddress: string, tokenIn: string, poolAmountOut: string): Promise<string>;
+    calcSingleInGivenPoolOut(poolAddress: string, tokenIn: string, poolAmountOut: string, poolDecimals?: number, tokenInDecimals?: number): Promise<string>;
     /**
      * Returns expected amount of tokenOut for removing exact poolAmountIn pool shares from the pool
      * @param tokenOut tokenOut
      * @param poolAmountIn amount of shares spent
+     * @param {number} poolDecimals optional number of decimals of the pool
+     * @param {number} tokenOutDecimals optional number of decimals of the token
      */
-    calcSingleOutGivenPoolIn(poolAddress: string, tokenOut: string, poolAmountIn: string): Promise<string>;
+    calcSingleOutGivenPoolIn(poolAddress: string, tokenOut: string, poolAmountIn: string, poolDecimals?: number, tokenOutDecimals?: number): Promise<string>;
     /**
      * Returns number of poolshares needed to withdraw exact tokenAmountOut tokens
      * @param tokenOut tokenOut
      * @param tokenAmountOut expected amount of tokensOut
+     * @param {number} poolDecimals optional number of decimals of the pool
+     * @param {number} tokenOutDecimals optional number of decimals of the token
      */
-    calcPoolInGivenSingleOut(poolAddress: string, tokenOut: string, tokenAmountOut: string): Promise<string>;
+    calcPoolInGivenSingleOut(poolAddress: string, tokenOut: string, tokenAmountOut: string, poolDecimals?: number, tokenOutDecimals?: number): Promise<string>;
     /**
      * Get LOG_SWAP encoded topic
      * @return {String}

package/dist/src/pools/dispenser/Dispenser.d.ts

@@ -26,7 +26,7 @@ export declare class Dispenser {
      * @param {String} dispenserAddress
      * @param {any} dispenserABI
      */
-    constructor(web3: Web3, dispenserAddress?: string, dispenserAbi?: AbiItem | AbiItem[], config?: Config);
+    constructor(web3: Web3, network?: string | number, dispenserAddress?: string, dispenserAbi?: AbiItem | AbiItem[], config?: Config);
     /**
      * Get information about a datatoken dispenser
      * @param {String} dtAddress

package/dist/src/pools/fixedRate/FixedRateExchange.d.ts

@@ -54,9 +54,9 @@ export declare class FixedRateExchange {
      * @param {any} web3
      * @param {any} fixedRateExchangeAbi
      */
-    constructor(web3: Web3, fixedRateAddress: string, fixedRateExchangeAbi?: AbiItem | AbiItem[], oceanAddress?: string, config?: Config);
-    amountToUnits(token: string, amount: string): Promise<string>;
-    unitsToAmount(token: string, amount: string): Promise<string>;
+    constructor(web3: Web3, fixedRateAddress: string, network?: string | number, fixedRateExchangeAbi?: AbiItem | AbiItem[], oceanAddress?: string, config?: Config);
+    amountToUnits(token: string, amount: string, tokenDecimals: number): Promise<string>;
+    unitsToAmount(token: string, amount: string, tokenDecimals: number): Promise<string>;
     /**
      * Creates unique exchange identifier.
      * @param {String} baseToken baseToken contract address

package/dist/src/pools/ssContracts/SideStaking.d.ts

@@ -8,9 +8,8 @@ export declare class SideStaking {
     web3: Web3;
     GASLIMIT_DEFAULT: number;
     config: Config;
-    constructor(web3: Web3, ssAbi?: AbiItem | AbiItem[], config?: Config);
-    amountToUnits(token: string, amount: string): Promise<string>;
-    unitsToAmount(token: string, amount: string): Promise<string>;
+    constructor(web3: Web3, network?: string | number, ssAbi?: AbiItem | AbiItem[], config?: Config);
+    unitsToAmount(token: string, amount: string, tokenDecimals?: number): Promise<string>;
     /**
      * Get (total vesting amount + token released from the contract when adding liquidity)
      * @param {String} ssAddress side staking contract address
@@ -58,9 +57,10 @@ export declare class SideStaking {
      * Get dt balance in the staking contract available for being added as liquidity
      * @param {String} ssAddress side staking contract address
      * @param {String} datatokenAddress datatokenAddress
+     * @param {number} tokenDecimals optional number of decimals of the token
      * @return {String}
      */
-    getDatatokenBalance(ssAddress: string, datatokenAddress: string): Promise<string>;
+    getDatatokenBalance(ssAddress: string, datatokenAddress: string, tokenDecimals?: number): Promise<string>;
     /**
      * Get block when vesting ends
      * @param {String} ssAddress side staking contract address
@@ -72,9 +72,10 @@ export declare class SideStaking {
      * Get total amount vesting
      * @param {String} ssAddress side staking contract address
      * @param {String} datatokenAddress datatokenAddress
+     * @param {number} tokenDecimals optional number of decimals of the token
      * @return {String}
      */
-    getvestingAmount(ssAddress: string, datatokenAddress: string): Promise<string>;
+    getvestingAmount(ssAddress: string, datatokenAddress: string, tokenDecimals?: number): Promise<string>;
     /**
      * Get last block publisher got some vested tokens
      * @param {String} ssAddress side staking contract address
@@ -86,9 +87,10 @@ export declare class SideStaking {
      * Get how much has been taken from the vesting amount
      * @param {String} ssAddress side staking contract address
      * @param {String} datatokenAddress datatokenAddress
+     * @param {number} tokenDecimals optional number of decimals of the token
      * @return {String}
      */
-    getvestingAmountSoFar(ssAddress: string, datatokenAddress: string): Promise<string>;
+    getvestingAmountSoFar(ssAddress: string, datatokenAddress: string, tokenDecimals?: number): Promise<string>;
     /**
      * Estimate gas cost for getVesting
      * @param {String} account

package/dist/src/tokens/Datatoken.d.ts

@@ -38,7 +38,7 @@ export declare class Datatoken {
      * @param {AbiItem | AbiItem[]} datatokensAbi
      * @param {Web3} web3
      */
-    constructor(web3: Web3, datatokensAbi?: AbiItem | AbiItem[], datatokensEnterpriseAbi?: AbiItem | AbiItem[], config?: Config);
+    constructor(web3: Web3, network?: string | number, datatokensAbi?: AbiItem | AbiItem[], datatokensEnterpriseAbi?: AbiItem | AbiItem[], config?: Config);
     /**
      * Estimate gas cost for mint method
      * @param {String} dtAddress Datatoken address

package/dist/src/tokens/NFT.d.ts

@@ -22,7 +22,7 @@ export declare class Nft {
     web3: Web3;
     startBlock: number;
     config: Config;
-    constructor(web3: Web3, nftAbi?: AbiItem | AbiItem[], config?: Config);
+    constructor(web3: Web3, network?: string | number, nftAbi?: AbiItem | AbiItem[], config?: Config);
     /**
      *  Estimate gas cost for createERC20 token creation
      * @param {String} nftAddress ERC721 addreess

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

@@ -8,5 +8,5 @@ export declare function getErcCreationParams(ercParams: Erc20CreateParams): any;
 export declare function getFreOrderParams(freParams: FreOrderParams): any;
 export declare function getFreCreationParams(freParams: FreCreationParams): any;
 export declare function getPoolCreationParams(web3: Web3, poolParams: PoolCreationParams): Promise<any>;
-export declare function unitsToAmount(web3: Web3, token: string, amount: string): Promise<string>;
-export declare function amountToUnits(web3: Web3, token: string, amount: string): Promise<string>;
+export declare function unitsToAmount(web3: Web3, token: string, amount: string, tokenDecimals?: number): Promise<string>;
+export declare function amountToUnits(web3: Web3, token: string, amount: string, tokenDecimals?: number): Promise<string>;

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

@@ -18,22 +18,25 @@ export declare function estApprove(web3: Web3, account: string, tokenAddress: st
  * @param {String} tokenAddress
  * @param {String} spender
  * @param {String} amount  (always expressed as wei)
- * @param {String} 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} 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
  */
-export declare function approve(web3: Web3, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean): Promise<TransactionReceipt | string>;
+export declare function approve(web3: Web3, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean, tokenDecimals?: number): Promise<TransactionReceipt | string>;
 /**
  * Get Allowance for any erc20
  * @param {Web3} web3
  * @param {String } tokenAdress
  * @param {String} account
  * @param {String} spender
+ * @param {number} tokenDecimals optional number of decimals of the token
  */
-export declare function allowance(web3: Web3, tokenAddress: string, account: string, spender: string): Promise<string>;
+export declare function allowance(web3: Web3, tokenAddress: string, account: string, spender: string, tokenDecimals?: number): Promise<string>;
 /**
  * Get balance for any erc20
  * @param {Web3} web3
  * @param {String} tokenAdress
  * @param {String} owner
  * @param {String} spender
+ * @param {number} tokenDecimals optional number of decimals of the token
  */
-export declare function balance(web3: Web3, tokenAddress: string, account: string): Promise<string>;
+export declare function balance(web3: Web3, tokenAddress: string, account: string, tokenDecimals?: number): Promise<string>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "1.0.0-next.38",
+  "version": "1.0.0-next.39",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.js",
   "umd:main": "dist/lib.umd.js",
@@ -73,7 +73,7 @@
     "@types/chai-spies": "^1.0.3",
     "@types/crypto-js": "^4.1.1",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^17.0.30",
+    "@types/node": "^17.0.31",
     "@types/node-fetch": "^3.0.3",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
@@ -87,12 +87,12 @@
     "eslint-plugin-prettier": "^4.0.0",
     "fs": "0.0.1-security",
     "microbundle": "^0.15.0",
-    "mocha": "^9.2.2",
+    "mocha": "^10.0.0",
     "mock-local-storage": "^1.1.21",
     "nyc": "^15.1.0",
     "ora": "5.4.1",
     "prettier": "^2.6.2",
-    "release-it": "^14.14.2",
+    "release-it": "^15.0.0",
     "source-map-support": "^0.5.19",
     "ts-node": "^10.7.0",
     "ts-node-register": "^1.0.0",