build: implement integration test for zksync contracts

.github/workflows/zksync-integration-test.yml

@@ -0,0 +1,97 @@
+name: ZKSync Integration Test
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    types: [opened, synchronize, reopened]
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  Test:
+    runs-on: ubuntu-latest
+    environment: Test
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # Run Dockerized L1-L2, goes first because it takes a lot of time
+      - name: Setup Dockerized L1-L2
+        run: |
+          export ETHERSCAN_API_KEY=${{vars.ETHERSCAN_API_KEY}}
+          git clone https://github.com/matter-labs/local-setup.git
+
+          echo git cloned, starting:
+          cd local-setup
+
+          echo starting:
+          touch ../docker_output.log
+          ./start.sh &> ../docker_output.log &
+
+      # Ethereum Setup
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Install Forge
+        run: |
+          cd contracts/ethereum
+          forge install
+
+      # ZKSync Setup
+      - name: Install ZKSync libraries
+        run: |
+          cd ./contracts/zksync/ && yarn install
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '20.11.1'
+          cache: 'npm'
+          cache-dependency-path: '**/.github/workflows/*.yml'
+
+      - name: Download zksync-cli
+        run: |
+          npx zksync-cli --version
+
+      # Build Ethereum Contract
+      - name: Build Ethereum Contract
+        run: |
+          make ethereum-build
+
+      # Build ZKSync Contract
+      - name: Build ZKSync Contract
+        run: |
+          make zksync-build
+
+      # Run Dockerized L1-L2
+      - name: Running integration test
+        run: |
+          export ETHERSCAN_API_KEY=${{vars.ETHERSCAN_API_KEY}}
+
+          export STARKNET_MESSAGING_ADDRESS=${{vars.STARKNET_MESSAGING_ADDRESS}}
+          export STARKNET_CLAIM_PAYMENT_SELECTOR=${{vars.STARKNET_CLAIM_PAYMENT_SELECTOR}}
+          export STARKNET_CLAIM_PAYMENT_BATCH_SELECTOR=${{vars.STARKNET_CLAIM_PAYMENT_BATCH_SELECTOR}}
+          export ZKSYNC_CLAIM_PAYMENT_SELECTOR=${{vars.ZKSYNC_CLAIM_PAYMENT_SELECTOR}}
+          export ZKSYNC_CLAIM_PAYMENT_BATCH_SELECTOR=${{vars.ZKSYNC_CLAIM_PAYMENT_BATCH_SELECTOR}}
+          export STARKNET_CHAIN_ID=${{vars.STARKNET_CHAIN_ID}}
+          export ZKSYNC_CHAIN_ID=${{vars.ZKSYNC_CHAIN_ID}}
+
+          export MM_ETHEREUM_WALLET_ADDRESS=${{vars.MM_ETHEREUM_WALLET_ADDRESS}}
+          export TEST=true
+
+          echo sleeping 250 to wait for ./start to setup
+          sleep 250
+
+          export ZKSYNC_DIAMOND_PROXY_ADDRESS=$(cat docker_output.log | sed -n 's/.*CONTRACTS_DIAMOND_PROXY_ADDR=\(0x[a-fA-F0-9]*\).*/\1/p')
+          echo stored ZKSYNC_DIAMOND_PROXY_ADDRESS variable:
+          echo $ZKSYNC_DIAMOND_PROXY_ADDRESS
+
+          echo running make-test-integration-ci
+          make zksync-test-integration-ci
+
+          exit 0

.github/workflows/zksync-scripts/assert.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+. contracts/utils/colors.sh #for ANSI colors
+
+echo "\n"
+FAILED=false
+
+assert() {
+  #Usage: assert <variable_name> <obtained> <expected>
+  if [ $2 = $3 ] ; then
+    printf "${GREEN}✓ $1 passed.${RESET}\n"
+  else
+    printf "${RED}x $1 assertion failed: Obtained value: $2, Expected value: $3.${RESET}\n"
+    FAILED=true
+  fi
+}
+
+assert "Escrow balance after SetOrder" $BALANCE_ESCROW_L2_AFTER_SETORDER_WEI $VALUE_WEI #2000000000000000000
+assert "Escrow balance after Claim Payment" $BALANCE_ESCROW_L2_AFTER_CLAIMPAYMENT_WEI 0
+
+assert "User balance" $BALANCE_USER_L1_AFTER_TRANSFER_WEI $BRIDGE_AMOUNT_WEI #1990000000000000000
+
+assert "MM balance" $(($BALANCE_MM_L2_AFTER_CLAIMPAYMENT_WEI)) $(($BALANCE_MM_L2_BEFORE_CLAIMPAYMENT_WEI + $VALUE_WEI))
+
+if $FAILED; then
+  echo "One of the previous tests failed, all should pass for Integration Test to be successful"
+  exit 1
+fi
+exit 0

.github/workflows/zksync-scripts/ci.env.test

@@ -0,0 +1,36 @@
+## ETH.env
+SKIP_VERIFY=true #cant verify on local devnet
+
+ETHEREUM_RPC=http://localhost:8545 #local devnet L1 rpc url
+
+ETHEREUM_PRIVATE_KEY=0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110 #prefunded 0
+
+MM_ETHEREUM_PRIVATE_KEY=0xd293c684d884d56f8d6abd64fc76757d3664904e309a0645baf8522ab6366d9e #prefunded 2
+MM_ETHEREUM_WALLET_ADDRESS=0x0D43eB5B8a47bA8900d84AA36656c92024e9772e #prefunded 2
+
+USER_ETHEREUM_PUBLIC_ADDRESS=0xCEEe57f2B700c2f37D1476A7974965E149Fce2D4 #random address with no funds
+
+ZKSYNC_CLAIM_PAYMENT_SELECTOR=0xa5168739
+ZKSYNC_CLAIM_PAYMENT_BATCH_SELECTOR=0x156be1ae
+ZKSYNC_CHAIN_ID=300
+
+
+# These SN variables don't affect this test, but are necessary for deploy
+STARKNET_CLAIM_PAYMENT_SELECTOR=0x03636c566f6409560d55d5f6d1eb4ee163b096b4698c503e69e210be79de2afa
+STARKNET_CLAIM_PAYMENT_BATCH_SELECTOR=0x0354a01e49fe07e43306a97ed84dbd5de8238c7d8ff616caa3444630cfc559e6
+STARKNET_MESSAGING_ADDRESS=0xE2Bb56ee936fd6433DC0F6e7e3b8365C906AA057
+STARKNET_CHAIN_ID=0x534e5f5345504f4c4941
+
+
+## ZKSYNC.env
+TEST=true
+
+WALLET_PRIVATE_KEY=0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110 #prefunded 0
+MM_ZKSYNC_WALLET=0xbE85c9531BE760B6964cdA4A8826b9Cb0391E32C #random address with no funds
+
+NATIVE_TOKEN_ETH_IN_ZKSYNC=0x000000000000000000000000000000000000800A
+
+USER_ZKSYNC_PRIVATE_ADDRESS=0xf12e28c0eb1ef4ff90478f6805b68d63737b7f33abfa091601140805da450d93 #prefunded 4
+USER_ZKSYNC_PUBLIC_ADDRESS=0x8002cD98Cfb563492A6fB3E7C8243b7B9Ad4cc92 #prefunded 4
+
+

.github/workflows/zksync-scripts/claim_payment.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+. contracts/utils/colors.sh #for ANSI colors
+
+printf "${GREEN}\n=> [ETH] Making Claim Payment${COLOR_RESET}\n"
+
+BALANCE_ESCROW_L2_BEFORE_CLAIMPAYMENT=$(cast balance --rpc-url http://localhost:3050 $ZKSYNC_ESCROW_CONTRACT_ADDRESS)
+echo "Initial Escrow balance: $BALANCE_ESCROW_L2_BEFORE_CLAIMPAYMENT"
+
+# BALANCE_MM_L1_BEFORE_CLAIMPAYMENT=$(cast balance --rpc-url $ETHEREUM_RPC $MM_ETHEREUM_WALLET_ADDRESS)
+# echo "\nInitial MM balance: $BALANCE_MM_L1_BEFORE_CLAIMPAYMENT"
+
+BALANCE_MM_L2_BEFORE_CLAIMPAYMENT_WEI=$(cast balance --rpc-url http://localhost:3050 $MM_ZKSYNC_WALLET) #for assert.sh
+BALANCE_MM_L2_BEFORE_CLAIMPAYMENT=$(cast balance --rpc-url http://localhost:3050 --ether $MM_ZKSYNC_WALLET) #for logging
+echo "Initial MM balance: $BALANCE_MM_L2_BEFORE_CLAIMPAYMENT"
+
+echo "Withdrawing $BRIDGE_AMOUNT_ETH ETH" # == $BRIDGE_AMOUNT_WEI WEI"
+cast send --rpc-url $ETHEREUM_RPC --private-key $ETHEREUM_PRIVATE_KEY --gas-price 2000000000 \
+  $PAYMENT_REGISTRY_PROXY_ADDRESS "claimPaymentZKSync(uint256, address, uint256, uint256, uint256)" \
+  "0" $USER_ETHEREUM_PUBLIC_ADDRESS $BRIDGE_AMOUNT_WEI 2000000 800 \
+  --value 5000000000000000000 > /dev/null
+
+# echo "\nMM L1 funds after Claim Payment"
+# BALANCE_MM_L1_AFTER_CLAIMPAYMENT=$(cast balance --rpc-url $ETHEREUM_RPC $MM_ETHEREUM_WALLET_ADDRESS)
+# echo "$BALANCE_MM_L1_AFTER_CLAIMPAYMENT"
+
+BALANCE_ESCROW_L2_AFTER_CLAIMPAYMENT_WEI=$(cast balance --rpc-url http://localhost:3050 $ZKSYNC_ESCROW_CONTRACT_ADDRESS) #for assert.sh
+BALANCE_ESCROW_L2_AFTER_CLAIMPAYMENT=$(cast balance --rpc-url http://localhost:3050 --ether $ZKSYNC_ESCROW_CONTRACT_ADDRESS) #for logging
+echo "Final Escrow balance: $BALANCE_ESCROW_L2_AFTER_CLAIMPAYMENT"
+
+BALANCE_MM_L2_AFTER_CLAIMPAYMENT_WEI=$(cast balance --rpc-url http://localhost:3050 $MM_ZKSYNC_WALLET) #for assert.sh
+BALANCE_MM_L2_AFTER_CLAIMPAYMENT=$(cast balance --rpc-url http://localhost:3050 --ether $MM_ZKSYNC_WALLET) #for logging
+echo "Final MM balance:$BALANCE_MM_L2_AFTER_CLAIMPAYMENT"

.github/workflows/zksync-scripts/set_order.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+. contracts/utils/colors.sh #for ANSI colors
+
+FEE=10000000000000000 #in WEI
+VALUE=2 #in ETH
+VALUE_WEI=$(echo "scale=0; $VALUE * 10^18" | bc)
+BRIDGE_AMOUNT_WEI=$(echo "scale=0; $VALUE_WEI - $FEE" | bc)
+BRIDGE_AMOUNT_ETH=$(echo "scale=18; $BRIDGE_AMOUNT_WEI / 10^18" | bc)
+
+echo USER_ZKSYNC_PUBLIC_ADDRESS
+echo $USER_ZKSYNC_PUBLIC_ADDRESS
+echo ZKSYNC_ESCROW_CONTRACT_ADDRESS
+echo $ZKSYNC_ESCROW_CONTRACT_ADDRESS
+
+printf "${GREEN}\n=> [SN] Making Set Order on Escrow${COLOR_RESET}\n"
+echo "$ZKSYNC_ESCROW_CONTRACT_ADDRESS\n"
+
+BALANCE_USER_L2_BEFORE_SETORDER=$(cast balance --rpc-url http://localhost:3050 $USER_ZKSYNC_PUBLIC_ADDRESS)
+echo "Initial User funds: $BALANCE_USER_L2_BEFORE_SETORDER"
+
+BALANCE_ESCROW_L2_BEFORE_SETORDER=$(cast balance --rpc-url http://localhost:3050 $ZKSYNC_ESCROW_CONTRACT_ADDRESS)
+echo "Initial Escrow funds: $BALANCE_ESCROW_L2_BEFORE_SETORDER"
+
+npx zksync-cli contract write --private-key $USER_ZKSYNC_PRIVATE_ADDRESS --rpc http://localhost:3050 --contract "$ZKSYNC_ESCROW_CONTRACT_ADDRESS" --method "set_order(address recipient_address, uint256 fee)" --args "$USER_ETHEREUM_PUBLIC_ADDRESS" "$FEE" --value "$VALUE" >> /dev/null
+
+BALANCE_USER_L2_AFTER_SETORDER=$(cast balance --rpc-url http://localhost:3050 $USER_ZKSYNC_PUBLIC_ADDRESS)
+echo "Final User funds: $BALANCE_USER_L2_AFTER_SETORDER"
+
+
+BALANCE_ESCROW_L2_AFTER_SETORDER_WEI=$(cast balance --rpc-url http://localhost:3050 $ZKSYNC_ESCROW_CONTRACT_ADDRESS) #for assert.sh
+BALANCE_ESCROW_L2_AFTER_SETORDER=$(cast balance --rpc-url http://localhost:3050 $ZKSYNC_ESCROW_CONTRACT_ADDRESS) #for logging
+echo "Final Escrow funds:$BALANCE_ESCROW_L2_AFTER_SETORDER"

.github/workflows/zksync-scripts/transfer.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+. contracts/utils/colors.sh #for ANSI colors
+
+printf "${GREEN}\n=> [ETH] Making transfer to Destination account${COLOR_RESET}\n"
+
+BALANCE_MM_L1_BEFORE_TRANSFER=$(cast balance --rpc-url $ETHEREUM_RPC $MM_ETHEREUM_WALLET_ADDRESS)
+echo "Initial MM Balance: $BALANCE_MM_L1_BEFORE_TRANSFER"
+
+BALANCE_USER_L1_BEFORE_TRANSFER=$(cast balance --rpc-url $ETHEREUM_RPC $USER_ETHEREUM_PUBLIC_ADDRESS)
+echo "Initial User Balance: $BALANCE_USER_L1_BEFORE_TRANSFER"
+
+echo "Transferring $BRIDGE_AMOUNT_ETH ETH to $USER_ETHEREUM_PUBLIC_ADDRESS"
+cast send --rpc-url $ETHEREUM_RPC --private-key $MM_ETHEREUM_PRIVATE_KEY --gas-price 2000000000 \
+  $PAYMENT_REGISTRY_PROXY_ADDRESS "transfer(uint256, address, uint128)" \
+  "0" $USER_ETHEREUM_PUBLIC_ADDRESS $ZKSYNC_CHAIN_ID \
+  --value $BRIDGE_AMOUNT_WEI >> /dev/null
+
+BALANCE_MM_L1_AFTER_TRANSFER=$(cast balance --rpc-url $ETHEREUM_RPC $MM_ETHEREUM_WALLET_ADDRESS)
+echo "Final MM Balance: $BALANCE_MM_L1_AFTER_TRANSFER"
+
+BALANCE_USER_L1_AFTER_TRANSFER_WEI=$(cast balance --rpc-url $ETHEREUM_RPC $USER_ETHEREUM_PUBLIC_ADDRESS) #for assert.sh
+BALANCE_USER_L1_AFTER_TRANSFER=$(cast balance --rpc-url $ETHEREUM_RPC --ether $USER_ETHEREUM_PUBLIC_ADDRESS) #for logging
+echo "Final User Balance: $BALANCE_USER_L1_AFTER_TRANSFER"

Makefile

@@ -102,16 +102,26 @@ zksync-test: zksync-build
 zksync-test-in-memory: zksync-build
 	@cd ./contracts/zksync/ && yarn test-in-memory
 
-#wip:
-zksync-test-integration:
+zksync-test-integration-ci:
+	@. ./.github/workflows/zksync-scripts/ci.env.test && \
+	. ./contracts/ethereum/deploy.sh && \
+	. ./contracts/zksync/deploy.sh && \
+	. ./contracts/ethereum/set_zksync_escrow.sh && \
+	. ./.github/workflows/zksync-scripts/set_order.sh && \
+	. ./.github/workflows/zksync-scripts/transfer.sh && \
+	. ./.github/workflows/zksync-scripts/claim_payment.sh && \
+	. ./.github/workflows/zksync-scripts/assert.sh
+
+zksync-test-integration-local:
 	@make ethereum-build && make zksync-build && \
 	. ./contracts/ethereum/test/.env.test && . ./contracts/zksync/test/.env.test && \
 	. ./contracts/ethereum/deploy.sh && \
 	. ./contracts/zksync/deploy.sh && \
 	. ./contracts/ethereum/set_zksync_escrow.sh && \
-	. ./contracts/zksync/test/set_order.sh && \
-	. ./contracts/zksync/test/transfer.sh && \
-	. ./contracts/zksync/test/claim_payment.sh
+	. ./.github/workflows/zksync-scripts/set_order.sh && \
+	. ./.github/workflows/zksync-scripts/transfer.sh && \
+	. ./.github/workflows/zksync-scripts/claim_payment.sh && \
+	. ./.github/workflows/zksync-scripts/assert.sh
 
 # zksync-upgrade: WIP
 

contracts/ethereum/deploy.sh

@@ -5,12 +5,12 @@ cd contracts/ethereum
 
 printf "${GREEN}\n=> [ETH] Deploying ERC1967Proxy & PaymentRegistry ${COLOR_RESET}\n"
 
-
 export ETHEREUM_PRIVATE_KEY=$ETHEREUM_PRIVATE_KEY
 
 RESULT_LOG=$(forge script ./script/Deploy.s.sol --rpc-url $ETHEREUM_RPC --broadcast ${SKIP_VERIFY:---verify})
 # echo "$RESULT_LOG" #uncomment this line for debugging in detail
 
+
 # Getting result addresses
 PAYMENT_REGISTRY_PROXY_ADDRESS=$(echo "$RESULT_LOG" | grep -Eo '0: address ([^\n]+)' | awk '{print $NF}')
 PAYMENT_REGISTRY_ADDRESS=$(echo "$RESULT_LOG" | grep -Eo '1: address ([^\n]+)' | awk '{print $NF}')

contracts/ethereum/test/.env.test

@@ -2,13 +2,30 @@ SKIP_VERIFY=true #cant verify on local devnet
 
 ETHEREUM_RPC=http://localhost:8545 #local devnet L1 rpc url
 
-ZKSYNC_DIAMOND_PROXY_ADDRESS=0x97589bcE7727f5D0C8082440681DB6092b6Dda1a
+ZKSYNC_DIAMOND_PROXY_ADDRESS=0xdA7aA6e28eD3164bF5383eCe38868ADc7686A2F0
 
 
 ETHEREUM_PRIVATE_KEY=0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110 #prefunded 0
 
-MM_ETHEREUM_PRIVATE_KEY=0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110 #prefunded 0
-MM_ETHEREUM_PUBLIC_ADDRESS=0x36615Cf349d7F6344891B1e7CA7C72883F5dc049 #prefunded 0
+MM_ETHEREUM_PRIVATE_KEY=0xd293c684d884d56f8d6abd64fc76757d3664904e309a0645baf8522ab6366d9e #prefunded 2
+MM_ETHEREUM_WALLET_ADDRESS=0x0D43eB5B8a47bA8900d84AA36656c92024e9772e #prefunded 2
+
+USER_ETHEREUM_PUBLIC_ADDRESS=0xCEEe57f2B700c2f37D1476A7974965E149Fce2D4 #random address with no funds
+
+ETHERSCAN_API_KEY=0x1
+
+ZKSYNC_CLAIM_PAYMENT_SELECTOR=0xa5168739
+ZKSYNC_CLAIM_PAYMENT_BATCH_SELECTOR=0x156be1ae
+ZKSYNC_CHAIN_ID=300
+
+
+#irrelevant SN variables
+STARKNET_CLAIM_PAYMENT_SELECTOR=0x03636c566f6409560d55d5f6d1eb4ee163b096b4698c503e69e210be79de2afa
+STARKNET_CLAIM_PAYMENT_BATCH_SELECTOR=0x0354a01e49fe07e43306a97ed84dbd5de8238c7d8ff616caa3444630cfc559e6
+STARKNET_MESSAGING_ADDRESS=0xE2Bb56ee936fd6433DC0F6e7e3b8365C906AA057
+STARKNET_CHAIN_ID=0x534e5f5345504f4c4941
+
+
+
+
 
-USER_ETHEREUM_PUBLIC_ADDRESS=0xceee57f2b700c2f37d1476a7974965e149fce2d4 #random address with no funds
-USER_ETHEREUM_PUBLIC_ADDRESS_UINT=1181367337507422765615536123397692015769584198356

contracts/zksync/.gitignore

@@ -79,7 +79,6 @@ typings/
 
 # dotenv environment variables file
 .env
-.env.test
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache

contracts/zksync/deploy.sh

@@ -10,15 +10,17 @@ if [ -z "$PAYMENT_REGISTRY_PROXY_ADDRESS" ]; then
 fi
 
 DEPLOY="deploy"
-if [ "$TEST" == true ]; then
+if [ "$TEST" = true ]; then
     DEPLOY="deploy-devnet"
 fi
 
 export WALLET_PRIVATE_KEY=$WALLET_PRIVATE_KEY
 export PAYMENT_REGISTRY_PROXY_ADDRESS=$PAYMENT_REGISTRY_PROXY_ADDRESS
 export MM_ZKSYNC_WALLET=$MM_ZKSYNC_WALLET
 
-ZKSYNC_ESCROW_CONTRACT_ADDRESS=$(yarn $DEPLOY | grep "Contract address:" | egrep -i -o '0x[a-zA-Z0-9]{40}')
+RESULT_LOG=$(yarn $DEPLOY)
+# echo $RESULT_LOG #uncomment this line for debugging
+ZKSYNC_ESCROW_CONTRACT_ADDRESS=$(echo "$RESULT_LOG" | grep "Contract address:" | egrep -i -o '0x[a-zA-Z0-9]{40}')
 
 if [ -z "$ZKSYNC_ESCROW_CONTRACT_ADDRESS" ]; then
     printf "\n${RED}ERROR:${COLOR_RESET}\n"

contracts/zksync/test/.env.test

@@ -0,0 +1,10 @@
+TEST=true
+
+
+WALLET_PRIVATE_KEY=0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110 #prefunded 0
+MM_ZKSYNC_WALLET=0xbE85c9531BE760B6964cdA4A8826b9Cb0391E32C #random address with no funds
+
+NATIVE_TOKEN_ETH_IN_ZKSYNC=0x000000000000000000000000000000000000800A
+
+USER_ZKSYNC_PRIVATE_ADDRESS=0xf12e28c0eb1ef4ff90478f6805b68d63737b7f33abfa091601140805da450d93 #prefunded 4
+USER_ZKSYNC_PUBLIC_ADDRESS=0x8002cD98Cfb563492A6fB3E7C8243b7B9Ad4cc92 #prefunded 4