Contract Source Code:
// SPDX-License-Identifier: BUSL-1.1
// Central Limit Order Book (CLOB) exchange
// (c) Long Gamma Labs, 2023.
pragma solidity ^0.8.27;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {Errors as OnchainCLOBErrors} from "@onchainclob/contracts/Errors.sol";
import {IOnchainCLOB} from "@onchainclob/contracts/IOnchainCLOB.sol";
import {IRouter, Hop} from "./IRouter.sol";
import {IOGRouter} from "./IOGRouter.sol";
import {IV2Router} from "./IV2Router.sol";
import {IV3Router} from "./IV3Router.sol";
import {IWETH} from "./IWETH.sol";
import {Errors} from "./Errors.sol";
contract Router is IRouter, ReentrancyGuard {
using SafeERC20 for IERC20;
uint8 constant UNWRAP_AND_WRAP_ID = 0;
uint8 constant ONCHAINCLOB_ID = 1;
uint8 constant ORGANIC_GROWTH_ROUTER_ID = 2;
uint8 constant V2_ROUTER_ID = 3;
uint8 constant V3_ROUTER_ID = 4;
struct SwapParams {
uint256 amountIn;
address routerAddress;
address fromToken;
address toToken;
bool isFromNative;
bool isToNative;
uint24 poolV3fee;
uint256 deadline;
}
receive() external payable {
}
function swapEthForTokens(
uint256 amountOutMin,
Hop[] calldata hops,
address to,
uint256 deadline
) external payable nonReentrant() returns (uint256[] memory amounts) {
require(msg.value > 0, OnchainCLOBErrors.ZeroTokenTransferNotAllowed());
require(hops.length > 0, Errors.WrongHopsCount());
uint256[] memory amountRests;
(amounts, amountRests) = _swap(
msg.value,
hops,
deadline
);
// check final balances
IERC20 toToken = IERC20(hops[hops.length - 1].toToken);
uint256 finalAmountOut = toToken.balanceOf(address(this));
require(finalAmountOut >= amountOutMin, Errors.InsufficientAmountOut());
// withdraw tokens
toToken.safeTransfer(to, finalAmountOut);
// refund rests
_refundRests(hops, amountRests);
}
function swapTokensForEth(
uint256 amountIn,
uint256 amountOutMin,
Hop[] calldata hops,
address to,
uint256 deadline
) external nonReentrant() returns (uint256[] memory amounts) {
require(amountIn > 0, OnchainCLOBErrors.ZeroTokenTransferNotAllowed());
require(hops.length > 0, Errors.WrongHopsCount());
IERC20 fromToken = IERC20(hops[0].fromToken);
// deposit tokens
_safeTansferFromWithBalanceCheck(
fromToken,
msg.sender,
address(this),
amountIn
);
uint256[] memory amountRests;
(amounts, amountRests) = _swap(
amountIn,
hops,
deadline
);
uint256 finalAmountOut = address(this).balance;
require(finalAmountOut >= amountOutMin, Errors.InsufficientAmountOut());
// withdraw result
_sendETH(to, finalAmountOut);
// refund rests
_refundRests(hops, amountRests);
}
function swapTokensForTokens(
uint256 amountIn,
uint256 amountOutMin,
Hop[] calldata hops,
address to,
uint256 deadline
) external nonReentrant() returns (uint256[] memory amounts) {
require(amountIn > 0, OnchainCLOBErrors.ZeroTokenTransferNotAllowed());
require(hops.length > 0, Errors.WrongHopsCount());
IERC20 fromToken = IERC20(hops[0].fromToken);
// deposit tokens
_safeTansferFromWithBalanceCheck(
fromToken,
msg.sender,
address(this),
amountIn
);
uint256[] memory amountRests;
(amounts, amountRests) = _swap(
amountIn,
hops,
deadline
);
// check final balances
IERC20 toToken = IERC20(hops[hops.length - 1].toToken);
uint256 finalAmountOut = toToken.balanceOf(address(this));
require(finalAmountOut >= amountOutMin, Errors.InsufficientAmountOut());
// withdraw tokens
toToken.safeTransfer(to, finalAmountOut);
// refund rests
_refundRests(hops, amountRests);
}
function _swap(
uint256 amountIn,
Hop[] calldata hops,
uint256 deadline
) internal returns (uint256[] memory hopsAmountOut, uint256[] memory hopsAmountOutRest) {
hopsAmountOut = new uint256[](hops.length + 1);
hopsAmountOut[0] = amountIn;
hopsAmountOutRest = new uint256[](hops.length + 1);
hopsAmountOutRest[0] = amountIn;
// execute hops
for (uint i = 0; i < hops.length; ++i) {
uint hopId = i + 1;
uint8 dexId;
bool useForRest;
SwapParams memory swapParams;
(
dexId,
useForRest,
swapParams.isFromNative,
swapParams.isToNative,
swapParams.poolV3fee
) = _unpackParams(hops[i].params);
swapParams.routerAddress = hops[i].routerAddress;
swapParams.fromToken = hops[i].fromToken;
swapParams.toToken = hops[i].toToken;
swapParams.amountIn = _calculateHopAmountIn(hops[i], hopsAmountOut, hopsAmountOutRest, useForRest);
swapParams.deadline = deadline;
uint256 hopFromTokenBalanceOld = _getBalance(swapParams.fromToken, swapParams.isFromNative);
uint256 hopToTokenBalanceOld = _getBalance(swapParams.toToken, swapParams.isToNative);
if (dexId == UNWRAP_AND_WRAP_ID) {
_unwrapAndWrap(swapParams);
} else if (dexId == ONCHAINCLOB_ID) {
_swapUsingOnchainCLOB(swapParams);
} else if (dexId == ORGANIC_GROWTH_ROUTER_ID) {
_swapUsingOrganicGrowthRouter(swapParams);
} else if (dexId == V2_ROUTER_ID) {
_swapUsingV2Router(swapParams);
} else if (dexId == V3_ROUTER_ID) {
_swapUsingV3Router(swapParams);
} else {
revert Errors.UnsupportedDex();
}
uint256 hopFromTokenBalanceNew = _getBalance(swapParams.fromToken, swapParams.isFromNative);
uint256 hopToTokenBalanceNew = _getBalance(swapParams.toToken, swapParams.isToNative);
hopsAmountOut[hopId] = hopToTokenBalanceNew - hopToTokenBalanceOld;
hopsAmountOutRest[hopId] = hopsAmountOut[hopId];
uint256 executedAmountIn = hopFromTokenBalanceOld - hopFromTokenBalanceNew;
uint256 restAmountIn = swapParams.amountIn - executedAmountIn;
if (restAmountIn > 0) {
_returnRestAmountIn(hops[i], hopsAmountOutRest, restAmountIn);
}
}
}
function _calculateHopAmountIn(
Hop calldata hop,
uint256[] memory hopsAmountOut,
uint256[] memory hopsAmountOutRest,
bool useForRest
) internal pure returns (uint256 amountIn) {
for (uint i = 0; i < hop.inputHopParams.length; ++i) {
(uint8 inputHopId, uint16 inputAmountPercent) = _unpackInputHopParams(hop.inputHopParams[i]);
uint256 inputAmount = hopsAmountOut[inputHopId] * inputAmountPercent / 10000;
amountIn += inputAmount;
hopsAmountOutRest[inputHopId] -= inputAmount;
// if hop used to swap amount rests or rest < 1/10000
if (useForRest || hopsAmountOutRest[inputHopId] < hopsAmountOut[inputHopId] / 10000) {
amountIn += hopsAmountOutRest[inputHopId];
hopsAmountOutRest[inputHopId] = 0;
}
}
}
function _returnRestAmountIn(
Hop calldata hop,
uint256[] memory hopsAmountOutRest,
uint256 restAmountIn
) internal pure {
for (uint i = hop.inputHopParams.length; i > 0; i--) {
(uint8 inputHopId, uint16 inputAmountPercent) = _unpackInputHopParams(hop.inputHopParams[i - 1]);
// if input used by more than one hop (<100%), try to return rest amount here
if (inputAmountPercent < 10000) {
hopsAmountOutRest[inputHopId] += restAmountIn;
return;
}
}
// no chance, throw the rest amount into any input
(uint8 restHopId,) = _unpackInputHopParams(hop.inputHopParams[hop.inputHopParams.length - 1]);
hopsAmountOutRest[restHopId] += restAmountIn;
}
function _refundRests(
Hop[] calldata hops,
uint256[] memory amountRests
) internal {
// amountRests has length = hops.length + 1 and the following structure:
// [amountIn rest, hops[0] output rest, hops[1] output rest, ..., hops[hops.length - 1] output = amountOut]
//
// with corresponding tokens:
// [hops[-1].toToken = hops[0].fromToken, hops[0].toToken, hops[1].toToken, ..., hops[hops.length - 1].toToken]
// try to refund all outputs except the last one
for (uint i = 0; i < amountRests.length - 1; ++i) {
if (amountRests[i] == 0) {
continue;
}
uint hopIndex = i == 0 ? 0 : i - 1;
(,, bool isFromNative, bool isToNative,) = _unpackParams(hops[hopIndex].params);
(address token, bool isNative) = i == 0
? (hops[hopIndex].fromToken, isFromNative)
: (hops[hopIndex].toToken, isToNative);
if (isNative) {
_sendETH(msg.sender, amountRests[i]);
} else {
IERC20(token).safeTransfer(msg.sender, amountRests[i]);
}
}
}
function _getBalance(address tokenAddress, bool isNative) internal view returns (uint256) {
if (isNative) { // || tokenAddress == address(0)
return address(this).balance;
} else {
return IERC20(tokenAddress).balanceOf(address(this));
}
}
function _unwrapAndWrap(
SwapParams memory params
) internal {
if (params.fromToken != address(0) && !params.isFromNative) {
IWETH fromTokenWeth = IWETH(params.fromToken);
fromTokenWeth.withdraw(params.amountIn);
}
if (params.toToken != address(0) && !params.isToNative) {
IWETH toTokenWeth = IWETH(params.toToken);
toTokenWeth.deposit{value: params.amountIn}();
}
}
function _swapUsingOnchainCLOB(
SwapParams memory params
) internal {
uint256 nativeAmountIn = 0;
if (params.isFromNative) {
nativeAmountIn = params.amountIn;
} else {
IERC20(params.fromToken).approve(params.routerAddress, params.amountIn);
}
IOnchainCLOB lob = IOnchainCLOB(payable(params.routerAddress));
(
uint256 scalingFactorTokenX,
uint256 scalingFactorTokenY,
address tokenX,
,
,
,
,
,
,
,
,
,
) = lob.getConfig();
if (params.fromToken == tokenX) {
// x -> y
lob.placeOrder{value: nativeAmountIn}(
true,
uint128(params.amountIn / scalingFactorTokenX),
1,
type(uint128).max,
true,
false,
true,
params.deadline
);
} else {
// y -> x
lob.placeMarketOrderWithTargetValue{value: nativeAmountIn}(
false,
uint128(params.amountIn / scalingFactorTokenY),
999999000000000000000,
type(uint128).max,
true,
params.deadline
);
}
}
function _swapUsingV2Router(
SwapParams memory params
) internal {
uint256 nativeAmountIn = 0;
if (params.isFromNative) {
nativeAmountIn = params.amountIn;
} else {
IERC20(params.fromToken).approve(params.routerAddress, params.amountIn);
}
IV2Router router = IV2Router(params.routerAddress);
address[] memory path = new address[](2);
path[0] = params.fromToken;
path[1] = params.toToken;
if (params.isFromNative) {
router.swapExactETHForTokens{value: nativeAmountIn}(
0,
path,
address(this),
params.deadline
);
} else if (params.isToNative) {
router.swapExactTokensForETH(
params.amountIn,
0,
path,
address(this),
params.deadline
);
} else {
router.swapExactTokensForTokens(
params.amountIn,
0,
path,
address(this),
params.deadline
);
}
}
function _swapUsingV3Router(
SwapParams memory params
) internal {
IERC20(params.fromToken).approve(params.routerAddress, params.amountIn);
IV3Router router = IV3Router(params.routerAddress);
IV3Router.ExactInputSingleParams memory v3params = IV3Router.ExactInputSingleParams({
tokenIn: params.fromToken,
tokenOut: params.toToken,
fee: params.poolV3fee,
recipient: address(this),
deadline: params.deadline,
amountIn: params.amountIn,
amountOutMinimum: 0,
sqrtPriceLimitX96: 0
});
router.exactInputSingle(v3params);
}
function _swapUsingOrganicGrowthRouter(
SwapParams memory params
) internal {
uint256 nativeAmountIn = 0;
if (params.isFromNative) {
nativeAmountIn = params.amountIn;
} else {
IERC20(params.fromToken).approve(params.routerAddress, params.amountIn);
}
IOGRouter router = IOGRouter(params.routerAddress);
if (params.isFromNative) {
router.swapExactETHForTokens{value: nativeAmountIn}(
0,
params.toToken,
address(this),
params.deadline
);
} else if (params.isToNative) {
router.swapExactTokensForETH(
params.amountIn,
0,
params.fromToken,
address(this),
params.deadline
);
} else {
address[] memory path = new address[](2);
path[0] = params.fromToken;
path[1] = params.toToken;
router.swapExactTokensForTokens(
params.amountIn,
0,
path,
address(this),
params.deadline
);
}
}
function _safeTansferFromWithBalanceCheck(
IERC20 token,
address from,
address to,
uint256 value
) internal {
uint256 balanceBefore = token.balanceOf(address(this));
token.safeTransferFrom(from, to, value);
uint256 balanceAfter = token.balanceOf(address(this));
require(balanceAfter - balanceBefore == value, OnchainCLOBErrors.InvalidTransfer());
}
function _sendETH(address to, uint256 value) internal {
(bool success, ) = to.call{value: value}("");
require(success, OnchainCLOBErrors.TransferFailed());
}
function _unpackInputHopParams(
uint32 packedInputParams
) internal pure returns (uint8 hopId, uint16 amountPercent) {
hopId = uint8(packedInputParams & 0xFF);
amountPercent = uint16((packedInputParams >> 8) & 0xFFFF);
}
function _unpackParams(
uint64 packedParams
) internal pure returns (
uint8 dexId,
bool useForRest,
bool isFromNative,
bool isToNative,
uint24 poolV3fee
) {
dexId = uint8(packedParams & 0xFF);
useForRest = ((packedParams >> 8) & 0x1) > 0;
isFromNative = ((packedParams >> 9) & 0x1) > 0;
isToNative = ((packedParams >> 10) & 0x1) > 0;
poolV3fee = uint24((packedParams >> 11) & 0xFFFFFF);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ReentrancyGuard.sol)
pragma solidity ^0.8.20;
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If EIP-1153 (transient storage) is available on the chain you're deploying at,
* consider using {ReentrancyGuardTransient} instead.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant NOT_ENTERED = 1;
uint256 private constant ENTERED = 2;
uint256 private _status;
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
constructor() {
_status = NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be NOT_ENTERED
if (_status == ENTERED) {
revert ReentrancyGuardReentrantCall();
}
// Any calls to nonReentrant after this point will fail
_status = ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == ENTERED;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
import {Address} from "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
/**
* @dev An operation with an ERC-20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
// bubble errors
if iszero(success) {
let ptr := mload(0x40)
returndatacopy(ptr, 0, returndatasize())
revert(ptr, returndatasize())
}
returnSize := returndatasize()
returnValue := mload(0)
}
if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silently catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
bool success;
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
returnSize := returndatasize()
returnValue := mload(0)
}
return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
}
}
// SPDX-License-Identifier: BUSL-1.1
// Central Limit Order Book (CLOB) exchange
// (c) Long Gamma Labs, 2023.
pragma solidity ^0.8.26;
contract Errors {
error AddressIsZero();
error ArrayLengthMismatch();
error ChainIsUnstableForTrades();
error ClaimNotAllowed();
error CommissionParamTooHigh();
error Disabled();
error EmptyOrderError();
error ExcessiveSignificantFigures();
error Expired();
error Forbidden();
error FractionalNumbersNotAllowed();
error InsufficientTokenXBalance();
error InsufficientTokenYBalance();
error InvalidCommissionRate();
error InvalidFloatingPointRepresentation();
error InvalidMarketMaker();
error InvalidPriceRange();
error InvalidTransfer();
error MarketOnlyAndPostOnlyFlagsConflict();
error MaxCommissionFailure();
error NativeETHDisabled();
error NonceExhaustedFailure();
error NotImplementedYet();
error OnlyOwnerCanCancelOrders();
error PointerAlreadyFreed();
error PriceExceedsMaximumAllowedValue();
error TransferFailed();
error UnknownOrderId();
error UnknownTrader();
error WrongOwner();
error ZeroMaxDelayNotAllowed();
error ZeroRecoveryTimeNotAllowed();
error ZeroTokenTransferNotAllowed();
}
// SPDX-License-Identifier: BUSL-1.1
// Central Limit Order Book (CLOB) exchange
// (c) Long Gamma Labs, 2023.
pragma solidity ^0.8.26;
interface IOnchainCLOB {
function getConfig() external view returns (
uint256 _scaling_factor_token_x,
uint256 _scaling_factor_token_y,
address _token_x,
address _token_y,
bool _supports_native_eth,
bool _is_token_x_weth,
address _ask_trie,
address _bid_trie,
uint64 _admin_commission_rate,
uint64 _total_aggressive_commission_rate,
uint64 _total_passive_commission_rate,
uint64 _passive_order_payout_rate,
bool _should_invoke_on_trade
);
receive() external payable;
function getTraderBalance(address address_) external view returns (uint128, uint128, bool);
function changeMarketMaker(
address _marketmaker,
bool _should_invoke_on_trade,
uint64 _admin_commission_rate
) external;
function setClaimableStatus(bool status) external;
function placeOrder(
bool isAsk,
uint128 quantity,
uint72 price,
uint128 max_commission,
bool market_only,
bool post_only,
bool transfer_executed_tokens,
uint256 expires
) external payable returns (
uint64 order_id,
uint128 executed_shares,
uint128 executed_value,
uint128 aggressive_fee
);
function placeOrder(
bool isAsk,
uint128 quantity,
uint72 price,
uint128 max_commission,
uint128 amount_to_approve,
bool market_only,
bool post_only,
bool transfer_executed_tokens,
uint256 expires,
uint8 v,
bytes32 r,
bytes32 s
) external payable returns (
uint64 order_id,
uint128 executed_shares,
uint128 executed_value,
uint128 aggressive_fee
);
function placeMarketOrderWithTargetValue(
bool isAsk,
uint128 target_token_y_value,
uint72 price,
uint128 max_commission,
uint128 amount_to_approve,
bool transfer_executed_tokens,
uint256 expires,
uint8 v,
bytes32 r,
bytes32 s
) external payable returns (
uint128 executed_shares,
uint128 executed_value,
uint128 aggressive_fee
);
function placeMarketOrderWithTargetValue(
bool isAsk,
uint128 target_token_y_value,
uint72 price,
uint128 max_commission,
bool transfer_executed_tokens,
uint256 expires
) external payable returns (
uint128 executed_shares,
uint128 executed_value,
uint128 aggressive_fee
);
function claimOrder(
uint64 order_id,
bool only_claim,
bool transfer_tokens,
uint256 expires
) external;
function batchClaim(
address[] memory addresses,
uint64[] memory order_ids,
bool only_claim,
uint256 expires
) external;
function changeOrder(
uint64 old_order_id,
uint128 new_quantity,
uint72 new_price,
uint128 max_commission,
bool post_only,
bool transfer_tokens,
uint256 expires
) external returns (uint64);
function batchChangeOrder(
uint64[] memory order_ids,
uint128[] memory quantities,
uint72[] memory prices,
uint128 max_commission_per_order,
bool post_only,
bool transfer_tokens,
uint256 expires
) external returns (uint64[] memory new_order_ids);
function depositTokens(uint128 token_x_amount, uint128 token_y_amount) external;
function depositTokens(
uint128 token_x_amount,
uint128 token_y_amount,
uint8 v_x,
bytes32 r_x,
bytes32 s_x,
uint8 v_y,
bytes32 r_y,
bytes32 s_y,
uint256 expires
) external;
function withdrawTokens(bool withdraw_all, uint128 token_x_amount, uint128 token_y_amount) external;
function getAccumulatedFees() external returns (uint256);
function transferFees() external;
}
// SPDX-License-Identifier: BUSL-1.1
// Central Limit Order Book (CLOB) exchange
// (c) Long Gamma Labs, 2023.
pragma solidity ^0.8.27;
struct Hop {
uint64 params;
uint32[] inputHopParams;
address routerAddress;
address fromToken;
address toToken;
}
interface IRouter {
function swapEthForTokens(
uint256 amountOutMin,
Hop[] calldata hops,
address to,
uint256 deadline
) external payable returns (uint256[] memory amounts);
function swapTokensForEth(
uint256 amountIn,
uint256 amountOutMin,
Hop[] calldata hops,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
function swapTokensForTokens(
uint256 amountIn,
uint256 amountOutMin,
Hop[] calldata hops,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
}
// SPDX-License-Identifier: BUSL-1.1
// Central Limit Order Book (CLOB) exchange
// (c) Long Gamma Labs, 2023.
pragma solidity ^0.8.27;
interface IOGRouter {
function swapExactTokensForTokens(
uint256 amountIn,
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
function swapExactETHForTokens(
uint256 amountOutMin,
address token,
address to,
uint256 deadline
) external payable returns (uint256 amountTokenOut);
function swapExactTokensForETH(
uint256 amountIn,
uint256 amountOutMin,
address token,
address to,
uint256 deadline
) external returns (uint256 amountWethOut);
}
// SPDX-License-Identifier: BUSL-1.1
// Central Limit Order Book (CLOB) exchange
// (c) Long Gamma Labs, 2023.
pragma solidity ^0.8.27;
interface IV2Router {
function swapExactTokensForTokens(
uint256 amountIn,
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
function swapExactETHForTokens(
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external payable returns (uint256[] memory amounts);
function swapExactTokensForETH(
uint256 amountIn,
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
}
// SPDX-License-Identifier: BUSL-1.1
// Central Limit Order Book (CLOB) exchange
// (c) Long Gamma Labs, 2023.
pragma solidity ^0.8.27;
interface IV3Router {
struct ExactInputSingleParams {
address tokenIn;
address tokenOut;
uint24 fee;
address recipient;
uint256 deadline;
uint256 amountIn;
uint256 amountOutMinimum;
uint160 sqrtPriceLimitX96;
}
/// @notice Swaps `amountIn` of one token for as much as possible of another token
/// @param params The parameters necessary for the swap, encoded as `ExactInputSingleParams` in calldata
/// @return amountOut The amount of the received token
function exactInputSingle(
ExactInputSingleParams calldata params
) external payable returns (uint256 amountOut);
}
// SPDX-License-Identifier: BUSL-1.1
// Central Limit Order Book (CLOB) exchange
// (c) Long Gamma Labs, 2023.
pragma solidity ^0.8.27;
interface IWETH {
function deposit() external payable;
function withdraw(uint wad) external;
}
// SPDX-License-Identifier: BUSL-1.1
// Central Limit Order Book (CLOB) exchange
// (c) Long Gamma Labs, 2023.
pragma solidity ^0.8.27;
contract Errors {
error InsufficientAmountOut();
error UnsupportedDex();
error WrongHopsCount();
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC1363.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Address.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
if (address(this).balance < amount) {
revert Errors.InsufficientBalance(address(this).balance, amount);
}
(bool success, ) = recipient.call{value: amount}("");
if (!success) {
revert Errors.FailedCall();
}
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason or custom error, it is bubbled
* up by this function (like regular Solidity function calls). However, if
* the call reverted with no returned reason, this function reverts with a
* {Errors.FailedCall} error.
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
if (address(this).balance < value) {
revert Errors.InsufficientBalance(address(this).balance, value);
}
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
* was not a contract or bubbling up the revert reason (falling back to {Errors.FailedCall}) in case
* of an unsuccessful call.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
// only check if target is a contract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
if (returndata.length == 0 && target.code.length == 0) {
revert AddressEmptyCode(target);
}
return returndata;
}
}
/**
* @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
* revert reason or with a default {Errors.FailedCall} error.
*/
function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {Errors.FailedCall}.
*/
function _revert(bytes memory returndata) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly ("memory-safe") {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert Errors.FailedCall();
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../token/ERC20/IERC20.sol";
// 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.1.0) (utils/Errors.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of common custom errors used in multiple contracts
*
* IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
* It is recommended to avoid relying on the error API for critical functionality.
*
* _Available since v5.1._
*/
library Errors {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedCall();
/**
* @dev The deployment failed.
*/
error FailedDeployment();
/**
* @dev A necessary precompile is missing.
*/
error MissingPrecompile(address);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}