# Multisig.mk — Global macros for multisig approve / execute workflows.
#
# Every task template should `include ../../Multisig.mk` and define at minimum:
#   RPC_URL     — the RPC endpoint (typically $(L1_RPC_URL) or $(L2_RPC_URL))
#   SCRIPT_NAME — the Forge script class name or .sol file path
#
# The two macros below (MULTISIG_APPROVE, MULTISIG_EXECUTE) are the canonical
# way to invoke multisig operations. Signing is handled externally by the
# task-signing-tool.
#
# ---------- Common fragments ----------

LEDGER_HD_PATH = "m/44'/60'/$(LEDGER_ACCOUNT)'/0/0"

empty :=
space := $(empty) $(empty)
comma := ,

# Join a whitespace-separated list with ", " and normalize whitespace
comma_join = $(subst $(space),$(comma) ,$(strip $(foreach w,$(1),$(w))))

# Validation helper for required variables
require_vars = $(foreach _var,$(2),$(if $(strip $($(_var))),,$(error $(1): required variable $(_var) is not defined)))

# ---------- Procedures ----------

# MULTISIG_APPROVE: $(1)=address list (space-separated), $(2)=signatures (e.g., 0x or $(SIGNATURES))
define MULTISIG_APPROVE
$(call require_vars,MULTISIG_APPROVE,LEDGER_ACCOUNT RPC_URL SCRIPT_NAME) \
	$(MISE_EXEC) forge script --rpc-url $(RPC_URL) $(SCRIPT_NAME) \
	--sig "approve(address[],bytes)" "[$(call comma_join,$(1))]" $(2) \
	--ledger --hd-paths $(LEDGER_HD_PATH) --broadcast -vvvv
endef

# MULTISIG_EXECUTE: $(1)=signatures for run(bytes) (e.g., 0x or $(SIGNATURES))
define MULTISIG_EXECUTE
$(call require_vars,MULTISIG_EXECUTE,LEDGER_ACCOUNT RPC_URL SCRIPT_NAME) \
	$(MISE_EXEC) forge script --rpc-url $(RPC_URL) $(SCRIPT_NAME) \
	--sig "run(bytes)" $(1) \
	--ledger --hd-paths $(LEDGER_HD_PATH) --broadcast -vvvv
endef

# ---------- Validation file generation ----------

# GEN_VALIDATION: Generate a validation JSON file for multisig signing.
# $(1)=script_name, $(2)=safe_addr (comma-separated, or empty for []),
# $(3)=sender, $(4)=output_file, $(5)=env_vars (optional prefix)
#
# NOTE: The embedded `--forge-cmd` uses the bare literal `mise exec --` rather
# than `$(MISE_EXEC)`. The latter expands at Makefile parse time to either
# `mise exec --` (mise on PATH) or `$(HOME)/.local/bin/mise exec --` (fallback),
# which would bake a machine-specific absolute path into the generated validation
# JSON's `cmd` field — and that JSON is committed to the repo and re-hashed at
# verification time on other machines. By keeping the literal token, the
# committed file is portable; the trade-off is that `mise` must be discoverable
# on the signer-tool subprocess's PATH (see the bootstrap-mise warning and the
# README "Toolchain (mise)" section for the PATH requirement).
define GEN_VALIDATION
$(call require_vars,GEN_VALIDATION,RPC_URL LEDGER_ACCOUNT) \
	cd $(SIGNER_TOOL_PATH) && \
		$(MISE_EXEC) npx tsx scripts/genValidationFile.ts \
			--rpc-url $(RPC_URL) \
			--workdir $(CURDIR) \
			--forge-cmd '$(if $(5),$(5) )mise exec -- forge script --rpc-url $(RPC_URL) $(1) --sig "sign(address[])" "[$(2)]" --sender $(3)' \
			--ledger-id $(LEDGER_ACCOUNT) \
			--out $(CURDIR)/validations/$(4)
endef

# ---------- Helpers ----------

# GET_NONCE: Fetch the current nonce of a Safe contract.
# $(1)=safe_address
define GET_NONCE
$(shell $(MISE_EXEC) cast call $(1) "nonce()" --rpc-url $(RPC_URL) | $(MISE_EXEC) cast to-dec)
endef

# ADDR_UPPER: Convert an address to uppercase (for env var construction).
# Used to build per-Safe nonce override env vars passed to forge scripts,
# e.g. SAFE_NONCE_$(call ADDR_UPPER,$(SAFE_ADDR))=$(NONCE_VALUE)
# See mainnet/2026-02-19-superchain-separation for real-world usage.
# $(1)=address
define ADDR_UPPER
$(shell echo "$(1)" | tr '[:lower:]' '[:upper:]')
endef