More flexible parameterization

Author: brickpop

.env.example

@@ -1,6 +1,9 @@
 JSON_RPC_URL="https://eth-mainnet.g.alchemy.com/v2/<API-KEY>"
 # JSON_RPC_URL="https://eth-sepolia.g.alchemy.com/v2/<API-KEY>"
+# JSON_RPC_URL="https://eth-holesky.g.alchemy.com/v2/<API-KEY>"
 # JSON_RPC_URL="https://base-mainnet.g.alchemy.com/v2/<API-KEY>"
 # JSON_RPC_URL="https://polygon-rpc.com/"
 # JSON_RPC_URL="https://arb1.arbitrum.io/rpc"
 # JSON_RPC_URL="https://mainnet.era.zksync.io"
+# JSON_RPC_URL="https://mainnet.mode.network"
+# JSON_RPC_URL="https://linea.drpc.org"

.gitignore

@@ -1,4 +1,4 @@
 .env
 digest
-data/*json
+cache/*json
 deployments/all-*.json

Makefile

@@ -4,6 +4,8 @@
 include .env
 
 SHELL:=/bin/bash
+CACHE_PATH:=./cache
+OUTPUT_PATH:=./deployments
 
 # Target dependent variables
 deployment: export GENERATION_SCRIPT=generate-upgrade-deployment-config.ts
@@ -17,6 +19,8 @@ help: ## Display the current message
 	@cat Makefile | while IFS= read -r line; do \
 	   if [[ "$$line" == "##" ]]; then \
 			echo "" ; \
+		elif [[ "$$line" =~ ^##\ (.*)$$ ]]; then \
+			echo -e "$${BASH_REMATCH[1]}" ; \
 		elif [[ "$$line" =~ ^([^:]+):(.*)##\ (.*)$$ ]]; then \
 			echo -e "- make $${BASH_REMATCH[1]}  \t$${BASH_REMATCH[3]}" ; \
 		fi ; \
@@ -26,39 +30,39 @@ help: ## Display the current message
 
 .PHONY: init
 init: .env ## Check the dependencies and prepare the environment
-	@mkdir -p data deployments
+	@mkdir -p $(CACHE_PATH) $(OUTPUT_PATH)
 	@which docker > /dev/null || (echo "Error: Docker is not installed" ; exit 1)
 	@which jq > /dev/null || (echo "Error: jq is not installed" ; exit 1)
 	@which cast > /dev/null || (echo "Error: Foundry is not installed" ; exit 1)
 	docker pull denoland/deno:alpine
 
 .PHONY: clean
 clean: ## Clean the generated artifacts
-	rm -Rf ./data/*
+	rm -Rf $(CACHE_PATH)/*
 
 ##
 
 # Entry points
 
 .PHONY: deployment
-deployment: deployments/osx-$(network).json  ## Generate the config to verify with diffyscan-workspace
+deployment: $(OUTPUT_PATH)/osx-$(network).json  ## Generate the config to verify with diffyscan-workspace
 
 .PHONY: deployment-zk
-deployment-zk: deployments/osx-$(network).json  ## Generate the config to verify with diffyscan-workspace (only ZkSync)
+deployment-zk: $(OUTPUT_PATH)/osx-$(network).json  ## Generate the config to verify with diffyscan-workspace (only ZkSync)
 
 .PHONY: summary
-summary: data/upgrade-proposal-$(network)-$(address)-$(pid)-actions-decoded.json  ## Show the decoded proposal upgrade actions
+summary: $(CACHE_PATH)/upgrade-proposal-$(network)-$(address)-$(pid)-actions-decoded.json  ## Show the decoded proposal upgrade actions
 	docker run --rm \
     	-v ./scripts/summarize-upgrade-proposal.ts:/root/script.ts:ro \
     	-v ./scripts/lib.ts:/root/lib.ts:ro \
-    	-v ./$<:/root/data.json:ro \
+    	-v ./$<:/root/input.json:ro \
     	denoland/deno:alpine \
-    	deno run --allow-read /root/script.ts /root/data.json
+    	deno run --allow-read /root/script.ts /root/input.json
 
 # Internal targets
 
 # Deployment config <= Decoded proposal actions
-deployments/osx-$(network).json: data/upgrade-proposal-$(network)-$(address)-$(pid)-actions-decoded.json
+$(OUTPUT_PATH)/osx-$(network).json: $(CACHE_PATH)/upgrade-proposal-$(network)-$(address)-$(pid)-actions-decoded.json
 	@echo "Generating the deployment config file"
 	docker run --rm \
     	-v ./scripts/$(GENERATION_SCRIPT):/root/script.ts:ro \
@@ -67,37 +71,38 @@ deployments/osx-$(network).json: data/upgrade-proposal-$(network)-$(address)-$(p
     	-v ./scripts/template-token-voting.json:/root/template-token-voting.json:ro \
     	-v ./scripts/template-multisig.json:/root/template-multisig.json:ro \
     	-v ./scripts/template-admin.json:/root/template-admin.json:ro \
-    	-v ./$<:/root/data.json:ro \
+    	-v ./$<:/root/input.json:ro \
         -w /root \
     	denoland/deno:alpine \
-    	deno run --allow-read /root/script.ts /root/data.json $(network) > ./deployments/all-$(network).json
+    	deno run --allow-read /root/script.ts /root/input.json $(network) > $(OUTPUT_PATH)/all-$(network).json
 
-	jq ".osx" ./deployments/all-$(network).json > $(@)
-	jq ".tokenVoting" ./deployments/all-$(network).json > deployments/token-voting-$(network).json
-	jq ".multisig" ./deployments/all-$(network).json > deployments/multisig-$(network).json
-	jq ".admin" ./deployments/all-$(network).json > deployments/admin-$(network).json
+	@echo "Generating the config files:"
+	jq ".osx" $(OUTPUT_PATH)/all-$(network).json > $(@)
+	jq ".tokenVoting" $(OUTPUT_PATH)/all-$(network).json > $(OUTPUT_PATH)/token-voting-$(network).json
+	jq ".multisig" $(OUTPUT_PATH)/all-$(network).json > $(OUTPUT_PATH)/multisig-$(network).json
+	jq ".admin" $(OUTPUT_PATH)/all-$(network).json > $(OUTPUT_PATH)/admin-$(network).json
 
-	rm ./deployments/all-$(network).json
+	rm $(OUTPUT_PATH)/all-$(network).json
 
 # Decoded proposal actions <= Proposal raw actions
-data/upgrade-proposal-$(network)-$(address)-$(pid)-actions-decoded.json: data/upgrade-proposal-$(network)-$(address)-$(pid)-actions.json
+$(CACHE_PATH)/upgrade-proposal-$(network)-$(address)-$(pid)-actions-decoded.json: $(CACHE_PATH)/upgrade-proposal-$(network)-$(address)-$(pid)-actions.json
 	@echo "Decoding action parameters"
 	jq -r '.[] | "cast 4byte-decode \(.data)"' $< | while read cmd; do \
 	  data=$$(eval "$$cmd") ; \
 	  jq -n --arg data "$$data" '{"decoded": $$ARGS.named.data}' ; \
 	done | jq -s '.' > $(@)
 
 # Proposal raw actions <= Proposal raw data
-data/upgrade-proposal-$(network)-$(address)-$(pid)-actions.json: data/upgrade-proposal-$(network)-$(address)-$(pid)-raw.json
+$(CACHE_PATH)/upgrade-proposal-$(network)-$(address)-$(pid)-actions.json: $(CACHE_PATH)/upgrade-proposal-$(network)-$(address)-$(pid)-raw.json
 	@echo "Parsing proposal actions"
 	docker run --rm \
         -v ./scripts/parse-upgrade-proposal-actions.ts:/root/script.ts:ro \
-        -v ./$<:/root/data.json:ro \
+        -v ./$<:/root/input.json:ro \
         denoland/deno:alpine \
-        deno run --allow-read /root/script.ts /root/data.json > $(@)
+        deno run --allow-read /root/script.ts /root/input.json > $(@)
 
 # Fetch proposal data
-data/upgrade-proposal-$(network)-$(address)-$(pid)-raw.json:
+$(CACHE_PATH)/upgrade-proposal-$(network)-$(address)-$(pid)-raw.json:
 	@if [ -z "$(address)" ]; then echo "Please, append 'address=<plugin-address>'"; exit 1 ; fi
 	@if [ -z "$(pid)" ]; then echo "Please, append 'pid=<proposal-id>'"; exit 1 ; fi
 	@if [ -z "$(network)" ]; then echo "Please, append 'network=<name>'"; exit 1 ; fi