Skip to content

Latest commit

 

History

History
293 lines (212 loc) · 10.9 KB

workstation.md

File metadata and controls

293 lines (212 loc) · 10.9 KB

テスト用ネットワークの環境構築

お手元のマシンにローカルネットワーク環境を構築して学習する場合に行います。

既に用意されたネットワークを使用する場合はこの作業をする必要はありません。

外部ネットワークを使用する場合は、以降のドキュメントでは接続するURLのホストとポートは各自の環境で読み替えてください。

APIエンドポイントはデフォルト設定でhttp://localhost:3000です。

catapult-service-bootstrapの起動

任意の場所にアーカイブを展開してください。(gitが利用できる場合はクローンしてもよいです)

$ git clone https://github.com/tech-bureau/catapult-service-bootstrap.git -b 0.5.0.1

展開したディレクトリに移動して、cmds/以下にあるコマンドファイルの実行でコンテナクラスタを立ち上げます。

$ cd catapult-service-bootstrap
$ ./cmds/start-all -d

-dオプションでバックグラウンド動作させます。

初期設定などが動き出すので、ブロック生成が始まるまで1分程度待ちます。

クラスタの動作確認

APIの疎通確認

ブラウザでアクセスしてください。初期ブロックのレスポンスが得ることで動作を確認できます。

{
  "meta": {
    "hash": "D58DB24EE18D2585A98D00112C67F9FADF75C808B1BCE7FAB5787171B2BD498E",
    "generationHash": "67763DFDA2C6D8FE2E51D8EBBA0F430C06AD07561FA5E565D1A576EA06ABC682",
    "totalFee": [
      0,
      0
    ],
    "subCacheMerkleRoots": [],
    "numTransactions": 29
  },
  "block": {
    "signature": "0DA9D18AD8FB8CFD71991A0EE966528853A7B82880C2F0BBBFAFDFBDDCAAB997AF859F9BB16075E1C711A1E0136693914B7CA49371A89190A6433AEF405F9802",
    "signer": "1E86A389DA753CE14365AB30793D378D648E422E89229AE8B07B69059BD550AE",
    "version": 36867,
    "type": 32835,
    "height": [
      1,
      0
    ],
    "timestamp": [
      0,
      0
    ],
    "difficulty": [
      276447232,
      23283
    ],
    "feeMultiplier": 0,
    "previousBlockHash": "0000000000000000000000000000000000000000000000000000000000000000",
    "blockTransactionsHash": "B9B1AE9D1D49F6CBAA3D71F14EEB08F23B8278C04C999E2A2D3FF3640E9CFF32",
    "blockReceiptsHash": "E9877761762C1FD4FCF2C7A7BCAB57CF2FDE83BE2A49C070E11E748141E31215",
    "stateHash": "43C5EE62FF5ABAC078B4B511F306EEA5C2E2F07CFB8E8BA8C0DA53869E140E3E",
    "beneficiary": "0000000000000000000000000000000000000000000000000000000000000000"
  }
}}

初期分配の確認

初期分配された基軸モザイクは初期生成アドレスへ分配されています。

初期アドレスは./build/generated-addresses/addresses.ymlにあります。

nemesis_addresses:という箇所から下が初期アドレスです。以下は一例です。

なお、以降に出てくる秘密/公開鍵やアドレスはご自分の使用しているものに置き換えて実行してください。

nemesis_addresses:
- private: 57062D8B532D0423B324998E251DD77B972802B6FB3DDB57289BCF9246284AE0
  public: F02D33764A08DEBEF4B9FFD514FE99DFB084879F09C32E183F087610246C8BB2
  address: SBPKTXJYSCHBGHRAFEETGITGW6AS22KX4GI5WZ25
- private: 6BE1AD4D445329D8F1B8DA6662EC1BB1ED7976E1AA8653C25FE1F600778F354E
  public: 6AD9B656ECA8AF93E4EE9F20847DA51FFC7B6DAFD6ACCA88149315AFED1BB245
  address: SATGJWJCHFZTXTUQYZVAXXTXY6KXA3S66ZMQX23T
- private: 00FD5E450984189F9DE396A8B9E4DB038DF7D9AB7612D5197C5011318100CF0E
  public: 196DF14B0C6EF2A9BCB0914E3B249A50301A2058AE962AEA970616F6BD91E393
  address: SCFO5UG43W5KV7HNIGE3BY6ZK6ST2SCDJ5F3O2Q

初期分配時に使われるファイルを見てみると、前の20アカウントへ分配しています。

(現時点での仕様です。今後コードは変更されるかもしれません)

基軸モザイクの発行枚数は8,999,999,998.000,000、可分性は6なので、4億49百94万9千999.9cat.currency(8,999,999,998.000,000 / 20 = 449,949,999.900,000)ずつ分配されます。

APIにアクセスして確認してみましょう。

ここでは整形していますが、次のようなjsonレスポンスが得られます。

{
  "meta": {},
  "account": {
    "address": "9098AEE06DA026A414E1AF31AD5497DB7980D433EE0DC05FB5",
    "addressHeight": [
      1,
      0
    ],
    "publicKey": "0000000000000000000000000000000000000000000000000000000000000000",
    "publicKeyHeight": [
      0,
      0
    ],
    "accountType": 0,
    "linkedAccountKey": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
    "activityBuckets": [
      {
        "startHeight": "1",
        "totalFeesPaid": "0",
        "beneficiaryCount": 0,
        "rawScore": "3750000"
      }
    ],
    "mosaics": [
      {
        "id": [
          2100741038,
          1065721635
        ],
        "amount": [
          636036448,
          104762
        ]
      },
      {
        "id": [
          33800276,
          1975350734
        ],
        "amount": [
          3750000,
          0
        ]
      }
    ],
    "importance": [
      3750000,
      0
    ],
    "importanceHeight": [
      1,
      0
    ]
  }
}

mosaicsが保有モザイクを表しています。

ここでは2つモザイクを持っていますが、amountに0が含まれていない方([636036448, 104762])に注目します。

mosaics[0].amountの値を確認すると[636036448, 104762]となっています。

これはJavaScriptで64bitの大きな値を扱うために上下位32bitずつに分けた表現です。

(JavaScriptの言語仕様上53bitの整数値までしか扱えません)

(53bit以下に収まる)表現可能な数値であれば、整数値として表示することができます。

scriptsディレクトリへ移動して、次のワンライナースクリプトを実行してみてください。

$ cd scripts
$ node -e "let uint64 = require('nem2-sdk').UInt64;console.log(new uint64([636036448,104762]).compact())"
449949999900000 # 絶対値による表現

449,949,999.900,000 cat.currencyが配布されていることが確認できました。

クラスタの停止

クラスタを停止するには./cmds/stop-allを実行してください。

$ ./cmds/stop-all
Stopping catapult-service-bootstrap_faucet_1            ... done
Stopping catapult-service-bootstrap_peer-node-1_1       ... done
Stopping catapult-service-bootstrap_peer-node-0_1       ... done
Stopping catapult-service-bootstrap_api-node-0_1        ... done
Stopping catapult-service-bootstrap_rest-gateway_1      ... done
Stopping catapult-service-bootstrap_db_1                ... done
Stopping catapult-service-bootstrap_api-node-broker-0_1 ... done
Removing catapult-service-bootstrap_faucet_1                 ... done
Removing catapult-service-bootstrap_peer-node-1_1            ... done
Removing catapult-service-bootstrap_peer-node-0_1            ... done
Removing catapult-service-bootstrap_api-node-0_1             ... done
Removing catapult-service-bootstrap_rest-gateway_1           ... done
Removing catapult-service-bootstrap_init-db_1                ... done
Removing catapult-service-bootstrap_peer-node-0-nemgen_1     ... done
Removing catapult-service-bootstrap_peer-node-1-nemgen_1     ... done
Removing catapult-service-bootstrap_api-node-0-nemgen_1      ... done
Removing catapult-service-bootstrap_db_1                     ... done
Removing catapult-service-bootstrap_setup-network_1          ... done
Removing catapult-service-bootstrap_generate-raw-addresses_1 ... done
Removing catapult-service-bootstrap_api-node-broker-0_1      ... done
Removing catapult-service-bootstrap_store-addresses_1        ... done
Removing network catapult-service-bootstrap_default

再開する場合は起動と同様に./cmds/start-all -dを実行してください。

クラスタ立ち上げ時のトラブルシューティング

執筆時点でクラスタを立ち上げる際にブロック生成が進まない問題が発生することがあります。

動作確認でつまづいた場合、以下を試してみてください。

また、解決しない場合に助けを求めたり、詳しい原因を調べたりする場合はログが役に立ちます。

cd cmds/docker; docker-compose -p catapult-service-bootstrap logs でログを表示して、エラーの出力を確認してみてください。

ブロック生成が進まない

ブロック情報の破損、設定ファイルの食い違いなどの問題が発生することがあるようです。

./cmds/clean-allというスクリプトを実行すると、環境を初期化できます。

初期化後に./cmds/start-allでクラスタを立ち上げ直してみてください。

レスポンスが帰ってこない

APIサーバの起動に失敗している可能性があります。

./cmds/clean-allで環境を初期化後、クラスタを立ち上げ直してみてください。

クラスタを停止後、動かそうとすると動かない

正しくコンテナが終了しなかったりすると、ロックファイルserver.lockが残る場合があります。

./data/{node}/server.lockを削除してから立ち上げてみてください。

なんだかおかしい

とにかく./cmds/clean-allで環境を(ry

ブロックチェーンをリセットしたい・消したい

クラスタを停止してから./cmds/clean-dataを使ってください。

こちらはブロック情報だけを削除します。

削除後に./cmds/start-allすれば1ブロック目から生成が始まります。

何度cleanしても動作しない

cowやdragonなどを過去に動作させていて、過去バージョンのイメージが残っていることで、イメージの組み合わせに齟齬が起きている場合があります。

一度イメージとコンテナもすべて削除してからやり直してみてください。

docker rmi -f $(docker images -f 'reference=catapult-service-bootstrap_*' --format '{{.Repository}}:{{.Tag}}')
docker rm -f $(docker ps -a  -f 'name=catapult-service-bootstrap' --format '{{.ID}}')