diff --git a/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.ja.md b/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.ja.md index 7c7c38d3ee..20f261b54a 100644 --- a/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.ja.md +++ b/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.ja.md @@ -7,15 +7,50 @@ label: - データ保持 --- # ledger_entry -[[ソース]](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/LedgerEntry.cpp "Source") +[[ソース]](https://github.com/xrplf/rippled/blob/master/src/ripple/rpc/handlers/LedgerEntry.cpp "Source") `ledger_entry`メソッドは、XRP Ledgerの1つのレジャーオブジェクトを生フォーマットで返します。取得可能な各種オブジェクトについては、[レジャーフォーマット][]を参照してください。 -**注記:** このメソッドのコマンドラインバージョンはありません。代わりに[jsonメソッド][]を使用してコマンドラインからこのメソッドにアクセスできます。 - ## 要求フォーマット -要求フォーマットの例: +このメソッドは複数の異なる種類のデータを取得することができます。以下に記載されている一般的なフィールドと特定のタイプのフィールドで構成される適切なパラメータを渡し、標準の[リクエストフォーマット](request-formatting.html)に従うことで、取得するアイテムの種類を選択できます。(例えば、WebSocketリクエストは常に`command`フィールドとオプションで`id`フィールドを持ち、JSON-RPCリクエストは`method`フィールドと`params`フィールドを使います)。 + +{% include '_snippets/no-cli-syntax.ja.md' %} + +### 一般的なフィールド + +| フィールド | 型 | 説明 | +|:------------------------|:-----------------------|:----------------------| +| `binary` | ブール値 | _（省略可）_ `true`の場合、要求したレジャーオブジェクトの内容がXRPレジャーの[バイナリ形式](serialization.html)の16進数の文字列として返されます。それ以外の場合はデータがJSONフォーマットで返されます。デフォルトは`false`です。[更新: rippled 1.2.0][] | +| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進数の文字列。（[レジャーの指定][]を参照してください | +| `ledger_index` | 文字列 または 符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列("validated"や"closed"、"current"など)。（[レジャーの指定][]を参照してください） | + +`generator`と`ledger`パラメータは非推奨であり、予告なく削除される可能性があります。 + +上記の一般的なフィールドに加えて、オブジェクトを取得するタイプを示すために、以下のフィールドのうち *正確に1つ* を指定する必要があります。有効なフィールドは以下のとおりです。 + +- [`index`](#idからレジャーオブジェクトを取得する) +- [`account_root`](#accountrootオブジェクトを取得する) +- [`directory`](#directorynodeオブジェクトを取得する) +- [`offer`](#offerオブジェクトを取得する) +- [`ripple_state`](#ripplestateオブジェクトを取得する) +- [`check`](#checkオブジェクトを取得する) +- [`escrow`](#escrowオブジェクトを取得する) +- [`payment_channel`](#paychannelオブジェクトを取得する) +- [`deposit_preauth`](#depositpreauthオブジェクトを取得する) +- [`ticket`](#ticketオブジェクトを取得する) +- [`nft_page`](#nft-pageを取得する) + +**注意:** リクエストでこれらの型固有のフィールドを1つ以上指定した場合、サーバはそのうちの1つだけの結果を取得します。サーバがどれを選択するかは定義されていないため、こうした行為は避けるべきです。 + + +### IDからレジャーオブジェクトを取得する + +ユニークな ID を使用して、任意のタイプのレジャーオブジェクトを取得します。 + +| フィールド | 型 | 説明 | +|:---------|:-------|:----------------------------------------------------------| +| `index` | 文字列 | レジャーから取得する1オブジェクトの[オブジェクトID](ledger-object-ids.html)を、64文字(256ビット)の16進数の文字列。 | @@ -23,10 +58,8 @@ label: ```json { - "id": 3, "command": "ledger_entry", - "type": "account_root", - "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "index": "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4", "ledger_index": "validated" } ``` @@ -38,65 +71,39 @@ label: "method": "ledger_entry", "params": [ { - "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "ledger_index": "validated", - "type": "account_root" + "index": "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4", + "ledger_index": "validated" } ] } ``` +*コマンドライン* + +```sh +rippled json ledger_entry '{ "index": "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4", "ledger_index": "validated" }' +``` + -[試してみる >](websocket-api-tool.html#ledger_entry) +[試してみる >](websocket-api-tool.html#ledger_entry-by-object-id) -このメソッドでは各種データを取得できます。取得するアイテムのタイプを選択するには、当該のパラメーターを渡します。具体的には、以下のフィールドのいずれか1つを指定します。 +> **ヒント:** このタイプのリクエストは、レジャーデータにシングルトンオブジェクトが存在する場合、そのIDは常に同一であるため、任意のシングルトンオブジェクトを取得するために使用できます。たとえば +> +> - [`Amendments`](amendments-object.html) - `7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4` +> - [`FeeSettings`](feesettings.html) - `4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651` +> - [Recent History `LedgerHashes`](ledgerhashes.html) - `B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66B` +> - [`NegativeUNL`](negativeunl.html) - `2E8A59AA9D3B5B186B0B9E0F62E6C02587CA74A4D778938E957B6357D364B244` -1. `index` - 一意のIDを指定して任意のタイプのレジャーオブジェクトを取得します。 -2. `account_root` - [AccountRootオブジェクト](accountroot.html)を取得します。これは[account_infoメソッド][]とほぼ同等です。 -3. `directory` - 他のレジャーオブジェクトのリストが含まれている[DirectoryNode](directorynode.html)を取得します。 -4. `offer` - 通貨取引オファーを定義する[Offerオブジェクト](offer.html)を取得します。 -5. `ripple_state` - 2つのアカウント間の（XRP以外の）通貨の残高を追跡する[RippleStateオブジェクト](ripplestate.html)を取得します。 -6. `check` - 受取人が現金化できる支払いである[Checkオブジェクト](check.html)を取得します。[新規: rippled 1.0.0][] -7. `escrow` - 特定の時刻または条件に一致するまでXRPを保有する[Escrowオブジェクト](escrow-object.html)を取得します。[新規: rippled 1.0.0][] -8. `payment_channel` - 非同期支払いのためにXRPを保有する[PayChannelオブジェクト](paychannel.html)を取得します。[新規: rippled 1.0.0][] -9. `deposit_preauth` - [Deposit Authorization](depositauth.html)を必要とするアカウントへの支払いの事前承認を追跡する[DepositPreauthオブジェクト](depositpreauth-object.html)を取得します。[新規: rippled 1.1.0][] -上記のアイテムを複数指定すると、サーバーはそのうちの1つのみを取得します。どのアイテムが取得されるかは未定義です。 -このメソッドで認識されるすべてのパラメーターのリストを次に示します。 +### AccountRootオブジェクトを取得する -| `Field` | 型 | 説明 | -|:------------------------|:---------------------------|:----------------------| -| `index` | 文字列 | _（省略可）_ レジャーから取得する1つのオブジェクトの[オブジェクトID](ledger-object-ids.html)を指定します。 | -| `account_root` | 文字列 - [アドレス][] | _（省略可）_ 取得する[AccountRootオブジェクト](accountroot.html)を指定します。 | -| `check` | 文字列 | _（省略可）_ レジャーから取得する[Checkオブジェクト](check.html)の[オブジェクトID](ledger-object-ids.html)を指定します。 | -| `deposit_preauth` | オブジェクトまたは文字列 | _（省略可）_ 取得する[DepositPreauthオブジェクト](depositpreauth-object.html)を指定します。文字列の場合はDepositPreauthオブジェクトの[オブジェクトID](ledger-object-ids.html)（16進数）である必要があります。オブジェクトの場合は`owner`および`authorized`サブフィールドが必要です。 | -| `deposit_preauth.owner` | 文字列 - [アドレス][] | _（`deposit_preauth`がオブジェクトとして指定されている場合に必須）_ 事前承認を提供したアカウント。 | -| `deposit_preauth.authorized` | 文字列 - [アドレス][] | _（`deposit_preauth`がオブジェクトとして指定されている場合に必須）_ 事前承認を受けたアカウント。 | -| `directory` | オブジェクトまたは文字列 | _（省略可）_ 取得する[DirectoryNode](directorynode.html)を指定します。文字列の場合はディレクトリーの[オブジェクトID](ledger-object-ids.html)（16進数）である必要があります。オブジェクトの場合はサブフィールドとして`dir_root`または`owner`のいずれかが必要です。また必要に応じて`sub_index`サブフィールドを指定できます。 | -| `directory.sub_index` | 符号なし整数 | _（省略可）_ 指定されている場合は、[DirectoryNode](directorynode.html)の後のページにジャンプします。 | -| `directory.dir_root` | 文字列 | _（`directory`がオブジェクトとして指定されており、`directory.owner`が指定されていない場合に必須）_ 取得するディレクトリーを識別する一意のインデックス（16進数）。 | -| `directory.owner` | 文字列 | _（`directory`がオブジェクトとして指定されており、`directory.dir_root`が指定されていない場合に必須）_ このディレクトリーに関連付けられているアカウントの一意のアドレス。 | -| `escrow` | オブジェクトまたは文字列 | _（省略可）_ 取得する[Escrowオブジェクト](escrow-object.html)を指定します。文字列の場合はEscrowの[オブジェクトID](ledger-object-ids.html)（16進数）である必要があります。オブジェクトの場合は`owner`および`seq`サブフィールドが必要です。 | -| `escrow.owner` | 文字列 - [アドレス][] | _（`escrow`がオブジェクトとして指定されている場合に必須）_ Escrowオブジェクトの所有者（送金元）。 | -| `escrow.seq` | 符号なし整数 | _（`escrow`がオブジェクトとして指定されている場合に必須）_ Escrowオブジェクトを作成したトランザクションのシーケンス番号。 | -| `offer` | オブジェクトまたは文字列 | _（省略可）_ 取得する[Offer オブジェクト](offer.html)を指定します。文字列の場合はOfferの[一意のインデックス](ledgers.html#ツリーの形式)として解釈されます。オブジェクトの場合は、オファーを一意に識別するためサブフィールド`account`と`seq`が必要です。 | -| `offer.account` | 文字列 - [アドレス][] | _（`offer`が指定されている場合に必須）_ オファーを出したアカウント。 | -| `offer.seq` | 符号なし整数 | _（`offer`が指定されている場合に必須）_ Offerオブジェクトを作成したトランザクションのシーケンス番号。 | -| `payment_channel` | 文字列 | _（省略可）_ 取得する[PayChannel オブジェクト](paychannel.html)の[オブジェクトID](ledger-object-ids.html)を指定します。 | -| `ripple_state` | オブジェクト | _（省略可）_ 取得するRippleState（トラストライン）オブジェクトを指定するオブジェクト。取得するRippleStateエントリを一意に指定するため、`accounts`および`currency`サブフィールドが必要です。 | -| `ripple_state.accounts` | 配列 | _（`ripple_state`が指定されている場合に必須）_ アカウントの[アドレス][]からなる長さ2の配列。この[RippleStateオブジェクト](ripplestate.html)によりリンクされる2つのアカウントを定義します。 | -| `ripple_state.currency` | 文字列 | _（`ripple_state`が指定されている場合に必須）_ 取得する[RippleStateオブジェクト](ripplestate.html)の[通貨コード][]。 | | -| `binary` | ブール値 | _（省略可）_ trueの場合、要求したレジャーオブジェクトの内容が16進文字列として返されます。それ以外の場合はデータがJSONフォーマットで返されます。デフォルトは`false`です。[更新: rippled 1.2.0][] | -| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） | -| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） | +アドレスから[AccountRootオブジェクト](accountroot.html)を取得します。これは[account_infoメソッド][]とほぼ同じです。 -`generator`パラメーターと`ledger`パラメーターは廃止予定であり、今後予告なしに削除される可能性があります。 - -## 応答フォーマット - -処理が成功した応答の例: +| フィールド | 型 | 説明 | +|:----------- ---|:--------------------|:----------------------| +| `account_root` | 文字列 - [アドレス][] | 取得する[AccountRootオブジェクト](accountroot.html)の標準アドレス。 | @@ -104,24 +111,543 @@ label: ```json { - "id": 3, - "result": { - "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05", - "ledger_index": 6889347, - "node": { - "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "Balance": "27389517749", - "Flags": 0, - "LedgerEntryType": "AccountRoot", - "OwnerCount": 18, - "PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932", - "PreviousTxnLgrSeq": 6592159, - "Sequence": 1400, - "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05" + "id": "example_get_accountroot", + "command": "ledger_entry", + "account_root": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [ + { + "account_root": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "ledger_index": "validated" } + ] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-accountroot) + + + +### DirectoryNodeオブジェクトを取得する + +他のレジャーオブジェクトのリストを含む[DirectoryNode](directorynode.html)を取得します。文字列(DirectoryのオブジェクトID)またはオブジェクトを指定します。 + +| フィールド | 型 | 説明 | +|:------------------------|:---------------------------|:----------------------| +| `directory` | オブジェクト または 文字列 | 取得する[DirectoryNode](directorynode.html)。文字列の場合は、ディレクトリの[オブジェクトID](ledger-object-ids.html)を16進数で指定します。オブジェクトの場合は、サブフィールドとして`dir_root`または`owner`が必要で、オプションとして`sub_index`サブフィールドを指定可能です。 | +| `directory.sub_index` | 符号なし整数 | _(省略可)_ 指定された場合、その"ページ"以降の[DirectoryNode](directorynode.html)にジャンプします。 | +| `directory.dir_root` | 文字列 | _(省略可)_ 取得するディレクトリを表す一意のインデックス。 | +| `directory.owner` | 文字列 | _(省略可)_ このディレクトリに関連付けられているアカウントの一意のアドレス。 | + + + +*WebSocket* + +```json +{ + "id": 3, + "command": "ledger_entry", + "directory": { + "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "sub_index": 0 + }, + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [ + { + "directory": { + "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "sub_index": 0 + }, + "ledger_index": "validated" + } + ] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "directory": { "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "sub_index": 0 }, "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-directorynode) + + + +### Offerオブジェクトを取得する + +通貨交換のオファーを定義した [Offer オブジェクト](offer.html) を取得します。文字列 (オファーの一意なインデックス) あるいはオブジェクトを指定します。 + +| フィールド | 型 | 説明 | +|:------------------------|:---------------------------|:----------------------| +| `offer` | オブジェクトまたは 文字列 | 取得する[オファーオブジェクト](offer.html)。文字列の場合、オファーに対する[一意のオブジェクトID](ledgers.html#ツリーの形式)を指定します。オブジェクトの場合、オファーを一意に識別するためのサブフィールド`account`と`seq`を指定します。 | +| `offer.account` | 文字列 - [アドレス][] | _(`offer`がオブジェクト形式で指定されている場合、必須)_ オファーを作成したアカウント。 | +| `offer.seq` | 符号なし整数 | _(`offer`がオブジェクト形式で指定されている場合、必須)_ オファーオブジェクトを作成したトランザクションの[シーケンス番号][]。 | + + + +*WebSocket* + +```json +{ + "id": "example_get_offer", + "command": "ledger_entry", + "offer": { + "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "seq": 359 + }, + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [ + { + "offer": { + "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "seq": 359 + }, + "ledger_index": "validated" + } + ] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "offer": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "seq": 359}, "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-offer) + + + +### RippleStateオブジェクトを取得する + +2つのアカウント間の（XRP以外の）通貨残高を追跡する[RippleStateオブジェクト](ripplestate.html)を取得します。 + +| フィールド | 型 | 説明 | +|:------------------------|:---------------------------|:----------------------| +| `ripple_state` | オブジェクト | 取得するRippleState(trust line)オブジェクトを指定するオブジェクト。取得するRippleStateエントリを一意に指定するには、`accounts`と`currency`のサブフィールドが必要です。 | +| `ripple_state.accounts` | 配列 | _(`ripple_state`が指定されている場合、必須)_ この[RippleStateオブジェクト](ripplestate.html)によってリンクされた2つのアカウントを長さ2の配列で指定します。 | +| `ripple_state.currency` | 文字列 | _(`ripple_state`が指定されている場合、必須)_ 取得する[RippleStateオブジェクト](ripplestate.html)の[通貨コード][]を指定します。 | + + + +*WebSocket* + +```json +{ + "id": "example_get_ripplestate", + "command": "ledger_entry", + "ripple_state": { + "accounts": [ + "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW" + ], + "currency": "USD" + }, + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [{ + "ripple_state": { + "accounts": [ + "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW" + ], + "currency": "USD" }, - "status": "success", - "type": "response" + "ledger_index": "validated" + }] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "ripple_state": { "accounts": ["rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW"], "currency": "USD"}, "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-ripplestate) + + + +### Checkオブジェクトを取得する + +[Checkオブジェクト](check.html)を取得します。[新規: rippled 1.0.0][]. + +| フィールド | 型 | 説明 | +|:---------|:------|:----------------------| +| `check` | 文字列 | 取得する[Checkオブジェクト](check.html)の[オブジェクトID](ledger-object-ids.html)。 | + + + +*WebSocket* + +```json +{ + "id": "example_get_check", + "command": "ledger_entry", + "check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D7944C28B95127C2659C47CBEB", + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [{ + "check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D7944C28B95127C2659C47CBEB", + "ledger_index": "validated" + }] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D7944C28B95127C2659C47CBEB", "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-check) + + + +### Escrowオブジェクトを取得する + +[Escrowオブジェクト](escrow-object.html)を取得します。文字列(エスクローのオブジェクトID)またはオブジェクトとして指定します。[新規: rippled 1.0.0][] + +| フィールド | 型 | 説明 | +|:------------------------|:---------------------------|:----------------------| +| `escrow` | オブジェクト または 文字列 | 取得する[Escrowオブジェクト](escrow-object.html)を指定します。文字列の場合は、エスクローの[オブジェクトID](ledger-object-ids.html)を16進数で指定します。オブジェクトの場合、`owner`と`seq`サブフィールドを指定します。. | +| `escrow.owner` | 文字列 - [アドレス][] | _(`escrow`がオブジェクト形式で指定されている場合、必須)_ Escrowオブジェクトの所有者（送信者）。 | +| `escrow.seq` | 符号なし整数 | _(`escrow`がオブジェクト形式で指定されている場合、必須)_ エスクローオブジェクトを作成したトランザクションの[シーケンス番号][]。 | + + + +*WebSocket* + +```json +{ + "id": "example_get_escrow", + "command": "ledger_entry", + "escrow": { + "owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9NTjKK", + "seq": 126 + }, + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [{ + "escrow": { + "owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9NTjKK", + "seq": 126 + }, + "ledger_index": "validated" + }] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "escrow": { "owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9NTjKK", "seq": 126 }, "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-escrow) + + + +### PayChannelオブジェクトを取得する + +非同期決済用のXRPを保持する[PayChannelオブジェクト](paychannel.html)を取得します。[新規: rippled 1.0.0][]. + +| フィールド | 型 | 説明 | +|:------------------|:-------|:------------------------------------------------| +| `payment_channel` | 文字列 | 取得する[PayChannelオブジェクト](paychannel.html)の[オブジェクトID](ledger-object-ids.html)。 | + + + +*WebSocket* + +```json +{ + "id": "example_get_paychannel", + "command": "ledger_entry", + "payment_channel": "C7F634794B79DB40E87179A9D1BF05D05797AE7E92DF8E93FD6656E8C4BE3AE7", + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [{ + "payment_channel": "C7F634794B79DB40E87179A9D1BF05D05797AE7E92DF8E93FD6656E8C4BE3AE7", + "ledger_index": "validated" + }] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "payment_channel": "C7F634794B79DB40E87179A9D1BF05D05797AE7E92DF8E93FD6656E8C4BE3AE7", "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-paychannel) + + +### DepositPreauthオブジェクトを取得する + +[DepositPreauthオブジェクト](depositpreauth-object.html)を取得します。このオブジェクトは、[Deposit Authorization](depositauth.html)を必要とする口座への支払いの事前承認を記録します。文字列（DepositPreauthのオブジェクトID）またはオブジェクトとして指定します。[新規: rippled 1.1.0][]. + +| フィールド | 型 | 説明 | +|:-----------------------------|:-----------------------|:-----------------------| +| `deposit_preauth` | オブジェクト または 文字列 | 取得する[DepositPreauthオブジェクト](depositpreauth-object.html)を指定します。文字列の場合、DepositPreauthオブジェクトの[オブジェクトID](ledger-object-ids.html)を16進数で指定します。オブジェクトの場合、`owner`と`authorized`のサブフィールドを指定します。 | +| `deposit_preauth.owner` | 文字列 - [アドレス][] | _(`deposit_preauth`がオブジェクト形式で指定されている場合、必須)_ 事前承認を行ったアカウント。 | +| `deposit_preauth.authorized` | 文字列 - [アドレス][] | _(`deposit_preauth`がオブジェクト形式で指定されている場合、必須)_ 事前承認を受けたアカウント。 | + + + +*WebSocket* + +```json +{ + "id": "example_get_deposit_preauth", + "command": "ledger_entry", + "deposit_preauth": { + "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "authorized": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX" + }, + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [{ + "deposit_preauth": { + "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "authorized": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX" + }, + "ledger_index": "validated" + }] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "deposit_preauth": { "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "authorized": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX" }, "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-depositpreauth) + + +### Ticketオブジェクトを取得する + +将来の使用のために確保された[シーケンス番号][]を表す[Ticketオブジェクト](ticket.html)を取得します。文字列(TicketのオブジェクトID)またはオブジェクトを指定します。 _([TicketBatch amendment][]により追加されました。)_ + +| フィールド | 型 | 説明 | +|:--------------------|:-----------------------|:----------------------| +| `ticket` | オブジェクト または 文字列 | 取得する[Ticketオブジェクト](ticket.html)。文字列の場合、チケットの[オブジェクトID](ledger-object-ids.html)を16進数で指定します。オブジェクトの場合、チケットエントリを一意に指定するために`account`と`ticket_seq`サブフィールドを指定します。 | +| `ticket.account` | 文字列 - [アドレス][] | _(`ticket`がオブジェクト形式で指定されている場合、必須)_ Ticketオブジェクトの所有者を指定します。 | +| `ticket.ticket_seq` | 数値 | _(`ticket`がオブジェクト形式で指定されている場合、必須)_ 取得するTicketのTicketシーケンス番号を指定します。 | + + + +*WebSocket* + +```json +{ + "id": "example_get_ticket", + "command": "ledger_entry", + "ticket": { + "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "ticket_seq": 389 + }, + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [{ + "ticket": { + "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "ticket_seq": 389 + }, + "ledger_index": "validated" + }] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "ticket": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "ticket_seq: 389 }, "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-ticket) + + +### NFT Pageを取得する + +NFT ページを生のレジャー形式で取得します。 + +| フィールド | 型 | 説明 | +|:------------------------|:-------|:----------------------| +| `nft_page` | 文字列 | 取得する[NFTページ](nftokenpage.html)の[オブジェクトID](ledger-object-ids.html)。 | + + + +*WebSocket* + +```json +{ + "id": "example_get_nft_page", + "command": "ledger_entry", + "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "ledger_entry", + "params": [{ + "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", + "ledger_index": "validated" + }] +} +``` + +*コマンドライン* + +```sh +rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF", "ledger_index": "validated" }' +``` + + + +[試してみる >](websocket-api-tool.html#ledger_entry-nft-page) + +## 応答フォーマット + +レスポンスは[標準フォーマット][]に従って、成功結果には以下のフィールドが含まれます。 + +| フィールド | 型 | 説明 | +|:---------------|:-----------------|:-----------------------------------------| +| `index` | 文字列 | [レジャーオブジェクト](ledger-object-types.html)の一意のID。 | +| `ledger_index` | 符号なし整数 | このデータを取得する際に使用したレジャーの [レジャーインデックス][]。 | +| `node` | オブジェクト | _(`"binary": true`が指定されている場合、省略)_ [レジャーフォーマット][]に基づいた、この元帳オブジェクトのデータを含むオブジェクト。 | +| `node_binary` | 文字列 | _(`"binary": true`が指定されていない場合、省略)_ レジャーオブジェクトの[バイナリ形式](serialization.html)を16進数で表したもの。 | + +処理が成功したレスポンスの例: + + + +*WebSocket* + +```json +{ + "id": "example_get_accountroot", + "result": { + "index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8", + "ledger_hash": "31850E8E48E76D1064651DF39DF4E9542E8C90A9A9B629F4DE339EB3FA74F726", + "ledger_index": 61966146, + "node": { + "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "AccountTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB", + "Balance": "424021949", + "Domain": "6D64756F31332E636F6D", + "EmailHash": "98B4375E1D753E5B91627516F6D70977", + "Flags": 9568256, + "LedgerEntryType": "AccountRoot", + "MessageKey": "0000000000000000000000070000000300", + "OwnerCount": 12, + "PreviousTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB", + "PreviousTxnLgrSeq": 61965653, + "RegularKey": "rD9iJmieYHn8jTtPjwwkW2Wm9sVDvPXLoJ", + "Sequence": 385, + "TransferRate": 4294967295, + "index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8" + }, + "validated": true + }, + "status": "success", + "type": "response" } ``` @@ -131,36 +657,66 @@ label: 200 OK { - "result": { - "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05", - "ledger_index": 8696234, - "node": { - "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "Balance": "13176802787", - "Flags": 0, - "LedgerEntryType": "AccountRoot", - "OwnerCount": 17, - "PreviousTxnID": "E5D0235A236F7CD162C1AB87A0325056AE61CFC63D92D1494AB5D826AAD0CDCA", - "PreviousTxnLgrSeq": 8554742, - "Sequence": 1406, - "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05" - }, - "status": "success", - "validated": true - } + "result": { + "index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8", + "ledger_hash": "395946243EA36C5092AE58AF729D2875F659812409810A63096AC006C73E656E", + "ledger_index": 61966165, + "node": { + "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "AccountTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB", + "Balance": "424021949", + "Domain": "6D64756F31332E636F6D", + "EmailHash": "98B4375E1D753E5B91627516F6D70977", + "Flags": 9568256, + "LedgerEntryType": "AccountRoot", + "MessageKey": "0000000000000000000000070000000300", + "OwnerCount": 12, + "PreviousTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB", + "PreviousTxnLgrSeq": 61965653, + "RegularKey": "rD9iJmieYHn8jTtPjwwkW2Wm9sVDvPXLoJ", + "Sequence": 385, + "TransferRate": 4294967295, + "index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8" + }, + "status": "success", + "validated": true + } +} +``` + +*コマンドライン* + +```json +{ + "result": { + "index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8", + "ledger_hash": "395946243EA36C5092AE58AF729D2875F659812409810A63096AC006C73E656E", + "ledger_index": 61966165, + "node": { + "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "AccountTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB", + "Balance": "424021949", + "Domain": "6D64756F31332E636F6D", + "EmailHash": "98B4375E1D753E5B91627516F6D70977", + "Flags": 9568256, + "LedgerEntryType": "AccountRoot", + "MessageKey": "0000000000000000000000070000000300", + "OwnerCount": 12, + "PreviousTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB", + "PreviousTxnLgrSeq": 61965653, + "RegularKey": "rD9iJmieYHn8jTtPjwwkW2Wm9sVDvPXLoJ", + "Sequence": 385, + "TransferRate": 4294967295, + "index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8" + }, + "status": "success", + "validated": true + } } ``` -この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。 - -| `Field` | 型 | 説明 | -|:---------------|:-----------------|:-----------------------------------------| -| `index` | 文字列 | この[レジャーオブジェクト](ledger-object-types.html)の一意のID。 | -| `ledger_index` | 符号なし整数 | このデータの取得時に使用されたレジャーの[レジャーインデックス][]。 | -| `node` | オブジェクト | _（`"binary": true`が指定されている場合は省略）_[レジャーフォーマット][]に基づく、このレジャーオブジェクトのデータが含まれているオブジェクト。 | -| `node_binary` | 文字列 | _（`"binary":true`が指定されていない場合は省略可）_ レジャーオブジェクトの[バイナリー表現](serialization.html)（16進数）。 | ## 考えられるエラー diff --git a/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md b/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md index ecd202a315..518d0164e0 100644 --- a/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md +++ b/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md @@ -7,7 +7,7 @@ labels: - Data Retention --- # ledger_entry -[[Source]](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/LedgerEntry.cpp "Source") +[[Source]](https://github.com/xrplf/rippled/blob/master/src/ripple/rpc/handlers/LedgerEntry.cpp "Source") The `ledger_entry` method returns a single ledger object from the XRP Ledger in its raw format. See [ledger format][] for information on the different types of objects you can retrieve. @@ -564,7 +564,7 @@ rippled json ledger_entry '{ "ticket": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJ Return an NFT Page in its raw ledger format. -| `Field` | Type | Description | +| Field | Type | Description | |:------------------------|:---------------------------|:----------------------| | `nft_page` | String | The [object ID](ledger-object-ids.html) of an [NFT Page](nftokenpage.html) to retrieve. |