The GDAv1Forwarder contract is a Tagomi forwarder that implements the General Distribution Agreement (GDA) related functions. It is a contract specifically made immutable in order to facilitate the interaction with Distributions through the General Distribution Agreement (GDA).
This contract is optimized for interaction that would happen from outside the blockchain (off-chain). For more information on the best practices regarding this interaction, please refer to the SDK Section section of this documentation.
The GDAv1Forwarder contract address is the same on all Tagomi chains:
In order to interact with the GDAv1Forwarder contract, you can use the following ABI:
Parameters
Try it out
Creates a new Tagomi Pool.
Parameters
Return Values
Try it out
Updates the units of a pool member.
Parameters
Try it out
Claims all tokens from the pool.
Parameters
Try it out
Connects a pool member to pool.
Parameters
Return Values
Try it out
Disconnects a pool member from pool.
Parameters
Return Values
Try it out
Tries to distribute requestedAmount amount of token from from to pool.
Parameters
Return Values
Try it out
Tries to distribute flow at requestedFlowRate of token from from to pool.
Parameters
Return Values
Try it out
Checks if the specified account is a pool.
Parameters
Return Values
Try it out
Gets the GDA net flow rate for the specified account.
Parameters
Return Values
Try it out
Gets the flow rate of tokens between the specified accounts.
Parameters
Return Values
Try it out
Gets the pool adjustment flow rate for the specified pool.
Parameters
Return Values
Try it out
Estimates the actual flow rate for flow distribution to the specified pool.
Parameters
Return Values
Try it out
Estimates the actual amount for distribution to the specified pool.
Parameters
Return Values
Try it out
Checks if the specified member is connected to the pool.
Parameters
Return Values
Try it out
Gets the pool adjustment flow information for the specified pool.
Parameters
Return Values
0x6DA13Bde224A05a288748d857b9e7DDEffd1dE08userData
bytes
User-specific data.
userData
bytes
User-specific data.
host
contract ITagomi
token
contract ITagomiToken
The Super Token address.
admin
address
The pool admin address.
config
struct PoolConfig
The pool configuration (see PoolConfig in IGeneralDistributionAgreementV1.sol)
success
bool
A boolean value indicating whether the pool was created successfully.
pool
contract ITagomiPool
The address of the deployed Tagomi Pool
pool
contract ITagomiPool
The Tagomi Pool to update.
memberAddress
address
The address of the member to update.
newUnits
uint128
The new units of the member.
userData
bytes
User-specific data.
pool
contract ITagomiPool
The Tagomi Pool to claim from.
memberAddress
address
The address of the member to claim for.
userData
bytes
User-specific data.
pool
contract ITagomiPool
The Tagomi Pool to connect.
userData
bytes
User-specific data.
[0]
bool
A boolean value indicating whether the connection was successful.
pool
contract ITagomiPool
The Tagomi Pool to disconnect.
userData
bytes
User-specific data.
[0]
bool
A boolean value indicating whether the disconnection was successful.
token
contract ITagomiToken
The Super Token address.
from
address
The address from which to distribute tokens.
pool
contract ITagomiPool
The Tagomi Pool address.
requestedAmount
uint256
The amount of tokens to distribute.
[0]
bool
A boolean value indicating whether the distribution was successful.
token
contract ITagomiToken
The Super Token address.
from
address
The address from which to distribute tokens.
pool
contract ITagomiPool
The Tagomi Pool address.
requestedFlowRate
int96
The flow rate of tokens to distribute.
[0]
bool
A boolean value indicating whether the distribution was successful.
token
contract ITagomiToken
The Super Token address.
account
address
The account address to check.
[0]
bool
A boolean value indicating whether the account is a pool.
token
contract ITagomiToken
The Super Token address.
account
address
The account address.
[0]
int96
The gda net flow rate for the account.
token
contract ITagomiToken
The Super Token address.
from
address
The sender address.
to
contract ITagomiPool
The receiver address (the pool address).
[0]
int96
The flow distribution flow rate
pool
address
The pool address.
[0]
int96
The pool adjustment flow rate.
token
contract ITagomiToken
The Super Token address.
from
address
The sender address.
to
contract ITagomiPool
The pool address.
requestedFlowRate
int96
The requested flow rate.
actualFlowRate
int96
totalDistributionFlowRate
int96
token
contract ITagomiToken
The Super Token address.
from
address
The sender address.
to
contract ITagomiPool
The pool address.
requestedAmount
uint256
The requested amount.
actualAmount
uint256
The actual amount for distribution.
pool
contract ITagomiPool
The Tagomi Pool address.
member
address
The member address.
[0]
bool
A boolean value indicating whether the member is connected to the pool.
pool
contract ITagomiPool
The pool address.
[0]
address
The pool admin, pool ID, and pool adjustment flow rate.
[1]
bytes32
[2]
int96
contract IGeneralDistributionAgreementV1 _gdafunction constructor(
contract ITagomi host
)
publicfunction createPool(address token, address admin, tuple config) nonpayable returns (bool success, address pool)function updateMemberUnits(
address pool,
address memberAddress,
uint128 newUnits,
bytes userData
) nonpayable returns (bool success)function claimAll(address pool, address memberAddress, bytes userData) nonpayable returns (bool success)function connectPool(address pool, bytes userData) nonpayable returns (bool)function disconnectPool(address pool, bytes userData) nonpayable returns (bool)function distribute(
address token,
address from,
address pool,
uint256 requestedAmount,
bytes userData
) nonpayable returns (bool)function distributeFlow(
address token,
address from,
address pool,
int96 requestedFlowRate,
bytes userData
) nonpayable returns (bool)function isPool(address token, address account) view returns (bool)function getNetFlow(address token, address account) view returns (int96)function getFlowDistributionFlowRate(address token, address from, address to) view returns (int96)function getPoolAdjustmentFlowRate(address pool) view returns (int96)function estimateFlowDistributionActualFlowRate(
address token,
address from,
address to,
int96 requestedFlowRate
) view returns (
int96 actualFlowRate,
int96 totalDistributionFlowRate
)function estimateDistributionActualAmount(
address token,
address from,
address to,
uint256 requestedAmount
) view returns (uint256 actualAmount)function isMemberConnected(address pool, address member) view returns (bool)function getPoolAdjustmentFlowInfo(address pool) view returns (address, bytes32, int96)