Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add (un)/wrapping for steth #317

Merged
merged 11 commits into from
Sep 18, 2023
Merged

add (un)/wrapping for steth #317

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e416d41
add wrapping for steth
ewilz Sep 13, 2023
6ca3b87
linting
ewilz Sep 13, 2023
efef4ac
test Steth swaps
ewilz Sep 14, 2023
242d110
gas tests
ewilz Sep 14, 2023
be68f1f
lint
ewilz Sep 14, 2023
f85d73a
forge fmt?
ewilz Sep 14, 2023
ccff95c
PR comments
ewilz Sep 18, 2023
7d1ba64
dont repeat constant declaration
ewilz Sep 18, 2023
a7deced
add comment about STETH_DUST
ewilz Sep 18, 2023
e807f9e
lint
ewilz Sep 18, 2023
1d1abbd
update readme
ewilz Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion contracts/base/Dispatcher.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,8 +350,24 @@ abstract contract Dispatcher is Payments, V2SwapRouter, V3SwapRouter, Callbacks,
spender := calldataload(add(inputs.offset, 0x20))
}
Payments.approveERC20(token, spender);
} else if (command == Commands.WRAP_STETH) {
address recipient;
uint256 amount;
assembly {
recipient := calldataload(inputs.offset)
amount := calldataload(add(inputs.offset, 0x20))
}
Payments.wrapSTETH(map(recipient), amount);
} else if (command == Commands.UNWRAP_STETH) {
address recipient;
uint256 amountMin;
assembly {
recipient := calldataload(inputs.offset)
amountMin := calldataload(add(inputs.offset, 0x20))
}
Payments.unwrapSTETH(map(recipient), amountMin);
} else {
// placeholder area for commands 0x22-0x3f
// placeholder area for commands 0x25-0x3f
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added 2 commands but this number increased by 3? Seems it switched from inclusive to exclusive

Copy link
Member Author

@ewilz ewilz Sep 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this was just forgotten in a past PR

revert InvalidCommandType(command);
}
}
Expand Down
12 changes: 12 additions & 0 deletions contracts/base/RouterImmutables.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@ pragma solidity ^0.8.17;
import {IAllowanceTransfer} from 'permit2/src/interfaces/IAllowanceTransfer.sol';
import {ERC20} from 'solmate/src/tokens/ERC20.sol';
import {IWETH9} from '../interfaces/external/IWETH9.sol';
import {ISTETH} from '../interfaces/external/ISTETH.sol';
import {IWSTETH} from '../interfaces/external/IWSTETH.sol';

struct RouterParameters {
address permit2;
address weth9;
address steth;
address wsteth;
address seaportV1_5;
address seaportV1_4;
address openseaConduit;
Expand All @@ -34,6 +38,12 @@ contract RouterImmutables {
/// @dev WETH9 address
IWETH9 internal immutable WETH9;

/// @dev STETH address
ISTETH internal immutable STETH;

/// @dev WSTETH address
IWSTETH internal immutable WSTETH;

/// @dev Permit2 address
IAllowanceTransfer internal immutable PERMIT2;

Expand Down Expand Up @@ -99,6 +109,8 @@ contract RouterImmutables {
constructor(RouterParameters memory params) {
PERMIT2 = IAllowanceTransfer(params.permit2);
WETH9 = IWETH9(params.weth9);
WSTETH = IWSTETH(params.wsteth);
STETH = ISTETH(params.steth);
SEAPORT_V1_5 = params.seaportV1_5;
SEAPORT_V1_4 = params.seaportV1_4;
OPENSEA_CONDUIT = params.openseaConduit;
Expand Down
9 changes: 9 additions & 0 deletions contracts/interfaces/external/ISTETH.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity ^0.8.4;

import {IERC20} from '@openzeppelin/contracts/token/ERC20/IERC20.sol';

/// @title Partial interface for stETH
interface ISTETH is IERC20 {
function getSharesByPooledEth(uint256 _ethAmount) external view returns (uint256);
}
24 changes: 24 additions & 0 deletions contracts/interfaces/external/IWSTETH.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity ^0.8.4;

import {IERC20} from '@openzeppelin/contracts/token/ERC20/IERC20.sol';

/// @title Interface for wstETH
interface IWSTETH is IERC20 {
/// @notice wrap steth to get wsteth
function wrap(uint256 stETHAmount) external returns (uint256);

/// @notice unwrap wsteth to get steth
function unwrap(uint256 wstETHAmount) external returns (uint256);

function tokensPerStEth() external view returns (uint256);

function stEthPerToken() external view returns (uint256);

function stETH() external view returns (address);

function permit(address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s)
external;

function DOMAIN_SEPARATOR() external view returns (bytes32);
}
5 changes: 4 additions & 1 deletion contracts/libraries/Commands.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,8 @@ library Commands {
uint256 constant SEAPORT_V1_4 = 0x20;
uint256 constant EXECUTE_SUB_PLAN = 0x21;
uint256 constant APPROVE_ERC20 = 0x22;
// COMMAND_PLACEHOLDER for 0x23 to 0x3f (all unused)
uint256 constant WRAP_STETH = 0x23;
uint256 constant UNWRAP_STETH = 0x24;

// COMMAND_PLACEHOLDER for 0x25 to 0x3f (all unused)
}
43 changes: 42 additions & 1 deletion contracts/modules/Payments.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ abstract contract Payments is RouterImmutables {

error InsufficientToken();
error InsufficientETH();
error InsufficientSTETH();
error InvalidBips();
error InvalidSpender();

Expand All @@ -32,7 +33,6 @@ abstract contract Payments is RouterImmutables {
if (value == Constants.CONTRACT_BALANCE) {
value = ERC20(token).balanceOf(address(this));
}

ERC20(token).safeTransfer(recipient, value);
}
}
Expand Down Expand Up @@ -137,4 +137,45 @@ abstract contract Payments is RouterImmutables {
}
}
}

/// @notice Wrap an amount of stETH into wstETH
/// @param recipient The recipient of the wstETH
/// @param amount The amount of wstETH desired
function wrapSTETH(address recipient, uint256 amount) internal {
if (amount == Constants.CONTRACT_BALANCE) {
amount = STETH.balanceOf(address(this));
} else if (amount > STETH.balanceOf(address(this))) {
revert InsufficientSTETH();
}

if (amount > 0) {
if (STETH.allowance(address(this), address(WSTETH)) < amount) {
STETH.approve(address(WSTETH), type(uint256).max);
}

amount = WSTETH.wrap(amount);

if (recipient != address(this)) {
WSTETH.transfer(recipient, amount);
ewilz marked this conversation as resolved.
Show resolved Hide resolved
}
}
}

/// @notice Unwraps all of the contract's wstETH into stETH
/// @param recipient The recipient of the stETH
/// @param amountMinimum The minimum amount of stETH desired
function unwrapSTETH(address recipient, uint256 amountMinimum) internal {
uint256 balanceWSTETH = WSTETH.balanceOf(address(this));
if (balanceWSTETH > 0) {
uint256 amountSTETH = WSTETH.unwrap(balanceWSTETH);

if (amountSTETH < amountMinimum) {
revert InsufficientSTETH();
}

if (recipient != address(this)) {
STETH.transfer(recipient, amountSTETH);
}
}
}
}
2 changes: 1 addition & 1 deletion deploy-addresses/base-goerli.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"UniversalRouterV1_2": "0xd0872d928672ae2ff74bdb2f5130ac12229cafaf",
"UnsupportedProtocol": "0x7B46ee9BaB49bd5b37117494689A035b0F187B59"
}
}
4 changes: 4 additions & 0 deletions script/DeployUniversalRouter.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ abstract contract DeployUniversalRouter is Script {
params = RouterParameters({
permit2: mapUnsupported(params.permit2),
weth9: mapUnsupported(params.weth9),
steth: mapUnsupported(params.steth),
wsteth: mapUnsupported(params.wsteth),
seaportV1_5: mapUnsupported(params.seaportV1_5),
seaportV1_4: mapUnsupported(params.seaportV1_4),
openseaConduit: mapUnsupported(params.openseaConduit),
Expand Down Expand Up @@ -69,6 +71,8 @@ abstract contract DeployUniversalRouter is Script {
function logParams() internal view {
console2.log('permit2:', params.permit2);
console2.log('weth9:', params.weth9);
console2.log('steth:', params.steth);
console2.log('wsteth:', params.wsteth);
console2.log('seaportV1_5:', params.seaportV1_5);
console2.log('seaportV1_4:', params.seaportV1_4);
console2.log('openseaConduit:', params.openseaConduit);
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployArbitrum.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployArbitrum is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0x82aF49447D8a07e3bd95BD0d56f35241523fBab1,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployArbitrumGoerli.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployArbitrumGoerli is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0xe39Ab88f8A4777030A534146A9Ca3B52bd5D43A3,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: UNSUPPORTED_PROTOCOL,
seaportV1_4: UNSUPPORTED_PROTOCOL,
openseaConduit: UNSUPPORTED_PROTOCOL,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployAvalanche.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployAvalanche is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0xB31f66AA3C1e785363F0875A1B74E27b85FD66c7,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployBSC.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployBSC is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployBase.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployBase is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0x4200000000000000000000000000000000000006,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployBaseGoerli.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployBaseGoerli is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0x44D627f900da8AdaC7561bD73aA745F132450798,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployCelo.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployCelo is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: UNSUPPORTED_PROTOCOL,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: UNSUPPORTED_PROTOCOL,
seaportV1_4: UNSUPPORTED_PROTOCOL,
openseaConduit: UNSUPPORTED_PROTOCOL,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployCeloAlfajores.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployCeloAlfajores is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: UNSUPPORTED_PROTOCOL,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: UNSUPPORTED_PROTOCOL,
seaportV1_4: UNSUPPORTED_PROTOCOL,
openseaConduit: UNSUPPORTED_PROTOCOL,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployGoerli.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployGoerli is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployMainnet.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployMainnet is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2,
steth: 0xae7ab96520DE3A18E5e111B5EaAb095312D7fE84,
wsteth: 0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployOptimism.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployOptimism is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0x4200000000000000000000000000000000000006,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployOptimismGoerli.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployOptimismGoerli is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0x4200000000000000000000000000000000000006,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: UNSUPPORTED_PROTOCOL,
seaportV1_4: UNSUPPORTED_PROTOCOL,
openseaConduit: UNSUPPORTED_PROTOCOL,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployPolygon.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ contract DeployPolygon is DeployUniversalRouter {
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
nftxZap: UNSUPPORTED_PROTOCOL,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeployPolygonMumbai.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeployPolygonMumbai is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0x9c3C9283D3e44854697Cd22D3Faa240Cfb032889,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions script/deployParameters/DeploySepolia.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contract DeploySepolia is DeployUniversalRouter {
params = RouterParameters({
permit2: 0x000000000022D473030F116dDEE9F6B43aC78BA3,
weth9: 0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14,
steth: UNSUPPORTED_PROTOCOL,
wsteth: UNSUPPORTED_PROTOCOL,
seaportV1_5: 0x00000000000000ADc04C56Bf30aC9d3c0aAF14dC,
seaportV1_4: 0x00000000000001ad428e4906aE43D8F9852d0dD6,
openseaConduit: 0x1E0049783F008A0085193E00003D00cd54003c71,
Expand Down
2 changes: 2 additions & 0 deletions test/foundry-tests/UniswapV2.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ abstract contract UniswapV2Test is Test {
RouterParameters memory params = RouterParameters({
permit2: address(PERMIT2),
weth9: address(WETH9),
steth: address(0),
wsteth: address(0),
seaportV1_5: address(0),
seaportV1_4: address(0),
openseaConduit: address(0),
Expand Down
2 changes: 2 additions & 0 deletions test/foundry-tests/UniversalRouter.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ contract UniversalRouterTest is Test {
RouterParameters memory params = RouterParameters({
permit2: address(0),
weth9: address(0),
steth: address(0),
wsteth: address(0),
seaportV1_5: address(0),
seaportV1_4: address(0),
openseaConduit: address(0),
Expand Down
Loading
Loading