hiero-solo-action

A GitHub Action for setting up a Hiero Solo network. An overview of the usage and idea of the action can be found here.

The network that is created by the action contains one consensus node that can be accessed at localhost:50211. The action creates an account on the network that contains 10,000,000 hbars. All information about the account is stored as output to the github action.

A good example on how the action is used can be found at the hiero-enterprise project action. Here the action is used to create a temporary network that is than used to execute tests against the network.

Inputs

The GitHub action takes the following inputs:

Input	Required	Default	Description
hbarAmount	false	10000000	Amount of hbars to fund a created account with.
hieroVersion	false	v0.58.10	Hiero consenus node version to use
mirrorNodeVersion	false	v0.133.0	Mirror node version to use
installMirrorNode	false	false	If set to true, the action will install a mirror node in addition to the main node. The mirror node can be accessed at localhost:5551.
mirrorNodePortRest	false	5551	Port for Mirror Node REST API
mirrorNodePortGrpc	false	5600	Port for Mirror Node gRPC
mirrorNodePortWeb3Rest	false	8545	Port for Web3 REST API
installRelay	false	false	If set to true, the action will install the JSON-RPC-Relay as part of the setup process.
relayPort	false	7546	Port for the JSON-RPC-Relay

[! IMPORTANT] The used Solo version isn't compatible with Hiero consenus node versions above v0.58.10. Therefore we recommend to not change hieroVersion.

Outputs

Output	Description
steps.solo.outputs.accountId	The account ID of account created in ED25519 format.
steps.solo.outputs.publicKey	The public key of account created in ED25519 format.
steps.solo.outputs.privateKey	The private key of account created in ED25519 format.
steps.solo.outputs.deployment	The name of the Solo deployment created by the action.
steps.solo.outputs.ecdsaAccountId	The account ID of the account created (in ECDSA format).
steps.solo.outputs.ecdsaPublicKey	The public key of the account created (in ECDSA format).
steps.solo.outputs.ecdsaPrivateKey	The private key of the account created (in ECDSA format).
steps.solo.outputs.ed25519AccountId	Same as accountId, but with an explicit ED25519 format!
steps.solo.outputs.ed25519PublicKey	Same as publicKey, but with an explicit ED25519 format!
steps.solo.outputs.ed25519PrivateKey	Same as privateKey, but with an explicit ED25519 format!

Simple usage

- name: Setup Hiero Solo
  uses: hiero-ledger/[email protected]
  id: solo

- name: Use Hiero Solo
  run: |
    echo "Account ID: ${{ steps.solo.outputs.accountId }}"
    echo "Private Key: ${{ steps.solo.outputs.privateKey }}"
    echo "Public Key: ${{ steps.solo.outputs.publicKey }}"

Usage with ecdsa account format

- name: Setup Hiero Solo
  uses: hiero-ledger/[email protected]
  id: solo

- name: Use Hiero Solo
  run: |
    echo "Account ID: ${{ steps.solo.outputs.ecdsaAccountId }}"
    echo "Private Key: ${{ steps.solo.outputs.ecdsaPrivateKey }}"
    echo "Public Key: ${{ steps.solo.outputs.ecdsaPublicKey }}"

Usage with ED25519 account format

- name: Setup Hiero Solo
  uses: hiero-ledger/[email protected]
  id: solo

- name: Use Hiero Solo
  run: |
    echo "Account ID: ${{ steps.solo.outputs.ed25519AccountId }}"
    echo "Private Key: ${{ steps.solo.outputs.ed25519PrivateKey }}"
    echo "Public Key: ${{ steps.solo.outputs.ed25519PublicKey }}"

Usage with hbarAmount

- name: Setup Hiero Solo
  uses: hiero-ledger/[email protected]
  id: solo
  with:
    hbarAmount: 10000000

- name: Use Hiero Solo
  run: |
    echo "Account ID: ${{ steps.solo.outputs.accountId }}"
    # Display account information including the current amount of HBAR
    solo account get --account-id ${{ steps.solo.outputs.accountId }} --deployment "solo-deployment"

Local Solo Test Network

The README.md describes how to set up a local solo test network only with Docker.

Tributes

This action is based on the work of Hiero Solo. Without the great help of Timo, Nathan, and Lenin this action would not exist.