第一种安装方法（推荐安装）

我们建议通过NPM安装 Iron Fish 。

npm install -g ironfish

注意：如果您的系统上没有 NPM，您可能需要安装Node.js。（网址：nodejs.org/en/download）我们至少需要 16.0.0 版本。

你都准备好了！运行 Iron Fish CLI：

ironfish

$ironfish

Command line Iron Fish node

VERSION

  ironfish-cli/0.0.0 darwin-x64 node-v12.18.4 

USAGE  

$ ironfish [COMMAND] 

TOPICS

 accounts  Create and delete accounts  

chain     Manage the blockchain  

config    Show and edit the node configuration  

faucet    Get coins to start using Iron Fish  

miners    Manage an Iron Fish miner  

peers     Manage the peers connected to this node 

COMMANDS  

help    display help for ironfish  

logs    Tail server logs  

start  Start the node  

status  Show the status of the node 

 stop    Stop the node from running

铁鱼现在可以使用了。按照教程的下一步或直接跳转到CLI 命令列表(文章尾页部分)。

第二种安装方法

您还可以通过使用 Docker 或从源代码运行来开始使用 Iron Fish。如果您使用的是基于 Intel 的 macOS 系统，我们支持 Homebrew 作为替代安装方法。

使用 Docker 

从 GitHub 注册表运行 Docker 映像，将节点的数据目录挂载到您的主目录并使用主机网络。（在 Windows 或其他设备上替换<home-directory>为）%USERPROFILE%$HOME

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

现在使用 IPC 检查节点的状态，再次<home-directory>根据您的操作系统进行替换。

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

注意： --network host需要 2 个 Docker 容器通过 IPC 连接。

注意：您还可以通过使用 启动节点来使用 TCP 上的 RPC 层--rpc.tcp，该节点通过默认端口 8020 连接。

更新

要更新您的映像，请docker pull在运行映像之前使用。

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

来自源

首先，前往 GitHub 克隆我们的官方存储库。完成后，按照自述文件中的初始设置步骤安装先决条件，然后前往CLI 自述文件以运行 CLI。

自制 (macOS) 

注意：我们的 Homebrew tap 还不支持M1/arm64。但是，您可以直接从源安装 Iron Fish或使用支持的Dockerx86_64。

首先添加我们的 Homebrew 水龙头并安装 Iron Fish。

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

你都准备好了！运行 Iron Fish CLI：

ironfish

当更新可用时，更新 Brew，然后重新安装 Iron Fish。

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

启动一个新节点

启动节点

运行 Iron Fish CLI

ironfish start

$ironfish start(注意先输入这个命令然后enter，开始启动，文字请删掉)

 :::::::::::::::::::::::::::::::::::::::::::::::: ::::::::::::::::::::::::::::::::::::::::::::::: ::::::::::::::::::::::::::::::::::::::::::::::: ::: ::::::::: ::::::::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::::::::::::::::::: ::::: :::::::::::::::::::::::::::::::::::::::::::: :::::: ::::::::::::::::::::: :::::::::::::::::::::: ::::::::::::::::::::::::::::::::: Peer Identity ms1kEwERcvP4bzn8TtcmffSBHrlQfn9izdW2KlmLXiA= Peer Version ironfish-sdk/2/cli Port 9033 Bootstrap test.bn1.ironfish.network Serving RPC on IPC /Users/username/.ironfish/ironfish.ipc ############ ################################################# ### # 感谢您安装 Iron Fish 节点。# # 为了帮助改进 Ironfish，请选择收集遥测数据 # # 通过在配置文件中设置 telemetry=true ########################## ####################################### 

新创建的默认账户：默认账户的公共地址：ec7d8422f70b5449a5aabb18c9507b1875b6ec49b8ada1ba991ca09900c1c3b1c7b282a7b93866be02109d      

初始化区块链... 

创世区块创建成功 

WebSocket 服务器开始于 :::9033

连接到 Iron Fish 网络

使用不同的目录

默认情况下，Iron Fish 节点的数据库和配置文件在~/.ironfish目录中创建（更多详细信息在配置部分）。您可以使用该--datadir标志为数据库和配置文件使用不同的目录。

例如

ironfish start --datadir=~/myCustomFolder

使用不同的引导节点

默认情况下，您的节点将连接到官方 Iron Fish 引导节点。如果您正在开发并想要使用不同的引导节点，您可以使用--bootstrap标志使节点连接到不同的地址。

不要使用未经 Iron Fish 官方认可的生产引导节点，您可能最终会进入恶意网络。

例如

ironfish start--bootstrap=localhost:9031

使用不同的端口

默认情况下，Iron Fish 在端口 9033 上运行。如果您希望使用其他端口，可以使用该--port标志。

例如

ironfish start --port=9045

下一步

该节点现在将您的本地链与网络同步。完全同步可能需要一段时间才能完成。但在此期间您仍然可以使用该节点。

创建一个帐户

创建一个新帐户

默认情况下，第一次启动节点时会创建一个帐户。但是您可以随时使用以下命令创建新帐户：

ironfish accounts：create

$ironfish accounts：create

Enter the name of the account: MyNewAccounts 

Creating account MyNewAccount 

Account MyNewAccount saved to /Users/username/.ironfishtodelete/accounts.json Public address: 6a085865ac5608c8ec64189db54d4b5c085da9da12dad0a0bf00f60e52c16b0303d8a8dd7d82601f577c8d 

Run "ironfish accounts:use MyNewAccount" to set the account as default

将帐户设置为默认

当您有多个帐户时，您可以向 CLI 指示要使用哪个帐户：

ironfisha accounts：use MyNewAccount

下一步

您可以在本节中了解不同的帐户命令。现在您已经创建了一个帐户，您可以使用它来获取硬币或开始挖矿。

交易

您的节点不必与发送方同时运行即可发送或接收交易。

发送交易

交互模式

通过使用您的默认帐户运行以下命令来发送交易：

‍ironfish accounts:pay

$ironfish accounts:pay

Enter the amount in $IORN(balance available:$IRON 200)20

Enter the fee amount in $IRON 0.00000001

Enter the the public address of the recipient:

ab518b8c908d7157eaebdf8159c5813894074d3136826daba4a485598de1b86a597af2821f8400bbfe70c1

You are about to send:

$IRON 20 to 

ab518b8c908d7157eaebdf8159c5813894074d3136826daba4a485598de1b86a597af2821f8400bbfe70c1 from the account IronFishGenesisAccount 

* This action is NOT reversible *

Do you confirm(Y/N)?: Y

Creating the transaction:

████████████████████████████████████████ 100%

Sending 20 to ab518b8c908d7157eaebdf8159c5813894074d3136826daba4a485598de1b86a597af2821f8400bbfe70c1 from MyNewAccount 

Transaction Hash: e032e78268a1097288503e18510e48d140292ff5ce91d0914ae00f733ad8d166 Transaction Fee: 0.00000001

Find the transaction on 

如果你想从不同的账户发送交易，你可以使用 `-f` 标志。

例如

ironfish accounts：pay -f MyOtherAccount

非交互模式

运行ironfish accounts:pay --help以查看可用的不同选项。

例如从账户发送 2 个硬币Savings

ironfish accounts：pay -a 2 -o 0.00000001 -t 997c...7fc52ed -f Savings

接收交易

要接收交易，您只需将您帐户的公钥传达给发件人。如果您不知道您的公钥，请运行以下命令：

ironfish accounts：publickey

例如，在您的节点上获取不同帐户的公钥

ironfish accounts：publickey -a Savings

余额

您可以通过运行以下命令随时查看余额：

ironfish accounts：balance

下一步

您现在可以在网络上跟踪您的交易，或开始挖掘 $IRON。

跟踪 $IRON 交易

执行交易后，CLI 上会显示带有交易哈希的确认消息。

例如:

Transaction Hash:e032e78268a1097288503e18510e48d140292ff5ce91d0914ae00f733ad8d166

您可以使用Iron Fish Block Explorer显示有关此交易的信息。当然，由于 Iron Fish 是一种完全私有的加密货币，因此公众实际上可以获得有限的信息。

挖矿

矿工对 Iron Fish 网络的健康至关重要。没有它们，就不会生成区块，也不会传输交易。Iron Fish 仍处于测试网阶段。

我们目前正在运行一个激励测试网，您可以在其中通过挖掘区块和为网络做出贡献来赚取积分。要参与，请访问我们的测试网网站以了解更多信息。

快速开始

通过运行以下命令启动您的节点：

ironfish start

打开一个新的终端窗口并运行：

ironfish miners:start

更改默认帐户

如果您想使用不同的账户来存储矿工费，您可以通过运行以下命令创建一个新账户：

iornfish accounts：create newAccount

然后将其设置为默认值：

iornfish accounts：use newAccount

设置块涂鸦（可选）

Iron Fish 区块包含一个 32 字节的公开可见字段graffiti，称为可由区块的矿工设置。要将此值设置为您挖掘的块上的 UTF-8 编码字符串，请更新blockGraffiti配置选项：

ironfish config:set blockGraffiti "<your graffiti here>"

加入矿池

您可以加入矿池以增加开采区块的机会。区块奖励通常根据矿工各自的贡献在矿工之间进行分配。我们还运行一个任何人都可以加入的基本矿池。首先，检索您要使用的帐户的公钥：

iornfish accounts：publickey

并使用该公钥加入矿池：

ironfish miners：start --pool pool.ironfish.network --address <publickey>

故障排除

我的矿工已经运行了很长时间 - 但我还没有挖出一个区块

·难度（以及挖掘区块的时间）可能会根据 Iron Fish 网络上区块的开采速度而变化。

·确保您已正确连接到 Iron Fish 网络（您应该Connected to the Iron Fish network在节点日志中看到）。

未连接到节点 - 重试前等待 5 秒

确保您的节点当前正在运行。如果您使用不同的datadir参数来启动节点，请确保在启动矿工时也使用它。例如：

ironfish miners：start --datadir=~./ironfish2/

树的大小与链条的大小不同

·在启动矿工之前，请确保您的节点与网络同步。运行ironfish status以检查您的节点是否仍在同步。

节点的运行状况

状态

运行 status 命令以显示节点的状态。

ironfish status -f

节点

该节点可以具有以下状态：

块同步器

块同步器可以具有以下状态：

最重的头

最重的头表示本地节点上的链头。它每 15 秒更改一次。

P2P网络

P2P 网络可以有以下状态：

$ironfish status

Node: STARTED 

Blocks syncing: SYNCING - 268 / 13802 blocks @ 20.73blocks per seconds 

Heaviest head: 00000894D09B1016B4A982415FC7EAA0C6982919CBCD997277C74E7BB9B3B421 P2P Network: CONNECTED In: 180 KB/s, Out: 160 B/s

链信息

运行以下命令以显示您的链状态。最重的头是同步到链中创世块的最新块。最新头是从 Iron Fish 网络中的对等点收到的最新块。

ironfish chain:show

$ironfish chain:show

Getting the chain blocks...

======

TAIL 

f6801b559c46aaee1bc94398c353f6b2bdabe50a44664a703b165cb0be6a7d26 

HEAVIEST 0000278c762f231f326b981b517b0b34320ba8011945220e4da1e43101a99a57 

LATEST 0000278c762f231f326b981b517b0b34320ba8011945220e4da1e43101a99a57 

TREES OKAY?

TRUE

+- Block f6801...a7d26 (1 seq, work: 131072) TAIL GENESIS 

+- Block 00003...a62ca (2 seq, work: 262144) 

+- Block 00005...863b9 (3 seq, work: 393280) 

+- Block 00004...efa6e (4 seq, work: 524480) 

+- Block 00004...3554b (5 seq, work: 655744) 

+- Block 00006...3d053 (6 seq, work: 787072) 

+- Block 00002...9ec82 (7 seq, work: 918464)

+- Block 00004...cfd82 (8 seq, work: 1049920)

+- Block 00005...96c9c (9 seq, work: 1181440) 

+- Block 00000...fa3a7 (10 seq, work: 1313024) 

+- Block 00005...c3b97 (11 seq, work: 1444672) 

+- Block 00007...b49a9 (12 seq, work: 1576384) 

+- Block 00007...53332 (13 seq, work: 1708160) 

+- Block 00005...7535a (13 seq, work: 1708160)

+- Block 00003...6d423 (14 seq, work: 1840000)

| +- Block 00003...21e8e (15 seq, work: 1971904) 

+- Block 00003...af531 (14 seq, work: 1840000) 

+- Block 00002...f8b86 (15 seq, work: 1971904) 

+- Block 00006...7457e (16 seq, work: 2103872)

| +- Block 00000...cf403 (17 seq, work: 2235904)

| +- Block 00007...9321c (18 seq, work: 2368000) 

| +- Block 00002...42725 (19 seq, work: 2500160)

| +- Block 00006...4b38a (20 seq, work: 2632384)

| +- Block 00007...92895 (21 seq, work: 2764672)

| +- Block 00006...4f07d (22 seq, work: 2897024)

| +- Block 00001...f2fa4 (23 seq, work: 3029440)

| | +- Block 00001...3177a (24 seq, work: 3161920)

| | +- Block 00002...99a57 (25 seq, work: 3294464) LATEST HEAVY 

| +- Block 00005...f594e (23 seq, work: 3029440) 

+- Block 00007...b3f27 (16 seq, work: 2103872)

同行信息

要查看您的节点如何连接到网络，您可以运行以下命令

ironfish peers：list -f

对等点可以具有以下状态：

$ironfish peers：list

IDENTITY                                     STATE             ADDRESS 1fkrpde0NXRjYjnHpYR2WvyfCBBQvVrvjBi26uAFkXE= CONNECTED         test.bn1.ironfish.network:9033 dowjFPeQZBDLUriPFv4f9b/am19eYqCN0w9CUFI+wSI= CONNECTED(!)      104.7.65.165:9034 dowjFPeQZBDLUriPFv4f9b/am19eYqCN0w9CUFI+wSI= DISCONNECTED(!)   104.7.65.165:9034 dowjFPeQZBDLUriPFv4f9b/am19eYqCN0w9CUFI+wSI= CONNECTING        10.7.25.65:9033 dowjFPeQZBDLUriPFv4f9b/am19eYqCN0w9CUFI+wSI= CONNECTED         84.7.15.65:9044 dowjFPeQZBDLUriPFv4f9b/am19eYqCN0w9CUFI+wSI= CONNECTED         124.7.65.165:9014

您可以通过运行以下命令获取有关连接状态和错误的更多信息：

ironfish peers：list -fe

节点配置

数据结构

默认情况下，Iron Fish 节点的数据库和配置文件在~/.ironfish目录中创建。

文件结构由以下部分组成：

【铁鱼节点】

├── 账户

...└── 默认

├── config.json

├── internal.json

└── 数据库

...└── 默认

配置文件可以通过这里描述的命令进行编辑。帐户可以通过此处描述的命令进行编辑

--datadir您可以在运行命令时通过传递标志来更改工作目录。这样做将要求您再次将节点与网络同步。

配置选项列表

帐户命令

检查所有可用命令

ironfish accounts

$ironfish accounts

Create and delete accounts 

USAGE  

$ ironfish accounts:COMMAND 

COMMANDS  accounts:balance    Display the account balance  

accounts:create     Create a new account for sending and receiving coins  

accounts:export     Export an account  accounts:import     Import an account 

 accounts:list       List all the accounts on the node  

accounts:pay        Send coins to another account  

accounts:publickey  Display or regenerate the account public key  

accounts:remove     Permanently remove an account  

accounts:rescan     Rescan the blockchain for transaction  

accounts:use        Change the default account used by all commands  

accounts:which      Show the account currently used.

创建帐户

创建新帐户

ironfish accounts:create

$ironfish accounts:create

MyNewAccountCreating account MyNewAccount Account MyNewAccount saved to /Users/username/.ironfishtodelete/accounts.json Public address: 6a085865ac5608c8ec64189db54d4b5c085da9da12dad0a0bf00f60e52c16b0303d8a8dd7d82601f577c8d Run "ironfish accounts:use MyNewAccount" to set the account as default

默认帐户

更改 CLI 使用的默认帐户

ironfish accounts:use MyAccount

$ironfish accounts:use MyAccount

The default account is now: MyAccount

导入帐户

要从文件导入帐户：

Ironfish account：import filename

通过标准输入导入账户：

echo {<account json>} |ironfish accounts：import

输入账户的 JSON 并回车

以交互方式导入帐户：

ironfish accounts：import

$ironfish accounts:import

Enter the account name:walletEnter the account spending key:9cfaf518a343aa5cb6d7ee704f7b0b29fac85ff96912ea7302a3e2a4ae52cff5Enter the account incoming view key:0092734294658f53417ed104deb10ac333a799ca13d210bbad3d62e95247f306Enter the account outgoing view key:687ddc73cc224fad52379f52cd545c1a6b79af38d7cf18a02e1f527fd4740a1cEnter the account public address:c1ab489154850983e68f2e4b74f658d7dd1cfe84cb18902cf6632680909b2379590b3b7287fc78b8e947c7Account wallet imported. Run "ironfish accounts:use wallet" to set the account as default

输入如上所示提示要求的详细信息

导出帐户

要将帐户导出到文件：

Ironfish accounts：export AccountName filename

要将帐户导出到终端：

ironfish accounts:export AccountName

$ironfish accounts:export wallet

{ 

"name": 

"wallet",

"spendingKey": "9cfaf518a343aa5cb6d7ee704f7b0b29fac85ff96912ea7302a3e2a4ae52cff5", "incomingViewKey": "0092734294658f53417ed104deb10ac333a799ca13d210bbad3d62e95247f306", "outgoingViewKey": "687ddc73cc224fad52379f52cd545c1a6b79af38d7cf18a02e1f527fd4740a1c", "publicAddress": "c1ab489154850983e68f2e4b74f658d7dd1cfe84cb18902cf6632680909b2379590b3b7287fc78b8e947c7", 

"rescan": null

}

查看当前默认帐户

显示 CLI 使用的当前默认帐户

ironfish accounts:which

$ironfish accounts:which

MyAccount

帐户列表

查看节点上的帐户列表

ironfish accounts:list

$ironfish accounts:list

default MyAccount

帐户密钥

查看特定帐户的公钥

ironfish accounts:publickey

$ironfish accounts:publickey

Account: default, public key: 30b62713dc3b1c823b3e18089a30540ca1eb551a85884bb3e6ddd90d9966888e9997b74a83324cba643fc3

账户余额

显示账户余额

ironfish accounts:balance

$ironfish accounts:balance

The account balance is:    $IRON 0.00000000 ($ORE 0) Amount available to spend: $IRON 0.00000000 ($ORE 0)

帐户删除

删除帐户

ironfish accounts:remove MyAccount

$ironfish accounts:remove wallet

Account 'wallet' successfully removed.

发送交易

从当前账户发送交易

ironfish accounts:pay

$ironfish accounts:pay

Enter the amount in $IORN(balance available:$IRON 200)20

Enter the fee amount in $IRON 0.00000001

Enter the the public address of the recipient:

ab518b8c908d7157eaebdf8159c5813894074d3136826daba4a485598de1b86a597af2821f8400bbfe70c1

You are about to send:

$IRON 20 to 

ab518b8c908d7157eaebdf8159c5813894074d3136826daba4a485598de1b86a597af2821f8400bbfe70c1 from the account IronFishGenesisAccount 

* This action is NOT reversible *

Do you confirm(Y/N)?: Y

Creating the transaction:

████████████████████████████████████████ 100%

Sending 20 to ab518b8c908d7157eaebdf8159c5813894074d3136826daba4a485598de1b86a597af2821f8400bbfe70c1 from MyNewAccount 

Transaction Hash: e032e78268a1097288503e18510e48d140292ff5ce91d0914ae00f733ad8d166 Transaction Fee: 0.00000001

Find the transaction on 

重置钱包

重置你的钱包并尝试从头开始重建它

ironfish accounts:rescan

$ironfish accounts:rescanRescanning Transactions... ⡿ Scanning Block: 3660, 41 seconds        Rescanning Transactions... Scanning Complete

CLI 命令

帮助

ironfish help显示可用于 Iron Fish CLI 的所有命令和主题。要获取有关特定命令或特定主题的其他信息，请键入ironfish [topic/command] help。

例如对于一个主题：

ironfish accounts help

例如对于一个命令：

Ironfish Ironfish accounts：pay help

节点

开始

启动全节点

ironfish start

用不同的端口和不同的数据目录启动一个完整的节点

ironfish start --port=9034 --datadir=~/.ironfish2/

停止

停止全节点

ironfish stop

状态

打印出来：

·节点的状态（启动/停止）

·节点的同步状态和同步统计信息

·节点的网络状态（和网络统计信息）

ironfish status

要查看实时更新：

ironfish status-f

重置

删除你的链和钱包状态。这将永久删除您的帐户，因此如有必要，请先备份它们。

ironfish reset

配置

配置：显示

打印出配置文件的内容

ironfish config:show

配置：编辑

使用默认代码编辑器打开配置文件

ironfish config:edit

注意：您需要设置编辑器配置或默认编辑器环境变量才能使此命令起作用。例如对于配置级别ironfish config:set editor "/Applications/Visual Studio Code.app/Contents/MacOS/Electron" 的 Vscode：例如对于环境级别的 Vscode：export EDITOR="/Applications/Visual Studio Code.app/Contents/MacOS/Electron"

配置：设置

设置键的配置值。

例如

config：set enableMiningDirector “ture”

注意：配置选项列表可在此处获得

配置：获取

显示节点的配置值

例如

config：get enableMiningDirector

矿工

矿工：开始

启动矿工并为节点订阅新块。该节点必须与网络同步，矿工才能开始挖掘。

ironfish miners：start

加入矿池。

ironfish miners：start -p <ip-address-of-pool> -a <your-public-address>

矿工：矿池：开始

poolName使用配置选项中设置的名称启动矿池。

ironfish miners：pool：start

启动一个禁用支付的池。

ironfish miners：pool：start --no-payouts

矿工：开采

列出挖掘的块哈希

ironfish miners：mined [start] [stop]

网络

同行：名单

显示连接到节点的对等方列表。

ironfish peers：list

显示具有实时更新的对等点列表。

ironfish peers：list -f

同行：显示

显示有关对等点的信息

ironfish peers：show[IDENTITY]

账户/钱包

帐户：创建

使用交互模式创建新帐户

ironfish accounts：create

在命令行中创建一个新帐户

ironfish accounts：create MyNewAccount

帐户：公钥

获取当前账户的公钥

ironfish accounts：publickey

获取特定帐户的公钥

ironfish accounts：publickey -a MyNewAccount

账户：余额

获取当前账户的余额

ironfish accounts：balance

获取特定帐户的公钥

ironfish accounts：balance -a MyNewAccount

帐户：支付

使用交互模式创建新事务

ironfish accounts：pay

在命令行中创建新事务

ironfish accounts：pay -a 2 -t 997c5...c52ed

水龙头

水龙头

连接铁鱼龙头获取测试资金

ironfish faucet

链

链：出口

将部分链数据库导出为 JSON

ironfish chain：export [start] [stop]

链：叉子

尝试检测正在开采的分叉

ironfish chain：forks

链：修复

重建主链修复腐败

ironfish chain：repair

链：显示

显示节点链中最重的头部和尾部。包括链中的最后十个块。

ironfish chain：show

块

块：显示

显示请求哈希的块头

ironfish blocks：show [HASH]

工人

工人：状态

显示工作池的状态

ironfisha workers：status