Getting Started

Getting started with Solo

[!WARNING]

Any version of Solo prior to v0.35.3 will fail on Apple M3/M4 chipsets due to a known issue with Java 21 and these chipsets.

Solo

NPM Version GitHub License node-lts Build Application Codacy Grade Codacy Coverage codecov

An opinionated CLI tool to deploy and manage standalone test networks.

Requirements

Solo VersionNode.jsKindSolo ChartHederaKubernetesKubectlHelmk9sDocker Resources
0.29.0>= 20.14.0 (lts/hydrogen)>= v1.29.1v0.30.0v0.53.0 – <= v0.57.0>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.30.0>= 20.14.0 (lts/hydrogen)>= v1.29.1v0.30.0v0.54.0 – <= v0.57.0>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.31.4>= 20.18.0 (lts/iron)>= v1.29.1v0.31.4v0.54.0 – <= v0.57.0>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.32.0>= 20.18.0 (lts/iron)>= v1.29.1v0.38.2v0.58.1 - <= v0.59.0>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.33.0>= 20.18.0 (lts/iron)>= v1.29.1v0.38.2v0.58.1 - <= v0.59.0>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.34.0>= 20.18.0 (lts/iron)>= v1.29.1v0.42.10v0.58.1+>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.35.0>= 20.18.0 (lts/iron)>= v1.29.1v0.44.0v0.58.1+>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.36.0>= 20.18.0 (lts/iron)>= v1.29.1v0.52.0v0.58.1+>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.36.1>= 20.18.0 (lts/iron)>= v1.29.1v0.53.0v0.58.1+>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.37.0>= 20.18.0 (lts/iron)>= v1.29.1v0.53.0v0.58.1+>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.37.1>= 20.18.0 (lts/iron)>= v1.29.1v0.53.0v0.58.1+>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4
0.38.0>= 20.18.0 (lts/iron)>= v1.29.1v0.54.3v0.58.1+>= v1.27.3>= v1.27.3v3.14.2>= v0.27.4Memory >= 8GB, CPU >= 4

Hardware Requirements

To run a three-node network, you will need to set up Docker Desktop with at least 8GB of memory and 4 CPUs.

alt text

Setup

  • Install Node. You may also use nvm to manage different Node versions locally, some examples:
# install specific nodejs version
# nvm install <version>

# install nodejs version 20.18.0
nvm install v20.18.0

# lists available node versions already installed
nvm ls

# switch to selected node version
# nvm use <version>
nvm use v20.18.0

Install Solo

  • Run npm install -g @hashgraph/solo

Documentation

Getting Started

Contributing

Contributions are welcome. Please see the contributing guide to see how you can get involved.

Code of Conduct

This project is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code of conduct.

License

Apache License 2.0