dfx ledger
dfx ledger
コマンドを使用して、「 Ledger Canister 」(台帳)と対話を行います。
このコマンドは、ユーティリティトークンである ICP をある Canister から別の Canister に移転するトランザクションや、ICP から(ミントされた) Cycle を Canister に追加したりするために使用されます。
dfx ledger
コマンドを実行するための基本的な構文は以下のとおりです:
dfx ledger [options] [subcommand]
指定する dfx ledger
サブコマンドによっては、追加の引数、オプション、フラグが適用される場合があります。dfx ledger
コマンドの使い方を説明するリファレンス情報と例については適切なコマンドを選択してご覧ください。
コマンド | 説明 |
---|---|
選択された開発者 Indentity のアカウント ID を表示します。 |
|
ユーザー Identity のアカウント ID の残高を表示します。 |
|
ICP から Canister を作成します。 |
|
|
指定されたサブコマンドの使用情報メッセージを表示します。 |
Cycle をミントする Canister への送信トランザクションがあった場合、台帳に通知します。 |
|
ICP からミントする Cycle を Canister に追加します。 |
|
ユーザー Identity から転送先のアカウント ID に ICP を転送します。 |
特定のサブコマンドの使用情報を見るには、そのサブコマンドと --help
フラグを指定します。
例えば、dfx ledger transfer
の使用情報を見るには、以下のコマンドを実行します:
dfx ledger transfer --help
dfx ledger account-id
dfx ledger balance
dfx ledger balance
コマンドは自分のアカウント残高や他のユーザーのアカウント残高を表示します。
フラグ
以下のオプションフラグは dfx ledger balance
コマンドで使用できます。
フラグ | 説明 |
---|---|
|
利用情報を表示します。 |
|
バージョン情報を表示します。 |
dfx ledger create-canister
dfx ledger create-canister
コマンドを使用して、ICP トークンを Cycle に変換し、Internet Computer に新しい Canister ID を登録することができます。
フラグ
dfx ledger create-canister
コマンドには以下のオプションフラグを使用することができます。
フラグ | 説明 |
---|---|
|
利用情報を表示します。 |
|
バージョン情報を表示します。 |
引数
dfx ledger create-canister
コマンドには以下の引数を指定することができます。
引数 | 説明 |
---|---|
|
新しい Canister のコントローラーとして設定する Principal ID を指定します。 |
オプション
dfx ledger create-canister
コマンドには以下の引数を指定することができます。
オプション | 説明 |
---|---|
|
ICP トークンかミントされた Cycle を、送金先 Canister にデポジットする数量を指定します。金額は小数点以下8桁までの数字で指定できます。 |
|
ICP トークンの分数単位(e8)を整数で指定します。例えば、1.05000000は1 ICP と5,000,000 e8s です。このオプションは単独で、あるいは |
|
取引手数料を指定します。デフォルトは10,000 e8s です。 |
|
ICP トークンを整数で指定します。このオプションは単独で、あるいは |
|
取引手数料の上限を指定します。デフォルトは10,000 e8s です。 |
例
Cycle を扱える新しい Canister を作成するには、以下のようなコマンドを実行して、台帳アカウントから ICP トークンを転送します:
dfx ledger --network ic create-canister tsqwz-udeik-5migd-ehrev-pvoqv-szx2g-akh5s-fkyqc-zy6q7-snav6-uqe --amount 1.25
このコマンドは --amount
引数に指定した ICP トークンの数量を Cycle に変換し、指定した Principal で制御される新しい Canister ID に Cycle を関連付けます。
この例では、コマンドは 1.25 ICP トークンを Cycle に変換し、新しい Canister のコントローラーとして、デフォルトの Identity の Principal ID を指定しています。
トランザクションが成功すると、台帳にイベントが記録され、次のような出力が表示されるはずです。
Transfer sent at BlockHeight: 20 Canister created with id: "53zcu-tiaaa-aaaaa-qaaba-cai"
以下のようなコマンドを実行して、ICP トークンと e8s に別々の値を指定することで、新しい Canister を作成することができます。
dfx ledger --network ic create-canister tsqwz-udeik-5migd-ehrev-pvoqv-szx2g-akh5s-fkyqc-zy6q7-snav6-uqe --icp 3 --e8s 5000
dfx ledger notify
dfx ledger notify
コマンドを使用すると、Cycle をミントする Canister への送信トランザクションを台帳に通知します。
このコマンドは dfx ledger create-canister
や dfx ledger top-up
が台帳へのメッセージ送信に成功し、あるブロック高でトランザクションが記録されたが、何らかの理由でその後の通知に失敗した場合のみ使用されます。
フラグ
dfx ledger notify
コマンドでは以下のオプションフラグを使用することができます。
フラグ | 説明 |
---|---|
|
利用情報を表示します。 |
|
バージョン情報を表示します。 |
引数
dfx ledger notify
コマンドでは以下の引数を指定することができます。
引数 | 説明 |
---|---|
|
送信トランザクションが記録されたブロック高を指定します。 |
|
送信先の Principal を指定します。Canister ID またはユーザー Identity の Principal のテキストタイプ表現のいずれかを指定します。
送信トランザクションが |
dfx ledger top-up
dfx ledger top-up
コマンドでは、ICPトークンからミントされた Cycle を Canister に追加することができます。
フラグ
dfx ledger top-up
コマンドでは以下のオプションフラグが使用できます。
フラグ | 説明 |
---|---|
|
利用情報を表示します。 |
|
バージョン情報を表示します。 |
オプション
dfx ledger top-up
コマンドには以下のオプションを指定することができます。
オプション | 説明 |
---|---|
|
ICP トークンかミントされた Cycle を、送金先 Canister にデポジットする数量を指定します。金額は小数点以下8桁までの数字で指定できます。 |
|
ICP トークンの最小単位を e8 とし,小数点以下の単位を整数で指定します.例えば、1.05000000は1 ICPと5,000,000 e8s です。このオプションは単独で、あるいは |
|
オペレーションの取引手数料を指定します。デフォルトは10,000 e8s です。 |
|
ICP トークンを整数で指定します。このオプションは単独で、あるいは |
|
取引手数料の上限を指定します。デフォルトは10,000 e8s です。 |
例
dfx ledger top-up
コマンドを使用すると、自分が管理している ICP トークンの残高から、特定の Canister の Cycle を追加することができます。
Canister ID は Cycle を受け取ることができる 「Cycle Wallet Canister 」と関連付けられている必要があります。または、 Internet Computer Interface Specification に記載されているシステム API を使って Cycle を受け取る方法を実装するために、「Cycle Wallet Canister 」ではない Canister を変更することもできます。
例えば、以下のコマンドを実行すると、Internet Computer に配置された Cycle Wallet Canister に1 ICP 相当の Cycle を追加することができます:
dfx ledger --network ic top-up --icp 1 5a46r-jqaaa-aaaaa-qaadq-cai
このコマンドは次のような出力を表示します:
Transfer sent at BlockHeight: 59482 Canister was topped up!
dfx ledger transfer
dfx ledger transfer
コマンドを使用すると、ICP トークンを Ledger Canister のアカウントアドレスから送信先アドレスに転送することができます。
フラグ
dfx ledger transfer
コマンドでは、以下のオプションフラグを使用することができます。
フラグ | 説明 |
---|---|
|
利用情報を表示します。 |
|
バージョン情報を表示します。 |
オプション
dfx ledger transfer
コマンドには以下の引数を指定することができます。
オプション | 説明 |
---|---|
|
転送する ICP トークンの数量を指定します。 小数点以下8桁までの数値で指定可能です。 |
|
e8s を整数で指定し,1 e8 を ICPトークンの最小値とする。例えば、1.05000000は1 ICPと5,000,000 e8s である。このオプションは単独で、あるいは |
|
取引手数料を指定します。デフォルトは10,000 e8s です。 |
|
ICP を整数で指定します。このオプションは単独で、または |
|
このトランザクションの数値メモを指定します。 |
例
dfx ledger transfer
コマンドを使用すると、転送先のアカウント ID に ICP を送信することができます。
例えば、以下のコマンドを実行すると、現在使用している Principal に関連するアカウント ID を確認することができます。
dfx ledger account-id
このコマンドは、次のような出力を表示します:
30e596fd6c5ff5ad7b7d70bbbda1187c833e646c6251464da7f82bc217bba397
このアカウントの残高は以下のコマンドを実行することで確認することができます:
dfx ledger --network ic balance
このコマンドは、次のような出力を表示します:
64.89580000 ICP
以下のコマンドを使用して、dfx ledger transfer
コマンドで ICP 残高の一部を別の既知の送信先に送信してください。
dfx ledger --network ic transfer dd81336dbfef5c5870e84b48405c7b229c07ad999fdcacb85b9b9850bd60766f --memo 12345 --icp 1
このコマンドは、次のような出力を表示します:
Transfer sent at BlockHeight: 59513
その後、dfx ledger --network ic balance
コマンドを使用して、アカウント残高に今行った取引が反映されているかどうかを確認することができます。