Spaceship

Spaceship is an Ignite App designed to extend the Ignite CLI by providing tools to deploy blockchain applications via SSH.

Prerequisites

• Ignite CLI: Version v28.4.0 or higher is required.
• Blockchain Scaffold: A blockchain scaffolded using Ignite

Usage

Spaceship provides multiple ways to connect to your SSH server for deployment:

ignite spaceship deploy [email protected] --key $HOME/.ssh/id_rsa
ignite spaceship deploy 127.0.0.1 --user root --key $HOME/.ssh/id_rsa
ignite spaceship deploy 127.0.0.1 --user root --password password
ignite spaceship deploy [email protected] --key $HOME/.ssh/id_rsa --key-password key_password

Each command initiates a build of the blockchain binary and sets up the chain's home directory based on the configuration. The app then connects to the specified SSH server, establishes workspaces, transfers the binary, and executes it using a runner script. The workspaces are organized under $HOME/workspace/<chain-id> and include:

• Binary Directory: $HOME/workspace/<chain-id>/bin - Contains the chain binary.
• Home Directory: $HOME/workspace/<chain-id>/home - Stores chain data.
• Log Directory: $HOME/workspace/<chain-id>/log - Holds logs of the running chain.
• Runner Script: $HOME/workspace/<chain-id>/run.sh - A script to start the binary in the background using nohup.
• PID File: $HOME/workspace/<chain-id>/spaceship.pid - Stores the PID of the currently running chain instance.

Managing the Chain

To manage your blockchain deployment, use the following commands:

• Check status:

ignite spaceship status [email protected] --key $HOME/.ssh/id_rsa

• View logs:

ignite spaceship log [email protected] --key $HOME/.ssh/id_rsa

• Watch the logs in real time:

ignite spaceship log [email protected] --key $HOME/.ssh/id_rsa --real-time

• Restart the chain:

ignite spaceship restart [email protected] --key $HOME/.ssh/id_rsa

• Stop the Chain:

ignite spaceship stop [email protected] --key $HOME/.ssh/id_rsa

To redeploy the chain on the same server without overwriting the home directory, use the --init-chain flag to reinitialize the chain if necessary.

Config

You can override the default chain configuration by using the Ignite configuration file. Validators' node configuration files are stored in the data directory. By default, Spaceship initializes the chain locally in a temporary folder using the Ignite config file and then copies the configuration to the remote machine at $HOME/workspace/<chain-id>/home. Configuration resets are performed by Ignite when necessary, especially when using the --init-chain flag or if the chain was not previously initialized.

Example Ignite config:

validators:
  - name: alice
    bonded: '100000000stake'
    app:
      pruning: "nothing"
    config:
      moniker: "mychain"
    client:
      output: "json"

For more information, please refer to the Ignite documentation.