@oceanprotocol/lib 0.20.2 → 1.0.0-next.11

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

@@ -0,0 +1,229 @@
+import { Contract } from 'web3-eth-contract';
+import Web3 from 'web3';
+import { TransactionReceipt } from 'web3-core';
+import { AbiItem } from 'web3-utils';
+import { Operation } from '../@types/Router';
+import { Config } from '../models/index.js';
+/**
+ * Provides an interface for FactoryRouter contract
+ */
+export declare class Router {
+    GASLIMIT_DEFAULT: number;
+    routerAddress: string;
+    RouterAbi: AbiItem | AbiItem[];
+    web3: Web3;
+    config: Config;
+    router: Contract;
+    /**
+     * Instantiate Router.
+     * @param {String} routerAddress
+     * @param {AbiItem | AbiItem[]} Router
+     * @param {Web3} web3
+     */
+    constructor(routerAddress: string, web3: Web3, RouterAbi?: AbiItem | AbiItem[], config?: Config);
+    /**
+     * Estimate gas cost for buyDTBatch method
+     * @param {String} address
+     * @param {Operation} operations Operations objects array
+     * @return {Promise<TransactionReceipt>} Transaction receipt
+     */
+    estGasBuyDTBatch(address: string, operations: Operation[]): Promise<any>;
+    /**
+     * BuyDTBatch
+     * @param {String} address
+     * @param {Operation} operations Operations objects array
+     * @return {Promise<TransactionReceipt>} Transaction receipt
+     */
+    buyDTBatch(address: string, operations: Operation[]): Promise<TransactionReceipt>;
+    /** Check if a token is on ocean tokens list, if true opfFee is ZERO in pools with that token/DT
+     * @return {Promise<boolean>} true if is on the list.
+     */
+    isOceanTokens(address: string): Promise<boolean>;
+    /** Check if an address is a side staking contract.
+     * @return {Promise<boolean>} true if is a SS contract
+     */
+    isSideStaking(address: string): Promise<boolean>;
+    /** Check if an address is a Fixed Rate contract.
+     * @return {Promise<boolean>} true if is a Fixed Rate contract
+     */
+    isFixedPrice(address: string): Promise<boolean>;
+    /** Get Router Owner
+     * @return {Promise<string>} Router Owner address
+     */
+    getOwner(): Promise<string>;
+    /** Get NFT Factory address
+     * @return {Promise<string>} NFT Factory address
+     */
+    getNFTFactory(): Promise<string>;
+    /** Check if an address is a pool template contract.
+     * @return {Promise<boolean>} true if is a Template
+     */
+    isPoolTemplate(address: string): Promise<boolean>;
+    /**
+     * Estimate gas cost for addOceanToken
+     * @param {String} address
+     * @param {String} tokenAddress token address we want to add
+     * @param {Contract} routerContract optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasAddOceanToken(address: string, tokenAddress: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Add a new token to oceanTokens list, pools with baseToken in this list have NO opf Fee
+     * @param {String} address caller address
+     * @param {String} tokenAddress token address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    addOceanToken(address: string, tokenAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for removeOceanToken
+     * @param {String} address caller address
+     * @param {String} tokenAddress token address we want to add
+     * @param {Contract} routerContract optional contract instance
+     * @return {Promise<any>}
+     */
+    estGasRemoveOceanToken(address: string, tokenAddress: string, contractInstance?: Contract): Promise<any>;
+    /**
+     * Remove a token from oceanTokens list, pools without baseToken in this list have a opf Fee
+     * @param {String} address
+     * @param {String} tokenAddress address to remove
+     * @return {Promise<TransactionReceipt>}
+     */
+    removeOceanToken(address: string, tokenAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addSSContract method
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    estGasAddSSContract(address: string, tokenAddress: string): Promise<any>;
+    /**
+     * Add a new contract to ssContract list, after is added, can be used when deploying a new pool
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    addSSContract(address: string, tokenAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for removeSSContract method
+     * @param {String} address caller address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    estGasRemoveSSContract(address: string, tokenAddress: string): Promise<any>;
+    /**
+     * Removes a new contract from ssContract list
+     * @param {String} address caller address
+     * @param {String} tokenAddress contract address to removed
+     * @return {Promise<TransactionReceipt>}
+     */
+    removeSSContract(address: string, tokenAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addFixedRateContract method
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    estGasAddFixedRateContract(address: string, tokenAddress: string): Promise<any>;
+    /**
+     * Add a new contract to fixedRate list, after is added, can be used when deploying a new pool
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    addFixedRateContract(address: string, tokenAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addFixedRateContract method
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    estGasRemoveFixedRateContract(address: string, tokenAddress: string): Promise<any>;
+    /**
+     * Removes a contract from fixedRate list
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    removeFixedRateContract(address: string, tokenAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addDispenserContract method
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    estGasAddDispenserContract(address: string, tokenAddress: string): Promise<any>;
+    /**
+     * Add a new contract to dispenser list, after is added, can be used when deploying a new pool
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    addDispenserContract(address: string, tokenAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addDispenserContract method
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    estGasRemoveDispenserContract(address: string, tokenAddress: string): Promise<any>;
+    /**
+     * Add a new contract to dispenser list, after is added, can be used when deploying a new pool
+     * @param {String} address
+     * @param {String} tokenAddress contract address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    removeDispenserContract(address: string, tokenAddress: string): Promise<TransactionReceipt>;
+    /** Get OPF Fee per token
+     * @return {Promise<number>} OPC fee for a specific baseToken
+     */
+    getOPCFee(baseToken: string): Promise<number>;
+    /** Get Current OPF Fee
+     * @return {Promise<number>} OPF fee
+     */
+    getCurrentOPCFee(): Promise<number>;
+    /**
+     * Estimate gas cost for updateOPFFee method
+     * @param {String} address
+     * @param {String} newFee new OPF Fee
+     * @return {Promise<TransactionReceipt>}
+     */
+    estGasUpdateOPCFee(address: string, newSwapOceanFee: number, newSwapNonOceanFee: number, newConsumeFee: number, newProviderFee: number): Promise<any>;
+    /**
+     * Add a new contract to fixedRate list, after is added, can be used when deploying a new pool
+     * @param {String} address
+     * @param {number} newSwapOceanFee Amount charged for swapping with ocean approved tokens
+     * @param {number} newSwapNonOceanFee Amount charged for swapping with non ocean approved tokens
+     * @param {number} newConsumeFee Amount charged from consumeFees
+     * @param {number} newProviderFee Amount charged for providerFees
+     * @return {Promise<TransactionReceipt>}
+     */
+    updateOPCFee(address: string, newSwapOceanFee: number, newSwapNonOceanFee: number, newConsumeFee: number, newProviderFee: number): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for addPoolTemplate method
+     * @param {String} address
+     * @param {String} templateAddress template address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    estGasAddPoolTemplate(address: string, templateAddress: string): Promise<any>;
+    /**
+     * Add a new template to poolTemplates mapping, after template is added,it can be used
+     * @param {String} address
+     * @param {String} templateAddress template address to add
+     * @return {Promise<TransactionReceipt>}
+     */
+    addPoolTemplate(address: string, templateAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for removePoolTemplate method
+     * @param {String} address
+     * @param {String} templateAddress template address to remove
+     * @return {Promise<TransactionReceipt>}
+     */
+    estGasRemovePoolTemplate(address: string, templateAddress: string): Promise<any>;
+    /**
+     * Remove template from poolTemplates mapping, after template is removed,it can be used anymore
+     * @param {String} address
+     * @param {String} templateAddress template address to remove
+     * @return {Promise<TransactionReceipt>}
+     */
+    removePoolTemplate(address: string, templateAddress: string): Promise<TransactionReceipt>;
+}

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

@@ -0,0 +1,408 @@
+import Web3 from 'web3';
+import { AbiItem } from 'web3-utils/types';
+import { TransactionReceipt } from 'web3-core';
+import { Contract } from 'web3-eth-contract';
+import { CurrentFees, TokenInOutMarket, AmountsInMaxFee, AmountsOutMaxFee } from '../../@types';
+import { Config } from '../../models';
+/**
+ * Provides an interface to Ocean friendly fork from Balancer BPool
+ */
+export declare class Pool {
+    poolAbi: AbiItem | AbiItem[];
+    web3: Web3;
+    GASLIMIT_DEFAULT: number;
+    private config;
+    constructor(web3: Web3, poolAbi?: AbiItem | AbiItem[], config?: Config);
+    /**
+     * Get user shares of pool tokens
+     * @param {String} account
+     * @param {String} poolAddress
+     * @return {String}
+     */
+    sharesBalance(account: string, poolAddress: string): Promise<string>;
+    /**
+     * Estimate gas cost for setSwapFee
+     * @param {String} account
+     * @param {String} tokenAddress
+     * @param {String} spender
+     * @param {String} amount
+     * @param {String} force
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estSetSwapFee(account: string, poolAddress: string, fee: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Set pool fee
+     * @param {String} account
+     * @param {String} poolAddress
+     * @param {String} fee 0.1=10% fee(max allowed)
+     */
+    setSwapFee(account: string, poolAddress: string, fee: string): Promise<TransactionReceipt>;
+    /**
+     * Get number of tokens composing this pool
+     * @param {String} poolAddress
+     * @return {String}
+     */
+    getNumTokens(poolAddress: string): Promise<string>;
+    /**
+     * Get total supply of pool shares
+     * @param {String} poolAddress
+     * @return {String}
+     */
+    getPoolSharesTotalSupply(poolAddress: string): Promise<string>;
+    /**
+     * Get tokens composing this pool
+     * @param {String} poolAddress
+     * @return {String[]}
+     */
+    getCurrentTokens(poolAddress: string): Promise<string[]>;
+    /**
+     * Get the final tokens composing this pool
+     * @param {String} poolAddress
+     * @return {String[]}
+     */
+    getFinalTokens(poolAddress: string): Promise<string[]>;
+    /**
+     * Get controller address of this pool
+     * @param {String} poolAddress
+     * @return {String}
+     */
+    getController(poolAddress: string): Promise<string>;
+    /**
+     * Get baseToken address of this pool
+     * @param {String} poolAddress
+     * @return {String}
+     */
+    getBaseToken(poolAddress: string): Promise<string>;
+    /**
+     * Get datatoken address of this pool
+     * @param {String} poolAddress
+     * @return {String}
+     */
+    getDatatoken(poolAddress: string): Promise<string>;
+    /**
+     * Get marketFeeCollector of this pool
+     * @param {String} poolAddress
+     * @return {String}
+     */
+    getMarketFeeCollector(poolAddress: string): Promise<string>;
+    /**
+     * Get OPC Collector of this pool
+     * @param {String} poolAddress
+     * @return {String}
+     */
+    getOPCCollector(poolAddress: string): Promise<string>;
+    /**
+     * Get if a token is bounded to a pool
+     * @param {String} poolAddress
+     * @param {String} token  Address of the token
+     * @return {Boolean}
+     */
+    isBound(poolAddress: string, token: string): Promise<boolean>;
+    /**
+     * Get how many tokens are in the pool
+     * @param {String} poolAddress
+     * @param {String} token  Address of the token
+     * @return {String}
+     */
+    getReserve(poolAddress: string, token: string): Promise<string>;
+    /**
+     * Get if a pool is finalized
+     * @param {String} poolAddress
+     * @return {Boolean}
+     */
+    isFinalized(poolAddress: string): Promise<boolean>;
+    /**
+     * Get pool fee
+     * @param {String} poolAddress
+     * @return {String} Swap fee. To get the percentage value, substract by 100. E.g. `0.1` represents a 10% swap fee.
+     */
+    getSwapFee(poolAddress: string): Promise<string>;
+    /**
+     * The normalized weight of a token. The combined normalized weights of all tokens will sum up to 1. (Note: the actual sum may be 1 plus or minus a few wei due to division precision loss)
+     * @param {String} poolAddress
+     * @param {String} token
+     * @return {String}
+     */
+    getNormalizedWeight(poolAddress: string, token: string): Promise<string>;
+    /**
+     * getDenormalizedWeight of a token in pool
+     * @param {String} poolAddress
+     * @param {String} token
+     * @return {String}
+     */
+    getDenormalizedWeight(poolAddress: string, token: string): Promise<string>;
+    /**
+     * getTotalDenormalizedWeight in pool
+     * @param {String} poolAddress
+     * @return {String}
+     */
+    getTotalDenormalizedWeight(poolAddress: string): Promise<string>;
+    /**
+     * Get Market Fees available to be collected for a specific token
+     * @param {String} poolAddress
+     * @param {String} token token we want to check fees
+     * @return {String}
+     */
+    getMarketFees(poolAddress: string, token: string): Promise<string>;
+    /**
+     * Get Community  Get the current amount of fees which can be withdrawned by the Market
+     * @return {CurrentFees}
+     */
+    getCurrentMarketFees(poolAddress: string): Promise<CurrentFees>;
+    /**
+     * Get getCurrentOPFFees  Get the current amount of fees which can be withdrawned by OPF
+     * @return {CurrentFees}
+     */
+    getCurrentOPCFees(poolAddress: string): Promise<CurrentFees>;
+    /**
+     * Get Community Fees available to be collected for a specific token
+     * @param {String} poolAddress
+     * @param {String} token token we want to check fees
+     * @return {String}
+     */
+    getCommunityFees(poolAddress: string, token: string): Promise<string>;
+    /**
+     * Estimate gas cost for collectOPF
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estCollectOPC(address: string, poolAddress: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * collectOPF - collect opf fee - can be called by anyone
+     * @param {String} address
+     * @param {String} poolAddress
+     * @return {TransactionReceipt}
+     */
+    collectOPC(address: string, poolAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for collectMarketFee
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {String} to address that will receive fees
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estCollectMarketFee(address: string, poolAddress: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * collectOPF - collect market fees - can be called by the publishMarketCollector
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {String} to address that will receive fees
+     * @return {TransactionReceipt}
+     */
+    collectMarketFee(address: string, poolAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for updateMarketFeeCollector
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {String} newCollector new market fee collector address
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estUpdateMarketFeeCollector(address: string, poolAddress: string, newCollector: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * updateMarketFeeCollector - updates marketFeeCollector - can be called only by the marketFeeCollector
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {String} newCollector new market fee collector address
+     * @return {TransactionReceipt}
+     */
+    updateMarketFeeCollector(address: string, poolAddress: string, newCollector: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for swapExactAmountIn
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {TokenInOutMarket} tokenInOutMarket
+     * @param {AmountsInMaxFee} amountsInOutMaxFee
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estSwapExactAmountIn(address: string, poolAddress: string, tokenInOutMarket: TokenInOutMarket, amountsInOutMaxFee: AmountsInMaxFee, contractInstance?: Contract): Promise<number>;
+    /**
+     * swapExactAmountIn - Trades an exact tokenAmountIn of tokenIn taken from the caller by the pool,
+     *  in exchange for at least minAmountOut of tokenOut given to the caller from the pool, with a maximum marginal price of maxPrice.
+     *  Returns (tokenAmountOut, spotPriceAfter), where tokenAmountOut is the amount of token that came out of the pool,
+     *  and spotPriceAfter is the new marginal spot price, ie, the result of getSpotPrice after the call.
+     * (These values are what are limited by the arguments; you are guaranteed tokenAmountOut >= minAmountOut and spotPriceAfter <= maxPrice).
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {TokenInOutMarket} tokenInOutMarket
+     * @param {AmountsInMaxFee} amountsInOutMaxFee
+     * @return {TransactionReceipt}
+     */
+    swapExactAmountIn(address: string, poolAddress: string, tokenInOutMarket: TokenInOutMarket, amountsInOutMaxFee: AmountsInMaxFee): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for swapExactAmountOut
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {TokenInOutMarket} tokenInOutMarket
+     * @param {AmountsOutMaxFee} amountsInOutMaxFee
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estSwapExactAmountOut(address: string, poolAddress: string, tokenInOutMarket: TokenInOutMarket, amountsInOutMaxFee: AmountsOutMaxFee, contractInstance?: Contract): Promise<number>;
+    /**
+     * swapExactAmountOut
+     * @param {String} account
+     * @param {String} poolAddress
+     * @param {TokenInOutMarket} tokenInOutMarket
+     * @param {AmountsOutMaxFee} amountsInOutMaxFee
+     * @return {TransactionReceipt}
+     */
+    swapExactAmountOut(account: string, poolAddress: string, tokenInOutMarket: TokenInOutMarket, amountsInOutMaxFee: AmountsOutMaxFee): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for swapExactAmountOut
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {String} poolAmountOut will be converted to wei
+     * @param {String[]} maxAmountsIn  array holding maxAmount per each token, will be converted to wei
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estJoinPool(address: string, poolAddress: string, poolAmountOut: string, maxAmountsIn: string[], contractInstance?: Contract): Promise<number>;
+    /**
+     * Join the pool, getting poolAmountOut pool tokens. This will pull some of each of the currently trading tokens in the pool, meaning you must have called approve for each token for this pool. These values are limited by the array of maxAmountsIn in the order of the pool tokens.
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {String} poolAmountOut will be converted to wei
+     * @param {String[]} maxAmountsIn  array holding maxAmount per each token, will be converted to wei
+     * @return {TransactionReceipt}
+     */
+    joinPool(address: string, poolAddress: string, poolAmountOut: string, maxAmountsIn: string[]): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for exitPool
+  * @param {String} address
+     * @param {String} poolAddress
+   ``* @param {String} poolAmountIn will be converted to wei
+     * @param {String[]} minAmountsOut  array holding minAmount per each token, will be converted to wei
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estExitPool(address: string, poolAddress: string, poolAmountIn: string, minAmountsOut: string[], contractInstance?: Contract): Promise<number>;
+    /**
+     * Exit the pool, paying poolAmountIn pool tokens and getting some of each of the currently trading tokens in return. These values are limited by the array of minAmountsOut in the order of the pool tokens.
+     * @param {String} account
+     * @param {String} poolAddress
+     * @param {String} poolAmountIn will be converted to wei
+     * @param {String[]} minAmountsOut  array holding minAmount per each token, will be converted to wei
+     * @return {TransactionReceipt}
+     */
+    exitPool(account: string, poolAddress: string, poolAmountIn: string, minAmountsOut: string[]): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for joinswapExternAmountIn
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {String} tokenIn
+     * @param {String} tokenAmountIn will be converted to wei
+     * @param {String} minPoolAmountOut  will be converted to wei
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estJoinswapExternAmountIn(address: string, poolAddress: string, tokenIn: string, tokenAmountIn: string, minPoolAmountOut: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Pay tokenAmountIn of token tokenIn to join the pool, getting poolAmountOut of the pool shares.
+     * @param {String} account
+     * @param {String} poolAddress
+     * @param {String} tokenIn
+     * @param {String} tokenAmountIn will be converted to wei
+     * @param {String} minPoolAmountOut  will be converted to wei
+     * @return {TransactionReceipt}
+     */
+    joinswapExternAmountIn(account: string, poolAddress: string, tokenIn: string, tokenAmountIn: string, minPoolAmountOut: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for joinswapPoolAmountOut
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {String} tokenIn
+     * @param {String} poolAmountOut will be converted to wei
+     * @param {String} maxAmountIn  will be converted to wei
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estJoinswapPoolAmountOut(address: string, poolAddress: string, tokenIn: string, poolAmountOut: string, maxAmountIn: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Specify poolAmountOut pool shares that you want to get, and a token tokenIn to pay with. This costs tokenAmountIn tokens (these went into the pool).
+     * @param {String} account
+     * @param {String} poolAddress
+     * @param {String} tokenIn
+     * @param {String} poolAmountOut will be converted to wei
+     * @param {String} maxAmountIn  will be converted to wei
+     * @return {TransactionReceipt}
+     */
+    joinswapPoolAmountOut(account: string, poolAddress: string, tokenIn: string, poolAmountOut: string, maxAmountIn: string): Promise<TransactionReceipt>;
+    /**
+    * Estimate gas cost for joinswapExternAmountIn
+    * @param {String} address
+       @param {String} poolAddress
+     * @param {String} tokenOut
+     * @param {String} poolAmountIn will be converted to wei
+     * @param {String} minTokenAmountOut  will be converted to wei
+       * @param {Contract} contractInstance optional contract instance
+       * @return {Promise<number>}
+       */
+    estExitswapPoolAmountIn(address: string, poolAddress: string, tokenOut: string, poolAmountIn: string, minTokenAmountOut: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Pay poolAmountIn pool shares into the pool, getting minTokenAmountOut of the given token tokenOut out of the pool.
+     * @param {String} account
+     * @param {String} poolAddress
+     * @param {String} tokenOut
+     * @param {String} poolAmountIn will be converted to wei
+     * @param {String} minTokenAmountOut  will be converted to wei
+     * @return {TransactionReceipt}
+     */
+    exitswapPoolAmountIn(account: string, poolAddress: string, tokenOut: string, poolAmountIn: string, minTokenAmountOut: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for joinswapExternAmountIn
+     * @param {String} address
+     * @param {String} poolAddress
+     * @param {String} tokenOut
+     * @param {String} tokenAmountOut will be converted to wei
+     * @param {String} maxPoolAmountIn  will be converted to wei
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estExitswapExternAmountOut(address: string, poolAddress: string, tokenOut: string, tokenAmountOut: string, maxPoolAmountIn: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Specify tokenAmountOut of token tokenOut that you want to get out of the pool. This costs poolAmountIn pool shares (these went into the pool).
+     * @param {String} account
+     * @param {String} poolAddress
+     * @param {String} tokenOut
+     * @param {String} tokenAmountOut will be converted to wei
+     * @param {String} maxPoolAmountIn  will be converted to wei
+     * @return {TransactionReceipt}
+     */
+    exitswapExternAmountOut(account: string, poolAddress: string, tokenOut: string, tokenAmountOut: string, maxPoolAmountIn: string): Promise<TransactionReceipt>;
+    /**
+     * Get Spot Price of swaping tokenIn to tokenOut
+     * @param {String} poolAddress
+     * @param {String} tokenIn
+     * @param {String} tokenOut
+     * @param {String} swapMarketFe
+     * @return {String}
+     */
+    getSpotPrice(poolAddress: string, tokenIn: string, tokenOut: string, swapMarketFee: string): Promise<string>;
+    getAmountInExactOut(poolAddress: string, tokenIn: string, tokenOut: string, tokenAmountOut: string, swapMarketFee: string): Promise<string>;
+    getAmountOutExactIn(poolAddress: string, tokenIn: string, tokenOut: string, tokenAmountIn: string, swapMarketFee: string): Promise<string>;
+    calcPoolOutGivenSingleIn(poolAddress: string, tokenIn: string, tokenAmountIn: string): Promise<string>;
+    calcSingleInGivenPoolOut(poolAddress: string, tokenIn: string, poolAmountOut: string): Promise<string>;
+    calcSingleOutGivenPoolIn(poolAddress: string, tokenOut: string, poolAmountIn: string): Promise<string>;
+    calcPoolInGivenSingleOut(poolAddress: string, tokenOut: string, tokenAmountOut: string): Promise<string>;
+    /**
+     * Get LOG_SWAP encoded topic
+     * @return {String}
+     */
+    getSwapEventSignature(): string;
+    /**
+     * Get LOG_JOIN encoded topic
+     * @return {String}
+     */
+    getJoinEventSignature(): string;
+    /**
+     * Get LOG_EXIT encoded topic
+     * @return {String}
+     */
+    getExitEventSignature(): string;
+}

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

@@ -0,0 +1 @@
+export * from './Pool';