Makefile

GOTOOLS = \
	github.com/mitchellh/gox \
	github.com/golangci/golangci-lint/cmd/golangci-lint \
	github.com/gogo/protobuf/protoc-gen-gogo \
	github.com/square/certstrap
GOBIN?=${GOPATH}/bin

export GO111MODULE = on

PACKAGES=$(shell go list ./...)
COMMIT_HASH := $(shell git rev-parse --short HEAD)

COSMOS_RELEASE := $(shell grep 'github.com/bnb-chain/bnc-cosmos-sdk' go.mod |awk '{print $$4}')
TENDER_RELEASE := $(shell grep 'github.com/bnb-chain/bnc-tendermint' go.mod| grep -v iavl| awk '{print $$4}')

BUILD_TAGS = netgo

BUILD_CLI_TAGS = netgo
BUILD_FLAGS = -mod=readonly -tags "${BUILD_TAGS}" -ldflags "-w -s -X github.com/bnb-chain/node/version.GitCommit=${COMMIT_HASH} -X github.com/bnb-chain/node/version.CosmosRelease=${COSMOS_RELEASE} -X github.com/bnb-chain/node/version.TendermintRelease=${TENDER_RELEASE}" -trimpath
BUILD_CLI_FLAGS = -tags "${BUILD_CLI_TAGS}" -ldflags "-X github.com/bnb-chain/node/version.GitCommit=${COMMIT_HASH} -X github.com/bnb-chain/node/version.CosmosRelease=${COSMOS_RELEASE} -X github.com/bnb-chain/node/version.TendermintRelease=${TENDER_RELEASE}"
# Without -lstdc++ on CentOS we will encounter link error, solution comes from: https://stackoverflow.com/a/29285011/1147187
BUILD_CGOFLAGS = CGO_ENABLED=1 CGO_LDFLAGS="-lleveldb -lsnappy -lstdc++"
BUILD_CFLAGS = ${BUILD_FLAGS} -tags "cleveldb"
BUILD_TESTNET_FLAGS = ${BUILD_CLI_FLAGS} -ldflags "-X github.com/bnb-chain/node/app.Bech32PrefixAccAddr=tbnb"

UNAME_S := $(shell uname -s)
ifeq ($(UNAME_S),Linux)
    # On CentOS, this requires on control machine:
    # yum group install "Development Tools"
    # yum install glibc-static
    # build cmake, leveldb, snappy and copy libleveldb.a and libsnappy.a into /usr/lib
	BUILD_CFLAGS += -ldflags '-extldflags "-static"'
endif

all: format build

LEDGER_ENABLED ?= true

########################################
### Build/Install

ifeq ($(LEDGER_ENABLED),true)
  ifeq ($(OS),Windows_NT)
    GCCEXE = $(shell where gcc.exe 2> NUL)
    ifeq ($(GCCEXE),)
      $(error gcc.exe not installed for ledger support, please install or set LEDGER_ENABLED=false)
    else
      BUILD_CLI_TAGS += ledger
    endif
  else
    UNAME_S = $(shell uname -s)
    ifeq ($(UNAME_S),OpenBSD)
      $(warning OpenBSD detected, disabling ledger support (https://github.com/cosmos/cosmos-sdk/issues/1988))
    else
      GCC = $(shell command -v gcc 2> /dev/null)
      ifeq ($(GCC),)
        $(error gcc not installed for ledger support, please install or set LEDGER_ENABLED=false)
      else
        BUILD_CLI_TAGS += ledger
      endif
    endif
  endif
endif

########################################
### CI

ci: build

########################################
### Build

define buildwindows
     go build $(BUILD_CLI_FLAGS) -o build/bnbcli.exe ./cmd/bnbcli
     go build $(BUILD_TESTNET_FLAGS) -o build/tbnbcli.exe ./cmd/bnbcli
     go build $(BUILD_FLAGS) -o build/bnbchaind.exe ./cmd/bnbchaind
     go build $(BUILD_FLAGS) -o build/bnbsentry.exe ./cmd/bnbsentry
     go build $(BUILD_FLAGS) -o build/pressuremaker.exe ./cmd/pressuremaker
     go build $(BUILD_FLAGS) -o build/lightd.exe ./cmd/lightd
endef


build:
ifeq ($(OS),Windows_NT)
	$(call buildwindows)
else
	go build $(BUILD_CLI_FLAGS) -o build/bnbcli ./cmd/bnbcli
	go build $(BUILD_TESTNET_FLAGS) -o build/tbnbcli ./cmd/bnbcli
	go build $(BUILD_FLAGS) -o build/bnbchaind ./cmd/bnbchaind
	go build $(BUILD_FLAGS) -o build/bnbsentry ./cmd/bnbsentry
	go build $(BUILD_FLAGS) -o build/pressuremaker ./cmd/pressuremaker
	go build $(BUILD_FLAGS) -o build/lightd ./cmd/lightd
	go build $(BUILD_FLAGS) -o build/state_recover ./networks/tools/state_recover
endif


build_c:
ifeq ($(OS),Windows_NT)
	go build $(BUILD_CLI_FLAGS) -o build/bnbcli.exe ./cmd/bnbcli
	go build $(BUILD_TESTNET_FLAGS) -o build/tbnbcli.exe ./cmd/bnbcli
	$(BUILD_CGOFLAGS) go build $(BUILD_CFLAGS) -o build/bnbchaind.exe ./cmd/bnbchaind
	$(BUILD_CGOFLAGS) go build $(BUILD_CFLAGS) -o build/bnbsentry.exe ./cmd/bnbsentry
	go build $(BUILD_FLAGS) -o build/pressuremaker.exe ./cmd/pressuremaker
	$(BUILD_CGOFLAGS) go build $(BUILD_CFLAGS) -o build/lightd.exe ./cmd/lightd
	go build $(BUILD_FLAGS) -o build/state_recover.exe ./networks/tools/state_recover
else
	go build $(BUILD_CLI_FLAGS) -o build/bnbcli ./cmd/bnbcli
	go build $(BUILD_TESTNET_FLAGS) -o build/tbnbcli ./cmd/bnbcli
	$(BUILD_CGOFLAGS) go build $(BUILD_CFLAGS) -o build/bnbchaind ./cmd/bnbchaind
	$(BUILD_CGOFLAGS) go build $(BUILD_CFLAGS) -o build/bnbsentry ./cmd/bnbsentry
	go build $(BUILD_FLAGS) -o build/pressuremaker ./cmd/pressuremaker
	$(BUILD_CGOFLAGS) go build $(BUILD_CFLAGS) -o build/lightd ./cmd/lightd
	go build $(BUILD_FLAGS) -o build/state_recover ./networks/tools/state_recover
endif

build-windows:
	$(call buildwindows)

build-linux:
	LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 $(MAKE) build

build-linux_c:
	LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 $(MAKE) build_c

build-alpine:
	LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 CGO_ENABLED=0 $(MAKE) build

build-alpine_c:
    LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 CGO_ENABLED=0 $(MAKE) build_c

install:
	go install $(BUILD_FLAGS) ./cmd/bnbchaind
	go install $(BUILD_CLI_FLAGS) ./cmd/bnbcli
	go install $(BUILD_FLAGS) ./cmd/bnbsentry

install_c:
	$(BUILD_CGOFLAGS) go install $(BUILD_CFLAGS) ./cmd/bnbchaind
	go install $(BUILD_CLI_FLAGS) ./cmd/bnbcli
	go install $(BUILD_FLAGS) ./cmd/bnbsentry

########################################
### Format
format:
	@echo "-->Formatting"
	$(shell go fmt ./...)
	bash scripts/importssort.sh

########################################
### Lint
install_lint:
	which golangci-lint || go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.45.2
	golangci-lint --version

lint: install_lint
	@echo "-->Lint"
	golangci-lint run

########################################
### Testing

get_tools:
	@echo "--> Installing tools"
	./scripts/get_tools.sh

test: get_tools
	make set_with_deadlock
	make test_unit
	make test_race
	make cleanup_after_test_with_deadlock

# uses https://github.com/sasha-s/go-deadlock/ to detect potential deadlocks
set_with_deadlock:
	cp go.mod go.mod_bak
	cp go.sum go.sum_bak
	find . -name "*.go" | grep -v "vendor/" | xargs -n 1 sed -i.mutex_bak 's/sync.RWMutex/deadlock.RWMutex/'
	find . -name "*.go" | grep -v "vendor/" | xargs -n 1 sed -i.mutex_bak 's/sync.Mutex/deadlock.Mutex/'
	find . -name "*.go" | grep -v "vendor/" | grep -v ".git/"  | xargs -n 1 goimports -w

# cleanes up after you ran test_with_deadlock
cleanup_after_test_with_deadlock:
	find . -name "*.go" | grep -v "vendor/" | xargs -n 1 sed -i.mutex_bak 's/deadlock.RWMutex/sync.RWMutex/'
	find . -name "*.go" | grep -v "vendor/" | xargs -n 1 sed -i.mutex_bak 's/deadlock.Mutex/sync.Mutex/'
	find . -name "*.go" | grep -v "vendor/" | grep -v ".git/" | xargs -n 1 goimports -w
	find . -name "*.go.mutex_bak" | grep -v "vendor/" | xargs rm
	mv go.mod_bak go.mod
	mv go.sum_bak go.sum


test_race:
	@echo "--> Running go test --race"
	@go test -race $(PACKAGES)

test_unit:
	@echo "--> Running go test"
	@go test $(PACKAGES)

test_coverage:
	@echo "--> Running go test"
	@go test $(PACKAGES) -race -coverprofile=coverage.txt -covermode=atomic

integration_test: build
	@echo "-->Integration Test"
	@./integration_test.sh

bep159_integration_test: build
	@echo "-->BEP159 Integration Test"
	@bash ./scripts/bep159_integration_test.sh

recon_integration_test: build
	@echo "-->Recon Integration Test"
	@bash ./scripts/recon_integration_test.sh

########################################
### Pre Commit
pre_commit: build test_unit recon_integration_test bep159_integration_test integration_test format lint multi-nodes-test

########################################
### Local validator nodes using docker and docker-compose
build-docker-node:
	$(MAKE) -C networks/local

# Run a 4-node testnet locally
localnet-start: localnet-stop
	@if ! [ -f build/node0/gaiad/config/genesis.json ]; then docker run --rm -v $(CURDIR)/build:/bnbchaind:Z binance/bnbdnode testnet --v 4 -o . --starting-ip-address 172.20.0.2 ; fi
	@for i in `seq 0 3`; do \
		if [ "$(SKIP_TIMEOUT)" = "true" ]; then \
			sed -i -e "s/skip_timeout_commit = false/skip_timeout_commit = true/g" ./build/node$$i/gaiad/config/config.toml;\
		else \
			sed -i -e "s/skip_timeout_commit = true/skip_timeout_commit = false/g" ./build/node$$i/gaiad/config/config.toml;\
		fi;\
	done
	@for i in `seq 0 3`; do \
		if [ "$(PEX)" = "false" ]; then \
			sed -i -e "s/pex = true/pex = false/g" ./build/node$$i/gaiad/config/config.toml;\
		else \
			sed -i -e "s/pex = false/pex = true/g" ./build/node$$i/gaiad/config/config.toml;\
		fi;\
	done
	docker-compose up

# Stop testnet
localnet-stop:
	docker-compose down

# docker commands
docker.build:
	docker build -t binance/bnbdnode .

docker.generate:
	go run ./cmd/gen_devnet

docker.start:
	docker compose -f build/devnet/docker-compose.yml up -d

docker.stop:
	docker compose -f build/devnet/docker-compose.yml down

docker.clean:
	rm -rf build/devnet

multi-nodes-test:
	cd ./e2e && STAKE_ENV=multi go run .

# To avoid unintended conflicts with file names, always add to .PHONY
# unless there is a reason not to.
# https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html
.PHONY: build install test test_unit build-linux build-docker-node localnet-start localnet-stop
.PHONY: lint install_lint