LiquidityProtectionStats
This contract aggregates the statistics of the liquidity protection mechanism.
Functions:
Function increaseTotalAmounts(address provider, contract IDSToken poolToken, contract IReserveToken reserveToken, uint256 poolAmount, uint256 reserveAmount)
increaseTotalAmounts(address provider, contract IDSToken poolToken, contract IReserveToken reserveToken, uint256 poolAmount, uint256 reserveAmount)
increases the total amounts
can be executed only by an owner
Parameters:
provider
: liquidity provider addresspoolToken
: pool token addressreserveToken
: reserve token addresspoolAmount
: pool token amountreserveAmount
: reserve token amount
Function decreaseTotalAmounts(address provider, contract IDSToken poolToken, contract IReserveToken reserveToken, uint256 poolAmount, uint256 reserveAmount)
decreaseTotalAmounts(address provider, contract IDSToken poolToken, contract IReserveToken reserveToken, uint256 poolAmount, uint256 reserveAmount)
decreases the total amounts
can be executed only by an owner
Parameters:
provider
: liquidity provider addresspoolToken
: pool token addressreserveToken
: reserve token addresspoolAmount
: pool token amountreserveAmount
: reserve token amount
Function addProviderPool(address provider, contract IDSToken poolToken) → bool
addProviderPool(address provider, contract IDSToken poolToken) → bool
adds a pool to the list of pools of a liquidity provider
can be executed only by an owner
Parameters:
provider
: liquidity provider addresspoolToken
: pool token address
Function removeProviderPool(address provider, contract IDSToken poolToken) → bool
removeProviderPool(address provider, contract IDSToken poolToken) → bool
removes a pool from the list of pools of a liquidity provider
can be executed only by an owner
Parameters:
provider
: liquidity provider addresspoolToken
: pool token address
Function totalPoolAmount(contract IDSToken poolToken) → uint256
totalPoolAmount(contract IDSToken poolToken) → uint256
returns the total amount of protected pool tokens
Parameters:
poolToken
: pool token address
Return Values:
total amount of protected pool tokens
Function totalReserveAmount(contract IDSToken poolToken, contract IReserveToken reserveToken) → uint256
totalReserveAmount(contract IDSToken poolToken, contract IReserveToken reserveToken) → uint256
returns the total amount of protected reserve tokens
Parameters:
poolToken
: pool token addressreserveToken
: reserve token address
Return Values:
total amount of protected reserve tokens
Function totalProviderAmount(address provider, contract IDSToken poolToken, contract IReserveToken reserveToken) → uint256
totalProviderAmount(address provider, contract IDSToken poolToken, contract IReserveToken reserveToken) → uint256
returns the total amount of a liquidity provider's protected reserve tokens
Parameters:
provider
: liquidity provider addresspoolToken
: pool token addressreserveToken
: reserve token address
Return Values:
total amount of the liquidity provider's protected reserve tokens
Function providerPools(address provider) → contract IDSToken[]
providerPools(address provider) → contract IDSToken[]
returns the list of pools of a liquidity provider
Parameters:
provider
: liquidity provider address
Return Values:
pool tokens
Function seedPoolAmounts(contract IDSToken[] poolTokens, uint256[] poolAmounts)
seedPoolAmounts(contract IDSToken[] poolTokens, uint256[] poolAmounts)
seeds the total amount of protected pool tokens
can be executed only by a seeder
Parameters:
poolTokens
: pool token addressespoolAmounts
: pool token amounts
Function seedReserveAmounts(contract IDSToken[] poolTokens, contract IReserveToken[] reserveTokens, uint256[] reserveAmounts)
seedReserveAmounts(contract IDSToken[] poolTokens, contract IReserveToken[] reserveTokens, uint256[] reserveAmounts)
seeds the total amount of protected reserve tokens
can be executed only by a seeder
Parameters:
poolTokens
: pool token addressesreserveTokens
: reserve token addressesreserveAmounts
: reserve token amounts
Function seedProviderAmounts(address[] providers, contract IDSToken[] poolTokens, contract IReserveToken[] reserveTokens, uint256[] reserveAmounts)
seedProviderAmounts(address[] providers, contract IDSToken[] poolTokens, contract IReserveToken[] reserveTokens, uint256[] reserveAmounts)
seeds the total amount of protected reserve tokens per liquidity provider
can be executed only by a seeder
Parameters:
providers
: liquidity provider addressespoolTokens
: pool token addressesreserveTokens
: reserve token addressesreserveAmounts
: reserve token amounts
Function seedProviderPools(address[] providers, contract IDSToken[] poolTokens)
seedProviderPools(address[] providers, contract IDSToken[] poolTokens)
seeds the list of pools per liquidity provider
can be executed only by a seeder
Parameters:
providers
: liquidity provider addressespoolTokens
: pool token addresses
Last updated