Makefile

# Make entire file 'silent' (unless make VERBOSE=1)
ifndef VERBOSE
	MAKEFLAGS += --silent
endif

include makefiles/lib.mk
include makefiles/help.mk

# ==================================================================================================
# Packages

# Order matters in all the below, it's structured so that the same package never appears twice
# in any variable.

# packages shared between SDK & iframe
SHARED_PKGS := support/common,support/wallet-common,support/worker

# packages only used in the SDK
SDK_ONLY_PKGS := packages/core,packages/react,packages/vue

# packages needed to build the sdk
SDK_PKGS := $(SHARED_PKGS),$(SDK_ONLY_PKGS)

# packages needed to build the boop skd
BOOP_SDK_PKGS := apps/submitter,packages/boop-sdk

# packages needed to build the iframe
IFRAME_PKGS := $(SHARED_PKGS),$(BOOP_SDK_PKGS),apps/iframe

# packages needed to build the sdk and iframe
ACCOUNT_PKGS := $(IFRAME_PKGS),$(SDK_ONLY_PKGS)

# demo packages (not including dependencies)
DEMOS_PKGS := demos/js,demos/react,demos/vue

# packages only used in the backend services
BACKEND_ONLY_PKGS := packages/txm,apps/randomness,apps/faucet,apps/monitor-service

# packages needed to build the backend services
BACKEND_PKGS := support/common,$(BACKEND_ONLY_PKGS)

# all typescript packages, excluding docs
TS_PKGS := $(ACCOUNT_PKGS),$(DEMOS_PKGS),${BACKEND_ONLY_PKGS}

# all packages that have a package.json
NPM_PKGS := $(TS_PKGS),apps/docs,contracts,support/configs,support/happybuild

# Packages that get published to npm
PUBLISHED_PKGS := $(SDK_ONLY_PKGS),packages/boop-sdk

# ==================================================================================================
# CMDS

# Concurrently or mprocs to run commands in parallel
MULTIRUN ?= concurrently

# ==================================================================================================
# HELPERS

# Validation function for Ethereum addresses (0x followed by 40 hex chars)
check_eth_address = $(shell echo $(1) | grep -E '^0x[a-fA-F0-9]{40}$$' > /dev/null && echo 1 || echo 0)

define forall
	$(eval PKGS := $(strip $(1)))
	$(eval CMD := $(2))
	for name in ./{$(PKGS)}; do\
		echo "Running $(CMD) in $${name}";\
		cd $${name} && $(CMD) && cd ../.. || (cd ../.. && exit 1);\
	done
endef

define forall_make
	$(eval PKGS := $(strip $(1)))
	$(eval TARGET := $(2))
	for name in ./{$(PKGS)}; do\
		echo "Running make $(TARGET) in $${name}";\
		make $(TARGET) --directory=$${name} || exit 1;\
	done
endef

define with_optional_iframe
	$(eval DEMO_NAME := $(strip $(1)))
	$(eval DEMO_PATH := $(strip $(2)))
	$(eval DEMO_CMD := $(strip $(3)))

	@if lsof -t -iTCP:5160 -sTCP:LISTEN &> /dev/null; then \
		$(MULTIRUN) --names $(DEMO_NAME) "cd $(DEMO_PATH) && make $(DEMO_CMD)";\
	else \
		$(MULTIRUN) --names "iframe,$(DEMO_NAME)" "cd apps/iframe && make $(DEMO_CMD)" "cd $(DEMO_PATH) && make $(DEMO_CMD)";\
	fi
endef

# e.g. $(call update_env,apps/iframe/.env,VITE_USE_STAGING_CONTRACTS,true)
# Updates the .env file non-destructively, in a section delimited by "### AUTOGEN" at the bottom of the file.
define update_env
	awk -v var="$(2)" -v val="$(3)" -v delim="### AUTOGEN" ' \
		BEGIN {found_delim=0; found_var=0;} \
		$$0 == delim {found_delim=1; print; next} \
		found_delim && $$0 ~ "^"var"=" {print var"="val; found_var=1; next} \
		{print} \
		END { \
			if (!found_delim) { \
				print ""; print delim; print var"="val; \
			} else if (!found_var) { \
				print var"="val; \
			} \
		}' $(1) > $(1).tmp && mv $(1).tmp $(1)
endef

# ==================================================================================================
# BASICS COMMANDS
#   To get the project running locally.

setup: install-frozen enable-hooks ## To be run when first setting up the repository.
	$(call forall_make , $(NPM_PKGS) , setup)
	@echo "Running make setup in ./contracts"
	@cd contracts && make setup
.PHONY: setup

clean: ts.clean docs.clean contracts.clean ## Removes build artifacts
.PHONY: clean

build: node_modules ts.build ## Creates production builds
.PHONY: build

build.check: ## Checks that the projects builds then resets to dev mode.
	make build && make reset-dev
.PHONY: build.check

reset-dev: node_modules ## Resets to dev (no-build) mode
	$(call forall_make , $(TS_PKGS) , reset-dev)
.PHONY: dev

nuke: clean ## Removes build artifacts and dependencies 
	cd contracts && make nuke
	$(MAKE) remove-modules
.PHONY: nuke

test: sdk.test iframe.test txm.test ## Run tests
.PHONY: test

test.all: test contracts.test
	# Not ideal, but for now we're assuming it was true.
	$(call update_env,apps/submitter/.env,AUTOMINE_TESTS,false)
	cd apps/submitter && make test || true
	$(call update_env,apps/submitter/.env,AUTOMINE_TESTS,true)
.PHONY: test.all

docs: node_modules docs.contained ## Builds latest docs and starts dev server http://localhost:4000
	cd apps/docs && make preview
.PHONY: docs

# ==================================================================================================
##@ Formatting
# cf. makefiles/formatting.mk

check: ## Runs code quality & formatting checks
	$(call forall_make , $(NPM_PKGS) , check)
	echo "Running make check in ./"
	biome check ./;
.PHONY: check

format: ## Formats code and tries to fix code quality issues
	$(call forall_make , $(NPM_PKGS) , format)
	biome check ./ --write; # top-level only
.PHONY: format

# ==================================================================================================
##@ Demos & Apps

submitter.dev: setup shared.dev ## Runs the submitter app at http://localhost:3001
	cd apps/submitter && make migrate;
	cd apps/submitter && make dev;
.PHONY: submitter.dev

submitter-local.dev: setup shared.dev setup-local-chain select-submitter-local ## Runs the submitter app on Anvil at http://localhost:3001
	cd apps/submitter && make migrate-fresh;
	cd apps/submitter && make dev;
.PHONY: submitter-local.dev

submitter.build: shared.build
	cd apps/submitter && make build;
	cd packages/boop-sdk && make build;
.PHONY: submitter.build

submitter.prod: submitter.build
	cd apps/submitter && make migrate;
	cd apps/submitter && make prod;
.PHONY: submitter.prod

iframe.dev: shared.dev sdk.dev ## Serves the wallet iframe at http://localhost:5160
	cd apps/iframe && make dev
.PHONY: iframe.dev

demo-all.dev: setup shared.dev sdk.dev ## Serves all demo applications at once
	$(MULTIRUN) --names "iframe,demo-js,demo-react,demo-vue" \
		"cd apps/iframe && make dev" \
		"cd demos/js && make dev" \
		"cd demos/react && make dev" \
		"cd demos/vue && make dev" \
		;\
.PHONY: demo-all.dev

demo-js.dev: setup shared.dev sdk.dev ## Serves the VanillaJS demo application at http://localhost:6001
	$(call with_optional_iframe, "demo-js", "demos/js", "dev")
.PHONY: demo-js.dev

demo-react.dev: setup shared.dev sdk.dev ## Serves the React demo application at http://localhost:6002
	$(call with_optional_iframe, "demo-react", "demos/react", "dev")
.PHONY: demo-react.dev

demo-vue.dev: setup shared.dev sdk.dev ## Serves the VueJS demo application at http://localhost:6003
	$(call with_optional_iframe, "demo-vue", "demos/vue", "dev")
.PHONY: demo-vue.dev

demo-js.prod: setup  ## Builds & runs the prod version of the JS demo at http://localhost:6001
	make demo-js.build;
	$(call with_optional_iframe, "demo-js", "demos/js", "preview")
.PHONY: demo-js.prod

demo-react.prod: setup ## Builds & runs the prod version of the React demo at http://localhost:6002
	make demo-react.build;
	$(call with_optional_iframe, "demo-react", "demos/react", "preview")
.PHONY: demo-react.prod

demo-vue.prod: setup sdk.build  ## Builds & runs the prod version of the Vue demo at http://localhost:6003
	make demo-vue.build;
	$(call with_optional_iframe, "demo-vue", "demos/vue", "preview")
.PHONY: demo-vue.prod

# ==================================================================================================
##@ Contracts

anvil: ## Runs anvil (local EVM node)
	cd contracts && make anvil
.PHONY: anvil

deploy: ## Deploys contracts to Anvil
	cd contracts && make deploy
.PHONY: deploy

contracts.test:
	cd contracts && make test
.PHONY: contracts.test

# ==================================================================================================
# DEVELOPMENT

shared.dev:
	$(call forall_make , $(SHARED_PKGS) , dev)
.PHONY: shared.dev

sdk.dev:
	$(call forall_make , $(SDK_ONLY_PKGS) , dev)
.PHONY: sdk-dev

# start docs in watch mode (can crash, see packages/docs/Makefile for more info)
docs.dev: setup shared.dev sdk.dev
	cd apps/docs && make dev
.PHONY: docs.dev

# ==================================================================================================
# CORRECTNESS

sdk.test:
	$(call forall_make , $(SDK_PKGS) , test)
.PHONY: sdk.test

iframe.test:
	$(call forall_make , $(IFRAME_PKGS) , test)
.PHONY: iframe.test

txm.test:
	cd packages/txm && make test
.PHONY: iframe.test

# ==================================================================================================
# FORMATTING

sdk.check:
	$(call forall_make , $(SDK_PKGS) , check)
.PHONY: sdk.check

iframe.check:
	$(call forall_make , $(IFRAME_PKGS) , check)
.PHONY: iframe.check

account.check:
	$(call forall_make , $(ACCOUNT_PKGS) , check)
.PHONY: account.check

demos.check:
	$(call forall_make , $(DEMOS_PKGS) , check)
.PHONY: apps.check

docs.check:
	echo "Running make check in apps/docs"
	cd apps/docs && make check
.PHONY: docs.check

backend.check:
	$(call forall_make , $(BACKEND_PKGS) , check)
.PHONY: backend.check

ts.check:
	$(call forall_make , $(TS_PKGS) , check)
.PHONY: ts.check

contracts.check:
	echo "Running make check in contracts"
	cd contracts && make check
.PHONY: contracts.check

sdk.format:
	$(call forall_make , $(SDK_PKGS) , format)
.PHONY: sdk.format

iframe.format:
	$(call forall_make , $(IFRAME_PKGS) , format)
.PHONY: iframe.format

account.format:
	$(call forall_make , $(ACCOUNT_PKGS) , format)
.PHONY: account.format

demos.format:
	$(call forall_make , $(DEMOS_PKGS) , format)
.PHONY: apps.format

docs.format:
	cd apps/docs && make format
.PHONY: docs.format

backend.format:
	$(call forall_make , $(BACKEND_PKGS) , format)
.PHONY: backend.format

ts.format:
	$(call forall_make , $(TS_PKGS) , format)
.PHONY: ts.format

contracts.format:
	cd contracts && make format
.PHONY: contracts.format

# ==================================================================================================
# PRODUCTION BUILDS

shared.build:
	$(call forall_make , $(SHARED_PKGS) , build)
.PHONY: shared.build

sdk.build:
	$(call forall_make , $(SDK_PKGS) , build)
.PHONY: sdk.build

iframe.build:
	$(call forall_make , $(IFRAME_PKGS) , build)
.PHONY: iframe.build

account.build:
	make sdk.build
	make iframe.build
.PHONY: account.build

demo-js.build: setup shared.build
	cd packages/core && make build
	cd demos/js && make build
.PHONY: demo-js.build

demo-react.build: setup shared.build
	cd packages/core && make build
	cd packages/react && make build
	cd demos/react && make build
.PHONY: demo-react.build

demo-vue.build: setup shared.build
	cd packages/core && make build
	cd demos/vue && make build
.PHONY: demo-vue.build

demos.build:
	$(call forall_make , $(DEMOS_PKGS) , build)
.PHONY: apps.build

backend.build:
	$(call forall_make , $(BACKEND_PKGS) , build)
.PHONY: backend.build

ts.build:
	$(call forall_make , $(TS_PKGS) , build)
.PHONY: ts.build

contracts.build:
	cd contracts && make build
.PHONY: contracts.build

randomness.build: setup shared.build
	cd packages/txm && make build
	cd apps/randomness && make build
.PHONY: randomness.build

randomness-monitor.build: setup shared.build
	cd apps/randomness-monitor && make build
.PHONY: randomness-monitor.build

txm.build: setup shared.build
	cd packages/txm && make build
.PHONY: txm.build

faucet.build: setup shared.build
	cd packages/txm && make build
	cd apps/faucet && make build
.PHONY: faucet.build

monitor-service.build: setup shared.build submitter.build
	cd packages/boop-sdk && make build
	cd packages/txm && make build
	cd apps/monitor-service && make build
.PHONY: monitor-service.build

# ==================================================================================================
##@ Docs

docs.build: ## Build the docs
	cd apps/docs && make build
.PHONY: docs.build

# Fully self-contained target to build docs, to be used by docs page host.
docs.contained: setup shared.dev sdk.dev docs.build 
.PHONY: docs.contained

docs.preview: ## Serve already-built docs
	cd apps/docs && make preview
.PHONY: docs.preview

# ==================================================================================================
# CLEANING

sdk.clean:
	$(call forall_make , $(SDK_PKGS) , clean)
.PHONY: sdk.clean

iframe.clean:
	$(call forall_make , $(IFRAME_PKGS) , clean)
.PHONY: iframe.clean

account.clean:
	$(call forall_make , $(ACCOUNT_PKGS) , clean)
.PHONY: account.clean

demos.clean:
	$(call forall_make , $(DEMOS_PKGS) , clean)
.PHONY: apps.clean

docs.clean:
	@echo "Running make clean in ./apps/docs"
	@cd apps/docs && make clean
.PHONY: docs.clean

backend.clean:
	$(call forall_make , $(BACKEND_PKGS) , clean)
.PHONY: backend.clean

ts.clean:
	$(call forall_make , $(TS_PKGS) , clean)
.PHONY: ts.clean

contracts.clean:
	@echo "Running make clean in ./contracts"
	@cd contracts && make clean
.PHONY: contracts.clean

# ==================================================================================================
# DEPENDENCY MANAGEMENT
#   Update dependencies, check for outdated dependencies, etc.

# Install packages as specified in bun.lock.
install-frozen:
	# --frozen-lockfile will not generate the lockfile if missing
	@if [ -r bun.lock ]; then \
		bun install --frozen-lockfile; \
	else \
		bun install; \
	fi
.PHONY: install-frozen

# NOTES:
#  Below "version specifier" refers to the version strings (e.g. "^1.2.3") in package.json.
#  You can safely use bun commands inside the packages, and things will behave like you expect
#  (i.e. update only the package, but use the bun monorepo architecture).

# Like npm install: if a version matching version specifier is installed, does nothing, otherwise
# installs the most up-to-date version matching the specifier.
install:
	@bun install
.PHONY: install

node_modules: package.json $(wildcard {apps,demos,packages,support}/*/package.json)
	@bun install

# Shows packages for which new versions are available (compared to the installed version).
# This will also show new versions that do not match the version specifiers!
outdated:
	@bun outdated
	$(call forall , $(NPM_PKGS) , bun outdated)
.PHONY: outdated

# Updates all packages to their latest version that match the version specifier.
# It will also update the version specifiers to point to the new version.
# You can also run this if your installed versions are > than the version specifiers and you want
# to update them.
update:
	bun update
.PHONY: update

# Updates all packages to their latest version (even if they do not match the version specifier!).
# It will also update the version specifiers to point to the new version.
update-latest:
	bun update --latest
	@echo "If the lockfileVersion changed, please update 'packageManager' in package.json!"
.PHONY: update-latest

remove-modules:
	@echo "Removing all node_modules"
	rm -rf node_modules apps/*/node_modules demos/*/node_modules packages/*/node_modules support/*/node_modules

	@echo "Removing all dist/*"
	rm -rf apps/*/dist demos/*/dist packages/*/dist support/*/dist
.PHONY: remove-modules

# ==================================================================================================
##@ Publishing

changeset: ## Add a new changeset
	changeset add;
.PHONY: changeset

version: ## Bump all package dependencies according to staged changesets & generate changelogs
	changeset version
.PHONY: version

publish: build test  ## Build, test, then publish current packages
	$(call forall_make , $(PUBLISHED_PKGS) , publish)
	changeset tag # push with `git push --follow-tags`
.PHONY: publish

publish.dry-run: build  ## Dry-run package publishing
	$(call forall_make , $(PUBLISHED_PKGS) , publish.dry-run)
.PHONY: publish

pack: build ## Packs the tarball, ready to publish manually
	$(call forall_make , $(PUBLISHED_PKGS) , pack)
.PHONY: pack

use-published-packages:
	echo "Installing published packages... Don't commit these changes!"
	cd demos/react && bun install @happy.tech/core@latest @happy.tech/react@latest
	cd apps/iframe && bun install @happy.tech/boop-sdk@latest
	bun install
.PHONY: use-published-packages

# ==================================================================================================
# ENV CONFIG

# NOTE: "127.0.0.1" doesn't always work on MacOS, prefer "localhost".

select-submitter:
	$(call update_env,apps/iframe/.env,VITE_SUBMITTER_URL,$(url))
	$(call update_env,apps/submitter/.env,SUBMITTER_URL,$(url))
	$(call update_env,apps/docs/.env,HAPPY_SUBMITTER_URL,$(url))
.PHONY: select-submitter

select-iframe:
	$(call update_env,packages/core/.env,HAPPY_IFRAME_URL,$(url))
.PHONY: select-iframe

select-chain:
	$(call update_env,apps/submitter/.env,CHAIN_ID,$(chain))
	$(call update_env,apps/randomness/.env,CHAIN_ID,$(chain))
	$(call update_env,apps/iframe/.env,VITE_CHAIN_ID,$(chain))
	$(call update_env,demos/js/.env,VITE_CHAIN_ID,$(chain))
	$(call update_env,demos/react/.env,VITE_CHAIN_ID,$(chain))
	$(call update_env,demos/vue/.env,VITE_CHAIN_ID,$(chain))
.PHONY: select-chain

select-rpc-url:
	$(call update_env,apps/submitter/.env,RPC_URLS,$(url))
	$(call update_env,apps/randomness/.env,RPC_URL,$(url))
	$(call update_env,apps/iframe/.env,HAPPY_RPC_OVERRIDE,$(url))
	$(call update_env,packages/core/.env,HAPPY_RPC_OVERRIDE,$(url))
.PHONY: select-rpc-url

select-rpc-urls:
	$(call update_env,apps/submitter/.env,RPC_URLS,$(urls))
.PHONY: select-rpc-urls

select-staging-contracts:
	$(call update_env,apps/iframe/.env,VITE_USE_STAGING_CONTRACTS,$(use))
	$(call update_env,apps/submitter/.env,USE_STAGING_CONTRACTS,$(use))
.PHONY: select-staging-contracts

# Sets the allowed hosts for Vite.
select-allowed-hosts:
	$(call update_env,apps/iframe/.env,ALLOWED_HOSTS,$(urls))
	$(call update_env,demos/js/.env,ALLOWED_HOSTS,$(urls))
	$(call update_env,demos/react/.env,ALLOWED_HOSTS,$(urls))
	$(call update_env,demos/vue/.env,ALLOWED_HOSTS,$(urls))
.PHONY: select-allowed-hosts

select-auth:
	$(call update_env,apps/iframe/.env,VITE_DEPLOYMENT,$(deployment))
.PHONY: select-auth

select-docs:
	$(call update_env,apps/docs/.env,HAPPY_DOCS_URL,$(url))
	if [ "$(posthog)" = "true" ]; then \
  		$(call update_env,apps/docs/.env,HAPPY_POSTHOG_HOST,https://us.i.posthog.com); \
	else \
		$(call update_env,apps/docs/.env,HAPPY_POSTHOG_HOST,); \
	fi
.PHONY: select-docs

select-submitter-local:
	make select-submitter url=http://localhost:3001
	make select-staging-contracts use=false
.PHONY: select-submitter-local

select-submitter-staging:
	make select-submitter url=https://submitter-staging.happy.tech
	make select-staging-contracts use=true
.PHONY: select-submitter-staging

select-submitter-prod:
	make select-submitter url=https://submitter.happy.tech
	make select-staging-contracts use=false
.PHONY: select-submitter-prod

select-iframe-local:
	make select-iframe url=http://localhost:5160
.PHONY: select-iframe-local

select-iframe-staging:
	make select-iframe url=https://iframe-staging.happy.tech
.PHONY: select-iframe-local

select-iframe-prod:
	make select-iframe url=https://iframe.happy.tech
.PHONY: select-iframe-prod

select-chain-local:
	make select-chain chain=31337
	make select-rpc-url url=http://localhost:8545
	make select-rpc-urls urls=ws://localhost:8545,http://localhost:8545
	make select-staging-contracts use=false
.PHONY: select-chain-local

define select-chain-testnet
	make select-chain chain=216
	make select-rpc-url url=https://rpc.testnet.happy.tech/http
	make select-rpc-urls urls=wss://rpc.testnet.happy.tech/ws,https://rpc.testnet.happy.tech/http
endef

select-chain-staging:
	$(select-chain-testnet)
	make select-staging-contracts use=true
.PHONY: select-chain-staging

select-chain-prod:
	$(select-chain-testnet)
	make select-staging-contracts use=false
.PHONY: select-chain-prod

select-auth-local:
	make select-auth deployment=LOCAL
.PHONY: select-auth-local

select-auth-staging:
	make select-auth deployment=STAGING
.PHONY: select-auth-local

select-auth-prod:
	make select-auth deployment=PROD
.PHONY: select-auth-local

select-docs-local:
	make select-docs url=http://localhost:4000 posthog=false
.PHONY: select-docs-local

select-docs-staging:
	make select-docs url=https://docs-staging.happy.tech posthog=false
.PHONY: select-docs-staging

select-docs-prod:
	make select-docs url=https://docs.happy.tech posthog=true
.PHONY: select-docs-prod

# Use the local setup (chain & all services to run locally).
select-all-local: select-chain-local select-submitter-local select-iframe-local select-auth-local select-docs-local
.PHONY: select-all-local

# Use the staging setup — this is useful as a base for other rules & for scripts.
select-all-staging: select-chain-staging select-submitter-staging select-iframe-staging select-auth-staging select-docs-staging
.PHONY: select-all-staging

# Use the prod setup — this is useful for bundling/publishing packages, and as a base for other rules & for scripts.
select-all-prod: select-chain-prod select-submitter-prod select-iframe-prod select-auth-prod select-docs-prod
.PHONY: select-all-prod

# Use the staging setup, but run the iframe locally.
select-iframe-dev-staging: select-all-staging select-iframe-local
.PHONY: select-iframe-dev-staging

# Use the prod setup, but run the iframe locally.
select-iframe-dev-prod: select-all-prod select-iframe-local
.PHONY: select-iframe-dev-prod

# Use the staging setup, but run the iframe and the submitter locally.
select-submitter-dev-staging: select-iframe-dev-staging select-submitter-staging
.PHONY: select-submitter-dev-staging

# Use the prod setup, but run the iframe and submitter locally.
select-submitter-dev-prod: select-iframe-dev-prod select-submitter-prod
.PHONY: select-submitter-dev-prod

setup-local-chain: select-chain-local
	@cd contracts && make anvil-background
	@until cast chain-id; do sleep 1; done;
	@CONFIG=LOCAL cd contracts && make deploy-boop
	@CONFIG=LOCAL cd contracts && make deploy-mocks
	@CONFIG=LOCAL cd contracts && make deploy-random
.PHONY: setup-local-chain

kill-anvil:
	@cd contracts && make kill-anvil
.PHONY: kill-anvil

# ==================================================================================================
# EXTRAS

# install this to run github workflows locally
# https://nektosact.com/
debug-github-workflow:
	act push
.PHONY: debug-github-workflow

# Enable Git Hooks
enable-hooks:
	husky;
.PHONY: enable-hooks

# Disable Git Hooks
disable-hooks:
	git config --unset core.hooksPath
.PHONY: disable-hooks

# updates all github action version pins: https://github.com/suzuki-shunsuke/pinact
pinact:
	pinact run
.PHONY: pinact