#!/usr/bin/make -f PACKAGES_NOSIMULATION=$(shell go list ./... | grep -v '/simulation') PACKAGES_SIMTEST=$(shell go list ./... | grep '/simulation') VERSION := $(shell echo $(shell git describe --always) | sed 's/^v//') TMVERSION := $(shell go list -m github.com/tendermint/tendermint | sed 's:.* ::') COMMIT := $(shell git log -1 --format='%H') LEDGER_ENABLED ?= true BINDIR ?= $(GOPATH)/bin ETHERMINT_BINARY = ethermintd ETHERMINT_DIR = ethermint BUILDDIR ?= $(CURDIR)/build SIMAPP = ./app HTTPS_GIT := https://github.com/tharsis/ethermint.git DOCKER := $(shell which docker) DOCKER_BUF := $(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace bufbuild/buf export GO111MODULE = on # Default target executed when no arguments are given to make. default_target: all .PHONY: default_target # process build tags build_tags = netgo 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_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_tags += ledger endif endif endif endif ifeq (cleveldb,$(findstring cleveldb,$(COSMOS_BUILD_OPTIONS))) build_tags += gcc endif build_tags += $(BUILD_TAGS) build_tags := $(strip $(build_tags)) whitespace := whitespace += $(whitespace) comma := , build_tags_comma_sep := $(subst $(whitespace),$(comma),$(build_tags)) # process linker flags ldflags = -X github.com/cosmos/cosmos-sdk/version.Name=ethermint \ -X github.com/cosmos/cosmos-sdk/version.AppName=$(ETHERMINT_BINARY) \ -X github.com/cosmos/cosmos-sdk/version.Version=$(VERSION) \ -X github.com/cosmos/cosmos-sdk/version.Commit=$(COMMIT) \ -X "github.com/cosmos/cosmos-sdk/version.BuildTags=$(build_tags_comma_sep)" \ -X github.com/tendermint/tendermint/version.TMCoreSemVer=$(TMVERSION) # DB backend selection ifeq (cleveldb,$(findstring cleveldb,$(COSMOS_BUILD_OPTIONS))) ldflags += -X github.com/cosmos/cosmos-sdk/types.DBBackend=cleveldb endif ifeq (badgerdb,$(findstring badgerdb,$(COSMOS_BUILD_OPTIONS))) ldflags += -X github.com/cosmos/cosmos-sdk/types.DBBackend=badgerdb endif # handle rocksdb ifeq (rocksdb,$(findstring rocksdb,$(COSMOS_BUILD_OPTIONS))) CGO_ENABLED=1 BUILD_TAGS += rocksdb ldflags += -X github.com/cosmos/cosmos-sdk/types.DBBackend=rocksdb endif # handle boltdb ifeq (boltdb,$(findstring boltdb,$(COSMOS_BUILD_OPTIONS))) BUILD_TAGS += boltdb ldflags += -X github.com/cosmos/cosmos-sdk/types.DBBackend=boltdb endif ifeq (,$(findstring nostrip,$(COSMOS_BUILD_OPTIONS))) ldflags += -w -s endif ldflags += $(LDFLAGS) ldflags := $(strip $(ldflags)) BUILD_FLAGS := -tags "$(build_tags)" -ldflags '$(ldflags)' # check for nostrip option ifeq (,$(findstring nostrip,$(COSMOS_BUILD_OPTIONS))) BUILD_FLAGS += -trimpath endif # # The below include contains the tools and runsim targets. # include contrib/devtools/Makefile ############################################################################### ### Build ### ############################################################################### BUILD_TARGETS := build install build: BUILD_ARGS=-o $(BUILDDIR)/ build-linux: GOOS=linux GOARCH=amd64 LEDGER_ENABLED=false $(MAKE) build $(BUILD_TARGETS): go.sum $(BUILDDIR)/ go $@ $(BUILD_FLAGS) $(BUILD_ARGS) ./... $(BUILDDIR)/: mkdir -p $(BUILDDIR)/ docker-build: # TODO replace with kaniko docker build -t ${DOCKER_IMAGE}:${DOCKER_TAG} . docker tag ${DOCKER_IMAGE}:${DOCKER_TAG} ${DOCKER_IMAGE}:latest # docker tag ${DOCKER_IMAGE}:${DOCKER_TAG} ${DOCKER_IMAGE}:${COMMIT_HASH} # update old container docker rm ethermint || true # create a new container from the latest image docker create --name ethermint -t -i tharsis/ethermint:latest ethermint # move the binaries to the ./build directory mkdir -p ./build/ docker cp ethermint:/usr/bin/ethermintd ./build/ $(MOCKS_DIR): mkdir -p $(MOCKS_DIR) distclean: clean tools-clean clean: rm -rf \ $(BUILDDIR)/ \ artifacts/ \ tmp-swagger-gen/ all: build build-all: tools build lint test .PHONY: distclean clean build-all ############################################################################### ### Tools & Dependencies ### ############################################################################### TOOLS_DESTDIR ?= $(GOPATH)/bin STATIK = $(TOOLS_DESTDIR)/statik RUNSIM = $(TOOLS_DESTDIR)/runsim # Install the runsim binary with a temporary workaround of entering an outside # directory as the "go get" command ignores the -mod option and will polute the # go.{mod, sum} files. # # ref: https://github.com/golang/go/issues/30515 runsim: $(RUNSIM) $(RUNSIM): @echo "Installing runsim..." @(cd /tmp && ${GO_MOD} go get github.com/cosmos/tools/cmd/runsim@master) statik: $(STATIK) $(STATIK): @echo "Installing statik..." @(cd /tmp && go get github.com/rakyll/statik@v0.1.6) contract-tools: ifeq (, $(shell which stringer)) @echo "Installing stringer..." @go get golang.org/x/tools/cmd/stringer else @echo "stringer already installed; skipping..." endif ifeq (, $(shell which go-bindata)) @echo "Installing go-bindata..." @go get github.com/kevinburke/go-bindata/go-bindata else @echo "go-bindata already installed; skipping..." endif ifeq (, $(shell which gencodec)) @echo "Installing gencodec..." @go get github.com/fjl/gencodec else @echo "gencodec already installed; skipping..." endif ifeq (, $(shell which protoc-gen-go)) @echo "Installing protoc-gen-go..." @go get github.com/fjl/gencodec github.com/golang/protobuf/protoc-gen-go else @echo "protoc-gen-go already installed; skipping..." endif ifeq (, $(shell which protoc)) @echo "Please istalling protobuf according to your OS" @echo "macOS: brew install protobuf" @echo "linux: apt-get install -f -y protobuf-compiler" else @echo "protoc already installed; skipping..." endif ifeq (, $(shell which solcjs)) @echo "Installing solcjs..." @npm install -g solc@0.5.11 else @echo "solcjs already installed; skipping..." endif docs-tools: ifeq (, $(shell which yarn)) @echo "Installing yarn..." @npm install -g yarn else @echo "yarn already installed; skipping..." endif tools: tools-stamp tools-stamp: contract-tools docs-tools proto-tools statik runsim # Create dummy file to satisfy dependency and avoid # rebuilding when this Makefile target is hit twice # in a row. touch $@ tools-clean: rm -f $(RUNSIM) rm -f tools-stamp docs-tools-stamp: docs-tools # Create dummy file to satisfy dependency and avoid # rebuilding when this Makefile target is hit twice # in a row. touch $@ .PHONY: runsim statik tools contract-tools docs-tools proto-tools tools-stamp tools-clean docs-tools-stamp go.sum: go.mod echo "Ensure dependencies have not been modified ..." >&2 go mod verify go mod tidy ############################################################################### ### Documentation ### ############################################################################### update-swagger-docs: statik $(BINDIR)/statik -src=client/docs/swagger-ui -dest=client/docs -f -m @if [ -n "$(git status --porcelain)" ]; then \ echo "\033[91mSwagger docs are out of sync!!!\033[0m";\ exit 1;\ else \ echo "\033[92mSwagger docs are in sync\033[0m";\ fi .PHONY: update-swagger-docs godocs: @echo "--> Wait a few seconds and visit http://localhost:6060/pkg/github.com/tharsis/ethermint/types" godoc -http=:6060 # Start docs site at localhost:8080 docs-serve: @cd docs && \ yarn && \ yarn run serve # Build the site into docs/.vuepress/dist build-docs: @$(MAKE) docs-tools-stamp && \ cd docs && \ yarn && \ yarn run build # This builds a docs site for each branch/tag in `./docs/versions` # and copies each site to a version prefixed path. The last entry inside # the `versions` file will be the default root index.html. build-docs-versioned: @$(MAKE) docs-tools-stamp && \ cd docs && \ while read -r branch path_prefix; do \ (git checkout $${branch} && npm install && VUEPRESS_BASE="/$${path_prefix}/" npm run build) ; \ mkdir -p ~/output/$${path_prefix} ; \ cp -r .vuepress/dist/* ~/output/$${path_prefix}/ ; \ cp ~/output/$${path_prefix}/index.html ~/output ; \ done < versions ; .PHONY: docs-serve build-docs build-docs-versioned ############################################################################### ### Tests & Simulation ### ############################################################################### test: test-unit test-all: test-unit test-race PACKAGES_UNIT=$(shell go list ./...) TEST_PACKAGES=./... TEST_TARGETS := test-unit test-unit-cover test-race # Test runs-specific rules. To add a new test target, just add # a new rule, customise ARGS or TEST_PACKAGES ad libitum, and # append the new rule to the TEST_TARGETS list. test-unit: ARGS=-timeout=10m -race test-unit: TEST_PACKAGES=$(PACKAGES_UNIT) test-race: ARGS=-race test-race: TEST_PACKAGES=$(PACKAGES_NOSIMULATION) $(TEST_TARGETS): run-tests test-unit-cover: ARGS=-timeout=10m -race -coverprofile=coverage.txt -covermode=atomic test-unit-cover: TEST_PACKAGES=$(PACKAGES_UNIT) run-tests: ifneq (,$(shell which tparse 2>/dev/null)) go test -mod=readonly -json $(ARGS) $(EXTRA_ARGS) $(TEST_PACKAGES) | tparse else go test -mod=readonly $(ARGS) $(EXTRA_ARGS) $(TEST_PACKAGES) endif test-import: @go test ./tests/importer -v --vet=off --run=TestImportBlocks --datadir tmp \ --blockchain blockchain rm -rf tests/importer/tmp test-rpc: ./scripts/integration-test-all.sh -t "rpc" -q 1 -z 1 -s 2 -m "rpc" -r "true" test-rpc-pending: ./scripts/integration-test-all.sh -t "pending" -q 1 -z 1 -s 2 -m "pending" -r "true" test-contract: @type "npm" 2> /dev/null || (echo 'Npm does not exist. Please install node.js and npm."' && exit 1) @type "solcjs" 2> /dev/null || (echo 'Solcjs does not exist. Please install solcjs using make contract-tools."' && exit 1) @type "protoc" 2> /dev/null || (echo 'Failed to install protoc. Please reinstall protoc using make contract-tools.' && exit 1) bash scripts/contract-test.sh test-solidity: @echo "Beginning solidity tests..." ./scripts/run-solidity-tests.sh .PHONY: run-tests test test-all test-import test-rpc test-contract test-solidity $(TEST_TARGETS) test-sim-nondeterminism: @echo "Running non-determinism test..." @go test -mod=readonly $(SIMAPP) -run TestAppStateDeterminism -Enabled=true \ -NumBlocks=100 -BlockSize=200 -Commit=true -Period=0 -v -timeout 24h test-sim-custom-genesis-fast: @echo "Running custom genesis simulation..." @echo "By default, ${HOME}/.$(ETHERMINT_DIR)/config/genesis.json will be used." @go test -mod=readonly $(SIMAPP) -run TestFullAppSimulation -Genesis=${HOME}/.$(ETHERMINT_DIR)/config/genesis.json \ -Enabled=true -NumBlocks=100 -BlockSize=200 -Commit=true -Seed=99 -Period=5 -v -timeout 24h test-sim-import-export: runsim @echo "Running application import/export simulation. This may take several minutes..." @$(BINDIR)/runsim -Jobs=4 -SimAppPkg=$(SIMAPP) -ExitOnFail 50 5 TestAppImportExport test-sim-after-import: runsim @echo "Running application simulation-after-import. This may take several minutes..." @$(BINDIR)/runsim -Jobs=4 -SimAppPkg=$(SIMAPP) -ExitOnFail 50 5 TestAppSimulationAfterImport test-sim-custom-genesis-multi-seed: runsim @echo "Running multi-seed custom genesis simulation..." @echo "By default, ${HOME}/.$(ETHERMINT_DIR)/config/genesis.json will be used." @$(BINDIR)/runsim -Genesis=${HOME}/.$(ETHERMINT_DIR)/config/genesis.json -SimAppPkg=$(SIMAPP) -ExitOnFail 400 5 TestFullAppSimulation test-sim-multi-seed-long: runsim @echo "Running long multi-seed application simulation. This may take awhile!" @$(BINDIR)/runsim -Jobs=4 -SimAppPkg=$(SIMAPP) -ExitOnFail 500 50 TestFullAppSimulation test-sim-multi-seed-short: runsim @echo "Running short multi-seed application simulation. This may take awhile!" @$(BINDIR)/runsim -Jobs=4 -SimAppPkg=$(SIMAPP) -ExitOnFail 50 10 TestFullAppSimulation test-sim-benchmark-invariants: @echo "Running simulation invariant benchmarks..." @go test -mod=readonly $(SIMAPP) -benchmem -bench=BenchmarkInvariants -run=^$ \ -Enabled=true -NumBlocks=1000 -BlockSize=200 \ -Period=1 -Commit=true -Seed=57 -v -timeout 24h .PHONY: \ test-sim-nondeterminism \ test-sim-custom-genesis-fast \ test-sim-import-export \ test-sim-after-import \ test-sim-custom-genesis-multi-seed \ test-sim-multi-seed-short \ test-sim-multi-seed-long \ test-sim-benchmark-invariants benchmark: @go test -mod=readonly -bench=. $(PACKAGES_NOSIMULATION) .PHONY: benchmark ############################################################################### ### Linting ### ############################################################################### lint: golangci-lint run --out-format=tab lint-fix: golangci-lint run --fix --out-format=tab --issues-exit-code=0 .PHONY: lint lint-fix format: find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/docs/statik/statik.go" -not -name '*.pb.go' | xargs gofmt -w -s find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/docs/statik/statik.go" -not -name '*.pb.go' | xargs misspell -w find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/docs/statik/statik.go" -not -name '*.pb.go' | xargs goimports -w -local github.com/tharsis/ethermint .PHONY: format ############################################################################### ### Protobuf ### ############################################################################### containerProtoVer=v0.2 containerProtoImage=tendermintdev/sdk-proto-gen:$(containerProtoVer) containerProtoGen=cosmos-sdk-proto-gen-$(containerProtoVer) containerProtoGenSwagger=cosmos-sdk-proto-gen-swagger-$(containerProtoVer) containerProtoFmt=cosmos-sdk-proto-fmt-$(containerProtoVer) proto-all: proto-format proto-lint proto-gen proto-gen: @echo "Generating Protobuf files" $(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace tendermintdev/sdk-proto-gen sh ./scripts/protocgen.sh proto-swagger-gen: @echo "Generating Protobuf Swagger" @./scripts/protoc-swagger-gen.sh proto-format: @echo "Formatting Protobuf files" find ./ -not -path "./third_party/*" -name *.proto -exec clang-format -i {} \; proto-lint: @$(DOCKER_BUF) lint --error-format=json proto-check-breaking: @$(DOCKER_BUF) breaking --against $(HTTPS_GIT)#branch=main TM_URL = https://raw.githubusercontent.com/tendermint/tendermint/v0.34.12/proto/tendermint GOGO_PROTO_URL = https://raw.githubusercontent.com/regen-network/protobuf/cosmos COSMOS_SDK_URL = https://raw.githubusercontent.com/cosmos/cosmos-sdk/v0.43.0 COSMOS_PROTO_URL = https://raw.githubusercontent.com/regen-network/cosmos-proto/master TM_CRYPTO_TYPES = third_party/proto/tendermint/crypto TM_ABCI_TYPES = third_party/proto/tendermint/abci TM_TYPES = third_party/proto/tendermint/types GOGO_PROTO_TYPES = third_party/proto/gogoproto COSMOS_PROTO_TYPES = third_party/proto/cosmos_proto proto-update-deps: @mkdir -p $(GOGO_PROTO_TYPES) @curl -sSL $(GOGO_PROTO_URL)/gogoproto/gogo.proto > $(GOGO_PROTO_TYPES)/gogo.proto @mkdir -p $(COSMOS_PROTO_TYPES) @curl -sSL $(COSMOS_PROTO_URL)/cosmos.proto > $(COSMOS_PROTO_TYPES)/cosmos.proto ## Importing of tendermint protobuf definitions currently requires the ## use of `sed` in order to build properly with cosmos-sdk's proto file layout ## (which is the standard Buf.build FILE_LAYOUT) ## Issue link: https://github.com/tendermint/tendermint/issues/5021 @mkdir -p $(TM_ABCI_TYPES) @curl -sSL $(TM_URL)/abci/types.proto > $(TM_ABCI_TYPES)/types.proto @mkdir -p $(TM_TYPES) @curl -sSL $(TM_URL)/types/types.proto > $(TM_TYPES)/types.proto @mkdir -p $(TM_CRYPTO_TYPES) @curl -sSL $(TM_URL)/crypto/proof.proto > $(TM_CRYPTO_TYPES)/proof.proto @curl -sSL $(TM_URL)/crypto/keys.proto > $(TM_CRYPTO_TYPES)/keys.proto .PHONY: proto-all proto-gen proto-gen-any proto-swagger-gen proto-format proto-lint proto-check-breaking proto-update-deps ############################################################################### ### Localnet ### ############################################################################### # Build image for a local testnet localnet-build: @$(MAKE) -C networks/local # Start a 4-node testnet locally localnet-start: localnet-stop ifeq ($(OS),Windows_NT) mkdir localnet-setup & @$(MAKE) localnet-build IF not exist "build/node0/$(ETHERMINT_BINARY)/config/genesis.json" docker run --rm -v $(CURDIR)/build\ethermint\Z ethermintd/node "./ethermintd testnet --v 4 -o /ethermint --keyring-backend=test --ip-addresses ethermintdnode0,ethermintdnode1,ethermintdnode2,ethermintdnode3" docker-compose up -d else mkdir -p localnet-setup @$(MAKE) localnet-build if ! [ -f localnet-setup/node0/$(ETHERMINT_BINARY)/config/genesis.json ]; then docker run --rm -v $(CURDIR)/localnet-setup:/ethermint:Z ethermintd/node "./ethermintd testnet --v 4 -o /ethermint --keyring-backend=test --ip-addresses ethermintdnode0,ethermintdnode1,ethermintdnode2,ethermintdnode3"; fi docker-compose up -d endif # Stop testnet localnet-stop: docker-compose down # Clean testnet localnet-clean: docker-compose down sudo rm -rf localnet-setup # Reset testnet localnet-unsafe-reset: docker-compose down ifeq ($(OS),Windows_NT) @docker run --rm -v $(CURDIR)\localnet-setup\node0\ethermitd:ethermint\Z ethermintd/node "./ethermintd unsafe-reset-all --home=/ethermint" @docker run --rm -v $(CURDIR)\localnet-setup\node1\ethermitd:ethermint\Z ethermintd/node "./ethermintd unsafe-reset-all --home=/ethermint" @docker run --rm -v $(CURDIR)\localnet-setup\node2\ethermitd:ethermint\Z ethermintd/node "./ethermintd unsafe-reset-all --home=/ethermint" @docker run --rm -v $(CURDIR)\localnet-setup\node3\ethermitd:ethermint\Z ethermintd/node "./ethermintd unsafe-reset-all --home=/ethermint" else @docker run --rm -v $(CURDIR)/localnet-setup/node0/ethermitd:/ethermint:Z ethermintd/node "./ethermintd unsafe-reset-all --home=/ethermint" @docker run --rm -v $(CURDIR)/localnet-setup/node1/ethermitd:/ethermint:Z ethermintd/node "./ethermintd unsafe-reset-all --home=/ethermint" @docker run --rm -v $(CURDIR)/localnet-setup/node2/ethermitd:/ethermint:Z ethermintd/node "./ethermintd unsafe-reset-all --home=/ethermint" @docker run --rm -v $(CURDIR)/localnet-setup/node3/ethermitd:/ethermint:Z ethermintd/node "./ethermintd unsafe-reset-all --home=/ethermint" endif # Clean testnet localnet-show-logstream: docker-compose logs --tail=1000 -f .PHONY: build-docker-local-ethermint localnet-start localnet-stop ############################################################################### ### Releasing ### ############################################################################### PACKAGE_NAME:=github.com/tharsis/ethermint GOLANG_CROSS_VERSION = v1.17 release-dry-run: docker run \ --rm \ --privileged \ -e CGO_ENABLED=1 \ -v /var/run/docker.sock:/var/run/docker.sock \ -v `pwd`:/go/src/$(PACKAGE_NAME) \ -v ${GOPATH}/pkg:/go/pkg \ -w /go/src/$(PACKAGE_NAME) \ troian/golang-cross:${GOLANG_CROSS_VERSION} \ --rm-dist --skip-validate --skip-publish release: @if [ ! -f ".release-env" ]; then \ echo "\033[91m.release-env is required for release\033[0m";\ exit 1;\ fi docker run \ --rm \ --privileged \ -e CGO_ENABLED=1 \ --env-file .release-env \ -v /var/run/docker.sock:/var/run/docker.sock \ -v `pwd`:/go/src/$(PACKAGE_NAME) \ -w /go/src/$(PACKAGE_NAME) \ troian/golang-cross:${GOLANG_CROSS_VERSION} \ release --rm-dist --skip-validate .PHONY: release-dry-run release