Address Contract Verified
Address
0x06683D1Fbbcda32D8Ccb8372884471A8265e5998
Balance
0 ETH
Nonce
1
Code Size
3228 bytes
Creator
0x205a73F1...F65D at tx 0xf3471dc5...861554
Indexed Transactions
0
Contract Bytecode
3228 bytes
0x608060405234801561001057600080fd5b506004361061008e5760003560e01c8063206f248d14610093578063253f3ffb146100a857806333827438146100bb5780636edf9831146100e4578063715018a6146100f75780638da5cb5b146100ff57806392837566146101075780639fe6ddc61461011a578063e87a8bcd1461012d578063f2fde38b14610140575b600080fd5b6100a66100a1366004610764565b610153565b005b6100a66100b63660046107e8565b61017d565b6001546100ce906001600160a01b031681565b6040516100db919061083b565b60405180910390f35b6100a66100f2366004610764565b61023b565b6100a66102a8565b6100ce6102bc565b6100a661011536600461084f565b6102cb565b6100a66101283660046108e8565b610347565b6100a661013b366004610929565b610526565b6100a661014e366004610764565b610686565b61015b6106cd565b600180546001600160a01b0319166001600160a01b0392909216919091179055565b6101856106cd565b60005b82811015610235576001546001600160a01b031663d5de83a28585848181106101b3576101b361099d565b90506020020160208101906101c891906109ca565b6040516001600160e01b031960e084901b1681526001600160401b0390911660048201528415156024820152604401600060405180830381600087803b15801561021157600080fd5b505af1158015610225573d6000803e3d6000fd5b5050600190920191506101889050565b50505050565b6102436106cd565b60015460405163f2fde38b60e01b81526001600160a01b039091169063f2fde38b9061027390849060040161083b565b600060405180830381600087803b15801561028d57600080fd5b505af11580156102a1573d6000803e3d6000fd5b5050505050565b6102b06106cd565b6102ba60006106ff565b565b6000546001600160a01b031690565b6102d36106cd565b60015460405163564343cd60e01b81526001600160a01b039091169063564343cd9061030d90899089908990899089908990600401610af9565b600060405180830381600087803b15801561032757600080fd5b505af115801561033b573d6000803e3d6000fd5b50505050505050505050565b61034f6106cd565b60005b81811015610521576001546001600160a01b031663407705be84848481811061037d5761037d61099d565b905060200281019061038f9190610bb6565b61039d906020810190610764565b8585858181106103af576103af61099d565b90506020028101906103c19190610bb6565b602001358686868181106103d7576103d761099d565b90506020028101906103e99190610bb6565b604001358787878181106103ff576103ff61099d565b90506020028101906104119190610bb6565b606001358888888181106104275761042761099d565b90506020028101906104399190610bb6565b6080013589898981811061044f5761044f61099d565b90506020028101906104619190610bb6565b60a001358a8a8a8181106104775761047761099d565b90506020028101906104899190610bb6565b60c001358b8b8b81811061049f5761049f61099d565b90506020028101906104b19190610bb6565b6104bf9060e0810190610bd6565b6040518a63ffffffff1660e01b81526004016104e399989796959493929190610c1f565b600060405180830381600087803b1580156104fd57600080fd5b505af1158015610511573d6000803e3d6000fd5b5050600190920191506103529050565b505050565b61052e6106cd565b60005b81811015610521576001546001600160a01b031663292562d884848481811061055c5761055c61099d565b61057292602060c09092020190810191506109ca565b8585858181106105845761058461099d565b905060c00201602001358686868181106105a0576105a061099d565b905060c00201604001358787878181106105bc576105bc61099d565b905060c00201606001358888888181106105d8576105d861099d565b905060c00201608001358989898181106105f4576105f461099d565b6040516001600160e01b031960e08b901b1681526001600160401b03909816600489015260248801969096525060448601939093526064850191909152608484015260a060c090920201013560a482015260c401600060405180830381600087803b15801561066257600080fd5b505af1158015610676573d6000803e3d6000fd5b5050600190920191506105319050565b61068e6106cd565b6001600160a01b0381166106c1576000604051631e4fbdf760e01b81526004016106b8919061083b565b60405180910390fd5b6106ca816106ff565b50565b336106d66102bc565b6001600160a01b0316146102ba573360405163118cdaa760e01b81526004016106b8919061083b565b600080546001600160a01b038381166001600160a01b0319831681178455604051919092169283917f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09190a35050565b6001600160a01b03811681146106ca57600080fd5b60006020828403121561077657600080fd5b81356107818161074f565b9392505050565b60008083601f84011261079a57600080fd5b5081356001600160401b038111156107b157600080fd5b6020830191508360208260051b85010111156107cc57600080fd5b9250929050565b803580151581146107e357600080fd5b919050565b6000806000604084860312156107fd57600080fd5b83356001600160401b0381111561081357600080fd5b61081f86828701610788565b90945092506108329050602085016107d3565b90509250925092565b6001600160a01b0391909116815260200190565b6000806000806000806060878903121561086857600080fd5b86356001600160401b038082111561087f57600080fd5b61088b8a838b01610788565b909850965060208901359150808211156108a457600080fd5b6108b08a838b01610788565b909650945060408901359150808211156108c957600080fd5b506108d689828a01610788565b979a9699509497509295939492505050565b600080602083850312156108fb57600080fd5b82356001600160401b0381111561091157600080fd5b61091d85828601610788565b90969095509350505050565b6000806020838503121561093c57600080fd5b82356001600160401b038082111561095357600080fd5b818501915085601f83011261096757600080fd5b81358181111561097657600080fd5b86602060c08302850101111561098b57600080fd5b60209290920196919550909350505050565b634e487b7160e01b600052603260045260246000fd5b80356001600160401b03811681146107e357600080fd5b6000602082840312156109dc57600080fd5b610781826109b3565b8183526000602080850194508260005b85811015610a21576001600160401b03610a0e836109b3565b16875295820195908201906001016109f5565b509495945050505050565b6000808335601e19843603018112610a4357600080fd5b83016020810192503590506001600160401b03811115610a6257600080fd5b8060051b36038213156107cc57600080fd5b60008383855260208086019550808560051b830101846000805b88811015610aeb57858403601f19018a52610aa98389610a2c565b808652868601845b82811015610ad657610ac2846107d3565b151582529288019290880190600101610ab1565b509b87019b9550505091840191600101610a8e565b509198975050505050505050565b606081526000610b0d60608301888a6109e5565b602083820381850152818783528183019050818860051b840101896000805b8b811015610b9057868403601f19018552610b47838e610a2c565b808652878601845b82811015610b7b576001600160401b03610b68856109b3565b1682529289019290890190600101610b4f565b50968801969550505091850191600101610b2c565b5050508581036040870152610ba681888a610a74565b9c9b505050505050505050505050565b6000823560fe19833603018112610bcc57600080fd5b9190910192915050565b6000808335601e19843603018112610bed57600080fd5b8301803591506001600160401b03821115610c0757600080fd5b6020019150600581901b36038213156107cc57600080fd5b600061010060018060a01b038c1683528a60208401528960408401528860608401528760808401528660a08401528560c08401528060e0840152610ba681840185876109e556fea26469706673582212208d9b6b6467314a48c271dbe5424b8fae1ed9929fae3f283a4704cb606d1c4f8264736f6c63430008190033
Verified Source Code Full Match
Compiler: v0.8.25+commit.b61c2a91
EVM: paris
Optimization: Yes (1 runs)
Ownable.sol 100 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
constructor(address initialOwner) {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
IERC1363.sol 86 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC1363.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}
IERC165.sol 6 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../utils/introspection/IERC165.sol";
IERC20.sol 6 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../token/ERC20/IERC20.sol";
IERC20.sol 79 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}
SafeERC20.sol 199 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
import {Address} from "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
/**
* @dev An operation with an ERC-20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
// bubble errors
if iszero(success) {
let ptr := mload(0x40)
returndatacopy(ptr, 0, returndatasize())
revert(ptr, returndatasize())
}
returnSize := returndatasize()
returnValue := mload(0)
}
if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silently catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
bool success;
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
returnSize := returndatasize()
returnValue := mload(0)
}
return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
}
}
Address.sol 150 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Address.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
if (address(this).balance < amount) {
revert Errors.InsufficientBalance(address(this).balance, amount);
}
(bool success, ) = recipient.call{value: amount}("");
if (!success) {
revert Errors.FailedCall();
}
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason or custom error, it is bubbled
* up by this function (like regular Solidity function calls). However, if
* the call reverted with no returned reason, this function reverts with a
* {Errors.FailedCall} error.
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
if (address(this).balance < value) {
revert Errors.InsufficientBalance(address(this).balance, value);
}
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
* was not a contract or bubbling up the revert reason (falling back to {Errors.FailedCall}) in case
* of an unsuccessful call.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
// only check if target is a contract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
if (returndata.length == 0 && target.code.length == 0) {
revert AddressEmptyCode(target);
}
return returndata;
}
}
/**
* @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
* revert reason or with a default {Errors.FailedCall} error.
*/
function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {Errors.FailedCall}.
*/
function _revert(bytes memory returndata) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly ("memory-safe") {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert Errors.FailedCall();
}
}
}
Context.sol 28 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}
Errors.sol 34 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Errors.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of common custom errors used in multiple contracts
*
* IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
* It is recommended to avoid relying on the error API for critical functionality.
*
* _Available since v5.1._
*/
library Errors {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedCall();
/**
* @dev The deployment failed.
*/
error FailedDeployment();
/**
* @dev A necessary precompile is missing.
*/
error MissingPrecompile(address);
}
IERC165.sol 25 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
IEcclesiaDao.sol 10 lines
// SPDX-License-Identifier: MIT
pragma solidity 0.8.25;
interface IEcclesiaDao {
function accrueRevenue(
address _token,
uint256 _amount,
uint256 leverageFee_
) external;
}
ILiquidityManager.sol 231 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.25;
// Libraries
import { VirtualPool } from "../libs/VirtualPool.sol";
import { PoolMath } from "../libs/PoolMath.sol";
import { DataTypes } from "../libs/DataTypes.sol";
// Interfaces
import { IEcclesiaDao } from "../interfaces/IEcclesiaDao.sol";
import { IStrategyManager } from "../interfaces/IStrategyManager.sol";
interface ILiquidityManager {
// ======= STRUCTS ======= //
struct CoverRead {
uint256 coverId;
uint64 poolId;
uint256 coverAmount;
bool isActive;
uint256 premiumsLeft;
uint256 dailyCost;
uint256 premiumRate;
uint32 lastTick; // Last last tick for which the cover is active
}
struct PositionRead {
uint256 positionId;
uint256 supplied;
uint256 suppliedWrapped;
uint256 commitWithdrawalTimestamp;
uint256 strategyRewardIndex;
uint64[] poolIds;
uint256 newUserCapital;
uint256 newUserCapitalWrapped;
uint256[] coverRewards;
uint256 strategyRewards;
}
struct Position {
uint256 supplied;
uint256 commitWithdrawalTimestamp;
uint256 strategyRewardIndex;
uint64[] poolIds;
}
struct PoolOverlap {
uint64 poolId;
uint256 amount;
}
struct VPoolRead {
uint64 poolId;
uint256 feeRate; // amount of fees on premiums in RAY
uint256 leverageFeePerPool; // amount of fees per pool when using leverage
IEcclesiaDao dao;
IStrategyManager strategyManager;
PoolMath.Formula formula;
DataTypes.Slot0 slot0;
uint256 strategyId;
uint256 strategyRewardRate;
address paymentAsset; // asset used to pay LP premiums
address underlyingAsset; // asset required by the strategy
address wrappedAsset; // tokenised strategy shares (ex: aTokens)
bool isPaused;
uint64[] overlappedPools;
uint256 ongoingClaims;
uint256[] compensationIds;
uint256[] overlappedCapital;
uint256 utilizationRate;
uint256 totalLiquidity;
uint256 availableLiquidity;
uint256 strategyRewardIndex;
uint256 lastOnchainUpdateTimestamp;
uint256 premiumRate;
// The amount of liquidity index that is in the current unfinished tick
uint256 liquidityIndexLead;
}
// ======= FUNCTIONS ======= //
// View Functions
function strategyManager() external view returns (IStrategyManager);
function coverToPool(
uint256 coverId
) external view returns (uint64);
function positions(
uint256 tokenId
) external view returns (Position memory);
function positionInfo(
uint256 positionId
) external view returns (PositionRead memory);
function positionInfos(
uint256[] calldata positionIds
) external view returns (PositionRead[] memory);
function coverInfo(
uint256 coverId
) external view returns (CoverRead memory);
function coverInfos(
uint256[] calldata coverIds
) external view returns (CoverRead[] memory);
function poolInfo(
uint64 poolId
) external view returns (VPoolRead memory);
function poolInfos(
uint256[] calldata poolIds
) external view returns (VPoolRead[] memory);
function isCoverActive(
uint256 coverId
) external view returns (bool);
function poolOverlaps(
uint64 poolIdA,
uint64 poolIdB
) external view returns (uint256);
// Position Management
function openPosition(
uint256 amount,
bool isWrapped,
uint64[] calldata poolIds
) external;
function addLiquidity(
uint256 positionId,
uint256 amount,
bool isWrapped
) external;
function takeInterests(uint256 positionId) external;
function commitRemoveLiquidity(uint256 positionId) external;
function uncommitRemoveLiquidity(uint256 positionId) external;
function removeLiquidity(
uint256 positionId,
uint256 amount,
bool keepWrapped
) external;
// Cover Management
function openCover(
uint64 poolId,
uint256 coverAmount,
uint256 premiums
) external;
function updateCover(
uint256 coverId,
uint256 coverToAdd,
uint256 coverToRemove,
uint256 premiumsToAdd,
uint256 premiumsToRemove
) external;
// External Contract Functions
function addClaimToPool(uint256 coverId_) external;
function removeClaimFromPool(uint256 coverId_) external;
function payoutClaim(
uint256 coverId_,
uint256 compensationAmount_
) external;
function takeInterestsWithYieldBonus(
address account_,
uint256 yieldBonus_,
uint256[] calldata positionIds_
) external;
// Admin Functions
function createPool(
address paymentAsset_,
uint256 strategyId_,
uint256 feeRate_,
uint256 uOptimal_,
uint256 r0_,
uint256 rSlope1_,
uint256 rSlope2_,
uint64[] calldata compatiblePools_
) external;
function pausePool(uint64 poolId, bool isPaused) external;
function freezeProtocol(bool isFrozen) external;
function updatePoolCompatibility(
uint64[] calldata poolIds,
uint64[][] calldata poolIdCompatible,
bool[][] calldata poolIdCompatibleStatus
) external;
function updatePoolConfig(
uint64 poolId,
uint256 feeRate,
uint256 uOptimal,
uint256 r0,
uint256 rSlope1,
uint256 rSlope2
) external;
function updateConfig(
IEcclesiaDao ecclesiaDao,
IStrategyManager strategyManager,
address claimManager,
address yieldRewarder,
uint256 withdrawDelay,
uint256 maxLeverage,
uint256 leverageFeePerPool
) external;
function purgeExpiredCoversUpTo(
uint64 poolId,
uint256 timestamp
) external;
function updatePositionUpTo(
uint256 positionId,
uint256[] calldata endCompensationIndexes
) external;
}
IOwnable.sol 10 lines
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.25;
interface IOwnable {
function owner() external view returns (address);
function transferOwnership(address newOwner) external;
function renounceOwnership() external;
}
IStrategyManager.sol 65 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.25;
interface IStrategyManager {
function getRewardIndex(
uint256 strategyId
) external view returns (uint256);
function getRewardRate(
uint256 strategyId_
) external view returns (uint256);
function underlyingAsset(
uint256 strategyId_
) external view returns (address);
function assets(
uint256 strategyId_
) external view returns (address underlying, address wrapped);
function wrappedToUnderlying(
uint256 strategyId_,
uint256 amountWrapped_
) external view returns (uint256);
function depositToStrategy(
uint256 strategyId_,
uint256 amountUnderlying_
) external;
function withdrawFromStrategy(
uint256 strategyId_,
uint256 amountCapitalUnderlying_,
uint256 amountRewardsUnderlying_,
address account_,
uint256 /*yieldBonus_*/
) external;
function depositWrappedToStrategy(uint256 strategyId_) external;
function withdrawWrappedFromStrategy(
uint256 strategyId_,
uint256 amountCapitalUnderlying_,
uint256 amountRewardsUnderlying_,
address account_,
uint256 /*yieldBonus_*/
) external;
function payoutFromStrategy(
uint256 strategyId_,
uint256 amount,
address claimant
) external;
function computeReward(
uint256 strategyId_,
uint256 amount_,
uint256 startRewardIndex_,
uint256 endRewardIndex_
) external pure returns (uint256);
function itCompounds(
uint256 strategyId_
) external pure returns (bool);
}
BitMath.sol 56 lines
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity 0.8.25;
/// @title BitMath
/// @dev This library provides functionality for computing bit properties of an unsigned integer
library BitMath {
/// @notice Returns the index of the least significant bit of the number,
/// where the least significant bit is at index 0 and the most significant bit is at index 255
/// @dev The function satisfies the property:
/// (x & 2**leastSignificantBit(x)) != 0 and (x & (2**(leastSignificantBit(x)) - 1)) == 0)
/// @param x the value for which to compute the least significant bit, must be greater than 0
/// @return r the index of the least significant bit
function leastSignificantBit(
uint256 x
) internal pure returns (uint8 r) {
require(x > 0);
r = 255;
if (x & type(uint128).max > 0) {
r -= 128;
} else {
x >>= 128;
}
if (x & type(uint64).max > 0) {
r -= 64;
} else {
x >>= 64;
}
if (x & type(uint32).max > 0) {
r -= 32;
} else {
x >>= 32;
}
if (x & type(uint16).max > 0) {
r -= 16;
} else {
x >>= 16;
}
if (x & type(uint8).max > 0) {
r -= 8;
} else {
x >>= 8;
}
if (x & 0xf > 0) {
r -= 4;
} else {
x >>= 4;
}
if (x & 0x3 > 0) {
r -= 2;
} else {
x >>= 2;
}
if (x & 0x1 > 0) r -= 1;
}
}
DataTypes.sol 97 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.25;
// Libraries
import { RayMath } from "../libs/RayMath.sol";
import { TickBitmap } from "../libs/TickBitmap.sol";
import { PoolMath } from "../libs/PoolMath.sol";
// Interfaces
import { IEcclesiaDao } from "../interfaces/IEcclesiaDao.sol";
import { IStrategyManager } from "../interfaces/IStrategyManager.sol";
library DataTypes {
struct Slot0 {
// The last tick at which the pool's liquidity was updated
uint32 tick;
// The distance in seconds between ticks
uint256 secondsPerTick;
uint256 coveredCapital;
/**
* The last timestamp at which the current tick changed
* This value indicates the start of the current stored tick
*/
uint256 lastUpdateTimestamp;
// The index tracking how much premiums have been consumed in favor of LP
uint256 liquidityIndex;
}
struct LpInfo {
uint256 beginLiquidityIndex;
uint256 beginClaimIndex;
}
struct Cover {
uint256 coverAmount;
uint256 beginPremiumRate;
/**
* If cover is active: last last tick for which the cover is valid
* If cover is expired: slot0 tick at which the cover was expired minus 1
*/
uint32 lastTick;
}
struct Compensation {
uint64 fromPoolId;
// The ratio is the claimed amount/ total liquidity in the claim pool
uint256 ratio;
uint256 strategyRewardIndexBeforeClaim;
mapping(uint64 _poolId => uint256 _amount) liquidityIndexBeforeClaim;
}
struct VPool {
uint64 poolId;
uint256 feeRate; // amount of fees on premiums in RAY
uint256 leverageFeePerPool; // amount of fees per pool when using leverage
IEcclesiaDao dao;
IStrategyManager strategyManager;
PoolMath.Formula formula;
Slot0 slot0;
uint256 strategyId;
address paymentAsset; // asset used to pay LP premiums
address underlyingAsset; // asset covered & used by the strategy
address wrappedAsset; // tokenised strategy shares (ex: aTokens)
bool isPaused;
uint64[] overlappedPools;
uint256 ongoingClaims;
uint256[] compensationIds;
/**
* Maps poolId 0 -> poolId 1 -> overlapping capital
*
* @dev poolId 0 -> poolId 0 points to a pool's own liquidity
* @dev liquidity overlap is always registered in the lower poolId
*/
mapping(uint64 _poolId => uint256 _amount) overlaps;
mapping(uint256 _positionId => LpInfo) lpInfos;
// Maps an word position index to a bitmap of tick states (initialized or not)
mapping(uint24 _wordPos => uint256 _bitmap) tickBitmap;
// Maps a tick to the amount of cover that expires after that tick ends
mapping(uint32 _tick => uint256 _coverAmount) ticks;
// Maps a cover ID to the premium position of the cover
mapping(uint256 _coverId => Cover) covers;
}
struct VPoolConstructorParams {
uint64 poolId;
IEcclesiaDao dao;
IStrategyManager strategyManager;
uint256 strategyId;
address paymentAsset;
uint256 feeRate; //Ray
uint256 leverageFeePerPool; //Ray
uint256 uOptimal; //Ray
uint256 r0; //Ray
uint256 rSlope1; //Ray
uint256 rSlope2; //Ray
}
}
IsContract.sol 27 lines
// SPDX-License-Identifier: MIT
pragma solidity 0.8.25;
library IsContract {
/**
* @notice Checks if address is a contract
* @param address_ address to check
* @return true if address is a contract
*
* @dev This function will return false if the address is:
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* All this is considered acceptable for the intended use cases.
*
*/
function _isContract(
address address_
) internal view returns (bool) {
uint32 size;
assembly {
size := extcodesize(address_)
}
return (size > 0);
}
}
PoolMath.sol 225 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.25;
// Libraries
import { RayMath } from "../libs/RayMath.sol";
// @bw move back into vpool ?
library PoolMath {
using RayMath for uint256;
// ======= CONSTANTS ======= //
uint256 constant YEAR = 365 days;
uint256 constant RAY = RayMath.RAY;
uint256 constant MAX_SECONDS_PER_TICK = 1 days;
uint256 constant FEE_BASE = RAY;
uint256 constant PERCENTAGE_BASE = 100;
uint256 constant FULL_CAPACITY = PERCENTAGE_BASE * RAY;
// ======= STRUCTURES ======= //
struct Formula {
uint256 uOptimal;
uint256 r0;
uint256 rSlope1;
uint256 rSlope2;
}
// ======= FUNCTIONS ======= //
/**
* @notice Computes the premium rate of a cover,
* the premium rate is the APR cost for a cover ,
* these are paid by cover buyer on their cover amount.
*
* @param formula The formula of the pool
* @param utilizationRate_ The utilization rate of the pool
*
* @return The premium rate of the cover expressed in rays
*
* @dev Not pure since reads self but pure for all practical purposes
*/
function getPremiumRate(
Formula calldata formula,
uint256 utilizationRate_
) public pure returns (uint256 /* premiumRate */) {
if (utilizationRate_ < formula.uOptimal) {
// Return base rate + proportional slope 1 rate
return
formula.r0 +
formula.rSlope1.rayMul(
utilizationRate_.rayDiv(formula.uOptimal)
);
} else if (utilizationRate_ < FULL_CAPACITY) {
// Return base rate + slope 1 rate + proportional slope 2 rate
return
formula.r0 +
formula.rSlope1 +
formula.rSlope2.rayMul(
(utilizationRate_ - formula.uOptimal).rayDiv(
FULL_CAPACITY - formula.uOptimal
)
);
} else {
// Return base rate + slope 1 rate + slope 2 rate
/**
* @dev Premium rate is capped because in case of overusage the
* liquidity providers are exposed to the same risk as 100% usage but
* cover buyers are not fully covered.
* This means cover buyers only pay for the effective cover they have.
*/
return formula.r0 + formula.rSlope1 + formula.rSlope2;
}
}
/**
* @notice Computes the liquidity index for a given period
* @param utilizationRate_ The utilization rate
* @param premiumRate_ The premium rate
* @param timeSeconds_ The time in seconds
* @return The liquidity index to add for the given time
*/
function computeLiquidityIndex(
uint256 utilizationRate_,
uint256 premiumRate_,
uint256 timeSeconds_
) public pure returns (uint /* liquidityIndex */) {
return
utilizationRate_
.rayMul(premiumRate_)
.rayMul(timeSeconds_)
.rayDiv(YEAR);
}
/**
* @notice Computes the premiums or interests earned by a liquidity position
* @param userCapital_ The amount of liquidity in the position
* @param endLiquidityIndex_ The end liquidity index
* @param startLiquidityIndex_ The start liquidity index
*/
function getCoverRewards(
uint256 userCapital_,
uint256 startLiquidityIndex_,
uint256 endLiquidityIndex_
) public pure returns (uint256) {
return
(userCapital_.rayMul(endLiquidityIndex_) -
userCapital_.rayMul(startLiquidityIndex_)) / 10_000;
}
/**
* @notice Computes the new daily cost of a cover,
* the emmission rate is the daily cost of a cover .
*
* @param oldDailyCost_ The daily cost of the cover before the change
* @param oldPremiumRate_ The premium rate of the cover before the change
* @param newPremiumRate_ The premium rate of the cover after the change
*
* @return The new daily cost of the cover expressed in tokens/day
*/
function getDailyCost(
uint256 oldDailyCost_,
uint256 oldPremiumRate_,
uint256 newPremiumRate_
) public pure returns (uint256) {
return (oldDailyCost_ * newPremiumRate_) / oldPremiumRate_;
}
/**
* @notice Computes the new seconds per tick of a pool,
* the seconds per tick is the time between two ticks .
*
* @param oldSecondsPerTick_ The seconds per tick before the change
* @param oldPremiumRate_ The premium rate before the change
* @param newPremiumRate_ The premium rate after the change
*
* @return The new seconds per tick of the pool
*/
function secondsPerTick(
uint256 oldSecondsPerTick_,
uint256 oldPremiumRate_,
uint256 newPremiumRate_
) public pure returns (uint256) {
return
oldSecondsPerTick_.rayMul(oldPremiumRate_).rayDiv(
newPremiumRate_
);
}
/**
* @notice Computes the updated premium rate of the pool based on utilization.
* @param formula The formula of the pool
* @param secondsPerTick_ The seconds per tick of the pool
* @param coveredCapital_ The amount of covered capital
* @param totalLiquidity_ The total amount liquidity
* @param newCoveredCapital_ The new amount of covered capital
* @param newTotalLiquidity_ The new total amount liquidity
*
* @return newPremiumRate The updated premium rate of the pool
* @return newSecondsPerTick The updated seconds per tick of the pool
*/
function updatePoolMarket(
Formula calldata formula,
uint256 secondsPerTick_,
uint256 totalLiquidity_,
uint256 coveredCapital_,
uint256 newTotalLiquidity_,
uint256 newCoveredCapital_
)
public
pure
returns (
uint256 newPremiumRate,
uint256 newSecondsPerTick,
uint256 newUtilizationRate
)
{
uint256 previousPremiumRate = getPremiumRate(
formula,
_utilization(coveredCapital_, totalLiquidity_)
);
newUtilizationRate = _utilization(
newCoveredCapital_,
newTotalLiquidity_
);
newPremiumRate = getPremiumRate(formula, newUtilizationRate);
newSecondsPerTick = secondsPerTick(
secondsPerTick_,
previousPremiumRate,
newPremiumRate
);
}
/**
* @notice Computes the percentage of the pool's liquidity used for covers.
* @param coveredCapital_ The amount of covered capital
* @param liquidity_ The total amount liquidity
*
* @return rate The utilization rate of the pool
*
* @dev The utilization rate is capped at 100%.
*/
function _utilization(
uint256 coveredCapital_,
uint256 liquidity_
) public pure returns (uint256 /* rate */) {
// If the pool has no liquidity then the utilization rate is 0
if (liquidity_ == 0) return 0;
/**
* @dev Utilization rate is capped at 100% because in case of overusage the
* liquidity providers are exposed to the same risk as 100% usage but
* cover buyers are not fully covered.
* This means cover buyers only pay for the effective cover they have.
*/
if (liquidity_ < coveredCapital_) return FULL_CAPACITY;
// Get a base PERCENTAGE_BASE percentage
return (coveredCapital_ * PERCENTAGE_BASE).rayDiv(liquidity_);
}
}
RayMath.sol 39 lines
// SPDX-License-Identifier: agpl-3.0
pragma solidity 0.8.25;
/**
* @title RayMath library
* @author Aave
* @dev Provides mul and div function for rays (decimals with 27 digits)
**/
library RayMath {
uint256 internal constant RAY = 1e27;
uint256 internal constant halfRAY = RAY / 2;
/**
* @dev Multiplies two ray, rounding half up to the nearest ray
* @param a Ray
* @param b Ray
* @return The result of a*b, in ray
**/
function rayMul(
uint256 a,
uint256 b
) internal pure returns (uint256) {
return (a * b + halfRAY) / RAY;
}
/**
* @dev Divides two ray, rounding half up to the nearest ray
* @param a Ray
* @param b Ray
* @return The result of a/b, in ray
**/
function rayDiv(
uint256 a,
uint256 b
) internal pure returns (uint256) {
return ((a * RAY) + (b / 2)) / b;
}
}
TickBitmap.sol 66 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.25;
// Libraries
import { BitMath } from "./BitMath.sol";
/// @title Packed tick initialized state library
/// @notice Stores a packed mapping of tick index to its initialized state
/// @dev The mapping uses int24 for keys since ticks are represented as int32 and there are 256 (2^8) values per word.
library TickBitmap {
/// @notice Computes the position in the mapping where the initialized bit for a tick lives
/// @param tick The tick for which to compute the position
/// @return wordPos The key in the mapping containing the word in which the bit is stored
/// @return bitPos The bit position in the word where the flag is stored
function position(
uint32 tick
) private pure returns (uint24 wordPos, uint8 bitPos) {
wordPos = uint24(tick >> 8);
bitPos = uint8(uint32(tick % 256));
}
/// @notice Flips the initialized state for a given tick from false to true, or vice versa
/// @param self The mapping in which to flip the tick
/// @param tick The tick to flip
function flipTick(
mapping(uint24 => uint256) storage self,
uint32 tick
) internal {
(uint24 wordPos, uint8 bitPos) = position(tick);
uint256 mask = 1 << bitPos;
self[wordPos] ^= mask;
}
function isInitializedTick(
mapping(uint24 => uint256) storage self,
uint32 tick
) internal view returns (bool) {
(uint24 wordPos, uint8 bitPos) = position(tick);
uint256 mask = 1 << bitPos;
return (self[wordPos] & mask) != 0;
}
/// @notice Returns the next initialized tick contained in the same word (or adjacent word)
/// as the tick that is to the left (greater than) of the given tick
/// @param self The mapping in which to compute the next initialized tick
/// @param tick The starting tick
function nextTick(
mapping(uint24 => uint256) storage self,
uint32 tick
) internal view returns (uint32 next, bool initialized) {
// start from the word of the next tick, since the current tick state doesn't matter
(uint24 wordPos, uint8 bitPos) = position(tick + 1);
// all the 1s at or to the left of the bitPos
uint256 mask = ~((1 << bitPos) - 1);
uint256 masked = self[wordPos] & mask;
// if there are no initialized ticks to the left of the current tick, return leftmost in the word
initialized = masked != 0;
// overflow/underflow is possible, but prevented externally by limiting tick
next = initialized
? (tick +
1 +
uint32(BitMath.leastSignificantBit(masked) - bitPos))
: (tick + 1 + uint32(type(uint8).max - bitPos));
}
}
VirtualPool.sol 1109 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.25;
// Libraries
import { RayMath } from "../libs/RayMath.sol";
import { TickBitmap } from "../libs/TickBitmap.sol";
import { PoolMath } from "../libs/PoolMath.sol";
import { DataTypes } from "../libs/DataTypes.sol";
import { IsContract } from "../libs/IsContract.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
// Interfaces
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { IEcclesiaDao } from "../interfaces/IEcclesiaDao.sol";
import { IStrategyManager } from "../interfaces/IStrategyManager.sol";
// ======= ERRORS ======= //
error ZeroAddressAsset();
error DurationBelowOneTick();
error DurationOverflow();
error InsufficientCapacity();
error NotEnoughLiquidityForRemoval();
/**
* @title Athena Virtual Pool
* @author vblackwhale
*
* This library provides the logic to create and manage virtual pools.
* The pool storage is located in the Liquidity Manager contract.
*
* Definitions:
*
* Ticks:
* They are a serie equidistant points in time who's distance from one another is variable.
* The initial tick spacing is its maximum possible value of 86400 seconds or 1 day.
* The distance between ticks will reduce as usage grows and increase when usage falls.
* The change in distance represents the speed at which cover premiums are spent given the pool's usage.
*
* Core pool metrics are computed with the following flow:
* Utilization Rate (ray %) -> Premium Rate (ray %) -> Daily Cost (token/day)
*/
library VirtualPool {
// ======= LIBS ======= //
using VirtualPool for DataTypes.VPool;
using RayMath for uint256;
using SafeERC20 for IERC20;
using TickBitmap for mapping(uint24 => uint256);
// ======= CONSTANTS ======= //
bytes32 private constant POOL_SLOT_HASH =
keccak256("diamond.storage.VPool");
bytes32 private constant COMPENSATION_SLOT_HASH =
keccak256("diamond.storage.Compensation");
uint256 constant YEAR = 365 days;
uint256 constant RAY = RayMath.RAY;
uint256 constant MAX_SECONDS_PER_TICK = 1 days;
uint256 constant FEE_BASE = RAY;
uint256 constant PERCENTAGE_BASE = 100;
uint256 constant HUNDRED_PERCENT = FEE_BASE * PERCENTAGE_BASE;
// ======= STRUCTS ======= //
struct CoverInfo {
uint256 premiumsLeft;
uint256 dailyCost;
uint256 premiumRate;
bool isActive;
}
struct UpdatePositionParams {
uint256 currentLiquidityIndex;
uint256 tokenId;
uint256 userCapital;
uint256 strategyRewardIndex;
uint256 latestStrategyRewardIndex;
uint256 strategyId;
bool itCompounds;
uint256 endCompensationIndex;
uint256 nbPools;
}
struct UpdatedPositionInfo {
uint256 newUserCapital;
uint256 coverRewards;
uint256 strategyRewards;
DataTypes.LpInfo newLpInfo;
}
// ======= STORAGE GETTERS ======= //
/**
* @notice Returns the storage slot position of a pool.
*
* @param poolId_ The pool ID
*
* @return pool The storage slot position of the pool
*/
function getPool(
uint64 poolId_
) internal pure returns (DataTypes.VPool storage pool) {
// Generate a random storage storage slot position based on the pool ID
bytes32 storagePosition = keccak256(
abi.encodePacked(POOL_SLOT_HASH, poolId_)
);
// Set the position of our struct in contract storage
assembly {
pool.slot := storagePosition
}
}
/**
* @notice Returns the storage slot position of a compensation.
*
* @param compensationId_ The compensation ID
*
* @return comp The storage slot position of the compensation
*
* @dev Enables VirtualPool library to access child compensation storage
*/
function getCompensation(
uint256 compensationId_
) internal pure returns (DataTypes.Compensation storage comp) {
// Generate a random storage storage slot position based on the compensation ID
bytes32 storagePosition = keccak256(
abi.encodePacked(COMPENSATION_SLOT_HASH, compensationId_)
);
// Set the position of our struct in contract storage
assembly {
comp.slot := storagePosition
}
}
// ======= VIRTUAL STORAGE INIT ======= //
/**
* @notice Initializes a virtual pool & populates its storage
*
* @param params The pool's constructor parameters
*/
function _vPoolConstructor(
DataTypes.VPoolConstructorParams memory params
) internal {
DataTypes.VPool storage pool = VirtualPool.getPool(params.poolId);
(address underlyingAsset, address wrappedAsset) = params
.strategyManager
.assets(params.strategyId);
if (
underlyingAsset == address(0) ||
params.paymentAsset == address(0)
) {
revert ZeroAddressAsset();
}
pool.poolId = params.poolId;
pool.dao = params.dao;
pool.strategyManager = params.strategyManager;
pool.paymentAsset = params.paymentAsset;
pool.strategyId = params.strategyId;
pool.underlyingAsset = underlyingAsset;
pool.wrappedAsset = wrappedAsset;
pool.feeRate = params.feeRate;
pool.leverageFeePerPool = params.leverageFeePerPool;
pool.formula = PoolMath.Formula({
uOptimal: params.uOptimal,
r0: params.r0,
rSlope1: params.rSlope1,
rSlope2: params.rSlope2
});
/// @dev the initial tick spacing is its maximum value 86400 seconds
pool.slot0.secondsPerTick = MAX_SECONDS_PER_TICK;
pool.slot0.lastUpdateTimestamp = block.timestamp;
/// @dev initialize at 1 to enable expiring covers created a first tick
pool.slot0.tick = 1;
pool.overlappedPools.push(params.poolId);
}
// ================================= //
// ======= LIQUIDITY METHODS ======= //
// ================================= //
/**
* @notice Returns the total liquidity of the pool.
*
* @param poolId_ The pool ID
*/
function totalLiquidity(
uint64 poolId_
) public view returns (uint256) {
return getPool(poolId_).overlaps[poolId_];
}
/**
* @notice Returns the available liquidity of the pool.
*
* @param poolId_ The pool ID
*/
function availableLiquidity(
uint64 poolId_
) public view returns (uint256) {
DataTypes.VPool storage self = getPool(poolId_);
/// @dev Since payout can lead to available capital underflow, we return 0
if (totalLiquidity(poolId_) <= self.slot0.coveredCapital)
return 0;
return totalLiquidity(poolId_) - self.slot0.coveredCapital;
}
/**
* @notice Computes an updated slot0 & liquidity index up to a timestamp.
* These changes are virtual an not reflected in storage in this function.
*
* @param poolId_ The pool ID
* @param timestamp_ The timestamp to update the slot0 & liquidity index to
*
* @return slot0 The updated slot0
*/
function _refreshSlot0(
uint64 poolId_,
uint256 timestamp_
) public view returns (DataTypes.Slot0 memory slot0) {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
// Make copy in memory to allow for mutations
slot0 = self.slot0;
// The remaining time in seconds to run through to sync up to the timestamp
uint256 remaining = timestamp_ - slot0.lastUpdateTimestamp;
// If the remaining time is less than the tick spacing then return the slot0
if (remaining < slot0.secondsPerTick) return slot0;
uint256 utilization = PoolMath._utilization(
slot0.coveredCapital,
totalLiquidity(self.poolId)
);
uint256 premiumRate = PoolMath.getPremiumRate(
self.formula,
utilization
);
// Default to ignore remaining time in case we do not enter loop
uint256 secondsSinceTickStart = remaining;
uint256 secondsParsed;
// @bw could opti here by searching for next initialized tick to compute the liquidity index with same premium & utilization in one go, parsing multiple 256 value bitmaps. This should exit when remaining < secondsToNextTickEnd before finishing with the partial tick operation.
while (slot0.secondsPerTick <= remaining) {
secondsSinceTickStart = 0;
// Search for the next tick, either last in bitmap or next initialized
(uint32 nextTick, bool isInitialized) = self
.tickBitmap
.nextTick(slot0.tick);
uint256 secondsToNextTickEnd = slot0.secondsPerTick *
(nextTick - slot0.tick);
if (secondsToNextTickEnd <= remaining) {
// Remove parsed tick size from remaining time to current timestamp
remaining -= secondsToNextTickEnd;
secondsParsed = secondsToNextTickEnd;
slot0.liquidityIndex += PoolMath.computeLiquidityIndex(
utilization,
premiumRate,
secondsParsed
);
// If the tick has covers then update pool metrics
if (isInitialized) {
(slot0, utilization, premiumRate) = self
._crossingInitializedTick(slot0, nextTick);
}
// Pool is now synched at the start of nextTick
slot0.tick = nextTick;
} else {
/**
* Time bewteen start of the new tick and the current timestamp
* This is ignored since this is not enough for a full tick to be processed
*/
secondsSinceTickStart = remaining % slot0.secondsPerTick;
// Ignore interests of current uncompleted tick
secondsParsed = remaining - secondsSinceTickStart;
// Number of complete ticks that we can take into account
slot0.tick += uint32(secondsParsed / slot0.secondsPerTick);
// Exit loop after the liquidity index update
remaining = 0;
slot0.liquidityIndex += PoolMath.computeLiquidityIndex(
utilization,
premiumRate,
secondsParsed
);
}
}
// Remove ignored duration so the update aligns with current tick start
slot0.lastUpdateTimestamp = timestamp_ - secondsSinceTickStart;
}
/**
* @notice Updates the pool's slot0 when the available liquidity changes.
*
* @param poolId_ The pool ID
* @param liquidityToAdd_ The amount of liquidity to add
* @param liquidityToRemove_ The amount of liquidity to remove
* @param skipLimitCheck_ Whether to skip the available liquidity check
*
* @dev The skipLimitCheck_ is used for deposits & payouts
*/
function _syncLiquidity(
uint64 poolId_,
uint256 liquidityToAdd_,
uint256 liquidityToRemove_,
bool skipLimitCheck_
) public {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
uint256 liquidity = totalLiquidity(self.poolId);
uint256 available = availableLiquidity(self.poolId);
// Skip liquidity check for deposits & payouts
if (!skipLimitCheck_)
if (available + liquidityToAdd_ < liquidityToRemove_)
revert NotEnoughLiquidityForRemoval();
// uint256 totalCovered = self.slot0.coveredCapital;
uint256 newTotalLiquidity = (liquidity + liquidityToAdd_) -
liquidityToRemove_;
(, self.slot0.secondsPerTick, ) = PoolMath.updatePoolMarket(
self.formula,
self.slot0.secondsPerTick,
liquidity,
self.slot0.coveredCapital,
newTotalLiquidity,
self.slot0.coveredCapital
);
}
// =================================== //
// ======= COVERS & LP METHODS ======= //
// =================================== //
// ======= LIQUIDITY POSITIONS ======= //
/**
* @notice Adds liquidity info to the pool and updates the pool's state.
*
* @param poolId_ The pool ID
* @param tokenId_ The LP position token ID
* @param amount_ The amount of liquidity to deposit
*/
function _depositToPool(
uint64 poolId_,
uint256 tokenId_,
uint256 amount_
) external {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
// Skip liquidity check for deposits
_syncLiquidity(poolId_, amount_, 0, true);
// This sets the point from which the position earns rewards & is impacted by claims
// also overwrites previous LpInfo after a withdrawal
self.lpInfos[tokenId_] = DataTypes.LpInfo({
beginLiquidityIndex: self.slot0.liquidityIndex,
beginClaimIndex: self.compensationIds.length
});
}
/**
* @notice Pays the rewards and fees to the position owner and the DAO.
*
* @param poolId_ The pool ID
* @param rewards_ The rewards to pay
* @param account_ The account to pay the rewards to
* @param yieldBonus_ The yield bonus to apply to the rewards
* @param nbPools_ The number of pools in the position
*/
function _payRewardsAndFees(
uint64 poolId_,
uint256 rewards_,
address account_,
uint256 yieldBonus_,
uint256 nbPools_
) public {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
if (0 < rewards_) {
uint256 fees = (rewards_ * self.feeRate) / HUNDRED_PERCENT;
uint256 yieldBonus = (rewards_ *
(HUNDRED_PERCENT - yieldBonus_)) / HUNDRED_PERCENT;
uint256 netFees = fees == 0 || fees < yieldBonus
? 0
: fees - yieldBonus;
uint256 leverageFee;
if (1 < nbPools_) {
// The risk fee is only applied when using leverage
// @dev The leverage fee is per pool so it starts at 2 * leverageFeePerPool
leverageFee =
(rewards_ * (self.leverageFeePerPool * nbPools_)) /
HUNDRED_PERCENT;
} else if (account_ == address(self.dao)) {
// Take profits for the DAO accumulate the net in the leverage risk wallet
leverageFee = rewards_ - netFees;
}
uint256 totalFees = netFees + leverageFee;
// With insane leverage then the user could have a total fee rate above 100%
uint256 net = rewards_ < totalFees ? 0 : rewards_ - totalFees;
// Pay position owner
// @bw would be better to move this up to liq man to pay all in one go
if (net != 0) {
IERC20(self.paymentAsset).safeTransfer(account_, net);
}
// Pay treasury & leverage risk wallet
if (totalFees != 0) {
IERC20(self.paymentAsset).safeTransfer(
address(self.dao),
totalFees
);
// This will register the revenue in the DAO for distribution
if (IsContract._isContract(address(self.dao))) {
self.dao.accrueRevenue(
self.paymentAsset,
netFees,
leverageFee
);
}
}
}
}
/// -------- TAKE INTERESTS -------- ///
/**
* @notice Takes the interests of a position and updates the pool's state.
*
* @param poolId_ The pool ID
* @param tokenId_ The LP position token ID
* @param account_ The account to pay the rewards to
* @param supplied_ The amount of liquidity to take interest on
* @param yieldBonus_ The yield bonus to apply to the rewards
* @param poolIds_ The pool IDs of the position
*
* @return newUserCapital The user's capital after claims
* @return coverRewards The rewards earned from cover premiums
*
* @dev Need to update user capital & payout strategy rewards upon calling this function
*/
function _takePoolInterests(
uint64 poolId_,
uint256 tokenId_,
address account_,
uint256 supplied_,
uint256 strategyRewardIndex_,
uint256 latestStrategyRewardIndex_,
uint256 yieldBonus_,
uint64[] storage poolIds_
)
external
returns (uint256 /*newUserCapital*/, uint256 /*coverRewards*/)
{
if (supplied_ == 0) return (0, 0);
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
// Get the updated position info
UpdatedPositionInfo memory info = _getUpdatedPositionInfo(
poolId_,
poolIds_,
UpdatePositionParams({
currentLiquidityIndex: self.slot0.liquidityIndex,
tokenId: tokenId_,
userCapital: supplied_,
strategyRewardIndex: strategyRewardIndex_,
latestStrategyRewardIndex: latestStrategyRewardIndex_,
strategyId: self.strategyId,
itCompounds: self.strategyManager.itCompounds(
self.strategyId
),
endCompensationIndex: self.compensationIds.length,
nbPools: poolIds_.length
})
);
// Pay cover rewards and send fees to treasury
_payRewardsAndFees(
poolId_,
info.coverRewards,
account_,
yieldBonus_,
poolIds_.length
);
// Update lp info to reflect the new state of the position
self.lpInfos[tokenId_] = info.newLpInfo;
// Return the user's capital & strategy rewards for withdrawal
return (info.newUserCapital, info.strategyRewards);
}
/// -------- WITHDRAW -------- ///
/**
* @notice Withdraws liquidity from the pool and updates the pool's state.
*
* @param poolId_ The pool ID
* @param tokenId_ The LP position token ID
* @param supplied_ The amount of liquidity to withdraw
* @param poolIds_ The pool IDs of the position
*
* @return newUserCapital The user's capital after claims
* @return strategyRewards The rewards earned by the strategy
*/
function _withdrawLiquidity(
uint64 poolId_,
uint256 tokenId_,
uint256 supplied_,
uint256 amount_,
uint256 strategyRewardIndex_,
uint256 latestStrategyRewardIndex_,
uint64[] storage poolIds_
) external returns (uint256, uint256) {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
// Get the updated position info
UpdatedPositionInfo memory info = _getUpdatedPositionInfo(
poolId_,
poolIds_,
UpdatePositionParams({
currentLiquidityIndex: self.slot0.liquidityIndex,
tokenId: tokenId_,
userCapital: supplied_,
strategyRewardIndex: strategyRewardIndex_,
latestStrategyRewardIndex: latestStrategyRewardIndex_,
strategyId: self.strategyId,
itCompounds: self.strategyManager.itCompounds(
self.strategyId
),
endCompensationIndex: self.compensationIds.length,
nbPools: poolIds_.length
})
);
// Pool rewards after commit are paid in favor of the DAO's leverage risk wallet
_payRewardsAndFees(
poolId_,
info.coverRewards,
address(self.dao),
0, // No yield bonus for the DAO
poolIds_.length
);
// Update lp info to reflect the new state of the position
self.lpInfos[tokenId_] = info.newLpInfo;
// Update liquidity index
_syncLiquidity(poolId_, 0, amount_, false);
// Return the user's capital & strategy rewards for withdrawal
return (info.newUserCapital, info.strategyRewards);
}
// ======= COVERS ======= //
/// -------- BUY -------- ///
/**
* @notice Registers a premium position for a cover,
* it also initializes the last tick (expiration tick) of the cover is needed.
*
* @param self The pool
* @param coverId_ The cover ID
* @param beginPremiumRate_ The premium rate at the beginning of the cover
* @param lastTick_ The last tick of the cover
*/
function _addPremiumPosition(
DataTypes.VPool storage self,
uint256 coverId_,
uint256 coverAmount_,
uint256 beginPremiumRate_,
uint32 lastTick_
) internal {
self.ticks[lastTick_] += coverAmount_;
self.covers[coverId_] = DataTypes.Cover({
coverAmount: coverAmount_,
beginPremiumRate: beginPremiumRate_,
lastTick: lastTick_
});
/**
* If the tick at which the cover expires is not initialized then initialize it
* this indicates that the tick is not empty and has covers that expire
*/
if (!self.tickBitmap.isInitializedTick(lastTick_)) {
self.tickBitmap.flipTick(lastTick_);
}
}
/**
* @notice Registers a premium position of a cover and updates the pool's slot0.
*
* @param poolId_ The pool ID
* @param coverId_ The cover ID
* @param coverAmount_ The amount of cover to buy
* @param premiums_ The amount of premiums deposited
*/
function _registerCover(
uint64 poolId_,
uint256 coverId_,
uint256 coverAmount_,
uint256 premiums_
) external {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
// @bw could compute amount of time lost to rounding and conseqentially the amount of premiums lost, then register them to be able to harvest them / redistrib them
uint256 available = availableLiquidity(self.poolId);
/**
* Check if pool has enough liquidity, when updating a cover
* we closed the previous cover at this point so check for total
* */
if (available < coverAmount_) revert InsufficientCapacity();
uint256 liquidity = totalLiquidity(self.poolId);
(uint256 newPremiumRate, uint256 newSecondsPerTick, ) = PoolMath
.updatePoolMarket(
self.formula,
self.slot0.secondsPerTick,
liquidity,
self.slot0.coveredCapital,
liquidity,
self.slot0.coveredCapital + coverAmount_
);
uint256 durationInSeconds = (premiums_ * YEAR * PERCENTAGE_BASE)
.rayDiv(newPremiumRate) / coverAmount_;
if (durationInSeconds < newSecondsPerTick)
revert DurationBelowOneTick();
/**
* @dev The user can loose up to almost 1 tick of cover due to the floored division
* The user can also win up to almost 1 tick of cover if it is opened at the start of a tick
*/
uint256 tickDuration = durationInSeconds / newSecondsPerTick;
// Check for overflow in case the cover amount is very low
if (type(uint32).max < tickDuration) revert DurationOverflow();
uint32 lastTick = self.slot0.tick + uint32(tickDuration);
self._addPremiumPosition(
coverId_,
coverAmount_,
newPremiumRate,
lastTick
);
self.slot0.coveredCapital += coverAmount_;
self.slot0.secondsPerTick = newSecondsPerTick;
}
/// -------- CLOSE -------- ///
/**
* @notice Closes a cover and updates the pool's slot0.
*
* @param poolId_ The pool ID
* @param coverId_ The cover ID
*/
function _closeCover(uint64 poolId_, uint256 coverId_) external {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
DataTypes.Cover memory cover = self.covers[coverId_];
// Remove cover amount from the tick at which it expires
uint256 coverAmount = cover.coverAmount;
self.ticks[cover.lastTick] -= coverAmount;
// If there is no more cover in the tick then flip it to uninitialized
if (self.ticks[cover.lastTick] == 0) {
self.tickBitmap.flipTick(cover.lastTick);
}
uint256 liquidity = totalLiquidity(self.poolId);
(, self.slot0.secondsPerTick, ) = PoolMath.updatePoolMarket(
self.formula,
self.slot0.secondsPerTick,
liquidity,
self.slot0.coveredCapital,
liquidity,
self.slot0.coveredCapital - coverAmount
);
self.slot0.coveredCapital -= coverAmount;
// @dev We remove 1 since the covers expire at the end of the tick
self.covers[coverId_].lastTick = self.slot0.tick - 1;
}
// ======= INTERNAL POOL HELPERS ======= //
/**
* @notice Purges expired covers from the pool and updates the pool's slot0 up to the latest timestamp
*
* @param poolId_ The pool ID
*
* @dev function _purgeExpiredCoversUpTo
*/
function _purgeExpiredCovers(uint64 poolId_) external {
_purgeExpiredCoversUpTo(poolId_, block.timestamp);
}
/**
* @notice Removes expired covers from the pool and updates the pool's slot0.
* Required before any operation that requires the slot0 to be up to date.
* This includes all position and cover operations.
*
* @param poolId_ The pool ID
*/
function _purgeExpiredCoversUpTo(
uint64 poolId_,
uint256 timestamp_
) public {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
self.slot0 = _refreshSlot0(poolId_, timestamp_);
}
// ======= VIEW HELPERS ======= //
/**
* @notice Checks if a cover is active or if it has expired or been closed
* @dev The user is protected during lastTick but the cover cannot be updated
*
* @param poolId_ The pool ID
* @param coverId_ The cover ID
*
* @return Whether the cover is active
*/
function _isCoverActive(
uint64 poolId_,
uint256 coverId_
) external view returns (bool) {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
return self.slot0.tick < self.covers[coverId_].lastTick;
}
/**
* @notice Computes the cover and strategy rewards for an LP position.
*
* @param self The pool
* @param info The updated position information
* @param coverRewards The current rewards earned from cover premiums
* @param strategyRewards The current rewards earned by the strategy
* @param strategyId The strategy ID
* @param itCompounds Whether the strategy compounds
* @param endliquidityIndex The end liquidity index
* @param startStrategyRewardIndex The start strategy reward index
* @param endStrategyRewardIndex The end strategy reward index
*
* @return coverRewards The aggregated rewards earned from cover premiums
* @return strategyRewards The aggregated rewards earned by the strategy
*/
function computePositionRewards(
DataTypes.VPool storage self,
UpdatedPositionInfo memory info,
uint256 coverRewards,
uint256 strategyRewards,
uint256 strategyId,
bool itCompounds,
uint256 endliquidityIndex,
uint256 startStrategyRewardIndex,
uint256 endStrategyRewardIndex
)
internal
view
returns (
uint256 /* coverRewards */,
uint256 /* strategyRewards */
)
{
coverRewards += PoolMath.getCoverRewards(
info.newUserCapital,
info.newLpInfo.beginLiquidityIndex,
endliquidityIndex
);
strategyRewards += self.strategyManager.computeReward(
strategyId,
// If strategy compounds then add to capital to compute next new rewards
itCompounds
? info.newUserCapital + info.strategyRewards
: info.newUserCapital,
startStrategyRewardIndex,
endStrategyRewardIndex
);
return (coverRewards, strategyRewards);
}
/**
* @notice Computes the state changes of an LP position,
* it aggregates the fees earned by the position and
* computes the losses incurred by the claims in this pool.
*
* @param poolId_ The pool ID
* @param poolIds_ The pool IDs of the position
* @param params The update position parameters
* - currentLiquidityIndex_ The current liquidity index
* - tokenId_ The LP position token ID
* - userCapital_ The user's capital
* - strategyRewardIndex_ The strategy reward index
* - latestStrategyRewardIndex_ The latest strategy reward index
*
* @return info Updated information about the position:
* - newUserCapital The user's capital after claims
* - coverRewards The rewards earned from cover premiums
* - strategyRewards The rewards earned by the strategy
* - newLpInfo The updated LpInfo of the position
*
* @dev Used for takeInterest, withdrawLiquidity and rewardsOf
*/
function _getUpdatedPositionInfo(
uint64 poolId_,
uint64[] storage poolIds_,
UpdatePositionParams memory params
) public view returns (UpdatedPositionInfo memory info) {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
// Make copy of current LP info state for position
info.newLpInfo = self.lpInfos[params.tokenId];
info.newUserCapital = params.userCapital;
// This index is not bubbled up in info because it is updated by the LiquidityManager
// @dev Left unitilized because _processCompensationsForPosition will update it event with no compensations
uint256 upToStrategyRewardIndex;
(
info,
upToStrategyRewardIndex
) = _processCompensationsForPosition(poolId_, poolIds_, params);
/**
* Finally add the rewards from the last claim or update to the current block
* & register latest reward & claim indexes
*/
(info.coverRewards, info.strategyRewards) = self
.computePositionRewards(
info,
info.coverRewards,
info.strategyRewards,
params.strategyId,
params.itCompounds,
params.currentLiquidityIndex,
upToStrategyRewardIndex,
params.latestStrategyRewardIndex
);
// Register up to where the position has been updated
// @dev
info.newLpInfo.beginLiquidityIndex = params.currentLiquidityIndex;
info.newLpInfo.beginClaimIndex = params.endCompensationIndex;
}
/**
* @notice Updates the capital in an LP position post compensation payouts.
*
* @param poolId_ The pool ID
* @param poolIds_ The pool IDs of the position
* @param params The update position parameters
*
* @return info Updated information about the position:
* @return upToStrategyRewardIndex The latest strategy reward index
*/
function _processCompensationsForPosition(
uint64 poolId_,
uint64[] storage poolIds_,
UpdatePositionParams memory params
)
public
view
returns (
UpdatedPositionInfo memory info,
uint256 upToStrategyRewardIndex
)
{
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
info.newLpInfo = self.lpInfos[params.tokenId];
info.newUserCapital = params.userCapital;
// This index is not bubbled up in info because it is updated by the LiquidityManager
upToStrategyRewardIndex = params.strategyRewardIndex;
uint256 compensationIndex = info.newLpInfo.beginClaimIndex;
/**
* Parse each claim that may affect capital due to overlap in order to
* compute rewards on post compensation capital
*/
for (
compensationIndex;
compensationIndex < params.endCompensationIndex;
compensationIndex++
) {
DataTypes.Compensation storage comp = getCompensation(
self.compensationIds[compensationIndex]
);
// For each pool in the position
for (uint256 j; j < params.nbPools; j++) {
// Skip if the comp is not incoming from one of the pools in the position
if (poolIds_[j] != comp.fromPoolId) continue;
// We want the liquidity index of this pool at the time of the claim
uint256 liquidityIndexBeforeClaim = comp
.liquidityIndexBeforeClaim[self.poolId];
// Compute the rewards accumulated up to the claim
(info.coverRewards, info.strategyRewards) = self
.computePositionRewards(
info,
info.coverRewards,
info.strategyRewards,
params.strategyId,
params.itCompounds,
liquidityIndexBeforeClaim,
upToStrategyRewardIndex,
comp.strategyRewardIndexBeforeClaim
);
info
.newLpInfo
.beginLiquidityIndex = liquidityIndexBeforeClaim;
// Reduce capital after the comp
info.newUserCapital -= info.newUserCapital.rayMul(comp.ratio);
// Register up to where the rewards have been accumulated
upToStrategyRewardIndex = comp.strategyRewardIndexBeforeClaim;
break;
}
}
// Register up to where the position has been updated
info.newLpInfo.beginClaimIndex = params.endCompensationIndex;
}
/**
* @notice Computes the updated state of a cover.
*
* @param poolId_ The pool ID
* @param coverId_ The cover ID
*
* @return info The cover data
*/
function _computeRefreshedCoverInfo(
uint64 poolId_,
uint256 coverId_
) external view returns (CoverInfo memory info) {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
return
self._computeCoverInfo(
coverId_,
// For reads we sync the slot0 to the current timestamp to have latests data
_refreshSlot0(poolId_, block.timestamp)
);
}
/**
* @notice Returns the current state of a cover.
*
* @param poolId_ The pool ID
* @param coverId_ The cover ID
*
* @return info The cover data
*/
function _computeCurrentCoverInfo(
uint64 poolId_,
uint256 coverId_
) external view returns (CoverInfo memory info) {
DataTypes.VPool storage self = VirtualPool.getPool(poolId_);
return self._computeCoverInfo(coverId_, self.slot0);
}
/**
* @notice Computes the premium rate & daily cost of a cover,
* this parses the pool's ticks to compute how much premiums are left and
* what is the daily cost of keeping the cover openened.
*
* @param self The pool
* @param coverId_ The cover ID
*
* @return info A struct containing the cover's premium rate & the cover's daily cost
*/
function _computeCoverInfo(
DataTypes.VPool storage self,
uint256 coverId_,
DataTypes.Slot0 memory slot0_
) internal view returns (CoverInfo memory info) {
DataTypes.Cover storage cover = self.covers[coverId_];
/**
* If the cover's last tick is overtaken then it's expired & no premiums are left.
* Return default 0 / false values in the returned struct.
*/
if (cover.lastTick < slot0_.tick) return info;
info.isActive = true;
info.premiumRate = PoolMath.getPremiumRate(
self.formula,
PoolMath._utilization(
slot0_.coveredCapital,
totalLiquidity(self.poolId)
)
);
/// @dev Skip division by premium rate PERCENTAGE_BASE for precision
uint256 beginDailyCost = cover
.coverAmount
.rayMul(cover.beginPremiumRate)
.rayDiv(365);
info.dailyCost = PoolMath.getDailyCost(
beginDailyCost,
cover.beginPremiumRate,
info.premiumRate
);
uint256 nbTicksLeft = cover.lastTick - slot0_.tick;
// Duration in seconds between currentTick & minNextTick
uint256 duration = nbTicksLeft * slot0_.secondsPerTick;
/// @dev Unscale amount by PERCENTAGE_BASE & RAY
info.premiumsLeft =
(duration * info.dailyCost) /
(1 days * PERCENTAGE_BASE * RAY);
/// @dev Unscale amount by PERCENTAGE_BASE & RAY
info.dailyCost = info.dailyCost / (PERCENTAGE_BASE * RAY);
}
/**
* @notice Mutates a slot0 to reflect states changes upon crossing an initialized tick.
* The covers crossed tick are expired and the pool's liquidity is updated.
*
* @dev It must be mutative so it can be used by read & write fns.
*
* @param self The pool
* @param slot0_ The slot0 to mutate
* @param tick_ The tick to cross
*
* @return The mutated slot0
*/
function _crossingInitializedTick(
DataTypes.VPool storage self,
DataTypes.Slot0 memory slot0_,
uint32 tick_
)
internal
view
returns (
DataTypes.Slot0 memory /* slot0_ */,
uint256 utilization,
uint256 premiumRate
)
{
uint256 liquidity = totalLiquidity(self.poolId);
// Remove expired cover amount from the pool's covered capital
uint256 newCoveredCapital = slot0_.coveredCapital -
self.ticks[tick_];
(premiumRate, slot0_.secondsPerTick, utilization) = PoolMath
.updatePoolMarket(
self.formula,
self.slot0.secondsPerTick,
liquidity,
self.slot0.coveredCapital,
liquidity,
newCoveredCapital
);
// Remove expired cover amount from the pool's covered capital
slot0_.coveredCapital = newCoveredCapital;
return (slot0_, utilization, premiumRate);
}
}
PoolManager.sol 140 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.25;
// Contracts
import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
// Interfaces
import { ILiquidityManager } from "../interfaces/ILiquidityManager.sol";
import { IOwnable } from "../interfaces/IOwnable.sol";
/// @title Pool Manager Contract
/// @notice Manages batch operations for pools in the Liquidity Manager
/// @dev All functions are restricted to owner access
contract PoolManager is Ownable {
/// @notice Reference to the Liquidity Manager contract
ILiquidityManager public liquidityManager;
/// @notice Initializes the Pool Manager with a Liquidity Manager contract
/// @param _liquidityManager Address of the Liquidity Manager contract
constructor(
ILiquidityManager _liquidityManager
) Ownable(msg.sender) {
liquidityManager = _liquidityManager;
}
/// @notice Configuration parameters for a pool
/// @param poolId Unique identifier of the pool
/// @param feeRate Fee rate for the pool
/// @param uOptimal Optimal utilization rate
/// @param r0 Base interest rate
/// @param rSlope1 First slope parameter for interest rate calculation
/// @param rSlope2 Second slope parameter for interest rate calculation
struct PoolConfig {
uint64 poolId;
uint256 feeRate;
uint256 uOptimal;
uint256 r0;
uint256 rSlope1;
uint256 rSlope2;
}
/// @notice Parameters required for creating a new pool
/// @param paymentAsset Address of the token used for payments
/// @param strategyId Identifier of the strategy to be used
/// @param feeRate Fee rate for the pool
/// @param uOptimal Optimal utilization rate
/// @param r0 Base interest rate
/// @param rSlope1 First slope parameter for interest rate calculation
/// @param rSlope2 Second slope parameter for interest rate calculation
/// @param compatiblePools Array of pool IDs that are compatible with this pool
struct PoolCreationParams {
address paymentAsset;
uint256 strategyId;
uint256 feeRate;
uint256 uOptimal;
uint256 r0;
uint256 rSlope1;
uint256 rSlope2;
uint64[] compatiblePools;
}
/// @notice Pauses or unpauses multiple pools in a single transaction
/// @param poolIds Array of pool IDs to modify
/// @param isPaused True to pause pools, false to unpause
function batchPausePool(
uint64[] calldata poolIds,
bool isPaused
) external onlyOwner {
for (uint256 i = 0; i < poolIds.length; i++) {
liquidityManager.pausePool(poolIds[i], isPaused);
}
}
/// @notice Creates multiple pools in a single transaction
/// @param params Array of pool creation parameters
function batchCreatePool(
PoolCreationParams[] calldata params
) external onlyOwner {
for (uint256 i = 0; i < params.length; i++) {
liquidityManager.createPool(
params[i].paymentAsset,
params[i].strategyId,
params[i].feeRate,
params[i].uOptimal,
params[i].r0,
params[i].rSlope1,
params[i].rSlope2,
params[i].compatiblePools
);
}
}
/// @notice Updates configuration for multiple pools in a single transaction
/// @param configs Array of pool configurations to update
function batchUpdatePoolConfig(
PoolConfig[] calldata configs
) external onlyOwner {
for (uint256 i = 0; i < configs.length; i++) {
liquidityManager.updatePoolConfig(
configs[i].poolId,
configs[i].feeRate,
configs[i].uOptimal,
configs[i].r0,
configs[i].rSlope1,
configs[i].rSlope2
);
}
}
/// @notice Updates compatibility between multiple pools in a single transaction
/// @param poolIds Array of pool IDs to update
/// @param poolIdCompatible Array of arrays containing compatible pool IDs for each pool
/// @param poolIdCompatibleStatus Array of arrays containing compatibility status for each pool pair
function batchUpdatePoolCompatibility(
uint64[] calldata poolIds,
uint64[][] calldata poolIdCompatible,
bool[][] calldata poolIdCompatibleStatus
) external onlyOwner {
liquidityManager.updatePoolCompatibility(
poolIds,
poolIdCompatible,
poolIdCompatibleStatus
);
}
/// @notice Transfers ownership of the Liquidity Manager contract
/// @param newOwner Address of the new owner
function transferLiquidityManagerOwnership(
address newOwner
) external onlyOwner {
IOwnable(address(liquidityManager)).transferOwnership(newOwner);
}
/// @notice Updates the Liquidity Manager contract address
/// @param _liquidityManager Address of the new Liquidity Manager contract
function updateLiquidityManager(
ILiquidityManager _liquidityManager
) external onlyOwner {
liquidityManager = _liquidityManager;
}
}
Read Contract
liquidityManager 0x33827438 → address
owner 0x8da5cb5b → address
Write Contract 8 functions
These functions modify contract state and require a wallet transaction to execute.
batchCreatePool 0xf6aa7507
tuple[] params
batchPausePool 0x253f3ffb
uint64[] poolIds
bool isPaused
batchUpdatePoolCompatibility 0x92837566
uint64[] poolIds
uint64[][] poolIdCompatible
bool[][] poolIdCompatibleStatus
batchUpdatePoolConfig 0x384f8d42
tuple[] configs
renounceOwnership 0x715018a6
No parameters
transferLiquidityManagerOwnership 0x6edf9831
address newOwner
transferOwnership 0xf2fde38b
address newOwner
updateLiquidityManager 0x206f248d
address _liquidityManager
Recent Transactions
No transactions found for this address