Merge pull request #696 from onflow/jp/docker-fixes

Docker updates to build and run

Author: franklywatson

.github/workflows/build.yml

@@ -40,5 +40,5 @@ jobs:
       - name: Docker Auth
         run: |-
           gcloud auth configure-docker ${{ vars.GAR_LOCATION }}-docker.pkg.dev
-          docker build -t ${{ env.DOCKER_IMAGE_URL }}:${{ steps.set_version.outputs.GATEWAY_VERSION }} --build-arg GATEWAY_VERSION=${{ steps.set_version.outputs.GATEWAY_VERSION }} --file Dockerfile .
+          docker build --build-arg VERSION="${{ steps.set_version.outputs.GATEWAY_VERSION }}" --build-arg ARCH=amd64 -t ${{ env.DOCKER_IMAGE_URL }}:${{ steps.set_version.outputs.GATEWAY_VERSION }} --file Dockerfile .
           docker push ${{ env.DOCKER_IMAGE_URL }}:${{ steps.set_version.outputs.GATEWAY_VERSION }}

.gitignore

@@ -5,6 +5,5 @@ tests/e2e-network/node_modules
 tests/e2e-network/package-lock.json
 db
 flow.json
-flow*.json
 .idea
 metrics/data/

Dockerfile

@@ -2,8 +2,6 @@
 
 FROM golang:1.22.0 as app-builder
 
-ARG GATEWAY_VERSION="v0.1.0"
-
 # Build the app binary in /app
 WORKDIR /app
 
@@ -14,8 +12,11 @@ COPY . ./
 RUN go mod download
 RUN go mod verify
 
+ARG VERSION
+ARG ARCH
+
 # Build binary
-RUN CGO_ENABLED=1 go build -o bin -ldflags="-X github.com/onflow/flow-evm-gateway/api.Version=${GATEWAY_VERSION}" cmd/main.go
+RUN CGO_ENABLED=1 GOOS=linux GOARCH=$ARCH build -o bin -ldflags="-X github.com/onflow/flow-evm-gateway/api.Version=$VERSION" -trimpath cmd/main.go
 RUN chmod a+x bin
 
 # RUN APP

Makefile

@@ -1,3 +1,64 @@
+# The short Git commit hash
+SHORT_COMMIT := $(shell git rev-parse --short HEAD)
+BRANCH_NAME:=$(shell git rev-parse --abbrev-ref HEAD | tr '/' '-')
+# The Git commit hash
+COMMIT := $(shell git rev-parse HEAD)
+# The tag of the current commit, otherwise empty
+GIT_VERSION := $(shell git describe --tags --abbrev=2 2>/dev/null)
+CMD_ARGS :=
+# ACCESS_NODE_SPORK_HOSTS are comma separated
+TESTNET_ACCESS_NODE_SPORK_HOSTS := access-001.devnet51.nodes.onflow.org:9000
+MAINNET_ACCESS_NODE_SPORK_HOSTS := access-001.mainnet25.nodes.onflow.org:9000
+EMULATOR_COINBASE := FACF71692421039876a5BB4F10EF7A439D8ef61E
+EMULATOR_COA_ADDRESS := f8d6e0586b0a20c7
+EMULATOR_COA_KEY := 2619878f0e2ff438d17835c2a4561cb87b4d24d72d12ec34569acd0dd4af7c21
+UNAME_S := $(shell uname -s)
+# Set default values
+ARCH :=
+OS :=
+COMPILER_FLAGS := CGO_ENABLED=1
+
+EMULATOR_ARGS := --flow-network-id=flow-emulator \
+		--coinbase=$(EMULATOR_COINBASE) \
+		--coa-address=$(EMULATOR_COA_ADDRESS)  \
+		--coa-key=$(EMULATOR_COA_KEY)  \
+		--wallet-api-key=2619878f0e2ff438d17835c2a4561cb87b4d24d72d12ec34569acd0dd4af7c21 \
+		--gas-price=0 \
+		--log-writer=console \
+		--tx-state-validation=local-index \
+		--profiler-enabled=true \
+		--profiler-port=6060
+
+# Set VERSION from command line, environment, or default to SHORT_COMMIT
+VERSION ?= ${SHORT_COMMIT}
+
+# Set IMAGE_TAG from VERSION if not explicitly set
+IMAGE_TAG ?= ${VERSION}
+
+# Function to check and append required arguments
+define check_and_append
+$(if $($(2)),\
+    $(eval CMD_ARGS += --$(1)=$($(2))),\
+    $(error ERROR: $(2) ENV variable is required))
+endef
+
+# Determine OS and set ARCH
+ifeq ($(UNAME_S),Darwin)
+    OS := macos
+    ARCH := arm64
+    $(eval COMPILER_FLAGS += CGO_CFLAGS="-O2 -D__BLST_PORTABLE__")
+else ifeq ($(UNAME_S),Linux)
+    OS := linux
+    ARCH := amd64
+else
+    $(error Unsupported operating system: $(UNAME_S))
+endif
+
+# docker container registry
+export CONTAINER_REGISTRY := us-west1-docker.pkg.dev/dl-flow-devex-production/development
+export DOCKER_BUILDKIT := 1
+export DATADIR := /data
+
 .PHONY: test
 test:
 	# test all packages
@@ -20,7 +81,7 @@ check-tidy:
 
 .PHONY: build
 build:
-	CGO_ENABLED=1 go build -o flow-evm-gateway -ldflags="-X github.com/onflow/flow-evm-gateway/api.Version=$(shell git describe --tags --abbrev=0 2>/dev/null || echo 'unknown')" cmd/main.go
+	$(COMPILER_FLAGS) go build -o flow-evm-gateway -ldflags="-X github.com/onflow/flow-evm-gateway/api.Version=$(IMAGE_TAG)" cmd/main.go
 	chmod a+x flow-evm-gateway
 
 .PHONY: fix-lint
@@ -44,37 +105,113 @@ ci: check-tidy test e2e-test
 
 .PHONY: start
 start:
-	go run ./cmd/server/main.go
+	$(COMPILER_FLAGS) go run ./cmd/main.go
 
 .PHONY: start-local
 start-local:
 	rm -rf db/
 	rm -rf metrics/data/
-	go run cmd/main.go run \
-		--flow-network-id=flow-emulator \
-		--coinbase=FACF71692421039876a5BB4F10EF7A439D8ef61E \
-		--coa-address=f8d6e0586b0a20c7 \
-		--coa-key=2619878f0e2ff438d17835c2a4561cb87b4d24d72d12ec34569acd0dd4af7c21 \
-		--wallet-api-key=2619878f0e2ff438d17835c2a4561cb87b4d24d72d12ec34569acd0dd4af7c21 \
-		--coa-resource-create=true \
-		--gas-price=0 \
-		--log-writer=console \
-		--profiler-enabled=true \
-		--profiler-port=6060
+	$(COMPILER_FLAGS) go run cmd/main.go run $(EMULATOR_ARGS)
 
 # Use this after running `make build`, to test out the binary
 .PHONY: start-local-bin
 start-local-bin:
 	rm -rf db/
 	rm -rf metrics/data/
-	./flow-evm-gateway run \
-		--flow-network-id=flow-emulator \
-		--coinbase=FACF71692421039876a5BB4F10EF7A439D8ef61E \
-		--coa-address=f8d6e0586b0a20c7 \
-		--coa-key=2619878f0e2ff438d17835c2a4561cb87b4d24d72d12ec34569acd0dd4af7c21 \
-		--wallet-api-key=2619878f0e2ff438d17835c2a4561cb87b4d24d72d12ec34569acd0dd4af7c21 \
-		--coa-resource-create=true \
-		--gas-price=0 \
-		--log-writer=console \
-		--profiler-enabled=true \
-		--profiler-port=6060
+	$(COMPILER_FLAGS) go run cmd/main.go run $(EMULATOR_ARGS)
+
+# Build docker image from local sources
+.PHONY: docker-build-local
+docker-build-local:
+ifdef GOARCH
+	$(eval ARCH=$(GOARCH))
+endif
+	docker build --build-arg ARCH=$(ARCH) --no-cache -f dev/Dockerfile -t "$(CONTAINER_REGISTRY)/flow-evm-gateway:$(COMMIT)" .
+
+# Docker run for local development
+.PHONY: docker-run-local
+docker-run-local:
+	@trap 'kill $$(jobs -p)' EXIT
+	flow emulator -f dev/flow.json &
+	sleep 3
+
+	$(call check_and_append,coinbase,EMULATOR_COINBASE)
+	$(call check_and_append,coa-address,EMULATOR_COA_ADDRESS)
+	$(call check_and_append,coa-key,EMULATOR_COA_KEY)
+
+	$(eval CMD_ARGS += --flow-network-id=flow-emulator --tx-state-validation=local-index --log-level=debug --gas-price=0 --log-writer=console --profiler-enabled=true --access-node-grpc-host=host.docker.internal:3569)
+
+	docker run -p 8545:8545 --add-host=host.docker.internal:host-gateway "$(CONTAINER_REGISTRY)/flow-evm-gateway:$(COMMIT)" $(CMD_ARGS)
+
+
+# Build docker image for release
+.PHONY: docker-build
+docker-build:
+ifdef GOARCH
+	$(eval ARCH=$(GOARCH))
+endif
+	docker build --build-arg VERSION="$(VERSION)" --build-arg ARCH=$(ARCH)  -f Dockerfile -t "$(CONTAINER_REGISTRY)/flow-evm-gateway:$(IMAGE_TAG)" \
+		--label "git_commit=$(COMMIT)" --label "git_tag=$(IMAGE_TAG)" .
+
+# Install image version from container registry
+.PHONY: docker-pull-version
+docker-pull-version:
+	docker pull "$(CONTAINER_REGISTRY)/flow-evm-gateway:$(IMAGE_VERSION)"
+
+# Run GW image
+# https://github.com/onflow/flow-evm-gateway?tab=readme-ov-file#configuration-flags
+# Requires the following ENV variables:
+#   - ACCESS_NODE_GRPC_HOST: [access.devnet.nodes.onflow.org:9000 | access.mainnet.nodes.onflow.org:9000]
+#   - FLOW_NETWORK_ID: [flow-testnet, flow-mainnet]
+#   - INIT_CADENCE_HEIGHT: [testnet: 211176670, mainnet: 85981135]
+#   - COINBASE: To be set by the operator. This is an EVM EOA or COA address which is set as the receiver of GW transaction fees (remove 0x prefix)
+#   - COA_ADDRESS: To be set by the operator. This is a Cadence address which funds gateway operations (remove 0x prefix)
+#   - COA_KEY: A full weight, private key belonging to operator COA_ADDRESS (remove 0x prefix). NB: For development use only. We recommend using cloud KMS configuration on mainnet
+#
+# Optional
+#   - GAS_PRICE: the attoFlow amount of gas to charge for transactions
+#
+# Optional make arguments:
+#   - DOCKER_RUN_DETACHED: Runs container in detached mode when true
+#   - DOCKER_HOST_PORT: Sets the exposed container port for the gateway JSON-RPC
+#   - DOCKER_MOUNT: Sets the host mount point for the EVM data dir
+.PHONY: docker-run
+docker-run:
+	$(eval CMD_ARGS :=)
+ifdef DOCKER_RUN_DETACHED
+	$(eval MODE=-d)
+endif
+ifdef DOCKER_HOST_PORT
+	$(eval HOST_PORT=$(DOCKER_HOST_PORT))
+else
+	$(eval HOST_PORT=8545)
+endif
+ifndef GAS_PRICE
+	$(eval GAS_PRICE=100)
+endif
+ifdef DOCKER_MOUNT
+	$(eval MOUNT=--mount type=bind,src="$(DOCKER_MOUNT)",target=$(DATADIR))
+	$(call check_and_append,database-dir,DATADIR)
+endif
+
+ifdef FLOW_NETWORK_ID
+    ifeq ($(FLOW_NETWORK_ID),flow-testnet)
+        ACCESS_NODE_SPORK_HOSTS := TESTNET_ACCESS_NODE_SPORK_HOSTS
+    else ifeq ($(FLOW_NETWORK_ID),flow-mainnet)
+        ACCESS_NODE_SPORK_HOSTS := MAINNET_ACCESS_NODE_SPORK_HOSTS
+    endif
+endif
+
+	$(call check_and_append,access-node-grpc-host,ACCESS_NODE_GRPC_HOST)
+	$(call check_and_append,flow-network-id,FLOW_NETWORK_ID)
+	$(call check_and_append,init-cadence-height,INIT_CADENCE_HEIGHT)
+	$(call check_and_append,coinbase,COINBASE)
+	$(call check_and_append,coa-address,COA_ADDRESS)
+	$(call check_and_append,coa-key,COA_KEY)
+	$(call check_and_append,gas-price,GAS_PRICE)
+
+	$(eval CMD_ARGS += --ws-enabled=true --rate-limit=9999999 --rpc-host=0.0.0.0 --log-level=info --tx-state-validation=local-index)
+	$(call check_and_append,access-node-spork-hosts,ACCESS_NODE_SPORK_HOSTS)
+
+	docker run $(MODE) -p $(HOST_PORT):8545 -p 8080:8080 $(MOUNT) "$(CONTAINER_REGISTRY)/flow-evm-gateway:$(IMAGE_TAG)" $(CMD_ARGS)
+