Solidity API

PropsERC4626Internal

_getDeploymentSeedAmount

function _getDeploymentSeedAmount(address _asset) internal view returns (uint256)

_calculateFee

function _calculateFee(uint256 amount) internal pure returns (uint256)

Calculates fee amount for a given value

__ERC4626_init

function __ERC4626_init(contract IERC20 asset_) internal

Set the underlying asset contract. This must be an ERC20-compatible contract (ERC-20 or ERC-777).

__ERC4626_init_unchained

function __ERC4626_init_unchained(contract IERC20 asset_) internal

_asset

function _asset() internal view virtual returns (address)

_totalAssets

function _totalAssets() internal view virtual returns (uint256)

See {IERC4626-totalAssets}.

_totalTokens

function _totalTokens() internal view virtual returns (uint256)

_totalTokenReserve

function _totalTokenReserve() internal view virtual returns (uint256)

_setIsGraduated

function _setIsGraduated(bool isGraduated) internal

_isGraduated

function _isGraduated() internal view returns (bool)

_totalAssetReserve

function _totalAssetReserve() internal view virtual returns (uint256)

_maxDeposit

function _maxDeposit(address owner) internal view virtual returns (uint256)

_maxMint

function _maxMint(address receiver) internal view virtual returns (uint256)

_maxWithdraw

function _maxWithdraw(address owner) internal view virtual returns (uint256)

_maxRedeem

function _maxRedeem(address owner) internal view virtual returns (uint256)

_previewDeposit

function _previewDeposit(uint256 assets) internal view virtual returns (uint256, uint256, uint256)

_previewMint

function _previewMint(uint256 assets) internal view virtual returns (uint256, uint256, uint256)

_previewWithdraw

function _previewWithdraw(uint256 shares) internal view virtual returns (uint256, uint256, uint256)

_previewRedeem

function _previewRedeem(uint256 shares) internal view virtual returns (uint256, uint256, uint256)

f

function f(uint256 A) internal pure returns (uint256)

_Square root bonding curve function mapping asset reserve A to cumulative minted shares. f(A) = SEED_SHARES * sqrt(A/TARGET_ASSETS) Properties:

• f(0) = 0
• f(TARGET_ASSETS) = SEED_SHARES
• Gradual distribution that slows down as more assets are added_

fInv

function fInv(uint256 S) internal pure returns (uint256)

Inverse of the square root bonding curve. Given S shares, returns the asset amount A where f(A) = S. A = TARGET_ASSETS * (S/SEED_SHARES)^2

_convertToShares

function _convertToShares(uint256 assets, enum Math.Rounding) internal view virtual returns (uint256, uint256, uint256)

Internal conversion function (from assets to shares) using the differential model. Computes minted shares as: mintedShares = f(A_current + ΔA_net) - f(A_current), where ΔA_net = assets - deposit fee.

_convertToAssets

function _convertToAssets(uint256 shares, enum Math.Rounding) internal view virtual returns (uint256, uint256, uint256)

Internal conversion function (from shares to assets) using the differential model. Redemption is computed by "rewinding" the cumulative function. Let f(A_current) be the cumulative share count at the current asset reserve A_current. Redeeming X shares will yield an asset redemption of: grossAssets = A_current - fInv( f(A_current) - X ). After subtracting the withdrawal fee, the returned asset amount is: netAssets = grossAssets - fee.

_deposit

function _deposit(address caller, address receiver, uint256 assets, uint256 shares, uint256 assetFee, uint256 sharesFee) internal virtual

Deposit/mint common workflow. Includes 0.3% fee collection

_withdraw

function _withdraw(address caller, address receiver, address owner, uint256 assets, uint256 shares, uint256 assetFee, uint256 sharesFee) internal virtual

Withdraw/redeem common workflow. Includes 0.3% fee collection

_increaseTreasuryAssetBalance

function _increaseTreasuryAssetBalance(uint256 amount) internal

_decreaseTreasuryAssetBalance

function _decreaseTreasuryAssetBalance(uint256 amount) internal

_getTreasuryAssetBalance

function _getTreasuryAssetBalance() internal view returns (uint256)

_withdrawAssetsFromTreasury

function _withdrawAssetsFromTreasury(uint256 assets, address receiver) internal

_increaseTreasuryTokenBalance

function _increaseTreasuryTokenBalance(uint256 amount) internal

_decreaseTreasuryTokenBalance

function _decreaseTreasuryTokenBalance(uint256 amount) internal

_getTreasuryTokenBalance

function _getTreasuryTokenBalance() internal view returns (uint256)

_withdrawTokensFromTreasury

function _withdrawTokensFromTreasury(uint256 tokens, address receiver) internal

_decimalsOffset

function _decimalsOffset() internal view virtual returns (uint8)

_setName

function _setName(string name_) internal

_allowance

function _allowance(address owner, address spender) internal view returns (uint256)

_approve

function _approve(address owner, address spender, uint256 amount) internal returns (bool)

_balanceOf

function _balanceOf(address account) internal view returns (uint256)

Query the token balance of given account

Returns the current balance of an address from storage

Parameters

Name	Type	Description
account	address	Address to query the balance of

Return Values

Name	Type	Description
[0]	uint256	Number of tokens owned by the account

_name

function _name() internal view returns (string)

Returns the name of the token

Reads the token name from the ERC20MetadataStorage layout

Return Values

Name	Type	Description
[0]	string	The name of the token as a string

_symbol

function _symbol() internal view returns (string)

Returns the symbol of the token

Reads the token symbol from the ERC20MetadataStorage layout

Return Values

Name	Type	Description
[0]	string	The symbol of the token as a string

_decimals

function _decimals() internal view virtual returns (uint8)

Returns the number of decimals used for token display

Reads the decimals value from the ERC20MetadataStorage layout. The decimals value is used to determine how to interpret the token's raw numeric value. For example, if decimals is 2, a raw value of 100 should be displayed as 1.00

Return Values

Name	Type	Description
[0]	uint8	The number of decimals places for token display

_totalSupply

function _totalSupply() internal view virtual returns (uint256)

See {IERC4626-totalAssets}.

_transfer

function _transfer(address from, address to, uint256 amount) internal returns (bool)

_transferFrom

function _transferFrom(address from, address to, uint256 amount) internal returns (bool)

_getPercentOfGraduation

function _getPercentOfGraduation() internal view returns (uint256)

_hasReachedGraduation

function _hasReachedGraduation() internal view returns (bool)

Check if the pool has reached graduation threshold (51% of SEED_SHARES distributed)