logos-storage/logos-storage-contracts-eth
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-contracts-eth.git synced 2026-01-06 23:33:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

vault: update documentation

Browse Source
This commit is contained in:
Mark Spanbroek 2025-02-11 14:36:26 +01:00
parent 473a5fec19
commit 81032965f4
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
contracts/Vault.sol
View File

@ -95,6 +95,7 @@ contract Vault is VaultBase {
/// Delays unlocking of a locked fund. The new expiry should be later than /// Delays unlocking of a locked fund. The new expiry should be later than
/// the existing expiry, but no later than the maximum timestamp that was /// the existing expiry, but no later than the maximum timestamp that was
/// provided when locking the fund. /// provided when locking the fund.
/// Only allowed when the lock has not unlocked yet.
function extendLock(Fund fund, Timestamp expiry) public { function extendLock(Fund fund, Timestamp expiry) public {
Controller controller = Controller.wrap(msg.sender); Controller controller = Controller.wrap(msg.sender);
_extendLock(controller, fund, expiry); _extendLock(controller, fund, expiry);
@ -137,7 +138,8 @@ contract Vault is VaultBase {
/// Transfers tokens from the account of one recipient to the other over time. /// Transfers tokens from the account of one recipient to the other over time.
/// Every second a number of tokens are transfered, until the fund is /// Every second a number of tokens are transfered, until the fund is
/// unlocked. /// unlocked. After flowing into an account, these tokens become designated
/// tokens, so they cannot be transfered again.
/// Only allowed when the fund is locked. /// Only allowed when the fund is locked.
/// Only allowed when the balance is sufficient to sustain the flow until the /// Only allowed when the balance is sufficient to sustain the flow until the
/// fund unlocks, even if the lock expiry time is extended to its maximum. /// fund unlocks, even if the lock expiry time is extended to its maximum.
@ -160,6 +162,7 @@ contract Vault is VaultBase {
/// Burns all tokens from the account of the recipient. /// Burns all tokens from the account of the recipient.
/// Only allowed when the fund is locked. /// Only allowed when the fund is locked.
/// Only allowed when no funds are flowing into or out of the account.
function burnAccount(Fund fund, Recipient recipient) public { function burnAccount(Fund fund, Recipient recipient) public {
Controller controller = Controller.wrap(msg.sender); Controller controller = Controller.wrap(msg.sender);
_burnAccount(controller, fund, recipient); _burnAccount(controller, fund, recipient);

7
contracts/vault/VaultBase.sol
View File

@ -25,9 +25,10 @@ import "./Locks.sol";
/// for the maximum time that a fund can be locked: /// for the maximum time that a fund can be locked:
/// ///
/// (∀ controller ∈ Controller, fund ∈ Fund, recipient ∈ Recipient: /// (∀ controller ∈ Controller, fund ∈ Fund, recipient ∈ Recipient:
/// account.isSolventAt(lock.maximum) /// flow.outgoing * (lock.maximum - flow.updated) <= balance.available
/// where account = _accounts[controller][fund][recipient] /// where lock = _locks[controller][fund])
/// and lock = _locks[controller][fund]) /// and flow = _accounts[controller][fund][recipient].flow
/// and balance = _accounts[controller][fund][recipient].balance
/// ///
/// The flow invariant ensures that incoming and outgoing flow rates match: /// The flow invariant ensures that incoming and outgoing flow rates match:
/// ///