@oceanprotocol/lib 0.20.2 → 1.0.0-next.11

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>;
+}

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

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

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

@@ -0,0 +1,375 @@
+import { TransactionReceipt } from 'web3-core';
+import { Contract } from 'web3-eth-contract';
+import { AbiItem } from 'web3-utils/types';
+import Web3 from 'web3';
+import { Config } from '../../models/index.js';
+export interface FixedPriceExchange {
+    active: boolean;
+    exchangeOwner: string;
+    datatoken: string;
+    baseToken: string;
+    fixedRate: string;
+    dtDecimals: string;
+    btDecimals: string;
+    dtBalance: string;
+    btBalance: string;
+    dtSupply: string;
+    btSupply: string;
+    withMint: boolean;
+    allowedSwapper: string;
+    exchangeId?: string;
+}
+export interface FeesInfo {
+    opcFee: string;
+    marketFee: string;
+    marketFeeCollector: string;
+    marketFeeAvailable: string;
+    oceanFeeAvailable: string;
+    exchangeId: string;
+}
+export interface FixedPriceSwap {
+    exchangeId: string;
+    caller: string;
+    baseTokenAmount: string;
+    datatokenAmount: string;
+}
+export declare enum FixedRateCreateProgressStep {
+    CreatingExchange = 0,
+    ApprovingDatatoken = 1
+}
+export declare class FixedRateExchange {
+    GASLIMIT_DEFAULT: number;
+    /** Ocean related functions */
+    oceanAddress: string;
+    fixedRateAddress: string;
+    fixedRateExchangeAbi: AbiItem | AbiItem[];
+    fixedRateContract: Contract;
+    web3: Web3;
+    contract: Contract;
+    config: Config;
+    ssAbi: AbiItem | AbiItem[];
+    /**
+     * Instantiate 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>;
+    /**
+     * Creates unique exchange identifier.
+     * @param {String} datatoken Datatoken contract address
+     * @param {String} owner Owner of the exchange
+     * @return {Promise<string>} exchangeId
+     */
+    generateExchangeId(baseToken: string, datatoken: string, owner: string): Promise<string>;
+    /**
+     * Estimate gas cost for buyDT
+     * @param {String} account
+     * @param {String} dtAmount datatoken amount we want to buy
+     * @param {String} datatokenAddress datatokenAddress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estBuyDT(account: string, datatokenAddress: string, dtAmount: string, maxBaseTokenAmount: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Atomic swap
+     * @param {String} exchangeId ExchangeId
+     * @param {String} datatokenAmount Amount of datatokens
+     * @param {String} maxBaseTokenAmount max amount of baseToken we want to pay for datatokenAmount
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    buyDT(address: string, exchangeId: string, datatokenAmount: string, maxBaseTokenAmount: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for sellDT
+     * @param {String} account
+     * @param {String} dtAmount datatoken amount we want to sell
+     * @param {String} datatokenAddress datatokenAddress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estSellDT(account: string, datatokenAddress: string, dtAmount: string, maxBaseTokenAmount: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Atomic swap
+     * @param {String} exchangeId ExchangeId
+     * @param {String} datatokenAmount Amount of datatokens
+     * @param {String} minBaseTokenAmount min amount of baseToken we want to receive back
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    sellDT(address: string, exchangeId: string, datatokenAmount: string, minBaseTokenAmount: string): Promise<TransactionReceipt>;
+    /**
+     * Gets total number of exchanges
+     * @param {String} exchangeId ExchangeId
+     * @param {Number} datatokenAmount Amount of datatokens
+     * @return {Promise<Number>} no of available exchanges
+     */
+    getNumberOfExchanges(): Promise<number>;
+    /**
+     * Estimate gas cost for setRate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Number} newRate New rate
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estSetRate(account: string, exchangeId: string, newRate: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Set new rate
+     * @param {String} exchangeId ExchangeId
+     * @param {Number} newRate New rate
+     * @param {String} address User account
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    setRate(address: string, exchangeId: string, newRate: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for setRate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newAllowedSwapper new allowed swapper address
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estSetAllowedSwapper(account: string, exchangeId: string, newAllowedSwapper: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Set new rate
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newAllowedSwapper newAllowedSwapper (set address zero if we want to remove allowed swapper)
+     * @param {String} address User account
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    setAllowedSwapper(address: string, exchangeId: string, newAllowedSwapper: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for activate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estActivate(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Activate an exchange
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    activate(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for deactivate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estDeactivate(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Deactivate an exchange
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    deactivate(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Get Rate
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<string>} Rate (converted from wei)
+     */
+    getRate(exchangeId: string): Promise<string>;
+    /**
+     * Get Datatoken Supply in the exchange
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<string>}  dt supply formatted
+     */
+    getDTSupply(exchangeId: string): Promise<string>;
+    /**
+     * Get BaseToken Supply in the exchange
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<string>} dt supply formatted
+     */
+    getBTSupply(exchangeId: string): Promise<string>;
+    /**
+     * Get Allower Swapper (if set this is the only account which can use this exchange, else is set at address(0))
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<string>} address of allowedSwapper
+     */
+    getAllowedSwapper(exchangeId: string): Promise<string>;
+    /**
+     * getBTNeeded - returns amount in baseToken that user will pay for datatokenAmount
+     * @param {String} exchangeId ExchangeId
+     * @param {Number} datatokenAmount Amount of datatokens user wants to buy
+     * @return {Promise<string>} Amount of baseToken needed for buying
+     */
+    getAmountBTIn(exchangeId: string, datatokenAmount: string): Promise<string>;
+    /**
+     * getBTOut - returns amount in baseToken that user will receive for datatokenAmount sold
+     * @param {String} exchangeId ExchangeId
+     * @param {Number} datatokenAmount Amount of datatokens
+     * @return {Promise<string>} Amount of baseTokens user will receive
+     */
+    getAmountBTOut(exchangeId: string, datatokenAmount: string): Promise<string>;
+    /**
+     * Get exchange details
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<FixedPricedExchange>} Exchange details
+     */
+    getExchange(exchangeId: string): Promise<FixedPriceExchange>;
+    /**
+     * Get fee details for an exchange
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<FixedPricedExchange>} Exchange details
+     */
+    getFeesInfo(exchangeId: string): Promise<FeesInfo>;
+    /**
+     * Get all exchanges
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<String[]>} Exchanges list
+     */
+    getExchanges(): Promise<string[]>;
+    /**
+     * Check if an exchange is active
+     * @param {String} exchangeId ExchangeId
+     * @return {Promise<Boolean>} Result
+     */
+    isActive(exchangeId: string): Promise<boolean>;
+    /**
+     * Estimate gas cost for activate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estActivateMint(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Activate minting option for fixed rate contract
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    activateMint(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for deactivate
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estDeactivateMint(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Deactivate minting for fixed rate
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    deactivateMint(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for collectBT
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estCollectBT(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Collect BaseTokens in the contract (only exchange owner)
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    collectBT(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for collecDT
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estCollectDT(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Collect datatokens in the contract (only exchange owner)
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    collectDT(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for collecMarketFee
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estCollectMarketFee(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Collect market fee and send it to marketFeeCollector (anyone can call it)
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    collectMarketFee(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for collectOceanFee
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estCollectOceanFee(account: string, exchangeId: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Collect ocean fee and send it to OPF collector (anyone can call it)
+     * @param {String} exchangeId ExchangeId
+     * @param {String} address User address
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    collectOceanFee(address: string, exchangeId: string): Promise<TransactionReceipt>;
+    /**
+     * Get OPF Collector of fixed rate contract
+     * @return {String}
+     */
+    getOPCCollector(): Promise<string>;
+    /**
+     * Get Router address set in fixed rate contract
+     * @return {String}
+     */
+    getRouter(): Promise<string>;
+    /**
+     * Get Exchange Owner given an exchangeId
+     * @param {String} exchangeId ExchangeId
+     * @return {String} return exchange owner
+     */
+    getExchangeOwner(exchangeId: string): Promise<string>;
+    /**
+     * Estimate gas cost for updateMarketFee
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newMarketFee New market fee
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estUpdateMarketFee(account: string, exchangeId: string, newMarketFee: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Set new market fee, only market fee collector can update it
+     * @param {String} address user address
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newMarketFee New market fee
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    updateMarketFee(address: string, exchangeId: string, newMarketFee: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for updateMarketFeeCollector
+     * @param {String} account
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newMarketFee New market fee collector
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estUpdateMarketFeeCollector(account: string, exchangeId: string, newMarketFeeCollector: string, contractInstance?: Contract): Promise<number>;
+    /**
+     * Set new market fee collector, only market fee collector can update it
+     * @param {String} address user address
+     * @param {String} exchangeId ExchangeId
+     * @param {String} newMarketFeeCollector New market fee collector
+     * @return {Promise<TransactionReceipt>} transaction receipt
+     */
+    updateMarketFeeCollector(address: string, exchangeId: string, newMarketFeeCollector: string): Promise<TransactionReceipt>;
+}

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

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

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

@@ -0,0 +1,3 @@
+export * from './balancer';
+export * from './dispenser';
+export * from './fixedRate';

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

@@ -0,0 +1,132 @@
+import Web3 from 'web3';
+import { AbiItem } from 'web3-utils/types';
+import { TransactionReceipt } from 'web3-core';
+import { Contract } from 'web3-eth-contract';
+import { Config } from '../../models';
+export declare class SideStaking {
+    ssAbi: AbiItem | AbiItem[];
+    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>;
+    /**
+     * Get (total vesting amount + token released from the contract when adding liquidity)
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatoken address
+     * @return {String}
+     */
+    getDatatokenCirculatingSupply(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get actual dts in circulation (vested token withdrawn from the contract +
+           token released from the contract when adding liquidity)
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatoken address
+     * @return {String}
+     */
+    getDatatokenCurrentCirculatingSupply(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get Publisher address
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatoken address
+     * @return {String}
+     */
+    getPublisherAddress(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
+    getBaseToken(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get Pool Address
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
+    getPoolAddress(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get baseToken balance in the contract
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
+    getBaseTokenBalance(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get dt balance in the staking contract available for being added as liquidity
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
+    getDatatokenBalance(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get block when vesting ends
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String} end block for vesting amount
+     */
+    getvestingEndBlock(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get total amount vesting
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
+    getvestingAmount(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get last block publisher got some vested tokens
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
+    getvestingLastBlock(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Get how much has been taken from the vesting amount
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {String}
+     */
+    getvestingAmountSoFar(ssAddress: string, datatokenAddress: string): Promise<string>;
+    /**
+     * Estimate gas cost for getVesting
+     * @param {String} account
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estGetVesting(account: string, ssAddress: string, datatokenAddress: string, contractInstance?: Contract): Promise<number>;
+    /** Send vested tokens available to the publisher address, can be called by anyone
+     *
+     * @param {String} account
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {TransactionReceipt}
+     */
+    getVesting(account: string, ssAddress: string, datatokenAddress: string): Promise<TransactionReceipt>;
+    /**
+     * Estimate gas cost for getVesting
+     * @param {String} account
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @param {Contract} contractInstance optional contract instance
+     * @return {Promise<number>}
+     */
+    estSetPoolSwapFee(account: string, ssAddress: string, datatokenAddress: string, poolAddress: string, swapFee: number, contractInstance?: Contract): Promise<number>;
+    /** Send vested tokens available to the publisher address, can be called by anyone
+     *
+     * @param {String} account
+     * @param {String} ssAddress side staking contract address
+     * @param {String} datatokenAddress datatokenAddress
+     * @return {TransactionReceipt}
+     */
+    setPoolSwapFee(account: string, ssAddress: string, datatokenAddress: string, poolAddress: string, swapFee: number): Promise<TransactionReceipt>;
+    /**
+     * Get Router address set in side staking contract
+     * @param {String} ssAddress side staking contract address
+     * @return {String}
+     */
+    getRouter(ssAddress: string): Promise<string>;
+}

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

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