Retrieves the allowance for a specific owner and spender.
Retrieves the allowance for a specific owner and spender.
The allowance.
The owner's address.
The spender's address.
A provider or signer object
The allowance.
Approves an amount to be spent by a specific spender.
Approves an amount to be spent by a specific spender.
A promise that resolves when the approval is complete.
The spender's address.
The amount to approve.
The transaction signer.
A promise that resolves when the approval is complete.
Retrieves the balance of an account.
Retrieves the balance of an account.
The account's balance.
The account's address.
A provider or signer object
The account's balance.
Claims all available funds.
Claims all available funds.
A promise that resolves when the claim is complete.
A promise that resolves when the claim is complete.
Claims all available funds for a specific member.
Claims all available funds for a specific member.
A promise that resolves when the claim is complete.
The member's address.
The transaction signer.
A promise that resolves when the claim is complete.
Readonly contractDecreases the allowance for a specific spender.
Decreases the allowance for a specific spender.
A promise that resolves when the allowance decrease is complete.
The spender's address.
The amount to decrease the allowance by.
The transaction signer.
The transaction overrides.
A promise that resolves when the allowance decrease is complete.
Retrieves the claimable amount for a specific member and time.
Retrieves the claimable amount for a specific member and time.
The claimable amount.
The member's address.
The amount claimable at time.
A provider or signer object
The claimable amount.
Retrieves the claimable amount for a specific member at the current time.
Retrieves the claimable amount for a specific member at the current time.
ClaimableData: { timestamp, claimableBalance }
The member's address.
A provider or signer object
ClaimableData: { timestamp, claimableBalance }
Retrieves the disconnected balance for the pool a specific time.
Retrieves the disconnected balance for the pool a specific time.
The disconnected balance.
The time of the disconnected balance.
A provider or signer object
The disconnected balance.
Retrieves the flow rate for a specific member.
Retrieves the flow rate for a specific member.
The flow rate for the specified member.
The member's address.
A provider or signer object
The flow rate for the specified member.
Retrieves the pool admin.
Retrieves the pool admin.
A provider or signer object
The pool admin.
A provider or signer object
The pool admin.
Retrieves the SuperToken.
Retrieves the SuperToken.
A provider or signer object
The SuperToken for this pool.
A provider or signer object
The SuperToken for this pool.
Retrieves the flow rate for a specific member.
Retrieves the flow rate for a specific member.
The total amount received by the member.
The member's address.
A provider or signer object
The total amount received by the member.
Retrieves the total connected flow rate.
Retrieves the total connected flow rate.
A provider or signer object
The total connected flow rate.
A provider or signer object
The total connected flow rate.
Retrieves the total connected units.
Retrieves the total connected units.
A provider or signer object
The total connected units.
A provider or signer object
The total connected units.
Retrieves the total disconnected flow rate.
Retrieves the total disconnected flow rate.
A provider or signer object
The total disconnected flow rate.
A provider or signer object
The total disconnected flow rate.
Retrieves the total units. Returns the same value as totalSupply.
Retrieves the total units. Returns the same value as totalSupply.
A provider or signer object
The total units.
A provider or signer object
The total units.
Retrieves the units for a specific member.
Retrieves the units for a specific member.
The units for the specified member.
The member's address.
A provider or signer object
The units for the specified member.
Increases the allowance for a specific spender.
Increases the allowance for a specific spender.
A promise that resolves when the allowance increase is complete.
The spender's address.
The amount to increase the allowance by.
The transaction signer.
A promise that resolves when the allowance increase is complete.
Retrieves the total supply. Returns the same value as getTotalUnits.
Retrieves the total supply. Returns the same value as getTotalUnits.
The total supply.
The total supply.
Transfers an amount to a specific recipient.
Transfers an amount to a specific recipient.
A promise that resolves when the transfer is complete.
The recipient's address.
The amount to transfer.
The transaction signer.
A promise that resolves when the transfer is complete.
Transfers an amount from a specific sender to a recipient.
Transfers an amount from a specific sender to a recipient.
A promise that resolves when the transfer is complete.
The sender's address.
The recipient's address.
The amount to transfer.
The transaction signer.
A promise that resolves when the transfer is complete.
Updates the units for a specific member.
Updates the units for a specific member.
A promise that resolves when the update is complete.
The member's address.
The new units value.
The transaction signer.
A promise that resolves when the update is complete.
Generated using TypeDoc
Superfluid Pool Helper Class
Description
A helper class to interact with the SuperfluidPool contract.