refactor: use relayer in docker compose and update makefile

Author: damiannolan

.github/workflows/docker.yml

@@ -21,6 +21,8 @@ jobs:
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
+        with:
+          install: true
 
       - name: Log in to GitHub Container Registry
         uses: docker/login-action@v3
@@ -35,4 +37,5 @@ jobs:
           context: .
           file: ./hyperlane/Dockerfile
           push: true
+          platforms: linux/amd64,linux/arm64
           tags: ghcr.io/${{ github.repository_owner }}/hyperlane-init:latest

Makefile

@@ -1,36 +1,11 @@
-VERSION := $(shell echo $(shell git describe --tags 2>/dev/null || git log -1 --format='%h') | sed 's/^v//')
-COMMIT := $(shell git rev-parse --short HEAD)
-DOCKER := $(shell which docker)
-DOCKER_BUF := $(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace bufbuild/buf
-IMAGE := ghcr.io/tendermint/docker-build-proto:latest
-DOCKER_PROTO_BUILDER := docker run -v $(shell pwd):/workspace --workdir /workspace $(IMAGE)
 PROJECT_NAME=$(shell basename "$(PWD)")
-HTTPS_GIT := https://github.com/celestiaorg/celestia-zkevm-ibc-demo
-SIMAPP_GHCR_REPO := ghcr.io/celestiaorg/celestia-zkevm-ibc-demo/simapp
-CELESTIA_PROVER_GHCR_REPO := ghcr.io/celestiaorg/celestia-zkevm-ibc-demo/celestia-prover
-EVM_PROVER_GHCR_REPO := ghcr.io/celestiaorg/celestia-zkevm-ibc-demo/evm-prover
-INDEXER_GHCR_REPO := ghcr.io/celestiaorg/celestia-zkevm-ibc-demo/indexer
-
-# process linker flags
-ldflags = -X github.com/cosmos/cosmos-sdk/version.Name=celestia-zkevm-ibc-demo \
-		  -X github.com/cosmos/cosmos-sdk/version.AppName=celestia-zkevm-ibc-demo \
-		  -X github.com/cosmos/cosmos-sdk/version.Version=$(VERSION) \
-		  -X github.com/cosmos/cosmos-sdk/version.Commit=$(COMMIT) \
-
-BUILD_FLAGS := -tags "ledger" -ldflags '$(ldflags)'
 
 ## help: Get more info on make commands.
 help: Makefile
 	@echo " Choose a command run in "$(PROJECT_NAME)":"
 	@sed -n 's/^##//p' $< | sort | column -t -s ':' | sed -e 's/^/ /'
 .PHONY: help
 
-## install-dependencies: Install all dependencies needed for the demo.
-install-dependencies:
-	@echo "--> Setting up Solidity IBC Eureka submodule"
-	@cd ./solidity-ibc-eureka && bun install && just install-operator
-.PHONY: install-dependencies
-
 ## check-dependencies: Check if all dependencies are installed.
 check-dependencies:
 	@echo "--> Checking if all dependencies are installed"
@@ -46,223 +21,50 @@ check-dependencies:
 		echo "Error: forge is not installed. Please install Foundry."; \
 		exit 1; \
 	fi
-	@if command -v bun >/dev/null 2>&1; then \
-		echo "bun is installed."; \
-	else \
-		echo "Error: bun is not installed. Please install bun."; \
-		exit 1; \
-	fi
-	@if command -v just >/dev/null 2>&1; then \
-		echo "just is installed."; \
-	else \
-		echo "Error: just is not installed. Please install just."; \
-		exit 1; \
-	fi
 	@if command -v cargo prove >/dev/null 2>&1; then \
 		echo "cargo prove is installed."; \
 	else \
 		echo "Error: succinct is not installed. Please install SP1."; \
 		exit 1; \
 	fi
-	@if command -v operator >/dev/null 2>&1; then \
-		echo "operator is installed."; \
-	else \
-		echo "Error: operator is not installed. Please run install-dependencies."; \
-		exit 1; \
-	fi
 	@echo "All dependencies are installed."
 .PHONY: check-dependencies
 
-## demo: Run the entire demo.
-demo:
-	@make start
-	@make setup
-	@make transfer
-	@make transfer-back
-.PHONY: demo
-
 ## start: Start all Docker containers for the demo.
 start:
+	@echo "--> Starting all Docker containers"
 	@docker compose up --detach
 .PHONY: start
 
-## relay-local: Start a local instance of the hyperlane relayer (NOTE: This is temporary and should be removed in favour of Docker).
-relay-local:
-	@echo "--> Starting hyperlane relayer"
-	@cd local && CONFIG_FILES=./config/config.json ./relayer
-.PHONY: relay-local
-
-## setup: Set up the IBC light clients.
-setup:
-	@echo "--> Creating genesis.json for Tendermint light client"
-	@cd ./solidity-ibc-eureka && cargo run --quiet --bin operator --release -- genesis -o scripts/genesis.json --proof-type groth16
-	@echo "--> Creating IBC light clients"
-	@go run ./testing/demo/pkg/setup/
-.PHONY: setup
+## stop: Stop all Docker containers and remove volumes.
+stop:
+	@echo "--> Stopping all Docker containers"
+	@docker compose down -v
+.PHONY: stop
 
-## transfer: Transfer tokens from simapp to the EVM roll-up.
+## transfer: Transfer tokens from celestia-app to the EVM roll-up.
 transfer:
-	@echo "--> Transferring tokens from simapp to the EVM roll-up"
-	@go run ./testing/demo/pkg/transfer/ transfer
+	@echo "--> Transferring tokens from celestia-app to the EVM roll-up"
+	@docker run --rm \
+  		--network celestia-zkevm-hl-testnet_celestia-zkevm-net \
+  		--volume celestia-zkevm-hl-testnet_celestia-app:/home/celestia/.celestia-app \
+  		ghcr.io/celestiaorg/celestia-app-standalone:feature-zk-execution-ism \
+  		tx warp transfer 0x726f757465725f61707000000000000000000000000000010000000000000000 1234 0x000000000000000000000000d7958B336f0019081Ad2279B2B7B7c3f744Bce0a "1000" \
+  		--from default --fees 400utia --max-hyperlane-fee 100utia --node http://celestia-validator:26657 --yes
 .PHONY: transfer
 
-## transfer-back: Transfer tokens back from the EVM roll-up to simapp.
+## transfer-back: Transfer tokens back from the EVM roll-up to celestia-app.
+# TODO: https://github.com/celestiaorg/celestia-zkevm-hl-testnet/issues/34
 transfer-back:
-	@echo "--> Transferring tokens back from the EVM roll-up to simapp"
+	@echo "--> Transferring tokens back from the EVM roll-up to celestia-app"
 	@go run ./testing/demo/pkg/transfer/ transfer-back
 .PHONY: transfer-back
 
 ## query-balance: Query the balance of the receiver in the EVM roll-up.
 query-balance:
-	@echo "--> Querying the balance of the receivier on the EVM roll-up"
-	@go run ./testing/demo/pkg/transfer/ query-balance
+	@echo "--> Querying the balance of the receiver on the EVM roll-up"
+	@cast call 0xa7578551baE89a96C3365b93493AD2D4EBcbAe97 \
+  		"balanceOf(address)(uint256)" \
+  		0xd7958B336f0019081Ad2279B2B7B7c3f744Bce0a \
+  		--rpc-url http://localhost:8545
 .PHONY: query-balance
-
-## stop: Stop all Docker containers and remove volumes.
-stop:
-	@echo "--> Stopping all Docker containers"
-	@docker compose down -v
-.PHONY: stop
-
-## build: Build the simapp and indexer binaries into the ./build directory.
-build: build-simapp build-indexer
-.PHONY: build
-
-## build-simapp: Build the simapp binary into the ./build directory.
-build-simapp: mod
-	@cd ./simapp/simd/
-	@mkdir -p build/
-	@go build $(BUILD_FLAGS) -o build/ ./simapp/simd/
-.PHONY: build-simapp
-
-## build-indexer: Build the indexer binary
-build-indexer:
-	@cd ./indexer
-	@mkdir -p build/
-	@cd indexer && go build $(BUILD_FLAGS) -o build/ .
-.PHONY: build-indexer
-
-## build-evm-prover: Build the EVM prover binary
-build-evm-prover:
-	@cargo build --release --bin evm-prover
-.PHONY: build-evm-prover
-
-## install: Install the simapp binary into the $GOPATH/bin directory.
-install: install-simapp
-.PHONY: install
-
-## install-simapp: Build and install the simapp binary into the $GOPATH/bin directory.
-install-simapp:
-	@echo "--> Installing simd"
-	@go install $(BUILD_FLAGS) ./simapp/simd/
-.PHONY: install-simapp
-
-## mod: Update all go.mod files.
-mod:
-	@echo "--> Updating go.mod"
-	@go mod tidy
-.PHONY: mod
-
-## proto-gen: Generate protobuf files. Requires docker.
-proto-gen:
-	@echo "--> Generating Protobuf files"
-	$(DOCKER_BUF) generate
-.PHONY: proto-gen
-
-## proto-lint: Lint protobuf files. Requires docker.
-proto-lint:
-	@echo "--> Linting Protobuf files"
-	@$(DOCKER_BUF) lint --error-format=json
-.PHONY: proto-lint
-
-## proto-check-breaking: Check if there are any breaking change to protobuf definitions.
-proto-check-breaking:
-	@echo "--> Checking if Protobuf definitions have any breaking changes"
-	@$(DOCKER_BUF) breaking --against $(HTTPS_GIT)#branch=main
-.PHONY: proto-check-breaking
-
-## proto-format: Format protobuf files. Requires Docker.
-proto-format:
-	@echo "--> Formatting Protobuf files"
-	@$(DOCKER_PROTO_BUILDER) find . -name '*.proto' -path "./proto/*" -exec clang-format -i {} \;
-.PHONY: proto-format
-
-## docker: Build the all Docker images.
-docker: build-simapp-docker build-indexer-docker build-celestia-prover-docker build-evm-prover-docker
-.PHONY: docker
-
-## build-simapp-docker: Build the simapp docker image from the current branch. Requires docker.
-build-simapp-docker: build-simapp
-	@echo "--> Building simapp Docker image"
-	$(DOCKER) build -t $(SIMAPP_GHCR_REPO) --file docker/simapp.Dockerfile .
-.PHONY: build-simapp-docker
-
-## build-indexer-docker: Build the indexer docker image. Requires docker.
-build-indexer-docker: build-indexer
-	@echo "--> Building indexer Docker image"
-	$(DOCKER) build -t $(INDEXER_GHCR_REPO) --file docker/indexer.Dockerfile indexer
-.PHONY: build-indexer-docker
-
-## build-celestia-prover-docker: Build the celestia prover docker image from the current branch. Requires docker.
-build-celestia-prover-docker:
-	@echo "--> Building celestia prover Docker image"
-	$(DOCKER) build -t $(CELESTIA_PROVER_GHCR_REPO) --file docker/celestia_prover.Dockerfile .
-.PHONY: build-celestia-prover-docker
-
-## build-evm-prover-docker: Build the EVM prover docker image from the current branch. Requires docker.
-build-evm-prover-docker: build-evm-prover
-	@echo "--> Building EVM prover Docker image"
-	$(DOCKER) build -t $(EVM_PROVER_GHCR_REPO) --file docker/evm_prover.Dockerfile .
-.PHONY: build-evm-prover-docker
-
-# publish: Publish all Docker images to GHCR. Requires Docker and authentication.
-publish: publish-simapp-docker publish-celestia-prover-docker publish-evm-prover-docker
-.PHONY: publish
-
-## publish-simapp-docker: Publish the simapp docker image to GHCR. Requires Docker and authentication.
-publish-simapp-docker:
-	$(DOCKER) push $(SIMAPP_GHCR_REPO)
-.PHONY: publish-simapp-docker
-
-## publish-celestia-prover-docker: Publish the celestia prover docker image. Requires docker.
-publish-celestia-prover-docker:
-	$(DOCKER) push $(CELESTIA_PROVER_GHCR_REPO)
-.PHONY: publish-celestia-prover-docker
-
-## publish-evm-prover-docker: Publish the EVM prover docker image. Requires docker.
-publish-evm-prover-docker:
-	$(DOCKER) push $(EVM_PROVER_GHCR_REPO)
-.PHONY: publish-evm-prover-docker
-
-## lint: Run all linters; golangci-lint, markdownlint, hadolint, yamllint.
-lint:
-	@echo "--> Running golangci-lint"
-	@golangci-lint run
-	@echo "--> Running markdownlint"
-	@markdownlint --config .markdownlint.yaml '**/*.md'
-	@echo "--> Running hadolint"
-	@hadolint docker/**
-	@echo "--> Running yamllint"
-	@yamllint --no-warnings . -c .yamllint.yml
-.PHONY: lint
-
-## markdown-link-check: Check all markdown links.
-markdown-link-check:
-	@echo "--> Running markdown-link-check"
-# Skip the solidity-ibc-eureka directory because we don't want to fix their broken links.
-	@find . -name \*.md -not -path "./solidity-ibc-eureka/*" -print0 | xargs -0 -n1 markdown-link-check
-.PHONY: markdown-link-check
-
-## fmt: Format files per linters golangci-lint and markdownlint.
-fmt:
-	@echo "--> Running golangci-lint --fix"
-	@golangci-lint run --fix
-	@echo "--> Running markdownlint --fix"
-	@markdownlint --fix --quiet --config .markdownlint.yaml .
-.PHONY: fmt
-
-## test: Run tests.
-test:
-	@echo "--> Running tests"
-	@go test -timeout 30m ./...
-.PHONY: test

README.md

@@ -1,12 +1,9 @@
-# ZK EVM IBC demo
+# ZK EVM Hyperlane
 
 > [!WARNING]
 > This repository is a work in progress and under active development.
 
-This repo exists to showcase transferring tokens between SimApp (a Cosmos SDK chain representing Celestia) and a ZK proveable EVM via [IBC V2](https://github.com/cosmos/ibc/blob/main/spec/IBC_V2/README.md) (formerly known as IBC Eureka) and the IBC V2 [solidity contracts](https://github.com/cosmos/solidity-ibc-eureka/blob/main/README.md). The diagram below is meant to detail the components involved and, at a high level, how they interact with one another.
-
-![mvp-zk-accounts](./docs/images/mvp-zk-accounts.png)
-
+This repository showcases a bridged token transfer between Celestia and a ZK proveable EVM via [Hyperlane](https://hyperlane.xyz/). 
 For more information refer to the [architecture](./docs/ARCHITECTURE.md). Note that the design is subject to change.
 
 ## Usage
@@ -23,64 +20,52 @@ NETWORK_PRIVATE_KEY="PRIVATE_KEY" to the SP1 prover network private key from Cel
 ### Prerequisites
 
 1. Install [Docker](https://docs.docker.com/get-docker/)
-1. Install [Rust](https://rustup.rs/)
-1. Install [Foundry](https://book.getfoundry.sh/getting-started/installation)
-1. Install [Bun](https://bun.sh/)
-1. Install [Just](https://just.systems/man/en/)
-1. Install [SP1](https://docs.succinct.xyz/docs/sp1/getting-started/install)
+2. Install [Foundry](https://book.getfoundry.sh/getting-started/installation)
+3. Install [Rust](https://rustup.rs/)
+4. Install [SP1](https://docs.succinct.xyz/docs/sp1/getting-started/install)
 
 ### Steps
 
-1. Fork this repo and clone it
-1. Set up the git submodule for `solidity-ibc-eureka`
+1. Clone this repository.
 
     ```shell
-    git submodule init
-    git submodule update
+    git clone git@github.com:celestiaorg/celestia-zkevm-hl-testnet.git
     ```
 
-1. Create the `.env` file in this repo
+2. Source the provided `.env` file in this repository.
 
     ```shell
     cp .env.example .env
-    ```
-
-1. Run sp1up
 
-    ```shell
-    sp1up
+    set -a
+    source .env
+    set +a
     ```
 
-1. Install contract dependencies and the SP1 Tendermint light client operator binary from solidity-ibc-eureka.
+3. Start the docker compose services.
 
     ```shell
-    make install-dependencies
+    # Run `make start` or `docker compose up` from the root of the repository
+    make start 
     ```
 
-1. Build the docker images
+4. Allow the `hyperlane-init` service to complete the provisioning of Hyperlane EVM contracts and cosmosnative components.
 
     ```shell
-    make build-celestia-prover-docker
-    make build-evm-prover-docker
-    make build-indexer-docker
-    make build-simapp-docker
+    # Stream the logs via Docker to observe the status.
+    docker logs -f hyperlane-init
     ```
 
-1. Copy the proto_description.bin file one directory up in celestia prover
-    ```shell
-    cp ./provers/celestia-prover/prover/proto_descriptor.bin ./provers/celestia-prover/
-    ```
+5. Run a Hyperlane warp transfer, bridging `utia` from celestia to the reth service.
 
-1. Run the Celestia prover
     ```shell
-    cargo run --package celestia-prover
+    make transfer
     ```
 
-1. Run the demo in a different terminal window
+6. Query the ERC20 balance of the recipient on the reth service.
 
     ```shell
-    # This runs make start, setup, and transfer
-    make demo
+    make query-balance
     ```
 
 ## Architecture