Running Devnet with custom stacks node and signer Docker image

[hugo-stacks]

Clarinet runs Devnet with specific tags for each Docker image. For example, Clarinet v3.10.0 uses the following images:

• stacks node: blockstack/stacks-blockchain:3.3.0.0.1-alpine
• stacks signer: blockstack/stacks-signer:3.3.0.0.1.0-alpine

We recommend Devnet users let Clarinet handle it and use the default version. This ensures that your Clarinet version can handle and properly configure the images it uses.

In some cases, you may need to use other images. Clarinet lets you do this by configuring it in settings/Devnet.toml.
For example, if you don't want to run the alpine images:

# setting/Devnet.toml
[network]
name = "devnet"
deployment_fee_rate = 10

# ...

[devnet]
stacks_node_image_url = "blockstack/stacks-blockchain:3.3.0.0.1"
stacks_signer_image_url = "blockstack/stacks-signer:3.3.0.0.1.0"

Using a local image

You can build an image locally and use it.

• Clone the stacks-core repository (or a fork) and checkout the desired branch.

git clone git@github.com:stacks-network/stacks-core.git
cd stacks-core
git checkout develop

• Build the Docker image stacks-node:local:

docker build -t stacks-node:local -f ./Dockerfile ./

• Clarinet needs the image to be available in a registry. You can host a local one and push the image to it.

docker run -d -e REGISTRY_HTTP_ADDR=0.0.0.0:5001 -p 5001:5001 --name registry registry:2
docker tag stacks-node:local localhost:5001/stacks-node:local
docker push localhost:5001/stacks-node:local

Use the image in a Clarinet project

Set the image to be used:

# setting/Devnet.toml
[network]
name = "devnet"
deployment_fee_rate = 10

# ...

[devnet]
stacks_node_image_url = "localhost:5001/stacks-node:local"

Then start Devnet:

clarinet devnet start