For the complete documentation index, see llms.txt. This page is also available as Markdown.

MixinPoolState

MixinPoolState

balanceOf

function balanceOf(address who) external view returns (uint256)

Returns token balance for an address.

Parameters

Name
Type
Description

who

address

Address to query balance for.

Return Values

Name
Type
Description

[0]

uint256

Number of units held.

getAcceptedMintTokens

function getAcceptedMintTokens() external view returns (address[] tokens)

Returns the list of accepted mint tokens.

Return Values

Name
Type
Description

tokens

address[]

Array of token addresses.

getActiveApplications

Returns the active application flags.

Grg staking is always queried regardless of the active bit.

Return Values

Name
Type
Description

packedApplications

uint256

Packed value of bitmap encoded active flags.

getActiveTokens

Returns the list of active tokens and the base token.

Base token is always active.

Return Values

Name
Type
Description

tokens

struct ISmartPoolState.ActiveTokens

Tuple of active tokens list and base token.

getPoolStorage

Returns the aggregate pool generic storage.

Return Values

Name
Type
Description

poolInitParams

struct ISmartPoolState.ReturnedPool

The pool's initialization parameters.

poolVariables

struct ISmartPoolState.PoolParams

The pool's variables.

poolTokensInfo

struct ISmartPoolState.PoolTokens

The pool's tokens info.

getUserAccount

Returns a pool holder's account struct.

Return Values

Name
Type
Description

[0]

struct ISmartPoolState.UserAccount

UserAccount struct.

name

Returns a string of the pool name.

Name maximum length 31 bytes.

Return Values

Name
Type
Description

[0]

string

String of the name.

owner

Returns the address of the owner.

Return Values

Name
Type
Description

[0]

address

Address of the owner.

totalSupply

Returns the total amount of issued tokens for this pool.

Return Values

Name
Type
Description

[0]

uint256

Number of total issued tokens.

decimals

getPool

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

Name
Type
Description

[0]

struct ISmartPoolState.ReturnedPool

ReturnedPool struct.

getPoolParams

Returns the struct compaining pool parameters.

Return Values

Name
Type
Description

[0]

struct ISmartPoolState.PoolParams

PoolParams struct.

getPoolTokens

Returns the struct containing pool tokens info. Unitary value is the last stored unitary value.

Return Values

Name
Type
Description

[0]

struct ISmartPoolState.PoolTokens

PoolTokens struct.

symbol

Returns a string of the pool symbol.

Return Values

Name
Type
Description

[0]

string

String of the symbol.

isOperator

getDelegatedAddresses

Returns all addresses currently granted delegated write access to a selector.

Parameters

Name
Type
Description

selector

bytes4

The adapter function selector to query.

Return Values

Name
Type
Description

[0]

address[]

getDelegatedSelectors

Returns all selectors currently delegated to an address.

Parameters

Name
Type
Description

delegated

address

The address to query.

Return Values

Name
Type
Description

[0]

bytes4[]

_getActiveApplications

virtual methods

_getFeeCollector

_getMinPeriod

_getSpread

_Returns the spread, or MAX_SPREAD if not set

_getTokenJar

Last updated