Returns the desired Operation based on shouldUseCallAgreement.
Returns the desired Operation based on shouldUseCallAgreement.
the host.callAgreement created Operation
Optional
forwarderPopulatedTransactionPromise: Promise<PopulatedTransaction>the populated forwarder transaction promise
Optional
shouldUseCallAgreement: booleanwhether or not to use host.callAgreement
whether or not to use host.callAgreement
the host.callAgreement created Operation
the populated forwarder transaction promise
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.
Readonly
contractCreates a new pool with the given token and admin.
Creates a new pool with the given token and admin.
CreatePoolTxn and SuperfluidPool instance
The token address.
The admin address.
CreatePoolTxn and SuperfluidPool instance
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 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 token address.
The sender's address.
The pool address.
The requested amount to distribute.
The user data.
The transaction overrides.
The call agreement operation result.
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 token address.
The sender's address.
The pool address.
The requested flow rate.
The user data.
The transaction overrides.
The call agreement operation result.
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 token address.
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 token address.
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
forwarderRetrieves 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 token address.
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 token address.
The account address.
A provider or signer object
The net flow of the account for the token.
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 token address.
The pool address.
A provider or signer object
The pool adjustment flow rate for the token and pool.
Readonly
hostChecks 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 token address.
The account address.
A provider or signer object
Whether the account is a pool for the token.
Generated using TypeDoc
General Distribution Agreement V1 Helper Class
Description
A helper class to interact with the GDAV1 contract.