Symbol ノードの構築方法

目次

• Symbol ノードについて
• ノードの特徴とサーバの基本スペック
• Symbol Node 構築手順
• Tips

Symbol ノードについて

ノードの特徴とサーバの基本スペック

• Peer Node
• API Node
• Voting Node

Peer Node

API Node

Voting Node

Symbol Node 構築手順

• 必須ハードウェアスペック以上のサーバー（別表）
• Debian OS 10 以上
• PORT 80, 443, 3000, 3001, 7900

（別表）必須ハードウェアスペック

普段サーバーを構築されない方への注意点

• ファイアーウォールの設定
• SSH通信の場合は root ログインの禁止し、かつ公開鍵での認証を行う
• PORT は 22, 80, 3000, 3001, 7900 以外は原則閉じて下さい

ポートの用途

サーバーの初期設定

adduser symbol
usermod -aG sudo symbol
su - symbol

必要なソフトウェアのインストール

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ymuichiro/symbol-node-builder/main/scripts/install.sh)"

• nvm, node.js 16, npm のインストール
• docker, docker-compose のインストール
• npm による symbol-bootstrap のインストール
• ~/symbol-bootstrap/** フォルダの作成

Symbol-Bootstrap の起動とセットアップ

cd ~/symbol-bootstrap
symbol-bootstrap wizard

1. ネットワーク選択 どのネットワークでノードを建てるか選びます。

Select a network: (Use arrow keys)
❯  Mainnet Node
    Testnet Node
    Bootstrap Local Network
    Custom Network Node ('custom-network-preset.yml' file and 'nemesis-seed' folder are required)

Select an assembly: (Use arrow keys)
❯ Dual Node
  Peer Node
  Api Node
  Demo Node. A dual node that includes a Faucet and Explorer.

? Symbol Bootstrap is about to start working with sensitive information (private keys) so it is highly recommended that
you disconnect from the network before continuing. Say YES if you are offline or if you don't care. (Y/n)

Enter the password used to encrypt and decrypt custom presets, addresses.yml, and preset.yml files. When providing a
password, private keys will be encrypted. Keep this password in a secure place!

? How do you want to create the Main account: (Use arrow keys)
❯ Generating a new account
   Entering a private key
   Enter the 64 HEX private key of the Main account (or press enter to select the option again).

? Is this the expected address TCDNP*******************55KCQ to used as Main account?  (y/N)

? How do you want to create the Transport account: (Use arrow keys)
❯ Generating a new account
  Entering a private key

? How do you want to create the VRF account: (Use arrow keys)
❯ Generating a new account
   Entering a private key

? How do you want to create the Remote account: (Use arrow keys)
❯ Generating a new account
  Entering a private key

Your REST Gateway should be running on HTTPS (which is a secure protocol) so that it can be recognized by the Symbol Explorer.
? Select your HTTPS setup method: (Use arrow keys)
❯ Native support, I have the SSL certificate and key.
   Automatic, all of your keys and certs will be generated/renewed automatically, using letsencyrpt.
   None

? Enter the public domain name(eg. node-01.mysymbolnodes.com) that's pointing to your outbound host IP This value is
required when you are running on HTTPS!

Enter the friendly name of your node.

? Select the type of security you want to use: (Use arrow keys)
   PROMPT_MAIN: Bootstrap may ask for the Main private key when doing certificates upgrades. Other keys are encrypted.
❯ PROMPT_MAIN_TRANSPORT: Bootstrap may ask for the Main and Transport private keys when regenerating certificates. Other
keys are encrypted. Recommended for most nodes
   ENCRYPT: All keys are encrypted, only password would be asked

? Are you creating a Voting node? (y/N)

assembly: dual
preset: mainnet
privateKeySecurityMode: PROMPT_MAIN_TRANSPORT
nodes:
    -
        host: example.org
        maxUnlockedAccounts: 30
        beneficiaryAddress: ${your-symbol-address}
        voting: false
        friendlyName: ${your-name}
        mainPrivateKey: ${your-node-main-privatekey}
        vrfPrivateKey: ${your-node-vrf-privatekey}
        remotePrivateKey: ${your-node-remote-privatekey}
        transportPrivateKey: ${your-node-transport-privatekey}
httpsProxies:
    -
        excludeDockerService: false

Symbol-Node の起動

cd ~/symbol-bootstrap
symbol-bootstrap config -p mainnet -a dual -c custom-preset.yml
symbol-bootstrap start -d
symbol-bootstrap healthCheck

Tips

ノード証明書の更新

1. healthCheck でノードSSL証明書の期限を確認する

symbol-bootstrap healthCheck

> he node.crt.pem certificate for node node will expire on Aug  2 14:30:34 2023 GMT. No need to renew it yet.

2. 証明書を更新する

symbol-bootstrap renewCertificates

Symbol Node list で ノードの情報を表示する

1. 手数料を支払っての登録（推奨）

2. ノード上に nodeSetting.json を設置しての登録

• ノードの以下のパスへコンフィグファイルを設置します

  • http://xxx.xxx.xxx.xxx:80/nodeSetting.json
• symbol-bootstrap は稼働中 80, 443 ポートも listen されています。よって以下、もしくは同等の操作をする必要があります。

  • ~/symbol-bootstrap/target/docker/docker-compose.yml を編集し、nginx の パス上に nodeSetting.json がマウントされるよう、ボリューム情報を書き換えます
  • symbol-bootstrap compose 等でコンテナを再構築し、ノードを起動します

MongoDBのインデックス見直し

custom-preset.yml を更新したとき

symbol-bootstrap stop
symbol-bootstrap config -p mainnet -a dual -c custom-preset.yml --upgrade
symbol-bootstrap compose --upgrade
symbol-bootstrap run -d

ノードのエラー発生時原因の確認方法

1. symbol-bootstrap のログ出力を確認する

symbol-bootstrap run

2. docker のログ機能を利用する

symbol-bootstrap stop
symbol-bootstrap run -d
docker ps -a

symbol@xxxxxxxxxxxxxxxxxxx:~$ docker ps -a
CONTAINER ID   IMAGE                                      COMMAND                  CREATED        STATUS        PORTS                                                                        NAMES
8d44313c93d6   steveltn/https-portal:1.19                 "/init"                  40 hours ago   Up 40 hours   0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:3001->443/tcp, :::3001->443/tcp   https-proxy
71fa6d455cf6   symbolplatform/symbol-server:gcc-1.0.3.5   "/bin/bash /symbol-c…"   40 hours ago   Up 40 hours   0.0.0.0:7900->7900/tcp, :::7900->7900/tcp                                    node
542ca6019607   symbolplatform/symbol-server:gcc-1.0.3.5   "/bin/bash /symbol-c…"   2 days ago     Up 40 hours                                                                                broker
5b6765426fd2   symbolplatform/symbol-rest:2.4.2           "docker-entrypoint.s…"   2 days ago     Up 40 hours   0.0.0.0:3000->3000/tcp, :::3000->3000/tcp                                    rest-gateway
19c9ac8edce9   mongo:4.4.3-bionic                         "docker-entrypoint.s…"   2 days ago     Up 40 hours   27017/tcp                                                                    db

docker logs ${CONTAINER ID}

リンク

• Symbol ノードの移設方法
• Symbol Tools - Symbol Node List
• Symbol Nodes - nodes
• Symbol documentation
• Symbol bootstrap repository