@oceanprotocol/lib 1.0.0-next.8 → 1.1.0

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

@@ -4,7 +4,10 @@ import { TransactionReceipt } from 'web3-eth';
 import { Contract } from 'web3-eth-contract';
 import { MetadataProof } from '../../src/@types';
 import { Config } from '../models/index.js';
-import { MetadataAndTokenURI } from '../interfaces/Erc721Interface';
+import { MetadataAndTokenURI } from '../@types';
+/**
+ * ERC721 ROLES
+ */
 interface Roles {
     manager: boolean;
     deployERC20: boolean;
@@ -12,51 +15,340 @@ interface Roles {
     store: boolean;
 }
 export declare class Nft {
-    GASLIMIT_DEFAULT: number;
     factory721Address: string;
     factory721Abi: AbiItem | AbiItem[];
     nftAbi: AbiItem | AbiItem[];
     web3: Web3;
     startBlock: number;
     config: Config;
-    constructor(web3: Web3, nftAbi?: AbiItem | AbiItem[], config?: Config);
-    estGasCreateErc20(nftAddress: string, address: string, minter: string, feeManager: string, mpFeeAddress: string, feeToken: string, feeAmount: string, cap: string, name?: string, symbol?: string, templateIndex?: number, contractInstance?: Contract): Promise<any>;
-    createErc20(nftAddress: string, address: string, minter: string, feeManager: string, mpFeeAddress: string, feeToken: string, feeAmount: string, cap: string, name?: string, symbol?: string, templateIndex?: number): Promise<string>;
+    constructor(web3: Web3, network?: string | number, nftAbi?: AbiItem | AbiItem[], config?: Config);
+    /**
+     *  Estimate gas cost for createERC20 token creation
+     * @param {String} nftAddress ERC721 addreess
+     * @param {String} address User address
+     * @param {String} minter User set as initial minter for the ERC20
+     * @param {String} paymentCollector initial paymentCollector for this DT
+     * @param {String} mpFeeAddress Consume marketplace fee address
+     * @param {String} feeToken address of the token marketplace wants to add fee on top
+     * @param {String} feeAmount amount of feeToken to be transferred to mpFeeAddress on top, will be converted to WEI
+     * @param {String} cap Maximum cap (Number) - will be converted to wei
+     * @param {String} name Token name
+     * @param {String} symbol Token symbol
+     * @param {Number} templateIndex NFT template index
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasCreateErc20(nftAddress: string, address: string, minter: string, paymentCollector: string, mpFeeAddress: string, feeToken: string, feeAmount: string, cap: string, name?: string, symbol?: string, templateIndex?: number, contractInstance?: Contract): Promise<any>;
+    /**
+     * Create new ERC20 datatoken - only user with ERC20Deployer permission can succeed
+     * @param {String} nftAddress ERC721 addreess
+     * @param {String} address User address
+     * @param {String} minter User set as initial minter for the ERC20
+     * @param {String} paymentCollector initial paymentCollector for this DT
+     * @param {String} mpFeeAddress Consume marketplace fee address
+     * @param {String} feeToken address of the token marketplace wants to add fee on top
+     * @param {String} feeAmount amount of feeToken to be transferred to mpFeeAddress on top, will be converted to WEI
+     * @param {String} cap Maximum cap (Number) - will be converted to wei
+     * @param {String} name Token name
+     * @param {String} symbol Token symbol
+     * @param {Number} templateIndex NFT template index
+     * @return {Promise<string>} ERC20 datatoken address
+     */
+    createErc20(nftAddress: string, address: string, minter: string, paymentCollector: string, mpFeeAddress: string, feeToken: string, feeAmount: string, cap: string, name?: string, symbol?: string, templateIndex?: number): Promise<string>;
+    /**
+     * Estimate gas cost for add manager call
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Owner adress
+     * @param {String} manager User adress which is going to be assing manager
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasAddManager(nftAddress: string, address: string, manager: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Add Manager for NFT Contract (only NFT Owner can succeed)
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Owner adress
+     * @param {String} manager User adress which is going to be assing manager
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     addManager(nftAddress: string, address: string, manager: string): Promise<any>;
+    /**
+     * Estimate gas cost for removeManager method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Owner adress
+     * @param {String} manager User adress which is going to be removed as manager
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasRemoveManager(nftAddress: string, address: string, manager: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Removes a specific manager for NFT Contract (only NFT Owner can succeed)
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Owner adress
+     * @param {String} manager User adress which is going to be removed as manager
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     removeManager(nftAddress: string, address: string, manager: string): Promise<any>;
+    /**
+     *  Estimate gas cost for addToCreateERC20List method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} erc20Deployer User adress which is going to have erc20Deployer permission
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasAddErc20Deployer(nftAddress: string, address: string, erc20Deployer: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Add ERC20Deployer permission - only Manager can succeed
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} erc20Deployer User adress which is going to have erc20Deployer permission
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     addErc20Deployer(nftAddress: string, address: string, erc20Deployer: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for removeFromCreateERC20List method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} erc20Deployer Address of the user to be revoked ERC20Deployer Permission
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasRemoveErc20Deployer(nftAddress: string, address: string, erc20Deployer: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Remove ERC20Deployer permission - only Manager can succeed
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} erc20Deployer Address of the user to be revoked ERC20Deployer Permission
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     removeErc20Deployer(nftAddress: string, address: string, erc20Deployer: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addToMetadataList method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} metadataUpdater User adress which is going to have Metadata Updater permission
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasAddMetadataUpdater(nftAddress: string, address: string, metadataUpdater: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Add Metadata Updater permission - only Manager can succeed
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} metadataUpdater User adress which is going to have Metadata Updater permission
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     addMetadataUpdater(nftAddress: string, address: string, metadataUpdater: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for removeFromMetadataList method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} metadataUpdater Address of the user to be revoked Metadata updater Permission
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     esGasRemoveMetadataUpdater(nftAddress: string, address: string, metadataUpdater: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Remove Metadata Updater permission - only Manager can succeed
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} metadataUpdater Address of the user to be revoked Metadata updater Permission
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     removeMetadataUpdater(nftAddress: string, address: string, metadataUpdater: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addTo725StoreList method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} storeUpdater User adress which is going to have Store Updater permission
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasAddStoreUpdater(nftAddress: string, address: string, storeUpdater: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Add Store Updater permission - only Manager can succeed
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} storeUpdater User adress which is going to have Store Updater permission
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     addStoreUpdater(nftAddress: string, address: string, storeUpdater: string): Promise<TransactionReceipt>;
+    /**
+     *  Estimate gas cost for removeFrom725StoreList method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} storeUpdater Address of the user to be revoked Store Updater Permission
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasRemoveStoreUpdater(nftAddress: string, address: string, storeUpdater: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Remove Store Updater permission - only Manager can succeed
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Manager adress
+     * @param {String} storeUpdater Address of the user to be revoked Store Updater Permission
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     removeStoreUpdater(nftAddress: string, address: string, storeUpdater: string): Promise<TransactionReceipt>;
+    /**
+     *  Estimate gas cost for cleanPermissions method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Owner adress
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasCleanPermissions(nftAddress: string, address: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * This function allows to remove all ROLES at erc721 level: Managers, ERC20Deployer, MetadataUpdater, StoreUpdater
+     * Even NFT Owner has to readd himself as Manager
+     * Permissions at erc20 level stay.
+     * Only NFT Owner  can call it.
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address NFT Owner adress
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     cleanPermissions(nftAddress: string, address: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for transfer NFT method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} nftOwner Current NFT Owner adress
+     * @param {String} nftReceiver User which will receive the NFT, will also be set as Manager
+     * @param {Number} tokenId The id of the token to be transfered
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasTransferNft(nftAddress: string, nftOwner: string, nftReceiver: string, tokenId: number, contractInstance?: Contract): Promise<any>;
+    /**
+     * Transfers the NFT
+     * will clean all permissions both on erc721 and erc20 level.
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} nftOwner Current NFT Owner adress
+     * @param {String} nftReceiver User which will receive the NFT, will also be set as Manager
+     * @param {Number} tokenId The id of the token to be transfered
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     transferNft(nftAddress: string, nftOwner: string, nftReceiver: string, tokenId?: number): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for safeTransfer NFT method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} nftOwner Current NFT Owner adress
+     * @param {String} nftReceiver User which will receive the NFT, will also be set as Manager
+     * @param {Number} tokenId The id of the token to be transfered
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasSafeTransferNft(nftAddress: string, nftOwner: string, nftReceiver: string, tokenId: number, contractInstance?: Contract): Promise<any>;
+    /**
+     * safeTransferNFT Used for transferring the NFT, can be used by an approved relayer
+     * will clean all permissions both on erc721 and erc20 level.
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} nftOwner Current NFT Owner adress
+     * @param {String} nftReceiver User which will receive the NFT, will also be set as Manager
+     * @param {Number} tokenId The id of the token to be transfered
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     safeTransferNft(nftAddress: string, nftOwner: string, nftReceiver: string, tokenId?: number): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for setMetadata  method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} metadataUpdater metadataUpdater address
+     * @param {Number} metadataState User which will receive the NFT, will also be set as Manager
+     * @param {String} metadataDecryptorUrl
+     * @param {Number} tokenId The id of the token to be transfered
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasSetMetadata(nftAddress: string, metadataUpdater: string, metadataState: number, metadataDecryptorUrl: string, metadataDecryptorAddress: string, flags: string, data: string, metadataHash: string, metadataProofs?: MetadataProof[], contractInstance?: Contract): Promise<any>;
+    /**
+     * safeTransferNFT Used for transferring the NFT, can be used by an approved relayer
+     * will clean all permissions both on erc721 and erc20 level.
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address Caller address NFT Owner adress
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     setMetadata(nftAddress: string, address: string, metadataState: number, metadataDecryptorUrl: string, metadataDecryptorAddress: string, flags: string, data: string, metadataHash: string, metadataProofs?: MetadataProof[]): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for setMetadata  method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} metadataUpdater metadataUpdater address
+     * @param {MetaDataAndTokenURI} metadataAndTokenURI metaDataAndTokenURI object
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasSetMetadataAndTokenURI(nftAddress: string, metadataUpdater: string, metadataAndTokenURI: MetadataAndTokenURI, contractInstance?: Contract): Promise<any>;
+    /**
+     *  Helper function to improve UX sets both MetaData & TokenURI in one tx
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address Caller address
+     * @param {MetadataAndTokenURI} metadataAndTokenURI metaDataAndTokenURI object
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     setMetadataAndTokenURI(nftAddress: string, metadataUpdater: string, metadataAndTokenURI: MetadataAndTokenURI): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for setMetadataState  method
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} nftOwner Current NFT Owner adress
+     * @param {Number} metadataState new metadata state
+     * @param {Contract} nftContract optional contract instance
+     * @return {Promise<any>}
+     */
     estGasSetMetadataState(nftAddress: string, metadataUpdater: string, metadataState: number, contractInstance?: Contract): Promise<any>;
+    /**
+     * setMetadataState Used for updating the metadata State
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address Caller address => metadata updater
+     * @param {Number} metadataState new metadata state
+     * @return {Promise<TransactionReceipt>} trxReceipt
+     */
     setMetadataState(nftAddress: string, address: string, metadataState: number): Promise<TransactionReceipt>;
+    /** Estimate gas cost for setTokenURI method
+     * @param nftAddress erc721 contract adress
+     * @param address user adress
+     * @param data input data for TokenURI
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     estSetTokenURI(nftAddress: string, address: string, data: string): Promise<any>;
+    /** set TokenURI on an nft
+     * @param nftAddress erc721 contract adress
+     * @param address user adress
+     * @param data input data for TokenURI
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
     setTokenURI(nftAddress: string, address: string, data: string): Promise<any>;
+    /** Get Owner
+     * @param {String} nftAddress erc721 contract adress
+     * @return {Promise<string>} string
+     */
     getNftOwner(nftAddress: string): Promise<string>;
+    /** Get users NFT Permissions
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address user adress
+     * @return {Promise<Roles>}
+     */
     getNftPermissions(nftAddress: string, address: string): Promise<Roles>;
+    /** Get users Metadata, return Metadata details
+     * @param {String} nftAddress erc721 contract adress
+     * @return {Promise<Objecta>}
+     */
     getMetadata(nftAddress: string): Promise<Object>;
+    /** Get users ERC20Deployer role
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} address user adress
+     * @return {Promise<Roles>}
+     */
     isErc20Deployer(nftAddress: string, address: string): Promise<boolean>;
+    /** Gets data at a given `key`
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} key the key which value to retrieve
+     * @return {Promise<string>} The data stored at the key
+     */
     getData(nftAddress: string, key: string): Promise<string>;
+    /** Gets data at a given `key`
+     * @param {String} nftAddress erc721 contract adress
+     * @param {String} id
+     * @return {Promise<string>} The data stored at the key
+     */
     getTokenURI(nftAddress: string, id: number): Promise<string>;
 }
 export {};

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

@@ -1,11 +1,20 @@
 import Web3 from 'web3';
 import { Contract } from 'web3-eth-contract';
-import { Erc20CreateParams, FreCreationParams, PoolCreationParams } from '../interfaces';
+import { Erc20CreateParams, FreCreationParams, FreOrderParams, PoolCreationParams } from '../@types';
 import { Config } from '../models';
 export declare function setContractDefaults(contract: Contract, config: Config): Contract;
 export declare function getFairGasPrice(web3: Web3, config: Config): Promise<string>;
 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(poolParams: PoolCreationParams): 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 getPoolCreationParams(web3: Web3, poolParams: PoolCreationParams): Promise<any>;
+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>;
+/**
+ * Estimates the gas used when a function would be executed on chain
+ * @param {string} from account that calls the function
+ * @param {Function} functionToEstimateGas function that we need to estimate the gas
+ * @param {...any[]} args arguments of the function
+ * @return {Promise<number>} gas cost of the function
+ */
+export declare function estimateGas(from: string, functionToEstimateGas: Function, ...args: any[]): Promise<any>;

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

@@ -1,3 +1,7 @@
+/**
+ * Generate new datatoken name & symbol from a word list
+ * @return {<{ name: String; symbol: String }>} datatoken name & symbol. Produces e.g. "Endemic Jellyfish Token" & "ENDJEL-45"
+ */
 export declare function generateDtName(wordList?: {
     nouns: string[];
     adjectives: string[];

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

@@ -0,0 +1,4 @@
+/**
+ * Simple blocking sleep function
+ */
+export declare function sleep(ms: number): Promise<unknown>;

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

@@ -0,0 +1,8 @@
+import Decimal from 'decimal.js';
+import { Pool } from '..';
+export declare function calcMaxExactOut(balance: string): Decimal;
+export declare function calcMaxExactIn(balance: string): Decimal;
+export declare function getMaxSwapExactOut(poolInstance: Pool, poolAddress: string, tokenAddress: string): Promise<Decimal>;
+export declare function getMaxSwapExactIn(poolInstance: Pool, poolAddress: string, tokenAddress: string): Promise<Decimal>;
+export declare function getMaxAddLiquidity(poolInstance: Pool, poolAddress: string, tokenAddress: string): Promise<Decimal>;
+export declare function getMaxRemoveLiquidity(poolInstance: Pool, poolAddress: string, tokenAddress: string): Promise<Decimal>;

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

@@ -1,8 +1,6 @@
 import Web3 from 'web3';
-export declare function signText(web3: Web3, text: string, publicKey: string, password?: string): Promise<string>;
 export declare function signHash(web3: Web3, message: string, address: string): Promise<{
     v: string;
     r: string;
     s: string;
 }>;
-export declare function signWithHash(web3: Web3, text: string, publicKey: string, password?: string): Promise<string>;

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

@@ -1,7 +1,86 @@
 import { Contract } from 'web3-eth-contract';
 import { TransactionReceipt } from 'web3-core';
 import Web3 from 'web3';
+/**
+ * Estimate gas cost for approval function
+ * @param {String} account
+ * @param {String} tokenAddress
+ * @param {String} spender
+ * @param {String} amount
+ * @param {String} force
+ * @param {Contract} contractInstance optional contract instance
+ * @return {Promise<number>}
+ */
 export declare function estApprove(web3: Web3, account: string, tokenAddress: string, spender: string, amount: string, contractInstance?: Contract): Promise<number>;
-export declare function approve(web3: Web3, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean): Promise<TransactionReceipt | string>;
-export declare function allowance(web3: Web3, tokenAddress: string, account: string, spender: string): Promise<string>;
-export declare function balance(web3: Web3, tokenAddress: string, account: string): Promise<string>;
+/**
+ * Approve spender to spent amount tokens
+ * @param {String} account
+ * @param {String} tokenAddress
+ * @param {String} 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 {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, tokenDecimals?: number): Promise<TransactionReceipt | string>;
+/**
+ * Approve spender to spent amount tokens
+ * @param {String} account
+ * @param {String} tokenAddress
+ * @param {String} 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
+ */
+export declare function approveWei(web3: Web3, account: string, tokenAddress: string, spender: string, amount: string, force?: boolean): Promise<TransactionReceipt | string>;
+/**
+ * Estimate gas cost for transfer function
+ * @param {String} account
+ * @param {String} tokenAddress
+ * @param {String} recipient
+ * @param {String} amount
+ * @param {String} force
+ * @param {Contract} contractInstance optional contract instance
+ * @return {Promise<number>}
+ */
+export declare function estTransfer(web3: Web3, account: string, tokenAddress: string, recipient: string, amount: string, contractInstance?: Contract): Promise<number>;
+/**
+ * Moves amount tokens from the caller’s account to recipient.
+ * @param {String} account
+ * @param {String} tokenAddress
+ * @param {String} recipient
+ * @param {String} amount amount of ERC20 tokens (not 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
+ */
+export declare function transfer(web3: Web3, account: string, tokenAddress: string, recipient: string, amount: string): 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, tokenDecimals?: number): Promise<string>;
+/**
+ * Get Allowance for any erc20
+ * @param {Web3} web3
+ * @param {String } tokenAdress
+ * @param {String} account
+ * @param {String} spender
+ */
+export declare function allowanceWei(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, tokenDecimals?: number): Promise<string>;
+/**
+ * Get decimals for any erc20
+ * @param {Web3} web3
+ * @param {String} tokenAdress
+ * @return {Promise<number>} Number of decimals of the token
+ */
+export declare function decimals(web3: Web3, tokenAddress: string): Promise<number>;

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

@@ -7,3 +7,5 @@ export * from './DdoHelpers';
 export * from './Constants';
 export * from './SignatureUtils';
 export * from './TokenUtils';
+export * from './General';
+export * from './PoolHelpers';

package/dist/test/TestContractHandler.d.ts

@@ -1,44 +1,16 @@
 import Web3 from 'web3';
-import { Contract } from 'web3-eth-contract';
-import { AbiItem } from 'web3-utils/types';
-export declare class TestContractHandler {
-    accounts: string[];
-    ERC721Factory: Contract;
-    ERC20Template: Contract;
-    ERC721Template: Contract;
-    Router: Contract;
-    SideStaking: Contract;
-    FixedRate: Contract;
-    Dispenser: Contract;
-    OPFCollector: Contract;
-    PoolTemplate: Contract;
-    MockERC20: Contract;
-    MockOcean: Contract;
-    ERC721FactoryBytecode: string;
-    ERC20TemplateBytecode: string;
-    ERC721TemplateBytecode: string;
-    RouterBytecode: string;
-    SideStakingBytecode: string;
-    FixedRateBytecode: string;
-    DispenserBytecode: string;
-    PoolTemplateBytecode: string;
-    OPFCollectorBytecode: string;
-    MockERC20Bytecode: string;
-    OPFBytecode: string;
-    factory721Address: string;
-    template721Address: string;
-    template20Address: string;
+export interface Addresses {
+    opfCommunityFeeCollectorAddress: string;
+    poolTemplateAddress: string;
+    erc20TemplateAddress: string;
+    erc721TemplateAddress: string;
+    oceanAddress: string;
     routerAddress: string;
     sideStakingAddress: string;
     fixedRateAddress: string;
     dispenserAddress: string;
-    poolTemplateAddress: string;
-    opfCollectorAddress: string;
-    oceanAddress: string;
+    erc721FactoryAddress: string;
     daiAddress: string;
     usdcAddress: string;
-    web3: Web3;
-    constructor(web3: Web3, ERC721TemplateABI: AbiItem | AbiItem[], ERC20TemplateABI: AbiItem | AbiItem[], PoolTemplateABI?: AbiItem | AbiItem[], ERC721FactoryABI?: AbiItem | AbiItem[], RouterABI?: AbiItem | AbiItem[], SideStakingABI?: AbiItem | AbiItem[], FixedRateABI?: AbiItem | AbiItem[], DispenserABI?: AbiItem | AbiItem[], OPFABI?: AbiItem | AbiItem[], template721Bytecode?: string, template20Bytecode?: string, poolTemplateBytecode?: string, factory721Bytecode?: string, routerBytecode?: string, sideStakingBytecode?: string, fixedRateBytecode?: string, dispenserBytecode?: string, opfBytecode?: string);
-    getAccounts(): Promise<string[]>;
-    deployContracts(owner: string, routerABI?: AbiItem | AbiItem[]): Promise<void>;
 }
+export declare const deployContracts: (web3: Web3, owner: string) => Promise<Addresses>;

package/dist/test/config.d.ts

@@ -0,0 +1,5 @@
+import Web3 from 'web3';
+export declare const GAS_PRICE = "3000000000";
+export declare const web3: Web3;
+export declare const getTestConfig: (web3: Web3) => Promise<import("../src").Config>;
+export declare const getAddresses: () => any;

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

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