Skip to content

Commit a0242d3

Browse files
zimphazimpha
authored
feat(contracts): 4844 support (#1179)
1 parent 61c10c4 commit a0242d3

File tree

203 files changed

+3859
-2303
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

203 files changed

+3859
-2303
lines changed

‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v18.15.0

‎docs/apis/L1ERC1155Gateway.md

+34-34
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Initialize the storage of L1ERC1155Gateway.
162162
| Name | Type | Description |
163163
|---|---|---|
164164
| _counterpart | address | The address of L2ERC1155Gateway in L2. |
165-
| _messenger | address | The address of L1ScrollMessenger. |
165+
| _messenger | address | The address of L1ScrollMessenger in L1. |
166166

167167
### messenger
168168

@@ -389,12 +389,12 @@ Emitted when the ERC1155 NFT is batch deposited to gateway on layer 1.
389389

390390
| Name | Type | Description |
391391
|---|---|---|
392-
| _l1Token `indexed` | address | undefined |
393-
| _l2Token `indexed` | address | undefined |
394-
| _from `indexed` | address | undefined |
395-
| _to | address | undefined |
396-
| _tokenIds | uint256[] | undefined |
397-
| _amounts | uint256[] | undefined |
392+
| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
393+
| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
394+
| _from `indexed` | address | The address of sender on layer 1. |
395+
| _to | address | The address of recipient on layer 2. |
396+
| _tokenIds | uint256[] | The list of token ids of the ERC1155 NFT to deposit on layer 1. |
397+
| _amounts | uint256[] | The list of corresponding number of token to deposit on layer 1. |
398398

399399
### BatchRefundERC1155
400400

@@ -410,10 +410,10 @@ Emitted when some ERC1155 token is refunded.
410410

411411
| Name | Type | Description |
412412
|---|---|---|
413-
| token `indexed` | address | undefined |
414-
| recipient `indexed` | address | undefined |
415-
| tokenIds | uint256[] | undefined |
416-
| amounts | uint256[] | undefined |
413+
| token `indexed` | address | The address of the token in L1. |
414+
| recipient `indexed` | address | The address of receiver in L1. |
415+
| tokenIds | uint256[] | The list of ids of token refunded. |
416+
| amounts | uint256[] | The list of amount of token refunded. |
417417

418418
### DepositERC1155
419419

@@ -429,12 +429,12 @@ Emitted when the ERC1155 NFT is deposited to gateway on layer 1.
429429

430430
| Name | Type | Description |
431431
|---|---|---|
432-
| _l1Token `indexed` | address | undefined |
433-
| _l2Token `indexed` | address | undefined |
434-
| _from `indexed` | address | undefined |
435-
| _to | address | undefined |
436-
| _tokenId | uint256 | undefined |
437-
| _amount | uint256 | undefined |
432+
| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
433+
| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
434+
| _from `indexed` | address | The address of sender on layer 1. |
435+
| _to | address | The address of recipient on layer 2. |
436+
| _tokenId | uint256 | The token id of the ERC1155 NFT to deposit on layer 1. |
437+
| _amount | uint256 | The number of token to deposit on layer 1. |
438438

439439
### FinalizeBatchWithdrawERC1155
440440

@@ -450,12 +450,12 @@ Emitted when the ERC1155 NFT is batch transferred to recipient on layer 1.
450450

451451
| Name | Type | Description |
452452
|---|---|---|
453-
| _l1Token `indexed` | address | undefined |
454-
| _l2Token `indexed` | address | undefined |
455-
| _from `indexed` | address | undefined |
456-
| _to | address | undefined |
457-
| _tokenIds | uint256[] | undefined |
458-
| _amounts | uint256[] | undefined |
453+
| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
454+
| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
455+
| _from `indexed` | address | The address of sender on layer 2. |
456+
| _to | address | The address of recipient on layer 1. |
457+
| _tokenIds | uint256[] | The list of token ids of the ERC1155 NFT to withdraw from layer 2. |
458+
| _amounts | uint256[] | The list of corresponding number of token to withdraw from layer 2. |
459459

460460
### FinalizeWithdrawERC1155
461461

@@ -471,12 +471,12 @@ Emitted when the ERC1155 NFT is transferred to recipient on layer 1.
471471

472472
| Name | Type | Description |
473473
|---|---|---|
474-
| _l1Token `indexed` | address | undefined |
475-
| _l2Token `indexed` | address | undefined |
476-
| _from `indexed` | address | undefined |
477-
| _to | address | undefined |
478-
| _tokenId | uint256 | undefined |
479-
| _amount | uint256 | undefined |
474+
| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
475+
| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
476+
| _from `indexed` | address | The address of sender on layer 2. |
477+
| _to | address | The address of recipient on layer 1. |
478+
| _tokenId | uint256 | The token id of the ERC1155 NFT to withdraw from layer 2. |
479+
| _amount | uint256 | The number of token to withdraw from layer 2. |
480480

481481
### Initialized
482482

@@ -486,7 +486,7 @@ event Initialized(uint8 version)
486486

487487

488488

489-
489+
*Triggered when the contract has been initialized or reinitialized.*
490490

491491
#### Parameters
492492

@@ -525,10 +525,10 @@ Emitted when some ERC1155 token is refunded.
525525

526526
| Name | Type | Description |
527527
|---|---|---|
528-
| token `indexed` | address | undefined |
529-
| recipient `indexed` | address | undefined |
530-
| tokenId | uint256 | undefined |
531-
| amount | uint256 | undefined |
528+
| token `indexed` | address | The address of the token in L1. |
529+
| recipient `indexed` | address | The address of receiver in L1. |
530+
| tokenId | uint256 | The id of token refunded. |
531+
| amount | uint256 | The amount of token refunded. |
532532

533533
### UpdateTokenMapping
534534

‎docs/apis/L1ERC721Gateway.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Initialize the storage of L1ERC721Gateway.
156156
| Name | Type | Description |
157157
|---|---|---|
158158
| _counterpart | address | The address of L2ERC721Gateway in L2. |
159-
| _messenger | address | The address of L1ScrollMessenger. |
159+
| _messenger | address | The address of L1ScrollMessenger in L1. |
160160

161161
### messenger
162162

@@ -334,11 +334,11 @@ Emitted when the ERC721 NFT is batch deposited to gateway on layer 1.
334334

335335
| Name | Type | Description |
336336
|---|---|---|
337-
| _l1Token `indexed` | address | undefined |
338-
| _l2Token `indexed` | address | undefined |
339-
| _from `indexed` | address | undefined |
340-
| _to | address | undefined |
341-
| _tokenIds | uint256[] | undefined |
337+
| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
338+
| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
339+
| _from `indexed` | address | The address of sender on layer 1. |
340+
| _to | address | The address of recipient on layer 2. |
341+
| _tokenIds | uint256[] | The list of token ids of the ERC721 NFT to deposit on layer 1. |
342342

343343
### BatchRefundERC721
344344

@@ -354,9 +354,9 @@ Emitted when a batch of ERC721 tokens are refunded.
354354

355355
| Name | Type | Description |
356356
|---|---|---|
357-
| token `indexed` | address | undefined |
358-
| recipient `indexed` | address | undefined |
359-
| tokenIds | uint256[] | undefined |
357+
| token `indexed` | address | The address of the token in L1. |
358+
| recipient `indexed` | address | The address of receiver in L1. |
359+
| tokenIds | uint256[] | The list of token ids of the ERC721 NFT refunded. |
360360

361361
### DepositERC721
362362

@@ -372,11 +372,11 @@ Emitted when the ERC721 NFT is deposited to gateway on layer 1.
372372

373373
| Name | Type | Description |
374374
|---|---|---|
375-
| _l1Token `indexed` | address | undefined |
376-
| _l2Token `indexed` | address | undefined |
377-
| _from `indexed` | address | undefined |
378-
| _to | address | undefined |
379-
| _tokenId | uint256 | undefined |
375+
| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
376+
| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
377+
| _from `indexed` | address | The address of sender on layer 1. |
378+
| _to | address | The address of recipient on layer 2. |
379+
| _tokenId | uint256 | The token id of the ERC721 NFT to deposit on layer 1. |
380380

381381
### FinalizeBatchWithdrawERC721
382382

@@ -392,11 +392,11 @@ Emitted when the ERC721 NFT is batch transferred to recipient on layer 1.
392392

393393
| Name | Type | Description |
394394
|---|---|---|
395-
| _l1Token `indexed` | address | undefined |
396-
| _l2Token `indexed` | address | undefined |
397-
| _from `indexed` | address | undefined |
398-
| _to | address | undefined |
399-
| _tokenIds | uint256[] | undefined |
395+
| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
396+
| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
397+
| _from `indexed` | address | The address of sender on layer 2. |
398+
| _to | address | The address of recipient on layer 1. |
399+
| _tokenIds | uint256[] | The list of token ids of the ERC721 NFT to withdraw from layer 2. |
400400

401401
### FinalizeWithdrawERC721
402402

@@ -412,11 +412,11 @@ Emitted when the ERC721 NFT is transferred to recipient on layer 1.
412412

413413
| Name | Type | Description |
414414
|---|---|---|
415-
| _l1Token `indexed` | address | undefined |
416-
| _l2Token `indexed` | address | undefined |
417-
| _from `indexed` | address | undefined |
418-
| _to | address | undefined |
419-
| _tokenId | uint256 | undefined |
415+
| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
416+
| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
417+
| _from `indexed` | address | The address of sender on layer 2. |
418+
| _to | address | The address of recipient on layer 1. |
419+
| _tokenId | uint256 | The token id of the ERC721 NFT to withdraw from layer 2. |
420420

421421
### Initialized
422422

@@ -426,7 +426,7 @@ event Initialized(uint8 version)
426426

427427

428428

429-
429+
*Triggered when the contract has been initialized or reinitialized.*
430430

431431
#### Parameters
432432

@@ -465,9 +465,9 @@ Emitted when some ERC721 token is refunded.
465465

466466
| Name | Type | Description |
467467
|---|---|---|
468-
| token `indexed` | address | undefined |
469-
| recipient `indexed` | address | undefined |
470-
| tokenId | uint256 | undefined |
468+
| token `indexed` | address | The address of the token in L1. |
469+
| recipient `indexed` | address | The address of receiver in L1. |
470+
| tokenId | uint256 | The id of token refunded. |
471471

472472
### UpdateTokenMapping
473473

0 commit comments

Comments
 (0)