Examples

The examples section provides information on some examples of how Solo can be used and leveraged.

The usage of examples in Solo

Example Directory	Description
address-book	Example of using Yahcli to pull the ledger and mirror node address book
multicluster-backup-restore	Multi-cluster backup/restore workflow with external PostgreSQL database and distributed consensus nodes
custom-network-config	Deploy a Solo network with custom configuration settings (log4j2, properties, etc.)
external-database-test	Deploy a Solo network with an external PostgreSQL database
hardhat-with-solo	Example of using Hardhat to test a smart contract with a local Solo deployment
local-build-with-custom-config	Example of how to create and manage a custom Hiero Hashgraph Solo deployment using locally built consensus nodes
network-with-block-node	Deploy a Solo network that includes a block node
network-with-domain-names	Setup a network using custom domain names for all components
node-create-transaction	Manually write a NodeCreateTransaction and use the add-prepare/prepare-upgrade/freeze-upgrade/add-execute commands.
node-delete-transaction	Manually write a NodeDeleteTransaction and use the add-prepare/prepare-upgrade/freeze-upgrade/add-execute commands.
node-update-transaction	Manually write a NodeUpdateTransaction and use the add-prepare/prepare-upgrade/freeze-upgrade/add-execute commands.
one-shot-falcon	Example of how to use the Solo one-shot falcon commands
rapid-fire	Example of how to use the Solo rapid-fire commands
state-save-and-restore	Save network state, recreate network, and restore state with mirror node (with optional external database)
version-upgrade-test	Example of how to upgrade all components of a Hiero network to current versions

Accessing Examples

From GitHub Repository

All examples are available in the examples directory of the Solo repository. You can browse the source code, documentation, and configuration files directly on GitHub.

Downloading Example Archives

Pre-packaged example archives are available for download from the Solo releases page. Each example is packaged as a standalone zip file that includes all necessary configuration files and documentation.

To download a specific example:

Visit the Solo releases page
Navigate to the desired release version
Download the example archive (e.g., example-backup-restore-workflow.zip)

Example download URL format:

https://github.com/hiero-ledger/solo/releases/download/<release_version>/example-<example-name>.zip

For example, to download the backup-restore-workflow example from release v0.49.0:

https://github.com/hiero-ledger/solo/releases/download/v0.49.0/example-backup-restore-workflow.zip

After downloading, extract the archive and follow the README instructions inside.

Prerequisites

install taskfile: npm install -g @go-task/cli

Running the examples with Taskfile

cd into the directory under examples that has the Taskfile.yml, e.g. (from solo repo root directory) cd examples/network-with-block-node/
make sure that your current kubeconfig context is pointing to the cluster that you want to deploy to
run task which will do the rest and deploy the network and take care of many of the pre-requisites

NOTES:

Some of these examples are for running against large clusters with a lot of resources available.
Edit the values of the variables as needed.

Customizing the examples

take a look at the Taskfile.yml sitting in the subdirectory for the deployment you want to run
make sure your cluster can handle the number in SOLO_NETWORK_SIZE, if not, then you will have to update that and make it match the number of nodes in the init-containers-values.yaml: hedera.nodes[]
take a look at the init-containers-values.yaml file and make sure the values are correct for your deployment with special attention to:
- resources
- nodeSelector
- tolerations