# ledger [[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/LedgerHandler.cpp) 公開レジャーに関する情報を取得します。 ## リクエストのフォーマット リクエストのフォーマットの例: WebSocket ```json { "id":14, "command":"ledger", "ledger_index":"validated", "transactions": false, "expand": false, "owner_funds": false } ``` JSON-RPC ```json { "method":"ledger", "params":[ { "ledger_index":"validated", "transactions": false, "expand": false, "owner_funds": false } ] } ``` コマンドライン ```sh #Syntax: ledger ledger_index|ledger_hash [full|tx] # "full" is equivalent to "full": true # "tx" is equivalent to "transactions": true rippled ledger current ``` リクエストには以下のパラメーターを含めることができます。 | `Field` | 型 | 必須? | 説明 | | --- | --- | --- | --- | | `ledger_hash` | [ハッシュ](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%8F%E3%83%83%E3%82%B7%E3%83%A5) | いいえ | 使用するレジャーバージョンの32バイトの16進文字列。([レジャーの指定](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%AC%E3%82%B8%E3%83%A3%E3%83%BC%E3%81%AE%E6%8C%87%E5%AE%9A)ご覧ください。) | | `ledger_index` | [レジャーインデックス](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%AC%E3%82%B8%E3%83%A3%E3%83%BC%E3%82%A4%E3%83%B3%E3%83%87%E3%83%83%E3%82%AF%E3%82%B9) | いいえ | 使用するレジャーの[レジャーインデックス](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%AC%E3%82%B8%E3%83%A3%E3%83%BC%E3%82%A4%E3%83%B3%E3%83%87%E3%83%83%E3%82%AF%E3%82%B9)、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%AC%E3%82%B8%E3%83%A3%E3%83%BC%E3%81%AE%E6%8C%87%E5%AE%9A)をご覧ください) | | `transactions` | 真偽値 | いいえ | `true`の場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトでは`false`です。レジャーバージョンを指定しない場合は無視されます。 | | `expand` | 真偽値 | いいえ | ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方をリクエストしない場合は無視されます。 | | `owner_funds` | 真偽値 | いいえ | `true`の場合、レスポンスのOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 | | `binary` | 真偽値 | いいえ | `true`で、かつ`transactions`と`expand`が両方とも`true`の場合、JSONフォーマットではなくバイナリフォーマット(16進文字列)でトランザクション情報が返されます。 | | `queue` | 真偽値 | いいえ | `true`で、かつコマンドが`current`レジャーをリクエストしている場合、[キューに入れらているトランザクション](/ja/docs/concepts/transactions/transaction-cost#%E3%82%AD%E3%83%A5%E3%83%BC%E3%81%AB%E5%85%A5%E3%82%8C%E3%82%89%E3%82%8C%E3%81%9F%E3%83%88%E3%83%A9%E3%83%B3%E3%82%B6%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3)の配列が結果に含まれます。 | `ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。`full`、`accounts`、`type`フィールド(管理者専用)も非推奨です。 ## レスポンスのフォーマット 処理が成功したレスポンスの例: WebSocket { "id": "example_ledger_req", "result": { "ledger": { "account_hash": "B8B2C0C3F9E75E3AEE31D467B2544AB56244E618890BA58679707D6BFC0AF41D", "close_flags": 0, "close_time": 752188602, "close_time_human": "2023-Nov-01 21:16:42.000000000 UTC", "close_time_resolution": 10, "closed": true, "ledger_hash": "1BEECD5D21592EABDEF98D8E4BC038AD10B5700FF7E98011870DF5D6C2A2F39B", "ledger_index": "83626901", "parent_close_time": 752188601, "parent_hash": "6B32CFC42B32C5FB90019AE17F701D96B499A4C8E148A002E18135A434A19D98", "total_coins": "99988256314388830", "transaction_hash": "21586C664DC47E12AF34F22EBF1DB55D23F8C98972542BAC0C39B1009CAC84D4" }, "ledger_hash": "1BEECD5D21592EABDEF98D8E4BC038AD10B5700FF7E98011870DF5D6C2A2F39B", "ledger_index": 83626901, "validated": true }, "status": "success", "type": "response" } JSON-RPC 200 OK { "result": { "ledger": { "account_hash": "23C1C8F8ACCEFACBDD9A1804CC25E652A324F9EABD7D0BEF103DA56D6E0306E7", "close_flags": 0, "close_time": 752188801, "close_time_human": "2023-Nov-01 21:20:01.000000000 UTC", "close_time_resolution": 10, "closed": true, "ledger_hash": "140B769E9ED61FCD675A6EEC1F005084614314C1D675C2CFDD11A1024BBD2C96", "ledger_index": "83626952", "parent_close_time": 752188800, "parent_hash": "7D169A530960AFA8A0E38D036D8EF960BC2C2E02C4A0CE848A4200B9376AC99C", "total_coins": "99988256304478252", "transaction_hash": "77226182F58D9B5C798262F0E9D8C575D174E434F0C3C7119FB658BA70004CE9" }, "ledger_hash": "140B769E9ED61FCD675A6EEC1F005084614314C1D675C2CFDD11A1024BBD2C96", "ledger_index": 83626952, "status": "success", "validated": true } } コマンドライン Loading: "/etc/opt/ripple/rippled.cfg" 2023-Nov-01 21:38:14.638871262 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005 { "result": { "ledger": { "account_hash": "23C1C8F8ACCEFACBDD9A1804CC25E652A324F9EABD7D0BEF103DA56D6E0306E7", "close_flags": 0, "close_time": 752188801, "close_time_human": "2023-Nov-01 21:20:01.000000000 UTC", "close_time_resolution": 10, "closed": true, "ledger_hash": "140B769E9ED61FCD675A6EEC1F005084614314C1D675C2CFDD11A1024BBD2C96", "ledger_index": "83626952", "parent_close_time": 752188800, "parent_hash": "7D169A530960AFA8A0E38D036D8EF960BC2C2E02C4A0CE848A4200B9376AC99C", "total_coins": "99988256304478252", "transaction_hash": "77226182F58D9B5C798262F0E9D8C575D174E434F0C3C7119FB658BA70004CE9" }, "ledger_hash": "140B769E9ED61FCD675A6EEC1F005084614314C1D675C2CFDD11A1024BBD2C96", "ledger_index": 83626952, "status": "success", "validated": true } } レスポンスは[標準フォーマット](/ja/docs/references/http-websocket-apis/api-conventions/response-formatting)に従っており、正常に完了した場合は結果にレジャーに関する情報を表す次のフィールドが含まれています。 | `Field` | 型 | 説明 | | --- | --- | --- | | `ledger` | オブジェクト | このレジャーの完全な[レジャーヘッダのデータ](/ja/docs/references/protocol/ledger-data/ledger-header)で、便宜上いくつかのフィールドが追加されています。 | | `ledger.account_hash` | 文字列 | このレジャーのすべてのアカウント状態情報の[ハッシュ](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%8F%E3%83%83%E3%82%B7%E3%83%A5) | | `ledger.accountState` | 配列 | このレジャーのすべての[アカウント状態情報](/ja/docs/references/protocol/ledger-data)(16進数)。 | | `ledger.close_flags` | 整数 | このレジャーの[クローズに関するフラグ](/ja/docs/references/protocol/ledger-data/ledger-header#close-flags)のビットマップ。 | | `ledger.close_time` | 整数 | レジャーが閉鎖された時刻([Rippleエポック以降の経過秒数](/ja/docs/references/protocol/data-types/basic-data-types#%E6%99%82%E9%96%93%E3%81%AE%E6%8C%87%E5%AE%9A))。 | | `ledger.close_time_human` | 文字列 | 人間が読めるフォーマットでのこのレジャーが閉鎖された時刻。常にUTCタイムゾーンを使用します。 | | `ledger.close_time_resolution` | 整数 | レジャー閉鎖時刻が丸められる秒数の範囲。 | | `ledger.closed` | 真偽値 | このレジャーが閉鎖されているかどうか。 | | `ledger.ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 | | `ledger.ledger_index` | 文字列 | このレジャーの[レジャーインデックス](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%AC%E3%82%B8%E3%83%A3%E3%83%BC%E3%82%A4%E3%83%B3%E3%83%87%E3%83%83%E3%82%AF%E3%82%B9)。整数を引用符で囲んだ形式で示されます。 | | `ledger.parent_close_time` | 整数 | 前のレジャーが閉鎖された時刻。 | | `ledger.parent_hash` | 文字列 | このレジャーの直前のレジャーの一意の識別用ハッシュ。 | | `ledger.total_coins` | 文字列 | ネットワークのXRPの合計(drop数)。整数を引用符で囲んだ形式で示されます。(トランザクションコストによりXRPが焼却されると、この値は減少します。) | | `ledger.transaction_hash` | 文字列 | このレジャーに記録されているトランザクション情報のハッシュ(16進数) | | `ledger.transactions` | 配列 | (リクエストされていない場合は省略)このレジャーバージョンで適用されたトランザクション。デフォルトでは、メンバーはトランザクションの識別用[ハッシュ](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%8F%E3%83%83%E3%82%B7%E3%83%A5)文字列です。リクエストで`expand`がtrueとして指定されている場合は、メンバーはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現です。フォーマットは、リクエストで`binary`がtrueとして指定されていたかどうかに応じて決まります。 | | `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 | | `ledger_index` | 数値 | このレジャーの[レジャーインデックス](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%AC%E3%82%B8%E3%83%A3%E3%83%BC%E3%82%A4%E3%83%B3%E3%83%87%E3%83%83%E3%82%AF%E3%82%B9)。 | | `queue_data` | 配列 | (`queue`パラメーターでリクエストされている場合を除いて省略)キューに入れられたトランザクションをキューと同じ順序で記述するオブジェクトの配列。リクエストで`expand`がtrueに指定されている場合は、メンバーにはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現が含まれています。フォーマットは、リクエストで`binary`がtrueとして指定されていたかどうかによって決まります。 | `ledger.accountState`フィールド(`"full": true`または`"accounts": true`でリクエストされない限り省略)は廃止予定です。 次のフィールドは廃止予定であり、今後予告なしに削除される可能性があります。`accepted`、`hash`(代わりに`ledger_hash`を使用)、`seqNum`(代わりに`ledger_index`を使用)、`totalCoins`(代わりに`total_coins`を使用)。更新: rippled 1.12.0 `queue_data`配列の各メンバーは、キュー内の1つのトランザクションを表します。このオブジェクトの一部フィールドは、まだ計算されていないために省略されることがあります。このオブジェクトのフィールドを次に示します。 | フィールド | 値 | 説明 | | --- | --- | --- | | `account` | 文字列 | このキューに入れられたトランザクションの送信者の[アドレス](/ja/docs/references/protocol/data-types/basic-data-types#%E3%82%A2%E3%83%89%E3%83%AC%E3%82%B9)。 | | `tx` | 文字列またはオブジェクト | デフォルトでは、これはトランザクションの[識別用ハッシュ](/ja/docs/references/protocol/data-types/basic-data-types#%E3%83%8F%E3%83%83%E3%82%B7%E3%83%A5)を含む文字列です。トランザクションがバイナリフォーマットで展開されている場合、これは`tx_blob`が唯一のフィールドであるオブジェクトであり、バイナリー形式のトランザクションが10進文字列として含まれています。トランザクションがJSONフォーマットで展開されている場合、これは`hash`フィールドにトランザクションの識別用ハッシュが指定されている[トランザクションオブジェクト](/ja/docs/references/protocol/transactions)を含むオブジェクトです。 | | `retries_remaining` | 数値 | このトランザクションの再試行可能回数。この回数を超えるとトランザクションが除外されます。 | | `preflight_result` | 文字列 | 初期トランザクションチェックの一時的な結果。これは常に`tesSUCCESS`です。 | | `last_result` | 文字列 | *(省略される場合があります)*[再試行可能な(`ter`)の結果](/ja/docs/references/protocol/transactions/transaction-results/ter-codes)を取得した後でこのトランザクションがキューに残っている場合、これは取得した正確な`ter`結果コードです。 | | `auth_change` | 真偽値 | *(省略される場合があります)* このトランザクションがこのアドレスの[トランザクション承認方法](/ja/docs/concepts/transactions#%E3%83%88%E3%83%A9%E3%83%B3%E3%82%B6%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AE%E6%89%BF%E8%AA%8D)を変更するかどうかを示します。 | | `fee` | 文字列 | *(省略される場合があります)* このトランザクションの[トランザクションコスト](/ja/docs/concepts/transactions/transaction-cost)([XRPのdrop数](/ja/docs/references/protocol/data-types/basic-data-types#%E9%80%9A%E8%B2%A8%E9%A1%8D%E3%81%AE%E6%8C%87%E5%AE%9A))。 | | `fee_level` | 文字列 | *(省略される場合があります)* このタイプのトランザクションの最少コストと比較した、このトランザクションのトランザクションコスト([手数料レベル](/ja/docs/concepts/transactions/transaction-cost#%E6%89%8B%E6%95%B0%E6%96%99%E3%83%AC%E3%83%99%E3%83%AB))。 | | `max_spend_drops` | 文字列 | *(省略される場合があります)* このトランザクションで送信または消却できる[XRPのdrop数](/ja/docs/references/protocol/data-types/basic-data-types#%E9%80%9A%E8%B2%A8%E9%A1%8D%E3%81%AE%E6%8C%87%E5%AE%9A)の最高額。 | リクエストに`"owner_funds": true`が指定されておりトランザクションが展開されている場合、レスポンスには、各[OfferCreateトランザクション](/ja/docs/references/protocol/transactions/types/offercreate)の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](/ja/docs/concepts/tokens/decentralized-exchange/offers#%E3%82%AA%E3%83%95%E3%82%A1%E3%83%BC%E3%81%AE%E3%83%A9%E3%82%A4%E3%83%95%E3%82%B5%E3%82%A4%E3%82%AF%E3%83%AB)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](/ja/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe#%E3%82%AA%E3%83%BC%E3%83%80%E3%83%BC%E3%83%96%E3%83%83%E3%82%AF%E3%82%B9%E3%83%88%E3%83%AA%E3%83%BC%E3%83%A0)でのこのフィールドのバージョンとはわずかに異なります。 | `Field` | 値 | 説明 | | --- | --- | --- | | `owner_funds` | 文字列 | このレジャーのすべてのトランザクションの実行後に、このOfferCreateトランザクションを送信する`Account`が保有する`TakerGets`通貨の額。この通貨額が[フリーズ](/ja/docs/concepts/tokens/fungible-tokens/freezes)されているかどうかはチェックされません。 | ## 考えられるエラー * [汎用エラータイプ](/ja/docs/references/http-websocket-apis/api-conventions/error-formatting#%E6%B1%8E%E7%94%A8%E3%82%A8%E3%83%A9%E3%83%BC)のすべて。 * `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。 * `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。 * `noPermission` - `full`または`accounts`をtrueとして指定したが、管理者としてサーバに接続していない場合(通常、管理者はローカルポートで接続する必要があります)。