Documentation Index

Fetch the complete documentation index at: https://docs.monolith.market/llms.txt

Use this file to discover all available pages before exploring further.

​

Vault Contract

​

ERC4626 Standard Functions

​

deposit

function deposit(uint256 assets, address receiver) public accrueInterest override returns (uint256 shares)

• assets: Amount of underlying assets to deposit (in wei)
• receiver: Address to receive the vault shares

• shares: Amount of vault shares minted

• assets must be > 0
• Caller must have approved vault for asset transfer
• If this is the first ever deposit into the vault, the minted shares must be at least MIN_SHARES (1e16); otherwise the transaction reverts

• Transfers assets from caller to vault
• Mints shares to receiver
• Updates total assets
• Accrues interest before deposit
• On the first ever deposit, MIN_SHARES shares are burned from the receiver and sent to address(0) to initialize share pricing; the receiver’s net minted shares are reduced by MIN_SHARES

​

mint

function mint(uint256 shares, address receiver) public accrueInterest override returns (uint256 assets)

• shares: Exact amount of shares to mint
• receiver: Address to receive the vault shares

• assets: Amount of assets required for the mint

• shares must be > 0
• Caller must have sufficient assets approved
• If this is the first ever mint into the vault, the requested shares must be at least MIN_SHARES (1e16); otherwise the transaction reverts

• Calculates required assets based on current share price
• Transfers assets from caller to vault
• Mints exact shares to receiver
• On the first ever mint, MIN_SHARES shares are burned from the receiver and sent to address(0); the corresponding assets are effectively reserved

​

withdraw

function withdraw(
    uint256 assets,
    address receiver,
    address owner
) public accrueInterest override returns (uint256 shares)

• assets: Amount of assets to withdraw
• receiver: Address to receive the assets
• owner: Address that owns the shares (can be different from caller with approval)

• shares: Amount of shares burned

• assets must be ≤ owner’s balance
• If owner != msg.sender, caller must have withdrawal approval
• Vault must have sufficient assets

• Burns shares from owner
• Transfers assets to receiver
• Updates total assets

​

redeem

function redeem(
    uint256 shares,
    address receiver,
    address owner
) public accrueInterest override returns (uint256 assets)

• shares: Amount of shares to redeem
• receiver: Address to receive the assets
• owner: Address that owns the shares

• assets: Amount of assets returned

• shares must be ≤ owner’s balance
• If owner != msg.sender, caller must have approval

• Burns shares from owner
• Transfers assets to receiver
• Returns actual assets received (may differ due to rounding)

​

View Functions

​

totalAssets

function totalAssets() public view override returns (uint256)

• uint256: Total assets in wei

​

convertToShares

function convertToShares(uint256 assets) public view override returns (uint256)

• assets: Amount of assets to convert

• uint256: Equivalent shares amount

​

convertToAssets

function convertToAssets(uint256 shares) public view override returns (uint256)

• shares: Amount of shares to convert

• uint256: Equivalent assets amount

​

maxDeposit

function maxDeposit(address) public view override returns (uint256)

• uint256: Maximum deposit amount (type(uint256).max if unlimited)

​

maxMint

function maxMint(address) public view override returns (uint256)

• uint256: Maximum mint amount

​

maxWithdraw

function maxWithdraw(address owner) public view override returns (uint256)

• owner: Address to check withdrawal limit for

• uint256: Maximum withdrawable assets

​

maxRedeem

function maxRedeem(address owner) public view override returns (uint256)

• owner: Address to check redemption limit for

• uint256: Maximum redeemable shares

​

previewDeposit

function previewDeposit(uint256 assets) public view override returns (uint256)

• assets: Amount of assets to deposit

• uint256: Expected shares to receive

​

previewMint

function previewMint(uint256 shares) public view override returns (uint256)

• shares: Amount of shares to mint

• uint256: Required assets amount

​

previewWithdraw

function previewWithdraw(uint256 assets) public view override returns (uint256)

• assets: Amount of assets to withdraw

• uint256: Shares to be burned

​

previewRedeem

function previewRedeem(uint256 shares) public view override returns (uint256)

• shares: Amount of shares to redeem

• uint256: Assets to be received

​

ERC20 Functions

• name(): Returns vault share token name
• symbol(): Returns vault share token symbol
• decimals(): Returns decimals (same as underlying asset)
• totalSupply(): Returns total vault shares
• balanceOf(address): Returns shares balance of address
• transfer(address,uint256): Transfers shares
• allowance(address,address): Returns transfer allowance
• approve(address,uint256): Approves share transfers
• transferFrom(address,address,uint256): Transfers shares with approval

​

Yield and Staking Features

​

accrueInterest

function accrueInterest() external

• Updates vault’s asset balance with accrued interest
• Maintains accurate share pricing

​

Security Considerations

• All state-changing functions accrue interest first
• Share calculations use current total assets
• The first ever depositor forfeits MIN_SHARES (1e16 = 0.01 share units) which are burned to address(0) to prevent the ERC‑4626 inflation attack