-
Notifications
You must be signed in to change notification settings - Fork 18
/
L1ERC721Gateway.sol
251 lines (207 loc) · 9.61 KB
/
L1ERC721Gateway.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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
// SPDX-License-Identifier: MIT
pragma solidity =0.8.24;
import {IERC721Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/IERC721Upgradeable.sol";
import {ERC721HolderUpgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC721/utils/ERC721HolderUpgradeable.sol";
import {IL2ERC721Gateway} from "../../L2/gateways/IL2ERC721Gateway.sol";
import {IL1ScrollMessenger} from "../IL1ScrollMessenger.sol";
import {IL1ERC721Gateway} from "./IL1ERC721Gateway.sol";
import {IMessageDropCallback} from "../../libraries/callbacks/IMessageDropCallback.sol";
import {ScrollGatewayBase} from "../../libraries/gateway/ScrollGatewayBase.sol";
/// @title L1ERC721Gateway
/// @notice The `L1ERC721Gateway` is used to deposit ERC721 compatible NFT on layer 1 and
/// finalize withdraw the NFTs from layer 2.
/// @dev The deposited NFTs are held in this gateway. On finalizing withdraw, the corresponding
/// NFT will be transfer to the recipient directly.
///
/// This will be changed if we have more specific scenarios.
contract L1ERC721Gateway is ERC721HolderUpgradeable, ScrollGatewayBase, IL1ERC721Gateway, IMessageDropCallback {
/**********
* Events *
**********/
/// @notice Emitted when token mapping for ERC721 token is updated.
/// @param l1Token The address of ERC721 token in layer 1.
/// @param oldL2Token The address of the old corresponding ERC721 token in layer 2.
/// @param newL2Token The address of the new corresponding ERC721 token in layer 2.
event UpdateTokenMapping(address indexed l1Token, address indexed oldL2Token, address indexed newL2Token);
/*************
* Variables *
*************/
/// @notice Mapping from l1 token address to l2 token address for ERC721 NFT.
mapping(address => address) public tokenMapping;
/***************
* Constructor *
***************/
/// @notice Constructor for `L2ERC721Gateway` implementation contract.
///
/// @param _counterpart The address of `L2ERC721Gateway` contract in L2.
/// @param _messenger The address of `L1ScrollMessenger` contract in L1.
constructor(address _counterpart, address _messenger) ScrollGatewayBase(_counterpart, address(0), _messenger) {
_disableInitializers();
}
/// @notice Initialize the storage of L1ERC721Gateway.
///
/// @dev The parameters `_counterpart` and `_messenger` are no longer used.
///
/// @param _counterpart The address of L2ERC721Gateway in L2.
/// @param _messenger The address of L1ScrollMessenger in L1.
function initialize(address _counterpart, address _messenger) external initializer {
ERC721HolderUpgradeable.__ERC721Holder_init();
ScrollGatewayBase._initialize(_counterpart, address(0), _messenger);
}
/*****************************
* Public Mutating Functions *
*****************************/
/// @inheritdoc IL1ERC721Gateway
function depositERC721(
address _token,
uint256 _tokenId,
uint256 _gasLimit
) external payable override {
_depositERC721(_token, _msgSender(), _tokenId, _gasLimit);
}
/// @inheritdoc IL1ERC721Gateway
function depositERC721(
address _token,
address _to,
uint256 _tokenId,
uint256 _gasLimit
) external payable override {
_depositERC721(_token, _to, _tokenId, _gasLimit);
}
/// @inheritdoc IL1ERC721Gateway
function batchDepositERC721(
address _token,
uint256[] calldata _tokenIds,
uint256 _gasLimit
) external payable override {
_batchDepositERC721(_token, _msgSender(), _tokenIds, _gasLimit);
}
/// @inheritdoc IL1ERC721Gateway
function batchDepositERC721(
address _token,
address _to,
uint256[] calldata _tokenIds,
uint256 _gasLimit
) external payable override {
_batchDepositERC721(_token, _to, _tokenIds, _gasLimit);
}
/// @inheritdoc IL1ERC721Gateway
function finalizeWithdrawERC721(
address _l1Token,
address _l2Token,
address _from,
address _to,
uint256 _tokenId
) external virtual onlyCallByCounterpart nonReentrant {
require(_l2Token != address(0), "token address cannot be 0");
require(_l2Token == tokenMapping[_l1Token], "l2 token mismatch");
IERC721Upgradeable(_l1Token).safeTransferFrom(address(this), _to, _tokenId);
emit FinalizeWithdrawERC721(_l1Token, _l2Token, _from, _to, _tokenId);
}
/// @inheritdoc IL1ERC721Gateway
function finalizeBatchWithdrawERC721(
address _l1Token,
address _l2Token,
address _from,
address _to,
uint256[] calldata _tokenIds
) external virtual onlyCallByCounterpart nonReentrant {
require(_l2Token != address(0), "token address cannot be 0");
require(_l2Token == tokenMapping[_l1Token], "l2 token mismatch");
for (uint256 i = 0; i < _tokenIds.length; i++) {
IERC721Upgradeable(_l1Token).safeTransferFrom(address(this), _to, _tokenIds[i]);
}
emit FinalizeBatchWithdrawERC721(_l1Token, _l2Token, _from, _to, _tokenIds);
}
/// @inheritdoc IMessageDropCallback
function onDropMessage(bytes calldata _message) external payable virtual onlyInDropContext nonReentrant {
require(msg.value == 0, "nonzero msg.value");
if (bytes4(_message[0:4]) == IL2ERC721Gateway.finalizeDepositERC721.selector) {
(address _token, , address _receiver, , uint256 _tokenId) = abi.decode(
_message[4:],
(address, address, address, address, uint256)
);
IERC721Upgradeable(_token).safeTransferFrom(address(this), _receiver, _tokenId);
emit RefundERC721(_token, _receiver, _tokenId);
} else if (bytes4(_message[0:4]) == IL2ERC721Gateway.finalizeBatchDepositERC721.selector) {
(address _token, , address _receiver, , uint256[] memory _tokenIds) = abi.decode(
_message[4:],
(address, address, address, address, uint256[])
);
for (uint256 i = 0; i < _tokenIds.length; i++) {
IERC721Upgradeable(_token).safeTransferFrom(address(this), _receiver, _tokenIds[i]);
}
emit BatchRefundERC721(_token, _receiver, _tokenIds);
} else {
revert("invalid selector");
}
}
/************************
* Restricted Functions *
************************/
/// @notice Update layer 2 to layer 2 token mapping.
/// @param _l1Token The address of ERC721 token on layer 1.
/// @param _l2Token The address of corresponding ERC721 token on layer 2.
function updateTokenMapping(address _l1Token, address _l2Token) external onlyOwner {
require(_l2Token != address(0), "token address cannot be 0");
address _oldL2Token = tokenMapping[_l1Token];
tokenMapping[_l1Token] = _l2Token;
emit UpdateTokenMapping(_l1Token, _oldL2Token, _l2Token);
}
/**********************
* Internal Functions *
**********************/
/// @dev Internal function to deposit ERC721 NFT to layer 2.
/// @param _token The address of ERC721 NFT on layer 1.
/// @param _to The address of recipient on layer 2.
/// @param _tokenId The token id to deposit.
/// @param _gasLimit Estimated gas limit required to complete the deposit on layer 2.
function _depositERC721(
address _token,
address _to,
uint256 _tokenId,
uint256 _gasLimit
) internal virtual nonReentrant {
address _l2Token = tokenMapping[_token];
require(_l2Token != address(0), "no corresponding l2 token");
address _sender = _msgSender();
// 1. transfer token to this contract
IERC721Upgradeable(_token).safeTransferFrom(_sender, address(this), _tokenId);
// 2. Generate message passed to L2ERC721Gateway.
bytes memory _message = abi.encodeCall(
IL2ERC721Gateway.finalizeDepositERC721,
(_token, _l2Token, _sender, _to, _tokenId)
);
// 3. Send message to L1ScrollMessenger.
IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit, _sender);
emit DepositERC721(_token, _l2Token, _sender, _to, _tokenId);
}
/// @dev Internal function to batch deposit ERC721 NFT to layer 2.
/// @param _token The address of ERC721 NFT on layer 1.
/// @param _to The address of recipient on layer 2.
/// @param _tokenIds The list of token ids to deposit.
/// @param _gasLimit Estimated gas limit required to complete the deposit on layer 2.
function _batchDepositERC721(
address _token,
address _to,
uint256[] calldata _tokenIds,
uint256 _gasLimit
) internal virtual nonReentrant {
require(_tokenIds.length > 0, "no token to deposit");
address _l2Token = tokenMapping[_token];
require(_l2Token != address(0), "no corresponding l2 token");
address _sender = _msgSender();
// 1. transfer token to this contract
for (uint256 i = 0; i < _tokenIds.length; i++) {
IERC721Upgradeable(_token).safeTransferFrom(_sender, address(this), _tokenIds[i]);
}
// 2. Generate message passed to L2ERC721Gateway.
bytes memory _message = abi.encodeCall(
IL2ERC721Gateway.finalizeBatchDepositERC721,
(_token, _l2Token, _sender, _to, _tokenIds)
);
// 3. Send message to L1ScrollMessenger.
IL1ScrollMessenger(messenger).sendMessage{value: msg.value}(counterpart, 0, _message, _gasLimit, _sender);
emit BatchDepositERC721(_token, _l2Token, _sender, _to, _tokenIds);
}
}