Makefile

SHELL=/usr/bin/env bash

all: build
.PHONY: all

unexport GOFLAGS

GOCC?=go

ARCH?=$(shell arch)
GOVERSION:=$(shell $(GOCC) version | tr ' ' '\n' | grep go1 | sed 's/^go//' | awk -F. '{printf "%d%03d%03d", $$1, $$2, $$3}')
ifeq ($(shell expr $(GOVERSION) \< 1020000), 1)
$(warning Your Golang version is go$(shell expr $(GOVERSION) / 1000000).$(shell expr $(GOVERSION) % 1000000 / 1000).$(shell expr $(GOVERSION) % 1000))
$(error Update Golang to version to at least 1.20.0)
endif

ALLOWED_NODE_VERSIONS := 16 18 20
validate-node-version:
ifeq ($(filter $(shell node -v | cut -c2-3),$(ALLOWED_NODE_VERSIONS)),)
	@echo "Unsupported Node.js version. Please install one of the following versions: $(ALLOWED_NODE_VERSIONS)"
	exit 1
else
	@echo "Node.js version $(shell node -v) is supported."
endif

# git modules that need to be loaded
MODULES:=

CLEAN:=
BINS:=

ldflags=-X=github.com/filecoin-project/boost/build.CurrentCommit=+git.$(subst -,.,$(shell git describe --always --match=NeVeRmAtCh --dirty 2>/dev/null || git rev-parse --short HEAD 2>/dev/null))
ifneq ($(strip $(LDFLAGS)),)
	ldflags+=-extldflags=$(LDFLAGS)
endif

GOFLAGS+=-ldflags="$(ldflags)"


## FFI

FFI_PATH:=extern/filecoin-ffi/
FFI_DEPS:=.install-filcrypto
FFI_DEPS:=$(addprefix $(FFI_PATH),$(FFI_DEPS))

$(FFI_DEPS): build/.filecoin-install ;

build/.filecoin-install: $(FFI_PATH)
	$(MAKE) -C $(FFI_PATH) $(FFI_DEPS:$(FFI_PATH)%=%)
	@touch $@

MODULES+=$(FFI_PATH)
BUILD_DEPS+=build/.filecoin-install
CLEAN+=build/.filecoin-install

ffi-version-check:
	@[[ "$$(awk '/const Version/{print $$5}' extern/filecoin-ffi/version.go)" -eq 3 ]] || (echo "FFI version mismatch, update submodules"; exit 1)
BUILD_DEPS+=ffi-version-check

.PHONY: ffi-version-check

$(MODULES): build/.update-modules ;
# dummy file that marks the last time modules were updated
build/.update-modules:
	git submodule update --init --recursive
	touch $@

# end git modules

## MAIN BINARIES

CLEAN+=build/.update-modules

debug: GOFLAGS+=-tags=debug
debug: build-go

calibnet-go: GOFLAGS+=-tags=calibnet
calibnet-go: build-go

deps: $(BUILD_DEPS)
.PHONY: deps

migrate-lid: $(BUILD_DEPS)
	rm -f migrate-lid
	$(GOCC) build $(GOFLAGS) -o migrate-lid ./cmd/migrate-lid
.PHONY: migrate-lid
BINS+=migrate-lid

boostx: $(BUILD_DEPS)
	rm -f boostx
	$(GOCC) build $(GOFLAGS) -o boostx ./cmd/boostx
.PHONY: boostx
BINS+=boostx

boost: $(BUILD_DEPS)
	rm -f boost
	$(GOCC) build $(GOFLAGS) -o boost ./cmd/boost
.PHONY: boost
BINS+=boost

boostd: $(BUILD_DEPS)
	rm -f boostd
	$(GOCC) build $(GOFLAGS) -o boostd ./cmd/boostd
.PHONY: boostd
BINS+=boostd

boostd-data:
	$(MAKE) -C ./extern/boostd-data
	install -C ./extern/boostd-data/boostd-data ./boostd-data
.PHONY: boostd-data
BINS+=boostd-data

booster-http: $(BUILD_DEPS)
	rm -f booster-http
	$(GOCC) build $(GOFLAGS) -o booster-http ./cmd/booster-http
.PHONY: booster-http
BINS+=booster-http

booster-bitswap: $(BUILD_DEPS)
	rm -f booster-bitswap
	$(GOCC) build $(GOFLAGS) -o booster-bitswap ./cmd/booster-bitswap
.PHONY: booster-bitswap
BINS+=booster-bitswap

devnet: $(BUILD_DEPS)
	rm -f devnet
	$(GOCC) build $(GOFLAGS) -o devnet ./cmd/devnet
.PHONY: devnet
BINS+=devnet

boostci: $(BUILD_DEPS)
	rm -f boostci
	$(GOCC) build $(GOFLAGS) -o boostci ./cmd/boostci
.PHONY: boostci

react: validate-node-version
	npm_config_legacy_peer_deps=yes npm ci --no-audit --prefix react
	npm run --prefix react build
.PHONY: react

update-react: validate-node-version
	npm_config_legacy_peer_deps=yes npm install --no-audit --prefix react
	npm run --prefix react build
.PHONY: react

build-go: boost boostd boostx boostd-data booster-http booster-bitswap devnet migrate-lid
.PHONY: build-go

build: react build-go
.PHONY: build

calibnet: react calibnet-go
.PHONY: calibnet

install: install-boost install-devnet

install-boost:
	install -C ./boost /usr/local/bin/boost
	install -C ./boostd /usr/local/bin/boostd
	install -C ./boostx /usr/local/bin/boostx
	install -C ./boostd-data /usr/local/bin/boostd-data
	install -C ./booster-http /usr/local/bin/booster-http
	install -C ./booster-bitswap /usr/local/bin/booster-bitswap
	install -C ./migrate-lid /usr/local/bin/migrate-lid

install-devnet:
	install -C ./devnet /usr/local/bin/devnet

buildall: $(BINS)

clean:
	rm -rf $(CLEAN) $(BINS)
	-$(MAKE) -C $(FFI_PATH) clean
.PHONY: clean

dist-clean:
	git clean -xdff
	git submodule deinit --all -f
.PHONY: dist-clean

gen: cfgdoc-gen api-gen
.PHONY: gen

api-gen:
	$(GOCC) run ./gen/api
	goimports -w api
	goimports -w api
.PHONY: api-gen

cfgdoc-gen:
	$(GOCC) run ./node/config/cfgdocgen > ./node/config/doc_gen.go

print-%:
	@echo $*=$($*)

cbor-gen:
	pushd ./storagemarket/types && rm -rf types_cbor_gen.go && $(GOCC) generate types.go && popd

docsgen: docsgen-md docsgen-openrpc

docsgen-md-bin: api-gen
	$(GOCC) build $(GOFLAGS) -o docgen-md ./api/docgen/cmd
docsgen-openrpc-bin: api-gen
	$(GOCC) build $(GOFLAGS) -o docgen-openrpc ./api/docgen-openrpc/cmd

docsgen-md: docsgen-md-boost

docsgen-md-boost: docsgen-md-bin
	./docgen-md "api/api.go" "Boost" "api" "./api" > documentation/en/api-v1-methods.md

docsgen-openrpc: docsgen-openrpc-boost

docsgen-openrpc-boost: docsgen-openrpc-bin
	./docgen-openrpc "api/api.go" "Boost" "api" "./api" -gzip > build/openrpc/boost.json.gz

.PHONY: docsgen docsgen-md-bin docsgen-openrpc-bin

## DOCKER IMAGES
docker_user?=filecoin
lotus_version?=v1.27.0
ffi_from_source?=0
build_lotus?=0
build_boost?=1
boost_version?=v2.3.0-rc2
ifeq ($(build_boost),1)
#v1: build boost images currently checked out branch
	boost_build_cmd=docker/boost
	booster_http_build_cmd=docker/booster-http
	booster_bitswap_build_cmd=docker/booster-bitswap
else
# v2: pull images from the github repo
	boost_build_cmd=pull/boost retag/boost
	booster_http_build_cmd=pull/booster-http retag/booster-http
	booster_bitswap_build_cmd=pull/booster-bitswap retag/booster-bitswap
endif
ifeq ($(build_lotus),1)
# v1: building lotus image with provided lotus version
	lotus_info_msg=!!! building lotus base image from github: branch/tag $(lotus_version) !!!
	override lotus_src_dir=/tmp/lotus-$(lotus_version)
	lotus_build_cmd=update/lotus docker/lotus-all-in-one
	lotus_base_image=$(docker_user)/lotus-all-in-one:$(lotus_version)-debug
else
# v2 (default): using prebuilt lotus image
	lotus_base_image?=ghcr.io/filecoin-shipyard/lotus-containers:lotus-$(lotus_version)-devnet
	lotus_info_msg=using lotus image from github: $(lotus_base_image)
	lotus_build_cmd=info/lotus-all-in-one
endif
docker_build_cmd=docker build --build-arg LOTUS_TEST_IMAGE=$(lotus_base_image) \
	--build-arg FFI_BUILD_FROM_SOURCE=$(ffi_from_source) $(docker_args)
### lotus-all-in-one docker image build
info/lotus-all-in-one:
	@echo Docker build info: $(lotus_info_msg)
.PHONY: info/lotus-all-in-one
### checkout/update lotus if needed
$(lotus_src_dir):
	git clone --depth 1 --branch $(lotus_version) https://github.com/filecoin-project/lotus $@
update/lotus: $(lotus_src_dir)
	cd $(lotus_src_dir) && git pull
.PHONY: update/lotus

docker/lotus-all-in-one: info/lotus-all-in-one | $(lotus_src_dir)
	cd $(lotus_src_dir) && $(docker_build_cmd) -f Dockerfile --target lotus-all-in-one \
		-t $(lotus_base_image) --build-arg GOFLAGS=-tags=debug .
.PHONY: docker/lotus-all-in-one

pull/boost:
	docker pull ghcr.io/filecoin-project/boost:boost-dev-$(boost_version)
.PHONY: pull/boost

pull/booster-http:
	docker pull ghcr.io/filecoin-project/boost:boost-http-dev-$(boost_version)
.PHONY: pull/boost

pull/booster-bitswap:
	docker pull ghcr.io/filecoin-project/boost:boost-bitswap-dev-$(boost_version)
.PHONY: pull/boost

retag/boost:
	docker tag ghcr.io/filecoin-project/boost:boost-dev-$(boost_version) $(docker_user)/boost-dev:dev
.PHONY: retag/boost

retag/booster-http:
	docker tag ghcr.io/filecoin-project/boost:boost-http-dev-$(boost_version) $(docker_user)/booster-http-dev:dev
.PHONY: retag/booster-http

retag/booster-bitswap:
	docker tag ghcr.io/filecoin-project/boost:boost-bitswap-dev-$(boost_version) $(docker_user)/booster-bitswap-dev:dev
.PHONY: retag/booster-bitswap

# boost-client main
docker/mainnet/boost-client: build/.update-modules
	DOCKER_BUILDKIT=1 $(docker_build_cmd) \
		-t $(docker_user)/boost-main:main --build-arg BUILD_VERSION=dev \
		-f docker/boost-client/Dockerfile.source --target boost-main .
.PHONY: docker/mainnet/boost-client

### devnet images
docker/%:
	cd docker/devnet/$* && DOCKER_BUILDKIT=1 $(docker_build_cmd) -t $(docker_user)/$*-dev:dev \
		--build-arg BUILD_VERSION=dev .
docker/boost: build/.update-modules
	DOCKER_BUILDKIT=1 $(docker_build_cmd) \
		-t $(docker_user)/boost-dev:dev --build-arg BUILD_VERSION=dev \
		-f docker/devnet/Dockerfile.source --target boost-dev .
.PHONY: docker/boost
docker/booster-http:
	DOCKER_BUILDKIT=1 $(docker_build_cmd) \
		-t $(docker_user)/booster-http-dev:dev --build-arg BUILD_VERSION=dev \
		-f docker/devnet/Dockerfile.source --target booster-http-dev .
.PHONY: docker/booster-http
docker/booster-bitswap:
	DOCKER_BUILDKIT=1 $(docker_build_cmd) \
		-t $(docker_user)/booster-bitswap-dev:dev --build-arg BUILD_VERSION=dev \
		-f docker/devnet/Dockerfile.source --target booster-bitswap-dev .
docker/yugabytedb:
	DOCKER_BUILDKIT=1 $(docker_build_cmd) \
		-t $(docker_user)/yugabytedb:dev \
		-f docker/Dockerfile.yugabyte .
.PHONY: docker/booster-http
.PHONY: docker/booster-bitswap
docker/all: $(lotus_build_cmd) $(boost_build_cmd) $(booster_http_build_cmd) $(booster_bitswap_build_cmd) \
	docker/lotus docker/lotus-miner docker/yugabytedb
.PHONY: docker/all

### To allow devs to pull individual images. Require build_boost=0 and boost_version to be supplied
docker/get-boost: $(boost_build_cmd)
.PHONY: docker/get-boost

docker/get-booster-http: $(booster_http_build_cmd)
.PHONY: docker/get-booster-http

docker/get-booster-bitswap: $(booster_bitswap_build_cmd)
.PHONY: docker/get-booster-http

test-lid:
	cd ./extern/boostd-data && ARCH=$(ARCH) docker-compose up --build --exit-code-from go-tests

devnet/up:
	rm -rf ./docker/devnet/data && docker compose -f ./docker/devnet/docker-compose.yaml up -d

devnet/%:
	docker compose -f ./docker/devnet/docker-compose.yaml up --build $* -d

devnet/down:
	docker compose -f ./docker/devnet/docker-compose.yaml down --rmi=local && sleep 2 && rm -rf ./docker/devnet/data

process?=/bin/bash
devnet/exec:
	docker compose -f ./docker/devnet/docker-compose.yaml exec $(service) $(process)