Makefile: Add Solana Makefile targets to top-level dir (#502)

nvsriram · johnsaigle · nonergodic · web-flow · commit f4d970e3bce5 · 2024-08-28T14:01:09.000-04:00
* solana: Add build, test, and lint targets to top-level dir

Adds Makefile targets for common Solana tasks in the top-level
directory. This allows the test and build pipeline to be run from the
main directory for both the EVM and Solana implementations.

This also helps to capture the Solana commands that are configured in
the .github/workflows/solana.yml file. In case this codebase is merged
or adapted into the Wormhole monorepo, the GitHub workflow may be
removed for modified. Therefore it is beneficial to track the
expected test configurations here.

* solana: Update Makefile targets and clippy command

* Makefile: Remove all target

* Makefile: Update .PHONY target names

Co-authored-by: Andreas &lt;41449730+nonergodic@users.noreply.github.com&gt;

* Makefile: Add Solana prod build and general targets to build/test/lint

* CI: Update Forge fmt to use new Makefile target

* chore: Readd newlines

* solana: Add build, test, and lint targets to top-level dir

Adds Makefile targets for common Solana tasks in the top-level
directory. This allows the test and build pipeline to be run from the
main directory for both the EVM and Solana implementations.

This also helps to capture the Solana commands that are configured in
the .github/workflows/solana.yml file. In case this codebase is merged
or adapted into the Wormhole monorepo, the GitHub workflow may be
removed for modified. Therefore it is beneficial to track the
expected test configurations here.

* solana: Update Makefile targets and clippy command

* Makefile: Remove all target

* Makefile: Update .PHONY target names

Co-authored-by: Andreas &lt;41449730+nonergodic@users.noreply.github.com&gt;

* Makefile: Add Solana prod build and general targets to build/test/lint

* CI: Update Forge fmt to use new Makefile target

* chore: Readd newlines

* solana: Update Makefile to include CI commands

* evm: Add Makefile with build, tests, and lint targets

* CI: Update evm.yml to use new targets

* Makefile: Add generic build, test, and lint targets

* CI: Set evm.yml working directory to ./evm

* CI: Untar echidna to echidna-bin to avoid name conflicts

* CI: Fix untar location from PATH to echidna-bin

---------

Co-authored-by: John Saigle &lt;john@asymmetric.re&gt;
Co-authored-by: Andreas &lt;41449730+nonergodic@users.noreply.github.com&gt;
diff --git a/.github/workflows/evm.yml b/.github/workflows/evm.yml
@@ -10,6 +10,10 @@ on:
 env:
   FOUNDRY_PROFILE: ci
 
+defaults:
+  run:
+    working-directory: ./evm
+
 jobs:
   check:
     strategy:
@@ -29,44 +33,44 @@ jobs:
 
       - name: Run Forge build
         run: |
-          make test-push0
+          make push0-test
         id: build
 
       - name: Run Forge tests
         run: |
-          make test-evm
+          make forge-test
         id: test
 
       - name: Run Forge fmt
         run: |
-          make check-format
+          make lint
         id: check
-    
+
   echidna:
     name: echidna
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: recursive
-      
+
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
           version: nightly
 
       - name: Run Forge build
         run: |
-          make test-push0
+          make build
         id: build
 
       - name: Install Echidna
         run: |
           curl -LO https://github.com/crytic/echidna/releases/download/v2.2.3/echidna-2.2.3-x86_64-linux.tar.gz
-          tar -xzf echidna-2.2.3-x86_64-linux.tar.gz
+          mkdir echidna-bin
+          tar -xzf echidna-2.2.3-x86_64-linux.tar.gz -C echidna-bin
           pip install crytic-compile
-      
+
       - name: Run Echidna
         run: |
-          cd evm
-          ../echidna ./echidna --config echidna.yaml
+          echidna-bin/echidna ./echidna --config echidna.yaml
diff --git a/Makefile b/Makefile
@@ -1,40 +1,7 @@
-all: build
+PLATFORM_DIRS := evm solana
 
-#######################
-## BUILD
+TARGETS := build test lint
 
-.PHONY: build
-build-evm:
-	cd evm && forge build
-
-.PHONY: clean-evm
-clean-evm:
-	cd evm && forge clean
-
-.PHONY: build-evm-prod
-build-evm-prod: clean-evm
-	cd evm && docker build --target foundry-export -f Dockerfile -o out .
-
-.PHONY: gen-evm-bindings
-gen-evm-bindings: build-evm-prod
-	npm ci && cd evm/ts && npm run generate
-
-#######################
-## TESTS
-
-.PHONY: check-format
-check-format:
-	cd evm && forge fmt --check
-
-.PHONY: fix-format
-fix-format:
-	cd evm && forge fmt
-
-.PHONY: test
-test-evm:
-	cd evm && forge test -vvv
-
-# Verify that the contracts do not include PUSH0 opcodes
-test-push0:
-	cd evm && forge build --extra-output evm.bytecode.opcodes
-	@if grep -qr --include \*.json PUSH0 ./evm/out; then echo "Contract uses PUSH0 instruction" 1>&2; exit 1; else echo "PUSH0 Verification Succeeded"; fi
+.PHONY: $(TARGETS)
+$(TARGETS):
+	$(foreach dir,$(PLATFORM_DIRS), make -C $(dir) $@ &&) true
diff --git a/evm/Makefile b/evm/Makefile
@@ -0,0 +1,45 @@
+.DEFAULT_GOAL = build
+.PHONY: build prod-build clean gen-bindings test forge-test push0-test lint fix-lint
+
+
+#######################
+## BUILD
+
+build:
+	forge build
+
+
+prod-build: clean
+	docker build --target foundry-export -f Dockerfile -o out .
+
+clean:
+	forge clean
+
+gen-bindings: prod-build
+	npm ci && cd ts && npm run generate
+
+
+#######################
+## TESTS
+
+test: forge-test push0-test
+
+
+forge-test:
+	forge test -vvv
+
+# Verify that the contracts do not include PUSH0 opcodes
+push0-test:
+	forge build --extra-output evm.bytecode.opcodes
+	@if grep -qr --include \*.json PUSH0 ./evm/out; then echo "Contract uses PUSH0 instruction" 1>&2; exit 1; else echo "PUSH0 Verification Succeeded"; fi
+
+
+#######################
+## LINT
+
+lint:
+	forge fmt --check
+
+
+fix-lint:
+	forge fmt
diff --git a/solana/Makefile b/solana/Makefile
@@ -1,5 +1,5 @@
 .DEFAULT_GOAL = build
-.PHONY: build test idl sdk clean
+.PHONY: build cargo-build anchor-build prod-build test cargo-test anchor-test idl sdk clean node_modules lint fix-lint
 
 #find and convert version line:
 #  turn `const VERSION: &str = "major.minor.patch";` into `major_minor_patch`
@@ -8,18 +8,27 @@ VERSION = $(subst .,_,$(subst ;,,$(subst ",,$(lastword \
   $(shell grep "const VERSION" programs/example-native-token-transfers/src/lib.rs) \
 ))))
 
+
+#######################
+## BUILD
+
+build: cargo-build anchor-build
+
+
+cargo-build:
+	BPF_OUT_DIR="$(pwd)/target/deploy" cargo build-sbf
+
 # after building, remove the generics from the idl file. This is necessary as of anchor 0.29.0,
 # because the javascript library does not support generics yet, and just panics
-build:
+anchor-build:
 	anchor build --arch sbf
 	@echo "Removing generics from target/idl/example_native_token_transfers.json"
 	./scripts/patch-idl target/idl/example_native_token_transfers.json
 
+prod-build:
+	anchor build --verifiable
 
-test: idl sdk node_modules
-	anchor test --skip-build
-
-idl: build
+idl: anchor-build
 	@echo "IDL Version: $(VERSION)"
 	mkdir -p ts/idl/$(VERSION)/json
 	mkdir -p ts/idl/$(VERSION)/ts
@@ -29,7 +38,7 @@ idl: build
 	  tsx scripts/regenerateIdl.ts $$jsonfile > $$tsfile; \
 	done
 
-sdk: build
+sdk: anchor-build
 	@echo "Building SDK"
 	cd .. && npm ci && npm run build:solana
 
@@ -38,4 +47,32 @@ clean:
 	rm -rf .anchor node_modules
 
 node_modules:
-	npm install
+	npm install
+
+
+#######################
+## TESTS
+
+test: cargo-test anchor-test
+
+
+cargo-test:
+	cargo build-sbf --features "mainnet"
+	cargo test-sbf --features "mainnet"
+	cargo test
+
+anchor-test: idl sdk node_modules
+	anchor test --skip-build
+
+
+#######################
+## LINT
+
+lint:
+	cargo fmt --check --all --manifest-path Cargo.toml
+	cargo check --workspace --tests --manifest-path Cargo.toml
+	cargo clippy --workspace --tests --manifest-path Cargo.toml -- -Dclippy::cast_possible_truncation
+
+
+fix-lint:
+	cargo fmt --all --manifest-path Cargo.toml
