-
Notifications
You must be signed in to change notification settings - Fork 602
/
L2ERC721Gateway.sol
222 lines (185 loc) · 8.05 KB
/
L2ERC721Gateway.sol
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
// SPDX-License-Identifier: MIT
pragma solidity =0.8.16;
import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import {IERC721Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/IERC721Upgradeable.sol";
import {ERC721HolderUpgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/utils/ERC721HolderUpgradeable.sol";
import {IL2ERC721Gateway} from "./IL2ERC721Gateway.sol";
import {IL2ScrollMessenger} from "../IL2ScrollMessenger.sol";
import {IL1ERC721Gateway} from "../../L1/gateways/IL1ERC721Gateway.sol";
import {ScrollGatewayBase, IScrollGateway} from "../../libraries/gateway/ScrollGatewayBase.sol";
import {IScrollERC721} from "../../libraries/token/IScrollERC721.sol";
/// @title L2ERC721Gateway
/// @notice The `L2ERC721Gateway` is used to withdraw ERC721 compatible NFTs in layer 2 and
/// finalize deposit the NFTs from layer 1.
/// @dev The withdrawn NFTs tokens will be burned directly. On finalizing deposit, the corresponding
/// NFT will be minted and transfered to the recipient.
///
/// This will be changed if we have more specific scenarios.
contract L2ERC721Gateway is OwnableUpgradeable, ERC721HolderUpgradeable, ScrollGatewayBase, IL2ERC721Gateway {
/**********
* Events *
**********/
/// @notice Emitted when token mapping for ERC721 token is updated.
/// @param _l1Token The address of corresponding ERC721 token in layer 2.
/// @param _l1Token The address of ERC721 token in layer 1.
event UpdateTokenMapping(address _l2Token, address _l1Token);
/*************
* Variables *
*************/
/// @notice Mapping from layer 2 token address to layer 1 token address for ERC721 NFT.
// solhint-disable-next-line var-name-mixedcase
mapping(address => address) public tokenMapping;
/***************
* Constructor *
***************/
constructor() {
_disableInitializers();
}
function initialize(address _counterpart, address _messenger) external initializer {
OwnableUpgradeable.__Ownable_init();
ERC721HolderUpgradeable.__ERC721Holder_init();
ScrollGatewayBase._initialize(_counterpart, address(0), _messenger);
}
/*****************************
* Public Mutating Functions *
*****************************/
/// @inheritdoc IL2ERC721Gateway
function withdrawERC721(
address _token,
uint256 _tokenId,
uint256 _gasLimit
) external payable override {
_withdrawERC721(_token, msg.sender, _tokenId, _gasLimit);
}
/// @inheritdoc IL2ERC721Gateway
function withdrawERC721(
address _token,
address _to,
uint256 _tokenId,
uint256 _gasLimit
) external payable override {
_withdrawERC721(_token, _to, _tokenId, _gasLimit);
}
/// @inheritdoc IL2ERC721Gateway
function batchWithdrawERC721(
address _token,
uint256[] calldata _tokenIds,
uint256 _gasLimit
) external payable override {
_batchWithdrawERC721(_token, msg.sender, _tokenIds, _gasLimit);
}
/// @inheritdoc IL2ERC721Gateway
function batchWithdrawERC721(
address _token,
address _to,
uint256[] calldata _tokenIds,
uint256 _gasLimit
) external payable override {
_batchWithdrawERC721(_token, _to, _tokenIds, _gasLimit);
}
/// @inheritdoc IL2ERC721Gateway
function finalizeDepositERC721(
address _l1Token,
address _l2Token,
address _from,
address _to,
uint256 _tokenId
) external virtual onlyCallByCounterpart nonReentrant {
require(_l1Token != address(0), "token address cannot be 0");
require(_l1Token == tokenMapping[_l2Token], "l2 token mismatch");
IScrollERC721(_l2Token).mint(_to, _tokenId);
emit FinalizeDepositERC721(_l1Token, _l2Token, _from, _to, _tokenId);
}
/// @inheritdoc IL2ERC721Gateway
function finalizeBatchDepositERC721(
address _l1Token,
address _l2Token,
address _from,
address _to,
uint256[] calldata _tokenIds
) external virtual onlyCallByCounterpart nonReentrant {
require(_l1Token != address(0), "token address cannot be 0");
require(_l1Token == tokenMapping[_l2Token], "l2 token mismatch");
for (uint256 i = 0; i < _tokenIds.length; i++) {
IScrollERC721(_l2Token).mint(_to, _tokenIds[i]);
}
emit FinalizeBatchDepositERC721(_l1Token, _l2Token, _from, _to, _tokenIds);
}
/************************
* Restricted Functions *
************************/
/// @notice Update layer 2 to layer 1 token mapping.
/// @param _l1Token The address of corresponding ERC721 token in layer 2.
/// @param _l1Token The address of ERC721 token in layer 1.
function updateTokenMapping(address _l2Token, address _l1Token) external onlyOwner {
require(_l1Token != address(0), "token address cannot be 0");
tokenMapping[_l2Token] = _l1Token;
emit UpdateTokenMapping(_l2Token, _l1Token);
}
/**********************
* Internal Functions *
**********************/
/// @dev Internal function to withdraw ERC721 NFT to layer 1.
/// @param _token The address of ERC721 NFT in layer 2.
/// @param _to The address of recipient in layer 1.
/// @param _tokenId The token id to withdraw.
/// @param _gasLimit Estimated gas limit required to complete the withdraw on layer 1.
function _withdrawERC721(
address _token,
address _to,
uint256 _tokenId,
uint256 _gasLimit
) internal virtual nonReentrant {
address _l1Token = tokenMapping[_token];
require(_l1Token != address(0), "no corresponding l1 token");
// 1. burn token
// @note in case the token has given too much power to the gateway, we check owner here.
require(IScrollERC721(_token).ownerOf(_tokenId) == msg.sender, "token not owned");
IScrollERC721(_token).burn(_tokenId);
// 2. Generate message passed to L1ERC721Gateway.
bytes memory _message = abi.encodeWithSelector(
IL1ERC721Gateway.finalizeWithdrawERC721.selector,
_l1Token,
_token,
msg.sender,
_to,
_tokenId
);
// 3. Send message to L2ScrollMessenger.
IL2ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit);
emit WithdrawERC721(_l1Token, _token, msg.sender, _to, _tokenId);
}
/// @dev Internal function to batch withdraw ERC721 NFT to layer 1.
/// @param _token The address of ERC721 NFT in layer 2.
/// @param _to The address of recipient in layer 1.
/// @param _tokenIds The list of token ids to withdraw.
/// @param _gasLimit Estimated gas limit required to complete the withdraw on layer 1.
function _batchWithdrawERC721(
address _token,
address _to,
uint256[] calldata _tokenIds,
uint256 _gasLimit
) internal virtual nonReentrant {
require(_tokenIds.length > 0, "no token to withdraw");
address _l1Token = tokenMapping[_token];
require(_l1Token != address(0), "no corresponding l1 token");
// 1. transfer token to this contract
for (uint256 i = 0; i < _tokenIds.length; i++) {
// @note in case the token has given too much power to the gateway, we check owner here.
require(IScrollERC721(_token).ownerOf(_tokenIds[i]) == msg.sender, "token not owned");
IScrollERC721(_token).burn(_tokenIds[i]);
}
// 2. Generate message passed to L1ERC721Gateway.
bytes memory _message = abi.encodeWithSelector(
IL1ERC721Gateway.finalizeBatchWithdrawERC721.selector,
_l1Token,
_token,
msg.sender,
_to,
_tokenIds
);
// 3. Send message to L2ScrollMessenger.
IL2ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit);
emit BatchWithdrawERC721(_l1Token, _token, msg.sender, _to, _tokenIds);
}
}