14 KiB
html, parent, seo, label
| html | parent | seo | label | |||
|---|---|---|---|---|---|---|
| ledger.html | ledger-methods.html |
|
|
ledger
公開レジャーに関する情報を取得します。
リクエストのフォーマット
リクエストのフォーマットの例:
{% tabs %}
{% tab label="WebSocket" %}
{
"id":14,
"command":"ledger",
"ledger_index":"validated",
"transactions": false,
"expand": false,
"owner_funds": false
}
{% /tab %}
{% tab label="JSON-RPC" %}
{
"method":"ledger",
"params":[
{
"ledger_index":"validated",
"transactions": false,
"expand": false,
"owner_funds": false
}
]
}
{% /tab %}
{% tab label="コマンドライン" %}
#Syntax: ledger ledger_index|ledger_hash [full|tx]
# "full" is equivalent to "full": true
# "tx" is equivalent to "transactions": true
rippled ledger current
{% /tab %}
{% /tabs %}
{% try-it method="ledger" server="xrplcluster" /%}
リクエストには以下のパラメーターを含めることができます。
Field |
型 | 必須? | 説明 |
|---|---|---|---|
ledger_hash |
[ハッシュ][] | いいえ | 使用するレジャーバージョンの32バイトの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進文字列）でトランザクション情報が返されます。 |
queue |
真偽値 | いいえ | trueで、かつコマンドがcurrentレジャーをリクエストしている場合、キューに入れらているトランザクションの配列が結果に含まれます。 |
ledgerフィールドは廃止予定であり、今後予告なしに削除される可能性があります。full、accounts、typeフィールド(管理者専用)も非推奨です。
レスポンスのフォーマット
処理が成功したレスポンスの例:
{% tabs %}
{% tab label="WebSocket" %} {% code-snippet file="/_api-examples/ledger/ws-response.json" language="json" /%} {% /tab %}
{% tab label="JSON-RPC" %} {% code-snippet file="/_api-examples/ledger/jsonrpc-response.json" language="json" prefix="200 OK\n\n" /%} {% /tab %}
{% tab label="コマンドライン" %} {% code-snippet file="/_api-examples/ledger/jsonrpc-response.json" language="json" prefix="Loading: "/etc/opt/ripple/rippled.cfg"\n2023-Nov-01 21:38:14.638871262 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005\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 |
数値 | このレジャーの[レジャーインデックス][]。 |
queue_data |
配列 | （queueパラメーターでリクエストされている場合を除いて省略）キューに入れられたトランザクションをキューと同じ順序で記述するオブジェクトの配列。リクエストでexpandがtrueに指定されている場合は、メンバーにはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現が含まれています。フォーマットは、リクエストでbinaryがtrueとして指定されていたかどうかによって決まります。 |
ledger.accountStateフィールド（"full": trueまたは"accounts": trueでリクエストされない限り省略）は廃止予定です。
次のフィールドは廃止予定であり、今後予告なしに削除される可能性があります。accepted、hash（代わりにledger_hashを使用）、seqNum（代わりにledger_indexを使用）、totalCoins（代わりにtotal_coinsを使用）。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.12.0" %}更新: rippled 1.12.0{% /badge %}
queue_data配列の各メンバーは、キュー内の1つのトランザクションを表します。このオブジェクトの一部フィールドは、まだ計算されていないために省略されることがあります。このオブジェクトのフィールドを次に示します。
| フィールド | 値 | 説明 |
|---|---|---|
account |
文字列 | このキューに入れられたトランザクションの送信者の[アドレス][]。 |
tx |
文字列またはオブジェクト | デフォルトでは、これはトランザクションの識別用ハッシュを含む文字列です。トランザクションがバイナリフォーマットで展開されている場合、これはtx_blobが唯一のフィールドであるオブジェクトであり、バイナリー形式のトランザクションが10進文字列として含まれています。トランザクションがJSONフォーマットで展開されている場合、これはhashフィールドにトランザクションの識別用ハッシュが指定されているトランザクションオブジェクトを含むオブジェクトです。 |
retries_remaining |
数値 | このトランザクションの再試行可能回数。この回数を超えるとトランザクションが除外されます。 |
preflight_result |
文字列 | 初期トランザクションチェックの一時的な結果。これは常にtesSUCCESSです。 |
last_result |
文字列 | （省略される場合があります）再試行可能な(ter)の結果を取得した後でこのトランザクションがキューに残っている場合、これは取得した正確なter結果コードです。 |
auth_change |
真偽値 | （省略される場合があります） このトランザクションがこのアドレスのトランザクション承認方法を変更するかどうかを示します。 |
fee |
文字列 | （省略される場合があります） このトランザクションのトランザクションコスト（[XRPのdrop数][]）。 |
fee_level |
文字列 | （省略される場合があります） このタイプのトランザクションの最少コストと比較した、このトランザクションのトランザクションコスト（手数料レベル）。 |
max_spend_drops |
文字列 | （省略される場合があります） このトランザクションで送信または消却できる[XRP、drop単位][]の最高額。 |
リクエストに"owner_funds": trueが指定されておりトランザクションが展開されている場合、レスポンスには、各[OfferCreateトランザクション][]のmetaDataオブジェクトのowner_fundsフィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとにオファーの資金化ステータスを容易に追跡できるようにすることです。このフィールドの定義は、オーダーブックサブスクリプションストリームでのこのフィールドのバージョンとはわずかに異なります。
Field |
値 | 説明 |
|---|---|---|
owner_funds |
文字列 | このレジャーのすべてのトランザクションの実行後に、このOfferCreateトランザクションを送信するAccountが保有するTakerGets通貨の額。この通貨額がフリーズされているかどうかはチェックされません。 |
考えられるエラー
- [汎用エラータイプ][]のすべて。
invalidParams- 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。lgrNotFound-ledger_hashまたはledger_indexで指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。noPermission-fullまたはaccountsをtrueとして指定したが、管理者としてサーバに接続していない場合（通常、管理者はローカルポートで接続する必要があります）。
{% raw-partial file="/docs/_snippets/common-links.md" /%}