feat: add deploy workflow for contract deployment (#79)

Co-authored-by: GitHub Actions Bot <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Zied <[email protected]>

Author: 3 people

.env.template

@@ -1,3 +1,5 @@
+CI=false # Set to true if you want to run the make file commands in CI mode (will use --private-key instead of --account option)
+
 SEPOLIA_RPC_URL="https://gateway.tenderly.co/public/sepolia"
 ARBITRUM_SEPOLIA_RPC_URL="https://arbitrum-sepolia.gateway.tenderly.co"
 

.github/workflows/deploy.yml

@@ -0,0 +1,89 @@
+name: Deploy contracts
+
+on:
+  workflow_dispatch: # Manual trigger
+    inputs:
+      network:
+        description: 'Network'
+        required: true
+        type: choice
+        options:
+          - anvil
+          - sepolia
+          - ethereum
+          - arbitrum_sepolia
+          - arbitrum
+        default: 'anvil'
+
+jobs:
+
+  # Build and test before deploying.
+  build-and-test:
+    uses: ./.github/workflows/main.yml
+    with:
+      SEPOLIA_RPC_URL: ${{ vars.SEPOLIA_RPC_URL }}
+      ARBITRUM_SEPOLIA_RPC_URL: ${{ vars.ARBITRUM_SEPOLIA_RPC_URL }}
+
+  # Deploy and verify contract.
+  deploy:
+    needs: build-and-test
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    permissions:
+      contents: write # Required to commit deployment files.
+    environment: ${{ inputs.network }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: stable
+          cache: true
+
+      - name: Deploy contracts on Anvil (All networks)
+        if: inputs.network == 'anvil'
+        env:
+          DEPLOYER_PRIVATE_KEY: ${{ vars.ANVIL_PRIVATE_KEY }}
+          SEPOLIA_RPC_URL: ${{ vars.SEPOLIA_RPC_URL }}
+          ARBITRUM_SEPOLIA_RPC_URL: ${{ vars.ARBITRUM_SEPOLIA_RPC_URL }}
+          ANVIL_SEPOLIA_RPC_URL: ${{ vars.ANVIL_SEPOLIA_RPC_URL }}
+          ANVIL_ARBITRUM_SEPOLIA_RPC_URL: ${{ vars.ANVIL_ARBITRUM_SEPOLIA_RPC_URL }}
+        run: |
+          make fork-sepolia & make fork-arbitrum-sepolia & sleep 10 && make deploy-on-anvil
+
+      - name: Deploy contracts on Sepolia/EthereumMainnet
+        if: inputs.network == 'sepolia' || inputs.network == 'ethereum'
+        env:
+          DEPLOYER_PRIVATE_KEY: ${{ secrets.DEPLOYER_PRIVATE_KEY }}
+          CHAIN: ${{ inputs.network }}
+          RPC_URL: ${{ secrets.RPC_URL }}
+        run: |
+          make deploy-liquidity-unifier-and-bridge
+
+      - name: Deploy contracts on ChainX
+        if: inputs.network != 'sepolia' && inputs.network != 'ethereum' && inputs.network != 'anvil'
+        env:
+          DEPLOYER_PRIVATE_KEY: ${{ secrets.DEPLOYER_PRIVATE_KEY }}
+          CHAIN: ${{ inputs.network }}
+          RPC_URL: ${{ secrets.RPC_URL }}
+        run: |
+          make deploy-crosschain-token-and-bridge
+
+      - name: Save deployment artifacts
+        if: inputs.network != 'anvil'
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: 'chore: save deployment artifacts for ${{ inputs.network }} (Github run_id: ${{ github.run_id }})'
+          file_pattern: 'config/config.json broadcast/'
+          commit_user_name: 'GitHub Actions Bot'
+          commit_user_email: 'github-actions[bot]@users.noreply.github.com'
+          commit_author: 'GitHub Actions Bot <github-actions[bot]@users.noreply.github.com>'
+          
+      - name: Verify contracts
+        if: inputs.network != 'anvil'
+        run: |
+          echo "TODO: Implement contract verification for ${{ inputs.network }}."

.github/workflows/main.yml

@@ -2,15 +2,21 @@ name: Default
 
 on:
   pull_request:
+  workflow_call:
+    inputs:
+      SEPOLIA_RPC_URL:
+        required: true
+        type: string
+      ARBITRUM_SEPOLIA_RPC_URL:
+        required: true
+        type: string
 
 concurrency:
   group: ${{ github.ref }}-ci
   cancel-in-progress: true
 
 env:
   FOUNDRY_PROFILE: ci
-  SEPOLIA_RPC_URL: secrets.SEPOLIA_RPC_URL
-  ARBITRUM_SEPOLIA_RPC_URL: secrets.ARBITRUM_SEPOLIA_RPC_URL
 
 jobs:
   build-and-test:
@@ -23,6 +29,9 @@ jobs:
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: stable
+          cache: true
 
       - name: Show Forge version
         run: forge --version
@@ -31,12 +40,14 @@ jobs:
         run: forge fmt --check
 
       - name: Run Forge build
-        run: forge build && forge build './src' --sizes && cp .env.template .env
+        run: forge build && forge build './src' --sizes
 
       - name: Run Foundry coverage
-        run: make generate-coverage
         env:
           CI: true
+          SEPOLIA_RPC_URL: ${{ inputs.SEPOLIA_RPC_URL || vars.SEPOLIA_RPC_URL }}
+          ARBITRUM_SEPOLIA_RPC_URL: ${{ inputs.ARBITRUM_SEPOLIA_RPC_URL || vars.ARBITRUM_SEPOLIA_RPC_URL }}
+        run: make generate-coverage
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v5

Makefile

@@ -66,16 +66,25 @@ deploy-on-testnets:
 		TARGET_CHAIN=arbitrum_sepolia TARGET_RPC=$(ARBITRUM_SEPOLIA_RPC_URL) \
 		OPTIONS="--verify --verifier etherscan --verifier-api-key $(ETHERSCAN_API_KEY) --verifier-url $(ETHERSCAN_API_URL)"
 
+deploy-liquidity-unifier-and-bridge:
+	$(MAKE) deploy-contract CONTRACT=RLCLiquidityUnifier CHAIN=$(CHAIN) RPC_URL=$(RPC_URL) OPTIONS="$(OPTIONS)"
+	$(MAKE) deploy-contract CONTRACT=bridges/layerZero/IexecLayerZeroBridge CHAIN=$(CHAIN) RPC_URL=$(RPC_URL) OPTIONS="$(OPTIONS)"
+
+deploy-crosschain-token-and-bridge:
+	$(MAKE) deploy-contract CONTRACT=RLCCrosschainToken CHAIN=$(CHAIN) RPC_URL=$(RPC_URL) OPTIONS="$(OPTIONS)"
+	$(MAKE) deploy-contract CONTRACT=bridges/layerZero/IexecLayerZeroBridge CHAIN=$(CHAIN) RPC_URL=$(RPC_URL) OPTIONS="$(OPTIONS)"
+
 deploy-all: # SOURCE_CHAIN, SOURCE_RPC, TARGET_CHAIN, TARGET_RPC, OPTIONS
-	$(MAKE) deploy-contract CONTRACT=RLCLiquidityUnifier CHAIN=$(SOURCE_CHAIN) RPC_URL=$(SOURCE_RPC) OPTIONS="$(OPTIONS)"
-	$(MAKE) deploy-contract CONTRACT=bridges/layerZero/IexecLayerZeroBridge CHAIN=$(SOURCE_CHAIN) RPC_URL=$(SOURCE_RPC) OPTIONS="$(OPTIONS)"
-	$(MAKE) deploy-contract CONTRACT=RLCCrosschainToken CHAIN=$(TARGET_CHAIN) RPC_URL=$(TARGET_RPC) OPTIONS="$(OPTIONS)"
-	$(MAKE) deploy-contract CONTRACT=bridges/layerZero/IexecLayerZeroBridge CHAIN=$(TARGET_CHAIN) RPC_URL=$(TARGET_RPC) OPTIONS="$(OPTIONS)"
+	$(MAKE) deploy-liquidity-unifier-and-bridge CHAIN=$(SOURCE_CHAIN) RPC_URL=$(SOURCE_RPC) OPTIONS=$(OPTIONS)
+	$(MAKE) deploy-crosschain-token-and-bridge CHAIN=$(TARGET_CHAIN) RPC_URL=$(TARGET_RPC) OPTIONS=$(OPTIONS)
+	@echo "Contracts deployment completed."
+	@echo "⚠️ Run 'make configure-all' to configure bridges."
+	@echo "⚠️ Please configure the bridges. Do not forget to authorize the RLCLiquidityUnifier and RLCCrosschainToken contracts on the bridges."
+
+configure-all: # SOURCE_CHAIN, TARGET_CHAIN, SOURCE_RPC, TARGET_RPC
 	$(MAKE) configure-bridge SOURCE_CHAIN=$(SOURCE_CHAIN) TARGET_CHAIN=$(TARGET_CHAIN) RPC_URL=$(SOURCE_RPC)
 	$(MAKE) configure-bridge SOURCE_CHAIN=$(TARGET_CHAIN) TARGET_CHAIN=$(SOURCE_CHAIN) RPC_URL=$(TARGET_RPC)
-	@echo "Deployment completed."
-	@echo "⚠️ Please authorize bridges on RLCLiquidityUnifier and RLCCrosschainToken contracts."
-	# TODO verify contracts after deployment.
+	@echo "Bridge configuration completed."
 
 #
 # High-level upgrade targets
@@ -111,7 +120,7 @@ deploy-contract: # CONTRACT, CHAIN, RPC_URL, OPTIONS
 	@echo "Deploying $(CONTRACT) on $(CHAIN) with options: $(OPTIONS)"
 	CHAIN=$(CHAIN) forge script script/$(CONTRACT).s.sol:Deploy \
 		--rpc-url $(RPC_URL) \
-		--account $(ACCOUNT) \
+		$$(if [ "$(CI)" = "true" ]; then echo "--private-key $(DEPLOYER_PRIVATE_KEY)"; else echo "--account $(ACCOUNT)"; fi) \
 		$(OPTIONS) \
 		--broadcast \
 		-vvv