@oceanprotocol/lib 1.0.0-next.1 → 1.0.0-next.13

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

@@ -0,0 +1,365 @@
+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, tokenAmountIn: string, minPoolAmountOut: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Pay tokenAmountIn of baseToken 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, tokenAmountIn: string, minPoolAmountOut: string): Promise<TransactionReceipt>;
+    /**
+    * Estimate gas cost for joinswapExternAmountIn
+    * @param {String} address
+       @param {String} poolAddress
+     * @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, poolAmountIn: string, minTokenAmountOut: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Pay poolAmountIn pool shares into the pool, getting minTokenAmountOut of the baseToken
+     * @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, poolAmountIn: string, minTokenAmountOut: 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/dispenser/Dispenser.d.ts

@@ -0,0 +1,146 @@
+import Web3 from 'web3';
+import { AbiItem } from 'web3-utils';
+import { Contract } from 'web3-eth-contract';
+import { TransactionReceipt } from 'web3-eth';
+import { Datatoken } from '../../tokens';
+import { Config } from '../../models/index.js';
+export interface DispenserToken {
+    active: boolean;
+    owner: string;
+    maxTokens: string;
+    maxBalance: string;
+    balance: string;
+    isMinter: boolean;
+    allowedSwapper: string;
+}
+export declare class Dispenser {
+    GASLIMIT_DEFAULT: number;
+    web3: Web3;
+    dispenserAddress: string;
+    config: Config;
+    dispenserAbi: AbiItem | AbiItem[];
+    dispenserContract: Contract;
+    /**
+     * Instantiate Dispenser
+     * @param {any} web3
+     * @param {String} dispenserAddress
+     * @param {any} dispenserABI
+     */
+    constructor(web3: Web3, dispenserAddress?: string, dispenserAbi?: AbiItem | AbiItem[], config?: Config);
+    /**
+     * Get information about a datatoken dispenser
+     * @param {String} dtAddress
+     * @return {Promise<FixedPricedExchange>} Exchange details
+     */
+    status(dtAdress: string): Promise<DispenserToken>;
+    /**
+     * Estimate gas cost for create method
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Owner address
+     * @param {String} maxTokens max tokens to dispense
+     * @param {String} maxBalance max balance of requester
+     * @param {String} allowedSwapper  if !=0, only this address can request DTs
+     * @return {Promise<any>}
+     */
+    estGasCreate(dtAddress: string, address: string, maxTokens: string, maxBalance: string, allowedSwapper: string): Promise<any>;
+    /**
+     * Creates a new Dispenser
+     * @param {String} dtAddress Datatoken address
+     * @param {String} address Owner address
+     * @param {String} maxTokens max tokens to dispense
+     * @param {String} maxBalance max balance of requester
+     * @param {String} allowedSwapper  only account that can ask tokens. set address(0) if not required
+     * @return {Promise<TransactionReceipt>} transactionId
+     */
+    create(dtAddress: string, address: string, maxTokens: string, maxBalance: string, allowedSwapper: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for activate method
+     * @param {String} dtAddress
+     * @param {Number} maxTokens max amount of tokens to dispense
+     * @param {Number} maxBalance max balance of user. If user balance is >, then dispense will be rejected
+     * @param {String} address User address (must be owner of the datatoken)
+     * @return {Promise<any>}
+     */
+    estGasActivate(dtAddress: string, maxTokens: string, maxBalance: string, address: string): Promise<any>;
+    /**
+     * Activates a new dispener.
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {Number} maxTokens max amount of tokens to dispense
+     * @param {Number} maxBalance max balance of user. If user balance is >, then dispense will be rejected
+     * @param {String} address User address (must be owner of the datatoken)
+     * @return {Promise<TransactionReceipt>} TransactionReceipt
+     */
+    activate(dtAddress: string, maxTokens: string, maxBalance: string, address: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for deactivate method
+     * @param {String} dtAddress
+     * @param {String} address User address (must be owner of the datatoken)
+     * @return {Promise<any>}
+     */
+    estGasDeactivate(dtAddress: string, address: string): Promise<any>;
+    /**
+     * Deactivate an existing dispenser.
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {String} address User address (must be owner of the datatoken)
+     * @return {Promise<TransactionReceipt>} TransactionReceipt
+     */
+    deactivate(dtAddress: string, address: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for setAllowedSwapper method
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {String} address User address (must be owner of the datatoken)
+     * @param {String} newAllowedSwapper refers to the new allowedSwapper
+     * @return {Promise<any>}
+     */
+    estGasSetAllowedSwapper(dtAddress: string, address: string, newAllowedSwapper: string): Promise<any>;
+    /**
+     * Sets a new allowedSwapper.
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {String} address User address (must be owner of the datatoken)
+     * @param {String} newAllowedSwapper refers to the new allowedSwapper
+     * @return {Promise<TransactionReceipt>} TransactionReceipt
+     */
+    setAllowedSwapper(dtAddress: string, address: string, newAllowedSwapper: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for dispense method
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {String} address User address (must be owner of the datatoken)
+     * @param {String} newAllowedSwapper refers to the new allowedSwapper
+     * @return {Promise<any>}
+     */
+    estGasDispense(dtAddress: string, address: string, amount: string, destination: string): Promise<any>;
+    /**
+     * Dispense datatokens to caller.
+     * The dispenser must be active, hold enough DT (or be able to mint more)
+     * and respect maxTokens/maxBalance requirements
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {String} address User address
+     * @param {String} amount amount of datatokens required.
+     * @param {String} destination who will receive the tokens
+     * @return {Promise<TransactionReceipt>} TransactionReceipt
+     */
+    dispense(dtAddress: string, address: string, amount: string, destination: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas for ownerWithdraw method
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {String} address User address (must be owner of the datatoken)
+     * @param {String} newAllowedSwapper refers to the new allowedSwapper
+     * @return {Promise<any>}
+     */
+    estGasOwnerWithdraw(dtAddress: string, address: string): Promise<any>;
+    /**
+     * Withdraw all tokens from the dispenser
+     * @param {String} dtAddress refers to datatoken address.
+     * @param {String} address User address (must be owner of the dispenser)
+     * @return {Promise<TransactionReceipt>} TransactionReceipt
+     */
+    ownerWithdraw(dtAddress: string, address: string): Promise<TransactionReceipt>;
+    /**
+     * Check if tokens can be dispensed
+     * @param {String} dtAddress
+     * @param {String} address User address that will receive datatokens
+     * @param {String} amount amount of datatokens required.
+     * @return {Promise<Boolean>}
+     */
+    isDispensable(dtAddress: string, datatoken: Datatoken, address: string, amount?: string): Promise<Boolean>;
+}