Readonly addressReturns the allowance the owner has granted the spender.
Returns the allowance the owner has granted the spender.
the allowance amount
the owner who has allotted the allowance
the spender who has received the allowance
a provider or signer for executing a web3 call
the allowance amount
Approve receiver to spend amount tokens.
Approve receiver to spend amount tokens.
An instance of Operation which can be executed or batched.
The receiver approved.
The amount approved.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Approves a Subscription, so the Subscriber won't need to claim tokens when the Publisher distributes.
The id of the index.
The publisher address whose subscription you want to approve.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Returns the ERC20 balanceOf the account, this can't be negative and will just display 0.
Returns the ERC20 balanceOf the account, this can't be negative and will just display 0.
the token balance of account
the account you would like to query
a provider or signer for executing a web3 call
the token balance of account
Readonly cfaClaims any pending tokens allocated to the Subscription (unapproved).
Claims any pending tokens allocated to the Subscription (unapproved).
An instance of Operation which can be executed or batched.
The id of the index.
The subscriber address who you are claiming for.
The publisher address of the index you are targeting.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Connects a pool to the contract.
Connects a pool to the contract.
The call agreement operation result.
The pool address.
The user data.
The transaction overrides.
The call agreement operation result.
Optional Readonly constantReadonly constantOptional Readonly constantReadonly constantReadonly contractCreate a flow of the token of this class.
Create a flow of the token of this class.
An instance of Operation which can be executed or batched.
The receiver of the flow.
The specified flow rate.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Create a flow as an operator
The specified flow rate.
The sender of the flow.
The receiver of the flow.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Creates an IDA Index.
Creates an IDA Index.
An instance of Operation which can be executed or batched.
The id of the index.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Creates a new pool with the given token and admin.
Creates a new pool with the given token and admin.
The contract transaction and the pool address
The admin address.
The transaction overrides.
The contract transaction and the pool address
Decreases the allowance of spender by amount.
Decreases the allowance of spender by amount.
An instance of Operation which can be executed or batched.
the spender
the amount to decrease the allowance by
An instance of Operation which can be executed or batched.
Delete a flow of the token of this class.
Delete a flow of the token of this class.
An instance of Operation which can be executed or batched.
The sender of the flow.
The receiver of the flow.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Delete a flow as an operator.
Delete a flow as an operator.
An instance of Operation which can be executed or batched.
The sender of the flow.
The receiver of the flow.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Deletes a Subscription by setting the units allocated to the Subscriber to 0.
Deletes a Subscription by setting the units allocated to the Subscriber to 0.
An instance of Operation which can be executed or batched.
The id of the index.
The subscriber address whose subscription you want to delete.
The publisher address of the index you are targeting.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Disconnects a pool from the contract.
Disconnects a pool from the contract.
The call agreement operation result.
The pool address.
The user data.
The transaction overrides.
The call agreement operation result.
Distributes amount of token to an index
Distributes amount of token to an index
An instance of Operation which can be executed or batched.
The id of the index.
The amount of tokens to be distributed.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Distributes the flow from the sender's account to the specified pool.
Distributes the flow from the sender's account to the specified pool.
The call agreement operation result.
The sender's address.
The pool address.
The requested flow rate.
The user data.
The transaction overrides.
The call agreement operation result.
Distributes funds from the sender's account to the specified pool.
Distributes funds from the sender's account to the specified pool.
The call agreement operation result.
The sender's address.
The pool address.
The requested amount to distribute.
The user data.
The transaction overrides.
The call agreement operation result.
Downgrade amount of a native asset super token to the underlying native asset.
Downgrade amount of a native asset super token to the underlying native asset.
Optional overrides?: Overrides & { An instance of Operation which can be executed.
The amount to be upgraded.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed.
Estimates the distribution's actual amount for a specific token, sender, and pool.
Estimates the distribution's actual amount for a specific token, sender, and pool.
The actual amount that will be distributed.
The sender address.
The pool address.
The requested amount.
A provider or signer object
The actual amount that will be distributed.
Estimates the flow distribution's actual flow rate for a specific token, sender, and pool.
Estimates the flow distribution's actual flow rate for a specific token, sender, and pool.
The flow distribution's actual flow rate and the total distribution flow rate for the pool.
The sender address.
The pool address.
The requested flow rate.
A provider or signer object
The flow distribution's actual flow rate and the total distribution flow rate for the pool.
Readonly gdaGet the flow info of an account (net flow).
Get the flow info of an account (net flow).
Web3 Flow info object
the account we're querying
a provider or signer object
Web3 Flow info object
Get the details of a flow.
Get the details of a flow.
Web3 Flow info object
the sender of the flow
the receiver of the flow
a provider or signer object
Web3 Flow info object
Get flow operator data.
Get flow operator data.
Web3 Flow info object
the sender
the flowOperator
a provider or signer object
Web3 Flow info object
Get flow operator data using the flowOperatorId.
Get flow operator data using the flowOperatorId.
Web3 Flow info object
The keccak256 hash of encoded string "flowOperator", sender and flowOperator
a provider or signer object
Web3 Flow info object
Retrieves the flow rate for a specific token, sender, and pool.
Retrieves the flow rate for a specific token, sender, and pool.
The flow rate from the sender to the pool for the token.
The sender address.
The pool address.
A provider or signer object
The flow rate from the sender to the pool for the token.
Retrieves the net flow for a specific token and account.
Retrieves the net flow for a specific token and account.
The net flow of the account for the token.
The account address.
A provider or signer object
The net flow of the account for the token.
Get the details of an Index.
Get the details of an Index.
Web3 Index object
the address of the publisher of the index
the index id
a provider or signer object
Web3 Index object
Get the net flow of an account.
Get the net flow of an account.
Web3 Flow info object
the account we're querying
a provider or signer object
Web3 Flow info object
Retrieves the pool adjustment flow information for a specific pool.
Retrieves the pool adjustment flow information for a specific pool.
The recipient of the pool adjustment flow, the flow hash and the rate of the adjustment flow.
The address of the pool.
A provider or signer object
The recipient of the pool adjustment flow, the flow hash and the rate of the adjustment flow.
Retrieves the pool adjustment flow rate for a specific token and pool.
Retrieves the pool adjustment flow rate for a specific token and pool.
The pool adjustment flow rate for the token and pool.
The pool address.
A provider or signer object
The pool adjustment flow rate for the token and pool.
Get the details of a Subscription.
Get the details of a Subscription.
Web3 Subscription object
the address of the publisher of the index
the index id
the subscriber's address
a provider or signer object
Web3 Subscription object
Readonly governanceReadonly idaIncreases the allowance of spender by amount.
Increases the allowance of spender by amount.
An instance of Operation which can be executed or batched.
the spender
the amount to increase the allowance by
An instance of Operation which can be executed or batched.
Checks if a member is connected to a specific pool.
Checks if a member is connected to a specific pool.
Whether the member is connected to the pool.
The pool address.
The member address.
A provider or signer object
Whether the member is connected to the pool.
Checks if a given token and account form a pool.
Checks if a given token and account form a pool.
Whether the account is a pool for the token.
The account address.
A provider or signer object
Whether the account is a pool for the token.
Returns the token name
Returns the token name
a provider or signer for executing a web3 call
the token name
a provider or signer for executing a web3 call
the token name
Readonly nativeReadonly optionsReturns the real time balance of address.
Returns the real time balance of address.
real time balance of data
the target address
the timestamp you'd like to see the data
a provider or signer for executing a web3 call
real time balance of data
Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributes.
The id of the index.
The index publisher address you want to revoke for the subscriber.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Send amount tokens to recipient from transaction signer.
Send amount tokens to recipient from transaction signer.
the recipient of the tokens
the amount of tokens to send
Extra user data provided.
Readonly settingsReturns the token symbol
Returns the token symbol
a provider or signer for executing a web3 call
the token symbol
a provider or signer for executing a web3 call
the token symbol
Returns the total supply of the token.
Returns the total supply of the token.
a provider or signer for executing a web3 call
the total supply of the token
a provider or signer for executing a web3 call
the total supply of the token
Transfer receiver amount tokens.
Transfer receiver amount tokens.
An instance of Operation which can be executed or batched.
The receiver of the transfer.
The amount to be transferred.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Transfer from sender to receiver amount tokens.
Transfer from sender to receiver amount tokens.
An instance of Operation which can be executed or batched.
The sender of the transfer.
The receiver of the transfer.
The amount to be transferred.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Optional Readonly underlyingUpdate a flow of the token of this class.
Update a flow of the token of this class.
An instance of Operation which can be executed or batched.
The receiver of the flow.
The specified flow rate.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Update a flow as an operator.
The specified flow rate.
The sender of the flow.
The receiver of the flow.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Updates the IndexValue field of an index.
The id of the index.
The new indexValue.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
NOTE: It has the same effect as distribute, but is closer to the low level data structure of the index.
Updates the units allocated to a Subscription.
The id of the index.
The subscriber address whose units you want to update.
The amount of units you want to update to.
Extra user data provided.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed or batched.
Upgrade amount of a network's native asset to its SuperToken.
Upgrade amount of a network's native asset to its SuperToken.
Optional overrides?: Overrides & { An instance of Operation which can be executed.
The amount to be upgraded.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed.
Upgrade amount of a network's native asset to its SuperToken to to address.
Upgrade amount of a network's native asset to its SuperToken to to address.
Optional overrides?: Overrides & { An instance of Operation which can be executed.
The amount to be upgraded.
The destination of the upgraded native asset super tokens.
ethers overrides object for more control over the transaction sent.
An instance of Operation which can be executed.
Static createGive flow operator full control - max flow rate and create/update/delete permissions.
Revoke flow operator control - set flow rate to 0 with no permissions.
Generated using TypeDoc
NativeAssetSuperToken wraps the native asset of the network.