@q-dev/qdex-js-sdk
Version:
Typescript Library to interact with Q DEX Contracts
35 lines (34 loc) • 1.7 kB
TypeScript
import Web3 from 'web3';
import { DEXRevenuePool } from '../../web3-contracts/DEX_RevenuePool';
import { DEXContractInstance } from '../DEXContractInstance';
import { QNonPayableTx } from '@q-dev/q-js-sdk';
import { TransactionReceipt } from 'web3-eth';
/**
* QDEX Revenue Pool Contract Instance to interact with the Revenue Pool contract
* See [onchain documentation]((@q-dex-utils/@network/RevenuePool) for more details.
* An instance of this class for a deployed network can be obtained via {@link ContractRegistryInstance.revenuePool}
*/
export declare class DEXRevenuePoolInstance extends DEXContractInstance<DEXRevenuePool> {
static readonly registryKey = "governance.intApp.QDEX.revenuePool";
constructor(web3: Web3, address: string);
/**
* [External documentation](@q-dex-utils-repo/@network/RevenuePool/#flatfee)
*/
flatFee(): Promise<string>;
/**
* [External documentation](@q-dex-utils-repo/@network/RevenuePool/#transferq)
*/
transferQ(txOptions?: QNonPayableTx): Promise<TransactionReceipt>;
/**
* [External documentation](@q-dex-utils-repo/@network/RevenuePool/#swaptokenforq)
*/
swapTokenForQ(token: string, amountWQMin: number, txOptions?: QNonPayableTx): Promise<TransactionReceipt>;
/**
* [External documentation](@q-dex-utils-repo/@network/RevenuePool/#returncollectedrevenue)
*/
swapLPTokenForIndividualTokens(pair: string, amountAMin: number, amountBMin: any, txOptions?: QNonPayableTx): Promise<TransactionReceipt>;
/**
* [External documentation](@q-dex-utils-repo/@network/RevenuePool/#returncollectedrevenue)
*/
returnCollectedRevenue(tokenAddress: string): Promise<string>;
}