icon picker
Get Started With Iron Fish

Special thanks to Product Guy for putting this together!

Overview and Table of Contents:

1. Announcements

Testnet Phase 2 Started just after noon PDT US Time Tues 10 May, = 1900 UTC.

- Phase 2 Overview: we will reward people for: - Finding bugs - Contributing to our code base - Running a node - Sending IRON in transactions, which will require mining to get the IRON

How can I get news?

Follow Discord channel
Monthly Pulse audio calls are held on the 2nd Friday of each month at 12:00 PM US Pacific Daylight Time (PDT = California) = 19:00 UTC
Next one is May 13
See the 1 Event at the top of the Discord channel list
How to get notified about Phase 2 and releases

We've deployed Iron Fish v0.1.32!
This is a mandatory release for participating in the Phase 2 testnet. It breaks backward compatibility with older versions. If you'd like to back up your accounts, please do so before upgrading to this version.
Export command: ironfish accounts:export <accountname> <filename> Example: ironfish accounts:export default default
After updating, you should run ironfish reset to clear your local data.
See below
You may also need to create a new account with ironfish accounts:create
Info and sign-up page for Testnet Phase 2 has been posted, see
Please read Phase 2 FAQs here:


2. Sign up for the Testnet

Q. What should I put for my Graffiti?
A. It doesn't matter. It's like a nickname or label.
The graffiti is how we credit you for mined blocks. Your node/miner must use it.
You could use your Discord handle, or something completely different, unique to you.
Maximum graffiti length is 32 chars.
The registration page checks that your graffiti is unique.
Q. How can I verify my registration and graffiti?
A. Log into the . Search for your graffiti, click into your line, view your individual page.
Tip: you can bookmark your Leaderboard page (ending in your user ID number) to easily see your points

3. Install Iron Fish

CPU mining only, no GPU required
There are installation options for:
Native on Intel Mac via Homebrew
Docker on Windows or Linux
From source code on Windows, Linux, or Mac M1
Via Git client, or
Download and unzip source files

4. Configure your node to use your blockGraffiti from your Testnet registration

Setting your graffiti in the node is very important
Without it, blocks you mine will not be credited to you, and cannot be retroactively added.
Your blocks are permanently stored into the blockchain with graffiti setting in your node's configuration when the block is mined.
Run ironfish testnet in a terminal window
If you installed from source, cd to the ironfish-cli directory and run yarn start:once ironfish testnet
The User ID it is asking you for is the URL to your testnet user, like https://testnet.ironfish.network/users/1080
Q. How can I find my User ID?
A. Find your user ID by searching for your blockGraffiti in the and clicking into your line
Q. How can I check that my graffiti was set correctly in my node?
A. View it by running ironfish config:show from a terminal window
If you , you will run Ironfish commands by typing yarn start:once <command> instead of ironfish <command>
From a terminal window, cd to the ironfish-cli directory
On Windows, this is usually at C:\Users\<username>\Source\ironfish-cli
On Linux, it's usually at ~\Source\ironfish-cli
Example command: yarn start:once config:show
Yarn Command Reference: (yarn start format)

5. Start your Node process and wait for sync to complete

Type one of these in a terminal window:
Mac: ironfish start
If installed from source: yarn start start
Once started, a new node will sync with the blockchain for at least 2 hours, up to several hours
Log messages will show the percent of syncing
You can check status of your node in a separate terminal window with the command ironfish status -f
After initial sync, if you stop and re-start your node, it will sync up within seconds or minutes

6. Start Mining - you can mine solo or in a pool

Solo mining (same as Phase 1).
After sync is complete, you can start a miner process in another terminal window:
ironfish miners:start -t Nwhere N is the number of mining threads you want to run.
Maximize mining power withironfish miners:start -t -1
"-1" means "all possible threads", like 16 threads on an 8-core, 16-hyperthread CPU
Reserve some CPU power for other activities by using a positive numberless than 2xthe number of CPU cores.
ironfish miners:start -t 24would use 24 threads (3/4 of total capacity) on a 16-core, 32-hyperthread CPU
You may want to reserve 1 thread for node & communications (for example start 15 threads on an 8-core CPU)
NEW: Default view no longer shows hashrate updating every few seconds. It shows this once:
Listening to node for new blocks
Then it shows updates only when you win a block:
Found block: 0000000006189501 3528 55.02 MH/s
Block submitted successfully! 55.02 MH/s
If you want to see hashrate displayed continuously, add-vin the string.
Example:ironfish miners:start -t -1 -v
NEW: Mining Pool support is now native in Iron Fish (Use ver 0.1.31 = current as of 9may22)
You can start your own pool, or participate in the main Iron Fish pool.
Pool participants receive fractions of mined testnet IRON coins based on their proportion of pool hashpower.
Pool mining benefit: no duplicate work for multiple mining machines or miner instances on high-core-count CPUs
Main Iron Fish pool is a good option for small miners (e.g. 1-2 machines).
- Ask questions in

General mining pool recommendations

There are 2 options to participate in pool: your own pool where you can add all your machines to pool. The other option is to participate in the official Ironfish pool.
Your own local pool:
First of all you need to run Ironfish node on your main machine and wait for full synchronization. Look at
Next step is to run mining pool with no payouts (since you are running only your machines). Use this command to set up pool:
ironfish miners:pools:start --no-payouts
Now you are almost done and can make connection to your pool from every machine you have:
ironfish miners:start -p <ip-address-of-your-node> -a <account-public-address>
you can find your account-public-address by typing ironfish accounts:publickey in another terminal window.
Copy the long string of numbers that's returned afterAccount: default, public key:
Enter it into the miners:start command above.
Reminder: If your machines are located in different networks you have to forward9034port with firewall (e.g. UFW).
Official Ironfish Pool
If you want to connect to the official pool you don't need to run your own node, just create account and start miner with this command:
ironfish miners:start -p pool.ironfish.network -a <account-public-address>

9. Updating Iron Fish

If you installed Iron Fish using the new command `npm -g install ironfish', run it again to update.
Run all commands from the root (top-level) Iron Fish directory. If you are unsure, if you dolsordir, you should see files likeCODE_OF_CONDUCT.mdandCONTRIBUTING.md
Update your local code from GitHub (example using gitcli, whatever method you got the code from GitHub originally should work)
git fetch
git pull --ff-only
yarn clean
yarn install
yarn build
If for some reason the first 2 git commands fail, or you are unsure, you can always delete the folder and download from GitHub again, following the instructions from the README.

10. References:

Command References:
(ironfish <command> format)
Yarn start Command Reference:

11. Resources

Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
) instead.