Makefile

.PHONY: all build test lint license check-fmt check-clippy actor-bundle

BUILTIN_ACTORS_TAG    ?= v11.0.0
BUILTIN_ACTORS_BUNDLE := $(PWD)/builtin-actors/output/bundle.car

# Make sure this tag matches the one in Cargo.toml for the ABI binding
IPC_ACTORS_TAG				?= origin/pre-audit
IPC_ACTORS_DIR        := $(PWD)/../ipc-solidity-actors
IPC_ACTORS_CODE       := $(shell find $(IPC_ACTORS_DIR) -type f -name "*.sol")
IPC_ACTORS_ABI        := .make/.ipc-actors-abi

# We checked out an earlier commit where .out did not exist yet.
IPC_ACTORS_OUT        := $(IPC_ACTORS_DIR)/out

FENDERMINT_CODE       := $(shell find . -type f \( -name "*.rs" -o -name "Cargo.toml" \) | grep -v target)

# Override PROFILE env var to choose between `local | ci`
PROFILE ?= local

# Set to `--push` to push the multiarch image during the build.
# Leave on `--load` for local build, but it only works for a single platform.
BUILDX_STORE ?= --load
# Set according to what kind of `--platform` and `--cache` to use.
# Leave empty for local builds, then the platform matches the local one.
BUILDX_FLAGS ?=
# Set to the `<repo>/<image>:<tag>` label the image.
BUILDX_TAG   ?= fendermint:latest

all: test build diagrams

diagrams:
	make -C docs/diagrams diagrams

build: | protoc
	cargo build --release

install:
	cargo install --locked --path fendermint/app

# Using --release for testing because wasm can otherwise be slow.
test: $(IPC_ACTORS_ABI) $(BUILTIN_ACTORS_BUNDLE)
	FM_BUILTIN_ACTORS_BUNDLE=$(BUILTIN_ACTORS_BUNDLE) \
	FM_CONTRACTS_DIR=$(IPC_ACTORS_OUT) \
	cargo test --release --workspace --exclude smoke-test

e2e: docker-build
	cd fendermint/testing/smoke-test && cargo make --profile $(PROFILE)
	cd fendermint/testing/snapshot-test && cargo make --profile $(PROFILE)

clean:
	cargo clean
	rm $(BUILTIN_ACTORS_BUNDLE)
	rm -rf .make

lint: \
	license \
	check-fmt \
	check-clippy

license:
	./scripts/add_license.sh

check-fmt:
	@# `nightly` is required to support ignore list in rustfmt.toml
	cargo +nightly fmt --all --check

check-clippy:
	cargo clippy --all --tests -- -D clippy::all

docker-deps: $(BUILTIN_ACTORS_BUNDLE) $(FENDERMINT_CODE) $(IPC_ACTORS_ABI)
	rm -rf docker/.artifacts
	mkdir -p docker/.artifacts/contracts
	cp -r $(IPC_ACTORS_OUT)/* docker/.artifacts/contracts
	cp $(BUILTIN_ACTORS_BUNDLE) docker/.artifacts

# To use `buildx` locally to produce multiplatform images, one needs to run `docker buildx create --use`.
# After that it looks like even the regular docker build needs the `--load` parameter, which hopefully
# it can handle for anyone with `DOCKER_BUILDKIT=1`.
docker-build: docker-deps
	if [ "$(PROFILE)" = "ci" ]; then \
		cat docker/builder.ci.Dockerfile docker/runner.Dockerfile > docker/Dockerfile ; \
		docker buildx build \
			$(BUILDX_STORE) \
			$(BUILDX_FLAGS) \
			-f docker/Dockerfile \
			-t $(BUILDX_TAG) $(PWD); \
	else \
		cat docker/builder.local.Dockerfile docker/runner.Dockerfile > docker/Dockerfile ; \
		DOCKER_BUILDKIT=1 \
		docker build \
			$(BUILDX_STORE) \
			-f docker/Dockerfile \
			-t fendermint:latest $(PWD); \
	fi


# Build a bundle CAR; this is so we don't have to have a project reference,
# which means we are not tied to the release cycle of both FVM _and_ actors;
# so long as they work together.
actor-bundle: $(BUILTIN_ACTORS_BUNDLE)

# Download a released builtin-actors bundle CAR file.
$(BUILTIN_ACTORS_BUNDLE):
	mkdir -p $(dir $@)
	curl -L -o $@ https://github.com/filecoin-project/builtin-actors/releases/download/$(BUILTIN_ACTORS_TAG)/builtin-actors-mainnet.car

# Compile the ABI artifacts of the IPC Solidity actors.
ipc-actors-abi: $(IPC_ACTORS_ABI)

# Check out the IPC Solidity actors if necessary so we get the ABI artifacts, putting down a marker at the end.
$(IPC_ACTORS_ABI): $(IPC_ACTORS_CODE)
	if [ ! -d $(IPC_ACTORS_DIR) ]; then \
		mkdir -p $(IPC_ACTORS_DIR) && \
		cd $(IPC_ACTORS_DIR) && \
		git clone https://github.com/consensus-shipyard/ipc-solidity-actors.git .; \
	fi
	cd $(IPC_ACTORS_DIR) && \
	git fetch origin && \
	git checkout $(IPC_ACTORS_TAG)
	@# The ABI are already checked in; otherwise we'd have to compile with foundry
	@# make -C $(IPC_ACTORS_DIR) compile-abi
	mkdir -p $(dir $@) && touch $@

.PHONY: protoc
protoc:
	@if [ -z "$(shell which protoc)" ]; then \
		echo "Please install the Protobuf Compiler. See https://grpc.io/docs/protoc-installation/"; \
		exit 1; \
	fi