Repository navigation
Expand file tree
/
Copy pathMakefile
More file actions
335 lines (261 loc) · 14.5 KB
/
Copy pathMakefile
File metadata and controls
335 lines (261 loc) · 14.5 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
#!/usr/bin/make -f
export VERSION := $(shell echo $(shell git describe --always --match "v*") | sed 's/^v//')
export COMMIT := $(shell git log -1 --format='%H')
export COMETBFT_VERSION := $(shell go list -m github.com/cometbft/cometbft | sed 's:.* ::')
BIN_DIR ?= $(GOPATH)/bin
BUILD_DIR ?= $(CURDIR)/build
PROJECT_NAME = $(shell git remote get-url origin | xargs basename -s .git)
HTTPS_GIT := https://github.com/dydxprotocol/slinky.git
DOCKER := $(shell which docker)
DOCKER_COMPOSE := $(shell which docker-compose)
HOMEDIR ?= $(CURDIR)/tests/.slinkyd
GENESIS ?= $(HOMEDIR)/config/genesis.json
GENESIS_TMP ?= $(HOMEDIR)/config/genesis_tmp.json
APP_TOML ?= $(HOMEDIR)/config/app.toml
CONFIG_TOML ?= $(HOMEDIR)/config/config.toml
COVER_FILE ?= cover.out
BENCHMARK_ITERS ?= 10
USE_CORE_MARKETS ?= true
USE_RAYDIUM_MARKETS ?= false
USE_UNISWAPV3_BASE_MARKETS ?= false
USE_COINGECKO_MARKETS ?= false
USE_COINMARKETCAP_MARKETS ?= false
USE_OSMOSIS_MARKETS ?= false
USE_POLYMARKET_MARKETS ?= false
SCRIPT_DIR := $(CURDIR)/scripts
DEV_COMPOSE ?= $(CURDIR)/contrib/compose/docker-compose-dev.yml
TAG := $(shell git describe --tags --always --dirty)
export HOMEDIR := $(HOMEDIR)
export APP_TOML := $(APP_TOML)
export GENESIS := $(GENESIS)
export GENESIS_TMP := $(GENESIS_TMP)
export USE_CORE_MARKETS ?= $(USE_CORE_MARKETS)
export USE_RAYDIUM_MARKETS ?= $(USE_RAYDIUM_MARKETS)
export USE_UNISWAPV3_BASE_MARKETS ?= $(USE_UNISWAPV3_BASE_MARKETS)
export USE_COINGECKO_MARKETS ?= $(USE_COINGECKO_MARKETS)
export USE_COINMARKETCAP_MARKETS ?= $(USE_COINMARKETCAP_MARKETS)
export USE_OSMOSIS_MARKETS ?= $(USE_OSMOSIS_MARKETS)
export USE_POLYMARKET_MARKETS ?= $(USE_POLYMARKET_MARKETS)
export SCRIPT_DIR := $(SCRIPT_DIR)
BUILD_TAGS := -X github.com/dydxprotocol/slinky/cmd/build.Build=$(TAG)
###############################################################################
### build ###
###############################################################################
build: tidy
go build -ldflags="$(BUILD_TAGS)" \
-o ./build/ ./...
run-oracle-client: build
@./build/client --host localhost --port 8080
start-all-dev:
@echo "Starting development oracle side-car, blockchain, grafana, and prometheus dashboard..."
@$(DOCKER_COMPOSE) -f $(DEV_COMPOSE) --profile all up -d --build
stop-all-dev:
@echo "Stopping development network..."
@$(DOCKER_COMPOSE) -f $(DEV_COMPOSE) --profile all down
start-sidecar-dev:
@echo "Starting development oracle side-car, grafana, and prometheus dashboard..."
@$(DOCKER_COMPOSE) -f $(DEV_COMPOSE) --profile sidecar up -d --build
stop-sidecar-dev:
@echo "Stopping development oracle..."
@$(DOCKER_COMPOSE) -f $(DEV_COMPOSE) --profile sidecar down
install: tidy
@go install -ldflags="$(BUILD_TAGS)" ./cmd/slinky
.PHONY: build install run-oracle-client start-all-dev stop-all-dev
###############################################################################
## Docker ##
###############################################################################
docker-build:
@echo "Building Docker images..."
docker buildx build -t ghcr.io/dydxprotocol/slinky-base -f contrib/images/slinky.base.Dockerfile . --platform linux/amd64,linux/arm64
docker buildx build -t ghcr.io/dydxprotocol/slinky-e2e-sidecar -f contrib/images/slinky.sidecar.e2e.Dockerfile . --platform linux/amd64,linux/arm64
docker buildx build -t ghcr.io/dydxprotocol/slinky-local-app -f contrib/images/slinky.local.Dockerfile . --platform linux/amd64,linux/arm64
docker buildx build -t ghcr.io/dydxprotocol/slinky-market-simulator -f contrib/images/slinky.market.simulator.Dockerfile . --platform linux/amd64,linux/arm64
docker buildx build -t ghcr.io/dydxprotocol/slinky-sidecar -f contrib/images/slinky.sidecar.Dockerfile . --platform linux/amd64,linux/arm64
docker buildx build -t ghcr.io/dydxprotocol/slinky-sidecar-dev -f contrib/images/slinky.sidecar.dev.Dockerfile . --platform linux/amd64,linux/arm64
docker buildx build -t ghcr.io/dydxprotocol/slinky-sim-app -f contrib/images/slinky.sim.app.Dockerfile . --platform linux/amd64,linux/arm64
docker-push:
@echo "Pushing Docker images..."
docker buildx build -t ghcr.io/dydxprotocol/slinky-base -f contrib/images/slinky.base.Dockerfile . --platform linux/amd64,linux/arm64 --push
docker buildx build -t ghcr.io/dydxprotocol/slinky-e2e-sidecar -f contrib/images/slinky.sidecar.e2e.Dockerfile . --platform linux/amd64,linux/arm64 --push
docker buildx build -t ghcr.io/dydxprotocol/slinky-local-app -f contrib/images/slinky.local.Dockerfile . --platform linux/amd64,linux/arm64 --push
docker buildx build -t ghcr.io/dydxprotocol/slinky-market-simulator -f contrib/images/slinky.market.simulator.Dockerfile . --platform linux/amd64,linux/arm64 --push
docker buildx build -t ghcr.io/dydxprotocol/slinky-sidecar -f contrib/images/slinky.sidecar.Dockerfile . --platform linux/amd64,linux/arm64 --push
docker buildx build -t ghcr.io/dydxprotocol/slinky-sidecar-dev -f contrib/images/slinky.sidecar.dev.Dockerfile . --platform linux/amd64,linux/arm64 --push
docker buildx build -t ghcr.io/dydxprotocol/slinky-sim-app -f contrib/images/slinky.sim.app.Dockerfile . --platform linux/amd64,linux/arm64 --push
e2e-docker-build:
@echo "Building Docker images..."
# don't build for multiple platforms - build in native arch for e2e test runner
# load to cache to provide local image for e2e test runner
docker buildx build --load --cache-from=type=local,src=.buildx-cache,scope=slinky-sim-app --cache-to=type=local,dest=.buildx-cache,mode=max,compression=zstd,scope=slinky-sim-app -t slinky-sim-app -f contrib/images/slinky.sim.app.Dockerfile --load .
docker buildx build --load --cache-from=type=local,src=.buildx-cache,scope=slinky-e2e-sidecar --cache-to=type=local,dest=.buildx-cache,mode=max,compression=zstd,scope=slinky-e2e-sidecar -t slinky-e2e-sidecar -f contrib/images/slinky.sidecar.e2e.Dockerfile --load .
.PHONY: docker-build e2e-docker-build
###############################################################################
### Test App ###
###############################################################################
whitespace :=
whitespace += $(whitespace)
comma := ,
build_tags_comma_sep := $(subst $(whitespace),$(comma),$(build_tags))
ldflags = -X github.com/cosmos/cosmos-sdk/version.Name=testapp \
-X github.com/cosmos/cosmos-sdk/version.AppName=testappd \
-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/cometbft/cometbft/version.TMCoreSemVer=$(COMETBFT_VERSION)
# DB backend selection
ifeq (cleveldb,$(findstring cleveldb,$(COSMOS_BUILD_OPTIONS)))
build_tags += gcc
endif
ifeq (badgerdb,$(findstring badgerdb,$(COSMOS_BUILD_OPTIONS)))
build_tags += badgerdb
endif
# handle rocksdb
ifeq (rocksdb,$(findstring rocksdb,$(COSMOS_BUILD_OPTIONS)))
CGO_ENABLED=1
build_tags += rocksdb
endif
# handle boltdb
ifeq (boltdb,$(findstring boltdb,$(COSMOS_BUILD_OPTIONS)))
build_tags += boltdb
endif
ifeq (,$(findstring nostrip,$(COSMOS_BUILD_OPTIONS)))
ldflags += -w -s
endif
ldflags += $(LDFLAGS)
ldflags := $(strip $(ldflags))
build_tags += $(BUILD_TAGS)
build_tags := $(strip $(build_tags))
BUILD_FLAGS := -tags "$(build_tags)" -ldflags '$(ldflags)'
# check for nostrip option
ifeq (,$(findstring nostrip,$(COSMOS_BUILD_OPTIONS)))
BUILD_FLAGS += -trimpath
endif
BUILD_TARGETS := build-sim-app
build-sim-app: BUILD_ARGS=-o $(BUILD_DIR)/
$(BUILD_TARGETS): $(BUILD_DIR)/
@cd $(CURDIR)/tests/simapp && go build -mod=readonly $(BUILD_FLAGS) $(BUILD_ARGS) ./...
$(BUILD_DIR)/:
@mkdir -p $(BUILD_DIR)/
delete-configs:
@rm -rf ./tests/.slinkyd/
build-market-map:
@echo "Building market map..."
@sh ./scripts/genesis.sh
# build-configs builds a slinky simulation application binary in the build folder (/test/.slinkyd)
build-configs: delete-configs build-market-map
@dasel put -r toml 'instrumentation.enabled' -f $(CONFIG_TOML) -t bool -v true
@dasel put -r toml 'rpc.laddr' -f $(CONFIG_TOML) -t string -v "tcp://0.0.0.0:26657"
@dasel put -r toml 'telemetry.enabled' -f $(APP_TOML) -t bool -v true
@dasel put -r toml 'api.enable' -f $(APP_TOML) -t bool -v true
@dasel put -r toml 'grpc.address' -f $(APP_TOML) -t string -v "0.0.0.0:9090"
@dasel put -r toml 'api.address' -f $(APP_TOML) -t string -v "tcp://0.0.0.0:1317"
@dasel put -r toml 'api.enabled-unsafe-cors' -f $(APP_TOML) -t bool -v true
# start-app starts a slinky simulation application binary in the build folder (/test/.slinkyd)
# this will set the environment variable for running locally
start-app:
@./build/slinkyd start --log_level info --home $(HOMEDIR)
# build-and-start-app builds a slinky simulation application binary in the build folder
# and initializes a single validator configuration. If desired, users can supplement
# other addresses using "genesis add-genesis-account address 10000000000000000000000000stake".
# This will allow users to bootstrap their wallet with a balance.
build-and-start-app: build-configs start-app
.PHONY: build-sim-app build-configs build-and-start-app start-app delete-configs
###############################################################################
### Testing ###
###############################################################################
test-integration: tidy e2e-docker-build
@echo "Running integration tests..."
@cd ./tests/integration && go test -p 1 -v -race -timeout 30m
test-petri-integ: tidy e2e-docker-build
@echo "Running petri integration tests..."
@cd ./tests/petri && go test -p 1 -v -race -timeout 30m
test: tidy
@go test -v -race $(shell go list ./... | grep -v tests/)
test-bench: tidy
@go test -count=$(BENCHMARK_ITERS) -benchmem -run notest -bench . ./... | grep Benchmark
test-cover: tidy
@echo Running unit tests and creating coverage report...
@go test -mod=readonly -v -timeout 30m -coverprofile=$(COVER_FILE) -covermode=atomic $(shell go list ./... | grep -v tests/)
@sed -i'.bak' -e '/.pb.go/d' $(COVER_FILE)
@sed -i'.bak' -e '/.pulsar.go/d' $(COVER_FILE)
@sed -i'.bak' -e '/.proto/d' $(COVER_FILE)
@sed -i'.bak' -e '/.pb.gw.go/d' $(COVER_FILE)
@sed -i'.bak' -e '/mocks/d' $(COVER_FILE)
.PHONY: test test-e2e test-petri-integ
###############################################################################
### Protobuf ###
###############################################################################
protoVer=0.17.1
protoImageName=ghcr.io/cosmos/proto-builder:$(protoVer)
protoImage=$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace $(protoImageName)
proto-all: tidy proto-format proto-gen proto-pulsar-gen format
proto-gen:
@echo "Generating Protobuf files"
@$(protoImage) sh ./scripts/protocgen.sh
proto-gen-vendors:
@echo "Generating Vendor Protobuf files"
@$(protoImage) sh ./scripts/protocgen-vendors.sh
proto-pulsar-gen:
@echo "Generating Dep-Inj Protobuf files"
@$(protoImage) sh ./scripts/protocgen-pulsar.sh
proto-format:
@$(protoImage) find ./ -name "*.proto" -exec clang-format -i {} \;
proto-lint:
@$(DOCKER) run --rm -v $(CURDIR)/proto:/workspace --workdir /workspace $(protoImageName) buf lint --error-format=json
proto-check-breaking:
@$(protoImage) buf breaking --against $(HTTPS_GIT)#branch=main
proto-update-deps:
@echo "Updating Protobuf dependencies"
@$(DOCKER) run --rm -v $(CURDIR)/proto:/workspace --workdir /workspace $(protoImageName) buf mod update
.PHONY: proto-all proto-gen proto-pulsar-gen proto-format proto-lint proto-check-breaking proto-update-deps
###############################################################################
### Formatting ###
###############################################################################
tidy:
@go mod tidy
@cd ./tests/integration && go mod tidy
@cd ./tests/petri && go mod tidy
.PHONY: tidy
###############################################################################
### Linting ###
###############################################################################
lint:
@echo "--> Running linter"
@go run github.com/golangci/golangci-lint/cmd/golangci-lint run --out-format=tab
lint-fix:
@echo "--> Running linter"
@go run github.com/golangci/golangci-lint/cmd/golangci-lint run --fix --out-format=tab --issues-exit-code=0
lint-markdown:
@echo "--> Running markdown linter"
@markdownlint **/*.md
govulncheck:
@echo "--> Running govulncheck"
@go run golang.org/x/vuln/cmd/govulncheck -test ./...
.PHONY: lint lint-fix lint-markdown govulncheck
###############################################################################
### Mocks ###
###############################################################################
mocks: gen-mocks format
gen-mocks:
@echo "--> generating mocks"
@go install github.com/vektra/mockery/v2
@go generate ./...
###############################################################################
### Formatting ###
###############################################################################
format:
@find . -name '*.go' -type f -not -path "*.git*" -not -path "*/mocks/*" -not -name '*.pb.go' -not -name '*.pulsar.go' -not -name '*.gw.go' | xargs go run mvdan.cc/gofumpt -w .
@find . -name '*.go' -type f -not -path "*.git*" -not -path "*/mocks/*" -not -name '*.pb.go' -not -name '*.pulsar.go' -not -name '*.gw.go' | xargs go run github.com/client9/misspell/cmd/misspell -w
@find . -name '*.go' -type f -not -path "*.git*" -not -path "/*mocks/*" -not -name '*.pb.go' -not -name '*.pulsar.go' -not -name '*.gw.go' | xargs go run golang.org/x/tools/cmd/goimports -w -local github.com/dydxprotocol/slinky
.PHONY: format
###############################################################################
## Docs ##
###############################################################################
docs:
@if which mintlify > /dev/null 2>&1; then \
echo "Starting Mintlify dev server..."; \
cd docs && mintlify dev; \
else \
echo "Mintlify not found. Install at https://mintlify.com/docs/quickstart"; \
fi
.PHONY: docs