Common Workflows

List of most common workflows.

Deposits

  1. A holder of the underlying ERC20 asset gives proper allowance (approve) of that asset to the Firelight Vault.

  2. The holder transfers (deposit or mint) the asset to the Launch Vault, and receives shares.

Withdrawals

  1. The shareholder starts a withdrawal request (withdraw or redeem) to exchange shares for the underlying assets.

  2. After the waiting time has passed, the shareholder can claim the requested withdrawal (claimWithdraw) for that period.

Useful Functions:

  • asset(): Returns the address of the underlying token.

  • totalAssets(): Returns the total amount of the underlying asset.

  • convertToShares(assets): Returns the amount of shares that the vault would exchange for the amount of assets provided.

  • convertToAssets(shares): Returns the amount of assets that the vault would exchange for the amount of shares provided.

  • isBlocklisted(account): Indicates whether an account is blocklisted.

  • depositLimit(): The maximum total amount of assets that can be deposited into the vault.

  • currentPeriod(): Returns the current active period.

  • balanceOfAt(account, timestamp): Returns the effective total shares for account at a specific timestamp.

Last updated