From ed1cbb3d3975357c08e0dcf3d3439f92e60745d8 Mon Sep 17 00:00:00 2001
From: Halimao <1065621723@qq.com>
Date: Tue, 4 Mar 2025 11:32:12 +0800
Subject: [PATCH] build: add `help` target to `Makefile`

---
 Makefile | 71 ++++++++++++++++++++++++++++++--------------------------
 1 file changed, 38 insertions(+), 33 deletions(-)

diff --git a/Makefile b/Makefile
index d00ed152..e2168be2 100644
--- a/Makefile
+++ b/Makefile
@@ -1,80 +1,85 @@
 PROJECT=reddio
 
-default: build
+default: build ## Default target (alias for build)
 
-build:
+build: ## Build main project binary
 	go build -v -o $(PROJECT) ./cmd/node/main.go ./cmd/node/testrequest.go
 
+help: ## Display this help message
+	@echo "$$(tput bold)Available targets:$$(tput sgr0)"
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / { \
+		printf "\033[36m%-40s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
+
 ## for local dev
 
-build_transfer_test_no_race:
+build_transfer_test_no_race: ## Build transfer test without race detector
 	go build -v -o transfer_test ./test/cmd/transfer/main.go
 
-build_uniswap_test_no_race:
+build_uniswap_test_no_race: ## Build Uniswap test without race detector
 	go build -v -o uniswap_test ./test/cmd/uniswap/main.go
 
-build_uniswap_benchmark_test:
+build_uniswap_benchmark_test: ## Build Uniswap benchmark test
 	go build -v -o uniswap_benchmark_test ./test/cmd/uniswap_benchmark/main.go
 
-build_transfer_erc20_test_no_race:
+build_transfer_erc20_test_no_race: ## Build ERC20 transfer test
 	go build -v -o transfer_erc20_test ./test/cmd/erc20/main.go
 
 ## for ci
 
-build_transfer_test_race:
+build_transfer_test_race: ## Build transfer test with race detector
 	go build -race -v -o transfer_test ./test/cmd/transfer/main.go
 
-build_uniswap_test_race:
+build_uniswap_test_race: ## Build Uniswap test with race detector
 	go build -race -v -o uniswap_test ./test/cmd/uniswap/main.go
 
-build_transfer_erc20_test_race:
+build_transfer_erc20_test_race: ## Build ERC20 transfer test with race detector
 	go build -race -v -o transfer_erc20_test ./test/cmd/erc20/main.go
 
-ci_parallel_transfer_test: reset
+ci_parallel_transfer_test: reset ## Run transfer tests in parallel
 	./transfer_test --parallel=true
 
-ci_sqlite_parallel_transfer_test: reset
+ci_sqlite_parallel_transfer_test: reset ## Run SQLite parallel transfer tests
 	./transfer_test --parallel=true --use-sql=true
 
-ci_serial_transfer_test: reset
+ci_serial_transfer_test: reset ## Run transfer tests sequentially
 	./transfer_test --parallel=false
 
-ci_parallel_uniswap_test: reset
+ci_parallel_uniswap_test: reset ## Run Uniswap tests in parallel
 	./uniswap_test --parallel=true
 
-ci_sqlite_parallel_uniswap_test: reset
+ci_sqlite_parallel_uniswap_test: reset ## Run SQLite parallel Uniswap tests
 	./uniswap_test --parallel=true --use-sql=true
 
-ci_serial_uniswap_test: reset
+ci_serial_uniswap_test: reset ## Run Uniswap tests sequentially
 	./uniswap_test --parallel=false
 
-ci_parallel_transfer_erc20_test: reset
+ci_parallel_transfer_erc20_test: reset ## Run ERC20 transfer tests in parallel
 	./transfer_erc20_test --parallel=true
 
-ci_serial_transfer_erc20_test: reset
+ci_serial_transfer_erc20_test: reset ## Run ERC20 transfer tests sequentially
 	./transfer_erc20_test --parallel=FALSE
 
-build_state_root_test:
+build_state_root_test: ## Build state root test
 	go build -v -o state_root_test ./test/cmd/state_root/main.go
 
-state_root_test_gen: reset
+state_root_test_gen: reset ## Generate state root test data
 	./state_root_test --action=gen
 
-state_root_test_assert: reset
+state_root_test_assert: reset ## Verify state root test data
 	./state_root_test --action=assert
 
 ## for local benchmark
 
-build_benchmark_test:
+build_benchmark_test: ## Build benchmark test
 	go build -v -o benchmark_test ./test/cmd/benchmark/main.go
 
-parallel_benchmark_test:
+parallel_benchmark_test: ## Run parallel benchmark
 	./benchmark_test --parallel=true --maxBlock=50 --qps=1000 --embedded=false
 
-serial_benchmark_test:
+serial_benchmark_test: ## Run serial benchmark
 	./benchmark_test --parallel=false --maxBlock=50 --qps=1000 --embedded=false
 
-reset:
+reset: ## Reset local development environment
 	@if [ -d "yu" ]; then \
 		echo "Deleting 'yu' directory..."; \
 		rm -rf yu; \
@@ -84,19 +89,19 @@ reset:
 		rm -rf reddio_db; \
 	fi
 
-clean:
+clean: ## Remove main binary
 	rm -f $(PROJECT)
 
-clean_tests:
+clean_tests: ## Remove test binaries
 	rm uniswap_test benchmark_test
 
-clean_test_data:
+clean_test_data: ## Clean test temporary data
 	@if [ -d "test/tmp" ]; then \
 		echo "Deleting 'test/tmp' directory..."; \
 		rm -rf test/tmp; \
 	fi
 
-check-mod-tidy:
+check-mod-tidy: ## Verify go.mod cleanliness
 	@go mod tidy
 	@if [ -n "$$(git status --porcelain)" ]; then \
 		echo "Changes detected after running go mod tidy. Please run 'go mod tidy' locally and commit the changes."; \
@@ -154,19 +159,19 @@ PKG = contracts
 ABIGEN = abigen
 
 # Rule to generate all Go bindings
-generate_bindings:
+generate_bindings: ## Generate Go contract bindings for core contracts
 	$(ABIGEN) --abi $(ERC20T_ABI) --bin $(ERC20T_BIN) --pkg $(PKG) --type ERC20T --out $(ERC20T_GO)
 	$(ABIGEN) --abi $(TOKEN_ABI) --bin $(TOKEN_BIN) --pkg $(PKG) --type Token --out $(TOKEN_GO)
 	$(ABIGEN) --abi $(WETH9_ABI) --bin $(WETH9_BIN) --pkg $(PKG) --type WETH9 --out $(WETH9_GO)
 	$(ABIGEN) --abi $(UNISWAPV2FACTORY_ABI) --bin $(UNISWAPV2FACTORY_BIN) --pkg $(PKG) --type UniswapV2Factory --out $(UNISWAPV2FACTORY_GO)
 	$(ABIGEN) --abi $(UNISWAPV2ROUTER01_ABI) --bin $(UNISWAPV2ROUTER01_BIN) --pkg $(PKG) --type UniswapV2Router01 --out $(UNISWAPV2ROUTER01_GO)
 	# Clean up generated files
-clean_bindings:
+clean_bindings: ## Clean generated contract bindings
 	rm -f $(ERC20T_GO) $(TOKEN_GO) $(WETH9_GO) $(UNISWAPV2FACTORY_GO) $(UNISWAPV2ROUTER01_GO)
 
 BRIDGE_PKG = contract
 
-generate_bridge_bindings:
+generate_bridge_bindings: ## Generate Go contract bindings for bridge contracts
 	$(ABIGEN) --abi $(CHILDBRIDGECOREFACET_ABI) --pkg $(BRIDGE_PKG) --type ChildBridgeCoreFacet --out $(CHILDBRIDGECOREFACET_GO)
 	$(ABIGEN) --abi $(PARENTBRIDGECOREFACET_ABI) --pkg $(BRIDGE_PKG) --type ParentBridgeCoreFacet --out $(PARENTBRIDGECOREFACET_GO)
 	$(ABIGEN) --abi $(UPWARDMESSAGEDISPATCHERFACET_ABI) --pkg $(BRIDGE_PKG) --type UpwardMessageDispatcherFacet --out $(UPWARDMESSAGEDISPATCHERFACET_GO)
@@ -174,10 +179,10 @@ generate_bridge_bindings:
 
 
 TEST_PKG = bindings
-generate_intergration_test_bindings:
+generate_intergration_test_bindings: ## Generate Go integration test bindings for core and bridge contracts
 	$(ABIGEN) --abi $(ERC20TOKEN_ABI) --pkg $(TEST_PKG) --type ERC20Token --out $(ERC20TOKEN_GO)
 	$(ABIGEN) --abi $(ERC721TOKEN_ABI) --pkg $(TEST_PKG) --type ERC721Token --out $(ERC721TOKEN_GO)
 	$(ABIGEN) --abi $(ERC1155TOKEN_ABI) --pkg $(TEST_PKG) --type ERC1155Token --out $(ERC1155TOKEN_GO)
 	$(ABIGEN) --abi $(PARENTTOKENMESSAGETRANSMITTERFACET_ABI) --pkg $(TEST_PKG) --type ParentTokenMessageTransmitterFacet --out $(PARENTTOKENMESSAGETRANSMITTERFACET_GO)
 	$(ABIGEN) --abi $(CHILDTOKENMESSAGETRANSMITTERFACET_ABI) --pkg $(TEST_PKG) --type ChildTokenMessageTransmitterFacet --out $(CHILDTOKENMESSAGETRANSMITTERFACET_GO)
-	$(ABIGEN) --abi $(CHILDBRIDGECOREFACET_TEST_ABI) --pkg $(TEST_PKG) --type ChildBridgeCoreFacet --out $(CHILDBRIDGECOREFACET_TEST_GO)
\ No newline at end of file
+	$(ABIGEN) --abi $(CHILDBRIDGECOREFACET_TEST_ABI) --pkg $(TEST_PKG) --type ChildBridgeCoreFacet --out $(CHILDBRIDGECOREFACET_TEST_GO)