state
MixinPoolState
balanceOf
function balanceOf(address who) external view returns (uint256)
Returns how many pool tokens a user holds.
Parameters
who
address
Address of the target account.
Return Values
[0]
uint256
Number of pool.
getPoolStorage
function getPoolStorage() external view returns (struct IRigoblockV3PoolState.ReturnedPool poolInitParams, struct IRigoblockV3PoolState.PoolParams poolVariables, struct IRigoblockV3PoolState.PoolTokens poolTokensInfo)
Returns the aggregate pool generic storage.
Return Values
poolInitParams
struct IRigoblockV3PoolState.ReturnedPool
The pool's initialization parameters.
poolVariables
struct IRigoblockV3PoolState.PoolParams
The pool's variables.
poolTokensInfo
struct IRigoblockV3PoolState.PoolTokens
The pool's tokens info.
getUserAccount
function getUserAccount(address who) external view returns (struct IRigoblockV3PoolState.UserAccount)
owner
function owner() external view returns (address)
Returns the address of the owner.
Return Values
[0]
address
Address of the owner.
decimals
function decimals() public view returns (uint8)
Decimals are initialized at proxy creation.
Return Values
[0]
uint8
Number of decimals.
getPool
function getPool() public view returns (struct IRigoblockV3PoolState.ReturnedPool)
Returns the struct containing pool initialization parameters.
Symbol is stored as bytes8 but returned as string in the returned struct, unlocked is omitted as alwasy true.
Return Values
[0]
struct IRigoblockV3PoolState.ReturnedPool
ReturnedPool struct.
getPoolParams
function getPoolParams() public view returns (struct IRigoblockV3PoolState.PoolParams)
Returns the struct compaining pool parameters.
Return Values
[0]
struct IRigoblockV3PoolState.PoolParams
PoolParams struct.
getPoolTokens
function getPoolTokens() public view returns (struct IRigoblockV3PoolState.PoolTokens)
Returns the struct containing pool tokens info.
Return Values
[0]
struct IRigoblockV3PoolState.PoolTokens
PoolTokens struct.
name
function name() public view returns (string)
Returns a string of the pool name.
Name maximum length 31 bytes.
Return Values
[0]
string
String of the name.
symbol
function symbol() public view returns (string)
Returns a string of the pool symbol.
Return Values
[0]
string
String of the symbol.
totalSupply
function totalSupply() public view returns (uint256)
_getFeeCollector
function _getFeeCollector() internal view returns (address)
_getMinPeriod
function _getMinPeriod() internal view returns (uint48)
_getSpread
function _getSpread() internal view returns (uint16)
_getUnitaryValue
function _getUnitaryValue() internal view returns (uint256)
Last updated