simple-sushiswap-sdk
Version:
Simple easy to understand SDK for sushiswap
120 lines (119 loc) • 4.01 kB
TypeScript
import { ContractTransaction, BigNumber, BigNumberish } from 'ethers';
import { EthersContractContextV5 } from 'ethereum-abi-types-generator';
export declare type ContractContext = EthersContractContextV5<SushiswapPair, SushiswapPairMethodNames, SushiswapPairEventsContext, SushiswapPairEvents>;
export declare type EventFilter = {
address?: string;
topics?: Array<string>;
fromBlock?: string | number;
toBlock?: string | number;
};
export interface ContractTransactionOverrides {
/**
* The maximum units of gas for the transaction to use
*/
gasLimit?: number;
/**
* The price (in wei) per unit of gas
*/
gasPrice?: BigNumber | string | number | Promise<any>;
/**
* The nonce to use in the transaction
*/
nonce?: number;
/**
* The amount to send with the transaction (i.e. msg.value)
*/
value?: BigNumber | string | number | Promise<any>;
/**
* The chain ID (or network ID) to use
*/
chainId?: number;
}
export interface ContractCallOverrides {
/**
* The address to execute the call as
*/
from?: string;
/**
* The maximum units of gas for the transaction to use
*/
gasLimit?: number;
}
export declare type SushiswapPairEvents = 'PairCreated';
export interface SushiswapPairEventsContext {
PairCreated(...parameters: any): EventFilter;
}
export declare type SushiswapPairMethodNames = 'new' | 'allPairs' | 'allPairsLength' | 'createPair' | 'feeTo' | 'feeToSetter' | 'getPair' | 'setFeeTo' | 'setFeeToSetter';
export interface SushiswapPair {
/**
* Payable: false
* Constant: false
* StateMutability: nonpayable
* Type: constructor
* @param _feeToSetter Type: address, Indexed: false
*/
'new'(_feeToSetter: string, overrides?: ContractTransactionOverrides): Promise<ContractTransaction>;
/**
* Payable: false
* Constant: true
* StateMutability: view
* Type: function
* @param parameter0 Type: uint256, Indexed: false
*/
allPairs(parameter0: BigNumberish, overrides?: ContractCallOverrides): Promise<string>;
/**
* Payable: false
* Constant: true
* StateMutability: view
* Type: function
*/
allPairsLength(overrides?: ContractCallOverrides): Promise<BigNumber>;
/**
* Payable: false
* Constant: false
* StateMutability: nonpayable
* Type: function
* @param tokenA Type: address, Indexed: false
* @param tokenB Type: address, Indexed: false
*/
createPair(tokenA: string, tokenB: string, overrides?: ContractTransactionOverrides): Promise<ContractTransaction>;
/**
* Payable: false
* Constant: true
* StateMutability: view
* Type: function
*/
feeTo(overrides?: ContractCallOverrides): Promise<string>;
/**
* Payable: false
* Constant: true
* StateMutability: view
* Type: function
*/
feeToSetter(overrides?: ContractCallOverrides): Promise<string>;
/**
* Payable: false
* Constant: true
* StateMutability: view
* Type: function
* @param parameter0 Type: address, Indexed: false
* @param parameter1 Type: address, Indexed: false
*/
getPair(parameter0: string, parameter1: string, overrides?: ContractCallOverrides): Promise<string>;
/**
* Payable: false
* Constant: false
* StateMutability: nonpayable
* Type: function
* @param _feeTo Type: address, Indexed: false
*/
setFeeTo(_feeTo: string, overrides?: ContractTransactionOverrides): Promise<ContractTransaction>;
/**
* Payable: false
* Constant: false
* StateMutability: nonpayable
* Type: function
* @param _feeToSetter Type: address, Indexed: false
*/
setFeeToSetter(_feeToSetter: string, overrides?: ContractTransactionOverrides): Promise<ContractTransaction>;
}