Properties
Optional _contract
_contract?: PoolToken
address
address: string
approve
approve: (spender: string, amount: number | BigNumber) => Promise<ContractTransaction> = ...
Type declaration
- (spender: string, amount: number | BigNumber): Promise<ContractTransaction>
Parameters
spender: string
amount: number | BigNumber
Returns Promise<ContractTransaction>
connect
connect: (provider: Provider | Signer) => void = ...
Type declaration
- (provider: Provider | Signer): void
Parameters
provider: Provider | Signer
Returns void
decimals
decimals: number
fetchAllowance
fetchAllowance: (spender: string, account: string) => Promise<BigNumber> = ...
Type declaration
- (spender: string, account: string): Promise<BigNumber>
Parameters
spender: string
account: string
Returns Promise<BigNumber>
the allowance the account has given to the spender address to spend this pool token
fetchBalance
fetchBalance: (account: string) => Promise<BigNumber> = ...
Type declaration
- (account: string): Promise<BigNumber>
Parameters
Returns Promise<BigNumber>
The accounts balance formatted in a BigNumber
fetchSupply
fetchSupply: () => Promise<BigNumber> = ...
Type declaration
Returns Promise<BigNumber>
most up to date token supply
Private init
init
: (tokenInfo
: IPoolToken) => Promise<void> = ...Type declaration
Parameters
Returns Promise<void>
multicallProvider
multicallProvider: undefined | Signer | MulticallProvider
name
name: string
pool
pool: string
provider
provider: undefined | Provider | Signer
side
supply
supply: BigNumber
symbol
symbol: string
Static Create
Type declaration
Parameters
a Promise containing an initialised PoolToken class ready to be used
Static CreateDefault
Type declaration
default constructed pool token
Approve a spender to spend the signers accounts pool tokens