diff --git a/.github/workflows/l1-contracts-ci.yaml b/.github/workflows/l1-contracts-ci.yaml index 120e37f28..fe3c28379 100644 --- a/.github/workflows/l1-contracts-ci.yaml +++ b/.github/workflows/l1-contracts-ci.yaml @@ -25,23 +25,33 @@ jobs: - name: Install dependencies run: yarn - - name: Build artifacts - run: yarn l1 build + - name: Install l2 deps + working-directory: ./l2-contracts + run: yarn + + - name: Install l1 deps + working-directory: ./l1-contracts + run: yarn - - name: Build L2 artifacts + - name: Build l2 artifacts run: yarn l2 build + - name: Build l1 artifacts + run: yarn l1 build + - name: Create cache uses: actions/cache/save@v3 with: key: artifacts-l1-${{ github.sha }} path: | l1-contracts/artifacts + l1-contracts/artifacts-zk l1-contracts/cache l1-contracts/typechain l2-contracts/artifacts-zk l2-contracts/cache-zk l2-contracts/typechain + l1-contracts/lib lint: runs-on: ubuntu-latest @@ -91,11 +101,68 @@ jobs: key: artifacts-l1-${{ github.sha }} path: | l1-contracts/artifacts + l1-contracts/artifacts-zk + l1-contracts/cache + l1-contracts/typechain + l2-contracts/artifacts-zk + l2-contracts/cache-zk + l2-contracts/typechain + l1-contracts/lib + + - name: Run tests + working-directory: ./l1-contracts + run: FOUNDRY_PROFILE=default yarn test:foundry + + test-foundry-zksync: + needs: [build, lint] + runs-on: ubuntu-latest + + steps: + - name: Checkout the repository + uses: actions/checkout@v4 + with: + submodules: recursive + + - name: Use Node.js + uses: actions/setup-node@v3 + with: + node-version: 18.18.0 + cache: yarn + + - name: Install dependencies + run: yarn + + - name: Build system contract artifacts + run: yarn sc build + + - name: Restore artifacts cache + uses: actions/cache/restore@v3 + with: + fail-on-cache-miss: true + key: artifacts-l1-${{ github.sha }} + path: | + l1-contracts/artifacts + l1-contracts/artifacts-zk l1-contracts/cache l1-contracts/typechain + l2-contracts/artifacts-zk + l2-contracts/cache-zk + l2-contracts/typechain + l1-contracts/lib + + - name: Install foundry zksync + run: | + wget https://github.com/matter-labs/foundry-zksync/releases/download/nightly-f908ce43834bc1ffb4de6576ea5600eaab49dddb/foundry_nightly_linux_amd64.tar.gz -O foundry-zksync.tar.gz + tar -xzf foundry-zksync.tar.gz + sudo mv forge /usr/local/bin/forge + sudo mv cast /usr/local/bin/cast + sudo chmod +x /usr/local/bin/forge + sudo chmod +x /usr/local/bin/cast + forge --version - name: Run tests - run: yarn l1 test:foundry + working-directory: ./l1-contracts + run: FOUNDRY_PROFILE=default yarn test:zkfoundry test-hardhat: needs: [build, lint] @@ -114,6 +181,10 @@ jobs: - name: Install dependencies run: yarn + - name: Install l1 deps + working-directory: ./l1-contracts + run: yarn + - name: Restore artifacts cache uses: actions/cache/restore@v3 with: @@ -121,16 +192,21 @@ jobs: key: artifacts-l1-${{ github.sha }} path: | l1-contracts/artifacts + l1-contracts/artifacts-zk l1-contracts/cache l1-contracts/typechain l2-contracts/artifacts-zk l2-contracts/cache-zk l2-contracts/typechain + l1-contracts/lib + + - name: Build L2 contracts + run: yarn l2 build - name: Run tests run: yarn l1 test --no-compile - check-verifier-generator: + check-verifier-generator-l1: runs-on: ubuntu-latest steps: @@ -183,8 +259,13 @@ jobs: key: artifacts-l1-${{ github.sha }} path: | l1-contracts/artifacts + l1-contracts/artifacts-zk l1-contracts/cache l1-contracts/typechain + l2-contracts/artifacts-zk + l2-contracts/cache-zk + l2-contracts/typechain + l1-contracts/lib - name: Run coverage run: FOUNDRY_PROFILE=default yarn test:foundry && FOUNDRY_PROFILE=default yarn coverage:foundry --report summary --report lcov diff --git a/.github/workflows/l1-contracts-foundry-ci.yaml b/.github/workflows/l1-contracts-foundry-ci.yaml new file mode 100644 index 000000000..5205d092c --- /dev/null +++ b/.github/workflows/l1-contracts-foundry-ci.yaml @@ -0,0 +1,129 @@ +name: L1 contracts foundry CI + +env: + ANVIL_PRIVATE_KEY: "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80" + ANVIL_RPC_URL: "http://127.0.0.1:8545" + +on: + pull_request: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout the repository + uses: actions/checkout@v4 + with: + submodules: true + + - name: Use Foundry + uses: foundry-rs/foundry-toolchain@v1 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: 18.18.0 + cache: yarn + + - name: Install dependencies + run: yarn + + - name: Build hardhat artifacts + run: yarn l1 build + + - name: Build artifacts + working-directory: ./l1-contracts + run: forge build + + - name: Build system-contract artifacts + run: yarn sc build + + - name: Build l2 artifacts + run: yarn l2 build + + - name: Create cache + uses: actions/cache/save@v3 + with: + key: artifacts-l1-contracts-foudry-${{ github.sha }} + path: | + l1-contracts/cache + l1-contracts/out + l1-contracts/artifacts-zk + l2-contracts/artifacts-zk + l2-contracts/cache-zk + system-contracts/artifacts-zk + system-contracts/bootloader/build + system-contracts/cache-zk + system-contracts/contracts-preprocessed + system-contracts/typechain + + scripts: + runs-on: ubuntu-latest + needs: build + steps: + - name: Checkout the repository + uses: actions/checkout@v4 + with: + submodules: true + + - name: Restore artifacts cache + uses: actions/cache/restore@v3 + with: + fail-on-cache-miss: true + key: artifacts-l1-contracts-foudry-${{ github.sha }} + path: | + l1-contracts/cache + l1-contracts/out + l1-contracts/artifacts-zk + l2-contracts/artifacts-zk + l2-contracts/cache-zk + system-contracts/artifacts-zk + system-contracts/bootloader/build + system-contracts/cache-zk + system-contracts/contracts-preprocessed + system-contracts/typechain + + - name: Use Foundry + uses: foundry-rs/foundry-toolchain@v1 + + - name: Copy configs from template + working-directory: ./l1-contracts + run: cp -r deploy-script-config-template/. script-config + + - name: Run anvil + run: | + anvil --silent & + + ANVIL_READY=0 + for i in {1..10}; do + if curl -s -o /dev/null $ANVIL_RPC_URL -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","method":"eth_chainId","id":1}'; then + echo "Anvil is ready" + ANVIL_READY=1 + break + else + echo "Waiting for Anvil to become ready..." + sleep 1 + fi + done + + if [ $ANVIL_READY -ne 1 ]; then + echo "Anvil failed to become ready after 10 attempts." + exit 1 + fi + + - name: Run DeployL1 script + working-directory: ./l1-contracts + run: forge script ./deploy-scripts/DeployL1.s.sol --ffi --rpc-url $ANVIL_RPC_URL --broadcast --private-key $ANVIL_PRIVATE_KEY + + - name: Run DeployErc20 script + working-directory: ./l1-contracts + run: forge script ./deploy-scripts/DeployErc20.s.sol --ffi --rpc-url $ANVIL_RPC_URL --broadcast --private-key $ANVIL_PRIVATE_KEY +# TODO restore scripts verification +# - name: Run RegisterZKChain script +# working-directory: ./l1-contracts +# run: | +# cat ./script-out/output-deploy-l1.toml >> ./script-config/register-zk-chain.toml +# forge script ./deploy-scripts/RegisterZKChain.s.sol --ffi --rpc-url $ANVIL_RPC_URL --broadcast --private-key $ANVIL_PRIVATE_KEY +# - name: Run InitializeL2WethToken script +# working-directory: ./l1-contracts-foundry +# run: forge script ./deploy-scripts/InitializeL2WethToken.s.sol --ffi --rpc-url $ANVIL_RPC_URL --broadcast --private-key $ANVIL_PRIVATE_KEY diff --git a/.github/workflows/l2-contracts-ci.yaml b/.github/workflows/l2-contracts-ci.yaml index 4b8fbcb12..e7e4b9541 100644 --- a/.github/workflows/l2-contracts-ci.yaml +++ b/.github/workflows/l2-contracts-ci.yaml @@ -26,6 +26,9 @@ jobs: - name: Build L2 artifacts run: yarn l2 build + - name: Build system contract artifacts + run: yarn sc build + - name: Create cache uses: actions/cache/save@v3 with: @@ -37,6 +40,9 @@ jobs: l2-contracts/artifacts-zk l2-contracts/cache-zk l2-contracts/typechain + system-contracts/artifacts-zk + system-contracts/cache-zk + system-contracts/typechain lint: runs-on: ubuntu-latest @@ -57,6 +63,23 @@ jobs: - name: Lint run: yarn lint:check + check-verifier-generator-l2: + needs: [build] + runs-on: ubuntu-latest + + steps: + - name: Checkout the repository + uses: actions/checkout@v4 + with: + submodules: recursive + + - name: Generate Verifier.sol + working-directory: tools + run: cargo run --bin zksync_verifier_contract_generator --release -- --input_path data/scheduler_key.json --l2_mode + + - name: Compare + run: diff tools/data/Verifier.sol l2-contracts/contracts/verifier/Verifier.sol + test: needs: [build, lint] runs-on: ubuntu-latest @@ -88,12 +111,19 @@ jobs: l2-contracts/artifacts-zk l2-contracts/cache-zk l2-contracts/typechain - - - name: Run Era test node - uses: dutterbutter/era-test-node-action@v0.1.3 - - - name: Copy typechain from System Contracts - run: yarn sc build && yarn sc copy:typechain + system-contracts/artifacts-zk + system-contracts/cache-zk + system-contracts/typechain + + - name: Install foundry zksync + run: | + wget https://github.com/matter-labs/foundry-zksync/releases/download/nightly-f908ce43834bc1ffb4de6576ea5600eaab49dddb/foundry_nightly_linux_amd64.tar.gz -O foundry-zksync.tar.gz + tar -xzf foundry-zksync.tar.gz + sudo mv forge /usr/local/bin/forge + sudo mv cast /usr/local/bin/cast + sudo chmod +x /usr/local/bin/forge + sudo chmod +x /usr/local/bin/cast + forge --version - name: Run tests - run: yarn l2 test + run: yarn l2 test:foundry diff --git a/.gitignore b/.gitignore index 58c92d50f..780fb4e9d 100644 --- a/.gitignore +++ b/.gitignore @@ -22,10 +22,13 @@ l1-contracts/lcov.info l1-contracts/report/* l1-contracts/coverage/* l1-contracts/out/* +l1-contracts/zkout/* l1-contracts/broadcast/* l1-contracts/script-config/* !l1-contracts/script-config/artifacts l1-contracts/script-out/* -l1-contracts/test/foundry/integration/deploy-scripts/script-out/*.toml +l1-contracts/test/foundry/l1/integration/deploy-scripts/script-out/*.toml !l1-contracts/script-out/.gitkeep *.timestamp +l1-contracts/test/foundry/l1/integration/deploy-scripts/script-out/* +l1-contracts/zkout/* diff --git a/.gitmodules b/.gitmodules index 3451bd884..f94071e53 100644 --- a/.gitmodules +++ b/.gitmodules @@ -12,3 +12,6 @@ [submodule "lib/forge-std"] path = lib/forge-std url = https://github.com/foundry-rs/forge-std +[submodule "lib/@matterlabs/zksync-contracts"] + path = lib/@matterlabs/zksync-contracts + url = https://github.com/matter-labs/v2-testnet-contracts diff --git a/.solhintignore b/.solhintignore index abcb64f98..81b96357a 100644 --- a/.solhintignore +++ b/.solhintignore @@ -8,6 +8,7 @@ l1-contracts/lib l1-contracts/node_modules l1-contracts/contracts/dev-contracts l1-contracts/test +l1-contracts/deploy-scripts # l1-contracts-foundry l1-contracts-foundry/cache @@ -16,6 +17,7 @@ l1-contracts-foundry/lib # l2-contracts l2-contracts/cache-zk l2-contracts/node_modules +l2-contracts/test # system-contracts system-contracts/contracts/openzeppelin diff --git a/da-contracts/contracts/CalldataDA.sol b/da-contracts/contracts/CalldataDA.sol index 6a2f0f5a0..ffb666f5f 100644 --- a/da-contracts/contracts/CalldataDA.sol +++ b/da-contracts/contracts/CalldataDA.sol @@ -4,17 +4,21 @@ pragma solidity 0.8.24; // solhint-disable gas-custom-errors, reason-string -import {BLOB_SIZE_BYTES} from "./DAUtils.sol"; +/// @dev Total number of bytes in a blob. Blob = 4096 field elements * 31 bytes per field element +/// @dev EIP-4844 defines it as 131_072 but we use 4096 * 31 within our circuits to always fit within a field element +/// @dev Our circuits will prove that a EIP-4844 blob and our internal blob are the same. +uint256 constant BLOB_SIZE_BYTES = 126_976; -uint256 constant BLOBS_SUPPORTED = 6; - -// the state diff hash, hash of pubdata + the number of blobs. +/// @dev The state diff hash, hash of pubdata + the number of blobs. uint256 constant BLOB_DATA_OFFSET = 65; -/// @notice Contract that contains the functionality for processing the calldata DA. +/// @dev The size of the commitment for a single blob. +uint256 constant BLOB_COMMITMENT_SIZE = 32; + +/// @notice Contract that contains the functionality for process the calldata DA. /// @dev The expected l2DAValidator that should be used with it `RollupL2DAValidator`. abstract contract CalldataDA { - /// @notice Parses the input that the l2 DA validator has provided to the contract. + /// @notice Parses the input that the L2 DA validator has provided to the contract. /// @param _l2DAValidatorOutputHash The hash of the output of the L2 DA validator. /// @param _maxBlobsSupported The maximal number of blobs supported by the chain. /// @param _operatorDAInput The DA input by the operator provided on L1. @@ -54,12 +58,7 @@ abstract contract CalldataDA { require(_operatorDAInput.length >= BLOB_DATA_OFFSET + 32 * blobsProvided, "invalid blobs hashes"); - assembly { - // The pointer to the allocated memory above. We skip 32 bytes to avoid overwriting the length. - let blobsPtr := add(blobsLinearHashes, 0x20) - let inputPtr := add(_operatorDAInput.offset, BLOB_DATA_OFFSET) - calldatacopy(blobsPtr, inputPtr, mul(blobsProvided, 32)) - } + _cloneCalldata(blobsLinearHashes, _operatorDAInput[BLOB_DATA_OFFSET:], blobsProvided); uint256 ptr = BLOB_DATA_OFFSET + 32 * blobsProvided; @@ -81,19 +80,32 @@ abstract contract CalldataDA { bytes32 _fullPubdataHash, uint256 _maxBlobsSupported, bytes calldata _pubdataInput - ) internal pure returns (bytes32[] memory blobCommitments, bytes calldata _pubdata) { + ) internal pure virtual returns (bytes32[] memory blobCommitments, bytes calldata _pubdata) { require(_blobsProvided == 1, "one blob with calldata"); + require(_pubdataInput.length >= BLOB_COMMITMENT_SIZE, "pubdata too small"); // We typically do not know whether we'll use calldata or blobs at the time when // we start proving the batch. That's why the blob commitment for a single blob is still present in the case of calldata. blobCommitments = new bytes32[](_maxBlobsSupported); - _pubdata = _pubdataInput[:_pubdataInput.length - 32]; + _pubdata = _pubdataInput[:_pubdataInput.length - BLOB_COMMITMENT_SIZE]; - // FIXME: allow larger lengths for Gateway-based chains. require(_pubdata.length <= BLOB_SIZE_BYTES, "cz"); require(_fullPubdataHash == keccak256(_pubdata), "wp"); - blobCommitments[0] = bytes32(_pubdataInput[_pubdataInput.length - 32:_pubdataInput.length]); + blobCommitments[0] = bytes32(_pubdataInput[_pubdataInput.length - BLOB_COMMITMENT_SIZE:_pubdataInput.length]); + } + + /// @notice Method that clones a slice of calldata into a bytes32[] memory array. + /// @param _dst The destination array. + /// @param _input The input calldata. + /// @param _len The length of the slice in 32-byte words to clone. + function _cloneCalldata(bytes32[] memory _dst, bytes calldata _input, uint256 _len) internal pure { + assembly { + // The pointer to the allocated memory above. We skip 32 bytes to avoid overwriting the length. + let dstPtr := add(_dst, 0x20) + let inputPtr := _input.offset + calldatacopy(dstPtr, inputPtr, mul(_len, 32)) + } } } diff --git a/da-contracts/contracts/DAContractsErrors.sol b/da-contracts/contracts/DAContractsErrors.sol new file mode 100644 index 000000000..2116d582d --- /dev/null +++ b/da-contracts/contracts/DAContractsErrors.sol @@ -0,0 +1,19 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.21; + +// 0x53dee67b +error PubdataCommitmentsEmpty(); +// 0x7734c31a +error PubdataCommitmentsTooBig(); +// 0x53e6d04d +error InvalidPubdataCommitmentsSize(); +// 0xafd53e2f +error BlobHashCommitmentError(uint256 index, bool blobHashEmpty, bool blobCommitmentEmpty); +// 0xfc7ab1d3 +error EmptyBlobVersionHash(uint256 index); +// 0x92290acc +error NonEmptyBlobVersionHash(uint256 index); +// 0x8d5851de +error PointEvalCallFailed(bytes); +// 0x4daa985d +error PointEvalFailed(bytes); diff --git a/da-contracts/contracts/IL1DAValidator.sol b/da-contracts/contracts/IL1DAValidator.sol index 3b4c339b8..c22e9c557 100644 --- a/da-contracts/contracts/IL1DAValidator.sol +++ b/da-contracts/contracts/IL1DAValidator.sol @@ -14,21 +14,22 @@ struct L1DAValidatorOutput { bytes32[] blobsOpeningCommitments; } -// TODO: require EIP165 support as this will allow changes for future compatibility. interface IL1DAValidator { /// @notice The function that checks the data availability for the given batch input. - /// @param chainId The chain id of the chain that is being committed. - /// @param l2DAValidatorOutputHash The hash of that was returned by the l2DAValidator. - /// @param operatorDAInput The DA input by the operator provided on L1. - /// @param maxBlobsSupported The maximal number of blobs supported by the chain. + /// @param _chainId The chain id of the chain that is being committed. + /// @param _chainId The batch number for which the data availability is being checked. + /// @param _l2DAValidatorOutputHash The hash of that was returned by the l2DAValidator. + /// @param _operatorDAInput The DA input by the operator provided on L1. + /// @param _maxBlobsSupported The maximal number of blobs supported by the chain. /// We provide this value for future compatibility. /// This is needed because the corresponding `blobsLinearHashes`/`blobsOpeningCommitments` /// in the `L1DAValidatorOutput` struct will have to have this length as it is required /// to be static by the circuits. function checkDA( - uint256 chainId, - bytes32 l2DAValidatorOutputHash, - bytes calldata operatorDAInput, - uint256 maxBlobsSupported + uint256 _chainId, + uint256 _batchNumber, + bytes32 _l2DAValidatorOutputHash, + bytes calldata _operatorDAInput, + uint256 _maxBlobsSupported ) external returns (L1DAValidatorOutput memory output); } diff --git a/da-contracts/contracts/RollupL1DAValidator.sol b/da-contracts/contracts/RollupL1DAValidator.sol index 37ea2e433..99a57a7c3 100644 --- a/da-contracts/contracts/RollupL1DAValidator.sol +++ b/da-contracts/contracts/RollupL1DAValidator.sol @@ -10,6 +10,8 @@ import {CalldataDA} from "./CalldataDA.sol"; import {PubdataSource, BLS_MODULUS, PUBDATA_COMMITMENT_SIZE, PUBDATA_COMMITMENT_CLAIMED_VALUE_OFFSET, PUBDATA_COMMITMENT_COMMITMENT_OFFSET, BLOB_DA_INPUT_SIZE, POINT_EVALUATION_PRECOMPILE_ADDR} from "./DAUtils.sol"; +import {PubdataCommitmentsEmpty, InvalidPubdataCommitmentsSize, BlobHashCommitmentError, EmptyBlobVersionHash, NonEmptyBlobVersionHash, PointEvalCallFailed, PointEvalFailed} from "./DAContractsErrors.sol"; + uint256 constant BLOBS_SUPPORTED = 6; contract RollupL1DAValidator is IL1DAValidator, CalldataDA { @@ -22,8 +24,12 @@ contract RollupL1DAValidator is IL1DAValidator, CalldataDA { /// `_pubdataCommitments` is a packed list of commitments of the following format: /// opening point (16 bytes) || claimed value (32 bytes) || commitment (48 bytes) || proof (48 bytes) function publishBlobs(bytes calldata _pubdataCommitments) external { - require(_pubdataCommitments.length > 0, "zln"); - require(_pubdataCommitments.length % PUBDATA_COMMITMENT_SIZE == 0, "bd"); + if (_pubdataCommitments.length == 0) { + revert PubdataCommitmentsEmpty(); + } + if (_pubdataCommitments.length % PUBDATA_COMMITMENT_SIZE != 0) { + revert InvalidPubdataCommitmentsSize(); + } uint256 versionedHashIndex = 0; // solhint-disable-next-line gas-length-in-loops @@ -40,6 +46,7 @@ contract RollupL1DAValidator is IL1DAValidator, CalldataDA { /// @inheritdoc IL1DAValidator function checkDA( uint256, // _chainId + uint256, // _batchNumber bytes32 _l2DAValidatorOutputHash, bytes calldata _operatorDAInput, uint256 _maxBlobsSupported @@ -67,11 +74,12 @@ contract RollupL1DAValidator is IL1DAValidator, CalldataDA { // or there are values for both. // This is mostly a sanity check and it is not strictly required. for (uint256 i = 0; i < _maxBlobsSupported; ++i) { - require( - (blobsLinearHashes[i] == bytes32(0) && blobCommitments[i] == bytes32(0)) || - (blobsLinearHashes[i] != bytes32(0) && blobCommitments[i] != bytes32(0)), - "bh" - ); + if ( + (blobsLinearHashes[i] == bytes32(0) && blobCommitments[i] != bytes32(0)) || + (blobsLinearHashes[i] != bytes32(0) && blobCommitments[i] == bytes32(0)) + ) { + revert BlobHashCommitmentError(i, blobsLinearHashes[i] == bytes32(0), blobCommitments[i] == bytes32(0)); + } } output.stateDiffHash = stateDiffHash; @@ -86,7 +94,9 @@ contract RollupL1DAValidator is IL1DAValidator, CalldataDA { function _getPublishedBlobCommitment(uint256 _index, bytes calldata _commitment) internal view returns (bytes32) { bytes32 blobVersionedHash = _getBlobVersionedHash(_index); - require(blobVersionedHash != bytes32(0), "vh"); + if (blobVersionedHash == bytes32(0)) { + revert EmptyBlobVersionHash(_index); + } // First 16 bytes is the opening point. While we get the point as 16 bytes, the point evaluation precompile // requires it to be 32 bytes. The blob commitment must use the opening point as 16 bytes though. @@ -119,7 +129,9 @@ contract RollupL1DAValidator is IL1DAValidator, CalldataDA { // 144 bytes for commitment data // 32 bytes for the prepublished commitment. If it is non-zero, it means that it is expected that // such commitment was published before. Otherwise, it is expected that it is published in this transaction - require(_operatorDAInput.length == _blobsProvided * BLOB_DA_INPUT_SIZE, "bd"); + if (_operatorDAInput.length != _blobsProvided * BLOB_DA_INPUT_SIZE) { + revert InvalidPubdataCommitmentsSize(); + } uint256 versionedHashIndex = 0; @@ -148,7 +160,9 @@ contract RollupL1DAValidator is IL1DAValidator, CalldataDA { // This check is required because we want to ensure that there aren't any extra blobs trying to be published. // Calling the BLOBHASH opcode with an index > # blobs - 1 yields bytes32(0) bytes32 versionedHash = _getBlobVersionedHash(versionedHashIndex); - require(versionedHash == bytes32(0), "lh"); + if (versionedHash != bytes32(0)) { + revert NonEmptyBlobVersionHash(versionedHashIndex); + } } /// @notice Calls the point evaluation precompile and verifies the output @@ -166,9 +180,13 @@ contract RollupL1DAValidator is IL1DAValidator, CalldataDA { // We verify that the point evaluation precompile call was successful by testing the latter 32 bytes of the // response is equal to BLS_MODULUS as defined in https://eips.ethereum.org/EIPS/eip-4844#point-evaluation-precompile - require(success, "failed to call point evaluation precompile"); + if (!success) { + revert PointEvalCallFailed(precompileInput); + } (, uint256 result) = abi.decode(data, (uint256, uint256)); - require(result == BLS_MODULUS, "precompile unexpected output"); + if (result != BLS_MODULUS) { + revert PointEvalFailed(abi.encode(result)); + } } function _getBlobVersionedHash(uint256 _index) internal view virtual returns (bytes32 versionedHash) { diff --git a/da-contracts/contracts/ValidiumL1DAValidator.sol b/da-contracts/contracts/ValidiumL1DAValidator.sol index f525e04b8..e163f8073 100644 --- a/da-contracts/contracts/ValidiumL1DAValidator.sol +++ b/da-contracts/contracts/ValidiumL1DAValidator.sol @@ -9,6 +9,7 @@ import {IL1DAValidator, L1DAValidatorOutput} from "./IL1DAValidator.sol"; contract ValidiumL1DAValidator is IL1DAValidator { function checkDA( uint256, // _chainId + uint256, // _batchNumber bytes32, // _l2DAValidatorOutputHash bytes calldata _operatorDAInput, uint256 // maxBlobsSupported @@ -22,8 +23,4 @@ contract ValidiumL1DAValidator is IL1DAValidator { // The rest of the fields that relate to blobs are empty. output.stateDiffHash = stateDiffHash; } - - function supportsInterface(bytes4 interfaceId) external pure returns (bool) { - return (interfaceId == this.supportsInterface.selector) || (interfaceId == type(IL1DAValidator).interfaceId); - } } diff --git a/docs/Overview.md b/docs/Overview.md index 4529a8dda..bcee716b2 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -157,7 +157,7 @@ this trick: #### L1 -> L2 Transaction filtering There is a mechanism for applying custom filters to the L1 -> L2 communication. It is achieved by having an address of -the `TransactionFilterer` contract in the `ZkSyncHyperchainStorage`. If the filterer exists, it is being called in +the `TransactionFilterer` contract in the `ZkSyncZKChainStorage`. If the filterer exists, it is being called in the `Mailbox` facet with the tx details and has to return whether the transaction can be executed or not. The filterer has to implement the `ITransactionFilterer` interface. The ones intended to use this feature, have to deploy the contract that implements `ITransactionFilterer` and use `setTransactionFilterer` function of `AdminFacet` to set the @@ -178,12 +178,12 @@ Each L2 -> L1 system log will have a key that is part of the following: ```solidity enum SystemLogKey { L2_TO_L1_LOGS_TREE_ROOT_KEY, - TOTAL_L2_TO_L1_PUBDATA_KEY, - STATE_DIFF_HASH_KEY, PACKED_BATCH_AND_L2_BLOCK_TIMESTAMP_KEY, PREV_BATCH_HASH_KEY, CHAINED_PRIORITY_TXN_HASH_KEY, NUMBER_OF_LAYER_1_TXS_KEY, + L2_DA_VALIDATOR_OUTPUT_HASH_KEY, + USED_L2_DA_VALIDATOR_ADDRESS_KEY, EXPECTED_SYSTEM_CONTRACT_UPGRADE_TX_HASH_KEY } ``` diff --git a/docs/gateway/chain-migration.md b/docs/gateway/chain-migration.md index e19276ec2..c638cc5c9 100644 --- a/docs/gateway/chain-migration.md +++ b/docs/gateway/chain-migration.md @@ -2,11 +2,11 @@ Chain migration uses the Custom Asset Bridging framework: -- STMs can be deployed on the Gateway. Each STM has its own assetId. -- The STM Deployment Tracker deployed on L1 registers assetId in the L1 and L2 AssetRouters, with the Bridgehub as the AssetHandler. It also registers the L1 and L2 STM contracts to be associated to the assetId in the Bridgehubs. -- Bridging of a chain happens via the Bridgehub, AssetRouters, and STM. +- CTMs can be deployed on the Gateway. Each CTM has its own assetId. +- The CTM Deployment Tracker deployed on L1 registers assetId in the L1 and L2 AssetRouters, with the Bridgehub as the AssetHandler. It also registers the L1 and L2 CTM contracts to be associated to the assetId in the Bridgehubs. +- Bridging of a chain happens via the Bridgehub, AssetRouters, and CTM. -![STM assetId registration](./chain-asset-id-registration.png) +![CTM assetId registration](./chain-asset-id-registration.png) _Note these are separate calls_ ![Chain migration](./chain-migration.png) diff --git a/docs/gateway/contracts-review-gateway.md b/docs/gateway/contracts-review-gateway.md index e4a34126c..5e14df72e 100644 --- a/docs/gateway/contracts-review-gateway.md +++ b/docs/gateway/contracts-review-gateway.md @@ -10,7 +10,7 @@ List of changes and new features: - Custom Data Availability contracts. This is needed to handle the relayed data availability on the Gateway. - L1 -> Gateway -> ZKChain transactions. This is done by forwarding transactions to Chain's Mailbox on the Gateway via the Gateway's Mailbox. - ZKChain -> Gateway -> L1 transactions. This is done by aggregating the logs of different chains in the MessageRoot contract, and sending a single log to L1. -- Migration of chains to and from the Gateway. This is done using our Custom Asset Bridging framework, each STM has an assetId and is managed by a shared STMDeploymentTracker, the L2AssetRouter = L2SharedBridge is deployed on the Gateway, but only holds the chains as assets, with the Bridgehub as the AssetHandler. +- Migration of chains to and from the Gateway. This is done using our Custom Asset Bridging framework, each CTM has an assetId and is managed by a shared CTMDeploymentTracker, the L2AssetRouter = L2SharedBridge is deployed on the Gateway, but only holds the chains as assets, with the Bridgehub as the AssetHandler. Other smaller changes: @@ -26,10 +26,10 @@ Known issues, and features that still need to be implemented: - Upgrade process, how do we upgrade to CAB bridge, to the new system contracts. - We had the syncLayer internal name previously for the Gateway. This has not been replaced everywhere yet. - permissions for some functions are not properly restricted yet, mostly they are missing a modifier. -- Bridgehub setAssetHandlerAddressInitial `address sender` might be an issue. +- Bridgehub setAssetHandlerAddress `address sender` might be an issue. - MessageRoot should be renamed to MessageRootAggregator -![Untitled](./Hyperchain-scheme.png) +![Untitled](./ZKChain-scheme.png) ## Initial Scope @@ -56,13 +56,13 @@ Known issues, and features that still need to be implemented: The majority of the rest of the changes. This makes the scope quite big, so please focus on the initial scope in more detail, and if you have time include the later scope. - MessageRoot.sol -- STMDeploymentTracker.sol +- CTMDeploymentTracker.sol - Bridgehub.sol - Config.sol - L2ContractAddresses.sol -- StateTransitionManager.sol +- ChainTypeManager.sol - ValidatorTimelock.sol - DiamondInit.sol -- ZkSyncHyperchainStorage.sol +- ZKChainStorage.sol - Admin.sol - L1GenesisUpgrade.sol diff --git a/gas-bound-caller/package.json b/gas-bound-caller/package.json index af91e7593..1b144a8ff 100644 --- a/gas-bound-caller/package.json +++ b/gas-bound-caller/package.json @@ -14,7 +14,8 @@ "ethers": "^5.7.0", "fast-glob": "^3.3.2", "hardhat": "=2.22.2", - "preprocess": "^3.2.0" + "preprocess": "^3.2.0", + "zksync-ethers": "^5.9.0" }, "devDependencies": { "@matterlabs/hardhat-zksync-chai-matchers": "^0.2.0", @@ -56,7 +57,7 @@ "test-node": "hardhat node-zksync --tag v0.0.1-vm1.5.0", "check-canonical-bytecode": "ts-node ./scripts/check-canonical-bytecode.ts", "verify": "hardhat run scripts/verify.ts", - "deploy-on-hyperchain": "ts-node ./scripts/deploy-on-hyperchain.ts", + "deploy-on-zk-chain": "ts-node ./scripts/deploy-on-zk-chain.ts", "deploy-on-localhost": "hardhat deploy --network localhost" } } diff --git a/gas-bound-caller/scripts/deploy-on-hyperchain.ts b/gas-bound-caller/scripts/deploy-on-hyperchain.ts index 35d013fd7..228524de4 100644 --- a/gas-bound-caller/scripts/deploy-on-hyperchain.ts +++ b/gas-bound-caller/scripts/deploy-on-hyperchain.ts @@ -44,8 +44,8 @@ async function main() { program .version("0.1.0") - .name("Deploy on hyperchain") - .description("Deploys the GasBoundCaller on a predetermined Hyperchain network") + .name("Deploy on ZK chain") + .description("Deploys the GasBoundCaller on a predetermined ZK chain network") .option("--private-key ") .option("--l2Rpc ") .action(async (cmd) => { diff --git a/l1-contracts/.env b/l1-contracts/.env index 325665949..25ec2b87f 100644 --- a/l1-contracts/.env +++ b/l1-contracts/.env @@ -24,8 +24,12 @@ CONTRACTS_TRANSPARENT_PROXY_ADMIN_ADDR=0x000000000000000000000000000000000000000 CONTRACTS_GOVERNANCE_ADDR=0x0000000000000000000000000000000000000000 CONTRACTS_L1_ERC20_BRIDGE_IMPL_ADDR=0x0000000000000000000000000000000000000000 CONTRACTS_L1_ERC20_BRIDGE_PROXY_ADDR=0x0000000000000000000000000000000000000000 +CONTRACTS_L1_NULLIFIER_IMPL_ADDR=0x0000000000000000000000000000000000000000 +CONTRACTS_L1_NULLIFIER_PROXY_ADDR=0x0000000000000000000000000000000000000000 CONTRACTS_L1_SHARED_BRIDGE_IMPL_ADDR=0x0000000000000000000000000000000000000000 CONTRACTS_L1_SHARED_BRIDGE_PROXY_ADDR=0x0000000000000000000000000000000000000000 +CONTRACTS_L1_BRIDGED_STANDARD_ERC20_IMPL_ADDR=0x0000000000000000000000000000000000000000 +CONTRACTS_L1_BRIDGED_TOKEN_BEACON_ADDR=0x0000000000000000000000000000000000000000 CONTRACTS_L1_ALLOW_LIST_ADDR=0x0000000000000000000000000000000000000000 CONTRACTS_CREATE2_FACTORY_ADDR=0x0000000000000000000000000000000000000000 CONTRACTS_VALIDATOR_TIMELOCK_ADDR=0x0000000000000000000000000000000000000000 @@ -33,9 +37,10 @@ CONTRACTS_VALIDATOR_TIMELOCK_EXECUTION_DELAY=0 ETH_SENDER_SENDER_OPERATOR_COMMIT_ETH_ADDR=0x0000000000000000000000000000000000000000 ETH_SENDER_SENDER_OPERATOR_BLOBS_ETH_ADDR=0x0000000000000000000000000000000000000001 CONTRACTS_SHARED_BRIDGE_UPGRADE_STORAGE_SWITCH=0 -CONTRACTS_MAX_NUMBER_OF_HYPERCHAINS=100 +CONTRACTS_MAX_NUMBER_OF_ZK_CHAINS=100 L1_CONFIG=/script-config/config-deploy-l1.toml L1_OUTPUT=/script-out/output-deploy-l1.toml TOKENS_CONFIG=/script-config/config-deploy-erc20.toml -HYPERCHAIN_CONFIG=/script-config/register-hyperchain.toml -HYPERCHAIN_OUTPUT=/script-out/output-deploy-hyperchain-era.toml +ZK_CHAIN_CONFIG=/script-config/register-zk-chain.toml +ZK_CHAIN_OUTPUT=/script-out/output-deploy-zk-chain-era.toml +FORCE_DEPLOYMENTS_CONFIG=/script-config/generate-force-deployments-data.toml diff --git a/l1-contracts/contracts/bridge/BridgeHelper.sol b/l1-contracts/contracts/bridge/BridgeHelper.sol index 9fc9b7cfc..bcc59327f 100644 --- a/l1-contracts/contracts/bridge/BridgeHelper.sol +++ b/l1-contracts/contracts/bridge/BridgeHelper.sol @@ -4,7 +4,9 @@ pragma solidity 0.8.24; // solhint-disable gas-custom-errors -import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol"; +import {IERC20Metadata} from "@openzeppelin/contracts-v4/token/ERC20/extensions/IERC20Metadata.sol"; +import {ETH_TOKEN_ADDRESS} from "../common/Config.sol"; +import {DataEncoding} from "../common/libraries/DataEncoding.sol"; /** * @author Matter Labs @@ -13,17 +15,22 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER */ library BridgeHelper { /// @dev Receives and parses (name, symbol, decimals) from the token contract - function getERC20Getters(address _token, address _ethTokenAddress) internal view returns (bytes memory) { - if (_token == _ethTokenAddress) { - bytes memory name = abi.encode("Ether"); - bytes memory symbol = abi.encode("ETH"); - bytes memory decimals = abi.encode(uint8(18)); - return abi.encode(name, symbol, decimals); // when depositing eth to a non-eth based chain it is an ERC20 + function getERC20Getters(address _token, uint256 _originChainId) internal view returns (bytes memory) { + bytes memory name; + bytes memory symbol; + bytes memory decimals; + if (_token == ETH_TOKEN_ADDRESS) { + // when depositing eth to a non-eth based chain it is an ERC20 + name = abi.encode("Ether"); + symbol = abi.encode("ETH"); + decimals = abi.encode(uint8(18)); + } else { + /// note this also works on the L2 for the base token. + (, name) = _token.staticcall(abi.encodeCall(IERC20Metadata.name, ())); + (, symbol) = _token.staticcall(abi.encodeCall(IERC20Metadata.symbol, ())); + (, decimals) = _token.staticcall(abi.encodeCall(IERC20Metadata.decimals, ())); } - - (, bytes memory data1) = _token.staticcall(abi.encodeCall(IERC20Metadata.name, ())); - (, bytes memory data2) = _token.staticcall(abi.encodeCall(IERC20Metadata.symbol, ())); - (, bytes memory data3) = _token.staticcall(abi.encodeCall(IERC20Metadata.decimals, ())); - return abi.encode(data1, data2, data3); + return + DataEncoding.encodeTokenData({_chainId: _originChainId, _name: name, _symbol: symbol, _decimals: decimals}); } } diff --git a/l2-contracts/contracts/bridge/L2StandardERC20.sol b/l1-contracts/contracts/bridge/BridgedStandardERC20.sol similarity index 77% rename from l2-contracts/contracts/bridge/L2StandardERC20.sol rename to l1-contracts/contracts/bridge/BridgedStandardERC20.sol index df81f542e..bd8d01110 100644 --- a/l2-contracts/contracts/bridge/L2StandardERC20.sol +++ b/l1-contracts/contracts/bridge/BridgedStandardERC20.sol @@ -6,14 +6,16 @@ import {ERC20PermitUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/tok import {UpgradeableBeacon} from "@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol"; import {ERC1967Upgrade} from "@openzeppelin/contracts-v4/proxy/ERC1967/ERC1967Upgrade.sol"; -import {IL2StandardToken} from "./interfaces/IL2StandardToken.sol"; -import {ZeroAddress, Unauthorized, NonSequentialVersion} from "../errors/L2ContractErrors.sol"; +import {IBridgedStandardToken} from "./interfaces/IBridgedStandardToken.sol"; +import {Unauthorized, NonSequentialVersion, ZeroAddress} from "../common/L1ContractErrors.sol"; +import {L2_NATIVE_TOKEN_VAULT_ADDR} from "../common/L2ContractAddresses.sol"; +import {DataEncoding} from "../common/libraries/DataEncoding.sol"; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev /// @notice The ERC20 token implementation, that is used in the "default" ERC20 bridge. Note, that it does not /// support any custom token logic, i.e. rebase tokens' functionality is not supported. -contract L2StandardERC20 is ERC20PermitUpgradeable, IL2StandardToken, ERC1967Upgrade { +contract BridgedStandardERC20 is ERC20PermitUpgradeable, IBridgedStandardToken, ERC1967Upgrade { /// @dev Describes whether there is a specific getter in the token. /// @notice Used to explicitly separate which getters the token has and which it does not. /// @notice Different tokens in L1 can implement or not implement getter function as `name`/`symbol`/`decimals`, @@ -31,15 +33,26 @@ contract L2StandardERC20 is ERC20PermitUpgradeable, IL2StandardToken, ERC1967Upg /// @notice OpenZeppelin token represents `name` and `symbol` as storage variables and `decimals` as constant. uint8 private decimals_; + /// @notice The l2Bridge now is deprecated, use the L2AssetRouter and L2NativeTokenVault instead. /// @dev Address of the L2 bridge that is used as trustee who can mint/burn tokens address public override l2Bridge; - /// @dev Address of the L1 token that can be deposited to mint this L2 token - address public override l1Address; + /// @dev Address of the token on its origin chain that can be deposited to mint this bridged token + address public override originToken; - modifier onlyBridge() { - if (msg.sender != l2Bridge) { - revert Unauthorized(); + /// @dev Address of the native token vault that is used as trustee who can mint/burn tokens + address public nativeTokenVault; + + /// @dev This also sets the native token vault to the default value if it is not set. + /// It is not set only on the L2s for legacy tokens. + modifier onlyNTV() { + address ntv = nativeTokenVault; + if (ntv == address(0)) { + ntv = L2_NATIVE_TOKEN_VAULT_ADDR; + nativeTokenVault = L2_NATIVE_TOKEN_VAULT_ADDR; + } + if (msg.sender != ntv) { + revert Unauthorized(msg.sender); } _; } @@ -61,22 +74,20 @@ contract L2StandardERC20 is ERC20PermitUpgradeable, IL2StandardToken, ERC1967Upg /// @notice Initializes a contract token for later use. Expected to be used in the proxy. /// @dev Stores the L1 address of the bridge and set `name`/`symbol`/`decimals` getters that L1 token has. - /// @param _l1Address Address of the L1 token that can be deposited to mint this L2 token + /// @param _originToken Address of the origin token that can be deposited to mint this bridged token /// @param _data The additional data that the L1 bridge provide for initialization. /// In this case, it is packed `name`/`symbol`/`decimals` of the L1 token. - function bridgeInitialize(address _l1Address, bytes calldata _data) external initializer { - if (_l1Address == address(0)) { + function bridgeInitialize(address _originToken, bytes calldata _data) external initializer returns (uint256) { + if (_originToken == address(0)) { revert ZeroAddress(); } - l1Address = _l1Address; + originToken = _originToken; - l2Bridge = msg.sender; + nativeTokenVault = msg.sender; // We parse the data exactly as they were created on the L1 bridge - (bytes memory nameBytes, bytes memory symbolBytes, bytes memory decimalsBytes) = abi.decode( - _data, - (bytes, bytes, bytes) - ); + (uint256 chainId, bytes memory nameBytes, bytes memory symbolBytes, bytes memory decimalsBytes) = DataEncoding + .decodeTokenData(_data); ERC20Getters memory getters; string memory decodedName; @@ -117,7 +128,8 @@ contract L2StandardERC20 is ERC20PermitUpgradeable, IL2StandardToken, ERC1967Upg } availableGetters = getters; - emit BridgeInitialize(_l1Address, decodedName, decodedSymbol, decimals_); + emit BridgeInitialize(_originToken, decodedName, decodedSymbol, decimals_); + return chainId; } /// @notice A method to be called by the governor to update the token's metadata. @@ -144,14 +156,14 @@ contract L2StandardERC20 is ERC20PermitUpgradeable, IL2StandardToken, ERC1967Upg __ERC20Permit_init(_newName); availableGetters = _availableGetters; - emit BridgeInitialize(l1Address, _newName, _newSymbol, decimals_); + emit BridgeInitialize(originToken, _newName, _newSymbol, decimals_); } /// @dev Mint tokens to a given account. /// @param _to The account that will receive the created tokens. /// @param _amount The amount that will be created. /// @notice Should be called by bridge after depositing tokens from L1. - function bridgeMint(address _to, uint256 _amount) external override onlyBridge { + function bridgeMint(address _to, uint256 _amount) external override onlyNTV { _mint(_to, _amount); emit BridgeMint(_to, _amount); } @@ -160,7 +172,7 @@ contract L2StandardERC20 is ERC20PermitUpgradeable, IL2StandardToken, ERC1967Upg /// @param _from The account from which tokens will be burned. /// @param _amount The amount that will be burned. /// @notice Should be called by bridge before withdrawing tokens to L1. - function bridgeBurn(address _from, uint256 _amount) external override onlyBridge { + function bridgeBurn(address _from, uint256 _amount) external override onlyNTV { _burn(_from, _amount); emit BridgeBurn(_from, _amount); } @@ -195,4 +207,14 @@ contract L2StandardERC20 is ERC20PermitUpgradeable, IL2StandardToken, ERC1967Upg if (availableGetters.ignoreDecimals) revert(); return decimals_; } + + /*////////////////////////////////////////////////////////////// + LEGACY FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @notice Returns the address of the token on its native chain. + /// Legacy for the l2 bridge. + function l1Address() public view override returns (address) { + return originToken; + } } diff --git a/l1-contracts/contracts/bridge/L1AssetRouter.sol b/l1-contracts/contracts/bridge/L1AssetRouter.sol deleted file mode 100644 index 9a4a16bce..000000000 --- a/l1-contracts/contracts/bridge/L1AssetRouter.sol +++ /dev/null @@ -1,1030 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -// solhint-disable reason-string, gas-custom-errors - -import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; -import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/security/PausableUpgradeable.sol"; - -import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; -import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; - -import {IL1ERC20Bridge} from "./interfaces/IL1ERC20Bridge.sol"; -import {IL1AssetRouter} from "./interfaces/IL1AssetRouter.sol"; -import {IL2Bridge} from "./interfaces/IL2Bridge.sol"; -import {IL2BridgeLegacy} from "./interfaces/IL2BridgeLegacy.sol"; -import {IL1AssetHandler} from "./interfaces/IL1AssetHandler.sol"; -import {IL1NativeTokenVault} from "./interfaces/IL1NativeTokenVault.sol"; - -import {IMailbox} from "../state-transition/chain-interfaces/IMailbox.sol"; -import {L2Message, TxStatus} from "../common/Messaging.sol"; -import {UnsafeBytes} from "../common/libraries/UnsafeBytes.sol"; -import {ReentrancyGuard} from "../common/ReentrancyGuard.sol"; -import {DataEncoding} from "../common/libraries/DataEncoding.sol"; -import {AddressAliasHelper} from "../vendor/AddressAliasHelper.sol"; -import {TWO_BRIDGES_MAGIC_VALUE, ETH_TOKEN_ADDRESS} from "../common/Config.sol"; -import {L2_NATIVE_TOKEN_VAULT_ADDRESS} from "../common/L2ContractAddresses.sol"; - -import {IBridgehub, L2TransactionRequestTwoBridgesInner, L2TransactionRequestDirect} from "../bridgehub/IBridgehub.sol"; -import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR, L2_ASSET_ROUTER_ADDR} from "../common/L2ContractAddresses.sol"; - -import {BridgeHelper} from "./BridgeHelper.sol"; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -/// @dev Bridges assets between L1 and ZK chain, supporting both ETH and ERC20 tokens. -/// @dev Designed for use with a proxy for upgradability. -contract L1AssetRouter is IL1AssetRouter, ReentrancyGuard, Ownable2StepUpgradeable, PausableUpgradeable { - using SafeERC20 for IERC20; - - /// @dev The address of the WETH token on L1. - address public immutable override L1_WETH_TOKEN; - - /// @dev Bridgehub smart contract that is used to operate with L2 via asynchronous L2 <-> L1 communication. - IBridgehub public immutable override BRIDGE_HUB; - - /// @dev Era's chainID - uint256 internal immutable ERA_CHAIN_ID; - - /// @dev The address of ZKsync Era diamond proxy contract. - address internal immutable ERA_DIAMOND_PROXY; - - /// @dev Stores the first batch number on the ZKsync Era Diamond Proxy that was settled after Diamond proxy upgrade. - /// This variable is used to differentiate between pre-upgrade and post-upgrade Eth withdrawals. Withdrawals from batches older - /// than this value are considered to have been finalized prior to the upgrade and handled separately. - uint256 internal eraPostDiamondUpgradeFirstBatch; - - /// @dev Stores the first batch number on the ZKsync Era Diamond Proxy that was settled after L1ERC20 Bridge upgrade. - /// This variable is used to differentiate between pre-upgrade and post-upgrade ERC20 withdrawals. Withdrawals from batches older - /// than this value are considered to have been finalized prior to the upgrade and handled separately. - uint256 internal eraPostLegacyBridgeUpgradeFirstBatch; - - /// @dev Stores the ZKsync Era batch number that processes the last deposit tx initiated by the legacy bridge - /// This variable (together with eraLegacyBridgeLastDepositTxNumber) is used to differentiate between pre-upgrade and post-upgrade deposits. Deposits processed in older batches - /// than this value are considered to have been processed prior to the upgrade and handled separately. - /// We use this both for Eth and erc20 token deposits, so we need to update the diamond and bridge simultaneously. - uint256 internal eraLegacyBridgeLastDepositBatch; - - /// @dev The tx number in the _eraLegacyBridgeLastDepositBatch of the last deposit tx initiated by the legacy bridge. - /// This variable (together with eraLegacyBridgeLastDepositBatch) is used to differentiate between pre-upgrade and post-upgrade deposits. Deposits processed in older txs - /// than this value are considered to have been processed prior to the upgrade and handled separately. - /// We use this both for Eth and erc20 token deposits, so we need to update the diamond and bridge simultaneously. - uint256 internal eraLegacyBridgeLastDepositTxNumber; - - /// @dev Legacy bridge smart contract that used to hold ERC20 tokens. - IL1ERC20Bridge public override legacyBridge; - - /// @dev A mapping chainId => bridgeProxy. Used to store the bridge proxy's address, and to see if it has been deployed yet. - mapping(uint256 chainId => address l2Bridge) public __DEPRECATED_l2BridgeAddress; - - /// @dev A mapping chainId => L2 deposit transaction hash => dataHash - // keccak256(abi.encode(account, tokenAddress, amount)) for legacy transfers - // keccak256(abi.encode(_prevMsgSender, assetId, transferData)) for new transfers - /// @dev Tracks deposit transactions to L2 to enable users to claim their funds if a deposit fails. - mapping(uint256 chainId => mapping(bytes32 l2DepositTxHash => bytes32 depositDataHash)) - public - override depositHappened; - - /// @dev Tracks the processing status of L2 to L1 messages, indicating whether a message has already been finalized. - mapping(uint256 chainId => mapping(uint256 l2BatchNumber => mapping(uint256 l2ToL1MessageNumber => bool isFinalized))) - public isWithdrawalFinalized; - - /// @notice Deprecated. Kept for backwards compatibility. - /// @dev Indicates whether the hyperbridging is enabled for a given chain. - // slither-disable-next-line uninitialized-state - mapping(uint256 chainId => bool enabled) public hyperbridgingEnabled; - - /// @dev Maps token balances for each chain to prevent unauthorized spending across ZK chain. - /// This serves as a security measure until hyperbridging is implemented. - /// NOTE: this function may be removed in the future, don't rely on it! - mapping(uint256 chainId => mapping(address l1Token => uint256 balance)) public chainBalance; - - /// @dev Maps asset ID to address of corresponding asset handler. - /// @dev Tracks the address of Asset Handler contracts, where bridged funds are locked for each asset. - /// @dev P.S. this liquidity was locked directly in SharedBridge before. - mapping(bytes32 assetId => address assetHandlerAddress) public assetHandlerAddress; - - /// @dev Maps asset ID to the asset deployment tracker address. - /// @dev Tracks the address of Deployment Tracker contract on L1, which sets Asset Handlers on L2s (ZK chain). - /// @dev For the asset and stores respective addresses. - mapping(bytes32 assetId => address assetDeploymentTracker) public assetDeploymentTracker; - - /// @dev Address of native token vault. - IL1NativeTokenVault public nativeTokenVault; - - /// @notice Checks that the message sender is the bridgehub. - modifier onlyBridgehub() { - require(msg.sender == address(BRIDGE_HUB), "L1AR: not BH"); - _; - } - - /// @notice Checks that the message sender is the bridgehub or zkSync Era Diamond Proxy. - modifier onlyBridgehubOrEra(uint256 _chainId) { - require( - msg.sender == address(BRIDGE_HUB) || (_chainId == ERA_CHAIN_ID && msg.sender == ERA_DIAMOND_PROXY), - "L1AR: msg.sender not equal to bridgehub or era chain" - ); - _; - } - - /// @notice Checks that the message sender is the legacy bridge. - modifier onlyLegacyBridge() { - require(msg.sender == address(legacyBridge), "L1AR: not legacy bridge"); - _; - } - - /// @dev Contract is expected to be used as proxy implementation. - /// @dev Initialize the implementation to prevent Parity hack. - constructor( - address _l1WethAddress, - IBridgehub _bridgehub, - uint256 _eraChainId, - address _eraDiamondProxy - ) reentrancyGuardInitializer { - _disableInitializers(); - L1_WETH_TOKEN = _l1WethAddress; - BRIDGE_HUB = _bridgehub; - ERA_CHAIN_ID = _eraChainId; - ERA_DIAMOND_PROXY = _eraDiamondProxy; - } - - /// @dev Initializes a contract bridge for later use. Expected to be used in the proxy. - /// @dev Used for testing purposes only, as the contract has been initialized on mainnet. - /// @param _owner The address which can change L2 token implementation and upgrade the bridge implementation. - /// The owner is the Governor and separate from the ProxyAdmin from now on, so that the Governor can call the bridge. - /// @param _eraPostDiamondUpgradeFirstBatch The first batch number on the zkSync Era Diamond Proxy that was settled after diamond proxy upgrade. - /// @param _eraPostLegacyBridgeUpgradeFirstBatch The first batch number on the zkSync Era Diamond Proxy that was settled after legacy bridge upgrade. - /// @param _eraLegacyBridgeLastDepositBatch The the zkSync Era batch number that processes the last deposit tx initiated by the legacy bridge. - /// @param _eraLegacyBridgeLastDepositTxNumber The tx number in the _eraLegacyBridgeLastDepositBatch of the last deposit tx initiated by the legacy bridge. - function initialize( - address _owner, - uint256 _eraPostDiamondUpgradeFirstBatch, - uint256 _eraPostLegacyBridgeUpgradeFirstBatch, - uint256 _eraLegacyBridgeLastDepositBatch, - uint256 _eraLegacyBridgeLastDepositTxNumber - ) external reentrancyGuardInitializer initializer { - require(_owner != address(0), "L1AR: owner 0"); - _transferOwnership(_owner); - if (eraPostDiamondUpgradeFirstBatch == 0) { - eraPostDiamondUpgradeFirstBatch = _eraPostDiamondUpgradeFirstBatch; - eraPostLegacyBridgeUpgradeFirstBatch = _eraPostLegacyBridgeUpgradeFirstBatch; - eraLegacyBridgeLastDepositBatch = _eraLegacyBridgeLastDepositBatch; - eraLegacyBridgeLastDepositTxNumber = _eraLegacyBridgeLastDepositTxNumber; - } - } - - /// @notice Transfers tokens from shared bridge to native token vault. - /// @dev This function is part of the upgrade process used to transfer liquidity. - /// @param _token The address of the token to be transferred to NTV. - function transferTokenToNTV(address _token) external { - address ntvAddress = address(nativeTokenVault); - require(msg.sender == ntvAddress, "L1AR: not NTV"); - if (ETH_TOKEN_ADDRESS == _token) { - uint256 amount = address(this).balance; - bool callSuccess; - // Low-level assembly call, to avoid any memory copying (save gas) - assembly { - callSuccess := call(gas(), ntvAddress, amount, 0, 0, 0, 0) - } - require(callSuccess, "L1AR: eth transfer failed"); - } else { - IERC20(_token).safeTransfer(ntvAddress, IERC20(_token).balanceOf(address(this))); - } - } - - /// @notice Clears chain balance for specific token. - /// @dev This function is part of the upgrade process used to nullify chain balances once they are credited to NTV. - /// @param _chainId The ID of the ZK chain. - /// @param _token The address of the token which was previously deposit to shared bridge. - function nullifyChainBalanceByNTV(uint256 _chainId, address _token) external { - require(msg.sender == address(nativeTokenVault), "L1AR: not NTV"); - chainBalance[_chainId][_token] = 0; - } - - /// @notice Sets the L1ERC20Bridge contract address. - /// @dev Should be called only once by the owner. - /// @param _legacyBridge The address of the legacy bridge. - function setL1Erc20Bridge(address _legacyBridge) external onlyOwner { - require(address(legacyBridge) == address(0), "L1AR: legacy bridge already set"); - require(_legacyBridge != address(0), "L1AR: legacy bridge 0"); - legacyBridge = IL1ERC20Bridge(_legacyBridge); - } - - /// @notice Sets the nativeTokenVault contract address. - /// @dev Should be called only once by the owner. - /// @param _nativeTokenVault The address of the native token vault. - function setNativeTokenVault(IL1NativeTokenVault _nativeTokenVault) external onlyOwner { - require(address(nativeTokenVault) == address(0), "L1AR: native token vault already set"); - require(address(_nativeTokenVault) != address(0), "L1AR: native token vault 0"); - nativeTokenVault = _nativeTokenVault; - } - - /// @notice Used to set the assed deployment tracker address for given asset data. - /// @param _assetRegistrationData The asset data which may include the asset address and any additional required data or encodings. - /// @param _assetDeploymentTracker The whitelisted address of asset deployment tracker for provided asset. - function setAssetDeploymentTracker( - bytes32 _assetRegistrationData, - address _assetDeploymentTracker - ) external onlyOwner { - bytes32 assetId = keccak256( - abi.encode(uint256(block.chainid), _assetDeploymentTracker, _assetRegistrationData) - ); - assetDeploymentTracker[assetId] = _assetDeploymentTracker; - emit AssetDeploymentTrackerSet(assetId, _assetDeploymentTracker, _assetRegistrationData); - } - - /// @notice Sets the asset handler address for a specified asset ID on the chain of the asset deployment tracker. - /// @dev The caller of this function is encoded within the `assetId`, therefore, it should be invoked by the asset deployment tracker contract. - /// @dev Typically, for most tokens, ADT is the native token vault. However, custom tokens may have their own specific asset deployment trackers. - /// @dev `setAssetHandlerAddressOnCounterPart` should be called on L1 to set asset handlers on L2 chains for a specific asset ID. - /// @param _assetRegistrationData The asset data which may include the asset address and any additional required data or encodings. - /// @param _assetHandlerAddress The address of the asset handler to be set for the provided asset. - function setAssetHandlerAddressInitial(bytes32 _assetRegistrationData, address _assetHandlerAddress) external { - bool senderIsNTV = msg.sender == address(nativeTokenVault); - address sender = senderIsNTV ? L2_NATIVE_TOKEN_VAULT_ADDRESS : msg.sender; - bytes32 assetId = DataEncoding.encodeAssetId(block.chainid, _assetRegistrationData, sender); - require(senderIsNTV || msg.sender == assetDeploymentTracker[assetId], "ShB: not NTV or ADT"); - assetHandlerAddress[assetId] = _assetHandlerAddress; - if (senderIsNTV) { - assetDeploymentTracker[assetId] = msg.sender; - } - emit AssetHandlerRegisteredInitial(assetId, _assetHandlerAddress, _assetRegistrationData, sender); - } - - /// @notice Used to set the asset handler address for a given asset ID on a remote ZK chain - /// @dev No access control on the caller, as msg.sender is encoded in the assetId. - /// @param _chainId The ZK chain ID. - /// @param _mintValue The value withdrawn by base token bridge to cover for l2 gas and l2 msg.value costs. - /// @param _l2TxGasLimit The L2 gas limit to be used in the corresponding L2 transaction. - /// @param _l2TxGasPerPubdataByte The gasPerPubdataByteLimit to be used in the corresponding L2 transaction. - /// @param _refundRecipient The address on L2 that will receive the refund for the transaction. - /// @param _assetId The encoding of asset ID. - /// @param _assetHandlerAddressOnCounterPart The address of the asset handler, which will hold the token of interest. - /// @return txHash The L2 transaction hash of setting asset handler on remote chain. - function setAssetHandlerAddressOnCounterPart( - uint256 _chainId, - uint256 _mintValue, - uint256 _l2TxGasLimit, - uint256 _l2TxGasPerPubdataByte, - address _refundRecipient, - bytes32 _assetId, - address _assetHandlerAddressOnCounterPart - ) external payable returns (bytes32 txHash) { - require(msg.sender == assetDeploymentTracker[_assetId] || msg.sender == owner(), "L1AR: only ADT or owner"); - - bytes memory l2Calldata = abi.encodeCall( - IL2Bridge.setAssetHandlerAddress, - (_assetId, _assetHandlerAddressOnCounterPart) - ); - - L2TransactionRequestDirect memory request = L2TransactionRequestDirect({ - chainId: _chainId, - l2Contract: L2_ASSET_ROUTER_ADDR, - mintValue: _mintValue, // l2 gas + l2 msg.value the bridgehub will withdraw the mintValue from the base token bridge for gas - l2Value: 0, // For base token deposits, there is no msg.value during the call, as the base token is minted to the recipient address - l2Calldata: l2Calldata, - l2GasLimit: _l2TxGasLimit, - l2GasPerPubdataByteLimit: _l2TxGasPerPubdataByte, - factoryDeps: new bytes[](0), - refundRecipient: _refundRecipient - }); - txHash = BRIDGE_HUB.requestL2TransactionDirect{value: msg.value}(request); - } - - /// @notice Allows bridgehub to acquire mintValue for L1->L2 transactions. - /// @dev If the corresponding L2 transaction fails, refunds are issued to a refund recipient on L2. - /// @param _chainId The chain ID of the ZK chain to which deposit. - /// @param _assetId The deposited asset ID. - /// @param _prevMsgSender The `msg.sender` address from the external call that initiated current one. - /// @param _amount The total amount of tokens to be bridged. - function bridgehubDepositBaseToken( - uint256 _chainId, - bytes32 _assetId, - address _prevMsgSender, - uint256 _amount - ) external payable onlyBridgehubOrEra(_chainId) whenNotPaused { - address l1AssetHandler = assetHandlerAddress[_assetId]; - require(l1AssetHandler != address(0), "ShB: asset handler not set"); - - _transferAllowanceToNTV(_assetId, _amount, _prevMsgSender); - // slither-disable-next-line unused-return - IL1AssetHandler(l1AssetHandler).bridgeBurn{value: msg.value}({ - _chainId: _chainId, - _l2Value: 0, - _assetId: _assetId, - _prevMsgSender: _prevMsgSender, - _data: abi.encode(_amount, address(0)) - }); - - // Note that we don't save the deposited amount, as this is for the base token, which gets sent to the refundRecipient if the tx fails - emit BridgehubDepositBaseTokenInitiated(_chainId, _prevMsgSender, _assetId, _amount); - } - - /// @notice Initiates a deposit transaction within Bridgehub, used by `requestL2TransactionTwoBridges`. - /// @param _chainId The chain ID of the ZK chain to which deposit. - /// @param _prevMsgSender The `msg.sender` address from the external call that initiated current one. - /// @param _l2Value The L2 `msg.value` from the L1 -> L2 deposit transaction. - /// @param _data The calldata for the second bridge deposit. - /// @return request The data used by the bridgehub to create L2 transaction request to specific ZK chain. - function bridgehubDeposit( - uint256 _chainId, - address _prevMsgSender, - uint256 _l2Value, - bytes calldata _data - ) - external - payable - override - onlyBridgehub - whenNotPaused - returns (L2TransactionRequestTwoBridgesInner memory request) - { - bytes32 assetId; - bytes memory transferData; - bool legacyDeposit = false; - bytes1 encodingVersion = _data[0]; - - // The new encoding ensures that the calldata is collision-resistant with respect to the legacy format. - // In the legacy calldata, the first input was the address, meaning the most significant byte was always `0x00`. - if (encodingVersion == 0x01) { - (assetId, transferData) = abi.decode(_data[1:], (bytes32, bytes)); - require( - assetHandlerAddress[assetId] != address(nativeTokenVault), - "ShB: new encoding format not yet supported for NTV" - ); - } else { - (assetId, transferData) = _handleLegacyData(_data, _prevMsgSender); - legacyDeposit = true; - } - - require(BRIDGE_HUB.baseTokenAssetId(_chainId) != assetId, "L1AR: baseToken deposit not supported"); - - bytes memory bridgeMintCalldata = _burn({ - _chainId: _chainId, - _l2Value: _l2Value, - _assetId: assetId, - _prevMsgSender: _prevMsgSender, - _transferData: transferData, - _passValue: true - }); - bytes32 txDataHash = this.encodeTxDataHash(legacyDeposit, _prevMsgSender, assetId, transferData); - - request = _requestToBridge({ - _prevMsgSender: _prevMsgSender, - _assetId: assetId, - _bridgeMintCalldata: bridgeMintCalldata, - _txDataHash: txDataHash - }); - - emit BridgehubDepositInitiated({ - chainId: _chainId, - txDataHash: txDataHash, - from: _prevMsgSender, - assetId: assetId, - bridgeMintCalldata: bridgeMintCalldata - }); - } - - /// @notice Confirms the acceptance of a transaction by the Mailbox, as part of the L2 transaction process within Bridgehub. - /// This function is utilized by `requestL2TransactionTwoBridges` to validate the execution of a transaction. - /// @param _chainId The chain ID of the ZK chain to which confirm the deposit. - /// @param _txDataHash The keccak256 hash of 0x01 || abi.encode(bytes32, bytes) to identify deposits. - /// @param _txHash The hash of the L1->L2 transaction to confirm the deposit. - function bridgehubConfirmL2Transaction( - uint256 _chainId, - bytes32 _txDataHash, - bytes32 _txHash - ) external override onlyBridgehub whenNotPaused { - require(depositHappened[_chainId][_txHash] == 0x00, "L1AR: tx hap"); - depositHappened[_chainId][_txHash] = _txDataHash; - emit BridgehubDepositFinalized(_chainId, _txDataHash, _txHash); - } - - /// @notice Finalize the withdrawal and release funds - /// @param _chainId The chain ID of the transaction to check - /// @param _l2BatchNumber The L2 batch number where the withdrawal was processed - /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message - /// @param _l2TxNumberInBatch The L2 transaction number in the batch, in which the log was sent - /// @param _message The L2 withdraw data, stored in an L2 -> L1 message - /// @param _merkleProof The Merkle proof of the inclusion L2 -> L1 message about withdrawal initialization - function finalizeWithdrawal( - uint256 _chainId, - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes calldata _message, - bytes32[] calldata _merkleProof - ) external override { - _finalizeWithdrawal({ - _chainId: _chainId, - _l2BatchNumber: _l2BatchNumber, - _l2MessageIndex: _l2MessageIndex, - _l2TxNumberInBatch: _l2TxNumberInBatch, - _message: _message, - _merkleProof: _merkleProof - }); - } - - /// @dev Calls the internal `_encodeTxDataHash`. Used as a wrapped for try / catch case. - /// @param _isLegacyEncoding Boolean flag indicating whether to use the legacy encoding standard (true) or the latest encoding standard (false). - /// @param _prevMsgSender The address of the entity that initiated the deposit. - /// @param _assetId The unique identifier of the deposited L1 token. - /// @param _transferData The encoded transfer data, which includes both the deposit amount and the address of the L2 receiver. - /// @return txDataHash The resulting encoded transaction data hash. - function encodeTxDataHash( - bool _isLegacyEncoding, - address _prevMsgSender, - bytes32 _assetId, - bytes calldata _transferData - ) external view returns (bytes32 txDataHash) { - return _encodeTxDataHash(_isLegacyEncoding, _prevMsgSender, _assetId, _transferData); - } - - /// @dev Withdraw funds from the initiated deposit, that failed when finalizing on L2. - /// @param _chainId The ZK chain id to which deposit was initiated. - /// @param _depositSender The address of the entity that initiated the deposit. - /// @param _assetId The unique identifier of the deposited L1 token. - /// @param _assetData The encoded transfer data, which includes both the deposit amount and the address of the L2 receiver. Might include extra information. - /// @param _l2TxHash The L2 transaction hash of the failed deposit finalization. - /// @param _l2BatchNumber The L2 batch number where the deposit finalization was processed. - /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. - /// @param _l2TxNumberInBatch The L2 transaction number in a batch, in which the log was sent. - /// @param _merkleProof The Merkle proof of the processing L1 -> L2 transaction with deposit finalization. - /// @dev Processes claims of failed deposit, whether they originated from the legacy bridge or the current system. - function bridgeRecoverFailedTransfer( - uint256 _chainId, - address _depositSender, - bytes32 _assetId, - bytes memory _assetData, - bytes32 _l2TxHash, - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes32[] calldata _merkleProof - ) public nonReentrant whenNotPaused { - { - bool proofValid = BRIDGE_HUB.proveL1ToL2TransactionStatus({ - _chainId: _chainId, - _l2TxHash: _l2TxHash, - _l2BatchNumber: _l2BatchNumber, - _l2MessageIndex: _l2MessageIndex, - _l2TxNumberInBatch: _l2TxNumberInBatch, - _merkleProof: _merkleProof, - _status: TxStatus.Failure - }); - require(proofValid, "yn"); - } - - require(!_isEraLegacyDeposit(_chainId, _l2BatchNumber, _l2TxNumberInBatch), "L1AR: legacy cFD"); - { - bytes32 dataHash = depositHappened[_chainId][_l2TxHash]; - // Determine if the given dataHash matches the calculated legacy transaction hash. - bool isLegacyTxDataHash = _isLegacyTxDataHash(_depositSender, _assetId, _assetData, dataHash); - // If the dataHash matches the legacy transaction hash, skip the next step. - // Otherwise, perform the check using the new transaction data hash encoding. - if (!isLegacyTxDataHash) { - bytes32 txDataHash = _encodeTxDataHash(false, _depositSender, _assetId, _assetData); - require(dataHash == txDataHash, "L1AR: d.it not hap"); - } - } - delete depositHappened[_chainId][_l2TxHash]; - - IL1AssetHandler(assetHandlerAddress[_assetId]).bridgeRecoverFailedTransfer( - _chainId, - _assetId, - _depositSender, - _assetData - ); - - emit ClaimedFailedDepositSharedBridge(_chainId, _depositSender, _assetId, _assetData); - } - - /// @dev Receives and parses (name, symbol, decimals) from the token contract - function getERC20Getters(address _token) public view returns (bytes memory) { - return BridgeHelper.getERC20Getters(_token, ETH_TOKEN_ADDRESS); - } - - /// @dev send the burn message to the asset - /// @notice Forwards the burn request for specific asset to respective asset handler - /// @param _chainId The chain ID of the ZK chain to which deposit. - /// @param _l2Value The L2 `msg.value` from the L1 -> L2 deposit transaction. - /// @param _assetId The deposited asset ID. - /// @param _prevMsgSender The `msg.sender` address from the external call that initiated current one. - /// @param _transferData The encoded data, which is used by the asset handler to determine L2 recipient and amount. Might include extra information. - /// @param _passValue Boolean indicating whether to pass msg.value in the call. - /// @return bridgeMintCalldata The calldata used by remote asset handler to mint tokens for recipient. - function _burn( - uint256 _chainId, - uint256 _l2Value, - bytes32 _assetId, - address _prevMsgSender, - bytes memory _transferData, - bool _passValue - ) internal returns (bytes memory bridgeMintCalldata) { - address l1AssetHandler = assetHandlerAddress[_assetId]; - require(l1AssetHandler != address(0), "ShB: asset handler does not exist for assetId"); - - uint256 msgValue = _passValue ? msg.value : 0; - bridgeMintCalldata = IL1AssetHandler(l1AssetHandler).bridgeBurn{value: msgValue}({ - _chainId: _chainId, - _l2Value: _l2Value, - _assetId: _assetId, - _prevMsgSender: _prevMsgSender, - _data: _transferData - }); - } - - struct MessageParams { - uint256 l2BatchNumber; - uint256 l2MessageIndex; - uint16 l2TxNumberInBatch; - } - - /// @notice Internal function that handles the logic for finalizing withdrawals, supporting both the current bridge system and the legacy ERC20 bridge. - /// @param _chainId The chain ID of the transaction to check. - /// @param _l2BatchNumber The L2 batch number where the withdrawal was processed. - /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. - /// @param _l2TxNumberInBatch The L2 transaction number in the batch, in which the log was sent. - /// @param _message The L2 withdraw data, stored in an L2 -> L1 message. - /// @param _merkleProof The Merkle proof of the inclusion L2 -> L1 message about withdrawal initialization. - /// @return l1Receiver The address to receive bridged assets. - /// @return assetId The bridged asset ID. - /// @return amount The amount of asset bridged. - function _finalizeWithdrawal( - uint256 _chainId, - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes calldata _message, - bytes32[] calldata _merkleProof - ) internal nonReentrant whenNotPaused returns (address l1Receiver, bytes32 assetId, uint256 amount) { - require( - !isWithdrawalFinalized[_chainId][_l2BatchNumber][_l2MessageIndex], - "L1AR: Withdrawal is already finalized" - ); - isWithdrawalFinalized[_chainId][_l2BatchNumber][_l2MessageIndex] = true; - - // Handling special case for withdrawal from ZKsync Era initiated before Shared Bridge. - require(!_isEraLegacyEthWithdrawal(_chainId, _l2BatchNumber), "L1AR: legacy eth withdrawal"); - require(!_isEraLegacyTokenWithdrawal(_chainId, _l2BatchNumber), "L1AR: legacy token withdrawal"); - - bytes memory transferData; - { - MessageParams memory messageParams = MessageParams({ - l2BatchNumber: _l2BatchNumber, - l2MessageIndex: _l2MessageIndex, - l2TxNumberInBatch: _l2TxNumberInBatch - }); - (assetId, transferData) = _checkWithdrawal(_chainId, messageParams, _message, _merkleProof); - } - address l1AssetHandler = assetHandlerAddress[assetId]; - // slither-disable-next-line unused-return - IL1AssetHandler(l1AssetHandler).bridgeMint(_chainId, assetId, transferData); - (amount, l1Receiver) = abi.decode(transferData, (uint256, address)); - - emit WithdrawalFinalizedSharedBridge(_chainId, l1Receiver, assetId, amount); - } - - /// @notice Decodes the transfer input for legacy data and transfers allowance to NTV - /// @dev Is not applicable for custom asset handlers - /// @param _data encoded transfer data (address _l1Token, uint256 _depositAmount, address _l2Receiver) - /// @param _prevMsgSender address of the deposit initiator - function _handleLegacyData(bytes calldata _data, address _prevMsgSender) internal returns (bytes32, bytes memory) { - (address _l1Token, uint256 _depositAmount, address _l2Receiver) = abi.decode( - _data, - (address, uint256, address) - ); - bytes32 assetId = _ensureTokenRegisteredWithNTV(_l1Token); - _transferAllowanceToNTV(assetId, _depositAmount, _prevMsgSender); - return (assetId, abi.encode(_depositAmount, _l2Receiver)); - } - - function _ensureTokenRegisteredWithNTV(address _l1Token) internal returns (bytes32 assetId) { - assetId = DataEncoding.encodeNTVAssetId(block.chainid, _l1Token); - if (nativeTokenVault.tokenAddress(assetId) == address(0)) { - nativeTokenVault.registerToken(_l1Token); - } - } - - /// @notice Transfers allowance to Native Token Vault, if the asset is registered with it. Does nothing for ETH or non-registered tokens. - /// @dev assetId is not the padded address, but the correct encoded id (NTV stores respective format for IDs) - function _transferAllowanceToNTV(bytes32 _assetId, uint256 _amount, address _prevMsgSender) internal { - address l1TokenAddress = nativeTokenVault.tokenAddress(_assetId); - if (l1TokenAddress == address(0) || l1TokenAddress == ETH_TOKEN_ADDRESS) { - return; - } - IERC20 l1Token = IERC20(l1TokenAddress); - - // Do the transfer if allowance to Shared bridge is bigger than amount - // And if there is not enough allowance for the NTV - if ( - l1Token.allowance(_prevMsgSender, address(this)) >= _amount && - l1Token.allowance(_prevMsgSender, address(nativeTokenVault)) < _amount - ) { - // slither-disable-next-line arbitrary-send-erc20 - l1Token.safeTransferFrom(_prevMsgSender, address(this), _amount); - l1Token.forceApprove(address(nativeTokenVault), _amount); - } - } - - /// @dev The request data that is passed to the bridgehub - function _requestToBridge( - address _prevMsgSender, - bytes32 _assetId, - bytes memory _bridgeMintCalldata, - bytes32 _txDataHash - ) internal view returns (L2TransactionRequestTwoBridgesInner memory request) { - // Request the finalization of the deposit on the L2 side - bytes memory l2TxCalldata = _getDepositL2Calldata(_prevMsgSender, _assetId, _bridgeMintCalldata); - - request = L2TransactionRequestTwoBridgesInner({ - magicValue: TWO_BRIDGES_MAGIC_VALUE, - l2Contract: L2_ASSET_ROUTER_ADDR, - l2Calldata: l2TxCalldata, - factoryDeps: new bytes[](0), - txDataHash: _txDataHash - }); - } - - /// @dev Generate a calldata for calling the deposit finalization on the L2 bridge contract - function _getDepositL2Calldata( - address _l1Sender, - bytes32 _assetId, - bytes memory _assetData - ) internal view returns (bytes memory) { - // First branch covers the case when asset is not registered with NTV (custom asset handler) - // Second branch handles tokens registered with NTV and uses legacy calldata encoding - if (nativeTokenVault.tokenAddress(_assetId) == address(0)) { - return abi.encodeCall(IL2Bridge.finalizeDeposit, (_assetId, _assetData)); - } else { - // slither-disable-next-line unused-return - (, address _l2Receiver, address _parsedL1Token, uint256 _amount, bytes memory _gettersData) = DataEncoding - .decodeBridgeMintData(_assetData); - return - abi.encodeCall( - IL2BridgeLegacy.finalizeDeposit, - (_l1Sender, _l2Receiver, _parsedL1Token, _amount, _gettersData) - ); - } - } - - /// @dev Determines if an eth withdrawal was initiated on zkSync Era before the upgrade to the Shared Bridge. - /// @param _chainId The chain ID of the transaction to check. - /// @param _l2BatchNumber The L2 batch number for the withdrawal. - /// @return Whether withdrawal was initiated on ZKsync Era before diamond proxy upgrade. - function _isEraLegacyEthWithdrawal(uint256 _chainId, uint256 _l2BatchNumber) internal view returns (bool) { - require((_chainId != ERA_CHAIN_ID) || eraPostDiamondUpgradeFirstBatch != 0, "L1AR: diamondUFB not set for Era"); - return (_chainId == ERA_CHAIN_ID) && (_l2BatchNumber < eraPostDiamondUpgradeFirstBatch); - } - - /// @dev Determines if a token withdrawal was initiated on ZKsync Era before the upgrade to the Shared Bridge. - /// @param _chainId The chain ID of the transaction to check. - /// @param _l2BatchNumber The L2 batch number for the withdrawal. - /// @return Whether withdrawal was initiated on ZKsync Era before Legacy Bridge upgrade. - function _isEraLegacyTokenWithdrawal(uint256 _chainId, uint256 _l2BatchNumber) internal view returns (bool) { - require( - (_chainId != ERA_CHAIN_ID) || eraPostLegacyBridgeUpgradeFirstBatch != 0, - "L1AR: LegacyUFB not set for Era" - ); - return (_chainId == ERA_CHAIN_ID) && (_l2BatchNumber < eraPostLegacyBridgeUpgradeFirstBatch); - } - - /// @dev Determines if the provided data for a failed deposit corresponds to a legacy failed deposit. - /// @param _prevMsgSender The address of the entity that initiated the deposit. - /// @param _assetId The unique identifier of the deposited L1 token. - /// @param _transferData The encoded transfer data, which includes both the deposit amount and the address of the L2 receiver. - /// @param _expectedTxDataHash The nullifier data hash stored for the failed deposit. - /// @return isLegacyTxDataHash True if the transaction is legacy, false otherwise. - function _isLegacyTxDataHash( - address _prevMsgSender, - bytes32 _assetId, - bytes memory _transferData, - bytes32 _expectedTxDataHash - ) internal view returns (bool isLegacyTxDataHash) { - try this.encodeTxDataHash(true, _prevMsgSender, _assetId, _transferData) returns (bytes32 txDataHash) { - return txDataHash == _expectedTxDataHash; - } catch { - return false; - } - } - - /// @dev Encodes the transaction data hash using either the latest encoding standard or the legacy standard. - /// @param _isLegacyEncoding Boolean flag indicating whether to use the legacy encoding standard (true) or the latest encoding standard (false). - /// @param _prevMsgSender The address of the entity that initiated the deposit. - /// @param _assetId The unique identifier of the deposited L1 token. - /// @param _transferData The encoded transfer data, which includes both the deposit amount and the address of the L2 receiver. - /// @return txDataHash The resulting encoded transaction data hash. - function _encodeTxDataHash( - bool _isLegacyEncoding, - address _prevMsgSender, - bytes32 _assetId, - bytes memory _transferData - ) internal view returns (bytes32 txDataHash) { - if (_isLegacyEncoding) { - (uint256 depositAmount, ) = abi.decode(_transferData, (uint256, address)); - txDataHash = keccak256(abi.encode(_prevMsgSender, nativeTokenVault.tokenAddress(_assetId), depositAmount)); - } else { - // Similarly to calldata, the txDataHash is collision-resistant. - // In the legacy data hash, the first encoded variable was the address, which is padded with zeros during `abi.encode`. - txDataHash = keccak256(bytes.concat(bytes1(0x01), abi.encode(_prevMsgSender, _assetId, _transferData))); - } - } - - /// @dev Determines if a deposit was initiated on zkSync Era before the upgrade to the Shared Bridge. - /// @param _chainId The chain ID of the transaction to check. - /// @param _l2BatchNumber The L2 batch number for the deposit where it was processed. - /// @param _l2TxNumberInBatch The L2 transaction number in the batch, in which the deposit was processed. - /// @return Whether deposit was initiated on ZKsync Era before Shared Bridge upgrade. - function _isEraLegacyDeposit( - uint256 _chainId, - uint256 _l2BatchNumber, - uint256 _l2TxNumberInBatch - ) internal view returns (bool) { - require( - (_chainId != ERA_CHAIN_ID) || (eraLegacyBridgeLastDepositBatch != 0), - "L1AR: last deposit time not set for Era" - ); - return - (_chainId == ERA_CHAIN_ID) && - (_l2BatchNumber < eraLegacyBridgeLastDepositBatch || - (_l2TxNumberInBatch <= eraLegacyBridgeLastDepositTxNumber && - _l2BatchNumber == eraLegacyBridgeLastDepositBatch)); - } - - /// @notice Verifies the validity of a withdrawal message from L2 and returns withdrawal details. - /// @param _chainId The chain ID of the transaction to check. - /// @param _messageParams The message params, which include batch number, message index, and L2 tx number in batch. - /// @param _message The L2 withdraw data, stored in an L2 -> L1 message. - /// @param _merkleProof The Merkle proof of the inclusion L2 -> L1 message about withdrawal initialization. - /// @return assetId The ID of the bridged asset. - /// @return transferData The transfer data used to finalize withdawal. - function _checkWithdrawal( - uint256 _chainId, - MessageParams memory _messageParams, - bytes calldata _message, - bytes32[] calldata _merkleProof - ) internal view returns (bytes32 assetId, bytes memory transferData) { - (assetId, transferData) = _parseL2WithdrawalMessage(_chainId, _message); - L2Message memory l2ToL1Message; - { - bool baseTokenWithdrawal = (assetId == BRIDGE_HUB.baseTokenAssetId(_chainId)); - address l2Sender = baseTokenWithdrawal ? L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR : L2_ASSET_ROUTER_ADDR; - - l2ToL1Message = L2Message({ - txNumberInBatch: _messageParams.l2TxNumberInBatch, - sender: l2Sender, - data: _message - }); - } - - bool success = BRIDGE_HUB.proveL2MessageInclusion({ - _chainId: _chainId, - _batchNumber: _messageParams.l2BatchNumber, - _index: _messageParams.l2MessageIndex, - _message: l2ToL1Message, - _proof: _merkleProof - }); - require(success, "L1AR: withd w proof"); // withdrawal wrong proof - } - - /// @notice Parses the withdrawal message and returns withdrawal details. - /// @dev Currently, 3 different encoding versions are supported: legacy mailbox withdrawal, ERC20 bridge withdrawal, - /// @dev and the latest version supported by shared bridge. Selectors are used for versioning. - /// @param _chainId The ZK chain ID. - /// @param _l2ToL1message The encoded L2 -> L1 message. - /// @return assetId The ID of the bridged asset. - /// @return transferData The transfer data used to finalize withdawal. - function _parseL2WithdrawalMessage( - uint256 _chainId, - bytes memory _l2ToL1message - ) internal view returns (bytes32 assetId, bytes memory transferData) { - // We check that the message is long enough to read the data. - // Please note that there are three versions of the message: - // 1. The message that is sent by `withdraw(address _l1Receiver)` or `withdrawWithMessage`. In the second case, this function ignores the extra data - // It should be equal to the length of the bytes4 function signature + address l1Receiver + uint256 amount = 4 + 20 + 32 = 56 (bytes). - // 2. The legacy `getL1WithdrawMessage`, the length of the data is known. - // 3. The message that is encoded by `getL1WithdrawMessage(bytes32 _assetId, bytes memory _bridgeMintData)` - // No length is assumed. The assetId is decoded and the mintData is passed to respective assetHandler - - (uint32 functionSignature, uint256 offset) = UnsafeBytes.readUint32(_l2ToL1message, 0); - if (bytes4(functionSignature) == IMailbox.finalizeEthWithdrawal.selector) { - uint256 amount; - address l1Receiver; - - // The data is expected to be at least 56 bytes long. - require(_l2ToL1message.length >= 56, "L1AR: wrong msg len"); // wrong message length - // this message is a base token withdrawal - (l1Receiver, offset) = UnsafeBytes.readAddress(_l2ToL1message, offset); - // slither-disable-next-line unused-return - (amount, ) = UnsafeBytes.readUint256(_l2ToL1message, offset); - assetId = BRIDGE_HUB.baseTokenAssetId(_chainId); - transferData = abi.encode(amount, l1Receiver); - } else if (bytes4(functionSignature) == IL1ERC20Bridge.finalizeWithdrawal.selector) { - address l1Token; - uint256 amount; - address l1Receiver; - // We use the IL1ERC20Bridge for backward compatibility with old withdrawals. - // This message is a token withdrawal - - // Check that the message length is correct. - // It should be equal to the length of the function signature + address + address + uint256 = 4 + 20 + 20 + 32 = - // 76 (bytes). - require(_l2ToL1message.length == 76, "L1AR: wrong msg len 2"); - (l1Receiver, offset) = UnsafeBytes.readAddress(_l2ToL1message, offset); - (l1Token, offset) = UnsafeBytes.readAddress(_l2ToL1message, offset); - // slither-disable-next-line unused-return - (amount, ) = UnsafeBytes.readUint256(_l2ToL1message, offset); - - assetId = DataEncoding.encodeNTVAssetId(block.chainid, l1Token); - transferData = abi.encode(amount, l1Receiver); - } else if (bytes4(functionSignature) == this.finalizeWithdrawal.selector) { - // The data is expected to be at least 36 bytes long to contain assetId. - require(_l2ToL1message.length >= 36, "L1AR: wrong msg len"); // wrong message length - (assetId, offset) = UnsafeBytes.readBytes32(_l2ToL1message, offset); - transferData = UnsafeBytes.readRemainingBytes(_l2ToL1message, offset); - } else { - revert("L1AR: Incorrect message function selector"); - } - } - - /*////////////////////////////////////////////////////////////// - SHARED BRIDGE TOKEN BRIDGING LEGACY FUNCTIONS - //////////////////////////////////////////////////////////////*/ - - /// @notice Withdraw funds from the initiated deposit, that failed when finalizing on L2. - /// @dev Cannot be used to claim deposits made with new encoding. - /// @param _chainId The ZK chain id to which deposit was initiated. - /// @param _depositSender The address of the deposit initiator. - /// @param _l1Asset The address of the deposited L1 ERC20 token. - /// @param _amount The amount of the deposit that failed. - /// @param _l2TxHash The L2 transaction hash of the failed deposit finalization. - /// @param _l2BatchNumber The L2 batch number where the deposit finalization was processed. - /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. - /// @param _l2TxNumberInBatch The L2 transaction number in a batch, in which the log was sent. - /// @param _merkleProof The Merkle proof of the processing L1 -> L2 transaction with deposit finalization. - function claimFailedDeposit( - uint256 _chainId, - address _depositSender, - address _l1Asset, - uint256 _amount, - bytes32 _l2TxHash, - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes32[] calldata _merkleProof - ) external override { - bytes32 assetId = DataEncoding.encodeNTVAssetId(block.chainid, _l1Asset); - // For legacy deposits, the l2 receiver is not required to check tx data hash - bytes memory transferData = abi.encode(_amount, address(0)); - bridgeRecoverFailedTransfer({ - _chainId: _chainId, - _depositSender: _depositSender, - _assetId: assetId, - _assetData: transferData, - _l2TxHash: _l2TxHash, - _l2BatchNumber: _l2BatchNumber, - _l2MessageIndex: _l2MessageIndex, - _l2TxNumberInBatch: _l2TxNumberInBatch, - _merkleProof: _merkleProof - }); - } - - /*////////////////////////////////////////////////////////////// - ERA ERC20 LEGACY FUNCTIONS - //////////////////////////////////////////////////////////////*/ - - /// @notice Initiates a deposit by locking funds on the contract and sending the request - /// of processing an L2 transaction where tokens would be minted. - /// @dev If the token is bridged for the first time, the L2 token contract will be deployed. Note however, that the - /// newly-deployed token does not support any custom logic, i.e. rebase tokens' functionality is not supported. - /// @param _prevMsgSender The `msg.sender` address from the external call that initiated current one. - /// @param _l2Receiver The account address that should receive funds on L2. - /// @param _l1Token The L1 token address which is deposited. - /// @param _amount The total amount of tokens to be bridged. - /// @param _l2TxGasLimit The L2 gas limit to be used in the corresponding L2 transaction. - /// @param _l2TxGasPerPubdataByte The gasPerPubdataByteLimit to be used in the corresponding L2 transaction. - /// @param _refundRecipient The address on L2 that will receive the refund for the transaction. - /// @dev If the L2 deposit finalization transaction fails, the `_refundRecipient` will receive the `_l2Value`. - /// Please note, the contract may change the refund recipient's address to eliminate sending funds to addresses - /// out of control. - /// - If `_refundRecipient` is a contract on L1, the refund will be sent to the aliased `_refundRecipient`. - /// - If `_refundRecipient` is set to `address(0)` and the sender has NO deployed bytecode on L1, the refund will - /// be sent to the `msg.sender` address. - /// - If `_refundRecipient` is set to `address(0)` and the sender has deployed bytecode on L1, the refund will be - /// sent to the aliased `msg.sender` address. - /// @dev The address aliasing of L1 contracts as refund recipient on L2 is necessary to guarantee that the funds - /// are controllable through the Mailbox, since the Mailbox applies address aliasing to the from address for the - /// L2 tx if the L1 msg.sender is a contract. Without address aliasing for L1 contracts as refund recipients they - /// would not be able to make proper L2 tx requests through the Mailbox to use or withdraw the funds from L2, and - /// the funds would be lost. - /// @return txHash The L2 transaction hash of deposit finalization. - function depositLegacyErc20Bridge( - address _prevMsgSender, - address _l2Receiver, - address _l1Token, - uint256 _amount, - uint256 _l2TxGasLimit, - uint256 _l2TxGasPerPubdataByte, - address _refundRecipient - ) external payable override onlyLegacyBridge nonReentrant whenNotPaused returns (bytes32 txHash) { - require(_l1Token != L1_WETH_TOKEN, "L1AR: WETH deposit not supported 2"); - - bytes32 _assetId; - bytes memory bridgeMintCalldata; - - { - // Inner call to encode data to decrease local var numbers - _assetId = _ensureTokenRegisteredWithNTV(_l1Token); - IERC20(_l1Token).forceApprove(address(nativeTokenVault), _amount); - } - - { - bridgeMintCalldata = _burn({ - _chainId: ERA_CHAIN_ID, - _l2Value: 0, - _assetId: _assetId, - _prevMsgSender: _prevMsgSender, - _transferData: abi.encode(_amount, _l2Receiver), - _passValue: false - }); - } - - { - bytes memory l2TxCalldata = _getDepositL2Calldata(_prevMsgSender, _assetId, bridgeMintCalldata); - - // If the refund recipient is not specified, the refund will be sent to the sender of the transaction. - // Otherwise, the refund will be sent to the specified address. - // If the recipient is a contract on L1, the address alias will be applied. - address refundRecipient = AddressAliasHelper.actualRefundRecipient(_refundRecipient, _prevMsgSender); - - L2TransactionRequestDirect memory request = L2TransactionRequestDirect({ - chainId: ERA_CHAIN_ID, - l2Contract: L2_ASSET_ROUTER_ADDR, - mintValue: msg.value, // l2 gas + l2 msg.Value the bridgehub will withdraw the mintValue from the shared bridge (base token bridge) for gas - l2Value: 0, // L2 msg.value, this contract doesn't support base token deposits or wrapping functionality, for direct deposits use bridgehub - l2Calldata: l2TxCalldata, - l2GasLimit: _l2TxGasLimit, - l2GasPerPubdataByteLimit: _l2TxGasPerPubdataByte, - factoryDeps: new bytes[](0), - refundRecipient: refundRecipient - }); - txHash = BRIDGE_HUB.requestL2TransactionDirect{value: msg.value}(request); - } - - // Save the deposited amount to claim funds on L1 if the deposit failed on L2 - depositHappened[ERA_CHAIN_ID][txHash] = keccak256(abi.encode(_prevMsgSender, _l1Token, _amount)); - - emit LegacyDepositInitiated({ - chainId: ERA_CHAIN_ID, - l2DepositTxHash: txHash, - from: _prevMsgSender, - to: _l2Receiver, - l1Asset: _l1Token, - amount: _amount - }); - } - - /// @notice Finalizes the withdrawal for transactions initiated via the legacy ERC20 bridge. - /// @param _l2BatchNumber The L2 batch number where the withdrawal was processed. - /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. - /// @param _l2TxNumberInBatch The L2 transaction number in the batch, in which the log was sent. - /// @param _message The L2 withdraw data, stored in an L2 -> L1 message. - /// @param _merkleProof The Merkle proof of the inclusion L2 -> L1 message about withdrawal initialization. - /// - /// @return l1Receiver The address on L1 that will receive the withdrawn funds. - /// @return l1Asset The address of the L1 token being withdrawn. - /// @return amount The amount of the token being withdrawn. - function finalizeWithdrawalLegacyErc20Bridge( - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes calldata _message, - bytes32[] calldata _merkleProof - ) external override onlyLegacyBridge returns (address l1Receiver, address l1Asset, uint256 amount) { - bytes32 assetId; - (l1Receiver, assetId, amount) = _finalizeWithdrawal({ - _chainId: ERA_CHAIN_ID, - _l2BatchNumber: _l2BatchNumber, - _l2MessageIndex: _l2MessageIndex, - _l2TxNumberInBatch: _l2TxNumberInBatch, - _message: _message, - _merkleProof: _merkleProof - }); - l1Asset = nativeTokenVault.tokenAddress(assetId); - } - - /*////////////////////////////////////////////////////////////// - PAUSE - //////////////////////////////////////////////////////////////*/ - - /// @notice Pauses all functions marked with the `whenNotPaused` modifier. - function pause() external onlyOwner { - _pause(); - } - - /// @notice Unpauses the contract, allowing all functions marked with the `whenNotPaused` modifier to be called again. - function unpause() external onlyOwner { - _unpause(); - } -} diff --git a/l1-contracts/contracts/bridge/L1ERC20Bridge.sol b/l1-contracts/contracts/bridge/L1ERC20Bridge.sol index 39c8879b2..3eb231950 100644 --- a/l1-contracts/contracts/bridge/L1ERC20Bridge.sol +++ b/l1-contracts/contracts/bridge/L1ERC20Bridge.sol @@ -6,13 +6,15 @@ import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; import {IL1ERC20Bridge} from "./interfaces/IL1ERC20Bridge.sol"; -import {IL1AssetRouter} from "./interfaces/IL1AssetRouter.sol"; -import {IL1NativeTokenVault} from "./interfaces/IL1NativeTokenVault.sol"; +import {IL1Nullifier, FinalizeL1DepositParams} from "./interfaces/IL1Nullifier.sol"; +import {IL1NativeTokenVault} from "./ntv/IL1NativeTokenVault.sol"; +import {IL1AssetRouter} from "./asset-router/IL1AssetRouter.sol"; import {L2ContractHelper} from "../common/libraries/L2ContractHelper.sol"; import {ReentrancyGuard} from "../common/ReentrancyGuard.sol"; -import {Unauthorized, EmptyDeposit, TokensWithFeesNotSupported, WithdrawalAlreadyFinalized} from "../common/L1ContractErrors.sol"; +import {EmptyDeposit, WithdrawalAlreadyFinalized, TokensWithFeesNotSupported, ETHDepositNotSupported} from "../common/L1ContractErrors.sol"; +import {ETH_TOKEN_ADDRESS} from "../common/Config.sol"; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev @@ -23,10 +25,13 @@ contract L1ERC20Bridge is IL1ERC20Bridge, ReentrancyGuard { using SafeERC20 for IERC20; /// @dev The shared bridge that is now used for all bridging, replacing the legacy contract. - IL1AssetRouter public immutable override SHARED_BRIDGE; + IL1Nullifier public immutable override L1_NULLIFIER; + + /// @dev The asset router, which holds deposited tokens. + IL1AssetRouter public immutable override L1_ASSET_ROUTER; /// @dev The native token vault, which holds deposited tokens. - IL1NativeTokenVault public immutable override NATIVE_TOKEN_VAULT; + IL1NativeTokenVault public immutable override L1_NATIVE_TOKEN_VAULT; /// @dev The chainId of Era uint256 public immutable ERA_CHAIN_ID; @@ -66,30 +71,20 @@ contract L1ERC20Bridge is IL1ERC20Bridge, ReentrancyGuard { /// @dev Contract is expected to be used as proxy implementation. /// @dev Initialize the implementation to prevent Parity hack. constructor( - IL1AssetRouter _sharedBridge, + IL1Nullifier _nullifier, + IL1AssetRouter _assetRouter, IL1NativeTokenVault _nativeTokenVault, uint256 _eraChainId ) reentrancyGuardInitializer { - SHARED_BRIDGE = _sharedBridge; - NATIVE_TOKEN_VAULT = _nativeTokenVault; + L1_NULLIFIER = _nullifier; + L1_ASSET_ROUTER = _assetRouter; + L1_NATIVE_TOKEN_VAULT = _nativeTokenVault; ERA_CHAIN_ID = _eraChainId; } /// @dev Initializes the reentrancy guard. Expected to be used in the proxy. function initialize() external reentrancyGuardInitializer {} - /*////////////////////////////////////////////////////////////// - ERA LEGACY GETTERS - //////////////////////////////////////////////////////////////*/ - - /// @return The L2 token address that would be minted for deposit of the given L1 token on ZKsync Era. - function l2TokenAddress(address _l1Token) external view returns (address) { - bytes32 constructorInputHash = keccak256(abi.encode(l2TokenBeacon, "")); - bytes32 salt = bytes32(uint256(uint160(_l1Token))); - - return L2ContractHelper.computeCreate2Address(l2Bridge, salt, l2TokenProxyBytecodeHash, constructorInputHash); - } - /*////////////////////////////////////////////////////////////// ERA LEGACY FUNCTIONS //////////////////////////////////////////////////////////////*/ @@ -123,6 +118,36 @@ contract L1ERC20Bridge is IL1ERC20Bridge, ReentrancyGuard { }); } + /// @notice Finalize the withdrawal and release funds + /// @param _l2BatchNumber The L2 batch number where the withdrawal was processed + /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message + /// @param _l2TxNumberInBatch The L2 transaction number in the batch, in which the log was sent + /// @param _message The L2 withdraw data, stored in an L2 -> L1 message + /// @param _merkleProof The Merkle proof of the inclusion L2 -> L1 message about withdrawal initialization + function finalizeWithdrawal( + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes calldata _message, + bytes32[] calldata _merkleProof + ) external nonReentrant { + if (isWithdrawalFinalized[_l2BatchNumber][_l2MessageIndex]) { + revert WithdrawalAlreadyFinalized(); + } + // We don't need to set finalizeWithdrawal here, as we set it in the shared bridge + + FinalizeL1DepositParams memory finalizeWithdrawalParams = FinalizeL1DepositParams({ + chainId: ERA_CHAIN_ID, + l2BatchNumber: _l2BatchNumber, + l2MessageIndex: _l2MessageIndex, + l2Sender: l2Bridge, + l2TxNumberInBatch: _l2TxNumberInBatch, + message: _message, + merkleProof: _merkleProof + }); + L1_NULLIFIER.finalizeDeposit(finalizeWithdrawalParams); + } + /// @notice Initiates a deposit by locking funds on the contract and sending the request /// @dev Initiates a deposit by locking funds on the contract and sending the request /// of processing an L2 transaction where tokens would be minted @@ -156,18 +181,21 @@ contract L1ERC20Bridge is IL1ERC20Bridge, ReentrancyGuard { uint256 _l2TxGasPerPubdataByte, address _refundRecipient ) public payable nonReentrant returns (bytes32 l2TxHash) { - // empty deposit if (_amount == 0) { + // empty deposit amount revert EmptyDeposit(); } - uint256 amount = _depositFundsToSharedBridge(msg.sender, IERC20(_l1Token), _amount); - // The token has non-standard transfer logic + if (_l1Token == ETH_TOKEN_ADDRESS) { + revert ETHDepositNotSupported(); + } + uint256 amount = _depositFundsToAssetRouter(msg.sender, IERC20(_l1Token), _amount); if (amount != _amount) { + // The token has non-standard transfer logic revert TokensWithFeesNotSupported(); } - l2TxHash = SHARED_BRIDGE.depositLegacyErc20Bridge{value: msg.value}({ - _prevMsgSender: msg.sender, + l2TxHash = L1_ASSET_ROUTER.depositLegacyErc20Bridge{value: msg.value}({ + _originalCaller: msg.sender, _l2Receiver: _l2Receiver, _l1Token: _l1Token, _amount: _amount, @@ -185,12 +213,16 @@ contract L1ERC20Bridge is IL1ERC20Bridge, ReentrancyGuard { }); } - /// @dev Transfers tokens from the depositor address to the shared bridge address. + /*////////////////////////////////////////////////////////////// + ERA LEGACY FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @dev Transfers tokens from the depositor address to the native token vault address. /// @return The difference between the contract balance before and after the transferring of funds. - function _depositFundsToSharedBridge(address _from, IERC20 _token, uint256 _amount) internal returns (uint256) { - uint256 balanceBefore = _token.balanceOf(address(SHARED_BRIDGE)); - _token.safeTransferFrom(_from, address(SHARED_BRIDGE), _amount); - uint256 balanceAfter = _token.balanceOf(address(SHARED_BRIDGE)); + function _depositFundsToAssetRouter(address _from, IERC20 _token, uint256 _amount) internal returns (uint256) { + uint256 balanceBefore = _token.balanceOf(address(L1_ASSET_ROUTER)); + _token.safeTransferFrom(_from, address(L1_ASSET_ROUTER), _amount); + uint256 balanceAfter = _token.balanceOf(address(L1_ASSET_ROUTER)); return balanceAfter - balanceBefore; } @@ -219,8 +251,7 @@ contract L1ERC20Bridge is IL1ERC20Bridge, ReentrancyGuard { } delete depositAmount[_depositSender][_l1Token][_l2TxHash]; - SHARED_BRIDGE.claimFailedDeposit({ - _chainId: ERA_CHAIN_ID, + L1_NULLIFIER.claimFailedDepositLegacyErc20Bridge({ _depositSender: _depositSender, _l1Token: _l1Token, _amount: amount, @@ -234,34 +265,13 @@ contract L1ERC20Bridge is IL1ERC20Bridge, ReentrancyGuard { } /*////////////////////////////////////////////////////////////// - ERA LEGACY FUNCTIONS + ERA LEGACY GETTERS //////////////////////////////////////////////////////////////*/ - /// @notice Finalize the withdrawal and release funds - /// @param _l2BatchNumber The L2 batch number where the withdrawal was processed - /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message - /// @param _l2TxNumberInBatch The L2 transaction number in the batch, in which the log was sent - /// @param _message The L2 withdraw data, stored in an L2 -> L1 message - /// @param _merkleProof The Merkle proof of the inclusion L2 -> L1 message about withdrawal initialization - function finalizeWithdrawal( - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes calldata _message, - bytes32[] calldata _merkleProof - ) external nonReentrant { - if (isWithdrawalFinalized[_l2BatchNumber][_l2MessageIndex]) { - revert WithdrawalAlreadyFinalized(); - } - // We don't need to set finalizeWithdrawal here, as we set it in the shared bridge - - (address l1Receiver, address l1Token, uint256 amount) = SHARED_BRIDGE.finalizeWithdrawalLegacyErc20Bridge({ - _l2BatchNumber: _l2BatchNumber, - _l2MessageIndex: _l2MessageIndex, - _l2TxNumberInBatch: _l2TxNumberInBatch, - _message: _message, - _merkleProof: _merkleProof - }); - emit WithdrawalFinalized(l1Receiver, l1Token, amount); + /// @return The L2 token address that would be minted for deposit of the given L1 token on ZKsync Era. + function l2TokenAddress(address _l1Token) external view returns (address) { + bytes32 constructorInputHash = keccak256(abi.encode(l2TokenBeacon, "")); + bytes32 salt = bytes32(uint256(uint160(_l1Token))); + return L2ContractHelper.computeCreate2Address(l2Bridge, salt, l2TokenProxyBytecodeHash, constructorInputHash); } } diff --git a/l1-contracts/contracts/bridge/L1NativeTokenVault.sol b/l1-contracts/contracts/bridge/L1NativeTokenVault.sol deleted file mode 100644 index fba532597..000000000 --- a/l1-contracts/contracts/bridge/L1NativeTokenVault.sol +++ /dev/null @@ -1,259 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -// solhint-disable reason-string, gas-custom-errors - -import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; -import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/security/PausableUpgradeable.sol"; - -import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; -import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; - -import {IL1NativeTokenVault} from "./interfaces/IL1NativeTokenVault.sol"; -import {IL1AssetHandler} from "./interfaces/IL1AssetHandler.sol"; - -import {IL1AssetRouter} from "./interfaces/IL1AssetRouter.sol"; -import {ETH_TOKEN_ADDRESS} from "../common/Config.sol"; -import {DataEncoding} from "../common/libraries/DataEncoding.sol"; - -import {BridgeHelper} from "./BridgeHelper.sol"; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -/// @dev Vault holding L1 native ETH and ERC20 tokens bridged into the ZK chains. -/// @dev Designed for use with a proxy for upgradability. -contract L1NativeTokenVault is IL1NativeTokenVault, IL1AssetHandler, Ownable2StepUpgradeable, PausableUpgradeable { - using SafeERC20 for IERC20; - - /// @dev The address of the WETH token on L1. - address public immutable override L1_WETH_TOKEN; - - /// @dev L1 Shared Bridge smart contract that handles communication with its counterparts on L2s - IL1AssetRouter public immutable override L1_SHARED_BRIDGE; - - /// @dev Maps token balances for each chain to prevent unauthorized spending across ZK chains. - /// This serves as a security measure until hyperbridging is implemented. - /// NOTE: this function may be removed in the future, don't rely on it! - mapping(uint256 chainId => mapping(address l1Token => uint256 balance)) public chainBalance; - - /// @dev A mapping assetId => tokenAddress - mapping(bytes32 assetId => address tokenAddress) public tokenAddress; - - /// @notice Checks that the message sender is the bridge. - modifier onlyBridge() { - require(msg.sender == address(L1_SHARED_BRIDGE), "NTV not ShB"); - _; - } - - /// @dev Contract is expected to be used as proxy implementation. - /// @dev Initialize the implementation to prevent Parity hack. - constructor(address _l1WethAddress, IL1AssetRouter _l1SharedBridge) { - _disableInitializers(); - L1_WETH_TOKEN = _l1WethAddress; - L1_SHARED_BRIDGE = _l1SharedBridge; - } - - /// @dev Accepts ether only from the Shared Bridge. - receive() external payable { - require(address(L1_SHARED_BRIDGE) == msg.sender, "NTV: ETH only accepted from Shared Bridge"); - } - - /// @dev Initializes a contract for later use. Expected to be used in the proxy - /// @param _owner Address which can change pause / unpause the NTV - /// implementation. The owner is the Governor and separate from the ProxyAdmin from now on, so that the Governor can call the bridge. - function initialize(address _owner) external initializer { - require(_owner != address(0), "NTV owner 0"); - _transferOwnership(_owner); - } - - /// @notice Transfers tokens from shared bridge as part of the migration process. - /// @dev Both ETH and ERC20 tokens can be transferred. Exhausts balance of shared bridge after the first call. - /// @dev Calling second time for the same token will revert. - /// @param _token The address of token to be transferred (address(1) for ether and contract address for ERC20). - function transferFundsFromSharedBridge(address _token) external { - if (_token == ETH_TOKEN_ADDRESS) { - uint256 balanceBefore = address(this).balance; - L1_SHARED_BRIDGE.transferTokenToNTV(_token); - uint256 balanceAfter = address(this).balance; - require(balanceAfter > balanceBefore, "NTV: 0 eth transferred"); - } else { - uint256 balanceBefore = IERC20(_token).balanceOf(address(this)); - uint256 sharedBridgeChainBalance = IERC20(_token).balanceOf(address(L1_SHARED_BRIDGE)); - require(sharedBridgeChainBalance > 0, "NTV: 0 amount to transfer"); - L1_SHARED_BRIDGE.transferTokenToNTV(_token); - uint256 balanceAfter = IERC20(_token).balanceOf(address(this)); - require(balanceAfter - balanceBefore >= sharedBridgeChainBalance, "NTV: wrong amount transferred"); - } - } - - /// @notice Updates chain token balance within NTV to account for tokens transferred from the shared bridge (part of the migration process). - /// @dev Clears chain balance on the shared bridge after the first call. Subsequent calls will not affect the state. - /// @param _token The address of token to be transferred (address(1) for ether and contract address for ERC20). - /// @param _targetChainId The chain ID of the corresponding ZK chain. - function updateChainBalancesFromSharedBridge(address _token, uint256 _targetChainId) external { - uint256 sharedBridgeChainBalance = L1_SHARED_BRIDGE.chainBalance(_targetChainId, _token); - chainBalance[_targetChainId][_token] = chainBalance[_targetChainId][_token] + sharedBridgeChainBalance; - L1_SHARED_BRIDGE.nullifyChainBalanceByNTV(_targetChainId, _token); - } - - /// @notice Registers tokens within the NTV. - /// @dev The goal was to allow bridging L1 native tokens automatically, by registering them on the fly. - /// @notice Allows the bridge to register a token address for the vault. - /// @notice No access control is ok, since the bridging of tokens should be permissionless. This requires permissionless registration. - function registerToken(address _l1Token) external { - require(_l1Token != L1_WETH_TOKEN, "NTV: WETH deposit not supported"); - require(_l1Token == ETH_TOKEN_ADDRESS || _l1Token.code.length > 0, "NTV: empty token"); - bytes32 assetId = DataEncoding.encodeNTVAssetId(block.chainid, _l1Token); - L1_SHARED_BRIDGE.setAssetHandlerAddressInitial(bytes32(uint256(uint160(_l1Token))), address(this)); - tokenAddress[assetId] = _l1Token; - } - - /// @inheritdoc IL1AssetHandler - function bridgeMint( - uint256 _chainId, - bytes32 _assetId, - bytes calldata _data - ) external payable override onlyBridge whenNotPaused returns (address l1Receiver) { - // here we are minting the tokens after the bridgeBurn has happened on an L2, so we can assume the l1Token is not zero - address l1Token = tokenAddress[_assetId]; - uint256 amount; - (amount, l1Receiver) = abi.decode(_data, (uint256, address)); - // Check that the chain has sufficient balance - require(chainBalance[_chainId][l1Token] >= amount, "NTV: not enough funds"); // not enough funds - chainBalance[_chainId][l1Token] -= amount; - - if (l1Token == ETH_TOKEN_ADDRESS) { - bool callSuccess; - // Low-level assembly call, to avoid any memory copying (save gas) - assembly { - callSuccess := call(gas(), l1Receiver, amount, 0, 0, 0, 0) - } - require(callSuccess, "NTV: withdrawal failed, no funds or cannot transfer to receiver"); - } else { - // Withdraw funds - IERC20(l1Token).safeTransfer(l1Receiver, amount); - } - emit BridgeMint(_chainId, _assetId, l1Receiver, amount); - } - - /// @inheritdoc IL1AssetHandler - /// @notice Allows bridgehub to acquire mintValue for L1->L2 transactions. - /// @dev In case of native token vault _data is the tuple of _depositAmount and _l2Receiver. - function bridgeBurn( - uint256 _chainId, - uint256, - bytes32 _assetId, - address _prevMsgSender, - bytes calldata _data - ) external payable override onlyBridge whenNotPaused returns (bytes memory _bridgeMintData) { - (uint256 _depositAmount, address _l2Receiver) = abi.decode(_data, (uint256, address)); - - uint256 amount; - address l1Token = tokenAddress[_assetId]; - if (l1Token == ETH_TOKEN_ADDRESS) { - amount = msg.value; - - // In the old SDK/contracts the user had to always provide `0` as the deposit amount for ETH token, while - // ultimately the provided `msg.value` was used as the deposit amount. This check is needed for backwards compatibility. - if (_depositAmount == 0) { - _depositAmount = amount; - } - - require(_depositAmount == amount, "L1NTV: msg.value not equal to amount"); - } else { - // The Bridgehub also checks this, but we want to be sure - require(msg.value == 0, "NTV m.v > 0 b d.it"); - amount = _depositAmount; - - uint256 expectedDepositAmount = _depositFunds(_prevMsgSender, IERC20(l1Token), _depositAmount); // note if _prevMsgSender is this contract, this will return 0. This does not happen. - require(expectedDepositAmount == _depositAmount, "5T"); // The token has non-standard transfer logic - } - require(amount != 0, "6T"); // empty deposit amount - - chainBalance[_chainId][l1Token] += amount; - - _bridgeMintData = DataEncoding.encodeBridgeMintData({ - _prevMsgSender: _prevMsgSender, - _l2Receiver: _l2Receiver, - _l1Token: l1Token, - _amount: amount, - _erc20Metadata: getERC20Getters(l1Token) - }); - - emit BridgeBurn({ - chainId: _chainId, - assetId: _assetId, - l1Sender: _prevMsgSender, - l2receiver: _l2Receiver, - amount: amount - }); - } - - /// @inheritdoc IL1AssetHandler - function bridgeRecoverFailedTransfer( - uint256 _chainId, - bytes32 _assetId, - address _depositSender, - bytes calldata _data - ) external payable override onlyBridge whenNotPaused { - (uint256 _amount, ) = abi.decode(_data, (uint256, address)); - address l1Token = tokenAddress[_assetId]; - require(_amount > 0, "y1"); - - // check that the chain has sufficient balance - require(chainBalance[_chainId][l1Token] >= _amount, "NTV: not enough funds 2"); - chainBalance[_chainId][l1Token] -= _amount; - - if (l1Token == ETH_TOKEN_ADDRESS) { - bool callSuccess; - // Low-level assembly call, to avoid any memory copying (save gas) - assembly { - callSuccess := call(gas(), _depositSender, _amount, 0, 0, 0, 0) - } - require(callSuccess, "NTV: claimFailedDeposit failed, no funds or cannot transfer to receiver"); - } else { - IERC20(l1Token).safeTransfer(_depositSender, _amount); - // Note we don't allow weth deposits anymore, but there might be legacy weth deposits. - // until we add Weth bridging capabilities, we don't wrap/unwrap weth to ether. - } - } - - /// @dev Receives and parses (name, symbol, decimals) from the token contract - function getERC20Getters(address _token) public view returns (bytes memory) { - return BridgeHelper.getERC20Getters(_token, ETH_TOKEN_ADDRESS); - } - - /// @dev Transfers tokens from the depositor address to the smart contract address. - /// @return The difference between the contract balance before and after the transferring of funds. - function _depositFunds(address _from, IERC20 _token, uint256 _amount) internal returns (uint256) { - uint256 balanceBefore = _token.balanceOf(address(this)); - address from = _from; - // in the legacy scenario the SharedBridge was granting the allowance, we have to transfer from them instead of the user - if ( - _token.allowance(address(L1_SHARED_BRIDGE), address(this)) >= _amount && - _token.allowance(_from, address(this)) < _amount - ) { - from = address(L1_SHARED_BRIDGE); - } - // slither-disable-next-line arbitrary-send-erc20 - _token.safeTransferFrom(from, address(this), _amount); - uint256 balanceAfter = _token.balanceOf(address(this)); - - return balanceAfter - balanceBefore; - } - - /*////////////////////////////////////////////////////////////// - PAUSE - //////////////////////////////////////////////////////////////*/ - - /// @notice Pauses all functions marked with the `whenNotPaused` modifier. - function pause() external onlyOwner { - _pause(); - } - - /// @notice Unpauses the contract, allowing all functions marked with the `whenNotPaused` modifier to be called again. - function unpause() external onlyOwner { - _unpause(); - } -} diff --git a/l1-contracts/contracts/bridge/L1Nullifier.sol b/l1-contracts/contracts/bridge/L1Nullifier.sol new file mode 100644 index 000000000..789f122df --- /dev/null +++ b/l1-contracts/contracts/bridge/L1Nullifier.sol @@ -0,0 +1,726 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +// solhint-disable reason-string, gas-custom-errors + +import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; +import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/security/PausableUpgradeable.sol"; + +import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; +import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; + +import {NEW_ENCODING_VERSION, LEGACY_ENCODING_VERSION} from "./asset-router/IAssetRouterBase.sol"; +import {IL1NativeTokenVault} from "./ntv/IL1NativeTokenVault.sol"; + +import {IL1ERC20Bridge} from "./interfaces/IL1ERC20Bridge.sol"; +import {IL1AssetRouter} from "./asset-router/IL1AssetRouter.sol"; +import {IAssetRouterBase} from "./asset-router/IAssetRouterBase.sol"; +import {INativeTokenVault} from "./ntv/INativeTokenVault.sol"; + +import {IL1Nullifier, FinalizeL1DepositParams} from "./interfaces/IL1Nullifier.sol"; + +import {IGetters} from "../state-transition/chain-interfaces/IGetters.sol"; +import {IMailbox} from "../state-transition/chain-interfaces/IMailbox.sol"; +import {L2Message, TxStatus} from "../common/Messaging.sol"; +import {UnsafeBytes} from "../common/libraries/UnsafeBytes.sol"; +import {ReentrancyGuard} from "../common/ReentrancyGuard.sol"; +import {ETH_TOKEN_ADDRESS} from "../common/Config.sol"; +import {DataEncoding} from "../common/libraries/DataEncoding.sol"; + +import {IBridgehub} from "../bridgehub/IBridgehub.sol"; +import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR, L2_ASSET_ROUTER_ADDR} from "../common/L2ContractAddresses.sol"; +import {DataEncoding} from "../common/libraries/DataEncoding.sol"; +import {Unauthorized, SharedBridgeKey, DepositExists, AddressAlreadySet, InvalidProof, DepositDoesNotExist, SharedBridgeValueNotSet, WithdrawalAlreadyFinalized, L2WithdrawalMessageWrongLength, InvalidSelector, SharedBridgeValueNotSet, ZeroAddress} from "../common/L1ContractErrors.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @dev Bridges assets between L1 and ZK chain, supporting both ETH and ERC20 tokens. +/// @dev Designed for use with a proxy for upgradability. +contract L1Nullifier is IL1Nullifier, ReentrancyGuard, Ownable2StepUpgradeable, PausableUpgradeable { + using SafeERC20 for IERC20; + + /// @dev Bridgehub smart contract that is used to operate with L2 via asynchronous L2 <-> L1 communication. + IBridgehub public immutable override BRIDGE_HUB; + + /// @dev Era's chainID + uint256 internal immutable ERA_CHAIN_ID; + + /// @dev The address of ZKsync Era diamond proxy contract. + address internal immutable ERA_DIAMOND_PROXY; + + /// @dev Stores the first batch number on the ZKsync Era Diamond Proxy that was settled after Diamond proxy upgrade. + /// This variable is used to differentiate between pre-upgrade and post-upgrade Eth withdrawals. Withdrawals from batches older + /// than this value are considered to have been finalized prior to the upgrade and handled separately. + uint256 internal eraPostDiamondUpgradeFirstBatch; + + /// @dev Stores the first batch number on the ZKsync Era Diamond Proxy that was settled after L1ERC20 Bridge upgrade. + /// This variable is used to differentiate between pre-upgrade and post-upgrade ERC20 withdrawals. Withdrawals from batches older + /// than this value are considered to have been finalized prior to the upgrade and handled separately. + uint256 internal eraPostLegacyBridgeUpgradeFirstBatch; + + /// @dev Stores the ZKsync Era batch number that processes the last deposit tx initiated by the legacy bridge + /// This variable (together with eraLegacyBridgeLastDepositTxNumber) is used to differentiate between pre-upgrade and post-upgrade deposits. Deposits processed in older batches + /// than this value are considered to have been processed prior to the upgrade and handled separately. + /// We use this both for Eth and erc20 token deposits, so we need to update the diamond and bridge simultaneously. + uint256 internal eraLegacyBridgeLastDepositBatch; + + /// @dev The tx number in the _eraLegacyBridgeLastDepositBatch of the last deposit tx initiated by the legacy bridge. + /// This variable (together with eraLegacyBridgeLastDepositBatch) is used to differentiate between pre-upgrade and post-upgrade deposits. Deposits processed in older txs + /// than this value are considered to have been processed prior to the upgrade and handled separately. + /// We use this both for Eth and erc20 token deposits, so we need to update the diamond and bridge simultaneously. + uint256 internal eraLegacyBridgeLastDepositTxNumber; + + /// @dev Legacy bridge smart contract that used to hold ERC20 tokens. + IL1ERC20Bridge public override legacyBridge; + + /// @dev A mapping chainId => bridgeProxy. Used to store the bridge proxy's address, and to see if it has been deployed yet. + // slither-disable-next-line uninitialized-state + mapping(uint256 chainId => address l2Bridge) public __DEPRECATED_l2BridgeAddress; + + /// @dev A mapping chainId => L2 deposit transaction hash => dataHash + // keccak256(abi.encode(account, tokenAddress, amount)) for legacy transfers + // keccak256(abi.encode(_originalCaller, assetId, transferData)) for new transfers + /// @dev Tracks deposit transactions to L2 to enable users to claim their funds if a deposit fails. + mapping(uint256 chainId => mapping(bytes32 l2DepositTxHash => bytes32 depositDataHash)) + public + override depositHappened; + + /// @dev Tracks the processing status of L2 to L1 messages, indicating whether a message has already been finalized. + mapping(uint256 chainId => mapping(uint256 l2BatchNumber => mapping(uint256 l2ToL1MessageNumber => bool isFinalized))) + public isWithdrawalFinalized; + + /// @notice Deprecated. Kept for backwards compatibility. + /// @dev Indicates whether the hyperbridging is enabled for a given chain. + // slither-disable-next-line uninitialized-state + mapping(uint256 chainId => bool enabled) private __DEPRECATED_hyperbridgingEnabled; + + /// @dev Maps token balances for each chain to prevent unauthorized spending across ZK chain. + /// This serves as a security measure until hyperbridging is implemented. + /// NOTE: this function may be removed in the future, don't rely on it! + mapping(uint256 chainId => mapping(address l1Token => uint256 balance)) public __DEPRECATED_chainBalance; + + /// @dev Address of L1 asset router. + IL1AssetRouter public l1AssetRouter; + + /// @dev Address of native token vault. + IL1NativeTokenVault public l1NativeTokenVault; + + /// @notice Checks that the message sender is the asset router.. + modifier onlyAssetRouter() { + if (msg.sender != address(l1AssetRouter)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @notice Checks that the message sender is the native token vault. + modifier onlyL1NTV() { + if (msg.sender != address(l1NativeTokenVault)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @notice Checks that the message sender is the bridgehub or ZKsync Era Diamond Proxy. + modifier onlyBridgehubOrEra(uint256 _chainId) { + if (msg.sender != address(BRIDGE_HUB) && (_chainId != ERA_CHAIN_ID || msg.sender != ERA_DIAMOND_PROXY)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @notice Checks that the message sender is the legacy bridge. + modifier onlyLegacyBridge() { + if (msg.sender != address(legacyBridge)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @notice Checks that the message sender is the legacy bridge. + modifier onlyAssetRouterOrErc20Bridge() { + if (msg.sender != address(l1AssetRouter) && msg.sender != address(legacyBridge)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @dev Contract is expected to be used as proxy implementation. + /// @dev Initialize the implementation to prevent Parity hack. + constructor(IBridgehub _bridgehub, uint256 _eraChainId, address _eraDiamondProxy) reentrancyGuardInitializer { + _disableInitializers(); + BRIDGE_HUB = _bridgehub; + ERA_CHAIN_ID = _eraChainId; + ERA_DIAMOND_PROXY = _eraDiamondProxy; + } + + /// @dev Initializes a contract bridge for later use. Expected to be used in the proxy. + /// @dev Used for testing purposes only, as the contract has been initialized on mainnet. + /// @param _owner The address which can change L2 token implementation and upgrade the bridge implementation. + /// The owner is the Governor and separate from the ProxyAdmin from now on, so that the Governor can call the bridge. + /// @param _eraPostDiamondUpgradeFirstBatch The first batch number on the ZKsync Era Diamond Proxy that was settled after diamond proxy upgrade. + /// @param _eraPostLegacyBridgeUpgradeFirstBatch The first batch number on the ZKsync Era Diamond Proxy that was settled after legacy bridge upgrade. + /// @param _eraLegacyBridgeLastDepositBatch The the ZKsync Era batch number that processes the last deposit tx initiated by the legacy bridge. + /// @param _eraLegacyBridgeLastDepositTxNumber The tx number in the _eraLegacyBridgeLastDepositBatch of the last deposit tx initiated by the legacy bridge. + function initialize( + address _owner, + uint256 _eraPostDiamondUpgradeFirstBatch, + uint256 _eraPostLegacyBridgeUpgradeFirstBatch, + uint256 _eraLegacyBridgeLastDepositBatch, + uint256 _eraLegacyBridgeLastDepositTxNumber + ) external reentrancyGuardInitializer initializer { + if (_owner == address(0)) { + revert ZeroAddress(); + } + _transferOwnership(_owner); + if (eraPostDiamondUpgradeFirstBatch == 0) { + eraPostDiamondUpgradeFirstBatch = _eraPostDiamondUpgradeFirstBatch; + eraPostLegacyBridgeUpgradeFirstBatch = _eraPostLegacyBridgeUpgradeFirstBatch; + eraLegacyBridgeLastDepositBatch = _eraLegacyBridgeLastDepositBatch; + eraLegacyBridgeLastDepositTxNumber = _eraLegacyBridgeLastDepositTxNumber; + } + } + + /// @notice Transfers tokens from shared bridge to native token vault. + /// @dev This function is part of the upgrade process used to transfer liquidity. + /// @param _token The address of the token to be transferred to NTV. + function transferTokenToNTV(address _token) external onlyL1NTV { + address ntvAddress = address(l1NativeTokenVault); + if (ETH_TOKEN_ADDRESS == _token) { + uint256 amount = address(this).balance; + bool callSuccess; + // Low-level assembly call, to avoid any memory copying (save gas) + assembly { + callSuccess := call(gas(), ntvAddress, amount, 0, 0, 0, 0) + } + require(callSuccess, "L1N: eth transfer failed"); + } else { + IERC20(_token).safeTransfer(ntvAddress, IERC20(_token).balanceOf(address(this))); + } + } + + /// @notice Clears chain balance for specific token. + /// @dev This function is part of the upgrade process used to nullify chain balances once they are credited to NTV. + /// @param _chainId The ID of the ZK chain. + /// @param _token The address of the token which was previously deposit to shared bridge. + function nullifyChainBalanceByNTV(uint256 _chainId, address _token) external { + require(msg.sender == address(l1NativeTokenVault), "L1N: not NTV"); + __DEPRECATED_chainBalance[_chainId][_token] = 0; + } + + /// @notice Legacy function used for migration, do not use! + /// @param _chainId The chain id on which the bridge is deployed. + // slither-disable-next-line uninitialized-state-variables + function l2BridgeAddress(uint256 _chainId) external view returns (address) { + // slither-disable-next-line uninitialized-state-variables + return __DEPRECATED_l2BridgeAddress[_chainId]; + } + + /// @notice Sets the L1ERC20Bridge contract address. + /// @dev Should be called only once by the owner. + /// @param _legacyBridge The address of the legacy bridge. + function setL1Erc20Bridge(IL1ERC20Bridge _legacyBridge) external onlyOwner { + if (address(legacyBridge) != address(0)) { + revert AddressAlreadySet(address(legacyBridge)); + } + if (address(_legacyBridge) == address(0)) { + revert ZeroAddress(); + } + legacyBridge = _legacyBridge; + } + + /// @notice Sets the nativeTokenVault contract address. + /// @dev Should be called only once by the owner. + /// @param _l1NativeTokenVault The address of the native token vault. + function setL1NativeTokenVault(IL1NativeTokenVault _l1NativeTokenVault) external onlyOwner { + require(address(l1NativeTokenVault) == address(0), "L1N: native token vault already set"); + require(address(_l1NativeTokenVault) != address(0), "L1N: native token vault 0"); + l1NativeTokenVault = _l1NativeTokenVault; + } + + /// @notice Sets the L1 asset router contract address. + /// @dev Should be called only once by the owner. + /// @param _l1AssetRouter The address of the asset router. + function setL1AssetRouter(address _l1AssetRouter) external onlyOwner { + if (address(l1AssetRouter) != address(0)) { + revert AddressAlreadySet(address(_l1AssetRouter)); + } + require(_l1AssetRouter != address(0), "ShB: nullifier 0"); + l1AssetRouter = IL1AssetRouter(_l1AssetRouter); + } + + /// @notice Confirms the acceptance of a transaction by the Mailbox, as part of the L2 transaction process within Bridgehub. + /// This function is utilized by `requestL2TransactionTwoBridges` to validate the execution of a transaction. + /// @param _chainId The chain ID of the ZK chain to which confirm the deposit. + /// @param _txDataHash The keccak256 hash of 0x01 || abi.encode(bytes32, bytes) to identify deposits. + /// @param _txHash The hash of the L1->L2 transaction to confirm the deposit. + function bridgehubConfirmL2TransactionForwarded( + uint256 _chainId, + bytes32 _txDataHash, + bytes32 _txHash + ) external override onlyAssetRouter whenNotPaused { + if (depositHappened[_chainId][_txHash] != 0x00) { + revert DepositExists(); + } + depositHappened[_chainId][_txHash] = _txDataHash; + emit BridgehubDepositFinalized(_chainId, _txDataHash, _txHash); + } + + /// @dev Calls the internal `_encodeTxDataHash`. Used as a wrapped for try / catch case. + /// @dev Encodes the transaction data hash using either the latest encoding standard or the legacy standard. + /// @param _encodingVersion EncodingVersion. + /// @param _originalCaller The address of the entity that initiated the deposit. + /// @param _assetId The unique identifier of the deposited L1 token. + /// @param _transferData The encoded transfer data, which includes both the deposit amount and the address of the L2 receiver. + /// @return txDataHash The resulting encoded transaction data hash. + function encodeTxDataHash( + bytes1 _encodingVersion, + address _originalCaller, + bytes32 _assetId, + bytes calldata _transferData + ) external view returns (bytes32 txDataHash) { + txDataHash = DataEncoding.encodeTxDataHash({ + _encodingVersion: _encodingVersion, + _originalCaller: _originalCaller, + _assetId: _assetId, + _nativeTokenVault: address(l1NativeTokenVault), + _transferData: _transferData + }); + } + + /// @inheritdoc IL1Nullifier + function bridgeRecoverFailedTransfer( + uint256 _chainId, + address _depositSender, + bytes32 _assetId, + bytes memory _assetData, + bytes32 _l2TxHash, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes32[] calldata _merkleProof + ) public nonReentrant { + _verifyAndClearFailedTransfer({ + _checkedInLegacyBridge: false, + _chainId: _chainId, + _depositSender: _depositSender, + _assetId: _assetId, + _assetData: _assetData, + _l2TxHash: _l2TxHash, + _l2BatchNumber: _l2BatchNumber, + _l2MessageIndex: _l2MessageIndex, + _l2TxNumberInBatch: _l2TxNumberInBatch, + _merkleProof: _merkleProof + }); + + l1AssetRouter.bridgeRecoverFailedTransfer(_chainId, _depositSender, _assetId, _assetData); + } + + /// @dev Withdraw funds from the initiated deposit, that failed when finalizing on L2. + /// @param _chainId The ZK chain id to which deposit was initiated. + /// @param _depositSender The address of the entity that initiated the deposit. + /// @param _assetId The unique identifier of the deposited L1 token. + /// @param _assetData The encoded data, which is used by the asset handler to determine L2 recipient and amount. Might include extra information. + /// @param _l2TxHash The L2 transaction hash of the failed deposit finalization. + /// @param _l2BatchNumber The L2 batch number where the deposit finalization was processed. + /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. + /// @param _l2TxNumberInBatch The L2 transaction number in a batch, in which the log was sent. + /// @param _merkleProof The Merkle proof of the processing L1 -> L2 transaction with deposit finalization. + /// @dev Processes claims of failed deposit, whether they originated from the legacy bridge or the current system. + function _verifyAndClearFailedTransfer( + bool _checkedInLegacyBridge, + uint256 _chainId, + address _depositSender, + bytes32 _assetId, + bytes memory _assetData, + bytes32 _l2TxHash, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes32[] calldata _merkleProof + ) internal whenNotPaused { + { + bool proofValid = BRIDGE_HUB.proveL1ToL2TransactionStatus({ + _chainId: _chainId, + _l2TxHash: _l2TxHash, + _l2BatchNumber: _l2BatchNumber, + _l2MessageIndex: _l2MessageIndex, + _l2TxNumberInBatch: _l2TxNumberInBatch, + _merkleProof: _merkleProof, + _status: TxStatus.Failure + }); + if (!proofValid) { + revert InvalidProof(); + } + } + + bool notCheckedInLegacyBridgeOrWeCanCheckDeposit; + { + // Deposits that happened before the upgrade cannot be checked here, they have to be claimed and checked in the legacyBridge + bool weCanCheckDepositHere = !_isPreSharedBridgeDepositOnEra(_chainId, _l2BatchNumber, _l2TxNumberInBatch); + // Double claims are not possible, as depositHappened is checked here for all except legacy deposits (which have to happen through the legacy bridge) + // Funds claimed before the update will still be recorded in the legacy bridge + // Note we double check NEW deposits if they are called from the legacy bridge + notCheckedInLegacyBridgeOrWeCanCheckDeposit = (!_checkedInLegacyBridge) || weCanCheckDepositHere; + } + + if (notCheckedInLegacyBridgeOrWeCanCheckDeposit) { + bytes32 dataHash = depositHappened[_chainId][_l2TxHash]; + // Determine if the given dataHash matches the calculated legacy transaction hash. + bool isLegacyTxDataHash = _isLegacyTxDataHash(_depositSender, _assetId, _assetData, dataHash); + // If the dataHash matches the legacy transaction hash, skip the next step. + // Otherwise, perform the check using the new transaction data hash encoding. + if (!isLegacyTxDataHash) { + bytes32 txDataHash = DataEncoding.encodeTxDataHash({ + _encodingVersion: NEW_ENCODING_VERSION, + _originalCaller: _depositSender, + _assetId: _assetId, + _nativeTokenVault: address(l1NativeTokenVault), + _transferData: _assetData + }); + if (dataHash != txDataHash) { + revert DepositDoesNotExist(); + } + } + } + delete depositHappened[_chainId][_l2TxHash]; + } + + /// @notice Finalize the withdrawal and release funds. + /// @param _finalizeWithdrawalParams The structure that holds all necessary data to finalize withdrawal + /// @dev We have both the legacy finalizeWithdrawal and the new finalizeDeposit functions, + /// finalizeDeposit uses the new format. On the L2 we have finalizeDeposit with new and old formats both. + function finalizeDeposit(FinalizeL1DepositParams calldata _finalizeWithdrawalParams) external { + _finalizeDeposit(_finalizeWithdrawalParams); + } + + /// @notice Internal function that handles the logic for finalizing withdrawals, supporting both the current bridge system and the legacy ERC20 bridge. + /// @param _finalizeWithdrawalParams The structure that holds all necessary data to finalize withdrawal + function _finalizeDeposit( + FinalizeL1DepositParams calldata _finalizeWithdrawalParams + ) internal nonReentrant whenNotPaused { + uint256 chainId = _finalizeWithdrawalParams.chainId; + uint256 l2BatchNumber = _finalizeWithdrawalParams.l2BatchNumber; + uint256 l2MessageIndex = _finalizeWithdrawalParams.l2MessageIndex; + if (isWithdrawalFinalized[chainId][l2BatchNumber][l2MessageIndex]) { + revert WithdrawalAlreadyFinalized(); + } + isWithdrawalFinalized[chainId][l2BatchNumber][l2MessageIndex] = true; + + // Handling special case for withdrawal from ZKsync Era initiated before Shared Bridge. + (bytes32 assetId, bytes memory transferData) = _verifyWithdrawal(_finalizeWithdrawalParams); + + // Handling special case for withdrawal from zkSync Era initiated before Shared Bridge. + if (_isPreSharedBridgeEraEthWithdrawal(chainId, l2BatchNumber)) { + // Checks that the withdrawal wasn't finalized already. + bool alreadyFinalized = IGetters(ERA_DIAMOND_PROXY).isEthWithdrawalFinalized(l2BatchNumber, l2MessageIndex); + require(!alreadyFinalized, "L1N: Withdrawal is already finalized 2"); + } + if (_isPreSharedBridgeEraTokenWithdrawal(chainId, l2BatchNumber)) { + require(!legacyBridge.isWithdrawalFinalized(l2BatchNumber, l2MessageIndex), "L1N: legacy withdrawal"); + } + + l1AssetRouter.finalizeDeposit(chainId, assetId, transferData); + } + + /// @dev Determines if an eth withdrawal was initiated on ZKsync Era before the upgrade to the Shared Bridge. + /// @param _chainId The chain ID of the transaction to check. + /// @param _l2BatchNumber The L2 batch number for the withdrawal. + /// @return Whether withdrawal was initiated on ZKsync Era before diamond proxy upgrade. + function _isPreSharedBridgeEraEthWithdrawal(uint256 _chainId, uint256 _l2BatchNumber) internal view returns (bool) { + if ((_chainId == ERA_CHAIN_ID) && eraPostDiamondUpgradeFirstBatch == 0) { + revert SharedBridgeValueNotSet(SharedBridgeKey.PostUpgradeFirstBatch); + } + return (_chainId == ERA_CHAIN_ID) && (_l2BatchNumber < eraPostDiamondUpgradeFirstBatch); + } + + /// @dev Determines if a token withdrawal was initiated on ZKsync Era before the upgrade to the Shared Bridge. + /// @param _chainId The chain ID of the transaction to check. + /// @param _l2BatchNumber The L2 batch number for the withdrawal. + /// @return Whether withdrawal was initiated on ZKsync Era before Legacy Bridge upgrade. + function _isPreSharedBridgeEraTokenWithdrawal( + uint256 _chainId, + uint256 _l2BatchNumber + ) internal view returns (bool) { + if ((_chainId == ERA_CHAIN_ID) && eraPostLegacyBridgeUpgradeFirstBatch == 0) { + revert SharedBridgeValueNotSet(SharedBridgeKey.LegacyBridgeFirstBatch); + } + return (_chainId == ERA_CHAIN_ID) && (_l2BatchNumber < eraPostLegacyBridgeUpgradeFirstBatch); + } + + /// @dev Determines if the provided data for a failed deposit corresponds to a legacy failed deposit. + /// @param _depositSender The address of the entity that initiated the deposit. + /// @param _assetId The unique identifier of the deposited L1 token. + /// @param _transferData The encoded transfer data, which includes both the deposit amount and the address of the L2 receiver. + /// @param _expectedTxDataHash The nullifier data hash stored for the failed deposit. + /// @return isLegacyTxDataHash True if the transaction is legacy, false otherwise. + function _isLegacyTxDataHash( + address _depositSender, + bytes32 _assetId, + bytes memory _transferData, + bytes32 _expectedTxDataHash + ) internal view returns (bool isLegacyTxDataHash) { + try this.encodeTxDataHash(LEGACY_ENCODING_VERSION, _depositSender, _assetId, _transferData) returns ( + bytes32 txDataHash + ) { + return txDataHash == _expectedTxDataHash; + } catch { + return false; + } + } + + /// @dev Determines if a deposit was initiated on ZKsync Era before the upgrade to the Shared Bridge. + /// @param _chainId The chain ID of the transaction to check. + /// @param _l2BatchNumber The L2 batch number for the deposit where it was processed. + /// @param _l2TxNumberInBatch The L2 transaction number in the batch, in which the deposit was processed. + /// @return Whether deposit was initiated on ZKsync Era before Shared Bridge upgrade. + function _isPreSharedBridgeDepositOnEra( + uint256 _chainId, + uint256 _l2BatchNumber, + uint256 _l2TxNumberInBatch + ) internal view returns (bool) { + if ((_chainId == ERA_CHAIN_ID) && (eraLegacyBridgeLastDepositBatch == 0)) { + revert SharedBridgeValueNotSet(SharedBridgeKey.LegacyBridgeLastDepositBatch); + } + return + (_chainId == ERA_CHAIN_ID) && + (_l2BatchNumber < eraLegacyBridgeLastDepositBatch || + (_l2TxNumberInBatch <= eraLegacyBridgeLastDepositTxNumber && + _l2BatchNumber == eraLegacyBridgeLastDepositBatch)); + } + + /// @notice Verifies the validity of a withdrawal message from L2 and returns withdrawal details. + /// @param _finalizeWithdrawalParams The structure that holds all necessary data to finalize withdrawal + /// @return assetId The ID of the bridged asset. + /// @return transferData The transfer data used to finalize withdawal. + function _verifyWithdrawal( + FinalizeL1DepositParams calldata _finalizeWithdrawalParams + ) internal view returns (bytes32 assetId, bytes memory transferData) { + (assetId, transferData) = _parseL2WithdrawalMessage( + _finalizeWithdrawalParams.chainId, + _finalizeWithdrawalParams.message + ); + L2Message memory l2ToL1Message; + { + address l2Sender = _finalizeWithdrawalParams.l2Sender; + bool baseTokenWithdrawal = (assetId == BRIDGE_HUB.baseTokenAssetId(_finalizeWithdrawalParams.chainId)); + require( + /// @dev for legacy function calls we hardcode the sender as the L2AssetRouter as we don't know if it is + /// a base token or erc20 token withdrawal beforehand, + /// so we have to allow that option even if we override it. + l2Sender == L2_ASSET_ROUTER_ADDR || + l2Sender == L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR || + l2Sender == __DEPRECATED_l2BridgeAddress[_finalizeWithdrawalParams.chainId], + "L1N: wrong l2 sender" + ); + + l2ToL1Message = L2Message({ + txNumberInBatch: _finalizeWithdrawalParams.l2TxNumberInBatch, + sender: baseTokenWithdrawal ? L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR : l2Sender, + data: _finalizeWithdrawalParams.message + }); + } + + bool success = BRIDGE_HUB.proveL2MessageInclusion({ + _chainId: _finalizeWithdrawalParams.chainId, + _batchNumber: _finalizeWithdrawalParams.l2BatchNumber, + _index: _finalizeWithdrawalParams.l2MessageIndex, + _message: l2ToL1Message, + _proof: _finalizeWithdrawalParams.merkleProof + }); + // withdrawal wrong proof + if (!success) { + revert InvalidProof(); + } + } + + /// @notice Parses the withdrawal message and returns withdrawal details. + /// @dev Currently, 3 different encoding versions are supported: legacy mailbox withdrawal, ERC20 bridge withdrawal, + /// @dev and the latest version supported by shared bridge. Selectors are used for versioning. + /// @param _chainId The ZK chain ID. + /// @param _l2ToL1message The encoded L2 -> L1 message. + /// @return assetId The ID of the bridged asset. + /// @return transferData The transfer data used to finalize withdawal. + function _parseL2WithdrawalMessage( + uint256 _chainId, + bytes memory _l2ToL1message + ) internal view returns (bytes32 assetId, bytes memory transferData) { + // Please note that there are three versions of the message: + // 1. The message that is sent from `L2BaseToken` to withdraw base token. + // 2. The message that is sent from L2 Legacy Shared Bridge to withdraw ERC20 tokens or base token. + // 3. The message that is sent from L2 Asset Router to withdraw ERC20 tokens or base token. + + uint256 amount; + address l1Receiver; + + (uint32 functionSignature, uint256 offset) = UnsafeBytes.readUint32(_l2ToL1message, 0); + if (bytes4(functionSignature) == IMailbox.finalizeEthWithdrawal.selector) { + // The data is expected to be at least 56 bytes long. + if (_l2ToL1message.length < 56) { + revert L2WithdrawalMessageWrongLength(_l2ToL1message.length); + } + // this message is a base token withdrawal + (l1Receiver, offset) = UnsafeBytes.readAddress(_l2ToL1message, offset); + // slither-disable-next-line unused-return + (amount, ) = UnsafeBytes.readUint256(_l2ToL1message, offset); + assetId = BRIDGE_HUB.baseTokenAssetId(_chainId); + address baseToken = BRIDGE_HUB.baseToken(_chainId); + transferData = DataEncoding.encodeBridgeMintData({ + _originalCaller: address(0), + _l2Receiver: l1Receiver, + _l1Token: baseToken, + _amount: amount, + _erc20Metadata: new bytes(0) + }); + } else if (bytes4(functionSignature) == IL1ERC20Bridge.finalizeWithdrawal.selector) { + // this message is a token withdrawal + + // Check that the message length is correct. + // It should be equal to the length of the function signature + address + address + uint256 = 4 + 20 + 20 + 32 = + // 76 (bytes). + if (_l2ToL1message.length != 76) { + revert L2WithdrawalMessageWrongLength(_l2ToL1message.length); + } + (l1Receiver, offset) = UnsafeBytes.readAddress(_l2ToL1message, offset); + // We use the IL1ERC20Bridge for backward compatibility with old withdrawals. + address l1Token; + (l1Token, offset) = UnsafeBytes.readAddress(_l2ToL1message, offset); + // slither-disable-next-line unused-return + (amount, ) = UnsafeBytes.readUint256(_l2ToL1message, offset); + + assetId = DataEncoding.encodeNTVAssetId(block.chainid, l1Token); + transferData = DataEncoding.encodeBridgeMintData({ + _originalCaller: address(0), + _l2Receiver: l1Receiver, + _l1Token: l1Token, + _amount: amount, + _erc20Metadata: new bytes(0) + }); + } else if (bytes4(functionSignature) == IAssetRouterBase.finalizeDeposit.selector) { + // The data is expected to be at least 36 bytes long to contain assetId. + require(_l2ToL1message.length >= 36, "L1N: wrong msg len"); // wrong message length + // slither-disable-next-line unused-return + (, offset) = UnsafeBytes.readBytes32(_l2ToL1message, offset); // originChainId, not used for L2->L1 txs + (assetId, offset) = UnsafeBytes.readBytes32(_l2ToL1message, offset); + transferData = UnsafeBytes.readRemainingBytes(_l2ToL1message, offset); + } else { + revert InvalidSelector(bytes4(functionSignature)); + } + } + + /*////////////////////////////////////////////////////////////// + SHARED BRIDGE TOKEN BRIDGING LEGACY FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @dev Withdraw funds from the initiated deposit, that failed when finalizing on L2. + /// @param _depositSender The address of the deposit initiator. + /// @param _l1Token The address of the deposited L1 ERC20 token. + /// @param _amount The amount of the deposit that failed. + /// @param _l2TxHash The L2 transaction hash of the failed deposit finalization. + /// @param _l2BatchNumber The L2 batch number where the deposit finalization was processed. + /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. + /// @param _l2TxNumberInBatch The L2 transaction number in a batch, in which the log was sent. + /// @param _merkleProof The Merkle proof of the processing L1 -> L2 transaction with deposit finalization. + function claimFailedDeposit( + uint256 _chainId, + address _depositSender, + address _l1Token, + uint256 _amount, + bytes32 _l2TxHash, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes32[] calldata _merkleProof + ) external override { + bytes32 assetId = INativeTokenVault(address(l1NativeTokenVault)).getAssetId(block.chainid, _l1Token); + // For legacy deposits, the l2 receiver is not required to check tx data hash + // bytes memory transferData = abi.encode(_amount, _depositSender); + bytes memory assetData = abi.encode(_amount, address(0)); + + _verifyAndClearFailedTransfer({ + _checkedInLegacyBridge: false, + _depositSender: _depositSender, + _chainId: _chainId, + _assetId: assetId, + _assetData: assetData, + _l2TxHash: _l2TxHash, + _l2BatchNumber: _l2BatchNumber, + _l2MessageIndex: _l2MessageIndex, + _l2TxNumberInBatch: _l2TxNumberInBatch, + _merkleProof: _merkleProof + }); + + l1AssetRouter.bridgeRecoverFailedTransfer({ + _chainId: _chainId, + _depositSender: _depositSender, + _assetId: assetId, + _assetData: assetData + }); + } + + /*////////////////////////////////////////////////////////////// + ERA ERC20 LEGACY FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @notice Withdraw funds from the initiated deposit, that failed when finalizing on ZKsync Era chain. + /// This function is specifically designed for maintaining backward-compatibility with legacy `claimFailedDeposit` + /// method in `L1ERC20Bridge`. + /// + /// @param _depositSender The address of the deposit initiator. + /// @param _l1Asset The address of the deposited L1 ERC20 token. + /// @param _amount The amount of the deposit that failed. + /// @param _l2TxHash The L2 transaction hash of the failed deposit finalization. + /// @param _l2BatchNumber The L2 batch number where the deposit finalization was processed. + /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. + /// @param _l2TxNumberInBatch The L2 transaction number in a batch, in which the log was sent. + /// @param _merkleProof The Merkle proof of the processing L1 -> L2 transaction with deposit finalization. + function claimFailedDepositLegacyErc20Bridge( + address _depositSender, + address _l1Asset, + uint256 _amount, + bytes32 _l2TxHash, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes32[] calldata _merkleProof + ) external override onlyLegacyBridge { + bytes memory assetData = abi.encode(_amount, _depositSender); + /// the legacy bridge can only be used with L1 native tokens. + bytes32 assetId = INativeTokenVault(address(l1NativeTokenVault)).getAssetId(block.chainid, _l1Asset); + + _verifyAndClearFailedTransfer({ + _checkedInLegacyBridge: true, + _depositSender: _depositSender, + _chainId: ERA_CHAIN_ID, + _assetId: assetId, + _assetData: assetData, + _l2TxHash: _l2TxHash, + _l2BatchNumber: _l2BatchNumber, + _l2MessageIndex: _l2MessageIndex, + _l2TxNumberInBatch: _l2TxNumberInBatch, + _merkleProof: _merkleProof + }); + + l1AssetRouter.bridgeRecoverFailedTransfer({ + _chainId: ERA_CHAIN_ID, + _depositSender: _depositSender, + _assetId: assetId, + _assetData: assetData + }); + } + + /*////////////////////////////////////////////////////////////// + PAUSE + //////////////////////////////////////////////////////////////*/ + + /// @notice Pauses all functions marked with the `whenNotPaused` modifier. + function pause() external onlyOwner { + _pause(); + } + + /// @notice Unpauses the contract, allowing all functions marked with the `whenNotPaused` modifier to be called again. + function unpause() external onlyOwner { + _unpause(); + } +} diff --git a/l2-contracts/contracts/bridge/L2SharedBridge.sol b/l1-contracts/contracts/bridge/L2SharedBridgeLegacy.sol similarity index 56% rename from l2-contracts/contracts/bridge/L2SharedBridge.sol rename to l1-contracts/contracts/bridge/L2SharedBridgeLegacy.sol index d4e7b7900..61e6141c2 100644 --- a/l2-contracts/contracts/bridge/L2SharedBridge.sol +++ b/l1-contracts/contracts/bridge/L2SharedBridgeLegacy.sol @@ -3,25 +3,29 @@ pragma solidity 0.8.24; import {Initializable} from "@openzeppelin/contracts-v4/proxy/utils/Initializable.sol"; -import {BeaconProxy} from "@openzeppelin/contracts-v4/proxy/beacon/BeaconProxy.sol"; import {UpgradeableBeacon} from "@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol"; -import {IL1ERC20Bridge} from "./interfaces/IL1ERC20Bridge.sol"; -import {IL2SharedBridge} from "./interfaces/IL2SharedBridge.sol"; -import {IL2StandardToken} from "./interfaces/IL2StandardToken.sol"; +import {BridgedStandardERC20} from "./BridgedStandardERC20.sol"; -import {L2StandardERC20} from "./L2StandardERC20.sol"; -import {AddressAliasHelper} from "../vendor/AddressAliasHelper.sol"; -import {L2ContractHelper, DEPLOYER_SYSTEM_CONTRACT, IContractDeployer} from "../L2ContractHelper.sol"; -import {SystemContractsCaller} from "../SystemContractsCaller.sol"; +import {DEPLOYER_SYSTEM_CONTRACT, L2_ASSET_ROUTER_ADDR, L2_NATIVE_TOKEN_VAULT_ADDR} from "../common/L2ContractAddresses.sol"; +import {SystemContractsCaller} from "../common/libraries/SystemContractsCaller.sol"; +import {L2ContractHelper, IContractDeployer} from "../common/libraries/L2ContractHelper.sol"; -import {ZeroAddress, EmptyBytes32, Unauthorized, AddressMismatch, AmountMustBeGreaterThanZero, DeployFailed} from "../errors/L2ContractErrors.sol"; +import {IL2AssetRouter} from "./asset-router/IL2AssetRouter.sol"; +import {IL2NativeTokenVault} from "./ntv/IL2NativeTokenVault.sol"; + +import {IL2SharedBridgeLegacy} from "./interfaces/IL2SharedBridgeLegacy.sol"; +import {ZeroAddress, EmptyBytes32, Unauthorized, AmountMustBeGreaterThanZero, DeployFailed} from "../common/L1ContractErrors.sol"; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev /// @notice The "default" bridge implementation for the ERC20 tokens. Note, that it does not /// support any custom token logic, i.e. rebase tokens' functionality is not supported. -contract L2SharedBridge is IL2SharedBridge, Initializable { +contract L2SharedBridgeLegacy is IL2SharedBridgeLegacy, Initializable { + /// @dev Contract is expected to be used as proxy implementation. + /// @dev Disable the initialization to prevent Parity hack. + uint256 public immutable ERA_CHAIN_ID; + /// @dev The address of the L1 shared bridge counterpart. address public override l1SharedBridge; @@ -39,9 +43,19 @@ contract L2SharedBridge is IL2SharedBridge, Initializable { /// This is non-zero only on Era, and should not be renamed for backward compatibility with the SDKs. address public override l1Bridge; - /// @dev Contract is expected to be used as proxy implementation. - /// @dev Disable the initialization to prevent Parity hack. - uint256 public immutable ERA_CHAIN_ID; + modifier onlyNTV() { + if (msg.sender != L2_NATIVE_TOKEN_VAULT_ADDR) { + revert Unauthorized(msg.sender); + } + _; + } + + modifier onlyAssetRouter() { + if (msg.sender != L2_ASSET_ROUTER_ADDR) { + revert Unauthorized(msg.sender); + } + _; + } constructor(uint256 _eraChainId) { ERA_CHAIN_ID = _eraChainId; @@ -74,7 +88,7 @@ contract L2SharedBridge is IL2SharedBridge, Initializable { l1SharedBridge = _l1SharedBridge; if (block.chainid != ERA_CHAIN_ID) { - address l2StandardToken = address(new L2StandardERC20{salt: bytes32(0)}()); + address l2StandardToken = address(new BridgedStandardERC20{salt: bytes32(0)}()); l2TokenBeacon = new UpgradeableBeacon{salt: bytes32(0)}(l2StandardToken); l2TokenProxyBytecodeHash = _l2TokenProxyBytecodeHash; l2TokenBeacon.transferOwnership(_aliasedOwner); @@ -87,56 +101,6 @@ contract L2SharedBridge is IL2SharedBridge, Initializable { } } - /// @notice Finalize the deposit and mint funds - /// @param _l1Sender The account address that initiated the deposit on L1 - /// @param _l2Receiver The account address that would receive minted ether - /// @param _l1Token The address of the token that was locked on the L1 - /// @param _amount Total amount of tokens deposited from L1 - /// @param _data The additional data that user can pass with the deposit - function finalizeDeposit( - address _l1Sender, - address _l2Receiver, - address _l1Token, - uint256 _amount, - bytes calldata _data - ) external override { - // Only the L1 bridge counterpart can initiate and finalize the deposit. - if ( - AddressAliasHelper.undoL1ToL2Alias(msg.sender) != l1Bridge && - AddressAliasHelper.undoL1ToL2Alias(msg.sender) != l1SharedBridge - ) { - revert Unauthorized(msg.sender); - } - - address expectedL2Token = l2TokenAddress(_l1Token); - address currentL1Token = l1TokenAddress[expectedL2Token]; - if (currentL1Token == address(0)) { - address deployedToken = _deployL2Token(_l1Token, _data); - if (deployedToken != expectedL2Token) { - revert AddressMismatch(expectedL2Token, deployedToken); - } - - l1TokenAddress[expectedL2Token] = _l1Token; - } else { - if (currentL1Token != _l1Token) { - revert AddressMismatch(_l1Token, currentL1Token); - } - } - - IL2StandardToken(expectedL2Token).bridgeMint(_l2Receiver, _amount); - emit FinalizeDeposit(_l1Sender, _l2Receiver, expectedL2Token, _amount); - } - - /// @dev Deploy and initialize the L2 token for the L1 counterpart - function _deployL2Token(address _l1Token, bytes calldata _data) internal returns (address) { - bytes32 salt = _getCreate2Salt(_l1Token); - - BeaconProxy l2Token = _deployBeaconProxy(salt); - L2StandardERC20(address(l2Token)).bridgeInitialize(_l1Token, _data); - - return address(l2Token); - } - /// @notice Initiates a withdrawal by burning funds on the contract and sending the message to L1 /// where tokens would be unlocked /// @param _l1Receiver The account address that should receive funds on L1 @@ -146,33 +110,22 @@ contract L2SharedBridge is IL2SharedBridge, Initializable { if (_amount == 0) { revert AmountMustBeGreaterThanZero(); } - - IL2StandardToken(_l2Token).bridgeBurn(msg.sender, _amount); - - address l1Token = l1TokenAddress[_l2Token]; - if (l1Token == address(0)) { - revert ZeroAddress(); - } - - bytes memory message = _getL1WithdrawMessage(_l1Receiver, l1Token, _amount); - L2ContractHelper.sendMessageToL1(message); - - emit WithdrawalInitiated(msg.sender, _l1Receiver, _l2Token, _amount); - } - - /// @dev Encode the message for l2ToL1log sent with withdraw initialization - function _getL1WithdrawMessage( - address _to, - address _l1Token, - uint256 _amount - ) internal pure returns (bytes memory) { - // note we use the IL1ERC20Bridge.finalizeWithdrawal function selector to specify the selector for L1<>L2 messages, - // and we use this interface so that when the switch happened the old messages could be processed - return abi.encodePacked(IL1ERC20Bridge.finalizeWithdrawal.selector, _to, _l1Token, _amount); + IL2AssetRouter(L2_ASSET_ROUTER_ADDR).withdrawLegacyBridge(_l1Receiver, _l2Token, _amount, msg.sender); } /// @return Address of an L2 token counterpart function l2TokenAddress(address _l1Token) public view override returns (address) { + address token = IL2NativeTokenVault(L2_NATIVE_TOKEN_VAULT_ADDR).l2TokenAddress(_l1Token); + if (token != address(0)) { + return token; + } + return _calculateCreate2TokenAddress(_l1Token); + } + + /// @notice Calculates L2 wrapped token address given the currently stored beacon proxy bytecode hash and beacon address. + /// @param _l1Token The address of token on L1. + /// @return Address of an L2 token counterpart. + function _calculateCreate2TokenAddress(address _l1Token) internal view returns (address) { bytes32 constructorInputHash = keccak256(abi.encode(address(l2TokenBeacon), "")); bytes32 salt = _getCreate2Salt(_l1Token); return @@ -187,7 +140,7 @@ contract L2SharedBridge is IL2SharedBridge, Initializable { /// @dev Deploy the beacon proxy for the L2 token, while using ContractDeployer system contract. /// @dev This function uses raw call to ContractDeployer to make sure that exactly `l2TokenProxyBytecodeHash` is used /// for the code of the proxy. - function _deployBeaconProxy(bytes32 salt) internal returns (BeaconProxy proxy) { + function deployBeaconProxy(bytes32 salt) external onlyNTV returns (address proxy) { (bool success, bytes memory returndata) = SystemContractsCaller.systemCallWithReturndata( uint32(gasleft()), DEPLOYER_SYSTEM_CONTRACT, @@ -202,6 +155,11 @@ contract L2SharedBridge is IL2SharedBridge, Initializable { if (!success) { revert DeployFailed(); } - proxy = BeaconProxy(abi.decode(returndata, (address))); + proxy = abi.decode(returndata, (address)); + } + + function sendMessageToL1(bytes calldata _message) external override onlyAssetRouter { + // slither-disable-next-line unused-return + L2ContractHelper.sendMessageToL1(_message); } } diff --git a/l2-contracts/contracts/bridge/L2WrappedBaseToken.sol b/l1-contracts/contracts/bridge/L2WrappedBaseToken.sol similarity index 92% rename from l2-contracts/contracts/bridge/L2WrappedBaseToken.sol rename to l1-contracts/contracts/bridge/L2WrappedBaseToken.sol index f7bda32b5..4319a8b7c 100644 --- a/l2-contracts/contracts/bridge/L2WrappedBaseToken.sol +++ b/l1-contracts/contracts/bridge/L2WrappedBaseToken.sol @@ -5,9 +5,9 @@ pragma solidity 0.8.24; import {ERC20PermitUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/token/ERC20/extensions/draft-ERC20PermitUpgradeable.sol"; import {IL2WrappedBaseToken} from "./interfaces/IL2WrappedBaseToken.sol"; -import {IL2StandardToken} from "./interfaces/IL2StandardToken.sol"; +import {IBridgedStandardToken} from "./interfaces/IBridgedStandardToken.sol"; -import {ZeroAddress, Unauthorized, UnimplementedMessage, BRIDGE_MINT_NOT_IMPLEMENTED, WithdrawFailed} from "../errors/L2ContractErrors.sol"; +import {ZeroAddress, Unauthorized, BridgeMintNotImplemented, WithdrawFailed} from "../common/L1ContractErrors.sol"; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev @@ -22,7 +22,7 @@ import {ZeroAddress, Unauthorized, UnimplementedMessage, BRIDGE_MINT_NOT_IMPLEME /// /// Note: This is an upgradeable contract. In the future, we will remove upgradeability to make it trustless. /// But for now, when the Rollup has instant upgradability, we leave the possibility of upgrading to improve the contract if needed. -contract L2WrappedBaseToken is ERC20PermitUpgradeable, IL2WrappedBaseToken, IL2StandardToken { +contract L2WrappedBaseToken is ERC20PermitUpgradeable, IL2WrappedBaseToken, IBridgedStandardToken { /// @dev Address of the L2 WETH Bridge. address public override l2Bridge; @@ -31,7 +31,7 @@ contract L2WrappedBaseToken is ERC20PermitUpgradeable, IL2WrappedBaseToken, IL2S modifier onlyBridge() { if (msg.sender != l2Bridge) { - revert Unauthorized(); + revert Unauthorized(msg.sender); } _; } @@ -85,7 +85,7 @@ contract L2WrappedBaseToken is ERC20PermitUpgradeable, IL2WrappedBaseToken, IL2S /// Note: Use `deposit`/`depositTo` methods instead. // solhint-disable-next-line no-unused-vars function bridgeMint(address _to, uint256 _amount) external override onlyBridge { - revert UnimplementedMessage(BRIDGE_MINT_NOT_IMPLEMENTED); + revert BridgeMintNotImplemented(); } /// @dev Burn tokens from a given account and send the same amount of Ether to the bridge. @@ -127,4 +127,8 @@ contract L2WrappedBaseToken is ERC20PermitUpgradeable, IL2WrappedBaseToken, IL2S revert WithdrawFailed(); } } + + function originToken() external view override returns (address) { + return l1Address; + } } diff --git a/l1-contracts/contracts/bridge/asset-router/AssetRouterBase.sol b/l1-contracts/contracts/bridge/asset-router/AssetRouterBase.sol new file mode 100644 index 000000000..1a27e825f --- /dev/null +++ b/l1-contracts/contracts/bridge/asset-router/AssetRouterBase.sol @@ -0,0 +1,165 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; +import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/security/PausableUpgradeable.sol"; + +import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; +import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; + +import {IAssetRouterBase} from "./IAssetRouterBase.sol"; +import {IAssetHandler} from "../interfaces/IAssetHandler.sol"; +import {DataEncoding} from "../../common/libraries/DataEncoding.sol"; + +import {L2_NATIVE_TOKEN_VAULT_ADDR} from "../../common/L2ContractAddresses.sol"; + +import {IBridgehub} from "../../bridgehub/IBridgehub.sol"; +import {Unauthorized, AssetHandlerDoesNotExist} from "../../common/L1ContractErrors.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @dev Bridges assets between L1 and ZK chain, supporting both ETH and ERC20 tokens. +/// @dev Designed for use with a proxy for upgradability. +abstract contract AssetRouterBase is IAssetRouterBase, Ownable2StepUpgradeable, PausableUpgradeable { + using SafeERC20 for IERC20; + + /// @dev Bridgehub smart contract that is used to operate with L2 via asynchronous L2 <-> L1 communication. + IBridgehub public immutable override BRIDGE_HUB; + + /// @dev Chain ID of L1 for bridging reasons + uint256 public immutable L1_CHAIN_ID; + + /// @dev Chain ID of Era for legacy reasons + uint256 public immutable ERA_CHAIN_ID; + + /// @dev Maps asset ID to address of corresponding asset handler. + /// @dev Tracks the address of Asset Handler contracts, where bridged funds are locked for each asset. + /// @dev P.S. this liquidity was locked directly in SharedBridge before. + /// @dev Current AssetHandlers: NTV for tokens, Bridgehub for chains. + mapping(bytes32 assetId => address assetHandlerAddress) public assetHandlerAddress; + + /// @dev Maps asset ID to the asset deployment tracker address. + /// @dev Tracks the address of Deployment Tracker contract on L1, which sets Asset Handlers on L2s (ZK chain). + /// @dev For the asset and stores respective addresses. + /// @dev Current AssetDeploymentTrackers: NTV for tokens, CTMDeploymentTracker for chains. + mapping(bytes32 assetId => address assetDeploymentTracker) public assetDeploymentTracker; + + /** + * @dev This empty reserved space is put in place to allow future versions to add new + * variables without shifting down storage in the inheritance chain. + * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps + */ + uint256[47] private __gap; + + /// @notice Checks that the message sender is the bridgehub. + modifier onlyBridgehub() { + if (msg.sender != address(BRIDGE_HUB)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @dev Contract is expected to be used as proxy implementation. + /// @dev Initialize the implementation to prevent Parity hack. + constructor(uint256 _l1ChainId, uint256 _eraChainId, IBridgehub _bridgehub) { + L1_CHAIN_ID = _l1ChainId; + ERA_CHAIN_ID = _eraChainId; + BRIDGE_HUB = _bridgehub; + } + + /// @inheritdoc IAssetRouterBase + function setAssetHandlerAddressThisChain( + bytes32 _assetRegistrationData, + address _assetHandlerAddress + ) external virtual override; + + function _setAssetHandlerAddressThisChain( + address _nativeTokenVault, + bytes32 _assetRegistrationData, + address _assetHandlerAddress + ) internal { + bool senderIsNTV = msg.sender == address(_nativeTokenVault); + address sender = senderIsNTV ? L2_NATIVE_TOKEN_VAULT_ADDR : msg.sender; + bytes32 assetId = DataEncoding.encodeAssetId(block.chainid, _assetRegistrationData, sender); + if (!senderIsNTV && msg.sender != assetDeploymentTracker[assetId]) { + revert Unauthorized(msg.sender); + } + assetHandlerAddress[assetId] = _assetHandlerAddress; + assetDeploymentTracker[assetId] = msg.sender; + emit AssetHandlerRegisteredInitial(assetId, _assetHandlerAddress, _assetRegistrationData, sender); + } + + /*////////////////////////////////////////////////////////////// + Receive transaction Functions + //////////////////////////////////////////////////////////////*/ + + /// @inheritdoc IAssetRouterBase + function finalizeDeposit(uint256 _chainId, bytes32 _assetId, bytes calldata _transferData) public virtual; + + function _finalizeDeposit( + uint256 _chainId, + bytes32 _assetId, + bytes calldata _transferData, + address _nativeTokenVault + ) internal { + address assetHandler = assetHandlerAddress[_assetId]; + + if (assetHandler != address(0)) { + IAssetHandler(assetHandler).bridgeMint(_chainId, _assetId, _transferData); + } else { + assetHandlerAddress[_assetId] = _nativeTokenVault; + IAssetHandler(_nativeTokenVault).bridgeMint(_chainId, _assetId, _transferData); // ToDo: Maybe it's better to receive amount and receiver here? transferData may have different encoding + } + } + + /*////////////////////////////////////////////////////////////// + Internal Functions + //////////////////////////////////////////////////////////////*/ + + /// @dev send the burn message to the asset + /// @notice Forwards the burn request for specific asset to respective asset handler. + /// @param _chainId The chain ID of the ZK chain to which to deposit. + /// @param _nextMsgValue The L2 `msg.value` from the L1 -> L2 deposit transaction. + /// @param _assetId The deposited asset ID. + /// @param _originalCaller The `msg.sender` address from the external call that initiated current one. + /// @param _transferData The encoded data, which is used by the asset handler to determine L2 recipient and amount. Might include extra information. + /// @param _passValue Boolean indicating whether to pass msg.value in the call. + /// @return bridgeMintCalldata The calldata used by remote asset handler to mint tokens for recipient. + function _burn( + uint256 _chainId, + uint256 _nextMsgValue, + bytes32 _assetId, + address _originalCaller, + bytes memory _transferData, + bool _passValue + ) internal returns (bytes memory bridgeMintCalldata) { + address l1AssetHandler = assetHandlerAddress[_assetId]; + if (l1AssetHandler == address(0)) { + revert AssetHandlerDoesNotExist(_assetId); + } + + uint256 msgValue = _passValue ? msg.value : 0; + bridgeMintCalldata = IAssetHandler(l1AssetHandler).bridgeBurn{value: msgValue}({ + _chainId: _chainId, + _msgValue: _nextMsgValue, + _assetId: _assetId, + _originalCaller: _originalCaller, + _data: _transferData + }); + } + + /*////////////////////////////////////////////////////////////// + PAUSE + //////////////////////////////////////////////////////////////*/ + + /// @notice Pauses all functions marked with the `whenNotPaused` modifier. + function pause() external onlyOwner { + _pause(); + } + + /// @notice Unpauses the contract, allowing all functions marked with the `whenNotPaused` modifier to be called again. + function unpause() external onlyOwner { + _unpause(); + } +} diff --git a/l1-contracts/contracts/bridge/asset-router/IAssetRouterBase.sol b/l1-contracts/contracts/bridge/asset-router/IAssetRouterBase.sol new file mode 100644 index 000000000..a307ba526 --- /dev/null +++ b/l1-contracts/contracts/bridge/asset-router/IAssetRouterBase.sol @@ -0,0 +1,73 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {IBridgehub} from "../../bridgehub/IBridgehub.sol"; + +/// @dev The encoding version used for legacy txs. +bytes1 constant LEGACY_ENCODING_VERSION = 0x00; + +/// @dev The encoding version used for new txs. +bytes1 constant NEW_ENCODING_VERSION = 0x01; + +/// @dev The encoding version used for txs that set the asset handler on the counterpart contract. +bytes1 constant SET_ASSET_HANDLER_COUNTERPART_ENCODING_VERSION = 0x02; + +/// @title L1 Bridge contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IAssetRouterBase { + event BridgehubDepositBaseTokenInitiated( + uint256 indexed chainId, + address indexed from, + bytes32 assetId, + uint256 amount + ); + + event BridgehubDepositInitiated( + uint256 indexed chainId, + bytes32 indexed txDataHash, + address indexed from, + bytes32 assetId, + bytes bridgeMintCalldata + ); + + event BridgehubWithdrawalInitiated( + uint256 chainId, + address indexed sender, + bytes32 indexed assetId, + bytes32 assetDataHash // Todo: What's the point of emitting hash? + ); + + event AssetHandlerRegisteredInitial( + bytes32 indexed assetId, + address indexed assetHandlerAddress, + bytes32 indexed additionalData, + address assetDeploymentTracker + ); + + event AssetHandlerRegistered(bytes32 indexed assetId, address indexed _assetAddress); + + event DepositFinalizedAssetRouter(uint256 indexed chainId, bytes32 indexed assetId, bytes assetData); + + function BRIDGE_HUB() external view returns (IBridgehub); + + /// @notice Sets the asset handler address for a specified asset ID on the chain of the asset deployment tracker. + /// @dev The caller of this function is encoded within the `assetId`, therefore, it should be invoked by the asset deployment tracker contract. + /// @dev No access control on the caller, as msg.sender is encoded in the assetId. + /// @dev Typically, for most tokens, ADT is the native token vault. However, custom tokens may have their own specific asset deployment trackers. + /// @dev `setAssetHandlerAddressOnCounterpart` should be called on L1 to set asset handlers on L2 chains for a specific asset ID. + /// @param _assetRegistrationData The asset data which may include the asset address and any additional required data or encodings. + /// @param _assetHandlerAddress The address of the asset handler to be set for the provided asset. + function setAssetHandlerAddressThisChain(bytes32 _assetRegistrationData, address _assetHandlerAddress) external; + + function assetHandlerAddress(bytes32 _assetId) external view returns (address); + + /// @notice Finalize the withdrawal and release funds. + /// @param _chainId The chain ID of the transaction to check. + /// @param _assetId The bridged asset ID. + /// @param _transferData The position in the L2 logs Merkle tree of the l2Log that was sent with the message. + /// @dev We have both the legacy finalizeWithdrawal and the new finalizeDeposit functions, + /// finalizeDeposit uses the new format. On the L2 we have finalizeDeposit with new and old formats both. + function finalizeDeposit(uint256 _chainId, bytes32 _assetId, bytes memory _transferData) external; +} diff --git a/l1-contracts/contracts/bridge/asset-router/IL1AssetRouter.sol b/l1-contracts/contracts/bridge/asset-router/IL1AssetRouter.sol new file mode 100644 index 000000000..55b5b9560 --- /dev/null +++ b/l1-contracts/contracts/bridge/asset-router/IL1AssetRouter.sol @@ -0,0 +1,171 @@ +// SPDX-License-Identifier: MIT +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. +pragma solidity ^0.8.21; + +import {IL1Nullifier} from "../interfaces/IL1Nullifier.sol"; +import {INativeTokenVault} from "../ntv/INativeTokenVault.sol"; +import {IAssetRouterBase} from "./IAssetRouterBase.sol"; +import {L2TransactionRequestTwoBridgesInner} from "../../bridgehub/IBridgehub.sol"; + +/// @title L1 Bridge contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IL1AssetRouter is IAssetRouterBase { + event BridgehubMintData(bytes bridgeMintData); + + event BridgehubDepositFinalized( + uint256 indexed chainId, + bytes32 indexed txDataHash, + bytes32 indexed l2DepositTxHash + ); + + event ClaimedFailedDepositAssetRouter(uint256 indexed chainId, bytes32 indexed assetId, bytes assetData); + + event AssetDeploymentTrackerSet( + bytes32 indexed assetId, + address indexed assetDeploymentTracker, + bytes32 indexed additionalData + ); + + event LegacyDepositInitiated( + uint256 indexed chainId, + bytes32 indexed l2DepositTxHash, + address indexed from, + address to, + address l1Asset, + uint256 amount + ); + + /// @notice Initiates a deposit by locking funds on the contract and sending the request + /// of processing an L2 transaction where tokens would be minted. + /// @dev If the token is bridged for the first time, the L2 token contract will be deployed. Note however, that the + /// newly-deployed token does not support any custom logic, i.e. rebase tokens' functionality is not supported. + /// @param _originalCaller The `msg.sender` address from the external call that initiated current one. + /// @param _l2Receiver The account address that should receive funds on L2. + /// @param _l1Token The L1 token address which is deposited. + /// @param _amount The total amount of tokens to be bridged. + /// @param _l2TxGasLimit The L2 gas limit to be used in the corresponding L2 transaction. + /// @param _l2TxGasPerPubdataByte The gasPerPubdataByteLimit to be used in the corresponding L2 transaction. + /// @param _refundRecipient The address on L2 that will receive the refund for the transaction. + /// @dev If the L2 deposit finalization transaction fails, the `_refundRecipient` will receive the `_l2Value`. + /// Please note, the contract may change the refund recipient's address to eliminate sending funds to addresses + /// out of control. + /// - If `_refundRecipient` is a contract on L1, the refund will be sent to the aliased `_refundRecipient`. + /// - If `_refundRecipient` is set to `address(0)` and the sender has NO deployed bytecode on L1, the refund will + /// be sent to the `msg.sender` address. + /// - If `_refundRecipient` is set to `address(0)` and the sender has deployed bytecode on L1, the refund will be + /// sent to the aliased `msg.sender` address. + /// @dev The address aliasing of L1 contracts as refund recipient on L2 is necessary to guarantee that the funds + /// are controllable through the Mailbox, since the Mailbox applies address aliasing to the from address for the + /// L2 tx if the L1 msg.sender is a contract. Without address aliasing for L1 contracts as refund recipients they + /// would not be able to make proper L2 tx requests through the Mailbox to use or withdraw the funds from L2, and + /// the funds would be lost. + /// @return txHash The L2 transaction hash of deposit finalization. + function depositLegacyErc20Bridge( + address _originalCaller, + address _l2Receiver, + address _l1Token, + uint256 _amount, + uint256 _l2TxGasLimit, + uint256 _l2TxGasPerPubdataByte, + address _refundRecipient + ) external payable returns (bytes32 txHash); + + function L1_NULLIFIER() external view returns (IL1Nullifier); + + function L1_WETH_TOKEN() external view returns (address); + + function nativeTokenVault() external view returns (INativeTokenVault); + + function setAssetDeploymentTracker(bytes32 _assetRegistrationData, address _assetDeploymentTracker) external; + + function setNativeTokenVault(INativeTokenVault _nativeTokenVault) external; + + /// @notice Withdraw funds from the initiated deposit, that failed when finalizing on L2. + /// @param _chainId The ZK chain id to which the deposit was initiated. + /// @param _depositSender The address of the entity that initiated the deposit. + /// @param _assetId The unique identifier of the deposited L1 token. + /// @param _assetData The encoded transfer data, which includes both the deposit amount and the address of the L2 receiver. Might include extra information. + /// @dev Processes claims of failed deposit, whether they originated from the legacy bridge or the current system. + function bridgeRecoverFailedTransfer( + uint256 _chainId, + address _depositSender, + bytes32 _assetId, + bytes calldata _assetData + ) external; + + /// @notice Transfers funds to Native Token Vault, if the asset is registered with it. Does nothing for ETH or non-registered tokens. + /// @dev assetId is not the padded address, but the correct encoded id (NTV stores respective format for IDs) + /// @param _amount The asset amount to be transferred to native token vault. + /// @param _originalCaller The `msg.sender` address from the external call that initiated current one. + function transferFundsToNTV(bytes32 _assetId, uint256 _amount, address _originalCaller) external returns (bool); + + /// @notice Finalize the withdrawal and release funds + /// @param _chainId The chain ID of the transaction to check + /// @param _l2BatchNumber The L2 batch number where the withdrawal was processed + /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message + /// @param _l2TxNumberInBatch The L2 transaction number in the batch, in which the log was sent + /// @param _message The L2 withdraw data, stored in an L2 -> L1 message + /// @param _merkleProof The Merkle proof of the inclusion L2 -> L1 message about withdrawal initialization + function finalizeWithdrawal( + uint256 _chainId, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes calldata _message, + bytes32[] calldata _merkleProof + ) external; + + /// @notice Initiates a transfer transaction within Bridgehub, used by `requestL2TransactionTwoBridges`. + /// @param _chainId The chain ID of the ZK chain to which deposit. + /// @param _originalCaller The `msg.sender` address from the external call that initiated current one. + /// @param _value The `msg.value` on the target chain tx. + /// @param _data The calldata for the second bridge deposit. + /// @return request The data used by the bridgehub to create L2 transaction request to specific ZK chain. + /// @dev Data has the following abi encoding for legacy deposits: + /// address _l1Token, + /// uint256 _amount, + /// address _l2Receiver + /// for new deposits: + /// bytes32 _assetId, + /// bytes _transferData + function bridgehubDeposit( + uint256 _chainId, + address _originalCaller, + uint256 _value, + bytes calldata _data + ) external payable returns (L2TransactionRequestTwoBridgesInner memory request); + + /// @notice Generates a calldata for calling the deposit finalization on the L2 native token contract. + // / @param _chainId The chain ID of the ZK chain to which deposit. + /// @param _sender The address of the deposit initiator. + /// @param _assetId The deposited asset ID. + /// @param _assetData The encoded data, which is used by the asset handler to determine L2 recipient and amount. Might include extra information. + /// @return Returns calldata used on ZK chain. + function getDepositCalldata( + address _sender, + bytes32 _assetId, + bytes memory _assetData + ) external view returns (bytes memory); + + /// @notice Allows bridgehub to acquire mintValue for L1->L2 transactions. + /// @dev If the corresponding L2 transaction fails, refunds are issued to a refund recipient on L2. + /// @param _chainId The chain ID of the ZK chain to which deposit. + /// @param _assetId The deposited asset ID. + /// @param _originalCaller The `msg.sender` address from the external call that initiated current one. + /// @param _amount The total amount of tokens to be bridged. + function bridgehubDepositBaseToken( + uint256 _chainId, + bytes32 _assetId, + address _originalCaller, + uint256 _amount + ) external payable; + + /// @notice Routes the confirmation to nullifier for backward compatibility. + /// @notice Confirms the acceptance of a transaction by the Mailbox, as part of the L2 transaction process within Bridgehub. + /// This function is utilized by `requestL2TransactionTwoBridges` to validate the execution of a transaction. + /// @param _chainId The chain ID of the ZK chain to which confirm the deposit. + /// @param _txDataHash The keccak256 hash of 0x01 || abi.encode(bytes32, bytes) to identify deposits. + /// @param _txHash The hash of the L1->L2 transaction to confirm the deposit. + function bridgehubConfirmL2Transaction(uint256 _chainId, bytes32 _txDataHash, bytes32 _txHash) external; +} diff --git a/l1-contracts/contracts/bridge/asset-router/IL2AssetRouter.sol b/l1-contracts/contracts/bridge/asset-router/IL2AssetRouter.sol new file mode 100644 index 000000000..34ce2ecd1 --- /dev/null +++ b/l1-contracts/contracts/bridge/asset-router/IL2AssetRouter.sol @@ -0,0 +1,24 @@ +// SPDX-License-Identifier: MIT + +pragma solidity ^0.8.20; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IL2AssetRouter { + event WithdrawalInitiatedAssetRouter( + uint256 chainId, + address indexed l2Sender, + bytes32 indexed assetId, + bytes assetData + ); + + function withdraw(bytes32 _assetId, bytes calldata _transferData) external; + + function l1AssetRouter() external view returns (address); + + function withdrawLegacyBridge(address _l1Receiver, address _l2Token, uint256 _amount, address _sender) external; + + /// @dev Used to set the assedAddress for a given assetId. + /// @dev Will be used by ZK Gateway + function setAssetHandlerAddress(uint256 _originChainId, bytes32 _assetId, address _assetAddress) external; +} diff --git a/l1-contracts/contracts/bridge/asset-router/L1AssetRouter.sol b/l1-contracts/contracts/bridge/asset-router/L1AssetRouter.sol new file mode 100644 index 000000000..0c3b2001f --- /dev/null +++ b/l1-contracts/contracts/bridge/asset-router/L1AssetRouter.sol @@ -0,0 +1,588 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +// solhint-disable reason-string, gas-custom-errors + +import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; +import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; + +import {IL1AssetRouter} from "./IL1AssetRouter.sol"; +import {IL2AssetRouter} from "./IL2AssetRouter.sol"; +import {IAssetRouterBase, LEGACY_ENCODING_VERSION, NEW_ENCODING_VERSION, SET_ASSET_HANDLER_COUNTERPART_ENCODING_VERSION} from "./IAssetRouterBase.sol"; +import {AssetRouterBase} from "./AssetRouterBase.sol"; + +import {IL1AssetHandler} from "../interfaces/IL1AssetHandler.sol"; +import {IL1ERC20Bridge} from "../interfaces/IL1ERC20Bridge.sol"; +import {IAssetHandler} from "../interfaces/IAssetHandler.sol"; +import {IL1Nullifier, FinalizeL1DepositParams} from "../interfaces/IL1Nullifier.sol"; +import {INativeTokenVault} from "../ntv/INativeTokenVault.sol"; +import {IL2SharedBridgeLegacyFunctions} from "../interfaces/IL2SharedBridgeLegacyFunctions.sol"; + +import {ReentrancyGuard} from "../../common/ReentrancyGuard.sol"; +import {DataEncoding} from "../../common/libraries/DataEncoding.sol"; +import {AddressAliasHelper} from "../../vendor/AddressAliasHelper.sol"; +import {TWO_BRIDGES_MAGIC_VALUE, ETH_TOKEN_ADDRESS} from "../../common/Config.sol"; +import {UnsupportedEncodingVersion, AssetIdNotSupported, AssetHandlerDoesNotExist, Unauthorized, ZeroAddress, TokenNotSupported, AddressAlreadyUsed} from "../../common/L1ContractErrors.sol"; +import {L2_ASSET_ROUTER_ADDR} from "../../common/L2ContractAddresses.sol"; + +import {IBridgehub, L2TransactionRequestTwoBridgesInner, L2TransactionRequestDirect} from "../../bridgehub/IBridgehub.sol"; + +import {IL1AssetDeploymentTracker} from "../interfaces/IL1AssetDeploymentTracker.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @dev Bridges assets between L1 and ZK chain, supporting both ETH and ERC20 tokens. +/// @dev Designed for use with a proxy for upgradability. +contract L1AssetRouter is AssetRouterBase, IL1AssetRouter, ReentrancyGuard { + using SafeERC20 for IERC20; + + /// @dev The address of the WETH token on L1. + address public immutable override L1_WETH_TOKEN; + + /// @dev The address of ZKsync Era diamond proxy contract. + address internal immutable ERA_DIAMOND_PROXY; + + /// @dev Address of nullifier. + IL1Nullifier public immutable L1_NULLIFIER; + + /// @dev Address of native token vault. + INativeTokenVault public nativeTokenVault; + + /// @dev Address of legacy bridge. + IL1ERC20Bridge public legacyBridge; + + /// @notice Checks that the message sender is the nullifier. + modifier onlyNullifier() { + if (msg.sender != address(L1_NULLIFIER)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @notice Checks that the message sender is the bridgehub or ZKsync Era Diamond Proxy. + modifier onlyBridgehubOrEra(uint256 _chainId) { + if (msg.sender != address(BRIDGE_HUB) && (_chainId != ERA_CHAIN_ID || msg.sender != ERA_DIAMOND_PROXY)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @notice Checks that the message sender is the legacy bridge. + modifier onlyLegacyBridge() { + if (msg.sender != address(legacyBridge)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @notice Checks that the message sender is the native token vault. + modifier onlyNativeTokenVault() { + if (msg.sender != address(nativeTokenVault)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @dev Contract is expected to be used as proxy implementation. + /// @dev Initialize the implementation to prevent Parity hack. + constructor( + address _l1WethAddress, + address _bridgehub, + address _l1Nullifier, + uint256 _eraChainId, + address _eraDiamondProxy + ) reentrancyGuardInitializer AssetRouterBase(block.chainid, _eraChainId, IBridgehub(_bridgehub)) { + _disableInitializers(); + L1_WETH_TOKEN = _l1WethAddress; + ERA_DIAMOND_PROXY = _eraDiamondProxy; + L1_NULLIFIER = IL1Nullifier(_l1Nullifier); + } + + /// @dev Initializes a contract bridge for later use. Expected to be used in the proxy. + /// @dev Used for testing purposes only, as the contract has been initialized on mainnet. + /// @param _owner The address which can change L2 token implementation and upgrade the bridge implementation. + /// The owner is the Governor and separate from the ProxyAdmin from now on, so that the Governor can call the bridge. + function initialize(address _owner) external reentrancyGuardInitializer initializer { + if (_owner == address(0)) { + revert ZeroAddress(); + } + _transferOwnership(_owner); + } + + /// @notice Sets the L1ERC20Bridge contract address. + /// @dev Should be called only once by the owner. + /// @param _nativeTokenVault The address of the native token vault. + function setNativeTokenVault(INativeTokenVault _nativeTokenVault) external onlyOwner { + require(address(nativeTokenVault) == address(0), "AR: native token v already set"); + require(address(_nativeTokenVault) != address(0), "AR: native token vault 0"); + nativeTokenVault = _nativeTokenVault; + bytes32 ethAssetId = DataEncoding.encodeNTVAssetId(block.chainid, ETH_TOKEN_ADDRESS); + assetHandlerAddress[ethAssetId] = address(nativeTokenVault); + } + + /// @notice Sets the L1ERC20Bridge contract address. + /// @dev Should be called only once by the owner. + /// @param _legacyBridge The address of the legacy bridge. + function setL1Erc20Bridge(IL1ERC20Bridge _legacyBridge) external onlyOwner { + if (address(legacyBridge) != address(0)) { + revert AddressAlreadyUsed(address(legacyBridge)); + } + if (address(_legacyBridge) == address(0)) { + revert ZeroAddress(); + } + legacyBridge = _legacyBridge; + } + + /// @notice Used to set the assed deployment tracker address for given asset data. + /// @param _assetRegistrationData The asset data which may include the asset address and any additional required data or encodings. + /// @param _assetDeploymentTracker The whitelisted address of asset deployment tracker for provided asset. + function setAssetDeploymentTracker( + bytes32 _assetRegistrationData, + address _assetDeploymentTracker + ) external onlyOwner { + bytes32 assetId = keccak256( + abi.encode(uint256(block.chainid), _assetDeploymentTracker, _assetRegistrationData) + ); + assetDeploymentTracker[assetId] = _assetDeploymentTracker; + emit AssetDeploymentTrackerSet(assetId, _assetDeploymentTracker, _assetRegistrationData); + } + + /// @inheritdoc IAssetRouterBase + function setAssetHandlerAddressThisChain( + bytes32 _assetRegistrationData, + address _assetHandlerAddress + ) external override(AssetRouterBase, IAssetRouterBase) { + _setAssetHandlerAddressThisChain(address(nativeTokenVault), _assetRegistrationData, _assetHandlerAddress); + } + + /// @notice Used to set the asset handler address for a given asset ID on a remote ZK chain + /// @dev No access control on the caller, as msg.sender is encoded in the assetId. + /// @param _chainId The ZK chain ID. + /// @param _originalCaller The `msg.sender` address from the external call that initiated current one. + /// @param _assetId The encoding of asset ID. + /// @param _assetHandlerAddressOnCounterpart The address of the asset handler, which will hold the token of interest. + /// @return request The tx request sent to the Bridgehub + function _setAssetHandlerAddressOnCounterpart( + uint256 _chainId, + address _originalCaller, + bytes32 _assetId, + address _assetHandlerAddressOnCounterpart + ) internal view returns (L2TransactionRequestTwoBridgesInner memory request) { + IL1AssetDeploymentTracker(assetDeploymentTracker[_assetId]).bridgeCheckCounterpartAddress( + _chainId, + _assetId, + _originalCaller, + _assetHandlerAddressOnCounterpart + ); + + bytes memory l2Calldata = abi.encodeCall( + IL2AssetRouter.setAssetHandlerAddress, + (block.chainid, _assetId, _assetHandlerAddressOnCounterpart) + ); + request = L2TransactionRequestTwoBridgesInner({ + magicValue: TWO_BRIDGES_MAGIC_VALUE, + l2Contract: L2_ASSET_ROUTER_ADDR, + l2Calldata: l2Calldata, + factoryDeps: new bytes[](0), + txDataHash: bytes32(0x00) + }); + } + + /*////////////////////////////////////////////////////////////// + INITIATTE DEPOSIT Functions + //////////////////////////////////////////////////////////////*/ + + /// @inheritdoc IL1AssetRouter + function bridgehubDepositBaseToken( + uint256 _chainId, + bytes32 _assetId, + address _originalCaller, + uint256 _amount + ) public payable virtual override onlyBridgehubOrEra(_chainId) whenNotPaused { + address assetHandler = assetHandlerAddress[_assetId]; + if (assetHandler == address(0)) { + revert AssetHandlerDoesNotExist(_assetId); + } + + // slither-disable-next-line unused-return + IAssetHandler(assetHandler).bridgeBurn{value: msg.value}({ + _chainId: _chainId, + _msgValue: 0, + _assetId: _assetId, + _originalCaller: _originalCaller, + _data: abi.encode(_amount, address(0)) + }); + + // Note that we don't save the deposited amount, as this is for the base token, which gets sent to the refundRecipient if the tx fails + emit BridgehubDepositBaseTokenInitiated(_chainId, _originalCaller, _assetId, _amount); + } + + /// @inheritdoc IL1AssetRouter + function bridgehubDeposit( + uint256 _chainId, + address _originalCaller, + uint256 _value, + bytes calldata _data + ) + external + payable + virtual + override + onlyBridgehub + whenNotPaused + returns (L2TransactionRequestTwoBridgesInner memory request) + { + bytes32 assetId; + bytes memory transferData; + bytes1 encodingVersion = _data[0]; + // The new encoding ensures that the calldata is collision-resistant with respect to the legacy format. + // In the legacy calldata, the first input was the address, meaning the most significant byte was always `0x00`. + if (encodingVersion == SET_ASSET_HANDLER_COUNTERPART_ENCODING_VERSION) { + (bytes32 _assetId, address _assetHandlerAddressOnCounterpart) = abi.decode(_data[1:], (bytes32, address)); + return + _setAssetHandlerAddressOnCounterpart( + _chainId, + _originalCaller, + _assetId, + _assetHandlerAddressOnCounterpart + ); + } else if (encodingVersion == NEW_ENCODING_VERSION) { + (assetId, transferData) = abi.decode(_data[1:], (bytes32, bytes)); + } else if (encodingVersion == LEGACY_ENCODING_VERSION) { + (assetId, transferData) = _handleLegacyData(_data, _originalCaller); + } else { + revert UnsupportedEncodingVersion(); + } + + if (BRIDGE_HUB.baseTokenAssetId(_chainId) == assetId) { + revert AssetIdNotSupported(assetId); + } + + bytes memory bridgeMintCalldata = _burn({ + _chainId: _chainId, + _nextMsgValue: _value, + _assetId: assetId, + _originalCaller: _originalCaller, + _transferData: transferData, + _passValue: true + }); + + bytes32 txDataHash = DataEncoding.encodeTxDataHash({ + _nativeTokenVault: address(nativeTokenVault), + _encodingVersion: encodingVersion, + _originalCaller: _originalCaller, + _assetId: assetId, + _transferData: transferData + }); + + request = _requestToBridge({ + _originalCaller: _originalCaller, + _assetId: assetId, + _bridgeMintCalldata: bridgeMintCalldata, + _txDataHash: txDataHash + }); + + emit BridgehubDepositInitiated({ + chainId: _chainId, + txDataHash: txDataHash, + from: _originalCaller, + assetId: assetId, + bridgeMintCalldata: bridgeMintCalldata + }); + } + + /// @inheritdoc IL1AssetRouter + function bridgehubConfirmL2Transaction( + uint256 _chainId, + bytes32 _txDataHash, + bytes32 _txHash + ) external override onlyBridgehub whenNotPaused { + L1_NULLIFIER.bridgehubConfirmL2TransactionForwarded(_chainId, _txDataHash, _txHash); + } + + /*////////////////////////////////////////////////////////////// + Receive transaction Functions + //////////////////////////////////////////////////////////////*/ + + /// @inheritdoc IAssetRouterBase + function finalizeDeposit( + uint256 _chainId, + bytes32 _assetId, + bytes calldata _transferData + ) public override(AssetRouterBase, IAssetRouterBase) onlyNullifier { + _finalizeDeposit(_chainId, _assetId, _transferData, address(nativeTokenVault)); + emit DepositFinalizedAssetRouter(_chainId, _assetId, _transferData); + } + + /*////////////////////////////////////////////////////////////// + CLAIM FAILED DEPOSIT Functions + //////////////////////////////////////////////////////////////*/ + + /// @inheritdoc IL1AssetRouter + function bridgeRecoverFailedTransfer( + uint256 _chainId, + address _depositSender, + bytes32 _assetId, + bytes calldata _assetData + ) external override onlyNullifier nonReentrant whenNotPaused { + IL1AssetHandler(assetHandlerAddress[_assetId]).bridgeRecoverFailedTransfer( + _chainId, + _assetId, + _depositSender, + _assetData + ); + + emit ClaimedFailedDepositAssetRouter(_chainId, _assetId, _assetData); + } + /*////////////////////////////////////////////////////////////// + Internal & Helpers + //////////////////////////////////////////////////////////////*/ + + /// @notice Decodes the transfer input for legacy data and transfers allowance to NTV. + /// @dev Is not applicable for custom asset handlers. + /// @param _data The encoded transfer data (address _l1Token, uint256 _depositAmount, address _l2Receiver). + /// @return Tuple of asset ID and encoded transfer data to conform with new encoding standard. + function _handleLegacyData(bytes calldata _data, address) internal returns (bytes32, bytes memory) { + (address _l1Token, uint256 _depositAmount, address _l2Receiver) = abi.decode( + _data, + (address, uint256, address) + ); + bytes32 assetId = _ensureTokenRegisteredWithNTV(_l1Token); + return (assetId, abi.encode(_depositAmount, _l2Receiver)); + } + + /// @notice Ensures that token is registered with native token vault. + /// @dev Only used when deposit is made with legacy data encoding format. + /// @param _token The L1 token address which should be registered with native token vault. + /// @return assetId The asset ID of the token provided. + function _ensureTokenRegisteredWithNTV(address _token) internal returns (bytes32 assetId) { + assetId = nativeTokenVault.getAssetId(block.chainid, _token); + if (nativeTokenVault.tokenAddress(assetId) == address(0)) { + nativeTokenVault.registerToken(_token); + } + } + + /// @inheritdoc IL1AssetRouter + function transferFundsToNTV( + bytes32 _assetId, + uint256 _amount, + address _originalCaller + ) external onlyNativeTokenVault returns (bool) { + address l1TokenAddress = INativeTokenVault(address(nativeTokenVault)).tokenAddress(_assetId); + if (l1TokenAddress == address(0) || l1TokenAddress == ETH_TOKEN_ADDRESS) { + return false; + } + IERC20 l1Token = IERC20(l1TokenAddress); + + // Do the transfer if allowance to Shared bridge is bigger than amount + // And if there is not enough allowance for the NTV + if ( + l1Token.allowance(_originalCaller, address(this)) >= _amount && + l1Token.allowance(_originalCaller, address(nativeTokenVault)) < _amount + ) { + // slither-disable-next-line arbitrary-send-erc20 + l1Token.safeTransferFrom(_originalCaller, address(nativeTokenVault), _amount); + return true; + } + return false; + } + + /// @dev The request data that is passed to the bridgehub. + /// @param _originalCaller The `msg.sender` address from the external call that initiated current one. + /// @param _assetId The deposited asset ID. + /// @param _bridgeMintCalldata The calldata used by remote asset handler to mint tokens for recipient. + /// @param _txDataHash The keccak256 hash of 0x01 || abi.encode(bytes32, bytes) to identify deposits. + /// @return request The data used by the bridgehub to create L2 transaction request to specific ZK chain. + function _requestToBridge( + address _originalCaller, + bytes32 _assetId, + bytes memory _bridgeMintCalldata, + bytes32 _txDataHash + ) internal view virtual returns (L2TransactionRequestTwoBridgesInner memory request) { + bytes memory l2TxCalldata = getDepositCalldata(_originalCaller, _assetId, _bridgeMintCalldata); + + request = L2TransactionRequestTwoBridgesInner({ + magicValue: TWO_BRIDGES_MAGIC_VALUE, + l2Contract: L2_ASSET_ROUTER_ADDR, + l2Calldata: l2TxCalldata, + factoryDeps: new bytes[](0), + txDataHash: _txDataHash + }); + } + + /// @inheritdoc IL1AssetRouter + function getDepositCalldata( + address _sender, + bytes32 _assetId, + bytes memory _assetData + ) public view override returns (bytes memory) { + // First branch covers the case when asset is not registered with NTV (custom asset handler) + // Second branch handles tokens registered with NTV and uses legacy calldata encoding + // We need to use the legacy encoding to support the old SDK, which relies on a specific encoding of the data. + if ( + (nativeTokenVault.tokenAddress(_assetId) == address(0)) || + (nativeTokenVault.originChainId(_assetId) != block.chainid) + ) { + return abi.encodeCall(IAssetRouterBase.finalizeDeposit, (block.chainid, _assetId, _assetData)); + } else { + // slither-disable-next-line unused-return + (, address _receiver, address _parsedNativeToken, uint256 _amount, bytes memory _gettersData) = DataEncoding + .decodeBridgeMintData(_assetData); + return + _getLegacyNTVCalldata({ + _sender: _sender, + _receiver: _receiver, + _parsedNativeToken: _parsedNativeToken, + _amount: _amount, + _gettersData: _gettersData + }); + } + } + + function _getLegacyNTVCalldata( + address _sender, + address _receiver, + address _parsedNativeToken, + uint256 _amount, + bytes memory _gettersData + ) internal pure returns (bytes memory) { + return + abi.encodeCall( + IL2SharedBridgeLegacyFunctions.finalizeDeposit, + (_sender, _receiver, _parsedNativeToken, _amount, _gettersData) + ); + } + + /*////////////////////////////////////////////////////////////// + Legacy Functions + //////////////////////////////////////////////////////////////*/ + + /// @inheritdoc IL1AssetRouter + function depositLegacyErc20Bridge( + address _originalCaller, + address _l2Receiver, + address _l1Token, + uint256 _amount, + uint256 _l2TxGasLimit, + uint256 _l2TxGasPerPubdataByte, + address _refundRecipient + ) external payable override onlyLegacyBridge nonReentrant whenNotPaused returns (bytes32 txHash) { + if (_l1Token == L1_WETH_TOKEN) { + revert TokenNotSupported(L1_WETH_TOKEN); + } + + bytes32 _assetId; + bytes memory bridgeMintCalldata; + + { + // Inner call to encode data to decrease local var numbers + _assetId = _ensureTokenRegisteredWithNTV(_l1Token); + IERC20(_l1Token).forceApprove(address(nativeTokenVault), _amount); + + bridgeMintCalldata = _burn({ + _chainId: ERA_CHAIN_ID, + _nextMsgValue: 0, + _assetId: _assetId, + _originalCaller: _originalCaller, + _transferData: abi.encode(_amount, _l2Receiver), + _passValue: false + }); + } + + { + bytes memory l2TxCalldata = getDepositCalldata(_originalCaller, _assetId, bridgeMintCalldata); + + // If the refund recipient is not specified, the refund will be sent to the sender of the transaction. + // Otherwise, the refund will be sent to the specified address. + // If the recipient is a contract on L1, the address alias will be applied. + address refundRecipient = AddressAliasHelper.actualRefundRecipient(_refundRecipient, _originalCaller); + + L2TransactionRequestDirect memory request = L2TransactionRequestDirect({ + chainId: ERA_CHAIN_ID, + l2Contract: L2_ASSET_ROUTER_ADDR, + mintValue: msg.value, // l2 gas + l2 msg.Value the bridgehub will withdraw the mintValue from the base token bridge for gas + l2Value: 0, // L2 msg.value, this contract doesn't support base token deposits or wrapping functionality, for direct deposits use bridgehub + l2Calldata: l2TxCalldata, + l2GasLimit: _l2TxGasLimit, + l2GasPerPubdataByteLimit: _l2TxGasPerPubdataByte, + factoryDeps: new bytes[](0), + refundRecipient: refundRecipient + }); + txHash = BRIDGE_HUB.requestL2TransactionDirect{value: msg.value}(request); + } + + // Save the deposited amount to claim funds on L1 if the deposit failed on L2 + L1_NULLIFIER.bridgehubConfirmL2TransactionForwarded( + ERA_CHAIN_ID, + keccak256(abi.encode(_originalCaller, _l1Token, _amount)), + txHash + ); + + emit LegacyDepositInitiated({ + chainId: ERA_CHAIN_ID, + l2DepositTxHash: txHash, + from: _originalCaller, + to: _l2Receiver, + l1Asset: _l1Token, + amount: _amount + }); + } + + /// @inheritdoc IL1AssetRouter + function finalizeWithdrawal( + uint256 _chainId, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes calldata _message, + bytes32[] calldata _merkleProof + ) external override { + /// @dev We use a deprecated field to support L2->L1 legacy withdrawals, which were started + /// by the legacy bridge. + address legacyL2Bridge = L1_NULLIFIER.__DEPRECATED_l2BridgeAddress(_chainId); + FinalizeL1DepositParams memory finalizeWithdrawalParams = FinalizeL1DepositParams({ + chainId: _chainId, + l2BatchNumber: _l2BatchNumber, + l2MessageIndex: _l2MessageIndex, + l2Sender: legacyL2Bridge == address(0) ? L2_ASSET_ROUTER_ADDR : legacyL2Bridge, + l2TxNumberInBatch: _l2TxNumberInBatch, + message: _message, + merkleProof: _merkleProof + }); + L1_NULLIFIER.finalizeDeposit(finalizeWithdrawalParams); + } + + /// @dev Withdraw funds from the initiated deposit, that failed when finalizing on L2. + /// @param _depositSender The address of the deposit initiator. + /// @param _l1Token The address of the deposited L1 ERC20 token. + /// @param _amount The amount of the deposit that failed. + /// @param _l2TxHash The L2 transaction hash of the failed deposit finalization. + /// @param _l2BatchNumber The L2 batch number where the deposit finalization was processed. + /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. + /// @param _l2TxNumberInBatch The L2 transaction number in a batch, in which the log was sent. + /// @param _merkleProof The Merkle proof of the processing L1 -> L2 transaction with deposit finalization. + function claimFailedDeposit( + uint256 _chainId, + address _depositSender, + address _l1Token, + uint256 _amount, + bytes32 _l2TxHash, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes32[] calldata _merkleProof + ) external { + L1_NULLIFIER.claimFailedDeposit({ + _chainId: _chainId, + _depositSender: _depositSender, + _l1Token: _l1Token, + _amount: _amount, + _l2TxHash: _l2TxHash, + _l2BatchNumber: _l2BatchNumber, + _l2MessageIndex: _l2MessageIndex, + _l2TxNumberInBatch: _l2TxNumberInBatch, + _merkleProof: _merkleProof + }); + } +} diff --git a/l1-contracts/contracts/bridge/asset-router/L2AssetRouter.sol b/l1-contracts/contracts/bridge/asset-router/L2AssetRouter.sol new file mode 100644 index 000000000..6c122ccc6 --- /dev/null +++ b/l1-contracts/contracts/bridge/asset-router/L2AssetRouter.sol @@ -0,0 +1,283 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {IL2AssetRouter} from "./IL2AssetRouter.sol"; +import {IAssetRouterBase} from "./IAssetRouterBase.sol"; +import {AssetRouterBase} from "./AssetRouterBase.sol"; + +import {IL2NativeTokenVault} from "../ntv/IL2NativeTokenVault.sol"; +import {IL2SharedBridgeLegacy} from "../interfaces/IL2SharedBridgeLegacy.sol"; +import {IAssetHandler} from "../interfaces/IAssetHandler.sol"; +import {IBridgedStandardToken} from "../interfaces/IBridgedStandardToken.sol"; +import {IL1ERC20Bridge} from "../interfaces/IL1ERC20Bridge.sol"; + +import {IBridgehub} from "../../bridgehub/IBridgehub.sol"; +import {AddressAliasHelper} from "../../vendor/AddressAliasHelper.sol"; + +import {L2_NATIVE_TOKEN_VAULT_ADDR, L2_BRIDGEHUB_ADDR} from "../../common/L2ContractAddresses.sol"; +import {L2ContractHelper} from "../../common/libraries/L2ContractHelper.sol"; +import {DataEncoding} from "../../common/libraries/DataEncoding.sol"; +import {EmptyAddress, InvalidCaller, AmountMustBeGreaterThanZero, AssetIdNotSupported} from "../../common/L1ContractErrors.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice The "default" bridge implementation for the ERC20 tokens. Note, that it does not +/// support any custom token logic, i.e. rebase tokens' functionality is not supported. +contract L2AssetRouter is AssetRouterBase, IL2AssetRouter { + /// @dev The address of the L2 legacy shared bridge. + address public immutable L2_LEGACY_SHARED_BRIDGE; + + /// @dev The asset id of the base token. + bytes32 public immutable BASE_TOKEN_ASSET_ID; + + /// @dev The address of the L1 asset router counterpart. + address public override l1AssetRouter; + + /// @notice Checks that the message sender is the L1 Asset Router. + modifier onlyAssetRouterCounterpart(uint256 _originChainId) { + if (_originChainId == L1_CHAIN_ID) { + // Only the L1 Asset Router counterpart can initiate and finalize the deposit. + if (AddressAliasHelper.undoL1ToL2Alias(msg.sender) != l1AssetRouter) { + revert InvalidCaller(msg.sender); + } + } else { + revert InvalidCaller(msg.sender); // xL2 messaging not supported for now + } + _; + } + + /// @notice Checks that the message sender is the L1 Asset Router. + modifier onlyAssetRouterCounterpartOrSelf(uint256 _originChainId) { + if (_originChainId == L1_CHAIN_ID) { + // Only the L1 Asset Router counterpart can initiate and finalize the deposit. + if ((AddressAliasHelper.undoL1ToL2Alias(msg.sender) != l1AssetRouter) && (msg.sender != address(this))) { + revert InvalidCaller(msg.sender); + } + } + _; + } + + /// @notice Checks that the message sender is the legacy L2 bridge. + modifier onlyLegacyBridge() { + if (msg.sender != L2_LEGACY_SHARED_BRIDGE) { + revert InvalidCaller(msg.sender); + } + _; + } + + /// @dev Disable the initialization to prevent Parity hack. + /// @param _l1AssetRouter The address of the L1 Bridge contract. + constructor( + uint256 _l1ChainId, + uint256 _eraChainId, + address _l1AssetRouter, + address _legacySharedBridge, + bytes32 _baseTokenAssetId + ) AssetRouterBase(_l1ChainId, _eraChainId, IBridgehub(L2_BRIDGEHUB_ADDR)) { + L2_LEGACY_SHARED_BRIDGE = _legacySharedBridge; + if (_l1AssetRouter == address(0)) { + revert EmptyAddress(); + } + l1AssetRouter = _l1AssetRouter; + assetHandlerAddress[_baseTokenAssetId] = L2_NATIVE_TOKEN_VAULT_ADDR; + BASE_TOKEN_ASSET_ID = _baseTokenAssetId; + _disableInitializers(); + } + + /// @inheritdoc IL2AssetRouter + function setAssetHandlerAddress( + uint256 _originChainId, + bytes32 _assetId, + address _assetAddress + ) external override onlyAssetRouterCounterpart(_originChainId) { + assetHandlerAddress[_assetId] = _assetAddress; + emit AssetHandlerRegistered(_assetId, _assetAddress); + } + + /// @inheritdoc IAssetRouterBase + function setAssetHandlerAddressThisChain( + bytes32 _assetRegistrationData, + address _assetHandlerAddress + ) external override(AssetRouterBase) { + _setAssetHandlerAddressThisChain(L2_NATIVE_TOKEN_VAULT_ADDR, _assetRegistrationData, _assetHandlerAddress); + } + + /*////////////////////////////////////////////////////////////// + Receive transaction Functions + //////////////////////////////////////////////////////////////*/ + + /// @notice Finalize the deposit and mint funds + /// @param _assetId The encoding of the asset on L2 + /// @param _transferData The encoded data required for deposit (address _l1Sender, uint256 _amount, address _l2Receiver, bytes memory erc20Data, address originToken) + function finalizeDeposit( + // solhint-disable-next-line no-unused-vars + uint256, + bytes32 _assetId, + bytes calldata _transferData + ) public override onlyAssetRouterCounterpartOrSelf(L1_CHAIN_ID) { + if (_assetId == BASE_TOKEN_ASSET_ID) { + revert AssetIdNotSupported(BASE_TOKEN_ASSET_ID); + } + _finalizeDeposit(L1_CHAIN_ID, _assetId, _transferData, L2_NATIVE_TOKEN_VAULT_ADDR); + + emit DepositFinalizedAssetRouter(L1_CHAIN_ID, _assetId, _transferData); + } + + /*////////////////////////////////////////////////////////////// + LEGACY FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @notice Initiates a withdrawal by burning funds on the contract and sending the message to L1 + /// where tokens would be unlocked + /// @dev do not rely on this function, it will be deprecated in the future + /// @param _assetId The asset id of the withdrawn asset + /// @param _assetData The data that is passed to the asset handler contract + function withdraw(bytes32 _assetId, bytes memory _assetData) public override { + _withdrawSender(_assetId, _assetData, msg.sender, true); + } + + /// @notice Initiates a withdrawal by burning funds on the contract and sending the message to L1 + /// where tokens would be unlocked + /// @param _assetId The asset id of the withdrawn asset + /// @param _assetData The data that is passed to the asset handler contract + /// @param _sender The address of the sender of the message + /// @param _alwaysNewMessageFormat Whether to use the new message format compatible with Custom Asset Handlers + function _withdrawSender( + bytes32 _assetId, + bytes memory _assetData, + address _sender, + bool _alwaysNewMessageFormat + ) internal { + address assetHandler = assetHandlerAddress[_assetId]; + bytes memory _l1bridgeMintData = IAssetHandler(assetHandler).bridgeBurn({ + _chainId: L1_CHAIN_ID, + _msgValue: 0, + _assetId: _assetId, + _originalCaller: _sender, + _data: _assetData + }); + + bytes memory message; + if (_alwaysNewMessageFormat || L2_LEGACY_SHARED_BRIDGE == address(0)) { + message = _getAssetRouterWithdrawMessage(_assetId, _l1bridgeMintData); + // slither-disable-next-line unused-return + L2ContractHelper.sendMessageToL1(message); + } else { + address l1Token = IL2NativeTokenVault(L2_NATIVE_TOKEN_VAULT_ADDR).tokenAddress(_assetId); + require(l1Token != address(0), "Unsupported asset Id by NTV"); + (uint256 amount, address l1Receiver) = abi.decode(_assetData, (uint256, address)); + message = _getSharedBridgeWithdrawMessage(l1Receiver, l1Token, amount); + IL2SharedBridgeLegacy(L2_LEGACY_SHARED_BRIDGE).sendMessageToL1(message); + } + + emit WithdrawalInitiatedAssetRouter(L1_CHAIN_ID, _sender, _assetId, _assetData); + } + + /// @notice Encodes the message for l2ToL1log sent during withdraw initialization. + /// @param _assetId The encoding of the asset on L2 which is withdrawn. + /// @param _l1bridgeMintData The calldata used by l1 asset handler to unlock tokens for recipient. + function _getAssetRouterWithdrawMessage( + bytes32 _assetId, + bytes memory _l1bridgeMintData + ) internal pure returns (bytes memory) { + // solhint-disable-next-line func-named-parameters + return abi.encodePacked(IAssetRouterBase.finalizeDeposit.selector, _assetId, _l1bridgeMintData); + } + + /// @notice Encodes the message for l2ToL1log sent during withdraw initialization. + function _getSharedBridgeWithdrawMessage( + address _l1Receiver, + address _l1Token, + uint256 _amount + ) internal pure returns (bytes memory) { + // solhint-disable-next-line func-named-parameters + return abi.encodePacked(IL1ERC20Bridge.finalizeWithdrawal.selector, _l1Receiver, _l1Token, _amount); + } + + /// @notice Legacy finalizeDeposit. + /// @dev Finalizes the deposit and mint funds. + /// @param _l1Sender The address of token sender on L1. + /// @param _l2Receiver The address of token receiver on L2. + /// @param _l1Token The address of the token transferred. + /// @param _amount The amount of the token transferred. + /// @param _data The metadata of the token transferred. + function finalizeDeposit( + address _l1Sender, + address _l2Receiver, + address _l1Token, + uint256 _amount, + bytes calldata _data + ) external onlyAssetRouterCounterpart(L1_CHAIN_ID) { + bytes32 assetId = DataEncoding.encodeNTVAssetId(L1_CHAIN_ID, _l1Token); + // solhint-disable-next-line func-named-parameters + bytes memory data = DataEncoding.encodeBridgeMintData(_l1Sender, _l2Receiver, _l1Token, _amount, _data); + this.finalizeDeposit(L1_CHAIN_ID, assetId, data); + } + + /// @notice Initiates a withdrawal by burning funds on the contract and sending the message to L1 + /// where tokens would be unlocked + /// @dev A compatibility method to support legacy functionality for the SDK. + /// @param _l1Receiver The account address that should receive funds on L1 + /// @param _l2Token The L2 token address which is withdrawn + /// @param _amount The total amount of tokens to be withdrawn + function withdraw(address _l1Receiver, address _l2Token, uint256 _amount) external { + if (_amount == 0) { + revert AmountMustBeGreaterThanZero(); + } + _withdrawLegacy(_l1Receiver, _l2Token, _amount, msg.sender); + } + + /// @notice Legacy withdraw. + /// @dev Finalizes the deposit and mint funds. + /// @param _l1Receiver The address of token receiver on L1. + /// @param _l2Token The address of token on L2. + /// @param _amount The amount of the token transferred. + /// @param _sender The original msg.sender. + function withdrawLegacyBridge( + address _l1Receiver, + address _l2Token, + uint256 _amount, + address _sender + ) external onlyLegacyBridge { + _withdrawLegacy(_l1Receiver, _l2Token, _amount, _sender); + } + + function _withdrawLegacy(address _l1Receiver, address _l2Token, uint256 _amount, address _sender) internal { + bytes32 assetId = DataEncoding.encodeNTVAssetId(L1_CHAIN_ID, getL1TokenAddress(_l2Token)); + bytes memory data = abi.encode(_amount, _l1Receiver); + _withdrawSender(assetId, data, _sender, false); + } + + /// @notice Legacy getL1TokenAddress. + /// @param _l2Token The address of token on L2. + /// @return The address of token on L1. + function getL1TokenAddress(address _l2Token) public view returns (address) { + return IBridgedStandardToken(_l2Token).l1Address(); + } + + /// @notice Legacy function used for backward compatibility to return L2 wrapped token + /// @notice address corresponding to provided L1 token address and deployed through NTV. + /// @dev However, the shared bridge can use custom asset handlers such that L2 addresses differ, + /// @dev or an L1 token may not have an L2 counterpart. + /// @param _l1Token The address of token on L1. + /// @return Address of an L2 token counterpart + function l2TokenAddress(address _l1Token) public view returns (address) { + IL2NativeTokenVault l2NativeTokenVault = IL2NativeTokenVault(L2_NATIVE_TOKEN_VAULT_ADDR); + address currentlyDeployedAddress = l2NativeTokenVault.l2TokenAddress(_l1Token); + + if (currentlyDeployedAddress != address(0)) { + return currentlyDeployedAddress; + } + + // For backwards compatibility, the bridge smust return the address of the token even if it + // has not been deployed yet. + return l2NativeTokenVault.calculateCreate2TokenAddress(L1_CHAIN_ID, _l1Token); + } + + /// @notice Returns the address of the L1 asset router. + /// @dev The old name is kept for backward compatibility. + function l1Bridge() external view returns (address) { + return l1AssetRouter; + } +} diff --git a/l1-contracts/contracts/bridge/interfaces/IAssetHandler.sol b/l1-contracts/contracts/bridge/interfaces/IAssetHandler.sol new file mode 100644 index 000000000..57f58eb59 --- /dev/null +++ b/l1-contracts/contracts/bridge/interfaces/IAssetHandler.sol @@ -0,0 +1,45 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +/// @title Asset Handler contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice Used for any asset handler and called by the AssetRouter +interface IAssetHandler { + /// @dev Emitted when a new token is initialized + event BridgeInitialize(address indexed token, string name, string symbol, uint8 decimals); + + /// @dev Emitted when a token is minted + event BridgeMint(uint256 indexed chainId, bytes32 indexed assetId, address receiver, uint256 amount); + + /// @dev Emitted when a token is burned + event BridgeBurn( + uint256 indexed chainId, + bytes32 indexed assetId, + address indexed sender, + address receiver, + uint256 amount + ); + + /// @param _chainId the chainId that the message is from + /// @param _assetId the assetId of the asset being bridged + /// @param _data the actual data specified for the function + function bridgeMint(uint256 _chainId, bytes32 _assetId, bytes calldata _data) external payable; + + /// @notice Burns bridged tokens and returns the calldata for L2 -> L1 message. + /// @dev In case of native token vault _data is the tuple of _depositAmount and _l2Receiver. + /// @param _chainId the chainId that the message will be sent to + /// @param _msgValue the msg.value of the L2 transaction. For now it is always 0. + /// @param _assetId the assetId of the asset being bridged + /// @param _originalCaller the original caller of the + /// @param _data the actual data specified for the function + /// @return _bridgeMintData The calldata used by counterpart asset handler to unlock tokens for recipient. + function bridgeBurn( + uint256 _chainId, + uint256 _msgValue, + bytes32 _assetId, + address _originalCaller, + bytes calldata _data + ) external payable returns (bytes memory _bridgeMintData); +} diff --git a/l2-contracts/contracts/bridge/interfaces/IL2StandardToken.sol b/l1-contracts/contracts/bridge/interfaces/IBridgedStandardToken.sol similarity index 88% rename from l2-contracts/contracts/bridge/interfaces/IL2StandardToken.sol rename to l1-contracts/contracts/bridge/interfaces/IBridgedStandardToken.sol index 38cad77d3..952bc1871 100644 --- a/l2-contracts/contracts/bridge/interfaces/IL2StandardToken.sol +++ b/l1-contracts/contracts/bridge/interfaces/IBridgedStandardToken.sol @@ -2,7 +2,7 @@ // We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.20; -interface IL2StandardToken { +interface IBridgedStandardToken { event BridgeInitialize(address indexed l1Token, string name, string symbol, uint8 decimals); event BridgeMint(address indexed account, uint256 amount); @@ -15,5 +15,7 @@ interface IL2StandardToken { function l1Address() external view returns (address); + function originToken() external view returns (address); + function l2Bridge() external view returns (address); } diff --git a/l1-contracts/contracts/bridge/interfaces/IL1AssetDeploymentTracker.sol b/l1-contracts/contracts/bridge/interfaces/IL1AssetDeploymentTracker.sol new file mode 100644 index 000000000..6fb6538b6 --- /dev/null +++ b/l1-contracts/contracts/bridge/interfaces/IL1AssetDeploymentTracker.sol @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IL1AssetDeploymentTracker { + function bridgeCheckCounterpartAddress( + uint256 _chainId, + bytes32 _assetId, + address _originalCaller, + address _assetHandlerAddressOnCounterpart + ) external view; +} diff --git a/l1-contracts/contracts/bridge/interfaces/IL1AssetHandler.sol b/l1-contracts/contracts/bridge/interfaces/IL1AssetHandler.sol index a707da173..c62dce3da 100644 --- a/l1-contracts/contracts/bridge/interfaces/IL1AssetHandler.sol +++ b/l1-contracts/contracts/bridge/interfaces/IL1AssetHandler.sol @@ -7,43 +7,6 @@ pragma solidity 0.8.24; /// @custom:security-contact security@matterlabs.dev /// @notice Used for any asset handler and called by the L1AssetRouter interface IL1AssetHandler { - /// @dev Emitted when a new token is initialized - event BridgeInitialize(address indexed l1Token, string name, string symbol, uint8 decimals); - - /// @dev Emitted when a token is minted - event BridgeMint(uint256 indexed chainId, bytes32 indexed assetId, address l1Receiver, uint256 amount); - - /// @dev Emitted when a token is burned - event BridgeBurn( - uint256 indexed chainId, - bytes32 indexed assetId, - address indexed l1Sender, - address l2receiver, - uint256 amount - ); - - /// @param _chainId the chainId that the message is from - /// @param _assetId the assetId of the asset being bridged - /// @param _data the actual data specified for the function - function bridgeMint( - uint256 _chainId, - bytes32 _assetId, - bytes calldata _data - ) external payable returns (address l1Receiver); - - /// @param _chainId the chainId that the message will be sent to - /// @param _l2Value the msg.value of the L2 transaction - /// @param _assetId the assetId of the asset being bridged - /// @param _prevMsgSender the original caller of the Bridgehub, - /// @param _data the actual data specified for the function - function bridgeBurn( - uint256 _chainId, - uint256 _l2Value, - bytes32 _assetId, - address _prevMsgSender, - bytes calldata _data - ) external payable returns (bytes memory _bridgeMintData); - /// @param _chainId the chainId that the message will be sent to /// @param _assetId the assetId of the asset being bridged /// @param _depositSender the address of the entity that initiated the deposit. diff --git a/l1-contracts/contracts/bridge/interfaces/IL1AssetRouter.sol b/l1-contracts/contracts/bridge/interfaces/IL1AssetRouter.sol deleted file mode 100644 index 27dbbd539..000000000 --- a/l1-contracts/contracts/bridge/interfaces/IL1AssetRouter.sol +++ /dev/null @@ -1,188 +0,0 @@ -// SPDX-License-Identifier: MIT -// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. -pragma solidity ^0.8.21; - -import {L2TransactionRequestTwoBridgesInner} from "../../bridgehub/IBridgehub.sol"; -import {IBridgehub} from "../../bridgehub/IBridgehub.sol"; -import {IL1ERC20Bridge} from "./IL1ERC20Bridge.sol"; -import {IL1NativeTokenVault} from "./IL1NativeTokenVault.sol"; - -/// @title L1 Bridge contract interface -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -interface IL1AssetRouter { - event LegacyDepositInitiated( - uint256 indexed chainId, - bytes32 indexed l2DepositTxHash, - address indexed from, - address to, - address l1Asset, - uint256 amount - ); - - event BridgehubDepositInitiated( - uint256 indexed chainId, - bytes32 indexed txDataHash, - address indexed from, - bytes32 assetId, - bytes bridgeMintCalldata - ); - - event BridgehubDepositBaseTokenInitiated( - uint256 indexed chainId, - address indexed from, - bytes32 assetId, - uint256 amount - ); - - event BridgehubMintData(bytes bridgeMintData); - - event BridgehubDepositFinalized( - uint256 indexed chainId, - bytes32 indexed txDataHash, - bytes32 indexed l2DepositTxHash - ); - - event WithdrawalFinalizedSharedBridge( - uint256 indexed chainId, - address indexed to, - bytes32 indexed assetId, - uint256 amount - ); - - event ClaimedFailedDepositSharedBridge( - uint256 indexed chainId, - address indexed to, - bytes32 indexed assetId, - bytes assetData - ); - - event AssetDeploymentTrackerSet( - bytes32 indexed assetId, - address indexed assetDeploymentTracker, - bytes32 indexed additionalData - ); - - event AssetHandlerRegisteredInitial( - bytes32 indexed assetId, - address indexed assetHandlerAddress, - bytes32 indexed additionalData, - address sender - ); - - function isWithdrawalFinalized( - uint256 _chainId, - uint256 _l2BatchNumber, - uint256 _l2ToL1MessageNumber - ) external view returns (bool); - - function depositLegacyErc20Bridge( - address _prevMsgSender, - address _l2Receiver, - address _l1Token, - uint256 _amount, - uint256 _l2TxGasLimit, - uint256 _l2TxGasPerPubdataByte, - address _refundRecipient - ) external payable returns (bytes32 txHash); - - function claimFailedDeposit( - uint256 _chainId, - address _depositSender, - address _l1Token, - uint256 _amount, - bytes32 _l2TxHash, - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes32[] calldata _merkleProof - ) external; - - function finalizeWithdrawalLegacyErc20Bridge( - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes calldata _message, - bytes32[] calldata _merkleProof - ) external returns (address l1Receiver, address l1Asset, uint256 amount); - - function finalizeWithdrawal( - uint256 _chainId, - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes calldata _message, - bytes32[] calldata _merkleProof - ) external; - - function L1_WETH_TOKEN() external view returns (address); - - function BRIDGE_HUB() external view returns (IBridgehub); - - function legacyBridge() external view returns (IL1ERC20Bridge); - - function depositHappened(uint256 _chainId, bytes32 _l2DepositTxHash) external view returns (bytes32); - - /// @dev Data has the following abi encoding for legacy deposits: - /// address _l1Token, - /// uint256 _amount, - /// address _l2Receiver - /// for new deposits: - /// bytes32 _assetId, - /// bytes _transferData - function bridgehubDeposit( - uint256 _chainId, - address _prevMsgSender, - uint256 _l2Value, - bytes calldata _data - ) external payable returns (L2TransactionRequestTwoBridgesInner memory request); - - function bridgehubDepositBaseToken( - uint256 _chainId, - bytes32 _assetId, - address _prevMsgSender, - uint256 _amount - ) external payable; - - function bridgehubConfirmL2Transaction(uint256 _chainId, bytes32 _txDataHash, bytes32 _txHash) external; - - function hyperbridgingEnabled(uint256 _chainId) external view returns (bool); - - function setAssetDeploymentTracker(bytes32 _assetRegistrationData, address _assetDeploymentTracker) external; - - function setAssetHandlerAddressInitial(bytes32 _additionalData, address _assetHandlerAddress) external; - - function setAssetHandlerAddressOnCounterPart( - uint256 _chainId, - uint256 _mintValue, - uint256 _l2TxGasLimit, - uint256 _l2TxGasPerPubdataByte, - address _refundRecipient, - bytes32 _assetId, - address _assetAddressOnCounterPart - ) external payable returns (bytes32 l2TxHash); - - function assetHandlerAddress(bytes32 _assetId) external view returns (address); - - function nativeTokenVault() external view returns (IL1NativeTokenVault); - - function setNativeTokenVault(IL1NativeTokenVault _nativeTokenVault) external; - - function bridgeRecoverFailedTransfer( - uint256 _chainId, - address _depositSender, - bytes32 _assetId, - bytes calldata _assetData, - bytes32 _l2TxHash, - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes32[] calldata _merkleProof - ) external; - - function chainBalance(uint256 _chainId, address _l1Token) external view returns (uint256); - - function transferTokenToNTV(address _token) external; - - function nullifyChainBalanceByNTV(uint256 _chainId, address _token) external; -} diff --git a/l1-contracts/contracts/bridge/interfaces/IL1BaseTokenAssetHandler.sol b/l1-contracts/contracts/bridge/interfaces/IL1BaseTokenAssetHandler.sol new file mode 100644 index 000000000..1e8d08bdd --- /dev/null +++ b/l1-contracts/contracts/bridge/interfaces/IL1BaseTokenAssetHandler.sol @@ -0,0 +1,12 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +/// @title L1 Base Token Asset Handler contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice Used for any asset handler and called by the L1AssetRouter +interface IL1BaseTokenAssetHandler { + /// @notice Used to get the token address of an assetId + function tokenAddress(bytes32 _assetId) external view returns (address); +} diff --git a/l1-contracts/contracts/bridge/interfaces/IL1ERC20Bridge.sol b/l1-contracts/contracts/bridge/interfaces/IL1ERC20Bridge.sol index b9426f3e1..fcba5da5a 100644 --- a/l1-contracts/contracts/bridge/interfaces/IL1ERC20Bridge.sol +++ b/l1-contracts/contracts/bridge/interfaces/IL1ERC20Bridge.sol @@ -2,8 +2,9 @@ // We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.21; -import {IL1AssetRouter} from "./IL1AssetRouter.sol"; -import {IL1NativeTokenVault} from "./IL1NativeTokenVault.sol"; +import {IL1Nullifier} from "./IL1Nullifier.sol"; +import {IL1NativeTokenVault} from "../ntv/IL1NativeTokenVault.sol"; +import {IL1AssetRouter} from "../asset-router/IL1AssetRouter.sol"; /// @title L1 Bridge contract legacy interface /// @author Matter Labs @@ -61,9 +62,11 @@ interface IL1ERC20Bridge { function l2TokenAddress(address _l1Token) external view returns (address); - function SHARED_BRIDGE() external view returns (IL1AssetRouter); + function L1_NULLIFIER() external view returns (IL1Nullifier); - function NATIVE_TOKEN_VAULT() external view returns (IL1NativeTokenVault); + function L1_ASSET_ROUTER() external view returns (IL1AssetRouter); + + function L1_NATIVE_TOKEN_VAULT() external view returns (IL1NativeTokenVault); function l2TokenBeacon() external view returns (address); diff --git a/l1-contracts/contracts/bridge/interfaces/IL1NativeTokenVault.sol b/l1-contracts/contracts/bridge/interfaces/IL1NativeTokenVault.sol deleted file mode 100644 index 4572d8e01..000000000 --- a/l1-contracts/contracts/bridge/interfaces/IL1NativeTokenVault.sol +++ /dev/null @@ -1,29 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {IL1AssetRouter} from "./IL1AssetRouter.sol"; - -/// @title L1 Native token vault contract interface -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -/// @notice The NTV is an Asset Handler for the L1AssetRouter to handle native tokens -interface IL1NativeTokenVault { - /// @notice The L1AssetRouter contract - function L1_SHARED_BRIDGE() external view returns (IL1AssetRouter); - - /// @notice The weth contract - function L1_WETH_TOKEN() external view returns (address); - - /// @notice Used to register a token in the vault - function registerToken(address _l1Token) external; - - /// @notice Used to get the ERC20 data for a token - function getERC20Getters(address _token) external view returns (bytes memory); - - /// @notice Used the get token balance for specific ZK chain in shared bridge - function chainBalance(uint256 _chainId, address _l1Token) external view returns (uint256); - - /// @notice Used to get the token address of an assetId - function tokenAddress(bytes32 _assetId) external view returns (address); -} diff --git a/l1-contracts/contracts/bridge/interfaces/IL1Nullifier.sol b/l1-contracts/contracts/bridge/interfaces/IL1Nullifier.sol new file mode 100644 index 000000000..f5bd3539c --- /dev/null +++ b/l1-contracts/contracts/bridge/interfaces/IL1Nullifier.sol @@ -0,0 +1,111 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {IBridgehub} from "../../bridgehub/IBridgehub.sol"; +import {IL1NativeTokenVault} from "../ntv/IL1NativeTokenVault.sol"; +import {IL1ERC20Bridge} from "./IL1ERC20Bridge.sol"; + +/// @param chainId The chain ID of the transaction to check. +/// @param l2BatchNumber The L2 batch number where the withdrawal was processed. +/// @param l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. +/// @param l2sender The address of the message sender on L2 (base token system contract address or asset handler) +/// @param l2TxNumberInBatch The L2 transaction number in the batch, in which the log was sent. +/// @param message The L2 withdraw data, stored in an L2 -> L1 message. +/// @param merkleProof The Merkle proof of the inclusion L2 -> L1 message about withdrawal initialization. +struct FinalizeL1DepositParams { + uint256 chainId; + uint256 l2BatchNumber; + uint256 l2MessageIndex; + address l2Sender; + uint16 l2TxNumberInBatch; + bytes message; + bytes32[] merkleProof; +} + +/// @title L1 Bridge contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IL1Nullifier { + event BridgehubDepositFinalized( + uint256 indexed chainId, + bytes32 indexed txDataHash, + bytes32 indexed l2DepositTxHash + ); + + function isWithdrawalFinalized( + uint256 _chainId, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex + ) external view returns (bool); + + function claimFailedDepositLegacyErc20Bridge( + address _depositSender, + address _l1Token, + uint256 _amount, + bytes32 _l2TxHash, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes32[] calldata _merkleProof + ) external; + + function claimFailedDeposit( + uint256 _chainId, + address _depositSender, + address _l1Token, + uint256 _amount, + bytes32 _l2TxHash, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes32[] calldata _merkleProof + ) external; + + function finalizeDeposit(FinalizeL1DepositParams calldata _finalizeWithdrawalParams) external; + + function BRIDGE_HUB() external view returns (IBridgehub); + + function legacyBridge() external view returns (IL1ERC20Bridge); + + function depositHappened(uint256 _chainId, bytes32 _l2TxHash) external view returns (bytes32); + + function bridgehubConfirmL2TransactionForwarded(uint256 _chainId, bytes32 _txDataHash, bytes32 _txHash) external; + + function l1NativeTokenVault() external view returns (IL1NativeTokenVault); + + function setL1NativeTokenVault(IL1NativeTokenVault _nativeTokenVault) external; + + function setL1AssetRouter(address _l1AssetRouter) external; + + function __DEPRECATED_chainBalance(uint256 _chainId, address _token) external view returns (uint256); + + function __DEPRECATED_l2BridgeAddress(uint256 _chainId) external view returns (address); + + function transferTokenToNTV(address _token) external; + + function nullifyChainBalanceByNTV(uint256 _chainId, address _token) external; + + /// @dev Withdraw funds from the initiated deposit, that failed when finalizing on L2. + /// @param _chainId The ZK chain id to which deposit was initiated. + /// @param _depositSender The address of the entity that initiated the deposit. + /// @param _assetId The unique identifier of the deposited L1 token. + /// @param _assetData The encoded transfer data, which includes both the deposit amount and the address of the L2 receiver. Might include extra information. + /// @param _l2TxHash The L2 transaction hash of the failed deposit finalization. + /// @param _l2BatchNumber The L2 batch number where the deposit finalization was processed. + /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message. + /// @param _l2TxNumberInBatch The L2 transaction number in a batch, in which the log was sent. + /// @param _merkleProof The Merkle proof of the processing L1 -> L2 transaction with deposit finalization. + /// @dev Processes claims of failed deposit, whether they originated from the legacy bridge or the current system. + function bridgeRecoverFailedTransfer( + uint256 _chainId, + address _depositSender, + bytes32 _assetId, + bytes memory _assetData, + bytes32 _l2TxHash, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes32[] calldata _merkleProof + ) external; +} diff --git a/l1-contracts/contracts/bridge/interfaces/IL1SharedBridgeLegacy.sol b/l1-contracts/contracts/bridge/interfaces/IL1SharedBridgeLegacy.sol new file mode 100644 index 000000000..627048f75 --- /dev/null +++ b/l1-contracts/contracts/bridge/interfaces/IL1SharedBridgeLegacy.sol @@ -0,0 +1,19 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +/// @title L1 Bridge contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IL1SharedBridgeLegacy { + function l2BridgeAddress(uint256 _chainId) external view returns (address); + + event LegacyDepositInitiated( + uint256 indexed chainId, + bytes32 indexed l2DepositTxHash, + address indexed from, + address to, + address l1Asset, + uint256 amount + ); +} diff --git a/l1-contracts/contracts/bridge/interfaces/IL2BridgeLegacy.sol b/l1-contracts/contracts/bridge/interfaces/IL2SharedBridgeLegacy.sol similarity index 53% rename from l1-contracts/contracts/bridge/interfaces/IL2BridgeLegacy.sol rename to l1-contracts/contracts/bridge/interfaces/IL2SharedBridgeLegacy.sol index b163262c7..00a762447 100644 --- a/l1-contracts/contracts/bridge/interfaces/IL2BridgeLegacy.sol +++ b/l1-contracts/contracts/bridge/interfaces/IL2SharedBridgeLegacy.sol @@ -1,21 +1,21 @@ // SPDX-License-Identifier: MIT -pragma solidity 0.8.24; +pragma solidity ^0.8.20; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -interface IL2BridgeLegacy { +interface IL2SharedBridgeLegacy { function withdraw(address _l1Receiver, address _l2Token, uint256 _amount) external; - function finalizeDeposit( - address _l1Sender, - address _l2Receiver, - address _l1Token, - uint256 _amount, - bytes calldata _data - ) external payable; - function l1TokenAddress(address _l2Token) external view returns (address); function l2TokenAddress(address _l1Token) external view returns (address); + + function l1Bridge() external view returns (address); + + function l1SharedBridge() external view returns (address); + + function deployBeaconProxy(bytes32 _salt) external returns (address); + + function sendMessageToL1(bytes calldata _message) external; } diff --git a/l2-contracts/contracts/bridge/interfaces/IL2SharedBridge.sol b/l1-contracts/contracts/bridge/interfaces/IL2SharedBridgeLegacyFunctions.sol similarity index 65% rename from l2-contracts/contracts/bridge/interfaces/IL2SharedBridge.sol rename to l1-contracts/contracts/bridge/interfaces/IL2SharedBridgeLegacyFunctions.sol index ee31f6691..42c8f7759 100644 --- a/l2-contracts/contracts/bridge/interfaces/IL2SharedBridge.sol +++ b/l1-contracts/contracts/bridge/interfaces/IL2SharedBridgeLegacyFunctions.sol @@ -3,7 +3,7 @@ pragma solidity ^0.8.20; /// @author Matter Labs -interface IL2SharedBridge { +interface IL2SharedBridgeLegacyFunctions { event FinalizeDeposit( address indexed l1Sender, address indexed l2Receiver, @@ -25,14 +25,4 @@ interface IL2SharedBridge { uint256 _amount, bytes calldata _data ) external; - - function withdraw(address _l1Receiver, address _l2Token, uint256 _amount) external; - - function l1TokenAddress(address _l2Token) external view returns (address); - - function l2TokenAddress(address _l1Token) external view returns (address); - - function l1Bridge() external view returns (address); - - function l1SharedBridge() external view returns (address); } diff --git a/l2-contracts/contracts/bridge/interfaces/IL2WrappedBaseToken.sol b/l1-contracts/contracts/bridge/interfaces/IL2WrappedBaseToken.sol similarity index 100% rename from l2-contracts/contracts/bridge/interfaces/IL2WrappedBaseToken.sol rename to l1-contracts/contracts/bridge/interfaces/IL2WrappedBaseToken.sol diff --git a/l1-contracts/contracts/bridge/ntv/IL1NativeTokenVault.sol b/l1-contracts/contracts/bridge/ntv/IL1NativeTokenVault.sol new file mode 100644 index 000000000..1d16f48fb --- /dev/null +++ b/l1-contracts/contracts/bridge/ntv/IL1NativeTokenVault.sol @@ -0,0 +1,24 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {IL1Nullifier} from "../interfaces/IL1Nullifier.sol"; +import {INativeTokenVault} from "./INativeTokenVault.sol"; + +/// @title L1 Native token vault contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice The NTV is an Asset Handler for the L1AssetRouter to handle native tokens +// is IL1AssetHandler, IL1BaseTokenAssetHandler { +interface IL1NativeTokenVault is INativeTokenVault { + /// @notice The L1Nullifier contract + function L1_NULLIFIER() external view returns (IL1Nullifier); + + /// @notice Returns the total number of specific tokens locked for some chain + function chainBalance(uint256 _chainId, bytes32 _assetId) external view returns (uint256); + + /// @notice Registers ETH token + function registerEthToken() external; + + event TokenBeaconUpdated(address indexed l2TokenBeacon); +} diff --git a/l2-contracts/contracts/bridge/interfaces/IL2NativeTokenVault.sol b/l1-contracts/contracts/bridge/ntv/IL2NativeTokenVault.sol similarity index 57% rename from l2-contracts/contracts/bridge/interfaces/IL2NativeTokenVault.sol rename to l1-contracts/contracts/bridge/ntv/IL2NativeTokenVault.sol index 8b44eba55..8938a8c28 100644 --- a/l2-contracts/contracts/bridge/interfaces/IL2NativeTokenVault.sol +++ b/l1-contracts/contracts/bridge/ntv/IL2NativeTokenVault.sol @@ -1,13 +1,12 @@ // SPDX-License-Identifier: MIT -pragma solidity 0.8.20; +pragma solidity ^0.8.20; -// import {IL2AssetRouter} from "./IL2AssetRouter.sol"; -import {IL2AssetHandler} from "./IL2AssetHandler.sol"; +import {INativeTokenVault} from "./INativeTokenVault.sol"; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -interface IL2NativeTokenVault is IL2AssetHandler { +interface IL2NativeTokenVault is INativeTokenVault { event FinalizeDeposit( address indexed l1Sender, address indexed l2Receiver, @@ -24,11 +23,5 @@ interface IL2NativeTokenVault is IL2AssetHandler { event L2TokenBeaconUpdated(address indexed l2TokenBeacon, bytes32 indexed l2TokenProxyBytecodeHash); - function tokenAddress(bytes32 _assetId) external view returns (address); - function l2TokenAddress(address _l1Token) external view returns (address); - - function setL2TokenBeacon(address _l2TokenBeacon, bytes32 _l2TokenProxyBytecodeHash) external; - - function configureL2TokenBeacon(bool _contractsDeployedAlready, address _l2TokenBeacon) external; } diff --git a/l1-contracts/contracts/bridge/ntv/INativeTokenVault.sol b/l1-contracts/contracts/bridge/ntv/INativeTokenVault.sol new file mode 100644 index 000000000..0cd78cf54 --- /dev/null +++ b/l1-contracts/contracts/bridge/ntv/INativeTokenVault.sol @@ -0,0 +1,39 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {IAssetRouterBase} from "../asset-router/IAssetRouterBase.sol"; + +/// @title Base Native token vault contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice The NTV is an Asset Handler for the L1AssetRouter to handle native tokens +interface INativeTokenVault { + event BridgedTokenBeaconUpdated(address bridgedTokenBeacon, bytes32 bridgedTokenProxyBytecodeHash); + + /// @notice The Weth token address + function WETH_TOKEN() external view returns (address); + + /// @notice The AssetRouter contract + function ASSET_ROUTER() external view returns (IAssetRouterBase); + /// @notice Returns the chain ID of the origin chain for a given asset ID + function originChainId(bytes32 assetId) external view returns (uint256); + + /// @notice Registers tokens within the NTV. + /// @dev The goal is to allow bridging native tokens automatically, by registering them on the fly. + /// @notice Allows the bridge to register a token address for the vault. + /// @notice No access control is ok, since the bridging of tokens should be permissionless. This requires permissionless registration. + function registerToken(address _l1Token) external; + + /// @notice Used to get the assetId of a token + function getAssetId(uint256 _chainId, address _tokenAddress) external view returns (bytes32); + + /// @notice Used to get the the ERC20 data for a token + function getERC20Getters(address _token, uint256 _originChainId) external view returns (bytes memory); + + /// @notice Used to get the token address of an assetId + function tokenAddress(bytes32 assetId) external view returns (address); + + /// @notice Used to get the expected bridged token address corresponding to its native counterpart + function calculateCreate2TokenAddress(uint256 _originChainId, address _originToken) external view returns (address); +} diff --git a/l1-contracts/contracts/bridge/ntv/L1NativeTokenVault.sol b/l1-contracts/contracts/bridge/ntv/L1NativeTokenVault.sol new file mode 100644 index 000000000..be456db43 --- /dev/null +++ b/l1-contracts/contracts/bridge/ntv/L1NativeTokenVault.sol @@ -0,0 +1,272 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +// solhint-disable reason-string, gas-custom-errors + +import {BeaconProxy} from "@openzeppelin/contracts-v4/proxy/beacon/BeaconProxy.sol"; +import {IBeacon} from "@openzeppelin/contracts-v4/proxy/beacon/IBeacon.sol"; +import {Create2} from "@openzeppelin/contracts-v4/utils/Create2.sol"; + +import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; +import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; + +import {IL1NativeTokenVault} from "./IL1NativeTokenVault.sol"; +import {INativeTokenVault} from "./INativeTokenVault.sol"; +import {NativeTokenVault} from "./NativeTokenVault.sol"; + +import {IL1AssetHandler} from "../interfaces/IL1AssetHandler.sol"; +import {IL1Nullifier} from "../interfaces/IL1Nullifier.sol"; +import {IL1AssetRouter} from "../asset-router/IL1AssetRouter.sol"; + +import {ETH_TOKEN_ADDRESS} from "../../common/Config.sol"; +import {DataEncoding} from "../../common/libraries/DataEncoding.sol"; + +import {Unauthorized, ZeroAddress, NoFundsTransferred, InsufficientChainBalance, WithdrawFailed} from "../../common/L1ContractErrors.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @dev Vault holding L1 native ETH and ERC20 tokens bridged into the ZK chains. +/// @dev Designed for use with a proxy for upgradability. +contract L1NativeTokenVault is IL1NativeTokenVault, IL1AssetHandler, NativeTokenVault { + using SafeERC20 for IERC20; + + /// @dev L1 nullifier contract that handles legacy functions & finalize withdrawal, confirm l2 tx mappings + IL1Nullifier public immutable override L1_NULLIFIER; + + /// @dev Era's chainID + uint256 public immutable ERA_CHAIN_ID; + + /// @dev Maps token balances for each chain to prevent unauthorized spending across ZK chains. + /// This serves as a security measure until hyperbridging is implemented. + /// NOTE: this function may be removed in the future, don't rely on it! + mapping(uint256 chainId => mapping(bytes32 assetId => uint256 balance)) public chainBalance; + + /// @dev Contract is expected to be used as proxy implementation. + /// @dev Initialize the implementation to prevent Parity hack. + /// @param _l1WethAddress Address of WETH on deployed chain + /// @param _l1AssetRouter Address of Asset Router on L1. + /// @param _eraChainId ID of Era. + /// @param _l1Nullifier Address of the nullifier contract, which handles transaction progress between L1 and ZK chains. + constructor( + address _l1WethAddress, + address _l1AssetRouter, + uint256 _eraChainId, + IL1Nullifier _l1Nullifier + ) + NativeTokenVault( + _l1WethAddress, + _l1AssetRouter, + DataEncoding.encodeNTVAssetId(block.chainid, ETH_TOKEN_ADDRESS), + block.chainid + ) + { + ERA_CHAIN_ID = _eraChainId; + L1_NULLIFIER = _l1Nullifier; + } + + /// @dev Accepts ether only from the contract that was the shared Bridge. + receive() external payable { + if ((address(L1_NULLIFIER) != msg.sender) && (address(ASSET_ROUTER) != msg.sender)) { + revert Unauthorized(msg.sender); + } + } + + /// @dev Initializes a contract for later use. Expected to be used in the proxy + /// @param _owner Address which can change pause / unpause the NTV + /// implementation. The owner is the Governor and separate from the ProxyAdmin from now on, so that the Governor can call the bridge. + function initialize(address _owner, address _bridgedTokenBeacon) external initializer { + if (_owner == address(0)) { + revert ZeroAddress(); + } + bridgedTokenBeacon = IBeacon(_bridgedTokenBeacon); + _transferOwnership(_owner); + } + + /// @inheritdoc IL1NativeTokenVault + function registerEthToken() external { + _unsafeRegisterNativeToken(ETH_TOKEN_ADDRESS); + } + + /// @notice Transfers tokens from shared bridge as part of the migration process. + /// The shared bridge becomes the L1Nullifier contract. + /// @dev Both ETH and ERC20 tokens can be transferred. Exhausts balance of shared bridge after the first call. + /// @dev Calling second time for the same token will revert. + /// @param _token The address of token to be transferred (address(1) for ether and contract address for ERC20). + function transferFundsFromSharedBridge(address _token) external { + if (_token == ETH_TOKEN_ADDRESS) { + uint256 balanceBefore = address(this).balance; + L1_NULLIFIER.transferTokenToNTV(_token); + uint256 balanceAfter = address(this).balance; + if (balanceAfter <= balanceBefore) { + revert NoFundsTransferred(); + } + } else { + uint256 balanceBefore = IERC20(_token).balanceOf(address(this)); + uint256 nullifierChainBalance = IERC20(_token).balanceOf(address(L1_NULLIFIER)); + require(nullifierChainBalance > 0, "NTV: 0 amount to transfer"); + L1_NULLIFIER.transferTokenToNTV(_token); + uint256 balanceAfter = IERC20(_token).balanceOf(address(this)); + require(balanceAfter - balanceBefore >= nullifierChainBalance, "NTV: wrong amount transferred"); + } + } + + /// @notice Updates chain token balance within NTV to account for tokens transferred from the shared bridge (part of the migration process). + /// @dev Clears chain balance on the shared bridge after the first call. Subsequent calls will not affect the state. + /// @param _token The address of token to be transferred (address(1) for ether and contract address for ERC20). + /// @param _targetChainId The chain ID of the corresponding ZK chain. + function updateChainBalancesFromSharedBridge(address _token, uint256 _targetChainId) external { + uint256 nullifierChainBalance = L1_NULLIFIER.__DEPRECATED_chainBalance(_targetChainId, _token); + bytes32 assetId = DataEncoding.encodeNTVAssetId(block.chainid, _token); + chainBalance[_targetChainId][assetId] = chainBalance[_targetChainId][assetId] + nullifierChainBalance; + originChainId[assetId] = block.chainid; + L1_NULLIFIER.nullifyChainBalanceByNTV(_targetChainId, _token); + } + + /*////////////////////////////////////////////////////////////// + Start transaction Functions + //////////////////////////////////////////////////////////////*/ + + function _bridgeBurnNativeToken( + uint256 _chainId, + bytes32 _assetId, + address _originalCaller, + // solhint-disable-next-line no-unused-vars + bool _depositChecked, + bytes calldata _data + ) internal override returns (bytes memory _bridgeMintData) { + uint256 _depositAmount; + (_depositAmount, ) = abi.decode(_data, (uint256, address)); + bool depositChecked = IL1AssetRouter(address(ASSET_ROUTER)).transferFundsToNTV( + _assetId, + _depositAmount, + _originalCaller + ); + _bridgeMintData = super._bridgeBurnNativeToken({ + _chainId: _chainId, + _assetId: _assetId, + _originalCaller: _originalCaller, + _depositChecked: depositChecked, + _data: _data + }); + } + + /*////////////////////////////////////////////////////////////// + L1 SPECIFIC FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @inheritdoc IL1AssetHandler + function bridgeRecoverFailedTransfer( + uint256 _chainId, + bytes32 _assetId, + address _depositSender, + bytes calldata _data + ) external payable override onlyAssetRouter whenNotPaused { + (uint256 _amount, ) = abi.decode(_data, (uint256, address)); + address l1Token = tokenAddress[_assetId]; + if (_amount == 0) { + revert NoFundsTransferred(); + } + + _handleChainBalanceDecrease(_chainId, _assetId, _amount, false); + + if (l1Token == ETH_TOKEN_ADDRESS) { + bool callSuccess; + // Low-level assembly call, to avoid any memory copying (save gas) + assembly { + callSuccess := call(gas(), _depositSender, _amount, 0, 0, 0, 0) + } + require(callSuccess, "NTV: claimFailedDeposit failed, no funds or cannot transfer to receiver"); + } else { + IERC20(l1Token).safeTransfer(_depositSender, _amount); + // Note we don't allow weth deposits anymore, but there might be legacy weth deposits. + // until we add Weth bridging capabilities, we don't wrap/unwrap weth to ether. + } + } + + /*////////////////////////////////////////////////////////////// + INTERNAL & HELPER FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + // get the computed address before the contract DeployWithCreate2 deployed using Bytecode of contract DeployWithCreate2 and salt specified by the sender + function calculateCreate2TokenAddress( + uint256 _originChainId, + address _l1Token + ) public view override(INativeTokenVault, NativeTokenVault) returns (address) { + bytes32 salt = _getCreate2Salt(_originChainId, _l1Token); + return + Create2.computeAddress( + salt, + keccak256(abi.encodePacked(type(BeaconProxy).creationCode, abi.encode(bridgedTokenBeacon, ""))) + ); + } + + /// @notice Transfers tokens from the depositor address to the smart contract address. + /// @param _from The address of the depositor. + /// @param _token The ERC20 token to be transferred. + /// @param _amount The amount to be transferred. + /// @return The difference between the contract balance before and after the transferring of funds. + function _depositFunds(address _from, IERC20 _token, uint256 _amount) internal override returns (uint256) { + address from = _from; + // in the legacy scenario the SharedBridge = L1Nullifier was granting the allowance, we have to transfer from them instead of the user + if ( + _token.allowance(address(ASSET_ROUTER), address(this)) >= _amount && + _token.allowance(_from, address(this)) < _amount + ) { + from = address(ASSET_ROUTER); + } + return super._depositFunds(from, _token, _amount); + } + + function _withdrawFunds(bytes32 _assetId, address _to, address _token, uint256 _amount) internal override { + if (_assetId == BASE_TOKEN_ASSET_ID) { + bool callSuccess; + // Low-level assembly call, to avoid any memory copying (save gas) + assembly { + callSuccess := call(gas(), _to, _amount, 0, 0, 0, 0) + } + if (!callSuccess) { + revert WithdrawFailed(); + } + } else { + // Withdraw funds + IERC20(_token).safeTransfer(_to, _amount); + } + } + + function _deployBeaconProxy(bytes32 _salt) internal override returns (BeaconProxy proxy) { + // Use CREATE2 to deploy the BeaconProxy + address proxyAddress = Create2.deploy( + 0, + _salt, + abi.encodePacked(type(BeaconProxy).creationCode, abi.encode(bridgedTokenBeacon, "")) + ); + return BeaconProxy(payable(proxyAddress)); + } + + function _handleChainBalanceIncrease( + uint256 _chainId, + bytes32 _assetId, + uint256 _amount, + bool _isNative + ) internal override { + if ((_isNative) || (originChainId[_assetId] != _chainId)) { + chainBalance[_chainId][_assetId] += _amount; + } + } + + function _handleChainBalanceDecrease( + uint256 _chainId, + bytes32 _assetId, + uint256 _amount, + bool _isNative + ) internal override { + if ((_isNative) || (originChainId[_assetId] != _chainId)) { + // Check that the chain has sufficient balance + if (chainBalance[_chainId][_assetId] < _amount) { + revert InsufficientChainBalance(); + } + chainBalance[_chainId][_assetId] -= _amount; + } + } +} diff --git a/l1-contracts/contracts/bridge/ntv/L2NativeTokenVault.sol b/l1-contracts/contracts/bridge/ntv/L2NativeTokenVault.sol new file mode 100644 index 000000000..e96a6d289 --- /dev/null +++ b/l1-contracts/contracts/bridge/ntv/L2NativeTokenVault.sol @@ -0,0 +1,230 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {BeaconProxy} from "@openzeppelin/contracts-v4/proxy/beacon/BeaconProxy.sol"; +import {IBeacon} from "@openzeppelin/contracts-v4/proxy/beacon/IBeacon.sol"; +import {UpgradeableBeacon} from "@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol"; + +import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; +import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; + +import {INativeTokenVault} from "./INativeTokenVault.sol"; +import {IL2NativeTokenVault} from "./IL2NativeTokenVault.sol"; +import {NativeTokenVault} from "./NativeTokenVault.sol"; + +import {IL2SharedBridgeLegacy} from "../interfaces/IL2SharedBridgeLegacy.sol"; +import {BridgedStandardERC20} from "../BridgedStandardERC20.sol"; + +import {DEPLOYER_SYSTEM_CONTRACT, L2_ASSET_ROUTER_ADDR} from "../../common/L2ContractAddresses.sol"; +import {L2ContractHelper, IContractDeployer} from "../../common/libraries/L2ContractHelper.sol"; + +import {SystemContractsCaller} from "../../common/libraries/SystemContractsCaller.sol"; +import {DataEncoding} from "../../common/libraries/DataEncoding.sol"; + +import {EmptyAddress, EmptyBytes32, AddressMismatch, DeployFailed, AssetIdNotSupported} from "../../common/L1ContractErrors.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice The "default" bridge implementation for the ERC20 tokens. Note, that it does not +/// support any custom token logic, i.e. rebase tokens' functionality is not supported. +contract L2NativeTokenVault is IL2NativeTokenVault, NativeTokenVault { + using SafeERC20 for IERC20; + + IL2SharedBridgeLegacy public immutable L2_LEGACY_SHARED_BRIDGE; + + /// @dev Bytecode hash of the proxy for tokens deployed by the bridge. + bytes32 internal l2TokenProxyBytecodeHash; + + /// @notice Initializes the bridge contract for later use. + /// @param _l1ChainId The L1 chain id differs between mainnet and testnets. + /// @param _l2TokenProxyBytecodeHash The bytecode hash of the proxy for tokens deployed by the bridge. + /// @param _aliasedOwner The address of the governor contract. + /// @param _legacySharedBridge The address of the L2 legacy shared bridge. + /// @param _bridgedTokenBeacon The address of the L2 token beacon for legacy chains. + /// @param _contractsDeployedAlready Ensures beacon proxy for standard ERC20 has not been deployed. + /// @param _wethToken Address of WETH on deployed chain + constructor( + uint256 _l1ChainId, + address _aliasedOwner, + bytes32 _l2TokenProxyBytecodeHash, + address _legacySharedBridge, + address _bridgedTokenBeacon, + bool _contractsDeployedAlready, + address _wethToken, + bytes32 _baseTokenAssetId + ) NativeTokenVault(_wethToken, L2_ASSET_ROUTER_ADDR, _baseTokenAssetId, _l1ChainId) { + L2_LEGACY_SHARED_BRIDGE = IL2SharedBridgeLegacy(_legacySharedBridge); + + if (_l2TokenProxyBytecodeHash == bytes32(0)) { + revert EmptyBytes32(); + } + if (_aliasedOwner == address(0)) { + revert EmptyAddress(); + } + + l2TokenProxyBytecodeHash = _l2TokenProxyBytecodeHash; + _transferOwnership(_aliasedOwner); + + if (_contractsDeployedAlready) { + if (_bridgedTokenBeacon == address(0)) { + revert EmptyAddress(); + } + bridgedTokenBeacon = IBeacon(_bridgedTokenBeacon); + } else { + address l2StandardToken = address(new BridgedStandardERC20{salt: bytes32(0)}()); + + UpgradeableBeacon tokenBeacon = new UpgradeableBeacon{salt: bytes32(0)}(l2StandardToken); + + tokenBeacon.transferOwnership(owner()); + bridgedTokenBeacon = IBeacon(address(tokenBeacon)); + emit L2TokenBeaconUpdated(address(bridgedTokenBeacon), _l2TokenProxyBytecodeHash); + } + } + + /// @notice Sets the legacy token asset ID for the given L2 token address. + function setLegacyTokenAssetId(address _l2TokenAddress) public { + address l1TokenAddress = L2_LEGACY_SHARED_BRIDGE.l1TokenAddress(_l2TokenAddress); + bytes32 assetId = DataEncoding.encodeNTVAssetId(L1_CHAIN_ID, l1TokenAddress); + tokenAddress[assetId] = _l2TokenAddress; + originChainId[assetId] = L1_CHAIN_ID; + } + + /// @notice Ensures that the token is deployed. + /// @param _originChainId The chain ID of the origin chain. + /// @param _assetId The asset ID. + /// @param _originToken The origin token address. + /// @param _erc20Data The ERC20 data. + /// @return expectedToken The token address. + function _ensureTokenDeployed( + uint256 _originChainId, + bytes32 _assetId, + address _originToken, + bytes memory _erc20Data + ) internal override returns (address expectedToken) { + expectedToken = _assetIdCheck(_originChainId, _assetId, _originToken); + address l1LegacyToken; + if (address(L2_LEGACY_SHARED_BRIDGE) != address(0)) { + l1LegacyToken = L2_LEGACY_SHARED_BRIDGE.l1TokenAddress(expectedToken); + } + + if (l1LegacyToken != address(0)) { + /// token is a legacy token, no need to deploy + if (l1LegacyToken != _originToken) { + revert AddressMismatch(_originToken, l1LegacyToken); + } + tokenAddress[_assetId] = expectedToken; + } else { + super._ensureTokenDeployedInner({ + _originChainId: _originChainId, + _assetId: _assetId, + _originToken: _originToken, + _erc20Data: _erc20Data, + _expectedToken: expectedToken + }); + } + } + + /// @notice Deploys the beacon proxy for the L2 token, while using ContractDeployer system contract. + /// @dev This function uses raw call to ContractDeployer to make sure that exactly `l2TokenProxyBytecodeHash` is used + /// for the code of the proxy. + /// @param _salt The salt used for beacon proxy deployment of L2 bridged token. + /// @return proxy The beacon proxy, i.e. L2 bridged token. + function _deployBeaconProxy(bytes32 _salt) internal override returns (BeaconProxy proxy) { + if (address(L2_LEGACY_SHARED_BRIDGE) == address(0)) { + // Deploy the beacon proxy for the L2 token + + (bool success, bytes memory returndata) = SystemContractsCaller.systemCallWithReturndata( + uint32(gasleft()), + DEPLOYER_SYSTEM_CONTRACT, + 0, + abi.encodeCall( + IContractDeployer.create2, + (_salt, l2TokenProxyBytecodeHash, abi.encode(address(bridgedTokenBeacon), "")) + ) + ); + + // The deployment should be successful and return the address of the proxy + if (!success) { + revert DeployFailed(); + } + proxy = BeaconProxy(abi.decode(returndata, (address))); + } else { + // Deploy the beacon proxy for the L2 token + address l2TokenAddr = L2_LEGACY_SHARED_BRIDGE.deployBeaconProxy(_salt); + proxy = BeaconProxy(payable(l2TokenAddr)); + } + } + + function _withdrawFunds(bytes32 _assetId, address _to, address _token, uint256 _amount) internal override { + if (_assetId == BASE_TOKEN_ASSET_ID) { + revert AssetIdNotSupported(BASE_TOKEN_ASSET_ID); + } else { + // Withdraw funds + IERC20(_token).safeTransfer(_to, _amount); + } + } + + /*////////////////////////////////////////////////////////////// + INTERNAL & HELPER FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @notice Calculates L2 wrapped token address given the currently stored beacon proxy bytecode hash and beacon address. + /// @param _l1Token The address of token on L1. + /// @return Address of an L2 token counterpart. + function calculateCreate2TokenAddress( + uint256 _originChainId, + address _l1Token + ) public view override(INativeTokenVault, NativeTokenVault) returns (address) { + bytes32 constructorInputHash = keccak256(abi.encode(address(bridgedTokenBeacon), "")); + bytes32 salt = _getCreate2Salt(_originChainId, _l1Token); + if (address(L2_LEGACY_SHARED_BRIDGE) != address(0)) { + return L2_LEGACY_SHARED_BRIDGE.l2TokenAddress(_l1Token); + } else { + return + L2ContractHelper.computeCreate2Address( + address(this), + salt, + l2TokenProxyBytecodeHash, + constructorInputHash + ); + } + } + + /// @notice Calculates the salt for the Create2 deployment of the L2 token. + function _getCreate2Salt(uint256 _originChainId, address _l1Token) internal view override returns (bytes32 salt) { + salt = _originChainId == L1_CHAIN_ID + ? bytes32(uint256(uint160(_l1Token))) + : keccak256(abi.encode(_originChainId, _l1Token)); + } + + function _handleChainBalanceIncrease( + uint256 _chainId, + bytes32 _assetId, + uint256 _amount, + bool _isNative + ) internal override { + // on L2s we don't track the balance + } + + function _handleChainBalanceDecrease( + uint256 _chainId, + bytes32 _assetId, + uint256 _amount, + bool _isNative + ) internal override { + // on L2s we don't track the balance + } + + /*////////////////////////////////////////////////////////////// + LEGACY FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @notice Calculates L2 wrapped token address corresponding to L1 token counterpart. + /// @param _l1Token The address of token on L1. + /// @return expectedToken The address of token on L2. + function l2TokenAddress(address _l1Token) public view returns (address expectedToken) { + bytes32 expectedAssetId = DataEncoding.encodeNTVAssetId(L1_CHAIN_ID, _l1Token); + expectedToken = tokenAddress[expectedAssetId]; + } +} diff --git a/l1-contracts/contracts/bridge/ntv/NativeTokenVault.sol b/l1-contracts/contracts/bridge/ntv/NativeTokenVault.sol new file mode 100644 index 000000000..5e76d7630 --- /dev/null +++ b/l1-contracts/contracts/bridge/ntv/NativeTokenVault.sol @@ -0,0 +1,454 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +// solhint-disable reason-string, gas-custom-errors + +import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; +import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/security/PausableUpgradeable.sol"; +import {BeaconProxy} from "@openzeppelin/contracts-v4/proxy/beacon/BeaconProxy.sol"; +import {IBeacon} from "@openzeppelin/contracts-v4/proxy/beacon/IBeacon.sol"; + +import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; +import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; + +import {IBridgedStandardToken} from "../interfaces/IBridgedStandardToken.sol"; +import {INativeTokenVault} from "./INativeTokenVault.sol"; +import {IAssetHandler} from "../interfaces/IAssetHandler.sol"; +import {IAssetRouterBase} from "../asset-router/IAssetRouterBase.sol"; +import {DataEncoding} from "../../common/libraries/DataEncoding.sol"; + +import {BridgedStandardERC20} from "../BridgedStandardERC20.sol"; +import {BridgeHelper} from "../BridgeHelper.sol"; + +import {EmptyDeposit, Unauthorized, TokensWithFeesNotSupported, TokenNotSupported, NonEmptyMsgValue, ValueMismatch, AddressMismatch, AssetIdMismatch, AmountMustBeGreaterThanZero, ZeroAddress} from "../../common/L1ContractErrors.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @dev Vault holding L1 native ETH and ERC20 tokens bridged into the ZK chains. +/// @dev Designed for use with a proxy for upgradability. +abstract contract NativeTokenVault is INativeTokenVault, IAssetHandler, Ownable2StepUpgradeable, PausableUpgradeable { + using SafeERC20 for IERC20; + + /// @dev The address of the WETH token. + address public immutable override WETH_TOKEN; + + /// @dev L1 Shared Bridge smart contract that handles communication with its counterparts on L2s + IAssetRouterBase public immutable override ASSET_ROUTER; + + /// @dev The assetId of the base token. + bytes32 public immutable BASE_TOKEN_ASSET_ID; + + /// @dev Chain ID of L1 for bridging reasons. + uint256 public immutable L1_CHAIN_ID; + + /// @dev Contract that stores the implementation address for token. + /// @dev For more details see https://docs.openzeppelin.com/contracts/3.x/api/proxy#UpgradeableBeacon. + IBeacon public bridgedTokenBeacon; + + /// @dev A mapping assetId => tokenAddress + mapping(bytes32 assetId => uint256 chainId) public originChainId; + + /// @dev A mapping assetId => tokenAddress + mapping(bytes32 assetId => address tokenAddress) public tokenAddress; + + /** + * @dev This empty reserved space is put in place to allow future versions to add new + * variables without shifting down storage in the inheritance chain. + * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps + */ + uint256[47] private __gap; + + /// @notice Checks that the message sender is the bridgehub. + modifier onlyAssetRouter() { + if (msg.sender != address(ASSET_ROUTER)) { + revert Unauthorized(msg.sender); + } + _; + } + + /// @dev Contract is expected to be used as proxy implementation. + /// @dev Disable the initialization to prevent Parity hack. + /// @param _wethToken Address of WETH on deployed chain + /// @param _assetRouter Address of assetRouter + constructor(address _wethToken, address _assetRouter, bytes32 _baseTokenAssetId, uint256 _l1ChainId) { + _disableInitializers(); + L1_CHAIN_ID = _l1ChainId; + ASSET_ROUTER = IAssetRouterBase(_assetRouter); + WETH_TOKEN = _wethToken; + BASE_TOKEN_ASSET_ID = _baseTokenAssetId; + } + + /// @inheritdoc INativeTokenVault + function registerToken(address _nativeToken) external virtual { + _registerToken(_nativeToken); + } + + function _registerToken(address _nativeToken) internal { + if (_nativeToken == WETH_TOKEN) { + revert TokenNotSupported(WETH_TOKEN); + } + require(_nativeToken.code.length > 0, "NTV: empty token"); + _unsafeRegisterNativeToken(_nativeToken); + } + + /*////////////////////////////////////////////////////////////// + FINISH TRANSACTION FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @inheritdoc IAssetHandler + /// @notice Used when the chain receives a transfer from L1 Shared Bridge and correspondingly mints the asset. + /// @param _chainId The chainId that the message is from. + /// @param _assetId The assetId of the asset being bridged. + /// @param _data The abi.encoded transfer data. + function bridgeMint( + uint256 _chainId, + bytes32 _assetId, + bytes calldata _data + ) external payable override onlyAssetRouter whenNotPaused { + address receiver; + uint256 amount; + // we set all originChainId for all already bridged tokens with the setLegacyTokenAssetId and updateChainBalancesFromSharedBridge functions. + // for tokens that are bridged for the first time, the originChainId will be 0. + if (originChainId[_assetId] == block.chainid) { + (receiver, amount) = _bridgeMintNativeToken(_chainId, _assetId, _data); + } else { + (receiver, amount) = _bridgeMintBridgedToken(_chainId, _assetId, _data); + } + // solhint-disable-next-line func-named-parameters + emit BridgeMint(_chainId, _assetId, receiver, amount); + } + + function _bridgeMintBridgedToken( + uint256 _originChainId, + bytes32 _assetId, + bytes calldata _data + ) internal virtual returns (address receiver, uint256 amount) { + // Either it was bridged before, therefore address is not zero, or it is first time bridging and standard erc20 will be deployed + address token = tokenAddress[_assetId]; + bytes memory erc20Data; + address originToken; + // slither-disable-next-line unused-return + (, receiver, originToken, amount, erc20Data) = DataEncoding.decodeBridgeMintData(_data); + + if (token == address(0)) { + token = _ensureTokenDeployed(_originChainId, _assetId, originToken, erc20Data); + } + _handleChainBalanceDecrease(_originChainId, _assetId, amount, false); + IBridgedStandardToken(token).bridgeMint(receiver, amount); + emit BridgeMint(_originChainId, _assetId, receiver, amount); + } + + function _bridgeMintNativeToken( + uint256 _originChainId, + bytes32 _assetId, + bytes calldata _data + ) internal returns (address receiver, uint256 amount) { + address token = tokenAddress[_assetId]; + // slither-disable-next-line unused-return + (, receiver, , amount, ) = DataEncoding.decodeBridgeMintData(_data); + + _handleChainBalanceDecrease(_originChainId, _assetId, amount, true); + _withdrawFunds(_assetId, receiver, token, amount); + emit BridgeMint(_originChainId, _assetId, receiver, amount); + } + + function _withdrawFunds(bytes32 _assetId, address _to, address _token, uint256 _amount) internal virtual; + + /*////////////////////////////////////////////////////////////// + Start transaction Functions + //////////////////////////////////////////////////////////////*/ + + /// @inheritdoc IAssetHandler + /// @notice Allows bridgehub to acquire mintValue for L1->L2 transactions. + /// @dev In case of native token vault _data is the tuple of _depositAmount and _receiver. + function bridgeBurn( + uint256 _chainId, + uint256, + bytes32 _assetId, + address _originalCaller, + bytes calldata _data + ) external payable override onlyAssetRouter whenNotPaused returns (bytes memory _bridgeMintData) { + if (originChainId[_assetId] != block.chainid) { + _bridgeMintData = _bridgeBurnBridgedToken(_chainId, _assetId, _originalCaller, _data); + } else { + _bridgeMintData = _bridgeBurnNativeToken({ + _chainId: _chainId, + _assetId: _assetId, + _originalCaller: _originalCaller, + _depositChecked: false, + _data: _data + }); + } + } + + function _bridgeBurnBridgedToken( + uint256 _chainId, + bytes32 _assetId, + address _originalCaller, + bytes calldata _data + ) internal returns (bytes memory _bridgeMintData) { + (uint256 _amount, address _receiver) = abi.decode(_data, (uint256, address)); + if (_amount == 0) { + // "Amount cannot be zero"); + revert AmountMustBeGreaterThanZero(); + } + + address bridgedToken = tokenAddress[_assetId]; + IBridgedStandardToken(bridgedToken).bridgeBurn(_originalCaller, _amount); + + emit BridgeBurn({ + chainId: _chainId, + assetId: _assetId, + sender: _originalCaller, + receiver: _receiver, + amount: _amount + }); + bytes memory erc20Metadata; + { + // we set all originChainId for all already bridged tokens with the setLegacyTokenAssetId and updateChainBalancesFromSharedBridge functions. + // for native tokens the originChainId is set when they register. + uint256 originChainId = originChainId[_assetId]; + if (originChainId == 0) { + revert ZeroAddress(); + } + erc20Metadata = getERC20Getters(bridgedToken, originChainId); + } + address originToken; + { + originToken = IBridgedStandardToken(bridgedToken).originToken(); + if (originToken == address(0)) { + revert ZeroAddress(); + } + } + + _bridgeMintData = DataEncoding.encodeBridgeMintData({ + _originalCaller: _originalCaller, + _l2Receiver: _receiver, + _l1Token: originToken, + _amount: _amount, + _erc20Metadata: erc20Metadata + }); + } + + function _bridgeBurnNativeToken( + uint256 _chainId, + bytes32 _assetId, + address _originalCaller, + bool _depositChecked, + bytes calldata _data + ) internal virtual returns (bytes memory _bridgeMintData) { + (uint256 _depositAmount, address _receiver) = abi.decode(_data, (uint256, address)); + + uint256 amount; + address nativeToken = tokenAddress[_assetId]; + if (_assetId == BASE_TOKEN_ASSET_ID) { + amount = msg.value; + + // In the old SDK/contracts the user had to always provide `0` as the deposit amount for ETH token, while + // ultimately the provided `msg.value` was used as the deposit amount. This check is needed for backwards compatibility. + if (_depositAmount == 0) { + _depositAmount = amount; + } + _handleChainBalanceIncrease(_chainId, _assetId, amount, true); + if (_depositAmount != amount) { + revert ValueMismatch(amount, msg.value); + } + } else { + // The Bridgehub also checks this, but we want to be sure + if (msg.value != 0) { + revert NonEmptyMsgValue(); + } + _handleChainBalanceIncrease(_chainId, _assetId, amount, true); + amount = _depositAmount; + if (!_depositChecked) { + uint256 expectedDepositAmount = _depositFunds(_originalCaller, IERC20(nativeToken), _depositAmount); // note if _originalCaller is this contract, this will return 0. This does not happen. + // The token has non-standard transfer logic + if (amount != expectedDepositAmount) { + revert TokensWithFeesNotSupported(); + } + } + } + if (amount == 0) { + // empty deposit amount + revert EmptyDeposit(); + } + + bytes memory erc20Metadata; + { + erc20Metadata = getERC20Getters(nativeToken, originChainId[_assetId]); + } + _bridgeMintData = DataEncoding.encodeBridgeMintData({ + _originalCaller: _originalCaller, + _l2Receiver: _receiver, + _l1Token: nativeToken, + _amount: amount, + _erc20Metadata: erc20Metadata + }); + + emit BridgeBurn({ + chainId: _chainId, + assetId: _assetId, + sender: _originalCaller, + receiver: _receiver, + amount: amount + }); + } + + /*////////////////////////////////////////////////////////////// + INTERNAL & HELPER FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + /// @notice Transfers tokens from the depositor address to the smart contract address. + /// @param _from The address of the depositor. + /// @param _token The ERC20 token to be transferred. + /// @param _amount The amount to be transferred. + /// @return The difference between the contract balance before and after the transferring of funds. + function _depositFunds(address _from, IERC20 _token, uint256 _amount) internal virtual returns (uint256) { + uint256 balanceBefore = _token.balanceOf(address(this)); + // slither-disable-next-line arbitrary-send-erc20 + _token.safeTransferFrom(_from, address(this), _amount); + uint256 balanceAfter = _token.balanceOf(address(this)); + + return balanceAfter - balanceBefore; + } + + /// @param _token The address of token of interest. + /// @dev Receives and parses (name, symbol, decimals) from the token contract + function getERC20Getters(address _token, uint256 _originChainId) public view override returns (bytes memory) { + return BridgeHelper.getERC20Getters(_token, _originChainId); + } + + /// @notice Returns the parsed assetId. + /// @param _nativeToken The address of the token to be parsed. + /// @dev Shows the assetId for a given chain and token address + function getAssetId(uint256 _chainId, address _nativeToken) external pure override returns (bytes32) { + return DataEncoding.encodeNTVAssetId(_chainId, _nativeToken); + } + + /// @notice Registers a native token address for the vault. + /// @dev It does not perform any checks for the correctnesss of the token contract. + /// @param _nativeToken The address of the token to be registered. + function _unsafeRegisterNativeToken(address _nativeToken) internal { + bytes32 assetId = DataEncoding.encodeNTVAssetId(block.chainid, _nativeToken); + ASSET_ROUTER.setAssetHandlerAddressThisChain(bytes32(uint256(uint160(_nativeToken))), address(this)); + tokenAddress[assetId] = _nativeToken; + originChainId[assetId] = block.chainid; + } + + function _handleChainBalanceIncrease( + uint256 _chainId, + bytes32 _assetId, + uint256 _amount, + bool _isNative + ) internal virtual; + + function _handleChainBalanceDecrease( + uint256 _chainId, + bytes32 _assetId, + uint256 _amount, + bool _isNative + ) internal virtual; + + /*////////////////////////////////////////////////////////////// + TOKEN DEPLOYER FUNCTIONS + //////////////////////////////////////////////////////////////*/ + + function _ensureTokenDeployed( + uint256 _originChainId, + bytes32 _assetId, + address _originToken, + bytes memory _erc20Data + ) internal virtual returns (address expectedToken) { + expectedToken = _assetIdCheck(_originChainId, _assetId, _originToken); + _ensureTokenDeployedInner({ + _originChainId: _originChainId, + _assetId: _assetId, + _originToken: _originToken, + _erc20Data: _erc20Data, + _expectedToken: expectedToken + }); + } + + function _assetIdCheck( + uint256 _originChainId, + bytes32 _assetId, + address _originToken + ) internal view returns (address expectedToken) { + expectedToken = calculateCreate2TokenAddress(_originChainId, _originToken); + bytes32 expectedAssetId = DataEncoding.encodeNTVAssetId(_originChainId, _originToken); + if (_assetId != expectedAssetId) { + // Make sure that a NativeTokenVault sent the message + revert AssetIdMismatch(_assetId, expectedAssetId); + } + } + + function _ensureTokenDeployedInner( + uint256 _originChainId, + bytes32 _assetId, + address _originToken, + bytes memory _erc20Data, + address _expectedToken + ) internal { + address deployedToken = _deployBridgedToken(_originChainId, _originToken, _erc20Data); + if (deployedToken != _expectedToken) { + revert AddressMismatch(_expectedToken, deployedToken); + } + + tokenAddress[_assetId] = _expectedToken; + } + + /// @notice Calculates the bridged token address corresponding to native token counterpart. + /// @param _bridgeToken The address of native token. + /// @return The address of bridged token. + function calculateCreate2TokenAddress( + uint256 _originChainId, + address _bridgeToken + ) public view virtual override returns (address); + + /// @notice Deploys and initializes the bridged token for the native counterpart. + /// @param _originToken The address of origin token. + /// @param _erc20Data The ERC20 metadata of the token deployed. + /// @return The address of the beacon proxy (bridged token). + function _deployBridgedToken( + uint256 _originChainId, + address _originToken, + bytes memory _erc20Data + ) internal returns (address) { + bytes32 salt = _getCreate2Salt(_originChainId, _originToken); + + BeaconProxy l2Token = _deployBeaconProxy(salt); + uint256 tokenOriginChainId = BridgedStandardERC20(address(l2Token)).bridgeInitialize(_originToken, _erc20Data); + tokenOriginChainId = tokenOriginChainId == 0 ? L1_CHAIN_ID : tokenOriginChainId; + originChainId[DataEncoding.encodeNTVAssetId(tokenOriginChainId, _originToken)] = tokenOriginChainId; + return address(l2Token); + } + + /// @notice Converts the L1 token address to the create2 salt of deployed L2 token. + /// @param _l1Token The address of token on L1. + /// @return salt The salt used to compute address of bridged token on L2 and for beacon proxy deployment. + function _getCreate2Salt(uint256 _originChainId, address _l1Token) internal view virtual returns (bytes32 salt) { + salt = keccak256(abi.encode(_originChainId, _l1Token)); + } + + /// @notice Deploys the beacon proxy for the bridged token. + /// @dev This function uses raw call to ContractDeployer to make sure that exactly `l2TokenProxyBytecodeHash` is used + /// for the code of the proxy. + /// @param _salt The salt used for beacon proxy deployment of the bridged token (we pass the native token address). + /// @return proxy The beacon proxy, i.e. bridged token. + function _deployBeaconProxy(bytes32 _salt) internal virtual returns (BeaconProxy proxy); + + /*////////////////////////////////////////////////////////////// + PAUSE + //////////////////////////////////////////////////////////////*/ + + /// @notice Pauses all functions marked with the `whenNotPaused` modifier. + function pause() external onlyOwner { + _pause(); + } + + /// @notice Unpauses the contract, allowing all functions marked with the `whenNotPaused` modifier to be called again. + function unpause() external onlyOwner { + _unpause(); + } +} diff --git a/l1-contracts/contracts/bridgehub/Bridgehub.sol b/l1-contracts/contracts/bridgehub/Bridgehub.sol index 10495b489..8e23a9f3d 100644 --- a/l1-contracts/contracts/bridgehub/Bridgehub.sol +++ b/l1-contracts/contracts/bridgehub/Bridgehub.sol @@ -2,49 +2,65 @@ pragma solidity 0.8.24; +// solhint-disable reason-string, gas-custom-errors + +import {EnumerableMap} from "@openzeppelin/contracts-v4/utils/structs/EnumerableMap.sol"; + import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/security/PausableUpgradeable.sol"; -import {IBridgehub, L2TransactionRequestDirect, L2TransactionRequestTwoBridgesOuter, L2TransactionRequestTwoBridgesInner} from "./IBridgehub.sol"; -import {IL1AssetRouter} from "../bridge/interfaces/IL1AssetRouter.sol"; -import {IStateTransitionManager} from "../state-transition/IStateTransitionManager.sol"; +import {IBridgehub, L2TransactionRequestDirect, L2TransactionRequestTwoBridgesOuter, L2TransactionRequestTwoBridgesInner, BridgehubMintCTMAssetData, BridgehubBurnCTMAssetData} from "./IBridgehub.sol"; +import {IAssetRouterBase} from "../bridge/asset-router/IAssetRouterBase.sol"; +import {IL1AssetRouter} from "../bridge/asset-router/IL1AssetRouter.sol"; +import {IL1BaseTokenAssetHandler} from "../bridge/interfaces/IL1BaseTokenAssetHandler.sol"; +import {IChainTypeManager} from "../state-transition/IChainTypeManager.sol"; import {ReentrancyGuard} from "../common/ReentrancyGuard.sol"; import {DataEncoding} from "../common/libraries/DataEncoding.sol"; -import {IZkSyncHyperchain} from "../state-transition/chain-interfaces/IZkSyncHyperchain.sol"; +import {IZKChain} from "../state-transition/chain-interfaces/IZKChain.sol"; -import {ETH_TOKEN_ADDRESS, TWO_BRIDGES_MAGIC_VALUE, BRIDGEHUB_MIN_SECOND_BRIDGE_ADDRESS, VIRTUAL_SENDER_ALIASED_ZERO_ADDRESS} from "../common/Config.sol"; +import {ETH_TOKEN_ADDRESS, TWO_BRIDGES_MAGIC_VALUE, BRIDGEHUB_MIN_SECOND_BRIDGE_ADDRESS, SETTLEMENT_LAYER_RELAY_SENDER} from "../common/Config.sol"; import {BridgehubL2TransactionRequest, L2Message, L2Log, TxStatus} from "../common/Messaging.sol"; import {AddressAliasHelper} from "../vendor/AddressAliasHelper.sol"; import {IMessageRoot} from "./IMessageRoot.sol"; -import {ISTMDeploymentTracker} from "./ISTMDeploymentTracker.sol"; -import {L2CanonicalTransaction} from "../common/Messaging.sol"; -import {Unauthorized, STMAlreadyRegistered, STMNotRegistered, TokenAlreadyRegistered, TokenNotRegistered, ZeroChainId, ChainIdTooBig, SharedBridgeNotSet, BridgeHubAlreadyRegistered, AddressTooLow, MsgValueMismatch, WrongMagicValue, ZeroAddress} from "../common/L1ContractErrors.sol"; +import {ICTMDeploymentTracker} from "./ICTMDeploymentTracker.sol"; +import {MigrationPaused, AssetIdAlreadyRegistered, ChainAlreadyLive, ChainNotLegacy, CTMNotRegistered, ChainIdNotRegistered, AssetHandlerNotRegistered, ZKChainLimitReached, CTMAlreadyRegistered, CTMNotRegistered, ZeroChainId, ChainIdTooBig, BridgeHubAlreadyRegistered, AddressTooLow, MsgValueMismatch, ZeroAddress, Unauthorized, SharedBridgeNotSet, WrongMagicValue, ChainIdAlreadyExists, ChainIdMismatch, ChainIdCantBeCurrentChain, EmptyAssetId, AssetIdNotSupported, IncorrectBridgeHubAddress} from "../common/L1ContractErrors.sol"; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev /// @dev The Bridgehub contract serves as the primary entry point for L1<->L2 communication, /// facilitating interactions between end user and bridges. /// It also manages state transition managers, base tokens, and chain registrations. +/// Bridgehub is also an IL1AssetHandler for the chains themselves, which is used to migrate the chains +/// between different settlement layers (for example from L1 to Gateway). contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, PausableUpgradeable { - /// @notice the asset id of Eth + using EnumerableMap for EnumerableMap.UintToAddressMap; + + /// @notice the asset id of Eth. This is only used on L1. bytes32 internal immutable ETH_TOKEN_ASSET_ID; - /// @notice The chain id of L1, this contract will be deployed on multiple layers. + /// @notice The chain id of L1. This contract can be deployed on multiple layers, but this value is still equal to the + /// L1 that is at the most base layer. uint256 public immutable L1_CHAIN_ID; - /// @notice all the ether is held by the weth bridge - IL1AssetRouter public sharedBridge; + /// @notice The total number of ZK chains can be created/connected to this CTM. + /// This is the temporary security measure. + uint256 public immutable MAX_NUMBER_OF_ZK_CHAINS; + + /// @notice all the ether and ERC20 tokens are held by NativeVaultToken managed by this shared Bridge. + address public assetRouter; + + /// @notice ChainTypeManagers that are registered, and ZKchains that use these CTMs can use this bridgehub as settlement layer. + mapping(address chainTypeManager => bool) public chainTypeManagerIsRegistered; - /// @notice we store registered stateTransitionManagers - mapping(address _stateTransitionManager => bool) public stateTransitionManagerIsRegistered; /// @notice we store registered tokens (for arbitrary base token) - mapping(address _baseToken => bool) public tokenIsRegistered; + mapping(address baseToken => bool) public __DEPRECATED_tokenIsRegistered; - /// @notice chainID => StateTransitionManager contract address, storing StateTransitionManager - mapping(uint256 _chainId => address) public stateTransitionManager; + /// @notice chainID => ChainTypeManager contract address, CTM that is managing rules for a given ZKchain. + mapping(uint256 chainId => address) public chainTypeManager; - /// @notice chainID => baseToken contract address, storing baseToken - mapping(uint256 _chainId => address) public baseToken; + /// @notice chainID => baseToken contract address, token that is used as 'base token' by a given child chain. + // slither-disable-next-line uninitialized-state + mapping(uint256 chainId => address) public __DEPRECATED_baseToken; /// @dev used to manage non critical updates address public admin; @@ -52,20 +68,23 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus /// @dev used to accept the admin role address private pendingAdmin; - // FIXME: `messageRoot` DOES NOT contain messages that come from the current layer and go to the settlement layer. - // it may make sense to store the final root somewhere for interop purposes. - // Though maybe it can be postponed. + /// @notice The map from chainId => zkChain contract + EnumerableMap.UintToAddressMap internal zkChainMap; + /// @notice The contract that stores the cross-chain message root for each chain and the aggregated root. + /// @dev Note that the message root does not contain messages from the chain it is deployed on. It may + /// be added later on if needed. IMessageRoot public override messageRoot; /// @notice Mapping from chain id to encoding of the base token used for deposits / withdrawals - mapping(uint256 _chainId => bytes32) public baseTokenAssetId; + mapping(uint256 chainId => bytes32) public baseTokenAssetId; /// @notice The deployment tracker for the state transition managers. - ISTMDeploymentTracker public stmDeployer; + /// @dev The L1 address of the ctm deployer is provided. + ICTMDeploymentTracker public l1CtmDeployer; /// @dev asset info used to identify chains in the Shared Bridge - mapping(bytes32 stmAssetId => address stmAddress) public stmAssetIdToAddress; + mapping(bytes32 ctmAssetId => address ctmAddress) public ctmAssetIdToAddress; /// @dev used to indicate the currently active settlement layer for a given chainId mapping(uint256 chainId => uint256 activeSettlementLayerChainId) public settlementLayer; @@ -75,6 +94,12 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus /// @dev Sync layer chain is expected to have .. as the base token. mapping(uint256 chainId => bool isWhitelistedSettlementLayer) public whitelistedSettlementLayers; + /// @notice we store registered assetIds (for arbitrary base token) + mapping(bytes32 baseTokenAssetId => bool) public assetIdIsRegistered; + + /// @notice used to pause the migrations of chains. Used for upgrades. + bool public migrationPaused; + modifier onlyOwnerOrAdmin() { if (msg.sender != admin && msg.sender != owner()) { revert Unauthorized(msg.sender); @@ -82,17 +107,54 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus _; } - modifier onlyChainSTM(uint256 _chainId) { - require(msg.sender == stateTransitionManager[_chainId], "BH: not chain STM"); + modifier onlyChainCTM(uint256 _chainId) { + if (msg.sender != chainTypeManager[_chainId]) { + revert Unauthorized(msg.sender); + } + _; + } + + modifier onlyL1() { + if (L1_CHAIN_ID != block.chainid) { + revert Unauthorized(msg.sender); + } + _; + } + + modifier onlySettlementLayerRelayedSender() { + /// There is no sender for the wrapping, we use a virtual address. + if (msg.sender != SETTLEMENT_LAYER_RELAY_SENDER) { + revert Unauthorized(msg.sender); + } + _; + } + + modifier onlyAssetRouter() { + if (msg.sender != assetRouter) { + revert Unauthorized(msg.sender); + } + _; + } + + modifier whenMigrationsNotPaused() { + if (migrationPaused) { + revert MigrationPaused(); + } _; } /// @notice to avoid parity hack - constructor(uint256 _l1ChainId, address _owner) reentrancyGuardInitializer { + constructor(uint256 _l1ChainId, address _owner, uint256 _maxNumberOfZKChains) reentrancyGuardInitializer { _disableInitializers(); L1_CHAIN_ID = _l1ChainId; - ETH_TOKEN_ASSET_ID = DataEncoding.encodeNTVAssetId(block.chainid, ETH_TOKEN_ADDRESS); + MAX_NUMBER_OF_ZK_CHAINS = _maxNumberOfZKChains; + + // Note that this assumes that the bridgehub only accepts transactions on chains with ETH base token only. + // This is indeed true, since the only methods where this immutable is used are the ones with `onlyL1` modifier. + // We will change this with interop. + ETH_TOKEN_ASSET_ID = DataEncoding.encodeNTVAssetId(L1_CHAIN_ID, ETH_TOKEN_ADDRESS); _transferOwnership(_owner); + whitelistedSettlementLayers[_l1ChainId] = true; } /// @notice used to initialize the contract @@ -100,17 +162,8 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus /// @param _owner the owner of the contract function initialize(address _owner) external reentrancyGuardInitializer { _transferOwnership(_owner); - } - - modifier onlyAliasedZero() { - /// There is no sender for the wrapping, we use a virtual address. - require(msg.sender == VIRTUAL_SENDER_ALIASED_ZERO_ADDRESS, "BH: not aliased zero"); - _; - } - - modifier onlyAssetRouter() { - require(msg.sender == address(sharedBridge), "BH: not asset router"); - _; + assetIdIsRegistered[ETH_TOKEN_ASSET_ID] = true; + whitelistedSettlementLayers[L1_CHAIN_ID] = true; } //// Initialization and registration @@ -147,69 +200,87 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus /// @notice To set the addresses of some of the ecosystem contracts, only Owner. Not done in initialize, as /// the order of deployment is Bridgehub, other contracts, and then we call this. - /// @param _sharedBridge the shared bridge address - /// @param _stmDeployer the stm deployment tracker address + /// @param _assetRouter the shared bridge address + /// @param _l1CtmDeployer the ctm deployment tracker address. Note, that the address of the L1 CTM deployer is provided. /// @param _messageRoot the message root address function setAddresses( - address _sharedBridge, - ISTMDeploymentTracker _stmDeployer, + address _assetRouter, + ICTMDeploymentTracker _l1CtmDeployer, IMessageRoot _messageRoot ) external onlyOwner { - sharedBridge = IL1AssetRouter(_sharedBridge); - stmDeployer = _stmDeployer; + assetRouter = _assetRouter; + l1CtmDeployer = _l1CtmDeployer; messageRoot = _messageRoot; } + /// @notice Used for the upgrade to set the baseTokenAssetId previously stored as baseToken. + /// @param _chainId the chainId of the chain. + function setLegacyBaseTokenAssetId(uint256 _chainId) external override { + if (baseTokenAssetId[_chainId] == bytes32(0)) { + return; + } + address token = __DEPRECATED_baseToken[_chainId]; + require(token != address(0), "BH: token not set"); + baseTokenAssetId[_chainId] = DataEncoding.encodeNTVAssetId(block.chainid, token); + } + + /// @notice Used to set the legacy chain address for the upgrade. + /// @param _chainId The chainId of the legacy chain we are migrating. + function setLegacyChainAddress(uint256 _chainId) external override { + address ctm = chainTypeManager[_chainId]; + if (ctm == address(0)) { + revert ChainNotLegacy(); + } + if (zkChainMap.contains(_chainId)) { + revert ChainAlreadyLive(); + } + address chainAddress = IChainTypeManager(ctm).getZKChainLegacy(_chainId); + if (chainAddress == address(0)) { + revert ChainNotLegacy(); + } + _registerNewZKChain(_chainId, chainAddress); + } + //// Registry /// @notice State Transition can be any contract with the appropriate interface/functionality - /// @param _stateTransitionManager the state transition manager address to be added - function addStateTransitionManager(address _stateTransitionManager) external onlyOwner { - if (_stateTransitionManager == address(0)) { + /// @param _chainTypeManager the state transition manager address to be added + function addChainTypeManager(address _chainTypeManager) external onlyOwner { + if (_chainTypeManager == address(0)) { revert ZeroAddress(); } - if (stateTransitionManagerIsRegistered[_stateTransitionManager]) { - revert STMAlreadyRegistered(); + if (chainTypeManagerIsRegistered[_chainTypeManager]) { + revert CTMAlreadyRegistered(); } - stateTransitionManagerIsRegistered[_stateTransitionManager] = true; + chainTypeManagerIsRegistered[_chainTypeManager] = true; - emit StateTransitionManagerAdded(_stateTransitionManager); + emit ChainTypeManagerAdded(_chainTypeManager); } /// @notice State Transition can be any contract with the appropriate interface/functionality /// @notice this stops new Chains from using the STF, old chains are not affected - /// @param _stateTransitionManager the state transition manager address to be removed - function removeStateTransitionManager(address _stateTransitionManager) external onlyOwner { - if (_stateTransitionManager == address(0)) { + /// @param _chainTypeManager the state transition manager address to be removed + function removeChainTypeManager(address _chainTypeManager) external onlyOwner { + if (_chainTypeManager == address(0)) { revert ZeroAddress(); } - if (!stateTransitionManagerIsRegistered[_stateTransitionManager]) { - revert STMNotRegistered(); + if (!chainTypeManagerIsRegistered[_chainTypeManager]) { + revert CTMNotRegistered(); } - stateTransitionManagerIsRegistered[_stateTransitionManager] = false; + chainTypeManagerIsRegistered[_chainTypeManager] = false; - emit StateTransitionManagerRemoved(_stateTransitionManager); + emit ChainTypeManagerRemoved(_chainTypeManager); } - /// @notice token can be any contract with the appropriate interface/functionality - /// @param _token address of base token to be registered - function addToken(address _token) external onlyOwner { - if (tokenIsRegistered[_token]) { - revert TokenAlreadyRegistered(_token); + /// @notice asset id can represent any token contract with the appropriate interface/functionality + /// @param _baseTokenAssetId asset id of base token to be registered + function addTokenAssetId(bytes32 _baseTokenAssetId) external onlyOwnerOrAdmin { + if (assetIdIsRegistered[_baseTokenAssetId]) { + revert AssetIdAlreadyRegistered(); } - tokenIsRegistered[_token] = true; + assetIdIsRegistered[_baseTokenAssetId] = true; - emit TokenRegistered(_token); - } - - /// @notice To set shared bridge, only Owner. Not done in initialize, as - /// the order of deployment is Bridgehub, Shared bridge, and then we call this - function setSharedBridge(address _sharedBridge) external onlyOwner { - if (_sharedBridge == address(0)) { - revert ZeroAddress(); - } - sharedBridge = IL1AssetRouter(_sharedBridge); - emit SharedBridgeUpdated(_sharedBridge); + emit BaseTokenAssetIdRegistered(_baseTokenAssetId); } /// @notice Used to register a chain as a settlement layer. @@ -218,19 +289,37 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus function registerSettlementLayer( uint256 _newSettlementLayerChainId, bool _isWhitelisted - ) external onlyChainSTM(_newSettlementLayerChainId) { + ) external onlyOwner onlyL1 { whitelistedSettlementLayers[_newSettlementLayerChainId] = _isWhitelisted; - - // TODO: emit event + emit SettlementLayerRegistered(_newSettlementLayerChainId, _isWhitelisted); } /// @dev Used to set the assetAddress for a given assetInfo. /// @param _additionalData the additional data to identify the asset /// @param _assetAddress the asset handler address - function setAssetHandlerAddressInitial(bytes32 _additionalData, address _assetAddress) external { - address sender = L1_CHAIN_ID == block.chainid ? msg.sender : AddressAliasHelper.undoL1ToL2Alias(msg.sender); // Todo: this might be dangerous. We should decide based on the tx type. - bytes32 assetInfo = keccak256(abi.encode(L1_CHAIN_ID, sender, _additionalData)); /// todo make other asse - stmAssetIdToAddress[assetInfo] = _assetAddress; + function setAssetHandlerAddress(bytes32 _additionalData, address _assetAddress) external { + // It is a simplified version of the logic used by the AssetRouter to manage asset handlers. + // CTM's assetId is `keccak256(abi.encode(L1_CHAIN_ID, l1CtmDeployer, ctmAddress))`. + // And the l1CtmDeployer is considered the deployment tracker for the CTM asset. + // + // The l1CtmDeployer will call this method to set the asset handler address for the assetId. + // If the chain is not the same as L1, we assume that it is done via L1->L2 communication and so we unalias the sender. + // + // For simpler handling we allow anyone to call this method. It is okay, since during bridging operations + // it is double checked that `assetId` is indeed derived from the `l1CtmDeployer`. + // TODO(EVM-703): This logic should be revised once interchain communication is implemented. + + address sender = L1_CHAIN_ID == block.chainid ? msg.sender : AddressAliasHelper.undoL1ToL2Alias(msg.sender); + // This method can be accessed by l1CtmDeployer only + if (sender != address(l1CtmDeployer)) { + revert Unauthorized(sender); + } + if (!chainTypeManagerIsRegistered[_assetAddress]) { + revert CTMNotRegistered(); + } + + bytes32 assetInfo = keccak256(abi.encode(L1_CHAIN_ID, sender, _additionalData)); + ctmAssetIdToAddress[assetInfo] = _assetAddress; emit AssetRegistered(assetInfo, _assetAddress, _additionalData, msg.sender); } @@ -238,103 +327,121 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus Chain Registration //////////////////////////////////////////////////////////////*/ - /// @notice register new chain + /// @notice register new chain. New chains can be only registered on Bridgehub deployed on L1. Later they can be moved to any other layer. /// @notice for Eth the baseToken address is 1 /// @param _chainId the chainId of the chain - /// @param _stateTransitionManager the state transition manager address - /// @param _baseToken the base token of the chain + /// @param _chainTypeManager the state transition manager address + /// @param _baseTokenAssetId the base token asset id of the chain /// @param _salt the salt for the chainId, currently not used /// @param _admin the admin of the chain /// @param _initData the fixed initialization data for the chain /// @param _factoryDeps the factory dependencies for the chain's deployment function createNewChain( uint256 _chainId, - address _stateTransitionManager, - address _baseToken, + address _chainTypeManager, + bytes32 _baseTokenAssetId, // solhint-disable-next-line no-unused-vars uint256 _salt, address _admin, bytes calldata _initData, bytes[] calldata _factoryDeps - ) external onlyOwnerOrAdmin nonReentrant whenNotPaused returns (uint256) { - if (_chainId == 0) { - revert ZeroChainId(); - } - if (_chainId > type(uint48).max) { - revert ChainIdTooBig(); - } - if (_stateTransitionManager == address(0)) { - revert ZeroAddress(); - } - if (_baseToken == address(0)) { - revert ZeroAddress(); - } + ) external onlyOwnerOrAdmin nonReentrant whenNotPaused onlyL1 returns (uint256) { + _validateChainParams({_chainId: _chainId, _assetId: _baseTokenAssetId, _chainTypeManager: _chainTypeManager}); - if (!stateTransitionManagerIsRegistered[_stateTransitionManager]) { - revert STMNotRegistered(); - } - if (!tokenIsRegistered[_baseToken]) { - revert TokenNotRegistered(_baseToken); - } - if (address(sharedBridge) == address(0)) { - revert SharedBridgeNotSet(); - } + chainTypeManager[_chainId] = _chainTypeManager; - if (stateTransitionManager[_chainId] != address(0)) { - revert BridgeHubAlreadyRegistered(); - } - - stateTransitionManager[_chainId] = _stateTransitionManager; - baseToken[_chainId] = _baseToken; - - /// For now all base tokens have to use the NTV. - baseTokenAssetId[_chainId] = DataEncoding.encodeNTVAssetId(block.chainid, _baseToken); + baseTokenAssetId[_chainId] = _baseTokenAssetId; settlementLayer[_chainId] = block.chainid; - IStateTransitionManager(_stateTransitionManager).createNewChain({ + address chainAddress = IChainTypeManager(_chainTypeManager).createNewChain({ _chainId: _chainId, - _baseToken: _baseToken, - _sharedBridge: address(sharedBridge), + _baseTokenAssetId: _baseTokenAssetId, + _assetRouter: assetRouter, _admin: _admin, _initData: _initData, _factoryDeps: _factoryDeps }); + _registerNewZKChain(_chainId, chainAddress); messageRoot.addNewChain(_chainId); - emit NewChain(_chainId, _stateTransitionManager, _admin); + emit NewChain(_chainId, _chainTypeManager, _admin); return _chainId; } + /// @dev This internal function is used to register a new zkChain in the system. + function _registerNewZKChain(uint256 _chainId, address _zkChain) internal { + // slither-disable-next-line unused-return + zkChainMap.set(_chainId, _zkChain); + if (zkChainMap.length() > MAX_NUMBER_OF_ZK_CHAINS) { + revert ZKChainLimitReached(); + } + } + /*////////////////////////////////////////////////////////////// Getters //////////////////////////////////////////////////////////////*/ - /// @notice return the state transition chain contract for a chainId - function getHyperchain(uint256 _chainId) public view returns (address) { - return IStateTransitionManager(stateTransitionManager[_chainId]).getHyperchain(_chainId); + /// @notice baseToken function, which takes chainId as input, reads assetHandler from AR, and tokenAddress from AH + function baseToken(uint256 _chainId) public view returns (address) { + bytes32 baseTokenAssetId = baseTokenAssetId[_chainId]; + address assetHandlerAddress = IAssetRouterBase(assetRouter).assetHandlerAddress(baseTokenAssetId); + + // It is possible that the asset handler is not deployed for a chain on the current layer. + // In this case we throw an error. + if (assetHandlerAddress == address(0)) { + revert AssetHandlerNotRegistered(baseTokenAssetId); + } + return IL1BaseTokenAssetHandler(assetHandlerAddress).tokenAddress(baseTokenAssetId); + } + + /// @notice Returns all the registered zkChain addresses + function getAllZKChains() public view override returns (address[] memory chainAddresses) { + uint256[] memory keys = zkChainMap.keys(); + chainAddresses = new address[](keys.length); + uint256 keysLength = keys.length; + for (uint256 i = 0; i < keysLength; ++i) { + chainAddresses[i] = zkChainMap.get(keys[i]); + } + } + + /// @notice Returns all the registered zkChain chainIDs + function getAllZKChainChainIDs() public view override returns (uint256[] memory) { + return zkChainMap.keys(); + } + + /// @notice Returns the address of the ZK chain with the corresponding chainID + /// @param _chainId the chainId of the chain + /// @return chainAddress the address of the ZK chain + function getZKChain(uint256 _chainId) public view override returns (address chainAddress) { + // slither-disable-next-line unused-return + (, chainAddress) = zkChainMap.tryGet(_chainId); } - function stmAssetIdFromChainId(uint256 _chainId) public view override returns (bytes32) { - return stmAssetId(stateTransitionManager[_chainId]); + function ctmAssetIdFromChainId(uint256 _chainId) public view override returns (bytes32) { + address ctmAddress = chainTypeManager[_chainId]; + if (ctmAddress == address(0)) { + revert ChainIdNotRegistered(_chainId); + } + return ctmAssetId(chainTypeManager[_chainId]); } - function stmAssetId(address _stmAddress) public view override returns (bytes32) { - return keccak256(abi.encode(L1_CHAIN_ID, address(stmDeployer), bytes32(uint256(uint160(_stmAddress))))); + function ctmAssetId(address _ctmAddress) public view override returns (bytes32) { + return keccak256(abi.encode(L1_CHAIN_ID, address(l1CtmDeployer), bytes32(uint256(uint160(_ctmAddress))))); } /*////////////////////////////////////////////////////////////// Mailbox forwarder //////////////////////////////////////////////////////////////*/ - /// @notice the mailbox is called directly after the sharedBridge received the deposit + /// @notice the mailbox is called directly after the assetRouter received the deposit /// this assumes that either ether is the base token or /// the msg.sender has approved mintValue allowance for the nativeTokenVault. /// This means this is not ideal for contract calls, as the contract would have to handle token allowance of the base Token. /// In case allowance is provided to the Shared Bridge, then it will be transferred to NTV. function requestL2TransactionDirect( L2TransactionRequestDirect calldata _request - ) external payable override nonReentrant whenNotPaused returns (bytes32 canonicalTxHash) { - // Note: If the hyperchain with corresponding `chainId` is not yet created, + ) external payable override nonReentrant whenNotPaused onlyL1 returns (bytes32 canonicalTxHash) { + // Note: If the ZK chain with corresponding `chainId` is not yet created, // the transaction will revert on `bridgehubRequestL2Transaction` as call to zero address. { bytes32 tokenAssetId = baseTokenAssetId[_request.chainId]; @@ -349,7 +456,7 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus } // slither-disable-next-line arbitrary-send-eth - sharedBridge.bridgehubDepositBaseToken{value: msg.value}( + IL1AssetRouter(assetRouter).bridgehubDepositBaseToken{value: msg.value}( _request.chainId, tokenAssetId, msg.sender, @@ -357,9 +464,9 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus ); } - address hyperchain = getHyperchain(_request.chainId); - address refundRecipient = AddressAliasHelper.actualRefundRecipient(_request.refundRecipient, msg.sender); - canonicalTxHash = IZkSyncHyperchain(hyperchain).bridgehubRequestL2Transaction( + canonicalTxHash = _sendRequest( + _request.chainId, + _request.refundRecipient, BridgehubL2TransactionRequest({ sender: msg.sender, contractL2: _request.l2Contract, @@ -369,12 +476,12 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus l2GasLimit: _request.l2GasLimit, l2GasPerPubdataByteLimit: _request.l2GasPerPubdataByteLimit, factoryDeps: _request.factoryDeps, - refundRecipient: refundRecipient + refundRecipient: address(0) }) ); } - /// @notice After depositing funds to the sharedBridge, the secondBridge is called + /// @notice After depositing funds to the assetRouter, the secondBridge is called /// to return the actual L2 message which is sent to the Mailbox. /// This assumes that either ether is the base token or /// the msg.sender has approved the nativeTokenVault with the mintValue, @@ -387,11 +494,10 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus /// @param _request the request for the L2 transaction function requestL2TransactionTwoBridges( L2TransactionRequestTwoBridgesOuter calldata _request - ) external payable override nonReentrant whenNotPaused returns (bytes32 canonicalTxHash) { - require( - _request.secondBridgeAddress > BRIDGEHUB_MIN_SECOND_BRIDGE_ADDRESS, - "BH: second bridge address too low" - ); // to avoid calls to precompiles + ) external payable override nonReentrant whenNotPaused onlyL1 returns (bytes32 canonicalTxHash) { + if (_request.secondBridgeAddress <= BRIDGEHUB_MIN_SECOND_BRIDGE_ADDRESS) { + revert AddressTooLow(_request.secondBridgeAddress); + } { bytes32 tokenAssetId = baseTokenAssetId[_request.chainId]; @@ -407,8 +513,9 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus } baseTokenMsgValue = 0; } + // slither-disable-next-line arbitrary-send-eth - sharedBridge.bridgehubDepositBaseToken{value: baseTokenMsgValue}( + IL1AssetRouter(assetRouter).bridgehubDepositBaseToken{value: baseTokenMsgValue}( _request.chainId, tokenAssetId, msg.sender, @@ -416,8 +523,6 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus ); } - address hyperchain = getHyperchain(_request.chainId); - // slither-disable-next-line arbitrary-send-eth L2TransactionRequestTwoBridgesInner memory outputRequest = IL1AssetRouter(_request.secondBridgeAddress) .bridgehubDeposit{value: _request.secondBridgeValue}( @@ -431,12 +536,9 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus revert WrongMagicValue(uint256(TWO_BRIDGES_MAGIC_VALUE), uint256(outputRequest.magicValue)); } - address refundRecipient = AddressAliasHelper.actualRefundRecipient(_request.refundRecipient, msg.sender); - - if (_request.secondBridgeAddress <= BRIDGEHUB_MIN_SECOND_BRIDGE_ADDRESS) { - revert AddressTooLow(_request.secondBridgeAddress); - } - canonicalTxHash = IZkSyncHyperchain(hyperchain).bridgehubRequestL2Transaction( + canonicalTxHash = _sendRequest( + _request.chainId, + _request.refundRecipient, BridgehubL2TransactionRequest({ sender: _request.secondBridgeAddress, contractL2: outputRequest.l2Contract, @@ -446,7 +548,7 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus l2GasLimit: _request.l2GasLimit, l2GasPerPubdataByteLimit: _request.l2GasPerPubdataByteLimit, factoryDeps: outputRequest.factoryDeps, - refundRecipient: refundRecipient + refundRecipient: address(0) }) ); @@ -457,31 +559,39 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus ); } + /// @notice This function is used to send a request to the ZK chain. + /// @param _chainId the chainId of the chain + /// @param _refundRecipient the refund recipient + /// @param _request the request + /// @return canonicalTxHash the canonical transaction hash + function _sendRequest( + uint256 _chainId, + address _refundRecipient, + BridgehubL2TransactionRequest memory _request + ) internal returns (bytes32 canonicalTxHash) { + address refundRecipient = AddressAliasHelper.actualRefundRecipient(_refundRecipient, msg.sender); + _request.refundRecipient = refundRecipient; + address zkChain = zkChainMap.get(_chainId); + + canonicalTxHash = IZKChain(zkChain).bridgehubRequestL2Transaction(_request); + } + /// @notice Used to forward a transaction on the gateway to the chains mailbox (from L1). /// @param _chainId the chainId of the chain - /// @param _transaction the transaction to be forwarded - /// @param _factoryDeps the factory dependencies for the transaction /// @param _canonicalTxHash the canonical transaction hash /// @param _expirationTimestamp the expiration timestamp for the transaction function forwardTransactionOnGateway( uint256 _chainId, - L2CanonicalTransaction calldata _transaction, - bytes[] calldata _factoryDeps, bytes32 _canonicalTxHash, uint64 _expirationTimestamp - ) external override onlyAliasedZero { + ) external override onlySettlementLayerRelayedSender { require(L1_CHAIN_ID != block.chainid, "BH: not in sync layer mode"); - address hyperchain = getHyperchain(_chainId); - IZkSyncHyperchain(hyperchain).bridgehubRequestL2TransactionOnGateway( - _transaction, - _factoryDeps, - _canonicalTxHash, - _expirationTimestamp - ); + address zkChain = zkChainMap.get(_chainId); + IZKChain(zkChain).bridgehubRequestL2TransactionOnGateway(_canonicalTxHash, _expirationTimestamp); } /// @notice forwards function call to Mailbox based on ChainId - /// @param _chainId The chain ID of the hyperchain where to prove L2 message inclusion. + /// @param _chainId The chain ID of the ZK chain where to prove L2 message inclusion. /// @param _batchNumber The executed L2 batch number in which the message appeared /// @param _index The position in the L2 logs Merkle tree of the l2Log that was sent with the message /// @param _message Information about the sent message: sender address, the message itself, tx index in the L2 batch where the message was sent @@ -494,12 +604,12 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus L2Message calldata _message, bytes32[] calldata _proof ) external view override returns (bool) { - address hyperchain = getHyperchain(_chainId); - return IZkSyncHyperchain(hyperchain).proveL2MessageInclusion(_batchNumber, _index, _message, _proof); + address zkChain = zkChainMap.get(_chainId); + return IZKChain(zkChain).proveL2MessageInclusion(_batchNumber, _index, _message, _proof); } /// @notice forwards function call to Mailbox based on ChainId - /// @param _chainId The chain ID of the hyperchain where to prove L2 log inclusion. + /// @param _chainId The chain ID of the ZK chain where to prove L2 log inclusion. /// @param _batchNumber The executed L2 batch number in which the log appeared /// @param _index The position of the l2log in the L2 logs Merkle tree /// @param _log Information about the sent log @@ -512,12 +622,12 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus L2Log calldata _log, bytes32[] calldata _proof ) external view override returns (bool) { - address hyperchain = getHyperchain(_chainId); - return IZkSyncHyperchain(hyperchain).proveL2LogInclusion(_batchNumber, _index, _log, _proof); + address zkChain = zkChainMap.get(_chainId); + return IZKChain(zkChain).proveL2LogInclusion(_batchNumber, _index, _log, _proof); } /// @notice forwards function call to Mailbox based on ChainId - /// @param _chainId The chain ID of the hyperchain where to prove L1->L2 tx status. + /// @param _chainId The chain ID of the ZK chain where to prove L1->L2 tx status. /// @param _l2TxHash The L2 canonical transaction hash /// @param _l2BatchNumber The L2 batch number where the transaction was processed /// @param _l2MessageIndex The position in the L2 logs Merkle tree of the l2Log that was sent with the message @@ -535,9 +645,9 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus bytes32[] calldata _merkleProof, TxStatus _status ) external view override returns (bool) { - address hyperchain = getHyperchain(_chainId); + address zkChain = zkChainMap.get(_chainId); return - IZkSyncHyperchain(hyperchain).proveL1ToL2TransactionStatus({ + IZKChain(zkChain).proveL1ToL2TransactionStatus({ _l2TxHash: _l2TxHash, _l2BatchNumber: _l2BatchNumber, _l2MessageIndex: _l2MessageIndex, @@ -554,8 +664,8 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus uint256 _l2GasLimit, uint256 _l2GasPerPubdataByteLimit ) external view returns (uint256) { - address hyperchain = getHyperchain(_chainId); - return IZkSyncHyperchain(hyperchain).l2TransactionBaseCost(_gasPrice, _l2GasLimit, _l2GasPerPubdataByteLimit); + address zkChain = zkChainMap.get(_chainId); + return IZKChain(zkChain).l2TransactionBaseCost(_gasPrice, _l2GasLimit, _l2GasPerPubdataByteLimit); } /*////////////////////////////////////////////////////////////// @@ -564,74 +674,182 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus /// @notice IL1AssetHandler interface, used to migrate (transfer) a chain to the settlement layer. /// @param _settlementChainId the chainId of the settlement chain, i.e. where the message and the migrating chain is sent. - /// @param _assetId the assetId of the migrating chain's STM - /// @param _prevMsgSender the previous message sender + /// @param _assetId the assetId of the migrating chain's CTM + /// @param _originalCaller the message sender initiated a set of calls that leads to bridge burn /// @param _data the data for the migration function bridgeBurn( uint256 _settlementChainId, - uint256, + uint256, // msgValue bytes32 _assetId, - address _prevMsgSender, + address _originalCaller, bytes calldata _data - ) external payable override onlyAssetRouter returns (bytes memory bridgehubMintData) { + ) external payable override onlyAssetRouter whenMigrationsNotPaused returns (bytes memory bridgehubMintData) { require(whitelistedSettlementLayers[_settlementChainId], "BH: SL not whitelisted"); - (uint256 _chainId, bytes memory _stmData, bytes memory _chainData) = abi.decode(_data, (uint256, bytes, bytes)); - require(_assetId == stmAssetIdFromChainId(_chainId), "BH: assetInfo 1"); - require(settlementLayer[_chainId] == block.chainid, "BH: not current SL"); - settlementLayer[_chainId] = _settlementChainId; + BridgehubBurnCTMAssetData memory bridgehubData = abi.decode(_data, (BridgehubBurnCTMAssetData)); + require(_assetId == ctmAssetIdFromChainId(bridgehubData.chainId), "BH: assetInfo 1"); + require(settlementLayer[bridgehubData.chainId] == block.chainid, "BH: not current SL"); + settlementLayer[bridgehubData.chainId] = _settlementChainId; + + address zkChain = zkChainMap.get(bridgehubData.chainId); + require(zkChain != address(0), "BH: zkChain not registered"); + require(_originalCaller == IZKChain(zkChain).getAdmin(), "BH: incorrect sender"); - bytes memory stmMintData = IStateTransitionManager(stateTransitionManager[_chainId]).forwardedBridgeBurn( - _chainId, - _stmData + bytes memory ctmMintData = IChainTypeManager(chainTypeManager[bridgehubData.chainId]).forwardedBridgeBurn( + bridgehubData.chainId, + bridgehubData.ctmData ); - bytes memory chainMintData = IZkSyncHyperchain(getHyperchain(_chainId)).forwardedBridgeBurn( - getHyperchain(_settlementChainId), - _prevMsgSender, - _chainData + bytes memory chainMintData = IZKChain(zkChain).forwardedBridgeBurn( + zkChainMap.get(_settlementChainId), + _originalCaller, + bridgehubData.chainData ); - bridgehubMintData = abi.encode(_chainId, stmMintData, chainMintData); - // TODO: double check that get only returns when chain id is there. + BridgehubMintCTMAssetData memory bridgeMintStruct = BridgehubMintCTMAssetData({ + chainId: bridgehubData.chainId, + baseTokenAssetId: baseTokenAssetId[bridgehubData.chainId], + ctmData: ctmMintData, + chainData: chainMintData + }); + bridgehubMintData = abi.encode(bridgeMintStruct); + + emit MigrationStarted(bridgehubData.chainId, _assetId, _settlementChainId); } /// @dev IL1AssetHandler interface, used to receive a chain on the settlement layer. /// @param _assetId the assetId of the chain's STM /// @param _bridgehubMintData the data for the mint function bridgeMint( - uint256, + uint256, // originChainId bytes32 _assetId, bytes calldata _bridgehubMintData - ) external payable override onlyAssetRouter returns (address l1Receiver) { - (uint256 _chainId, bytes memory _stmData, bytes memory _chainMintData) = abi.decode( - _bridgehubMintData, - (uint256, bytes, bytes) - ); - address stm = stmAssetIdToAddress[_assetId]; - require(stm != address(0), "BH: assetInfo 2"); - require(settlementLayer[_chainId] != block.chainid, "BH: already current SL"); - - settlementLayer[_chainId] = block.chainid; - stateTransitionManager[_chainId] = stm; - address hyperchain = getHyperchain(_chainId); - if (hyperchain == address(0)) { - hyperchain = IStateTransitionManager(stm).forwardedBridgeMint(_chainId, _stmData); + ) external payable override onlyAssetRouter whenMigrationsNotPaused { + BridgehubMintCTMAssetData memory bridgehubData = abi.decode(_bridgehubMintData, (BridgehubMintCTMAssetData)); + + address ctm = ctmAssetIdToAddress[_assetId]; + require(ctm != address(0), "BH: assetInfo 2"); + require(settlementLayer[bridgehubData.chainId] != block.chainid, "BH: already current SL"); + + settlementLayer[bridgehubData.chainId] = block.chainid; + chainTypeManager[bridgehubData.chainId] = ctm; + baseTokenAssetId[bridgehubData.chainId] = bridgehubData.baseTokenAssetId; + // To keep `assetIdIsRegistered` consistent, we'll also automatically register the base token. + // It is assumed that if the bridging happened, the token was approved on L1 already. + assetIdIsRegistered[bridgehubData.baseTokenAssetId] = true; + + address zkChain = getZKChain(bridgehubData.chainId); + bool contractAlreadyDeployed = zkChain != address(0); + if (!contractAlreadyDeployed) { + zkChain = IChainTypeManager(ctm).forwardedBridgeMint(bridgehubData.chainId, bridgehubData.ctmData); + require(zkChain != address(0), "BH: chain not registered"); + _registerNewZKChain(bridgehubData.chainId, zkChain); + messageRoot.addNewChain(bridgehubData.chainId); } - messageRoot.addNewChainIfNeeded(_chainId); - IZkSyncHyperchain(hyperchain).forwardedBridgeMint(_chainMintData); - return address(0); + IZKChain(zkChain).forwardedBridgeMint(bridgehubData.chainData, contractAlreadyDeployed); + + emit MigrationFinalized(bridgehubData.chainId, _assetId, zkChain); } /// @dev IL1AssetHandler interface, used to undo a failed migration of a chain. - /// @param _chainId the chainId of the chain - /// @param _assetId the assetId of the chain's STM - /// @param _data the data for the recovery + // / @param _chainId the chainId of the chain + /// @param _assetId the assetId of the chain's CTM + /// @param _data the data for the recovery. function bridgeRecoverFailedTransfer( - uint256 _chainId, + uint256, bytes32 _assetId, address _depositSender, bytes calldata _data - ) external payable override onlyAssetRouter {} + ) external payable override onlyAssetRouter onlyL1 { + BridgehubBurnCTMAssetData memory bridgehubData = abi.decode(_data, (BridgehubBurnCTMAssetData)); + + delete settlementLayer[bridgehubData.chainId]; + + IChainTypeManager(chainTypeManager[bridgehubData.chainId]).forwardedBridgeRecoverFailedTransfer({ + _chainId: bridgehubData.chainId, + _assetInfo: _assetId, + _depositSender: _depositSender, + _ctmData: bridgehubData.ctmData + }); + + IZKChain(getZKChain(bridgehubData.chainId)).forwardedBridgeRecoverFailedTransfer({ + _chainId: bridgehubData.chainId, + _assetInfo: _assetId, + _originalCaller: _depositSender, + _chainData: bridgehubData.chainData + }); + } + + /// @dev Registers an already deployed chain with the bridgehub + /// @param _chainId The chain Id of the chain + /// @param _zkChain Address of the zkChain + function registerAlreadyDeployedZKChain(uint256 _chainId, address _zkChain) external onlyOwner onlyL1 { + if (_zkChain == address(0)) { + revert ZeroAddress(); + } + if (zkChainMap.contains(_chainId)) { + revert ChainIdAlreadyExists(); + } + if (IZKChain(_zkChain).getChainId() != _chainId) { + revert ChainIdMismatch(); + } + + address ctm = IZKChain(_zkChain).getChainTypeManager(); + address chainAdmin = IZKChain(_zkChain).getAdmin(); + bytes32 chainBaseTokenAssetId = IZKChain(_zkChain).getBaseTokenAssetId(); + address bridgeHub = IZKChain(_zkChain).getBridgehub(); + + if (bridgeHub != address(this)) { + revert IncorrectBridgeHubAddress(bridgeHub); + } + + _validateChainParams({_chainId: _chainId, _assetId: chainBaseTokenAssetId, _chainTypeManager: ctm}); + + chainTypeManager[_chainId] = ctm; + + baseTokenAssetId[_chainId] = chainBaseTokenAssetId; + settlementLayer[_chainId] = block.chainid; + + _registerNewZKChain(_chainId, _zkChain); + messageRoot.addNewChain(_chainId); + + emit NewChain(_chainId, ctm, chainAdmin); + } + + function _validateChainParams(uint256 _chainId, bytes32 _assetId, address _chainTypeManager) internal view { + if (_chainId == 0) { + revert ZeroChainId(); + } + + if (_chainId > type(uint48).max) { + revert ChainIdTooBig(); + } + + if (_chainId == block.chainid) { + revert ChainIdCantBeCurrentChain(); + } + + if (_chainTypeManager == address(0)) { + revert ZeroAddress(); + } + if (_assetId == bytes32(0)) { + revert EmptyAssetId(); + } + + if (!chainTypeManagerIsRegistered[_chainTypeManager]) { + revert CTMNotRegistered(); + } + + if (!assetIdIsRegistered[_assetId]) { + revert AssetIdNotSupported(_assetId); + } + + if (assetRouter == address(0)) { + revert SharedBridgeNotSet(); + } + if (chainTypeManager[_chainId] != address(0)) { + revert BridgeHubAlreadyRegistered(); + } + } /*////////////////////////////////////////////////////////////// PAUSE @@ -646,4 +864,28 @@ contract Bridgehub is IBridgehub, ReentrancyGuard, Ownable2StepUpgradeable, Paus function unpause() external onlyOwner { _unpause(); } + + /// @notice Pauses migration functions. + function pauseMigration() external onlyOwner { + migrationPaused = true; + } + + /// @notice Unpauses migration functions. + function unpauseMigration() external onlyOwner { + migrationPaused = false; + } + + /*////////////////////////////////////////////////////////////// + Legacy functions + //////////////////////////////////////////////////////////////*/ + + /// @notice return the ZK chain contract for a chainId + function getHyperchain(uint256 _chainId) public view returns (address) { + return getZKChain(_chainId); + } + + /// @notice return the asset router + function sharedBridge() public view returns (address) { + return assetRouter; + } } diff --git a/l1-contracts/contracts/bridgehub/CTMDeploymentTracker.sol b/l1-contracts/contracts/bridgehub/CTMDeploymentTracker.sol new file mode 100644 index 000000000..6ffee2482 --- /dev/null +++ b/l1-contracts/contracts/bridgehub/CTMDeploymentTracker.sol @@ -0,0 +1,147 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +// solhint-disable reason-string, gas-custom-errors + +import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; +import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/security/PausableUpgradeable.sol"; + +import {IBridgehub, L2TransactionRequestTwoBridgesInner} from "./IBridgehub.sol"; +import {ICTMDeploymentTracker} from "./ICTMDeploymentTracker.sol"; + +import {IAssetRouterBase} from "../bridge/asset-router/IAssetRouterBase.sol"; +import {ReentrancyGuard} from "../common/ReentrancyGuard.sol"; +import {TWO_BRIDGES_MAGIC_VALUE} from "../common/Config.sol"; +import {L2_BRIDGEHUB_ADDR} from "../common/L2ContractAddresses.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @dev Contract to be deployed on L1, can link together other contracts based on AssetInfo. +contract CTMDeploymentTracker is ICTMDeploymentTracker, ReentrancyGuard, Ownable2StepUpgradeable, PausableUpgradeable { + /// @dev Bridgehub smart contract that is used to operate with L2 via asynchronous L2 <-> L1 communication. + IBridgehub public immutable override BRIDGE_HUB; + + /// @dev Bridgehub smart contract that is used to operate with L2 via asynchronous L2 <-> L1 communication. + IAssetRouterBase public immutable override L1_ASSET_ROUTER; + + /// @dev The encoding version of the data. + bytes1 internal constant ENCODING_VERSION = 0x01; + + /// @notice Checks that the message sender is the bridgehub. + modifier onlyBridgehub() { + // solhint-disable-next-line gas-custom-errors + require(msg.sender == address(BRIDGE_HUB), "CTM DT: not BH"); + _; + } + + /// @notice Checks that the message sender is the bridgehub. + modifier onlyOwnerViaRouter(address _originalCaller) { + // solhint-disable-next-line gas-custom-errors + require(msg.sender == address(L1_ASSET_ROUTER) && _originalCaller == owner(), "CTM DT: not owner via router"); + _; + } + + /// @dev Contract is expected to be used as proxy implementation on L1. + /// @dev Initialize the implementation to prevent Parity hack. + constructor(IBridgehub _bridgehub, IAssetRouterBase _sharedBridge) reentrancyGuardInitializer { + _disableInitializers(); + BRIDGE_HUB = _bridgehub; + L1_ASSET_ROUTER = _sharedBridge; + } + + /// @notice used to initialize the contract + /// @param _owner the owner of the contract + function initialize(address _owner) external reentrancyGuardInitializer { + _transferOwnership(_owner); + } + + /// @notice Used to register the ctm asset in L1 contracts, AssetRouter and Bridgehub. + /// @param _ctmAddress the address of the ctm asset + function registerCTMAssetOnL1(address _ctmAddress) external onlyOwner { + // solhint-disable-next-line gas-custom-errors + + require(BRIDGE_HUB.chainTypeManagerIsRegistered(_ctmAddress), "CTMDT: ctm not registered"); + L1_ASSET_ROUTER.setAssetHandlerAddressThisChain(bytes32(uint256(uint160(_ctmAddress))), address(BRIDGE_HUB)); + BRIDGE_HUB.setAssetHandlerAddress(bytes32(uint256(uint160(_ctmAddress))), _ctmAddress); + } + + /// @notice The function responsible for registering the L2 counterpart of an CTM asset on the L2 Bridgehub. + /// @dev The function is called by the Bridgehub contract during the `Bridgehub.requestL2TransactionTwoBridges`. + /// @dev Since the L2 settlement layers `_chainId` might potentially have ERC20 tokens as native assets, + /// there are two ways to perform the L1->L2 transaction: + /// - via the `Bridgehub.requestL2TransactionDirect`. However, this would require the CTMDeploymentTracker to + /// handle the ERC20 balances to be used in the transaction. + /// - via the `Bridgehub.requestL2TransactionTwoBridges`. This way it will be the sender that provides the funds + /// for the L2 transaction. + /// The second approach is used due to its simplicity even though it gives the sender slightly more control over the call: + /// `gasLimit`, etc. + /// @param _chainId the chainId of the chain + /// @param _originalCaller the previous message sender + /// @param _data the data of the transaction + // slither-disable-next-line locked-ether + function bridgehubDeposit( + uint256 _chainId, + address _originalCaller, + uint256, + bytes calldata _data + ) external payable onlyBridgehub returns (L2TransactionRequestTwoBridgesInner memory request) { + // solhint-disable-next-line gas-custom-errors + + require(msg.value == 0, "CTMDT: no eth allowed"); + // solhint-disable-next-line gas-custom-errors + + require(_originalCaller == owner(), "CTMDT: not owner"); + bytes1 encodingVersion = _data[0]; + require(encodingVersion == ENCODING_VERSION, "CTMDT: wrong encoding version"); + (address _ctmL1Address, address _ctmL2Address) = abi.decode(_data[1:], (address, address)); + + request = _registerCTMAssetOnL2Bridgehub(_chainId, _ctmL1Address, _ctmL2Address); + } + + /// @notice The function called by the Bridgehub after the L2 transaction has been initiated. + /// @dev Not used in this contract. In case the transaction fails, we can just re-try it. + function bridgehubConfirmL2Transaction(uint256 _chainId, bytes32 _txDataHash, bytes32 _txHash) external {} + + /// @notice Used to register the ctm asset in L2 AssetRouter. + /// @param _originalCaller the address that called the Router + /// @param _assetHandlerAddressOnCounterpart the address of the asset handler on the counterpart chain. + function bridgeCheckCounterpartAddress( + uint256, + bytes32, + address _originalCaller, + address _assetHandlerAddressOnCounterpart + ) external view override onlyOwnerViaRouter(_originalCaller) { + require(_assetHandlerAddressOnCounterpart == L2_BRIDGEHUB_ADDR, "CTMDT: wrong counter part"); + } + + function getAssetId(address _l1CTM) public view override returns (bytes32) { + return keccak256(abi.encode(block.chainid, address(this), bytes32(uint256(uint160(_l1CTM))))); + } + + /// @notice Used to register the ctm asset in L2 Bridgehub. + /// @param _chainId the chainId of the chain + function _registerCTMAssetOnL2Bridgehub( + // solhint-disable-next-line no-unused-vars + uint256 _chainId, + address _ctmL1Address, + address _ctmL2Address + ) internal pure returns (L2TransactionRequestTwoBridgesInner memory request) { + bytes memory l2TxCalldata = abi.encodeCall( + IBridgehub.setAssetHandlerAddress, + (bytes32(uint256(uint160(_ctmL1Address))), _ctmL2Address) + ); + + request = L2TransactionRequestTwoBridgesInner({ + magicValue: TWO_BRIDGES_MAGIC_VALUE, + l2Contract: L2_BRIDGEHUB_ADDR, + l2Calldata: l2TxCalldata, + factoryDeps: new bytes[](0), + // The `txDataHash` is typically used in usual ERC20 bridges to commit to the transaction data + // so that the user can recover funds in case the bridging fails on L2. + // However, this contract uses the `requestL2TransactionTwoBridges` method just to perform an L1->L2 transaction. + // We do not need to recover anything and so `bytes32(0)` here is okay. + txDataHash: bytes32(0) + }); + } +} diff --git a/l1-contracts/contracts/bridgehub/IBridgehub.sol b/l1-contracts/contracts/bridgehub/IBridgehub.sol index 089dc30c5..f5732b98e 100644 --- a/l1-contracts/contracts/bridgehub/IBridgehub.sol +++ b/l1-contracts/contracts/bridgehub/IBridgehub.sol @@ -2,11 +2,11 @@ // We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.21; -import {IL1AssetRouter} from "../bridge/interfaces/IL1AssetRouter.sol"; -import {L2CanonicalTransaction, L2Message, L2Log, TxStatus} from "../common/Messaging.sol"; +import {L2Message, L2Log, TxStatus} from "../common/Messaging.sol"; import {IL1AssetHandler} from "../bridge/interfaces/IL1AssetHandler.sol"; -import {ISTMDeploymentTracker} from "./ISTMDeploymentTracker.sol"; +import {ICTMDeploymentTracker} from "./ICTMDeploymentTracker.sol"; import {IMessageRoot} from "./IMessageRoot.sol"; +import {IAssetHandler} from "../bridge/interfaces/IAssetHandler.sol"; struct L2TransactionRequestDirect { uint256 chainId; @@ -40,9 +40,22 @@ struct L2TransactionRequestTwoBridgesInner { bytes32 txDataHash; } +struct BridgehubMintCTMAssetData { + uint256 chainId; + bytes32 baseTokenAssetId; + bytes ctmData; + bytes chainData; +} + +struct BridgehubBurnCTMAssetData { + uint256 chainId; + bytes ctmData; + bytes chainData; +} + /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -interface IBridgehub is IL1AssetHandler { +interface IBridgehub is IAssetHandler, IL1AssetHandler { /// @notice pendingAdmin is changed /// @dev Also emitted when new admin is accepted and in this case, `newPendingAdmin` would be zero address event NewPendingAdmin(address indexed oldPendingAdmin, address indexed newPendingAdmin); @@ -50,7 +63,7 @@ interface IBridgehub is IL1AssetHandler { /// @notice Admin changed event NewAdmin(address indexed oldAdmin, address indexed newAdmin); - /// @notice STM asset registered + /// @notice CTM asset registered event AssetRegistered( bytes32 indexed assetInfo, address indexed _assetAddress, @@ -58,6 +71,20 @@ interface IBridgehub is IL1AssetHandler { address sender ); + event SettlementLayerRegistered(uint256 indexed chainId, bool indexed isWhitelisted); + + /// @notice Emitted when the bridging to the chain is started. + /// @param chainId Chain ID of the ZK chain + /// @param assetId Asset ID of the token for the zkChain's CTM + /// @param settlementLayerChainId The chain id of the settlement layer the chain migrates to. + event MigrationStarted(uint256 indexed chainId, bytes32 indexed assetId, uint256 indexed settlementLayerChainId); + + /// @notice Emitted when the bridging to the chain is complete. + /// @param chainId Chain ID of the ZK chain + /// @param assetId Asset ID of the token for the zkChain's CTM + /// @param zkChain The address of the ZK chain on the chain where it is migrated to. + event MigrationFinalized(uint256 indexed chainId, bytes32 indexed assetId, address indexed zkChain); + /// @notice Starts the transfer of admin rights. Only the current admin or owner can propose a new pending one. /// @notice New admin can accept admin rights by calling `acceptAdmin` function. /// @param _newPendingAdmin Address of the new admin @@ -67,21 +94,29 @@ interface IBridgehub is IL1AssetHandler { function acceptAdmin() external; /// Getters - function stateTransitionManagerIsRegistered(address _stateTransitionManager) external view returns (bool); + function chainTypeManagerIsRegistered(address _chainTypeManager) external view returns (bool); - function stateTransitionManager(uint256 _chainId) external view returns (address); + function chainTypeManager(uint256 _chainId) external view returns (address); - function tokenIsRegistered(address _baseToken) external view returns (bool); + function assetIdIsRegistered(bytes32 _baseTokenAssetId) external view returns (bool); function baseToken(uint256 _chainId) external view returns (address); function baseTokenAssetId(uint256 _chainId) external view returns (bytes32); - function sharedBridge() external view returns (IL1AssetRouter); + function sharedBridge() external view returns (address); function messageRoot() external view returns (IMessageRoot); - function getHyperchain(uint256 _chainId) external view returns (address); + function getZKChain(uint256 _chainId) external view returns (address); + + function getAllZKChains() external view returns (address[] memory); + + function getAllZKChainChainIDs() external view returns (uint256[] memory); + + function migrationPaused() external view returns (bool); + + function admin() external view returns (address); /// Mailbox forwarder @@ -130,35 +165,33 @@ interface IBridgehub is IL1AssetHandler { function createNewChain( uint256 _chainId, - address _stateTransitionManager, - address _baseToken, + address _chainTypeManager, + bytes32 _baseTokenAssetId, uint256 _salt, address _admin, bytes calldata _initData, bytes[] calldata _factoryDeps ) external returns (uint256 chainId); - function addStateTransitionManager(address _stateTransitionManager) external; + function addChainTypeManager(address _chainTypeManager) external; - function removeStateTransitionManager(address _stateTransitionManager) external; + function removeChainTypeManager(address _chainTypeManager) external; - function addToken(address _token) external; + function addTokenAssetId(bytes32 _baseTokenAssetId) external; function setAddresses( address _sharedBridge, - ISTMDeploymentTracker _stmDeployer, + ICTMDeploymentTracker _l1CtmDeployer, IMessageRoot _messageRoot ) external; - event NewChain(uint256 indexed chainId, address stateTransitionManager, address indexed chainGovernance); - - event StateTransitionManagerAdded(address indexed stateTransitionManager); + event NewChain(uint256 indexed chainId, address chainTypeManager, address indexed chainGovernance); - event StateTransitionManagerRemoved(address indexed stateTransitionManager); + event ChainTypeManagerAdded(address indexed chainTypeManager); - event TokenRegistered(address indexed token); + event ChainTypeManagerRemoved(address indexed chainTypeManager); - event SharedBridgeUpdated(address indexed sharedBridge); + event BaseTokenAssetIdRegistered(bytes32 indexed assetId); function whitelistedSettlementLayers(uint256 _chainId) external view returns (bool); @@ -170,27 +203,35 @@ interface IBridgehub is IL1AssetHandler { // address _sharedBridge, // address _admin, // uint256 _expectedProtocolVersion, - // HyperchainCommitment calldata _commitment, + // ZKChainCommitment calldata _commitment, // bytes calldata _diamondCut // ) external; function forwardTransactionOnGateway( uint256 _chainId, - L2CanonicalTransaction calldata _transaction, - bytes[] calldata _factoryDeps, bytes32 _canonicalTxHash, uint64 _expirationTimestamp ) external; - function stmAssetIdFromChainId(uint256 _chainId) external view returns (bytes32); + function ctmAssetIdFromChainId(uint256 _chainId) external view returns (bytes32); - function stmAssetId(address _stmAddress) external view returns (bytes32); + function ctmAssetId(address _ctmAddress) external view returns (bytes32); - function stmDeployer() external view returns (ISTMDeploymentTracker); + function l1CtmDeployer() external view returns (ICTMDeploymentTracker); - function stmAssetIdToAddress(bytes32 _assetInfo) external view returns (address); + function ctmAssetIdToAddress(bytes32 _assetInfo) external view returns (address); - function setAssetHandlerAddressInitial(bytes32 _additionalData, address _assetAddress) external; + function setAssetHandlerAddress(bytes32 _additionalData, address _assetAddress) external; function L1_CHAIN_ID() external view returns (uint256); + + function setLegacyBaseTokenAssetId(uint256 _chainId) external; + + function registerAlreadyDeployedZKChain(uint256 _chainId, address _hyperchain) external; + + function setLegacyChainAddress(uint256 _chainId) external; + + /// @notice return the ZK chain contract for a chainId + /// @dev It is a legacy method. Do not use! + function getHyperchain(uint256 _chainId) external view returns (address); } diff --git a/l1-contracts/contracts/bridgehub/ICTMDeploymentTracker.sol b/l1-contracts/contracts/bridgehub/ICTMDeploymentTracker.sol new file mode 100644 index 000000000..5f75aa990 --- /dev/null +++ b/l1-contracts/contracts/bridgehub/ICTMDeploymentTracker.sol @@ -0,0 +1,26 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {L2TransactionRequestTwoBridgesInner, IBridgehub} from "./IBridgehub.sol"; +import {IAssetRouterBase} from "../bridge/asset-router/IAssetRouterBase.sol"; +import {IL1AssetDeploymentTracker} from "../bridge/interfaces/IL1AssetDeploymentTracker.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface ICTMDeploymentTracker is IL1AssetDeploymentTracker { + function bridgehubDeposit( + uint256 _chainId, + address _originalCaller, + uint256 _l2Value, + bytes calldata _data + ) external payable returns (L2TransactionRequestTwoBridgesInner memory request); + + function BRIDGE_HUB() external view returns (IBridgehub); + + function L1_ASSET_ROUTER() external view returns (IAssetRouterBase); + + function registerCTMAssetOnL1(address _ctmAddress) external; + + function getAssetId(address _l1CTM) external view returns (bytes32); +} diff --git a/l1-contracts/contracts/bridgehub/IMessageRoot.sol b/l1-contracts/contracts/bridgehub/IMessageRoot.sol index a0791b922..2e15e6f63 100644 --- a/l1-contracts/contracts/bridgehub/IMessageRoot.sol +++ b/l1-contracts/contracts/bridgehub/IMessageRoot.sol @@ -12,6 +12,4 @@ interface IMessageRoot { function addNewChain(uint256 _chainId) external; function addChainBatchRoot(uint256 _chainId, uint256 _batchNumber, bytes32 _chainBatchRoot) external; - - function addNewChainIfNeeded(uint256 _chainId) external; } diff --git a/l1-contracts/contracts/bridgehub/ISTMDeploymentTracker.sol b/l1-contracts/contracts/bridgehub/ISTMDeploymentTracker.sol deleted file mode 100644 index a1f71cdbf..000000000 --- a/l1-contracts/contracts/bridgehub/ISTMDeploymentTracker.sol +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {L2TransactionRequestTwoBridgesInner, IBridgehub} from "./IBridgehub.sol"; -import {IL1AssetRouter} from "../bridge/interfaces/IL1AssetRouter.sol"; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -interface ISTMDeploymentTracker { - function bridgehubDeposit( - uint256 _chainId, - address _prevMsgSender, - uint256 _l2Value, - bytes calldata _data - ) external payable returns (L2TransactionRequestTwoBridgesInner memory request); - - function BRIDGE_HUB() external view returns (IBridgehub); - - function SHARED_BRIDGE() external view returns (IL1AssetRouter); - - function registerSTMAssetOnL1(address _stmAddress) external; - - function getAssetId(address _l1STM) external view returns (bytes32); - - // todo temporary, will move into L1AssetRouter bridgehubDeposit - function registerSTMAssetOnL2SharedBridge( - uint256 _chainId, - address _stmL1Address, - uint256 _mintValue, - uint256 _l2TxGasLimit, - uint256 _l2TxGasPerPubdataByteLimit, - address _refundRecipient - ) external payable; -} diff --git a/l1-contracts/contracts/bridgehub/MessageRoot.sol b/l1-contracts/contracts/bridgehub/MessageRoot.sol index 9f70febd4..3d81b990f 100644 --- a/l1-contracts/contracts/bridgehub/MessageRoot.sol +++ b/l1-contracts/contracts/bridgehub/MessageRoot.sol @@ -14,7 +14,7 @@ import {FullMerkle} from "../common/libraries/FullMerkle.sol"; import {MessageHashing} from "../common/libraries/MessageHashing.sol"; -import {MAX_NUMBER_OF_HYPERCHAINS} from "../common/Config.sol"; +import {MAX_NUMBER_OF_ZK_CHAINS} from "../common/Config.sol"; // Chain tree consists of batch commitments as their leaves. We use hash of "new bytes(96)" as the hash of an empty leaf. bytes32 constant CHAIN_TREE_EMPTY_ENTRY_HASH = bytes32( @@ -45,19 +45,12 @@ contract MessageRoot is IMessageRoot, ReentrancyGuard { /// @notice The number of chains that are registered. uint256 public chainCount; - /// @notice The mapping from chainId to chainIndex. + /// @notice The mapping from chainId to chainIndex. Note index 0 is maintained for the chain the contract is on. mapping(uint256 chainId => uint256 chainIndex) public chainIndex; /// @notice The mapping from chainIndex to chainId. mapping(uint256 chainIndex => uint256 chainId) public chainIndexToId; - // There are two ways to distinguish chains: - // - Either by reserving the index 0 as a special value which denotes an unregistered chain - // - Use a separate mapping - // The second approach is used due to explicitness. - /// @notice The mapping from chainId to whether the chain is registered. Used because the chainIndex can be 0. - mapping(uint256 chainId => bool isRegistered) public chainRegistered; - /// @notice The shared full merkle tree storing the aggregate hash. FullMerkle.FullTree public sharedTree; @@ -73,7 +66,7 @@ contract MessageRoot is IMessageRoot, ReentrancyGuard { /// @notice only the bridgehub can call /// @param _chainId the chainId of the chain modifier onlyChain(uint256 _chainId) { - require(msg.sender == BRIDGE_HUB.getHyperchain(_chainId), "MR: only chain"); + require(msg.sender == BRIDGE_HUB.getZKChain(_chainId), "MR: only chain"); _; } @@ -91,16 +84,12 @@ contract MessageRoot is IMessageRoot, ReentrancyGuard { } function addNewChain(uint256 _chainId) external onlyBridgehub { - require(!chainRegistered[_chainId], "MR: chain exists"); + require(!chainRegistered(_chainId), "MR: chain exists"); _addNewChain(_chainId); } - /// @dev Adds a new chain to the message root if it has not been added yet. - /// @param _chainId the chainId of the chain - function addNewChainIfNeeded(uint256 _chainId) external onlyBridgehub { - if (!chainRegistered[_chainId]) { - _addNewChain(_chainId); - } + function chainRegistered(uint256 _chainId) public view returns (bool) { + return (_chainId == block.chainid || chainIndex[_chainId] != 0); } /// @dev add a new chainBatchRoot to the chainTree @@ -109,7 +98,7 @@ contract MessageRoot is IMessageRoot, ReentrancyGuard { uint256 _batchNumber, bytes32 _chainBatchRoot ) external onlyChain(_chainId) { - require(chainRegistered[_chainId], "MR: not registered"); + require(chainRegistered(_chainId), "MR: not registered"); bytes32 chainRoot; // slither-disable-next-line unused-return (, chainRoot) = chainTree[_chainId].push(MessageHashing.batchLeafHash(_chainBatchRoot, _batchNumber)); @@ -124,6 +113,9 @@ contract MessageRoot is IMessageRoot, ReentrancyGuard { /// @dev Gets the aggregated root of all chains. function getAggregatedRoot() external view returns (bytes32) { + if (chainCount == 0) { + return SHARED_ROOT_TREE_EMPTY_HASH; + } return sharedTree.root(); } @@ -146,20 +138,14 @@ contract MessageRoot is IMessageRoot, ReentrancyGuard { function _initialize() internal { // slither-disable-next-line unused-return sharedTree.setup(SHARED_ROOT_TREE_EMPTY_HASH); + _addNewChain(block.chainid); } /// @dev Adds a single chain to the message root. /// @param _chainId the chainId of the chain function _addNewChain(uint256 _chainId) internal { - // The chain itself can not be the part of the message root. - // The message root will only aggregate chains that settle on it. - require(_chainId != block.chainid, "MR: chainId is this chain"); - - chainRegistered[_chainId] = true; - - // We firstly increment `chainCount` and then apply it to ensure that `0` is reserved for chains that are not present. uint256 cachedChainCount = chainCount; - require(cachedChainCount < MAX_NUMBER_OF_HYPERCHAINS, "MR: too many chains"); + require(cachedChainCount < MAX_NUMBER_OF_ZK_CHAINS, "MR: too many chains"); ++chainCount; chainIndex[_chainId] = cachedChainCount; @@ -167,6 +153,7 @@ contract MessageRoot is IMessageRoot, ReentrancyGuard { // slither-disable-next-line unused-return bytes32 initialHash = chainTree[_chainId].setup(CHAIN_TREE_EMPTY_ENTRY_HASH); + // slither-disable-next-line unused-return sharedTree.pushNewLeaf(MessageHashing.chainIdLeafHash(initialHash, _chainId)); diff --git a/l1-contracts/contracts/bridgehub/STMDeploymentTracker.sol b/l1-contracts/contracts/bridgehub/STMDeploymentTracker.sol deleted file mode 100644 index 697e8331e..000000000 --- a/l1-contracts/contracts/bridgehub/STMDeploymentTracker.sol +++ /dev/null @@ -1,149 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -// solhint-disable reason-string, gas-custom-errors - -import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol"; -import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol"; - -import {L2TransactionRequestTwoBridgesInner} from "./IBridgehub.sol"; -import {ISTMDeploymentTracker} from "./ISTMDeploymentTracker.sol"; - -import {IBridgehub, IL1AssetRouter} from "../bridge/interfaces/IL1AssetRouter.sol"; -import {ReentrancyGuard} from "../common/ReentrancyGuard.sol"; -import {TWO_BRIDGES_MAGIC_VALUE} from "../common/Config.sol"; -import {L2_BRIDGEHUB_ADDR} from "../common/L2ContractAddresses.sol"; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -/// @dev Contract to be deployed on L1, can link together other contracts based on AssetInfo. -contract STMDeploymentTracker is ISTMDeploymentTracker, ReentrancyGuard, Ownable2StepUpgradeable, PausableUpgradeable { - /// @dev Bridgehub smart contract that is used to operate with L2 via asynchronous L2 <-> L1 communication. - IBridgehub public immutable override BRIDGE_HUB; - - /// @dev Bridgehub smart contract that is used to operate with L2 via asynchronous L2 <-> L1 communication. - IL1AssetRouter public immutable override SHARED_BRIDGE; - - /// @notice Checks that the message sender is the bridgehub. - modifier onlyBridgehub() { - // solhint-disable-next-line gas-custom-errors - require(msg.sender == address(BRIDGE_HUB), "STM DT: not BH"); - _; - } - - /// @dev Contract is expected to be used as proxy implementation on L1. - /// @dev Initialize the implementation to prevent Parity hack. - constructor(IBridgehub _bridgehub, IL1AssetRouter _sharedBridge) reentrancyGuardInitializer { - _disableInitializers(); - BRIDGE_HUB = _bridgehub; - SHARED_BRIDGE = _sharedBridge; - } - - /// @notice used to initialize the contract - /// @param _owner the owner of the contract - function initialize(address _owner) external reentrancyGuardInitializer { - _transferOwnership(_owner); - } - - /// @notice Used to register the stm asset in L1 contracts, AssetRouter and Bridgehub. - /// @param _stmAddress the address of the stm asset - function registerSTMAssetOnL1(address _stmAddress) external onlyOwner { - // solhint-disable-next-line gas-custom-errors - - require(BRIDGE_HUB.stateTransitionManagerIsRegistered(_stmAddress), "STMDT: stm not registered"); - SHARED_BRIDGE.setAssetHandlerAddressInitial(bytes32(uint256(uint160(_stmAddress))), address(BRIDGE_HUB)); - BRIDGE_HUB.setAssetHandlerAddressInitial(bytes32(uint256(uint160(_stmAddress))), _stmAddress); - } - - /// @notice The function responsible for registering the L2 counterpart of an STM asset on the L2 Bridgehub. - /// @dev The function is called by the Bridgehub contract during the `Bridgehub.requestL2TransactionTwoBridges`. - /// @dev Since the L2 settlement layers `_chainId` might potentially have ERC20 tokens as native assets, - /// there are two ways to perform the L1->L2 transaction: - /// - via the `Bridgehub.requestL2TransactionDirect`. However, this would require the STMDeploymentTracker to - /// handle the ERC20 balances to be used in the transaction. - /// - via the `Bridgehub.requestL2TransactionTwoBridges`. This way it will be the sender that provides the funds - /// for the L2 transaction. - /// The second approach is used due to its simplicity even though it gives the sender slightly more control over the call: - /// `gasLimit`, etc. - /// @param _chainId the chainId of the chain - /// @param _prevMsgSender the previous message sender - /// @param _data the data of the transaction - // slither-disable-next-line locked-ether - function bridgehubDeposit( - uint256 _chainId, - address _prevMsgSender, - uint256, - bytes calldata _data - ) external payable onlyBridgehub returns (L2TransactionRequestTwoBridgesInner memory request) { - // solhint-disable-next-line gas-custom-errors - - require(msg.value == 0, "STMDT: no eth allowed"); - // solhint-disable-next-line gas-custom-errors - - require(_prevMsgSender == owner(), "STMDT: not owner"); - (address _stmL1Address, address _stmL2Address) = abi.decode(_data, (address, address)); - - request = _registerSTMAssetOnL2Bridgehub(_chainId, _stmL1Address, _stmL2Address); - } - - /// @dev we need to implement this for the bridgehub for the TwoBridges logic - function bridgehubConfirmL2Transaction(uint256 _chainId, bytes32 _txDataHash, bytes32 _txHash) external { - // This function is typically used on bridges for e.g. - } - - // todo this has to be put in L1AssetRouter via TwoBridges for custom base tokens. Hard, because we have to have multiple msg types in bridgehubDeposit in the AssetRouter. - /// @notice Used to register the stm asset in L2 AssetRouter. - /// @param _chainId the chainId of the chain - function registerSTMAssetOnL2SharedBridge( - uint256 _chainId, - address _stmL1Address, - uint256 _mintValue, - uint256 _l2TxGasLimit, - uint256 _l2TxGasPerPubdataByteLimit, - address _refundRecipient - ) public payable onlyOwner { - bytes32 assetId; - { - assetId = getAssetId(_stmL1Address); - } - // slither-disable-next-line unused-return - SHARED_BRIDGE.setAssetHandlerAddressOnCounterPart{value: msg.value}({ - _chainId: _chainId, - _mintValue: _mintValue, - _l2TxGasLimit: _l2TxGasLimit, - _l2TxGasPerPubdataByte: _l2TxGasPerPubdataByteLimit, - _refundRecipient: _refundRecipient, - _assetId: assetId, - _assetAddressOnCounterPart: L2_BRIDGEHUB_ADDR - }); - } - - function getAssetId(address _l1STM) public view override returns (bytes32) { - return keccak256(abi.encode(block.chainid, address(this), bytes32(uint256(uint160(_l1STM))))); - } - - // Todo this works for now, but it will not work in the future if we want to change STM DTs. Probably ok. - /// @notice Used to register the stm asset in L2 Bridgehub. - /// @param _chainId the chainId of the chain - function _registerSTMAssetOnL2Bridgehub( - // solhint-disable-next-line no-unused-vars - uint256 _chainId, - address _stmL1Address, - address _stmL2Address - ) internal pure returns (L2TransactionRequestTwoBridgesInner memory request) { - bytes memory l2TxCalldata = abi.encodeCall( - /// todo it should not be initial in setAssetHandlerAddressInitial - IBridgehub.setAssetHandlerAddressInitial, - (bytes32(uint256(uint160(_stmL1Address))), _stmL2Address) - ); - - request = L2TransactionRequestTwoBridgesInner({ - magicValue: TWO_BRIDGES_MAGIC_VALUE, - l2Contract: L2_BRIDGEHUB_ADDR, - l2Calldata: l2TxCalldata, - factoryDeps: new bytes[](0), - txDataHash: bytes32(0) - }); - } -} diff --git a/l1-contracts/contracts/common/Config.sol b/l1-contracts/contracts/common/Config.sol index c7e665286..beebcd00c 100644 --- a/l1-contracts/contracts/common/Config.sol +++ b/l1-contracts/contracts/common/Config.sol @@ -112,10 +112,13 @@ bytes32 constant TWO_BRIDGES_MAGIC_VALUE = bytes32(uint256(keccak256("TWO_BRIDGE address constant BRIDGEHUB_MIN_SECOND_BRIDGE_ADDRESS = address(uint160(type(uint16).max)); /// @dev the maximum number of supported chains, this is an arbitrary limit. -uint256 constant MAX_NUMBER_OF_HYPERCHAINS = 100; +uint256 constant MAX_NUMBER_OF_ZK_CHAINS = 100; -/// @dev Used to when there is no sender contract on L1. This is the alias we apply to L1->L2 messages. -address constant VIRTUAL_SENDER_ALIASED_ZERO_ADDRESS = address(uint160(0x1111000000000000000000000000000000001111)); +/// @dev Used as the `msg.sender` for transactions that relayed via a settlement layer. +address constant SETTLEMENT_LAYER_RELAY_SENDER = address(uint160(0x1111111111111111111111111111111111111111)); + +/// @dev The metadata version that is supported by the ZK Chains to prove that an L2->L1 log was included in a batch. +uint256 constant SUPPORTED_PROOF_METADATA_VERSION = 1; struct PriorityTreeCommitment { uint256 nextLeafIndex; @@ -125,7 +128,7 @@ struct PriorityTreeCommitment { } // Info that allows to restore a chain. -struct HyperchainCommitment { +struct ZKChainCommitment { /// @notice Total number of executed batches i.e. batches[totalBatchesExecuted] points at the latest executed batch /// (batch 0 is genesis) uint256 totalBatchesExecuted; @@ -134,11 +137,17 @@ struct HyperchainCommitment { /// @notice Total number of committed batches i.e. batches[totalBatchesCommitted] points at the latest committed /// batch uint256 totalBatchesCommitted; - /// @notice + /// @notice The hash of the L2 system contracts ugpgrade transaction. + /// @dev It is non zero if the migration happens while the upgrade is not yet finalized. bytes32 l2SystemContractsUpgradeTxHash; - /// @notice + /// @notice The batch when the system contracts upgrade transaction was executed. + /// @dev It is non-zero if the migration happens while the batch where the upgrade tx was present + /// has not been finalized (executed) yet. uint256 l2SystemContractsUpgradeBatchNumber; + /// @notice The hashes of the batches that are needed to keep the blockchain working. + /// @dev The length of the array is equal to the `totalBatchesCommitted - totalBatchesExecuted + 1`, i.e. we need + /// to store all the unexecuted batches' hashes + 1 latest executed one. bytes32[] batchHashes; - /// @notice Commitment to the priority merkle tree + /// @notice Commitment to the priority merkle tree. PriorityTreeCommitment priorityTree; } diff --git a/l1-contracts/contracts/common/L1ContractErrors.sol b/l1-contracts/contracts/common/L1ContractErrors.sol index 73ff72cc9..48c90d540 100644 --- a/l1-contracts/contracts/common/L1ContractErrors.sol +++ b/l1-contracts/contracts/common/L1ContractErrors.sol @@ -1,12 +1,50 @@ // SPDX-License-Identifier: MIT pragma solidity ^0.8.21; +// 0x5ecf2d7a +error AccessToFallbackDenied(address target, address invoker); +// 0x3995f750 +error AccessToFunctionDenied(address target, bytes4 selector, address invoker); +// 0x6c167909 +error OnlySelfAllowed(); +// 0x52e22c98 +error RestrictionWasNotPresent(address restriction); +// 0xf126e113 +error RestrictionWasAlreadyPresent(address restriction); +// 0x3331e9c0 +error CallNotAllowed(bytes call); +// 0x59e1b0d2 +error ChainZeroAddress(); +// 0xff4bbdf1 +error NotAHyperchain(address chainAddress); +// 0xa3decdf3 +error NotAnAdmin(address expected, address actual); +// 0xf6fd7071 +error RemovingPermanentRestriction(); +// 0xfcb9b2e1 +error UnallowedImplementation(bytes32 implementationHash); // 0x1ff9d522 error AddressAlreadyUsed(address addr); +// +error AddressAlreadySet(address addr); // 0x86bb51b8 error AddressHasNoCode(address); +// +error AddressMismatch(address expected, address supplied); // 0x1eee5481 error AddressTooLow(address); +// +error AmountMustBeGreaterThanZero(); +// +error AssetHandlerDoesNotExist(bytes32 assetId); +// +error AssetIdMismatch(bytes32 expected, bytes32 supplied); +// +error AssetIdAlreadyRegistered(); +// 0x0bfcef28 +error AlreadyWhitelisted(address); +// 0x04a0b7e9 +error AssetIdNotSupported(bytes32 assetId); // 0x6afd6c20 error BadReturnData(); // 0x6ef9a972 @@ -21,6 +59,8 @@ error BatchNumberMismatch(uint256 expectedBatchNumber, uint256 providedBatchNumb error BlobHashCommitmentError(uint256 index, bool blobHashEmpty, bool blobCommitmentEmpty); // 0x6cf12312 error BridgeHubAlreadyRegistered(); +// +error BridgeMintNotImplemented(); // 0xcf102c5a error CalldataLengthTooBig(); // 0xe85392f9 @@ -29,6 +69,16 @@ error CanOnlyProcessOneBatch(); error CantExecuteUnprovenBatches(); // 0xe18cb383 error CantRevertExecutedBatch(); +// 0x24591d89 +error ChainIdAlreadyExists(); +// 0x717a1656 +error ChainIdCantBeCurrentChain(); +// 0xa179f8c9 +error ChainIdMismatch(); +// +error ChainIdNotRegistered(uint256 chainId); +// +error ChainNotLegacy(); // 0x78d2ed02 error ChainAlreadyLive(); // 0x8f620a06 @@ -37,6 +87,8 @@ error ChainIdTooBig(); error DelegateCallFailed(bytes returnData); // 0x0a8ed92c error DenominatorIsZero(); +// +error DeployFailed(); // 0xc7c9660f error DepositDoesNotExist(); // 0xad2fa98e @@ -51,14 +103,25 @@ error DiamondAlreadyFrozen(); error DiamondFreezeIncorrectState(); // 0xa7151b9a error DiamondNotFrozen(); +// +error EmptyAddress(); +// 0x2d4d012f +error EmptyAssetId(); // 0xfc7ab1d3 error EmptyBlobVersionHash(uint256 index); +// +error EmptyBytes32(); // 0x95b66fe9 error EmptyDeposit(); +// +error ETHDepositNotSupported(); +// +error FailedToTransferTokens(address tokenContract, address to, uint256 amount); // 0xac4a3f98 error FacetExists(bytes4 selector, address); // 0x79e12cc3 error FacetIsFrozen(bytes4 func); +error FunctionNotSupported(); // 0xc91cf3b1 error GasPerPubdataMismatch(); // 0x6d4a7df8 @@ -74,17 +137,25 @@ error HashedLogIsDefault(); // 0x0b08d5be error HashMismatch(bytes32 expected, bytes32 actual); // 0xb615c2b1 -error HyperchainLimitReached(); +error ZKChainLimitReached(); +// +error InsufficientAllowance(uint256 providedAllowance, uint256 requiredAmount); +// 0xdd381a4c +error IncorrectBridgeHubAddress(address bridgehub); // 0x826fb11e error InsufficientChainBalance(); // 0x356680b7 error InsufficientFunds(); +// +error InvalidCaller(address); // 0x7a47c9a2 error InvalidChainId(); // 0x4fbe5dba error InvalidDelay(); // 0x0af806e0 error InvalidHash(); +// +error InvalidInput(); // 0xc1780bd6 error InvalidLogSender(address sender, uint256 logKey); // 0xd8e9405c @@ -141,6 +212,8 @@ error MerkleIndexOutOfBounds(); error MerklePathEmpty(); // 0x1c500385 error MerklePathOutOfBounds(); +// +error MigrationPaused(); // 0xfa44b527 error MissingSystemLogs(uint256 expected, uint256 actual); // 0x4a094431 @@ -165,12 +238,16 @@ error NonEmptyMsgValue(); error NonIncreasingTimestamp(); // 0x0105f9c0 error NonSequentialBatch(); +// +error NonSequentialVersion(); // 0x4ef79e5a error NonZeroAddress(address); // 0xdd629f86 error NotEnoughGas(); // 0xdd7e3621 error NotInitializedReentrancyGuard(); +// 0xdf17e316 +error NotWhitelisted(address); // 0xf3ed9dfa error OnlyEraSupported(); // 0x1a21feed @@ -244,9 +321,9 @@ error SharedBridgeValueAlreadySet(SharedBridgeKey); // 0xdf3a8fdd error SlotOccupied(); // 0xd0bc70cf -error STMAlreadyRegistered(); +error CTMAlreadyRegistered(); // 0x09865e10 -error STMNotRegistered(); +error CTMNotRegistered(); // 0xae43b424 error SystemLogsSizeTooBig(); // 0x08753982 @@ -281,8 +358,14 @@ error UndefinedDiamondCutAction(); error UnexpectedNumberOfFactoryDeps(); // 0x6aa39880 error UnexpectedSystemLog(uint256 logKey); +// +error UnimplementedMessage(string); // 0xf093c2e5 error UpgradeBatchNumberIsNotZero(); +// +error UnsupportedEncodingVersion(); +// +error UnsupportedPaymasterFlow(); // 0x47b3b145 error ValidateTxnNotEnoughGas(); // 0x626ade30 @@ -305,6 +388,31 @@ error ZeroAddress(); error ZeroBalance(); // 0xc84885d4 error ZeroChainId(); +// 0x520aa59c +error PubdataIsEmpty(); +// 0x99d8fec9 +error EmptyData(); +// 0xc99a8360 +error UnsupportedCommitBatchEncoding(uint8 version); +// 0xe167e4a6 +error UnsupportedProofBatchEncoding(uint8 version); +// 0xe8e3f6f4 +error UnsupportedExecuteBatchEncoding(uint8 version); +// 0xd7d93e1f +error IncorrectBatchBounds( + uint256 processFromExpected, + uint256 processToExpected, + uint256 processFromProvided, + uint256 processToProvided +); +// 0x64107968 +error AssetHandlerNotRegistered(bytes32 assetId); +// 0x10f30e75 +error NotBridgehub(address addr); +// 0x2554babc +error InvalidAddress(address expected, address actual); +// 0xfa5cd00f +error NotAllowed(address addr); enum SharedBridgeKey { PostUpgradeFirstBatch, diff --git a/l1-contracts/contracts/common/L2ContractAddresses.sol b/l1-contracts/contracts/common/L2ContractAddresses.sol index 00afcef29..0d9e59936 100644 --- a/l1-contracts/contracts/common/L2ContractAddresses.sol +++ b/l1-contracts/contracts/common/L2ContractAddresses.sol @@ -41,10 +41,45 @@ address constant L2_GENESIS_UPGRADE_ADDR = address(0x10001); /// @dev The address of the L2 bridge hub system contract, used to start L2<>L2 transactions address constant L2_BRIDGEHUB_ADDR = address(0x10002); -/// @dev the address of the l2 asse3t router. +/// @dev the address of the l2 asset router. address constant L2_ASSET_ROUTER_ADDR = address(0x10003); +/** + * @author Matter Labs + * @custom:security-contact security@matterlabs.dev + * @notice Smart contract for sending arbitrary length messages to L1 + * @dev by default ZkSync can send fixed-length messages on L1. + * A fixed length message has 4 parameters `senderAddress`, `isService`, `key`, `value`, + * the first one is taken from the context, the other three are chosen by the sender. + * @dev To send a variable-length message we use this trick: + * - This system contract accepts an arbitrary length message and sends a fixed length message with + * parameters `senderAddress == this`, `isService == true`, `key == msg.sender`, `value == keccak256(message)`. + * - The contract on L1 accepts all sent messages and if the message came from this system contract + * it requires that the preimage of `value` be provided. + */ +interface IL2Messenger { + /// @notice Sends an arbitrary length message to L1. + /// @param _message The variable length message to be sent to L1. + /// @return Returns the keccak256 hashed value of the message. + function sendToL1(bytes memory _message) external returns (bytes32); +} + /// @dev An l2 system contract address, used in the assetId calculation for native assets. /// This is needed for automatic bridging, i.e. without deploying the AssetHandler contract, /// if the assetId can be calculated with this address then it is in fact an NTV asset -address constant L2_NATIVE_TOKEN_VAULT_ADDRESS = address(0x10004); +address constant L2_NATIVE_TOKEN_VAULT_ADDR = address(0x10004); + +/// @dev the address of the l2 asset router. +address constant L2_MESSAGE_ROOT_ADDR = address(0x10005); + +/// @dev the offset for the system contracts +uint160 constant SYSTEM_CONTRACTS_OFFSET = 0x8000; // 2^15 + +/// @dev the address of the deployer system contract +address constant DEPLOYER_SYSTEM_CONTRACT = address(SYSTEM_CONTRACTS_OFFSET + 0x06); + +/// @dev the address of the l2 messenger system contract +IL2Messenger constant L2_MESSENGER = IL2Messenger(address(SYSTEM_CONTRACTS_OFFSET + 0x08)); + +/// @dev the address of the msg value system contract +address constant MSG_VALUE_SYSTEM_CONTRACT = address(SYSTEM_CONTRACTS_OFFSET + 0x09); diff --git a/l1-contracts/contracts/common/interfaces/IL2ContractDeployer.sol b/l1-contracts/contracts/common/interfaces/IL2ContractDeployer.sol index 3d5b597df..015442dd9 100644 --- a/l1-contracts/contracts/common/interfaces/IL2ContractDeployer.sol +++ b/l1-contracts/contracts/common/interfaces/IL2ContractDeployer.sol @@ -4,7 +4,7 @@ pragma solidity ^0.8.21; /** * @author Matter Labs - * @notice System smart contract that is responsible for deploying other smart contracts on a ZKsync hyperchain. + * @notice System smart contract that is responsible for deploying other smart contracts on a ZK chain. */ interface IL2ContractDeployer { /// @notice A struct that describes a forced deployment on an address. diff --git a/l1-contracts/contracts/common/libraries/DataEncoding.sol b/l1-contracts/contracts/common/libraries/DataEncoding.sol index 39dcef4d5..9df83d67a 100644 --- a/l1-contracts/contracts/common/libraries/DataEncoding.sol +++ b/l1-contracts/contracts/common/libraries/DataEncoding.sol @@ -2,7 +2,10 @@ pragma solidity 0.8.24; -import {L2_NATIVE_TOKEN_VAULT_ADDRESS} from "../L2ContractAddresses.sol"; +import {L2_NATIVE_TOKEN_VAULT_ADDR} from "../L2ContractAddresses.sol"; +import {LEGACY_ENCODING_VERSION, NEW_ENCODING_VERSION} from "../../bridge/asset-router/IAssetRouterBase.sol"; +import {INativeTokenVault} from "../../bridge/ntv/INativeTokenVault.sol"; +import {UnsupportedEncodingVersion} from "../L1ContractErrors.sol"; /** * @author Matter Labs @@ -11,26 +14,26 @@ import {L2_NATIVE_TOKEN_VAULT_ADDRESS} from "../L2ContractAddresses.sol"; */ library DataEncoding { /// @notice Abi.encodes the data required for bridgeMint on remote chain. - /// @param _prevMsgSender The address which initiated the transfer. + /// @param _originalCaller The address which initiated the transfer. /// @param _l2Receiver The address which to receive tokens on remote chain. /// @param _l1Token The transferred token address. /// @param _amount The amount of token to be transferred. /// @param _erc20Metadata The transferred token metadata. /// @return The encoded bridgeMint data function encodeBridgeMintData( - address _prevMsgSender, + address _originalCaller, address _l2Receiver, address _l1Token, uint256 _amount, bytes memory _erc20Metadata ) internal pure returns (bytes memory) { // solhint-disable-next-line func-named-parameters - return abi.encode(_prevMsgSender, _l2Receiver, _l1Token, _amount, _erc20Metadata); + return abi.encode(_originalCaller, _l2Receiver, _l1Token, _amount, _erc20Metadata); } /// @notice Function decoding transfer data previously encoded with this library. /// @param _bridgeMintData The encoded bridgeMint data - /// @return _prevMsgSender The address which initiated the transfer. + /// @return _originalCaller The address which initiated the transfer. /// @return _l2Receiver The address which to receive tokens on remote chain. /// @return _parsedL1Token The transferred token address. /// @return _amount The amount of token to be transferred. @@ -41,14 +44,14 @@ library DataEncoding { internal pure returns ( - address _prevMsgSender, + address _originalCaller, address _l2Receiver, address _parsedL1Token, uint256 _amount, bytes memory _erc20Metadata ) { - (_prevMsgSender, _l2Receiver, _parsedL1Token, _amount, _erc20Metadata) = abi.decode( + (_originalCaller, _l2Receiver, _parsedL1Token, _amount, _erc20Metadata) = abi.decode( _bridgeMintData, (address, address, address, uint256, bytes) ); @@ -77,7 +80,7 @@ library DataEncoding { /// @param _assetData The asset data that has to be encoded. /// @return The encoded asset data. function encodeNTVAssetId(uint256 _chainId, bytes32 _assetData) internal pure returns (bytes32) { - return keccak256(abi.encode(_chainId, L2_NATIVE_TOKEN_VAULT_ADDRESS, _assetData)); + return keccak256(abi.encode(_chainId, L2_NATIVE_TOKEN_VAULT_ADDR, _assetData)); } /// @notice Encodes the asset data by combining chain id, NTV as asset deployment tracker and asset data. @@ -85,6 +88,65 @@ library DataEncoding { /// @param _tokenAddress The address of token that has to be encoded (asset data is the address itself). /// @return The encoded asset data. function encodeNTVAssetId(uint256 _chainId, address _tokenAddress) internal pure returns (bytes32) { - return keccak256(abi.encode(_chainId, L2_NATIVE_TOKEN_VAULT_ADDRESS, _tokenAddress)); + return keccak256(abi.encode(_chainId, L2_NATIVE_TOKEN_VAULT_ADDR, _tokenAddress)); + } + + /// @dev Encodes the transaction data hash using either the latest encoding standard or the legacy standard. + /// @param _encodingVersion EncodingVersion. + /// @param _originalCaller The address of the entity that initiated the deposit. + /// @param _assetId The unique identifier of the deposited L1 token. + /// @param _nativeTokenVault The address of the token, only used if the encoding version is legacy. + /// @param _transferData The encoded transfer data, which includes both the deposit amount and the address of the L2 receiver. + /// @return txDataHash The resulting encoded transaction data hash. + function encodeTxDataHash( + bytes1 _encodingVersion, + address _originalCaller, + bytes32 _assetId, + address _nativeTokenVault, + bytes memory _transferData + ) internal view returns (bytes32 txDataHash) { + if (_encodingVersion == LEGACY_ENCODING_VERSION) { + address tokenAddress = INativeTokenVault(_nativeTokenVault).tokenAddress(_assetId); + (uint256 depositAmount, ) = abi.decode(_transferData, (uint256, address)); + txDataHash = keccak256(abi.encode(_originalCaller, tokenAddress, depositAmount)); + } else if (_encodingVersion == NEW_ENCODING_VERSION) { + // Similarly to calldata, the txDataHash is collision-resistant. + // In the legacy data hash, the first encoded variable was the address, which is padded with zeros during `abi.encode`. + txDataHash = keccak256( + bytes.concat(_encodingVersion, abi.encode(_originalCaller, _assetId, _transferData)) + ); + } else { + revert UnsupportedEncodingVersion(); + } + } + + /// @notice Decodes the token data by combining chain id, asset deployment tracker and asset data. + function decodeTokenData( + bytes calldata _tokenData + ) internal pure returns (uint256 chainId, bytes memory name, bytes memory symbol, bytes memory decimals) { + bytes1 encodingVersion = _tokenData[0]; + // kl todo check correct + if (encodingVersion == LEGACY_ENCODING_VERSION) { + (name, symbol, decimals) = abi.decode(_tokenData, (bytes, bytes, bytes)); + } else if (encodingVersion == NEW_ENCODING_VERSION) { + return abi.decode(_tokenData[1:], (uint256, bytes, bytes, bytes)); + } else { + revert UnsupportedEncodingVersion(); + } + } + + /// @notice Encodes the token data by combining chain id, asset deployment tracker and asset data. + /// @param _chainId The id of the chain token is native to. + /// @param _name The name of the token. + /// @param _symbol The symbol of the token. + /// @param _decimals The decimals of the token. + /// @return The encoded token data. + function encodeTokenData( + uint256 _chainId, + bytes memory _name, + bytes memory _symbol, + bytes memory _decimals + ) internal pure returns (bytes memory) { + return bytes.concat(NEW_ENCODING_VERSION, abi.encode(_chainId, _name, _symbol, _decimals)); } } diff --git a/l1-contracts/contracts/common/libraries/DynamicIncrementalMerkle.sol b/l1-contracts/contracts/common/libraries/DynamicIncrementalMerkle.sol index 45f13cfaa..b41b665d3 100644 --- a/l1-contracts/contracts/common/libraries/DynamicIncrementalMerkle.sol +++ b/l1-contracts/contracts/common/libraries/DynamicIncrementalMerkle.sol @@ -3,7 +3,7 @@ pragma solidity 0.8.24; import {Merkle} from "./Merkle.sol"; -import {Arrays} from "@openzeppelin/contracts/utils/Arrays.sol"; +import {Arrays} from "@openzeppelin/contracts-v4/utils/Arrays.sol"; /** * @dev Library for managing https://wikipedia.org/wiki/Merkle_Tree[Merkle Tree] data structures. diff --git a/l1-contracts/contracts/common/libraries/L2ContractHelper.sol b/l1-contracts/contracts/common/libraries/L2ContractHelper.sol index 93d786936..2d1a26c1f 100644 --- a/l1-contracts/contracts/common/libraries/L2ContractHelper.sol +++ b/l1-contracts/contracts/common/libraries/L2ContractHelper.sol @@ -5,6 +5,38 @@ pragma solidity ^0.8.21; import {BytecodeError, MalformedBytecode, LengthIsNotDivisibleBy32} from "../L1ContractErrors.sol"; import {UncheckedMath} from "./UncheckedMath.sol"; +import {L2_MESSENGER} from "../L2ContractAddresses.sol"; + +/** + * @author Matter Labs + * @custom:security-contact security@matterlabs.dev + * @notice Interface for the contract that is used to deploy contracts on L2. + */ +interface IContractDeployer { + /// @notice A struct that describes a forced deployment on an address. + /// @param bytecodeHash The bytecode hash to put on an address. + /// @param newAddress The address on which to deploy the bytecodehash to. + /// @param callConstructor Whether to run the constructor on the force deployment. + /// @param value The `msg.value` with which to initialize a contract. + /// @param input The constructor calldata. + struct ForceDeployment { + bytes32 bytecodeHash; + address newAddress; + bool callConstructor; + uint256 value; + bytes input; + } + + /// @notice This method is to be used only during an upgrade to set bytecodes on specific addresses. + /// @param _deployParams A set of parameters describing force deployment. + function forceDeployOnAddresses(ForceDeployment[] calldata _deployParams) external payable; + + /// @notice Creates a new contract at a determined address using the `CREATE2` salt on L2 + /// @param _salt a unique value to create the deterministic address of the new contract + /// @param _bytecodeHash the bytecodehash of the new contract to be deployed + /// @param _input the calldata to be sent to the constructor of the new contract + function create2(bytes32 _salt, bytes32 _bytecodeHash, bytes calldata _input) external returns (address); +} /** * @author Matter Labs @@ -17,6 +49,13 @@ library L2ContractHelper { /// @dev The prefix used to create CREATE2 addresses. bytes32 private constant CREATE2_PREFIX = keccak256("zksyncCreate2"); + /// @notice Sends L2 -> L1 arbitrary-long message through the system contract messenger. + /// @param _message Data to be sent to L1. + /// @return keccak256 hash of the sent message. + function sendMessageToL1(bytes memory _message) internal returns (bytes32) { + return L2_MESSENGER.sendToL1(_message); + } + /// @notice Validate the bytecode format and calculate its hash. /// @param _bytecode The bytecode to hash. /// @return hashedBytecode The 32-byte hash of the bytecode. diff --git a/l1-contracts/contracts/common/libraries/Merkle.sol b/l1-contracts/contracts/common/libraries/Merkle.sol index 73bcfe2e5..66db8ea75 100644 --- a/l1-contracts/contracts/common/libraries/Merkle.sol +++ b/l1-contracts/contracts/common/libraries/Merkle.sol @@ -1,10 +1,11 @@ // SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. +pragma solidity ^0.8.21; // solhint-disable gas-custom-errors import {UncheckedMath} from "../../common/libraries/UncheckedMath.sol"; +import {MerklePathEmpty, MerklePathOutOfBounds, MerkleIndexOutOfBounds} from "../../common/L1ContractErrors.sol"; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev @@ -23,9 +24,7 @@ library Merkle { bytes32 _itemHash ) internal pure returns (bytes32) { uint256 pathLength = _path.length; - require(pathLength > 0, "xc"); - require(pathLength < 256, "bt"); - require(_index < (1 << pathLength), "px"); + _validatePathLengthForSingleProof(_index, pathLength); bytes32 currentHash = _itemHash; for (uint256 i; i < pathLength; i = i.uncheckedInc()) { @@ -50,9 +49,7 @@ library Merkle { bytes32 _itemHash ) internal pure returns (bytes32) { uint256 pathLength = _path.length; - require(pathLength > 0, "xc"); - require(pathLength < 256, "bt"); - require(_index < (1 << pathLength), "px"); + _validatePathLengthForSingleProof(_index, pathLength); bytes32 currentHash = _itemHash; for (uint256 i; i < pathLength; i = i.uncheckedInc()) { @@ -73,17 +70,21 @@ library Merkle { /// @param _itemHashes Hashes of the elements in the range /// @return The Merkle root function calculateRootPaths( - bytes32[] calldata _startPath, - bytes32[] calldata _endPath, + bytes32[] memory _startPath, + bytes32[] memory _endPath, uint256 _startIndex, - bytes32[] calldata _itemHashes + bytes32[] memory _itemHashes ) internal pure returns (bytes32) { uint256 pathLength = _startPath.length; require(pathLength == _endPath.length, "Merkle: path length mismatch"); - require(pathLength < 256, "Merkle: path too long"); + if (pathLength >= 256) { + revert MerklePathOutOfBounds(); + } uint256 levelLen = _itemHashes.length; // Edge case: we want to be able to prove an element in a single-node tree. - require(pathLength > 0 || (_startIndex == 0 && levelLen == 1), "Merkle: empty paths"); + if (pathLength == 0 && (_startIndex != 0 || levelLen != 1)) { + revert MerklePathEmpty(); + } require(levelLen > 0, "Merkle: nothing to prove"); require(_startIndex + levelLen <= (1 << pathLength), "Merkle: index/height mismatch"); bytes32[] memory itemHashes = _itemHashes; @@ -115,4 +116,16 @@ library Merkle { result := keccak256(0x00, 0x40) } } + + function _validatePathLengthForSingleProof(uint256 _index, uint256 _pathLength) private pure { + if (_pathLength == 0) { + revert MerklePathEmpty(); + } + if (_pathLength >= 256) { + revert MerklePathOutOfBounds(); + } + if (_index >= (1 << _pathLength)) { + revert MerkleIndexOutOfBounds(); + } + } } diff --git a/l1-contracts/contracts/common/libraries/SystemContractsCaller.sol b/l1-contracts/contracts/common/libraries/SystemContractsCaller.sol new file mode 100644 index 000000000..b6bf0c54a --- /dev/null +++ b/l1-contracts/contracts/common/libraries/SystemContractsCaller.sol @@ -0,0 +1,145 @@ +// SPDX-License-Identifier: MIT + +// solhint-disable one-contract-per-file + +pragma solidity 0.8.24; + +import {MSG_VALUE_SYSTEM_CONTRACT} from "../L2ContractAddresses.sol"; + +address constant SYSTEM_CALL_CALL_ADDRESS = address((1 << 16) - 11); +/// @dev If the bitwise AND of the extraAbi[2] param when calling the MSG_VALUE_SIMULATOR +/// is non-zero, the call will be assumed to be a system one. +uint256 constant MSG_VALUE_SIMULATOR_IS_SYSTEM_BIT = 1; + +/// @notice The way to forward the calldata: +/// - Use the current heap (i.e. the same as on EVM). +/// - Use the auxiliary heap. +/// - Forward via a pointer +/// @dev Note, that currently, users do not have access to the auxiliary +/// heap and so the only type of forwarding that will be used by the users +/// are UseHeap and ForwardFatPointer for forwarding a slice of the current calldata +/// to the next call. +enum CalldataForwardingMode { + UseHeap, + ForwardFatPointer, + UseAuxHeap +} + +/// @notice Error thrown a cast from uint256 to u32 is not possible. +error U32CastOverflow(); + +library Utils { + function safeCastToU32(uint256 _x) internal pure returns (uint32) { + if (_x > type(uint32).max) { + revert U32CastOverflow(); + } + + return uint32(_x); + } +} + +/// @notice The library contains the functions to make system calls. +/// @dev A more detailed description of the library and its methods can be found in the `system-contracts` repo. +library SystemContractsCaller { + function systemCall(uint32 gasLimit, address to, uint256 value, bytes memory data) internal returns (bool success) { + address callAddr = SYSTEM_CALL_CALL_ADDRESS; + + uint32 dataStart; + assembly { + dataStart := add(data, 0x20) + } + uint32 dataLength = uint32(Utils.safeCastToU32(data.length)); + + uint256 farCallAbi = getFarCallABI({ + dataOffset: 0, + memoryPage: 0, + dataStart: dataStart, + dataLength: dataLength, + gasPassed: gasLimit, + // Only rollup is supported for now + shardId: 0, + forwardingMode: CalldataForwardingMode.UseHeap, + isConstructorCall: false, + isSystemCall: true + }); + + if (value == 0) { + // Doing the system call directly + assembly { + success := call(to, callAddr, 0, 0, farCallAbi, 0, 0) + } + } else { + address msgValueSimulator = MSG_VALUE_SYSTEM_CONTRACT; + // We need to supply the mask to the MsgValueSimulator to denote + // that the call should be a system one. + uint256 forwardMask = MSG_VALUE_SIMULATOR_IS_SYSTEM_BIT; + + assembly { + success := call(msgValueSimulator, callAddr, value, to, farCallAbi, forwardMask, 0) + } + } + } + + function systemCallWithReturndata( + uint32 gasLimit, + address to, + uint128 value, + bytes memory data + ) internal returns (bool success, bytes memory returnData) { + success = systemCall(gasLimit, to, value, data); + + uint256 size; + assembly { + size := returndatasize() + } + + returnData = new bytes(size); + assembly { + returndatacopy(add(returnData, 0x20), 0, size) + } + } + + function getFarCallABI( + uint32 dataOffset, + uint32 memoryPage, + uint32 dataStart, + uint32 dataLength, + uint32 gasPassed, + uint8 shardId, + CalldataForwardingMode forwardingMode, + bool isConstructorCall, + bool isSystemCall + ) internal pure returns (uint256 farCallAbi) { + // Fill in the call parameter fields + farCallAbi = getFarCallABIWithEmptyFatPointer({ + gasPassed: gasPassed, + shardId: shardId, + forwardingMode: forwardingMode, + isConstructorCall: isConstructorCall, + isSystemCall: isSystemCall + }); + // Fill in the fat pointer fields + farCallAbi |= dataOffset; + farCallAbi |= (uint256(memoryPage) << 32); + farCallAbi |= (uint256(dataStart) << 64); + farCallAbi |= (uint256(dataLength) << 96); + } + + function getFarCallABIWithEmptyFatPointer( + uint32 gasPassed, + uint8 shardId, + CalldataForwardingMode forwardingMode, + bool isConstructorCall, + bool isSystemCall + ) internal pure returns (uint256 farCallAbiWithEmptyFatPtr) { + farCallAbiWithEmptyFatPtr |= (uint256(gasPassed) << 192); + farCallAbiWithEmptyFatPtr |= (uint256(forwardingMode) << 224); + farCallAbiWithEmptyFatPtr |= (uint256(shardId) << 232); + if (isConstructorCall) { + farCallAbiWithEmptyFatPtr |= (1 << 240); + } + if (isSystemCall) { + farCallAbiWithEmptyFatPtr |= (1 << 248); + } + } +} diff --git a/l1-contracts/contracts/common/libraries/UnsafeBytes.sol b/l1-contracts/contracts/common/libraries/UnsafeBytes.sol index e2680d9e0..4edf94004 100644 --- a/l1-contracts/contracts/common/libraries/UnsafeBytes.sol +++ b/l1-contracts/contracts/common/libraries/UnsafeBytes.sol @@ -30,6 +30,13 @@ library UnsafeBytes { } } + function readUint128(bytes memory _bytes, uint256 _start) internal pure returns (uint128 result, uint256 offset) { + assembly { + offset := add(_start, 16) + result := mload(add(_bytes, offset)) + } + } + function readUint256(bytes memory _bytes, uint256 _start) internal pure returns (uint256 result, uint256 offset) { assembly { offset := add(_start, 32) diff --git a/l1-contracts/contracts/dev-contracts/DummyL1ERC20Bridge.sol b/l1-contracts/contracts/dev-contracts/DummyL1ERC20Bridge.sol index f3cf869cf..5ca21d4ba 100644 --- a/l1-contracts/contracts/dev-contracts/DummyL1ERC20Bridge.sol +++ b/l1-contracts/contracts/dev-contracts/DummyL1ERC20Bridge.sol @@ -3,14 +3,17 @@ pragma solidity 0.8.24; import {L1ERC20Bridge} from "../bridge/L1ERC20Bridge.sol"; -import {IL1AssetRouter} from "../bridge/interfaces/IL1AssetRouter.sol"; -import {IL1NativeTokenVault} from "../bridge/interfaces/IL1NativeTokenVault.sol"; +import {IL1AssetRouter} from "../bridge/asset-router/IL1AssetRouter.sol"; +import {IL1NativeTokenVault} from "../bridge/ntv/IL1NativeTokenVault.sol"; +import {IL1Nullifier} from "../bridge/interfaces/IL1Nullifier.sol"; contract DummyL1ERC20Bridge is L1ERC20Bridge { constructor( + IL1Nullifier _l1Nullifier, IL1AssetRouter _l1SharedBridge, - IL1NativeTokenVault _l1NativeTokenVault - ) L1ERC20Bridge(_l1SharedBridge, _l1NativeTokenVault, 1) {} + IL1NativeTokenVault _l1NativeTokenVault, + uint256 _eraChainId + ) L1ERC20Bridge(_l1Nullifier, _l1SharedBridge, _l1NativeTokenVault, _eraChainId) {} function setValues(address _l2SharedBridge, address _l2TokenBeacon, bytes32 _l2TokenProxyBytecodeHash) external { l2Bridge = _l2SharedBridge; diff --git a/l1-contracts/contracts/dev-contracts/WETH9.sol b/l1-contracts/contracts/dev-contracts/WETH9.sol index e094ba89e..5ab311b13 100644 --- a/l1-contracts/contracts/dev-contracts/WETH9.sol +++ b/l1-contracts/contracts/dev-contracts/WETH9.sol @@ -30,7 +30,17 @@ contract WETH9 { function withdraw(uint256 wad) public { require(balanceOf[msg.sender] >= wad, "weth9, 1"); balanceOf[msg.sender] -= wad; - payable(msg.sender).transfer(wad); + // this is a hack so that zkfoundry works, but we are deploying WETH9 on L2 as well. + // payable(msg.sender).transfer(wad); + bool callSuccess; + address sender = msg.sender; + // Low-level assembly call, to avoid any memory copying (save gas) + assembly { + callSuccess := call(gas(), sender, wad, 0, 0, 0, 0) + } + if (!callSuccess) { + require(false, "Withdraw failed"); + } emit Withdrawal(msg.sender, wad); } diff --git a/l1-contracts/contracts/dev-contracts/test/AdminFacetTest.sol b/l1-contracts/contracts/dev-contracts/test/AdminFacetTest.sol index 614c34bb9..bf5ef724f 100644 --- a/l1-contracts/contracts/dev-contracts/test/AdminFacetTest.sol +++ b/l1-contracts/contracts/dev-contracts/test/AdminFacetTest.sol @@ -8,9 +8,9 @@ contract AdminFacetTest is AdminFacet { // add this to be excluded from coverage report function test() internal virtual {} - constructor() { + constructor(uint256 _l1ChainId) AdminFacet(_l1ChainId) { s.admin = msg.sender; - s.stateTransitionManager = msg.sender; + s.chainTypeManager = msg.sender; } function getPorterAvailability() external view returns (bool) { diff --git a/l1-contracts/contracts/dev-contracts/test/DiamondProxyTest.sol b/l1-contracts/contracts/dev-contracts/test/DiamondProxyTest.sol index 212a2b76a..a8ae37582 100644 --- a/l1-contracts/contracts/dev-contracts/test/DiamondProxyTest.sol +++ b/l1-contracts/contracts/dev-contracts/test/DiamondProxyTest.sol @@ -3,9 +3,9 @@ pragma solidity 0.8.24; import {Diamond} from "../../state-transition/libraries/Diamond.sol"; -import {ZkSyncHyperchainBase} from "../../state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol"; +import {ZKChainBase} from "../../state-transition/chain-deps/facets/ZKChainBase.sol"; -contract DiamondProxyTest is ZkSyncHyperchainBase { +contract DiamondProxyTest is ZKChainBase { // add this to be excluded from coverage report function test() internal virtual {} diff --git a/l1-contracts/contracts/dev-contracts/test/DummyAdminFacet.sol b/l1-contracts/contracts/dev-contracts/test/DummyAdminFacet.sol index 0a27a7e1c..82c64c4e8 100644 --- a/l1-contracts/contracts/dev-contracts/test/DummyAdminFacet.sol +++ b/l1-contracts/contracts/dev-contracts/test/DummyAdminFacet.sol @@ -2,9 +2,9 @@ pragma solidity 0.8.24; -import {ZkSyncHyperchainBase} from "../../state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol"; +import {ZKChainBase} from "../../state-transition/chain-deps/facets/ZKChainBase.sol"; -contract DummyAdminFacet is ZkSyncHyperchainBase { +contract DummyAdminFacet is ZKChainBase { // add this to be excluded from coverage report function test() internal virtual {} diff --git a/l1-contracts/contracts/dev-contracts/test/DummyAdminFacetNoOverlap.sol b/l1-contracts/contracts/dev-contracts/test/DummyAdminFacetNoOverlap.sol index 030006109..b66c76bf0 100644 --- a/l1-contracts/contracts/dev-contracts/test/DummyAdminFacetNoOverlap.sol +++ b/l1-contracts/contracts/dev-contracts/test/DummyAdminFacetNoOverlap.sol @@ -3,12 +3,12 @@ pragma solidity 0.8.24; import {Diamond} from "../../state-transition/libraries/Diamond.sol"; -import {ZkSyncHyperchainBase} from "../../state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol"; -import {IL1AssetRouter} from "../../bridge/interfaces/IL1AssetRouter.sol"; +import {ZKChainBase} from "../../state-transition/chain-deps/facets/ZKChainBase.sol"; +import {IL1AssetRouter} from "../../bridge/asset-router/IL1AssetRouter.sol"; import {DataEncoding} from "../../common/libraries/DataEncoding.sol"; /// selectors do not overlap with normal facet selectors (getName does not count) -contract DummyAdminFacetNoOverlap is ZkSyncHyperchainBase { +contract DummyAdminFacetNoOverlap is ZKChainBase { // add this to be excluded from coverage report function test() internal virtual {} @@ -18,7 +18,6 @@ contract DummyAdminFacetNoOverlap is ZkSyncHyperchainBase { function executeUpgradeNoOverlap(Diamond.DiamondCutData calldata _diamondCut) external { Diamond.diamondCut(_diamondCut); - s.baseTokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, s.baseToken); } function receiveEther() external payable {} diff --git a/l1-contracts/contracts/dev-contracts/test/DummyBridgehub.sol b/l1-contracts/contracts/dev-contracts/test/DummyBridgehub.sol index fc092c801..5038f5f66 100644 --- a/l1-contracts/contracts/dev-contracts/test/DummyBridgehub.sol +++ b/l1-contracts/contracts/dev-contracts/test/DummyBridgehub.sol @@ -3,27 +3,27 @@ pragma solidity 0.8.24; import {ETH_TOKEN_ADDRESS} from "../../common/Config.sol"; -import {L2_NATIVE_TOKEN_VAULT_ADDRESS} from "../../common/L2ContractAddresses.sol"; +import {L2_NATIVE_TOKEN_VAULT_ADDR} from "../../common/L2ContractAddresses.sol"; import {IMessageRoot} from "../../bridgehub/IMessageRoot.sol"; import {IGetters} from "../../state-transition/chain-interfaces/IGetters.sol"; -import {Bridgehub} from "../../bridgehub/Bridgehub.sol"; - +/// @title DummyBridgehub +/// @notice A test smart contract that allows to set State Transition Manager for a given chain contract DummyBridgehub { IMessageRoot public messageRoot; + address public zkChain; + // add this to be excluded from coverage report function test() internal virtual {} - constructor() {} - function baseTokenAssetId(uint256) external view returns (bytes32) { return keccak256( abi.encode( block.chainid, - L2_NATIVE_TOKEN_VAULT_ADDRESS, + L2_NATIVE_TOKEN_VAULT_ADDR, ETH_TOKEN_ADDRESS // bytes32(uint256(uint160(IGetters(msg.sender).getBaseToken()))) ) @@ -34,7 +34,11 @@ contract DummyBridgehub { messageRoot = IMessageRoot(_messageRoot); } - // function setStateTransitionManager(uint256 _chainId, address _stm) external { - // stateTransitionManager[_chainId] = _stm; - // } + function setZKChain(uint256, address _zkChain) external { + zkChain = _zkChain; + } + + function getZKChain(uint256) external view returns (address) { + return address(0); + } } diff --git a/l1-contracts/contracts/dev-contracts/test/DummyBridgehubSetter.sol b/l1-contracts/contracts/dev-contracts/test/DummyBridgehubSetter.sol new file mode 100644 index 000000000..8ae0404e7 --- /dev/null +++ b/l1-contracts/contracts/dev-contracts/test/DummyBridgehubSetter.sol @@ -0,0 +1,25 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {Bridgehub} from "../../bridgehub/Bridgehub.sol"; + +contract DummyBridgehubSetter is Bridgehub { + // add this to be excluded from coverage report + function test() internal virtual {} + + /// @notice Constructor + constructor( + uint256 _l1ChainId, + address _owner, + uint256 _maxNumberOfZKChains + ) Bridgehub(_l1ChainId, _owner, _maxNumberOfZKChains) {} + + function setZKChain(uint256 _chainId, address _zkChain) external { + _registerNewZKChain(_chainId, _zkChain); + } + + function setCTM(uint256 _chainId, address _ctm) external { + chainTypeManager[_chainId] = _ctm; + } +} diff --git a/l1-contracts/contracts/dev-contracts/test/DummyStateTransitionManager.sol b/l1-contracts/contracts/dev-contracts/test/DummyChainTypeManager.sol similarity index 57% rename from l1-contracts/contracts/dev-contracts/test/DummyStateTransitionManager.sol rename to l1-contracts/contracts/dev-contracts/test/DummyChainTypeManager.sol index fba37465e..20cc25328 100644 --- a/l1-contracts/contracts/dev-contracts/test/DummyStateTransitionManager.sol +++ b/l1-contracts/contracts/dev-contracts/test/DummyChainTypeManager.sol @@ -4,20 +4,22 @@ pragma solidity 0.8.24; import {EnumerableMap} from "@openzeppelin/contracts-v4/utils/structs/EnumerableMap.sol"; -import {StateTransitionManager} from "../../state-transition/StateTransitionManager.sol"; +import {ChainTypeManager} from "../../state-transition/ChainTypeManager.sol"; /// @title DummyExecutor /// @notice A test smart contract implementing the IExecutor interface to simulate Executor behavior for testing purposes. -contract DummyStateTransitionManager is StateTransitionManager { +contract DummyChainTypeManager is ChainTypeManager { using EnumerableMap for EnumerableMap.UintToAddressMap; // add this to be excluded from coverage report function test() internal virtual {} + address zkChain; + /// @notice Constructor - constructor() StateTransitionManager(address(0), type(uint256).max) {} + constructor() ChainTypeManager(address(0)) {} - function setHyperchain(uint256 _chainId, address _hyperchain) external { - hyperchainMap.set(_chainId, _hyperchain); + function setZKChain(uint256 _chainId, address _zkChain) external { + zkChain = _zkChain; } } diff --git a/l1-contracts/contracts/dev-contracts/test/DummyStateTransitionManagerForValidatorTimelock.sol b/l1-contracts/contracts/dev-contracts/test/DummyChainTypeManagerForValidatorTimelock.sol similarity index 51% rename from l1-contracts/contracts/dev-contracts/test/DummyStateTransitionManagerForValidatorTimelock.sol rename to l1-contracts/contracts/dev-contracts/test/DummyChainTypeManagerForValidatorTimelock.sol index f2944d3a8..8e876abb2 100644 --- a/l1-contracts/contracts/dev-contracts/test/DummyStateTransitionManagerForValidatorTimelock.sol +++ b/l1-contracts/contracts/dev-contracts/test/DummyChainTypeManagerForValidatorTimelock.sol @@ -2,25 +2,29 @@ pragma solidity 0.8.24; -/// @title DummyStateTransitionManagerForValidatorTimelock +/// @title DummyChainTypeManagerForValidatorTimelock /// @notice A test smart contract implementing the IExecutor interface to simulate Executor behavior for testing purposes. -contract DummyStateTransitionManagerForValidatorTimelock { +contract DummyChainTypeManagerForValidatorTimelock { // add this to be excluded from coverage report function test() internal virtual {} address public chainAdmin; - address public hyperchainAddress; + address public zkChainAddress; - constructor(address _chainAdmin, address _hyperchain) { + constructor(address _chainAdmin, address _zkChain) { chainAdmin = _chainAdmin; - hyperchainAddress = _hyperchain; + zkChainAddress = _zkChain; } function getChainAdmin(uint256) external view returns (address) { return chainAdmin; } - function getHyperchain(uint256) external view returns (address) { - return hyperchainAddress; + function getZKChain(uint256) external view returns (address) { + return zkChainAddress; + } + + function setZKChain(uint256, address _zkChain) external { + zkChainAddress = _zkChain; } } diff --git a/l1-contracts/contracts/dev-contracts/test/DummyStateTransitionManagerWithBridgeHubAddress.sol b/l1-contracts/contracts/dev-contracts/test/DummyChainTypeManagerWithBridgeHubAddress.sol similarity index 56% rename from l1-contracts/contracts/dev-contracts/test/DummyStateTransitionManagerWithBridgeHubAddress.sol rename to l1-contracts/contracts/dev-contracts/test/DummyChainTypeManagerWithBridgeHubAddress.sol index bb6282be1..9f6acd198 100644 --- a/l1-contracts/contracts/dev-contracts/test/DummyStateTransitionManagerWithBridgeHubAddress.sol +++ b/l1-contracts/contracts/dev-contracts/test/DummyChainTypeManagerWithBridgeHubAddress.sol @@ -4,18 +4,19 @@ pragma solidity 0.8.24; import {EnumerableMap} from "@openzeppelin/contracts-v4/utils/structs/EnumerableMap.sol"; -import {StateTransitionManager} from "../../state-transition/StateTransitionManager.sol"; +import {ChainTypeManager} from "../../state-transition/ChainTypeManager.sol"; /// @title DummyExecutor /// @notice A test smart contract implementing the IExecutor interface to simulate Executor behavior for testing purposes. -contract DummyStateTransitionManagerWBH is StateTransitionManager { +contract DummyChainTypeManagerWBH is ChainTypeManager { using EnumerableMap for EnumerableMap.UintToAddressMap; + address zkChain; /// @notice Constructor - constructor(address bridgeHub) StateTransitionManager(bridgeHub, type(uint256).max) {} + constructor(address bridgeHub) ChainTypeManager(bridgeHub) {} - function setHyperchain(uint256 _chainId, address _hyperchain) external { - hyperchainMap.set(_chainId, _hyperchain); + function setZKChain(uint256 _chainId, address _zkChain) external { + zkChain = _zkChain; } // add this to be excluded from coverage report diff --git a/l1-contracts/contracts/dev-contracts/test/DummyEraBaseTokenBridge.sol b/l1-contracts/contracts/dev-contracts/test/DummyEraBaseTokenBridge.sol index 96382c44f..bb450b261 100644 --- a/l1-contracts/contracts/dev-contracts/test/DummyEraBaseTokenBridge.sol +++ b/l1-contracts/contracts/dev-contracts/test/DummyEraBaseTokenBridge.sol @@ -8,7 +8,7 @@ contract DummyEraBaseTokenBridge { function bridgehubDepositBaseToken( uint256 _chainId, - address _prevMsgSender, + address _originalCaller, address _l1Token, uint256 _amount ) external payable {} diff --git a/l1-contracts/contracts/dev-contracts/test/DummyExecutor.sol b/l1-contracts/contracts/dev-contracts/test/DummyExecutor.sol deleted file mode 100644 index 1126dc89f..000000000 --- a/l1-contracts/contracts/dev-contracts/test/DummyExecutor.sol +++ /dev/null @@ -1,166 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {IExecutor} from "../../state-transition/chain-interfaces/IExecutor.sol"; -import {PriorityOpsBatchInfo} from "../../state-transition/libraries/PriorityTree.sol"; - -/// @title DummyExecutor -/// @notice A test smart contract implementing the IExecutor interface to simulate Executor behavior for testing purposes. -contract DummyExecutor is IExecutor { - // add this to be excluded from coverage report - function test() internal virtual {} - - address owner; - - // Flags to control if the contract should revert during commit, prove, and execute batch operations - bool shouldRevertOnCommitBatches; - bool shouldRevertOnProveBatches; - bool shouldRevertOnExecuteBatches; - - // Counters to track the total number of committed, verified, and executed batches - uint256 public getTotalBatchesCommitted; - uint256 public getTotalBatchesVerified; - uint256 public getTotalBatchesExecuted; - string public constant override getName = "DummyExecutor"; - - /// @notice Constructor sets the contract owner to the message sender - constructor() { - owner = msg.sender; - } - - /// @notice Modifier that only allows the owner to call certain functions - modifier onlyOwner() { - require(msg.sender == owner); - _; - } - - function getAdmin() external view returns (address) { - return owner; - } - - /// @notice Removing txs from the priority queue - function removePriorityQueueFront(uint256 _index) external {} - - /// @notice Allows the owner to set whether the contract should revert during commit blocks operation - function setShouldRevertOnCommitBatches(bool _shouldRevert) external onlyOwner { - shouldRevertOnCommitBatches = _shouldRevert; - } - - /// @notice Allows the owner to set whether the contract should revert during prove batches operation - function setShouldRevertOnProveBatches(bool _shouldRevert) external onlyOwner { - shouldRevertOnProveBatches = _shouldRevert; - } - - /// @notice Allows the owner to set whether the contract should revert during execute batches operation - function setShouldRevertOnExecuteBatches(bool _shouldRevert) external onlyOwner { - shouldRevertOnExecuteBatches = _shouldRevert; - } - - function commitBatches( - StoredBatchInfo calldata _lastCommittedBatchData, - CommitBatchInfo[] calldata _newBatchesData - ) public { - require(!shouldRevertOnCommitBatches, "DummyExecutor: shouldRevertOnCommitBatches"); - require( - _lastCommittedBatchData.batchNumber == getTotalBatchesCommitted, - "DummyExecutor: Invalid last committed batch number" - ); - - uint256 batchesLength = _newBatchesData.length; - for (uint256 i = 0; i < batchesLength; ++i) { - require(getTotalBatchesCommitted + i + 1 == _newBatchesData[i].batchNumber); - } - - getTotalBatchesCommitted += batchesLength; - } - - function commitBatchesSharedBridge( - uint256, - StoredBatchInfo calldata _lastCommittedBatchData, - CommitBatchInfo[] calldata _newBatchesData - ) external { - commitBatches(_lastCommittedBatchData, _newBatchesData); - } - - function proveBatches( - StoredBatchInfo calldata _prevBatch, - StoredBatchInfo[] calldata _committedBatches, - ProofInput calldata - ) public { - require(!shouldRevertOnProveBatches, "DummyExecutor: shouldRevertOnProveBatches"); - require(_prevBatch.batchNumber == getTotalBatchesVerified, "DummyExecutor: Invalid previous batch number"); - - require(_committedBatches.length == 1, "DummyExecutor: Can prove only one batch"); - require( - _committedBatches[0].batchNumber == _prevBatch.batchNumber + 1, - "DummyExecutor 1: Can't prove batch out of order" - ); - - getTotalBatchesVerified += 1; - require( - getTotalBatchesVerified <= getTotalBatchesCommitted, - "DummyExecutor: prove more batches than were committed" - ); - } - - function proveBatchesSharedBridge( - uint256, - StoredBatchInfo calldata _prevBatch, - StoredBatchInfo[] calldata _committedBatches, - ProofInput calldata _proof - ) external { - proveBatches(_prevBatch, _committedBatches, _proof); - } - - function executeBatches(StoredBatchInfo[] calldata _batchesData) public { - require(!shouldRevertOnExecuteBatches, "DummyExecutor: shouldRevertOnExecuteBatches"); - uint256 nBatches = _batchesData.length; - for (uint256 i = 0; i < nBatches; ++i) { - require(_batchesData[i].batchNumber == getTotalBatchesExecuted + i + 1); - } - getTotalBatchesExecuted += nBatches; - require( - getTotalBatchesExecuted <= getTotalBatchesVerified, - "DummyExecutor 2: Can't execute batches more than committed and proven currently" - ); - } - - function executeBatches(StoredBatchInfo[] calldata _batchesData, PriorityOpsBatchInfo[] calldata) external { - executeBatches(_batchesData); - } - - function executeBatchesSharedBridge(uint256, StoredBatchInfo[] calldata _batchesData) external { - executeBatches(_batchesData); - } - - function executeBatchesSharedBridge( - uint256, - StoredBatchInfo[] calldata _batchesData, - PriorityOpsBatchInfo[] calldata - ) external { - executeBatches(_batchesData); - } - - function revertBatches(uint256 _newLastBatch) public { - require( - getTotalBatchesCommitted > _newLastBatch, - "DummyExecutor: The last committed batch is less than new last batch" - ); - uint256 newTotalBatchesCommitted = _maxU256(_newLastBatch, getTotalBatchesExecuted); - - if (newTotalBatchesCommitted < getTotalBatchesVerified) { - getTotalBatchesVerified = newTotalBatchesCommitted; - } - getTotalBatchesCommitted = newTotalBatchesCommitted; - } - - function revertBatchesSharedBridge(uint256, uint256 _newLastBatch) external { - revertBatches(_newLastBatch); - } - - /// @notice Returns larger of two values - function _maxU256(uint256 a, uint256 b) internal pure returns (uint256) { - return a < b ? b : a; - } -} diff --git a/l1-contracts/contracts/dev-contracts/test/DummySharedBridge.sol b/l1-contracts/contracts/dev-contracts/test/DummySharedBridge.sol index f0151b6df..c75ec4530 100644 --- a/l1-contracts/contracts/dev-contracts/test/DummySharedBridge.sol +++ b/l1-contracts/contracts/dev-contracts/test/DummySharedBridge.sol @@ -5,12 +5,14 @@ pragma solidity 0.8.24; import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; import {L2TransactionRequestTwoBridgesInner} from "../../bridgehub/IBridgehub.sol"; -import {TWO_BRIDGES_MAGIC_VALUE, ETH_TOKEN_ADDRESS} from "../../common/Config.sol"; -import {IL1NativeTokenVault} from "../../bridge/L1NativeTokenVault.sol"; import {PausableUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/security/PausableUpgradeable.sol"; -import {L2_NATIVE_TOKEN_VAULT_ADDRESS} from "../../common/L2ContractAddresses.sol"; +import {TWO_BRIDGES_MAGIC_VALUE, ETH_TOKEN_ADDRESS} from "../../common/Config.sol"; +import {IL1NativeTokenVault} from "../../bridge/ntv/L1NativeTokenVault.sol"; +import {L2_NATIVE_TOKEN_VAULT_ADDR} from "../../common/L2ContractAddresses.sol"; import {SafeERC20} from "@openzeppelin/contracts-v4/token/ERC20/utils/SafeERC20.sol"; import {IL2Bridge} from "../../bridge/interfaces/IL2Bridge.sol"; +import {IL2SharedBridgeLegacy} from "../../bridge/interfaces/IL2SharedBridgeLegacy.sol"; +import {IL2SharedBridgeLegacyFunctions} from "../../bridge/interfaces/IL2SharedBridgeLegacyFunctions.sol"; contract DummySharedBridge is PausableUpgradeable { using SafeERC20 for IERC20; @@ -20,18 +22,17 @@ contract DummySharedBridge is PausableUpgradeable { event BridgehubDepositBaseTokenInitiated( uint256 indexed chainId, address indexed from, - address l1Token, + bytes32 assetId, uint256 amount ); bytes32 dummyL2DepositTxHash; - /// @dev Maps token balances for each chain to prevent unauthorized spending across hyperchains. + /// @dev Maps token balances for each chain to prevent unauthorized spending across zkChains. /// This serves as a security measure until hyperbridging is implemented. mapping(uint256 chainId => mapping(address l1Token => uint256 balance)) public chainBalance; /// @dev Indicates whether the hyperbridging is enabled for a given chain. - mapping(uint256 chainId => bool enabled) internal hyperbridgingEnabled; address l1ReceiverReturnInFinalizeWithdrawal; address l1TokenReturnInFinalizeWithdrawal; @@ -126,8 +127,8 @@ contract DummySharedBridge is PausableUpgradeable { uint16 _l2TxNumberInBatch, bytes calldata _message, bytes32[] calldata _merkleProof - ) external { - (address l1Receiver, address l1Token, uint256 amount) = _parseL2WithdrawalMessage(_message); + ) external returns (address l1Receiver, address l1Token, uint256 amount) { + (l1Receiver, l1Token, amount) = _parseL2WithdrawalMessage(_message); if (l1Token == address(1)) { bool callSuccess; @@ -144,26 +145,17 @@ contract DummySharedBridge is PausableUpgradeable { function bridgehubDepositBaseToken( uint256 _chainId, - address _prevMsgSender, - address _l1Token, + bytes32 _assetId, + address _originalCaller, uint256 _amount ) external payable whenNotPaused { - if (_l1Token == address(1)) { - require(msg.value == _amount, "L1AR: msg.value not equal to amount"); - } else { - // The Bridgehub also checks this, but we want to be sure - require(msg.value == 0, "L1AR: m.v > 0 b d.it"); - uint256 amount = _depositFunds(_prevMsgSender, IERC20(_l1Token), _amount); // note if _prevMsgSender is this contract, this will return 0. This does not happen. - require(amount == _amount, "5T"); // The token has non-standard transfer logic - } + // Dummy bridge supports only working with ETH for simplicity. + require(msg.value == _amount, "L1AR: msg.value not equal to amount"); - if (!hyperbridgingEnabled[_chainId]) { - chainBalance[_chainId][_l1Token] += _amount; - } + chainBalance[_chainId][address(1)] += _amount; - emit Debugger(5); // Note that we don't save the deposited amount, as this is for the base token, which gets sent to the refundRecipient if the tx fails - emit BridgehubDepositBaseTokenInitiated(_chainId, _prevMsgSender, _l1Token, _amount); + emit BridgehubDepositBaseTokenInitiated(_chainId, _originalCaller, _assetId, _amount); } function _depositFunds(address _from, IERC20 _token, uint256 _amount) internal returns (uint256) { @@ -176,7 +168,7 @@ contract DummySharedBridge is PausableUpgradeable { function bridgehubDeposit( uint256, - address _prevMsgSender, + address _originalCaller, uint256, bytes calldata _data ) external payable returns (L2TransactionRequestTwoBridgesInner memory request) { @@ -193,17 +185,15 @@ contract DummySharedBridge is PausableUpgradeable { require(msg.value == 0, "ShB m.v > 0 for BH d.it 2"); amount = _depositAmount; - uint256 withdrawAmount = _depositFunds(_prevMsgSender, IERC20(_l1Token), _depositAmount); + uint256 withdrawAmount = _depositFunds(_originalCaller, IERC20(_l1Token), _depositAmount); require(withdrawAmount == _depositAmount, "5T"); // The token has non-standard transfer logic } - // TODO: restore - bytes memory l2TxCalldata = hex""; - // abi.encodeCall( - // IL2Bridge.finalizeDeposit, - // (_prevMsgSender, _l2Receiver, _l1Token, amount, new bytes(0)) - // ); - bytes32 txDataHash = keccak256(abi.encode(_prevMsgSender, _l1Token, amount)); + bytes memory l2TxCalldata = abi.encodeCall( + IL2SharedBridgeLegacyFunctions.finalizeDeposit, + (_originalCaller, _l2Receiver, _l1Token, amount, new bytes(0)) + ); + bytes32 txDataHash = keccak256(abi.encode(_originalCaller, _l1Token, amount)); request = L2TransactionRequestTwoBridgesInner({ magicValue: TWO_BRIDGES_MAGIC_VALUE, @@ -224,8 +214,8 @@ contract DummySharedBridge is PausableUpgradeable { } /// @dev Used to set the assedAddress for a given assetId. - function setAssetHandlerAddressInitial(bytes32 _additionalData, address _assetHandlerAddress) external { - address sender = msg.sender == address(nativeTokenVault) ? L2_NATIVE_TOKEN_VAULT_ADDRESS : msg.sender; + function setAssetHandlerAddressThisChain(bytes32 _additionalData, address _assetHandlerAddress) external { + address sender = msg.sender == address(nativeTokenVault) ? L2_NATIVE_TOKEN_VAULT_ADDR : msg.sender; bytes32 assetId = keccak256(abi.encode(uint256(block.chainid), sender, _additionalData)); assetHandlerAddress[assetId] = _assetHandlerAddress; // assetDeploymentTracker[assetId] = sender; diff --git a/l1-contracts/contracts/dev-contracts/test/DummyHyperchain.sol b/l1-contracts/contracts/dev-contracts/test/DummyZKChain.sol similarity index 87% rename from l1-contracts/contracts/dev-contracts/test/DummyHyperchain.sol rename to l1-contracts/contracts/dev-contracts/test/DummyZKChain.sol index f1114d92d..9a535affe 100644 --- a/l1-contracts/contracts/dev-contracts/test/DummyHyperchain.sol +++ b/l1-contracts/contracts/dev-contracts/test/DummyZKChain.sol @@ -2,10 +2,14 @@ pragma solidity 0.8.24; import {MailboxFacet} from "../../state-transition/chain-deps/facets/Mailbox.sol"; -import {FeeParams, PubdataPricingMode} from "../../state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; - -contract DummyHyperchain is MailboxFacet { - constructor(address bridgeHubAddress, uint256 _eraChainId) MailboxFacet(_eraChainId) { +import {FeeParams, PubdataPricingMode} from "../../state-transition/chain-deps/ZKChainStorage.sol"; + +contract DummyZKChain is MailboxFacet { + constructor( + address bridgeHubAddress, + uint256 _eraChainId, + uint256 _l1ChainId + ) MailboxFacet(_eraChainId, _l1ChainId) { s.bridgehub = bridgeHubAddress; } diff --git a/l1-contracts/contracts/dev-contracts/test/ExecutorProvingTest.sol b/l1-contracts/contracts/dev-contracts/test/ExecutorProvingTest.sol index 113d406ac..5794dfbe6 100644 --- a/l1-contracts/contracts/dev-contracts/test/ExecutorProvingTest.sol +++ b/l1-contracts/contracts/dev-contracts/test/ExecutorProvingTest.sol @@ -3,7 +3,7 @@ pragma solidity 0.8.24; import {ExecutorFacet} from "../../state-transition/chain-deps/facets/Executor.sol"; -import {PubdataPricingMode} from "../../state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; +import {PubdataPricingMode} from "../../state-transition/chain-deps/ZKChainStorage.sol"; import {LogProcessingOutput} from "../../state-transition/chain-interfaces/IExecutor.sol"; import {LogProcessingOutput} from "../../state-transition/chain-interfaces/IExecutor.sol"; diff --git a/l1-contracts/contracts/dev-contracts/test/L1ERC20BridgeTest.sol b/l1-contracts/contracts/dev-contracts/test/L1ERC20BridgeTest.sol index ea65333c5..2f8eda079 100644 --- a/l1-contracts/contracts/dev-contracts/test/L1ERC20BridgeTest.sol +++ b/l1-contracts/contracts/dev-contracts/test/L1ERC20BridgeTest.sol @@ -3,13 +3,17 @@ pragma solidity 0.8.24; import {L1ERC20Bridge} from "../../bridge/L1ERC20Bridge.sol"; -import {IL1NativeTokenVault} from "../../bridge/interfaces/IL1NativeTokenVault.sol"; -import {IBridgehub, IL1AssetRouter} from "../../bridge/interfaces/IL1AssetRouter.sol"; +import {IL1NativeTokenVault} from "../../bridge/ntv/IL1NativeTokenVault.sol"; +import {IBridgehub} from "../../bridgehub/IBridgehub.sol"; +import {IL1AssetRouter} from "../../bridge/asset-router/IL1AssetRouter.sol"; +import {IL1Nullifier} from "../../bridge/interfaces/IL1Nullifier.sol"; /// @author Matter Labs contract L1ERC20BridgeTest is L1ERC20Bridge { // add this to be excluded from coverage report function test() internal virtual {} - constructor(IBridgehub _zkSync) L1ERC20Bridge(IL1AssetRouter(address(0)), IL1NativeTokenVault(address(0)), 1) {} + constructor( + IBridgehub _zkSync + ) L1ERC20Bridge(IL1Nullifier(address(0)), IL1AssetRouter(address(0)), IL1NativeTokenVault(address(0)), 1) {} } diff --git a/l1-contracts/contracts/dev-contracts/test/MailboxFacetTest.sol b/l1-contracts/contracts/dev-contracts/test/MailboxFacetTest.sol index d5a415510..5b132f64c 100644 --- a/l1-contracts/contracts/dev-contracts/test/MailboxFacetTest.sol +++ b/l1-contracts/contracts/dev-contracts/test/MailboxFacetTest.sol @@ -2,7 +2,7 @@ pragma solidity 0.8.24; -import {FeeParams} from "../../state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; +import {FeeParams} from "../../state-transition/chain-deps/ZKChainStorage.sol"; import {MailboxFacet} from "../../state-transition/chain-deps/facets/Mailbox.sol"; import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA} from "../../common/Config.sol"; @@ -10,7 +10,7 @@ contract MailboxFacetTest is MailboxFacet { // add this to be excluded from coverage report function test() internal virtual {} - constructor(uint256 _eraChainId) MailboxFacet(_eraChainId) { + constructor(uint256 _eraChainId, uint256 _l1ChainId) MailboxFacet(_eraChainId, _l1ChainId) { s.admin = msg.sender; } diff --git a/l1-contracts/contracts/dev-contracts/test/MockExecutor.sol b/l1-contracts/contracts/dev-contracts/test/MockExecutor.sol index c69c54d03..954c32ca2 100644 --- a/l1-contracts/contracts/dev-contracts/test/MockExecutor.sol +++ b/l1-contracts/contracts/dev-contracts/test/MockExecutor.sol @@ -2,9 +2,9 @@ pragma solidity 0.8.24; -import {ZkSyncHyperchainBase} from "../../state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol"; +import {ZKChainBase} from "../../state-transition/chain-deps/facets/ZKChainBase.sol"; -contract MockExecutorFacet is ZkSyncHyperchainBase { +contract MockExecutorFacet is ZKChainBase { // add this to be excluded from coverage report function test() internal virtual {} diff --git a/l1-contracts/contracts/dev-contracts/test/ReenterGovernance.sol b/l1-contracts/contracts/dev-contracts/test/ReenterGovernance.sol index 0d619c5ba..193f8085f 100644 --- a/l1-contracts/contracts/dev-contracts/test/ReenterGovernance.sol +++ b/l1-contracts/contracts/dev-contracts/test/ReenterGovernance.sol @@ -3,6 +3,7 @@ pragma solidity 0.8.24; import {IGovernance} from "../../governance/IGovernance.sol"; +import {Call} from "../../governance/Common.sol"; contract ReenterGovernance { // add this to be excluded from coverage report @@ -12,7 +13,7 @@ contract ReenterGovernance { // Store call, predecessor and salt separately, // because Operation struct can't be stored on storage. - IGovernance.Call call; + Call call; bytes32 predecessor; bytes32 salt; @@ -45,7 +46,7 @@ contract ReenterGovernance { fallback() external payable { if (!alreadyReentered) { alreadyReentered = true; - IGovernance.Call[] memory calls = new IGovernance.Call[](1); + Call[] memory calls = new Call[](1); calls[0] = call; IGovernance.Operation memory op = IGovernance.Operation({ calls: calls, diff --git a/l1-contracts/contracts/governance/AccessControlRestriction.sol b/l1-contracts/contracts/governance/AccessControlRestriction.sol new file mode 100644 index 000000000..3fc67f875 --- /dev/null +++ b/l1-contracts/contracts/governance/AccessControlRestriction.sol @@ -0,0 +1,72 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {AccessToFallbackDenied, AccessToFunctionDenied} from "../common/L1ContractErrors.sol"; +import {IAccessControlRestriction} from "./IAccessControlRestriction.sol"; +import {AccessControlDefaultAdminRules} from "@openzeppelin/contracts-v4/access/AccessControlDefaultAdminRules.sol"; +import {IRestriction} from "./IRestriction.sol"; +import {Call} from "./Common.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice The Restriction that is designed to provide the access control logic for the `ChainAdmin` contract. +/// @dev It inherits from `AccessControlDefaultAdminRules` without overriding `_setRoleAdmin` functionaity. In other +/// words, the `DEFAULT_ADMIN_ROLE` is the only role that can manage roles. This is done for simplicity. +/// @dev An instance of this restriction should be deployed separately for each `ChainAdmin` contract. +/// @dev IMPORTANT: this function does not validate the ability of the invoker to use `msg.value`. Thus, +/// either all callers with access to functions should be trusted to not steal ETH from the `ChainAdmin` account +/// or not ETH should be passively stored in `ChainAdmin` account. +contract AccessControlRestriction is IRestriction, IAccessControlRestriction, AccessControlDefaultAdminRules { + /// @notice Required roles to call a specific functions. + /// @dev Note, that the role 0 means the `DEFAULT_ADMIN_ROLE` from the `AccessControlDefaultAdminRules` contract. + mapping(address target => mapping(bytes4 selector => bytes32 requiredRole)) public requiredRoles; + + /// @notice Required roles to call a fallback function. + mapping(address target => bytes32 requiredRole) public requiredRolesForFallback; + + constructor( + uint48 initialDelay, + address initialDefaultAdmin + ) AccessControlDefaultAdminRules(initialDelay, initialDefaultAdmin) {} + + /// @notice Sets the required role for a specific function call. + /// @param _target The address of the contract. + /// @param _selector The selector of the function. + /// @param _requiredRole The required role. + function setRequiredRoleForCall( + address _target, + bytes4 _selector, + bytes32 _requiredRole + ) external onlyRole(DEFAULT_ADMIN_ROLE) { + requiredRoles[_target][_selector] = _requiredRole; + + emit RoleSet(_target, _selector, _requiredRole); + } + + /// @notice Sets the required role for a fallback function call. + /// @param _target The address of the contract. + /// @param _requiredRole The required role. + function setRequiredRoleForFallback(address _target, bytes32 _requiredRole) external onlyRole(DEFAULT_ADMIN_ROLE) { + requiredRolesForFallback[_target] = _requiredRole; + + emit FallbackRoleSet(_target, _requiredRole); + } + + /// @inheritdoc IRestriction + function validateCall(Call calldata _call, address _invoker) external view { + // Note, that since `DEFAULT_ADMIN_ROLE` is 0 and the default storage value for the + // `requiredRoles` and `requiredRolesForFallback` is 0, the default admin is by default a required + // role for all the functions. + if (_call.data.length < 4) { + if (!hasRole(requiredRolesForFallback[_call.target], _invoker)) { + revert AccessToFallbackDenied(_call.target, _invoker); + } + } else { + bytes4 selector = bytes4(_call.data[:4]); + if (!hasRole(requiredRoles[_call.target][selector], _invoker)) { + revert AccessToFunctionDenied(_call.target, selector, _invoker); + } + } + } +} diff --git a/l1-contracts/contracts/governance/ChainAdmin.sol b/l1-contracts/contracts/governance/ChainAdmin.sol index 4d9ff858f..f6a93146f 100644 --- a/l1-contracts/contracts/governance/ChainAdmin.sol +++ b/l1-contracts/contracts/governance/ChainAdmin.sol @@ -2,48 +2,76 @@ pragma solidity 0.8.24; -import {Ownable2Step} from "@openzeppelin/contracts-v4/access/Ownable2Step.sol"; +// solhint-disable gas-length-in-loops + +import {NoCallsProvided, OnlySelfAllowed, RestrictionWasNotPresent, RestrictionWasAlreadyPresent} from "../common/L1ContractErrors.sol"; import {IChainAdmin} from "./IChainAdmin.sol"; -import {IAdmin} from "../state-transition/chain-interfaces/IAdmin.sol"; -import {NoCallsProvided, Unauthorized, ZeroAddress} from "../common/L1ContractErrors.sol"; +import {IRestriction} from "./IRestriction.sol"; +import {Call} from "./Common.sol"; + +import {EnumerableSet} from "@openzeppelin/contracts-v4/utils/structs/EnumerableSet.sol"; +import {ReentrancyGuard} from "../common/ReentrancyGuard.sol"; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev /// @notice The contract is designed to hold the `admin` role in ZKSync Chain (State Transition) contracts. /// The owner of the contract can perform any external calls and also save the information needed for -/// the blockchain node to accept the protocol upgrade. Another role - `tokenMultiplierSetter` can be used in the contract -/// to change the base token gas price in the Chain contract. -contract ChainAdmin is IChainAdmin, Ownable2Step { +/// the blockchain node to accept the protocol upgrade. +contract ChainAdmin is IChainAdmin, ReentrancyGuard { + using EnumerableSet for EnumerableSet.AddressSet; + + /// @notice Ensures that only the `ChainAdmin` contract itself can call the function. + /// @dev All functions that require access-control should use `onlySelf` modifier, while the access control logic + /// should be implemented in the restriction contracts. + modifier onlySelf() { + if (msg.sender != address(this)) { + revert OnlySelfAllowed(); + } + _; + } + + constructor(address[] memory _initialRestrictions) reentrancyGuardInitializer { + unchecked { + for (uint256 i = 0; i < _initialRestrictions.length; ++i) { + _addRestriction(_initialRestrictions[i]); + } + } + } + /// @notice Mapping of protocol versions to their expected upgrade timestamps. /// @dev Needed for the offchain node administration to know when to start building batches with the new protocol version. mapping(uint256 protocolVersion => uint256 upgradeTimestamp) public protocolVersionToUpgradeTimestamp; - /// @notice The address which can call `setTokenMultiplier` function to change the base token gas price in the Chain contract. - /// @dev The token base price can be changed quite often, so the private key for this role is supposed to be stored in the node - /// and used by the automated service in a way similar to the sequencer workflow. - address public tokenMultiplierSetter; + /// @notice The set of active restrictions. + EnumerableSet.AddressSet internal activeRestrictions; - constructor(address _initialOwner, address _initialTokenMultiplierSetter) { - if (_initialOwner == address(0)) { - revert ZeroAddress(); - } - _transferOwnership(_initialOwner); - // Can be zero if no one has this permission. - tokenMultiplierSetter = _initialTokenMultiplierSetter; - emit NewTokenMultiplierSetter(address(0), _initialTokenMultiplierSetter); + /// @notice Returns the list of active restrictions. + function getRestrictions() public view returns (address[] memory) { + return activeRestrictions.values(); + } + + /// @inheritdoc IChainAdmin + function isRestrictionActive(address _restriction) external view returns (bool) { + return activeRestrictions.contains(_restriction); } - /// @notice Updates the address responsible for setting token multipliers on the Chain contract . - /// @param _tokenMultiplierSetter The new address to be set as the token multiplier setter. - function setTokenMultiplierSetter(address _tokenMultiplierSetter) external onlyOwner { - emit NewTokenMultiplierSetter(tokenMultiplierSetter, _tokenMultiplierSetter); - tokenMultiplierSetter = _tokenMultiplierSetter; + /// @inheritdoc IChainAdmin + function addRestriction(address _restriction) external onlySelf { + _addRestriction(_restriction); + } + + /// @inheritdoc IChainAdmin + function removeRestriction(address _restriction) external onlySelf { + if (!activeRestrictions.remove(_restriction)) { + revert RestrictionWasNotPresent(_restriction); + } + emit RestrictionRemoved(_restriction); } /// @notice Set the expected upgrade timestamp for a specific protocol version. /// @param _protocolVersion The ZKsync chain protocol version. /// @param _upgradeTimestamp The timestamp at which the chain node should expect the upgrade to happen. - function setUpgradeTimestamp(uint256 _protocolVersion, uint256 _upgradeTimestamp) external onlyOwner { + function setUpgradeTimestamp(uint256 _protocolVersion, uint256 _upgradeTimestamp) external onlySelf { protocolVersionToUpgradeTimestamp[_protocolVersion] = _upgradeTimestamp; emit UpdateUpgradeTimestamp(_protocolVersion, _upgradeTimestamp); } @@ -52,12 +80,16 @@ contract ChainAdmin is IChainAdmin, Ownable2Step { /// @param _calls Array of Call structures defining target, value, and data for each call. /// @param _requireSuccess If true, reverts transaction on any call failure. /// @dev Intended for batch processing of contract interactions, managing gas efficiency and atomicity of operations. - function multicall(Call[] calldata _calls, bool _requireSuccess) external payable onlyOwner { + /// @dev Note, that this function lacks access control. It is expected that the access control is implemented in a separate restriction contract. + /// @dev Even though all the validation from external modules is executed via `staticcall`, the function + /// is marked as `nonReentrant` to prevent reentrancy attacks in case the staticcall restriction is lifted in the future. + function multicall(Call[] calldata _calls, bool _requireSuccess) external payable nonReentrant { if (_calls.length == 0) { revert NoCallsProvided(); } - // solhint-disable-next-line gas-length-in-loops for (uint256 i = 0; i < _calls.length; ++i) { + _validateCall(_calls[i]); + // slither-disable-next-line arbitrary-send-eth (bool success, bytes memory returnData) = _calls[i].target.call{value: _calls[i].value}(_calls[i].data); if (_requireSuccess && !success) { @@ -70,17 +102,27 @@ contract ChainAdmin is IChainAdmin, Ownable2Step { } } - /// @notice Sets the token multiplier in the specified Chain contract. - /// @param _chainContract The chain contract address where the token multiplier will be set. - /// @param _nominator The numerator part of the token multiplier. - /// @param _denominator The denominator part of the token multiplier. - function setTokenMultiplier(IAdmin _chainContract, uint128 _nominator, uint128 _denominator) external { - if (msg.sender != tokenMultiplierSetter) { - revert Unauthorized(msg.sender); + /// @dev Contract might receive/hold ETH as part of the maintenance process. + receive() external payable {} + + /// @notice Function that returns the current admin can perform the call. + /// @dev By default it always returns true, but can be overridden in derived contracts. + function _validateCall(Call calldata _call) internal view { + address[] memory restrictions = getRestrictions(); + + unchecked { + for (uint256 i = 0; i < restrictions.length; ++i) { + IRestriction(restrictions[i]).validateCall(_call, msg.sender); + } } - _chainContract.setTokenMultiplier(_nominator, _denominator); } - /// @dev Contract might receive/hold ETH as part of the maintenance process. - receive() external payable {} + /// @notice Adds a new restriction to the active restrictions set. + /// @param _restriction The address of the restriction contract to be added. + function _addRestriction(address _restriction) internal { + if (!activeRestrictions.add(_restriction)) { + revert RestrictionWasAlreadyPresent(_restriction); + } + emit RestrictionAdded(_restriction); + } } diff --git a/l1-contracts/contracts/governance/Common.sol b/l1-contracts/contracts/governance/Common.sol new file mode 100644 index 000000000..fd73dd793 --- /dev/null +++ b/l1-contracts/contracts/governance/Common.sol @@ -0,0 +1,13 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +/// @dev Represents a call to be made during multicall. +/// @param target The address to which the call will be made. +/// @param value The amount of Ether (in wei) to be sent along with the call. +/// @param data The calldata to be executed on the `target` address. +struct Call { + address target; + uint256 value; + bytes data; +} diff --git a/l1-contracts/contracts/governance/Governance.sol b/l1-contracts/contracts/governance/Governance.sol index 790b79a26..7b2182e1c 100644 --- a/l1-contracts/contracts/governance/Governance.sol +++ b/l1-contracts/contracts/governance/Governance.sol @@ -4,6 +4,7 @@ pragma solidity 0.8.24; import {Ownable2Step} from "@openzeppelin/contracts-v4/access/Ownable2Step.sol"; import {IGovernance} from "./IGovernance.sol"; +import {Call} from "./Common.sol"; import {ZeroAddress, Unauthorized, OperationMustBeReady, OperationMustBePending, OperationExists, InvalidDelay, PreviousOperationNotExecuted} from "../common/L1ContractErrors.sol"; /// @author Matter Labs @@ -12,7 +13,7 @@ import {ZeroAddress, Unauthorized, OperationMustBeReady, OperationMustBePending, /// @notice This contract manages operations (calls with preconditions) for governance tasks. /// The contract allows for operations to be scheduled, executed, and canceled with /// appropriate permissions and delays. It is used for managing and coordinating upgrades -/// and changes in all ZKsync hyperchain governed contracts. +/// and changes in all ZK chain governed contracts. /// /// Operations can be proposed as either fully transparent upgrades with on-chain data, /// or "shadow" upgrades where upgrade data is not published on-chain before execution. Proposed operations diff --git a/l1-contracts/contracts/governance/IAccessControlRestriction.sol b/l1-contracts/contracts/governance/IAccessControlRestriction.sol new file mode 100644 index 000000000..3c9cfb5c5 --- /dev/null +++ b/l1-contracts/contracts/governance/IAccessControlRestriction.sol @@ -0,0 +1,14 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +/// @title AccessControlRestriction contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IAccessControlRestriction { + /// @notice Emitted when the required role for a specific function is set. + event RoleSet(address indexed target, bytes4 indexed selector, bytes32 requiredRole); + + /// @notice Emitted when the required role for a fallback function is set. + event FallbackRoleSet(address indexed target, bytes32 requiredRole); +} diff --git a/l1-contracts/contracts/governance/IChainAdmin.sol b/l1-contracts/contracts/governance/IChainAdmin.sol index d5d8f117c..1ef3144c2 100644 --- a/l1-contracts/contracts/governance/IChainAdmin.sol +++ b/l1-contracts/contracts/governance/IChainAdmin.sol @@ -2,36 +2,37 @@ pragma solidity 0.8.24; -import {IAdmin} from "../state-transition/chain-interfaces/IAdmin.sol"; +import {Call} from "./Common.sol"; /// @title ChainAdmin contract interface /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev interface IChainAdmin { - /// @dev Represents a call to be made during multicall. - /// @param target The address to which the call will be made. - /// @param value The amount of Ether (in wei) to be sent along with the call. - /// @param data The calldata to be executed on the `target` address. - struct Call { - address target; - uint256 value; - bytes data; - } - /// @notice Emitted when the expected upgrade timestamp for a specific protocol version is set. - event UpdateUpgradeTimestamp(uint256 indexed _protocolVersion, uint256 _upgradeTimestamp); + event UpdateUpgradeTimestamp(uint256 indexed protocolVersion, uint256 upgradeTimestamp); /// @notice Emitted when the call is executed from the contract. - event CallExecuted(Call _call, bool _success, bytes _returnData); + event CallExecuted(Call call, bool success, bytes returnData); + + /// @notice Emitted when a new restriction is added. + event RestrictionAdded(address indexed restriction); - /// @notice Emitted when the new token multiplier address is set. - event NewTokenMultiplierSetter(address _oldTokenMultiplierSetter, address _newTokenMultiplierSetter); + /// @notice Emitted when a restriction is removed. + event RestrictionRemoved(address indexed restriction); - function setTokenMultiplierSetter(address _tokenMultiplierSetter) external; + /// @notice Returns the list of active restrictions. + function getRestrictions() external view returns (address[] memory); - function setUpgradeTimestamp(uint256 _protocolVersion, uint256 _upgradeTimestamp) external; + /// @notice Checks if the restriction is active. + /// @param _restriction The address of the restriction contract. + function isRestrictionActive(address _restriction) external view returns (bool); - function multicall(Call[] calldata _calls, bool _requireSuccess) external payable; + /// @notice Adds a new restriction to the active restrictions set. + /// @param _restriction The address of the restriction contract. + function addRestriction(address _restriction) external; - function setTokenMultiplier(IAdmin _chainContract, uint128 _nominator, uint128 _denominator) external; + /// @notice Removes a restriction from the active restrictions set. + /// @param _restriction The address of the restriction contract. + /// @dev Sometimes restrictions might need to enforce their permanence (e.g. if a chain should be a rollup forever). + function removeRestriction(address _restriction) external; } diff --git a/l1-contracts/contracts/governance/IGovernance.sol b/l1-contracts/contracts/governance/IGovernance.sol index 2b03ed4c9..0cb478573 100644 --- a/l1-contracts/contracts/governance/IGovernance.sol +++ b/l1-contracts/contracts/governance/IGovernance.sol @@ -2,6 +2,8 @@ // We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.21; +import {Call} from "./Common.sol"; + /// @title Governance contract interface /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev @@ -18,16 +20,6 @@ interface IGovernance { Done } - /// @dev Represents a call to be made during an operation. - /// @param target The address to which the call will be made. - /// @param value The amount of Ether (in wei) to be sent along with the call. - /// @param data The calldata to be executed on the `target` address. - struct Call { - address target; - uint256 value; - bytes data; - } - /// @dev Defines the structure of an operation that Governance executes. /// @param calls An array of `Call` structs, each representing a call to be made during the operation. /// @param predecessor The hash of the predecessor operation, that should be executed before this operation. diff --git a/l1-contracts/contracts/governance/IPermanentRestriction.sol b/l1-contracts/contracts/governance/IPermanentRestriction.sol new file mode 100644 index 000000000..5fb015e33 --- /dev/null +++ b/l1-contracts/contracts/governance/IPermanentRestriction.sol @@ -0,0 +1,20 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +/// @notice The interface for the permanent restriction contract. +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IPermanentRestriction { + /// @notice Emitted when the implementation is allowed or disallowed. + event AdminImplementationAllowed(bytes32 indexed implementationHash, bool isAllowed); + + /// @notice Emitted when a certain calldata is allowed or disallowed. + event AllowedDataChanged(bytes data, bool isAllowed); + + /// @notice Emitted when the selector is labeled as validated or not. + event SelectorValidationChanged(bytes4 indexed selector, bool isValidated); + + /// @notice Emitted when the L2 admin is whitelisted or not. + event AllowL2Admin(address indexed adminAddress); +} diff --git a/l1-contracts/contracts/governance/IRestriction.sol b/l1-contracts/contracts/governance/IRestriction.sol new file mode 100644 index 000000000..b2cc79428 --- /dev/null +++ b/l1-contracts/contracts/governance/IRestriction.sol @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {Call} from "./Common.sol"; + +/// @title Restriction contract interface +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IRestriction { + /// @notice Ensures that the invoker has the required role to call the function. + /// @param _call The call data. + /// @param _invoker The address of the invoker. + function validateCall(Call calldata _call, address _invoker) external view; +} diff --git a/l1-contracts/contracts/governance/L2AdminFactory.sol b/l1-contracts/contracts/governance/L2AdminFactory.sol new file mode 100644 index 000000000..d4fe4637c --- /dev/null +++ b/l1-contracts/contracts/governance/L2AdminFactory.sol @@ -0,0 +1,42 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {ChainAdmin} from "./ChainAdmin.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @dev Contract used to deploy ChainAdmin contracts on L2. +/// @dev It can be used to ensure that certain L2 admins are deployed with +/// predefined restrictions. E.g. it can be used to deploy admins that ensure that +/// a chain is a permanent rollup. +/// @dev This contract is expected to be deployed in zkEVM (L2) environment. +/// @dev The contract is immutable, in case the restrictions need to be changed, +/// a new contract should be deployed. +contract L2AdminFactory { + event AdminDeployed(address admin); + + /// @dev We use storage instead of immutable variables due to the + /// specifics of the zkEVM environment, where storage is actually cheaper. + address[] public requiredRestrictions; + + constructor(address[] memory _requiredRestrictions) { + requiredRestrictions = _requiredRestrictions; + } + + /// @notice Deploys a new L2 admin contract. + /// @return admin The address of the deployed admin contract. + function deployAdmin(address[] calldata _additionalRestrictions, bytes32 _salt) external returns (address admin) { + address[] memory restrictions = new address[](requiredRestrictions.length + _additionalRestrictions.length); + uint256 cachedRequired = requiredRestrictions.length; + for (uint256 i = 0; i < cachedRequired; ++i) { + restrictions[i] = requiredRestrictions[i]; + } + uint256 cachedAdditional = _additionalRestrictions.length; + for (uint256 i = 0; i < cachedAdditional; ++i) { + restrictions[requiredRestrictions.length + i] = _additionalRestrictions[i]; + } + + admin = address(new ChainAdmin{salt: _salt}(restrictions)); + } +} diff --git a/l1-contracts/contracts/governance/PermanentRestriction.sol b/l1-contracts/contracts/governance/PermanentRestriction.sol new file mode 100644 index 000000000..153ce369e --- /dev/null +++ b/l1-contracts/contracts/governance/PermanentRestriction.sol @@ -0,0 +1,311 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {UnsupportedEncodingVersion, CallNotAllowed, ChainZeroAddress, NotAHyperchain, NotAnAdmin, RemovingPermanentRestriction, ZeroAddress, UnallowedImplementation, AlreadyWhitelisted, NotAllowed, NotBridgehub, InvalidSelector, InvalidAddress, NotEnoughGas} from "../common/L1ContractErrors.sol"; + +import {L2TransactionRequestTwoBridgesOuter, BridgehubBurnCTMAssetData} from "../bridgehub/IBridgehub.sol"; +import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; +import {L2ContractHelper} from "../common/libraries/L2ContractHelper.sol"; +import {NEW_ENCODING_VERSION} from "../bridge/asset-router/IAssetRouterBase.sol"; + +import {Call} from "./Common.sol"; +import {IRestriction} from "./IRestriction.sol"; +import {IChainAdmin} from "./IChainAdmin.sol"; +import {IBridgehub} from "../bridgehub/IBridgehub.sol"; +import {IZKChain} from "../state-transition/chain-interfaces/IZKChain.sol"; +import {IGetters} from "../state-transition/chain-interfaces/IGetters.sol"; +import {IAdmin} from "../state-transition/chain-interfaces/IAdmin.sol"; + +import {IPermanentRestriction} from "./IPermanentRestriction.sol"; + +/// @dev We use try-catch to test whether some of the conditions should be checked. +/// To avoid attacks based on the 63/64 gas limitations, we ensure that each such call +/// has at least this amount. +uint256 constant MIN_GAS_FOR_FALLABLE_CALL = 5_000_000; + +/// @title PermanentRestriction contract +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice This contract should be used by chains that wish to guarantee that certain security +/// properties are preserved forever. +/// @dev To be deployed as a transparent upgradable proxy, owned by a trusted decentralized governance. +/// @dev Once of the instances of such contract is to ensure that a ZkSyncHyperchain is a rollup forever. +contract PermanentRestriction is IRestriction, IPermanentRestriction, Ownable2StepUpgradeable { + /// @notice The address of the Bridgehub contract. + IBridgehub public immutable BRIDGE_HUB; + + /// @notice The address of the L2 admin factory that should be used to deploy the chain admins + /// for chains that migrated on top of an L2 settlement layer. + /// @dev If this contract is deployed on L2, this address is 0. + /// @dev This address is expected to be the same on all L2 chains. + address public immutable L2_ADMIN_FACTORY; + + /// @notice The mapping of the allowed admin implementations. + mapping(bytes32 implementationCodeHash => bool isAllowed) public allowedAdminImplementations; + + /// @notice The mapping of the allowed calls. + mapping(bytes allowedCalldata => bool isAllowed) public allowedCalls; + + /// @notice The mapping of the validated selectors. + mapping(bytes4 selector => bool isValidated) public validatedSelectors; + + /// @notice The mapping of whitelisted L2 admins. + mapping(address adminAddress => bool isWhitelisted) public allowedL2Admins; + + constructor(IBridgehub _bridgehub, address _l2AdminFactory) { + BRIDGE_HUB = _bridgehub; + L2_ADMIN_FACTORY = _l2AdminFactory; + } + + function initialize(address _initialOwner) external initializer { + // solhint-disable-next-line gas-custom-errors, reason-string + if (_initialOwner == address(0)) { + revert ZeroAddress(); + } + _transferOwnership(_initialOwner); + } + + /// @notice Allows a certain `ChainAdmin` implementation to be used as an admin. + /// @param _implementationHash The hash of the implementation code. + /// @param _isAllowed The flag that indicates if the implementation is allowed. + function allowAdminImplementation(bytes32 _implementationHash, bool _isAllowed) external onlyOwner { + allowedAdminImplementations[_implementationHash] = _isAllowed; + + emit AdminImplementationAllowed(_implementationHash, _isAllowed); + } + + /// @notice Allows a certain calldata for a selector to be used. + /// @param _data The calldata for the function. + /// @param _isAllowed The flag that indicates if the calldata is allowed. + function setAllowedData(bytes calldata _data, bool _isAllowed) external onlyOwner { + allowedCalls[_data] = _isAllowed; + + emit AllowedDataChanged(_data, _isAllowed); + } + + /// @notice Allows a certain selector to be validated. + /// @param _selector The selector of the function. + /// @param _isValidated The flag that indicates if the selector is validated. + function setSelectorIsValidated(bytes4 _selector, bool _isValidated) external onlyOwner { + validatedSelectors[_selector] = _isValidated; + + emit SelectorValidationChanged(_selector, _isValidated); + } + + /// @notice Whitelists a certain L2 admin. + /// @param deploymentSalt The salt for the deployment. + /// @param l2BytecodeHash The hash of the L2 bytecode. + /// @param constructorInputHash The hash of the constructor data for the deployment. + function allowL2Admin(bytes32 deploymentSalt, bytes32 l2BytecodeHash, bytes32 constructorInputHash) external { + // We do not do any additional validations for constructor data or the bytecode, + // we expect that only admins of the allowed format are to be deployed. + address expectedAddress = L2ContractHelper.computeCreate2Address( + L2_ADMIN_FACTORY, + deploymentSalt, + l2BytecodeHash, + constructorInputHash + ); + + if (allowedL2Admins[expectedAddress]) { + revert AlreadyWhitelisted(expectedAddress); + } + + allowedL2Admins[expectedAddress] = true; + emit AllowL2Admin(expectedAddress); + } + + /// @inheritdoc IRestriction + function validateCall( + Call calldata _call, + address // _invoker + ) external view override { + _validateAsChainAdmin(_call); + _validateMigrationToL2(_call); + _validateRemoveRestriction(_call); + } + + /// @notice Validates the migration to an L2 settlement layer. + /// @param _call The call data. + /// @dev Note that we do not need to validate the migration to the L1 layer as the admin + /// is not changed in this case. + function _validateMigrationToL2(Call calldata _call) internal view { + _ensureEnoughGas(); + try this.tryGetNewAdminFromMigration(_call) returns (address admin) { + if (!allowedL2Admins[admin]) { + revert NotAllowed(admin); + } + } catch { + // It was not the migration call, so we do nothing + } + } + + /// @notice Validates the call as the chain admin + /// @param _call The call data. + function _validateAsChainAdmin(Call calldata _call) internal view { + if (!_isAdminOfAChain(_call.target)) { + // We only validate calls related to being an admin of a chain + return; + } + + // All calls with the length of the data below 4 will get into `receive`/`fallback` functions, + // we consider it to always be allowed. + if (_call.data.length < 4) { + return; + } + + bytes4 selector = bytes4(_call.data[:4]); + + if (selector == IAdmin.setPendingAdmin.selector) { + _validateNewAdmin(_call); + return; + } + + if (!validatedSelectors[selector]) { + // The selector is not validated, any data is allowed. + return; + } + + if (!allowedCalls[_call.data]) { + revert CallNotAllowed(_call.data); + } + } + + /// @notice Validates the correctness of the new admin. + /// @param _call The call data. + /// @dev Ensures that the admin has a whitelisted implementation and does not remove this restriction. + function _validateNewAdmin(Call calldata _call) internal view { + address newChainAdmin = abi.decode(_call.data[4:], (address)); + + bytes32 implementationCodeHash = newChainAdmin.codehash; + + if (!allowedAdminImplementations[implementationCodeHash]) { + revert UnallowedImplementation(implementationCodeHash); + } + + // Since the implementation is known to be correct (from the checks above), we + // can safely trust the returned value from the call below + if (!IChainAdmin(newChainAdmin).isRestrictionActive(address(this))) { + revert RemovingPermanentRestriction(); + } + } + + /// @notice Validates the removal of the restriction. + /// @param _call The call data. + /// @dev Ensures that this restriction is not removed. + function _validateRemoveRestriction(Call calldata _call) internal view { + if (_call.target != msg.sender) { + return; + } + + if (bytes4(_call.data[:4]) != IChainAdmin.removeRestriction.selector) { + return; + } + + address removedRestriction = abi.decode(_call.data[4:], (address)); + + if (removedRestriction == address(this)) { + revert RemovingPermanentRestriction(); + } + } + + /// @notice Checks if the `msg.sender` is an admin of a certain ZkSyncHyperchain. + /// @param _chain The address of the chain. + function _isAdminOfAChain(address _chain) internal view returns (bool) { + _ensureEnoughGas(); + (bool success, ) = address(this).staticcall(abi.encodeCall(this.tryCompareAdminOfAChain, (_chain, msg.sender))); + return success; + } + + /// @notice Tries to compare the admin of a chain with the potential admin. + /// @param _chain The address of the chain. + /// @param _potentialAdmin The address of the potential admin. + /// @dev This function reverts if the `_chain` is not a ZkSyncHyperchain or the `_potentialAdmin` is not the + /// admin of the chain. + function tryCompareAdminOfAChain(address _chain, address _potentialAdmin) external view { + if (_chain == address(0)) { + revert ChainZeroAddress(); + } + + // Unfortunately there is no easy way to double check that indeed the `_chain` is a ZkSyncHyperchain. + // So we do the following: + // - Query it for `chainId`. If it reverts, it is not a ZkSyncHyperchain. + // - Query the Bridgehub for the Hyperchain with the given `chainId`. + // - We compare the corresponding addresses + + // Note, that we do not use an explicit call here to ensure that the function does not panic in case of + // incorrect `_chain` address. + (bool success, bytes memory data) = _chain.staticcall(abi.encodeWithSelector(IGetters.getChainId.selector)); + if (!success || data.length < 32) { + revert NotAHyperchain(_chain); + } + + // Can not fail + uint256 chainId = abi.decode(data, (uint256)); + + // Note, that here it is important to use the legacy `getHyperchain` function, so that the contract + // is compatible with the legacy ones. + if (BRIDGE_HUB.getHyperchain(chainId) != _chain) { + revert NotAHyperchain(_chain); + } + + // Now, the chain is known to be a hyperchain, so it should implement the corresponding interface + address admin = IZKChain(_chain).getAdmin(); + if (admin != _potentialAdmin) { + revert NotAnAdmin(admin, _potentialAdmin); + } + } + + /// @notice Tries to get the new admin from the migration. + /// @param _call The call data. + /// @dev This function reverts if the provided call was not a migration call. + function tryGetNewAdminFromMigration(Call calldata _call) external view returns (address) { + if (_call.target != address(BRIDGE_HUB)) { + revert NotBridgehub(_call.target); + } + + if (bytes4(_call.data[:4]) != IBridgehub.requestL2TransactionTwoBridges.selector) { + revert InvalidSelector(bytes4(_call.data[:4])); + } + + address sharedBridge = BRIDGE_HUB.sharedBridge(); + + L2TransactionRequestTwoBridgesOuter memory request = abi.decode( + _call.data[4:], + (L2TransactionRequestTwoBridgesOuter) + ); + + if (request.secondBridgeAddress != sharedBridge) { + revert InvalidAddress(sharedBridge, request.secondBridgeAddress); + } + + bytes memory secondBridgeData = request.secondBridgeCalldata; + if (secondBridgeData[0] != NEW_ENCODING_VERSION) { + revert UnsupportedEncodingVersion(); + } + bytes memory encodedData = new bytes(secondBridgeData.length - 1); + assembly { + mcopy(add(encodedData, 0x20), add(secondBridgeData, 0x21), mload(encodedData)) + } + + (bytes32 chainAssetId, bytes memory bridgehubData) = abi.decode(encodedData, (bytes32, bytes)); + // We will just check that the chainAssetId is a valid chainAssetId. + // For now, for simplicity, we do not check that the admin is exactly the admin + // of this chain. + address ctmAddress = BRIDGE_HUB.ctmAssetIdToAddress(chainAssetId); + if (ctmAddress == address(0)) { + revert ZeroAddress(); + } + + BridgehubBurnCTMAssetData memory burnData = abi.decode(bridgehubData, (BridgehubBurnCTMAssetData)); + (address l2Admin, ) = abi.decode(burnData.ctmData, (address, bytes)); + + return l2Admin; + } + + function _ensureEnoughGas() internal view { + if (gasleft() < MIN_GAS_FOR_FALLABLE_CALL) { + revert NotEnoughGas(); + } + } +} diff --git a/l1-contracts/contracts/state-transition/StateTransitionManager.sol b/l1-contracts/contracts/state-transition/ChainTypeManager.sol similarity index 70% rename from l1-contracts/contracts/state-transition/StateTransitionManager.sol rename to l1-contracts/contracts/state-transition/ChainTypeManager.sol index 9396458ab..62df92419 100644 --- a/l1-contracts/contracts/state-transition/StateTransitionManager.sol +++ b/l1-contracts/contracts/state-transition/ChainTypeManager.sol @@ -2,6 +2,8 @@ pragma solidity 0.8.24; +// solhint-disable gas-custom-errors, reason-string + import {EnumerableMap} from "@openzeppelin/contracts-v4/utils/structs/EnumerableMap.sol"; import {SafeCast} from "@openzeppelin/contracts-v4/utils/math/SafeCast.sol"; @@ -10,35 +12,27 @@ import {DiamondProxy} from "./chain-deps/DiamondProxy.sol"; import {IAdmin} from "./chain-interfaces/IAdmin.sol"; import {IDiamondInit} from "./chain-interfaces/IDiamondInit.sol"; import {IExecutor} from "./chain-interfaces/IExecutor.sol"; -import {IStateTransitionManager, StateTransitionManagerInitializeData, ChainCreationParams} from "./IStateTransitionManager.sol"; -import {IZkSyncHyperchain} from "./chain-interfaces/IZkSyncHyperchain.sol"; -import {FeeParams} from "./chain-deps/ZkSyncHyperchainStorage.sol"; -import {L2_SYSTEM_CONTEXT_SYSTEM_CONTRACT_ADDR, L2_FORCE_DEPLOYER_ADDR} from "../common/L2ContractAddresses.sol"; -import {L2CanonicalTransaction} from "../common/Messaging.sol"; +import {IChainTypeManager, ChainTypeManagerInitializeData, ChainCreationParams} from "./IChainTypeManager.sol"; +import {IZKChain} from "./chain-interfaces/IZKChain.sol"; +import {FeeParams} from "./chain-deps/ZKChainStorage.sol"; import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; -import {ProposedUpgrade} from "../upgrades/BaseZkSyncUpgrade.sol"; import {ReentrancyGuard} from "../common/ReentrancyGuard.sol"; -import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, L2_TO_L1_LOG_SERIALIZE_SIZE, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK, SYSTEM_UPGRADE_L2_TX_TYPE, PRIORITY_TX_MAX_GAS_LIMIT} from "../common/Config.sol"; -import {VerifierParams} from "./chain-interfaces/IVerifier.sol"; -import {Unauthorized, ZeroAddress, HashMismatch, HyperchainLimitReached, GenesisUpgradeZero, GenesisBatchHashZero, GenesisIndexStorageZero, GenesisBatchCommitmentZero} from "../common/L1ContractErrors.sol"; +import {L2_TO_L1_LOG_SERIALIZE_SIZE, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK} from "../common/Config.sol"; +import {Unauthorized, ZeroAddress, HashMismatch, GenesisUpgradeZero, GenesisBatchHashZero, GenesisIndexStorageZero, GenesisBatchCommitmentZero} from "../common/L1ContractErrors.sol"; import {SemVer} from "../common/libraries/SemVer.sol"; import {IBridgehub} from "../bridgehub/IBridgehub.sol"; /// @title State Transition Manager contract /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Ownable2StepUpgradeable { +contract ChainTypeManager is IChainTypeManager, ReentrancyGuard, Ownable2StepUpgradeable { using EnumerableMap for EnumerableMap.UintToAddressMap; /// @notice Address of the bridgehub address public immutable BRIDGE_HUB; - /// @notice The total number of hyperchains can be created/connected to this STM. - /// This is the temporary security measure. - uint256 public immutable MAX_NUMBER_OF_HYPERCHAINS; - - /// @notice The map from chainId => hyperchain contract - EnumerableMap.UintToAddressMap internal hyperchainMap; + /// @notice The map from chainId => zkChain contract + EnumerableMap.UintToAddressMap internal __DEPRECATED_zkChainMap; /// @dev The batch zero hash, calculated at initialization bytes32 public storedBatchZero; @@ -72,9 +66,8 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own /// @dev Contract is expected to be used as proxy implementation. /// @dev Initialize the implementation to prevent Parity hack. - constructor(address _bridgehub, uint256 _maxNumberOfHyperchains) reentrancyGuardInitializer { + constructor(address _bridgehub) reentrancyGuardInitializer { BRIDGE_HUB = _bridgehub; - MAX_NUMBER_OF_HYPERCHAINS = _maxNumberOfHyperchains; // While this does not provide a protection in the production, it is needed for local testing // Length of the L2Log encoding should not be equal to the length of other L2Logs' tree nodes preimages @@ -103,39 +96,27 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own return SemVer.unpackSemVer(SafeCast.toUint96(protocolVersion)); } - /// @notice Returns all the registered hyperchain addresses - function getAllHyperchains() public view override returns (address[] memory chainAddresses) { - uint256[] memory keys = hyperchainMap.keys(); - chainAddresses = new address[](keys.length); - uint256 keysLength = keys.length; - for (uint256 i = 0; i < keysLength; ++i) { - chainAddresses[i] = hyperchainMap.get(keys[i]); - } - } - - /// @notice Returns all the registered hyperchain chainIDs - function getAllHyperchainChainIDs() public view override returns (uint256[] memory) { - return hyperchainMap.keys(); + /// @notice return the chain contract address for a chainId + function getZKChain(uint256 _chainId) public view returns (address) { + return IBridgehub(BRIDGE_HUB).getZKChain(_chainId); } - /// @notice Returns the address of the hyperchain with the corresponding chainID - /// @param _chainId the chainId of the chain - /// @return chainAddress the address of the hyperchain - function getHyperchain(uint256 _chainId) public view override returns (address chainAddress) { + /// @notice return the chain contract address for a chainId + /// @notice Do not use! use getZKChain instead. This will be removed. + function getZKChainLegacy(uint256 _chainId) public view returns (address chainAddress) { // slither-disable-next-line unused-return - (, chainAddress) = hyperchainMap.tryGet(_chainId); + (, chainAddress) = __DEPRECATED_zkChainMap.tryGet(_chainId); } - /// @notice Returns the address of the hyperchain admin with the corresponding chainID + /// @notice Returns the address of the ZK chain admin with the corresponding chainID. + /// @notice Not related to the CTM, but it is here for legacy reasons. /// @param _chainId the chainId of the chain function getChainAdmin(uint256 _chainId) external view override returns (address) { - return IZkSyncHyperchain(hyperchainMap.get(_chainId)).getAdmin(); + return IZKChain(getZKChain(_chainId)).getAdmin(); } /// @dev initialize - function initialize( - StateTransitionManagerInitializeData calldata _initializeData - ) external reentrancyGuardInitializer { + function initialize(ChainTypeManagerInitializeData calldata _initializeData) external reentrancyGuardInitializer { if (_initializeData.owner == address(0)) { revert ZeroAddress(); } @@ -228,7 +209,7 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own emit NewAdmin(previousAdmin, currentPendingAdmin); } - /// @dev set validatorTimelock. Cannot do it during initialization, as validatorTimelock is deployed after STM + /// @dev set validatorTimelock. Cannot do it during initialization, as validatorTimelock is deployed after CTM /// @param _validatorTimelock the new validatorTimelock address function setValidatorTimelock(address _validatorTimelock) external onlyOwnerOrAdmin { address oldValidatorTimelock = validatorTimelock; @@ -286,20 +267,20 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own /// @dev freezes the specified chain /// @param _chainId the chainId of the chain function freezeChain(uint256 _chainId) external onlyOwner { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).freezeDiamond(); + IZKChain(getZKChain(_chainId)).freezeDiamond(); } /// @dev freezes the specified chain /// @param _chainId the chainId of the chain function unfreezeChain(uint256 _chainId) external onlyOwner { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).unfreezeDiamond(); + IZKChain(getZKChain(_chainId)).unfreezeDiamond(); } /// @dev reverts batches on the specified chain /// @param _chainId the chainId of the chain /// @param _newLastBatch the new last batch function revertBatches(uint256 _chainId, uint256 _newLastBatch) external onlyOwnerOrAdmin { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).revertBatches(_newLastBatch); + IZKChain(getZKChain(_chainId)).revertBatchesSharedBridge(_chainId, _newLastBatch); } /// @dev execute predefined upgrade @@ -311,21 +292,21 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own uint256 _oldProtocolVersion, Diamond.DiamondCutData calldata _diamondCut ) external onlyOwner { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).upgradeChainFromVersion(_oldProtocolVersion, _diamondCut); + IZKChain(getZKChain(_chainId)).upgradeChainFromVersion(_oldProtocolVersion, _diamondCut); } /// @dev executes upgrade on chain /// @param _chainId the chainId of the chain /// @param _diamondCut the diamond cut data function executeUpgrade(uint256 _chainId, Diamond.DiamondCutData calldata _diamondCut) external onlyOwner { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).executeUpgrade(_diamondCut); + IZKChain(getZKChain(_chainId)).executeUpgrade(_diamondCut); } /// @dev setPriorityTxMaxGasLimit for the specified chain /// @param _chainId the chainId of the chain /// @param _maxGasLimit the new max gas limit function setPriorityTxMaxGasLimit(uint256 _chainId, uint256 _maxGasLimit) external onlyOwner { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).setPriorityTxMaxGasLimit(_maxGasLimit); + IZKChain(getZKChain(_chainId)).setPriorityTxMaxGasLimit(_maxGasLimit); } /// @dev setTokenMultiplier for the specified chain @@ -333,14 +314,14 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own /// @param _nominator the new nominator of the token multiplier /// @param _denominator the new denominator of the token multiplier function setTokenMultiplier(uint256 _chainId, uint128 _nominator, uint128 _denominator) external onlyOwner { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).setTokenMultiplier(_nominator, _denominator); + IZKChain(getZKChain(_chainId)).setTokenMultiplier(_nominator, _denominator); } /// @dev changeFeeParams for the specified chain /// @param _chainId the chainId of the chain /// @param _newFeeParams the new fee params function changeFeeParams(uint256 _chainId, FeeParams calldata _newFeeParams) external onlyOwner { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).changeFeeParams(_newFeeParams); + IZKChain(getZKChain(_chainId)).changeFeeParams(_newFeeParams); } /// @dev setValidator for the specified chain @@ -348,49 +329,45 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own /// @param _validator the new validator /// @param _active whether the validator is active function setValidator(uint256 _chainId, address _validator, bool _active) external onlyOwnerOrAdmin { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).setValidator(_validator, _active); + IZKChain(getZKChain(_chainId)).setValidator(_validator, _active); } /// @dev setPorterAvailability for the specified chain /// @param _chainId the chainId of the chain /// @param _zkPorterIsAvailable whether the zkPorter mode is available function setPorterAvailability(uint256 _chainId, bool _zkPorterIsAvailable) external onlyOwner { - IZkSyncHyperchain(hyperchainMap.get(_chainId)).setPorterAvailability(_zkPorterIsAvailable); + IZKChain(getZKChain(_chainId)).setPorterAvailability(_zkPorterIsAvailable); } /// registration - /// @dev used to register already deployed hyperchain contracts + /// @notice deploys a full set of chains contracts /// @param _chainId the chain's id - /// @param _hyperchain the chain's contract address - function registerAlreadyDeployedHyperchain(uint256 _chainId, address _hyperchain) external onlyOwner { - if (_hyperchain == address(0)) { - revert ZeroAddress(); - } - - _registerNewHyperchain(_chainId, _hyperchain); - } - - /// @dev deploys a full set of chains contracts + /// @param _baseTokenAssetId the base token asset id used to pay for gas fees + /// @param _sharedBridge the shared bridge address, used as base token bridge + /// @param _admin the chain's admin address + /// @param _diamondCut the diamond cut data that initializes the chains Diamond Proxy function _deployNewChain( uint256 _chainId, - address _baseToken, + bytes32 _baseTokenAssetId, address _sharedBridge, address _admin, bytes memory _diamondCut - ) internal returns (address hyperchainAddress) { - if (getHyperchain(_chainId) != address(0)) { - // Hyperchain already registered - return getHyperchain(_chainId); + ) internal returns (address zkChainAddress) { + if (getZKChain(_chainId) != address(0)) { + // ZKChain already registered + return getZKChain(_chainId); } // check not registered Diamond.DiamondCutData memory diamondCut = abi.decode(_diamondCut, (Diamond.DiamondCutData)); - // check input - bytes32 cutHashInput = keccak256(_diamondCut); - if (cutHashInput != initialCutHash) { - revert HashMismatch(initialCutHash, cutHashInput); + { + // check input + bytes32 cutHashInput = keccak256(_diamondCut); + if (cutHashInput != initialCutHash) { + revert HashMismatch(initialCutHash, cutHashInput); + } } // construct init data @@ -405,55 +382,59 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own bytes32(protocolVersion), bytes32(uint256(uint160(_admin))), bytes32(uint256(uint160(validatorTimelock))), - bytes32(uint256(uint160(_baseToken))), + _baseTokenAssetId, bytes32(uint256(uint160(_sharedBridge))), storedBatchZero, diamondCut.initCalldata ); diamondCut.initCalldata = initData; - // deploy hyperchainContract + // deploy zkChainContract // slither-disable-next-line reentrancy-no-eth - DiamondProxy hyperchainContract = new DiamondProxy{salt: bytes32(0)}(block.chainid, diamondCut); + DiamondProxy zkChainContract = new DiamondProxy{salt: bytes32(0)}(block.chainid, diamondCut); // save data - hyperchainAddress = address(hyperchainContract); - - _registerNewHyperchain(_chainId, hyperchainAddress); + zkChainAddress = address(zkChainContract); + emit NewZKChain(_chainId, zkChainAddress); } /// @notice called by Bridgehub when a chain registers /// @param _chainId the chain's id - /// @param _baseToken the base token address used to pay for gas fees - /// @param _sharedBridge the shared bridge address, used as base token bridge + /// @param _baseTokenAssetId the base token asset id used to pay for gas fees + /// @param _assetRouter the shared bridge address, used as base token bridge /// @param _admin the chain's admin address /// @param _initData the diamond cut data, force deployments and factoryDeps encoded /// @param _factoryDeps the factory dependencies used for the genesis upgrade /// that initializes the chains Diamond Proxy function createNewChain( uint256 _chainId, - address _baseToken, - address _sharedBridge, + bytes32 _baseTokenAssetId, + address _assetRouter, address _admin, bytes calldata _initData, bytes[] calldata _factoryDeps - ) external onlyBridgehub { + ) external onlyBridgehub returns (address zkChainAddress) { (bytes memory _diamondCut, bytes memory _forceDeploymentData) = abi.decode(_initData, (bytes, bytes)); - // TODO: only allow on L1. + // solhint-disable-next-line func-named-parameters - address hyperchainAddress = _deployNewChain(_chainId, _baseToken, _sharedBridge, _admin, _diamondCut); + zkChainAddress = _deployNewChain(_chainId, _baseTokenAssetId, _assetRouter, _admin, _diamondCut); { // check input bytes32 forceDeploymentHash = keccak256(abi.encode(_forceDeploymentData)); - require(forceDeploymentHash == initialForceDeploymentHash, "STM: initial force deployment mismatch"); + require(forceDeploymentHash == initialForceDeploymentHash, "CTM: initial force deployment mismatch"); } // genesis upgrade, deploys some contracts, sets chainId - IAdmin(hyperchainAddress).genesisUpgrade(l1GenesisUpgrade, _forceDeploymentData, _factoryDeps); + IAdmin(zkChainAddress).genesisUpgrade( + l1GenesisUpgrade, + address(IBridgehub(BRIDGE_HUB).l1CtmDeployer()), + _forceDeploymentData, + _factoryDeps + ); } /// @param _chainId the chainId of the chain function getProtocolVersion(uint256 _chainId) public view returns (uint256) { - return IZkSyncHyperchain(hyperchainMap.get(_chainId)).getProtocolVersion(); + return IZKChain(getZKChain(_chainId)).getProtocolVersion(); } /// @param _newSettlementLayerChainId the chainId of the chain @@ -461,15 +442,10 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own function registerSettlementLayer(uint256 _newSettlementLayerChainId, bool _isWhitelisted) external onlyOwner { require(_newSettlementLayerChainId != 0, "Bad chain id"); - // Currently, we require that the sync layer is deployed by the same STM. - address settlementLayerAddress = hyperchainMap.get(_newSettlementLayerChainId); - - // TODO: Maybe `get` already ensured its existence. - require(settlementLayerAddress != address(0), "STM: sync layer not registered"); + // Currently, we require that the sync layer is deployed by the same CTM. + require(getZKChain(_newSettlementLayerChainId) != address(0), "CTM: sync layer not registered"); IBridgehub(BRIDGE_HUB).registerSettlementLayer(_newSettlementLayerChainId, _isWhitelisted); - - // TODO: emit event } /// @notice Called by the bridgehub during the migration of a chain to another settlement layer. @@ -478,29 +454,44 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own function forwardedBridgeBurn( uint256 _chainId, bytes calldata _data - ) external view override onlyBridgehub returns (bytes memory stmForwardedBridgeMintData) { - (address _newGatewayAdmin, bytes memory _diamondCut) = abi.decode(_data, (address, bytes)); - require(_newGatewayAdmin != address(0), "STM: admin zero"); - // todo check protocol version - return abi.encode(IBridgehub(BRIDGE_HUB).baseToken(_chainId), _newGatewayAdmin, protocolVersion, _diamondCut); + ) external view override onlyBridgehub returns (bytes memory ctmForwardedBridgeMintData) { + // Note that the `_diamondCut` here is not for the current chain, for the chain where the migration + // happens. The correctness of it will be checked on the CTM on the new settlement layer. + (address _newSettlementLayerAdmin, bytes memory _diamondCut) = abi.decode(_data, (address, bytes)); + require(_newSettlementLayerAdmin != address(0), "CTM: admin zero"); + + // We ensure that the chain has the latest protocol version to avoid edge cases + // related to different protocol version support. + address zkChain = getZKChain(_chainId); + require(IZKChain(zkChain).getProtocolVersion() == protocolVersion, "CTM: outdated pv"); + + return + abi.encode( + IBridgehub(BRIDGE_HUB).baseTokenAssetId(_chainId), + _newSettlementLayerAdmin, + protocolVersion, + _diamondCut + ); } /// @notice Called by the bridgehub during the migration of a chain to the current settlement layer. /// @param _chainId The chain id of the chain to be migrated. - /// @param _stmData The data returned from `forwardedBridgeBurn` for the chain. + /// @param _ctmData The data returned from `forwardedBridgeBurn` for the chain. function forwardedBridgeMint( uint256 _chainId, - bytes calldata _stmData + bytes calldata _ctmData ) external override onlyBridgehub returns (address chainAddress) { - (address _baseToken, address _admin, uint256 _protocolVersion, bytes memory _diamondCut) = abi.decode( - _stmData, - (address, address, uint256, bytes) + (bytes32 _baseTokenAssetId, address _admin, uint256 _protocolVersion, bytes memory _diamondCut) = abi.decode( + _ctmData, + (bytes32, address, uint256, bytes) ); - require(_protocolVersion == protocolVersion, "STM, outdated pv"); - // todo porotocl version check + + // We ensure that the chain has the latest protocol version to avoid edge cases + // related to different protocol version support. + require(_protocolVersion == protocolVersion, "CTM, outdated pv"); chainAddress = _deployNewChain({ _chainId: _chainId, - _baseToken: _baseToken, + _baseTokenAssetId: _baseTokenAssetId, _sharedBridge: address(IBridgehub(BRIDGE_HUB).sharedBridge()), _admin: _admin, _diamondCut: _diamondCut @@ -508,26 +499,26 @@ contract StateTransitionManager is IStateTransitionManager, ReentrancyGuard, Own } /// @notice Called by the bridgehub during the failed migration of a chain. - /// @param _chainId the chainId of the chain - /// @param _assetInfo the assetInfo of the chain - /// @param _prevMsgSender the previous message sender - /// @param _data the data of the migration - function bridgeClaimFailedBurn( - uint256 _chainId, - bytes32 _assetInfo, - address _prevMsgSender, - bytes calldata _data + /// param _chainId the chainId of the chain + /// param _assetInfo the assetInfo of the chain + /// param _depositSender the address of that sent the deposit + /// param _ctmData the data of the migration + function forwardedBridgeRecoverFailedTransfer( + uint256 /* _chainId */, + bytes32 /* _assetInfo */, + address /* _depositSender */, + bytes calldata /* _ctmData */ ) external { - // todo + // Function is empty due to the fact that when calling `forwardedBridgeBurn` there are no + // state updates that occur. } - /// @dev This internal function is used to register a new hyperchain in the system. - function _registerNewHyperchain(uint256 _chainId, address _hyperchain) internal { - // slither-disable-next-line unused-return - hyperchainMap.set(_chainId, _hyperchain); - if (hyperchainMap.length() > MAX_NUMBER_OF_HYPERCHAINS) { - revert HyperchainLimitReached(); - } - emit NewHyperchain(_chainId, _hyperchain); + /*////////////////////////////////////////////////////////////// + Legacy functions + //////////////////////////////////////////////////////////////*/ + + /// @notice return the chain contract address for a chainId + function getHyperchain(uint256 _chainId) public view returns (address) { + return getZKChain(_chainId); } } diff --git a/l1-contracts/contracts/state-transition/IStateTransitionManager.sol b/l1-contracts/contracts/state-transition/IChainTypeManager.sol similarity index 85% rename from l1-contracts/contracts/state-transition/IStateTransitionManager.sol rename to l1-contracts/contracts/state-transition/IChainTypeManager.sol index 16fb1be0b..b5202e975 100644 --- a/l1-contracts/contracts/state-transition/IStateTransitionManager.sol +++ b/l1-contracts/contracts/state-transition/IChainTypeManager.sol @@ -4,17 +4,17 @@ pragma solidity ^0.8.21; import {Diamond} from "./libraries/Diamond.sol"; import {L2CanonicalTransaction} from "../common/Messaging.sol"; -import {FeeParams} from "./chain-deps/ZkSyncHyperchainStorage.sol"; +import {FeeParams} from "./chain-deps/ZKChainStorage.sol"; // import {IBridgehub} from "../bridgehub/IBridgehub.sol"; -/// @notice Struct that holds all data needed for initializing STM Proxy. +/// @notice Struct that holds all data needed for initializing CTM Proxy. /// @dev We use struct instead of raw parameters in `initialize` function to prevent "Stack too deep" error /// @param owner The address who can manage non-critical updates in the contract /// @param validatorTimelock The address that serves as consensus, i.e. can submit blocks to be processed /// @param chainCreationParams The struct that contains the fields that define how a new chain should be created /// @param protocolVersion The initial protocol version on the newly deployed chain -struct StateTransitionManagerInitializeData { +struct ChainTypeManagerInitializeData { address owner; address validatorTimelock; ChainCreationParams chainCreationParams; @@ -22,7 +22,7 @@ struct StateTransitionManagerInitializeData { } /// @notice The struct that contains the fields that define how a new chain should be created -/// within this STM. +/// within this CTM. /// @param genesisUpgrade The address that is used in the diamond cut initialize address on chain creation /// @param genesisBatchHash Batch hash of the genesis (initial) batch /// @param genesisIndexRepeatedStorageChanges The serial number of the shortcut storage key for the genesis batch @@ -38,13 +38,13 @@ struct ChainCreationParams { bytes forceDeploymentsData; } -interface IStateTransitionManager { - /// @dev Emitted when a new Hyperchain is added - event NewHyperchain(uint256 indexed _chainId, address indexed _hyperchainContract); +interface IChainTypeManager { + /// @dev Emitted when a new ZKChain is added + event NewZKChain(uint256 indexed _chainId, address indexed _zkChainContract); /// @dev emitted when an chain registers and a GenesisUpgrade happens event GenesisUpgrade( - address indexed _hyperchain, + address indexed _zkChain, L2CanonicalTransaction _l2Transaction, uint256 indexed _protocolVersion ); @@ -84,11 +84,9 @@ interface IStateTransitionManager { function acceptAdmin() external; - function getAllHyperchains() external view returns (address[] memory); + function getZKChain(uint256 _chainId) external view returns (address); - function getAllHyperchainChainIDs() external view returns (uint256[] memory); - - function getHyperchain(uint256 _chainId) external view returns (address); + function getZKChainLegacy(uint256 _chainId) external view returns (address); function storedBatchZero() external view returns (bytes32); @@ -104,7 +102,9 @@ interface IStateTransitionManager { function protocolVersionIsActive(uint256 _protocolVersion) external view returns (bool); - function initialize(StateTransitionManagerInitializeData calldata _initializeData) external; + function getProtocolVersion(uint256 _chainId) external view returns (uint256); + + function initialize(ChainTypeManagerInitializeData calldata _initializeData) external; function setValidatorTimelock(address _validatorTimelock) external; @@ -114,14 +114,12 @@ interface IStateTransitionManager { function createNewChain( uint256 _chainId, - address _baseToken, - address _sharedBridge, + bytes32 _baseTokenAssetId, + address _assetRouter, address _admin, bytes calldata _initData, bytes[] calldata _factoryDeps - ) external; - - function registerAlreadyDeployedHyperchain(uint256 _chainId, address _hyperchain) external; + ) external returns (address); function setNewVersionUpgrade( Diamond.DiamondCutData calldata _cutData, @@ -167,10 +165,10 @@ interface IStateTransitionManager { function forwardedBridgeMint(uint256 _chainId, bytes calldata _data) external returns (address); - function bridgeClaimFailedBurn( + function forwardedBridgeRecoverFailedTransfer( uint256 _chainId, bytes32 _assetInfo, - address _prevMsgSender, - bytes calldata _data + address _depositSender, + bytes calldata _ctmData ) external; } diff --git a/l1-contracts/contracts/state-transition/TestnetVerifier.sol b/l1-contracts/contracts/state-transition/TestnetVerifier.sol index 6e97fed05..a347c3537 100644 --- a/l1-contracts/contracts/state-transition/TestnetVerifier.sol +++ b/l1-contracts/contracts/state-transition/TestnetVerifier.sol @@ -18,17 +18,13 @@ contract TestnetVerifier is Verifier { /// @dev Verifies a zk-SNARK proof, skipping the verification if the proof is empty. /// @inheritdoc IVerifier - function verify( - uint256[] calldata _publicInputs, - uint256[] calldata _proof, - uint256[] calldata _recursiveAggregationInput - ) public view override returns (bool) { + function verify(uint256[] calldata _publicInputs, uint256[] calldata _proof) public view override returns (bool) { // We allow skipping the zkp verification for the test(net) environment // If the proof is not empty, verify it, otherwise, skip the verification if (_proof.length == 0) { return true; } - return super.verify(_publicInputs, _proof, _recursiveAggregationInput); + return super.verify(_publicInputs, _proof); } } diff --git a/l1-contracts/contracts/state-transition/ValidatorTimelock.sol b/l1-contracts/contracts/state-transition/ValidatorTimelock.sol index 710eaa870..64cc0bc20 100644 --- a/l1-contracts/contracts/state-transition/ValidatorTimelock.sol +++ b/l1-contracts/contracts/state-transition/ValidatorTimelock.sol @@ -5,15 +5,14 @@ pragma solidity 0.8.24; import {Ownable2Step} from "@openzeppelin/contracts-v4/access/Ownable2Step.sol"; import {LibMap} from "./libraries/LibMap.sol"; import {IExecutor} from "./chain-interfaces/IExecutor.sol"; -import {IStateTransitionManager} from "./IStateTransitionManager.sol"; -import {PriorityOpsBatchInfo} from "./libraries/PriorityTree.sol"; +import {IChainTypeManager} from "./IChainTypeManager.sol"; import {Unauthorized, TimeNotReached, ZeroAddress} from "../common/L1ContractErrors.sol"; /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -/// @notice Intermediate smart contract between the validator EOA account and the hyperchains state transition diamond smart contract. +/// @notice Intermediate smart contract between the validator EOA account and the ZK chains state transition diamond smart contract. /// @dev The primary purpose of this contract is to provide a trustless means of delaying batch execution without -/// modifying the main hyperchain diamond contract. As such, even if this contract is compromised, it will not impact the main +/// modifying the main zkChain diamond contract. As such, even if this contract is compromised, it will not impact the main /// contract. /// @dev ZKsync actively monitors the chain activity and reacts to any suspicious activity by freezing the chain. /// This allows time for investigation and mitigation before resuming normal operations. @@ -41,8 +40,8 @@ contract ValidatorTimelock is IExecutor, Ownable2Step { /// @notice Error for when an address is not a validator. error ValidatorDoesNotExist(uint256 _chainId); - /// @dev The stateTransitionManager smart contract. - IStateTransitionManager public stateTransitionManager; + /// @dev The chainTypeManager smart contract. + IChainTypeManager public chainTypeManager; /// @dev The mapping of L2 chainId => batch number => timestamp when it was committed. mapping(uint256 chainId => LibMap.Uint32Map batchNumberToTimestampMapping) internal committedBatchTimestamp; @@ -64,7 +63,7 @@ contract ValidatorTimelock is IExecutor, Ownable2Step { /// @notice Checks if the caller is the admin of the chain. modifier onlyChainAdmin(uint256 _chainId) { - if (msg.sender != stateTransitionManager.getChainAdmin(_chainId)) { + if (msg.sender != chainTypeManager.getChainAdmin(_chainId)) { revert Unauthorized(msg.sender); } _; @@ -79,11 +78,11 @@ contract ValidatorTimelock is IExecutor, Ownable2Step { } /// @dev Sets a new state transition manager. - function setStateTransitionManager(IStateTransitionManager _stateTransitionManager) external onlyOwner { - if (address(_stateTransitionManager) == address(0)) { + function setChainTypeManager(IChainTypeManager _chainTypeManager) external onlyOwner { + if (address(_chainTypeManager) == address(0)) { revert ZeroAddress(); } - stateTransitionManager = _stateTransitionManager; + chainTypeManager = _chainTypeManager; } /// @dev Sets an address as a validator. @@ -116,102 +115,57 @@ contract ValidatorTimelock is IExecutor, Ownable2Step { } /// @dev Records the timestamp for all provided committed batches and make - /// a call to the hyperchain diamond contract with the same calldata. - function commitBatches( - StoredBatchInfo calldata, - CommitBatchInfo[] calldata _newBatchesData - ) external onlyValidator(ERA_CHAIN_ID) { - _commitBatchesInner(ERA_CHAIN_ID, _newBatchesData); - } - - /// @dev Records the timestamp for all provided committed batches and make - /// a call to the hyperchain diamond contract with the same calldata. + /// a call to the zkChain diamond contract with the same calldata. function commitBatchesSharedBridge( uint256 _chainId, - StoredBatchInfo calldata, - CommitBatchInfo[] calldata _newBatchesData + uint256 _processBatchFrom, + uint256 _processBatchTo, + bytes calldata ) external onlyValidator(_chainId) { - _commitBatchesInner(_chainId, _newBatchesData); - } - - function _commitBatchesInner(uint256 _chainId, CommitBatchInfo[] calldata _newBatchesData) internal { unchecked { // This contract is only a temporary solution, that hopefully will be disabled until 2106 year, so... // It is safe to cast. uint32 timestamp = uint32(block.timestamp); // We disable this check because calldata array length is cheap. - // solhint-disable-next-line gas-length-in-loops - for (uint256 i = 0; i < _newBatchesData.length; ++i) { - committedBatchTimestamp[_chainId].set(_newBatchesData[i].batchNumber, timestamp); + for (uint256 i = _processBatchFrom; i <= _processBatchTo; ++i) { + committedBatchTimestamp[_chainId].set(i, timestamp); } } - - _propagateToZkSyncHyperchain(_chainId); - } - - /// @dev Make a call to the hyperchain diamond contract with the same calldata. - /// Note: If the batch is reverted, it needs to be committed first before the execution. - /// So it's safe to not override the committed batches. - function revertBatches(uint256) external onlyValidator(ERA_CHAIN_ID) { - _propagateToZkSyncHyperchain(ERA_CHAIN_ID); + _propagateToZKChain(_chainId); } - /// @dev Make a call to the hyperchain diamond contract with the same calldata. + /// @dev Make a call to the zkChain diamond contract with the same calldata. /// Note: If the batch is reverted, it needs to be committed first before the execution. /// So it's safe to not override the committed batches. function revertBatchesSharedBridge(uint256 _chainId, uint256) external onlyValidator(_chainId) { - _propagateToZkSyncHyperchain(_chainId); + _propagateToZKChain(_chainId); } - /// @dev Make a call to the hyperchain diamond contract with the same calldata. - /// Note: We don't track the time when batches are proven, since all information about - /// the batch is known on the commit stage and the proved is not finalized (may be reverted). - function proveBatches( - StoredBatchInfo calldata, - StoredBatchInfo[] calldata, - ProofInput calldata - ) external onlyValidator(ERA_CHAIN_ID) { - _propagateToZkSyncHyperchain(ERA_CHAIN_ID); - } - - /// @dev Make a call to the hyperchain diamond contract with the same calldata. + /// @dev Make a call to the zkChain diamond contract with the same calldata. /// Note: We don't track the time when batches are proven, since all information about /// the batch is known on the commit stage and the proved is not finalized (may be reverted). function proveBatchesSharedBridge( uint256 _chainId, - StoredBatchInfo calldata, - StoredBatchInfo[] calldata, - ProofInput calldata + uint256, // _processBatchFrom + uint256, // _processBatchTo + bytes calldata ) external onlyValidator(_chainId) { - _propagateToZkSyncHyperchain(_chainId); + _propagateToZKChain(_chainId); } /// @dev Check that batches were committed at least X time ago and - /// make a call to the hyperchain diamond contract with the same calldata. - function executeBatches( - StoredBatchInfo[] calldata _batchesData, - PriorityOpsBatchInfo[] calldata - ) external onlyValidator(ERA_CHAIN_ID) { - _executeBatchesInner(ERA_CHAIN_ID, _batchesData); - } - - /// @dev Check that batches were committed at least X time ago and - /// make a call to the hyperchain diamond contract with the same calldata. + /// make a call to the zkChain diamond contract with the same calldata. function executeBatchesSharedBridge( uint256 _chainId, - StoredBatchInfo[] calldata _newBatchesData, - PriorityOpsBatchInfo[] calldata + uint256 _processBatchFrom, + uint256 _processBatchTo, + bytes calldata ) external onlyValidator(_chainId) { - _executeBatchesInner(_chainId, _newBatchesData); - } - - function _executeBatchesInner(uint256 _chainId, StoredBatchInfo[] calldata _newBatchesData) internal { uint256 delay = executionDelay; // uint32 unchecked { // We disable this check because calldata array length is cheap. - // solhint-disable-next-line gas-length-in-loops - for (uint256 i = 0; i < _newBatchesData.length; ++i) { - uint256 commitBatchTimestamp = committedBatchTimestamp[_chainId].get(_newBatchesData[i].batchNumber); + for (uint256 i = _processBatchFrom; i <= _processBatchTo; ++i) { + uint256 commitBatchTimestamp = committedBatchTimestamp[_chainId].get(i); // Note: if the `commitBatchTimestamp` is zero, that means either: // * The batch was committed, but not through this contract. @@ -223,17 +177,17 @@ contract ValidatorTimelock is IExecutor, Ownable2Step { } } } - _propagateToZkSyncHyperchain(_chainId); + _propagateToZKChain(_chainId); } - /// @dev Call the hyperchain diamond contract with the same calldata as this contract was called. - /// Note: it is called the hyperchain diamond contract, not delegatecalled! - function _propagateToZkSyncHyperchain(uint256 _chainId) internal { - address contractAddress = stateTransitionManager.getHyperchain(_chainId); + /// @dev Call the zkChain diamond contract with the same calldata as this contract was called. + /// Note: it is called the zkChain diamond contract, not delegatecalled! + function _propagateToZKChain(uint256 _chainId) internal { + address contractAddress = chainTypeManager.getZKChain(_chainId); assembly { // Copy function signature and arguments from calldata at zero position into memory at pointer position calldatacopy(0, 0, calldatasize()) - // Call method of the hyperchain diamond contract returns 0 on error + // Call method of the ZK chain diamond contract returns 0 on error let result := call(gas(), contractAddress, 0, 0, calldatasize(), 0, 0) // Get the size of the last return data let size := returndatasize() diff --git a/l1-contracts/contracts/state-transition/Verifier.sol b/l1-contracts/contracts/state-transition/Verifier.sol index a74ecb12c..3072c2c5a 100644 --- a/l1-contracts/contracts/state-transition/Verifier.sol +++ b/l1-contracts/contracts/state-transition/Verifier.sol @@ -8,7 +8,7 @@ import {IVerifier} from "./chain-interfaces/IVerifier.sol"; /// @author Matter Labs /// @notice Modified version of the Permutations over Lagrange-bases for Oecumenical Noninteractive arguments of /// Knowledge (PLONK) verifier. -/// Modifications have been made to optimize the proof system for ZKsync hyperchain circuits. +/// Modifications have been made to optimize the proof system for ZK chain circuits. /// @dev Contract was generated from a verification key with a hash of 0x14f97b81e54b35fe673d8708cc1a19e1ea5b5e348e12d31e39824ed4f42bbca2 /// @dev It uses a custom memory layout inside the inline assembly block. Each reserved memory cell is declared in the /// constants below. @@ -343,8 +343,7 @@ contract Verifier is IVerifier { /// @inheritdoc IVerifier function verify( uint256[] calldata, // _publicInputs - uint256[] calldata, // _proof - uint256[] calldata // _recursiveAggregationInput + uint256[] calldata // _proof ) public view virtual returns (bool) { // No memory was accessed yet, so keys can be loaded into the right place and not corrupt any other memory. _loadVerificationKey(); @@ -523,7 +522,17 @@ contract Verifier is IVerifier { // 2. Load the proof (except for the recursive part) offset := calldataload(0x24) let proofLengthInWords := calldataload(add(offset, 0x04)) - isValid := and(eq(proofLengthInWords, 44), isValid) + + // Check the proof length depending on whether the recursive part is present + let expectedProofLength + switch mload(VK_RECURSIVE_FLAG_SLOT) + case 0 { + expectedProofLength := 44 + } + default { + expectedProofLength := 48 + } + isValid := and(eq(proofLengthInWords, expectedProofLength), isValid) // PROOF_STATE_POLYS_0 { @@ -670,21 +679,13 @@ contract Verifier is IVerifier { } // 3. Load the recursive part of the proof - offset := calldataload(0x44) - let recursiveProofLengthInWords := calldataload(add(offset, 0x04)) - - switch mload(VK_RECURSIVE_FLAG_SLOT) - case 0 { - // recursive part should be empty - isValid := and(iszero(recursiveProofLengthInWords), isValid) - } - default { + if mload(VK_RECURSIVE_FLAG_SLOT) { // recursive part should be consist of 2 points - isValid := and(eq(recursiveProofLengthInWords, 4), isValid) + // PROOF_RECURSIVE_PART_P1 { - let x := mod(calldataload(add(offset, 0x024)), Q_MOD) - let y := mod(calldataload(add(offset, 0x044)), Q_MOD) + let x := mod(calldataload(add(offset, 0x5a4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x5c4)), Q_MOD) let xx := mulmod(x, x, Q_MOD) isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) mstore(PROOF_RECURSIVE_PART_P1_X_SLOT, x) @@ -692,8 +693,8 @@ contract Verifier is IVerifier { } // PROOF_RECURSIVE_PART_P2 { - let x := mod(calldataload(add(offset, 0x064)), Q_MOD) - let y := mod(calldataload(add(offset, 0x084)), Q_MOD) + let x := mod(calldataload(add(offset, 0x5e4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x604)), Q_MOD) let xx := mulmod(x, x, Q_MOD) isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) mstore(PROOF_RECURSIVE_PART_P2_X_SLOT, x) diff --git a/l1-contracts/contracts/state-transition/chain-deps/DiamondInit.sol b/l1-contracts/contracts/state-transition/chain-deps/DiamondInit.sol index a1812ca26..3be7dc2b1 100644 --- a/l1-contracts/contracts/state-transition/chain-deps/DiamondInit.sol +++ b/l1-contracts/contracts/state-transition/chain-deps/DiamondInit.sol @@ -3,10 +3,9 @@ pragma solidity 0.8.24; import {Diamond} from "../libraries/Diamond.sol"; -import {ZkSyncHyperchainBase} from "./facets/ZkSyncHyperchainBase.sol"; +import {ZKChainBase} from "./facets/ZKChainBase.sol"; import {L2_TO_L1_LOG_SERIALIZE_SIZE, MAX_GAS_PER_TRANSACTION} from "../../common/Config.sol"; import {InitializeData, IDiamondInit} from "../chain-interfaces/IDiamondInit.sol"; -import {IBridgehub} from "../../bridgehub/IBridgehub.sol"; import {PriorityQueue} from "../libraries/PriorityQueue.sol"; import {PriorityTree} from "../libraries/PriorityTree.sol"; import {ZeroAddress, TooMuchGas} from "../../common/L1ContractErrors.sol"; @@ -14,14 +13,14 @@ import {ZeroAddress, TooMuchGas} from "../../common/L1ContractErrors.sol"; /// @author Matter Labs /// @dev The contract is used only once to initialize the diamond proxy. /// @dev The deployment process takes care of this contract's initialization. -contract DiamondInit is ZkSyncHyperchainBase, IDiamondInit { +contract DiamondInit is ZKChainBase, IDiamondInit { using PriorityQueue for PriorityQueue.Queue; using PriorityTree for PriorityTree.Tree; /// @dev Initialize the implementation to prevent any possibility of a Parity hack. constructor() reentrancyGuardInitializer {} - /// @notice hyperchain diamond contract initialization + /// @notice ZK chain diamond contract initialization /// @return Magic 32 bytes, which indicates that the contract logic is expected to be used as a diamond proxy /// initializer function initialize(InitializeData calldata _initializeData) external reentrancyGuardInitializer returns (bytes32) { @@ -40,10 +39,10 @@ contract DiamondInit is ZkSyncHyperchainBase, IDiamondInit { if (_initializeData.bridgehub == address(0)) { revert ZeroAddress(); } - if (_initializeData.stateTransitionManager == address(0)) { + if (_initializeData.chainTypeManager == address(0)) { revert ZeroAddress(); } - if (_initializeData.baseToken == address(0)) { + if (_initializeData.baseTokenAssetId == bytes32(0)) { revert ZeroAddress(); } if (_initializeData.baseTokenBridge == address(0)) { @@ -55,8 +54,8 @@ contract DiamondInit is ZkSyncHyperchainBase, IDiamondInit { s.chainId = _initializeData.chainId; s.bridgehub = _initializeData.bridgehub; - s.stateTransitionManager = _initializeData.stateTransitionManager; - s.baseToken = _initializeData.baseToken; + s.chainTypeManager = _initializeData.chainTypeManager; + s.baseTokenAssetId = _initializeData.baseTokenAssetId; s.baseTokenBridge = _initializeData.baseTokenBridge; s.protocolVersion = _initializeData.protocolVersion; @@ -73,8 +72,6 @@ contract DiamondInit is ZkSyncHyperchainBase, IDiamondInit { s.blobVersionedHashRetriever = _initializeData.blobVersionedHashRetriever; s.priorityTree.setup(s.priorityQueue.getTotalPriorityTxs()); - s.baseTokenAssetId = IBridgehub(_initializeData.bridgehub).baseTokenAssetId(_initializeData.chainId); - // While this does not provide a protection in the production, it is needed for local testing // Length of the L2Log encoding should not be equal to the length of other L2Logs' tree nodes preimages assert(L2_TO_L1_LOG_SERIALIZE_SIZE != 2 * 32); diff --git a/l1-contracts/contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol b/l1-contracts/contracts/state-transition/chain-deps/ZKChainStorage.sol similarity index 92% rename from l1-contracts/contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol rename to l1-contracts/contracts/state-transition/chain-deps/ZKChainStorage.sol index 636756d43..3205a229e 100644 --- a/l1-contracts/contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol +++ b/l1-contracts/contracts/state-transition/chain-deps/ZKChainStorage.sol @@ -3,7 +3,7 @@ pragma solidity 0.8.24; import {IVerifier, VerifierParams} from "../chain-interfaces/IVerifier.sol"; -// import {IStateTransitionManager} from "../IStateTransitionManager.sol"; +// import {IChainTypeManager} from "../IChainTypeManager.sol"; import {PriorityQueue} from "../../state-transition/libraries/PriorityQueue.sol"; import {PriorityTree} from "../../state-transition/libraries/PriorityTree.sol"; @@ -60,16 +60,16 @@ struct FeeParams { uint64 minimalL2GasPrice; } -/// @dev storing all storage variables for hyperchain diamond facets +/// @dev storing all storage variables for ZK chain diamond facets /// NOTE: It is used in a proxy, so it is possible to add new variables to the end /// but NOT to modify already existing variables or change their order. /// NOTE: variables prefixed with '__DEPRECATED_' are deprecated and shouldn't be used. /// Their presence is maintained for compatibility and to prevent storage collision. // solhint-disable-next-line gas-struct-packing -struct ZkSyncHyperchainStorage { +struct ZKChainStorage { /// @dev Storage of variables needed for deprecated diamond cut facet uint256[7] __DEPRECATED_diamondCutStorage; - /// @notice Address which will exercise critical changes to the Diamond Proxy (upgrades, freezing & unfreezing). Replaced by STM + /// @notice Address which will exercise critical changes to the Diamond Proxy (upgrades, freezing & unfreezing). Replaced by CTM address __DEPRECATED_governor; /// @notice Address that the governor proposed as one that will replace it address __DEPRECATED_pendingGovernor; @@ -134,17 +134,20 @@ struct ZkSyncHyperchainStorage { address pendingAdmin; /// @dev Fee params used to derive gasPrice for the L1->L2 transactions. For L2 transactions, /// the bootloader gives enough freedom to the operator. + /// @dev The value is only for the L1 deployment of the ZK Chain, since payment for all the priority transactions is + /// charged at that level. FeeParams feeParams; /// @dev Address of the blob versioned hash getter smart contract used for EIP-4844 versioned hashes. + /// @dev Used only for testing. address blobVersionedHashRetriever; /// @dev The chainId of the chain uint256 chainId; /// @dev The address of the bridgehub address bridgehub; - /// @dev The address of the StateTransitionManager - address stateTransitionManager; + /// @dev The address of the ChainTypeManager + address chainTypeManager; /// @dev The address of the baseToken contract. Eth is address(1) - address baseToken; + address __DEPRECATED_baseToken; /// @dev The address of the baseTokenbridge. Eth also uses the shared bridge address baseTokenBridge; /// @notice gasPriceMultiplier for each baseToken, so that each L1->L2 transaction pays for its transaction on the destination @@ -161,7 +164,8 @@ struct ZkSyncHyperchainStorage { address l2DAValidator; /// @dev the Asset Id of the baseToken bytes32 baseTokenAssetId; - /// @dev address of the synclayer, only set on L1 if settling on it + /// @dev If this ZKchain settles on this chain, then this is zero. Otherwise it is the address of the ZKchain that is a + /// settlement layer for this ZKchain. (think about it as a 'forwarding' address for the chain that migrated away). address settlementLayer; /// @dev Priority tree, the new data structure for priority queue PriorityTree.Tree priorityTree; diff --git a/l1-contracts/contracts/state-transition/chain-deps/facets/Admin.sol b/l1-contracts/contracts/state-transition/chain-deps/facets/Admin.sol index 20ce1f5c9..27bbe3155 100644 --- a/l1-contracts/contracts/state-transition/chain-deps/facets/Admin.sol +++ b/l1-contracts/contracts/state-transition/chain-deps/facets/Admin.sol @@ -2,30 +2,45 @@ pragma solidity 0.8.24; +// solhint-disable gas-custom-errors, reason-string + import {IAdmin} from "../../chain-interfaces/IAdmin.sol"; import {Diamond} from "../../libraries/Diamond.sol"; -import {MAX_GAS_PER_TRANSACTION, HyperchainCommitment} from "../../../common/Config.sol"; -import {FeeParams, PubdataPricingMode} from "../ZkSyncHyperchainStorage.sol"; +import {MAX_GAS_PER_TRANSACTION, ZKChainCommitment} from "../../../common/Config.sol"; +import {FeeParams, PubdataPricingMode} from "../ZKChainStorage.sol"; import {PriorityTree} from "../../../state-transition/libraries/PriorityTree.sol"; import {PriorityQueue} from "../../../state-transition/libraries/PriorityQueue.sol"; -import {ZkSyncHyperchainBase} from "./ZkSyncHyperchainBase.sol"; -import {IStateTransitionManager} from "../../IStateTransitionManager.sol"; +import {ZKChainBase} from "./ZKChainBase.sol"; +import {IChainTypeManager} from "../../IChainTypeManager.sol"; import {IL1GenesisUpgrade} from "../../../upgrades/IL1GenesisUpgrade.sol"; import {Unauthorized, TooMuchGas, PriorityTxPubdataExceedsMaxPubDataPerBatch, InvalidPubdataPricingMode, ProtocolIdMismatch, ChainAlreadyLive, HashMismatch, ProtocolIdNotGreater, DenominatorIsZero, DiamondAlreadyFrozen, DiamondNotFrozen} from "../../../common/L1ContractErrors.sol"; // While formally the following import is not used, it is needed to inherit documentation from it -import {IZkSyncHyperchainBase} from "../../chain-interfaces/IZkSyncHyperchainBase.sol"; +import {IZKChainBase} from "../../chain-interfaces/IZKChainBase.sol"; /// @title Admin Contract controls access rights for contract management. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -contract AdminFacet is ZkSyncHyperchainBase, IAdmin { +contract AdminFacet is ZKChainBase, IAdmin { using PriorityTree for PriorityTree.Tree; using PriorityQueue for PriorityQueue.Queue; - /// @inheritdoc IZkSyncHyperchainBase + /// @inheritdoc IZKChainBase string public constant override getName = "AdminFacet"; + /// @notice The chain id of L1. This contract can be deployed on multiple layers, but this value is still equal to the + /// L1 that is at the most base layer. + uint256 internal immutable L1_CHAIN_ID; + + constructor(uint256 _l1ChainId) { + L1_CHAIN_ID = _l1ChainId; + } + + modifier onlyL1() { + require(block.chainid == L1_CHAIN_ID, "AdminFacet: not L1"); + _; + } + /// @inheritdoc IAdmin function setPendingAdmin(address _newPendingAdmin) external onlyAdmin { // Save previous value into the stack to put it into the event later @@ -52,20 +67,20 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { } /// @inheritdoc IAdmin - function setValidator(address _validator, bool _active) external onlyStateTransitionManager { + function setValidator(address _validator, bool _active) external onlyChainTypeManager { s.validators[_validator] = _active; emit ValidatorStatusUpdate(_validator, _active); } /// @inheritdoc IAdmin - function setPorterAvailability(bool _zkPorterIsAvailable) external onlyStateTransitionManager { + function setPorterAvailability(bool _zkPorterIsAvailable) external onlyChainTypeManager { // Change the porter availability s.zkPorterIsAvailable = _zkPorterIsAvailable; emit IsPorterAvailableStatusUpdate(_zkPorterIsAvailable); } /// @inheritdoc IAdmin - function setPriorityTxMaxGasLimit(uint256 _newPriorityTxMaxGasLimit) external onlyStateTransitionManager { + function setPriorityTxMaxGasLimit(uint256 _newPriorityTxMaxGasLimit) external onlyChainTypeManager { if (_newPriorityTxMaxGasLimit > MAX_GAS_PER_TRANSACTION) { revert TooMuchGas(); } @@ -76,7 +91,7 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { } /// @inheritdoc IAdmin - function changeFeeParams(FeeParams calldata _newFeeParams) external onlyAdminOrStateTransitionManager { + function changeFeeParams(FeeParams calldata _newFeeParams) external onlyAdminOrChainTypeManager onlyL1 { // Double checking that the new fee params are valid, i.e. // the maximal pubdata per batch is not less than the maximal pubdata per priority transaction. if (_newFeeParams.maxPubdataPerBatch < _newFeeParams.priorityTxMaxPubdata) { @@ -96,7 +111,7 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { } /// @inheritdoc IAdmin - function setTokenMultiplier(uint128 _nominator, uint128 _denominator) external onlyAdminOrStateTransitionManager { + function setTokenMultiplier(uint128 _nominator, uint128 _denominator) external onlyAdminOrChainTypeManager { if (_denominator == 0) { revert DenominatorIsZero(); } @@ -110,7 +125,7 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { } /// @inheritdoc IAdmin - function setPubdataPricingMode(PubdataPricingMode _pricingMode) external onlyAdmin { + function setPubdataPricingMode(PubdataPricingMode _pricingMode) external onlyAdmin onlyL1 { // Validium mode can be set only before the first batch is processed if (s.totalBatchesCommitted != 0) { revert ChainAlreadyLive(); @@ -120,7 +135,7 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { } /// @inheritdoc IAdmin - function setTransactionFilterer(address _transactionFilterer) external onlyAdmin { + function setTransactionFilterer(address _transactionFilterer) external onlyAdmin onlyL1 { address oldTransactionFilterer = s.transactionFilterer; s.transactionFilterer = _transactionFilterer; emit NewTransactionFilterer(oldTransactionFilterer, _transactionFilterer); @@ -130,14 +145,11 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { /// @dev It does not check for these addresses to be non-zero, since when migrating to a new settlement /// layer, we set them to zero. function _setDAValidatorPair(address _l1DAValidator, address _l2DAValidator) internal { - address oldL1DAValidator = s.l1DAValidator; - address oldL2DAValidator = s.l2DAValidator; + emit NewL1DAValidator(s.l1DAValidator, _l1DAValidator); + emit NewL2DAValidator(s.l2DAValidator, _l2DAValidator); s.l1DAValidator = _l1DAValidator; s.l2DAValidator = _l2DAValidator; - - emit NewL1DAValidator(oldL1DAValidator, _l1DAValidator); - emit NewL2DAValidator(oldL2DAValidator, _l2DAValidator); } /// @inheritdoc IAdmin @@ -156,9 +168,9 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { function upgradeChainFromVersion( uint256 _oldProtocolVersion, Diamond.DiamondCutData calldata _diamondCut - ) external onlyAdminOrStateTransitionManager { + ) external onlyAdminOrChainTypeManager { bytes32 cutHashInput = keccak256(abi.encode(_diamondCut)); - bytes32 upgradeCutHash = IStateTransitionManager(s.stateTransitionManager).upgradeCutHash(_oldProtocolVersion); + bytes32 upgradeCutHash = IChainTypeManager(s.chainTypeManager).upgradeCutHash(_oldProtocolVersion); if (cutHashInput != upgradeCutHash) { revert HashMismatch(upgradeCutHash, cutHashInput); } @@ -174,7 +186,7 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { } /// @inheritdoc IAdmin - function executeUpgrade(Diamond.DiamondCutData calldata _diamondCut) external onlyStateTransitionManager { + function executeUpgrade(Diamond.DiamondCutData calldata _diamondCut) external onlyChainTypeManager { Diamond.diamondCut(_diamondCut); emit ExecuteUpgrade(_diamondCut); } @@ -182,16 +194,17 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { /// @dev we have to set the chainId at genesis, as blockhashzero is the same for all chains with the same chainId function genesisUpgrade( address _l1GenesisUpgrade, + address _ctmDeployer, bytes calldata _forceDeploymentData, bytes[] calldata _factoryDeps - ) external onlyStateTransitionManager { + ) external onlyChainTypeManager { Diamond.FacetCut[] memory emptyArray; Diamond.DiamondCutData memory cutData = Diamond.DiamondCutData({ facetCuts: emptyArray, initAddress: _l1GenesisUpgrade, initCalldata: abi.encodeCall( IL1GenesisUpgrade.genesisUpgrade, - (_l1GenesisUpgrade, s.chainId, s.protocolVersion, _forceDeploymentData, _factoryDeps) + (_l1GenesisUpgrade, s.chainId, s.protocolVersion, _ctmDeployer, _forceDeploymentData, _factoryDeps) ) }); @@ -203,7 +216,7 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { //////////////////////////////////////////////////////////////*/ /// @inheritdoc IAdmin - function freezeDiamond() external onlyStateTransitionManager { + function freezeDiamond() external onlyChainTypeManager { Diamond.DiamondStorage storage diamondStorage = Diamond.getDiamondStorage(); // diamond proxy is frozen already @@ -216,7 +229,7 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { } /// @inheritdoc IAdmin - function unfreezeDiamond() external onlyStateTransitionManager { + function unfreezeDiamond() external onlyChainTypeManager { Diamond.DiamondStorage storage diamondStorage = Diamond.getDiamondStorage(); // diamond proxy is not frozen @@ -235,27 +248,40 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { /// @inheritdoc IAdmin function forwardedBridgeBurn( address _settlementLayer, - address _prevMsgSender, - bytes calldata + address _originalCaller, + bytes calldata _data ) external payable override onlyBridgehub returns (bytes memory chainBridgeMintData) { - // (address _newSettlementLayerAdmin, bytes memory _diamondCut) = abi.decode(_data, (address, bytes)); require(s.settlementLayer == address(0), "Af: already migrated"); - require(_prevMsgSender == s.admin, "Af: not chainAdmin"); - IStateTransitionManager stm = IStateTransitionManager(s.stateTransitionManager); + require(_originalCaller == s.admin, "Af: not chainAdmin"); + // As of now all we need in this function is the chainId so we encode it and pass it down in the _chainData field + uint256 protocolVersion = abi.decode(_data, (uint256)); - // address chainBaseToken = hyperchain.getBaseToken(); uint256 currentProtocolVersion = s.protocolVersion; - uint256 protocolVersion = stm.protocolVersion(); - require(currentProtocolVersion == protocolVersion, "STM: protocolVersion not up to date"); + require(currentProtocolVersion == protocolVersion, "CTM: protocolVersion not up to date"); + + if (block.chainid != L1_CHAIN_ID) { + // We assume that GW -> L1 transactions can never fail and provide no recovery mechanism from it. + // That's why we need to bound the gas that can be consumed during such a migration. + require(s.totalBatchesCommitted == s.totalBatchesExecuted, "Af: not all batches executed"); + } s.settlementLayer = _settlementLayer; - chainBridgeMintData = abi.encode(_prepareChainCommitment()); + chainBridgeMintData = abi.encode(prepareChainCommitment()); } /// @inheritdoc IAdmin - function forwardedBridgeMint(bytes calldata _data) external payable override onlyBridgehub { - HyperchainCommitment memory _commitment = abi.decode(_data, (HyperchainCommitment)); + function forwardedBridgeMint( + bytes calldata _data, + bool _contractAlreadyDeployed + ) external payable override onlyBridgehub { + ZKChainCommitment memory _commitment = abi.decode(_data, (ZKChainCommitment)); + + IChainTypeManager ctm = IChainTypeManager(s.chainTypeManager); + + uint256 currentProtocolVersion = s.protocolVersion; + uint256 protocolVersion = ctm.protocolVersion(); + require(currentProtocolVersion == protocolVersion, "CTM: protocolVersion not up to date"); uint256 batchesExecuted = _commitment.totalBatchesExecuted; uint256 batchesVerified = _commitment.totalBatchesVerified; @@ -284,26 +310,62 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { s.storedBatchHashes[batchesExecuted + i] = _commitment.batchHashes[i]; } - s.priorityTree.initFromCommitment(_commitment.priorityTree); + if (block.chainid == L1_CHAIN_ID) { + // L1 PTree contains all L1->L2 transactions. + require( + s.priorityTree.isHistoricalRoot( + _commitment.priorityTree.sides[_commitment.priorityTree.sides.length - 1] + ), + "Admin: not historical root" + ); + require(_contractAlreadyDeployed, "Af: contract not deployed"); + require(s.settlementLayer != address(0), "Af: not migrated"); + s.priorityTree.checkL1Reinit(_commitment.priorityTree); + } else if (_contractAlreadyDeployed) { + require(s.settlementLayer != address(0), "Af: not migrated 2"); + s.priorityTree.checkGWReinit(_commitment.priorityTree); + s.priorityTree.initFromCommitment(_commitment.priorityTree); + } else { + s.priorityTree.initFromCommitment(_commitment.priorityTree); + } s.l2SystemContractsUpgradeTxHash = _commitment.l2SystemContractsUpgradeTxHash; s.l2SystemContractsUpgradeBatchNumber = _commitment.l2SystemContractsUpgradeBatchNumber; + // Set the settlement to 0 - as this is the current settlement chain. + s.settlementLayer = address(0); + _setDAValidatorPair(address(0), address(0)); emit MigrationComplete(); } /// @inheritdoc IAdmin - function forwardedBridgeClaimFailedBurn( - uint256 _chainId, - bytes32 _assetInfo, - address _prevMsgSender, - bytes calldata _data - ) external payable override onlyBridgehub {} + /// @dev Note that this function does not check that the caller is the chain admin. + function forwardedBridgeRecoverFailedTransfer( + uint256 /* _chainId */, + bytes32 /* _assetInfo */, + address _depositSender, + bytes calldata _chainData + ) external payable override onlyBridgehub { + // As of now all we need in this function is the chainId so we encode it and pass it down in the _chainData field + uint256 protocolVersion = abi.decode(_chainData, (uint256)); + + require(s.settlementLayer != address(0), "Af: not migrated"); + // Sanity check that the _depositSender is the chain admin. + require(_depositSender == s.admin, "Af: not chainAdmin"); + + uint256 currentProtocolVersion = s.protocolVersion; + + require(currentProtocolVersion == protocolVersion, "CTM: protocolVersion not up to date"); - // todo make internal. For now useful for testing - function _prepareChainCommitment() public view returns (HyperchainCommitment memory commitment) { + s.settlementLayer = address(0); + } + + /// @notice Returns the commitment for a chain. + /// @dev Note, that this is a getter method helpful for debugging and should not be relied upon by clients. + /// @return commitment The commitment for the chain. + function prepareChainCommitment() public view returns (ZKChainCommitment memory commitment) { require(s.priorityQueue.getFirstUnprocessedPriorityTx() >= s.priorityTree.startIndex, "PQ not ready"); commitment.totalBatchesCommitted = s.totalBatchesCommitted; @@ -335,42 +397,4 @@ contract AdminFacet is ZkSyncHyperchainBase, IAdmin { commitment.batchHashes = batchHashes; } - - /// @inheritdoc IAdmin - function readChainCommitment() external view override returns (bytes memory commitment) { - return abi.encode(_prepareChainCommitment()); - } - - // function recoverFromFailedMigrationToGateway( - // uint256 _settlementLayerChainId, - // uint256 _l2BatchNumber, - // uint256 _l2MessageIndex, - // uint16 _l2TxNumberInBatch, - // bytes32[] calldata _merkleProof - // ) external onlyAdmin { - // require(s.settlementLayerState == SettlementLayerState.MigratedFromL1, "not migrated L1"); - - // bytes32 migrationHash = s.settlementLayerMigrationHash; - // require(migrationHash != bytes32(0), "can not recover when there is no migration"); - - // require( - // IBridgehub(s.bridgehub).proveL1ToL2TransactionStatus( - // _settlementLayerChainId, - // migrationHash, - // _l2BatchNumber, - // _l2MessageIndex, - // _l2TxNumberInBatch, - // _merkleProof, - // TxStatus.Failure - // ), - // "Migration not failed" - // ); - - // s.settlementLayerState = SettlementLayerState.ActiveOnL1; - // s.settlementLayerChainId = 0; - // s.settlementLayerMigrationHash = bytes32(0); - - // // We do not need to perform any additional actions, since no changes related to the chain commitment can be performed - // // while the chain is in the "migrated" state. - // } } diff --git a/l1-contracts/contracts/state-transition/chain-deps/facets/Executor.sol b/l1-contracts/contracts/state-transition/chain-deps/facets/Executor.sol index 7fb021060..0875d2e95 100644 --- a/l1-contracts/contracts/state-transition/chain-deps/facets/Executor.sol +++ b/l1-contracts/contracts/state-transition/chain-deps/facets/Executor.sol @@ -2,40 +2,49 @@ pragma solidity 0.8.24; -import {ZkSyncHyperchainBase} from "./ZkSyncHyperchainBase.sol"; +// solhint-disable gas-custom-errors, reason-string + +import {ZKChainBase} from "./ZKChainBase.sol"; import {IBridgehub} from "../../../bridgehub/IBridgehub.sol"; import {IMessageRoot} from "../../../bridgehub/IMessageRoot.sol"; import {COMMIT_TIMESTAMP_NOT_OLDER, COMMIT_TIMESTAMP_APPROXIMATION_DELTA, EMPTY_STRING_KECCAK, L2_TO_L1_LOG_SERIALIZE_SIZE, MAX_L2_TO_L1_LOGS_COMMITMENT_BYTES, PACKED_L2_BLOCK_TIMESTAMP_MASK, PUBLIC_INPUT_SHIFT} from "../../../common/Config.sol"; -import {IExecutor, L2_LOG_ADDRESS_OFFSET, L2_LOG_KEY_OFFSET, L2_LOG_VALUE_OFFSET, SystemLogKey, LogProcessingOutput, MAX_NUMBER_OF_BLOBS, TOTAL_BLOBS_IN_COMMITMENT} from "../../chain-interfaces/IExecutor.sol"; +import {IExecutor, L2_LOG_ADDRESS_OFFSET, L2_LOG_KEY_OFFSET, L2_LOG_VALUE_OFFSET, SystemLogKey, LogProcessingOutput, TOTAL_BLOBS_IN_COMMITMENT} from "../../chain-interfaces/IExecutor.sol"; import {PriorityQueue, PriorityOperation} from "../../libraries/PriorityQueue.sol"; +import {BatchDecoder} from "../../libraries/BatchDecoder.sol"; import {UncheckedMath} from "../../../common/libraries/UncheckedMath.sol"; import {UnsafeBytes} from "../../../common/libraries/UnsafeBytes.sol"; import {L2_BOOTLOADER_ADDRESS, L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR, L2_SYSTEM_CONTEXT_SYSTEM_CONTRACT_ADDR} from "../../../common/L2ContractAddresses.sol"; -import {IStateTransitionManager} from "../../IStateTransitionManager.sol"; +import {IChainTypeManager} from "../../IChainTypeManager.sol"; import {PriorityTree, PriorityOpsBatchInfo} from "../../libraries/PriorityTree.sol"; import {IL1DAValidator, L1DAValidatorOutput} from "../../chain-interfaces/IL1DAValidator.sol"; -import {BatchNumberMismatch, TimeNotReached, TooManyBlobs, ValueMismatch, InvalidPubdataMode, InvalidPubdataLength, HashMismatch, NonIncreasingTimestamp, TimestampError, InvalidLogSender, TxHashMismatch, UnexpectedSystemLog, MissingSystemLogs, LogAlreadyProcessed, InvalidProtocolVersion, CanOnlyProcessOneBatch, BatchHashMismatch, UpgradeBatchNumberIsNotZero, NonSequentialBatch, CantExecuteUnprovenBatches, SystemLogsSizeTooBig, InvalidNumberOfBlobs, VerifiedBatchesExceedsCommittedBatches, InvalidProof, RevertedBatchNotAfterNewLastBatch, CantRevertExecutedBatch, PointEvalFailed, EmptyBlobVersionHash, NonEmptyBlobVersionHash, BlobHashCommitmentError, CalldataLengthTooBig, InvalidPubdataHash, L2TimestampTooBig, PriorityOperationsRollingHashMismatch, PubdataCommitmentsEmpty, PointEvalCallFailed, PubdataCommitmentsTooBig, InvalidPubdataCommitmentsSize} from "../../../common/L1ContractErrors.sol"; +import {MissingSystemLogs, BatchNumberMismatch, TimeNotReached, ValueMismatch, HashMismatch, NonIncreasingTimestamp, TimestampError, InvalidLogSender, TxHashMismatch, UnexpectedSystemLog, LogAlreadyProcessed, InvalidProtocolVersion, CanOnlyProcessOneBatch, BatchHashMismatch, UpgradeBatchNumberIsNotZero, NonSequentialBatch, CantExecuteUnprovenBatches, SystemLogsSizeTooBig, InvalidNumberOfBlobs, VerifiedBatchesExceedsCommittedBatches, InvalidProof, RevertedBatchNotAfterNewLastBatch, CantRevertExecutedBatch, L2TimestampTooBig, PriorityOperationsRollingHashMismatch} from "../../../common/L1ContractErrors.sol"; // While formally the following import is not used, it is needed to inherit documentation from it -import {IZkSyncHyperchainBase} from "../../chain-interfaces/IZkSyncHyperchainBase.sol"; +import {IZKChainBase} from "../../chain-interfaces/IZKChainBase.sol"; -/// @title ZKsync hyperchain Executor contract capable of processing events emitted in the ZKsync hyperchain protocol. +/// @title ZK chain Executor contract capable of processing events emitted in the ZK chain protocol. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { +contract ExecutorFacet is ZKChainBase, IExecutor { using UncheckedMath for uint256; using PriorityQueue for PriorityQueue.Queue; using PriorityTree for PriorityTree.Tree; - /// @inheritdoc IZkSyncHyperchainBase + /// @inheritdoc IZKChainBase string public constant override getName = "ExecutorFacet"; + /// @dev Checks that the chain is connected to the current bridehub and not migrated away. + modifier chainOnCurrentBridgehub() { + require(s.settlementLayer == address(0), "Chain was migrated"); + _; + } + /// @dev Process one batch commit using the previous batch StoredBatchInfo /// @dev returns new batch StoredBatchInfo /// @notice Does not change storage function _commitOneBatch( StoredBatchInfo memory _previousBatch, - CommitBatchInfo calldata _newBatch, + CommitBatchInfo memory _newBatch, bytes32 _expectedSystemContractUpgradeTxHash ) internal returns (StoredBatchInfo memory) { // only commit next batch @@ -47,12 +56,13 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { // Get the chained hash of priority transaction hashes. LogProcessingOutput memory logOutput = _processL2Logs(_newBatch, _expectedSystemContractUpgradeTxHash); - L1DAValidatorOutput memory daOutput = IL1DAValidator(s.l1DAValidator).checkDA( - s.chainId, - logOutput.l2DAValidatorOutputHash, - _newBatch.operatorDAInput, - TOTAL_BLOBS_IN_COMMITMENT - ); + L1DAValidatorOutput memory daOutput = IL1DAValidator(s.l1DAValidator).checkDA({ + _chainId: s.chainId, + _batchNumber: uint256(_newBatch.batchNumber), + _l2DAValidatorOutputHash: logOutput.l2DAValidatorOutputHash, + _operatorDAInput: _newBatch.operatorDAInput, + _maxBlobsSupported: TOTAL_BLOBS_IN_COMMITMENT + }); if (_previousBatch.batchHash != logOutput.previousBatchHash) { revert HashMismatch(logOutput.previousBatchHash, _previousBatch.batchHash); @@ -132,7 +142,7 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { /// SystemLogKey enum in Constants.sol is processed per new batch. /// @dev Data returned from here will be used to form the batch commitment. function _processL2Logs( - CommitBatchInfo calldata _newBatch, + CommitBatchInfo memory _newBatch, bytes32 _expectedSystemContractUpgradeTxHash ) internal view returns (LogProcessingOutput memory logOutput) { // Copy L2 to L1 logs into memory. @@ -186,10 +196,14 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { } logOutput.numberOfLayer1Txs = uint256(logValue); } else if (logKey == uint256(SystemLogKey.USED_L2_DA_VALIDATOR_ADDRESS_KEY)) { - require(logSender == L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR, "vk"); + if (logSender != L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR) { + revert InvalidLogSender(logSender, logKey); + } require(s.l2DAValidator == address(uint160(uint256(logValue))), "lo"); } else if (logKey == uint256(SystemLogKey.L2_DA_VALIDATOR_OUTPUT_HASH_KEY)) { - require(logSender == L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR, "lp2"); + if (logSender != L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR) { + revert InvalidLogSender(logSender, logKey); + } logOutput.l2DAValidatorOutputHash = logValue; } else if (logKey == uint256(SystemLogKey.EXPECTED_SYSTEM_CONTRACT_UPGRADE_TX_HASH_KEY)) { if (logSender != L2_BOOTLOADER_ADDRESS) { @@ -203,40 +217,25 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { } } - // FIXME: temporarily old logs were kept for backwards compatibility. This check cannot work now. - // // We only require 8 logs to be checked, the 9th is if we are expecting a protocol upgrade // Without the protocol upgrade we expect 8 logs: 2^8 - 1 = 255 // With the protocol upgrade we expect 9 logs: 2^9 - 1 = 511 if (_expectedSystemContractUpgradeTxHash == bytes32(0)) { - // require(processedLogs == 255, "b7"); - } else { - // FIXME: do restore this code to the one that was before - require(_checkBit(processedLogs, uint8(SystemLogKey.EXPECTED_SYSTEM_CONTRACT_UPGRADE_TX_HASH_KEY)), "b8"); + if (processedLogs != 127) { + revert MissingSystemLogs(127, processedLogs); + } + } else if (processedLogs != 255) { + revert MissingSystemLogs(255, processedLogs); } } - /// @inheritdoc IExecutor - function commitBatches( - StoredBatchInfo calldata _lastCommittedBatchData, - CommitBatchInfo[] calldata _newBatchesData - ) external nonReentrant onlyValidator { - _commitBatches(_lastCommittedBatchData, _newBatchesData); - } - /// @inheritdoc IExecutor function commitBatchesSharedBridge( uint256, // _chainId - StoredBatchInfo calldata _lastCommittedBatchData, - CommitBatchInfo[] calldata _newBatchesData - ) external nonReentrant onlyValidator { - _commitBatches(_lastCommittedBatchData, _newBatchesData); - } - - function _commitBatches( - StoredBatchInfo memory _lastCommittedBatchData, - CommitBatchInfo[] calldata _newBatchesData - ) internal { + uint256 _processFrom, + uint256 _processTo, + bytes calldata _commitData + ) external nonReentrant onlyValidator chainOnCurrentBridgehub { // check that we have the right protocol version // three comments: // 1. A chain has to keep their protocol version up to date, as processing a block requires the latest or previous protocol version @@ -244,35 +243,39 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { // 2. A chain might become out of sync if it launches while we are in the middle of a protocol upgrade. This would mean they cannot process their genesis upgrade // as their protocolversion would be outdated, and they also cannot process the protocol upgrade tx as they have a pending upgrade. // 3. The protocol upgrade is increased in the BaseZkSyncUpgrade, in the executor only the systemContractsUpgradeTxHash is checked - if (!IStateTransitionManager(s.stateTransitionManager).protocolVersionIsActive(s.protocolVersion)) { + if (!IChainTypeManager(s.chainTypeManager).protocolVersionIsActive(s.protocolVersion)) { revert InvalidProtocolVersion(); } + (StoredBatchInfo memory lastCommittedBatchData, CommitBatchInfo[] memory newBatchesData) = BatchDecoder + .decodeAndCheckCommitData(_commitData, _processFrom, _processTo); // With the new changes for EIP-4844, namely the restriction on number of blobs per block, we only allow for a single batch to be committed at a time. - if (_newBatchesData.length != 1) { + // Note: Don't need to check that `_processFrom` == `_processTo` because there is only one batch, + // and so the range checked in the `decodeAndCheckCommitData` is enough. + if (newBatchesData.length != 1) { revert CanOnlyProcessOneBatch(); } // Check that we commit batches after last committed batch - if (s.storedBatchHashes[s.totalBatchesCommitted] != _hashStoredBatchInfo(_lastCommittedBatchData)) { + if (s.storedBatchHashes[s.totalBatchesCommitted] != _hashStoredBatchInfo(lastCommittedBatchData)) { // incorrect previous batch data revert BatchHashMismatch( s.storedBatchHashes[s.totalBatchesCommitted], - _hashStoredBatchInfo(_lastCommittedBatchData) + _hashStoredBatchInfo(lastCommittedBatchData) ); } bytes32 systemContractsUpgradeTxHash = s.l2SystemContractsUpgradeTxHash; // Upgrades are rarely done so we optimize a case with no active system contracts upgrade. if (systemContractsUpgradeTxHash == bytes32(0) || s.l2SystemContractsUpgradeBatchNumber != 0) { - _commitBatchesWithoutSystemContractsUpgrade(_lastCommittedBatchData, _newBatchesData); + _commitBatchesWithoutSystemContractsUpgrade(lastCommittedBatchData, newBatchesData); } else { _commitBatchesWithSystemContractsUpgrade( - _lastCommittedBatchData, - _newBatchesData, + lastCommittedBatchData, + newBatchesData, systemContractsUpgradeTxHash ); } - s.totalBatchesCommitted = s.totalBatchesCommitted + _newBatchesData.length; + s.totalBatchesCommitted = s.totalBatchesCommitted + newBatchesData.length; } /// @dev Commits new batches without any system contracts upgrade. @@ -280,7 +283,7 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { /// @param _newBatchesData An array of batch data that needs to be committed. function _commitBatchesWithoutSystemContractsUpgrade( StoredBatchInfo memory _lastCommittedBatchData, - CommitBatchInfo[] calldata _newBatchesData + CommitBatchInfo[] memory _newBatchesData ) internal { // We disable this check because calldata array length is cheap. // solhint-disable-next-line gas-length-in-loops @@ -302,7 +305,7 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { /// @param _systemContractUpgradeTxHash The transaction hash of the system contract upgrade. function _commitBatchesWithSystemContractsUpgrade( StoredBatchInfo memory _lastCommittedBatchData, - CommitBatchInfo[] calldata _newBatchesData, + CommitBatchInfo[] memory _newBatchesData, bytes32 _systemContractUpgradeTxHash ) internal { // The system contract upgrade is designed to be executed atomically with the new bootloader, a default account, @@ -348,7 +351,7 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { } } - function _rollingHash(bytes32[] calldata _hashes) internal pure returns (bytes32) { + function _rollingHash(bytes32[] memory _hashes) internal pure returns (bytes32) { bytes32 hash = EMPTY_STRING_KECCAK; uint256 nHashes = _hashes.length; for (uint256 i = 0; i < nHashes; i = i.uncheckedInc()) { @@ -375,7 +378,7 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { revert PriorityOperationsRollingHashMismatch(); } } - + /// @dev Executes one batch /// @dev 1. Processes all pending operations (Complete priority requests) /// @dev 2. Finalizes batch on Ethereum @@ -401,9 +404,13 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { // ); } + /// @notice Executes one batch + /// @dev 1. Processes all pending operations (Complete priority requests) + /// @dev 2. Finalizes batch + /// @dev _executedBatchIdx is an index in the array of the batches that we want to execute together function _executeOneBatch( StoredBatchInfo memory _storedBatch, - PriorityOpsBatchInfo calldata _priorityOpsData, + PriorityOpsBatchInfo memory _priorityOpsData, uint256 _executedBatchIdx ) internal { require(_priorityOpsData.itemHashes.length == _storedBatch.numberOfLayer1Txs, "zxc"); @@ -423,38 +430,26 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { /// @inheritdoc IExecutor function executeBatchesSharedBridge( - uint256, - StoredBatchInfo[] calldata _batchesData, - PriorityOpsBatchInfo[] calldata _priorityOpsData - ) external nonReentrant onlyValidator { - _executeBatches(_batchesData, _priorityOpsData); - } - - /// @inheritdoc IExecutor - function executeBatches( - StoredBatchInfo[] calldata _batchesData, - PriorityOpsBatchInfo[] calldata _priorityOpsData - ) external nonReentrant onlyValidator { - _executeBatches(_batchesData, _priorityOpsData); - } - - function _executeBatches( - StoredBatchInfo[] calldata _batchesData, - PriorityOpsBatchInfo[] calldata _priorityOpsData - ) internal { - uint256 nBatches = _batchesData.length; - require(_batchesData.length == _priorityOpsData.length, "bp"); + uint256, // _chainId + uint256 _processFrom, + uint256 _processTo, + bytes calldata _executeData + ) external nonReentrant onlyValidator chainOnCurrentBridgehub { + (StoredBatchInfo[] memory batchesData, PriorityOpsBatchInfo[] memory priorityOpsData) = BatchDecoder + .decodeAndCheckExecuteData(_executeData, _processFrom, _processTo); + uint256 nBatches = batchesData.length; + require(batchesData.length == priorityOpsData.length, "bp"); for (uint256 i = 0; i < nBatches; i = i.uncheckedInc()) { if (s.priorityTree.startIndex <= s.priorityQueue.getFirstUnprocessedPriorityTx()) { - _executeOneBatch(_batchesData[i], _priorityOpsData[i], i); + _executeOneBatch(batchesData[i], priorityOpsData[i], i); } else { - require(_priorityOpsData[i].leftPath.length == 0, "le"); - require(_priorityOpsData[i].rightPath.length == 0, "re"); - require(_priorityOpsData[i].itemHashes.length == 0, "ih"); - _executeOneBatch(_batchesData[i], i); + require(priorityOpsData[i].leftPath.length == 0, "le"); + require(priorityOpsData[i].rightPath.length == 0, "re"); + require(priorityOpsData[i].itemHashes.length == 0, "ih"); + _executeOneBatch(batchesData[i], i); } - emit BlockExecution(_batchesData[i].batchNumber, _batchesData[i].batchHash, _batchesData[i].commitment); + emit BlockExecution(batchesData[i].batchNumber, batchesData[i].batchHash, batchesData[i].commitment); } uint256 newTotalBatchesExecuted = s.totalBatchesExecuted + nBatches; @@ -470,56 +465,42 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { } } - /// @inheritdoc IExecutor - function proveBatches( - StoredBatchInfo calldata _prevBatch, - StoredBatchInfo[] calldata _committedBatches, - ProofInput calldata _proof - ) external nonReentrant onlyValidator { - _proveBatches(_prevBatch, _committedBatches, _proof); - } - /// @inheritdoc IExecutor function proveBatchesSharedBridge( uint256, // _chainId - StoredBatchInfo calldata _prevBatch, - StoredBatchInfo[] calldata _committedBatches, - ProofInput calldata _proof - ) external nonReentrant onlyValidator { - _proveBatches(_prevBatch, _committedBatches, _proof); - } + uint256 _processBatchFrom, + uint256 _processBatchTo, + bytes calldata _proofData + ) external nonReentrant onlyValidator chainOnCurrentBridgehub { + ( + StoredBatchInfo memory prevBatch, + StoredBatchInfo[] memory committedBatches, + uint256[] memory proof + ) = BatchDecoder.decodeAndCheckProofData(_proofData, _processBatchFrom, _processBatchTo); - function _proveBatches( - StoredBatchInfo calldata _prevBatch, - StoredBatchInfo[] calldata _committedBatches, - ProofInput calldata _proof - ) internal { // Save the variables into the stack to save gas on reading them later uint256 currentTotalBatchesVerified = s.totalBatchesVerified; - uint256 committedBatchesLength = _committedBatches.length; + uint256 committedBatchesLength = committedBatches.length; // Initialize the array, that will be used as public input to the ZKP uint256[] memory proofPublicInput = new uint256[](committedBatchesLength); // Check that the batch passed by the validator is indeed the first unverified batch - if (_hashStoredBatchInfo(_prevBatch) != s.storedBatchHashes[currentTotalBatchesVerified]) { - revert BatchHashMismatch( - s.storedBatchHashes[currentTotalBatchesVerified], - _hashStoredBatchInfo(_prevBatch) - ); + if (_hashStoredBatchInfo(prevBatch) != s.storedBatchHashes[currentTotalBatchesVerified]) { + revert BatchHashMismatch(s.storedBatchHashes[currentTotalBatchesVerified], _hashStoredBatchInfo(prevBatch)); } - bytes32 prevBatchCommitment = _prevBatch.commitment; + bytes32 prevBatchCommitment = prevBatch.commitment; for (uint256 i = 0; i < committedBatchesLength; i = i.uncheckedInc()) { currentTotalBatchesVerified = currentTotalBatchesVerified.uncheckedInc(); - if (_hashStoredBatchInfo(_committedBatches[i]) != s.storedBatchHashes[currentTotalBatchesVerified]) { + if (_hashStoredBatchInfo(committedBatches[i]) != s.storedBatchHashes[currentTotalBatchesVerified]) { revert BatchHashMismatch( s.storedBatchHashes[currentTotalBatchesVerified], - _hashStoredBatchInfo(_committedBatches[i]) + _hashStoredBatchInfo(committedBatches[i]) ); } - bytes32 currentBatchCommitment = _committedBatches[i].commitment; + bytes32 currentBatchCommitment = committedBatches[i].commitment; proofPublicInput[i] = _getBatchProofPublicInput(prevBatchCommitment, currentBatchCommitment); prevBatchCommitment = currentBatchCommitment; @@ -528,23 +509,19 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { revert VerifiedBatchesExceedsCommittedBatches(); } - _verifyProof(proofPublicInput, _proof); + _verifyProof(proofPublicInput, proof); emit BlocksVerification(s.totalBatchesVerified, currentTotalBatchesVerified); s.totalBatchesVerified = currentTotalBatchesVerified; } - function _verifyProof(uint256[] memory proofPublicInput, ProofInput calldata _proof) internal view { + function _verifyProof(uint256[] memory proofPublicInput, uint256[] memory _proof) internal view { // We can only process 1 batch proof at a time. if (proofPublicInput.length != 1) { revert CanOnlyProcessOneBatch(); } - bool successVerifyProof = s.verifier.verify( - proofPublicInput, - _proof.serializedProof, - _proof.recursiveAggregationInput - ); + bool successVerifyProof = s.verifier.verify(proofPublicInput, _proof); if (!successVerifyProof) { revert InvalidProof(); } @@ -559,17 +536,12 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { uint256(keccak256(abi.encodePacked(_prevBatchCommitment, _currentBatchCommitment))) >> PUBLIC_INPUT_SHIFT; } - /// @inheritdoc IExecutor - function revertBatches(uint256 _newLastBatch) external nonReentrant onlyValidatorOrStateTransitionManager { - _revertBatches(_newLastBatch); - } - /// @inheritdoc IExecutor function revertBatchesSharedBridge(uint256, uint256 _newLastBatch) external nonReentrant onlyValidator { _revertBatches(_newLastBatch); } - function _revertBatches(uint256 _newLastBatch) internal { + function _revertBatches(uint256 _newLastBatch) internal chainOnCurrentBridgehub { if (s.totalBatchesCommitted <= _newLastBatch) { revert RevertedBatchNotAfterNewLastBatch(); } @@ -593,7 +565,7 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { /// @dev Creates batch commitment from its data function _createBatchCommitment( - CommitBatchInfo calldata _newBatchData, + CommitBatchInfo memory _newBatchData, bytes32 _stateDiffHash, bytes32[] memory _blobCommitments, bytes32[] memory _blobHashes @@ -607,7 +579,7 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { return keccak256(abi.encode(passThroughDataHash, metadataHash, auxiliaryOutputHash)); } - function _batchPassThroughData(CommitBatchInfo calldata _batch) internal pure returns (bytes memory) { + function _batchPassThroughData(CommitBatchInfo memory _batch) internal pure returns (bytes memory) { return abi.encodePacked( // solhint-disable-next-line func-named-parameters @@ -631,7 +603,7 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { } function _batchAuxiliaryOutput( - CommitBatchInfo calldata _batch, + CommitBatchInfo memory _batch, bytes32 _stateDiffHash, bytes32[] memory _blobCommitments, bytes32[] memory _blobHashes @@ -677,7 +649,7 @@ contract ExecutorFacet is ZkSyncHyperchainBase, IExecutor { blobAuxOutputWords = new bytes32[](2 * TOTAL_BLOBS_IN_COMMITMENT); - for (uint256 i = 0; i < MAX_NUMBER_OF_BLOBS; ++i) { + for (uint256 i = 0; i < TOTAL_BLOBS_IN_COMMITMENT; ++i) { blobAuxOutputWords[i * 2] = _blobHashes[i]; blobAuxOutputWords[i * 2 + 1] = _blobCommitments[i]; } diff --git a/l1-contracts/contracts/state-transition/chain-deps/facets/Getters.sol b/l1-contracts/contracts/state-transition/chain-deps/facets/Getters.sol index 3bfd0e161..1ffdb5b0c 100644 --- a/l1-contracts/contracts/state-transition/chain-deps/facets/Getters.sol +++ b/l1-contracts/contracts/state-transition/chain-deps/facets/Getters.sol @@ -4,12 +4,13 @@ pragma solidity 0.8.24; import {SafeCast} from "@openzeppelin/contracts-v4/utils/math/SafeCast.sol"; -import {ZkSyncHyperchainBase} from "./ZkSyncHyperchainBase.sol"; -import {PubdataPricingMode} from "../ZkSyncHyperchainStorage.sol"; +import {ZKChainBase} from "./ZKChainBase.sol"; +import {PubdataPricingMode} from "../ZKChainStorage.sol"; import {VerifierParams} from "../../../state-transition/chain-interfaces/IVerifier.sol"; import {Diamond} from "../../libraries/Diamond.sol"; import {PriorityQueue} from "../../../state-transition/libraries/PriorityQueue.sol"; import {PriorityTree} from "../../../state-transition/libraries/PriorityTree.sol"; +import {IBridgehub} from "../../../bridgehub/IBridgehub.sol"; import {UncheckedMath} from "../../../common/libraries/UncheckedMath.sol"; import {IGetters} from "../../chain-interfaces/IGetters.sol"; import {ILegacyGetters} from "../../chain-interfaces/ILegacyGetters.sol"; @@ -17,17 +18,17 @@ import {InvalidSelector} from "../../../common/L1ContractErrors.sol"; import {SemVer} from "../../../common/libraries/SemVer.sol"; // While formally the following import is not used, it is needed to inherit documentation from it -import {IZkSyncHyperchainBase} from "../../chain-interfaces/IZkSyncHyperchainBase.sol"; +import {IZKChainBase} from "../../chain-interfaces/IZKChainBase.sol"; /// @title Getters Contract implements functions for getting contract state from outside the blockchain. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -contract GettersFacet is ZkSyncHyperchainBase, IGetters, ILegacyGetters { +contract GettersFacet is ZKChainBase, IGetters, ILegacyGetters { using UncheckedMath for uint256; using PriorityQueue for PriorityQueue.Queue; using PriorityTree for PriorityTree.Tree; - /// @inheritdoc IZkSyncHyperchainBase + /// @inheritdoc IZKChainBase string public constant override getName = "GettersFacet"; /*////////////////////////////////////////////////////////////// @@ -55,8 +56,8 @@ contract GettersFacet is ZkSyncHyperchainBase, IGetters, ILegacyGetters { } /// @inheritdoc IGetters - function getStateTransitionManager() external view returns (address) { - return s.stateTransitionManager; + function getChainTypeManager() external view returns (address) { + return s.chainTypeManager; } /// @inheritdoc IGetters @@ -66,7 +67,12 @@ contract GettersFacet is ZkSyncHyperchainBase, IGetters, ILegacyGetters { /// @inheritdoc IGetters function getBaseToken() external view returns (address) { - return s.baseToken; + return IBridgehub(s.bridgehub).baseToken(s.chainId); + } + + /// @inheritdoc IGetters + function getBaseTokenAssetId() external view returns (bytes32) { + return s.baseTokenAssetId; } /// @inheritdoc IGetters @@ -99,13 +105,14 @@ contract GettersFacet is ZkSyncHyperchainBase, IGetters, ILegacyGetters { return s.totalBatchesExecuted; } + /// @inheritdoc IGetters + function getTransactionFilterer() external view returns (address) { + return s.transactionFilterer; + } + /// @inheritdoc IGetters function getTotalPriorityTxs() external view returns (uint256) { - if (s.priorityQueue.getFirstUnprocessedPriorityTx() >= s.priorityTree.startIndex) { - return s.priorityTree.getTotalPriorityTxs(); - } else { - return s.priorityQueue.getTotalPriorityTxs(); - } + return _getTotalPriorityTxs(); } /// @inheritdoc IGetters @@ -227,7 +234,6 @@ contract GettersFacet is ZkSyncHyperchainBase, IGetters, ILegacyGetters { /// @inheritdoc IGetters function getSettlementLayer() external view returns (address) { - // TODO: consider making private so that no one relies on it return s.settlementLayer; } diff --git a/l1-contracts/contracts/state-transition/chain-deps/facets/Mailbox.sol b/l1-contracts/contracts/state-transition/chain-deps/facets/Mailbox.sol index 18781078f..48b6dd76d 100644 --- a/l1-contracts/contracts/state-transition/chain-deps/facets/Mailbox.sol +++ b/l1-contracts/contracts/state-transition/chain-deps/facets/Mailbox.sol @@ -2,10 +2,12 @@ pragma solidity 0.8.24; +// solhint-disable gas-custom-errors, reason-string + import {Math} from "@openzeppelin/contracts-v4/utils/math/Math.sol"; import {IMailbox} from "../../chain-interfaces/IMailbox.sol"; -import {IStateTransitionManager} from "../../IStateTransitionManager.sol"; +import {IChainTypeManager} from "../../IChainTypeManager.sol"; import {IBridgehub} from "../../../bridgehub/IBridgehub.sol"; import {ITransactionFilterer} from "../../chain-interfaces/ITransactionFilterer.sol"; @@ -15,37 +17,49 @@ import {PriorityTree} from "../../libraries/PriorityTree.sol"; import {TransactionValidator} from "../../libraries/TransactionValidator.sol"; import {WritePriorityOpParams, L2CanonicalTransaction, L2Message, L2Log, TxStatus, BridgehubL2TransactionRequest} from "../../../common/Messaging.sol"; import {MessageHashing} from "../../../common/libraries/MessageHashing.sol"; -import {FeeParams, PubdataPricingMode} from "../ZkSyncHyperchainStorage.sol"; +import {FeeParams, PubdataPricingMode} from "../ZKChainStorage.sol"; import {UncheckedMath} from "../../../common/libraries/UncheckedMath.sol"; import {L2ContractHelper} from "../../../common/libraries/L2ContractHelper.sol"; import {AddressAliasHelper} from "../../../vendor/AddressAliasHelper.sol"; -import {ZkSyncHyperchainBase} from "./ZkSyncHyperchainBase.sol"; -import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, L1_GAS_PER_PUBDATA_BYTE, L2_L1_LOGS_TREE_DEFAULT_LEAF_HASH, PRIORITY_OPERATION_L2_TX_TYPE, PRIORITY_EXPIRATION, MAX_NEW_FACTORY_DEPS, VIRTUAL_SENDER_ALIASED_ZERO_ADDRESS} from "../../../common/Config.sol"; +import {ZKChainBase} from "./ZKChainBase.sol"; +import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, L1_GAS_PER_PUBDATA_BYTE, L2_L1_LOGS_TREE_DEFAULT_LEAF_HASH, PRIORITY_OPERATION_L2_TX_TYPE, PRIORITY_EXPIRATION, MAX_NEW_FACTORY_DEPS, SETTLEMENT_LAYER_RELAY_SENDER, SUPPORTED_PROOF_METADATA_VERSION} from "../../../common/Config.sol"; import {L2_BOOTLOADER_ADDRESS, L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR, L2_BRIDGEHUB_ADDR} from "../../../common/L2ContractAddresses.sol"; -import {IL1AssetRouter} from "../../../bridge/interfaces/IL1AssetRouter.sol"; +import {IL1AssetRouter} from "../../../bridge/asset-router/IL1AssetRouter.sol"; +import {IBridgehub} from "../../../bridgehub/IBridgehub.sol"; -import {OnlyEraSupported, BatchNotExecuted, HashedLogIsDefault, BaseTokenGasPriceDenominatorNotSet, TransactionNotAllowed, GasPerPubdataMismatch, TooManyFactoryDeps, MsgValueTooLow} from "../../../common/L1ContractErrors.sol"; +import {IChainTypeManager} from "../../IChainTypeManager.sol"; +import {MerklePathEmpty, OnlyEraSupported, BatchNotExecuted, HashedLogIsDefault, BaseTokenGasPriceDenominatorNotSet, TransactionNotAllowed, GasPerPubdataMismatch, TooManyFactoryDeps, MsgValueTooLow} from "../../../common/L1ContractErrors.sol"; // While formally the following import is not used, it is needed to inherit documentation from it -import {IZkSyncHyperchainBase} from "../../chain-interfaces/IZkSyncHyperchainBase.sol"; +import {IZKChainBase} from "../../chain-interfaces/IZKChainBase.sol"; /// @title ZKsync Mailbox contract providing interfaces for L1 <-> L2 interaction. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { +contract MailboxFacet is ZKChainBase, IMailbox { using UncheckedMath for uint256; using PriorityQueue for PriorityQueue.Queue; using PriorityTree for PriorityTree.Tree; - /// @inheritdoc IZkSyncHyperchainBase + /// @inheritdoc IZKChainBase string public constant override getName = "MailboxFacet"; /// @dev Era's chainID uint256 internal immutable ERA_CHAIN_ID; - constructor(uint256 _eraChainId) { + /// @notice The chain id of L1. This contract can be deployed on multiple layers, but this value is still equal to the + /// L1 that is at the most base layer. + uint256 internal immutable L1_CHAIN_ID; + + modifier onlyL1() { + require(block.chainid == L1_CHAIN_ID, "MailboxFacet: not L1"); + _; + } + + constructor(uint256 _eraChainId, uint256 _l1ChainId) { ERA_CHAIN_ID = _eraChainId; + L1_CHAIN_ID = _l1ChainId; } /// @inheritdoc IMailbox @@ -116,13 +130,44 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { ) public view returns (bool) {} function _parseProofMetadata( - bytes32 _proofMetadata - ) internal pure returns (uint256 logLeafProofLen, uint256 batchLeafProofLen) { - bytes1 metadataVersion = bytes1(_proofMetadata[0]); - require(metadataVersion == 0x01, "Mailbox: unsupported proof metadata version"); + bytes32[] calldata _proof + ) internal pure returns (uint256 proofStartIndex, uint256 logLeafProofLen, uint256 batchLeafProofLen) { + bytes32 proofMetadata = _proof[0]; + + // We support two formats of the proofs: + // 1. The old format, where `_proof` is just a plain Merkle proof. + // 2. The new format, where the first element of the `_proof` is encoded metadata, which consists of the following: + // - first byte: metadata version (0x01). + // - second byte: length of the log leaf proof (the proof that the log belongs to a batch). + // - third byte: length of the batch leaf proof (the proof that the batch belongs to another settlement layer, if any). + // - the rest of the bytes are zeroes. + // + // In the future the old version will be disabled, and only the new version will be supported. + // For now, we need to support both for backwards compatibility. We distinguish between those based on whether the last 29 bytes are zeroes. + // It is safe, since the elements of the proof are hashes and are unlikely to have 29 zero bytes in them. + + // We shift left by 3 bytes = 24 bits to remove the top 24 bits of the metadata. + uint256 metadataAsUint256 = (uint256(proofMetadata) << 24); + + if (metadataAsUint256 == 0) { + // It is the new version + bytes1 metadataVersion = bytes1(proofMetadata); + require( + uint256(uint8(metadataVersion)) == SUPPORTED_PROOF_METADATA_VERSION, + "Mailbox: unsupported proof metadata version" + ); + + proofStartIndex = 1; + logLeafProofLen = uint256(uint8(proofMetadata[1])); + batchLeafProofLen = uint256(uint8(proofMetadata[2])); + } else { + // It is the old version - logLeafProofLen = uint256(uint8(_proofMetadata[1])); - batchLeafProofLen = uint256(uint8(_proofMetadata[2])); + // The entire proof is a merkle path + proofStartIndex = 0; + logLeafProofLen = _proof.length; + batchLeafProofLen = 0; + } } function extractSlice( @@ -136,6 +181,15 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { } } + /// @notice Extracts slice until the end of the array. + /// @dev It is used in one place in order to circumvent the stack too deep error. + function extractSliceUntilEnd( + bytes32[] calldata _proof, + uint256 _start + ) internal pure returns (bytes32[] memory slice) { + slice = extractSlice(_proof, _start, _proof.length); + } + /// @inheritdoc IMailbox function proveL2LeafInclusion( uint256 _batchNumber, @@ -152,13 +206,15 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { bytes32 _leaf, bytes32[] calldata _proof ) internal view returns (bool) { - // FIXME: maybe support legacy interface + if (_proof.length == 0) { + revert MerklePathEmpty(); + } uint256 ptr = 0; bytes32 chainIdLeaf; { - (uint256 logLeafProofLen, uint256 batchLeafProofLen) = _parseProofMetadata(_proof[ptr]); - ++ptr; + (uint256 proofStartIndex, uint256 logLeafProofLen, uint256 batchLeafProofLen) = _parseProofMetadata(_proof); + ptr = proofStartIndex; bytes32 batchSettlementRoot = Merkle.calculateRootMemory( extractSlice(_proof, ptr, ptr + logLeafProofLen), @@ -167,9 +223,14 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { ); ptr += logLeafProofLen; - // Note that this logic works only for chains that do not migrate away from the synclayer back to L1. - // Support for chains that migrate back to L1 will be added in the future. - if (s.settlementLayer == address(0)) { + // If the `batchLeafProofLen` is 0, then we assume that this is L1 contract of the top-level + // in the aggregation, i.e. the batch root is stored here on L1. + if (batchLeafProofLen == 0) { + // Double checking that the batch has been executed. + if (_batchNumber > s.totalBatchesExecuted) { + revert BatchNotExecuted(_batchNumber); + } + bytes32 correctBatchRoot = s.l2LogsRootHashes[_batchNumber]; require(correctBatchRoot != bytes32(0), "local root is 0"); return correctBatchRoot == batchSettlementRoot; @@ -195,6 +256,7 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { uint256 settlementLayerBatchNumber; uint256 settlementLayerBatchRootMask; + address settlementLayerAddress; // Preventing stack too deep error { @@ -203,14 +265,25 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { ++ptr; settlementLayerBatchNumber = uint256(settlementLayerPackedBatchInfo >> 128); settlementLayerBatchRootMask = uint256(settlementLayerPackedBatchInfo & ((1 << 128) - 1)); + + uint256 settlementLayerChainId = uint256(_proof[ptr]); + ++ptr; + + // Assuming that `settlementLayerChainId` is an honest chain, the `chainIdLeaf` should belong + // to a chain's message root only if the chain has indeed executed its batch on top of it. + // + // We trust all chains whitelisted by the Bridgehub governance. + require(IBridgehub(s.bridgehub).whitelistedSettlementLayers(settlementLayerChainId), "Mailbox: wrong CTM"); + + settlementLayerAddress = IBridgehub(s.bridgehub).getZKChain(settlementLayerChainId); } return - IMailbox(s.settlementLayer).proveL2LeafInclusion( + IMailbox(settlementLayerAddress).proveL2LeafInclusion( settlementLayerBatchNumber, settlementLayerBatchRootMask, chainIdLeaf, - extractSlice(_proof, ptr, _proof.length) + extractSliceUntilEnd(_proof, ptr) ); } @@ -221,8 +294,6 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { L2Log memory _log, bytes32[] calldata _proof ) internal view returns (bool) { - // require(_batchNumber <= s.totalBatchesExecuted, "xx"); - bytes32 hashedLog = keccak256( // solhint-disable-next-line func-named-parameters abi.encodePacked(_log.l2ShardId, _log.isService, _log.txNumberInBatch, _log.sender, _log.key, _log.value) @@ -297,21 +368,14 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { /// @inheritdoc IMailbox function requestL2TransactionToGatewayMailbox( uint256 _chainId, - L2CanonicalTransaction calldata _transaction, - bytes[] calldata _factoryDeps, bytes32 _canonicalTxHash, uint64 _expirationTimestamp - ) external override returns (bytes32 canonicalTxHash) { + ) external override onlyL1 returns (bytes32 canonicalTxHash) { require(IBridgehub(s.bridgehub).whitelistedSettlementLayers(s.chainId), "Mailbox SL: not SL"); - require( - IStateTransitionManager(s.stateTransitionManager).getHyperchain(_chainId) == msg.sender, - "Mailbox SL: not hyperchain" - ); + require(IChainTypeManager(s.chainTypeManager).getZKChain(_chainId) == msg.sender, "Mailbox SL: not zkChain"); BridgehubL2TransactionRequest memory wrappedRequest = _wrapRequest({ _chainId: _chainId, - _transaction: _transaction, - _factoryDeps: _factoryDeps, _canonicalTxHash: _canonicalTxHash, _expirationTimestamp: _expirationTimestamp }); @@ -320,30 +384,27 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { /// @inheritdoc IMailbox function bridgehubRequestL2TransactionOnGateway( - L2CanonicalTransaction calldata _transaction, - bytes[] calldata _factoryDeps, bytes32 _canonicalTxHash, uint64 _expirationTimestamp ) external override onlyBridgehub { - _writePriorityOp(_transaction, _factoryDeps, _canonicalTxHash, _expirationTimestamp); + _writePriorityOpHash(_canonicalTxHash, _expirationTimestamp); + emit NewRelayedPriorityTransaction(_getTotalPriorityTxs(), _canonicalTxHash, _expirationTimestamp); } function _wrapRequest( uint256 _chainId, - L2CanonicalTransaction calldata _transaction, - bytes[] calldata _factoryDeps, bytes32 _canonicalTxHash, uint64 _expirationTimestamp ) internal view returns (BridgehubL2TransactionRequest memory) { // solhint-disable-next-line func-named-parameters bytes memory data = abi.encodeCall( IBridgehub(s.bridgehub).forwardTransactionOnGateway, - (_chainId, _transaction, _factoryDeps, _canonicalTxHash, _expirationTimestamp) + (_chainId, _canonicalTxHash, _expirationTimestamp) ); return BridgehubL2TransactionRequest({ /// There is no sender for the wrapping, we use a virtual address. - sender: VIRTUAL_SENDER_ALIASED_ZERO_ADDRESS, + sender: SETTLEMENT_LAYER_RELAY_SENDER, contractL2: L2_BRIDGEHUB_ADDR, mintValue: 0, l2Value: 0, @@ -414,7 +475,6 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { if (request.sender != tx.origin) { request.sender = AddressAliasHelper.applyL1ToL2Alias(request.sender); } - // solhint-enable avoid-tx-origin // populate missing fields _params.expirationTimestamp = uint64(block.timestamp + PRIORITY_EXPIRATION); // Safe to cast @@ -427,8 +487,6 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { // slither-disable-next-line unused-return IMailbox(s.settlementLayer).requestL2TransactionToGatewayMailbox({ _chainId: s.chainId, - _transaction: transaction, - _factoryDeps: _params.request.factoryDeps, _canonicalTxHash: canonicalTxHash, _expirationTimestamp: _params.expirationTimestamp }); @@ -504,6 +562,14 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { bytes32 _canonicalTxHash, uint64 _expirationTimestamp ) internal { + _writePriorityOpHash(_canonicalTxHash, _expirationTimestamp); + + // Data that is needed for the operator to simulate priority queue offchain + // solhint-disable-next-line func-named-parameters + emit NewPriorityRequest(_transaction.nonce, _canonicalTxHash, _expirationTimestamp, _transaction, _factoryDeps); + } + + function _writePriorityOpHash(bytes32 _canonicalTxHash, uint64 _expirationTimestamp) internal { if (s.priorityTree.startIndex > s.priorityQueue.getFirstUnprocessedPriorityTx()) { s.priorityQueue.pushBack( PriorityOperation({ @@ -514,10 +580,6 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { ); } s.priorityTree.push(_canonicalTxHash); - - // Data that is needed for the operator to simulate priority queue offchain - // solhint-disable-next-line func-named-parameters - emit NewPriorityRequest(_transaction.nonce, _canonicalTxHash, _expirationTimestamp, _transaction, _factoryDeps); } /// @notice Hashes the L2 bytecodes and returns them in the format in which they are processed by the bootloader @@ -544,7 +606,7 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { uint16 _l2TxNumberInBatch, bytes calldata _message, bytes32[] calldata _merkleProof - ) external nonReentrant { + ) external nonReentrant onlyL1 { if (s.chainId != ERA_CHAIN_ID) { revert OnlyEraSupported(); } @@ -567,7 +629,7 @@ contract MailboxFacet is ZkSyncHyperchainBase, IMailbox { uint256 _l2GasPerPubdataByteLimit, bytes[] calldata _factoryDeps, address _refundRecipient - ) external payable returns (bytes32 canonicalTxHash) { + ) external payable onlyL1 returns (bytes32 canonicalTxHash) { if (s.chainId != ERA_CHAIN_ID) { revert OnlyEraSupported(); } diff --git a/l1-contracts/contracts/state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol b/l1-contracts/contracts/state-transition/chain-deps/facets/ZKChainBase.sol similarity index 57% rename from l1-contracts/contracts/state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol rename to l1-contracts/contracts/state-transition/chain-deps/facets/ZKChainBase.sol index 0910fcab3..45c360197 100644 --- a/l1-contracts/contracts/state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol +++ b/l1-contracts/contracts/state-transition/chain-deps/facets/ZKChainBase.sol @@ -2,17 +2,21 @@ pragma solidity 0.8.24; -import {ZkSyncHyperchainStorage} from "../ZkSyncHyperchainStorage.sol"; +import {ZKChainStorage} from "../ZKChainStorage.sol"; import {ReentrancyGuard} from "../../../common/ReentrancyGuard.sol"; - +import {PriorityQueue} from "../../libraries/PriorityQueue.sol"; +import {PriorityTree} from "../../libraries/PriorityTree.sol"; import {Unauthorized} from "../../../common/L1ContractErrors.sol"; /// @title Base contract containing functions accessible to the other facets. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -contract ZkSyncHyperchainBase is ReentrancyGuard { +contract ZKChainBase is ReentrancyGuard { + using PriorityQueue for PriorityQueue.Queue; + using PriorityTree for PriorityTree.Tree; + // slither-disable-next-line uninitialized-state - ZkSyncHyperchainStorage internal s; + ZKChainStorage internal s; /// @notice Checks that the message sender is an active admin modifier onlyAdmin() { @@ -30,8 +34,8 @@ contract ZkSyncHyperchainBase is ReentrancyGuard { _; } - modifier onlyStateTransitionManager() { - if (msg.sender != s.stateTransitionManager) { + modifier onlyChainTypeManager() { + if (msg.sender != s.chainTypeManager) { revert Unauthorized(msg.sender); } _; @@ -44,15 +48,15 @@ contract ZkSyncHyperchainBase is ReentrancyGuard { _; } - modifier onlyAdminOrStateTransitionManager() { - if (msg.sender != s.admin && msg.sender != s.stateTransitionManager) { + modifier onlyAdminOrChainTypeManager() { + if (msg.sender != s.admin && msg.sender != s.chainTypeManager) { revert Unauthorized(msg.sender); } _; } - modifier onlyValidatorOrStateTransitionManager() { - if (!s.validators[msg.sender] && msg.sender != s.stateTransitionManager) { + modifier onlyValidatorOrChainTypeManager() { + if (!s.validators[msg.sender] && msg.sender != s.chainTypeManager) { revert Unauthorized(msg.sender); } _; @@ -64,4 +68,12 @@ contract ZkSyncHyperchainBase is ReentrancyGuard { } _; } + + function _getTotalPriorityTxs() internal view returns (uint256) { + if (s.priorityQueue.getFirstUnprocessedPriorityTx() >= s.priorityTree.startIndex) { + return s.priorityTree.getTotalPriorityTxs(); + } else { + return s.priorityQueue.getTotalPriorityTxs(); + } + } } diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IAdmin.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IAdmin.sol index caf7a7062..4a2ad7170 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/IAdmin.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/IAdmin.sol @@ -2,15 +2,15 @@ // We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.21; -import {IZkSyncHyperchainBase} from "../chain-interfaces/IZkSyncHyperchainBase.sol"; +import {IZKChainBase} from "../chain-interfaces/IZKChainBase.sol"; import {Diamond} from "../libraries/Diamond.sol"; -import {FeeParams, PubdataPricingMode} from "../chain-deps/ZkSyncHyperchainStorage.sol"; +import {FeeParams, PubdataPricingMode} from "../chain-deps/ZKChainStorage.sol"; /// @title The interface of the Admin Contract that controls access rights for contract management. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -interface IAdmin is IZkSyncHyperchainBase { +interface IAdmin is IZKChainBase { /// @notice Starts the transfer of admin rights. Only the current admin can propose a new pending one. /// @notice New admin can accept admin rights by calling `acceptAdmin` function. /// @param _newPendingAdmin Address of the new admin @@ -61,11 +61,12 @@ interface IAdmin is IZkSyncHyperchainBase { function freezeDiamond() external; /// @notice Unpause the functionality of all freezable facets & their selectors - /// @dev Both the admin and the STM can unfreeze Diamond Proxy + /// @dev Both the admin and the CTM can unfreeze Diamond Proxy function unfreezeDiamond() external; function genesisUpgrade( address _l1GenesisUpgrade, + address _ctmDeployer, bytes calldata _forceDeploymentData, bytes[] calldata _factoryDeps ) external; @@ -114,7 +115,7 @@ interface IAdmin is IZkSyncHyperchainBase { /// @notice Emitted when an upgrade is executed. event ExecuteUpgrade(Diamond.DiamondCutData diamondCut); - /// TODO: maybe include some params + /// @notice Emitted when the migration to the new settlement layer is complete. event MigrationComplete(); /// @notice Emitted when the contract is frozen. @@ -134,21 +135,18 @@ interface IAdmin is IZkSyncHyperchainBase { /// @dev Similar to IL1AssetHandler interface, used to send chains. function forwardedBridgeBurn( address _settlementLayer, - address _prevMsgSender, + address _originalCaller, bytes calldata _data ) external payable returns (bytes memory _bridgeMintData); /// @dev Similar to IL1AssetHandler interface, used to claim failed chain transfers. - function forwardedBridgeClaimFailedBurn( + function forwardedBridgeRecoverFailedTransfer( uint256 _chainId, bytes32 _assetInfo, - address _prevMsgSender, - bytes calldata _data + address _originalCaller, + bytes calldata _chainData ) external payable; /// @dev Similar to IL1AssetHandler interface, used to receive chains. - function forwardedBridgeMint(bytes calldata _data) external payable; - - /// @dev Returns the commitments to the chain. - function readChainCommitment() external view returns (bytes memory); + function forwardedBridgeMint(bytes calldata _data, bool _contractAlreadyDeployed) external payable; } diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IDiamondInit.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IDiamondInit.sol index 189ae69fa..c5f2bbc90 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/IDiamondInit.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/IDiamondInit.sol @@ -3,15 +3,15 @@ pragma solidity ^0.8.21; import {IVerifier, VerifierParams} from "./IVerifier.sol"; -import {FeeParams} from "../chain-deps/ZkSyncHyperchainStorage.sol"; +import {FeeParams} from "../chain-deps/ZKChainStorage.sol"; /// @param chainId the id of the chain /// @param bridgehub the address of the bridgehub contract -/// @param stateTransitionManager contract's address +/// @param chainTypeManager contract's address /// @param protocolVersion initial protocol version /// @param validatorTimelock address of the validator timelock that delays execution /// @param admin address who can manage the contract -/// @param baseToken address of the base token of the chain +/// @param baseTokenAssetId asset id of the base token of the chain /// @param baseTokenBridge address of the L1 shared bridge contract /// @param storedBatchZero hash of the initial genesis batch /// @param verifier address of Verifier contract @@ -25,11 +25,11 @@ import {FeeParams} from "../chain-deps/ZkSyncHyperchainStorage.sol"; struct InitializeData { uint256 chainId; address bridgehub; - address stateTransitionManager; + address chainTypeManager; uint256 protocolVersion; address admin; address validatorTimelock; - address baseToken; + bytes32 baseTokenAssetId; address baseTokenBridge; bytes32 storedBatchZero; IVerifier verifier; diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IExecutor.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IExecutor.sol index cc208629e..0877dcbf9 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/IExecutor.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/IExecutor.sol @@ -2,14 +2,11 @@ // We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.21; -import {IZkSyncHyperchainBase} from "./IZkSyncHyperchainBase.sol"; -import {PriorityOpsBatchInfo} from "../libraries/PriorityTree.sol"; +import {IZKChainBase} from "./IZKChainBase.sol"; /// @dev Enum used by L2 System Contracts to differentiate logs. enum SystemLogKey { L2_TO_L1_LOGS_TREE_ROOT_KEY, - TOTAL_L2_TO_L1_PUBDATA_KEY, - STATE_DIFF_HASH_KEY, PACKED_BATCH_AND_L2_BLOCK_TIMESTAMP_KEY, PREV_BATCH_HASH_KEY, CHAINED_PRIORITY_TXN_HASH_KEY, @@ -50,7 +47,7 @@ uint256 constant TOTAL_BLOBS_IN_COMMITMENT = 16; /// @title The interface of the ZKsync Executor contract capable of processing events emitted in the ZKsync protocol. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -interface IExecutor is IZkSyncHyperchainBase { +interface IExecutor is IZKChainBase { /// @notice Rollup batch stored data /// @param batchNumber Rollup batch number /// @param batchHash Hash of L2 batch @@ -103,73 +100,53 @@ interface IExecutor is IZkSyncHyperchainBase { bytes operatorDAInput; } - /// @notice Recursive proof input data (individual commitments are constructed onchain) - struct ProofInput { - uint256[] recursiveAggregationInput; - uint256[] serializedProof; - } - /// @notice Function called by the operator to commit new batches. It is responsible for: /// - Verifying the correctness of their timestamps. /// - Processing their L2->L1 logs. /// - Storing batch commitments. - /// @param _lastCommittedBatchData Stored data of the last committed batch. - /// @param _newBatchesData Data of the new batches to be committed. - function commitBatches( - StoredBatchInfo calldata _lastCommittedBatchData, - CommitBatchInfo[] calldata _newBatchesData - ) external; - - /// @notice same as `commitBatches` but with the chainId so ValidatorTimelock can sort the inputs. + /// @param _chainId Chain ID of the chain. + /// @param _processFrom The batch number from which the processing starts. + /// @param _processTo The batch number at which the processing ends. + /// @param _commitData The encoded data of the new batches to be committed. function commitBatchesSharedBridge( uint256 _chainId, - StoredBatchInfo calldata _lastCommittedBatchData, - CommitBatchInfo[] calldata _newBatchesData + uint256 _processFrom, + uint256 _processTo, + bytes calldata _commitData ) external; /// @notice Batches commitment verification. /// @dev Only verifies batch commitments without any other processing. - /// @param _prevBatch Stored data of the last committed batch. - /// @param _committedBatches Stored data of the committed batches. - /// @param _proof The zero knowledge proof. - function proveBatches( - StoredBatchInfo calldata _prevBatch, - StoredBatchInfo[] calldata _committedBatches, - ProofInput calldata _proof - ) external; - - /// @notice same as `proveBatches` but with the chainId so ValidatorTimelock can sort the inputs. + /// @param _chainId Chain ID of the chain. + /// @param _processBatchFrom The batch number from which the verification starts. + /// @param _processBatchTo The batch number at which the verification ends. + /// @param _proofData The encoded data of the new batches to be verified. function proveBatchesSharedBridge( uint256 _chainId, - StoredBatchInfo calldata _prevBatch, - StoredBatchInfo[] calldata _committedBatches, - ProofInput calldata _proof + uint256 _processBatchFrom, + uint256 _processBatchTo, + bytes calldata _proofData ) external; /// @notice The function called by the operator to finalize (execute) batches. It is responsible for: /// - Processing all pending operations (commpleting priority requests). /// - Finalizing this batch (i.e. allowing to withdraw funds from the system) - /// @param _batchesData Data of the batches to be executed. - /// @param _priorityOpsData Merkle proofs of the priority operations for each batch. - function executeBatches( - StoredBatchInfo[] calldata _batchesData, - PriorityOpsBatchInfo[] calldata _priorityOpsData - ) external; - - /// @notice same as `executeBatches` but with the chainId so ValidatorTimelock can sort the inputs. + /// @param _chainId Chain ID of the chain. + /// @param _processFrom The batch number from which the execution starts. + /// @param _processTo The batch number at which the execution ends. + /// @param _executeData The encoded data of the new batches to be executed. function executeBatchesSharedBridge( uint256 _chainId, - StoredBatchInfo[] calldata _batchesData, - PriorityOpsBatchInfo[] calldata _priorityOpsData + uint256 _processFrom, + uint256 _processTo, + bytes calldata _executeData ) external; /// @notice Reverts unexecuted batches + /// @param _chainId Chain ID of the chain /// @param _newLastBatch batch number after which batches should be reverted /// NOTE: Doesn't delete the stored data about batches, but only decreases /// counters that are responsible for the number of batches - function revertBatches(uint256 _newLastBatch) external; - - /// @notice same as `revertBatches` but with the chainId so ValidatorTimelock can sort the inputs. function revertBatchesSharedBridge(uint256 _chainId, uint256 _newLastBatch) external; /// @notice Event emitted when a batch is committed diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IGetters.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IGetters.sol index 3bc2c3aec..5dfd600ca 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/IGetters.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/IGetters.sol @@ -3,13 +3,16 @@ pragma solidity ^0.8.21; import {VerifierParams} from "../chain-interfaces/IVerifier.sol"; -import {PubdataPricingMode} from "../chain-deps/ZkSyncHyperchainStorage.sol"; -import {IZkSyncHyperchainBase} from "./IZkSyncHyperchainBase.sol"; +import {PubdataPricingMode} from "../chain-deps/ZKChainStorage.sol"; +import {IZKChainBase} from "./IZKChainBase.sol"; /// @title The interface of the Getters Contract that implements functions for getting contract state from outside the blockchain. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -interface IGetters is IZkSyncHyperchainBase { +/// @dev Most of the methods simply return the values that correspond to the current diamond proxy and possibly +/// not to the ZK Chain as a whole. For example, if the chain is migrated to another settlement layer, the values returned +/// by this facet will correspond to the values stored on this chain and possilbly not the canonical state of the chain. +interface IGetters is IZKChainBase { /*////////////////////////////////////////////////////////////// CUSTOM GETTERS //////////////////////////////////////////////////////////////*/ @@ -27,7 +30,7 @@ interface IGetters is IZkSyncHyperchainBase { function getBridgehub() external view returns (address); /// @return The address of the state transition - function getStateTransitionManager() external view returns (address); + function getChainTypeManager() external view returns (address); /// @return The chain ID function getChainId() external view returns (uint256); @@ -35,6 +38,9 @@ interface IGetters is IZkSyncHyperchainBase { /// @return The address of the base token function getBaseToken() external view returns (address); + /// @return The address of the base token + function getBaseTokenAssetId() external view returns (bytes32); + /// @return The address of the base token bridge function getBaseTokenBridge() external view returns (address); @@ -47,6 +53,9 @@ interface IGetters is IZkSyncHyperchainBase { /// @return The total number of batches that were committed & verified & executed function getTotalBatchesExecuted() external view returns (uint256); + // @return Address of transaction filterer + function getTransactionFilterer() external view returns (address); + /// @return The total number of priority operations that were added to the priority queue, including all processed ones function getTotalPriorityTxs() external view returns (uint256); @@ -150,6 +159,6 @@ interface IGetters is IZkSyncHyperchainBase { /// @return isFreezable Whether the facet can be frozen by the admin or always accessible function isFacetFreezable(address _facet) external view returns (bool isFreezable); - /// TODO + /// @return The address of the current settlement layer. function getSettlementLayer() external view returns (address); } diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IL1DAValidator.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IL1DAValidator.sol index 9abb301ca..a4fe56b01 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/IL1DAValidator.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/IL1DAValidator.sol @@ -22,18 +22,20 @@ struct L1DAValidatorOutput { interface IL1DAValidator { /// @notice The function that checks the data availability for the given batch input. - /// @param chainId The chain id of the chain that is being committed. - /// @param l2DAValidatorOutputHash The hash of that was returned by the l2DAValidator. - /// @param operatorDAInput The DA input by the operator provided on L1. - /// @param maxBlobsSupported The maximal number of blobs supported by the chain. + /// @param _chainId The chain id of the chain that is being committed. + /// @param _chainId The batch number for which the data availability is being checked. + /// @param _l2DAValidatorOutputHash The hash of that was returned by the l2DAValidator. + /// @param _operatorDAInput The DA input by the operator provided on L1. + /// @param _maxBlobsSupported The maximal number of blobs supported by the chain. /// We provide this value for future compatibility. /// This is needed because the corresponding `blobsLinearHashes`/`blobsOpeningCommitments` /// in the `L1DAValidatorOutput` struct will have to have this length as it is required /// to be static by the circuits. function checkDA( - uint256 chainId, - bytes32 l2DAValidatorOutputHash, - bytes calldata operatorDAInput, - uint256 maxBlobsSupported + uint256 _chainId, + uint256 _batchNumber, + bytes32 _l2DAValidatorOutputHash, + bytes calldata _operatorDAInput, + uint256 _maxBlobsSupported ) external returns (L1DAValidatorOutput memory output); } diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/ILegacyGetters.sol b/l1-contracts/contracts/state-transition/chain-interfaces/ILegacyGetters.sol index cb62f5087..9c143d93e 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/ILegacyGetters.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/ILegacyGetters.sol @@ -2,13 +2,13 @@ // We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.21; -import {IZkSyncHyperchainBase} from "./IZkSyncHyperchainBase.sol"; +import {IZKChainBase} from "./IZKChainBase.sol"; /// @author Matter Labs /// @dev This interface contains getters for the ZKsync contract that should not be used, /// but still are kept for backward compatibility. /// @custom:security-contact security@matterlabs.dev -interface ILegacyGetters is IZkSyncHyperchainBase { +interface ILegacyGetters is IZKChainBase { /// @return The total number of batches that were committed /// @dev It is a *deprecated* method, please use `getTotalBatchesCommitted` instead function getTotalBlocksCommitted() external view returns (uint256); diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IMailbox.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IMailbox.sol index f565e8562..e63832aa7 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/IMailbox.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/IMailbox.sol @@ -2,13 +2,13 @@ // We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.21; -import {IZkSyncHyperchainBase} from "./IZkSyncHyperchainBase.sol"; +import {IZKChainBase} from "./IZKChainBase.sol"; import {L2CanonicalTransaction, L2Log, L2Message, TxStatus, BridgehubL2TransactionRequest} from "../../common/Messaging.sol"; /// @title The interface of the ZKsync Mailbox contract that provides interfaces for L1 <-> L2 interaction. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -interface IMailbox is IZkSyncHyperchainBase { +interface IMailbox is IZKChainBase { /// @notice Prove that a specific arbitrary-length message was sent in a specific L2 batch number /// @param _batchNumber The executed L2 batch number in which the message appeared /// @param _index The position in the L2 logs Merkle tree of the l2Log that was sent with the message @@ -101,23 +101,14 @@ interface IMailbox is IZkSyncHyperchainBase { ) external returns (bytes32 canonicalTxHash); /// @dev On the Gateway the chain's mailbox receives the tx from the bridgehub. - function bridgehubRequestL2TransactionOnGateway( - L2CanonicalTransaction calldata _transaction, - bytes[] calldata _factoryDeps, - bytes32 _canonicalTxHash, - uint64 _expirationTimestamp - ) external; + function bridgehubRequestL2TransactionOnGateway(bytes32 _canonicalTxHash, uint64 _expirationTimestamp) external; /// @dev On L1 we have to forward to the Gateway's mailbox which sends to the Bridgehub on the Gw /// @param _chainId the chainId of the chain - /// @param _transaction the transaction to be relayed - /// @param _factoryDeps the factory dependencies /// @param _canonicalTxHash the canonical transaction hash /// @param _expirationTimestamp the expiration timestamp function requestL2TransactionToGatewayMailbox( uint256 _chainId, - L2CanonicalTransaction calldata _transaction, - bytes[] calldata _factoryDeps, bytes32 _canonicalTxHash, uint64 _expirationTimestamp ) external returns (bytes32 canonicalTxHash); @@ -175,4 +166,13 @@ interface IMailbox is IZkSyncHyperchainBase { L2CanonicalTransaction transaction, bytes[] factoryDeps ); + + /// @notice New relayed priority request event. It is emitted on a chain that is deployed + /// on top of the gateway when it receives a request relayed via the Bridgehub. + /// @dev IMPORTANT: this event most likely will be removed in the future, so + /// no one should rely on it for indexing purposes. + /// @param txId Serial number of the priority operation + /// @param txHash keccak256 hash of encoded transaction representation + /// @param expirationTimestamp Timestamp up to which priority request should be processed + event NewRelayedPriorityTransaction(uint256 txId, bytes32 txHash, uint64 expirationTimestamp); } diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IVerifier.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IVerifier.sol index 97872c370..fe5e2af2c 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/IVerifier.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/IVerifier.sol @@ -16,11 +16,7 @@ interface IVerifier { /// @dev Verifies a zk-SNARK proof. /// @return A boolean value indicating whether the zk-SNARK proof is valid. /// Note: The function may revert execution instead of returning false in some cases. - function verify( - uint256[] calldata _publicInputs, - uint256[] calldata _proof, - uint256[] calldata _recursiveAggregationInput - ) external view returns (bool); + function verify(uint256[] calldata _publicInputs, uint256[] calldata _proof) external view returns (bool); /// @notice Calculates a keccak256 hash of the runtime loaded verification keys. /// @return vkHash The keccak256 hash of the loaded verification keys. diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IZkSyncHyperchain.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IZKChain.sol similarity index 89% rename from l1-contracts/contracts/state-transition/chain-interfaces/IZkSyncHyperchain.sol rename to l1-contracts/contracts/state-transition/chain-interfaces/IZKChain.sol index 14aa123b0..31d14009b 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/IZkSyncHyperchain.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/IZKChain.sol @@ -9,7 +9,7 @@ import {IMailbox} from "./IMailbox.sol"; import {Diamond} from "../libraries/Diamond.sol"; -interface IZkSyncHyperchain is IAdmin, IExecutor, IGetters, IMailbox { +interface IZKChain is IAdmin, IExecutor, IGetters, IMailbox { // We need this structure for the server for now event ProposeTransparentUpgrade( Diamond.DiamondCutData diamondCut, diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IZkSyncHyperchainBase.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IZKChainBase.sol similarity index 81% rename from l1-contracts/contracts/state-transition/chain-interfaces/IZkSyncHyperchainBase.sol rename to l1-contracts/contracts/state-transition/chain-interfaces/IZKChainBase.sol index 3cd646cc9..06f0c9784 100644 --- a/l1-contracts/contracts/state-transition/chain-interfaces/IZkSyncHyperchainBase.sol +++ b/l1-contracts/contracts/state-transition/chain-interfaces/IZKChainBase.sol @@ -1,11 +1,11 @@ // SPDX-License-Identifier: MIT -// We use a floating point pragma here so it can be used within other projects that interact with the zkSync ecosystem without using our exact pragma version. +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.21; /// @title The interface of the ZKsync contract, responsible for the main ZKsync logic. /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev -interface IZkSyncHyperchainBase { +interface IZKChainBase { /// @return Returns facet name. function getName() external view returns (string memory); } diff --git a/l1-contracts/contracts/state-transition/data-availability/CalldataDA.sol b/l1-contracts/contracts/state-transition/data-availability/CalldataDA.sol index b7a1681a0..f1e5f7355 100644 --- a/l1-contracts/contracts/state-transition/data-availability/CalldataDA.sol +++ b/l1-contracts/contracts/state-transition/data-availability/CalldataDA.sol @@ -9,13 +9,16 @@ pragma solidity 0.8.24; /// @dev Our circuits will prove that a EIP-4844 blob and our internal blob are the same. uint256 constant BLOB_SIZE_BYTES = 126_976; -// the state diff hash, hash of pubdata + the number of blobs. +/// @dev The state diff hash, hash of pubdata + the number of blobs. uint256 constant BLOB_DATA_OFFSET = 65; +/// @dev The size of the commitment for a single blob. +uint256 constant BLOB_COMMITMENT_SIZE = 32; + /// @notice Contract that contains the functionality for process the calldata DA. /// @dev The expected l2DAValidator that should be used with it `RollupL2DAValidator`. abstract contract CalldataDA { - /// @notice Parses the input that the l2 Da validator has provided to the contract. + /// @notice Parses the input that the L2 DA validator has provided to the contract. /// @param _l2DAValidatorOutputHash The hash of the output of the L2 DA validator. /// @param _maxBlobsSupported The maximal number of blobs supported by the chain. /// @param _operatorDAInput The DA input by the operator provided on L1. @@ -34,7 +37,7 @@ abstract contract CalldataDA { bytes calldata l1DaInput ) { - // The preimage under the hash `l2DAValidatorOutputHash` is expected to be in the following format: + // The preimage under the hash `_l2DAValidatorOutputHash` is expected to be in the following format: // - First 32 bytes are the hash of the uncompressed state diff. // - Then, there is a 32-byte hash of the full pubdata. // - Then, there is the 1-byte number of blobs published. @@ -55,19 +58,14 @@ abstract contract CalldataDA { require(_operatorDAInput.length >= BLOB_DATA_OFFSET + 32 * blobsProvided, "invalid blobs hashes"); - assembly { - // The pointer to the allocated memory above. We skip 32 bytes to avoid overwriting the length. - let blobsPtr := add(blobsLinearHashes, 0x20) - let inputPtr := add(_operatorDAInput.offset, BLOB_DATA_OFFSET) - calldatacopy(blobsPtr, inputPtr, mul(blobsProvided, 32)) - } + _cloneCalldata(blobsLinearHashes, _operatorDAInput[BLOB_DATA_OFFSET:], blobsProvided); uint256 ptr = BLOB_DATA_OFFSET + 32 * blobsProvided; - // Now, we need to double check that the provided input was indeed retutned by the L2 DA validator. + // Now, we need to double check that the provided input was indeed returned by the L2 DA validator. require(keccak256(_operatorDAInput[:ptr]) == _l2DAValidatorOutputHash, "invalid l2 DA output hash"); - // The rest of the output were provided specifically by the operator + // The rest of the output was provided specifically by the operator l1DaInput = _operatorDAInput[ptr:]; } @@ -82,20 +80,32 @@ abstract contract CalldataDA { bytes32 _fullPubdataHash, uint256 _maxBlobsSupported, bytes calldata _pubdataInput - ) internal pure returns (bytes32[] memory blobCommitments, bytes calldata _pubdata) { + ) internal pure virtual returns (bytes32[] memory blobCommitments, bytes calldata _pubdata) { require(_blobsProvided == 1, "only one blob with calldata"); - require(_pubdataInput.length >= 32, "pubdata too small"); + require(_pubdataInput.length >= BLOB_COMMITMENT_SIZE, "pubdata too small"); // We typically do not know whether we'll use calldata or blobs at the time when // we start proving the batch. That's why the blob commitment for a single blob is still present in the case of calldata. blobCommitments = new bytes32[](_maxBlobsSupported); - _pubdata = _pubdataInput[:_pubdataInput.length - 32]; + _pubdata = _pubdataInput[:_pubdataInput.length - BLOB_COMMITMENT_SIZE]; - // FIXME: allow larger lengths for Gateway-based chains. require(_pubdata.length <= BLOB_SIZE_BYTES, "cz"); require(_fullPubdataHash == keccak256(_pubdata), "wp"); - blobCommitments[0] = bytes32(_pubdataInput[_pubdataInput.length - 32:_pubdataInput.length]); + blobCommitments[0] = bytes32(_pubdataInput[_pubdataInput.length - BLOB_COMMITMENT_SIZE:_pubdataInput.length]); + } + + /// @notice Method that clones a slice of calldata into a bytes32[] memory array. + /// @param _dst The destination array. + /// @param _input The input calldata. + /// @param _len The length of the slice in 32-byte words to clone. + function _cloneCalldata(bytes32[] memory _dst, bytes calldata _input, uint256 _len) internal pure { + assembly { + // The pointer to the allocated memory above. We skip 32 bytes to avoid overwriting the length. + let dstPtr := add(_dst, 0x20) + let inputPtr := _input.offset + calldatacopy(dstPtr, inputPtr, mul(_len, 32)) + } } } diff --git a/l1-contracts/contracts/state-transition/data-availability/CalldataDAGateway.sol b/l1-contracts/contracts/state-transition/data-availability/CalldataDAGateway.sol new file mode 100644 index 000000000..3e069bbd5 --- /dev/null +++ b/l1-contracts/contracts/state-transition/data-availability/CalldataDAGateway.sol @@ -0,0 +1,36 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {CalldataDA, BLOB_COMMITMENT_SIZE, BLOB_SIZE_BYTES} from "./CalldataDA.sol"; + +// solhint-disable gas-custom-errors, reason-string + +/// @notice Contract that contains the functionality for process the calldata DA. +/// @dev The expected l2DAValidator that should be used with it `RollupL2DAValidator`. +abstract contract CalldataDAGateway is CalldataDA { + /// @inheritdoc CalldataDA + function _processCalldataDA( + uint256 _blobsProvided, + bytes32 _fullPubdataHash, + uint256 _maxBlobsSupported, + bytes calldata _pubdataInput + ) internal pure override returns (bytes32[] memory blobCommitments, bytes calldata _pubdata) { + require(_pubdataInput.length >= _blobsProvided * BLOB_COMMITMENT_SIZE, "pubdata too small"); + + // We typically do not know whether we'll use calldata or blobs at the time when + // we start proving the batch. That's why the blob commitment for a single blob is still present in the case of calldata. + blobCommitments = new bytes32[](_maxBlobsSupported); + + _pubdata = _pubdataInput[:_pubdataInput.length - _blobsProvided * BLOB_COMMITMENT_SIZE]; + + require(_pubdata.length <= _blobsProvided * BLOB_SIZE_BYTES, "cz"); + require(_fullPubdataHash == keccak256(_pubdata), "wp"); + + bytes calldata providedCommitments = _pubdataInput[_pubdataInput.length - + _blobsProvided * + BLOB_COMMITMENT_SIZE:]; + + _cloneCalldata(blobCommitments, providedCommitments, _blobsProvided); + } +} diff --git a/l1-contracts/contracts/state-transition/data-availability/RelayedSLDAValidator.sol b/l1-contracts/contracts/state-transition/data-availability/RelayedSLDAValidator.sol index 4e91c7bc4..d5f3473a7 100644 --- a/l1-contracts/contracts/state-transition/data-availability/RelayedSLDAValidator.sol +++ b/l1-contracts/contracts/state-transition/data-availability/RelayedSLDAValidator.sol @@ -7,22 +7,46 @@ pragma solidity 0.8.24; import {IL1DAValidator, L1DAValidatorOutput, PubdataSource} from "../chain-interfaces/IL1DAValidator.sol"; import {IL1Messenger} from "../../common/interfaces/IL1Messenger.sol"; -import {CalldataDA} from "./CalldataDA.sol"; +import {CalldataDAGateway} from "./CalldataDAGateway.sol"; -import {L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR} from "../../common/L2ContractAddresses.sol"; +import {IBridgehub} from "../../bridgehub/IBridgehub.sol"; +import {L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR, L2_BRIDGEHUB_ADDR} from "../../common/L2ContractAddresses.sol"; /// @notice The DA validator intended to be used in Era-environment. /// @dev For compatibility reasons it accepts calldata in the same format as the `RollupL1DAValidator`, but unlike the latter it /// does not support blobs. /// @dev Note that it does not provide any compression whatsoever. -contract RelayedSLDAValidator is IL1DAValidator, CalldataDA { +contract RelayedSLDAValidator is IL1DAValidator, CalldataDAGateway { + /// @dev Ensures that the sender is the chain that is supposed to send the message. + /// @param _chainId The chain id of the chain that is supposed to send the message. + function _ensureOnlyChainSender(uint256 _chainId) internal view { + // Note that this contract is only supposed to be deployed on L2, where the + // bridgehub is predeployed at `L2_BRIDGEHUB_ADDR` address. + require(IBridgehub(L2_BRIDGEHUB_ADDR).getZKChain(_chainId) == msg.sender, "l1-da-validator/invalid-sender"); + } + + /// @dev Relays the calldata to L1. + /// @param _chainId The chain id of the chain that is supposed to send the message. + /// @param _batchNumber The batch number for which the data availability is being checked. + /// @param _pubdata The pubdata to be relayed to L1. + function _relayCalldata(uint256 _chainId, uint256 _batchNumber, bytes calldata _pubdata) internal { + // Re-sending all the pubdata in pure form to L1. + // slither-disable-next-line unused-return + IL1Messenger(L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR).sendToL1(abi.encode(_chainId, _batchNumber, _pubdata)); + } + /// @inheritdoc IL1DAValidator function checkDA( uint256 _chainId, + uint256 _batchNumber, bytes32 _l2DAValidatorOutputHash, bytes calldata _operatorDAInput, uint256 _maxBlobsSupported ) external returns (L1DAValidatorOutput memory output) { + // Unfortunately we have to use a method call instead of a modifier + // because of the stack-too-deep error caused by it. + _ensureOnlyChainSender(_chainId); + // Preventing "stack too deep" error uint256 blobsProvided; bytes32 fullPubdataHash; @@ -56,10 +80,7 @@ contract RelayedSLDAValidator is IL1DAValidator, CalldataDA { l1DaInput[1:] ); - // Re-sending all the pubdata in pure form to L1. - // FIXME: we should also supply batch number, this is needed for logs to work. - // slither-disable-next-line unused-return - IL1Messenger(L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR).sendToL1(abi.encode(_chainId, pubdata)); + _relayCalldata(_chainId, _batchNumber, pubdata); output.blobsOpeningCommitments = blobCommitments; } else { diff --git a/l1-contracts/contracts/state-transition/l2-deps/IL2GenesisUpgrade.sol b/l1-contracts/contracts/state-transition/l2-deps/IL2GenesisUpgrade.sol index 2effd48cd..daddd142a 100644 --- a/l1-contracts/contracts/state-transition/l2-deps/IL2GenesisUpgrade.sol +++ b/l1-contracts/contracts/state-transition/l2-deps/IL2GenesisUpgrade.sol @@ -18,5 +18,11 @@ struct ForceDeployment { /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev interface IL2GenesisUpgrade { - function genesisUpgrade(uint256 _chainId, bytes calldata _forceDeploymentsData) external payable; + event UpgradeComplete(uint256 _chainId); + + function genesisUpgrade( + uint256 _chainId, + address _ctmDeployer, + bytes calldata _forceDeploymentsData + ) external payable; } diff --git a/l1-contracts/contracts/state-transition/l2-deps/ISystemContext.sol b/l1-contracts/contracts/state-transition/l2-deps/ISystemContext.sol index b8319f7c4..8448cb4e4 100644 --- a/l1-contracts/contracts/state-transition/l2-deps/ISystemContext.sol +++ b/l1-contracts/contracts/state-transition/l2-deps/ISystemContext.sol @@ -1,5 +1,5 @@ // SPDX-License-Identifier: MIT -// We use a floating point pragma here so it can be used within other projects that interact with the zkSync ecosystem without using our exact pragma version. +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.21; /// @author Matter Labs diff --git a/l1-contracts/contracts/state-transition/libraries/BatchDecoder.sol b/l1-contracts/contracts/state-transition/libraries/BatchDecoder.sol new file mode 100644 index 000000000..05b16537b --- /dev/null +++ b/l1-contracts/contracts/state-transition/libraries/BatchDecoder.sol @@ -0,0 +1,219 @@ +// SPDX-License-Identifier: MIT +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. +pragma solidity ^0.8.21; + +import {IExecutor} from "../chain-interfaces/IExecutor.sol"; +import {PriorityOpsBatchInfo} from "./PriorityTree.sol"; +import {IncorrectBatchBounds, EmptyData, UnsupportedCommitBatchEncoding, UnsupportedProofBatchEncoding, UnsupportedExecuteBatchEncoding} from "../../common/L1ContractErrors.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice Utility library for decoding and validating batch data. +/// @dev This library decodes commit, proof, and execution batch data and verifies batch number bounds. +/// It reverts with custom errors when the data is invalid or unsupported encoding is used. +library BatchDecoder { + /// @notice The currently supported encoding version. + uint8 internal constant SUPPORTED_ENCODING_VERSION = 0; + + /// @notice Decodes commit data from a calldata bytes into the last committed batch data and an array of new batch data. + /// @param _commitData The calldata byte array containing the data for committing batches. + /// @return lastCommittedBatchData The data for the batch before newly committed batches. + /// @return newBatchesData An array containing the newly committed batches. + function _decodeCommitData( + bytes calldata _commitData + ) + private + pure + returns ( + IExecutor.StoredBatchInfo memory lastCommittedBatchData, + IExecutor.CommitBatchInfo[] memory newBatchesData + ) + { + if (_commitData.length == 0) { + revert EmptyData(); + } + + uint8 encodingVersion = uint8(_commitData[0]); + if (encodingVersion == SUPPORTED_ENCODING_VERSION) { + (lastCommittedBatchData, newBatchesData) = abi.decode( + _commitData[1:], + (IExecutor.StoredBatchInfo, IExecutor.CommitBatchInfo[]) + ); + } else { + revert UnsupportedCommitBatchEncoding(encodingVersion); + } + } + + /// @notice Decodes the commit data and checks that the provided batch bounds are correct. + /// @dev Note that it only checks that the last and the first batches in the array correspond to the provided bounds. + /// The fact that the batches inside the array are provided in the correct order should be checked by the caller. + /// @param _commitData The calldata byte array containing the data for committing batches. + /// @param _processBatchFrom The expected batch number of the first commit batch in the array. + /// @param _processBatchTo The expected batch number of the last commit batch in the array. + /// @return lastCommittedBatchData The data for the batch before newly committed batches. + /// @return newBatchesData An array containing the newly committed batches. + function decodeAndCheckCommitData( + bytes calldata _commitData, + uint256 _processBatchFrom, + uint256 _processBatchTo + ) + internal + pure + returns ( + IExecutor.StoredBatchInfo memory lastCommittedBatchData, + IExecutor.CommitBatchInfo[] memory newBatchesData + ) + { + (lastCommittedBatchData, newBatchesData) = _decodeCommitData(_commitData); + + if (newBatchesData.length == 0) { + revert EmptyData(); + } + + if ( + newBatchesData[0].batchNumber != _processBatchFrom || + newBatchesData[newBatchesData.length - 1].batchNumber != _processBatchTo + ) { + revert IncorrectBatchBounds( + _processBatchFrom, + _processBatchTo, + newBatchesData[0].batchNumber, + newBatchesData[newBatchesData.length - 1].batchNumber + ); + } + } + + /// @notice Decodes proof data from a calldata byte array into the previous batch, an array of proved batches, and a proof array. + /// @param _proofData The calldata byte array containing the data for proving batches. + /// @return prevBatch The batch information before the batches to be verified. + /// @return provedBatches An array containing the the batches to be verified. + /// @return proof An array containing the proof for the verifier. + function _decodeProofData( + bytes calldata _proofData + ) + private + pure + returns ( + IExecutor.StoredBatchInfo memory prevBatch, + IExecutor.StoredBatchInfo[] memory provedBatches, + uint256[] memory proof + ) + { + if (_proofData.length == 0) { + revert EmptyData(); + } + + uint8 encodingVersion = uint8(_proofData[0]); + if (encodingVersion == SUPPORTED_ENCODING_VERSION) { + (prevBatch, provedBatches, proof) = abi.decode( + _proofData[1:], + (IExecutor.StoredBatchInfo, IExecutor.StoredBatchInfo[], uint256[]) + ); + } else { + revert UnsupportedProofBatchEncoding(encodingVersion); + } + } + + /// @notice Decodes the commit data and checks that the provided batch bounds are correct. + /// @dev Note that it only checks that the last and the first batches in the array correspond to the provided bounds. + /// The fact that the batches inside the array are provided in the correct order should be checked by the caller. + /// @param _proofData The commit data to decode. + /// @param _processBatchFrom The expected batch number of the first batch in the array. + /// @param _processBatchTo The expected batch number of the last batch in the array. + /// @return prevBatch The batch information before the batches to be verified. + /// @return provedBatches An array containing the the batches to be verified. + /// @return proof An array containing the proof for the verifier. + function decodeAndCheckProofData( + bytes calldata _proofData, + uint256 _processBatchFrom, + uint256 _processBatchTo + ) + internal + pure + returns ( + IExecutor.StoredBatchInfo memory prevBatch, + IExecutor.StoredBatchInfo[] memory provedBatches, + uint256[] memory proof + ) + { + (prevBatch, provedBatches, proof) = _decodeProofData(_proofData); + + if (provedBatches.length == 0) { + revert EmptyData(); + } + + if ( + provedBatches[0].batchNumber != _processBatchFrom || + provedBatches[provedBatches.length - 1].batchNumber != _processBatchTo + ) { + revert IncorrectBatchBounds( + _processBatchFrom, + _processBatchTo, + provedBatches[0].batchNumber, + provedBatches[provedBatches.length - 1].batchNumber + ); + } + } + + /// @notice Decodes execution data from a calldata byte array into an array of stored batch information. + /// @param _executeData The calldata byte array containing the execution data to decode. + /// @return executeData An array containing the stored batch information for execution. + /// @return priorityOpsData Merkle proofs of the priority operations for each batch. + function _decodeExecuteData( + bytes calldata _executeData + ) + private + pure + returns (IExecutor.StoredBatchInfo[] memory executeData, PriorityOpsBatchInfo[] memory priorityOpsData) + { + if (_executeData.length == 0) { + revert EmptyData(); + } + + uint8 encodingVersion = uint8(_executeData[0]); + if (encodingVersion == 0) { + (executeData, priorityOpsData) = abi.decode( + _executeData[1:], + (IExecutor.StoredBatchInfo[], PriorityOpsBatchInfo[]) + ); + } else { + revert UnsupportedExecuteBatchEncoding(encodingVersion); + } + } + + /// @notice Decodes the execute data and checks that the provided batch bounds are correct. + /// @dev Note that it only checks that the last and the first batches in the array correspond to the provided bounds. + /// The fact that the batches inside the array are provided in the correct order should be checked by the caller. + /// @param _executeData The calldata byte array containing the execution data to decode. + /// @param _processBatchFrom The expected batch number of the first batch in the array. + /// @param _processBatchTo The expected batch number of the last batch in the array. + /// @return executeData An array containing the stored batch information for execution. + /// @return priorityOpsData Merkle proofs of the priority operations for each batch. + function decodeAndCheckExecuteData( + bytes calldata _executeData, + uint256 _processBatchFrom, + uint256 _processBatchTo + ) + internal + pure + returns (IExecutor.StoredBatchInfo[] memory executeData, PriorityOpsBatchInfo[] memory priorityOpsData) + { + (executeData, priorityOpsData) = _decodeExecuteData(_executeData); + + if (executeData.length == 0) { + revert EmptyData(); + } + + if ( + executeData[0].batchNumber != _processBatchFrom || + executeData[executeData.length - 1].batchNumber != _processBatchTo + ) { + revert IncorrectBatchBounds( + _processBatchFrom, + _processBatchTo, + executeData[0].batchNumber, + executeData[executeData.length - 1].batchNumber + ); + } + } +} diff --git a/l1-contracts/contracts/state-transition/libraries/Merkle.sol b/l1-contracts/contracts/state-transition/libraries/Merkle.sol deleted file mode 100644 index 57701f338..000000000 --- a/l1-contracts/contracts/state-transition/libraries/Merkle.sol +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: MIT -// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. -pragma solidity ^0.8.21; - -import {UncheckedMath} from "../../common/libraries/UncheckedMath.sol"; -import {MerklePathEmpty, MerklePathOutOfBounds, MerkleIndexOutOfBounds} from "../../common/L1ContractErrors.sol"; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -library Merkle { - using UncheckedMath for uint256; - - /// @dev Calculate Merkle root by the provided Merkle proof. - /// NOTE: When using this function, check that the _path length is equal to the tree height to prevent shorter/longer paths attack - /// @param _path Merkle path from the leaf to the root - /// @param _index Leaf index in the tree - /// @param _itemHash Hash of leaf content - /// @return The Merkle root - function calculateRoot( - bytes32[] calldata _path, - uint256 _index, - bytes32 _itemHash - ) internal pure returns (bytes32) { - uint256 pathLength = _path.length; - if (pathLength == 0) { - revert MerklePathEmpty(); - } - if (pathLength >= 256) { - revert MerklePathOutOfBounds(); - } - if (_index >= (1 << pathLength)) { - revert MerkleIndexOutOfBounds(); - } - - bytes32 currentHash = _itemHash; - for (uint256 i; i < pathLength; i = i.uncheckedInc()) { - currentHash = (_index % 2 == 0) - ? _efficientHash(currentHash, _path[i]) - : _efficientHash(_path[i], currentHash); - _index /= 2; - } - - return currentHash; - } - - /// @dev Keccak hash of the concatenation of two 32-byte words - function _efficientHash(bytes32 _lhs, bytes32 _rhs) private pure returns (bytes32 result) { - assembly { - mstore(0x00, _lhs) - mstore(0x20, _rhs) - result := keccak256(0x00, 0x40) - } - } -} diff --git a/l1-contracts/contracts/state-transition/libraries/PriorityTree.sol b/l1-contracts/contracts/state-transition/libraries/PriorityTree.sol index 6bf3649e5..71d6d9df1 100644 --- a/l1-contracts/contracts/state-transition/libraries/PriorityTree.sol +++ b/l1-contracts/contracts/state-transition/libraries/PriorityTree.sol @@ -60,8 +60,14 @@ library PriorityTree { return _tree.tree.root(); } + /// @param _root The root to check. + /// @return Returns true if the root is a historical root. + function isHistoricalRoot(Tree storage _tree, bytes32 _root) internal view returns (bool) { + return _tree.historicalRoots[_root]; + } + /// @notice Process the priority operations of a batch. - function processBatch(Tree storage _tree, PriorityOpsBatchInfo calldata _priorityOpsData) internal { + function processBatch(Tree storage _tree, PriorityOpsBatchInfo memory _priorityOpsData) internal { if (_priorityOpsData.itemHashes.length > 0) { bytes32 expectedRoot = Merkle.calculateRootPaths( _priorityOpsData.leftPath, @@ -91,6 +97,20 @@ library PriorityTree { _tree.historicalRoots[_tree.tree.root()] = true; } + /// @notice Reinitialize the tree from a commitment on L1. + function checkL1Reinit(Tree storage _tree, PriorityTreeCommitment memory _commitment) internal view { + require(_tree.startIndex == _commitment.startIndex, "PT: invalid start index"); + require(_tree.unprocessedIndex >= _commitment.unprocessedIndex, "PT: invalid unprocessed index"); + require(_tree.tree._nextLeafIndex >= _commitment.nextLeafIndex, "PT: invalid next leaf index"); + } + + /// @notice Reinitialize the tree from a commitment on GW. + function checkGWReinit(Tree storage _tree, PriorityTreeCommitment memory _commitment) internal view { + require(_tree.startIndex == _commitment.startIndex, "PT: invalid start index"); + require(_tree.unprocessedIndex <= _commitment.unprocessedIndex, "PT: invalid unprocessed index"); + require(_tree.tree._nextLeafIndex <= _commitment.nextLeafIndex, "PT: invalid next leaf index"); + } + /// @notice Returns the commitment to the priority tree. function getCommitment(Tree storage _tree) internal view returns (PriorityTreeCommitment memory commitment) { commitment.nextLeafIndex = _tree.tree._nextLeafIndex; diff --git a/l1-contracts/contracts/transactionFilterer/GatewayTransactionFilterer.sol b/l1-contracts/contracts/transactionFilterer/GatewayTransactionFilterer.sol new file mode 100644 index 000000000..81556f221 --- /dev/null +++ b/l1-contracts/contracts/transactionFilterer/GatewayTransactionFilterer.sol @@ -0,0 +1,99 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; + +import {ReentrancyGuard} from "../common/ReentrancyGuard.sol"; +import {AlreadyWhitelisted, InvalidSelector, NotWhitelisted, ZeroAddress} from "../common/L1ContractErrors.sol"; +import {ITransactionFilterer} from "../state-transition/chain-interfaces/ITransactionFilterer.sol"; +import {IBridgehub} from "../bridgehub/IBridgehub.sol"; +import {IL2Bridge} from "../bridge/interfaces/IL2Bridge.sol"; +import {IAssetRouterBase} from "../bridge/asset-router/IAssetRouterBase.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @dev Filters transactions received by the Mailbox +/// @dev Only allows whitelisted senders to deposit to Gateway +contract GatewayTransactionFilterer is ITransactionFilterer, ReentrancyGuard, Ownable2StepUpgradeable { + /// @notice Event emitted when sender is whitelisted + event WhitelistGranted(address indexed sender); + + /// @notice Event emitted when sender is removed from whitelist + event WhitelistRevoked(address indexed sender); + + /// @notice The ecosystem's Bridgehub + IBridgehub public immutable BRIDGE_HUB; + + /// @notice The L1 asset router + address public immutable L1_ASSET_ROUTER; + + /// @notice Indicates whether the sender is whitelisted to deposit to Gateway + mapping(address sender => bool whitelisted) public whitelistedSenders; + + /// @dev Contract is expected to be used as proxy implementation. + /// @dev Initialize the implementation to prevent Parity hack. + constructor(IBridgehub _bridgeHub, address _assetRouter) reentrancyGuardInitializer { + BRIDGE_HUB = _bridgeHub; + L1_ASSET_ROUTER = _assetRouter; + _disableInitializers(); + } + + /// @notice Initializes a contract filterer for later use. Expected to be used in the proxy. + /// @param _owner The address which can upgrade the implementation. + function initialize(address _owner) external reentrancyGuardInitializer initializer { + if (_owner == address(0)) { + revert ZeroAddress(); + } + _transferOwnership(_owner); + } + + /// @notice Whitelists the sender. + /// @param sender Address of the tx sender. + function grantWhitelist(address sender) external onlyOwner { + if (whitelistedSenders[sender]) { + revert AlreadyWhitelisted(sender); + } + whitelistedSenders[sender] = true; + emit WhitelistGranted(sender); + } + + /// @notice Revoke the sender from whitelist. + /// @param sender Address of the tx sender. + function revokeWhitelist(address sender) external onlyOwner { + if (!whitelistedSenders[sender]) { + revert NotWhitelisted(sender); + } + whitelistedSenders[sender] = false; + emit WhitelistRevoked(sender); + } + + /// @notice Checks if the transaction is allowed + /// @param sender The sender of the transaction + /// @param l2Calldata The calldata of the L2 transaction + /// @return Whether the transaction is allowed + function isTransactionAllowed( + address sender, + address, + uint256, + uint256, + bytes calldata l2Calldata, + address + ) external view returns (bool) { + if (sender == L1_ASSET_ROUTER) { + bytes4 l2TxSelector = bytes4(l2Calldata[:4]); + if ( + (IAssetRouterBase.finalizeDeposit.selector != l2TxSelector) && + (IL2Bridge.finalizeDeposit.selector != l2TxSelector) + ) { + revert InvalidSelector(l2TxSelector); + } + + (, bytes32 decodedAssetId, ) = abi.decode(l2Calldata[4:], (uint256, bytes32, bytes)); + address stmAddress = BRIDGE_HUB.ctmAssetIdToAddress(decodedAssetId); + return (stmAddress != address(0)); + } + + return whitelistedSenders[sender]; + } +} diff --git a/l1-contracts/contracts/upgrades/BaseZkSyncUpgrade.sol b/l1-contracts/contracts/upgrades/BaseZkSyncUpgrade.sol index 4534884d5..edae3870b 100644 --- a/l1-contracts/contracts/upgrades/BaseZkSyncUpgrade.sol +++ b/l1-contracts/contracts/upgrades/BaseZkSyncUpgrade.sol @@ -4,7 +4,7 @@ pragma solidity 0.8.24; import {SafeCast} from "@openzeppelin/contracts-v4/utils/math/SafeCast.sol"; -import {ZkSyncHyperchainBase} from "../state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol"; +import {ZKChainBase} from "../state-transition/chain-deps/facets/ZKChainBase.sol"; import {VerifierParams} from "../state-transition/chain-interfaces/IVerifier.sol"; import {IVerifier} from "../state-transition/chain-interfaces/IVerifier.sol"; import {L2ContractHelper} from "../common/libraries/L2ContractHelper.sol"; @@ -44,7 +44,7 @@ struct ProposedUpgrade { /// @author Matter Labs /// @custom:security-contact security@matterlabs.dev /// @notice Interface to which all the upgrade implementations should adhere -abstract contract BaseZkSyncUpgrade is ZkSyncHyperchainBase { +abstract contract BaseZkSyncUpgrade is ZKChainBase { /// @notice Changes the protocol version event NewProtocolVersion(uint256 indexed previousProtocolVersion, uint256 indexed newProtocolVersion); @@ -304,7 +304,7 @@ abstract contract BaseZkSyncUpgrade is ZkSyncHyperchainBase { // must be ensured in the other parts of the upgrade that the upgrade transaction is not overridden. if (!patchOnly) { // If the previous upgrade had an L2 system upgrade transaction, we require that it is finalized. - // Note it is important to keep this check, as otherwise hyperchains might skip upgrades by overwriting + // Note it is important to keep this check, as otherwise ZK chains might skip upgrades by overwriting if (s.l2SystemContractsUpgradeTxHash != bytes32(0)) { revert PreviousUpgradeNotFinalized(s.l2SystemContractsUpgradeTxHash); } diff --git a/l1-contracts/contracts/upgrades/BaseZkSyncUpgradeGenesis.sol b/l1-contracts/contracts/upgrades/BaseZkSyncUpgradeGenesis.sol index 561f25d23..49237ccfd 100644 --- a/l1-contracts/contracts/upgrades/BaseZkSyncUpgradeGenesis.sol +++ b/l1-contracts/contracts/upgrades/BaseZkSyncUpgradeGenesis.sol @@ -58,7 +58,7 @@ abstract contract BaseZkSyncUpgradeGenesis is BaseZkSyncUpgrade { // must be ensured in the other parts of the upgrade that the upgrade transaction is not overridden. if (!patchOnly) { // If the previous upgrade had an L2 system upgrade transaction, we require that it is finalized. - // Note it is important to keep this check, as otherwise hyperchains might skip upgrades by overwriting + // Note it is important to keep this check, as otherwise ZK chains might skip upgrades by overwriting if (s.l2SystemContractsUpgradeTxHash != bytes32(0)) { revert PreviousUpgradeNotFinalized(s.l2SystemContractsUpgradeTxHash); } diff --git a/l1-contracts/contracts/upgrades/CustomAssetBridging.sol b/l1-contracts/contracts/upgrades/CustomAssetBridging.sol deleted file mode 100644 index 6f7e712de..000000000 --- a/l1-contracts/contracts/upgrades/CustomAssetBridging.sol +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {Diamond} from "../state-transition/libraries/Diamond.sol"; -import {BaseZkSyncUpgrade, ProposedUpgrade} from "./BaseZkSyncUpgrade.sol"; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -/// @notice This upgrade will be used to migrate Era to be part of the hyperchain ecosystem contracts. -contract CustomAssetBridging is BaseZkSyncUpgrade { - /// @notice The main function that will be called by the upgrade proxy. - /// @param _proposedUpgrade The upgrade to be executed. - function upgrade(ProposedUpgrade calldata _proposedUpgrade) public override returns (bytes32) { - // (uint256 chainId, address bridgehubAddress, address stateTransitionManager, address sharedBridgeAddress) = abi - // .decode(_proposedUpgrade.postUpgradeCalldata, (uint256, address, address, address)); - - // s.baseTokenAssetId = - - super.upgrade(_proposedUpgrade); - return Diamond.DIAMOND_INIT_SUCCESS_RETURN_VALUE; - } -} diff --git a/l1-contracts/contracts/upgrades/GatewayUpgrade.sol b/l1-contracts/contracts/upgrades/GatewayUpgrade.sol new file mode 100644 index 000000000..9ce428f96 --- /dev/null +++ b/l1-contracts/contracts/upgrades/GatewayUpgrade.sol @@ -0,0 +1,66 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {Initializable} from "@openzeppelin/contracts-upgradeable-v4/proxy/utils/Initializable.sol"; + +import {BaseZkSyncUpgrade, ProposedUpgrade} from "./BaseZkSyncUpgrade.sol"; + +import {DataEncoding} from "../common/libraries/DataEncoding.sol"; + +import {Diamond} from "../state-transition/libraries/Diamond.sol"; +import {PriorityQueue} from "../state-transition/libraries/PriorityQueue.sol"; +import {PriorityTree} from "../state-transition/libraries/PriorityTree.sol"; + +import {IGatewayUpgrade} from "./IGatewayUpgrade.sol"; +import {IL1SharedBridgeLegacy} from "../bridge/interfaces/IL1SharedBridgeLegacy.sol"; + +import {IBridgehub} from "../bridgehub/IBridgehub.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @notice This upgrade will be used to migrate Era to be part of the ZK chain ecosystem contracts. +contract GatewayUpgrade is BaseZkSyncUpgrade, Initializable { + using PriorityQueue for PriorityQueue.Queue; + using PriorityTree for PriorityTree.Tree; + + address public immutable THIS_ADDRESS; + + constructor() { + THIS_ADDRESS = address(this); + } + + /// @notice The main function that will be called by the upgrade proxy. + /// @param _proposedUpgrade The upgrade to be executed. + function upgrade(ProposedUpgrade calldata _proposedUpgrade) public override returns (bytes32) { + (bytes memory l2TxDataStart, bytes memory l2TxDataFinish) = abi.decode( + _proposedUpgrade.postUpgradeCalldata, + (bytes, bytes) + ); + + s.baseTokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, s.__DEPRECATED_baseToken); + s.priorityTree.setup(s.priorityQueue.getTotalPriorityTxs()); + IBridgehub(s.bridgehub).setLegacyBaseTokenAssetId(s.chainId); + ProposedUpgrade memory proposedUpgrade = _proposedUpgrade; + address l2LegacyBridge = IL1SharedBridgeLegacy(s.baseTokenBridge).l2BridgeAddress(s.chainId); + proposedUpgrade.l2ProtocolUpgradeTx.data = bytes.concat( + l2TxDataStart, + bytes32(uint256(uint160(l2LegacyBridge))), + l2TxDataFinish + ); + // slither-disable-next-line controlled-delegatecall + (bool success, ) = THIS_ADDRESS.delegatecall( + abi.encodeWithSelector(IGatewayUpgrade.upgradeExternal.selector, proposedUpgrade) + ); + // solhint-disable-next-line gas-custom-errors + require(success, "GatewayUpgrade: upgrade failed"); + return Diamond.DIAMOND_INIT_SUCCESS_RETURN_VALUE; + } + + /// @notice The function that will be called from this same contract, we need an external call to be able to modify _proposedUpgrade (memory/calldata). + function upgradeExternal(ProposedUpgrade calldata _proposedUpgrade) external { + // solhint-disable-next-line gas-custom-errors + require(msg.sender == address(this), "GatewayUpgrade: upgradeExternal"); + super.upgrade(_proposedUpgrade); + } +} diff --git a/l1-contracts/contracts/upgrades/IGatewayUpgrade.sol b/l1-contracts/contracts/upgrades/IGatewayUpgrade.sol new file mode 100644 index 000000000..eaa74c75b --- /dev/null +++ b/l1-contracts/contracts/upgrades/IGatewayUpgrade.sol @@ -0,0 +1,9 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {ProposedUpgrade} from "./BaseZkSyncUpgrade.sol"; + +interface IGatewayUpgrade { + function upgradeExternal(ProposedUpgrade calldata _upgrade) external returns (bytes32); +} diff --git a/l1-contracts/contracts/upgrades/IL1GenesisUpgrade.sol b/l1-contracts/contracts/upgrades/IL1GenesisUpgrade.sol index 345c70cbe..57dd40131 100644 --- a/l1-contracts/contracts/upgrades/IL1GenesisUpgrade.sol +++ b/l1-contracts/contracts/upgrades/IL1GenesisUpgrade.sol @@ -7,7 +7,7 @@ import {L2CanonicalTransaction} from "../common/Messaging.sol"; interface IL1GenesisUpgrade { /// @dev emitted when a chain registers and a GenesisUpgrade happens event GenesisUpgrade( - address indexed _hyperchain, + address indexed _zkChain, L2CanonicalTransaction _l2Transaction, uint256 indexed _protocolVersion, bytes[] _factoryDeps @@ -17,6 +17,7 @@ interface IL1GenesisUpgrade { address _l1GenesisUpgrade, uint256 _chainId, uint256 _protocolVersion, + address _l1CtmDeployerAddress, bytes calldata _forceDeployments, bytes[] calldata _factoryDeps ) external returns (bytes32); diff --git a/l1-contracts/contracts/upgrades/L1GenesisUpgrade.sol b/l1-contracts/contracts/upgrades/L1GenesisUpgrade.sol index 5c20aa56b..4637c535d 100644 --- a/l1-contracts/contracts/upgrades/L1GenesisUpgrade.sol +++ b/l1-contracts/contracts/upgrades/L1GenesisUpgrade.sol @@ -2,7 +2,7 @@ pragma solidity 0.8.24; -import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol"; +import {SafeCast} from "@openzeppelin/contracts-v4/utils/math/SafeCast.sol"; import {Diamond} from "../state-transition/libraries/Diamond.sol"; import {BaseZkSyncUpgradeGenesis} from "./BaseZkSyncUpgradeGenesis.sol"; @@ -26,6 +26,7 @@ contract L1GenesisUpgrade is IL1GenesisUpgrade, BaseZkSyncUpgradeGenesis { address _l1GenesisUpgrade, uint256 _chainId, uint256 _protocolVersion, + address _l1CtmDeployerAddress, bytes calldata _forceDeploymentsData, bytes[] calldata _factoryDeps ) public override returns (bytes32) { @@ -36,7 +37,7 @@ contract L1GenesisUpgrade is IL1GenesisUpgrade, BaseZkSyncUpgradeGenesis { { bytes memory l2GenesisUpgradeCalldata = abi.encodeCall( IL2GenesisUpgrade.genesisUpgrade, - (_chainId, _forceDeploymentsData) + (_chainId, _l1CtmDeployerAddress, _forceDeploymentsData) ); complexUpgraderCalldata = abi.encodeCall( IComplexUpgrader.upgrade, diff --git a/l1-contracts/contracts/vendor/AddressAliasHelper.sol b/l1-contracts/contracts/vendor/AddressAliasHelper.sol index ad80f3483..b604e9d24 100644 --- a/l1-contracts/contracts/vendor/AddressAliasHelper.sol +++ b/l1-contracts/contracts/vendor/AddressAliasHelper.sol @@ -43,19 +43,19 @@ library AddressAliasHelper { /// @notice Utility function used to calculate the correct refund recipient /// @param _refundRecipient the address that should receive the refund - /// @param _prevMsgSender the address that triggered the tx to L2 + /// @param _originalCaller the address that triggered the tx to L2 /// @return _recipient the corrected address that should receive the refund function actualRefundRecipient( address _refundRecipient, - address _prevMsgSender + address _originalCaller ) internal view returns (address _recipient) { if (_refundRecipient == address(0)) { - // If the `_refundRecipient` is not provided, we use the `_prevMsgSender` as the recipient. + // If the `_refundRecipient` is not provided, we use the `_originalCaller` as the recipient. // solhint-disable avoid-tx-origin // slither-disable-next-line tx-origin - _recipient = _prevMsgSender == tx.origin - ? _prevMsgSender - : AddressAliasHelper.applyL1ToL2Alias(_prevMsgSender); + _recipient = _originalCaller == tx.origin + ? _originalCaller + : AddressAliasHelper.applyL1ToL2Alias(_originalCaller); // solhint-enable avoid-tx-origin } else if (_refundRecipient.code.length > 0) { // If the `_refundRecipient` is a smart contract, we apply the L1 to L2 alias to prevent foot guns. diff --git a/l1-contracts/deploy-script-config-template/config-deploy-l2-config.toml b/l1-contracts/deploy-script-config-template/config-deploy-l2-config.toml index 67e46ae38..fae9cc907 100644 --- a/l1-contracts/deploy-script-config-template/config-deploy-l2-config.toml +++ b/l1-contracts/deploy-script-config-template/config-deploy-l2-config.toml @@ -4,3 +4,4 @@ l1_shared_bridge = "0x2ae37d8130b82c7e79b3863a39027178e073eedb" bridgehub = "0xea785a9c91a07ed69b83eb165f4ce2c30ecb4c0b" governance = "0x6a08d69675af7755569a1a25ef37e795493473a1" erc20_bridge = "0x84fbda16bd5f2d66d7fbaec5e8d816e7b7014595" +consensus_registry_owner = "0xD64e136566a9E04eb05B30184fF577F52682D182" diff --git a/l1-contracts/deploy-scripts/AcceptAdmin.s.sol b/l1-contracts/deploy-scripts/AcceptAdmin.s.sol index 9262a5cd8..2eff6dc07 100644 --- a/l1-contracts/deploy-scripts/AcceptAdmin.s.sol +++ b/l1-contracts/deploy-scripts/AcceptAdmin.s.sol @@ -4,7 +4,7 @@ pragma solidity ^0.8.21; import {Script} from "forge-std/Script.sol"; import {Ownable2Step} from "@openzeppelin/contracts-v4/access/Ownable2Step.sol"; -import {IZkSyncHyperchain} from "contracts/state-transition/chain-interfaces/IZkSyncHyperchain.sol"; +import {IZKChain} from "contracts/state-transition/chain-interfaces/IZKChain.sol"; import {ChainAdmin} from "contracts/governance/ChainAdmin.sol"; import {IChainAdmin} from "contracts/governance/IChainAdmin.sol"; import {Utils} from "./Utils.sol"; @@ -28,11 +28,9 @@ contract AcceptAdmin is Script { config.governor = toml.readAddress("$.governor"); } - // This function should be called by the owner to accept the owner role - function acceptOwner() public { - initConfig(); - - Ownable2Step adminContract = Ownable2Step(config.admin); + // This function should be called by the owner to accept the admin role + function governanceAcceptOwner(address governor, address target) public { + Ownable2Step adminContract = Ownable2Step(target); Utils.executeUpgrade({ _governor: governor, _salt: bytes32(0), @@ -44,21 +42,21 @@ contract AcceptAdmin is Script { } // This function should be called by the owner to accept the admin role - function acceptAdmin(address payable _admin, address _target) public { - IZkSyncHyperchain hyperchain = IZkSyncHyperchain(_target); - ChainAdmin chainAdmin = ChainAdmin(_admin); - - IChainAdmin.Call[] memory calls = new IChainAdmin.Call[](1); - calls[0] = IChainAdmin.Call({target: _target, value: 0, data: abi.encodeCall(hyperchain.acceptAdmin, ())}); - - vm.startBroadcast(); - chainAdmin.multicall(calls, true); - vm.stopBroadcast(); + function governanceAcceptAdmin(address governor, address target) public { + IZKChain adminContract = IZKChain(target); + Utils.executeUpgrade({ + _governor: governor, + _salt: bytes32(0), + _target: target, + _data: abi.encodeCall(adminContract.acceptAdmin, ()), + _value: 0, + _delay: 0 + }); } // This function should be called by the owner to accept the admin role function chainAdminAcceptAdmin(ChainAdmin chainAdmin, address target) public { - IZkSyncHyperchain adminContract = IZkSyncHyperchain(target); + IZKChain adminContract = IZKChain(target); IChainAdmin.Call[] memory calls = new IChainAdmin.Call[](1); calls[0] = IChainAdmin.Call({target: target, value: 0, data: abi.encodeCall(adminContract.acceptAdmin, ())}); diff --git a/l1-contracts/deploy-scripts/DecentralizeGovernanceUpgradeScript.s.sol b/l1-contracts/deploy-scripts/DecentralizeGovernanceUpgradeScript.s.sol index 1e35d3fe4..39ecc4efd 100644 --- a/l1-contracts/deploy-scripts/DecentralizeGovernanceUpgradeScript.s.sol +++ b/l1-contracts/deploy-scripts/DecentralizeGovernanceUpgradeScript.s.sol @@ -8,20 +8,22 @@ import {ProxyAdmin} from "@openzeppelin/contracts-v4/proxy/transparent/ProxyAdmi import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; import {Governance} from "contracts/governance/Governance.sol"; -import {IStateTransitionManager} from "contracts/state-transition/IStateTransitionManager.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; import {Utils} from "./Utils.sol"; contract DecentralizeGovernanceUpgradeScript is Script { - function upgradeSTM( + function upgradeCTM( ProxyAdmin _proxyAdmin, - ITransparentUpgradeableProxy _stmProxy, + ITransparentUpgradeableProxy _ctmProxy, Governance _governance, - address _newStmImpl + address _newCtmImpl ) public { - require(_proxyAdmin.getProxyAdmin(_stmProxy) == address(_proxyAdmin)); - require(_proxyAdmin.owner() == address(_governance)); + // solhint-disable-next-line gas-custom-errors + require(_proxyAdmin.getProxyAdmin(_ctmProxy) == address(_proxyAdmin), "Proxy admin incorrect"); + // solhint-disable-next-line gas-custom-errors + require(_proxyAdmin.owner() == address(_governance), "Proxy admin owner incorrect"); - bytes memory proxyAdminUpgradeData = abi.encodeCall(ProxyAdmin.upgrade, (_stmProxy, _newStmImpl)); + bytes memory proxyAdminUpgradeData = abi.encodeCall(ProxyAdmin.upgrade, (_ctmProxy, _newCtmImpl)); Utils.executeUpgrade({ _governor: address(_governance), @@ -34,7 +36,7 @@ contract DecentralizeGovernanceUpgradeScript is Script { } function setPendingAdmin(address _target, Governance _governance, address _pendingAdmin) public { - bytes memory upgradeData = abi.encodeCall(IStateTransitionManager.setPendingAdmin, (_pendingAdmin)); + bytes memory upgradeData = abi.encodeCall(IChainTypeManager.setPendingAdmin, (_pendingAdmin)); Utils.executeUpgrade({ _governor: address(_governance), _salt: bytes32(0), diff --git a/l1-contracts/deploy-scripts/DeployErc20.s.sol b/l1-contracts/deploy-scripts/DeployErc20.s.sol index 6b58a2acb..400c1ff1f 100644 --- a/l1-contracts/deploy-scripts/DeployErc20.s.sol +++ b/l1-contracts/deploy-scripts/DeployErc20.s.sol @@ -128,11 +128,14 @@ contract DeployErc20Script is Script { if (mint > 0) { vm.broadcast(); additionalAddressesForMinting.push(config.deployerAddress); - // solhint-disable-next-line gas-length-in-loops - for (uint256 i = 0; i < additionalAddressesForMinting.length; ++i) { + uint256 addressMintListLength = additionalAddressesForMinting.length; + for (uint256 i = 0; i < addressMintListLength; ++i) { (bool success, ) = tokenAddress.call( abi.encodeWithSignature("mint(address,uint256)", additionalAddressesForMinting[i], mint) ); + if (!success) { + revert MintFailed(); + } console.log("Minting to:", additionalAddressesForMinting[i]); if (!success) { revert MintFailed(); diff --git a/l1-contracts/deploy-scripts/DeployL1.s.sol b/l1-contracts/deploy-scripts/DeployL1.s.sol index 71813c016..868fdbc47 100644 --- a/l1-contracts/deploy-scripts/DeployL1.s.sol +++ b/l1-contracts/deploy-scripts/DeployL1.s.sol @@ -7,7 +7,7 @@ import {Script, console2 as console} from "forge-std/Script.sol"; import {stdToml} from "forge-std/StdToml.sol"; import {ProxyAdmin} from "@openzeppelin/contracts-v4/proxy/transparent/ProxyAdmin.sol"; import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; - +import {UpgradeableBeacon} from "@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol"; import {Utils} from "./Utils.sol"; import {Multicall3} from "contracts/dev-contracts/Multicall3.sol"; import {Verifier} from "contracts/state-transition/Verifier.sol"; @@ -20,28 +20,33 @@ import {ChainAdmin} from "contracts/governance/ChainAdmin.sol"; import {ValidatorTimelock} from "contracts/state-transition/ValidatorTimelock.sol"; import {Bridgehub} from "contracts/bridgehub/Bridgehub.sol"; import {MessageRoot} from "contracts/bridgehub/MessageRoot.sol"; -import {STMDeploymentTracker} from "contracts/bridgehub/STMDeploymentTracker.sol"; -import {L1NativeTokenVault} from "contracts/bridge/L1NativeTokenVault.sol"; +import {CTMDeploymentTracker} from "contracts/bridgehub/CTMDeploymentTracker.sol"; +import {L1NativeTokenVault} from "contracts/bridge/ntv/L1NativeTokenVault.sol"; import {ExecutorFacet} from "contracts/state-transition/chain-deps/facets/Executor.sol"; import {AdminFacet} from "contracts/state-transition/chain-deps/facets/Admin.sol"; import {MailboxFacet} from "contracts/state-transition/chain-deps/facets/Mailbox.sol"; import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; import {DiamondInit} from "contracts/state-transition/chain-deps/DiamondInit.sol"; -import {StateTransitionManager} from "contracts/state-transition/StateTransitionManager.sol"; -import {StateTransitionManagerInitializeData, ChainCreationParams} from "contracts/state-transition/IStateTransitionManager.sol"; -import {IStateTransitionManager} from "contracts/state-transition/IStateTransitionManager.sol"; +import {ChainTypeManager} from "contracts/state-transition/ChainTypeManager.sol"; +import {ChainTypeManagerInitializeData, ChainCreationParams} from "contracts/state-transition/IChainTypeManager.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; import {InitializeDataNewChain as DiamondInitializeDataNewChain} from "contracts/state-transition/chain-interfaces/IDiamondInit.sol"; -import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; -import {L1AssetRouter} from "contracts/bridge/L1AssetRouter.sol"; +import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; +import {L1AssetRouter} from "contracts/bridge/asset-router/L1AssetRouter.sol"; import {L1ERC20Bridge} from "contracts/bridge/L1ERC20Bridge.sol"; +import {L1Nullifier} from "contracts/bridge/L1Nullifier.sol"; import {DiamondProxy} from "contracts/state-transition/chain-deps/DiamondProxy.sol"; -import {IL1AssetRouter} from "contracts/bridge/interfaces/IL1AssetRouter.sol"; -import {IL1NativeTokenVault} from "contracts/bridge/interfaces/IL1NativeTokenVault.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; +import {INativeTokenVault} from "contracts/bridge/ntv/INativeTokenVault.sol"; +import {BridgedStandardERC20} from "contracts/bridge/BridgedStandardERC20.sol"; import {AddressHasNoCode} from "./ZkSyncScriptErrors.sol"; +import {IL1Nullifier} from "contracts/bridge/L1Nullifier.sol"; +import {IL1NativeTokenVault} from "contracts/bridge/ntv/IL1NativeTokenVault.sol"; -import {ISTMDeploymentTracker} from "contracts/bridgehub/ISTMDeploymentTracker.sol"; +import {ICTMDeploymentTracker} from "contracts/bridgehub/ICTMDeploymentTracker.sol"; import {IMessageRoot} from "contracts/bridgehub/IMessageRoot.sol"; +import {IAssetRouterBase} from "contracts/bridge/asset-router/IAssetRouterBase.sol"; contract DeployL1Script is Script { using stdToml for string; @@ -73,8 +78,8 @@ contract DeployL1Script is Script { struct BridgehubDeployedAddresses { address bridgehubImplementation; address bridgehubProxy; - address stmDeploymentTrackerImplementation; - address stmDeploymentTrackerProxy; + address ctmDeploymentTrackerImplementation; + address ctmDeploymentTrackerProxy; address messageRootImplementation; address messageRootProxy; } @@ -100,6 +105,10 @@ contract DeployL1Script is Script { address erc20BridgeProxy; address sharedBridgeImplementation; address sharedBridgeProxy; + address l1NullifierImplementation; + address l1NullifierProxy; + address bridgedStandardERC20Implementation; + address bridgedTokenBeacon; } // solhint-disable-next-line gas-struct-packing @@ -169,18 +178,21 @@ contract DeployL1Script is Script { deployBridgehubContract(); deployMessageRootContract(); + deployL1NullifierContracts(); deploySharedBridgeContracts(); + deployBridgedStandardERC20Implementation(); + deployBridgedTokenBeacon(); deployL1NativeTokenVaultImplementation(); deployL1NativeTokenVaultProxy(); deployErc20BridgeImplementation(); deployErc20BridgeProxy(); updateSharedBridge(); - deploySTMDeploymentTracker(); + deployCTMDeploymentTracker(); registerSharedBridge(); deployBlobVersionedHashRetriever(); - deployStateTransitionManagerContract(); - setStateTransitionManagerInValidatorTimelock(); + deployChainTypeManagerContract(); + setChainTypeManagerInValidatorTimelock(); // deployDiamondProxy(); @@ -197,11 +209,19 @@ contract DeployL1Script is Script { return addresses.bridges.sharedBridgeProxy; } + function getNativeTokenVaultProxyAddress() public view returns (address) { + return addresses.vaults.l1NativeTokenVaultProxy; + } + + function getL1NullifierProxyAddress() public view returns (address) { + return addresses.bridges.l1NullifierProxy; + } + function getOwnerAddress() public view returns (address) { return config.ownerAddress; } - function getSTM() public view returns (address) { + function getCTM() public view returns (address) { return addresses.stateTransition.stateTransitionProxy; } @@ -350,7 +370,17 @@ contract DeployL1Script is Script { } function deployChainAdmin() internal { - bytes memory bytecode = abi.encodePacked(type(ChainAdmin).creationCode, abi.encode(config.ownerAddress)); + bytes memory accessControlRestrictionBytecode = abi.encodePacked( + type(ChainAdmin).creationCode, + abi.encode(uint256(0), config.ownerAddress) + ); + + address accessControlRestriction = deployViaCreate2(accessControlRestrictionBytecode); + console.log("Access control restriction deployed at:", accessControlRestriction); + address[] memory restrictions = new address[](1); + restrictions[0] = accessControlRestriction; + + bytes memory bytecode = abi.encodePacked(type(ChainAdmin).creationCode, abi.encode(restrictions)); address contractAddress = deployViaCreate2(bytecode); console.log("ChainAdmin deployed at:", contractAddress); addresses.chainAdmin = contractAddress; @@ -368,7 +398,7 @@ contract DeployL1Script is Script { function deployBridgehubContract() internal { bytes memory bridgeHubBytecode = abi.encodePacked( type(Bridgehub).creationCode, - abi.encode(config.l1ChainId, config.ownerAddress) + abi.encode(config.l1ChainId, config.ownerAddress, (config.contracts.maxNumberOfChains)) ); address bridgehubImplementation = deployViaCreate2(bridgeHubBytecode); console.log("Bridgehub Implementation deployed at:", bridgehubImplementation); @@ -409,26 +439,26 @@ contract DeployL1Script is Script { addresses.bridgehub.messageRootProxy = messageRootProxy; } - function deploySTMDeploymentTracker() internal { - bytes memory stmDTBytecode = abi.encodePacked( - type(STMDeploymentTracker).creationCode, + function deployCTMDeploymentTracker() internal { + bytes memory ctmDTBytecode = abi.encodePacked( + type(CTMDeploymentTracker).creationCode, abi.encode(addresses.bridgehub.bridgehubProxy, addresses.bridges.sharedBridgeProxy) ); - address stmDTImplementation = deployViaCreate2(stmDTBytecode); - console.log("STM Deployment Tracker Implementation deployed at:", stmDTImplementation); - addresses.bridgehub.stmDeploymentTrackerImplementation = stmDTImplementation; + address ctmDTImplementation = deployViaCreate2(ctmDTBytecode); + console.log("CTM Deployment Tracker Implementation deployed at:", ctmDTImplementation); + addresses.bridgehub.ctmDeploymentTrackerImplementation = ctmDTImplementation; bytes memory bytecode = abi.encodePacked( type(TransparentUpgradeableProxy).creationCode, abi.encode( - stmDTImplementation, + ctmDTImplementation, addresses.transparentProxyAdmin, - abi.encodeCall(STMDeploymentTracker.initialize, (config.deployerAddress)) + abi.encodeCall(CTMDeploymentTracker.initialize, (config.deployerAddress)) ) ); - address stmDTProxy = deployViaCreate2(bytecode); - console.log("STM Deployment Tracker Proxy deployed at:", stmDTProxy); - addresses.bridgehub.stmDeploymentTrackerProxy = stmDTProxy; + address ctmDTProxy = deployViaCreate2(bytecode); + console.log("CTM Deployment Tracker Proxy deployed at:", ctmDTProxy); + addresses.bridgehub.ctmDeploymentTrackerProxy = ctmDTProxy; } function deployBlobVersionedHashRetriever() internal { @@ -439,11 +469,11 @@ contract DeployL1Script is Script { addresses.blobVersionedHashRetriever = contractAddress; } - function deployStateTransitionManagerContract() internal { + function deployChainTypeManagerContract() internal { deployStateTransitionDiamondFacets(); - deployStateTransitionManagerImplementation(); - deployStateTransitionManagerProxy(); - registerStateTransitionManager(); + deployChainTypeManagerImplementation(); + deployChainTypeManagerProxy(); + registerChainTypeManager(); } function deployStateTransitionDiamondFacets() internal { @@ -451,12 +481,14 @@ contract DeployL1Script is Script { console.log("ExecutorFacet deployed at:", executorFacet); addresses.stateTransition.executorFacet = executorFacet; - address adminFacet = deployViaCreate2(type(AdminFacet).creationCode); + address adminFacet = deployViaCreate2( + abi.encodePacked(type(AdminFacet).creationCode, abi.encode(config.l1ChainId)) + ); console.log("AdminFacet deployed at:", adminFacet); addresses.stateTransition.adminFacet = adminFacet; address mailboxFacet = deployViaCreate2( - abi.encodePacked(type(MailboxFacet).creationCode, abi.encode(config.eraChainId)) + abi.encodePacked(type(MailboxFacet).creationCode, abi.encode(config.eraChainId, config.l1ChainId)) ); console.log("MailboxFacet deployed at:", mailboxFacet); addresses.stateTransition.mailboxFacet = mailboxFacet; @@ -470,18 +502,17 @@ contract DeployL1Script is Script { addresses.stateTransition.diamondInit = diamondInit; } - function deployStateTransitionManagerImplementation() internal { + function deployChainTypeManagerImplementation() internal { bytes memory bytecode = abi.encodePacked( - type(StateTransitionManager).creationCode, - abi.encode(addresses.bridgehub.bridgehubProxy), - abi.encode(config.contracts.maxNumberOfChains) + type(ChainTypeManager).creationCode, + abi.encode(addresses.bridgehub.bridgehubProxy) ); address contractAddress = deployViaCreate2(bytecode); - console.log("StateTransitionManagerImplementation deployed at:", contractAddress); + console.log("ChainTypeManagerImplementation deployed at:", contractAddress); addresses.stateTransition.stateTransitionImplementation = contractAddress; } - function deployStateTransitionManagerProxy() internal { + function deployChainTypeManagerProxy() internal { Diamond.FacetCut[] memory facetCuts = new Diamond.FacetCut[](4); facetCuts[0] = Diamond.FacetCut({ facet: addresses.stateTransition.adminFacet, @@ -550,7 +581,7 @@ contract DeployL1Script is Script { forceDeploymentsData: config.contracts.forceDeploymentsData }); - StateTransitionManagerInitializeData memory diamondInitData = StateTransitionManagerInitializeData({ + ChainTypeManagerInitializeData memory diamondInitData = ChainTypeManagerInitializeData({ owner: msg.sender, validatorTimelock: addresses.validatorTimelock, chainCreationParams: chainCreationParams, @@ -563,49 +594,47 @@ contract DeployL1Script is Script { abi.encode( addresses.stateTransition.stateTransitionImplementation, addresses.transparentProxyAdmin, - abi.encodeCall(StateTransitionManager.initialize, (diamondInitData)) + abi.encodeCall(ChainTypeManager.initialize, (diamondInitData)) ) ) ); - console.log("StateTransitionManagerProxy deployed at:", contractAddress); + console.log("ChainTypeManagerProxy deployed at:", contractAddress); addresses.stateTransition.stateTransitionProxy = contractAddress; } - function registerStateTransitionManager() internal { + function registerChainTypeManager() internal { Bridgehub bridgehub = Bridgehub(addresses.bridgehub.bridgehubProxy); vm.startBroadcast(msg.sender); - bridgehub.addStateTransitionManager(addresses.stateTransition.stateTransitionProxy); - console.log("StateTransitionManager registered"); - STMDeploymentTracker stmDT = STMDeploymentTracker(addresses.bridgehub.stmDeploymentTrackerProxy); + bridgehub.addChainTypeManager(addresses.stateTransition.stateTransitionProxy); + console.log("ChainTypeManager registered"); + CTMDeploymentTracker ctmDT = CTMDeploymentTracker(addresses.bridgehub.ctmDeploymentTrackerProxy); // vm.startBroadcast(msg.sender); L1AssetRouter sharedBridge = L1AssetRouter(addresses.bridges.sharedBridgeProxy); sharedBridge.setAssetDeploymentTracker( bytes32(uint256(uint160(addresses.stateTransition.stateTransitionProxy))), - address(stmDT) + address(ctmDT) ); - console.log("STM DT whitelisted"); + console.log("CTM DT whitelisted"); - stmDT.registerSTMAssetOnL1(addresses.stateTransition.stateTransitionProxy); + ctmDT.registerCTMAssetOnL1(addresses.stateTransition.stateTransitionProxy); vm.stopBroadcast(); - console.log("STM registered in STMDeploymentTracker"); + console.log("CTM registered in CTMDeploymentTracker"); - bytes32 assetId = bridgehub.stmAssetId(addresses.stateTransition.stateTransitionProxy); - // console.log(address(bridgehub.stmDeployer()), addresses.bridgehub.stmDeploymentTrackerProxy); - // console.log(address(bridgehub.stmDeployer().BRIDGE_HUB()), addresses.bridgehub.bridgehubProxy); + bytes32 assetId = bridgehub.ctmAssetId(addresses.stateTransition.stateTransitionProxy); + // console.log(address(bridgehub.ctmDeployer()), addresses.bridgehub.ctmDeploymentTrackerProxy); + // console.log(address(bridgehub.ctmDeployer().BRIDGE_HUB()), addresses.bridgehub.bridgehubProxy); console.log( - "STM in router 1", + "CTM in router 1", sharedBridge.assetHandlerAddress(assetId), - bridgehub.stmAssetIdToAddress(assetId) + bridgehub.ctmAssetIdToAddress(assetId) ); } - function setStateTransitionManagerInValidatorTimelock() internal { + function setChainTypeManagerInValidatorTimelock() internal { ValidatorTimelock validatorTimelock = ValidatorTimelock(addresses.validatorTimelock); vm.broadcast(msg.sender); - validatorTimelock.setStateTransitionManager( - IStateTransitionManager(addresses.stateTransition.stateTransitionProxy) - ); - console.log("StateTransitionManager set in ValidatorTimelock"); + validatorTimelock.setChainTypeManager(IChainTypeManager(addresses.stateTransition.stateTransitionProxy)); + console.log("ChainTypeManager set in ValidatorTimelock"); } function deployDiamondProxy() internal { @@ -635,6 +664,33 @@ contract DeployL1Script is Script { deploySharedBridgeProxy(); } + function deployL1NullifierContracts() internal { + deployL1NullifierImplementation(); + deployL1NullifierProxy(); + } + + function deployL1NullifierImplementation() internal { + bytes memory bytecode = abi.encodePacked( + type(L1Nullifier).creationCode, + // solhint-disable-next-line func-named-parameters + abi.encode(addresses.bridgehub.bridgehubProxy, config.eraChainId, addresses.stateTransition.diamondProxy) + ); + address contractAddress = deployViaCreate2(bytecode); + console.log("L1NullifierImplementation deployed at:", contractAddress); + addresses.bridges.l1NullifierImplementation = contractAddress; + } + + function deployL1NullifierProxy() internal { + bytes memory initCalldata = abi.encodeCall(L1Nullifier.initialize, (config.deployerAddress, 1, 1, 1, 0)); + bytes memory bytecode = abi.encodePacked( + type(TransparentUpgradeableProxy).creationCode, + abi.encode(addresses.bridges.l1NullifierImplementation, addresses.transparentProxyAdmin, initCalldata) + ); + address contractAddress = deployViaCreate2(bytecode); + console.log("L1NullifierProxy deployed at:", contractAddress); + addresses.bridges.l1NullifierProxy = contractAddress; + } + function deploySharedBridgeImplementation() internal { bytes memory bytecode = abi.encodePacked( type(L1AssetRouter).creationCode, @@ -642,6 +698,7 @@ contract DeployL1Script is Script { abi.encode( config.tokens.tokenWethAddress, addresses.bridgehub.bridgehubProxy, + addresses.bridges.l1NullifierProxy, config.eraChainId, addresses.stateTransition.diamondProxy ) @@ -652,7 +709,7 @@ contract DeployL1Script is Script { } function deploySharedBridgeProxy() internal { - bytes memory initCalldata = abi.encodeCall(L1AssetRouter.initialize, (config.deployerAddress, 1, 1, 1, 0)); + bytes memory initCalldata = abi.encodeCall(L1AssetRouter.initialize, (config.deployerAddress)); bytes memory bytecode = abi.encodePacked( type(TransparentUpgradeableProxy).creationCode, abi.encode(addresses.bridges.sharedBridgeImplementation, addresses.transparentProxyAdmin, initCalldata) @@ -665,11 +722,11 @@ contract DeployL1Script is Script { function registerSharedBridge() internal { Bridgehub bridgehub = Bridgehub(addresses.bridgehub.bridgehubProxy); vm.startBroadcast(msg.sender); - bridgehub.addToken(ADDRESS_ONE); + bridgehub.addTokenAssetId(bridgehub.baseTokenAssetId(config.eraChainId)); // bridgehub.setSharedBridge(addresses.bridges.sharedBridgeProxy); bridgehub.setAddresses( addresses.bridges.sharedBridgeProxy, - ISTMDeploymentTracker(addresses.bridgehub.stmDeploymentTrackerProxy), + ICTMDeploymentTracker(addresses.bridgehub.ctmDeploymentTrackerProxy), IMessageRoot(addresses.bridgehub.messageRootProxy) ); vm.stopBroadcast(); @@ -679,7 +736,12 @@ contract DeployL1Script is Script { function deployErc20BridgeImplementation() internal { bytes memory bytecode = abi.encodePacked( type(L1ERC20Bridge).creationCode, - abi.encode(addresses.bridges.sharedBridgeProxy, addresses.vaults.l1NativeTokenVaultProxy, config.eraChainId) + abi.encode( + addresses.bridges.l1NullifierProxy, + addresses.bridges.sharedBridgeProxy, + addresses.vaults.l1NativeTokenVaultProxy, + config.eraChainId + ) ); address contractAddress = deployViaCreate2(bytecode); console.log("Erc20BridgeImplementation deployed at:", contractAddress); @@ -700,14 +762,44 @@ contract DeployL1Script is Script { function updateSharedBridge() internal { L1AssetRouter sharedBridge = L1AssetRouter(addresses.bridges.sharedBridgeProxy); vm.broadcast(msg.sender); - sharedBridge.setL1Erc20Bridge(addresses.bridges.erc20BridgeProxy); + sharedBridge.setL1Erc20Bridge(L1ERC20Bridge(addresses.bridges.erc20BridgeProxy)); console.log("SharedBridge updated with ERC20Bridge address"); } + function deployBridgedStandardERC20Implementation() internal { + bytes memory bytecode = abi.encodePacked( + type(BridgedStandardERC20).creationCode, + // solhint-disable-next-line func-named-parameters + abi.encode() + ); + address contractAddress = deployViaCreate2(bytecode); + console.log("BridgedStandardERC20Implementation deployed at:", contractAddress); + addresses.bridges.bridgedStandardERC20Implementation = contractAddress; + } + + function deployBridgedTokenBeacon() internal { + bytes memory bytecode = abi.encodePacked( + type(UpgradeableBeacon).creationCode, + // solhint-disable-next-line func-named-parameters + abi.encode(addresses.bridges.bridgedStandardERC20Implementation) + ); + UpgradeableBeacon beacon = new UpgradeableBeacon(addresses.bridges.bridgedStandardERC20Implementation); + address contractAddress = address(beacon); + beacon.transferOwnership(config.ownerAddress); + console.log("BridgedTokenBeacon deployed at:", contractAddress); + addresses.bridges.bridgedTokenBeacon = contractAddress; + } + function deployL1NativeTokenVaultImplementation() internal { bytes memory bytecode = abi.encodePacked( type(L1NativeTokenVault).creationCode, - abi.encode(config.tokens.tokenWethAddress, addresses.bridges.sharedBridgeProxy, config.eraChainId) + // solhint-disable-next-line func-named-parameters + abi.encode( + config.tokens.tokenWethAddress, + addresses.bridges.sharedBridgeProxy, + config.eraChainId, + addresses.bridges.l1NullifierProxy + ) ); address contractAddress = deployViaCreate2(bytecode); console.log("L1NativeTokenVaultImplementation deployed at:", contractAddress); @@ -715,7 +807,10 @@ contract DeployL1Script is Script { } function deployL1NativeTokenVaultProxy() internal { - bytes memory initCalldata = abi.encodeCall(L1NativeTokenVault.initialize, config.ownerAddress); + bytes memory initCalldata = abi.encodeCall( + L1NativeTokenVault.initialize, + (config.ownerAddress, addresses.bridges.bridgedTokenBeacon) + ); bytes memory bytecode = abi.encodePacked( type(TransparentUpgradeableProxy).creationCode, abi.encode(addresses.vaults.l1NativeTokenVaultImplementation, addresses.transparentProxyAdmin, initCalldata) @@ -725,10 +820,19 @@ contract DeployL1Script is Script { addresses.vaults.l1NativeTokenVaultProxy = contractAddress; IL1AssetRouter sharedBridge = IL1AssetRouter(addresses.bridges.sharedBridgeProxy); + IL1Nullifier l1Nullifier = IL1Nullifier(addresses.bridges.l1NullifierProxy); // Ownable ownable = Ownable(addresses.bridges.sharedBridgeProxy); vm.broadcast(msg.sender); - sharedBridge.setNativeTokenVault(IL1NativeTokenVault(addresses.vaults.l1NativeTokenVaultProxy)); + sharedBridge.setNativeTokenVault(INativeTokenVault(addresses.vaults.l1NativeTokenVaultProxy)); + vm.broadcast(msg.sender); + l1Nullifier.setL1NativeTokenVault(IL1NativeTokenVault(addresses.vaults.l1NativeTokenVaultProxy)); + vm.broadcast(msg.sender); + l1Nullifier.setL1AssetRouter(addresses.bridges.sharedBridgeProxy); + + vm.broadcast(msg.sender); + IL1NativeTokenVault(addresses.vaults.l1NativeTokenVaultProxy).registerEthToken(); + // bytes memory data = abi.encodeCall(sharedBridge.setNativeTokenVault, (IL1NativeTokenVault(addresses.vaults.l1NativeTokenVaultProxy))); // Utils.executeUpgrade({ // _governor: ownable.owner(), @@ -752,8 +856,8 @@ contract DeployL1Script is Script { L1AssetRouter sharedBridge = L1AssetRouter(addresses.bridges.sharedBridgeProxy); sharedBridge.transferOwnership(addresses.governance); - StateTransitionManager stm = StateTransitionManager(addresses.stateTransition.stateTransitionProxy); - stm.transferOwnership(addresses.governance); + ChainTypeManager ctm = ChainTypeManager(addresses.stateTransition.stateTransitionProxy); + ctm.transferOwnership(addresses.governance); vm.stopBroadcast(); console.log("Owners updated"); @@ -763,13 +867,13 @@ contract DeployL1Script is Script { vm.serializeAddress("bridgehub", "bridgehub_proxy_addr", addresses.bridgehub.bridgehubProxy); vm.serializeAddress( "bridgehub", - "stm_deployment_tracker_proxy_addr", - addresses.bridgehub.stmDeploymentTrackerProxy + "ctm_deployment_tracker_proxy_addr", + addresses.bridgehub.ctmDeploymentTrackerProxy ); vm.serializeAddress( "bridgehub", - "stm_deployment_tracker_implementation_addr", - addresses.bridgehub.stmDeploymentTrackerImplementation + "ctm_deployment_tracker_implementation_addr", + addresses.bridgehub.ctmDeploymentTrackerImplementation ); vm.serializeAddress("bridgehub", "message_root_proxy_addr", addresses.bridgehub.messageRootProxy); vm.serializeAddress( diff --git a/l1-contracts/deploy-scripts/DeployL2Contracts.sol b/l1-contracts/deploy-scripts/DeployL2Contracts.sol index cd647d7e9..072840fc9 100644 --- a/l1-contracts/deploy-scripts/DeployL2Contracts.sol +++ b/l1-contracts/deploy-scripts/DeployL2Contracts.sol @@ -8,7 +8,7 @@ import {stdToml} from "forge-std/StdToml.sol"; import {Utils} from "./Utils.sol"; import {L2ContractHelper} from "contracts/common/libraries/L2ContractHelper.sol"; import {AddressAliasHelper} from "contracts/vendor/AddressAliasHelper.sol"; -// import {L1AssetRouter} from "contracts/bridge/L1AssetRouter.sol"; +// import {L1AssetRouter} from "contracts/bridge/asset-router/L1AssetRouter.sol"; contract DeployL2Script is Script { using stdToml for string; @@ -22,10 +22,15 @@ contract DeployL2Script is Script { address l1SharedBridgeProxy; address governance; address erc20BridgeProxy; + // The owner of the contract sets the validator/attester weights. + // Can be the developer multisig wallet on mainnet. + address consensusRegistryOwner; uint256 chainId; uint256 eraChainId; address l2SharedBridgeImplementation; address l2SharedBridgeProxy; + address consensusRegistryImplementation; + address consensusRegistryProxy; address forceDeployUpgraderAddress; } @@ -35,65 +40,108 @@ contract DeployL2Script is Script { bytes l2StandardErc20Bytecode; bytes l2SharedBridgeBytecode; bytes l2SharedBridgeProxyBytecode; + bytes consensusRegistryBytecode; + bytes consensusRegistryProxyBytecode; bytes forceDeployUpgrader; } function run() public { + deploy(false); + } + + function runWithLegacyBridge() public { + deploy(true); + } + + function deploy(bool legacyBridge) public { initializeConfig(); - loadContracts(); + loadContracts(legacyBridge); deployFactoryDeps(); deploySharedBridge(); - deploySharedBridgeProxy(); + deploySharedBridgeProxy(legacyBridge); + initializeChain(); deployForceDeployer(); + deployConsensusRegistry(); + deployConsensusRegistryProxy(); saveOutput(); } + function runDeployLegacySharedBridge() public { + deploySharedBridge(true); + } + function runDeploySharedBridge() public { + deploySharedBridge(false); + } + + function deploySharedBridge(bool legacyBridge) internal { initializeConfig(); - loadContracts(); + loadContracts(legacyBridge); deployFactoryDeps(); deploySharedBridge(); - deploySharedBridgeProxy(); + deploySharedBridgeProxy(legacyBridge); + initializeChain(); saveOutput(); } function runDefaultUpgrader() public { initializeConfig(); - loadContracts(); + loadContracts(false); deployForceDeployer(); saveOutput(); } - function loadContracts() internal { + function runDeployConsensusRegistry() public { + initializeConfig(); + loadContracts(false); + + deployConsensusRegistry(); + deployConsensusRegistryProxy(); + + saveOutput(); + } + + function loadContracts(bool legacyBridge) internal { //HACK: Meanwhile we are not integrated foundry zksync we use contracts that has been built using hardhat contracts.l2StandardErc20FactoryBytecode = Utils.readHardhatBytecode( - "/../l2-contracts/artifacts-zk/@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol/UpgradeableBeacon.json" + "/artifacts-zk/@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol/UpgradeableBeacon.json" ); contracts.beaconProxy = Utils.readHardhatBytecode( - "/../l2-contracts/artifacts-zk/@openzeppelin/contracts-v4/proxy/beacon/BeaconProxy.sol/BeaconProxy.json" + "/artifacts-zk/@openzeppelin/contracts-v4/proxy/beacon/BeaconProxy.sol/BeaconProxy.json" ); contracts.l2StandardErc20Bytecode = Utils.readHardhatBytecode( - "/../l2-contracts/artifacts-zk/contracts/bridge/L2StandardERC20.sol/L2StandardERC20.json" + "/artifacts-zk/contracts/bridge/BridgedStandardERC20.sol/BridgedStandardERC20.json" ); - contracts.l2SharedBridgeBytecode = Utils.readFoundryBytecode( - "/../l2-contracts/zkout/L2SharedBridge.sol/L2SharedBridge.json" - ); + if (legacyBridge) { + contracts.l2SharedBridgeBytecode = Utils.readHardhatBytecode( + "/../l2-contracts/artifacts-zk/contracts/dev-contracts/DevL2SharedBridge.sol/DevL2SharedBridge.json" + ); + } else { + contracts.l2SharedBridgeBytecode = Utils.readHardhatBytecode( + "/../l2-contracts/zkout/L2SharedBridge.sol/L2SharedBridge.json" + ); + } contracts.l2SharedBridgeProxyBytecode = Utils.readHardhatBytecode( - "/../l2-contracts/artifacts-zk/@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json" + "/artifacts-zk/@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json" ); - contracts.forceDeployUpgrader = Utils.readFoundryBytecode( - "/../l2-contracts/zkout/ForceDeployUpgrader.sol/ForceDeployUpgrader.json" + + contracts.consensusRegistryBytecode = Utils.readHardhatBytecode( + "/../l2-contracts/zkout/ConsensusRegistry.sol/ConsensusRegistry.json" + ); + contracts.consensusRegistryProxyBytecode = Utils.readHardhatBytecode( + "/../l2-contracts/zkout/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json" ); + contracts.forceDeployUpgrader = Utils.readHardhatBytecode( - "/../l2-contracts/artifacts-zk/contracts/ForceDeployUpgrader.sol/ForceDeployUpgrader.json" + "/../l2-contracts/zkout/ForceDeployUpgrader.sol/ForceDeployUpgrader.json" ); } @@ -105,6 +153,7 @@ contract DeployL2Script is Script { config.governance = toml.readAddress("$.governance"); config.l1SharedBridgeProxy = toml.readAddress("$.l1_shared_bridge"); config.erc20BridgeProxy = toml.readAddress("$.erc20_bridge"); + config.consensusRegistryOwner = toml.readAddress("$.consensus_registry_owner"); config.chainId = toml.readUint("$.chain_id"); config.eraChainId = toml.readUint("$.era_chain_id"); } @@ -112,6 +161,8 @@ contract DeployL2Script is Script { function saveOutput() internal { vm.serializeAddress("root", "l2_shared_bridge_implementation", config.l2SharedBridgeImplementation); vm.serializeAddress("root", "l2_shared_bridge_proxy", config.l2SharedBridgeProxy); + vm.serializeAddress("root", "consensus_registry_implementation", config.consensusRegistryImplementation); + vm.serializeAddress("root", "consensus_registry_proxy", config.consensusRegistryProxy); string memory toml = vm.serializeAddress("root", "l2_default_upgrader", config.forceDeployUpgraderAddress); string memory root = vm.projectRoot(); string memory path = string.concat(root, "/script-out/output-deploy-l2-contracts.toml"); @@ -158,13 +209,20 @@ contract DeployL2Script is Script { }); } - function deploySharedBridgeProxy() internal { + function deploySharedBridgeProxy(bool legacyBridge) internal { address l2GovernorAddress = AddressAliasHelper.applyL1ToL2Alias(config.governance); bytes32 l2StandardErc20BytecodeHash = L2ContractHelper.hashL2Bytecode(contracts.beaconProxy); + string memory functionSignature; + + if (legacyBridge) { + functionSignature = "initializeDevBridge(address,address,bytes32,address)"; + } else { + functionSignature = "initialize(address,address,bytes32,address)"; + } // solhint-disable-next-line func-named-parameters bytes memory proxyInitializationParams = abi.encodeWithSignature( - "initialize(address,address,bytes32,address)", + functionSignature, config.l1SharedBridgeProxy, config.erc20BridgeProxy, l2StandardErc20BytecodeHash, @@ -188,4 +246,65 @@ contract DeployL2Script is Script { l1SharedBridgeProxy: config.l1SharedBridgeProxy }); } + + // Deploy the ConsensusRegistry implementation and save its address into the config. + function deployConsensusRegistry() internal { + // ConsensusRegistry.sol doesn't have a constructor, just an initializer. + bytes memory constructorData = ""; + + config.consensusRegistryImplementation = Utils.deployThroughL1({ + bytecode: contracts.consensusRegistryBytecode, + constructorargs: constructorData, + create2salt: "", + l2GasLimit: Utils.MAX_PRIORITY_TX_GAS, + factoryDeps: new bytes[](0), + chainId: config.chainId, + bridgehubAddress: config.bridgehubAddress, + l1SharedBridgeProxy: config.l1SharedBridgeProxy + }); + } + + // Deploy a transparent upgradable proxy for the already deployed consensus registry + // implementation and save its address into the config. + function deployConsensusRegistryProxy() internal { + // Admin for the proxy + address l2GovernorAddress = AddressAliasHelper.applyL1ToL2Alias(config.governance); + + // Call ConsensusRegistry::initialize with the initial owner. + // solhint-disable-next-line func-named-parameters + bytes memory proxyInitializationParams = abi.encodeWithSignature( + "initialize(address)", + config.consensusRegistryOwner + ); + + bytes memory consensusRegistryProxyConstructorData = abi.encode( + config.consensusRegistryImplementation, // _logic + l2GovernorAddress, // admin_ + proxyInitializationParams // _data + ); + + config.consensusRegistryProxy = Utils.deployThroughL1({ + bytecode: contracts.consensusRegistryProxyBytecode, + constructorargs: consensusRegistryProxyConstructorData, + create2salt: "", + l2GasLimit: Utils.MAX_PRIORITY_TX_GAS, + factoryDeps: new bytes[](0), + chainId: config.chainId, + bridgehubAddress: config.bridgehubAddress, + l1SharedBridgeProxy: config.l1SharedBridgeProxy + }); + } + + function initializeChain() internal { + L1SharedBridge bridge = L1SharedBridge(config.l1SharedBridgeProxy); + + Utils.executeUpgrade({ + _governor: bridge.owner(), + _salt: bytes32(0), + _target: config.l1SharedBridgeProxy, + _data: abi.encodeCall(bridge.initializeChainGovernance, (config.chainId, config.l2SharedBridgeProxy)), + _value: 0, + _delay: 0 + }); + } } diff --git a/l1-contracts/deploy-scripts/Gateway.s.sol b/l1-contracts/deploy-scripts/Gateway.s.sol index 84bc3909c..d5e4c78ea 100644 --- a/l1-contracts/deploy-scripts/Gateway.s.sol +++ b/l1-contracts/deploy-scripts/Gateway.s.sol @@ -7,27 +7,28 @@ import {Script, console2 as console} from "forge-std/Script.sol"; // import {Vm} from "forge-std/Vm.sol"; import {stdToml} from "forge-std/StdToml.sol"; -import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; -import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; -import {IZkSyncHyperchain} from "contracts/state-transition/chain-interfaces/IZkSyncHyperchain.sol"; +import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; + +import {Ownable} from "@openzeppelin/contracts-v4/access/Ownable.sol"; +import {IBridgehub, BridgehubBurnCTMAssetData} from "contracts/bridgehub/IBridgehub.sol"; +import {IZKChain} from "contracts/state-transition/chain-interfaces/IZKChain.sol"; +import {GatewayTransactionFilterer} from "contracts/transactionFilterer/GatewayTransactionFilterer.sol"; // import {ValidatorTimelock} from "contracts/state-transition/ValidatorTimelock.sol"; // import {Governance} from "contracts/governance/Governance.sol"; // import {Utils} from "./Utils.sol"; -// import {PubdataPricingMode} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; -// import {IL1NativeTokenVault} from "contracts/bridge/interfaces/IL1NativeTokenVault.sol"; +// import {PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; +// import {IL1NativeTokenVault} from "contracts/bridge/ntv/IL1NativeTokenVault.sol"; import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA} from "contracts/common/Config.sol"; import {L2TransactionRequestTwoBridgesOuter} from "contracts/bridgehub/IBridgehub.sol"; +import {L2_BRIDGEHUB_ADDR} from "contracts/common/L2ContractAddresses.sol"; -// import {IL1AssetRouter} from "contracts/bridge/interfaces/IL1AssetRouter.sol"; - -import {IStateTransitionManager} from "contracts/state-transition/IStateTransitionManager.sol"; -import {IZkSyncHyperchain} from "contracts/state-transition/chain-interfaces/IZkSyncHyperchain.sol"; +// import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; contract GatewayScript is Script { using stdToml for string; address internal constant ADDRESS_ONE = 0x0000000000000000000000000000000000000001; - bytes32 internal constant STATE_TRANSITION_NEW_CHAIN_HASH = keccak256("NewHyperchain(uint256,address)"); + bytes32 internal constant STATE_TRANSITION_NEW_CHAIN_HASH = keccak256("NewZKChain(uint256,address)"); // solhint-disable-next-line gas-struct-packing struct Config { @@ -42,7 +43,7 @@ contract GatewayScript is Script { uint128 baseTokenGasPriceMultiplierNominator; uint128 baseTokenGasPriceMultiplierDenominator; address bridgehub; - address stmDeploymentTracker; + address ctmDeploymentTracker; address nativeTokenVault; address stateTransitionProxy; address sharedBridgeProxy; @@ -67,7 +68,7 @@ contract GatewayScript is Script { function initializeConfig() internal { // Grab config from output of l1 deployment string memory root = vm.projectRoot(); - string memory path = string.concat(root, vm.envString("L1_OUTPUT")); //"/script-config/register-hyperchain.toml"); + string memory path = string.concat(root, vm.envString("L1_OUTPUT")); //"/script-config/register-zkChain.toml"); string memory toml = vm.readFile(path); config.deployerAddress = msg.sender; @@ -86,10 +87,10 @@ contract GatewayScript is Script { config.nativeTokenVault = toml.readAddress("$.deployed_addresses.native_token_vault_addr"); config.diamondCutData = toml.readBytes("$.contracts_config.diamond_cut_data"); config.forceDeployments = toml.readBytes("$.contracts_config.force_deployments_data"); - config.stmDeploymentTracker = toml.readAddress( - "$.deployed_addresses.bridgehub.stm_deployment_tracker_proxy_addr" + config.ctmDeploymentTracker = toml.readAddress( + "$.deployed_addresses.bridgehub.ctm_deployment_tracker_proxy_addr" ); - path = string.concat(root, vm.envString("HYPERCHAIN_CONFIG")); + path = string.concat(root, vm.envString("ZK_CHAIN_CONFIG")); toml = vm.readFile(path); config.ownerAddress = toml.readAddress("$.owner_address"); @@ -116,10 +117,33 @@ contract GatewayScript is Script { } function registerGateway() public { - IStateTransitionManager stm = IStateTransitionManager(config.stateTransitionProxy); - Ownable ownable = Ownable(config.stateTransitionProxy); - vm.prank(ownable.owner()); - stm.registerSettlementLayer(config.gatewayChainId, true); + IBridgehub bridgehub = IBridgehub(config.bridgehub); + Ownable ownable = Ownable(config.bridgehub); + Ownable ownableStmDT = Ownable(config.ctmDeploymentTracker); + IZKChain chainL2 = IZKChain(bridgehub.getZKChain(config.chainChainId)); + IZKChain chain = IZKChain(bridgehub.getZKChain(config.gatewayChainId)); + vm.startPrank(chain.getAdmin()); + GatewayTransactionFilterer transactionFiltererImplementation = new GatewayTransactionFilterer( + IBridgehub(config.bridgehub), + config.sharedBridgeProxy + ); + address transactionFiltererProxy = address( + new TransparentUpgradeableProxy( + address(transactionFiltererImplementation), + chain.getAdmin(), + abi.encodeCall(GatewayTransactionFilterer.initialize, ownable.owner()) + ) + ); + chain.setTransactionFilterer(transactionFiltererProxy); + vm.stopPrank(); + + vm.startPrank(ownable.owner()); + GatewayTransactionFilterer(transactionFiltererProxy).grantWhitelist(ownableStmDT.owner()); + GatewayTransactionFilterer(transactionFiltererProxy).grantWhitelist(chainL2.getAdmin()); + GatewayTransactionFilterer(transactionFiltererProxy).grantWhitelist(config.sharedBridgeProxy); + bridgehub.registerSettlementLayer(config.gatewayChainId, true); + + vm.stopPrank(); // bytes memory data = abi.encodeCall(stm.registerSettlementLayer, (config.chainChainId, true)); // Utils.executeUpgrade({ // _governor: ownable.owner(), @@ -129,7 +153,7 @@ contract GatewayScript is Script { // _value: 0, // _delay: 0 // }); - console.log("Gateway registered on STM"); + console.log("Gateway registered on CTM"); } function moveChainToGateway() public { @@ -149,14 +173,19 @@ contract GatewayScript is Script { address newAdmin = ownable.owner(); console.log("newAdmin", newAdmin); - IZkSyncHyperchain chain = IZkSyncHyperchain(bridgehub.getHyperchain(config.chainChainId)); - console.log("chainAdmin", bridgehub.getHyperchain(config.chainChainId), chain.getAdmin()); - bytes32 stmAssetId = bridgehub.stmAssetIdFromChainId(config.chainChainId); + IZKChain chain = IZKChain(bridgehub.getZKChain(config.chainChainId)); + console.log("chainAdmin", bridgehub.getZKChain(config.chainChainId), chain.getAdmin()); + bytes32 ctmAssetId = bridgehub.ctmAssetIdFromChainId(config.chainChainId); bytes memory diamondCutData = config.diamondCutData; // todo replace with config.zkDiamondCutData; - bytes memory stmData = abi.encode(newAdmin, diamondCutData); - bytes memory chainData = abi.encode(address(1)); - bytes memory bridgehubData = abi.encode(config.chainChainId, stmData, chainData); - bytes memory routerData = bytes.concat(bytes1(0x01), abi.encode(stmAssetId, bridgehubData)); + bytes memory ctmData = abi.encode(newAdmin, diamondCutData); + bytes memory chainData = abi.encode(chain.getProtocolVersion()); + BridgehubBurnCTMAssetData memory ctmAssetData = BridgehubBurnCTMAssetData({ + chainId: config.chainChainId, + ctmData: ctmData, + chainData: chainData + }); + bytes memory bridgehubData = abi.encode(ctmAssetData); + bytes memory routerData = bytes.concat(bytes1(0x01), abi.encode(ctmAssetId, bridgehubData)); vm.startBroadcast(chain.getAdmin()); L2TransactionRequestTwoBridgesOuter memory request = L2TransactionRequestTwoBridgesOuter({ @@ -177,7 +206,7 @@ contract GatewayScript is Script { function registerL2Contracts() public { IBridgehub bridgehub = IBridgehub(config.bridgehub); - Ownable ownable = Ownable(config.stmDeploymentTracker); + Ownable ownable = Ownable(config.ctmDeploymentTracker); // IStateTransitionManager stm = IStateTransitionManager(config.stateTransitionProxy); uint256 gasPrice = 10; @@ -189,20 +218,38 @@ contract GatewayScript is Script { l2GasLimit, REQUIRED_L2_GAS_PRICE_PER_PUBDATA ) * 2; - - L2TransactionRequestTwoBridgesOuter memory request = L2TransactionRequestTwoBridgesOuter({ + bytes32 assetId = bridgehub.ctmAssetIdFromChainId(config.chainChainId); + bytes memory routerData = bytes.concat(bytes1(0x02), abi.encode(assetId, L2_BRIDGEHUB_ADDR)); + L2TransactionRequestTwoBridgesOuter + memory assetRouterRegistrationRequest = L2TransactionRequestTwoBridgesOuter({ + chainId: config.chainChainId, + mintValue: expectedCost, + l2Value: 0, + l2GasLimit: l2GasLimit, + l2GasPerPubdataByteLimit: REQUIRED_L2_GAS_PRICE_PER_PUBDATA, + refundRecipient: ownable.owner(), + secondBridgeAddress: config.sharedBridgeProxy, + secondBridgeValue: 0, + secondBridgeCalldata: routerData + }); + + L2TransactionRequestTwoBridgesOuter memory bridehubRegistrationRequest = L2TransactionRequestTwoBridgesOuter({ chainId: config.chainChainId, mintValue: expectedCost, l2Value: 0, l2GasLimit: l2GasLimit, l2GasPerPubdataByteLimit: REQUIRED_L2_GAS_PRICE_PER_PUBDATA, refundRecipient: ownable.owner(), - secondBridgeAddress: config.stmDeploymentTracker, + secondBridgeAddress: config.ctmDeploymentTracker, secondBridgeValue: 0, - secondBridgeCalldata: abi.encode(config.stateTransitionProxy, config.stateTransitionProxy) + secondBridgeCalldata: bytes.concat( + bytes1(0x01), + abi.encode(config.stateTransitionProxy, config.stateTransitionProxy) + ) }); vm.startBroadcast(ownable.owner()); - bridgehub.requestL2TransactionTwoBridges{value: expectedCost}(request); + bridgehub.requestL2TransactionTwoBridges{value: expectedCost}(assetRouterRegistrationRequest); + bridgehub.requestL2TransactionTwoBridges{value: expectedCost}(bridehubRegistrationRequest); vm.stopBroadcast(); } } diff --git a/l1-contracts/deploy-scripts/GenerateForceDeploymentsData.s.sol b/l1-contracts/deploy-scripts/GenerateForceDeploymentsData.s.sol new file mode 100644 index 000000000..3d5a1c042 --- /dev/null +++ b/l1-contracts/deploy-scripts/GenerateForceDeploymentsData.s.sol @@ -0,0 +1,142 @@ +pragma solidity ^0.8.24; + +import {Script} from "forge-std/Script.sol"; +import {stdToml} from "forge-std/StdToml.sol"; + +import {Utils} from "./Utils.sol"; +import {L2_BRIDGEHUB_ADDR, L2_ASSET_ROUTER_ADDR, L2_NATIVE_TOKEN_VAULT_ADDR, L2_MESSAGE_ROOT_ADDR} from "contracts/common/L2ContractAddresses.sol"; +import {AddressAliasHelper} from "contracts/vendor/AddressAliasHelper.sol"; +import {ForceDeployment} from "contracts/state-transition/l2-deps/IL2GenesisUpgrade.sol"; + +contract GenerateForceDeploymentsData is Script { + using stdToml for string; + + Config internal config; + ContractsBytecodes internal contracts; + + // solhint-disable-next-line gas-struct-packing + struct Config { + address l1AssetRouterProxy; + address governance; + uint256 chainId; + uint256 eraChainId; + bytes forceDeploymentsData; + address l2LegacySharedBridge; + address l2TokenBeacon; + bool contractsDeployedAlready; + } + + struct ContractsBytecodes { + bytes bridgehubBytecode; + bytes l2AssetRouterBytecode; + bytes l2NtvBytecode; + bytes l2StandardErc20FactoryBytecode; + bytes l2TokenProxyBytecode; + bytes l2StandardErc20Bytecode; + bytes messageRootBytecode; + } + + function run() public { + initializeConfig(); + loadContracts(); + + genesisForceDeploymentsData(); + + saveOutput(); + } + + function loadContracts() internal { + //HACK: Meanwhile we are not integrated foundry zksync we use contracts that has been built using hardhat + contracts.l2StandardErc20FactoryBytecode = Utils.readHardhatBytecode( + "/artifacts-zk/@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol/UpgradeableBeacon.json" + ); + contracts.l2TokenProxyBytecode = Utils.readHardhatBytecode( + "/artifacts-zk/@openzeppelin/contracts-v4/proxy/beacon/BeaconProxy.sol/BeaconProxy.json" + ); + contracts.l2StandardErc20Bytecode = Utils.readHardhatBytecode( + "/artifacts-zk/contracts/bridge/BridgedStandardERC20.sol/BridgedStandardERC20.json" + ); + + contracts.l2AssetRouterBytecode = Utils.readHardhatBytecode( + "/artifacts-zk/contracts/bridge/asset-router/L2AssetRouter.sol/L2AssetRouter.json" + ); + contracts.bridgehubBytecode = Utils.readHardhatBytecode( + "/../l1-contracts/artifacts-zk/contracts/bridgehub/Bridgehub.sol/Bridgehub.json" + ); + contracts.messageRootBytecode = Utils.readHardhatBytecode( + "/../l1-contracts/artifacts-zk/contracts/bridgehub/MessageRoot.sol/MessageRoot.json" + ); + contracts.l2NtvBytecode = Utils.readHardhatBytecode( + "/artifacts-zk/contracts/bridge/ntv/L2NativeTokenVault.sol/L2NativeTokenVault.json" + ); + } + + function initializeConfig() internal { + string memory root = vm.projectRoot(); + string memory path = string.concat(root, vm.envString("FORCE_DEPLOYMENTS_CONFIG")); + string memory toml = vm.readFile(path); + config.governance = toml.readAddress("$.governance"); + config.l1AssetRouterProxy = toml.readAddress("$.l1_shared_bridge"); + config.chainId = toml.readUint("$.chain_id"); + config.eraChainId = toml.readUint("$.era_chain_id"); + config.l2LegacySharedBridge = toml.readAddress("$.l2_legacy_shared_bridge"); + config.l2TokenBeacon = toml.readAddress("$.l2_token_beacon"); + config.contractsDeployedAlready = toml.readBool("$.l2_contracts_deployed_already"); + } + + function saveOutput() internal { + string memory toml = vm.serializeBytes("root", "force_deployments_data", config.forceDeploymentsData); + string memory root = vm.projectRoot(); + string memory path = string.concat(root, "/script-out/output-force-deployments-data.toml"); + vm.writeToml(toml, path); + } + + function genesisForceDeploymentsData() internal { + address aliasedGovernance = AddressAliasHelper.applyL1ToL2Alias(config.governance); + ForceDeployment[] memory forceDeployments = new ForceDeployment[](4); + + forceDeployments[0] = ForceDeployment({ + bytecodeHash: keccak256(contracts.bridgehubBytecode), + newAddress: L2_BRIDGEHUB_ADDR, + callConstructor: true, + value: 0, + input: abi.encode(config.chainId, aliasedGovernance) + }); + + forceDeployments[1] = ForceDeployment({ + bytecodeHash: keccak256(contracts.l2AssetRouterBytecode), + newAddress: L2_ASSET_ROUTER_ADDR, + callConstructor: true, + value: 0, + // solhint-disable-next-line func-named-parameters + input: abi.encode(config.chainId, config.eraChainId, config.l1AssetRouterProxy, address(1)) + }); + + forceDeployments[2] = ForceDeployment({ + bytecodeHash: keccak256(contracts.l2NtvBytecode), + newAddress: L2_NATIVE_TOKEN_VAULT_ADDR, + callConstructor: true, + value: 0, + // solhint-disable-next-line func-named-parameters + input: abi.encode( + config.chainId, + aliasedGovernance, + keccak256(contracts.l2TokenProxyBytecode), + config.l2LegacySharedBridge, + config.l2TokenBeacon, + config.contractsDeployedAlready + ) + }); + + forceDeployments[3] = ForceDeployment({ + bytecodeHash: keccak256(contracts.messageRootBytecode), + newAddress: L2_MESSAGE_ROOT_ADDR, + callConstructor: true, + value: 0, + // solhint-disable-next-line func-named-parameters + input: abi.encode(L2_BRIDGEHUB_ADDR) + }); + + config.forceDeploymentsData = abi.encode(forceDeployments); + } +} diff --git a/l1-contracts/deploy-scripts/PrepareZKChainRegistrationCalldata.s.sol b/l1-contracts/deploy-scripts/PrepareZKChainRegistrationCalldata.s.sol index 0a7e20a53..618ee3c64 100644 --- a/l1-contracts/deploy-scripts/PrepareZKChainRegistrationCalldata.s.sol +++ b/l1-contracts/deploy-scripts/PrepareZKChainRegistrationCalldata.s.sol @@ -10,9 +10,10 @@ import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; import {Bridgehub} from "contracts/bridgehub/Bridgehub.sol"; import {L2ContractHelper} from "contracts/common/libraries/L2ContractHelper.sol"; import {AddressAliasHelper} from "contracts/vendor/AddressAliasHelper.sol"; -import {L1SharedBridge} from "contracts/bridge/L1SharedBridge.sol"; -import {IStateTransitionManager} from "contracts/state-transition/IStateTransitionManager.sol"; +import {L1AssetRouter} from "contracts/bridge/L1AssetRouter.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; import {IGovernance} from "contracts/governance/IGovernance.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; import {Utils} from "./Utils.sol"; /** @@ -58,7 +59,7 @@ contract PrepareZKChainRegistrationCalldataScript is Script { struct Config { // Admin of the yet-to-be-registered chain (L1-based address) address chainAdmin; - // STM proxy address + // CTM proxy address address stateTransitionProxy; // Chain ID of the new chain uint256 chainId; @@ -69,7 +70,7 @@ contract PrepareZKChainRegistrationCalldataScript is Script { // Address of the new chain's base token address baseToken; // Diamond cut data is a "configuration" for the Diamond proxy that will be created for a new chain. - // It can only be the one that's allowed by the STM. It can be generated by the other scripts or taken from the + // It can only be the one that's allowed by the CTM. It can be generated by the other scripts or taken from the // `etc/env/ecosystems/ENV.yaml` file in `zksync-era` repository bytes diamondCutData; // Address of the L1 ERC20 bridge proxy (required for the L2 bridge deployment) @@ -118,7 +119,7 @@ contract PrepareZKChainRegistrationCalldataScript is Script { calls = new IGovernance.Call[](1); } - IGovernance.Call memory registerChainCall = prepareRegisterHyperchainCall(); + IGovernance.Call memory registerChainCall = prepareRegisterZKChainCall(); calls[cnt] = registerChainCall; ++cnt; @@ -141,7 +142,7 @@ contract PrepareZKChainRegistrationCalldataScript is Script { config.stateTransitionProxy = toml.readAddress("$.deployed_addresses.state_transition_proxy_addr"); config.erc20BridgeProxy = toml.readAddress("$.deployed_addresses.erc20_bridge_proxy_addr"); - ecosystem.bridgehub = IStateTransitionManager(config.stateTransitionProxy).BRIDGE_HUB(); + ecosystem.bridgehub = IChainTypeManager(config.stateTransitionProxy).BRIDGE_HUB(); ecosystem.l1SharedBridgeProxy = address(Bridgehub(ecosystem.bridgehub).sharedBridge()); ecosystem.governance = Bridgehub(ecosystem.bridgehub).owner(); @@ -181,7 +182,10 @@ contract PrepareZKChainRegistrationCalldataScript is Script { function prepareRegisterBaseTokenCall() internal view returns (IGovernance.Call memory) { Bridgehub bridgehub = Bridgehub(ecosystem.bridgehub); - bytes memory data = abi.encodeCall(bridgehub.addToken, (config.baseToken)); + bytes memory data = abi.encodeCall( + bridgehub.addTokenAssetId, + (DataEncoding.encodeNTVAssetId(block.chainid, config.baseToken)) + ); return IGovernance.Call({target: ecosystem.bridgehub, value: 0, data: data}); } @@ -267,7 +271,7 @@ contract PrepareZKChainRegistrationCalldataScript is Script { return proxyContractAddress; } - function prepareRegisterHyperchainCall() internal view returns (IGovernance.Call memory) { + function prepareRegisterZKChainCall() internal view returns (IGovernance.Call memory) { Bridgehub bridgehub = Bridgehub(ecosystem.bridgehub); bytes memory data = abi.encodeCall( @@ -288,7 +292,7 @@ contract PrepareZKChainRegistrationCalldataScript is Script { function prepareInitializeChainGovernanceCall( address l2SharedBridgeProxy ) internal view returns (IGovernance.Call memory) { - L1SharedBridge bridge = L1SharedBridge(ecosystem.l1SharedBridgeProxy); + L1AssetRouter bridge = L1AssetRouter(ecosystem.l1SharedBridgeProxy); bytes memory data = abi.encodeCall(bridge.initializeChainGovernance, (config.chainId, l2SharedBridgeProxy)); diff --git a/l1-contracts/deploy-scripts/RegisterHyperchain.s.sol b/l1-contracts/deploy-scripts/RegisterZKChain.s.sol similarity index 80% rename from l1-contracts/deploy-scripts/RegisterHyperchain.s.sol rename to l1-contracts/deploy-scripts/RegisterZKChain.s.sol index 6aca2fefe..63c230741 100644 --- a/l1-contracts/deploy-scripts/RegisterHyperchain.s.sol +++ b/l1-contracts/deploy-scripts/RegisterZKChain.s.sol @@ -9,20 +9,23 @@ import {stdToml} from "forge-std/StdToml.sol"; import {Ownable} from "@openzeppelin/contracts-v4/access/Ownable.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; -import {IZkSyncHyperchain} from "contracts/state-transition/chain-interfaces/IZkSyncHyperchain.sol"; +import {IZKChain} from "contracts/state-transition/chain-interfaces/IZKChain.sol"; import {ValidatorTimelock} from "contracts/state-transition/ValidatorTimelock.sol"; import {Governance} from "contracts/governance/Governance.sol"; import {ChainAdmin} from "contracts/governance/ChainAdmin.sol"; +import {AccessControlRestriction} from "contracts/governance/AccessControlRestriction.sol"; import {Utils} from "./Utils.sol"; -import {PubdataPricingMode} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; -import {IL1NativeTokenVault} from "contracts/bridge/interfaces/IL1NativeTokenVault.sol"; +import {PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; +import {INativeTokenVault} from "contracts/bridge/ntv/INativeTokenVault.sol"; import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; -contract RegisterHyperchainScript is Script { +import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; + +contract RegisterZKChainScript is Script { using stdToml for string; address internal constant ADDRESS_ONE = 0x0000000000000000000000000000000000000001; - bytes32 internal constant STATE_TRANSITION_NEW_CHAIN_HASH = keccak256("NewHyperchain(uint256,address)"); + bytes32 internal constant STATE_TRANSITION_NEW_CHAIN_HASH = keccak256("NewZKChain(uint256,address)"); // solhint-disable-next-line gas-struct-packing struct Config { @@ -34,6 +37,7 @@ contract RegisterHyperchainScript is Script { address validatorSenderOperatorCommitEth; address validatorSenderOperatorBlobsEth; address baseToken; + bytes32 baseTokenAssetId; uint128 baseTokenGasPriceMultiplierNominator; uint128 baseTokenGasPriceMultiplierDenominator; address bridgehub; @@ -52,16 +56,16 @@ contract RegisterHyperchainScript is Script { Config internal config; function run() public { - console.log("Deploying Hyperchain"); + console.log("Deploying ZKChain"); initializeConfig(); deployGovernance(); deployChainAdmin(); checkTokenAddress(); - registerTokenOnBridgehub(); + registerAssetIdOnBridgehub(); registerTokenOnNTV(); - registerHyperchain(); + registerZKChain(); addValidators(); configureZkSyncStateTransition(); setPendingAdmin(); @@ -72,7 +76,7 @@ contract RegisterHyperchainScript is Script { function initializeConfig() internal { // Grab config from output of l1 deployment string memory root = vm.projectRoot(); - string memory path = string.concat(root, vm.envString("L1_OUTPUT")); //"/script-config/register-hyperchain.toml"); + string memory path = string.concat(root, vm.envString("L1_OUTPUT")); //"/script-config/register-zkChain.toml"); string memory toml = vm.readFile(path); config.deployerAddress = msg.sender; @@ -90,7 +94,7 @@ contract RegisterHyperchainScript is Script { config.nativeTokenVault = toml.readAddress("$.deployed_addresses.native_token_vault_addr"); config.diamondCutData = toml.readBytes("$.contracts_config.diamond_cut_data"); config.forceDeployments = toml.readBytes("$.contracts_config.force_deployments_data"); - path = string.concat(root, vm.envString("HYPERCHAIN_CONFIG")); + path = string.concat(root, vm.envString("ZK_CHAIN_CONFIG")); toml = vm.readFile(path); config.ownerAddress = toml.readAddress("$.owner_address"); @@ -128,14 +132,15 @@ contract RegisterHyperchainScript is Script { console.log("Using base token address:", config.baseToken); } - function registerTokenOnBridgehub() internal { + function registerAssetIdOnBridgehub() internal { IBridgehub bridgehub = IBridgehub(config.bridgehub); Ownable ownable = Ownable(config.bridgehub); + bytes32 baseTokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, config.baseToken); - if (bridgehub.tokenIsRegistered(config.baseToken)) { - console.log("Token already registered on Bridgehub"); + if (bridgehub.assetIdIsRegistered(baseTokenAssetId)) { + console.log("Base token asset id already registered on Bridgehub"); } else { - bytes memory data = abi.encodeCall(bridgehub.addToken, (config.baseToken)); + bytes memory data = abi.encodeCall(bridgehub.addTokenAssetId, (baseTokenAssetId)); Utils.executeUpgrade({ _governor: ownable.owner(), _salt: bytes32(config.bridgehubCreateNewChainSalt), @@ -144,15 +149,16 @@ contract RegisterHyperchainScript is Script { _value: 0, _delay: 0 }); - console.log("Token registered on Bridgehub"); + console.log("Base token asset id registered on Bridgehub"); } } function registerTokenOnNTV() internal { - IL1NativeTokenVault ntv = IL1NativeTokenVault(config.nativeTokenVault); + INativeTokenVault ntv = INativeTokenVault(config.nativeTokenVault); // Ownable ownable = Ownable(config.nativeTokenVault); - bytes32 assetId = DataEncoding.encodeNTVAssetId(block.chainid, config.baseToken); - if (ntv.tokenAddress(assetId) != address(0)) { + bytes32 baseTokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, config.baseToken); + config.baseTokenAssetId = baseTokenAssetId; + if (ntv.tokenAddress(baseTokenAssetId) != address(0) || config.baseToken == ETH_TOKEN_ADDRESS) { console.log("Token already registered on NTV"); } else { // bytes memory data = abi.encodeCall(ntv.registerToken, (config.baseToken)); @@ -174,12 +180,17 @@ contract RegisterHyperchainScript is Script { function deployChainAdmin() internal { vm.broadcast(); - ChainAdmin chainAdmin = new ChainAdmin(config.ownerAddress, address(0)); - console.log("ChainAdmin deployed at:", address(chainAdmin)); + AccessControlRestriction restriction = new AccessControlRestriction(0, config.ownerAddress); + + address[] memory restrictions = new address[](1); + restrictions[0] = address(restriction); + + vm.broadcast(); + ChainAdmin chainAdmin = new ChainAdmin(restrictions); config.chainAdmin = address(chainAdmin); } - function registerHyperchain() internal { + function registerZKChain() internal { IBridgehub bridgehub = IBridgehub(config.bridgehub); Ownable ownable = Ownable(config.bridgehub); @@ -189,7 +200,7 @@ contract RegisterHyperchainScript is Script { ( config.chainChainId, config.stateTransitionProxy, - config.baseToken, + config.baseTokenAssetId, config.bridgehubCreateNewChainSalt, msg.sender, abi.encode(config.diamondCutData, config.forceDeployments), @@ -204,7 +215,7 @@ contract RegisterHyperchainScript is Script { _value: 0, _delay: 0 }); - console.log("Hyperchain registered"); + console.log("ZK chain registered"); // Get new diamond proxy address from emitted events Vm.Log[] memory logs = vm.getRecordedLogs(); @@ -220,7 +231,7 @@ contract RegisterHyperchainScript is Script { revert("Diamond proxy address not found"); } config.newDiamondProxy = diamondProxyAddress; - console.log("Hyperchain diamond proxy deployed at:", diamondProxyAddress); + console.log("ZKChain diamond proxy deployed at:", diamondProxyAddress); } function addValidators() internal { @@ -235,16 +246,16 @@ contract RegisterHyperchainScript is Script { } function configureZkSyncStateTransition() internal { - IZkSyncHyperchain hyperchain = IZkSyncHyperchain(config.newDiamondProxy); + IZKChain zkChain = IZKChain(config.newDiamondProxy); vm.startBroadcast(msg.sender); - hyperchain.setTokenMultiplier( + zkChain.setTokenMultiplier( config.baseTokenGasPriceMultiplierNominator, config.baseTokenGasPriceMultiplierDenominator ); if (config.validiumMode) { - hyperchain.setPubdataPricingMode(PubdataPricingMode.Validium); + zkChain.setPubdataPricingMode(PubdataPricingMode.Validium); } vm.stopBroadcast(); @@ -252,10 +263,11 @@ contract RegisterHyperchainScript is Script { } function setPendingAdmin() internal { - IZkSyncHyperchain hyperchain = IZkSyncHyperchain(config.newDiamondProxy); + IZKChain zkChain = IZKChain(config.newDiamondProxy); - vm.broadcast(); - hyperchain.setPendingAdmin(config.chainAdmin); + vm.startBroadcast(msg.sender); + zkChain.setPendingAdmin(config.chainAdmin); + vm.stopBroadcast(); console.log("Owner for ", config.newDiamondProxy, "set to", config.chainAdmin); } @@ -264,7 +276,7 @@ contract RegisterHyperchainScript is Script { vm.serializeAddress("root", "chain_admin_addr", config.chainAdmin); string memory toml = vm.serializeAddress("root", "governance_addr", config.governance); string memory root = vm.projectRoot(); - string memory path = string.concat(root, "/script-out/output-register-hyperchain.toml"); + string memory path = string.concat(root, "/script-out/output-register-zkChain.toml"); vm.writeToml(toml, path); console.log("Output saved at:", path); } diff --git a/l1-contracts/deploy-scripts/Utils.sol b/l1-contracts/deploy-scripts/Utils.sol index c3ab22594..7c387ac5f 100644 --- a/l1-contracts/deploy-scripts/Utils.sol +++ b/l1-contracts/deploy-scripts/Utils.sol @@ -5,11 +5,11 @@ pragma solidity 0.8.24; import {Vm} from "forge-std/Vm.sol"; -import {Bridgehub} from "contracts/bridgehub/Bridgehub.sol"; -import {L2TransactionRequestDirect} from "contracts/bridgehub/IBridgehub.sol"; +import {L2TransactionRequestDirect, IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; import {IGovernance} from "contracts/governance/IGovernance.sol"; import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; import {Ownable} from "@openzeppelin/contracts-v4/access/Ownable.sol"; +import {Call} from "contracts/governance/Common.sol"; import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA} from "contracts/common/Config.sol"; import {L2_DEPLOYER_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; import {L2ContractHelper} from "contracts/common/libraries/L2ContractHelper.sol"; @@ -231,7 +231,7 @@ library Utils { address bridgehubAddress, address l1SharedBridgeProxy ) internal { - Bridgehub bridgehub = Bridgehub(bridgehubAddress); + IBridgehub bridgehub = IBridgehub(bridgehubAddress); uint256 gasPrice = bytesToUint256(vm.rpc("eth_gasPrice", "[]")); uint256 requiredValueToDeploy = bridgehub.l2TransactionBaseCost( @@ -318,8 +318,8 @@ library Utils { IGovernance governance = IGovernance(_governor); Ownable ownable = Ownable(_governor); - IGovernance.Call[] memory calls = new IGovernance.Call[](1); - calls[0] = IGovernance.Call({target: _target, value: _value, data: _data}); + Call[] memory calls = new Call[](1); + calls[0] = Call({target: _target, value: _value, data: _data}); IGovernance.Operation memory operation = IGovernance.Operation({ calls: calls, diff --git a/l1-contracts/deploy-scripts/dev/SetupLegacyBridge.s.sol b/l1-contracts/deploy-scripts/dev/SetupLegacyBridge.s.sol new file mode 100644 index 000000000..301bfd2c8 --- /dev/null +++ b/l1-contracts/deploy-scripts/dev/SetupLegacyBridge.s.sol @@ -0,0 +1,155 @@ +// SPDX-License-Identifier: UNLICENSED +pragma solidity ^0.8.0; + +import {Script} from "forge-std/Script.sol"; +import {stdToml} from "forge-std/StdToml.sol"; +import {Utils} from "./../Utils.sol"; +import {L1SharedBridge} from "contracts/bridge/L1SharedBridge.sol"; +import {DummyL1ERC20Bridge} from "contracts/dev-contracts/DummyL1ERC20Bridge.sol"; +import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol"; +import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol"; +import {L2ContractHelper} from "contracts/common/libraries/L2ContractHelper.sol"; + +/// This scripts is only for developer +contract SetupLegacyBridge is Script { + using stdToml for string; + + Config internal config; + Addresses internal addresses; + + struct Config { + uint256 chainId; + address l2SharedBridgeAddress; + bytes32 create2FactorySalt; + } + + struct Addresses { + address create2FactoryAddr; + address bridgehub; + address diamondProxy; + address sharedBridgeProxy; + address transparentProxyAdmin; + address erc20BridgeProxy; + address tokenWethAddress; + address erc20BridgeProxyImpl; + address sharedBridgeProxyImpl; + } + + function run() public { + initializeConfig(); + deploySharedBridgeImplementation(); + upgradeImplementation(addresses.sharedBridgeProxy, addresses.sharedBridgeProxyImpl); + deployDummyErc20Bridge(); + upgradeImplementation(addresses.erc20BridgeProxy, addresses.erc20BridgeProxyImpl); + setParamsForDummyBridge(); + } + + function initializeConfig() internal { + string memory root = vm.projectRoot(); + string memory path = string.concat(root, "/script-config/setup-legacy-bridge.toml"); + string memory toml = vm.readFile(path); + + addresses.bridgehub = toml.readAddress("$.bridgehub"); + addresses.diamondProxy = toml.readAddress("$.diamond_proxy"); + addresses.sharedBridgeProxy = toml.readAddress("$.shared_bridge_proxy"); + addresses.transparentProxyAdmin = toml.readAddress("$.transparent_proxy_admin"); + addresses.erc20BridgeProxy = toml.readAddress("$.erc20bridge_proxy"); + addresses.tokenWethAddress = toml.readAddress("$.token_weth_address"); + addresses.create2FactoryAddr = toml.readAddress("$.create2factory_addr"); + config.chainId = toml.readUint("$.chain_id"); + config.l2SharedBridgeAddress = toml.readAddress("$.l2shared_bridge_address"); + config.create2FactorySalt = toml.readBytes32("$.create2factory_salt"); + } + + // We need to deploy new shared bridge for changing chain id and diamond proxy address + function deploySharedBridgeImplementation() internal { + bytes memory bytecode = abi.encodePacked( + type(L1SharedBridge).creationCode, + // solhint-disable-next-line func-named-parameters + abi.encode(addresses.tokenWethAddress, addresses.bridgehub, config.chainId, addresses.diamondProxy) + ); + + address contractAddress = deployViaCreate2(bytecode); + addresses.sharedBridgeProxyImpl = contractAddress; + } + + function deployDummyErc20Bridge() internal { + bytes memory bytecode = abi.encodePacked( + type(DummyL1ERC20Bridge).creationCode, + // solhint-disable-next-line func-named-parameters + abi.encode(addresses.sharedBridgeProxy) + ); + address contractAddress = deployViaCreate2(bytecode); + addresses.erc20BridgeProxyImpl = contractAddress; + } + + function upgradeImplementation(address proxy, address implementation) internal { + bytes memory proxyAdminUpgradeData = abi.encodeCall( + ProxyAdmin.upgrade, + (ITransparentUpgradeableProxy(proxy), implementation) + ); + ProxyAdmin _proxyAdmin = ProxyAdmin(addresses.transparentProxyAdmin); + address governance = _proxyAdmin.owner(); + + Utils.executeUpgrade({ + _governor: address(governance), + _salt: bytes32(0), + _target: address(addresses.transparentProxyAdmin), + _data: proxyAdminUpgradeData, + _value: 0, + _delay: 0 + }); + } + + function setParamsForDummyBridge() internal { + (address l2TokenBeacon, bytes32 l2TokenBeaconHash) = calculateTokenBeaconAddress(); + DummyL1ERC20Bridge bridge = DummyL1ERC20Bridge(addresses.erc20BridgeProxy); + bridge.setValues(config.l2SharedBridgeAddress, l2TokenBeacon, l2TokenBeaconHash); + } + + function calculateTokenBeaconAddress() + internal + returns (address tokenBeaconAddress, bytes32 tokenBeaconBytecodeHash) + { + bytes memory l2StandardTokenCode = Utils.readHardhatBytecode( + "/../l2-contracts/artifacts-zk/contracts/bridge/L2StandardERC20.sol/L2StandardERC20.json" + ); + (address l2StandardToken, ) = calculateL2Create2Address( + config.l2SharedBridgeAddress, + l2StandardTokenCode, + bytes32(0), + "" + ); + + bytes memory beaconProxy = Utils.readHardhatBytecode( + "/../l2-contracts/artifacts-zk/@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol/BeaconProxy.json" + ); + + (tokenBeaconAddress, tokenBeaconBytecodeHash) = calculateL2Create2Address( + config.l2SharedBridgeAddress, + beaconProxy, + bytes32(0), + abi.encode(l2StandardToken) + ); + } + + function calculateL2Create2Address( + address sender, + bytes memory bytecode, + bytes32 create2salt, + bytes memory constructorargs + ) internal returns (address create2Address, bytes32 bytecodeHash) { + bytecodeHash = L2ContractHelper.hashL2Bytecode(bytecode); + + create2Address = L2ContractHelper.computeCreate2Address( + sender, + create2salt, + bytecodeHash, + keccak256(constructorargs) + ); + } + + function deployViaCreate2(bytes memory _bytecode) internal returns (address) { + return Utils.deployViaCreate2(_bytecode, config.create2FactorySalt, addresses.create2FactoryAddr); + } +} diff --git a/l1-contracts/foundry.toml b/l1-contracts/foundry.toml index c640a4b27..c2e651106 100644 --- a/l1-contracts/foundry.toml +++ b/l1-contracts/foundry.toml @@ -1,33 +1,40 @@ [profile.default] +allow_paths = ["../l2-contracts/contracts"] src = "contracts" out = "out" -libs = ["lib"] +libs = ["node_modules", "./lib", "../da-contracts/"] cache_path = "cache-forge" test = "test/foundry" solc_version = "0.8.24" evm_version = "cancun" -allow_paths = ["../l2-contracts/contracts"] fs_permissions = [ { access = "read", path = "../system-contracts/bootloader/build/artifacts" }, { access = "read", path = "../system-contracts/artifacts-zk/contracts-preprocessed" }, { access = "read", path = "../l2-contracts/artifacts-zk/" }, + { access = "read", path = "../l1-contracts/artifacts-zk/" }, { access = "read", path = "../da-contracts/" }, - { access = "read", path = "../l2-contracts/zkout/" }, { access = "read", path = "../system-contracts/zkout/" }, { access = "read", path = "./script-config" }, { access = "read-write", path = "./script-out" }, { access = "read", path = "./out" }, - { access = "read", path = "./test/foundry/integration/deploy-scripts/script-config/" }, - { access = "read-write", path = "./test/foundry/integration/deploy-scripts/script-out/" }, + { access = "read", path = "./test/foundry/l1/integration/deploy-scripts/script-config/" }, + { access = "read-write", path = "./test/foundry/l1/integration/deploy-scripts/script-out/" }, + { access = "read", path = "zkout" }, ] ignored_error_codes = ["missing-receive-ether", "code-size"] ignored_warnings_from = ["test", "contracts/dev-contracts"] +suppressed_warnings = ["txorigin"] remappings = [ "forge-std/=lib/forge-std/src/", "murky/=lib/murky/src/", "foundry-test/=test/foundry/", + "l2-contracts/=../l2-contracts/contracts/", + "da-contracts/=../da-contracts/contracts/", "@openzeppelin/contracts-v4/=lib/openzeppelin-contracts-v4/contracts/", "@openzeppelin/contracts-upgradeable-v4/=lib/openzeppelin-contracts-upgradeable-v4/contracts/", - "l2-contracts/=../l2-contracts/contracts/", - "da-contracts/=../da-contracts/contracts/" ] +optimizer = true +optimizer_runs = 9999999 +[profile.default.zksync] +enable_eravm_extensions = true +zksolc = "1.5.3" diff --git a/l1-contracts/hardhat.config.ts b/l1-contracts/hardhat.config.ts index fc8b7b1d7..f19968b51 100644 --- a/l1-contracts/hardhat.config.ts +++ b/l1-contracts/hardhat.config.ts @@ -13,19 +13,6 @@ if (!process.env.CHAIN_ETH_NETWORK) { require("dotenv").config(); } -const COMPILER_VERSION = "1.5.0"; -const PRE_RELEASE_VERSION = "prerelease-a167aa3-code4rena"; -function getZksolcUrl(): string { - // @ts-ignore - const platform = { darwin: "macosx", linux: "linux", win32: "windows" }[process.platform]; - // @ts-ignore - const toolchain = { linux: "-musl", win32: "-gnu", darwin: "" }[process.platform]; - const arch = process.arch === "x64" ? "amd64" : process.arch; - const ext = process.platform === "win32" ? ".exe" : ""; - - return `https://github.com/matter-labs/era-compiler-solidity/releases/download/${PRE_RELEASE_VERSION}/zksolc-${platform}-${arch}${toolchain}-v${COMPILER_VERSION}${ext}`; -} - // These are L2/ETH networks defined by environment in `dev.env` of zksync-era default development environment // const DEFAULT_L2_NETWORK = "http://127.0.0.1:3050"; const DEFAULT_ETH_NETWORK = "http://127.0.0.1:8545"; @@ -58,7 +45,7 @@ export default { zksolc: { compilerSource: "binary", settings: { - compilerPath: getZksolcUrl(), + // compilerPath: getZksolcUrl(), isSystem: true, }, }, diff --git a/l1-contracts/package.json b/l1-contracts/package.json index d090d78c2..0c955188e 100644 --- a/l1-contracts/package.json +++ b/l1-contracts/package.json @@ -54,15 +54,16 @@ }, "scripts": { "build": "hardhat compile && CONTRACTS_BASE_NETWORK_ZKSYNC=true hardhat compile ", - "build-l1": "harhdat compile", - "clean": "hardhat clean", + "build-l1": "hardhat compile", + "clean": "hardhat clean && CONTRACTS_BASE_NETWORK_ZKSYNC=true hardhat clean", "clean:foundry": "forge clean", "test": "yarn workspace da-contracts build && hardhat test test/unit_tests/*.spec.ts --network hardhat", - "test:foundry": "forge test --ffi", + "test:foundry": "forge test --ffi --match-path 'test/foundry/l1/*'", + "test:zkfoundry": "forge test --zksync --match-path 'test/foundry/l2/*'", "test:fork": "TEST_CONTRACTS_FORK=1 yarn run hardhat test test/unit_tests/*.fork.ts --network hardhat", - "coverage:foundry": "forge coverage --ffi", + "coverage:foundry": "forge coverage --ffi --match-path 'test/foundry/l1/*' --no-match-coverage 'contracts/(bridge/.*L2.*\\.sol|governance/L2AdminFactory\\.sol)'", "deploy-no-build": "ts-node scripts/deploy.ts", - "register-hyperchain": "ts-node scripts/register-hyperchain.ts", + "register-zk-chain": "ts-node scripts/register-zk-chain.ts", "deploy-weth-bridges": "ts-node scripts/deploy-weth-bridges.ts", "initialize-l2-weth-token": "ts-node scripts/initialize-l2-weth-token.ts", "deploy-erc20": "ts-node scripts/deploy-erc20.ts", diff --git a/l1-contracts/scripts/display-governance.ts b/l1-contracts/scripts/display-governance.ts index 0593d580e..4b6741386 100644 --- a/l1-contracts/scripts/display-governance.ts +++ b/l1-contracts/scripts/display-governance.ts @@ -13,7 +13,7 @@ import { UpgradeableBeaconFactory } from "../../l2-contracts/typechain/Upgradeab import { Provider } from "zksync-ethers"; const l2SharedBridgeABI = JSON.parse( - fs.readFileSync("../zksync/artifacts-zk/contracts/bridge/L2SharedBridge.sol/L2SharedBridge.json").toString() + fs.readFileSync("../zksync/artifacts-zk/contracts/bridge/L2AssetRouter.sol/L2SharedBridge.json").toString() ).abi; async function getERC20BeaconAddress(l2SharedBridgeAddress: string) { diff --git a/l1-contracts/scripts/initialize-l2-weth-token.ts b/l1-contracts/scripts/initialize-l2-weth-token.ts index 4bf9dd933..7cb09f075 100644 --- a/l1-contracts/scripts/initialize-l2-weth-token.ts +++ b/l1-contracts/scripts/initialize-l2-weth-token.ts @@ -16,7 +16,7 @@ const provider = web3Provider(); const testConfigPath = path.join(process.env.ZKSYNC_HOME as string, "etc/test_config/constant"); const ethTestConfig = JSON.parse(fs.readFileSync(`${testConfigPath}/eth.json`, { encoding: "utf-8" })); -const contractArtifactsPath = path.join(process.env.ZKSYNC_HOME as string, "contracts/l2-contracts/artifacts-zk/"); +const contractArtifactsPath = path.join(process.env.ZKSYNC_HOME as string, "contracts/l1-contracts/artifacts-zk/"); const l2BridgeArtifactsPath = path.join(contractArtifactsPath, "contracts/bridge/"); const openzeppelinTransparentProxyArtifactsPath = path.join( contractArtifactsPath, diff --git a/l1-contracts/scripts/migrate-governance.ts b/l1-contracts/scripts/migrate-governance.ts index f8f44a8b6..0c04a79c5 100644 --- a/l1-contracts/scripts/migrate-governance.ts +++ b/l1-contracts/scripts/migrate-governance.ts @@ -23,7 +23,7 @@ const priorityTxMaxGasLimit = BigNumber.from(getNumberFromEnv("CONTRACTS_PRIORIT const l2SharedBridgeABI = JSON.parse( fs - .readFileSync("../l2-contracts/artifacts-zk/contracts-preprocessed/bridge/L2SharedBridge.sol/L2SharedBridge.json") + .readFileSync("../l2-contracts/artifacts-zk/contracts-preprocessed/bridge/L2AssetRouter.sol/L2SharedBridge.json") .toString() ).abi; diff --git a/l1-contracts/scripts/register-hyperchain.ts b/l1-contracts/scripts/register-hyperchain.ts index 8a68c92df..13013a9d2 100644 --- a/l1-contracts/scripts/register-hyperchain.ts +++ b/l1-contracts/scripts/register-hyperchain.ts @@ -8,7 +8,7 @@ import * as fs from "fs"; import * as path from "path"; import { Deployer } from "../src.ts/deploy"; import { GAS_MULTIPLIER, web3Provider } from "./utils"; -import { ADDRESS_ONE } from "../src.ts/utils"; +import { ADDRESS_ONE, encodeNTVAssetId } from "../src.ts/utils"; import { getTokens } from "../src.ts/deploy-token"; const ETH_TOKEN_ADDRESS = ADDRESS_ONE; @@ -55,7 +55,7 @@ const chooseBaseTokenAddress = async (name?: string, address?: string) => { async function main() { const program = new Command(); - program.version("0.1.0").name("register-hyperchain").description("register hyperchains"); + program.version("0.1.0").name("register-zk-chain").description("register zk-chains"); program .option("--private-key ") @@ -66,7 +66,7 @@ async function main() { .option("--validium-mode") .option("--base-token-name ") .option("--base-token-address ") - .option("--use-governance ") + .option("--use-governance") .option("--token-multiplier-setter-address ") .action(async (cmd) => { const deployWallet = cmd.privateKey @@ -92,18 +92,20 @@ async function main() { deployWallet, ownerAddress, verbose: true, + l1ChainId: process.env.CONTRACTS_L1_CHAIN_ID || "31337", }); const baseTokenAddress = await chooseBaseTokenAddress(cmd.baseTokenName, cmd.baseTokenAddress); await checkTokenAddress(baseTokenAddress); console.log(`Using base token address: ${baseTokenAddress}`); console.log(deployer.addresses.Bridgehub.BridgehubProxy); - if (!(await deployer.bridgehubContract(deployWallet).tokenIsRegistered(baseTokenAddress))) { + const baseTokenAssetId = encodeNTVAssetId(deployer.l1ChainId, baseTokenAddress); + if (!(await deployer.bridgehubContract(deployWallet).assetIdIsRegistered(baseTokenAssetId))) { await deployer.registerTokenBridgehub(baseTokenAddress, cmd.useGovernance); } await deployer.registerTokenInNativeTokenVault(baseTokenAddress); - await deployer.registerHyperchain( - baseTokenAddress, + await deployer.registerZKChain( + baseTokenAssetId, cmd.validiumMode, null, gasPrice, @@ -114,7 +116,6 @@ async function main() { ); const tokenMultiplierSetterAddress = cmd.tokenMultiplierSetterAddress || ""; - if (tokenMultiplierSetterAddress != "") { console.log(`Using token multiplier setter address: ${tokenMultiplierSetterAddress}`); await deployer.setTokenMultiplierSetterAddress(tokenMultiplierSetterAddress); diff --git a/l1-contracts/scripts/revert-reason.ts b/l1-contracts/scripts/revert-reason.ts index 713587bc0..2cd8eae83 100644 --- a/l1-contracts/scripts/revert-reason.ts +++ b/l1-contracts/scripts/revert-reason.ts @@ -7,7 +7,7 @@ import { Interface } from "ethers/lib/utils"; import { web3Url } from "./utils"; const erc20BridgeInterface = new Interface(hardhat.artifacts.readArtifactSync("L1ERC20Bridge").abi); -const zkSyncInterface = new Interface(hardhat.artifacts.readArtifactSync("IZkSyncHyperchain").abi); +const zkSyncInterface = new Interface(hardhat.artifacts.readArtifactSync("IZKChain").abi); const verifierInterface = new Interface(hardhat.artifacts.readArtifactSync("Verifier").abi); const bridgehubInterface = new Interface(hardhat.artifacts.readArtifactSync("Bridgehub").abi); const sharedBridgeInterface = new Interface(hardhat.artifacts.readArtifactSync("L1SharedBridge").abi); diff --git a/l1-contracts/scripts/setup-legacy-bridge-era.ts b/l1-contracts/scripts/setup-legacy-bridge-era.ts index 32a81c23d..37eeef9cc 100644 --- a/l1-contracts/scripts/setup-legacy-bridge-era.ts +++ b/l1-contracts/scripts/setup-legacy-bridge-era.ts @@ -118,7 +118,8 @@ async function main() { console.log("l2TokenBytecodeHash:", ethers.utils.hexlify(l2TokenBytecodeHash)); // set storage values - const tx = await dummyBridge.setValues(l2SharedBridgeAddress, l2TokenBeacon, l2TokenBytecodeHash); + // FIXME(EVM-716): we provide the `L2NativeTokenVaultAddress` as the "shared bridge value" as it is only used for calculating of L2 token addresses. + const tx = await dummyBridge.setValues(L2NativeTokenVaultAddress, l2TokenBeacon, l2TokenBytecodeHash); await tx.wait(); console.log("Set storage values for TestERC20Bridge"); diff --git a/l1-contracts/scripts/sync-layer.ts b/l1-contracts/scripts/sync-layer.ts index 16811295e..c463ef38d 100644 --- a/l1-contracts/scripts/sync-layer.ts +++ b/l1-contracts/scripts/sync-layer.ts @@ -15,10 +15,11 @@ import { ADDRESS_ONE, REQUIRED_L2_GAS_PRICE_PER_PUBDATA, priorityTxMaxGasLimit, + L2_BRIDGEHUB_ADDRESS, } from "../src.ts/utils"; import { Wallet as ZkWallet, Provider as ZkProvider, utils as zkUtils } from "zksync-ethers"; -import { IStateTransitionManagerFactory } from "../typechain/IStateTransitionManagerFactory"; +import { IChainTypeManagerFactory } from "../typechain/IChainTypeManagerFactory"; import { TestnetERC20TokenFactory } from "../typechain/TestnetERC20TokenFactory"; import { BOOTLOADER_FORMAL_ADDRESS } from "zksync-ethers/build/utils"; @@ -145,7 +146,7 @@ async function main() { const currentChainId = getNumberFromEnv("CHAIN_ETH_ZKSYNC_NETWORK_ID"); - const stm = deployer.stateTransitionManagerContract(deployer.deployWallet); + const ctm = deployer.chainTypeManagerContract(deployer.deployWallet); const counterPart = getAddressFromEnv("GATEWAY_STATE_TRANSITION_PROXY_ADDR"); @@ -160,7 +161,7 @@ async function main() { const receipt = await deployer.moveChainToGateway(gatewayChainId, gasPrice); - const gatewayAddress = await stm.getHyperchain(gatewayChainId); + const gatewayAddress = await ctm.getZKChain(gatewayChainId); const l2TxHash = zkUtils.getL2HashFromPriorityOp(receipt, gatewayAddress); @@ -175,9 +176,9 @@ async function main() { const receiptOnSL = await (await txL2Handle).wait(); console.log("Finalized on SL with hash:", receiptOnSL.transactionHash); - const stmOnSL = IStateTransitionManagerFactory.connect(counterPart, gatewayProvider); - const hyperchainAddress = await stmOnSL.getHyperchain(currentChainId); - console.log(`CONTRACTS_DIAMOND_PROXY_ADDR=${hyperchainAddress}`); + const ctmOnSL = IChainTypeManagerFactory.connect(counterPart, gatewayProvider); + const zkChainAddress = await ctmOnSL.getZKChain(currentChainId); + console.log(`CONTRACTS_DIAMOND_PROXY_ADDR=${zkChainAddress}`); console.log("Success!"); }); @@ -213,14 +214,14 @@ async function main() { verbose: true, }); - const hyperchain = deployer.stateTransitionContract(deployer.deployWallet); + const zkChain = deployer.stateTransitionContract(deployer.deployWallet); - console.log(await hyperchain.getAdmin()); + console.log(await zkChain.getAdmin()); console.log("Executing recovery..."); await ( - await hyperchain.recoverFromFailedMigrationToGateway( + await zkChain.recoverFromFailedMigrationToGateway( gatewayChainId, proof.l2BatchNumber, proof.l2MessageIndex, @@ -272,6 +273,10 @@ async function main() { const timelock = deployer.validatorTimelock(deployer.deployWallet); for (const operator of operators) { + if (await timelock.validators(currentChainId, operator)) { + continue; + } + await deployer.deployWallet.sendTransaction({ to: operator, value: ethers.utils.parseEther("5"), @@ -286,19 +291,13 @@ async function main() { ); deployer.addresses.Bridgehub.BridgehubProxy = getAddressFromEnv("GATEWAY_BRIDGEHUB_PROXY_ADDR"); - // FIXME? Do we want to - console.log("Setting default token multiplier"); - - const hyperchain = deployer.stateTransitionContract(deployer.deployWallet); - - console.log("The default ones token multiplier"); - await (await hyperchain.setTokenMultiplier(1, 1)).wait(); + const zkChain = deployer.stateTransitionContract(deployer.deployWallet); console.log("Setting SL DA validators"); // This logic should be distinctive between Validium and Rollup const l1DaValidator = getAddressFromEnv("GATEWAY_L1_RELAYED_SL_DA_VALIDATOR"); const l2DaValidator = getAddressFromEnv("CONTRACTS_L2_DA_VALIDATOR_ADDR"); - await (await hyperchain.setDAValidatorPair(l1DaValidator, l2DaValidator)).wait(); + await (await zkChain.setDAValidatorPair(l1DaValidator, l2DaValidator)).wait(); console.log("Success!"); }); @@ -307,34 +306,26 @@ async function main() { } async function registerSLContractsOnL1(deployer: Deployer) { - /// STM asset info + /// CTM asset info /// l2Bridgehub in L1Bridghub - const bridgehubOnGateway = getAddressFromEnv("GATEWAY_BRIDGEHUB_PROXY_ADDR"); const chainId = getNumberFromEnv("CHAIN_ETH_ZKSYNC_NETWORK_ID"); - console.log(`Bridghub on Gateway: ${bridgehubOnGateway}`); console.log(`Gateway chain Id: ${chainId}`); - const l1STM = deployer.stateTransitionManagerContract(deployer.deployWallet); const l1Bridgehub = deployer.bridgehubContract(deployer.deployWallet); + const l1CTM = deployer.chainTypeManagerContract(deployer.deployWallet); console.log(deployer.addresses.StateTransition.StateTransitionProxy); - const gatewayAddress = await l1STM.getHyperchain(chainId); + const gatewayAddress = await l1Bridgehub.getZKChain(chainId); // this script only works when owner is the deployer - console.log("Registering Gateway chain id on the STM"); + console.log("Registering Gateway chain id on the CTM"); const receipt1 = await deployer.executeUpgrade( - l1STM.address, + l1Bridgehub.address, 0, l1Bridgehub.interface.encodeFunctionData("registerSettlementLayer", [chainId, true]) ); - console.log("Registering Bridgehub counter part on the Gateway", receipt1.transactionHash); - // await deployer.executeUpgrade( - // l1Bridgehub.address, // kl todo fix. The BH has the counterpart, the BH needs to be deployed on L2, and the STM needs to be registered in the L2 BH. - // 0, - // l1Bridgehub.interface.encodeFunctionData("registerCounterpart", [chainId, bridgehubOnGateway]) - // ); - // console.log("Gateway registration completed in L1 Bridgehub"); + console.log("Registering Gateway as settlement layer on the L1", receipt1.transactionHash); const gasPrice = (await deployer.deployWallet.provider.getGasPrice()).mul(GAS_MULTIPLIER); const value = ( @@ -351,25 +342,14 @@ async function registerSLContractsOnL1(deployer: Deployer) { baseToken.interface.encodeFunctionData("approve", [this.addresses.Bridges.SharedBridgeProxy, value.mul(2)]) ); } - const stmDeploymentTracker = deployer.stmDeploymentTracker(deployer.deployWallet); + const ctmDeploymentTracker = deployer.ctmDeploymentTracker(deployer.deployWallet); + const assetRouter = deployer.defaultSharedBridge(deployer.deployWallet); + const assetId = await l1Bridgehub.ctmAssetIdFromChainId(chainId); + // Setting the L2 bridgehub as the counterpart for the CTM asset const receipt2 = await deployer.executeUpgrade( - stmDeploymentTracker.address, - value, - stmDeploymentTracker.encodeFunctionData("registerSTMAssetOnL2SharedBridge", [ - chainId, - l1STM.address, - value, - priorityTxMaxGasLimit, - SYSTEM_CONFIG.requiredL2GasPricePerPubdata, - deployer.deployWallet.address, - ]) - ); - const l2TxHash = zkUtils.getL2HashFromPriorityOp(receipt2, gatewayAddress); - console.log("STM asset registered in L2SharedBridge on SL l2 tx hash: ", l2TxHash); - const receipt3 = await deployer.executeUpgrade( l1Bridgehub.address, - value, + ethIsBaseToken ? value : 0, l1Bridgehub.interface.encodeFunctionData("requestL2TransactionTwoBridges", [ { chainId, @@ -378,29 +358,54 @@ async function registerSLContractsOnL1(deployer: Deployer) { l2GasLimit: priorityTxMaxGasLimit, l2GasPerPubdataByteLimit: SYSTEM_CONFIG.requiredL2GasPricePerPubdata, refundRecipient: deployer.deployWallet.address, - secondBridgeAddress: stmDeploymentTracker.address, + secondBridgeAddress: assetRouter.address, secondBridgeValue: 0, - secondBridgeCalldata: ethers.utils.defaultAbiCoder.encode( - ["address", "address"], - [l1STM.address, getAddressFromEnv("GATEWAY_STATE_TRANSITION_PROXY_ADDR")] - ), + secondBridgeCalldata: + "0x02" + + ethers.utils.defaultAbiCoder.encode(["bytes32", "address"], [assetId, L2_BRIDGEHUB_ADDRESS]).slice(2), }, ]) ); - const l2TxHash2 = zkUtils.getL2HashFromPriorityOp(receipt3, gatewayAddress); - console.log("STM asset registered in L2 Bridgehub on SL", l2TxHash2); + const l2TxHash = zkUtils.getL2HashFromPriorityOp(receipt2, gatewayAddress); + console.log("CTM asset registered in L2SharedBridge on SL tx hash: ", receipt2.transactionHash); + console.log("CTM asset registered in L2SharedBridge on SL l2 tx hash: ", l2TxHash); - const upgradeData = l1Bridgehub.interface.encodeFunctionData("addStateTransitionManager", [ - deployer.addresses.StateTransition.StateTransitionProxy, - ]); - const receipt4 = await deployer.executeUpgradeOnL2( + const l2CTMAddress = getAddressFromEnv("GATEWAY_STATE_TRANSITION_PROXY_ADDR"); + + // Whitelisting the CTM address on L2 + const receipt3 = await deployer.executeUpgradeOnL2( chainId, - getAddressFromEnv("GATEWAY_BRIDGEHUB_PROXY_ADDR"), + L2_BRIDGEHUB_ADDRESS, gasPrice, - upgradeData, + l1Bridgehub.interface.encodeFunctionData("addChainTypeManager", [l2CTMAddress]), priorityTxMaxGasLimit ); - console.log(`StateTransition System registered, txHash: ${receipt4.transactionHash}`); + const l2TxHash2dot5 = zkUtils.getL2HashFromPriorityOp(receipt3, gatewayAddress); + console.log(`L2 CTM ,l2 txHash: ${l2TxHash2dot5}`); + console.log(`L2 CTM address ${l2CTMAddress} registered on gateway, txHash: ${receipt3.transactionHash}`); + + // Setting the corresponding CTM address on L2. + const receipt4 = await deployer.executeUpgrade( + l1Bridgehub.address, + value, + l1Bridgehub.interface.encodeFunctionData("requestL2TransactionTwoBridges", [ + { + chainId, + mintValue: value, + l2Value: 0, + l2GasLimit: priorityTxMaxGasLimit, + l2GasPerPubdataByteLimit: SYSTEM_CONFIG.requiredL2GasPricePerPubdata, + refundRecipient: deployer.deployWallet.address, + secondBridgeAddress: ctmDeploymentTracker.address, + secondBridgeValue: 0, + secondBridgeCalldata: + "0x01" + ethers.utils.defaultAbiCoder.encode(["address", "address"], [l1CTM.address, l2CTMAddress]).slice(2), + }, + ]) + ); + const l2TxHash3 = zkUtils.getL2HashFromPriorityOp(receipt4, gatewayAddress); + console.log("CTM asset registered in L2 Bridgehub on SL", receipt4.transactionHash); + console.log("CTM asset registered in L2 Bridgehub on SL l2TxHash", l2TxHash3); } // TODO: maybe move it to SDK diff --git a/l1-contracts/scripts/upgrade-consistency-checker.ts b/l1-contracts/scripts/upgrade-consistency-checker.ts index c70411296..798f6f36a 100644 --- a/l1-contracts/scripts/upgrade-consistency-checker.ts +++ b/l1-contracts/scripts/upgrade-consistency-checker.ts @@ -10,16 +10,17 @@ import { BigNumber, ethers } from "ethers"; import { utils } from "zksync-ethers"; import type { FacetCut } from "../src.ts/diamondCut"; import { getCurrentFacetCutsForAdd } from "../src.ts/diamondCut"; +import { encodeNTVAssetId } from "../src.ts/utils"; // Things that still have to be manually double checked: // 1. Contracts must be verified. -// 2. Getter methods in STM. +// 2. Getter methods in CTM. // List the contracts that should become the upgrade targets const genesisUpgrade = process.env.CONTRACTS_GENESIS_UPGRADE_ADDR!; const validatorTimelockDeployTx = "0xde4ef2b77241b605acaa1658ff8815df0911bf81555a80c9cbdde42fbcaaea30"; const validatorTimelock = process.env.CONTRACTS_VALIDATOR_TIMELOCK_ADDR!; -const upgradeHyperchains = process.env.CONTRACTS_HYPERCHAIN_UPGRADE_ADDR!; +const upgradeZKChains = process.env.CONTRACTS_ZK_CHAIN_UPGRADE_ADDR!; const verifier = process.env.CONTRACTS_VERIFIER_ADDR!; const proxyAdmin = process.env.CONTRACTS_TRANSPARENT_PROXY_ADMIN_ADDR!; @@ -35,10 +36,10 @@ const gettersFacet = process.env.CONTRACTS_GETTERS_FACET_ADDR!; const diamondInit = process.env.CONTRACTS_DIAMOND_INIT_ADDR!; -const stmImplDeployTx = "0xe01c0bb497017a25c92bfc712e370e8f900554b107fe0b6022976d05c349f2b6"; -const stmImpl = process.env.CONTRACTS_STATE_TRANSITION_IMPL_ADDR!; -const stmDeployTx = "0x514bbf46d227eee8567825bf5c8ee1855aa8a1916f7fee7b191e2e3d5ecba849"; -const stm = process.env.CONTRACTS_STATE_TRANSITION_PROXY_ADDR!; +const ctmImplDeployTx = "0xe01c0bb497017a25c92bfc712e370e8f900554b107fe0b6022976d05c349f2b6"; +const ctmImpl = process.env.CONTRACTS_STATE_TRANSITION_IMPL_ADDR!; +const ctmDeployTx = "0x514bbf46d227eee8567825bf5c8ee1855aa8a1916f7fee7b191e2e3d5ecba849"; +const ctm = process.env.CONTRACTS_STATE_TRANSITION_PROXY_ADDR!; const sharedBridgeImplDeployTx = "0x074204db79298c2f6beccae881c2ad7321c331e97fb4bd93adce2eb23bf17a17"; const sharedBridgeImpl = process.env.CONTRACTS_L1_SHARED_BRIDGE_IMPL_ADDR!; @@ -52,9 +53,10 @@ const initialOwner = "0x71d84c3404a6ae258E6471d4934B96a2033F9438"; const expectedOwner = "0x71d84c3404a6ae258E6471d4934B96a2033F9438"; //process.env.CONTRACTS_GOVERNANCE_ADDR!; const expectedDelay = "75600"; const eraChainId = process.env.CONTRACTS_ERA_CHAIN_ID!; +const l1ChainId = process.env.CONTRACTS_L1_CHAIN_ID!; const expectedSalt = "0x0000000000000000000000000000000000000000000000000000000000000001"; -const expectedHyperchainAddr = "0x32400084c286cf3e17e7b677ea9583e60a000324"; -const maxNumberOfHyperchains = 100; +const expectedZKChainAddr = "0x32400084c286cf3e17e7b677ea9583e60a000324"; +const maxNumberOfZKChains = 100; const expectedStoredBatchHashZero = "0x1574fa776dec8da2071e5f20d71840bfcbd82c2bca9ad68680edfedde1710bc4"; const expectedL2BridgeAddress = "0x11f943b2c77b743AB90f4A0Ae7d5A4e7FCA3E102"; const expectedL1LegacyBridge = "0x57891966931Eb4Bb6FB81430E6cE0A03AAbDe063"; @@ -276,7 +278,7 @@ async function extractProxyInitializationData(contract: ethers.Contract, data: s throw new Error("L2 default account bytecode hash is not correct"); } - console.log("STM init data correct!"); + console.log("CTM init data correct!"); } async function checkValidatorTimelock() { @@ -288,9 +290,9 @@ async function checkValidatorTimelock() { throw new Error("ValidatorTimelock owner is not correct"); } - const usedStm = await contract.stateTransitionManager(); - if (usedStm.toLowerCase() != stm.toLowerCase()) { - throw new Error("ValidatorTimelock stateTransitionManager is not correct"); + const usedCtm = await contract.chainTypeManager(); + if (usedCtm.toLowerCase() != ctm.toLowerCase()) { + throw new Error("ValidatorTimelock chainTypeManager is not correct"); } const validatorOneIsSet = await contract.validators(eraChainId, validatorOne); @@ -326,9 +328,9 @@ async function checkBridgehub() { throw new Error("Bridgehub baseToken is not correct"); } - const hyperchain = await contract.getHyperchain(eraChainId); - if (hyperchain.toLowerCase() != expectedHyperchainAddr.toLowerCase()) { - throw new Error("Bridgehub hyperchain is not correct"); + const zkChain = await contract.getZKChain(eraChainId); + if (zkChain.toLowerCase() != expectedZKChainAddr.toLowerCase()) { + throw new Error("Bridgehub zkChain is not correct"); } const sharedBridge = await contract.sharedBridge(); @@ -336,17 +338,21 @@ async function checkBridgehub() { throw new Error("Bridgehub sharedBridge is not correct"); } - const usedSTM = await contract.stateTransitionManager(eraChainId); - if (usedSTM.toLowerCase() != stm.toLowerCase()) { - throw new Error("Bridgehub stateTransitionManager is not correct"); + const usedCTM = await contract.chainTypeManager(eraChainId); + if (usedCTM.toLowerCase() != ctm.toLowerCase()) { + throw new Error("Bridgehub chainTypeManager is not correct"); } - const isRegistered = await contract.stateTransitionManagerIsRegistered(usedSTM); + const isRegistered = await contract.chainTypeManagerIsRegistered(usedCTM); if (!isRegistered) { - throw new Error("Bridgehub stateTransitionManager is not registered"); + throw new Error("Bridgehub chainTypeManager is not registered"); } - const tokenIsRegistered = await contract.tokenIsRegistered(utils.ETH_ADDRESS_IN_CONTRACTS); + const baseTokenAssetId = encodeNTVAssetId( + parseInt(l1ChainId), + ethers.utils.hexZeroPad(utils.ETH_ADDRESS_IN_CONTRACTS, 32) + ); + const tokenIsRegistered = contract.assetIdIsRegistered(baseTokenAssetId); if (!tokenIsRegistered) { throw new Error("Bridgehub token is not registered"); } @@ -362,47 +368,47 @@ async function checkMailbox() { console.log("Mailbox is correct!"); } -async function checkSTMImpl() { - const artifact = await hardhat.artifacts.readArtifact("StateTransitionManager"); - const contract = new ethers.Contract(stmImpl, artifact.abi, l1Provider); +async function checkCTMImpl() { + const artifact = await hardhat.artifacts.readArtifact("ChainTypeManager"); + const contract = new ethers.Contract(ctmImpl, artifact.abi, l1Provider); - await checkCorrectInitCode(stmImplDeployTx, contract, artifact.bytecode, [bridgeHub, maxNumberOfHyperchains]); + await checkCorrectInitCode(ctmImplDeployTx, contract, artifact.bytecode, [bridgeHub, maxNumberOfZKChains]); - console.log("STM impl correct!"); + console.log("CTM impl correct!"); } -async function checkSTM() { - const artifact = await hardhat.artifacts.readArtifact("StateTransitionManager"); +async function checkCTM() { + const artifact = await hardhat.artifacts.readArtifact("ChainTypeManager"); - const contract = new ethers.Contract(stm, artifact.abi, l1Provider); + const contract = new ethers.Contract(ctm, artifact.abi, l1Provider); const usedBH = await contract.BRIDGE_HUB(); if (usedBH.toLowerCase() != bridgeHub.toLowerCase()) { - throw new Error("STM bridgeHub is not correct"); + throw new Error("CTM bridgeHub is not correct"); } - const usedMaxNumberOfHyperchains = (await contract.MAX_NUMBER_OF_HYPERCHAINS()).toNumber(); - if (usedMaxNumberOfHyperchains != maxNumberOfHyperchains) { - throw new Error("STM maxNumberOfHyperchains is not correct"); + const usedMaxNumberOfZKChains = (await contract.MAX_NUMBER_OF_ZK_CHAINS()).toNumber(); + if (usedMaxNumberOfZKChains != maxNumberOfZKChains) { + throw new Error("CTM maxNumberOfZKChains is not correct"); } const genUpgrade = await contract.genesisUpgrade(); if (genUpgrade.toLowerCase() != genesisUpgrade.toLowerCase()) { - throw new Error("STM genesisUpgrade is not correct"); + throw new Error("CTM genesisUpgrade is not correct"); } const storedBatchHashZero = await contract.storedBatchZero(); if (storedBatchHashZero.toLowerCase() != expectedStoredBatchHashZero.toLowerCase()) { - throw new Error("STM storedBatchHashZero is not correct"); + throw new Error("CTM storedBatchHashZero is not correct"); } const currentOwner = await contract.owner(); if (currentOwner.toLowerCase() != expectedOwner.toLowerCase()) { - throw new Error("STM owner is not correct"); + throw new Error("CTM owner is not correct"); } - console.log("STM is correct!"); + console.log("CTM is correct!"); - await extractProxyInitializationData(contract, (await l1Provider.getTransaction(stmDeployTx)).data); + await extractProxyInitializationData(contract, (await l1Provider.getTransaction(ctmDeployTx)).data); } async function checkL1AssetRouterImpl() { @@ -413,7 +419,7 @@ async function checkL1AssetRouterImpl() { expectedL1WethAddress, bridgeHub, eraChainId, - expectedHyperchainAddr, + expectedZKChainAddr, ]); console.log("L1 shared bridge impl correct!"); @@ -476,7 +482,7 @@ async function main() { program.action(async () => { await checkIdenticalBytecode(genesisUpgrade, "GenesisUpgrade"); - await checkIdenticalBytecode(upgradeHyperchains, "UpgradeHyperchains"); + await checkIdenticalBytecode(upgradeZKChains, "UpgradeZKChains"); await checkIdenticalBytecode(executorFacet, "ExecutorFacet"); await checkIdenticalBytecode(gettersFacet, "GettersFacet"); await checkIdenticalBytecode(adminFacet, "AdminFacet"); @@ -496,8 +502,8 @@ async function main() { await checkLegacyBridge(); - await checkSTMImpl(); - await checkSTM(); + await checkCTMImpl(); + await checkCTM(); }); await program.parseAsync(process.argv); diff --git a/l1-contracts/scripts/verify.ts b/l1-contracts/scripts/verify.ts index 5abb2a42a..25255bad7 100644 --- a/l1-contracts/scripts/verify.ts +++ b/l1-contracts/scripts/verify.ts @@ -88,7 +88,7 @@ async function main() { const promise3 = verifyPromise(process.env.CONTRACTS_DEFAULT_UPGRADE_ADDR); promises.push(promise3); - const promise4 = verifyPromise(process.env.CONTRACTS_HYPERCHAIN_UPGRADE_ADDR); + const promise4 = verifyPromise(process.env.CONTRACTS_ZK_CHAIN_UPGRADE_ADDR); promises.push(promise4); const promise5 = verifyPromise(addresses.TransparentProxyAdmin); @@ -108,7 +108,7 @@ async function main() { ]); promises.push(promise7); - // stm + // ctm // Contracts without constructor parameters for (const address of [ @@ -127,18 +127,18 @@ async function main() { const promise8 = verifyPromise(addresses.StateTransition.StateTransitionImplementation, [ addresses.Bridgehub.BridgehubProxy, - getNumberFromEnv("CONTRACTS_MAX_NUMBER_OF_HYPERCHAINS"), + getNumberFromEnv("CONTRACTS_MAX_NUMBER_OF_ZK_CHAINS"), ]); promises.push(promise8); - const stateTransitionManager = new Interface(hardhat.artifacts.readArtifactSync("StateTransitionManager").abi); + const chainTypeManager = new Interface(hardhat.artifacts.readArtifactSync("ChainTypeManager").abi); const genesisBatchHash = getHashFromEnv("CONTRACTS_GENESIS_ROOT"); // TODO: confusing name const genesisRollupLeafIndex = getNumberFromEnv("CONTRACTS_GENESIS_ROLLUP_LEAF_INDEX"); const genesisBatchCommitment = getHashFromEnv("CONTRACTS_GENESIS_BATCH_COMMITMENT"); - const diamondCut = await deployer.initialZkSyncHyperchainDiamondCut([]); + const diamondCut = await deployer.initialZkSyncZKChainDiamondCut([]); const protocolVersion = packSemver(...unpackStringSemVer(process.env.CONTRACTS_GENESIS_PROTOCOL_SEMANTIC_VERSION)); - const initCalldata2 = stateTransitionManager.encodeFunctionData("initialize", [ + const initCalldata2 = chainTypeManager.encodeFunctionData("initialize", [ { owner: addresses.Governance, validatorTimelock: addresses.ValidatorTimeLock, diff --git a/l1-contracts/src.ts/deploy-process.ts b/l1-contracts/src.ts/deploy-process.ts index d197df699..c0f8fd712 100644 --- a/l1-contracts/src.ts/deploy-process.ts +++ b/l1-contracts/src.ts/deploy-process.ts @@ -12,7 +12,13 @@ import type { FacetCut } from "./diamondCut"; import type { Deployer } from "./deploy"; import { getTokens } from "./deploy-token"; -import { ADDRESS_ONE, L2_BRIDGEHUB_ADDRESS, L2_MESSAGE_ROOT_ADDRESS, isCurrentNetworkLocal } from "../src.ts/utils"; +import { + ADDRESS_ONE, + L2_BRIDGEHUB_ADDRESS, + L2_MESSAGE_ROOT_ADDRESS, + isCurrentNetworkLocal, + encodeNTVAssetId, +} from "../src.ts/utils"; export const L2_BOOTLOADER_BYTECODE_HASH = "0x1000100000000000000000000000000000000000000000000000000000000000"; export const L2_DEFAULT_ACCOUNT_BYTECODE_HASH = "0x1001000000000000000000000000000000000000000000000000000000000000"; @@ -88,11 +94,11 @@ export async function initialBridgehubDeployment( } else { await deployer.deployBlobVersionedHashRetriever(create2Salt, { gasPrice }); } - await deployer.deployStateTransitionManagerContract(create2Salt, extraFacets, gasPrice); - await deployer.setStateTransitionManagerInValidatorTimelock({ gasPrice }); + await deployer.deployChainTypeManagerContract(create2Salt, extraFacets, gasPrice); + await deployer.setChainTypeManagerInValidatorTimelock({ gasPrice }); } -export async function registerHyperchain( +export async function registerZKChain( deployer: Deployer, validiumMode: boolean, extraFacets: FacetCut[], @@ -107,12 +113,15 @@ export async function registerHyperchain( ? testnetTokens.find((token: { symbol: string }) => token.symbol == baseTokenName).address : ADDRESS_ONE; - if (!(await deployer.bridgehubContract(deployer.deployWallet).tokenIsRegistered(baseTokenAddress))) { + const baseTokenAssetId = encodeNTVAssetId(deployer.l1ChainId, ethers.utils.hexZeroPad(baseTokenAddress, 32)); + if (!(await deployer.bridgehubContract(deployer.deployWallet).assetIdIsRegistered(baseTokenAssetId))) { await deployer.registerTokenBridgehub(baseTokenAddress, useGovernance); } - await deployer.registerTokenInNativeTokenVault(baseTokenAddress); - await deployer.registerHyperchain( - baseTokenAddress, + if (baseTokenAddress !== ADDRESS_ONE) { + await deployer.registerTokenInNativeTokenVault(baseTokenAddress); + } + await deployer.registerZKChain( + encodeNTVAssetId(deployer.l1ChainId, ethers.utils.hexZeroPad(baseTokenAddress, 32)), validiumMode, extraFacets, gasPrice, diff --git a/l1-contracts/src.ts/deploy-test-process.ts b/l1-contracts/src.ts/deploy-test-process.ts index 9c826ddc2..f6b0d00fb 100644 --- a/l1-contracts/src.ts/deploy-test-process.ts +++ b/l1-contracts/src.ts/deploy-test-process.ts @@ -15,7 +15,7 @@ import { L2_BOOTLOADER_BYTECODE_HASH, L2_DEFAULT_ACCOUNT_BYTECODE_HASH, initialBridgehubDeployment, - registerHyperchain, + registerZKChain, } from "./deploy-process"; import { deployTokens, getTokens } from "./deploy-token"; @@ -29,6 +29,7 @@ import { EMPTY_STRING_KECCAK, isCurrentNetworkLocal, ETH_ADDRESS_IN_CONTRACTS, + encodeNTVAssetId, } from "./utils"; import { diamondCut, getCurrentFacetCutsForAdd, facetCut, Action } from "./diamondCut"; import { CONTRACTS_GENESIS_PROTOCOL_VERSION } from "../test/unit_tests/utils"; @@ -50,6 +51,7 @@ export async function loadDefaultEnvVarsForTests(deployWallet: Wallet) { // process.env.CONTRACTS_SHARED_BRIDGE_UPGRADE_STORAGE_SWITCH = "1"; process.env.ETH_CLIENT_CHAIN_ID = (await deployWallet.getChainId()).toString(); process.env.CONTRACTS_ERA_CHAIN_ID = "270"; + process.env.CONTRACTS_L1_CHAIN_ID = "31337"; process.env.CONTRACTS_ERA_DIAMOND_PROXY_ADDR = ADDRESS_ONE; // CONTRACTS_ERA_DIAMOND_PROXY_ADDR; process.env.CONTRACTS_L2_SHARED_BRIDGE_ADDR = ADDRESS_ONE; @@ -67,6 +69,7 @@ export async function defaultDeployerForTests(deployWallet: Wallet, ownerAddress addresses: addressConfig, bootloaderBytecodeHash: L2_BOOTLOADER_BYTECODE_HASH, defaultAccountBytecodeHash: L2_DEFAULT_ACCOUNT_BYTECODE_HASH, + l1ChainId: process.env.CONTRACTS_L1_CHAIN_ID, }); } @@ -78,6 +81,7 @@ export async function defaultEraDeployerForTests(deployWallet: Wallet, ownerAddr addresses: addressConfig, bootloaderBytecodeHash: L2_BOOTLOADER_BYTECODE_HASH, defaultAccountBytecodeHash: L2_DEFAULT_ACCOUNT_BYTECODE_HASH, + l1ChainId: process.env.CONTRACTS_L1_CHAIN_ID, }); const l2_rpc_addr = "http://localhost:3050"; const web3Provider = new zkethers.Provider(l2_rpc_addr); @@ -106,12 +110,13 @@ export async function initialTestnetDeploymentProcess( // deploy the verifier first await initialBridgehubDeployment(deployer, extraFacets, gasPrice, true); await initialBridgehubDeployment(deployer, extraFacets, gasPrice, false); - await registerHyperchainWithBridgeRegistration(deployer, false, extraFacets, gasPrice, baseTokenName); + await registerZKChainWithBridgeRegistration(deployer, false, extraFacets, gasPrice, baseTokenName); await registerTestDAValidators(deployer); + return deployer; } -export async function registerHyperchainWithBridgeRegistration( +export async function registerZKChainWithBridgeRegistration( deployer: Deployer, onlyVerifier: boolean, extraFacets: FacetCut[], @@ -120,7 +125,7 @@ export async function registerHyperchainWithBridgeRegistration( chainId?: string ) { chainId = chainId ?? deployer.chainId.toString(); - await registerHyperchain(deployer, onlyVerifier, extraFacets, gasPrice, baseTokenName, chainId, true); + await registerZKChain(deployer, onlyVerifier, extraFacets, gasPrice, baseTokenName, chainId, true); await registerTestDAValidators(deployer); } @@ -135,7 +140,7 @@ async function registerTestDAValidators(deployer: Deployer) { ).wait(); } -// This is used to deploy the diamond and bridge such that they can be upgraded using UpgradeHyperchain.sol +// This is used to deploy the diamond and bridge such that they can be upgraded using UpgradeZKChain.sol // This should be deleted after the migration export async function initialPreUpgradeContractsDeployment( deployWallet: Wallet, @@ -181,8 +186,8 @@ export async function initialPreUpgradeContractsDeployment( // note we should also deploy the old ERC20Bridge here, but we can do that later. // // for Era we first deploy the DiamondProxy manually, set the vars manually, - // // and register it in the system via STM.registerAlreadyDeployedStateTransition and bridgehub.createNewChain(ERA_CHAIN_ID, ..) - // // note we just deploy the STM to get the storedBatchZero + // // and register it in the system via CTM.registerAlreadyDeployedStateTransition and bridgehub.createNewChain(ERA_CHAIN_ID, ..) + // // note we just deploy the CTM to get the storedBatchZero await deployer.deployDiamondProxy(extraFacets, {}); // we have to know the address of the diamond proxy in the mailbox so we separate the deployment @@ -192,7 +197,7 @@ export async function initialPreUpgradeContractsDeployment( ); await deployer.deployStateTransitionDiamondFacets(create2Salt); - await diamondAdminFacet.executeUpgradeNoOverlap(await deployer.upgradeZkSyncHyperchainDiamondCut()); + await diamondAdminFacet.executeUpgradeNoOverlap(await deployer.upgradeZKChainDiamondCut()); return deployer; } @@ -228,15 +233,9 @@ export async function initialEraTestnetDeploymentProcess( "DummyAdminFacetNoOverlap", deployer.addresses.StateTransition.DiamondProxy ); - await diamondAdminFacet.executeUpgradeNoOverlap(await deployer.upgradeZkSyncHyperchainDiamondCut()); - - const stateTransitionManager = deployer.stateTransitionManagerContract(deployer.deployWallet); - const registerData = stateTransitionManager.interface.encodeFunctionData("registerAlreadyDeployedHyperchain", [ - deployer.chainId, - deployer.addresses.StateTransition.DiamondProxy, - ]); - await deployer.executeUpgrade(deployer.addresses.StateTransition.StateTransitionProxy, 0, registerData); - await registerHyperchain(deployer, false, extraFacets, gasPrice, baseTokenName, deployer.chainId.toString(), true); + await diamondAdminFacet.executeUpgradeNoOverlap(await deployer.upgradeZKChainDiamondCut()); + + await registerZKChain(deployer, false, extraFacets, gasPrice, baseTokenName, deployer.chainId.toString(), true); return deployer; } @@ -279,7 +278,7 @@ export class EraDeployer extends Deployer { await tx.wait(); } - public async upgradeZkSyncHyperchainDiamondCut(extraFacets?: FacetCut[]) { + public async upgradeZKChainDiamondCut(extraFacets?: FacetCut[]) { let facetCuts: FacetCut[] = Object.values( await getCurrentFacetCutsForAdd( this.addresses.StateTransition.AdminFacet, @@ -331,11 +330,14 @@ export class EraDeployer extends Deployer { { chainId: this.chainId, // era chain Id bridgehub: this.addresses.Bridgehub.BridgehubProxy, - stateTransitionManager: this.addresses.StateTransition.StateTransitionProxy, + chainTypeManager: this.addresses.StateTransition.StateTransitionProxy, protocolVersion: CONTRACTS_GENESIS_PROTOCOL_VERSION, admin: this.ownerAddress, validatorTimelock: ADDRESS_ONE, - baseToken: ETH_ADDRESS_IN_CONTRACTS, + baseTokenAssetId: encodeNTVAssetId( + parseInt(process.env.CONTRACTS_L1_CHAIN_ID), + ethers.utils.hexZeroPad(ETH_ADDRESS_IN_CONTRACTS, 32) + ), baseTokenBridge: this.addresses.Bridges.SharedBridgeProxy, storedBatchZero, verifier: this.addresses.StateTransition.Verifier, diff --git a/l1-contracts/src.ts/deploy-utils-zk.ts b/l1-contracts/src.ts/deploy-utils-zk.ts index 98c5ad679..ec9b50a03 100644 --- a/l1-contracts/src.ts/deploy-utils-zk.ts +++ b/l1-contracts/src.ts/deploy-utils-zk.ts @@ -14,10 +14,18 @@ import { ethersWalletToZkWallet, readBytecode, readInterface } from "./utils"; export const BUILT_IN_ZKSYNC_CREATE2_FACTORY = "0x0000000000000000000000000000000000010000"; const contractsHome = process.env.ZKSYNC_HOME ? path.join(process.env.ZKSYNC_HOME as string, "contracts/") : "../"; -const contractArtifactsPath = path.join(contractsHome, "l2-contracts/artifacts-zk/"); -const openzeppelinBeaconProxyArtifactsPath = path.join(contractArtifactsPath, "@openzeppelin/contracts/proxy/beacon"); -export const BEACON_PROXY_BYTECODE = readBytecode(openzeppelinBeaconProxyArtifactsPath, "BeaconProxy"); -export const L2_SHARED_BRIDGE_PATH = contractArtifactsPath + "contracts/bridge"; +const contractArtifactsPath = path.join(contractsHome, "l1-contracts/artifacts-zk/"); +const openzeppelinBeaconProxyArtifactsPath = path.join( + contractArtifactsPath, + "@openzeppelin/contracts-v4/proxy/beacon" +); +const L2_SHARED_BRIDGE_PATH = contractArtifactsPath + "contracts/bridge"; +export const L2_STANDARD_ERC20_PROXY_FACTORY_BYTECODE = readBytecode( + openzeppelinBeaconProxyArtifactsPath, + "UpgradeableBeacon" +); +export const L2_STANDARD_ERC20_IMPLEMENTATION_BYTECODE = readBytecode(L2_SHARED_BRIDGE_PATH, "BridgedStandardERC20"); +export const L2_STANDARD_TOKEN_PROXY_BYTECODE = readBytecode(openzeppelinBeaconProxyArtifactsPath, "BeaconProxy"); export async function deployViaCreate2( deployWallet: ZkWallet, diff --git a/l1-contracts/src.ts/deploy-utils.ts b/l1-contracts/src.ts/deploy-utils.ts index 99d3232f0..d9e7264c1 100644 --- a/l1-contracts/src.ts/deploy-utils.ts +++ b/l1-contracts/src.ts/deploy-utils.ts @@ -3,7 +3,7 @@ import "@nomiclabs/hardhat-ethers"; import { ethers } from "ethers"; import { SingletonFactoryFactory } from "../typechain"; -import { getAddressFromEnv } from "./utils"; +import { encodeNTVAssetId, getAddressFromEnv, getNumberFromEnv } from "./utils"; export async function deployViaCreate2( deployWallet: ethers.Wallet, @@ -102,8 +102,8 @@ export interface DeployedAddresses { Bridgehub: { BridgehubProxy: string; BridgehubImplementation: string; - STMDeploymentTrackerImplementation: string; - STMDeploymentTrackerProxy: string; + CTMDeploymentTrackerImplementation: string; + CTMDeploymentTrackerProxy: string; MessageRootImplementation: string; MessageRootProxy: string; }; @@ -122,6 +122,8 @@ export interface DeployedAddresses { DiamondProxy: string; }; Bridges: { + L1NullifierImplementation: string; + L1NullifierProxy: string; ERC20BridgeImplementation: string; ERC20BridgeProxy: string; SharedBridgeImplementation: string; @@ -132,7 +134,10 @@ export interface DeployedAddresses { L2NativeTokenVaultProxy: string; NativeTokenVaultImplementation: string; NativeTokenVaultProxy: string; + BridgedStandardERC20Implementation: string; + BridgedTokenBeacon: string; }; + BaseTokenAssetId: string; BaseToken: string; TransparentProxyAdmin: string; L2ProxyAdmin: string; @@ -147,12 +152,21 @@ export interface DeployedAddresses { } export function deployedAddressesFromEnv(): DeployedAddresses { + let baseTokenAssetId = "0"; + try { + baseTokenAssetId = getAddressFromEnv("CONTRACTS_BASE_TOKEN_ASSET_ID"); + } catch (error) { + baseTokenAssetId = encodeNTVAssetId( + parseInt(getNumberFromEnv("ETH_CLIENT_CHAIN_ID")), + ethers.utils.hexZeroPad(getAddressFromEnv("CONTRACTS_BASE_TOKEN_ADDR"), 32) + ); + } return { Bridgehub: { BridgehubProxy: getAddressFromEnv("CONTRACTS_BRIDGEHUB_PROXY_ADDR"), BridgehubImplementation: getAddressFromEnv("CONTRACTS_BRIDGEHUB_IMPL_ADDR"), - STMDeploymentTrackerImplementation: getAddressFromEnv("CONTRACTS_STM_DEPLOYMENT_TRACKER_IMPL_ADDR"), - STMDeploymentTrackerProxy: getAddressFromEnv("CONTRACTS_STM_DEPLOYMENT_TRACKER_PROXY_ADDR"), + CTMDeploymentTrackerImplementation: getAddressFromEnv("CONTRACTS_CTM_DEPLOYMENT_TRACKER_IMPL_ADDR"), + CTMDeploymentTrackerProxy: getAddressFromEnv("CONTRACTS_CTM_DEPLOYMENT_TRACKER_PROXY_ADDR"), MessageRootImplementation: getAddressFromEnv("CONTRACTS_MESSAGE_ROOT_IMPL_ADDR"), MessageRootProxy: getAddressFromEnv("CONTRACTS_MESSAGE_ROOT_PROXY_ADDR"), }, @@ -171,6 +185,8 @@ export function deployedAddressesFromEnv(): DeployedAddresses { DiamondProxy: getAddressFromEnv("CONTRACTS_DIAMOND_PROXY_ADDR"), }, Bridges: { + L1NullifierImplementation: getAddressFromEnv("CONTRACTS_L1_NULLIFIER_IMPL_ADDR"), + L1NullifierProxy: getAddressFromEnv("CONTRACTS_L1_NULLIFIER_PROXY_ADDR"), ERC20BridgeImplementation: getAddressFromEnv("CONTRACTS_L1_ERC20_BRIDGE_IMPL_ADDR"), ERC20BridgeProxy: getAddressFromEnv("CONTRACTS_L1_ERC20_BRIDGE_PROXY_ADDR"), SharedBridgeImplementation: getAddressFromEnv("CONTRACTS_L1_SHARED_BRIDGE_IMPL_ADDR"), @@ -181,11 +197,14 @@ export function deployedAddressesFromEnv(): DeployedAddresses { L2SharedBridgeProxy: getAddressFromEnv("CONTRACTS_L2_SHARED_BRIDGE_ADDR"), NativeTokenVaultImplementation: getAddressFromEnv("CONTRACTS_L1_NATIVE_TOKEN_VAULT_IMPL_ADDR"), NativeTokenVaultProxy: getAddressFromEnv("CONTRACTS_L1_NATIVE_TOKEN_VAULT_PROXY_ADDR"), + BridgedStandardERC20Implementation: getAddressFromEnv("CONTRACTS_L1_BRIDGED_STANDARD_ERC20_IMPL_ADDR"), + BridgedTokenBeacon: getAddressFromEnv("CONTRACTS_L1_BRIDGED_TOKEN_BEACON_ADDR"), }, RollupL1DAValidator: getAddressFromEnv("CONTRACTS_L1_ROLLUP_DA_VALIDATOR"), ValidiumL1DAValidator: getAddressFromEnv("CONTRACTS_L1_VALIDIUM_DA_VALIDATOR"), RelayedSLDAValidator: getAddressFromEnv("CONTRACTS_L1_RELAYED_SL_DA_VALIDATOR"), BaseToken: getAddressFromEnv("CONTRACTS_BASE_TOKEN_ADDR"), + BaseTokenAssetId: baseTokenAssetId, TransparentProxyAdmin: getAddressFromEnv("CONTRACTS_TRANSPARENT_PROXY_ADMIN_ADDR"), L2ProxyAdmin: getAddressFromEnv("CONTRACTS_L2_PROXY_ADMIN_ADDR"), Create2Factory: getAddressFromEnv("CONTRACTS_CREATE2_FACTORY_ADDR"), diff --git a/l1-contracts/src.ts/deploy.ts b/l1-contracts/src.ts/deploy.ts index afae0dbc2..c75a46e1f 100644 --- a/l1-contracts/src.ts/deploy.ts +++ b/l1-contracts/src.ts/deploy.ts @@ -16,6 +16,9 @@ import { import { deployViaCreate2 as deployViaCreate2Zk, BUILT_IN_ZKSYNC_CREATE2_FACTORY, + L2_STANDARD_ERC20_PROXY_FACTORY_BYTECODE, + L2_STANDARD_ERC20_IMPLEMENTATION_BYTECODE, + L2_STANDARD_TOKEN_PROXY_BYTECODE, // deployBytecodeViaCreate2OnPath, // L2_SHARED_BRIDGE_PATH, } from "./deploy-utils-zk"; @@ -45,15 +48,16 @@ import { compileInitialCutHash, readBytecode, applyL1ToL2Alias, - // priorityTxMaxGasLimit, + BRIDGEHUB_CTM_ASSET_DATA_ABI_STRING, + encodeNTVAssetId, + L2_MESSAGE_ROOT_ADDRESS, } from "./utils"; import type { ChainAdminCall } from "./utils"; -import { IBridgehubFactory } from "../typechain/IBridgehubFactory"; import { IGovernanceFactory } from "../typechain/IGovernanceFactory"; import { ITransparentUpgradeableProxyFactory } from "../typechain/ITransparentUpgradeableProxyFactory"; import { ProxyAdminFactory } from "../typechain/ProxyAdminFactory"; -import { IZkSyncHyperchainFactory } from "../typechain/IZkSyncHyperchainFactory"; +import { IZKChainFactory } from "../typechain/IZKChainFactory"; import { L1AssetRouterFactory } from "../typechain/L1AssetRouterFactory"; import { SingletonFactoryFactory } from "../typechain/SingletonFactoryFactory"; @@ -62,12 +66,12 @@ import { ValidatorTimelockFactory } from "../typechain/ValidatorTimelockFactory" import type { FacetCut } from "./diamondCut"; import { getCurrentFacetCutsForAdd } from "./diamondCut"; -import { ChainAdminFactory, ERC20Factory, StateTransitionManagerFactory } from "../typechain"; +import { BridgehubFactory, ChainAdminFactory, ERC20Factory, ChainTypeManagerFactory } from "../typechain"; import { IL1AssetRouterFactory } from "../typechain/IL1AssetRouterFactory"; import { IL1NativeTokenVaultFactory } from "../typechain/IL1NativeTokenVaultFactory"; -import { ISTMDeploymentTrackerFactory } from "../typechain/ISTMDeploymentTrackerFactory"; - +import { IL1NullifierFactory } from "../typechain/IL1NullifierFactory"; +import { ICTMDeploymentTrackerFactory } from "../typechain/ICTMDeploymentTrackerFactory"; import { TestnetERC20TokenFactory } from "../typechain/TestnetERC20TokenFactory"; import { RollupL1DAValidatorFactory } from "../../da-contracts/typechain/RollupL1DAValidatorFactory"; @@ -85,6 +89,7 @@ export interface DeployerConfig { defaultAccountBytecodeHash?: string; deployedLogPrefix?: string; l1Deployer?: Deployer; + l1ChainId?: string; } export interface Operation { @@ -100,6 +105,7 @@ export class Deployer { public deployWallet: Wallet | ZkWallet; public verbose: boolean; public chainId: number; + public l1ChainId: number; public ownerAddress: string; public deployedLogPrefix: string; @@ -119,10 +125,11 @@ export class Deployer { : hexlify(hashL2Bytecode(readSystemContractsBytecode("DefaultAccount"))); this.ownerAddress = config.ownerAddress != null ? config.ownerAddress : this.deployWallet.address; this.chainId = parseInt(process.env.CHAIN_ETH_ZKSYNC_NETWORK_ID!); + this.l1ChainId = parseInt(config.l1ChainId || getNumberFromEnv("ETH_CLIENT_CHAIN_ID")); this.deployedLogPrefix = config.deployedLogPrefix ?? "CONTRACTS"; } - public async initialZkSyncHyperchainDiamondCut(extraFacets?: FacetCut[], compareDiamondCutHash: boolean = false) { + public async initialZkSyncZKChainDiamondCut(extraFacets?: FacetCut[], compareDiamondCutHash: boolean = false) { let facetCuts: FacetCut[] = Object.values( await getCurrentFacetCutsForAdd( this.addresses.StateTransition.AdminFacet, @@ -158,14 +165,14 @@ export class Deployer { ); console.log(`Diamond cut hash: ${hash}`); - const stm = StateTransitionManagerFactory.connect( + const ctm = ChainTypeManagerFactory.connect( this.addresses.StateTransition.StateTransitionProxy, this.deployWallet ); - const hashFromSTM = await stm.initialCutHash(); - if (hash != hashFromSTM) { - throw new Error(`Has from STM ${hashFromSTM} does not match the computed hash ${hash}`); + const hashFromCTM = await ctm.initialCutHash(); + if (hash != hashFromCTM) { + throw new Error(`Has from CTM ${hashFromCTM} does not match the computed hash ${hash}`); } } @@ -177,12 +184,14 @@ export class Deployer { let assetRouterZKBytecode = ethers.constants.HashZero; let nativeTokenVaultZKBytecode = ethers.constants.HashZero; let l2TokenProxyBytecodeHash = ethers.constants.HashZero; + let messageRootZKBytecode = ethers.constants.HashZero; if (process.env.CHAIN_ETH_NETWORK != "hardhat") { bridgehubZKBytecode = readBytecode("./artifacts-zk/contracts/bridgehub", "Bridgehub"); - assetRouterZKBytecode = readBytecode("../l2-contracts/artifacts-zk/contracts/bridge", "L2AssetRouter"); - nativeTokenVaultZKBytecode = readBytecode("../l2-contracts/artifacts-zk/contracts/bridge", "L2NativeTokenVault"); + assetRouterZKBytecode = readBytecode("./artifacts-zk/contracts/bridge/asset-router", "L2AssetRouter"); + nativeTokenVaultZKBytecode = readBytecode("./artifacts-zk/contracts/bridge/ntv", "L2NativeTokenVault"); + messageRootZKBytecode = readBytecode("./artifacts-zk/contracts/bridgehub", "MessageRoot"); const l2TokenProxyBytecode = readBytecode( - "../l2-contracts/artifacts-zk/@openzeppelin/contracts/proxy/beacon", + "./artifacts-zk/@openzeppelin/contracts-v4/proxy/beacon", "BeaconProxy" ); l2TokenProxyBytecodeHash = ethers.utils.hexlify(hashL2Bytecode(l2TokenProxyBytecode)); @@ -194,8 +203,12 @@ export class Deployer { callConstructor: true, value: 0, input: ethers.utils.defaultAbiCoder.encode( - ["uint256", "address"], - [getNumberFromEnv("ETH_CLIENT_CHAIN_ID"), applyL1ToL2Alias(this.addresses.Governance)] + ["uint256", "address", "uint256"], + [ + getNumberFromEnv("ETH_CLIENT_CHAIN_ID"), + applyL1ToL2Alias(this.addresses.Governance), + getNumberFromEnv("CONTRACTS_MAX_NUMBER_OF_ZK_CHAINS"), + ] ), }; const eraChainId = getNumberFromEnv("CONTRACTS_ERA_CHAIN_ID"); @@ -206,21 +219,38 @@ export class Deployer { value: 0, input: ethers.utils.defaultAbiCoder.encode( ["uint256", "uint256", "address", "address"], - [eraChainId, getNumberFromEnv("ETH_CLIENT_CHAIN_ID"), this.addresses.Bridges.SharedBridgeProxy, ADDRESS_ONE] + [getNumberFromEnv("ETH_CLIENT_CHAIN_ID"), eraChainId, this.addresses.Bridges.SharedBridgeProxy, ADDRESS_ONE] ), }; + const tokens = getTokens(); + const l1WethToken = tokens.find((token: { symbol: string }) => token.symbol == "WETH")!.address; const ntvDeployment = { bytecodeHash: ethers.utils.hexlify(hashL2Bytecode(nativeTokenVaultZKBytecode)), newAddress: L2_NATIVE_TOKEN_VAULT_ADDRESS, callConstructor: true, value: 0, input: ethers.utils.defaultAbiCoder.encode( - ["bytes32", "address"], - [l2TokenProxyBytecodeHash, this.addresses.Governance] + ["uint256", "address", "bytes32", "address", "address", "bool", "address"], + [ + getNumberFromEnv("ETH_CLIENT_CHAIN_ID"), + applyL1ToL2Alias(this.addresses.Governance), + l2TokenProxyBytecodeHash, + ethers.constants.AddressZero, + ethers.constants.AddressZero, + false, + l1WethToken, + ] ), }; + const messageRootDeployment = { + bytecodeHash: ethers.utils.hexlify(hashL2Bytecode(messageRootZKBytecode)), + newAddress: L2_MESSAGE_ROOT_ADDRESS, + callConstructor: true, + value: 0, + input: ethers.utils.defaultAbiCoder.encode(["address"], [L2_BRIDGEHUB_ADDRESS]), + }; - const forceDeployments = [bridgehubDeployment, assetRouterDeployment, ntvDeployment]; + const forceDeployments = [messageRootDeployment, bridgehubDeployment, assetRouterDeployment, ntvDeployment]; return ethers.utils.defaultAbiCoder.encode([FORCE_DEPLOYMENT_ABI_STRING], [forceDeployments]); } @@ -353,9 +383,21 @@ export class Deployer { public async deployChainAdmin(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { ethTxOptions.gasLimit ??= 10_000_000; + // Firstly, we deploy the access control restriction for the chain admin + const accessControlRestriction = await this.deployViaCreate2( + "AccessControlRestriction", + [0, this.ownerAddress], + create2Salt, + ethTxOptions + ); + if (this.verbose) { + console.log(`CONTRACTS_ACCESS_CONTROL_RESTRICTION_ADDR=${accessControlRestriction}`); + } + + // Then we deploy the ChainAdmin contract itself const contractAddress = await this.deployViaCreate2( "ChainAdmin", - [this.ownerAddress, ethers.constants.AddressZero], + [[accessControlRestriction]], create2Salt, ethTxOptions ); @@ -376,25 +418,33 @@ export class Deployer { if (this.isZkMode()) { // @ts-ignore // TODO try to make it work with zksync ethers - const artifact = hardhat.artifacts.readArtifactSync("ProxyAdmin"); const zkWal = this.deployWallet as ZkWallet; - const contractFactory = new ZkContractFactory(artifact.abi, artifact.bytecode, zkWal); + // FIXME: this is a hack + const tmpContractFactory = await hardhat.ethers.getContractFactory( + "@openzeppelin/contracts-v4/proxy/transparent/ProxyAdmin.sol:ProxyAdmin", + { + signer: this.deployWallet, + } + ); + const contractFactory = new ZkContractFactory(tmpContractFactory.interface, tmpContractFactory.bytecode, zkWal); proxyAdmin = await contractFactory.deploy(...[ethTxOptions]); rec = await proxyAdmin.deployTransaction.wait(); } else { ethTxOptions.gasLimit ??= 10_000_000; - const contractFactory = await hardhat.ethers.getContractFactory("ProxyAdmin", { - signer: this.deployWallet, - }); + const contractFactory = await hardhat.ethers.getContractFactory( + "@openzeppelin/contracts-v4/proxy/transparent/ProxyAdmin.sol:ProxyAdmin", + { + signer: this.deployWallet, + } + ); proxyAdmin = await contractFactory.deploy(...[ethTxOptions]); rec = await proxyAdmin.deployTransaction.wait(); } if (this.verbose) { console.log( - `Proxy admin deployed, gasUsed: ${rec.gasUsed.toString()}, tx hash ${rec.transactionHash}, expected address: ${ - proxyAdmin.address - }` + `Proxy admin deployed, gasUsed: ${rec.gasUsed.toString()}, tx hash ${rec.transactionHash}, expected address: + ${proxyAdmin.address}` ); console.log(`CONTRACTS_TRANSPARENT_PROXY_ADMIN_ADDR=${proxyAdmin.address}`); } @@ -406,18 +456,16 @@ export class Deployer { if (this.verbose) { console.log( - `ProxyAdmin ownership transferred to Governance in tx ${ - receipt.transactionHash - }, gas used: ${receipt.gasUsed.toString()}` + `ProxyAdmin ownership transferred to Governance in tx + ${receipt.transactionHash}, gas used: ${receipt.gasUsed.toString()}` ); } } public async deployBridgehubImplementation(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { - const l1ChainId = this.isZkMode() ? getNumberFromEnv("ETH_CLIENT_CHAIN_ID") : await this.deployWallet.getChainId(); const contractAddress = await this.deployViaCreate2( "Bridgehub", - [l1ChainId, this.addresses.Governance], + [await this.getL1ChainId(), this.addresses.Governance, getNumberFromEnv("CONTRACTS_MAX_NUMBER_OF_ZK_CHAINS")], create2Salt, ethTxOptions ); @@ -482,13 +530,13 @@ export class Deployer { this.addresses.Bridgehub.MessageRootProxy = contractAddress; } - public async deployStateTransitionManagerImplementation( + public async deployChainTypeManagerImplementation( create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest ) { const contractAddress = await this.deployViaCreate2( - "StateTransitionManager", - [this.addresses.Bridgehub.BridgehubProxy, getNumberFromEnv("CONTRACTS_MAX_NUMBER_OF_HYPERCHAINS")], + "ChainTypeManager", + [this.addresses.Bridgehub.BridgehubProxy], create2Salt, { ...ethTxOptions, @@ -503,7 +551,7 @@ export class Deployer { this.addresses.StateTransition.StateTransitionImplementation = contractAddress; } - public async deployStateTransitionManagerProxy( + public async deployChainTypeManagerProxy( create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest, extraFacets?: FacetCut[] @@ -511,10 +559,10 @@ export class Deployer { const genesisBatchHash = getHashFromEnv("CONTRACTS_GENESIS_ROOT"); // TODO: confusing name const genesisRollupLeafIndex = getNumberFromEnv("CONTRACTS_GENESIS_ROLLUP_LEAF_INDEX"); const genesisBatchCommitment = getHashFromEnv("CONTRACTS_GENESIS_BATCH_COMMITMENT"); - const diamondCut = await this.initialZkSyncHyperchainDiamondCut(extraFacets); + const diamondCut = await this.initialZkSyncZKChainDiamondCut(extraFacets); const protocolVersion = packSemver(...unpackStringSemVer(process.env.CONTRACTS_GENESIS_PROTOCOL_SEMANTIC_VERSION)); - const stateTransitionManager = new Interface(hardhat.artifacts.readArtifactSync("StateTransitionManager").abi); + const chainTypeManager = new Interface(hardhat.artifacts.readArtifactSync("ChainTypeManager").abi); const forceDeploymentsData = await this.genesisForceDeploymentsData(); const chainCreationParams = { genesisUpgrade: this.addresses.StateTransition.GenesisUpgrade, @@ -525,7 +573,7 @@ export class Deployer { forceDeploymentsData, }; - const initCalldata = stateTransitionManager.encodeFunctionData("initialize", [ + const initCalldata = chainTypeManager.encodeFunctionData("initialize", [ { owner: this.addresses.Governance, validatorTimelock: this.addresses.ValidatorTimeLock, @@ -546,7 +594,7 @@ export class Deployer { ); if (this.verbose) { - console.log(`StateTransitionManagerProxy deployed, with protocol version: ${protocolVersion}`); + console.log(`ChainTypeManagerProxy deployed, with protocol version: ${protocolVersion}`); console.log(`CONTRACTS_STATE_TRANSITION_PROXY_ADDR=${contractAddress}`); } @@ -554,7 +602,12 @@ export class Deployer { } public async deployAdminFacet(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { - const contractAddress = await this.deployViaCreate2("AdminFacet", [], create2Salt, ethTxOptions); + const contractAddress = await this.deployViaCreate2( + "AdminFacet", + [await this.getL1ChainId()], + create2Salt, + ethTxOptions + ); if (this.verbose) { console.log(`CONTRACTS_ADMIN_FACET_ADDR=${contractAddress}`); @@ -565,7 +618,12 @@ export class Deployer { public async deployMailboxFacet(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { const eraChainId = getNumberFromEnv("CONTRACTS_ERA_CHAIN_ID"); - const contractAddress = await this.deployViaCreate2("MailboxFacet", [eraChainId], create2Salt, ethTxOptions); + const contractAddress = await this.deployViaCreate2( + "MailboxFacet", + [eraChainId, await this.getL1ChainId()], + create2Salt, + ethTxOptions + ); if (this.verbose) { console.log(`Mailbox deployed with era chain id: ${eraChainId}`); @@ -619,7 +677,12 @@ export class Deployer { const eraChainId = getNumberFromEnv("CONTRACTS_ERA_CHAIN_ID"); const contractAddress = await this.deployViaCreate2( dummy ? "DummyL1ERC20Bridge" : "L1ERC20Bridge", - [this.addresses.Bridges.SharedBridgeProxy, this.addresses.Bridges.NativeTokenVaultProxy, eraChainId], + [ + this.addresses.Bridges.L1NullifierProxy, + this.addresses.Bridges.SharedBridgeProxy, + this.addresses.Bridges.NativeTokenVaultProxy, + eraChainId, + ], create2Salt, ethTxOptions ); @@ -780,6 +843,44 @@ export class Deployer { this.addresses.Bridges.ERC20BridgeProxy = contractAddress; } + public async deployL1NullifierImplementation(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { + // const tokens = getTokens(); + // const l1WethToken = tokens.find((token: { symbol: string }) => token.symbol == "WETH")!.address; + const eraChainId = getNumberFromEnv("CONTRACTS_ERA_CHAIN_ID"); + const eraDiamondProxy = getAddressFromEnv("CONTRACTS_ERA_DIAMOND_PROXY_ADDR"); + const contractAddress = await this.deployViaCreate2( + "L1Nullifier", + [this.addresses.Bridgehub.BridgehubProxy, eraChainId, eraDiamondProxy], + create2Salt, + ethTxOptions + ); + + if (this.verbose) { + console.log(`CONTRACTS_L1_NULLIFIER_IMPL_ADDR=${contractAddress}`); + } + + this.addresses.Bridges.L1NullifierImplementation = contractAddress; + } + + public async deployL1NullifierProxy(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { + const initCalldata = new Interface(hardhat.artifacts.readArtifactSync("L1Nullifier").abi).encodeFunctionData( + "initialize", + [this.addresses.Governance, 1, 1, 1, 0] + ); + const contractAddress = await this.deployViaCreate2( + "TransparentUpgradeableProxy", + [this.addresses.Bridges.L1NullifierImplementation, this.addresses.TransparentProxyAdmin, initCalldata], + create2Salt, + ethTxOptions + ); + + if (this.verbose) { + console.log(`CONTRACTS_L1_NULLIFIER_PROXY_ADDR=${contractAddress}`); + } + + this.addresses.Bridges.L1NullifierProxy = contractAddress; + } + public async deploySharedBridgeImplementation( create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest @@ -790,7 +891,13 @@ export class Deployer { const eraDiamondProxy = getAddressFromEnv("CONTRACTS_ERA_DIAMOND_PROXY_ADDR"); const contractAddress = await this.deployViaCreate2( "L1AssetRouter", - [l1WethToken, this.addresses.Bridgehub.BridgehubProxy, eraChainId, eraDiamondProxy], + [ + l1WethToken, + this.addresses.Bridgehub.BridgehubProxy, + this.addresses.Bridges.L1NullifierProxy, + eraChainId, + eraDiamondProxy, + ], create2Salt, ethTxOptions ); @@ -806,7 +913,7 @@ export class Deployer { public async deploySharedBridgeProxy(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { const initCalldata = new Interface(hardhat.artifacts.readArtifactSync("L1AssetRouter").abi).encodeFunctionData( "initialize", - [this.addresses.Governance, 1, 1, 1, 0] + [this.addresses.Governance] ); const contractAddress = await this.deployViaCreate2( "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol:TransparentUpgradeableProxy", @@ -822,17 +929,54 @@ export class Deployer { this.addresses.Bridges.SharedBridgeProxy = contractAddress; } + public async deployBridgedStandardERC20Implementation( + create2Salt: string, + ethTxOptions: ethers.providers.TransactionRequest + ) { + const contractAddress = await this.deployViaCreate2("BridgedStandardERC20", [], create2Salt, ethTxOptions); + + if (this.verbose) { + // console.log(`With era chain id ${eraChainId}`); + console.log(`CONTRACTS_L1_BRIDGED_STANDARD_ERC20_IMPL_ADDR=${contractAddress}`); + } + + this.addresses.Bridges.BridgedStandardERC20Implementation = contractAddress; + } + + public async deployBridgedTokenBeacon(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { + /// Note we cannot use create2 as the deployer is the owner. + ethTxOptions.gasLimit ??= 10_000_000; + const contractFactory = await hardhat.ethers.getContractFactory( + "@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol:UpgradeableBeacon", + { + signer: this.deployWallet, + } + ); + const beacon = await contractFactory.deploy( + ...[this.addresses.Bridges.BridgedStandardERC20Implementation, ethTxOptions] + ); + const rec = await beacon.deployTransaction.wait(); + + if (this.verbose) { + console.log("Beacon deployed with tx hash", rec.transactionHash); + console.log(`CONTRACTS_L1_BRIDGED_TOKEN_BEACON_ADDR=${beacon.address}`); + } + + this.addresses.Bridges.BridgedTokenBeacon = beacon.address; + + await beacon.transferOwnership(this.addresses.Governance); + } + public async deployNativeTokenVaultImplementation( create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest ) { - // const eraChainId = getNumberFromEnv("CONTRACTS_ERA_CHAIN_ID"); + const eraChainId = getNumberFromEnv("CONTRACTS_ERA_CHAIN_ID"); const tokens = getTokens(); const l1WethToken = tokens.find((token: { symbol: string }) => token.symbol == "WETH")!.address; - const contractAddress = await this.deployViaCreate2( "L1NativeTokenVault", - [l1WethToken, this.addresses.Bridges.SharedBridgeProxy], + [l1WethToken, this.addresses.Bridges.SharedBridgeProxy, eraChainId, this.addresses.Bridges.L1NullifierProxy], create2Salt, ethTxOptions ); @@ -848,7 +992,7 @@ export class Deployer { public async deployNativeTokenVaultProxy(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { const initCalldata = new Interface(hardhat.artifacts.readArtifactSync("L1NativeTokenVault").abi).encodeFunctionData( "initialize", - [this.addresses.Governance] + [this.addresses.Governance, this.addresses.Bridges.BridgedTokenBeacon] ); const contractAddress = await this.deployViaCreate2( "TransparentUpgradeableProxy", @@ -863,58 +1007,78 @@ export class Deployer { this.addresses.Bridges.NativeTokenVaultProxy = contractAddress; - const sharedBridge = this.defaultSharedBridge(this.deployWallet); - const data = await sharedBridge.interface.encodeFunctionData("setNativeTokenVault", [ + const nullifier = this.l1NullifierContract(this.deployWallet); + const assetRouter = this.defaultSharedBridge(this.deployWallet); + + const data = await assetRouter.interface.encodeFunctionData("setNativeTokenVault", [ this.addresses.Bridges.NativeTokenVaultProxy, ]); await this.executeUpgrade(this.addresses.Bridges.SharedBridgeProxy, 0, data); if (this.verbose) { console.log("Native token vault set in shared bridge"); } + + const data2 = await nullifier.interface.encodeFunctionData("setL1NativeTokenVault", [ + this.addresses.Bridges.NativeTokenVaultProxy, + ]); + await this.executeUpgrade(this.addresses.Bridges.L1NullifierProxy, 0, data2); + if (this.verbose) { + console.log("Native token vault set in nullifier"); + } + + const data3 = await nullifier.interface.encodeFunctionData("setL1AssetRouter", [ + this.addresses.Bridges.SharedBridgeProxy, + ]); + await this.executeUpgrade(this.addresses.Bridges.L1NullifierProxy, 0, data3); + if (this.verbose) { + console.log("Asset router set in nullifier"); + } + + await (await this.nativeTokenVault(this.deployWallet).registerEthToken()).wait(); } - public async deploySTMDeploymentTrackerImplementation( + public async deployCTMDeploymentTrackerImplementation( create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest ) { const contractAddress = await this.deployViaCreate2( - "STMDeploymentTracker", + "CTMDeploymentTracker", [this.addresses.Bridgehub.BridgehubProxy, this.addresses.Bridges.SharedBridgeProxy], create2Salt, ethTxOptions ); if (this.verbose) { - console.log(`CONTRACTS_STM_DEPLOYMENT_TRACKER_IMPL_ADDR=${contractAddress}`); + console.log(`CONTRACTS_CTM_DEPLOYMENT_TRACKER_IMPL_ADDR=${contractAddress}`); } - this.addresses.Bridgehub.STMDeploymentTrackerImplementation = contractAddress; + this.addresses.Bridgehub.CTMDeploymentTrackerImplementation = contractAddress; } - public async deploySTMDeploymentTrackerProxy(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { + public async deployCTMDeploymentTrackerProxy(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { const initCalldata = new Interface( - hardhat.artifacts.readArtifactSync("STMDeploymentTracker").abi + hardhat.artifacts.readArtifactSync("CTMDeploymentTracker").abi ).encodeFunctionData("initialize", [this.addresses.Governance]); const contractAddress = await this.deployViaCreate2( "TransparentUpgradeableProxy", - [this.addresses.Bridgehub.STMDeploymentTrackerImplementation, this.addresses.TransparentProxyAdmin, initCalldata], + [this.addresses.Bridgehub.CTMDeploymentTrackerImplementation, this.addresses.TransparentProxyAdmin, initCalldata], create2Salt, ethTxOptions ); if (this.verbose) { - console.log(`CONTRACTS_STM_DEPLOYMENT_TRACKER_PROXY_ADDR=${contractAddress}`); + console.log(`CONTRACTS_CTM_DEPLOYMENT_TRACKER_PROXY_ADDR=${contractAddress}`); } - this.addresses.Bridgehub.STMDeploymentTrackerProxy = contractAddress; + this.addresses.Bridgehub.CTMDeploymentTrackerProxy = contractAddress; // const bridgehub = this.bridgehubContract(this.deployWallet); - // const data0 = bridgehub.interface.encodeFunctionData("setSTMDeployer", [ - // this.addresses.Bridgehub.STMDeploymentTrackerProxy, + // const data0 = bridgehub.interface.encodeFunctionData("setCTMDeployer", [ + // this.addresses.Bridgehub.CTMDeploymentTrackerProxy, // ]); // await this.executeUpgrade(this.addresses.Bridgehub.BridgehubProxy, 0, data0); // if (this.verbose) { - // console.log("STM DT registered in Bridgehub"); + // console.log("CTM DT registered in Bridgehub"); // } } @@ -933,19 +1097,28 @@ export class Deployer { const upgradeData1 = await bridgehub.interface.encodeFunctionData("setAddresses", [ this.addresses.Bridges.SharedBridgeProxy, - this.addresses.Bridgehub.STMDeploymentTrackerProxy, + this.addresses.Bridgehub.CTMDeploymentTrackerProxy, this.addresses.Bridgehub.MessageRootProxy, ]); await this.executeUpgrade(this.addresses.Bridgehub.BridgehubProxy, 0, upgradeData1); if (this.verbose) { console.log("Shared bridge was registered in Bridgehub"); } + } + + public async registerTokenBridgehub(tokenAddress: string, useGovernance: boolean = false) { + const bridgehub = this.bridgehubContract(this.deployWallet); + const baseTokenAssetId = encodeNTVAssetId(this.l1ChainId, tokenAddress); + const receipt = await this.executeDirectOrGovernance( + useGovernance, + bridgehub, + "addTokenAssetId", + [baseTokenAssetId], + 0 + ); - /// registering ETH as a valid token, with address 1. - const upgradeData2 = bridgehub.interface.encodeFunctionData("addToken", [ADDRESS_ONE]); - await this.executeUpgrade(this.addresses.Bridgehub.BridgehubProxy, 0, upgradeData2); if (this.verbose) { - console.log("ETH token registered in Bridgehub"); + console.log(`Token ${tokenAddress} was registered, gas used: ${receipt.gasUsed.toString()}`); } } @@ -955,7 +1128,7 @@ export class Deployer { const data = nativeTokenVault.interface.encodeFunctionData("registerToken", [token]); await this.executeUpgrade(this.addresses.Bridges.NativeTokenVaultProxy, 0, data); if (this.verbose) { - console.log("Native token vault registered with ETH"); + console.log("Native token vault registered with token", token); } } @@ -982,11 +1155,11 @@ export class Deployer { this.addresses.StateTransition.DefaultUpgrade = contractAddress; } - public async deployHyperchainsUpgrade(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { - const contractAddress = await this.deployViaCreate2("UpgradeHyperchains", [], create2Salt, ethTxOptions); + public async deployZKChainsUpgrade(create2Salt: string, ethTxOptions: ethers.providers.TransactionRequest) { + const contractAddress = await this.deployViaCreate2("UpgradeZKChains", [], create2Salt, ethTxOptions); if (this.verbose) { - console.log(`CONTRACTS_HYPERCHAIN_UPGRADE_ADDR=${contractAddress}`); + console.log(`CONTRACTS_ZK_CHAIN_UPGRADE_ADDR=${contractAddress}`); } this.addresses.StateTransition.DefaultUpgrade = contractAddress; @@ -1011,18 +1184,17 @@ export class Deployer { await this.deployMessageRootProxy(create2Salt, { gasPrice }); } - public async deployStateTransitionManagerContract( + public async deployChainTypeManagerContract( create2Salt: string, extraFacets?: FacetCut[], gasPrice?: BigNumberish, nonce? ) { nonce = nonce ? parseInt(nonce) : await this.deployWallet.getTransactionCount(); - await this.deployStateTransitionDiamondFacets(create2Salt, gasPrice, nonce); - await this.deployStateTransitionManagerImplementation(create2Salt, { gasPrice }); - await this.deployStateTransitionManagerProxy(create2Salt, { gasPrice }, extraFacets); - await this.registerStateTransitionManager(); + await this.deployChainTypeManagerImplementation(create2Salt, { gasPrice }); + await this.deployChainTypeManagerProxy(create2Salt, { gasPrice }, extraFacets); + await this.registerChainTypeManager(); } public async deployStateTransitionDiamondFacets(create2Salt: string, gasPrice?: BigNumberish, nonce?) { @@ -1035,11 +1207,11 @@ export class Deployer { await this.deployStateTransitionDiamondInit(create2Salt, { gasPrice, nonce: nonce + 4 }); } - public async registerStateTransitionManager() { + public async registerChainTypeManager() { const bridgehub = this.bridgehubContract(this.deployWallet); - if (!(await bridgehub.stateTransitionManagerIsRegistered(this.addresses.StateTransition.StateTransitionProxy))) { - const upgradeData = bridgehub.interface.encodeFunctionData("addStateTransitionManager", [ + if (!(await bridgehub.chainTypeManagerIsRegistered(this.addresses.StateTransition.StateTransitionProxy))) { + const upgradeData = bridgehub.interface.encodeFunctionData("addChainTypeManager", [ this.addresses.StateTransition.StateTransitionProxy, ]); @@ -1049,46 +1221,52 @@ export class Deployer { if (this.verbose) { console.log(`StateTransition System registered, gas used: ${receipt1.gasUsed.toString()}`); } - } - const stmDeploymentTracker = this.stmDeploymentTracker(this.deployWallet); + const ctmDeploymentTracker = this.ctmDeploymentTracker(this.deployWallet); - const l1AssetRouter = this.defaultSharedBridge(this.deployWallet); - const whitelistData = l1AssetRouter.interface.encodeFunctionData("setAssetDeploymentTracker", [ - ethers.utils.hexZeroPad(this.addresses.StateTransition.StateTransitionProxy, 32), - stmDeploymentTracker.address, - ]); - const receipt2 = await this.executeUpgrade(l1AssetRouter.address, 0, whitelistData); - if (this.verbose) { - console.log("STM deployment tracker whitelisted in L1 Shared Bridge", receipt2.gasUsed.toString()); - console.log( - `CONTRACTS_STM_ASSET_INFO=${await bridgehub.stmAssetId(this.addresses.StateTransition.StateTransitionProxy)}` - ); - } + const l1AssetRouter = this.defaultSharedBridge(this.deployWallet); + const whitelistData = l1AssetRouter.interface.encodeFunctionData("setAssetDeploymentTracker", [ + ethers.utils.hexZeroPad(this.addresses.StateTransition.StateTransitionProxy, 32), + ctmDeploymentTracker.address, + ]); + const receipt2 = await this.executeUpgrade(l1AssetRouter.address, 0, whitelistData); + if (this.verbose) { + console.log("CTM deployment tracker whitelisted in L1 Shared Bridge", receipt2.gasUsed.toString()); + console.log( + `CONTRACTS_CTM_ASSET_INFO=${await bridgehub.ctmAssetId(this.addresses.StateTransition.StateTransitionProxy)}` + ); + } - const data1 = stmDeploymentTracker.interface.encodeFunctionData("registerSTMAssetOnL1", [ - this.addresses.StateTransition.StateTransitionProxy, - ]); - const receipt3 = await this.executeUpgrade(this.addresses.Bridgehub.STMDeploymentTrackerProxy, 0, data1); - if (this.verbose) { - console.log("STM asset registered in L1 Shared Bridge via STM Deployment Tracker", receipt3.gasUsed.toString()); - console.log( - `CONTRACTS_STM_ASSET_INFO=${await bridgehub.stmAssetId(this.addresses.StateTransition.StateTransitionProxy)}` - ); + const data1 = ctmDeploymentTracker.interface.encodeFunctionData("registerCTMAssetOnL1", [ + this.addresses.StateTransition.StateTransitionProxy, + ]); + const receipt3 = await this.executeUpgrade(this.addresses.Bridgehub.CTMDeploymentTrackerProxy, 0, data1); + if (this.verbose) { + console.log( + "CTM asset registered in L1 Shared Bridge via CTM Deployment Tracker", + receipt3.gasUsed.toString() + ); + console.log( + `CONTRACTS_CTM_ASSET_INFO=${await bridgehub.ctmAssetId(this.addresses.StateTransition.StateTransitionProxy)}` + ); + } } } } public async registerSettlementLayer() { - const stm = this.stateTransitionManagerContract(this.deployWallet); - const calldata = stm.interface.encodeFunctionData("registerSettlementLayer", [this.chainId, true]); - await this.executeUpgrade(this.addresses.StateTransition.StateTransitionProxy, 0, calldata); + const bridgehub = this.bridgehubContract(this.deployWallet); + const calldata = bridgehub.interface.encodeFunctionData("registerSettlementLayer", [this.chainId, true]); + await this.executeUpgrade(this.addresses.Bridgehub.BridgehubProxy, 0, calldata); if (this.verbose) { console.log("Gateway registered"); } } + // Main function to move the current chain (that is hooked to l1), on top of the syncLayer chain. public async moveChainToGateway(gatewayChainId: string, gasPrice: BigNumberish) { + const protocolVersion = packSemver(...unpackStringSemVer(process.env.CONTRACTS_GENESIS_PROTOCOL_SEMANTIC_VERSION)); + const chainData = ethers.utils.defaultAbiCoder.encode(["uint256"], [protocolVersion]); const bridgehub = this.bridgehubContract(this.deployWallet); // Just some large gas limit that should always be enough const l2GasLimit = ethers.BigNumber.from(72_000_000); @@ -1096,30 +1274,41 @@ export class Deployer { await bridgehub.l2TransactionBaseCost(gatewayChainId, gasPrice, l2GasLimit, REQUIRED_L2_GAS_PRICE_PER_PUBDATA) ).mul(5); + // We are creating the new DiamondProxy for our chain, to be deployed on top of sync Layer. const newAdmin = this.deployWallet.address; - const diamondCutData = await this.initialZkSyncHyperchainDiamondCut(); + const diamondCutData = await this.initialZkSyncZKChainDiamondCut(); const initialDiamondCut = new ethers.utils.AbiCoder().encode([DIAMOND_CUT_DATA_ABI_STRING], [diamondCutData]); - const stmData = new ethers.utils.AbiCoder().encode(["uint256", "bytes"], [newAdmin, initialDiamondCut]); - const chainData = new ethers.utils.AbiCoder().encode(["uint256"], [ADDRESS_ONE]); // empty for now + const ctmData = new ethers.utils.AbiCoder().encode(["uint256", "bytes"], [newAdmin, initialDiamondCut]); const bridgehubData = new ethers.utils.AbiCoder().encode( - ["uint256", "bytes", "bytes"], - [this.chainId, stmData, chainData] + [BRIDGEHUB_CTM_ASSET_DATA_ABI_STRING], + [[this.chainId, ctmData, chainData]] ); // console.log("bridgehubData", bridgehubData) // console.log("this.addresses.ChainAssetInfo", this.addresses.ChainAssetInfo) + + // The ctmAssetIFromChainId gives us a unique 'asset' identifier for a given chain. + const chainAssetId = await bridgehub.ctmAssetIdFromChainId(this.chainId); + if (this.verbose) { + console.log("Chain asset id is: ", chainAssetId); + } + let sharedBridgeData = ethers.utils.defaultAbiCoder.encode( ["bytes32", "bytes"], - [await bridgehub.stmAssetIdFromChainId(this.chainId), bridgehubData] + [chainAssetId, bridgehubData] ); + // The 0x01 is the encoding for the L1AssetRouter. sharedBridgeData = "0x01" + sharedBridgeData.slice(2); + // And now we 'transfer' the chain through the bridge (it behaves like a 'regular' asset, where we 'freeze' it in L1 + // and then create on SyncLayer). You can see these methods in Admin.sol (part of DiamondProxy). const receipt = await this.executeChainAdminMulticall([ { target: bridgehub.address, data: bridgehub.interface.encodeFunctionData("requestL2TransactionTwoBridges", [ + // These arguments must match L2TransactionRequestTwoBridgesOuter struct. { chainId: gatewayChainId, mintValue: expectedCost, @@ -1140,7 +1329,7 @@ export class Deployer { } public async finishMoveChainToL1(synclayerChainId: number) { - const sharedBridge = this.defaultSharedBridge(this.deployWallet); + const nullifier = this.l1NullifierContract(this.deployWallet); // const baseTokenAmount = ethers.utils.parseEther("1"); // const chainData = new ethers.utils.AbiCoder().encode(["uint256", "bytes"], [ADDRESS_ONE, "0x"]); // todo // const bridgehubData = new ethers.utils.AbiCoder().encode(["uint256", "bytes"], [this.chainId, chainData]); @@ -1149,14 +1338,14 @@ export class Deployer { // const sharedBridgeData = ethers.utils.defaultAbiCoder.encode( // ["bytes32", "bytes"], - // [await bridgehub.stmAssetInfoFromChainId(this.chainId), bridgehubData] + // [await bridgehub.ctmAssetInfoFromChainId(this.chainId), bridgehubData] // ); const l2BatchNumber = 1; const l2MsgIndex = 1; const l2TxNumberInBatch = 1; const message = ethers.utils.defaultAbiCoder.encode(["bytes32", "bytes"], []); const merkleProof = ["0x00"]; - const tx = await sharedBridge.finalizeWithdrawal( + const tx = await nullifier.finalizeWithdrawal( synclayerChainId, l2BatchNumber, l2MsgIndex, @@ -1170,8 +1359,8 @@ export class Deployer { } } - public async registerHyperchain( - baseTokenAddress: string, + public async registerZKChain( + baseTokenAssetId: string, validiumMode: boolean, extraFacets?: FacetCut[], gasPrice?: BigNumberish, @@ -1185,17 +1374,26 @@ export class Deployer { nonce = nonce ? parseInt(nonce) : await this.deployWallet.getTransactionCount(); const bridgehub = this.bridgehubContract(this.deployWallet); - const stateTransitionManager = this.stateTransitionManagerContract(this.deployWallet); + const chainTypeManager = this.chainTypeManagerContract(this.deployWallet); + const ntv = this.nativeTokenVault(this.deployWallet); + const baseTokenAddress = await ntv.tokenAddress(baseTokenAssetId); const inputChainId = predefinedChainId || getNumberFromEnv("CHAIN_ETH_ZKSYNC_NETWORK_ID"); - const alreadyRegisteredInSTM = - (await stateTransitionManager.getHyperchain(inputChainId)) != ethers.constants.AddressZero; + const alreadyRegisteredInCTM = (await chainTypeManager.getZKChain(inputChainId)) != ethers.constants.AddressZero; const admin = process.env.CHAIN_ADMIN_ADDRESS || this.ownerAddress; - const diamondCutData = await this.initialZkSyncHyperchainDiamondCut(extraFacets, compareDiamondCutHash); + const diamondCutData = await this.initialZkSyncZKChainDiamondCut(extraFacets, compareDiamondCutHash); const initialDiamondCut = new ethers.utils.AbiCoder().encode([DIAMOND_CUT_DATA_ABI_STRING], [diamondCutData]); const forceDeploymentsData = await this.genesisForceDeploymentsData(); const initData = ethers.utils.defaultAbiCoder.encode(["bytes", "bytes"], [initialDiamondCut, forceDeploymentsData]); + let factoryDeps = []; + if (process.env.CHAIN_ETH_NETWORK != "hardhat") { + factoryDeps = [ + L2_STANDARD_ERC20_PROXY_FACTORY_BYTECODE, + L2_STANDARD_ERC20_IMPLEMENTATION_BYTECODE, + L2_STANDARD_TOKEN_PROXY_BYTECODE, + ]; + } // note the factory deps are provided at genesis const receipt = await this.executeDirectOrGovernance( useGovernance, @@ -1204,11 +1402,11 @@ export class Deployer { [ inputChainId, this.addresses.StateTransition.StateTransitionProxy, - baseTokenAddress, + baseTokenAssetId, Date.now(), admin, initData, - [], + factoryDeps, ], 0, { @@ -1226,21 +1424,22 @@ export class Deployer { } this.addresses.BaseToken = baseTokenAddress; + this.addresses.BaseTokenAssetId = baseTokenAssetId; if (this.verbose) { - console.log(`Hyperchain registered, gas used: ${receipt.gasUsed.toString()} and ${receipt.gasUsed.toString()}`); - console.log(`Hyperchain registration tx hash: ${receipt.transactionHash}`); + console.log(`ZK chain registered, gas used: ${receipt.gasUsed.toString()} and ${receipt.gasUsed.toString()}`); + console.log(`ZK chain registration tx hash: ${receipt.transactionHash}`); console.log(`CHAIN_ETH_ZKSYNC_NETWORK_ID=${parseInt(chainId, 16)}`); console.log(`CONTRACTS_BASE_TOKEN_ADDR=${baseTokenAddress}`); } - if (!alreadyRegisteredInSTM) { + if (!alreadyRegisteredInCTM) { const diamondProxyAddress = "0x" + receipt.logs - .find((log) => log.topics[0] == stateTransitionManager.interface.getEventTopic("NewHyperchain")) + .find((log) => log.topics[0] == chainTypeManager.interface.getEventTopic("NewZKChain")) .topics[2].slice(26); this.addresses.StateTransition.DiamondProxy = diamondProxyAddress; if (this.verbose) { @@ -1261,9 +1460,8 @@ export class Deployer { const receiptRegisterValidator = await txRegisterValidator.wait(); if (this.verbose) { console.log( - `Validator registered, gas used: ${receiptRegisterValidator.gasUsed.toString()}, tx hash: ${ - txRegisterValidator.hash - }` + `Validator registered, gas used: ${receiptRegisterValidator.gasUsed.toString()}, tx hash: + ${txRegisterValidator.hash}` ); } @@ -1310,6 +1508,7 @@ export class Deployer { const multicallTx = await chainAdmin.multicall(calls, requireSuccess, { value: totalValue }); return await multicallTx.wait(); } + public async setTokenMultiplierSetterAddress(tokenMultiplierSetterAddress: string) { const chainAdmin = ChainAdminFactory.connect(this.addresses.ChainAdmin, this.deployWallet); @@ -1322,26 +1521,19 @@ export class Deployer { } public async transferAdminFromDeployerToChainAdmin() { - const stm = this.stateTransitionManagerContract(this.deployWallet); - const diamondProxyAddress = await stm.getHyperchain(this.chainId); - const hyperchain = IZkSyncHyperchainFactory.connect(diamondProxyAddress, this.deployWallet); + const ctm = this.chainTypeManagerContract(this.deployWallet); + const diamondProxyAddress = await ctm.getZKChain(this.chainId); + const zkChain = IZKChainFactory.connect(diamondProxyAddress, this.deployWallet); - const receipt = await (await hyperchain.setPendingAdmin(this.addresses.ChainAdmin)).wait(); + const receipt = await (await zkChain.setPendingAdmin(this.addresses.ChainAdmin)).wait(); if (this.verbose) { console.log(`ChainAdmin set as pending admin, gas used: ${receipt.gasUsed.toString()}`); } - // await this.executeUpgrade( - // hyperchain.address, - // 0, - // hyperchain.interface.encodeFunctionData("acceptAdmin"), - // null, - // false - // ); - const acceptAdminData = hyperchain.interface.encodeFunctionData("acceptAdmin"); + const acceptAdminData = zkChain.interface.encodeFunctionData("acceptAdmin"); await this.executeChainAdminMulticall([ { - target: hyperchain.address, + target: zkChain.address, value: 0, data: acceptAdminData, }, @@ -1352,24 +1544,22 @@ export class Deployer { } } - public async registerTokenBridgehub(tokenAddress: string, useGovernance: boolean = false) { - const bridgehub = this.bridgehubContract(this.deployWallet); - const receipt = await this.executeDirectOrGovernance(useGovernance, bridgehub, "addToken", [tokenAddress], 0); - - if (this.verbose) { - console.log(`Token ${tokenAddress} was registered, gas used: ${receipt.gasUsed.toString()}`); - } - } - public async deploySharedBridgeContracts(create2Salt: string, gasPrice?: BigNumberish, nonce?) { nonce = nonce ? parseInt(nonce) : await this.deployWallet.getTransactionCount(); + await this.deployL1NullifierImplementation(create2Salt, { gasPrice, nonce: nonce }); + await this.deployL1NullifierProxy(create2Salt, { gasPrice, nonce: nonce + 1 }); + + nonce = nonce + 2; await this.deploySharedBridgeImplementation(create2Salt, { gasPrice, nonce: nonce }); await this.deploySharedBridgeProxy(create2Salt, { gasPrice, nonce: nonce + 1 }); - await this.deployNativeTokenVaultImplementation(create2Salt, { gasPrice, nonce: nonce + 2 }); + nonce = nonce + 2; + await this.deployBridgedStandardERC20Implementation(create2Salt, { gasPrice, nonce: nonce }); + await this.deployBridgedTokenBeacon(create2Salt, { gasPrice, nonce: nonce + 1 }); + await this.deployNativeTokenVaultImplementation(create2Salt, { gasPrice, nonce: nonce + 3 }); await this.deployNativeTokenVaultProxy(create2Salt, { gasPrice }); - await this.deploySTMDeploymentTrackerImplementation(create2Salt, { gasPrice }); - await this.deploySTMDeploymentTrackerProxy(create2Salt, { gasPrice }); + await this.deployCTMDeploymentTrackerImplementation(create2Salt, { gasPrice }); + await this.deployCTMDeploymentTrackerProxy(create2Salt, { gasPrice }); await this.registerAddresses(); } @@ -1389,15 +1579,15 @@ export class Deployer { this.addresses.ValidatorTimeLock = contractAddress; } - public async setStateTransitionManagerInValidatorTimelock(ethTxOptions: ethers.providers.TransactionRequest) { + public async setChainTypeManagerInValidatorTimelock(ethTxOptions: ethers.providers.TransactionRequest) { const validatorTimelock = this.validatorTimelock(this.deployWallet); - const tx = await validatorTimelock.setStateTransitionManager( + const tx = await validatorTimelock.setChainTypeManager( this.addresses.StateTransition.StateTransitionProxy, ethTxOptions ); const receipt = await tx.wait(); if (this.verbose) { - console.log(`StateTransitionManager was set in ValidatorTimelock, gas used: ${receipt.gasUsed.toString()}`); + console.log(`ChainTypeManager was set in ValidatorTimelock, gas used: ${receipt.gasUsed.toString()}`); } } @@ -1490,15 +1680,15 @@ export class Deployer { } public bridgehubContract(signerOrProvider: Signer | providers.Provider) { - return IBridgehubFactory.connect(this.addresses.Bridgehub.BridgehubProxy, signerOrProvider); + return BridgehubFactory.connect(this.addresses.Bridgehub.BridgehubProxy, signerOrProvider); } - public stateTransitionManagerContract(signerOrProvider: Signer | providers.Provider) { - return StateTransitionManagerFactory.connect(this.addresses.StateTransition.StateTransitionProxy, signerOrProvider); + public chainTypeManagerContract(signerOrProvider: Signer | providers.Provider) { + return ChainTypeManagerFactory.connect(this.addresses.StateTransition.StateTransitionProxy, signerOrProvider); } public stateTransitionContract(signerOrProvider: Signer | providers.Provider) { - return IZkSyncHyperchainFactory.connect(this.addresses.StateTransition.DiamondProxy, signerOrProvider); + return IZKChainFactory.connect(this.addresses.StateTransition.DiamondProxy, signerOrProvider); } public governanceContract(signerOrProvider: Signer | providers.Provider) { @@ -1513,12 +1703,16 @@ export class Deployer { return IL1AssetRouterFactory.connect(this.addresses.Bridges.SharedBridgeProxy, signerOrProvider); } + public l1NullifierContract(signerOrProvider: Signer | providers.Provider) { + return IL1NullifierFactory.connect(this.addresses.Bridges.L1NullifierProxy, signerOrProvider); + } + public nativeTokenVault(signerOrProvider: Signer | providers.Provider) { return IL1NativeTokenVaultFactory.connect(this.addresses.Bridges.NativeTokenVaultProxy, signerOrProvider); } - public stmDeploymentTracker(signerOrProvider: Signer | providers.Provider) { - return ISTMDeploymentTrackerFactory.connect(this.addresses.Bridgehub.STMDeploymentTrackerProxy, signerOrProvider); + public ctmDeploymentTracker(signerOrProvider: Signer | providers.Provider) { + return ICTMDeploymentTrackerFactory.connect(this.addresses.Bridgehub.CTMDeploymentTrackerProxy, signerOrProvider); } public baseTokenContract(signerOrProvider: Signer | providers.Provider) { @@ -1528,4 +1722,9 @@ export class Deployer { public proxyAdminContract(signerOrProvider: Signer | providers.Provider) { return ProxyAdminFactory.connect(this.addresses.TransparentProxyAdmin, signerOrProvider); } + + private async getL1ChainId(): Promise { + const l1ChainId = this.isZkMode() ? getNumberFromEnv("ETH_CLIENT_CHAIN_ID") : await this.deployWallet.getChainId(); + return +l1ChainId; + } } diff --git a/l1-contracts/src.ts/diamondCut.ts b/l1-contracts/src.ts/diamondCut.ts index c2a8e8728..ca44029bf 100644 --- a/l1-contracts/src.ts/diamondCut.ts +++ b/l1-contracts/src.ts/diamondCut.ts @@ -3,8 +3,8 @@ import type { Interface } from "ethers/lib/utils"; import "@nomiclabs/hardhat-ethers"; import type { Wallet, BigNumberish } from "ethers"; import { ethers } from "ethers"; -import { IZkSyncHyperchainFactory } from "../typechain/IZkSyncHyperchainFactory"; -import { IZkSyncHyperchainBaseFactory } from "../typechain/IZkSyncHyperchainBaseFactory"; +import { IZKChainFactory } from "../typechain/IZKChainFactory"; +import { IZKChainBaseFactory } from "../typechain/IZKChainBaseFactory"; export enum Action { Add = 0, @@ -98,12 +98,12 @@ export async function getCurrentFacetCutsForAdd( } export async function getDeployedFacetCutsForRemove(wallet: Wallet, zkSyncAddress: string, updatedFaceNames: string[]) { - const mainContract = IZkSyncHyperchainFactory.connect(zkSyncAddress, wallet); + const mainContract = IZKChainFactory.connect(zkSyncAddress, wallet); const diamondCutFacets = await mainContract.facets(); // We don't care about freezing, because we are removing the facets. const result = []; for (const { addr, selectors } of diamondCutFacets) { - const facet = IZkSyncHyperchainBaseFactory.connect(addr, wallet); + const facet = IZKChainBaseFactory.connect(addr, wallet); const facetName = await facet.getName(); if (updatedFaceNames.includes(facetName)) { result.push({ diff --git a/l1-contracts/src.ts/utils.ts b/l1-contracts/src.ts/utils.ts index f328c5759..92f38244f 100644 --- a/l1-contracts/src.ts/utils.ts +++ b/l1-contracts/src.ts/utils.ts @@ -22,7 +22,6 @@ export const REQUIRED_L2_GAS_PRICE_PER_PUBDATA = require("../../SystemConfig.jso export const SYSTEM_UPGRADE_L2_TX_TYPE = 254; export const ADDRESS_ONE = "0x0000000000000000000000000000000000000001"; -export const ADDRESS_TWO_NTV = "0x0000000000000000000000000000000000000002"; export const ETH_ADDRESS_IN_CONTRACTS = ADDRESS_ONE; export const L1_TO_L2_ALIAS_OFFSET = "0x1111000000000000000000000000000000001111"; export const L2_BRIDGEHUB_ADDRESS = "0x0000000000000000000000000000000000010002"; @@ -35,12 +34,17 @@ const CREATE2_PREFIX = ethers.utils.solidityKeccak256(["string"], ["zksyncCreate export const priorityTxMaxGasLimit = getNumberFromEnv("CONTRACTS_PRIORITY_TX_MAX_GAS_LIMIT"); const ADDRESS_MODULO = ethers.BigNumber.from(2).pow(160); +export const STORED_BATCH_INFO_ABI_STRING = + "tuple(uint64 batchNumber, bytes32 batchHash, uint64 indexRepeatedStorageChanges, uint256 numberOfLayer1Txs, bytes32 priorityOperationsHash, bytes32 l2LogsTreeRoot, uint256 timestamp, bytes32 commitment)"; +export const COMMIT_BATCH_INFO_ABI_STRING = + "tuple(uint64 batchNumber, uint64 timestamp, uint64 indexRepeatedStorageChanges, bytes32 newStateRoot, uint256 numberOfLayer1Txs, bytes32 priorityOperationsHash, bytes32 bootloaderHeapInitialContentsHash, bytes32 eventsQueueStateHash, bytes systemLogs, bytes operatorDAInput)"; +export const PRIORITY_OPS_BATCH_INFO_ABI_STRING = + "tuple(bytes32[] leftPath, bytes32[] rightPath, bytes32[] itemHashes)"; export const DIAMOND_CUT_DATA_ABI_STRING = "tuple(tuple(address facet, uint8 action, bool isFreezable, bytes4[] selectors)[] facetCuts, address initAddress, bytes initCalldata)"; export const FORCE_DEPLOYMENT_ABI_STRING = "tuple(bytes32 bytecodeHash, address newAddress, bool callConstructor, uint256 value, bytes input)[]"; -export const HYPERCHAIN_COMMITMENT_ABI_STRING = - "tuple(uint256 totalBatchesExecuted, uint256 totalBatchesVerified, uint256 totalBatchesCommitted, bytes32 l2SystemContractsUpgradeTxHash, uint256 l2SystemContractsUpgradeBatchNumber, bytes32[] batchHashes, tuple(uint256 nextLeafIndex, uint256 startIndex, uint256 unprocessedIndex, bytes32[] sides) priorityTree)"; +export const BRIDGEHUB_CTM_ASSET_DATA_ABI_STRING = "tuple(uint256 chainId, bytes ctmData, bytes chainData)"; export function applyL1ToL2Alias(address: string): string { return ethers.utils.hexlify(ethers.BigNumber.from(address).add(L1_TO_L2_ALIAS_OFFSET).mod(ADDRESS_MODULO)); @@ -105,9 +109,12 @@ export function computeL2Create2Address( return ethers.utils.hexDataSlice(data, 12); } -export function encodeNTVAssetId(chainId: number, assetData: BytesLike) { +export function encodeNTVAssetId(chainId: number, tokenAddress: BytesLike) { return ethers.utils.keccak256( - ethers.utils.defaultAbiCoder.encode(["uint256", "address", "bytes32"], [chainId, ADDRESS_TWO_NTV, assetData]) + ethers.utils.defaultAbiCoder.encode( + ["uint256", "address", "bytes32"], + [chainId, L2_NATIVE_TOKEN_VAULT_ADDRESS, ethers.utils.hexZeroPad(tokenAddress, 32)] + ) ); } @@ -301,11 +308,11 @@ export function compileInitialCutHash( { chainId: "0x0000000000000000000000000000000000000000000000000000000000000001", bridgehub: "0x0000000000000000000000000000000000001234", - stateTransitionManager: "0x0000000000000000000000000000000000002234", + chainTypeManager: "0x0000000000000000000000000000000000002234", protocolVersion: "0x0000000000000000000000000000000000002234", admin: "0x0000000000000000000000000000000000003234", validatorTimelock: "0x0000000000000000000000000000000000004234", - baseToken: "0x0000000000000000000000000000000000004234", + baseTokenAssetId: "0x0000000000000000000000000000000000000000000000000000000000004234", baseTokenBridge: "0x0000000000000000000000000000000000004234", storedBatchZero: "0x0000000000000000000000000000000000000000000000000000000000005432", verifier, diff --git a/l1-contracts/test/foundry/integration/DeploymentTest.t.sol b/l1-contracts/test/foundry/integration/DeploymentTest.t.sol deleted file mode 100644 index 937df9cb4..000000000 --- a/l1-contracts/test/foundry/integration/DeploymentTest.t.sol +++ /dev/null @@ -1,75 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity 0.8.24; - -import {Test} from "forge-std/Test.sol"; -import {Vm} from "forge-std/Vm.sol"; - -import {L2TransactionRequestDirect, L2TransactionRequestTwoBridgesOuter} from "contracts/bridgehub/IBridgehub.sol"; -import {TestnetERC20Token} from "contracts/dev-contracts/TestnetERC20Token.sol"; -import {MailboxFacet} from "contracts/state-transition/chain-deps/facets/Mailbox.sol"; -import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; -import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol"; -import {IExecutor} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; -import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; -import {TokenDeployer} from "./_SharedTokenDeployer.t.sol"; -import {HyperchainDeployer} from "./_SharedHyperchainDeployer.t.sol"; -import {L2TxMocker} from "./_SharedL2TxMocker.t.sol"; -import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; -import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK} from "contracts/common/Config.sol"; -import {L2CanonicalTransaction} from "contracts/common/Messaging.sol"; -import {L2Message} from "contracts/common/Messaging.sol"; -import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; -import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; -import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; - -contract DeploymentTests is L1ContractDeployer, HyperchainDeployer, TokenDeployer, L2TxMocker { - uint256 constant TEST_USERS_COUNT = 10; - address[] public users; - address[] public l2ContractAddresses; - - // generate MAX_USERS addresses and append it to users array - function _generateUserAddresses() internal { - require(users.length == 0, "Addresses already generated"); - - for (uint256 i = 0; i < TEST_USERS_COUNT; i++) { - address newAddress = makeAddr(string(abi.encode("account", i))); - users.push(newAddress); - } - } - - function prepare() public { - _generateUserAddresses(); - - _deployL1Contracts(); - _deployTokens(); - _registerNewTokens(tokens); - - _deployEra(); - // _deployHyperchain(ETH_TOKEN_ADDRESS); - // _deployHyperchain(ETH_TOKEN_ADDRESS); - // _deployHyperchain(tokens[0]); - // _deployHyperchain(tokens[0]); - // _deployHyperchain(tokens[1]); - // _deployHyperchain(tokens[1]); - - for (uint256 i = 0; i < hyperchainIds.length; i++) { - address contractAddress = makeAddr(string(abi.encode("contract", i))); - l2ContractAddresses.push(contractAddress); - - _addL2ChainContract(hyperchainIds[i], contractAddress); - } - } - - function setUp() public { - prepare(); - } - - // Check whether the sum of ETH deposits from tests, updated on each deposit and withdrawal, - // equals the balance of L1Shared bridge. - function test_initialDeployment() public { - require(1 == 1); - } - - // add this to be excluded from coverage report - function test() internal override {} -} diff --git a/l1-contracts/test/foundry/integration/GatewayTests.t.sol b/l1-contracts/test/foundry/integration/GatewayTests.t.sol deleted file mode 100644 index 55dba36b4..000000000 --- a/l1-contracts/test/foundry/integration/GatewayTests.t.sol +++ /dev/null @@ -1,184 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity 0.8.24; - -import {Test} from "forge-std/Test.sol"; -import {Vm} from "forge-std/Vm.sol"; -import "forge-std/console.sol"; - -import {L2TransactionRequestDirect, L2TransactionRequestTwoBridgesOuter} from "contracts/bridgehub/IBridgehub.sol"; -import {TestnetERC20Token} from "contracts/dev-contracts/TestnetERC20Token.sol"; -import {MailboxFacet} from "contracts/state-transition/chain-deps/facets/Mailbox.sol"; -import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; -import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol"; -import {IExecutor} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; -import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; -import {TokenDeployer} from "./_SharedTokenDeployer.t.sol"; -import {HyperchainDeployer} from "./_SharedHyperchainDeployer.t.sol"; -import {GatewayDeployer} from "./_SharedGatewayDeployer.t.sol"; -import {L2TxMocker} from "./_SharedL2TxMocker.t.sol"; -import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; -import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK} from "contracts/common/Config.sol"; -import {L2CanonicalTransaction} from "contracts/common/Messaging.sol"; -import {L2Message} from "contracts/common/Messaging.sol"; -import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; -import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; -import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; - -import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; -import {IZkSyncHyperchain} from "contracts/state-transition/chain-interfaces/IZkSyncHyperchain.sol"; -import {IStateTransitionManager} from "contracts/state-transition/IStateTransitionManager.sol"; -import {AdminFacet} from "contracts/state-transition/chain-deps/facets/Admin.sol"; -import {AddressAliasHelper} from "contracts/vendor/AddressAliasHelper.sol"; - -contract GatewayTests is L1ContractDeployer, HyperchainDeployer, TokenDeployer, L2TxMocker, GatewayDeployer { - uint256 constant TEST_USERS_COUNT = 10; - address[] public users; - address[] public l2ContractAddresses; - - uint256 migratingChainId = 10; - uint256 gatewayChainId = 11; - uint256 mintChainId = 12; - - // generate MAX_USERS addresses and append it to users array - function _generateUserAddresses() internal { - require(users.length == 0, "Addresses already generated"); - - for (uint256 i = 0; i < TEST_USERS_COUNT; i++) { - address newAddress = makeAddr(string(abi.encode("account", i))); - users.push(newAddress); - } - } - - function prepare() public { - _generateUserAddresses(); - - _deployL1Contracts(); - _deployTokens(); - _registerNewTokens(tokens); - - _deployEra(); - _deployHyperchain(ETH_TOKEN_ADDRESS); - acceptPendingAdmin(); - _deployHyperchain(ETH_TOKEN_ADDRESS); - acceptPendingAdmin(); - // _deployHyperchain(tokens[0]); - // _deployHyperchain(tokens[0]); - // _deployHyperchain(tokens[1]); - // _deployHyperchain(tokens[1]); - - for (uint256 i = 0; i < hyperchainIds.length; i++) { - address contractAddress = makeAddr(string(abi.encode("contract", i))); - l2ContractAddresses.push(contractAddress); - - _addL2ChainContract(hyperchainIds[i], contractAddress); - // _registerL2SharedBridge(hyperchainIds[i], contractAddress); - } - - _initializeGatewayScript(); - - // console.log("KL todo", Ownable(l1Script.getBridgehubProxyAddress()).owner(), l1Script.getBridgehubProxyAddress()); - vm.deal(Ownable(l1Script.getBridgehubProxyAddress()).owner(), 100000000000000000000000000000000000); - vm.deal(l1Script.getOwnerAddress(), 100000000000000000000000000000000000); - IZkSyncHyperchain chain = IZkSyncHyperchain( - IBridgehub(l1Script.getBridgehubProxyAddress()).getHyperchain(migratingChainId) - ); - IZkSyncHyperchain chain2 = IZkSyncHyperchain( - IBridgehub(l1Script.getBridgehubProxyAddress()).getHyperchain(gatewayChainId) - ); - vm.deal(chain.getAdmin(), 100000000000000000000000000000000000); - vm.deal(chain2.getAdmin(), 100000000000000000000000000000000000); - - // console.log("kl todo balance", Ownable(l1Script.getBridgehubProxyAddress()).owner().balance); - // vm.deal(msg.sender, 100000000000000000000000000000000000); - // vm.deal(l1Script.getBridgehubProxyAddress(), 100000000000000000000000000000000000); - } - - function setUp() public { - prepare(); - } - - // - function test_registerGateway() public { - gatewayScript.registerGateway(); - } - - // - function test_moveChainToGateway() public { - gatewayScript.registerGateway(); - gatewayScript.moveChainToGateway(); - // require(bridgehub.settlementLayer()) - } - - function test_l2Registration() public { - gatewayScript.registerGateway(); - gatewayScript.moveChainToGateway(); - gatewayScript.registerL2Contracts(); - } - - function test_finishMoveChain() public { - finishMoveChain(); - } - - function test_startMessageToL3() public { - finishMoveChain(); - IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); - uint256 expectedValue = 1000000000000000000000; - - L2TransactionRequestDirect memory request = _createL2TransactionRequestDirect( - migratingChainId, - expectedValue, - 0, - 72000000, - 800, - "0x" - ); - bridgehub.requestL2TransactionDirect{value: expectedValue}(request); - } - - function test_forwardToL3OnGateway() public { - finishMoveChain(); - - IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); - L2CanonicalTransaction memory tx = L2CanonicalTransaction({ - txType: 255, - from: uint256(0), - to: uint256(0), - gasLimit: 72000000, - gasPerPubdataByteLimit: 800, - maxFeePerGas: 1, - maxPriorityFeePerGas: 0, - paymaster: 0, - // Note, that the priority operation id is used as "nonce" for L1->L2 transactions - nonce: 0, - value: 0, - reserved: [uint256(0), 0, 0, 0], - data: "0x", - signature: new bytes(0), - factoryDeps: new uint256[](0), - paymasterInput: "0x", - reservedDynamic: "0x" - }); - vm.chainId(12345); - vm.startBroadcast(AddressAliasHelper.applyL1ToL2Alias(address(0))); - bridgehub.forwardTransactionOnGateway(mintChainId, tx, new bytes[](0), bytes32(0), 0); - vm.stopBroadcast(); - } - - function finishMoveChain() public { - IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); - IStateTransitionManager stm = IStateTransitionManager(l1Script.getSTM()); - IZkSyncHyperchain chain = IZkSyncHyperchain(bridgehub.getHyperchain(migratingChainId)); - bytes32 assetId = bridgehub.stmAssetIdFromChainId(migratingChainId); - - bytes memory initialDiamondCut = l1Script.getInitialDiamondCutData(); - bytes memory chainData = abi.encode(AdminFacet(address(chain))._prepareChainCommitment()); - bytes memory stmData = abi.encode(address(1), msg.sender, stm.protocolVersion(), initialDiamondCut); - bytes memory bridgehubMintData = abi.encode(mintChainId, stmData, chainData); - vm.startBroadcast(address(bridgehub.sharedBridge())); - bridgehub.bridgeMint(gatewayChainId, assetId, bridgehubMintData); - vm.stopBroadcast(); - } - - // add this to be excluded from coverage report - function test() internal override {} -} diff --git a/l1-contracts/test/foundry/integration/_SharedHyperchainDeployer.t.sol b/l1-contracts/test/foundry/integration/_SharedHyperchainDeployer.t.sol deleted file mode 100644 index 9e032fdc9..000000000 --- a/l1-contracts/test/foundry/integration/_SharedHyperchainDeployer.t.sol +++ /dev/null @@ -1,136 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity 0.8.24; - -import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; -import {RegisterHyperchainScript} from "deploy-scripts/RegisterHyperchain.s.sol"; -import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; -import "@openzeppelin/contracts/utils/Strings.sol"; -import {IZkSyncHyperchain} from "contracts/state-transition/chain-interfaces/IZkSyncHyperchain.sol"; - -contract HyperchainDeployer is L1ContractDeployer { - RegisterHyperchainScript deployScript; - - struct HyperchainDescription { - uint256 hyperchainChainId; - address baseToken; - uint256 bridgehubCreateNewChainSalt; - bool validiumMode; - address validatorSenderOperatorCommitEth; - address validatorSenderOperatorBlobsEth; - uint128 baseTokenGasPriceMultiplierNominator; - uint128 baseTokenGasPriceMultiplierDenominator; - } - - uint256 currentHyperChainId = 10; - uint256 eraHyperchainId = 9; - uint256[] public hyperchainIds; - - function _deployEra() internal { - vm.setEnv( - "HYPERCHAIN_CONFIG", - "/test/foundry/integration/deploy-scripts/script-out/output-deploy-hyperchain-era.toml" - ); - - deployScript = new RegisterHyperchainScript(); - saveHyperchainConfig(_getDefaultDescription(eraHyperchainId, ETH_TOKEN_ADDRESS, eraHyperchainId)); - vm.warp(100); - deployScript.run(); - hyperchainIds.push(eraHyperchainId); - } - - function _deployHyperchain(address _baseToken) internal { - vm.setEnv( - "HYPERCHAIN_CONFIG", - string.concat( - "/test/foundry/integration/deploy-scripts/script-out/output-deploy-hyperchain-", - Strings.toString(currentHyperChainId), - ".toml" - ) - ); - hyperchainIds.push(currentHyperChainId); - saveHyperchainConfig(_getDefaultDescription(currentHyperChainId, _baseToken, currentHyperChainId)); - currentHyperChainId++; - deployScript.run(); - } - - function _getDefaultDescription( - uint256 __chainId, - address __baseToken, - uint256 __salt - ) internal returns (HyperchainDescription memory description) { - description = HyperchainDescription({ - hyperchainChainId: __chainId, - baseToken: __baseToken, - bridgehubCreateNewChainSalt: __salt, - validiumMode: false, - validatorSenderOperatorCommitEth: address(0), - validatorSenderOperatorBlobsEth: address(1), - baseTokenGasPriceMultiplierNominator: uint128(1), - baseTokenGasPriceMultiplierDenominator: uint128(1) - }); - } - - function saveHyperchainConfig(HyperchainDescription memory description) public { - string memory serialized; - - vm.serializeAddress("toml1", "owner_address", 0x70997970C51812dc3A010C7d01b50e0d17dc79C8); - vm.serializeUint("chain", "chain_chain_id", description.hyperchainChainId); - vm.serializeAddress("chain", "base_token_addr", description.baseToken); - vm.serializeUint("chain", "bridgehub_create_new_chain_salt", description.bridgehubCreateNewChainSalt); - - uint256 validiumMode = 0; - - if (description.validiumMode) { - validiumMode = 1; - } - - vm.serializeUint("chain", "validium_mode", validiumMode); - vm.serializeAddress( - "chain", - "validator_sender_operator_commit_eth", - description.validatorSenderOperatorCommitEth - ); - vm.serializeAddress( - "chain", - "validator_sender_operator_blobs_eth", - description.validatorSenderOperatorBlobsEth - ); - vm.serializeUint( - "chain", - "base_token_gas_price_multiplier_nominator", - description.baseTokenGasPriceMultiplierNominator - ); - vm.serializeUint("chain", "governance_min_delay", 0); - vm.serializeAddress("chain", "governance_security_council_address", address(0)); - - string memory single_serialized = vm.serializeUint( - "chain", - "base_token_gas_price_multiplier_denominator", - description.baseTokenGasPriceMultiplierDenominator - ); - - string memory toml = vm.serializeString("toml1", "chain", single_serialized); - string memory path = string.concat(vm.projectRoot(), vm.envString("HYPERCHAIN_CONFIG")); - vm.writeToml(toml, path); - } - - function getHyperchainAddress(uint256 _chainId) public view returns (address) { - return bridgeHub.getHyperchain(_chainId); - } - - function getHyperchainBaseToken(uint256 _chainId) public view returns (address) { - return bridgeHub.baseToken(_chainId); - } - - function acceptPendingAdmin() public { - IZkSyncHyperchain chain = IZkSyncHyperchain(bridgeHub.getHyperchain(currentHyperChainId - 1)); - address admin = chain.getPendingAdmin(); - vm.startBroadcast(admin); - chain.acceptAdmin(); - vm.stopBroadcast(); - vm.deal(admin, 10000000000000000000000000); - } - - // add this to be excluded from coverage report - function testHyperchainDeployer() internal {} -} diff --git a/l1-contracts/test/foundry/integration/deploy-scripts/script-out/output-deploy-l1.toml b/l1-contracts/test/foundry/integration/deploy-scripts/script-out/output-deploy-l1.toml deleted file mode 100644 index fa3301825..000000000 --- a/l1-contracts/test/foundry/integration/deploy-scripts/script-out/output-deploy-l1.toml +++ /dev/null @@ -1,54 +0,0 @@ -create2_factory_salt = "0x00000000000000000000000000000000000000000000000000000000000000ff" -deployer_addr = "0x7FA9385bE102ac3EAc297483Dd6233D62b3e1496" -era_chain_id = 9 -l1_chain_id = 31337 -multicall3_addr = "0x9735C424DEa176DC4304D1A240C824783D841f20" -owner_address = "0x70997970C51812dc3A010C7d01b50e0d17dc79C8" - -[contracts_config] -diamond_cut_data = "0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000600000000000000000000000009a5d498f9fdab5d26090b68aec33363ac3706c5e0000000000000000000000000000000000000000000000000000000000000de00000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000003a000000000000000000000000000000000000000000000000000000000000009c00000000000000000000000000000000000000000000000000000000000000bc0000000000000000000000000c49e34de76847b6ce4933cae561d6ae7c72b1c2500000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000140e18b681000000000000000000000000000000000000000000000000000000001733894500000000000000000000000000000000000000000000000000000000fc57565f000000000000000000000000000000000000000000000000000000001cc5d1030000000000000000000000000000000000000000000000000000000021f603d700000000000000000000000000000000000000000000000000000000235d9eb50000000000000000000000000000000000000000000000000000000027ae4c160000000000000000000000000000000000000000000000000000000043dc2951000000000000000000000000000000000000000000000000000000004623c91d000000000000000000000000000000000000000000000000000000004dd18bf5000000000000000000000000000000000000000000000000000000006223258e0000000000000000000000000000000000000000000000000000000064b554ad0000000000000000000000000000000000000000000000000000000064bf8d660000000000000000000000000000000000000000000000000000000082b57749000000000000000000000000000000000000000000000000000000008c564cc100000000000000000000000000000000000000000000000000000000a37dc1d400000000000000000000000000000000000000000000000000000000a3bd011200000000000000000000000000000000000000000000000000000000a9f6d94100000000000000000000000000000000000000000000000000000000be6f11cf00000000000000000000000000000000000000000000000000000000e76db86500000000000000000000000000000000000000000000000000000000000000000000000000000000ab0aa7c14904459f4bcde7f3b465546f022ec22a000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000002c06d49e5b00000000000000000000000000000000000000000000000000000000086a56f8000000000000000000000000000000000000000000000000000000000ec6b0b700000000000000000000000000000000000000000000000000000000fe26699e0000000000000000000000000000000000000000000000000000000018e3a941000000000000000000000000000000000000000000000000000000001de72e340000000000000000000000000000000000000000000000000000000029b98c670000000000000000000000000000000000000000000000000000000033ce93fe000000000000000000000000000000000000000000000000000000003408e470000000000000000000000000000000000000000000000000000000003591c1a000000000000000000000000000000000000000000000000000000000396073820000000000000000000000000000000000000000000000000000000039d7d4aa0000000000000000000000000000000000000000000000000000000046657fe90000000000000000000000000000000000000000000000000000000052ef6b2c000000000000000000000000000000000000000000000000000000005518c73b0000000000000000000000000000000000000000000000000000000056142d7a00000000000000000000000000000000000000000000000000000000631f4bac000000000000000000000000000000000000000000000000000000006e9960c30000000000000000000000000000000000000000000000000000000074f4d30d0000000000000000000000000000000000000000000000000000000079823c9a000000000000000000000000000000000000000000000000000000007a0ed627000000000000000000000000000000000000000000000000000000007b30c8da0000000000000000000000000000000000000000000000000000000098acd7a6000000000000000000000000000000000000000000000000000000009cd939e4000000000000000000000000000000000000000000000000000000009d1b5a8100000000000000000000000000000000000000000000000000000000a1954fc500000000000000000000000000000000000000000000000000000000a7358efb00000000000000000000000000000000000000000000000000000000adfca15e00000000000000000000000000000000000000000000000000000000af6a2dcd00000000000000000000000000000000000000000000000000000000b22dd78e00000000000000000000000000000000000000000000000000000000b8c2f66f00000000000000000000000000000000000000000000000000000000bd7c541200000000000000000000000000000000000000000000000000000000c3bbd2d700000000000000000000000000000000000000000000000000000000cdffacc600000000000000000000000000000000000000000000000000000000d046815600000000000000000000000000000000000000000000000000000000d86970d800000000000000000000000000000000000000000000000000000000db1f0bf900000000000000000000000000000000000000000000000000000000e5355c7500000000000000000000000000000000000000000000000000000000e81e0ba100000000000000000000000000000000000000000000000000000000ea6c029c00000000000000000000000000000000000000000000000000000000ef3f0bae00000000000000000000000000000000000000000000000000000000f5c1182c00000000000000000000000000000000000000000000000000000000facd743b00000000000000000000000000000000000000000000000000000000fd791f3c0000000000000000000000000000000000000000000000000000000000000000000000000000000066825543c5c82b711de855426946f6929573cf55000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000b042901c70000000000000000000000000000000000000000000000000000000008522c300000000000000000000000000000000000000000000000000000000012f43dab00000000000000000000000000000000000000000000000000000000eb67241900000000000000000000000000000000000000000000000000000000263b7f8e000000000000000000000000000000000000000000000000000000006c0960f9000000000000000000000000000000000000000000000000000000007efda2ae00000000000000000000000000000000000000000000000000000000b473318e00000000000000000000000000000000000000000000000000000000d06b26e200000000000000000000000000000000000000000000000000000000dcabb98200000000000000000000000000000000000000000000000000000000e4948f430000000000000000000000000000000000000000000000000000000000000000000000000000000049c0372a531af3cf3fe715c1918c278c07affce5000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000800a22e22000000000000000000000000000000000000000000000000000000000f23da4300000000000000000000000000000000000000000000000000000000c37533bb000000000000000000000000000000000000000000000000000000006edd4f1200000000000000000000000000000000000000000000000000000000701f58c5000000000000000000000000000000000000000000000000000000007f61885c0000000000000000000000000000000000000000000000000000000097c09d3400000000000000000000000000000000000000000000000000000000bd6db4990000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000032c101edc4d322abd5da779f1a5376e412e21160000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004c4b400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000f4240000000000000000000000000000000000000000000000000000000000001d4c00000000000000000000000000000000000000000000000000000000004c4b40000000000000000000000000000000000000000000000000000000000000182b8000000000000000000000000000000000000000000000000000000000ee6b280000000000000000000000000a4cb26d6933d2c3e76718d30de8547bcdf8dd241" -diamond_init_batch_overhead_l1_gas = 1000000 -diamond_init_max_l2_gas_per_batch = 80000000 -diamond_init_max_pubdata_per_batch = 120000 -diamond_init_minimal_l2_gas_price = 250000000 -diamond_init_priority_tx_max_pubdata = 99000 -diamond_init_pubdata_pricing_mode = 0 -force_deployments_data = "0x00" -priority_tx_max_gas_limit = 80000000 -recursion_circuits_set_vks_hash = "0x0000000000000000000000000000000000000000000000000000000000000000" -recursion_leaf_level_vk_hash = "0x0000000000000000000000000000000000000000000000000000000000000000" -recursion_node_level_vk_hash = "0x0000000000000000000000000000000000000000000000000000000000000000" - -[deployed_addresses] -blob_versioned_hash_retriever_addr = "0xA4cB26d6933D2c3E76718D30de8547bCDF8dD241" -governance_addr = "0x6ba327EAE385c52A861b1cacAc60021F03489413" -native_token_vault_addr = "0x153e4040C649Fe562cAa0A71Fd79f79BCA2593aB" -transparent_proxy_admin_addr = "0xDEb1E9a6Be7Baf84208BB6E10aC9F9bbE1D70809" -validator_timelock_addr = "0xDb50CefBF1F40e85951dAbd0194c477D6270Fe5E" - -[deployed_addresses.bridgehub] -bridgehub_implementation_addr = "0xa53970305e11ac9eD420Ec7C7AABb59fC3a64B0e" -bridgehub_proxy_addr = "0xC6585692481e509DDD11Eb2033535c6FF6e89B99" -message_root_implementation_addr = "0x67c321b17102Cbd39068B8bAeC3fF925FEc76C46" -message_root_proxy_addr = "0x88001933Ff48C53181cf1b11935AC2126954cb9e" -stm_deployment_tracker_implementation_addr = "0x205CEF369839dF59C016b02e4ECb45fB706576d0" -stm_deployment_tracker_proxy_addr = "0x8D9731582480f2CB74BC93168D86fB26788986b2" - -[deployed_addresses.bridges] -erc20_bridge_implementation_addr = "0xD23dF92Df88AF35d9f804BCd576B12C212A8BbD9" -erc20_bridge_proxy_addr = "0x6DDEFe6C5B5068347E278D5Be9B2a8a81c9C4F23" -shared_bridge_implementation_addr = "0xA66087143CEBcd6859aEd08420B1228De567Cd88" -shared_bridge_proxy_addr = "0x1e1314a32AaE641325b6BEfC625f499f1d7c7B2a" - -[deployed_addresses.state_transition] -admin_facet_addr = "0xC49E34dE76847b6Ce4933caE561d6aE7C72B1c25" -default_upgrade_addr = "0x7C0213Ecf479fE20b03B9e0d5a62B6D1602fe9a5" -diamond_init_addr = "0x9a5D498f9FdAB5D26090B68AEc33363ac3706C5e" -diamond_proxy_addr = "0x0000000000000000000000000000000000000000" -executor_facet_addr = "0x49C0372A531aF3cF3Fe715c1918c278c07aFfCe5" -genesis_upgrade_addr = "0xAFAb4F3F4B7984A3A93A5eC3B1028aC6e7194602" -getters_facet_addr = "0xab0AA7c14904459F4bCDe7f3B465546f022ec22A" -mailbox_facet_addr = "0x66825543c5c82b711de855426946f6929573cF55" -state_transition_implementation_addr = "0x2051075b03d1F2E0902C9cFd349fbdD4c73bB2d4" -state_transition_proxy_addr = "0x236e89885449f7ef4650743Ba350Fd557060905E" -verifier_addr = "0x32C101EDC4D322AbD5da779f1A5376e412E21160" diff --git a/l1-contracts/test/foundry/l1/integration/AssetRouterTest.t.sol b/l1-contracts/test/foundry/l1/integration/AssetRouterTest.t.sol new file mode 100644 index 000000000..83913d2a4 --- /dev/null +++ b/l1-contracts/test/foundry/l1/integration/AssetRouterTest.t.sol @@ -0,0 +1,184 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {Test} from "forge-std/Test.sol"; +import {Vm} from "forge-std/Vm.sol"; + +import {L2TransactionRequestDirect, L2TransactionRequestTwoBridgesOuter} from "contracts/bridgehub/IBridgehub.sol"; +import {TestnetERC20Token} from "contracts/dev-contracts/TestnetERC20Token.sol"; +import {MailboxFacet} from "contracts/state-transition/chain-deps/facets/Mailbox.sol"; +import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; +import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol"; +import {IExecutor} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; +import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; +import {TokenDeployer} from "./_SharedTokenDeployer.t.sol"; +import {ZKChainDeployer} from "./_SharedZKChainDeployer.t.sol"; +import {L2TxMocker} from "./_SharedL2TxMocker.t.sol"; +import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; +import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK} from "contracts/common/Config.sol"; +import {L2CanonicalTransaction, L2Message} from "contracts/common/Messaging.sol"; +import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; +import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; +import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; +import {IZKChain} from "contracts/state-transition/chain-interfaces/IZKChain.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; +import {IL1NativeTokenVault} from "contracts/bridge/ntv/IL1NativeTokenVault.sol"; +import {IL1Nullifier, FinalizeL1DepositParams} from "contracts/bridge/interfaces/IL1Nullifier.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; +import {IAssetRouterBase, LEGACY_ENCODING_VERSION, NEW_ENCODING_VERSION} from "contracts/bridge/asset-router/IAssetRouterBase.sol"; +import {L2_ASSET_ROUTER_ADDR, L2_NATIVE_TOKEN_VAULT_ADDR} from "contracts/common/L2ContractAddresses.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; +import {BridgeHelper} from "contracts/bridge/BridgeHelper.sol"; +import {BridgedStandardERC20, NonSequentialVersion} from "contracts/bridge/BridgedStandardERC20.sol"; +import {IBridgedStandardToken} from "contracts/bridge/BridgedStandardERC20.sol"; +import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; + +contract AssetRouterTest is L1ContractDeployer, ZKChainDeployer, TokenDeployer, L2TxMocker { + uint256 constant TEST_USERS_COUNT = 10; + address[] public users; + address[] public l2ContractAddresses; + bytes32 public l2TokenAssetId; + address public tokenL1Address; + // generate MAX_USERS addresses and append it to users array + function _generateUserAddresses() internal { + require(users.length == 0, "Addresses already generated"); + + for (uint256 i = 0; i < TEST_USERS_COUNT; i++) { + address newAddress = makeAddr(string(abi.encode("account", i))); + users.push(newAddress); + } + } + + function prepare() public { + _generateUserAddresses(); + + _deployL1Contracts(); + _deployTokens(); + _registerNewTokens(tokens); + + _deployEra(); + // _deployHyperchain(ETH_TOKEN_ADDRESS); + // _deployHyperchain(ETH_TOKEN_ADDRESS); + // _deployHyperchain(tokens[0]); + // _deployHyperchain(tokens[0]); + // _deployHyperchain(tokens[1]); + // _deployHyperchain(tokens[1]); + + for (uint256 i = 0; i < zkChainIds.length; i++) { + address contractAddress = makeAddr(string(abi.encode("contract", i))); + l2ContractAddresses.push(contractAddress); + + _addL2ChainContract(zkChainIds[i], contractAddress); + } + } + + function setUp() public { + prepare(); + } + + function depositToL1(address _tokenAddress) public { + vm.mockCall( + address(bridgeHub), + abi.encodeWithSelector(IBridgehub.proveL2MessageInclusion.selector), + abi.encode(true) + ); + uint256 chainId = eraZKChainId; + l2TokenAssetId = DataEncoding.encodeNTVAssetId(chainId, address(1)); + bytes memory transferData = DataEncoding.encodeBridgeMintData({ + _originalCaller: ETH_TOKEN_ADDRESS, + _l2Receiver: address(this), + _l1Token: ETH_TOKEN_ADDRESS, + _amount: 100, + _erc20Metadata: BridgeHelper.getERC20Getters(_tokenAddress, chainId) + }); + l1Nullifier.finalizeDeposit( + FinalizeL1DepositParams({ + chainId: chainId, + l2BatchNumber: 1, + l2MessageIndex: 1, + l2Sender: L2_ASSET_ROUTER_ADDR, + l2TxNumberInBatch: 1, + message: abi.encodePacked( + IAssetRouterBase.finalizeDeposit.selector, + chainId, + l2TokenAssetId, + transferData + ), + merkleProof: new bytes32[](0) + }) + ); + tokenL1Address = l1NativeTokenVault.tokenAddress(l2TokenAssetId); + } + + function test_DepositToL1_Success() public { + depositToL1(ETH_TOKEN_ADDRESS); + } + + function test_BridgeTokenFunctions() public { + depositToL1(ETH_TOKEN_ADDRESS); + BridgedStandardERC20 bridgedToken = BridgedStandardERC20(l1NativeTokenVault.tokenAddress(l2TokenAssetId)); + assertEq(bridgedToken.name(), "Ether"); + assertEq(bridgedToken.symbol(), "ETH"); + assertEq(bridgedToken.decimals(), 18); + } + + function test_reinitBridgedToken_Success() public { + depositToL1(ETH_TOKEN_ADDRESS); + BridgedStandardERC20 bridgedToken = BridgedStandardERC20(l1NativeTokenVault.tokenAddress(l2TokenAssetId)); + address owner = l1NativeTokenVault.owner(); + vm.broadcast(owner); + bridgedToken.reinitializeToken( + BridgedStandardERC20.ERC20Getters({ignoreName: false, ignoreSymbol: false, ignoreDecimals: false}), + "TestnetERC20Token", + "TST", + 2 + ); + } + + function test_reinitBridgedToken_WrongVersion() public { + depositToL1(ETH_TOKEN_ADDRESS); + BridgedStandardERC20 bridgedToken = BridgedStandardERC20(l1NativeTokenVault.tokenAddress(l2TokenAssetId)); + vm.expectRevert(NonSequentialVersion.selector); + bridgedToken.reinitializeToken( + BridgedStandardERC20.ERC20Getters({ignoreName: false, ignoreSymbol: false, ignoreDecimals: false}), + "TestnetERC20Token", + "TST", + 3 + ); + } + + /// @dev We should not test this on the L1, but to get coverage we do. + function test_BridgeTokenBurn() public { + depositToL1(ETH_TOKEN_ADDRESS); + BridgedStandardERC20 bridgedToken = BridgedStandardERC20(l1NativeTokenVault.tokenAddress(l2TokenAssetId)); + vm.store(address(bridgedToken), bytes32(uint256(207)), bytes32(0)); + vm.broadcast(L2_NATIVE_TOKEN_VAULT_ADDR); // kl todo call ntv, or even assetRouter/bridgehub + bridgedToken.bridgeBurn(address(this), 100); + } + + function test_DepositToL1AndWithdraw() public { + depositToL1(ETH_TOKEN_ADDRESS); + bytes memory secondBridgeCalldata = bytes.concat( + NEW_ENCODING_VERSION, + abi.encode(l2TokenAssetId, abi.encode(uint256(100), address(this))) + ); + IERC20(tokenL1Address).approve(address(l1NativeTokenVault), 100); + bridgeHub.requestL2TransactionTwoBridges{value: 250000000000100}( + L2TransactionRequestTwoBridgesOuter({ + chainId: eraZKChainId, + mintValue: 250000000000100, + l2Value: 0, + l2GasLimit: 1000000, + l2GasPerPubdataByteLimit: REQUIRED_L2_GAS_PRICE_PER_PUBDATA, + refundRecipient: address(0), + secondBridgeAddress: address(sharedBridge), + secondBridgeValue: 0, + secondBridgeCalldata: secondBridgeCalldata + }) + ); + } + + // add this to be excluded from coverage report + function test() internal override {} +} diff --git a/l1-contracts/test/foundry/integration/BridgeHubInvariantTests.t.sol b/l1-contracts/test/foundry/l1/integration/BridgeHubInvariantTests.t.sol similarity index 90% rename from l1-contracts/test/foundry/integration/BridgeHubInvariantTests.t.sol rename to l1-contracts/test/foundry/l1/integration/BridgeHubInvariantTests.t.sol index 6a59364bc..f7bd23b28 100644 --- a/l1-contracts/test/foundry/integration/BridgeHubInvariantTests.t.sol +++ b/l1-contracts/test/foundry/l1/integration/BridgeHubInvariantTests.t.sol @@ -12,7 +12,7 @@ import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol import {IExecutor} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; import {TokenDeployer} from "./_SharedTokenDeployer.t.sol"; -import {HyperchainDeployer} from "./_SharedHyperchainDeployer.t.sol"; +import {ZKChainDeployer} from "./_SharedZKChainDeployer.t.sol"; import {L2TxMocker} from "./_SharedL2TxMocker.t.sol"; import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK} from "contracts/common/Config.sol"; @@ -21,8 +21,9 @@ import {L2Message} from "contracts/common/Messaging.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; -contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, TokenDeployer, L2TxMocker { +contract BridgeHubInvariantTests is L1ContractDeployer, ZKChainDeployer, TokenDeployer, L2TxMocker { uint256 constant TEST_USERS_COUNT = 10; bytes32 constant NEW_PRIORITY_REQUEST_HASH = @@ -54,7 +55,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke // Amounts deposited by each user, mapped by user address and token address mapping(address user => mapping(address token => uint256 deposited)) public depositsUsers; - // Amounts deposited into the bridge, mapped by hyperchain address and token address + // Amounts deposited into the bridge, mapped by ZK chain address and token address mapping(address chain => mapping(address token => uint256 deposited)) public depositsBridge; // Total sum of deposits into the bridge, mapped by token address mapping(address token => uint256 deposited) public tokenSumDeposit; @@ -62,7 +63,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke mapping(address token => uint256 deposited) public tokenSumWithdrawal; // Total sum of L2 values transferred to mock contracts, mapped by token address mapping(address token => uint256 deposited) public l2ValuesSum; - // Deposits into the hyperchains contract, mapped by L2 contract address and token address + // Deposits into the ZK chains contract, mapped by L2 contract address and token address mapping(address l2contract => mapping(address token => uint256 balance)) public contractDeposits; // Total sum of deposits into all L2 contracts, mapped by token address mapping(address token => uint256 deposited) public contractDepositsSum; @@ -75,10 +76,10 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke vm.stopPrank(); } - // gets random hyperchain from hyperchain ids, set contract variables - modifier useHyperchain(uint256 chainIndexSeed) { - currentChainId = hyperchainIds[bound(chainIndexSeed, 0, hyperchainIds.length - 1)]; - currentChainAddress = getHyperchainAddress(currentChainId); + // gets random ZK chain from ZK chain ids, set contract variables + modifier useZKChain(uint256 chainIndexSeed) { + currentChainId = zkChainIds[bound(chainIndexSeed, 0, zkChainIds.length - 1)]; + currentChainAddress = getZKChainAddress(currentChainId); _; } @@ -99,7 +100,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke // use base token as main token // watch out, do not use with ETH modifier useBaseToken() { - currentToken = TestnetERC20Token(getHyperchainBaseToken(currentChainId)); + currentToken = TestnetERC20Token(getZKChainBaseToken(currentChainId)); currentTokenAddress = address(currentToken); _; } @@ -134,7 +135,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke function _commitBatchInfo(uint256 _chainId) internal { //vm.warp(COMMIT_TIMESTAMP_NOT_OLDER + 1 + 1); - GettersFacet hyperchainGetters = GettersFacet(getHyperchainAddress(_chainId)); + GettersFacet zkChainGetters = GettersFacet(getZKChainAddress(_chainId)); IExecutor.StoredBatchInfo memory batchZero; @@ -148,7 +149,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke batchZero.commitment = vm.parseBytes32("0x0000000000000000000000000000000000000000000000000000000000000000"); bytes32 hashedZeroBatch = keccak256(abi.encode(batchZero)); - assertEq(hyperchainGetters.storedBatchHash(0), hashedZeroBatch); + assertEq(zkChainGetters.storedBatchHash(0), hashedZeroBatch); } // use mailbox interface to return exact amount to use as a gas on l2 side, @@ -159,7 +160,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke uint256 _l2GasLimit, uint256 _l2GasPerPubdataByteLimit ) public view returns (uint256) { - MailboxFacet chainMailBox = MailboxFacet(getHyperchainAddress(_chainId)); + MailboxFacet chainMailBox = MailboxFacet(getZKChainAddress(_chainId)); return chainMailBox.l2TransactionBaseCost(_gasPrice, _l2GasLimit, _l2GasPerPubdataByteLimit); } @@ -235,7 +236,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke } } - // deposits ERC20 token to the hyperchain where base token is ETH + // deposits ERC20 token to the ZK chain where base token is ETH // this function use requestL2TransactionTwoBridges function from shared bridge. // tokenAddress should be any ERC20 token, excluding ETH function depositERC20ToEthChain(uint256 l2Value, address tokenAddress) private useGivenToken(tokenAddress) { @@ -338,7 +339,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke } // deposits ERC20 to token with base being also ERC20 - // there are no modifiers so watch out, baseTokenAddress should be base of hyperchain + // there are no modifiers so watch out, baseTokenAddress should be base of ZK chain // currentToken should be different from base function depositERC20ToERC20Chain(uint256 l2Value, address baseTokenAddress) private { uint256 gasPrice = 10000000; @@ -392,7 +393,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke l2ValuesSum[currentTokenAddress] += l2Value; } - // deposits ETH to hyperchain where base is ETH + // deposits ETH to ZK chain where base is ETH function depositEthBase(uint256 l2Value) private { uint256 gasPrice = 10000000; vm.txGasPrice(gasPrice); @@ -485,8 +486,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke bytes32[] memory merkleProof = new bytes32[](1); _setSharedBridgeIsWithdrawalFinalized(currentChainId, l2BatchNumber, l2MessageIndex, false); - uint256 beforeChainBalance = sharedBridge.chainBalance(currentChainId, currentTokenAddress); - uint256 beforeBalance = currentToken.balanceOf(sharedBridgeProxyAddress); + uint256 beforeChainBalance = l1Nullifier.__DEPRECATED_chainBalance(currentChainId, currentTokenAddress); + uint256 beforeBalance = currentToken.balanceOf(address(sharedBridge)); if (beforeChainBalance < amountToWithdraw) { vm.expectRevert("L1AR: not enough funds 2"); @@ -533,10 +534,10 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke // check if the balance was updated correctly if (beforeChainBalance > amountToWithdraw) { assertEq( - beforeChainBalance - sharedBridge.chainBalance(currentChainId, currentTokenAddress), + beforeChainBalance - l1Nullifier.__DEPRECATED_chainBalance(currentChainId, currentTokenAddress), amountToWithdraw ); - assertEq(beforeBalance - currentToken.balanceOf(sharedBridgeProxyAddress), amountToWithdraw); + assertEq(beforeBalance - currentToken.balanceOf(address(sharedBridge)), amountToWithdraw); } } @@ -547,8 +548,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke bytes32[] memory merkleProof = new bytes32[](1); _setSharedBridgeIsWithdrawalFinalized(currentChainId, l2BatchNumber, l2MessageIndex, false); - uint256 beforeChainBalance = sharedBridge.chainBalance(currentChainId, currentTokenAddress); - uint256 beforeBalance = sharedBridgeProxyAddress.balance; + uint256 beforeChainBalance = l1Nullifier.__DEPRECATED_chainBalance(currentChainId, currentTokenAddress); + uint256 beforeBalance = address(sharedBridge).balance; if (beforeChainBalance < amountToWithdraw) { vm.expectRevert("L1AR: not enough funds 2"); @@ -589,10 +590,10 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke // check if the balance was updated correctly if (beforeChainBalance > amountToWithdraw) { assertEq( - beforeChainBalance - sharedBridge.chainBalance(currentChainId, currentTokenAddress), + beforeChainBalance - l1Nullifier.__DEPRECATED_chainBalance(currentChainId, currentTokenAddress), amountToWithdraw ); - assertEq(beforeBalance - sharedBridgeProxyAddress.balance, amountToWithdraw); + assertEq(beforeBalance - address(sharedBridge).balance, amountToWithdraw); } } @@ -600,7 +601,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke uint256 userIndexSeed, uint256 chainIndexSeed, uint256 l2Value - ) public virtual useUser(userIndexSeed) useHyperchain(chainIndexSeed) useBaseToken { + ) public virtual useUser(userIndexSeed) useZKChain(chainIndexSeed) useBaseToken { if (currentTokenAddress == ETH_TOKEN_ADDRESS) { depositEthBase(l2Value); } else { @@ -613,8 +614,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke uint256 chainIndexSeed, uint256 tokenIndexSeed, uint256 l2Value - ) public virtual useUser(userIndexSeed) useHyperchain(chainIndexSeed) useERC20Token(tokenIndexSeed) { - address chainBaseToken = getHyperchainBaseToken(currentChainId); + ) public virtual useUser(userIndexSeed) useZKChain(chainIndexSeed) useERC20Token(tokenIndexSeed) { + address chainBaseToken = getZKChainBaseToken(currentChainId); if (chainBaseToken == ETH_TOKEN_ADDRESS) { depositERC20ToEthChain(l2Value, currentTokenAddress); @@ -631,8 +632,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke uint256 userIndexSeed, uint256 chainIndexSeed, uint256 amountToWithdraw - ) public virtual useUser(userIndexSeed) useHyperchain(chainIndexSeed) { - address token = getHyperchainBaseToken(currentChainId); + ) public virtual useUser(userIndexSeed) useZKChain(chainIndexSeed) { + address token = getZKChainBaseToken(currentChainId); if (token != ETH_TOKEN_ADDRESS) { withdrawERC20Token(amountToWithdraw, token); @@ -643,7 +644,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke function getAddressesToExclude() public returns (address[] memory) { addressesToExclude.push(bridgehubProxyAddress); - addressesToExclude.push(sharedBridgeProxyAddress); + addressesToExclude.push(address(sharedBridge)); for (uint256 i = 0; i < users.length; i++) { addressesToExclude.push(users[i]); @@ -653,8 +654,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke addressesToExclude.push(l2ContractAddresses[i]); } - for (uint256 i = 0; i < hyperchainIds.length; i++) { - addressesToExclude.push(getHyperchainAddress(hyperchainIds[i])); + for (uint256 i = 0; i < zkChainIds.length; i++) { + addressesToExclude.push(getZKChainAddress(zkChainIds[i])); } return addressesToExclude; @@ -668,18 +669,18 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke _registerNewTokens(tokens); _deployEra(); - _deployHyperchain(ETH_TOKEN_ADDRESS); - _deployHyperchain(ETH_TOKEN_ADDRESS); - _deployHyperchain(tokens[0]); - _deployHyperchain(tokens[0]); - _deployHyperchain(tokens[1]); - _deployHyperchain(tokens[1]); - - for (uint256 i = 0; i < hyperchainIds.length; i++) { + _deployZKChain(ETH_TOKEN_ADDRESS); + _deployZKChain(ETH_TOKEN_ADDRESS); + _deployZKChain(tokens[0]); + _deployZKChain(tokens[0]); + _deployZKChain(tokens[1]); + _deployZKChain(tokens[1]); + + for (uint256 i = 0; i < zkChainIds.length; i++) { address contractAddress = makeAddr(string(abi.encode("contract", i))); l2ContractAddresses.push(contractAddress); - _addL2ChainContract(hyperchainIds[i], contractAddress); + _addL2ChainContract(zkChainIds[i], contractAddress); } } @@ -721,7 +722,7 @@ contract BoundedBridgeHubInvariantTests is BridgeHubInvariantTests { function testBoundedBridgeHubInvariant() internal {} } -contract InvariantTesterHyperchains is Test { +contract InvariantTesterZKChains is Test { BoundedBridgeHubInvariantTests tests; function setUp() public { diff --git a/l1-contracts/test/foundry/integration/BridgehubTests.t.sol b/l1-contracts/test/foundry/l1/integration/BridgehubTests.t.sol similarity index 90% rename from l1-contracts/test/foundry/integration/BridgehubTests.t.sol rename to l1-contracts/test/foundry/l1/integration/BridgehubTests.t.sol index 5074d6091..4e262ad50 100644 --- a/l1-contracts/test/foundry/integration/BridgehubTests.t.sol +++ b/l1-contracts/test/foundry/l1/integration/BridgehubTests.t.sol @@ -12,7 +12,7 @@ import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol import {IExecutor} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; import {TokenDeployer} from "./_SharedTokenDeployer.t.sol"; -import {HyperchainDeployer} from "./_SharedHyperchainDeployer.t.sol"; +import {ZKChainDeployer} from "./_SharedZKChainDeployer.t.sol"; import {L2TxMocker} from "./_SharedL2TxMocker.t.sol"; import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK} from "contracts/common/Config.sol"; @@ -21,8 +21,9 @@ import {L2Message} from "contracts/common/Messaging.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; -contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, TokenDeployer, L2TxMocker { +contract BridgeHubInvariantTests is L1ContractDeployer, ZKChainDeployer, TokenDeployer, L2TxMocker { uint256 constant TEST_USERS_COUNT = 10; bytes32 constant NEW_PRIORITY_REQUEST_HASH = @@ -54,7 +55,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke // Amounts deposited by each user, mapped by user address and token address mapping(address user => mapping(address token => uint256 deposited)) public depositsUsers; - // Amounts deposited into the bridge, mapped by hyperchain address and token address + // Amounts deposited into the bridge, mapped by ZK chain address and token address mapping(address chain => mapping(address token => uint256 deposited)) public depositsBridge; // Total sum of deposits into the bridge, mapped by token address mapping(address token => uint256 deposited) public tokenSumDeposit; @@ -62,7 +63,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke mapping(address token => uint256 deposited) public tokenSumWithdrawal; // Total sum of L2 values transferred to mock contracts, mapped by token address mapping(address token => uint256 deposited) public l2ValuesSum; - // Deposits into the hyperchains contract, mapped by L2 contract address and token address + // Deposits into the ZK chains contract, mapped by L2 contract address and token address mapping(address l2contract => mapping(address token => uint256 balance)) public contractDeposits; // Total sum of deposits into all L2 contracts, mapped by token address mapping(address token => uint256 deposited) public contractDepositsSum; @@ -75,10 +76,10 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke vm.stopPrank(); } - // gets random hyperchain from hyperchain ids, set contract variables - modifier useHyperchain(uint256 chainIndexSeed) { - currentChainId = hyperchainIds[bound(chainIndexSeed, 0, hyperchainIds.length - 1)]; - currentChainAddress = getHyperchainAddress(currentChainId); + // gets random ZK chain from ZK chain ids, set contract variables + modifier useZKChain(uint256 chainIndexSeed) { + currentChainId = zkChainIds[bound(chainIndexSeed, 0, zkChainIds.length - 1)]; + currentChainAddress = getZKChainAddress(currentChainId); _; } @@ -99,7 +100,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke // use base token as main token // watch out, do not use with ETH modifier useBaseToken() { - currentToken = TestnetERC20Token(getHyperchainBaseToken(currentChainId)); + currentToken = TestnetERC20Token(getZKChainBaseToken(currentChainId)); currentTokenAddress = address(currentToken); _; } @@ -134,7 +135,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke function _commitBatchInfo(uint256 _chainId) internal { //vm.warp(COMMIT_TIMESTAMP_NOT_OLDER + 1 + 1); - GettersFacet hyperchainGetters = GettersFacet(getHyperchainAddress(_chainId)); + GettersFacet zkChainGetters = GettersFacet(getZKChainAddress(_chainId)); IExecutor.StoredBatchInfo memory batchZero; @@ -148,7 +149,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke batchZero.commitment = vm.parseBytes32("0x0000000000000000000000000000000000000000000000000000000000000000"); bytes32 hashedZeroBatch = keccak256(abi.encode(batchZero)); - assertEq(hyperchainGetters.storedBatchHash(0), hashedZeroBatch); + assertEq(zkChainGetters.storedBatchHash(0), hashedZeroBatch); } // use mailbox interface to return exact amount to use as a gas on l2 side, @@ -159,7 +160,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke uint256 _l2GasLimit, uint256 _l2GasPerPubdataByteLimit ) public view returns (uint256) { - MailboxFacet chainMailBox = MailboxFacet(getHyperchainAddress(_chainId)); + MailboxFacet chainMailBox = MailboxFacet(getZKChainAddress(_chainId)); return chainMailBox.l2TransactionBaseCost(_gasPrice, _l2GasLimit, _l2GasPerPubdataByteLimit); } @@ -235,7 +236,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke } } - // deposits ERC20 token to the hyperchain where base token is ETH + // deposits ERC20 token to the ZK chain where base token is ETH // this function use requestL2TransactionTwoBridges function from shared bridge. // tokenAddress should be any ERC20 token, excluding ETH function depositERC20ToEthChain(uint256 l2Value, address tokenAddress) private useGivenToken(tokenAddress) { @@ -338,7 +339,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke } // deposits ERC20 to token with base being also ERC20 - // there are no modifiers so watch out, baseTokenAddress should be base of hyperchain + // there are no modifiers so watch out, baseTokenAddress should be base of ZK chain // currentToken should be different from base function depositERC20ToERC20Chain(uint256 l2Value, address baseTokenAddress) private { uint256 gasPrice = 10000000; @@ -392,7 +393,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke l2ValuesSum[currentTokenAddress] += l2Value; } - // deposits ETH to hyperchain where base is ETH + // deposits ETH to ZK chain where base is ETH function depositEthBase(uint256 l2Value) private { uint256 gasPrice = 10000000; vm.txGasPrice(gasPrice); @@ -485,8 +486,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke bytes32[] memory merkleProof = new bytes32[](1); _setSharedBridgeIsWithdrawalFinalized(currentChainId, l2BatchNumber, l2MessageIndex, false); - uint256 beforeChainBalance = sharedBridge.chainBalance(currentChainId, currentTokenAddress); - uint256 beforeBalance = currentToken.balanceOf(sharedBridgeProxyAddress); + uint256 beforeChainBalance = l1Nullifier.__DEPRECATED_chainBalance(currentChainId, currentTokenAddress); + uint256 beforeBalance = currentToken.balanceOf(address(sharedBridge)); if (beforeChainBalance < amountToWithdraw) { vm.expectRevert("L1AR: not enough funds 2"); @@ -533,10 +534,10 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke // check if the balance was updated correctly if (beforeChainBalance > amountToWithdraw) { assertEq( - beforeChainBalance - sharedBridge.chainBalance(currentChainId, currentTokenAddress), + beforeChainBalance - l1Nullifier.__DEPRECATED_chainBalance(currentChainId, currentTokenAddress), amountToWithdraw ); - assertEq(beforeBalance - currentToken.balanceOf(sharedBridgeProxyAddress), amountToWithdraw); + assertEq(beforeBalance - currentToken.balanceOf(address(sharedBridge)), amountToWithdraw); } } @@ -547,8 +548,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke bytes32[] memory merkleProof = new bytes32[](1); _setSharedBridgeIsWithdrawalFinalized(currentChainId, l2BatchNumber, l2MessageIndex, false); - uint256 beforeChainBalance = sharedBridge.chainBalance(currentChainId, currentTokenAddress); - uint256 beforeBalance = sharedBridgeProxyAddress.balance; + uint256 beforeChainBalance = l1Nullifier.__DEPRECATED_chainBalance(currentChainId, currentTokenAddress); + uint256 beforeBalance = address(sharedBridge).balance; if (beforeChainBalance < amountToWithdraw) { vm.expectRevert("L1AR: not enough funds 2"); @@ -589,10 +590,10 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke // check if the balance was updated correctly if (beforeChainBalance > amountToWithdraw) { assertEq( - beforeChainBalance - sharedBridge.chainBalance(currentChainId, currentTokenAddress), + beforeChainBalance - l1Nullifier.__DEPRECATED_chainBalance(currentChainId, currentTokenAddress), amountToWithdraw ); - assertEq(beforeBalance - sharedBridgeProxyAddress.balance, amountToWithdraw); + assertEq(beforeBalance - address(sharedBridge).balance, amountToWithdraw); } } @@ -600,7 +601,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke uint256 userIndexSeed, uint256 chainIndexSeed, uint256 l2Value - ) public virtual useUser(userIndexSeed) useHyperchain(chainIndexSeed) useBaseToken { + ) public virtual useUser(userIndexSeed) useZKChain(chainIndexSeed) useBaseToken { if (currentTokenAddress == ETH_TOKEN_ADDRESS) { depositEthBase(l2Value); } else { @@ -613,8 +614,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke uint256 chainIndexSeed, uint256 tokenIndexSeed, uint256 l2Value - ) public virtual useUser(userIndexSeed) useHyperchain(chainIndexSeed) useERC20Token(tokenIndexSeed) { - address chainBaseToken = getHyperchainBaseToken(currentChainId); + ) public virtual useUser(userIndexSeed) useZKChain(chainIndexSeed) useERC20Token(tokenIndexSeed) { + address chainBaseToken = getZKChainBaseToken(currentChainId); if (chainBaseToken == ETH_TOKEN_ADDRESS) { depositERC20ToEthChain(l2Value, currentTokenAddress); @@ -631,8 +632,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke uint256 userIndexSeed, uint256 chainIndexSeed, uint256 amountToWithdraw - ) public virtual useUser(userIndexSeed) useHyperchain(chainIndexSeed) { - address token = getHyperchainBaseToken(currentChainId); + ) public virtual useUser(userIndexSeed) useZKChain(chainIndexSeed) { + address token = getZKChainBaseToken(currentChainId); if (token != ETH_TOKEN_ADDRESS) { withdrawERC20Token(amountToWithdraw, token); @@ -643,7 +644,7 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke function getAddressesToExclude() public returns (address[] memory) { addressesToExclude.push(bridgehubProxyAddress); - addressesToExclude.push(sharedBridgeProxyAddress); + addressesToExclude.push(address(sharedBridge)); for (uint256 i = 0; i < users.length; i++) { addressesToExclude.push(users[i]); @@ -653,8 +654,8 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke addressesToExclude.push(l2ContractAddresses[i]); } - for (uint256 i = 0; i < hyperchainIds.length; i++) { - addressesToExclude.push(getHyperchainAddress(hyperchainIds[i])); + for (uint256 i = 0; i < zkChainIds.length; i++) { + addressesToExclude.push(getZKChainAddress(zkChainIds[i])); } return addressesToExclude; @@ -668,18 +669,18 @@ contract BridgeHubInvariantTests is L1ContractDeployer, HyperchainDeployer, Toke _registerNewTokens(tokens); _deployEra(); - _deployHyperchain(ETH_TOKEN_ADDRESS); - _deployHyperchain(ETH_TOKEN_ADDRESS); - _deployHyperchain(tokens[0]); - _deployHyperchain(tokens[0]); - _deployHyperchain(tokens[1]); - _deployHyperchain(tokens[1]); - - for (uint256 i = 0; i < hyperchainIds.length; i++) { + _deployZKChain(ETH_TOKEN_ADDRESS); + _deployZKChain(ETH_TOKEN_ADDRESS); + _deployZKChain(tokens[0]); + _deployZKChain(tokens[0]); + _deployZKChain(tokens[1]); + _deployZKChain(tokens[1]); + + for (uint256 i = 0; i < zkChainIds.length; i++) { address contractAddress = makeAddr(string(abi.encode("contract", i))); l2ContractAddresses.push(contractAddress); - _addL2ChainContract(hyperchainIds[i], contractAddress); + _addL2ChainContract(zkChainIds[i], contractAddress); } } @@ -721,7 +722,7 @@ contract BoundedBridgeHubInvariantTests is BridgeHubInvariantTests { function testBoundedBridgeHubInvariant() internal {} } -// contract InvariantTesterHyperchains is Test { +// contract InvariantTesterZKChains is Test { // BoundedBridgeHubInvariantTests tests; // function setUp() public { diff --git a/l1-contracts/test/foundry/l1/integration/DeploymentTest.t.sol b/l1-contracts/test/foundry/l1/integration/DeploymentTest.t.sol new file mode 100644 index 000000000..9224eea05 --- /dev/null +++ b/l1-contracts/test/foundry/l1/integration/DeploymentTest.t.sol @@ -0,0 +1,115 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {Test} from "forge-std/Test.sol"; +import {Vm} from "forge-std/Vm.sol"; + +import {L2TransactionRequestDirect, L2TransactionRequestTwoBridgesOuter} from "contracts/bridgehub/IBridgehub.sol"; +import {TestnetERC20Token} from "contracts/dev-contracts/TestnetERC20Token.sol"; +import {MailboxFacet} from "contracts/state-transition/chain-deps/facets/Mailbox.sol"; +import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; +import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol"; +import {IExecutor} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; +import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; +import {TokenDeployer} from "./_SharedTokenDeployer.t.sol"; +import {ZKChainDeployer} from "./_SharedZKChainDeployer.t.sol"; +import {L2TxMocker} from "./_SharedL2TxMocker.t.sol"; +import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; +import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK} from "contracts/common/Config.sol"; +import {L2CanonicalTransaction, L2Message} from "contracts/common/Messaging.sol"; +import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; +import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; +import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; +import {IZKChain} from "contracts/state-transition/chain-interfaces/IZKChain.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; + +contract DeploymentTests is L1ContractDeployer, ZKChainDeployer, TokenDeployer, L2TxMocker { + uint256 constant TEST_USERS_COUNT = 10; + address[] public users; + address[] public l2ContractAddresses; + + // generate MAX_USERS addresses and append it to users array + function _generateUserAddresses() internal { + require(users.length == 0, "Addresses already generated"); + + for (uint256 i = 0; i < TEST_USERS_COUNT; i++) { + address newAddress = makeAddr(string(abi.encode("account", i))); + users.push(newAddress); + } + } + + function prepare() public { + _generateUserAddresses(); + + _deployL1Contracts(); + _deployTokens(); + _registerNewTokens(tokens); + + _deployEra(); + // _deployZKChain(ETH_TOKEN_ADDRESS); + // _deployZKChain(ETH_TOKEN_ADDRESS); + // _deployZKChain(tokens[0]); + // _deployZKChain(tokens[0]); + // _deployZKChain(tokens[1]); + // _deployZKChain(tokens[1]); + + for (uint256 i = 0; i < zkChainIds.length; i++) { + address contractAddress = makeAddr(string(abi.encode("contract", i))); + l2ContractAddresses.push(contractAddress); + + _addL2ChainContract(zkChainIds[i], contractAddress); + } + } + + function setUp() public { + prepare(); + } + + // Check whether the sum of ETH deposits from tests, updated on each deposit and withdrawal, + // equals the balance of L1Shared bridge. + function test_initialDeployment() public { + uint256 chainId = zkChainIds[0]; + IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); + address newChainAddress = bridgehub.getZKChain(chainId); + address admin = IZKChain(bridgehub.getZKChain(chainId)).getAdmin(); + IChainTypeManager ctm = IChainTypeManager(bridgehub.chainTypeManager(chainId)); + + assertNotEq(admin, address(0)); + assertNotEq(newChainAddress, address(0)); + + address[] memory chainAddresses = bridgehub.getAllZKChains(); + assertEq(chainAddresses.length, 1); + assertEq(chainAddresses[0], newChainAddress); + + uint256[] memory chainIds = bridgehub.getAllZKChainChainIDs(); + assertEq(chainIds.length, 1); + assertEq(chainIds[0], chainId); + + uint256 protocolVersion = ctm.getProtocolVersion(chainId); + assertEq(protocolVersion, 0); + } + + function test_bridgehubSetter() public { + IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); + uint256 chainId = zkChainIds[0]; + IChainTypeManager chainTypeManager = IChainTypeManager(bridgehub.chainTypeManager(chainId)); + uint256 randomChainId = 123456; + + vm.mockCall( + address(chainTypeManager), + abi.encodeWithSelector(IChainTypeManager.getZKChainLegacy.selector, randomChainId), + abi.encode(address(0x01)) + ); + vm.store(address(bridgehub), keccak256(abi.encode(randomChainId, 205)), bytes32(uint256(uint160(1)))); + vm.store( + address(bridgehub), + keccak256(abi.encode(randomChainId, 204)), + bytes32(uint256(uint160(address(chainTypeManager)))) + ); + bridgehub.setLegacyBaseTokenAssetId(randomChainId); + bridgehub.setLegacyChainAddress(randomChainId); + } + + // add this to be excluded from coverage report + function test() internal override {} +} diff --git a/l1-contracts/test/foundry/l1/integration/GatewayTests.t.sol b/l1-contracts/test/foundry/l1/integration/GatewayTests.t.sol new file mode 100644 index 000000000..e4e14e10f --- /dev/null +++ b/l1-contracts/test/foundry/l1/integration/GatewayTests.t.sol @@ -0,0 +1,317 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {Test} from "forge-std/Test.sol"; +import {Vm} from "forge-std/Vm.sol"; +import "forge-std/console.sol"; + +import {L2TransactionRequestDirect, L2TransactionRequestTwoBridgesOuter, BridgehubMintCTMAssetData, BridgehubBurnCTMAssetData} from "contracts/bridgehub/IBridgehub.sol"; +import {TestnetERC20Token} from "contracts/dev-contracts/TestnetERC20Token.sol"; +import {MailboxFacet} from "contracts/state-transition/chain-deps/facets/Mailbox.sol"; +import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; +import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol"; +import {IExecutor} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; +import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; +import {TokenDeployer} from "./_SharedTokenDeployer.t.sol"; +import {ZKChainDeployer} from "./_SharedZKChainDeployer.t.sol"; +import {GatewayDeployer} from "./_SharedGatewayDeployer.t.sol"; +import {L2TxMocker} from "./_SharedL2TxMocker.t.sol"; +import {ETH_TOKEN_ADDRESS, SETTLEMENT_LAYER_RELAY_SENDER} from "contracts/common/Config.sol"; +import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK} from "contracts/common/Config.sol"; +import {L2CanonicalTransaction} from "contracts/common/Messaging.sol"; +import {L2Message} from "contracts/common/Messaging.sol"; +import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; +import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; +import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; + +import {Ownable} from "@openzeppelin/contracts-v4/access/Ownable.sol"; +import {IZKChain} from "contracts/state-transition/chain-interfaces/IZKChain.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; +import {AdminFacet} from "contracts/state-transition/chain-deps/facets/Admin.sol"; +import {AddressAliasHelper} from "contracts/vendor/AddressAliasHelper.sol"; +import {TxStatus} from "contracts/common/Messaging.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; +import {IncorrectBridgeHubAddress} from "contracts/common/L1ContractErrors.sol"; + +contract GatewayTests is L1ContractDeployer, ZKChainDeployer, TokenDeployer, L2TxMocker, GatewayDeployer { + uint256 constant TEST_USERS_COUNT = 10; + address[] public users; + address[] public l2ContractAddresses; + + uint256 migratingChainId = 10; + uint256 gatewayChainId = 11; + uint256 mintChainId = 12; + + // generate MAX_USERS addresses and append it to users array + function _generateUserAddresses() internal { + require(users.length == 0, "Addresses already generated"); + + for (uint256 i = 0; i < TEST_USERS_COUNT; i++) { + address newAddress = makeAddr(string(abi.encode("account", i))); + users.push(newAddress); + } + } + + function prepare() public { + _generateUserAddresses(); + + _deployL1Contracts(); + _deployTokens(); + _registerNewTokens(tokens); + + _deployEra(); + _deployZKChain(ETH_TOKEN_ADDRESS); + acceptPendingAdmin(); + _deployZKChain(ETH_TOKEN_ADDRESS); + acceptPendingAdmin(); + // _deployZKChain(tokens[0]); + // _deployZKChain(tokens[0]); + // _deployZKChain(tokens[1]); + // _deployZKChain(tokens[1]); + + for (uint256 i = 0; i < zkChainIds.length; i++) { + address contractAddress = makeAddr(string(abi.encode("contract", i))); + l2ContractAddresses.push(contractAddress); + + _addL2ChainContract(zkChainIds[i], contractAddress); + // _registerL2SharedBridge(zkChainIds[i], contractAddress); + } + + _initializeGatewayScript(); + + vm.deal(Ownable(l1Script.getBridgehubProxyAddress()).owner(), 100000000000000000000000000000000000); + vm.deal(l1Script.getOwnerAddress(), 100000000000000000000000000000000000); + IZKChain chain = IZKChain(IBridgehub(l1Script.getBridgehubProxyAddress()).getZKChain(migratingChainId)); + IZKChain chain2 = IZKChain(IBridgehub(l1Script.getBridgehubProxyAddress()).getZKChain(gatewayChainId)); + vm.deal(chain.getAdmin(), 100000000000000000000000000000000000); + vm.deal(chain2.getAdmin(), 100000000000000000000000000000000000); + + // vm.deal(msg.sender, 100000000000000000000000000000000000); + // vm.deal(l1Script.getBridgehubProxyAddress(), 100000000000000000000000000000000000); + } + + function setUp() public { + prepare(); + } + + // + function test_registerGateway() public { + gatewayScript.registerGateway(); + } + + // + function test_moveChainToGateway() public { + gatewayScript.registerGateway(); + gatewayScript.moveChainToGateway(); + // require(bridgehub.settlementLayer()) + } + + function test_l2Registration() public { + gatewayScript.registerGateway(); + gatewayScript.moveChainToGateway(); + gatewayScript.registerL2Contracts(); + } + + function test_finishMoveChain() public { + finishMoveChain(); + } + + function test_startMessageToL3() public { + finishMoveChain(); + IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); + uint256 expectedValue = 1000000000000000000000; + + L2TransactionRequestDirect memory request = _createL2TransactionRequestDirect( + migratingChainId, + expectedValue, + 0, + 72000000, + 800, + "0x" + ); + bridgehub.requestL2TransactionDirect{value: expectedValue}(request); + } + + function test_forwardToL3OnGateway() public { + finishMoveChain(); + + IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); + vm.chainId(12345); + vm.startBroadcast(SETTLEMENT_LAYER_RELAY_SENDER); + bridgehub.forwardTransactionOnGateway(mintChainId, bytes32(0), 0); + vm.stopBroadcast(); + } + + function test_recoverFromFailedChainMigration() public { + gatewayScript.registerGateway(); + gatewayScript.moveChainToGateway(); + + // Setup + IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); + IChainTypeManager ctm = IChainTypeManager(l1Script.getCTM()); + bytes32 assetId = bridgehub.ctmAssetIdFromChainId(migratingChainId); + bytes memory transferData; + + { + IZKChain chain = IZKChain(bridgehub.getZKChain(migratingChainId)); + bytes memory initialDiamondCut = l1Script.getInitialDiamondCutData(); + bytes memory chainData = abi.encode(chain.getProtocolVersion()); + bytes memory ctmData = abi.encode(address(1), msg.sender, ctm.protocolVersion(), initialDiamondCut); + BridgehubBurnCTMAssetData memory data = BridgehubBurnCTMAssetData({ + chainId: migratingChainId, + ctmData: ctmData, + chainData: chainData + }); + transferData = abi.encode(data); + } + + address chainAdmin = IZKChain(bridgehub.getZKChain(migratingChainId)).getAdmin(); + IL1AssetRouter assetRouter = IL1AssetRouter(address(bridgehub.sharedBridge())); + bytes32 l2TxHash = keccak256("l2TxHash"); + uint256 l2BatchNumber = 5; + uint256 l2MessageIndex = 0; + uint16 l2TxNumberInBatch = 0; + bytes32[] memory merkleProof = new bytes32[](1); + bytes32 txDataHash = keccak256(bytes.concat(bytes1(0x01), abi.encode(chainAdmin, assetId, transferData))); + + // Mock Call for Msg Inclusion + vm.mockCall( + address(bridgehub), + abi.encodeWithSelector( + IBridgehub.proveL1ToL2TransactionStatus.selector, + migratingChainId, + l2TxHash, + l2BatchNumber, + l2MessageIndex, + l2TxNumberInBatch, + merkleProof, + TxStatus.Failure + ), + abi.encode(true) + ); + + // Set Deposit Happened + vm.startBroadcast(address(bridgeHub)); + assetRouter.bridgehubConfirmL2Transaction({ + _chainId: migratingChainId, + _txDataHash: txDataHash, + _txHash: l2TxHash + }); + vm.stopBroadcast(); + + vm.startBroadcast(); + l1Nullifier.bridgeRecoverFailedTransfer({ + _chainId: migratingChainId, + _depositSender: chainAdmin, + _assetId: assetId, + _assetData: transferData, + _l2TxHash: l2TxHash, + _l2BatchNumber: l2BatchNumber, + _l2MessageIndex: l2MessageIndex, + _l2TxNumberInBatch: l2TxNumberInBatch, + _merkleProof: merkleProof + }); + vm.stopBroadcast(); + } + + function test_registerAlreadyDeployedZKChain() public { + gatewayScript.registerGateway(); + IChainTypeManager stm = IChainTypeManager(l1Script.getCTM()); + IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); + address owner = Ownable(address(bridgeHub)).owner(); + + { + uint256 chainId = currentZKChainId++; + bytes32 baseTokenAssetId = DataEncoding.encodeNTVAssetId(chainId, ETH_TOKEN_ADDRESS); + + address chain = _deployZkChain( + chainId, + baseTokenAssetId, + address(bridgehub.sharedBridge()), + owner, + stm.protocolVersion(), + stm.storedBatchZero(), + address(bridgehub) + ); + + address stmAddr = IZKChain(chain).getChainTypeManager(); + + vm.startBroadcast(owner); + bridgeHub.addChainTypeManager(stmAddr); + bridgeHub.addTokenAssetId(baseTokenAssetId); + bridgeHub.registerAlreadyDeployedZKChain(chainId, chain); + vm.stopBroadcast(); + + address bridgeHubStmForChain = bridgeHub.chainTypeManager(chainId); + bytes32 bridgeHubBaseAssetIdForChain = bridgeHub.baseTokenAssetId(chainId); + address bridgeHubChainAddressdForChain = bridgeHub.getZKChain(chainId); + address bhAddr = IZKChain(chain).getBridgehub(); + + assertEq(bridgeHubStmForChain, stmAddr); + assertEq(bridgeHubBaseAssetIdForChain, baseTokenAssetId); + assertEq(bridgeHubChainAddressdForChain, chain); + assertEq(bhAddr, address(bridgeHub)); + } + + { + uint256 chainId = currentZKChainId++; + bytes32 baseTokenAssetId = DataEncoding.encodeNTVAssetId(chainId, ETH_TOKEN_ADDRESS); + address chain = _deployZkChain( + chainId, + baseTokenAssetId, + address(bridgehub.sharedBridge()), + owner, + stm.protocolVersion(), + stm.storedBatchZero(), + address(bridgehub.sharedBridge()) + ); + + address stmAddr = IZKChain(chain).getChainTypeManager(); + + vm.startBroadcast(owner); + bridgeHub.addTokenAssetId(baseTokenAssetId); + vm.expectRevert( + abi.encodeWithSelector(IncorrectBridgeHubAddress.selector, address(bridgehub.sharedBridge())) + ); + bridgeHub.registerAlreadyDeployedZKChain(chainId, chain); + vm.stopBroadcast(); + } + } + + function finishMoveChain() public { + IBridgehub bridgehub = IBridgehub(l1Script.getBridgehubProxyAddress()); + IChainTypeManager ctm = IChainTypeManager(l1Script.getCTM()); + IZKChain migratingChain = IZKChain(bridgehub.getZKChain(migratingChainId)); + bytes32 assetId = bridgehub.ctmAssetIdFromChainId(migratingChainId); + + vm.startBroadcast(Ownable(address(bridgehub)).owner()); + bridgehub.registerSettlementLayer(gatewayChainId, true); + vm.stopBroadcast(); + + bytes32 baseTokenAssetId = keccak256("baseTokenAssetId"); + bytes memory initialDiamondCut = l1Script.getInitialDiamondCutData(); + bytes memory chainData = abi.encode(AdminFacet(address(migratingChain)).prepareChainCommitment()); + bytes memory ctmData = abi.encode(baseTokenAssetId, msg.sender, ctm.protocolVersion(), initialDiamondCut); + BridgehubMintCTMAssetData memory data = BridgehubMintCTMAssetData({ + chainId: mintChainId, + baseTokenAssetId: baseTokenAssetId, + ctmData: ctmData, + chainData: chainData + }); + bytes memory bridgehubMintData = abi.encode(data); + vm.startBroadcast(address(bridgehub.sharedBridge())); + uint256 currentChainId = block.chainid; + vm.chainId(migratingChainId); + bridgehub.bridgeMint(gatewayChainId, assetId, bridgehubMintData); + vm.stopBroadcast(); + vm.chainId(currentChainId); + + assertEq(bridgehub.baseTokenAssetId(mintChainId), baseTokenAssetId); + IZKChain mintedZKChain = IZKChain(bridgehub.getZKChain(mintChainId)); + assertEq(mintedZKChain.getBaseTokenAssetId(), baseTokenAssetId); + } + + // add this to be excluded from coverage report + function test() internal override {} +} diff --git a/l1-contracts/test/foundry/integration/_SharedGatewayDeployer.t.sol b/l1-contracts/test/foundry/l1/integration/_SharedGatewayDeployer.t.sol similarity index 52% rename from l1-contracts/test/foundry/integration/_SharedGatewayDeployer.t.sol rename to l1-contracts/test/foundry/l1/integration/_SharedGatewayDeployer.t.sol index fbc6cac3e..11b320367 100644 --- a/l1-contracts/test/foundry/integration/_SharedGatewayDeployer.t.sol +++ b/l1-contracts/test/foundry/l1/integration/_SharedGatewayDeployer.t.sol @@ -4,21 +4,21 @@ pragma solidity 0.8.24; import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; import {GatewayScript} from "deploy-scripts/Gateway.s.sol"; import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; -import "@openzeppelin/contracts/utils/Strings.sol"; +import "@openzeppelin/contracts-v4/utils/Strings.sol"; contract GatewayDeployer is L1ContractDeployer { GatewayScript gatewayScript; function _initializeGatewayScript() internal { - vm.setEnv("L1_CONFIG", "/test/foundry/integration/deploy-scripts/script-config/config-deploy-l1.toml"); - vm.setEnv("L1_OUTPUT", "/test/foundry/integration/deploy-scripts/script-out/output-deploy-l1.toml"); + vm.setEnv("L1_CONFIG", "/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-l1.toml"); + vm.setEnv("L1_OUTPUT", "/test/foundry/l1/integration/deploy-scripts/script-out/output-deploy-l1.toml"); vm.setEnv( - "HYPERCHAIN_CONFIG", - "/test/foundry/integration/deploy-scripts/script-out/output-deploy-hyperchain-10.toml" + "ZK_CHAIN_CONFIG", + "/test/foundry/l1/integration/deploy-scripts/script-out/output-deploy-zk-chain-10.toml" ); vm.setEnv( "GATEWAY_CONFIG", - "/test/foundry/integration/deploy-scripts/script-out/output-deploy-hyperchain-11.toml" + "/test/foundry/l1/integration/deploy-scripts/script-out/output-deploy-zk-chain-11.toml" ); gatewayScript = new GatewayScript(); diff --git a/l1-contracts/test/foundry/integration/_SharedL1ContractDeployer.t.sol b/l1-contracts/test/foundry/l1/integration/_SharedL1ContractDeployer.t.sol similarity index 54% rename from l1-contracts/test/foundry/integration/_SharedL1ContractDeployer.t.sol rename to l1-contracts/test/foundry/l1/integration/_SharedL1ContractDeployer.t.sol index 55413c702..49c6e5c43 100644 --- a/l1-contracts/test/foundry/integration/_SharedL1ContractDeployer.t.sol +++ b/l1-contracts/test/foundry/l1/integration/_SharedL1ContractDeployer.t.sol @@ -5,8 +5,12 @@ import {Test} from "forge-std/Test.sol"; import {StdStorage, stdStorage} from "forge-std/Test.sol"; import {DeployL1Script} from "deploy-scripts/DeployL1.s.sol"; +import {GenerateForceDeploymentsData} from "deploy-scripts/GenerateForceDeploymentsData.s.sol"; import {Bridgehub} from "contracts/bridgehub/Bridgehub.sol"; -import {L1AssetRouter} from "contracts/bridge/L1AssetRouter.sol"; +import {L1AssetRouter} from "contracts/bridge/asset-router/L1AssetRouter.sol"; +import {L1Nullifier} from "contracts/bridge/L1Nullifier.sol"; +import {L1NativeTokenVault} from "contracts/bridge/ntv/L1NativeTokenVault.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; contract L1ContractDeployer is Test { using stdStorage for StdStorage; @@ -15,28 +19,41 @@ contract L1ContractDeployer is Test { address bridgehubOwnerAddress; Bridgehub bridgeHub; - address public sharedBridgeProxyAddress; L1AssetRouter public sharedBridge; + L1Nullifier public l1Nullifier; + L1NativeTokenVault public l1NativeTokenVault; DeployL1Script l1Script; + GenerateForceDeploymentsData forceDeploymentsScript; function _deployL1Contracts() internal { - vm.setEnv("L1_CONFIG", "/test/foundry/integration/deploy-scripts/script-config/config-deploy-l1.toml"); - vm.setEnv("L1_OUTPUT", "/test/foundry/integration/deploy-scripts/script-out/output-deploy-l1.toml"); + vm.setEnv("L1_CONFIG", "/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-l1.toml"); + vm.setEnv("L1_OUTPUT", "/test/foundry/l1/integration/deploy-scripts/script-out/output-deploy-l1.toml"); vm.setEnv( - "HYPERCHAIN_CONFIG", - "/test/foundry/integration/deploy-scripts/script-out/output-deploy-hyperchain-era.toml" + "ZK_CHAIN_CONFIG", + "/test/foundry/l1/integration/deploy-scripts/script-out/output-deploy-zk-chain-era.toml" ); - + vm.setEnv( + "FORCE_DEPLOYMENTS_CONFIG", + "/test/foundry/l1/integration/deploy-scripts/script-config/generate-force-deployments-data.toml" + ); + forceDeploymentsScript = new GenerateForceDeploymentsData(); l1Script = new DeployL1Script(); + forceDeploymentsScript.run(); l1Script.run(); bridgehubProxyAddress = l1Script.getBridgehubProxyAddress(); bridgeHub = Bridgehub(bridgehubProxyAddress); - sharedBridgeProxyAddress = l1Script.getSharedBridgeProxyAddress(); + address sharedBridgeProxyAddress = l1Script.getSharedBridgeProxyAddress(); sharedBridge = L1AssetRouter(sharedBridgeProxyAddress); + address l1NullifierProxyAddress = l1Script.getL1NullifierProxyAddress(); + l1Nullifier = L1Nullifier(l1NullifierProxyAddress); + + address l1NativeTokenVaultProxyAddress = l1Script.getNativeTokenVaultProxyAddress(); + l1NativeTokenVault = L1NativeTokenVault(payable(l1NativeTokenVaultProxyAddress)); + _acceptOwnership(); _setEraBatch(); @@ -58,9 +75,10 @@ contract L1ContractDeployer is Test { } function _registerNewToken(address _tokenAddress) internal { - if (!bridgeHub.tokenIsRegistered(_tokenAddress)) { + bytes32 tokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, _tokenAddress); + if (!bridgeHub.assetIdIsRegistered(tokenAssetId)) { vm.prank(bridgehubOwnerAddress); - bridgeHub.addToken(_tokenAddress); + bridgeHub.addTokenAssetId(tokenAssetId); } } @@ -72,8 +90,8 @@ contract L1ContractDeployer is Test { function _setSharedBridgeChainBalance(uint256 _chainId, address _token, uint256 _value) internal { stdstore - .target(address(sharedBridge)) - .sig(sharedBridge.chainBalance.selector) + .target(address(l1Nullifier)) + .sig(l1Nullifier.__DEPRECATED_chainBalance.selector) .with_key(_chainId) .with_key(_token) .checked_write(_value); @@ -86,8 +104,8 @@ contract L1ContractDeployer is Test { bool _isFinalized ) internal { stdstore - .target(address(sharedBridge)) - .sig(sharedBridge.isWithdrawalFinalized.selector) + .target(address(l1Nullifier)) + .sig(l1Nullifier.isWithdrawalFinalized.selector) .with_key(_chainId) .with_key(_l2BatchNumber) .with_key(_l2ToL1MessageNumber) diff --git a/l1-contracts/test/foundry/integration/_SharedL2TxMocker.t.sol b/l1-contracts/test/foundry/l1/integration/_SharedL2TxMocker.t.sol similarity index 100% rename from l1-contracts/test/foundry/integration/_SharedL2TxMocker.t.sol rename to l1-contracts/test/foundry/l1/integration/_SharedL2TxMocker.t.sol diff --git a/l1-contracts/test/foundry/integration/_SharedTokenDeployer.t.sol b/l1-contracts/test/foundry/l1/integration/_SharedTokenDeployer.t.sol similarity index 77% rename from l1-contracts/test/foundry/integration/_SharedTokenDeployer.t.sol rename to l1-contracts/test/foundry/l1/integration/_SharedTokenDeployer.t.sol index bbfcb4090..8696fd2a6 100644 --- a/l1-contracts/test/foundry/integration/_SharedTokenDeployer.t.sol +++ b/l1-contracts/test/foundry/l1/integration/_SharedTokenDeployer.t.sol @@ -9,7 +9,10 @@ contract TokenDeployer is Test { DeployErc20Script private deployScript; function _deployTokens() internal { - vm.setEnv("TOKENS_CONFIG", "/test/foundry/integration/deploy-scripts/script-config/config-deploy-erc20.toml"); + vm.setEnv( + "TOKENS_CONFIG", + "/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-erc20.toml" + ); deployScript = new DeployErc20Script(); deployScript.run(); diff --git a/l1-contracts/test/foundry/l1/integration/_SharedZKChainDeployer.t.sol b/l1-contracts/test/foundry/l1/integration/_SharedZKChainDeployer.t.sol new file mode 100644 index 000000000..747a6c311 --- /dev/null +++ b/l1-contracts/test/foundry/l1/integration/_SharedZKChainDeployer.t.sol @@ -0,0 +1,179 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {StdStorage, stdStorage} from "forge-std/Test.sol"; + +import {L1ContractDeployer} from "./_SharedL1ContractDeployer.t.sol"; +import {RegisterZKChainScript} from "deploy-scripts/RegisterZKChain.s.sol"; +import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; +import "@openzeppelin/contracts-v4/utils/Strings.sol"; +import {IZKChain} from "contracts/state-transition/chain-interfaces/IZKChain.sol"; +import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; +import {DiamondProxy} from "contracts/state-transition/chain-deps/DiamondProxy.sol"; +import {IDiamondInit} from "contracts/state-transition/chain-interfaces/IDiamondInit.sol"; + +contract ZKChainDeployer is L1ContractDeployer { + using stdStorage for StdStorage; + + RegisterZKChainScript deployScript; + + struct ZKChainDescription { + uint256 zkChainChainId; + address baseToken; + uint256 bridgehubCreateNewChainSalt; + bool validiumMode; + address validatorSenderOperatorCommitEth; + address validatorSenderOperatorBlobsEth; + uint128 baseTokenGasPriceMultiplierNominator; + uint128 baseTokenGasPriceMultiplierDenominator; + } + + uint256 currentZKChainId = 10; + uint256 eraZKChainId = 9; + uint256[] public zkChainIds; + + function _deployEra() internal { + vm.setEnv( + "ZK_CHAIN_CONFIG", + "/test/foundry/l1/integration/deploy-scripts/script-out/output-deploy-zk-chain-era.toml" + ); + + deployScript = new RegisterZKChainScript(); + saveZKChainConfig(_getDefaultDescription(eraZKChainId, ETH_TOKEN_ADDRESS, eraZKChainId)); + vm.warp(100); + deployScript.run(); + zkChainIds.push(eraZKChainId); + } + + function _deployZKChain(address _baseToken) internal { + vm.setEnv( + "ZK_CHAIN_CONFIG", + string.concat( + "/test/foundry/l1/integration/deploy-scripts/script-out/output-deploy-zk-chain-", + Strings.toString(currentZKChainId), + ".toml" + ) + ); + zkChainIds.push(currentZKChainId); + saveZKChainConfig(_getDefaultDescription(currentZKChainId, _baseToken, currentZKChainId)); + currentZKChainId++; + deployScript.run(); + } + + function _getDefaultDescription( + uint256 __chainId, + address __baseToken, + uint256 __salt + ) internal returns (ZKChainDescription memory description) { + description = ZKChainDescription({ + zkChainChainId: __chainId, + baseToken: __baseToken, + bridgehubCreateNewChainSalt: __salt, + validiumMode: false, + validatorSenderOperatorCommitEth: address(0), + validatorSenderOperatorBlobsEth: address(1), + baseTokenGasPriceMultiplierNominator: uint128(1), + baseTokenGasPriceMultiplierDenominator: uint128(1) + }); + } + + function saveZKChainConfig(ZKChainDescription memory description) public { + string memory serialized; + + vm.serializeAddress("toml1", "owner_address", 0x70997970C51812dc3A010C7d01b50e0d17dc79C8); + vm.serializeUint("chain", "chain_chain_id", description.zkChainChainId); + vm.serializeAddress("chain", "base_token_addr", description.baseToken); + vm.serializeUint("chain", "bridgehub_create_new_chain_salt", description.bridgehubCreateNewChainSalt); + + uint256 validiumMode = 0; + + if (description.validiumMode) { + validiumMode = 1; + } + + vm.serializeUint("chain", "validium_mode", validiumMode); + vm.serializeAddress( + "chain", + "validator_sender_operator_commit_eth", + description.validatorSenderOperatorCommitEth + ); + vm.serializeAddress( + "chain", + "validator_sender_operator_blobs_eth", + description.validatorSenderOperatorBlobsEth + ); + vm.serializeUint( + "chain", + "base_token_gas_price_multiplier_nominator", + description.baseTokenGasPriceMultiplierNominator + ); + vm.serializeUint("chain", "governance_min_delay", 0); + vm.serializeAddress("chain", "governance_security_council_address", address(0)); + + string memory single_serialized = vm.serializeUint( + "chain", + "base_token_gas_price_multiplier_denominator", + description.baseTokenGasPriceMultiplierDenominator + ); + + string memory toml = vm.serializeString("toml1", "chain", single_serialized); + string memory path = string.concat(vm.projectRoot(), vm.envString("ZK_CHAIN_CONFIG")); + vm.writeToml(toml, path); + } + + function getZKChainAddress(uint256 _chainId) public view returns (address) { + return bridgeHub.getZKChain(_chainId); + } + + function getZKChainBaseToken(uint256 _chainId) public view returns (address) { + return bridgeHub.baseToken(_chainId); + } + + function acceptPendingAdmin() public { + IZKChain chain = IZKChain(bridgeHub.getZKChain(currentZKChainId - 1)); + address admin = chain.getPendingAdmin(); + vm.startBroadcast(admin); + chain.acceptAdmin(); + vm.stopBroadcast(); + vm.deal(admin, 10000000000000000000000000); + } + + // add this to be excluded from coverage report + function testZKChainDeployer() internal {} + + function _deployZkChain( + uint256 _chainId, + bytes32 _baseTokenAssetId, + address _sharedBridge, + address _admin, + uint256 _protocolVersion, + bytes32 _storedBatchZero, + address _bridgeHub + ) internal returns (address) { + Diamond.DiamondCutData memory diamondCut = abi.decode( + l1Script.getInitialDiamondCutData(), + (Diamond.DiamondCutData) + ); + bytes memory initData; + + { + initData = bytes.concat( + IDiamondInit.initialize.selector, + bytes32(_chainId), + bytes32(uint256(uint160(address(_bridgeHub)))), + bytes32(uint256(uint160(address(this)))), + bytes32(_protocolVersion), + bytes32(uint256(uint160(_admin))), + bytes32(uint256(uint160(address(0x1337)))), + _baseTokenAssetId, + bytes32(uint256(uint160(_sharedBridge))), + _storedBatchZero, + diamondCut.initCalldata + ); + } + diamondCut.initCalldata = initData; + DiamondProxy hyperchainContract = new DiamondProxy{salt: bytes32(0)}(block.chainid, diamondCut); + return address(hyperchainContract); + } +} diff --git a/l1-contracts/test/foundry/integration/deploy-scripts/script-config/config-deploy-erc20.toml b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-erc20.toml similarity index 100% rename from l1-contracts/test/foundry/integration/deploy-scripts/script-config/config-deploy-erc20.toml rename to l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-erc20.toml diff --git a/l1-contracts/test/foundry/integration/deploy-scripts/script-config/config-deploy-l1.toml b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-l1.toml similarity index 100% rename from l1-contracts/test/foundry/integration/deploy-scripts/script-config/config-deploy-l1.toml rename to l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-l1.toml diff --git a/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-zk-chain-10.toml b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-zk-chain-10.toml new file mode 100644 index 000000000..8ce96fda5 --- /dev/null +++ b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-zk-chain-10.toml @@ -0,0 +1,13 @@ +owner_address = "0x70997970C51812dc3A010C7d01b50e0d17dc79C8" + +[chain] +base_token_addr = "0x0000000000000000000000000000000000000001" +base_token_gas_price_multiplier_denominator = 1 +base_token_gas_price_multiplier_nominator = 1 +bridgehub_create_new_chain_salt = 10 +chain_chain_id = 10 +governance_min_delay = 0 +governance_security_council_address = "0x0000000000000000000000000000000000000000" +validator_sender_operator_blobs_eth = "0x0000000000000000000000000000000000000001" +validator_sender_operator_commit_eth = "0x0000000000000000000000000000000000000000" +validium_mode = 0 diff --git a/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-zk-chain-11.toml b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-zk-chain-11.toml new file mode 100644 index 000000000..5e4e1dce8 --- /dev/null +++ b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-zk-chain-11.toml @@ -0,0 +1,13 @@ +owner_address = "0x70997970C51812dc3A010C7d01b50e0d17dc79C8" + +[chain] +base_token_addr = "0x0000000000000000000000000000000000000001" +base_token_gas_price_multiplier_denominator = 1 +base_token_gas_price_multiplier_nominator = 1 +bridgehub_create_new_chain_salt = 11 +chain_chain_id = 11 +governance_min_delay = 0 +governance_security_council_address = "0x0000000000000000000000000000000000000000" +validator_sender_operator_blobs_eth = "0x0000000000000000000000000000000000000001" +validator_sender_operator_commit_eth = "0x0000000000000000000000000000000000000000" +validium_mode = 0 diff --git a/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-zk-chain-era.toml b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-zk-chain-era.toml new file mode 100644 index 000000000..39ab26fe6 --- /dev/null +++ b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/config-deploy-zk-chain-era.toml @@ -0,0 +1,13 @@ +owner_address = "0x70997970C51812dc3A010C7d01b50e0d17dc79C8" + +[chain] +base_token_addr = "0x0000000000000000000000000000000000000001" +base_token_gas_price_multiplier_denominator = 1 +base_token_gas_price_multiplier_nominator = 1 +bridgehub_create_new_chain_salt = 9 +chain_chain_id = 9 +governance_min_delay = 0 +governance_security_council_address = "0x0000000000000000000000000000000000000000" +validator_sender_operator_blobs_eth = "0x0000000000000000000000000000000000000001" +validator_sender_operator_commit_eth = "0x0000000000000000000000000000000000000000" +validium_mode = 0 diff --git a/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/generate-force-deployments-data.toml b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/generate-force-deployments-data.toml new file mode 100644 index 000000000..15a0d7d43 --- /dev/null +++ b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-config/generate-force-deployments-data.toml @@ -0,0 +1,7 @@ +era_chain_id = 9 +chain_id = 270 +l1_shared_bridge = "0x70997970C51812dc3A010C7d01b50e0d17dc79C8" +governance = "0x70997970C51812dc3A010C7d01b50e0d17dc79C8" +l2_legacy_shared_bridge = "0x70997970C51812dc3A010C7d01b50e0d17dc79C8" +l2_token_beacon = "0x70997970C51812dc3A010C7d01b50e0d17dc79C8" +l2_contracts_deployed_already = false diff --git a/l1-contracts/test/foundry/integration/deploy-scripts/script-out/.gitkeep b/l1-contracts/test/foundry/l1/integration/deploy-scripts/script-out/.gitkeep similarity index 100% rename from l1-contracts/test/foundry/integration/deploy-scripts/script-out/.gitkeep rename to l1-contracts/test/foundry/l1/integration/deploy-scripts/script-out/.gitkeep diff --git a/l1-contracts/test/foundry/unit/concrete/AddressAliasHelper/_AddressAliasHelper_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/AddressAliasHelper/_AddressAliasHelper_Shared.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/AddressAliasHelper/_AddressAliasHelper_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/AddressAliasHelper/_AddressAliasHelper_Shared.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/AddressAliasHelper/applyL1ToL2Alias.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/AddressAliasHelper/applyL1ToL2Alias.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/AddressAliasHelper/applyL1ToL2Alias.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/AddressAliasHelper/applyL1ToL2Alias.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/AddressAliasHelper/undoL1ToL2Alias.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/AddressAliasHelper/undoL1ToL2Alias.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/AddressAliasHelper/undoL1ToL2Alias.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/AddressAliasHelper/undoL1ToL2Alias.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Bridgehub/Initialize.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/Initialize.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Bridgehub/Initialize.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/Initialize.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Bridgehub/MessageRoot.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/MessageRoot.t.sol similarity index 86% rename from l1-contracts/test/foundry/unit/concrete/Bridgehub/MessageRoot.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/MessageRoot.t.sol index 497ec4731..34ca5f9d2 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridgehub/MessageRoot.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/MessageRoot.t.sol @@ -5,6 +5,8 @@ pragma solidity 0.8.24; import {Test} from "forge-std/Test.sol"; import {MessageRoot} from "contracts/bridgehub/MessageRoot.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; +import {Merkle} from "contracts/common/libraries/Merkle.sol"; +import {MessageHashing} from "contracts/common/libraries/MessageHashing.sol"; // Chain tree consists of batch commitments as their leaves. We use hash of "new bytes(96)" as the hash of an empty leaf. bytes32 constant CHAIN_TREE_EMPTY_ENTRY_HASH = bytes32( @@ -26,7 +28,7 @@ contract MessageRootTest is Test { } function test_init() public { - assertEq(messageRoot.getAggregatedRoot(), CHAIN_TREE_EMPTY_ENTRY_HASH); + assertEq(messageRoot.getAggregatedRoot(), (MessageHashing.chainIdLeafHash(0x00, block.chainid))); } function test_RevertWhen_addChainNotBridgeHub() public { @@ -64,7 +66,7 @@ contract MessageRootTest is Test { uint256 alphaChainId = uint256(uint160(makeAddr("alphaChainId"))); vm.mockCall( bridgeHub, - abi.encodeWithSelector(IBridgehub.getHyperchain.selector, alphaChainId), + abi.encodeWithSelector(IBridgehub.getZKChain.selector, alphaChainId), abi.encode(alphaChainSender) ); @@ -78,7 +80,7 @@ contract MessageRootTest is Test { uint256 alphaChainId = uint256(uint160(makeAddr("alphaChainId"))); vm.mockCall( bridgeHub, - abi.encodeWithSelector(IBridgehub.getHyperchain.selector, alphaChainId), + abi.encodeWithSelector(IBridgehub.getZKChain.selector, alphaChainId), abi.encode(alphaChainSender) ); @@ -98,7 +100,7 @@ contract MessageRootTest is Test { uint256 alphaChainId = uint256(uint160(makeAddr("alphaChainId"))); vm.mockCall( bridgeHub, - abi.encodeWithSelector(IBridgehub.getHyperchain.selector, alphaChainId), + abi.encodeWithSelector(IBridgehub.getZKChain.selector, alphaChainId), abi.encode(alphaChainSender) ); @@ -110,6 +112,6 @@ contract MessageRootTest is Test { messageRoot.updateFullTree(); - assertEq(messageRoot.getAggregatedRoot(), 0xbad7e1cf889e30252b8ce93820f79d50651b78587844bc1c588dea123effa4ea); + assertEq(messageRoot.getAggregatedRoot(), 0x0ef1ac67d77f177a33449c47a8f05f0283300a81adca6f063c92c774beed140c); } } diff --git a/l1-contracts/test/foundry/unit/concrete/Bridgehub/_Bridgehub_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/_Bridgehub_Shared.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Bridgehub/_Bridgehub_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/_Bridgehub_Shared.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Bridgehub/experimental_bridge.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/experimental_bridge.t.sol similarity index 55% rename from l1-contracts/test/foundry/unit/concrete/Bridgehub/experimental_bridge.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/experimental_bridge.t.sol index dac000331..d9675912a 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridgehub/experimental_bridge.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridgehub/experimental_bridge.t.sol @@ -8,53 +8,61 @@ import "forge-std/console.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; import {TestnetERC20Token} from "contracts/dev-contracts/TestnetERC20Token.sol"; import {Bridgehub} from "contracts/bridgehub/Bridgehub.sol"; -import {ChainCreationParams} from "contracts/state-transition/IStateTransitionManager.sol"; +import {ChainCreationParams} from "contracts/state-transition/IChainTypeManager.sol"; import {L2TransactionRequestDirect, L2TransactionRequestTwoBridgesOuter} from "contracts/bridgehub/IBridgehub.sol"; -import {DummyStateTransitionManagerWBH} from "contracts/dev-contracts/test/DummyStateTransitionManagerWithBridgeHubAddress.sol"; -import {DummyHyperchain} from "contracts/dev-contracts/test/DummyHyperchain.sol"; -<<<<<<< HEAD +import {DummyChainTypeManagerWBH} from "contracts/dev-contracts/test/DummyChainTypeManagerWithBridgeHubAddress.sol"; +import {DummyZKChain} from "contracts/dev-contracts/test/DummyZKChain.sol"; import {DummySharedBridge} from "contracts/dev-contracts/test/DummySharedBridge.sol"; -import {IL1AssetRouter} from "contracts/bridge/interfaces/IL1AssetRouter.sol"; -import {L1NativeTokenVault} from "contracts/bridge/L1NativeTokenVault.sol"; +import {DummyBridgehubSetter} from "contracts/dev-contracts/test/DummyBridgehubSetter.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; +import {L1AssetRouter} from "contracts/bridge/asset-router/L1AssetRouter.sol"; +import {L1NativeTokenVault} from "contracts/bridge/ntv/L1NativeTokenVault.sol"; +import {L1Nullifier} from "contracts/bridge/L1Nullifier.sol"; +import {IL1Nullifier} from "contracts/bridge/L1Nullifier.sol"; import {L2Message, L2Log, TxStatus, BridgehubL2TransactionRequest} from "contracts/common/Messaging.sol"; -import {ETH_TOKEN_ADDRESS, REQUIRED_L2_GAS_PRICE_PER_PUBDATA, MAX_NEW_FACTORY_DEPS} from "contracts/common/Config.sol"; -import {L2_NATIVE_TOKEN_VAULT_ADDRESS} from "contracts/common/L2ContractAddresses.sol"; +import {L2_NATIVE_TOKEN_VAULT_ADDR} from "contracts/common/L2ContractAddresses.sol"; import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; -======= -import {IL1SharedBridge} from "contracts/bridge/interfaces/IL1SharedBridge.sol"; -import {L1SharedBridge} from "contracts/bridge/L1SharedBridge.sol"; + +import {ICTMDeploymentTracker} from "contracts/bridgehub/ICTMDeploymentTracker.sol"; +import {IMessageRoot} from "contracts/bridgehub/IMessageRoot.sol"; +import {MessageRoot} from "contracts/bridgehub/MessageRoot.sol"; import {L2TransactionRequestTwoBridgesInner} from "contracts/bridgehub/IBridgehub.sol"; -import {L2Message, L2Log, TxStatus, BridgehubL2TransactionRequest} from "contracts/common/Messaging.sol"; import {ETH_TOKEN_ADDRESS, REQUIRED_L2_GAS_PRICE_PER_PUBDATA, MAX_NEW_FACTORY_DEPS, TWO_BRIDGES_MAGIC_VALUE} from "contracts/common/Config.sol"; import {L1ERC20Bridge} from "contracts/bridge/L1ERC20Bridge.sol"; -import {ZeroChainId, AddressTooLow, ChainIdTooBig, WrongMagicValue, SharedBridgeNotSet, TokenNotRegistered, BridgeHubAlreadyRegistered, MsgValueMismatch, SlotOccupied, STMAlreadyRegistered, TokenAlreadyRegistered, Unauthorized, NonEmptyMsgValue, STMNotRegistered, InvalidChainId} from "contracts/common/L1ContractErrors.sol"; ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe +import {IAssetRouterBase} from "contracts/bridge/asset-router/IAssetRouterBase.sol"; +import {AssetIdNotSupported, ZeroChainId, ChainAlreadyLive, AssetIdAlreadyRegistered, AddressTooLow, ChainIdTooBig, WrongMagicValue, SharedBridgeNotSet, TokenNotRegistered, BridgeHubAlreadyRegistered, MsgValueMismatch, SlotOccupied, CTMAlreadyRegistered, TokenAlreadyRegistered, Unauthorized, NonEmptyMsgValue, CTMNotRegistered, InvalidChainId} from "contracts/common/L1ContractErrors.sol"; +import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; contract ExperimentalBridgeTest is Test { using stdStorage for StdStorage; + address weth; Bridgehub bridgeHub; + DummyBridgehubSetter dummyBridgehub; address public bridgeOwner; address public testTokenAddress; - DummyStateTransitionManagerWBH mockSTM; - DummyHyperchain mockChainContract; - L1SharedBridge sharedBridge; + DummyChainTypeManagerWBH mockCTM; + DummyZKChain mockChainContract; + DummySharedBridge mockSharedBridge; + DummySharedBridge mockSecondSharedBridge; + L1AssetRouter sharedBridge; address sharedBridgeAddress; address secondBridgeAddress; - L1SharedBridge secondBridge; + address l1NullifierAddress; + L1AssetRouter secondBridge; TestnetERC20Token testToken; -<<<<<<< HEAD L1NativeTokenVault ntv; + IMessageRoot messageRoot; + L1Nullifier l1Nullifier; + bytes32 tokenAssetId; - uint256 eraChainId; + bytes32 private constant LOCK_FLAG_ADDRESS = 0x8e94fed44239eb2314ab7a406345e6c5a8f0ccedf3b600de3d004e672c33abf4; bytes32 ETH_TOKEN_ASSET_ID = - keccak256( - abi.encode(block.chainid, L2_NATIVE_TOKEN_VAULT_ADDRESS, bytes32(uint256(uint160(ETH_TOKEN_ADDRESS)))) - ); -======= + keccak256(abi.encode(block.chainid, L2_NATIVE_TOKEN_VAULT_ADDR, bytes32(uint256(uint160(ETH_TOKEN_ADDRESS))))); + TestnetERC20Token testToken6; TestnetERC20Token testToken8; TestnetERC20Token testToken18; @@ -63,7 +71,9 @@ contract ExperimentalBridgeTest is Test { uint256 eraChainId; - event NewChain(uint256 indexed chainId, address stateTransitionManager, address indexed chainGovernance); + address deployerAddress; + + event NewChain(uint256 indexed chainId, address chainTypeManager, address indexed chainGovernance); modifier useRandomToken(uint256 randomValue) { _setRandomToken(randomValue); @@ -81,44 +91,63 @@ contract ExperimentalBridgeTest is Test { } else { testToken = testToken8; } + + tokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, address(testToken)); } ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe function setUp() public { - eraChainId = 9; - uint256 l1ChainId = 1; + deployerAddress = makeAddr("DEPLOYER_ADDRESS"); + eraChainId = 320; + uint256 l1ChainId = block.chainid; bridgeOwner = makeAddr("BRIDGE_OWNER"); - bridgeHub = new Bridgehub(l1ChainId, bridgeOwner); - address weth = makeAddr("WETH"); - mockSTM = new DummyStateTransitionManagerWBH(address(bridgeHub)); - mockChainContract = new DummyHyperchain(address(bridgeHub), eraChainId); -<<<<<<< HEAD + dummyBridgehub = new DummyBridgehubSetter(l1ChainId, bridgeOwner, type(uint256).max); + bridgeHub = Bridgehub(address(dummyBridgehub)); + weth = makeAddr("WETH"); + mockCTM = new DummyChainTypeManagerWBH(address(bridgeHub)); + mockChainContract = new DummyZKChain(address(bridgeHub), eraChainId, block.chainid); + + mockL2Contract = makeAddr("mockL2Contract"); + // mocks to use in bridges instead of using a dummy one + address mockL1WethAddress = makeAddr("Weth"); + address eraDiamondProxy = makeAddr("eraDiamondProxy"); + + l1Nullifier = new L1Nullifier(bridgeHub, eraChainId, eraDiamondProxy); + l1NullifierAddress = address(l1Nullifier); + mockSharedBridge = new DummySharedBridge(keccak256("0xabc")); mockSecondSharedBridge = new DummySharedBridge(keccak256("0xdef")); - ntv = new L1NativeTokenVault(weth, IL1AssetRouter(address(mockSharedBridge))); - mockSharedBridge.setNativeTokenVault(ntv); + + ntv = _deployNTV(address(mockSharedBridge)); + mockSecondSharedBridge.setNativeTokenVault(ntv); + testToken = new TestnetERC20Token("ZKSTT", "ZkSync Test Token", 18); testTokenAddress = address(testToken); - vm.prank(address(ntv)); - ntv.registerToken(ETH_TOKEN_ADDRESS); ntv.registerToken(address(testToken)); tokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, address(testToken)); -======= - mockL2Contract = makeAddr("mockL2Contract"); - // mocks to use in bridges instead of using a dummy one - address mockL1WethAddress = makeAddr("Weth"); - address eraDiamondProxy = makeAddr("eraDiamondProxy"); + messageRoot = new MessageRoot(bridgeHub); - sharedBridge = new L1SharedBridge(mockL1WethAddress, bridgeHub, eraChainId, eraDiamondProxy); + sharedBridge = new L1AssetRouter( + mockL1WethAddress, + address(bridgeHub), + l1NullifierAddress, + eraChainId, + eraDiamondProxy + ); address defaultOwner = sharedBridge.owner(); vm.prank(defaultOwner); sharedBridge.transferOwnership(bridgeOwner); vm.prank(bridgeOwner); sharedBridge.acceptOwnership(); - secondBridge = new L1SharedBridge(mockL1WethAddress, bridgeHub, eraChainId, eraDiamondProxy); + secondBridge = new L1AssetRouter( + mockL1WethAddress, + address(bridgeHub), + l1NullifierAddress, + eraChainId, + eraDiamondProxy + ); defaultOwner = secondBridge.owner(); vm.prank(defaultOwner); secondBridge.transferOwnership(bridgeOwner); @@ -130,7 +159,6 @@ contract ExperimentalBridgeTest is Test { testToken18 = new TestnetERC20Token("ZKSTT", "ZkSync Test Token", 18); testToken6 = new TestnetERC20Token("USDC", "USD Coin", 6); testToken8 = new TestnetERC20Token("WBTC", "Wrapped Bitcoin", 8); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe // test if the ownership of the bridgeHub is set correctly or not defaultOwner = bridgeHub.owner(); @@ -139,11 +167,7 @@ contract ExperimentalBridgeTest is Test { vm.expectRevert(SlotOccupied.selector); bridgeHub.initialize(bridgeOwner); - vm.store( - address(mockChainContract), - 0x8e94fed44239eb2314ab7a406345e6c5a8f0ccedf3b600de3d004e672c33abf4, - bytes32(uint256(1)) - ); + vm.store(address(mockChainContract), LOCK_FLAG_ADDRESS, bytes32(uint256(1))); bytes32 bridgehubLocation = bytes32(uint256(36)); vm.store(address(mockChainContract), bridgehubLocation, bytes32(uint256(uint160(address(bridgeHub))))); bytes32 baseTokenGasPriceNominatorLocation = bytes32(uint256(40)); @@ -164,6 +188,49 @@ contract ExperimentalBridgeTest is Test { assertEq(bridgeHub.owner(), bridgeOwner); } + function _deployNTV(address _sharedBridgeAddr) internal returns (L1NativeTokenVault addr) { + L1NativeTokenVault ntvImpl = new L1NativeTokenVault(weth, _sharedBridgeAddr, eraChainId, l1Nullifier); + TransparentUpgradeableProxy ntvProxy = new TransparentUpgradeableProxy( + address(ntvImpl), + address(bridgeOwner), + abi.encodeCall(ntvImpl.initialize, (bridgeOwner, address(0))) + ); + addr = L1NativeTokenVault(payable(ntvProxy)); + + vm.prank(bridgeOwner); + L1AssetRouter(_sharedBridgeAddr).setNativeTokenVault(addr); + + addr.registerEthToken(); + } + + function _useFullSharedBridge() internal { + ntv = _deployNTV(address(sharedBridge)); + + secondBridgeAddress = address(sharedBridge); + } + + function _useMockSharedBridge() internal { + sharedBridgeAddress = address(mockSharedBridge); + } + + function _initializeBridgehub() internal { + vm.prank(bridgeOwner); + bridgeHub.setPendingAdmin(deployerAddress); + vm.prank(deployerAddress); + bridgeHub.acceptAdmin(); + + vm.startPrank(bridgeOwner); + bridgeHub.addChainTypeManager(address(mockCTM)); + bridgeHub.addTokenAssetId(tokenAssetId); + bridgeHub.setAddresses(sharedBridgeAddress, ICTMDeploymentTracker(address(0)), messageRoot); + vm.stopPrank(); + + vm.prank(l1Nullifier.owner()); + l1Nullifier.setL1NativeTokenVault(ntv); + vm.prank(l1Nullifier.owner()); + l1Nullifier.setL1AssetRouter(sharedBridgeAddress); + } + function test_newPendingAdminReplacesPrevious(address randomDeployer, address otherRandomDeployer) public { vm.assume(randomDeployer != address(0)); vm.assume(otherRandomDeployer != address(0)); @@ -213,11 +280,7 @@ contract ExperimentalBridgeTest is Test { function test_randomCallerCannotSetDeployer(address randomCaller, address randomDeployer) public { if (randomCaller != bridgeHub.owner() && randomCaller != bridgeHub.admin()) { vm.prank(randomCaller); -<<<<<<< HEAD - vm.expectRevert(bytes("BH: not owner or admin")); -======= vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, randomCaller)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe bridgeHub.setPendingAdmin(randomDeployer); // The deployer shouldn't have changed. @@ -225,354 +288,256 @@ contract ExperimentalBridgeTest is Test { } } - function test_addStateTransitionManager(address randomAddressWithoutTheCorrectInterface) public { + function test_addChainTypeManager(address randomAddressWithoutTheCorrectInterface) public { vm.assume(randomAddressWithoutTheCorrectInterface != address(0)); - bool isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(!isSTMRegistered); + bool isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(!isCTMRegistered); vm.prank(bridgeOwner); - bridgeHub.addStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.addChainTypeManager(randomAddressWithoutTheCorrectInterface); - isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(isSTMRegistered); + isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(isCTMRegistered); - // An address that has already been registered, cannot be registered again (at least not before calling `removeStateTransitionManager`). + // An address that has already been registered, cannot be registered again (at least not before calling `removeChainTypeManager`). vm.prank(bridgeOwner); -<<<<<<< HEAD - vm.expectRevert(bytes("BH: state transition already registered")); -======= - vm.expectRevert(STMAlreadyRegistered.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - bridgeHub.addStateTransitionManager(randomAddressWithoutTheCorrectInterface); - - isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(isSTMRegistered); + vm.expectRevert(CTMAlreadyRegistered.selector); + bridgeHub.addChainTypeManager(randomAddressWithoutTheCorrectInterface); + + isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(isCTMRegistered); } - function test_addStateTransitionManager_cannotBeCalledByRandomAddress( + function test_addChainTypeManager_cannotBeCalledByRandomAddress( address randomCaller, address randomAddressWithoutTheCorrectInterface ) public { vm.assume(randomAddressWithoutTheCorrectInterface != address(0)); - bool isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(!isSTMRegistered); + bool isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(!isCTMRegistered); if (randomCaller != bridgeOwner) { vm.prank(randomCaller); vm.expectRevert(bytes("Ownable: caller is not the owner")); - bridgeHub.addStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.addChainTypeManager(randomAddressWithoutTheCorrectInterface); } vm.prank(bridgeOwner); - bridgeHub.addStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.addChainTypeManager(randomAddressWithoutTheCorrectInterface); - isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(isSTMRegistered); + isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(isCTMRegistered); - // An address that has already been registered, cannot be registered again (at least not before calling `removeStateTransitionManager`). + // An address that has already been registered, cannot be registered again (at least not before calling `removeChainTypeManager`). vm.prank(bridgeOwner); -<<<<<<< HEAD - vm.expectRevert(bytes("BH: state transition already registered")); -======= - vm.expectRevert(STMAlreadyRegistered.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - bridgeHub.addStateTransitionManager(randomAddressWithoutTheCorrectInterface); + vm.expectRevert(CTMAlreadyRegistered.selector); + bridgeHub.addChainTypeManager(randomAddressWithoutTheCorrectInterface); // Definitely not by a random caller if (randomCaller != bridgeOwner) { vm.prank(randomCaller); vm.expectRevert("Ownable: caller is not the owner"); - bridgeHub.addStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.addChainTypeManager(randomAddressWithoutTheCorrectInterface); } - isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(isSTMRegistered); + isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(isCTMRegistered); } - function test_removeStateTransitionManager(address randomAddressWithoutTheCorrectInterface) public { + function test_removeChainTypeManager(address randomAddressWithoutTheCorrectInterface) public { vm.assume(randomAddressWithoutTheCorrectInterface != address(0)); - bool isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(!isSTMRegistered); + bool isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(!isCTMRegistered); - // A non-existent STM cannot be removed + // A non-existent CTM cannot be removed vm.prank(bridgeOwner); -<<<<<<< HEAD - vm.expectRevert(bytes("BH: state transition not registered yet")); -======= - vm.expectRevert(STMNotRegistered.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - bridgeHub.removeStateTransitionManager(randomAddressWithoutTheCorrectInterface); - - // Let's first register our particular stateTransitionManager + vm.expectRevert(CTMNotRegistered.selector); + bridgeHub.removeChainTypeManager(randomAddressWithoutTheCorrectInterface); + + // Let's first register our particular chainTypeManager vm.prank(bridgeOwner); - bridgeHub.addStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.addChainTypeManager(randomAddressWithoutTheCorrectInterface); - isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(isSTMRegistered); + isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(isCTMRegistered); // Only an address that has already been registered, can be removed. vm.prank(bridgeOwner); - bridgeHub.removeStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.removeChainTypeManager(randomAddressWithoutTheCorrectInterface); - isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(!isSTMRegistered); + isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(!isCTMRegistered); - // An already removed STM cannot be removed again + // An already removed CTM cannot be removed again vm.prank(bridgeOwner); -<<<<<<< HEAD - vm.expectRevert(bytes("BH: state transition not registered yet")); -======= - vm.expectRevert(STMNotRegistered.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - bridgeHub.removeStateTransitionManager(randomAddressWithoutTheCorrectInterface); + vm.expectRevert(CTMNotRegistered.selector); + bridgeHub.removeChainTypeManager(randomAddressWithoutTheCorrectInterface); } - function test_removeStateTransitionManager_cannotBeCalledByRandomAddress( + function test_removeChainTypeManager_cannotBeCalledByRandomAddress( address randomAddressWithoutTheCorrectInterface, address randomCaller ) public { vm.assume(randomAddressWithoutTheCorrectInterface != address(0)); - bool isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(!isSTMRegistered); + bool isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(!isCTMRegistered); if (randomCaller != bridgeOwner) { vm.prank(randomCaller); vm.expectRevert(bytes("Ownable: caller is not the owner")); - bridgeHub.removeStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.removeChainTypeManager(randomAddressWithoutTheCorrectInterface); } - // A non-existent STM cannot be removed + // A non-existent CTM cannot be removed vm.prank(bridgeOwner); -<<<<<<< HEAD - vm.expectRevert(bytes("BH: state transition not registered yet")); -======= - vm.expectRevert(STMNotRegistered.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - bridgeHub.removeStateTransitionManager(randomAddressWithoutTheCorrectInterface); - - // Let's first register our particular stateTransitionManager + vm.expectRevert(CTMNotRegistered.selector); + bridgeHub.removeChainTypeManager(randomAddressWithoutTheCorrectInterface); + + // Let's first register our particular chainTypeManager vm.prank(bridgeOwner); - bridgeHub.addStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.addChainTypeManager(randomAddressWithoutTheCorrectInterface); - isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(isSTMRegistered); + isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(isCTMRegistered); // Only an address that has already been registered, can be removed. vm.prank(bridgeOwner); - bridgeHub.removeStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.removeChainTypeManager(randomAddressWithoutTheCorrectInterface); - isSTMRegistered = bridgeHub.stateTransitionManagerIsRegistered(randomAddressWithoutTheCorrectInterface); - assertTrue(!isSTMRegistered); + isCTMRegistered = bridgeHub.chainTypeManagerIsRegistered(randomAddressWithoutTheCorrectInterface); + assertTrue(!isCTMRegistered); - // An already removed STM cannot be removed again + // An already removed CTM cannot be removed again vm.prank(bridgeOwner); -<<<<<<< HEAD - vm.expectRevert(bytes("BH: state transition not registered yet")); -======= - vm.expectRevert(STMNotRegistered.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - bridgeHub.removeStateTransitionManager(randomAddressWithoutTheCorrectInterface); + vm.expectRevert(CTMNotRegistered.selector); + bridgeHub.removeChainTypeManager(randomAddressWithoutTheCorrectInterface); // Not possible by a randomcaller as well if (randomCaller != bridgeOwner) { vm.prank(randomCaller); vm.expectRevert(bytes("Ownable: caller is not the owner")); - bridgeHub.removeStateTransitionManager(randomAddressWithoutTheCorrectInterface); + bridgeHub.removeChainTypeManager(randomAddressWithoutTheCorrectInterface); } } -<<<<<<< HEAD - function test_addToken(address randomAddress) public { + function test_addAssetId(address randomAddress) public { vm.startPrank(bridgeOwner); - bridgeHub.setSharedBridge(address(mockSharedBridge)); + bridgeHub.setAddresses(address(mockSharedBridge), ICTMDeploymentTracker(address(0)), IMessageRoot(address(0))); vm.stopPrank(); - assertTrue(!bridgeHub.tokenIsRegistered(testTokenAddress), "This random address is not registered as a token"); -======= - function test_addToken(address, address randomAddress, uint256 randomValue) public useRandomToken(randomValue) { - assertTrue(!bridgeHub.tokenIsRegistered(randomAddress), "This random address is not registered as a token"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + bytes32 assetId = DataEncoding.encodeNTVAssetId(block.chainid, testTokenAddress); + assertTrue(!bridgeHub.assetIdIsRegistered(assetId), "This random address is not registered as a token"); vm.prank(bridgeOwner); - bridgeHub.addToken(testTokenAddress); + bridgeHub.addTokenAssetId(assetId); assertTrue( - bridgeHub.tokenIsRegistered(testTokenAddress), + bridgeHub.assetIdIsRegistered(assetId), "after call from the bridgeowner, this randomAddress should be a registered token" ); if (randomAddress != address(testTokenAddress)) { // Testing to see if a random address can also be added or not vm.prank(bridgeOwner); - bridgeHub.addToken(address(randomAddress)); - assertTrue(bridgeHub.tokenIsRegistered(randomAddress)); + assetId = DataEncoding.encodeNTVAssetId(block.chainid, address(randomAddress)); + bridgeHub.addTokenAssetId(assetId); + assertTrue(bridgeHub.assetIdIsRegistered(assetId)); } // An already registered token cannot be registered again vm.prank(bridgeOwner); -<<<<<<< HEAD - vm.expectRevert("BH: token already registered"); - bridgeHub.addToken(testTokenAddress); + vm.expectRevert(AssetIdAlreadyRegistered.selector); + bridgeHub.addTokenAssetId(assetId); } - function test_addToken_cannotBeCalledByRandomAddress(address randomAddress, address randomCaller) public { + function test_addAssetId_cannotBeCalledByRandomAddress( + address randomCaller, + uint256 randomValue + ) public useRandomToken(randomValue) { vm.startPrank(bridgeOwner); - bridgeHub.setSharedBridge(address(mockSharedBridge)); + bridgeHub.setAddresses(address(mockSharedBridge), ICTMDeploymentTracker(address(0)), IMessageRoot(address(0))); vm.stopPrank(); -======= - vm.expectRevert(abi.encodeWithSelector(TokenAlreadyRegistered.selector, address(randomAddress))); - bridgeHub.addToken(randomAddress); - } + bytes32 assetId = DataEncoding.encodeNTVAssetId(block.chainid, testTokenAddress); - function test_addToken_cannotBeCalledByRandomAddress( - address randomAddress, - address randomCaller, - uint256 randomValue - ) public useRandomToken(randomValue) { ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - if (randomCaller != bridgeOwner) { - vm.prank(randomCaller); - vm.expectRevert(bytes("Ownable: caller is not the owner")); - bridgeHub.addToken(testTokenAddress); - } + vm.assume(randomCaller != bridgeOwner); + vm.assume(randomCaller != bridgeHub.admin()); + vm.prank(randomCaller); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, randomCaller)); + bridgeHub.addTokenAssetId(assetId); - assertTrue(!bridgeHub.tokenIsRegistered(testTokenAddress), "This random address is not registered as a token"); + assertTrue(!bridgeHub.assetIdIsRegistered(assetId), "This random address is not registered as a token"); vm.prank(bridgeOwner); - bridgeHub.addToken(testTokenAddress); + bridgeHub.addTokenAssetId(assetId); assertTrue( - bridgeHub.tokenIsRegistered(testTokenAddress), + bridgeHub.assetIdIsRegistered(assetId), "after call from the bridgeowner, this testTokenAddress should be a registered token" ); // An already registered token cannot be registered again by randomCaller if (randomCaller != bridgeOwner) { vm.prank(bridgeOwner); -<<<<<<< HEAD - vm.expectRevert("BH: token already registered"); - bridgeHub.addToken(testTokenAddress); + vm.expectRevert(AssetIdAlreadyRegistered.selector); + bridgeHub.addTokenAssetId(assetId); } } - // function test_setSharedBridge(address randomAddress) public { - // assertTrue( - // bridgeHub.sharedBridge() == IL1AssetRouter(address(0)), - // "This random address is not registered as sharedBridge" - // ); -======= - vm.expectRevert(abi.encodeWithSelector(TokenAlreadyRegistered.selector, address(randomAddress))); - bridgeHub.addToken(randomAddress); - } - } + function test_setAddresses(address randomAssetRouter, address randomCTMDeployer, address randomMessageRoot) public { + assertTrue(bridgeHub.sharedBridge() == address(0), "Shared bridge is already there"); + assertTrue(bridgeHub.l1CtmDeployer() == ICTMDeploymentTracker(address(0)), "L1 CTM deployer is already there"); + assertTrue(bridgeHub.messageRoot() == IMessageRoot(address(0)), "Message root is already there"); + + vm.prank(bridgeOwner); + bridgeHub.setAddresses( + randomAssetRouter, + ICTMDeploymentTracker(randomCTMDeployer), + IMessageRoot(randomMessageRoot) + ); - function test_setSharedBridge(address randomAddress) public { - vm.assume(randomAddress != address(0)); + assertTrue(bridgeHub.sharedBridge() == randomAssetRouter, "Shared bridge is already there"); assertTrue( - bridgeHub.sharedBridge() == IL1SharedBridge(address(0)), - "This random address is not registered as sharedBridge" + bridgeHub.l1CtmDeployer() == ICTMDeploymentTracker(randomCTMDeployer), + "L1 CTM deployer is already there" ); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // vm.prank(bridgeOwner); - // bridgeHub.setSharedBridge(randomAddress); - - // assertTrue( - // bridgeHub.sharedBridge() == IL1AssetRouter(randomAddress), - // "after call from the bridgeowner, this randomAddress should be the registered sharedBridge" - // ); - // } - -<<<<<<< HEAD - // function test_setSharedBridge_cannotBeCalledByRandomAddress(address randomCaller, address randomAddress) public { - // if (randomCaller != bridgeOwner) { - // vm.prank(randomCaller); - // vm.expectRevert(bytes("Ownable: caller is not the owner")); - // bridgeHub.setSharedBridge(randomAddress); - // } -======= - function test_setSharedBridge_cannotBeCalledByRandomAddress(address randomCaller, address randomAddress) public { - vm.assume(randomAddress != address(0)); - if (randomCaller != bridgeOwner) { - vm.prank(randomCaller); - vm.expectRevert(bytes("Ownable: caller is not the owner")); - bridgeHub.setSharedBridge(randomAddress); - } ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // assertTrue( - // bridgeHub.sharedBridge() == IL1AssetRouter(address(0)), - // "This random address is not registered as sharedBridge" - // ); - - // vm.prank(bridgeOwner); - // bridgeHub.setSharedBridge(randomAddress); - - // assertTrue( - // bridgeHub.sharedBridge() == IL1AssetRouter(randomAddress), - // "after call from the bridgeowner, this randomAddress should be the registered sharedBridge" - // ); - // } - - // uint256 newChainId; - // address admin; - -<<<<<<< HEAD - // function test_createNewChain( - // address randomCaller, - // uint256 chainId, - // bool isFreezable, - // bytes4[] memory mockSelectors, - // address mockInitAddress, - // bytes memory mockInitCalldata - // ) public { - // address deployerAddress = makeAddr("DEPLOYER_ADDRESS"); - // admin = makeAddr("NEW_CHAIN_ADMIN"); - // // Diamond.DiamondCutData memory dcData; - - // vm.prank(bridgeOwner); - // bridgeHub.setPendingAdmin(deployerAddress); - // vm.prank(deployerAddress); - // bridgeHub.acceptAdmin(); - // vm.startPrank(bridgeOwner); - // bridgeHub.setSharedBridge(address(mockSharedBridge)); - // bridgeHub.addStateTransitionManager(address(mockSTM)); - // bridgeHub.addToken(testTokenAddress); - // bridgeHub.setSharedBridge(address(mockSharedBridge)); - // vm.stopPrank(); - - // if (randomCaller != deployerAddress && randomCaller != bridgeOwner) { - // vm.prank(randomCaller); - // vm.expectRevert(bytes("BH: not owner or admin")); - // bridgeHub.createNewChain({ - // _chainId: chainId, - // _stateTransitionManager: address(mockSTM), - // _baseToken: testTokenAddress, - // _salt: uint256(123), - // _admin: admin, - // _initData: bytes("") - // }); - // } - - // chainId = bound(chainId, 1, type(uint48).max); - // vm.prank(mockSTM.owner()); - // bytes memory _newChainInitData = _createNewChainInitData( - // isFreezable, - // mockSelectors, - // mockInitAddress, - // mockInitCalldata - // ); -======= + assertTrue(bridgeHub.messageRoot() == IMessageRoot(randomMessageRoot), "Message root is already there"); + } + + function test_setAddresses_cannotBeCalledByRandomAddress( + address randomCaller, + address randomAssetRouter, + address randomCTMDeployer, + address randomMessageRoot + ) public { + vm.assume(randomCaller != bridgeOwner); + + vm.prank(randomCaller); + vm.expectRevert(bytes("Ownable: caller is not the owner")); + bridgeHub.setAddresses( + randomAssetRouter, + ICTMDeploymentTracker(randomCTMDeployer), + IMessageRoot(randomMessageRoot) + ); + + assertTrue(bridgeHub.sharedBridge() == address(0), "Shared bridge is already there"); + assertTrue(bridgeHub.l1CtmDeployer() == ICTMDeploymentTracker(address(0)), "L1 CTM deployer is already there"); + assertTrue(bridgeHub.messageRoot() == IMessageRoot(address(0)), "Message root is already there"); + } + + uint256 newChainId; + address admin; + function test_pause_createNewChain( uint256 chainId, uint256 salt, uint256 randomValue ) public useRandomToken(randomValue) { chainId = bound(chainId, 1, type(uint48).max); - address deployerAddress = makeAddr("DEPLOYER_ADDRESS"); + vm.assume(chainId != block.chainid); + admin = makeAddr("NEW_CHAIN_ADMIN"); vm.prank(bridgeOwner); @@ -582,39 +547,49 @@ contract ExperimentalBridgeTest is Test { vm.prank(deployerAddress); bridgeHub.acceptAdmin(); + // ntv.registerToken(address(testToken)); + + // bytes32 tokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, address(testToken)); + + // vm.prank(deployerAddress); + // bridgehub.addTokenAssetId(tokenAssetId); + vm.expectRevert("Pausable: paused"); vm.prank(deployerAddress); bridgeHub.createNewChain({ _chainId: chainId, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, _salt: salt, _admin: admin, - _initData: bytes("") + _initData: bytes(""), + _factoryDeps: new bytes[](0) }); vm.prank(bridgeOwner); bridgeHub.unpause(); - vm.expectRevert(STMNotRegistered.selector); + vm.expectRevert(CTMNotRegistered.selector); vm.prank(deployerAddress); bridgeHub.createNewChain({ - _chainId: 1, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), - _salt: uint256(123), + _chainId: chainId, + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, + _salt: salt, _admin: admin, - _initData: bytes("") + _initData: bytes(""), + _factoryDeps: new bytes[](0) }); } - function test_RevertWhen_STMNotRegisteredOnCreate( + function test_RevertWhen_CTMNotRegisteredOnCreate( uint256 chainId, uint256 salt, uint256 randomValue ) public useRandomToken(randomValue) { chainId = bound(chainId, 1, type(uint48).max); - address deployerAddress = makeAddr("DEPLOYER_ADDRESS"); + vm.assume(chainId != block.chainid); + admin = makeAddr("NEW_CHAIN_ADMIN"); vm.prank(bridgeOwner); @@ -623,15 +598,16 @@ contract ExperimentalBridgeTest is Test { bridgeHub.acceptAdmin(); chainId = bound(chainId, 1, type(uint48).max); - vm.expectRevert(STMNotRegistered.selector); + vm.expectRevert(CTMNotRegistered.selector); vm.prank(deployerAddress); bridgeHub.createNewChain({ _chainId: chainId, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, _salt: salt, _admin: admin, - _initData: bytes("") + _initData: bytes(""), + _factoryDeps: new bytes[](0) }); } @@ -641,7 +617,8 @@ contract ExperimentalBridgeTest is Test { uint256 randomValue ) public useRandomToken(randomValue) { chainId = bound(chainId, 1, type(uint48).max); - address deployerAddress = makeAddr("DEPLOYER_ADDRESS"); + vm.assume(chainId != block.chainid); + admin = makeAddr("NEW_CHAIN_ADMIN"); vm.prank(bridgeOwner); @@ -654,11 +631,12 @@ contract ExperimentalBridgeTest is Test { vm.prank(deployerAddress); bridgeHub.createNewChain({ _chainId: chainId, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, _salt: salt, _admin: admin, - _initData: bytes("") + _initData: bytes(""), + _factoryDeps: new bytes[](0) }); chainId = 0; @@ -666,21 +644,23 @@ contract ExperimentalBridgeTest is Test { vm.prank(deployerAddress); bridgeHub.createNewChain({ _chainId: chainId, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, _salt: salt, _admin: admin, - _initData: bytes("") + _initData: bytes(""), + _factoryDeps: new bytes[](0) }); } - function test_RevertWhen_tokenNotRegistered( + function test_RevertWhen_assetIdNotRegistered( uint256 chainId, uint256 salt, uint256 randomValue ) public useRandomToken(randomValue) { chainId = bound(chainId, 1, type(uint48).max); - address deployerAddress = makeAddr("DEPLOYER_ADDRESS"); + vm.assume(chainId != block.chainid); + admin = makeAddr("NEW_CHAIN_ADMIN"); vm.prank(bridgeOwner); @@ -689,18 +669,19 @@ contract ExperimentalBridgeTest is Test { bridgeHub.acceptAdmin(); vm.startPrank(bridgeOwner); - bridgeHub.addStateTransitionManager(address(mockSTM)); + bridgeHub.addChainTypeManager(address(mockCTM)); vm.stopPrank(); - vm.expectRevert(abi.encodeWithSelector(TokenNotRegistered.selector, address(testToken))); + vm.expectRevert(abi.encodeWithSelector(AssetIdNotSupported.selector, tokenAssetId)); vm.prank(deployerAddress); bridgeHub.createNewChain({ _chainId: chainId, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, _salt: salt, _admin: admin, - _initData: bytes("") + _initData: bytes(""), + _factoryDeps: new bytes[](0) }); } @@ -710,7 +691,7 @@ contract ExperimentalBridgeTest is Test { uint256 randomValue ) public useRandomToken(randomValue) { chainId = bound(chainId, 1, type(uint48).max); - address deployerAddress = makeAddr("DEPLOYER_ADDRESS"); + vm.assume(chainId != block.chainid); admin = makeAddr("NEW_CHAIN_ADMIN"); vm.prank(bridgeOwner); @@ -719,19 +700,20 @@ contract ExperimentalBridgeTest is Test { bridgeHub.acceptAdmin(); vm.startPrank(bridgeOwner); - bridgeHub.addStateTransitionManager(address(mockSTM)); - bridgeHub.addToken(address(testToken)); + bridgeHub.addChainTypeManager(address(mockCTM)); + bridgeHub.addTokenAssetId(tokenAssetId); vm.stopPrank(); vm.expectRevert(SharedBridgeNotSet.selector); vm.prank(deployerAddress); bridgeHub.createNewChain({ _chainId: chainId, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, _salt: salt, _admin: admin, - _initData: bytes("") + _initData: bytes(""), + _factoryDeps: new bytes[](0) }); } @@ -740,202 +722,144 @@ contract ExperimentalBridgeTest is Test { uint256 salt, uint256 randomValue ) public useRandomToken(randomValue) { - address deployerAddress = makeAddr("DEPLOYER_ADDRESS"); admin = makeAddr("NEW_CHAIN_ADMIN"); - vm.prank(bridgeOwner); - bridgeHub.setPendingAdmin(deployerAddress); - vm.prank(deployerAddress); - bridgeHub.acceptAdmin(); - vm.startPrank(bridgeOwner); - bridgeHub.addStateTransitionManager(address(mockSTM)); - bridgeHub.addToken(address(testToken)); - bridgeHub.setSharedBridge(sharedBridgeAddress); - vm.stopPrank(); + _initializeBridgehub(); chainId = bound(chainId, 1, type(uint48).max); - stdstore.target(address(bridgeHub)).sig("stateTransitionManager(uint256)").with_key(chainId).checked_write( - address(mockSTM) + vm.assume(chainId != block.chainid); + stdstore.target(address(bridgeHub)).sig("chainTypeManager(uint256)").with_key(chainId).checked_write( + address(mockCTM) ); vm.expectRevert(BridgeHubAlreadyRegistered.selector); vm.prank(deployerAddress); bridgeHub.createNewChain({ _chainId: chainId, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, _salt: salt, _admin: admin, - _initData: bytes("") + _initData: bytes(""), + _factoryDeps: new bytes[](0) }); } function test_createNewChain( address randomCaller, uint256 chainId, - bool isFreezable, - bytes4[] memory mockSelectors, - address mockInitAddress, bytes memory mockInitCalldata, + bytes[] memory factoryDeps, uint256 salt, - uint256 randomValue + uint256 randomValue, + address newChainAddress ) public useRandomToken(randomValue) { - address deployerAddress = makeAddr("DEPLOYER_ADDRESS"); admin = makeAddr("NEW_CHAIN_ADMIN"); chainId = bound(chainId, 1, type(uint48).max); + vm.assume(chainId != block.chainid); + vm.assume(randomCaller != deployerAddress && randomCaller != bridgeOwner); - vm.prank(bridgeOwner); - bridgeHub.setPendingAdmin(deployerAddress); - vm.prank(deployerAddress); - bridgeHub.acceptAdmin(); + _initializeBridgehub(); - vm.startPrank(bridgeOwner); - bridgeHub.addStateTransitionManager(address(mockSTM)); - bridgeHub.addToken(address(testToken)); - bridgeHub.setSharedBridge(sharedBridgeAddress); - vm.stopPrank(); + vm.prank(randomCaller); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, randomCaller)); + bridgeHub.createNewChain({ + _chainId: chainId, + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, + _salt: salt, + _admin: admin, + _initData: bytes(""), + _factoryDeps: factoryDeps + }); - if (randomCaller != deployerAddress && randomCaller != bridgeOwner) { - vm.prank(randomCaller); - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, randomCaller)); - bridgeHub.createNewChain({ - _chainId: chainId, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), - _salt: salt, - _admin: admin, - _initData: bytes("") - }); - } + vm.prank(mockCTM.owner()); + + // bridgeHub.createNewChain => chainTypeManager.createNewChain => this function sets the stateTransition mapping + // of `chainId`, let's emulate that using foundry cheatcodes or let's just use the extra function we introduced in our mockCTM + mockCTM.setZKChain(chainId, address(mockChainContract)); - vm.prank(mockSTM.owner()); - bytes memory _newChainInitData = _createNewChainInitData( - isFreezable, - mockSelectors, - mockInitAddress, - mockInitCalldata - ); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // // bridgeHub.createNewChain => stateTransitionManager.createNewChain => this function sets the stateTransition mapping - // // of `chainId`, let's emulate that using foundry cheatcodes or let's just use the extra function we introduced in our mockSTM - // mockSTM.setHyperchain(chainId, address(mockChainContract)); - // assertTrue(mockSTM.getHyperchain(chainId) == address(mockChainContract)); - -<<<<<<< HEAD - // vm.startPrank(deployerAddress); - // vm.mockCall( - // address(mockSTM), - // // solhint-disable-next-line func-named-parameters - // abi.encodeWithSelector( - // mockSTM.createNewChain.selector, - // chainId, - // testTokenAddress, - // address(mockSharedBridge), - // admin, - // _newChainInitData - // ), - // bytes("") - // ); - - // newChainId = bridgeHub.createNewChain({ - // _chainId: chainId, - // _stateTransitionManager: address(mockSTM), - // _baseToken: testTokenAddress, - // _salt: uint256(chainId * 2), - // _admin: admin, - // _initData: _newChainInitData - // }); -======= vm.startPrank(deployerAddress); vm.mockCall( - address(mockSTM), + address(mockCTM), // solhint-disable-next-line func-named-parameters abi.encodeWithSelector( - mockSTM.createNewChain.selector, + mockCTM.createNewChain.selector, chainId, - address(testToken), + tokenAssetId, sharedBridgeAddress, admin, - _newChainInitData + mockInitCalldata, + factoryDeps ), - bytes("") + abi.encode(newChainAddress) ); vm.expectEmit(true, true, true, true, address(bridgeHub)); - emit NewChain(chainId, address(mockSTM), admin); + emit NewChain(chainId, address(mockCTM), admin); - newChainId = bridgeHub.createNewChain({ + bridgeHub.createNewChain({ _chainId: chainId, - _stateTransitionManager: address(mockSTM), - _baseToken: address(testToken), + _chainTypeManager: address(mockCTM), + _baseTokenAssetId: tokenAssetId, _salt: uint256(chainId * 2), _admin: admin, - _initData: _newChainInitData + _initData: mockInitCalldata, + _factoryDeps: factoryDeps }); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // vm.stopPrank(); - // vm.clearMockedCalls(); - - // assertTrue(bridgeHub.stateTransitionManager(newChainId) == address(mockSTM)); - // assertTrue(bridgeHub.baseToken(newChainId) == testTokenAddress); - // } - - // function test_getHyperchain(uint256 mockChainId) public { - // mockChainId = _setUpHyperchainForChainId(mockChainId); - - // // Now the following statements should be true as well: - // assertTrue(bridgeHub.stateTransitionManager(mockChainId) == address(mockSTM)); - // address returnedHyperchain = bridgeHub.getHyperchain(mockChainId); - - // assertEq(returnedHyperchain, address(mockChainContract)); - // } - - // function test_proveL2MessageInclusion( - // uint256 mockChainId, - // uint256 mockBatchNumber, - // uint256 mockIndex, - // bytes32[] memory mockProof, - // uint16 randomTxNumInBatch, - // address randomSender, - // bytes memory randomData - // ) public { - // mockChainId = _setUpHyperchainForChainId(mockChainId); - - // // Now the following statements should be true as well: - // assertTrue(bridgeHub.stateTransitionManager(mockChainId) == address(mockSTM)); - // assertTrue(bridgeHub.getHyperchain(mockChainId) == address(mockChainContract)); - - // // Creating a random L2Message::l2Message so that we pass the correct parameters to `proveL2MessageInclusion` - // L2Message memory l2Message = _createMockL2Message(randomTxNumInBatch, randomSender, randomData); - - // // Since we have used random data for the `bridgeHub.proveL2MessageInclusion` function which basically forwards the call - // // to the same function in the mailbox, we will mock the call to the mailbox to return true and see if it works. - // vm.mockCall( - // address(mockChainContract), - // // solhint-disable-next-line func-named-parameters - // abi.encodeWithSelector( - // mockChainContract.proveL2MessageInclusion.selector, - // mockBatchNumber, - // mockIndex, - // l2Message, - // mockProof - // ), - // abi.encode(true) - // ); - - // assertTrue( - // bridgeHub.proveL2MessageInclusion({ - // _chainId: mockChainId, - // _batchNumber: mockBatchNumber, - // _index: mockIndex, - // _message: l2Message, - // _proof: mockProof - // }) - // ); - // vm.clearMockedCalls(); - // } + + vm.stopPrank(); + vm.clearMockedCalls(); + + assertTrue(bridgeHub.chainTypeManager(chainId) == address(mockCTM)); + assertTrue(bridgeHub.baseTokenAssetId(chainId) == tokenAssetId); + assertTrue(bridgeHub.getZKChain(chainId) == newChainAddress); + } + + function test_proveL2MessageInclusion( + uint256 mockChainId, + uint256 mockBatchNumber, + uint256 mockIndex, + bytes32[] memory mockProof, + uint16 randomTxNumInBatch, + address randomSender, + bytes memory randomData + ) public { + mockChainId = _setUpZKChainForChainId(mockChainId); + + // Now the following statements should be true as well: + assertTrue(bridgeHub.chainTypeManager(mockChainId) == address(mockCTM)); + assertTrue(bridgeHub.getZKChain(mockChainId) == address(mockChainContract)); + + // Creating a random L2Message::l2Message so that we pass the correct parameters to `proveL2MessageInclusion` + L2Message memory l2Message = _createMockL2Message(randomTxNumInBatch, randomSender, randomData); + + // Since we have used random data for the `bridgeHub.proveL2MessageInclusion` function which basically forwards the call + // to the same function in the mailbox, we will mock the call to the mailbox to return true and see if it works. + vm.mockCall( + address(mockChainContract), + // solhint-disable-next-line func-named-parameters + abi.encodeWithSelector( + mockChainContract.proveL2MessageInclusion.selector, + mockBatchNumber, + mockIndex, + l2Message, + mockProof + ), + abi.encode(true) + ); + + assertTrue( + bridgeHub.proveL2MessageInclusion({ + _chainId: mockChainId, + _batchNumber: mockBatchNumber, + _index: mockIndex, + _message: l2Message, + _proof: mockProof + }) + ); + vm.clearMockedCalls(); + } function test_proveL2LogInclusion( uint256 mockChainId, @@ -949,11 +873,11 @@ contract ExperimentalBridgeTest is Test { bytes32 randomKey, bytes32 randomValue ) public { - mockChainId = _setUpHyperchainForChainId(mockChainId); + mockChainId = _setUpZKChainForChainId(mockChainId); // Now the following statements should be true as well: - assertTrue(bridgeHub.stateTransitionManager(mockChainId) == address(mockSTM)); - assertTrue(bridgeHub.getHyperchain(mockChainId) == address(mockChainContract)); + assertTrue(bridgeHub.chainTypeManager(mockChainId) == address(mockCTM)); + assertTrue(bridgeHub.getZKChain(mockChainId) == address(mockChainContract)); // Creating a random L2Log::l2Log so that we pass the correct parameters to `proveL2LogInclusion` L2Log memory l2Log = _createMockL2Log({ @@ -1002,7 +926,7 @@ contract ExperimentalBridgeTest is Test { bool randomResultantBool, bool txStatusBool ) public { - randomChainId = _setUpHyperchainForChainId(randomChainId); + randomChainId = _setUpZKChainForChainId(randomChainId); TxStatus txStatus; @@ -1047,7 +971,7 @@ contract ExperimentalBridgeTest is Test { uint256 mockL2GasPerPubdataByteLimit, uint256 mockL2TxnCost ) public { - mockChainId = _setUpHyperchainForChainId(mockChainId); + mockChainId = _setUpZKChainForChainId(mockChainId); vm.mockCall( address(mockChainContract), @@ -1068,35 +992,6 @@ contract ExperimentalBridgeTest is Test { vm.clearMockedCalls(); } -<<<<<<< HEAD - // function test_requestL2TransactionDirect_ETHCase( - // uint256 mockChainId, - // uint256 mockMintValue, - // address mockL2Contract, - // uint256 mockL2Value, - // bytes memory mockL2Calldata, - // uint256 mockL2GasLimit, - // uint256 mockL2GasPerPubdataByteLimit, - // bytes[] memory mockFactoryDeps, - // address mockRefundRecipient, - // bytes[] memory mockRefundRecipientBH - // ) public { - // if (mockFactoryDeps.length > MAX_NEW_FACTORY_DEPS) { - // mockFactoryDeps = _restrictArraySize(mockFactoryDeps, MAX_NEW_FACTORY_DEPS); - // } - - // L2TransactionRequestDirect memory l2TxnReqDirect = _createMockL2TransactionRequestDirect({ - // mockChainId: mockChainId, - // mockMintValue: mockMintValue, - // mockL2Contract: mockL2Contract, - // mockL2Value: mockL2Value, - // mockL2Calldata: mockL2Calldata, - // mockL2GasLimit: mockL2GasLimit, - // mockL2GasPerPubdataByteLimit: mockL2GasPerPubdataByteLimit, - // mockFactoryDeps: mockFactoryDeps, - // mockRefundRecipient: mockRefundRecipient - // }); -======= function _prepareETHL2TransactionDirectRequest( uint256 mockChainId, uint256 mockMintValue, @@ -1107,10 +1002,8 @@ contract ExperimentalBridgeTest is Test { uint256 mockL2GasPerPubdataByteLimit, bytes[] memory mockFactoryDeps, address randomCaller - ) internal returns (L2TransactionRequestDirect memory l2TxnReqDirect) { - if (mockFactoryDeps.length > MAX_NEW_FACTORY_DEPS) { - mockFactoryDeps = _restrictArraySize(mockFactoryDeps, MAX_NEW_FACTORY_DEPS); - } + ) internal returns (L2TransactionRequestDirect memory l2TxnReqDirect, bytes32 canonicalHash) { + vm.assume(mockFactoryDeps.length <= MAX_NEW_FACTORY_DEPS); l2TxnReqDirect = _createMockL2TransactionRequestDirect({ mockChainId: mockChainId, @@ -1123,62 +1016,25 @@ contract ExperimentalBridgeTest is Test { mockFactoryDeps: mockFactoryDeps, mockRefundRecipient: address(0) }); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // l2TxnReqDirect.chainId = _setUpHyperchainForChainId(l2TxnReqDirect.chainId); - -<<<<<<< HEAD - // assertTrue(!(bridgeHub.baseToken(l2TxnReqDirect.chainId) == ETH_TOKEN_ADDRESS)); - // _setUpBaseTokenForChainId(l2TxnReqDirect.chainId, true); - // assertTrue(bridgeHub.baseToken(l2TxnReqDirect.chainId) == ETH_TOKEN_ADDRESS); - // _setUpSharedBridge(); + l2TxnReqDirect.chainId = _setUpZKChainForChainId(l2TxnReqDirect.chainId); - // address randomCaller = makeAddr("RANDOM_CALLER"); - // vm.deal(randomCaller, l2TxnReqDirect.mintValue); - - // assertTrue(bridgeHub.getHyperchain(l2TxnReqDirect.chainId) == address(mockChainContract)); - // bytes32 canonicalHash = keccak256(abi.encode("CANONICAL_TX_HASH")); - // //BridgehubL2TransactionRequest memory bhL2TxnRequest = - // _createBhL2TxnRequest(mockRefundRecipientBH); -======= - assertTrue(!(bridgeHub.baseToken(l2TxnReqDirect.chainId) == ETH_TOKEN_ADDRESS)); + assertTrue(bridgeHub.baseTokenAssetId(l2TxnReqDirect.chainId) != ETH_TOKEN_ASSET_ID); _setUpBaseTokenForChainId(l2TxnReqDirect.chainId, true, address(0)); + + assertTrue(bridgeHub.baseTokenAssetId(l2TxnReqDirect.chainId) == ETH_TOKEN_ASSET_ID); + console.log(IL1AssetRouter(bridgeHub.sharedBridge()).assetHandlerAddress(ETH_TOKEN_ASSET_ID)); assertTrue(bridgeHub.baseToken(l2TxnReqDirect.chainId) == ETH_TOKEN_ADDRESS); - _setUpSharedBridge(); - _setUpSharedBridgeL2(mockChainId); + assertTrue(bridgeHub.getZKChain(l2TxnReqDirect.chainId) == address(mockChainContract)); + canonicalHash = keccak256(abi.encode("CANONICAL_TX_HASH")); + + vm.mockCall( + address(mockChainContract), + abi.encodeWithSelector(mockChainContract.bridgehubRequestL2Transaction.selector), + abi.encode(canonicalHash) + ); - assertTrue(bridgeHub.getHyperchain(l2TxnReqDirect.chainId) == address(mockChainContract)); - bytes32 canonicalHash = keccak256(abi.encode("CANONICAL_TX_HASH")); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // vm.mockCall( - // address(mockChainContract), - // abi.encodeWithSelector(mockChainContract.bridgehubRequestL2Transaction.selector), - // abi.encode(canonicalHash) - // ); - -<<<<<<< HEAD - // mockChainContract.setFeeParams(); - // mockChainContract.setBaseTokenGasMultiplierPrice(uint128(1), uint128(1)); - // mockChainContract.setBridgeHubAddress(address(bridgeHub)); - // assertTrue(mockChainContract.getBridgeHubAddress() == address(bridgeHub)); - - // bytes32 baseTokenAssetIdLocation = bytes32(uint256(208)); - // vm.store( - // address(bridgeHub), - // keccak256(abi.encode(l2TxnReqDirect.chainId, baseTokenAssetIdLocation)), - // ETH_TOKEN_ASSET_ID - // ); - // vm.mockCall( - // address(mockSharedBridge), - // abi.encodeWithSelector(IL1AssetRouter.bridgehubDepositBaseToken.selector), - // abi.encode(true) - // ); - - // vm.txGasPrice(0.05 ether); -======= mockChainContract.setFeeParams(); mockChainContract.setBaseTokenGasMultiplierPrice(uint128(1), uint128(1)); mockChainContract.setBridgeHubAddress(address(bridgeHub)); @@ -1196,10 +1052,13 @@ contract ExperimentalBridgeTest is Test { uint256 mockL2GasPerPubdataByteLimit, bytes[] memory mockFactoryDeps ) public { + _useMockSharedBridge(); + _initializeBridgehub(); + address randomCaller = makeAddr("RANDOM_CALLER"); vm.assume(msgValue != mockMintValue); - L2TransactionRequestDirect memory l2TxnReqDirect = _prepareETHL2TransactionDirectRequest({ + (L2TransactionRequestDirect memory l2TxnReqDirect, bytes32 hash) = _prepareETHL2TransactionDirectRequest({ mockChainId: mockChainId, mockMintValue: mockMintValue, mockL2Contract: mockL2Contract, @@ -1228,10 +1087,13 @@ contract ExperimentalBridgeTest is Test { bytes[] memory mockFactoryDeps, uint256 gasPrice ) public { + _useMockSharedBridge(); + _initializeBridgehub(); + address randomCaller = makeAddr("RANDOM_CALLER"); mockChainId = bound(mockChainId, 1, type(uint48).max); - L2TransactionRequestDirect memory l2TxnReqDirect = _prepareETHL2TransactionDirectRequest({ + (L2TransactionRequestDirect memory l2TxnReqDirect, bytes32 hash) = _prepareETHL2TransactionDirectRequest({ mockChainId: mockChainId, mockMintValue: mockMintValue, mockL2Contract: mockL2Contract, @@ -1247,32 +1109,11 @@ contract ExperimentalBridgeTest is Test { gasPrice = bound(gasPrice, 1_000, 50_000_000); vm.txGasPrice(gasPrice * 1 gwei); vm.prank(randomCaller); - bytes32 canonicalHash = keccak256(abi.encode("CANONICAL_TX_HASH")); bytes32 resultantHash = bridgeHub.requestL2TransactionDirect{value: randomCaller.balance}(l2TxnReqDirect); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // vm.prank(randomCaller); - // bytes32 resultantHash = bridgeHub.requestL2TransactionDirect{value: randomCaller.balance}(l2TxnReqDirect); - -<<<<<<< HEAD - // assertTrue(resultantHash == canonicalHash); - // } - - // function test_requestL2TransactionDirect_NonETHCase( - // uint256 mockChainId, - // uint256 mockMintValue, - // address mockL2Contract, - // uint256 mockL2Value, - // bytes memory mockL2Calldata, - // uint256 mockL2GasLimit, - // uint256 mockL2GasPerPubdataByteLimit, - // bytes[] memory mockFactoryDeps, - // address mockRefundRecipient - // ) public { - // if (mockFactoryDeps.length > MAX_NEW_FACTORY_DEPS) { - // mockFactoryDeps = _restrictArraySize(mockFactoryDeps, MAX_NEW_FACTORY_DEPS); - // } -======= + + assertTrue(resultantHash == hash); + } + function test_requestL2TransactionDirect_NonETHCase( uint256 mockChainId, uint256 mockMintValue, @@ -1285,12 +1126,14 @@ contract ExperimentalBridgeTest is Test { uint256 gasPrice, uint256 randomValue ) public useRandomToken(randomValue) { + _useFullSharedBridge(); + _initializeBridgehub(); + address randomCaller = makeAddr("RANDOM_CALLER"); mockChainId = bound(mockChainId, 1, type(uint48).max); - if (mockFactoryDeps.length > MAX_NEW_FACTORY_DEPS) { - mockFactoryDeps = _restrictArraySize(mockFactoryDeps, MAX_NEW_FACTORY_DEPS); - } + vm.assume(mockFactoryDeps.length <= MAX_NEW_FACTORY_DEPS); + vm.assume(mockMintValue > 0); L2TransactionRequestDirect memory l2TxnReqDirect = _createMockL2TransactionRequestDirect({ mockChainId: mockChainId, @@ -1303,51 +1146,25 @@ contract ExperimentalBridgeTest is Test { mockFactoryDeps: mockFactoryDeps, mockRefundRecipient: address(0) }); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // L2TransactionRequestDirect memory l2TxnReqDirect = _createMockL2TransactionRequestDirect({ - // mockChainId: mockChainId, - // mockMintValue: mockMintValue, - // mockL2Contract: mockL2Contract, - // mockL2Value: mockL2Value, - // mockL2Calldata: mockL2Calldata, - // mockL2GasLimit: mockL2GasLimit, - // mockL2GasPerPubdataByteLimit: mockL2GasPerPubdataByteLimit, - // mockFactoryDeps: mockFactoryDeps, - // mockRefundRecipient: mockRefundRecipient - // }); - -<<<<<<< HEAD - // l2TxnReqDirect.chainId = _setUpHyperchainForChainId(l2TxnReqDirect.chainId); -======= - _setUpBaseTokenForChainId(l2TxnReqDirect.chainId, false, address(testToken)); - _setUpSharedBridge(); - _setUpSharedBridgeL2(mockChainId); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - // _setUpBaseTokenForChainId(l2TxnReqDirect.chainId, false); - // _setUpSharedBridge(); + l2TxnReqDirect.chainId = _setUpZKChainForChainId(l2TxnReqDirect.chainId); - // assertTrue(bridgeHub.getHyperchain(l2TxnReqDirect.chainId) == address(mockChainContract)); - // bytes32 canonicalHash = keccak256(abi.encode("CANONICAL_TX_HASH")); + _setUpBaseTokenForChainId(l2TxnReqDirect.chainId, false, address(testToken)); - // vm.mockCall( - // address(mockChainContract), - // abi.encodeWithSelector(mockChainContract.bridgehubRequestL2Transaction.selector), - // abi.encode(canonicalHash) - // ); + assertTrue(bridgeHub.getZKChain(l2TxnReqDirect.chainId) == address(mockChainContract)); + bytes32 canonicalHash = keccak256(abi.encode("CANONICAL_TX_HASH")); -<<<<<<< HEAD - // mockChainContract.setFeeParams(); - // mockChainContract.setBaseTokenGasMultiplierPrice(uint128(1), uint128(1)); - // mockChainContract.setBridgeHubAddress(address(bridgeHub)); - // assertTrue(mockChainContract.getBridgeHubAddress() == address(bridgeHub)); + vm.mockCall( + address(mockChainContract), + abi.encodeWithSelector(mockChainContract.bridgehubRequestL2Transaction.selector), + abi.encode(canonicalHash) + ); - // vm.txGasPrice(0.05 ether); + mockChainContract.setFeeParams(); + mockChainContract.setBaseTokenGasMultiplierPrice(uint128(1), uint128(1)); + mockChainContract.setBridgeHubAddress(address(bridgeHub)); + assertTrue(mockChainContract.getBridgeHubAddress() == address(bridgeHub)); - // address randomCaller = makeAddr("RANDOM_CALLER"); - // vm.deal(randomCaller, 1 ether); -======= gasPrice = bound(gasPrice, 1_000, 50_000_000); vm.txGasPrice(gasPrice * 1 gwei); @@ -1355,66 +1172,21 @@ contract ExperimentalBridgeTest is Test { vm.prank(randomCaller); vm.expectRevert(abi.encodeWithSelector(MsgValueMismatch.selector, 0, randomCaller.balance)); bytes32 resultantHash = bridgeHub.requestL2TransactionDirect{value: randomCaller.balance}(l2TxnReqDirect); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - // vm.prank(randomCaller); - // vm.expectRevert("BH: non-eth bridge with msg.value"); - // bytes32 resultantHash = bridgeHub.requestL2TransactionDirect{value: randomCaller.balance}(l2TxnReqDirect); + // Now, let's call the same function with zero msg.value + testToken.mint(randomCaller, l2TxnReqDirect.mintValue); + assertEq(testToken.balanceOf(randomCaller), l2TxnReqDirect.mintValue); -<<<<<<< HEAD - // // Now, let's call the same function with zero msg.value - // testToken.mint(randomCaller, l2TxnReqDirect.mintValue); - // assertEq(testToken.balanceOf(randomCaller), l2TxnReqDirect.mintValue); -======= vm.prank(randomCaller); testToken.transfer(address(this), l2TxnReqDirect.mintValue); assertEq(testToken.balanceOf(address(this)), l2TxnReqDirect.mintValue); testToken.approve(sharedBridgeAddress, l2TxnReqDirect.mintValue); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // vm.prank(randomCaller); - // testToken.transfer(address(this), l2TxnReqDirect.mintValue); - // assertEq(testToken.balanceOf(address(this)), l2TxnReqDirect.mintValue); - // testToken.approve(address(mockSharedBridge), l2TxnReqDirect.mintValue); - // bytes32 baseTokenAssetIdLocation = bytes32(uint256(208)); - // vm.store( - // address(bridgeHub), - // keccak256(abi.encode(l2TxnReqDirect.chainId, baseTokenAssetIdLocation)), - // tokenAssetId - // ); - // //bytes32 resultantHash = - // vm.mockCall( - // address(mockSharedBridge), - // abi.encodeWithSelector(IL1AssetRouter.bridgehubDepositBaseToken.selector), - // abi.encode(true) - // ); - // resultantHash = bridgeHub.requestL2TransactionDirect(l2TxnReqDirect); - - // assertEq(canonicalHash, resultantHash); - // } - -<<<<<<< HEAD - // function test_requestL2TransactionTwoBridges_ETHCase( - // uint256 chainId, - // uint256 mintValue, - // uint256 l2Value, - // uint256 l2GasLimit, - // uint256 l2GasPerPubdataByteLimit, - // address refundRecipient, - // uint256 secondBridgeValue, - // bytes memory secondBridgeCalldata - // ) public { - // L2TransactionRequestTwoBridgesOuter memory l2TxnReq2BridgeOut = _createMockL2TransactionRequestTwoBridgesOuter({ - // chainId: chainId, - // mintValue: mintValue, - // l2Value: l2Value, - // l2GasLimit: l2GasLimit, - // l2GasPerPubdataByteLimit: l2GasPerPubdataByteLimit, - // refundRecipient: refundRecipient, - // secondBridgeValue: secondBridgeValue, - // secondBridgeCalldata: secondBridgeCalldata - // }); -======= + + resultantHash = bridgeHub.requestL2TransactionDirect(l2TxnReqDirect); + + assertEq(canonicalHash, resultantHash); + } + function test_requestTransactionTwoBridgesChecksMagicValue( uint256 chainId, uint256 mintValue, @@ -1426,6 +1198,11 @@ contract ExperimentalBridgeTest is Test { bytes memory secondBridgeCalldata, bytes32 magicValue ) public { + _useMockSharedBridge(); + _initializeBridgehub(); + + vm.assume(magicValue != TWO_BRIDGES_MAGIC_VALUE); + chainId = bound(chainId, 1, type(uint48).max); L2TransactionRequestTwoBridgesOuter memory l2TxnReq2BridgeOut = _createMockL2TransactionRequestTwoBridgesOuter({ @@ -1438,48 +1215,35 @@ contract ExperimentalBridgeTest is Test { secondBridgeValue: secondBridgeValue, secondBridgeCalldata: secondBridgeCalldata }); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - // l2TxnReq2BridgeOut.chainId = _setUpHyperchainForChainId(l2TxnReq2BridgeOut.chainId); + l2TxnReq2BridgeOut.chainId = _setUpZKChainForChainId(l2TxnReq2BridgeOut.chainId); -<<<<<<< HEAD - // _setUpBaseTokenForChainId(l2TxnReq2BridgeOut.chainId, true); - // assertTrue(bridgeHub.baseToken(l2TxnReq2BridgeOut.chainId) == ETH_TOKEN_ADDRESS); - - // _setUpSharedBridge(); - // assertTrue(bridgeHub.getHyperchain(l2TxnReq2BridgeOut.chainId) == address(mockChainContract)); -======= _setUpBaseTokenForChainId(l2TxnReq2BridgeOut.chainId, true, address(0)); assertTrue(bridgeHub.baseToken(l2TxnReq2BridgeOut.chainId) == ETH_TOKEN_ADDRESS); - _setUpSharedBridge(); - _setUpSharedBridgeL2(chainId); - - assertTrue(bridgeHub.getHyperchain(l2TxnReq2BridgeOut.chainId) == address(mockChainContract)); + assertTrue(bridgeHub.getZKChain(l2TxnReq2BridgeOut.chainId) == address(mockChainContract)); uint256 callerMsgValue = l2TxnReq2BridgeOut.mintValue + l2TxnReq2BridgeOut.secondBridgeValue; address randomCaller = makeAddr("RANDOM_CALLER"); vm.deal(randomCaller, callerMsgValue); - if (magicValue != TWO_BRIDGES_MAGIC_VALUE) { - L2TransactionRequestTwoBridgesInner memory request = L2TransactionRequestTwoBridgesInner({ - magicValue: magicValue, - l2Contract: makeAddr("L2_CONTRACT"), - l2Calldata: new bytes(0), - factoryDeps: new bytes[](0), - txDataHash: bytes32(0) - }); + L2TransactionRequestTwoBridgesInner memory request = L2TransactionRequestTwoBridgesInner({ + magicValue: magicValue, + l2Contract: makeAddr("L2_CONTRACT"), + l2Calldata: new bytes(0), + factoryDeps: new bytes[](0), + txDataHash: bytes32(0) + }); - vm.mockCall( - secondBridgeAddress, - abi.encodeWithSelector(IL1SharedBridge.bridgehubDeposit.selector), - abi.encode(request) - ); + vm.mockCall( + secondBridgeAddress, + abi.encodeWithSelector(IL1AssetRouter.bridgehubDeposit.selector), + abi.encode(request) + ); - vm.expectRevert(abi.encodeWithSelector(WrongMagicValue.selector, TWO_BRIDGES_MAGIC_VALUE, magicValue)); - vm.prank(randomCaller); - bridgeHub.requestL2TransactionTwoBridges{value: randomCaller.balance}(l2TxnReq2BridgeOut); - } + vm.expectRevert(abi.encodeWithSelector(WrongMagicValue.selector, TWO_BRIDGES_MAGIC_VALUE, magicValue)); + vm.prank(randomCaller); + bridgeHub.requestL2TransactionTwoBridges{value: randomCaller.balance}(l2TxnReq2BridgeOut); } function test_requestL2TransactionTwoBridgesWrongBridgeAddress( @@ -1494,6 +1258,9 @@ contract ExperimentalBridgeTest is Test { uint160 secondBridgeAddressValue, bytes memory secondBridgeCalldata ) public { + _useMockSharedBridge(); + _initializeBridgehub(); + chainId = bound(chainId, 1, type(uint48).max); L2TransactionRequestTwoBridgesOuter memory l2TxnReq2BridgeOut = _createMockL2TransactionRequestTwoBridgesOuter({ @@ -1507,49 +1274,21 @@ contract ExperimentalBridgeTest is Test { secondBridgeCalldata: secondBridgeCalldata }); - l2TxnReq2BridgeOut.chainId = _setUpHyperchainForChainId(l2TxnReq2BridgeOut.chainId); + l2TxnReq2BridgeOut.chainId = _setUpZKChainForChainId(l2TxnReq2BridgeOut.chainId); _setUpBaseTokenForChainId(l2TxnReq2BridgeOut.chainId, true, address(0)); assertTrue(bridgeHub.baseToken(l2TxnReq2BridgeOut.chainId) == ETH_TOKEN_ADDRESS); - _setUpSharedBridge(); - _setUpSharedBridgeL2(chainId); - - assertTrue(bridgeHub.getHyperchain(l2TxnReq2BridgeOut.chainId) == address(mockChainContract)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - - // uint256 callerMsgValue = l2TxnReq2BridgeOut.mintValue + l2TxnReq2BridgeOut.secondBridgeValue; - // address randomCaller = makeAddr("RANDOM_CALLER"); - // vm.deal(randomCaller, callerMsgValue); - - // mockChainContract.setBridgeHubAddress(address(bridgeHub)); - // { - // bytes32 canonicalHash = keccak256(abi.encode("CANONICAL_TX_HASH")); - - // vm.mockCall( - // address(mockChainContract), - // abi.encodeWithSelector(mockChainContract.bridgehubRequestL2Transaction.selector), - // abi.encode(canonicalHash) - // ); - // } - // bytes32 baseTokenAssetIdLocation = bytes32(uint256(208)); - // vm.store( - // address(bridgeHub), - // keccak256(abi.encode(l2TxnReq2BridgeOut.chainId, baseTokenAssetIdLocation)), - // ETH_TOKEN_ASSET_ID - // ); - // vm.mockCall( - // address(mockSharedBridge), - // abi.encodeWithSelector(IL1AssetRouter.bridgehubDepositBaseToken.selector), - // abi.encode(true) - // ); - // vm.prank(randomCaller); - // bridgeHub.requestL2TransactionTwoBridges{value: randomCaller.balance}(l2TxnReq2BridgeOut); - -<<<<<<< HEAD - // assertTrue(true); - // } -======= + assertTrue(bridgeHub.getZKChain(l2TxnReq2BridgeOut.chainId) == address(mockChainContract)); + + uint256 callerMsgValue = l2TxnReq2BridgeOut.mintValue + l2TxnReq2BridgeOut.secondBridgeValue; + address randomCaller = makeAddr("RANDOM_CALLER"); + vm.deal(randomCaller, callerMsgValue); + + mockChainContract.setBridgeHubAddress(address(bridgeHub)); + + bytes32 canonicalHash = keccak256(abi.encode("CANONICAL_TX_HASH")); + vm.mockCall( address(mockChainContract), abi.encodeWithSelector(mockChainContract.bridgehubRequestL2Transaction.selector), @@ -1570,7 +1309,7 @@ contract ExperimentalBridgeTest is Test { address(secondBridgeAddressValue), l2TxnReq2BridgeOut.secondBridgeValue, abi.encodeWithSelector( - IL1SharedBridge.bridgehubDeposit.selector, + IL1AssetRouter.bridgehubDeposit.selector, l2TxnReq2BridgeOut.chainId, randomCaller, l2TxnReq2BridgeOut.l2Value, @@ -1594,13 +1333,17 @@ contract ExperimentalBridgeTest is Test { address l2Receiver, uint256 randomValue ) public useRandomToken(randomValue) { + _useFullSharedBridge(); + _initializeBridgehub(); + vm.assume(mintValue > 0); + // create another token, to avoid base token TestnetERC20Token erc20Token = new TestnetERC20Token("ZKESTT", "ZkSync ERC Test Token", 18); address erc20TokenAddress = address(erc20Token); l2Value = bound(l2Value, 1, type(uint256).max); bytes memory secondBridgeCalldata = abi.encode(erc20TokenAddress, l2Value, l2Receiver); - chainId = _setUpHyperchainForChainId(chainId); + chainId = _setUpZKChainForChainId(chainId); L2TransactionRequestTwoBridgesOuter memory l2TxnReq2BridgeOut = _createMockL2TransactionRequestTwoBridgesOuter({ chainId: chainId, @@ -1618,10 +1361,7 @@ contract ExperimentalBridgeTest is Test { _setUpBaseTokenForChainId(l2TxnReq2BridgeOut.chainId, false, address(testToken)); assertTrue(bridgeHub.baseToken(l2TxnReq2BridgeOut.chainId) == address(testToken)); - _setUpSharedBridge(); - - _setUpSharedBridgeL2(chainId); - assertTrue(bridgeHub.getHyperchain(l2TxnReq2BridgeOut.chainId) == address(mockChainContract)); + assertTrue(bridgeHub.getZKChain(l2TxnReq2BridgeOut.chainId) == address(mockChainContract)); mockChainContract.setBridgeHubAddress(address(bridgeHub)); vm.mockCall( @@ -1644,10 +1384,10 @@ contract ExperimentalBridgeTest is Test { bytes32 resultHash = bridgeHub.requestL2TransactionTwoBridges(l2TxnReq2BridgeOut); assertEq(resultHash, canonicalHash); - assert(erc20Token.balanceOf(randomCaller) == 0); - assert(testToken.balanceOf(randomCaller) == 0); - assert(erc20Token.balanceOf(secondBridgeAddress) == l2Value); - assert(testToken.balanceOf(sharedBridgeAddress) == l2TxnReq2BridgeOut.mintValue); + assertEq(erc20Token.balanceOf(randomCaller), 0); + assertEq(testToken.balanceOf(randomCaller), 0); + assertEq(erc20Token.balanceOf(address(ntv)), l2Value); + assertEq(testToken.balanceOf(address(ntv)), l2TxnReq2BridgeOut.mintValue); l2TxnReq2BridgeOut.secondBridgeValue = 1; testToken.mint(randomCaller, l2TxnReq2BridgeOut.mintValue); @@ -1670,10 +1410,14 @@ contract ExperimentalBridgeTest is Test { address l2Receiver, uint256 randomValue ) public useRandomToken(randomValue) { + _useFullSharedBridge(); + _initializeBridgehub(); + vm.assume(mintValue > 0); + secondBridgeValue = bound(secondBridgeValue, 1, type(uint256).max); bytes memory secondBridgeCalldata = abi.encode(ETH_TOKEN_ADDRESS, 0, l2Receiver); - chainId = _setUpHyperchainForChainId(chainId); + chainId = _setUpZKChainForChainId(chainId); L2TransactionRequestTwoBridgesOuter memory l2TxnReq2BridgeOut = _createMockL2TransactionRequestTwoBridgesOuter({ chainId: chainId, @@ -1688,10 +1432,7 @@ contract ExperimentalBridgeTest is Test { _setUpBaseTokenForChainId(l2TxnReq2BridgeOut.chainId, false, address(testToken)); assertTrue(bridgeHub.baseToken(l2TxnReq2BridgeOut.chainId) == address(testToken)); - - _setUpSharedBridge(); - _setUpSharedBridgeL2(chainId); - assertTrue(bridgeHub.getHyperchain(l2TxnReq2BridgeOut.chainId) == address(mockChainContract)); + assertTrue(bridgeHub.getZKChain(l2TxnReq2BridgeOut.chainId) == address(mockChainContract)); address randomCaller = makeAddr("RANDOM_CALLER"); @@ -1725,7 +1466,6 @@ contract ExperimentalBridgeTest is Test { vm.prank(randomCaller); bridgeHub.requestL2TransactionTwoBridges{value: randomCaller.balance}(l2TxnReq2BridgeOut); } ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe ///////////////////////////////////////////////////////// // INTERNAL UTILITY FUNCTIONS @@ -1832,61 +1572,42 @@ contract ExperimentalBridgeTest is Test { forceDeploymentsData: bytes("") }); - mockSTM.setChainCreationParams(params); + mockCTM.setChainCreationParams(params); return abi.encode(abi.encode(diamondCutData), bytes("")); } - function _setUpHyperchainForChainId(uint256 mockChainId) internal returns (uint256 mockChainIdInRange) { + function _setUpZKChainForChainId(uint256 mockChainId) internal returns (uint256 mockChainIdInRange) { mockChainId = bound(mockChainId, 1, type(uint48).max); mockChainIdInRange = mockChainId; - vm.prank(bridgeOwner); - bridgeHub.addStateTransitionManager(address(mockSTM)); - // We need to set the stateTransitionManager of the mockChainId to mockSTM - // There is no function to do that in the bridgeHub - // So, perhaps we will have to manually set the values in the stateTransitionManager mapping via a foundry cheatcode - assertTrue(!(bridgeHub.stateTransitionManager(mockChainId) == address(mockSTM))); + if (!bridgeHub.chainTypeManagerIsRegistered(address(mockCTM))) { + vm.prank(bridgeOwner); + bridgeHub.addChainTypeManager(address(mockCTM)); + } - stdstore.target(address(bridgeHub)).sig("stateTransitionManager(uint256)").with_key(mockChainId).checked_write( - address(mockSTM) - ); + // We need to set the chainTypeManager of the mockChainId to mockCTM + // There is no function to do that in the bridgeHub + // So, perhaps we will have to manually set the values in the chainTypeManager mapping via a foundry cheatcode + assertTrue(!(bridgeHub.chainTypeManager(mockChainId) == address(mockCTM))); - // Now in the StateTransitionManager that has been set for our mockChainId, we set the hyperchain contract as our mockChainContract - mockSTM.setHyperchain(mockChainId, address(mockChainContract)); + dummyBridgehub.setCTM(mockChainId, address(mockCTM)); + dummyBridgehub.setZKChain(mockChainId, address(mockChainContract)); } function _setUpBaseTokenForChainId(uint256 mockChainId, bool tokenIsETH, address token) internal { - address baseToken = tokenIsETH ? ETH_TOKEN_ADDRESS : token; - - stdstore.target(address(bridgeHub)).sig("baseToken(uint256)").with_key(mockChainId).checked_write(baseToken); - } - -<<<<<<< HEAD - // function _setUpSharedBridge() internal { - // vm.prank(bridgeOwner); - // bridgeHub.setSharedBridge(address(mockSharedBridge)); - // } -======= - function _setUpSharedBridge() internal { - vm.prank(bridgeOwner); - bridgeHub.setSharedBridge(sharedBridgeAddress); - } - - function _setUpSharedBridgeL2(uint256 _chainId) internal { - _chainId = bound(_chainId, 1, type(uint48).max); - - vm.prank(bridgeOwner); - sharedBridge.initializeChainGovernance(_chainId, mockL2Contract); - - assertEq(sharedBridge.l2BridgeAddress(_chainId), mockL2Contract); + if (tokenIsETH) { + token = ETH_TOKEN_ADDRESS; + } else { + ntv.registerToken(token); + } - vm.prank(bridgeOwner); - secondBridge.initializeChainGovernance(_chainId, mockL2Contract); + bytes32 baseTokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, token); - assertEq(secondBridge.l2BridgeAddress(_chainId), mockL2Contract); + stdstore.target(address(bridgeHub)).sig("baseTokenAssetId(uint256)").with_key(mockChainId).checked_write( + baseTokenAssetId + ); } ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe function _createMockL2TransactionRequestDirect( uint256 mockChainId, @@ -1957,7 +1678,7 @@ contract ExperimentalBridgeTest is Test { bytes memory randomData ) public { vm.startPrank(bridgeOwner); - bridgeHub.addStateTransitionManager(address(mockSTM)); + bridgeHub.addChainTypeManager(address(mockCTM)); vm.stopPrank(); L2Message memory l2Message = _createMockL2Message(randomTxNumInBatch, randomSender, randomData); @@ -2000,7 +1721,7 @@ contract ExperimentalBridgeTest is Test { bytes32 randomValue ) public { vm.startPrank(bridgeOwner); - bridgeHub.addStateTransitionManager(address(mockSTM)); + bridgeHub.addChainTypeManager(address(mockCTM)); vm.stopPrank(); L2Log memory l2Log = _createMockL2Log({ @@ -2047,7 +1768,7 @@ contract ExperimentalBridgeTest is Test { bool randomResultantBool ) public { vm.startPrank(bridgeOwner); - bridgeHub.addStateTransitionManager(address(mockSTM)); + bridgeHub.addChainTypeManager(address(mockCTM)); vm.stopPrank(); TxStatus txStatus; diff --git a/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/ClaimFailedDeposit.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/ClaimFailedDeposit.t.sol new file mode 100644 index 000000000..aecde91f8 --- /dev/null +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/ClaimFailedDeposit.t.sol @@ -0,0 +1,29 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {L1Erc20BridgeTest} from "./_L1Erc20Bridge_Shared.t.sol"; +import {StdStorage, stdStorage} from "forge-std/Test.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; +import {EmptyDeposit} from "contracts/common/L1ContractErrors.sol"; + +contract ClaimFailedDepositTest is L1Erc20BridgeTest { + using stdStorage for StdStorage; + + event ClaimedFailedDeposit(address indexed to, address indexed l1Token, uint256 amount); + + function test_RevertWhen_ClaimAmountIsZero() public { + vm.expectRevert(EmptyDeposit.selector); + bytes32[] memory merkleProof; + + bridge.claimFailedDeposit({ + _depositSender: randomSigner, + _l1Token: address(token), + _l2TxHash: bytes32(""), + _l2BatchNumber: 0, + _l2MessageIndex: 0, + _l2TxNumberInBatch: 0, + _merkleProof: merkleProof + }); + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/Deposit.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/Deposit.t.sol similarity index 95% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/Deposit.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/Deposit.t.sol index 6ac86dbe2..3e4d305f6 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/Deposit.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/Deposit.t.sol @@ -2,10 +2,10 @@ pragma solidity 0.8.24; -import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; +import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; import {L1Erc20BridgeTest} from "./_L1Erc20Bridge_Shared.t.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; import {EmptyDeposit, ValueMismatch, TokensWithFeesNotSupported} from "contracts/common/L1ContractErrors.sol"; -import {IL1SharedBridge} from "contracts/bridge/interfaces/IL1SharedBridge.sol"; contract DepositTest is L1Erc20BridgeTest { event DepositInitiated( @@ -130,7 +130,7 @@ contract DepositTest is L1Erc20BridgeTest { vm.mockCall( sharedBridgeAddress, abi.encodeWithSelector( - IL1SharedBridge.depositLegacyErc20Bridge.selector, + IL1AssetRouter.depositLegacyErc20Bridge.selector, alice, randomSigner, address(token), @@ -173,7 +173,7 @@ contract DepositTest is L1Erc20BridgeTest { vm.mockCall( sharedBridgeAddress, abi.encodeWithSelector( - IL1SharedBridge.depositLegacyErc20Bridge.selector, + IL1AssetRouter.depositLegacyErc20Bridge.selector, alice, randomSigner, address(token), diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/FinalizeWithdrawal.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/FinalizeWithdrawal.sol similarity index 69% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/FinalizeWithdrawal.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/FinalizeWithdrawal.sol index 59cc80323..6af9fb369 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/FinalizeWithdrawal.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/FinalizeWithdrawal.sol @@ -3,9 +3,12 @@ pragma solidity 0.8.24; import {L1Erc20BridgeTest} from "./_L1Erc20Bridge_Shared.t.sol"; -import {IL1SharedBridge} from "contracts/bridge/interfaces/IL1SharedBridge.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; import {StdStorage, stdStorage} from "forge-std/Test.sol"; import {WithdrawalAlreadyFinalized} from "contracts/common/L1ContractErrors.sol"; +import {IL1Nullifier} from "contracts/bridge/L1Nullifier.sol"; +import {FinalizeL1DepositParams} from "contracts/bridge/interfaces/IL1Nullifier.sol"; +import {L2_ASSET_ROUTER_ADDR} from "contracts/common/L2ContractAddresses.sol"; contract FinalizeWithdrawalTest is L1Erc20BridgeTest { using stdStorage for StdStorage; @@ -43,24 +46,25 @@ contract FinalizeWithdrawalTest is L1Erc20BridgeTest { uint256 amount = 999; assertFalse(bridge.isWithdrawalFinalized(l2BatchNumber, l2MessageIndex)); - + FinalizeL1DepositParams memory finalizeWithdrawalParams = FinalizeL1DepositParams({ + chainId: eraChainId, + l2BatchNumber: l2BatchNumber, + l2MessageIndex: l2MessageIndex, + l2Sender: L2_ASSET_ROUTER_ADDR, + l2TxNumberInBatch: uint16(txNumberInBatch), + message: "", + merkleProof: merkleProof + }); vm.mockCall( - sharedBridgeAddress, - abi.encodeWithSelector( - IL1SharedBridge.finalizeWithdrawalLegacyErc20Bridge.selector, - l2BatchNumber, - l2MessageIndex, - txNumberInBatch, - "", - merkleProof - ), + l1NullifierAddress, + abi.encodeWithSelector(IL1Nullifier.finalizeDeposit.selector, finalizeWithdrawalParams), abi.encode(alice, address(token), amount) ); vm.prank(alice); // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, true, address(bridge)); - emit WithdrawalFinalized(alice, address(token), amount); + // vm.expectEmit(true, true, true, true, address(bridge)); + // emit WithdrawalFinalized(alice, address(token), amount); bridge.finalizeWithdrawal({ _l2BatchNumber: l2BatchNumber, diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/Getters.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/Getters.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/Getters.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/Getters.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/Initialization.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/Initialization.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/Initialization.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/Initialization.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/Reentrancy.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/Reentrancy.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/Reentrancy.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/Reentrancy.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/_L1Erc20Bridge_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/_L1Erc20Bridge_Shared.t.sol similarity index 57% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/_L1Erc20Bridge_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/_L1Erc20Bridge_Shared.t.sol index 58a44c403..fb0c30c58 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/_L1Erc20Bridge_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1Erc20Bridge/_L1Erc20Bridge_Shared.t.sol @@ -6,13 +6,16 @@ import {StdStorage, stdStorage} from "forge-std/Test.sol"; import {Test} from "forge-std/Test.sol"; import {L1ERC20Bridge} from "contracts/bridge/L1ERC20Bridge.sol"; -import {L1NativeTokenVault} from "contracts/bridge/L1NativeTokenVault.sol"; -import {IL1AssetRouter} from "contracts/bridge/interfaces/IL1AssetRouter.sol"; +import {L1NativeTokenVault} from "contracts/bridge/ntv/L1NativeTokenVault.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; import {TestnetERC20Token} from "contracts/dev-contracts/TestnetERC20Token.sol"; import {FeeOnTransferToken} from "contracts/dev-contracts/FeeOnTransferToken.sol"; import {ReenterL1ERC20Bridge} from "contracts/dev-contracts/test/ReenterL1ERC20Bridge.sol"; +import {DummySharedBridge} from "contracts/dev-contracts/test/DummySharedBridge.sol"; import {Utils} from "../../Utils/Utils.sol"; -import {IL1NativeTokenVault} from "contracts/bridge/interfaces/IL1NativeTokenVault.sol"; +import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; +import {IL1NativeTokenVault} from "contracts/bridge/ntv/IL1NativeTokenVault.sol"; +import {IL1Nullifier} from "contracts/bridge/L1Nullifier.sol"; contract L1Erc20BridgeTest is Test { L1ERC20Bridge internal bridge; @@ -25,31 +28,41 @@ contract L1Erc20BridgeTest is Test { address internal randomSigner; address internal alice; address sharedBridgeAddress; + address l1NullifierAddress; + bytes32 internal dummyL2DepositTxHash; + uint256 eraChainId = 9; constructor() { randomSigner = makeAddr("randomSigner"); + dummyL2DepositTxHash = Utils.randomBytes32("dummyL2DepositTxHash"); + sharedBridgeAddress = makeAddr("sharedBridgeAddress"); alice = makeAddr("alice"); + l1NullifierAddress = makeAddr("l1NullifierAddress"); -<<<<<<< HEAD - dummySharedBridge = new DummySharedBridge(dummyL2DepositTxHash); - uint256 eraChainId = 9; bridge = new L1ERC20Bridge( - IL1AssetRouter(address(dummySharedBridge)), + IL1Nullifier(l1NullifierAddress), + IL1AssetRouter(sharedBridgeAddress), IL1NativeTokenVault(address(1)), eraChainId ); address weth = makeAddr("weth"); - L1NativeTokenVault ntv = new L1NativeTokenVault(weth, IL1AssetRouter(address(dummySharedBridge))); + L1NativeTokenVault ntv = new L1NativeTokenVault( + weth, + sharedBridgeAddress, + eraChainId, + IL1Nullifier(l1NullifierAddress) + ); vm.store(address(bridge), bytes32(uint256(212)), bytes32(0)); -======= - sharedBridgeAddress = makeAddr("shared bridge"); - bridge = new L1ERC20Bridge(IL1SharedBridge(sharedBridgeAddress)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe reenterL1ERC20Bridge = new ReenterL1ERC20Bridge(); - bridgeReenterItself = new L1ERC20Bridge(IL1AssetRouter(address(reenterL1ERC20Bridge)), ntv, eraChainId); + bridgeReenterItself = new L1ERC20Bridge( + IL1Nullifier(address(reenterL1ERC20Bridge)), + IL1AssetRouter(address(reenterL1ERC20Bridge)), + ntv, + eraChainId + ); reenterL1ERC20Bridge.setBridge(bridgeReenterItself); token = new TestnetERC20Token("TestnetERC20Token", "TET", 18); diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeBase.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeBase.t.sol similarity index 85% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeBase.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeBase.t.sol index 3ced5fb4e..dd3b8c145 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeBase.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeBase.t.sol @@ -1,7 +1,7 @@ // SPDX-License-Identifier: MIT pragma solidity 0.8.24; -import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; +import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; import {L1AssetRouterTest} from "./_L1SharedBridge_Shared.t.sol"; @@ -9,12 +9,15 @@ import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; import {L2Message, TxStatus} from "contracts/common/Messaging.sol"; import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol"; -import {IL1AssetRouter} from "contracts/bridge/interfaces/IL1AssetRouter.sol"; -import {IL1NativeTokenVault} from "contracts/bridge/interfaces/IL1NativeTokenVault.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; +import {IAssetRouterBase} from "contracts/bridge/asset-router/IAssetRouterBase.sol"; +import {IL1AssetHandler} from "contracts/bridge/interfaces/IL1AssetHandler.sol"; +import {IL1BaseTokenAssetHandler} from "contracts/bridge/interfaces/IL1BaseTokenAssetHandler.sol"; import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR, L2_ASSET_ROUTER_ADDR} from "contracts/common/L2ContractAddresses.sol"; import {IGetters} from "contracts/state-transition/chain-interfaces/IGetters.sol"; -import {L1NativeTokenVault} from "contracts/bridge/L1NativeTokenVault.sol"; +import {L1NativeTokenVault} from "contracts/bridge/ntv/L1NativeTokenVault.sol"; import {StdStorage, stdStorage} from "forge-std/Test.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; contract L1AssetRouterTestBase is L1AssetRouterTest { using stdStorage for StdStorage; @@ -34,25 +37,6 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { assertEq(sharedBridge.paused(), false, "Shared Bridge Remains Paused"); } - function test_setAssetHandlerAddressOnCounterPart() public payable { - uint256 l2TxGasLimit = 100000; - uint256 l2TxGasPerPubdataByte = 100; - uint256 mintValue = 1; - address refundRecipient = address(0); - - vm.deal(owner, amount); - vm.prank(owner); - sharedBridge.setAssetHandlerAddressOnCounterPart{value: 1}( - eraChainId, - mintValue, - l2TxGasLimit, - l2TxGasPerPubdataByte, - refundRecipient, - tokenAssetId, - address(token) - ); - } - function test_bridgehubDepositBaseToken_Eth() public { vm.prank(bridgehubAddress); // solhint-disable-next-line func-named-parameters @@ -88,10 +72,10 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { bob, address(ETH_TOKEN_ADDRESS), amount, - nativeTokenVault.getERC20Getters(address(ETH_TOKEN_ADDRESS)) + nativeTokenVault.getERC20Getters(address(ETH_TOKEN_ADDRESS), chainId) ); // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, true, address(sharedBridge)); + vm.expectEmit(true, true, true, false, address(sharedBridge)); vm.prank(bridgehubAddress); emit BridgehubDepositInitiated({ chainId: chainId, @@ -122,7 +106,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { // ToDo: remove the mock call and register custom asset handler? vm.mockCall( address(nativeTokenVault), - abi.encodeWithSelector(IL1NativeTokenVault.tokenAddress.selector, tokenAssetId), + abi.encodeWithSelector(IL1BaseTokenAssetHandler.tokenAddress.selector, tokenAssetId), abi.encode(address(0)) ); vm.prank(bridgehubAddress); @@ -131,7 +115,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { function test_bridgehubConfirmL2Transaction() public { // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, false, address(sharedBridge)); + vm.expectEmit(true, true, true, false, address(l1Nullifier)); bytes32 txDataHash = keccak256(abi.encode(alice, address(token), amount)); emit BridgehubDepositFinalized(chainId, txDataHash, txHash); vm.prank(bridgehubAddress); @@ -141,7 +125,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { function test_claimFailedDeposit_Erc() public { bytes32 txDataHash = keccak256(abi.encode(alice, address(token), amount)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - require(sharedBridge.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); + require(l1Nullifier.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); vm.mockCall( bridgehubAddress, @@ -161,16 +145,15 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit ClaimedFailedDepositSharedBridge({ + emit ClaimedFailedDepositAssetRouter({ chainId: chainId, - to: alice, assetId: tokenAssetId, assetData: abi.encode(bytes32(0)) }); - sharedBridge.claimFailedDeposit({ + l1Nullifier.claimFailedDeposit({ _chainId: chainId, _depositSender: alice, - _l1Asset: address(token), + _l1Token: address(token), _amount: amount, _l2TxHash: txHash, _l2BatchNumber: l2BatchNumber, @@ -183,7 +166,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { function test_claimFailedDeposit_Eth() public { bytes32 txDataHash = keccak256(abi.encode(alice, ETH_TOKEN_ADDRESS, amount)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - require(sharedBridge.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); + require(l1Nullifier.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); vm.mockCall( bridgehubAddress, @@ -203,16 +186,15 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit ClaimedFailedDepositSharedBridge({ + emit ClaimedFailedDepositAssetRouter({ chainId: chainId, - to: alice, assetId: ETH_TOKEN_ASSET_ID, assetData: abi.encode(bytes32(0)) }); - sharedBridge.claimFailedDeposit({ + l1Nullifier.claimFailedDeposit({ _chainId: chainId, _depositSender: alice, - _l1Asset: ETH_TOKEN_ADDRESS, + _l1Token: ETH_TOKEN_ADDRESS, _amount: amount, _l2TxHash: txHash, _l2BatchNumber: l2BatchNumber, @@ -226,7 +208,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { bytes memory transferData = abi.encode(amount, alice); bytes32 txDataHash = keccak256(abi.encode(alice, ETH_TOKEN_ADDRESS, amount)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - require(sharedBridge.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); + require(l1Nullifier.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); vm.mockCall( bridgehubAddress, @@ -246,13 +228,12 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit ClaimedFailedDepositSharedBridge({ + emit ClaimedFailedDepositAssetRouter({ chainId: chainId, - to: alice, assetId: ETH_TOKEN_ASSET_ID, assetData: abi.encode(bytes32(0)) }); - sharedBridge.bridgeRecoverFailedTransfer({ + l1Nullifier.bridgeRecoverFailedTransfer({ _chainId: chainId, _depositSender: alice, _assetId: ETH_TOKEN_ASSET_ID, @@ -289,7 +270,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, ETH_TOKEN_ASSET_ID, amount); + emit DepositFinalizedAssetRouter(chainId, ETH_TOKEN_ASSET_ID, message); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -303,9 +284,10 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { function test_finalizeWithdrawal_ErcOnEth() public { _setNativeTokenVaultChainBalance(chainId, address(token), amount); bytes memory message = abi.encodePacked( - IL1AssetRouter.finalizeWithdrawal.selector, + IAssetRouterBase.finalizeDeposit.selector, + chainId, tokenAssetId, - abi.encode(amount, alice) + abi.encode(0, alice, 0, amount, new bytes(0)) ); L2Message memory l2ToL1Message = L2Message({ txNumberInBatch: l2TxNumberInBatch, @@ -329,7 +311,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, tokenAssetId, amount); + emit DepositFinalizedAssetRouter(chainId, tokenAssetId, message); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -348,9 +330,10 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { vm.prank(bridgehubAddress); bytes memory message = abi.encodePacked( - IL1AssetRouter.finalizeWithdrawal.selector, + IAssetRouterBase.finalizeDeposit.selector, + chainId, ETH_TOKEN_ASSET_ID, - abi.encode(amount, alice) + abi.encode(0, alice, 0, amount, new bytes(0)) ); L2Message memory l2ToL1Message = L2Message({ txNumberInBatch: l2TxNumberInBatch, @@ -374,7 +357,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, ETH_TOKEN_ASSET_ID, amount); + emit DepositFinalizedAssetRouter(chainId, ETH_TOKEN_ASSET_ID, message); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -390,9 +373,10 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { vm.prank(bridgehubAddress); bytes memory message = abi.encodePacked( - IL1AssetRouter.finalizeWithdrawal.selector, + IAssetRouterBase.finalizeDeposit.selector, + chainId, tokenAssetId, - abi.encode(amount, alice) + abi.encode(0, alice, 0, amount, new bytes(0)) ); L2Message memory l2ToL1Message = L2Message({ txNumberInBatch: l2TxNumberInBatch, @@ -416,7 +400,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, tokenAssetId, amount); + emit DepositFinalizedAssetRouter(chainId, tokenAssetId, abi.encode(amount, alice)); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -429,9 +413,10 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { function test_finalizeWithdrawal_NonBaseErcOnErc() public { bytes memory message = abi.encodePacked( - IL1AssetRouter.finalizeWithdrawal.selector, + IAssetRouterBase.finalizeDeposit.selector, + chainId, tokenAssetId, - abi.encode(amount, alice) + abi.encode(0, alice, 0, amount, new bytes(0)) ); vm.mockCall( bridgehubAddress, @@ -461,7 +446,7 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, tokenAssetId, amount); + emit DepositFinalizedAssetRouter(chainId, tokenAssetId, message); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -473,22 +458,23 @@ contract L1AssetRouterTestBase is L1AssetRouterTest { } function test_safeTransferFundsFromSharedBridge_Erc() public { - uint256 startBalanceNtv = nativeTokenVault.chainBalance(chainId, address(token)); + bytes32 assetId = DataEncoding.encodeNTVAssetId(block.chainid, address(token)); + uint256 startBalanceNtv = nativeTokenVault.chainBalance(chainId, assetId); // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, false, true, address(token)); - emit IERC20.Transfer(address(sharedBridge), address(nativeTokenVault), amount); + emit IERC20.Transfer(address(l1Nullifier), address(nativeTokenVault), amount); nativeTokenVault.transferFundsFromSharedBridge(address(token)); nativeTokenVault.updateChainBalancesFromSharedBridge(address(token), chainId); - uint256 endBalanceNtv = nativeTokenVault.chainBalance(chainId, address(token)); + uint256 endBalanceNtv = nativeTokenVault.chainBalance(chainId, assetId); assertEq(endBalanceNtv - startBalanceNtv, amount); } function test_safeTransferFundsFromSharedBridge_Eth() public { uint256 startEthBalanceNtv = address(nativeTokenVault).balance; - uint256 startBalanceNtv = nativeTokenVault.chainBalance(chainId, ETH_TOKEN_ADDRESS); + uint256 startBalanceNtv = nativeTokenVault.chainBalance(chainId, ETH_TOKEN_ASSET_ID); nativeTokenVault.transferFundsFromSharedBridge(ETH_TOKEN_ADDRESS); nativeTokenVault.updateChainBalancesFromSharedBridge(ETH_TOKEN_ADDRESS, chainId); - uint256 endBalanceNtv = nativeTokenVault.chainBalance(chainId, ETH_TOKEN_ADDRESS); + uint256 endBalanceNtv = nativeTokenVault.chainBalance(chainId, ETH_TOKEN_ASSET_ID); uint256 endEthBalanceNtv = address(nativeTokenVault).balance; assertEq(endBalanceNtv - startBalanceNtv, amount); assertEq(endEthBalanceNtv - startEthBalanceNtv, amount); diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeFails.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeFails.t.sol similarity index 64% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeFails.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeFails.t.sol index 7c3e05809..0131721a0 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeFails.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeFails.t.sol @@ -8,37 +8,30 @@ import {L1AssetRouterTest} from "./_L1SharedBridge_Shared.t.sol"; import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; import {IERC20} from "@openzeppelin/contracts-v4/token/ERC20/IERC20.sol"; -import {L1AssetRouter} from "contracts/bridge/L1AssetRouter.sol"; -import {L1NativeTokenVault} from "contracts/bridge/L1NativeTokenVault.sol"; +import {L1AssetRouter} from "contracts/bridge/asset-router/L1AssetRouter.sol"; +import {L1NativeTokenVault} from "contracts/bridge/ntv/L1NativeTokenVault.sol"; import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; import {L2Message, TxStatus} from "contracts/common/Messaging.sol"; import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol"; import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; -import {IL1NativeTokenVault} from "contracts/bridge/interfaces/IL1NativeTokenVault.sol"; -import {L1NativeTokenVault} from "contracts/bridge/L1NativeTokenVault.sol"; +import {IL1NativeTokenVault} from "contracts/bridge/ntv/IL1NativeTokenVault.sol"; +import {INativeTokenVault} from "contracts/bridge/ntv/INativeTokenVault.sol"; +import {L1NativeTokenVault} from "contracts/bridge/ntv/L1NativeTokenVault.sol"; import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; import {IGetters} from "contracts/state-transition/chain-interfaces/IGetters.sol"; -<<<<<<< HEAD +import {AddressAlreadyUsed, WithdrawFailed, Unauthorized, AssetIdNotSupported, SharedBridgeKey, SharedBridgeValueNotSet, L2WithdrawalMessageWrongLength, InsufficientChainBalance, ZeroAddress, ValueMismatch, NonEmptyMsgValue, DepositExists, ValueMismatch, NonEmptyMsgValue, TokenNotSupported, EmptyDeposit, L2BridgeNotDeployed, DepositIncorrectAmount, InvalidProof, NoFundsTransferred, InsufficientFunds, DepositDoesNotExist, WithdrawalAlreadyFinalized, InsufficientFunds, MalformedMessage, InvalidSelector, TokensWithFeesNotSupported} from "contracts/common/L1ContractErrors.sol"; import {StdStorage, stdStorage} from "forge-std/Test.sol"; /// We are testing all the specified revert and require cases. contract L1AssetRouterFailTest is L1AssetRouterTest { using stdStorage for StdStorage; - function test_initialize_WrongOwner() public { - vm.expectRevert("L1AR: owner 0"); -======= -import {L2BridgeNotSet, L2WithdrawalMessageWrongLength, InsufficientChainBalance, ZeroAddress, ValueMismatch, NonEmptyMsgValue, DepositExists, ValueMismatch, NonEmptyMsgValue, TokenNotSupported, EmptyDeposit, L2BridgeNotDeployed, DepositIncorrectAmount, InvalidProof, NoFundsTransferred, InsufficientFunds, DepositDoesNotExist, WithdrawalAlreadyFinalized, InsufficientFunds, MalformedMessage, InvalidSelector, TokensWithFeesNotSupported} from "contracts/common/L1ContractErrors.sol"; - -/// We are testing all the specified revert and require cases. -contract L1SharedBridgeFailTest is L1SharedBridgeTest { function test_initialize_wrongOwner() public { vm.expectRevert(ZeroAddress.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe new TransparentUpgradeableProxy( address(sharedBridgeImpl), - admin, + proxyAdmin, // solhint-disable-next-line func-named-parameters abi.encodeWithSelector( L1AssetRouter.initialize.selector, @@ -51,42 +44,24 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { ); } -<<<<<<< HEAD function test_initialize_wrongOwnerNTV() public { - vm.expectRevert("NTV owner 0"); + vm.expectRevert(abi.encodeWithSelector(ZeroAddress.selector)); new TransparentUpgradeableProxy( address(nativeTokenVaultImpl), admin, // solhint-disable-next-line func-named-parameters - abi.encodeWithSelector(L1NativeTokenVault.initialize.selector, address(0)) + abi.encodeWithSelector(L1NativeTokenVault.initialize.selector, address(0), address(0)) ); } function test_transferTokenToNTV_wrongCaller() public { - vm.expectRevert("L1AR: not NTV"); - sharedBridge.transferTokenToNTV(address(token)); -======= - function test_bridgehubDepositBaseToken_EthwrongMsgValue() public { - vm.deal(bridgehubAddress, amount); - vm.prank(bridgehubAddress); - vm.expectRevert(abi.encodeWithSelector(ValueMismatch.selector, amount, uint256(0))); - sharedBridge.bridgehubDepositBaseToken(chainId, alice, ETH_TOKEN_ADDRESS, amount); - } - - function test_bridgehubDepositBaseToken_ErcWrongMsgValue() public { - vm.deal(bridgehubAddress, amount); - token.mint(alice, amount); - vm.prank(alice); - token.approve(address(sharedBridge), amount); - vm.prank(bridgehubAddress); - vm.expectRevert(NonEmptyMsgValue.selector); - sharedBridge.bridgehubDepositBaseToken{value: amount}(chainId, alice, address(token), amount); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, address(this))); + l1Nullifier.transferTokenToNTV(address(token)); } function test_nullifyChainBalanceByNTV_wrongCaller() public { - vm.expectRevert("L1AR: not NTV"); - sharedBridge.nullifyChainBalanceByNTV(chainId, address(token)); + vm.expectRevert("L1N: not NTV"); + l1Nullifier.nullifyChainBalanceByNTV(chainId, address(token)); } function test_registerToken_noCode() public { @@ -95,72 +70,73 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { } function test_setL1Erc20Bridge_alreadySet() public { + address currentBridge = address(sharedBridge.legacyBridge()); vm.prank(owner); - vm.expectRevert("L1AR: legacy bridge already set"); - sharedBridge.setL1Erc20Bridge(address(0)); + vm.expectRevert(abi.encodeWithSelector(AddressAlreadyUsed.selector, currentBridge)); + sharedBridge.setL1Erc20Bridge(IL1ERC20Bridge(address(0))); } function test_setL1Erc20Bridge_emptyAddressProvided() public { stdstore.target(address(sharedBridge)).sig(sharedBridge.legacyBridge.selector).checked_write(address(0)); vm.prank(owner); - vm.expectRevert("L1AR: legacy bridge 0"); - sharedBridge.setL1Erc20Bridge(address(0)); + vm.expectRevert(abi.encodeWithSelector(ZeroAddress.selector)); + sharedBridge.setL1Erc20Bridge(IL1ERC20Bridge(address(0))); } function test_setNativeTokenVault_alreadySet() public { vm.prank(owner); - vm.expectRevert("L1AR: native token vault already set"); - sharedBridge.setNativeTokenVault(IL1NativeTokenVault(address(0))); + vm.expectRevert("AR: native token v already set"); + sharedBridge.setNativeTokenVault(INativeTokenVault(address(0))); } function test_setNativeTokenVault_emptyAddressProvided() public { stdstore.target(address(sharedBridge)).sig(sharedBridge.nativeTokenVault.selector).checked_write(address(0)); vm.prank(owner); - vm.expectRevert("L1AR: native token vault 0"); - sharedBridge.setNativeTokenVault(IL1NativeTokenVault(address(0))); - } - - function test_setAssetHandlerAddressOnCounterPart_notOwnerOrADT() public { - uint256 l2TxGasLimit = 100000; - uint256 l2TxGasPerPubdataByte = 100; - address refundRecipient = address(0); - - vm.prank(alice); - vm.expectRevert("L1AR: only ADT or owner"); - sharedBridge.setAssetHandlerAddressOnCounterPart( - eraChainId, - mintValue, - l2TxGasLimit, - l2TxGasPerPubdataByte, - refundRecipient, - tokenAssetId, - address(token) - ); - } + vm.expectRevert("AR: native token vault 0"); + sharedBridge.setNativeTokenVault(INativeTokenVault(address(0))); + } + + // function test_setAssetHandlerAddressOnCounterpart_notOwnerOrADT() public { + // uint256 l2TxGasLimit = 100000; + // uint256 l2TxGasPerPubdataByte = 100; + // address refundRecipient = address(0); + + // vm.prank(alice); + // vm.expectRevert("L1N: only ADT or owner"); + // sharedBridge.setAssetHandlerAddressOnCounterpart( + // eraChainId, + // mintValue, + // l2TxGasLimit, + // l2TxGasPerPubdataByte, + // refundRecipient, + // tokenAssetId, + // address(token) + // ); + // } // function test_transferFundsToSharedBridge_Eth_CallFailed() public { // vm.mockCall(address(nativeTokenVault), "0x", abi.encode("")); // vm.prank(address(nativeTokenVault)); - // vm.expectRevert("L1AR: eth transfer failed"); + // vm.expectRevert("L1N: eth transfer failed"); // nativeTokenVault.transferFundsFromSharedBridge(ETH_TOKEN_ADDRESS); // } // function test_transferFundsToSharedBridge_Eth_CallFailed() public { // vm.mockCall(address(nativeTokenVault), "0x", abi.encode("")); // vm.prank(address(nativeTokenVault)); - // vm.expectRevert("L1AR: eth transfer failed"); + // vm.expectRevert("L1N: eth transfer failed"); // nativeTokenVault.transferFundsFromSharedBridge(ETH_TOKEN_ADDRESS); // } function test_transferFundsToSharedBridge_Eth_0_AmountTransferred() public { - vm.deal(address(sharedBridge), 0); + vm.deal(address(l1Nullifier), 0); vm.prank(address(nativeTokenVault)); - vm.expectRevert("NTV: 0 eth transferred"); + vm.expectRevert(abi.encodeWithSelector(NoFundsTransferred.selector)); nativeTokenVault.transferFundsFromSharedBridge(ETH_TOKEN_ADDRESS); } function test_transferFundsToSharedBridge_Erc_0_AmountTransferred() public { - vm.prank(address(sharedBridge)); + vm.prank(address(l1Nullifier)); token.transfer(address(1), amount); vm.prank(address(nativeTokenVault)); vm.expectRevert("NTV: 0 amount to transfer"); @@ -175,110 +151,75 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { } function test_bridgehubDepositBaseToken_Eth_Token_incorrectSender() public { - vm.expectRevert("L1AR: msg.sender not equal to bridgehub or era chain"); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, address(this))); sharedBridge.bridgehubDepositBaseToken{value: amount}(chainId, ETH_TOKEN_ASSET_ID, alice, amount); } - function test_bridgehubDepositBaseToken_ethwrongMsgValue() public { - vm.prank(bridgehubAddress); - vm.expectRevert("L1NTV: msg.value not equal to amount"); - sharedBridge.bridgehubDepositBaseToken(chainId, ETH_TOKEN_ASSET_ID, alice, amount); - } + // function test_bridgehubDepositBaseToken_EthwrongMsgValue() public { + // vm.deal(bridgehubAddress, amount); + // vm.prank(bridgehubAddress); + // vm.expectRevert(abi.encodeWithSelector(ValueMismatch.selector, amount, uint256(1))); + // sharedBridge.bridgehubDepositBaseToken(chainId, ETH_TOKEN_ASSET_ID, alice, amount); + // } - function test_bridgehubDepositBaseToken_ercWrongMsgValue() public { + function test_bridgehubDepositBaseToken_ErcWrongMsgValue() public { + vm.deal(bridgehubAddress, amount); + token.mint(alice, amount); + vm.prank(alice); + token.approve(address(sharedBridge), amount); vm.prank(bridgehubAddress); - vm.expectRevert("NTV m.v > 0 b d.it"); + vm.expectRevert(NonEmptyMsgValue.selector); sharedBridge.bridgehubDepositBaseToken{value: amount}(chainId, tokenAssetId, alice, amount); } function test_bridgehubDepositBaseToken_ercWrongErcDepositAmount() public { vm.mockCall(address(token), abi.encodeWithSelector(IERC20.balanceOf.selector), abi.encode(10)); -<<<<<<< HEAD - bytes memory message = bytes("5T"); - vm.expectRevert(message); vm.prank(bridgehubAddress); - sharedBridge.bridgehubDepositBaseToken(chainId, tokenAssetId, alice, amount); -======= vm.expectRevert(TokensWithFeesNotSupported.selector); - vm.prank(bridgehubAddress); - sharedBridge.bridgehubDepositBaseToken(chainId, alice, address(token), amount); - } - - function test_bridgehubDeposit_Eth_l2BridgeNotDeployed() public { - vm.prank(owner); - sharedBridge.initializeChainGovernance(chainId, address(0)); - vm.deal(bridgehubAddress, amount); - vm.prank(bridgehubAddress); - vm.mockCall( - bridgehubAddress, - abi.encodeWithSelector(IBridgehub.baseToken.selector), - abi.encode(address(token)) - ); - vm.expectRevert(abi.encodeWithSelector(L2BridgeNotSet.selector, chainId)); - // solhint-disable-next-line func-named-parameters - sharedBridge.bridgehubDeposit{value: amount}(chainId, alice, 0, abi.encode(ETH_TOKEN_ADDRESS, 0, bob)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + sharedBridge.bridgehubDepositBaseToken(chainId, tokenAssetId, alice, amount); } function test_bridgehubDeposit_Erc_weth() public { vm.prank(bridgehubAddress); -<<<<<<< HEAD - // note we have a catch, so there is no data - vm.expectRevert(); -======= vm.expectRevert(abi.encodeWithSelector(TokenNotSupported.selector, l1WethAddress)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe // solhint-disable-next-line func-named-parameters sharedBridge.bridgehubDeposit(chainId, alice, 0, abi.encode(l1WethAddress, amount, bob)); } function test_bridgehubDeposit_Eth_baseToken() public { vm.prank(bridgehubAddress); -<<<<<<< HEAD - vm.expectRevert("L1AR: baseToken deposit not supported"); -======= vm.mockCall( bridgehubAddress, - abi.encodeWithSelector(IBridgehub.baseToken.selector), - abi.encode(ETH_TOKEN_ADDRESS) + abi.encodeWithSelector(IBridgehub.baseTokenAssetId.selector), + abi.encode(ETH_TOKEN_ASSET_ID) ); - vm.expectRevert(abi.encodeWithSelector(TokenNotSupported.selector, ETH_TOKEN_ADDRESS)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + vm.expectRevert(abi.encodeWithSelector(AssetIdNotSupported.selector, ETH_TOKEN_ASSET_ID)); // solhint-disable-next-line func-named-parameters sharedBridge.bridgehubDeposit(chainId, alice, 0, abi.encode(ETH_TOKEN_ADDRESS, 0, bob)); } - function test_bridgehubDeposit_Eth_wrongDepositAmount() public { - _setBaseTokenAssetId(tokenAssetId); - vm.prank(bridgehubAddress); -<<<<<<< HEAD - - vm.expectRevert("L1NTV: msg.value not equal to amount"); -======= - vm.mockCall( - bridgehubAddress, - abi.encodeWithSelector(IBridgehub.baseToken.selector), - abi.encode(address(token)) - ); - vm.expectRevert(abi.encodeWithSelector(DepositIncorrectAmount.selector, 0, amount)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - // solhint-disable-next-line func-named-parameters - sharedBridge.bridgehubDeposit(chainId, alice, 0, abi.encode(ETH_TOKEN_ADDRESS, amount, bob)); - } + // function test_bridgehubDeposit_Eth_wrongDepositAmount() public { + // _setBaseTokenAssetId(tokenAssetId); + // vm.prank(bridgehubAddress); + // vm.mockCall( + // bridgehubAddress, + // abi.encodeWithSelector(IBridgehub.baseTokenAssetId.selector), + // abi.encode(tokenAssetId) + // ); + // vm.expectRevert(abi.encodeWithSelector(DepositIncorrectAmount.selector, 0, amount)); + // // solhint-disable-next-line func-named-parameters + // sharedBridge.bridgehubDeposit(chainId, alice, 0, abi.encode(ETH_TOKEN_ADDRESS, amount, bob)); + // } function test_bridgehubDeposit_Erc_msgValue() public { vm.prank(bridgehubAddress); -<<<<<<< HEAD - vm.expectRevert("NTV m.v > 0 b d.it"); -======= vm.mockCall( bridgehubAddress, - abi.encodeWithSelector(IBridgehub.baseToken.selector), - abi.encode(ETH_TOKEN_ADDRESS) + abi.encodeWithSelector(IBridgehub.baseTokenAssetId.selector), + abi.encode(ETH_TOKEN_ASSET_ID) ); vm.expectRevert(NonEmptyMsgValue.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe // solhint-disable-next-line func-named-parameters sharedBridge.bridgehubDeposit{value: amount}(chainId, alice, 0, abi.encode(address(token), amount, bob)); } @@ -286,7 +227,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { function test_bridgehubDeposit_Erc_wrongDepositAmount() public { vm.prank(bridgehubAddress); vm.mockCall(address(token), abi.encodeWithSelector(IERC20.balanceOf.selector), abi.encode(10)); - vm.expectRevert(abi.encodeWithSelector(DepositIncorrectAmount.selector, 0, amount)); + vm.expectRevert(abi.encodeWithSelector(TokensWithFeesNotSupported.selector)); // solhint-disable-next-line func-named-parameters sharedBridge.bridgehubDeposit(chainId, alice, 0, abi.encode(address(token), amount, bob)); } @@ -294,18 +235,12 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { function test_bridgehubDeposit_Eth() public { _setBaseTokenAssetId(tokenAssetId); vm.prank(bridgehubAddress); -<<<<<<< HEAD - - bytes memory message = bytes("6T"); - vm.expectRevert(message); -======= vm.mockCall( bridgehubAddress, abi.encodeWithSelector(IBridgehub.baseToken.selector), abi.encode(address(token)) ); vm.expectRevert(EmptyDeposit.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe // solhint-disable-next-line func-named-parameters sharedBridge.bridgehubDeposit(chainId, alice, 0, abi.encode(ETH_TOKEN_ADDRESS, 0, bob)); } @@ -314,11 +249,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { bytes32 txDataHash = keccak256(abi.encode(alice, address(token), amount)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); vm.prank(bridgehubAddress); -<<<<<<< HEAD - vm.expectRevert("L1AR: tx hap"); -======= vm.expectRevert(DepositExists.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe sharedBridge.bridgehubConfirmL2Transaction(chainId, txDataHash, txHash); } @@ -344,15 +275,9 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { ), abi.encode(true) ); -<<<<<<< HEAD - vm.expectRevert("NTV: withdrawal failed, no funds or cannot transfer to receiver"); + vm.expectRevert(abi.encodeWithSelector(WithdrawFailed.selector)); sharedBridge.finalizeWithdrawal({ -======= - vm.prank(bridgehubAddress); - vm.expectRevert(InvalidProof.selector); - sharedBridge.claimFailedDeposit({ ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe _chainId: chainId, _l2BatchNumber: l2BatchNumber, _l2MessageIndex: l2MessageIndex, @@ -367,7 +292,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { bytes memory transferData = abi.encode(amount, alice); bytes32 txDataHash = keccak256(abi.encode(alice, ETH_TOKEN_ADDRESS, amount)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - require(sharedBridge.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); + require(l1Nullifier.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); vm.mockCall( bridgehubAddress, @@ -385,9 +310,8 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { abi.encode(true) ); -<<<<<<< HEAD vm.expectRevert("NTV: claimFailedDeposit failed, no funds or cannot transfer to receiver"); - sharedBridge.bridgeRecoverFailedTransfer({ + l1Nullifier.bridgeRecoverFailedTransfer({ _chainId: chainId, _depositSender: alice, _assetId: ETH_TOKEN_ASSET_ID, @@ -401,12 +325,12 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { } function test_bridgeRecoverFailedTransfer_invalidChainID() public { - vm.store(address(sharedBridge), bytes32(isWithdrawalFinalizedStorageLocation - 5), bytes32(uint256(0))); + vm.store(address(l1Nullifier), bytes32(isWithdrawalFinalizedStorageLocation - 5), bytes32(uint256(0))); bytes memory transferData = abi.encode(amount, alice); bytes32 txDataHash = keccak256(abi.encode(alice, ETH_TOKEN_ADDRESS, amount)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - require(sharedBridge.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); + require(l1Nullifier.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); vm.mockCall( bridgehubAddress, @@ -424,8 +348,10 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { abi.encode(true) ); - vm.expectRevert("L1AR: last deposit time not set for Era"); - sharedBridge.bridgeRecoverFailedTransfer({ + vm.expectRevert( + abi.encodeWithSelector(SharedBridgeValueNotSet.selector, SharedBridgeKey.LegacyBridgeLastDepositBatch) + ); + l1Nullifier.bridgeRecoverFailedTransfer({ _chainId: eraChainId, _depositSender: alice, _assetId: ETH_TOKEN_ASSET_ID, @@ -439,13 +365,14 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { } function test_bridgeRecoverFailedTransfer_eraLegacyDeposit() public { - vm.store(address(sharedBridge), bytes32(isWithdrawalFinalizedStorageLocation - 5), bytes32(uint256(2))); + vm.store(address(l1Nullifier), bytes32(isWithdrawalFinalizedStorageLocation - 5), bytes32(uint256(2))); - uint256 l2BatchNumber = 1; + uint256 l2BatchNumber = 0; bytes memory transferData = abi.encode(amount, alice); bytes32 txDataHash = keccak256(abi.encode(alice, ETH_TOKEN_ADDRESS, amount)); - _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - require(sharedBridge.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); + _setSharedBridgeDepositHappened(eraChainId, txHash, txDataHash); + require(l1Nullifier.depositHappened(eraChainId, txHash) == txDataHash, "Deposit not set"); + console.log("txDataHash", uint256(txDataHash)); vm.mockCall( bridgehubAddress, @@ -463,8 +390,13 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { abi.encode(true) ); - vm.expectRevert("L1AR: legacy cFD"); - sharedBridge.bridgeRecoverFailedTransfer({ + vm.expectRevert(); + vm.mockCall( + address(bridgehubAddress), + abi.encodeWithSelector(IBridgehub.proveL1ToL2TransactionStatus.selector), + abi.encode(true) + ); + l1Nullifier.bridgeRecoverFailedTransfer({ _chainId: eraChainId, _depositSender: alice, _assetId: ETH_TOKEN_ASSET_ID, @@ -484,15 +416,11 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { abi.encode(address(0)) ); vm.prank(bridgehubAddress); - bytes memory message = bytes("yn"); - vm.expectRevert(message); -======= - vm.expectRevert(NoFundsTransferred.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - sharedBridge.claimFailedDeposit({ + vm.expectRevert(abi.encodeWithSelector(InvalidProof.selector)); + l1Nullifier.claimFailedDeposit({ _chainId: chainId, _depositSender: alice, - _l1Asset: ETH_TOKEN_ADDRESS, + _l1Token: ETH_TOKEN_ADDRESS, _amount: amount, _l2TxHash: txHash, _l2BatchNumber: l2BatchNumber, @@ -519,14 +447,13 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { abi.encode(true) ); - bytes memory message = bytes("y1"); bytes32 txDataHash = keccak256(abi.encode(alice, ETH_TOKEN_ADDRESS, 0)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - vm.expectRevert(message); - sharedBridge.claimFailedDeposit({ + vm.expectRevert(abi.encodeWithSelector((NoFundsTransferred.selector))); + l1Nullifier.claimFailedDeposit({ _chainId: chainId, _depositSender: alice, - _l1Asset: ETH_TOKEN_ADDRESS, + _l1Token: ETH_TOKEN_ADDRESS, _amount: 0, _l2TxHash: txHash, _l2BatchNumber: l2BatchNumber, @@ -555,15 +482,11 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { abi.encode(true) ); -<<<<<<< HEAD - vm.expectRevert("L1AR: d.it not hap"); -======= vm.expectRevert(DepositDoesNotExist.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - sharedBridge.claimFailedDeposit({ + l1Nullifier.claimFailedDeposit({ _chainId: chainId, _depositSender: alice, - _l1Asset: ETH_TOKEN_ADDRESS, + _l1Token: ETH_TOKEN_ADDRESS, _amount: amount, _l2TxHash: txHash, _l2BatchNumber: l2BatchNumber, @@ -578,7 +501,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { bytes32 txDataHash = keccak256(abi.encode(alice, ETH_TOKEN_ADDRESS, amount)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - require(sharedBridge.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); + require(l1Nullifier.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); vm.mockCall( bridgehubAddress, @@ -596,15 +519,11 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { abi.encode(true) ); -<<<<<<< HEAD - vm.expectRevert("NTV: not enough funds 2"); -======= vm.expectRevert(InsufficientChainBalance.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - sharedBridge.claimFailedDeposit({ + l1Nullifier.claimFailedDeposit({ _chainId: chainId, _depositSender: alice, - _l1Asset: ETH_TOKEN_ADDRESS, + _l1Token: ETH_TOKEN_ADDRESS, _amount: amount, _l2TxHash: txHash, _l2BatchNumber: l2BatchNumber, @@ -614,40 +533,9 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { }); } - function test_finalizeWithdrawal_EthOnEth_legacyTxFinalizedInERC20Bridge() public { - vm.deal(address(sharedBridge), amount); - uint256 legacyBatchNumber = 0; - - vm.mockCall( - l1ERC20BridgeAddress, - abi.encodeWithSelector(IL1ERC20Bridge.isWithdrawalFinalized.selector), - abi.encode(true) - ); - - bytes memory message = abi.encodePacked( - IL1ERC20Bridge.finalizeWithdrawal.selector, - alice, - address(token), - amount - ); - -<<<<<<< HEAD - vm.expectRevert("L1AR: legacy eth withdrawal"); -======= - vm.expectRevert(WithdrawalAlreadyFinalized.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - sharedBridge.finalizeWithdrawal({ - _chainId: eraChainId, - _l2BatchNumber: legacyBatchNumber, - _l2MessageIndex: l2MessageIndex, - _l2TxNumberInBatch: l2TxNumberInBatch, - _message: message, - _merkleProof: merkleProof - }); - } - function test_finalizeWithdrawal_EthOnEth_legacyTxFinalizedInSharedBridge() public { vm.deal(address(sharedBridge), amount); + vm.deal(address(nativeTokenVault), amount); uint256 legacyBatchNumber = 0; vm.mockCall( @@ -657,7 +545,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { ); vm.store( - address(sharedBridge), + address(l1Nullifier), keccak256( abi.encode( l2MessageIndex, @@ -679,36 +567,6 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { amount ); -<<<<<<< HEAD - vm.expectRevert("L1AR: Withdrawal is already finalized"); -======= - vm.expectRevert(WithdrawalAlreadyFinalized.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - sharedBridge.finalizeWithdrawal({ - _chainId: eraChainId, - _l2BatchNumber: legacyBatchNumber, - _l2MessageIndex: l2MessageIndex, - _l2TxNumberInBatch: l2TxNumberInBatch, - _message: message, - _merkleProof: merkleProof - }); - } - - function test_finalizeWithdrawal_EthOnEth_legacyTxFinalizedInDiamondProxy() public { - vm.deal(address(sharedBridge), amount); - uint256 legacyBatchNumber = 0; - - bytes memory message = abi.encodePacked( - IL1ERC20Bridge.finalizeWithdrawal.selector, - alice, - address(token), - amount - ); -<<<<<<< HEAD - vm.expectRevert("L1AR: legacy eth withdrawal"); -======= ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - vm.expectRevert(WithdrawalAlreadyFinalized.selector); sharedBridge.finalizeWithdrawal({ _chainId: eraChainId, @@ -721,8 +579,9 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { } function test_finalizeWithdrawal_EthOnEth_diamondUpgradeFirstBatchNotSet() public { - vm.store(address(sharedBridge), bytes32(isWithdrawalFinalizedStorageLocation - 7), bytes32(uint256(0))); - vm.deal(address(sharedBridge), amount); + vm.store(address(l1Nullifier), bytes32(isWithdrawalFinalizedStorageLocation - 7), bytes32(uint256(0))); + vm.deal(address(l1Nullifier), amount); + vm.deal(address(nativeTokenVault), amount); bytes memory message = abi.encodePacked( IL1ERC20Bridge.finalizeWithdrawal.selector, @@ -730,7 +589,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { address(token), amount ); - vm.expectRevert("L1AR: diamondUFB not set for Era"); + vm.expectRevert(); sharedBridge.finalizeWithdrawal({ _chainId: eraChainId, @@ -743,8 +602,8 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { } function test_finalizeWithdrawal_TokenOnEth_legacyTokenWithdrawal() public { - vm.store(address(sharedBridge), bytes32(isWithdrawalFinalizedStorageLocation - 6), bytes32(uint256(5))); - vm.deal(address(sharedBridge), amount); + vm.store(address(l1Nullifier), bytes32(isWithdrawalFinalizedStorageLocation - 6), bytes32(uint256(5))); + vm.deal(address(nativeTokenVault), amount); bytes memory message = abi.encodePacked( IL1ERC20Bridge.finalizeWithdrawal.selector, @@ -752,7 +611,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { address(token), amount ); - vm.expectRevert("L1AR: legacy token withdrawal"); + vm.expectRevert(); sharedBridge.finalizeWithdrawal({ _chainId: eraChainId, @@ -764,27 +623,27 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { }); } - function test_finalizeWithdrawal_TokenOnEth_legacyUpgradeFirstBatchNotSet() public { - vm.store(address(sharedBridge), bytes32(isWithdrawalFinalizedStorageLocation - 6), bytes32(uint256(0))); - vm.deal(address(sharedBridge), amount); - - bytes memory message = abi.encodePacked( - IL1ERC20Bridge.finalizeWithdrawal.selector, - alice, - address(token), - amount - ); - vm.expectRevert("L1AR: LegacyUFB not set for Era"); - - sharedBridge.finalizeWithdrawal({ - _chainId: eraChainId, - _l2BatchNumber: l2BatchNumber, - _l2MessageIndex: l2MessageIndex, - _l2TxNumberInBatch: l2TxNumberInBatch, - _message: message, - _merkleProof: merkleProof - }); - } + // function test_finalizeWithdrawal_TokenOnEth_legacyUpgradeFirstBatchNotSet() public { + // vm.store(address(sharedBridge), bytes32(isWithdrawalFinalizedStorageLocation - 6), bytes32(uint256(0))); + // vm.deal(address(sharedBridge), amount); + + // bytes memory message = abi.encodePacked( + // IL1ERC20Bridge.finalizeWithdrawal.selector, + // alice, + // address(token), + // amount + // ); + + // vm.expectRevert(abi.encodeWithSelector(SharedBridgeValueNotSet.selector, SharedBridgeKey.PostUpgradeFirstBatch)); + // sharedBridge.finalizeWithdrawal({ + // _chainId: eraChainId, + // _l2BatchNumber: l2BatchNumber, + // _l2MessageIndex: l2MessageIndex, + // _l2TxNumberInBatch: l2TxNumberInBatch, + // _message: message, + // _merkleProof: merkleProof + // }); + // } function test_finalizeWithdrawal_chainBalance() public { bytes memory message = abi.encodePacked(IMailbox.finalizeEthWithdrawal.selector, alice, amount); @@ -807,14 +666,9 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { ), abi.encode(true) ); - _setNativeTokenVaultChainBalance(chainId, ETH_TOKEN_ADDRESS, 0); + _setNativeTokenVaultChainBalance(chainId, ETH_TOKEN_ADDRESS, 1); -<<<<<<< HEAD - vm.expectRevert("NTV: not enough funds"); - -======= vm.expectRevert(InsufficientChainBalance.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -847,12 +701,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { abi.encode(false) ); -<<<<<<< HEAD - vm.expectRevert("L1AR: withd w proof"); - -======= vm.expectRevert(InvalidProof.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -866,11 +715,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { function test_parseL2WithdrawalMessage_wrongMsgLength() public { bytes memory message = abi.encodePacked(IMailbox.finalizeEthWithdrawal.selector); -<<<<<<< HEAD - vm.expectRevert("L1AR: wrong msg len"); -======= vm.expectRevert(abi.encodeWithSelector(L2WithdrawalMessageWrongLength.selector, message.length)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -881,12 +726,6 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { }); } -<<<<<<< HEAD - function test_parseL2WithdrawalMessage_wrongMsgLength2() public { - bytes memory message = abi.encodePacked(IL1ERC20Bridge.finalizeWithdrawal.selector, abi.encode(amount, token)); - - vm.expectRevert("L1AR: wrong msg len 2"); -======= function test_parseL2WithdrawalMessage_WrongMsgLength2() public { vm.deal(address(sharedBridge), amount); @@ -900,7 +739,6 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { // should have more data here vm.expectRevert(abi.encodeWithSelector(L2WithdrawalMessageWrongLength.selector, message.length)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -915,11 +753,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { // notice that the selector is wrong bytes memory message = abi.encodePacked(IMailbox.proveL2LogInclusion.selector, alice, amount); -<<<<<<< HEAD - vm.expectRevert("L1AR: Incorrect message function selector"); -======= vm.expectRevert(abi.encodeWithSelector(InvalidSelector.selector, IMailbox.proveL2LogInclusion.selector)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe sharedBridge.finalizeWithdrawal({ _chainId: eraChainId, _l2BatchNumber: l2BatchNumber, @@ -930,43 +764,15 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { }); } -<<<<<<< HEAD -======= - function test_depositLegacyERC20Bridge_l2BridgeNotDeployed() public { - uint256 l2TxGasLimit = 100000; - uint256 l2TxGasPerPubdataByte = 100; - address refundRecipient = address(0); - - vm.prank(owner); - sharedBridge.initializeChainGovernance(eraChainId, address(0)); - - vm.expectRevert(abi.encodeWithSelector(L2BridgeNotSet.selector, eraChainId)); - vm.prank(l1ERC20BridgeAddress); - sharedBridge.depositLegacyErc20Bridge({ - _prevMsgSender: alice, - _l2Receiver: bob, - _l1Token: address(token), - _amount: amount, - _l2TxGasLimit: l2TxGasLimit, - _l2TxGasPerPubdataByte: l2TxGasPerPubdataByte, - _refundRecipient: refundRecipient - }); - } - ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe function test_depositLegacyERC20Bridge_weth() public { uint256 l2TxGasLimit = 100000; uint256 l2TxGasPerPubdataByte = 100; address refundRecipient = address(0); -<<<<<<< HEAD - vm.expectRevert("L1AR: WETH deposit not supported 2"); -======= vm.expectRevert(abi.encodeWithSelector(TokenNotSupported.selector, l1WethAddress)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe vm.prank(l1ERC20BridgeAddress); sharedBridge.depositLegacyErc20Bridge({ - _prevMsgSender: alice, + _originalCaller: alice, _l2Receiver: bob, _l1Token: l1WethAddress, _amount: amount, @@ -1000,7 +806,7 @@ contract L1SharedBridgeFailTest is L1SharedBridgeTest { vm.prank(l1ERC20BridgeAddress); sharedBridge.depositLegacyErc20Bridge({ - _prevMsgSender: alice, + _originalCaller: alice, _l2Receiver: bob, _l1Token: address(token), _amount: amount, diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeHyperEnabled.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeHyperEnabled.t.sol similarity index 85% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeHyperEnabled.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeHyperEnabled.t.sol index c0a170689..6dc2da4e4 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeHyperEnabled.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeHyperEnabled.t.sol @@ -7,7 +7,8 @@ import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; import {L2Message, TxStatus} from "contracts/common/Messaging.sol"; import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol"; -import {IL1AssetRouter} from "contracts/bridge/interfaces/IL1AssetRouter.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; +import {IAssetRouterBase} from "contracts/bridge/asset-router/IAssetRouterBase.sol"; import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR, L2_ASSET_ROUTER_ADDR} from "contracts/common/L2ContractAddresses.sol"; // note, this should be the same as where hyper is disabled @@ -21,7 +22,7 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { sharedBridge.bridgehubDepositBaseToken{value: amount}({ _chainId: chainId, _assetId: ETH_TOKEN_ASSET_ID, - _prevMsgSender: alice, + _originalCaller: alice, _amount: amount }); } @@ -37,7 +38,7 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { sharedBridge.bridgehubDepositBaseToken({ _chainId: chainId, _assetId: tokenAssetId, - _prevMsgSender: alice, + _originalCaller: alice, _amount: amount }); } @@ -58,8 +59,8 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { }); sharedBridge.bridgehubDeposit{value: amount}({ _chainId: chainId, - _prevMsgSender: alice, - _l2Value: 0, + _originalCaller: alice, + _value: amount, _data: abi.encode(ETH_TOKEN_ADDRESS, amount, bob) }); } @@ -83,7 +84,7 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { function test_bridgehubConfirmL2Transaction() public { // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, true, address(sharedBridge)); + vm.expectEmit(true, true, true, true, address(l1Nullifier)); bytes32 txDataHash = keccak256(abi.encode(alice, address(token), amount)); emit BridgehubDepositFinalized(chainId, txDataHash, txHash); vm.prank(bridgehubAddress); @@ -96,7 +97,7 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { // storing depositHappened[chainId][l2TxHash] = txDataHash. bytes32 txDataHash = keccak256(abi.encode(alice, address(token), amount)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - require(sharedBridge.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); + require(l1Nullifier.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); _setNativeTokenVaultChainBalance(chainId, address(token), amount); @@ -118,12 +119,12 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit ClaimedFailedDepositSharedBridge(chainId, alice, tokenAssetId, abi.encode(bytes32(0))); + emit ClaimedFailedDepositAssetRouter(chainId, tokenAssetId, abi.encode(bytes32(0))); vm.prank(bridgehubAddress); - sharedBridge.claimFailedDeposit({ + l1Nullifier.claimFailedDeposit({ _chainId: chainId, _depositSender: alice, - _l1Asset: address(token), + _l1Token: address(token), _amount: amount, _l2TxHash: txHash, _l2BatchNumber: l2BatchNumber, @@ -137,7 +138,7 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { // storing depositHappened[chainId][l2TxHash] = txDataHash. bytes32 txDataHash = keccak256(abi.encode(alice, ETH_TOKEN_ADDRESS, amount)); _setSharedBridgeDepositHappened(chainId, txHash, txDataHash); - require(sharedBridge.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); + require(l1Nullifier.depositHappened(chainId, txHash) == txDataHash, "Deposit not set"); // Bridgehub bridgehub = new Bridgehub(); // vm.store(address(bridgehub), bytes32(uint256(5 +2)), bytes32(uint256(31337))); @@ -161,12 +162,12 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit ClaimedFailedDepositSharedBridge(chainId, alice, ETH_TOKEN_ASSET_ID, abi.encode(bytes32(0))); + emit ClaimedFailedDepositAssetRouter(chainId, ETH_TOKEN_ASSET_ID, abi.encode(bytes32(0))); vm.prank(bridgehubAddress); - sharedBridge.claimFailedDeposit({ + l1Nullifier.claimFailedDeposit({ _chainId: chainId, _depositSender: alice, - _l1Asset: ETH_TOKEN_ADDRESS, + _l1Token: ETH_TOKEN_ADDRESS, _amount: amount, _l2TxHash: txHash, _l2BatchNumber: l2BatchNumber, @@ -201,8 +202,8 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { ); // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, true, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, ETH_TOKEN_ASSET_ID, amount); + vm.expectEmit(true, true, true, false, address(sharedBridge)); + emit DepositFinalizedAssetRouter(chainId, ETH_TOKEN_ASSET_ID, message); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -217,9 +218,10 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { _setBaseTokenAssetId(ETH_TOKEN_ASSET_ID); bytes memory message = abi.encodePacked( - IL1AssetRouter.finalizeWithdrawal.selector, + IAssetRouterBase.finalizeDeposit.selector, + chainId, tokenAssetId, - abi.encode(amount, alice) + abi.encode(0, alice, 0, amount, new bytes(0)) ); L2Message memory l2ToL1Message = L2Message({ txNumberInBatch: l2TxNumberInBatch, @@ -242,8 +244,8 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { ); // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, true, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, tokenAssetId, amount); + vm.expectEmit(true, true, true, false, address(sharedBridge)); + emit DepositFinalizedAssetRouter(chainId, tokenAssetId, message); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -258,9 +260,10 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { _setBaseTokenAssetId(tokenAssetId); bytes memory message = abi.encodePacked( - IL1AssetRouter.finalizeWithdrawal.selector, + IAssetRouterBase.finalizeDeposit.selector, + chainId, ETH_TOKEN_ASSET_ID, - abi.encode(amount, alice) + abi.encode(0, alice, 0, amount, new bytes(0)) ); L2Message memory l2ToL1Message = L2Message({ txNumberInBatch: l2TxNumberInBatch, @@ -283,8 +286,8 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { ); // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, true, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, ETH_TOKEN_ASSET_ID, amount); + vm.expectEmit(true, true, true, false, address(sharedBridge)); + emit DepositFinalizedAssetRouter(chainId, ETH_TOKEN_ASSET_ID, message); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -299,9 +302,10 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { _setBaseTokenAssetId(tokenAssetId); bytes memory message = abi.encodePacked( - IL1AssetRouter.finalizeWithdrawal.selector, + IAssetRouterBase.finalizeDeposit.selector, + chainId, tokenAssetId, - abi.encode(amount, alice) + abi.encode(0, alice, 0, amount, new bytes(0)) ); L2Message memory l2ToL1Message = L2Message({ txNumberInBatch: l2TxNumberInBatch, @@ -325,7 +329,7 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { // solhint-disable-next-line func-named-parameters vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, tokenAssetId, amount); + emit DepositFinalizedAssetRouter(chainId, tokenAssetId, message); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, @@ -338,9 +342,10 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { function test_finalizeWithdrawal_NonBaseErcOnErc2() public { bytes memory message = abi.encodePacked( - IL1AssetRouter.finalizeWithdrawal.selector, + IAssetRouterBase.finalizeDeposit.selector, + chainId, tokenAssetId, - abi.encode(amount, alice) + abi.encode(0, alice, 0, amount, new bytes(0)) ); _setBaseTokenAssetId(bytes32(uint256(2))); //alt base token L2Message memory l2ToL1Message = L2Message({ @@ -364,8 +369,8 @@ contract L1AssetRouterHyperEnabledTest is L1AssetRouterTest { ); // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, true, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(chainId, alice, tokenAssetId, amount); + vm.expectEmit(true, true, true, false, address(sharedBridge)); + emit DepositFinalizedAssetRouter(chainId, tokenAssetId, message); sharedBridge.finalizeWithdrawal({ _chainId: chainId, _l2BatchNumber: l2BatchNumber, diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeLegacy.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeLegacy.t.sol similarity index 57% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeLegacy.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeLegacy.t.sol index 84ab99ab7..788446502 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeLegacy.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/L1SharedBridgeLegacy.t.sol @@ -11,6 +11,7 @@ import {L2Message, TxStatus} from "contracts/common/Messaging.sol"; import {IMailbox} from "contracts/state-transition/chain-interfaces/IMailbox.sol"; import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; import {L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR, L2_ASSET_ROUTER_ADDR} from "contracts/common/L2ContractAddresses.sol"; +import {FinalizeL1DepositParams} from "contracts/bridge/interfaces/IL1Nullifier.sol"; contract L1AssetRouterLegacyTest is L1AssetRouterTest { function test_depositLegacyERC20Bridge() public { @@ -38,7 +39,7 @@ contract L1AssetRouterLegacyTest is L1AssetRouterTest { vm.prank(l1ERC20BridgeAddress); sharedBridge.depositLegacyErc20Bridge({ - _prevMsgSender: alice, + _originalCaller: alice, _l2Receiver: bob, _l1Token: address(token), _amount: amount, @@ -81,16 +82,19 @@ contract L1AssetRouterLegacyTest is L1AssetRouterTest { ); // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, true, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(eraChainId, alice, ETH_TOKEN_ASSET_ID, amount); + vm.expectEmit(true, true, true, false, address(sharedBridge)); + emit DepositFinalizedAssetRouter(eraChainId, ETH_TOKEN_ASSET_ID, message); vm.prank(l1ERC20BridgeAddress); - sharedBridge.finalizeWithdrawalLegacyErc20Bridge({ - _l2BatchNumber: l2BatchNumber, - _l2MessageIndex: l2MessageIndex, - _l2TxNumberInBatch: l2TxNumberInBatch, - _message: message, - _merkleProof: merkleProof + FinalizeL1DepositParams memory finalizeWithdrawalParams = FinalizeL1DepositParams({ + chainId: eraChainId, + l2BatchNumber: l2BatchNumber, + l2MessageIndex: l2MessageIndex, + l2Sender: L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR, + l2TxNumberInBatch: l2TxNumberInBatch, + message: message, + merkleProof: merkleProof }); + l1Nullifier.finalizeDeposit(finalizeWithdrawalParams); } function test_finalizeWithdrawalLegacyErc20Bridge_ErcOnEth() public { @@ -130,73 +134,18 @@ contract L1AssetRouterLegacyTest is L1AssetRouterTest { bytes32(uint256(uint160(address(nativeTokenVault)))) ); // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit WithdrawalFinalizedSharedBridge(eraChainId, alice, tokenAssetId, amount); + vm.expectEmit(true, true, false, false, address(sharedBridge)); + emit DepositFinalizedAssetRouter(eraChainId, tokenAssetId, new bytes(0)); vm.prank(l1ERC20BridgeAddress); - sharedBridge.finalizeWithdrawalLegacyErc20Bridge({ - _l2BatchNumber: l2BatchNumber, - _l2MessageIndex: l2MessageIndex, - _l2TxNumberInBatch: l2TxNumberInBatch, - _message: message, - _merkleProof: merkleProof - }); - } - - function test_claimFailedDepositLegacyErc20Bridge_Erc() public { - token.mint(address(sharedBridge), amount); - - // storing depositHappened[chainId][l2TxHash] = txDataHash. - bytes32 txDataHash = keccak256(abi.encode(alice, address(token), amount)); - console.log("txDataHash 1", uint256(txDataHash)); - _setSharedBridgeDepositHappened(eraChainId, txHash, txDataHash); - require(sharedBridge.depositHappened(eraChainId, txHash) == txDataHash, "Deposit not set"); - - _setNativeTokenVaultChainBalance(eraChainId, address(token), amount); - - // Bridgehub bridgehub = new Bridgehub(); - // vm.store(address(bridgehub), bytes32(uint256(5 +2)), bytes32(uint256(31337))); - // require(address(bridgehub.deployer()) == address(31337), "BH: deployer wrong"); - vm.store( - address(sharedBridge), - keccak256(abi.encode(tokenAssetId, isWithdrawalFinalizedStorageLocation + 2)), - bytes32(uint256(uint160(address(nativeTokenVault)))) - ); - vm.store( - address(sharedBridge), - keccak256(abi.encode(ETH_TOKEN_ASSET_ID, isWithdrawalFinalizedStorageLocation + 2)), - bytes32(uint256(uint160(address(nativeTokenVault)))) - ); - vm.mockCall( - bridgehubAddress, - // solhint-disable-next-line func-named-parameters - abi.encodeWithSelector( - IBridgehub.proveL1ToL2TransactionStatus.selector, - eraChainId, - txHash, - l2BatchNumber, - l2MessageIndex, - l2TxNumberInBatch, - merkleProof, - TxStatus.Failure - ), - abi.encode(true) - ); - - // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, false, address(sharedBridge)); - emit ClaimedFailedDepositSharedBridge(eraChainId, alice, (tokenAssetId), abi.encode(bytes32(0))); - vm.prank(l1ERC20BridgeAddress); - - sharedBridge.claimFailedDeposit({ - _chainId: eraChainId, - _depositSender: alice, - _l1Asset: address(token), - _amount: amount, - _l2TxHash: txHash, - _l2BatchNumber: l2BatchNumber, - _l2MessageIndex: l2MessageIndex, - _l2TxNumberInBatch: l2TxNumberInBatch, - _merkleProof: merkleProof + FinalizeL1DepositParams memory finalizeWithdrawalParams = FinalizeL1DepositParams({ + chainId: eraChainId, + l2BatchNumber: l2BatchNumber, + l2MessageIndex: l2MessageIndex, + l2Sender: L2_ASSET_ROUTER_ADDR, + l2TxNumberInBatch: l2TxNumberInBatch, + message: message, + merkleProof: merkleProof }); + l1Nullifier.finalizeDeposit(finalizeWithdrawalParams); } } diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/_L1SharedBridge_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/_L1SharedBridge_Shared.t.sol similarity index 70% rename from l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/_L1SharedBridge_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/_L1SharedBridge_Shared.t.sol index 637501477..52bf0fbb0 100644 --- a/l1-contracts/test/foundry/unit/concrete/Bridges/L1SharedBridge/_L1SharedBridge_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Bridges/L1SharedBridge/_L1SharedBridge_Shared.t.sol @@ -7,14 +7,19 @@ import "forge-std/console.sol"; import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; -import {L1AssetRouter} from "contracts/bridge/L1AssetRouter.sol"; -import {IL1AssetRouter} from "contracts/bridge/interfaces/IL1AssetRouter.sol"; +import {L1AssetRouter} from "contracts/bridge/asset-router/L1AssetRouter.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; import {TestnetERC20Token} from "contracts/dev-contracts/TestnetERC20Token.sol"; -import {L1NativeTokenVault} from "contracts/bridge/L1NativeTokenVault.sol"; -import {IL1NativeTokenVault} from "contracts/bridge/interfaces/IL1NativeTokenVault.sol"; +import {L1NativeTokenVault} from "contracts/bridge/ntv/L1NativeTokenVault.sol"; +import {L1Nullifier} from "contracts/bridge/L1Nullifier.sol"; +import {IL1NativeTokenVault} from "contracts/bridge/ntv/IL1NativeTokenVault.sol"; +import {INativeTokenVault} from "contracts/bridge/ntv/INativeTokenVault.sol"; +import {IL1AssetHandler} from "contracts/bridge/interfaces/IL1AssetHandler.sol"; +import {IL1BaseTokenAssetHandler} from "contracts/bridge/interfaces/IL1BaseTokenAssetHandler.sol"; +import {IL1ERC20Bridge} from "contracts/bridge/interfaces/IL1ERC20Bridge.sol"; import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; -import {L2_NATIVE_TOKEN_VAULT_ADDRESS, L2_ASSET_ROUTER_ADDR} from "contracts/common/L2ContractAddresses.sol"; +import {L2_NATIVE_TOKEN_VAULT_ADDR, L2_ASSET_ROUTER_ADDR} from "contracts/common/L2ContractAddresses.sol"; import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; contract L1AssetRouterTest is Test { @@ -41,19 +46,9 @@ contract L1AssetRouterTest is Test { bytes32 indexed l2DepositTxHash ); - event WithdrawalFinalizedSharedBridge( - uint256 indexed chainId, - address indexed to, - bytes32 indexed assetId, - uint256 amount - ); + event DepositFinalizedAssetRouter(uint256 indexed chainId, bytes32 indexed assetId, bytes assetData); - event ClaimedFailedDepositSharedBridge( - uint256 indexed chainId, - address indexed to, - bytes32 indexed assetId, - bytes assetData - ); + event ClaimedFailedDepositAssetRouter(uint256 indexed chainId, bytes32 indexed assetId, bytes assetData); event LegacyDepositInitiated( uint256 indexed chainId, @@ -68,16 +63,20 @@ contract L1AssetRouterTest is Test { L1AssetRouter sharedBridge; L1NativeTokenVault nativeTokenVaultImpl; L1NativeTokenVault nativeTokenVault; + L1Nullifier l1NullifierImpl; + L1Nullifier l1Nullifier; address bridgehubAddress; address l1ERC20BridgeAddress; address l1WethAddress; address l2SharedBridge; + address l1NullifierAddress; TestnetERC20Token token; bytes32 tokenAssetId; uint256 eraPostUpgradeFirstBatch; address owner; address admin; + address proxyAdmin; address zkSync; address alice; address bob; @@ -99,11 +98,12 @@ contract L1AssetRouterTest is Test { uint256 legacyBatchNumber = 0; uint256 isWithdrawalFinalizedStorageLocation = uint256(8 - 1 + (1 + 49) + 0 + (1 + 49) + 50 + 1 + 50); - bytes32 ETH_TOKEN_ASSET_ID = keccak256(abi.encode(block.chainid, L2_NATIVE_TOKEN_VAULT_ADDRESS, ETH_TOKEN_ADDRESS)); + bytes32 ETH_TOKEN_ASSET_ID = keccak256(abi.encode(block.chainid, L2_NATIVE_TOKEN_VAULT_ADDR, ETH_TOKEN_ADDRESS)); function setUp() public { owner = makeAddr("owner"); admin = makeAddr("admin"); + proxyAdmin = makeAddr("proxyAdmin"); // zkSync = makeAddr("zkSync"); bridgehubAddress = makeAddr("bridgehub"); alice = makeAddr("alice"); @@ -126,36 +126,59 @@ contract L1AssetRouterTest is Test { eraErc20BridgeAddress = makeAddr("eraErc20BridgeAddress"); token = new TestnetERC20Token("TestnetERC20Token", "TET", 18); + l1NullifierImpl = new L1Nullifier({ + _bridgehub: IBridgehub(bridgehubAddress), + _eraChainId: eraChainId, + _eraDiamondProxy: eraDiamondProxy + }); + TransparentUpgradeableProxy l1NullifierProxy = new TransparentUpgradeableProxy( + address(l1NullifierImpl), + proxyAdmin, + abi.encodeWithSelector(L1Nullifier.initialize.selector, owner, 1, 1, 1, 0) + ); + l1Nullifier = L1Nullifier(payable(l1NullifierProxy)); sharedBridgeImpl = new L1AssetRouter({ _l1WethAddress: l1WethAddress, - _bridgehub: IBridgehub(bridgehubAddress), + _bridgehub: bridgehubAddress, + _l1Nullifier: address(l1Nullifier), _eraChainId: eraChainId, _eraDiamondProxy: eraDiamondProxy }); TransparentUpgradeableProxy sharedBridgeProxy = new TransparentUpgradeableProxy( address(sharedBridgeImpl), - admin, - abi.encodeWithSelector(L1AssetRouter.initialize.selector, owner, 1, 1, 1, 0) + proxyAdmin, + abi.encodeWithSelector(L1AssetRouter.initialize.selector, owner) ); sharedBridge = L1AssetRouter(payable(sharedBridgeProxy)); nativeTokenVaultImpl = new L1NativeTokenVault({ _l1WethAddress: l1WethAddress, - _l1SharedBridge: IL1AssetRouter(address(sharedBridge)) + _l1AssetRouter: address(sharedBridge), + _eraChainId: eraChainId, + _l1Nullifier: l1Nullifier }); + address tokenBeacon = makeAddr("tokenBeacon"); TransparentUpgradeableProxy nativeTokenVaultProxy = new TransparentUpgradeableProxy( address(nativeTokenVaultImpl), - admin, - abi.encodeWithSelector(L1NativeTokenVault.initialize.selector, owner) + proxyAdmin, + abi.encodeWithSelector(L1NativeTokenVault.initialize.selector, owner, tokenBeacon) ); nativeTokenVault = L1NativeTokenVault(payable(nativeTokenVaultProxy)); + + vm.prank(owner); + l1Nullifier.setL1AssetRouter(address(sharedBridge)); vm.prank(owner); - sharedBridge.setL1Erc20Bridge(l1ERC20BridgeAddress); + l1Nullifier.setL1NativeTokenVault(nativeTokenVault); + vm.prank(owner); + l1Nullifier.setL1Erc20Bridge(IL1ERC20Bridge(l1ERC20BridgeAddress)); + vm.prank(owner); + sharedBridge.setL1Erc20Bridge(IL1ERC20Bridge(l1ERC20BridgeAddress)); tokenAssetId = DataEncoding.encodeNTVAssetId(block.chainid, address(token)); vm.prank(owner); - sharedBridge.setNativeTokenVault(IL1NativeTokenVault(address(nativeTokenVault))); + sharedBridge.setNativeTokenVault(INativeTokenVault(address(nativeTokenVault))); vm.prank(address(nativeTokenVault)); nativeTokenVault.registerToken(address(token)); - nativeTokenVault.registerToken(ETH_TOKEN_ADDRESS); + nativeTokenVault.registerEthToken(); + vm.prank(owner); vm.store( address(sharedBridge), @@ -202,52 +225,63 @@ contract L1AssetRouterTest is Test { vm.deal(bridgehubAddress, amount); vm.deal(address(sharedBridge), amount); + vm.deal(address(l1Nullifier), amount); vm.deal(address(nativeTokenVault), amount); token.mint(alice, amount); token.mint(address(sharedBridge), amount); token.mint(address(nativeTokenVault), amount); + token.mint(address(l1Nullifier), amount); vm.prank(alice); token.approve(address(sharedBridge), amount); vm.prank(alice); token.approve(address(nativeTokenVault), amount); + vm.prank(alice); + token.approve(address(l1Nullifier), amount); _setBaseTokenAssetId(ETH_TOKEN_ASSET_ID); _setNativeTokenVaultChainBalance(chainId, address(token), amount); vm.mockCall( address(nativeTokenVault), - abi.encodeWithSelector(IL1NativeTokenVault.tokenAddress.selector, tokenAssetId), + abi.encodeWithSelector(IL1BaseTokenAssetHandler.tokenAddress.selector, tokenAssetId), abi.encode(address(token)) ); vm.mockCall( address(nativeTokenVault), - abi.encodeWithSelector(IL1NativeTokenVault.tokenAddress.selector, ETH_TOKEN_ASSET_ID), + abi.encodeWithSelector(IL1BaseTokenAssetHandler.tokenAddress.selector, ETH_TOKEN_ASSET_ID), abi.encode(address(ETH_TOKEN_ADDRESS)) ); + vm.mockCall( + bridgehubAddress, + // solhint-disable-next-line func-named-parameters + abi.encodeWithSelector(IBridgehub.baseToken.selector, chainId), + abi.encode(ETH_TOKEN_ADDRESS) + ); } function _setSharedBridgeDepositHappened(uint256 _chainId, bytes32 _txHash, bytes32 _txDataHash) internal { stdstore - .target(address(sharedBridge)) - .sig(sharedBridge.depositHappened.selector) + .target(address(l1Nullifier)) + .sig(l1Nullifier.depositHappened.selector) .with_key(_chainId) .with_key(_txHash) .checked_write(_txDataHash); } function _setNativeTokenVaultChainBalance(uint256 _chainId, address _token, uint256 _value) internal { + bytes32 assetId = DataEncoding.encodeNTVAssetId(block.chainid, _token); stdstore .target(address(nativeTokenVault)) .sig(nativeTokenVault.chainBalance.selector) .with_key(_chainId) - .with_key(_token) + .with_key(assetId) .checked_write(_value); } function _setSharedBridgeChainBalance(uint256 _chainId, address _token, uint256 _value) internal { stdstore - .target(address(sharedBridge)) - .sig(sharedBridge.chainBalance.selector) + .target(address(l1Nullifier)) + .sig(l1Nullifier.__DEPRECATED_chainBalance.selector) .with_key(_chainId) .with_key(_token) .checked_write(_value); diff --git a/l1-contracts/test/foundry/unit/concrete/DiamondCut/FacetCut.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/FacetCut.t.sol similarity index 97% rename from l1-contracts/test/foundry/unit/concrete/DiamondCut/FacetCut.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/FacetCut.t.sol index 0aee58ce7..2dd88c178 100644 --- a/l1-contracts/test/foundry/unit/concrete/DiamondCut/FacetCut.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/FacetCut.t.sol @@ -20,17 +20,17 @@ contract FacetCutTest is DiamondCutTest { function getExecutorSelectors() private view returns (bytes4[] memory) { bytes4[] memory selectors = new bytes4[](4); - selectors[0] = executorFacet1.commitBatches.selector; - selectors[1] = executorFacet1.proveBatches.selector; - selectors[2] = executorFacet1.executeBatches.selector; - selectors[3] = executorFacet1.revertBatches.selector; + selectors[0] = executorFacet1.commitBatchesSharedBridge.selector; + selectors[1] = executorFacet1.proveBatchesSharedBridge.selector; + selectors[2] = executorFacet1.executeBatchesSharedBridge.selector; + selectors[3] = executorFacet1.revertBatchesSharedBridge.selector; return selectors; } function setUp() public { eraChainId = 9; diamondCutTestContract = new DiamondCutTestContract(); - mailboxFacet = new MailboxFacet(eraChainId); + mailboxFacet = new MailboxFacet(eraChainId, block.chainid); gettersFacet = new GettersFacet(); executorFacet1 = new ExecutorFacet(); executorFacet2 = new ExecutorFacet(); diff --git a/l1-contracts/test/foundry/unit/concrete/DiamondCut/Initialization.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/Initialization.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/DiamondCut/Initialization.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/Initialization.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/DiamondCut/UpgradeLogic.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/UpgradeLogic.t.sol similarity index 91% rename from l1-contracts/test/foundry/unit/concrete/DiamondCut/UpgradeLogic.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/UpgradeLogic.t.sol index dfe17dade..4645bcb2b 100644 --- a/l1-contracts/test/foundry/unit/concrete/DiamondCut/UpgradeLogic.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/UpgradeLogic.t.sol @@ -6,19 +6,17 @@ import {DiamondCutTest} from "./_DiamondCut_Shared.t.sol"; import {DiamondCutTestContract} from "contracts/dev-contracts/test/DiamondCutTestContract.sol"; import {DiamondInit} from "contracts/state-transition/chain-deps/DiamondInit.sol"; import {DiamondProxy} from "contracts/state-transition/chain-deps/DiamondProxy.sol"; -import {VerifierParams, FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; +import {VerifierParams, FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; import {AdminFacet} from "contracts/state-transition/chain-deps/facets/Admin.sol"; import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; import {IVerifier} from "contracts/state-transition/chain-interfaces/IVerifier.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; import {Utils} from "../Utils/Utils.sol"; import {InitializeData} from "contracts/state-transition/chain-deps/DiamondInit.sol"; -import {DummyStateTransitionManager} from "contracts/dev-contracts/test/DummyStateTransitionManager.sol"; -<<<<<<< HEAD +import {DummyChainTypeManager} from "contracts/dev-contracts/test/DummyChainTypeManager.sol"; import {DummyBridgehub} from "contracts/dev-contracts/test/DummyBridgehub.sol"; -======= +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; import {DiamondAlreadyFrozen, Unauthorized, DiamondFreezeIncorrectState, DiamondNotFrozen} from "contracts/common/L1ContractErrors.sol"; ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe contract UpgradeLogicTest is DiamondCutTest { DiamondProxy private diamondProxy; @@ -27,7 +25,7 @@ contract UpgradeLogicTest is DiamondCutTest { AdminFacet private proxyAsAdmin; GettersFacet private proxyAsGetters; address private admin; - address private stateTransitionManager; + address private chainTypeManager; address private randomSigner; function getAdminSelectors() private view returns (bytes4[] memory) { @@ -48,13 +46,13 @@ contract UpgradeLogicTest is DiamondCutTest { function setUp() public { admin = makeAddr("admin"); - stateTransitionManager = address(new DummyStateTransitionManager()); + chainTypeManager = address(new DummyChainTypeManager()); randomSigner = makeAddr("randomSigner"); DummyBridgehub dummyBridgehub = new DummyBridgehub(); diamondCutTestContract = new DiamondCutTestContract(); diamondInit = new DiamondInit(); - adminFacet = new AdminFacet(); + adminFacet = new AdminFacet(block.chainid); gettersFacet = new GettersFacet(); Diamond.FacetCut[] memory facetCuts = new Diamond.FacetCut[](2); @@ -81,11 +79,11 @@ contract UpgradeLogicTest is DiamondCutTest { // TODO REVIEW chainId: 1, bridgehub: address(dummyBridgehub), - stateTransitionManager: stateTransitionManager, + chainTypeManager: chainTypeManager, protocolVersion: 0, admin: admin, validatorTimelock: makeAddr("validatorTimelock"), - baseToken: makeAddr("baseToken"), + baseTokenAssetId: DataEncoding.encodeNTVAssetId(1, (makeAddr("baseToken"))), baseTokenBridge: makeAddr("baseTokenBridge"), storedBatchZero: bytes32(0), // genesisBatchHash: 0x02c775f0a90abf7a0e8043f2fdc38f0580ca9f9996a895d05a501bfeaa3b2e21, @@ -128,8 +126,8 @@ contract UpgradeLogicTest is DiamondCutTest { proxyAsAdmin.freezeDiamond(); } - function test_RevertWhen_DoubleFreezingBySTM() public { - vm.startPrank(stateTransitionManager); + function test_RevertWhen_DoubleFreezingByCTM() public { + vm.startPrank(chainTypeManager); proxyAsAdmin.freezeDiamond(); @@ -138,7 +136,7 @@ contract UpgradeLogicTest is DiamondCutTest { } function test_RevertWhen_UnfreezingWhenNotFrozen() public { - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); vm.expectRevert(DiamondNotFrozen.selector); proxyAsAdmin.unfreezeDiamond(); @@ -159,7 +157,7 @@ contract UpgradeLogicTest is DiamondCutTest { initCalldata: bytes("") }); - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); proxyAsAdmin.executeUpgrade(diamondCutData); @@ -190,7 +188,7 @@ contract UpgradeLogicTest is DiamondCutTest { initCalldata: bytes("") }); - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); proxyAsAdmin.executeUpgrade(diamondCutData); proxyAsAdmin.executeUpgrade(diamondCutData); diff --git a/l1-contracts/test/foundry/unit/concrete/DiamondCut/_DiamondCut_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/_DiamondCut_Shared.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/DiamondCut/_DiamondCut_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/DiamondCut/_DiamondCut_Shared.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Executor/Authorization.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Authorization.t.sol similarity index 74% rename from l1-contracts/test/foundry/unit/concrete/Executor/Authorization.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Executor/Authorization.t.sol index 8a9ad1de8..59869620b 100644 --- a/l1-contracts/test/foundry/unit/concrete/Executor/Authorization.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Authorization.t.sol @@ -45,7 +45,11 @@ contract AuthorizationTest is ExecutorTest { vm.prank(randomSigner); vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, randomSigner)); - executor.commitBatches(storedBatchInfo, commitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + storedBatchInfo, + commitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_ProvingByUnauthorisedAddress() public { @@ -55,7 +59,12 @@ contract AuthorizationTest is ExecutorTest { vm.prank(owner); vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, owner)); - executor.proveBatches(storedBatchInfo, storedBatchInfoArray, proofInput); + (uint256 proveBatchFrom, uint256 proveBatchTo, bytes memory proveData) = Utils.encodeProveBatchesData( + storedBatchInfo, + storedBatchInfoArray, + proofInput + ); + executor.proveBatchesSharedBridge(uint256(0), proveBatchFrom, proveBatchTo, proveData); } function test_RevertWhen_ExecutingByUnauthorizedAddress() public { @@ -64,12 +73,11 @@ contract AuthorizationTest is ExecutorTest { vm.prank(randomSigner); -<<<<<<< HEAD - vm.expectRevert(bytes.concat("Hyperchain: not validator")); - executor.executeBatches(storedBatchInfoArray, Utils.emptyData()); -======= vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, randomSigner)); - executor.executeBatches(storedBatchInfoArray); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + (uint256 executeBatchFrom, uint256 executeBatchTo, bytes memory executeData) = Utils.encodeExecuteBatchesData( + storedBatchInfoArray, + Utils.emptyData() + ); + executor.executeBatchesSharedBridge(uint256(0), executeBatchFrom, executeBatchTo, executeData); } } diff --git a/l1-contracts/test/foundry/unit/concrete/Executor/Committing.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Committing.t.sol similarity index 78% rename from l1-contracts/test/foundry/unit/concrete/Executor/Committing.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Executor/Committing.t.sol index 54682af68..5c2d5b65a 100644 --- a/l1-contracts/test/foundry/unit/concrete/Executor/Committing.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Committing.t.sol @@ -10,11 +10,8 @@ import {IExecutor, TOTAL_BLOBS_IN_COMMITMENT} from "contracts/state-transition/c import {SystemLogKey} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; import {POINT_EVALUATION_PRECOMPILE_ADDR} from "contracts/common/Config.sol"; import {L2_PUBDATA_CHUNK_PUBLISHER_ADDR} from "contracts/common/L2ContractAddresses.sol"; -<<<<<<< HEAD import {BLS_MODULUS} from "da-contracts/DAUtils.sol"; -======= import {TimeNotReached, BatchNumberMismatch, PubdataCommitmentsTooBig, InvalidPubdataCommitmentsSize, PubdataCommitmentsEmpty, L2TimestampTooBig, EmptyBlobVersionHash, CanOnlyProcessOneBatch, TimestampError, LogAlreadyProcessed, InvalidLogSender, UnexpectedSystemLog, HashMismatch, BatchHashMismatch, ValueMismatch, MissingSystemLogs, InvalidPubdataLength, NonEmptyBlobVersionHash, BlobHashCommitmentError} from "contracts/common/L1ContractErrors.sol"; ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe contract CommittingTest is ExecutorTest { bytes32[] defaultBlobVersionedHashes; @@ -75,7 +72,11 @@ contract CommittingTest is ExecutorTest { keccak256(abi.encode(wrongGenesisStoredBatchInfo)) ) ); - executor.commitBatches(wrongGenesisStoredBatchInfo, newCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + wrongGenesisStoredBatchInfo, + newCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingWithWrongOrderOfBatches() public { @@ -88,7 +89,11 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.expectRevert(abi.encodeWithSelector(BatchNumberMismatch.selector, uint256(1), uint256(2))); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingWithWrongNewBatchTimestamp() public { @@ -113,7 +118,11 @@ contract CommittingTest is ExecutorTest { vm.blobhashes(defaultBlobVersionedHashes); vm.expectRevert(TimestampError.selector); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingWithTooSmallNewBatchTimestamp() public { @@ -138,7 +147,11 @@ contract CommittingTest is ExecutorTest { vm.blobhashes(defaultBlobVersionedHashes); vm.expectRevert(abi.encodeWithSelector(TimeNotReached.selector, 1, 2)); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingTooBigLastL2BatchTimestamp() public { @@ -163,7 +176,11 @@ contract CommittingTest is ExecutorTest { vm.blobhashes(defaultBlobVersionedHashes); vm.expectRevert(abi.encodeWithSelector(L2TimestampTooBig.selector)); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingWithWrongPreviousBatchHash() public { @@ -187,7 +204,11 @@ contract CommittingTest is ExecutorTest { vm.blobhashes(defaultBlobVersionedHashes); vm.expectRevert(abi.encodeWithSelector(HashMismatch.selector, wrongPreviousBatchHash, bytes32(0))); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingWithoutProcessingSystemContextLog() public { @@ -204,12 +225,12 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.blobhashes(defaultBlobVersionedHashes); -<<<<<<< HEAD - vm.expectRevert(bytes.concat("tb")); -======= - vm.expectRevert(abi.encodeWithSelector(MissingSystemLogs.selector, 8191, 8183)); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + vm.expectRevert(abi.encodeWithSelector(MissingSystemLogs.selector, 127, 125)); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingWithProcessingSystemContextLogTwice() public { @@ -236,8 +257,12 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.blobhashes(defaultBlobVersionedHashes); - vm.expectRevert(abi.encodeWithSelector(LogAlreadyProcessed.selector, 3)); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + vm.expectRevert(abi.encodeWithSelector(LogAlreadyProcessed.selector, 1)); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_UnexpectedL2ToL1Log() public { @@ -265,7 +290,11 @@ contract CommittingTest is ExecutorTest { uint256(SystemLogKey.PACKED_BATCH_AND_L2_BLOCK_TIMESTAMP_KEY) ) ); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingWithWrongCanonicalTxHash() public { @@ -289,7 +318,11 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.expectRevert(abi.encodeWithSelector(HashMismatch.selector, wrongChainedPriorityHash, keccak256(""))); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingWithWrongNumberOfLayer1txs() public { @@ -313,7 +346,11 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.expectRevert(abi.encodeWithSelector(ValueMismatch.selector, uint256(bytes32(bytes1(0x01))), uint256(2))); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_CommittingWithUnknownSystemLogKey() public { @@ -333,13 +370,15 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.expectRevert(abi.encodeWithSelector(UnexpectedSystemLog.selector, uint256(119))); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_SystemLogIsFromIncorrectAddress() public { - bytes32[9] memory values = [ - bytes32(""), - bytes32(""), + bytes32[7] memory values = [ bytes32(""), bytes32(""), bytes32(""), @@ -349,26 +388,7 @@ contract CommittingTest is ExecutorTest { bytes32("") ]; - bytes[9] memory errors = [ - bytes.concat("lm"), - bytes.concat(""), - bytes.concat(""), - bytes.concat("sc"), - bytes.concat("sv"), - bytes.concat("bl"), - bytes.concat("bk"), - bytes.concat("lp2"), - bytes.concat("vk") - ]; - for (uint256 i = 0; i < values.length; i++) { - // these logs are not checked by the executor, thus they can't cause a revert - if ( - i == uint256(SystemLogKey.TOTAL_L2_TO_L1_PUBDATA_KEY) || i == uint256(SystemLogKey.STATE_DIFF_HASH_KEY) - ) { - continue; - } - bytes[] memory wrongL2Logs = Utils.createSystemLogs(l2DAValidatorOutputHash); address wrongAddress = makeAddr("randomAddress"); wrongL2Logs[i] = Utils.constructL2Log(true, wrongAddress, i, values[i]); @@ -382,33 +402,17 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.expectRevert(abi.encodeWithSelector(InvalidLogSender.selector, wrongAddress, i)); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } } -<<<<<<< HEAD - // FIXME: uncomment when old logs are removed - // function test_RevertWhen_SystemLogIsMissing() public { - // for (uint256 i = 0; i < 7; i++) { - // bytes[] memory l2Logs = Utils.createSystemLogs(l2DAValidatorOutputHash); - // delete l2Logs[i]; - // - // IExecutor.CommitBatchInfo memory wrongNewCommitBatchInfo = newCommitBatchInfo; - // wrongNewCommitBatchInfo.systemLogs = Utils.encodePacked(l2Logs); - // - // IExecutor.CommitBatchInfo[] memory wrongNewCommitBatchInfoArray = new IExecutor.CommitBatchInfo[](1); - // wrongNewCommitBatchInfoArray[0] = wrongNewCommitBatchInfo; - // - // vm.prank(validator); - // - // vm.expectRevert(bytes.concat("b7")); - // executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); - // } - // } -======= function test_RevertWhen_SystemLogIsMissing() public { for (uint256 i = 0; i < 7; i++) { - bytes[] memory l2Logs = Utils.createSystemLogs(); + bytes[] memory l2Logs = Utils.createSystemLogs(l2DAValidatorOutputHash); delete l2Logs[i]; IExecutor.CommitBatchInfo memory wrongNewCommitBatchInfo = newCommitBatchInfo; @@ -419,12 +423,15 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); - uint256 allLogsProcessed = uint256(8191); - vm.expectRevert(abi.encodeWithSelector(MissingSystemLogs.selector, 8191, allLogsProcessed ^ (1 << i))); - executor.commitBatches(genesisStoredBatchInfo, wrongNewCommitBatchInfoArray); + uint256 allLogsProcessed = uint256(127); + vm.expectRevert(abi.encodeWithSelector(MissingSystemLogs.selector, 127, allLogsProcessed ^ (1 << i))); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + wrongNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } } ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe function test_SuccessfullyCommitBatch() public { bytes32 uncompressedStateDiffHash = Utils.randomBytes32("uncompressedStateDiffHash"); @@ -487,8 +494,11 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.blobhashes(defaultBlobVersionedHashes); vm.recordLogs(); - - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); Vm.Log[] memory entries = vm.getRecordedLogs(); @@ -524,7 +534,11 @@ contract CommittingTest is ExecutorTest { vm.recordLogs(); - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); Vm.Log[] memory entries = vm.getRecordedLogs(); @@ -589,7 +603,11 @@ contract CommittingTest is ExecutorTest { vm.recordLogs(); - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); Vm.Log[] memory entries = vm.getRecordedLogs(); @@ -613,7 +631,11 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.expectRevert(abi.encodeWithSelector(CanOnlyProcessOneBatch.selector)); - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_EmptyPubdataCommitments() public { @@ -636,12 +658,12 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); -<<<<<<< HEAD - vm.expectRevert(bytes("too small")); -======= - vm.expectRevert(PubdataCommitmentsEmpty.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + vm.expectRevert("too small"); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_PartialPubdataCommitment() public { @@ -676,12 +698,12 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.blobhashes(defaultBlobVersionedHashes); -<<<<<<< HEAD - vm.expectRevert(bytes("bd")); -======= vm.expectRevert(InvalidPubdataCommitmentsSize.selector); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_TooManyPubdataCommitments() public { @@ -717,8 +739,12 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); - vm.expectRevert(PubdataCommitmentsTooBig.selector); - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + vm.expectRevert(InvalidPubdataCommitmentsSize.selector); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_NotEnoughPubdataCommitments() public { @@ -745,7 +771,11 @@ contract CommittingTest is ExecutorTest { vm.blobhashes(versionedHashes); vm.expectRevert(abi.encodeWithSelector(NonEmptyBlobVersionHash.selector, uint256(1))); - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); vm.clearMockedCalls(); } @@ -771,7 +801,11 @@ contract CommittingTest is ExecutorTest { vm.prank(validator); vm.expectRevert(abi.encodeWithSelector(EmptyBlobVersionHash.selector, 0)); - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); vm.clearMockedCalls(); } @@ -800,7 +834,11 @@ contract CommittingTest is ExecutorTest { vm.blobhashes(blobVersionedHashes); vm.expectRevert(abi.encodeWithSelector(NonEmptyBlobVersionHash.selector, uint256(1))); - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); vm.clearMockedCalls(); } @@ -849,33 +887,49 @@ contract CommittingTest is ExecutorTest { IExecutor.CommitBatchInfo[] memory correctCommitBatchInfoArray = new IExecutor.CommitBatchInfo[](1); correctCommitBatchInfoArray[0] = correctNewCommitBatchInfo; -<<<<<<< HEAD correctCommitBatchInfoArray[0].operatorDAInput = operatorDAInput; -======= - correctCommitBatchInfoArray[0].pubdataCommitments = pubdataCommitment; + vm.blobhashes(blobVersionedHashes); vm.prank(validator); vm.expectRevert(abi.encodeWithSelector(BlobHashCommitmentError.selector, uint256(1), true, false)); - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_RevertWhen_SecondBlobLinearHashNotZeroWithEmptyCommitment() public { - bytes - memory pubdataCommitment = "\x01\xf4\x3d\x53\x8d\x91\xd4\x77\xb0\xf8\xf7\x7e\x19\x52\x48\x7f\x00\xb8\xdf\x41\xda\x90\x5c\x08\x75\xc5\xc9\x9b\xa1\x92\x26\x84\x0d\x0d\x0a\x25\x26\xee\x22\xc7\x96\x60\x65\x7c\xbe\x01\x95\x33\x5b\x44\x69\xbd\x92\x94\x6f\x7f\x74\xae\xc5\xce\xef\x31\xf4\x32\x53\xd4\x08\x96\x72\x65\xfa\x85\x5a\xc8\xa0\x0a\x19\x52\x93\x6e\x0f\xe9\x97\x01\xc0\xa4\x32\xa1\x32\x2c\x45\x67\x24\xf7\xad\xd8\xa5\xb4\x7a\x51\xda\x52\x17\x06\x06\x95\x34\x61\xab\xd7\x5b\x91\x49\xc7\xc7\x91\xf4\x07\xfd\xbc\xf8\x39\x53\x2c\xb1\x08\xe8\xa5\x00\x64\x40\xcf\x21\xbf\x68\x87\x20\x5a\xcf\x44\x3b\x66\x3a\x57\xf2"; - bytes32 versionedHash1 = 0xf39a869f62e75cf5f0bf914688a6b289caf2049435d8e68c5c5e6d05e44913f3; + bytes32 uncompressedStateDiffHash = Utils.randomBytes32("uncompressedStateDiffHash"); + bytes32 totalL2PubdataHash = Utils.randomBytes32("totalL2PubdataHash"); + uint8 numberOfBlobs = 2; + bytes32[] memory blobsLinearHashes = new bytes32[](2); + blobsLinearHashes[0] = Utils.randomBytes32("blobsLinearHashes1"); + blobsLinearHashes[1] = Utils.randomBytes32("blobsLinearHashes2"); - vm.mockCall(blobVersionedHashRetriever, abi.encode(uint256(0)), abi.encode(versionedHash1)); + bytes memory operatorDAInput = abi.encodePacked( + uncompressedStateDiffHash, + totalL2PubdataHash, + numberOfBlobs, + blobsLinearHashes, + bytes1(0x01), + defaultBlobCommitment, + EMPTY_PREPUBLISHED_COMMITMENT + ); - vm.mockCall(blobVersionedHashRetriever, abi.encode(uint256(1)), abi.encode(bytes32(0))); + bytes32[] memory blobVersionedHashes = new bytes32[](2); + blobVersionedHashes[0] = defaultBlobVersionedHashes[0]; + blobVersionedHashes[1] = defaultBlobVersionedHashes[0]; - vm.mockCall( - POINT_EVALUATION_PRECOMPILE_ADDR, - "\xf3\x9a\x86\x9f\x62\xe7\x5c\xf5\xf0\xbf\x91\x46\x88\xa6\xb2\x89\xca\xf2\x04\x94\x35\xd8\xe6\x8c\x5c\x5e\x6d\x05\xe4\x49\x13\xf3\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xf4\x3d\x53\x8d\x91\xd4\x77\xb0\xf8\xf7\x7e\x19\x52\x48\x7f\x00\xb8\xdf\x41\xda\x90\x5c\x08\x75\xc5\xc9\x9b\xa1\x92\x26\x84\x0d\x0d\x0a\x25\x26\xee\x22\xc7\x96\x60\x65\x7c\xbe\x01\x95\x33\x5b\x44\x69\xbd\x92\x94\x6f\x7f\x74\xae\xc5\xce\xef\x31\xf4\x32\x53\xd4\x08\x96\x72\x65\xfa\x85\x5a\xc8\xa0\x0a\x19\x52\x93\x6e\x0f\xe9\x97\x01\xc0\xa4\x32\xa1\x32\x2c\x45\x67\x24\xf7\xad\xd8\xa5\xb4\x7a\x51\xda\x52\x17\x06\x06\x95\x34\x61\xab\xd7\x5b\x91\x49\xc7\xc7\x91\xf4\x07\xfd\xbc\xf8\x39\x53\x2c\xb1\x08\xe8\xa5\x00\x64\x40\xcf\x21\xbf\x68\x87\x20\x5a\xcf\x44\x3b\x66\x3a\x57\xf2", - "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x73\xed\xa7\x53\x29\x9d\x7d\x48\x33\x39\xd8\x08\x09\xa1\xd8\x05\x53\xbd\xa4\x02\xff\xfe\x5b\xfe\xff\xff\xff\xff\x00\x00\x00\x01" + bytes32 outputHash = Utils.constructRollupL2DAValidatorOutputHash( + uncompressedStateDiffHash, + totalL2PubdataHash, + uint8(numberOfBlobs), + blobsLinearHashes ); - bytes[] memory correctL2Logs = Utils.createSystemLogs(); + bytes[] memory correctL2Logs = Utils.createSystemLogs(outputHash); correctL2Logs[uint256(SystemLogKey.PACKED_BATCH_AND_L2_BLOCK_TIMESTAMP_KEY)] = Utils.constructL2Log( true, L2_SYSTEM_CONTEXT_ADDRESS, @@ -883,34 +937,22 @@ contract CommittingTest is ExecutorTest { Utils.packBatchTimestampAndBlockTimestamp(currentTimestamp, currentTimestamp) ); - correctL2Logs[uint256(SystemLogKey.BLOB_ONE_HASH_KEY)] = Utils.constructL2Log( - true, - L2_PUBDATA_CHUNK_PUBLISHER_ADDR, - uint256(SystemLogKey.BLOB_ONE_HASH_KEY), - versionedHash1 - ); - - correctL2Logs[uint256(SystemLogKey.BLOB_TWO_HASH_KEY)] = Utils.constructL2Log( - true, - L2_PUBDATA_CHUNK_PUBLISHER_ADDR, - uint256(SystemLogKey.BLOB_TWO_HASH_KEY), - versionedHash1 - ); - IExecutor.CommitBatchInfo memory correctNewCommitBatchInfo = newCommitBatchInfo; correctNewCommitBatchInfo.systemLogs = Utils.encodePacked(correctL2Logs); IExecutor.CommitBatchInfo[] memory correctCommitBatchInfoArray = new IExecutor.CommitBatchInfo[](1); correctCommitBatchInfoArray[0] = correctNewCommitBatchInfo; - correctCommitBatchInfoArray[0].pubdataCommitments = pubdataCommitment; ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + correctCommitBatchInfoArray[0].operatorDAInput = operatorDAInput; - vm.prank(validator); vm.blobhashes(blobVersionedHashes); + vm.prank(validator); - vm.expectRevert(abi.encodeWithSelector(BlobHashCommitmentError.selector, uint256(1), false, true)); - executor.commitBatches(genesisStoredBatchInfo, correctCommitBatchInfoArray); - - vm.clearMockedCalls(); + // It will just panic with array out of bounds + vm.expectRevert(); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } } diff --git a/l1-contracts/test/foundry/unit/concrete/Executor/Executing.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Executing.t.sol similarity index 74% rename from l1-contracts/test/foundry/unit/concrete/Executor/Executing.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Executor/Executing.t.sol index 38468435a..fbfc92fd4 100644 --- a/l1-contracts/test/foundry/unit/concrete/Executor/Executing.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Executing.t.sol @@ -74,7 +74,11 @@ contract ExecutingTest is ExecutorTest { vm.prank(validator); vm.blobhashes(blobVersionedHashes); vm.recordLogs(); - executor.commitBatches(genesisStoredBatchInfo, commitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + commitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); Vm.Log[] memory entries = vm.getRecordedLogs(); newStoredBatchInfo = IExecutor.StoredBatchInfo({ @@ -92,7 +96,12 @@ contract ExecutingTest is ExecutorTest { storedBatchInfoArray[0] = newStoredBatchInfo; vm.prank(validator); - executor.proveBatches(genesisStoredBatchInfo, storedBatchInfoArray, proofInput); + (uint256 proveBatchFrom, uint256 proveBatchTo, bytes memory proveData) = Utils.encodeProveBatchesData( + genesisStoredBatchInfo, + storedBatchInfoArray, + proofInput + ); + executor.proveBatchesSharedBridge(uint256(0), proveBatchFrom, proveBatchTo, proveData); } function test_RevertWhen_ExecutingBlockWithWrongBatchNumber() public { @@ -103,13 +112,12 @@ contract ExecutingTest is ExecutorTest { storedBatchInfoArray[0] = wrongNewStoredBatchInfo; vm.prank(validator); -<<<<<<< HEAD - vm.expectRevert(bytes.concat("k")); - executor.executeBatches(storedBatchInfoArray, Utils.generatePriorityOps(storedBatchInfoArray.length)); -======= vm.expectRevert(NonSequentialBatch.selector); - executor.executeBatches(storedBatchInfoArray); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + (uint256 executeBatchFrom, uint256 executeBatchTo, bytes memory executeData) = Utils.encodeExecuteBatchesData( + storedBatchInfoArray, + Utils.generatePriorityOps(storedBatchInfoArray.length) + ); + executor.executeBatchesSharedBridge(uint256(0), executeBatchFrom, executeBatchTo, executeData); } function test_RevertWhen_ExecutingBlockWithWrongData() public { @@ -120,10 +128,6 @@ contract ExecutingTest is ExecutorTest { storedBatchInfoArray[0] = wrongNewStoredBatchInfo; vm.prank(validator); -<<<<<<< HEAD - vm.expectRevert(bytes.concat("exe10")); - executor.executeBatches(storedBatchInfoArray, Utils.generatePriorityOps(storedBatchInfoArray.length)); -======= vm.expectRevert( abi.encodeWithSelector( BatchHashMismatch.selector, @@ -131,30 +135,32 @@ contract ExecutingTest is ExecutorTest { keccak256(abi.encode(wrongNewStoredBatchInfo)) ) ); - executor.executeBatches(storedBatchInfoArray); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + (uint256 executeBatchFrom, uint256 executeBatchTo, bytes memory executeData) = Utils.encodeExecuteBatchesData( + storedBatchInfoArray, + Utils.generatePriorityOps(storedBatchInfoArray.length) + ); + executor.executeBatchesSharedBridge(uint256(0), executeBatchFrom, executeBatchTo, executeData); } function test_RevertWhen_ExecutingRevertedBlockWithoutCommittingAndProvingAgain() public { vm.prank(validator); - executor.revertBatches(0); + executor.revertBatchesSharedBridge(0, 0); IExecutor.StoredBatchInfo[] memory storedBatchInfoArray = new IExecutor.StoredBatchInfo[](1); storedBatchInfoArray[0] = newStoredBatchInfo; vm.prank(validator); -<<<<<<< HEAD - vm.expectRevert(bytes.concat("n")); - executor.executeBatches(storedBatchInfoArray, Utils.generatePriorityOps(storedBatchInfoArray.length)); -======= vm.expectRevert(CantExecuteUnprovenBatches.selector); - executor.executeBatches(storedBatchInfoArray); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + (uint256 executeBatchFrom, uint256 executeBatchTo, bytes memory executeData) = Utils.encodeExecuteBatchesData( + storedBatchInfoArray, + Utils.generatePriorityOps(storedBatchInfoArray.length) + ); + executor.executeBatchesSharedBridge(uint256(0), executeBatchFrom, executeBatchTo, executeData); } function test_RevertWhen_ExecutingUnavailablePriorityOperationHash() public { vm.prank(validator); - executor.revertBatches(0); + executor.revertBatchesSharedBridge(0, 0); bytes32 arbitraryCanonicalTxHash = Utils.randomBytes32("arbitraryCanonicalTxHash"); bytes32 chainedPriorityTxHash = keccak256(bytes.concat(keccak256(""), arbitraryCanonicalTxHash)); @@ -190,7 +196,11 @@ contract ExecutingTest is ExecutorTest { vm.prank(validator); vm.blobhashes(blobVersionedHashes); vm.recordLogs(); - executor.commitBatches(genesisStoredBatchInfo, correctNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); Vm.Log[] memory entries = vm.getRecordedLogs(); IExecutor.StoredBatchInfo memory correctNewStoredBatchInfo = newStoredBatchInfo; @@ -203,24 +213,32 @@ contract ExecutingTest is ExecutorTest { correctNewStoredBatchInfoArray[0] = correctNewStoredBatchInfo; vm.prank(validator); - executor.proveBatches(genesisStoredBatchInfo, correctNewStoredBatchInfoArray, proofInput); + uint256 processBatchFrom; + uint256 processBatchTo; + bytes memory processData; + { + (processBatchFrom, processBatchTo, processData) = Utils.encodeProveBatchesData( + genesisStoredBatchInfo, + correctNewStoredBatchInfoArray, + proofInput + ); + executor.proveBatchesSharedBridge(uint256(0), processBatchFrom, processBatchTo, processData); + } vm.prank(validator); -<<<<<<< HEAD - vm.expectRevert(bytes.concat("s")); - executor.executeBatches( - correctNewStoredBatchInfoArray, - Utils.generatePriorityOps(correctNewStoredBatchInfoArray.length) - ); -======= vm.expectRevert(QueueIsEmpty.selector); - executor.executeBatches(correctNewStoredBatchInfoArray); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + { + (processBatchFrom, processBatchTo, processData) = Utils.encodeExecuteBatchesData( + correctNewStoredBatchInfoArray, + Utils.generatePriorityOps(correctNewStoredBatchInfoArray.length) + ); + executor.executeBatchesSharedBridge(uint256(0), processBatchFrom, processBatchTo, processData); + } } function test_RevertWhen_ExecutingWithUnmatchedPriorityOperationHash() public { vm.prank(validator); - executor.revertBatches(0); + executor.revertBatchesSharedBridge(0, 0); bytes32 arbitraryCanonicalTxHash = Utils.randomBytes32("arbitraryCanonicalTxHash"); bytes32 chainedPriorityTxHash = keccak256(bytes.concat(keccak256(""), arbitraryCanonicalTxHash)); @@ -255,7 +273,11 @@ contract ExecutingTest is ExecutorTest { vm.prank(validator); vm.blobhashes(blobVersionedHashes); vm.recordLogs(); - executor.commitBatches(genesisStoredBatchInfo, correctNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + correctNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); Vm.Log[] memory entries = vm.getRecordedLogs(); IExecutor.StoredBatchInfo memory correctNewStoredBatchInfo = newStoredBatchInfo; @@ -268,7 +290,17 @@ contract ExecutingTest is ExecutorTest { correctNewStoredBatchInfoArray[0] = correctNewStoredBatchInfo; vm.prank(validator); - executor.proveBatches(genesisStoredBatchInfo, correctNewStoredBatchInfoArray, proofInput); + uint256 processBatchFrom; + uint256 processBatchTo; + bytes memory processData; + { + (processBatchFrom, processBatchTo, processData) = Utils.encodeProveBatchesData( + genesisStoredBatchInfo, + correctNewStoredBatchInfoArray, + proofInput + ); + executor.proveBatchesSharedBridge(uint256(0), processBatchFrom, processBatchTo, processData); + } bytes32 randomFactoryDeps0 = Utils.randomBytes32("randomFactoryDeps0"); @@ -292,16 +324,15 @@ contract ExecutingTest is ExecutorTest { }); vm.prank(validator); -<<<<<<< HEAD - vm.expectRevert(bytes.concat("x")); - executor.executeBatches( - correctNewStoredBatchInfoArray, - Utils.generatePriorityOps(correctNewStoredBatchInfoArray.length) - ); -======= vm.expectRevert(PriorityOperationsRollingHashMismatch.selector); - executor.executeBatches(correctNewStoredBatchInfoArray); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + + { + (processBatchFrom, processBatchTo, processData) = Utils.encodeExecuteBatchesData( + correctNewStoredBatchInfoArray, + Utils.generatePriorityOps(correctNewStoredBatchInfoArray.length) + ); + executor.executeBatchesSharedBridge(uint256(0), processBatchFrom, processBatchTo, processData); + } } function test_RevertWhen_CommittingBlockWithWrongPreviousBatchHash() public { @@ -331,7 +362,11 @@ contract ExecutingTest is ExecutorTest { vm.expectRevert( abi.encodeWithSelector(BatchHashMismatch.selector, storedBatchHash, keccak256(abi.encode(genesisBlock))) ); - executor.commitBatches(genesisBlock, correctNewCommitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisBlock, + correctNewCommitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); } function test_ShouldExecuteBatchesuccessfully() public { @@ -339,7 +374,11 @@ contract ExecutingTest is ExecutorTest { storedBatchInfoArray[0] = newStoredBatchInfo; vm.prank(validator); - executor.executeBatches(storedBatchInfoArray, Utils.generatePriorityOps(storedBatchInfoArray.length)); + (uint256 executeBatchFrom, uint256 executeBatchTo, bytes memory executeData) = Utils.encodeExecuteBatchesData( + storedBatchInfoArray, + Utils.generatePriorityOps(storedBatchInfoArray.length) + ); + executor.executeBatchesSharedBridge(uint256(0), executeBatchFrom, executeBatchTo, executeData); uint256 totalBlocksExecuted = getters.getTotalBlocksExecuted(); assertEq(totalBlocksExecuted, 1); diff --git a/l1-contracts/test/foundry/unit/concrete/Executor/ExecutorProof.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Executor/ExecutorProof.t.sol similarity index 99% rename from l1-contracts/test/foundry/unit/concrete/Executor/ExecutorProof.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Executor/ExecutorProof.t.sol index 5de5cc670..af6e9f3a5 100644 --- a/l1-contracts/test/foundry/unit/concrete/Executor/ExecutorProof.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Executor/ExecutorProof.t.sol @@ -3,8 +3,8 @@ pragma solidity 0.8.24; import {Test} from "forge-std/Test.sol"; -import {Utils} from "foundry-test/unit/concrete/Utils/Utils.sol"; -import {UtilsFacet} from "foundry-test/unit/concrete/Utils/UtilsFacet.sol"; +import {Utils} from "foundry-test/l1/unit/concrete/Utils/Utils.sol"; +import {UtilsFacet} from "foundry-test/l1/unit/concrete/Utils/UtilsFacet.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; import {ExecutorFacet} from "contracts/state-transition/chain-deps/facets/Executor.sol"; diff --git a/l1-contracts/test/foundry/unit/concrete/Executor/Proving.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Proving.t.sol similarity index 78% rename from l1-contracts/test/foundry/unit/concrete/Executor/Proving.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Executor/Proving.t.sol index 5242cee81..73b104186 100644 --- a/l1-contracts/test/foundry/unit/concrete/Executor/Proving.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Proving.t.sol @@ -41,7 +41,11 @@ contract ProvingTest is ExecutorTest { vm.prank(validator); vm.blobhashes(blobVersionedHashes); vm.recordLogs(); - executor.commitBatches(genesisStoredBatchInfo, commitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + commitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); Vm.Log[] memory entries = vm.getRecordedLogs(); newStoredBatchInfo = IExecutor.StoredBatchInfo({ @@ -106,7 +110,12 @@ contract ProvingTest is ExecutorTest { keccak256(abi.encode(wrongPreviousStoredBatchInfo)) ) ); - executor.proveBatches(wrongPreviousStoredBatchInfo, storedBatchInfoArray, proofInput); + (uint256 proveBatchFrom, uint256 proveBatchTo, bytes memory proveData) = Utils.encodeProveBatchesData( + wrongPreviousStoredBatchInfo, + storedBatchInfoArray, + proofInput + ); + executor.proveBatchesSharedBridge(uint256(0), proveBatchFrom, proveBatchTo, proveData); } function test_RevertWhen_ProvingWithWrongCommittedBlock() public { @@ -125,12 +134,17 @@ contract ProvingTest is ExecutorTest { keccak256(abi.encode(wrongNewStoredBatchInfo)) ) ); - executor.proveBatches(genesisStoredBatchInfo, storedBatchInfoArray, proofInput); + (uint256 proveBatchFrom, uint256 proveBatchTo, bytes memory proveData) = Utils.encodeProveBatchesData( + genesisStoredBatchInfo, + storedBatchInfoArray, + proofInput + ); + executor.proveBatchesSharedBridge(uint256(0), proveBatchFrom, proveBatchTo, proveData); } function test_RevertWhen_ProvingRevertedBlockWithoutCommittingAgain() public { vm.prank(validator); - executor.revertBatches(0); + executor.revertBatchesSharedBridge(0, 0); IExecutor.StoredBatchInfo[] memory storedBatchInfoArray = new IExecutor.StoredBatchInfo[](1); storedBatchInfoArray[0] = newStoredBatchInfo; @@ -138,7 +152,12 @@ contract ProvingTest is ExecutorTest { vm.prank(validator); vm.expectRevert(VerifiedBatchesExceedsCommittedBatches.selector); - executor.proveBatches(genesisStoredBatchInfo, storedBatchInfoArray, proofInput); + (uint256 proveBatchFrom, uint256 proveBatchTo, bytes memory proveData) = Utils.encodeProveBatchesData( + genesisStoredBatchInfo, + storedBatchInfoArray, + proofInput + ); + executor.proveBatchesSharedBridge(uint256(0), proveBatchFrom, proveBatchTo, proveData); } function test_SuccessfulProve() public { @@ -146,8 +165,12 @@ contract ProvingTest is ExecutorTest { storedBatchInfoArray[0] = newStoredBatchInfo; vm.prank(validator); - - executor.proveBatches(genesisStoredBatchInfo, storedBatchInfoArray, proofInput); + (uint256 proveBatchFrom, uint256 proveBatchTo, bytes memory proveData) = Utils.encodeProveBatchesData( + genesisStoredBatchInfo, + storedBatchInfoArray, + proofInput + ); + executor.proveBatchesSharedBridge(uint256(0), proveBatchFrom, proveBatchTo, proveData); uint256 totalBlocksVerified = getters.getTotalBlocksVerified(); assertEq(totalBlocksVerified, 1); diff --git a/l1-contracts/test/foundry/unit/concrete/Executor/Reverting.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Reverting.t.sol similarity index 86% rename from l1-contracts/test/foundry/unit/concrete/Executor/Reverting.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Executor/Reverting.t.sol index 0dc12bea0..ba2fc4b60 100644 --- a/l1-contracts/test/foundry/unit/concrete/Executor/Reverting.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Executor/Reverting.t.sol @@ -40,7 +40,11 @@ contract RevertingTest is ExecutorTest { vm.prank(validator); vm.blobhashes(blobVersionedHashes); vm.recordLogs(); - executor.commitBatches(genesisStoredBatchInfo, commitBatchInfoArray); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + genesisStoredBatchInfo, + commitBatchInfoArray + ); + executor.commitBatchesSharedBridge(uint256(0), commitBatchFrom, commitBatchTo, commitData); Vm.Log[] memory entries = vm.getRecordedLogs(); newStoredBatchInfo = IExecutor.StoredBatchInfo({ @@ -58,8 +62,12 @@ contract RevertingTest is ExecutorTest { storedBatchInfoArray[0] = newStoredBatchInfo; vm.prank(validator); - - executor.proveBatches(genesisStoredBatchInfo, storedBatchInfoArray, proofInput); + (uint256 proveBatchFrom, uint256 proveBatchTo, bytes memory proveData) = Utils.encodeProveBatchesData( + genesisStoredBatchInfo, + storedBatchInfoArray, + proofInput + ); + executor.proveBatchesSharedBridge(uint256(0), proveBatchFrom, proveBatchTo, proveData); } function setUpCommitBatch() public { @@ -99,7 +107,7 @@ contract RevertingTest is ExecutorTest { function test_RevertWhen_RevertingMoreBatchesThanAlreadyCommitted() public { vm.prank(validator); vm.expectRevert(RevertedBatchNotAfterNewLastBatch.selector); - executor.revertBatches(10); + executor.revertBatchesSharedBridge(0, 10); } function test_SuccessfulRevert() public { @@ -110,7 +118,7 @@ contract RevertingTest is ExecutorTest { assertEq(totalBlocksVerifiedBefore, 1, "totalBlocksVerifiedBefore"); vm.prank(validator); - executor.revertBatches(0); + executor.revertBatchesSharedBridge(0, 0); uint256 totalBlocksCommitted = getters.getTotalBlocksCommitted(); assertEq(totalBlocksCommitted, 0, "totalBlocksCommitted"); diff --git a/l1-contracts/test/foundry/unit/concrete/Executor/_Executor_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Executor/_Executor_Shared.t.sol similarity index 89% rename from l1-contracts/test/foundry/unit/concrete/Executor/_Executor_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Executor/_Executor_Shared.t.sol index 44f28181d..b4d46e842 100644 --- a/l1-contracts/test/foundry/unit/concrete/Executor/_Executor_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Executor/_Executor_Shared.t.sol @@ -6,11 +6,11 @@ import {Test} from "forge-std/Test.sol"; import {Utils, DEFAULT_L2_LOGS_TREE_ROOT_HASH, L2_DA_VALIDATOR_ADDRESS} from "../Utils/Utils.sol"; import {COMMIT_TIMESTAMP_NOT_OLDER, ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; import {DummyEraBaseTokenBridge} from "contracts/dev-contracts/test/DummyEraBaseTokenBridge.sol"; -import {DummyStateTransitionManager} from "contracts/dev-contracts/test/DummyStateTransitionManager.sol"; -import {IStateTransitionManager} from "contracts/state-transition/IStateTransitionManager.sol"; +import {DummyChainTypeManager} from "contracts/dev-contracts/test/DummyChainTypeManager.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; import {DiamondInit} from "contracts/state-transition/chain-deps/DiamondInit.sol"; import {DiamondProxy} from "contracts/state-transition/chain-deps/DiamondProxy.sol"; -import {VerifierParams, FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; +import {VerifierParams, FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; import {TestExecutor} from "contracts/dev-contracts/test/TestExecutor.sol"; import {ExecutorFacet} from "contracts/state-transition/chain-deps/facets/Executor.sol"; import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; @@ -27,7 +27,9 @@ import {MessageRoot} from "contracts/bridgehub/MessageRoot.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; import {RollupL1DAValidator} from "da-contracts/RollupL1DAValidator.sol"; -import {IL1AssetRouter} from "contracts/bridge/interfaces/IL1AssetRouter.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; +import {IAssetRouterBase} from "contracts/bridge/asset-router/IAssetRouterBase.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; bytes32 constant EMPTY_PREPUBLISHED_COMMITMENT = 0x0000000000000000000000000000000000000000000000000000000000000000; bytes constant POINT_EVALUATION_PRECOMPILE_RESULT = hex"000000000000000000000000000000000000000000000000000000000000100073eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001"; @@ -54,7 +56,7 @@ contract ExecutorTest is Test { uint256 eraChainId; IExecutor.StoredBatchInfo internal genesisStoredBatchInfo; - IExecutor.ProofInput internal proofInput; + uint256[] internal proofInput; function getAdminSelectors() private view returns (bytes4[] memory) { bytes4[] memory selectors = new bytes4[](12); @@ -75,16 +77,16 @@ contract ExecutorTest is Test { function getExecutorSelectors() private view returns (bytes4[] memory) { bytes4[] memory selectors = new bytes4[](5); - selectors[0] = executor.commitBatches.selector; - selectors[1] = executor.proveBatches.selector; - selectors[2] = executor.executeBatches.selector; - selectors[3] = executor.revertBatches.selector; + selectors[0] = executor.commitBatchesSharedBridge.selector; + selectors[1] = executor.proveBatchesSharedBridge.selector; + selectors[2] = executor.executeBatchesSharedBridge.selector; + selectors[3] = executor.revertBatchesSharedBridge.selector; selectors[4] = executor.setPriorityTreeStartIndex.selector; return selectors; } function getGettersSelectors() public view returns (bytes4[] memory) { - bytes4[] memory selectors = new bytes4[](29); + bytes4[] memory selectors = new bytes4[](28); selectors[0] = getters.getVerifier.selector; selectors[1] = getters.getAdmin.selector; selectors[2] = getters.getPendingAdmin.selector; @@ -112,11 +114,7 @@ contract ExecutorTest is Test { selectors[24] = getters.isFacetFreezable.selector; selectors[25] = getters.getTotalBatchesCommitted.selector; selectors[26] = getters.getTotalBatchesVerified.selector; -<<<<<<< HEAD -======= - selectors[27] = getters.getTotalBatchesExecuted.selector; - selectors[28] = getters.storedBlockHash.selector; ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + selectors[27] = getters.storedBlockHash.selector; return selectors; } @@ -162,15 +160,15 @@ contract ExecutorTest is Test { rollupL1DAValidator = new RollupL1DAValidator(); - admin = new AdminFacet(); + admin = new AdminFacet(block.chainid); getters = new GettersFacet(); executor = new TestExecutor(); - mailbox = new MailboxFacet(eraChainId); + mailbox = new MailboxFacet(eraChainId, block.chainid); - DummyStateTransitionManager stateTransitionManager = new DummyStateTransitionManager(); + DummyChainTypeManager chainTypeManager = new DummyChainTypeManager(); vm.mockCall( - address(stateTransitionManager), - abi.encodeWithSelector(IStateTransitionManager.protocolVersionIsActive.selector), + address(chainTypeManager), + abi.encodeWithSelector(IChainTypeManager.protocolVersionIsActive.selector), abi.encode(bool(true)) ); DiamondInit diamondInit = new DiamondInit(); @@ -194,11 +192,11 @@ contract ExecutorTest is Test { // TODO REVIEW chainId: eraChainId, bridgehub: address(dummyBridgehub), - stateTransitionManager: address(stateTransitionManager), + chainTypeManager: address(chainTypeManager), protocolVersion: 0, admin: owner, validatorTimelock: validator, - baseToken: ETH_TOKEN_ADDRESS, + baseTokenAssetId: DataEncoding.encodeNTVAssetId(block.chainid, ETH_TOKEN_ADDRESS), baseTokenBridge: address(sharedBridge), storedBatchZero: keccak256(abi.encode(genesisStoredBatchInfo)), verifier: IVerifier(testnetVerifier), // verifier @@ -257,15 +255,11 @@ contract ExecutorTest is Test { admin = AdminFacet(address(diamondProxy)); // Initiate the token multiplier to enable L1 -> L2 transactions. - vm.prank(address(stateTransitionManager)); + vm.prank(address(chainTypeManager)); admin.setTokenMultiplier(1, 1); vm.prank(address(owner)); admin.setDAValidatorPair(address(rollupL1DAValidator), L2_DA_VALIDATOR_ADDRESS); - uint256[] memory recursiveAggregationInput; - uint256[] memory serializedProof; - proofInput = IExecutor.ProofInput(recursiveAggregationInput, serializedProof); - // foundry's default value is 1 for the block's timestamp, it is expected // that block.timestamp > COMMIT_TIMESTAMP_NOT_OLDER + 1 vm.warp(COMMIT_TIMESTAMP_NOT_OLDER + 1 + 1); diff --git a/l1-contracts/test/foundry/l1/unit/concrete/Governance/AccessControlRestriction.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/AccessControlRestriction.t.sol new file mode 100644 index 000000000..1cd471413 --- /dev/null +++ b/l1-contracts/test/foundry/l1/unit/concrete/Governance/AccessControlRestriction.t.sol @@ -0,0 +1,186 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {Test} from "forge-std/Test.sol"; + +import "@openzeppelin/contracts-v4/utils/Strings.sol"; +import "forge-std/console.sol"; +import {IChainAdmin} from "contracts/governance/IChainAdmin.sol"; +import {ChainAdmin} from "contracts/governance/ChainAdmin.sol"; +import {AccessControlRestriction} from "contracts/governance/AccessControlRestriction.sol"; +import {IAccessControlRestriction} from "contracts/governance/IAccessControlRestriction.sol"; +import {Utils} from "test/foundry/l1/unit/concrete/Utils/Utils.sol"; +import {NoCallsProvided, AccessToFallbackDenied, AccessToFunctionDenied} from "contracts/common/L1ContractErrors.sol"; +import {Call} from "contracts/governance/Common.sol"; + +contract AccessRestrictionTest is Test { + AccessControlRestriction internal restriction; + ChainAdmin internal chainAdmin; + address owner; + address randomCaller; + bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00; + + function getChainAdminSelectors() public pure returns (bytes4[] memory) { + bytes4[] memory selectors = new bytes4[](12); + selectors[0] = IChainAdmin.getRestrictions.selector; + selectors[1] = IChainAdmin.isRestrictionActive.selector; + selectors[2] = IChainAdmin.addRestriction.selector; + selectors[3] = IChainAdmin.removeRestriction.selector; + + return selectors; + } + + function setUp() public { + owner = makeAddr("random address"); + randomCaller = makeAddr("random caller"); + + restriction = new AccessControlRestriction(0, owner); + address[] memory restrictions = new address[](1); + restrictions[0] = address(restriction); + + chainAdmin = new ChainAdmin(restrictions); + } + + function test_adminAsAddressZero() public { + vm.expectRevert("AccessControl: 0 default admin"); + new AccessControlRestriction(0, address(0)); + } + + function test_setRequiredRoleForCallByNotDefaultAdmin(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + + bytes4[] memory chainAdminSelectors = getChainAdminSelectors(); + string memory revertMsg = string( + abi.encodePacked( + "AccessControl: account ", + Strings.toHexString(uint160(randomCaller), 20), + " is missing role ", + Strings.toHexString(uint256(DEFAULT_ADMIN_ROLE), 32) + ) + ); + + vm.expectRevert(bytes(revertMsg)); + vm.prank(randomCaller); + restriction.setRequiredRoleForCall(address(chainAdmin), chainAdminSelectors[0], role); + } + + function test_setRequiredRoleForCallAccessToFunctionDenied(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + + bytes4[] memory chainAdminSelectors = getChainAdminSelectors(); + + vm.startPrank(owner); + restriction.setRequiredRoleForCall(address(chainAdmin), chainAdminSelectors[0], role); + vm.stopPrank(); + + Call memory call = Call({ + target: address(chainAdmin), + value: 0, + data: abi.encodeCall(IChainAdmin.getRestrictions, ()) + }); + + vm.expectRevert( + abi.encodeWithSelector( + AccessToFunctionDenied.selector, + address(chainAdmin), + chainAdminSelectors[0], + randomCaller + ) + ); + restriction.validateCall(call, randomCaller); + } + + function test_setRequiredRoleForCall(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + + bytes4[] memory chainAdminSelectors = getChainAdminSelectors(); + + vm.expectEmit(true, true, false, true); + emit IAccessControlRestriction.RoleSet(address(chainAdmin), chainAdminSelectors[0], role); + + vm.startPrank(owner); + restriction.setRequiredRoleForCall(address(chainAdmin), chainAdminSelectors[0], role); + restriction.grantRole(role, randomCaller); + vm.stopPrank(); + + Call memory call = Call({ + target: address(chainAdmin), + value: 0, + data: abi.encodeCall(IChainAdmin.getRestrictions, ()) + }); + restriction.validateCall(call, randomCaller); + } + + function test_setRequiredRoleForFallbackByNotDefaultAdmin(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + + string memory revertMsg = string( + abi.encodePacked( + "AccessControl: account ", + Strings.toHexString(uint160(randomCaller), 20), + " is missing role ", + Strings.toHexString(uint256(DEFAULT_ADMIN_ROLE), 32) + ) + ); + + vm.expectRevert(bytes(revertMsg)); + vm.prank(randomCaller); + restriction.setRequiredRoleForFallback(address(chainAdmin), role); + } + + function test_setRequiredRoleForFallbackAccessToFallbackDenied(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + + vm.startPrank(owner); + restriction.setRequiredRoleForFallback(address(chainAdmin), role); + vm.stopPrank(); + + Call memory call = Call({target: address(chainAdmin), value: 0, data: ""}); + + vm.expectRevert(abi.encodeWithSelector(AccessToFallbackDenied.selector, address(chainAdmin), randomCaller)); + restriction.validateCall(call, randomCaller); + } + + function test_setRequiredRoleForFallback(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + + vm.expectEmit(true, false, false, true); + emit IAccessControlRestriction.FallbackRoleSet(address(chainAdmin), role); + + vm.startPrank(owner); + restriction.setRequiredRoleForFallback(address(chainAdmin), role); + restriction.grantRole(role, randomCaller); + vm.stopPrank(); + + Call memory call = Call({target: address(chainAdmin), value: 0, data: ""}); + restriction.validateCall(call, randomCaller); + } + + function test_validateCallFunction(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + + bytes4[] memory chainAdminSelectors = getChainAdminSelectors(); + vm.startPrank(owner); + restriction.setRequiredRoleForCall(address(chainAdmin), chainAdminSelectors[0], role); + restriction.grantRole(role, randomCaller); + vm.stopPrank(); + + Call memory call = Call({ + target: address(chainAdmin), + value: 0, + data: abi.encodeCall(IChainAdmin.getRestrictions, ()) + }); + restriction.validateCall(call, randomCaller); + } + + function test_validateCallFallback(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + vm.startPrank(owner); + restriction.setRequiredRoleForFallback(address(chainAdmin), role); + restriction.grantRole(role, randomCaller); + vm.stopPrank(); + + Call memory call = Call({target: address(chainAdmin), value: 0, data: ""}); + restriction.validateCall(call, randomCaller); + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/Governance/Authorization.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/Authorization.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Governance/Authorization.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Governance/Authorization.t.sol diff --git a/l1-contracts/test/foundry/l1/unit/concrete/Governance/ChainAdmin.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/ChainAdmin.t.sol new file mode 100644 index 000000000..27624d503 --- /dev/null +++ b/l1-contracts/test/foundry/l1/unit/concrete/Governance/ChainAdmin.t.sol @@ -0,0 +1,177 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {Test} from "forge-std/Test.sol"; + +import "@openzeppelin/contracts-v4/utils/Strings.sol"; +import {AccessControlRestriction} from "contracts/governance/AccessControlRestriction.sol"; +import {IChainAdmin} from "contracts/governance/IChainAdmin.sol"; +import {ChainAdmin} from "contracts/governance/ChainAdmin.sol"; +import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; +import {Call} from "contracts/governance/Common.sol"; +import {NoCallsProvided, RestrictionWasAlreadyPresent, RestrictionWasNotPresent, AccessToFallbackDenied, AccessToFunctionDenied} from "contracts/common/L1ContractErrors.sol"; +import {Utils} from "test/foundry/l1/unit/concrete/Utils/Utils.sol"; + +contract ChainAdminTest is Test { + ChainAdmin internal chainAdmin; + AccessControlRestriction internal restriction; + GettersFacet internal gettersFacet; + + address internal owner; + uint32 internal major; + uint32 internal minor; + uint32 internal patch; + bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00; + + function setUp() public { + owner = makeAddr("random address"); + + restriction = new AccessControlRestriction(0, owner); + address[] memory restrictions = new address[](1); + restrictions[0] = address(restriction); + + chainAdmin = new ChainAdmin(restrictions); + + gettersFacet = new GettersFacet(); + } + + function test_getRestrictions() public { + address[] memory restrictions = chainAdmin.getRestrictions(); + assertEq(restrictions[0], address(restriction)); + } + + function test_isRestrictionActive() public { + bool isActive = chainAdmin.isRestrictionActive(address(restriction)); + assertEq(isActive, true); + } + + function test_addRestriction() public { + address[] memory restrictions = chainAdmin.getRestrictions(); + + vm.expectEmit(true, false, false, true); + emit IChainAdmin.RestrictionAdded(owner); + + vm.prank(address(chainAdmin)); + chainAdmin.addRestriction(owner); + } + + function test_addRestrictionRevert() public { + vm.startPrank(address(chainAdmin)); + chainAdmin.addRestriction(owner); + + vm.expectRevert(abi.encodeWithSelector(RestrictionWasAlreadyPresent.selector, owner)); + chainAdmin.addRestriction(owner); + vm.stopPrank(); + } + + function test_removeRestriction() public { + address[] memory restrictions = chainAdmin.getRestrictions(); + + vm.startPrank(address(chainAdmin)); + chainAdmin.addRestriction(owner); + + vm.expectEmit(true, false, false, true); + emit IChainAdmin.RestrictionRemoved(owner); + + chainAdmin.removeRestriction(owner); + vm.stopPrank(); + } + + function test_removeRestrictionRevert() public { + address[] memory restrictions = chainAdmin.getRestrictions(); + + vm.startPrank(address(chainAdmin)); + chainAdmin.addRestriction(owner); + chainAdmin.removeRestriction(owner); + + vm.expectRevert(abi.encodeWithSelector(RestrictionWasNotPresent.selector, owner)); + chainAdmin.removeRestriction(owner); + vm.stopPrank(); + } + + function test_setUpgradeTimestamp(uint256 semverMinorVersionMultiplier, uint256 timestamp) public { + (major, minor, patch) = gettersFacet.getSemverProtocolVersion(); + uint256 protocolVersion = packSemver(major, minor, patch + 1, semverMinorVersionMultiplier); + + vm.expectEmit(true, false, false, true); + emit IChainAdmin.UpdateUpgradeTimestamp(protocolVersion, timestamp); + + vm.prank(address(chainAdmin)); + chainAdmin.setUpgradeTimestamp(protocolVersion, timestamp); + } + + function test_multicallRevertNoCalls() public { + Call[] memory calls = new Call[](0); + + vm.expectRevert(NoCallsProvided.selector); + chainAdmin.multicall(calls, false); + } + + function test_multicallRevertFailedCall() public { + Call[] memory calls = new Call[](1); + calls[0] = Call({target: address(chainAdmin), value: 0, data: abi.encodeCall(gettersFacet.getAdmin, ())}); + + vm.expectRevert(); + vm.prank(owner); + chainAdmin.multicall(calls, true); + } + + function test_validateCallAccessToFunctionDenied(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + + Call[] memory calls = new Call[](2); + calls[0] = Call({target: address(gettersFacet), value: 0, data: abi.encodeCall(gettersFacet.getAdmin, ())}); + calls[1] = Call({target: address(gettersFacet), value: 0, data: abi.encodeCall(gettersFacet.getVerifier, ())}); + + vm.prank(owner); + restriction.setRequiredRoleForCall(address(gettersFacet), gettersFacet.getAdmin.selector, role); + + vm.expectRevert( + abi.encodeWithSelector( + AccessToFunctionDenied.selector, + address(gettersFacet), + gettersFacet.getAdmin.selector, + owner + ) + ); + vm.prank(owner); + chainAdmin.multicall(calls, true); + } + + function test_validateCallAccessToFallbackDenied(bytes32 role) public { + vm.assume(role != DEFAULT_ADMIN_ROLE); + + Call[] memory calls = new Call[](2); + calls[0] = Call({target: address(gettersFacet), value: 0, data: ""}); + calls[1] = Call({target: address(gettersFacet), value: 0, data: abi.encodeCall(gettersFacet.getVerifier, ())}); + + vm.prank(owner); + restriction.setRequiredRoleForFallback(address(gettersFacet), role); + + vm.expectRevert(abi.encodeWithSelector(AccessToFallbackDenied.selector, address(gettersFacet), owner)); + vm.prank(owner); + chainAdmin.multicall(calls, true); + } + + function test_multicall() public { + Call[] memory calls = new Call[](2); + calls[0] = Call({target: address(gettersFacet), value: 0, data: abi.encodeCall(gettersFacet.getAdmin, ())}); + calls[1] = Call({target: address(gettersFacet), value: 0, data: abi.encodeCall(gettersFacet.getVerifier, ())}); + + vm.prank(owner); + chainAdmin.multicall(calls, true); + } + + function packSemver( + uint32 major, + uint32 minor, + uint32 patch, + uint256 semverMinorVersionMultiplier + ) public returns (uint256) { + if (major != 0) { + revert("Major version must be 0"); + } + + return minor * semverMinorVersionMultiplier + patch; + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/Governance/Executing.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/Executing.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Governance/Executing.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Governance/Executing.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Governance/Fallback.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/Fallback.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Governance/Fallback.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Governance/Fallback.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Governance/OperationStatus.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/OperationStatus.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Governance/OperationStatus.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Governance/OperationStatus.t.sol diff --git a/l1-contracts/test/foundry/l1/unit/concrete/Governance/PermanentRestriction.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/PermanentRestriction.t.sol new file mode 100644 index 000000000..bcfe6ae2c --- /dev/null +++ b/l1-contracts/test/foundry/l1/unit/concrete/Governance/PermanentRestriction.t.sol @@ -0,0 +1,389 @@ +pragma solidity 0.8.24; + +import "@openzeppelin/contracts-v4/utils/Strings.sol"; +import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; +import {Bridgehub} from "contracts/bridgehub/Bridgehub.sol"; +import {L2TransactionRequestTwoBridgesOuter, BridgehubBurnCTMAssetData} from "contracts/bridgehub/IBridgehub.sol"; +import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; +import {ChainTypeManager} from "contracts/state-transition/ChainTypeManager.sol"; +import {DiamondInit} from "contracts/state-transition/chain-deps/DiamondInit.sol"; +import {PermanentRestriction, MIN_GAS_FOR_FALLABLE_CALL} from "contracts/governance/PermanentRestriction.sol"; +import {IPermanentRestriction} from "contracts/governance/IPermanentRestriction.sol"; +import {NotAllowed, NotEnoughGas, InvalidAddress, UnsupportedEncodingVersion, InvalidSelector, NotBridgehub, ZeroAddress, ChainZeroAddress, NotAnAdmin, UnallowedImplementation, RemovingPermanentRestriction, CallNotAllowed} from "contracts/common/L1ContractErrors.sol"; +import {Call} from "contracts/governance/Common.sol"; +import {IZKChain} from "contracts/state-transition/chain-interfaces/IZKChain.sol"; +import {VerifierParams, FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; +import {IAdmin} from "contracts/state-transition/chain-interfaces/IAdmin.sol"; +import {AccessControlRestriction} from "contracts/governance/AccessControlRestriction.sol"; +import {ChainAdmin} from "contracts/governance/ChainAdmin.sol"; +import {IChainAdmin} from "contracts/governance/IChainAdmin.sol"; +import {ChainTypeManagerTest} from "test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/_ChainTypeManager_Shared.t.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; +import {ICTMDeploymentTracker} from "contracts/bridgehub/ICTMDeploymentTracker.sol"; +import {IMessageRoot} from "contracts/bridgehub/IMessageRoot.sol"; +import {MessageRoot} from "contracts/bridgehub/MessageRoot.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; +import {IL1Nullifier} from "contracts/bridge/interfaces/IL1Nullifier.sol"; +import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; +import {L2ContractHelper} from "contracts/common/libraries/L2ContractHelper.sol"; + +contract PermanentRestrictionTest is ChainTypeManagerTest { + ChainAdmin internal chainAdmin; + AccessControlRestriction internal restriction; + PermanentRestriction internal permRestriction; + + address constant L2_FACTORY_ADDR = address(0); + + address internal owner; + address internal hyperchain; + + function setUp() public { + deploy(); + + createNewChainBridgehub(); + + owner = makeAddr("owner"); + hyperchain = chainContractAddress.getHyperchain(chainId); + (permRestriction, ) = _deployPermRestriction(bridgehub, L2_FACTORY_ADDR, owner); + restriction = new AccessControlRestriction(0, owner); + address[] memory restrictions = new address[](1); + restrictions[0] = address(restriction); + chainAdmin = new ChainAdmin(restrictions); + } + + function _deployPermRestriction( + IBridgehub _bridgehub, + address _l2AdminFactory, + address _owner + ) internal returns (PermanentRestriction proxy, PermanentRestriction impl) { + impl = new PermanentRestriction(_bridgehub, _l2AdminFactory); + TransparentUpgradeableProxy tup = new TransparentUpgradeableProxy( + address(impl), + address(uint160(1)), + abi.encodeCall(PermanentRestriction.initialize, (_owner)) + ); + + proxy = PermanentRestriction(address(tup)); + } + + function test_ownerAsAddressZero() public { + PermanentRestriction impl = new PermanentRestriction(bridgehub, L2_FACTORY_ADDR); + vm.expectRevert(ZeroAddress.selector); + new TransparentUpgradeableProxy( + address(impl), + address(uint160(1)), + abi.encodeCall(PermanentRestriction.initialize, (address(0))) + ); + } + + function test_allowAdminImplementation(bytes32 implementationHash) public { + vm.expectEmit(true, false, false, true); + emit IPermanentRestriction.AdminImplementationAllowed(implementationHash, true); + + vm.prank(owner); + permRestriction.allowAdminImplementation(implementationHash, true); + } + + function test_setAllowedData(bytes memory data) public { + vm.expectEmit(false, false, false, true); + emit IPermanentRestriction.AllowedDataChanged(data, true); + + vm.prank(owner); + permRestriction.setAllowedData(data, true); + } + + function test_setSelectorIsValidated(bytes4 selector) public { + vm.expectEmit(true, false, false, true); + emit IPermanentRestriction.SelectorValidationChanged(selector, true); + + vm.prank(owner); + permRestriction.setSelectorIsValidated(selector, true); + } + + function test_tryCompareAdminOfAChainIsAddressZero() public { + vm.expectRevert(ChainZeroAddress.selector); + permRestriction.tryCompareAdminOfAChain(address(0), owner); + } + + function test_tryCompareAdminOfAChainNotAHyperchain() public { + vm.expectRevert(); + permRestriction.tryCompareAdminOfAChain(makeAddr("random"), owner); + } + + function test_tryCompareAdminOfAChainNotAnAdmin() public { + vm.expectRevert(abi.encodeWithSelector(NotAnAdmin.selector, IZKChain(hyperchain).getAdmin(), owner)); + permRestriction.tryCompareAdminOfAChain(hyperchain, owner); + } + + function test_tryCompareAdminOfAChain() public { + permRestriction.tryCompareAdminOfAChain(hyperchain, newChainAdmin); + } + + function test_validateCallTooShortData() public { + Call memory call = Call({target: hyperchain, value: 0, data: ""}); + + vm.startPrank(newChainAdmin); + permRestriction.validateCall(call, owner); + vm.stopPrank(); + } + + function test_validateCallSetPendingAdminUnallowedImplementation() public { + Call memory call = Call({ + target: hyperchain, + value: 0, + data: abi.encodeWithSelector(IAdmin.setPendingAdmin.selector, owner) + }); + + vm.expectRevert(abi.encodeWithSelector(UnallowedImplementation.selector, owner.codehash)); + + vm.startPrank(newChainAdmin); + permRestriction.validateCall(call, owner); + vm.stopPrank(); + } + + function test_validateCallSetPendingAdminRemovingPermanentRestriction() public { + vm.prank(owner); + permRestriction.allowAdminImplementation(address(chainAdmin).codehash, true); + + Call memory call = Call({ + target: hyperchain, + value: 0, + data: abi.encodeWithSelector(IAdmin.setPendingAdmin.selector, address(chainAdmin)) + }); + + vm.expectRevert(RemovingPermanentRestriction.selector); + + vm.startPrank(newChainAdmin); + permRestriction.validateCall(call, owner); + vm.stopPrank(); + } + + function test_validateCallSetPendingAdmin() public { + vm.prank(owner); + permRestriction.allowAdminImplementation(address(chainAdmin).codehash, true); + + vm.prank(address(chainAdmin)); + chainAdmin.addRestriction(address(permRestriction)); + + Call memory call = Call({ + target: hyperchain, + value: 0, + data: abi.encodeWithSelector(IAdmin.setPendingAdmin.selector, address(chainAdmin)) + }); + + vm.startPrank(newChainAdmin); + permRestriction.validateCall(call, owner); + vm.stopPrank(); + } + + function test_validateCallNotValidatedSelector() public { + Call memory call = Call({ + target: hyperchain, + value: 0, + data: abi.encodeWithSelector(IAdmin.acceptAdmin.selector) + }); + + vm.startPrank(newChainAdmin); + permRestriction.validateCall(call, owner); + vm.stopPrank(); + } + + function test_validateCallCallNotAllowed() public { + vm.prank(owner); + permRestriction.setSelectorIsValidated(IAdmin.acceptAdmin.selector, true); + Call memory call = Call({ + target: hyperchain, + value: 0, + data: abi.encodeWithSelector(IAdmin.acceptAdmin.selector) + }); + + vm.expectRevert(abi.encodeWithSelector(CallNotAllowed.selector, call.data)); + + vm.startPrank(newChainAdmin); + permRestriction.validateCall(call, owner); + vm.stopPrank(); + } + + function test_validateCall() public { + vm.prank(owner); + permRestriction.setSelectorIsValidated(IAdmin.acceptAdmin.selector, true); + Call memory call = Call({ + target: hyperchain, + value: 0, + data: abi.encodeWithSelector(IAdmin.acceptAdmin.selector) + }); + + vm.prank(owner); + permRestriction.setAllowedData(call.data, true); + + vm.startPrank(newChainAdmin); + permRestriction.validateCall(call, owner); + vm.stopPrank(); + } + + function _encodeMigraationCall( + bool correctTarget, + bool correctSelector, + bool correctSecondBridge, + bool correctEncodingVersion, + bool correctAssetId, + address l2Admin + ) internal returns (Call memory call) { + if (!correctTarget) { + call.target = address(0); + return call; + } + call.target = address(bridgehub); + + if (!correctSelector) { + call.data = hex"00000000"; + return call; + } + + L2TransactionRequestTwoBridgesOuter memory outer = L2TransactionRequestTwoBridgesOuter({ + chainId: chainId, + mintValue: 0, + l2Value: 0, + l2GasLimit: 0, + l2GasPerPubdataByteLimit: 0, + refundRecipient: address(0), + secondBridgeAddress: address(0), + secondBridgeValue: 0, + secondBridgeCalldata: hex"" + }); + if (!correctSecondBridge) { + call.data = abi.encodeCall(Bridgehub.requestL2TransactionTwoBridges, (outer)); + // 0 is not correct second bridge + return call; + } + outer.secondBridgeAddress = sharedBridge; + + uint8 encoding = correctEncodingVersion ? 1 : 12; + + bytes32 chainAssetId = correctAssetId ? bridgehub.ctmAssetIdFromChainId(chainId) : bytes32(0); + + bytes memory bridgehubData = abi.encode( + BridgehubBurnCTMAssetData({ + // Gateway chain id, we do not need it + chainId: 0, + ctmData: abi.encode(l2Admin, hex""), + chainData: abi.encode(IZKChain(IBridgehub(bridgehub).getZKChain(chainId)).getProtocolVersion()) + }) + ); + outer.secondBridgeCalldata = abi.encodePacked(bytes1(encoding), abi.encode(chainAssetId, bridgehubData)); + + call.data = abi.encodeCall(Bridgehub.requestL2TransactionTwoBridges, (outer)); + } + + function test_tryGetNewAdminFromMigrationRevertWhenInvalidSelector() public { + Call memory call = _encodeMigraationCall(false, true, true, true, true, address(0)); + + vm.expectRevert(abi.encodeWithSelector(NotBridgehub.selector, address(0))); + permRestriction.tryGetNewAdminFromMigration(call); + } + + function test_tryGetNewAdminFromMigrationRevertWhenNotBridgehub() public { + Call memory call = _encodeMigraationCall(true, false, true, true, true, address(0)); + + vm.expectRevert(abi.encodeWithSelector(InvalidSelector.selector, bytes4(0))); + permRestriction.tryGetNewAdminFromMigration(call); + } + + function test_tryGetNewAdminFromMigrationRevertWhenNotSharedBridge() public { + Call memory call = _encodeMigraationCall(true, true, false, true, true, address(0)); + + vm.expectRevert(abi.encodeWithSelector(InvalidAddress.selector, address(sharedBridge), address(0))); + permRestriction.tryGetNewAdminFromMigration(call); + } + + function test_tryGetNewAdminFromMigrationRevertWhenIncorrectEncoding() public { + Call memory call = _encodeMigraationCall(true, true, true, false, true, address(0)); + + vm.expectRevert(abi.encodeWithSelector(UnsupportedEncodingVersion.selector)); + permRestriction.tryGetNewAdminFromMigration(call); + } + + function test_tryGetNewAdminFromMigrationRevertWhenIncorrectAssetId() public { + Call memory call = _encodeMigraationCall(true, true, true, true, false, address(0)); + + vm.expectRevert(abi.encodeWithSelector(ZeroAddress.selector)); + permRestriction.tryGetNewAdminFromMigration(call); + } + + function test_tryGetNewAdminFromMigrationShouldWorkCorrectly() public { + address l2Addr = makeAddr("l2Addr"); + Call memory call = _encodeMigraationCall(true, true, true, true, true, l2Addr); + + address result = permRestriction.tryGetNewAdminFromMigration(call); + assertEq(result, l2Addr); + } + + function test_validateMigrationToL2RevertNotAllowed() public { + Call memory call = _encodeMigraationCall(true, true, true, true, true, address(0)); + + vm.expectRevert(abi.encodeWithSelector(NotAllowed.selector, address(0))); + permRestriction.validateCall(call, owner); + } + + function test_validateMigrationToL2() public { + address expectedAddress = L2ContractHelper.computeCreate2Address( + L2_FACTORY_ADDR, + bytes32(0), + bytes32(0), + bytes32(0) + ); + + vm.expectEmit(true, false, false, true); + emit IPermanentRestriction.AllowL2Admin(expectedAddress); + permRestriction.allowL2Admin(bytes32(0), bytes32(0), bytes32(0)); + + Call memory call = _encodeMigraationCall(true, true, true, true, true, expectedAddress); + + // Should not fail + permRestriction.validateCall(call, owner); + } + + function test_validateNotEnoughGas() public { + address l2Addr = makeAddr("l2Addr"); + Call memory call = _encodeMigraationCall(true, true, true, true, true, l2Addr); + + vm.expectRevert(abi.encodeWithSelector(NotEnoughGas.selector)); + permRestriction.validateCall{gas: MIN_GAS_FOR_FALLABLE_CALL}(call, address(0)); + } + + function createNewChainBridgehub() internal { + bytes[] memory factoryDeps = new bytes[](0); + vm.stopPrank(); + vm.startPrank(governor); + bridgehub.addChainTypeManager(address(chainContractAddress)); + bridgehub.addTokenAssetId(DataEncoding.encodeNTVAssetId(block.chainid, baseToken)); + bridgehub.setAddresses(sharedBridge, ICTMDeploymentTracker(address(0)), new MessageRoot(bridgehub)); + vm.stopPrank(); + + // ctm deployer address is 0 in this test + vm.startPrank(address(0)); + bridgehub.setAssetHandlerAddress( + bytes32(uint256(uint160(address(chainContractAddress)))), + address(chainContractAddress) + ); + vm.stopPrank(); + + address l1Nullifier = makeAddr("l1Nullifier"); + vm.mockCall( + address(sharedBridge), + abi.encodeWithSelector(IL1AssetRouter.L1_NULLIFIER.selector), + abi.encode(l1Nullifier) + ); + vm.startPrank(governor); + bridgehub.createNewChain({ + _chainId: chainId, + _chainTypeManager: address(chainContractAddress), + _baseTokenAssetId: DataEncoding.encodeNTVAssetId(block.chainid, baseToken), + _salt: 0, + _admin: newChainAdmin, + _initData: getCTMInitData(), + _factoryDeps: factoryDeps + }); + vm.stopPrank(); + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/Governance/Reentrancy.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/Reentrancy.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Governance/Reentrancy.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Governance/Reentrancy.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Governance/SelfUpgrades.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/SelfUpgrades.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/Governance/SelfUpgrades.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Governance/SelfUpgrades.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/Governance/_Governance_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Governance/_Governance_Shared.t.sol similarity index 93% rename from l1-contracts/test/foundry/unit/concrete/Governance/_Governance_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Governance/_Governance_Shared.t.sol index e7f499254..2a34bc2ff 100644 --- a/l1-contracts/test/foundry/unit/concrete/Governance/_Governance_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Governance/_Governance_Shared.t.sol @@ -6,6 +6,7 @@ import {Test} from "forge-std/Test.sol"; import {Governance} from "contracts/governance/Governance.sol"; import {IGovernance} from "contracts/governance/IGovernance.sol"; +import {Call} from "contracts/governance/Common.sol"; import {EventOnFallback} from "contracts/dev-contracts/EventOnFallback.sol"; import {Forwarder} from "contracts/dev-contracts/Forwarder.sol"; import {RevertFallback} from "contracts/dev-contracts/RevertFallback.sol"; @@ -58,8 +59,8 @@ contract GovernanceTest is Test, EventOnFallback { uint256 _value, bytes memory _data ) internal pure returns (IGovernance.Operation memory) { - IGovernance.Call[] memory calls = new IGovernance.Call[](1); - calls[0] = IGovernance.Call({target: _target, value: _value, data: _data}); + Call[] memory calls = new Call[](1); + calls[0] = Call({target: _target, value: _value, data: _data}); return IGovernance.Operation({calls: calls, salt: bytes32(0), predecessor: bytes32(0)}); } diff --git a/l1-contracts/test/foundry/unit/concrete/Utils/Utils.sol b/l1-contracts/test/foundry/l1/unit/concrete/Utils/Utils.sol similarity index 90% rename from l1-contracts/test/foundry/unit/concrete/Utils/Utils.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Utils/Utils.sol index 111f7f8f8..8ab52c976 100644 --- a/l1-contracts/test/foundry/unit/concrete/Utils/Utils.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Utils/Utils.sol @@ -12,8 +12,8 @@ import {AdminFacet} from "contracts/state-transition/chain-deps/facets/Admin.sol import {ExecutorFacet} from "contracts/state-transition/chain-deps/facets/Executor.sol"; import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; import {MailboxFacet} from "contracts/state-transition/chain-deps/facets/Mailbox.sol"; -import {IVerifier, VerifierParams} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; -import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; +import {IVerifier, VerifierParams} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; +import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; import {InitializeData, InitializeDataNewChain} from "contracts/state-transition/chain-interfaces/IDiamondInit.sol"; import {IExecutor, SystemLogKey} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; import {L2CanonicalTransaction} from "contracts/common/Messaging.sol"; @@ -60,7 +60,7 @@ library Utils { } function createSystemLogs(bytes32 _outputHash) public returns (bytes[] memory) { - bytes[] memory logs = new bytes[](9); + bytes[] memory logs = new bytes[](7); logs[0] = constructL2Log( true, L2_TO_L1_MESSENGER, @@ -68,44 +68,37 @@ library Utils { bytes32("") ); logs[1] = constructL2Log( - true, - L2_TO_L1_MESSENGER, - uint256(SystemLogKey.TOTAL_L2_TO_L1_PUBDATA_KEY), - 0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563 - ); - logs[2] = constructL2Log(true, L2_TO_L1_MESSENGER, uint256(SystemLogKey.STATE_DIFF_HASH_KEY), bytes32("")); - logs[3] = constructL2Log( true, L2_SYSTEM_CONTEXT_ADDRESS, uint256(SystemLogKey.PACKED_BATCH_AND_L2_BLOCK_TIMESTAMP_KEY), bytes32("") ); - logs[4] = constructL2Log( + logs[2] = constructL2Log( true, L2_SYSTEM_CONTEXT_ADDRESS, uint256(SystemLogKey.PREV_BATCH_HASH_KEY), bytes32("") ); - logs[5] = constructL2Log( + logs[3] = constructL2Log( true, L2_BOOTLOADER_ADDRESS, uint256(SystemLogKey.CHAINED_PRIORITY_TXN_HASH_KEY), keccak256("") ); - logs[6] = constructL2Log( + logs[4] = constructL2Log( true, L2_BOOTLOADER_ADDRESS, uint256(SystemLogKey.NUMBER_OF_LAYER_1_TXS_KEY), bytes32("") ); - logs[7] = constructL2Log( + logs[5] = constructL2Log( true, L2_TO_L1_MESSENGER, uint256(SystemLogKey.L2_DA_VALIDATOR_OUTPUT_HASH_KEY), _outputHash ); - logs[8] = constructL2Log( + logs[6] = constructL2Log( true, L2_TO_L1_MESSENGER, uint256(SystemLogKey.USED_L2_DA_VALIDATOR_ADDRESS_KEY), @@ -162,17 +155,6 @@ library Utils { }); } - function createProofInput() public pure returns (IExecutor.ProofInput memory) { - uint256[] memory recursiveAggregationInput; - uint256[] memory serializedProof; - - return - IExecutor.ProofInput({ - recursiveAggregationInput: recursiveAggregationInput, - serializedProof: serializedProof - }); - } - function encodePacked(bytes[] memory data) public pure returns (bytes memory) { bytes memory result; for (uint256 i = 0; i < data.length; i++) { @@ -181,6 +163,40 @@ library Utils { return result; } + function encodeCommitBatchesData( + IExecutor.StoredBatchInfo memory _lastCommittedBatchData, + IExecutor.CommitBatchInfo[] memory _newBatchesData + ) internal pure returns (uint256, uint256, bytes memory) { + return ( + _newBatchesData[0].batchNumber, + _newBatchesData[_newBatchesData.length - 1].batchNumber, + bytes.concat(bytes1(0x00), abi.encode(_lastCommittedBatchData, _newBatchesData)) + ); + } + + function encodeProveBatchesData( + IExecutor.StoredBatchInfo memory _prevBatch, + IExecutor.StoredBatchInfo[] memory _committedBatches, + uint256[] memory _proof + ) internal pure returns (uint256, uint256, bytes memory) { + return ( + _committedBatches[0].batchNumber, + _committedBatches[_committedBatches.length - 1].batchNumber, + bytes.concat(bytes1(0x00), abi.encode(_prevBatch, _committedBatches, _proof)) + ); + } + + function encodeExecuteBatchesData( + IExecutor.StoredBatchInfo[] memory _batchesData, + PriorityOpsBatchInfo[] memory _priorityOpsData + ) internal pure returns (uint256, uint256, bytes memory) { + return ( + _batchesData[0].batchNumber, + _batchesData[_batchesData.length - 1].batchNumber, + bytes.concat(bytes1(0x00), abi.encode(_batchesData, _priorityOpsData)) + ); + } + function getAdminSelectors() public pure returns (bytes4[] memory) { bytes4[] memory selectors = new bytes4[](12); selectors[0] = AdminFacet.setPendingAdmin.selector; @@ -200,15 +216,15 @@ library Utils { function getExecutorSelectors() public pure returns (bytes4[] memory) { bytes4[] memory selectors = new bytes4[](4); - selectors[0] = ExecutorFacet.commitBatches.selector; - selectors[1] = ExecutorFacet.proveBatches.selector; - selectors[2] = ExecutorFacet.executeBatches.selector; - selectors[3] = ExecutorFacet.revertBatches.selector; + selectors[0] = ExecutorFacet.commitBatchesSharedBridge.selector; + selectors[1] = ExecutorFacet.proveBatchesSharedBridge.selector; + selectors[2] = ExecutorFacet.executeBatchesSharedBridge.selector; + selectors[3] = ExecutorFacet.revertBatchesSharedBridge.selector; return selectors; } function getGettersSelectors() public pure returns (bytes4[] memory) { - bytes4[] memory selectors = new bytes4[](30); + bytes4[] memory selectors = new bytes4[](31); selectors[0] = GettersFacet.getVerifier.selector; selectors[1] = GettersFacet.getAdmin.selector; selectors[2] = GettersFacet.getPendingAdmin.selector; @@ -238,11 +254,13 @@ library Utils { selectors[26] = GettersFacet.getTotalBatchesVerified.selector; selectors[27] = GettersFacet.getTotalBatchesExecuted.selector; selectors[28] = GettersFacet.getProtocolVersion.selector; + selectors[29] = GettersFacet.getPriorityTreeRoot.selector; + selectors[30] = GettersFacet.getChainId.selector; return selectors; } function getMailboxSelectors() public pure returns (bytes4[] memory) { - bytes4[] memory selectors = new bytes4[](8); + bytes4[] memory selectors = new bytes4[](7); selectors[0] = MailboxFacet.proveL2MessageInclusion.selector; selectors[1] = MailboxFacet.proveL2LogInclusion.selector; selectors[2] = MailboxFacet.proveL1ToL2TransactionStatus.selector; @@ -250,7 +268,6 @@ library Utils { selectors[4] = MailboxFacet.requestL2Transaction.selector; selectors[5] = MailboxFacet.bridgehubRequestL2Transaction.selector; selectors[6] = MailboxFacet.l2TransactionBaseCost.selector; - selectors[7] = MailboxFacet.transferEthToSharedBridge.selector; return selectors; } @@ -261,7 +278,7 @@ library Utils { selectors[2] = UtilsFacet.util_setBridgehub.selector; selectors[3] = UtilsFacet.util_getBridgehub.selector; selectors[4] = UtilsFacet.util_setBaseToken.selector; - selectors[5] = UtilsFacet.util_getBaseToken.selector; + selectors[5] = UtilsFacet.util_getBaseTokenAssetId.selector; selectors[6] = UtilsFacet.util_setBaseTokenBridge.selector; selectors[7] = UtilsFacet.util_getBaseTokenBridge.selector; selectors[8] = UtilsFacet.util_setVerifier.selector; @@ -282,8 +299,8 @@ library Utils { selectors[23] = UtilsFacet.util_getValidator.selector; selectors[24] = UtilsFacet.util_setZkPorterAvailability.selector; selectors[25] = UtilsFacet.util_getZkPorterAvailability.selector; - selectors[26] = UtilsFacet.util_setStateTransitionManager.selector; - selectors[27] = UtilsFacet.util_getStateTransitionManager.selector; + selectors[26] = UtilsFacet.util_setChainTypeManager.selector; + selectors[27] = UtilsFacet.util_getChainTypeManager.selector; selectors[28] = UtilsFacet.util_setPriorityTxMaxGasLimit.selector; selectors[29] = UtilsFacet.util_getPriorityTxMaxGasLimit.selector; selectors[30] = UtilsFacet.util_setFeeParams.selector; @@ -328,11 +345,11 @@ library Utils { InitializeData({ chainId: 1, bridgehub: address(dummyBridgehub), - stateTransitionManager: address(0x1234567890876543567890), + chainTypeManager: address(0x1234567890876543567890), protocolVersion: 0, admin: address(0x32149872498357874258787), validatorTimelock: address(0x85430237648403822345345), - baseToken: address(0x923645439232223445), + baseTokenAssetId: bytes32(uint256(0x923645439232223445)), baseTokenBridge: address(0x23746765237749923040872834), storedBatchZero: bytes32(0), verifier: makeVerifier(testnetVerifier), diff --git a/l1-contracts/test/foundry/unit/concrete/Utils/Utils.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Utils/Utils.t.sol similarity index 86% rename from l1-contracts/test/foundry/unit/concrete/Utils/Utils.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Utils/Utils.t.sol index ffa7770ca..0c9ad684f 100644 --- a/l1-contracts/test/foundry/unit/concrete/Utils/Utils.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Utils/Utils.t.sol @@ -45,7 +45,7 @@ contract UtilsTest is Test { function test_CreateSystemLogs() public { bytes[] memory logs = Utils.createSystemLogs(bytes32(0)); - assertEq(logs.length, 9, "logs length should be correct"); + assertEq(logs.length, 7, "logs length should be correct"); assertEq( logs[0], @@ -60,85 +60,68 @@ contract UtilsTest is Test { assertEq( logs[1], - Utils.constructL2Log( - true, - L2_TO_L1_MESSENGER, - uint256(SystemLogKey.TOTAL_L2_TO_L1_PUBDATA_KEY), - 0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563 - ), - "log[1] should be correct" - ); - - assertEq( - logs[2], - Utils.constructL2Log(true, L2_TO_L1_MESSENGER, uint256(SystemLogKey.STATE_DIFF_HASH_KEY), bytes32("")), - "log[2] should be correct" - ); - - assertEq( - logs[3], Utils.constructL2Log( true, L2_SYSTEM_CONTEXT_ADDRESS, uint256(SystemLogKey.PACKED_BATCH_AND_L2_BLOCK_TIMESTAMP_KEY), bytes32("") ), - "log[3] should be correct" + "log[1] should be correct" ); assertEq( - logs[4], + logs[2], Utils.constructL2Log( true, L2_SYSTEM_CONTEXT_ADDRESS, uint256(SystemLogKey.PREV_BATCH_HASH_KEY), bytes32("") ), - "log[4] should be correct" + "log[2] should be correct" ); assertEq( - logs[5], + logs[3], Utils.constructL2Log( true, L2_BOOTLOADER_ADDRESS, uint256(SystemLogKey.CHAINED_PRIORITY_TXN_HASH_KEY), keccak256("") ), - "log[5] should be correct" + "log[3] should be correct" ); assertEq( - logs[6], + logs[4], Utils.constructL2Log( true, L2_BOOTLOADER_ADDRESS, uint256(SystemLogKey.NUMBER_OF_LAYER_1_TXS_KEY), bytes32("") ), - "log[6] should be correct" + "log[4] should be correct" ); assertEq( - logs[7], + logs[5], Utils.constructL2Log( true, L2_TO_L1_MESSENGER, uint256(SystemLogKey.L2_DA_VALIDATOR_OUTPUT_HASH_KEY), bytes32(0) ), - "log[7] should be correct" + "log[5] should be correct" ); assertEq( - logs[8], + logs[6], Utils.constructL2Log( true, L2_TO_L1_MESSENGER, uint256(SystemLogKey.USED_L2_DA_VALIDATOR_ADDRESS_KEY), bytes32(uint256(uint160(L2_DA_VALIDATOR_ADDRESS))) ), - "log[8] should be correct" + "log[6] should be correct" ); } diff --git a/l1-contracts/test/foundry/unit/concrete/Utils/UtilsFacet.sol b/l1-contracts/test/foundry/l1/unit/concrete/Utils/UtilsFacet.sol similarity index 88% rename from l1-contracts/test/foundry/unit/concrete/Utils/UtilsFacet.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Utils/UtilsFacet.sol index ce9e659a0..0d141ce1f 100644 --- a/l1-contracts/test/foundry/unit/concrete/Utils/UtilsFacet.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Utils/UtilsFacet.sol @@ -2,12 +2,12 @@ pragma solidity 0.8.24; -import {IVerifier, VerifierParams} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; -import {FeeParams} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; -import {ZkSyncHyperchainBase} from "contracts/state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol"; +import {IVerifier, VerifierParams} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; +import {FeeParams} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; +import {ZKChainBase} from "contracts/state-transition/chain-deps/facets/ZKChainBase.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; -contract UtilsFacet is ZkSyncHyperchainBase { +contract UtilsFacet is ZKChainBase { function util_setChainId(uint256 _chainId) external { s.chainId = _chainId; } @@ -24,12 +24,12 @@ contract UtilsFacet is ZkSyncHyperchainBase { return s.bridgehub; } - function util_setBaseToken(address _baseToken) external { - s.baseToken = _baseToken; + function util_setBaseToken(bytes32 _baseTokenAssetId) external { + s.baseTokenAssetId = _baseTokenAssetId; } - function util_getBaseToken() external view returns (address) { - return s.baseToken; + function util_getBaseTokenAssetId() external view returns (bytes32) { + return s.baseTokenAssetId; } function util_setBaseTokenBridge(address _baseTokenBridge) external { @@ -120,12 +120,12 @@ contract UtilsFacet is ZkSyncHyperchainBase { return s.zkPorterIsAvailable; } - function util_setStateTransitionManager(address _stateTransitionManager) external { - s.stateTransitionManager = _stateTransitionManager; + function util_setChainTypeManager(address _chainTypeManager) external { + s.chainTypeManager = _chainTypeManager; } - function util_getStateTransitionManager() external view returns (address) { - return s.stateTransitionManager; + function util_getChainTypeManager() external view returns (address) { + return s.chainTypeManager; } function util_setPriorityTxMaxGasLimit(uint256 _priorityTxMaxGasLimit) external { diff --git a/l1-contracts/test/foundry/unit/concrete/ValidatorTimelock/ValidatorTimelock.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/ValidatorTimelock/ValidatorTimelock.t.sol similarity index 56% rename from l1-contracts/test/foundry/unit/concrete/ValidatorTimelock/ValidatorTimelock.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/ValidatorTimelock/ValidatorTimelock.t.sol index c4e815096..3725f54e2 100644 --- a/l1-contracts/test/foundry/unit/concrete/ValidatorTimelock/ValidatorTimelock.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/ValidatorTimelock/ValidatorTimelock.t.sol @@ -4,8 +4,8 @@ pragma solidity 0.8.24; import {Test} from "forge-std/Test.sol"; import {Utils} from "../Utils/Utils.sol"; import {ValidatorTimelock, IExecutor} from "contracts/state-transition/ValidatorTimelock.sol"; -import {DummyStateTransitionManagerForValidatorTimelock} from "contracts/dev-contracts/test/DummyStateTransitionManagerForValidatorTimelock.sol"; -import {IStateTransitionManager} from "contracts/state-transition/IStateTransitionManager.sol"; +import {DummyChainTypeManagerForValidatorTimelock} from "contracts/dev-contracts/test/DummyChainTypeManagerForValidatorTimelock.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; import {Unauthorized, TimeNotReached} from "contracts/common/L1ContractErrors.sol"; contract ValidatorTimelockTest is Test { @@ -22,7 +22,7 @@ contract ValidatorTimelockTest is Test { error ValidatorDoesNotExist(uint256 _chainId); ValidatorTimelock validator; - DummyStateTransitionManagerForValidatorTimelock stateTransitionManager; + DummyChainTypeManagerForValidatorTimelock chainTypeManager; address owner; address zkSync; @@ -45,10 +45,10 @@ contract ValidatorTimelockTest is Test { lastBatchNumber = 123; executionDelay = 10; - stateTransitionManager = new DummyStateTransitionManagerForValidatorTimelock(owner, zkSync); + chainTypeManager = new DummyChainTypeManagerForValidatorTimelock(owner, zkSync); validator = new ValidatorTimelock(owner, executionDelay, eraChainId); vm.prank(owner); - validator.setStateTransitionManager(IStateTransitionManager(address(stateTransitionManager))); + validator.setChainTypeManager(IChainTypeManager(address(chainTypeManager))); vm.prank(owner); validator.addValidator(chainId, alice); vm.prank(owner); @@ -92,20 +92,24 @@ contract ValidatorTimelockTest is Test { batchesToCommit[0] = batchToCommit; vm.prank(alice); - validator.commitBatchesSharedBridge(chainId, storedBatch, batchesToCommit); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + storedBatch, + batchesToCommit + ); + validator.commitBatchesSharedBridge(chainId, commitBatchFrom, commitBatchTo, commitData); } - function test_setStateTransitionManager() public { - assert(validator.stateTransitionManager() == IStateTransitionManager(address(stateTransitionManager))); + function test_setChainTypeManager() public { + assert(validator.chainTypeManager() == IChainTypeManager(address(chainTypeManager))); - DummyStateTransitionManagerForValidatorTimelock newManager = new DummyStateTransitionManagerForValidatorTimelock( - bob, - zkSync - ); + DummyChainTypeManagerForValidatorTimelock newManager = new DummyChainTypeManagerForValidatorTimelock( + bob, + zkSync + ); vm.prank(owner); - validator.setStateTransitionManager(IStateTransitionManager(address(newManager))); + validator.setChainTypeManager(IChainTypeManager(address(newManager))); - assert(validator.stateTransitionManager() == IStateTransitionManager(address(newManager))); + assert(validator.chainTypeManager() == IChainTypeManager(address(newManager))); } function test_setExecutionDelay() public { @@ -126,7 +130,11 @@ contract ValidatorTimelockTest is Test { uint64 timestamp = 123456; vm.warp(timestamp); - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.commitBatches.selector), abi.encode(eraChainId)); + vm.mockCall( + zkSync, + abi.encodeWithSelector(IExecutor.commitBatchesSharedBridge.selector), + abi.encode(eraChainId) + ); IExecutor.StoredBatchInfo memory storedBatch = Utils.createStoredBatchInfo(); IExecutor.CommitBatchInfo memory batchToCommit = Utils.createCommitBatchInfo(); @@ -135,14 +143,18 @@ contract ValidatorTimelockTest is Test { IExecutor.CommitBatchInfo[] memory batchesToCommit = new IExecutor.CommitBatchInfo[](1); batchesToCommit[0] = batchToCommit; - vm.prank(dan); - validator.commitBatches(storedBatch, batchesToCommit); + vm.prank(alice); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + storedBatch, + batchesToCommit + ); + validator.commitBatchesSharedBridge(chainId, commitBatchFrom, commitBatchTo, commitData); - assert(validator.getCommittedBatchTimestamp(eraChainId, batchNumber) == timestamp); + assert(validator.getCommittedBatchTimestamp(chainId, batchNumber) == timestamp); } function test_commitBatches() public { - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.commitBatches.selector), abi.encode(chainId)); + vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.commitBatchesSharedBridge.selector), abi.encode(chainId)); IExecutor.StoredBatchInfo memory storedBatch = Utils.createStoredBatchInfo(); IExecutor.CommitBatchInfo memory batchToCommit = Utils.createCommitBatchInfo(); @@ -150,93 +162,48 @@ contract ValidatorTimelockTest is Test { IExecutor.CommitBatchInfo[] memory batchesToCommit = new IExecutor.CommitBatchInfo[](1); batchesToCommit[0] = batchToCommit; - vm.prank(dan); - validator.commitBatches(storedBatch, batchesToCommit); - } - - function test_revertBatches() public { - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.revertBatches.selector), abi.encode(lastBatchNumber)); - - vm.prank(dan); - validator.revertBatches(lastBatchNumber); + vm.prank(alice); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + storedBatch, + batchesToCommit + ); + validator.commitBatchesSharedBridge(chainId, commitBatchFrom, commitBatchTo, commitData); } function test_revertBatchesSharedBridge() public { - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.revertBatches.selector), abi.encode(chainId)); + vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.revertBatchesSharedBridge.selector), abi.encode(chainId)); vm.prank(alice); validator.revertBatchesSharedBridge(chainId, lastBatchNumber); } - function test_proveBatches() public { - IExecutor.StoredBatchInfo memory prevBatch = Utils.createStoredBatchInfo(); - IExecutor.StoredBatchInfo memory batchToProve = Utils.createStoredBatchInfo(); - IExecutor.ProofInput memory proof = Utils.createProofInput(); - - IExecutor.StoredBatchInfo[] memory batchesToProve = new IExecutor.StoredBatchInfo[](1); - batchesToProve[0] = batchToProve; - - vm.mockCall( - zkSync, - abi.encodeWithSelector(IExecutor.proveBatches.selector), - abi.encode(prevBatch, batchesToProve, proof) - ); - vm.prank(dan); - validator.proveBatches(prevBatch, batchesToProve, proof); - } - function test_proveBatchesSharedBridge() public { IExecutor.StoredBatchInfo memory prevBatch = Utils.createStoredBatchInfo(); IExecutor.StoredBatchInfo memory batchToProve = Utils.createStoredBatchInfo(); - IExecutor.ProofInput memory proof = Utils.createProofInput(); + uint256[] memory proof = new uint256[](0); IExecutor.StoredBatchInfo[] memory batchesToProve = new IExecutor.StoredBatchInfo[](1); batchesToProve[0] = batchToProve; vm.mockCall( zkSync, - abi.encodeWithSelector(IExecutor.proveBatches.selector), + abi.encodeWithSelector(IExecutor.proveBatchesSharedBridge.selector), abi.encode(chainId, prevBatch, batchesToProve, proof) ); vm.prank(alice); - validator.proveBatchesSharedBridge(chainId, prevBatch, batchesToProve, proof); - } - - function test_executeBatches() public { - uint64 timestamp = 123456; - uint64 batchNumber = 123; - // Commit batches first to have the valid timestamp - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.commitBatches.selector), abi.encode(chainId)); - - IExecutor.StoredBatchInfo memory storedBatch1 = Utils.createStoredBatchInfo(); - IExecutor.CommitBatchInfo memory batchToCommit = Utils.createCommitBatchInfo(); - - batchToCommit.batchNumber = batchNumber; - IExecutor.CommitBatchInfo[] memory batchesToCommit = new IExecutor.CommitBatchInfo[](1); - batchesToCommit[0] = batchToCommit; - - vm.prank(dan); - vm.warp(timestamp); - validator.commitBatches(storedBatch1, batchesToCommit); - - // Execute batches - IExecutor.StoredBatchInfo memory storedBatch2 = Utils.createStoredBatchInfo(); - storedBatch2.batchNumber = batchNumber; - IExecutor.StoredBatchInfo[] memory storedBatches = new IExecutor.StoredBatchInfo[](1); - storedBatches[0] = storedBatch2; - - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.proveBatches.selector), abi.encode(storedBatches)); - - vm.prank(dan); - vm.warp(timestamp + executionDelay + 1); - validator.executeBatches(storedBatches, Utils.emptyData()); + (uint256 proveBatchFrom, uint256 proveBatchTo, bytes memory proveData) = Utils.encodeProveBatchesData( + prevBatch, + batchesToProve, + proof + ); + validator.proveBatchesSharedBridge(chainId, proveBatchFrom, proveBatchTo, proveData); } function test_executeBatchesSharedBridge() public { uint64 timestamp = 123456; uint64 batchNumber = 123; // Commit batches first to have the valid timestamp - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.commitBatches.selector), abi.encode(chainId)); + vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.commitBatchesSharedBridge.selector), abi.encode(chainId)); IExecutor.StoredBatchInfo memory storedBatch1 = Utils.createStoredBatchInfo(); IExecutor.CommitBatchInfo memory batchToCommit = Utils.createCommitBatchInfo(); @@ -247,7 +214,11 @@ contract ValidatorTimelockTest is Test { vm.prank(alice); vm.warp(timestamp); - validator.commitBatchesSharedBridge(chainId, storedBatch1, batchesToCommit); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + storedBatch1, + batchesToCommit + ); + validator.commitBatchesSharedBridge(chainId, commitBatchFrom, commitBatchTo, commitData); // Execute batches IExecutor.StoredBatchInfo memory storedBatch2 = Utils.createStoredBatchInfo(); @@ -255,11 +226,19 @@ contract ValidatorTimelockTest is Test { IExecutor.StoredBatchInfo[] memory storedBatches = new IExecutor.StoredBatchInfo[](1); storedBatches[0] = storedBatch2; - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.proveBatches.selector), abi.encode(storedBatches)); + vm.mockCall( + zkSync, + abi.encodeWithSelector(IExecutor.proveBatchesSharedBridge.selector), + abi.encode(storedBatches) + ); vm.prank(alice); vm.warp(timestamp + executionDelay + 1); - validator.executeBatchesSharedBridge(chainId, storedBatches, Utils.emptyData()); + (uint256 executeBatchFrom, uint256 executeBatchTo, bytes memory executeData) = Utils.encodeExecuteBatchesData( + storedBatches, + Utils.emptyData() + ); + validator.executeBatchesSharedBridge(chainId, executeBatchFrom, executeBatchTo, executeData); } function test_RevertWhen_setExecutionDelayNotOwner() public { @@ -311,17 +290,21 @@ contract ValidatorTimelockTest is Test { vm.prank(bob); vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, bob)); - validator.commitBatches(storedBatch, batchesToCommit); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + storedBatch, + batchesToCommit + ); + validator.commitBatchesSharedBridge(chainId, commitBatchFrom, commitBatchTo, commitData); } - function test_RevertWhen_setStateTransitionManagerNotOwner() public { + function test_RevertWhen_setChainTypeManagerNotOwner() public { vm.expectRevert("Ownable: caller is not the owner"); - validator.setStateTransitionManager(IStateTransitionManager(address(stateTransitionManager))); + validator.setChainTypeManager(IChainTypeManager(address(chainTypeManager))); } function test_RevertWhen_revertBatchesNotValidator() public { vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, address(this))); - validator.revertBatches(lastBatchNumber); + validator.revertBatchesSharedBridge(uint256(0), lastBatchNumber); } function test_RevertWhen_revertBatchesSharedBridgeNotValidator() public { @@ -329,45 +312,22 @@ contract ValidatorTimelockTest is Test { validator.revertBatchesSharedBridge(chainId, lastBatchNumber); } - function test_RevertWhen_proveBatchesNotValidator() public { - IExecutor.StoredBatchInfo memory prevBatch = Utils.createStoredBatchInfo(); - IExecutor.StoredBatchInfo memory batchToProve = Utils.createStoredBatchInfo(); - IExecutor.ProofInput memory proof = Utils.createProofInput(); - - IExecutor.StoredBatchInfo[] memory batchesToProve = new IExecutor.StoredBatchInfo[](1); - batchesToProve[0] = batchToProve; - - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, address(this))); - validator.proveBatches(prevBatch, batchesToProve, proof); - } - function test_RevertWhen_proveBatchesSharedBridgeNotValidator() public { IExecutor.StoredBatchInfo memory prevBatch = Utils.createStoredBatchInfo(); IExecutor.StoredBatchInfo memory batchToProve = Utils.createStoredBatchInfo(); - IExecutor.ProofInput memory proof = Utils.createProofInput(); + uint256[] memory proof = new uint256[](0); IExecutor.StoredBatchInfo[] memory batchesToProve = new IExecutor.StoredBatchInfo[](1); batchesToProve[0] = batchToProve; vm.prank(bob); vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, bob)); - validator.proveBatchesSharedBridge(chainId, prevBatch, batchesToProve, proof); - } - - function test_RevertWhen_executeBatchesNotValidator() public { - IExecutor.StoredBatchInfo memory storedBatch = Utils.createStoredBatchInfo(); - - IExecutor.StoredBatchInfo[] memory storedBatches = new IExecutor.StoredBatchInfo[](1); - storedBatches[0] = storedBatch; - - vm.prank(bob); -<<<<<<< HEAD - vm.expectRevert("ValidatorTimelock: only validator"); - validator.executeBatches(storedBatches, Utils.emptyData()); -======= - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, bob)); - validator.executeBatches(storedBatches); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + (uint256 proveBatchFrom, uint256 proveBatchTo, bytes memory proveData) = Utils.encodeProveBatchesData( + prevBatch, + batchesToProve, + proof + ); + validator.proveBatchesSharedBridge(chainId, proveBatchFrom, proveBatchTo, proveData); } function test_RevertWhen_executeBatchesSharedBridgeNotValidator() public { @@ -377,56 +337,19 @@ contract ValidatorTimelockTest is Test { storedBatches[0] = storedBatch; vm.prank(bob); -<<<<<<< HEAD - vm.expectRevert("ValidatorTimelock: only validator"); - validator.executeBatchesSharedBridge(chainId, storedBatches, Utils.emptyData()); -======= vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, bob)); - validator.executeBatchesSharedBridge(chainId, storedBatches); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - } - - function test_RevertWhen_executeBatchesTooEarly() public { - uint64 timestamp = 123456; - uint64 batchNumber = 123; - // Prove batches first to have the valid timestamp - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.commitBatches.selector), abi.encode(chainId)); - - IExecutor.StoredBatchInfo memory storedBatch1 = Utils.createStoredBatchInfo(); - IExecutor.CommitBatchInfo memory batchToCommit = Utils.createCommitBatchInfo(); - - batchToCommit.batchNumber = batchNumber; - IExecutor.CommitBatchInfo[] memory batchesToCommit = new IExecutor.CommitBatchInfo[](1); - batchesToCommit[0] = batchToCommit; - - vm.prank(dan); - vm.warp(timestamp); - validator.commitBatches(storedBatch1, batchesToCommit); - - // Execute batches - IExecutor.StoredBatchInfo memory storedBatch2 = Utils.createStoredBatchInfo(); - storedBatch2.batchNumber = batchNumber; - IExecutor.StoredBatchInfo[] memory storedBatches = new IExecutor.StoredBatchInfo[](1); - storedBatches[0] = storedBatch2; - - vm.prank(dan); - vm.warp(timestamp + executionDelay - 1); -<<<<<<< HEAD - vm.expectRevert(bytes("5c")); - validator.executeBatches(storedBatches, Utils.emptyData()); -======= - vm.expectRevert( - abi.encodeWithSelector(TimeNotReached.selector, timestamp + executionDelay, timestamp + executionDelay - 1) + (uint256 executeBatchFrom, uint256 executeBatchTo, bytes memory executeData) = Utils.encodeExecuteBatchesData( + storedBatches, + Utils.emptyData() ); - validator.executeBatches(storedBatches); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + validator.executeBatchesSharedBridge(chainId, executeBatchFrom, executeBatchTo, executeData); } function test_RevertWhen_executeBatchesSharedBridgeTooEarly() public { uint64 timestamp = 123456; uint64 batchNumber = 123; // Prove batches first to have the valid timestamp - vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.commitBatches.selector), abi.encode(chainId)); + vm.mockCall(zkSync, abi.encodeWithSelector(IExecutor.commitBatchesSharedBridge.selector), abi.encode(chainId)); IExecutor.StoredBatchInfo memory storedBatch1 = Utils.createStoredBatchInfo(); IExecutor.CommitBatchInfo memory batchToCommit = Utils.createCommitBatchInfo(); @@ -437,7 +360,11 @@ contract ValidatorTimelockTest is Test { vm.prank(alice); vm.warp(timestamp); - validator.commitBatchesSharedBridge(chainId, storedBatch1, batchesToCommit); + (uint256 commitBatchFrom, uint256 commitBatchTo, bytes memory commitData) = Utils.encodeCommitBatchesData( + storedBatch1, + batchesToCommit + ); + validator.commitBatchesSharedBridge(chainId, commitBatchFrom, commitBatchTo, commitData); // Execute batches IExecutor.StoredBatchInfo memory storedBatch2 = Utils.createStoredBatchInfo(); @@ -447,14 +374,13 @@ contract ValidatorTimelockTest is Test { vm.prank(alice); vm.warp(timestamp + executionDelay - 1); -<<<<<<< HEAD - vm.expectRevert(bytes("5c")); - validator.executeBatchesSharedBridge(chainId, storedBatches, Utils.emptyData()); -======= vm.expectRevert( abi.encodeWithSelector(TimeNotReached.selector, timestamp + executionDelay, timestamp + executionDelay - 1) ); - validator.executeBatchesSharedBridge(chainId, storedBatches); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + (uint256 executeBatchFrom, uint256 executeBatchTo, bytes memory executeData) = Utils.encodeExecuteBatchesData( + storedBatches, + Utils.emptyData() + ); + validator.executeBatchesSharedBridge(chainId, executeBatchFrom, executeBatchTo, executeData); } } diff --git a/l1-contracts/test/foundry/unit/concrete/Verifier/Verifier.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Verifier/Verifier.t.sol similarity index 90% rename from l1-contracts/test/foundry/unit/concrete/Verifier/Verifier.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/Verifier/Verifier.t.sol index 54ab49974..bd67cfa2b 100644 --- a/l1-contracts/test/foundry/unit/concrete/Verifier/Verifier.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/Verifier/Verifier.t.sol @@ -12,7 +12,6 @@ contract VerifierTestTest is Test { uint256[] public publicInputs; uint256[] public serializedProof; - uint256[] public recursiveAggregationInput; Verifier public verifier; @@ -68,7 +67,7 @@ contract VerifierTestTest is Test { } function testShouldVerify() public view { - bool success = verifier.verify(publicInputs, serializedProof, recursiveAggregationInput); + bool success = verifier.verify(publicInputs, serializedProof); assert(success); } @@ -76,7 +75,7 @@ contract VerifierTestTest is Test { uint256[] memory newPublicInputs = publicInputs; newPublicInputs[0] += uint256(bytes32(0xe000000000000000000000000000000000000000000000000000000000000000)); - bool success = verifier.verify(newPublicInputs, serializedProof, recursiveAggregationInput); + bool success = verifier.verify(newPublicInputs, serializedProof); assert(success); } @@ -86,7 +85,7 @@ contract VerifierTestTest is Test { newSerializedProof[1] += Q_MOD; newSerializedProof[1] += Q_MOD; - bool success = verifier.verify(publicInputs, newSerializedProof, recursiveAggregationInput); + bool success = verifier.verify(publicInputs, newSerializedProof); assert(success); } @@ -94,7 +93,7 @@ contract VerifierTestTest is Test { uint256[] memory newSerializedProof = serializedProof; newSerializedProof[22] += R_MOD; - bool success = verifier.verify(publicInputs, newSerializedProof, recursiveAggregationInput); + bool success = verifier.verify(publicInputs, newSerializedProof); assert(success); } @@ -104,14 +103,14 @@ contract VerifierTestTest is Test { newPublicInputs[1] = publicInputs[0]; vm.expectRevert(bytes("loadProof: Proof is invalid")); - verifier.verify(newPublicInputs, serializedProof, recursiveAggregationInput); + verifier.verify(newPublicInputs, serializedProof); } function testEmptyPublicInput_shouldRevert() public { uint256[] memory newPublicInputs; vm.expectRevert(bytes("loadProof: Proof is invalid")); - verifier.verify(newPublicInputs, serializedProof, recursiveAggregationInput); + verifier.verify(newPublicInputs, serializedProof); } function testMoreThan44WordsProof_shouldRevert() public { @@ -123,21 +122,25 @@ contract VerifierTestTest is Test { newSerializedProof[newSerializedProof.length - 1] = serializedProof[serializedProof.length - 1]; vm.expectRevert(bytes("loadProof: Proof is invalid")); - verifier.verify(publicInputs, newSerializedProof, recursiveAggregationInput); + verifier.verify(publicInputs, newSerializedProof); } function testEmptyProof_shouldRevert() public { uint256[] memory newSerializedProof; vm.expectRevert(bytes("loadProof: Proof is invalid")); - verifier.verify(publicInputs, newSerializedProof, recursiveAggregationInput); + verifier.verify(publicInputs, newSerializedProof); } - function testNotEmptyRecursiveAggregationInput_shouldRevert() public { - uint256[] memory newRecursiveAggregationInput = publicInputs; + function testLongerProofInput_shouldRevert() public { + uint256[] memory newSerializedProof = new uint256[](serializedProof.length + 1); + for (uint256 i = 0; i < serializedProof.length; i++) { + newSerializedProof[i] = serializedProof[i]; + } + newSerializedProof[newSerializedProof.length - 1] = publicInputs[0]; vm.expectRevert(bytes("loadProof: Proof is invalid")); - verifier.verify(publicInputs, serializedProof, newRecursiveAggregationInput); + verifier.verify(publicInputs, newSerializedProof); } function testEllipticCurvePointAtInfinity_shouldRevert() public { @@ -146,7 +149,7 @@ contract VerifierTestTest is Test { newSerializedProof[1] = 0; vm.expectRevert(bytes("loadProof: Proof is invalid")); - verifier.verify(publicInputs, newSerializedProof, recursiveAggregationInput); + verifier.verify(publicInputs, newSerializedProof); } function testInvalidPublicInput_shouldRevert() public { @@ -154,7 +157,7 @@ contract VerifierTestTest is Test { newPublicInputs[0] = 0; vm.expectRevert(bytes("invalid quotient evaluation")); - verifier.verify(newPublicInputs, serializedProof, recursiveAggregationInput); + verifier.verify(newPublicInputs, serializedProof); } function testVerificationKeyHash() public virtual { diff --git a/l1-contracts/test/foundry/l1/unit/concrete/Verifier/VerifierRecursive.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/Verifier/VerifierRecursive.t.sol new file mode 100644 index 000000000..c23759f35 --- /dev/null +++ b/l1-contracts/test/foundry/l1/unit/concrete/Verifier/VerifierRecursive.t.sol @@ -0,0 +1,56 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {VerifierTestTest} from "./Verifier.t.sol"; +import {VerifierRecursiveTest} from "contracts/dev-contracts/test/VerifierRecursiveTest.sol"; + +contract VerifierRecursiveTestTest is VerifierTestTest { + function setUp() public override { + super.setUp(); + + serializedProof.push(2257920826825449939414463854743099397427742128922725774525544832270890253504); + serializedProof.push(9091218701914748532331969127001446391756173432977615061129552313204917562530); + serializedProof.push(16188304989094043810949359833767911976672882599560690320245309499206765021563); + serializedProof.push(3201093556796962656759050531176732990872300033146738631772984017549903765305); + + verifier = new VerifierRecursiveTest(); + } + + function testMoreThan4WordsRecursiveInput_shouldRevert() public { + uint256[] memory newSerializedProof = new uint256[](serializedProof.length + 1); + + for (uint256 i = 0; i < serializedProof.length; i++) { + newSerializedProof[i] = serializedProof[i]; + } + newSerializedProof[newSerializedProof.length - 1] = serializedProof[serializedProof.length - 1]; + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testEmptyRecursiveInput_shouldRevert() public { + uint256[] memory newSerializedProof = new uint256[](serializedProof.length - 4); + for (uint256 i = 0; i < newSerializedProof.length; i++) { + newSerializedProof[i] = serializedProof[i]; + } + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testInvalidRecursiveInput_shouldRevert() public { + uint256[] memory newSerializedProof = serializedProof; + newSerializedProof[newSerializedProof.length - 4] = 1; + newSerializedProof[newSerializedProof.length - 3] = 2; + newSerializedProof[newSerializedProof.length - 2] = 1; + newSerializedProof[newSerializedProof.length - 1] = 2; + + vm.expectRevert(bytes("finalPairing: pairing failure")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testVerificationKeyHash() public override { + bytes32 verificationKeyHash = verifier.verificationKeyHash(); + assertEq(verificationKeyHash, 0x88b3ddc4ed85974c7e14297dcad4097169440305c05fdb6441ca8dfd77cd7fa7); + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/PushNewLeaf.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/PushNewLeaf.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/PushNewLeaf.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/PushNewLeaf.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/Root.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/Root.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/Root.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/Root.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/Setup.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/Setup.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/Setup.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/Setup.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/UpdateAllLeaves.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/UpdateAllLeaves.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/UpdateAllLeaves.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/UpdateAllLeaves.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/UpdateAllNodesAtHeight.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/UpdateAllNodesAtHeight.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/UpdateAllNodesAtHeight.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/UpdateAllNodesAtHeight.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/UpdateLeaf.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/UpdateLeaf.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/UpdateLeaf.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/UpdateLeaf.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/_FullMerkle_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/_FullMerkle_Shared.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/FullMerkle/_FullMerkle_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/FullMerkle/_FullMerkle_Shared.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/IncrementalMerkle/IncrementalMerkle.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/IncrementalMerkle/IncrementalMerkle.t.sol similarity index 65% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/IncrementalMerkle/IncrementalMerkle.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/IncrementalMerkle/IncrementalMerkle.t.sol index 9d91647c1..bb7fe7090 100644 --- a/l1-contracts/test/foundry/unit/concrete/common/libraries/IncrementalMerkle/IncrementalMerkle.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/IncrementalMerkle/IncrementalMerkle.t.sol @@ -72,46 +72,4 @@ contract IncrementalMerkleTestTest is Test { merkleTest.push(elements[i]); } } - - // function testElements(uint256 i) public { - // vm.assume(i < elements.length); - // bytes32 leaf = elements[i]; - // bytes32[] memory proof = merkleTree.getProof(elements, i); - - // bytes32 rootFromContract = merkleTest.calculateRoot(proof, i, leaf); - - // assertEq(rootFromContract, root); - // } - - // function testFirstElement() public { - // testElements(0); - // } - - // function testLastElement() public { - // testElements(elements.length - 1); - // } - - // function testEmptyProof_shouldRevert() public { - // bytes32 leaf = elements[0]; - // bytes32[] memory proof; - - // vm.expectRevert(bytes("xc")); - // merkleTest.calculateRoot(proof, 0, leaf); - // } - - // function testLeafIndexTooBig_shouldRevert() public { - // bytes32 leaf = elements[0]; - // bytes32[] memory proof = merkleTree.getProof(elements, 0); - - // vm.expectRevert(bytes("px")); - // merkleTest.calculateRoot(proof, 2 ** 255, leaf); - // } - - // function testProofLengthTooLarge_shouldRevert() public { - // bytes32 leaf = elements[0]; - // bytes32[] memory proof = new bytes32[](256); - - // vm.expectRevert(bytes("bt")); - // merkleTest.calculateRoot(proof, 0, leaf); - // } } diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/Merkle/Merkle.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/Merkle/Merkle.t.sol similarity index 93% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/Merkle/Merkle.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/Merkle/Merkle.t.sol index b6e6f3f84..88e8c8efa 100644 --- a/l1-contracts/test/foundry/unit/concrete/common/libraries/Merkle/Merkle.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/Merkle/Merkle.t.sol @@ -4,6 +4,7 @@ pragma solidity 0.8.24; import {Test} from "forge-std/Test.sol"; import {MerkleTest} from "contracts/dev-contracts/test/MerkleTest.sol"; import {MerkleTreeNoSort} from "./MerkleTreeNoSort.sol"; +import {MerklePathEmpty, MerkleIndexOutOfBounds, MerklePathOutOfBounds} from "contracts/common/L1ContractErrors.sol"; contract MerkleTestTest is Test { MerkleTreeNoSort merkleTree; @@ -60,7 +61,7 @@ contract MerkleTestTest is Test { bytes32 leaf = elements[0]; bytes32[] memory proof; - vm.expectRevert(bytes("xc")); + vm.expectRevert(MerklePathEmpty.selector); merkleTest.calculateRoot(proof, 0, leaf); } @@ -68,7 +69,7 @@ contract MerkleTestTest is Test { bytes32 leaf = elements[0]; bytes32[] memory proof = merkleTree.getProof(elements, 0); - vm.expectRevert(bytes("px")); + vm.expectRevert(MerkleIndexOutOfBounds.selector); merkleTest.calculateRoot(proof, 2 ** 255, leaf); } @@ -76,7 +77,7 @@ contract MerkleTestTest is Test { bytes32 leaf = elements[0]; bytes32[] memory proof = new bytes32[](256); - vm.expectRevert(bytes("bt")); + vm.expectRevert(MerklePathOutOfBounds.selector); merkleTest.calculateRoot(proof, 0, leaf); } @@ -105,7 +106,7 @@ contract MerkleTestTest is Test { bytes32[] memory left; bytes32[] memory right; - vm.expectRevert(bytes("Merkle: empty paths")); + vm.expectRevert(MerklePathEmpty.selector); merkleTest.calculateRoot(left, right, 10, leaves); } diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/Merkle/MerkleTreeNoSort.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/Merkle/MerkleTreeNoSort.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/Merkle/MerkleTreeNoSort.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/Merkle/MerkleTreeNoSort.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/UncheckedMath/UncheckedAdd.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/UncheckedMath/UncheckedAdd.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/UncheckedMath/UncheckedAdd.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/UncheckedMath/UncheckedAdd.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/UncheckedMath/UncheckedInc.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/UncheckedMath/UncheckedInc.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/UncheckedMath/UncheckedInc.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/UncheckedMath/UncheckedInc.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/UncheckedMath/_UncheckedMath_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/UncheckedMath/_UncheckedMath_Shared.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/UncheckedMath/_UncheckedMath_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/UncheckedMath/_UncheckedMath_Shared.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/common/libraries/UnsafeBytes/UnsafeBytes.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/common/libraries/UnsafeBytes/UnsafeBytes.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/common/libraries/UnsafeBytes/UnsafeBytes.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/common/libraries/UnsafeBytes/UnsafeBytes.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/Admin.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/Admin.t.sol similarity index 63% rename from l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/Admin.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/Admin.t.sol index a214c0374..5194b1da5 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/Admin.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/Admin.t.sol @@ -1,15 +1,19 @@ // SPDX-License-Identifier: MIT pragma solidity 0.8.24; -import {IStateTransitionManager} from "contracts/state-transition/IStateTransitionManager.sol"; -import {StateTransitionManagerTest} from "./_StateTransitionManager_Shared.t.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; +import {ChainTypeManagerTest} from "./_ChainTypeManager_Shared.t.sol"; + +contract AdminTest is ChainTypeManagerTest { + function setUp() public { + deploy(); + } -contract AdminTest is StateTransitionManagerTest { function test_setPendingAdmin() public { address newAdmin = makeAddr("newAdmin"); vm.expectEmit(true, true, true, false); - emit IStateTransitionManager.NewPendingAdmin(address(0), newAdmin); + emit IChainTypeManager.NewPendingAdmin(address(0), newAdmin); chainContractAddress.setPendingAdmin(newAdmin); } @@ -22,9 +26,9 @@ contract AdminTest is StateTransitionManagerTest { vm.stopPrank(); vm.prank(newAdmin); vm.expectEmit(true, true, true, false); - emit IStateTransitionManager.NewPendingAdmin(newAdmin, address(0)); + emit IChainTypeManager.NewPendingAdmin(newAdmin, address(0)); vm.expectEmit(true, true, true, false); - emit IStateTransitionManager.NewAdmin(address(0), newAdmin); + emit IChainTypeManager.NewAdmin(address(0), newAdmin); chainContractAddress.acceptAdmin(); address currentAdmin = chainContractAddress.admin(); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/CreateNewChain.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/CreateNewChain.t.sol similarity index 55% rename from l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/CreateNewChain.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/CreateNewChain.t.sol index e1aaa8bcb..81659b682 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/CreateNewChain.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/CreateNewChain.t.sol @@ -1,11 +1,16 @@ // // SPDX-License-Identifier: MIT pragma solidity 0.8.24; -import {StateTransitionManagerTest} from "./_StateTransitionManager_Shared.t.sol"; +import {ChainTypeManagerTest} from "./_ChainTypeManager_Shared.t.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; import {Unauthorized, HashMismatch} from "contracts/common/L1ContractErrors.sol"; -contract createNewChainTest is StateTransitionManagerTest { +contract createNewChainTest is ChainTypeManagerTest { + function setUp() public { + deploy(); + } + function test_RevertWhen_InitialDiamondCutHashMismatch() public { Diamond.DiamondCutData memory initialDiamondCutData = getDiamondCutData(sharedBridge); Diamond.DiamondCutData memory correctDiamondCutData = getDiamondCutData(address(diamondInit)); @@ -26,32 +31,11 @@ contract createNewChainTest is StateTransitionManagerTest { vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, governor)); chainContractAddress.createNewChain({ _chainId: chainId, - _baseToken: baseToken, - _sharedBridge: sharedBridge, + _baseTokenAssetId: DataEncoding.encodeNTVAssetId(block.chainid, baseToken), + _assetRouter: sharedBridge, _admin: admin, _initData: abi.encode(abi.encode(initialDiamondCutData), bytes("")), _factoryDeps: new bytes[](0) }); } - - function test_SuccessfulCreationOfNewChain() public { - createNewChain(getDiamondCutData(diamondInit)); - - address admin = chainContractAddress.getChainAdmin(chainId); - address newChainAddress = chainContractAddress.getHyperchain(chainId); - - assertEq(newChainAdmin, admin); - assertNotEq(newChainAddress, address(0)); - - address[] memory chainAddresses = chainContractAddress.getAllHyperchains(); - assertEq(chainAddresses.length, 1); - assertEq(chainAddresses[0], newChainAddress); - - uint256[] memory chainIds = chainContractAddress.getAllHyperchainChainIDs(); - assertEq(chainIds.length, 1); - assertEq(chainIds[0], chainId); - - uint256 protocolVersion = chainContractAddress.getProtocolVersion(chainId); - assertEq(protocolVersion, 0); - } } diff --git a/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/FreezeChain.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/FreezeChain.t.sol new file mode 100644 index 000000000..d92349a61 --- /dev/null +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/FreezeChain.t.sol @@ -0,0 +1,26 @@ +// // SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {ChainTypeManagerTest} from "./_ChainTypeManager_Shared.t.sol"; +import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; +import {IAdmin} from "contracts/state-transition/chain-interfaces/IAdmin.sol"; +import {FacetIsFrozen} from "contracts/common/L1ContractErrors.sol"; + +contract freezeChainTest is ChainTypeManagerTest { + // function test_FreezingChain() public { + // createNewChain(getDiamondCutData(diamondInit)); + // address newChainAddress = chainContractAddress.getZKChain(chainId); + // GettersFacet gettersFacet = GettersFacet(newChainAddress); + // bool isChainFrozen = gettersFacet.isDiamondStorageFrozen(); + // assertEq(isChainFrozen, false); + // vm.stopPrank(); + // vm.startPrank(governor); + // chainContractAddress.freezeChain(block.chainid); + // // Repeated call should revert + // vm.expectRevert(bytes("q1")); // storage frozen + // chainContractAddress.freezeChain(block.chainid); + // // Call fails as storage is frozen + // vm.expectRevert(bytes("q1")); + // isChainFrozen = gettersFacet.isDiamondStorageFrozen(); + // } +} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/RevertBatches.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/RevertBatches.t.sol similarity index 94% rename from l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/RevertBatches.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/RevertBatches.t.sol index 4b0fa4576..cdac3e776 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/RevertBatches.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/RevertBatches.t.sol @@ -4,7 +4,7 @@ pragma solidity 0.8.24; import {Vm} from "forge-std/Test.sol"; import {Utils, L2_SYSTEM_CONTEXT_ADDRESS} from "../../Utils/Utils.sol"; -import {StateTransitionManagerTest} from "./_StateTransitionManager_Shared.t.sol"; +import {ChainTypeManagerTest} from "./_ChainTypeManager_Shared.t.sol"; import {COMMIT_TIMESTAMP_NOT_OLDER, DEFAULT_L2_LOGS_TREE_ROOT_HASH, EMPTY_STRING_KECCAK} from "contracts/common/Config.sol"; import {IExecutor, SystemLogKey} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; @@ -13,13 +13,13 @@ import {AdminFacet} from "contracts/state-transition/chain-deps/facets/Admin.sol import {ExecutorFacet} from "contracts/state-transition/chain-deps/facets/Executor.sol"; import {IExecutor} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; -contract revertBatchesTest is StateTransitionManagerTest { +contract revertBatchesTest is ChainTypeManagerTest { // Items for logs & commits uint256 internal currentTimestamp; IExecutor.CommitBatchInfo internal newCommitBatchInfo; IExecutor.StoredBatchInfo internal newStoredBatchInfo; IExecutor.StoredBatchInfo internal genesisStoredBatchInfo; - IExecutor.ProofInput internal proofInput; + uint256[] internal proofInput; // Facets exposing the diamond AdminFacet internal adminFacet; @@ -29,7 +29,7 @@ contract revertBatchesTest is StateTransitionManagerTest { // function test_SuccessfulBatchReverting() public { // createNewChain(getDiamondCutData(diamondInit)); - // address newChainAddress = chainContractAddress.getHyperchain(chainId); + // address newChainAddress = chainContractAddress.getZKChain(chainId); // executorFacet = ExecutorFacet(address(newChainAddress)); // gettersFacet = GettersFacet(address(newChainAddress)); @@ -108,7 +108,7 @@ contract revertBatchesTest is StateTransitionManagerTest { // vm.stopPrank(); // vm.startPrank(validator); // vm.recordLogs(); - // executorFacet.commitBatches(genesisStoredBatchInfo, commitBatchInfoArray); + // executorFacet.commitBatchesSharedBridge(uint256(0), genesisStoredBatchInfo, commitBatchInfoArray); // Vm.Log[] memory entries = vm.getRecordedLogs(); // newStoredBatchInfo = IExecutor.StoredBatchInfo({ @@ -127,7 +127,7 @@ contract revertBatchesTest is StateTransitionManagerTest { // executorFacet.proveBatches(genesisStoredBatchInfo, storedBatchInfoArray, proofInput); - // // Test batch revert triggered from STM + // // Test batch revert triggered from CTM // vm.stopPrank(); // vm.startPrank(governor); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetChainCreationParams.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetChainCreationParams.t.sol similarity index 90% rename from l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetChainCreationParams.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetChainCreationParams.t.sol index f4712553c..e55334737 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetChainCreationParams.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetChainCreationParams.t.sol @@ -1,13 +1,17 @@ // SPDX-License-Identifier: MIT pragma solidity 0.8.24; -import {StateTransitionManagerTest} from "./_StateTransitionManager_Shared.t.sol"; +import {ChainTypeManagerTest} from "./_ChainTypeManager_Shared.t.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; -import {ChainCreationParams} from "contracts/state-transition/IStateTransitionManager.sol"; +import {ChainCreationParams} from "contracts/state-transition/IChainTypeManager.sol"; import {IExecutor} from "contracts/state-transition/chain-interfaces/IExecutor.sol"; import {EMPTY_STRING_KECCAK, DEFAULT_L2_LOGS_TREE_ROOT_HASH} from "contracts/common/Config.sol"; -contract SetChainCreationParamsTest is StateTransitionManagerTest { +contract SetChainCreationParamsTest is ChainTypeManagerTest { + function setUp() public { + deploy(); + } + function test_SettingInitialCutHash() public { bytes32 initialCutHash = keccak256(abi.encode(getDiamondCutData(address(diamondInit)))); address randomDiamondInit = address(0x303030303030303030303); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetNewVersionUpgrade.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetNewVersionUpgrade.t.sol similarity index 84% rename from l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetNewVersionUpgrade.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetNewVersionUpgrade.t.sol index b1153a495..1dbaa2462 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetNewVersionUpgrade.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetNewVersionUpgrade.t.sol @@ -1,10 +1,14 @@ // SPDX-License-Identifier: MIT pragma solidity 0.8.24; -import {StateTransitionManagerTest} from "./_StateTransitionManager_Shared.t.sol"; +import {ChainTypeManagerTest} from "./_ChainTypeManager_Shared.t.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; -contract setNewVersionUpgradeTest is StateTransitionManagerTest { +contract setNewVersionUpgradeTest is ChainTypeManagerTest { + function setUp() public { + deploy(); + } + function test_SettingNewVersionUpgrade() public { assertEq(chainContractAddress.protocolVersion(), 0, "Initial protocol version is not correct"); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetUpgradeDiamondCut.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetUpgradeDiamondCut.t.sol similarity index 81% rename from l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetUpgradeDiamondCut.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetUpgradeDiamondCut.t.sol index a71f35d2e..d5ca40d50 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetUpgradeDiamondCut.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetUpgradeDiamondCut.t.sol @@ -1,10 +1,14 @@ // SPDX-License-Identifier: MIT pragma solidity 0.8.24; -import {StateTransitionManagerTest} from "./_StateTransitionManager_Shared.t.sol"; +import {ChainTypeManagerTest} from "./_ChainTypeManager_Shared.t.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; -contract setUpgradeDiamondCutTest is StateTransitionManagerTest { +contract setUpgradeDiamondCutTest is ChainTypeManagerTest { + function setUp() public { + deploy(); + } + function test_SettingUpgradeDiamondCut() public { assertEq(chainContractAddress.protocolVersion(), 0, "Initial protocol version is not correct"); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetValidatorTimelock.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetValidatorTimelock.t.sol similarity index 79% rename from l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetValidatorTimelock.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetValidatorTimelock.t.sol index 85267cf41..cbe0f1c6d 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/SetValidatorTimelock.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/SetValidatorTimelock.t.sol @@ -1,9 +1,15 @@ // SPDX-License-Identifier: MIT pragma solidity 0.8.24; -import {StateTransitionManagerTest} from "./_StateTransitionManager_Shared.t.sol"; +import {ChainTypeManagerTest} from "./_ChainTypeManager_Shared.t.sol"; + +import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; + +contract setValidatorTimelockTest is ChainTypeManagerTest { + function setUp() public { + deploy(); + } -contract setValidatorTimelockTest is StateTransitionManagerTest { function test_SettingValidatorTimelock() public { assertEq( chainContractAddress.validatorTimelock(), @@ -33,7 +39,7 @@ contract setValidatorTimelockTest is StateTransitionManagerTest { ); vm.prank(notOwner); - vm.expectRevert("STM: not owner or admin"); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, notOwner)); address newValidatorTimelock = address(0x0000000000000000000000000000000000004235); chainContractAddress.setValidatorTimelock(newValidatorTimelock); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/StateTransitionOwnerZero.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/StateTransitionOwnerZero.t.sol similarity index 58% rename from l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/StateTransitionOwnerZero.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/StateTransitionOwnerZero.t.sol index 1d87e925f..88c786c7b 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/StateTransitionOwnerZero.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/StateTransitionOwnerZero.t.sol @@ -2,13 +2,17 @@ pragma solidity 0.8.24; import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; -import {StateTransitionManagerTest} from "./_StateTransitionManager_Shared.t.sol"; -import {StateTransitionManager} from "contracts/state-transition/StateTransitionManager.sol"; -import {StateTransitionManagerInitializeData, ChainCreationParams} from "contracts/state-transition/IStateTransitionManager.sol"; +import {ChainTypeManagerTest} from "./_ChainTypeManager_Shared.t.sol"; +import {ChainTypeManager} from "contracts/state-transition/ChainTypeManager.sol"; +import {ChainTypeManagerInitializeData, ChainCreationParams} from "contracts/state-transition/IChainTypeManager.sol"; import {ZeroAddress} from "contracts/common/L1ContractErrors.sol"; -contract initializingSTMOwnerZeroTest is StateTransitionManagerTest { - function test_InitializingSTMWithGovernorZeroShouldRevert() public { +contract initializingCTMOwnerZeroTest is ChainTypeManagerTest { + function setUp() public { + deploy(); + } + + function test_InitializingCTMWithGovernorZeroShouldRevert() public { ChainCreationParams memory chainCreationParams = ChainCreationParams({ genesisUpgrade: address(genesisUpgradeContract), genesisBatchHash: bytes32(uint256(0x01)), @@ -18,7 +22,7 @@ contract initializingSTMOwnerZeroTest is StateTransitionManagerTest { forceDeploymentsData: bytes("") }); - StateTransitionManagerInitializeData memory stmInitializeDataNoOwner = StateTransitionManagerInitializeData({ + ChainTypeManagerInitializeData memory ctmInitializeDataNoOwner = ChainTypeManagerInitializeData({ owner: address(0), validatorTimelock: validator, chainCreationParams: chainCreationParams, @@ -27,9 +31,9 @@ contract initializingSTMOwnerZeroTest is StateTransitionManagerTest { vm.expectRevert(ZeroAddress.selector); new TransparentUpgradeableProxy( - address(stateTransitionManager), + address(chainTypeManager), admin, - abi.encodeCall(StateTransitionManager.initialize, stmInitializeDataNoOwner) + abi.encodeCall(ChainTypeManager.initialize, ctmInitializeDataNoOwner) ); } } diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/_StateTransitionManager_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/_ChainTypeManager_Shared.t.sol similarity index 66% rename from l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/_StateTransitionManager_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/_ChainTypeManager_Shared.t.sol index d35b2230e..6980aa52f 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/_StateTransitionManager_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/ChainTypeManager/_ChainTypeManager_Shared.t.sol @@ -7,8 +7,10 @@ import {Test} from "forge-std/Test.sol"; import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; -import {Utils} from "foundry-test/unit/concrete/Utils/Utils.sol"; -import {UtilsFacet} from "foundry-test/unit/concrete/Utils/UtilsFacet.sol"; + +import {Utils} from "foundry-test/l1/unit/concrete/Utils/Utils.sol"; +import {Bridgehub} from "contracts/bridgehub/Bridgehub.sol"; +import {UtilsFacet} from "foundry-test/l1/unit/concrete/Utils/UtilsFacet.sol"; import {AdminFacet} from "contracts/state-transition/chain-deps/facets/Admin.sol"; import {ExecutorFacet} from "contracts/state-transition/chain-deps/facets/Executor.sol"; import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; @@ -16,20 +18,18 @@ import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; import {DiamondInit} from "contracts/state-transition/chain-deps/DiamondInit.sol"; import {L1GenesisUpgrade as GenesisUpgrade} from "contracts/upgrades/L1GenesisUpgrade.sol"; import {InitializeDataNewChain} from "contracts/state-transition/chain-interfaces/IDiamondInit.sol"; -import {StateTransitionManager} from "contracts/state-transition/StateTransitionManager.sol"; -import {StateTransitionManagerInitializeData, ChainCreationParams} from "contracts/state-transition/IStateTransitionManager.sol"; +import {ChainTypeManager} from "contracts/state-transition/ChainTypeManager.sol"; +import {ChainTypeManagerInitializeData, ChainCreationParams} from "contracts/state-transition/IChainTypeManager.sol"; import {TestnetVerifier} from "contracts/state-transition/TestnetVerifier.sol"; -<<<<<<< HEAD import {DummyBridgehub} from "contracts/dev-contracts/test/DummyBridgehub.sol"; -======= +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; import {ZeroAddress} from "contracts/common/L1ContractErrors.sol"; ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe -contract StateTransitionManagerTest is Test { - StateTransitionManager internal stateTransitionManager; - StateTransitionManager internal chainContractAddress; +contract ChainTypeManagerTest is Test { + ChainTypeManager internal chainTypeManager; + ChainTypeManager internal chainContractAddress; GenesisUpgrade internal genesisUpgradeContract; - address internal bridgehub; + Bridgehub internal bridgehub; address internal diamondInit; address internal constant governor = address(0x1010101); address internal constant admin = address(0x2020202); @@ -37,18 +37,18 @@ contract StateTransitionManagerTest is Test { address internal constant sharedBridge = address(0x4040404); address internal constant validator = address(0x5050505); address internal newChainAdmin; - uint256 chainId = block.chainid; + uint256 chainId = 112; address internal testnetVerifier = address(new TestnetVerifier()); + bytes internal forceDeploymentsData = hex""; Diamond.FacetCut[] internal facetCuts; - function setUp() public { - DummyBridgehub dummyBridgehub = new DummyBridgehub(); - bridgehub = address(dummyBridgehub); + function deploy() public { + bridgehub = new Bridgehub(block.chainid, governor, type(uint256).max); newChainAdmin = makeAddr("chainadmin"); - vm.startPrank(bridgehub); - stateTransitionManager = new StateTransitionManager(address(IBridgehub(address(bridgehub))), type(uint256).max); + vm.startPrank(address(bridgehub)); + chainTypeManager = new ChainTypeManager(address(IBridgehub(address(bridgehub)))); diamondInit = address(new DiamondInit()); genesisUpgradeContract = new GenesisUpgrade(); @@ -62,7 +62,7 @@ contract StateTransitionManagerTest is Test { ); facetCuts.push( Diamond.FacetCut({ - facet: address(new AdminFacet()), + facet: address(new AdminFacet(block.chainid)), action: Diamond.Action.Add, isFreezable: true, selectors: Utils.getAdminSelectors() @@ -91,10 +91,10 @@ contract StateTransitionManagerTest is Test { genesisIndexRepeatedStorageChanges: 0x01, genesisBatchCommitment: bytes32(uint256(0x01)), diamondCut: getDiamondCutData(address(diamondInit)), - forceDeploymentsData: bytes("") + forceDeploymentsData: forceDeploymentsData }); - StateTransitionManagerInitializeData memory stmInitializeDataNoGovernor = StateTransitionManagerInitializeData({ + ChainTypeManagerInitializeData memory ctmInitializeDataNoGovernor = ChainTypeManagerInitializeData({ owner: address(0), validatorTimelock: validator, chainCreationParams: chainCreationParams, @@ -103,12 +103,12 @@ contract StateTransitionManagerTest is Test { vm.expectRevert(ZeroAddress.selector); new TransparentUpgradeableProxy( - address(stateTransitionManager), + address(chainTypeManager), admin, - abi.encodeCall(StateTransitionManager.initialize, stmInitializeDataNoGovernor) + abi.encodeCall(ChainTypeManager.initialize, ctmInitializeDataNoGovernor) ); - StateTransitionManagerInitializeData memory stmInitializeData = StateTransitionManagerInitializeData({ + ChainTypeManagerInitializeData memory ctmInitializeData = ChainTypeManagerInitializeData({ owner: governor, validatorTimelock: validator, chainCreationParams: chainCreationParams, @@ -116,11 +116,11 @@ contract StateTransitionManagerTest is Test { }); TransparentUpgradeableProxy transparentUpgradeableProxy = new TransparentUpgradeableProxy( - address(stateTransitionManager), + address(chainTypeManager), admin, - abi.encodeCall(StateTransitionManager.initialize, stmInitializeData) + abi.encodeCall(ChainTypeManager.initialize, ctmInitializeData) ); - chainContractAddress = StateTransitionManager(address(transparentUpgradeableProxy)); + chainContractAddress = ChainTypeManager(address(transparentUpgradeableProxy)); vm.stopPrank(); vm.startPrank(governor); @@ -134,18 +134,23 @@ contract StateTransitionManagerTest is Test { return Diamond.DiamondCutData({facetCuts: facetCuts, initAddress: _diamondInit, initCalldata: initCalldata}); } - function createNewChain(Diamond.DiamondCutData memory _diamondCut) internal { + function getCTMInitData() internal view returns (bytes memory) { + return abi.encode(abi.encode(getDiamondCutData(diamondInit)), forceDeploymentsData); + } + + function createNewChain(Diamond.DiamondCutData memory _diamondCut) internal returns (address) { vm.stopPrank(); - vm.startPrank(bridgehub); - - chainContractAddress.createNewChain({ - _chainId: chainId, - _baseToken: baseToken, - _sharedBridge: sharedBridge, - _admin: newChainAdmin, - _initData: abi.encode(abi.encode(_diamondCut), bytes("")), - _factoryDeps: new bytes[](0) - }); + vm.startPrank(address(bridgehub)); + + return + chainContractAddress.createNewChain({ + _chainId: chainId, + _baseTokenAssetId: DataEncoding.encodeNTVAssetId(block.chainid, baseToken), + _assetRouter: sharedBridge, + _admin: newChainAdmin, + _initData: abi.encode(abi.encode(_diamondCut), bytes("")), + _factoryDeps: new bytes[](0) + }); } // add this to be excluded from coverage report diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/DiamondInit/Initialize.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/DiamondInit/Initialize.t.sol similarity index 93% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/DiamondInit/Initialize.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/DiamondInit/Initialize.t.sol index 205752a9f..cfc826fa5 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/DiamondInit/Initialize.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/DiamondInit/Initialize.t.sol @@ -2,8 +2,8 @@ pragma solidity 0.8.24; import {DiamondInitTest} from "./_DiamondInit_Shared.t.sol"; -import {Utils} from "foundry-test/unit/concrete/Utils/Utils.sol"; -import {UtilsFacet} from "foundry-test/unit/concrete/Utils/UtilsFacet.sol"; +import {Utils} from "foundry-test/l1/unit/concrete/Utils/Utils.sol"; +import {UtilsFacet} from "foundry-test/l1/unit/concrete/Utils/UtilsFacet.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; import {DiamondInit} from "contracts/state-transition/chain-deps/DiamondInit.sol"; @@ -84,8 +84,8 @@ contract InitializeTest is DiamondInitTest { assertEq(utilsFacet.util_getChainId(), initializeData.chainId); assertEq(utilsFacet.util_getBridgehub(), initializeData.bridgehub); - assertEq(utilsFacet.util_getStateTransitionManager(), initializeData.stateTransitionManager); - assertEq(utilsFacet.util_getBaseToken(), initializeData.baseToken); + assertEq(utilsFacet.util_getChainTypeManager(), initializeData.chainTypeManager); + assertEq(utilsFacet.util_getBaseTokenAssetId(), initializeData.baseTokenAssetId); assertEq(utilsFacet.util_getBaseTokenBridge(), initializeData.baseTokenBridge); assertEq(utilsFacet.util_getProtocolVersion(), initializeData.protocolVersion); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/DiamondInit/_DiamondInit_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/DiamondInit/_DiamondInit_Shared.t.sol similarity index 84% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/DiamondInit/_DiamondInit_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/DiamondInit/_DiamondInit_Shared.t.sol index 8a50fd5d5..79d0145dd 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/DiamondInit/_DiamondInit_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/DiamondInit/_DiamondInit_Shared.t.sol @@ -3,8 +3,8 @@ pragma solidity 0.8.24; import {Test} from "forge-std/Test.sol"; -import {Utils} from "foundry-test/unit/concrete/Utils/Utils.sol"; -import {UtilsFacet} from "foundry-test/unit/concrete/Utils/UtilsFacet.sol"; +import {Utils} from "foundry-test/l1/unit/concrete/Utils/Utils.sol"; +import {UtilsFacet} from "foundry-test/l1/unit/concrete/Utils/UtilsFacet.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; import {TestnetVerifier} from "contracts/state-transition/TestnetVerifier.sol"; diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/DiamondProxy/DiamondProxy.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/DiamondProxy/DiamondProxy.t.sol similarity index 95% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/DiamondProxy/DiamondProxy.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/DiamondProxy/DiamondProxy.t.sol index 4637faabd..d58d81ae5 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/DiamondProxy/DiamondProxy.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/DiamondProxy/DiamondProxy.t.sol @@ -3,18 +3,18 @@ pragma solidity 0.8.24; import {Test} from "forge-std/Test.sol"; -import {Utils} from "foundry-test/unit/concrete/Utils/Utils.sol"; -import {UtilsFacet} from "foundry-test/unit/concrete/Utils/UtilsFacet.sol"; +import {Utils} from "foundry-test/l1/unit/concrete/Utils/Utils.sol"; +import {UtilsFacet} from "foundry-test/l1/unit/concrete/Utils/UtilsFacet.sol"; import {InitializeData} from "contracts/state-transition/chain-interfaces/IDiamondInit.sol"; import {DiamondInit} from "contracts/state-transition/chain-deps/DiamondInit.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; import {DiamondProxy} from "contracts/state-transition/chain-deps/DiamondProxy.sol"; -import {ZkSyncHyperchainBase} from "contracts/state-transition/chain-deps/facets/ZkSyncHyperchainBase.sol"; +import {ZKChainBase} from "contracts/state-transition/chain-deps/facets/ZKChainBase.sol"; import {TestnetVerifier} from "contracts/state-transition/TestnetVerifier.sol"; import {FacetIsFrozen, ValueMismatch, InvalidSelector} from "contracts/common/L1ContractErrors.sol"; -contract TestFacet is ZkSyncHyperchainBase { +contract TestFacet is ZKChainBase { function func() public pure returns (bool) { return true; } diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/AcceptAdmin.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/AcceptAdmin.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/AcceptAdmin.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/AcceptAdmin.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/ChangeFeeParams.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/ChangeFeeParams.t.sol similarity index 84% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/ChangeFeeParams.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/ChangeFeeParams.t.sol index 70324aabf..5a1f4cbb0 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/ChangeFeeParams.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/ChangeFeeParams.t.sol @@ -4,7 +4,7 @@ pragma solidity 0.8.24; import {AdminTest} from "./_Admin_Shared.t.sol"; -import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; +import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; import {Unauthorized, PriorityTxPubdataExceedsMaxPubDataPerBatch} from "contracts/common/L1ContractErrors.sol"; contract ChangeFeeParamsTest is AdminTest { @@ -25,8 +25,8 @@ contract ChangeFeeParamsTest is AdminTest { ); } - function test_revertWhen_calledByNonStateTransitionManager() public { - address nonStateTransitionManager = makeAddr("nonStateTransitionManager"); + function test_revertWhen_calledByNonChainTypeManager() public { + address nonChainTypeManager = makeAddr("nonChainTypeManager"); FeeParams memory newFeeParams = FeeParams({ pubdataPricingMode: PubdataPricingMode.Rollup, batchOverheadL1Gas: 1_000_000, @@ -36,14 +36,14 @@ contract ChangeFeeParamsTest is AdminTest { minimalL2GasPrice: 250_000_000 }); - vm.startPrank(nonStateTransitionManager); - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonStateTransitionManager)); + vm.startPrank(nonChainTypeManager); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonChainTypeManager)); adminFacet.changeFeeParams(newFeeParams); } function test_revertWhen_newMaxPubdataPerBatchIsLessThanMaxPubdataPerTransaction() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); + address chainTypeManager = utilsFacet.util_getChainTypeManager(); uint32 priorityTxMaxPubdata = 88_000; uint32 maxPubdataPerBatch = priorityTxMaxPubdata - 1; FeeParams memory newFeeParams = FeeParams({ @@ -57,12 +57,12 @@ contract ChangeFeeParamsTest is AdminTest { vm.expectRevert(PriorityTxPubdataExceedsMaxPubDataPerBatch.selector); - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); adminFacet.changeFeeParams(newFeeParams); } function test_successfulChange() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); + address chainTypeManager = utilsFacet.util_getChainTypeManager(); FeeParams memory oldFeeParams = utilsFacet.util_getFeeParams(); FeeParams memory newFeeParams = FeeParams({ pubdataPricingMode: PubdataPricingMode.Rollup, @@ -77,7 +77,7 @@ contract ChangeFeeParamsTest is AdminTest { vm.expectEmit(true, true, true, true, address(adminFacet)); emit NewFeeParams(oldFeeParams, newFeeParams); - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); adminFacet.changeFeeParams(newFeeParams); bytes32 newFeeParamsHash = keccak256(abi.encode(newFeeParams)); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/ExecuteUpgrade.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/ExecuteUpgrade.t.sol similarity index 88% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/ExecuteUpgrade.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/ExecuteUpgrade.t.sol index d09b6f204..de559f27b 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/ExecuteUpgrade.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/ExecuteUpgrade.t.sol @@ -15,17 +15,17 @@ import {ProposedUpgrade} from "contracts/upgrades/BaseZkSyncUpgrade.sol"; contract ExecuteUpgradeTest is AdminTest { event ExecuteUpgrade(Diamond.DiamondCutData diamondCut); - function test_revertWhen_calledByNonGovernorOrStateTransitionManager() public { - address nonStateTransitionManager = makeAddr("nonStateTransitionManager"); + function test_revertWhen_calledByNonGovernorOrChainTypeManager() public { + address nonChainTypeManager = makeAddr("nonChainTypeManager"); Diamond.DiamondCutData memory diamondCutData = Diamond.DiamondCutData({ facetCuts: new Diamond.FacetCut[](0), initAddress: address(0), initCalldata: new bytes(0) }); - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonStateTransitionManager)); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonChainTypeManager)); - vm.startPrank(nonStateTransitionManager); + vm.startPrank(nonChainTypeManager); adminFacet.executeUpgrade(diamondCutData); } @@ -61,8 +61,8 @@ contract ExecuteUpgradeTest is AdminTest { initCalldata: abi.encodeCall(upgrade.upgrade, (proposedUpgrade)) }); - address stm = utilsFacet.util_getStateTransitionManager(); - vm.startPrank(stm); + address ctm = utilsFacet.util_getChainTypeManager(); + vm.startPrank(ctm); adminFacet.executeUpgrade(diamondCutData); } diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/FreezeDiamond.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/FreezeDiamond.t.sol similarity index 59% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/FreezeDiamond.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/FreezeDiamond.t.sol index 77baed0ef..457611105 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/FreezeDiamond.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/FreezeDiamond.t.sol @@ -8,12 +8,12 @@ import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; contract FreezeDiamondTest is AdminTest { event Freeze(); - function test_revertWhen_calledByNonStateTransitionManager() public { - address nonStateTransitionManager = makeAddr("nonStateTransitionManager"); + function test_revertWhen_calledByNonChainTypeManager() public { + address nonChainTypeManager = makeAddr("nonChainTypeManager"); - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonStateTransitionManager)); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonChainTypeManager)); - vm.startPrank(nonStateTransitionManager); + vm.startPrank(nonChainTypeManager); adminFacet.freezeDiamond(); } } diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetPendingGovernor.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetPendingGovernor.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetPendingGovernor.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetPendingGovernor.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetPorterAvailability.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetPorterAvailability.t.sol similarity index 74% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetPorterAvailability.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetPorterAvailability.t.sol index ad0708f11..ca594b93a 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetPorterAvailability.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetPorterAvailability.t.sol @@ -8,17 +8,17 @@ import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; contract SetPorterAvailabilityTest is AdminTest { event IsPorterAvailableStatusUpdate(bool isPorterAvailable); - function test_revertWhen_calledByNonStateTransitionManager() public { - address nonStateTransitionManager = makeAddr("nonStateTransitionManager"); + function test_revertWhen_calledByNonChainTypeManager() public { + address nonChainTypeManager = makeAddr("nonChainTypeManager"); bool isPorterAvailable = true; - vm.startPrank(nonStateTransitionManager); - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonStateTransitionManager)); + vm.startPrank(nonChainTypeManager); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonChainTypeManager)); adminFacet.setPorterAvailability(isPorterAvailable); } function test_setPorterAvailabilityToFalse() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); + address chainTypeManager = utilsFacet.util_getChainTypeManager(); bool isPorterAvailable = false; utilsFacet.util_setZkPorterAvailability(true); @@ -27,14 +27,14 @@ contract SetPorterAvailabilityTest is AdminTest { vm.expectEmit(true, true, true, true, address(adminFacet)); emit IsPorterAvailableStatusUpdate(isPorterAvailable); - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); adminFacet.setPorterAvailability(isPorterAvailable); assertEq(utilsFacet.util_getZkPorterAvailability(), isPorterAvailable); } function test_setPorterAvailabilityToTrue() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); + address chainTypeManager = utilsFacet.util_getChainTypeManager(); bool isPorterAvailable = true; utilsFacet.util_setZkPorterAvailability(false); @@ -43,7 +43,7 @@ contract SetPorterAvailabilityTest is AdminTest { vm.expectEmit(true, true, true, true, address(adminFacet)); emit IsPorterAvailableStatusUpdate(isPorterAvailable); - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); adminFacet.setPorterAvailability(isPorterAvailable); assertEq(utilsFacet.util_getZkPorterAvailability(), isPorterAvailable); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetPriorityTxMaxGasLimit.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetPriorityTxMaxGasLimit.t.sol similarity index 74% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetPriorityTxMaxGasLimit.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetPriorityTxMaxGasLimit.t.sol index 5581420fe..e5841bc87 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetPriorityTxMaxGasLimit.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetPriorityTxMaxGasLimit.t.sol @@ -10,26 +10,26 @@ import {Unauthorized, TooMuchGas} from "contracts/common/L1ContractErrors.sol"; contract SetPriorityTxMaxGasLimitTest is AdminTest { event NewPriorityTxMaxGasLimit(uint256 oldPriorityTxMaxGasLimit, uint256 newPriorityTxMaxGasLimit); - function test_revertWhen_calledByNonStateTransitionManager() public { - address nonStateTransitionManager = makeAddr("nonStateTransitionManager"); + function test_revertWhen_calledByNonChainTypeManager() public { + address nonChainTypeManager = makeAddr("nonChainTypeManager"); uint256 newPriorityTxMaxGasLimit = 100; - vm.startPrank(nonStateTransitionManager); - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonStateTransitionManager)); + vm.startPrank(nonChainTypeManager); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonChainTypeManager)); adminFacet.setPriorityTxMaxGasLimit(newPriorityTxMaxGasLimit); } function test_revertWhen_newPriorityTxMaxGasLimitIsGreaterThanMaxGasPerTransaction() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); + address chainTypeManager = utilsFacet.util_getChainTypeManager(); uint256 newPriorityTxMaxGasLimit = MAX_GAS_PER_TRANSACTION + 1; - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); vm.expectRevert(TooMuchGas.selector); adminFacet.setPriorityTxMaxGasLimit(newPriorityTxMaxGasLimit); } function test_successfulSet() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); + address chainTypeManager = utilsFacet.util_getChainTypeManager(); uint256 oldPriorityTxMaxGasLimit = utilsFacet.util_getPriorityTxMaxGasLimit(); uint256 newPriorityTxMaxGasLimit = 100; @@ -37,7 +37,7 @@ contract SetPriorityTxMaxGasLimitTest is AdminTest { vm.expectEmit(true, true, true, true, address(adminFacet)); emit NewPriorityTxMaxGasLimit(oldPriorityTxMaxGasLimit, newPriorityTxMaxGasLimit); - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); adminFacet.setPriorityTxMaxGasLimit(newPriorityTxMaxGasLimit); assertEq(utilsFacet.util_getPriorityTxMaxGasLimit(), newPriorityTxMaxGasLimit); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetTransactionFilterer.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetTransactionFilterer.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetTransactionFilterer.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetTransactionFilterer.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetValidator.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetValidator.t.sol similarity index 74% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetValidator.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetValidator.t.sol index 77990a285..5b75a0ac7 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/SetValidator.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/SetValidator.t.sol @@ -8,18 +8,18 @@ import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; contract SetValidatorTest is AdminTest { event ValidatorStatusUpdate(address indexed validatorAddress, bool isActive); - function test_revertWhen_calledByNonStateTransitionManager() public { - address nonStateTransitionManager = makeAddr("nonStateTransitionManager"); + function test_revertWhen_calledByNonChainTypeManager() public { + address nonChainTypeManager = makeAddr("nonChainTypeManager"); address validator = makeAddr("validator"); bool isActive = true; - vm.startPrank(nonStateTransitionManager); - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonStateTransitionManager)); + vm.startPrank(nonChainTypeManager); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonChainTypeManager)); adminFacet.setValidator(validator, isActive); } function test_deactivateValidator() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); + address chainTypeManager = utilsFacet.util_getChainTypeManager(); address validator = makeAddr("validator"); bool isActive = false; @@ -29,14 +29,14 @@ contract SetValidatorTest is AdminTest { vm.expectEmit(true, true, true, true, address(adminFacet)); emit ValidatorStatusUpdate(validator, isActive); - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); adminFacet.setValidator(validator, isActive); assertEq(utilsFacet.util_getValidator(validator), isActive); } function test_reactivateValidator() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); + address chainTypeManager = utilsFacet.util_getChainTypeManager(); address validator = makeAddr("validator"); bool isActive = true; @@ -46,7 +46,7 @@ contract SetValidatorTest is AdminTest { vm.expectEmit(true, true, true, true, address(adminFacet)); emit ValidatorStatusUpdate(validator, isActive); - vm.startPrank(stateTransitionManager); + vm.startPrank(chainTypeManager); adminFacet.setValidator(validator, isActive); assertEq(utilsFacet.util_getValidator(validator), isActive); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/UnfreezeDiamond.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/UnfreezeDiamond.t.sol similarity index 67% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/UnfreezeDiamond.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/UnfreezeDiamond.t.sol index e0da9d6dc..88af27533 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/UnfreezeDiamond.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/UnfreezeDiamond.t.sol @@ -8,16 +8,16 @@ import {Unauthorized, DiamondFreezeIncorrectState, DiamondNotFrozen} from "contr contract UnfreezeDiamondTest is AdminTest { event Unfreeze(); - function test_revertWhen_calledByNonStateTransitionManager() public { - address nonStateTransitionManager = makeAddr("nonStateTransitionManager"); + function test_revertWhen_calledByNonChainTypeManager() public { + address nonChainTypeManager = makeAddr("nonChainTypeManager"); - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonStateTransitionManager)); - vm.startPrank(nonStateTransitionManager); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonChainTypeManager)); + vm.startPrank(nonChainTypeManager); adminFacet.unfreezeDiamond(); } function test_revertWhen_diamondIsNotFrozen() public { - address admin = utilsFacet.util_getStateTransitionManager(); + address admin = utilsFacet.util_getChainTypeManager(); utilsFacet.util_setIsFrozen(false); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/UpgradeChainFromVersion.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/UpgradeChainFromVersion.t.sol similarity index 73% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/UpgradeChainFromVersion.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/UpgradeChainFromVersion.t.sol index 9e6efc1e5..50de804d5 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/UpgradeChainFromVersion.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/UpgradeChainFromVersion.t.sol @@ -5,14 +5,14 @@ pragma solidity 0.8.24; import {AdminTest} from "./_Admin_Shared.t.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; -import {IStateTransitionManager} from "contracts/state-transition/IStateTransitionManager.sol"; +import {IChainTypeManager} from "contracts/state-transition/IChainTypeManager.sol"; import {ProtocolIdMismatch, ProtocolIdNotGreater, InvalidProtocolVersion, ValueMismatch, Unauthorized, HashMismatch} from "contracts/common/L1ContractErrors.sol"; contract UpgradeChainFromVersionTest is AdminTest { event ExecuteUpgrade(Diamond.DiamondCutData diamondCut); - function test_revertWhen_calledByNonAdminOrStateTransitionManager() public { - address nonAdminOrStateTransitionManager = makeAddr("nonAdminOrStateTransitionManager"); + function test_revertWhen_calledByNonAdminOrChainTypeManager() public { + address nonAdminOrChainTypeManager = makeAddr("nonAdminOrChainTypeManager"); uint256 oldProtocolVersion = 1; Diamond.DiamondCutData memory diamondCutData = Diamond.DiamondCutData({ facetCuts: new Diamond.FacetCut[](0), @@ -20,14 +20,14 @@ contract UpgradeChainFromVersionTest is AdminTest { initCalldata: new bytes(0) }); - vm.startPrank(nonAdminOrStateTransitionManager); - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonAdminOrStateTransitionManager)); + vm.startPrank(nonAdminOrChainTypeManager); + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonAdminOrChainTypeManager)); adminFacet.upgradeChainFromVersion(oldProtocolVersion, diamondCutData); } function test_revertWhen_cutHashMismatch() public { address admin = utilsFacet.util_getAdmin(); - address stateTransitionManager = makeAddr("stateTransitionManager"); + address chainTypeManager = makeAddr("chainTypeManager"); uint256 oldProtocolVersion = 1; Diamond.DiamondCutData memory diamondCutData = Diamond.DiamondCutData({ @@ -36,12 +36,12 @@ contract UpgradeChainFromVersionTest is AdminTest { initCalldata: new bytes(0) }); - utilsFacet.util_setStateTransitionManager(stateTransitionManager); + utilsFacet.util_setChainTypeManager(chainTypeManager); bytes32 cutHashInput = keccak256("random"); vm.mockCall( - stateTransitionManager, - abi.encodeWithSelector(IStateTransitionManager.upgradeCutHash.selector), + chainTypeManager, + abi.encodeWithSelector(IChainTypeManager.upgradeCutHash.selector), abi.encode(cutHashInput) ); @@ -54,7 +54,7 @@ contract UpgradeChainFromVersionTest is AdminTest { function test_revertWhen_ProtocolVersionMismatchWhenUpgrading() public { address admin = utilsFacet.util_getAdmin(); - address stateTransitionManager = makeAddr("stateTransitionManager"); + address chainTypeManager = makeAddr("chainTypeManager"); uint256 oldProtocolVersion = 1; Diamond.DiamondCutData memory diamondCutData = Diamond.DiamondCutData({ @@ -64,12 +64,12 @@ contract UpgradeChainFromVersionTest is AdminTest { }); utilsFacet.util_setProtocolVersion(oldProtocolVersion + 1); - utilsFacet.util_setStateTransitionManager(stateTransitionManager); + utilsFacet.util_setChainTypeManager(chainTypeManager); bytes32 cutHashInput = keccak256(abi.encode(diamondCutData)); vm.mockCall( - stateTransitionManager, - abi.encodeWithSelector(IStateTransitionManager.upgradeCutHash.selector), + chainTypeManager, + abi.encodeWithSelector(IChainTypeManager.upgradeCutHash.selector), abi.encode(cutHashInput) ); @@ -80,7 +80,7 @@ contract UpgradeChainFromVersionTest is AdminTest { function test_revertWhen_ProtocolVersionMismatchAfterUpgrading() public { address admin = utilsFacet.util_getAdmin(); - address stateTransitionManager = makeAddr("stateTransitionManager"); + address chainTypeManager = makeAddr("chainTypeManager"); uint256 oldProtocolVersion = 1; Diamond.DiamondCutData memory diamondCutData = Diamond.DiamondCutData({ @@ -90,12 +90,12 @@ contract UpgradeChainFromVersionTest is AdminTest { }); utilsFacet.util_setProtocolVersion(oldProtocolVersion); - utilsFacet.util_setStateTransitionManager(stateTransitionManager); + utilsFacet.util_setChainTypeManager(chainTypeManager); bytes32 cutHashInput = keccak256(abi.encode(diamondCutData)); vm.mockCall( - stateTransitionManager, - abi.encodeWithSelector(IStateTransitionManager.upgradeCutHash.selector), + chainTypeManager, + abi.encodeWithSelector(IChainTypeManager.upgradeCutHash.selector), abi.encode(cutHashInput) ); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/_Admin_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/_Admin_Shared.t.sol similarity index 91% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/_Admin_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/_Admin_Shared.t.sol index a4419a342..7c45f8e8b 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Admin/_Admin_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Admin/_Admin_Shared.t.sol @@ -3,8 +3,8 @@ pragma solidity 0.8.24; import {Test} from "forge-std/Test.sol"; -import {Utils} from "foundry-test/unit/concrete/Utils/Utils.sol"; -import {UtilsFacet} from "foundry-test/unit/concrete/Utils/UtilsFacet.sol"; +import {Utils} from "foundry-test/l1/unit/concrete/Utils/Utils.sol"; +import {UtilsFacet} from "foundry-test/l1/unit/concrete/Utils/UtilsFacet.sol"; import {AdminFacet} from "contracts/state-transition/chain-deps/facets/Admin.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; @@ -36,7 +36,7 @@ contract AdminTest is Test { function setUp() public virtual { Diamond.FacetCut[] memory facetCuts = new Diamond.FacetCut[](2); facetCuts[0] = Diamond.FacetCut({ - facet: address(new AdminFacet()), + facet: address(new AdminFacet(block.chainid)), action: Diamond.Action.Add, isFreezable: true, selectors: getAdminSelectors() diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyBridgehub.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyBridgehub.t.sol similarity index 84% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyBridgehub.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyBridgehub.t.sol index af92cde5f..459e71b47 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyBridgehub.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyBridgehub.t.sol @@ -2,10 +2,10 @@ pragma solidity 0.8.24; -import {ZkSyncHyperchainBaseTest} from "./_Base_Shared.t.sol"; +import {ZKChainBaseTest} from "./_Base_Shared.t.sol"; import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; -contract OnlyBridgehubTest is ZkSyncHyperchainBaseTest { +contract OnlyBridgehubTest is ZKChainBaseTest { function test_revertWhen_calledByNonBridgehub() public { address nonBridgehub = makeAddr("nonBridgehub"); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernor.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernor.t.sol similarity index 83% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernor.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernor.t.sol index 44c397c85..478372df9 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernor.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernor.t.sol @@ -2,10 +2,10 @@ pragma solidity 0.8.24; -import {ZkSyncHyperchainBaseTest} from "./_Base_Shared.t.sol"; +import {ZKChainBaseTest} from "./_Base_Shared.t.sol"; import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; -contract OnlyAdminTest is ZkSyncHyperchainBaseTest { +contract OnlyAdminTest is ZKChainBaseTest { function test_revertWhen_calledByNonAdmin() public { address nonAdmin = makeAddr("nonAdmin"); diff --git a/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernorOrStateTransitionManager.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernorOrStateTransitionManager.t.sol new file mode 100644 index 000000000..67cfe3d32 --- /dev/null +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernorOrStateTransitionManager.t.sol @@ -0,0 +1,38 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {ZKChainBaseTest} from "./_Base_Shared.t.sol"; +import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; + +contract OnlyAdminOrChainTypeManagerTest is ZKChainBaseTest { + function test_revertWhen_calledByNonAdmin() public { + address nonAdmin = makeAddr("nonAdmin"); + + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonAdmin)); + vm.startPrank(nonAdmin); + testBaseFacet.functionWithOnlyAdminOrChainTypeManagerModifier(); + } + + function test_revertWhen_calledByNonChainTypeManager() public { + address nonChainTypeManager = makeAddr("nonChainTypeManager"); + + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonChainTypeManager)); + vm.startPrank(nonChainTypeManager); + testBaseFacet.functionWithOnlyAdminOrChainTypeManagerModifier(); + } + + function test_successfulCallWhenCalledByAdmin() public { + address admin = utilsFacet.util_getAdmin(); + + vm.startPrank(admin); + testBaseFacet.functionWithOnlyAdminOrChainTypeManagerModifier(); + } + + function test_successfulCallWhenCalledByChainTypeManager() public { + address chainTypeManager = utilsFacet.util_getChainTypeManager(); + + vm.startPrank(chainTypeManager); + testBaseFacet.functionWithOnlyAdminOrChainTypeManagerModifier(); + } +} diff --git a/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyStateTransitionManager.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyStateTransitionManager.t.sol new file mode 100644 index 000000000..b7f7ec5a3 --- /dev/null +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyStateTransitionManager.t.sol @@ -0,0 +1,23 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {ZKChainBaseTest} from "./_Base_Shared.t.sol"; +import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; + +contract OnlyChainTypeManagerTest is ZKChainBaseTest { + function test_revertWhen_calledByNonChainTypeManager() public { + address nonChainTypeManager = makeAddr("nonChainTypeManager"); + + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonChainTypeManager)); + vm.startPrank(nonChainTypeManager); + testBaseFacet.functionWithOnlyChainTypeManagerModifier(); + } + + function test_successfulCall() public { + address chainTypeManager = utilsFacet.util_getChainTypeManager(); + + vm.startPrank(chainTypeManager); + testBaseFacet.functionWithOnlyChainTypeManagerModifier(); + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyValidator.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyValidator.t.sol similarity index 86% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyValidator.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyValidator.t.sol index c002fec59..5997976ac 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyValidator.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/OnlyValidator.t.sol @@ -2,10 +2,10 @@ pragma solidity 0.8.24; -import {ZkSyncHyperchainBaseTest} from "./_Base_Shared.t.sol"; +import {ZKChainBaseTest} from "./_Base_Shared.t.sol"; import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; -contract OnlyValidatorTest is ZkSyncHyperchainBaseTest { +contract OnlyValidatorTest is ZKChainBaseTest { function test_revertWhen_calledByNonValidator() public { address nonValidator = makeAddr("nonValidator"); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/_Base_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/_Base_Shared.t.sol similarity index 59% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/_Base_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/_Base_Shared.t.sol index 15fa32883..be93c91df 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/_Base_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Base/_Base_Shared.t.sol @@ -3,41 +3,38 @@ pragma solidity 0.8.24; import {Test} from "forge-std/Test.sol"; -import {Utils} from "foundry-test/unit/concrete/Utils/Utils.sol"; -import {UtilsFacet} from "foundry-test/unit/concrete/Utils/UtilsFacet.sol"; +import {Utils} from "foundry-test/l1/unit/concrete/Utils/Utils.sol"; +import {UtilsFacet} from "foundry-test/l1/unit/concrete/Utils/UtilsFacet.sol"; import {Diamond} from "contracts/state-transition/libraries/Diamond.sol"; -import {ZkSyncHyperchainBase} from "contracts/state-transition/chain-deps/facets/Admin.sol"; +import {ZKChainBase} from "contracts/state-transition/chain-deps/facets/Admin.sol"; import {TestnetVerifier} from "contracts/state-transition/TestnetVerifier.sol"; -contract TestBaseFacet is ZkSyncHyperchainBase { +contract TestBaseFacet is ZKChainBase { function functionWithOnlyAdminModifier() external onlyAdmin {} function functionWithOnlyValidatorModifier() external onlyValidator {} - function functionWithOnlyStateTransitionManagerModifier() external onlyStateTransitionManager {} + function functionWithOnlyChainTypeManagerModifier() external onlyChainTypeManager {} function functionWithOnlyBridgehubModifier() external onlyBridgehub {} - function functionWithOnlyAdminOrStateTransitionManagerModifier() external onlyAdminOrStateTransitionManager {} + function functionWithOnlyAdminOrChainTypeManagerModifier() external onlyAdminOrChainTypeManager {} - function functionWithonlyValidatorOrStateTransitionManagerModifier() - external - onlyValidatorOrStateTransitionManager - {} + function functionWithonlyValidatorOrChainTypeManagerModifier() external onlyValidatorOrChainTypeManager {} // add this to be excluded from coverage report function test() internal virtual {} } -bytes constant ERROR_ONLY_ADMIN = "Hyperchain: not admin"; -bytes constant ERROR_ONLY_VALIDATOR = "Hyperchain: not validator"; -bytes constant ERROR_ONLY_STATE_TRANSITION_MANAGER = "Hyperchain: not state transition manager"; -bytes constant ERROR_ONLY_BRIDGEHUB = "Hyperchain: not bridgehub"; -bytes constant ERROR_ONLY_ADMIN_OR_STATE_TRANSITION_MANAGER = "Hyperchain: Only by admin or state transition manager"; -bytes constant ERROR_ONLY_VALIDATOR_OR_STATE_TRANSITION_MANAGER = "Hyperchain: Only by validator or state transition manager"; +bytes constant ERROR_ONLY_ADMIN = "ZKChain: not admin"; +bytes constant ERROR_ONLY_VALIDATOR = "ZKChain: not validator"; +bytes constant ERROR_ONLY_STATE_TRANSITION_MANAGER = "ZKChain: not state transition manager"; +bytes constant ERROR_ONLY_BRIDGEHUB = "ZKChain: not bridgehub"; +bytes constant ERROR_ONLY_ADMIN_OR_STATE_TRANSITION_MANAGER = "ZKChain: Only by admin or state transition manager"; +bytes constant ERROR_ONLY_VALIDATOR_OR_STATE_TRANSITION_MANAGER = "ZKChain: Only by validator or state transition manager"; -contract ZkSyncHyperchainBaseTest is Test { +contract ZKChainBaseTest is Test { TestBaseFacet internal testBaseFacet; UtilsFacet internal utilsFacet; address internal testnetVerifier = address(new TestnetVerifier()); @@ -46,10 +43,10 @@ contract ZkSyncHyperchainBaseTest is Test { selectors = new bytes4[](6); selectors[0] = TestBaseFacet.functionWithOnlyAdminModifier.selector; selectors[1] = TestBaseFacet.functionWithOnlyValidatorModifier.selector; - selectors[2] = TestBaseFacet.functionWithOnlyStateTransitionManagerModifier.selector; + selectors[2] = TestBaseFacet.functionWithOnlyChainTypeManagerModifier.selector; selectors[3] = TestBaseFacet.functionWithOnlyBridgehubModifier.selector; - selectors[4] = TestBaseFacet.functionWithOnlyAdminOrStateTransitionManagerModifier.selector; - selectors[5] = TestBaseFacet.functionWithonlyValidatorOrStateTransitionManagerModifier.selector; + selectors[4] = TestBaseFacet.functionWithOnlyAdminOrChainTypeManagerModifier.selector; + selectors[5] = TestBaseFacet.functionWithonlyValidatorOrChainTypeManagerModifier.selector; } function setUp() public virtual { diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/FacetAddress.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/FacetAddress.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/FacetAddress.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/FacetAddress.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/FacetAddresses.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/FacetAddresses.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/FacetAddresses.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/FacetAddresses.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/FacetFunctionSelectors.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/FacetFunctionSelectors.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/FacetFunctionSelectors.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/FacetFunctionSelectors.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/Facets.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/Facets.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/Facets.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/Facets.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetAdmin.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetAdmin.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetAdmin.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetAdmin.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseToken.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseToken.t.sol similarity index 70% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseToken.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseToken.t.sol index 7feed3cd1..ce0611c96 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseToken.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseToken.t.sol @@ -6,10 +6,10 @@ import {GettersFacetTest} from "./_Getters_Shared.t.sol"; contract GetBaseTokenTest is GettersFacetTest { function test() public { - address expected = makeAddr("baseToken"); + bytes32 expected = bytes32(uint256(uint160(makeAddr("baseToken")))); gettersFacetWrapper.util_setBaseToken(expected); - address received = gettersFacet.getBaseToken(); + bytes32 received = gettersFacet.getBaseTokenAssetId(); assertEq(expected, received, "BaseToken address is incorrect"); } diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseTokenBridge.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseTokenBridge.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseTokenBridge.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetBaseTokenBridge.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetBridgehub.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetBridgehub.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetBridgehub.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetBridgehub.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetFirstUnprocessedPriorityTx.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetFirstUnprocessedPriorityTx.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetFirstUnprocessedPriorityTx.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetFirstUnprocessedPriorityTx.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2BootloaderBytecodeHash.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2BootloaderBytecodeHash.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2BootloaderBytecodeHash.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2BootloaderBytecodeHash.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2DefaultAccountBytecodeHash.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2DefaultAccountBytecodeHash.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2DefaultAccountBytecodeHash.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2DefaultAccountBytecodeHash.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeBatchNumber.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeBatchNumber.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeBatchNumber.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeBatchNumber.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeBlockNumber.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeBlockNumber.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeBlockNumber.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeBlockNumber.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeTxHash.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeTxHash.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeTxHash.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetL2SystemContractsUpgradeTxHash.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetPendingAdmin.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetPendingAdmin.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetPendingAdmin.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetPendingAdmin.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetPriorityQueueSize.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetPriorityQueueSize.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetPriorityQueueSize.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetPriorityQueueSize.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetPriorityTxMaxGasLimit.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetPriorityTxMaxGasLimit.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetPriorityTxMaxGasLimit.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetPriorityTxMaxGasLimit.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetProtocolVersion.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetProtocolVersion.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetProtocolVersion.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetProtocolVersion.t.sol diff --git a/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetStateTransitionManager.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetStateTransitionManager.t.sol new file mode 100644 index 000000000..cf8b23ef0 --- /dev/null +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetStateTransitionManager.t.sol @@ -0,0 +1,16 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {GettersFacetTest} from "./_Getters_Shared.t.sol"; + +contract GetChainTypeManagerTest is GettersFacetTest { + function test() public { + address expected = makeAddr("chainTypeManager"); + gettersFacetWrapper.util_setChainTypeManager(expected); + + address received = gettersFacet.getChainTypeManager(); + + assertEq(expected, received, "ChainTypeManager address is incorrect"); + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesCommitted.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesCommitted.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesCommitted.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesCommitted.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesExecuted.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesExecuted.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesExecuted.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesExecuted.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesVerified.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesVerified.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesVerified.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBatchesVerified.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksCommitted.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksCommitted.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksCommitted.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksCommitted.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksExecuted.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksExecuted.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksExecuted.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksExecuted.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksVerified.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksVerified.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksVerified.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalBlocksVerified.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalPriorityTxs.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalPriorityTxs.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalPriorityTxs.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetTotalPriorityTxs.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetVerifier.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetVerifier.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetVerifier.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetVerifier.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetVerifierParams.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetVerifierParams.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetVerifierParams.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/GetVerifierParams.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsDiamondStorageFrozen.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsDiamondStorageFrozen.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsDiamondStorageFrozen.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsDiamondStorageFrozen.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsEthWithdrawalFinalized.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsEthWithdrawalFinalized.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsEthWithdrawalFinalized.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsEthWithdrawalFinalized.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsFacetFreezable.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsFacetFreezable.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsFacetFreezable.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsFacetFreezable.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsFunctionFreezable.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsFunctionFreezable.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsFunctionFreezable.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsFunctionFreezable.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsValidator.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsValidator.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/IsValidator.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/IsValidator.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/L2LogsRootHash.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/L2LogsRootHash.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/L2LogsRootHash.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/L2LogsRootHash.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/StoredBatchHash.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/StoredBatchHash.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/StoredBatchHash.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/StoredBatchHash.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/StoredBlockHash.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/StoredBlockHash.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/StoredBlockHash.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/StoredBlockHash.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/_Getters_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/_Getters_Shared.t.sol similarity index 96% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/_Getters_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/_Getters_Shared.t.sol index d06088b5f..557378c63 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/_Getters_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Getters/_Getters_Shared.t.sol @@ -28,12 +28,12 @@ contract GettersFacetWrapper is GettersFacet { s.bridgehub = _bridgehub; } - function util_setStateTransitionManager(address _stateTransitionManager) external { - s.stateTransitionManager = _stateTransitionManager; + function util_setChainTypeManager(address _chainTypeManager) external { + s.chainTypeManager = _chainTypeManager; } - function util_setBaseToken(address _baseToken) external { - s.baseToken = _baseToken; + function util_setBaseToken(bytes32 _baseTokenAssetId) external { + s.baseTokenAssetId = _baseTokenAssetId; } function util_setBaseTokenBridge(address _baseTokenBridge) external { diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/BaseMailboxTests.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/BaseMailboxTests.t.sol similarity index 93% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/BaseMailboxTests.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/BaseMailboxTests.t.sol index 54ab2a135..230828ae7 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/BaseMailboxTests.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/BaseMailboxTests.t.sol @@ -3,9 +3,9 @@ pragma solidity 0.8.24; import {MailboxTest} from "./_Mailbox_Shared.t.sol"; -import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; +import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA} from "contracts/common/Config.sol"; -import {DummyHyperchain} from "contracts/dev-contracts/test/DummyHyperchain.sol"; +import {DummyZKChain} from "contracts/dev-contracts/test/DummyZKChain.sol"; import {BaseTokenGasPriceDenominatorNotSet} from "contracts/common/L1ContractErrors.sol"; contract MailboxBaseTests is MailboxTest { @@ -16,7 +16,7 @@ contract MailboxBaseTests is MailboxTest { } function test_mailboxConstructor() public { - DummyHyperchain h = new DummyHyperchain(address(0), eraChainId); + DummyZKChain h = new DummyZKChain(address(0), eraChainId, block.chainid); assertEq(h.getEraChainId(), eraChainId); } diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/BridgehubRequestL2Transaction.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/BridgehubRequestL2Transaction.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/BridgehubRequestL2Transaction.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/BridgehubRequestL2Transaction.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/FinalizeWithdrawal.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/FinalizeWithdrawal.t.sol similarity index 84% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/FinalizeWithdrawal.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/FinalizeWithdrawal.t.sol index e561f4e3b..c71721c79 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/FinalizeWithdrawal.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/FinalizeWithdrawal.t.sol @@ -4,23 +4,23 @@ pragma solidity 0.8.24; import {MailboxTest} from "./_Mailbox_Shared.t.sol"; import {DummyBridgehub} from "contracts/dev-contracts/test/DummyBridgehub.sol"; -import {L1SharedBridge} from "contracts/bridge/L1SharedBridge.sol"; +import {L1AssetRouter} from "contracts/bridge/asset-router/L1AssetRouter.sol"; import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; -import {IL1SharedBridge} from "contracts/bridge/interfaces/IL1SharedBridge.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; import {DummySharedBridge} from "contracts/dev-contracts/test/DummySharedBridge.sol"; import {OnlyEraSupported} from "contracts/common/L1ContractErrors.sol"; contract MailboxFinalizeWithdrawal is MailboxTest { bytes32[] proof; bytes message; - DummySharedBridge l1SharedBridge; + DummySharedBridge L1AssetRouter; address baseTokenBridgeAddress; function setUp() public virtual { setupDiamondProxy(); - l1SharedBridge = new DummySharedBridge(keccak256("dummyDepositHash")); - baseTokenBridgeAddress = address(l1SharedBridge); + L1AssetRouter = new DummySharedBridge(keccak256("dummyDepositHash")); + baseTokenBridgeAddress = address(L1AssetRouter); proof = new bytes32[](0); message = "message"; diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/ProvingL2LogsInclusion.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/ProvingL2LogsInclusion.t.sol similarity index 67% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/ProvingL2LogsInclusion.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/ProvingL2LogsInclusion.t.sol index b80409234..e04335d04 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/ProvingL2LogsInclusion.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/ProvingL2LogsInclusion.t.sol @@ -7,13 +7,13 @@ import {L2Message, L2Log} from "contracts/common/Messaging.sol"; import "forge-std/Test.sol"; import {L2_L1_LOGS_TREE_DEFAULT_LEAF_HASH, L1_GAS_PER_PUBDATA_BYTE, L2_TO_L1_LOG_SERIALIZE_SIZE} from "contracts/common/Config.sol"; import {L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR, L2_BOOTLOADER_ADDRESS} from "contracts/common/L2ContractAddresses.sol"; +import {Merkle} from "contracts/common/libraries/Merkle.sol"; import {BatchNotExecuted, HashedLogIsDefault} from "contracts/common/L1ContractErrors.sol"; -import {Merkle} from "contracts/state-transition/libraries/Merkle.sol"; import {MurkyBase} from "murky/common/MurkyBase.sol"; import {MerkleTest} from "contracts/dev-contracts/test/MerkleTest.sol"; import {TxStatus} from "contracts/state-transition/chain-deps/facets/Mailbox.sol"; import {Bridgehub} from "contracts/bridgehub/Bridgehub.sol"; -import {MerkleTreeNoSort} from "test/foundry/unit/concrete/state-transition/libraries/Merkle/MerkleTreeNoSort.sol"; +import {MerkleTreeNoSort} from "test/foundry/l1/unit/concrete/common/libraries/Merkle/MerkleTreeNoSort.sol"; contract MailboxL2LogsProve is MailboxTest { bytes32[] elements; @@ -50,14 +50,14 @@ contract MailboxL2LogsProve is MailboxTest { function test_RevertWhen_batchNumberGreaterThanBatchesExecuted() public { L2Message memory message = L2Message({txNumberInBatch: 0, sender: sender, data: data}); - bytes32[] memory proof = new bytes32[](0); + bytes32[] memory proof = _appendProofMetadata(new bytes32[](1)); - vm.expectRevert(abi.encodeWithSelector(BatchNotExecuted.selector, batchNumber + 1)); - mailboxFacet.proveL2MessageInclusion({ + _proveL2MessageInclusion({ _batchNumber: batchNumber + 1, _index: 0, _message: message, - _proof: proof + _proof: proof, + _expectedError: abi.encodeWithSelector(BatchNotExecuted.selector, batchNumber + 1) }); } @@ -100,13 +100,13 @@ contract MailboxL2LogsProve is MailboxTest { } // Prove L2 message inclusion - bool ret = mailboxFacet.proveL2MessageInclusion(batchNumber, firstLogIndex, message, firstLogProof); + bool ret = _proveL2MessageInclusion(batchNumber, firstLogIndex, message, firstLogProof, bytes("")); // Assert that the proof was successful assertEq(ret, true); // Prove L2 message inclusion for wrong leaf - ret = mailboxFacet.proveL2MessageInclusion(batchNumber, secondLogIndex, message, firstLogProof); + ret = _proveL2MessageInclusion(batchNumber, secondLogIndex, message, firstLogProof, bytes("")); // Assert that the proof has failed assertEq(ret, false); @@ -158,22 +158,24 @@ contract MailboxL2LogsProve is MailboxTest { } // Prove l2 log inclusion with correct proof - bool ret = mailboxFacet.proveL2LogInclusion({ + bool ret = _proveL2LogInclusion({ _batchNumber: batchNumber, _index: secondLogIndex, _proof: secondLogProof, - _log: log + _log: log, + _expectedError: bytes("") }); // Assert that the proof was successful assertEq(ret, true); // Prove l2 log inclusion with wrong proof - ret = mailboxFacet.proveL2LogInclusion({ + ret = _proveL2LogInclusion({ _batchNumber: batchNumber, _index: firstLogIndex, _proof: secondLogProof, - _log: log + _log: log, + _expectedError: bytes("") }); // Assert that the proof was successful @@ -222,13 +224,13 @@ contract MailboxL2LogsProve is MailboxTest { } // Prove log inclusion reverts - vm.expectRevert(HashedLogIsDefault.selector); - mailboxFacet.proveL2LogInclusion({ - _batchNumber: batchNumber, - _index: secondLogIndex, - _proof: secondLogProof, - _log: log - }); + _proveL2LogInclusion( + batchNumber, + secondLogIndex, + log, + secondLogProof, + bytes.concat(HashedLogIsDefault.selector) + ); } function test_success_proveL1ToL2TransactionStatus() public { @@ -271,7 +273,7 @@ contract MailboxL2LogsProve is MailboxTest { } // Prove L1 to L2 transaction status - bool ret = mailboxFacet.proveL1ToL2TransactionStatus({ + bool ret = _proveL1ToL2TransactionStatus({ _l2TxHash: secondL2TxHash, _l2BatchNumber: batchNumber, _l2MessageIndex: secondLogIndex, @@ -279,8 +281,111 @@ contract MailboxL2LogsProve is MailboxTest { _merkleProof: secondLogProof, _status: txStatus }); - // Assert that the proof was successful assertEq(ret, true); } + + /// @notice Proves L1 to L2 transaction status and cross-checks new and old encoding + function _proveL1ToL2TransactionStatus( + bytes32 _l2TxHash, + uint256 _l2BatchNumber, + uint256 _l2MessageIndex, + uint16 _l2TxNumberInBatch, + bytes32[] memory _merkleProof, + TxStatus _status + ) internal returns (bool) { + bool retOldEncoding = mailboxFacet.proveL1ToL2TransactionStatus({ + _l2TxHash: _l2TxHash, + _l2BatchNumber: _l2BatchNumber, + _l2MessageIndex: _l2MessageIndex, + _l2TxNumberInBatch: _l2TxNumberInBatch, + _merkleProof: _merkleProof, + _status: _status + }); + bool retNewEncoding = mailboxFacet.proveL1ToL2TransactionStatus({ + _l2TxHash: _l2TxHash, + _l2BatchNumber: _l2BatchNumber, + _l2MessageIndex: _l2MessageIndex, + _l2TxNumberInBatch: _l2TxNumberInBatch, + _merkleProof: _appendProofMetadata(_merkleProof), + _status: _status + }); + + assertEq(retOldEncoding, retNewEncoding); + + return retOldEncoding; + } + + /// @notice Proves L2 log inclusion and cross-checks new and old encoding + function _proveL2LogInclusion( + uint256 _batchNumber, + uint256 _index, + L2Log memory _log, + bytes32[] memory _proof, + bytes memory _expectedError + ) internal returns (bool) { + if (_expectedError.length > 0) { + vm.expectRevert(_expectedError); + } + bool retOldEncoding = mailboxFacet.proveL2LogInclusion({ + _batchNumber: _batchNumber, + _index: _index, + _proof: _proof, + _log: _log + }); + + if (_expectedError.length > 0) { + vm.expectRevert(_expectedError); + } + bool retNewEncoding = mailboxFacet.proveL2LogInclusion({ + _batchNumber: _batchNumber, + _index: _index, + _proof: _appendProofMetadata(_proof), + _log: _log + }); + + assertEq(retOldEncoding, retNewEncoding); + return retOldEncoding; + } + + function _proveL2MessageInclusion( + uint256 _batchNumber, + uint256 _index, + L2Message memory _message, + bytes32[] memory _proof, + bytes memory _expectedError + ) internal returns (bool) { + if (_expectedError.length > 0) { + vm.expectRevert(_expectedError); + } + bool retOldEncoding = mailboxFacet.proveL2MessageInclusion({ + _batchNumber: _batchNumber, + _index: _index, + _message: _message, + _proof: _proof + }); + + if (_expectedError.length > 0) { + vm.expectRevert(_expectedError); + } + bool retNewEncoding = mailboxFacet.proveL2MessageInclusion({ + _batchNumber: _batchNumber, + _index: _index, + _message: _message, + _proof: _appendProofMetadata(_proof) + }); + + assertEq(retOldEncoding, retNewEncoding); + return retOldEncoding; + } + + /// @notice Appends the proof metadata to the log proof as if the proof is for a batch that settled on L1. + function _appendProofMetadata(bytes32[] memory logProof) internal returns (bytes32[] memory result) { + result = new bytes32[](logProof.length + 1); + + result[0] = bytes32(bytes.concat(bytes1(0x01), bytes1(uint8(logProof.length)), bytes30(0x00))); + for (uint256 i = 0; i < logProof.length; i++) { + result[i + 1] = logProof[i]; + } + } } diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/RequestL2Transaction.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/RequestL2Transaction.t.sol similarity index 97% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/RequestL2Transaction.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/RequestL2Transaction.t.sol index 76c501013..85bcd8be8 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/RequestL2Transaction.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/RequestL2Transaction.t.sol @@ -7,8 +7,8 @@ import {BridgehubL2TransactionRequest} from "contracts/common/Messaging.sol"; import {REQUIRED_L2_GAS_PRICE_PER_PUBDATA, MAX_NEW_FACTORY_DEPS, ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; import {TransactionFiltererTrue} from "contracts/dev-contracts/test/DummyTransactionFiltererTrue.sol"; import {TransactionFiltererFalse} from "contracts/dev-contracts/test/DummyTransactionFiltererFalse.sol"; -import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZkSyncHyperchainStorage.sol"; -import {IL1SharedBridge} from "contracts/bridge/interfaces/IL1SharedBridge.sol"; +import {FeeParams, PubdataPricingMode} from "contracts/state-transition/chain-deps/ZKChainStorage.sol"; +import {IL1AssetRouter} from "contracts/bridge/asset-router/IL1AssetRouter.sol"; import {DummySharedBridge} from "contracts/dev-contracts/test/DummySharedBridge.sol"; import {OnlyEraSupported, TooManyFactoryDeps, MsgValueTooLow, GasPerPubdataMismatch} from "contracts/common/L1ContractErrors.sol"; diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/_Mailbox_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/_Mailbox_Shared.t.sol similarity index 68% rename from l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/_Mailbox_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/_Mailbox_Shared.t.sol index d0cad27b1..b1ef215d8 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/_Mailbox_Shared.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/chain-deps/facets/Mailbox/_Mailbox_Shared.t.sol @@ -3,8 +3,8 @@ pragma solidity 0.8.24; import {Test} from "forge-std/Test.sol"; -import {Utils} from "foundry-test/unit/concrete/Utils/Utils.sol"; -import {UtilsFacet} from "foundry-test/unit/concrete/Utils/UtilsFacet.sol"; +import {Utils} from "foundry-test/l1/unit/concrete/Utils/Utils.sol"; +import {UtilsFacet} from "foundry-test/l1/unit/concrete/Utils/UtilsFacet.sol"; import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; import {MailboxFacet} from "contracts/state-transition/chain-deps/facets/Mailbox.sol"; import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; @@ -15,7 +15,6 @@ import {TestnetVerifier} from "contracts/state-transition/TestnetVerifier.sol"; contract MailboxTest is Test { IMailbox internal mailboxFacet; - IGetters internal gettersFacet; UtilsFacet internal utilsFacet; IGetters internal gettersFacet; address sender; @@ -23,29 +22,13 @@ contract MailboxTest is Test { address internal testnetVerifier = address(new TestnetVerifier()); address diamondProxy; -<<<<<<< HEAD - function getMailboxSelectors() public pure returns (bytes4[] memory) { - bytes4[] memory selectors = new bytes4[](1); - selectors[0] = IMailbox.bridgehubRequestL2Transaction.selector; - return selectors; - } - - function getGettersSelectors() public pure returns (bytes4[] memory) { - bytes4[] memory selectors = new bytes4[](1); - selectors[0] = IGetters.getPriorityTreeRoot.selector; - return selectors; - } - - function setUp() public virtual { -======= - function setupDiamondProxy() public { ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + function setupDiamondProxy() public virtual { sender = makeAddr("sender"); vm.deal(sender, 100 ether); Diamond.FacetCut[] memory facetCuts = new Diamond.FacetCut[](3); facetCuts[0] = Diamond.FacetCut({ - facet: address(new MailboxFacet(eraChainId)), + facet: address(new MailboxFacet(eraChainId, block.chainid)), action: Diamond.Action.Add, isFreezable: true, selectors: Utils.getMailboxSelectors() @@ -60,11 +43,7 @@ contract MailboxTest is Test { facet: address(new GettersFacet()), action: Diamond.Action.Add, isFreezable: true, -<<<<<<< HEAD - selectors: getGettersSelectors() -======= selectors: Utils.getGettersSelectors() ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); diamondProxy = Utils.makeDiamondProxy(facetCuts, testnetVerifier); diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/data-availability/CalldataDA.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/data-availability/CalldataDA.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/data-availability/CalldataDA.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/data-availability/CalldataDA.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/data-availability/RelayedSLDAValidator.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/data-availability/RelayedSLDAValidator.t.sol similarity index 71% rename from l1-contracts/test/foundry/unit/concrete/state-transition/data-availability/RelayedSLDAValidator.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/data-availability/RelayedSLDAValidator.t.sol index d193d1e5e..9d896cf08 100644 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/data-availability/RelayedSLDAValidator.t.sol +++ b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/data-availability/RelayedSLDAValidator.t.sol @@ -8,9 +8,12 @@ import {RelayedSLDAValidator} from "contracts/state-transition/data-availability import {L1DAValidatorOutput, PubdataSource} from "contracts/state-transition/chain-interfaces/IL1DAValidator.sol"; import {L2_TO_L1_MESSENGER_SYSTEM_CONTRACT_ADDR} from "contracts/common/L2ContractAddresses.sol"; import {IL1Messenger} from "contracts/common/interfaces/IL1Messenger.sol"; +import {L2_BRIDGEHUB_ADDR} from "contracts/common/L2ContractAddresses.sol"; +import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; contract RelayedSLDAValidatorTest is Test { uint256 constant CHAIN_ID = 193; + address constant CHAIN_ADDRESS = address(0x1234); RelayedSLDAValidator daValidator; function setUp() public { @@ -21,6 +24,11 @@ contract RelayedSLDAValidatorTest is Test { abi.encodeWithSelector(IL1Messenger.sendToL1.selector), abi.encode(bytes32(0)) ); + vm.mockCall( + L2_BRIDGEHUB_ADDR, + abi.encodeWithSelector(IBridgehub.getZKChain.selector, (CHAIN_ID)), + abi.encode(CHAIN_ADDRESS) + ); } /*////////////////////////////////////////////////////////////////////////// @@ -41,8 +49,9 @@ contract RelayedSLDAValidatorTest is Test { bytes memory operatorDAInput = abi.encodePacked(daInput, l1DaInput); + vm.prank(CHAIN_ADDRESS); vm.expectRevert("l1-da-validator/invalid-pubdata-source"); - daValidator.checkDA(CHAIN_ID, l2DAValidatorOutputHash, operatorDAInput, maxBlobsSupported); + daValidator.checkDA(CHAIN_ID, 0, l2DAValidatorOutputHash, operatorDAInput, maxBlobsSupported); } function test_revertWhen_PubdataInputTooSmall() public { @@ -63,8 +72,31 @@ contract RelayedSLDAValidatorTest is Test { bytes memory operatorDAInput = abi.encodePacked(daInput, pubdataSource, l1DaInput); + vm.prank(CHAIN_ADDRESS); vm.expectRevert("pubdata too small"); - daValidator.checkDA(CHAIN_ID, l2DAValidatorOutputHash, operatorDAInput, maxBlobsSupported); + daValidator.checkDA(CHAIN_ID, 0, l2DAValidatorOutputHash, operatorDAInput, maxBlobsSupported); + } + + function test_revertWhenInvalidSender() public { + bytes memory pubdata = "verifydont"; + console.logBytes(pubdata); + + bytes32 stateDiffHash = Utils.randomBytes32("stateDiffHash"); + uint8 blobsProvided = 1; + uint256 maxBlobsSupported = 6; + bytes32 blobLinearHash = Utils.randomBytes32("blobLinearHash"); + uint8 pubdataSource = uint8(PubdataSource.Calldata); + bytes memory l1DaInput = "verifydonttrust"; + bytes32 fullPubdataHash = keccak256(pubdata); + + bytes memory daInput = abi.encodePacked(stateDiffHash, fullPubdataHash, blobsProvided, blobLinearHash); + + bytes32 l2DAValidatorOutputHash = keccak256(daInput); + + bytes memory operatorDAInput = abi.encodePacked(daInput, pubdataSource, l1DaInput); + + vm.expectRevert("l1-da-validator/invalid-sender"); + daValidator.checkDA(CHAIN_ID, 0, l2DAValidatorOutputHash, operatorDAInput, maxBlobsSupported); } function test_checkDA() public { @@ -85,8 +117,10 @@ contract RelayedSLDAValidatorTest is Test { bytes memory operatorDAInput = abi.encodePacked(daInput, pubdataSource, l1DaInput); + vm.prank(CHAIN_ADDRESS); L1DAValidatorOutput memory output = daValidator.checkDA( CHAIN_ID, + 0, l2DAValidatorOutputHash, operatorDAInput, maxBlobsSupported diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityQueue/OnEmptyQueue.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityQueue/OnEmptyQueue.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityQueue/OnEmptyQueue.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityQueue/OnEmptyQueue.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityQueue/PopOperations.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityQueue/PopOperations.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityQueue/PopOperations.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityQueue/PopOperations.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityQueue/PushOperations.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityQueue/PushOperations.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityQueue/PushOperations.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityQueue/PushOperations.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityQueue/_PriorityQueue_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityQueue/_PriorityQueue_Shared.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityQueue/_PriorityQueue_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityQueue/_PriorityQueue_Shared.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityTree/PriorityTree.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityTree/PriorityTree.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityTree/PriorityTree.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityTree/PriorityTree.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityTree/_PriorityTree_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityTree/_PriorityTree_Shared.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/libraries/PriorityTree/_PriorityTree_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/PriorityTree/_PriorityTree_Shared.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/TransactionValidator/ValidateL1L2Tx.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/TransactionValidator/ValidateL1L2Tx.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/libraries/TransactionValidator/ValidateL1L2Tx.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/TransactionValidator/ValidateL1L2Tx.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/TransactionValidator/ValidateUpgradeTransaction.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/TransactionValidator/ValidateUpgradeTransaction.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/libraries/TransactionValidator/ValidateUpgradeTransaction.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/TransactionValidator/ValidateUpgradeTransaction.t.sol diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/TransactionValidator/_TransactionValidator_Shared.t.sol b/l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/TransactionValidator/_TransactionValidator_Shared.t.sol similarity index 100% rename from l1-contracts/test/foundry/unit/concrete/state-transition/libraries/TransactionValidator/_TransactionValidator_Shared.t.sol rename to l1-contracts/test/foundry/l1/unit/concrete/state-transition/libraries/TransactionValidator/_TransactionValidator_Shared.t.sol diff --git a/l1-contracts/test/foundry/l2/unit/L2AdminFactory/L2AdminFactory.t.sol b/l1-contracts/test/foundry/l2/unit/L2AdminFactory/L2AdminFactory.t.sol new file mode 100644 index 000000000..7b85a8c54 --- /dev/null +++ b/l1-contracts/test/foundry/l2/unit/L2AdminFactory/L2AdminFactory.t.sol @@ -0,0 +1,42 @@ +// SPDX-License-Identifier: MIT + +pragma solidity ^0.8.20; + +import {Test} from "forge-std/Test.sol"; + +import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; +import {L2AdminFactory} from "contracts/governance/L2AdminFactory.sol"; +import {PermanentRestriction} from "contracts/governance/PermanentRestriction.sol"; +import {IPermanentRestriction} from "contracts/governance/IPermanentRestriction.sol"; + +contract L2AdminFactoryTest is Test { + function testL2AdminFactory() public { + address[] memory requiredRestrictions = new address[](1); + requiredRestrictions[0] = makeAddr("required"); + + L2AdminFactory factory = new L2AdminFactory(requiredRestrictions); + + address[] memory additionalRestrictions = new address[](1); + additionalRestrictions[0] = makeAddr("additional"); + + address[] memory allRestrictions = new address[](2); + allRestrictions[0] = requiredRestrictions[0]; + allRestrictions[1] = additionalRestrictions[0]; + + bytes32 salt = keccak256("salt"); + + address admin = factory.deployAdmin(additionalRestrictions, salt); + + // Now, we need to check whether it would be able to accept such an admin + PermanentRestriction restriction = new PermanentRestriction(IBridgehub(address(0)), address(factory)); + + bytes32 codeHash; + assembly { + codeHash := extcodehash(admin) + } + + vm.expectEmit(true, false, false, true); + emit IPermanentRestriction.AllowL2Admin(admin); + restriction.allowL2Admin(salt, codeHash, keccak256(abi.encode(allRestrictions))); + } +} diff --git a/l1-contracts/test/foundry/l2/unit/erc20/L2Erc20BridgeTest.t.sol b/l1-contracts/test/foundry/l2/unit/erc20/L2Erc20BridgeTest.t.sol new file mode 100644 index 000000000..1b9535108 --- /dev/null +++ b/l1-contracts/test/foundry/l2/unit/erc20/L2Erc20BridgeTest.t.sol @@ -0,0 +1,137 @@ +// SPDX-License-Identifier: MIT + +pragma solidity ^0.8.20; + +// solhint-disable gas-custom-errors + +import {Test} from "forge-std/Test.sol"; +import "forge-std/console.sol"; + +import {BridgedStandardERC20} from "contracts/bridge/BridgedStandardERC20.sol"; +import {L2AssetRouter} from "contracts/bridge/asset-router/L2AssetRouter.sol"; +import {IL2NativeTokenVault} from "contracts/bridge/ntv/IL2NativeTokenVault.sol"; + +import {UpgradeableBeacon} from "@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol"; +import {BeaconProxy} from "@openzeppelin/contracts-v4/proxy/beacon/BeaconProxy.sol"; + +import {L2_ASSET_ROUTER_ADDR, L2_NATIVE_TOKEN_VAULT_ADDR} from "contracts/common/L2ContractAddresses.sol"; + +import {AddressAliasHelper} from "contracts/vendor/AddressAliasHelper.sol"; + +import {L2Utils} from "../utils/L2Utils.sol"; + +contract L2Erc20BridgeTest is Test { + // We need to emulate a L1->L2 transaction from the L1 bridge to L2 counterpart. + // It is a bit easier to use EOA and it is sufficient for the tests. + address internal l1BridgeWallet = address(1); + address internal aliasedL1BridgeWallet; + + // The owner of the beacon and the native token vault + address internal ownerWallet = address(2); + + BridgedStandardERC20 internal standardErc20Impl; + + UpgradeableBeacon internal beacon; + BeaconProxy internal proxy; + + uint256 internal constant L1_CHAIN_ID = 9; + uint256 internal ERA_CHAIN_ID = 270; + + // We won't actually deploy an L1 token in these tests, but we need some address for it. + address internal L1_TOKEN_ADDRESS = 0x1111100000000000000000000000000000011111; + + string internal constant TOKEN_DEFAULT_NAME = "TestnetERC20Token"; + string internal constant TOKEN_DEFAULT_SYMBOL = "TET"; + uint8 internal constant TOKEN_DEFAULT_DECIMALS = 18; + + function setUp() public { + aliasedL1BridgeWallet = AddressAliasHelper.applyL1ToL2Alias(l1BridgeWallet); + + standardErc20Impl = new BridgedStandardERC20(); + beacon = new UpgradeableBeacon(address(standardErc20Impl)); + beacon.transferOwnership(ownerWallet); + + // One of the purposes of deploying it here is to publish its bytecode + BeaconProxy beaconProxy = new BeaconProxy(address(beacon), new bytes(0)); + proxy = beaconProxy; + bytes32 beaconProxyBytecodeHash; + assembly { + beaconProxyBytecodeHash := extcodehash(beaconProxy) + } + + L2Utils.initSystemContracts(); + L2Utils.forceDeployAssetRouter(L1_CHAIN_ID, ERA_CHAIN_ID, l1BridgeWallet, address(0)); + L2Utils.forceDeployNativeTokenVault({ + _l1ChainId: L1_CHAIN_ID, + _aliasedOwner: ownerWallet, + _l2TokenProxyBytecodeHash: beaconProxyBytecodeHash, + _legacySharedBridge: address(0), + _l2TokenBeacon: address(beacon), + _contractsDeployedAlready: true + }); + } + + function performDeposit(address depositor, address receiver, uint256 amount) internal { + vm.prank(aliasedL1BridgeWallet); + L2AssetRouter(L2_ASSET_ROUTER_ADDR).finalizeDeposit({ + _l1Sender: depositor, + _l2Receiver: receiver, + _l1Token: L1_TOKEN_ADDRESS, + _amount: amount, + _data: L2Utils.encodeTokenData(TOKEN_DEFAULT_NAME, TOKEN_DEFAULT_SYMBOL, TOKEN_DEFAULT_DECIMALS) + }); + } + + function initializeTokenByDeposit() internal returns (address l2TokenAddress) { + performDeposit(makeAddr("someDepositor"), makeAddr("someReeiver"), 1); + + l2TokenAddress = IL2NativeTokenVault(L2_NATIVE_TOKEN_VAULT_ADDR).l2TokenAddress(L1_TOKEN_ADDRESS); + require(l2TokenAddress != address(0), "Token not initialized"); + } + + function test_shouldFinalizeERC20Deposit() public { + address depositor = makeAddr("depositor"); + address receiver = makeAddr("receiver"); + + performDeposit(depositor, receiver, 100); + + address l2TokenAddress = IL2NativeTokenVault(L2_NATIVE_TOKEN_VAULT_ADDR).l2TokenAddress(L1_TOKEN_ADDRESS); + + assertEq(BridgedStandardERC20(l2TokenAddress).balanceOf(receiver), 100); + assertEq(BridgedStandardERC20(l2TokenAddress).totalSupply(), 100); + assertEq(BridgedStandardERC20(l2TokenAddress).name(), TOKEN_DEFAULT_NAME); + assertEq(BridgedStandardERC20(l2TokenAddress).symbol(), TOKEN_DEFAULT_SYMBOL); + assertEq(BridgedStandardERC20(l2TokenAddress).decimals(), TOKEN_DEFAULT_DECIMALS); + } + + function test_governanceShouldBeAbleToReinitializeToken() public { + address l2TokenAddress = initializeTokenByDeposit(); + + BridgedStandardERC20.ERC20Getters memory getters = BridgedStandardERC20.ERC20Getters({ + ignoreName: false, + ignoreSymbol: false, + ignoreDecimals: false + }); + + vm.prank(ownerWallet); + BridgedStandardERC20(l2TokenAddress).reinitializeToken(getters, "TestTokenNewName", "TTN", 2); + assertEq(BridgedStandardERC20(l2TokenAddress).name(), "TestTokenNewName"); + assertEq(BridgedStandardERC20(l2TokenAddress).symbol(), "TTN"); + // The decimals should stay the same + assertEq(BridgedStandardERC20(l2TokenAddress).decimals(), 18); + } + + function test_governanceShouldNotBeAbleToSkipInitializerVersions() public { + address l2TokenAddress = initializeTokenByDeposit(); + + BridgedStandardERC20.ERC20Getters memory getters = BridgedStandardERC20.ERC20Getters({ + ignoreName: false, + ignoreSymbol: false, + ignoreDecimals: false + }); + + vm.expectRevert(); + vm.prank(ownerWallet); + BridgedStandardERC20(l2TokenAddress).reinitializeToken(getters, "TestTokenNewName", "TTN", 20); + } +} diff --git a/l1-contracts/test/foundry/l2/unit/utils/L2Utils.sol b/l1-contracts/test/foundry/l2/unit/utils/L2Utils.sol new file mode 100644 index 000000000..2c46774f4 --- /dev/null +++ b/l1-contracts/test/foundry/l2/unit/utils/L2Utils.sol @@ -0,0 +1,167 @@ +// SPDX-License-Identifier: MIT + +pragma solidity ^0.8.20; + +import {Vm} from "forge-std/Vm.sol"; + +import {DEPLOYER_SYSTEM_CONTRACT, L2_ASSET_ROUTER_ADDR, L2_NATIVE_TOKEN_VAULT_ADDR} from "contracts/common/L2ContractAddresses.sol"; +import {IContractDeployer, L2ContractHelper} from "contracts/common/libraries/L2ContractHelper.sol"; + +import {L2AssetRouter} from "contracts/bridge/asset-router/L2AssetRouter.sol"; +import {L2NativeTokenVault} from "contracts/bridge/ntv/L2NativeTokenVault.sol"; + +import {ETH_TOKEN_ADDRESS} from "contracts/common/Config.sol"; + +import {DataEncoding} from "contracts/common/libraries/DataEncoding.sol"; + +library L2Utils { + address internal constant VM_ADDRESS = address(uint160(uint256(keccak256("hevm cheat code")))); + Vm internal constant vm = Vm(VM_ADDRESS); + + address internal constant L2_FORCE_DEPLOYER_ADDR = address(0x8007); + + string internal constant L2_ASSET_ROUTER_PATH = "./zkout/L2AssetRouter.sol/L2AssetRouter.json"; + string internal constant L2_NATIVE_TOKEN_VAULT_PATH = "./zkout/L2NativeTokenVault.sol/L2NativeTokenVault.json"; + + /// @notice Returns the bytecode of a given era contract from a `zkout` folder. + function readEraBytecode(string memory _filename) internal returns (bytes memory bytecode) { + string memory artifact = vm.readFile( + // solhint-disable-next-line func-named-parameters + string.concat("./zkout/", _filename, ".sol/", _filename, ".json") + ); + + bytecode = vm.parseJsonBytes(artifact, ".bytecode.object"); + } + + /// @notice Returns the bytecode of a given system contract. + function readSystemContractsBytecode(string memory _filename) internal view returns (bytes memory) { + string memory file = vm.readFile( + // solhint-disable-next-line func-named-parameters + string.concat( + "../system-contracts/artifacts-zk/contracts-preprocessed/", + _filename, + ".sol/", + _filename, + ".json" + ) + ); + bytes memory bytecode = vm.parseJson(file, "$.bytecode"); + return bytecode; + } + + /** + * @dev Initializes the system contracts. + * @dev It is a hack needed to make the tests be able to call system contracts directly. + */ + function initSystemContracts() internal { + bytes memory contractDeployerBytecode = readSystemContractsBytecode("ContractDeployer"); + vm.etch(DEPLOYER_SYSTEM_CONTRACT, contractDeployerBytecode); + } + + /// @notice Deploys the L2AssetRouter contract. + /// @param _l1ChainId The chain ID of the L1 chain. + /// @param _eraChainId The chain ID of the era chain. + /// @param _l1AssetRouter The address of the L1 asset router. + /// @param _legacySharedBridge The address of the legacy shared bridge. + function forceDeployAssetRouter( + uint256 _l1ChainId, + uint256 _eraChainId, + address _l1AssetRouter, + address _legacySharedBridge + ) internal { + // to ensure that the bytecode is known + bytes32 ethAssetId = DataEncoding.encodeNTVAssetId(_l1ChainId, ETH_TOKEN_ADDRESS); + { + new L2AssetRouter(_l1ChainId, _eraChainId, _l1AssetRouter, _legacySharedBridge, ethAssetId); + } + + bytes memory bytecode = readEraBytecode("L2AssetRouter"); + + bytes32 bytecodehash = L2ContractHelper.hashL2Bytecode(bytecode); + + IContractDeployer.ForceDeployment[] memory deployments = new IContractDeployer.ForceDeployment[](1); + deployments[0] = IContractDeployer.ForceDeployment({ + bytecodeHash: bytecodehash, + newAddress: L2_ASSET_ROUTER_ADDR, + callConstructor: true, + value: 0, + input: abi.encode(_l1ChainId, _eraChainId, _l1AssetRouter, _legacySharedBridge, ethAssetId) + }); + + vm.prank(L2_FORCE_DEPLOYER_ADDR); + IContractDeployer(DEPLOYER_SYSTEM_CONTRACT).forceDeployOnAddresses(deployments); + } + + /// @notice Deploys the L2NativeTokenVault contract. + /// @param _l1ChainId The chain ID of the L1 chain. + /// @param _aliasedOwner The address of the aliased owner. + /// @param _l2TokenProxyBytecodeHash The hash of the L2 token proxy bytecode. + /// @param _legacySharedBridge The address of the legacy shared bridge. + /// @param _l2TokenBeacon The address of the L2 token beacon. + /// @param _contractsDeployedAlready Whether the contracts are deployed already. + function forceDeployNativeTokenVault( + uint256 _l1ChainId, + address _aliasedOwner, + bytes32 _l2TokenProxyBytecodeHash, + address _legacySharedBridge, + address _l2TokenBeacon, + bool _contractsDeployedAlready + ) internal { + // to ensure that the bytecode is known + bytes32 ethAssetId = DataEncoding.encodeNTVAssetId(_l1ChainId, ETH_TOKEN_ADDRESS); + { + new L2NativeTokenVault({ + _l1ChainId: _l1ChainId, + _aliasedOwner: _aliasedOwner, + _l2TokenProxyBytecodeHash: _l2TokenProxyBytecodeHash, + _legacySharedBridge: _legacySharedBridge, + _bridgedTokenBeacon: _l2TokenBeacon, + _contractsDeployedAlready: _contractsDeployedAlready, + _wethToken: address(0), + _baseTokenAssetId: ethAssetId + }); + } + + bytes memory bytecode = readEraBytecode("L2NativeTokenVault"); + + bytes32 bytecodehash = L2ContractHelper.hashL2Bytecode(bytecode); + + IContractDeployer.ForceDeployment[] memory deployments = new IContractDeployer.ForceDeployment[](1); + deployments[0] = IContractDeployer.ForceDeployment({ + bytecodeHash: bytecodehash, + newAddress: L2_NATIVE_TOKEN_VAULT_ADDR, + callConstructor: true, + value: 0, + // solhint-disable-next-line func-named-parameters + input: abi.encode( + _l1ChainId, + _aliasedOwner, + _l2TokenProxyBytecodeHash, + _legacySharedBridge, + _l2TokenBeacon, + _contractsDeployedAlready, + address(0), + ethAssetId + ) + }); + + vm.prank(L2_FORCE_DEPLOYER_ADDR); + IContractDeployer(DEPLOYER_SYSTEM_CONTRACT).forceDeployOnAddresses(deployments); + } + + /// @notice Encodes the token data. + /// @param name The name of the token. + /// @param symbol The symbol of the token. + /// @param decimals The decimals of the token. + function encodeTokenData( + string memory name, + string memory symbol, + uint8 decimals + ) internal pure returns (bytes memory) { + bytes memory encodedName = abi.encode(name); + bytes memory encodedSymbol = abi.encode(symbol); + bytes memory encodedDecimals = abi.encode(decimals); + + return abi.encode(encodedName, encodedSymbol, encodedDecimals); + } +} diff --git a/l1-contracts/test/foundry/l2/unit/weth/WETH.t.sol b/l1-contracts/test/foundry/l2/unit/weth/WETH.t.sol new file mode 100644 index 000000000..6cbc44fa7 --- /dev/null +++ b/l1-contracts/test/foundry/l2/unit/weth/WETH.t.sol @@ -0,0 +1,118 @@ +// SPDX-License-Identifier: MIT + +pragma solidity ^0.8.20; + +import {Test} from "forge-std/Test.sol"; + +import {L2WrappedBaseToken} from "contracts/bridge/L2WrappedBaseToken.sol"; +import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; + +import {Unauthorized, UnimplementedMessage, BridgeMintNotImplemented} from "contracts/common/L1ContractErrors.sol"; + +contract WethTest is Test { + L2WrappedBaseToken internal weth; + + // The owner of the proxy + address internal ownerWallet = address(2); + + address internal l2BridgeAddress = address(3); + address internal l1Address = address(4); + + function setUp() public { + ownerWallet = makeAddr("owner"); + L2WrappedBaseToken impl = new L2WrappedBaseToken(); + + TransparentUpgradeableProxy proxy = new TransparentUpgradeableProxy(address(impl), ownerWallet, ""); + + weth = L2WrappedBaseToken(payable(proxy)); + + weth.initializeV2("Wrapped Ether", "WETH", l2BridgeAddress, l1Address); + } + + function test_shouldDepositWethByCallingDeposit() public { + uint256 amount = 100; + weth.deposit{value: amount}(); + assertEq(weth.balanceOf(address(this)), amount); + } + + function test_shouldDepositWethBySendingEth() public { + uint256 amount = 100; + address(weth).call{value: amount}(""); + assertEq(weth.balanceOf(address(this)), amount); + } + + function test_revertWhenDepositingWithRandomCalldata() public { + (bool success, ) = address(weth).call{value: 100}(hex"00000000"); + assertEq(success, false); + } + + function test_shouldWithdrawWethToL2Eth() public { + address sender = makeAddr("sender"); + uint256 amount = 100; + + vm.deal(sender, amount); + + vm.prank(sender); + weth.deposit{value: amount}(); + + vm.prank(sender); + weth.withdraw(amount); + + assertEq(weth.balanceOf(sender), 0); + assertEq(address(sender).balance, amount); + } + + function test_shouldDepositWethToAnotherAccount() public { + address sender = makeAddr("sender"); + address receiver = makeAddr("receiver"); + + uint256 amount = 100; + + vm.deal(sender, amount); + + vm.prank(sender); + weth.depositTo{value: amount}(receiver); + + assertEq(weth.balanceOf(receiver), amount); + assertEq(weth.balanceOf(sender), 0); + } + + function test_shouldWithdrawWethToAnotherAccount() public { + address sender = makeAddr("sender"); + address receiver = makeAddr("receiver"); + + uint256 amount = 100; + + vm.deal(sender, amount); + + vm.prank(sender); + weth.deposit{value: amount}(); + + vm.prank(sender); + weth.withdrawTo(receiver, amount); + + assertEq(receiver.balance, amount); + assertEq(sender.balance, 0); + } + + function test_revertWhenWithdrawingMoreThanBalance() public { + vm.expectRevert(); + weth.withdraw(1); + } + + function test_revertWhenCallingBridgeMint() public { + vm.expectRevert(abi.encodeWithSelector(BridgeMintNotImplemented.selector)); + vm.prank(l2BridgeAddress); + weth.bridgeMint(address(1), 1); + } + + function test_revertWhenCallingBridgeMintDirectly() public { + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, address(this))); + weth.bridgeMint(address(1), 1); + } + + function test_revertWhenCallingBridgeBurnDirectly() public { + vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, address(this))); + weth.bridgeBurn(address(1), 1); + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/ClaimFailedDeposit.t.sol b/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/ClaimFailedDeposit.t.sol deleted file mode 100644 index e434dd8f4..000000000 --- a/l1-contracts/test/foundry/unit/concrete/Bridges/L1Erc20Bridge/ClaimFailedDeposit.t.sol +++ /dev/null @@ -1,83 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {L1Erc20BridgeTest} from "./_L1Erc20Bridge_Shared.t.sol"; -import {StdStorage, stdStorage} from "forge-std/Test.sol"; -import {IL1SharedBridge} from "contracts/bridge/interfaces/IL1SharedBridge.sol"; -import {EmptyDeposit} from "contracts/common/L1ContractErrors.sol"; - -contract ClaimFailedDepositTest is L1Erc20BridgeTest { - using stdStorage for StdStorage; - - event ClaimedFailedDeposit(address indexed to, address indexed l1Token, uint256 amount); - - function test_RevertWhen_ClaimAmountIsZero() public { - vm.expectRevert(EmptyDeposit.selector); - bytes32[] memory merkleProof; - - bridge.claimFailedDeposit({ - _depositSender: randomSigner, - _l1Token: address(token), - _l2TxHash: bytes32(""), - _l2BatchNumber: 0, - _l2MessageIndex: 0, - _l2TxNumberInBatch: 0, - _merkleProof: merkleProof - }); - } - - function test_claimFailedDepositSuccessfully() public { - uint256 amount = 16; - bytes32 l2DepositTxHash = keccak256("l2tx"); - bytes32[] memory merkleProof; - - uint256 depositedAmountBefore = bridge.depositAmount(alice, address(token), l2DepositTxHash); - assertEq(depositedAmountBefore, 0); - - stdstore - .target(address(bridge)) - .sig("depositAmount(address,address,bytes32)") - .with_key(alice) - .with_key(address(token)) - .with_key(l2DepositTxHash) - .checked_write(amount); - - uint256 depositedAmountAfterDeposit = bridge.depositAmount(alice, address(token), l2DepositTxHash); - assertEq(depositedAmountAfterDeposit, amount); - - vm.mockCall( - sharedBridgeAddress, - abi.encodeWithSelector( - IL1SharedBridge.claimFailedDepositLegacyErc20Bridge.selector, - alice, - address(token), - amount, - l2DepositTxHash, - 0, - 0, - 0, - merkleProof - ), - abi.encode("") - ); - - vm.prank(alice); - // solhint-disable-next-line func-named-parameters - vm.expectEmit(true, true, true, true, address(bridge)); - emit ClaimedFailedDeposit(alice, address(token), amount); - - bridge.claimFailedDeposit({ - _depositSender: alice, - _l1Token: address(token), - _l2TxHash: l2DepositTxHash, - _l2BatchNumber: 0, - _l2MessageIndex: 0, - _l2TxNumberInBatch: 0, - _merkleProof: merkleProof - }); - - uint256 depositedAmountAfterWithdrawal = bridge.depositAmount(alice, address(token), l2DepositTxHash); - assertEq(depositedAmountAfterWithdrawal, 0); - } -} diff --git a/l1-contracts/test/foundry/unit/concrete/GatewayTransactionFilterer/CheckTransaction.sol b/l1-contracts/test/foundry/unit/concrete/GatewayTransactionFilterer/CheckTransaction.sol new file mode 100644 index 000000000..3231a7144 --- /dev/null +++ b/l1-contracts/test/foundry/unit/concrete/GatewayTransactionFilterer/CheckTransaction.sol @@ -0,0 +1,89 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {GatewayTransactionFiltererTest} from "./_GatewayTransactionFilterer_Shared.t.sol"; + +import {IGetters} from "contracts/state-transition/chain-interfaces/IGetters.sol"; +import {IL2Bridge} from "contracts/bridge/interfaces/IL2Bridge.sol"; +import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; +import {AlreadyWhitelisted, InvalidSelector, NotWhitelisted} from "contracts/common/L1ContractErrors.sol"; + +contract CheckTransactionTest is GatewayTransactionFiltererTest { + function test_TransactionAllowedOnlyFromWhitelistedSenderWhichIsNotAssetRouter() public { + bytes memory txCalladata = abi.encodeCall(IL2Bridge.finalizeDeposit, (bytes32("0x12345"), bytes("0x23456"))); + vm.startPrank(owner); + vm.mockCall( + bridgehub, + abi.encodeWithSelector(IBridgehub.ctmAssetIdToAddress.selector), + abi.encode(address(0)) // Return any address + ); + bool isTxAllowed = transactionFiltererProxy.isTransactionAllowed( + sender, + address(0), + 0, + 0, + txCalladata, + address(0) + ); // Other arguments do not make a difference for the test + + assertEq(isTxAllowed, false, "Transaction should not be allowed"); + + transactionFiltererProxy.grantWhitelist(sender); + isTxAllowed = transactionFiltererProxy.isTransactionAllowed(sender, address(0), 0, 0, txCalladata, address(0)); // Other arguments do not make a difference for the test + + assertEq(isTxAllowed, true, "Transaction should be allowed"); + + transactionFiltererProxy.grantWhitelist(assetRouter); + isTxAllowed = transactionFiltererProxy.isTransactionAllowed( + assetRouter, + address(0), + 0, + 0, + txCalladata, + address(0) + ); // Other arguments do not make a difference for the test + + assertEq(isTxAllowed, false, "Transaction should not be allowed"); + + vm.stopPrank(); + } + + function test_TransactionAllowedFromWhitelistedSenderForChainBridging() public { + address stm = address(0x6060606); + bytes memory txCalladata = abi.encodeCall(IL2Bridge.finalizeDeposit, (bytes32("0x12345"), bytes("0x23456"))); + vm.startPrank(owner); + vm.mockCall( + bridgehub, + abi.encodeWithSelector(IBridgehub.ctmAssetIdToAddress.selector), + abi.encode(stm) // Return random address + ); + + transactionFiltererProxy.grantWhitelist(assetRouter); + bool isTxAllowed = transactionFiltererProxy.isTransactionAllowed( + assetRouter, + address(0), + 0, + 0, + txCalladata, + address(0) + ); // Other arguments do not make a difference for the test + + assertEq(isTxAllowed, true, "Transaction should be allowed"); + + vm.stopPrank(); + } + + function test_TransactionFailsWithInvalidSelectorEvenIfTheSenderIsAR() public { + bytes memory txCalladata = abi.encodeCall(IL2Bridge.withdraw, (bytes32("0x12345"), bytes("0x23456"))); + vm.prank(owner); + vm.expectRevert(abi.encodeWithSelector(InvalidSelector.selector, IL2Bridge.withdraw.selector)); + bool isTxAllowed = transactionFiltererProxy.isTransactionAllowed( + assetRouter, + address(0), + 0, + 0, + txCalladata, + address(0) + ); // Other arguments do not make a difference for the test + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/GatewayTransactionFilterer/ManageWhitelist.sol b/l1-contracts/test/foundry/unit/concrete/GatewayTransactionFilterer/ManageWhitelist.sol new file mode 100644 index 000000000..be176e150 --- /dev/null +++ b/l1-contracts/test/foundry/unit/concrete/GatewayTransactionFilterer/ManageWhitelist.sol @@ -0,0 +1,37 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {GatewayTransactionFiltererTest} from "./_GatewayTransactionFilterer_Shared.t.sol"; + +import {AlreadyWhitelisted, NotWhitelisted} from "contracts/common/L1ContractErrors.sol"; + +contract ManageWhitelistTest is GatewayTransactionFiltererTest { + function test_GrantingWhitelistToSender() public { + vm.startPrank(owner); + transactionFiltererProxy.grantWhitelist(sender); + + assertEq( + transactionFiltererProxy.whitelistedSenders(sender), + true, + "Whitelisting of sender was not successful" + ); + + vm.expectRevert(abi.encodeWithSelector(AlreadyWhitelisted.selector, sender)); + transactionFiltererProxy.grantWhitelist(sender); + } + + function test_RevokeWhitelistFromSender() public { + vm.startPrank(owner); + vm.expectRevert(abi.encodeWithSelector(NotWhitelisted.selector, sender)); + transactionFiltererProxy.revokeWhitelist(sender); + + transactionFiltererProxy.grantWhitelist(sender); + transactionFiltererProxy.revokeWhitelist(sender); + + assertEq( + transactionFiltererProxy.whitelistedSenders(sender), + false, + "Revoking the sender from whitelist was not successful" + ); + } +} diff --git a/l1-contracts/test/foundry/unit/concrete/GatewayTransactionFilterer/_GatewayTransactionFilterer_Shared.t.sol b/l1-contracts/test/foundry/unit/concrete/GatewayTransactionFilterer/_GatewayTransactionFilterer_Shared.t.sol new file mode 100644 index 000000000..1b3646ccb --- /dev/null +++ b/l1-contracts/test/foundry/unit/concrete/GatewayTransactionFilterer/_GatewayTransactionFilterer_Shared.t.sol @@ -0,0 +1,38 @@ +// SPDX-License-Identifier: MIT + +pragma solidity ^0.8.21; + +import {Test} from "forge-std/Test.sol"; + +import {TransparentUpgradeableProxy} from "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol"; + +import {IBridgehub} from "contracts/bridgehub/IBridgehub.sol"; + +import {GatewayTransactionFilterer} from "contracts/transactionFilterer/GatewayTransactionFilterer.sol"; + +contract GatewayTransactionFiltererTest is Test { + GatewayTransactionFilterer internal transactionFiltererProxy; + GatewayTransactionFilterer internal transactionFiltererImplementation; + address internal constant owner = address(0x1010101); + address internal constant admin = address(0x2020202); + address internal constant sender = address(0x3030303); + address internal constant bridgehub = address(0x5050505); + address internal constant assetRouter = address(0x4040404); + + constructor() { + transactionFiltererImplementation = new GatewayTransactionFilterer(IBridgehub(bridgehub), assetRouter); + + transactionFiltererProxy = GatewayTransactionFilterer( + address( + new TransparentUpgradeableProxy( + address(transactionFiltererImplementation), + admin, + abi.encodeCall(GatewayTransactionFilterer.initialize, owner) + ) + ) + ); + } + + // add this to be excluded from coverage report + function test() internal virtual {} +} diff --git a/l1-contracts/test/foundry/unit/concrete/Verifier/VerifierRecursive.t.sol b/l1-contracts/test/foundry/unit/concrete/Verifier/VerifierRecursive.t.sol deleted file mode 100644 index 69bad2303..000000000 --- a/l1-contracts/test/foundry/unit/concrete/Verifier/VerifierRecursive.t.sol +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity 0.8.24; - -import {VerifierTestTest} from "./Verifier.t.sol"; -import {VerifierRecursiveTest} from "contracts/dev-contracts/test/VerifierRecursiveTest.sol"; - -contract VerifierRecursiveTestTest is VerifierTestTest { - function setUp() public override { - super.setUp(); - - recursiveAggregationInput.push(2257920826825449939414463854743099397427742128922725774525544832270890253504); - recursiveAggregationInput.push(9091218701914748532331969127001446391756173432977615061129552313204917562530); - recursiveAggregationInput.push(16188304989094043810949359833767911976672882599560690320245309499206765021563); - recursiveAggregationInput.push(3201093556796962656759050531176732990872300033146738631772984017549903765305); - - verifier = new VerifierRecursiveTest(); - } - - function testMoreThan4WordsRecursiveInput_shouldRevert() public { - uint256[] memory newRecursiveAggregationInput = new uint256[](recursiveAggregationInput.length + 1); - - for (uint256 i = 0; i < recursiveAggregationInput.length; i++) { - newRecursiveAggregationInput[i] = recursiveAggregationInput[i]; - } - newRecursiveAggregationInput[newRecursiveAggregationInput.length - 1] = recursiveAggregationInput[ - recursiveAggregationInput.length - 1 - ]; - - vm.expectRevert(bytes("loadProof: Proof is invalid")); - verifier.verify(publicInputs, serializedProof, newRecursiveAggregationInput); - } - - function testEmptyRecursiveInput_shouldRevert() public { - uint256[] memory newRecursiveAggregationInput; - - vm.expectRevert(bytes("loadProof: Proof is invalid")); - verifier.verify(publicInputs, serializedProof, newRecursiveAggregationInput); - } - - function testInvalidRecursiveInput_shouldRevert() public { - uint256[] memory newRecursiveAggregationInput = new uint256[](4); - newRecursiveAggregationInput[0] = 1; - newRecursiveAggregationInput[1] = 2; - newRecursiveAggregationInput[2] = 1; - newRecursiveAggregationInput[3] = 2; - - vm.expectRevert(bytes("finalPairing: pairing failure")); - verifier.verify(publicInputs, serializedProof, newRecursiveAggregationInput); - } - - function testVerificationKeyHash() public override { - bytes32 verificationKeyHash = verifier.verificationKeyHash(); - assertEq(verificationKeyHash, 0x88b3ddc4ed85974c7e14297dcad4097169440305c05fdb6441ca8dfd77cd7fa7); - } -} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/FreezeChain.t.sol b/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/FreezeChain.t.sol deleted file mode 100644 index 8dfa4de1a..000000000 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/StateTransitionManager/FreezeChain.t.sol +++ /dev/null @@ -1,50 +0,0 @@ -// // SPDX-License-Identifier: MIT -pragma solidity 0.8.24; - -import {StateTransitionManagerTest} from "./_StateTransitionManager_Shared.t.sol"; -import {GettersFacet} from "contracts/state-transition/chain-deps/facets/Getters.sol"; -import {IAdmin} from "contracts/state-transition/chain-interfaces/IAdmin.sol"; -import {FacetIsFrozen} from "contracts/common/L1ContractErrors.sol"; - -contract freezeChainTest is StateTransitionManagerTest { -<<<<<<< HEAD - // function test_FreezingChain() public { - // createNewChain(getDiamondCutData(diamondInit)); - // address newChainAddress = chainContractAddress.getHyperchain(chainId); - // GettersFacet gettersFacet = GettersFacet(newChainAddress); - // bool isChainFrozen = gettersFacet.isDiamondStorageFrozen(); - // assertEq(isChainFrozen, false); - // vm.stopPrank(); - // vm.startPrank(governor); - // chainContractAddress.freezeChain(block.chainid); - // // Repeated call should revert - // vm.expectRevert(bytes.concat("q1")); // storage frozen - // chainContractAddress.freezeChain(block.chainid); - // // Call fails as storage is frozen - // vm.expectRevert(bytes.concat("q1")); - // isChainFrozen = gettersFacet.isDiamondStorageFrozen(); - // } -======= - function test_FreezingChain() public { - createNewChain(getDiamondCutData(diamondInit)); - - address newChainAddress = chainContractAddress.getHyperchain(chainId); - GettersFacet gettersFacet = GettersFacet(newChainAddress); - bool isChainFrozen = gettersFacet.isDiamondStorageFrozen(); - assertEq(isChainFrozen, false); - - vm.stopPrank(); - vm.startPrank(governor); - - chainContractAddress.freezeChain(block.chainid); - - // Repeated call should revert - vm.expectRevert(bytes("q1")); // storage frozen - chainContractAddress.freezeChain(block.chainid); - - // Call fails as storage is frozen - vm.expectRevert(bytes("q1")); - isChainFrozen = gettersFacet.isDiamondStorageFrozen(); - } ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe -} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernorOrStateTransitionManager.t.sol b/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernorOrStateTransitionManager.t.sol deleted file mode 100644 index 2c4062d5b..000000000 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyGovernorOrStateTransitionManager.t.sol +++ /dev/null @@ -1,38 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {ZkSyncHyperchainBaseTest} from "./_Base_Shared.t.sol"; -import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; - -contract OnlyAdminOrStateTransitionManagerTest is ZkSyncHyperchainBaseTest { - function test_revertWhen_calledByNonAdmin() public { - address nonAdmin = makeAddr("nonAdmin"); - - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonAdmin)); - vm.startPrank(nonAdmin); - testBaseFacet.functionWithOnlyAdminOrStateTransitionManagerModifier(); - } - - function test_revertWhen_calledByNonStateTransitionManager() public { - address nonStateTransitionManager = makeAddr("nonStateTransitionManager"); - - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonStateTransitionManager)); - vm.startPrank(nonStateTransitionManager); - testBaseFacet.functionWithOnlyAdminOrStateTransitionManagerModifier(); - } - - function test_successfulCallWhenCalledByAdmin() public { - address admin = utilsFacet.util_getAdmin(); - - vm.startPrank(admin); - testBaseFacet.functionWithOnlyAdminOrStateTransitionManagerModifier(); - } - - function test_successfulCallWhenCalledByStateTransitionManager() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); - - vm.startPrank(stateTransitionManager); - testBaseFacet.functionWithOnlyAdminOrStateTransitionManagerModifier(); - } -} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyStateTransitionManager.t.sol b/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyStateTransitionManager.t.sol deleted file mode 100644 index a93032c90..000000000 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Base/OnlyStateTransitionManager.t.sol +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {ZkSyncHyperchainBaseTest} from "./_Base_Shared.t.sol"; -import {Unauthorized} from "contracts/common/L1ContractErrors.sol"; - -contract OnlyStateTransitionManagerTest is ZkSyncHyperchainBaseTest { - function test_revertWhen_calledByNonStateTransitionManager() public { - address nonStateTransitionManager = makeAddr("nonStateTransitionManager"); - - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, nonStateTransitionManager)); - vm.startPrank(nonStateTransitionManager); - testBaseFacet.functionWithOnlyStateTransitionManagerModifier(); - } - - function test_successfulCall() public { - address stateTransitionManager = utilsFacet.util_getStateTransitionManager(); - - vm.startPrank(stateTransitionManager); - testBaseFacet.functionWithOnlyStateTransitionManagerModifier(); - } -} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetStateTransitionManager.t.sol b/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetStateTransitionManager.t.sol deleted file mode 100644 index 9b3038f97..000000000 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/GetStateTransitionManager.t.sol +++ /dev/null @@ -1,16 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {GettersFacetTest} from "./_Getters_Shared.t.sol"; - -contract GetStateTransitionManagerTest is GettersFacetTest { - function test() public { - address expected = makeAddr("stateTransitionManager"); - gettersFacetWrapper.util_setStateTransitionManager(expected); - - address received = gettersFacet.getStateTransitionManager(); - - assertEq(expected, received, "StateTransitionManager address is incorrect"); - } -} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/PriorityQueueFrontOperation.t.sol b/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/PriorityQueueFrontOperation.t.sol deleted file mode 100644 index ac8ccfeaa..000000000 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Getters/PriorityQueueFrontOperation.t.sol +++ /dev/null @@ -1,30 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {GettersFacetTest} from "./_Getters_Shared.t.sol"; -import {PriorityOperation} from "contracts/state-transition/libraries/PriorityQueue.sol"; -import {QueueIsEmpty} from "contracts/common/L1ContractErrors.sol"; - -contract GetPriorityQueueFrontOperationTest is GettersFacetTest { - function test_revertWhen_queueIsEmpty() public { - vm.expectRevert(QueueIsEmpty.selector); - gettersFacet.priorityQueueFrontOperation(); - } - - function test() public { - PriorityOperation memory expected = PriorityOperation({ - canonicalTxHash: bytes32(uint256(1)), - expirationTimestamp: uint64(2), - layer2Tip: uint192(3) - }); - - gettersFacetWrapper.util_setPriorityQueueFrontOperation(expected); - - PriorityOperation memory received = gettersFacet.priorityQueueFrontOperation(); - - bytes32 expectedHash = keccak256(abi.encode(expected)); - bytes32 receivedHash = keccak256(abi.encode(received)); - assertEq(expectedHash, receivedHash, "Priority queue front operation is incorrect"); - } -} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/TransferEthToSharedBridge.t.sol b/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/TransferEthToSharedBridge.t.sol deleted file mode 100644 index 2bba6bda1..000000000 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/chain-deps/facets/Mailbox/TransferEthToSharedBridge.t.sol +++ /dev/null @@ -1,53 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {MailboxTest} from "./_Mailbox_Shared.t.sol"; -import {IL1SharedBridge} from "contracts/bridge/interfaces/IL1SharedBridge.sol"; -import {DummySharedBridge} from "contracts/dev-contracts/test/DummySharedBridge.sol"; -import {OnlyEraSupported, Unauthorized} from "contracts/common/L1ContractErrors.sol"; - -contract MailboxTransferEthToSharedBridge is MailboxTest { - address baseTokenBridgeAddress; - DummySharedBridge l1SharedBridge; - - function setUp() public virtual { - setupDiamondProxy(); - - l1SharedBridge = new DummySharedBridge(keccak256("dummyDepositHash")); - baseTokenBridgeAddress = address(l1SharedBridge); - - utilsFacet.util_setChainId(eraChainId); - utilsFacet.util_setBaseTokenBridge(baseTokenBridgeAddress); - } - - modifier useBaseTokenBridge() { - vm.startPrank(baseTokenBridgeAddress); - _; - vm.stopPrank(); - } - - function test_success_transfer(uint256 randomAmount) public useBaseTokenBridge { - vm.deal(diamondProxy, randomAmount); - - assertEq(address(l1SharedBridge).balance, 0); - assertEq(address(diamondProxy).balance, randomAmount); - mailboxFacet.transferEthToSharedBridge(); - assertEq(address(l1SharedBridge).balance, randomAmount); - assertEq(address(diamondProxy).balance, 0); - } - - function test_RevertWhen_wrongCaller() public { - vm.expectRevert(abi.encodeWithSelector(Unauthorized.selector, sender)); - vm.prank(sender); - mailboxFacet.transferEthToSharedBridge(); - } - - function test_RevertWhen_hyperchainIsNotEra(uint256 randomChainId) public useBaseTokenBridge { - vm.assume(eraChainId != randomChainId); - utilsFacet.util_setChainId(randomChainId); - - vm.expectRevert(OnlyEraSupported.selector); - mailboxFacet.transferEthToSharedBridge(); - } -} diff --git a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/Merkle/Merkle.t.sol b/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/Merkle/Merkle.t.sol deleted file mode 100644 index 89514fc99..000000000 --- a/l1-contracts/test/foundry/unit/concrete/state-transition/libraries/Merkle/Merkle.t.sol +++ /dev/null @@ -1,67 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity 0.8.24; - -import {Test} from "forge-std/Test.sol"; -import {MerkleTest} from "contracts/dev-contracts/test/MerkleTest.sol"; -import {MerkleTreeNoSort} from "./MerkleTreeNoSort.sol"; -import {MerklePathEmpty, MerkleIndexOutOfBounds, MerklePathOutOfBounds} from "contracts/common/L1ContractErrors.sol"; - -contract MerkleTestTest is Test { - MerkleTreeNoSort merkleTree; - MerkleTest merkleTest; - bytes32[] elements; - bytes32 root; - - function setUp() public { - merkleTree = new MerkleTreeNoSort(); - merkleTest = new MerkleTest(); - - for (uint256 i = 0; i < 65; i++) { - elements.push(keccak256(abi.encodePacked(i))); - } - - root = merkleTree.getRoot(elements); - } - - function testElements(uint256 i) public { - vm.assume(i < elements.length); - bytes32 leaf = elements[i]; - bytes32[] memory proof = merkleTree.getProof(elements, i); - - bytes32 rootFromContract = merkleTest.calculateRoot(proof, i, leaf); - - assertEq(rootFromContract, root); - } - - function testFirstElement() public { - testElements(0); - } - - function testLastElement() public { - testElements(elements.length - 1); - } - - function testEmptyProof_shouldRevert() public { - bytes32 leaf = elements[0]; - bytes32[] memory proof; - - vm.expectRevert(MerklePathEmpty.selector); - merkleTest.calculateRoot(proof, 0, leaf); - } - - function testLeafIndexTooBig_shouldRevert() public { - bytes32 leaf = elements[0]; - bytes32[] memory proof = merkleTree.getProof(elements, 0); - - vm.expectRevert(MerkleIndexOutOfBounds.selector); - merkleTest.calculateRoot(proof, 2 ** 255, leaf); - } - - function testProofLengthTooLarge_shouldRevert() public { - bytes32 leaf = elements[0]; - bytes32[] memory proof = new bytes32[](256); - - vm.expectRevert(MerklePathOutOfBounds.selector); - merkleTest.calculateRoot(proof, 0, leaf); - } -} diff --git a/l1-contracts/test/test_config/constant/hardhat.json b/l1-contracts/test/test_config/constant/hardhat.json index 1a59b10d3..60af027f7 100644 --- a/l1-contracts/test/test_config/constant/hardhat.json +++ b/l1-contracts/test/test_config/constant/hardhat.json @@ -3,96 +3,96 @@ "name": "DAI", "symbol": "DAI", "decimals": 18, - "address": "0x9F9Cd69A2a3b296B8C3b0E59A942d1B893c6c988" + "address": "0x3577F97253469b560CD6442AB37A262a292003f3" }, { "name": "wBTC", "symbol": "wBTC", "decimals": 8, - "address": "0xe7B8C0dd29D50D54b9d75e923FB96562B7513A6f" + "address": "0x4A9D48Db0008F8778160dDF142b28a858c427B48" }, { "name": "BAT", "symbol": "BAT", "decimals": 18, - "address": "0x4C56e415d1C59c69FE953aEd7C41686f5ee33B2c" + "address": "0x8ce06E5aF9A1221a88282A5Ce65D750BE16b0079" }, { "name": "GNT", "symbol": "GNT", "decimals": 18, - "address": "0x7D12865902a998Ae6C7B8Bea02277dF1707bB7E2" + "address": "0xF1286aD858DeE56B79D5F23f14040849fA3631dA" }, { "name": "MLTT", "symbol": "MLTT", "decimals": 18, - "address": "0xD4Ba730aA7b2E7Bb7515b265c39dd0796cF7d440" + "address": "0x9267631d42C7D2747f8e5573169BdceAE87535b8" }, { "name": "DAIK", "symbol": "DAIK", "decimals": 18, - "address": "0xee80cFA1F62427E52A62197A86f76a16eA7b7627" + "address": "0xea21B9a6C6D13d1C6AbAEc73c6F330D601779e15" }, { "name": "wBTCK", "symbol": "wBTCK", "decimals": 8, - "address": "0x2dD8d8B7E8489E361fa3a455888a371eDcB645d4" + "address": "0x389f272Ae7D1061608Af3E2203d24c8e654FcEd5" }, { "name": "BATK", "symbol": "BATS", "decimals": 18, - "address": "0x3dE741Ebc93DbEC9C97eccbbA1aD2577b4335980" + "address": "0x6890D8DB20db3A5d06eC6DE69F7DB1d5A183922C" }, { "name": "GNTK", "symbol": "GNTS", "decimals": 18, - "address": "0x6989065500a6B9AAF59F3DCC4cf9e30d0ea9d394" + "address": "0x037f096F289dF1c0dBf3C89Dd6CAbc07599dD150" }, { "name": "MLTTK", "symbol": "MLTTS", "decimals": 18, - "address": "0x18c1BC9b6049FCC6780549Ad2aA247426f81e916" + "address": "0x23886B9856326226A5de9368C3781843b58Bd2bE" }, { "name": "DAIL", "symbol": "DAIL", "decimals": 18, - "address": "0x75d34909F783D56B7B8Be71085fE63777Dc8fDFE" + "address": "0x039D76D9b98e856da082ddf5Ab504352BB2096E0" }, { "name": "wBTCL", "symbol": "wBTCP", "decimals": 8, - "address": "0x3577F97253469b560CD6442AB37A262a292003f3" + "address": "0x341a1D5df70E56DCA0bCe2892F70A9e83bFA7958" }, { "name": "BATL", "symbol": "BATW", "decimals": 18, - "address": "0x4A9D48Db0008F8778160dDF142b28a858c427B48" + "address": "0x1268Cf85f3D4306059A3fa7aDE2a9a49467E0E0C" }, { "name": "GNTL", "symbol": "GNTW", "decimals": 18, - "address": "0x8ce06E5aF9A1221a88282A5Ce65D750BE16b0079" + "address": "0x75fe8be7615e5b8b116AF4ffD67993E03b7568b5" }, { "name": "MLTTL", "symbol": "MLTTW", "decimals": 18, - "address": "0xF1286aD858DeE56B79D5F23f14040849fA3631dA" + "address": "0x35e4ba9B6913426C15410DeD184Ba642E858f3Ef" }, { "name": "Wrapped Ether", "symbol": "WETH", "decimals": 18, - "address": "0x9267631d42C7D2747f8e5573169BdceAE87535b8" + "address": "0x8ed463C98Ba3A08d1263D785Ac74CD93bDBbcFD4" } ] diff --git a/l1-contracts/test/unit_tests/custom_base_token.spec.ts b/l1-contracts/test/unit_tests/custom_base_token.spec.ts index 6ec55fec2..2fc87d199 100644 --- a/l1-contracts/test/unit_tests/custom_base_token.spec.ts +++ b/l1-contracts/test/unit_tests/custom_base_token.spec.ts @@ -73,7 +73,7 @@ describe("Custom base token chain and bridge tests", () => { it("Should have correct base token", async () => { // we should still be able to deploy the erc20 bridge - const baseTokenAddressInBridgehub = await bridgehub.baseToken(chainId); + const baseTokenAddressInBridgehub = await bridgehub.baseToken(deployer.chainId); expect(baseTokenAddress).equal(baseTokenAddressInBridgehub); }); @@ -92,11 +92,7 @@ describe("Custom base token chain and bridge tests", () => { ) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: not legacy bridge"); -======= expect(revertReason).contains("Unauthorized"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); it("Should deposit base token successfully direct via bridgehub", async () => { @@ -152,21 +148,13 @@ describe("Custom base token chain and bridge tests", () => { const revertReason = await getCallRevertReason( l1SharedBridge.connect(randomSigner).finalizeWithdrawal(chainId, 0, 0, 0, mailboxFunctionSignature, []) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: wrong msg len"); -======= - expect(revertReason).contains("MalformedMessage"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + expect(revertReason).contains("L2WithdrawalMessageWrongLength"); }); it("Should revert on finalizing a withdrawal with wrong function selector", async () => { const revertReason = await getCallRevertReason( l1SharedBridge.connect(randomSigner).finalizeWithdrawal(chainId, 0, 0, 0, ethers.utils.randomBytes(96), []) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: Incorrect message function selector"); -======= expect(revertReason).contains("InvalidSelector"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); }); diff --git a/l1-contracts/test/unit_tests/synclayer.spec.ts b/l1-contracts/test/unit_tests/gateway.spec.ts similarity index 74% rename from l1-contracts/test/unit_tests/synclayer.spec.ts rename to l1-contracts/test/unit_tests/gateway.spec.ts index d5ee3fe43..37460e02a 100644 --- a/l1-contracts/test/unit_tests/synclayer.spec.ts +++ b/l1-contracts/test/unit_tests/gateway.spec.ts @@ -9,16 +9,21 @@ import { BridgehubFactory } from "../../typechain"; import { initialTestnetDeploymentProcess, defaultDeployerForTests, - registerHyperchainWithBridgeRegistration, + registerZKChainWithBridgeRegistration, } from "../../src.ts/deploy-test-process"; -import { ethTestConfig, REQUIRED_L2_GAS_PRICE_PER_PUBDATA, priorityTxMaxGasLimit } from "../../src.ts/utils"; +import { + ethTestConfig, + REQUIRED_L2_GAS_PRICE_PER_PUBDATA, + priorityTxMaxGasLimit, + L2_BRIDGEHUB_ADDRESS, +} from "../../src.ts/utils"; import { SYSTEM_CONFIG } from "../../scripts/utils"; import type { Deployer } from "../../src.ts/deploy"; -describe("Synclayer", function () { +describe("Gateway", function () { let bridgehub: Bridgehub; - // let stateTransition: StateTransitionManager; + // let stateTransition: ChainTypeManager; let owner: ethers.Signer; let migratingDeployer: Deployer; let gatewayDeployer: Deployer; @@ -57,7 +62,7 @@ describe("Synclayer", function () { gatewayDeployer = await defaultDeployerForTests(deployWallet, ownerAddress); gatewayDeployer.chainId = 10; - await registerHyperchainWithBridgeRegistration( + await registerZKChainWithBridgeRegistration( gatewayDeployer, false, [], @@ -76,28 +81,40 @@ describe("Synclayer", function () { it("Check start move chain to synclayer", async () => { const gasPrice = await owner.provider.getGasPrice(); - await migratingDeployer.moveChainToGateway(gatewayDeployer.chainId.toString(), gasPrice, false); + await migratingDeployer.moveChainToGateway(gatewayDeployer.chainId.toString(), gasPrice); expect(await bridgehub.settlementLayer(migratingDeployer.chainId)).to.equal(gatewayDeployer.chainId); }); it("Check l2 registration", async () => { - const stm = migratingDeployer.stateTransitionManagerContract(migratingDeployer.deployWallet); + const ctm = migratingDeployer.chainTypeManagerContract(migratingDeployer.deployWallet); const gasPrice = await migratingDeployer.deployWallet.provider.getGasPrice(); const value = ( await bridgehub.l2TransactionBaseCost(chainId, gasPrice, priorityTxMaxGasLimit, REQUIRED_L2_GAS_PRICE_PER_PUBDATA) ).mul(10); - // const baseTokenAddress = await bridgehub.baseToken(chainId); - // const ethIsBaseToken = baseTokenAddress == ADDRESS_ONE; - const stmDeploymentTracker = migratingDeployer.stmDeploymentTracker(migratingDeployer.deployWallet); - const calldata = stmDeploymentTracker.interface.encodeFunctionData("registerSTMAssetOnL2SharedBridge", [ - chainId, - gatewayDeployer.addresses.StateTransition.StateTransitionProxy, + + const ctmDeploymentTracker = migratingDeployer.ctmDeploymentTracker(migratingDeployer.deployWallet); + const assetRouter = migratingDeployer.defaultSharedBridge(migratingDeployer.deployWallet); + const assetId = await bridgehub.ctmAssetIdFromChainId(chainId); + + await migratingDeployer.executeUpgrade( + bridgehub.address, value, - priorityTxMaxGasLimit, - SYSTEM_CONFIG.requiredL2GasPricePerPubdata, - gatewayDeployer.deployWallet.address, - ]); - await migratingDeployer.executeUpgrade(stmDeploymentTracker.address, value, calldata); + bridgehub.interface.encodeFunctionData("requestL2TransactionTwoBridges", [ + { + chainId, + mintValue: value, + l2Value: 0, + l2GasLimit: priorityTxMaxGasLimit, + l2GasPerPubdataByteLimit: SYSTEM_CONFIG.requiredL2GasPricePerPubdata, + refundRecipient: migratingDeployer.deployWallet.address, + secondBridgeAddress: assetRouter.address, + secondBridgeValue: 0, + secondBridgeCalldata: + "0x02" + + ethers.utils.defaultAbiCoder.encode(["bytes32", "address"], [assetId, L2_BRIDGEHUB_ADDRESS]).slice(2), + }, + ]) + ); await migratingDeployer.executeUpgrade( bridgehub.address, value, @@ -109,13 +126,14 @@ describe("Synclayer", function () { l2GasLimit: priorityTxMaxGasLimit, l2GasPerPubdataByteLimit: SYSTEM_CONFIG.requiredL2GasPricePerPubdata, refundRecipient: migratingDeployer.deployWallet.address, - secondBridgeAddress: stmDeploymentTracker.address, + secondBridgeAddress: ctmDeploymentTracker.address, secondBridgeValue: 0, - secondBridgeCalldata: ethers.utils.defaultAbiCoder.encode(["address", "address"], [stm.address, stm.address]), + secondBridgeCalldata: + "0x01" + ethers.utils.defaultAbiCoder.encode(["address", "address"], [ctm.address, ctm.address]).slice(2), }, ]) ); - // console.log("STM asset registered in L2 Bridgehub on SL"); + // console.log("CTM asset registered in L2 Bridgehub on SL"); }); it("Check start message to L3 on L1", async () => { diff --git a/l1-contracts/test/unit_tests/governance_test.spec.ts b/l1-contracts/test/unit_tests/governance_test.spec.ts index 444e70846..e689def8d 100644 --- a/l1-contracts/test/unit_tests/governance_test.spec.ts +++ b/l1-contracts/test/unit_tests/governance_test.spec.ts @@ -13,17 +13,18 @@ describe("Admin facet tests", function () { before(async () => { const contractFactory = await hardhat.ethers.getContractFactory("AdminFacetTest"); - const contract = await contractFactory.deploy(); + const contract = await contractFactory.deploy(await contractFactory.signer.getChainId()); adminFacetTest = AdminFacetTestFactory.connect(contract.address, contract.signer); - const governanceContract = await contractFactory.deploy(); + const governanceContract = await contractFactory.deploy(await contractFactory.signer.getChainId()); + const governance = GovernanceFactory.connect(governanceContract.address, governanceContract.signer); await adminFacetTest.setPendingAdmin(governance.address); randomSigner = (await hardhat.ethers.getSigners())[1]; }); - it("StateTransitionManager successfully set validator", async () => { + it("ChainTypeManager successfully set validator", async () => { const validatorAddress = randomAddress(); await adminFacetTest.setValidator(validatorAddress, true); @@ -39,7 +40,7 @@ describe("Admin facet tests", function () { expect(revertReason).contains("Unauthorized"); }); - it("StateTransitionManager successfully set porter availability", async () => { + it("ChainTypeManager successfully set porter availability", async () => { await adminFacetTest.setPorterAvailability(true); const porterAvailability = await adminFacetTest.getPorterAvailability(); @@ -51,7 +52,7 @@ describe("Admin facet tests", function () { expect(revertReason).contains("Unauthorized"); }); - it("StateTransitionManager successfully set priority transaction max gas limit", async () => { + it("ChainTypeManager successfully set priority transaction max gas limit", async () => { const gasLimit = "12345678"; await adminFacetTest.setPriorityTxMaxGasLimit(gasLimit); diff --git a/l1-contracts/test/unit_tests/initial_deployment_test.spec.ts b/l1-contracts/test/unit_tests/initial_deployment_test.spec.ts index bf381402e..d670f9306 100644 --- a/l1-contracts/test/unit_tests/initial_deployment_test.spec.ts +++ b/l1-contracts/test/unit_tests/initial_deployment_test.spec.ts @@ -3,8 +3,14 @@ import * as ethers from "ethers"; import { Wallet } from "ethers"; import * as hardhat from "hardhat"; -import type { Bridgehub, StateTransitionManager } from "../../typechain"; -import { BridgehubFactory, StateTransitionManagerFactory } from "../../typechain"; +import type { Bridgehub, ChainTypeManager, L1NativeTokenVault, L1AssetRouter, L1Nullifier } from "../../typechain"; +import { + BridgehubFactory, + ChainTypeManagerFactory, + L1NativeTokenVaultFactory, + L1AssetRouterFactory, + L1NullifierFactory, +} from "../../typechain"; import { initialTestnetDeploymentProcess } from "../../src.ts/deploy-test-process"; import { ethTestConfig } from "../../src.ts/utils"; @@ -13,12 +19,15 @@ import type { Deployer } from "../../src.ts/deploy"; describe("Initial deployment test", function () { let bridgehub: Bridgehub; - let stateTransition: StateTransitionManager; + let chainTypeManager: ChainTypeManager; let owner: ethers.Signer; let deployer: Deployer; // const MAX_CODE_LEN_WORDS = (1 << 16) - 1; // const MAX_CODE_LEN_BYTES = MAX_CODE_LEN_WORDS * 32; // let forwarder: Forwarder; + let l1NativeTokenVault: L1NativeTokenVault; + let l1AssetRouter: L1AssetRouter; + let l1Nullifier: L1Nullifier; let chainId = process.env.CHAIN_ETH_ZKSYNC_NETWORK_ID || 270; before(async () => { @@ -47,22 +56,48 @@ describe("Initial deployment test", function () { // await deploySharedBridgeOnL2ThroughL1(deployer, chainId.toString(), gasPrice); bridgehub = BridgehubFactory.connect(deployer.addresses.Bridgehub.BridgehubProxy, deployWallet); - stateTransition = StateTransitionManagerFactory.connect( + chainTypeManager = ChainTypeManagerFactory.connect( deployer.addresses.StateTransition.StateTransitionProxy, deployWallet ); + l1NativeTokenVault = L1NativeTokenVaultFactory.connect( + deployer.addresses.Bridges.NativeTokenVaultProxy, + deployWallet + ); + l1AssetRouter = L1AssetRouterFactory.connect(deployer.addresses.Bridges.SharedBridgeProxy, deployWallet); + l1Nullifier = L1NullifierFactory.connect(deployer.addresses.Bridges.L1NullifierProxy, deployWallet); }); it("Check addresses", async () => { - const stateTransitionManagerAddress1 = deployer.addresses.StateTransition.StateTransitionProxy; - const stateTransitionManagerAddress2 = await bridgehub.stateTransitionManager(chainId); - expect(stateTransitionManagerAddress1.toLowerCase()).equal(stateTransitionManagerAddress2.toLowerCase()); - - const stateTransitionAddress1 = deployer.addresses.StateTransition.DiamondProxy; - const stateTransitionAddress2 = await stateTransition.getHyperchain(chainId); - expect(stateTransitionAddress1.toLowerCase()).equal(stateTransitionAddress2.toLowerCase()); - - const stateTransitionAddress3 = await bridgehub.getHyperchain(chainId); - expect(stateTransitionAddress1.toLowerCase()).equal(stateTransitionAddress3.toLowerCase()); + const bridgehubAddress1 = deployer.addresses.Bridgehub.BridgehubProxy; + const bridgehubAddress2 = await l1AssetRouter.BRIDGE_HUB(); + const bridgehubAddress3 = await chainTypeManager.BRIDGE_HUB(); + expect(bridgehubAddress1.toLowerCase()).equal(bridgehubAddress2.toLowerCase()); + expect(bridgehubAddress1.toLowerCase()).equal(bridgehubAddress3.toLowerCase()); + + const chainTypeManagerAddress1 = deployer.addresses.StateTransition.StateTransitionProxy; + const chainTypeManagerAddress2 = await bridgehub.chainTypeManager(chainId); + expect(chainTypeManagerAddress1.toLowerCase()).equal(chainTypeManagerAddress2.toLowerCase()); + + const chainAddress2 = await chainTypeManager.getZKChain(chainId); + const chainAddress1 = deployer.addresses.StateTransition.DiamondProxy; + expect(chainAddress1.toLowerCase()).equal(chainAddress2.toLowerCase()); + + const chainAddress3 = await bridgehub.getZKChain(chainId); + expect(chainAddress1.toLowerCase()).equal(chainAddress3.toLowerCase()); + + const assetRouterAddress1 = deployer.addresses.Bridges.SharedBridgeProxy; + const assetRouterAddress2 = await bridgehub.sharedBridge(); + const assetRouterAddress3 = await l1NativeTokenVault.ASSET_ROUTER(); + const assetRouterAddress4 = await l1Nullifier.l1AssetRouter(); + expect(assetRouterAddress1.toLowerCase()).equal(assetRouterAddress2.toLowerCase()); + expect(assetRouterAddress1.toLowerCase()).equal(assetRouterAddress3.toLowerCase()); + expect(assetRouterAddress1.toLowerCase()).equal(assetRouterAddress4.toLowerCase()); + + const ntvAddress1 = deployer.addresses.Bridges.NativeTokenVaultProxy; + const ntvAddress2 = await l1Nullifier.l1NativeTokenVault(); + const ntvAddress3 = await l1AssetRouter.nativeTokenVault(); + expect(ntvAddress1.toLowerCase()).equal(ntvAddress2.toLowerCase()); + expect(ntvAddress1.toLowerCase()).equal(ntvAddress3.toLowerCase()); }); }); diff --git a/l1-contracts/test/unit_tests/l1_shared_bridge_test.spec.ts b/l1-contracts/test/unit_tests/l1_shared_bridge_test.spec.ts index 6244ffe8a..e1e17128b 100644 --- a/l1-contracts/test/unit_tests/l1_shared_bridge_test.spec.ts +++ b/l1-contracts/test/unit_tests/l1_shared_bridge_test.spec.ts @@ -161,11 +161,7 @@ describe("Shared Bridge tests", () => { .connect(randomSigner) .finalizeWithdrawal(chainId, 0, 0, 0, mailboxFunctionSignature, [ethers.constants.HashZero]) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: wrong msg len"); -======= - expect(revertReason).contains("MalformedMessage"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + expect(revertReason).contains("L2WithdrawalMessageWrongLength"); }); it("Should revert on finalizing a withdrawal with wrong message length", async () => { @@ -181,47 +177,39 @@ describe("Shared Bridge tests", () => { [ethers.constants.HashZero] ) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: wrong msg len 2"); -======= - expect(revertReason).contains("MalformedMessage"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + expect(revertReason).contains("L2WithdrawalMessageWrongLength"); }); it("Should revert on finalizing a withdrawal with wrong function selector", async () => { const revertReason = await getCallRevertReason( l1SharedBridge.connect(randomSigner).finalizeWithdrawal(chainId, 0, 0, 0, ethers.utils.randomBytes(96), []) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: Incorrect message function selector"); -======= expect(revertReason).contains("InvalidSelector"); }); - it("Should deposit erc20 token successfully", async () => { - const amount = ethers.utils.parseEther("0.001"); - const mintValue = ethers.utils.parseEther("0.002"); - await l1Weth.connect(randomSigner).deposit({ value: amount }); - await (await l1Weth.connect(randomSigner).approve(l1SharedBridge.address, amount)).wait(); - bridgehub.connect(randomSigner).requestL2TransactionTwoBridges( - { - chainId, - mintValue, - l2Value: amount, - l2GasLimit: 1000000, - l2GasPerPubdataByteLimit: REQUIRED_L2_GAS_PRICE_PER_PUBDATA, - refundRecipient: ethers.constants.AddressZero, - secondBridgeAddress: l1SharedBridge.address, - secondBridgeValue: 0, - secondBridgeCalldata: new ethers.utils.AbiCoder().encode( - ["address", "uint256", "address"], - [l1Weth.address, amount, await randomSigner.getAddress()] - ), - }, - { value: mintValue } - ); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - }); + // it("Should deposit erc20 token successfully", async () => { + // const amount = ethers.utils.parseEther("0.001"); + // const mintValue = ethers.utils.parseEther("0.002"); + // await l1Weth.connect(randomSigner).deposit({ value: amount }); + // await (await l1Weth.connect(randomSigner).approve(l1SharedBridge.address, amount)).wait(); + // bridgehub.connect(randomSigner).requestL2TransactionTwoBridges( + // { + // chainId, + // mintValue, + // l2Value: amount, + // l2GasLimit: 1000000, + // l2GasPerPubdataByteLimit: REQUIRED_L2_GAS_PRICE_PER_PUBDATA, + // refundRecipient: ethers.constants.AddressZero, + // secondBridgeAddress: l1SharedBridge.address, + // secondBridgeValue: 0, + // secondBridgeCalldata: new ethers.utils.AbiCoder().encode( + // ["address", "uint256", "address"], + // [l1Weth.address, amount, await randomSigner.getAddress()] + // ), + // }, + // { value: mintValue } + // ); + // }); it("Should revert on finalizing a withdrawal with wrong message length", async () => { const revertReason = await getCallRevertReason( @@ -229,11 +217,7 @@ describe("Shared Bridge tests", () => { .connect(randomSigner) .finalizeWithdrawal(chainId, 0, 0, 0, mailboxFunctionSignature, [ethers.constants.HashZero]) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: wrong msg len"); -======= - expect(revertReason).contains("MalformedMessage"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + expect(revertReason).contains("L2WithdrawalMessageWrongLength"); }); it("Should revert on finalizing a withdrawal with wrong function signature", async () => { @@ -242,11 +226,7 @@ describe("Shared Bridge tests", () => { .connect(randomSigner) .finalizeWithdrawal(chainId, 0, 0, 0, ethers.utils.randomBytes(76), [ethers.constants.HashZero]) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: Incorrect message function selector"); -======= expect(revertReason).contains("InvalidSelector"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); it("Should revert on finalizing a withdrawal with wrong batch number", async () => { @@ -260,20 +240,13 @@ describe("Shared Bridge tests", () => { const revertReason = await getCallRevertReason( l1SharedBridge.connect(randomSigner).finalizeWithdrawal(chainId, 10, 0, 0, l2ToL1message, dummyProof) ); -<<<<<<< HEAD - expect(revertReason).equal("local root is 0"); -======= expect(revertReason).contains("BatchNotExecuted"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); it("Should revert on finalizing a withdrawal with wrong length of proof", async () => { const l1Receiver = await randomSigner.getAddress(); const l2ToL1message = ethers.utils.hexConcat([ -<<<<<<< HEAD mailboxFunctionSignature, -======= - functionSignature, l1Receiver, erc20TestToken.address, ethers.constants.HashZero, @@ -287,8 +260,7 @@ describe("Shared Bridge tests", () => { it("Should revert on finalizing a withdrawal with wrong proof", async () => { const l1Receiver = await randomSigner.getAddress(); const l2ToL1message = ethers.utils.hexConcat([ - functionSignature, ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + mailboxFunctionSignature, l1Receiver, erc20TestToken.address, ethers.constants.HashZero, @@ -298,24 +270,6 @@ describe("Shared Bridge tests", () => { .connect(randomSigner) .finalizeWithdrawal(chainId, 0, 0, 0, l2ToL1message, [dummyProof[0], dummyProof[1]]) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: withd w proof"); - }); - - it("Should revert on finalizing a withdrawal with wrong proof", async () => { - const l1Receiver = await randomSigner.getAddress(); - const l2ToL1message = ethers.utils.hexConcat([ - mailboxFunctionSignature, - l1Receiver, - erc20TestToken.address, - ethers.constants.HashZero, - ]); - const revertReason = await getCallRevertReason( - l1SharedBridge.connect(randomSigner).finalizeWithdrawal(chainId, 0, 0, 0, l2ToL1message, dummyProof) - ); - expect(revertReason).equal("L1AR: withd w proof"); -======= expect(revertReason).contains("InvalidProof"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); }); diff --git a/l1-contracts/test/unit_tests/l2-upgrade.test.spec.ts b/l1-contracts/test/unit_tests/l2-upgrade.test.spec.ts index 84e0a4f83..4d04f6695 100644 --- a/l1-contracts/test/unit_tests/l2-upgrade.test.spec.ts +++ b/l1-contracts/test/unit_tests/l2-upgrade.test.spec.ts @@ -5,7 +5,7 @@ import * as ethers from "ethers"; import * as hardhat from "hardhat"; import { hashBytecode } from "zksync-ethers/build/utils"; -import type { AdminFacet, ExecutorFacet, GettersFacet, StateTransitionManager } from "../../typechain"; +import type { AdminFacet, ExecutorFacet, GettersFacet, ChainTypeManager } from "../../typechain"; import { AdminFacetFactory, DummyAdminFacetFactory, @@ -13,7 +13,7 @@ import { DefaultUpgradeFactory, ExecutorFacetFactory, GettersFacetFactory, - StateTransitionManagerFactory, + ChainTypeManagerFactory, } from "../../typechain"; import { Ownable2StepFactory } from "../../typechain/Ownable2StepFactory"; @@ -27,6 +27,7 @@ import { diamondCut, Action, facetCut } from "../../src.ts/diamondCut"; import type { CommitBatchInfo, StoredBatchInfo, CommitBatchInfoWithTimestamp } from "./utils"; import { + encodeCommitBatchesData, L2_BOOTLOADER_ADDRESS, L2_SYSTEM_CONTEXT_ADDRESS, SYSTEM_LOG_KEYS, @@ -49,7 +50,7 @@ describe("L2 upgrade test", function () { let proxyAdmin: AdminFacet; let proxyGetters: GettersFacet; - let stateTransitionManager: StateTransitionManager; + let chainTypeManager: ChainTypeManager; let owner: ethers.Signer; @@ -115,7 +116,7 @@ describe("L2 upgrade test", function () { deployWallet ); - stateTransitionManager = StateTransitionManagerFactory.connect( + chainTypeManager = ChainTypeManagerFactory.connect( deployer.addresses.StateTransition.StateTransitionProxy, deployWallet ); @@ -135,9 +136,11 @@ describe("L2 upgrade test", function () { ); const commitReceipt = await ( - await proxyExecutor.commitBatches(genesisStoredBatchInfo(), [batch1InfoChainIdUpgrade]) + await proxyExecutor.commitBatchesSharedBridge( + chainId, + ...encodeCommitBatchesData(genesisStoredBatchInfo(), [batch1InfoChainIdUpgrade]) + ) ).wait(); - const commitment = commitReceipt.events[0].args.commitment; storedBatch1InfoChainIdUpgrade = getBatchStoredInfo(batch1InfoChainIdUpgrade, commitment); await makeExecutedEqualCommitted(proxyExecutor, genesisStoredBatchInfo(), [storedBatch1InfoChainIdUpgrade], []); @@ -151,7 +154,10 @@ describe("L2 upgrade test", function () { }); const commitReceipt = await ( - await proxyExecutor.commitBatches(storedBatch1InfoChainIdUpgrade, [batch2Info]) + await proxyExecutor.commitBatchesSharedBridge( + chainId, + ...encodeCommitBatchesData(storedBatch1InfoChainIdUpgrade, [batch2Info]) + ) ).wait(); const commitment = commitReceipt.events[0].args.commitment; @@ -159,7 +165,7 @@ describe("L2 upgrade test", function () { expect(await proxyGetters.getL2SystemContractsUpgradeTxHash()).to.equal(ethers.constants.HashZero); await ( - await executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + await executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 1, 0), l2ProtocolUpgradeTx: noopUpgradeTransaction, }) @@ -176,7 +182,7 @@ describe("L2 upgrade test", function () { const { 0: major, 1: minor, 2: patch } = await proxyGetters.getSemverProtocolVersion(); const bootloaderRevertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { newProtocolVersion: packSemver(major, minor, patch + 1), bootloaderHash: ethers.utils.hexlify(hashBytecode(ethers.utils.randomBytes(32))), l2ProtocolUpgradeTx: noopUpgradeTransaction, @@ -185,7 +191,7 @@ describe("L2 upgrade test", function () { expect(bootloaderRevertReason).to.contain("PatchUpgradeCantSetBootloader"); const defaultAccountRevertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { newProtocolVersion: packSemver(major, minor, patch + 1), defaultAccountHash: ethers.utils.hexlify(hashBytecode(ethers.utils.randomBytes(32))), l2ProtocolUpgradeTx: noopUpgradeTransaction, @@ -203,7 +209,7 @@ describe("L2 upgrade test", function () { }); const bootloaderRevertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { newProtocolVersion: packSemver(major, minor, patch + 1), l2ProtocolUpgradeTx: someTx, }) @@ -221,7 +227,7 @@ describe("L2 upgrade test", function () { }); const bootloaderRevertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { newProtocolVersion: newVersion, l2ProtocolUpgradeTx: someTx, }) @@ -232,14 +238,14 @@ describe("L2 upgrade test", function () { it("Timestamp should behave correctly", async () => { // Upgrade was scheduled for now should work fine const timeNow = (await hardhat.ethers.provider.getBlock("latest")).timestamp; - await executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + await executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { upgradeTimestamp: ethers.BigNumber.from(timeNow), l2ProtocolUpgradeTx: noopUpgradeTransaction, }); // Upgrade that was scheduled for the future should not work now const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { upgradeTimestamp: ethers.BigNumber.from(timeNow).mul(2), l2ProtocolUpgradeTx: noopUpgradeTransaction, }) @@ -252,7 +258,7 @@ describe("L2 upgrade test", function () { txType: 255, }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 3, 0), }) @@ -268,7 +274,7 @@ describe("L2 upgrade test", function () { }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 4, 0), }) @@ -284,7 +290,7 @@ describe("L2 upgrade test", function () { }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, newProtocolVersion: 0, }) @@ -300,7 +306,7 @@ describe("L2 upgrade test", function () { }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 10000, 0), }) @@ -316,7 +322,7 @@ describe("L2 upgrade test", function () { }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 4, 0), }) @@ -332,7 +338,7 @@ describe("L2 upgrade test", function () { }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 4, 0), }) @@ -349,7 +355,7 @@ describe("L2 upgrade test", function () { }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 4, 0), }) @@ -367,7 +373,7 @@ describe("L2 upgrade test", function () { }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, factoryDeps: [myFactoryDep], newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 4, 0), @@ -385,7 +391,7 @@ describe("L2 upgrade test", function () { }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, factoryDeps: [myFactoryDep], newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 4, 0), @@ -405,7 +411,7 @@ describe("L2 upgrade test", function () { }); const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { l2ProtocolUpgradeTx: wrongTx, factoryDeps: Array(33).fill(myFactoryDep), newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 4, 0), @@ -447,7 +453,7 @@ describe("L2 upgrade test", function () { }; const upgradeReceipt = await ( - await executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, upgrade) + await executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, upgrade) ).wait(); const defaultUpgradeFactory = await hardhat.ethers.getContractFactory("DefaultUpgrade"); @@ -534,7 +540,7 @@ describe("L2 upgrade test", function () { }; const upgradeReceipt = await ( - await executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, upgrade) + await executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, upgrade) ).wait(); const defaultUpgradeFactory = await hardhat.ethers.getContractFactory("DefaultUpgrade"); @@ -612,29 +618,26 @@ describe("L2 upgrade test", function () { newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 5 + 1, 0), }; const revertReason = await getCallRevertReason( - executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, upgrade) - ); - await rollBackToVersion( - addToProtocolVersion(initialProtocolVersion, 5, 1).toString(), - stateTransitionManager, - upgrade + executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, upgrade) ); + await rollBackToVersion(addToProtocolVersion(initialProtocolVersion, 5, 1).toString(), chainTypeManager, upgrade); expect(revertReason).to.contains("PreviousUpgradeNotFinalized"); }); - it("Should require that the next commit batches contains an upgrade tx", async () => { - if (!l2UpgradeTxHash) { - throw new Error("Can not perform this test without l2UpgradeTxHash"); - } - - const batch3InfoNoUpgradeTx = await buildCommitBatchInfo(storedBatch2Info, { - batchNumber: 3, - }); - const revertReason = await getCallRevertReason( - proxyExecutor.commitBatches(storedBatch2Info, [batch3InfoNoUpgradeTx]) - ); - expect(revertReason).to.contains("MissingSystemLogs"); - }); + // TODO: restore test + // it("Should require that the next commit batches contains an upgrade tx", async () => { + // if (!l2UpgradeTxHash) { + // throw new Error("Can not perform this test without l2UpgradeTxHash"); + // } + + // const batch3InfoNoUpgradeTx = await buildCommitBatchInfo(storedBatch2Info, { + // batchNumber: 3, + // }); + // const revertReason = await getCallRevertReason( + // proxyExecutor.commitBatchesSharedBridge(chainId, ...encodeCommitBatchesData(storedBatch2Info, [batch3InfoNoUpgradeTx])) + // ); + // expect(revertReason).to.contains("MissingSystemLogs"); + // }); it("Should ensure any additional upgrade logs go to the priority ops hash", async () => { if (!l2UpgradeTxHash) { @@ -673,8 +676,12 @@ describe("L2 upgrade test", function () { }, systemLogs ); + const revertReason = await getCallRevertReason( - proxyExecutor.commitBatches(storedBatch2Info, [batch3InfoNoUpgradeTx]) + proxyExecutor.commitBatchesSharedBridge( + chainId, + ...encodeCommitBatchesData(storedBatch2Info, [batch3InfoNoUpgradeTx]) + ) ); expect(revertReason).to.contains("LogAlreadyProcessed"); }); @@ -707,7 +714,10 @@ describe("L2 upgrade test", function () { ); const revertReason = await getCallRevertReason( - proxyExecutor.commitBatches(storedBatch2Info, [batch3InfoTwoUpgradeTx]) + proxyExecutor.commitBatchesSharedBridge( + chainId, + ...encodeCommitBatchesData(storedBatch2Info, [batch3InfoTwoUpgradeTx]) + ) ); expect(revertReason).to.contains("TxHashMismatch"); }); @@ -739,13 +749,18 @@ describe("L2 upgrade test", function () { systemLogs ); - await (await proxyExecutor.commitBatches(storedBatch2Info, [batch3InfoTwoUpgradeTx])).wait(); + await ( + await proxyExecutor.commitBatchesSharedBridge( + chainId, + ...encodeCommitBatchesData(storedBatch2Info, [batch3InfoTwoUpgradeTx]) + ) + ).wait(); expect(await proxyGetters.getL2SystemContractsUpgradeBatchNumber()).to.equal(3); }); it("Should commit successfully when batch was reverted and reupgraded", async () => { - await (await proxyExecutor.revertBatches(2)).wait(); + await (await proxyExecutor.revertBatchesSharedBridge(chainId, 2)).wait(); const timestamp = (await hardhat.ethers.provider.getBlock("latest")).timestamp; const systemLogs = createSystemLogs(); systemLogs.push( @@ -772,7 +787,12 @@ describe("L2 upgrade test", function () { systemLogs ); - const commitReceipt = await (await proxyExecutor.commitBatches(storedBatch2Info, [batch3InfoTwoUpgradeTx])).wait(); + const commitReceipt = await ( + await proxyExecutor.commitBatchesSharedBridge( + chainId, + ...encodeCommitBatchesData(storedBatch2Info, [batch3InfoTwoUpgradeTx]) + ) + ).wait(); expect(await proxyGetters.getL2SystemContractsUpgradeBatchNumber()).to.equal(3); const commitment = commitReceipt.events[0].args.commitment; @@ -785,7 +805,7 @@ describe("L2 upgrade test", function () { it("Should successfully commit a sequential upgrade", async () => { expect(await proxyGetters.getL2SystemContractsUpgradeBatchNumber()).to.equal(0); await ( - await executeUpgrade(chainId, proxyGetters, stateTransitionManager, proxyAdmin, { + await executeUpgrade(chainId, proxyGetters, chainTypeManager, proxyAdmin, { newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 5 + 1, 0), l2ProtocolUpgradeTx: noopUpgradeTransaction, }) @@ -809,7 +829,12 @@ describe("L2 upgrade test", function () { systemLogs ); - const commitReceipt = await (await proxyExecutor.commitBatches(storedBatch2Info, [batch4InfoTwoUpgradeTx])).wait(); + const commitReceipt = await ( + await proxyExecutor.commitBatchesSharedBridge( + chainId, + ...encodeCommitBatchesData(storedBatch2Info, [batch4InfoTwoUpgradeTx]) + ) + ).wait(); const commitment = commitReceipt.events[0].args.commitment; const newBatchStoredInfo = getBatchStoredInfo(batch4InfoTwoUpgradeTx, commitment); @@ -824,7 +849,7 @@ describe("L2 upgrade test", function () { it("Should successfully commit custom upgrade", async () => { const upgradeReceipt = await ( - await executeCustomUpgrade(chainId, proxyGetters, proxyAdmin, stateTransitionManager, { + await executeCustomUpgrade(chainId, proxyGetters, proxyAdmin, chainTypeManager, { newProtocolVersion: addToProtocolVersion(initialProtocolVersion, 6 + 1, 0), l2ProtocolUpgradeTx: noopUpgradeTransaction, }) @@ -863,7 +888,12 @@ describe("L2 upgrade test", function () { systemLogs ); - const commitReceipt = await (await proxyExecutor.commitBatches(storedBatch2Info, [batch5InfoTwoUpgradeTx])).wait(); + const commitReceipt = await ( + await proxyExecutor.commitBatchesSharedBridge( + chainId, + ...encodeCommitBatchesData(storedBatch2Info, [batch5InfoTwoUpgradeTx]) + ) + ).wait(); const commitment = commitReceipt.events[0].args.commitment; const newBatchStoredInfo = getBatchStoredInfo(batch5InfoTwoUpgradeTx, commitment); @@ -975,7 +1005,7 @@ function buildProposeUpgrade(proposedUpgrade: PartialProposedUpgrade): ProposedU async function executeUpgrade( chainId: BigNumberish, proxyGetters: GettersFacet, - stateTransitionManager: StateTransitionManager, + chainTypeManager: ChainTypeManager, proxyAdmin: AdminFacet, partialUpgrade: Partial, contractFactory?: ethers.ethers.ContractFactory @@ -1001,7 +1031,7 @@ async function executeUpgrade( const oldProtocolVersion = await proxyGetters.getProtocolVersion(); // This promise will be handled in the tests ( - await stateTransitionManager.setNewVersionUpgrade( + await chainTypeManager.setNewVersionUpgrade( diamondCutData, oldProtocolVersion, 999999999999, @@ -1014,7 +1044,7 @@ async function executeUpgrade( // we rollback the protocolVersion ( we don't clear the upgradeHash mapping, but that is ok) async function rollBackToVersion( protocolVersion: string, - stateTransition: StateTransitionManager, + stateTransition: ChainTypeManager, partialUpgrade: Partial ) { partialUpgrade.newProtocolVersion = protocolVersion; @@ -1045,7 +1075,7 @@ async function executeCustomUpgrade( chainId: BigNumberish, proxyGetters: GettersFacet, proxyAdmin: AdminFacet, - stateTransition: StateTransitionManager, + stateTransition: ChainTypeManager, partialUpgrade: Partial, contractFactory?: ethers.ethers.ContractFactory ) { diff --git a/l1-contracts/test/unit_tests/legacy_era_test.spec.ts b/l1-contracts/test/unit_tests/legacy_era_test.spec.ts index 879d3bebe..5a0d6e995 100644 --- a/l1-contracts/test/unit_tests/legacy_era_test.spec.ts +++ b/l1-contracts/test/unit_tests/legacy_era_test.spec.ts @@ -11,6 +11,7 @@ import { MailboxFacetFactory, GettersFacetFactory, MockExecutorFacetFactory, + L1NullifierFactory, } from "../../typechain"; import type { IL1ERC20Bridge } from "../../typechain/IL1ERC20Bridge"; import { IL1ERC20BridgeFactory } from "../../typechain/IL1ERC20BridgeFactory"; @@ -104,6 +105,7 @@ describe("Legacy Era tests", function () { const sharedBridge = await sharedBridgeFactory.deploy( l1WethToken, deployer.addresses.Bridgehub.BridgehubProxy, + deployer.addresses.Bridges.L1NullifierProxy, deployer.chainId, deployer.addresses.StateTransition.DiamondProxy ); @@ -121,6 +123,13 @@ describe("Legacy Era tests", function () { console.log("L1AssetRouter upgrade sent for testing"); } + const setL1Erc20BridgeCalldata = L1NullifierFactory.connect( + deployer.addresses.Bridges.L1NullifierProxy, + deployWallet + ).interface.encodeFunctionData("setL1Erc20Bridge", [l1ERC20Bridge.address]); + + await deployer.executeUpgrade(deployer.addresses.Bridges.L1NullifierProxy, 0, setL1Erc20BridgeCalldata); + mailbox = MailboxFacetFactory.connect(deployer.addresses.StateTransition.DiamondProxy, deployWallet); getter = GettersFacetFactory.connect(deployer.addresses.StateTransition.DiamondProxy, deployWallet); @@ -164,6 +173,7 @@ describe("Legacy Era tests", function () { l1ERC20Bridge.connect(randomSigner), bridgehub, chainId, + deployer.l1ChainId, depositorAddress, erc20TestToken.address, ethers.utils.parseUnits("800", 18), @@ -178,11 +188,7 @@ describe("Legacy Era tests", function () { .connect(randomSigner) .finalizeWithdrawal(1, 0, 0, mailboxFunctionSignature, [ethers.constants.HashZero]) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: wrong msg len"); -======= - expect(revertReason).contains("MalformedMessage"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + expect(revertReason).contains("L2WithdrawalMessageWrongLength(4)"); }); it("Should revert on finalizing a withdrawal with wrong function signature", async () => { @@ -191,20 +197,13 @@ describe("Legacy Era tests", function () { .connect(randomSigner) .finalizeWithdrawal(1, 0, 0, ethers.utils.randomBytes(76), [ethers.constants.HashZero]) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: Incorrect message function selector"); -======= expect(revertReason).contains("InvalidSelector"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); it("Should revert on finalizing a withdrawal with wrong batch number", async () => { const revertReason = await getCallRevertReason( l1ERC20Bridge.connect(randomSigner).finalizeWithdrawal(10, 0, 0, l2ToL1message, dummyProof) ); -<<<<<<< HEAD - expect(revertReason).equal("local root is 0"); -======= expect(revertReason).contains("BatchNotExecuted"); }); @@ -216,22 +215,14 @@ describe("Legacy Era tests", function () { erc20TestToken.address, ethers.constants.HashZero, ]); - const revertReason = await getCallRevertReason( - l1ERC20Bridge.connect(randomSigner).finalizeWithdrawal(0, 0, 0, l2ToL1message, []) - ); - expect(revertReason).contains("MerklePathEmpty"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe + await expect(l1ERC20Bridge.connect(randomSigner).finalizeWithdrawal(0, 0, 0, l2ToL1message, [])).to.be.reverted; }); it("Should revert on finalizing a withdrawal with wrong proof", async () => { const revertReason = await getCallRevertReason( l1ERC20Bridge.connect(randomSigner).finalizeWithdrawal(1, 0, 0, l2ToL1message, dummyProof) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: withd w proof"); -======= expect(revertReason).contains("InvalidProof"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); /////////// Mailbox. Note we have these two together because we need to fix ERA Diamond proxy Address @@ -301,11 +292,7 @@ describe("Legacy Era tests", function () { const revertReason = await getCallRevertReason( mailbox.finalizeEthWithdrawal(BLOCK_NUMBER, MESSAGE_INDEX, TX_NUMBER_IN_BLOCK, MESSAGE, invalidProof) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: withd w proof"); -======= expect(revertReason).contains("InvalidProof"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); it("Successful deposit", async () => { @@ -336,11 +323,7 @@ describe("Legacy Era tests", function () { const revertReason = await getCallRevertReason( mailbox.finalizeEthWithdrawal(BLOCK_NUMBER, MESSAGE_INDEX, TX_NUMBER_IN_BLOCK, MESSAGE, MERKLE_PROOF) ); -<<<<<<< HEAD - expect(revertReason).equal("L1AR: Withdrawal is already finalized"); -======= expect(revertReason).contains("WithdrawalAlreadyFinalized"); ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe }); }); }); diff --git a/l1-contracts/test/unit_tests/mailbox_test.spec.ts b/l1-contracts/test/unit_tests/mailbox_test.spec.ts index 4b3b335f5..c78cc646d 100644 --- a/l1-contracts/test/unit_tests/mailbox_test.spec.ts +++ b/l1-contracts/test/unit_tests/mailbox_test.spec.ts @@ -105,7 +105,7 @@ describe("Mailbox tests", function () { ) ); - expect(revertReason).contains("MalformedBytecode"); + expect(revertReason).contains("LengthIsNotDivisibleBy32(63)"); }); it("Should not accept bytecode of even length in words", async () => { @@ -199,7 +199,10 @@ describe("Mailbox tests", function () { before(async () => { const mailboxTestContractFactory = await hardhat.ethers.getContractFactory("MailboxFacetTest"); - const mailboxTestContract = await mailboxTestContractFactory.deploy(chainId); + const mailboxTestContract = await mailboxTestContractFactory.deploy( + chainId, + await mailboxTestContractFactory.signer.getChainId() + ); testContract = MailboxFacetTestFactory.connect(mailboxTestContract.address, mailboxTestContract.signer); // Generating 10 more gas prices for test suit diff --git a/l1-contracts/test/unit_tests/proxy_test.spec.ts b/l1-contracts/test/unit_tests/proxy_test.spec.ts index dd9a95fe5..46067e16f 100644 --- a/l1-contracts/test/unit_tests/proxy_test.spec.ts +++ b/l1-contracts/test/unit_tests/proxy_test.spec.ts @@ -45,7 +45,7 @@ describe("Diamond proxy tests", function () { diamondInit = DiamondInitFactory.connect(diamondInitContract.address, diamondInitContract.signer); const adminFactory = await hardhat.ethers.getContractFactory("AdminFacet"); - const adminContract = await adminFactory.deploy(); + const adminContract = await adminFactory.deploy(await owner.getChainId()); adminFacet = AdminFacetFactory.connect(adminContract.address, adminContract.signer); const gettersFacetFactory = await hardhat.ethers.getContractFactory("GettersFacet"); @@ -53,7 +53,7 @@ describe("Diamond proxy tests", function () { gettersFacet = GettersFacetFactory.connect(gettersFacetContract.address, gettersFacetContract.signer); const mailboxFacetFactory = await hardhat.ethers.getContractFactory("MailboxFacet"); - const mailboxFacetContract = await mailboxFacetFactory.deploy(chainId); + const mailboxFacetContract = await mailboxFacetFactory.deploy(chainId, await owner.getChainId()); mailboxFacet = MailboxFacetFactory.connect(mailboxFacetContract.address, mailboxFacetContract.signer); const executorFactory = await hardhat.ethers.getContractFactory("ExecutorFacet"); @@ -88,11 +88,11 @@ describe("Diamond proxy tests", function () { { chainId, bridgehub: dummyBridgehub.address, - stateTransitionManager: await owner.getAddress(), + chainTypeManager: await owner.getAddress(), protocolVersion: 0, admin: governorAddress, validatorTimelock: governorAddress, - baseToken: "0x0000000000000000000000000000000000000001", + baseTokenAssetId: "0x0000000000000000000000000000000000000000000000000000000000000001", baseTokenBridge: "0x0000000000000000000000000000000000000001", storedBatchZero: "0x02c775f0a90abf7a0e8043f2fdc38f0580ca9f9996a895d05a501bfeaa3b2e21", verifier: "0x0000000000000000000000000000000000000001", @@ -137,14 +137,14 @@ describe("Diamond proxy tests", function () { const proxyAsERC20 = TestnetERC20TokenFactory.connect(proxy.address, proxy.signer); const revertReason = await getCallRevertReason(proxyAsERC20.transfer(proxyAsERC20.address, 0)); - expect(revertReason).contains("InvalidSelector"); + expect(revertReason).contains("F"); }); it("check that proxy reject data with no selector", async () => { const dataWithoutSelector = "0x1122"; const revertReason = await getCallRevertReason(proxy.fallback({ data: dataWithoutSelector })); - expect(revertReason).contains("MalformedCalldata"); + expect(revertReason).contains("Ut"); }); it("should freeze the diamond storage", async () => { @@ -181,7 +181,7 @@ describe("Diamond proxy tests", function () { data: executorFacetSelector3 + "0000000000000000000000000000000000000000000000000000000000000000", }) ); - expect(revertReason).contains("FacetIsFrozen"); + expect(revertReason).contains("q1"); }); it("should be able to call an unfreezable facet when diamondStorage is frozen", async () => { diff --git a/l1-contracts/test/unit_tests/utils.ts b/l1-contracts/test/unit_tests/utils.ts index 7721c0f15..af74fa28f 100644 --- a/l1-contracts/test/unit_tests/utils.ts +++ b/l1-contracts/test/unit_tests/utils.ts @@ -10,9 +10,16 @@ import type { IMailbox } from "../../typechain/IMailbox"; import type { ExecutorFacet } from "../../typechain"; import type { FeeParams, L2CanonicalTransaction } from "../../src.ts/utils"; -import { ADDRESS_ONE, PubdataPricingMode, EMPTY_STRING_KECCAK } from "../../src.ts/utils"; +import { + ADDRESS_ONE, + PubdataPricingMode, + EMPTY_STRING_KECCAK, + STORED_BATCH_INFO_ABI_STRING, + COMMIT_BATCH_INFO_ABI_STRING, + PRIORITY_OPS_BATCH_INFO_ABI_STRING, +} from "../../src.ts/utils"; import { packSemver } from "../../scripts/utils"; -import { keccak256 } from "ethers/lib/utils"; +import { keccak256, hexConcat, defaultAbiCoder } from "ethers/lib/utils"; export const CONTRACTS_GENESIS_PROTOCOL_VERSION = packSemver(0, 21, 0).toString(); // eslint-disable-next-line @typescript-eslint/no-var-requires @@ -30,7 +37,6 @@ export const L2_BASE_TOKEN_SYSTEM_CONTRACT_ADDR = "0x000000000000000000000000000 export const L2_BYTECODE_COMPRESSOR_ADDRESS = "0x000000000000000000000000000000000000800e"; export const DEPLOYER_SYSTEM_CONTRACT_ADDRESS = "0x0000000000000000000000000000000000008006"; export const PUBDATA_CHUNK_PUBLISHER_ADDRESS = "0x0000000000000000000000000000000000008011"; -const PUBDATA_HASH = "0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563"; export const SYSTEM_UPGRADE_TX_TYPE = 254; @@ -40,8 +46,6 @@ export function randomAddress() { export enum SYSTEM_LOG_KEYS { L2_TO_L1_LOGS_TREE_ROOT_KEY, - TOTAL_L2_TO_L1_PUBDATA_KEY, - STATE_DIFF_HASH_KEY, PACKED_BATCH_AND_L2_BLOCK_TIMESTAMP_KEY, PREV_BATCH_HASH_KEY, CHAINED_PRIORITY_TXN_HASH_KEY, @@ -213,8 +217,6 @@ export function createSystemLogs( ) { return [ constructL2Log(true, L2_TO_L1_MESSENGER, SYSTEM_LOG_KEYS.L2_TO_L1_LOGS_TREE_ROOT_KEY, ethers.constants.HashZero), - constructL2Log(true, L2_TO_L1_MESSENGER, SYSTEM_LOG_KEYS.TOTAL_L2_TO_L1_PUBDATA_KEY, PUBDATA_HASH), - constructL2Log(true, L2_TO_L1_MESSENGER, SYSTEM_LOG_KEYS.STATE_DIFF_HASH_KEY, ethers.constants.HashZero), constructL2Log( true, L2_SYSTEM_CONTEXT_ADDRESS, @@ -264,8 +266,6 @@ export function createSystemLogsWithUpgrade( ) { return [ constructL2Log(true, L2_TO_L1_MESSENGER, SYSTEM_LOG_KEYS.L2_TO_L1_LOGS_TREE_ROOT_KEY, ethers.constants.HashZero), - constructL2Log(true, L2_TO_L1_MESSENGER, SYSTEM_LOG_KEYS.TOTAL_L2_TO_L1_PUBDATA_KEY, PUBDATA_HASH), - constructL2Log(true, L2_TO_L1_MESSENGER, SYSTEM_LOG_KEYS.STATE_DIFF_HASH_KEY, ethers.constants.HashZero), constructL2Log( true, L2_SYSTEM_CONTEXT_ADDRESS, @@ -369,10 +369,17 @@ export interface CommitBatchInfo { operatorDAInput: BytesLike; } +export interface PriorityOpsBatchInfo { + leftPath: Array; + rightPath: Array; + itemHashes: Array; +} + export async function depositERC20( bridge: IL1ERC20Bridge, bridgehubContract: IBridgehub, chainId: string, + l1ChainId: number, l2Receiver: string, l1Token: string, amount: ethers.BigNumber, @@ -509,14 +516,13 @@ export async function makeExecutedEqualCommitted( batchesToExecute = [...batchesToProve, ...batchesToExecute]; await ( - await proxyExecutor.proveBatches(prevBatchInfo, batchesToProve, { - recursiveAggregationInput: [], - serializedProof: [], - }) + await proxyExecutor.proveBatchesSharedBridge(0, ...encodeProveBatchesData(prevBatchInfo, batchesToProve, [])) ).wait(); const dummyMerkleProofs = batchesToExecute.map(() => ({ leftPath: [], rightPath: [], itemHashes: [] })); - await (await proxyExecutor.executeBatches(batchesToExecute, dummyMerkleProofs)).wait(); + await ( + await proxyExecutor.executeBatchesSharedBridge(0, ...encodeExecuteBatchesData(batchesToExecute, dummyMerkleProofs)) + ).wait(); } export function getBatchStoredInfo(commitInfo: CommitBatchInfo, commitment: string): StoredBatchInfo { @@ -531,3 +537,40 @@ export function getBatchStoredInfo(commitInfo: CommitBatchInfo, commitment: stri commitment: commitment, }; } + +export function encodeCommitBatchesData( + storedBatchInfo: StoredBatchInfo, + commitBatchInfos: Array +): [BigNumberish, BigNumberish, string] { + const encodedCommitDataWithoutVersion = defaultAbiCoder.encode( + [STORED_BATCH_INFO_ABI_STRING, `${COMMIT_BATCH_INFO_ABI_STRING}[]`], + [storedBatchInfo, commitBatchInfos] + ); + const commitData = hexConcat(["0x00", encodedCommitDataWithoutVersion]); + return [commitBatchInfos[0].batchNumber, commitBatchInfos[commitBatchInfos.length - 1].batchNumber, commitData]; +} + +export function encodeProveBatchesData( + prevBatch: StoredBatchInfo, + committedBatches: Array, + proof: Array +): [BigNumberish, BigNumberish, string] { + const encodedProveDataWithoutVersion = defaultAbiCoder.encode( + [STORED_BATCH_INFO_ABI_STRING, `${STORED_BATCH_INFO_ABI_STRING}[]`, "uint256[]"], + [prevBatch, committedBatches, proof] + ); + const proveData = hexConcat(["0x00", encodedProveDataWithoutVersion]); + return [committedBatches[0].batchNumber, committedBatches[committedBatches.length - 1].batchNumber, proveData]; +} + +export function encodeExecuteBatchesData( + batchesData: Array, + priorityOpsBatchInfo: Array +): [BigNumberish, BigNumberish, string] { + const encodedExecuteDataWithoutVersion = defaultAbiCoder.encode( + [`${STORED_BATCH_INFO_ABI_STRING}[]`, `${PRIORITY_OPS_BATCH_INFO_ABI_STRING}[]`], + [batchesData, priorityOpsBatchInfo] + ); + const executeData = hexConcat(["0x00", encodedExecuteDataWithoutVersion]); + return [batchesData[0].batchNumber, batchesData[batchesData.length - 1].batchNumber, executeData]; +} diff --git a/l1-contracts/test/unit_tests/validator_timelock_test.spec.ts b/l1-contracts/test/unit_tests/validator_timelock_test.spec.ts deleted file mode 100644 index e1ab8d9cf..000000000 --- a/l1-contracts/test/unit_tests/validator_timelock_test.spec.ts +++ /dev/null @@ -1,284 +0,0 @@ -import { expect } from "chai"; -import { ethers } from "ethers"; -import * as hardhat from "hardhat"; -import type { DummyExecutor, ValidatorTimelock, DummyStateTransitionManager } from "../../typechain"; -import { DummyExecutorFactory, ValidatorTimelockFactory, DummyStateTransitionManagerFactory } from "../../typechain"; -import { getCallRevertReason } from "./utils"; - -describe("ValidatorTimelock tests", function () { - let owner: ethers.Signer; - let validator: ethers.Signer; - let randomSigner: ethers.Signer; - let validatorTimelock: ValidatorTimelock; - let dummyExecutor: DummyExecutor; - let dummyStateTransitionManager: DummyStateTransitionManager; - const chainId: number = 270; - - const MOCK_PROOF_INPUT = { - recursiveAggregationInput: [], - serializedProof: [], - }; - - function getMockCommitBatchInfo(batchNumber: number, timestamp: number = 0) { - return { - batchNumber, - timestamp, - indexRepeatedStorageChanges: 0, - newStateRoot: ethers.constants.HashZero, - numberOfLayer1Txs: 0, - priorityOperationsHash: ethers.constants.HashZero, - bootloaderHeapInitialContentsHash: ethers.utils.randomBytes(32), - eventsQueueStateHash: ethers.utils.randomBytes(32), - systemLogs: [], - operatorDAInput: - "0x00290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e56300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", - }; - } - - function getMockStoredBatchInfo(batchNumber: number, timestamp: number = 0) { - return { - batchNumber, - batchHash: ethers.constants.HashZero, - indexRepeatedStorageChanges: 0, - numberOfLayer1Txs: 0, - priorityOperationsHash: ethers.constants.HashZero, - l2LogsTreeRoot: ethers.constants.HashZero, - timestamp, - commitment: ethers.constants.HashZero, - }; - } - - before(async () => { - [owner, validator, randomSigner] = await hardhat.ethers.getSigners(); - - const dummyExecutorFactory = await hardhat.ethers.getContractFactory("DummyExecutor"); - const dummyExecutorContract = await dummyExecutorFactory.deploy(); - dummyExecutor = DummyExecutorFactory.connect(dummyExecutorContract.address, dummyExecutorContract.signer); - - const dummyStateTransitionManagerFactory = await hardhat.ethers.getContractFactory("DummyStateTransitionManager"); - const dummyStateTransitionManagerContract = await dummyStateTransitionManagerFactory.deploy(); - dummyStateTransitionManager = DummyStateTransitionManagerFactory.connect( - dummyStateTransitionManagerContract.address, - dummyStateTransitionManagerContract.signer - ); - - const setSTtx = await dummyStateTransitionManager.setHyperchain(chainId, dummyExecutor.address); - await setSTtx.wait(); - - const validatorTimelockFactory = await hardhat.ethers.getContractFactory("ValidatorTimelock"); - const validatorTimelockContract = await validatorTimelockFactory.deploy(await owner.getAddress(), 0, chainId); - validatorTimelock = ValidatorTimelockFactory.connect( - validatorTimelockContract.address, - validatorTimelockContract.signer - ); - const setSTMtx = await validatorTimelock.setStateTransitionManager(dummyStateTransitionManager.address); - await setSTMtx.wait(); - }); - - it("Should check deployment", async () => { - expect(await validatorTimelock.owner()).equal(await owner.getAddress()); - expect(await validatorTimelock.executionDelay()).equal(0); - expect(await validatorTimelock.validators(chainId, ethers.constants.AddressZero)).equal(false); - expect(await validatorTimelock.stateTransitionManager()).equal(dummyStateTransitionManager.address); - expect(await dummyStateTransitionManager.getHyperchain(chainId)).equal(dummyExecutor.address); - expect(await dummyStateTransitionManager.getChainAdmin(chainId)).equal(await owner.getAddress()); - expect(await dummyExecutor.getAdmin()).equal(await owner.getAddress()); - }); - - it("Should revert if non-validator commits batches", async () => { - const revertReason = await getCallRevertReason( - validatorTimelock.connect(randomSigner).commitBatches(getMockStoredBatchInfo(0), [getMockCommitBatchInfo(1)]) - ); - - expect(revertReason).contains("Unauthorized"); - }); - - it("Should revert if non-validator proves batches", async () => { - const revertReason = await getCallRevertReason( - validatorTimelock - .connect(randomSigner) - .proveBatches(getMockStoredBatchInfo(0), [getMockStoredBatchInfo(1)], MOCK_PROOF_INPUT) - ); - - expect(revertReason).contains("Unauthorized"); - }); - - it("Should revert if non-validator revert batches", async () => { - const revertReason = await getCallRevertReason(validatorTimelock.connect(randomSigner).revertBatches(1)); - - expect(revertReason).contains("Unauthorized"); - }); - - it("Should revert if non-validator executes batches", async () => { - const revertReason = await getCallRevertReason( - validatorTimelock.connect(randomSigner).executeBatches([getMockStoredBatchInfo(1)], []) - ); - - expect(revertReason).contains("Unauthorized"); - }); - - it("Should revert if not chain governor sets validator", async () => { - const revertReason = await getCallRevertReason( - validatorTimelock.connect(randomSigner).addValidator(chainId, await randomSigner.getAddress()) - ); - - expect(revertReason).contains("Unauthorized"); - }); - - it("Should revert if non-owner sets execution delay", async () => { - const revertReason = await getCallRevertReason(validatorTimelock.connect(randomSigner).setExecutionDelay(1000)); - - expect(revertReason).equal("Ownable: caller is not the owner"); - }); - - it("Should successfully set the validator", async () => { - const validatorAddress = await validator.getAddress(); - await validatorTimelock.connect(owner).addValidator(chainId, validatorAddress); - - expect(await validatorTimelock.validators(chainId, validatorAddress)).equal(true); - }); - - it("Should successfully set the execution delay", async () => { - await validatorTimelock.connect(owner).setExecutionDelay(10); // set to 10 seconds - - expect(await validatorTimelock.executionDelay()).equal(10); - }); - - it("Should successfully commit batches", async () => { - await validatorTimelock - .connect(validator) - .commitBatchesSharedBridge(chainId, getMockStoredBatchInfo(0), [getMockCommitBatchInfo(1)]); - - expect(await dummyExecutor.getTotalBatchesCommitted()).equal(1); - }); - - it("Should successfully prove batches", async () => { - await validatorTimelock - .connect(validator) - .proveBatchesSharedBridge(chainId, getMockStoredBatchInfo(0), [getMockStoredBatchInfo(1, 1)], MOCK_PROOF_INPUT); - - expect(await dummyExecutor.getTotalBatchesVerified()).equal(1); - }); - - it("Should revert on executing earlier than the delay", async () => { - const revertReason = await getCallRevertReason( - validatorTimelock.connect(validator).executeBatchesSharedBridge(chainId, [getMockStoredBatchInfo(1)], []) - ); - - expect(revertReason).contains("TimeNotReached"); - }); - - it("Should successfully revert batches", async () => { - await validatorTimelock.connect(validator).revertBatchesSharedBridge(chainId, 0); - - expect(await dummyExecutor.getTotalBatchesVerified()).equal(0); - expect(await dummyExecutor.getTotalBatchesCommitted()).equal(0); - }); - - it("Should successfully overwrite the committing timestamp on the reverted batches timestamp", async () => { - const revertedBatchesTimestamp = Number(await validatorTimelock.getCommittedBatchTimestamp(chainId, 1)); - - await validatorTimelock - .connect(validator) - .commitBatchesSharedBridge(chainId, getMockStoredBatchInfo(0), [getMockCommitBatchInfo(1)]); - - await validatorTimelock - .connect(validator) - .proveBatchesSharedBridge(chainId, getMockStoredBatchInfo(0), [getMockStoredBatchInfo(1)], MOCK_PROOF_INPUT); - - const newBatchesTimestamp = Number(await validatorTimelock.getCommittedBatchTimestamp(chainId, 1)); - - expect(newBatchesTimestamp).greaterThanOrEqual(revertedBatchesTimestamp); - }); - - it("Should successfully execute batches after the delay", async () => { - await hardhat.network.provider.send("hardhat_mine", ["0x2", "0xc"]); //mine 2 batches with intervals of 12 seconds - await validatorTimelock.connect(validator).executeBatchesSharedBridge(chainId, [getMockStoredBatchInfo(1)], []); - expect(await dummyExecutor.getTotalBatchesExecuted()).equal(1); - }); - - it("Should revert if validator tries to commit batches with invalid last committed batchNumber", async () => { - const revertReason = await getCallRevertReason( - validatorTimelock - .connect(validator) - .commitBatchesSharedBridge(chainId, getMockStoredBatchInfo(0), [getMockCommitBatchInfo(2)]) - ); - - // Error should be forwarded from the DummyExecutor - expect(revertReason).equal("DummyExecutor: Invalid last committed batch number"); - }); - - // Test case to check if proving batches with invalid batchNumber fails - it("Should revert if validator tries to prove batches with invalid batchNumber", async () => { - const revertReason = await getCallRevertReason( - validatorTimelock - .connect(validator) - .proveBatchesSharedBridge(chainId, getMockStoredBatchInfo(0), [getMockStoredBatchInfo(2, 1)], MOCK_PROOF_INPUT) - ); - - expect(revertReason).equal("DummyExecutor: Invalid previous batch number"); - }); - - it("Should revert if validator tries to execute more batches than were proven", async () => { - await hardhat.network.provider.send("hardhat_mine", ["0x2", "0xc"]); //mine 2 batches with intervals of 12 seconds - const revertReason = await getCallRevertReason( - validatorTimelock.connect(validator).executeBatchesSharedBridge(chainId, [getMockStoredBatchInfo(2)], []) - ); - - expect(revertReason).equal("DummyExecutor 2: Can"); - }); - - // These tests primarily needed to make gas statistics be more accurate. - - it("Should commit multiple batches in one transaction", async () => { - await validatorTimelock - .connect(validator) - .commitBatchesSharedBridge(chainId, getMockStoredBatchInfo(1), [ - getMockCommitBatchInfo(2), - getMockCommitBatchInfo(3), - getMockCommitBatchInfo(4), - getMockCommitBatchInfo(5), - getMockCommitBatchInfo(6), - getMockCommitBatchInfo(7), - getMockCommitBatchInfo(8), - ]); - - expect(await dummyExecutor.getTotalBatchesCommitted()).equal(8); - }); - - it("Should prove multiple batches in one transactions", async () => { - for (let i = 1; i < 8; i++) { - await validatorTimelock - .connect(validator) - .proveBatchesSharedBridge( - chainId, - getMockStoredBatchInfo(i), - [getMockStoredBatchInfo(i + 1)], - MOCK_PROOF_INPUT - ); - - expect(await dummyExecutor.getTotalBatchesVerified()).equal(i + 1); - } - }); - - it("Should execute multiple batches in multiple transactions", async () => { - await hardhat.network.provider.send("hardhat_mine", ["0x2", "0xc"]); //mine 2 batches with intervals of 12 seconds - await validatorTimelock - .connect(validator) - .executeBatchesSharedBridge( - chainId, - [ - getMockStoredBatchInfo(2), - getMockStoredBatchInfo(3), - getMockStoredBatchInfo(4), - getMockStoredBatchInfo(5), - getMockStoredBatchInfo(6), - getMockStoredBatchInfo(7), - getMockStoredBatchInfo(8), - ], - [] - ); - - expect(await dummyExecutor.getTotalBatchesExecuted()).equal(8); - }); -}); diff --git a/l2-contracts/contracts/ConsensusRegistry.sol b/l2-contracts/contracts/ConsensusRegistry.sol new file mode 100644 index 000000000..de5af6340 --- /dev/null +++ b/l2-contracts/contracts/ConsensusRegistry.sol @@ -0,0 +1,486 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable-v4/access/Ownable2StepUpgradeable.sol"; +import {Initializable} from "@openzeppelin/contracts-upgradeable-v4/proxy/utils/Initializable.sol"; +import {IConsensusRegistry} from "./interfaces/IConsensusRegistry.sol"; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @title ConsensusRegistry +/// @dev Manages consensus nodes and committees for the L2 consensus protocol, +/// owned by Matter Labs Multisig. Nodes act as both validators and attesters, +/// each playing a distinct role in the consensus process. This contract facilitates +/// the rotation of validator and attester committees, which represent a subset of nodes +/// expected to actively participate in the consensus process during a specific time window. +/// @dev Designed for use with a proxy for upgradability. +contract ConsensusRegistry is IConsensusRegistry, Initializable, Ownable2StepUpgradeable { + /// @dev An array to keep track of node owners. + address[] public nodeOwners; + /// @dev A mapping of node owners => nodes. + mapping(address => Node) public nodes; + /// @dev A mapping for enabling efficient lookups when checking whether a given attester public key exists. + mapping(bytes32 => bool) public attesterPubKeyHashes; + /// @dev A mapping for enabling efficient lookups when checking whether a given validator public key exists. + mapping(bytes32 => bool) public validatorPubKeyHashes; + /// @dev Counter that increments with each new commit to the attester committee. + uint32 public attestersCommit; + /// @dev Counter that increments with each new commit to the validator committee. + uint32 public validatorsCommit; + + modifier onlyOwnerOrNodeOwner(address _nodeOwner) { + if (owner() != msg.sender && _nodeOwner != msg.sender) { + revert UnauthorizedOnlyOwnerOrNodeOwner(); + } + _; + } + + function initialize(address _initialOwner) external initializer { + if (_initialOwner == address(0)) { + revert InvalidInputNodeOwnerAddress(); + } + _transferOwnership(_initialOwner); + } + + /// @notice Adds a new node to the registry. + /// @dev Fails if node owner already exists. + /// @dev Fails if a validator/attester with the same public key already exists. + /// @param _nodeOwner The address of the new node's owner. + /// @param _validatorWeight The voting weight of the validator. + /// @param _validatorPubKey The BLS12-381 public key of the validator. + /// @param _validatorPoP The proof-of-possession (PoP) of the validator's public key. + /// @param _attesterWeight The voting weight of the attester. + /// @param _attesterPubKey The ECDSA public key of the attester. + function add( + address _nodeOwner, + uint32 _validatorWeight, + BLS12_381PublicKey calldata _validatorPubKey, + BLS12_381Signature calldata _validatorPoP, + uint32 _attesterWeight, + Secp256k1PublicKey calldata _attesterPubKey + ) external onlyOwner { + // Verify input. + _verifyInputAddress(_nodeOwner); + _verifyInputBLS12_381PublicKey(_validatorPubKey); + _verifyInputBLS12_381Signature(_validatorPoP); + _verifyInputSecp256k1PublicKey(_attesterPubKey); + + // Verify storage. + _verifyNodeOwnerDoesNotExist(_nodeOwner); + bytes32 attesterPubKeyHash = _hashAttesterPubKey(_attesterPubKey); + _verifyAttesterPubKeyDoesNotExist(attesterPubKeyHash); + bytes32 validatorPubKeyHash = _hashValidatorPubKey(_validatorPubKey); + _verifyValidatorPubKeyDoesNotExist(validatorPubKeyHash); + + uint32 nodeOwnerIdx = uint32(nodeOwners.length); + nodeOwners.push(_nodeOwner); + nodes[_nodeOwner] = Node({ + attesterLatest: AttesterAttr({ + active: true, + removed: false, + weight: _attesterWeight, + pubKey: _attesterPubKey + }), + attesterSnapshot: AttesterAttr({ + active: false, + removed: false, + weight: 0, + pubKey: Secp256k1PublicKey({tag: bytes1(0), x: bytes32(0)}) + }), + attesterLastUpdateCommit: attestersCommit, + validatorLatest: ValidatorAttr({ + active: true, + removed: false, + weight: _validatorWeight, + pubKey: _validatorPubKey, + proofOfPossession: _validatorPoP + }), + validatorSnapshot: ValidatorAttr({ + active: false, + removed: false, + weight: 0, + pubKey: BLS12_381PublicKey({a: bytes32(0), b: bytes32(0), c: bytes32(0)}), + proofOfPossession: BLS12_381Signature({a: bytes32(0), b: bytes16(0)}) + }), + validatorLastUpdateCommit: validatorsCommit, + nodeOwnerIdx: nodeOwnerIdx + }); + attesterPubKeyHashes[attesterPubKeyHash] = true; + validatorPubKeyHashes[validatorPubKeyHash] = true; + + emit NodeAdded({ + nodeOwner: _nodeOwner, + validatorWeight: _validatorWeight, + validatorPubKey: _validatorPubKey, + validatorPoP: _validatorPoP, + attesterWeight: _attesterWeight, + attesterPubKey: _attesterPubKey + }); + } + + /// @notice Deactivates a node, preventing it from participating in committees. + /// @dev Only callable by the contract owner or the node owner. + /// @dev Verifies that the node owner exists in the registry. + /// @param _nodeOwner The address of the node's owner to be inactivated. + function deactivate(address _nodeOwner) external onlyOwnerOrNodeOwner(_nodeOwner) { + _verifyNodeOwnerExists(_nodeOwner); + (Node storage node, bool deleted) = _getNodeAndDeleteIfRequired(_nodeOwner); + if (deleted) { + return; + } + + _ensureAttesterSnapshot(node); + node.attesterLatest.active = false; + _ensureValidatorSnapshot(node); + node.validatorLatest.active = false; + + emit NodeDeactivated(_nodeOwner); + } + + /// @notice Activates a previously inactive node, allowing it to participate in committees. + /// @dev Only callable by the contract owner or the node owner. + /// @dev Verifies that the node owner exists in the registry. + /// @param _nodeOwner The address of the node's owner to be activated. + function activate(address _nodeOwner) external onlyOwnerOrNodeOwner(_nodeOwner) { + _verifyNodeOwnerExists(_nodeOwner); + (Node storage node, bool deleted) = _getNodeAndDeleteIfRequired(_nodeOwner); + if (deleted) { + return; + } + + _ensureAttesterSnapshot(node); + node.attesterLatest.active = true; + _ensureValidatorSnapshot(node); + node.validatorLatest.active = true; + + emit NodeActivated(_nodeOwner); + } + + /// @notice Removes a node from the registry. + /// @dev Only callable by the contract owner. + /// @dev Verifies that the node owner exists in the registry. + /// @param _nodeOwner The address of the node's owner to be removed. + function remove(address _nodeOwner) external onlyOwner { + _verifyNodeOwnerExists(_nodeOwner); + (Node storage node, bool deleted) = _getNodeAndDeleteIfRequired(_nodeOwner); + if (deleted) { + return; + } + + _ensureAttesterSnapshot(node); + node.attesterLatest.removed = true; + _ensureValidatorSnapshot(node); + node.validatorLatest.removed = true; + + emit NodeRemoved(_nodeOwner); + } + + /// @notice Changes the validator weight of a node in the registry. + /// @dev Only callable by the contract owner. + /// @dev Verifies that the node owner exists in the registry. + /// @param _nodeOwner The address of the node's owner whose validator weight will be changed. + /// @param _weight The new validator weight to assign to the node. + function changeValidatorWeight(address _nodeOwner, uint32 _weight) external onlyOwner { + _verifyNodeOwnerExists(_nodeOwner); + (Node storage node, bool deleted) = _getNodeAndDeleteIfRequired(_nodeOwner); + if (deleted) { + return; + } + + _ensureValidatorSnapshot(node); + node.validatorLatest.weight = _weight; + + emit NodeValidatorWeightChanged(_nodeOwner, _weight); + } + + /// @notice Changes the attester weight of a node in the registry. + /// @dev Only callable by the contract owner. + /// @dev Verifies that the node owner exists in the registry. + /// @param _nodeOwner The address of the node's owner whose attester weight will be changed. + /// @param _weight The new attester weight to assign to the node. + function changeAttesterWeight(address _nodeOwner, uint32 _weight) external onlyOwner { + _verifyNodeOwnerExists(_nodeOwner); + (Node storage node, bool deleted) = _getNodeAndDeleteIfRequired(_nodeOwner); + if (deleted) { + return; + } + + _ensureAttesterSnapshot(node); + node.attesterLatest.weight = _weight; + + emit NodeAttesterWeightChanged(_nodeOwner, _weight); + } + + /// @notice Changes the validator's public key and proof-of-possession in the registry. + /// @dev Only callable by the contract owner or the node owner. + /// @dev Verifies that the node owner exists in the registry. + /// @param _nodeOwner The address of the node's owner whose validator key and PoP will be changed. + /// @param _pubKey The new BLS12-381 public key to assign to the node's validator. + /// @param _pop The new proof-of-possession (PoP) to assign to the node's validator. + function changeValidatorKey( + address _nodeOwner, + BLS12_381PublicKey calldata _pubKey, + BLS12_381Signature calldata _pop + ) external onlyOwnerOrNodeOwner(_nodeOwner) { + _verifyInputBLS12_381PublicKey(_pubKey); + _verifyInputBLS12_381Signature(_pop); + _verifyNodeOwnerExists(_nodeOwner); + (Node storage node, bool deleted) = _getNodeAndDeleteIfRequired(_nodeOwner); + if (deleted) { + return; + } + + bytes32 prevHash = _hashValidatorPubKey(node.validatorLatest.pubKey); + delete validatorPubKeyHashes[prevHash]; + bytes32 newHash = _hashValidatorPubKey(_pubKey); + _verifyValidatorPubKeyDoesNotExist(newHash); + validatorPubKeyHashes[newHash] = true; + _ensureValidatorSnapshot(node); + node.validatorLatest.pubKey = _pubKey; + node.validatorLatest.proofOfPossession = _pop; + + emit NodeValidatorKeyChanged(_nodeOwner, _pubKey, _pop); + } + + /// @notice Changes the attester's public key of a node in the registry. + /// @dev Only callable by the contract owner or the node owner. + /// @dev Verifies that the node owner exists in the registry. + /// @param _nodeOwner The address of the node's owner whose attester public key will be changed. + /// @param _pubKey The new ECDSA public key to assign to the node's attester. + function changeAttesterKey( + address _nodeOwner, + Secp256k1PublicKey calldata _pubKey + ) external onlyOwnerOrNodeOwner(_nodeOwner) { + _verifyInputSecp256k1PublicKey(_pubKey); + _verifyNodeOwnerExists(_nodeOwner); + (Node storage node, bool deleted) = _getNodeAndDeleteIfRequired(_nodeOwner); + if (deleted) { + return; + } + + bytes32 prevHash = _hashAttesterPubKey(node.attesterLatest.pubKey); + delete attesterPubKeyHashes[prevHash]; + bytes32 newHash = _hashAttesterPubKey(_pubKey); + _verifyAttesterPubKeyDoesNotExist(newHash); + attesterPubKeyHashes[newHash] = true; + + _ensureAttesterSnapshot(node); + node.attesterLatest.pubKey = _pubKey; + + emit NodeAttesterKeyChanged(_nodeOwner, _pubKey); + } + + /// @notice Adds a new commit to the attester committee. + /// @dev Implicitly updates the attester committee by affecting readers based on the current state of a node's attester attributes: + /// - If "attestersCommit" > "node.attesterLastUpdateCommit", read "node.attesterLatest". + /// - If "attestersCommit" == "node.attesterLastUpdateCommit", read "node.attesterSnapshot". + /// @dev Only callable by the contract owner. + function commitAttesterCommittee() external onlyOwner { + ++attestersCommit; + + emit AttestersCommitted(attestersCommit); + } + + /// @notice Adds a new commit to the validator committee. + /// @dev Implicitly updates the validator committee by affecting readers based on the current state of a node's validator attributes: + /// - If "validatorsCommit" > "node.validatorLastUpdateCommit", read "node.validatorLatest". + /// - If "validatorsCommit" == "node.validatorLastUpdateCommit", read "node.validatorSnapshot". + /// @dev Only callable by the contract owner. + function commitValidatorCommittee() external onlyOwner { + ++validatorsCommit; + + emit ValidatorsCommitted(validatorsCommit); + } + + /// @notice Returns an array of `AttesterAttr` structs representing the current attester committee. + /// @dev Collects active and non-removed attesters based on the latest commit to the committee. + function getAttesterCommittee() public view returns (CommitteeAttester[] memory) { + uint256 len = nodeOwners.length; + CommitteeAttester[] memory committee = new CommitteeAttester[](len); + uint256 count = 0; + + for (uint256 i = 0; i < len; ++i) { + Node storage node = nodes[nodeOwners[i]]; + AttesterAttr memory attester = attestersCommit > node.attesterLastUpdateCommit + ? node.attesterLatest + : node.attesterSnapshot; + if (attester.active && !attester.removed) { + committee[count] = CommitteeAttester({weight: attester.weight, pubKey: attester.pubKey}); + ++count; + } + } + + // Resize the array. + assembly { + mstore(committee, count) + } + return committee; + } + + /// @notice Returns an array of `ValidatorAttr` structs representing the current attester committee. + /// @dev Collects active and non-removed validators based on the latest commit to the committee. + function getValidatorCommittee() public view returns (CommitteeValidator[] memory) { + uint256 len = nodeOwners.length; + CommitteeValidator[] memory committee = new CommitteeValidator[](len); + uint256 count = 0; + + for (uint256 i = 0; i < len; ++i) { + Node storage node = nodes[nodeOwners[i]]; + ValidatorAttr memory validator = validatorsCommit > node.validatorLastUpdateCommit + ? node.validatorLatest + : node.validatorSnapshot; + if (validator.active && !validator.removed) { + committee[count] = CommitteeValidator({ + weight: validator.weight, + pubKey: validator.pubKey, + proofOfPossession: validator.proofOfPossession + }); + ++count; + } + } + + // Resize the array. + assembly { + mstore(committee, count) + } + return committee; + } + + function numNodes() public view returns (uint256) { + return nodeOwners.length; + } + + function _getNodeAndDeleteIfRequired(address _nodeOwner) private returns (Node storage, bool) { + Node storage node = nodes[_nodeOwner]; + bool pendingDeletion = _isNodePendingDeletion(node); + if (pendingDeletion) { + _deleteNode(_nodeOwner, node); + } + return (node, pendingDeletion); + } + + function _isNodePendingDeletion(Node storage _node) private returns (bool) { + bool attesterRemoved = (attestersCommit > _node.attesterLastUpdateCommit) + ? _node.attesterLatest.removed + : _node.attesterSnapshot.removed; + bool validatorRemoved = (validatorsCommit > _node.validatorLastUpdateCommit) + ? _node.validatorLatest.removed + : _node.validatorSnapshot.removed; + return attesterRemoved && validatorRemoved; + } + + function _deleteNode(address _nodeOwner, Node storage _node) private { + // Delete from array by swapping the last node owner (gas-efficient, not preserving order). + address lastNodeOwner = nodeOwners[nodeOwners.length - 1]; + nodeOwners[_node.nodeOwnerIdx] = lastNodeOwner; + nodeOwners.pop(); + // Update the node owned by the last node owner. + nodes[lastNodeOwner].nodeOwnerIdx = _node.nodeOwnerIdx; + + // Delete from the remaining mapping. + delete attesterPubKeyHashes[_hashAttesterPubKey(_node.attesterLatest.pubKey)]; + delete validatorPubKeyHashes[_hashValidatorPubKey(_node.validatorLatest.pubKey)]; + delete nodes[_nodeOwner]; + + emit NodeDeleted(_nodeOwner); + } + + function _ensureAttesterSnapshot(Node storage _node) private { + if (_node.attesterLastUpdateCommit < attestersCommit) { + _node.attesterSnapshot = _node.attesterLatest; + _node.attesterLastUpdateCommit = attestersCommit; + } + } + + function _ensureValidatorSnapshot(Node storage _node) private { + if (_node.validatorLastUpdateCommit < validatorsCommit) { + _node.validatorSnapshot = _node.validatorLatest; + _node.validatorLastUpdateCommit = validatorsCommit; + } + } + + function _isNodeOwnerExists(address _nodeOwner) private view returns (bool) { + BLS12_381PublicKey storage pubKey = nodes[_nodeOwner].validatorLatest.pubKey; + if (pubKey.a == bytes32(0) && pubKey.b == bytes32(0) && pubKey.c == bytes32(0)) { + return false; + } + return true; + } + + function _verifyNodeOwnerExists(address _nodeOwner) private view { + if (!_isNodeOwnerExists(_nodeOwner)) { + revert NodeOwnerDoesNotExist(); + } + } + + function _verifyNodeOwnerDoesNotExist(address _nodeOwner) private view { + if (_isNodeOwnerExists(_nodeOwner)) { + revert NodeOwnerExists(); + } + } + + function _hashAttesterPubKey(Secp256k1PublicKey storage _pubKey) private view returns (bytes32) { + return keccak256(abi.encode(_pubKey.tag, _pubKey.x)); + } + + function _hashAttesterPubKey(Secp256k1PublicKey calldata _pubKey) private pure returns (bytes32) { + return keccak256(abi.encode(_pubKey.tag, _pubKey.x)); + } + + function _hashValidatorPubKey(BLS12_381PublicKey storage _pubKey) private view returns (bytes32) { + return keccak256(abi.encode(_pubKey.a, _pubKey.b, _pubKey.c)); + } + + function _hashValidatorPubKey(BLS12_381PublicKey calldata _pubKey) private pure returns (bytes32) { + return keccak256(abi.encode(_pubKey.a, _pubKey.b, _pubKey.c)); + } + + function _verifyInputAddress(address _nodeOwner) private pure { + if (_nodeOwner == address(0)) { + revert InvalidInputNodeOwnerAddress(); + } + } + + function _verifyAttesterPubKeyDoesNotExist(bytes32 _hash) private view { + if (attesterPubKeyHashes[_hash]) { + revert AttesterPubKeyExists(); + } + } + + function _verifyValidatorPubKeyDoesNotExist(bytes32 _hash) private { + if (validatorPubKeyHashes[_hash]) { + revert ValidatorPubKeyExists(); + } + } + + function _verifyInputBLS12_381PublicKey(BLS12_381PublicKey calldata _pubKey) private pure { + if (_isEmptyBLS12_381PublicKey(_pubKey)) { + revert InvalidInputBLS12_381PublicKey(); + } + } + + function _verifyInputBLS12_381Signature(BLS12_381Signature calldata _pop) private pure { + if (_isEmptyBLS12_381Signature(_pop)) { + revert InvalidInputBLS12_381Signature(); + } + } + + function _verifyInputSecp256k1PublicKey(Secp256k1PublicKey calldata _pubKey) private pure { + if (_isEmptySecp256k1PublicKey(_pubKey)) { + revert InvalidInputSecp256k1PublicKey(); + } + } + + function _isEmptyBLS12_381PublicKey(BLS12_381PublicKey calldata _pubKey) private pure returns (bool) { + return _pubKey.a == bytes32(0) && _pubKey.b == bytes32(0) && _pubKey.c == bytes32(0); + } + + function _isEmptyBLS12_381Signature(BLS12_381Signature calldata _pop) private pure returns (bool) { + return _pop.a == bytes32(0) && _pop.b == bytes16(0); + } + + function _isEmptySecp256k1PublicKey(Secp256k1PublicKey calldata _pubKey) private pure returns (bool) { + return _pubKey.tag == bytes1(0) && _pubKey.x == bytes32(0); + } +} diff --git a/l2-contracts/contracts/L2ContractHelper.sol b/l2-contracts/contracts/L2ContractHelper.sol index 97bf6b55e..620e9b3ee 100644 --- a/l2-contracts/contracts/L2ContractHelper.sol +++ b/l2-contracts/contracts/L2ContractHelper.sol @@ -3,8 +3,6 @@ pragma solidity ^0.8.20; import {EfficientCall} from "@matterlabs/zksync-contracts/l2/system-contracts/libraries/EfficientCall.sol"; -import {IL2AssetRouter} from "./bridge/interfaces/IL2AssetRouter.sol"; -import {IL2NativeTokenVault} from "./bridge/interfaces/IL2NativeTokenVault.sol"; import {MalformedBytecode, BytecodeError} from "./errors/L2ContractErrors.sol"; /** @@ -56,6 +54,13 @@ interface IContractDeployer { /// @param _bytecodeHash the bytecodehash of the new contract to be deployed /// @param _input the calldata to be sent to the constructor of the new contract function create2(bytes32 _salt, bytes32 _bytecodeHash, bytes calldata _input) external returns (address); + + function getNewAddressCreate2( + address _sender, + bytes32 _bytecodeHash, + bytes32 _salt, + bytes calldata _input + ) external view returns (address newAddress); } /** @@ -108,11 +113,6 @@ address constant DEPLOYER_SYSTEM_CONTRACT = address(SYSTEM_CONTRACTS_OFFSET + 0x address constant L2_BRIDGEHUB_ADDRESS = address(USER_CONTRACTS_OFFSET + 0x02); -IL2AssetRouter constant L2_ASSET_ROUTER = IL2AssetRouter(address(USER_CONTRACTS_OFFSET + 0x03)); - -/// @dev The contract responsible for handling tokens native to a single chain. -IL2NativeTokenVault constant L2_NATIVE_TOKEN_VAULT = IL2NativeTokenVault(address(USER_CONTRACTS_OFFSET + 0x04)); - uint256 constant L1_CHAIN_ID = 1; IL2Messenger constant L2_MESSENGER = IL2Messenger(address(SYSTEM_CONTRACTS_OFFSET + 0x08)); @@ -193,6 +193,35 @@ library L2ContractHelper { // Setting the length hashedBytecode = hashedBytecode | bytes32(bytecodeLenInWords << 224); } + + /// @notice Validate the bytecode format and calculate its hash. + /// @param _bytecode The bytecode to hash. + /// @return hashedBytecode The 32-byte hash of the bytecode. + /// Note: The function reverts the execution if the bytecode has non expected format: + /// - Bytecode bytes length is not a multiple of 32 + /// - Bytecode bytes length is not less than 2^21 bytes (2^16 words) + /// - Bytecode words length is not odd + function hashL2BytecodeMemory(bytes memory _bytecode) internal view returns (bytes32 hashedBytecode) { + // Note that the length of the bytecode must be provided in 32-byte words. + if (_bytecode.length % 32 != 0) { + revert MalformedBytecode(BytecodeError.Length); + } + + uint256 bytecodeLenInWords = _bytecode.length / 32; + // bytecode length must be less than 2^16 words + if (bytecodeLenInWords >= 2 ** 16) { + revert MalformedBytecode(BytecodeError.NumberOfWords); + } + // bytecode length in words must be odd + if (bytecodeLenInWords % 2 == 0) { + revert MalformedBytecode(BytecodeError.WordsMustBeOdd); + } + hashedBytecode = sha256(_bytecode) & 0x00000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF; + // Setting the version of the hash + hashedBytecode = (hashedBytecode | bytes32(uint256(1 << 248))); + // Setting the length + hashedBytecode = hashedBytecode | bytes32(bytecodeLenInWords << 224); + } } /// @notice Structure used to represent a ZKsync transaction. diff --git a/l2-contracts/contracts/bridge/L2AssetRouter.sol b/l2-contracts/contracts/bridge/L2AssetRouter.sol deleted file mode 100644 index d143517b1..000000000 --- a/l2-contracts/contracts/bridge/L2AssetRouter.sol +++ /dev/null @@ -1,198 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.20; - -import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol"; -import {UpgradeableBeacon} from "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol"; - -import {IL2AssetRouter} from "./interfaces/IL2AssetRouter.sol"; -import {IL1AssetRouter} from "./interfaces/IL1AssetRouter.sol"; -import {ILegacyL2SharedBridge} from "./interfaces/ILegacyL2SharedBridge.sol"; -import {IL2AssetHandler} from "./interfaces/IL2AssetHandler.sol"; -import {IL2StandardToken} from "./interfaces/IL2StandardToken.sol"; -import {IL2NativeTokenVault} from "./interfaces/IL2NativeTokenVault.sol"; - -import {AddressAliasHelper} from "../vendor/AddressAliasHelper.sol"; -import {L2ContractHelper, L2_NATIVE_TOKEN_VAULT} from "../L2ContractHelper.sol"; -import {DataEncoding} from "../common/libraries/DataEncoding.sol"; - -import {EmptyAddress, InvalidCaller} from "../errors/L2ContractErrors.sol"; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -/// @notice The "default" bridge implementation for the ERC20 tokens. Note, that it does not -/// support any custom token logic, i.e. rebase tokens' functionality is not supported. -contract L2AssetRouter is IL2AssetRouter, ILegacyL2SharedBridge, Initializable { - /// @dev Chain ID of Era for legacy reasons - uint256 public immutable ERA_CHAIN_ID; - - /// @dev Chain ID of L1 for bridging reasons - uint256 public immutable L1_CHAIN_ID; - - /// @dev The address of the L1 shared bridge counterpart. - address public override l1SharedBridge; - - /// @dev Contract that stores the implementation address for token. - /// @dev For more details see https://docs.openzeppelin.com/contracts/3.x/api/proxy#UpgradeableBeacon. - UpgradeableBeacon public DEPRECATED_l2TokenBeacon; - - /// @dev Bytecode hash of the proxy for tokens deployed by the bridge. - bytes32 internal DEPRECATED_l2TokenProxyBytecodeHash; - - /// @notice Deprecated. Kept for backwards compatibility. - /// @dev A mapping l2 token address => l1 token address - mapping(address l2Token => address l1Token) public override l1TokenAddress; - - /// @notice Obsolete, as all calls are performed via L1 Shared Bridge. Kept for backwards compatibility. - /// @dev The address of the legacy L1 erc20 bridge counterpart. - /// This is non-zero only on Era, and should not be renamed for backward compatibility with the SDKs. - address public override l1Bridge; - - /// @dev The contract responsible for handling tokens native to a single chain. - IL2NativeTokenVault public nativeTokenVault; - - /// @dev A mapping of asset ID to asset handler address - mapping(bytes32 assetId => address assetHandlerAddress) public override assetHandlerAddress; - - /// @notice Checks that the message sender is the legacy bridge. - modifier onlyL1Bridge() { - // Only the L1 bridge counterpart can initiate and finalize the deposit. - if ( - AddressAliasHelper.undoL1ToL2Alias(msg.sender) != l1Bridge && - AddressAliasHelper.undoL1ToL2Alias(msg.sender) != l1SharedBridge - ) { - revert InvalidCaller(msg.sender); - } - _; - } - - /// @dev Contract is expected to be used as proxy implementation. - /// @dev Disable the initialization to prevent Parity hack. - /// @param _l1SharedBridge The address of the L1 Bridge contract. - /// @param _l1Bridge The address of the legacy L1 Bridge contract. - constructor(uint256 _eraChainId, uint256 _l1ChainId, address _l1SharedBridge, address _l1Bridge) { - ERA_CHAIN_ID = _eraChainId; - L1_CHAIN_ID = _l1ChainId; - if (_l1SharedBridge == address(0)) { - revert EmptyAddress(); - } - - l1SharedBridge = _l1SharedBridge; - if (block.chainid == ERA_CHAIN_ID) { - if (_l1Bridge == address(0)) { - revert EmptyAddress(); - } - if (l1Bridge == address(0)) { - l1Bridge = _l1Bridge; - } - } - _disableInitializers(); - } - - /// @dev Used to set the assedAddress for a given assetId. - /// @dev Will be used by ZK Gateway - function setAssetHandlerAddress(bytes32 _assetId, address _assetAddress) external onlyL1Bridge { - assetHandlerAddress[_assetId] = _assetAddress; - emit AssetHandlerRegistered(_assetId, _assetAddress); - } - - /// @notice Finalize the deposit and mint funds - /// @param _assetId The encoding of the asset on L2 - /// @param _transferData The encoded data required for deposit (address _l1Sender, uint256 _amount, address _l2Receiver, bytes memory erc20Data, address originToken) - function finalizeDeposit(bytes32 _assetId, bytes memory _transferData) public override onlyL1Bridge { - address assetHandler = assetHandlerAddress[_assetId]; - if (assetHandler != address(0)) { - IL2AssetHandler(assetHandler).bridgeMint(L1_CHAIN_ID, _assetId, _transferData); - } else { - L2_NATIVE_TOKEN_VAULT.bridgeMint(L1_CHAIN_ID, _assetId, _transferData); - assetHandlerAddress[_assetId] = address(L2_NATIVE_TOKEN_VAULT); - } - - emit FinalizeDepositSharedBridge(L1_CHAIN_ID, _assetId, _transferData); - } - - /// @notice Initiates a withdrawal by burning funds on the contract and sending the message to L1 - /// where tokens would be unlocked - /// @param _assetId The asset id of the withdrawn asset - /// @param _assetData The data that is passed to the asset handler contract - function withdraw(bytes32 _assetId, bytes memory _assetData) public override { - address assetHandler = assetHandlerAddress[_assetId]; - bytes memory _l1bridgeMintData = IL2AssetHandler(assetHandler).bridgeBurn({ - _chainId: L1_CHAIN_ID, - _mintValue: 0, - _assetId: _assetId, - _prevMsgSender: msg.sender, - _data: _assetData - }); - - bytes memory message = _getL1WithdrawMessage(_assetId, _l1bridgeMintData); - L2ContractHelper.sendMessageToL1(message); - - emit WithdrawalInitiatedSharedBridge(L1_CHAIN_ID, msg.sender, _assetId, _assetData); - } - - /// @notice Encodes the message for l2ToL1log sent during withdraw initialization. - /// @param _assetId The encoding of the asset on L2 which is withdrawn. - /// @param _l1bridgeMintData The calldata used by l1 asset handler to unlock tokens for recipient. - function _getL1WithdrawMessage( - bytes32 _assetId, - bytes memory _l1bridgeMintData - ) internal pure returns (bytes memory) { - // note we use the IL1SharedBridge.finalizeWithdrawal function selector to specify the selector for L1<>L2 messages, - // and we use this interface so that when the switch happened the old messages could be processed - // solhint-disable-next-line func-named-parameters - return abi.encodePacked(IL1AssetRouter.finalizeWithdrawal.selector, _assetId, _l1bridgeMintData); - } - - /*////////////////////////////////////////////////////////////// - LEGACY FUNCTIONS - //////////////////////////////////////////////////////////////*/ - - /// @notice Legacy finalizeDeposit. - /// @dev Finalizes the deposit and mint funds. - /// @param _l1Sender The address of token sender on L1. - /// @param _l2Receiver The address of token receiver on L2. - /// @param _l1Token The address of the token transferred. - /// @param _amount The amount of the token transferred. - /// @param _data The metadata of the token transferred. - function finalizeDeposit( - address _l1Sender, - address _l2Receiver, - address _l1Token, - uint256 _amount, - bytes calldata _data - ) external override { - bytes32 assetId = DataEncoding.encodeNTVAssetId(L1_CHAIN_ID, _l1Token); - // solhint-disable-next-line func-named-parameters - bytes memory data = DataEncoding.encodeBridgeMintData(_l1Sender, _l2Receiver, _l1Token, _amount, _data); - finalizeDeposit(assetId, data); - } - - /// @notice Initiates a withdrawal by burning funds on the contract and sending the message to L1 - /// where tokens would be unlocked. - /// @param _l1Receiver The address of token receiver on L1. - /// @param _l2Token The address of the token transferred. - /// @param _amount The amount of the token transferred. - function withdraw(address _l1Receiver, address _l2Token, uint256 _amount) external { - bytes32 assetId = DataEncoding.encodeNTVAssetId(L1_CHAIN_ID, getL1TokenAddress(_l2Token)); - bytes memory data = abi.encode(_amount, _l1Receiver); - withdraw(assetId, data); - } - - /// @notice Legacy getL1TokenAddress. - /// @param _l2Token The address of token on L2. - /// @return The address of token on L1. - function getL1TokenAddress(address _l2Token) public view returns (address) { - return IL2StandardToken(_l2Token).l1Address(); - } - - /// @notice Legacy function used for backward compatibility to return L2 wrapped token - /// @notice address corresponding to provided L1 token address and deployed through NTV. - /// @dev However, the shared bridge can use custom asset handlers such that L2 addresses differ, - /// @dev or an L1 token may not have an L2 counterpart. - /// @param _l1Token The address of token on L1. - /// @return Address of an L2 token counterpart - function l2TokenAddress(address _l1Token) public view returns (address) { - return L2_NATIVE_TOKEN_VAULT.l2TokenAddress(_l1Token); - } -} diff --git a/l2-contracts/contracts/bridge/L2NativeTokenVault.sol b/l2-contracts/contracts/bridge/L2NativeTokenVault.sol deleted file mode 100644 index 56c50d9a8..000000000 --- a/l2-contracts/contracts/bridge/L2NativeTokenVault.sol +++ /dev/null @@ -1,234 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.20; - -import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol"; -import {BeaconProxy} from "@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol"; -import {UpgradeableBeacon} from "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol"; - -import {IL2StandardToken} from "./interfaces/IL2StandardToken.sol"; -import {IL2NativeTokenVault} from "./interfaces/IL2NativeTokenVault.sol"; - -import {L2StandardERC20} from "./L2StandardERC20.sol"; -import {L2ContractHelper, DEPLOYER_SYSTEM_CONTRACT, L2_ASSET_ROUTER, IContractDeployer} from "../L2ContractHelper.sol"; -import {SystemContractsCaller} from "../SystemContractsCaller.sol"; -import {DataEncoding} from "../common/libraries/DataEncoding.sol"; - -import {EmptyAddress, EmptyBytes32, AddressMismatch, AssetIdMismatch, DeployFailed, AmountMustBeGreaterThanZero, InvalidCaller} from "../errors/L2ContractErrors.sol"; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -/// @notice The "default" bridge implementation for the ERC20 tokens. Note, that it does not -/// support any custom token logic, i.e. rebase tokens' functionality is not supported. -contract L2NativeTokenVault is IL2NativeTokenVault, Ownable2StepUpgradeable { - /// @dev Chain ID of L1 for bridging reasons. - uint256 public immutable L1_CHAIN_ID; - - bytes32 internal l2TokenProxyBytecodeHash; - - /// @dev Contract that stores the implementation address for token. - /// @dev For more details see https://docs.openzeppelin.com/contracts/3.x/api/proxy#UpgradeableBeacon. - UpgradeableBeacon public l2TokenBeacon; - - mapping(bytes32 assetId => address tokenAddress) public override tokenAddress; - - /// @dev Bytecode hash of the proxy for tokens deployed by the bridge. - - modifier onlyBridge() { - if (msg.sender != address(L2_ASSET_ROUTER)) { - revert InvalidCaller(msg.sender); - // Only L2 bridge can call this method - } - _; - } - - /// @notice Initializes the bridge contract for later use. Expected to be used in the proxy. - /// @param _l1ChainId The L1 chain id differs between mainnet and testnets. - /// @param _l2TokenProxyBytecodeHash The bytecode hash of the proxy for tokens deployed by the bridge. - /// @param _aliasedOwner The address of the governor contract. - constructor(uint256 _l1ChainId, bytes32 _l2TokenProxyBytecodeHash, address _aliasedOwner) { - L1_CHAIN_ID = _l1ChainId; - - _disableInitializers(); - if (_l2TokenProxyBytecodeHash == bytes32(0)) { - revert EmptyBytes32(); - } - if (_aliasedOwner == address(0)) { - revert EmptyAddress(); - } - - l2TokenProxyBytecodeHash = _l2TokenProxyBytecodeHash; - _transferOwnership(_aliasedOwner); - } - - /// @notice Sets L2 token beacon used by wrapped ERC20 tokens deployed by NTV. - /// @dev Sets the l2TokenBeacon, called after initialize. - /// @param _l2TokenBeacon The address of L2 token beacon implementation. - /// @param _l2TokenProxyBytecodeHash The bytecode hash of the L2 token proxy that will be deployed for wrapped tokens. - function setL2TokenBeacon(address _l2TokenBeacon, bytes32 _l2TokenProxyBytecodeHash) external onlyOwner { - l2TokenBeacon = UpgradeableBeacon(_l2TokenBeacon); - l2TokenProxyBytecodeHash = _l2TokenProxyBytecodeHash; - emit L2TokenBeaconUpdated(_l2TokenBeacon, _l2TokenProxyBytecodeHash); - } - - /// @notice Configure L2 token beacon used by wrapped ERC20 tokens deployed by NTV. - /// @dev we don't call this in the constructor, as we need to provide factory deps. - /// @param _contractsDeployedAlready Ensures beacon proxy for standard ERC20 has not been deployed. - function configureL2TokenBeacon(bool _contractsDeployedAlready, address _l2TokenBeacon) external { - if (address(l2TokenBeacon) != address(0)) { - revert AddressMismatch(address(l2TokenBeacon), address(0)); - } - if (_contractsDeployedAlready) { - if (_l2TokenBeacon == address(0)) { - revert EmptyAddress(); - } - l2TokenBeacon = UpgradeableBeacon(_l2TokenBeacon); - } else { - address l2StandardToken = address(new L2StandardERC20{salt: bytes32(0)}()); - l2TokenBeacon = new UpgradeableBeacon{salt: bytes32(0)}(l2StandardToken); - l2TokenBeacon.transferOwnership(owner()); - } - } - - /// @notice Used when the chain receives a transfer from L1 Shared Bridge and correspondingly mints the asset. - /// @param _chainId The chainId that the message is from. - /// @param _assetId The assetId of the asset being bridged. - /// @param _data The abi.encoded transfer data. - function bridgeMint(uint256 _chainId, bytes32 _assetId, bytes calldata _data) external payable override onlyBridge { - address token = tokenAddress[_assetId]; - ( - address _l1Sender, - address _l2Receiver, - address originToken, - uint256 _amount, - bytes memory erc20Data - ) = DataEncoding.decodeBridgeMintData(_data); - - if (token == address(0)) { - address expectedToken = _calculateCreate2TokenAddress(originToken); - bytes32 expectedAssetId = DataEncoding.encodeNTVAssetId(L1_CHAIN_ID, originToken); - if (_assetId != expectedAssetId) { - // Make sure that a NativeTokenVault sent the message - revert AssetIdMismatch(expectedAssetId, _assetId); - } - address deployedToken = _deployL2Token(originToken, erc20Data); - if (deployedToken != expectedToken) { - revert AddressMismatch(expectedToken, deployedToken); - } - tokenAddress[_assetId] = expectedToken; - token = expectedToken; - } - - IL2StandardToken(token).bridgeMint(_l2Receiver, _amount); - /// backwards compatible event - emit FinalizeDeposit(_l1Sender, _l2Receiver, token, _amount); - emit BridgeMint({ - chainId: _chainId, - assetId: _assetId, - sender: _l1Sender, - l2Receiver: _l2Receiver, - amount: _amount - }); - } - - /// @notice Burns wrapped tokens and returns the calldata for L2 -> L1 message. - /// @dev In case of native token vault _data is the tuple of _depositAmount and _l2Receiver. - /// @param _chainId The chainId that the message will be sent to. - /// @param _mintValue The L1 base token value bridged. - /// @param _assetId The L2 assetId of the asset being bridged. - /// @param _prevMsgSender The original caller of the shared bridge. - /// @param _data The abi.encoded transfer data. - /// @return l1BridgeMintData The calldata used by l1 asset handler to unlock tokens for recipient. - function bridgeBurn( - uint256 _chainId, - uint256 _mintValue, - bytes32 _assetId, - address _prevMsgSender, - bytes calldata _data - ) external payable override onlyBridge returns (bytes memory l1BridgeMintData) { - (uint256 _amount, address _l1Receiver) = abi.decode(_data, (uint256, address)); - if (_amount == 0) { - // "Amount cannot be zero"); - revert AmountMustBeGreaterThanZero(); - } - - address l2Token = tokenAddress[_assetId]; - IL2StandardToken(l2Token).bridgeBurn(_prevMsgSender, _amount); - - /// backwards compatible event - emit WithdrawalInitiated(_prevMsgSender, _l1Receiver, l2Token, _amount); - emit BridgeBurn({ - chainId: _chainId, - assetId: _assetId, - l2Sender: _prevMsgSender, - receiver: _l1Receiver, - mintValue: _mintValue, - amount: _amount - }); - l1BridgeMintData = _data; - } - - /// @notice Calculates L2 wrapped token address corresponding to L1 token counterpart. - /// @param _l1Token The address of token on L1. - /// @return expectedToken The address of token on L2. - function l2TokenAddress(address _l1Token) public view override returns (address expectedToken) { - bytes32 expectedAssetId = DataEncoding.encodeNTVAssetId(L1_CHAIN_ID, _l1Token); - expectedToken = tokenAddress[expectedAssetId]; - if (expectedToken == address(0)) { - expectedToken = _calculateCreate2TokenAddress(_l1Token); - } - } - - /// @notice Deploys and initializes the L2 token for the L1 counterpart. - /// @param _l1Token The address of token on L1. - /// @param _erc20Data The ERC20 metadata of the token deployed. - /// @return The address of the beacon proxy (L2 wrapped / bridged token). - function _deployL2Token(address _l1Token, bytes memory _erc20Data) internal returns (address) { - bytes32 salt = _getCreate2Salt(_l1Token); - - BeaconProxy l2Token = _deployBeaconProxy(salt); - L2StandardERC20(address(l2Token)).bridgeInitialize(_l1Token, _erc20Data); - - return address(l2Token); - } - - /// @notice Deploys the beacon proxy for the L2 token, while using ContractDeployer system contract. - /// @dev This function uses raw call to ContractDeployer to make sure that exactly `l2TokenProxyBytecodeHash` is used - /// for the code of the proxy. - /// @param salt The salt used for beacon proxy deployment of L2 wrapped token. - /// @return proxy The beacon proxy, i.e. L2 wrapped / bridged token. - function _deployBeaconProxy(bytes32 salt) internal returns (BeaconProxy proxy) { - (bool success, bytes memory returndata) = SystemContractsCaller.systemCallWithReturndata( - uint32(gasleft()), - DEPLOYER_SYSTEM_CONTRACT, - 0, - abi.encodeCall( - IContractDeployer.create2, - (salt, l2TokenProxyBytecodeHash, abi.encode(address(l2TokenBeacon), "")) - ) - ); - - // The deployment should be successful and return the address of the proxy - if (!success) { - revert DeployFailed(); - } - proxy = BeaconProxy(abi.decode(returndata, (address))); - } - - /// @notice Calculates L2 wrapped token address given the currently stored beacon proxy bytecode hash and beacon address. - /// @param _l1Token The address of token on L1. - /// @return Address of an L2 token counterpart. - function _calculateCreate2TokenAddress(address _l1Token) internal view returns (address) { - bytes32 constructorInputHash = keccak256(abi.encode(address(l2TokenBeacon), "")); - bytes32 salt = _getCreate2Salt(_l1Token); - return - L2ContractHelper.computeCreate2Address(address(this), salt, l2TokenProxyBytecodeHash, constructorInputHash); - } - - /// @notice Converts the L1 token address to the create2 salt of deployed L2 token. - /// @param _l1Token The address of token on L1. - /// @return salt The salt used to compute address of wrapped token on L2 and for beacon proxy deployment. - function _getCreate2Salt(address _l1Token) internal pure returns (bytes32 salt) { - salt = bytes32(uint256(uint160(_l1Token))); - } -} diff --git a/l2-contracts/contracts/bridge/L2SharedBridgeLegacy.sol b/l2-contracts/contracts/bridge/L2SharedBridgeLegacy.sol deleted file mode 100644 index c4535bc24..000000000 --- a/l2-contracts/contracts/bridge/L2SharedBridgeLegacy.sol +++ /dev/null @@ -1,27 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.20; - -// import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol"; -// import {UpgradeableBeacon} from "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol"; - -// import {IL1ERC20Bridge} from "./interfaces/IL1ERC20Bridge.sol"; -// import {IL2AssetRouter} from "./interfaces/IL2AssetRouter.sol"; -// import {ILegacyL2SharedBridge} from "./interfaces/ILegacyL2SharedBridge.sol"; -// import {IL2AssetHandler} from "./interfaces/IL2AssetHandler.sol"; -// import {ILegacyL2SharedBridge} from "./interfaces/ILegacyL2SharedBridge.sol"; -// import {IL2StandardToken} from "./interfaces/IL2StandardToken.sol"; - -// import {AddressAliasHelper} from "../vendor/AddressAliasHelper.sol"; -// import {L2ContractHelper, L2_NATIVE_TOKEN_VAULT} from "../L2ContractHelper.sol"; - -// import {EmptyAddress, InvalidCaller} from "../L2ContractErrors.sol"; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -/// @notice The "default" bridge implementation for the ERC20 tokens. Note, that it does not -/// support any custom token logic, i.e. rebase tokens' functionality is not supported. -contract L2SharedBridge { - // is IL2AssetRouter, ILegacyL2SharedBridge, Initializable { - // todo -} diff --git a/l2-contracts/contracts/bridge/interfaces/IL1AssetRouter.sol b/l2-contracts/contracts/bridge/interfaces/IL1AssetRouter.sol deleted file mode 100644 index 84c9a3363..000000000 --- a/l2-contracts/contracts/bridge/interfaces/IL1AssetRouter.sol +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: MIT -// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. -pragma solidity ^0.8.20; - -/// @title L1 Bridge contract interface -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -interface IL1AssetRouter { - function finalizeWithdrawal( - uint256 _chainId, - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes calldata _message, - bytes32[] calldata _merkleProof - ) external; -} diff --git a/l2-contracts/contracts/bridge/interfaces/IL1ERC20Bridge.sol b/l2-contracts/contracts/bridge/interfaces/IL1ERC20Bridge.sol deleted file mode 100644 index ed76b84b1..000000000 --- a/l2-contracts/contracts/bridge/interfaces/IL1ERC20Bridge.sol +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: MIT -// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. -pragma solidity ^0.8.20; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -// note we use the IL1ERC20Bridge only to send L1<>L2 messages, -// and we use this interface so that when the switch happened the old messages could be processed -interface IL1ERC20Bridge { - function finalizeWithdrawal( - uint256 _l2BatchNumber, - uint256 _l2MessageIndex, - uint16 _l2TxNumberInBatch, - bytes calldata _message, - bytes32[] calldata _merkleProof - ) external; -} diff --git a/l2-contracts/contracts/bridge/interfaces/IL2AssetHandler.sol b/l2-contracts/contracts/bridge/interfaces/IL2AssetHandler.sol deleted file mode 100644 index 53f6708d7..000000000 --- a/l2-contracts/contracts/bridge/interfaces/IL2AssetHandler.sol +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.20; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -interface IL2AssetHandler { - event BridgeMint( - uint256 indexed chainId, - bytes32 indexed assetId, - address indexed sender, - address l2Receiver, - uint256 amount - ); - - event BridgeBurn( - uint256 indexed chainId, - bytes32 indexed assetId, - address indexed l2Sender, - address receiver, - uint256 mintValue, - uint256 amount - ); - - function bridgeMint(uint256 _chainId, bytes32 _assetId, bytes calldata _transferData) external payable; - - function bridgeBurn( - uint256 _chainId, - uint256 _mintValue, - bytes32 _assetId, - address _prevMsgSender, - bytes calldata _data - ) external payable returns (bytes memory _l1BridgeMintData); -} diff --git a/l2-contracts/contracts/bridge/interfaces/IL2AssetRouter.sol b/l2-contracts/contracts/bridge/interfaces/IL2AssetRouter.sol deleted file mode 100644 index edd677dc6..000000000 --- a/l2-contracts/contracts/bridge/interfaces/IL2AssetRouter.sol +++ /dev/null @@ -1,37 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.20; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -interface IL2AssetRouter { - event FinalizeDepositSharedBridge(uint256 chainId, bytes32 indexed assetId, bytes assetData); - - event WithdrawalInitiatedSharedBridge( - uint256 chainId, - address indexed l2Sender, - bytes32 indexed assetId, - bytes assetData - ); - - event AssetHandlerRegisteredInitial( - bytes32 indexed assetId, - address indexed assetAddress, - bytes32 indexed additionalData, - address sender - ); - - event AssetHandlerRegistered(bytes32 indexed assetId, address indexed _assetAddress); - - function finalizeDeposit(bytes32 _assetId, bytes calldata _transferData) external; - - function withdraw(bytes32 _assetId, bytes calldata _transferData) external; - - function l1Bridge() external view returns (address); - - function assetHandlerAddress(bytes32 _assetId) external view returns (address); - - function l1SharedBridge() external view returns (address); - - function l1TokenAddress(address _l2Token) external view returns (address); -} diff --git a/l2-contracts/contracts/bridge/interfaces/ILegacyL2SharedBridge.sol b/l2-contracts/contracts/bridge/interfaces/ILegacyL2SharedBridge.sol deleted file mode 100644 index a73f888ab..000000000 --- a/l2-contracts/contracts/bridge/interfaces/ILegacyL2SharedBridge.sol +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.20; - -/// @author Matter Labs -/// @custom:security-contact security@matterlabs.dev -interface ILegacyL2SharedBridge { - function finalizeDeposit( - address _l1Sender, - address _l2Receiver, - address _l1Token, - uint256 _amount, - bytes calldata _data - ) external; - - function withdraw(address _l1Receiver, address _l2Token, uint256 _amount) external; - - function getL1TokenAddress(address _l2Token) external view returns (address); - - function l2TokenAddress(address _l1Token) external view returns (address); -} diff --git a/l2-contracts/contracts/common/libraries/DataEncoding.sol b/l2-contracts/contracts/common/libraries/DataEncoding.sol deleted file mode 100644 index 16c97c11a..000000000 --- a/l2-contracts/contracts/common/libraries/DataEncoding.sol +++ /dev/null @@ -1,90 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.20; - -import {L2_NATIVE_TOKEN_VAULT} from "../../L2ContractHelper.sol"; - -/** - * @author Matter Labs - * @custom:security-contact security@matterlabs.dev - * @notice Helper library for transfer data encoding and decoding to reduce possibility of errors. - */ -library DataEncoding { - /// @notice Abi.encodes the data required for bridgeMint on remote chain. - /// @param _prevMsgSender The address which initiated the transfer. - /// @param _l2Receiver The address which to receive tokens on remote chain. - /// @param _l1Token The transferred token address. - /// @param _amount The amount of token to be transferred. - /// @param _erc20Metadata The transferred token metadata. - /// @return The encoded bridgeMint data - function encodeBridgeMintData( - address _prevMsgSender, - address _l2Receiver, - address _l1Token, - uint256 _amount, - bytes memory _erc20Metadata - ) internal pure returns (bytes memory) { - // solhint-disable-next-line func-named-parameters - return abi.encode(_prevMsgSender, _l2Receiver, _l1Token, _amount, _erc20Metadata); - } - - /// @notice Function decoding transfer data previously encoded with this library. - /// @param _bridgeMintData The encoded bridgeMint data - /// @return _prevMsgSender The address which initiated the transfer. - /// @return _l2Receiver The address which to receive tokens on remote chain. - /// @return _parsedL1Token The transferred token address. - /// @return _amount The amount of token to be transferred. - /// @return _erc20Metadata The transferred token metadata. - function decodeBridgeMintData( - bytes memory _bridgeMintData - ) - internal - pure - returns ( - address _prevMsgSender, - address _l2Receiver, - address _parsedL1Token, - uint256 _amount, - bytes memory _erc20Metadata - ) - { - (_prevMsgSender, _l2Receiver, _parsedL1Token, _amount, _erc20Metadata) = abi.decode( - _bridgeMintData, - (address, address, address, uint256, bytes) - ); - } - - /// @notice Encodes the asset data by combining chain id, asset deployment tracker and asset data. - /// @param _chainId The id of the chain token is native to. - /// @param _assetData The asset data that has to be encoded. - /// @param _sender The asset deployment tracker address. - /// @return The encoded asset data. - function encodeAssetId(uint256 _chainId, bytes32 _assetData, address _sender) internal pure returns (bytes32) { - return keccak256(abi.encode(_chainId, _sender, _assetData)); - } - - /// @notice Encodes the asset data by combining chain id, asset deployment tracker and asset data. - /// @param _chainId The id of the chain token is native to. - /// @param _tokenAaddress The address of token that has to be encoded (asset data is the address itself). - /// @param _sender The asset deployment tracker address. - /// @return The encoded asset data. - function encodeAssetId(uint256 _chainId, address _tokenAaddress, address _sender) internal pure returns (bytes32) { - return keccak256(abi.encode(_chainId, _sender, _tokenAaddress)); - } - - /// @notice Encodes the asset data by combining chain id, NTV as asset deployment tracker and asset data. - /// @param _chainId The id of the chain token is native to. - /// @param _assetData The asset data that has to be encoded. - /// @return The encoded asset data. - function encodeNTVAssetId(uint256 _chainId, bytes32 _assetData) internal pure returns (bytes32) { - return keccak256(abi.encode(_chainId, L2_NATIVE_TOKEN_VAULT, _assetData)); - } - - /// @notice Encodes the asset data by combining chain id, NTV as asset deployment tracker and asset data. - /// @param _chainId The id of the chain token is native to. - /// @param _tokenAddress The address of token that has to be encoded (asset data is the address itself). - /// @return The encoded asset data. - function encodeNTVAssetId(uint256 _chainId, address _tokenAddress) internal pure returns (bytes32) { - return keccak256(abi.encode(_chainId, L2_NATIVE_TOKEN_VAULT, _tokenAddress)); - } -} diff --git a/l2-contracts/contracts/data-availability/DAErrors.sol b/l2-contracts/contracts/data-availability/DAErrors.sol index 0d24845a8..c3f032d2a 100644 --- a/l2-contracts/contracts/data-availability/DAErrors.sol +++ b/l2-contracts/contracts/data-availability/DAErrors.sol @@ -1,10 +1,8 @@ // SPDX-License-Identifier: MIT -pragma solidity 0.8.20; +pragma solidity 0.8.24; enum PubdataField { - NumberOfLogs, - LogsHash, MsgHash, Bytecode, StateDiffCompressionVersion, diff --git a/l2-contracts/contracts/data-availability/RollupL2DAValidator.sol b/l2-contracts/contracts/data-availability/RollupL2DAValidator.sol index d81bea055..febedf625 100644 --- a/l2-contracts/contracts/data-availability/RollupL2DAValidator.sol +++ b/l2-contracts/contracts/data-availability/RollupL2DAValidator.sol @@ -1,12 +1,12 @@ // SPDX-License-Identifier: MIT -pragma solidity 0.8.20; +pragma solidity 0.8.24; import {IL2DAValidator} from "../interfaces/IL2DAValidator.sol"; import {StateDiffL2DAValidator} from "./StateDiffL2DAValidator.sol"; import {PUBDATA_CHUNK_PUBLISHER} from "../L2ContractHelper.sol"; -import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol"; +import {SafeCast} from "@openzeppelin/contracts-v4/utils/math/SafeCast.sol"; import {EfficientCall} from "@matterlabs/zksync-contracts/l2/system-contracts/libraries/EfficientCall.sol"; import {ReconstructionMismatch, PubdataField} from "./DAErrors.sol"; diff --git a/l2-contracts/contracts/data-availability/StateDiffL2DAValidator.sol b/l2-contracts/contracts/data-availability/StateDiffL2DAValidator.sol index 2102b5c28..ab7d48636 100644 --- a/l2-contracts/contracts/data-availability/StateDiffL2DAValidator.sol +++ b/l2-contracts/contracts/data-availability/StateDiffL2DAValidator.sol @@ -1,6 +1,6 @@ // SPDX-License-Identifier: MIT -pragma solidity 0.8.20; +pragma solidity 0.8.24; import {ReconstructionMismatch, PubdataField} from "./DAErrors.sol"; import {COMPRESSOR_CONTRACT, L2ContractHelper} from "../L2ContractHelper.sol"; diff --git a/l2-contracts/contracts/data-availability/ValidiumL2DAValidator.sol b/l2-contracts/contracts/data-availability/ValidiumL2DAValidator.sol index 78a49aea8..5930131fc 100644 --- a/l2-contracts/contracts/data-availability/ValidiumL2DAValidator.sol +++ b/l2-contracts/contracts/data-availability/ValidiumL2DAValidator.sol @@ -1,6 +1,6 @@ // SPDX-License-Identifier: MIT -pragma solidity 0.8.20; +pragma solidity 0.8.24; import {IL2DAValidator} from "../interfaces/IL2DAValidator.sol"; diff --git a/l2-contracts/contracts/dev-contracts/DevL2SharedBridge.sol b/l2-contracts/contracts/dev-contracts/DevL2SharedBridge.sol deleted file mode 100644 index e93d5c987..000000000 --- a/l2-contracts/contracts/dev-contracts/DevL2SharedBridge.sol +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: MIT - -pragma solidity 0.8.24; - -import {L2SharedBridge} from "../bridge/L2SharedBridge.sol"; -import {L2StandardERC20} from "../bridge/L2StandardERC20.sol"; -import {UpgradeableBeacon} from "@openzeppelin/contracts-v4/proxy/beacon/UpgradeableBeacon.sol"; - -/// @author Matter Labs -/// @notice The implementation of the shared bridge that allows setting legacy bridge. Must only be used in local testing environments. -contract DevL2SharedBridge is L2SharedBridge { - constructor(uint256 _eraChainId) L2SharedBridge(_eraChainId) {} - - function initializeDevBridge( - address _l1SharedBridge, - address _l1Bridge, - bytes32 _l2TokenProxyBytecodeHash, - address _aliasedOwner - ) external reinitializer(2) { - l1SharedBridge = _l1SharedBridge; - - address l2StandardToken = address(new L2StandardERC20{salt: bytes32(0)}()); - l2TokenBeacon = new UpgradeableBeacon{salt: bytes32(0)}(l2StandardToken); - l2TokenProxyBytecodeHash = _l2TokenProxyBytecodeHash; - l2TokenBeacon.transferOwnership(_aliasedOwner); - - // Unfortunately the `l1Bridge` is not an internal variable in the parent contract. - // To keep the changes to the production code minimal, we'll just manually set the variable here. - assembly { - sstore(4, _l1Bridge) - } - } -} diff --git a/l2-contracts/contracts/dev-contracts/VerifierRecursiveTest.sol b/l2-contracts/contracts/dev-contracts/VerifierRecursiveTest.sol new file mode 100644 index 000000000..2b1da08f0 --- /dev/null +++ b/l2-contracts/contracts/dev-contracts/VerifierRecursiveTest.sol @@ -0,0 +1,70 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {Verifier} from "../verifier/Verifier.sol"; + +/// @author Matter Labs +contract VerifierRecursiveTest is Verifier { + // add this to be excluded from coverage report + function test() internal virtual {} + + function _loadVerificationKey() internal pure override { + assembly { + // gate setup commitments + mstore(VK_GATE_SETUP_0_X_SLOT, 0x046e45fd137982bd0f6cf731b4650d2d520e8d675827744e1edf1308583599bb) + mstore(VK_GATE_SETUP_0_Y_SLOT, 0x177f14d16b716d4298be5e07b83add3fb61ff1ee08dce19f9a54fa8f04937f7e) + mstore(VK_GATE_SETUP_1_X_SLOT, 0x169ad5156d25b56f7b67ea6382f88b845ed5bae5b91aacfe51d8f0716afff2fb) + mstore(VK_GATE_SETUP_1_Y_SLOT, 0x2406e3268e4d5fa672142998ecf834034638a4a6f8b5e90205552c6aa1dde163) + mstore(VK_GATE_SETUP_2_X_SLOT, 0x05fd0ce0fdc590938d29c738c8dc956b32ca8e69c3babfbb49dc1c13a6d9a8d4) + mstore(VK_GATE_SETUP_2_Y_SLOT, 0x0a27dac323a04dd319d9805be879875c95063d0a55c96214cd45c913fba84460) + mstore(VK_GATE_SETUP_3_X_SLOT, 0x0d58a2a86b208a4976beb9bfd918514d448656e0ee66175eb344a4a17bba99f8) + mstore(VK_GATE_SETUP_3_Y_SLOT, 0x215fa609a1a425b84c9dc218c6cf999596d9eba6d35597ad7aaf2d077a6616ed) + mstore(VK_GATE_SETUP_4_X_SLOT, 0x1a26e6deccf91174ab13613363eb4939680828f0c6031f5039f9e6f264afa68c) + mstore(VK_GATE_SETUP_4_Y_SLOT, 0x1f5b2d6bffac1839edfd02cd0e41acc411f0ecbf6c5c4b1da0e12b68b99cb25d) + mstore(VK_GATE_SETUP_5_X_SLOT, 0x09b71be2e8a45dcbe7654cf369c4f1f2e7eab4b97869a469fb7a149d989f7226) + mstore(VK_GATE_SETUP_5_Y_SLOT, 0x197e1e2cefbd4f99558b89ca875e01fec0f14f05e5128bd869c87d6bf2f307fa) + mstore(VK_GATE_SETUP_6_X_SLOT, 0x0d7cef745da686fd44760403d452d72be504bb41b0a7f4fbe973a07558893871) + mstore(VK_GATE_SETUP_6_Y_SLOT, 0x1e9a863307cdfd3fdcf119f72279ddfda08b6f23c3672e8378dbb9d548734c29) + mstore(VK_GATE_SETUP_7_X_SLOT, 0x16af3f5d978446fdb37d84f5cf12e59f5c1088bde23f8260c0bb6792c5f78e99) + mstore(VK_GATE_SETUP_7_Y_SLOT, 0x167d3aeee50c0e53fd1e8a33941a806a34cfae5dc8b66578486e5d7207b5d546) + + // gate selectors commitments + mstore(VK_GATE_SELECTORS_0_X_SLOT, 0x1addc8e154c74bed403dc19558096ce22f1ceb2c656a2a5e85e56d2be6580ed1) + mstore(VK_GATE_SELECTORS_0_Y_SLOT, 0x1420d38f0ef206828efc36d0f5ad2b4d85fe768097f358fc671b7b3ec0239234) + mstore(VK_GATE_SELECTORS_1_X_SLOT, 0x2d5c06d0c8aa6a3520b8351f82341affcbb1a0bf27bceb9bab175e3e1d38cf47) + mstore(VK_GATE_SELECTORS_1_Y_SLOT, 0x0ff8d923a0374308147f6dd4fc513f6d0640f5df699f4836825ef460df3f8d6a) + + // permutation commitments + mstore(VK_PERMUTATION_0_X_SLOT, 0x1de8943a8f67d9f6fcbda10a1f37a82de9e9ffd0a0102ea5ce0ce6dd13b4031b) + mstore(VK_PERMUTATION_0_Y_SLOT, 0x1e04b0824853ab5d7c3412a217a1c5b88a2b4011be7e7e849485be8ed7332e41) + mstore(VK_PERMUTATION_1_X_SLOT, 0x2aa1817b9cc40b6cc7a7b3f832f3267580f9fb8e539666c00541e1a77e34a3da) + mstore(VK_PERMUTATION_1_Y_SLOT, 0x0edb3cde226205b01212fc1861303c49ef3ff66f060b5833dc9a3f661ef31dd9) + mstore(VK_PERMUTATION_2_X_SLOT, 0x13f5ae93c8eccc1455a0095302923442d4b0b3c8233d66ded99ffcf2ad641c27) + mstore(VK_PERMUTATION_2_Y_SLOT, 0x2dd42d42ccdea8b1901435ace12bc9e52c7dbbeb409d20c517ba942ed0cc7519) + mstore(VK_PERMUTATION_3_X_SLOT, 0x1a15a70a016be11af71e46e9c8a8d31ece32a7e657ae90356dd9535e6566645f) + mstore(VK_PERMUTATION_3_Y_SLOT, 0x0381d23e115521c6fc233c5346f79a6777bfa8871b7ee623d990cdcb5d8c3ce1) + + // lookup tables commitments + mstore(VK_LOOKUP_TABLE_0_X_SLOT, 0x2c513ed74d9d57a5ec901e074032741036353a2c4513422e96e7b53b302d765b) + mstore(VK_LOOKUP_TABLE_0_Y_SLOT, 0x04dd964427e430f16004076d708c0cb21e225056cc1d57418cfbd3d472981468) + mstore(VK_LOOKUP_TABLE_1_X_SLOT, 0x1ea83e5e65c6f8068f4677e2911678cf329b28259642a32db1f14b8347828aac) + mstore(VK_LOOKUP_TABLE_1_Y_SLOT, 0x1d22bc884a2da4962a893ba8de13f57aaeb785ed52c5e686994839cab8f7475d) + mstore(VK_LOOKUP_TABLE_2_X_SLOT, 0x0b2e7212d0d9cff26d0bdf3d79b2cac029a25dfeb1cafdf49e2349d7db348d89) + mstore(VK_LOOKUP_TABLE_2_Y_SLOT, 0x1301f9b252419ea240eb67fda720ca0b16d92364027285f95e9b1349490fa283) + mstore(VK_LOOKUP_TABLE_3_X_SLOT, 0x02f7b99fdfa5b418548c2d777785820e02383cfc87e7085e280a375a358153bf) + mstore(VK_LOOKUP_TABLE_3_Y_SLOT, 0x09d004fe08dc4d19c382df36fad22ef676185663543703e6a4b40203e50fd8a6) + + // lookup selector commitment + mstore(VK_LOOKUP_SELECTOR_X_SLOT, 0x1641f5d312e6f62720b1e6cd1d1be5bc0e69d10d20a12dc97ff04e2107e10ccc) + mstore(VK_LOOKUP_SELECTOR_Y_SLOT, 0x277f435d376acc3261ef9d5748e6705086214daf46d04edc80fbd657f8d9e73d) + + // table type commitment + mstore(VK_LOOKUP_TABLE_TYPE_X_SLOT, 0x1b5f1cfddd6713cf25d9e6850a1b3fe80d6ef7fe2c67248f25362d5f9b31893c) + mstore(VK_LOOKUP_TABLE_TYPE_Y_SLOT, 0x0945076de03a0d240067e5f02b8fc11eaa589df3343542576eb59fdb3ecb57e0) + + // flag for using recursive part + mstore(VK_RECURSIVE_FLAG_SLOT, 1) + } + } +} diff --git a/l2-contracts/contracts/dev-contracts/VerifierTest.sol b/l2-contracts/contracts/dev-contracts/VerifierTest.sol new file mode 100644 index 000000000..9c2db1c84 --- /dev/null +++ b/l2-contracts/contracts/dev-contracts/VerifierTest.sol @@ -0,0 +1,70 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {Verifier} from "../verifier/Verifier.sol"; + +/// @author Matter Labs +contract VerifierTest is Verifier { + // add this to be excluded from coverage report + function test() internal virtual {} + + function _loadVerificationKey() internal pure override { + assembly { + // gate setup commitments + mstore(VK_GATE_SETUP_0_X_SLOT, 0x046e45fd137982bd0f6cf731b4650d2d520e8d675827744e1edf1308583599bb) + mstore(VK_GATE_SETUP_0_Y_SLOT, 0x177f14d16b716d4298be5e07b83add3fb61ff1ee08dce19f9a54fa8f04937f7e) + mstore(VK_GATE_SETUP_1_X_SLOT, 0x169ad5156d25b56f7b67ea6382f88b845ed5bae5b91aacfe51d8f0716afff2fb) + mstore(VK_GATE_SETUP_1_Y_SLOT, 0x2406e3268e4d5fa672142998ecf834034638a4a6f8b5e90205552c6aa1dde163) + mstore(VK_GATE_SETUP_2_X_SLOT, 0x05fd0ce0fdc590938d29c738c8dc956b32ca8e69c3babfbb49dc1c13a6d9a8d4) + mstore(VK_GATE_SETUP_2_Y_SLOT, 0x0a27dac323a04dd319d9805be879875c95063d0a55c96214cd45c913fba84460) + mstore(VK_GATE_SETUP_3_X_SLOT, 0x0d58a2a86b208a4976beb9bfd918514d448656e0ee66175eb344a4a17bba99f8) + mstore(VK_GATE_SETUP_3_Y_SLOT, 0x215fa609a1a425b84c9dc218c6cf999596d9eba6d35597ad7aaf2d077a6616ed) + mstore(VK_GATE_SETUP_4_X_SLOT, 0x1a26e6deccf91174ab13613363eb4939680828f0c6031f5039f9e6f264afa68c) + mstore(VK_GATE_SETUP_4_Y_SLOT, 0x1f5b2d6bffac1839edfd02cd0e41acc411f0ecbf6c5c4b1da0e12b68b99cb25d) + mstore(VK_GATE_SETUP_5_X_SLOT, 0x09b71be2e8a45dcbe7654cf369c4f1f2e7eab4b97869a469fb7a149d989f7226) + mstore(VK_GATE_SETUP_5_Y_SLOT, 0x197e1e2cefbd4f99558b89ca875e01fec0f14f05e5128bd869c87d6bf2f307fa) + mstore(VK_GATE_SETUP_6_X_SLOT, 0x0d7cef745da686fd44760403d452d72be504bb41b0a7f4fbe973a07558893871) + mstore(VK_GATE_SETUP_6_Y_SLOT, 0x1e9a863307cdfd3fdcf119f72279ddfda08b6f23c3672e8378dbb9d548734c29) + mstore(VK_GATE_SETUP_7_X_SLOT, 0x16af3f5d978446fdb37d84f5cf12e59f5c1088bde23f8260c0bb6792c5f78e99) + mstore(VK_GATE_SETUP_7_Y_SLOT, 0x167d3aeee50c0e53fd1e8a33941a806a34cfae5dc8b66578486e5d7207b5d546) + + // gate selectors commitments + mstore(VK_GATE_SELECTORS_0_X_SLOT, 0x1addc8e154c74bed403dc19558096ce22f1ceb2c656a2a5e85e56d2be6580ed1) + mstore(VK_GATE_SELECTORS_0_Y_SLOT, 0x1420d38f0ef206828efc36d0f5ad2b4d85fe768097f358fc671b7b3ec0239234) + mstore(VK_GATE_SELECTORS_1_X_SLOT, 0x2d5c06d0c8aa6a3520b8351f82341affcbb1a0bf27bceb9bab175e3e1d38cf47) + mstore(VK_GATE_SELECTORS_1_Y_SLOT, 0x0ff8d923a0374308147f6dd4fc513f6d0640f5df699f4836825ef460df3f8d6a) + + // permutation commitments + mstore(VK_PERMUTATION_0_X_SLOT, 0x1de8943a8f67d9f6fcbda10a1f37a82de9e9ffd0a0102ea5ce0ce6dd13b4031b) + mstore(VK_PERMUTATION_0_Y_SLOT, 0x1e04b0824853ab5d7c3412a217a1c5b88a2b4011be7e7e849485be8ed7332e41) + mstore(VK_PERMUTATION_1_X_SLOT, 0x2aa1817b9cc40b6cc7a7b3f832f3267580f9fb8e539666c00541e1a77e34a3da) + mstore(VK_PERMUTATION_1_Y_SLOT, 0x0edb3cde226205b01212fc1861303c49ef3ff66f060b5833dc9a3f661ef31dd9) + mstore(VK_PERMUTATION_2_X_SLOT, 0x13f5ae93c8eccc1455a0095302923442d4b0b3c8233d66ded99ffcf2ad641c27) + mstore(VK_PERMUTATION_2_Y_SLOT, 0x2dd42d42ccdea8b1901435ace12bc9e52c7dbbeb409d20c517ba942ed0cc7519) + mstore(VK_PERMUTATION_3_X_SLOT, 0x1a15a70a016be11af71e46e9c8a8d31ece32a7e657ae90356dd9535e6566645f) + mstore(VK_PERMUTATION_3_Y_SLOT, 0x0381d23e115521c6fc233c5346f79a6777bfa8871b7ee623d990cdcb5d8c3ce1) + + // lookup tables commitments + mstore(VK_LOOKUP_TABLE_0_X_SLOT, 0x2c513ed74d9d57a5ec901e074032741036353a2c4513422e96e7b53b302d765b) + mstore(VK_LOOKUP_TABLE_0_Y_SLOT, 0x04dd964427e430f16004076d708c0cb21e225056cc1d57418cfbd3d472981468) + mstore(VK_LOOKUP_TABLE_1_X_SLOT, 0x1ea83e5e65c6f8068f4677e2911678cf329b28259642a32db1f14b8347828aac) + mstore(VK_LOOKUP_TABLE_1_Y_SLOT, 0x1d22bc884a2da4962a893ba8de13f57aaeb785ed52c5e686994839cab8f7475d) + mstore(VK_LOOKUP_TABLE_2_X_SLOT, 0x0b2e7212d0d9cff26d0bdf3d79b2cac029a25dfeb1cafdf49e2349d7db348d89) + mstore(VK_LOOKUP_TABLE_2_Y_SLOT, 0x1301f9b252419ea240eb67fda720ca0b16d92364027285f95e9b1349490fa283) + mstore(VK_LOOKUP_TABLE_3_X_SLOT, 0x02f7b99fdfa5b418548c2d777785820e02383cfc87e7085e280a375a358153bf) + mstore(VK_LOOKUP_TABLE_3_Y_SLOT, 0x09d004fe08dc4d19c382df36fad22ef676185663543703e6a4b40203e50fd8a6) + + // lookup selector commitment + mstore(VK_LOOKUP_SELECTOR_X_SLOT, 0x1641f5d312e6f62720b1e6cd1d1be5bc0e69d10d20a12dc97ff04e2107e10ccc) + mstore(VK_LOOKUP_SELECTOR_Y_SLOT, 0x277f435d376acc3261ef9d5748e6705086214daf46d04edc80fbd657f8d9e73d) + + // table type commitment + mstore(VK_LOOKUP_TABLE_TYPE_X_SLOT, 0x1b5f1cfddd6713cf25d9e6850a1b3fe80d6ef7fe2c67248f25362d5f9b31893c) + mstore(VK_LOOKUP_TABLE_TYPE_Y_SLOT, 0x0945076de03a0d240067e5f02b8fc11eaa589df3343542576eb59fdb3ecb57e0) + + // flag for using recursive part + mstore(VK_RECURSIVE_FLAG_SLOT, 0) + } + } +} diff --git a/l2-contracts/contracts/errors/L2ContractErrors.sol b/l2-contracts/contracts/errors/L2ContractErrors.sol index c7d5deffe..bb16f38c6 100644 --- a/l2-contracts/contracts/errors/L2ContractErrors.sol +++ b/l2-contracts/contracts/errors/L2ContractErrors.sol @@ -44,5 +44,3 @@ enum BytecodeError { } // 0xd92e233d error ZeroAddress(); - -string constant BRIDGE_MINT_NOT_IMPLEMENTED = "bridgeMint is not implemented! Use deposit/depositTo methods instead."; diff --git a/l2-contracts/contracts/interfaces/IConsensusRegistry.sol b/l2-contracts/contracts/interfaces/IConsensusRegistry.sol new file mode 100644 index 000000000..a5e017484 --- /dev/null +++ b/l2-contracts/contracts/interfaces/IConsensusRegistry.sol @@ -0,0 +1,161 @@ +// SPDX-License-Identifier: MIT +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. +pragma solidity ^0.8.20; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +/// @title ConsensusRegistry contract interface +interface IConsensusRegistry { + /// @dev Represents a consensus node. + /// @param attesterLastUpdateCommit The latest `attestersCommit` where the node's attester attributes were updated. + /// @param attesterLatest Attester attributes to read if `node.attesterLastUpdateCommit` < `attestersCommit`. + /// @param attesterSnapshot Attester attributes to read if `node.attesterLastUpdateCommit` == `attestersCommit`. + /// @param validatorLastUpdateCommit The latest `validatorsCommit` where the node's validator attributes were updated. + /// @param validatorLatest Validator attributes to read if `node.validatorLastUpdateCommit` < `validatorsCommit`. + /// @param validatorSnapshot Validator attributes to read if `node.validatorLastUpdateCommit` == `validatorsCommit`. + /// @param nodeOwnerIdx Index of the node owner within the array of node owners. + struct Node { + uint32 attesterLastUpdateCommit; + uint32 validatorLastUpdateCommit; + uint32 nodeOwnerIdx; + AttesterAttr attesterLatest; + AttesterAttr attesterSnapshot; + ValidatorAttr validatorLatest; + ValidatorAttr validatorSnapshot; + } + + /// @dev Represents the attester attributes of a consensus node. + /// @param active A flag stating if the attester is active. + /// @param removed A flag stating if the attester has been removed (and is pending a deletion). + /// @param weight Attester's voting weight. + /// @param pubKey Attester's Secp256k1 public key. + struct AttesterAttr { + bool active; + bool removed; + uint32 weight; + Secp256k1PublicKey pubKey; + } + + /// @dev Represents an attester within a committee. + /// @param weight Attester's voting weight. + /// @param pubKey Attester's Secp256k1 public key. + struct CommitteeAttester { + uint32 weight; + Secp256k1PublicKey pubKey; + } + + /// @dev Represents the validator attributes of a consensus node. + /// @param active A flag stating if the validator is active. + /// @param removed A flag stating if the validator has been removed (and is pending a deletion). + /// @param weight Validator's voting weight. + /// @param pubKey Validator's BLS12-381 public key. + /// @param proofOfPossession Validator's Proof-of-possession (a signature over the public key). + struct ValidatorAttr { + bool active; + bool removed; + uint32 weight; + BLS12_381PublicKey pubKey; + BLS12_381Signature proofOfPossession; + } + + /// @dev Represents a validator within a committee. + /// @param weight Validator's voting weight. + /// @param pubKey Validator's BLS12-381 public key. + /// @param proofOfPossession Validator's Proof-of-possession (a signature over the public key). + struct CommitteeValidator { + uint32 weight; + BLS12_381PublicKey pubKey; + BLS12_381Signature proofOfPossession; + } + + /// @dev Represents BLS12_381 public key. + /// @param a First component of the BLS12-381 public key. + /// @param b Second component of the BLS12-381 public key. + /// @param c Third component of the BLS12-381 public key. + struct BLS12_381PublicKey { + bytes32 a; + bytes32 b; + bytes32 c; + } + + /// @dev Represents BLS12_381 signature. + /// @param a First component of the BLS12-381 signature. + /// @param b Second component of the BLS12-381 signature. + struct BLS12_381Signature { + bytes32 a; + bytes16 b; + } + + /// @dev Represents Secp256k1 public key. + /// @param tag Y-coordinate's even/odd indicator of the Secp256k1 public key. + /// @param x X-coordinate component of the Secp256k1 public key. + struct Secp256k1PublicKey { + bytes1 tag; + bytes32 x; + } + + error UnauthorizedOnlyOwnerOrNodeOwner(); + error NodeOwnerExists(); + error NodeOwnerDoesNotExist(); + error NodeOwnerNotFound(); + error ValidatorPubKeyExists(); + error AttesterPubKeyExists(); + error InvalidInputNodeOwnerAddress(); + error InvalidInputBLS12_381PublicKey(); + error InvalidInputBLS12_381Signature(); + error InvalidInputSecp256k1PublicKey(); + + event NodeAdded( + address indexed nodeOwner, + uint32 validatorWeight, + BLS12_381PublicKey validatorPubKey, + BLS12_381Signature validatorPoP, + uint32 attesterWeight, + Secp256k1PublicKey attesterPubKey + ); + event NodeDeactivated(address indexed nodeOwner); + event NodeActivated(address indexed nodeOwner); + event NodeRemoved(address indexed nodeOwner); + event NodeDeleted(address indexed nodeOwner); + event NodeValidatorWeightChanged(address indexed nodeOwner, uint32 newWeight); + event NodeAttesterWeightChanged(address indexed nodeOwner, uint32 newWeight); + event NodeValidatorKeyChanged(address indexed nodeOwner, BLS12_381PublicKey newPubKey, BLS12_381Signature newPoP); + event NodeAttesterKeyChanged(address indexed nodeOwner, Secp256k1PublicKey newPubKey); + event ValidatorsCommitted(uint32 commit); + event AttestersCommitted(uint32 commit); + + function add( + address _nodeOwner, + uint32 _validatorWeight, + BLS12_381PublicKey calldata _validatorPubKey, + BLS12_381Signature calldata _validatorPoP, + uint32 _attesterWeight, + Secp256k1PublicKey calldata _attesterPubKey + ) external; + + function deactivate(address _nodeOwner) external; + + function activate(address _nodeOwner) external; + + function remove(address _nodeOwner) external; + + function changeValidatorWeight(address _nodeOwner, uint32 _weight) external; + + function changeAttesterWeight(address _nodeOwner, uint32 _weight) external; + + function changeValidatorKey( + address _nodeOwner, + BLS12_381PublicKey calldata _pubKey, + BLS12_381Signature calldata _pop + ) external; + + function changeAttesterKey(address _nodeOwner, Secp256k1PublicKey calldata _pubKey) external; + + function commitAttesterCommittee() external; + + function commitValidatorCommittee() external; + + function getAttesterCommittee() external view returns (CommitteeAttester[] memory); + + function getValidatorCommittee() external view returns (CommitteeValidator[] memory); +} diff --git a/l2-contracts/contracts/interfaces/IL2DAValidator.sol b/l2-contracts/contracts/interfaces/IL2DAValidator.sol index 3289bfc54..1e053307d 100644 --- a/l2-contracts/contracts/interfaces/IL2DAValidator.sol +++ b/l2-contracts/contracts/interfaces/IL2DAValidator.sol @@ -1,6 +1,6 @@ // SPDX-License-Identifier: MIT -pragma solidity 0.8.20; +pragma solidity ^0.8.20; interface IL2DAValidator { function validatePubdata( diff --git a/l2-contracts/contracts/verifier/Verifier.sol b/l2-contracts/contracts/verifier/Verifier.sol new file mode 100644 index 000000000..dd4eaff55 --- /dev/null +++ b/l2-contracts/contracts/verifier/Verifier.sol @@ -0,0 +1,1711 @@ +// SPDX-License-Identifier: MIT + +pragma solidity 0.8.24; + +import {IVerifier} from "./chain-interfaces/IVerifier.sol"; + +/* solhint-disable max-line-length */ +/// @author Matter Labs +/// @notice Modified version of the Permutations over Lagrange-bases for Oecumenical Noninteractive arguments of +/// Knowledge (PLONK) verifier. +/// Modifications have been made to optimize the proof system for ZK chain circuits. +/// @dev Contract was generated from a verification key with a hash of 0x14f97b81e54b35fe673d8708cc1a19e1ea5b5e348e12d31e39824ed4f42bbca2 +/// @dev It uses a custom memory layout inside the inline assembly block. Each reserved memory cell is declared in the +/// constants below. +/// @dev For a better understanding of the verifier algorithm please refer to the following papers: +/// * Original Plonk Article: https://eprint.iacr.org/2019/953.pdf +/// * Original LookUp Article: https://eprint.iacr.org/2020/315.pdf +/// * Plonk for ZKsync v1.1: https://github.com/matter-labs/solidity_plonk_verifier/raw/recursive/bellman_vk_codegen_recursive/RecursivePlonkUnrolledForEthereum.pdf +/// The notation used in the code is the same as in the papers. +/* solhint-enable max-line-length */ +contract Verifier is IVerifier { + /*////////////////////////////////////////////////////////////// + Verification keys + //////////////////////////////////////////////////////////////*/ + + // Memory slots from 0x000 to 0x200 are reserved for intermediate computations and call to precompiles. + + uint256 internal constant VK_GATE_SETUP_0_X_SLOT = 0x200 + 0x000; + uint256 internal constant VK_GATE_SETUP_0_Y_SLOT = 0x200 + 0x020; + uint256 internal constant VK_GATE_SETUP_1_X_SLOT = 0x200 + 0x040; + uint256 internal constant VK_GATE_SETUP_1_Y_SLOT = 0x200 + 0x060; + uint256 internal constant VK_GATE_SETUP_2_X_SLOT = 0x200 + 0x080; + uint256 internal constant VK_GATE_SETUP_2_Y_SLOT = 0x200 + 0x0a0; + uint256 internal constant VK_GATE_SETUP_3_X_SLOT = 0x200 + 0x0c0; + uint256 internal constant VK_GATE_SETUP_3_Y_SLOT = 0x200 + 0x0e0; + uint256 internal constant VK_GATE_SETUP_4_X_SLOT = 0x200 + 0x100; + uint256 internal constant VK_GATE_SETUP_4_Y_SLOT = 0x200 + 0x120; + uint256 internal constant VK_GATE_SETUP_5_X_SLOT = 0x200 + 0x140; + uint256 internal constant VK_GATE_SETUP_5_Y_SLOT = 0x200 + 0x160; + uint256 internal constant VK_GATE_SETUP_6_X_SLOT = 0x200 + 0x180; + uint256 internal constant VK_GATE_SETUP_6_Y_SLOT = 0x200 + 0x1a0; + uint256 internal constant VK_GATE_SETUP_7_X_SLOT = 0x200 + 0x1c0; + uint256 internal constant VK_GATE_SETUP_7_Y_SLOT = 0x200 + 0x1e0; + + uint256 internal constant VK_GATE_SELECTORS_0_X_SLOT = 0x200 + 0x200; + uint256 internal constant VK_GATE_SELECTORS_0_Y_SLOT = 0x200 + 0x220; + uint256 internal constant VK_GATE_SELECTORS_1_X_SLOT = 0x200 + 0x240; + uint256 internal constant VK_GATE_SELECTORS_1_Y_SLOT = 0x200 + 0x260; + + uint256 internal constant VK_PERMUTATION_0_X_SLOT = 0x200 + 0x280; + uint256 internal constant VK_PERMUTATION_0_Y_SLOT = 0x200 + 0x2a0; + uint256 internal constant VK_PERMUTATION_1_X_SLOT = 0x200 + 0x2c0; + uint256 internal constant VK_PERMUTATION_1_Y_SLOT = 0x200 + 0x2e0; + uint256 internal constant VK_PERMUTATION_2_X_SLOT = 0x200 + 0x300; + uint256 internal constant VK_PERMUTATION_2_Y_SLOT = 0x200 + 0x320; + uint256 internal constant VK_PERMUTATION_3_X_SLOT = 0x200 + 0x340; + uint256 internal constant VK_PERMUTATION_3_Y_SLOT = 0x200 + 0x360; + + uint256 internal constant VK_LOOKUP_SELECTOR_X_SLOT = 0x200 + 0x380; + uint256 internal constant VK_LOOKUP_SELECTOR_Y_SLOT = 0x200 + 0x3a0; + + uint256 internal constant VK_LOOKUP_TABLE_0_X_SLOT = 0x200 + 0x3c0; + uint256 internal constant VK_LOOKUP_TABLE_0_Y_SLOT = 0x200 + 0x3e0; + uint256 internal constant VK_LOOKUP_TABLE_1_X_SLOT = 0x200 + 0x400; + uint256 internal constant VK_LOOKUP_TABLE_1_Y_SLOT = 0x200 + 0x420; + uint256 internal constant VK_LOOKUP_TABLE_2_X_SLOT = 0x200 + 0x440; + uint256 internal constant VK_LOOKUP_TABLE_2_Y_SLOT = 0x200 + 0x460; + uint256 internal constant VK_LOOKUP_TABLE_3_X_SLOT = 0x200 + 0x480; + uint256 internal constant VK_LOOKUP_TABLE_3_Y_SLOT = 0x200 + 0x4a0; + + uint256 internal constant VK_LOOKUP_TABLE_TYPE_X_SLOT = 0x200 + 0x4c0; + uint256 internal constant VK_LOOKUP_TABLE_TYPE_Y_SLOT = 0x200 + 0x4e0; + + uint256 internal constant VK_RECURSIVE_FLAG_SLOT = 0x200 + 0x500; + + /*////////////////////////////////////////////////////////////// + Proof + //////////////////////////////////////////////////////////////*/ + + uint256 internal constant PROOF_PUBLIC_INPUT = 0x200 + 0x520 + 0x000; + + uint256 internal constant PROOF_STATE_POLYS_0_X_SLOT = 0x200 + 0x520 + 0x020; + uint256 internal constant PROOF_STATE_POLYS_0_Y_SLOT = 0x200 + 0x520 + 0x040; + uint256 internal constant PROOF_STATE_POLYS_1_X_SLOT = 0x200 + 0x520 + 0x060; + uint256 internal constant PROOF_STATE_POLYS_1_Y_SLOT = 0x200 + 0x520 + 0x080; + uint256 internal constant PROOF_STATE_POLYS_2_X_SLOT = 0x200 + 0x520 + 0x0a0; + uint256 internal constant PROOF_STATE_POLYS_2_Y_SLOT = 0x200 + 0x520 + 0x0c0; + uint256 internal constant PROOF_STATE_POLYS_3_X_SLOT = 0x200 + 0x520 + 0x0e0; + uint256 internal constant PROOF_STATE_POLYS_3_Y_SLOT = 0x200 + 0x520 + 0x100; + + uint256 internal constant PROOF_COPY_PERMUTATION_GRAND_PRODUCT_X_SLOT = 0x200 + 0x520 + 0x120; + uint256 internal constant PROOF_COPY_PERMUTATION_GRAND_PRODUCT_Y_SLOT = 0x200 + 0x520 + 0x140; + + uint256 internal constant PROOF_LOOKUP_S_POLY_X_SLOT = 0x200 + 0x520 + 0x160; + uint256 internal constant PROOF_LOOKUP_S_POLY_Y_SLOT = 0x200 + 0x520 + 0x180; + + uint256 internal constant PROOF_LOOKUP_GRAND_PRODUCT_X_SLOT = 0x200 + 0x520 + 0x1a0; + uint256 internal constant PROOF_LOOKUP_GRAND_PRODUCT_Y_SLOT = 0x200 + 0x520 + 0x1c0; + + uint256 internal constant PROOF_QUOTIENT_POLY_PARTS_0_X_SLOT = 0x200 + 0x520 + 0x1e0; + uint256 internal constant PROOF_QUOTIENT_POLY_PARTS_0_Y_SLOT = 0x200 + 0x520 + 0x200; + uint256 internal constant PROOF_QUOTIENT_POLY_PARTS_1_X_SLOT = 0x200 + 0x520 + 0x220; + uint256 internal constant PROOF_QUOTIENT_POLY_PARTS_1_Y_SLOT = 0x200 + 0x520 + 0x240; + uint256 internal constant PROOF_QUOTIENT_POLY_PARTS_2_X_SLOT = 0x200 + 0x520 + 0x260; + uint256 internal constant PROOF_QUOTIENT_POLY_PARTS_2_Y_SLOT = 0x200 + 0x520 + 0x280; + uint256 internal constant PROOF_QUOTIENT_POLY_PARTS_3_X_SLOT = 0x200 + 0x520 + 0x2a0; + uint256 internal constant PROOF_QUOTIENT_POLY_PARTS_3_Y_SLOT = 0x200 + 0x520 + 0x2c0; + + uint256 internal constant PROOF_STATE_POLYS_0_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x2e0; + uint256 internal constant PROOF_STATE_POLYS_1_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x300; + uint256 internal constant PROOF_STATE_POLYS_2_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x320; + uint256 internal constant PROOF_STATE_POLYS_3_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x340; + + uint256 internal constant PROOF_STATE_POLYS_3_OPENING_AT_Z_OMEGA_SLOT = 0x200 + 0x520 + 0x360; + uint256 internal constant PROOF_GATE_SELECTORS_0_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x380; + + uint256 internal constant PROOF_COPY_PERMUTATION_POLYS_0_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x3a0; + uint256 internal constant PROOF_COPY_PERMUTATION_POLYS_1_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x3c0; + uint256 internal constant PROOF_COPY_PERMUTATION_POLYS_2_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x3e0; + + uint256 internal constant PROOF_COPY_PERMUTATION_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT = 0x200 + 0x520 + 0x400; + uint256 internal constant PROOF_LOOKUP_S_POLY_OPENING_AT_Z_OMEGA_SLOT = 0x200 + 0x520 + 0x420; + uint256 internal constant PROOF_LOOKUP_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT = 0x200 + 0x520 + 0x440; + uint256 internal constant PROOF_LOOKUP_T_POLY_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x460; + uint256 internal constant PROOF_LOOKUP_T_POLY_OPENING_AT_Z_OMEGA_SLOT = 0x200 + 0x520 + 0x480; + uint256 internal constant PROOF_LOOKUP_SELECTOR_POLY_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x4a0; + uint256 internal constant PROOF_LOOKUP_TABLE_TYPE_POLY_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x4c0; + uint256 internal constant PROOF_QUOTIENT_POLY_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x4e0; + uint256 internal constant PROOF_LINEARISATION_POLY_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x500; + + uint256 internal constant PROOF_OPENING_PROOF_AT_Z_X_SLOT = 0x200 + 0x520 + 0x520; + uint256 internal constant PROOF_OPENING_PROOF_AT_Z_Y_SLOT = 0x200 + 0x520 + 0x540; + uint256 internal constant PROOF_OPENING_PROOF_AT_Z_OMEGA_X_SLOT = 0x200 + 0x520 + 0x560; + uint256 internal constant PROOF_OPENING_PROOF_AT_Z_OMEGA_Y_SLOT = 0x200 + 0x520 + 0x580; + + uint256 internal constant PROOF_RECURSIVE_PART_P1_X_SLOT = 0x200 + 0x520 + 0x5a0; + uint256 internal constant PROOF_RECURSIVE_PART_P1_Y_SLOT = 0x200 + 0x520 + 0x5c0; + + uint256 internal constant PROOF_RECURSIVE_PART_P2_X_SLOT = 0x200 + 0x520 + 0x5e0; + uint256 internal constant PROOF_RECURSIVE_PART_P2_Y_SLOT = 0x200 + 0x520 + 0x600; + + /*////////////////////////////////////////////////////////////// + Transcript slot + //////////////////////////////////////////////////////////////*/ + + uint256 internal constant TRANSCRIPT_BEGIN_SLOT = 0x200 + 0x520 + 0x620 + 0x00; + uint256 internal constant TRANSCRIPT_DST_BYTE_SLOT = 0x200 + 0x520 + 0x620 + 0x03; + uint256 internal constant TRANSCRIPT_STATE_0_SLOT = 0x200 + 0x520 + 0x620 + 0x04; + uint256 internal constant TRANSCRIPT_STATE_1_SLOT = 0x200 + 0x520 + 0x620 + 0x24; + uint256 internal constant TRANSCRIPT_CHALLENGE_SLOT = 0x200 + 0x520 + 0x620 + 0x44; + + /*////////////////////////////////////////////////////////////// + Partial verifier state + //////////////////////////////////////////////////////////////*/ + + uint256 internal constant STATE_ALPHA_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x000; + uint256 internal constant STATE_BETA_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x020; + uint256 internal constant STATE_GAMMA_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x040; + uint256 internal constant STATE_POWER_OF_ALPHA_2_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x060; + uint256 internal constant STATE_POWER_OF_ALPHA_3_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x080; + uint256 internal constant STATE_POWER_OF_ALPHA_4_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x0a0; + uint256 internal constant STATE_POWER_OF_ALPHA_5_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x0c0; + uint256 internal constant STATE_POWER_OF_ALPHA_6_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x0e0; + uint256 internal constant STATE_POWER_OF_ALPHA_7_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x100; + uint256 internal constant STATE_POWER_OF_ALPHA_8_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x120; + uint256 internal constant STATE_ETA_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x140; + uint256 internal constant STATE_BETA_LOOKUP_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x160; + uint256 internal constant STATE_GAMMA_LOOKUP_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x180; + uint256 internal constant STATE_BETA_PLUS_ONE_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x1a0; + uint256 internal constant STATE_BETA_GAMMA_PLUS_GAMMA_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x1c0; + uint256 internal constant STATE_V_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x1e0; + uint256 internal constant STATE_U_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x200; + uint256 internal constant STATE_Z_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x220; + uint256 internal constant STATE_Z_MINUS_LAST_OMEGA_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x240; + uint256 internal constant STATE_L_0_AT_Z_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x260; + uint256 internal constant STATE_L_N_MINUS_ONE_AT_Z_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x280; + uint256 internal constant STATE_Z_IN_DOMAIN_SIZE = 0x200 + 0x520 + 0x620 + 0x80 + 0x2a0; + + /*////////////////////////////////////////////////////////////// + Queries + //////////////////////////////////////////////////////////////*/ + + uint256 internal constant QUERIES_BUFFER_POINT_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x00; + + uint256 internal constant QUERIES_AT_Z_0_X_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x40; + uint256 internal constant QUERIES_AT_Z_0_Y_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x60; + uint256 internal constant QUERIES_AT_Z_1_X_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x80; + uint256 internal constant QUERIES_AT_Z_1_Y_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0xa0; + + uint256 internal constant QUERIES_T_POLY_AGGREGATED_X_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0xc0; + uint256 internal constant QUERIES_T_POLY_AGGREGATED_Y_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0xe0; + + /*////////////////////////////////////////////////////////////// + Aggregated commitment + //////////////////////////////////////////////////////////////*/ + + uint256 internal constant AGGREGATED_AT_Z_X_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x00; + uint256 internal constant AGGREGATED_AT_Z_Y_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x20; + + uint256 internal constant AGGREGATED_AT_Z_OMEGA_X_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x40; + uint256 internal constant AGGREGATED_AT_Z_OMEGA_Y_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x60; + + uint256 internal constant AGGREGATED_OPENING_AT_Z_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x80; + uint256 internal constant AGGREGATED_OPENING_AT_Z_OMEGA_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0xa0; + + /*////////////////////////////////////////////////////////////// + Pairing data + //////////////////////////////////////////////////////////////*/ + + uint256 internal constant PAIRING_BUFFER_POINT_X_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0xc0 + 0x00; + uint256 internal constant PAIRING_BUFFER_POINT_Y_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0xc0 + 0x20; + + uint256 internal constant PAIRING_PAIR_WITH_GENERATOR_X_SLOT = + 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0xc0 + 0x40; + uint256 internal constant PAIRING_PAIR_WITH_GENERATOR_Y_SLOT = + 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0xc0 + 0x60; + + uint256 internal constant PAIRING_PAIR_WITH_X_X_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x100 + 0x80; + uint256 internal constant PAIRING_PAIR_WITH_X_Y_SLOT = 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x100 + 0xa0; + + /*////////////////////////////////////////////////////////////// + Slots for scalar multiplication optimizations + //////////////////////////////////////////////////////////////*/ + + uint256 internal constant COPY_PERMUTATION_FIRST_AGGREGATED_COMMITMENT_COEFF = + 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x100 + 0xc0; + uint256 internal constant LOOKUP_GRAND_PRODUCT_FIRST_AGGREGATED_COMMITMENT_COEFF = + 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x100 + 0xe0; + uint256 internal constant LOOKUP_S_FIRST_AGGREGATED_COMMITMENT_COEFF = + 0x200 + 0x520 + 0x620 + 0x80 + 0x2c0 + 0x100 + 0x100 + 0x100; + + /*////////////////////////////////////////////////////////////// + Constants + //////////////////////////////////////////////////////////////*/ + + uint256 internal constant OMEGA = 0x1951441010b2b95a6e47a6075066a50a036f5ba978c050f2821df86636c0facb; + uint256 internal constant DOMAIN_SIZE = 0x1000000; // 2^24 + uint256 internal constant Q_MOD = 21888242871839275222246405745257275088696311157297823662689037894645226208583; + uint256 internal constant R_MOD = 21888242871839275222246405745257275088548364400416034343698204186575808495617; + + /// @dev flip of 0xe000000000000000000000000000000000000000000000000000000000000000; + uint256 internal constant FR_MASK = 0x1fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff; + + // non residues + uint256 internal constant NON_RESIDUES_0 = 0x05; + uint256 internal constant NON_RESIDUES_1 = 0x07; + uint256 internal constant NON_RESIDUES_2 = 0x0a; + + // trusted setup g2 elements + uint256 internal constant G2_ELEMENTS_0_X1 = 0x198e9393920d483a7260bfb731fb5d25f1aa493335a9e71297e485b7aef312c2; + uint256 internal constant G2_ELEMENTS_0_X2 = 0x1800deef121f1e76426a00665e5c4479674322d4f75edadd46debd5cd992f6ed; + uint256 internal constant G2_ELEMENTS_0_Y1 = 0x090689d0585ff075ec9e99ad690c3395bc4b313370b38ef355acdadcd122975b; + uint256 internal constant G2_ELEMENTS_0_Y2 = 0x12c85ea5db8c6deb4aab71808dcb408fe3d1e7690c43d37b4ce6cc0166fa7daa; + uint256 internal constant G2_ELEMENTS_1_X1 = 0x260e01b251f6f1c7e7ff4e580791dee8ea51d87a358e038b4efe30fac09383c1; + uint256 internal constant G2_ELEMENTS_1_X2 = 0x0118c4d5b837bcc2bc89b5b398b5974e9f5944073b32078b7e231fec938883b0; + uint256 internal constant G2_ELEMENTS_1_Y1 = 0x04fc6369f7110fe3d25156c1bb9a72859cf2a04641f99ba4ee413c80da6a5fe4; + uint256 internal constant G2_ELEMENTS_1_Y2 = 0x22febda3c0c0632a56475b4214e5615e11e6dd3f96e6cea2854a87d4dacc5e55; + + /// @inheritdoc IVerifier + function verificationKeyHash() external pure returns (bytes32 vkHash) { + _loadVerificationKey(); + + assembly { + let start := VK_GATE_SETUP_0_X_SLOT + let end := VK_RECURSIVE_FLAG_SLOT + let length := add(sub(end, start), 0x20) + + vkHash := keccak256(start, length) + } + } + + /// @notice Load verification keys to memory in runtime. + /// @dev The constants are loaded into memory in a specific layout declared in the constants starting from + /// `VK_` prefix. + /// NOTE: Function may corrupt the memory state if some memory was used before this function was called. + /// The VK consists of commitments to setup polynomials: + /// [q_a], [q_b], [q_c], [q_d], - main gate setup commitments + /// [q_{d_next}], [q_ab], [q_ac], [q_const] / + /// [main_gate_selector], [custom_gate_selector] - gate selectors commitments + /// [sigma_0], [sigma_1], [sigma_2], [sigma_3] - permutation polynomials commitments + /// [lookup_selector] - lookup selector commitment + /// [col_0], [col_1], [col_2], [col_3] - lookup columns commitments + /// [table_type] - lookup table type commitment + function _loadVerificationKey() internal pure virtual { + assembly { + // gate setup commitments + mstore(VK_GATE_SETUP_0_X_SLOT, 0x110deb1e0863737f9a3d7b4de641a03aa00a77bc9f1a05acc9d55b76ab9fdd4d) + mstore(VK_GATE_SETUP_0_Y_SLOT, 0x2c9dc252441e9298b7f6df6335a252517b7bccb924adf537b87c5cd3383fd7a9) + mstore(VK_GATE_SETUP_1_X_SLOT, 0x04659caf7b05471ba5ba85b1ab62267aa6c456836e625f169f7119d55b9462d2) + mstore(VK_GATE_SETUP_1_Y_SLOT, 0x0ea63403692148d2ad22189a1e5420076312f4d46e62036a043a6b0b84d5b410) + mstore(VK_GATE_SETUP_2_X_SLOT, 0x0e6696d09d65fce1e42805be03fca1f14aea247281f688981f925e77d4ce2291) + mstore(VK_GATE_SETUP_2_Y_SLOT, 0x0228f6cf8fe20c1e07e5b78bf8c41d50e55975a126d22a198d1e56acd4bbb3dd) + mstore(VK_GATE_SETUP_3_X_SLOT, 0x14685dafe340b1dec5eafcd5e7faddaf24f3781ddc53309cc25d0b42c00541dd) + mstore(VK_GATE_SETUP_3_Y_SLOT, 0x0e651cff9447cb360198899b80fa23e89ec13bc94ff161729aa841d2b55ea5be) + mstore(VK_GATE_SETUP_4_X_SLOT, 0x16e9ef76cb68f2750eb0ee72382dd9911a982308d0ab10ef94dada13c382ae73) + mstore(VK_GATE_SETUP_4_Y_SLOT, 0x22e404bc91350f3bc7daad1d1025113742436983c85eac5ab7b42221a181b81e) + mstore(VK_GATE_SETUP_5_X_SLOT, 0x0d9b29613037a5025655c82b143d2b7449c98f3aea358307c8529249cc54f3b9) + mstore(VK_GATE_SETUP_5_Y_SLOT, 0x15b3c4c946ad1babfc4c03ff7c2423fd354af3a9305c499b7fb3aaebe2fee746) + mstore(VK_GATE_SETUP_6_X_SLOT, 0x2a4cb6c495dbc7201142cc773da895ae2046e790073988fb850aca6aead27b8a) + mstore(VK_GATE_SETUP_6_Y_SLOT, 0x28ef9200c3cb67da82030520d640292014f5f7c2e2909da608812e04671a3acf) + mstore(VK_GATE_SETUP_7_X_SLOT, 0x283344a1ab3e55ecfd904d0b8e9f4faea338df5a4ead2fa9a42f0e103da40abc) + mstore(VK_GATE_SETUP_7_Y_SLOT, 0x223b37b83b9687512d322993edd70e508dd80adb10bcf7321a3cc8a44c269521) + + // gate selectors commitments + mstore(VK_GATE_SELECTORS_0_X_SLOT, 0x1f67f0ba5f7e837bc680acb4e612ebd938ad35211aa6e05b96cad19e66b82d2d) + mstore(VK_GATE_SELECTORS_0_Y_SLOT, 0x2820641a84d2e8298ac2ac42bd4b912c0c37f768ecc83d3a29e7c720763d15a1) + mstore(VK_GATE_SELECTORS_1_X_SLOT, 0x0353257957562270292a17860ca8e8827703f828f440ee004848b1e23fdf9de2) + mstore(VK_GATE_SELECTORS_1_Y_SLOT, 0x305f4137fee253dff8b2bfe579038e8f25d5bd217865072af5d89fc8800ada24) + + // permutation commitments + mstore(VK_PERMUTATION_0_X_SLOT, 0x13a600154b369ff3237706d00948e465ee1c32c7a6d3e18bccd9c4a15910f2e5) + mstore(VK_PERMUTATION_0_Y_SLOT, 0x138aa24fbf4cdddc75114811b3d59040394c218ecef3eb46ef9bd646f7e53776) + mstore(VK_PERMUTATION_1_X_SLOT, 0x277fff1f80c409357e2d251d79f6e3fd2164b755ce69cfd72de5c690289df662) + mstore(VK_PERMUTATION_1_Y_SLOT, 0x25235588e28c70eea3e35531c80deac25cd9b53ea3f98993f120108bc7abf670) + mstore(VK_PERMUTATION_2_X_SLOT, 0x0990e07a9b001048b947d0e5bd6157214c7359b771f01bf52bd771ba563a900e) + mstore(VK_PERMUTATION_2_Y_SLOT, 0x05e5fb090dd40914c8606d875e301167ae3047d684a02b44d9d36f1eaf43d0b4) + mstore(VK_PERMUTATION_3_X_SLOT, 0x1d4656690b33299db5631401a282afab3e16c78ee2c9ad9efea628171dcbc6bc) + mstore(VK_PERMUTATION_3_Y_SLOT, 0x0ebda2ebe582f601f813ec1e3970d13ef1500c742a85cce9b7f190f333de03b0) + + // lookup tables commitments + mstore(VK_LOOKUP_TABLE_0_X_SLOT, 0x2c513ed74d9d57a5ec901e074032741036353a2c4513422e96e7b53b302d765b) + mstore(VK_LOOKUP_TABLE_0_Y_SLOT, 0x04dd964427e430f16004076d708c0cb21e225056cc1d57418cfbd3d472981468) + mstore(VK_LOOKUP_TABLE_1_X_SLOT, 0x1ea83e5e65c6f8068f4677e2911678cf329b28259642a32db1f14b8347828aac) + mstore(VK_LOOKUP_TABLE_1_Y_SLOT, 0x1d22bc884a2da4962a893ba8de13f57aaeb785ed52c5e686994839cab8f7475d) + mstore(VK_LOOKUP_TABLE_2_X_SLOT, 0x0b2e7212d0d9cff26d0bdf3d79b2cac029a25dfeb1cafdf49e2349d7db348d89) + mstore(VK_LOOKUP_TABLE_2_Y_SLOT, 0x1301f9b252419ea240eb67fda720ca0b16d92364027285f95e9b1349490fa283) + mstore(VK_LOOKUP_TABLE_3_X_SLOT, 0x02f7b99fdfa5b418548c2d777785820e02383cfc87e7085e280a375a358153bf) + mstore(VK_LOOKUP_TABLE_3_Y_SLOT, 0x09d004fe08dc4d19c382df36fad22ef676185663543703e6a4b40203e50fd8a6) + + // lookup selector commitment + mstore(VK_LOOKUP_SELECTOR_X_SLOT, 0x2f4d347c7fb61daaadfff881e24f4b5dcfdc0d70a95bcb148168b90ef93e0007) + mstore(VK_LOOKUP_SELECTOR_Y_SLOT, 0x2322632465ba8e28cd0a4befd813ea85a972f4f6fa8e8603cf5d062dbcb14065) + + // table type commitment + mstore(VK_LOOKUP_TABLE_TYPE_X_SLOT, 0x1e3c9fc98c118e4bc34f1f93d214a5d86898e980c40d8e2c180c6ada377a7467) + mstore(VK_LOOKUP_TABLE_TYPE_Y_SLOT, 0x2260a13535c35a15c173f5e5797d4b675b55d164a9995bfb7624971324bd84a8) + + // flag for using recursive part + mstore(VK_RECURSIVE_FLAG_SLOT, 0) + } + } + + /// @inheritdoc IVerifier + function verify( + uint256[] calldata, // _publicInputs + uint256[] calldata // _proof + ) public view virtual returns (bool) { + // No memory was accessed yet, so keys can be loaded into the right place and not corrupt any other memory. + _loadVerificationKey(); + + // Beginning of the big inline assembly block that makes all the verification work. + // Note: We use the custom memory layout, so the return value should be returned from the assembly, not + // Solidity code. + assembly { + /*////////////////////////////////////////////////////////////// + Utils + //////////////////////////////////////////////////////////////*/ + + /// @dev Reverts execution with a provided revert reason. + /// @param len The byte length of the error message string, which is expected to be no more than 32. + /// @param reason The 1-word revert reason string, encoded in ASCII. + function revertWithMessage(len, reason) { + // "Error(string)" signature: bytes32(bytes4(keccak256("Error(string)"))) + mstore(0x00, 0x08c379a000000000000000000000000000000000000000000000000000000000) + // Data offset + mstore(0x04, 0x0000000000000000000000000000000000000000000000000000000000000020) + // Length of revert string + mstore(0x24, len) + // Revert reason + mstore(0x44, reason) + // Revert + revert(0x00, 0x64) + } + + /// @dev Performs modular exponentiation using the formula (value ^ power) mod R_MOD. + function modexp(value, power) -> res { + res := 1 + for { + + } gt(power, 0) { + + } { + if mod(power, 2) { + res := mulmod(res, value, R_MOD) + } + value := mulmod(value, value, R_MOD) + power := shr(1, power) + } + } + + /// @dev Performs a point multiplication operation and stores the result in a given memory destination. + function pointMulIntoDest(point, s, dest) { + mstore(0x00, mload(point)) + mstore(0x20, mload(add(point, 0x20))) + mstore(0x40, s) + if iszero(staticcall(gas(), 7, 0, 0x60, dest, 0x40)) { + revertWithMessage(30, "pointMulIntoDest: ecMul failed") + } + } + + /// @dev Performs a point addition operation and stores the result in a given memory destination. + function pointAddIntoDest(p1, p2, dest) { + mstore(0x00, mload(p1)) + mstore(0x20, mload(add(p1, 0x20))) + mstore(0x40, mload(p2)) + mstore(0x60, mload(add(p2, 0x20))) + if iszero(staticcall(gas(), 6, 0x00, 0x80, dest, 0x40)) { + revertWithMessage(30, "pointAddIntoDest: ecAdd failed") + } + } + + /// @dev Performs a point subtraction operation and updates the first point with the result. + function pointSubAssign(p1, p2) { + mstore(0x00, mload(p1)) + mstore(0x20, mload(add(p1, 0x20))) + mstore(0x40, mload(p2)) + mstore(0x60, sub(Q_MOD, mload(add(p2, 0x20)))) + if iszero(staticcall(gas(), 6, 0x00, 0x80, p1, 0x40)) { + revertWithMessage(28, "pointSubAssign: ecAdd failed") + } + } + + /// @dev Performs a point addition operation and updates the first point with the result. + function pointAddAssign(p1, p2) { + mstore(0x00, mload(p1)) + mstore(0x20, mload(add(p1, 0x20))) + mstore(0x40, mload(p2)) + mstore(0x60, mload(add(p2, 0x20))) + if iszero(staticcall(gas(), 6, 0x00, 0x80, p1, 0x40)) { + revertWithMessage(28, "pointAddAssign: ecAdd failed") + } + } + + /// @dev Performs a point multiplication operation and then adds the result to the destination point. + function pointMulAndAddIntoDest(point, s, dest) { + mstore(0x00, mload(point)) + mstore(0x20, mload(add(point, 0x20))) + mstore(0x40, s) + let success := staticcall(gas(), 7, 0, 0x60, 0, 0x40) + + mstore(0x40, mload(dest)) + mstore(0x60, mload(add(dest, 0x20))) + success := and(success, staticcall(gas(), 6, 0x00, 0x80, dest, 0x40)) + + if iszero(success) { + revertWithMessage(22, "pointMulAndAddIntoDest") + } + } + + /// @dev Negates an elliptic curve point by changing the sign of the y-coordinate. + function pointNegate(point) { + let pY := mload(add(point, 0x20)) + switch pY + case 0 { + if mload(point) { + revertWithMessage(26, "pointNegate: invalid point") + } + } + default { + mstore(add(point, 0x20), sub(Q_MOD, pY)) + } + } + + /*////////////////////////////////////////////////////////////// + Transcript helpers + //////////////////////////////////////////////////////////////*/ + + /// @dev Updates the transcript state with a new challenge value. + function updateTranscript(value) { + mstore8(TRANSCRIPT_DST_BYTE_SLOT, 0x00) + mstore(TRANSCRIPT_CHALLENGE_SLOT, value) + let newState0 := keccak256(TRANSCRIPT_BEGIN_SLOT, 0x64) + mstore8(TRANSCRIPT_DST_BYTE_SLOT, 0x01) + let newState1 := keccak256(TRANSCRIPT_BEGIN_SLOT, 0x64) + mstore(TRANSCRIPT_STATE_1_SLOT, newState1) + mstore(TRANSCRIPT_STATE_0_SLOT, newState0) + } + + /// @dev Retrieves a transcript challenge. + function getTranscriptChallenge(numberOfChallenge) -> challenge { + mstore8(TRANSCRIPT_DST_BYTE_SLOT, 0x02) + mstore(TRANSCRIPT_CHALLENGE_SLOT, shl(224, numberOfChallenge)) + challenge := and(keccak256(TRANSCRIPT_BEGIN_SLOT, 0x48), FR_MASK) + } + + /*////////////////////////////////////////////////////////////// + 1. Load Proof + //////////////////////////////////////////////////////////////*/ + + /// @dev This function loads a zk-SNARK proof, ensures it's properly formatted, and stores it in memory. + /// It ensures the number of inputs and the elliptic curve point's validity. + /// Note: It does NOT reject inputs that exceed these module sizes, but rather wraps them within the + /// module bounds. + /// The proof consists of: + /// 1. Public input: (1 field element from F_r) + /// + /// 2. Polynomial commitments (elliptic curve points over F_q): + /// [a], [b], [c], [d] - state polynomials commitments + /// [z_perm] - copy-permutation grand product commitment + /// [s] - polynomial for lookup argument commitment + /// [z_lookup] - lookup grand product commitment + /// [t_0], [t_1], [t_2], [t_3] - quotient polynomial parts commitments + /// [W], [W'] - proof openings commitments + /// + /// 3. Polynomial evaluations at z and z*omega (field elements from F_r): + /// t(z) - quotient polynomial opening + /// a(z), b(z), c(z), d(z), d(z*omega) - state polynomials openings + /// main_gate_selector(z) - main gate selector opening + /// sigma_0(z), sigma_1(z), sigma_2(z) - permutation polynomials openings + /// z_perm(z*omega) - copy-permutation grand product opening + /// z_lookup(z*omega) - lookup grand product opening + /// lookup_selector(z) - lookup selector opening + /// s(x*omega), t(z*omega), table_type(z) - lookup argument polynomial openings + /// r(z) - linearisation polynomial opening + /// + /// 4. Recursive proof (0 or 2 elliptic curve points over F_q) + function loadProof() { + // 1. Load public input + let offset := calldataload(0x04) + let publicInputLengthInWords := calldataload(add(offset, 0x04)) + let isValid := eq(publicInputLengthInWords, 1) // We expect only one public input + mstore(PROOF_PUBLIC_INPUT, and(calldataload(add(offset, 0x24)), FR_MASK)) + + // 2. Load the proof (except for the recursive part) + offset := calldataload(0x24) + let proofLengthInWords := calldataload(add(offset, 0x04)) + + // Check the proof length depending on whether the recursive part is present + let expectedProofLength + switch mload(VK_RECURSIVE_FLAG_SLOT) + case 0 { + expectedProofLength := 44 + } + default { + expectedProofLength := 48 + } + isValid := and(eq(proofLengthInWords, expectedProofLength), isValid) + + // PROOF_STATE_POLYS_0 + { + let x := mod(calldataload(add(offset, 0x024)), Q_MOD) + let y := mod(calldataload(add(offset, 0x044)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_STATE_POLYS_0_X_SLOT, x) + mstore(PROOF_STATE_POLYS_0_Y_SLOT, y) + } + // PROOF_STATE_POLYS_1 + { + let x := mod(calldataload(add(offset, 0x064)), Q_MOD) + let y := mod(calldataload(add(offset, 0x084)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_STATE_POLYS_1_X_SLOT, x) + mstore(PROOF_STATE_POLYS_1_Y_SLOT, y) + } + // PROOF_STATE_POLYS_2 + { + let x := mod(calldataload(add(offset, 0x0a4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x0c4)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_STATE_POLYS_2_X_SLOT, x) + mstore(PROOF_STATE_POLYS_2_Y_SLOT, y) + } + // PROOF_STATE_POLYS_3 + { + let x := mod(calldataload(add(offset, 0x0e4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x104)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_STATE_POLYS_3_X_SLOT, x) + mstore(PROOF_STATE_POLYS_3_Y_SLOT, y) + } + // PROOF_COPY_PERMUTATION_GRAND_PRODUCT + { + let x := mod(calldataload(add(offset, 0x124)), Q_MOD) + let y := mod(calldataload(add(offset, 0x144)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_COPY_PERMUTATION_GRAND_PRODUCT_X_SLOT, x) + mstore(PROOF_COPY_PERMUTATION_GRAND_PRODUCT_Y_SLOT, y) + } + // PROOF_LOOKUP_S_POLY + { + let x := mod(calldataload(add(offset, 0x164)), Q_MOD) + let y := mod(calldataload(add(offset, 0x184)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_LOOKUP_S_POLY_X_SLOT, x) + mstore(PROOF_LOOKUP_S_POLY_Y_SLOT, y) + } + // PROOF_LOOKUP_GRAND_PRODUCT + { + let x := mod(calldataload(add(offset, 0x1a4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x1c4)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_LOOKUP_GRAND_PRODUCT_X_SLOT, x) + mstore(PROOF_LOOKUP_GRAND_PRODUCT_Y_SLOT, y) + } + // PROOF_QUOTIENT_POLY_PARTS_0 + { + let x := mod(calldataload(add(offset, 0x1e4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x204)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_QUOTIENT_POLY_PARTS_0_X_SLOT, x) + mstore(PROOF_QUOTIENT_POLY_PARTS_0_Y_SLOT, y) + } + // PROOF_QUOTIENT_POLY_PARTS_1 + { + let x := mod(calldataload(add(offset, 0x224)), Q_MOD) + let y := mod(calldataload(add(offset, 0x244)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_QUOTIENT_POLY_PARTS_1_X_SLOT, x) + mstore(PROOF_QUOTIENT_POLY_PARTS_1_Y_SLOT, y) + } + // PROOF_QUOTIENT_POLY_PARTS_2 + { + let x := mod(calldataload(add(offset, 0x264)), Q_MOD) + let y := mod(calldataload(add(offset, 0x284)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_QUOTIENT_POLY_PARTS_2_X_SLOT, x) + mstore(PROOF_QUOTIENT_POLY_PARTS_2_Y_SLOT, y) + } + // PROOF_QUOTIENT_POLY_PARTS_3 + { + let x := mod(calldataload(add(offset, 0x2a4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x2c4)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_QUOTIENT_POLY_PARTS_3_X_SLOT, x) + mstore(PROOF_QUOTIENT_POLY_PARTS_3_Y_SLOT, y) + } + + mstore(PROOF_STATE_POLYS_0_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x2e4)), R_MOD)) + mstore(PROOF_STATE_POLYS_1_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x304)), R_MOD)) + mstore(PROOF_STATE_POLYS_2_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x324)), R_MOD)) + mstore(PROOF_STATE_POLYS_3_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x344)), R_MOD)) + + mstore(PROOF_STATE_POLYS_3_OPENING_AT_Z_OMEGA_SLOT, mod(calldataload(add(offset, 0x364)), R_MOD)) + mstore(PROOF_GATE_SELECTORS_0_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x384)), R_MOD)) + + mstore(PROOF_COPY_PERMUTATION_POLYS_0_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x3a4)), R_MOD)) + mstore(PROOF_COPY_PERMUTATION_POLYS_1_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x3c4)), R_MOD)) + mstore(PROOF_COPY_PERMUTATION_POLYS_2_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x3e4)), R_MOD)) + + mstore( + PROOF_COPY_PERMUTATION_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT, + mod(calldataload(add(offset, 0x404)), R_MOD) + ) + mstore(PROOF_LOOKUP_S_POLY_OPENING_AT_Z_OMEGA_SLOT, mod(calldataload(add(offset, 0x424)), R_MOD)) + mstore(PROOF_LOOKUP_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT, mod(calldataload(add(offset, 0x444)), R_MOD)) + mstore(PROOF_LOOKUP_T_POLY_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x464)), R_MOD)) + mstore(PROOF_LOOKUP_T_POLY_OPENING_AT_Z_OMEGA_SLOT, mod(calldataload(add(offset, 0x484)), R_MOD)) + mstore(PROOF_LOOKUP_SELECTOR_POLY_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x4a4)), R_MOD)) + mstore(PROOF_LOOKUP_TABLE_TYPE_POLY_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x4c4)), R_MOD)) + mstore(PROOF_QUOTIENT_POLY_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x4e4)), R_MOD)) + mstore(PROOF_LINEARISATION_POLY_OPENING_AT_Z_SLOT, mod(calldataload(add(offset, 0x504)), R_MOD)) + + // PROOF_OPENING_PROOF_AT_Z + { + let x := mod(calldataload(add(offset, 0x524)), Q_MOD) + let y := mod(calldataload(add(offset, 0x544)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_OPENING_PROOF_AT_Z_X_SLOT, x) + mstore(PROOF_OPENING_PROOF_AT_Z_Y_SLOT, y) + } + // PROOF_OPENING_PROOF_AT_Z_OMEGA + { + let x := mod(calldataload(add(offset, 0x564)), Q_MOD) + let y := mod(calldataload(add(offset, 0x584)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_OPENING_PROOF_AT_Z_OMEGA_X_SLOT, x) + mstore(PROOF_OPENING_PROOF_AT_Z_OMEGA_Y_SLOT, y) + } + + // 3. Load the recursive part of the proof + if mload(VK_RECURSIVE_FLAG_SLOT) { + // recursive part should be consist of 2 points + + // PROOF_RECURSIVE_PART_P1 + { + let x := mod(calldataload(add(offset, 0x5a4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x5c4)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_RECURSIVE_PART_P1_X_SLOT, x) + mstore(PROOF_RECURSIVE_PART_P1_Y_SLOT, y) + } + // PROOF_RECURSIVE_PART_P2 + { + let x := mod(calldataload(add(offset, 0x5e4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x604)), Q_MOD) + let xx := mulmod(x, x, Q_MOD) + isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) + mstore(PROOF_RECURSIVE_PART_P2_X_SLOT, x) + mstore(PROOF_RECURSIVE_PART_P2_Y_SLOT, y) + } + } + + // Revert if a proof is not valid + if iszero(isValid) { + revertWithMessage(27, "loadProof: Proof is invalid") + } + } + + /*////////////////////////////////////////////////////////////// + 2. Transcript initialization + //////////////////////////////////////////////////////////////*/ + + /// @notice Recomputes all challenges + /// @dev The process is the following: + /// Commit: PI, [a], [b], [c], [d] + /// Get: eta + /// Commit: [s] + /// Get: beta, gamma + /// Commit: [z_perm] + /// Get: beta', gamma' + /// Commit: [z_lookup] + /// Get: alpha + /// Commit: [t_0], [t_1], [t_2], [t_3] + /// Get: z + /// Commit: t(z), a(z), b(z), c(z), d(z), d(z*omega), + /// main_gate_selector(z), + /// sigma_0(z), sigma_1(z), sigma_2(z), + /// z_perm(z*omega), + /// t(z), lookup_selector(z), table_type(z), + /// s(x*omega), z_lookup(z*omega), t(z*omega), + /// r(z) + /// Get: v + /// Commit: [W], [W'] + /// Get: u + function initializeTranscript() { + // Round 1 + updateTranscript(mload(PROOF_PUBLIC_INPUT)) + updateTranscript(mload(PROOF_STATE_POLYS_0_X_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_0_Y_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_1_X_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_1_Y_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_2_X_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_2_Y_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_3_X_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_3_Y_SLOT)) + + mstore(STATE_ETA_SLOT, getTranscriptChallenge(0)) + + // Round 1.5 + updateTranscript(mload(PROOF_LOOKUP_S_POLY_X_SLOT)) + updateTranscript(mload(PROOF_LOOKUP_S_POLY_Y_SLOT)) + + mstore(STATE_BETA_SLOT, getTranscriptChallenge(1)) + mstore(STATE_GAMMA_SLOT, getTranscriptChallenge(2)) + + // Round 2 + updateTranscript(mload(PROOF_COPY_PERMUTATION_GRAND_PRODUCT_X_SLOT)) + updateTranscript(mload(PROOF_COPY_PERMUTATION_GRAND_PRODUCT_Y_SLOT)) + + mstore(STATE_BETA_LOOKUP_SLOT, getTranscriptChallenge(3)) + mstore(STATE_GAMMA_LOOKUP_SLOT, getTranscriptChallenge(4)) + + // Round 2.5 + updateTranscript(mload(PROOF_LOOKUP_GRAND_PRODUCT_X_SLOT)) + updateTranscript(mload(PROOF_LOOKUP_GRAND_PRODUCT_Y_SLOT)) + + mstore(STATE_ALPHA_SLOT, getTranscriptChallenge(5)) + + // Round 3 + updateTranscript(mload(PROOF_QUOTIENT_POLY_PARTS_0_X_SLOT)) + updateTranscript(mload(PROOF_QUOTIENT_POLY_PARTS_0_Y_SLOT)) + updateTranscript(mload(PROOF_QUOTIENT_POLY_PARTS_1_X_SLOT)) + updateTranscript(mload(PROOF_QUOTIENT_POLY_PARTS_1_Y_SLOT)) + updateTranscript(mload(PROOF_QUOTIENT_POLY_PARTS_2_X_SLOT)) + updateTranscript(mload(PROOF_QUOTIENT_POLY_PARTS_2_Y_SLOT)) + updateTranscript(mload(PROOF_QUOTIENT_POLY_PARTS_3_X_SLOT)) + updateTranscript(mload(PROOF_QUOTIENT_POLY_PARTS_3_Y_SLOT)) + + { + let z := getTranscriptChallenge(6) + + mstore(STATE_Z_SLOT, z) + mstore(STATE_Z_IN_DOMAIN_SIZE, modexp(z, DOMAIN_SIZE)) + } + + // Round 4 + updateTranscript(mload(PROOF_QUOTIENT_POLY_OPENING_AT_Z_SLOT)) + + updateTranscript(mload(PROOF_STATE_POLYS_0_OPENING_AT_Z_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_1_OPENING_AT_Z_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_2_OPENING_AT_Z_SLOT)) + updateTranscript(mload(PROOF_STATE_POLYS_3_OPENING_AT_Z_SLOT)) + + updateTranscript(mload(PROOF_STATE_POLYS_3_OPENING_AT_Z_OMEGA_SLOT)) + updateTranscript(mload(PROOF_GATE_SELECTORS_0_OPENING_AT_Z_SLOT)) + + updateTranscript(mload(PROOF_COPY_PERMUTATION_POLYS_0_OPENING_AT_Z_SLOT)) + updateTranscript(mload(PROOF_COPY_PERMUTATION_POLYS_1_OPENING_AT_Z_SLOT)) + updateTranscript(mload(PROOF_COPY_PERMUTATION_POLYS_2_OPENING_AT_Z_SLOT)) + + updateTranscript(mload(PROOF_COPY_PERMUTATION_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT)) + updateTranscript(mload(PROOF_LOOKUP_T_POLY_OPENING_AT_Z_SLOT)) + updateTranscript(mload(PROOF_LOOKUP_SELECTOR_POLY_OPENING_AT_Z_SLOT)) + updateTranscript(mload(PROOF_LOOKUP_TABLE_TYPE_POLY_OPENING_AT_Z_SLOT)) + updateTranscript(mload(PROOF_LOOKUP_S_POLY_OPENING_AT_Z_OMEGA_SLOT)) + updateTranscript(mload(PROOF_LOOKUP_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT)) + updateTranscript(mload(PROOF_LOOKUP_T_POLY_OPENING_AT_Z_OMEGA_SLOT)) + updateTranscript(mload(PROOF_LINEARISATION_POLY_OPENING_AT_Z_SLOT)) + + mstore(STATE_V_SLOT, getTranscriptChallenge(7)) + + // Round 5 + updateTranscript(mload(PROOF_OPENING_PROOF_AT_Z_X_SLOT)) + updateTranscript(mload(PROOF_OPENING_PROOF_AT_Z_Y_SLOT)) + updateTranscript(mload(PROOF_OPENING_PROOF_AT_Z_OMEGA_X_SLOT)) + updateTranscript(mload(PROOF_OPENING_PROOF_AT_Z_OMEGA_Y_SLOT)) + + mstore(STATE_U_SLOT, getTranscriptChallenge(8)) + } + + /*////////////////////////////////////////////////////////////// + 3. Verifying quotient evaluation + //////////////////////////////////////////////////////////////*/ + + /// @notice Compute linearisation polynomial's constant term: r_0 + /// @dev To save a verifier scalar multiplication, we split linearisation polynomial + /// into its constant and non-constant terms. The constant term is computed with the formula: + /// + /// r_0 = alpha^0 * L_0(z) * PI * q_{main selector}(z) + r(z) -- main gate contribution + /// + /// - alpha^4 * z_perm(z*omega)(sigma_0(z) * beta + gamma + a(z)) \ + /// (sigma_1(z) * beta + gamma + b(z)) | + /// (sigma_2(z) * beta + gamma + c(z)) | - permutation contribution + /// (sigma_3(z) + gamma) | + /// - alpha^5 * L_0(z) / + /// + /// + alpha^6 * (s(z*omega) * beta' + gamma' (beta' + 1)) \ + /// * (z - omega^{n-1}) * z_lookup(z*omega) | - lookup contribution + /// - alpha^7 * L_0(z) | + /// - alpha^8 * L_{n-1}(z) * (gamma' (beta' + 1))^{n-1} / + /// + /// In the end we should check that t(z)*Z_H(z) = r(z) + r_0! + function verifyQuotientEvaluation() { + // Compute power of alpha + { + let alpha := mload(STATE_ALPHA_SLOT) + let currentAlpha := mulmod(alpha, alpha, R_MOD) + mstore(STATE_POWER_OF_ALPHA_2_SLOT, currentAlpha) + currentAlpha := mulmod(currentAlpha, alpha, R_MOD) + mstore(STATE_POWER_OF_ALPHA_3_SLOT, currentAlpha) + currentAlpha := mulmod(currentAlpha, alpha, R_MOD) + mstore(STATE_POWER_OF_ALPHA_4_SLOT, currentAlpha) + currentAlpha := mulmod(currentAlpha, alpha, R_MOD) + mstore(STATE_POWER_OF_ALPHA_5_SLOT, currentAlpha) + currentAlpha := mulmod(currentAlpha, alpha, R_MOD) + mstore(STATE_POWER_OF_ALPHA_6_SLOT, currentAlpha) + currentAlpha := mulmod(currentAlpha, alpha, R_MOD) + mstore(STATE_POWER_OF_ALPHA_7_SLOT, currentAlpha) + currentAlpha := mulmod(currentAlpha, alpha, R_MOD) + mstore(STATE_POWER_OF_ALPHA_8_SLOT, currentAlpha) + } + + // z + let stateZ := mload(STATE_Z_SLOT) + // L_0(z) + mstore(STATE_L_0_AT_Z_SLOT, evaluateLagrangePolyOutOfDomain(0, stateZ)) + // L_{n-1}(z) + mstore(STATE_L_N_MINUS_ONE_AT_Z_SLOT, evaluateLagrangePolyOutOfDomain(sub(DOMAIN_SIZE, 1), stateZ)) + // L_0(z) * PI + let stateT := mulmod(mload(STATE_L_0_AT_Z_SLOT), mload(PROOF_PUBLIC_INPUT), R_MOD) + + // Compute main gate contribution + let result := mulmod(stateT, mload(PROOF_GATE_SELECTORS_0_OPENING_AT_Z_SLOT), R_MOD) + + // Compute permutation contribution + result := addmod(result, permutationQuotientContribution(), R_MOD) + + // Compute lookup contribution + result := addmod(result, lookupQuotientContribution(), R_MOD) + + // Check that r(z) + r_0 = t(z) * Z_H(z) + result := addmod(mload(PROOF_LINEARISATION_POLY_OPENING_AT_Z_SLOT), result, R_MOD) + + let vanishing := addmod(mload(STATE_Z_IN_DOMAIN_SIZE), sub(R_MOD, 1), R_MOD) + let lhs := mulmod(mload(PROOF_QUOTIENT_POLY_OPENING_AT_Z_SLOT), vanishing, R_MOD) + if iszero(eq(lhs, result)) { + revertWithMessage(27, "invalid quotient evaluation") + } + } + + /// @notice Evaluating L_{polyNum}(at) out of domain + /// @dev L_i is a Lagrange polynomial for our domain such that: + /// L_i(omega^i) = 1 and L_i(omega^j) = 0 for all j != i + function evaluateLagrangePolyOutOfDomain(polyNum, at) -> res { + let omegaPower := 1 + if polyNum { + omegaPower := modexp(OMEGA, polyNum) + } + + res := addmod(modexp(at, DOMAIN_SIZE), sub(R_MOD, 1), R_MOD) + + // Vanishing polynomial can not be zero at point `at` + if iszero(res) { + revertWithMessage(28, "invalid vanishing polynomial") + } + res := mulmod(res, omegaPower, R_MOD) + let denominator := addmod(at, sub(R_MOD, omegaPower), R_MOD) + denominator := mulmod(denominator, DOMAIN_SIZE, R_MOD) + denominator := modexp(denominator, sub(R_MOD, 2)) + res := mulmod(res, denominator, R_MOD) + } + + /// @notice Compute permutation contribution to linearisation polynomial's constant term + function permutationQuotientContribution() -> res { + // res = alpha^4 * z_perm(z*omega) + res := mulmod( + mload(STATE_POWER_OF_ALPHA_4_SLOT), + mload(PROOF_COPY_PERMUTATION_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT), + R_MOD + ) + + { + let gamma := mload(STATE_GAMMA_SLOT) + let beta := mload(STATE_BETA_SLOT) + + let factorMultiplier + { + // res *= sigma_0(z) * beta + gamma + a(z) + factorMultiplier := mulmod(mload(PROOF_COPY_PERMUTATION_POLYS_0_OPENING_AT_Z_SLOT), beta, R_MOD) + factorMultiplier := addmod(factorMultiplier, gamma, R_MOD) + factorMultiplier := addmod( + factorMultiplier, + mload(PROOF_STATE_POLYS_0_OPENING_AT_Z_SLOT), + R_MOD + ) + res := mulmod(res, factorMultiplier, R_MOD) + } + { + // res *= sigma_1(z) * beta + gamma + b(z) + factorMultiplier := mulmod(mload(PROOF_COPY_PERMUTATION_POLYS_1_OPENING_AT_Z_SLOT), beta, R_MOD) + factorMultiplier := addmod(factorMultiplier, gamma, R_MOD) + factorMultiplier := addmod( + factorMultiplier, + mload(PROOF_STATE_POLYS_1_OPENING_AT_Z_SLOT), + R_MOD + ) + res := mulmod(res, factorMultiplier, R_MOD) + } + { + // res *= sigma_2(z) * beta + gamma + c(z) + factorMultiplier := mulmod(mload(PROOF_COPY_PERMUTATION_POLYS_2_OPENING_AT_Z_SLOT), beta, R_MOD) + factorMultiplier := addmod(factorMultiplier, gamma, R_MOD) + factorMultiplier := addmod( + factorMultiplier, + mload(PROOF_STATE_POLYS_2_OPENING_AT_Z_SLOT), + R_MOD + ) + res := mulmod(res, factorMultiplier, R_MOD) + } + + // res *= sigma_3(z) + gamma + res := mulmod(res, addmod(mload(PROOF_STATE_POLYS_3_OPENING_AT_Z_SLOT), gamma, R_MOD), R_MOD) + } + + // res = -res + res := sub(R_MOD, res) + + // -= L_0(z) * alpha^5 + let l0AtZ := mload(STATE_L_0_AT_Z_SLOT) + l0AtZ := mulmod(l0AtZ, mload(STATE_POWER_OF_ALPHA_5_SLOT), R_MOD) + res := addmod(res, sub(R_MOD, l0AtZ), R_MOD) + } + + /// @notice Compute lookup contribution to linearisation polynomial's constant term + function lookupQuotientContribution() -> res { + let betaLookup := mload(STATE_BETA_LOOKUP_SLOT) + let gammaLookup := mload(STATE_GAMMA_LOOKUP_SLOT) + let betaPlusOne := addmod(betaLookup, 1, R_MOD) + let betaGamma := mulmod(betaPlusOne, gammaLookup, R_MOD) + + mstore(STATE_BETA_PLUS_ONE_SLOT, betaPlusOne) + mstore(STATE_BETA_GAMMA_PLUS_GAMMA_SLOT, betaGamma) + + // res = alpha^6 * (s(z*omega) * beta' + gamma' (beta' + 1)) * z_lookup(z*omega) + res := mulmod(mload(PROOF_LOOKUP_S_POLY_OPENING_AT_Z_OMEGA_SLOT), betaLookup, R_MOD) + res := addmod(res, betaGamma, R_MOD) + res := mulmod(res, mload(PROOF_LOOKUP_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT), R_MOD) + res := mulmod(res, mload(STATE_POWER_OF_ALPHA_6_SLOT), R_MOD) + + // res *= z - omega^{n-1} + { + let lastOmega := modexp(OMEGA, sub(DOMAIN_SIZE, 1)) + let zMinusLastOmega := addmod(mload(STATE_Z_SLOT), sub(R_MOD, lastOmega), R_MOD) + mstore(STATE_Z_MINUS_LAST_OMEGA_SLOT, zMinusLastOmega) + res := mulmod(res, zMinusLastOmega, R_MOD) + } + + // res -= alpha^7 * L_{0}(z) + { + let intermediateValue := mulmod( + mload(STATE_L_0_AT_Z_SLOT), + mload(STATE_POWER_OF_ALPHA_7_SLOT), + R_MOD + ) + res := addmod(res, sub(R_MOD, intermediateValue), R_MOD) + } + + // res -= alpha^8 * L_{n-1}(z) * (gamma' (beta' + 1))^{n-1} + { + let lnMinusOneAtZ := mload(STATE_L_N_MINUS_ONE_AT_Z_SLOT) + let betaGammaPowered := modexp(betaGamma, sub(DOMAIN_SIZE, 1)) + let alphaPower8 := mload(STATE_POWER_OF_ALPHA_8_SLOT) + + let subtrahend := mulmod(mulmod(lnMinusOneAtZ, betaGammaPowered, R_MOD), alphaPower8, R_MOD) + res := addmod(res, sub(R_MOD, subtrahend), R_MOD) + } + } + + /// @notice Compute main gate contribution to linearisation polynomial commitment multiplied by v + function mainGateLinearisationContributionWithV( + dest, + stateOpening0AtZ, + stateOpening1AtZ, + stateOpening2AtZ, + stateOpening3AtZ + ) { + // += a(z) * [q_a] + pointMulIntoDest(VK_GATE_SETUP_0_X_SLOT, stateOpening0AtZ, dest) + // += b(z) * [q_b] + pointMulAndAddIntoDest(VK_GATE_SETUP_1_X_SLOT, stateOpening1AtZ, dest) + // += c(z) * [q_c] + pointMulAndAddIntoDest(VK_GATE_SETUP_2_X_SLOT, stateOpening2AtZ, dest) + // += d(z) * [q_d] + pointMulAndAddIntoDest(VK_GATE_SETUP_3_X_SLOT, stateOpening3AtZ, dest) + // += a(z) * b(z) * [q_ab] + pointMulAndAddIntoDest(VK_GATE_SETUP_4_X_SLOT, mulmod(stateOpening0AtZ, stateOpening1AtZ, R_MOD), dest) + // += a(z) * c(z) * [q_ac] + pointMulAndAddIntoDest(VK_GATE_SETUP_5_X_SLOT, mulmod(stateOpening0AtZ, stateOpening2AtZ, R_MOD), dest) + // += [q_const] + pointAddAssign(dest, VK_GATE_SETUP_6_X_SLOT) + // += d(z*omega) * [q_{d_next}] + pointMulAndAddIntoDest(VK_GATE_SETUP_7_X_SLOT, mload(PROOF_STATE_POLYS_3_OPENING_AT_Z_OMEGA_SLOT), dest) + + // *= v * main_gate_selector(z) + let coeff := mulmod(mload(PROOF_GATE_SELECTORS_0_OPENING_AT_Z_SLOT), mload(STATE_V_SLOT), R_MOD) + pointMulIntoDest(dest, coeff, dest) + } + + /// @notice Compute custom gate contribution to linearisation polynomial commitment multiplied by v + function addAssignRescueCustomGateLinearisationContributionWithV( + dest, + stateOpening0AtZ, + stateOpening1AtZ, + stateOpening2AtZ, + stateOpening3AtZ + ) { + let accumulator + let intermediateValue + // = alpha * (a(z)^2 - b(z)) + accumulator := mulmod(stateOpening0AtZ, stateOpening0AtZ, R_MOD) + accumulator := addmod(accumulator, sub(R_MOD, stateOpening1AtZ), R_MOD) + accumulator := mulmod(accumulator, mload(STATE_ALPHA_SLOT), R_MOD) + // += alpha^2 * (b(z)^2 - c(z)) + intermediateValue := mulmod(stateOpening1AtZ, stateOpening1AtZ, R_MOD) + intermediateValue := addmod(intermediateValue, sub(R_MOD, stateOpening2AtZ), R_MOD) + intermediateValue := mulmod(intermediateValue, mload(STATE_POWER_OF_ALPHA_2_SLOT), R_MOD) + accumulator := addmod(accumulator, intermediateValue, R_MOD) + // += alpha^3 * (c(z) * a(z) - d(z)) + intermediateValue := mulmod(stateOpening2AtZ, stateOpening0AtZ, R_MOD) + intermediateValue := addmod(intermediateValue, sub(R_MOD, stateOpening3AtZ), R_MOD) + intermediateValue := mulmod(intermediateValue, mload(STATE_POWER_OF_ALPHA_3_SLOT), R_MOD) + accumulator := addmod(accumulator, intermediateValue, R_MOD) + + // *= v * [custom_gate_selector] + accumulator := mulmod(accumulator, mload(STATE_V_SLOT), R_MOD) + pointMulAndAddIntoDest(VK_GATE_SELECTORS_1_X_SLOT, accumulator, dest) + } + + /// @notice Compute copy-permutation contribution to linearisation polynomial commitment multiplied by v + function addAssignPermutationLinearisationContributionWithV( + dest, + stateOpening0AtZ, + stateOpening1AtZ, + stateOpening2AtZ, + stateOpening3AtZ + ) { + // alpha^4 + let factor := mload(STATE_POWER_OF_ALPHA_4_SLOT) + // Calculate the factor + { + // *= (a(z) + beta * z + gamma) + let zMulBeta := mulmod(mload(STATE_Z_SLOT), mload(STATE_BETA_SLOT), R_MOD) + let gamma := mload(STATE_GAMMA_SLOT) + + let intermediateValue := addmod(addmod(zMulBeta, gamma, R_MOD), stateOpening0AtZ, R_MOD) + factor := mulmod(factor, intermediateValue, R_MOD) + + // (b(z) + beta * z * k0 + gamma) + intermediateValue := addmod( + addmod(mulmod(zMulBeta, NON_RESIDUES_0, R_MOD), gamma, R_MOD), + stateOpening1AtZ, + R_MOD + ) + factor := mulmod(factor, intermediateValue, R_MOD) + + // (c(z) + beta * z * k1 + gamma) + intermediateValue := addmod( + addmod(mulmod(zMulBeta, NON_RESIDUES_1, R_MOD), gamma, R_MOD), + stateOpening2AtZ, + R_MOD + ) + factor := mulmod(factor, intermediateValue, R_MOD) + + // (d(z) + beta * z * k2 + gamma) + intermediateValue := addmod( + addmod(mulmod(zMulBeta, NON_RESIDUES_2, R_MOD), gamma, R_MOD), + stateOpening3AtZ, + R_MOD + ) + factor := mulmod(factor, intermediateValue, R_MOD) + } + + // += alpha^5 * L_0(z) + let l0AtZ := mload(STATE_L_0_AT_Z_SLOT) + factor := addmod(factor, mulmod(l0AtZ, mload(STATE_POWER_OF_ALPHA_5_SLOT), R_MOD), R_MOD) + + // Here we can optimize one scalar multiplication by aggregating coefficients near [z_perm] during + // computing [F] + // We will sum them and add and make one scalar multiplication: (coeff1 + coeff2) * [z_perm] + factor := mulmod(factor, mload(STATE_V_SLOT), R_MOD) + mstore(COPY_PERMUTATION_FIRST_AGGREGATED_COMMITMENT_COEFF, factor) + + // alpha^4 * beta * z_perm(z*omega) + factor := mulmod(mload(STATE_POWER_OF_ALPHA_4_SLOT), mload(STATE_BETA_SLOT), R_MOD) + factor := mulmod(factor, mload(PROOF_COPY_PERMUTATION_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT), R_MOD) + { + // *= (a(z) + beta * sigma_0(z) + gamma) + let beta := mload(STATE_BETA_SLOT) + let gamma := mload(STATE_GAMMA_SLOT) + + let intermediateValue := addmod( + addmod( + mulmod(mload(PROOF_COPY_PERMUTATION_POLYS_0_OPENING_AT_Z_SLOT), beta, R_MOD), + gamma, + R_MOD + ), + stateOpening0AtZ, + R_MOD + ) + factor := mulmod(factor, intermediateValue, R_MOD) + + // *= (b(z) + beta * sigma_1(z) + gamma) + intermediateValue := addmod( + addmod( + mulmod(mload(PROOF_COPY_PERMUTATION_POLYS_1_OPENING_AT_Z_SLOT), beta, R_MOD), + gamma, + R_MOD + ), + stateOpening1AtZ, + R_MOD + ) + factor := mulmod(factor, intermediateValue, R_MOD) + + // *= (c(z) + beta * sigma_2(z) + gamma) + intermediateValue := addmod( + addmod( + mulmod(mload(PROOF_COPY_PERMUTATION_POLYS_2_OPENING_AT_Z_SLOT), beta, R_MOD), + gamma, + R_MOD + ), + stateOpening2AtZ, + R_MOD + ) + factor := mulmod(factor, intermediateValue, R_MOD) + } + + // *= v * [sigma_3] + factor := mulmod(factor, mload(STATE_V_SLOT), R_MOD) + pointMulIntoDest(VK_PERMUTATION_3_X_SLOT, factor, QUERIES_BUFFER_POINT_SLOT) + + pointSubAssign(dest, QUERIES_BUFFER_POINT_SLOT) + } + + /// @notice Compute lookup contribution to linearisation polynomial commitment multiplied by v + function addAssignLookupLinearisationContributionWithV( + dest, + stateOpening0AtZ, + stateOpening1AtZ, + stateOpening2AtZ + ) { + // alpha^6 * v * z_lookup(z*omega) * (z - omega^{n-1}) * [s] + let factor := mload(PROOF_LOOKUP_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT) + factor := mulmod(factor, mload(STATE_POWER_OF_ALPHA_6_SLOT), R_MOD) + factor := mulmod(factor, mload(STATE_Z_MINUS_LAST_OMEGA_SLOT), R_MOD) + factor := mulmod(factor, mload(STATE_V_SLOT), R_MOD) + + // Here we can optimize one scalar multiplication by aggregating coefficients near [s] during + // computing [F] + // We will sum them and add and make one scalar multiplication: (coeff1 + coeff2) * [s] + mstore(LOOKUP_S_FIRST_AGGREGATED_COMMITMENT_COEFF, factor) + + // gamma(1 + beta) + t(x) + beta * t(x*omega) + factor := mload(PROOF_LOOKUP_T_POLY_OPENING_AT_Z_OMEGA_SLOT) + factor := mulmod(factor, mload(STATE_BETA_LOOKUP_SLOT), R_MOD) + factor := addmod(factor, mload(PROOF_LOOKUP_T_POLY_OPENING_AT_Z_SLOT), R_MOD) + factor := addmod(factor, mload(STATE_BETA_GAMMA_PLUS_GAMMA_SLOT), R_MOD) + + // *= (gamma + f(z)) + // We should use fact that f(x) = + // lookup_selector(x) * (a(x) + eta * b(x) + eta^2 * c(x) + eta^3 * table_type(x)) + // to restore f(z) + let fReconstructed + { + fReconstructed := stateOpening0AtZ + let eta := mload(STATE_ETA_SLOT) + let currentEta := eta + + fReconstructed := addmod(fReconstructed, mulmod(currentEta, stateOpening1AtZ, R_MOD), R_MOD) + currentEta := mulmod(currentEta, eta, R_MOD) + fReconstructed := addmod(fReconstructed, mulmod(currentEta, stateOpening2AtZ, R_MOD), R_MOD) + currentEta := mulmod(currentEta, eta, R_MOD) + + // add type of table + fReconstructed := addmod( + fReconstructed, + mulmod(mload(PROOF_LOOKUP_TABLE_TYPE_POLY_OPENING_AT_Z_SLOT), currentEta, R_MOD), + R_MOD + ) + fReconstructed := mulmod(fReconstructed, mload(PROOF_LOOKUP_SELECTOR_POLY_OPENING_AT_Z_SLOT), R_MOD) + fReconstructed := addmod(fReconstructed, mload(STATE_GAMMA_LOOKUP_SLOT), R_MOD) + } + // *= -alpha^6 * (beta + 1) * (z - omega^{n-1}) + factor := mulmod(factor, fReconstructed, R_MOD) + factor := mulmod(factor, mload(STATE_BETA_PLUS_ONE_SLOT), R_MOD) + factor := sub(R_MOD, factor) + factor := mulmod(factor, mload(STATE_POWER_OF_ALPHA_6_SLOT), R_MOD) + + factor := mulmod(factor, mload(STATE_Z_MINUS_LAST_OMEGA_SLOT), R_MOD) + + // += alpha^7 * L_0(z) + factor := addmod( + factor, + mulmod(mload(STATE_L_0_AT_Z_SLOT), mload(STATE_POWER_OF_ALPHA_7_SLOT), R_MOD), + R_MOD + ) + + // += alpha^8 * L_{n-1}(z) + factor := addmod( + factor, + mulmod(mload(STATE_L_N_MINUS_ONE_AT_Z_SLOT), mload(STATE_POWER_OF_ALPHA_8_SLOT), R_MOD), + R_MOD + ) + + // Here we can optimize one scalar multiplication by aggregating coefficients near [z_lookup] during + // computing [F] + // We will sum them and add and make one scalar multiplication: (coeff1 + coeff2) * [z_lookup] + factor := mulmod(factor, mload(STATE_V_SLOT), R_MOD) + mstore(LOOKUP_GRAND_PRODUCT_FIRST_AGGREGATED_COMMITMENT_COEFF, factor) + } + + /*////////////////////////////////////////////////////////////// + 4. Prepare queries + //////////////////////////////////////////////////////////////*/ + + /// @dev Here we compute the first and second parts of batched polynomial commitment + /// We use the formula: + /// [D0] = [t_0] + z^n * [t_1] + z^{2n} * [t_2] + z^{3n} * [t_3] + /// and + /// [D1] = main_gate_selector(z) * ( \ + /// a(z) * [q_a] + b(z) * [q_b] + c(z) * [q_c] + d(z) * [q_d] + | - main gate contribution + /// a(z) * b(z) * [q_ab] + a(z) * c(z) * [q_ac] + | + /// [q_const] + d(z*omega) * [q_{d_next}]) / + /// + /// + alpha * [custom_gate_selector] * ( \ + /// (a(z)^2 - b(z)) + | - custom gate contribution + /// (b(z)^2 - c(z)) * alpha + | + /// (a(z)*c(z) - d(z)) * alpha^2 ) / + /// + /// + alpha^4 * [z_perm] * \ + /// (a(z) + beta * z + gamma) * | + /// (b(z) + beta * z * k0 + gamma) * | + /// (c(z) + beta * z * k1 + gamma) * | + /// (d(z) + beta * z * k2 + gamma) | - permutation contribution + /// - alpha^4 * z_perm(z*omega) * beta * [sigma_3] * | + /// (a(z) + beta * sigma_0(z) + gamma) * | + /// (b(z) + beta * sigma_1(z) + gamma) * | + /// (c(z) + beta * sigma_2(z) + gamma) * | + /// + alpha^5 * L_0(z) * [z_perm] / + /// + /// - alpha^6 * (1 + beta') * (gamma' + f(z)) * (z - omega^{n-1}) * \ + /// (gamma'(1 + beta') + t(z) + beta' * t(z*omega)) * [z_lookup] | + /// + alpha^6 * z_lookup(z*omega) * (z - omega^{n-1}) * [s] | - lookup contribution + /// + alpha^7 * L_0(z) * [z_lookup] | + /// + alpha^8 * L_{n-1}(z) * [z_lookup] / + function prepareQueries() { + // Calculate [D0] + { + let zInDomainSize := mload(STATE_Z_IN_DOMAIN_SIZE) + let currentZ := zInDomainSize + + mstore(QUERIES_AT_Z_0_X_SLOT, mload(PROOF_QUOTIENT_POLY_PARTS_0_X_SLOT)) + mstore(QUERIES_AT_Z_0_Y_SLOT, mload(PROOF_QUOTIENT_POLY_PARTS_0_Y_SLOT)) + + pointMulAndAddIntoDest(PROOF_QUOTIENT_POLY_PARTS_1_X_SLOT, currentZ, QUERIES_AT_Z_0_X_SLOT) + currentZ := mulmod(currentZ, zInDomainSize, R_MOD) + + pointMulAndAddIntoDest(PROOF_QUOTIENT_POLY_PARTS_2_X_SLOT, currentZ, QUERIES_AT_Z_0_X_SLOT) + currentZ := mulmod(currentZ, zInDomainSize, R_MOD) + + pointMulAndAddIntoDest(PROOF_QUOTIENT_POLY_PARTS_3_X_SLOT, currentZ, QUERIES_AT_Z_0_X_SLOT) + } + + // Calculate v * [D1] + // We are going to multiply all the points in the sum by v to save + // one scalar multiplication during [F] computation + { + let stateOpening0AtZ := mload(PROOF_STATE_POLYS_0_OPENING_AT_Z_SLOT) + let stateOpening1AtZ := mload(PROOF_STATE_POLYS_1_OPENING_AT_Z_SLOT) + let stateOpening2AtZ := mload(PROOF_STATE_POLYS_2_OPENING_AT_Z_SLOT) + let stateOpening3AtZ := mload(PROOF_STATE_POLYS_3_OPENING_AT_Z_SLOT) + + mainGateLinearisationContributionWithV( + QUERIES_AT_Z_1_X_SLOT, + stateOpening0AtZ, + stateOpening1AtZ, + stateOpening2AtZ, + stateOpening3AtZ + ) + + addAssignRescueCustomGateLinearisationContributionWithV( + QUERIES_AT_Z_1_X_SLOT, + stateOpening0AtZ, + stateOpening1AtZ, + stateOpening2AtZ, + stateOpening3AtZ + ) + + addAssignPermutationLinearisationContributionWithV( + QUERIES_AT_Z_1_X_SLOT, + stateOpening0AtZ, + stateOpening1AtZ, + stateOpening2AtZ, + stateOpening3AtZ + ) + + addAssignLookupLinearisationContributionWithV( + QUERIES_AT_Z_1_X_SLOT, + stateOpening0AtZ, + stateOpening1AtZ, + stateOpening2AtZ + ) + } + + // Also we should restore [t] for future computations + // [t] = [col_0] + eta*[col_1] + eta^2*[col_2] + eta^3*[col_3] + { + mstore(QUERIES_T_POLY_AGGREGATED_X_SLOT, mload(VK_LOOKUP_TABLE_0_X_SLOT)) + mstore(QUERIES_T_POLY_AGGREGATED_Y_SLOT, mload(VK_LOOKUP_TABLE_0_Y_SLOT)) + + let eta := mload(STATE_ETA_SLOT) + let currentEta := eta + + pointMulAndAddIntoDest(VK_LOOKUP_TABLE_1_X_SLOT, currentEta, QUERIES_T_POLY_AGGREGATED_X_SLOT) + currentEta := mulmod(currentEta, eta, R_MOD) + + pointMulAndAddIntoDest(VK_LOOKUP_TABLE_2_X_SLOT, currentEta, QUERIES_T_POLY_AGGREGATED_X_SLOT) + currentEta := mulmod(currentEta, eta, R_MOD) + + pointMulAndAddIntoDest(VK_LOOKUP_TABLE_3_X_SLOT, currentEta, QUERIES_T_POLY_AGGREGATED_X_SLOT) + } + } + + /*////////////////////////////////////////////////////////////// + 5. Prepare aggregated commitment + //////////////////////////////////////////////////////////////*/ + + /// @dev Here we compute aggregated commitment for the final pairing + /// We use the formula: + /// [E] = ( t(z) + v * r(z) + /// + v^2*a(z) + v^3*b(z) + v^4*c(z) + v^5*d(z) + /// + v^6*main_gate_selector(z) + /// + v^7*sigma_0(z) + v^8*sigma_1(z) + v^9*sigma_2(z) + /// + v^10*t(z) + v^11*lookup_selector(z) + v^12*table_type(z) + /// + u * (v^13*z_perm(z*omega) + v^14*d(z*omega) + /// + v^15*s(z*omega) + v^16*z_lookup(z*omega) + v^17*t(z*omega) + /// ) + /// ) * [1] + /// and + /// [F] = [D0] + v * [D1] + /// + v^2*[a] + v^3*[b] + v^4*[c] + v^5*[d] + /// + v^6*[main_gate_selector] + /// + v^7*[sigma_0] + v^8*[sigma_1] + v^9*[sigma_2] + /// + v^10*[t] + v^11*[lookup_selector] + v^12*[table_type] + /// + u * ( v^13*[z_perm] + v^14*[d] + /// + v^15*[s] + v^16*[z_lookup] + v^17*[t] + /// ) + function prepareAggregatedCommitment() { + // Here we compute parts of [E] and [F] without u multiplier + let aggregationChallenge := 1 + let firstDCoeff + let firstTCoeff + + mstore(AGGREGATED_AT_Z_X_SLOT, mload(QUERIES_AT_Z_0_X_SLOT)) + mstore(AGGREGATED_AT_Z_Y_SLOT, mload(QUERIES_AT_Z_0_Y_SLOT)) + let aggregatedOpeningAtZ := mload(PROOF_QUOTIENT_POLY_OPENING_AT_Z_SLOT) + { + function updateAggregationChallenge( + queriesCommitmentPoint, + valueAtZ, + curAggregationChallenge, + curAggregatedOpeningAtZ + ) -> newAggregationChallenge, newAggregatedOpeningAtZ { + newAggregationChallenge := mulmod(curAggregationChallenge, mload(STATE_V_SLOT), R_MOD) + pointMulAndAddIntoDest(queriesCommitmentPoint, newAggregationChallenge, AGGREGATED_AT_Z_X_SLOT) + newAggregatedOpeningAtZ := addmod( + curAggregatedOpeningAtZ, + mulmod(newAggregationChallenge, mload(valueAtZ), R_MOD), + R_MOD + ) + } + + // We don't need to multiply by v, because we have already computed v * [D1] + pointAddIntoDest(AGGREGATED_AT_Z_X_SLOT, QUERIES_AT_Z_1_X_SLOT, AGGREGATED_AT_Z_X_SLOT) + aggregationChallenge := mulmod(aggregationChallenge, mload(STATE_V_SLOT), R_MOD) + aggregatedOpeningAtZ := addmod( + aggregatedOpeningAtZ, + mulmod(aggregationChallenge, mload(PROOF_LINEARISATION_POLY_OPENING_AT_Z_SLOT), R_MOD), + R_MOD + ) + + aggregationChallenge, aggregatedOpeningAtZ := updateAggregationChallenge( + PROOF_STATE_POLYS_0_X_SLOT, + PROOF_STATE_POLYS_0_OPENING_AT_Z_SLOT, + aggregationChallenge, + aggregatedOpeningAtZ + ) + aggregationChallenge, aggregatedOpeningAtZ := updateAggregationChallenge( + PROOF_STATE_POLYS_1_X_SLOT, + PROOF_STATE_POLYS_1_OPENING_AT_Z_SLOT, + aggregationChallenge, + aggregatedOpeningAtZ + ) + aggregationChallenge, aggregatedOpeningAtZ := updateAggregationChallenge( + PROOF_STATE_POLYS_2_X_SLOT, + PROOF_STATE_POLYS_2_OPENING_AT_Z_SLOT, + aggregationChallenge, + aggregatedOpeningAtZ + ) + + // Here we can optimize one scalar multiplication by aggregating coefficients near [d] + // We will sum them and add and make one scalar multiplication: (coeff1 + coeff2) * [d] + aggregationChallenge := mulmod(aggregationChallenge, mload(STATE_V_SLOT), R_MOD) + firstDCoeff := aggregationChallenge + aggregatedOpeningAtZ := addmod( + aggregatedOpeningAtZ, + mulmod(aggregationChallenge, mload(PROOF_STATE_POLYS_3_OPENING_AT_Z_SLOT), R_MOD), + R_MOD + ) + + aggregationChallenge, aggregatedOpeningAtZ := updateAggregationChallenge( + VK_GATE_SELECTORS_0_X_SLOT, + PROOF_GATE_SELECTORS_0_OPENING_AT_Z_SLOT, + aggregationChallenge, + aggregatedOpeningAtZ + ) + aggregationChallenge, aggregatedOpeningAtZ := updateAggregationChallenge( + VK_PERMUTATION_0_X_SLOT, + PROOF_COPY_PERMUTATION_POLYS_0_OPENING_AT_Z_SLOT, + aggregationChallenge, + aggregatedOpeningAtZ + ) + aggregationChallenge, aggregatedOpeningAtZ := updateAggregationChallenge( + VK_PERMUTATION_1_X_SLOT, + PROOF_COPY_PERMUTATION_POLYS_1_OPENING_AT_Z_SLOT, + aggregationChallenge, + aggregatedOpeningAtZ + ) + aggregationChallenge, aggregatedOpeningAtZ := updateAggregationChallenge( + VK_PERMUTATION_2_X_SLOT, + PROOF_COPY_PERMUTATION_POLYS_2_OPENING_AT_Z_SLOT, + aggregationChallenge, + aggregatedOpeningAtZ + ) + + // Here we can optimize one scalar multiplication by aggregating coefficients near [t] + // We will sum them and add and make one scalar multiplication: (coeff1 + coeff2) * [t] + aggregationChallenge := mulmod(aggregationChallenge, mload(STATE_V_SLOT), R_MOD) + firstTCoeff := aggregationChallenge + aggregatedOpeningAtZ := addmod( + aggregatedOpeningAtZ, + mulmod(aggregationChallenge, mload(PROOF_LOOKUP_T_POLY_OPENING_AT_Z_SLOT), R_MOD), + R_MOD + ) + + aggregationChallenge, aggregatedOpeningAtZ := updateAggregationChallenge( + VK_LOOKUP_SELECTOR_X_SLOT, + PROOF_LOOKUP_SELECTOR_POLY_OPENING_AT_Z_SLOT, + aggregationChallenge, + aggregatedOpeningAtZ + ) + aggregationChallenge, aggregatedOpeningAtZ := updateAggregationChallenge( + VK_LOOKUP_TABLE_TYPE_X_SLOT, + PROOF_LOOKUP_TABLE_TYPE_POLY_OPENING_AT_Z_SLOT, + aggregationChallenge, + aggregatedOpeningAtZ + ) + } + mstore(AGGREGATED_OPENING_AT_Z_SLOT, aggregatedOpeningAtZ) + + // Here we compute parts of [E] and [F] with u multiplier + aggregationChallenge := mulmod(aggregationChallenge, mload(STATE_V_SLOT), R_MOD) + + let copyPermutationCoeff := addmod( + mload(COPY_PERMUTATION_FIRST_AGGREGATED_COMMITMENT_COEFF), + mulmod(aggregationChallenge, mload(STATE_U_SLOT), R_MOD), + R_MOD + ) + + pointMulIntoDest( + PROOF_COPY_PERMUTATION_GRAND_PRODUCT_X_SLOT, + copyPermutationCoeff, + AGGREGATED_AT_Z_OMEGA_X_SLOT + ) + let aggregatedOpeningAtZOmega := mulmod( + mload(PROOF_COPY_PERMUTATION_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT), + aggregationChallenge, + R_MOD + ) + + { + function updateAggregationChallenge( + queriesCommitmentPoint, + valueAtZ_Omega, + previousCoeff, + curAggregationChallenge, + curAggregatedOpeningAtZ_Omega + ) -> newAggregationChallenge, newAggregatedOpeningAtZ_Omega { + newAggregationChallenge := mulmod(curAggregationChallenge, mload(STATE_V_SLOT), R_MOD) + let finalCoeff := addmod( + previousCoeff, + mulmod(newAggregationChallenge, mload(STATE_U_SLOT), R_MOD), + R_MOD + ) + pointMulAndAddIntoDest(queriesCommitmentPoint, finalCoeff, AGGREGATED_AT_Z_OMEGA_X_SLOT) + newAggregatedOpeningAtZ_Omega := addmod( + curAggregatedOpeningAtZ_Omega, + mulmod(newAggregationChallenge, mload(valueAtZ_Omega), R_MOD), + R_MOD + ) + } + + aggregationChallenge, aggregatedOpeningAtZOmega := updateAggregationChallenge( + PROOF_STATE_POLYS_3_X_SLOT, + PROOF_STATE_POLYS_3_OPENING_AT_Z_OMEGA_SLOT, + firstDCoeff, + aggregationChallenge, + aggregatedOpeningAtZOmega + ) + aggregationChallenge, aggregatedOpeningAtZOmega := updateAggregationChallenge( + PROOF_LOOKUP_S_POLY_X_SLOT, + PROOF_LOOKUP_S_POLY_OPENING_AT_Z_OMEGA_SLOT, + mload(LOOKUP_S_FIRST_AGGREGATED_COMMITMENT_COEFF), + aggregationChallenge, + aggregatedOpeningAtZOmega + ) + aggregationChallenge, aggregatedOpeningAtZOmega := updateAggregationChallenge( + PROOF_LOOKUP_GRAND_PRODUCT_X_SLOT, + PROOF_LOOKUP_GRAND_PRODUCT_OPENING_AT_Z_OMEGA_SLOT, + mload(LOOKUP_GRAND_PRODUCT_FIRST_AGGREGATED_COMMITMENT_COEFF), + aggregationChallenge, + aggregatedOpeningAtZOmega + ) + aggregationChallenge, aggregatedOpeningAtZOmega := updateAggregationChallenge( + QUERIES_T_POLY_AGGREGATED_X_SLOT, + PROOF_LOOKUP_T_POLY_OPENING_AT_Z_OMEGA_SLOT, + firstTCoeff, + aggregationChallenge, + aggregatedOpeningAtZOmega + ) + } + mstore(AGGREGATED_OPENING_AT_Z_OMEGA_SLOT, aggregatedOpeningAtZOmega) + + // Now we can merge both parts and get [E] and [F] + let u := mload(STATE_U_SLOT) + + // [F] + pointAddIntoDest( + AGGREGATED_AT_Z_X_SLOT, + AGGREGATED_AT_Z_OMEGA_X_SLOT, + PAIRING_PAIR_WITH_GENERATOR_X_SLOT + ) + + // [E] = (aggregatedOpeningAtZ + u * aggregatedOpeningAtZOmega) * [1] + let aggregatedValue := addmod( + mulmod(mload(AGGREGATED_OPENING_AT_Z_OMEGA_SLOT), u, R_MOD), + mload(AGGREGATED_OPENING_AT_Z_SLOT), + R_MOD + ) + + mstore(PAIRING_BUFFER_POINT_X_SLOT, 1) + mstore(PAIRING_BUFFER_POINT_Y_SLOT, 2) + pointMulIntoDest(PAIRING_BUFFER_POINT_X_SLOT, aggregatedValue, PAIRING_BUFFER_POINT_X_SLOT) + } + + /*////////////////////////////////////////////////////////////// + 5. Pairing + //////////////////////////////////////////////////////////////*/ + + /// @notice Checks the final pairing + /// @dev We should check the equation: + /// e([W] + u * [W'], [x]_2) = e(z * [W] + u * z * omega * [W'] + [F] - [E], [1]_2), + /// where [F] and [E] were computed previously + /// + /// Also we need to check that e([P1], [x]_2) = e([P2], [1]_2) + /// if we have the recursive part of the proof + /// where [P1] and [P2] are parts of the recursive proof + /// + /// We can aggregate both pairings into one for gas optimization: + /// e([W] + u * [W'] + u^2 * [P1], [x]_2) = + /// e(z * [W] + u * z * omega * [W'] + [F] - [E] + u^2 * [P2], [1]_2) + /// + /// u is a valid challenge for such aggregation, + /// because [P1] and [P2] are used in PI + function finalPairing() { + let u := mload(STATE_U_SLOT) + let z := mload(STATE_Z_SLOT) + let zOmega := mulmod(mload(STATE_Z_SLOT), OMEGA, R_MOD) + + // [F] - [E] + pointSubAssign(PAIRING_PAIR_WITH_GENERATOR_X_SLOT, PAIRING_BUFFER_POINT_X_SLOT) + + // +z * [W] + u * z * omega * [W'] + pointMulAndAddIntoDest(PROOF_OPENING_PROOF_AT_Z_X_SLOT, z, PAIRING_PAIR_WITH_GENERATOR_X_SLOT) + pointMulAndAddIntoDest( + PROOF_OPENING_PROOF_AT_Z_OMEGA_X_SLOT, + mulmod(zOmega, u, R_MOD), + PAIRING_PAIR_WITH_GENERATOR_X_SLOT + ) + + // [W] + u * [W'] + mstore(PAIRING_PAIR_WITH_X_X_SLOT, mload(PROOF_OPENING_PROOF_AT_Z_X_SLOT)) + mstore(PAIRING_PAIR_WITH_X_Y_SLOT, mload(PROOF_OPENING_PROOF_AT_Z_Y_SLOT)) + pointMulAndAddIntoDest(PROOF_OPENING_PROOF_AT_Z_OMEGA_X_SLOT, u, PAIRING_PAIR_WITH_X_X_SLOT) + pointNegate(PAIRING_PAIR_WITH_X_X_SLOT) + + // Add recursive proof part if needed + if mload(VK_RECURSIVE_FLAG_SLOT) { + let uu := mulmod(u, u, R_MOD) + pointMulAndAddIntoDest(PROOF_RECURSIVE_PART_P1_X_SLOT, uu, PAIRING_PAIR_WITH_GENERATOR_X_SLOT) + pointMulAndAddIntoDest(PROOF_RECURSIVE_PART_P2_X_SLOT, uu, PAIRING_PAIR_WITH_X_X_SLOT) + } + + // Calculate pairing + { + mstore(0x000, mload(PAIRING_PAIR_WITH_GENERATOR_X_SLOT)) + mstore(0x020, mload(PAIRING_PAIR_WITH_GENERATOR_Y_SLOT)) + + mstore(0x040, G2_ELEMENTS_0_X1) + mstore(0x060, G2_ELEMENTS_0_X2) + mstore(0x080, G2_ELEMENTS_0_Y1) + mstore(0x0a0, G2_ELEMENTS_0_Y2) + + mstore(0x0c0, mload(PAIRING_PAIR_WITH_X_X_SLOT)) + mstore(0x0e0, mload(PAIRING_PAIR_WITH_X_Y_SLOT)) + + mstore(0x100, G2_ELEMENTS_1_X1) + mstore(0x120, G2_ELEMENTS_1_X2) + mstore(0x140, G2_ELEMENTS_1_Y1) + mstore(0x160, G2_ELEMENTS_1_Y2) + + let success := staticcall(gas(), 8, 0, 0x180, 0x00, 0x20) + if iszero(success) { + revertWithMessage(32, "finalPairing: precompile failure") + } + if iszero(mload(0)) { + revertWithMessage(29, "finalPairing: pairing failure") + } + } + } + + /*////////////////////////////////////////////////////////////// + Verification + //////////////////////////////////////////////////////////////*/ + + // Step 1: Load the proof and check the correctness of its parts + loadProof() + + // Step 2: Recompute all the challenges with the transcript + initializeTranscript() + + // Step 3: Check the quotient equality + verifyQuotientEvaluation() + + // Step 4: Compute queries [D0] and v * [D1] + prepareQueries() + + // Step 5: Compute [E] and [F] + prepareAggregatedCommitment() + + // Step 6: Check the final pairing with aggregated recursive proof + finalPairing() + + mstore(0, true) + return(0, 32) + } + } +} diff --git a/l2-contracts/contracts/verifier/chain-interfaces/IVerifier.sol b/l2-contracts/contracts/verifier/chain-interfaces/IVerifier.sol new file mode 100644 index 000000000..fe5e2af2c --- /dev/null +++ b/l2-contracts/contracts/verifier/chain-interfaces/IVerifier.sol @@ -0,0 +1,24 @@ +// SPDX-License-Identifier: MIT +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. +pragma solidity ^0.8.21; + +/// @notice Part of the configuration parameters of ZKP circuits +struct VerifierParams { + bytes32 recursionNodeLevelVkHash; + bytes32 recursionLeafLevelVkHash; + bytes32 recursionCircuitsSetVksHash; +} + +/// @title The interface of the Verifier contract, responsible for the zero knowledge proof verification. +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IVerifier { + /// @dev Verifies a zk-SNARK proof. + /// @return A boolean value indicating whether the zk-SNARK proof is valid. + /// Note: The function may revert execution instead of returning false in some cases. + function verify(uint256[] calldata _publicInputs, uint256[] calldata _proof) external view returns (bool); + + /// @notice Calculates a keccak256 hash of the runtime loaded verification keys. + /// @return vkHash The keccak256 hash of the loaded verification keys. + function verificationKeyHash() external pure returns (bytes32); +} diff --git a/l2-contracts/foundry.toml b/l2-contracts/foundry.toml index deb178a12..b369e211f 100644 --- a/l2-contracts/foundry.toml +++ b/l2-contracts/foundry.toml @@ -2,12 +2,26 @@ src = "contracts" out = "out" libs = ["lib"] +test = "test/foundry" +solc_version = "0.8.24" cache_path = "cache-forge" +via_ir = true evm_version = "paris" +ignored_error_codes = ["missing-receive-ether", "code-size"] +ignored_warnings_from = ["test", "contracts/dev-contracts"] remappings = [ + "forge-std/=lib/forge-std/src/", + "foundry-test/=test/foundry/", "@openzeppelin/contracts-v4/=lib/openzeppelin-contracts-v4/contracts/", "@openzeppelin/contracts-upgradeable-v4/=lib/openzeppelin-contracts-upgradeable-v4/contracts/", + "@matterlabs/zksync-contracts/=lib/@matterlabs/zksync-contracts/", +] +fs_permissions = [ + { access = "read", path = "zkout" }, + { access = "read", path = "../system-contracts/bootloader/build/artifacts" }, + { access = "read", path = "../system-contracts/artifacts-zk/contracts-preprocessed" } ] -[profile.default.zksync] -zksolc = "1.5.0" +[profile.default.zksync] +enable_eravm_extensions = true +zksolc = "1.5.3" diff --git a/l2-contracts/hardhat.config.ts b/l2-contracts/hardhat.config.ts index 282ab7b96..235930123 100644 --- a/l2-contracts/hardhat.config.ts +++ b/l2-contracts/hardhat.config.ts @@ -12,7 +12,7 @@ if (!process.env.CHAIN_ETH_NETWORK) { export default { zksolc: { - version: "1.5.0", + version: "1.5.3", compilerSource: "binary", settings: { isSystem: true, diff --git a/l2-contracts/lib/@matterlabs b/l2-contracts/lib/@matterlabs new file mode 120000 index 000000000..beffd09fc --- /dev/null +++ b/l2-contracts/lib/@matterlabs @@ -0,0 +1 @@ +../../lib/@matterlabs \ No newline at end of file diff --git a/l2-contracts/package.json b/l2-contracts/package.json index c34057e81..3c871ee3b 100644 --- a/l2-contracts/package.json +++ b/l2-contracts/package.json @@ -33,6 +33,7 @@ }, "scripts": { "build": "hardhat compile", + "test:foundry": "forge test --zksync --gas-limit 2000000000", "clean": "hardhat clean", "test": "hardhat test", "verify": "hardhat run src/verify.ts", @@ -44,7 +45,8 @@ "deploy-l2-weth": "ts-node src/deploy-l2-weth.ts", "upgrade-bridge-contracts": "ts-node src/upgrade-bridge-impl.ts", "update-l2-erc20-metadata": "ts-node src/update-l2-erc20-metadata.ts", - "upgrade-consistency-checker": "ts-node src/upgrade-consistency-checker.ts" + "upgrade-consistency-checker": "ts-node src/upgrade-consistency-checker.ts", + "deploy-consensus-registry": "ts-node src/deploy-consensus-registry.ts" }, "dependencies": { "dotenv": "^16.0.3" diff --git a/l2-contracts/src/deploy-consensus-registry.ts b/l2-contracts/src/deploy-consensus-registry.ts new file mode 100644 index 000000000..ffbf903f9 --- /dev/null +++ b/l2-contracts/src/deploy-consensus-registry.ts @@ -0,0 +1,90 @@ +import { Command } from "commander"; +import { ethers } from "ethers"; +import { computeL2Create2Address, create2DeployFromL2 } from "./utils"; +import { Interface } from "ethers/lib/utils"; +import { ethTestConfig } from "./deploy-utils"; + +import * as hre from "hardhat"; +import { Provider, Wallet } from "zksync-ethers"; + +const I_TRANSPARENT_UPGRADEABLE_PROXY_ARTIFACT = hre.artifacts.readArtifactSync("ITransparentUpgradeableProxy"); +const TRANSPARENT_UPGRADEABLE_PROXY_ARTIFACT = hre.artifacts.readArtifactSync("TransparentUpgradeableProxy"); +const CONSENSUS_REGISTRY_ARTIFACT = hre.artifacts.readArtifactSync("ConsensusRegistry"); +const PROXY_ADMIN_ARTIFACT = hre.artifacts.readArtifactSync("ConsensusRegistry"); + +const CONSENSUS_REGISTRY_INTERFACE = new Interface(CONSENSUS_REGISTRY_ARTIFACT.abi); +const I_TRANSPARENT_UPGRADEABLE_PROXY_INTERFACE = new Interface(I_TRANSPARENT_UPGRADEABLE_PROXY_ARTIFACT.abi); + +// Script to deploy the consensus registry contract and output its address. +// Note, that this script expects that the L2 contracts have been compiled PRIOR +// to running this script. +async function main() { + const program = new Command(); + + program + .version("0.1.0") + .name("deploy-consensus-registry") + .description("Deploys the consensus registry contract to L2"); + + program.option("--private-key ").action(async (cmd) => { + const zksProvider = new Provider(process.env.API_WEB3_JSON_RPC_HTTP_URL); + const deployWallet = cmd.privateKey + ? new Wallet(cmd.privateKey, zksProvider) + : Wallet.fromMnemonic( + process.env.MNEMONIC ? process.env.MNEMONIC : ethTestConfig.mnemonic, + "m/44'/60'/0'/0/1" + ).connect(zksProvider); + console.log(`Using deployer wallet: ${deployWallet.address}`); + + // Deploy Consensus Registry contract + const consensusRegistryImplementation = await computeL2Create2Address( + deployWallet, + CONSENSUS_REGISTRY_ARTIFACT.bytecode, + "0x", + ethers.constants.HashZero + ); + await create2DeployFromL2(deployWallet, CONSENSUS_REGISTRY_ARTIFACT.bytecode, "0x", ethers.constants.HashZero); + + // Deploy Proxy Admin contract + const proxyAdminContract = await computeL2Create2Address( + deployWallet, + PROXY_ADMIN_ARTIFACT.bytecode, + "0x", + ethers.constants.HashZero + ); + await create2DeployFromL2(deployWallet, PROXY_ADMIN_ARTIFACT.bytecode, "0x", ethers.constants.HashZero); + + const proxyInitializationParams = CONSENSUS_REGISTRY_INTERFACE.encodeFunctionData("initialize", [ + deployWallet.address, + ]); + const proxyConstructor = I_TRANSPARENT_UPGRADEABLE_PROXY_INTERFACE.encodeDeploy([ + consensusRegistryImplementation, + proxyAdminContract, + proxyInitializationParams, + ]); + + await create2DeployFromL2( + deployWallet, + TRANSPARENT_UPGRADEABLE_PROXY_ARTIFACT.bytecode, + proxyConstructor, + ethers.constants.HashZero + ); + + const address = computeL2Create2Address( + deployWallet, + TRANSPARENT_UPGRADEABLE_PROXY_ARTIFACT.bytecode, + proxyConstructor, + ethers.constants.HashZero + ); + console.log(`CONTRACTS_L2_CONSENSUS_REGISTRY_ADDR=${address}`); + }); + + await program.parseAsync(process.argv); +} + +main() + .then(() => process.exit(0)) + .catch((err) => { + console.error("Error:", err); + process.exit(1); + }); diff --git a/l2-contracts/src/deploy-shared-bridge-on-l2-through-l1.ts b/l2-contracts/src/deploy-shared-bridge-on-l2-through-l1.ts deleted file mode 100644 index 6a98f7142..000000000 --- a/l2-contracts/src/deploy-shared-bridge-on-l2-through-l1.ts +++ /dev/null @@ -1,312 +0,0 @@ -import { Command } from "commander"; -import type { BigNumberish } from "ethers"; -import { Wallet, ethers } from "ethers"; -import { formatUnits, parseUnits } from "ethers/lib/utils"; -import { provider, publishBytecodeFromL1, priorityTxMaxGasLimit } from "./utils"; - -import { ethTestConfig } from "./deploy-utils"; - -import { Deployer } from "../../l1-contracts/src.ts/deploy"; -import { GAS_MULTIPLIER } from "../../l1-contracts/scripts/utils"; -import * as hre from "hardhat"; -import { - ADDRESS_ONE, - L2_ASSET_ROUTER_ADDRESS, - L2_BRIDGEHUB_ADDRESS, - L2_MESSAGE_ROOT_ADDRESS, - L2_NATIVE_TOKEN_VAULT_ADDRESS, -} from "../../l1-contracts/src.ts/utils"; - -import { L2NativeTokenVaultFactory } from "../typechain"; -import { BridgehubFactory } from "../../l1-contracts/typechain"; - -export const L2_SHARED_BRIDGE_ABI = hre.artifacts.readArtifactSync("L2SharedBridge").abi; -export const L2_STANDARD_TOKEN_PROXY_BYTECODE = hre.artifacts.readArtifactSync("BeaconProxy").bytecode; - -export async function publishL2NativeTokenVaultDependencyBytecodesOnL2( - deployer: Deployer, - chainId: string, - gasPrice: BigNumberish -) { - if (deployer.verbose) { - console.log("Providing necessary L2 bytecodes"); - } - - const L2_STANDARD_ERC20_PROXY_FACTORY_BYTECODE = hre.artifacts.readArtifactSync("UpgradeableBeacon").bytecode; - const L2_STANDARD_ERC20_IMPLEMENTATION_BYTECODE = hre.artifacts.readArtifactSync("L2StandardERC20").bytecode; - -<<<<<<< HEAD - const receipt = await ( - await publishBytecodeFromL1( -======= - await publishBytecodeFromL1( - chainId, - deployer.deployWallet, - [ - L2_STANDARD_ERC20_PROXY_FACTORY_BYTECODE, - L2_STANDARD_ERC20_IMPLEMENTATION_BYTECODE, - L2_STANDARD_TOKEN_PROXY_BYTECODE, - ], - gasPrice - ); - - if (deployer.verbose) { - console.log("Bytecodes published on L2"); - } -} - -export async function deploySharedBridgeImplOnL2ThroughL1( - deployer: Deployer, - chainId: string, - gasPrice: BigNumberish, - localLegacyBridgeTesting: boolean = false -) { - if (deployer.verbose) { - console.log("Deploying L2SharedBridge Implementation"); - } - const eraChainId = process.env.CONTRACTS_ERA_CHAIN_ID; - - const l2SharedBridgeImplementationBytecode = localLegacyBridgeTesting - ? hre.artifacts.readArtifactSync("DevL2SharedBridge").bytecode - : hre.artifacts.readArtifactSync("L2SharedBridge").bytecode; - - if (!l2SharedBridgeImplementationBytecode) { - throw new Error("l2SharedBridgeImplementationBytecode not found"); - } - if (deployer.verbose) { - console.log("l2SharedBridgeImplementationBytecode loaded"); - - console.log("Computing L2SharedBridge Implementation Address"); - } - const l2SharedBridgeImplAddress = computeL2Create2Address( - deployer.deployWallet, - l2SharedBridgeImplementationBytecode, - defaultAbiCoder.encode(["uint256"], [eraChainId]), - ethers.constants.HashZero - ); - deployer.addresses.Bridges.L2SharedBridgeImplementation = l2SharedBridgeImplAddress; - if (deployer.verbose) { - console.log(`L2SharedBridge Implementation Address: ${l2SharedBridgeImplAddress}`); - - console.log("Deploying L2SharedBridge Implementation"); - } - - /// L2StandardTokenProxy bytecode. We need this bytecode to be accessible on the L2, it is enough to add to factoryDeps - const L2_STANDARD_TOKEN_PROXY_BYTECODE = hre.artifacts.readArtifactSync("BeaconProxy").bytecode; - - // TODO: request from API how many L2 gas needs for the transaction. - const tx2 = await create2DeployFromL1( - chainId, - deployer.deployWallet, - l2SharedBridgeImplementationBytecode, - defaultAbiCoder.encode(["uint256"], [eraChainId]), - ethers.constants.HashZero, - priorityTxMaxGasLimit, - gasPrice, - [L2_STANDARD_TOKEN_PROXY_BYTECODE] - ); - - await tx2.wait(); - if (deployer.verbose) { - console.log("Deployed L2SharedBridge Implementation"); - console.log(`CONTRACTS_L2_SHARED_BRIDGE_IMPL_ADDR=${l2SharedBridgeImplAddress}`); - } -} - -export async function deploySharedBridgeProxyOnL2ThroughL1( - deployer: Deployer, - chainId: string, - gasPrice: BigNumberish, - localLegacyBridgeTesting: boolean = false -) { - const l1SharedBridge = deployer.defaultSharedBridge(deployer.deployWallet); - if (deployer.verbose) { - console.log("Deploying L2SharedBridge Proxy"); - } - /// prepare proxyInitializationParams - const l2GovernorAddress = applyL1ToL2Alias(deployer.addresses.Governance); - - let proxyInitializationParams; - if (localLegacyBridgeTesting) { - const l2SharedBridgeInterface = new Interface(hre.artifacts.readArtifactSync("DevL2SharedBridge").abi); - proxyInitializationParams = l2SharedBridgeInterface.encodeFunctionData("initializeDevBridge", [ - l1SharedBridge.address, - deployer.addresses.Bridges.ERC20BridgeProxy, - hashL2Bytecode(L2_STANDARD_TOKEN_PROXY_BYTECODE), - l2GovernorAddress, - ]); - } else { - const l2SharedBridgeInterface = new Interface(hre.artifacts.readArtifactSync("L2SharedBridge").abi); - proxyInitializationParams = l2SharedBridgeInterface.encodeFunctionData("initialize", [ - l1SharedBridge.address, - deployer.addresses.Bridges.ERC20BridgeProxy, - hashL2Bytecode(L2_STANDARD_TOKEN_PROXY_BYTECODE), - l2GovernorAddress, - ]); - } - - /// prepare constructor data - const l2SharedBridgeProxyConstructorData = ethers.utils.arrayify( - new ethers.utils.AbiCoder().encode( - ["address", "address", "bytes"], - [deployer.addresses.Bridges.L2SharedBridgeImplementation, l2GovernorAddress, proxyInitializationParams] - ) - ); - - /// loading TransparentUpgradeableProxy bytecode - const L2_SHARED_BRIDGE_PROXY_BYTECODE = hre.artifacts.readArtifactSync( - "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol:TransparentUpgradeableProxy" - ).bytecode; - - /// compute L2SharedBridgeProxy address - const l2SharedBridgeProxyAddress = computeL2Create2Address( - deployer.deployWallet, - L2_SHARED_BRIDGE_PROXY_BYTECODE, - l2SharedBridgeProxyConstructorData, - ethers.constants.HashZero - ); - deployer.addresses.Bridges.L2SharedBridgeProxy = l2SharedBridgeProxyAddress; - - /// deploy L2SharedBridgeProxy - // TODO: request from API how many L2 gas needs for the transaction. - const tx3 = await create2DeployFromL1( - chainId, - deployer.deployWallet, - L2_SHARED_BRIDGE_PROXY_BYTECODE, - l2SharedBridgeProxyConstructorData, - ethers.constants.HashZero, - priorityTxMaxGasLimit, - gasPrice - ); - await tx3.wait(); - if (deployer.verbose) { - console.log(`CONTRACTS_L2_SHARED_BRIDGE_ADDR=${l2SharedBridgeProxyAddress}`); - } -} - -export async function initializeChainGovernance(deployer: Deployer, chainId: string) { - const l1SharedBridge = deployer.defaultSharedBridge(deployer.deployWallet); - - if (deployer.verbose) { - console.log("Initializing chain governance"); - } - await deployer.executeUpgrade( - l1SharedBridge.address, - 0, - l1SharedBridge.interface.encodeFunctionData("initializeChainGovernance", [ ->>>>>>> 874bc6ba940de9d37b474d1e3dda2fe4e869dfbe - chainId, - deployer.deployWallet, - [ - L2_STANDARD_ERC20_PROXY_FACTORY_BYTECODE, - L2_STANDARD_ERC20_IMPLEMENTATION_BYTECODE, - L2_STANDARD_TOKEN_PROXY_BYTECODE, - ], - gasPrice - ) - ).wait(); - - if (deployer.verbose) { - console.log("Bytecodes published on L2, hash: ", receipt.transactionHash); - } -} - -async function setL2TokenBeacon(deployer: Deployer, chainId: string, gasPrice: BigNumberish) { - if (deployer.verbose) { - console.log("Setting L2 token beacon"); - } - const l2NTV = L2NativeTokenVaultFactory.connect(L2_NATIVE_TOKEN_VAULT_ADDRESS, deployer.deployWallet); - - const receipt = await deployer.executeUpgradeOnL2( - chainId, - L2_NATIVE_TOKEN_VAULT_ADDRESS, - gasPrice, - l2NTV.interface.encodeFunctionData("setL2TokenBeacon", [false, ethers.constants.AddressZero]), - priorityTxMaxGasLimit - ); - if (deployer.verbose) { - console.log("Set L2Token Beacon, upgrade hash", receipt.transactionHash); - } - const bridgehub = BridgehubFactory.connect(L2_BRIDGEHUB_ADDRESS, deployer.deployWallet); - const receipt2 = await deployer.executeUpgradeOnL2( - chainId, - L2_BRIDGEHUB_ADDRESS, - gasPrice, - bridgehub.interface.encodeFunctionData("setAddresses", [ - L2_ASSET_ROUTER_ADDRESS, - ADDRESS_ONE, - L2_MESSAGE_ROOT_ADDRESS, - ]), - priorityTxMaxGasLimit - ); - if (deployer.verbose) { - console.log("Set addresses in BH, upgrade hash", receipt2.transactionHash); - } -} - -export async function deploySharedBridgeOnL2ThroughL1(deployer: Deployer, chainId: string, gasPrice: BigNumberish) { - await publishL2NativeTokenVaultDependencyBytecodesOnL2(deployer, chainId, gasPrice); - await setL2TokenBeacon(deployer, chainId, gasPrice); - if (deployer.verbose) { - console.log(`CONTRACTS_L2_NATIVE_TOKEN_VAULT_IMPL_ADDR=${L2_NATIVE_TOKEN_VAULT_ADDRESS}`); - console.log(`CONTRACTS_L2_NATIVE_TOKEN_VAULT_PROXY_ADDR=${L2_NATIVE_TOKEN_VAULT_ADDRESS}`); - console.log(`CONTRACTS_L2_SHARED_BRIDGE_IMPL_ADDR=${L2_ASSET_ROUTER_ADDRESS}`); - console.log(`CONTRACTS_L2_SHARED_BRIDGE_ADDR=${L2_ASSET_ROUTER_ADDRESS}`); - } -} - -async function main() { - const program = new Command(); - - program.version("0.1.0").name("deploy-shared-bridge-on-l2-through-l1"); - - program - .option("--private-key ") - .option("--chain-id ") - .option("--local-legacy-bridge-testing") - .option("--gas-price ") - .option("--nonce ") - .option("--erc20-bridge ") - .option("--skip-initialize-chain-governance ") - .action(async (cmd) => { - const chainId: string = cmd.chainId ? cmd.chainId : process.env.CHAIN_ETH_ZKSYNC_NETWORK_ID; - const deployWallet = cmd.privateKey - ? new Wallet(cmd.privateKey, provider) - : Wallet.fromMnemonic( - process.env.MNEMONIC ? process.env.MNEMONIC : ethTestConfig.mnemonic, - "m/44'/60'/0'/0/1" - ).connect(provider); - console.log(`Using deployer wallet: ${deployWallet.address}`); - - const deployer = new Deployer({ - deployWallet, - ownerAddress: deployWallet.address, - verbose: true, - }); - - const nonce = cmd.nonce ? parseInt(cmd.nonce) : await deployer.deployWallet.getTransactionCount(); - console.log(`Using nonce: ${nonce}`); - - const gasPrice = cmd.gasPrice - ? parseUnits(cmd.gasPrice, "gwei") - : (await provider.getGasPrice()).mul(GAS_MULTIPLIER); - console.log(`Using gas price: ${formatUnits(gasPrice, "gwei")} gwei`); - - const skipInitializeChainGovernance = - !!cmd.skipInitializeChainGovernance && cmd.skipInitializeChainGovernance === "true"; - if (skipInitializeChainGovernance) { - console.log("Initialization of the chain governance will be skipped"); - } - - await deploySharedBridgeOnL2ThroughL1(deployer, chainId, gasPrice); - }); - - await program.parseAsync(process.argv); -} - -main() - .then(() => process.exit(0)) - .catch((err) => { - console.error("Error:", err); - process.exit(1); - }); diff --git a/l2-contracts/src/upgrade-consistency-checker.ts b/l2-contracts/src/upgrade-consistency-checker.ts index 8bebe197d..da2ebcc29 100644 --- a/l2-contracts/src/upgrade-consistency-checker.ts +++ b/l2-contracts/src/upgrade-consistency-checker.ts @@ -10,7 +10,7 @@ import { Provider } from "zksync-ethers"; // Things that still have to be manually double checked: // 1. Contracts must be verified. -// 2. Getter methods in STM. +// 2. Getter methods in CTM. // List the contracts that should become the upgrade targets const l2BridgeImplAddr = "0x470afaacce2acdaefcc662419b74c79d76c914ae"; diff --git a/l2-contracts/src/utils.ts b/l2-contracts/src/utils.ts index 67883e600..fc89ba668 100644 --- a/l2-contracts/src/utils.ts +++ b/l2-contracts/src/utils.ts @@ -13,6 +13,7 @@ import type { Provider } from "zksync-ethers"; import { REQUIRED_L1_TO_L2_GAS_PER_PUBDATA_LIMIT, sleep } from "zksync-ethers/build/utils"; import { IERC20Factory } from "../typechain/IERC20Factory"; +import { IL1NativeTokenVaultFactory } from "../../l1-contracts/typechain/IL1NativeTokenVaultFactory"; export const provider = web3Provider(); @@ -132,6 +133,7 @@ export async function requestL2TransactionDirect( const deployedAddresses = deployedAddressesFromEnv(); const bridgehubAddress = deployedAddresses.Bridgehub.BridgehubProxy; const bridgehub = IBridgehubFactory.connect(bridgehubAddress, wallet); + const ntv = IL1NativeTokenVaultFactory.connect(deployedAddresses.Bridges.NativeTokenVaultProxy, wallet); gasPrice ??= await bridgehub.provider.getGasPrice(); const expectedCost = await bridgehub.l2TransactionBaseCost( @@ -141,7 +143,8 @@ export async function requestL2TransactionDirect( REQUIRED_L2_GAS_PRICE_PER_PUBDATA ); - const baseTokenAddress = await bridgehub.baseToken(chainId); + const baseTokenAssetId = await bridgehub.baseTokenAssetId(chainId); + const baseTokenAddress = await ntv.tokenAddress(baseTokenAssetId); const baseTokenBridge = deployedAddresses.Bridges.SharedBridgeProxy; const baseToken = IERC20Factory.connect(baseTokenAddress, wallet); const ethIsBaseToken = ADDRESS_ONE == baseTokenAddress; @@ -166,6 +169,27 @@ export async function requestL2TransactionDirect( ); } +export async function create2DeployFromL2( + wallet: ethers.Wallet, + bytecode: ethers.BytesLike, + constructor: ethers.BytesLike, + create2Salt: ethers.BytesLike, + extraFactoryDeps?: ethers.BytesLike[] +) { + const deployerSystemContracts = new Interface(artifacts.readArtifactSync("IContractDeployer").abi); + const bytecodeHash = hashL2Bytecode(bytecode); + const calldata = deployerSystemContracts.encodeFunctionData("create2", [create2Salt, bytecodeHash, constructor]); + + const factoryDeps = extraFactoryDeps ? [bytecode, ...extraFactoryDeps] : [bytecode]; + return await wallet.call({ + to: DEPLOYER_SYSTEM_CONTRACT_ADDRESS, + data: calldata, + customData: { + factoryDeps, + }, + }); +} + export async function publishBytecodeFromL1( chainId: ethers.BigNumberish, wallet: ethers.Wallet, diff --git a/l2-contracts/test/consensusRegistry.test.ts b/l2-contracts/test/consensusRegistry.test.ts new file mode 100644 index 000000000..66c0309bd --- /dev/null +++ b/l2-contracts/test/consensusRegistry.test.ts @@ -0,0 +1,499 @@ +import { Deployer } from "@matterlabs/hardhat-zksync-deploy"; +import * as hre from "hardhat"; +import { Provider, Wallet } from "zksync-ethers"; +import type { ConsensusRegistry } from "../typechain"; +import { ConsensusRegistryFactory } from "../typechain"; +import { expect } from "chai"; +import { ethers } from "ethers"; +import { Interface } from "ethers/lib/utils"; + +const richAccount = { + address: "0x36615Cf349d7F6344891B1e7CA7C72883F5dc049", + privateKey: "0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110", +}; + +const gasLimit = 100_000_000; + +const CONSENSUS_REGISTRY_ARTIFACT = hre.artifacts.readArtifactSync("ConsensusRegistry"); +const CONSENSUS_REGISTRY_INTERFACE = new Interface(CONSENSUS_REGISTRY_ARTIFACT.abi); + +describe("ConsensusRegistry", function () { + const provider = new Provider(hre.config.networks.localhost.url); + const owner = new Wallet(richAccount.privateKey, provider); + const nonOwner = new Wallet(Wallet.createRandom().privateKey, provider); + const nodes = []; + const nodeEntries = []; + let registry: ConsensusRegistry; + + before("Initialize", async function () { + // Deploy. + const deployer = new Deployer(hre, owner); + const registryInstance = await deployer.deploy(await deployer.loadArtifact("ConsensusRegistry"), []); + const proxyAdmin = await deployer.deploy(await deployer.loadArtifact("ProxyAdmin"), []); + const proxyInitializationParams = CONSENSUS_REGISTRY_INTERFACE.encodeFunctionData("initialize", [owner.address]); + const proxyInstance = await deployer.deploy(await deployer.loadArtifact("TransparentUpgradeableProxy"), [ + registryInstance.address, + proxyAdmin.address, + proxyInitializationParams, + ]); + registry = ConsensusRegistryFactory.connect(proxyInstance.address, owner); + + // Fund nonOwner. + await ( + await owner.sendTransaction({ + to: nonOwner.address, + value: ethers.utils.parseEther("100"), + }) + ).wait(); + + // Prepare the node list. + const numNodes = 10; + for (let i = 0; i < numNodes; i++) { + const node = makeRandomNode(provider); + const nodeEntry = makeRandomNodeEntry(node, i); + nodes.push(node); + nodeEntries.push(nodeEntry); + } + + // Fund the first node owner. + await ( + await owner.sendTransaction({ + to: nodes[0].ownerKey.address, + value: ethers.utils.parseEther("100"), + }) + ).wait(); + }); + + it("Should set the owner as provided in constructor", async function () { + expect(await registry.owner()).to.equal(owner.address); + }); + + it("Should add nodes to both registries", async function () { + for (let i = 0; i < nodes.length; i++) { + await ( + await registry.add( + nodeEntries[i].ownerAddr, + nodeEntries[i].validatorWeight, + nodeEntries[i].validatorPubKey, + nodeEntries[i].validatorPoP, + nodeEntries[i].attesterWeight, + nodeEntries[i].attesterPubKey + ) + ).wait(); + } + + expect(await registry.numNodes()).to.equal(nodes.length); + + for (let i = 0; i < nodes.length; i++) { + const nodeOwner = await registry.nodeOwners(i); + expect(nodeOwner).to.equal(nodeEntries[i].ownerAddr); + const node = await registry.nodes(nodeOwner); + expect(node.attesterLastUpdateCommit).to.equal(0); + expect(node.validatorLastUpdateCommit).to.equal(0); + + // 'Latest' is expected to match the added node's attributes. + expect(node.attesterLatest.active).to.equal(true); + expect(node.attesterLatest.removed).to.equal(false); + expect(node.attesterLatest.weight).to.equal(nodeEntries[i].attesterWeight); + expect(node.attesterLatest.pubKey.tag).to.equal(nodeEntries[i].attesterPubKey.tag); + expect(node.attesterLatest.pubKey.x).to.equal(nodeEntries[i].attesterPubKey.x); + expect(node.validatorLastUpdateCommit).to.equal(0); + expect(node.validatorLatest.active).to.equal(true); + expect(node.validatorLatest.removed).to.equal(false); + expect(node.validatorLatest.weight).to.equal(nodeEntries[i].attesterWeight); + expect(node.validatorLatest.pubKey.a).to.equal(nodeEntries[i].validatorPubKey.a); + expect(node.validatorLatest.pubKey.b).to.equal(nodeEntries[i].validatorPubKey.b); + expect(node.validatorLatest.pubKey.c).to.equal(nodeEntries[i].validatorPubKey.c); + expect(node.validatorLatest.proofOfPossession.a).to.equal(nodeEntries[i].validatorPoP.a); + expect(node.validatorLatest.proofOfPossession.b).to.equal(nodeEntries[i].validatorPoP.b); + + // 'Snapshot' is expected to have zero values. + expect(node.attesterSnapshot.active).to.equal(false); + expect(node.attesterSnapshot.removed).to.equal(false); + expect(node.attesterSnapshot.weight).to.equal(0); + expect(ethers.utils.arrayify(node.attesterSnapshot.pubKey.tag)).to.deep.equal(new Uint8Array(1)); + expect(ethers.utils.arrayify(node.attesterSnapshot.pubKey.x)).to.deep.equal(new Uint8Array(32)); + expect(node.validatorSnapshot.active).to.equal(false); + expect(node.validatorSnapshot.removed).to.equal(false); + expect(node.validatorSnapshot.weight).to.equal(0); + expect(ethers.utils.arrayify(node.validatorSnapshot.pubKey.a)).to.deep.equal(new Uint8Array(32)); + expect(ethers.utils.arrayify(node.validatorSnapshot.pubKey.b)).to.deep.equal(new Uint8Array(32)); + expect(ethers.utils.arrayify(node.validatorSnapshot.pubKey.c)).to.deep.equal(new Uint8Array(32)); + expect(ethers.utils.arrayify(node.validatorSnapshot.proofOfPossession.a)).to.deep.equal(new Uint8Array(32)); + expect(ethers.utils.arrayify(node.validatorSnapshot.proofOfPossession.b)).to.deep.equal(new Uint8Array(16)); + } + }); + + it("Should not allow nonOwner to add", async function () { + await expect( + registry + .connect(nonOwner) + .add( + ethers.Wallet.createRandom().address, + 0, + { a: new Uint8Array(32), b: new Uint8Array(32), c: new Uint8Array(32) }, + { a: new Uint8Array(32), b: new Uint8Array(16) }, + 0, + { tag: new Uint8Array(1), x: new Uint8Array(32) }, + { gasLimit } + ) + ).to.be.reverted; + }); + + it("Should allow owner to deactivate", async function () { + const nodeOwner = nodeEntries[0].ownerAddr; + expect((await registry.nodes(nodeOwner)).validatorLatest.active).to.equal(true); + + await (await registry.connect(owner).deactivate(nodeOwner, { gasLimit })).wait(); + expect((await registry.nodes(nodeOwner)).validatorLatest.active).to.equal(false); + + // Restore state. + await (await registry.connect(owner).activate(nodeOwner, { gasLimit })).wait(); + }); + + it("Should not allow nonOwner, nonNodeOwner to deactivate", async function () { + const nodeOwner = nodeEntries[0].ownerAddr; + await expect(registry.connect(nonOwner).deactivate(nodeOwner, { gasLimit })).to.be.reverted; + }); + + it("Should change validator weight", async function () { + const entry = nodeEntries[0]; + expect((await registry.nodes(entry.ownerAddr)).validatorLatest.weight).to.equal(entry.validatorWeight); + + const baseWeight = entry.validatorWeight; + const newWeight = getRandomNumber(100, 1000); + await (await registry.changeValidatorWeight(entry.ownerAddr, newWeight, { gasLimit })).wait(); + expect((await registry.nodes(entry.ownerAddr)).validatorLatest.weight).to.equal(newWeight); + expect((await registry.nodes(entry.ownerAddr)).attesterLatest.weight).to.equal(entry.attesterWeight); + + // Restore state. + await (await registry.changeValidatorWeight(entry.ownerAddr, baseWeight, { gasLimit })).wait(); + }); + + it("Should not allow nodeOwner to change validator weight", async function () { + const node = nodes[0]; + await expect(registry.connect(node.ownerKey).changeValidatorWeight(node.ownerKey.address, 0, { gasLimit })).to.be + .reverted; + }); + + it("Should not allow nonOwner to change validator weight", async function () { + const node = nodes[0]; + await expect(registry.connect(nonOwner).changeValidatorWeight(node.ownerKey.address, 0, { gasLimit })).to.be + .reverted; + }); + + it("Should change attester weight", async function () { + const entry = nodeEntries[0]; + expect((await registry.nodes(entry.ownerAddr)).attesterLatest.weight).to.equal(entry.attesterWeight); + + const baseWeight = entry.attesterWeight; + const newWeight = getRandomNumber(100, 1000); + await (await registry.changeAttesterWeight(entry.ownerAddr, newWeight, { gasLimit })).wait(); + expect((await registry.nodes(entry.ownerAddr)).attesterLatest.weight).to.equal(newWeight); + expect((await registry.nodes(entry.ownerAddr)).validatorLatest.weight).to.equal(entry.validatorWeight); + + // Restore state. + await (await registry.changeAttesterWeight(entry.ownerAddr, baseWeight, { gasLimit })).wait(); + }); + + it("Should not allow nodeOwner to change attester weight", async function () { + const node = nodes[0]; + await expect(registry.connect(node.ownerKey).changeAttesterWeight(node.ownerKey.address, 0, { gasLimit })).to.be + .reverted; + }); + + it("Should not allow nonOwner to change attester weight", async function () { + const node = nodes[0]; + await expect(registry.connect(nonOwner).changeAttesterWeight(node.ownerKey.address, 0, { gasLimit })).to.be + .reverted; + }); + + it("Should not allow to add a node with a validator public key which already exist", async function () { + const newEntry = makeRandomNodeEntry(makeRandomNode(), 0); + await expect( + registry.add( + newEntry.ownerAddr, + newEntry.validatorWeight, + nodeEntries[0].validatorPubKey, + newEntry.validatorPoP, + newEntry.attesterWeight, + newEntry.attesterPubKey, + { gasLimit } + ) + ).to.be.reverted; + }); + + it("Should not allow to add a node with an attester public key which already exist", async function () { + const newEntry = makeRandomNodeEntry(makeRandomNode(), 0); + await expect( + registry.add( + newEntry.ownerAddr, + newEntry.validatorWeight, + newEntry.validatorPubKey, + newEntry.validatorPoP, + newEntry.attesterWeight, + nodeEntries[0].attesterPubKey, + { gasLimit } + ) + ).to.be.reverted; + }); + + it("Should return attester committee once committed to", async function () { + // Verify that committee was not committed to. + expect((await registry.getAttesterCommittee()).length).to.equal(0); + + // Commit. + await (await registry.commitAttesterCommittee({ gasLimit })).wait(); + + // Read committee. + const attesterCommittee = await registry.getAttesterCommittee(); + expect(attesterCommittee.length).to.equal(nodes.length); + for (let i = 0; i < attesterCommittee.length; i++) { + const entry = nodeEntries[i]; + const attester = attesterCommittee[i]; + expect(attester.weight).to.equal(entry.attesterWeight); + expect(attester.pubKey.tag).to.equal(entry.attesterPubKey.tag); + expect(attester.pubKey.x).to.equal(entry.attesterPubKey.x); + } + }); + + it("Should return validator committee once committed to", async function () { + // Verify that committee was not committed to. + expect((await registry.getValidatorCommittee()).length).to.equal(0); + + // Commit. + await (await registry.commitValidatorCommittee({ gasLimit })).wait(); + + // Read committee. + const validatorCommittee = await registry.getValidatorCommittee(); + expect(validatorCommittee.length).to.equal(nodes.length); + for (let i = 0; i < validatorCommittee.length; i++) { + const entry = nodeEntries[i]; + const validator = validatorCommittee[i]; + expect(validator.weight).to.equal(entry.validatorWeight); + expect(validator.pubKey.a).to.equal(entry.validatorPubKey.a); + expect(validator.pubKey.b).to.equal(entry.validatorPubKey.b); + expect(validator.pubKey.c).to.equal(entry.validatorPubKey.c); + expect(validator.proofOfPossession.a).to.equal(entry.validatorPoP.a); + expect(validator.proofOfPossession.b).to.equal(entry.validatorPoP.b); + } + }); + + it("Should not include inactive nodes in attester and validator committees when committed to", async function () { + const idx = nodeEntries.length - 1; + const entry = nodeEntries[idx]; + + // Deactivate attribute. + await (await registry.deactivate(entry.ownerAddr, { gasLimit })).wait(); + + // Verify no change. + expect((await registry.getAttesterCommittee()).length).to.equal(nodes.length); + expect((await registry.getValidatorCommittee()).length).to.equal(nodes.length); + + // Commit attester committee and verify. + await (await registry.commitAttesterCommittee({ gasLimit })).wait(); + expect((await registry.getAttesterCommittee()).length).to.equal(nodes.length - 1); + expect((await registry.getValidatorCommittee()).length).to.equal(nodes.length); + + // Commit validator committee and verify. + await (await registry.commitValidatorCommittee({ gasLimit })).wait(); + expect((await registry.getAttesterCommittee()).length).to.equal(nodes.length - 1); + expect((await registry.getValidatorCommittee()).length).to.equal(nodes.length - 1); + + // Restore state. + await (await registry.activate(entry.ownerAddr, { gasLimit })).wait(); + await (await registry.commitAttesterCommittee({ gasLimit })).wait(); + await (await registry.commitValidatorCommittee({ gasLimit })).wait(); + }); + + it("Should not include removed nodes in attester and validator committees when committed to", async function () { + const idx = nodeEntries.length - 1; + const entry = nodeEntries[idx]; + + // Remove node. + await (await registry.remove(entry.ownerAddr, { gasLimit })).wait(); + + // Verify no change. + expect((await registry.getAttesterCommittee()).length).to.equal(nodes.length); + expect((await registry.getValidatorCommittee()).length).to.equal(nodes.length); + + // Commit attester committee and verify. + await (await registry.commitAttesterCommittee({ gasLimit })).wait(); + expect((await registry.getAttesterCommittee()).length).to.equal(nodes.length - 1); + expect((await registry.getValidatorCommittee()).length).to.equal(nodes.length); + + // Commit validator committee and verify. + await (await registry.commitValidatorCommittee({ gasLimit })).wait(); + expect((await registry.getAttesterCommittee()).length).to.equal(nodes.length - 1); + expect((await registry.getValidatorCommittee()).length).to.equal(nodes.length - 1); + + // Restore state. + await (await registry.remove(entry.ownerAddr, { gasLimit })).wait(); + await ( + await registry.add( + entry.ownerAddr, + entry.validatorWeight, + entry.validatorPubKey, + entry.validatorPoP, + entry.attesterWeight, + entry.attesterPubKey + ) + ).wait(); + await (await registry.commitAttesterCommittee({ gasLimit })).wait(); + await (await registry.commitValidatorCommittee({ gasLimit })).wait(); + }); + + it("Should not include node attribute change in attester committee before committed to", async function () { + const idx = nodeEntries.length - 1; + const entry = nodeEntries[idx]; + + // Change attribute. + await (await registry.changeAttesterWeight(entry.ownerAddr, entry.attesterWeight + 1, { gasLimit })).wait(); + + // Verify no change. + const attester = (await registry.getAttesterCommittee())[idx]; + expect(attester.weight).to.equal(entry.attesterWeight); + + // Commit. + await (await registry.commitAttesterCommittee({ gasLimit })).wait(); + + // Verify change. + const committedAttester = (await registry.getAttesterCommittee())[idx]; + expect(committedAttester.weight).to.equal(entry.attesterWeight + 1); + + // Restore state. + await (await registry.changeAttesterWeight(entry.ownerAddr, entry.attesterWeight, { gasLimit })).wait(); + await (await registry.commitAttesterCommittee({ gasLimit })).wait(); + }); + + it("Should not include node attribute change in validator committee before committed to", async function () { + const idx = nodeEntries.length - 1; + const entry = nodeEntries[idx]; + + // Change attribute. + await (await registry.changeValidatorWeight(entry.ownerAddr, entry.attesterWeight + 1, { gasLimit })).wait(); + + // Verify no change. + const validator = (await registry.getValidatorCommittee())[idx]; + expect(validator.weight).to.equal(entry.validatorWeight); + + // Commit. + await (await registry.commitValidatorCommittee({ gasLimit })).wait(); + + // Verify change. + const committedValidator = (await registry.getValidatorCommittee())[idx]; + expect(committedValidator.weight).to.equal(entry.validatorWeight + 1); + + // Restore state. + await (await registry.changeValidatorWeight(entry.ownerAddr, entry.validatorWeight, { gasLimit })).wait(); + await (await registry.commitValidatorCommittee({ gasLimit })).wait(); + }); + + it("Should finalize node removal by fully deleting it from storage", async function () { + const idx = nodeEntries.length - 1; + const entry = nodeEntries[idx]; + + // Remove. + expect((await registry.nodes(entry.ownerAddr)).attesterLatest.removed).to.equal(false); + expect((await registry.nodes(entry.ownerAddr)).validatorLatest.removed).to.equal(false); + await (await registry.remove(entry.ownerAddr, { gasLimit })).wait(); + expect((await registry.nodes(entry.ownerAddr)).attesterLatest.removed).to.equal(true); + expect((await registry.nodes(entry.ownerAddr)).validatorLatest.removed).to.equal(true); + + // Commit committees. + await (await registry.commitAttesterCommittee({ gasLimit })).wait(); + await (await registry.commitValidatorCommittee({ gasLimit })).wait(); + + // Verify node was not yet deleted. + expect(await registry.numNodes()).to.equal(nodes.length); + const attesterPubKeyHash = hashAttesterPubKey(entry.attesterPubKey); + expect(await registry.attesterPubKeyHashes(attesterPubKeyHash)).to.be.equal(true); + const validatorPubKeyHash = hashValidatorPubKey(entry.validatorPubKey); + expect(await registry.validatorPubKeyHashes(validatorPubKeyHash)).to.be.equal(true); + + // Trigger node deletion. + await (await registry.remove(entry.ownerAddr, { gasLimit })).wait(); + + // Verify the deletion. + expect(await registry.numNodes()).to.equal(nodes.length - 1); + expect(await registry.attesterPubKeyHashes(attesterPubKeyHash)).to.be.equal(false); + expect(await registry.validatorPubKeyHashes(attesterPubKeyHash)).to.be.equal(false); + const node = await registry.nodes(entry.ownerAddr, { gasLimit }); + expect(ethers.utils.arrayify(node.attesterLatest.pubKey.tag)).to.deep.equal(new Uint8Array(1)); + expect(ethers.utils.arrayify(node.attesterLatest.pubKey.x)).to.deep.equal(new Uint8Array(32)); + + // Restore state. + await ( + await registry.add( + entry.ownerAddr, + entry.validatorWeight, + entry.validatorPubKey, + entry.validatorPoP, + entry.attesterWeight, + entry.attesterPubKey + ) + ).wait(); + await (await registry.commitAttesterCommittee({ gasLimit })).wait(); + await (await registry.commitValidatorCommittee({ gasLimit })).wait(); + }); + + function makeRandomNode() { + return { + ownerKey: new Wallet(Wallet.createRandom().privateKey, provider), + validatorKey: Wallet.createRandom(), + attesterKey: Wallet.createRandom(), + }; + } + + function makeRandomNodeEntry(node, weight: number) { + return { + ownerAddr: node.ownerKey.address, + validatorWeight: weight, + validatorPubKey: getRandomValidatorPubKey(), + validatorPoP: getRandomValidatorPoP(), + attesterWeight: weight, + attesterPubKey: getRandomAttesterPubKey(), + }; + } +}); + +function getRandomNumber(min, max) { + return Math.floor(Math.random() * (max - min + 1)) + min; +} + +function getRandomValidatorPubKey() { + return { + a: ethers.utils.hexlify(ethers.utils.randomBytes(32)), + b: ethers.utils.hexlify(ethers.utils.randomBytes(32)), + c: ethers.utils.hexlify(ethers.utils.randomBytes(32)), + }; +} + +function getRandomValidatorPoP() { + return { + a: ethers.utils.hexlify(ethers.utils.randomBytes(32)), + b: ethers.utils.hexlify(ethers.utils.randomBytes(16)), + }; +} + +function getRandomAttesterPubKey() { + return { + tag: ethers.utils.hexlify(ethers.utils.randomBytes(1)), + x: ethers.utils.hexlify(ethers.utils.randomBytes(32)), + }; +} + +function hashAttesterPubKey(attesterPubKey) { + return ethers.utils.keccak256( + ethers.utils.defaultAbiCoder.encode(["bytes1", "bytes32"], [attesterPubKey.tag, attesterPubKey.x]) + ); +} + +function hashValidatorPubKey(validatorPubKey) { + return ethers.utils.keccak256( + ethers.utils.defaultAbiCoder.encode( + ["bytes32", "bytes32", "bytes32"], + [validatorPubKey.a, validatorPubKey.b, validatorPubKey.c] + ) + ); +} diff --git a/l2-contracts/test/erc20.test.ts b/l2-contracts/test/erc20.test.ts deleted file mode 100644 index ec531f7aa..000000000 --- a/l2-contracts/test/erc20.test.ts +++ /dev/null @@ -1,169 +0,0 @@ -import { Deployer } from "@matterlabs/hardhat-zksync-deploy"; -import { expect } from "chai"; -import { ethers } from "ethers"; -import * as hre from "hardhat"; -import { Provider, Wallet } from "zksync-ethers"; -import { hashBytecode } from "zksync-ethers/build/utils"; -import { unapplyL1ToL2Alias, setCode } from "./test-utils"; -import type { L2AssetRouter, L2NativeTokenVault, L2StandardERC20 } from "../typechain"; -import { L2AssetRouterFactory, L2NativeTokenVaultFactory, L2StandardERC20Factory } from "../typechain"; - -const richAccount = [ - { - address: "0x36615Cf349d7F6344891B1e7CA7C72883F5dc049", - privateKey: "0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110", - }, - { - address: "0xa61464658AfeAf65CccaaFD3a512b69A83B77618", - privateKey: "0xac1e735be8536c6534bb4f17f06f6afc73b2b5ba84ac2cfb12f7461b20c0bbe3", - }, - { - address: "0x0D43eB5B8a47bA8900d84AA36656c92024e9772e", - privateKey: "0xd293c684d884d56f8d6abd64fc76757d3664904e309a0645baf8522ab6366d9e", - }, - { - address: "0xA13c10C0D5bd6f79041B9835c63f91de35A15883", - privateKey: "0x850683b40d4a740aa6e745f889a6fdc8327be76e122f5aba645a5b02d0248db8", - }, -]; - -describe("ERC20Bridge", function () { - const provider = new Provider(hre.config.networks.localhost.url); - const deployerWallet = new Wallet(richAccount[0].privateKey, provider); - const governorWallet = new Wallet(richAccount[1].privateKey, provider); - const proxyAdminWallet = new Wallet(richAccount[3].privateKey, provider); - - // We need to emulate a L1->L2 transaction from the L1 bridge to L2 counterpart. - // It is a bit easier to use EOA and it is sufficient for the tests. - const l1BridgeWallet = new Wallet(richAccount[2].privateKey, provider); - - // We won't actually deploy an L1 token in these tests, but we need some address for it. - const L1_TOKEN_ADDRESS = "0x1111000000000000000000000000000000001111"; - const L2_ASSET_ROUTER_ADDRESS = "0x0000000000000000000000000000000000010003"; - const L2_NATIVE_TOKEN_VAULT_ADDRESS = "0x0000000000000000000000000000000000010004"; - - const testChainId = 9; - - let erc20Bridge: L2AssetRouter; - let erc20NativeTokenVault: L2NativeTokenVault; - let erc20Token: L2StandardERC20; - const contractsDeployedAlready: boolean = false; - - before("Deploy token and bridge", async function () { - const deployer = new Deployer(hre, deployerWallet); - - // While we formally don't need to deploy the token and the beacon proxy, it is a neat way to have the bytecode published - const l2TokenImplAddress = await deployer.deploy(await deployer.loadArtifact("L2StandardERC20")); - const l2Erc20TokenBeacon = await deployer.deploy(await deployer.loadArtifact("UpgradeableBeacon"), [ - l2TokenImplAddress.address, - ]); - await deployer.deploy(await deployer.loadArtifact("BeaconProxy"), [l2Erc20TokenBeacon.address, "0x"]); - const beaconProxyBytecodeHash = hashBytecode((await deployer.loadArtifact("BeaconProxy")).bytecode); - let constructorArgs = ethers.utils.defaultAbiCoder.encode( - ["uint256", "uint256", "address", "address"], - /// note in real deployment we have to transfer ownership of standard deployer here - [testChainId, 1, unapplyL1ToL2Alias(l1BridgeWallet.address), unapplyL1ToL2Alias(l1BridgeWallet.address)] - ); - await setCode( - deployerWallet, - L2_ASSET_ROUTER_ADDRESS, - (await deployer.loadArtifact("L2AssetRouter")).bytecode, - true, - constructorArgs - ); - - erc20Bridge = L2AssetRouterFactory.connect(L2_ASSET_ROUTER_ADDRESS, deployerWallet); - const l2NativeTokenVaultArtifact = await deployer.loadArtifact("L2NativeTokenVault"); - constructorArgs = ethers.utils.defaultAbiCoder.encode( - ["uint256", "bytes32", "address", "bool"], - /// note in real deployment we have to transfer ownership of standard deployer here - [1, beaconProxyBytecodeHash, governorWallet.address, contractsDeployedAlready] - ); - await setCode( - deployerWallet, - L2_NATIVE_TOKEN_VAULT_ADDRESS, - l2NativeTokenVaultArtifact.bytecode, - true, - constructorArgs - ); - - erc20NativeTokenVault = L2NativeTokenVaultFactory.connect(L2_NATIVE_TOKEN_VAULT_ADDRESS, l1BridgeWallet); - const governorNTV = L2NativeTokenVaultFactory.connect(L2_NATIVE_TOKEN_VAULT_ADDRESS, governorWallet); - await governorNTV.configureL2TokenBeacon(false, ethers.constants.AddressZero); - }); - - it("Should finalize deposit ERC20 deposit", async function () { - const erc20BridgeWithL1BridgeWallet = L2AssetRouterFactory.connect(erc20Bridge.address, proxyAdminWallet); - const l1Depositor = ethers.Wallet.createRandom(); - const l2Receiver = ethers.Wallet.createRandom(); - const l1Bridge = await hre.ethers.getImpersonatedSigner(l1BridgeWallet.address); - const tx = await ( - await erc20BridgeWithL1BridgeWallet.connect(l1Bridge)["finalizeDeposit(address,address,address,uint256,bytes)"]( - // Depositor and l2Receiver can be any here - l1Depositor.address, - l2Receiver.address, - L1_TOKEN_ADDRESS, - 100, - encodedTokenData("TestToken", "TT", 18) - ) - ).wait(); - const l2TokenInfo = tx.events.find((event) => event.event === "FinalizeDepositSharedBridge").args.assetId; - const l2TokenAddress = await erc20NativeTokenVault.tokenAddress(l2TokenInfo); - // Checking the correctness of the balance: - erc20Token = L2StandardERC20Factory.connect(l2TokenAddress, deployerWallet); - expect(await erc20Token.balanceOf(l2Receiver.address)).to.equal(100); - expect(await erc20Token.totalSupply()).to.equal(100); - expect(await erc20Token.name()).to.equal("TestToken"); - expect(await erc20Token.symbol()).to.equal("TT"); - expect(await erc20Token.decimals()).to.equal(18); - }); - - it("Governance should be able to reinitialize the token", async () => { - const erc20TokenWithGovernor = L2StandardERC20Factory.connect(erc20Token.address, governorWallet); - - await ( - await erc20TokenWithGovernor.reinitializeToken( - { - ignoreName: false, - ignoreSymbol: false, - ignoreDecimals: false, - }, - "TestTokenNewName", - "TTN", - 2 - ) - ).wait(); - - expect(await erc20Token.name()).to.equal("TestTokenNewName"); - expect(await erc20Token.symbol()).to.equal("TTN"); - // The decimals should stay the same - expect(await erc20Token.decimals()).to.equal(18); - }); - - it("Governance should not be able to skip initializer versions", async () => { - const erc20TokenWithGovernor = L2StandardERC20Factory.connect(erc20Token.address, governorWallet); - - await expect( - erc20TokenWithGovernor.reinitializeToken( - { - ignoreName: false, - ignoreSymbol: false, - ignoreDecimals: false, - }, - "TestTokenNewName", - "TTN", - 20, - { gasLimit: 10000000 } - ) - ).to.be.reverted; - }); -}); - -function encodedTokenData(name: string, symbol: string, decimals: number) { - const abiCoder = ethers.utils.defaultAbiCoder; - const encodedName = abiCoder.encode(["string"], [name]); - const encodedSymbol = abiCoder.encode(["string"], [symbol]); - const encodedDecimals = abiCoder.encode(["uint8"], [decimals]); - - return abiCoder.encode(["bytes", "bytes", "bytes"], [encodedName, encodedSymbol, encodedDecimals]); -} diff --git a/l2-contracts/test/foundry/unit/data-availability/RollupL2DAValidator.t.sol b/l2-contracts/test/foundry/unit/data-availability/RollupL2DAValidator.t.sol new file mode 100644 index 000000000..5a56e7118 --- /dev/null +++ b/l2-contracts/test/foundry/unit/data-availability/RollupL2DAValidator.t.sol @@ -0,0 +1,154 @@ +// SPDX-License-Identifier: MIT + +pragma solidity ^0.8.20; + +// solhint-disable gas-custom-errors + +import {Test} from "forge-std/Test.sol"; + +import {TestStateDiffComposer} from "./TestStateDiffComposer.sol"; + +import {RollupL2DAValidator} from "contracts/data-availability/RollupL2DAValidator.sol"; +import {STATE_DIFF_ENTRY_SIZE} from "contracts/data-availability/StateDiffL2DAValidator.sol"; +import {ReconstructionMismatch, PubdataField} from "contracts/data-availability/DAErrors.sol"; + +import {COMPRESSOR_CONTRACT, PUBDATA_CHUNK_PUBLISHER} from "contracts/L2ContractHelper.sol"; + +import {console2 as console} from "forge-std/Script.sol"; + +contract RollupL2DAValidatorTest is Test { + RollupL2DAValidator internal l2DAValidator; + TestStateDiffComposer internal composer; + + function setUp() public { + l2DAValidator = new RollupL2DAValidator(); + composer = new TestStateDiffComposer(); + + bytes memory emptyArray = new bytes(0); + + // Setting dummy state diffs, so it works fine. + composer.setDummyStateDiffs(1, 0, 64, emptyArray, 0, emptyArray); + + bytes memory verifyCompressedStateDiffsData = abi.encodeCall( + COMPRESSOR_CONTRACT.verifyCompressedStateDiffs, + (0, 64, emptyArray, emptyArray) + ); + vm.mockCall(address(COMPRESSOR_CONTRACT), verifyCompressedStateDiffsData, new bytes(32)); + + bytes memory chunkPubdataToBlobsData = abi.encodeCall( + PUBDATA_CHUNK_PUBLISHER.chunkPubdataToBlobs, + (emptyArray) + ); + vm.mockCall(address(PUBDATA_CHUNK_PUBLISHER), chunkPubdataToBlobsData, new bytes(32)); + } + + function finalizeAndCall(bytes memory revertMessage) internal returns (bytes32) { + bytes32 rollingMessagesHash = composer.correctRollingMessagesHash(); + bytes32 rollingBytecodeHash = composer.correctRollingBytecodesHash(); + bytes memory totalL2ToL1PubdataAndStateDiffs = composer.generateTotalStateDiffsAndPubdata(); + + if (revertMessage.length > 0) { + vm.expectRevert(revertMessage); + } + return + l2DAValidator.validatePubdata( + bytes32(0), + bytes32(0), + rollingMessagesHash, + rollingBytecodeHash, + totalL2ToL1PubdataAndStateDiffs + ); + } + + function test_incorrectChainMessagesHash() public { + composer.appendAMessage("message", true, false); + + bytes memory revertMessage = abi.encodeWithSelector( + ReconstructionMismatch.selector, + PubdataField.MsgHash, + composer.correctRollingMessagesHash(), + composer.currentRollingMessagesHash() + ); + finalizeAndCall(revertMessage); + } + + function test_incorrectChainBytecodeHash() public { + composer.appendBytecode(new bytes(32), true, false); + + bytes memory revertMessage = abi.encodeWithSelector( + ReconstructionMismatch.selector, + PubdataField.Bytecode, + composer.correctRollingBytecodesHash(), + composer.currentRollingBytecodesHash() + ); + finalizeAndCall(revertMessage); + } + + function test_incorrectStateDiffVersion() public { + composer.setDummyStateDiffs(2, 0, 64, new bytes(0), 0, new bytes(0)); + + bytes memory revertMessage = abi.encodeWithSelector( + ReconstructionMismatch.selector, + PubdataField.StateDiffCompressionVersion, + bytes32(uint256(1)), + bytes32(uint256(2)) + ); + finalizeAndCall(revertMessage); + } + + function test_nonZeroLeftOver() public { + composer.setDummyStateDiffs(1, 0, 64, new bytes(0), 0, new bytes(32)); + + bytes memory revertMessage = abi.encodeWithSelector( + ReconstructionMismatch.selector, + PubdataField.ExtraData, + bytes32(0), + bytes32(uint256(32)) + ); + finalizeAndCall(revertMessage); + } + + function test_fullCorrectCompression() public { + composer.appendAMessage("message", true, true); + composer.appendBytecode(new bytes(32), true, true); + + uint256 numberOfStateDiffs = 1; + // Just some non-zero array, the structure does not matter here. + bytes memory compressedStateDiffs = new bytes(12); + bytes memory uncompressedStateDiffs = new bytes(STATE_DIFF_ENTRY_SIZE * numberOfStateDiffs); + + composer.setDummyStateDiffs( + 1, + uint24(compressedStateDiffs.length), + 64, + compressedStateDiffs, + uint32(numberOfStateDiffs), + uncompressedStateDiffs + ); + + bytes32 stateDiffsHash = keccak256(uncompressedStateDiffs); + bytes memory verifyCompressedStateDiffsData = abi.encodeCall( + COMPRESSOR_CONTRACT.verifyCompressedStateDiffs, + (numberOfStateDiffs, 64, uncompressedStateDiffs, compressedStateDiffs) + ); + vm.mockCall(address(COMPRESSOR_CONTRACT), verifyCompressedStateDiffsData, abi.encodePacked(stateDiffsHash)); + + bytes memory totalPubdata = composer.getTotalPubdata(); + bytes32 blobHash = keccak256(totalPubdata); + bytes32[] memory blobHashes = new bytes32[](1); + blobHashes[0] = blobHash; + bytes memory chunkPubdataToBlobsData = abi.encodeCall( + PUBDATA_CHUNK_PUBLISHER.chunkPubdataToBlobs, + (totalPubdata) + ); + vm.mockCall(address(PUBDATA_CHUNK_PUBLISHER), chunkPubdataToBlobsData, abi.encode(blobHashes)); + + bytes32 operatorDAHash = finalizeAndCall(new bytes(0)); + + bytes32 expectedOperatorDAHash = keccak256( + abi.encodePacked(stateDiffsHash, keccak256(totalPubdata), uint8(blobHashes.length), blobHashes) + ); + + assertEq(operatorDAHash, expectedOperatorDAHash); + } +} diff --git a/l2-contracts/test/foundry/unit/data-availability/TestStateDiffComposer.sol b/l2-contracts/test/foundry/unit/data-availability/TestStateDiffComposer.sol new file mode 100644 index 000000000..05c639818 --- /dev/null +++ b/l2-contracts/test/foundry/unit/data-availability/TestStateDiffComposer.sol @@ -0,0 +1,97 @@ +// SPDX-License-Identifier: MIT + +import {L2_TO_L1_LOG_SERIALIZE_SIZE} from "contracts/data-availability/StateDiffL2DAValidator.sol"; + +import {L2ContractHelper} from "contracts/L2ContractHelper.sol"; + +/// @notice The contract that is used in testing to compose the pubdata needed for the +/// state diff DA validator. +contract TestStateDiffComposer { + // The following two are always correct + // as these qre expected to be already checked by the L1Messenger + uint256 internal logsNumber; + bytes internal logs; + + uint256 internal messagesNumber; + bytes internal messages; + bytes32 public currentRollingMessagesHash; + bytes32 public correctRollingMessagesHash; + + uint256 internal bytecodesNumber; + bytes internal bytecodes; + bytes32 public currentRollingBytecodesHash; + bytes32 public correctRollingBytecodesHash; + + bytes internal uncomressedStateDiffsPart; + bytes internal compressedStateDiffsPart; + + function appendALog() public { + // This function is not fully implemented, i.e. we do not insert the correct + // content of the log. The reason for that is that it is not needed for the + // testing + + ++logsNumber; + logs = bytes.concat(logs, new bytes(L2_TO_L1_LOG_SERIALIZE_SIZE)); + } + + function appendAMessage(bytes memory message, bool includeToArray, bool includeToCorrectHash) public { + if (includeToArray) { + ++messagesNumber; + messages = bytes.concat(messages, bytes4(uint32(message.length)), message); + currentRollingMessagesHash = keccak256(abi.encode(currentRollingMessagesHash, keccak256(message))); + } + + if (includeToCorrectHash) { + correctRollingMessagesHash = keccak256(abi.encode(correctRollingMessagesHash, keccak256(message))); + } + } + + function appendBytecode(bytes memory bytecode, bool includeToArray, bool includeToCorrectHash) public { + if (includeToArray) { + ++bytecodesNumber; + bytecodes = bytes.concat(bytecodes, bytes4(uint32(bytecode.length)), bytecode); + currentRollingBytecodesHash = keccak256( + abi.encode(currentRollingBytecodesHash, L2ContractHelper.hashL2BytecodeMemory(bytecode)) + ); + } + if (includeToCorrectHash) { + correctRollingBytecodesHash = keccak256( + abi.encode(correctRollingBytecodesHash, L2ContractHelper.hashL2BytecodeMemory(bytecode)) + ); + } + } + + function setDummyStateDiffs( + uint8 _version, + uint24 _compressedStateDiffSize, + uint8 _enumIndexSize, + bytes memory _compressedStateDiffs, + uint32 _numberOfStateDiffs, + bytes memory _stateDiffs + ) public { + compressedStateDiffsPart = abi.encodePacked( + _version, + _compressedStateDiffSize, + _enumIndexSize, + _compressedStateDiffs + ); + + uncomressedStateDiffsPart = abi.encodePacked(_numberOfStateDiffs, _stateDiffs); + } + + function getTotalPubdata() public returns (bytes memory _totalPubdata) { + _totalPubdata = abi.encodePacked( + uint32(logsNumber), + logs, + uint32(messagesNumber), + messages, + uint32(bytecodesNumber), + bytecodes, + compressedStateDiffsPart + ); + } + + function generateTotalStateDiffsAndPubdata() public returns (bytes memory _totalL2ToL1PubdataAndStateDiffs) { + _totalL2ToL1PubdataAndStateDiffs = abi.encodePacked(getTotalPubdata(), uncomressedStateDiffsPart); + } +} diff --git a/l2-contracts/test/foundry/unit/data-availability/ValidiumL2DAValidator.t.sol b/l2-contracts/test/foundry/unit/data-availability/ValidiumL2DAValidator.t.sol new file mode 100644 index 000000000..c54367295 --- /dev/null +++ b/l2-contracts/test/foundry/unit/data-availability/ValidiumL2DAValidator.t.sol @@ -0,0 +1,19 @@ +// SPDX-License-Identifier: MIT + +pragma solidity ^0.8.20; + +// solhint-disable gas-custom-errors + +import {Test} from "forge-std/Test.sol"; + +import {ValidiumL2DAValidator} from "contracts/data-availability/ValidiumL2DAValidator.sol"; + +contract L2Erc20BridgeTest is Test { + function test_callValidiumDAValidator(address depositor, address receiver, uint256 amount) internal { + ValidiumL2DAValidator validator = new ValidiumL2DAValidator(); + + bytes32 outputHash = validator.validatePubdata(bytes32(0), bytes32(0), bytes32(0), bytes32(0), hex""); + + assertEq(outputHash, bytes32(0)); + } +} diff --git a/l2-contracts/test/foundry/unit/verifier/Verifier.t.sol b/l2-contracts/test/foundry/unit/verifier/Verifier.t.sol new file mode 100644 index 000000000..39b7ad944 --- /dev/null +++ b/l2-contracts/test/foundry/unit/verifier/Verifier.t.sol @@ -0,0 +1,199 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {Test} from "forge-std/Test.sol"; + +import {Script, console2 as console} from "forge-std/Script.sol"; + +import {Verifier} from "contracts/verifier/Verifier.sol"; +import {VerifierTest} from "contracts/dev-contracts/VerifierTest.sol"; + +contract VerifierCaller { + Verifier public verifier; + + constructor(Verifier _verifier) { + verifier = _verifier; + } + + function verify( + uint256[] memory publicInputs, + uint256[] memory serializedProof + ) public view returns (bool result, uint256 gasUsed) { + uint256 gasBefore = gasleft(); + result = verifier.verify(publicInputs, serializedProof); + gasUsed = gasBefore - gasleft(); + } +} + +contract VerifierTestTest is Test { + uint256 Q_MOD = 21888242871839275222246405745257275088696311157297823662689037894645226208583; + uint256 R_MOD = 21888242871839275222246405745257275088548364400416034343698204186575808495617; + + uint256[] public publicInputs; + uint256[] public serializedProof; + + Verifier public verifier; + + function setUp() public virtual { + publicInputs.push(17257057577815541751225964212897374444694342989384539141520877492729); + + serializedProof.push(10032255692304426541958487424837706541667730769782503366592797609781788557424); + serializedProof.push(11856023086316274558845067687080284266010851703055534566998849536424959073766); + serializedProof.push(1946976494418613232642071265529572704802622739887191787991738703483400525159); + serializedProof.push(1328106069458824013351862477593422369726189688844441245167676630500797673929); + serializedProof.push(15488976127650523079605218040232167291115155239002840072043251018873550258833); + serializedProof.push(4352460820258659596860226525221943504756149602617718032378962471842121872064); + serializedProof.push(10499239305859992443759785453270906003243074359959242371675950941500942473773); + serializedProof.push(21347231097799123231227724221565041889687686131480556177475242020711996173235); + serializedProof.push(21448274562455512652922184359722637546669181231038098300951155169465175447933); + serializedProof.push(5224615512030263722410009061780530125927659699046094954022444377569738464640); + serializedProof.push(457781538876079938778845275495204146302569607395268192839148474821758081582); + serializedProof.push(18861735728246155975127314860333796285284072325207684293054713266899263027595); + serializedProof.push(16303944945368742900183889655415585360236645961122617249176044814801835577336); + serializedProof.push(13035945439947210396602249585896632733250124877036427100939804737514358838409); + serializedProof.push(5344210729159253547334947774998425118220137275601995670629358314205854915831); + serializedProof.push(5798533246034358556434877465898581616792677631188370022078168611592512620805); + serializedProof.push(17389657286129893116489015409587246992530648956814855147744210777822507444908); + serializedProof.push(2287244647342394712608648573347732257083870498255199596324312699868511383792); + serializedProof.push(4008043766112513713076111464601725311991199944328610186851424132679188418647); + serializedProof.push(1192776719848445147414966176395169615865534126881763324071908049917030138759); + serializedProof.push(21297794452895123333253856666749932934399762330444876027734824957603009458926); + serializedProof.push(17125994169200693606182326100834606153690416627082476471630567824088261322122); + serializedProof.push(13696978282153979214307382954559709118587582183649354744253374201589715565327); + serializedProof.push(19885518441500677676836488338931187143852666523909650686513498826535451677070); + serializedProof.push(1205434280320863211046275554464591162919269140938371417889032165323835178587); + serializedProof.push(17633172995805911347980792921300006225132501482343225088847242025756974009163); + serializedProof.push(16438080406761371143473961144300947125022788905488819913014533292593141026205); + serializedProof.push(5069081552536259237104332491140391551180511112980430307676595350165020188468); + serializedProof.push(21217317205917200275887696442048162383709998732382676029165079037795626916156); + serializedProof.push(19474466610515117278975027596198570980840609656738255347763182823792179771539); + serializedProof.push(9744176601826774967534277982058590459006781888895542911226406188087317156914); + serializedProof.push(13171230402193025939763214267878900142876558410430734782028402821166810894141); + serializedProof.push(11775403006142607980192261369108550982244126464568678337528680604943636677964); + serializedProof.push(6903612341636669639883555213872265187697278660090786759295896380793937349335); + serializedProof.push(10197105415769290664169006387603164525075746474380469980600306405504981186043); + serializedProof.push(10143152486514437388737642096964118742712576889537781270260677795662183637771); + serializedProof.push(7662095231333811948165764727904932118187491073896301295018543320499906824310); + serializedProof.push(929422796511992741418500336817719055655694499787310043166783539202506987065); + serializedProof.push(13837024938095280064325737989251964639823205065380219552242839155123572433059); + serializedProof.push(11738888513780631372636453609299803548810759208935038785934252961078387526204); + serializedProof.push(16528875312985292109940444015943812939751717229020635856725059316776921546668); + serializedProof.push(17525167117689648878398809303253004706004801107861280044640132822626802938868); + serializedProof.push(7419167499813234488108910149511390953153207250610705609008080038658070088540); + serializedProof.push(11628425014048216611195735618191126626331446742771562481735017471681943914146); + + verifier = new VerifierTest(); + } + + function testShouldVerify() public view { + bool success = verifier.verify(publicInputs, serializedProof); + assert(success); + } + + function testShouldVerifyWithGas() public { + // `gas snapshot` does not work well with zksync setup, so in order to obtain the amount of + // zkevm gas consumed we do the following: + // - Deploy a VerifierCaller contract, which would execute in zkevm context + // - Call the verify function from the VerifierCaller contract and return the gas used + + VerifierCaller caller = new VerifierCaller(verifier); + (bool success, uint256 gasUsed) = caller.verify(publicInputs, serializedProof); + assert(success); + + console.log("Gas used: %d", gasUsed); + } + + function testShouldVerifyWithDirtyBits() public view { + uint256[] memory newPublicInputs = publicInputs; + newPublicInputs[0] += uint256(bytes32(0xe000000000000000000000000000000000000000000000000000000000000000)); + + bool success = verifier.verify(newPublicInputs, serializedProof); + assert(success); + } + + function testEllipticCurvePointsOverModulo() public view { + uint256[] memory newSerializedProof = serializedProof; + newSerializedProof[0] += Q_MOD; + newSerializedProof[1] += Q_MOD; + newSerializedProof[1] += Q_MOD; + + bool success = verifier.verify(publicInputs, newSerializedProof); + assert(success); + } + + function testFrOverModulo() public view { + uint256[] memory newSerializedProof = serializedProof; + newSerializedProof[22] += R_MOD; + + bool success = verifier.verify(publicInputs, newSerializedProof); + assert(success); + } + + function testMoreThanOnePublicInput_shouldRevert() public { + uint256[] memory newPublicInputs = new uint256[](2); + newPublicInputs[0] = publicInputs[0]; + newPublicInputs[1] = publicInputs[0]; + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(newPublicInputs, serializedProof); + } + + function testEmptyPublicInput_shouldRevert() public { + uint256[] memory newPublicInputs; + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(newPublicInputs, serializedProof); + } + + function testMoreThan44WordsProof_shouldRevert() public { + uint256[] memory newSerializedProof = new uint256[](serializedProof.length + 1); + + for (uint256 i = 0; i < serializedProof.length; i++) { + newSerializedProof[i] = serializedProof[i]; + } + newSerializedProof[newSerializedProof.length - 1] = serializedProof[serializedProof.length - 1]; + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testEmptyProof_shouldRevert() public { + uint256[] memory newSerializedProof; + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testLongerProofInput_shouldRevert() public { + uint256[] memory newSerializedProof = new uint256[](serializedProof.length + 1); + for (uint256 i = 0; i < serializedProof.length; i++) { + newSerializedProof[i] = serializedProof[i]; + } + newSerializedProof[newSerializedProof.length - 1] = publicInputs[0]; + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testEllipticCurvePointAtInfinity_shouldRevert() public { + uint256[] memory newSerializedProof = serializedProof; + newSerializedProof[0] = 0; + newSerializedProof[1] = 0; + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testInvalidPublicInput_shouldRevert() public { + uint256[] memory newPublicInputs = publicInputs; + newPublicInputs[0] = 0; + + vm.expectRevert(bytes("invalid quotient evaluation")); + verifier.verify(newPublicInputs, serializedProof); + } + + function testVerificationKeyHash() public virtual { + bytes32 verificationKeyHash = verifier.verificationKeyHash(); + assertEq(verificationKeyHash, 0x6625fa96781746787b58306d414b1e25bd706d37d883a9b3acf57b2bd5e0de52); + } +} diff --git a/l2-contracts/test/foundry/unit/verifier/VerifierRecursive.t.sol b/l2-contracts/test/foundry/unit/verifier/VerifierRecursive.t.sol new file mode 100644 index 000000000..df43a07ed --- /dev/null +++ b/l2-contracts/test/foundry/unit/verifier/VerifierRecursive.t.sol @@ -0,0 +1,56 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.24; + +import {VerifierTestTest} from "./Verifier.t.sol"; +import {VerifierRecursiveTest} from "contracts/dev-contracts/VerifierRecursiveTest.sol"; + +contract VerifierRecursiveTestTest is VerifierTestTest { + function setUp() public override { + super.setUp(); + + serializedProof.push(2257920826825449939414463854743099397427742128922725774525544832270890253504); + serializedProof.push(9091218701914748532331969127001446391756173432977615061129552313204917562530); + serializedProof.push(16188304989094043810949359833767911976672882599560690320245309499206765021563); + serializedProof.push(3201093556796962656759050531176732990872300033146738631772984017549903765305); + + verifier = new VerifierRecursiveTest(); + } + + function testMoreThan4WordsRecursiveInput_shouldRevert() public { + uint256[] memory newSerializedProof = new uint256[](serializedProof.length + 1); + + for (uint256 i = 0; i < serializedProof.length; i++) { + newSerializedProof[i] = serializedProof[i]; + } + newSerializedProof[newSerializedProof.length - 1] = serializedProof[serializedProof.length - 1]; + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testEmptyRecursiveInput_shouldRevert() public { + uint256[] memory newSerializedProof = new uint256[](serializedProof.length - 4); + for (uint256 i = 0; i < newSerializedProof.length; i++) { + newSerializedProof[i] = serializedProof[i]; + } + + vm.expectRevert(bytes("loadProof: Proof is invalid")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testInvalidRecursiveInput_shouldRevert() public { + uint256[] memory newSerializedProof = serializedProof; + newSerializedProof[newSerializedProof.length - 4] = 1; + newSerializedProof[newSerializedProof.length - 3] = 2; + newSerializedProof[newSerializedProof.length - 2] = 1; + newSerializedProof[newSerializedProof.length - 1] = 2; + + vm.expectRevert(bytes("finalPairing: pairing failure")); + verifier.verify(publicInputs, newSerializedProof); + } + + function testVerificationKeyHash() public override { + bytes32 verificationKeyHash = verifier.verificationKeyHash(); + assertEq(verificationKeyHash, 0x88b3ddc4ed85974c7e14297dcad4097169440305c05fdb6441ca8dfd77cd7fa7); + } +} diff --git a/l2-contracts/test/test-utils.ts b/l2-contracts/test/test-utils.ts deleted file mode 100644 index 241a32a49..000000000 --- a/l2-contracts/test/test-utils.ts +++ /dev/null @@ -1,57 +0,0 @@ -import { ethers } from "ethers"; -import * as hre from "hardhat"; -import * as zksync from "zksync-ethers"; -import type { BytesLike } from "ethers"; -import { ContractDeployerFactory } from "../typechain/ContractDeployerFactory"; - -const L1_TO_L2_ALIAS_OFFSET = "0x1111000000000000000000000000000000001111"; -const ADDRESS_MODULO = ethers.BigNumber.from(2).pow(160); - -export function unapplyL1ToL2Alias(address: string): string { - // We still add ADDRESS_MODULO to avoid negative numbers - return ethers.utils.hexlify( - ethers.BigNumber.from(address).sub(L1_TO_L2_ALIAS_OFFSET).add(ADDRESS_MODULO).mod(ADDRESS_MODULO) - ); -} - -// Force deploy bytecode on the address -export async function setCode( - deployerWallet: zksync.Wallet, - address: string, - bytecode: BytesLike, - callConstructor: boolean = false, - constructorArgs: BytesLike -) { - const REAL_DEPLOYER_SYSTEM_CONTRACT_ADDRESS = "0x0000000000000000000000000000000000008006"; - // TODO: think about factoryDeps with eth_sendTransaction - try { - // publish bytecode in a separate tx - await publishBytecode(bytecode, deployerWallet); - } catch { - // ignore error - } - - const deployerAccount = await hre.ethers.getImpersonatedSigner(REAL_DEPLOYER_SYSTEM_CONTRACT_ADDRESS); - const deployerContract = ContractDeployerFactory.connect(REAL_DEPLOYER_SYSTEM_CONTRACT_ADDRESS, deployerAccount); - - const deployment = { - bytecodeHash: zksync.utils.hashBytecode(bytecode), - newAddress: address, - callConstructor, - value: 0, - input: constructorArgs, - }; - await deployerContract.forceDeployOnAddress(deployment, ethers.constants.AddressZero); -} - -export async function publishBytecode(bytecode: BytesLike, deployerWallet: zksync.Wallet) { - await deployerWallet.sendTransaction({ - type: 113, - to: ethers.constants.AddressZero, - data: "0x", - customData: { - factoryDeps: [ethers.utils.hexlify(bytecode)], - gasPerPubdata: 50000, - }, - }); -} diff --git a/l2-contracts/test/weth.test.ts b/l2-contracts/test/weth.test.ts deleted file mode 100644 index 79d8e7504..000000000 --- a/l2-contracts/test/weth.test.ts +++ /dev/null @@ -1,132 +0,0 @@ -import { Deployer } from "@matterlabs/hardhat-zksync-deploy"; -import { expect } from "chai"; -import { ethers } from "ethers"; -import * as hre from "hardhat"; -import { Provider, Wallet } from "zksync-ethers"; -import type { L2WrappedBaseToken } from "../typechain/L2WrappedBaseToken"; -import type { L2AssetRouter } from "../typechain/L2AssetRouter"; -import { L2AssetRouterFactory } from "../typechain/L2AssetRouterFactory"; -import { L2WrappedBaseTokenFactory } from "../typechain/L2WrappedBaseTokenFactory"; - -const richAccount = { - address: "0x36615Cf349d7F6344891B1e7CA7C72883F5dc049", - privateKey: "0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110", -}; - -const eth18 = ethers.utils.parseEther("18"); -const testChainId = 9; - -describe("WETH token & WETH bridge", function () { - const provider = new Provider(hre.config.networks.localhost.url); - const wallet = new Wallet(richAccount.privateKey, provider); - let wethToken: L2WrappedBaseToken; - let wethBridge: L2AssetRouter; - - before("Deploy token and bridge", async function () { - const deployer = new Deployer(hre, wallet); - const wethTokenImpl = await deployer.deploy(await deployer.loadArtifact("L2WrappedBaseToken")); - const wethBridgeImpl = await deployer.deploy(await deployer.loadArtifact("L2AssetRouter"), [ - testChainId, - 1, - richAccount.address, - richAccount.address, - ]); - const randomAddress = ethers.utils.hexlify(ethers.utils.randomBytes(20)); - - const wethTokenProxy = await deployer.deploy( - await deployer.loadArtifact( - "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol:TransparentUpgradeableProxy" - ), - [wethTokenImpl.address, randomAddress, "0x"] - ); - const wethBridgeProxy = await deployer.deploy( - await deployer.loadArtifact( - "@openzeppelin/contracts-v4/proxy/transparent/TransparentUpgradeableProxy.sol:TransparentUpgradeableProxy" - ), - [wethBridgeImpl.address, randomAddress, "0x"] - ); - - wethToken = L2WrappedBaseTokenFactory.connect(wethTokenProxy.address, wallet); - wethBridge = L2AssetRouterFactory.connect(wethBridgeProxy.address, wallet); - - // await wethToken.initialize(); - await wethToken.initializeV2("Wrapped Ether", "WETH", wethBridge.address, randomAddress); - - // await wethBridge.initialize(randomAddress, randomAddress, wethToken.address); - }); - - it("Should deposit WETH by calling deposit()", async function () { - await wethToken.deposit({ value: eth18 }).then((tx) => tx.wait()); - expect(await wethToken.balanceOf(wallet.address)).to.equal(eth18); - }); - - it("Should deposit WETH by sending", async function () { - await wallet - .sendTransaction({ - to: wethToken.address, - value: eth18, - }) - .then((tx) => tx.wait()); - expect(await wethToken.balanceOf(wallet.address)).to.equal(eth18.mul(2)); - }); - - it("Should fail depositing with random calldata", async function () { - await expect( - wallet.sendTransaction({ - data: ethers.utils.randomBytes(36), - to: wethToken.address, - value: eth18, - gasLimit: 100_000, - }) - ).to.be.reverted; - }); - - it("Should withdraw WETH to L2 ETH", async function () { - await wethToken.withdraw(eth18).then((tx) => tx.wait()); - expect(await wethToken.balanceOf(wallet.address)).to.equal(eth18); - }); - - // bridging not supported - // it("Should withdraw WETH to L1 ETH", async function () { - // await expect(wethBridge.withdraw(wallet.address, wethToken.address, eth18.div(2))) - // .to.emit(wethBridge, "WithdrawalInitiated") - // .and.to.emit(wethToken, "BridgeBurn"); - // expect(await wethToken.balanceOf(wallet.address)).to.equal(eth18.div(2)); - // }); - - it("Should deposit WETH to another account", async function () { - const anotherWallet = new Wallet(ethers.utils.randomBytes(32), provider); - await wethToken.depositTo(anotherWallet.address, { value: eth18 }).then((tx) => tx.wait()); - expect(await wethToken.balanceOf(anotherWallet.address)).to.equal(eth18); - }); - - it("Should withdraw WETH to another account", async function () { - const anotherWallet = new Wallet(ethers.utils.randomBytes(32), provider); - await wethToken.withdrawTo(anotherWallet.address, eth18.div(2)).then((tx) => tx.wait()); - expect(await anotherWallet.getBalance()).to.equal(eth18.div(2)); - expect(await wethToken.balanceOf(wallet.address)).to.equal(eth18.div(2)); - }); - - it("Should fail withdrawing with insufficient balance", async function () { - await expect(wethToken.withdraw(1, { gasLimit: 100_000 })).to.be.reverted; - }); - - // bridging not supported - // it("Should fail depositing directly to WETH bridge", async function () { - // await expect( - // wallet.sendTransaction({ - // to: wethBridge.address, - // value: eth18, - // gasLimit: 100_000, - // }) - // ).to.be.reverted; - // }); - - it("Should fail calling bridgeMint()", async function () { - await expect(await wethToken.bridgeMint(wallet.address, eth18, { gasLimit: 1_000_000 })).to.be.reverted; - }); - - it("Should fail calling bridgeBurn() directly", async function () { - await expect(wethToken.bridgeBurn(wallet.address, eth18, { gasLimit: 100_000 })).to.be.reverted; - }); -}); diff --git a/lib/@matterlabs/zksync-contracts b/lib/@matterlabs/zksync-contracts new file mode 160000 index 000000000..b8449bf9c --- /dev/null +++ b/lib/@matterlabs/zksync-contracts @@ -0,0 +1 @@ +Subproject commit b8449bf9c819098cc8bfee0549ff5094456be51d diff --git a/system-contracts/SystemContractsHashes.json b/system-contracts/SystemContractsHashes.json index abf7c87f1..aba28da40 100644 --- a/system-contracts/SystemContractsHashes.json +++ b/system-contracts/SystemContractsHashes.json @@ -3,50 +3,50 @@ "contractName": "AccountCodeStorage", "bytecodePath": "artifacts-zk/contracts-preprocessed/AccountCodeStorage.sol/AccountCodeStorage.json", "sourceCodePath": "contracts-preprocessed/AccountCodeStorage.sol", - "bytecodeHash": "0x0100005d1aca0cbed0567a1c7e07a1da321386b1665e440da22053addd4639e1", - "sourceCodeHash": "0xea3806fcaf7728463f559fe195d8acdc47a7659d58119e0a51efcf86a691b61b" + "bytecodeHash": "0x0100005d98c166be5bf169f5830a7fe56f591af62454527a598bf38b0a9f876c", + "sourceCodeHash": "0x2e0e09d57a04bd1e722d8bf8c6423fdf3f8bca44e5e8c4f6684f987794be066e" }, { "contractName": "BootloaderUtilities", "bytecodePath": "artifacts-zk/contracts-preprocessed/BootloaderUtilities.sol/BootloaderUtilities.json", "sourceCodePath": "contracts-preprocessed/BootloaderUtilities.sol", - "bytecodeHash": "0x010007c7149301f5f29fa1757a600b5088354d9e280a6d8f69bcce4f2dbce660", - "sourceCodeHash": "0x9d2b7376c4cd9b143ddd5dfe001a9faae99b9125ccd45f2915c3ce0099643ed9" + "bytecodeHash": "0x010007c79d04c5f1985588d02630c260c40edcbb2d663ed4c38c0a1242dc2bcc", + "sourceCodeHash": "0x0f1213c4b95acb71f4ab5d4082cc1aeb2bd5017e1cccd46afc66e53268609d85" }, { "contractName": "ComplexUpgrader", "bytecodePath": "artifacts-zk/contracts-preprocessed/ComplexUpgrader.sol/ComplexUpgrader.json", "sourceCodePath": "contracts-preprocessed/ComplexUpgrader.sol", - "bytecodeHash": "0x0100004deb11ca32277ab54e2d036f4d33b4a7e218ced1fee63b5b4713ff50ff", - "sourceCodeHash": "0xdde7c49a94cc3cd34c3e7ced1b5ba45e4740df68d26243871edbe393e7298f7a" + "bytecodeHash": "0x0100004d8b6a7af5d502b7790ebbf06a6ba21d0ca03ba3ff47d02dd33f4d619e", + "sourceCodeHash": "0x796046a914fb676ba2bbd337b2924311ee2177ce54571c18a2c3945755c83614" }, { "contractName": "Compressor", "bytecodePath": "artifacts-zk/contracts-preprocessed/Compressor.sol/Compressor.json", "sourceCodePath": "contracts-preprocessed/Compressor.sol", - "bytecodeHash": "0x0100013fc989177bcb6ec29d851cd01f845de31963ea5817ea7a684767c36368", - "sourceCodeHash": "0xb0cec0016f481ce023478f71727fbc0d82e967ddc0508e4d47f5c52292a3f790" + "bytecodeHash": "0x0100014bec423120b050d8095b9623455d9b4bca881b9a5f0f434de66574a4ff", + "sourceCodeHash": "0x7240b5fb2ea8e184522e731fb14f764ebae52b8a69d1870a55daedac9a3ed617" }, { "contractName": "ContractDeployer", "bytecodePath": "artifacts-zk/contracts-preprocessed/ContractDeployer.sol/ContractDeployer.json", "sourceCodePath": "contracts-preprocessed/ContractDeployer.sol", - "bytecodeHash": "0x010004e5711fff19f0048d745b0177b8b73952963b6de79ff4e16c902dbcc091", - "sourceCodeHash": "0xea9627fd5e6e905c268ba801e87bf2d9022bea036982d2b54425f2388b27e6b1" + "bytecodeHash": "0x010004e5d3f30278f686e9ad273eb77fa4d41cfd87676e88f33a63cd36329c04", + "sourceCodeHash": "0x92bc09da23ed9d86ba7a84f0dbf48503c99582ae58cdbebbdcc5f14ea1fcf014" }, { "contractName": "Create2Factory", "bytecodePath": "artifacts-zk/contracts-preprocessed/Create2Factory.sol/Create2Factory.json", "sourceCodePath": "contracts-preprocessed/Create2Factory.sol", - "bytecodeHash": "0x0100004937dba13ac3e393def7fe6cf01da88bbe9b087c397e950301fe14377d", - "sourceCodeHash": "0x217e65f55c8add77982171da65e0db8cc10141ba75159af582973b332a4e098a" + "bytecodeHash": "0x01000049ca08dfa946db4521eed61e95a989bc52f15c81f4eaf051649e7b59af", + "sourceCodeHash": "0x114d9322a9ca654989f3e0b3b21f1311dbc4db84f443d054cd414f6414d84de3" }, { "contractName": "DefaultAccount", "bytecodePath": "artifacts-zk/contracts-preprocessed/DefaultAccount.sol/DefaultAccount.json", "sourceCodePath": "contracts-preprocessed/DefaultAccount.sol", - "bytecodeHash": "0x0100055d7adab6efac115df578d88bc113738dc6ad811329c7575c2af3d91756", - "sourceCodeHash": "0xeb5ac8fc83e1c8619db058a9b6973958bd6ed1b6f4938f8f4541d702f12e085d" + "bytecodeHash": "0x0100055d0b56db8580a7cb4191661efc4d56f7ab91831afed87fe98123d987b6", + "sourceCodeHash": "0xebffe840ebbd9329edb1ebff8ca50f6935e7dabcc67194a896fcc2e968d46dfb" }, { "contractName": "EmptyContract", @@ -59,64 +59,64 @@ "contractName": "ImmutableSimulator", "bytecodePath": "artifacts-zk/contracts-preprocessed/ImmutableSimulator.sol/ImmutableSimulator.json", "sourceCodePath": "contracts-preprocessed/ImmutableSimulator.sol", - "bytecodeHash": "0x0100003bf60f81cb3074170af6420e8d74b710fea0b1fa04e291a080ec17f98a", - "sourceCodeHash": "0x4212e99cbc1722887cfb5b4cb967f278ac8642834786f0e3c6f3b324a9316815" + "bytecodeHash": "0x0100003920a44c0179abb18b63287a74e4c68d6dd4c015bed91b5aa8ec60f676", + "sourceCodeHash": "0x9659e69f7db09e8f60a8bb95314b1ed26afcc689851665cf27f5408122f60c98" }, { "contractName": "KnownCodesStorage", "bytecodePath": "artifacts-zk/contracts-preprocessed/KnownCodesStorage.sol/KnownCodesStorage.json", "sourceCodePath": "contracts-preprocessed/KnownCodesStorage.sol", - "bytecodeHash": "0x0100006f5cf65a28234e0791927389664cced66dd3d600aefbe120d63e9debae", - "sourceCodeHash": "0x8da495a9fc5aa0d7d20a165a4fc8bc77012bec29c472015ea5ecc0a2bd706137" + "bytecodeHash": "0x0100006f4f236efe0359b2d01a2c396fe9c2f5d74252b1acbeed29d0610e1280", + "sourceCodeHash": "0xb39b5b81168653e0c5062f7b8e1d6d15a4e186df3317f192f0cb2fc3a74f5448" }, { "contractName": "L1Messenger", "bytecodePath": "artifacts-zk/contracts-preprocessed/L1Messenger.sol/L1Messenger.json", "sourceCodePath": "contracts-preprocessed/L1Messenger.sol", - "bytecodeHash": "0x010001e9765b885f7e6422722e36e6d375beffc916047f5cec419d11d178baea", - "sourceCodeHash": "0xd83b345b8633affb0bba2296fec9424b4fe9483b60c20ca407d755857a385d8e" + "bytecodeHash": "0x010001f7ce693213118f4780607b934fb0be4baece85ae52377a0279d0c027f5", + "sourceCodeHash": "0x8d22a4019347a45cb0c27bed9e98f7033637a7bdcd90fafb1922caa48f2b05de" }, { "contractName": "L2BaseToken", "bytecodePath": "artifacts-zk/contracts-preprocessed/L2BaseToken.sol/L2BaseToken.json", "sourceCodePath": "contracts-preprocessed/L2BaseToken.sol", - "bytecodeHash": "0x0100010517992363aa510731a717db3c7740d1c31e69718090d07f73d47ba960", - "sourceCodeHash": "0x4cdafafd4cfdf410b31641e14487ea657be3af25e5ec1754fcd7ad67ec23d8be" + "bytecodeHash": "0x01000103d8b1dbf62114dbf0fdb7b06e94d372346b1a99936deeb9250c7c264d", + "sourceCodeHash": "0x8bdd2b4d0b53dba84c9f0af250bbaa2aad10b3de6747bba957f0bd3721090dfa" }, { "contractName": "L2GenesisUpgrade", "bytecodePath": "artifacts-zk/contracts-preprocessed/L2GenesisUpgrade.sol/L2GenesisUpgrade.json", "sourceCodePath": "contracts-preprocessed/L2GenesisUpgrade.sol", - "bytecodeHash": "0x010000975d32dfb09a7935f71e54783c30c9eaab051e961d7f834730e52f3a14", - "sourceCodeHash": "0xcb190d0dfd41bbc809409a8aa04a4847b86edfe010b1d75e23b4c8d07b13a9d0" + "bytecodeHash": "0x010000d5c6b00a5ad08e8990515dc11146b4150a2ab27008d78f1928159404b0", + "sourceCodeHash": "0x15bb6f306f209b618ea5e52671757934d306dcb1d53be73ce49cd200ad485688" }, { "contractName": "MsgValueSimulator", "bytecodePath": "artifacts-zk/contracts-preprocessed/MsgValueSimulator.sol/MsgValueSimulator.json", "sourceCodePath": "contracts-preprocessed/MsgValueSimulator.sol", - "bytecodeHash": "0x0100005d3182a51477d7ee3488aafab351bb5f0560412e4df7e5a5e21ca87cd5", - "sourceCodeHash": "0x4834adf62dbaefa1a1c15d36b5ad1bf2826e7d888a17be495f7ed4e4ea381aa8" + "bytecodeHash": "0x0100005d3053405421f29f79d8f9346697c19bbf4d0c1d3f357025ef4073d173", + "sourceCodeHash": "0x082f3dcbc2fe4d93706c86aae85faa683387097d1b676e7ebd00f71ee0f13b71" }, { "contractName": "NonceHolder", "bytecodePath": "artifacts-zk/contracts-preprocessed/NonceHolder.sol/NonceHolder.json", "sourceCodePath": "contracts-preprocessed/NonceHolder.sol", - "bytecodeHash": "0x010000db9e6c4608ca06cd3a69484b23f5e4ee196fa046cb2db8c0b56d3a2163", - "sourceCodeHash": "0xaa2ed3a26af30032c00a612ac327e0cdf5288b7c932ae903462355f863f950cb" + "bytecodeHash": "0x010000d98fcd3f30ceba0dffe1981b7402ac80e15d7f8d07686c94a16d1aef50", + "sourceCodeHash": "0xcd0c0366effebf2c98c58cf96322cc242a2d1c675620ef5514b7ed1f0a869edc" }, { "contractName": "PubdataChunkPublisher", "bytecodePath": "artifacts-zk/contracts-preprocessed/PubdataChunkPublisher.sol/PubdataChunkPublisher.json", "sourceCodePath": "contracts-preprocessed/PubdataChunkPublisher.sol", - "bytecodeHash": "0x01000049825a39e7057700666867a2b2be806c15d9b2addb60d335bb61b405d9", - "sourceCodeHash": "0x0da0d1279f906147a40e278f52bf3e4d5d4f24225935e4611cc04f4b387b5286" + "bytecodeHash": "0x010000496b83c897843f12da4672f6b3e549a949f7d2078b3f56c3221ed62a68", + "sourceCodeHash": "0x04d3d2e4019081c87aae5c22a060d84ae2e9d631ebce59801ecce37b9c87e4c7" }, { "contractName": "SystemContext", "bytecodePath": "artifacts-zk/contracts-preprocessed/SystemContext.sol/SystemContext.json", "sourceCodePath": "contracts-preprocessed/SystemContext.sol", - "bytecodeHash": "0x010001a722bf92cd15264a662582a6806db24101493ad7a1f202428a2a10e7bc", - "sourceCodeHash": "0x532a962209042f948e8a13e3f4cf12b6d53631e0fc5fa53083c7e2d8062771c0" + "bytecodeHash": "0x010001a75638c20c20ae71722f6265db5258d2d70b8cdcbc3400c618b113dc5c", + "sourceCodeHash": "0xb3b8c1f57928938ac590984442bc96c2c888282793014845d5ce2f90bbf2677f" }, { "contractName": "EventWriter", @@ -185,35 +185,35 @@ "contractName": "bootloader_test", "bytecodePath": "bootloader/build/artifacts/bootloader_test.yul.zbin", "sourceCodePath": "bootloader/build/bootloader_test.yul", - "bytecodeHash": "0x010003cb983fb1cded326ff4429b8a637a7b045233c427dc498373be58312969", - "sourceCodeHash": "0xa4f83a28bcc3d3a79c197a77de03dce464b2141c3aaf970ad3f3487f41ae5690" + "bytecodeHash": "0x010003cb2fe407ac312db0aa6a6e746ca41cd19ab0eea216a14ec725f5cc7444", + "sourceCodeHash": "0xd7748f25eeb4f17b5d5bc09172f09ffdd9b8a34d011b3fb62aac5b494231b168" }, { "contractName": "fee_estimate", "bytecodePath": "bootloader/build/artifacts/fee_estimate.yul.zbin", "sourceCodePath": "bootloader/build/fee_estimate.yul", - "bytecodeHash": "0x010009559ef1268a8b83687828c5dfc804c58a018028694fc931df712fb67f58", - "sourceCodeHash": "0xe7970c1738f2817b50bfcd16038227c5c059f12309407977df453bc6d365d31e" + "bytecodeHash": "0x01000931a58a1d205bdf0b87674e56f96bb5f2192173c96a07886121b6867c47", + "sourceCodeHash": "0x67877a2bd129d189c32e63333325fff1e0ee19650a270b6bfa55906e1eaa79d6" }, { "contractName": "gas_test", "bytecodePath": "bootloader/build/artifacts/gas_test.yul.zbin", "sourceCodePath": "bootloader/build/gas_test.yul", - "bytecodeHash": "0x010008db4c71130d6a96d77f2d3bf3573a5cddc72ecee030ecc9c3bc22764039", - "sourceCodeHash": "0x1b6ef61d0dbbbaa049946b95dc6d12d9335baed03b8c3364a0cbdb404495c045" + "bytecodeHash": "0x010008b7e13ae7b54e537ea6f7b4e030f7b3c81e44b05f41dea2eb13c19e6235", + "sourceCodeHash": "0xa173ad90cabe1b3431ee803b2c9b3943ece686c98df1600dad4cec28f5a027c8" }, { "contractName": "playground_batch", "bytecodePath": "bootloader/build/artifacts/playground_batch.yul.zbin", "sourceCodePath": "bootloader/build/playground_batch.yul", - "bytecodeHash": "0x0100095b01a95cb5caa633702442aeeac8ea64bf4dab31d534e0bb815b5c2820", - "sourceCodeHash": "0xb5a2f9d7d8990f9a1296f699573a5dffe3a1d2ed53d9d3c60b313cd9443221ab" + "bytecodeHash": "0x010009358206ce648b88a76f3199a3ea0c0e1183a9ebfca11cdcba924453db98", + "sourceCodeHash": "0xda17354bca78e6b816ce8f7d1d7ff45e1c5ed0cd9f6ea0437b7cac614ff2019c" }, { "contractName": "proved_batch", "bytecodePath": "bootloader/build/artifacts/proved_batch.yul.zbin", "sourceCodePath": "bootloader/build/proved_batch.yul", - "bytecodeHash": "0x010008eba57f69c88344eced34109c75d34b4bf84db66f47b47b4579b930355e", - "sourceCodeHash": "0xb7697ee1c00b1b8af52c166e3a6deb862281616ca8861ab3aa0b51e34aed8715" + "bytecodeHash": "0x010008c753336bc8d1ddca235602b9f31d346412b2d463cd342899f7bfb73baf", + "sourceCodeHash": "0x7a5776e8001a2d93e14165af0b08cadcf1170354401d0c31fdc0d2a8f8439989" } ] diff --git a/system-contracts/bootloader/bootloader.yul b/system-contracts/bootloader/bootloader.yul index d655630b2..1c58a3bf7 100644 --- a/system-contracts/bootloader/bootloader.yul +++ b/system-contracts/bootloader/bootloader.yul @@ -2690,7 +2690,7 @@ object "Bootloader" { // Third slot -- length of pubdata let len := mload(add(ptr, 96)) - // 4 bytes for selector, 32 bytes for ABI-encoded l2 DA validator address, + // 4 bytes for selector, 32 bytes for ABI-encoded L2 DA validator address, // 32 bytes for array offset and 32 bytes for array length let fullLen := add(len, 100) @@ -3900,17 +3900,17 @@ object "Bootloader" { /// @dev Log key used by Executor.sol for processing. See Constants.sol::SystemLogKey enum function chainedPriorityTxnHashLogKey() -> ret { - ret := 5 + ret := 3 } /// @dev Log key used by Executor.sol for processing. See Constants.sol::SystemLogKey enum function numberOfLayer1TxsLogKey() -> ret { - ret := 6 + ret := 4 } /// @dev Log key used by Executor.sol for processing. See Constants.sol::SystemLogKey enum function protocolUpgradeTxHashKey() -> ret { - ret := 9 + ret := 7 } //////////////////////////////////////////////////////////////////////////// diff --git a/system-contracts/bootloader/tests/bootloader/bootloader_test.yul b/system-contracts/bootloader/tests/bootloader/bootloader_test.yul index 7658ae9bb..9e620fccf 100644 --- a/system-contracts/bootloader/tests/bootloader/bootloader_test.yul +++ b/system-contracts/bootloader/tests/bootloader/bootloader_test.yul @@ -105,7 +105,7 @@ function TEST_systemLogKeys() { let numberOfLayer1TxsLogKey := numberOfLayer1TxsLogKey() let protocolUpgradeTxHashKey := protocolUpgradeTxHashKey() - testing_assertEq(chainedPriorityTxnHashLogKey, 5, "Invalid priority txn hash log key") - testing_assertEq(numberOfLayer1TxsLogKey, 6, "Invalid num layer 1 txns log key") - testing_assertEq(protocolUpgradeTxHashKey, 9, "Invalid protocol upgrade txn hash log key") + testing_assertEq(chainedPriorityTxnHashLogKey, 3, "Invalid priority txn hash log key") + testing_assertEq(numberOfLayer1TxsLogKey, 4, "Invalid num layer 1 txns log key") + testing_assertEq(protocolUpgradeTxHashKey, 7, "Invalid protocol upgrade txn hash log key") } diff --git a/system-contracts/contracts/Constants.sol b/system-contracts/contracts/Constants.sol index 5bd691bdb..6db2071f2 100644 --- a/system-contracts/contracts/Constants.sol +++ b/system-contracts/contracts/Constants.sol @@ -8,6 +8,7 @@ import {IContractDeployer} from "./interfaces/IContractDeployer.sol"; import {IKnownCodesStorage} from "./interfaces/IKnownCodesStorage.sol"; import {IImmutableSimulator} from "./interfaces/IImmutableSimulator.sol"; import {IBaseToken} from "./interfaces/IBaseToken.sol"; +import {IBridgehub} from "./interfaces/IBridgehub.sol"; import {IL1Messenger} from "./interfaces/IL1Messenger.sol"; import {ISystemContext} from "./interfaces/ISystemContext.sol"; import {ICompressor} from "./interfaces/ICompressor.sol"; @@ -72,6 +73,8 @@ address constant MSG_VALUE_SYSTEM_CONTRACT = address(SYSTEM_CONTRACTS_OFFSET + 0 IBaseToken constant BASE_TOKEN_SYSTEM_CONTRACT = IBaseToken(address(SYSTEM_CONTRACTS_OFFSET + 0x0a)); IBaseToken constant REAL_BASE_TOKEN_SYSTEM_CONTRACT = IBaseToken(address(REAL_SYSTEM_CONTRACTS_OFFSET + 0x0a)); +address constant L2_ASSET_ROUTER = address(USER_CONTRACTS_OFFSET + 0x03); +IBridgehub constant L2_BRIDGE_HUB = IBridgehub(address(USER_CONTRACTS_OFFSET + 0x02)); IMessageRoot constant L2_MESSAGE_ROOT = IMessageRoot(address(USER_CONTRACTS_OFFSET + 0x05)); // Hardcoded because even for tests we should keep the address. (Instead `SYSTEM_CONTRACTS_OFFSET + 0x10`) @@ -114,8 +117,6 @@ uint256 constant STATE_DIFF_ENTRY_SIZE = 272; enum SystemLogKey { L2_TO_L1_LOGS_TREE_ROOT_KEY, - TOTAL_L2_TO_L1_PUBDATA_KEY, - STATE_DIFF_HASH_KEY, PACKED_BATCH_AND_L2_BLOCK_TIMESTAMP_KEY, PREV_BATCH_HASH_KEY, CHAINED_PRIORITY_TXN_HASH_KEY, diff --git a/system-contracts/contracts/L1Messenger.sol b/system-contracts/contracts/L1Messenger.sol index d79b129f7..0f9242ef1 100644 --- a/system-contracts/contracts/L1Messenger.sol +++ b/system-contracts/contracts/L1Messenger.sol @@ -245,6 +245,16 @@ contract L1Messenger is IL1Messenger, SystemContractBase { ); } calldataPtr += 32; + + uint256 offset = uint256(bytes32(_operatorInput[calldataPtr:calldataPtr + 32])); + // The length of the pubdata input should be stored right next to the calldata. + // We need to change offset by 32 - 4 = 28 bytes, since 32 bytes is the length of the offset + // itself and the 4 bytes are the selector which is not included inside the offset. + if (offset != calldataPtr + 28) { + revert ReconstructionMismatch(PubdataField.Offset, bytes32(calldataPtr + 28), bytes32(offset)); + } + uint256 length = uint256(bytes32(_operatorInput[calldataPtr + 32:calldataPtr + 64])); + // Shift calldata ptr past the pubdata offset and len calldataPtr += 64; @@ -259,6 +269,15 @@ contract L1Messenger is IL1Messenger, SystemContractBase { } calldataPtr += 4; + // We need to ensure that length is enough to read all logs + if (length < 4 + numberOfL2ToL1Logs * L2_TO_L1_LOG_SERIALIZE_SIZE) { + revert ReconstructionMismatch( + PubdataField.Length, + bytes32(4 + numberOfL2ToL1Logs * L2_TO_L1_LOG_SERIALIZE_SIZE), + bytes32(length) + ); + } + bytes32[] memory l2ToL1LogsTreeArray = new bytes32[](L2_TO_L1_LOGS_MERKLE_TREE_LEAVES); bytes32 reconstructedChainedLogsHash = bytes32(0); for (uint256 i = 0; i < numberOfL2ToL1Logs; ++i) { diff --git a/system-contracts/contracts/L2GenesisUpgrade.sol b/system-contracts/contracts/L2GenesisUpgrade.sol index b680493fb..fbb3a1e30 100644 --- a/system-contracts/contracts/L2GenesisUpgrade.sol +++ b/system-contracts/contracts/L2GenesisUpgrade.sol @@ -1,9 +1,10 @@ // SPDX-License-Identifier: MIT -pragma solidity 0.8.20; +pragma solidity 0.8.24; -import {DEPLOYER_SYSTEM_CONTRACT, SYSTEM_CONTEXT_CONTRACT} from "./Constants.sol"; +import {DEPLOYER_SYSTEM_CONTRACT, SYSTEM_CONTEXT_CONTRACT, L2_BRIDGE_HUB, L2_ASSET_ROUTER, L2_MESSAGE_ROOT} from "./Constants.sol"; import {IContractDeployer, ForceDeployment} from "./interfaces/IContractDeployer.sol"; +import {SystemContractHelper} from "./libraries/SystemContractHelper.sol"; import {ISystemContext} from "./interfaces/ISystemContext.sol"; import {IL2GenesisUpgrade} from "./interfaces/IL2GenesisUpgrade.sol"; @@ -11,12 +12,41 @@ import {IL2GenesisUpgrade} from "./interfaces/IL2GenesisUpgrade.sol"; /// @author Matter Labs /// @notice The contract that can be used for deterministic contract deployment. contract L2GenesisUpgrade is IL2GenesisUpgrade { - function genesisUpgrade(uint256 _chainId, bytes calldata _forceDeploymentsData) external payable { + function genesisUpgrade( + uint256 _chainId, + address _ctmDeployer, + bytes calldata _forceDeploymentsData + ) external payable { // solhint-disable-next-line gas-custom-errors require(_chainId != 0, "Invalid chainId"); ISystemContext(SYSTEM_CONTEXT_CONTRACT).setChainId(_chainId); ForceDeployment[] memory forceDeployments = abi.decode(_forceDeploymentsData, (ForceDeployment[])); IContractDeployer(DEPLOYER_SYSTEM_CONTRACT).forceDeployOnAddresses{value: msg.value}(forceDeployments); + + // It is expected that either via to the force deployments above + // or upon init both the L2 deployment of Bridgehub, AssetRouter and MessageRoot are deployed. + // (The comment does not mention the exact order in case it changes) + // However, there is still some follow up finalization that needs to be done. + + address bridgehubOwner = L2_BRIDGE_HUB.owner(); + + bytes memory data = abi.encodeCall( + L2_BRIDGE_HUB.setAddresses, + (L2_ASSET_ROUTER, _ctmDeployer, address(L2_MESSAGE_ROOT)) + ); + + (bool success, bytes memory returnData) = SystemContractHelper.mimicCall( + address(L2_BRIDGE_HUB), + bridgehubOwner, + data + ); + if (!success) { + // Propagate revert reason + assembly { + revert(add(returnData, 0x20), returndatasize()) + } + } + emit UpgradeComplete(_chainId); } } diff --git a/system-contracts/contracts/PubdataChunkPublisher.sol b/system-contracts/contracts/PubdataChunkPublisher.sol index 2f48a9626..f61f0b5ac 100644 --- a/system-contracts/contracts/PubdataChunkPublisher.sol +++ b/system-contracts/contracts/PubdataChunkPublisher.sol @@ -2,6 +2,7 @@ pragma solidity 0.8.24; import {IPubdataChunkPublisher} from "./interfaces/IPubdataChunkPublisher.sol"; +import {SystemContractBase} from "./abstract/SystemContractBase.sol"; import {BLOB_SIZE_BYTES, MAX_NUMBER_OF_BLOBS} from "./Constants.sol"; import {TooMuchPubdata} from "./SystemContractErrors.sol"; diff --git a/system-contracts/contracts/SystemContractErrors.sol b/system-contracts/contracts/SystemContractErrors.sol index 017b1a3aa..d61e99c10 100644 --- a/system-contracts/contracts/SystemContractErrors.sol +++ b/system-contracts/contracts/SystemContractErrors.sol @@ -129,13 +129,13 @@ enum PubdataField { LogsHash, MsgHash, Bytecode, - StateDiffCompressionVersion, - ExtraData, InputDAFunctionSig, InputLogsHash, InputLogsRootHash, InputMsgsHash, - InputBytecodeHash + InputBytecodeHash, + Offset, + Length } enum BytecodeError { diff --git a/system-contracts/contracts/interfaces/IBridgehub.sol b/system-contracts/contracts/interfaces/IBridgehub.sol new file mode 100644 index 000000000..210fc287a --- /dev/null +++ b/system-contracts/contracts/interfaces/IBridgehub.sol @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: MIT +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. +pragma solidity ^0.8.20; + +/// @author Matter Labs +/// @custom:security-contact security@matterlabs.dev +interface IBridgehub { + function setAddresses(address _assetRouter, address _ctmDeployer, address _messageRoot) external; + + function owner() external view returns (address); +} diff --git a/system-contracts/contracts/interfaces/IL2DAValidator.sol b/system-contracts/contracts/interfaces/IL2DAValidator.sol index 4c8c6d4c4..02e5bf953 100644 --- a/system-contracts/contracts/interfaces/IL2DAValidator.sol +++ b/system-contracts/contracts/interfaces/IL2DAValidator.sol @@ -1,5 +1,5 @@ // SPDX-License-Identifier: MIT -// We use a floating point pragma here so it can be used within other projects that interact with the zkSync ecosystem without using our exact pragma version. +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.20; interface IL2DAValidator { diff --git a/system-contracts/contracts/interfaces/IL2GenesisUpgrade.sol b/system-contracts/contracts/interfaces/IL2GenesisUpgrade.sol index 96744b152..2b733cddb 100644 --- a/system-contracts/contracts/interfaces/IL2GenesisUpgrade.sol +++ b/system-contracts/contracts/interfaces/IL2GenesisUpgrade.sol @@ -1,9 +1,13 @@ // SPDX-License-Identifier: MIT -// We use a floating point pragma here so it can be used within other projects that interact with the zkSync ecosystem without using our exact pragma version. +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. pragma solidity ^0.8.20; interface IL2GenesisUpgrade { event UpgradeComplete(uint256 _chainId); - function genesisUpgrade(uint256 _chainId, bytes calldata _forceDeploymentsData) external payable; + function genesisUpgrade( + uint256 _chainId, + address _ctmDeployer, + bytes calldata _forceDeploymentsData + ) external payable; } diff --git a/system-contracts/contracts/interfaces/IMessageRoot.sol b/system-contracts/contracts/interfaces/IMessageRoot.sol index f158b4918..854508eb1 100644 --- a/system-contracts/contracts/interfaces/IMessageRoot.sol +++ b/system-contracts/contracts/interfaces/IMessageRoot.sol @@ -1,6 +1,6 @@ // SPDX-License-Identifier: MIT - -pragma solidity 0.8.20; +// We use a floating point pragma here so it can be used within other projects that interact with the ZKsync ecosystem without using our exact pragma version. +pragma solidity ^0.8.20; interface IMessageRoot { function getAggregatedRoot() external view returns (bytes32 aggregatedRoot); diff --git a/system-contracts/contracts/libraries/SystemContractHelper.sol b/system-contracts/contracts/libraries/SystemContractHelper.sol index e8469e308..77407b2cd 100644 --- a/system-contracts/contracts/libraries/SystemContractHelper.sol +++ b/system-contracts/contracts/libraries/SystemContractHelper.sol @@ -4,7 +4,7 @@ pragma solidity ^0.8.20; import {MAX_SYSTEM_CONTRACT_ADDRESS} from "../Constants.sol"; -import {CALLFLAGS_CALL_ADDRESS, CODE_ADDRESS_CALL_ADDRESS, EVENT_WRITE_ADDRESS, EVENT_INITIALIZE_ADDRESS, GET_EXTRA_ABI_DATA_ADDRESS, LOAD_CALLDATA_INTO_ACTIVE_PTR_CALL_ADDRESS, META_CODE_SHARD_ID_OFFSET, META_CALLER_SHARD_ID_OFFSET, META_SHARD_ID_OFFSET, META_AUX_HEAP_SIZE_OFFSET, META_HEAP_SIZE_OFFSET, META_PUBDATA_PUBLISHED_OFFSET, META_CALL_ADDRESS, PTR_CALLDATA_CALL_ADDRESS, PTR_ADD_INTO_ACTIVE_CALL_ADDRESS, PTR_SHRINK_INTO_ACTIVE_CALL_ADDRESS, PTR_PACK_INTO_ACTIVE_CALL_ADDRESS, PRECOMPILE_CALL_ADDRESS, SET_CONTEXT_VALUE_CALL_ADDRESS, TO_L1_CALL_ADDRESS} from "./SystemContractsCaller.sol"; +import {CalldataForwardingMode, SystemContractsCaller, MIMIC_CALL_CALL_ADDRESS, CALLFLAGS_CALL_ADDRESS, CODE_ADDRESS_CALL_ADDRESS, EVENT_WRITE_ADDRESS, EVENT_INITIALIZE_ADDRESS, GET_EXTRA_ABI_DATA_ADDRESS, LOAD_CALLDATA_INTO_ACTIVE_PTR_CALL_ADDRESS, META_CODE_SHARD_ID_OFFSET, META_CALLER_SHARD_ID_OFFSET, META_SHARD_ID_OFFSET, META_AUX_HEAP_SIZE_OFFSET, META_HEAP_SIZE_OFFSET, META_PUBDATA_PUBLISHED_OFFSET, META_CALL_ADDRESS, PTR_CALLDATA_CALL_ADDRESS, PTR_ADD_INTO_ACTIVE_CALL_ADDRESS, PTR_SHRINK_INTO_ACTIVE_CALL_ADDRESS, PTR_PACK_INTO_ACTIVE_CALL_ADDRESS, PRECOMPILE_CALL_ADDRESS, SET_CONTEXT_VALUE_CALL_ADDRESS, TO_L1_CALL_ADDRESS} from "./SystemContractsCaller.sol"; import {IndexOutOfBounds, FailedToChargeGas} from "../SystemContractErrors.sol"; uint256 constant UINT32_MASK = type(uint32).max; @@ -358,4 +358,47 @@ library SystemContractHelper { revert FailedToChargeGas(); } } + + /// @notice Performs a `mimicCall` to an address. + /// @param _to The address to call. + /// @param _whoToMimic The address to mimic. + /// @param _data The data to pass to the call. + /// @return success Whether the call was successful. + /// @return returndata The return data of the call. + function mimicCall( + address _to, + address _whoToMimic, + bytes memory _data + ) internal returns (bool success, bytes memory returndata) { + // In zkSync, no memory-related values can exceed uint32, so it is safe to convert here + uint32 dataStart; + uint32 dataLength = uint32(_data.length); + assembly { + dataStart := add(_data, 0x20) + } + + uint256 farCallAbi = SystemContractsCaller.getFarCallABI({ + dataOffset: 0, + memoryPage: 0, + dataStart: dataStart, + dataLength: dataLength, + gasPassed: uint32(gasleft()), + shardId: 0, + forwardingMode: CalldataForwardingMode.UseHeap, + isConstructorCall: false, + isSystemCall: false + }); + + address callAddr = MIMIC_CALL_CALL_ADDRESS; + uint256 rtSize; + assembly { + success := call(_to, callAddr, 0, farCallAbi, _whoToMimic, 0, 0) + rtSize := returndatasize() + } + + returndata = new bytes(rtSize); + assembly { + returndatacopy(add(returndata, 0x20), 0, rtSize) + } + } } diff --git a/system-contracts/package.json b/system-contracts/package.json index 70e7208b7..ab9f8d60e 100644 --- a/system-contracts/package.json +++ b/system-contracts/package.json @@ -14,7 +14,8 @@ "ethers": "^5.7.0", "fast-glob": "^3.3.2", "hardhat": "=2.22.2", - "preprocess": "^3.2.0" + "preprocess": "^3.2.0", + "zksync-ethers": "^5.9.0" }, "devDependencies": { "@matterlabs/hardhat-zksync-chai-matchers": "^0.2.0", @@ -66,6 +67,7 @@ "preprocess:system-contracts": "rm -rf ./contracts-preprocessed && ts-node scripts/preprocess-system-contracts.ts", "verify-on-explorer": "hardhat run scripts/verify-on-explorer.ts", "test": "yarn build:test-system-contracts && hardhat test --network zkSyncTestNode", + "test-no-build": "hardhat test --network zkSyncTestNode", "test-node": "hardhat node-zksync --tag v0.0.1-vm1.5.0", "test:bootloader": "cd bootloader/test_infra && cargo run" } diff --git a/system-contracts/scripts/utils.ts b/system-contracts/scripts/utils.ts index 8f63cd004..4c1060ee2 100644 --- a/system-contracts/scripts/utils.ts +++ b/system-contracts/scripts/utils.ts @@ -16,7 +16,7 @@ import path from "path"; import { spawn as _spawn } from "child_process"; import { createHash } from "crypto"; import { CompilerDownloader } from "hardhat/internal/solidity/compiler/downloader"; -import fetch from 'node-fetch'; +import fetch from "node-fetch"; export type HttpMethod = "POST" | "GET"; diff --git a/system-contracts/scripts/verify-on-explorer.ts b/system-contracts/scripts/verify-on-explorer.ts index 95fa65218..9aa37e3e6 100644 --- a/system-contracts/scripts/verify-on-explorer.ts +++ b/system-contracts/scripts/verify-on-explorer.ts @@ -6,7 +6,7 @@ import { SYSTEM_CONTRACTS } from "./constants"; import { query } from "./utils"; import { Command } from "commander"; import * as fs from "fs"; -import { sleep } from "zksync-ethers/build/src/utils"; +import { sleep } from "zksync-ethers/build/utils"; const VERIFICATION_URL = hre.network?.config?.verifyURL; diff --git a/system-contracts/test/L1Messenger.spec.ts b/system-contracts/test/L1Messenger.spec.ts index a67d4089f..225b197d6 100644 --- a/system-contracts/test/L1Messenger.spec.ts +++ b/system-contracts/test/L1Messenger.spec.ts @@ -1,32 +1,33 @@ import { ethers, network } from "hardhat"; import type { L1Messenger } from "../typechain"; +import { IL2DAValidatorFactory } from "../typechain/IL2DAValidatorFactory"; import { L1MessengerFactory } from "../typechain"; import { prepareEnvironment, setResult } from "./shared/mocks"; -import type { StateDiff } from "./shared/utils"; -import { compressStateDiffs, deployContractOnAddress, encodeStateDiffs, getCode, getWallets } from "./shared/utils"; -import { utils } from "zksync-ethers"; +import { deployContractOnAddress, getCode, getWallets } from "./shared/utils"; +import { utils, L2VoidSigner } from "zksync-ethers"; import type { Wallet } from "zksync-ethers"; import { TEST_KNOWN_CODE_STORAGE_CONTRACT_ADDRESS, TEST_L1_MESSENGER_SYSTEM_CONTRACT_ADDRESS, TEST_BOOTLOADER_FORMAL_ADDRESS, - TWO_IN_256, } from "./shared/constants"; import { expect } from "chai"; -import { BigNumber } from "ethers"; import { randomBytes } from "crypto"; -// FIXME: restore the test after the changes from the custom DA integration -describe.skip("L1Messenger tests", () => { +const EXPECTED_DA_INPUT_OFFSET = 160; +const L2_TO_L1_LOGS_MERKLE_TREE_LEAVES = 16_384; +const L2_TO_L1_LOG_SERIALIZE_SIZE = 88; +const L2_L1_LOGS_TREE_DEFAULT_LEAF_HASH = "0x72abee45b59e344af8a6e520241c4744aff26ed411f4c4b00f8af09adada43ba"; + +describe("L1Messenger tests", () => { let l1Messenger: L1Messenger; let wallet: Wallet; let l1MessengerAccount: ethers.Signer; let knownCodeStorageAccount: ethers.Signer; let bootloaderAccount: ethers.Signer; - let stateDiffsSetupData: StateDiffSetupData; let logData: LogData; - let bytecodeData: ContentLengthPair; let emulator: L1MessengerPubdataEmulator; + let bytecode; before(async () => { await prepareEnvironment(); @@ -37,13 +38,16 @@ describe.skip("L1Messenger tests", () => { knownCodeStorageAccount = await ethers.getImpersonatedSigner(TEST_KNOWN_CODE_STORAGE_CONTRACT_ADDRESS); bootloaderAccount = await ethers.getImpersonatedSigner(TEST_BOOTLOADER_FORMAL_ADDRESS); // setup - stateDiffsSetupData = await setupStateDiffs(); logData = setupLogData(l1MessengerAccount, l1Messenger); - bytecodeData = await setupBytecodeData(ethers.constants.AddressZero); + bytecode = await getCode(TEST_L1_MESSENGER_SYSTEM_CONTRACT_ADDRESS); await setResult("SystemContext", "txNumberInBlock", [], { failure: false, returnData: ethers.utils.defaultAbiCoder.encode(["uint16"], [1]), }); + await setResult("IMessageRoot", "getAggregatedRoot", [], { + failure: false, + returnData: ethers.constants.HashZero, + }); emulator = new L1MessengerPubdataEmulator(); }); @@ -51,7 +55,10 @@ describe.skip("L1Messenger tests", () => { // cleaning the state of l1Messenger await l1Messenger .connect(bootloaderAccount) - .publishPubdataAndClearState(emulator.buildTotalL2ToL1PubdataAndStateDiffs()); + .publishPubdataAndClearState( + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger) + ); await network.provider.request({ method: "hardhat_stopImpersonatingAccount", params: [TEST_L1_MESSENGER_SYSTEM_CONTRACT_ADDRESS], @@ -74,23 +81,15 @@ describe.skip("L1Messenger tests", () => { emulator.addLog(logData.logs[0].log); await (await l1Messenger.connect(l1MessengerAccount).sendToL1(logData.messages[0].message)).wait(); emulator.addLog(logData.messages[0].log); - emulator.addMessage({ - lengthBytes: logData.messages[0].currentMessageLengthBytes, - content: logData.messages[0].message, - }); - await ( - await l1Messenger - .connect(knownCodeStorageAccount) - .requestBytecodeL1Publication(await ethers.utils.hexlify(utils.hashBytecode(bytecodeData.content)), { - gasLimit: 130000000, - }) - ).wait(); - emulator.addBytecode(bytecodeData); - emulator.setStateDiffsSetupData(stateDiffsSetupData); + await ( await l1Messenger .connect(bootloaderAccount) - .publishPubdataAndClearState(emulator.buildTotalL2ToL1PubdataAndStateDiffs(), { gasLimit: 1000000000 }) + .publishPubdataAndClearState( + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger), + { gasLimit: 1000000000 } + ) ).wait(); }); @@ -99,7 +98,21 @@ describe.skip("L1Messenger tests", () => { await expect( l1Messenger .connect(bootloaderAccount) - .publishPubdataAndClearState(emulator.buildTotalL2ToL1PubdataAndStateDiffs({ numberOfLogs: 0x4002 })) + .publishPubdataAndClearState( + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger, { numberOfLogs: 0x4002 }) + ) + ).to.be.revertedWithCustomError(l1Messenger, "ReconstructionMismatch"); + }); + + it("should revert Invalid input DA signature", async () => { + await expect( + l1Messenger + .connect(bootloaderAccount) + .publishPubdataAndClearState( + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger, { l2DaValidatorFunctionSig: "0x12121212" }) + ) ).to.be.revertedWithCustomError(l1Messenger, "ReconstructionMismatch"); }); @@ -121,50 +134,71 @@ describe.skip("L1Messenger tests", () => { await expect( l1Messenger .connect(bootloaderAccount) - .publishPubdataAndClearState(emulator.buildTotalL2ToL1PubdataAndStateDiffs(overrideData)) + .publishPubdataAndClearState( + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger, overrideData) + ) ).to.be.revertedWithCustomError(l1Messenger, "ReconstructionMismatch"); }); - it("should revert chainedMessageHash mismatch", async () => { - // Buffer.alloc(32, 6), to trigger the revert - const wrongMessage = { lengthBytes: logData.messages[0].currentMessageLengthBytes, content: Buffer.alloc(32, 6) }; - const overrideData = { messages: [...emulator.messages] }; - overrideData.messages[0] = wrongMessage; + it("should revert Invalid input msgs hash", async () => { + const correctChainedMessagesHash = await l1Messenger.provider.getStorageAt(l1Messenger.address, 2); + await expect( - l1Messenger - .connect(bootloaderAccount) - .publishPubdataAndClearState(emulator.buildTotalL2ToL1PubdataAndStateDiffs(overrideData)) + l1Messenger.connect(bootloaderAccount).publishPubdataAndClearState( + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger, { + chainedMessagesHash: ethers.utils.keccak256(correctChainedMessagesHash), + }) + ) ).to.be.revertedWithCustomError(l1Messenger, "ReconstructionMismatch"); }); - it("should revert state diff compression version mismatch", async () => { - await ( - await l1Messenger - .connect(knownCodeStorageAccount) - .requestBytecodeL1Publication(await ethers.utils.hexlify(utils.hashBytecode(bytecodeData.content)), { - gasLimit: 130000000, + it("should revert Invalid bytecodes hash", async () => { + const correctChainedBytecodesHash = await l1Messenger.provider.getStorageAt(l1Messenger.address, 3); + + await expect( + l1Messenger.connect(bootloaderAccount).publishPubdataAndClearState( + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger, { + chainedBytecodeHash: ethers.utils.keccak256(correctChainedBytecodesHash), }) - ).wait(); - // modify version to trigger the revert + ) + ).to.be.revertedWithCustomError(l1Messenger, "ReconstructionMismatch"); + }); + + it("should revert Invalid offset", async () => { await expect( l1Messenger.connect(bootloaderAccount).publishPubdataAndClearState( - emulator.buildTotalL2ToL1PubdataAndStateDiffs({ - version: ethers.utils.hexZeroPad(ethers.utils.hexlify(66), 1), + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger, { + operatorDataOffset: EXPECTED_DA_INPUT_OFFSET + 1, }) ) ).to.be.revertedWithCustomError(l1Messenger, "ReconstructionMismatch"); }); - it("should revert extra data", async () => { - // add extra data to trigger the revert + it("should revert Invalid length", async () => { await expect( l1Messenger .connect(bootloaderAccount) .publishPubdataAndClearState( - ethers.utils.concat([emulator.buildTotalL2ToL1PubdataAndStateDiffs(), Buffer.alloc(1, 64)]) + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger, { operatorDataLength: 1 }) ) ).to.be.revertedWithCustomError(l1Messenger, "ReconstructionMismatch"); }); + + it("should revert Invalid root hash", async () => { + await expect( + l1Messenger.connect(bootloaderAccount).publishPubdataAndClearState( + ethers.constants.AddressZero, + await emulator.buildTotalL2ToL1PubdataAndStateDiffs(l1Messenger, { + chainedLogsRootHash: ethers.constants.HashZero, + }) + ) + ).to.be.revertedWithCustomError(l1Messenger, "ReconstructionMismatch"); + }); }); describe("sendL2ToL1Log", async () => { @@ -236,10 +270,6 @@ describe.skip("L1Messenger tests", () => { .and.to.emit(l1Messenger, "L2ToL1LogSent") .withArgs([0, true, 1, l1Messenger.address, expectedKey, ethers.utils.keccak256(logData.messages[0].message)]); emulator.addLog(logData.messages[0].log); - emulator.addMessage({ - lengthBytes: logData.messages[0].currentMessageLengthBytes, - content: logData.messages[0].message, - }); }); }); @@ -256,85 +286,16 @@ describe.skip("L1Messenger tests", () => { await expect( l1Messenger .connect(knownCodeStorageAccount) - .requestBytecodeL1Publication(await ethers.utils.hexlify(utils.hashBytecode(bytecodeData.content)), { - gasLimit: 130000000, + .requestBytecodeL1Publication(ethers.utils.hexlify(utils.hashBytecode(bytecode)), { + gasLimit: 230000000, }) ) .to.emit(l1Messenger, "BytecodeL1PublicationRequested") - .withArgs(await ethers.utils.hexlify(utils.hashBytecode(bytecodeData.content))); - emulator.addBytecode(bytecodeData); + .withArgs(ethers.utils.hexlify(utils.hashBytecode(bytecode))); }); }); }); -// Interface represents the structure of the data that that is used in totalL2ToL1PubdataAndStateDiffs. -interface StateDiffSetupData { - encodedStateDiffs: string; - compressedStateDiffs: string; - enumerationIndexSizeBytes: string; - numberOfStateDiffsBytes: string; - compressedStateDiffsSizeBytes: string; -} - -async function setupStateDiffs(): Promise { - const stateDiffs: StateDiff[] = [ - { - key: "0x1234567890123456789012345678901234567890123456789012345678901230", - index: 0, - initValue: BigNumber.from("0x1234567890123456789012345678901234567890123456789012345678901231"), - finalValue: BigNumber.from("0x1234567890123456789012345678901234567890123456789012345678901230"), - }, - { - key: "0x1234567890123456789012345678901234567890123456789012345678901232", - index: 1, - initValue: TWO_IN_256.sub(1), - finalValue: BigNumber.from(1), - }, - { - key: "0x1234567890123456789012345678901234567890123456789012345678901234", - index: 0, - initValue: TWO_IN_256.div(2), - finalValue: BigNumber.from(1), - }, - { - key: "0x1234567890123456789012345678901234567890123456789012345678901236", - index: 2323, - initValue: BigNumber.from("0x1234567890123456789012345678901234567890123456789012345678901237"), - finalValue: BigNumber.from("0x0239329298382323782378478237842378478237847237237872373272373272"), - }, - { - key: "0x1234567890123456789012345678901234567890123456789012345678901238", - index: 2, - initValue: BigNumber.from(0), - finalValue: BigNumber.from(1), - }, - ]; - const encodedStateDiffs = encodeStateDiffs(stateDiffs); - const compressedStateDiffs = compressStateDiffs(4, stateDiffs); - const enumerationIndexSizeBytes = ethers.utils.hexZeroPad(ethers.utils.hexlify(4), 1); - await setResult( - "Compressor", - "verifyCompressedStateDiffs", - [stateDiffs.length, 4, encodedStateDiffs, compressedStateDiffs], - { - failure: false, - returnData: ethers.utils.defaultAbiCoder.encode(["bytes32"], [ethers.utils.keccak256(encodedStateDiffs)]), - } - ); - const numberOfStateDiffsBytes = ethers.utils.hexZeroPad(ethers.utils.hexlify(stateDiffs.length), 4); - const compressedStateDiffsSizeBytes = ethers.utils.hexZeroPad( - ethers.utils.hexlify(ethers.utils.arrayify(compressedStateDiffs).length), - 3 - ); - return { - encodedStateDiffs, - compressedStateDiffs, - enumerationIndexSizeBytes, - numberOfStateDiffsBytes, - compressedStateDiffsSizeBytes, - }; -} - // Interface for L2ToL1Log struct. interface L2ToL1Log { l2ShardId: number; @@ -417,47 +378,34 @@ function setupLogData(l1MessengerAccount: ethers.Signer, l1Messenger: L1Messenge }; } -// Represents the structure of the bytecode/message data that is part of the pubdata. -interface ContentLengthPair { - content: string; - lengthBytes: string; -} - -async function setupBytecodeData(l1MessengerAddress: string): Promise { - const content = await getCode(l1MessengerAddress); - const lengthBytes = ethers.utils.hexZeroPad(ethers.utils.hexlify(ethers.utils.arrayify(content).length), 4); - return { - content, - lengthBytes, - }; -} - // Used for emulating the pubdata published by the L1Messenger. class L1MessengerPubdataEmulator implements EmulatorData { numberOfLogs: number; encodedLogs: string[]; - numberOfMessages: number; - messages: ContentLengthPair[]; - numberOfBytecodes: number; - bytecodes: ContentLengthPair[]; - stateDiffsSetupData: StateDiffSetupData; - version: string; + l2DaValidatorFunctionSig: string; + chainedLogsHash: string; + chainedLogsRootHash: string; + operatorDataOffset: number; + operatorDataLength: number; + + // These two fields are always zero, we need + // them just to extend the interface. + chainedMessagesHash: string; + chainedBytecodeHash: string; constructor() { this.numberOfLogs = 0; this.encodedLogs = []; - this.numberOfMessages = 0; - this.messages = []; - this.numberOfBytecodes = 0; - this.bytecodes = []; - this.stateDiffsSetupData = { - compressedStateDiffsSizeBytes: "", - enumerationIndexSizeBytes: "", - compressedStateDiffs: "", - numberOfStateDiffsBytes: "", - encodedStateDiffs: "", - }; - this.version = ethers.utils.hexZeroPad(ethers.utils.hexlify(1), 1); + + const factoryInterface = IL2DAValidatorFactory.connect( + ethers.constants.AddressZero, + new L2VoidSigner(ethers.constants.AddressZero) + ); + this.l2DaValidatorFunctionSig = factoryInterface.interface.getSighash("validatePubdata"); + + this.chainedLogsHash = ethers.constants.HashZero; + this.chainedLogsRootHash = ethers.constants.HashZero; + this.operatorDataOffset = EXPECTED_DA_INPUT_OFFSET; } addLog(log: string): void { @@ -465,70 +413,80 @@ class L1MessengerPubdataEmulator implements EmulatorData { this.numberOfLogs++; } - addMessage(message: ContentLengthPair): void { - this.messages.push(message); - this.numberOfMessages++; - } - - addBytecode(bytecode: ContentLengthPair): void { - this.bytecodes.push(bytecode); - this.numberOfBytecodes++; - } - - setStateDiffsSetupData(data: StateDiffSetupData) { - this.stateDiffsSetupData = data; - } + async buildTotalL2ToL1PubdataAndStateDiffs( + l1Messenger: L1Messenger, + overrideData: EmulatorOverrideData = {} + ): Promise { + const storedChainedMessagesHash = await l1Messenger.provider.getStorageAt(l1Messenger.address, 2); + const storedChainedBytecodesHash = await l1Messenger.provider.getStorageAt(l1Messenger.address, 3); - buildTotalL2ToL1PubdataAndStateDiffs(overrideData: EmulatorOverrideData = {}): string { const { + l2DaValidatorFunctionSig = this.l2DaValidatorFunctionSig, + chainedLogsHash = calculateChainedLogsHash(this.encodedLogs), + chainedLogsRootHash = calculateLogsRootHash(this.encodedLogs), + chainedMessagesHash = storedChainedMessagesHash, + chainedBytecodeHash = storedChainedBytecodesHash, + operatorDataOffset = this.operatorDataOffset, numberOfLogs = this.numberOfLogs, encodedLogs = this.encodedLogs, - numberOfMessages = this.numberOfMessages, - messages = this.messages, - numberOfBytecodes = this.numberOfBytecodes, - bytecodes = this.bytecodes, - stateDiffsSetupData = this.stateDiffsSetupData, - version = this.version, } = overrideData; - - const messagePairs = []; - for (let i = 0; i < numberOfMessages; i++) { - messagePairs.push(messages[i].lengthBytes, messages[i].content); - } - - const bytecodePairs = []; - for (let i = 0; i < numberOfBytecodes; i++) { - bytecodePairs.push(bytecodes[i].lengthBytes, bytecodes[i].content); - } + const operatorDataLength = overrideData.operatorDataLength + ? overrideData.operatorDataLength + : numberOfLogs * L2_TO_L1_LOG_SERIALIZE_SIZE + 4; return ethers.utils.concat([ + l2DaValidatorFunctionSig, + chainedLogsHash, + chainedLogsRootHash, + chainedMessagesHash, + chainedBytecodeHash, + ethers.utils.defaultAbiCoder.encode(["uint256"], [operatorDataOffset]), + ethers.utils.defaultAbiCoder.encode(["uint256"], [operatorDataLength]), ethers.utils.hexZeroPad(ethers.utils.hexlify(numberOfLogs), 4), ...encodedLogs, - ethers.utils.hexZeroPad(ethers.utils.hexlify(numberOfMessages), 4), - ...messagePairs, - ethers.utils.hexZeroPad(ethers.utils.hexlify(numberOfBytecodes), 4), - ...bytecodePairs, - version, - stateDiffsSetupData.compressedStateDiffsSizeBytes, - stateDiffsSetupData.enumerationIndexSizeBytes, - stateDiffsSetupData.compressedStateDiffs, - stateDiffsSetupData.numberOfStateDiffsBytes, - stateDiffsSetupData.encodedStateDiffs, ]); } } // Represents the structure of the data that the emulator uses. interface EmulatorData { + l2DaValidatorFunctionSig: string; + chainedLogsHash: string; + chainedLogsRootHash: string; + chainedMessagesHash: string; + chainedBytecodeHash: string; + operatorDataOffset: number; + operatorDataLength: number; numberOfLogs: number; encodedLogs: string[]; - numberOfMessages: number; - messages: ContentLengthPair[]; - numberOfBytecodes: number; - bytecodes: ContentLengthPair[]; - stateDiffsSetupData: StateDiffSetupData; - version: string; } // Represents a type that allows for overriding specific properties of the EmulatorData. // This is useful when you want to change some properties of the emulator data without affecting the others. type EmulatorOverrideData = Partial; + +function calculateChainedLogsHash(logs: string[]): string { + let hash = ethers.constants.HashZero; + for (const log of logs) { + const logHash = ethers.utils.keccak256(log); + hash = ethers.utils.keccak256(ethers.utils.concat([hash, logHash])); + } + + return hash; +} + +function calculateLogsRootHash(logs: string[]): string { + const logsTreeArray: string[] = new Array(L2_TO_L1_LOGS_MERKLE_TREE_LEAVES).fill(L2_L1_LOGS_TREE_DEFAULT_LEAF_HASH); + for (let i = 0; i < logs.length; i++) { + logsTreeArray[i] = ethers.utils.keccak256(logs[i]); + } + + let length = L2_TO_L1_LOGS_MERKLE_TREE_LEAVES; + + while (length > 1) { + for (let i = 0; i < length; i += 2) { + logsTreeArray[i / 2] = ethers.utils.keccak256(ethers.utils.concat([logsTreeArray[i], logsTreeArray[i + 1]])); + } + length /= 2; + } + return logsTreeArray[0]; +} diff --git a/system-contracts/test/L2GenesisUpgrade.spec.ts b/system-contracts/test/L2GenesisUpgrade.spec.ts index 6bc8e31f4..e64fb116a 100644 --- a/system-contracts/test/L2GenesisUpgrade.spec.ts +++ b/system-contracts/test/L2GenesisUpgrade.spec.ts @@ -1,40 +1,86 @@ import { expect } from "chai"; import { ethers, network } from "hardhat"; -import type { L2GenesisUpgrade } from "../typechain"; -import { L2GenesisUpgradeFactory } from "../typechain"; -import { TEST_L2_GENESIS_UPGRADE_CONTRACT_ADDRESS, TEST_FORCE_DEPLOYER_ADDRESS } from "./shared/constants"; -import { deployContractOnAddress, getWallets } from "./shared/utils"; +import type { ComplexUpgrader, L2GenesisUpgrade } from "../typechain"; +import { ComplexUpgraderFactory, L2GenesisUpgradeFactory } from "../typechain"; +import { + TEST_L2_GENESIS_UPGRADE_CONTRACT_ADDRESS, + TEST_FORCE_DEPLOYER_ADDRESS, + REAL_L2_ASSET_ROUTER_ADDRESS, + REAL_L2_MESSAGE_ROOT_ADDRESS, + TEST_COMPLEX_UPGRADER_CONTRACT_ADDRESS, +} from "./shared/constants"; +import { deployContractOnAddress } from "./shared/utils"; +import { setResult } from "./shared/mocks"; describe("L2GenesisUpgrade tests", function () { let l2GenesisUpgrade: L2GenesisUpgrade; + let complexUpgrader: ComplexUpgrader; const chainId = 270; + const ctmDeployerAddress = ethers.utils.hexlify(ethers.utils.randomBytes(20)); + const bridgehubOwnerAddress = ethers.utils.hexlify(ethers.utils.randomBytes(20)); + + const forceDeployments = [ + { + bytecodeHash: "0x0100056f53fd9e940906d998a80ed53392e5c50a8eb198baf9f78fd84ce7ec70", + newAddress: "0x0000000000000000000000000000000000020002", + callConstructor: true, + value: 0, + input: "0x", + }, + ]; + before(async () => { - const wallet = (await getWallets())[0]; + const wallet = await ethers.getImpersonatedSigner(TEST_FORCE_DEPLOYER_ADDRESS); + await deployContractOnAddress(TEST_COMPLEX_UPGRADER_CONTRACT_ADDRESS, "ComplexUpgrader"); await deployContractOnAddress(TEST_L2_GENESIS_UPGRADE_CONTRACT_ADDRESS, "L2GenesisUpgrade"); + complexUpgrader = ComplexUpgraderFactory.connect(TEST_COMPLEX_UPGRADER_CONTRACT_ADDRESS, wallet); l2GenesisUpgrade = L2GenesisUpgradeFactory.connect(TEST_L2_GENESIS_UPGRADE_CONTRACT_ADDRESS, wallet); + + await setResult( + "IBridgehub", + "setAddresses", + [REAL_L2_ASSET_ROUTER_ADDRESS, ctmDeployerAddress, REAL_L2_MESSAGE_ROOT_ADDRESS], + { + failure: false, + returnData: "0x", + } + ); + await setResult("IBridgehub", "owner", [], { + failure: false, + returnData: ethers.utils.defaultAbiCoder.encode(["address"], [bridgehubOwnerAddress]), + }); + + await setResult("SystemContext", "setChainId", [chainId], { + failure: false, + returnData: "0x", + }); + + await setResult("ContractDeployer", "forceDeployOnAddresses", [forceDeployments], { + failure: false, + returnData: "0x", + }); }); describe("upgrade", function () { it("successfully upgraded", async () => { - // const force_deployer = await ethers.getImpersonatedSigner(TEST_FORCE_DEPLOYER_ADDRESS); - const forceDeployments = ethers.utils.defaultAbiCoder.encode( + const forceDeploymentsData = ethers.utils.defaultAbiCoder.encode( ["tuple(bytes32 bytecodeHash, address newAddress, bool callConstructor, uint256 value, bytes input)[]"], - [ - [ - { - bytecodeHash: "0x0100056f53fd9e940906d998a80ed53392e5c50a8eb198baf9f78fd84ce7ec70", - newAddress: "0x0000000000000000000000000000000000020002", - callConstructor: true, - value: 0, - input: "0x", - }, - ], - ] + [forceDeployments] ); - await expect(l2GenesisUpgrade.genesisUpgrade(chainId, forceDeployments)) - .to.emit(l2GenesisUpgrade, "UpgradeComplete") + const data = l2GenesisUpgrade.interface.encodeFunctionData("genesisUpgrade", [ + chainId, + ctmDeployerAddress, + forceDeploymentsData, + ]); + + // Note, that the event is emitted at the complex upgrader, but the event declaration is taken from the l2GenesisUpgrade contract. + await expect(complexUpgrader.upgrade(l2GenesisUpgrade.address, data)) + .to.emit( + new ethers.Contract(complexUpgrader.address, l2GenesisUpgrade.interface, complexUpgrader.signer), + "UpgradeComplete" + ) .withArgs(chainId); await network.provider.request({ diff --git a/system-contracts/test/shared/constants.ts b/system-contracts/test/shared/constants.ts index 77ec811ed..cb5ae3e1c 100644 --- a/system-contracts/test/shared/constants.ts +++ b/system-contracts/test/shared/constants.ts @@ -27,6 +27,10 @@ export const REAL_CODE_ORACLE_CONTRACT_ADDRESS = "0x0000000000000000000000000000 export const REAL_MSG_VALUE_SYSTEM_CONTRACT_ADDRESS = "0x0000000000000000000000000000000000008009"; export const REAL_SYSTEM_CONTEXT_ADDRESS = "0x000000000000000000000000000000000000800b"; +export const REAL_BRIDGEHUB_ADDRESS = "0x0000000000000000000000000000000000010002"; +export const REAL_L2_ASSET_ROUTER_ADDRESS = "0x0000000000000000000000000000000000010003"; +export const REAL_L2_MESSAGE_ROOT_ADDRESS = "0x0000000000000000000000000000000000010005"; + export const EMPTY_STRING_KECCAK = "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470"; export const TWO_IN_256 = BigNumber.from(2).pow(256); export const ONE_BYTES32_HEX = "0x0000000000000000000000000000000000000000000000000000000000000001"; diff --git a/system-contracts/test/shared/mocks.ts b/system-contracts/test/shared/mocks.ts index 4dd51671e..8e38ba278 100644 --- a/system-contracts/test/shared/mocks.ts +++ b/system-contracts/test/shared/mocks.ts @@ -14,6 +14,8 @@ import { TEST_SYSTEM_CONTEXT_CONTRACT_ADDRESS, TEST_COMPRESSOR_CONTRACT_ADDRESS, TEST_PUBDATA_CHUNK_PUBLISHER_ADDRESS, + REAL_BRIDGEHUB_ADDRESS, + REAL_L2_MESSAGE_ROOT_ADDRESS, } from "./constants"; import { deployContractOnAddress, getWallets, loadArtifact } from "./utils"; @@ -37,6 +39,13 @@ const TEST_SYSTEM_CONTRACTS_MOCKS = { MsgValueSimulator: TEST_MSG_VALUE_SYSTEM_CONTRACT_ADDRESS, Bootloader: TEST_BOOTLOADER_FORMAL_ADDRESS, PubdataChunkPublisher: TEST_PUBDATA_CHUNK_PUBLISHER_ADDRESS, + // We use `IBridgehub` name, since this is the name of the file in the system-contracts folder. + // The contract itself is present in a different one. + // For bridgehub we mock the real address for simplicity. + // In case of need, it can be ported to use the test address. + IBridgehub: REAL_BRIDGEHUB_ADDRESS, + // For similar reasons we mock the L2 message real root only for simplicity + IMessageRoot: REAL_L2_MESSAGE_ROOT_ADDRESS, }; // Deploys mocks, and cleans previous call results during deployments. diff --git a/tools/README.md b/tools/README.md index 081ab8d70..a49cf4c73 100644 --- a/tools/README.md +++ b/tools/README.md @@ -7,3 +7,11 @@ To generate the verifier from the scheduler key in 'data' directory, just run: ```shell cargo run --bin zksync_verifier_contract_generator --release -- --input_path data/scheduler_key.json --output_path ../l1-contracts/contracts/state-transition/Verifier.sol ``` + +## L2 mode + +At the time of this writing, `modexp` precompile is not present on zkSync Era. In order to deploy the verifier on top of a ZK Chain, a different version has to be used with custom implementation of modular exponentiation. + +```shell +cargo run --bin zksync_verifier_contract_generator --release -- --input_path data/scheduler_key.json --output_path ../l2-contracts/contracts/verifier/Verifier.sol --l2_mode +``` diff --git a/tools/data/verifier_contract_template.txt b/tools/data/verifier_contract_template.txt index 5ef32b2c5..23249c9ab 100644 --- a/tools/data/verifier_contract_template.txt +++ b/tools/data/verifier_contract_template.txt @@ -8,7 +8,7 @@ import {IVerifier} from "./chain-interfaces/IVerifier.sol"; /// @author Matter Labs /// @notice Modified version of the Permutations over Lagrange-bases for Oecumenical Noninteractive arguments of /// Knowledge (PLONK) verifier. -/// Modifications have been made to optimize the proof system for ZKsync hyperchain circuits. +/// Modifications have been made to optimize the proof system for ZK chain circuits. /// @dev Contract was generated from a verification key with a hash of 0x{{vk_hash}} /// @dev It uses a custom memory layout inside the inline assembly block. Each reserved memory cell is declared in the /// constants below. @@ -278,8 +278,7 @@ contract Verifier is IVerifier { /// @inheritdoc IVerifier function verify( uint256[] calldata, // _publicInputs - uint256[] calldata, // _proof - uint256[] calldata // _recursiveAggregationInput + uint256[] calldata // _proof ) public view virtual returns (bool) { // No memory was accessed yet, so keys can be loaded into the right place and not corrupt any other memory. _loadVerificationKey(); @@ -309,18 +308,7 @@ contract Verifier is IVerifier { } /// @dev Performs modular exponentiation using the formula (value ^ power) mod R_MOD. - function modexp(value, power) -> res { - mstore(0x00, 0x20) - mstore(0x20, 0x20) - mstore(0x40, 0x20) - mstore(0x60, value) - mstore(0x80, power) - mstore(0xa0, R_MOD) - if iszero(staticcall(gas(), 5, 0, 0xc0, 0x00, 0x20)) { - revertWithMessage(24, "modexp precompile failed") - } - res := mload(0x00) - } + {{modexp_function}} /// @dev Performs a point multiplication operation and stores the result in a given memory destination. function pointMulIntoDest(point, s, dest) { @@ -458,7 +446,17 @@ contract Verifier is IVerifier { // 2. Load the proof (except for the recursive part) offset := calldataload(0x24) let proofLengthInWords := calldataload(add(offset, 0x04)) - isValid := and(eq(proofLengthInWords, 44), isValid) + + // Check the proof length depending on whether the recursive part is present + let expectedProofLength + switch mload(VK_RECURSIVE_FLAG_SLOT) + case 0 { + expectedProofLength := 44 + } + default { + expectedProofLength := 48 + } + isValid := and(eq(proofLengthInWords, expectedProofLength), isValid) // PROOF_STATE_POLYS_0 { @@ -605,21 +603,13 @@ contract Verifier is IVerifier { } // 3. Load the recursive part of the proof - offset := calldataload(0x44) - let recursiveProofLengthInWords := calldataload(add(offset, 0x04)) - - switch mload(VK_RECURSIVE_FLAG_SLOT) - case 0 { - // recursive part should be empty - isValid := and(iszero(recursiveProofLengthInWords), isValid) - } - default { + if mload(VK_RECURSIVE_FLAG_SLOT) { // recursive part should be consist of 2 points - isValid := and(eq(recursiveProofLengthInWords, 4), isValid) + // PROOF_RECURSIVE_PART_P1 { - let x := mod(calldataload(add(offset, 0x024)), Q_MOD) - let y := mod(calldataload(add(offset, 0x044)), Q_MOD) + let x := mod(calldataload(add(offset, 0x5a4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x5c4)), Q_MOD) let xx := mulmod(x, x, Q_MOD) isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) mstore(PROOF_RECURSIVE_PART_P1_X_SLOT, x) @@ -627,8 +617,8 @@ contract Verifier is IVerifier { } // PROOF_RECURSIVE_PART_P2 { - let x := mod(calldataload(add(offset, 0x064)), Q_MOD) - let y := mod(calldataload(add(offset, 0x084)), Q_MOD) + let x := mod(calldataload(add(offset, 0x5e4)), Q_MOD) + let y := mod(calldataload(add(offset, 0x604)), Q_MOD) let xx := mulmod(x, x, Q_MOD) isValid := and(eq(mulmod(y, y, Q_MOD), addmod(mulmod(x, xx, Q_MOD), 3, Q_MOD)), isValid) mstore(PROOF_RECURSIVE_PART_P2_X_SLOT, x) diff --git a/tools/src/main.rs b/tools/src/main.rs index 746373fe4..4da69d921 100644 --- a/tools/src/main.rs +++ b/tools/src/main.rs @@ -115,6 +115,10 @@ struct Opt { /// Output path to verifier contract file. #[structopt(short = "o", long = "output_path", default_value = "data/Verifier.sol")] output_path: String, + + /// The Verifier is to be compiled for an L2 network, where modexp precompile is not available. + #[structopt(short = "l2", long = "l2_mode")] + l2_mode: bool, } fn main() -> Result<(), Box> { @@ -135,7 +139,7 @@ fn main() -> Result<(), Box> { let vk_hash = hex::encode(calculate_verification_key_hash(verification_key).to_fixed_bytes()); let verifier_contract_template = - insert_residue_elements_and_commitments(&verifier_contract_template, &vk, &vk_hash)?; + insert_residue_elements_and_commitments(&verifier_contract_template, &vk, &vk_hash, opt.l2_mode)?; let mut file = File::create(opt.output_path)?; @@ -147,6 +151,7 @@ fn insert_residue_elements_and_commitments( template: &str, vk: &HashMap, vk_hash: &str, + l2_mode: bool, ) -> Result> { let reg = Handlebars::new(); let residue_g2_elements = generate_residue_g2_elements(vk); @@ -155,11 +160,16 @@ fn insert_residue_elements_and_commitments( let verifier_contract_template = template.replace("{{residue_g2_elements}}", &residue_g2_elements); + let modexp_function = get_modexp_function(l2_mode); + let verifier_contract_template = verifier_contract_template.replace("{{modexp_function}}", &modexp_function); + + Ok(reg.render_template( &verifier_contract_template, &json!({"residue_g2_elements": residue_g2_elements, "commitments": commitments, - "vk_hash": vk_hash}), + "vk_hash": vk_hash, + "modexp_function": modexp_function}), )?) } @@ -334,3 +344,37 @@ fn generate_residue_g2_elements(vk: &HashMap) -> String { residue_g2_elements } + + +fn get_modexp_function(l2_mode: bool) -> String { + if l2_mode { + r#"function modexp(value, power) -> res { + res := 1 + for { + + } gt(power, 0) { + + } { + if mod(power, 2) { + res := mulmod(res, value, R_MOD) + } + value := mulmod(value, value, R_MOD) + power := shr(1, power) + } + }"#.to_string() + } else { + r#"function modexp(value, power) -> res { + mstore(0x00, 0x20) + mstore(0x20, 0x20) + mstore(0x40, 0x20) + mstore(0x60, value) + mstore(0x80, power) + mstore(0xa0, R_MOD) + if iszero(staticcall(gas(), 5, 0, 0xc0, 0x00, 0x20)) { + revertWithMessage(24, "modexp precompile failed") + } + res := mload(0x00) + }"#.to_string() + } +} + diff --git a/yarn.lock b/yarn.lock index c550f2d1e..acf71f3ce 100644 --- a/yarn.lock +++ b/yarn.lock @@ -7933,8 +7933,15 @@ zksync-ethers@^5.0.0: ethers "~5.7.0" zksync-ethers@^5.9.0: - version "5.9.0" - resolved "https://registry.yarnpkg.com/zksync-ethers/-/zksync-ethers-5.9.0.tgz#96dc29e4eaaf0aa70d927886fd6e1e4c545786e3" - integrity sha512-VnRUesrBcPBmiTYTAp+WreIazK2qCIJEHE7j8BiK+cDApHzjAfIXX+x8SXXJpG1npGJANxiJKnPwA5wjGZtCRg== + version "5.9.2" + resolved "https://registry.yarnpkg.com/zksync-ethers/-/zksync-ethers-5.9.2.tgz#1c5f34cb25ac0b040fd1a6118f2ba1c2c3bda090" + integrity sha512-Y2Mx6ovvxO6UdC2dePLguVzvNToOY8iLWeq5ne+jgGSJxAi/f4He/NF6FNsf6x1aWX0o8dy4Df8RcOQXAkj5qw== + dependencies: + ethers "~5.7.0" + +zksync-web3@^0.15.4: + version "0.15.5" + resolved "https://registry.yarnpkg.com/zksync-web3/-/zksync-web3-0.15.5.tgz#aabe379464963ab573e15948660a709f409b5316" + integrity sha512-97gB7OKJL4spegl8fGO54g6cvTd/75G6yFWZWEa2J09zhjTrfqabbwE/GwiUJkFQ5BbzoH4JaTlVz1hoYZI+DQ== dependencies: ethers "~5.7.0"