Source Code
Overview
S Balance
0 SS Value
$0.00Latest 3 internal transactions
Advanced mode:
| Parent Transaction Hash | Block | From | To | |||
|---|---|---|---|---|---|---|
| 43950120 | 157 days ago | Contract Creation | 0 S | |||
| 43949943 | 157 days ago | Contract Creation | 0 S | |||
| 43945441 | 157 days ago | Contract Creation | 0 S |
Cross-Chain Transactions
Loading...
Loading
Contract Name:
SablierMerkleFactory
Compiler Version
v0.8.26+commit.8a97fa7a
Optimization Enabled:
Yes with 1000 runs
Other Settings:
shanghai EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: BUSL-1.1
pragma solidity >=0.8.22;
import { uUNIT } from "@prb/math/src/UD2x18.sol";
import { Adminable } from "@sablier/lockup/src/abstracts/Adminable.sol";
import { ISablierLockup } from "@sablier/lockup/src/interfaces/ISablierLockup.sol";
import { ISablierMerkleBase } from "./interfaces/ISablierMerkleBase.sol";
import { ISablierMerkleFactory } from "./interfaces/ISablierMerkleFactory.sol";
import { ISablierMerkleInstant } from "./interfaces/ISablierMerkleInstant.sol";
import { ISablierMerkleLL } from "./interfaces/ISablierMerkleLL.sol";
import { ISablierMerkleLT } from "./interfaces/ISablierMerkleLT.sol";
import { SablierMerkleInstant } from "./SablierMerkleInstant.sol";
import { SablierMerkleLL } from "./SablierMerkleLL.sol";
import { SablierMerkleLT } from "./SablierMerkleLT.sol";
import { MerkleBase, MerkleFactory, MerkleLL, MerkleLT } from "./types/DataTypes.sol";
/*
███████╗ █████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔════╝██╔══██╗██╔══██╗██║ ██║██╔════╝██╔══██╗
███████╗███████║██████╔╝██║ ██║█████╗ ██████╔╝
╚════██║██╔══██║██╔══██╗██║ ██║██╔══╝ ██╔══██╗
███████║██║ ██║██████╔╝███████╗██║███████╗██║ ██║
╚══════╝╚═╝ ╚═╝╚═════╝ ╚══════╝╚═╝╚══════╝╚═╝ ╚═╝
███╗ ███╗███████╗██████╗ ██╗ ██╗██╗ ███████╗ ███████╗ █████╗ ██████╗████████╗ ██████╗ ██████╗ ██╗ ██╗
████╗ ████║██╔════╝██╔══██╗██║ ██╔╝██║ ██╔════╝ ██╔════╝██╔══██╗██╔════╝╚══██╔══╝██╔═══██╗██╔══██╗╚██╗ ██╔╝
██╔████╔██║█████╗ ██████╔╝█████╔╝ ██║ █████╗ █████╗ ███████║██║ ██║ ██║ ██║██████╔╝ ╚████╔╝
██║╚██╔╝██║██╔══╝ ██╔══██╗██╔═██╗ ██║ ██╔══╝ ██╔══╝ ██╔══██║██║ ██║ ██║ ██║██╔══██╗ ╚██╔╝
██║ ╚═╝ ██║███████╗██║ ██║██║ ██╗███████╗███████╗ ██║ ██║ ██║╚██████╗ ██║ ╚██████╔╝██║ ██║ ██║
╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝╚══════╝╚══════╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═╝
*/
/// @title SablierMerkleFactory
/// @notice See the documentation in {ISablierMerkleFactory}.
contract SablierMerkleFactory is
ISablierMerkleFactory, // 2 inherited components
Adminable // 1 inherited component
{
/*//////////////////////////////////////////////////////////////////////////
STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierMerkleFactory
uint256 public override defaultFee;
/// @dev A mapping of custom fees mapped by campaign creator addresses.
mapping(address campaignCreator => MerkleFactory.CustomFee customFee) private _customFees;
/*//////////////////////////////////////////////////////////////////////////
CONSTRUCTOR
//////////////////////////////////////////////////////////////////////////*/
/// @param initialAdmin The address of the initial contract admin.
constructor(address initialAdmin) Adminable(initialAdmin) { }
/*//////////////////////////////////////////////////////////////////////////
USER-FACING CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierMerkleFactory
function getCustomFee(address campaignCreator) external view override returns (MerkleFactory.CustomFee memory) {
return _customFees[campaignCreator];
}
/// @inheritdoc ISablierMerkleFactory
function getFee(address campaignCreator) external view returns (uint256) {
return _getFee(campaignCreator);
}
/// @inheritdoc ISablierMerkleFactory
function isPercentagesSum100(MerkleLT.TrancheWithPercentage[] calldata tranches)
external
pure
override
returns (bool result)
{
uint256 totalPercentage;
for (uint256 i = 0; i < tranches.length; ++i) {
totalPercentage += tranches[i].unlockPercentage.unwrap();
}
return totalPercentage == uUNIT;
}
/*//////////////////////////////////////////////////////////////////////////
USER-FACING NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierMerkleFactory
function collectFees(ISablierMerkleBase merkleBase) external override {
// Effect: collect the fees from the MerkleBase contract.
uint256 feeAmount = merkleBase.collectFees(admin);
// Log the fee withdrawal.
emit CollectFees({ admin: admin, merkleBase: merkleBase, feeAmount: feeAmount });
}
/// @inheritdoc ISablierMerkleFactory
function createMerkleInstant(
MerkleBase.ConstructorParams memory baseParams,
uint256 aggregateAmount,
uint256 recipientCount
)
external
override
returns (ISablierMerkleInstant merkleInstant)
{
// Hash the parameters to generate a salt.
bytes32 salt = keccak256(abi.encodePacked(msg.sender, abi.encode(baseParams)));
// Deploy the MerkleInstant contract with CREATE2.
merkleInstant = new SablierMerkleInstant{ salt: salt }({ baseParams: baseParams, campaignCreator: msg.sender });
// Log the creation of the MerkleInstant contract, including some metadata that is not stored on-chain.
emit CreateMerkleInstant({
merkleInstant: merkleInstant,
baseParams: baseParams,
aggregateAmount: aggregateAmount,
recipientCount: recipientCount,
fee: _getFee(msg.sender)
});
}
/// @inheritdoc ISablierMerkleFactory
function createMerkleLL(
MerkleBase.ConstructorParams memory baseParams,
ISablierLockup lockup,
bool cancelable,
bool transferable,
MerkleLL.Schedule memory schedule,
uint256 aggregateAmount,
uint256 recipientCount
)
external
override
returns (ISablierMerkleLL merkleLL)
{
// Hash the parameters to generate a salt.
bytes32 salt = keccak256(
abi.encodePacked(msg.sender, abi.encode(baseParams), lockup, cancelable, transferable, abi.encode(schedule))
);
// Deploy the MerkleLL contract with CREATE2.
merkleLL = new SablierMerkleLL{ salt: salt }({
baseParams: baseParams,
campaignCreator: msg.sender,
lockup: lockup,
cancelable: cancelable,
transferable: transferable,
schedule: schedule
});
// Log the creation of the MerkleLL contract, including some metadata that is not stored on-chain.
emit CreateMerkleLL({
merkleLL: merkleLL,
baseParams: baseParams,
lockup: lockup,
cancelable: cancelable,
transferable: transferable,
schedule: schedule,
aggregateAmount: aggregateAmount,
recipientCount: recipientCount,
fee: _getFee(msg.sender)
});
}
/// @inheritdoc ISablierMerkleFactory
function createMerkleLT(
MerkleBase.ConstructorParams memory baseParams,
ISablierLockup lockup,
bool cancelable,
bool transferable,
uint40 streamStartTime,
MerkleLT.TrancheWithPercentage[] memory tranchesWithPercentages,
uint256 aggregateAmount,
uint256 recipientCount
)
external
override
returns (ISablierMerkleLT merkleLT)
{
// Calculate the sum of percentages and durations across all tranches.
uint256 count = tranchesWithPercentages.length;
uint256 totalDuration;
for (uint256 i = 0; i < count; ++i) {
unchecked {
// Safe to use `unchecked` because its only used in the event.
totalDuration += tranchesWithPercentages[i].duration;
}
}
// Deploy the MerkleLT contract.
merkleLT = _deployMerkleLT({
baseParams: baseParams,
lockup: lockup,
cancelable: cancelable,
transferable: transferable,
streamStartTime: streamStartTime,
tranchesWithPercentages: tranchesWithPercentages
});
// Log the creation of the MerkleLT contract, including some metadata that is not stored on-chain.
emit CreateMerkleLT({
merkleLT: merkleLT,
baseParams: baseParams,
lockup: lockup,
cancelable: cancelable,
transferable: transferable,
streamStartTime: streamStartTime,
tranchesWithPercentages: tranchesWithPercentages,
totalDuration: totalDuration,
aggregateAmount: aggregateAmount,
recipientCount: recipientCount,
fee: _getFee(msg.sender)
});
}
/// @inheritdoc ISablierMerkleFactory
function resetCustomFee(address campaignCreator) external override onlyAdmin {
delete _customFees[campaignCreator];
// Log the reset.
emit ResetCustomFee({ admin: msg.sender, campaignCreator: campaignCreator });
}
/// @inheritdoc ISablierMerkleFactory
function setCustomFee(address campaignCreator, uint256 newFee) external override onlyAdmin {
MerkleFactory.CustomFee storage customFeeByUser = _customFees[campaignCreator];
// Check: if the user is not in the custom fee list.
if (!customFeeByUser.enabled) {
customFeeByUser.enabled = true;
}
// Effect: update the custom fee for the given campaign creator.
customFeeByUser.fee = newFee;
// Log the update.
emit SetCustomFee({ admin: msg.sender, campaignCreator: campaignCreator, customFee: newFee });
}
/// @inheritdoc ISablierMerkleFactory
function setDefaultFee(uint256 defaultFee_) external override onlyAdmin {
// Effect: update the default fee.
defaultFee = defaultFee_;
emit SetDefaultFee(msg.sender, defaultFee_);
}
/*//////////////////////////////////////////////////////////////////////////
PRIVATE CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Retrieves the fee for the provided campaign creator, using the default fee if no custom fee is set.
function _getFee(address campaignCreator) private view returns (uint256) {
return _customFees[campaignCreator].enabled ? _customFees[campaignCreator].fee : defaultFee;
}
/*//////////////////////////////////////////////////////////////////////////
PRIVATE NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Deploys a new MerkleLT contract with CREATE2.
/// @dev We need a separate function to prevent the stack too deep error.
function _deployMerkleLT(
MerkleBase.ConstructorParams memory baseParams,
ISablierLockup lockup,
bool cancelable,
bool transferable,
uint40 streamStartTime,
MerkleLT.TrancheWithPercentage[] memory tranchesWithPercentages
)
private
returns (ISablierMerkleLT merkleLT)
{
// Hash the parameters to generate a salt.
bytes32 salt = keccak256(
abi.encodePacked(
msg.sender,
abi.encode(baseParams),
lockup,
cancelable,
transferable,
streamStartTime,
abi.encode(tranchesWithPercentages)
)
);
// Deploy the MerkleLT contract with CREATE2.
merkleLT = new SablierMerkleLT{ salt: salt }({
baseParams: baseParams,
campaignCreator: msg.sender,
lockup: lockup,
cancelable: cancelable,
transferable: transferable,
streamStartTime: streamStartTime,
tranchesWithPercentages: tranchesWithPercentages
});
}
}// SPDX-License-Identifier: MIT pragma solidity >=0.8.19; /* ██████╗ ██████╗ ██████╗ ███╗ ███╗ █████╗ ████████╗██╗ ██╗ ██╔══██╗██╔══██╗██╔══██╗████╗ ████║██╔══██╗╚══██╔══╝██║ ██║ ██████╔╝██████╔╝██████╔╝██╔████╔██║███████║ ██║ ███████║ ██╔═══╝ ██╔══██╗██╔══██╗██║╚██╔╝██║██╔══██║ ██║ ██╔══██║ ██║ ██║ ██║██████╔╝██║ ╚═╝ ██║██║ ██║ ██║ ██║ ██║ ╚═╝ ╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ██╗ ██╗██████╗ ██████╗ ██╗ ██╗ ██╗ █████╗ ██║ ██║██╔══██╗╚════██╗╚██╗██╔╝███║██╔══██╗ ██║ ██║██║ ██║ █████╔╝ ╚███╔╝ ╚██║╚█████╔╝ ██║ ██║██║ ██║██╔═══╝ ██╔██╗ ██║██╔══██╗ ╚██████╔╝██████╔╝███████╗██╔╝ ██╗ ██║╚█████╔╝ ╚═════╝ ╚═════╝ ╚══════╝╚═╝ ╚═╝ ╚═╝ ╚════╝ */ import "./ud2x18/Casting.sol"; import "./ud2x18/Constants.sol"; import "./ud2x18/Errors.sol"; import "./ud2x18/ValueType.sol";
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IAdminable } from "../interfaces/IAdminable.sol";
import { Errors } from "../libraries/Errors.sol";
/// @title Adminable
/// @notice See the documentation in {IAdminable}.
abstract contract Adminable is IAdminable {
/*//////////////////////////////////////////////////////////////////////////
STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc IAdminable
address public override admin;
/*//////////////////////////////////////////////////////////////////////////
MODIFIERS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Reverts if called by any account other than the admin.
modifier onlyAdmin() {
if (admin != msg.sender) {
revert Errors.CallerNotAdmin({ admin: admin, caller: msg.sender });
}
_;
}
/*//////////////////////////////////////////////////////////////////////////
CONSTRUCTOR
//////////////////////////////////////////////////////////////////////////*/
/// @dev Emits a {TransferAdmin} event.
/// @param initialAdmin The address of the initial admin.
constructor(address initialAdmin) {
admin = initialAdmin;
emit TransferAdmin({ oldAdmin: address(0), newAdmin: initialAdmin });
}
/*//////////////////////////////////////////////////////////////////////////
USER-FACING NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc IAdminable
function transferAdmin(address newAdmin) public virtual override onlyAdmin {
// Effect: update the admin.
admin = newAdmin;
// Log the transfer of the admin.
emit IAdminable.TransferAdmin({ oldAdmin: msg.sender, newAdmin: newAdmin });
}
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { Lockup, LockupDynamic, LockupLinear, LockupTranched } from "../types/DataTypes.sol";
import { ISablierLockupBase } from "./ISablierLockupBase.sol";
/// @title ISablierLockup
/// @notice Creates and manages Lockup streams with various distribution models.
interface ISablierLockup is ISablierLockupBase {
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when a stream is created using Lockup dynamic model.
/// @param streamId The ID of the newly created stream.
/// @param commonParams Common parameters emitted in Create events across all Lockup models.
/// @param segments The segments the protocol uses to compose the dynamic distribution function.
event CreateLockupDynamicStream(
uint256 indexed streamId, Lockup.CreateEventCommon commonParams, LockupDynamic.Segment[] segments
);
/// @notice Emitted when a stream is created using Lockup linear model.
/// @param streamId The ID of the newly created stream.
/// @param commonParams Common parameters emitted in Create events across all Lockup models.
/// @param cliffTime The Unix timestamp for the cliff period's end. A value of zero means there is no cliff.
/// @param unlockAmounts Struct encapsulating (i) the amount to unlock at the start time and (ii) the amount to
/// unlock at the cliff time.
event CreateLockupLinearStream(
uint256 indexed streamId,
Lockup.CreateEventCommon commonParams,
uint40 cliffTime,
LockupLinear.UnlockAmounts unlockAmounts
);
/// @notice Emitted when a stream is created using Lockup tranched model.
/// @param streamId The ID of the newly created stream.
/// @param commonParams Common parameters emitted in Create events across all Lockup models.
/// @param tranches The tranches the protocol uses to compose the tranched distribution function.
event CreateLockupTranchedStream(
uint256 indexed streamId, Lockup.CreateEventCommon commonParams, LockupTranched.Tranche[] tranches
);
/*//////////////////////////////////////////////////////////////////////////
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice The maximum number of segments and tranches allowed in Dynamic and Tranched streams respectively.
/// @dev This is initialized at construction time and cannot be changed later.
function MAX_COUNT() external view returns (uint256);
/// @notice Retrieves the stream's cliff time, which is a Unix timestamp. A value of zero means there is no cliff.
/// @dev Reverts if `streamId` references a null stream or a non Lockup Linear stream.
/// @param streamId The stream ID for the query.
function getCliffTime(uint256 streamId) external view returns (uint40 cliffTime);
/// @notice Retrieves the segments used to compose the dynamic distribution function.
/// @dev Reverts if `streamId` references a null stream or a non Lockup Dynamic stream.
/// @param streamId The stream ID for the query.
/// @return segments See the documentation in {DataTypes}.
function getSegments(uint256 streamId) external view returns (LockupDynamic.Segment[] memory segments);
/// @notice Retrieves the tranches used to compose the tranched distribution function.
/// @dev Reverts if `streamId` references a null stream or a non Lockup Tranched stream.
/// @param streamId The stream ID for the query.
/// @return tranches See the documentation in {DataTypes}.
function getTranches(uint256 streamId) external view returns (LockupTranched.Tranche[] memory tranches);
/// @notice Retrieves the unlock amounts used to compose the linear distribution function.
/// @dev Reverts if `streamId` references a null stream or a non Lockup Linear stream.
/// @param streamId The stream ID for the query.
/// @return unlockAmounts See the documentation in {DataTypes}.
function getUnlockAmounts(uint256 streamId)
external
view
returns (LockupLinear.UnlockAmounts memory unlockAmounts);
/*//////////////////////////////////////////////////////////////////////////
NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Creates a stream by setting the start time to `block.timestamp`, and the end time to the sum of
/// `block.timestamp` and all specified time durations. The segment timestamps are derived from these
/// durations. The stream is funded by `msg.sender` and is wrapped in an ERC-721 NFT.
///
/// @dev Emits a {Transfer}, {CreateLockupDynamicStream} and {MetadataUpdate} event.
///
/// Requirements:
/// - All requirements in {createWithTimestampsLD} must be met for the calculated parameters.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
/// @param segmentsWithDuration Segments with durations used to compose the dynamic distribution function. Timestamps
/// are calculated by starting from `block.timestamp` and adding each duration to the previous timestamp.
/// @return streamId The ID of the newly created stream.
function createWithDurationsLD(
Lockup.CreateWithDurations calldata params,
LockupDynamic.SegmentWithDuration[] calldata segmentsWithDuration
)
external
payable
returns (uint256 streamId);
/// @notice Creates a stream by setting the start time to `block.timestamp`, and the end time to
/// the sum of `block.timestamp` and `durations.total`. The stream is funded by `msg.sender` and is wrapped in an
/// ERC-721 NFT.
///
/// @dev Emits a {Transfer}, {CreateLockupLinearStream} and {MetadataUpdate} event.
///
/// Requirements:
/// - All requirements in {createWithTimestampsLL} must be met for the calculated parameters.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
/// @param durations Struct encapsulating (i) cliff period duration and (ii) total stream duration, both in seconds.
/// @param unlockAmounts Struct encapsulating (i) the amount to unlock at the start time and (ii) the amount to
/// unlock at the cliff time.
/// @return streamId The ID of the newly created stream.
function createWithDurationsLL(
Lockup.CreateWithDurations calldata params,
LockupLinear.UnlockAmounts calldata unlockAmounts,
LockupLinear.Durations calldata durations
)
external
payable
returns (uint256 streamId);
/// @notice Creates a stream by setting the start time to `block.timestamp`, and the end time to the sum of
/// `block.timestamp` and all specified time durations. The tranche timestamps are derived from these
/// durations. The stream is funded by `msg.sender` and is wrapped in an ERC-721 NFT.
///
/// @dev Emits a {Transfer}, {CreateLockupTrancheStream} and {MetadataUpdate} event.
///
/// Requirements:
/// - All requirements in {createWithTimestampsLT} must be met for the calculated parameters.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
/// @param tranchesWithDuration Tranches with durations used to compose the tranched distribution function.
/// Timestamps are calculated by starting from `block.timestamp` and adding each duration to the previous timestamp.
/// @return streamId The ID of the newly created stream.
function createWithDurationsLT(
Lockup.CreateWithDurations calldata params,
LockupTranched.TrancheWithDuration[] calldata tranchesWithDuration
)
external
payable
returns (uint256 streamId);
/// @notice Creates a stream with the provided segment timestamps, implying the end time from the last timestamp.
/// The stream is funded by `msg.sender` and is wrapped in an ERC-721 NFT.
///
/// @dev Emits a {Transfer}, {CreateLockupDynamicStream} and {MetadataUpdate} event.
///
/// Notes:
/// - As long as the segment timestamps are arranged in ascending order, it is not an error for some
/// of them to be in the past.
///
/// Requirements:
/// - Must not be delegate called.
/// - `params.totalAmount` must be greater than zero.
/// - If set, `params.broker.fee` must not be greater than `MAX_BROKER_FEE`.
/// - `params.timestamps.start` must be greater than zero and less than the first segment's timestamp.
/// - `segments` must have at least one segment, but not more than `MAX_COUNT`.
/// - The segment timestamps must be arranged in ascending order.
/// - `params.timestamps.end` must be equal to the last segment's timestamp.
/// - The sum of the segment amounts must equal the deposit amount.
/// - `params.recipient` must not be the zero address.
/// - `params.sender` must not be the zero address.
/// - `msg.sender` must have allowed this contract to spend at least `params.totalAmount` tokens.
/// - `params.shape.length` must not be greater than 32 characters.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
/// @param segments Segments used to compose the dynamic distribution function.
/// @return streamId The ID of the newly created stream.
function createWithTimestampsLD(
Lockup.CreateWithTimestamps calldata params,
LockupDynamic.Segment[] calldata segments
)
external
payable
returns (uint256 streamId);
/// @notice Creates a stream with the provided start time and end time. The stream is funded by `msg.sender` and is
/// wrapped in an ERC-721 NFT.
///
/// @dev Emits a {Transfer}, {CreateLockupLinearStream} and {MetadataUpdate} event.
///
/// Notes:
/// - A cliff time of zero means there is no cliff.
/// - As long as the times are ordered, it is not an error for the start or the cliff time to be in the past.
///
/// Requirements:
/// - Must not be delegate called.
/// - `params.totalAmount` must be greater than zero.
/// - If set, `params.broker.fee` must not be greater than `MAX_BROKER_FEE`.
/// - `params.timestamps.start` must be greater than zero and less than `params.timestamps.end`.
/// - If set, `cliffTime` must be greater than `params.timestamps.start` and less than
/// `params.timestamps.end`.
/// - `params.recipient` must not be the zero address.
/// - `params.sender` must not be the zero address.
/// - The sum of `params.unlockAmounts.start` and `params.unlockAmounts.cliff` must be less than or equal to
/// deposit amount.
/// - If `params.timestamps.cliff` not set, the `params.unlockAmounts.cliff` must be zero.
/// - `msg.sender` must have allowed this contract to spend at least `params.totalAmount` tokens.
/// - `params.shape.length` must not be greater than 32 characters.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
/// @param cliffTime The Unix timestamp for the cliff period's end. A value of zero means there is no cliff.
/// @param unlockAmounts Struct encapsulating (i) the amount to unlock at the start time and (ii) the amount to
/// unlock at the cliff time.
/// @return streamId The ID of the newly created stream.
function createWithTimestampsLL(
Lockup.CreateWithTimestamps calldata params,
LockupLinear.UnlockAmounts calldata unlockAmounts,
uint40 cliffTime
)
external
payable
returns (uint256 streamId);
/// @notice Creates a stream with the provided tranche timestamps, implying the end time from the last timestamp.
/// The stream is funded by `msg.sender` and is wrapped in an ERC-721 NFT.
///
/// @dev Emits a {Transfer}, {CreateLockupTrancheStream} and {MetadataUpdate} event.
///
/// Notes:
/// - As long as the tranche timestamps are arranged in ascending order, it is not an error for some
/// of them to be in the past.
///
/// Requirements:
/// - Must not be delegate called.
/// - `params.totalAmount` must be greater than zero.
/// - If set, `params.broker.fee` must not be greater than `MAX_BROKER_FEE`.
/// - `params.timestamps.start` must be greater than zero and less than the first tranche's timestamp.
/// - `tranches` must have at least one tranche, but not more than `MAX_COUNT`.
/// - The tranche timestamps must be arranged in ascending order.
/// - `params.timestamps.end` must be equal to the last tranche's timestamp.
/// - The sum of the tranche amounts must equal the deposit amount.
/// - `params.recipient` must not be the zero address.
/// - `params.sender` must not be the zero address.
/// - `msg.sender` must have allowed this contract to spend at least `params.totalAmount` tokens.
/// - `params.shape.length` must not be greater than 32 characters.
///
/// @param params Struct encapsulating the function parameters, which are documented in {DataTypes}.
/// @param tranches Tranches used to compose the tranched distribution function.
/// @return streamId The ID of the newly created stream.
function createWithTimestampsLT(
Lockup.CreateWithTimestamps calldata params,
LockupTranched.Tranche[] calldata tranches
)
external
payable
returns (uint256 streamId);
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { IAdminable } from "@sablier/lockup/src/interfaces/IAdminable.sol";
/// @title ISablierMerkleBase
/// @dev Common interface between Merkle Lockups and Merkle Instant.
interface ISablierMerkleBase is IAdminable {
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when the admin claws back the unclaimed tokens.
event Clawback(address indexed admin, address indexed to, uint128 amount);
/*//////////////////////////////////////////////////////////////////////////
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice The cut-off point for the campaign, as a Unix timestamp. A value of zero means there is no expiration.
/// @dev This is an immutable state variable.
function EXPIRATION() external returns (uint40);
/// @notice Retrieves the address of the factory contract.
function FACTORY() external view returns (address);
/// @notice Retrieves the minimum fee required to claim the airdrop, which is paid in the native token of the chain,
/// e.g. ETH for Ethereum Mainnet.
function FEE() external view returns (uint256);
/// @notice The root of the Merkle tree used to validate the proofs of inclusion.
/// @dev This is an immutable state variable.
function MERKLE_ROOT() external returns (bytes32);
/// @notice The ERC-20 token to distribute.
/// @dev This is an immutable state variable.
function TOKEN() external returns (IERC20);
/// @notice Retrieves the name of the campaign.
function campaignName() external view returns (string memory);
/// @notice Returns the timestamp when the first claim is made.
function getFirstClaimTime() external view returns (uint40);
/// @notice Returns a flag indicating whether a claim has been made for a given index.
/// @dev Uses a bitmap to save gas.
/// @param index The index of the recipient to check.
function hasClaimed(uint256 index) external returns (bool);
/// @notice Returns a flag indicating whether the campaign has expired.
function hasExpired() external view returns (bool);
/// @notice The content identifier for indexing the campaign on IPFS.
function ipfsCID() external view returns (string memory);
/// @notice Retrieves the shape of the lockup stream that the campaign produces upon claiming.
function shape() external view returns (string memory);
/*//////////////////////////////////////////////////////////////////////////
NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Makes the claim.
///
/// @dev Depending on the Merkle campaign, it either transfers tokens to the recipient or creates a Lockup stream
/// with an NFT minted to the recipient.
///
/// Requirements:
/// - The campaign must not have expired.
/// - The stream must not have been claimed already.
/// - The Merkle proof must be valid.
/// - The `msg.value` must not be less than `FEE`.
///
/// @param index The index of the recipient in the Merkle tree.
/// @param recipient The address of the airdrop recipient.
/// @param amount The amount of ERC-20 tokens to be transferred to the recipient.
/// @param merkleProof The proof of inclusion in the Merkle tree.
function claim(uint256 index, address recipient, uint128 amount, bytes32[] calldata merkleProof) external payable;
/// @notice Claws back the unclaimed tokens from the campaign.
///
/// @dev Emits a {Clawback} event.
///
/// Requirements:
/// - `msg.sender` must be the admin.
/// - No claim must be made, OR
/// The current timestamp must not exceed 7 days after the first claim, OR
/// The campaign must be expired.
///
/// @param to The address to receive the tokens.
/// @param amount The amount of tokens to claw back.
function clawback(address to, uint128 amount) external;
/// @notice Collects the accrued fees by transferring them to `FACTORY` admin.
///
/// Requirements:
/// - `msg.sender` must be the `FACTORY` contract.
///
/// @param factoryAdmin The address of the `FACTORY` admin.
/// @return feeAmount The amount of native tokens (e.g., ETH) collected as fees.
function collectFees(address factoryAdmin) external returns (uint256 feeAmount);
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IAdminable } from "@sablier/lockup/src/interfaces/IAdminable.sol";
import { ISablierLockup } from "@sablier/lockup/src/interfaces/ISablierLockup.sol";
import { ISablierMerkleBase } from "../interfaces/ISablierMerkleBase.sol";
import { MerkleBase, MerkleFactory, MerkleLL, MerkleLT } from "../types/DataTypes.sol";
import { ISablierMerkleInstant } from "./ISablierMerkleInstant.sol";
import { ISablierMerkleLL } from "./ISablierMerkleLL.sol";
import { ISablierMerkleLT } from "./ISablierMerkleLT.sol";
/// @title ISablierMerkleFactory
/// @notice A contract that deploys Merkle Lockups and Merkle Instant campaigns. Both use Merkle proofs for token
/// distribution. Merkle Lockup enable Airstreams, a portmanteau of "airdrop" and "stream", an airdrop model where the
/// tokens are distributed over time, as opposed to all at once. On the other hand, Merkle Instant enables instant
/// airdrops where tokens are unlocked and distributed immediately. See the Sablier docs for more guidance:
/// https://docs.sablier.com
/// @dev The contracts are deployed using CREATE2.
interface ISablierMerkleFactory is IAdminable {
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when the accrued fees are collected.
event CollectFees(address indexed admin, ISablierMerkleBase indexed merkleBase, uint256 feeAmount);
/// @notice Emitted when a {SablierMerkleInstant} campaign is created.
event CreateMerkleInstant(
ISablierMerkleInstant indexed merkleInstant,
MerkleBase.ConstructorParams baseParams,
uint256 aggregateAmount,
uint256 recipientCount,
uint256 fee
);
/// @notice Emitted when a {SablierMerkleLL} campaign is created.
event CreateMerkleLL(
ISablierMerkleLL indexed merkleLL,
MerkleBase.ConstructorParams baseParams,
ISablierLockup lockup,
bool cancelable,
bool transferable,
MerkleLL.Schedule schedule,
uint256 aggregateAmount,
uint256 recipientCount,
uint256 fee
);
/// @notice Emitted when a {SablierMerkleLT} campaign is created.
event CreateMerkleLT(
ISablierMerkleLT indexed merkleLT,
MerkleBase.ConstructorParams baseParams,
ISablierLockup lockup,
bool cancelable,
bool transferable,
uint40 streamStartTime,
MerkleLT.TrancheWithPercentage[] tranchesWithPercentages,
uint256 totalDuration,
uint256 aggregateAmount,
uint256 recipientCount,
uint256 fee
);
/// @notice Emitted when the admin resets the custom fee for the provided campaign creator to the default fee.
event ResetCustomFee(address indexed admin, address indexed campaignCreator);
/// @notice Emitted when the admin sets a custom fee for the provided campaign creator.
event SetCustomFee(address indexed admin, address indexed campaignCreator, uint256 customFee);
/// @notice Emitted when the default fee is set by the admin.
event SetDefaultFee(address indexed admin, uint256 defaultFee);
/*//////////////////////////////////////////////////////////////////////////
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Retrieves the default fee charged for claiming an airdrop.
/// @dev The fee is denominated in the native token of the chain, e.g., ETH for Ethereum Mainnet.
function defaultFee() external view returns (uint256);
/// @notice Retrieves the custom fee struct for the provided campaign creator.
/// @dev The fee is denominated in the native token of the chain, e.g., ETH for Ethereum Mainnet.
/// @param campaignCreator The address of the campaign creator.
function getCustomFee(address campaignCreator) external view returns (MerkleFactory.CustomFee memory);
/// @notice Retrieves the fee for the provided campaign creator, using the default fee if no custom fee is set.
/// @dev The fee is denominated in the native token of the chain, e.g., ETH for Ethereum Mainnet.
/// @param campaignCreator The address of the campaign creator.
function getFee(address campaignCreator) external view returns (uint256);
/// @notice Verifies if the sum of percentages in `tranches` equals 100%, i.e., 1e18.
/// @dev This is a helper function for the frontend. It is not used anywhere in the contracts.
/// @param tranches The tranches with their respective unlock percentages.
/// @return result True if the sum of percentages equals 100%, otherwise false.
function isPercentagesSum100(MerkleLT.TrancheWithPercentage[] calldata tranches)
external
pure
returns (bool result);
/*//////////////////////////////////////////////////////////////////////////
NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Collects the fees accrued in the `merkleBase` contract, and transfers them to the factory admin.
/// @dev Emits a {CollectFees} event.
///
/// Notes:
/// - If the admin is a contract, it must be able to receive native token payments, e.g., ETH for Ethereum Mainnet.
///
/// @param merkleBase The address of the Merkle contract where the fees are collected from.
function collectFees(ISablierMerkleBase merkleBase) external;
/// @notice Creates a new MerkleInstant campaign for instant distribution of tokens.
///
/// @dev Emits a {CreateMerkleInstant} event.
///
/// Notes:
/// - The MerkleInstant contract is created with CREATE2.
/// - The immutable fee will be set to the default value unless a custom fee is set.
///
/// @param baseParams Struct encapsulating the {SablierMerkleBase} parameters, which are documented in
/// {DataTypes}.
/// @param aggregateAmount The total amount of ERC-20 tokens to be distributed to all recipients.
/// @param recipientCount The total number of recipients who are eligible to claim.
/// @return merkleInstant The address of the newly created MerkleInstant contract.
function createMerkleInstant(
MerkleBase.ConstructorParams memory baseParams,
uint256 aggregateAmount,
uint256 recipientCount
)
external
returns (ISablierMerkleInstant merkleInstant);
/// @notice Creates a new Merkle Lockup campaign with a Lockup Linear distribution.
///
/// @dev Emits a {CreateMerkleLL} event.
///
/// Notes:
/// - The MerkleLL contract is created with CREATE2.
/// - The immutable fee will be set to the default value unless a custom fee is set.
///
/// @param baseParams Struct encapsulating the {SablierMerkleBase} parameters, which are documented in
/// {DataTypes}.
/// @param lockup The address of the {SablierLockup} contract.
/// @param cancelable Indicates if the stream will be cancelable after claiming.
/// @param transferable Indicates if the stream will be transferable after claiming.
/// @param schedule Struct encapsulating the unlocks schedule, which are documented in {DataTypes}.
/// @param aggregateAmount The total amount of ERC-20 tokens to be distributed to all recipients.
/// @param recipientCount The total number of recipients who are eligible to claim.
/// @return merkleLL The address of the newly created Merkle Lockup contract.
function createMerkleLL(
MerkleBase.ConstructorParams memory baseParams,
ISablierLockup lockup,
bool cancelable,
bool transferable,
MerkleLL.Schedule memory schedule,
uint256 aggregateAmount,
uint256 recipientCount
)
external
returns (ISablierMerkleLL merkleLL);
/// @notice Creates a new Merkle Lockup campaign with a Lockup Tranched distribution.
///
/// @dev Emits a {CreateMerkleLT} event.
///
/// Notes:
/// - The MerkleLT contract is created with CREATE2.
/// - The immutable fee will be set to the default value unless a custom fee is set.
///
/// @param baseParams Struct encapsulating the {SablierMerkleBase} parameters, which are documented in
/// {DataTypes}.
/// @param lockup The address of the {SablierLockup} contract.
/// @param cancelable Indicates if the stream will be cancelable after claiming.
/// @param transferable Indicates if the stream will be transferable after claiming.
/// @param streamStartTime The start time of the streams created through {SablierMerkleBase.claim}.
/// @param tranchesWithPercentages The tranches with their respective unlock percentages.
/// @param aggregateAmount The total amount of ERC-20 tokens to be distributed to all recipients.
/// @param recipientCount The total number of recipients who are eligible to claim.
/// @return merkleLT The address of the newly created Merkle Lockup contract.
function createMerkleLT(
MerkleBase.ConstructorParams memory baseParams,
ISablierLockup lockup,
bool cancelable,
bool transferable,
uint40 streamStartTime,
MerkleLT.TrancheWithPercentage[] memory tranchesWithPercentages,
uint256 aggregateAmount,
uint256 recipientCount
)
external
returns (ISablierMerkleLT merkleLT);
/// @notice Resets the custom fee for the provided campaign creator to the default fee.
/// @dev Emits a {ResetCustomFee} event.
///
/// Notes:
/// - The default fee will only be applied to future campaigns.
///
/// Requirements:
/// - `msg.sender` must be the admin.
///
/// @param campaignCreator The user for whom the fee is reset for.
function resetCustomFee(address campaignCreator) external;
/// @notice Sets a custom fee for the provided campaign creator.
/// @dev Emits a {SetCustomFee} event.
///
/// Notes:
/// - The new fee will only be applied to future campaigns.
///
/// Requirements:
/// - `msg.sender` must be the admin.
///
/// @param campaignCreator The user for whom the fee is set.
/// @param newFee The new fee to be set.
function setCustomFee(address campaignCreator, uint256 newFee) external;
/// @notice Sets the default fee to be applied when claiming airdrops.
/// @dev Emits a {SetDefaultFee} event.
///
/// Notes:
/// - The new default fee will only be applied to the future campaigns and will not affect the ones already
/// deployed.
///
/// Requirements:
/// - `msg.sender` must be the admin.
///
/// @param defaultFee The new default fee to be set.
function setDefaultFee(uint256 defaultFee) external;
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { ISablierMerkleBase } from "./ISablierMerkleBase.sol";
/// @title ISablierMerkleInstant
/// @notice MerkleInstant enables airdrop distributions where the tokens are claimed directly to the users' wallets.
interface ISablierMerkleInstant is ISablierMerkleBase {
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when a recipient claims an instant airdrop.
event Claim(uint256 index, address indexed recipient, uint128 amount);
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { ISablierLockup } from "@sablier/lockup/src/interfaces/ISablierLockup.sol";
import { MerkleLL } from "./../types/DataTypes.sol";
import { ISablierMerkleBase } from "./ISablierMerkleBase.sol";
/// @title ISablierMerkleLL
/// @notice Merkle Lockup enables airdrops with a vesting period powered by the Lockup Linear distribution model.
interface ISablierMerkleLL is ISablierMerkleBase {
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when a recipient claims a stream.
event Claim(uint256 index, address indexed recipient, uint128 amount, uint256 indexed streamId);
/*//////////////////////////////////////////////////////////////////////////
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice The address of the {SablierLockup} contract.
function LOCKUP() external view returns (ISablierLockup);
/// @notice A flag indicating whether the streams can be canceled.
/// @dev This is an immutable state variable.
function STREAM_CANCELABLE() external returns (bool);
/// @notice A flag indicating whether the stream NFTs are transferable.
/// @dev This is an immutable state variable.
function STREAM_TRANSFERABLE() external returns (bool);
/// @notice A tuple containing the start time, start unlock percentage, cliff duration, cliff unlock percentage, and
/// end duration. These values are used to calculate the vesting schedule in `Lockup.CreateWithTimestampsLL`.
/// @dev A start time value of zero will be considered as `block.timestamp`.
function getSchedule() external view returns (MerkleLL.Schedule memory);
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { ISablierLockup } from "@sablier/lockup/src/interfaces/ISablierLockup.sol";
import { MerkleLT } from "./../types/DataTypes.sol";
import { ISablierMerkleBase } from "./ISablierMerkleBase.sol";
/// @title ISablierMerkleLT
/// @notice Merkle Lockup enables airdrops with a vesting period powered by the Lockup Tranched distribution model.
interface ISablierMerkleLT is ISablierMerkleBase {
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when a recipient claims a stream.
event Claim(uint256 index, address indexed recipient, uint128 amount, uint256 indexed streamId);
/*//////////////////////////////////////////////////////////////////////////
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice The address of the {SablierLockup} contract.
function LOCKUP() external view returns (ISablierLockup);
/// @notice A flag indicating whether the streams can be canceled.
/// @dev This is an immutable state variable.
function STREAM_CANCELABLE() external returns (bool);
/// @notice The start time of the streams created through {SablierMerkleBase.claim} function.
/// @dev A start time value of zero will be treated as `block.timestamp`.
function STREAM_START_TIME() external returns (uint40);
/// @notice A flag indicating whether the stream NFTs are transferable.
/// @dev This is an immutable state variable.
function STREAM_TRANSFERABLE() external returns (bool);
/// @notice The total percentage of the tranches.
function TOTAL_PERCENTAGE() external view returns (uint64);
/// @notice Retrieves the tranches with their respective unlock percentages and durations.
function getTranchesWithPercentages() external view returns (MerkleLT.TrancheWithPercentage[] memory);
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { SablierMerkleBase } from "./abstracts/SablierMerkleBase.sol";
import { ISablierMerkleInstant } from "./interfaces/ISablierMerkleInstant.sol";
import { MerkleBase } from "./types/DataTypes.sol";
/*
███████╗ █████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔════╝██╔══██╗██╔══██╗██║ ██║██╔════╝██╔══██╗
███████╗███████║██████╔╝██║ ██║█████╗ ██████╔╝
╚════██║██╔══██║██╔══██╗██║ ██║██╔══╝ ██╔══██╗
███████║██║ ██║██████╔╝███████╗██║███████╗██║ ██║
╚══════╝╚═╝ ╚═╝╚═════╝ ╚══════╝╚═╝╚══════╝╚═╝ ╚═╝
███╗ ███╗███████╗██████╗ ██╗ ██╗██╗ ███████╗ ██╗███╗ ██╗███████╗████████╗ █████╗ ███╗ ██╗████████╗
████╗ ████║██╔════╝██╔══██╗██║ ██╔╝██║ ██╔════╝ ██║████╗ ██║██╔════╝╚══██╔══╝██╔══██╗████╗ ██║╚══██╔══╝
██╔████╔██║█████╗ ██████╔╝█████╔╝ ██║ █████╗ ██║██╔██╗ ██║███████╗ ██║ ███████║██╔██╗ ██║ ██║
██║╚██╔╝██║██╔══╝ ██╔══██╗██╔═██╗ ██║ ██╔══╝ ██║██║╚██╗██║╚════██║ ██║ ██╔══██║██║╚██╗██║ ██║
██║ ╚═╝ ██║███████╗██║ ██║██║ ██╗███████╗███████╗ ██║██║ ╚████║███████║ ██║ ██║ ██║██║ ╚████║ ██║
╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝╚══════╝╚══════╝ ╚═╝╚═╝ ╚═══╝╚══════╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═══╝ ╚═╝
*/
/// @title SablierMerkleInstant
/// @notice See the documentation in {ISablierMerkleInstant}.
contract SablierMerkleInstant is
ISablierMerkleInstant, // 2 inherited components
SablierMerkleBase // 4 inherited components
{
using SafeERC20 for IERC20;
/*//////////////////////////////////////////////////////////////////////////
CONSTRUCTOR
//////////////////////////////////////////////////////////////////////////*/
/// @dev Constructs the contract by initializing the immutable state variables.
constructor(
MerkleBase.ConstructorParams memory baseParams,
address campaignCreator
)
SablierMerkleBase(baseParams, campaignCreator)
{ }
/*//////////////////////////////////////////////////////////////////////////
INTERNAL NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc SablierMerkleBase
function _claim(uint256 index, address recipient, uint128 amount) internal override {
// Interaction: withdraw the tokens to the recipient.
TOKEN.safeTransfer(recipient, amount);
// Log the claim.
emit Claim(index, recipient, amount);
}
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { ud60x18, ZERO } from "@prb/math/src/UD60x18.sol";
import { ISablierLockup } from "@sablier/lockup/src/interfaces/ISablierLockup.sol";
import { Broker, Lockup, LockupLinear } from "@sablier/lockup/src/types/DataTypes.sol";
import { SablierMerkleBase } from "./abstracts/SablierMerkleBase.sol";
import { ISablierMerkleLL } from "./interfaces/ISablierMerkleLL.sol";
import { MerkleBase, MerkleLL } from "./types/DataTypes.sol";
/*
███████╗ █████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔════╝██╔══██╗██╔══██╗██║ ██║██╔════╝██╔══██╗
███████╗███████║██████╔╝██║ ██║█████╗ ██████╔╝
╚════██║██╔══██║██╔══██╗██║ ██║██╔══╝ ██╔══██╗
███████║██║ ██║██████╔╝███████╗██║███████╗██║ ██║
╚══════╝╚═╝ ╚═╝╚═════╝ ╚══════╝╚═╝╚══════╝╚═╝ ╚═╝
███╗ ███╗███████╗██████╗ ██╗ ██╗██╗ ███████╗ ██╗ ██╗
████╗ ████║██╔════╝██╔══██╗██║ ██╔╝██║ ██╔════╝ ██║ ██║
██╔████╔██║█████╗ ██████╔╝█████╔╝ ██║ █████╗ ██║ ██║
██║╚██╔╝██║██╔══╝ ██╔══██╗██╔═██╗ ██║ ██╔══╝ ██║ ██║
██║ ╚═╝ ██║███████╗██║ ██║██║ ██╗███████╗███████╗ ███████╗███████╗
╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝╚══════╝╚══════╝ ╚══════╝╚══════╝
*/
/// @title SablierMerkleLL
/// @notice See the documentation in {ISablierMerkleLL}.
contract SablierMerkleLL is
ISablierMerkleLL, // 2 inherited components
SablierMerkleBase // 4 inherited components
{
using SafeERC20 for IERC20;
/*//////////////////////////////////////////////////////////////////////////
STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierMerkleLL
ISablierLockup public immutable override LOCKUP;
/// @inheritdoc ISablierMerkleLL
bool public immutable override STREAM_CANCELABLE;
/// @inheritdoc ISablierMerkleLL
bool public immutable override STREAM_TRANSFERABLE;
/// @dev See the documentation in {ISablierMerkleLL.getSchedule}.
MerkleLL.Schedule private _schedule;
/*//////////////////////////////////////////////////////////////////////////
CONSTRUCTOR
//////////////////////////////////////////////////////////////////////////*/
/// @dev Constructs the contract by initializing the immutable state variables, and max approving the Lockup
/// contract.
constructor(
MerkleBase.ConstructorParams memory baseParams,
address campaignCreator,
ISablierLockup lockup,
bool cancelable,
bool transferable,
MerkleLL.Schedule memory schedule
)
SablierMerkleBase(baseParams, campaignCreator)
{
LOCKUP = lockup;
STREAM_CANCELABLE = cancelable;
STREAM_TRANSFERABLE = transferable;
_schedule = schedule;
// Max approve the Lockup contract to spend funds from the MerkleLL contract.
TOKEN.forceApprove(address(LOCKUP), type(uint256).max);
}
/*//////////////////////////////////////////////////////////////////////////
USER-FACING CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierMerkleLL
function getSchedule() external view override returns (MerkleLL.Schedule memory) {
return _schedule;
}
/*//////////////////////////////////////////////////////////////////////////
INTERNAL NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc SablierMerkleBase
function _claim(uint256 index, address recipient, uint128 amount) internal override {
// Calculate the timestamps for the stream.
Lockup.Timestamps memory timestamps;
if (_schedule.startTime == 0) {
timestamps.start = uint40(block.timestamp);
} else {
timestamps.start = _schedule.startTime;
}
uint40 cliffTime;
if (_schedule.cliffDuration > 0) {
cliffTime = timestamps.start + _schedule.cliffDuration;
}
timestamps.end = timestamps.start + _schedule.totalDuration;
// Calculate the unlock amounts based on the percentages.
LockupLinear.UnlockAmounts memory unlockAmounts;
unlockAmounts.start = ud60x18(amount).mul(_schedule.startPercentage.intoUD60x18()).intoUint128();
unlockAmounts.cliff = ud60x18(amount).mul(_schedule.cliffPercentage.intoUD60x18()).intoUint128();
// Interaction: create the stream via {SablierLockup}.
uint256 streamId = LOCKUP.createWithTimestampsLL(
Lockup.CreateWithTimestamps({
sender: admin,
recipient: recipient,
totalAmount: amount,
token: TOKEN,
cancelable: STREAM_CANCELABLE,
transferable: STREAM_TRANSFERABLE,
timestamps: timestamps,
shape: string(abi.encodePacked(SHAPE)),
broker: Broker({ account: address(0), fee: ZERO })
}),
unlockAmounts,
cliffTime
);
// Log the claim.
emit Claim(index, recipient, amount, streamId);
}
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { uUNIT } from "@prb/math/src/UD2x18.sol";
import { UD60x18, ud60x18, ZERO } from "@prb/math/src/UD60x18.sol";
import { ISablierLockup } from "@sablier/lockup/src/interfaces/ISablierLockup.sol";
import { Broker, Lockup, LockupTranched } from "@sablier/lockup/src/types/DataTypes.sol";
import { SablierMerkleBase } from "./abstracts/SablierMerkleBase.sol";
import { ISablierMerkleLT } from "./interfaces/ISablierMerkleLT.sol";
import { Errors } from "./libraries/Errors.sol";
import { MerkleBase, MerkleLT } from "./types/DataTypes.sol";
/*
███████╗ █████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔════╝██╔══██╗██╔══██╗██║ ██║██╔════╝██╔══██╗
███████╗███████║██████╔╝██║ ██║█████╗ ██████╔╝
╚════██║██╔══██║██╔══██╗██║ ██║██╔══╝ ██╔══██╗
███████║██║ ██║██████╔╝███████╗██║███████╗██║ ██║
╚══════╝╚═╝ ╚═╝╚═════╝ ╚══════╝╚═╝╚══════╝╚═╝ ╚═╝
███╗ ███╗███████╗██████╗ ██╗ ██╗██╗ ███████╗ ██╗ ████████╗
████╗ ████║██╔════╝██╔══██╗██║ ██╔╝██║ ██╔════╝ ██║ ╚══██╔══╝
██╔████╔██║█████╗ ██████╔╝█████╔╝ ██║ █████╗ ██║ ██║
██║╚██╔╝██║██╔══╝ ██╔══██╗██╔═██╗ ██║ ██╔══╝ ██║ ██║
██║ ╚═╝ ██║███████╗██║ ██║██║ ██╗███████╗███████╗ ███████╗ ██║
╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝╚══════╝╚══════╝ ╚══════╝ ╚═╝
*/
/// @title SablierMerkleLT
/// @notice See the documentation in {ISablierMerkleLT}.
contract SablierMerkleLT is
ISablierMerkleLT, // 2 inherited components
SablierMerkleBase // 4 inherited components
{
using SafeERC20 for IERC20;
/*//////////////////////////////////////////////////////////////////////////
STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierMerkleLT
ISablierLockup public immutable override LOCKUP;
/// @inheritdoc ISablierMerkleLT
bool public immutable override STREAM_CANCELABLE;
/// @inheritdoc ISablierMerkleLT
uint40 public immutable override STREAM_START_TIME;
/// @inheritdoc ISablierMerkleLT
bool public immutable override STREAM_TRANSFERABLE;
/// @inheritdoc ISablierMerkleLT
uint64 public immutable override TOTAL_PERCENTAGE;
/// @dev The tranches with their respective unlock percentages and durations.
MerkleLT.TrancheWithPercentage[] internal _tranchesWithPercentages;
/*//////////////////////////////////////////////////////////////////////////
CONSTRUCTOR
//////////////////////////////////////////////////////////////////////////*/
/// @dev Constructs the contract by initializing the immutable state variables, and max approving the Lockup
/// contract.
constructor(
MerkleBase.ConstructorParams memory baseParams,
address campaignCreator,
ISablierLockup lockup,
bool cancelable,
bool transferable,
uint40 streamStartTime,
MerkleLT.TrancheWithPercentage[] memory tranchesWithPercentages
)
SablierMerkleBase(baseParams, campaignCreator)
{
STREAM_CANCELABLE = cancelable;
LOCKUP = lockup;
STREAM_START_TIME = streamStartTime;
STREAM_TRANSFERABLE = transferable;
uint256 count = tranchesWithPercentages.length;
// Calculate the total percentage of the tranches and save them in the contract state.
uint64 totalPercentage;
for (uint256 i = 0; i < count; ++i) {
uint64 percentage = tranchesWithPercentages[i].unlockPercentage.unwrap();
totalPercentage += percentage;
_tranchesWithPercentages.push(tranchesWithPercentages[i]);
}
TOTAL_PERCENTAGE = totalPercentage;
// Max approve the Lockup contract to spend funds from the MerkleLT contract.
TOKEN.forceApprove(address(LOCKUP), type(uint256).max);
}
/*//////////////////////////////////////////////////////////////////////////
USER-FACING CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierMerkleLT
function getTranchesWithPercentages() external view override returns (MerkleLT.TrancheWithPercentage[] memory) {
return _tranchesWithPercentages;
}
/*//////////////////////////////////////////////////////////////////////////
INTERNAL NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc SablierMerkleBase
function _claim(uint256 index, address recipient, uint128 amount) internal override {
// Check: the sum of percentages equals 100%.
if (TOTAL_PERCENTAGE != uUNIT) {
revert Errors.SablierMerkleLT_TotalPercentageNotOneHundred(TOTAL_PERCENTAGE);
}
// Calculate the tranches based on the unlock percentages.
(uint40 startTime, LockupTranched.Tranche[] memory tranches) = _calculateStartTimeAndTranches(amount);
// Calculate the stream's end time.
uint40 endTime;
unchecked {
endTime = tranches[tranches.length - 1].timestamp;
}
// Interaction: create the stream via {SablierLockup-createWithTimestampsLT}.
uint256 streamId = LOCKUP.createWithTimestampsLT(
Lockup.CreateWithTimestamps({
sender: admin,
recipient: recipient,
totalAmount: amount,
token: TOKEN,
cancelable: STREAM_CANCELABLE,
transferable: STREAM_TRANSFERABLE,
timestamps: Lockup.Timestamps({ start: startTime, end: endTime }),
shape: string(abi.encodePacked(SHAPE)),
broker: Broker({ account: address(0), fee: ZERO })
}),
tranches
);
// Log the claim.
emit Claim(index, recipient, amount, streamId);
}
/*//////////////////////////////////////////////////////////////////////////
INTERNAL CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @dev Calculates the start time, and the tranches based on the claim amount and the unlock percentages for each
/// tranche.
function _calculateStartTimeAndTranches(uint128 claimAmount)
internal
view
returns (uint40 startTime, LockupTranched.Tranche[] memory tranches)
{
// Calculate the start time.
if (STREAM_START_TIME == 0) {
startTime = uint40(block.timestamp);
} else {
startTime = STREAM_START_TIME;
}
// Load the tranches in memory (to save gas).
MerkleLT.TrancheWithPercentage[] memory tranchesWithPercentages = _tranchesWithPercentages;
// Declare the variables needed for calculation.
uint128 calculatedAmountsSum;
UD60x18 claimAmountUD = ud60x18(claimAmount);
uint256 trancheCount = tranchesWithPercentages.length;
tranches = new LockupTranched.Tranche[](trancheCount);
unchecked {
// Convert the tranche's percentage from the `UD2x18` to the `UD60x18` type.
UD60x18 percentage = (tranchesWithPercentages[0].unlockPercentage).intoUD60x18();
// Calculate the tranche's amount by multiplying the claim amount by the unlock percentage.
uint128 calculatedAmount = claimAmountUD.mul(percentage).intoUint128();
// The first tranche is precomputed because it is needed in the for loop below.
tranches[0] = LockupTranched.Tranche({
amount: calculatedAmount,
timestamp: startTime + tranchesWithPercentages[0].duration
});
// Add the calculated tranche amount.
calculatedAmountsSum += calculatedAmount;
// Iterate over each tranche to calculate its timestamp and unlock amount.
for (uint256 i = 1; i < trancheCount; ++i) {
percentage = (tranchesWithPercentages[i].unlockPercentage).intoUD60x18();
calculatedAmount = claimAmountUD.mul(percentage).intoUint128();
tranches[i] = LockupTranched.Tranche({
amount: calculatedAmount,
timestamp: tranches[i - 1].timestamp + tranchesWithPercentages[i].duration
});
calculatedAmountsSum += calculatedAmount;
}
}
// Since there can be rounding errors, the last tranche amount needs to be adjusted to ensure the sum of all
// tranche amounts equals the claim amount.
if (calculatedAmountsSum < claimAmount) {
unchecked {
tranches[trancheCount - 1].amount += claimAmount - calculatedAmountsSum;
}
}
}
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { UD2x18 } from "@prb/math/src/UD2x18.sol";
library MerkleBase {
/// @notice Struct encapsulating the base constructor parameters of a Merkle campaign.
/// @param token The contract address of the ERC-20 token to be distributed.
/// @param expiration The expiration of the campaign, as a Unix timestamp. A value of zero means the campaign does
/// not expire.
/// @param initialAdmin The initial admin of the campaign.
/// @param ipfsCID The content identifier for indexing the contract on IPFS.
/// @param merkleRoot The Merkle root of the claim data.
/// @param campaignName The name of the campaign. It is truncated if exceeding 32 bytes
/// @param shape The shape of Lockup stream is used for differentiating between streams in the UI. It is truncated
/// if exceeding 32 bytes.
struct ConstructorParams {
IERC20 token;
uint40 expiration;
address initialAdmin;
string ipfsCID;
bytes32 merkleRoot;
string campaignName;
string shape;
}
}
library MerkleFactory {
/// @notice Struct encapsulating the custom fee details for a given campaign creator.
/// @param enabled Whether the fee is enabled. If false, the default fee will be applied for campaigns created by
/// the given creator.
/// @param fee The fee amount.
struct CustomFee {
bool enabled;
uint256 fee;
}
}
library MerkleLL {
/// @notice Struct encapsulating the start time, cliff duration and the end duration used to construct the time
/// variables in `Lockup.CreateWithTimestampsLL`.
/// @dev A start time value of zero will be considered as `block.timestamp`.
/// @param startTime The start time of the stream.
/// @param startPercentage The percentage to be unlocked at the start time.
/// @param cliffDuration The duration of the cliff.
/// @param cliffPercentage The percentage to be unlocked at the cliff time.
/// @param totalDuration The total duration of the stream.
struct Schedule {
uint40 startTime;
UD2x18 startPercentage;
uint40 cliffDuration;
UD2x18 cliffPercentage;
uint40 totalDuration;
}
}
library MerkleLT {
/// @notice Struct encapsulating the unlock percentage and duration of a tranche.
/// @dev Since users may have different amounts allocated, this struct makes it possible to calculate the amounts
/// at claim time. An 18-decimal format is used to represent percentages: 100% = 1e18. For more information, see
/// the PRBMath documentation on UD2x18: https://github.com/PaulRBerg/prb-math
/// @param unlockPercentage The percentage designated to be unlocked in this tranche.
/// @param duration The time difference in seconds between this tranche and the previous one.
struct TrancheWithPercentage {
// slot 0
UD2x18 unlockPercentage;
uint40 duration;
}
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "../Common.sol" as Common;
import "./Errors.sol" as Errors;
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";
import { UD2x18 } from "./ValueType.sol";
/// @notice Casts a UD2x18 number into SD59x18.
/// @dev There is no overflow check because UD2x18 ⊆ SD59x18.
function intoSD59x18(UD2x18 x) pure returns (SD59x18 result) {
result = SD59x18.wrap(int256(uint256(UD2x18.unwrap(x))));
}
/// @notice Casts a UD2x18 number into UD60x18.
/// @dev There is no overflow check because UD2x18 ⊆ UD60x18.
function intoUD60x18(UD2x18 x) pure returns (UD60x18 result) {
result = UD60x18.wrap(UD2x18.unwrap(x));
}
/// @notice Casts a UD2x18 number into uint128.
/// @dev There is no overflow check because UD2x18 ⊆ uint128.
function intoUint128(UD2x18 x) pure returns (uint128 result) {
result = uint128(UD2x18.unwrap(x));
}
/// @notice Casts a UD2x18 number into uint256.
/// @dev There is no overflow check because UD2x18 ⊆ uint256.
function intoUint256(UD2x18 x) pure returns (uint256 result) {
result = uint256(UD2x18.unwrap(x));
}
/// @notice Casts a UD2x18 number into uint40.
/// @dev Requirements:
/// - x ≤ MAX_UINT40
function intoUint40(UD2x18 x) pure returns (uint40 result) {
uint64 xUint = UD2x18.unwrap(x);
if (xUint > uint64(Common.MAX_UINT40)) {
revert Errors.PRBMath_UD2x18_IntoUint40_Overflow(x);
}
result = uint40(xUint);
}
/// @notice Alias for {wrap}.
function ud2x18(uint64 x) pure returns (UD2x18 result) {
result = UD2x18.wrap(x);
}
/// @notice Unwrap a UD2x18 number into uint64.
function unwrap(UD2x18 x) pure returns (uint64 result) {
result = UD2x18.unwrap(x);
}
/// @notice Wraps a uint64 number into UD2x18.
function wrap(uint64 x) pure returns (UD2x18 result) {
result = UD2x18.wrap(x);
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { UD2x18 } from "./ValueType.sol";
/// @dev Euler's number as a UD2x18 number.
UD2x18 constant E = UD2x18.wrap(2_718281828459045235);
/// @dev The maximum value a UD2x18 number can have.
uint64 constant uMAX_UD2x18 = 18_446744073709551615;
UD2x18 constant MAX_UD2x18 = UD2x18.wrap(uMAX_UD2x18);
/// @dev PI as a UD2x18 number.
UD2x18 constant PI = UD2x18.wrap(3_141592653589793238);
/// @dev The unit number, which gives the decimal precision of UD2x18.
UD2x18 constant UNIT = UD2x18.wrap(1e18);
uint64 constant uUNIT = 1e18;// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { UD2x18 } from "./ValueType.sol";
/// @notice Thrown when trying to cast a UD2x18 number that doesn't fit in uint40.
error PRBMath_UD2x18_IntoUint40_Overflow(UD2x18 x);// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "./Casting.sol" as Casting;
/// @notice The unsigned 2.18-decimal fixed-point number representation, which can have up to 2 digits and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the underlying Solidity
/// type uint64. This is useful when end users want to use uint64 to save gas, e.g. with tight variable packing in contract
/// storage.
type UD2x18 is uint64;
/*//////////////////////////////////////////////////////////////////////////
CASTING
//////////////////////////////////////////////////////////////////////////*/
using {
Casting.intoSD59x18,
Casting.intoUD60x18,
Casting.intoUint128,
Casting.intoUint256,
Casting.intoUint40,
Casting.unwrap
} for UD2x18 global;// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
/// @title IAdminable
/// @notice Contract module that provides a basic access control mechanism, with an admin that can be
/// granted exclusive access to specific functions. The inheriting contract must set the initial admin
/// in the constructor.
interface IAdminable {
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when the admin is transferred.
/// @param oldAdmin The address of the old admin.
/// @param newAdmin The address of the new admin.
event TransferAdmin(address indexed oldAdmin, address indexed newAdmin);
/*//////////////////////////////////////////////////////////////////////////
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice The address of the admin account or contract.
function admin() external view returns (address);
/*//////////////////////////////////////////////////////////////////////////
NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Transfers the contract admin to a new address.
///
/// @dev Notes:
/// - Does not revert if the admin is the same.
/// - This function can potentially leave the contract without an admin, thereby removing any
/// functionality that is only available to the admin.
///
/// Requirements:
/// - `msg.sender` must be the contract admin.
///
/// @param newAdmin The address of the new admin.
function transferAdmin(address newAdmin) external;
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
import { UD60x18 } from "@prb/math/src/UD60x18.sol";
import { Lockup } from "../types/DataTypes.sol";
/// @title Errors
/// @notice Library containing all custom errors the protocol may revert with.
library Errors {
/*//////////////////////////////////////////////////////////////////////////
GENERICS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Thrown when an unexpected error occurs during a batch call.
error BatchError(bytes errorData);
/// @notice Thrown when `msg.sender` is not the admin.
error CallerNotAdmin(address admin, address caller);
/// @notice Thrown when trying to delegate call to a function that disallows delegate calls.
error DelegateCall();
/*//////////////////////////////////////////////////////////////////////////
SABLIER-BATCH-LOCKUP
//////////////////////////////////////////////////////////////////////////*/
error SablierBatchLockup_BatchSizeZero();
/*//////////////////////////////////////////////////////////////////////////
LOCKUP-NFT-DESCRIPTOR
//////////////////////////////////////////////////////////////////////////*/
/// @notice Thrown when trying to generate the token URI for an unknown ERC-721 NFT contract.
error LockupNFTDescriptor_UnknownNFT(IERC721Metadata nft, string symbol);
/*//////////////////////////////////////////////////////////////////////////
HELPERS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Thrown when the broker fee exceeds the maximum allowed fee.
error SablierHelpers_BrokerFeeTooHigh(UD60x18 brokerFee, UD60x18 maxBrokerFee);
/// @notice Thrown when trying to create a linear stream with a cliff time not strictly less than the end time.
error SablierHelpers_CliffTimeNotLessThanEndTime(uint40 cliffTime, uint40 endTime);
/// @notice Thrown when trying to create a stream with a non zero cliff unlock amount when the cliff time is zero.
error SablierHelpers_CliffTimeZeroUnlockAmountNotZero(uint128 cliffUnlockAmount);
/// @notice Thrown when trying to create a dynamic stream with a deposit amount not equal to the sum of the segment
/// amounts.
error SablierHelpers_DepositAmountNotEqualToSegmentAmountsSum(uint128 depositAmount, uint128 segmentAmountsSum);
/// @notice Thrown when trying to create a tranched stream with a deposit amount not equal to the sum of the tranche
/// amounts.
error SablierHelpers_DepositAmountNotEqualToTrancheAmountsSum(uint128 depositAmount, uint128 trancheAmountsSum);
/// @notice Thrown when trying to create a stream with a zero deposit amount.
error SablierHelpers_DepositAmountZero();
/// @notice Thrown when trying to create a dynamic stream with end time not equal to the last segment's timestamp.
error SablierHelpers_EndTimeNotEqualToLastSegmentTimestamp(uint40 endTime, uint40 lastSegmentTimestamp);
/// @notice Thrown when trying to create a tranched stream with end time not equal to the last tranche's timestamp.
error SablierHelpers_EndTimeNotEqualToLastTrancheTimestamp(uint40 endTime, uint40 lastTrancheTimestamp);
/// @notice Thrown when trying to create a dynamic stream with more segments than the maximum allowed.
error SablierHelpers_SegmentCountTooHigh(uint256 count);
/// @notice Thrown when trying to create a dynamic stream with no segments.
error SablierHelpers_SegmentCountZero();
/// @notice Thrown when trying to create a dynamic stream with unordered segment timestamps.
error SablierHelpers_SegmentTimestampsNotOrdered(uint256 index, uint40 previousTimestamp, uint40 currentTimestamp);
/// @notice Thrown when trying to create a stream with the sender as the zero address.
error SablierHelpers_SenderZeroAddress();
/// @notice Thrown when trying to create a stream with a shape string exceeding 32 bytes.
error SablierHelpers_ShapeExceeds32Bytes(uint256 shapeLength);
/// @notice Thrown when trying to create a linear stream with a start time not strictly less than the cliff time,
/// when the cliff time does not have a zero value.
error SablierHelpers_StartTimeNotLessThanCliffTime(uint40 startTime, uint40 cliffTime);
/// @notice Thrown when trying to create a linear stream with a start time not strictly less than the end time.
error SablierHelpers_StartTimeNotLessThanEndTime(uint40 startTime, uint40 endTime);
/// @notice Thrown when trying to create a dynamic stream with a start time not strictly less than the first
/// segment timestamp.
error SablierHelpers_StartTimeNotLessThanFirstSegmentTimestamp(uint40 startTime, uint40 firstSegmentTimestamp);
/// @notice Thrown when trying to create a tranched stream with a start time not strictly less than the first
/// tranche timestamp.
error SablierHelpers_StartTimeNotLessThanFirstTrancheTimestamp(uint40 startTime, uint40 firstTrancheTimestamp);
/// @notice Thrown when trying to create a stream with a zero start time.
error SablierHelpers_StartTimeZero();
/// @notice Thrown when trying to create a tranched stream with more tranches than the maximum allowed.
error SablierHelpers_TrancheCountTooHigh(uint256 count);
/// @notice Thrown when trying to create a tranched stream with no tranches.
error SablierHelpers_TrancheCountZero();
/// @notice Thrown when trying to create a tranched stream with unordered tranche timestamps.
error SablierHelpers_TrancheTimestampsNotOrdered(uint256 index, uint40 previousTimestamp, uint40 currentTimestamp);
/// @notice Thrown when trying to create a stream with the sum of the unlock amounts greater than the deposit
/// amount.
error SablierHelpers_UnlockAmountsSumTooHigh(
uint128 depositAmount, uint128 startUnlockAmount, uint128 cliffUnlockAmount
);
/*//////////////////////////////////////////////////////////////////////////
SABLIER-LOCKUP-BASE
//////////////////////////////////////////////////////////////////////////*/
/// @notice Thrown when trying to allow to hook a contract that doesn't implement the interface correctly.
error SablierLockupBase_AllowToHookUnsupportedInterface(address recipient);
/// @notice Thrown when trying to allow to hook an address with no code.
error SablierLockupBase_AllowToHookZeroCodeSize(address recipient);
/// @notice Thrown when the fee transfer fails.
error SablierLockupBase_FeeTransferFail(address admin, uint256 feeAmount);
/// @notice Thrown when the hook does not return the correct selector.
error SablierLockupBase_InvalidHookSelector(address recipient);
/// @notice Thrown when trying to transfer Stream NFT when transferability is disabled.
error SablierLockupBase_NotTransferable(uint256 tokenId);
/// @notice Thrown when the ID references a null stream.
error SablierLockupBase_Null(uint256 streamId);
/// @notice Thrown when trying to withdraw an amount greater than the withdrawable amount.
error SablierLockupBase_Overdraw(uint256 streamId, uint128 amount, uint128 withdrawableAmount);
/// @notice Thrown when trying to cancel or renounce a canceled stream.
error SablierLockupBase_StreamCanceled(uint256 streamId);
/// @notice Thrown when trying to cancel, renounce, or withdraw from a depleted stream.
error SablierLockupBase_StreamDepleted(uint256 streamId);
/// @notice Thrown when trying to cancel or renounce a stream that is not cancelable.
error SablierLockupBase_StreamNotCancelable(uint256 streamId);
/// @notice Thrown when trying to burn a stream that is not depleted.
error SablierLockupBase_StreamNotDepleted(uint256 streamId);
/// @notice Thrown when trying to cancel or renounce a settled stream.
error SablierLockupBase_StreamSettled(uint256 streamId);
/// @notice Thrown when `msg.sender` lacks authorization to perform an action.
error SablierLockupBase_Unauthorized(uint256 streamId, address caller);
/// @notice Thrown when trying to withdraw to an address other than the recipient's.
error SablierLockupBase_WithdrawalAddressNotRecipient(uint256 streamId, address caller, address to);
/// @notice Thrown when trying to withdraw zero tokens from a stream.
error SablierLockupBase_WithdrawAmountZero(uint256 streamId);
/// @notice Thrown when trying to withdraw from multiple streams and the number of stream IDs does
/// not match the number of withdraw amounts.
error SablierLockupBase_WithdrawArrayCountsNotEqual(uint256 streamIdsCount, uint256 amountsCount);
/// @notice Thrown when trying to withdraw to the zero address.
error SablierLockupBase_WithdrawToZeroAddress(uint256 streamId);
/*//////////////////////////////////////////////////////////////////////////
SABLIER-LOCKUP
//////////////////////////////////////////////////////////////////////////*/
/// @notice Thrown when a function is called on a stream that does not use the expected Lockup model.
error SablierLockup_NotExpectedModel(Lockup.Model actualLockupModel, Lockup.Model expectedLockupModel);
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { UD2x18 } from "@prb/math/src/UD2x18.sol";
import { UD60x18 } from "@prb/math/src/UD60x18.sol";
// This file defines all structs used in Lockup, most of which are organized under three namespaces:
//
// - BatchLockup
// - Lockup
// - LockupDynamic
// - LockupLinear
// - LockupTranched
//
// You will notice that some structs contain "slot" annotations - they are used to indicate the
// storage layout of the struct. It is more gas efficient to group small data types together so
// that they fit in a single 32-byte slot.
/// @dev Namespace for the structs used in `BatchLockup` contract.
library BatchLockup {
/// @notice A struct encapsulating all parameters of {SablierLockup.createWithDurationsLD} except for the token.
struct CreateWithDurationsLD {
address sender;
address recipient;
uint128 totalAmount;
bool cancelable;
bool transferable;
LockupDynamic.SegmentWithDuration[] segmentsWithDuration;
string shape;
Broker broker;
}
/// @notice A struct encapsulating all parameters of {SablierLockup.createWithDurationsLL} except for the token.
struct CreateWithDurationsLL {
address sender;
address recipient;
uint128 totalAmount;
bool cancelable;
bool transferable;
LockupLinear.Durations durations;
LockupLinear.UnlockAmounts unlockAmounts;
string shape;
Broker broker;
}
/// @notice A struct encapsulating all parameters of {SablierLockup.createWithDurationsLT} except for the token.
struct CreateWithDurationsLT {
address sender;
address recipient;
uint128 totalAmount;
bool cancelable;
bool transferable;
LockupTranched.TrancheWithDuration[] tranchesWithDuration;
string shape;
Broker broker;
}
/// @notice A struct encapsulating all parameters of {SablierLockup.createWithTimestampsLD} except for the token.
struct CreateWithTimestampsLD {
address sender;
address recipient;
uint128 totalAmount;
bool cancelable;
bool transferable;
uint40 startTime;
LockupDynamic.Segment[] segments;
string shape;
Broker broker;
}
/// @notice A struct encapsulating all parameters of {SablierLockup.createWithTimestampsLL} except for the token.
struct CreateWithTimestampsLL {
address sender;
address recipient;
uint128 totalAmount;
bool cancelable;
bool transferable;
Lockup.Timestamps timestamps;
uint40 cliffTime;
LockupLinear.UnlockAmounts unlockAmounts;
string shape;
Broker broker;
}
/// @notice A struct encapsulating all parameters of {SablierLockup.createWithTimestampsLT} except for the token.
struct CreateWithTimestampsLT {
address sender;
address recipient;
uint128 totalAmount;
bool cancelable;
bool transferable;
uint40 startTime;
LockupTranched.Tranche[] tranches;
string shape;
Broker broker;
}
}
/// @notice Struct encapsulating the broker parameters passed to the create functions. Both can be set to zero.
/// @param account The address receiving the broker's fee.
/// @param fee The broker's percentage fee from the total amount, denoted as a fixed-point number where 1e18 is 100%.
struct Broker {
address account;
UD60x18 fee;
}
/// @notice Namespace for the structs used in all Lockup models.
library Lockup {
/// @notice Struct encapsulating the deposit, withdrawn, and refunded amounts, all denoted in units of the token's
/// decimals.
/// @dev Because the deposited and the withdrawn amount are often read together, declaring them in the same slot
/// saves gas.
/// @param deposited The initial amount deposited in the stream, net of broker fee.
/// @param withdrawn The cumulative amount withdrawn from the stream.
/// @param refunded The amount refunded to the sender. Unless the stream was canceled, this is always zero.
struct Amounts {
// slot 0
uint128 deposited;
uint128 withdrawn;
// slot 1
uint128 refunded;
}
/// @notice Struct encapsulating (i) the deposit amount and (ii) the broker fee amount, both denoted in units of the
/// token's decimals.
/// @param deposit The amount to deposit in the stream.
/// @param brokerFee The broker fee amount.
struct CreateAmounts {
uint128 deposit;
uint128 brokerFee;
}
/// @notice Struct encapsulating the common parameters emitted in the `Create` event.
/// @param funder The address which has funded the stream.
/// @param sender The address distributing the tokens, which is able to cancel the stream.
/// @param recipient The address receiving the tokens, as well as the NFT owner.
/// @param amounts Struct encapsulating (i) the deposit amount, and (ii) the broker fee amount, both denoted
/// in units of the token's decimals.
/// @param token The contract address of the ERC-20 token to be distributed.
/// @param cancelable Boolean indicating whether the stream is cancelable or not.
/// @param transferable Boolean indicating whether the stream NFT is transferable or not.
/// @param timestamps Struct encapsulating (i) the stream's start time and (ii) end time, all as Unix timestamps.
/// @param shape An optional parameter to specify the shape of the distribution function. This helps differentiate
/// streams in the UI.
/// @param broker The address of the broker who has helped create the stream, e.g. a front-end website.
struct CreateEventCommon {
address funder;
address sender;
address recipient;
Lockup.CreateAmounts amounts;
IERC20 token;
bool cancelable;
bool transferable;
Lockup.Timestamps timestamps;
string shape;
address broker;
}
/// @notice Struct encapsulating the parameters of the `createWithDurations` functions.
/// @param sender The address distributing the tokens, with the ability to cancel the stream. It doesn't have to be
/// the same as `msg.sender`.
/// @param recipient The address receiving the tokens, as well as the NFT owner.
/// @param totalAmount The total amount, including the deposit and any broker fee, denoted in units of the token's
/// decimals.
/// @param token The contract address of the ERC-20 token to be distributed.
/// @param cancelable Indicates if the stream is cancelable.
/// @param transferable Indicates if the stream NFT is transferable.
/// @param shape An optional parameter to specify the shape of the distribution function. This helps differentiate
/// streams in the UI.
/// @param broker Struct encapsulating (i) the address of the broker assisting in creating the stream, and (ii) the
/// percentage fee paid to the broker from `totalAmount`, denoted as a fixed-point number. Both can be set to zero.
struct CreateWithDurations {
address sender;
address recipient;
uint128 totalAmount;
IERC20 token;
bool cancelable;
bool transferable;
string shape;
Broker broker;
}
/// @notice Struct encapsulating the parameters of the `createWithTimestamps` functions.
/// @param sender The address distributing the tokens, with the ability to cancel the stream. It doesn't have to be
/// the same as `msg.sender`.
/// @param recipient The address receiving the tokens, as well as the NFT owner.
/// @param totalAmount The total amount, including the deposit and any broker fee, denoted in units of the token's
/// decimals.
/// @param token The contract address of the ERC-20 token to be distributed.
/// @param cancelable Indicates if the stream is cancelable.
/// @param transferable Indicates if the stream NFT is transferable.
/// @param timestamps Struct encapsulating (i) the stream's start time and (ii) end time, both as Unix timestamps.
/// @param shape An optional parameter to specify the shape of the distribution function. This helps differentiate
/// streams in the UI.
/// @param broker Struct encapsulating (i) the address of the broker assisting in creating the stream, and (ii) the
/// percentage fee paid to the broker from `totalAmount`, denoted as a fixed-point number. Both can be set to zero.
struct CreateWithTimestamps {
address sender;
address recipient;
uint128 totalAmount;
IERC20 token;
bool cancelable;
bool transferable;
Timestamps timestamps;
string shape;
Broker broker;
}
/// @notice Enum representing the different distribution models used to create lockup streams.
/// @dev These distribution models determine the vesting function used in the calculations of the unlocked tokens.
enum Model {
LOCKUP_LINEAR,
LOCKUP_DYNAMIC,
LOCKUP_TRANCHED
}
/// @notice Enum representing the different statuses of a stream.
/// @dev The status can have a "temperature":
/// 1. Warm: Pending, Streaming. The passage of time alone can change the status.
/// 2. Cold: Settled, Canceled, Depleted. The passage of time alone cannot change the status.
/// @custom:value0 PENDING Stream created but not started; tokens are in a pending state.
/// @custom:value1 STREAMING Active stream where tokens are currently being streamed.
/// @custom:value2 SETTLED All tokens have been streamed; recipient is due to withdraw them.
/// @custom:value3 CANCELED Canceled stream; remaining tokens await recipient's withdrawal.
/// @custom:value4 DEPLETED Depleted stream; all tokens have been withdrawn and/or refunded.
enum Status {
// Warm
PENDING,
STREAMING,
// Cold
SETTLED,
CANCELED,
DEPLETED
}
/// @notice A common data structure to be stored in all Lockup models.
/// @dev The fields are arranged like this to save gas via tight variable packing.
/// @param sender The address distributing the tokens, with the ability to cancel the stream.
/// @param startTime The Unix timestamp indicating the stream's start.
/// @param endTime The Unix timestamp indicating the stream's end.
/// @param isCancelable Boolean indicating if the stream is cancelable.
/// @param wasCanceled Boolean indicating if the stream was canceled.
/// @param token The contract address of the ERC-20 token to be distributed.
/// @param isDepleted Boolean indicating if the stream is depleted.
/// @param isStream Boolean indicating if the struct entity exists.
/// @param isTransferable Boolean indicating if the stream NFT is transferable.
/// @param lockupModel The distribution model of the stream.
/// @param amounts Struct encapsulating the deposit, withdrawn, and refunded amounts, both denoted in units of the
/// token's decimals.
struct Stream {
// slot 0
address sender;
uint40 startTime;
uint40 endTime;
bool isCancelable;
bool wasCanceled;
// slot 1
IERC20 token;
bool isDepleted;
bool isStream;
bool isTransferable;
Model lockupModel;
// slot 2 and 3
Amounts amounts;
}
/// @notice Struct encapsulating the Lockup timestamps.
/// @param start The Unix timestamp for the stream's start.
/// @param end The Unix timestamp for the stream's end.
struct Timestamps {
uint40 start;
uint40 end;
}
}
/// @notice Namespace for the structs used only in Lockup Dynamic model.
library LockupDynamic {
/// @notice Segment struct to be stored in the Lockup Dynamic model.
/// @param amount The amount of tokens streamed in the segment, denoted in units of the token's decimals.
/// @param exponent The exponent of the segment, denoted as a fixed-point number.
/// @param timestamp The Unix timestamp indicating the segment's end.
struct Segment {
// slot 0
uint128 amount;
UD2x18 exponent;
uint40 timestamp;
}
/// @notice Segment struct used at runtime in {SablierLockup.createWithDurationsLD} function.
/// @param amount The amount of tokens streamed in the segment, denoted in units of the token's decimals.
/// @param exponent The exponent of the segment, denoted as a fixed-point number.
/// @param duration The time difference in seconds between the segment and the previous one.
struct SegmentWithDuration {
uint128 amount;
UD2x18 exponent;
uint40 duration;
}
}
/// @notice Namespace for the structs used only in Lockup Linear model.
library LockupLinear {
/// @notice Struct encapsulating the cliff duration and the total duration used at runtime in
/// {SablierLockup.createWithDurationsLL} function.
/// @param cliff The cliff duration in seconds.
/// @param total The total duration in seconds.
struct Durations {
uint40 cliff;
uint40 total;
}
/// @notice Struct encapsulating the unlock amounts for the stream.
/// @dev The sum of `start` and `cliff` must be less than or equal to deposit amount. Both amounts can be zero.
/// @param start The amount to be unlocked at the start time.
/// @param cliff The amount to be unlocked at the cliff time.
struct UnlockAmounts {
// slot 0
uint128 start;
uint128 cliff;
}
}
/// @notice Namespace for the structs used only in Lockup Tranched model.
library LockupTranched {
/// @notice Tranche struct to be stored in the Lockup Tranched model.
/// @param amount The amount of tokens to be unlocked in the tranche, denoted in units of the token's decimals.
/// @param timestamp The Unix timestamp indicating the tranche's end.
struct Tranche {
// slot 0
uint128 amount;
uint40 timestamp;
}
/// @notice Tranche struct used at runtime in {SablierLockup.createWithDurationsLT} function.
/// @param amount The amount of tokens to be unlocked in the tranche, denoted in units of the token's decimals.
/// @param duration The time difference in seconds between the tranche and the previous one.
struct TrancheWithDuration {
uint128 amount;
uint40 duration;
}
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC4906 } from "@openzeppelin/contracts/interfaces/IERC4906.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
import { UD60x18 } from "@prb/math/src/UD60x18.sol";
import { Lockup } from "../types/DataTypes.sol";
import { IAdminable } from "./IAdminable.sol";
import { IBatch } from "./IBatch.sol";
import { ILockupNFTDescriptor } from "./ILockupNFTDescriptor.sol";
/// @title ISablierLockupBase
/// @notice Common logic between all Sablier Lockup contracts.
interface ISablierLockupBase is
IAdminable, // 0 inherited components
IBatch, // 0 inherited components
IERC4906, // 2 inherited components
IERC721Metadata // 2 inherited components
{
/*//////////////////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Emitted when the admin allows a new recipient contract to hook to Sablier.
/// @param admin The address of the current contract admin.
/// @param recipient The address of the recipient contract put on the allowlist.
event AllowToHook(address indexed admin, address recipient);
/// @notice Emitted when a stream is canceled.
/// @param streamId The ID of the stream.
/// @param sender The address of the stream's sender.
/// @param recipient The address of the stream's recipient.
/// @param token The contract address of the ERC-20 token that has been distributed.
/// @param senderAmount The amount of tokens refunded to the stream's sender, denoted in units of the token's
/// decimals.
/// @param recipientAmount The amount of tokens left for the stream's recipient to withdraw, denoted in units of the
/// token's decimals.
event CancelLockupStream(
uint256 streamId,
address indexed sender,
address indexed recipient,
IERC20 indexed token,
uint128 senderAmount,
uint128 recipientAmount
);
/// @notice Emitted when the accrued fees are collected.
/// @param admin The address of the current contract admin, which has received the fees.
/// @param feeAmount The amount of collected fees.
event CollectFees(address indexed admin, uint256 indexed feeAmount);
/// @notice Emitted when withdrawing from multiple streams and one particular withdrawal reverts.
/// @param streamId The stream ID that reverted during withdraw.
/// @param revertData The error data returned by the reverted withdraw.
event InvalidWithdrawalInWithdrawMultiple(uint256 streamId, bytes revertData);
/// @notice Emitted when a sender gives up the right to cancel a stream.
/// @param streamId The ID of the stream.
event RenounceLockupStream(uint256 indexed streamId);
/// @notice Emitted when the admin sets a new NFT descriptor contract.
/// @param admin The address of the current contract admin.
/// @param oldNFTDescriptor The address of the old NFT descriptor contract.
/// @param newNFTDescriptor The address of the new NFT descriptor contract.
event SetNFTDescriptor(
address indexed admin, ILockupNFTDescriptor oldNFTDescriptor, ILockupNFTDescriptor newNFTDescriptor
);
/// @notice Emitted when tokens are withdrawn from a stream.
/// @param streamId The ID of the stream.
/// @param to The address that has received the withdrawn tokens.
/// @param token The contract address of the ERC-20 token that has been withdrawn.
/// @param amount The amount of tokens withdrawn, denoted in units of the token's decimals.
event WithdrawFromLockupStream(uint256 indexed streamId, address indexed to, IERC20 indexed token, uint128 amount);
/*//////////////////////////////////////////////////////////////////////////
CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Retrieves the maximum broker fee that can be charged by the broker, denoted as a fixed-point
/// number where 1e18 is 100%.
/// @dev This value is hard coded as a constant.
function MAX_BROKER_FEE() external view returns (UD60x18);
/// @notice Retrieves the amount deposited in the stream, denoted in units of the token's decimals.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function getDepositedAmount(uint256 streamId) external view returns (uint128 depositedAmount);
/// @notice Retrieves the stream's end time, which is a Unix timestamp.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function getEndTime(uint256 streamId) external view returns (uint40 endTime);
/// @notice Retrieves the distribution models used to create the stream.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function getLockupModel(uint256 streamId) external view returns (Lockup.Model lockupModel);
/// @notice Retrieves the stream's recipient.
/// @dev Reverts if the NFT has been burned.
/// @param streamId The stream ID for the query.
function getRecipient(uint256 streamId) external view returns (address recipient);
/// @notice Retrieves the amount refunded to the sender after a cancellation, denoted in units of the token's
/// decimals. This amount is always zero unless the stream was canceled.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function getRefundedAmount(uint256 streamId) external view returns (uint128 refundedAmount);
/// @notice Retrieves the stream's sender.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function getSender(uint256 streamId) external view returns (address sender);
/// @notice Retrieves the stream's start time, which is a Unix timestamp.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function getStartTime(uint256 streamId) external view returns (uint40 startTime);
/// @notice Retrieves the address of the underlying ERC-20 token being distributed.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function getUnderlyingToken(uint256 streamId) external view returns (IERC20 token);
/// @notice Retrieves the amount withdrawn from the stream, denoted in units of the token's decimals.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function getWithdrawnAmount(uint256 streamId) external view returns (uint128 withdrawnAmount);
/// @notice Retrieves a flag indicating whether the provided address is a contract allowed to hook to Sablier
/// when a stream is canceled or when tokens are withdrawn.
/// @dev See {ISablierLockupRecipient} for more information.
function isAllowedToHook(address recipient) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream can be canceled. When the stream is cold, this
/// flag is always `false`.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function isCancelable(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream is cold, i.e. settled, canceled, or depleted.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function isCold(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream is depleted.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function isDepleted(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream exists.
/// @dev Does not revert if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function isStream(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream NFT can be transferred.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function isTransferable(uint256 streamId) external view returns (bool result);
/// @notice Retrieves a flag indicating whether the stream is warm, i.e. either pending or streaming.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function isWarm(uint256 streamId) external view returns (bool result);
/// @notice Counter for stream IDs, used in the create functions.
function nextStreamId() external view returns (uint256);
/// @notice Contract that generates the non-fungible token URI.
function nftDescriptor() external view returns (ILockupNFTDescriptor);
/// @notice Calculates the amount that the sender would be refunded if the stream were canceled, denoted in units
/// of the token's decimals.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function refundableAmountOf(uint256 streamId) external view returns (uint128 refundableAmount);
/// @notice Retrieves the stream's status.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function statusOf(uint256 streamId) external view returns (Lockup.Status status);
/// @notice Calculates the amount streamed to the recipient, denoted in units of the token's decimals.
/// @dev Reverts if `streamId` references a null stream.
///
/// Notes:
/// - Upon cancellation of the stream, the amount streamed is calculated as the difference between the deposited
/// amount and the refunded amount. Ultimately, when the stream becomes depleted, the streamed amount is equivalent
/// to the total amount withdrawn.
///
/// @param streamId The stream ID for the query.
function streamedAmountOf(uint256 streamId) external view returns (uint128 streamedAmount);
/// @notice Retrieves a flag indicating whether the stream was canceled.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function wasCanceled(uint256 streamId) external view returns (bool result);
/// @notice Calculates the amount that the recipient can withdraw from the stream, denoted in units of the token's
/// decimals.
/// @dev Reverts if `streamId` references a null stream.
/// @param streamId The stream ID for the query.
function withdrawableAmountOf(uint256 streamId) external view returns (uint128 withdrawableAmount);
/*//////////////////////////////////////////////////////////////////////////
NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Allows a recipient contract to hook to Sablier when a stream is canceled or when tokens are withdrawn.
/// Useful for implementing contracts that hold streams on behalf of users, such as vaults or staking contracts.
///
/// @dev Emits an {AllowToHook} event.
///
/// Notes:
/// - Does not revert if the contract is already on the allowlist.
/// - This is an irreversible operation. The contract cannot be removed from the allowlist.
///
/// Requirements:
/// - `msg.sender` must be the contract admin.
/// - `recipient` must have a non-zero code size.
/// - `recipient` must implement {ISablierLockupRecipient}.
///
/// @param recipient The address of the contract to allow for hooks.
function allowToHook(address recipient) external;
/// @notice Burns the NFT associated with the stream.
///
/// @dev Emits a {Transfer} and {MetadataUpdate} event.
///
/// Requirements:
/// - Must not be delegate called.
/// - `streamId` must reference a depleted stream.
/// - The NFT must exist.
/// - `msg.sender` must be either the NFT owner or an approved third party.
///
/// @param streamId The ID of the stream NFT to burn.
function burn(uint256 streamId) external payable;
/// @notice Cancels the stream and refunds any remaining tokens to the sender.
///
/// @dev Emits a {Transfer}, {CancelLockupStream} and {MetadataUpdate} event.
///
/// Notes:
/// - If there any tokens left for the recipient to withdraw, the stream is marked as canceled. Otherwise, the
/// stream is marked as depleted.
/// - If the address is on the allowlist, this function will invoke a hook on the recipient.
///
/// Requirements:
/// - Must not be delegate called.
/// - The stream must be warm and cancelable.
/// - `msg.sender` must be the stream's sender.
///
/// @param streamId The ID of the stream to cancel.
function cancel(uint256 streamId) external payable;
/// @notice Cancels multiple streams and refunds any remaining tokens to the sender.
///
/// @dev Emits multiple {Transfer}, {CancelLockupStream} and {MetadataUpdate} events.
///
/// Notes:
/// - Refer to the notes in {cancel}.
///
/// Requirements:
/// - All requirements from {cancel} must be met for each stream.
///
/// @param streamIds The IDs of the streams to cancel.
function cancelMultiple(uint256[] calldata streamIds) external payable;
/// @notice Collects the accrued fees by transferring them to the contract admin.
///
/// @dev Emits a {CollectFees} event.
///
/// Notes:
/// - If the admin is a contract, it must be able to receive native token payments, e.g., ETH for Ethereum Mainnet.
function collectFees() external;
/// @notice Removes the right of the stream's sender to cancel the stream.
///
/// @dev Emits a {RenounceLockupStream} event.
///
/// Notes:
/// - This is an irreversible operation.
///
/// Requirements:
/// - Must not be delegate called.
/// - `streamId` must reference a warm stream.
/// - `msg.sender` must be the stream's sender.
/// - The stream must be cancelable.
///
/// @param streamId The ID of the stream to renounce.
function renounce(uint256 streamId) external payable;
/// @notice Renounces multiple streams.
///
/// @dev Emits multiple {RenounceLockupStream} events.
///
/// Notes:
/// - Refer to the notes in {renounce}.
///
/// Requirements:
/// - All requirements from {renounce} must be met for each stream.
///
/// @param streamIds An array of stream IDs to renounce.
function renounceMultiple(uint256[] calldata streamIds) external payable;
/// @notice Sets a new NFT descriptor contract, which produces the URI describing the Sablier stream NFTs.
///
/// @dev Emits a {SetNFTDescriptor} and {BatchMetadataUpdate} event.
///
/// Notes:
/// - Does not revert if the NFT descriptor is the same.
///
/// Requirements:
/// - `msg.sender` must be the contract admin.
///
/// @param newNFTDescriptor The address of the new NFT descriptor contract.
function setNFTDescriptor(ILockupNFTDescriptor newNFTDescriptor) external;
/// @notice Withdraws the provided amount of tokens from the stream to the `to` address.
///
/// @dev Emits a {Transfer}, {WithdrawFromLockupStream} and {MetadataUpdate} event.
///
/// Notes:
/// - If `msg.sender` is not the recipient and the address is on the allowlist, this function will invoke a hook on
/// the recipient.
///
/// Requirements:
/// - Must not be delegate called.
/// - `streamId` must not reference a null or depleted stream.
/// - `to` must not be the zero address.
/// - `amount` must be greater than zero and must not exceed the withdrawable amount.
/// - `to` must be the recipient if `msg.sender` is not the stream's recipient or an approved third party.
///
/// @param streamId The ID of the stream to withdraw from.
/// @param to The address receiving the withdrawn tokens.
/// @param amount The amount to withdraw, denoted in units of the token's decimals.
function withdraw(uint256 streamId, address to, uint128 amount) external payable;
/// @notice Withdraws the maximum withdrawable amount from the stream to the provided address `to`.
///
/// @dev Emits a {Transfer}, {WithdrawFromLockupStream} and {MetadataUpdate} event.
///
/// Notes:
/// - Refer to the notes in {withdraw}.
///
/// Requirements:
/// - Refer to the requirements in {withdraw}.
///
/// @param streamId The ID of the stream to withdraw from.
/// @param to The address receiving the withdrawn tokens.
/// @return withdrawnAmount The amount withdrawn, denoted in units of the token's decimals.
function withdrawMax(uint256 streamId, address to) external payable returns (uint128 withdrawnAmount);
/// @notice Withdraws the maximum withdrawable amount from the stream to the current recipient, and transfers the
/// NFT to `newRecipient`.
///
/// @dev Emits a {WithdrawFromLockupStream}, {Transfer} and {MetadataUpdate} event.
///
/// Notes:
/// - If the withdrawable amount is zero, the withdrawal is skipped.
/// - Refer to the notes in {withdraw}.
///
/// Requirements:
/// - `msg.sender` must be either the NFT owner or an approved third party.
/// - Refer to the requirements in {withdraw}.
/// - Refer to the requirements in {IERC721.transferFrom}.
///
/// @param streamId The ID of the stream NFT to transfer.
/// @param newRecipient The address of the new owner of the stream NFT.
/// @return withdrawnAmount The amount withdrawn, denoted in units of the token's decimals.
function withdrawMaxAndTransfer(
uint256 streamId,
address newRecipient
)
external
payable
returns (uint128 withdrawnAmount);
/// @notice Withdraws tokens from streams to the recipient of each stream.
///
/// @dev Emits multiple {Transfer}, {WithdrawFromLockupStream} and {MetadataUpdate} events. For each stream that
/// reverted the withdrawal, it emits an {InvalidWithdrawalInWithdrawMultiple} event.
///
/// Notes:
/// - This function attempts to call a hook on the recipient of each stream, unless `msg.sender` is the recipient.
///
/// Requirements:
/// - Must not be delegate called.
/// - There must be an equal number of `streamIds` and `amounts`.
/// - Each stream ID in the array must not reference a null or depleted stream.
/// - Each amount in the array must be greater than zero and must not exceed the withdrawable amount.
///
/// @param streamIds The IDs of the streams to withdraw from.
/// @param amounts The amounts to withdraw, denoted in units of the token's decimals.
function withdrawMultiple(uint256[] calldata streamIds, uint128[] calldata amounts) external payable;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
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);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC20Permit} from "../extensions/IERC20Permit.sol";
import {Address} from "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 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 {
using Address for address;
/**
* @dev An operation with an ERC20 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.
*/
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.
*/
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.
*/
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 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).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data);
if (returndata.length != 0 && !abi.decode(returndata, (bool))) {
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 silents catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
// and not revert is the subcall reverts.
(bool success, bytes memory returndata) = address(token).call(data);
return success && (returndata.length == 0 || abi.decode(returndata, (bool))) && address(token).code.length > 0;
}
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { MerkleProof } from "@openzeppelin/contracts/utils/cryptography/MerkleProof.sol";
import { BitMaps } from "@openzeppelin/contracts/utils/structs/BitMaps.sol";
import { Adminable } from "@sablier/lockup/src/abstracts/Adminable.sol";
import { ISablierMerkleBase } from "./../interfaces/ISablierMerkleBase.sol";
import { ISablierMerkleFactory } from "./../interfaces/ISablierMerkleFactory.sol";
import { Errors } from "./../libraries/Errors.sol";
import { MerkleBase } from "./../types/DataTypes.sol";
/// @title SablierMerkleBase
/// @notice See the documentation in {ISablierMerkleBase}.
abstract contract SablierMerkleBase is
ISablierMerkleBase, // 2 inherited component
Adminable // 1 inherited component
{
using BitMaps for BitMaps.BitMap;
using SafeERC20 for IERC20;
/*//////////////////////////////////////////////////////////////////////////
STATE VARIABLES
//////////////////////////////////////////////////////////////////////////*/
/// @dev The name of the campaign stored as bytes32.
bytes32 internal immutable CAMPAIGN_NAME;
/// @inheritdoc ISablierMerkleBase
uint40 public immutable override EXPIRATION;
/// @inheritdoc ISablierMerkleBase
address public immutable override FACTORY;
/// @inheritdoc ISablierMerkleBase
uint256 public immutable override FEE;
/// @inheritdoc ISablierMerkleBase
bytes32 public immutable override MERKLE_ROOT;
/// @dev The shape of Lockup stream stored as bytes32.
bytes32 internal immutable SHAPE;
/// @inheritdoc ISablierMerkleBase
IERC20 public immutable override TOKEN;
/// @inheritdoc ISablierMerkleBase
string public override ipfsCID;
/// @dev Packed booleans that record the history of claims.
BitMaps.BitMap internal _claimedBitMap;
/// @dev The timestamp when the first claim is made.
uint40 internal _firstClaimTime;
/*//////////////////////////////////////////////////////////////////////////
CONSTRUCTOR
//////////////////////////////////////////////////////////////////////////*/
/// @notice Constructs the contract by initializing the immutable state variables.
constructor(MerkleBase.ConstructorParams memory params, address campaignCreator) Adminable(params.initialAdmin) {
CAMPAIGN_NAME = bytes32(abi.encodePacked(params.campaignName));
EXPIRATION = params.expiration;
FACTORY = msg.sender;
FEE = ISablierMerkleFactory(FACTORY).getFee(campaignCreator);
MERKLE_ROOT = params.merkleRoot;
SHAPE = bytes32(abi.encodePacked(params.shape));
TOKEN = params.token;
ipfsCID = params.ipfsCID;
}
/*//////////////////////////////////////////////////////////////////////////
USER-FACING CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierMerkleBase
function campaignName() external view override returns (string memory) {
return string(abi.encodePacked(CAMPAIGN_NAME));
}
/// @inheritdoc ISablierMerkleBase
function getFirstClaimTime() external view override returns (uint40) {
return _firstClaimTime;
}
/// @inheritdoc ISablierMerkleBase
function hasClaimed(uint256 index) public view override returns (bool) {
return _claimedBitMap.get(index);
}
/// @inheritdoc ISablierMerkleBase
function hasExpired() public view override returns (bool) {
return EXPIRATION > 0 && EXPIRATION <= block.timestamp;
}
/// @inheritdoc ISablierMerkleBase
function shape() external view override returns (string memory) {
return string(abi.encodePacked(SHAPE));
}
/*//////////////////////////////////////////////////////////////////////////
USER-FACING NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @inheritdoc ISablierMerkleBase
function claim(
uint256 index,
address recipient,
uint128 amount,
bytes32[] calldata merkleProof
)
external
payable
override
{
// Check: the campaign has not expired.
if (hasExpired()) {
revert Errors.SablierMerkleBase_CampaignExpired({ blockTimestamp: block.timestamp, expiration: EXPIRATION });
}
// Check: `msg.value` is not less than the fee.
if (msg.value < FEE) {
revert Errors.SablierMerkleBase_InsufficientFeePayment(msg.value, FEE);
}
// Check: the index has not been claimed.
if (_claimedBitMap.get(index)) {
revert Errors.SablierMerkleBase_StreamClaimed(index);
}
// Generate the Merkle tree leaf by hashing the corresponding parameters. Hashing twice prevents second
// preimage attacks.
bytes32 leaf = keccak256(bytes.concat(keccak256(abi.encode(index, recipient, amount))));
// Check: the input claim is included in the Merkle tree.
if (!MerkleProof.verify(merkleProof, MERKLE_ROOT, leaf)) {
revert Errors.SablierMerkleBase_InvalidProof();
}
// Effect: set the `_firstClaimTime` if its zero.
if (_firstClaimTime == 0) {
_firstClaimTime = uint40(block.timestamp);
}
// Effect: mark the index as claimed.
_claimedBitMap.set(index);
// Call the internal virtual function.
_claim(index, recipient, amount);
}
/// @inheritdoc ISablierMerkleBase
function clawback(address to, uint128 amount) external override onlyAdmin {
// Check: current timestamp is over the grace period and the campaign has not expired.
if (_hasGracePeriodPassed() && !hasExpired()) {
revert Errors.SablierMerkleBase_ClawbackNotAllowed({
blockTimestamp: block.timestamp,
expiration: EXPIRATION,
firstClaimTime: _firstClaimTime
});
}
// Effect: transfer the tokens to the provided address.
TOKEN.safeTransfer(to, amount);
// Log the clawback.
emit Clawback(admin, to, amount);
}
/// @inheritdoc ISablierMerkleBase
function collectFees(address factoryAdmin) external override returns (uint256 feeAmount) {
// Check: the caller is the FACTORY.
if (msg.sender != FACTORY) {
revert Errors.SablierMerkleBase_CallerNotFactory(FACTORY, msg.sender);
}
feeAmount = address(this).balance;
// Effect: transfer the fees to the factory admin.
(bool success,) = factoryAdmin.call{ value: feeAmount }("");
// Revert if the call failed.
if (!success) {
revert Errors.SablierMerkleBase_FeeTransferFail(factoryAdmin, feeAmount);
}
}
/*//////////////////////////////////////////////////////////////////////////
INTERNAL CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Returns a flag indicating whether the grace period has passed.
/// @dev The grace period is 7 days after the first claim.
function _hasGracePeriodPassed() internal view returns (bool) {
return _firstClaimTime > 0 && block.timestamp > _firstClaimTime + 7 days;
}
/*//////////////////////////////////////////////////////////////////////////
INTERNAL NON-CONSTANT FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @dev This function is implemented by child contracts, so the logic varies depending on the model.
function _claim(uint256 index, address recipient, uint128 amount) internal virtual;
}// SPDX-License-Identifier: MIT pragma solidity >=0.8.19; /* ██████╗ ██████╗ ██████╗ ███╗ ███╗ █████╗ ████████╗██╗ ██╗ ██╔══██╗██╔══██╗██╔══██╗████╗ ████║██╔══██╗╚══██╔══╝██║ ██║ ██████╔╝██████╔╝██████╔╝██╔████╔██║███████║ ██║ ███████║ ██╔═══╝ ██╔══██╗██╔══██╗██║╚██╔╝██║██╔══██║ ██║ ██╔══██║ ██║ ██║ ██║██████╔╝██║ ╚═╝ ██║██║ ██║ ██║ ██║ ██║ ╚═╝ ╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ██╗ ██╗██████╗ ██████╗ ██████╗ ██╗ ██╗ ██╗ █████╗ ██║ ██║██╔══██╗██╔════╝ ██╔═████╗╚██╗██╔╝███║██╔══██╗ ██║ ██║██║ ██║███████╗ ██║██╔██║ ╚███╔╝ ╚██║╚█████╔╝ ██║ ██║██║ ██║██╔═══██╗████╔╝██║ ██╔██╗ ██║██╔══██╗ ╚██████╔╝██████╔╝╚██████╔╝╚██████╔╝██╔╝ ██╗ ██║╚█████╔╝ ╚═════╝ ╚═════╝ ╚═════╝ ╚═════╝ ╚═╝ ╚═╝ ╚═╝ ╚════╝ */ import "./ud60x18/Casting.sol"; import "./ud60x18/Constants.sol"; import "./ud60x18/Conversions.sol"; import "./ud60x18/Errors.sol"; import "./ud60x18/Helpers.sol"; import "./ud60x18/Math.sol"; import "./ud60x18/ValueType.sol";
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
/// @title Errors
/// @notice Library containing all custom errors the protocol may revert with.
library Errors {
/*//////////////////////////////////////////////////////////////////////////
GENERIC
//////////////////////////////////////////////////////////////////////////*/
error CallerNotAdmin(address admin, address caller);
/*//////////////////////////////////////////////////////////////////////////
SABLIER-MERKLE-BASE
//////////////////////////////////////////////////////////////////////////*/
/// @notice Thrown when caller is not the factory contract.
error SablierMerkleBase_CallerNotFactory(address factory, address caller);
/// @notice Thrown when trying to claim after the campaign has expired.
error SablierMerkleBase_CampaignExpired(uint256 blockTimestamp, uint40 expiration);
/// @notice Thrown when trying to clawback when the current timestamp is over the grace period and the campaign has
/// not expired.
error SablierMerkleBase_ClawbackNotAllowed(uint256 blockTimestamp, uint40 expiration, uint40 firstClaimTime);
/// @notice Thrown if the fees withdrawal failed.
error SablierMerkleBase_FeeTransferFail(address factoryAdmin, uint256 feeAmount);
/// @notice Thrown when trying to claim with an insufficient fee payment.
error SablierMerkleBase_InsufficientFeePayment(uint256 feePaid, uint256 fee);
/// @notice Thrown when trying to claim with an invalid Merkle proof.
error SablierMerkleBase_InvalidProof();
/// @notice Thrown when trying to claim the same stream more than once.
error SablierMerkleBase_StreamClaimed(uint256 index);
/*//////////////////////////////////////////////////////////////////////////
SABLIER-MERKLE-LT
//////////////////////////////////////////////////////////////////////////*/
/// @notice Thrown when trying to claim from an LT campaign with tranches' unlock percentages not adding up to 100%.
error SablierMerkleLT_TotalPercentageNotOneHundred(uint64 totalPercentage);
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
// Common.sol
//
// Common mathematical functions used in both SD59x18 and UD60x18. Note that these global functions do not
// always operate with SD59x18 and UD60x18 numbers.
/*//////////////////////////////////////////////////////////////////////////
CUSTOM ERRORS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Thrown when the resultant value in {mulDiv} overflows uint256.
error PRBMath_MulDiv_Overflow(uint256 x, uint256 y, uint256 denominator);
/// @notice Thrown when the resultant value in {mulDiv18} overflows uint256.
error PRBMath_MulDiv18_Overflow(uint256 x, uint256 y);
/// @notice Thrown when one of the inputs passed to {mulDivSigned} is `type(int256).min`.
error PRBMath_MulDivSigned_InputTooSmall();
/// @notice Thrown when the resultant value in {mulDivSigned} overflows int256.
error PRBMath_MulDivSigned_Overflow(int256 x, int256 y);
/*//////////////////////////////////////////////////////////////////////////
CONSTANTS
//////////////////////////////////////////////////////////////////////////*/
/// @dev The maximum value a uint128 number can have.
uint128 constant MAX_UINT128 = type(uint128).max;
/// @dev The maximum value a uint40 number can have.
uint40 constant MAX_UINT40 = type(uint40).max;
/// @dev The maximum value a uint64 number can have.
uint64 constant MAX_UINT64 = type(uint64).max;
/// @dev The unit number, which the decimal precision of the fixed-point types.
uint256 constant UNIT = 1e18;
/// @dev The unit number inverted mod 2^256.
uint256 constant UNIT_INVERSE = 78156646155174841979727994598816262306175212592076161876661_508869554232690281;
/// @dev The the largest power of two that divides the decimal value of `UNIT`. The logarithm of this value is the least significant
/// bit in the binary representation of `UNIT`.
uint256 constant UNIT_LPOTD = 262144;
/*//////////////////////////////////////////////////////////////////////////
FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Calculates the binary exponent of x using the binary fraction method.
/// @dev Has to use 192.64-bit fixed-point numbers. See https://ethereum.stackexchange.com/a/96594/24693.
/// @param x The exponent as an unsigned 192.64-bit fixed-point number.
/// @return result The result as an unsigned 60.18-decimal fixed-point number.
/// @custom:smtchecker abstract-function-nondet
function exp2(uint256 x) pure returns (uint256 result) {
unchecked {
// Start from 0.5 in the 192.64-bit fixed-point format.
result = 0x800000000000000000000000000000000000000000000000;
// The following logic multiplies the result by $\sqrt{2^{-i}}$ when the bit at position i is 1. Key points:
//
// 1. Intermediate results will not overflow, as the starting point is 2^191 and all magic factors are under 2^65.
// 2. The rationale for organizing the if statements into groups of 8 is gas savings. If the result of performing
// a bitwise AND operation between x and any value in the array [0x80; 0x40; 0x20; 0x10; 0x08; 0x04; 0x02; 0x01] is 1,
// we know that `x & 0xFF` is also 1.
if (x & 0xFF00000000000000 > 0) {
if (x & 0x8000000000000000 > 0) {
result = (result * 0x16A09E667F3BCC909) >> 64;
}
if (x & 0x4000000000000000 > 0) {
result = (result * 0x1306FE0A31B7152DF) >> 64;
}
if (x & 0x2000000000000000 > 0) {
result = (result * 0x1172B83C7D517ADCE) >> 64;
}
if (x & 0x1000000000000000 > 0) {
result = (result * 0x10B5586CF9890F62A) >> 64;
}
if (x & 0x800000000000000 > 0) {
result = (result * 0x1059B0D31585743AE) >> 64;
}
if (x & 0x400000000000000 > 0) {
result = (result * 0x102C9A3E778060EE7) >> 64;
}
if (x & 0x200000000000000 > 0) {
result = (result * 0x10163DA9FB33356D8) >> 64;
}
if (x & 0x100000000000000 > 0) {
result = (result * 0x100B1AFA5ABCBED61) >> 64;
}
}
if (x & 0xFF000000000000 > 0) {
if (x & 0x80000000000000 > 0) {
result = (result * 0x10058C86DA1C09EA2) >> 64;
}
if (x & 0x40000000000000 > 0) {
result = (result * 0x1002C605E2E8CEC50) >> 64;
}
if (x & 0x20000000000000 > 0) {
result = (result * 0x100162F3904051FA1) >> 64;
}
if (x & 0x10000000000000 > 0) {
result = (result * 0x1000B175EFFDC76BA) >> 64;
}
if (x & 0x8000000000000 > 0) {
result = (result * 0x100058BA01FB9F96D) >> 64;
}
if (x & 0x4000000000000 > 0) {
result = (result * 0x10002C5CC37DA9492) >> 64;
}
if (x & 0x2000000000000 > 0) {
result = (result * 0x1000162E525EE0547) >> 64;
}
if (x & 0x1000000000000 > 0) {
result = (result * 0x10000B17255775C04) >> 64;
}
}
if (x & 0xFF0000000000 > 0) {
if (x & 0x800000000000 > 0) {
result = (result * 0x1000058B91B5BC9AE) >> 64;
}
if (x & 0x400000000000 > 0) {
result = (result * 0x100002C5C89D5EC6D) >> 64;
}
if (x & 0x200000000000 > 0) {
result = (result * 0x10000162E43F4F831) >> 64;
}
if (x & 0x100000000000 > 0) {
result = (result * 0x100000B1721BCFC9A) >> 64;
}
if (x & 0x80000000000 > 0) {
result = (result * 0x10000058B90CF1E6E) >> 64;
}
if (x & 0x40000000000 > 0) {
result = (result * 0x1000002C5C863B73F) >> 64;
}
if (x & 0x20000000000 > 0) {
result = (result * 0x100000162E430E5A2) >> 64;
}
if (x & 0x10000000000 > 0) {
result = (result * 0x1000000B172183551) >> 64;
}
}
if (x & 0xFF00000000 > 0) {
if (x & 0x8000000000 > 0) {
result = (result * 0x100000058B90C0B49) >> 64;
}
if (x & 0x4000000000 > 0) {
result = (result * 0x10000002C5C8601CC) >> 64;
}
if (x & 0x2000000000 > 0) {
result = (result * 0x1000000162E42FFF0) >> 64;
}
if (x & 0x1000000000 > 0) {
result = (result * 0x10000000B17217FBB) >> 64;
}
if (x & 0x800000000 > 0) {
result = (result * 0x1000000058B90BFCE) >> 64;
}
if (x & 0x400000000 > 0) {
result = (result * 0x100000002C5C85FE3) >> 64;
}
if (x & 0x200000000 > 0) {
result = (result * 0x10000000162E42FF1) >> 64;
}
if (x & 0x100000000 > 0) {
result = (result * 0x100000000B17217F8) >> 64;
}
}
if (x & 0xFF000000 > 0) {
if (x & 0x80000000 > 0) {
result = (result * 0x10000000058B90BFC) >> 64;
}
if (x & 0x40000000 > 0) {
result = (result * 0x1000000002C5C85FE) >> 64;
}
if (x & 0x20000000 > 0) {
result = (result * 0x100000000162E42FF) >> 64;
}
if (x & 0x10000000 > 0) {
result = (result * 0x1000000000B17217F) >> 64;
}
if (x & 0x8000000 > 0) {
result = (result * 0x100000000058B90C0) >> 64;
}
if (x & 0x4000000 > 0) {
result = (result * 0x10000000002C5C860) >> 64;
}
if (x & 0x2000000 > 0) {
result = (result * 0x1000000000162E430) >> 64;
}
if (x & 0x1000000 > 0) {
result = (result * 0x10000000000B17218) >> 64;
}
}
if (x & 0xFF0000 > 0) {
if (x & 0x800000 > 0) {
result = (result * 0x1000000000058B90C) >> 64;
}
if (x & 0x400000 > 0) {
result = (result * 0x100000000002C5C86) >> 64;
}
if (x & 0x200000 > 0) {
result = (result * 0x10000000000162E43) >> 64;
}
if (x & 0x100000 > 0) {
result = (result * 0x100000000000B1721) >> 64;
}
if (x & 0x80000 > 0) {
result = (result * 0x10000000000058B91) >> 64;
}
if (x & 0x40000 > 0) {
result = (result * 0x1000000000002C5C8) >> 64;
}
if (x & 0x20000 > 0) {
result = (result * 0x100000000000162E4) >> 64;
}
if (x & 0x10000 > 0) {
result = (result * 0x1000000000000B172) >> 64;
}
}
if (x & 0xFF00 > 0) {
if (x & 0x8000 > 0) {
result = (result * 0x100000000000058B9) >> 64;
}
if (x & 0x4000 > 0) {
result = (result * 0x10000000000002C5D) >> 64;
}
if (x & 0x2000 > 0) {
result = (result * 0x1000000000000162E) >> 64;
}
if (x & 0x1000 > 0) {
result = (result * 0x10000000000000B17) >> 64;
}
if (x & 0x800 > 0) {
result = (result * 0x1000000000000058C) >> 64;
}
if (x & 0x400 > 0) {
result = (result * 0x100000000000002C6) >> 64;
}
if (x & 0x200 > 0) {
result = (result * 0x10000000000000163) >> 64;
}
if (x & 0x100 > 0) {
result = (result * 0x100000000000000B1) >> 64;
}
}
if (x & 0xFF > 0) {
if (x & 0x80 > 0) {
result = (result * 0x10000000000000059) >> 64;
}
if (x & 0x40 > 0) {
result = (result * 0x1000000000000002C) >> 64;
}
if (x & 0x20 > 0) {
result = (result * 0x10000000000000016) >> 64;
}
if (x & 0x10 > 0) {
result = (result * 0x1000000000000000B) >> 64;
}
if (x & 0x8 > 0) {
result = (result * 0x10000000000000006) >> 64;
}
if (x & 0x4 > 0) {
result = (result * 0x10000000000000003) >> 64;
}
if (x & 0x2 > 0) {
result = (result * 0x10000000000000001) >> 64;
}
if (x & 0x1 > 0) {
result = (result * 0x10000000000000001) >> 64;
}
}
// In the code snippet below, two operations are executed simultaneously:
//
// 1. The result is multiplied by $(2^n + 1)$, where $2^n$ represents the integer part, and the additional 1
// accounts for the initial guess of 0.5. This is achieved by subtracting from 191 instead of 192.
// 2. The result is then converted to an unsigned 60.18-decimal fixed-point format.
//
// The underlying logic is based on the relationship $2^{191-ip} = 2^{ip} / 2^{191}$, where $ip$ denotes the,
// integer part, $2^n$.
result *= UNIT;
result >>= (191 - (x >> 64));
}
}
/// @notice Finds the zero-based index of the first 1 in the binary representation of x.
///
/// @dev See the note on "msb" in this Wikipedia article: https://en.wikipedia.org/wiki/Find_first_set
///
/// Each step in this implementation is equivalent to this high-level code:
///
/// ```solidity
/// if (x >= 2 ** 128) {
/// x >>= 128;
/// result += 128;
/// }
/// ```
///
/// Where 128 is replaced with each respective power of two factor. See the full high-level implementation here:
/// https://gist.github.com/PaulRBerg/f932f8693f2733e30c4d479e8e980948
///
/// The Yul instructions used below are:
///
/// - "gt" is "greater than"
/// - "or" is the OR bitwise operator
/// - "shl" is "shift left"
/// - "shr" is "shift right"
///
/// @param x The uint256 number for which to find the index of the most significant bit.
/// @return result The index of the most significant bit as a uint256.
/// @custom:smtchecker abstract-function-nondet
function msb(uint256 x) pure returns (uint256 result) {
// 2^128
assembly ("memory-safe") {
let factor := shl(7, gt(x, 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF))
x := shr(factor, x)
result := or(result, factor)
}
// 2^64
assembly ("memory-safe") {
let factor := shl(6, gt(x, 0xFFFFFFFFFFFFFFFF))
x := shr(factor, x)
result := or(result, factor)
}
// 2^32
assembly ("memory-safe") {
let factor := shl(5, gt(x, 0xFFFFFFFF))
x := shr(factor, x)
result := or(result, factor)
}
// 2^16
assembly ("memory-safe") {
let factor := shl(4, gt(x, 0xFFFF))
x := shr(factor, x)
result := or(result, factor)
}
// 2^8
assembly ("memory-safe") {
let factor := shl(3, gt(x, 0xFF))
x := shr(factor, x)
result := or(result, factor)
}
// 2^4
assembly ("memory-safe") {
let factor := shl(2, gt(x, 0xF))
x := shr(factor, x)
result := or(result, factor)
}
// 2^2
assembly ("memory-safe") {
let factor := shl(1, gt(x, 0x3))
x := shr(factor, x)
result := or(result, factor)
}
// 2^1
// No need to shift x any more.
assembly ("memory-safe") {
let factor := gt(x, 0x1)
result := or(result, factor)
}
}
/// @notice Calculates x*y÷denominator with 512-bit precision.
///
/// @dev Credits to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv.
///
/// Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - The denominator must not be zero.
/// - The result must fit in uint256.
///
/// @param x The multiplicand as a uint256.
/// @param y The multiplier as a uint256.
/// @param denominator The divisor as a uint256.
/// @return result The result as a uint256.
/// @custom:smtchecker abstract-function-nondet
function mulDiv(uint256 x, uint256 y, uint256 denominator) pure returns (uint256 result) {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512-bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly ("memory-safe") {
let mm := mulmod(x, y, not(0))
prod0 := mul(x, y)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
unchecked {
return prod0 / denominator;
}
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
if (prod1 >= denominator) {
revert PRBMath_MulDiv_Overflow(x, y, denominator);
}
////////////////////////////////////////////////////////////////////////////
// 512 by 256 division
////////////////////////////////////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly ("memory-safe") {
// Compute remainder using the mulmod Yul instruction.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512-bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
unchecked {
// Calculate the largest power of two divisor of the denominator using the unary operator ~. This operation cannot overflow
// because the denominator cannot be zero at this point in the function execution. The result is always >= 1.
// For more detail, see https://cs.stackexchange.com/q/138556/92363.
uint256 lpotdod = denominator & (~denominator + 1);
uint256 flippedLpotdod;
assembly ("memory-safe") {
// Factor powers of two out of denominator.
denominator := div(denominator, lpotdod)
// Divide [prod1 prod0] by lpotdod.
prod0 := div(prod0, lpotdod)
// Get the flipped value `2^256 / lpotdod`. If the `lpotdod` is zero, the flipped value is one.
// `sub(0, lpotdod)` produces the two's complement version of `lpotdod`, which is equivalent to flipping all the bits.
// However, `div` interprets this value as an unsigned value: https://ethereum.stackexchange.com/q/147168/24693
flippedLpotdod := add(div(sub(0, lpotdod), lpotdod), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * flippedLpotdod;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
// in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
}
}
/// @notice Calculates x*y÷1e18 with 512-bit precision.
///
/// @dev A variant of {mulDiv} with constant folding, i.e. in which the denominator is hard coded to 1e18.
///
/// Notes:
/// - The body is purposely left uncommented; to understand how this works, see the documentation in {mulDiv}.
/// - The result is rounded toward zero.
/// - We take as an axiom that the result cannot be `MAX_UINT256` when x and y solve the following system of equations:
///
/// $$
/// \begin{cases}
/// x * y = MAX\_UINT256 * UNIT \\
/// (x * y) \% UNIT \geq \frac{UNIT}{2}
/// \end{cases}
/// $$
///
/// Requirements:
/// - Refer to the requirements in {mulDiv}.
/// - The result must fit in uint256.
///
/// @param x The multiplicand as an unsigned 60.18-decimal fixed-point number.
/// @param y The multiplier as an unsigned 60.18-decimal fixed-point number.
/// @return result The result as an unsigned 60.18-decimal fixed-point number.
/// @custom:smtchecker abstract-function-nondet
function mulDiv18(uint256 x, uint256 y) pure returns (uint256 result) {
uint256 prod0;
uint256 prod1;
assembly ("memory-safe") {
let mm := mulmod(x, y, not(0))
prod0 := mul(x, y)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
if (prod1 == 0) {
unchecked {
return prod0 / UNIT;
}
}
if (prod1 >= UNIT) {
revert PRBMath_MulDiv18_Overflow(x, y);
}
uint256 remainder;
assembly ("memory-safe") {
remainder := mulmod(x, y, UNIT)
result :=
mul(
or(
div(sub(prod0, remainder), UNIT_LPOTD),
mul(sub(prod1, gt(remainder, prod0)), add(div(sub(0, UNIT_LPOTD), UNIT_LPOTD), 1))
),
UNIT_INVERSE
)
}
}
/// @notice Calculates x*y÷denominator with 512-bit precision.
///
/// @dev This is an extension of {mulDiv} for signed numbers, which works by computing the signs and the absolute values separately.
///
/// Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - Refer to the requirements in {mulDiv}.
/// - None of the inputs can be `type(int256).min`.
/// - The result must fit in int256.
///
/// @param x The multiplicand as an int256.
/// @param y The multiplier as an int256.
/// @param denominator The divisor as an int256.
/// @return result The result as an int256.
/// @custom:smtchecker abstract-function-nondet
function mulDivSigned(int256 x, int256 y, int256 denominator) pure returns (int256 result) {
if (x == type(int256).min || y == type(int256).min || denominator == type(int256).min) {
revert PRBMath_MulDivSigned_InputTooSmall();
}
// Get hold of the absolute values of x, y and the denominator.
uint256 xAbs;
uint256 yAbs;
uint256 dAbs;
unchecked {
xAbs = x < 0 ? uint256(-x) : uint256(x);
yAbs = y < 0 ? uint256(-y) : uint256(y);
dAbs = denominator < 0 ? uint256(-denominator) : uint256(denominator);
}
// Compute the absolute value of x*y÷denominator. The result must fit in int256.
uint256 resultAbs = mulDiv(xAbs, yAbs, dAbs);
if (resultAbs > uint256(type(int256).max)) {
revert PRBMath_MulDivSigned_Overflow(x, y);
}
// Get the signs of x, y and the denominator.
uint256 sx;
uint256 sy;
uint256 sd;
assembly ("memory-safe") {
// "sgt" is the "signed greater than" assembly instruction and "sub(0,1)" is -1 in two's complement.
sx := sgt(x, sub(0, 1))
sy := sgt(y, sub(0, 1))
sd := sgt(denominator, sub(0, 1))
}
// XOR over sx, sy and sd. What this does is to check whether there are 1 or 3 negative signs in the inputs.
// If there are, the result should be negative. Otherwise, it should be positive.
unchecked {
result = sx ^ sy ^ sd == 0 ? -int256(resultAbs) : int256(resultAbs);
}
}
/// @notice Calculates the square root of x using the Babylonian method.
///
/// @dev See https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method.
///
/// Notes:
/// - If x is not a perfect square, the result is rounded down.
/// - Credits to OpenZeppelin for the explanations in comments below.
///
/// @param x The uint256 number for which to calculate the square root.
/// @return result The result as a uint256.
/// @custom:smtchecker abstract-function-nondet
function sqrt(uint256 x) pure returns (uint256 result) {
if (x == 0) {
return 0;
}
// For our first guess, we calculate the biggest power of 2 which is smaller than the square root of x.
//
// We know that the "msb" (most significant bit) of x is a power of 2 such that we have:
//
// $$
// msb(x) <= x <= 2*msb(x)$
// $$
//
// We write $msb(x)$ as $2^k$, and we get:
//
// $$
// k = log_2(x)
// $$
//
// Thus, we can write the initial inequality as:
//
// $$
// 2^{log_2(x)} <= x <= 2*2^{log_2(x)+1} \\
// sqrt(2^k) <= sqrt(x) < sqrt(2^{k+1}) \\
// 2^{k/2} <= sqrt(x) < 2^{(k+1)/2} <= 2^{(k/2)+1}
// $$
//
// Consequently, $2^{log_2(x) /2} is a good first approximation of sqrt(x) with at least one correct bit.
uint256 xAux = uint256(x);
result = 1;
if (xAux >= 2 ** 128) {
xAux >>= 128;
result <<= 64;
}
if (xAux >= 2 ** 64) {
xAux >>= 64;
result <<= 32;
}
if (xAux >= 2 ** 32) {
xAux >>= 32;
result <<= 16;
}
if (xAux >= 2 ** 16) {
xAux >>= 16;
result <<= 8;
}
if (xAux >= 2 ** 8) {
xAux >>= 8;
result <<= 4;
}
if (xAux >= 2 ** 4) {
xAux >>= 4;
result <<= 2;
}
if (xAux >= 2 ** 2) {
result <<= 1;
}
// At this point, `result` is an estimation with at least one bit of precision. We know the true value has at
// most 128 bits, since it is the square root of a uint256. Newton's method converges quadratically (precision
// doubles at every iteration). We thus need at most 7 iteration to turn our partial result with one bit of
// precision into the expected uint128 result.
unchecked {
result = (result + x / result) >> 1;
result = (result + x / result) >> 1;
result = (result + x / result) >> 1;
result = (result + x / result) >> 1;
result = (result + x / result) >> 1;
result = (result + x / result) >> 1;
result = (result + x / result) >> 1;
// If x is not a perfect square, round the result toward zero.
uint256 roundedResult = x / result;
if (result >= roundedResult) {
result = roundedResult;
}
}
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "./Casting.sol" as Casting;
import "./Helpers.sol" as Helpers;
import "./Math.sol" as Math;
/// @notice The signed 59.18-decimal fixed-point number representation, which can have up to 59 digits and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the underlying Solidity
/// type int256.
type SD59x18 is int256;
/*//////////////////////////////////////////////////////////////////////////
CASTING
//////////////////////////////////////////////////////////////////////////*/
using {
Casting.intoInt256,
Casting.intoSD1x18,
Casting.intoSD21x18,
Casting.intoUD2x18,
Casting.intoUD21x18,
Casting.intoUD60x18,
Casting.intoUint256,
Casting.intoUint128,
Casting.intoUint40,
Casting.unwrap
} for SD59x18 global;
/*//////////////////////////////////////////////////////////////////////////
MATHEMATICAL FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
using {
Math.abs,
Math.avg,
Math.ceil,
Math.div,
Math.exp,
Math.exp2,
Math.floor,
Math.frac,
Math.gm,
Math.inv,
Math.log10,
Math.log2,
Math.ln,
Math.mul,
Math.pow,
Math.powu,
Math.sqrt
} for SD59x18 global;
/*//////////////////////////////////////////////////////////////////////////
HELPER FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
using {
Helpers.add,
Helpers.and,
Helpers.eq,
Helpers.gt,
Helpers.gte,
Helpers.isZero,
Helpers.lshift,
Helpers.lt,
Helpers.lte,
Helpers.mod,
Helpers.neq,
Helpers.not,
Helpers.or,
Helpers.rshift,
Helpers.sub,
Helpers.uncheckedAdd,
Helpers.uncheckedSub,
Helpers.uncheckedUnary,
Helpers.xor
} for SD59x18 global;
/*//////////////////////////////////////////////////////////////////////////
OPERATORS
//////////////////////////////////////////////////////////////////////////*/
// The global "using for" directive makes it possible to use these operators on the SD59x18 type.
using {
Helpers.add as +,
Helpers.and2 as &,
Math.div as /,
Helpers.eq as ==,
Helpers.gt as >,
Helpers.gte as >=,
Helpers.lt as <,
Helpers.lte as <=,
Helpers.mod as %,
Math.mul as *,
Helpers.neq as !=,
Helpers.not as ~,
Helpers.or as |,
Helpers.sub as -,
Helpers.unary as -,
Helpers.xor as ^
} for SD59x18 global;// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "./Casting.sol" as Casting;
import "./Helpers.sol" as Helpers;
import "./Math.sol" as Math;
/// @notice The unsigned 60.18-decimal fixed-point number representation, which can have up to 60 digits and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the Solidity type uint256.
/// @dev The value type is defined here so it can be imported in all other files.
type UD60x18 is uint256;
/*//////////////////////////////////////////////////////////////////////////
CASTING
//////////////////////////////////////////////////////////////////////////*/
using {
Casting.intoSD1x18,
Casting.intoSD21x18,
Casting.intoSD59x18,
Casting.intoUD2x18,
Casting.intoUD21x18,
Casting.intoUint128,
Casting.intoUint256,
Casting.intoUint40,
Casting.unwrap
} for UD60x18 global;
/*//////////////////////////////////////////////////////////////////////////
MATHEMATICAL FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
// The global "using for" directive makes the functions in this library callable on the UD60x18 type.
using {
Math.avg,
Math.ceil,
Math.div,
Math.exp,
Math.exp2,
Math.floor,
Math.frac,
Math.gm,
Math.inv,
Math.ln,
Math.log10,
Math.log2,
Math.mul,
Math.pow,
Math.powu,
Math.sqrt
} for UD60x18 global;
/*//////////////////////////////////////////////////////////////////////////
HELPER FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
// The global "using for" directive makes the functions in this library callable on the UD60x18 type.
using {
Helpers.add,
Helpers.and,
Helpers.eq,
Helpers.gt,
Helpers.gte,
Helpers.isZero,
Helpers.lshift,
Helpers.lt,
Helpers.lte,
Helpers.mod,
Helpers.neq,
Helpers.not,
Helpers.or,
Helpers.rshift,
Helpers.sub,
Helpers.uncheckedAdd,
Helpers.uncheckedSub,
Helpers.xor
} for UD60x18 global;
/*//////////////////////////////////////////////////////////////////////////
OPERATORS
//////////////////////////////////////////////////////////////////////////*/
// The global "using for" directive makes it possible to use these operators on the UD60x18 type.
using {
Helpers.add as +,
Helpers.and2 as &,
Math.div as /,
Helpers.eq as ==,
Helpers.gt as >,
Helpers.gte as >=,
Helpers.lt as <,
Helpers.lte as <=,
Helpers.or as |,
Helpers.mod as %,
Math.mul as *,
Helpers.neq as !=,
Helpers.not as ~,
Helpers.sub as -,
Helpers.xor as ^
} for UD60x18 global;// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/extensions/IERC721Metadata.sol)
pragma solidity ^0.8.20;
import {IERC721} from "../IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional metadata extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Metadata is IERC721 {
/**
* @dev Returns the token collection name.
*/
function name() external view returns (string memory);
/**
* @dev Returns the token collection symbol.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
*/
function tokenURI(uint256 tokenId) external view returns (string memory);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC4906.sol)
pragma solidity ^0.8.20;
import {IERC165} from "./IERC165.sol";
import {IERC721} from "./IERC721.sol";
/// @title EIP-721 Metadata Update Extension
interface IERC4906 is IERC165, IERC721 {
/// @dev This event emits when the metadata of a token is changed.
/// So that the third-party platforms such as NFT market could
/// timely update the images and related attributes of the NFT.
event MetadataUpdate(uint256 _tokenId);
/// @dev This event emits when the metadata of a range of tokens is changed.
/// So that the third-party platforms such as NFT market could
/// timely update the images and related attributes of the NFTs.
event BatchMetadataUpdate(uint256 _fromTokenId, uint256 _toTokenId);
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
/// @notice This contract implements logic to batch call any function.
interface IBatch {
/// @notice Allows batched calls to self, i.e., `this` contract.
/// @dev Since `msg.value` can be reused across calls, be VERY CAREFUL when using it. Refer to
/// https://paradigm.xyz/2021/08/two-rights-might-make-a-wrong for more information.
/// @param calls An array of inputs for each call.
/// @return results An array of results from each call. Empty when the calls do not return anything.
function batch(bytes[] calldata calls) external payable returns (bytes[] memory results);
}// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity >=0.8.22;
import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
/// @title ILockupNFTDescriptor
/// @notice This contract generates the URI describing the Sablier stream NFTs.
/// @dev Inspired by Uniswap V3 Positions NFTs.
interface ILockupNFTDescriptor {
/// @notice Produces the URI describing a particular stream NFT.
/// @dev This is a data URI with the JSON contents directly inlined.
/// @param sablier The address of the Sablier contract the stream was created in.
/// @param streamId The ID of the stream for which to produce a description.
/// @return uri The URI of the ERC721-compliant metadata.
function tokenURI(IERC721Metadata sablier, uint256 streamId) external view returns (string memory uri);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error AddressInsufficientBalance(address account);
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedInnerCall();
/**
* @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 AddressInsufficientBalance(address(this));
}
(bool success, ) = recipient.call{value: amount}("");
if (!success) {
revert FailedInnerCall();
}
}
/**
* @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
* {FailedInnerCall} 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 AddressInsufficientBalance(address(this));
}
(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 {FailedInnerCall}) 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 {FailedInnerCall} 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 {FailedInnerCall}.
*/
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
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert FailedInnerCall();
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/cryptography/MerkleProof.sol)
pragma solidity ^0.8.20;
/**
* @dev These functions deal with verification of Merkle Tree proofs.
*
* The tree and the proofs can be generated using our
* https://github.com/OpenZeppelin/merkle-tree[JavaScript library].
* You will find a quickstart guide in the readme.
*
* WARNING: You should avoid using leaf values that are 64 bytes long prior to
* hashing, or use a hash function other than keccak256 for hashing leaves.
* This is because the concatenation of a sorted pair of internal nodes in
* the Merkle tree could be reinterpreted as a leaf value.
* OpenZeppelin's JavaScript library generates Merkle trees that are safe
* against this attack out of the box.
*/
library MerkleProof {
/**
*@dev The multiproof provided is not valid.
*/
error MerkleProofInvalidMultiproof();
/**
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
* defined by `root`. For this, a `proof` must be provided, containing
* sibling hashes on the branch from the leaf to the root of the tree. Each
* pair of leaves and each pair of pre-images are assumed to be sorted.
*/
function verify(bytes32[] memory proof, bytes32 root, bytes32 leaf) internal pure returns (bool) {
return processProof(proof, leaf) == root;
}
/**
* @dev Calldata version of {verify}
*/
function verifyCalldata(bytes32[] calldata proof, bytes32 root, bytes32 leaf) internal pure returns (bool) {
return processProofCalldata(proof, leaf) == root;
}
/**
* @dev Returns the rebuilt hash obtained by traversing a Merkle tree up
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
* hash matches the root of the tree. When processing the proof, the pairs
* of leafs & pre-images are assumed to be sorted.
*/
function processProof(bytes32[] memory proof, bytes32 leaf) internal pure returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = _hashPair(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Calldata version of {processProof}
*/
function processProofCalldata(bytes32[] calldata proof, bytes32 leaf) internal pure returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = _hashPair(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Returns true if the `leaves` can be simultaneously proven to be a part of a Merkle tree defined by
* `root`, according to `proof` and `proofFlags` as described in {processMultiProof}.
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*/
function multiProofVerify(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32 root,
bytes32[] memory leaves
) internal pure returns (bool) {
return processMultiProof(proof, proofFlags, leaves) == root;
}
/**
* @dev Calldata version of {multiProofVerify}
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*/
function multiProofVerifyCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32 root,
bytes32[] memory leaves
) internal pure returns (bool) {
return processMultiProofCalldata(proof, proofFlags, leaves) == root;
}
/**
* @dev Returns the root of a tree reconstructed from `leaves` and sibling nodes in `proof`. The reconstruction
* proceeds by incrementally reconstructing all inner nodes by combining a leaf/inner node with either another
* leaf/inner node or a proof sibling node, depending on whether each `proofFlags` item is true or false
* respectively.
*
* CAUTION: Not all Merkle trees admit multiproofs. To use multiproofs, it is sufficient to ensure that: 1) the tree
* is complete (but not necessarily perfect), 2) the leaves to be proven are in the opposite order they are in the
* tree (i.e., as seen from right to left starting at the deepest layer and continuing at the next layer).
*/
function processMultiProof(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32[] memory leaves
) internal pure returns (bytes32 merkleRoot) {
// This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the Merkle tree.
uint256 leavesLen = leaves.length;
uint256 proofLen = proof.length;
uint256 totalHashes = proofFlags.length;
// Check proof validity.
if (leavesLen + proofLen != totalHashes + 1) {
revert MerkleProofInvalidMultiproof();
}
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](totalHashes);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < totalHashes; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i]
? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
: proof[proofPos++];
hashes[i] = _hashPair(a, b);
}
if (totalHashes > 0) {
if (proofPos != proofLen) {
revert MerkleProofInvalidMultiproof();
}
unchecked {
return hashes[totalHashes - 1];
}
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
/**
* @dev Calldata version of {processMultiProof}.
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*/
function processMultiProofCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32[] memory leaves
) internal pure returns (bytes32 merkleRoot) {
// This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the Merkle tree.
uint256 leavesLen = leaves.length;
uint256 proofLen = proof.length;
uint256 totalHashes = proofFlags.length;
// Check proof validity.
if (leavesLen + proofLen != totalHashes + 1) {
revert MerkleProofInvalidMultiproof();
}
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](totalHashes);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < totalHashes; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i]
? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
: proof[proofPos++];
hashes[i] = _hashPair(a, b);
}
if (totalHashes > 0) {
if (proofPos != proofLen) {
revert MerkleProofInvalidMultiproof();
}
unchecked {
return hashes[totalHashes - 1];
}
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
/**
* @dev Sorts the pair (a, b) and hashes the result.
*/
function _hashPair(bytes32 a, bytes32 b) private pure returns (bytes32) {
return a < b ? _efficientHash(a, b) : _efficientHash(b, a);
}
/**
* @dev Implementation of keccak256(abi.encode(a, b)) that doesn't allocate or expand memory.
*/
function _efficientHash(bytes32 a, bytes32 b) private pure returns (bytes32 value) {
/// @solidity memory-safe-assembly
assembly {
mstore(0x00, a)
mstore(0x20, b)
value := keccak256(0x00, 0x40)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/structs/BitMaps.sol)
pragma solidity ^0.8.20;
/**
* @dev Library for managing uint256 to bool mapping in a compact and efficient way, provided the keys are sequential.
* Largely inspired by Uniswap's https://github.com/Uniswap/merkle-distributor/blob/master/contracts/MerkleDistributor.sol[merkle-distributor].
*
* BitMaps pack 256 booleans across each bit of a single 256-bit slot of `uint256` type.
* Hence booleans corresponding to 256 _sequential_ indices would only consume a single slot,
* unlike the regular `bool` which would consume an entire slot for a single value.
*
* This results in gas savings in two ways:
*
* - Setting a zero value to non-zero only once every 256 times
* - Accessing the same warm slot for every 256 _sequential_ indices
*/
library BitMaps {
struct BitMap {
mapping(uint256 bucket => uint256) _data;
}
/**
* @dev Returns whether the bit at `index` is set.
*/
function get(BitMap storage bitmap, uint256 index) internal view returns (bool) {
uint256 bucket = index >> 8;
uint256 mask = 1 << (index & 0xff);
return bitmap._data[bucket] & mask != 0;
}
/**
* @dev Sets the bit at `index` to the boolean `value`.
*/
function setTo(BitMap storage bitmap, uint256 index, bool value) internal {
if (value) {
set(bitmap, index);
} else {
unset(bitmap, index);
}
}
/**
* @dev Sets the bit at `index`.
*/
function set(BitMap storage bitmap, uint256 index) internal {
uint256 bucket = index >> 8;
uint256 mask = 1 << (index & 0xff);
bitmap._data[bucket] |= mask;
}
/**
* @dev Unsets the bit at `index`.
*/
function unset(BitMap storage bitmap, uint256 index) internal {
uint256 bucket = index >> 8;
uint256 mask = 1 << (index & 0xff);
bitmap._data[bucket] &= ~mask;
}
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "./Errors.sol" as CastingErrors;
import { MAX_UINT128, MAX_UINT40 } from "../Common.sol";
import { uMAX_SD1x18 } from "../sd1x18/Constants.sol";
import { SD1x18 } from "../sd1x18/ValueType.sol";
import { uMAX_SD21x18 } from "../sd21x18/Constants.sol";
import { SD21x18 } from "../sd21x18/ValueType.sol";
import { uMAX_SD59x18 } from "../sd59x18/Constants.sol";
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { uMAX_UD2x18 } from "../ud2x18/Constants.sol";
import { uMAX_UD21x18 } from "../ud21x18/Constants.sol";
import { UD2x18 } from "../ud2x18/ValueType.sol";
import { UD21x18 } from "../ud21x18/ValueType.sol";
import { UD60x18 } from "./ValueType.sol";
/// @notice Casts a UD60x18 number into SD1x18.
/// @dev Requirements:
/// - x ≤ uMAX_SD1x18
function intoSD1x18(UD60x18 x) pure returns (SD1x18 result) {
uint256 xUint = UD60x18.unwrap(x);
if (xUint > uint256(int256(uMAX_SD1x18))) {
revert CastingErrors.PRBMath_UD60x18_IntoSD1x18_Overflow(x);
}
result = SD1x18.wrap(int64(uint64(xUint)));
}
/// @notice Casts a UD60x18 number into SD21x18.
/// @dev Requirements:
/// - x ≤ uMAX_SD21x18
function intoSD21x18(UD60x18 x) pure returns (SD21x18 result) {
uint256 xUint = UD60x18.unwrap(x);
if (xUint > uint256(int256(uMAX_SD21x18))) {
revert CastingErrors.PRBMath_UD60x18_IntoSD21x18_Overflow(x);
}
result = SD21x18.wrap(int128(uint128(xUint)));
}
/// @notice Casts a UD60x18 number into UD2x18.
/// @dev Requirements:
/// - x ≤ uMAX_UD2x18
function intoUD2x18(UD60x18 x) pure returns (UD2x18 result) {
uint256 xUint = UD60x18.unwrap(x);
if (xUint > uMAX_UD2x18) {
revert CastingErrors.PRBMath_UD60x18_IntoUD2x18_Overflow(x);
}
result = UD2x18.wrap(uint64(xUint));
}
/// @notice Casts a UD60x18 number into UD21x18.
/// @dev Requirements:
/// - x ≤ uMAX_UD21x18
function intoUD21x18(UD60x18 x) pure returns (UD21x18 result) {
uint256 xUint = UD60x18.unwrap(x);
if (xUint > uMAX_UD21x18) {
revert CastingErrors.PRBMath_UD60x18_IntoUD21x18_Overflow(x);
}
result = UD21x18.wrap(uint128(xUint));
}
/// @notice Casts a UD60x18 number into SD59x18.
/// @dev Requirements:
/// - x ≤ uMAX_SD59x18
function intoSD59x18(UD60x18 x) pure returns (SD59x18 result) {
uint256 xUint = UD60x18.unwrap(x);
if (xUint > uint256(uMAX_SD59x18)) {
revert CastingErrors.PRBMath_UD60x18_IntoSD59x18_Overflow(x);
}
result = SD59x18.wrap(int256(xUint));
}
/// @notice Casts a UD60x18 number into uint128.
/// @dev This is basically an alias for {unwrap}.
function intoUint256(UD60x18 x) pure returns (uint256 result) {
result = UD60x18.unwrap(x);
}
/// @notice Casts a UD60x18 number into uint128.
/// @dev Requirements:
/// - x ≤ MAX_UINT128
function intoUint128(UD60x18 x) pure returns (uint128 result) {
uint256 xUint = UD60x18.unwrap(x);
if (xUint > MAX_UINT128) {
revert CastingErrors.PRBMath_UD60x18_IntoUint128_Overflow(x);
}
result = uint128(xUint);
}
/// @notice Casts a UD60x18 number into uint40.
/// @dev Requirements:
/// - x ≤ MAX_UINT40
function intoUint40(UD60x18 x) pure returns (uint40 result) {
uint256 xUint = UD60x18.unwrap(x);
if (xUint > MAX_UINT40) {
revert CastingErrors.PRBMath_UD60x18_IntoUint40_Overflow(x);
}
result = uint40(xUint);
}
/// @notice Alias for {wrap}.
function ud(uint256 x) pure returns (UD60x18 result) {
result = UD60x18.wrap(x);
}
/// @notice Alias for {wrap}.
function ud60x18(uint256 x) pure returns (UD60x18 result) {
result = UD60x18.wrap(x);
}
/// @notice Unwraps a UD60x18 number into uint256.
function unwrap(UD60x18 x) pure returns (uint256 result) {
result = UD60x18.unwrap(x);
}
/// @notice Wraps a uint256 number into the UD60x18 value type.
function wrap(uint256 x) pure returns (UD60x18 result) {
result = UD60x18.wrap(x);
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { UD60x18 } from "./ValueType.sol";
// NOTICE: the "u" prefix stands for "unwrapped".
/// @dev Euler's number as a UD60x18 number.
UD60x18 constant E = UD60x18.wrap(2_718281828459045235);
/// @dev The maximum input permitted in {exp}.
uint256 constant uEXP_MAX_INPUT = 133_084258667509499440;
UD60x18 constant EXP_MAX_INPUT = UD60x18.wrap(uEXP_MAX_INPUT);
/// @dev The maximum input permitted in {exp2}.
uint256 constant uEXP2_MAX_INPUT = 192e18 - 1;
UD60x18 constant EXP2_MAX_INPUT = UD60x18.wrap(uEXP2_MAX_INPUT);
/// @dev Half the UNIT number.
uint256 constant uHALF_UNIT = 0.5e18;
UD60x18 constant HALF_UNIT = UD60x18.wrap(uHALF_UNIT);
/// @dev $log_2(10)$ as a UD60x18 number.
uint256 constant uLOG2_10 = 3_321928094887362347;
UD60x18 constant LOG2_10 = UD60x18.wrap(uLOG2_10);
/// @dev $log_2(e)$ as a UD60x18 number.
uint256 constant uLOG2_E = 1_442695040888963407;
UD60x18 constant LOG2_E = UD60x18.wrap(uLOG2_E);
/// @dev The maximum value a UD60x18 number can have.
uint256 constant uMAX_UD60x18 = 115792089237316195423570985008687907853269984665640564039457_584007913129639935;
UD60x18 constant MAX_UD60x18 = UD60x18.wrap(uMAX_UD60x18);
/// @dev The maximum whole value a UD60x18 number can have.
uint256 constant uMAX_WHOLE_UD60x18 = 115792089237316195423570985008687907853269984665640564039457_000000000000000000;
UD60x18 constant MAX_WHOLE_UD60x18 = UD60x18.wrap(uMAX_WHOLE_UD60x18);
/// @dev PI as a UD60x18 number.
UD60x18 constant PI = UD60x18.wrap(3_141592653589793238);
/// @dev The unit number, which gives the decimal precision of UD60x18.
uint256 constant uUNIT = 1e18;
UD60x18 constant UNIT = UD60x18.wrap(uUNIT);
/// @dev The unit number squared.
uint256 constant uUNIT_SQUARED = 1e36;
UD60x18 constant UNIT_SQUARED = UD60x18.wrap(uUNIT_SQUARED);
/// @dev Zero as a UD60x18 number.
UD60x18 constant ZERO = UD60x18.wrap(0);// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { uMAX_UD60x18, uUNIT } from "./Constants.sol";
import { PRBMath_UD60x18_Convert_Overflow } from "./Errors.sol";
import { UD60x18 } from "./ValueType.sol";
/// @notice Converts a UD60x18 number to a simple integer by dividing it by `UNIT`.
/// @dev The result is rounded toward zero.
/// @param x The UD60x18 number to convert.
/// @return result The same number in basic integer form.
function convert(UD60x18 x) pure returns (uint256 result) {
result = UD60x18.unwrap(x) / uUNIT;
}
/// @notice Converts a simple integer to UD60x18 by multiplying it by `UNIT`.
///
/// @dev Requirements:
/// - x ≤ MAX_UD60x18 / UNIT
///
/// @param x The basic integer to convert.
/// @return result The same number converted to UD60x18.
function convert(uint256 x) pure returns (UD60x18 result) {
if (x > uMAX_UD60x18 / uUNIT) {
revert PRBMath_UD60x18_Convert_Overflow(x);
}
unchecked {
result = UD60x18.wrap(x * uUNIT);
}
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { UD60x18 } from "./ValueType.sol";
/// @notice Thrown when ceiling a number overflows UD60x18.
error PRBMath_UD60x18_Ceil_Overflow(UD60x18 x);
/// @notice Thrown when converting a basic integer to the fixed-point format overflows UD60x18.
error PRBMath_UD60x18_Convert_Overflow(uint256 x);
/// @notice Thrown when taking the natural exponent of a base greater than 133_084258667509499441.
error PRBMath_UD60x18_Exp_InputTooBig(UD60x18 x);
/// @notice Thrown when taking the binary exponent of a base greater than 192e18.
error PRBMath_UD60x18_Exp2_InputTooBig(UD60x18 x);
/// @notice Thrown when taking the geometric mean of two numbers and multiplying them overflows UD60x18.
error PRBMath_UD60x18_Gm_Overflow(UD60x18 x, UD60x18 y);
/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in SD1x18.
error PRBMath_UD60x18_IntoSD1x18_Overflow(UD60x18 x);
/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in SD21x18.
error PRBMath_UD60x18_IntoSD21x18_Overflow(UD60x18 x);
/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in SD59x18.
error PRBMath_UD60x18_IntoSD59x18_Overflow(UD60x18 x);
/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in UD2x18.
error PRBMath_UD60x18_IntoUD2x18_Overflow(UD60x18 x);
/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in UD21x18.
error PRBMath_UD60x18_IntoUD21x18_Overflow(UD60x18 x);
/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in uint128.
error PRBMath_UD60x18_IntoUint128_Overflow(UD60x18 x);
/// @notice Thrown when trying to cast a UD60x18 number that doesn't fit in uint40.
error PRBMath_UD60x18_IntoUint40_Overflow(UD60x18 x);
/// @notice Thrown when taking the logarithm of a number less than UNIT.
error PRBMath_UD60x18_Log_InputTooSmall(UD60x18 x);
/// @notice Thrown when calculating the square root overflows UD60x18.
error PRBMath_UD60x18_Sqrt_Overflow(UD60x18 x);// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { wrap } from "./Casting.sol";
import { UD60x18 } from "./ValueType.sol";
/// @notice Implements the checked addition operation (+) in the UD60x18 type.
function add(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
result = wrap(x.unwrap() + y.unwrap());
}
/// @notice Implements the AND (&) bitwise operation in the UD60x18 type.
function and(UD60x18 x, uint256 bits) pure returns (UD60x18 result) {
result = wrap(x.unwrap() & bits);
}
/// @notice Implements the AND (&) bitwise operation in the UD60x18 type.
function and2(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
result = wrap(x.unwrap() & y.unwrap());
}
/// @notice Implements the equal operation (==) in the UD60x18 type.
function eq(UD60x18 x, UD60x18 y) pure returns (bool result) {
result = x.unwrap() == y.unwrap();
}
/// @notice Implements the greater than operation (>) in the UD60x18 type.
function gt(UD60x18 x, UD60x18 y) pure returns (bool result) {
result = x.unwrap() > y.unwrap();
}
/// @notice Implements the greater than or equal to operation (>=) in the UD60x18 type.
function gte(UD60x18 x, UD60x18 y) pure returns (bool result) {
result = x.unwrap() >= y.unwrap();
}
/// @notice Implements a zero comparison check function in the UD60x18 type.
function isZero(UD60x18 x) pure returns (bool result) {
// This wouldn't work if x could be negative.
result = x.unwrap() == 0;
}
/// @notice Implements the left shift operation (<<) in the UD60x18 type.
function lshift(UD60x18 x, uint256 bits) pure returns (UD60x18 result) {
result = wrap(x.unwrap() << bits);
}
/// @notice Implements the lower than operation (<) in the UD60x18 type.
function lt(UD60x18 x, UD60x18 y) pure returns (bool result) {
result = x.unwrap() < y.unwrap();
}
/// @notice Implements the lower than or equal to operation (<=) in the UD60x18 type.
function lte(UD60x18 x, UD60x18 y) pure returns (bool result) {
result = x.unwrap() <= y.unwrap();
}
/// @notice Implements the checked modulo operation (%) in the UD60x18 type.
function mod(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
result = wrap(x.unwrap() % y.unwrap());
}
/// @notice Implements the not equal operation (!=) in the UD60x18 type.
function neq(UD60x18 x, UD60x18 y) pure returns (bool result) {
result = x.unwrap() != y.unwrap();
}
/// @notice Implements the NOT (~) bitwise operation in the UD60x18 type.
function not(UD60x18 x) pure returns (UD60x18 result) {
result = wrap(~x.unwrap());
}
/// @notice Implements the OR (|) bitwise operation in the UD60x18 type.
function or(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
result = wrap(x.unwrap() | y.unwrap());
}
/// @notice Implements the right shift operation (>>) in the UD60x18 type.
function rshift(UD60x18 x, uint256 bits) pure returns (UD60x18 result) {
result = wrap(x.unwrap() >> bits);
}
/// @notice Implements the checked subtraction operation (-) in the UD60x18 type.
function sub(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
result = wrap(x.unwrap() - y.unwrap());
}
/// @notice Implements the unchecked addition operation (+) in the UD60x18 type.
function uncheckedAdd(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
unchecked {
result = wrap(x.unwrap() + y.unwrap());
}
}
/// @notice Implements the unchecked subtraction operation (-) in the UD60x18 type.
function uncheckedSub(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
unchecked {
result = wrap(x.unwrap() - y.unwrap());
}
}
/// @notice Implements the XOR (^) bitwise operation in the UD60x18 type.
function xor(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
result = wrap(x.unwrap() ^ y.unwrap());
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "../Common.sol" as Common;
import "./Errors.sol" as Errors;
import { wrap } from "./Casting.sol";
import {
uEXP_MAX_INPUT,
uEXP2_MAX_INPUT,
uHALF_UNIT,
uLOG2_10,
uLOG2_E,
uMAX_UD60x18,
uMAX_WHOLE_UD60x18,
UNIT,
uUNIT,
uUNIT_SQUARED,
ZERO
} from "./Constants.sol";
import { UD60x18 } from "./ValueType.sol";
/*//////////////////////////////////////////////////////////////////////////
MATHEMATICAL FUNCTIONS
//////////////////////////////////////////////////////////////////////////*/
/// @notice Calculates the arithmetic average of x and y using the following formula:
///
/// $$
/// avg(x, y) = (x & y) + ((xUint ^ yUint) / 2)
/// $$
///
/// In English, this is what this formula does:
///
/// 1. AND x and y.
/// 2. Calculate half of XOR x and y.
/// 3. Add the two results together.
///
/// This technique is known as SWAR, which stands for "SIMD within a register". You can read more about it here:
/// https://devblogs.microsoft.com/oldnewthing/20220207-00/?p=106223
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// @param x The first operand as a UD60x18 number.
/// @param y The second operand as a UD60x18 number.
/// @return result The arithmetic average as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function avg(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
uint256 xUint = x.unwrap();
uint256 yUint = y.unwrap();
unchecked {
result = wrap((xUint & yUint) + ((xUint ^ yUint) >> 1));
}
}
/// @notice Yields the smallest whole number greater than or equal to x.
///
/// @dev This is optimized for fractional value inputs, because for every whole value there are (1e18 - 1) fractional
/// counterparts. See https://en.wikipedia.org/wiki/Floor_and_ceiling_functions.
///
/// Requirements:
/// - x ≤ MAX_WHOLE_UD60x18
///
/// @param x The UD60x18 number to ceil.
/// @return result The smallest whole number greater than or equal to x, as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function ceil(UD60x18 x) pure returns (UD60x18 result) {
uint256 xUint = x.unwrap();
if (xUint > uMAX_WHOLE_UD60x18) {
revert Errors.PRBMath_UD60x18_Ceil_Overflow(x);
}
assembly ("memory-safe") {
// Equivalent to `x % UNIT`.
let remainder := mod(x, uUNIT)
// Equivalent to `UNIT - remainder`.
let delta := sub(uUNIT, remainder)
// Equivalent to `x + remainder > 0 ? delta : 0`.
result := add(x, mul(delta, gt(remainder, 0)))
}
}
/// @notice Divides two UD60x18 numbers, returning a new UD60x18 number.
///
/// @dev Uses {Common.mulDiv} to enable overflow-safe multiplication and division.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv}.
///
/// Requirements:
/// - Refer to the requirements in {Common.mulDiv}.
///
/// @param x The numerator as a UD60x18 number.
/// @param y The denominator as a UD60x18 number.
/// @return result The quotient as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function div(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
result = wrap(Common.mulDiv(x.unwrap(), uUNIT, y.unwrap()));
}
/// @notice Calculates the natural exponent of x using the following formula:
///
/// $$
/// e^x = 2^{x * log_2{e}}
/// $$
///
/// @dev Requirements:
/// - x ≤ 133_084258667509499440
///
/// @param x The exponent as a UD60x18 number.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function exp(UD60x18 x) pure returns (UD60x18 result) {
uint256 xUint = x.unwrap();
// This check prevents values greater than 192e18 from being passed to {exp2}.
if (xUint > uEXP_MAX_INPUT) {
revert Errors.PRBMath_UD60x18_Exp_InputTooBig(x);
}
unchecked {
// Inline the fixed-point multiplication to save gas.
uint256 doubleUnitProduct = xUint * uLOG2_E;
result = exp2(wrap(doubleUnitProduct / uUNIT));
}
}
/// @notice Calculates the binary exponent of x using the binary fraction method.
///
/// @dev See https://ethereum.stackexchange.com/q/79903/24693
///
/// Requirements:
/// - x < 192e18
/// - The result must fit in UD60x18.
///
/// @param x The exponent as a UD60x18 number.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function exp2(UD60x18 x) pure returns (UD60x18 result) {
uint256 xUint = x.unwrap();
// Numbers greater than or equal to 192e18 don't fit in the 192.64-bit format.
if (xUint > uEXP2_MAX_INPUT) {
revert Errors.PRBMath_UD60x18_Exp2_InputTooBig(x);
}
// Convert x to the 192.64-bit fixed-point format.
uint256 x_192x64 = (xUint << 64) / uUNIT;
// Pass x to the {Common.exp2} function, which uses the 192.64-bit fixed-point number representation.
result = wrap(Common.exp2(x_192x64));
}
/// @notice Yields the greatest whole number less than or equal to x.
/// @dev Optimized for fractional value inputs, because every whole value has (1e18 - 1) fractional counterparts.
/// See https://en.wikipedia.org/wiki/Floor_and_ceiling_functions.
/// @param x The UD60x18 number to floor.
/// @return result The greatest whole number less than or equal to x, as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function floor(UD60x18 x) pure returns (UD60x18 result) {
assembly ("memory-safe") {
// Equivalent to `x % UNIT`.
let remainder := mod(x, uUNIT)
// Equivalent to `x - remainder > 0 ? remainder : 0)`.
result := sub(x, mul(remainder, gt(remainder, 0)))
}
}
/// @notice Yields the excess beyond the floor of x using the odd function definition.
/// @dev See https://en.wikipedia.org/wiki/Fractional_part.
/// @param x The UD60x18 number to get the fractional part of.
/// @return result The fractional part of x as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function frac(UD60x18 x) pure returns (UD60x18 result) {
assembly ("memory-safe") {
result := mod(x, uUNIT)
}
}
/// @notice Calculates the geometric mean of x and y, i.e. $\sqrt{x * y}$, rounding down.
///
/// @dev Requirements:
/// - x * y must fit in UD60x18.
///
/// @param x The first operand as a UD60x18 number.
/// @param y The second operand as a UD60x18 number.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function gm(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
uint256 xUint = x.unwrap();
uint256 yUint = y.unwrap();
if (xUint == 0 || yUint == 0) {
return ZERO;
}
unchecked {
// Checking for overflow this way is faster than letting Solidity do it.
uint256 xyUint = xUint * yUint;
if (xyUint / xUint != yUint) {
revert Errors.PRBMath_UD60x18_Gm_Overflow(x, y);
}
// We don't need to multiply the result by `UNIT` here because the x*y product picked up a factor of `UNIT`
// during multiplication. See the comments in {Common.sqrt}.
result = wrap(Common.sqrt(xyUint));
}
}
/// @notice Calculates the inverse of x.
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x must not be zero.
///
/// @param x The UD60x18 number for which to calculate the inverse.
/// @return result The inverse as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function inv(UD60x18 x) pure returns (UD60x18 result) {
unchecked {
result = wrap(uUNIT_SQUARED / x.unwrap());
}
}
/// @notice Calculates the natural logarithm of x using the following formula:
///
/// $$
/// ln{x} = log_2{x} / log_2{e}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {log2}.
/// - The precision isn't sufficiently fine-grained to return exactly `UNIT` when the input is `E`.
///
/// Requirements:
/// - Refer to the requirements in {log2}.
///
/// @param x The UD60x18 number for which to calculate the natural logarithm.
/// @return result The natural logarithm as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function ln(UD60x18 x) pure returns (UD60x18 result) {
unchecked {
// Inline the fixed-point multiplication to save gas. This is overflow-safe because the maximum value that
// {log2} can return is ~196_205294292027477728.
result = wrap(log2(x).unwrap() * uUNIT / uLOG2_E);
}
}
/// @notice Calculates the common logarithm of x using the following formula:
///
/// $$
/// log_{10}{x} = log_2{x} / log_2{10}
/// $$
///
/// However, if x is an exact power of ten, a hard coded value is returned.
///
/// @dev Notes:
/// - Refer to the notes in {log2}.
///
/// Requirements:
/// - Refer to the requirements in {log2}.
///
/// @param x The UD60x18 number for which to calculate the common logarithm.
/// @return result The common logarithm as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function log10(UD60x18 x) pure returns (UD60x18 result) {
uint256 xUint = x.unwrap();
if (xUint < uUNIT) {
revert Errors.PRBMath_UD60x18_Log_InputTooSmall(x);
}
// Note that the `mul` in this assembly block is the standard multiplication operation, not {UD60x18.mul}.
// prettier-ignore
assembly ("memory-safe") {
switch x
case 1 { result := mul(uUNIT, sub(0, 18)) }
case 10 { result := mul(uUNIT, sub(1, 18)) }
case 100 { result := mul(uUNIT, sub(2, 18)) }
case 1000 { result := mul(uUNIT, sub(3, 18)) }
case 10000 { result := mul(uUNIT, sub(4, 18)) }
case 100000 { result := mul(uUNIT, sub(5, 18)) }
case 1000000 { result := mul(uUNIT, sub(6, 18)) }
case 10000000 { result := mul(uUNIT, sub(7, 18)) }
case 100000000 { result := mul(uUNIT, sub(8, 18)) }
case 1000000000 { result := mul(uUNIT, sub(9, 18)) }
case 10000000000 { result := mul(uUNIT, sub(10, 18)) }
case 100000000000 { result := mul(uUNIT, sub(11, 18)) }
case 1000000000000 { result := mul(uUNIT, sub(12, 18)) }
case 10000000000000 { result := mul(uUNIT, sub(13, 18)) }
case 100000000000000 { result := mul(uUNIT, sub(14, 18)) }
case 1000000000000000 { result := mul(uUNIT, sub(15, 18)) }
case 10000000000000000 { result := mul(uUNIT, sub(16, 18)) }
case 100000000000000000 { result := mul(uUNIT, sub(17, 18)) }
case 1000000000000000000 { result := 0 }
case 10000000000000000000 { result := uUNIT }
case 100000000000000000000 { result := mul(uUNIT, 2) }
case 1000000000000000000000 { result := mul(uUNIT, 3) }
case 10000000000000000000000 { result := mul(uUNIT, 4) }
case 100000000000000000000000 { result := mul(uUNIT, 5) }
case 1000000000000000000000000 { result := mul(uUNIT, 6) }
case 10000000000000000000000000 { result := mul(uUNIT, 7) }
case 100000000000000000000000000 { result := mul(uUNIT, 8) }
case 1000000000000000000000000000 { result := mul(uUNIT, 9) }
case 10000000000000000000000000000 { result := mul(uUNIT, 10) }
case 100000000000000000000000000000 { result := mul(uUNIT, 11) }
case 1000000000000000000000000000000 { result := mul(uUNIT, 12) }
case 10000000000000000000000000000000 { result := mul(uUNIT, 13) }
case 100000000000000000000000000000000 { result := mul(uUNIT, 14) }
case 1000000000000000000000000000000000 { result := mul(uUNIT, 15) }
case 10000000000000000000000000000000000 { result := mul(uUNIT, 16) }
case 100000000000000000000000000000000000 { result := mul(uUNIT, 17) }
case 1000000000000000000000000000000000000 { result := mul(uUNIT, 18) }
case 10000000000000000000000000000000000000 { result := mul(uUNIT, 19) }
case 100000000000000000000000000000000000000 { result := mul(uUNIT, 20) }
case 1000000000000000000000000000000000000000 { result := mul(uUNIT, 21) }
case 10000000000000000000000000000000000000000 { result := mul(uUNIT, 22) }
case 100000000000000000000000000000000000000000 { result := mul(uUNIT, 23) }
case 1000000000000000000000000000000000000000000 { result := mul(uUNIT, 24) }
case 10000000000000000000000000000000000000000000 { result := mul(uUNIT, 25) }
case 100000000000000000000000000000000000000000000 { result := mul(uUNIT, 26) }
case 1000000000000000000000000000000000000000000000 { result := mul(uUNIT, 27) }
case 10000000000000000000000000000000000000000000000 { result := mul(uUNIT, 28) }
case 100000000000000000000000000000000000000000000000 { result := mul(uUNIT, 29) }
case 1000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 30) }
case 10000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 31) }
case 100000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 32) }
case 1000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 33) }
case 10000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 34) }
case 100000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 35) }
case 1000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 36) }
case 10000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 37) }
case 100000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 38) }
case 1000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 39) }
case 10000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 40) }
case 100000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 41) }
case 1000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 42) }
case 10000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 43) }
case 100000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 44) }
case 1000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 45) }
case 10000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 46) }
case 100000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 47) }
case 1000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 48) }
case 10000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 49) }
case 100000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 50) }
case 1000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 51) }
case 10000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 52) }
case 100000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 53) }
case 1000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 54) }
case 10000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 55) }
case 100000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 56) }
case 1000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 57) }
case 10000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 58) }
case 100000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 59) }
default { result := uMAX_UD60x18 }
}
if (result.unwrap() == uMAX_UD60x18) {
unchecked {
// Inline the fixed-point division to save gas.
result = wrap(log2(x).unwrap() * uUNIT / uLOG2_10);
}
}
}
/// @notice Calculates the binary logarithm of x using the iterative approximation algorithm:
///
/// $$
/// log_2{x} = n + log_2{y}, \text{ where } y = x*2^{-n}, \ y \in [1, 2)
/// $$
///
/// For $0 \leq x \lt 1$, the input is inverted:
///
/// $$
/// log_2{x} = -log_2{\frac{1}{x}}
/// $$
///
/// @dev See https://en.wikipedia.org/wiki/Binary_logarithm#Iterative_approximation
///
/// Notes:
/// - Due to the lossy precision of the iterative approximation, the results are not perfectly accurate to the last decimal.
///
/// Requirements:
/// - x ≥ UNIT
///
/// @param x The UD60x18 number for which to calculate the binary logarithm.
/// @return result The binary logarithm as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function log2(UD60x18 x) pure returns (UD60x18 result) {
uint256 xUint = x.unwrap();
if (xUint < uUNIT) {
revert Errors.PRBMath_UD60x18_Log_InputTooSmall(x);
}
unchecked {
// Calculate the integer part of the logarithm.
uint256 n = Common.msb(xUint / uUNIT);
// This is the integer part of the logarithm as a UD60x18 number. The operation can't overflow because n
// n is at most 255 and UNIT is 1e18.
uint256 resultUint = n * uUNIT;
// Calculate $y = x * 2^{-n}$.
uint256 y = xUint >> n;
// If y is the unit number, the fractional part is zero.
if (y == uUNIT) {
return wrap(resultUint);
}
// Calculate the fractional part via the iterative approximation.
// The `delta >>= 1` part is equivalent to `delta /= 2`, but shifting bits is more gas efficient.
uint256 DOUBLE_UNIT = 2e18;
for (uint256 delta = uHALF_UNIT; delta > 0; delta >>= 1) {
y = (y * y) / uUNIT;
// Is y^2 >= 2e18 and so in the range [2e18, 4e18)?
if (y >= DOUBLE_UNIT) {
// Add the 2^{-m} factor to the logarithm.
resultUint += delta;
// Halve y, which corresponds to z/2 in the Wikipedia article.
y >>= 1;
}
}
result = wrap(resultUint);
}
}
/// @notice Multiplies two UD60x18 numbers together, returning a new UD60x18 number.
///
/// @dev Uses {Common.mulDiv} to enable overflow-safe multiplication and division.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv}.
///
/// Requirements:
/// - Refer to the requirements in {Common.mulDiv}.
///
/// @dev See the documentation in {Common.mulDiv18}.
/// @param x The multiplicand as a UD60x18 number.
/// @param y The multiplier as a UD60x18 number.
/// @return result The product as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function mul(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
result = wrap(Common.mulDiv18(x.unwrap(), y.unwrap()));
}
/// @notice Raises x to the power of y.
///
/// For $1 \leq x \leq \infty$, the following standard formula is used:
///
/// $$
/// x^y = 2^{log_2{x} * y}
/// $$
///
/// For $0 \leq x \lt 1$, since the unsigned {log2} is undefined, an equivalent formula is used:
///
/// $$
/// i = \frac{1}{x}
/// w = 2^{log_2{i} * y}
/// x^y = \frac{1}{w}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {log2} and {mul}.
/// - Returns `UNIT` for 0^0.
/// - It may not perform well with very small values of x. Consider using SD59x18 as an alternative.
///
/// Requirements:
/// - Refer to the requirements in {exp2}, {log2}, and {mul}.
///
/// @param x The base as a UD60x18 number.
/// @param y The exponent as a UD60x18 number.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function pow(UD60x18 x, UD60x18 y) pure returns (UD60x18 result) {
uint256 xUint = x.unwrap();
uint256 yUint = y.unwrap();
// If both x and y are zero, the result is `UNIT`. If just x is zero, the result is always zero.
if (xUint == 0) {
return yUint == 0 ? UNIT : ZERO;
}
// If x is `UNIT`, the result is always `UNIT`.
else if (xUint == uUNIT) {
return UNIT;
}
// If y is zero, the result is always `UNIT`.
if (yUint == 0) {
return UNIT;
}
// If y is `UNIT`, the result is always x.
else if (yUint == uUNIT) {
return x;
}
// If x is > UNIT, use the standard formula.
if (xUint > uUNIT) {
result = exp2(mul(log2(x), y));
}
// Conversely, if x < UNIT, use the equivalent formula.
else {
UD60x18 i = wrap(uUNIT_SQUARED / xUint);
UD60x18 w = exp2(mul(log2(i), y));
result = wrap(uUNIT_SQUARED / w.unwrap());
}
}
/// @notice Raises x (a UD60x18 number) to the power y (an unsigned basic integer) using the well-known
/// algorithm "exponentiation by squaring".
///
/// @dev See https://en.wikipedia.org/wiki/Exponentiation_by_squaring.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv18}.
/// - Returns `UNIT` for 0^0.
///
/// Requirements:
/// - The result must fit in UD60x18.
///
/// @param x The base as a UD60x18 number.
/// @param y The exponent as a uint256.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function powu(UD60x18 x, uint256 y) pure returns (UD60x18 result) {
// Calculate the first iteration of the loop in advance.
uint256 xUint = x.unwrap();
uint256 resultUint = y & 1 > 0 ? xUint : uUNIT;
// Equivalent to `for(y /= 2; y > 0; y /= 2)`.
for (y >>= 1; y > 0; y >>= 1) {
xUint = Common.mulDiv18(xUint, xUint);
// Equivalent to `y % 2 == 1`.
if (y & 1 > 0) {
resultUint = Common.mulDiv18(resultUint, xUint);
}
}
result = wrap(resultUint);
}
/// @notice Calculates the square root of x using the Babylonian method.
///
/// @dev See https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method.
///
/// Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x ≤ MAX_UD60x18 / UNIT
///
/// @param x The UD60x18 number for which to calculate the square root.
/// @return result The result as a UD60x18 number.
/// @custom:smtchecker abstract-function-nondet
function sqrt(UD60x18 x) pure returns (UD60x18 result) {
uint256 xUint = x.unwrap();
unchecked {
if (xUint > uMAX_UD60x18 / uUNIT) {
revert Errors.PRBMath_UD60x18_Sqrt_Overflow(x);
}
// Multiply x by `UNIT` to account for the factor of `UNIT` picked up when multiplying two UD60x18 numbers.
// In this case, the two numbers are both the square root.
result = wrap(Common.sqrt(xUint * uUNIT));
}
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "./Errors.sol" as CastingErrors;
import { MAX_UINT128, MAX_UINT40 } from "../Common.sol";
import { uMAX_SD1x18, uMIN_SD1x18 } from "../sd1x18/Constants.sol";
import { SD1x18 } from "../sd1x18/ValueType.sol";
import { uMAX_SD21x18, uMIN_SD21x18 } from "../sd21x18/Constants.sol";
import { SD21x18 } from "../sd21x18/ValueType.sol";
import { uMAX_UD2x18 } from "../ud2x18/Constants.sol";
import { UD2x18 } from "../ud2x18/ValueType.sol";
import { uMAX_UD21x18 } from "../ud21x18/Constants.sol";
import { UD21x18 } from "../ud21x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";
import { SD59x18 } from "./ValueType.sol";
/// @notice Casts an SD59x18 number into int256.
/// @dev This is basically a functional alias for {unwrap}.
function intoInt256(SD59x18 x) pure returns (int256 result) {
result = SD59x18.unwrap(x);
}
/// @notice Casts an SD59x18 number into SD1x18.
/// @dev Requirements:
/// - x ≥ uMIN_SD1x18
/// - x ≤ uMAX_SD1x18
function intoSD1x18(SD59x18 x) pure returns (SD1x18 result) {
int256 xInt = SD59x18.unwrap(x);
if (xInt < uMIN_SD1x18) {
revert CastingErrors.PRBMath_SD59x18_IntoSD1x18_Underflow(x);
}
if (xInt > uMAX_SD1x18) {
revert CastingErrors.PRBMath_SD59x18_IntoSD1x18_Overflow(x);
}
result = SD1x18.wrap(int64(xInt));
}
/// @notice Casts an SD59x18 number into SD21x18.
/// @dev Requirements:
/// - x ≥ uMIN_SD21x18
/// - x ≤ uMAX_SD21x18
function intoSD21x18(SD59x18 x) pure returns (SD21x18 result) {
int256 xInt = SD59x18.unwrap(x);
if (xInt < uMIN_SD21x18) {
revert CastingErrors.PRBMath_SD59x18_IntoSD21x18_Underflow(x);
}
if (xInt > uMAX_SD21x18) {
revert CastingErrors.PRBMath_SD59x18_IntoSD21x18_Overflow(x);
}
result = SD21x18.wrap(int128(xInt));
}
/// @notice Casts an SD59x18 number into UD2x18.
/// @dev Requirements:
/// - x ≥ 0
/// - x ≤ uMAX_UD2x18
function intoUD2x18(SD59x18 x) pure returns (UD2x18 result) {
int256 xInt = SD59x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD59x18_IntoUD2x18_Underflow(x);
}
if (xInt > int256(uint256(uMAX_UD2x18))) {
revert CastingErrors.PRBMath_SD59x18_IntoUD2x18_Overflow(x);
}
result = UD2x18.wrap(uint64(uint256(xInt)));
}
/// @notice Casts an SD59x18 number into UD21x18.
/// @dev Requirements:
/// - x ≥ 0
/// - x ≤ uMAX_UD21x18
function intoUD21x18(SD59x18 x) pure returns (UD21x18 result) {
int256 xInt = SD59x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD59x18_IntoUD21x18_Underflow(x);
}
if (xInt > int256(uint256(uMAX_UD21x18))) {
revert CastingErrors.PRBMath_SD59x18_IntoUD21x18_Overflow(x);
}
result = UD21x18.wrap(uint128(uint256(xInt)));
}
/// @notice Casts an SD59x18 number into UD60x18.
/// @dev Requirements:
/// - x ≥ 0
function intoUD60x18(SD59x18 x) pure returns (UD60x18 result) {
int256 xInt = SD59x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD59x18_IntoUD60x18_Underflow(x);
}
result = UD60x18.wrap(uint256(xInt));
}
/// @notice Casts an SD59x18 number into uint256.
/// @dev Requirements:
/// - x ≥ 0
function intoUint256(SD59x18 x) pure returns (uint256 result) {
int256 xInt = SD59x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD59x18_IntoUint256_Underflow(x);
}
result = uint256(xInt);
}
/// @notice Casts an SD59x18 number into uint128.
/// @dev Requirements:
/// - x ≥ 0
/// - x ≤ uMAX_UINT128
function intoUint128(SD59x18 x) pure returns (uint128 result) {
int256 xInt = SD59x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD59x18_IntoUint128_Underflow(x);
}
if (xInt > int256(uint256(MAX_UINT128))) {
revert CastingErrors.PRBMath_SD59x18_IntoUint128_Overflow(x);
}
result = uint128(uint256(xInt));
}
/// @notice Casts an SD59x18 number into uint40.
/// @dev Requirements:
/// - x ≥ 0
/// - x ≤ MAX_UINT40
function intoUint40(SD59x18 x) pure returns (uint40 result) {
int256 xInt = SD59x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD59x18_IntoUint40_Underflow(x);
}
if (xInt > int256(uint256(MAX_UINT40))) {
revert CastingErrors.PRBMath_SD59x18_IntoUint40_Overflow(x);
}
result = uint40(uint256(xInt));
}
/// @notice Alias for {wrap}.
function sd(int256 x) pure returns (SD59x18 result) {
result = SD59x18.wrap(x);
}
/// @notice Alias for {wrap}.
function sd59x18(int256 x) pure returns (SD59x18 result) {
result = SD59x18.wrap(x);
}
/// @notice Unwraps an SD59x18 number into int256.
function unwrap(SD59x18 x) pure returns (int256 result) {
result = SD59x18.unwrap(x);
}
/// @notice Wraps an int256 number into SD59x18.
function wrap(int256 x) pure returns (SD59x18 result) {
result = SD59x18.wrap(x);
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { wrap } from "./Casting.sol";
import { SD59x18 } from "./ValueType.sol";
/// @notice Implements the checked addition operation (+) in the SD59x18 type.
function add(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
return wrap(x.unwrap() + y.unwrap());
}
/// @notice Implements the AND (&) bitwise operation in the SD59x18 type.
function and(SD59x18 x, int256 bits) pure returns (SD59x18 result) {
return wrap(x.unwrap() & bits);
}
/// @notice Implements the AND (&) bitwise operation in the SD59x18 type.
function and2(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
return wrap(x.unwrap() & y.unwrap());
}
/// @notice Implements the equal (=) operation in the SD59x18 type.
function eq(SD59x18 x, SD59x18 y) pure returns (bool result) {
result = x.unwrap() == y.unwrap();
}
/// @notice Implements the greater than operation (>) in the SD59x18 type.
function gt(SD59x18 x, SD59x18 y) pure returns (bool result) {
result = x.unwrap() > y.unwrap();
}
/// @notice Implements the greater than or equal to operation (>=) in the SD59x18 type.
function gte(SD59x18 x, SD59x18 y) pure returns (bool result) {
result = x.unwrap() >= y.unwrap();
}
/// @notice Implements a zero comparison check function in the SD59x18 type.
function isZero(SD59x18 x) pure returns (bool result) {
result = x.unwrap() == 0;
}
/// @notice Implements the left shift operation (<<) in the SD59x18 type.
function lshift(SD59x18 x, uint256 bits) pure returns (SD59x18 result) {
result = wrap(x.unwrap() << bits);
}
/// @notice Implements the lower than operation (<) in the SD59x18 type.
function lt(SD59x18 x, SD59x18 y) pure returns (bool result) {
result = x.unwrap() < y.unwrap();
}
/// @notice Implements the lower than or equal to operation (<=) in the SD59x18 type.
function lte(SD59x18 x, SD59x18 y) pure returns (bool result) {
result = x.unwrap() <= y.unwrap();
}
/// @notice Implements the unchecked modulo operation (%) in the SD59x18 type.
function mod(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
result = wrap(x.unwrap() % y.unwrap());
}
/// @notice Implements the not equal operation (!=) in the SD59x18 type.
function neq(SD59x18 x, SD59x18 y) pure returns (bool result) {
result = x.unwrap() != y.unwrap();
}
/// @notice Implements the NOT (~) bitwise operation in the SD59x18 type.
function not(SD59x18 x) pure returns (SD59x18 result) {
result = wrap(~x.unwrap());
}
/// @notice Implements the OR (|) bitwise operation in the SD59x18 type.
function or(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
result = wrap(x.unwrap() | y.unwrap());
}
/// @notice Implements the right shift operation (>>) in the SD59x18 type.
function rshift(SD59x18 x, uint256 bits) pure returns (SD59x18 result) {
result = wrap(x.unwrap() >> bits);
}
/// @notice Implements the checked subtraction operation (-) in the SD59x18 type.
function sub(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
result = wrap(x.unwrap() - y.unwrap());
}
/// @notice Implements the checked unary minus operation (-) in the SD59x18 type.
function unary(SD59x18 x) pure returns (SD59x18 result) {
result = wrap(-x.unwrap());
}
/// @notice Implements the unchecked addition operation (+) in the SD59x18 type.
function uncheckedAdd(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
unchecked {
result = wrap(x.unwrap() + y.unwrap());
}
}
/// @notice Implements the unchecked subtraction operation (-) in the SD59x18 type.
function uncheckedSub(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
unchecked {
result = wrap(x.unwrap() - y.unwrap());
}
}
/// @notice Implements the unchecked unary minus operation (-) in the SD59x18 type.
function uncheckedUnary(SD59x18 x) pure returns (SD59x18 result) {
unchecked {
result = wrap(-x.unwrap());
}
}
/// @notice Implements the XOR (^) bitwise operation in the SD59x18 type.
function xor(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
result = wrap(x.unwrap() ^ y.unwrap());
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "../Common.sol" as Common;
import "./Errors.sol" as Errors;
import {
uEXP_MAX_INPUT,
uEXP2_MAX_INPUT,
uEXP_MIN_THRESHOLD,
uEXP2_MIN_THRESHOLD,
uHALF_UNIT,
uLOG2_10,
uLOG2_E,
uMAX_SD59x18,
uMAX_WHOLE_SD59x18,
uMIN_SD59x18,
uMIN_WHOLE_SD59x18,
UNIT,
uUNIT,
uUNIT_SQUARED,
ZERO
} from "./Constants.sol";
import { wrap } from "./Helpers.sol";
import { SD59x18 } from "./ValueType.sol";
/// @notice Calculates the absolute value of x.
///
/// @dev Requirements:
/// - x > MIN_SD59x18.
///
/// @param x The SD59x18 number for which to calculate the absolute value.
/// @return result The absolute value of x as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function abs(SD59x18 x) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
if (xInt == uMIN_SD59x18) {
revert Errors.PRBMath_SD59x18_Abs_MinSD59x18();
}
result = xInt < 0 ? wrap(-xInt) : x;
}
/// @notice Calculates the arithmetic average of x and y.
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// @param x The first operand as an SD59x18 number.
/// @param y The second operand as an SD59x18 number.
/// @return result The arithmetic average as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function avg(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
int256 yInt = y.unwrap();
unchecked {
// This operation is equivalent to `x / 2 + y / 2`, and it can never overflow.
int256 sum = (xInt >> 1) + (yInt >> 1);
if (sum < 0) {
// If at least one of x and y is odd, add 1 to the result, because shifting negative numbers to the right
// rounds toward negative infinity. The right part is equivalent to `sum + (x % 2 == 1 || y % 2 == 1)`.
assembly ("memory-safe") {
result := add(sum, and(or(xInt, yInt), 1))
}
} else {
// Add 1 if both x and y are odd to account for the double 0.5 remainder truncated after shifting.
result = wrap(sum + (xInt & yInt & 1));
}
}
}
/// @notice Yields the smallest whole number greater than or equal to x.
///
/// @dev Optimized for fractional value inputs, because every whole value has (1e18 - 1) fractional counterparts.
/// See https://en.wikipedia.org/wiki/Floor_and_ceiling_functions.
///
/// Requirements:
/// - x ≤ MAX_WHOLE_SD59x18
///
/// @param x The SD59x18 number to ceil.
/// @return result The smallest whole number greater than or equal to x, as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function ceil(SD59x18 x) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
if (xInt > uMAX_WHOLE_SD59x18) {
revert Errors.PRBMath_SD59x18_Ceil_Overflow(x);
}
int256 remainder = xInt % uUNIT;
if (remainder == 0) {
result = x;
} else {
unchecked {
// Solidity uses C fmod style, which returns a modulus with the same sign as x.
int256 resultInt = xInt - remainder;
if (xInt > 0) {
resultInt += uUNIT;
}
result = wrap(resultInt);
}
}
}
/// @notice Divides two SD59x18 numbers, returning a new SD59x18 number.
///
/// @dev This is an extension of {Common.mulDiv} for signed numbers, which works by computing the signs and the absolute
/// values separately.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv}.
/// - The result is rounded toward zero.
///
/// Requirements:
/// - Refer to the requirements in {Common.mulDiv}.
/// - None of the inputs can be `MIN_SD59x18`.
/// - The denominator must not be zero.
/// - The result must fit in SD59x18.
///
/// @param x The numerator as an SD59x18 number.
/// @param y The denominator as an SD59x18 number.
/// @return result The quotient as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function div(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
int256 yInt = y.unwrap();
if (xInt == uMIN_SD59x18 || yInt == uMIN_SD59x18) {
revert Errors.PRBMath_SD59x18_Div_InputTooSmall();
}
// Get hold of the absolute values of x and y.
uint256 xAbs;
uint256 yAbs;
unchecked {
xAbs = xInt < 0 ? uint256(-xInt) : uint256(xInt);
yAbs = yInt < 0 ? uint256(-yInt) : uint256(yInt);
}
// Compute the absolute value (x*UNIT÷y). The resulting value must fit in SD59x18.
uint256 resultAbs = Common.mulDiv(xAbs, uint256(uUNIT), yAbs);
if (resultAbs > uint256(uMAX_SD59x18)) {
revert Errors.PRBMath_SD59x18_Div_Overflow(x, y);
}
// Check if x and y have the same sign using two's complement representation. The left-most bit represents the sign (1 for
// negative, 0 for positive or zero).
bool sameSign = (xInt ^ yInt) > -1;
// If the inputs have the same sign, the result should be positive. Otherwise, it should be negative.
unchecked {
result = wrap(sameSign ? int256(resultAbs) : -int256(resultAbs));
}
}
/// @notice Calculates the natural exponent of x using the following formula:
///
/// $$
/// e^x = 2^{x * log_2{e}}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {exp2}.
///
/// Requirements:
/// - Refer to the requirements in {exp2}.
/// - x < 133_084258667509499441.
///
/// @param x The exponent as an SD59x18 number.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function exp(SD59x18 x) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
// Any input less than the threshold returns zero.
// This check also prevents an overflow for very small numbers.
if (xInt < uEXP_MIN_THRESHOLD) {
return ZERO;
}
// This check prevents values greater than 192e18 from being passed to {exp2}.
if (xInt > uEXP_MAX_INPUT) {
revert Errors.PRBMath_SD59x18_Exp_InputTooBig(x);
}
unchecked {
// Inline the fixed-point multiplication to save gas.
int256 doubleUnitProduct = xInt * uLOG2_E;
result = exp2(wrap(doubleUnitProduct / uUNIT));
}
}
/// @notice Calculates the binary exponent of x using the binary fraction method using the following formula:
///
/// $$
/// 2^{-x} = \frac{1}{2^x}
/// $$
///
/// @dev See https://ethereum.stackexchange.com/q/79903/24693.
///
/// Notes:
/// - If x < -59_794705707972522261, the result is zero.
///
/// Requirements:
/// - x < 192e18.
/// - The result must fit in SD59x18.
///
/// @param x The exponent as an SD59x18 number.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function exp2(SD59x18 x) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
if (xInt < 0) {
// The inverse of any number less than the threshold is truncated to zero.
if (xInt < uEXP2_MIN_THRESHOLD) {
return ZERO;
}
unchecked {
// Inline the fixed-point inversion to save gas.
result = wrap(uUNIT_SQUARED / exp2(wrap(-xInt)).unwrap());
}
} else {
// Numbers greater than or equal to 192e18 don't fit in the 192.64-bit format.
if (xInt > uEXP2_MAX_INPUT) {
revert Errors.PRBMath_SD59x18_Exp2_InputTooBig(x);
}
unchecked {
// Convert x to the 192.64-bit fixed-point format.
uint256 x_192x64 = uint256((xInt << 64) / uUNIT);
// It is safe to cast the result to int256 due to the checks above.
result = wrap(int256(Common.exp2(x_192x64)));
}
}
}
/// @notice Yields the greatest whole number less than or equal to x.
///
/// @dev Optimized for fractional value inputs, because for every whole value there are (1e18 - 1) fractional
/// counterparts. See https://en.wikipedia.org/wiki/Floor_and_ceiling_functions.
///
/// Requirements:
/// - x ≥ MIN_WHOLE_SD59x18
///
/// @param x The SD59x18 number to floor.
/// @return result The greatest whole number less than or equal to x, as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function floor(SD59x18 x) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
if (xInt < uMIN_WHOLE_SD59x18) {
revert Errors.PRBMath_SD59x18_Floor_Underflow(x);
}
int256 remainder = xInt % uUNIT;
if (remainder == 0) {
result = x;
} else {
unchecked {
// Solidity uses C fmod style, which returns a modulus with the same sign as x.
int256 resultInt = xInt - remainder;
if (xInt < 0) {
resultInt -= uUNIT;
}
result = wrap(resultInt);
}
}
}
/// @notice Yields the excess beyond the floor of x for positive numbers and the part of the number to the right.
/// of the radix point for negative numbers.
/// @dev Based on the odd function definition. https://en.wikipedia.org/wiki/Fractional_part
/// @param x The SD59x18 number to get the fractional part of.
/// @return result The fractional part of x as an SD59x18 number.
function frac(SD59x18 x) pure returns (SD59x18 result) {
result = wrap(x.unwrap() % uUNIT);
}
/// @notice Calculates the geometric mean of x and y, i.e. $\sqrt{x * y}$.
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x * y must fit in SD59x18.
/// - x * y must not be negative, since complex numbers are not supported.
///
/// @param x The first operand as an SD59x18 number.
/// @param y The second operand as an SD59x18 number.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function gm(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
int256 yInt = y.unwrap();
if (xInt == 0 || yInt == 0) {
return ZERO;
}
unchecked {
// Equivalent to `xy / x != y`. Checking for overflow this way is faster than letting Solidity do it.
int256 xyInt = xInt * yInt;
if (xyInt / xInt != yInt) {
revert Errors.PRBMath_SD59x18_Gm_Overflow(x, y);
}
// The product must not be negative, since complex numbers are not supported.
if (xyInt < 0) {
revert Errors.PRBMath_SD59x18_Gm_NegativeProduct(x, y);
}
// We don't need to multiply the result by `UNIT` here because the x*y product picked up a factor of `UNIT`
// during multiplication. See the comments in {Common.sqrt}.
uint256 resultUint = Common.sqrt(uint256(xyInt));
result = wrap(int256(resultUint));
}
}
/// @notice Calculates the inverse of x.
///
/// @dev Notes:
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x must not be zero.
///
/// @param x The SD59x18 number for which to calculate the inverse.
/// @return result The inverse as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function inv(SD59x18 x) pure returns (SD59x18 result) {
result = wrap(uUNIT_SQUARED / x.unwrap());
}
/// @notice Calculates the natural logarithm of x using the following formula:
///
/// $$
/// ln{x} = log_2{x} / log_2{e}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {log2}.
/// - The precision isn't sufficiently fine-grained to return exactly `UNIT` when the input is `E`.
///
/// Requirements:
/// - Refer to the requirements in {log2}.
///
/// @param x The SD59x18 number for which to calculate the natural logarithm.
/// @return result The natural logarithm as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function ln(SD59x18 x) pure returns (SD59x18 result) {
// Inline the fixed-point multiplication to save gas. This is overflow-safe because the maximum value that
// {log2} can return is ~195_205294292027477728.
result = wrap(log2(x).unwrap() * uUNIT / uLOG2_E);
}
/// @notice Calculates the common logarithm of x using the following formula:
///
/// $$
/// log_{10}{x} = log_2{x} / log_2{10}
/// $$
///
/// However, if x is an exact power of ten, a hard coded value is returned.
///
/// @dev Notes:
/// - Refer to the notes in {log2}.
///
/// Requirements:
/// - Refer to the requirements in {log2}.
///
/// @param x The SD59x18 number for which to calculate the common logarithm.
/// @return result The common logarithm as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function log10(SD59x18 x) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
if (xInt < 0) {
revert Errors.PRBMath_SD59x18_Log_InputTooSmall(x);
}
// Note that the `mul` in this block is the standard multiplication operation, not {SD59x18.mul}.
// prettier-ignore
assembly ("memory-safe") {
switch x
case 1 { result := mul(uUNIT, sub(0, 18)) }
case 10 { result := mul(uUNIT, sub(1, 18)) }
case 100 { result := mul(uUNIT, sub(2, 18)) }
case 1000 { result := mul(uUNIT, sub(3, 18)) }
case 10000 { result := mul(uUNIT, sub(4, 18)) }
case 100000 { result := mul(uUNIT, sub(5, 18)) }
case 1000000 { result := mul(uUNIT, sub(6, 18)) }
case 10000000 { result := mul(uUNIT, sub(7, 18)) }
case 100000000 { result := mul(uUNIT, sub(8, 18)) }
case 1000000000 { result := mul(uUNIT, sub(9, 18)) }
case 10000000000 { result := mul(uUNIT, sub(10, 18)) }
case 100000000000 { result := mul(uUNIT, sub(11, 18)) }
case 1000000000000 { result := mul(uUNIT, sub(12, 18)) }
case 10000000000000 { result := mul(uUNIT, sub(13, 18)) }
case 100000000000000 { result := mul(uUNIT, sub(14, 18)) }
case 1000000000000000 { result := mul(uUNIT, sub(15, 18)) }
case 10000000000000000 { result := mul(uUNIT, sub(16, 18)) }
case 100000000000000000 { result := mul(uUNIT, sub(17, 18)) }
case 1000000000000000000 { result := 0 }
case 10000000000000000000 { result := uUNIT }
case 100000000000000000000 { result := mul(uUNIT, 2) }
case 1000000000000000000000 { result := mul(uUNIT, 3) }
case 10000000000000000000000 { result := mul(uUNIT, 4) }
case 100000000000000000000000 { result := mul(uUNIT, 5) }
case 1000000000000000000000000 { result := mul(uUNIT, 6) }
case 10000000000000000000000000 { result := mul(uUNIT, 7) }
case 100000000000000000000000000 { result := mul(uUNIT, 8) }
case 1000000000000000000000000000 { result := mul(uUNIT, 9) }
case 10000000000000000000000000000 { result := mul(uUNIT, 10) }
case 100000000000000000000000000000 { result := mul(uUNIT, 11) }
case 1000000000000000000000000000000 { result := mul(uUNIT, 12) }
case 10000000000000000000000000000000 { result := mul(uUNIT, 13) }
case 100000000000000000000000000000000 { result := mul(uUNIT, 14) }
case 1000000000000000000000000000000000 { result := mul(uUNIT, 15) }
case 10000000000000000000000000000000000 { result := mul(uUNIT, 16) }
case 100000000000000000000000000000000000 { result := mul(uUNIT, 17) }
case 1000000000000000000000000000000000000 { result := mul(uUNIT, 18) }
case 10000000000000000000000000000000000000 { result := mul(uUNIT, 19) }
case 100000000000000000000000000000000000000 { result := mul(uUNIT, 20) }
case 1000000000000000000000000000000000000000 { result := mul(uUNIT, 21) }
case 10000000000000000000000000000000000000000 { result := mul(uUNIT, 22) }
case 100000000000000000000000000000000000000000 { result := mul(uUNIT, 23) }
case 1000000000000000000000000000000000000000000 { result := mul(uUNIT, 24) }
case 10000000000000000000000000000000000000000000 { result := mul(uUNIT, 25) }
case 100000000000000000000000000000000000000000000 { result := mul(uUNIT, 26) }
case 1000000000000000000000000000000000000000000000 { result := mul(uUNIT, 27) }
case 10000000000000000000000000000000000000000000000 { result := mul(uUNIT, 28) }
case 100000000000000000000000000000000000000000000000 { result := mul(uUNIT, 29) }
case 1000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 30) }
case 10000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 31) }
case 100000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 32) }
case 1000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 33) }
case 10000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 34) }
case 100000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 35) }
case 1000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 36) }
case 10000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 37) }
case 100000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 38) }
case 1000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 39) }
case 10000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 40) }
case 100000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 41) }
case 1000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 42) }
case 10000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 43) }
case 100000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 44) }
case 1000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 45) }
case 10000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 46) }
case 100000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 47) }
case 1000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 48) }
case 10000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 49) }
case 100000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 50) }
case 1000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 51) }
case 10000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 52) }
case 100000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 53) }
case 1000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 54) }
case 10000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 55) }
case 100000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 56) }
case 1000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 57) }
case 10000000000000000000000000000000000000000000000000000000000000000000000000000 { result := mul(uUNIT, 58) }
default { result := uMAX_SD59x18 }
}
if (result.unwrap() == uMAX_SD59x18) {
unchecked {
// Inline the fixed-point division to save gas.
result = wrap(log2(x).unwrap() * uUNIT / uLOG2_10);
}
}
}
/// @notice Calculates the binary logarithm of x using the iterative approximation algorithm:
///
/// $$
/// log_2{x} = n + log_2{y}, \text{ where } y = x*2^{-n}, \ y \in [1, 2)
/// $$
///
/// For $0 \leq x \lt 1$, the input is inverted:
///
/// $$
/// log_2{x} = -log_2{\frac{1}{x}}
/// $$
///
/// @dev See https://en.wikipedia.org/wiki/Binary_logarithm#Iterative_approximation.
///
/// Notes:
/// - Due to the lossy precision of the iterative approximation, the results are not perfectly accurate to the last decimal.
///
/// Requirements:
/// - x > 0
///
/// @param x The SD59x18 number for which to calculate the binary logarithm.
/// @return result The binary logarithm as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function log2(SD59x18 x) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
if (xInt <= 0) {
revert Errors.PRBMath_SD59x18_Log_InputTooSmall(x);
}
unchecked {
int256 sign;
if (xInt >= uUNIT) {
sign = 1;
} else {
sign = -1;
// Inline the fixed-point inversion to save gas.
xInt = uUNIT_SQUARED / xInt;
}
// Calculate the integer part of the logarithm.
uint256 n = Common.msb(uint256(xInt / uUNIT));
// This is the integer part of the logarithm as an SD59x18 number. The operation can't overflow
// because n is at most 255, `UNIT` is 1e18, and the sign is either 1 or -1.
int256 resultInt = int256(n) * uUNIT;
// Calculate $y = x * 2^{-n}$.
int256 y = xInt >> n;
// If y is the unit number, the fractional part is zero.
if (y == uUNIT) {
return wrap(resultInt * sign);
}
// Calculate the fractional part via the iterative approximation.
// The `delta >>= 1` part is equivalent to `delta /= 2`, but shifting bits is more gas efficient.
int256 DOUBLE_UNIT = 2e18;
for (int256 delta = uHALF_UNIT; delta > 0; delta >>= 1) {
y = (y * y) / uUNIT;
// Is y^2 >= 2e18 and so in the range [2e18, 4e18)?
if (y >= DOUBLE_UNIT) {
// Add the 2^{-m} factor to the logarithm.
resultInt = resultInt + delta;
// Halve y, which corresponds to z/2 in the Wikipedia article.
y >>= 1;
}
}
resultInt *= sign;
result = wrap(resultInt);
}
}
/// @notice Multiplies two SD59x18 numbers together, returning a new SD59x18 number.
///
/// @dev Notes:
/// - Refer to the notes in {Common.mulDiv18}.
///
/// Requirements:
/// - Refer to the requirements in {Common.mulDiv18}.
/// - None of the inputs can be `MIN_SD59x18`.
/// - The result must fit in SD59x18.
///
/// @param x The multiplicand as an SD59x18 number.
/// @param y The multiplier as an SD59x18 number.
/// @return result The product as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function mul(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
int256 yInt = y.unwrap();
if (xInt == uMIN_SD59x18 || yInt == uMIN_SD59x18) {
revert Errors.PRBMath_SD59x18_Mul_InputTooSmall();
}
// Get hold of the absolute values of x and y.
uint256 xAbs;
uint256 yAbs;
unchecked {
xAbs = xInt < 0 ? uint256(-xInt) : uint256(xInt);
yAbs = yInt < 0 ? uint256(-yInt) : uint256(yInt);
}
// Compute the absolute value (x*y÷UNIT). The resulting value must fit in SD59x18.
uint256 resultAbs = Common.mulDiv18(xAbs, yAbs);
if (resultAbs > uint256(uMAX_SD59x18)) {
revert Errors.PRBMath_SD59x18_Mul_Overflow(x, y);
}
// Check if x and y have the same sign using two's complement representation. The left-most bit represents the sign (1 for
// negative, 0 for positive or zero).
bool sameSign = (xInt ^ yInt) > -1;
// If the inputs have the same sign, the result should be positive. Otherwise, it should be negative.
unchecked {
result = wrap(sameSign ? int256(resultAbs) : -int256(resultAbs));
}
}
/// @notice Raises x to the power of y using the following formula:
///
/// $$
/// x^y = 2^{log_2{x} * y}
/// $$
///
/// @dev Notes:
/// - Refer to the notes in {exp2}, {log2}, and {mul}.
/// - Returns `UNIT` for 0^0.
///
/// Requirements:
/// - Refer to the requirements in {exp2}, {log2}, and {mul}.
///
/// @param x The base as an SD59x18 number.
/// @param y Exponent to raise x to, as an SD59x18 number
/// @return result x raised to power y, as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function pow(SD59x18 x, SD59x18 y) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
int256 yInt = y.unwrap();
// If both x and y are zero, the result is `UNIT`. If just x is zero, the result is always zero.
if (xInt == 0) {
return yInt == 0 ? UNIT : ZERO;
}
// If x is `UNIT`, the result is always `UNIT`.
else if (xInt == uUNIT) {
return UNIT;
}
// If y is zero, the result is always `UNIT`.
if (yInt == 0) {
return UNIT;
}
// If y is `UNIT`, the result is always x.
else if (yInt == uUNIT) {
return x;
}
// Calculate the result using the formula.
result = exp2(mul(log2(x), y));
}
/// @notice Raises x (an SD59x18 number) to the power y (an unsigned basic integer) using the well-known
/// algorithm "exponentiation by squaring".
///
/// @dev See https://en.wikipedia.org/wiki/Exponentiation_by_squaring.
///
/// Notes:
/// - Refer to the notes in {Common.mulDiv18}.
/// - Returns `UNIT` for 0^0.
///
/// Requirements:
/// - Refer to the requirements in {abs} and {Common.mulDiv18}.
/// - The result must fit in SD59x18.
///
/// @param x The base as an SD59x18 number.
/// @param y The exponent as a uint256.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function powu(SD59x18 x, uint256 y) pure returns (SD59x18 result) {
uint256 xAbs = uint256(abs(x).unwrap());
// Calculate the first iteration of the loop in advance.
uint256 resultAbs = y & 1 > 0 ? xAbs : uint256(uUNIT);
// Equivalent to `for(y /= 2; y > 0; y /= 2)`.
uint256 yAux = y;
for (yAux >>= 1; yAux > 0; yAux >>= 1) {
xAbs = Common.mulDiv18(xAbs, xAbs);
// Equivalent to `y % 2 == 1`.
if (yAux & 1 > 0) {
resultAbs = Common.mulDiv18(resultAbs, xAbs);
}
}
// The result must fit in SD59x18.
if (resultAbs > uint256(uMAX_SD59x18)) {
revert Errors.PRBMath_SD59x18_Powu_Overflow(x, y);
}
unchecked {
// Is the base negative and the exponent odd? If yes, the result should be negative.
int256 resultInt = int256(resultAbs);
bool isNegative = x.unwrap() < 0 && y & 1 == 1;
if (isNegative) {
resultInt = -resultInt;
}
result = wrap(resultInt);
}
}
/// @notice Calculates the square root of x using the Babylonian method.
///
/// @dev See https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method.
///
/// Notes:
/// - Only the positive root is returned.
/// - The result is rounded toward zero.
///
/// Requirements:
/// - x ≥ 0, since complex numbers are not supported.
/// - x ≤ MAX_SD59x18 / UNIT
///
/// @param x The SD59x18 number for which to calculate the square root.
/// @return result The result as an SD59x18 number.
/// @custom:smtchecker abstract-function-nondet
function sqrt(SD59x18 x) pure returns (SD59x18 result) {
int256 xInt = x.unwrap();
if (xInt < 0) {
revert Errors.PRBMath_SD59x18_Sqrt_NegativeInput(x);
}
if (xInt > uMAX_SD59x18 / uUNIT) {
revert Errors.PRBMath_SD59x18_Sqrt_Overflow(x);
}
unchecked {
// Multiply x by `UNIT` to account for the factor of `UNIT` picked up when multiplying two SD59x18 numbers.
// In this case, the two numbers are both the square root.
uint256 resultUint = Common.sqrt(uint256(xInt * uUNIT));
result = wrap(int256(resultUint));
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 compliant contract.
*/
interface IERC721 is IERC165 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must have been allowed to move this token by either {approve} or
* {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the address zero.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator) external view returns (bool);
}// 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";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC721.sol)
pragma solidity ^0.8.20;
import {IERC721} from "../token/ERC721/IERC721.sol";// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { SD1x18 } from "./ValueType.sol";
/// @dev Euler's number as an SD1x18 number.
SD1x18 constant E = SD1x18.wrap(2_718281828459045235);
/// @dev The maximum value an SD1x18 number can have.
int64 constant uMAX_SD1x18 = 9_223372036854775807;
SD1x18 constant MAX_SD1x18 = SD1x18.wrap(uMAX_SD1x18);
/// @dev The minimum value an SD1x18 number can have.
int64 constant uMIN_SD1x18 = -9_223372036854775808;
SD1x18 constant MIN_SD1x18 = SD1x18.wrap(uMIN_SD1x18);
/// @dev PI as an SD1x18 number.
SD1x18 constant PI = SD1x18.wrap(3_141592653589793238);
/// @dev The unit number, which gives the decimal precision of SD1x18.
SD1x18 constant UNIT = SD1x18.wrap(1e18);
int64 constant uUNIT = 1e18;// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "./Casting.sol" as Casting;
/// @notice The signed 1.18-decimal fixed-point number representation, which can have up to 1 digit and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the underlying Solidity
/// type int64. This is useful when end users want to use int64 to save gas, e.g. with tight variable packing in contract
/// storage.
type SD1x18 is int64;
/*//////////////////////////////////////////////////////////////////////////
CASTING
//////////////////////////////////////////////////////////////////////////*/
using {
Casting.intoSD59x18,
Casting.intoUD60x18,
Casting.intoUint128,
Casting.intoUint256,
Casting.intoUint40,
Casting.unwrap
} for SD1x18 global;// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { SD21x18 } from "./ValueType.sol";
/// @dev Euler's number as an SD21x18 number.
SD21x18 constant E = SD21x18.wrap(2_718281828459045235);
/// @dev The maximum value an SD21x18 number can have.
int128 constant uMAX_SD21x18 = 170141183460469231731_687303715884105727;
SD21x18 constant MAX_SD21x18 = SD21x18.wrap(uMAX_SD21x18);
/// @dev The minimum value an SD21x18 number can have.
int128 constant uMIN_SD21x18 = -170141183460469231731_687303715884105728;
SD21x18 constant MIN_SD21x18 = SD21x18.wrap(uMIN_SD21x18);
/// @dev PI as an SD21x18 number.
SD21x18 constant PI = SD21x18.wrap(3_141592653589793238);
/// @dev The unit number, which gives the decimal precision of SD21x18.
SD21x18 constant UNIT = SD21x18.wrap(1e18);
int128 constant uUNIT = 1e18;// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "./Casting.sol" as Casting;
/// @notice The signed 21.18-decimal fixed-point number representation, which can have up to 21 digits and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the underlying Solidity
/// type int128. This is useful when end users want to use int128 to save gas, e.g. with tight variable packing in contract
/// storage.
type SD21x18 is int128;
/*//////////////////////////////////////////////////////////////////////////
CASTING
//////////////////////////////////////////////////////////////////////////*/
using {
Casting.intoSD59x18,
Casting.intoUD60x18,
Casting.intoUint128,
Casting.intoUint256,
Casting.intoUint40,
Casting.unwrap
} for SD21x18 global;// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { SD59x18 } from "./ValueType.sol";
// NOTICE: the "u" prefix stands for "unwrapped".
/// @dev Euler's number as an SD59x18 number.
SD59x18 constant E = SD59x18.wrap(2_718281828459045235);
/// @dev The maximum input permitted in {exp}.
int256 constant uEXP_MAX_INPUT = 133_084258667509499440;
SD59x18 constant EXP_MAX_INPUT = SD59x18.wrap(uEXP_MAX_INPUT);
/// @dev Any value less than this returns 0 in {exp}.
int256 constant uEXP_MIN_THRESHOLD = -41_446531673892822322;
SD59x18 constant EXP_MIN_THRESHOLD = SD59x18.wrap(uEXP_MIN_THRESHOLD);
/// @dev The maximum input permitted in {exp2}.
int256 constant uEXP2_MAX_INPUT = 192e18 - 1;
SD59x18 constant EXP2_MAX_INPUT = SD59x18.wrap(uEXP2_MAX_INPUT);
/// @dev Any value less than this returns 0 in {exp2}.
int256 constant uEXP2_MIN_THRESHOLD = -59_794705707972522261;
SD59x18 constant EXP2_MIN_THRESHOLD = SD59x18.wrap(uEXP2_MIN_THRESHOLD);
/// @dev Half the UNIT number.
int256 constant uHALF_UNIT = 0.5e18;
SD59x18 constant HALF_UNIT = SD59x18.wrap(uHALF_UNIT);
/// @dev $log_2(10)$ as an SD59x18 number.
int256 constant uLOG2_10 = 3_321928094887362347;
SD59x18 constant LOG2_10 = SD59x18.wrap(uLOG2_10);
/// @dev $log_2(e)$ as an SD59x18 number.
int256 constant uLOG2_E = 1_442695040888963407;
SD59x18 constant LOG2_E = SD59x18.wrap(uLOG2_E);
/// @dev The maximum value an SD59x18 number can have.
int256 constant uMAX_SD59x18 = 57896044618658097711785492504343953926634992332820282019728_792003956564819967;
SD59x18 constant MAX_SD59x18 = SD59x18.wrap(uMAX_SD59x18);
/// @dev The maximum whole value an SD59x18 number can have.
int256 constant uMAX_WHOLE_SD59x18 = 57896044618658097711785492504343953926634992332820282019728_000000000000000000;
SD59x18 constant MAX_WHOLE_SD59x18 = SD59x18.wrap(uMAX_WHOLE_SD59x18);
/// @dev The minimum value an SD59x18 number can have.
int256 constant uMIN_SD59x18 = -57896044618658097711785492504343953926634992332820282019728_792003956564819968;
SD59x18 constant MIN_SD59x18 = SD59x18.wrap(uMIN_SD59x18);
/// @dev The minimum whole value an SD59x18 number can have.
int256 constant uMIN_WHOLE_SD59x18 = -57896044618658097711785492504343953926634992332820282019728_000000000000000000;
SD59x18 constant MIN_WHOLE_SD59x18 = SD59x18.wrap(uMIN_WHOLE_SD59x18);
/// @dev PI as an SD59x18 number.
SD59x18 constant PI = SD59x18.wrap(3_141592653589793238);
/// @dev The unit number, which gives the decimal precision of SD59x18.
int256 constant uUNIT = 1e18;
SD59x18 constant UNIT = SD59x18.wrap(1e18);
/// @dev The unit number squared.
int256 constant uUNIT_SQUARED = 1e36;
SD59x18 constant UNIT_SQUARED = SD59x18.wrap(uUNIT_SQUARED);
/// @dev Zero as an SD59x18 number.
SD59x18 constant ZERO = SD59x18.wrap(0);// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { UD21x18 } from "./ValueType.sol";
/// @dev Euler's number as a UD21x18 number.
UD21x18 constant E = UD21x18.wrap(2_718281828459045235);
/// @dev The maximum value a UD21x18 number can have.
uint128 constant uMAX_UD21x18 = 340282366920938463463_374607431768211455;
UD21x18 constant MAX_UD21x18 = UD21x18.wrap(uMAX_UD21x18);
/// @dev PI as a UD21x18 number.
UD21x18 constant PI = UD21x18.wrap(3_141592653589793238);
/// @dev The unit number, which gives the decimal precision of UD21x18.
uint256 constant uUNIT = 1e18;
UD21x18 constant UNIT = UD21x18.wrap(1e18);// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "./Casting.sol" as Casting;
/// @notice The unsigned 21.18-decimal fixed-point number representation, which can have up to 21 digits and up to 18
/// decimals. The values of this are bound by the minimum and the maximum values permitted by the underlying Solidity
/// type uint128. This is useful when end users want to use uint128 to save gas, e.g. with tight variable packing in contract
/// storage.
type UD21x18 is uint128;
/*//////////////////////////////////////////////////////////////////////////
CASTING
//////////////////////////////////////////////////////////////////////////*/
using {
Casting.intoSD59x18,
Casting.intoUD60x18,
Casting.intoUint128,
Casting.intoUint256,
Casting.intoUint40,
Casting.unwrap
} for UD21x18 global;// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { SD59x18 } from "./ValueType.sol";
/// @notice Thrown when taking the absolute value of `MIN_SD59x18`.
error PRBMath_SD59x18_Abs_MinSD59x18();
/// @notice Thrown when ceiling a number overflows SD59x18.
error PRBMath_SD59x18_Ceil_Overflow(SD59x18 x);
/// @notice Thrown when converting a basic integer to the fixed-point format overflows SD59x18.
error PRBMath_SD59x18_Convert_Overflow(int256 x);
/// @notice Thrown when converting a basic integer to the fixed-point format underflows SD59x18.
error PRBMath_SD59x18_Convert_Underflow(int256 x);
/// @notice Thrown when dividing two numbers and one of them is `MIN_SD59x18`.
error PRBMath_SD59x18_Div_InputTooSmall();
/// @notice Thrown when dividing two numbers and one of the intermediary unsigned results overflows SD59x18.
error PRBMath_SD59x18_Div_Overflow(SD59x18 x, SD59x18 y);
/// @notice Thrown when taking the natural exponent of a base greater than 133_084258667509499441.
error PRBMath_SD59x18_Exp_InputTooBig(SD59x18 x);
/// @notice Thrown when taking the binary exponent of a base greater than 192e18.
error PRBMath_SD59x18_Exp2_InputTooBig(SD59x18 x);
/// @notice Thrown when flooring a number underflows SD59x18.
error PRBMath_SD59x18_Floor_Underflow(SD59x18 x);
/// @notice Thrown when taking the geometric mean of two numbers and their product is negative.
error PRBMath_SD59x18_Gm_NegativeProduct(SD59x18 x, SD59x18 y);
/// @notice Thrown when taking the geometric mean of two numbers and multiplying them overflows SD59x18.
error PRBMath_SD59x18_Gm_Overflow(SD59x18 x, SD59x18 y);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in SD1x18.
error PRBMath_SD59x18_IntoSD1x18_Overflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in SD1x18.
error PRBMath_SD59x18_IntoSD1x18_Underflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in SD21x18.
error PRBMath_SD59x18_IntoSD21x18_Overflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in SD21x18.
error PRBMath_SD59x18_IntoSD21x18_Underflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in UD2x18.
error PRBMath_SD59x18_IntoUD2x18_Overflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in UD2x18.
error PRBMath_SD59x18_IntoUD2x18_Underflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in UD21x18.
error PRBMath_SD59x18_IntoUD21x18_Overflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in UD21x18.
error PRBMath_SD59x18_IntoUD21x18_Underflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in UD60x18.
error PRBMath_SD59x18_IntoUD60x18_Underflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in uint128.
error PRBMath_SD59x18_IntoUint128_Overflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in uint128.
error PRBMath_SD59x18_IntoUint128_Underflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in uint256.
error PRBMath_SD59x18_IntoUint256_Underflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in uint40.
error PRBMath_SD59x18_IntoUint40_Overflow(SD59x18 x);
/// @notice Thrown when trying to cast an SD59x18 number that doesn't fit in uint40.
error PRBMath_SD59x18_IntoUint40_Underflow(SD59x18 x);
/// @notice Thrown when taking the logarithm of a number less than or equal to zero.
error PRBMath_SD59x18_Log_InputTooSmall(SD59x18 x);
/// @notice Thrown when multiplying two numbers and one of the inputs is `MIN_SD59x18`.
error PRBMath_SD59x18_Mul_InputTooSmall();
/// @notice Thrown when multiplying two numbers and the intermediary absolute result overflows SD59x18.
error PRBMath_SD59x18_Mul_Overflow(SD59x18 x, SD59x18 y);
/// @notice Thrown when raising a number to a power and the intermediary absolute result overflows SD59x18.
error PRBMath_SD59x18_Powu_Overflow(SD59x18 x, uint256 y);
/// @notice Thrown when taking the square root of a negative number.
error PRBMath_SD59x18_Sqrt_NegativeInput(SD59x18 x);
/// @notice Thrown when the calculating the square root overflows SD59x18.
error PRBMath_SD59x18_Sqrt_Overflow(SD59x18 x);// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* 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[EIP 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);
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "../Common.sol" as Common;
import "./Errors.sol" as CastingErrors;
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";
import { SD1x18 } from "./ValueType.sol";
/// @notice Casts an SD1x18 number into SD59x18.
/// @dev There is no overflow check because SD1x18 ⊆ SD59x18.
function intoSD59x18(SD1x18 x) pure returns (SD59x18 result) {
result = SD59x18.wrap(int256(SD1x18.unwrap(x)));
}
/// @notice Casts an SD1x18 number into UD60x18.
/// @dev Requirements:
/// - x ≥ 0
function intoUD60x18(SD1x18 x) pure returns (UD60x18 result) {
int64 xInt = SD1x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD1x18_ToUD60x18_Underflow(x);
}
result = UD60x18.wrap(uint64(xInt));
}
/// @notice Casts an SD1x18 number into uint128.
/// @dev Requirements:
/// - x ≥ 0
function intoUint128(SD1x18 x) pure returns (uint128 result) {
int64 xInt = SD1x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD1x18_ToUint128_Underflow(x);
}
result = uint128(uint64(xInt));
}
/// @notice Casts an SD1x18 number into uint256.
/// @dev Requirements:
/// - x ≥ 0
function intoUint256(SD1x18 x) pure returns (uint256 result) {
int64 xInt = SD1x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD1x18_ToUint256_Underflow(x);
}
result = uint256(uint64(xInt));
}
/// @notice Casts an SD1x18 number into uint40.
/// @dev Requirements:
/// - x ≥ 0
/// - x ≤ MAX_UINT40
function intoUint40(SD1x18 x) pure returns (uint40 result) {
int64 xInt = SD1x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD1x18_ToUint40_Underflow(x);
}
if (xInt > int64(uint64(Common.MAX_UINT40))) {
revert CastingErrors.PRBMath_SD1x18_ToUint40_Overflow(x);
}
result = uint40(uint64(xInt));
}
/// @notice Alias for {wrap}.
function sd1x18(int64 x) pure returns (SD1x18 result) {
result = SD1x18.wrap(x);
}
/// @notice Unwraps an SD1x18 number into int64.
function unwrap(SD1x18 x) pure returns (int64 result) {
result = SD1x18.unwrap(x);
}
/// @notice Wraps an int64 number into SD1x18.
function wrap(int64 x) pure returns (SD1x18 result) {
result = SD1x18.wrap(x);
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "../Common.sol" as Common;
import "./Errors.sol" as CastingErrors;
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";
import { SD21x18 } from "./ValueType.sol";
/// @notice Casts an SD21x18 number into SD59x18.
/// @dev There is no overflow check because SD21x18 ⊆ SD59x18.
function intoSD59x18(SD21x18 x) pure returns (SD59x18 result) {
result = SD59x18.wrap(int256(SD21x18.unwrap(x)));
}
/// @notice Casts an SD21x18 number into UD60x18.
/// @dev Requirements:
/// - x ≥ 0
function intoUD60x18(SD21x18 x) pure returns (UD60x18 result) {
int128 xInt = SD21x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD21x18_ToUD60x18_Underflow(x);
}
result = UD60x18.wrap(uint128(xInt));
}
/// @notice Casts an SD21x18 number into uint128.
/// @dev Requirements:
/// - x ≥ 0
function intoUint128(SD21x18 x) pure returns (uint128 result) {
int128 xInt = SD21x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD21x18_ToUint128_Underflow(x);
}
result = uint128(xInt);
}
/// @notice Casts an SD21x18 number into uint256.
/// @dev Requirements:
/// - x ≥ 0
function intoUint256(SD21x18 x) pure returns (uint256 result) {
int128 xInt = SD21x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD21x18_ToUint256_Underflow(x);
}
result = uint256(uint128(xInt));
}
/// @notice Casts an SD21x18 number into uint40.
/// @dev Requirements:
/// - x ≥ 0
/// - x ≤ MAX_UINT40
function intoUint40(SD21x18 x) pure returns (uint40 result) {
int128 xInt = SD21x18.unwrap(x);
if (xInt < 0) {
revert CastingErrors.PRBMath_SD21x18_ToUint40_Underflow(x);
}
if (xInt > int128(uint128(Common.MAX_UINT40))) {
revert CastingErrors.PRBMath_SD21x18_ToUint40_Overflow(x);
}
result = uint40(uint128(xInt));
}
/// @notice Alias for {wrap}.
function sd21x18(int128 x) pure returns (SD21x18 result) {
result = SD21x18.wrap(x);
}
/// @notice Unwraps an SD21x18 number into int128.
function unwrap(SD21x18 x) pure returns (int128 result) {
result = SD21x18.unwrap(x);
}
/// @notice Wraps an int128 number into SD21x18.
function wrap(int128 x) pure returns (SD21x18 result) {
result = SD21x18.wrap(x);
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import "../Common.sol" as Common;
import "./Errors.sol" as Errors;
import { SD59x18 } from "../sd59x18/ValueType.sol";
import { UD60x18 } from "../ud60x18/ValueType.sol";
import { UD21x18 } from "./ValueType.sol";
/// @notice Casts a UD21x18 number into SD59x18.
/// @dev There is no overflow check because UD21x18 ⊆ SD59x18.
function intoSD59x18(UD21x18 x) pure returns (SD59x18 result) {
result = SD59x18.wrap(int256(uint256(UD21x18.unwrap(x))));
}
/// @notice Casts a UD21x18 number into UD60x18.
/// @dev There is no overflow check because UD21x18 ⊆ UD60x18.
function intoUD60x18(UD21x18 x) pure returns (UD60x18 result) {
result = UD60x18.wrap(UD21x18.unwrap(x));
}
/// @notice Casts a UD21x18 number into uint128.
/// @dev This is basically an alias for {unwrap}.
function intoUint128(UD21x18 x) pure returns (uint128 result) {
result = UD21x18.unwrap(x);
}
/// @notice Casts a UD21x18 number into uint256.
/// @dev There is no overflow check because UD21x18 ⊆ uint256.
function intoUint256(UD21x18 x) pure returns (uint256 result) {
result = uint256(UD21x18.unwrap(x));
}
/// @notice Casts a UD21x18 number into uint40.
/// @dev Requirements:
/// - x ≤ MAX_UINT40
function intoUint40(UD21x18 x) pure returns (uint40 result) {
uint128 xUint = UD21x18.unwrap(x);
if (xUint > uint128(Common.MAX_UINT40)) {
revert Errors.PRBMath_UD21x18_IntoUint40_Overflow(x);
}
result = uint40(xUint);
}
/// @notice Alias for {wrap}.
function ud21x18(uint128 x) pure returns (UD21x18 result) {
result = UD21x18.wrap(x);
}
/// @notice Unwrap a UD21x18 number into uint128.
function unwrap(UD21x18 x) pure returns (uint128 result) {
result = UD21x18.unwrap(x);
}
/// @notice Wraps a uint128 number into UD21x18.
function wrap(uint128 x) pure returns (UD21x18 result) {
result = UD21x18.wrap(x);
}// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { SD1x18 } from "./ValueType.sol";
/// @notice Thrown when trying to cast an SD1x18 number that doesn't fit in UD60x18.
error PRBMath_SD1x18_ToUD60x18_Underflow(SD1x18 x);
/// @notice Thrown when trying to cast an SD1x18 number that doesn't fit in uint128.
error PRBMath_SD1x18_ToUint128_Underflow(SD1x18 x);
/// @notice Thrown when trying to cast an SD1x18 number that doesn't fit in uint256.
error PRBMath_SD1x18_ToUint256_Underflow(SD1x18 x);
/// @notice Thrown when trying to cast an SD1x18 number that doesn't fit in uint40.
error PRBMath_SD1x18_ToUint40_Overflow(SD1x18 x);
/// @notice Thrown when trying to cast an SD1x18 number that doesn't fit in uint40.
error PRBMath_SD1x18_ToUint40_Underflow(SD1x18 x);// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { SD21x18 } from "./ValueType.sol";
/// @notice Thrown when trying to cast an SD21x18 number that doesn't fit in uint128.
error PRBMath_SD21x18_ToUint128_Underflow(SD21x18 x);
/// @notice Thrown when trying to cast an SD21x18 number that doesn't fit in UD60x18.
error PRBMath_SD21x18_ToUD60x18_Underflow(SD21x18 x);
/// @notice Thrown when trying to cast an SD21x18 number that doesn't fit in uint256.
error PRBMath_SD21x18_ToUint256_Underflow(SD21x18 x);
/// @notice Thrown when trying to cast an SD21x18 number that doesn't fit in uint40.
error PRBMath_SD21x18_ToUint40_Overflow(SD21x18 x);
/// @notice Thrown when trying to cast an SD21x18 number that doesn't fit in uint40.
error PRBMath_SD21x18_ToUint40_Underflow(SD21x18 x);// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19;
import { UD21x18 } from "./ValueType.sol";
/// @notice Thrown when trying to cast a UD21x18 number that doesn't fit in uint40.
error PRBMath_UD21x18_IntoUint40_Overflow(UD21x18 x);{
"remappings": [
"@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/",
"@prb/math/=node_modules/@prb/math/",
"@sablier/lockup/=node_modules/@sablier/lockup/",
"forge-std/=node_modules/forge-std/",
"murky/=node_modules/murky/",
"solady/=node_modules/solady/",
"@arbitrum/=node_modules/@arbitrum/",
"@chainlink/=node_modules/@chainlink/",
"@eth-optimism/=node_modules/@eth-optimism/",
"@offchainlabs/=node_modules/@offchainlabs/",
"@scroll-tech/=node_modules/@scroll-tech/",
"@zksync/=node_modules/@zksync/",
"openzeppelin-contracts/=node_modules/murky/lib/openzeppelin-contracts/"
],
"optimizer": {
"enabled": true,
"runs": 1000
},
"metadata": {
"useLiteralContent": false,
"bytecodeHash": "none",
"appendCBOR": true
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"evmVersion": "shanghai",
"viaIR": true
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"address","name":"initialAdmin","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"admin","type":"address"},{"internalType":"address","name":"caller","type":"address"}],"name":"CallerNotAdmin","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"admin","type":"address"},{"indexed":true,"internalType":"contract ISablierMerkleBase","name":"merkleBase","type":"address"},{"indexed":false,"internalType":"uint256","name":"feeAmount","type":"uint256"}],"name":"CollectFees","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"contract ISablierMerkleInstant","name":"merkleInstant","type":"address"},{"components":[{"internalType":"contract IERC20","name":"token","type":"address"},{"internalType":"uint40","name":"expiration","type":"uint40"},{"internalType":"address","name":"initialAdmin","type":"address"},{"internalType":"string","name":"ipfsCID","type":"string"},{"internalType":"bytes32","name":"merkleRoot","type":"bytes32"},{"internalType":"string","name":"campaignName","type":"string"},{"internalType":"string","name":"shape","type":"string"}],"indexed":false,"internalType":"struct MerkleBase.ConstructorParams","name":"baseParams","type":"tuple"},{"indexed":false,"internalType":"uint256","name":"aggregateAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"recipientCount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"fee","type":"uint256"}],"name":"CreateMerkleInstant","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"contract ISablierMerkleLL","name":"merkleLL","type":"address"},{"components":[{"internalType":"contract IERC20","name":"token","type":"address"},{"internalType":"uint40","name":"expiration","type":"uint40"},{"internalType":"address","name":"initialAdmin","type":"address"},{"internalType":"string","name":"ipfsCID","type":"string"},{"internalType":"bytes32","name":"merkleRoot","type":"bytes32"},{"internalType":"string","name":"campaignName","type":"string"},{"internalType":"string","name":"shape","type":"string"}],"indexed":false,"internalType":"struct MerkleBase.ConstructorParams","name":"baseParams","type":"tuple"},{"indexed":false,"internalType":"contract ISablierLockup","name":"lockup","type":"address"},{"indexed":false,"internalType":"bool","name":"cancelable","type":"bool"},{"indexed":false,"internalType":"bool","name":"transferable","type":"bool"},{"components":[{"internalType":"uint40","name":"startTime","type":"uint40"},{"internalType":"UD2x18","name":"startPercentage","type":"uint64"},{"internalType":"uint40","name":"cliffDuration","type":"uint40"},{"internalType":"UD2x18","name":"cliffPercentage","type":"uint64"},{"internalType":"uint40","name":"totalDuration","type":"uint40"}],"indexed":false,"internalType":"struct MerkleLL.Schedule","name":"schedule","type":"tuple"},{"indexed":false,"internalType":"uint256","name":"aggregateAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"recipientCount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"fee","type":"uint256"}],"name":"CreateMerkleLL","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"contract ISablierMerkleLT","name":"merkleLT","type":"address"},{"components":[{"internalType":"contract IERC20","name":"token","type":"address"},{"internalType":"uint40","name":"expiration","type":"uint40"},{"internalType":"address","name":"initialAdmin","type":"address"},{"internalType":"string","name":"ipfsCID","type":"string"},{"internalType":"bytes32","name":"merkleRoot","type":"bytes32"},{"internalType":"string","name":"campaignName","type":"string"},{"internalType":"string","name":"shape","type":"string"}],"indexed":false,"internalType":"struct MerkleBase.ConstructorParams","name":"baseParams","type":"tuple"},{"indexed":false,"internalType":"contract ISablierLockup","name":"lockup","type":"address"},{"indexed":false,"internalType":"bool","name":"cancelable","type":"bool"},{"indexed":false,"internalType":"bool","name":"transferable","type":"bool"},{"indexed":false,"internalType":"uint40","name":"streamStartTime","type":"uint40"},{"components":[{"internalType":"UD2x18","name":"unlockPercentage","type":"uint64"},{"internalType":"uint40","name":"duration","type":"uint40"}],"indexed":false,"internalType":"struct MerkleLT.TrancheWithPercentage[]","name":"tranchesWithPercentages","type":"tuple[]"},{"indexed":false,"internalType":"uint256","name":"totalDuration","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"aggregateAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"recipientCount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"fee","type":"uint256"}],"name":"CreateMerkleLT","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"admin","type":"address"},{"indexed":true,"internalType":"address","name":"campaignCreator","type":"address"}],"name":"ResetCustomFee","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"admin","type":"address"},{"indexed":true,"internalType":"address","name":"campaignCreator","type":"address"},{"indexed":false,"internalType":"uint256","name":"customFee","type":"uint256"}],"name":"SetCustomFee","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"admin","type":"address"},{"indexed":false,"internalType":"uint256","name":"defaultFee","type":"uint256"}],"name":"SetDefaultFee","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"oldAdmin","type":"address"},{"indexed":true,"internalType":"address","name":"newAdmin","type":"address"}],"name":"TransferAdmin","type":"event"},{"inputs":[],"name":"admin","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"contract ISablierMerkleBase","name":"merkleBase","type":"address"}],"name":"collectFees","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"contract IERC20","name":"token","type":"address"},{"internalType":"uint40","name":"expiration","type":"uint40"},{"internalType":"address","name":"initialAdmin","type":"address"},{"internalType":"string","name":"ipfsCID","type":"string"},{"internalType":"bytes32","name":"merkleRoot","type":"bytes32"},{"internalType":"string","name":"campaignName","type":"string"},{"internalType":"string","name":"shape","type":"string"}],"internalType":"struct MerkleBase.ConstructorParams","name":"baseParams","type":"tuple"},{"internalType":"uint256","name":"aggregateAmount","type":"uint256"},{"internalType":"uint256","name":"recipientCount","type":"uint256"}],"name":"createMerkleInstant","outputs":[{"internalType":"contract ISablierMerkleInstant","name":"merkleInstant","type":"address"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"contract IERC20","name":"token","type":"address"},{"internalType":"uint40","name":"expiration","type":"uint40"},{"internalType":"address","name":"initialAdmin","type":"address"},{"internalType":"string","name":"ipfsCID","type":"string"},{"internalType":"bytes32","name":"merkleRoot","type":"bytes32"},{"internalType":"string","name":"campaignName","type":"string"},{"internalType":"string","name":"shape","type":"string"}],"internalType":"struct MerkleBase.ConstructorParams","name":"baseParams","type":"tuple"},{"internalType":"contract ISablierLockup","name":"lockup","type":"address"},{"internalType":"bool","name":"cancelable","type":"bool"},{"internalType":"bool","name":"transferable","type":"bool"},{"components":[{"internalType":"uint40","name":"startTime","type":"uint40"},{"internalType":"UD2x18","name":"startPercentage","type":"uint64"},{"internalType":"uint40","name":"cliffDuration","type":"uint40"},{"internalType":"UD2x18","name":"cliffPercentage","type":"uint64"},{"internalType":"uint40","name":"totalDuration","type":"uint40"}],"internalType":"struct MerkleLL.Schedule","name":"schedule","type":"tuple"},{"internalType":"uint256","name":"aggregateAmount","type":"uint256"},{"internalType":"uint256","name":"recipientCount","type":"uint256"}],"name":"createMerkleLL","outputs":[{"internalType":"contract ISablierMerkleLL","name":"merkleLL","type":"address"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"contract IERC20","name":"token","type":"address"},{"internalType":"uint40","name":"expiration","type":"uint40"},{"internalType":"address","name":"initialAdmin","type":"address"},{"internalType":"string","name":"ipfsCID","type":"string"},{"internalType":"bytes32","name":"merkleRoot","type":"bytes32"},{"internalType":"string","name":"campaignName","type":"string"},{"internalType":"string","name":"shape","type":"string"}],"internalType":"struct MerkleBase.ConstructorParams","name":"baseParams","type":"tuple"},{"internalType":"contract ISablierLockup","name":"lockup","type":"address"},{"internalType":"bool","name":"cancelable","type":"bool"},{"internalType":"bool","name":"transferable","type":"bool"},{"internalType":"uint40","name":"streamStartTime","type":"uint40"},{"components":[{"internalType":"UD2x18","name":"unlockPercentage","type":"uint64"},{"internalType":"uint40","name":"duration","type":"uint40"}],"internalType":"struct MerkleLT.TrancheWithPercentage[]","name":"tranchesWithPercentages","type":"tuple[]"},{"internalType":"uint256","name":"aggregateAmount","type":"uint256"},{"internalType":"uint256","name":"recipientCount","type":"uint256"}],"name":"createMerkleLT","outputs":[{"internalType":"contract ISablierMerkleLT","name":"merkleLT","type":"address"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"defaultFee","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"campaignCreator","type":"address"}],"name":"getCustomFee","outputs":[{"components":[{"internalType":"bool","name":"enabled","type":"bool"},{"internalType":"uint256","name":"fee","type":"uint256"}],"internalType":"struct MerkleFactory.CustomFee","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"campaignCreator","type":"address"}],"name":"getFee","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"UD2x18","name":"unlockPercentage","type":"uint64"},{"internalType":"uint40","name":"duration","type":"uint40"}],"internalType":"struct MerkleLT.TrancheWithPercentage[]","name":"tranches","type":"tuple[]"}],"name":"isPercentagesSum100","outputs":[{"internalType":"bool","name":"result","type":"bool"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"address","name":"campaignCreator","type":"address"}],"name":"resetCustomFee","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"campaignCreator","type":"address"},{"internalType":"uint256","name":"newFee","type":"uint256"}],"name":"setCustomFee","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"defaultFee_","type":"uint256"}],"name":"setDefaultFee","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newAdmin","type":"address"}],"name":"transferAdmin","outputs":[],"stateMutability":"nonpayable","type":"function"}]Contract Creation Code
608034609357601f61600838819003918201601f19168301916001600160401b03831184841017609757808492602094604052833981010312609357516001600160a01b038116908190036093575f80546001600160a01b0319168217815560405191907fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a3615f5c90816100ac8239f35b5f80fd5b634e487b7160e01b5f52604160045260245ffdfe60806040526004361015610011575f80fd5b5f3560e01c8063050d535a14610a1e5780633a8dda7d146109ae5780633f693dcb14610626578063474a7634146104c95780634d7c0f11146104135780635a6c72d0146103f657806375829def14610370578063a480ca7914610286578063a4ab5432146101ff578063b88c9148146101d4578063c93a6c841461017b578063d49466a8146100d15763f851a440146100a8575f80fd5b346100cd575f3660031901126100cd5760206001600160a01b035f5416604051908152f35b5f80fd5b346100cd5760403660031901126100cd576100ea610e0b565b602435906001600160a01b035f541633810361016557506001600160a01b031690815f52600260205280600160405f20805460ff811615610157575b5001556040519081527f2cd7b20ee8b62492029a3c64fecf1603b5550673e9c2a72ea38044568108a08860203392a3005b60ff19168217815585610126565b6331b339a960e21b5f526004523360245260445ffd5b346100cd5760203660031901126100cd576004356001600160a01b035f54163381036101655750806001556040519081527ff20c52fd919086f2a3380c19e51ff1fb508de65b5eb8e07c1a69695a32af651960203392a2005b346100cd5760203660031901126100cd5760206101f76101f2610e0b565b6110aa565b604051908152f35b346100cd5760203660031901126100cd57610218610e0b565b6001600160a01b035f54169033820361026f576001600160a01b0316805f5260026020525f6001604082208281550155337f633e9c50ac98dfb667e9ab9e544db6b3f26f93fbde630f500afe6bf0cd78d8ab5f80a3005b506331b339a960e21b5f526004523360245260445ffd5b346100cd5760203660031901126100cd576004356001600160a01b0381168091036100cd576001600160a01b035f5416604051907fa480ca7900000000000000000000000000000000000000000000000000000000825260048201526020816024815f865af1908115610365575f91610333575b507fbf461a00c2a56d50c1ffe10b436b0da1a2b3a86fa5154599854bbf6be334d85060206001600160a01b035f541692604051908152a3005b90506020813d60201161035d575b8161034e60209383610dc3565b810103126100cd5751826102fa565b3d9150610341565b6040513d5f823e3d90fd5b346100cd5760203660031901126100cd57610389610e0b565b5f546001600160a01b03811633810361016557506001600160a01b037fffffffffffffffffffffffff0000000000000000000000000000000000000000921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b346100cd575f3660031901126100cd576020600154604051908152f35b346100cd5760203660031901126100cd5760043567ffffffffffffffff81116100cd57366023820112156100cd57806004013567ffffffffffffffff81116100cd573660248260061b840101116100cd575f91825b828410156104b45760248460061b8301013567ffffffffffffffff81168091036100cd5781018091116104a057600190930192610468565b634e487b7160e01b5f52601160045260245ffd5b602090670de0b6b3a764000060405191148152f35b346100cd5760603660031901126100cd5760043567ffffffffffffffff81116100cd576104fa903690600401610e77565b6040516020810160208152610524826105166040820186610fd7565b03601f198101845283610dc3565b6105596034604051809361054860208301963360601b885251809285850190610f91565b81010301601f198101835282610dc3565b51902060405161122980820182811067ffffffffffffffff8211176106125782916110e38339604081526105906040820186610fd7565b9060203391015203905ff58015610365576020917fca58fb398f60b2cc5e664a08608a6aabe7077d2684a2d82a7d5b83322fd2b2a76001600160a01b036105f293169283926105de336110aa565b604051928392608084526080840190610fd7565b9060243588840152604435604084015260608301520390a2604051908152f35b634e487b7160e01b5f52604160045260245ffd5b346100cd576101003660031901126100cd5760043567ffffffffffffffff81116100cd57610658903690600401610e77565b610660610f5d565b90610669610f73565b610671610f82565b9261067a610de5565b9260a4359067ffffffffffffffff82116100cd57366023830112156100cd57816004013567ffffffffffffffff811161061257604051926106c160208360051b0185610dc3565b8184526024602085019260061b820101903682116100cd57602401915b8183106109615750505081515f905f905b80821061092257505060405160208101956020875281604081016107139086610fd7565b03601f19810183526107259083610dc3565b6040519660208801602081528860408101610740908961105a565b03601f1981018a52610752908a610dc3565b60405192839260208401953360601b87525190816034860161077392610f91565b8301906001600160a01b038a16996bffffffffffffffffffffffff199060601b16603483015215159b8c60f81b60488301521515998a60f81b604983015264ffffffffff8c169b60d81b7fffffffffff00000000000000000000000000000000000000000000000000000016604a830152519182604f83016107f492610f91565b0160340103601b01601f198101825261080d9082610dc3565b519020604051611fef8082019082821067ffffffffffffffff83111761061257829161087691613f61843960e0815261084960e0820188610fd7565b903360208201528960408201528c60608201528a60808201528b60a082015260c08183039101528761105a565b03905ff5968715610365576108fa7f7f4d78094331349dd7faaa3e5d7de64176340a988e70586fac394de324566ce2956108d9956001600160a01b0360209b16998a996108c2336110aa565b95604051998a996101408b526101408b0190610fd7565b948e8a015260408901526060880152608087015285820360a087015261105a565b9160c084015260c43560e084015260e4356101008401526101208301520390a2604051908152f35b9091845183101561094d5760019064ffffffffff6020808660051b89010151015116019201906106ef565b634e487b7160e01b5f52603260045260245ffd5b6040833603126100cd576040519061097882610da7565b83359067ffffffffffffffff821682036100cd57826020926040945261099f838701610df9565b838201528152019201916106de565b346100cd5760203660031901126100cd576001600160a01b036109cf610e0b565b5f60206040516109de81610da7565b8281520152165f5260026020526040805f2081516109fb81610da7565b6020600160ff845416151593848452015491019081528251918252516020820152f35b346100cd576101603660031901126100cd5760043567ffffffffffffffff81116100cd57610a50903690600401610e77565b610a58610f5d565b90610a61610f73565b610a69610f82565b60a03660831901126100cd576040519260a0840184811067ffffffffffffffff82111761061257604052610a9b610de5565b845260a43567ffffffffffffffff811681036100cd57602085015260c43564ffffffffff811681036100cd57604085015260e43567ffffffffffffffff811681036100cd576060850152610104359264ffffffffff841684036100cd5760c09360808601526001600160a01b03610c1a6016604051936034898b610c09602089019460208652610b418a610b338d6040830190610fd7565b03601f1981018c528b610dc3565b610ba76040519d8e610b9e60208201809864ffffffffff6080809282815116855267ffffffffffffffff602082015116602086015282604082015116604086015267ffffffffffffffff6060820151166060860152015116910152565b60a08152610dc3565b604051988996610bc8602089019c8d3360601b9052518092898b0190610f91565b870193169e6bffffffffffffffffffffffff199060601b168584015215159a8b60f81b604884015215159b8c60f81b6049840152518093604a840190610f91565b01010301601f198101835282610dc3565b519020604051611c5580820182811067ffffffffffffffff82111761061257829161230c83396101408152610cbf60a0610c58610140840188610fd7565b923360208201528b6040820152886060820152896080820152018964ffffffffff6080809282815116855267ffffffffffffffff602082015116602086015282604082015116604086015267ffffffffffffffff6060820151166060860152015116910152565b03905ff5908115610365576020957f8ecd3adfa7cae76abab946b73ca62f03f8d77535fb2547a0f0883faef143b56093610d826001600160a01b03610d229516978897610d0b336110aa565b936040519788976101808952610180890190610fd7565b958c88015260408701526060860152608085019064ffffffffff6080809282815116855267ffffffffffffffff602082015116602086015282604082015116604086015267ffffffffffffffff6060820151166060860152015116910152565b61012435610120840152610144356101408401526101608301520390a2604051908152f35b6040810190811067ffffffffffffffff82111761061257604052565b90601f8019910116810190811067ffffffffffffffff82111761061257604052565b6084359064ffffffffff821682036100cd57565b359064ffffffffff821682036100cd57565b600435906001600160a01b03821682036100cd57565b81601f820112156100cd5780359067ffffffffffffffff82116106125760405192610e56601f8401601f191660200185610dc3565b828452602083830101116100cd57815f926020809301838601378301015290565b919060e0838203126100cd576040519060e0820182811067ffffffffffffffff82111761061257604052819380356001600160a01b03811681036100cd578352610ec360208201610df9565b602084015260408101356001600160a01b03811681036100cd576040840152606081013567ffffffffffffffff81116100cd5782610f02918301610e21565b60608401526080810135608084015260a081013567ffffffffffffffff81116100cd5782610f31918301610e21565b60a084015260c08101359167ffffffffffffffff83116100cd5760c092610f589201610e21565b910152565b602435906001600160a01b03821682036100cd57565b6044359081151582036100cd57565b6064359081151582036100cd57565b5f5b838110610fa25750505f910152565b8181015183820152602001610f93565b90602091610fcb81518092818552858086019101610f91565b601f01601f1916010190565b611057916001600160a01b03825116815264ffffffffff60208301511660208201526001600160a01b03604083015116604082015260c061104661102a606085015160e0606086015260e0850190610fb2565b6080850151608085015260a085015184820360a0860152610fb2565b9201519060c0818403910152610fb2565b90565b90602080835192838152019201905f5b8181106110775750505090565b8251805167ffffffffffffffff16855260209081015164ffffffffff16818601526040909401939092019160010161106a565b6001600160a01b0316805f52600260205260ff60405f2054165f146110db575f526002602052600160405f20015490565b506001549056fe610160806040523461044757611229803803809161001d828561045e565b83398101906040818303126104475780516001600160401b03811161044757810160e081840312610447576040519160e083016001600160401b038111848210176104075760405281516001600160a01b038116810361044757835260208201519364ffffffffff8516850361044757602084019485526100a060408401610481565b6040850190815260608401519093906001600160401b03811161044757826100c99183016104b6565b95606086019687526080820151926080870193845260a083015160018060401b03811161044757816100fc9185016104b6565b60a0880190815260c08401516001600160401b038111610447576020610142816101346101b7966101b29564ffffffffff9a016104b6565b9960c08d019a8b5201610481565b98515f80546001600160a01b0319166001600160a01b0392909216918217815560405194859290917fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a3516101a181518092858086019101610495565b81010301601f19810183528261045e565b61050a565b608052511660a0523360c05260405192631711922960e31b845260018060a01b03166004840152602083602481335afa8015610453575f9061041b575b61021e935060e0525161010052516101b26020604051836101a18295518092858086019101610495565b61012052516001600160a01b0316610140525180516001600160401b03811161040757600154600181811c911680156103fd575b60208210146103e957601f8111610386575b50602091601f8211600114610326579181925f9261031b575b50508160011b915f199060031b1c1916176001555b604051610cfc908161052d823960805181610a4f015260a05181818161018c015281816108170152818161097f0152610b1d015260c0518181816101d3015261085e015260e05181818161014c015261058f0152610100518181816103ae015261068f01526101205181610a060152610140518181816102be0152818161070a01526108f10152f35b015190505f8061027d565b601f1982169260015f52805f20915f5b85811061036e57508360019510610356575b505050811b01600155610292565b01515f1960f88460031b161c191690555f8080610348565b91926020600181928685015181550194019201610336565b60015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f830160051c810191602084106103df575b601f0160051c01905b8181106103d45750610264565b5f81556001016103c7565b90915081906103be565b634e487b7160e01b5f52602260045260245ffd5b90607f1690610252565b634e487b7160e01b5f52604160045260245ffd5b506020833d60201161044b575b816104356020938361045e565b810103126104475761021e92516101f4565b5f80fd5b3d9150610428565b6040513d5f823e3d90fd5b601f909101601f19168101906001600160401b0382119082101761040757604052565b51906001600160a01b038216820361044757565b5f5b8381106104a65750505f910152565b8181015183820152602001610497565b81601f820112156104475780516001600160401b03811161040757604051926104e9601f8301601f19166020018561045e565b81845260208284010111610447576105079160208085019101610495565b90565b60208151910151906020811061051e575090565b5f199060200360031b1b169056fe6080806040526004361015610012575f80fd5b5f3560e01c9081630724fda914610a39575080630f7514a2146109ee5780631686c909146108825780632dd310001461083f5780633f31ae3f146104f957806349fc73dd146103f55780634e390d3e146103d157806351e75e8b1461039757806375829def146102e257806382bfefc81461029f57806390e64d1314610285578063a480ca79146101b0578063bb4b57341461016f578063c57981b514610135578063ce516507146100f55763f851a440146100cc575f80fd5b346100f1575f3660031901126100f15760206001600160a01b035f5416604051908152f35b5f80fd5b346100f15760203660031901126100f157602061012b60043560ff6001918060081c5f526002602052161b60405f205416151590565b6040519015158152f35b346100f1575f3660031901126100f15760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b346100f1575f3660031901126100f157602060405164ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b346100f15760203660031901126100f1576101c9610ac9565b6001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016803303610256575047905f80808085855af161020d610b52565b501561021e57602082604051908152f35b6001600160a01b03907f245bf0c0000000000000000000000000000000000000000000000000000000005f521660045260245260445ffd5b7f4e3ddeed000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b346100f1575f3660031901126100f157602061012b610b15565b346100f1575f3660031901126100f15760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b346100f15760203660031901126100f1576102fb610ac9565b5f546001600160a01b03811633810361036857506001600160a01b037fffffffffffffffffffffffff0000000000000000000000000000000000000000921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b7fc6cce6a4000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b346100f1575f3660031901126100f15760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b346100f1575f3660031901126100f157602064ffffffffff60035416604051908152f35b346100f1575f3660031901126100f1576040515f6001548060011c906001811680156104ef575b6020831081146104db578285529081156104b75750600114610459575b6104558361044981850382610adf565b60405191829182610a82565b0390f35b91905060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6915f905b80821061049d57509091508101602001610449610439565b919260018160209254838588010152019101909291610485565b60ff191660208086019190915291151560051b840190910191506104499050610439565b634e487b7160e01b5f52602260045260245ffd5b91607f169161041c565b60803660031901126100f157600435602435906001600160a01b038216918281036100f157604435926fffffffffffffffffffffffffffffffff84168094036100f1576064359367ffffffffffffffff85116100f157366023860112156100f157846004013567ffffffffffffffff81116100f1578060051b95602487820101903682116100f157610589610b15565b6107e8577f00000000000000000000000000000000000000000000000000000000000000008034106107b957506105d78760ff6001918060081c5f526002602052161b60405f205416151590565b61078d57604051602081019088825286604082015285606082015260608152610601608082610adf565b519020604051602081019182526020815261061d604082610adf565b5190209261063160206040519a018a610adf565b8852602401602088015b82821061077d57505050925f935b865185101561068b5760208560051b88010151908181105f1461067a575f52602052600160405f205b940193610649565b905f52602052600160405f20610672565b85907f000000000000000000000000000000000000000000000000000000000000000003610755578261072e7f1dcd2362ae467d43bf31cbcac0526c0958b23eb063e011ab49a5179c839ed9a99460409460035464ffffffffff81161561073b575b508460081c5f526002602052855f20600160ff87161b81541790557f0000000000000000000000000000000000000000000000000000000000000000610b91565b82519182526020820152a2005b64ffffffffff19164264ffffffffff1617600355886106ed565b7fb4f06787000000000000000000000000000000000000000000000000000000005f5260045ffd5b813581526020918201910161063b565b867febe6f30d000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b7fa164c6b4000000000000000000000000000000000000000000000000000000005f523460045260245260445ffd5b7fdf4bae05000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445ffd5b346100f1575f3660031901126100f15760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b346100f15760403660031901126100f15761089b610ac9565b602435906fffffffffffffffffffffffffffffffff82168092036100f1576001600160a01b035f5416338103610368575064ffffffffff60035416801515806109b9575b806109aa575b610950575061091582827f0000000000000000000000000000000000000000000000000000000000000000610b91565b7f2e9d425ba8b27655048400b366d7b6a1f7180ebdb088e06bb7389704860ffe1f60206001600160a01b03805f5416936040519586521693a3005b7fe2e40a0c000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445260645ffd5b506109b3610b15565b156108e5565b5062093a80810164ffffffffff81116109da5764ffffffffff1642116108df565b634e487b7160e01b5f52601160045260245ffd5b346100f1575f3660031901126100f1576104556040517f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610449604082610adf565b346100f1575f3660031901126100f157610455907f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610449604082610adf565b9190916020815282518060208301525f5b818110610ab3575060409293505f838284010152601f8019910116010190565b8060208092870101516040828601015201610a93565b600435906001600160a01b03821682036100f157565b90601f8019910116810190811067ffffffffffffffff821117610b0157604052565b634e487b7160e01b5f52604160045260245ffd5b64ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168015159081610b4a575090565b905042101590565b3d15610b8c573d9067ffffffffffffffff8211610b015760405191610b81601f8201601f191660200184610adf565b82523d5f602084013e565b606090565b5f610bfe926001600160a01b038293604051968260208901947fa9059cbb000000000000000000000000000000000000000000000000000000008652166024890152604488015260448752610be7606488610adf565b1694519082865af1610bf7610b52565b9083610c63565b8051908115159182610c3f575b5050610c145750565b7f5274afe7000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b81925090602091810103126100f157602001518015908115036100f1575f80610c0b565b90610ca05750805115610c7857805190602001fd5b7f1425ea42000000000000000000000000000000000000000000000000000000005f5260045ffd5b81511580610ce6575b610cb1575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b15610ca956fea164736f6c634300081a000a6101c080604052346105ac57611c55803803809161001d82856106fe565b833981019080820361014081126105ac5781516001600160401b0381116105ac5782019160e0838503126105ac576040519360e085016001600160401b038111868210176106ab5760405283516001600160a01b03811681036105ac57855261008860208501610721565b936020860194855261009c60408201610733565b6040870190815260608201519094906001600160401b0381116105ac57836100c5918401610783565b96606081019788526080830151926080820193845260a081015160018060401b0381116105ac57856100f8918301610783565b60a0830190815260c08201519095906001600160401b0381116105ac5761011f9201610783565b9060c0810191825261013360208701610733565b60408701516001600160a01b0381169a909290918b84036105ac5761015a60608a016107c8565b9460a061016960808c016107c8565b97609f1901126105ac576040519760a089016001600160401b0381118a8210176106ab5760405261019c60a08c01610721565b89526101aa60c08c016107d5565b60208a019081529c6101be60e08d01610721565b60408b019081529a6101d36101008e016107d5565b9c60608c019d8e52610120016101e890610721565b60808c019081529d515f80546001600160a01b0319166001600160a01b0392909216918217815560405192839290917fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a3518051908160208401916020019161025292610762565b81010380825261026590602001826106fe565b61026e906107e9565b6080525164ffffffffff1660a0523360c0819052604051631711922960e31b81526001600160a01b039094166004850152839081905a92602491602094fa80156106f3575f906106bf575b6102f9935060e0525161010052516102f46020604051836102e38295518092858086019101610762565b81010301601f1981018352826106fe565b6107e9565b61012052516001600160a01b031661014052518051906001600160401b0382116106ab57600154600181811c911680156106a1575b602082101461068d57601f811161062a575b50602090601f83116001146105bb5764ffffffffff9695949392915f91836105b0575b50508160011b915f199060031b1c1916176001555b61016052610180526101a05251169071ffffffffff000000000000000000000000006004549565010000000000600160681b03905160281b16915160681b1692600160901b600160d01b03905160901b169364ffffffffff60d01b905160d01b169464ffffffffff60d01b1992600160901b600160d01b03199160018060901b0319161716171617171760045560018060a01b036101405116604051905f806020840163095ea7b360e01b815285602486015281196044860152604485526104416064866106fe565b84519082855af161045061080b565b81610575575b508061056b575b15610526575b604051611349908161090c823960805181611043015260a05181818161023001528181610c9701528181610f73015261112d015260c0518181816102770152610cde015260e0518181816101b40152610673015261010051818181610495015261077301526101205181818161089d0152610ffa0152610140518181816103a50152818161091c0152610e730152610160518181816103620152610ab4015261018051818181610178015261094d01526101a0518181816101ee01526109770152f35b61055e610563936040519063095ea7b360e01b602083015260248201525f6044820152604481526105586064826106fe565b8261083a565b61083a565b5f8080610463565b50803b151561045d565b805180159250821561058a575b50505f610456565b81925090602091810103126105ac5760206105a591016107c8565b5f80610582565b5f80fd5b015190505f80610363565b90601f1983169160015f52815f20925f5b818110610612575091600193918564ffffffffff9a9998979694106105fa575b505050811b01600155610378565b01515f1960f88460031b161c191690555f80806105ec565b929360206001819287860151815501950193016105cc565b60015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f840160051c81019160208510610683575b601f0160051c01905b8181106106785750610340565b5f815560010161066b565b9091508190610662565b634e487b7160e01b5f52602260045260245ffd5b90607f169061032e565b634e487b7160e01b5f52604160045260245ffd5b506020833d6020116106eb575b816106d9602093836106fe565b810103126105ac576102f992516102b9565b3d91506106cc565b6040513d5f823e3d90fd5b601f909101601f19168101906001600160401b038211908210176106ab57604052565b519064ffffffffff821682036105ac57565b51906001600160a01b03821682036105ac57565b6001600160401b0381116106ab57601f01601f191660200190565b5f5b8381106107735750505f910152565b8181015183820152602001610764565b81601f820112156105ac57805161079981610747565b926107a760405194856106fe565b818452602082840101116105ac576107c59160208085019101610762565b90565b519081151582036105ac57565b51906001600160401b03821682036105ac57565b6020815191015190602081106107fd575090565b5f199060200360031b1b1690565b3d15610835573d9061081c82610747565b9161082a60405193846106fe565b82523d5f602084013e565b606090565b5f806108629260018060a01b03169360208151910182865af161085b61080b565b90836108ad565b805190811515918261088a575b50506108785750565b635274afe760e01b5f5260045260245ffd5b81925090602091810103126105ac5760206108a591016107c8565b155f8061086f565b906108d157508051156108c257805190602001fd5b630a12f52160e11b5f5260045ffd5b81511580610902575b6108e2575090565b639996b31560e01b5f9081526001600160a01b0391909116600452602490fd5b50803b156108da56fe6080806040526004361015610012575f80fd5b5f3560e01c9081630724fda91461102d575080630f7514a214610fe25780631686c90914610db657806326fadbe214610d025780632dd3100014610cbf5780633f31ae3f146105e857806349fc73dd146104dc5780634e390d3e146104b857806351e75e8b1461047e57806375829def146103c957806382bfefc814610386578063845aef4b1461034357806390e64d1314610329578063a480ca7914610254578063bb4b573414610213578063bf44497a146101d7578063c57981b51461019d578063cbe9e5ef14610161578063ce516507146101215763f851a440146100f8575f80fd5b3461011d575f36600319011261011d5760206001600160a01b035f5416604051908152f35b5f80fd5b3461011d57602036600319011261011d57602061015760043560ff6001918060081c5f526002602052161b60405f205416151590565b6040519015158152f35b3461011d575f36600319011261011d5760206040517f000000000000000000000000000000000000000000000000000000000000000015158152f35b3461011d575f36600319011261011d5760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b3461011d575f36600319011261011d5760206040517f000000000000000000000000000000000000000000000000000000000000000015158152f35b3461011d575f36600319011261011d57602060405164ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b3461011d57602036600319011261011d5761026d6110b5565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168033036102fa575047905f80808085855af16102b1611162565b50156102c257602082604051908152f35b6001600160a01b03907f245bf0c0000000000000000000000000000000000000000000000000000000005f521660045260245260445ffd5b7f4e3ddeed000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b3461011d575f36600319011261011d576020610157611125565b3461011d575f36600319011261011d5760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b3461011d575f36600319011261011d5760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b3461011d57602036600319011261011d576103e26110b5565b5f546001600160a01b03811633810361044f57506001600160a01b037fffffffffffffffffffffffff0000000000000000000000000000000000000000921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b7fc6cce6a4000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b3461011d575f36600319011261011d5760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b3461011d575f36600319011261011d57602064ffffffffff60035416604051908152f35b3461011d575f36600319011261011d576040515f6001548060011c906001811680156105de575b6020831081146105ca578285529081156105a65750600114610548575b6105448361053081850382611103565b604051918291602083526020830190611076565b0390f35b91905060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6915f905b80821061058c57509091508101602001610530610520565b919260018160209254838588010152019101909291610574565b60ff191660208086019190915291151560051b840190910191506105309050610520565b634e487b7160e01b5f52602260045260245ffd5b91607f1691610503565b608036600319011261011d57600435602435906001600160a01b03821680920361011d576044356001600160801b03811680910361011d576064359067ffffffffffffffff821161011d573660238301121561011d57816004013567ffffffffffffffff811161011d578060051b926024848201019036821161011d5761066d611125565b610c68577f0000000000000000000000000000000000000000000000000000000000000000803410610c3957506106bb8660ff6001918060081c5f526002602052161b60405f205416151590565b610c0d576040516020810190878252886040820152856060820152606081526106e5608082611103565b5190206040516020810191825260208152610701604082611103565b519020926107156020604051970187611103565b8552602401602085015b828210610bfd57505050935f945b835186101561076f5760208660051b85010151908181105f1461075e575f52602052600160405f205b95019461072d565b905f52602052600160405f20610756565b84907f000000000000000000000000000000000000000000000000000000000000000003610bd55760035464ffffffffff811615610bbb575b508060081c5f52600260205260405f20600160ff83161b8154179055604051926107d1846110e7565b5f808552602085015260045464ffffffffff811680610bb4575064ffffffffff421685525b5f9064ffffffffff8160681c1680610b99575b5064ffffffffff61082381885116828460d01c16906111a1565b16602087015261087a61086867ffffffffffffffff60405193610845856110e7565b5f85525f60208601526001600160801b0361086d610868848460281c168a611202565b6111bd565b16855260901c1685611202565b916001600160801b0360208301931683526001600160a01b035f541692604051927f00000000000000000000000000000000000000000000000000000000000000006020850152602084526108d0604085611103565b604051936108dd856110e7565b5f85525f602086015260405195610120870187811067ffffffffffffffff821117610b855760405286526020860199898b5260408701888152606088017f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316815260808901907f00000000000000000000000000000000000000000000000000000000000000001515825260a08a01927f00000000000000000000000000000000000000000000000000000000000000001515845260c08b0194855260e08b019586526101008b01998a526040519e8f9b7f7a695841000000000000000000000000000000000000000000000000000000008d5260048d0160809052516001600160a01b031660848d0152516001600160a01b031660a48c0152516001600160801b031660c48b0152516001600160a01b031660e48a015251151561010489015251151561012488015251805164ffffffffff166101448801526020015164ffffffffff1661016487015251610184860161016090526101e48601610a6991611076565b935180516001600160a01b03166101a4870152602001516101c4860152516001600160801b03166024850152516001600160801b0316604484015264ffffffffff16606483015203847f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031691815a6020945f91f1938415610b7a575f94610b26575b507f28b58397e03322f670d6b223cc863f8c148e368b8b615412e6798a641a22842d9160409182519182526020820152a3005b9093506020813d602011610b72575b81610b4260209383611103565b8101031261011d5751927f28b58397e03322f670d6b223cc863f8c148e368b8b615412e6798a641a22842d610af3565b3d9150610b35565b6040513d5f823e3d90fd5b634e487b7160e01b5f52604160045260245ffd5b610bad91925064ffffffffff8751166111a1565b9086610809565b85526107f6565b64ffffffffff19164264ffffffffff1617600355836107a8565b7fb4f06787000000000000000000000000000000000000000000000000000000005f5260045ffd5b813581526020918201910161071f565b857febe6f30d000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b7fa164c6b4000000000000000000000000000000000000000000000000000000005f523460045260245260445ffd5b7fdf4bae05000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445ffd5b3461011d575f36600319011261011d5760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b3461011d575f36600319011261011d575f6080604051610d21816110cb565b828152826020820152826040820152826060820152015260a0604051610d46816110cb565b64ffffffffff60045467ffffffffffffffff828216938481528360208201838560281c168152836040840191838760681c1683528360806060870196848a60901c168852019760d01c16875260405198895251166020880152511660408601525116606084015251166080820152f35b3461011d57604036600319011261011d57610dcf6110b5565b6024356001600160801b03811680910361011d576001600160a01b035f541633810361044f575064ffffffffff6003541680151580610fad575b80610f9e575b610f445750604051610ea95f806001600160a01b0360208501967fa9059cbb000000000000000000000000000000000000000000000000000000008852169586602486015285604486015260448552610e69606486611103565b6001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001694519082865af1610ea2611162565b90836112b0565b8051908115159182610f20575b5050610ef557507f2e9d425ba8b27655048400b366d7b6a1f7180ebdb088e06bb7389704860ffe1f60206001600160a01b035f541692604051908152a3005b7f5274afe7000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b819250906020918101031261011d576020015180159081150361011d578480610eb6565b7fe2e40a0c000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445260645ffd5b50610fa7611125565b15610e0f565b5062093a80810164ffffffffff8111610fce5764ffffffffff164211610e09565b634e487b7160e01b5f52601160045260245ffd5b3461011d575f36600319011261011d576105446040517f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610530604082611103565b3461011d575f36600319011261011d57610544907f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610530604082611103565b91908251928382525f5b8481106110a0575050825f602080949584010152601f8019910116010190565b80602080928401015182828601015201611080565b600435906001600160a01b038216820361011d57565b60a0810190811067ffffffffffffffff821117610b8557604052565b6040810190811067ffffffffffffffff821117610b8557604052565b90601f8019910116810190811067ffffffffffffffff821117610b8557604052565b64ffffffffff7f000000000000000000000000000000000000000000000000000000000000000016801515908161115a575090565b905042101590565b3d1561119c573d9067ffffffffffffffff8211610b855760405191611191601f8201601f191660200184611103565b82523d5f602084013e565b606090565b9064ffffffffff8091169116019064ffffffffff8211610fce57565b6001600160801b0381116111d7576001600160801b031690565b7f4916adce000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b9091905f198382098382029182808310920391808303921461129f57670de0b6b3a764000082101561126f577faccb18165bd6fe31ae1cf318dc5b51eee0e1ba569b88cd74c1773b91fac106699394670de0b6b3a7640000910990828211900360ee1b910360121c170290565b84907f5173648d000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b5050670de0b6b3a764000090049150565b906112ed57508051156112c557805190602001fd5b7f1425ea42000000000000000000000000000000000000000000000000000000005f5260045ffd5b81511580611333575b6112fe575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b156112f656fea164736f6c634300081a000a610200806040523461053557611fef803803809161001d82856107af565b833981019060e0818303126105355780516001600160401b0381116105355781019060e082840312610535576040519160e083016001600160401b038111848210176105ef5760405280516001600160a01b0381168103610535578352610086602082016107d2565b906020840191825261009a604082016107e4565b6040850190815260608201519094906001600160401b03811161053557866100c3918401610834565b6060820190815260808381015190830190815260a08401519192916001600160401b03811161053557886100f8918601610834565b60a0830190815260c085015190946001600160401b03821161053557610120918a9101610834565b60c08301908152610133602088016107e4565b6040880151969092906001600160a01b03881688036105355761015860608a01610879565b9661016560808b01610879565b9a61017260a08c016107d2565b60c08c0151909b6001600160401b03821161053557018d601f82011215610535578051906001600160401b0382116105ef576040519e8f8360051b6020016101ba90826107af565b8381526020019260061b82016020019181831161053557602001925b828410610753575050505064ffffffffff929161025a602061025f9360018060a01b039051168060018060a01b03195f5416175f556040519384915f7fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a35161024981518092858086019101610813565b81010301601f1981018352826107af565b61089a565b608052511660a0523360c05260405192631711922960e31b845260018060a01b03166004840152602083602481335afa8015610748575f90610714575b6102c6935060e05251610100525161025a6020604051836102498295518092858086019101610813565b61012052516001600160a01b031661014052518051906001600160401b0382116105ef5760015490600182811c9216801561070a575b60208310146106f65781601f849311610688575b50602090601f8311600114610622575f92610617575b50508160011b915f199060031b1c1916176001555b61018052610160526101a0526101c0528051905f915f915b81831061053957836101e05260018060a01b03610140511660018060a01b03610160511690604051905f806020840163095ea7b360e01b815285602486015281196044860152604485526103a86064866107af565b84519082855af16103b76108bc565b816104fe575b50806104f4575b156104af575b60405161163290816109bd823960805181611283015260a05181818161030001528181610f8b015281816111b30152611369015260c0518181816103470152610fd2015260e05181818161020b01526107870152610100518181816105a9015261088e015261012051818181610a6c015261123a0152610140518181816104b901528181610af101526110b30152610160518181816104760152610c910152610180518181816101cf0152610b2201526101a051818181610194015261091c01526101c0518181816102be0152610b4c01526101e05181818161041901526108ea0152f35b6104e76104ec936040519063095ea7b360e01b602083015260248201525f6044820152604481526104e16064826107af565b826108eb565b6108eb565b8080806103ca565b50803b15156103c4565b8051801592508215610513575b5050846103bd565b819250906020918101031261053557602061052e9101610879565b848061050b565b5f80fd5b91929091906001600160401b036105508584610886565b5151166001600160401b039182160190811161060357926105718183610886565b519060045491680100000000000000008310156105ef5760018301806004558310156105db5760019260045f5260205f200190838060401b038151166cffffffffff00000000000000006020845493015160401b1691858060681b03191617179055019190610353565b634e487b7160e01b5f52603260045260245ffd5b634e487b7160e01b5f52604160045260245ffd5b634e487b7160e01b5f52601160045260245ffd5b015190505f80610326565b60015f9081528281209350601f198516905b8181106106705750908460019594939210610658575b505050811b0160015561033b565b01515f1960f88460031b161c191690555f808061064a565b92936020600181928786015181550195019301610634565b60015f529091507fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f840160051c810191602085106106ec575b90601f859493920160051c01905b8181106106de5750610310565b5f81558493506001016106d1565b90915081906106c3565b634e487b7160e01b5f52602260045260245ffd5b91607f16916102fc565b506020833d602011610740575b8161072e602093836107af565b81010312610535576102c6925161029c565b3d9150610721565b6040513d5f823e3d90fd5b6040848303126105355760408051919082016001600160401b038111838210176105ef576040528451906001600160401b03821682036105355782602092604094526107a08388016107d2565b838201528152019301926101d6565b601f909101601f19168101906001600160401b038211908210176105ef57604052565b519064ffffffffff8216820361053557565b51906001600160a01b038216820361053557565b6001600160401b0381116105ef57601f01601f191660200190565b5f5b8381106108245750505f910152565b8181015183820152602001610815565b81601f8201121561053557805161084a816107f8565b9261085860405194856107af565b81845260208284010111610535576108769160208085019101610813565b90565b5190811515820361053557565b80518210156105db5760209160051b010190565b6020815191015190602081106108ae575090565b5f199060200360031b1b1690565b3d156108e6573d906108cd826107f8565b916108db60405193846107af565b82523d5f602084013e565b606090565b5f806109139260018060a01b03169360208151910182865af161090c6108bc565b908361095e565b805190811515918261093b575b50506109295750565b635274afe760e01b5f5260045260245ffd5b81925090602091810103126105355760206109569101610879565b155f80610920565b90610982575080511561097357805190602001fd5b630a12f52160e11b5f5260045ffd5b815115806109b3575b610993575090565b639996b31560e01b5f9081526001600160a01b0391909116600452602490fd5b50803b1561098b56fe6080806040526004361015610012575f80fd5b5f3560e01c9081630724fda91461126d575080630f7514a2146112225780631686c90914610ff65780632dd3100014610fb35780633f31ae3f146106fc57806349fc73dd146105f05780634e390d3e146105cc57806351e75e8b1461059257806375829def146104dd57806382bfefc81461049a578063845aef4b1461045757806390e64d131461043d578063936c63d9146103f9578063a480ca7914610324578063bb4b5734146102e3578063bf44497a146102a7578063bf4ed03f1461022e578063c57981b5146101f4578063cbe9e5ef146101b8578063ce36b33514610177578063ce516507146101375763f851a4401461010e575f80fd5b34610133575f3660031901126101335760206001600160a01b035f5416604051908152f35b5f80fd5b3461013357602036600319011261013357602061016d60043560ff6001918060081c5f526002602052161b60405f205416151590565b6040519015158152f35b34610133575f36600319011261013357602060405164ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b34610133575f3660031901126101335760206040517f000000000000000000000000000000000000000000000000000000000000000015158152f35b34610133575f3660031901126101335760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b34610133575f366003190112610133576102466113dd565b6040518091602082016020835281518091526020604084019201905f5b818110610271575050500390f35b8251805167ffffffffffffffff16855260209081015164ffffffffff168186015286955060409094019390920191600101610263565b34610133575f3660031901126101335760206040517f000000000000000000000000000000000000000000000000000000000000000015158152f35b34610133575f36600319011261013357602060405164ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b346101335760203660031901126101335761033d6112f5565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168033036103ca575047905f80808085855af161038161139e565b501561039257602082604051908152f35b6001600160a01b03907f245bf0c0000000000000000000000000000000000000000000000000000000005f521660045260245260445ffd5b7f4e3ddeed000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b34610133575f36600319011261013357602060405167ffffffffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b34610133575f36600319011261013357602061016d611361565b34610133575f3660031901126101335760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b34610133575f3660031901126101335760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b34610133576020366003190112610133576104f66112f5565b5f546001600160a01b03811633810361056357506001600160a01b037fffffffffffffffffffffffff0000000000000000000000000000000000000000921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b7fc6cce6a4000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b34610133575f3660031901126101335760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b34610133575f36600319011261013357602064ffffffffff60035416604051908152f35b34610133575f366003190112610133576040515f6001548060011c906001811680156106f2575b6020831081146106de578285529081156106ba575060011461065c575b6106588361064481850382611327565b6040519182916020835260208301906112b6565b0390f35b91905060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6915f905b8082106106a057509091508101602001610644610634565b919260018160209254838588010152019101909291610688565b60ff191660208086019190915291151560051b840190910191506106449050610634565b634e487b7160e01b5f52602260045260245ffd5b91607f1691610617565b608036600319011261013357600435602435906001600160a01b03821680920361013357604435906001600160801b03821691828103610133576064359367ffffffffffffffff851161013357366023860112156101335784600401359467ffffffffffffffff86116101335760248660051b82010136811161013357610781611361565b610f5c577f0000000000000000000000000000000000000000000000000000000000000000803410610f2d57506107cf8560ff6001918060081c5f526002602052161b60405f205416151590565b610f01576040516020810190868252846040820152876060820152606081526107f9608082611327565b5190206040516020810191825260208152610815604082611327565b5190209161082288611349565b97610830604051998a611327565b8852602401602088015b828210610ef157505050925f935b865185101561088a5761085b8588611492565b519081811015610879575f52602052600160405f205b940193610848565b905f52602052600160405f20610871565b85907f000000000000000000000000000000000000000000000000000000000000000003610ec95760035464ffffffffff811615610eaf575b508160081c5f52600260205260405f20600160ff84161b815417905567ffffffffffffffff7f000000000000000000000000000000000000000000000000000000000000000016670de0b6b3a76400008103610e8457507f000000000000000000000000000000000000000000000000000000000000000064ffffffffff8116610e7e575064ffffffffff4216935b61095a6113dd565b9081519161096783611349565b926109756040519485611327565b808452601f1961098482611349565b015f5b818110610e5b5750506109b66109b167ffffffffffffffff6109a885611471565b515116876114eb565b6114a6565b64ffffffffff8060206109c886611471565b510151168a0116906001600160801b03604051916109e58361130b565b169182825260208201526109f886611471565b52610a0285611471565b50916001905b828210610dc7575050846001600160801b03831610610d9c575b50505064ffffffffff6020610a3b5f1984510184611492565b51015116946001600160a01b035f54169564ffffffffff60405192610a5f8461130b565b16825260208201526040517f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610a9f604082611327565b60405191610aac8361130b565b5f83525f602084015260405197610120890189811067ffffffffffffffff821117610d88576040999594939299528452602084019787895260408501868152606086017f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316815260808701907f00000000000000000000000000000000000000000000000000000000000000001515825260a08801927f00000000000000000000000000000000000000000000000000000000000000001515845260c0890194855260e0890195865261010089019687526040519c8d997f7ee21391000000000000000000000000000000000000000000000000000000008b5260048b0160409052516001600160a01b031660448b0152516001600160a01b031660648a0152516001600160801b03166084890152516001600160a01b031660a488015251151560c487015251151560e486015251805164ffffffffff166101048601526020015164ffffffffff1661012485015251610144840161016090526101a48401610c3c916112b6565b905180516001600160a01b03166101648501526020015161018484015260031983820301602484015281519081815260200191602001905f5b818110610d5357505050908060209203815f6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000165af1938415610d48575f94610cf4575b507f28b58397e03322f670d6b223cc863f8c148e368b8b615412e6798a641a22842d9160409182519182526020820152a3005b9093506020813d602011610d40575b81610d1060209383611327565b810103126101335751927f28b58397e03322f670d6b223cc863f8c148e368b8b615412e6798a641a22842d610cc1565b3d9150610d03565b6040513d5f823e3d90fd5b825180516001600160801b0316855260209081015164ffffffffff168186015289955060409094019390920191600101610c75565b634e487b7160e01b5f52604160045260245ffd5b6001600160801b0391610db383925f190186611492565b519303168183511601169052858080610a22565b90926001600160801b03600191610df66109b167ffffffffffffffff610ded8988611492565b5151168b6114eb565b9064ffffffffff806020610e0d5f198b018d611492565b51015116816020610e1e8b8a611492565b51015116011660405190610e318261130b565b84841682526020820152610e45888b611492565b52610e50878a611492565b500116930190610a08565b602090604051610e6a8161130b565b5f81525f8382015282828901015201610987565b93610952565b7f36d385ef000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b64ffffffffff19164264ffffffffff1617600355846108c3565b7fb4f06787000000000000000000000000000000000000000000000000000000005f5260045ffd5b813581526020918201910161083a565b847febe6f30d000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b7fa164c6b4000000000000000000000000000000000000000000000000000000005f523460045260245260445ffd5b7fdf4bae05000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445ffd5b34610133575f3660031901126101335760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b346101335760403660031901126101335761100f6112f5565b6024356001600160801b038116809103610133576001600160a01b035f5416338103610563575064ffffffffff60035416801515806111ed575b806111de575b61118457506040516110e95f806001600160a01b0360208501967fa9059cbb0000000000000000000000000000000000000000000000000000000088521695866024860152856044860152604485526110a9606486611327565b6001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001694519082865af16110e261139e565b9083611599565b8051908115159182611160575b505061113557507f2e9d425ba8b27655048400b366d7b6a1f7180ebdb088e06bb7389704860ffe1f60206001600160a01b035f541692604051908152a3005b7f5274afe7000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b819250906020918101031261013357602001518015908115036101335784806110f6565b7fe2e40a0c000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445260645ffd5b506111e7611361565b1561104f565b5062093a80810164ffffffffff811161120e5764ffffffffff164211611049565b634e487b7160e01b5f52601160045260245ffd5b34610133575f366003190112610133576106586040517f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610644604082611327565b34610133575f36600319011261013357610658907f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610644604082611327565b91908251928382525f5b8481106112e0575050825f602080949584010152601f8019910116010190565b806020809284010151828286010152016112c0565b600435906001600160a01b038216820361013357565b6040810190811067ffffffffffffffff821117610d8857604052565b90601f8019910116810190811067ffffffffffffffff821117610d8857604052565b67ffffffffffffffff8111610d885760051b60200190565b64ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168015159081611396575090565b905042101590565b3d156113d8573d9067ffffffffffffffff8211610d8857604051916113cd601f8201601f191660200184611327565b82523d5f602084013e565b606090565b600454906113ea82611349565b916113f86040519384611327565b80835260045f9081527f8a35acfbc15ff81a39ae7d344fd709f28e8600b4aa8c65c6b64bfe7fe36bd19b602085015b8383106114345750505050565b6001602081926040516114468161130b565b64ffffffffff865467ffffffffffffffff8116835260401c1683820152815201920192019190611427565b80511561147e5760200190565b634e487b7160e01b5f52603260045260245ffd5b805182101561147e5760209160051b010190565b6001600160801b0381116114c0576001600160801b031690565b7f4916adce000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b9091905f198382098382029182808310920391808303921461158857670de0b6b3a7640000821015611558577faccb18165bd6fe31ae1cf318dc5b51eee0e1ba569b88cd74c1773b91fac106699394670de0b6b3a7640000910990828211900360ee1b910360121c170290565b84907f5173648d000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b5050670de0b6b3a764000090049150565b906115d657508051156115ae57805190602001fd5b7f1425ea42000000000000000000000000000000000000000000000000000000005f5260045ffd5b8151158061161c575b6115e7575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b156115df56fea164736f6c634300081a000aa164736f6c634300081a000a000000000000000000000000b1bef51ebca01eb12001a639bdbbff6eeca12b9f
Deployed Bytecode
0x60806040526004361015610011575f80fd5b5f3560e01c8063050d535a14610a1e5780633a8dda7d146109ae5780633f693dcb14610626578063474a7634146104c95780634d7c0f11146104135780635a6c72d0146103f657806375829def14610370578063a480ca7914610286578063a4ab5432146101ff578063b88c9148146101d4578063c93a6c841461017b578063d49466a8146100d15763f851a440146100a8575f80fd5b346100cd575f3660031901126100cd5760206001600160a01b035f5416604051908152f35b5f80fd5b346100cd5760403660031901126100cd576100ea610e0b565b602435906001600160a01b035f541633810361016557506001600160a01b031690815f52600260205280600160405f20805460ff811615610157575b5001556040519081527f2cd7b20ee8b62492029a3c64fecf1603b5550673e9c2a72ea38044568108a08860203392a3005b60ff19168217815585610126565b6331b339a960e21b5f526004523360245260445ffd5b346100cd5760203660031901126100cd576004356001600160a01b035f54163381036101655750806001556040519081527ff20c52fd919086f2a3380c19e51ff1fb508de65b5eb8e07c1a69695a32af651960203392a2005b346100cd5760203660031901126100cd5760206101f76101f2610e0b565b6110aa565b604051908152f35b346100cd5760203660031901126100cd57610218610e0b565b6001600160a01b035f54169033820361026f576001600160a01b0316805f5260026020525f6001604082208281550155337f633e9c50ac98dfb667e9ab9e544db6b3f26f93fbde630f500afe6bf0cd78d8ab5f80a3005b506331b339a960e21b5f526004523360245260445ffd5b346100cd5760203660031901126100cd576004356001600160a01b0381168091036100cd576001600160a01b035f5416604051907fa480ca7900000000000000000000000000000000000000000000000000000000825260048201526020816024815f865af1908115610365575f91610333575b507fbf461a00c2a56d50c1ffe10b436b0da1a2b3a86fa5154599854bbf6be334d85060206001600160a01b035f541692604051908152a3005b90506020813d60201161035d575b8161034e60209383610dc3565b810103126100cd5751826102fa565b3d9150610341565b6040513d5f823e3d90fd5b346100cd5760203660031901126100cd57610389610e0b565b5f546001600160a01b03811633810361016557506001600160a01b037fffffffffffffffffffffffff0000000000000000000000000000000000000000921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b346100cd575f3660031901126100cd576020600154604051908152f35b346100cd5760203660031901126100cd5760043567ffffffffffffffff81116100cd57366023820112156100cd57806004013567ffffffffffffffff81116100cd573660248260061b840101116100cd575f91825b828410156104b45760248460061b8301013567ffffffffffffffff81168091036100cd5781018091116104a057600190930192610468565b634e487b7160e01b5f52601160045260245ffd5b602090670de0b6b3a764000060405191148152f35b346100cd5760603660031901126100cd5760043567ffffffffffffffff81116100cd576104fa903690600401610e77565b6040516020810160208152610524826105166040820186610fd7565b03601f198101845283610dc3565b6105596034604051809361054860208301963360601b885251809285850190610f91565b81010301601f198101835282610dc3565b51902060405161122980820182811067ffffffffffffffff8211176106125782916110e38339604081526105906040820186610fd7565b9060203391015203905ff58015610365576020917fca58fb398f60b2cc5e664a08608a6aabe7077d2684a2d82a7d5b83322fd2b2a76001600160a01b036105f293169283926105de336110aa565b604051928392608084526080840190610fd7565b9060243588840152604435604084015260608301520390a2604051908152f35b634e487b7160e01b5f52604160045260245ffd5b346100cd576101003660031901126100cd5760043567ffffffffffffffff81116100cd57610658903690600401610e77565b610660610f5d565b90610669610f73565b610671610f82565b9261067a610de5565b9260a4359067ffffffffffffffff82116100cd57366023830112156100cd57816004013567ffffffffffffffff811161061257604051926106c160208360051b0185610dc3565b8184526024602085019260061b820101903682116100cd57602401915b8183106109615750505081515f905f905b80821061092257505060405160208101956020875281604081016107139086610fd7565b03601f19810183526107259083610dc3565b6040519660208801602081528860408101610740908961105a565b03601f1981018a52610752908a610dc3565b60405192839260208401953360601b87525190816034860161077392610f91565b8301906001600160a01b038a16996bffffffffffffffffffffffff199060601b16603483015215159b8c60f81b60488301521515998a60f81b604983015264ffffffffff8c169b60d81b7fffffffffff00000000000000000000000000000000000000000000000000000016604a830152519182604f83016107f492610f91565b0160340103601b01601f198101825261080d9082610dc3565b519020604051611fef8082019082821067ffffffffffffffff83111761061257829161087691613f61843960e0815261084960e0820188610fd7565b903360208201528960408201528c60608201528a60808201528b60a082015260c08183039101528761105a565b03905ff5968715610365576108fa7f7f4d78094331349dd7faaa3e5d7de64176340a988e70586fac394de324566ce2956108d9956001600160a01b0360209b16998a996108c2336110aa565b95604051998a996101408b526101408b0190610fd7565b948e8a015260408901526060880152608087015285820360a087015261105a565b9160c084015260c43560e084015260e4356101008401526101208301520390a2604051908152f35b9091845183101561094d5760019064ffffffffff6020808660051b89010151015116019201906106ef565b634e487b7160e01b5f52603260045260245ffd5b6040833603126100cd576040519061097882610da7565b83359067ffffffffffffffff821682036100cd57826020926040945261099f838701610df9565b838201528152019201916106de565b346100cd5760203660031901126100cd576001600160a01b036109cf610e0b565b5f60206040516109de81610da7565b8281520152165f5260026020526040805f2081516109fb81610da7565b6020600160ff845416151593848452015491019081528251918252516020820152f35b346100cd576101603660031901126100cd5760043567ffffffffffffffff81116100cd57610a50903690600401610e77565b610a58610f5d565b90610a61610f73565b610a69610f82565b60a03660831901126100cd576040519260a0840184811067ffffffffffffffff82111761061257604052610a9b610de5565b845260a43567ffffffffffffffff811681036100cd57602085015260c43564ffffffffff811681036100cd57604085015260e43567ffffffffffffffff811681036100cd576060850152610104359264ffffffffff841684036100cd5760c09360808601526001600160a01b03610c1a6016604051936034898b610c09602089019460208652610b418a610b338d6040830190610fd7565b03601f1981018c528b610dc3565b610ba76040519d8e610b9e60208201809864ffffffffff6080809282815116855267ffffffffffffffff602082015116602086015282604082015116604086015267ffffffffffffffff6060820151166060860152015116910152565b60a08152610dc3565b604051988996610bc8602089019c8d3360601b9052518092898b0190610f91565b870193169e6bffffffffffffffffffffffff199060601b168584015215159a8b60f81b604884015215159b8c60f81b6049840152518093604a840190610f91565b01010301601f198101835282610dc3565b519020604051611c5580820182811067ffffffffffffffff82111761061257829161230c83396101408152610cbf60a0610c58610140840188610fd7565b923360208201528b6040820152886060820152896080820152018964ffffffffff6080809282815116855267ffffffffffffffff602082015116602086015282604082015116604086015267ffffffffffffffff6060820151166060860152015116910152565b03905ff5908115610365576020957f8ecd3adfa7cae76abab946b73ca62f03f8d77535fb2547a0f0883faef143b56093610d826001600160a01b03610d229516978897610d0b336110aa565b936040519788976101808952610180890190610fd7565b958c88015260408701526060860152608085019064ffffffffff6080809282815116855267ffffffffffffffff602082015116602086015282604082015116604086015267ffffffffffffffff6060820151166060860152015116910152565b61012435610120840152610144356101408401526101608301520390a2604051908152f35b6040810190811067ffffffffffffffff82111761061257604052565b90601f8019910116810190811067ffffffffffffffff82111761061257604052565b6084359064ffffffffff821682036100cd57565b359064ffffffffff821682036100cd57565b600435906001600160a01b03821682036100cd57565b81601f820112156100cd5780359067ffffffffffffffff82116106125760405192610e56601f8401601f191660200185610dc3565b828452602083830101116100cd57815f926020809301838601378301015290565b919060e0838203126100cd576040519060e0820182811067ffffffffffffffff82111761061257604052819380356001600160a01b03811681036100cd578352610ec360208201610df9565b602084015260408101356001600160a01b03811681036100cd576040840152606081013567ffffffffffffffff81116100cd5782610f02918301610e21565b60608401526080810135608084015260a081013567ffffffffffffffff81116100cd5782610f31918301610e21565b60a084015260c08101359167ffffffffffffffff83116100cd5760c092610f589201610e21565b910152565b602435906001600160a01b03821682036100cd57565b6044359081151582036100cd57565b6064359081151582036100cd57565b5f5b838110610fa25750505f910152565b8181015183820152602001610f93565b90602091610fcb81518092818552858086019101610f91565b601f01601f1916010190565b611057916001600160a01b03825116815264ffffffffff60208301511660208201526001600160a01b03604083015116604082015260c061104661102a606085015160e0606086015260e0850190610fb2565b6080850151608085015260a085015184820360a0860152610fb2565b9201519060c0818403910152610fb2565b90565b90602080835192838152019201905f5b8181106110775750505090565b8251805167ffffffffffffffff16855260209081015164ffffffffff16818601526040909401939092019160010161106a565b6001600160a01b0316805f52600260205260ff60405f2054165f146110db575f526002602052600160405f20015490565b506001549056fe610160806040523461044757611229803803809161001d828561045e565b83398101906040818303126104475780516001600160401b03811161044757810160e081840312610447576040519160e083016001600160401b038111848210176104075760405281516001600160a01b038116810361044757835260208201519364ffffffffff8516850361044757602084019485526100a060408401610481565b6040850190815260608401519093906001600160401b03811161044757826100c99183016104b6565b95606086019687526080820151926080870193845260a083015160018060401b03811161044757816100fc9185016104b6565b60a0880190815260c08401516001600160401b038111610447576020610142816101346101b7966101b29564ffffffffff9a016104b6565b9960c08d019a8b5201610481565b98515f80546001600160a01b0319166001600160a01b0392909216918217815560405194859290917fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a3516101a181518092858086019101610495565b81010301601f19810183528261045e565b61050a565b608052511660a0523360c05260405192631711922960e31b845260018060a01b03166004840152602083602481335afa8015610453575f9061041b575b61021e935060e0525161010052516101b26020604051836101a18295518092858086019101610495565b61012052516001600160a01b0316610140525180516001600160401b03811161040757600154600181811c911680156103fd575b60208210146103e957601f8111610386575b50602091601f8211600114610326579181925f9261031b575b50508160011b915f199060031b1c1916176001555b604051610cfc908161052d823960805181610a4f015260a05181818161018c015281816108170152818161097f0152610b1d015260c0518181816101d3015261085e015260e05181818161014c015261058f0152610100518181816103ae015261068f01526101205181610a060152610140518181816102be0152818161070a01526108f10152f35b015190505f8061027d565b601f1982169260015f52805f20915f5b85811061036e57508360019510610356575b505050811b01600155610292565b01515f1960f88460031b161c191690555f8080610348565b91926020600181928685015181550194019201610336565b60015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f830160051c810191602084106103df575b601f0160051c01905b8181106103d45750610264565b5f81556001016103c7565b90915081906103be565b634e487b7160e01b5f52602260045260245ffd5b90607f1690610252565b634e487b7160e01b5f52604160045260245ffd5b506020833d60201161044b575b816104356020938361045e565b810103126104475761021e92516101f4565b5f80fd5b3d9150610428565b6040513d5f823e3d90fd5b601f909101601f19168101906001600160401b0382119082101761040757604052565b51906001600160a01b038216820361044757565b5f5b8381106104a65750505f910152565b8181015183820152602001610497565b81601f820112156104475780516001600160401b03811161040757604051926104e9601f8301601f19166020018561045e565b81845260208284010111610447576105079160208085019101610495565b90565b60208151910151906020811061051e575090565b5f199060200360031b1b169056fe6080806040526004361015610012575f80fd5b5f3560e01c9081630724fda914610a39575080630f7514a2146109ee5780631686c909146108825780632dd310001461083f5780633f31ae3f146104f957806349fc73dd146103f55780634e390d3e146103d157806351e75e8b1461039757806375829def146102e257806382bfefc81461029f57806390e64d1314610285578063a480ca79146101b0578063bb4b57341461016f578063c57981b514610135578063ce516507146100f55763f851a440146100cc575f80fd5b346100f1575f3660031901126100f15760206001600160a01b035f5416604051908152f35b5f80fd5b346100f15760203660031901126100f157602061012b60043560ff6001918060081c5f526002602052161b60405f205416151590565b6040519015158152f35b346100f1575f3660031901126100f15760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b346100f1575f3660031901126100f157602060405164ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b346100f15760203660031901126100f1576101c9610ac9565b6001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016803303610256575047905f80808085855af161020d610b52565b501561021e57602082604051908152f35b6001600160a01b03907f245bf0c0000000000000000000000000000000000000000000000000000000005f521660045260245260445ffd5b7f4e3ddeed000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b346100f1575f3660031901126100f157602061012b610b15565b346100f1575f3660031901126100f15760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b346100f15760203660031901126100f1576102fb610ac9565b5f546001600160a01b03811633810361036857506001600160a01b037fffffffffffffffffffffffff0000000000000000000000000000000000000000921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b7fc6cce6a4000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b346100f1575f3660031901126100f15760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b346100f1575f3660031901126100f157602064ffffffffff60035416604051908152f35b346100f1575f3660031901126100f1576040515f6001548060011c906001811680156104ef575b6020831081146104db578285529081156104b75750600114610459575b6104558361044981850382610adf565b60405191829182610a82565b0390f35b91905060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6915f905b80821061049d57509091508101602001610449610439565b919260018160209254838588010152019101909291610485565b60ff191660208086019190915291151560051b840190910191506104499050610439565b634e487b7160e01b5f52602260045260245ffd5b91607f169161041c565b60803660031901126100f157600435602435906001600160a01b038216918281036100f157604435926fffffffffffffffffffffffffffffffff84168094036100f1576064359367ffffffffffffffff85116100f157366023860112156100f157846004013567ffffffffffffffff81116100f1578060051b95602487820101903682116100f157610589610b15565b6107e8577f00000000000000000000000000000000000000000000000000000000000000008034106107b957506105d78760ff6001918060081c5f526002602052161b60405f205416151590565b61078d57604051602081019088825286604082015285606082015260608152610601608082610adf565b519020604051602081019182526020815261061d604082610adf565b5190209261063160206040519a018a610adf565b8852602401602088015b82821061077d57505050925f935b865185101561068b5760208560051b88010151908181105f1461067a575f52602052600160405f205b940193610649565b905f52602052600160405f20610672565b85907f000000000000000000000000000000000000000000000000000000000000000003610755578261072e7f1dcd2362ae467d43bf31cbcac0526c0958b23eb063e011ab49a5179c839ed9a99460409460035464ffffffffff81161561073b575b508460081c5f526002602052855f20600160ff87161b81541790557f0000000000000000000000000000000000000000000000000000000000000000610b91565b82519182526020820152a2005b64ffffffffff19164264ffffffffff1617600355886106ed565b7fb4f06787000000000000000000000000000000000000000000000000000000005f5260045ffd5b813581526020918201910161063b565b867febe6f30d000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b7fa164c6b4000000000000000000000000000000000000000000000000000000005f523460045260245260445ffd5b7fdf4bae05000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445ffd5b346100f1575f3660031901126100f15760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b346100f15760403660031901126100f15761089b610ac9565b602435906fffffffffffffffffffffffffffffffff82168092036100f1576001600160a01b035f5416338103610368575064ffffffffff60035416801515806109b9575b806109aa575b610950575061091582827f0000000000000000000000000000000000000000000000000000000000000000610b91565b7f2e9d425ba8b27655048400b366d7b6a1f7180ebdb088e06bb7389704860ffe1f60206001600160a01b03805f5416936040519586521693a3005b7fe2e40a0c000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445260645ffd5b506109b3610b15565b156108e5565b5062093a80810164ffffffffff81116109da5764ffffffffff1642116108df565b634e487b7160e01b5f52601160045260245ffd5b346100f1575f3660031901126100f1576104556040517f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610449604082610adf565b346100f1575f3660031901126100f157610455907f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610449604082610adf565b9190916020815282518060208301525f5b818110610ab3575060409293505f838284010152601f8019910116010190565b8060208092870101516040828601015201610a93565b600435906001600160a01b03821682036100f157565b90601f8019910116810190811067ffffffffffffffff821117610b0157604052565b634e487b7160e01b5f52604160045260245ffd5b64ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168015159081610b4a575090565b905042101590565b3d15610b8c573d9067ffffffffffffffff8211610b015760405191610b81601f8201601f191660200184610adf565b82523d5f602084013e565b606090565b5f610bfe926001600160a01b038293604051968260208901947fa9059cbb000000000000000000000000000000000000000000000000000000008652166024890152604488015260448752610be7606488610adf565b1694519082865af1610bf7610b52565b9083610c63565b8051908115159182610c3f575b5050610c145750565b7f5274afe7000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b81925090602091810103126100f157602001518015908115036100f1575f80610c0b565b90610ca05750805115610c7857805190602001fd5b7f1425ea42000000000000000000000000000000000000000000000000000000005f5260045ffd5b81511580610ce6575b610cb1575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b15610ca956fea164736f6c634300081a000a6101c080604052346105ac57611c55803803809161001d82856106fe565b833981019080820361014081126105ac5781516001600160401b0381116105ac5782019160e0838503126105ac576040519360e085016001600160401b038111868210176106ab5760405283516001600160a01b03811681036105ac57855261008860208501610721565b936020860194855261009c60408201610733565b6040870190815260608201519094906001600160401b0381116105ac57836100c5918401610783565b96606081019788526080830151926080820193845260a081015160018060401b0381116105ac57856100f8918301610783565b60a0830190815260c08201519095906001600160401b0381116105ac5761011f9201610783565b9060c0810191825261013360208701610733565b60408701516001600160a01b0381169a909290918b84036105ac5761015a60608a016107c8565b9460a061016960808c016107c8565b97609f1901126105ac576040519760a089016001600160401b0381118a8210176106ab5760405261019c60a08c01610721565b89526101aa60c08c016107d5565b60208a019081529c6101be60e08d01610721565b60408b019081529a6101d36101008e016107d5565b9c60608c019d8e52610120016101e890610721565b60808c019081529d515f80546001600160a01b0319166001600160a01b0392909216918217815560405192839290917fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a3518051908160208401916020019161025292610762565b81010380825261026590602001826106fe565b61026e906107e9565b6080525164ffffffffff1660a0523360c0819052604051631711922960e31b81526001600160a01b039094166004850152839081905a92602491602094fa80156106f3575f906106bf575b6102f9935060e0525161010052516102f46020604051836102e38295518092858086019101610762565b81010301601f1981018352826106fe565b6107e9565b61012052516001600160a01b031661014052518051906001600160401b0382116106ab57600154600181811c911680156106a1575b602082101461068d57601f811161062a575b50602090601f83116001146105bb5764ffffffffff9695949392915f91836105b0575b50508160011b915f199060031b1c1916176001555b61016052610180526101a05251169071ffffffffff000000000000000000000000006004549565010000000000600160681b03905160281b16915160681b1692600160901b600160d01b03905160901b169364ffffffffff60d01b905160d01b169464ffffffffff60d01b1992600160901b600160d01b03199160018060901b0319161716171617171760045560018060a01b036101405116604051905f806020840163095ea7b360e01b815285602486015281196044860152604485526104416064866106fe565b84519082855af161045061080b565b81610575575b508061056b575b15610526575b604051611349908161090c823960805181611043015260a05181818161023001528181610c9701528181610f73015261112d015260c0518181816102770152610cde015260e0518181816101b40152610673015261010051818181610495015261077301526101205181818161089d0152610ffa0152610140518181816103a50152818161091c0152610e730152610160518181816103620152610ab4015261018051818181610178015261094d01526101a0518181816101ee01526109770152f35b61055e610563936040519063095ea7b360e01b602083015260248201525f6044820152604481526105586064826106fe565b8261083a565b61083a565b5f8080610463565b50803b151561045d565b805180159250821561058a575b50505f610456565b81925090602091810103126105ac5760206105a591016107c8565b5f80610582565b5f80fd5b015190505f80610363565b90601f1983169160015f52815f20925f5b818110610612575091600193918564ffffffffff9a9998979694106105fa575b505050811b01600155610378565b01515f1960f88460031b161c191690555f80806105ec565b929360206001819287860151815501950193016105cc565b60015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f840160051c81019160208510610683575b601f0160051c01905b8181106106785750610340565b5f815560010161066b565b9091508190610662565b634e487b7160e01b5f52602260045260245ffd5b90607f169061032e565b634e487b7160e01b5f52604160045260245ffd5b506020833d6020116106eb575b816106d9602093836106fe565b810103126105ac576102f992516102b9565b3d91506106cc565b6040513d5f823e3d90fd5b601f909101601f19168101906001600160401b038211908210176106ab57604052565b519064ffffffffff821682036105ac57565b51906001600160a01b03821682036105ac57565b6001600160401b0381116106ab57601f01601f191660200190565b5f5b8381106107735750505f910152565b8181015183820152602001610764565b81601f820112156105ac57805161079981610747565b926107a760405194856106fe565b818452602082840101116105ac576107c59160208085019101610762565b90565b519081151582036105ac57565b51906001600160401b03821682036105ac57565b6020815191015190602081106107fd575090565b5f199060200360031b1b1690565b3d15610835573d9061081c82610747565b9161082a60405193846106fe565b82523d5f602084013e565b606090565b5f806108629260018060a01b03169360208151910182865af161085b61080b565b90836108ad565b805190811515918261088a575b50506108785750565b635274afe760e01b5f5260045260245ffd5b81925090602091810103126105ac5760206108a591016107c8565b155f8061086f565b906108d157508051156108c257805190602001fd5b630a12f52160e11b5f5260045ffd5b81511580610902575b6108e2575090565b639996b31560e01b5f9081526001600160a01b0391909116600452602490fd5b50803b156108da56fe6080806040526004361015610012575f80fd5b5f3560e01c9081630724fda91461102d575080630f7514a214610fe25780631686c90914610db657806326fadbe214610d025780632dd3100014610cbf5780633f31ae3f146105e857806349fc73dd146104dc5780634e390d3e146104b857806351e75e8b1461047e57806375829def146103c957806382bfefc814610386578063845aef4b1461034357806390e64d1314610329578063a480ca7914610254578063bb4b573414610213578063bf44497a146101d7578063c57981b51461019d578063cbe9e5ef14610161578063ce516507146101215763f851a440146100f8575f80fd5b3461011d575f36600319011261011d5760206001600160a01b035f5416604051908152f35b5f80fd5b3461011d57602036600319011261011d57602061015760043560ff6001918060081c5f526002602052161b60405f205416151590565b6040519015158152f35b3461011d575f36600319011261011d5760206040517f000000000000000000000000000000000000000000000000000000000000000015158152f35b3461011d575f36600319011261011d5760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b3461011d575f36600319011261011d5760206040517f000000000000000000000000000000000000000000000000000000000000000015158152f35b3461011d575f36600319011261011d57602060405164ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b3461011d57602036600319011261011d5761026d6110b5565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168033036102fa575047905f80808085855af16102b1611162565b50156102c257602082604051908152f35b6001600160a01b03907f245bf0c0000000000000000000000000000000000000000000000000000000005f521660045260245260445ffd5b7f4e3ddeed000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b3461011d575f36600319011261011d576020610157611125565b3461011d575f36600319011261011d5760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b3461011d575f36600319011261011d5760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b3461011d57602036600319011261011d576103e26110b5565b5f546001600160a01b03811633810361044f57506001600160a01b037fffffffffffffffffffffffff0000000000000000000000000000000000000000921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b7fc6cce6a4000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b3461011d575f36600319011261011d5760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b3461011d575f36600319011261011d57602064ffffffffff60035416604051908152f35b3461011d575f36600319011261011d576040515f6001548060011c906001811680156105de575b6020831081146105ca578285529081156105a65750600114610548575b6105448361053081850382611103565b604051918291602083526020830190611076565b0390f35b91905060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6915f905b80821061058c57509091508101602001610530610520565b919260018160209254838588010152019101909291610574565b60ff191660208086019190915291151560051b840190910191506105309050610520565b634e487b7160e01b5f52602260045260245ffd5b91607f1691610503565b608036600319011261011d57600435602435906001600160a01b03821680920361011d576044356001600160801b03811680910361011d576064359067ffffffffffffffff821161011d573660238301121561011d57816004013567ffffffffffffffff811161011d578060051b926024848201019036821161011d5761066d611125565b610c68577f0000000000000000000000000000000000000000000000000000000000000000803410610c3957506106bb8660ff6001918060081c5f526002602052161b60405f205416151590565b610c0d576040516020810190878252886040820152856060820152606081526106e5608082611103565b5190206040516020810191825260208152610701604082611103565b519020926107156020604051970187611103565b8552602401602085015b828210610bfd57505050935f945b835186101561076f5760208660051b85010151908181105f1461075e575f52602052600160405f205b95019461072d565b905f52602052600160405f20610756565b84907f000000000000000000000000000000000000000000000000000000000000000003610bd55760035464ffffffffff811615610bbb575b508060081c5f52600260205260405f20600160ff83161b8154179055604051926107d1846110e7565b5f808552602085015260045464ffffffffff811680610bb4575064ffffffffff421685525b5f9064ffffffffff8160681c1680610b99575b5064ffffffffff61082381885116828460d01c16906111a1565b16602087015261087a61086867ffffffffffffffff60405193610845856110e7565b5f85525f60208601526001600160801b0361086d610868848460281c168a611202565b6111bd565b16855260901c1685611202565b916001600160801b0360208301931683526001600160a01b035f541692604051927f00000000000000000000000000000000000000000000000000000000000000006020850152602084526108d0604085611103565b604051936108dd856110e7565b5f85525f602086015260405195610120870187811067ffffffffffffffff821117610b855760405286526020860199898b5260408701888152606088017f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316815260808901907f00000000000000000000000000000000000000000000000000000000000000001515825260a08a01927f00000000000000000000000000000000000000000000000000000000000000001515845260c08b0194855260e08b019586526101008b01998a526040519e8f9b7f7a695841000000000000000000000000000000000000000000000000000000008d5260048d0160809052516001600160a01b031660848d0152516001600160a01b031660a48c0152516001600160801b031660c48b0152516001600160a01b031660e48a015251151561010489015251151561012488015251805164ffffffffff166101448801526020015164ffffffffff1661016487015251610184860161016090526101e48601610a6991611076565b935180516001600160a01b03166101a4870152602001516101c4860152516001600160801b03166024850152516001600160801b0316604484015264ffffffffff16606483015203847f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031691815a6020945f91f1938415610b7a575f94610b26575b507f28b58397e03322f670d6b223cc863f8c148e368b8b615412e6798a641a22842d9160409182519182526020820152a3005b9093506020813d602011610b72575b81610b4260209383611103565b8101031261011d5751927f28b58397e03322f670d6b223cc863f8c148e368b8b615412e6798a641a22842d610af3565b3d9150610b35565b6040513d5f823e3d90fd5b634e487b7160e01b5f52604160045260245ffd5b610bad91925064ffffffffff8751166111a1565b9086610809565b85526107f6565b64ffffffffff19164264ffffffffff1617600355836107a8565b7fb4f06787000000000000000000000000000000000000000000000000000000005f5260045ffd5b813581526020918201910161071f565b857febe6f30d000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b7fa164c6b4000000000000000000000000000000000000000000000000000000005f523460045260245260445ffd5b7fdf4bae05000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445ffd5b3461011d575f36600319011261011d5760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b3461011d575f36600319011261011d575f6080604051610d21816110cb565b828152826020820152826040820152826060820152015260a0604051610d46816110cb565b64ffffffffff60045467ffffffffffffffff828216938481528360208201838560281c168152836040840191838760681c1683528360806060870196848a60901c168852019760d01c16875260405198895251166020880152511660408601525116606084015251166080820152f35b3461011d57604036600319011261011d57610dcf6110b5565b6024356001600160801b03811680910361011d576001600160a01b035f541633810361044f575064ffffffffff6003541680151580610fad575b80610f9e575b610f445750604051610ea95f806001600160a01b0360208501967fa9059cbb000000000000000000000000000000000000000000000000000000008852169586602486015285604486015260448552610e69606486611103565b6001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001694519082865af1610ea2611162565b90836112b0565b8051908115159182610f20575b5050610ef557507f2e9d425ba8b27655048400b366d7b6a1f7180ebdb088e06bb7389704860ffe1f60206001600160a01b035f541692604051908152a3005b7f5274afe7000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b819250906020918101031261011d576020015180159081150361011d578480610eb6565b7fe2e40a0c000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445260645ffd5b50610fa7611125565b15610e0f565b5062093a80810164ffffffffff8111610fce5764ffffffffff164211610e09565b634e487b7160e01b5f52601160045260245ffd5b3461011d575f36600319011261011d576105446040517f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610530604082611103565b3461011d575f36600319011261011d57610544907f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610530604082611103565b91908251928382525f5b8481106110a0575050825f602080949584010152601f8019910116010190565b80602080928401015182828601015201611080565b600435906001600160a01b038216820361011d57565b60a0810190811067ffffffffffffffff821117610b8557604052565b6040810190811067ffffffffffffffff821117610b8557604052565b90601f8019910116810190811067ffffffffffffffff821117610b8557604052565b64ffffffffff7f000000000000000000000000000000000000000000000000000000000000000016801515908161115a575090565b905042101590565b3d1561119c573d9067ffffffffffffffff8211610b855760405191611191601f8201601f191660200184611103565b82523d5f602084013e565b606090565b9064ffffffffff8091169116019064ffffffffff8211610fce57565b6001600160801b0381116111d7576001600160801b031690565b7f4916adce000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b9091905f198382098382029182808310920391808303921461129f57670de0b6b3a764000082101561126f577faccb18165bd6fe31ae1cf318dc5b51eee0e1ba569b88cd74c1773b91fac106699394670de0b6b3a7640000910990828211900360ee1b910360121c170290565b84907f5173648d000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b5050670de0b6b3a764000090049150565b906112ed57508051156112c557805190602001fd5b7f1425ea42000000000000000000000000000000000000000000000000000000005f5260045ffd5b81511580611333575b6112fe575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b156112f656fea164736f6c634300081a000a610200806040523461053557611fef803803809161001d82856107af565b833981019060e0818303126105355780516001600160401b0381116105355781019060e082840312610535576040519160e083016001600160401b038111848210176105ef5760405280516001600160a01b0381168103610535578352610086602082016107d2565b906020840191825261009a604082016107e4565b6040850190815260608201519094906001600160401b03811161053557866100c3918401610834565b6060820190815260808381015190830190815260a08401519192916001600160401b03811161053557886100f8918601610834565b60a0830190815260c085015190946001600160401b03821161053557610120918a9101610834565b60c08301908152610133602088016107e4565b6040880151969092906001600160a01b03881688036105355761015860608a01610879565b9661016560808b01610879565b9a61017260a08c016107d2565b60c08c0151909b6001600160401b03821161053557018d601f82011215610535578051906001600160401b0382116105ef576040519e8f8360051b6020016101ba90826107af565b8381526020019260061b82016020019181831161053557602001925b828410610753575050505064ffffffffff929161025a602061025f9360018060a01b039051168060018060a01b03195f5416175f556040519384915f7fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf808180a35161024981518092858086019101610813565b81010301601f1981018352826107af565b61089a565b608052511660a0523360c05260405192631711922960e31b845260018060a01b03166004840152602083602481335afa8015610748575f90610714575b6102c6935060e05251610100525161025a6020604051836102498295518092858086019101610813565b61012052516001600160a01b031661014052518051906001600160401b0382116105ef5760015490600182811c9216801561070a575b60208310146106f65781601f849311610688575b50602090601f8311600114610622575f92610617575b50508160011b915f199060031b1c1916176001555b61018052610160526101a0526101c0528051905f915f915b81831061053957836101e05260018060a01b03610140511660018060a01b03610160511690604051905f806020840163095ea7b360e01b815285602486015281196044860152604485526103a86064866107af565b84519082855af16103b76108bc565b816104fe575b50806104f4575b156104af575b60405161163290816109bd823960805181611283015260a05181818161030001528181610f8b015281816111b30152611369015260c0518181816103470152610fd2015260e05181818161020b01526107870152610100518181816105a9015261088e015261012051818181610a6c015261123a0152610140518181816104b901528181610af101526110b30152610160518181816104760152610c910152610180518181816101cf0152610b2201526101a051818181610194015261091c01526101c0518181816102be0152610b4c01526101e05181818161041901526108ea0152f35b6104e76104ec936040519063095ea7b360e01b602083015260248201525f6044820152604481526104e16064826107af565b826108eb565b6108eb565b8080806103ca565b50803b15156103c4565b8051801592508215610513575b5050846103bd565b819250906020918101031261053557602061052e9101610879565b848061050b565b5f80fd5b91929091906001600160401b036105508584610886565b5151166001600160401b039182160190811161060357926105718183610886565b519060045491680100000000000000008310156105ef5760018301806004558310156105db5760019260045f5260205f200190838060401b038151166cffffffffff00000000000000006020845493015160401b1691858060681b03191617179055019190610353565b634e487b7160e01b5f52603260045260245ffd5b634e487b7160e01b5f52604160045260245ffd5b634e487b7160e01b5f52601160045260245ffd5b015190505f80610326565b60015f9081528281209350601f198516905b8181106106705750908460019594939210610658575b505050811b0160015561033b565b01515f1960f88460031b161c191690555f808061064a565b92936020600181928786015181550195019301610634565b60015f529091507fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6601f840160051c810191602085106106ec575b90601f859493920160051c01905b8181106106de5750610310565b5f81558493506001016106d1565b90915081906106c3565b634e487b7160e01b5f52602260045260245ffd5b91607f16916102fc565b506020833d602011610740575b8161072e602093836107af565b81010312610535576102c6925161029c565b3d9150610721565b6040513d5f823e3d90fd5b6040848303126105355760408051919082016001600160401b038111838210176105ef576040528451906001600160401b03821682036105355782602092604094526107a08388016107d2565b838201528152019301926101d6565b601f909101601f19168101906001600160401b038211908210176105ef57604052565b519064ffffffffff8216820361053557565b51906001600160a01b038216820361053557565b6001600160401b0381116105ef57601f01601f191660200190565b5f5b8381106108245750505f910152565b8181015183820152602001610815565b81601f8201121561053557805161084a816107f8565b9261085860405194856107af565b81845260208284010111610535576108769160208085019101610813565b90565b5190811515820361053557565b80518210156105db5760209160051b010190565b6020815191015190602081106108ae575090565b5f199060200360031b1b1690565b3d156108e6573d906108cd826107f8565b916108db60405193846107af565b82523d5f602084013e565b606090565b5f806109139260018060a01b03169360208151910182865af161090c6108bc565b908361095e565b805190811515918261093b575b50506109295750565b635274afe760e01b5f5260045260245ffd5b81925090602091810103126105355760206109569101610879565b155f80610920565b90610982575080511561097357805190602001fd5b630a12f52160e11b5f5260045ffd5b815115806109b3575b610993575090565b639996b31560e01b5f9081526001600160a01b0391909116600452602490fd5b50803b1561098b56fe6080806040526004361015610012575f80fd5b5f3560e01c9081630724fda91461126d575080630f7514a2146112225780631686c90914610ff65780632dd3100014610fb35780633f31ae3f146106fc57806349fc73dd146105f05780634e390d3e146105cc57806351e75e8b1461059257806375829def146104dd57806382bfefc81461049a578063845aef4b1461045757806390e64d131461043d578063936c63d9146103f9578063a480ca7914610324578063bb4b5734146102e3578063bf44497a146102a7578063bf4ed03f1461022e578063c57981b5146101f4578063cbe9e5ef146101b8578063ce36b33514610177578063ce516507146101375763f851a4401461010e575f80fd5b34610133575f3660031901126101335760206001600160a01b035f5416604051908152f35b5f80fd5b3461013357602036600319011261013357602061016d60043560ff6001918060081c5f526002602052161b60405f205416151590565b6040519015158152f35b34610133575f36600319011261013357602060405164ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b34610133575f3660031901126101335760206040517f000000000000000000000000000000000000000000000000000000000000000015158152f35b34610133575f3660031901126101335760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b34610133575f366003190112610133576102466113dd565b6040518091602082016020835281518091526020604084019201905f5b818110610271575050500390f35b8251805167ffffffffffffffff16855260209081015164ffffffffff168186015286955060409094019390920191600101610263565b34610133575f3660031901126101335760206040517f000000000000000000000000000000000000000000000000000000000000000015158152f35b34610133575f36600319011261013357602060405164ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b346101335760203660031901126101335761033d6112f5565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168033036103ca575047905f80808085855af161038161139e565b501561039257602082604051908152f35b6001600160a01b03907f245bf0c0000000000000000000000000000000000000000000000000000000005f521660045260245260445ffd5b7f4e3ddeed000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b34610133575f36600319011261013357602060405167ffffffffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168152f35b34610133575f36600319011261013357602061016d611361565b34610133575f3660031901126101335760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b34610133575f3660031901126101335760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b34610133576020366003190112610133576104f66112f5565b5f546001600160a01b03811633810361056357506001600160a01b037fffffffffffffffffffffffff0000000000000000000000000000000000000000921691829116175f55337fbdd36143ee09de60bdefca70680e0f71189b2ed7acee364b53917ad433fdaf805f80a3005b7fc6cce6a4000000000000000000000000000000000000000000000000000000005f526004523360245260445ffd5b34610133575f3660031901126101335760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b34610133575f36600319011261013357602064ffffffffff60035416604051908152f35b34610133575f366003190112610133576040515f6001548060011c906001811680156106f2575b6020831081146106de578285529081156106ba575060011461065c575b6106588361064481850382611327565b6040519182916020835260208301906112b6565b0390f35b91905060015f527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6915f905b8082106106a057509091508101602001610644610634565b919260018160209254838588010152019101909291610688565b60ff191660208086019190915291151560051b840190910191506106449050610634565b634e487b7160e01b5f52602260045260245ffd5b91607f1691610617565b608036600319011261013357600435602435906001600160a01b03821680920361013357604435906001600160801b03821691828103610133576064359367ffffffffffffffff851161013357366023860112156101335784600401359467ffffffffffffffff86116101335760248660051b82010136811161013357610781611361565b610f5c577f0000000000000000000000000000000000000000000000000000000000000000803410610f2d57506107cf8560ff6001918060081c5f526002602052161b60405f205416151590565b610f01576040516020810190868252846040820152876060820152606081526107f9608082611327565b5190206040516020810191825260208152610815604082611327565b5190209161082288611349565b97610830604051998a611327565b8852602401602088015b828210610ef157505050925f935b865185101561088a5761085b8588611492565b519081811015610879575f52602052600160405f205b940193610848565b905f52602052600160405f20610871565b85907f000000000000000000000000000000000000000000000000000000000000000003610ec95760035464ffffffffff811615610eaf575b508160081c5f52600260205260405f20600160ff84161b815417905567ffffffffffffffff7f000000000000000000000000000000000000000000000000000000000000000016670de0b6b3a76400008103610e8457507f000000000000000000000000000000000000000000000000000000000000000064ffffffffff8116610e7e575064ffffffffff4216935b61095a6113dd565b9081519161096783611349565b926109756040519485611327565b808452601f1961098482611349565b015f5b818110610e5b5750506109b66109b167ffffffffffffffff6109a885611471565b515116876114eb565b6114a6565b64ffffffffff8060206109c886611471565b510151168a0116906001600160801b03604051916109e58361130b565b169182825260208201526109f886611471565b52610a0285611471565b50916001905b828210610dc7575050846001600160801b03831610610d9c575b50505064ffffffffff6020610a3b5f1984510184611492565b51015116946001600160a01b035f54169564ffffffffff60405192610a5f8461130b565b16825260208201526040517f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610a9f604082611327565b60405191610aac8361130b565b5f83525f602084015260405197610120890189811067ffffffffffffffff821117610d88576040999594939299528452602084019787895260408501868152606086017f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316815260808701907f00000000000000000000000000000000000000000000000000000000000000001515825260a08801927f00000000000000000000000000000000000000000000000000000000000000001515845260c0890194855260e0890195865261010089019687526040519c8d997f7ee21391000000000000000000000000000000000000000000000000000000008b5260048b0160409052516001600160a01b031660448b0152516001600160a01b031660648a0152516001600160801b03166084890152516001600160a01b031660a488015251151560c487015251151560e486015251805164ffffffffff166101048601526020015164ffffffffff1661012485015251610144840161016090526101a48401610c3c916112b6565b905180516001600160a01b03166101648501526020015161018484015260031983820301602484015281519081815260200191602001905f5b818110610d5357505050908060209203815f6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000165af1938415610d48575f94610cf4575b507f28b58397e03322f670d6b223cc863f8c148e368b8b615412e6798a641a22842d9160409182519182526020820152a3005b9093506020813d602011610d40575b81610d1060209383611327565b810103126101335751927f28b58397e03322f670d6b223cc863f8c148e368b8b615412e6798a641a22842d610cc1565b3d9150610d03565b6040513d5f823e3d90fd5b825180516001600160801b0316855260209081015164ffffffffff168186015289955060409094019390920191600101610c75565b634e487b7160e01b5f52604160045260245ffd5b6001600160801b0391610db383925f190186611492565b519303168183511601169052858080610a22565b90926001600160801b03600191610df66109b167ffffffffffffffff610ded8988611492565b5151168b6114eb565b9064ffffffffff806020610e0d5f198b018d611492565b51015116816020610e1e8b8a611492565b51015116011660405190610e318261130b565b84841682526020820152610e45888b611492565b52610e50878a611492565b500116930190610a08565b602090604051610e6a8161130b565b5f81525f8382015282828901015201610987565b93610952565b7f36d385ef000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b64ffffffffff19164264ffffffffff1617600355846108c3565b7fb4f06787000000000000000000000000000000000000000000000000000000005f5260045ffd5b813581526020918201910161083a565b847febe6f30d000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b7fa164c6b4000000000000000000000000000000000000000000000000000000005f523460045260245260445ffd5b7fdf4bae05000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445ffd5b34610133575f3660031901126101335760206040516001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000168152f35b346101335760403660031901126101335761100f6112f5565b6024356001600160801b038116809103610133576001600160a01b035f5416338103610563575064ffffffffff60035416801515806111ed575b806111de575b61118457506040516110e95f806001600160a01b0360208501967fa9059cbb0000000000000000000000000000000000000000000000000000000088521695866024860152856044860152604485526110a9606486611327565b6001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001694519082865af16110e261139e565b9083611599565b8051908115159182611160575b505061113557507f2e9d425ba8b27655048400b366d7b6a1f7180ebdb088e06bb7389704860ffe1f60206001600160a01b035f541692604051908152a3005b7f5274afe7000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b819250906020918101031261013357602001518015908115036101335784806110f6565b7fe2e40a0c000000000000000000000000000000000000000000000000000000005f524260045264ffffffffff7f00000000000000000000000000000000000000000000000000000000000000001660245260445260645ffd5b506111e7611361565b1561104f565b5062093a80810164ffffffffff811161120e5764ffffffffff164211611049565b634e487b7160e01b5f52601160045260245ffd5b34610133575f366003190112610133576106586040517f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610644604082611327565b34610133575f36600319011261013357610658907f0000000000000000000000000000000000000000000000000000000000000000602082015260208152610644604082611327565b91908251928382525f5b8481106112e0575050825f602080949584010152601f8019910116010190565b806020809284010151828286010152016112c0565b600435906001600160a01b038216820361013357565b6040810190811067ffffffffffffffff821117610d8857604052565b90601f8019910116810190811067ffffffffffffffff821117610d8857604052565b67ffffffffffffffff8111610d885760051b60200190565b64ffffffffff7f0000000000000000000000000000000000000000000000000000000000000000168015159081611396575090565b905042101590565b3d156113d8573d9067ffffffffffffffff8211610d8857604051916113cd601f8201601f191660200184611327565b82523d5f602084013e565b606090565b600454906113ea82611349565b916113f86040519384611327565b80835260045f9081527f8a35acfbc15ff81a39ae7d344fd709f28e8600b4aa8c65c6b64bfe7fe36bd19b602085015b8383106114345750505050565b6001602081926040516114468161130b565b64ffffffffff865467ffffffffffffffff8116835260401c1683820152815201920192019190611427565b80511561147e5760200190565b634e487b7160e01b5f52603260045260245ffd5b805182101561147e5760209160051b010190565b6001600160801b0381116114c0576001600160801b031690565b7f4916adce000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b9091905f198382098382029182808310920391808303921461158857670de0b6b3a7640000821015611558577faccb18165bd6fe31ae1cf318dc5b51eee0e1ba569b88cd74c1773b91fac106699394670de0b6b3a7640000910990828211900360ee1b910360121c170290565b84907f5173648d000000000000000000000000000000000000000000000000000000005f5260045260245260445ffd5b5050670de0b6b3a764000090049150565b906115d657508051156115ae57805190602001fd5b7f1425ea42000000000000000000000000000000000000000000000000000000005f5260045ffd5b8151158061161c575b6115e7575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b156115df56fea164736f6c634300081a000aa164736f6c634300081a000a
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
000000000000000000000000b1bef51ebca01eb12001a639bdbbff6eeca12b9f
-----Decoded View---------------
Arg [0] : initialAdmin (address): 0xb1bEF51ebCA01EB12001a639bDBbFF6eEcA12B9F
-----Encoded View---------------
1 Constructor Arguments found :
Arg [0] : 000000000000000000000000b1bef51ebca01eb12001a639bdbbff6eeca12b9f
Loading...
Loading
Loading...
Loading
Loading...
Loading
0xbD73389Cbdd4f31F374F2815ecb7f9dEc0F124D3
Net Worth in USD
$0.00
Net Worth in S
0
Multichain Portfolio | 35 Chains
| Chain | Token | Portfolio % | Price | Amount | Value |
|---|
Loading...
Loading
Loading...
Loading
Loading...
Loading
[ Download: CSV Export ]
[ Download: CSV Export ]
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.