mirror of
				https://github.com/0glabs/0g-chain.git
				synced 2025-04-04 15:55:23 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			204 lines
		
	
	
		
			7.4 KiB
		
	
	
	
		
			Makefile
		
	
	
	
	
	
			
		
		
	
	
			204 lines
		
	
	
		
			7.4 KiB
		
	
	
	
		
			Makefile
		
	
	
	
	
	
| #!/usr/bin/make -f
 | |
| 
 | |
| VERSION := $(shell echo $(shell git describe --tags) | sed 's/^v//')
 | |
| COMMIT := $(shell git log -1 --format='%H')
 | |
| LEDGER_ENABLED ?= true
 | |
| export GO111MODULE = on
 | |
| 
 | |
| # 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 ($(WITH_CLEVELDB),yes)
 | |
|   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=kava \
 | |
| 		  -X github.com/cosmos/cosmos-sdk/version.ServerName=kvd \
 | |
| 		  -X github.com/cosmos/cosmos-sdk/version.ClientName=kvcli \
 | |
| 		  -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)"
 | |
| 
 | |
| ifeq ($(WITH_CLEVELDB),yes)
 | |
|   ldflags += -X github.com/cosmos/cosmos-sdk/types.DBBackend=cleveldb
 | |
| endif
 | |
| ldflags += $(LDFLAGS)
 | |
| ldflags := $(strip $(ldflags))
 | |
| 
 | |
| BUILD_FLAGS := -tags "$(build_tags)" -ldflags '$(ldflags)'
 | |
| 
 | |
| 
 | |
| all: install
 | |
| 
 | |
| build: go.sum
 | |
| ifeq ($(OS), Windows_NT)
 | |
| 	go build -mod=readonly $(BUILD_FLAGS) -o build/$(shell go env GOOS)/kvd.exe ./cmd/kvd
 | |
| 	go build -mod=readonly $(BUILD_FLAGS) -o build/$(shell go env GOOS)/kvcli.exe ./cmd/kvcli
 | |
| else
 | |
| 	go build -mod=readonly $(BUILD_FLAGS) -o build/$(shell go env GOOS)/kvd ./cmd/kvd
 | |
| 	go build -mod=readonly $(BUILD_FLAGS) -o build/$(shell go env GOOS)/kvcli ./cmd/kvcli
 | |
| endif
 | |
| 
 | |
| build-linux: go.sum
 | |
| 	LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 $(MAKE) build
 | |
| 
 | |
| install: go.sum
 | |
| 	go install -mod=readonly $(BUILD_FLAGS) ./cmd/kvd
 | |
| 	go install -mod=readonly $(BUILD_FLAGS) ./cmd/kvcli
 | |
| 
 | |
| ########################################
 | |
| ### Tools & dependencies
 | |
| 
 | |
| go-mod-cache: go.sum
 | |
| 	@echo "--> Download go modules to local cache"
 | |
| 	@go mod download
 | |
| PHONY: go-mod-cache
 | |
| 
 | |
| go.sum: go.mod
 | |
| 	@echo "--> Ensuring dependencies have not been modified"
 | |
| 	@go mod verify
 | |
| 
 | |
| clean:
 | |
| 	rm -rf build/
 | |
| 
 | |
| ########################################
 | |
| ### Linting
 | |
| 
 | |
| # Check url links in the repo are not broken.
 | |
| # This tool checks local markdown links as well.
 | |
| # Set to exclude riot links as they trigger false positives
 | |
| link-check:
 | |
| 	@go get -u github.com/raviqqe/liche@f57a5d1c5be4856454cb26de155a65a4fd856ee3
 | |
| 	liche -r . --exclude "^http://127.*|^https://riot.im/app*|^http://kava-testnet*|^https://testnet-dex*|^https://kava3.data.kava.io*|^https://ipfs.io*|^https://apps.apple.com*"
 | |
| 
 | |
| 
 | |
| lint:
 | |
| 	golangci-lint run
 | |
| 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" | xargs gofmt -d -s
 | |
| 	go mod verify
 | |
| .PHONY: lint
 | |
| 
 | |
| format:
 | |
| 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -name '*.pb.go' | xargs gofmt -w -s
 | |
| 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -name '*.pb.go' | xargs misspell -w
 | |
| 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -name '*.pb.go' | xargs goimports -w -local github.com/tendermint
 | |
| 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -name '*.pb.go' | xargs goimports -w -local github.com/cosmos/cosmos-sdk
 | |
| 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -name '*.pb.go' | xargs goimports -w -local github.com/kava-labs/kava
 | |
| .PHONY: format
 | |
| 
 | |
| ###############################################################################
 | |
| ###                                Localnet                                 ###
 | |
| ###############################################################################
 | |
| 
 | |
| build-docker-local-kava:
 | |
| 	@$(MAKE) -C networks/local
 | |
| 
 | |
| # Run a 4-node testnet locally
 | |
| localnet-start: build-linux localnet-stop
 | |
| 	@if ! [ -f build/node0/kvd/config/genesis.json ]; then docker run --rm -v $(CURDIR)/build:/kvd:Z kava/kavanode testnet --v 4 -o . --starting-ip-address 192.168.10.2 --keyring-backend=test ; fi
 | |
| 	docker-compose up -d
 | |
| 
 | |
| localnet-stop:
 | |
| 	docker-compose down
 | |
| 
 | |
| ########################################
 | |
| ### Testing
 | |
| 
 | |
| # TODO tidy up cli tests to use same -Enable flag as simulations, or the other way round
 | |
| # TODO -mod=readonly ?
 | |
| # build dependency needed for cli tests
 | |
| test-all: build
 | |
| 	# basic app tests
 | |
| 	@go test ./app -v
 | |
| 	# basic simulation (seed "4" happens to not unbond all validators before reaching 100 blocks)
 | |
| 	@go test ./app -run TestFullAppSimulation        -Enabled -Commit -NumBlocks=100 -BlockSize=200 -Seed 4 -v -timeout 24h
 | |
| 	# other sim tests
 | |
| 	@go test ./app -run TestAppImportExport          -Enabled -Commit -NumBlocks=100 -BlockSize=200 -Seed 4 -v -timeout 24h
 | |
| 	@go test ./app -run TestAppSimulationAfterImport -Enabled -Commit -NumBlocks=100 -BlockSize=200 -Seed 4 -v -timeout 24h
 | |
| 	@# AppStateDeterminism does not use Seed flag
 | |
| 	@go test ./app -run TestAppStateDeterminism      -Enabled -Commit -NumBlocks=100 -BlockSize=200 -Seed 4 -v -timeout 24h
 | |
| 
 | |
| # run module tests and short simulations
 | |
| test-basic: test
 | |
| 	@go test ./app -run TestFullAppSimulation        -Enabled -Commit -NumBlocks=5 -BlockSize=200 -Seed 4 -v -timeout 2m
 | |
| 	# other sim tests
 | |
| 	@go test ./app -run TestAppImportExport          -Enabled -Commit -NumBlocks=5 -BlockSize=200 -Seed 4 -v -timeout 2m
 | |
| 	@go test ./app -run TestAppSimulationAfterImport -Enabled -Commit -NumBlocks=5 -BlockSize=200 -Seed 4 -v -timeout 2m
 | |
| 	@# AppStateDeterminism does not use Seed flag
 | |
| 	@go test ./app -run TestAppStateDeterminism      -Enabled -Commit -NumBlocks=5 -BlockSize=200 -Seed 4 -v -timeout 2m
 | |
| 
 | |
| test:
 | |
| 	@go test $$(go list ./... | grep -v 'migrate\|contrib')
 | |
| 
 | |
| test-rest:
 | |
| 	rest_test/run_all_tests_from_make.sh
 | |
| 
 | |
| # Run cli integration tests
 | |
| # `-p 4` to use 4 cores, `-tags cli_test` to tell go not to ignore the cli package
 | |
| # These tests use the `kvd` or `kvcli` binaries in the build dir, or in `$BUILDDIR` if that env var is set.
 | |
| test-cli: build
 | |
| 	@go test ./cli_test -tags cli_test -v -p 4
 | |
| 
 | |
| # Kick start lots of sims on an AWS cluster.
 | |
| # This submits an AWS Batch job to run a lot of sims, each within a docker image. Results are uploaded to S3
 | |
| start-remote-sims:
 | |
| 	# build the image used for running sims in, and tag it
 | |
| 	docker build -f simulations/Dockerfile -t kava/kava-sim:master .
 | |
| 	# push that image to the hub
 | |
| 	docker push kava/kava-sim:master
 | |
| 	# submit an array job on AWS Batch, using 1000 seeds, spot instances
 | |
| 	aws batch submit-job \
 | |
| 		-—job-name "master-$(VERSION)" \
 | |
| 		-—job-queue “simulation-1-queue-spot" \
 | |
| 		-—array-properties size=1000 \
 | |
| 		-—job-definition kava-sim-master \
 | |
| 		-—container-override environment=[{SIM_NAME=master-$(VERSION)}]
 | |
| 
 | |
| .PHONY: all build-linux install clean build test test-cli test-all test-rest test-basic start-remote-sims
 | |
| 
 | |
| ########################################
 | |
| ### Documentation
 | |
| 
 | |
| # Start docs site at localhost:8080
 | |
| docs-develop:
 | |
| 	@cd docs && \
 | |
| 	npm install && \
 | |
| 	npm run serve
 | |
| 
 | |
| # Build the site into docs/.vuepress/dist
 | |
| docs-build:
 | |
| 	@cd docs && \
 | |
| 	npm install && \
 | |
| 	npm run build
 | 
