-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMakefile
More file actions
475 lines (377 loc) Β· 17 KB
/
Makefile
File metadata and controls
475 lines (377 loc) Β· 17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
#!/usr/bin/make -f
###############################################################################
### Module & Versioning ###
###############################################################################
VERSION ?= $(shell echo $(shell git describe --tags --always) | sed 's/^v//')
TMVERSION := $(shell go list -m github.com/cometbft/cometbft | sed 's:.* ::')
COMMIT := $(shell git log -1 --format='%H')
###############################################################################
### Directories & Binaries ###
###############################################################################
BINDIR ?= $(GOPATH)/bin
BUILDDIR ?= $(CURDIR)/build
EXAMPLE_BINARY := evmd
###############################################################################
### Repo Info ###
###############################################################################
HTTPS_GIT := https://github.com/cosmos/evm.git
DOCKER := $(shell which docker)
export GO111MODULE = on
###############################################################################
### Submodule Settings ###
###############################################################################
# evmd is a separate module under ./evmd
EVMD_DIR := evmd
EVMD_MAIN_PKG := ./cmd/evmd
###############################################################################
### Build & Install evmd ###
###############################################################################
# process build tags
build_tags = netgo
ifeq (cleveldb,$(findstring cleveldb,$(COSMOS_BUILD_OPTIONS)))
build_tags += gcc
endif
ifeq (rocksdb,$(findstring rocksdb,$(COSMOS_BUILD_OPTIONS)))
build_tags += gcc
build_tags += rocksdb
endif
build_tags += $(BUILD_TAGS)
build_tags := $(strip $(build_tags))
# process linker flags
ldflags = -X github.com/cosmos/cosmos-sdk/version.Name=os \
-X github.com/cosmos/cosmos-sdk/version.AppName=$(EXAMPLE_BINARY) \
-X github.com/cosmos/cosmos-sdk/version.Version=$(VERSION) \
-X github.com/cosmos/cosmos-sdk/version.Commit=$(COMMIT) \
-X github.com/cometbft/cometbft/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 (rocksdb,$(findstring rocksdb,$(COSMOS_BUILD_OPTIONS)))
ldflags += -X github.com/cosmos/cosmos-sdk/types.DBBackend=rocksdb
endif
# add build tags to linker flags
whitespace := $(subst ,, )
comma := ,
build_tags_comma_sep := $(subst $(whitespace),$(comma),$(build_tags))
ldflags += -X "github.com/cosmos/cosmos-sdk/version.BuildTags=$(build_tags_comma_sep)"
ifeq (,$(findstring nostrip,$(COSMOS_BUILD_OPTIONS)))
ldflags += -w -s
endif
ldflags += $(LDFLAGS)
ldflags := $(strip $(ldflags))
ifeq (staticlink,$(findstring staticlink,$(COSMOS_BUILD_OPTIONS)))
ldflags += -linkmode external -extldflags '-static'
endif
BUILD_FLAGS := -tags "$(build_tags)" -ldflags '$(ldflags)'
# check for nostrip option
ifeq (,$(findstring nostrip,$(COSMOS_BUILD_OPTIONS)))
BUILD_FLAGS += -trimpath
endif
# check if no optimization option is passed
# used for remote debugging
ifneq (,$(findstring nooptimization,$(COSMOS_BUILD_OPTIONS)))
BUILD_FLAGS += -gcflags "all=-N -l"
endif
# Build into $(BUILDDIR)
build: go.sum $(BUILDDIR)/
@echo "ποΈ Building evmd to $(BUILDDIR)/$(EXAMPLE_BINARY) ..."
@echo "BUILD_FLAGS: $(BUILD_FLAGS)"
@cd $(EVMD_DIR) && CGO_ENABLED="1" \
go build $(BUILD_FLAGS) -o $(BUILDDIR)/$(EXAMPLE_BINARY) $(EVMD_MAIN_PKG)
# Cross-compile for Linux AMD64
build-linux:
GOOS=linux GOARCH=amd64 $(MAKE) build
# Install into $(BINDIR)
install: go.sum
@echo "π Installing evmd to $(BINDIR) ..."
@echo "BUILD_FLAGS: $(BUILD_FLAGS)"
@cd $(EVMD_DIR) && CGO_ENABLED="1" \
go install $(BUILD_FLAGS) $(EVMD_MAIN_PKG)
$(BUILDDIR)/:
mkdir -p $(BUILDDIR)/
# Default & all target
.PHONY: all build build-linux install
all: build
###############################################################################
### Tools & Dependencies ###
###############################################################################
go.sum: go.mod
echo "Ensure dependencies have not been modified ..." >&2
go mod verify
go mod tidy
vulncheck:
@go install golang.org/x/vuln/cmd/govulncheck@latest
@govulncheck ./...
###############################################################################
### Tests & Simulation ###
###############################################################################
PACKAGES_NOSIMULATION=$(shell go list ./... | grep -v '/simulation')
PACKAGES_UNIT := $(shell go list ./... | grep -v '/tests/e2e$$' | grep -v '/simulation' | grep -v '/scripts/')
PACKAGES_EVMD := $(shell cd evmd && go list ./... | grep -v '/simulation')
COVERPKG_EVM := $(shell go list ./... | grep -v '/tests/e2e$$' | grep -v '/simulation' | paste -sd, -)
COVERPKG_ALL := $(COVERPKG_EVM)
COMMON_COVER_ARGS := -timeout=15m -covermode=atomic
TEST_PACKAGES := ./...
TEST_TARGETS := test-unit test-evmd test-unit-cover test-race
test-unit: ARGS=-timeout=15m
test-unit: TEST_PACKAGES=$(PACKAGES_UNIT)
test-unit: run-tests
test-race: ARGS=-race
test-race: TEST_PACKAGES=$(PACKAGES_UNIT)
test-race: run-tests
test-evmd: ARGS=-timeout=15m
test-evmd:
@cd evmd && go test -count=1 -race -tags=test -mod=readonly $(ARGS) $(EXTRA_ARGS) $(PACKAGES_EVMD)
test-unit-cover: ARGS=-timeout=15m -coverprofile=coverage.txt -covermode=atomic
test-unit-cover: TEST_PACKAGES=$(PACKAGES_UNIT)
test-unit-cover: run-tests
@echo "π Running evm (root) coverage..."
@go test -race -tags=test $(COMMON_COVER_ARGS) -coverpkg=$(COVERPKG_ALL) -coverprofile=coverage.txt ./...
@echo "π Running evmd coverage..."
@cd evmd && go test -race -tags=test $(COMMON_COVER_ARGS) -coverpkg=$(COVERPKG_ALL) -coverprofile=coverage_evmd.txt ./...
@echo "π Merging evmd coverage into root coverage..."
@tail -n +2 evmd/coverage_evmd.txt >> coverage.txt && rm evmd/coverage_evmd.txt
@echo "π§Ή Filtering ignored files from coverage.txt..."
@grep -v -E '/cmd/|/client/|/proto/|/testutil/|/mocks/|/test_.*\.go:|\.pb\.go:|\.pb\.gw\.go:|/x/[^/]+/module\.go:|/scripts/|/ibc/testing/|/version/|\.md:|\.pulsar\.go:' coverage.txt > tmp_coverage.txt && mv tmp_coverage.txt coverage.txt
test: test-unit
test-all:
@echo "π Running evm module tests..."
@go test -race -tags=test -mod=readonly -timeout=15m $(PACKAGES_NOSIMULATION)
@echo "π Running evmd module tests..."
@cd evmd && go test -race -tags=test -mod=readonly -timeout=15m $(PACKAGES_EVMD)
run-tests:
ifneq (,$(shell which tparse 2>/dev/null))
go test -count=1 -race -tags=test -mod=readonly -json $(ARGS) $(EXTRA_ARGS) $(TEST_PACKAGES) | tparse
else
go test -count=1 -race -tags=test -mod=readonly $(ARGS) $(EXTRA_ARGS) $(TEST_PACKAGES)
endif
# Use the old Apple linker to workaround broken xcode - https://github.com/golang/go/issues/65169
ifeq ($(OS_FAMILY),Darwin)
FUZZLDFLAGS := -ldflags=-extldflags=-Wl,-ld_classic
endif
test-fuzz:
go test -race -tags=test $(FUZZLDFLAGS) -run NOTAREALTEST -v -fuzztime 10s -fuzz=FuzzMintCoins ./x/precisebank/keeper
go test -race -tags=test $(FUZZLDFLAGS) -run NOTAREALTEST -v -fuzztime 10s -fuzz=FuzzBurnCoins ./x/precisebank/keeper
go test -race -tags=test $(FUZZLDFLAGS) -run NOTAREALTEST -v -fuzztime 10s -fuzz=FuzzSendCoins ./x/precisebank/keeper
go test -race -tags=test $(FUZZLDFLAGS) -run NOTAREALTEST -v -fuzztime 10s -fuzz=FuzzGenesisStateValidate_NonZeroRemainder ./x/precisebank/types
go test -race -tags=test $(FUZZLDFLAGS) -run NOTAREALTEST -v -fuzztime 10s -fuzz=FuzzGenesisStateValidate_ZeroRemainder ./x/precisebank/types
test-scripts:
@echo "Running scripts tests"
@pytest -s -vv ./scripts
test-solidity:
@echo "Beginning solidity tests..."
./scripts/run-solidity-tests.sh
.PHONY: run-tests test test-all $(TEST_TARGETS)
benchmark:
@go test -race -tags=test -mod=readonly -bench=. $(PACKAGES_NOSIMULATION)
.PHONY: benchmark
###############################################################################
### Linting ###
###############################################################################
golangci_lint_cmd=$(GOPATH)/bin/golangci-lint
golangci_version=latest
lint: lint-go lint-python lint-contracts
lint-go:
@echo "--> Running linter"
@go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(golangci_version)
@$(golangci_lint_cmd) run --timeout=15m
lint-python:
find . -name "*.py" -type f -not -path "*/node_modules/*" | xargs pylint
flake8
lint-contracts:
solhint contracts/**/*.sol
lint-fix:
@go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(golangci_version)
@$(golangci_lint_cmd) run --timeout=15m --fix
lint-fix-contracts:
solhint --fix contracts/**/*.sol
.PHONY: lint lint-fix lint-contracts lint-go lint-python
format: format-go format-python format-shell
format-go:
find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/docs/statik/statik.go" -not -name '*.pb.go' -not -name '*.pb.gw.go' -not -name '*.pulsar.go' | xargs gofumpt -w -l
format-python: format-isort format-black
format-black:
find . -name '*.py' -type f -not -path "*/node_modules/*" | xargs black
format-isort:
find . -name '*.py' -type f -not -path "*/node_modules/*" | xargs isort
format-shell:
shfmt -l -w .
.PHONY: format format-go format-python format-black format-isort format-go
###############################################################################
### Protobuf ###
###############################################################################
protoVer=0.14.0
protoImageName=ghcr.io/cosmos/proto-builder:$(protoVer)
protoImage=$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace --user 0 $(protoImageName)
protoLintVer=0.44.0
protoLinterImage=yoheimuta/protolint
protoLinter=$(DOCKER) run --rm -v "$(CURDIR):/workspace" --workdir /workspace --user 0 $(protoLinterImage):$(protoLintVer)
# ------
# NOTE: If you are experiencing problems running these commands, try deleting
# the docker images and execute the desired command again.
#
proto-all: proto-format proto-lint proto-gen
proto-gen:
@echo "generating implementations from Protobuf files"
@$(protoImage) sh ./scripts/generate_protos.sh
@$(protoImage) sh ./scripts/generate_protos_pulsar.sh
proto-format:
@echo "formatting Protobuf files"
@$(protoImage) find ./ -name *.proto -exec clang-format -i {} \;
proto-lint:
@echo "linting Protobuf files"
@$(protoImage) buf lint --error-format=json
@$(protoLinter) lint ./proto
proto-check-breaking:
@echo "checking Protobuf files for breaking changes"
@$(protoImage) buf breaking --against $(HTTPS_GIT)#branch=main
.PHONY: proto-all proto-gen proto-format proto-lint proto-check-breaking
###############################################################################
### Releasing ###
###############################################################################
PACKAGE_NAME:=github.com/cosmos/evm
GOLANG_CROSS_VERSION = v1.22
GOPATH ?= '$(HOME)/go'
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) \
ghcr.io/goreleaser/goreleaser-cross:${GOLANG_CROSS_VERSION} \
--clean --skip validate --skip publish --snapshot
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) \
ghcr.io/goreleaser/goreleaser-cross:${GOLANG_CROSS_VERSION} \
release --clean --skip validate
.PHONY: release-dry-run release
###############################################################################
### Compile Solidity Contracts ###
###############################################################################
# Install the necessary dependencies, compile the solidity contracts found in the
# Cosmos EVM repository and then clean up the contracts data.
contracts-all: contracts-compile contracts-clean
# Clean smart contract compilation artifacts, dependencies and cache files
contracts-clean:
@echo "Cleaning up the contracts directory..."
@python3 ./scripts/compile_smart_contracts/compile_smart_contracts.py --clean
# Compile the solidity contracts found in the Cosmos EVM repository.
contracts-compile:
@echo "Compiling smart contracts..."
@python3 ./scripts/compile_smart_contracts/compile_smart_contracts.py --compile
# Add a new solidity contract to be compiled
contracts-add:
@echo "Adding a new smart contract to be compiled..."
@python3 ./scripts/compile_smart_contracts/compile_smart_contracts.py --add $(CONTRACT)
###############################################################################
### Localnet ###
###############################################################################
localnet-build-env:
$(MAKE) -C contrib/images evmd-env
localnet-build-nodes:
$(DOCKER) run --rm -v $(CURDIR)/.testnets:/data cosmos/evmd \
testnet init-files --validator-count 4 -o /data --starting-ip-address 192.168.10.2 --keyring-backend=test --chain-id=local-4221 --use-docker=true
docker compose up -d
localnet-stop:
docker compose down
# localnet-start will run a 4-node testnet locally. The nodes are
# based off the docker images in: ./contrib/images/simd-env
localnet-start: localnet-stop localnet-build-env localnet-build-nodes
test-rpc-compat:
@./tests/jsonrpc/scripts/run-compat-test.sh
test-rpc-compat-stop:
cd tests/jsonrpc && docker compose down
.PHONY: localnet-start localnet-stop localnet-build-env localnet-build-nodes test-rpc-compat test-rpc-compat-stop
test-system: build-v05 build
mkdir -p ./tests/systemtests/binaries/
cp $(BUILDDIR)/evmd ./tests/systemtests/binaries/
cd tests/systemtests/Counter && forge build
$(MAKE) -C tests/systemtests test
build-v05:
mkdir -p ./tests/systemtests/binaries/v0.5
git checkout v0.5.0
make build
cp $(BUILDDIR)/evmd ./tests/systemtests/binaries/v0.5
git checkout -
mocks:
@echo "--> generating mocks"
@go get github.com/vektra/mockery/v2
@go generate ./...
@make format-go
###############################################################################
### D2 Diagrams ###
###############################################################################
D2_THEME=300
D2_DARK_THEME=200
D2_LAYOUT=tala
D2_ENV_VARS=D2_THEME=$(D2_THEME) \
D2_DARK_THEME=$(D2_DARK_THEME) \
D2_LAYOUT=$(D2_LAYOUT)
.PHONY: d2check d2watch d2gen d2gen-all
d2check:
@echo "π checking if d2 is installed..."
@which d2 > /dev/null 2>&1 || { \
echo "π΄ d2 is not installed, see installation docs: https://d2lang.com/tour/install/"; \
exit 1; \
}
@echo "π’ d2 is installed"
@echo "π checking if $(D2_LAYOUT) layout is installed..."
@d2 layout | grep $(D2_LAYOUT) > /dev/null 2>&1 || { \
echo "π΄ $(D2_LAYOUT) layout is not installed, see docs: https://d2lang.com/tour/layouts/"; \
exit 1; \
}
@echo "π’ $(D2_LAYOUT) layout is installed"
d2watch: d2check
@if [ -z "$(FILE)" ]; then \
echo "π΄ missing required parameter FILE, the correct usage is: make d2watch FILE=path/to/file.d2"; \
exit 1; \
fi
@if [ ! -f "$(FILE)" ]; then \
echo "π΄ file $(FILE) does not exist"; \
exit 1; \
fi
@echo "π watching $(FILE) for changes..."
@dir=$$(dirname "$(FILE)"); \
basename=$$(basename "$(FILE)" .d2); \
svgfile="$$dir/$$basename.svg"; \
printf "π generating $$svgfile from $(FILE)... "; \
$(D2_ENV_VARS) d2 --watch "$(FILE)" "$$svgfile"
d2gen: d2check
@if [ -z "$(FILE)" ]; then \
echo "π΄ missing required parameter FILE, the correct usage is: make d2gen FILE=path/to/file.d2"; \
exit 1; \
fi
@if [ ! -f "$(FILE)" ]; then \
echo "π΄ file $(FILE) does not exist"; \
exit 1; \
fi
@dir=$$(dirname "$(FILE)"); \
basename=$$(basename "$(FILE)" .d2); \
svgfile="$$dir/$$basename.svg"; \
printf "π generating $$svgfile from $(FILE)... "; \
$(D2_ENV_VARS) d2 "$(FILE)" "$$svgfile" > /dev/null 2>&1 && echo "done β
" || echo "failed β";
d2gen-all: d2check
@echo "π’ generating svg files for all d2 diagrams..."
@find . -name "*.d2" -type f | while read d2file; do \
dir=$$(dirname "$$d2file"); \
basename=$$(basename "$$d2file" .d2); \
svgfile="$$dir/$$basename.svg"; \
printf "π generating $$svgfile from $$d2file... "; \
$(D2_ENV_VARS) d2 "$$d2file" "$$svgfile" > /dev/null 2>&1 && echo "done β
" || echo "failed β"; \
done
@echo "β
svg files generated for all d2 diagrams"