XRP Ledger Apex is back in Amsterdam

Register Now
Last updated
Edit

ledger

[ソース]

ledgerコマンドは公開されているレジャーの情報を取得します。新規: Clio v1.0.0

Clioサーバはデフォルトで検証済みのレジャーデータを返すことに注意してください。

リクエストのフォーマット

リクエストのフォーマットの例:

  1. WebSocket
  2. JSON-RPC
{
    "id": 14,
    "command": "ledger",
    "ledger_index": "validated",
    "transactions": false,
    "expand": false,
    "owner_funds": false,
    "diff": false
}

リクエストには以下のパラメータを含めることができます。

Field説明
ledger_hashハッシュ(省略可) 使用するレジャーバージョンの20バイトの16進文字列。(レジャーの指定ご覧ください。)
ledger_indexレジャーインデックス(省略可) 使用するレジャーのレジャーインデックス、またはレジャーを自動的に選択するためのショートカット文字列。(レジャーの指定をご覧ください)
transactions真偽値(省略可) trueの場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトではfalseです。レジャーバージョンを指定しない場合は無視されます。
expand真偽値(省略可) ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトではfalseです。トランザクション、アカウント、またはその両方をリクエストしない場合は無視されます。
owner_funds真偽値(省略可) trueの場合、レスポンスのOfferCreateトランザクションのメタデータにowner_fundsフィールドが含まれます。デフォルトではfalseです。トランザクションが含まれておらず、expandがtrueではない場合には無視されます。
binary真偽値(省略可) trueで、かつtransactionsexpandが両方ともtrueの場合、JSONフォーマットではなくバイナリフォーマット(16進文字列)でトランザクション情報が返されます。
diff真偽値(省略可) trueの場合、指定したレジャーのトランザクションの一部として追加、変更、または削除されたすべてのオブジェクトを返します。

ledgerフィールドは廃止予定であり、今後予告なしに削除される可能性があります。

注記

Clioのledgerコマンドは、rippledのledgerコマンドでサポートされている以下のフィールドをサポートしていません。

  • accounts
  • full
  • queue

上記のフィールドのいずれかがtrueに設定されている場合、Clioは常にリクエストをrippledに転送します。

レスポンスのフォーマット

処理が成功したレスポンスの例:

  1. WebSocket
  2. JSON-RPC
{
  "result": {
    "ledger_hash": "3787026448652A36491493C1202A443B2A6CC6022599BB0B25DDB0802DD7F1E7",
    "ledger_index": 82681623,
    "validated": true,
    "ledger": {
      "account_hash": "39D34D858A0FD652143ED84B67A09193772DE0CCEBD2D63619E679293B7A3388",
      "close_flags": 0,
      "close_time": 748569571,
      "close_time_human": "2023-Sep-20 23:59:31.000000000 UTC",
      "close_time_resolution": 10,
      "closed": true,
      "ledger_hash": "3787026448652A36491493C1202A443B2A6CC6022599BB0B25DDB0802DD7F1E7",
      "ledger_index": "82681623",
      "parent_close_time": 748569570,
      "parent_hash": "674FF6C68956E06CB9628833677C3DD71824C87C0AEFB487984CF98C3964DAEE",
      "total_coins": "99988406188847858",
      "transaction_hash": "11EE9C448D6B07B88A80B4FC7935B485E513816B3B47D0976CE9F51E7CF10A85"
    }
  },
  "status": "success",
  "type": "response",
  "warnings": [
    {
      "id": 2001,
      "message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
    }
  ]
}

レスポンスは標準フォーマットに従っており、正常に完了した場合は結果にレジャーに関する情報を表す次のフィールドが含まれています。

Field説明
ledgerオブジェクトこのレジャーの完全なヘッダーデータ。
ledger.account_hash文字列このレジャーのすべてのアカウントの状態情報のハッシュ値。
ledger.accountState配列(リクエストで指定がない場合省略) このレジャーのすべてのアカウント状態情報(16進数)
ledger.close_flags数値このレジャーのクローズに関するフラグのビットマップ。
ledger.close_time数値レジャーが閉鎖された時刻(Rippleエポック以降の経過秒数)。
ledger.close_time_human文字列人間が読めるフォーマットでのこのレジャーが閉鎖された時刻。常にUTCタイムゾーンを使用します。
ledger.close_time_resolution数値レジャー閉鎖時刻が丸められる秒数の範囲。
ledger.closed真偽値このレジャーが閉鎖されているかどうか。
ledger.ledger_hash文字列レジャー全体の一意の識別用ハッシュ。
ledger.ledger_index文字列このレジャーのレジャーインデックス。整数を引用符で囲んだ形式で示されます。
ledger.parent_close_time数値前のレジャーが閉鎖された時刻。
ledger.parent_hash文字列このレジャーの直前のレジャーの一意の識別用ハッシュ。
ledger.total_coins文字列ネットワークのXRPの合計(drop数)。整数を引用符で囲んだ形式で示されます。(トランザクションコストによりXRPが焼却されると、この値は減少します。)
ledger.transaction_hash文字列このレジャーに記録されているトランザクション情報のハッシュ(16進数)
ledger.transactions配列(リクエストで指定がない場合省略) このレジャーバージョンで適用されたトランザクション。デフォルトでは、メンバーはトランザクションの識別用ハッシュ文字列です。リクエストでexpandがtrueとして指定されている場合は、メンバーはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現です。フォーマットは、リクエストでbinaryがtrueとして指定されていたかどうかに応じて決まります。
ledger_hash文字列レジャー全体の一意の識別用ハッシュ。
ledger_index数値このレジャーのレジャーインデックス
validated真偽値(省略される場合があります) trueの場合、このレジャーは最終バージョンです。省略または false の場合、このレジャーのデータは最終版ではありません。
diffオブジェクト(リクエストでdiffパラメータの指定がない場合省略) レジャーのトランザクションの一部として追加、変更、または削除されたハッシュの配列を含むオブジェクト。

リクエストに"owner_funds": trueが指定されておりトランザクションが展開されている場合、レスポンスには、各OfferCreateトランザクションmetaDataオブジェクトのowner_fundsフィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとにオファーの資金化ステータスを容易に追跡できるようにすることです。このフィールドの定義は、オーダーブックサブスクリプションストリームでのこのフィールドのバージョンとはわずかに異なります。

Field説明
owner_funds文字列このレジャーのすべてのトランザクションの実行後に、このOfferCreateトランザクションを送信するAccountが保有するTakerGets通貨の額。この通貨額が凍結されているかどうかはチェックされません。

リクエストで”diff": trueを指定した場合、レスポンスにはオブジェクトdiffが含まれます。このオブジェクトのフィールドは以下の通りです。

Field説明
object_id文字列オブジェクトのID
Hashesオブジェクトまたは16進文字列リクエストがbinaryをtrueに設定したかfalseに設定したかに応じて、このフィールドは作成されたオブジェクトの内容、変更されたオブジェクトの新しい値、またはオブジェクトが削除された場合は空の文字列を返します。

difftrueを設定した場合のレスポンス

{% code-snippet file="/_api-examples/ledger-clio/jsonrpc-diff-response.json" language="json" /%}

考えられるエラー

  • 汎用エラータイプのすべて。
  • invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
  • lgrNotFound - ledger_hashまたはledger_indexで指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。