Skip to content

Commit

Permalink
Clean up comments
Browse files Browse the repository at this point in the history
  • Loading branch information
miohtama committed Jan 5, 2025
1 parent 7092ac1 commit 3d206de
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
4 changes: 2 additions & 2 deletions eth_defi/lagoon/analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ class LagoonSettlementEvent:
#: Vault address
vault: LagoonVault

#: Number of deposit event processes (0..1)
#: Number of deposit event processed (0..1)
deposit_events: int

#: Number of deposit event processes (0..1)
#: Number of deposit event processed (0..1)
redeem_events: int

#: How much new underlying was added to the vault
Expand Down
10 changes: 6 additions & 4 deletions eth_defi/lagoon/vault.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,9 @@ class LagoonVaultInfo(VaultInfo):
version: str




class LagoonVault(VaultBase):
"""Python interface for interacting with Lagoon Finance vaults.
TODO: Work in progress
For information see :py:class:`~eth_defi.vault.base.VaultBase` base class documentation.
Notes
Expand All @@ -79,6 +75,12 @@ class LagoonVault(VaultBase):
- Ok so for settlement you dont have to worry about this metric, the only thing you have to value is the assets inside the safe (what you currently have under management) and update the NAV of the vault by calling updateNewTotalAssets (ex: if you have 1M inside the vault and 500K pending deposit you only need to call updateTotalAssets with the 1M that are currently inside the safe). Then, to settle you just call settleDeposit and the vault calculate everything for you.
- To monitor the pending deposits it's a bit more complicated. You have to check the balanceOf the pendingSilo contract (0xAD1241Ba37ab07fFc5d38e006747F8b92BB217D5) in term of underlying (here USDC) for pending deposit and in term of shares (so the vault itself) for pending withdraw requests
Lagoon tokens can be in
- Safe: Tradeable assets
- Silo: pending deposits (USDC)
- Vault: pending redemptions (USDC)
- User wallets: after `deposit()` have been called share tokens are moved to the user wallet
"""

def __init__(
Expand Down

0 comments on commit 3d206de

Please sign in to comment.