feat(contracts): 4844 support (scroll-tech#1179)

jeswinsimon · Mar 22, 2024 · 8bd4277 · 8bd4277
1 parent 02415a6
commit 8bd4277
Show file tree

Hide file tree

Showing 208 changed files with 3,883 additions and 2,327 deletions.
diff --git a/.github/workflows/common.yml b/.github/workflows/common.yml
@@ -85,9 +85,9 @@ jobs:
     - name: Install Solc
       uses: supplypike/setup-bin@v3
       with:
-        uri: 'https://github.com/ethereum/solidity/releases/download/v0.8.16/solc-static-linux'
+        uri: 'https://github.com/ethereum/solidity/releases/download/v0.8.24/solc-static-linux'
         name: 'solc'
-        version: '0.8.16'
+        version: '0.8.24'
     - name: Install Geth Tools
       uses: gacts/install-geth-tools@v1
     - name: Build prerequisites

diff --git a/.github/workflows/contracts.yml b/.github/workflows/contracts.yml
@@ -43,10 +43,10 @@ jobs:
       - name: Setup LCOV
         uses: hrishikesh-kadam/setup-lcov@v1
 
-      - name: Install Node.js 14
+      - name: Install Node.js 18
         uses: actions/setup-node@v2
         with:
-          node-version: '14'
+          node-version: '18'
 
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
@@ -73,13 +73,13 @@ jobs:
         run: yarn install
 
       - name: Compile with foundry
-        run: forge build
+        run: forge build --evm-version cancun
 
       - name: Run foundry tests
-        run: forge test -vvv
+        run: forge test --evm-version cancun -vvv
 
       - name: Run foundry coverage
-        run : forge coverage --report lcov
+        run : forge coverage --evm-version cancun --report lcov
 
       - name : Prune coverage
         run : lcov --rc branch_coverage=1 --remove ./lcov.info -o ./lcov.info.pruned 'src/mocks/*' 'src/test/*' 'scripts/*' 'node_modules/*' 'lib/*'
@@ -102,10 +102,10 @@ jobs:
         with:
           submodules: recursive
 
-      - name: Install Node.js 14
+      - name: Install Node.js 18
         uses: actions/setup-node@v2
         with:
-          node-version: '14'
+          node-version: '18'
 
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path

diff --git a/.github/workflows/coordinator.yml b/.github/workflows/coordinator.yml
@@ -101,9 +101,9 @@ jobs:
     - name: Install Solc
       uses: supplypike/setup-bin@v3
       with:
-        uri: 'https://github.com/ethereum/solidity/releases/download/v0.8.16/solc-static-linux'
+        uri: 'https://github.com/ethereum/solidity/releases/download/v0.8.24/solc-static-linux'
         name: 'solc'
-        version: '0.8.16'
+        version: '0.8.24'
     - name: Install Geth Tools
       uses: gacts/install-geth-tools@v1
     - name: Build prerequisites

diff --git a/.github/workflows/database.yml b/.github/workflows/database.yml
@@ -78,9 +78,9 @@ jobs:
     - name: Install Solc
       uses: supplypike/setup-bin@v3
       with:
-        uri: 'https://github.com/ethereum/solidity/releases/download/v0.8.16/solc-static-linux'
+        uri: 'https://github.com/ethereum/solidity/releases/download/v0.8.24/solc-static-linux'
         name: 'solc'
-        version: '0.8.16'
+        version: '0.8.24'
     - name: Install Geth Tools
       uses: gacts/install-geth-tools@v1
     - name: Build prerequisites

diff --git a/contracts/.nvmrc b/contracts/.nvmrc
@@ -0,0 +1 @@
+v18.15.0
diff --git a/contracts/docs/apis/L1ERC1155Gateway.md b/contracts/docs/apis/L1ERC1155Gateway.md
@@ -162,7 +162,7 @@ Initialize the storage of L1ERC1155Gateway.
 | Name | Type | Description |
 |---|---|---|
 | _counterpart | address | The address of L2ERC1155Gateway in L2. |
-| _messenger | address | The address of L1ScrollMessenger. |
+| _messenger | address | The address of L1ScrollMessenger in L1. |
 
 ### messenger
 
@@ -389,12 +389,12 @@ Emitted when the ERC1155 NFT is batch deposited to gateway on layer 1.
 
 | Name | Type | Description |
 |---|---|---|
-| _l1Token `indexed` | address | undefined |
-| _l2Token `indexed` | address | undefined |
-| _from `indexed` | address | undefined |
-| _to  | address | undefined |
-| _tokenIds  | uint256[] | undefined |
-| _amounts  | uint256[] | undefined |
+| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 1. |
+| _to  | address | The address of recipient on layer 2. |
+| _tokenIds  | uint256[] | The list of token ids of the ERC1155 NFT to deposit on layer 1. |
+| _amounts  | uint256[] | The list of corresponding number of token to deposit on layer 1. |
 
 ### BatchRefundERC1155
 
@@ -410,10 +410,10 @@ Emitted when some ERC1155 token is refunded.
 
 | Name | Type | Description |
 |---|---|---|
-| token `indexed` | address | undefined |
-| recipient `indexed` | address | undefined |
-| tokenIds  | uint256[] | undefined |
-| amounts  | uint256[] | undefined |
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| tokenIds  | uint256[] | The list of ids of token refunded. |
+| amounts  | uint256[] | The list of amount of token refunded. |
 
 ### DepositERC1155
 
@@ -429,12 +429,12 @@ Emitted when the ERC1155 NFT is deposited to gateway on layer 1.
 
 | Name | Type | Description |
 |---|---|---|
-| _l1Token `indexed` | address | undefined |
-| _l2Token `indexed` | address | undefined |
-| _from `indexed` | address | undefined |
-| _to  | address | undefined |
-| _tokenId  | uint256 | undefined |
-| _amount  | uint256 | undefined |
+| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 1. |
+| _to  | address | The address of recipient on layer 2. |
+| _tokenId  | uint256 | The token id of the ERC1155 NFT to deposit on layer 1. |
+| _amount  | uint256 | The number of token to deposit on layer 1. |
 
 ### FinalizeBatchWithdrawERC1155
 
@@ -450,12 +450,12 @@ Emitted when the ERC1155 NFT is batch transferred to recipient on layer 1.
 
 | Name | Type | Description |
 |---|---|---|
-| _l1Token `indexed` | address | undefined |
-| _l2Token `indexed` | address | undefined |
-| _from `indexed` | address | undefined |
-| _to  | address | undefined |
-| _tokenIds  | uint256[] | undefined |
-| _amounts  | uint256[] | undefined |
+| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 2. |
+| _to  | address | The address of recipient on layer 1. |
+| _tokenIds  | uint256[] | The list of token ids of the ERC1155 NFT to withdraw from layer 2. |
+| _amounts  | uint256[] | The list of corresponding number of token to withdraw from layer 2. |
 
 ### FinalizeWithdrawERC1155
 
@@ -471,12 +471,12 @@ Emitted when the ERC1155 NFT is transferred to recipient on layer 1.
 
 | Name | Type | Description |
 |---|---|---|
-| _l1Token `indexed` | address | undefined |
-| _l2Token `indexed` | address | undefined |
-| _from `indexed` | address | undefined |
-| _to  | address | undefined |
-| _tokenId  | uint256 | undefined |
-| _amount  | uint256 | undefined |
+| _l1Token `indexed` | address | The address of ERC1155 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC1155 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 2. |
+| _to  | address | The address of recipient on layer 1. |
+| _tokenId  | uint256 | The token id of the ERC1155 NFT to withdraw from layer 2. |
+| _amount  | uint256 | The number of token to withdraw from layer 2. |
 
 ### Initialized
 
@@ -486,7 +486,7 @@ event Initialized(uint8 version)
 
 
 
-
+*Triggered when the contract has been initialized or reinitialized.*
 
 #### Parameters
 
@@ -525,10 +525,10 @@ Emitted when some ERC1155 token is refunded.
 
 | Name | Type | Description |
 |---|---|---|
-| token `indexed` | address | undefined |
-| recipient `indexed` | address | undefined |
-| tokenId  | uint256 | undefined |
-| amount  | uint256 | undefined |
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| tokenId  | uint256 | The id of token refunded. |
+| amount  | uint256 | The amount of token refunded. |
 
 ### UpdateTokenMapping
 

diff --git a/contracts/docs/apis/L1ERC721Gateway.md b/contracts/docs/apis/L1ERC721Gateway.md
@@ -156,7 +156,7 @@ Initialize the storage of L1ERC721Gateway.
 | Name | Type | Description |
 |---|---|---|
 | _counterpart | address | The address of L2ERC721Gateway in L2. |
-| _messenger | address | The address of L1ScrollMessenger. |
+| _messenger | address | The address of L1ScrollMessenger in L1. |
 
 ### messenger
 
@@ -334,11 +334,11 @@ Emitted when the ERC721 NFT is batch deposited to gateway on layer 1.
 
 | Name | Type | Description |
 |---|---|---|
-| _l1Token `indexed` | address | undefined |
-| _l2Token `indexed` | address | undefined |
-| _from `indexed` | address | undefined |
-| _to  | address | undefined |
-| _tokenIds  | uint256[] | undefined |
+| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 1. |
+| _to  | address | The address of recipient on layer 2. |
+| _tokenIds  | uint256[] | The list of token ids of the ERC721 NFT to deposit on layer 1. |
 
 ### BatchRefundERC721
 
@@ -354,9 +354,9 @@ Emitted when a batch of ERC721 tokens are refunded.
 
 | Name | Type | Description |
 |---|---|---|
-| token `indexed` | address | undefined |
-| recipient `indexed` | address | undefined |
-| tokenIds  | uint256[] | undefined |
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| tokenIds  | uint256[] | The list of token ids of the ERC721 NFT refunded. |
 
 ### DepositERC721
 
@@ -372,11 +372,11 @@ Emitted when the ERC721 NFT is deposited to gateway on layer 1.
 
 | Name | Type | Description |
 |---|---|---|
-| _l1Token `indexed` | address | undefined |
-| _l2Token `indexed` | address | undefined |
-| _from `indexed` | address | undefined |
-| _to  | address | undefined |
-| _tokenId  | uint256 | undefined |
+| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 1. |
+| _to  | address | The address of recipient on layer 2. |
+| _tokenId  | uint256 | The token id of the ERC721 NFT to deposit on layer 1. |
 
 ### FinalizeBatchWithdrawERC721
 
@@ -392,11 +392,11 @@ Emitted when the ERC721 NFT is batch transferred to recipient on layer 1.
 
 | Name | Type | Description |
 |---|---|---|
-| _l1Token `indexed` | address | undefined |
-| _l2Token `indexed` | address | undefined |
-| _from `indexed` | address | undefined |
-| _to  | address | undefined |
-| _tokenIds  | uint256[] | undefined |
+| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 2. |
+| _to  | address | The address of recipient on layer 1. |
+| _tokenIds  | uint256[] | The list of token ids of the ERC721 NFT to withdraw from layer 2. |
 
 ### FinalizeWithdrawERC721
 
@@ -412,11 +412,11 @@ Emitted when the ERC721 NFT is transferred to recipient on layer 1.
 
 | Name | Type | Description |
 |---|---|---|
-| _l1Token `indexed` | address | undefined |
-| _l2Token `indexed` | address | undefined |
-| _from `indexed` | address | undefined |
-| _to  | address | undefined |
-| _tokenId  | uint256 | undefined |
+| _l1Token `indexed` | address | The address of ERC721 NFT on layer 1. |
+| _l2Token `indexed` | address | The address of ERC721 NFT on layer 2. |
+| _from `indexed` | address | The address of sender on layer 2. |
+| _to  | address | The address of recipient on layer 1. |
+| _tokenId  | uint256 | The token id of the ERC721 NFT to withdraw from layer 2. |
 
 ### Initialized
 
@@ -426,7 +426,7 @@ event Initialized(uint8 version)
 
 
 
-
+*Triggered when the contract has been initialized or reinitialized.*
 
 #### Parameters
 
@@ -465,9 +465,9 @@ Emitted when some ERC721 token is refunded.
 
 | Name | Type | Description |
 |---|---|---|
-| token `indexed` | address | undefined |
-| recipient `indexed` | address | undefined |
-| tokenId  | uint256 | undefined |
+| token `indexed` | address | The address of the token in L1. |
+| recipient `indexed` | address | The address of receiver in L1. |
+| tokenId  | uint256 | The id of token refunded. |
 
 ### UpdateTokenMapping