ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-03 01:55:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Japanese translation: add remaining files

Browse Source
This commit is contained in:
mDuo13
2019-10-31 16:36:45 -07:00
parent 10abd4b1cd
commit 430e4f4515
127 changed files with 24166 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

204
content/references/rippled-api/public-rippled-methods/ledger-methods/ledger.ja.md Normal file
View File

@@ -0,0 +1,204 @@
# ledger
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/LedgerHandler.cpp "Source")
公開レジャーに関する情報を取得します。
## 要求フォーマット
要求フォーマットの例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```
{
"id":14,
"command":"ledger",
"ledger_index":"validated",
"full": false,
"accounts": false,
"transactions": false,
"expand": false,
"owner_funds": false
}
```
*JSON-RPC*
```
{
"method":"ledger",
"params":[
{
"ledger_index":"validated",
"accounts": false,
"full": false,
"transactions": false,
"expand": false,
"owner_funds": false
}
]
}
```
*コマンドライン*
```
#Syntax: ledger ledger_index|ledger_hash [full|tx]
# "full" is equivalent to "full": true
# "tx" is equivalent to "transactions": true
rippled ledger current
```
<!-- MULTICODE_BLOCK_END -->
[試してみる >](websocket-api-tool.html#ledger)
要求には以下のパラメーターを含めることができます。
| `Field` | 型 | 説明 |
|:---------------|:---------------------------|:-------------------------------|
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
| `full` | ブール値 | _（省略可）_ **管理者が必要。** `true`の場合、レジャー全体に関するすべての情報が返されます。レジャーバージョンを指定しない場合は無視されます。デフォルトでは`false`です。（これは`transactions`、`accounts`、および`expand`を有効にする操作と同等です。） **注意:** 数百メガバイトのオーダーについて、非常に大量のデータが返されます。 |
| `accounts` | ブール値 | _（省略可）_ **管理者が必要。** `true`の場合、レジャーのアカウントに関する情報が返されます。レジャーバージョンを指定しない場合は無視されます。デフォルトでは`false`です。**注意:** 非常に大量のデータが返されます。 |
| `transactions` | ブール値 | _（省略可）_ `true`の場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトでは`false`です。レジャーバージョンを指定しない場合は無視されます。 |
| `expand` | ブール値 | _（省略可）_ ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方を要求しない場合は無視されます。 |
| `owner_funds` | ブール値 | _（省略可）_ `true`の場合、応答のOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
| `binary` | ブール値 | _（省略可）_ `true`で、かつ`transactions`と`expand`が両方とも`true`の場合、JSONフォーマットではなくバイナリフォーマット（16進文字列）でトランザクション情報が返されます。[新規: rippled 0.28.0][] |
| `queue` | ブール値 | _（省略可）_ `true`で、かつコマンドが`current`レジャーを要求している場合、[キューに入れらているトランザクション](transaction-cost.html#キューに入れられたトランザクション)の配列が結果に含まれます。
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。
## 応答フォーマット
処理が成功した応答の例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```
{
"id":4,
"status":"success",
"type":"response",
"result":{
"ledger":{
"accepted": true,
"account_hash":"FD2709F6C07284C3EE85EDE32AC452D9013A89D9B9E781D67D9784457E86A9BB",
"close_flags":0,
"close_time":508541181,
"close_time_human":"2016-Feb-11 21:26:21",
"close_time_resolution":10,
"closed": true,
"hash":"F1433E9D15F33E746B8820DEEE4879F48181704364E459332561DF8E52E4EB7E",
"ledger_hash":"F1433E9D15F33E746B8820DEEE4879F48181704364E459332561DF8E52E4EB7E",
"ledger_index":"18851530",
"parent_close_time":508541180,
"parent_hash":"8300B70AA5A865961DED7DAC5B88047028762D5946ECA887D09D32DE442E2305",
"seqNum":"18851530",
"totalCoins":"99998102799411646",
"total_coins":"99998102799411646",
"transaction_hash":"E0DB0471A1D198611E1C050ADA4AE74EEB38CEC26E0550663E0FCB1364212A3B"
},
"ledger_hash":"F1433E9D15F33E746B8820DEEE4879F48181704364E459332561DF8E52E4EB7E",
"ledger_index":18851530,
"validated": true
}
}
```
*JSON-RPC*
```
200 OK
{
"result":{
"ledger":{
"accepted": true,
"account_hash":"B089E7CD4F5167249951611AAEC863D4BF84FF098500E9CB50561F1A89EED825",
"close_flags":0,
"close_time":508541222,
"close_time_human":"2016-Feb-11 21:27:02",
"close_time_resolution":10,
"closed": true,
"hash":"85E6D422F1A3AE0BEA315C4F09CD0B45022312A4BBF0D308246E901536B61157",
"ledger_hash":"85E6D422F1A3AE0BEA315C4F09CD0B45022312A4BBF0D308246E901536B61157",
"ledger_index":"18851543",
"parent_close_time":508541221,
"parent_hash":"C382DB117F2D5AAECFBFB43EA509F8E56D6E1D1297CE00C0D02A3EE695ABB78F",
"seqNum":"18851543",
"totalCoins":"99998102795090646",
"total_coins":"99998102795090646",
"transaction_hash":"BEC71A3CAD11BFC4E4013CD109F220E0850E9A3808B15FAA6DAE4D898970EFAF"
},
"ledger_hash":"85E6D422F1A3AE0BEA315C4F09CD0B45022312A4BBF0D308246E901536B61157",
"ledger_index":18851543,
"status":"success",
"validated": true
}
}
```
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果にレジャーに関する情報を表す次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:-------------------------------|:--------|:----------------------------------|
| `ledger` | オブジェクト | このレジャーの完全なヘッダーデータ。 |
| `ledger.account_hash` | 文字列 | このレジャーのすべてのアカウント状態情報のハッシュ（16進数） |
| `ledger.accountState` | 配列 | （要求されていない場合は省略）このレジャーのすべての[アカウント状態情報](ledger-data-formats.html)。 |
| `ledger.close_flags` | 整数 | このレジャーの閉鎖に関連するフラグのビットマップ。現在、レジャーでは1つのフラグだけが`close_flags`として定義されています（**sLCF_NoConsensusTime**（値1））。このフラグが有効な場合、レジャーの正確な閉鎖時刻についてバリデータの間で意見が対立しましたが、作成しているレジャーは同一のものであるため、バリデータは閉鎖時刻について「合意をしないことに合意する」とした上でコンセンサスを宣言しました。この場合、コンセンサスレジャーの`close_time`の値は直前のバージョンの閉鎖時刻の1秒後です。（この場合、正式な閉鎖時刻がありませんが、実際の閉鎖時刻はおそらく指定されている`close_time`の3～6秒後です。） |
| `ledger.close_time` | 整数 | レジャーが閉鎖された時刻（[Rippleエポック以降の経過秒数][]） |
| `ledger.close_time_human` | 文字列 | 人間が読めるフォーマットでのこのレジャーが閉鎖された時刻 |
| `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として指定されていたかどうかによって決まります。[FeeEscalation Amendment][]が必要です。[新規: rippled 0.70.0][] |
以下のフィールドは廃止予定であり、今後予告なしに削除される可能性があります。`accepted`、`hash`（代わりに`ledger_hash`を使用）、`seqNum`（代わりに`ledger_index`を使用）、`totalCoins`（代わりに`total_coins`を使用）。
`queue_data`配列の各メンバーは、キュー内の1つのトランザクションを表します。このオブジェクトの一部フィールドは、まだ計算されていないために省略されることがあります。このオブジェクトのフィールドを次に示します。
| フィールド | 値 | 説明 |
|:--------------------|:-----------------|:------------------------------------|
| `account` | 文字列 | このキューに入れられたトランザクションの送信者の[アドレス][]。 |
| `tx` | 文字列またはオブジェクト | デフォルトでは、これはトランザクションの[識別用ハッシュ](basic-data-types.html#ハッシュ)を含む文字列です。トランザクションがバイナリフォーマットで展開されている場合、これは`tx_blob`が唯一のフィールドであるオブジェクトであり、バイナリー形式のトランザクションが10進文字列として含まれています。トランザクションがJSONフォーマットで展開されている場合、これは`hash`フィールドにトランザクションの識別用ハッシュが指定されている[トランザクションオブジェクト](transaction-formats.html)を含むオブジェクトです。 |
| `retries_remaining` | 数値 | このトランザクションの再試行可能回数。この回数を超えるとトランザクションが除外されます。 |
| `preflight_result` | 文字列 | 初期トランザクションチェックの一時的な結果。これは常に`tesSUCCESS`です。 |
| `last_result` | 文字列 | _（省略される場合があります）_[再試行可能な (`ter`) の結果](ter-codes.html)を取得した後でこのトランザクションがキューに残っている場合、これは取得した正確な`ter`結果コードです。 |
| `auth_change` | ブール値 | _（省略される場合があります）_ このトランザクションがこのアドレスの[トランザクション承認方法](transaction-basics.html#取引の承認)を変更するかどうかを示します。 |
| `fee` | 文字列 | _（省略される場合があります）_ このトランザクションの[トランザクションコスト](transaction-cost.html)（[XRPのdrop数][]）。 |
| `fee_level` | 文字列 | _（省略される場合があります）_ このタイプのトランザクションの最少コストと比較した、このトランザクションのトランザクションコスト（[手数料レベル][]）。 |
| `max_spend_drops` | 文字列 | _（省略される場合があります）_ このトランザクションで送信または消却できる[XRP、drop単位][]の最高額。 |
要求に`"owner_funds": true`が指定されておりトランザクションが展開されている場合、応答には、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](offers.html#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](subscribe.html#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
| `Field` | 値 | 説明 |
|:--------------|:-------|:----------------------------------------------------|
| `owner_funds` | 文字列 | このレジャーのすべてのトランザクションの実行後に、このOfferCreateトランザクションを送信する`Account`が保有する`TakerGets`通貨の額。この通貨額が[凍結](freezes.html)されているかどうかはチェックされません。 |
## 考えられるエラー
* [一般的なエラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
* `noPermission` - `full`または`accounts`をtrueとして指定したが、管理者としてサーバーに接続していない場合（通常、管理者はローカルポートで接続する必要があります）。
<!-- TODO: we should add this fee levels link to rippled-api-links.md. server_state.md is also including this as a one-off.-->
[手数料レベル]: transaction-cost.html#手数料レベル
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

91
content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_closed.ja.md Normal file
View File

@@ -0,0 +1,91 @@
# ledger_closed
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/LedgerClosed.cpp "Source")
`ledger_closed`メソッドは、最新の閉鎖済みレジャーの一意のIDを返します。（このレジャーは必ずしも検証済みで変更不可能ではありません。）
## 要求フォーマット
要求フォーマットの例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```
{
"id":2,
"command":"ledger_closed"
}
```
*JSON-RPC*
```
{
"method":"ledger_closed",
"params":[
{}
]
}
```
*コマンドライン*
```
#Syntax: ledger_closed
rippled ledger_closed
```
<!-- MULTICODE_BLOCK_END -->
[試してみる >](websocket-api-tool.html#ledger_closed)
このメソッドはパラメーターを受け入れません。
## 応答フォーマット
処理が成功した応答の例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```
{
"id":1,
"status":"success",
"type":"response",
"result":{
"ledger_hash":"17ACB57A0F73B5160713E81FE72B2AC9F6064541004E272BD09F257D57C30C02",
"ledger_index":6643099
}
}
```
*JSON-RPC*
```
200 OK
{
"result":{
"ledger_hash":"8B5A0C5F6B198254A6E411AF55C29EE40AA86251D2E78DD0BB17647047FA9C24",
"ledger_index":8696231,
"status":"success"
}
}
```
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-----------------|:-----------------------------------------|
| `ledger_hash` | 文字列 | レジャーの一意のハッシュを示す20バイトの16進文字列。 |
| `ledger_index` | 符号なし整数 | このレジャーのシーケンス番号 |
## 考えられるエラー
* [一般的なエラータイプ][]のすべて。
{% include '_snippets/rippled_versions.md' %}
{% include '_snippets/rippled-api-links.md' %}

92
content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_current.ja.md Normal file
View File

@@ -0,0 +1,92 @@
# ledger_current
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/LedgerCurrent.cpp "Source")
`ledger_current`メソッドは、現在進行中のレジャーの一意のIDを返します。このコマンドで返されるレジャーは確定されたものではないため、このコマンドは主にテストに有用です。
## 要求フォーマット
要求フォーマットの例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```
{
"id":2,
"command":"ledger_current"
}
```
*JSON-RPC*
```
{
"method":"ledger_current",
"params":[
{}
]
}
```
*コマンドライン*
```
#Syntax: ledger_current
rippled ledger_current
```
<!-- MULTICODE_BLOCK_END -->
[試してみる >](websocket-api-tool.html#ledger_current)
この要求にはパラメーターは含まれていません。
## 応答フォーマット
処理が成功した応答の例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```
{
"id":2,
"status":"success",
"type":"response",
"result":{
"ledger_current_index":6643240
}
}
```
*JSON-RPC*
```
200 OK
{
"result":{
"ledger_current_index":8696233,
"status":"success"
}
}
```
<!-- MULTICODE_BLOCK_END -->
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:-----------------------|:-----------------|:-------------------------------|
| `ledger_current_index` | 符号なし整数 | このレジャーのシーケンス番号 |
現行レジャーのハッシュは、レジャーの内容とともに常に変化するため、`ledger_hash`フィールドはありません。
## 考えられるエラー
* [一般的なエラータイプ][]のすべて。
{% include '_snippets/rippled_versions.md' %}
{% include '_snippets/rippled-api-links.md' %}

261
content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_data.ja.md Normal file
View File

@@ -0,0 +1,261 @@
# ledger_data
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/LedgerData.cpp "Source")
`ledger_data`メソッドは指定されたレジャーの内容を取得します。1つのレジャーバージョンの内容全体を取得するため、複数のコールを繰り返し実行できます。
## 要求フォーマット
要求フォーマットの例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```
{
"id":2,
"ledger_hash":"842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
"command":"ledger_data",
"limit":5,
"binary": true
}
```
*JSON-RPC*
```
{
"method":"ledger_data",
"params":[
{
"binary": true,
"ledger_hash":"842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
"limit":5
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
**注記:**`ledger_data`のコマンドライン構文はありません。代わりに[jsonメソッド][]を使用してコマンドラインからこのメソッドにアクセスできます。
要求には以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-------------------------------------------|:---------------|
| `id` | （任意） | （WebSocketのみ）応答が遅延して順不同になる場合にこの要求を他の要求と区別するためのID。 |
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
| `binary` | ブール値 | （省略可、デフォルトではfalseです）trueに設定すると、レジャーオブジェクトがJSONではなくハッシュされた16進文字列として返されます。 |
| `limit` | 整数 | （省略可、デフォルト値は可変）取得するレジャーオブジェクトの数を制限します。サーバーはこの値に従う必要はありません。 |
| `marker` | [マーカー][] | 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。
## 応答フォーマット
処理が成功した応答の例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket (binary:true)*
```
{
"id":2,
"result":{
"ledger_hash":"842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
"ledger_index":"6885842",
"marker":"0002A590029B53BE7857EFF9985F770EC792CE483720EB5E963C4D6A607D43DF",
"state":[
{
"data":"11006122000000002400000001250062FEA42D0000000055C204A65CF2542946289A3358C67D991B5E135FABFA89F271DBA7A150C08CA0466240000000354540208114C909F42250CFE8F12A7A1A0DFBD3CBD20F32CD79",
"index":"00001A2969BE1FC85F1D7A55282FA2E6D95C71D2E4B9C0FDD3D9994F3C00FF8F"
},
{
"data":"11006F22000000002400000003250035788533000000000000000034000000000000000055555B93628BF3EC318892BB7C7CDCB6732FF53D12B6EEC4FAF60DD1AEE1C6101F501071633D7DE1B6AEB32F87F1A73258B13FC8CC32942D53A66D4F038D7EA4C6800064D4838D7EA4C68000000000000000000000000000425443000000000035DD7DF146893456296BF4061FBE68735D28F3286540000000000F42408114A4B8F5F7B644AEDC3447F9459C132EEB016A133B",
"index":"000037C6659BB98F8D09F2F4CFEB27DE8EFEAFE54DD9E1C13AECDF5794B0C0F5"
},
{
"data":"11006F2200020000240000000A250067395C33000000000000000034000000000000000055A160BC41A45B6BB118DF23D77E4FF23C723431B917F50DCB41319ECC2821F34C5010DFA3B6DDAB58C7E8E5D944E736DA4B7046C30E4F460FD9DE4C1AA535D3D0C00064D554C88B43EFA00000000000000000000000000055534400000000000A20B3C85F482532A9578DBB3950B85CA06594D165400000B59B9F780081148366FB9ACD2A0FD822E31112D2EB6F98C317C2C1",
"index":"0000A8791F78CC9B39200E12A9BDAACCF40A72A512FA815525CFC9BA772990F7"
},
{
"data":"1100612200000000240000000125003E742F2D0000000055286498B513710CFEB2D723A554C7557983D1952DF4DEE342C40DCB43067C9A21624000000306DC42008114225BAB89C4A4B94624BB069D6DB3C819F934991C",
"index":"0000B717320558E2DE1A3B9FDB24E9A695BF05D1A44E4A4683212BB1DD0FBA23"
},
{
"data":"110072220002000025000B65783700000000000000003800000000000000005587591A63051645F37B85D1FBA55EE69B1C96BFF16904F5C99F03FB93D42D03756280000000000000000000000000000000000000004254430000000000000000000000000000000000000000000000000166800000000000000000000000000000000000000042544300000000000A20B3C85F482532A9578DBB3950B85CA06594D167D4C38D7EA4C680000000000000000000000000004254430000000000C795FDF8A637BCAAEDAD1C434033506236C82A2D",
"index":"000103996A3BAD918657F86E12A67D693E8FC8A814DA4B958A244B5F14D93E58"
}
]
},
"status":"success",
"type":"response"
}
```
*WebSocket (binary:false)*
```
{
"id":2,
"result":{
"ledger_hash":"842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
"ledger_index":"6885842",
"marker":"0002A590029B53BE7857EFF9985F770EC792CE483720EB5E963C4D6A607D43DF",
"state":[
{
"Account":"rKKzk9ghA2iuy3imqMXUHJqdRPMtNDGf4c",
"Balance":"893730848",
"Flags":0,
"LedgerEntryType":"AccountRoot",
"OwnerCount":0,
"PreviousTxnID":"C204A65CF2542946289A3358C67D991B5E135FABFA89F271DBA7A150C08CA046",
"PreviousTxnLgrSeq":6487716,
"Sequence":1,
"index":"00001A2969BE1FC85F1D7A55282FA2E6D95C71D2E4B9C0FDD3D9994F3C00FF8F"
},
{
"Account":"rGryPmNWFognBgMtr9k4quqPbbEcCrhNmD",
"BookDirectory":"71633D7DE1B6AEB32F87F1A73258B13FC8CC32942D53A66D4F038D7EA4C68000",
"BookNode":"0000000000000000",
"Flags":0,
"LedgerEntryType":"Offer",
"OwnerNode":"0000000000000000",
"PreviousTxnID":"555B93628BF3EC318892BB7C7CDCB6732FF53D12B6EEC4FAF60DD1AEE1C6101F",
"PreviousTxnLgrSeq":3504261,
"Sequence":3,
"TakerGets":"1000000",
"TakerPays":{
"currency":"BTC",
"issuer":"rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK",
"value":"1"
},
"index":"000037C6659BB98F8D09F2F4CFEB27DE8EFEAFE54DD9E1C13AECDF5794B0C0F5"
},
{
"Account":"rUy8tW38MW9ma7kSjRgB2GHtTkQAFRyrN8",
"BookDirectory":"DFA3B6DDAB58C7E8E5D944E736DA4B7046C30E4F460FD9DE4C1AA535D3D0C000",
"BookNode":"0000000000000000",
"Flags":131072,
"LedgerEntryType":"Offer",
"OwnerNode":"0000000000000000",
"PreviousTxnID":"A160BC41A45B6BB118DF23D77E4FF23C723431B917F50DCB41319ECC2821F34C",
"PreviousTxnLgrSeq":6764892,
"Sequence":10,
"TakerGets":"780000000000",
"TakerPays":{
"currency":"USD",
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value":"5850"
},
"index":"0000A8791F78CC9B39200E12A9BDAACCF40A72A512FA815525CFC9BA772990F7"
},
{
"Account":"rh3C81VfNDhhWPQWCU8ZGgknvdgNUvRtM9",
"Balance":"13000000000",
"Flags":0,
"LedgerEntryType":"AccountRoot",
"OwnerCount":0,
"PreviousTxnID":"286498B513710CFEB2D723A554C7557983D1952DF4DEE342C40DCB43067C9A21",
"PreviousTxnLgrSeq":4092975,
"Sequence":1,
"index":"0000B717320558E2DE1A3B9FDB24E9A695BF05D1A44E4A4683212BB1DD0FBA23"
},
{
"Balance":{
"currency":"BTC",
"issuer":"rrrrrrrrrrrrrrrrrrrrBZbvji",
"value":"0"
},
"Flags":131072,
"HighLimit":{
"currency":"BTC",
"issuer":"rKUK9omZqVEnraCipKNFb5q4tuNTeqEDZS",
"value":"10"
},
"HighNode":"0000000000000000",
"LedgerEntryType":"RippleState",
"LowLimit":{
"currency":"BTC",
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value":"0"
},
"LowNode":"0000000000000000",
"PreviousTxnID":"87591A63051645F37B85D1FBA55EE69B1C96BFF16904F5C99F03FB93D42D0375",
"PreviousTxnLgrSeq":746872,
"index":"000103996A3BAD918657F86E12A67D693E8FC8A814DA4B958A244B5F14D93E58"
}
]
},
"status":"success",
"type":"response"
}
```
*JSON-RPC (binary:true)*
```
200 OK
{
"result":{
"ledger_hash":"842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
"ledger_index":"6885842",
"marker":"0002A590029B53BE7857EFF9985F770EC792CE483720EB5E963C4D6A607D43DF",
"state":[
{
"data":"11006122000000002400000001250062FEA42D0000000055C204A65CF2542946289A3358C67D991B5E135FABFA89F271DBA7A150C08CA0466240000000354540208114C909F42250CFE8F12A7A1A0DFBD3CBD20F32CD79",
"index":"00001A2969BE1FC85F1D7A55282FA2E6D95C71D2E4B9C0FDD3D9994F3C00FF8F"
},
{
"data":"11006F22000000002400000003250035788533000000000000000034000000000000000055555B93628BF3EC318892BB7C7CDCB6732FF53D12B6EEC4FAF60DD1AEE1C6101F501071633D7DE1B6AEB32F87F1A73258B13FC8CC32942D53A66D4F038D7EA4C6800064D4838D7EA4C68000000000000000000000000000425443000000000035DD7DF146893456296BF4061FBE68735D28F3286540000000000F42408114A4B8F5F7B644AEDC3447F9459C132EEB016A133B",
"index":"000037C6659BB98F8D09F2F4CFEB27DE8EFEAFE54DD9E1C13AECDF5794B0C0F5"
},
{
"data":"11006F2200020000240000000A250067395C33000000000000000034000000000000000055A160BC41A45B6BB118DF23D77E4FF23C723431B917F50DCB41319ECC2821F34C5010DFA3B6DDAB58C7E8E5D944E736DA4B7046C30E4F460FD9DE4C1AA535D3D0C00064D554C88B43EFA00000000000000000000000000055534400000000000A20B3C85F482532A9578DBB3950B85CA06594D165400000B59B9F780081148366FB9ACD2A0FD822E31112D2EB6F98C317C2C1",
"index":"0000A8791F78CC9B39200E12A9BDAACCF40A72A512FA815525CFC9BA772990F7"
},
{
"data":"1100612200000000240000000125003E742F2D0000000055286498B513710CFEB2D723A554C7557983D1952DF4DEE342C40DCB43067C9A21624000000306DC42008114225BAB89C4A4B94624BB069D6DB3C819F934991C",
"index":"0000B717320558E2DE1A3B9FDB24E9A695BF05D1A44E4A4683212BB1DD0FBA23"
},
{
"data":"110072220002000025000B65783700000000000000003800000000000000005587591A63051645F37B85D1FBA55EE69B1C96BFF16904F5C99F03FB93D42D03756280000000000000000000000000000000000000004254430000000000000000000000000000000000000000000000000166800000000000000000000000000000000000000042544300000000000A20B3C85F482532A9578DBB3950B85CA06594D167D4C38D7EA4C680000000000000000000000000004254430000000000C795FDF8A637BCAAEDAD1C434033506236C82A2D",
"index":"000103996A3BAD918657F86E12A67D693E8FC8A814DA4B958A244B5F14D93E58"
}
],
"status":"success"
}
}
```
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-------------------------------------------|:---------------|
| `ledger_index` | 符号なし整数 | このレジャーのシーケンス番号 |
| `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
| `state` | 配列 | ツリーのデータが含まれているJSONオブジェクトの配列。以下のように定義されています。 |
| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
`state`配列の各オブジェクトのフォーマットは、要求で`binary`がtrueに設定されているかどうかによって異なります。各`state`オブジェクトには以下のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:--------------------|:----------|:-------------------------------------------|
| `data` | 文字列 | （`"binary":true`の場合にのみ含まれる）要求されたデータの16進表現。 |
| `LedgerEntryType` | 文字列 | （`"binary":false`の場合にのみ含まれる）このオブジェクトが表すレジャーオブジェクトの型を示す文字列。詳細なリストについては[レジャーデータフォーマット](ledger-data-formats.html)を参照してください。 |
| （追加のフィールド） | （各種） | （`"binary":false`の場合にのみ含まれる）このオブジェクトを記述する追加フィールド。オブジェクトのLedgerEntryTypeに応じて異なります。 |
| `index` | 文字列 | このレジャーエントリの一意のID（16進数） |
## 考えられるエラー
* [一般的なエラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
{% include '_snippets/rippled_versions.md' %}
{% include '_snippets/rippled-api-links.md' %}

171
content/references/rippled-api/public-rippled-methods/ledger-methods/ledger_entry.ja.md Normal file
View File

@@ -0,0 +1,171 @@
# ledger_entry
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/LedgerEntry.cpp "Source")
`ledger_entry`メソッドは、XRP Ledgerの1つのレジャーオブジェクトを生フォーマットで返します。取得可能な各種オブジェクトについては、[レジャーフォーマット][]を参照してください。
**注記:** このメソッドのコマンドラインバージョンはありません。代わりに[jsonメソッド][]を使用してコマンドラインからこのメソッドにアクセスできます。
## 要求フォーマット
要求フォーマットの例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```
{
"id":3,
"command":"ledger_entry",
"type":"account_root",
"account_root":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger_index":"validated"
}
```
*JSON-RPC*
```
{
"method":"ledger_entry",
"params":[
{
"account_root":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger_index":"validated",
"type":"account_root"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
[試してみる >](websocket-api-tool.html#ledger_entry)
このメソッドでは各種データを取得できます。取得するアイテムのタイプを選択するには、当該のパラメーターを渡します。具体的には、以下のフィールドのいずれか1つを指定します。
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つのみを取得します。どのアイテムが取得されるかは未定義です。
このメソッドで認識されるすべてのパラメーターのリストを次に示します。
| `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][新規: rippled 1.2.0] |
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
`generator`パラメーターと`ledger`パラメーターは廃止予定であり、今後予告なしに削除される可能性があります。
## 応答フォーマット
処理が成功した応答の例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```{
"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"
}
},
"status":"success",
"type":"response"
}
```
*JSON-RPC*
```
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
}
}
```
<!-- MULTICODE_BLOCK_END -->
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-----------------|:-----------------------------------------|
| `index` | 文字列 | このledger_entryの一意の識別用キー |
| `ledger_index` | 符号なし整数 | このデータの取得元レジャーの一意のシーケンス番号 |
| `node` | オブジェクト | （`"binary": true`が指定されている場合は省略）[レジャーフォーマット][]に基づく、このレジャーオブジェクトのデータが含まれているオブジェクト。 |
| `node_binary` | 文字列 | （`"binary":true`が指定されていない場合は省略）レジャーオブジェクトのバイナリデータ（16進数）。 |
## 考えられるエラー
* [一般的なエラータイプ][]のすべて。
* `deprecatedFeature` - 削除されたフィールド（`generator`など）が要求に指定されていました。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
* `malformedAddress` - 要求の[アドレス][]フィールドが誤って指定されています。
* `malformedCurrency` - 要求の[通貨コード][]フィールドが誤って指定されています。
* `malformedOwner` - 要求の`escrow.owner`サブフィールドが誤って指定されています。
* `malformedRequest` - 要求にフィールドが無効な組み合わせで指定されているか、1つ以上のフィールドの型が誤っています。
* `unknownOption` - 要求に指定されたフィールドが、予期される要求フォーマットのいずれにも一致していません。
<!-- TODO: we should add this ledger format link to rippled-api-links.md. account_objects.md is also including this as a one-off.-->
[レジャーフォーマット]: ledger-data-formats.html
{% include '_snippets/rippled_versions.md' %}
{% include '_snippets/rippled-api-links.md' %}