The Iron Fish Node App is still under active development, but has not been released yet.
👉 Install the released Iron Fish CLI by (which includes a wallet) by getting started here.
This repo is Electron-based application for running a Iron Fish full node, including a wallet in the Iron Fish network using Iron Fish modules.
🚧 Iron Fish Node App is not released yet and cannot be installed.
These instructions are for setting up the Node App in the case that you want to contribute to it.
The following steps should only be used to install if you are planning on contributing to the Node app codebase.
-
Install Node.js 18.x
-
Install Yarn.
-
Windows:
- Install the current version of Python from the Microsoft Store package or Python website.
- Install Visual C++ Build Environment: Visual Studio Build Tools (using "Visual C++ build tools" or "Desktop development with C++" workload)
If the above steps didn't work for you, please visit Microsoft's Node.js Guidelines for Windows for additional tips.
-
Run
yarn installfrom the root directory to install packages.
Other platform might require additional actions see Iron Fish Developer Install section
Once your environment is set up its possible to run app:
Use yarn start or yarn start:<mode> to run app.
By default dev mode is used, also demo and production modes are available.
To test build use yarn build, there is also 3 mode for build demo, dev, production, dev is default.
Just run yarn package and executable files will be builded into ./out folder.
By default demo mode is used for crating package use production mode to create release version (yarn package:production).
Releases are based on tags. In order to do a release:
Update package.json version, submit a PR and merge it to the master.
Run git tag -a "vX.Y.Z" -m "vX.Y.Z" where X.Y.Z is the major.minor.patch version.
(for demo version release use demo-v prefix instead of v)
Run git push --tags