lesson-3_Subnetをカスタムしよう

🌻 genesis file

このレッスンではSubnetをカスタムします。

genesis fileを作成し、それを元にSubnetを作成することで独自のカスタムを加えることができます。

📓 genesis file Subnet の初期設定を含むファイルです。 Subnet を作成する際、Avalanche はパラメータに基づいてジェネシスファイルを自動で生成します。また、独自の genesis file を作成することもできます。これにより、Subnet の構成をより詳細に制御することができます。

前回のレッスンで作成したmySubnetのgenesis fileは以下のコマンドで内容を確認することができます。

cat ~/.avalanche-cli/subnets/mySubnet/genesis.json

または

avalanche subnet describe mySubnet --genesis

出力結果

% avalanche subnet describe mySubnet --genesis
{
    "config": {
        "chainId": 1111,
        "feeConfig": {
            "gasLimit": 8000000,
            "targetBlockRate": 2,
            "minBaseFee": 25000000000,
            "targetGas": 15000000,
            "baseFeeChangeDenominator": 36,
            "minBlockGasCost": 0,
            "maxBlockGasCost": 1000000,
            "blockGasCostStep": 200000
        },
        "homesteadBlock": 0,
        "eip150Block": 0,
        "eip150Hash": "0x2086799aeebeae135c246c65021c82b4e15a2c451340993aacfd2751886514f0",
        "eip155Block": 0,
        "eip158Block": 0,
        "byzantiumBlock": 0,
        "constantinopleBlock": 0,
        "petersburgBlock": 0,
        "istanbulBlock": 0,
        "muirGlacierBlock": 0,
        "subnetEVMTimestamp": 0
    },
    "nonce": "0x0",
    "timestamp": "0x0",
    "extraData": "0x",
    "gasLimit": "0x7a1200",
    "difficulty": "0x0",
    "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "coinbase": "0x0000000000000000000000000000000000000000",
    "alloc": {
        "8db97c7cece249c2b98bdc0226cc4c2a57bf52fc": {
            "balance": "0xd3c21bcecceda1000000"
        }
    },
    "airdropHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "airdropAmount": null,
    "number": "0x0",
    "gasUsed": "0x0",
    "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "baseFeePerGas": null
}

以下、主要部分にコメントをつけたので簡単にgenesis fileの中身を確認します。

{
    "config": {
        "chainId": チェーンID。
        "feeConfig": {
            "gasLimit": 1つのブロックで使用できるガスの総量。
            "targetBlockRate": ブロックの生成間隔時間(秒)。
            "minBaseFee": トランザクションで使用できる最小の基本料金。
            "targetGas": 10秒間隔で消費するガスの目標量。利用量と目標量の比較で基本料金が増減されます。
            "baseFeeChangeDenominator": 利用量と目標量の差を割る分母値。基本料金の増減具合を決定します。
            "minBlockGasCost": ブロックの生産に課金するガスの最小量。
            "maxBlockGasCost": ブロックの生産に課金するガスの最大量。
            "blockGasCostStep": ブロックのガスコストの変化量を求める際に使用する値。
        },
    },
    "gasLimit": feeConfig内のgasLimitと同じである必要があります。0x7a1200は8,000,000の16進数表記です。
    "alloc": {
        アドレスとその初期残高を定義します。
        残高は10進数でも16進数でも定義可能です。
    },
}

genesis fileの中身について、詳しくはこちら、またはこちらをご覧ください。

✅ 環境構築を行う

genesis fileを作成する前に作業用ディレクトリを用意しましょう。

あなたのコンピュータのお好きな場所にAVAX-Subnetというディレクトリを作成してください。

⚠️ 本プロジェクトは全てのレッスンを終えたら、このAVAX-Subnetディレクトリをルートとしたリポジトリを提出します。今後ディレクトリ構成をレッスンと同じ構成にするよう気をつけてください。 💁

また、前回作成したmySubnetがローカルネットワーク上で起動している場合、avalanche network statusをターミナルで実行すると以下のような表示がされると思います。

Avalanche-CLIの操作に慣れるためにもう一度mySubnetを削除します。

まずはローカルネットワークからmySubnetを削除します。 avalanche network cleanを実行するとローカルネットワーク上のサブネット情報を永久的に削除します。

% avalanche network clean
Process terminated.

再びavalanche network statusを実行し、ローカルネットワーク上にサブネットがなければ以下のような表示がされます。

% avalanche network status
Requesting network status...
Error: timed out trying to contact backend controller、it is most probably not running

次にavalanche subnet list --deployedを実行すると以下のように作成されたsubnetの状態が表示されます。

% avalanche subnet list --deployed
+----------+----------+----------+-----------+-----------+-------+----------+---------+
|  SUBNET  |  CHAIN   | CHAIN ID |   TYPE    | FROM REPO |       | DEPLOYED |         |
+----------+----------+----------+-----------+-----------+-------+----------+---------+
|          |          |          |           |           | Local | Fuji     | Mainnet |
+----------+----------+----------+-----------+-----------+-------+----------+---------+
| mySubnet | mySubnet |     1111 | SubnetEVM | false     | No    | No       | No      |
+----------+----------+----------+-----------+-----------+-------+----------+---------+

先ほどローカルネットワークから削除したので、DEPLOYED項目のLocalがNoになっています。

さらに、avalanche subnet delete mySubnetを実行して作成したサブネットを削除してください。

% avalanche subnet delete mySubnet

avalanche subnet listを実行すると、mySubnetが削除されてる事が確認できます。

% avalanche subnet list
+--------+-------+---------+------+------+-----------+
| SUBNET | CHAIN | CHAINID | VMID | TYPE | FROM REPO |
+--------+-------+---------+------+------+-----------+
+--------+-------+---------+------+------+-----------+

これから新しくmySubnetを作っていきます。

🦀 genesis file の作成

AVAX-Subnetディレクトリ直下にgenesisというディレクトリを作成し、その中にmygenesis.jsonという名前のファイルを作成してください。

ディレクトリ構成。

AVAX-Subnet
└── genesis
    └── mygenesis.json

mygenesis.jsonの中にベースとなる以下の内容を貼り付けてください。

{
    "config": {
      "chainId": "change me",
      "homesteadBlock": 0,
      "eip150Block": 0,
      "eip150Hash": "0x2086799aeebeae135c246c65021c82b4e15a2c451340993aacfd2751886514f0",
      "eip155Block": 0,
      "eip158Block": 0,
      "byzantiumBlock": 0,
      "constantinopleBlock": 0,
      "petersburgBlock": 0,
      "istanbulBlock": 0,
      "muirGlacierBlock": 0,
      "SubnetEVMTimestamp": 0,
      "feeConfig": {}
    },
    "alloc": {},
    "nonce": "0x0",
    "timestamp": "0x0",
    "extraData": "0x00",
    "gasLimit": "change me",
    "difficulty": "0x0",
    "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "coinbase": "0x0000000000000000000000000000000000000000",
    "number": "0x0",
    "gasUsed": "0x0",
    "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000"
  }

🦌 chainIdの定義

chainIdの項目を以下のように変更してください。

文字列"321123"にならないように気をつけてください。

      "chainId": 321123,

🦌 feeConfigの定義

feeConfigの項目を以下のように変更してください。

      "feeConfig": {
        "gasLimit": 8000000,
        "minBaseFee": 25000000000,
        "targetGas": 15000000,
        "baseFeeChangeDenominator": 36,
        "minBlockGasCost": 0,
        "maxBlockGasCost": 1000000,
        "targetBlockRate": 2,
        "blockGasCostStep": 200000
      }

🦌 gasLimitの定義

gasLimitの項目を以下のように変更してください。 ※feeConfig内のgasLimitと同じ値（16進数表記）になります。

    "gasLimit": "0x7A1200",

🦌 allocの定義

allocの項目を以下のように変更してください。

    "alloc": {
        "あなたのアカウントのアドレス": {
          "balance": "0x3635C9ADC5DEA00000"
        }
    },

ここでは、Subnetのデプロイ時にネイティブトークンを送信するアカウントを定義しています。

balanceは送信するトークンの量（16進数表記）を表しています。

本プロジェクトでは、アドレス0x9726A1976148789be35a4EEb6AEfBBF4927b04ACを使用するため以下のようになります。 ⚠️ 接頭辞の0xを除いてください。

    "alloc": {
        "9726A1976148789be35a4EEb6AEfBBF4927b04AC": {
          "balance": "0x3635C9ADC5DEA00000"
        }
    },

🦌 PreCompileの定義

最後にPreCompileの定義を追加します。

PreCompileとは、Avalancheが事前に用意したコンパイル済みのコントラクトであり、ネットワークへのアクセス制限などに利用できます。

PreCompileは以下の3つが用意されています。

ContractNativeMinter: ネイティブトークンをmintできるアカウントを制御できます。

ContractDeployerAllowList: コントラクトをデプロイできるアカウントを制御できます。

TransactionAllowList: トランザクションを提出できるアカウントを制御できます。

全てのPreCompileは以下のインタフェースを実装しているので、コントラクトを使用する場合は以下のインタフェースにある関数を呼び出すことで可能です。

//SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

interface IAllowList {
  // addrを管理者アカウントに設定します。
  function setAdmin(address addr) external;

  // addrに権限を与えます。(例：ContractNativeMinterの場合はmintする権限を与えます)。
  function setEnabled(address addr) external;

  // addrの権限を無くします。
  function setNone(address addr) external;

  // addrのロールを取得します。
  function readAllowList(address addr) external view returns (uint256 role);
}

roleは以下のenumで管理されています。

enum BillStatus {
    None,
    Enabled,
    Admin
}

PreCompileを使用するには、genesis fileに定義する必要があります。

以下のようにfeeConfigの下に各PreCompileを使用する定義を追加してください。

      "feeConfig": {

      },
      "contractNativeMinterConfig": {
        "blockTimestamp": 0,
        "adminAddresses": ["管理者に使用するアカウントのアドレス"]
      },
      "contractDeployerAllowListConfig": {
        "blockTimestamp": 0,
        "adminAddresses": ["管理者に使用するアカウントのアドレス"]
      },
      "txAllowListConfig": {
        "blockTimestamp": 0,
        "adminAddresses": ["管理者に使用するアカウントのアドレス"]
      }

本プロジェクトでは、アドレス0x9726A1976148789be35a4EEb6AEfBBF4927b04ACを使用するため、adminAddressの項目はそれぞれ以下のようになります。

"adminAddresses": ["0x9726A1976148789be35a4EEb6AEfBBF4927b04AC"]

genesis fileの完成形は以下のようになっています。（管理者に使用するアカウントのアドレス・トークンを送信するアカウントのアドレスの部分をご自身の使用するアカウントのアドレスに書き換えてください）。

{
  "config": {
    "chainId": 321123,
    "homesteadBlock": 0,
    "eip150Block": 0,
    "eip150Hash": "0x2086799aeebeae135c246c65021c82b4e15a2c451340993aacfd2751886514f0",
    "eip155Block": 0,
    "eip158Block": 0,
    "byzantiumBlock": 0,
    "constantinopleBlock": 0,
    "petersburgBlock": 0,
    "istanbulBlock": 0,
    "muirGlacierBlock": 0,
    "SubnetEVMTimestamp": 0,
    "feeConfig": {
      "gasLimit": 8000000,
      "minBaseFee": 25000000000,
      "targetGas": 15000000,
      "baseFeeChangeDenominator": 36,
      "minBlockGasCost": 0,
      "maxBlockGasCost": 1000000,
      "targetBlockRate": 2,
      "blockGasCostStep": 200000
    },
    "contractNativeMinterConfig": {
      "blockTimestamp": 0,
      "adminAddresses": ["管理者に使用するアカウントのアドレス"]
    },
    "contractDeployerAllowListConfig": {
      "blockTimestamp": 0,
      "adminAddresses": ["管理者に使用するアカウントのアドレス"]
    },
    "txAllowListConfig": {
      "blockTimestamp": 0,
      "adminAddresses": ["管理者に使用するアカウントのアドレス"]
    }
  },
  "alloc": {
    "トークンを送信するアカウントのアドレス(※接頭辞の`0x`を除いてください)": {
      "balance": "0x3635C9ADC5DEA00000"
    }
  },
  "nonce": "0x0",
  "timestamp": "0x0",
  "extraData": "0x00",
  "gasLimit": "0x7A1200",
  "difficulty": "0x0",
  "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
  "coinbase": "0x0000000000000000000000000000000000000000",
  "number": "0x0",
  "gasUsed": "0x0",
  "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000"
}

🚜 カスタム Subnet の作成

※ どこかしらでエラーが発生し、Subnetを作り直す時には下にあるTipsのセクションをご参照ください。

それではgenesis fileを使ってSubnetを作成します。

AVAX-Subnetディレクトリ直下で以下のコマンドを実行してください。

avalanche subnet create mySubnet --genesis genesis/mygenesis.json

その後のプロンプトでSubnetEVM、Use latest versionを選択します。

% avalanche subnet create mySubnet --genesis genesis/mygenesis.json
✔ SubnetEVM
Importing genesis
✔ Use latest version
Successfully created subnet configuration

🛫 Subnet のデプロイ

以下のコマンドを実行してmySubnetをローカルネットワークにデプロイします。

avalanche subnet deploy mySubnet

% avalanche subnet deploy mySubnet
✔ Local Network
Deploying [mySubnet] to Local Network
Backend controller started, pid: 31209, output at: /Users/ryojiro/.avalanche-cli/runs/server_20221209_175948/avalanche-cli-backend
VMs ready.
Starting network...
.........
Blockchain has been deployed. Wait until network acknowledges...
......
Network ready to use. Local network node endpoints:
+-------+----------+-------------------------------------------------------------------------------------+
| NODE  |    VM    |                                         URL                                         |
+-------+----------+-------------------------------------------------------------------------------------+
| node2 | mySubnet | http://127.0.0.1:9652/ext/bc/2vVjEw8dH2SVtkuC75CgofJNj5DKqJBfoc1ez3cYnvyu5kywWH/rpc |
+-------+----------+-------------------------------------------------------------------------------------+
| node3 | mySubnet | http://127.0.0.1:9654/ext/bc/2vVjEw8dH2SVtkuC75CgofJNj5DKqJBfoc1ez3cYnvyu5kywWH/rpc |
+-------+----------+-------------------------------------------------------------------------------------+
| node4 | mySubnet | http://127.0.0.1:9656/ext/bc/2vVjEw8dH2SVtkuC75CgofJNj5DKqJBfoc1ez3cYnvyu5kywWH/rpc |
+-------+----------+-------------------------------------------------------------------------------------+
| node5 | mySubnet | http://127.0.0.1:9658/ext/bc/2vVjEw8dH2SVtkuC75CgofJNj5DKqJBfoc1ez3cYnvyu5kywWH/rpc |
+-------+----------+-------------------------------------------------------------------------------------+
| node1 | mySubnet | http://127.0.0.1:9650/ext/bc/2vVjEw8dH2SVtkuC75CgofJNj5DKqJBfoc1ez3cYnvyu5kywWH/rpc |
+-------+----------+-------------------------------------------------------------------------------------+

Browser Extension connection details (any node URL from above works):
RPC URL:          http://127.0.0.1:9654/ext/bc/2vVjEw8dH2SVtkuC75CgofJNj5DKqJBfoc1ez3cYnvyu5kywWH/rpc
Funded address:   0x9726A1976148789be35a4EEb6AEfBBF4927b04AC with 1000
Network name:     mySubnet
Chain ID:         321123
Currency Symbol:  TEST

💁 前回のレッスンでMetamaskに追加したmySubnetのネットワークを削除し、同じステップで新たに今回のネットワークをMetamaskに追加してください。

上記のデータの中にあるRPC URLは後ほど使うのでどこかに保存しておいてください。

RPC URL: http://127.0.0.1:9654/ext/bc/2vVjEw8dH2SVtkuC75CgofJNj5DKqJBfoc1ez3cYnvyu5kywWH/rpc

📓 Tips

Subnetを作り直す時の手順

avalanche network clean
avalanche subnet delete mySubnet
avalanche subnet create mySubnet --genesis genesis/mygenesis.json
avalanche subnet deploy mySubnet
Metamaskの以前のネットワークを削除し、新たなネットワークを接続
コントラクトを再デプロイする場合はhardhat.configのRPC URLを更新（この先のsectionで扱います）

以下にavalancheコマンドの一覧をまとめます。

詳しくはこちらをはじめとしたHow to Use Avalanche-CLIカテゴリーをご覧ください。

# subnetの作成
avalanche subnet create <subnetName>

# subnetのデプロイ
avalanche subnet deploy <subnetName>

# 作成したSubnetのリスト表示
avalanche subnet list

# Subnetの詳細表示
avalanche subnet describe <subnetName>

# Subnetの削除
avalanche subnet delete mySubnet

# ネットワーク ステータス確認
avalanche network status

# ネットワーク停止
avalanche network stop

# ネットワーク起動
avalanche network start

# データを永久的に削除
avalanche network clean

本プロジェクトはローカルネットワークにデプロイしましたが、テストネットやメインネットへのデプロイ方法はこちらやこちらをご覧ください。

また、プライベートブロックチェーン（特定のバリデータのみがブロックチェーン上の情報を読み取ることができる）の作成についてはこちらをご覧ください。

🐊 `GitHub`にソースコードをアップロードしよう

本プロジェクトは全てのレッスンを終えたら、完成物を提出するためにGitHubへソースコードをアップロードする必要があります。

AVAX-Subnet全体を対象としてアップロードしましょう。

今後の開発にも役に立つと思いますので、今のうちに以下にアップロード方法をおさらいしておきます。

GitHubのアカウントをお持ちでない方は,こちらの手順に沿ってアカウントを作成してください。

GitHubへソースコードをアップロードをしたことがない方は以下を参考にしてください。

新しいレポジトリを作成（リポジトリ名などはご自由に）した後、手順に従いターミナルからアップロードを済ませます。以下ターミナルで実行するコマンドの参考です。(AVAX-Subnet直下で実行することを想定しております)

$ git init
$ git add .
$ git commit -m "first commit"
$ git branch -M main
$ git remote add origin [作成したレポジトリの SSH URL]
$ git push -u origin main

✍️: SSH の設定を行う

Github のレポジトリをクローン・プッシュする際に,SSHKey を作成し,GitHub に公開鍵を登録する必要があります。

SSH（Secure SHell）はネットワークを経由してマシンを遠隔操作する仕組みのことで,通信が暗号化されているのが特徴的です。

主にクライアント（ローカル）からサーバー（リモート）に接続をするときに使われます。この SSH の暗号化について,仕組みを見ていく上で重要になるのが秘密鍵と公開鍵です。

まずはクライアントのマシンで秘密鍵と公開鍵を作り,公開鍵をサーバーに渡します。そしてサーバー側で「この公開鍵はこのユーザー」というように,紐付けを行っていきます。

自分で管理して必ず見せてはいけない秘密鍵と,サーバーに渡して見せても良い公開鍵の 2 つが SSH の通信では重要になってきます。 Github における SSH の設定は,こちらを参照してください!

🌔 参考リンク

こちらに本プロジェクトの完成形のレポジトリがあります。期待通り動かない場合は参考にしてみてください。

🙋‍♂️ 質問する

ここまでの作業で何かわからないことがある場合は、Discordの#avalancheで質問をしてください。

ヘルプをするときのフローが円滑になるので、エラーレポートには下記の三点を記載してください ✨

質問が関連しているセクション番号とレッスン番号
何をしようとしていたか
エラー文をコピー&ペースト
エラー画面のスクリーンショット

カスタムSubnetの作成が完了しました 🎉

次のレッスンではスマートコントラクトを実装していきます！

🌻 genesis file​

✅ 環境構築を行う​

🦀 genesis file の作成​

🚜 カスタム Subnet の作成​

🛫 Subnet のデプロイ​

📓 Tips​

🐊 GitHubにソースコードをアップロードしよう​

🌔 参考リンク​

🙋‍♂️ 質問する​