3 releases
new 0.0.0-main.170+2025.05.05 | May 5, 2025 |
---|
#94 in Magic Beans
43 downloads per month
Used in 2 crates
315KB
6.5K
SLoC
BVS Vault Bank
The BVS Vault Bank is a specialized vault contract
designed to support native bank tokens as the underlying asset in the SatLayer ecosystem.
It enables operators to manage deposits and withdrawals of native tokens
like ubbn
(the native token of the Babylon project).
The Vault Bank implements the ERC-4626 tokenized vault standard, providing a standardized interface for yield-bearing vaults. It manages the relationship between deposited assets and shares, allowing for efficient tracking of user deposits and their corresponding value.
- Native Token Support: Handles native bank tokens as the underlying asset
- Share-Based Accounting: Uses a share system to track user deposits and their value
Contract Functions
Execute Functions
DepositFor
: Deposit native tokens into the vault for a recipientWithdrawTo
: Withdraw native tokens from the vault to a recipientQueueWithdrawalTo
: Queue a withdrawal request for later processingRedeemWithdrawalTo
: Process a queued withdrawal request
Query Functions
Shares
: Get the number of shares owned by a stakerAssets
: Get the asset value of shares owned by a stakerConvertToAssets
: Convert a share amount to its asset valueConvertToShares
: Convert an asset amount to its share valueTotalShares
: Get the total number of shares in the vaultTotalAssets
: Get the total asset value in the vaultQueuedWithdrawal
: Get information about a queued withdrawalVaultInfo
: Get general information about the vault
Deposit and Withdrawal Process
The Vault Bank manages deposits and withdrawals through a share-based system:
- When users deposit assets, they receive shares proportional to their deposit value
- The share price (exchange rate) is determined by the total assets and total shares in the vault
- When users withdraw, their shares are converted back to assets based on the current exchange rate
- If the operator is not actively validating, withdrawals are queued for later processing
The vault implements a withdrawal queue to handle situations where immediate withdrawals are not possible:
- Users request a withdrawal via
QueueWithdrawalTo
- The request is stored with a timestamp and the current exchange rate
- After the lock period expires, users can redeem their withdrawal via
RedeemWithdrawalTo
- The withdrawal is processed using the exchange rate from when it was queued
Dependencies
~19MB
~333K SLoC