Skip to content

Chore/cleanup wileyj #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 23, 2025
Merged

Chore/cleanup wileyj #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5fc61b7
Create LICENSE
wileyj Sep 22, 2025
6a4c2a6
cleanup
wileyj Sep 22, 2025
1efa987
Cleanup and logically order Makefile targets
wileyj Sep 22, 2025
a2f6848
shellcheck for the miner.sh bitcoin mining script
wileyj Sep 23, 2025
f2e1a97
Apply suggestions from code review
wileyj Sep 23, 2025
fb0f9dd
remove monitor service
wileyj Sep 23, 2025
5288762
Remove extra line breaks between targets
wileyj Sep 23, 2025
ec9022c
reorder readme so the quickstart actually quickstarts
wileyj Sep 23, 2025
01c1551
Cleanup stacking script
BowTiedRadone Sep 23, 2025
eb99ce2
Merge pull request #18 from wileyj/chore/cleanup-radu
wileyj Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
674 changes: 674 additions & 0 deletions LICENSE
View file
Open in desktop

Large diffs are not rendered by default.

130 changes: 65 additions & 65 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# List of binaries devnet needs to function properly
COMMANDS := sudo tar zstd getent stress
$(foreach bin,$(COMMANDS),\
$(if $(shell command -v $(bin) 2> /dev/null),$(info),$(error Missing required dependency: `$(bin)`)))

TARGET := $(firstword $(MAKECMDGOALS))
PARAMS := $(filter-out $(TARGET),$(MAKECMDGOALS))
# Hardcode the chainstate dir if we're booting from genesis
ifeq ($(TARGET),up-genesis)
export CHAINSTATE_DIR := $(PWD)/docker/chainstate/genesis
endif
ifeq ($(TARGET),genesis)
export CHAINSTATE_DIR := $(PWD)/docker/chainstate/genesis
endif


## UID and GID are not currently used, but will be in the near future
# UID and GID are not currently used, but may be later to ensure consistent file permissions
export UID := $(shell getent passwd $$(whoami) | cut -d":" -f 3)
export GID := $(shell getent passwd $$(whoami) | cut -d":" -f 4)
EPOCH := $(shell date +%s)
Expand All @@ -23,6 +23,7 @@ CHAINSTATE_ARCHIVE ?= $(PWD)/docker/chainstate.tar.zstd
export CHAINSTATE_DIR ?= $(PWD)/docker/chainstate/$(EPOCH)
export DOCKER_NETWORK ?= stacks
SERVICES := $(shell CHAINSTATE_DIR="" docker compose -f docker/docker-compose.yml --profile=default config --services)
# Pauses the bitcoin miner script. Default is set to nearly 1 trillion blocks
PAUSE_HEIGHT ?= 999999999999
# Used for the stress testing target. modifies how much cpu to consume for how long
STRESS_CORES ?= $(shell cat /proc/cpuinfo | grep processor | wc -l)
Expand All @@ -43,56 +44,87 @@ $(CHAINSTATE_DIR): /usr/bin/tar /usr/bin/zstd
fi
fi

# Boot the network from the local chainstate archive
# Build the images with a cache if present
build: check-not-running
COMPOSE_BAKE=true PWD=$(PWD) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) build

# Build the images without a cache (default uses cache)
build-no-cache: check-not-running
COMPOSE_BAKE=true PWD=$(PWD) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) build --no-cache

# Set env var of what the statically defined chainstate dir is
current-chainstate-dir: | check-running
$(eval ACTIVE_CHAINSTATE_DIR=$(shell cat .current-chainstate-dir))

# If the network is already running, we need to exit (ex: trying to start the network when it's already running)
check-not-running:
@if test `docker compose ls --filter name=$(PROJECT) -q`; then \
echo ""; \
echo "WARNING: Network appears to be running or was not properly shut down."; \
echo "Current chainstate directory: $$(cat .current-chainstate-dir)"; \
echo ""; \
echo "To shut down: make down"; \
echo ""; \
exit 1; \
fi

# If the network is not running, we need to exit (ex: trying to restart a container)
check-running:
@if test ! `docker compose ls --filter name=$(PROJECT) -q`; then \
echo "Network not running. exiting"; \
exit 1; \
fi

# For targets that need an arg, check that *something* is provided. it not, exit
check-params: | check-running
@if [ ! "$(PARAMS)" ]; then \
echo "No service defined. Exiting"; \
exit 1; \
fi

# Boot the network from a local chainstate archive
up: check-not-running | build $(CHAINSTATE_DIR)
@echo "Starting $(PROJECT) network from chainstate archive"
@echo " Chainstate Dir: $(CHAINSTATE_DIR)"
@echo " Chainstate Archive: $(CHAINSTATE_ARCHIVE)"
echo "$(CHAINSTATE_DIR)" > .current-chainstate-dir
docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) up -d

# Run the network from genesis
# Boot the network from genesis
genesis: check-not-running | build $(CHAINSTATE_DIR) /usr/bin/sudo
@echo "Starting $(PROJECT) network from genesis"
@if [ -d "$(CHAINSTATE_DIR)/logs" ]; then \
@if [ -d "$(CHAINSTATE_DIR)" ]; then \
echo " Removing existing genesis chainstate dir: $(CHAINSTATE_DIR)"; \
rm -rf $(CHAINSTATE_DIR)/logs; \
sudo rm -rf $(CHAINSTATE_DIR); \
fi
@echo " Chainstate Dir: $(CHAINSTATE_DIR)"
mkdir -p "$(CHAINSTATE_DIR)"
echo "$(CHAINSTATE_DIR)" > .current-chainstate-dir
docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) up -d

# secondary name to run genesis network
# Secondary name to boot the genesis network
up-genesis: genesis
# secondary name to bring down genesis network
down-genesis: down

# Shut down the network (chainstate and logs will be preserved, but not logs)
# Shut down the network (chainstate and logs will be preserved)
down: backup-logs current-chainstate-dir
@echo "Shutting down $(PROJECT) network"
docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) down
@if [ -f .current-chainstate-dir ]; then \
rm -f .current-chainstate-dir
fi

# if the network is in a weird state - this target will force kill (bypassing error checks)
# Secondary name to bring down the genesis network
down-genesis: down

# If the network is in an unexpected state - this target will force kill (bypassing error checks)
down-force:
@echo "Force Shutting down $(PROJECT) network"
docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) down
@if [ -f .current-chainstate-dir ]; then \
rm -f .current-chainstate-dir
fi

# Build the images with a cache if present
build: check-not-running
COMPOSE_BAKE=true PWD=$(PWD) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) build

# Build the images without a cache (default uses cache)
build-no-cache: check-not-running
COMPOSE_BAKE=true PWD=$(PWD) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) build --no-cache

# Stream specified service logs to STDOUT. does not validate if PARAMS is supplied
# Stream specified service logs to STDOUT. Does not validate if PARAMS is supplied
log: current-chainstate-dir
@echo "Logs for service $(PARAMS)"
docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) logs -t --no-log-prefix $(PARAMS) -f
Expand All @@ -118,11 +150,7 @@ backup-logs: current-chainstate-dir /usr/bin/sudo
done; \
fi

# set env var of what the statically defined chainstate dir is
current-chainstate-dir: | check-running
$(eval ACTIVE_CHAINSTATE_DIR=$(shell cat .current-chainstate-dir))

# replace the existing chainstate archive. will be used with target `up`
# Replace the existing chainstate archive. Will be used with target `up`
snapshot: current-chainstate-dir down
@echo "Creating $(PROJECT) chainstate snapshot from $(ACTIVE_CHAINSTATE_DIR)"
@if [ -d "$(ACTIVE_CHAINSTATE_DIR)/logs" ]; then \
Expand All @@ -132,85 +160,57 @@ snapshot: current-chainstate-dir down
@echo "cd $(ACTIVE_CHAINSTATE_DIR); sudo tar --zstd -cf $(CHAINSTATE_ARCHIVE) *; cd $(PWD)"
cd $(ACTIVE_CHAINSTATE_DIR); sudo tar --zstd -cf $(CHAINSTATE_ARCHIVE) *; cd $(PWD)

# pause all services in the network (netork is down, but recoverably with target 'unpause')
# Pause all services in the network (netork is down, but recoverably with target 'unpause')
pause:
@echo "Pausing all services"
docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) pause $(SERVICES)

# unpause all services in the network (only used after first using target 'pause')
# Unpause all services in the network (only used after first using target 'pause')
unpause:
@echo "Unpausing all services"
docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) unpause $(SERVICES)

# stop an individual service
# Stop an individual service
stop: check-params current-chainstate-dir | check-running
@echo "Killing service $(PARAMS)"
@echo " Chainstate Dir: $(ACTIVE_CHAINSTATE_DIR)"
@echo " Target: $(TARGET)"
@echo " Params: $(PARAMS)"
CHAINSTATE_DIR=$(ACTIVE_CHAINSTATE_DIR) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) down $(PARAMS)

# start an individual service
# Start an individual service
start: check-params current-chainstate-dir | check-running
@echo "Resuming service $(PARAMS)"
@echo " Chainstate Dir: $(ACTIVE_CHAINSTATE_DIR)"
@echo " Target: $(TARGET)"
@echo " Params: $(PARAMS)"
CHAINSTATE_DIR=$(ACTIVE_CHAINSTATE_DIR) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) up -d $(PARAMS)

# restart a service with a defined servicename/duration. called script will validate PARAMS
# if no duration is provided, default of 30s shall be used
# Restart a service with a defined servicename/duration - the script will validate PARAMS
# If no duration is provided, a default of 30s shall be used
restart: check-params | check-running
@echo "Restarting service"
@echo " Params: $(PARAMS)"
./docker/tests/restart-container.sh $(PARAMS)

# use 'stress' binary to consume defined cpu over a specified time
# Use 'stress' binary to consume defined cpu over a specified time
stress:
@echo "Stressing system CPU $(PARAMS)"
@echo " Cores: $(STRESS_CORES)"
@echo " Timeout: $(STRESS_TIMEOUT)"
stress --cpu $(STRESS_CORES) --timeout $(STRESS_TIMEOUT)

# run the test script to verify the services are all load and operating as expected
# Run the liveness script to verify the services are all loaded and operating as expected
test:
./docker/tests/devnet-liveness.sh

# run the chain monitor script (loops and curls /v2/info, parsing the output to show current heights of miners)
# Run the chain monitor script (loops and curls /v2/info, parsing the output to show current heights of miners)
monitor:
./docker/tests/chain-monitor.sh

# if the network is already running, we need to exit (ex: trying to start the network when it's already running)
check-not-running:
@if test `docker compose ls --filter name=$(PROJECT) -q`; then \
echo ""; \
echo "WARNING: Network appears to be running or was not properly shut down."; \
echo "Current chainstate directory: $$(cat .current-chainstate-dir)"; \
echo ""; \
echo "To backup logs first: make backup-logs"; \
echo "To shut down: make down"; \
echo ""; \
exit 1; \
fi

# if the network is not running, we need to exit (ex: trying to restart a container)
check-running:
@if test ! `docker compose ls --filter name=$(PROJECT) -q`; then \
echo "Network not running. exiting"; \
exit 1; \
fi

# for targets that need an arg, check that *something* is provided. it not, exit
check-params: | check-running
@if [ ! "$(PARAMS)" ]; then \
echo "No service defined. Exiting"; \
exit 1; \
fi

# force stop and remove any existing chainstates (leaving all docker images/layers)
# Force stop and remove any existing chainstates (leaving all docker images/layers)
clean: down-force
sudo rm -rf ./docker/chainstate/*


.PHONY: up genesis up-genesis down-genesis down down-force build build-no-cache log log-all backup-logs current-chainstate-dir snapshot pause unpause stop start restart stress test monitor check-not-running check-running check-params clean
.PHONY: build build-no-cache current-chainstate-dir check-not-running check-running check-params up genesis up-genesis down down-genesis down-force log log-all backup-logs snapshot pause unpause stop start restart stress test monitor clean
.ONESHELL: all-in-one-shell
6 changes: 1 addition & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
# Devnet
Modified from: https://github.com/stacks-sbtc/sbtc/tree/v1.0.2/docker, changes:

- Deleted services related to sBTC, mempool and grafana
- Configured for 3 stacks miners and signers
- bind-mounts a local filesystem for data persistence
- Uses a chainstate archive to boot the network quickly
Expand Down Expand Up @@ -33,11 +30,11 @@ make genesis
```

### Stop the network
*note*: `down-genesis` target calls `down`
```sh
make down
```

## Full list of options
### Logs
`docker logs -f <service>` will work, along with some defined Makefile targets

Expand Down Expand Up @@ -159,7 +156,6 @@ make clean
- **postgres**: postgres DB used by stacks-api
- **stacker**: stack for `stacks-signer-1`, `stacks-signer-2` and `stacks-signer-3`
- **tx-broadcaster**: submits token transfer txs to ensure stacks block production during a sortition
- **monitor**: monitors block details and tracks stacking calls

## Stacks Miner Accounts

Expand Down
Loading