ISETH is the interface for native Super Tokens.
In order to interact with any contract satistying the ISETH interface, you can use the following ABI:
Parameters
Parameters
Super ETH (SETH) full interface
to
address
wad
uint256
function upgradeByETH(
)
externalfunction upgradeByETHTo(
address to
)
externalfunction downgradeToETH(
uint256 wad
)
externalThis is the technical reference related to the interface for any super token pool regardless of the distribution schemes.
Parameters
Parameters
A boolean indicating whether pool members can transfer their units
A boolean indicating whether addresses other than the pool admin can distribute via the pool
The admin is the creator of the pool and has permissions to update member units and is the recipient of the adjustment flow rate
The pool admin
The SuperToken for the pool
The total units of the pool
The total number of units of connected members
The total number of units of disconnected members
Parameters
The total number of units for memberAddress
The total flow rate of the pool
The flow rate of the connected members
The flow rate of the disconnected members
Parameters
The balance of all the disconnected members at time
Parameters
The flow rate a member is receiving from the pool
Parameters
The claimable balance for memberAddr at time in the pool
Parameters
The claimable balance for memberAddr at block.timestamp in the pool
Parameters
Sets memberAddr ownedUnits to newUnits
Parameters
Claims the claimable balance for memberAddr at block.timestamp
Claims the claimable balance for msg.sender at block.timestamp
Parameters
Return Values
Increases the allowance of spender by addedValue
Parameters
Return Values
Decreases the allowance of spender by subtractedValue
struct PoolIndexData {
uint128 totalUnits;
uint32 wrappedSettledAt;
int96 wrappedFlowRate;
int256 wrappedSettledValue;
}struct MemberData {
uint128 ownedUnits;
uint32 syncedSettledAt;
int96 syncedFlowRate;
int256 syncedSettledValue;
int256 settledValue;
int256 claimedValue;
}token
contract ITagomiToken
member
address
oldUnits
uint128
newUnits
uint128
token
contract ITagomiToken
member
address
claimedAmount
int256
totalClaimed
int256
memberAddress
address
The address of the member
time
uint32
The time to query
memberAddress
address
The address of the member
memberAddr
address
The address of the member
time
uint32
The time to query
memberAddr
address
The address of the member
memberAddr
address
The address of the member
newUnits
uint128
The new units for the member
memberAddr
address
The address of the member
spender
address
The address of the spender
addedValue
uint256
The amount to increase the allowance by
[0]
bool
true if successful
spender
address
The address of the spender
subtractedValue
uint256
The amount to decrease the allowance by
[0]
bool
true if successful
error Tagomi_POOL_INVALID_TIME()error Tagomi_POOL_NO_POOL_MEMBERS()error Tagomi_POOL_NO_ZERO_ADDRESS()error Tagomi_POOL_NOT_POOL_ADMIN_OR_GDA()error Tagomi_POOL_NOT_GDA()error Tagomi_POOL_TRANSFER_UNITS_NOT_ALLOWED()event MemberUnitsUpdated(
contract ITagomiToken token,
address member,
uint128 oldUnits,
uint128 newUnits
)event DistributionClaimed(
contract ITagomiToken token,
address member,
int256 claimedAmount,
int256 totalClaimed
)function transferabilityForUnitsOwner(
)
external
returns (bool)function distributionFromAnyAddress(
)
external
returns (bool)function admin(
)
external
returns (address)function superToken(
)
external
returns (contract ITagomiToken)function getTotalUnits(
)
external
returns (uint128)function getTotalConnectedUnits(
)
external
returns (uint128)function getTotalDisconnectedUnits(
)
external
returns (uint128)function getUnits(
address memberAddress
)
external
returns (uint128)function getTotalFlowRate(
)
external
returns (int96)function getTotalConnectedFlowRate(
)
external
returns (int96)function getTotalDisconnectedFlowRate(
)
external
returns (int96)function getDisconnectedBalance(
uint32 time
)
external
returns (int256 balance)function getMemberFlowRate(
address memberAddress
)
external
returns (int96)function getClaimable(
address memberAddr,
uint32 time
)
external
returns (int256)function getClaimableNow(
address memberAddr
)
external
returns (int256 claimableBalance, uint256 timestamp)function updateMemberUnits(
address memberAddr,
uint128 newUnits
)
external
returns (bool)function claimAll(
address memberAddr
)
external
returns (bool)function claimAll(
)
external
returns (bool)function increaseAllowance(
address spender,
uint256 addedValue
)
external
returns (bool)function decreaseAllowance(
address spender,
uint256 subtractedValue
)
external
returns (bool)