ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-25 14:15:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f89293a3b46c39eae627b14c8a08a2cb4ac067d6
xrpl-dev-portal/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md
mDuo13 7645140477 Re-levelization: move non-docs content, rename content→docs 
For better URLs, the content folder has been renamed 'docs' and all
other files have been moved up a level. Also, non-docs images have been
moved to the static folder at the top level where they belong.

Many relative paths had to be fixed to make this work.
2024-01-31 17:53:52 -08:00

11 KiB
Raw Blame History

html, parent, seo, labels
html parent seo labels
ledger-clio.html clio-methods.html
description
レジャーのバージョン情報を取得します。
ブロックチェーン

ledger

[ソース]

ledgerコマンドは公開されているレジャーの情報を取得します。{% badge href="https://github.com/XRPLF/clio/releases/tag/1.0.0" %}新規: Clio v1.0.0{% /badge %}

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

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

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

{% tabs %}

{% tab label="WebSocket" %} {% code-snippet file="/_api-examples/ledger-clio/wsrpc-request.json" language="json" /%} {% /tab %}

{% tab label="JSON-RPC" %} {% code-snippet file="/_api-examples/ledger-clio/jsonrpc-request.json" language="json" /%} {% /tab %}

{% /tabs %}

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

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

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

{% admonition type="info" name="注記" %} Clioのledgerコマンドは、rippledのledgerコマンドでサポートされている以下のフィールドをサポートしていません。

  • accounts
  • full
  • queue

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

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

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

{% tabs %}

{% tab label="WebSocket" %} {% code-snippet file="/_api-examples/ledger-clio/wsrpc-response.json" language="json" /%} {% /tab %}

{% tab label="JSON-RPC" %} {% code-snippet file="/_api-examples/ledger-clio/jsonrpc-response.json" language="json" prefix="200 OK\n\n" /%} {% /tab %}

{% /tabs %}

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

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に設定したかに応じて、このフィールドは作成されたオブジェクトの内容、変更されたオブジェクトの新しい値、またはオブジェクトが削除された場合は空の文字列を返します。

diffにtrueを設定した場合のレスポンス

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

考えられるエラー

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

{% raw-partial file="/docs/_snippets/common-links.md" /%}