Merge #4124

4124: Modify Localnet image-build behaviour, update documentation r=jordanschalm a=jordanschalm

The original default behaviour for Localnet was to always re-build all images, every time a new network was started. At some point, this default behaviour changed, so that images are not re-built, but the documentation was not updated.

This diff:
- changes default behaviour back to build images each time localnet is started (original behaviour: trade-speed-for-safety)
- adds option (make start-cached etc) to start without building images (current behaviour: trade-safety-for-speed)
- updates the documentation

Co-authored-by: Jordan Schalm <[email protected]>

Author: bors[bot]

integration/localnet/Makefile

@@ -83,18 +83,30 @@ bootstrap-ci:
 bootstrap-short-epochs:
 	$(MAKE) -e EPOCHLEN=200 STAKINGLEN=10 DKGLEN=50 bootstrap
 
+# Starts the network - must have been bootstrapped first. Builds fresh images.
 .PHONY: start
 start: start-metrics start-flow
 
+# Starts the network, using the most recently built images.
+# Useful for rapid iteration, when no code has changed or only one images needs to be re-built.
+.PHONY: start-cached
+start-cached: start-metrics start-flow-cached
+
 # Starts metrics services
 .PHONY: start-metrics
 start-metrics:
 	DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose -f docker-compose.metrics.yml up -d
 
-# Starts a version of localnet with just flow nodes and without metrics services. This prevents port collision and consumption
-# when these services are not needed.
+# Starts a version of localnet with just flow nodes and without metrics services.
+# This prevents port collision and consumption when these services are not needed.
+# All images are re-built prior to being started.
 .PHONY: start-flow
 start-flow:
+	DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose -f docker-compose.nodes.yml up -d --build
+
+# Same as start-flow, but most recently built images are used.
+.PHONY: start-flow-cached
+start-flow-cached:
 	DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose -f docker-compose.nodes.yml up -d
 
 .PHONY: build-flow

integration/localnet/README.md

@@ -74,6 +74,12 @@ and then start the test network:
 make start
 ```
 
+Alternatively, this command will start the test network without re-building, using the most recently built image.
+```shell
+make start-cached
+```
+
+
 ## Stop the network
 
 The network needs to be stopped between each consecutive run to clear the chain state:
@@ -82,6 +88,13 @@ The network needs to be stopped between each consecutive run to clear the chain
 make stop
 ```
 
+## Build Localnet images
+
+To build images for Localnet, run this command.
+```shell
+make build-flow
+```
+
 ## Logs
 
 You can view log output from all nodes:

integration/localnet/bootstrap.go

@@ -164,7 +164,8 @@ func main() {
 	displayPortAssignments()
 	fmt.Println()
 
-	fmt.Print("Run \"make start\" to launch the network.\n")
+	fmt.Println("Run \"make start\" to re-build images and launch the network.")
+	fmt.Println("Run \"make start-cached\" to launch the network without rebuilding images")
 }
 
 func displayFlowNetworkConf(flowNetworkConf testnet.NetworkConfig) {

state/protocol/badger/validity.go

@@ -290,7 +290,7 @@ func IsValidRootSnapshotQCs(snap protocol.Snapshot) error {
 		}
 		err = validateClusterQC(cluster)
 		if err != nil {
-			return fmt.Errorf("invalid cluster qc %d: %W", clusterIndex, err)
+			return fmt.Errorf("invalid cluster qc %d: %w", clusterIndex, err)
 		}
 	}
 	return nil