Iron Fish Installation

Recommended Installation

We recommend installing Iron Fish through NPM.

npm install -g ironfish

Note: If you do not have NPM on your system, you may need to install Node.js. We require version 18 - you may also want to check out nvm.

You're all set! Run the Iron Fish CLI:

ironfish

ironfish CLI for running and interacting with an Iron Fish node VERSION ironfish/0.1.62 darwin-arm64 node-v18.12.1 USAGE $ ironfish [COMMAND] TOPICS blocks Show the block header of a requested hash or sequence chain Manage the blockchain config Print out the entire config migrations List all the migration statuses miners Manage an Iron Fish miner peers List all connected peers rpc Show the status of the RPC layer wallet List all the accounts on the node workers Show the status of the worker pool COMMANDS config Print out the entire config faucet Receive coins from the Iron Fish official Faucet fees Get fee distribution for most recent blocks help Display help for ironfish. logs Tail server logs migrations List all the migration statuses peers List all connected peers repl An interactive terminal to the node reset Reset the node to its initial state start Start the node status Show the status of the node stop Stop the node from running testnet Set up your node to mine for the testnet

When new versions are announced, you can update through NPM:

npm install -g ironfish

Iron Fish is now ready to use. Follow the next step of the tutorial or jump directly to the CLI commands list.

Alternative Installation Methods

You can also get started with Iron Fish by using Docker or running from source. If you are using an Intel-based macOS system, we support Homebrew as an alternative installation method.

Using Docker

Run the Docker image from the GitHub registry, mounting the node's data directory into your home directory and using the host network. (Replace <home-directory> with %USERPROFILE% on Windows or $HOME on others)

docker run --rm --tty --interactive --network host --volume <home-directory>/.ironfish:/root/.ironfish ghcr.io/iron-fish/ironfish:latest

Now check the status of your node using IPC, again replacing <home-directory> according to your OS.

docker run --rm --tty --interactive --network host --volume <home-directory>/.ironfish:/root/.ironfish ghcr.io/iron-fish/ironfish:latest status -f

Note: --network host is needed for 2 Docker containers to connect over IPC.

Note: You can also use the RPC layer over TCP by starting your node with --rpc.tcp, which connects over the default port 8020.

Updating

To update your image, use docker pull before running the image.

docker pull ghcr.io/iron-fish/ironfish:latest

From source

First, head over to GitHub to clone our official repository. Once that's done, follow the initial setup steps in the README to install prerequisites, then head to the CLI README to run the CLI.

Homebrew (macOS)

Note: Our Homebrew tap does not yet support M1/arm64. However, you can install Iron Fish directly from the source or use Docker with x86_64 support.

Start by adding our Homebrew tap and installing Iron Fish.

brew tap iron-fish/brew && brew install ironfish

You're all set! Run the Iron Fish CLI:

ironfish

When updates are available, update Brew, then reinstall Iron Fish.

brew update && brew uninstall ironfish && brew install ironfish