@sablier/bob 1.0.1

package/src/interfaces/external/ILidoWithdrawalQueue.sol

@@ -0,0 +1,67 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22;
+
+/// @title ILidoWithdrawalQueue
+/// @notice Minimal interface for Lido's WithdrawalQueueERC721 contract.
+/// @dev Used as a fallback unstaking path when the Curve pool is unavailable.
+interface ILidoWithdrawalQueue {
+    /*//////////////////////////////////////////////////////////////////////////
+                                READ-ONLY FUNCTIONS
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Maximum amount of stETH that can be withdrawn in a single request.
+    function MAX_STETH_WITHDRAWAL_AMOUNT() external view returns (uint256);
+
+    /// @notice Minimum amount of stETH that can be withdrawn in a single request.
+    function MIN_STETH_WITHDRAWAL_AMOUNT() external view returns (uint256);
+
+    /// @notice Finds the list of hints for the given `_requestIds` searching among the checkpoints with indices in the
+    /// range  `[_firstIndex, _lastIndex]`.
+    /// @dev
+    /// - Array of request IDs should be sorted.
+    /// - `_firstIndex` should be greater than 0, because checkpoint list is 1-based array.
+    /// - `_lastIndex` should be less than or equal to `getLastCheckpointIndex()`.
+    /// @param _requestIds IDs of the requests sorted in the ascending order to get hints for.
+    /// @param _firstIndex Left boundary of the search range. Should be greater than 0.
+    /// @param _lastIndex Right boundary of the search range. Should be less than or equal to
+    /// `getLastCheckpointIndex()`.
+    /// @return hintIds Array of hints used to find required checkpoint for the request.
+    function findCheckpointHints(
+        uint256[] calldata _requestIds,
+        uint256 _firstIndex,
+        uint256 _lastIndex
+    )
+        external
+        view
+        returns (uint256[] memory hintIds);
+
+    /// @notice Length of the checkpoint array. Last possible value for the hint.
+    function getLastCheckpointIndex() external view returns (uint256);
+
+    /*//////////////////////////////////////////////////////////////////////////
+                              STATE-CHANGING FUNCTIONS
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Claim a batch of withdrawal requests if they are finalized sending locked ETH to the owner.
+    /// @param _requestIds Array of request IDs to claim.
+    /// @param _hints Checkpoint hint for each ID. Can be obtained with `findCheckpointHints()`
+    /// @dev Reverts if any of the following conditions are met:
+    ///  - `requestIds` and `hints` arrays length differs.
+    ///  - Any `requestId` or `hint` in arguments are not valid.
+    ///  - Any request is not finalized or already claimed.
+    ///  - `msg.sender` is not an owner of the requests.
+    function claimWithdrawals(uint256[] calldata _requestIds, uint256[] calldata _hints) external;
+
+    /// @notice Request the batch of stETH for withdrawal. Approvals for the passed amounts should be done before.
+    /// @param _amounts Array of stETH amount values. The standalone withdrawal request will be created for each item
+    /// in the passed list.
+    /// @param _owner Address that will be able to manage the created requests. If `address(0)` is passed, `msg.sender`
+    /// will be used as owner.
+    /// @return requestIds Array of the created withdrawal request IDs.
+    function requestWithdrawals(
+        uint256[] calldata _amounts,
+        address _owner
+    )
+        external
+        returns (uint256[] memory requestIds);
+}

package/src/interfaces/external/IStETH.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+/// @title IStETH
+/// @notice Minimal interface for Lido's stETH.
+interface IStETH is IERC20 {
+    /*//////////////////////////////////////////////////////////////////////////
+                              STATE-CHANGING FUNCTIONS
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Send funds to the Lido pool with the optional referral parameter and mints stETH.
+    /// @dev The amount of stETH minted equals the amount of ETH sent.
+    /// @param referral The referral address can be zero.
+    /// @return amount The amount of stETH minted.
+    function submit(address referral) external payable returns (uint256 amount);
+}

package/src/interfaces/external/IWETH9.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+/// @title IWETH9
+/// @notice Minimal interface for Wrapped Ether.
+interface IWETH9 is IERC20 {
+    /*//////////////////////////////////////////////////////////////////////////
+                              STATE-CHANGING FUNCTIONS
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Deposits ETH and mints WETH.
+    function deposit() external payable;
+
+    /// @notice Burns WETH and withdraws ETH.
+    /// @param amount The amount of WETH to burn.
+    function withdraw(uint256 amount) external;
+}

package/src/interfaces/external/IWstETH.sol

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+/// @title IWstETH
+/// @notice Minimal interface for Lido's wstETH.
+interface IWstETH is IERC20 {
+    /*//////////////////////////////////////////////////////////////////////////
+                                READ-ONLY FUNCTIONS
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Returns the amount of stETH for a given amount of wstETH.
+    /// @param wstETHAmount The amount of wstETH.
+    /// @return The equivalent amount of stETH.
+    function getStETHByWstETH(uint256 wstETHAmount) external view returns (uint256);
+
+    /// @notice Returns the amount of wstETH for a given amount of stETH.
+    /// @param stETHAmount The amount of stETH.
+    /// @return The equivalent amount of wstETH.
+    function getWstETHByStETH(uint256 stETHAmount) external view returns (uint256);
+
+    /*//////////////////////////////////////////////////////////////////////////
+                              STATE-CHANGING FUNCTIONS
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Wraps stETH to wstETH.
+    function wrap(uint256 stETHAmount) external returns (uint256 wstETHAmount);
+
+    /// @notice Unwraps wstETH to stETH.
+    function unwrap(uint256 wstETHAmount) external returns (uint256 stETHAmount);
+}

package/src/libraries/Errors.sol

@@ -0,0 +1,189 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import { UD60x18 } from "@prb/math/src/UD60x18.sol";
+import { Escrow } from "../types/Escrow.sol";
+
+/// @title Errors
+/// @notice Library containing all custom errors emitted by the Sablier Bob protocol.
+library Errors {
+    /*//////////////////////////////////////////////////////////////////////////
+                                  BOB VAULT SHARE
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Thrown when a function is called by an address other than SablierBob.
+    error BobVaultShare_OnlySablierBob(address caller, address expectedCaller);
+
+    /// @notice Thrown when the provided vault ID does not match the share token's vault ID.
+    error BobVaultShare_VaultIdMismatch(uint256 providedVaultId, uint256 expectedVaultId);
+
+    /*//////////////////////////////////////////////////////////////////////////
+                                    SABLIER BOB
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Thrown when `onShareTransfer` is called by an address other than the share token.
+    error SablierBob_CallerNotShareToken(uint256 vaultId, address caller);
+
+    /// @notice Thrown when depositing zero amount in a vault.
+    error SablierBob_DepositAmountZero(uint256 vaultId, address user);
+
+    /// @notice Thrown when trying to create a vault with an expiry timestamp not in the future.
+    error SablierBob_ExpiryNotInFuture(uint40 expiry, uint40 currentTime);
+
+    /// @notice Thrown when trying to create a vault with the native token.
+    error SablierBob_ForbidNativeToken(address nativeToken);
+
+    /// @notice Thrown when trying to redeem with `msg.value` less than the minimum fee required.
+    error SablierBob_InsufficientFeePayment(uint256 feePaid, uint256 feeRequired);
+
+    /// @notice Thrown when trying to pay a fee in the native token from a vault that uses the adapter.
+    error SablierBob_MsgValueNotZero(uint256 vaultId);
+
+    /// @notice Thrown when the native token fee transfer to the comptroller fails.
+    error SablierBob_NativeFeeTransferFailed();
+
+    /// @notice Thrown when trying to set the native token address when it is already set.
+    error SablierBob_NativeTokenAlreadySet(address nativeToken);
+
+    /// @notice Thrown when trying to set zero address as native token.
+    error SablierBob_NativeTokenZeroAddress();
+
+    /// @notice Thrown when the new adapter does not implement the required interface.
+    error SablierBob_NewAdapterMissesInterface(address adapter);
+
+    /// @notice Thrown when trying to exit or redeem with zero share balance.
+    error SablierBob_NoSharesToRedeem(uint256 vaultId, address user);
+
+    /// @notice Thrown when trying to create a vault with a zero target price.
+    error SablierBob_TargetPriceZero();
+
+    /// @notice Thrown when trying to create a vault with a target price that is not greater than the latest price
+    /// returned by the oracle.
+    error SablierBob_TargetPriceTooLow(uint128 targetPrice, uint128 currentPrice);
+
+    /// @notice Thrown when trying to create a vault with a zero token address.
+    error SablierBob_TokenAddressZero();
+
+    /// @notice Thrown when trying to unstake vault tokens using the adapter but the amount staked is zero.
+    error SablierBob_UnstakeAmountZero(uint256 vaultId);
+
+    /// @notice Thrown when trying to unstake vault tokens using the adapter but the vault has already been unstaked.
+    error SablierBob_VaultAlreadyUnstaked(uint256 vaultId);
+
+    /// @notice Thrown when trying to unstake from a vault that has no adapter configured.
+    error SablierBob_VaultHasNoAdapter(uint256 vaultId);
+
+    /// @notice Thrown when trying to perform an unauthorized action on a non-active vault.
+    error SablierBob_VaultNotActive(uint256 vaultId);
+
+    /// @notice Thrown when trying to perform an unauthorized action on an active vault.
+    error SablierBob_VaultStillActive(uint256 vaultId);
+
+    /*//////////////////////////////////////////////////////////////////////////
+                                 SABLIER BOB STATE
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Thrown when trying to interact with a non-existent vault.
+    error SablierBobState_Null(uint256 vaultId);
+
+    /*//////////////////////////////////////////////////////////////////////////
+                                   SABLIER ESCROW
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Thrown when trying to create an order with a zero address for the buy token.
+    error SablierEscrow_BuyTokenZero();
+
+    /// @notice Thrown when the caller is not authorized to perform an action on an order.
+    error SablierEscrow_CallerNotAuthorized(uint256 orderId, address caller, address expectedCaller);
+
+    /// @notice Thrown when trying to create an order with an expiration timestamp in the past.
+    error SablierEscrow_ExpiryTimeInPast(uint40 expiryTime, uint40 currentTime);
+
+    /// @notice Thrown when trying to create an order with the native token.
+    error SablierEscrow_ForbidNativeToken(address nativeToken);
+
+    /// @notice Thrown when trying to accept an order with a buy amount that is below the minimum amount required.
+    error SablierEscrow_InsufficientBuyAmount(uint128 buyAmount, uint128 minBuyAmount);
+
+    /// @notice Thrown when trying to create an order with a zero buy amount.
+    error SablierEscrow_MinBuyAmountZero();
+
+    /// @notice Thrown when trying to set the native token address when it is already set.
+    error SablierEscrow_NativeTokenAlreadySet(address nativeToken);
+
+    /// @notice Thrown when trying to set zero address as native token.
+    error SablierEscrow_NativeTokenZeroAddress();
+
+    /// @notice Thrown when trying to cancel an order that has already been canceled.
+    error SablierEscrow_OrderCancelled(uint256 orderId);
+
+    /// @notice Thrown when trying to cancel an order that has already been filled.
+    error SablierEscrow_OrderFilled(uint256 orderId);
+
+    /// @notice Thrown when trying to fill an order that has either been completed or canceled.
+    error SablierEscrow_OrderNotOpen(uint256 orderId, Escrow.Status status);
+
+    /// @notice Thrown when trying to create an order with the same sell and buy tokens.
+    error SablierEscrow_SameToken(IERC20 token);
+
+    /// @notice Thrown when trying to create an order with a zero sell amount.
+    error SablierEscrow_SellAmountZero();
+
+    /// @notice Thrown when trying to create an order with a zero address for the sell token.
+    error SablierEscrow_SellTokenZero();
+
+    /*//////////////////////////////////////////////////////////////////////////
+                                SABLIER ESCROW STATE
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Thrown when trying to set a trade fee that exceeds the maximum allowed.
+    error SablierEscrowState_NewTradeFeeTooHigh(UD60x18 newTradeFee, UD60x18 maxTradeFee);
+
+    /// @notice Thrown when trying to interact with a non-existent order.
+    error SablierEscrowState_Null(uint256 orderId);
+
+    /*//////////////////////////////////////////////////////////////////////////
+                                SABLIER LIDO ADAPTER
+    //////////////////////////////////////////////////////////////////////////*/
+
+    /// @notice Thrown when trying to request a Lido withdrawal for a vault that has already requested one.
+    error SablierLidoAdapter_LidoWithdrawalAlreadyRequested(uint256 vaultId);
+
+    /// @notice Thrown when trying to request a Lido withdrawal for a vault with no wstETH.
+    error SablierLidoAdapter_NoWstETHToWithdraw(uint256 vaultId);
+
+    /// @notice Thrown when a function is called by an address other than SablierBob.
+    error SablierLidoAdapter_OnlySablierBob(address caller, address expectedCaller);
+
+    /// @notice Thrown when the stETH/ETH oracle returns a zero price.
+    error SablierLidoAdapter_OraclePriceZero();
+
+    /// @notice Thrown when the Curve swap output is below the minimum acceptable amount.
+    error SablierLidoAdapter_SlippageExceeded(uint256 expected, uint256 actual);
+
+    /// @notice Thrown when trying to set a slippage that exceeds the maximum allowed.
+    error SablierLidoAdapter_SlippageToleranceTooHigh(UD60x18 tolerance, UD60x18 maxTolerance);
+
+    /// @notice Thrown when trying to update staked token balance but the user's balance is zero.
+    error SablierLidoAdapter_UserBalanceZero(uint256 vaultId, address user);
+
+    /// @notice Thrown when trying to request a Lido withdrawal for a vault that is active.
+    error SablierLidoAdapter_VaultActive(uint256 vaultId);
+
+    /// @notice Thrown when trying to request a Lido withdrawal for a vault that has already been unstaked.
+    error SablierLidoAdapter_VaultAlreadyUnstaked(uint256 vaultId);
+
+    /// @notice Thrown when the calculated wstETH transfer amount rounds down to zero due to floor division.
+    error SablierLidoAdapter_WstETHTransferAmountZero(uint256 vaultId, address from, address to);
+
+    /// @notice Thrown when the total amount to withdraw is below the minimum amount per request.
+    error SablierLidoAdapter_WithdrawalAmountBelowMinimum(
+        uint256 vaultId,
+        uint256 totalAmount,
+        uint256 minimumAmountPerRequest
+    );
+
+    /// @notice Thrown when trying to set a yield fee that exceeds the maximum allowed.
+    error SablierLidoAdapter_YieldFeeTooHigh(UD60x18 fee, UD60x18 maxFee);
+}

package/src/types/Bob.sol

@@ -0,0 +1,49 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22;
+
+import { AggregatorV3Interface } from "@chainlink/contracts/src/v0.8/shared/interfaces/AggregatorV3Interface.sol";
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+import { IBobVaultShare } from "../interfaces/IBobVaultShare.sol";
+import { ISablierBobAdapter } from "../interfaces/ISablierBobAdapter.sol";
+
+/// @notice Namespace for the structs and enums used in the Sablier Bob protocol.
+library Bob {
+    /// @notice Enum representing the different statuses of a vault.
+    /// @custom:value0 ACTIVE Vault is open for deposits.
+    /// @custom:value1 EXPIRED Vault has end time less than or equal to current timestamp.
+    /// @custom:value2 SETTLED Vault has target price less than or equal to last synced price.
+    enum Status {
+        ACTIVE,
+        EXPIRED,
+        SETTLED
+    }
+
+    /// @notice Struct encapsulating all the configuration and state of a vault.
+    /// @dev The fields are arranged for gas optimization via tight variable packing.
+    /// @param token The ERC-20 token accepted for deposits in this vault.
+    /// @param expiry The Unix timestamp when the vault expires.
+    /// @param lastSyncedAt The Unix timestamp when the oracle price was last synced.
+    /// @param shareToken The address of ERC-20 token representing shares in this vault.
+    /// @param oracle The address of the price oracle for the deposit token, provided by the vault creator.
+    /// @param adapter The adapter set for this vault, can be used to take action on the deposit token.
+    /// @param isStakedInAdapter Whether the deposit token is staked with the adapter or not.
+    /// @param targetPrice The target price at which the vault settles, denoted in 8 decimals where 1e8 is $1.
+    /// @param lastSyncedPrice The most recent price fetched from the oracle, denoted in 8 decimals where 1e8 is $1.
+    struct Vault {
+        // slot 0
+        IERC20 token;
+        uint40 expiry;
+        uint40 lastSyncedAt;
+        // slot 1
+        IBobVaultShare shareToken;
+        // slot 2
+        AggregatorV3Interface oracle;
+        // slot 3
+        ISablierBobAdapter adapter;
+        bool isStakedInAdapter;
+        // slot 4
+        uint128 targetPrice;
+        uint128 lastSyncedPrice;
+    }
+}

package/src/types/Escrow.sol

@@ -0,0 +1,49 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity >=0.8.22;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+/// @notice Namespace for the structs and enums used in the Sablier Escrow protocol.
+library Escrow {
+    /// @notice Enum representing the different statuses of an order.
+    /// @dev The status is derived at runtime from boolean flags and timestamps, not stored directly.
+    /// @custom:value0 CANCELLED Order has been cancelled by the seller.
+    /// @custom:value1 EXPIRED Order has expired without being filled.
+    /// @custom:value2 FILLED Order has been successfully filled.
+    /// @custom:value3 OPEN Order is open and can be filled or cancelled.
+    enum Status {
+        CANCELLED,
+        EXPIRED,
+        FILLED,
+        OPEN
+    }
+
+    /// @notice Struct encapsulating all the configuration and state of an order.
+    /// @dev The fields are arranged for gas optimization via tight variable packing.
+    /// @param seller The address that created the order and deposited the sell token.
+    /// @param buyer The designated counterparty address specified by the seller. If its zero address, the order can be
+    /// filled by anyone.
+    /// @param sellToken The ERC-20 token being sold, deposited by the seller when the order is created.
+    /// @param buyToken The ERC-20 token the seller wants to receive.
+    /// @param sellAmount The amount of sell token that the seller is willing to exchange.
+    /// @param minBuyAmount The minimum amount of buy token required to fill the order.
+    /// @param expiryTime The Unix timestamp when the order expires. Zero is sentinel for orders that never expire.
+    /// @param wasCanceled Boolean indicating if the order was canceled.
+    /// @param wasFilled Boolean indicating if the order was filled.
+    struct Order {
+        // slot 0
+        address seller;
+        uint40 expiryTime;
+        bool wasCanceled;
+        bool wasFilled;
+        // slot 1
+        address buyer;
+        // slot 2
+        IERC20 sellToken;
+        // slot 3
+        IERC20 buyToken;
+        // slot 4
+        uint128 sellAmount;
+        uint128 minBuyAmount;
+    }
+}