BM-193: Add make devnet-up and devnet-down (github#31)

We have considered creating a local devnet using Docker. After some
considerations, if the objective of the devnet is to just run in
dev-mode and be available as fast as possible, Docker does not sound as
a good fit; it takes too much to bootstrap a network, mainly to build
the broker.
As an alternative, this PR proposes to use a simple Makefile to spin up
anvil and the broker natively.

Add a `Makefile` to:
- start a local devnet in dev-mode: `make devnet-up`
- stop the local devnet: `make devnet-down`

---------

Co-authored-by: zeroecco <[email protected]>

Author: capossele

.gitignore

@@ -8,6 +8,9 @@ out/
 /broadcast/*/11155111/
 /broadcast/**/dry-run/
 
+# Devnet logs
+/logs
+
 # Dotenv file
 # .env
 

Makefile

@@ -0,0 +1,73 @@
+.POSIX:
+.SILENT:
+
+.PHONY: devnet-up devnet-down check-deps clean all
+
+# Variables
+ANVIL_PORT = 8545
+ANVIL_BLOCK_TIME = 2
+RISC0_DEV_MODE = 1
+RUST_LOG = info,broker=debug,boundless_market=debug
+PRIV_KEY = 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+DEPOSIT_AMOUNT = 10
+
+LOGS_DIR = logs
+PID_FILE = $(LOGS_DIR)/devnet.pid
+
+all: devnet-up
+
+# Check that required dependencies are installed
+check-deps:
+	for cmd in forge cargo anvil jq; do \
+		command -v $$cmd >/dev/null 2>&1 || { echo "Error: $$cmd is not installed."; exit 1; }; \
+	done
+
+devnet-up: check-deps
+	mkdir -p $(LOGS_DIR)
+	echo "Building contracts..."
+	forge build || { echo "Failed to build contracts"; $(MAKE) devnet-down; exit 1; }
+	echo "Building Rust project..."
+	cargo build --bin broker || { echo "Failed to build broker binary"; $(MAKE) devnet-down; exit 1; }
+	echo "Starting Anvil..."
+	anvil -b $(ANVIL_BLOCK_TIME) > $(LOGS_DIR)/anvil.txt 2>&1 & echo $$! >> $(PID_FILE)
+	sleep 5
+	echo "Deploying contracts..."
+	RISC0_DEV_MODE=$(RISC0_DEV_MODE) forge script contracts/scripts/Deploy.s.sol --rpc-url http://localhost:$(ANVIL_PORT) --broadcast -vv || { echo "Failed to deploy contracts"; $(MAKE) devnet-down; exit 1; }
+	echo "Fetching contract addresses..."
+	{ \
+		SET_VERIFIER_ADDRESS=$$(jq -re '.transactions[] | select(.contractName == "RiscZeroSetVerifier") | .contractAddress' ./broadcast/Deploy.s.sol/31337/run-latest.json); \
+		PROOF_MARKET_ADDRESS=$$(jq -re '.transactions[] | select(.contractName == "ProofMarket") | .contractAddress' ./broadcast/Deploy.s.sol/31337/run-latest.json); \
+		echo "Contract deployed at addresses:"; \
+		echo "SET_VERIFIER_ADDRESS=$$SET_VERIFIER_ADDRESS"; \
+		echo "PROOF_MARKET_ADDRESS=$$PROOF_MARKET_ADDRESS"; \
+		echo "Updating .env file..."; \
+		sed -i.bak "s/^SET_VERIFIER_ADDRESS=.*/SET_VERIFIER_ADDRESS=$$SET_VERIFIER_ADDRESS/" .env && \
+		sed -i.bak "s/^PROOF_MARKET_ADDRESS=.*/PROOF_MARKET_ADDRESS=$$PROOF_MARKET_ADDRESS/" .env && \
+		rm .env.bak; \
+		echo ".env file updated successfully."; \
+		echo "Starting Broker service..."; \
+		RISC0_DEV_MODE=$(RISC0_DEV_MODE) RUST_LOG=$(RUST_LOG) ./target/debug/broker \
+			--priv-key $(PRIV_KEY) \
+			--proof-market-addr $$PROOF_MARKET_ADDRESS \
+			--set-verifier-addr $$SET_VERIFIER_ADDRESS \
+			--deposit-amount $(DEPOSIT_AMOUNT) > $(LOGS_DIR)/broker.txt 2>&1 & echo $$! >> $(PID_FILE); \
+	} || { echo "Failed to fetch addresses or start broker"; $(MAKE) devnet-down; exit 1; }
+	echo "Devnet is up and running!"
+	echo "Make sure to run 'source .env' to load the environment variables."
+
+devnet-down:
+	echo "Bringing down all services..."
+	if [ -f $(PID_FILE) ]; then \
+		while read pid; do \
+			kill $$pid 2>/dev/null || true; \
+		done < $(PID_FILE); \
+		rm $(PID_FILE); \
+	fi
+	echo "Devnet stopped."
+
+clean: devnet-down
+	echo "Cleaning up..."
+	rm -rf $(LOGS_DIR) ./broadcast
+	cargo clean
+	forge clean
+	echo "Cleanup complete."

docs/src/market/local-development.md

@@ -11,6 +11,38 @@ Before starting, ensure you have cloned with recursive submodules, or pull them
 git submodule update --init
 ```
 
+1. Start a local devnet
+   ```console
+   make devnet-up
+   source .env
+   ```
+
+2. Test your deployment with the client CLI.
+   You can read more about the client on the [proving request][page-requestor-request] page.
+
+   ```console
+   RISC0_DEV_MODE=1 RUST_LOG=info,boundless_market=debug cargo run --bin cli -- submit-request request.yaml --wait
+   ```
+
+   > If you see "Error: Market error: Failed to check fulfillment status",
+   > check the deployment logs from running `forge script` and ensure it matches the addresses listed in `.env`
+   > If they don't match, adjust the `.env` file or try restarting anvil and deploying again.
+
+Congratulations! You now have a local devnet running and a prover that will respond to proving requests.
+
+3. To tear down the local devnet run:
+
+   ```console
+   make devnet-down
+   ```
+
+Check out the is-even example in the [Boundless Foundry template][boundless-foundry-template] for an example of how to run and application using the prover market.
+
+You can also try editing `request.yaml` to send a request with different values.
+Check `cargo run --bin cli -- --help` for a full list of commands available through the CLI.
+
+If instead you prefer setting up a local devnet step by step, you can run the following commands as an alternative to the Makefile:
+
 1. Build the contracts
 
    ```console
@@ -74,10 +106,11 @@ git submodule update --init
 
 Congratulations! You now have a local devnet running and a prover that will respond to proving requests.
 
-Check out the is-even example in the [Boundless Foundry template](https://github.com/boundless-xyz/boundless-foundry-template/)for an example of how to run and application using the prover market.
+Check out the is-even example in the [Boundless Foundry template][boundless-foundry-template] for an example of how to run and application using the prover market.
 
 You can also try editing `request.yaml` to send a request with different values.
 Check `cargo run --bin cli -- --help` for a full list of commands available through the CLI.
 
 [page-bento-running]: ../prover-manual/bento/running_bento.md
 [page-requestor-request]: ../requestor-manual/broadcasting.md
+[boundless-foundry-template]: https://github.com/boundless-xyz/boundless-foundry-template/