logos-storage-contracts-eth/contracts/vault/VaultBase.sol

// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;

import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "./Accounts.sol";
import "./Locks.sol";

/// Records account balances and token flows. Accounts are separated into funds.
/// Funds are kept separate between controllers.
///
/// A fund can only be manipulated by a controller when it is locked. Tokens can
/// only be withdrawn when a fund is unlocked.
///
/// The vault maintains a number of invariants to ensure its integrity.
///
/// The lock invariant ensures that there is a maximum time that a fund can be
/// locked:
///
/// (∀ controller ∈ Controller, fund ∈ Fund:
///   lock.expiry <= lock.maximum
///   where lock = _locks[controller][fund])
///
/// The account invariant ensures that the outgoing token flow can be sustained
/// for the maximum time that a fund can be locked:
///
/// (∀ controller ∈ Controller, fund ∈ Fund, account ∈ AccountId:
///   flow.outgoing * (lock.maximum - flow.updated) <= balance.available
///   where lock = _locks[controller][fund])
///   and flow = _accounts[controller][fund][account].flow
///   and balance = _accounts[controller][fund][account].balance
///
/// The flow invariant ensures that incoming and outgoing flow rates match:
///
/// (∀ controller ∈ Controller, fund ∈ Fund:
///   (∑ account ∈ AccountId: accounts[account].flow.incoming) =
///   (∑ account ∈ AccountId: accounts[account].flow.outgoing)
///   where accounts = _accounts[controller][fund])
///
abstract contract VaultBase {
  using SafeERC20 for IERC20;
  using Accounts for Account;
  using Locks for Lock;

  IERC20 internal immutable _token;

  /// Represents a smart contract that can redistribute and burn tokens in funds
  type Controller is address;
  /// Unique identifier for a fund, chosen by the controller
  type Fund is bytes32;

  /// Each fund has its own time lock
  mapping(Controller => mapping(Fund => Lock)) private _locks;
  /// Each account holder has its own set of accounts in a fund
  mapping(Controller => mapping(Fund => mapping(AccountId => Account)))
    private _accounts;

  constructor(IERC20 token) {
    _token = token;
  }

  function _getLockStatus(
    Controller controller,
    Fund fund
  ) internal view returns (LockStatus) {
    return _locks[controller][fund].status();
  }

  function _getLockExpiry(
    Controller controller,
    Fund fund
  ) internal view returns (Timestamp) {
    return _locks[controller][fund].expiry;
  }

  function _getBalance(
    Controller controller,
    Fund fund,
    AccountId id
  ) internal view returns (Balance memory) {
    Lock memory lock = _locks[controller][fund];
    LockStatus lockStatus = lock.status();
    if (lockStatus == LockStatus.Locked) {
      Account memory account = _accounts[controller][fund][id];
      account.update(Timestamps.currentTime());
      return account.balance;
    }
    if (lockStatus == LockStatus.Unlocked || lockStatus == LockStatus.Frozen) {
      Account memory account = _accounts[controller][fund][id];
      account.update(lock.flowEnd());
      return account.balance;
    }
    return Balance({available: 0, designated: 0});
  }

  function _lock(
    Controller controller,
    Fund fund,
    Timestamp expiry,
    Timestamp maximum
  ) internal {
    Lock memory lock = _locks[controller][fund];
    require(lock.status() == LockStatus.NoLock, VaultFundAlreadyLocked());
    lock.expiry = expiry;
    lock.maximum = maximum;
    _checkLockInvariant(lock);
    _locks[controller][fund] = lock;
  }

  function _extendLock(
    Controller controller,
    Fund fund,
    Timestamp expiry
  ) internal {
    Lock memory lock = _locks[controller][fund];
    require(lock.status() == LockStatus.Locked, VaultFundNotLocked());
    require(lock.expiry <= expiry, VaultInvalidExpiry());
    lock.expiry = expiry;
    _checkLockInvariant(lock);
    _locks[controller][fund] = lock;
  }

  function _deposit(
    Controller controller,
    Fund fund,
    AccountId id,
    uint128 amount
  ) internal {
    Lock storage lock = _locks[controller][fund];
    require(lock.status() == LockStatus.Locked, VaultFundNotLocked());

    Account storage account = _accounts[controller][fund][id];

    account.balance.available += amount;
    lock.value += amount;

    _token.safeTransferFrom(
      Controller.unwrap(controller),
      address(this),
      amount
    );
  }

  function _designate(
    Controller controller,
    Fund fund,
    AccountId id,
    uint128 amount
  ) internal {
    Lock memory lock = _locks[controller][fund];
    require(lock.status() == LockStatus.Locked, VaultFundNotLocked());

    Account memory account = _accounts[controller][fund][id];
    require(amount <= account.balance.available, VaultInsufficientBalance());

    account.balance.available -= amount;
    account.balance.designated += amount;
    _checkAccountInvariant(account, lock);

    _accounts[controller][fund][id] = account;
  }

  function _transfer(
    Controller controller,
    Fund fund,
    AccountId from,
    AccountId to,
    uint128 amount
  ) internal {
    Lock memory lock = _locks[controller][fund];
    require(lock.status() == LockStatus.Locked, VaultFundNotLocked());

    Account memory sender = _accounts[controller][fund][from];
    require(amount <= sender.balance.available, VaultInsufficientBalance());

    sender.balance.available -= amount;
    _checkAccountInvariant(sender, lock);

    _accounts[controller][fund][from] = sender;

    _accounts[controller][fund][to].balance.available += amount;
  }

  function _flow(
    Controller controller,
    Fund fund,
    AccountId from,
    AccountId to,
    TokensPerSecond rate
  ) internal {
    Lock memory lock = _locks[controller][fund];
    require(lock.status() == LockStatus.Locked, VaultFundNotLocked());

    Account memory sender = _accounts[controller][fund][from];
    sender.flowOut(rate);
    _checkAccountInvariant(sender, lock);
    _accounts[controller][fund][from] = sender;

    Account memory receiver = _accounts[controller][fund][to];
    receiver.flowIn(rate);
    _accounts[controller][fund][to] = receiver;
  }

  function _burnDesignated(
    Controller controller,
    Fund fund,
    AccountId id,
    uint128 amount
  ) internal {
    Lock storage lock = _locks[controller][fund];
    require(lock.status() == LockStatus.Locked, VaultFundNotLocked());

    Account storage account = _accounts[controller][fund][id];
    require(account.balance.designated >= amount, VaultInsufficientBalance());

    account.balance.designated -= amount;

    lock.value -= amount;

    _token.safeTransfer(address(0xdead), amount);
  }

  function _burnAccount(
    Controller controller,
    Fund fund,
    AccountId id
  ) internal {
    Lock storage lock = _locks[controller][fund];
    require(lock.status() == LockStatus.Locked, VaultFundNotLocked());

    Account memory account = _accounts[controller][fund][id];
    require(account.flow.incoming == account.flow.outgoing, VaultFlowNotZero());
    uint128 amount = account.balance.available + account.balance.designated;

    lock.value -= amount;

    delete _accounts[controller][fund][id];

    _token.safeTransfer(address(0xdead), amount);
  }

  function _freezeFund(Controller controller, Fund fund) internal {
    Lock storage lock = _locks[controller][fund];
    require(lock.status() == LockStatus.Locked, VaultFundNotLocked());

    lock.frozenAt = Timestamps.currentTime();
  }

  function _withdraw(Controller controller, Fund fund, AccountId id) internal {
    Lock memory lock = _locks[controller][fund];
    require(lock.status() == LockStatus.Unlocked, VaultFundNotUnlocked());

    Account memory account = _accounts[controller][fund][id];
    account.update(lock.flowEnd());
    uint128 amount = account.balance.available + account.balance.designated;

    lock.value -= amount;

    if (lock.value == 0) {
      delete _locks[controller][fund];
    } else {
      _locks[controller][fund] = lock;
    }

    delete _accounts[controller][fund][id];

    (address owner, ) = Accounts.decodeId(id);
    _token.safeTransfer(owner, amount);
  }

  function _checkLockInvariant(Lock memory lock) private pure {
    require(lock.expiry <= lock.maximum, VaultInvalidExpiry());
  }

  function _checkAccountInvariant(
    Account memory account,
    Lock memory lock
  ) private pure {
    require(account.isSolventAt(lock.maximum), VaultInsufficientBalance());
  }

  error VaultInsufficientBalance();
  error VaultInvalidExpiry();
  error VaultFundNotLocked();
  error VaultFundNotUnlocked();
  error VaultFundAlreadyLocked();
  error VaultFlowNotZero();
}