mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-21 20:25:51 +00:00
[JA] fix request, response
This commit is contained in:
tequ
@@ -83,7 +83,7 @@ XRP Ledgerは、複数の[暗号署名アルゴリズム](#署名アルゴリズ
|
|||||||
|
|
||||||
マスターキーペアは、秘密鍵と公開鍵で構成されています。アカウントのアドレスは、そのアカウントのマスターキーペアから得られるので、両者は[本質的な関係](addresses.html#アドレスのエンコード)となります。マスターキーペアの変更・削除はできませんが、無効にすることはできます。
|
マスターキーペアは、秘密鍵と公開鍵で構成されています。アカウントのアドレスは、そのアカウントのマスターキーペアから得られるので、両者は[本質的な関係](addresses.html#アドレスのエンコード)となります。マスターキーペアの変更・削除はできませんが、無効にすることはできます。
|
||||||
|
|
||||||
[wallet_proposeメソッド][]は、マスターキーペアを生成する方法の1つです。このメソッドからの応答には、アカウントのシード、アドレス、マスター公開鍵が一緒に表示されます。マスターキーペアを設定する他の方法については、[安全な署名の設定](secure-signing.html)を参照してください。
|
[wallet_proposeメソッド][]は、マスターキーペアを生成する方法の1つです。このメソッドからのレスポンスには、アカウントのシード、アドレス、マスター公開鍵が一緒に表示されます。マスターキーペアを設定する他の方法については、[安全な署名の設定](secure-signing.html)を参照してください。
|
||||||
|
|
||||||
**注意:** 悪意のある行為者があなたのマスター秘密鍵（またはシード）を知った場合、マスター鍵ペアが無効化されていない限り、彼らはあなたのアカウントを完全にコントロールすることができます。彼らはあなたのアカウントが保持している全ての資金を盗み、その他の回復不能な損害を与えることができます。秘密鍵は慎重に扱ってください！
|
**注意:** 悪意のある行為者があなたのマスター秘密鍵（またはシード）を知った場合、マスター鍵ペアが無効化されていない限り、彼らはあなたのアカウントを完全にコントロールすることができます。彼らはあなたのアカウントが保持している全ての資金を盗み、その他の回復不能な損害を与えることができます。秘密鍵は慎重に扱ってください！
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ labels:
|
|||||||
|
|
||||||
マルチシグには次のメリットがあります。
|
マルチシグには次のメリットがあります。
|
||||||
|
|
||||||
* 複数のデバイスからのキーを要求できます。これにより、不正使用者があなたの代わりにトランザクションを送信するには複数のマシンを悪用しなければならなくなります。
|
* 複数のデバイスからのキーをリクエストできます。これにより、不正使用者があなたの代わりにトランザクションを送信するには複数のマシンを悪用しなければならなくなります。
|
||||||
* 複数のユーザー間で1つのアドレスの管理を共有できます。この場合、各ユーザーが、そのアドレスからトランザクションを送信する際に必要な複数のキーのいずれか1つだけを所有します。
|
* 複数のユーザー間で1つのアドレスの管理を共有できます。この場合、各ユーザーが、そのアドレスからトランザクションを送信する際に必要な複数のキーのいずれか1つだけを所有します。
|
||||||
* あなたのアドレスからトランザクションを送信できる権限を、複数ユーザーのグループに委任できます。委任を受けた各ユーザーは、あなたが通常の方法で署名できない場合にあなたのアドレスを制御できます。
|
* あなたのアドレスからトランザクションを送信できる権限を、複数ユーザーのグループに委任できます。委任を受けた各ユーザーは、あなたが通常の方法で署名できない場合にあなたのアドレスを制御できます。
|
||||||
* その他のメリットもあります。
|
* その他のメリットもあります。
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ _図3: レジャーバージョンに適用されるトランザクション_
|
|||||||
|
|
||||||
レジャーインスタンスに含まれる一連のトランザクションはそのレジャーに記録され、XRP Ledger履歴の監査を可能としています。レジャーN+1のアカウント残高がレジャーNのアカウント残高と異なる場合、レジャーN+1にはその変更の原因となったトランザクションが含まれます。
|
レジャーインスタンスに含まれる一連のトランザクションはそのレジャーに記録され、XRP Ledger履歴の監査を可能としています。レジャーN+1のアカウント残高がレジャーNのアカウント残高と異なる場合、レジャーN+1にはその変更の原因となったトランザクションが含まれます。
|
||||||
|
|
||||||
検証済みのレジャー内に出現するトランザクションは、レジャーの変更に成功したか、または要求されたアクションを実行せずに処理された可能性があります。成功したトランザクションには、要求された変更がレジャーに適用されたことを示す**tesSUCCESS** [結果コード](transaction-results.html)が含まれます。レジャー内の失敗したトランザクションには、**tec**クラスの結果コードが含まれます。<a href="#footnote_1" id="from_footnote_1"><sup>1</sup></a>
|
検証済みのレジャー内に出現するトランザクションは、レジャーの変更に成功したか、またはリクエストされたアクションを実行せずに処理された可能性があります。成功したトランザクションには、リクエストされた変更がレジャーに適用されたことを示す**tesSUCCESS** [結果コード](transaction-results.html)が含まれます。レジャー内の失敗したトランザクションには、**tec**クラスの結果コードが含まれます。<a href="#footnote_1" id="from_footnote_1"><sup>1</sup></a>
|
||||||
|
|
||||||
レジャーに含まれるトランザクションでは必ず、[トランザクションコスト](transaction-cost.html)として一部のXRPが消却されます。この場合、**tes**コードまたは**tec**コードが含まれていたかどうかは関係ありません。消却するXRPの正確な量は、署名されたトランザクションの手順で定義されます。
|
レジャーに含まれるトランザクションでは必ず、[トランザクションコスト](transaction-cost.html)として一部のXRPが消却されます。この場合、**tes**コードまたは**tec**コードが含まれていたかどうかは関係ありません。消却するXRPの正確な量は、署名されたトランザクションの手順で定義されます。
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ _図3: レジャーバージョンに適用されるトランザクション_
|
|||||||
|
|
||||||
_図4: XRP Ledgerプロトコルの参加者_
|
_図4: XRP Ledgerプロトコルの参加者_
|
||||||
|
|
||||||
トランザクションを受信、中継、処理するサーバーは、追跡サーバーとバリデータのいずれかです。追跡サーバーの主な機能には、クライアントからのトランザクションの分散やレジャーに関する照会への応答が含まれます。検証サーバーは、追跡サーバーと同じ機能を実行し、さらにレジャー履歴を進めます<a href="#footnote_3" id="from_footnote_3"><sup>3</sup></a>。
|
トランザクションを受信、中継、処理するサーバーは、追跡サーバーとバリデータのいずれかです。追跡サーバーの主な機能には、クライアントからのトランザクションの分散やレジャーに関する照会へのレスポンスが含まれます。検証サーバーは、追跡サーバーと同じ機能を実行し、さらにレジャー履歴を進めます<a href="#footnote_3" id="from_footnote_3"><sup>3</sup></a>。
|
||||||
|
|
||||||
クライアントアプリケーションによって送信されたトランザクションを受け入れるときに、各追跡サーバーは最後に検証されたレジャーを開始点として使用します。受け入れられたトランザクションは候補トランザクションとなります。サーバーから候補トランザクションがそれぞれのピアに中継され、候補トランザクションがネットワーク全体に伝達されます。理想的には、各候補トランザクションはすべてのサーバーに伝達される必要があります。その結果、各サーバーは最後に検証されたレジャーに同じ一連のトランザクションを適用できる可能性が高くなります。しかし、トランザクションが伝達されるまでには時間がかかるため、サーバーは常に同じ候補トランザクションを処理するわけではありません。このことを考慮に入れて、XRP Ledgerでは、コンセンサスと呼ばれるプロセスを使用して、同一のトランザクションが処理され、ピアツーピアのXRP Ledgerネットワーク全体で検証済みのレジャーの一貫性が確保できるようにしています。
|
クライアントアプリケーションによって送信されたトランザクションを受け入れるときに、各追跡サーバーは最後に検証されたレジャーを開始点として使用します。受け入れられたトランザクションは候補トランザクションとなります。サーバーから候補トランザクションがそれぞれのピアに中継され、候補トランザクションがネットワーク全体に伝達されます。理想的には、各候補トランザクションはすべてのサーバーに伝達される必要があります。その結果、各サーバーは最後に検証されたレジャーに同じ一連のトランザクションを適用できる可能性が高くなります。しかし、トランザクションが伝達されるまでには時間がかかるため、サーバーは常に同じ候補トランザクションを処理するわけではありません。このことを考慮に入れて、XRP Ledgerでは、コンセンサスと呼ばれるプロセスを使用して、同一のトランザクションが処理され、ピアツーピアのXRP Ledgerネットワーク全体で検証済みのレジャーの一貫性が確保できるようにしています。
|
||||||
|
|
||||||
@@ -204,13 +204,13 @@ XRP Ledgerに送信されたトランザクションはすぐには処理され
|
|||||||
|
|
||||||
<a href="#from_footnote_6" id="footnote_6"><sup>6</sup></a> – 共謀しないとされるバリデータからだけでなくすべてのバリデータからの提案が評価される場合は、悪意のある攻撃者によって、無効なトランザクションが導入されたり、提案から有効なトランザクションが除外されたりする可能性があります。選択されたバリデータリストによって、[シビル攻撃](consensus-protections.html#シビル攻撃)から保護することができます。
|
<a href="#from_footnote_6" id="footnote_6"><sup>6</sup></a> – 共謀しないとされるバリデータからだけでなくすべてのバリデータからの提案が評価される場合は、悪意のある攻撃者によって、無効なトランザクションが導入されたり、提案から有効なトランザクションが除外されたりする可能性があります。選択されたバリデータリストによって、[シビル攻撃](consensus-protections.html#シビル攻撃)から保護することができます。
|
||||||
|
|
||||||
<a href="#from_footnote_7" id="footnote_7"><sup>7</sup></a> – 2014年11月の時点で、圧倒的多数を表すしきい値として、少なくともピアの80%が検証すべきレジャーに同意する必要があります。これは、コンセンサスのラウンドで要求される割合と同じです。いずれのしきい値も変更される可能性があり、同じである必要はありません。
|
<a href="#from_footnote_7" id="footnote_7"><sup>7</sup></a> – 2014年11月の時点で、圧倒的多数を表すしきい値として、少なくともピアの80%が検証すべきレジャーに同意する必要があります。これは、コンセンサスのラウンドでリクエストされる割合と同じです。いずれのしきい値も変更される可能性があり、同じである必要はありません。
|
||||||
|
|
||||||
<a href="#from_footnote_8" id="footnote_8"><sup>8</sup></a> – 実際には、サーバーは自身が少数であることを検知してから、すべてのピアの検証を受け取ります。ピアの20%以上から不一致の検証を受け取ると、その検証がしきい値の80%を満たしていないことが分かります。その時点で、レジャーの再計算を始めることができます。
|
<a href="#from_footnote_8" id="footnote_8"><sup>8</sup></a> – 実際には、サーバーは自身が少数であることを検知してから、すべてのピアの検証を受け取ります。ピアの20%以上から不一致の検証を受け取ると、その検証がしきい値の80%を満たしていないことが分かります。その時点で、レジャーの再計算を始めることができます。
|
||||||
|
|
||||||
<a href="#from_footnote_9" id="footnote_9"><sup>9</sup></a> – 実際には、効率的に実行できるように、検証の完了前に新しいコンセンサスのラウンドが開始されます。
|
<a href="#from_footnote_9" id="footnote_9"><sup>9</sup></a> – 実際には、効率的に実行できるように、検証の完了前に新しいコンセンサスのラウンドが開始されます。
|
||||||
|
|
||||||
<a href="#from_footnote_10" id="footnote_10"><sup>10</sup></a> – `rippled`サーバーはレジャーの履歴全体がなくてもAPIリクエストに応答することができます。サービスやネットワーク接続が中断すると、そのサーバーのレジャー履歴にレジャーの不足や誤差が生じることがあります。時間の経過とともに、`rippled`によってその誤差は埋まります（そのように設定されている場合）。欠落しているトランザクションを検証する場合は、トランザクションが送信されてからLastLedgerSequenceまでの連続した完全なレジャーを持つサーバーに照らして検証することが重要です。特定のサーバーで利用できるcomplete_ledgersを判断するには、RPCサーバーの状態を使用します。
|
<a href="#from_footnote_10" id="footnote_10"><sup>10</sup></a> – `rippled`サーバーはレジャーの履歴全体がなくてもAPIリクエストにレスポンスすることができます。サービスやネットワーク接続が中断すると、そのサーバーのレジャー履歴にレジャーの不足や誤差が生じることがあります。時間の経過とともに、`rippled`によってその誤差は埋まります（そのように設定されている場合）。欠落しているトランザクションを検証する場合は、トランザクションが送信されてからLastLedgerSequenceまでの連続した完全なレジャーを持つサーバーに照らして検証することが重要です。特定のサーバーで利用できるcomplete_ledgersを判断するには、RPCサーバーの状態を使用します。
|
||||||
|
|
||||||
|
|
||||||
<!--{# common link defs #}-->
|
<!--{# common link defs #}-->
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ XRP Ledgerを動かすサーバーソフトウェアは、主に2種類ありま
|
|||||||
* 選択的に支払いパスや通貨交換のオファーを表示または非表示にすることができ、最良の取引を提供せず、彼ら自身の利益を確保する可能性があります。
|
* 選択的に支払いパスや通貨交換のオファーを表示または非表示にすることができ、最良の取引を提供せず、彼ら自身の利益を確保する可能性があります。
|
||||||
* もし、アドレスの秘密鍵を送信してしまった場合、サーバーの管理者はあなたに代わって任意のトランザクションを実行し、アドレスが保有するすべての資金を転送または破棄する可能性があります。
|
* もし、アドレスの秘密鍵を送信してしまった場合、サーバーの管理者はあなたに代わって任意のトランザクションを実行し、アドレスが保有するすべての資金を転送または破棄する可能性があります。
|
||||||
|
|
||||||
さらに、独自のサーバーを運営することで、[管理者アクセス権限](get-started-using-http-websocket-apis.html#管理者アクセス権限)が与えられ、重要な管理者専用コマンドや負荷の高いコマンドを実行することができます。共有サーバーを使用する場合、同じサーバーの他のユーザーとサーバーの計算能力を共有することを考慮しなければいけません。WebSocket APIのコマンドの多くはサーバーに大きな負担をかけるので、サーバーには必要なときに応答を縮小するオプションがあります。サーバーを他人と共有する場合、常に最良の結果を得られるとは限りません。
|
さらに、独自のサーバーを運営することで、[管理者アクセス権限](get-started-using-http-websocket-apis.html#管理者アクセス権限)が与えられ、重要な管理者専用コマンドや負荷の高いコマンドを実行することができます。共有サーバーを使用する場合、同じサーバーの他のユーザーとサーバーの計算能力を共有することを考慮しなければいけません。WebSocket APIのコマンドの多くはサーバーに大きな負担をかけるので、サーバーには必要なときにレスポンスを縮小するオプションがあります。サーバーを他人と共有する場合、常に最良の結果を得られるとは限りません。
|
||||||
|
|
||||||
最後に、バリデーションサーバーを運用する場合、パブリックネットワークへのプロキシとしてストックサーバーを使用し、バリデーションサーバーをプライベートネットワークに置いて、ストックサーバーを通してのみ外部にアクセスできるようにすることができます。これにより、バリデーションサーバに侵入することがより困難になります。
|
最後に、バリデーションサーバーを運用する場合、パブリックネットワークへのプロキシとしてストックサーバーを使用し、バリデーションサーバーをプライベートネットワークに置いて、ストックサーバーを通してのみ外部にアクセスできるようにすることができます。これにより、バリデーションサーバに侵入することがより困難になります。
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ labels:
|
|||||||
|
|
||||||
## 利用可能な履歴
|
## 利用可能な履歴
|
||||||
|
|
||||||
設計上、XRP Ledgerのすべてのデータとトランザクションは公開されており、誰でもすべてのデータを検索または照会できます。ただし、サーバーが検索できるデータは、そのサーバーがローカルで使用できるデータに限られます。サーバーで利用できないレジャーバージョンやトランザクションを照会しようとすると、そのデータが見つからないという応答がサーバーから返されます。必要な履歴を保持している他のサーバーに対して同じ照会を実行すると、正常な応答が返されます。XRP Ledgerデータを使用する企業では、サーバーで利用可能な履歴の量に注意してください。
|
設計上、XRP Ledgerのすべてのデータとトランザクションは公開されており、誰でもすべてのデータを検索または照会できます。ただし、サーバーが検索できるデータは、そのサーバーがローカルで使用できるデータに限られます。サーバーで利用できないレジャーバージョンやトランザクションを照会しようとすると、そのデータが見つからないというレスポンスがサーバーから返されます。必要な履歴を保持している他のサーバーに対して同じ照会を実行すると、正常なレスポンスが返されます。XRP Ledgerデータを使用する企業では、サーバーで利用可能な履歴の量に注意してください。
|
||||||
|
|
||||||
[server_infoメソッド][]は、サーバーで利用可能なレジャーバージョンの数を`complete_ledgers`フィールドで報告します。
|
[server_infoメソッド][]は、サーバーで利用可能なレジャーバージョンの数を`complete_ledgers`フィールドで報告します。
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ XRP Ledger財団は、コミュニティメンバーが運営する一連の全
|
|||||||
|
|
||||||
## 履歴シャーディング
|
## 履歴シャーディング
|
||||||
|
|
||||||
XRP Ledgerのすべての履歴を1台の高価なマシンに保管する代わりに、複数のサーバーがレジャー履歴の一部分を保管するように構成できます。これは[履歴シャーディング](history-sharding.html)機能によって実現します。一定範囲のレジャー履歴が _シャードストアー_ という個別の保管領域に保管されます。ピアサーバーから（上記の[履歴の取得](#履歴の取得)で説明したとおり）特定のデータが要求されると、サーバーはレジャーストアーまたはシャードストアーのデータを使用して応答できます。
|
XRP Ledgerのすべての履歴を1台の高価なマシンに保管する代わりに、複数のサーバーがレジャー履歴の一部分を保管するように構成できます。これは[履歴シャーディング](history-sharding.html)機能によって実現します。一定範囲のレジャー履歴が _シャードストアー_ という個別の保管領域に保管されます。ピアサーバーから（上記の[履歴の取得](#履歴の取得)で説明したとおり）特定のデータがリクエストされると、サーバーはレジャーストアーまたはシャードストアーのデータを使用してレスポンスできます。
|
||||||
|
|
||||||
オンライン削除ではシャードストアーのデータは削除**されません**。ただし、32768個以上のレジャーバージョンをサーバーのレジャーストアーに保持するようにオンライン削除が設定されていれば、レジャーストアーからデータが自動的に削除される前に、サーバーはレジャーストアーからシャードストアーにすべてのシャードをコピーできます。
|
オンライン削除ではシャードストアーのデータは削除**されません**。ただし、32768個以上のレジャーバージョンをサーバーのレジャーストアーに保持するようにオンライン削除が設定されていれば、レジャーストアーからデータが自動的に削除される前に、サーバーはレジャーストアーからシャードストアーにすべてのシャードをコピーできます。
|
||||||
|
|
||||||
|
|||||||
@@ -12,16 +12,16 @@ XRP Ledgerのサーバーは、XRP Ledgerピアプロトコル（RTXP）を使
|
|||||||
|
|
||||||
ピアプロトコルは、XRP Ledgerのサーバー間のメイン通信モードです。XRP Ledgerの動作、進捗状況、接続に関するすべての情報がピアプロトコルを通じて伝達されます。ピアツーピア通信の例を以下に示します。
|
ピアプロトコルは、XRP Ledgerのサーバー間のメイン通信モードです。XRP Ledgerの動作、進捗状況、接続に関するすべての情報がピアプロトコルを通じて伝達されます。ピアツーピア通信の例を以下に示します。
|
||||||
|
|
||||||
- ピアツーピアネットワーク内の他のサーバーへの接続の要求、または接続スロットの使用可能性についてのアドバタイズ。
|
- ピアツーピアネットワーク内の他のサーバーへの接続のリクエスト、または接続スロットの使用可能性についてのアドバタイズ。
|
||||||
- ネットワークのその他の部分との候補トランザクションの共有。
|
- ネットワークのその他の部分との候補トランザクションの共有。
|
||||||
- 履歴レジャーへのレジャーデータの要求、またはレジャーデータの提供。
|
- 履歴レジャーへのレジャーデータのリクエスト、またはレジャーデータの提供。
|
||||||
- コンセンサスのための一連のトランザクションの提示、またはコンセンサストランザクションセットの適用に関する算出結果の共有。
|
- コンセンサスのための一連のトランザクションの提示、またはコンセンサストランザクションセットの適用に関する算出結果の共有。
|
||||||
|
|
||||||
ピアツーピア接続を確立するには、サーバーどうしをHTTPSで接続し、一方のサーバーはRTXPへの切り替えのために[HTTPアップグレード](https://tools.ietf.org/html/rfc7230#section-6.7)を要求します。（詳細は、[`rippled`リポジトリ](https://github.com/ripple/rippled)の[Overlay Network](https://github.com/XRPLF/rippled/blob/906ef761bab95f80b0a7e0cab3b4c594b226cf57/src/ripple/overlay/README.md#handshake)を参照してください。）
|
ピアツーピア接続を確立するには、サーバーどうしをHTTPSで接続し、一方のサーバーはRTXPへの切り替えのために[HTTPアップグレード](https://tools.ietf.org/html/rfc7230#section-6.7)をリクエストします。（詳細は、[`rippled`リポジトリ](https://github.com/ripple/rippled)の[Overlay Network](https://github.com/XRPLF/rippled/blob/906ef761bab95f80b0a7e0cab3b4c594b226cf57/src/ripple/overlay/README.md#handshake)を参照してください。）
|
||||||
|
|
||||||
## ピアの検出
|
## ピアの検出
|
||||||
|
|
||||||
XRP Ledgerでは、「ゴシップ」プロトコルを使用して、XRP Ledgerネットワーク内でサーバーが互いを識別できるようにします。サーバーは、起動するたびに、以前に接続したその他のあらゆるピアに再接続します。フォールバックとして、[ハードコーディングされた公開ハブ](https://github.com/XRPLF/rippled/blob/fa57859477441b60914e6239382c6fba286a0c26/src/ripple/overlay/impl/OverlayImpl.cpp#L518-L525)を使用します。サーバーがピアに正常に接続されると、ピアを探している他のXRP Ledgerサーバーの接続情報（通常はIPアドレスとポート）をそのピアに要求します。その後、サーバーはそれらのサーバーに接続し、ピア接続するXRP Ledgerサーバーの接続情報をさらに要求できます。このプロセスにより、サーバーは十分なピア接続を確立し、単一のピアへの接続が失われた場合でも、ネットワークの残りの部分にその後も接続されます。
|
XRP Ledgerでは、「ゴシップ」プロトコルを使用して、XRP Ledgerネットワーク内でサーバーが互いを識別できるようにします。サーバーは、起動するたびに、以前に接続したその他のあらゆるピアに再接続します。フォールバックとして、[ハードコーディングされた公開ハブ](https://github.com/XRPLF/rippled/blob/fa57859477441b60914e6239382c6fba286a0c26/src/ripple/overlay/impl/OverlayImpl.cpp#L518-L525)を使用します。サーバーがピアに正常に接続されると、ピアを探している他のXRP Ledgerサーバーの接続情報（通常はIPアドレスとポート）をそのピアにリクエストします。その後、サーバーはそれらのサーバーに接続し、ピア接続するXRP Ledgerサーバーの接続情報をさらにリクエストできます。このプロセスにより、サーバーは十分なピア接続を確立し、単一のピアへの接続が失われた場合でも、ネットワークの残りの部分にその後も接続されます。
|
||||||
|
|
||||||
通常、サーバーが公開ハブに接続する必要があるのは1回のみです。他のピアを見つけるために、短時間のみ接続します。そうすることで、ネットワーク接続の安定性、ハブのビジー状態、およびサーバーが検出する他の高品質ピアの数に応じて、ハブにサーバーを引き続き接続するかどうかが異なります。サーバーでは、これらの他のピアのアドレスを保存するため、ネットワークの停止後または再起動後、それらのピアへの直接再接続を試行できます。
|
通常、サーバーが公開ハブに接続する必要があるのは1回のみです。他のピアを見つけるために、短時間のみ接続します。そうすることで、ネットワーク接続の安定性、ハブのビジー状態、およびサーバーが検出する他の高品質ピアの数に応じて、ハブにサーバーを引き続き接続するかどうかが異なります。サーバーでは、これらの他のピアのアドレスを保存するため、ネットワークの停止後または再起動後、それらのピアへの直接再接続を試行できます。
|
||||||
|
|
||||||
@@ -63,7 +63,7 @@ protocol = peer
|
|||||||
通常、`rippled`サーバーでは多数のピアを維持するよう試みるため、信頼性の低いピアの最大数まで自動接続されます。特定のピアサーバーへの接続を維持するように`rippled`サーバーを構成するには、いくつかの方法があります。
|
通常、`rippled`サーバーでは多数のピアを維持するよう試みるため、信頼性の低いピアの最大数まで自動接続されます。特定のピアサーバーへの接続を維持するように`rippled`サーバーを構成するには、いくつかの方法があります。
|
||||||
|
|
||||||
- **固定ピア**を使用して、IPアドレスに基づき特定の他のピアへの接続を維持します。これは、ピアのIPアドレスが固定されている場合にのみ機能します。固定ピアを構成するには、構成スタンザ`[ips_fixed]`を使用します。これは、[クラスタリング](clustering.html)または[プライベートピア](#プライベートピア)の重要な部分です。固定ピアは構成ファイルで定義されているため、変更を適用するにはサーバーを再起動する必要があります。サーバーが同じユーザーまたは組織によって実行されている場合、固定ピアは、サーバーの接続状態を維持するのに最も有益です。
|
- **固定ピア**を使用して、IPアドレスに基づき特定の他のピアへの接続を維持します。これは、ピアのIPアドレスが固定されている場合にのみ機能します。固定ピアを構成するには、構成スタンザ`[ips_fixed]`を使用します。これは、[クラスタリング](clustering.html)または[プライベートピア](#プライベートピア)の重要な部分です。固定ピアは構成ファイルで定義されているため、変更を適用するにはサーバーを再起動する必要があります。サーバーが同じユーザーまたは組織によって実行されている場合、固定ピアは、サーバーの接続状態を維持するのに最も有益です。
|
||||||
- **ピアリザベーション**を使用して、特定のピアに優先順位を付けます。サーバーに特定のピアのピアリザベーションがある場合、既に最大数のピアに接続されていても、サーバーは常にそのピアからの接続要求を受け入れます。（これにより、サーバーでのピアの最大接続数を*超える*可能性があります。）[ノードキーペア](#ノードキーペア)によって確保済みピアを識別するため、可変IPアドレスを持つピアに対してもこれを行うことができます。ピアリザベーションは、管理コマンドを使用して構成され、サーバーデータベースに保存されるため、サーバーがオンラインの場合に調整することができ、再起動後も保存されます。ピアリザベーションは、さまざまなユーザーや組織が運営するサーバーを接続するのに最も有益です。[新規: rippled 1.4.0][]
|
- **ピアリザベーション**を使用して、特定のピアに優先順位を付けます。サーバーに特定のピアのピアリザベーションがある場合、既に最大数のピアに接続されていても、サーバーは常にそのピアからの接続リクエストを受け入れます。（これにより、サーバーでのピアの最大接続数を*超える*可能性があります。）[ノードキーペア](#ノードキーペア)によって確保済みピアを識別するため、可変IPアドレスを持つピアに対してもこれを行うことができます。ピアリザベーションは、管理コマンドを使用して構成され、サーバーデータベースに保存されるため、サーバーがオンラインの場合に調整することができ、再起動後も保存されます。ピアリザベーションは、さまざまなユーザーや組織が運営するサーバーを接続するのに最も有益です。[新規: rippled 1.4.0][]
|
||||||
|
|
||||||
次の場合、`rippled`サーバーは、信頼性の低いピアには接続されません。
|
次の場合、`rippled`サーバーは、信頼性の低いピアには接続されません。
|
||||||
|
|
||||||
@@ -81,17 +81,17 @@ protocol = peer
|
|||||||
|
|
||||||
- サーバーがピアツーピアネットワーク内の他のサーバーに接続するように明示的に設定されていない場合、サーバーは他のサーバーに発信接続しません。
|
- サーバーがピアツーピアネットワーク内の他のサーバーに接続するように明示的に設定されていない場合、サーバーは他のサーバーに発信接続しません。
|
||||||
- サーバーは、他のサーバーからの接続を受け入れるように明示的に設定されていない場合、他のサーバーからの着信接続を受け入れません。
|
- サーバーは、他のサーバーからの接続を受け入れるように明示的に設定されていない場合、他のサーバーからの着信接続を受け入れません。
|
||||||
- サーバーはそのダイレクトピアに対し、信頼できない通信（[ピアクローラーAPI応答](peer-crawler.html)を含む）の中ではサーバーのIPアドレスを公開しないように指示します。これは、[peers adminメソッド][peersメソッド]などの信頼できる通信には影響しません。
|
- サーバーはそのダイレクトピアに対し、信頼できない通信（[ピアクローラーAPIレスポンス](peer-crawler.html)を含む）の中ではサーバーのIPアドレスを公開しないように指示します。これは、[peers adminメソッド][peersメソッド]などの信頼できる通信には影響しません。
|
||||||
|
|
||||||
プライベートサーバーの設定に関係なく、バリデータは常にそのピアに対し、バリデータのIPアドレスを非公開にするように指示します。これにより、バリデータがサービス拒否攻撃を受け過剰な負荷がかかることから保護されます。[新規: rippled 1.2.1][]
|
プライベートサーバーの設定に関係なく、バリデータは常にそのピアに対し、バリデータのIPアドレスを非公開にするように指示します。これにより、バリデータがサービス拒否攻撃を受け過剰な負荷がかかることから保護されます。[新規: rippled 1.2.1][]
|
||||||
|
|
||||||
**注意:** サーバーのソースコードを改ざんして、サーバーがこの要求を無視し、直近のピアのIPアドレスを共有する可能性があります。プライベートサーバーを、このように改ざんされていないことが確認されているサーバーにのみ接続するように設定してください。
|
**注意:** サーバーのソースコードを改ざんして、サーバーがこのリクエストを無視し、直近のピアのIPアドレスを共有する可能性があります。プライベートサーバーを、このように改ざんされていないことが確認されているサーバーにのみ接続するように設定してください。
|
||||||
|
|
||||||
### ピア接続設定のメリットとデメリット
|
### ピア接続設定のメリットとデメリット
|
||||||
|
|
||||||
XRP Ledgerで使用できるように、`rippled`サーバーをピアツーピアのオープンネットワークの残りの部分に接続する必要があります。大まかに言えば、`rippled`サーバーがネットワークに接続する方法には、次の3種類の構成があります。
|
XRP Ledgerで使用できるように、`rippled`サーバーをピアツーピアのオープンネットワークの残りの部分に接続する必要があります。大まかに言えば、`rippled`サーバーがネットワークに接続する方法には、次の3種類の構成があります。
|
||||||
|
|
||||||
- **検出されたピア**を使用します。サーバーは、検出された信頼の低いサーバーに接続し、それらのサーバーが適切に動作する限り接続を維持します。（たとえば、要求するデータはそれほど多くなく、ネットワーク接続は安定しているため、同じ[ネットワーク](parallel-networks.html)をフォローしているように見えます。）デフォルトでは、この構成に設定されています。
|
- **検出されたピア**を使用します。サーバーは、検出された信頼の低いサーバーに接続し、それらのサーバーが適切に動作する限り接続を維持します。（たとえば、リクエストするデータはそれほど多くなく、ネットワーク接続は安定しているため、同じ[ネットワーク](parallel-networks.html)をフォローしているように見えます。）デフォルトでは、この構成に設定されています。
|
||||||
- 同じユーザーまたは組織が実行する**プロキシを使用したプライベートサーバー**として使用します。プロキシは、プライベートサーバーとの固定ピア接続を維持するストック用の`rippled`サーバーです（検出されたピアにも接続されます）。
|
- 同じユーザーまたは組織が実行する**プロキシを使用したプライベートサーバー**として使用します。プロキシは、プライベートサーバーとの固定ピア接続を維持するストック用の`rippled`サーバーです（検出されたピアにも接続されます）。
|
||||||
- **公開ハブを使用するプライベートサーバー**として使用します。プロキシを使用する構成と似ていますが、サードパーティーによって異なります。
|
- **公開ハブを使用するプライベートサーバー**として使用します。プロキシを使用する構成と似ていますが、サードパーティーによって異なります。
|
||||||
|
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ XRP Ledgerの堅牢性は、他のバリデータが共謀しないことをそ
|
|||||||
## レポートモード
|
## レポートモード
|
||||||
[新規: rippled 1.7.0][]
|
[新規: rippled 1.7.0][]
|
||||||
|
|
||||||
レポートモードは、APIリクエストをより効率的に処理するために特化したモードです。このモードでは、サーバーは[gRPC](configure-grpc.html)を介して、P2Pモードで動作する別の`rippled`サーバーから最新の検証済みレジャーデータを取得し、そのデータをリレーショナルデータベース([PostgreSQL](https://www.postgresql.org/))にロードします。レポートモードサーバはピアツーピアネットワークに直接参加しませんが、トランザクションの送信などの要求を、使用しているP2Pモードサーバに転送することはできます。
|
レポートモードは、APIリクエストをより効率的に処理するために特化したモードです。このモードでは、サーバーは[gRPC](configure-grpc.html)を介して、P2Pモードで動作する別の`rippled`サーバーから最新の検証済みレジャーデータを取得し、そのデータをリレーショナルデータベース([PostgreSQL](https://www.postgresql.org/))にロードします。レポートモードサーバはピアツーピアネットワークに直接参加しませんが、トランザクションの送信などのリクエストを、使用しているP2Pモードサーバに転送することはできます。
|
||||||
|
|
||||||
複数のレポートモードサーバーは、PostgreSQLデータベースと[Apache Cassandra](https://cassandra.apache.org/)クラスタへのアクセスを共有し、各サーバーがすべてのデータの冗長コピーを必要とせずに大量の履歴を提供できます。レポートモードサーバは、基礎となるデータの保存方法の違いに対応するため、若干の変更を加えた同じ[`rippled` API](http-websocket-apis.html)を使ってこのデータを提供します。
|
複数のレポートモードサーバーは、PostgreSQLデータベースと[Apache Cassandra](https://cassandra.apache.org/)クラスタへのアクセスを共有し、各サーバーがすべてのデータの冗長コピーを必要とせずに大量の履歴を提供できます。レポートモードサーバは、基礎となるデータの保存方法の違いに対応するため、若干の変更を加えた同じ[`rippled` API](http-websocket-apis.html)を使ってこのデータを提供します。
|
||||||
|
|
||||||
|
|||||||
@@ -72,8 +72,8 @@ XRP Ledgerでは、支払いを受け取ることができるアドレスは永
|
|||||||
- **XRPによる直接支払**は、単一のトランザクションでXRPを送受信する唯一の方法です。この方法は、速度、シンプルさ、低コストの面でバランスが取れています。
|
- **XRPによる直接支払**は、単一のトランザクションでXRPを送受信する唯一の方法です。この方法は、速度、シンプルさ、低コストの面でバランスが取れています。
|
||||||
- [通貨間の支払い](cross-currency-payments.html)でも[Payment][]トランザクションタイプを使用しますが、XRPとXRP以外の[トークン](tokens.html)を組み合わせて送金できます。ただし、XRP間の支払いは除きます。また、[Partial Payment](partial-payments.html)でも使用できます。通貨間の支払いは、XRPで指定されていない支払いや、[分散型取引所](decentralized-exchange.html)で裁定取引の機会を得るのに適しています。
|
- [通貨間の支払い](cross-currency-payments.html)でも[Payment][]トランザクションタイプを使用しますが、XRPとXRP以外の[トークン](tokens.html)を組み合わせて送金できます。ただし、XRP間の支払いは除きます。また、[Partial Payment](partial-payments.html)でも使用できます。通貨間の支払いは、XRPで指定されていない支払いや、[分散型取引所](decentralized-exchange.html)で裁定取引の機会を得るのに適しています。
|
||||||
- [Checks](checks.html)すぐに送金せずに送金元に債務を設定してもらいます。受取人は有効期間内であればいつでも換金できますが、その金額は保証されません。Checksでは、XRPまたはトークンのいずれかを送金できます。Checksは、受取人に支払いを請求する自律性を与えるのに適しています。
|
- [Checks](checks.html)すぐに送金せずに送金元に債務を設定してもらいます。受取人は有効期間内であればいつでも換金できますが、その金額は保証されません。Checksでは、XRPまたはトークンのいずれかを送金できます。Checksは、受取人に支払いを請求する自律性を与えるのに適しています。
|
||||||
- [Escrow](escrow.html)では、特定の条件が満たされたときに、意図した受取人が要求できるXRPを確保します。XRPの金額は完全に保証されており、Escrowの有効期限が切れない限り、送金元が使用することはできません。Escrowは、巨額のスマートコントラクトに適しています。
|
- [Escrow](escrow.html)では、特定の条件が満たされたときに、意図した受取人がリクエストできるXRPを確保します。XRPの金額は完全に保証されており、Escrowの有効期限が切れない限り、送金元が使用することはできません。Escrowは、巨額のスマートコントラクトに適しています。
|
||||||
- [Payment Channel](payment-channels.html)では、XRPが確保されます。受取人は、署名による認証を使用して、チャネルから一括でXRPを要求できます。XRP Ledgerの全トランザクションを送信せずに、認証を個々に確認できます。Payment Channelは、極めて大量の小口決済または「ストリーミング」支払いに適しています。
|
- [Payment Channel](payment-channels.html)では、XRPが確保されます。受取人は、署名による認証を使用して、チャネルから一括でXRPをリクエストできます。XRP Ledgerの全トランザクションを送信せずに、認証を個々に確認できます。Payment Channelは、極めて大量の小口決済または「ストリーミング」支払いに適しています。
|
||||||
|
|
||||||
|
|
||||||
## 関連項目
|
## 関連項目
|
||||||
|
|||||||
@@ -109,7 +109,7 @@ POST http://localhost:8088/
|
|||||||
|
|
||||||
トラストラインの認可状況を確認するには、[account_linesメソッド][]を使用してトラストラインを調べます。レスポンスの`account`フィールドに顧客のアドレスを指定し、`peer`フィールドに発行者のアドレスを指定します。
|
トラストラインの認可状況を確認するには、[account_linesメソッド][]を使用してトラストラインを調べます。レスポンスの`account`フィールドに顧客のアドレスを指定し、`peer`フィールドに発行者のアドレスを指定します。
|
||||||
|
|
||||||
応答の`result.lines`配列で、必要とする通貨のトラストラインを表している`currency`フィールドを持つオブジェクトを見つけます。そのオブジェクトの`peer_authorized`フィールドに値`true`が設定されている場合は、発行者（レスポンスの`peer`フィールドとして使用したアドレス）によりそのトラストラインが承認されています。
|
レスポンスの`result.lines`配列で、必要とする通貨のトラストラインを表している`currency`フィールドを持つオブジェクトを見つけます。そのオブジェクトの`peer_authorized`フィールドに値`true`が設定されている場合は、発行者（レスポンスの`peer`フィールドとして使用したアドレス）によりそのトラストラインが承認されています。
|
||||||
|
|
||||||
## 関連項目
|
## 関連項目
|
||||||
|
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ XRP Ledgerは分散型であり、Ripple社やXRP Ledger財団、そして他の
|
|||||||
|
|
||||||
## しかし、Ripple社がJed McCaleb氏のXRPを凍結したと聞きましたが？
|
## しかし、Ripple社がJed McCaleb氏のXRPを凍結したと聞きましたが？
|
||||||
|
|
||||||
これは、2015年から2016年にかけて実際に起こった事件の誤報です。2013年にRipple社の創業者で同社を退社したJed McCaleb氏は、100万USドル以上のXRPをカストディ取引所であるBitstampで売却しようと試みました。Ripple社の代理人は、この売却はJed氏とRipple社が2014年に締結した契約に違反すると主張しました。Ripple社の要求により、[BitstampはJedのBitstampアカウントを凍結](https://www.coindesk.com/markets/2015/04/02/1-million-legal-fight-ensnares-ripple-bitstamp-and-jed-mccaleb/)し、裁判に持ち込まれました。この裁判は[最終的に和解](https://www.coindesk.com/markets/2016/02/12/ripple-settles-1-million-lawsuit-with-former-executive-and-founder/)となり、双方がその結果に納得したと表明しています。
|
これは、2015年から2016年にかけて実際に起こった事件の誤報です。2013年にRipple社の創業者で同社を退社したJed McCaleb氏は、100万USドル以上のXRPをカストディ取引所であるBitstampで売却しようと試みました。Ripple社の代理人は、この売却はJed氏とRipple社が2014年に締結した契約に違反すると主張しました。Ripple社のリクエストにより、[BitstampはJedのBitstampアカウントを凍結](https://www.coindesk.com/markets/2015/04/02/1-million-legal-fight-ensnares-ripple-bitstamp-and-jed-mccaleb/)し、裁判に持ち込まれました。この裁判は[最終的に和解](https://www.coindesk.com/markets/2016/02/12/ripple-settles-1-million-lawsuit-with-former-executive-and-founder/)となり、双方がその結果に納得したと表明しています。
|
||||||
|
|
||||||
注目すべきは、この「凍結」はXRP Ledger上で起こったものではなく、XRP Ledgerの凍結機能を使ったものでもないことです。他のカストディアン取引所と同様に、Bitstampはユーザーのアカウントを凍結し、特にそれらの資金が法的紛争に巻き込まれている場合、取引や資金の引き出しを停止する権限を持っています。
|
注目すべきは、この「凍結」はXRP Ledger上で起こったものではなく、XRP Ledgerの凍結機能を使ったものでもないことです。他のカストディアン取引所と同様に、Bitstampはユーザーのアカウントを凍結し、特にそれらの資金が法的紛争に巻き込まれている場合、取引や資金の引き出しを停止する権限を持っています。
|
||||||
|
|
||||||
|
|||||||
@@ -35,9 +35,9 @@ XRPは任意のアドレスに直接送金できるため、[XRP間のトラン
|
|||||||
|
|
||||||
## Pathfinding
|
## Pathfinding
|
||||||
|
|
||||||
`rippled` APIではPathfindingに使用できるメソッドが2つあります。[ripple_path_findメソッド][]は、1回限りのパスセットの検索を実行します。[path_findメソッド][]（WebSocketのみ）は、レジャーが閉鎖するか、またはサーバーがより適切なパスを検出するたびに、フォローアップ応答によって検索を拡大します。
|
`rippled` APIではPathfindingに使用できるメソッドが2つあります。[ripple_path_findメソッド][]は、1回限りのパスセットの検索を実行します。[path_findメソッド][]（WebSocketのみ）は、レジャーが閉鎖するか、またはサーバーがより適切なパスを検出するたびに、フォローアップレスポンスによって検索を拡大します。
|
||||||
|
|
||||||
署名時に`rippled`によりパスが自動的に入力されるようにするには、[signメソッド][]または[`submit`コマンド（署名と送信モード）](submit.html#署名と送信モード)への要求に`build_path`フィールドを指定します。ただし、トラブルを回避するために、署名前にPathfindingを個別に実行し、結果を確認することが推奨されます。
|
署名時に`rippled`によりパスが自動的に入力されるようにするには、[signメソッド][]または[`submit`コマンド（署名と送信モード）](submit.html#署名と送信モード)へのリクエストに`build_path`フィールドを指定します。ただし、トラブルを回避するために、署名前にPathfindingを個別に実行し、結果を確認することが推奨されます。
|
||||||
|
|
||||||
**注意:** `rippled`は可能な限り低コストのパスを検出するように設計されていますが、常にこのようなパスを検出できるわけではありません。信頼できない`rippled`インスタンスが改ざんされ、利益目的でこの動作が変更される可能性もあります。パスに沿った支払いの実行にかかる実際のコストは、送信時とトランザクション実行時で異なることがあります。
|
**注意:** `rippled`は可能な限り低コストのパスを検出するように設計されていますが、常にこのようなパスを検出できるわけではありません。信頼できない`rippled`インスタンスが改ざんされ、利益目的でこの動作が変更される可能性もあります。パスに沿った支払いの実行にかかる実際のコストは、送信時とトランザクション実行時で異なることがあります。
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ labels:
|
|||||||
|
|
||||||
ステーブルコインの発行者は、トークンをXRP Ledgerの外の世界の実際の通貨や資産と交換するために、_入金_ と _出金_ の機能を提供する必要があります。
|
ステーブルコインの発行者は、トークンをXRP Ledgerの外の世界の実際の通貨や資産と交換するために、_入金_ と _出金_ の機能を提供する必要があります。
|
||||||
|
|
||||||
実際には、XRP Ledgerはコンピュータシステムであり、それ自身の外部にルールを強制することはできないため、XRP Ledger上のステーブルコインはその発行者に依存しています。もしあなたが、そのステーブルコインの発行者があなたのトークンを要求に応じて本物と交換してくれることを期待できないのであれば、そのステーブルコインがその価値を維持することを期待すべきではありません。ユーザとしては、トークンを発行しているのが誰なのか、信頼性があり、合法的で、支払能力があるのか、に気を配る必要があります。そうでない場合は、そのトークンを保有しない方がよいでしょう。
|
実際には、XRP Ledgerはコンピュータシステムであり、それ自身の外部にルールを強制することはできないため、XRP Ledger上のステーブルコインはその発行者に依存しています。もしあなたが、そのステーブルコインの発行者があなたのトークンをリクエストに応じて本物と交換してくれることを期待できないのであれば、そのステーブルコインがその価値を維持することを期待すべきではありません。ユーザとしては、トークンを発行しているのが誰なのか、信頼性があり、合法的で、支払能力があるのか、に気を配る必要があります。そうでない場合は、そのトークンを保有しない方がよいでしょう。
|
||||||
|
|
||||||
XRP Ledgerで取引される通貨トークンには、一般的に5つの種類があります。
|
XRP Ledgerで取引される通貨トークンには、一般的に5つの種類があります。
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ XRP Ledgerから送金を受ける際、プロセスや統合ソフトウェア
|
|||||||
|
|
||||||
予期しない、または不要な支払いを受け取った場合の標準的な対応は、送信者にそれを返却することです。追加費用を発生させずにこれを行う方法の詳細については、[不明な入金の返金](bouncing-payments.html)をご覧ください。
|
予期しない、または不要な支払いを受け取った場合の標準的な対応は、送信者にそれを返却することです。追加費用を発生させずにこれを行う方法の詳細については、[不明な入金の返金](bouncing-payments.html)をご覧ください。
|
||||||
|
|
||||||
XRP Ledgerからの支払いを処理する前に、顧客の身元を確認してください。そうすることで、匿名の攻撃者による詐欺が難しくなります。ほとんどのマネーロンダリング対策規制は、いずれにせよこの確認を要求しています。XRP Ledgerから送金するユーザは、XRP Ledgerで最初にお金を受け取ったユーザとは異なる可能性があるため、これは特に重要です。詳しくは、[ステーブルコインのコンプライアンス指針](stablecoin-compliance-guidelines.html)をご覧ください。
|
XRP Ledgerからの支払いを処理する前に、顧客の身元を確認してください。そうすることで、匿名の攻撃者による詐欺が難しくなります。ほとんどのマネーロンダリング対策規制は、いずれにせよこの確認をリクエストしています。XRP Ledgerから送金するユーザは、XRP Ledgerで最初にお金を受け取ったユーザとは異なる可能性があるため、これは特に重要です。詳しくは、[ステーブルコインのコンプライアンス指針](stablecoin-compliance-guidelines.html)をご覧ください。
|
||||||
|
|
||||||
|
|
||||||
## XRP Ledgerへの送金
|
## XRP Ledgerへの送金
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ XRP Ledger におけるトークンの代表的なモデルとして、発行者
|
|||||||
|
|
||||||
ステーブルコインの発行者は、XRP Ledgerの外側において、トークンを実際の通貨や資産と交換するための _入金_ と _出金_ のサービスを提供する必要があります。
|
ステーブルコインの発行者は、XRP Ledgerの外側において、トークンを実際の通貨や資産と交換するための _入金_ と _出金_ のサービスを提供する必要があります。
|
||||||
|
|
||||||
実際には、XRP Ledger はただのシステムであり、その外側にいかなるルールも適用することはできません。そのため、XRP Ledger上のステーブルコインは、その発行者を信頼し、その発行者が要求に応じてトークンを現物資産へ交換することができなければ、そのステーブルコインの価値が維持されないと考えるべきでしょう。ユーザは、誰がトークンを発行しているのか、信頼できるのか、合法的なのか、支払能力があるのか、という点について十分に注意をしなければなりません。信頼できない場合は、そのトークンを保有するべきではないでしょう。
|
実際には、XRP Ledger はただのシステムであり、その外側にいかなるルールも適用することはできません。そのため、XRP Ledger上のステーブルコインは、その発行者を信頼し、その発行者がリクエストに応じてトークンを現物資産へ交換することができなければ、そのステーブルコインの価値が維持されないと考えるべきでしょう。ユーザは、誰がトークンを発行しているのか、信頼できるのか、合法的なのか、支払能力があるのか、という点について十分に注意をしなければなりません。信頼できない場合は、そのトークンを保有するべきではないでしょう。
|
||||||
|
|
||||||
[Stablecoin Issuer](stablecoin-issuer.html)をご覧ください。
|
[Stablecoin Issuer](stablecoin-issuer.html)をご覧ください。
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ NFTはブロックチェーン上で作成されます。しかし、メディ
|
|||||||
|
|
||||||
## XRP Ledger上
|
## XRP Ledger上
|
||||||
|
|
||||||
データが256バイトより小さい場合は、`data://`URIを使用し、URIフィールドに直接埋め込むことを検討することができます。これには、信頼性が高く、永続的で、応答性の高いデータベースにデータを保存できるという利点があります。
|
データが256バイトより小さい場合は、`data://`URIを使用し、URIフィールドに直接埋め込むことを検討することができます。これには、信頼性が高く、永続的で、レスポンス性の高いデータベースにデータを保存できるという利点があります。
|
||||||
|
|
||||||
## 分散型, XRP Ledger外
|
## 分散型, XRP Ledger外
|
||||||
|
|
||||||
|
|||||||
@@ -47,8 +47,8 @@ labels:
|
|||||||
|
|
||||||
1. 売り手は`NFTokenMint`を使用してNFTを作成します。
|
1. 売り手は`NFTokenMint`を使用してNFTを作成します。
|
||||||
1. 入札者は`NFTokenCreateOffer`を使って、ブローカーを宛先としてオファーを出します。
|
1. 入札者は`NFTokenCreateOffer`を使って、ブローカーを宛先としてオファーを出します。
|
||||||
1. ブローカーは落札者を選択し、手数料として徴収する金額を差し引いた後、`NFTokenCreateOffer`を介してこの金額で売却のための署名を売り手に要求します。
|
1. ブローカーは落札者を選択し、手数料として徴収する金額を差し引いた後、`NFTokenCreateOffer`を介してこの金額で売却のための署名を売り手にリクエストします。
|
||||||
1. 売り手は要求されたオファーに署名し、宛先としてブローカーを設定します。
|
1. 売り手はリクエストされたオファーに署名し、宛先としてブローカーを設定します。
|
||||||
1. ブローカーは`NFTokenAcceptOffer`を使って取引を完了させ、ブローカー手数料を受け取ります。
|
1. ブローカーは`NFTokenAcceptOffer`を使って取引を完了させ、ブローカー手数料を受け取ります。
|
||||||
1. ブローカーは`NFTokenCancelOffer`を使って競り負けた入札をキャンセルします。
|
1. ブローカーは`NFTokenCancelOffer`を使って競り負けた入札をキャンセルします。
|
||||||
|
|
||||||
|
|||||||
@@ -69,7 +69,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました)_
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
もう1つのワークフローは、クリエイターが販売をよりコントロールできるようにするものです。このワークフローでは、クリエイターが新しい`NFToken`を発行します。入札者はオファーを作成し、ブローカーを宛先として設定します。ブローカーは落札者を選び、仲介手数料を差し引き、`NFTokenCreateOffer`を使用してクリエイターに署名の依頼をします。クリエーターは要求されたオファーに署名し、ブローカーを宛先として設定します。ブローカーは`NFTokenAcceptOffer`を使って売却を完了し、仲介手数料を保持します。ブローカーは`NFTokenCancelOffer`を使用して`NFToken`に対する残りの入札をキャンセルします。
|
もう1つのワークフローは、クリエイターが販売をよりコントロールできるようにするものです。このワークフローでは、クリエイターが新しい`NFToken`を発行します。入札者はオファーを作成し、ブローカーを宛先として設定します。ブローカーは落札者を選び、仲介手数料を差し引き、`NFTokenCreateOffer`を使用してクリエイターに署名の依頼をします。クリエーターはリクエストされたオファーに署名し、ブローカーを宛先として設定します。ブローカーは`NFTokenAcceptOffer`を使って売却を完了し、仲介手数料を保持します。ブローカーは`NFTokenCancelOffer`を使用して`NFToken`に対する残りの入札をキャンセルします。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ labels:
|
|||||||
---
|
---
|
||||||
# 手数料（曖昧さの回避）
|
# 手数料（曖昧さの回避）
|
||||||
|
|
||||||
XRP Ledgerは分散型レジャーであり、暗号技術により保護され、サーバーで構成される分散型ピアツーピアネットワークで運用されます。つまり、Rippleを含め誰もネットワークアクセス料を要求できません。
|
XRP Ledgerは分散型レジャーであり、暗号技術により保護され、サーバーで構成される分散型ピアツーピアネットワークで運用されます。つまり、Rippleを含め誰もネットワークアクセス料をリクエストできません。
|
||||||
|
|
||||||
ただしXRP Ledgerのルールには、レジャーを悪用から保護するための中立的な手数料を含む各種手数料が設定されています。この中立的な手数料の受取先はありません。また、XRP Ledgerの内外でユーザーはさまざまな方法で相互に手数料を徴収できます。
|
ただしXRP Ledgerのルールには、レジャーを悪用から保護するための中立的な手数料を含む各種手数料が設定されています。この中立的な手数料の受取先はありません。また、XRP Ledgerの内外でユーザーはさまざまな方法で相互に手数料を徴収できます。
|
||||||
|
|
||||||
|
|||||||
@@ -33,14 +33,14 @@ XRP Ledgerは共有システムとなっていて、すべてのデータが公
|
|||||||
1. トランザクションが検証済みレジャーに記録されたか。
|
1. トランザクションが検証済みレジャーに記録されたか。
|
||||||
2. 記録されていた場合、結果としてレジャーの状態はどのように変化したか。
|
2. 記録されていた場合、結果としてレジャーの状態はどのように変化したか。
|
||||||
|
|
||||||
検証済みレジャーにトランザクションが記録されていたかどうかを確認するには、通常、トランザクションが記録されている可能性のあるすべてのレジャーにアクセスする必要があります。最も簡単で確実な方法は、[全履歴を記録するサーバー](ledger-history.html#すべての履歴)でトランザクションを検索する方法です。[txメソッド][]、[account_txメソッド][]またはその他の`rippled`からの応答を使用します。コンセンサスにより検証されたレジャーバージョンがこの応答に使用されていることを示す`"validated": true`を検索します。
|
検証済みレジャーにトランザクションが記録されていたかどうかを確認するには、通常、トランザクションが記録されている可能性のあるすべてのレジャーにアクセスする必要があります。最も簡単で確実な方法は、[全履歴を記録するサーバー](ledger-history.html#すべての履歴)でトランザクションを検索する方法です。[txメソッド][]、[account_txメソッド][]またはその他の`rippled`からのレスポンスを使用します。コンセンサスにより検証されたレジャーバージョンがこのレスポンスに使用されていることを示す`"validated": true`を検索します。
|
||||||
|
|
||||||
- 結果に`"validated": true`がない場合は、その結果は一時的である可能性があり、トランザクションの結果が最終的なものであるかどうかを知るには、レジャーが検証されるまで待機する必要があります。
|
- 結果に`"validated": true`がない場合は、その結果は一時的である可能性があり、トランザクションの結果が最終的なものであるかどうかを知るには、レジャーが検証されるまで待機する必要があります。
|
||||||
- 結果に目的のトランザクションが含まれていない場合、または`txnNotFound`エラーが返される場合は、サーバーにある利用可能な履歴に保存されているどのレジャーにもそのトランザクションはありません。ただし、このことだけでトランザクションが失敗したかどうかを判断できないことがあります。サーバーに保存されていない検証済みレジャーバージョンにトランザクションが記録されている、または今後検証されるレジャーにトランザクションが記録されている場合があるためです。以下を把握することで、トランザクションが記録されるレジャーの範囲を制限することができます。
|
- 結果に目的のトランザクションが含まれていない場合、または`txnNotFound`エラーが返される場合は、サーバーにある利用可能な履歴に保存されているどのレジャーにもそのトランザクションはありません。ただし、このことだけでトランザクションが失敗したかどうかを判断できないことがあります。サーバーに保存されていない検証済みレジャーバージョンにトランザクションが記録されている、または今後検証されるレジャーにトランザクションが記録されている場合があるためです。以下を把握することで、トランザクションが記録されるレジャーの範囲を制限することができます。
|
||||||
- トランザクションが記録されている可能性のある最古のレジャー。つまり、**トランザクションを初めて送信した _後に_ 最初に検証されるレジャー**。
|
- トランザクションが記録されている可能性のある最古のレジャー。つまり、**トランザクションを初めて送信した _後に_ 最初に検証されるレジャー**。
|
||||||
- トランザクションが記録されている可能性のある最新のレジャー。つまり、トランザクションの`LastLedgerSequence`フィールドで定義されるレジャー
|
- トランザクションが記録されている可能性のある最新のレジャー。つまり、トランザクションの`LastLedgerSequence`フィールドで定義されるレジャー
|
||||||
|
|
||||||
以下の例では、成功したトランザクションが[txメソッド][]によって返され、検証済みレジャーバージョンに記録されています。わかりやすくするために、JSON応答のフィールドの順序を並べ替え、一部を省略しています。
|
以下の例では、成功したトランザクションが[txメソッド][]によって返され、検証済みレジャーバージョンに記録されています。わかりやすくするために、JSONレスポンスのフィールドの順序を並べ替え、一部を省略しています。
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -93,7 +93,7 @@ XRP Ledgerは共有システムとなっていて、すべてのデータが公
|
|||||||
|
|
||||||
**情報:** このルールの例外として[疑似トランザクション](pseudo-transaction-types.html)があります。このトランザクションは実在するアカウントから送信されないため、AccountRootオブジェクトを変更しません。その他の例外として、AccountRootオブジェクトの`Balance`フィールドを変更せずに、AccountRootオブジェクトを変更するトランザクションがあります。[Free Key Resetトランザクション](transaction-cost.html#key-resetトランザクション)の場合、送金元のXRP残高は変わりません。トランザクションによって消却される金額と同額のXRPをアカウントが受け取る場合（ただし、このようなことはほとんどありません）、そのアカウントの正味残高は変わりません。（XRPを受領したアカウントに関係なくトランザクションコストはメタデータの別の場所に反映されます。）
|
**情報:** このルールの例外として[疑似トランザクション](pseudo-transaction-types.html)があります。このトランザクションは実在するアカウントから送信されないため、AccountRootオブジェクトを変更しません。その他の例外として、AccountRootオブジェクトの`Balance`フィールドを変更せずに、AccountRootオブジェクトを変更するトランザクションがあります。[Free Key Resetトランザクション](transaction-cost.html#key-resetトランザクション)の場合、送金元のXRP残高は変わりません。トランザクションによって消却される金額と同額のXRPをアカウントが受け取る場合（ただし、このようなことはほとんどありません）、そのアカウントの正味残高は変わりません。（XRPを受領したアカウントに関係なくトランザクションコストはメタデータの別の場所に反映されます。）
|
||||||
|
|
||||||
以下は、上記のステップ1からの応答全文例です。レジャーに対して行われた変更を把握できるか確認してください。
|
以下は、上記のステップ1からのレスポンス全文例です。レジャーに対して行われた変更を把握できるか確認してください。
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -363,7 +363,7 @@ Payment Channelの作成時に、LedgerEntryTypeが`PayChannel`の`CreatedNode`
|
|||||||
|
|
||||||
[fixPayChanRecipientOwnerDir Amendment](known-amendments.html#fixpaychanrecipientownerdir)が有効な場合は、メタデータは宛先のアカウントの[所有者ディレクトリー](directorynode.html)を変更して、新しく作成されるPayment Channelをリストで示す必要もあります。これにより、アカウントがオープンPayment Channelの受取人である場合に、そのアカウントが[削除される](deleting-accounts.html)ことを防ぎます。（fixPayChanRecipientOwnerDir Amendmentが有効になる前にPayment Channelが作成された場合は、アカウントを削除できます。）
|
[fixPayChanRecipientOwnerDir Amendment](known-amendments.html#fixpaychanrecipientownerdir)が有効な場合は、メタデータは宛先のアカウントの[所有者ディレクトリー](directorynode.html)を変更して、新しく作成されるPayment Channelをリストで示す必要もあります。これにより、アカウントがオープンPayment Channelの受取人である場合に、そのアカウントが[削除される](deleting-accounts.html)ことを防ぎます。（fixPayChanRecipientOwnerDir Amendmentが有効になる前にPayment Channelが作成された場合は、アカウントを削除できます。）
|
||||||
|
|
||||||
Payment Channelの閉鎖を要求する方法は、Payment Channelの不変の`CancelAfter`時刻（作成時にのみ設定されます）以外にもいくつかあります。トランザクションでChannelの閉鎖をスケジュールする場合は、そのChannel用にLedgerEntryTypeが`PayChannel`の`ModifiedNode`エントリーがあり、`FinalFields`の`Expiration`フィールドには閉鎖時刻が新たに追加されています。以下の例は、送金元がクレームを清算せずにChannelを閉鎖するよう要求した場合に`PayChannel`に対して行われる変更を示します。
|
Payment Channelの閉鎖をリクエストする方法は、Payment Channelの不変の`CancelAfter`時刻（作成時にのみ設定されます）以外にもいくつかあります。トランザクションでChannelの閉鎖をスケジュールする場合は、そのChannel用にLedgerEntryTypeが`PayChannel`の`ModifiedNode`エントリーがあり、`FinalFields`の`Expiration`フィールドには閉鎖時刻が新たに追加されています。以下の例は、送金元がクレームを清算せずにChannelを閉鎖するようリクエストした場合に`PayChannel`に対して行われる変更を示します。
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ ECDSA署名はRおよびSと呼ばれる2つの整数で構成されています
|
|||||||
|
|
||||||
[RequireFullyCanonicalSig Amendment][]（2020年に有効）では、すべてのトランザクションは_完全正規(fully canonical)な_署名のみを使用しなければなりません。
|
[RequireFullyCanonicalSig Amendment][]（2020年に有効）では、すべてのトランザクションは_完全正規(fully canonical)な_署名のみを使用しなければなりません。
|
||||||
|
|
||||||
2014年から2020年の間、XRP Ledgerは常に完全な正規署名を生成するわけではないレガシーソフトウェアと互換性がありましたが、トランザクションの脆弱性から互換性のあるソフトウェアを保護するために、トランザクションに[**tfullyCanonicalSig`**](transaction-common-fields.html#global-flags)と呼ばれるフラグを使用していました。このフラグは互換署名ソフトウェアがデフォルトで有効にしており、トランザクショ ンが有効であるために _完全正規な_ 署名を使用することを要求していました。[RequireFullyCanonicalSig Amendment][]が有効になったので、このフラグは必要なくなりましたが、いずれにせよ有効にしても害はありません。
|
2014年から2020年の間、XRP Ledgerは常に完全な正規署名を生成するわけではないレガシーソフトウェアと互換性がありましたが、トランザクションの脆弱性から互換性のあるソフトウェアを保護するために、トランザクションに[**tfullyCanonicalSig`**](transaction-common-fields.html#global-flags)と呼ばれるフラグを使用していました。このフラグは互換署名ソフトウェアがデフォルトで有効にしており、トランザクショ ンが有効であるために _完全正規な_ 署名を使用することをリクエストしていました。[RequireFullyCanonicalSig Amendment][]が有効になったので、このフラグは必要なくなりましたが、いずれにせよ有効にしても害はありません。
|
||||||
|
|
||||||
|
|
||||||
### マルチシグの展性
|
### マルチシグの展性
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ _トランザクション（取引）_ は、XRP Ledgerを変更する唯一の
|
|||||||
|
|
||||||
### トランザクションの識別 <a id="identifying-transactions"></a>
|
### トランザクションの識別 <a id="identifying-transactions"></a>
|
||||||
|
|
||||||
署名付きトランザクションには、それを識別する固有の`"hash"`があります。トランザクションを送信すると、サーバーの応答でハッシュが返されます。[account_txコマンド](account_tx.html)を使用して、アカウントのトランザクション履歴でトランザクションを検索することもできます。
|
署名付きトランザクションには、それを識別する固有の`"hash"`があります。トランザクションを送信すると、サーバーのレスポンスでハッシュが返されます。[account_txコマンド](account_tx.html)を使用して、アカウントのトランザクション履歴でトランザクションを検索することもできます。
|
||||||
|
|
||||||
だれでも最終的なステータスを確認として[ハッシュによってトランザクションを調べる](look-up-transaction-results.html)ことができるため、トランザクションハッシュは「支払いの証明」として使用することができます。
|
だれでも最終的なステータスを確認として[ハッシュによってトランザクションを調べる](look-up-transaction-results.html)ことができるため、トランザクションハッシュは「支払いの証明」として使用することができます。
|
||||||
|
|
||||||
@@ -107,7 +107,7 @@ XRP Ledgerは、トランザクションオブジェクトが送信元アドレ
|
|||||||
|
|
||||||
**注意:** トランザクションが結果コード`tesSUCCESS`で**検証済み**のレジャーに表示されない限り、トランザクションの成功は確定ではありません。関連項目: [結果のファイナリティー](finality-of-results.html)
|
**注意:** トランザクションが結果コード`tesSUCCESS`で**検証済み**のレジャーに表示されない限り、トランザクションの成功は確定ではありません。関連項目: [結果のファイナリティー](finality-of-results.html)
|
||||||
|
|
||||||
`tx`コマンドの応答の例:
|
`tx`コマンドのレスポンスの例:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -162,7 +162,7 @@ For each persisted transaction without validated result:
|
|||||||
|
|
||||||
サーバーに、トランザクションが最初に送信されてから、レジャーが`LastLedgerSequence`によって識別された時点までを含む、継続したレジャー履歴がない場合には、トランザクションの最終結果を得られない可能性があります。（サーバーにないレジャーバージョンに結果が含まれている場合、成功したか失敗したかが分かりません。）
|
サーバーに、トランザクションが最初に送信されてから、レジャーが`LastLedgerSequence`によって識別された時点までを含む、継続したレジャー履歴がない場合には、トランザクションの最終結果を得られない可能性があります。（サーバーにないレジャーバージョンに結果が含まれている場合、成功したか失敗したかが分かりません。）
|
||||||
|
|
||||||
`rippled`サーバーにリソース（CPU/RAM/ディスクIO）の余裕がある場合には、不足しているレジャーバージョンを自動的に取得します。ただし、取得しようとするレジャーが[保管する履歴の設定期間](ledger-history.html)よりも古い場合には取得されません。ギャップのサイズや、サーバーのリソース使用率に基づき、不足しているレジャーバージョンの取得には数分かかります。[ledger_requestメソッド][]を使用して、履歴レジャーバージョンを取得するようにサーバーに要求できます。しかし、そうしても、サーバーに設定された履歴範囲外のレジャーバージョンからのトランザクション結果は検索できない場合があります。
|
`rippled`サーバーにリソース（CPU/RAM/ディスクIO）の余裕がある場合には、不足しているレジャーバージョンを自動的に取得します。ただし、取得しようとするレジャーが[保管する履歴の設定期間](ledger-history.html)よりも古い場合には取得されません。ギャップのサイズや、サーバーのリソース使用率に基づき、不足しているレジャーバージョンの取得には数分かかります。[ledger_requestメソッド][]を使用して、履歴レジャーバージョンを取得するようにサーバーにリクエストできます。しかし、そうしても、サーバーに設定された履歴範囲外のレジャーバージョンからのトランザクション結果は検索できない場合があります。
|
||||||
|
|
||||||
あるいは、`s2.ripple.com`にあるRippleの完全履歴サーバーなど、必要なレジャー履歴を含む別の`rippled`サーバーを使用して、トランザクションのステータスを検索することもできます。この目的には、信頼できるサーバーのみを使用してください。不正なサーバーは、トランザクションのステータスや結果について偽の情報を提供するようにプログラムされている可能性があります。
|
あるいは、`s2.ripple.com`にあるRippleの完全履歴サーバーなど、必要なレジャー履歴を含む別の`rippled`サーバーを使用して、トランザクションのステータスを検索することもできます。この目的には、信頼できるサーバーのみを使用してください。不正なサーバーは、トランザクションのステータスや結果について偽の情報を提供するようにプログラムされている可能性があります。
|
||||||
|
|
||||||
@@ -193,7 +193,7 @@ For each persisted transaction without validated result:
|
|||||||
|
|
||||||
`rippled`には、最後に検証されたレジャーでのアカウントのシーケンス番号を知るための[account_infoメソッド][]があります。
|
`rippled`には、最後に検証されたレジャーでのアカウントのシーケンス番号を知るための[account_infoメソッド][]があります。
|
||||||
|
|
||||||
JSON-RPC要求:
|
JSON-RPCリクエスト:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -207,7 +207,7 @@ JSON-RPC要求:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
応答の本文:
|
レスポンスの本文:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -230,7 +230,7 @@ JSON-RPC要求:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
この例では、最後に検証されたレジャーの時点において（要求の`"ledger_index": "validated"`と、応答の`"validated": "true"`を参照）、アカウントのシーケンスは**4**です（`"account_data"`の`"Sequence": 4`を参照）。
|
この例では、最後に検証されたレジャーの時点において（リクエストの`"ledger_index": "validated"`と、レスポンスの`"validated": "true"`を参照）、アカウントのシーケンスは**4**です（`"account_data"`の`"Sequence": 4`を参照）。
|
||||||
|
|
||||||
アプリケーションが、このアカウントで署名された3つのトランザクションを送信する場合には、4、5、6のシーケンス番号を使用します。各トランザクションの検証を待たずに複数のトランザクションを送信するには、アプリケーションで継続的なアカウントシーケンス番号を使用します。
|
アプリケーションが、このアカウントで署名された3つのトランザクションを送信する場合には、4、5、6のシーケンス番号を使用します。各トランザクションの検証を待たずに複数のトランザクションを送信するには、アプリケーションで継続的なアカウントシーケンス番号を使用します。
|
||||||
|
|
||||||
@@ -238,7 +238,7 @@ JSON-RPC要求:
|
|||||||
|
|
||||||
[server_stateメソッド][]は、最後に検証されたレジャーのレジャーインデックスを返します。
|
[server_stateメソッド][]は、最後に検証されたレジャーのレジャーインデックスを返します。
|
||||||
|
|
||||||
要求:
|
リクエスト:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -247,7 +247,7 @@ JSON-RPC要求:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
応答:
|
レスポンス:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -282,13 +282,13 @@ JSON-RPC要求:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
この例では、最後の検証済みレジャーインデックスは10268596（応答の`result.state.validated_ledger`の下）です。この例では、レジャー履歴にギャップがあることも示されています。ここで使用されたサーバーは、ギャップの間（レジャー10256383から10256411）に適用されたトランザクションに関する情報を提供することはできません。その部分のレジャー履歴を取得するよう設定されていれば、最終的にサーバーで取得できます。
|
この例では、最後の検証済みレジャーインデックスは10268596（レスポンスの`result.state.validated_ledger`の下）です。この例では、レジャー履歴にギャップがあることも示されています。ここで使用されたサーバーは、ギャップの間（レジャー10256383から10256411）に適用されたトランザクションに関する情報を提供することはできません。その部分のレジャー履歴を取得するよう設定されていれば、最終的にサーバーで取得できます。
|
||||||
|
|
||||||
#### トランザクションの生成
|
#### トランザクションの生成
|
||||||
|
|
||||||
`rippled`には、トランザクション送信に備えて準備するための[signメソッド][]があります。このメソッドは信頼できる`rippled`インスタンスにのみに渡すことができるアカウントの機密情報を必要とします。この例では、10 FOO（架空の通貨）を別のXRP Ledgerアドレスに発行します。
|
`rippled`には、トランザクション送信に備えて準備するための[signメソッド][]があります。このメソッドは信頼できる`rippled`インスタンスにのみに渡すことができるアカウントの機密情報を必要とします。この例では、10 FOO（架空の通貨）を別のXRP Ledgerアドレスに発行します。
|
||||||
|
|
||||||
要求:
|
リクエスト:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -319,7 +319,7 @@ JSON-RPC要求:
|
|||||||
|
|
||||||
また、アプリケーションが`server_state`から取得した最後の検証済みレジャーに基づく`LastLedgerSequence`にも注意してください。バックエンドアプリケーションでは、*「最後の検証済みレジャーインデックス + 4」*を使用することをお勧めします。または、*「現行のレジャー + 3」*の値を使用します。`LastLedgerSequence`の計算が誤りで、最後の検証済みレジャーの番号よりも小さい場合には、そのトランザクションは`tefMAX_LEDGER`エラーで失敗します。
|
また、アプリケーションが`server_state`から取得した最後の検証済みレジャーに基づく`LastLedgerSequence`にも注意してください。バックエンドアプリケーションでは、*「最後の検証済みレジャーインデックス + 4」*を使用することをお勧めします。または、*「現行のレジャー + 3」*の値を使用します。`LastLedgerSequence`の計算が誤りで、最後の検証済みレジャーの番号よりも小さい場合には、そのトランザクションは`tefMAX_LEDGER`エラーで失敗します。
|
||||||
|
|
||||||
応答:
|
レスポンス:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -353,7 +353,7 @@ JSON-RPC要求:
|
|||||||
|
|
||||||
`rippled`には、署名されたトランザクションの送信を可能にする、[submitメソッド][]があります。これは、`sign`メソッドで返された`tx_blob`パラメーターを使用します。
|
`rippled`には、署名されたトランザクションの送信を可能にする、[submitメソッド][]があります。これは、`sign`メソッドで返された`tx_blob`パラメーターを使用します。
|
||||||
|
|
||||||
要求:
|
リクエスト:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -366,7 +366,7 @@ JSON-RPC要求:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
応答:
|
レスポンス:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -403,7 +403,7 @@ JSON-RPC要求:
|
|||||||
|
|
||||||
トランザクションの結果を取得するために、トランザクションが署名された時に生成されるトランザクションハッシュが[txメソッド][]に渡されます。
|
トランザクションの結果を取得するために、トランザクションが署名された時に生成されるトランザクションハッシュが[txメソッド][]に渡されます。
|
||||||
|
|
||||||
要求:
|
リクエスト:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -417,7 +417,7 @@ JSON-RPC要求:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
応答:
|
レスポンス:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -451,9 +451,9 @@ JSON-RPC要求:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
この応答例には、`"validated": true`があります。これは、トランザクションが検証済みレジャーに含まれていること、つまりトランザクション結果が不変であることを示しています。さらに、メタデータには、トランザクションがレジャーに適用されたことを示す`"TransactionResult": "tesSUCCESS"`が含まれています。
|
このレスポンス例には、`"validated": true`があります。これは、トランザクションが検証済みレジャーに含まれていること、つまりトランザクション結果が不変であることを示しています。さらに、メタデータには、トランザクションがレジャーに適用されたことを示す`"TransactionResult": "tesSUCCESS"`が含まれています。
|
||||||
|
|
||||||
応答に`"validated": true`が含まれていない場合には、結果は暫定的であり変化する可能性があります。最終結果を取得するには、アプリケーションで`tx`メソッドを再度呼び出し、ネットワークでさらに多くのレジャーバージョンを検証できるよう十分な時間をかけます。`LastLedgerSequence`で指定されたレジャーが検証されるまで待たなければならない場合もありますが、そのトランザクションが以前の検証済みレジャーに含まれている場合には、その結果はその時点で不変です。
|
レスポンスに`"validated": true`が含まれていない場合には、結果は暫定的であり変化する可能性があります。最終結果を取得するには、アプリケーションで`tx`メソッドを再度呼び出し、ネットワークでさらに多くのレジャーバージョンを検証できるよう十分な時間をかけます。`LastLedgerSequence`で指定されたレジャーが検証されるまで待たなければならない場合もありますが、そのトランザクションが以前の検証済みレジャーに含まれている場合には、その結果はその時点で不変です。
|
||||||
|
|
||||||
#### 不明のトランザクションの確認
|
#### 不明のトランザクションの確認
|
||||||
|
|
||||||
@@ -514,7 +514,7 @@ JSON-RPC要求:
|
|||||||
|
|
||||||
サーバーは、指定された`LastLedgerSequence`よりも小さい値の最後の検証済みレジャーインデックスをレポートする場合があります。その場合、`txnNotFound`に、（a）送信されたトランザクションがまだネットワークに配布されていないこと、または（b）トランザクションがネットワークに配布されたものの、まだ処理されていないことを示します。最初のケースに対処するために、アプリケーションは再度同じ署名済みのトランザクションを送信できます。トランザクションには固有のアカウントシーケンス番号がつけられているため、処理されるのは一度のみです。
|
サーバーは、指定された`LastLedgerSequence`よりも小さい値の最後の検証済みレジャーインデックスをレポートする場合があります。その場合、`txnNotFound`に、（a）送信されたトランザクションがまだネットワークに配布されていないこと、または（b）トランザクションがネットワークに配布されたものの、まだ処理されていないことを示します。最初のケースに対処するために、アプリケーションは再度同じ署名済みのトランザクションを送信できます。トランザクションには固有のアカウントシーケンス番号がつけられているため、処理されるのは一度のみです。
|
||||||
|
|
||||||
最後に、サーバーにトランザクション履歴のギャップが1つ以上存在する場合があります。上記の応答に示される`completed_ledgers`フィールドは、このrippledインスタンスの10256383から10256411のレジャーが不足していることを示しています。このトランザクションの例では、（トランザクションの送信時点と`LastLedgerSequence`に基づいて）トランザクションは10268597から10268600のレジャーのみに含まれるため、このギャップはここでは関係ありません。ただし、必要範囲のレジャーが不足している場合には、`txnNotFound`の結果が不変の結果であるかどうかを判断するために、アプリケーションは別のrippledサーバーに照会する（またはこのサーバーによって不足しているレジャーが取得されるまで待つ）必要があります。
|
最後に、サーバーにトランザクション履歴のギャップが1つ以上存在する場合があります。上記のレスポンスに示される`completed_ledgers`フィールドは、このrippledインスタンスの10256383から10256411のレジャーが不足していることを示しています。このトランザクションの例では、（トランザクションの送信時点と`LastLedgerSequence`に基づいて）トランザクションは10268597から10268600のレジャーのみに含まれるため、このギャップはここでは関係ありません。ただし、必要範囲のレジャーが不足している場合には、`txnNotFound`の結果が不変の結果であるかどうかを判断するために、アプリケーションは別のrippledサーバーに照会する（またはこのサーバーによって不足しているレジャーが取得されるまで待つ）必要があります。
|
||||||
|
|
||||||
## その他のリソース
|
## その他のリソース
|
||||||
|
|
||||||
|
|||||||
@@ -95,7 +95,7 @@ XRP LedgerをスパムやDoS攻撃から守るため、各トランザクショ
|
|||||||
|
|
||||||
### server_info
|
### server_info
|
||||||
|
|
||||||
[server_infoメソッド][]は、`validated_ledger.base_fee_xrp`と同様に、前のレジャー時点のスケーリングされていない最低XRPコストを10進XRPの形式でレポートします。トランザクションを中継するために必要な実際のコストをスケーリングするには、その`base_fee_xrp`値に同じ応答内の`load_factor`パラメーターを掛けます。このパラメーターは、サーバーの現在の負荷レベルを表します。つまり、次の式になります。
|
[server_infoメソッド][]は、`validated_ledger.base_fee_xrp`と同様に、前のレジャー時点のスケーリングされていない最低XRPコストを10進XRPの形式でレポートします。トランザクションを中継するために必要な実際のコストをスケーリングするには、その`base_fee_xrp`値に同じレスポンス内の`load_factor`パラメーターを掛けます。このパラメーターは、サーバーの現在の負荷レベルを表します。つまり、次の式になります。
|
||||||
|
|
||||||
**XRP単位の現在のトランザクションコスト = `base_fee_xrp` × `load_factor`**
|
**XRP単位の現在のトランザクションコスト = `base_fee_xrp` × `load_factor`**
|
||||||
|
|
||||||
|
|||||||
@@ -65,7 +65,7 @@ labels:
|
|||||||
|
|
||||||
キュー内のトランザクションの数が次のレジャーバージョンの予期サイズを超える場合には、キュー内のトランザクションの正確な順序に基づいて、次の処理レジャーバージョンに追加されるトランザクションが決定します。トランザクションの順序は**検証済みレジャー内でのトランザクションの実行順序には影響しません**。各検証済みレジャーバージョンでは、そのバージョンのトランザクションセットが[正規の順序](consensus-structure.html#検証の計算と共有)で実行されます。
|
キュー内のトランザクションの数が次のレジャーバージョンの予期サイズを超える場合には、キュー内のトランザクションの正確な順序に基づいて、次の処理レジャーバージョンに追加されるトランザクションが決定します。トランザクションの順序は**検証済みレジャー内でのトランザクションの実行順序には影響しません**。各検証済みレジャーバージョンでは、そのバージョンのトランザクションセットが[正規の順序](consensus-structure.html#検証の計算と共有)で実行されます。
|
||||||
|
|
||||||
**注記:**`rippled`がトランザクションをキューに入れるときに付与される暫定的な[トランザクション応答コード](transaction-results.html)は`terQUEUED`です。つまり、トランザクションは今後のレジャーバージョンで成功する見込みです。すべての暫定的な応答コードと同様に、トランザクションが検証済みレジャーに追加されるか、または[完全に無効であると示される](finality-of-results.html)までは、トランザクションの結果は最終的ではありません。
|
**注記:**`rippled`がトランザクションをキューに入れるときに付与される暫定的な[トランザクションレスポンスコード](transaction-results.html)は`terQUEUED`です。つまり、トランザクションは今後のレジャーバージョンで成功する見込みです。すべての暫定的なレスポンスコードと同様に、トランザクションが検証済みレジャーに追加されるか、または[完全に無効であると示される](finality-of-results.html)までは、トランザクションの結果は最終的ではありません。
|
||||||
|
|
||||||
|
|
||||||
## 関連項目
|
## 関連項目
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ labels:
|
|||||||
|
|
||||||
$ rippled --conf=/etc/opt/ripple/rippled.cfg can_delete now
|
$ rippled --conf=/etc/opt/ripple/rippled.cfg can_delete now
|
||||||
|
|
||||||
応答は、サーバーがそのレジャーストアーから削除するレジャーインデックスの最大値を示します。たとえば、以下のメッセージはレジャーインデックス43633667以下のレジャーバージョンを削除できることを示します。
|
レスポンスは、サーバーがそのレジャーストアーから削除するレジャーインデックスの最大値を示します。たとえば、以下のメッセージはレジャーインデックス43633667以下のレジャーバージョンを削除できることを示します。
|
||||||
|
|
||||||
{
|
{
|
||||||
"result": {
|
"result": {
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ labels:
|
|||||||
|
|
||||||
`rippled` サーバーは履歴シャードを取得して保存します（この動作には設定が必要です）。このようなサーバーでは、ネットワークとの同期を実行し、設定された数の最新レジャーへのレジャー履歴の埋め戻しが完了した後で、シャードの取得が開始されます。ネットワークアクティビティがあまり発生しないこの期間に、`shard_db`を維持するように設定されている`rippled`サーバー が、シャードストアーに追加するシャードをランダムに選択します。ネットワークレジャー履歴が均等に分散される確率を高めるため、取得対象のシャードはランダムに選択され、現行シャードが特に優先されることはありません。
|
`rippled` サーバーは履歴シャードを取得して保存します（この動作には設定が必要です）。このようなサーバーでは、ネットワークとの同期を実行し、設定された数の最新レジャーへのレジャー履歴の埋め戻しが完了した後で、シャードの取得が開始されます。ネットワークアクティビティがあまり発生しないこの期間に、`shard_db`を維持するように設定されている`rippled`サーバー が、シャードストアーに追加するシャードをランダムに選択します。ネットワークレジャー履歴が均等に分散される確率を高めるため、取得対象のシャードはランダムに選択され、現行シャードが特に優先されることはありません。
|
||||||
|
|
||||||
シャードが選択されたら、レジャー取得プロセスが開始されます。最初にシャードの最後のレジャーのシーケンスが取得され、最初のシャードに向けて逆方向に処理が進められます。取得プロセスでは最初に、サーバーがローカルでデータを確認します。取得できないデータについては、サーバーはピア`rippled`サーバーにデータを要求します。要求された期間のデータを供給できるサーバーは、履歴で応答します。要求側サーバーはこれらの応答を結合し、シャードを作成します。シャードに特定範囲のレジャーがすべて含まれた状態になれば、シャードが完成します。
|
シャードが選択されたら、レジャー取得プロセスが開始されます。最初にシャードの最後のレジャーのシーケンスが取得され、最初のシャードに向けて逆方向に処理が進められます。取得プロセスでは最初に、サーバーがローカルでデータを確認します。取得できないデータについては、サーバーはピア`rippled`サーバーにデータをリクエストします。リクエストされた期間のデータを供給できるサーバーは、履歴でレスポンスします。リクエスト側サーバーはこれらのレスポンスを結合し、シャードを作成します。シャードに特定範囲のレジャーがすべて含まれた状態になれば、シャードが完成します。
|
||||||
|
|
||||||
`rippled`サーバーが1つのシャードを完全に取得する前に容量不足になった場合、空き容量ができて処理を続行できるようになるまで取得プロセスを停止します。この後、古いシャードは完成された最新のシャードに置き換えられます。ディスク容量が十分にある場合は、`rippled`サーバーはシャードに割り当てられている最大ディスク容量（`max_size_gb`）に達するまで、ランダムに選択された追加のシャードを取得し、シャードストアーに追加します。
|
`rippled`サーバーが1つのシャードを完全に取得する前に容量不足になった場合、空き容量ができて処理を続行できるようになるまで取得プロセスを停止します。この後、古いシャードは完成された最新のシャードに置き換えられます。ディスク容量が十分にある場合は、`rippled`サーバーはシャードに割り当てられている最大ディスク容量（`max_size_gb`）に達するまで、ランダムに選択された追加のシャードを取得し、シャードストアーに追加します。
|
||||||
|
|
||||||
|
|||||||
@@ -84,7 +84,7 @@ labels:
|
|||||||
|
|
||||||
この設定はデフォルトで無効になっています。
|
この設定はデフォルトで無効になっています。
|
||||||
|
|
||||||
- **`[fetch_depth]`** - 検証済みレジャーバージョンの数を指定します。サーバーは、指定されている数のレジャーバージョンよりも古い履歴データに対するピアからの取得要求を受け入れません。使用可能なすべてのデータをピアに提供するには、値`full`を指定します。
|
- **`[fetch_depth]`** - 検証済みレジャーバージョンの数を指定します。サーバーは、指定されている数のレジャーバージョンよりも古い履歴データに対するピアからの取得リクエストを受け入れません。使用可能なすべてのデータをピアに提供するには、値`full`を指定します。
|
||||||
|
|
||||||
`fetch_depth`のデフォルトは`full`です（使用可能なすべてのデータを提供します）。
|
`fetch_depth`のデフォルトは`full`です（使用可能なすべてのデータを提供します）。
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ labels:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
各応答の`validation_seed`パラメーターと`validation_public_key`パラメーターを安全な場所に保存します。
|
各レスポンスの`validation_seed`パラメーターと`validation_public_key`パラメーターを安全な場所に保存します。
|
||||||
|
|
||||||
3. 各サーバーで[構成ファイル](https://github.com/XRPLF/rippled/blob/master/cfg/rippled-example.cfg)を編集し、以下のセクションを変更します。
|
3. 各サーバーで[構成ファイル](https://github.com/XRPLF/rippled/blob/master/cfg/rippled-example.cfg)を編集し、以下のセクションを変更します。
|
||||||
|
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ labels:
|
|||||||
|
|
||||||
6. [peersメソッド][]を使用して、プライベートサーバーが自身のピアに _のみ_ 接続していることを確認します。
|
6. [peersメソッド][]を使用して、プライベートサーバーが自身のピアに _のみ_ 接続していることを確認します。
|
||||||
|
|
||||||
応答の`peers`配列に、構成済みのピアのいずれでもない`address`を持つオブジェクトが含まれていてはなりません。含まれている場合は、構成ファイルを再度確認して、プライベートサーバーを再起動します。
|
レスポンスの`peers`配列に、構成済みのピアのいずれでもない`address`を持つオブジェクトが含まれていてはなりません。含まれている場合は、構成ファイルを再度確認して、プライベートサーバーを再起動します。
|
||||||
|
|
||||||
|
|
||||||
## 次のステップ
|
## 次のステップ
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ labels:
|
|||||||
---
|
---
|
||||||
# ピアクローラの設定
|
# ピアクローラの設定
|
||||||
|
|
||||||
デフォルトでは、[`rippled`サーバ](xrpl-servers.html)は、[ピアクローラAPI](peer-crawler.html)を使って要求してきた人に統計を公開し、[XRP Ledgerのピアツーピアネットワーク](peer-protocol.html)の健全性と状況を追跡しやすくしています。より多くの情報を提供したり、より少ない情報を提供したり、あるいはピアクローラーのリクエストを完全に拒否するように、サーバを設定することができます。
|
デフォルトでは、[`rippled`サーバ](xrpl-servers.html)は、[ピアクローラAPI](peer-crawler.html)を使ってリクエストしてきた人に統計を公開し、[XRP Ledgerのピアツーピアネットワーク](peer-protocol.html)の健全性と状況を追跡しやすくしています。より多くの情報を提供したり、より少ない情報を提供したり、あるいはピアクローラーのリクエストを完全に拒否するように、サーバを設定することができます。
|
||||||
|
|
||||||
このドキュメントには、2つのオプションについて説明しています。
|
このドキュメントには、2つのオプションについて説明しています。
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ labels:
|
|||||||
|
|
||||||
## ピアクローラが報告する情報の変更
|
## ピアクローラが報告する情報の変更
|
||||||
|
|
||||||
ピアクローラからの要求に対してサーバが提供する情報量を設定するには、以下の手順を実行します。
|
ピアクローラからのリクエストに対してサーバが提供する情報量を設定するには、以下の手順を実行します。
|
||||||
|
|
||||||
1. `rippled`の設定ファイルを編集します。
|
1. `rippled`の設定ファイルを編集します。
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ labels:
|
|||||||
|
|
||||||
## ピアクローラの無効化
|
## ピアクローラの無効化
|
||||||
|
|
||||||
サーバのピアクローラAPIを無効にして、ピアクローラーリクエストにまったく応答しないようにするには、以下の手順を実行します。
|
サーバのピアクローラAPIを無効にして、ピアクローラーリクエストにまったくレスポンスしないようにするには、以下の手順を実行します。
|
||||||
|
|
||||||
1. `rippled`の設定ファイルを編集します。
|
1. `rippled`の設定ファイルを編集します。
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ lables:
|
|||||||
|
|
||||||
永続ノードキーペア値をすでにサーバーに設定している場合は、[ステップ2: ノード公開鍵をピアの管理者に連絡する](#2ストックサーバーのノード公開鍵を連絡する)に進んでください。（例えば、各サーバーの永続ノードキーペアは[サーバークラスターの設定](cluster-rippled-servers.html)の一環として設定します。）
|
永続ノードキーペア値をすでにサーバーに設定している場合は、[ステップ2: ノード公開鍵をピアの管理者に連絡する](#2ストックサーバーのノード公開鍵を連絡する)に進んでください。（例えば、各サーバーの永続ノードキーペアは[サーバークラスターの設定](cluster-rippled-servers.html)の一環として設定します。）
|
||||||
|
|
||||||
**ヒント:** 永続ノードキーペアの設定は省略可能ですが、この設定をしておけば、サーバーのデータベースの消去や新規マシンへの移行が必要となった場合にピア接続の設定を容易に維持することができます。永続ノードキーペアを設定しない場合は、[server_infoメソッド][]の応答の`pubkey_node`フィールドに表示される、サーバーが自動生成したノード公開鍵を使用できます。
|
**ヒント:** 永続ノードキーペアの設定は省略可能ですが、この設定をしておけば、サーバーのデータベースの消去や新規マシンへの移行が必要となった場合にピア接続の設定を容易に維持することができます。永続ノードキーペアを設定しない場合は、[server_infoメソッド][]のレスポンスの`pubkey_node`フィールドに表示される、サーバーが自動生成したノード公開鍵を使用できます。
|
||||||
|
|
||||||
1. [validation_createメソッド][]を使用して新しいランダムキーペアを生成します。（`secret`値を省略します。）
|
1. [validation_createメソッド][]を使用して新しいランダムキーペアを生成します。（`secret`値を省略します。）
|
||||||
|
|
||||||
|
|||||||
@@ -124,7 +124,7 @@ top_nav_name: UNLに参加しよう
|
|||||||
|
|
||||||
$ rippled server_info
|
$ rippled server_info
|
||||||
|
|
||||||
- 応答に含まれている`pubkey_validator`の値は、バリデータで使用するために生成した`validator-keys.json`ファイルの`public_key`と一致している必要があります。
|
- レスポンスに含まれている`pubkey_validator`の値は、バリデータで使用するために生成した`validator-keys.json`ファイルの`public_key`と一致している必要があります。
|
||||||
|
|
||||||
- `server_state`の値は、 _**proposing**_ にする必要があります。
|
- `server_state`の値は、 _**proposing**_ にする必要があります。
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ _**プロキシを使用してバリデータをXRP Ledgerネットワークに
|
|||||||
|
|
||||||
$ sudo systemctl restart rippled.service
|
$ sudo systemctl restart rippled.service
|
||||||
|
|
||||||
6. いずれかのストック`rippled`サーバーにある[ピアクローラー](peer-crawler.html)エンドポイントを使用します。応答には、バリデータが含まれていないはずです。これにより、バリデータの`[peer_private]`構成が機能していることが確認されます。バリデータの`[peer_private]`を有効にした場合の効果の1つは、バリデータのピアによって、ピアクローラーの結果にバリデータが含まれないことです。
|
6. いずれかのストック`rippled`サーバーにある[ピアクローラー](peer-crawler.html)エンドポイントを使用します。レスポンスには、バリデータが含まれていないはずです。これにより、バリデータの`[peer_private]`構成が機能していることが確認されます。バリデータの`[peer_private]`を有効にした場合の効果の1つは、バリデータのピアによって、ピアクローラーの結果にバリデータが含まれないことです。
|
||||||
|
|
||||||
$ curl --insecure https://STOCK_SERVER_IP_ADDRESS_HERE:51235/crawl | python3 -m json.tool
|
$ curl --insecure https://STOCK_SERVER_IP_ADDRESS_HERE:51235/crawl | python3 -m json.tool
|
||||||
|
|
||||||
@@ -252,7 +252,7 @@ _**公開ハブを使用してバリデータをネットワークに接続す
|
|||||||
|
|
||||||
2. バリデータの公開鍵を公開し、特に他の`rippled`オペレーターに知らせます。例えば、Webサイト、ソーシャルメディア、[XRPChatコミュニティーフォーラム](https://www.xrpchat.com/)、またはプレスリリースでバリデータの公開鍵を公表できます。
|
2. バリデータの公開鍵を公開し、特に他の`rippled`オペレーターに知らせます。例えば、Webサイト、ソーシャルメディア、[XRPChatコミュニティーフォーラム](https://www.xrpchat.com/)、またはプレスリリースでバリデータの公開鍵を公表できます。
|
||||||
|
|
||||||
3. この[Googleフォーム](https://docs.google.com/forms/d/e/1FAIpQLScszfq7rRLAfArSZtvitCyl-VFA9cNcdnXLFjURsdCQ3gHW7w/viewform)を使用して、自身のバリデータをXRP Chartsの[バリデータレジストリー](https://xrpcharts.ripple.com/#/validators)に登録するための要求を送信します。バリデータをこのレジストリーに登録することは、そのバリデータとドメインを所有していることを示す、別の形での公的な証拠になります。フォームに漏れなく記入するには、以下の情報が必要です。
|
3. この[Googleフォーム](https://docs.google.com/forms/d/e/1FAIpQLScszfq7rRLAfArSZtvitCyl-VFA9cNcdnXLFjURsdCQ3gHW7w/viewform)を使用して、自身のバリデータをXRP Chartsの[バリデータレジストリー](https://xrpcharts.ripple.com/#/validators)に登録するためのリクエストを送信します。バリデータをこのレジストリーに登録することは、そのバリデータとドメインを所有していることを示す、別の形での公的な証拠になります。フォームに漏れなく記入するには、以下の情報が必要です。
|
||||||
|
|
||||||
1. バリデータのサーバーで以下のコマンドを実行して、バリデータの公開鍵を検出します。
|
1. バリデータのサーバーで以下のコマンドを実行して、バリデータの公開鍵を検出します。
|
||||||
|
|
||||||
|
|||||||
@@ -415,7 +415,7 @@ Docker Composeを使用すると、簡単な`yaml`ファイルの設定でコン
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
すべてのバリデータノードは、`r9wRwVgL2vWVnKhTPdtxva5vdH7FNw1zPs`アカウントの同じ残高1000000000XRPで応答する必要があります。
|
すべてのバリデータノードは、`r9wRwVgL2vWVnKhTPdtxva5vdH7FNw1zPs`アカウントの同じ残高1000000000XRPでレスポンスする必要があります。
|
||||||
|
|
||||||
## ネットワークを停止する
|
## ネットワークを停止する
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ labels:
|
|||||||
rippled server_info
|
rippled server_info
|
||||||
```
|
```
|
||||||
|
|
||||||
このコマンドに対する応答には大量の情報が含まれています。これについては、[server_infoメソッド][]で説明します。トラブルシューティングで最も重要なフィールドは以下のとおりです（最も一般的に使われるものから順に説明します）。
|
このコマンドに対するレスポンスには大量の情報が含まれています。これについては、[server_infoメソッド][]で説明します。トラブルシューティングで最も重要なフィールドは以下のとおりです（最も一般的に使われるものから順に説明します）。
|
||||||
|
|
||||||
- **`server_state`** - ほとんどの場合、このフィールドには`proposing`（[バリデータとして設定されている](run-rippled-as-a-validator.html)サーバーの場合）または`full`（バリデータではないサーバーの場合）が表示されます。値が`connected`の場合は、サーバーはピアツーピアネットワークの他の部分と通信できますが、共有レジャーの状態を追跡するのに十分なデータがありません。通常、レジャーの残りの部分の状態を同期するには起動後約5～15分かかります。
|
- **`server_state`** - ほとんどの場合、このフィールドには`proposing`（[バリデータとして設定されている](run-rippled-as-a-validator.html)サーバーの場合）または`full`（バリデータではないサーバーの場合）が表示されます。値が`connected`の場合は、サーバーはピアツーピアネットワークの他の部分と通信できますが、共有レジャーの状態を追跡するのに十分なデータがありません。通常、レジャーの残りの部分の状態を同期するには起動後約5～15分かかります。
|
||||||
|
|
||||||
@@ -79,7 +79,7 @@ rippled server_info
|
|||||||
[ips_fixed]
|
[ips_fixed]
|
||||||
s2.ripple.com 51235
|
s2.ripple.com 51235
|
||||||
|
|
||||||
- **`amendment_blocked`** - このフィールドは通常`server_info`応答では省略されます。このフィールドの値が`true`の場合は、ネットワークにより承認された[Amendment](amendments.html)がサーバーに導入されていません。ほとんどの場合は、最新バージョンに[rippledを更新する](install-rippled.html)ことで修正できます。また[featureメソッド][]を使用して、現在有効なAmendment ID、サーバーでサポートされているAmendment ID、サーバーでサポートされていないAmendment IDを確認することもできます。
|
- **`amendment_blocked`** - このフィールドは通常`server_info`レスポンスでは省略されます。このフィールドの値が`true`の場合は、ネットワークにより承認された[Amendment](amendments.html)がサーバーに導入されていません。ほとんどの場合は、最新バージョンに[rippledを更新する](install-rippled.html)ことで修正できます。また[featureメソッド][]を使用して、現在有効なAmendment ID、サーバーでサポートされているAmendment ID、サーバーでサポートされていないAmendment IDを確認することもできます。
|
||||||
|
|
||||||
- **`peers`** - このフィールドは、サーバーが接続しているXRP Ledgerピアツーピアネットワーク内のその他のサーバーの数を示します。特定のピアのみに接続するように明示的に構成されているサーバーを除き、正常なサーバーでは通常5～50ピアと表示されます。
|
- **`peers`** - このフィールドは、サーバーが接続しているXRP Ledgerピアツーピアネットワーク内のその他のサーバーの数を示します。特定のピアのみに接続するように明示的に構成されているサーバーを除き、正常なサーバーでは通常5～50ピアと表示されます。
|
||||||
|
|
||||||
@@ -87,7 +87,7 @@ rippled server_info
|
|||||||
|
|
||||||
- ピアの数が10の場合、`rippled`が[NAT](https://en.wikipedia.org/wiki/Network_address_translation)を使用したルーター経由での着信接続を受信できていない可能性があります。接続を改善するには、ルーターのファイアウォールがピアツーピア接続に使用するポート（[デフォルトでは](https://github.com/XRPLF/rippled/blob/8429dd67e60ba360da591bfa905b58a35638fda1/cfg/rippled-example.cfg#L1065)ポート51235）を転送するように設定します。
|
- ピアの数が10の場合、`rippled`が[NAT](https://en.wikipedia.org/wiki/Network_address_translation)を使用したルーター経由での着信接続を受信できていない可能性があります。接続を改善するには、ルーターのファイアウォールがピアツーピア接続に使用するポート（[デフォルトでは](https://github.com/XRPLF/rippled/blob/8429dd67e60ba360da591bfa905b58a35638fda1/cfg/rippled-example.cfg#L1065)ポート51235）を転送するように設定します。
|
||||||
|
|
||||||
### サーバーから応答がない場合
|
### サーバーからレスポンスがない場合
|
||||||
|
|
||||||
`rippled`実行可能ファイルがクライアントとして`rippled`サーバーに接続できなかった場合、以下のメッセージが返されます。
|
`rippled`実行可能ファイルがクライアントとして`rippled`サーバーに接続できなかった場合、以下のメッセージが返されます。
|
||||||
|
|
||||||
|
|||||||
@@ -153,11 +153,11 @@ Terminating thread doJob:AcquisitionDone: unhandled
|
|||||||
|
|
||||||
11. `rippled`サービスが正常に起動したかどうかを確認します。
|
11. `rippled`サービスが正常に起動したかどうかを確認します。
|
||||||
|
|
||||||
[コマンドラインインターフェイス](get-started-using-http-websocket-apis.html#コマンドライン)を使用してサーバーの状況を確認できます（サーバーがJSON-RPC要求を受け入れないように設定している場合を除く）。次に例を示します。
|
[コマンドラインインターフェイス](get-started-using-http-websocket-apis.html#コマンドライン)を使用してサーバーの状況を確認できます（サーバーがJSON-RPCリクエストを受け入れないように設定している場合を除く）。次に例を示します。
|
||||||
|
|
||||||
/opt/ripple/bin/rippled server_info
|
/opt/ripple/bin/rippled server_info
|
||||||
|
|
||||||
このコマンドの予期される応答の説明については、[server_infoメソッド][]ドキュメントを参照してください。
|
このコマンドの予期されるレスポンスの説明については、[server_infoメソッド][]ドキュメントを参照してください。
|
||||||
|
|
||||||
12. サーバーのデバッグログを参照し、`SQLite page size`が現在4096であることを確認します。
|
12. サーバーのデバッグログを参照し、`SQLite page size`が現在4096であることを確認します。
|
||||||
|
|
||||||
|
|||||||
@@ -49,9 +49,9 @@ labels:
|
|||||||
|
|
||||||
デフォルトの構成では、`vl.ripple.com`から受信した推奨バリデータリストを使用します。このリストは、Rippleの暗号鍵ペアで署名されており、有効期限が組み込まれています。サーバーが何らかの理由でリストを`vl.ripple.com`からダウンロードできない場合、サーバーは信頼できるバリデータのセットを選択せず、有効として宣言できるレジャーを決定できません。（[Testnetや別の並列ネットワーク](parallel-networks.html)に接続している場合、サーバーは代わりにそのネットワークの信頼できるバリデータのリストを使用します。）
|
デフォルトの構成では、`vl.ripple.com`から受信した推奨バリデータリストを使用します。このリストは、Rippleの暗号鍵ペアで署名されており、有効期限が組み込まれています。サーバーが何らかの理由でリストを`vl.ripple.com`からダウンロードできない場合、サーバーは信頼できるバリデータのセットを選択せず、有効として宣言できるレジャーを決定できません。（[Testnetや別の並列ネットワーク](parallel-networks.html)に接続している場合、サーバーは代わりにそのネットワークの信頼できるバリデータのリストを使用します。）
|
||||||
|
|
||||||
[server_infoメソッド][]応答の`validator_list`ブロックは、バリデータリストの有効期限などのステータスを示します。リストがあるが期限切れである場合、サーバーは以前はそのバリデータリストのサイトに接続できていたものの、その後接続できなくなった可能性があります。その場合、現在のリストはサーバーがそれより新しいリストをダウンロードできなかったために期限切れとなった可能性があります。
|
[server_infoメソッド][]レスポンスの`validator_list`ブロックは、バリデータリストの有効期限などのステータスを示します。リストがあるが期限切れである場合、サーバーは以前はそのバリデータリストのサイトに接続できていたものの、その後接続できなくなった可能性があります。その場合、現在のリストはサーバーがそれより新しいリストをダウンロードできなかったために期限切れとなった可能性があります。
|
||||||
|
|
||||||
また、[validator_list_sitesメソッド][]を使用して、より詳細な情報を取得することもできます。応答内のバリデータサイトオブジェクトに`last_refresh_status`および`last_refresh_time`フィールドがない場合、サーバーからバリデータリストのサイトへの接続に問題があることを示しています。ファイアウォールの設定をチェックして、ポート80（HTTP）または443（HTTPS）の発信トラフィックをブロックしていないことを確認してください。また、DNSがバリデータリストのサイトのドメインを解決できることも確認してください。
|
また、[validator_list_sitesメソッド][]を使用して、より詳細な情報を取得することもできます。レスポンス内のバリデータサイトオブジェクトに`last_refresh_status`および`last_refresh_time`フィールドがない場合、サーバーからバリデータリストのサイトへの接続に問題があることを示しています。ファイアウォールの設定をチェックして、ポート80（HTTP）または443（HTTPS）の発信トラフィックをブロックしていないことを確認してください。また、DNSがバリデータリストのサイトのドメインを解決できることも確認してください。
|
||||||
|
|
||||||
<!-- TODO: create a tutorial for how to sideload a validator list from file and link it here -->
|
<!-- TODO: create a tutorial for how to sideload a validator list from file and link it here -->
|
||||||
|
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ Terminating thread rippled: main: unhandled St13runtime_error
|
|||||||
このようなメッセージが同時に大量に出力される場合は、以下のような問題がある可能性があります。
|
このようなメッセージが同時に大量に出力される場合は、以下のような問題がある可能性があります。
|
||||||
|
|
||||||
- 1つ以上の特定のピアへのインターネット接続が切断されている。
|
- 1つ以上の特定のピアへのインターネット接続が切断されている。
|
||||||
- サーバーからの要求でピアに過剰な負担がかかり、ピアがサーバーをドロップした。
|
- サーバーからのリクエストでピアに過剰な負担がかかり、ピアがサーバーをドロップした。
|
||||||
|
|
||||||
|
|
||||||
## InboundLedger 11 timeouts for ledger
|
## InboundLedger 11 timeouts for ledger
|
||||||
@@ -71,7 +71,7 @@ Terminating thread rippled: main: unhandled St13runtime_error
|
|||||||
InboundLedger:WRN 11 timeouts for ledger 8265938
|
InboundLedger:WRN 11 timeouts for ledger 8265938
|
||||||
```
|
```
|
||||||
|
|
||||||
これは、サーバーがそのピアに対して特定のレジャーデータを要求する際に問題が発生していることを示しています。[レジャーインデックス](basic-data-types.html#レジャーインデックス)が、[server_infoメソッド][]により報告される最新の検証済みレジャーのインデックスよりもかなり小さい場合は、サーバーが[履歴シャード](history-sharding.html)のダウンロード中である可能性があります。
|
これは、サーバーがそのピアに対して特定のレジャーデータをリクエストする際に問題が発生していることを示しています。[レジャーインデックス](basic-data-types.html#レジャーインデックス)が、[server_infoメソッド][]により報告される最新の検証済みレジャーのインデックスよりもかなり小さい場合は、サーバーが[履歴シャード](history-sharding.html)のダウンロード中である可能性があります。
|
||||||
|
|
||||||
これは厳密には問題ではありませんが、レジャー履歴を迅速に取得したい場合は、`[ips_fixed]`構成スタンザを追加または編集してからサーバーを再起動することで、すべての履歴が記録されたピアに接続するように`rippled`を構成できます。たとえば、すべての履歴が記録されたRippleのサーバーに常に接続するには、以下のようにします。
|
これは厳密には問題ではありませんが、レジャー履歴を迅速に取得したい場合は、`[ips_fixed]`構成スタンザを追加または編集してからサーバーを再起動することで、すべての履歴が記録されたピアに接続するように`rippled`を構成できます。たとえば、すべての履歴が記録されたRippleのサーバーに常に接続するには、以下のようにします。
|
||||||
|
|
||||||
@@ -83,7 +83,7 @@ s2.ripple.com 51235
|
|||||||
|
|
||||||
## InboundLedger Want hash
|
## InboundLedger Want hash
|
||||||
|
|
||||||
以下のようなログメッセージは、サーバーが他のサーバーにレジャーデータを要求していることを示しています。
|
以下のようなログメッセージは、サーバーが他のサーバーにレジャーデータをリクエストしていることを示しています。
|
||||||
|
|
||||||
```text
|
```text
|
||||||
InboundLedger:WRN Want: 5AE53B5E39E6388DBACD0959E5F5A0FCAF0E0DCBA45D9AB15120E8CDD21E019B
|
InboundLedger:WRN Want: 5AE53B5E39E6388DBACD0959E5F5A0FCAF0E0DCBA45D9AB15120E8CDD21E019B
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ XRP Ledgerとのすべてのやり取りは、レジャーに変更を加える
|
|||||||
|
|
||||||
## トランザクションの仕組み
|
## トランザクションの仕組み
|
||||||
|
|
||||||
トランザクションを実行するには、RESTコマンドをXRP Ledgerに送信し、その応答を待ちます。コマンドの構文は、すべてのトランザクションで常に共通です。
|
トランザクションを実行するには、RESTコマンドをXRP Ledgerに送信し、そのレスポンスを待ちます。コマンドの構文は、すべてのトランザクションで常に共通です。
|
||||||
|
|
||||||
トランザクションを行う _Account_ の _TransactionType_ とパブリックアドレスを常に提供する必要があります。
|
トランザクションを行う _Account_ の _TransactionType_ とパブリックアドレスを常に提供する必要があります。
|
||||||
|
|
||||||
|
|||||||
@@ -18,8 +18,8 @@ _`validation_create`メソッドは、権限のないユーザーは実行でき
|
|||||||
**ヒント:** 堅牢なバリデータを設定するには、`validator-keys`ツール（`rippled` RPMに付属）を使用してバリデータトークン（ローテーション可能）とオフラインマスターキーを生成してください。詳細は、[rippledサーバーで検証を有効化](run-rippled-as-a-validator.html#3-rippledサーバーで検証を有効化)を参照してください。
|
**ヒント:** 堅牢なバリデータを設定するには、`validator-keys`ツール（`rippled` RPMに付属）を使用してバリデータトークン（ローテーション可能）とオフラインマスターキーを生成してください。詳細は、[rippledサーバーで検証を有効化](run-rippled-as-a-validator.html#3-rippledサーバーで検証を有効化)を参照してください。
|
||||||
|
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIR
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------|:-------|:---------------------------------------------------------|
|
|:---------|:-------|:---------------------------------------------------------|
|
||||||
@@ -63,9 +63,9 @@ rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIR
|
|||||||
|
|
||||||
**注記:** バリデータのセキュリティは、シードのエントロピーに応じて異なります。シークレット値が強力なランダム性のソースを使用して生成されている場合を除き、実際の事業目的のためにシークレット値を使用しないでください。新しいクレデンシャルを初めて生成するときには`secret`を省略することが推奨されます。
|
**注記:** バリデータのセキュリティは、シードのエントロピーに応じて異なります。シークレット値が強力なランダム性のソースを使用して生成されている場合を除き、実際の事業目的のためにシークレット値を使用しないでください。新しいクレデンシャルを初めて生成するときには`secret`を省略することが推奨されます。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:------------------------|:-------|:------------------------------------------|
|
|:------------------------|:-------|:------------------------------------------|
|
||||||
@@ -111,7 +111,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
### 考えられるエラー
|
### 考えられるエラー
|
||||||
|
|
||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `badSeed` - 要求に無効なシード値が指定されていました。この場合は通常、シード値が異なるフォーマットの有効文字列（アカウントアドレス、検証の公開鍵など）である可能性があります。
|
* `badSeed` - リクエストに無効なシード値が指定されていました。この場合は通常、シード値が異なるフォーマットの有効文字列（アカウントアドレス、検証の公開鍵など）である可能性があります。
|
||||||
|
|
||||||
<!--{# common link defs #}-->
|
<!--{# common link defs #}-->
|
||||||
{% include '_snippets/rippled-api-links.md' %}
|
{% include '_snippets/rippled-api-links.md' %}
|
||||||
|
|||||||
@@ -15,9 +15,9 @@ labels:
|
|||||||
|
|
||||||
[更新: rippled 0.31.0][]
|
[更新: rippled 0.31.0][]
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ rippled wallet_propose masterpassphrase
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターを含めることができます。
|
リクエストには以下のパラメーターを含めることができます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------|:-------|:-----------------------------------------------------|
|
|:-------------|:-------|:-----------------------------------------------------|
|
||||||
@@ -108,9 +108,9 @@ rippled wallet_propose masterpassphrase
|
|||||||
[RFC-1751]: https://tools.ietf.org/html/rfc1751 ""
|
[RFC-1751]: https://tools.ietf.org/html/rfc1751 ""
|
||||||
[16進数]: https://en.wikipedia.org/wiki/Hexadecimal ""
|
[16進数]: https://en.wikipedia.org/wiki/Hexadecimal ""
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -172,7 +172,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従い、正常に終了した場合、新しい（可能性がある）アカウントについての重要な各種情報を含みます。以下のフィールドを含みます。
|
レスポンスは[標準フォーマット][]に従い、正常に終了した場合、新しい（可能性がある）アカウントについての重要な各種情報を含みます。以下のフィールドを含みます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:------------------|:-------|:------------------------------------------------|
|
|:------------------|:-------|:------------------------------------------------|
|
||||||
@@ -183,7 +183,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
| `account_id` | 文字列 | XRP Ledgerの[base58][]フォーマットで作成されたアカウントの[アドレス][]。これは公開鍵ではありませんが、公開鍵を2回ハッシュ化したものです。チェックサムも持っているため、タイプミスした場合はほぼ間違いなく無効なアドレスとみなされ、有効だが異なるアドレスとはみなされません。これはXRP LedgerのアカウントのプライマリIDです。支払いを受けるときにこれを人に伝えたり、トランザクションにおいて、自身や、支払先、委託先識別するのに使用します。[マルチシグリスト](multi-signing.html)でもこれを使用して、他の署名者を識別します。 |
|
| `account_id` | 文字列 | XRP Ledgerの[base58][]フォーマットで作成されたアカウントの[アドレス][]。これは公開鍵ではありませんが、公開鍵を2回ハッシュ化したものです。チェックサムも持っているため、タイプミスした場合はほぼ間違いなく無効なアドレスとみなされ、有効だが異なるアドレスとはみなされません。これはXRP LedgerのアカウントのプライマリIDです。支払いを受けるときにこれを人に伝えたり、トランザクションにおいて、自身や、支払先、委託先識別するのに使用します。[マルチシグリスト](multi-signing.html)でもこれを使用して、他の署名者を識別します。 |
|
||||||
| `public_key` | 文字列 | XRP Ledgerの[base58][]エンコード文字列フォーマットで作成された、キーペアの公開鍵。`master_seed`から生成されます。 |
|
| `public_key` | 文字列 | XRP Ledgerの[base58][]エンコード文字列フォーマットで作成された、キーペアの公開鍵。`master_seed`から生成されます。 |
|
||||||
| `public_key_hex` | 文字列 | これは16進数で作成されたキーペアの公開鍵です。`master_seed`から生成されます。トランザクションの署名を検証する場合、`rippled`にはこの公開鍵が必要です。そのため、署名されたトランザクションのフォーマットの`SigningPubKey`フィールドには公開鍵が入力されています。 |
|
| `public_key_hex` | 文字列 | これは16進数で作成されたキーペアの公開鍵です。`master_seed`から生成されます。トランザクションの署名を検証する場合、`rippled`にはこの公開鍵が必要です。そのため、署名されたトランザクションのフォーマットの`SigningPubKey`フィールドには公開鍵が入力されています。 |
|
||||||
| `warning` | 文字列 | （削除される可能性あり）要求にシード値を指定した場合、このフィールドに安全でない可能性があるという警告が表示されます。[新規: rippled 0.32.0][] |
|
| `warning` | 文字列 | （削除される可能性あり）リクエストにシード値を指定した場合、このフィールドに安全でない可能性があるという警告が表示されます。[新規: rippled 0.32.0][] |
|
||||||
|
|
||||||
このメソッドを使用してキーペアを生成し、アカウントのレギュラーキーペアとして使用することもできます。アカウントにレギュラーキーペアを割り当てて、それを使用してほとんどのトランザクションに署名し、マスターキーペアをできるだけオフラインにしておくことも可能です。
|
このメソッドを使用してキーペアを生成し、アカウントのレギュラーキーペアとして使用することもできます。アカウントにレギュラーキーペアを割り当てて、それを使用してほとんどのトランザクションに署名し、マスターキーペアをできるだけオフラインにしておくことも可能です。
|
||||||
|
|
||||||
@@ -198,7 +198,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドが不正に指定されています。
|
* `invalidParams` - 1つ以上のフィールドが不正に指定されています。
|
||||||
* `badSeed` - 要求には、空の文字列やXRP Ledgerアドレスに似た文字列などの許可されないシード値が（`passphrase`、`seed`、または`seed_hex`フィールド内に）指定されています。
|
* `badSeed` - リクエストには、空の文字列やXRP Ledgerアドレスに似た文字列などの許可されないシード値が（`passphrase`、`seed`、または`seed_hex`フィールド内に）指定されています。
|
||||||
|
|
||||||
<!--{# common link defs #}-->
|
<!--{# common link defs #}-->
|
||||||
{% include '_snippets/rippled-api-links.md' %}
|
{% include '_snippets/rippled-api-links.md' %}
|
||||||
|
|||||||
@@ -12,9 +12,9 @@ labels:
|
|||||||
|
|
||||||
_`can_delete`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`can_delete`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -50,15 +50,15 @@ rippled can_delete 11320417
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターを指定できます。
|
リクエストには以下のパラメーターを指定できます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------|:------------------|:------------------------------------------|
|
|:-------------|:------------------|:------------------------------------------|
|
||||||
| `can_delete` | 文字列 または整数 | _（省略可）_ 削除可能な最大レジャーバージョンの[レジャーインデックス][]。特殊ケース`never`を指定すると、オンライン削除が無効になります。特殊ケース`always`を指定すると、指示による削除が無効な場合と同様に、自動オンライン削除が有効になります。特殊ケース`now`を指定すると、設定されている`online_delete`値に一致するかまたはこの値を超える次の検証済みレジャーで、オンライン削除が1回実行されます。省略すると、サーバーは変更を行いません（ただし現在の`can_delete`の値で応答します）。 |
|
| `can_delete` | 文字列 または整数 | _（省略可）_ 削除可能な最大レジャーバージョンの[レジャーインデックス][]。特殊ケース`never`を指定すると、オンライン削除が無効になります。特殊ケース`always`を指定すると、指示による削除が無効な場合と同様に、自動オンライン削除が有効になります。特殊ケース`now`を指定すると、設定されている`online_delete`値に一致するかまたはこの値を超える次の検証済みレジャーで、オンライン削除が1回実行されます。省略すると、サーバーは変更を行いません（ただし現在の`can_delete`の値でレスポンスします）。 |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------|:--------|:----------------------------------------------------|
|
|:-------------|:--------|:----------------------------------------------------|
|
||||||
@@ -70,7 +70,7 @@ rippled can_delete 11320417
|
|||||||
|
|
||||||
- [汎用エラータイプ][]のすべて。
|
- [汎用エラータイプ][]のすべて。
|
||||||
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
- `lgrNotFound` 要求の`can_delete`フィールドに指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
- `lgrNotFound` リクエストの`can_delete`フィールドに指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
||||||
- `notEnabled` - オンライン削除または指示による削除のいずれかがサーバーの設定で有効になっていない場合。
|
- `notEnabled` - オンライン削除または指示による削除のいずれかがサーバーの設定で有効になっていない場合。
|
||||||
- `notReady` - サーバーは現在オンライン削除を実行する準備ができていません。これは通常、サーバーが起動したが、検証済みレジャーをまだ取得していないことを意味します。
|
- `notReady` - サーバーは現在オンライン削除を実行する準備ができていません。これは通常、サーバーが起動したが、検証済みレジャーをまだ取得していないことを意味します。
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
html: crawl_shards.html
|
html: crawl_shards.html
|
||||||
parent: logging-and-data-management-methods.html
|
parent: logging-and-data-management-methods.html
|
||||||
blurb: ピアが持つ履歴シャードについての情報を要求します。
|
blurb: ピアが持つ履歴シャードについての情報をリクエストします。
|
||||||
labels:
|
labels:
|
||||||
- データ保持
|
- データ保持
|
||||||
---
|
---
|
||||||
@@ -9,13 +9,13 @@ labels:
|
|||||||
|
|
||||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/CrawlShards.cpp "Source")
|
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/CrawlShards.cpp "Source")
|
||||||
|
|
||||||
使用可能な[履歴レジャーデータのシャード](history-sharding.html)に関するピアサーバーからの情報を要求します。[新規: rippled 1.2.0][]
|
使用可能な[履歴レジャーデータのシャード](history-sharding.html)に関するピアサーバーからの情報をリクエストします。[新規: rippled 1.2.0][]
|
||||||
|
|
||||||
_`crawl_shards`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`crawl_shards`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -47,19 +47,19 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
|
|||||||
|
|
||||||
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
|
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
|
||||||
|
|
||||||
要求には以下のフィールドが含まれます。
|
リクエストには以下のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------|:--------|:--------------------------------------------------------|
|
|:---------|:--------|:--------------------------------------------------------|
|
||||||
| `pubkey` | ブール値 | _（省略可）_ `true`の場合、応答には、クロールされたサーバーのノード公開鍵（ピアツーピア通信用）が含まれます。デフォルトは`false`です。 |
|
| `pubkey` | ブール値 | _（省略可）_ `true`の場合、レスポンスには、クロールされたサーバーのノード公開鍵（ピアツーピア通信用）が含まれます。デフォルトは`false`です。 |
|
||||||
| `limit` | 数値 | _（省略可）_ 検索の深さを示すホップ数。デフォルトは0で、ダイレクトピアのみを検索します。`1`を制限値にすると、ピアのピアも検索します。最大値は`3`です。 |
|
| `limit` | 数値 | _（省略可）_ 検索の深さを示すホップ数。デフォルトは0で、ダイレクトピアのみを検索します。`1`を制限値にすると、ピアのピアも検索します。最大値は`3`です。 |
|
||||||
|
|
||||||
**注意:** `limit`が増加すると、検索される可能性のあるピアの数は、指数関数的に増加します。2または3を制限値にすると、サーバーがAPI要求に応答するのに数秒かかる場合があります。
|
**注意:** `limit`が増加すると、検索される可能性のあるピアの数は、指数関数的に増加します。2または3を制限値にすると、サーバーがAPIリクエストにレスポンスするのに数秒かかる場合があります。
|
||||||
|
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -114,7 +114,7 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:------------------|:-------|:------------------------------------------------|
|
|:------------------|:-------|:------------------------------------------------|
|
||||||
@@ -123,7 +123,7 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
|
|||||||
|
|
||||||
#### ピアシャードオブジェクト
|
#### ピアシャードオブジェクト
|
||||||
|
|
||||||
応答の`peers`配列のメンバーはそれぞれ、ピアツーピアネットワーク内の1つのサーバーを表すオブジェクトです。リストには、少なくとも1つの完全な[履歴シャード](history-sharding.html)が使用可能なピアのみが含まれます。配列の各オブジェクトには以下のフィールドが含まれます。
|
レスポンスの`peers`配列のメンバーはそれぞれ、ピアツーピアネットワーク内の1つのサーバーを表すオブジェクトです。リストには、少なくとも1つの完全な[履歴シャード](history-sharding.html)が使用可能なピアのみが含まれます。配列の各オブジェクトには以下のフィールドが含まれます。
|
||||||
|
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
@@ -136,7 +136,7 @@ _`crawl_shards`メソッドは、権限のないユーザーは実行できな
|
|||||||
### 考えられるエラー
|
### 考えられるエラー
|
||||||
|
|
||||||
- いずれかの[汎用エラータイプ][]。
|
- いずれかの[汎用エラータイプ][]。
|
||||||
- `invalidParams` - 要求で1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
|
- `invalidParams` - リクエストで1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
|
||||||
|
|
||||||
|
|
||||||
<!--{# common link defs #}-->
|
<!--{# common link defs #}-->
|
||||||
|
|||||||
@@ -16,9 +16,9 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
|
|||||||
|
|
||||||
通常、このメソッドを使用してシャードをダウンロードしてインポートすれば、ピアツーピアネットワークからシャードを個別に取得するよりも短い時間で取得できます。また、サーバーから提供される特定範囲のシャードまたはシャードのセットを選択する場合にもこのメソッドを使用できます。
|
通常、このメソッドを使用してシャードをダウンロードしてインポートすれば、ピアツーピアネットワークからシャードを個別に取得するよりも短い時間で取得できます。また、サーバーから提供される特定範囲のシャードまたはシャードのセットを選択する場合にもこのメソッドを使用できます。
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
|
|||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
|
|
||||||
要求には以下のフィールドが含まれます。
|
リクエストには以下のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------|:--------|:------------------------------------------------------|
|
|:-----------|:--------|:------------------------------------------------------|
|
||||||
@@ -70,9 +70,9 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
|
|||||||
| `index` | 数値 | 取得するシャードのインデックス。本番環境のXRP Ledgerでは、最も古いシャードのインデックスは1であり、このシャードにはレジャー32750～32768が含まれています。次のシャードのインデックスは2であり、このシャードにはレジャー32769～49152が含まれています。 |
|
| `index` | 数値 | 取得するシャードのインデックス。本番環境のXRP Ledgerでは、最も古いシャードのインデックスは1であり、このシャードにはレジャー32750～32768が含まれています。次のシャードのインデックスは2であり、このシャードにはレジャー32769～49152が含まれています。 |
|
||||||
| `url` | 文字列 | このシャードをダウンロードできるURL。このURLは`https://`か`http://`かで始まり`.tar.lz4`（大文字小文字の区別なし）で終わる必要があります。このダウンロードを提供するWebサーバーは、信頼できる認証局（CA）によって署名された有効なTLS証明書を使用する必要があります。（`rippled`はオペレーティングシステムのCAストアーを使用します。） [更新: rippled 1.7.0][] |
|
| `url` | 文字列 | このシャードをダウンロードできるURL。このURLは`https://`か`http://`かで始まり`.tar.lz4`（大文字小文字の区別なし）で終わる必要があります。このダウンロードを提供するWebサーバーは、信頼できる認証局（CA）によって署名された有効なTLS証明書を使用する必要があります。（`rippled`はオペレーティングシステムのCAストアーを使用します。） [更新: rippled 1.7.0][] |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -105,11 +105,11 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:-------|:--------------------------------------------------------|
|
|:----------|:-------|:--------------------------------------------------------|
|
||||||
| `message` | 文字列 | この要求に対応して実行されたアクションを説明するメッセージ。 |
|
| `message` | 文字列 | このリクエストに対応して実行されたアクションを説明するメッセージ。 |
|
||||||
|
|
||||||
**ヒント:** サーバーで使用可能なシャードを確認するには、[crawl_shardsメソッド[]を使用します。または、シャードストアーとして設定されたロケーションのサブフォルダー（`rippled.cfg`の`[shard_db]`の`path`パラメーター）を調べます。フォルダーには、シャードの番号に対応する名前が付いています。これらのフォルダーの1つに、シャードが未完了であることを示す`control.txt`ファイルが含まれていることがあります。
|
**ヒント:** サーバーで使用可能なシャードを確認するには、[crawl_shardsメソッド[]を使用します。または、シャードストアーとして設定されたロケーションのサブフォルダー（`rippled.cfg`の`[shard_db]`の`path`パラメーター）を調べます。フォルダーには、シャードの番号に対応する名前が付いています。これらのフォルダーの1つに、シャードが未完了であることを示す`control.txt`ファイルが含まれていることがあります。
|
||||||
|
|
||||||
@@ -117,8 +117,8 @@ _`download_shard`メソッドは、権限のないユーザーは実行できな
|
|||||||
|
|
||||||
- いずれかの[汎用エラータイプ][]。
|
- いずれかの[汎用エラータイプ][]。
|
||||||
- `notEnabled` - サーバーでシャードストアーを使用するように設定されていません。
|
- `notEnabled` - サーバーでシャードストアーを使用するように設定されていません。
|
||||||
- `tooBusy` - サーバーはすでに、ピアツーピアネットワークから、または以前の`download_shard`要求の結果として、シャードをダウンロード中です。
|
- `tooBusy` - サーバーはすでに、ピアツーピアネットワークから、または以前の`download_shard`リクエストの結果として、シャードをダウンロード中です。
|
||||||
- `invalidParams` - 要求で1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
|
- `invalidParams` - リクエストで1つ以上の必須フィールドが省略されていたか、または指定されたフィールドのデータタイプが誤っています。
|
||||||
|
|
||||||
<!--{# common link defs #}-->
|
<!--{# common link defs #}-->
|
||||||
{% include '_snippets/rippled-api-links.md' %}
|
{% include '_snippets/rippled-api-links.md' %}
|
||||||
|
|||||||
@@ -12,8 +12,8 @@ labels:
|
|||||||
|
|
||||||
_`ledger_cleaner`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`ledger_cleaner`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -30,7 +30,7 @@ _`ledger_cleaner`メソッドは、権限のないユーザーは実行できな
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------------|:--------------------------|:---------------------------------|
|
|:--------------|:--------------------------|:---------------------------------|
|
||||||
@@ -42,9 +42,9 @@ _`ledger_cleaner`メソッドは、権限のないユーザーは実行できな
|
|||||||
| `check_nodes` | ブール値 | _（省略可）_ trueの場合は、指定されているレジャーのレジャー状態オブジェクトを修正します。指定されている場合は`full`をオーバーライドします。 |
|
| `check_nodes` | ブール値 | _（省略可）_ trueの場合は、指定されているレジャーのレジャー状態オブジェクトを修正します。指定されている場合は`full`をオーバーライドします。 |
|
||||||
| `stop` | ブール値 | _（省略可）_ trueの場合は、レジャークリーナーを無効にします。 |
|
| `stop` | ブール値 | _（省略可）_ trueの場合は、レジャークリーナーを無効にします。 |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -64,7 +64,7 @@ _`ledger_cleaner`メソッドは、権限のないユーザーは実行できな
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:-------|:---------------------------------|
|
|:----------|:-------|:---------------------------------|
|
||||||
|
|||||||
@@ -10,10 +10,10 @@ labels:
|
|||||||
|
|
||||||
`ledger_request`コマンドは、サーバーに対し接続しているピアから特定のレジャーバージョンを取得するように指示します。これは、サーバーが直接接続しているピアの1つにそのレジャーが存在している場合にのみ機能します。場合によっては、レジャーを完全に取得するにはこのコマンドを繰り返し実行する必要があります。
|
`ledger_request`コマンドは、サーバーに対し接続しているピアから特定のレジャーバージョンを取得するように指示します。これは、サーバーが直接接続しているピアの1つにそのレジャーが存在している場合にのみ機能します。場合によっては、レジャーを完全に取得するにはこのコマンドを繰り返し実行する必要があります。
|
||||||
|
|
||||||
*`ledger_request`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
*`ledger_request`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -35,7 +35,7 @@ rippled ledger_request 13800000
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:-------|:---------------------------------------------------|
|
|:---------------|:-------|:---------------------------------------------------|
|
||||||
@@ -44,13 +44,13 @@ rippled ledger_request 13800000
|
|||||||
|
|
||||||
`ledger_index`または`ledger_hash`のいずれかを指定する必要がありますが、両方は指定しないでください。
|
`ledger_index`または`ledger_hash`のいずれかを指定する必要がありますが、両方は指定しないでください。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っています。ただし、_`rippled`サーバーに対してレジャーの取得開始を正常に指示できた場合でも_、指定されたレジャーがない場合には失敗を示す応答が要求から返されます。
|
レスポンスは[標準フォーマット][]に従っています。ただし、_`rippled`サーバーに対してレジャーの取得開始を正常に指示できた場合でも_、指定されたレジャーがない場合には失敗を示すレスポンスがリクエストから返されます。
|
||||||
|
|
||||||
**注記:** レジャーを取得するには、rippledサーバーのダイレクトピアの履歴にそのレジャーが含まれている必要があります。どのピアにも要求されたレジャーがない場合は、[connectメソッド][]または構成ファイルの`fixed_ips`セクションを使用して、`s2.ripple.com`にあるRippleのすべての履歴が記録されるサーバーを追加すれば、`ledger_request`要求を再度実行できます。
|
**注記:** レジャーを取得するには、rippledサーバーのダイレクトピアの履歴にそのレジャーが含まれている必要があります。どのピアにもリクエストされたレジャーがない場合は、[connectメソッド][]または構成ファイルの`fixed_ips`セクションを使用して、`s2.ripple.com`にあるRippleのすべての履歴が記録されるサーバーを追加すれば、`ledger_request`リクエストを再度実行できます。
|
||||||
|
|
||||||
失敗した場合の応答には、レジャーの取得状況が示されます。成功した場合の応答には、[ledgerメソッド][]に類似したフォーマットでレジャーの情報が含まれます。
|
失敗した場合のレスポンスには、レジャーの取得状況が示されます。成功した場合のレスポンスには、[ledgerメソッド][]に類似したフォーマットでレジャーの情報が含まれます。
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -160,22 +160,22 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
3つの応答フォーマットは次のとおりです。
|
3つのレスポンスのフォーマットは次のとおりです。
|
||||||
|
|
||||||
1. `lgrNotFound`エラーが返された場合、応答の`acquiring`フィールドには、ピアツーピアネットワークからのレジャー取得状況を示す[レジャー要求オブジェクト](#レジャー要求オブジェクト)が指定されています。
|
1. `lgrNotFound`エラーが返された場合、レスポンスの`acquiring`フィールドには、ピアツーピアネットワークからのレジャー取得状況を示す[レジャーリクエストオブジェクト](#レジャーリクエストオブジェクト)が指定されています。
|
||||||
2. サーバーが現在データを取得中であると応答に示される場合、その結果の本文として、ピアツーピアネットワークからのレジャー取得状況を示す[レジャー要求オブジェクト](#レジャー要求オブジェクト)が表示されます。
|
2. サーバーが現在データを取得中であるとレスポンスに示される場合、その結果の本文として、ピアツーピアネットワークからのレジャー取得状況を示す[レジャーリクエストオブジェクト](#レジャーリクエストオブジェクト)が表示されます。
|
||||||
3. レジャーが完全に利用可能な場合、応答には[レジャーヘッダー](ledger-header.html)が表示されます。
|
3. レジャーが完全に利用可能な場合、レスポンスには[レジャーヘッダー](ledger-header.html)が表示されます。
|
||||||
|
|
||||||
### レジャー要求オブジェクト
|
### レジャーリクエストオブジェクト
|
||||||
|
|
||||||
サーバーでレジャーの取得操作が進行中であり、まだ完了していない場合は、`rippled`サーバーはレジャー取得状況を示すレジャー要求オブジェクトを返します。このオブジェクトのフィールドを次に示します。
|
サーバーでレジャーの取得操作が進行中であり、まだ完了していない場合は、`rippled`サーバーはレジャー取得状況を示すレジャーリクエストオブジェクトを返します。このオブジェクトのフィールドを次に示します。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------------------------|:-----------------|:----------------------------|
|
|:----------------------------|:-----------------|:----------------------------|
|
||||||
| `hash` | 文字列 | （省略される場合があります）要求されるレジャーの[ハッシュ][]（サーバーがこのハッシュを認識している場合）。 |
|
| `hash` | 文字列 | （省略される場合があります）リクエストされるレジャーの[ハッシュ][]（サーバーがこのハッシュを認識している場合）。 |
|
||||||
| `have_header` | ブール値 | 要求されたレジャーのヘッダーセクションがサーバーにあるかどうか。 |
|
| `have_header` | ブール値 | リクエストされたレジャーのヘッダーセクションがサーバーにあるかどうか。 |
|
||||||
| `have_state` | ブール値 | （省略される場合があります）要求されたレジャーの完全な状態データがサーバーにあるかどうか。 |
|
| `have_state` | ブール値 | （省略される場合があります）リクエストされたレジャーの完全な状態データがサーバーにあるかどうか。 |
|
||||||
| `have_transactions` | ブール値 | （省略される場合があります）要求されたレジャーの完全なトランザクションセットがサーバーにあるかどうか。 |
|
| `have_transactions` | ブール値 | （省略される場合があります）リクエストされたレジャーの完全なトランザクションセットがサーバーにあるかどうか。 |
|
||||||
| `needed_state_hashes` | 文字列の配列 | （省略される場合があります）サーバーが取得する必要がある完全な状態データ内のオブジェクトのハッシュ（最大16個）。 |
|
| `needed_state_hashes` | 文字列の配列 | （省略される場合があります）サーバーが取得する必要がある完全な状態データ内のオブジェクトのハッシュ（最大16個）。 |
|
||||||
| `needed_transaction_hashes` | 文字列の配列 | （省略される場合があります）サーバーが取得する必要があるトランザクションセットのオブジェクトのハッシュ（最大16個）。 |
|
| `needed_transaction_hashes` | 文字列の配列 | （省略される場合があります）サーバーが取得する必要があるトランザクションセットのオブジェクトのハッシュ（最大16個）。 |
|
||||||
| `peers` | 数値 | このレジャーを見つけるためにサーバーが照会するピアの数。 |
|
| `peers` | 数値 | このレジャーを見つけるためにサーバーが照会するピアの数。 |
|
||||||
@@ -185,7 +185,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。このエラーは、指定したレジャーインデックスが現在進行中のレジャーのインデックス以上である場合にも発生します。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。このエラーは、指定したレジャーインデックスが現在進行中のレジャーのインデックス以上である場合にも発生します。
|
||||||
* `lgrNotFound` - レジャーがまだ利用可能ではない場合。これは、サーバーがレジャーの取得を開始していますが、要求されたレジャーが接続されたどのピアにもない場合には失敗する可能性があることを意味します。（以前はこのエラーにはコード`ledgerNotFound`が使用されていました。）[更新: rippled 0.30.1][新規: rippled 0.30.1]
|
* `lgrNotFound` - レジャーがまだ利用可能ではない場合。これは、サーバーがレジャーの取得を開始していますが、リクエストされたレジャーが接続されたどのピアにもない場合には失敗する可能性があることを意味します。（以前はこのエラーにはコード`ledgerNotFound`が使用されていました。）[更新: rippled 0.30.1][新規: rippled 0.30.1]
|
||||||
|
|
||||||
<!--{# common link defs #}-->
|
<!--{# common link defs #}-->
|
||||||
{% include '_snippets/rippled-api-links.md' %}
|
{% include '_snippets/rippled-api-links.md' %}
|
||||||
|
|||||||
@@ -12,8 +12,8 @@ labels:
|
|||||||
|
|
||||||
_`log_level`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`log_level`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -37,16 +37,16 @@ rippled log_level PathRequest debug
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:------------|:-------|:------------------------------------------------------|
|
|:------------|:-------|:------------------------------------------------------|
|
||||||
| `severity` | 文字列 | _（省略可）_ 設定するログの詳細レベル。以下に、有効な値を詳細レベルの低いものから順に示します。`fatal`、`error`、`warn`、`info`、`debug`、および`trace`。省略すると、すべてのカテゴリーの現在のログ詳細レベルが返されます。 |
|
| `severity` | 文字列 | _（省略可）_ 設定するログの詳細レベル。以下に、有効な値を詳細レベルの低いものから順に示します。`fatal`、`error`、`warn`、`info`、`debug`、および`trace`。省略すると、すべてのカテゴリーの現在のログ詳細レベルが返されます。 |
|
||||||
| `partition` | 文字列 | _（省略可）_`severity`が指定されていない場合は無視されます。変更するログカテゴリー。省略されている場合、または`base`の値が指定されている場合は、すべてのカテゴリーのログレベルを設定します。 |
|
| `partition` | 文字列 | _（省略可）_`severity`が指定されていない場合は無視されます。変更するログカテゴリー。省略されている場合、または`base`の値が指定されている場合は、すべてのカテゴリーのログレベルを設定します。 |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
成功した場合の応答例:
|
成功した場合のレスポンス例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -130,13 +130,13 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っています。応答フォーマットは、要求に`severity`が指定されているかどうかに応じて異なります。指定されていた場合はログレベルが変更され、成功した場合の結果には追加フィールドが含まれません。
|
レスポンスは[標準フォーマット][]に従っています。レスポンスのフォーマットは、リクエストに`severity`が指定されているかどうかに応じて異なります。指定されていた場合はログレベルが変更され、成功した場合の結果には追加フィールドが含まれません。
|
||||||
|
|
||||||
それ以外の場合、要求には以下のフィールドが含まれます。
|
それ以外の場合、リクエストには以下のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------|:-------|:----------------------------------------------------------|
|
|:--------|:-------|:----------------------------------------------------------|
|
||||||
| `level` | オブジェクト | 各カテゴリーの現在のログレベル。このカテゴリーリストは、今後のリリースで予告なく変更される場合があります。このコマンドに対する要求で、フィールド名を`partition`の値として使用できます。 |
|
| `level` | オブジェクト | 各カテゴリーの現在のログレベル。このカテゴリーリストは、今後のリリースで予告なく変更される場合があります。このコマンドに対するリクエストで、フィールド名を`partition`の値として使用できます。 |
|
||||||
|
|
||||||
### 考えられるエラー
|
### 考えられるエラー
|
||||||
|
|
||||||
|
|||||||
@@ -40,8 +40,8 @@ labels:
|
|||||||
|
|
||||||
_`logrotate`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`logrotate`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -63,11 +63,11 @@ rippled logrotate
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求にはパラメーターが含まれていません。
|
リクエストにはパラメーターが含まれていません。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:-------|:--------------------------------------------------------|
|
|:----------|:-------|:--------------------------------------------------------|
|
||||||
|
|||||||
@@ -13,9 +13,9 @@ labels:
|
|||||||
_`{{currentpage.name}}`メソッドは、権限のないユーザーには実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`{{currentpage.name}}`メソッドは、権限のないユーザーには実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
|
|
||||||
### リクエストフォーマット
|
### リクエストのフォーマット
|
||||||
|
|
||||||
リクエストフォーマット例:
|
リクエストのフォーマット例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ rippled {{currentpage.name}} start
|
|||||||
| `action` | String | どのような動作をさせるかによって、 `start`、`stop` または `status` のいずれかを指定します。 |
|
| `action` | String | どのような動作をさせるかによって、 `start`、`stop` または `status` のいずれかを指定します。 |
|
||||||
|
|
||||||
|
|
||||||
### レスポンスフォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
正常レスポンス例:
|
正常レスポンス例:
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
| `項目` | 型 | 説明 |
|
| `項目` | 型 | 説明 |
|
||||||
|:----------|:-------|:--------------------------------------------------------|
|
|:----------|:-------|:--------------------------------------------------------|
|
||||||
| `message` | 文字列 | コマンドに応答して実行されたアクションを示す、可読性の高いメッセージ。 |
|
| `message` | 文字列 | コマンドにレスポンスして実行されたアクションを示す、可読性の高いメッセージ。 |
|
||||||
|
|
||||||
|
|
||||||
### 起こり得るエラー
|
### 起こり得るエラー
|
||||||
|
|||||||
@@ -10,10 +10,10 @@ labels:
|
|||||||
|
|
||||||
`connect`コマンドは、`rippled`サーバーを特定のピア`rippled`サーバーに強制的に接続します。
|
`connect`コマンドは、`rippled`サーバーを特定のピア`rippled`サーバーに強制的に接続します。
|
||||||
|
|
||||||
*`connect`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
*`connect`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -51,16 +51,16 @@ rippled connect 192.170.145.88 51235
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------|:-------|:----------------------------------------------------------|
|
|:--------|:-------|:----------------------------------------------------------|
|
||||||
| `ip` | 文字列 | 接続するサーバーのIPアドレス。 |
|
| `ip` | 文字列 | 接続するサーバーのIPアドレス。 |
|
||||||
| `port` | 数値 | _（省略可）_ 接続時に使用するポート番号。デフォルトでは**2459**です。 [新規: rippled 1.6.0][] |
|
| `port` | 数値 | _（省略可）_ 接続時に使用するポート番号。デフォルトでは**2459**です。 [新規: rippled 1.6.0][] |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:-------|:-------------------------------------------------------|
|
|:----------|:-------|:-------------------------------------------------------|
|
||||||
|
|||||||
@@ -13,9 +13,9 @@ labels:
|
|||||||
_`{{currentpage.name}}`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`{{currentpage.name}}`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -51,7 +51,7 @@ rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG9
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------------|:-------|:----------------------------------------------------|
|
|:--------------|:-------|:----------------------------------------------------|
|
||||||
@@ -60,9 +60,9 @@ rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG9
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -115,7 +115,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------|:-------|:-------------------------------------------------------|
|
|:-----------|:-------|:-------------------------------------------------------|
|
||||||
@@ -135,7 +135,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
- いずれかの[汎用エラータイプ][]。
|
- いずれかの[汎用エラータイプ][]。
|
||||||
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
- `publicMalformed` - 要求の`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
|
- `publicMalformed` - リクエストの`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
|
||||||
|
|
||||||
<!--{# common link defs #}-->
|
<!--{# common link defs #}-->
|
||||||
{% include '_snippets/rippled-api-links.md' %}
|
{% include '_snippets/rippled-api-links.md' %}
|
||||||
|
|||||||
@@ -15,9 +15,9 @@ _`{{currentpage.name}}`メソッドは、権限のないユーザーは実行で
|
|||||||
|
|
||||||
**注記:** ピアリザベーションを削除しても、対応するピアが接続されている場合、そのピアは自動的に切断されません。
|
**注記:** ピアリザベーションを削除しても、対応するピアが接続されている場合、そのピアは自動的に切断されません。
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -51,16 +51,16 @@ rippled {{currentpage.name}} n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG9
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:------------|:--------------------------|:-----------------------------------|
|
|:------------|:--------------------------|:-----------------------------------|
|
||||||
| `public_key` | 文字列 | 削除する[ピアリザベーション][]の[ノード公開鍵][]（[base58][]フォーマット） |
|
| `public_key` | 文字列 | 削除する[ピアリザベーション][]の[ノード公開鍵][]（[base58][]フォーマット） |
|
||||||
|
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -113,7 +113,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------|:-------|:----------------------------------------------------------|
|
|:--------|:-------|:----------------------------------------------------------|
|
||||||
@@ -132,7 +132,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
- いずれかの[汎用エラータイプ][]。
|
- いずれかの[汎用エラータイプ][]。
|
||||||
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
- `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
- `publicMalformed` - 要求の`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
|
- `publicMalformed` - リクエストの`public_key`フィールドが無効です。[base58][]フォーマットの有効なノード公開鍵である必要があります。
|
||||||
|
|
||||||
<!--{# common link defs #}-->
|
<!--{# common link defs #}-->
|
||||||
{% include '_snippets/rippled-api-links.md' %}
|
{% include '_snippets/rippled-api-links.md' %}
|
||||||
|
|||||||
@@ -13,9 +13,9 @@ labels:
|
|||||||
_`{{currentpage.name}}`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`{{currentpage.name}}`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -45,12 +45,12 @@ rippled {{currentpage.name}}
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この要求にはパラメーターは含まれません。
|
このリクエストにはパラメーターは含まれません。
|
||||||
|
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ Loading: "/etc/rippled.cfg"
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:------|:----------------------------------------------------|
|
|:---------------|:------|:----------------------------------------------------|
|
||||||
|
|||||||
@@ -10,10 +10,10 @@ labels:
|
|||||||
|
|
||||||
`peers`コマンドは、[ピアプロトコル](peer-protocol.html)でこのサーバーに現在接続されているその他のすべての`rippled`サーバーのリスト（各サーバーの接続状況と同期状況を含む）を返します。
|
`peers`コマンドは、[ピアプロトコル](peer-protocol.html)でこのサーバーに現在接続されているその他のすべての`rippled`サーバーのリスト（各サーバーの接続状況と同期状況を含む）を返します。
|
||||||
|
|
||||||
*`peers`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
*`peers`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -34,11 +34,11 @@ rippled peers
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この要求には追加パラメーターはありません。
|
このリクエストには追加パラメーターはありません。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -378,7 +378,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドからなるJSONオブジェクトが含まれます。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドからなるJSONオブジェクトが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:-------|:--------------------------------------------------------|
|
|:----------|:-------|:--------------------------------------------------------|
|
||||||
|
|||||||
@@ -12,9 +12,9 @@ labels:
|
|||||||
|
|
||||||
*`ledger_accept`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
*`ledger_accept`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -36,11 +36,11 @@ rippled ledger_accept
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この要求はパラメーターを受け入れません。
|
このリクエストはパラメーターを受け入れません。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
```js
|
```js
|
||||||
{
|
{
|
||||||
"id": "Accept my ledger!",
|
"id": "Accept my ledger!",
|
||||||
@@ -52,7 +52,7 @@ rippled ledger_accept
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:-----------------|:---------------------------------|
|
|:-----------------------|:-----------------|:---------------------------------|
|
||||||
|
|||||||
@@ -10,10 +10,10 @@ labels:
|
|||||||
|
|
||||||
サーバーのグレースフルシャットダウンを行います。
|
サーバーのグレースフルシャットダウンを行います。
|
||||||
|
|
||||||
_`stop`要求は、権限のないユーザーは実行できない*[管理メソッド](admin-api-methods.html)です。_
|
_`stop`リクエストは、権限のないユーザーは実行できない*[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -45,11 +45,11 @@ rippled stop
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求にはパラメーターが含まれていません。
|
リクエストにはパラメーターが含まれていません。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:-------|:-------------------------------------|
|
|:----------|:-------|:-------------------------------------|
|
||||||
|
|||||||
@@ -11,10 +11,10 @@ labels:
|
|||||||
|
|
||||||
`validation_seed`コマンドは、rippledが検証の署名に使用するシークレット値を一時的に設定します。サーバーを再起動すると、この値は構成ファイルに基づいてリセットされます。[rippled 0.29.1 以降では無効](https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1 "BADGE_RED")
|
`validation_seed`コマンドは、rippledが検証の署名に使用するシークレット値を一時的に設定します。サーバーを再起動すると、この値は構成ファイルに基づいてリセットされます。[rippled 0.29.1 以降では無効](https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1 "BADGE_RED")
|
||||||
|
|
||||||
*`validation_seed`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
*`validation_seed`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -37,15 +37,15 @@ rippled validation_seed 'BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE'
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------|:-------|:---------------------------------------------------------|
|
|:---------|:-------|:---------------------------------------------------------|
|
||||||
| `secret` | 文字列 | _（省略可）_ 指定されている場合は、この値はキーペアの検証のためのシークレット値として使用されます。有効なフォーマットには、XRP Ledgerの[base58][]フォーマット、[RFC-1751](https://tools.ietf.org/html/rfc1751)、またはパスフレーズがあります。省略されている場合は、ネットワークへの検証の提案が無効になります。 |
|
| `secret` | 文字列 | _（省略可）_ 指定されている場合は、この値はキーペアの検証のためのシークレット値として使用されます。有効なフォーマットには、XRP Ledgerの[base58][]フォーマット、[RFC-1751](https://tools.ietf.org/html/rfc1751)、またはパスフレーズがあります。省略されている場合は、ネットワークへの検証の提案が無効になります。 |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:------------------------|:-------|:------------------------------------------|
|
|:------------------------|:-------|:------------------------------------------|
|
||||||
@@ -93,7 +93,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
### 考えられるエラー
|
### 考えられるエラー
|
||||||
|
|
||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `badSeed` - 要求に無効なシークレット値が指定されていました。この場合は通常、シークレット値が異なるフォーマットの有効文字列（アカウントアドレス、検証の公開鍵など）である可能性があります。
|
* `badSeed` - リクエストに無効なシークレット値が指定されていました。この場合は通常、シークレット値が異なるフォーマットの有効文字列（アカウントアドレス、検証の公開鍵など）である可能性があります。
|
||||||
|
|
||||||
<!--{# common link defs #}-->
|
<!--{# common link defs #}-->
|
||||||
{% include '_snippets/rippled-api-links.md' %}
|
{% include '_snippets/rippled-api-links.md' %}
|
||||||
|
|||||||
@@ -15,8 +15,8 @@ labels:
|
|||||||
|
|
||||||
**注意:** 独自の`rippled`サーバーを運用している場合を除き、このコマンドを使用するのではなく、[クライアントライブラリ](client-libraries.html)を実行してください。詳細については[安全な署名の設定](secure-signing.html)を参照してください。
|
**注意:** 独自の`rippled`サーバーを運用している場合を除き、このコマンドを使用するのではなく、[クライアントライブラリ](client-libraries.html)を実行してください。詳細については[安全な署名の設定](secure-signing.html)を参照してください。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -81,7 +81,7 @@ rippled sign s██████████████████████
|
|||||||
* `secret`フィールドにシードを指定し、`key_type`フィールドを省略します。この値は、XRP Ledgerの[base58][]シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述します（secp256k1キーのみ）。
|
* `secret`フィールドにシードを指定し、`key_type`フィールドを省略します。この値は、XRP Ledgerの[base58][]シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述します（secp256k1キーのみ）。
|
||||||
* `key_type`値と、`seed`、`seed_hex`、または`passphrase`のいずれか1つを提供します。`secret`フィールドは省略します。（コマンドライン構文ではサポートされません）。
|
* `key_type`値と、`seed`、`seed_hex`、または`passphrase`のいずれか1つを提供します。`secret`フィールドは省略します。（コマンドライン構文ではサポートされません）。
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:--------|:--------------------------------------------------|
|
|:---------------|:--------|:--------------------------------------------------|
|
||||||
@@ -98,19 +98,19 @@ rippled sign s██████████████████████
|
|||||||
|
|
||||||
### 自動入力可能なフィールド
|
### 自動入力可能なフィールド
|
||||||
|
|
||||||
`tx_json`（[トランザクションオブジェクト](transaction-formats.html)）の特定のフィールドを省略すると、サーバーは自動的に入力しようとします。要求の`offline`を`true`と指定しない限り、サーバーは署名前に以下のフィールドを提供します。
|
`tx_json`（[トランザクションオブジェクト](transaction-formats.html)）の特定のフィールドを省略すると、サーバーは自動的に入力しようとします。リクエストの`offline`を`true`と指定しない限り、サーバーは署名前に以下のフィールドを提供します。
|
||||||
|
|
||||||
* `Sequence` - サーバーは、送信者のアカウント情報にある次のシーケンス番号を自動的に使用します。
|
* `Sequence` - サーバーは、送信者のアカウント情報にある次のシーケンス番号を自動的に使用します。
|
||||||
* **注意:** アカウントの次のシーケンス番号は、このトランザクションが適用されるまで増分されません。トランザクションの送信および個々のトランザクションへの応答を待たずに複数のトランザクションに署名する場合は、最初のトランザクション以降の各トランザクションについて、正しいシーケンス番号を手動で提供する必要があります。
|
* **注意:** アカウントの次のシーケンス番号は、このトランザクションが適用されるまで増分されません。トランザクションの送信および個々のトランザクションへのレスポンスを待たずに複数のトランザクションに署名する場合は、最初のトランザクション以降の各トランザクションについて、正しいシーケンス番号を手動で提供する必要があります。
|
||||||
* `Fee` - `Fee`パラメーターを省略した場合、サーバーは適切なトランザクションコストを自動的に入力しようとします。本番環境のXRP Ledgerでは、適切な`fee_mult_max`値を提供しない限り、この処理は`rpcHIGH_FEE`エラーで失敗します。
|
* `Fee` - `Fee`パラメーターを省略した場合、サーバーは適切なトランザクションコストを自動的に入力しようとします。本番環境のXRP Ledgerでは、適切な`fee_mult_max`値を提供しない限り、この処理は`rpcHIGH_FEE`エラーで失敗します。
|
||||||
* `fee_mult_max`パラメーターと`fee_div_max`パラメーターは、[リファレンストランザクションコスト](transaction-cost.html#referenceトランザクションコスト)に適用される負荷スケーリング乗数によって、自動的に提供されるトランザクションコストの上限値を設定します。デフォルト設定では、自動的に提供される値が10×の乗数より大きい場合、エラーが返されます。ただし、本番環境のXRP Ledgerでは、[1000×の負荷乗数を使用することが一般的](transaction-cost.html#現在のトランザクションコスト)です。
|
* `fee_mult_max`パラメーターと`fee_div_max`パラメーターは、[リファレンストランザクションコスト](transaction-cost.html#referenceトランザクションコスト)に適用される負荷スケーリング乗数によって、自動的に提供されるトランザクションコストの上限値を設定します。デフォルト設定では、自動的に提供される値が10×の乗数より大きい場合、エラーが返されます。ただし、本番環境のXRP Ledgerでは、[1000×の負荷乗数を使用することが一般的](transaction-cost.html#現在のトランザクションコスト)です。
|
||||||
* コマンドライン構文では、`fee_mult_max`および`fee_div_max`はサポートされません。本番環境のXRP Ledgerの場合は、`Fee`値を提供する必要があります。
|
* コマンドライン構文では、`fee_mult_max`および`fee_div_max`はサポートされません。本番環境のXRP Ledgerの場合は、`Fee`値を提供する必要があります。
|
||||||
* **注意:** 悪意のあるサーバーは、`fee_mult_max`や`fee_div_max`の値を無視して、きわめて大きなトランザクションコストを指定するおそれがあります。
|
* **注意:** 悪意のあるサーバーは、`fee_mult_max`や`fee_div_max`の値を無視して、きわめて大きなトランザクションコストを指定するおそれがあります。
|
||||||
* `Paths` - Payment型のトランザクションの場合（XRP間の移動を除く）、Pathsフィールドは、[ripple_path_findメソッド][]を使用した場合と同様に自動的に入力できます。`build_path`を指定した場合のみ入力されます。
|
* `Paths` - Payment型のトランザクションの場合（XRP間の移動を除く）、Pathsフィールドは、[ripple_path_findメソッド][]を使用した場合と同様に自動的に入力できます。`build_path`を指定した場合のみ入力されます。
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -204,14 +204,14 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:-------|:--------------------------------------------------------|
|
|:----------|:-------|:--------------------------------------------------------|
|
||||||
| `tx_blob` | 文字列 | 正しく作成された署名済みトランザクションの16進バイナリー表現 |
|
| `tx_blob` | 文字列 | 正しく作成された署名済みトランザクションの16進バイナリー表現 |
|
||||||
| `tx_json` | オブジェクト | 自動的に入力されたフィールドを含む、署名済み[トランザクション全体](transaction-formats.html)のJSON仕様 |
|
| `tx_json` | オブジェクト | 自動的に入力されたフィールドを含む、署名済み[トランザクション全体](transaction-formats.html)のJSON仕様 |
|
||||||
|
|
||||||
**注意:** このコマンドの結果としてエラーメッセージが表示された場合は、要求で指定されたシークレット値がメッセージの中に含まれている可能性があります。これらのエラーが他者から見えない状態であることを確認してください。
|
**注意:** このコマンドの結果としてエラーメッセージが表示された場合は、リクエストで指定されたシークレット値がメッセージの中に含まれている可能性があります。これらのエラーが他者から見えない状態であることを確認してください。
|
||||||
|
|
||||||
* このエラーは、複数の人物が参照できるログファイルに書き込まないでください。
|
* このエラーは、複数の人物が参照できるログファイルに書き込まないでください。
|
||||||
* デバッグを目的として、誰でも参照できる場所にこのエラーを貼り付けないでください。
|
* デバッグを目的として、誰でも参照できる場所にこのエラーを貼り付けないでください。
|
||||||
@@ -221,7 +221,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `highFee` - トランザクションコストに適用される現在の負荷乗数が、自動的に提供されるトランザクションコストの上限を超えています。要求で指定する`fee_mult_max`を大きくするか（1000以上）、`tx_json`の`Fee`フィールドに値を手動で指定します。
|
* `highFee` - トランザクションコストに適用される現在の負荷乗数が、自動的に提供されるトランザクションコストの上限を超えています。リクエストで指定する`fee_mult_max`を大きくするか（1000以上）、`tx_json`の`Fee`フィールドに値を手動で指定します。
|
||||||
* `tooBusy` - トランザクションにパスが含まれていませんが、サーバーがビジーであるため、パス検出処理をすぐに実行できません。管理者として接続している場合は発生しません。
|
* `tooBusy` - トランザクションにパスが含まれていませんが、サーバーがビジーであるため、パス検出処理をすぐに実行できません。管理者として接続している場合は発生しません。
|
||||||
* `noPath` - トランザクションにパスが含まれておらず、サーバーは、このペイメントの発生経路となるパスを検出できませんでした。
|
* `noPath` - トランザクションにパスが含まれておらず、サーバーは、このペイメントの発生経路となるパスを検出できませんでした。
|
||||||
|
|
||||||
|
|||||||
@@ -15,8 +15,8 @@ labels:
|
|||||||
|
|
||||||
このコマンドを使用するには、[MultiSign Amendment][]が有効になっている必要があります。[新規: rippled 0.31.0][]
|
このコマンドを使用するには、[MultiSign Amendment][]が有効になっている必要があります。[新規: rippled 0.31.0][]
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s█████████
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------|:---------------------|:---------------------------------------|
|
|:-------------|:---------------------|:---------------------------------------|
|
||||||
@@ -102,16 +102,16 @@ rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s█████████
|
|||||||
| `seed` | 文字列 | _（省略可）_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。XRP Ledgerの[base58][]フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
| `seed` | 文字列 | _（省略可）_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。XRP Ledgerの[base58][]フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed_hex`、`passphrase`と同時に使用することはできません。 |
|
||||||
| `seed_hex` | 文字列 | _（省略可）_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。16進フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`passphrase`と同時に使用することはできません。 |
|
| `seed_hex` | 文字列 | _（省略可）_ トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。16進フォーマットにする必要があります。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`passphrase`と同時に使用することはできません。 |
|
||||||
| `passphrase` | 文字列 | _（省略可）_ トランザクションを提供するアカウントのシークレットキー。文字列パスフレーズとして、トランザクションへの署名に使用されます。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`seed_hex`と同時に使用することはできません。 |
|
| `passphrase` | 文字列 | _（省略可）_ トランザクションを提供するアカウントのシークレットキー。文字列パスフレーズとして、トランザクションへの署名に使用されます。指定する場合は、`key_type`も指定する必要があります。`secret`、`seed`、`seed_hex`と同時に使用することはできません。 |
|
||||||
| `key_type` | 文字列 | _（省略可）_ この要求で提供する暗号鍵の種類。有効な種類は、`secp256k1`または`ed25519`です。デフォルトでは`secp256k1`です。`secret`と同時に使用することはできません。**注意:** Ed25519のサポートは実験的な機能です。 |
|
| `key_type` | 文字列 | _（省略可）_ このリクエストで提供する暗号鍵の種類。有効な種類は、`secp256k1`または`ed25519`です。デフォルトでは`secp256k1`です。`secret`と同時に使用することはできません。**注意:** Ed25519のサポートは実験的な機能です。 |
|
||||||
|
|
||||||
シークレットキーを指定した**1つのフィールドのみ**を指定する必要があります。次のいずれかになります。
|
シークレットキーを指定した**1つのフィールドのみ**を指定する必要があります。次のいずれかになります。
|
||||||
|
|
||||||
* `secret`値を指定し、`key_type`フィールドを省略します。この値は、XRP Ledgerの[base58][]シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述します（secp256k1キーのみ）。
|
* `secret`値を指定し、`key_type`フィールドを省略します。この値は、XRP Ledgerの[base58][]シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述します（secp256k1キーのみ）。
|
||||||
* `key_type`値と、`seed`、`seed_hex`、または`passphrase`のいずれか1つを提供します。`secret`フィールドは省略します。（コマンドライン構文ではサポートされません。）
|
* `key_type`値と、`seed`、`seed_hex`、または`passphrase`のいずれか1つを提供します。`secret`フィールドは省略します。（コマンドライン構文ではサポートされません。）
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -225,7 +225,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:-------|:--------------------------------------------------------|
|
|:----------|:-------|:--------------------------------------------------------|
|
||||||
@@ -237,7 +237,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `srcActNotFound` - トランザクションの`Account`が、レジャーの資金供給のあるアドレスではない場合。
|
* `srcActNotFound` - トランザクションの`Account`が、レジャーの資金供給のあるアドレスではない場合。
|
||||||
* `srcActMalformed` - 要求の署名アドレス（`account`フィールド）の形式が無効である場合。
|
* `srcActMalformed` - リクエストの署名アドレス（`account`フィールド）の形式が無効である場合。
|
||||||
* `badSeed` - 指定されたシード値のフォーマットが正しくありません。
|
* `badSeed` - 指定されたシード値のフォーマットが正しくありません。
|
||||||
* `badSecret` - 指定されたシークレット値のフォーマットが正しくありません。
|
* `badSecret` - 指定されたシークレット値のフォーマットが正しくありません。
|
||||||
|
|
||||||
|
|||||||
@@ -13,8 +13,8 @@ labels:
|
|||||||
|
|
||||||
_`consensus_info`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`consensus_info`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -47,11 +47,11 @@ rippled consensus_info
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この要求にはパラメーターはありません。
|
このリクエストにはパラメーターはありません。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -210,7 +210,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------|:-------|:----------------------------------------------------------|
|
|:--------|:-------|:----------------------------------------------------------|
|
||||||
|
|||||||
@@ -15,8 +15,8 @@ labels:
|
|||||||
|
|
||||||
_`feature`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`feature`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -63,18 +63,18 @@ rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:--------|:-------------------------------------------------------|
|
|:----------|:--------|:-------------------------------------------------------|
|
||||||
| `feature` | 文字列 | _（省略可）_ Amendmentの一意のID（16進数）またはAmendmentの短い名前。指定されている場合は、応答が1つのAmendmentに限定されます。それ以外の場合は応答にすべてのAmendmentのリストが表示されます。 |
|
| `feature` | 文字列 | _（省略可）_ Amendmentの一意のID（16進数）またはAmendmentの短い名前。指定されている場合は、レスポンスが1つのAmendmentに限定されます。それ以外の場合はレスポンスにすべてのAmendmentのリストが表示されます。 |
|
||||||
| `vetoed` | ブール値 | （省略可、`feature`が指定されていない場合は無視されます）trueの場合、サーバに対し`feature`で指定されたAmendmentに反対票を投じるように指示します。falseの場合、サーバに対しAmendmentに賛成票を投じるように指示します。 |
|
| `vetoed` | ブール値 | （省略可、`feature`が指定されていない場合は無視されます）trueの場合、サーバに対し`feature`で指定されたAmendmentに反対票を投じるように指示します。falseの場合、サーバに対しAmendmentに賛成票を投じるように指示します。 |
|
||||||
|
|
||||||
**注記:** サーバが新しいAmendmentの適用方法を現在認識していない場合でも、`feature`フィールドにAmendment IDを指定すれば、新しいAmendmentに賛成票を投じるようにサーバを設定できます。たとえば、Amendmentをサポートする新しい`rippled`バージョンに _確実に_ アップグレードする予定がある場合などにこのように設定できます。
|
**注記:** サーバが新しいAmendmentの適用方法を現在認識していない場合でも、`feature`フィールドにAmendment IDを指定すれば、新しいAmendmentに賛成票を投じるようにサーバを設定できます。たとえば、Amendmentをサポートする新しい`rippled`バージョンに _確実に_ アップグレードする予定がある場合などにこのように設定できます。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -181,7 +181,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に**Amendmentのマップ**がJSONプロジェクトとして含まれています。オブジェクトのキーはAmendment IDです。各キーの値は、そのIDのAmendmentのステータスを記述した _Amendmentオブジェクト_ です。要求に`feature`が指定されいる場合、要求による変更の適用後には、要求されたAmendmentオブジェクトだけがマップに含まれます。各Amendmentオブジェクトのフィールドを次に示します。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に**Amendmentのマップ**がJSONプロジェクトとして含まれています。オブジェクトのキーはAmendment IDです。各キーの値は、そのIDのAmendmentのステータスを記述した _Amendmentオブジェクト_ です。リクエストに`feature`が指定されいる場合、リクエストによる変更の適用後には、リクエストされたAmendmentオブジェクトだけがマップに含まれます。各Amendmentオブジェクトのフィールドを次に示します。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:------------|:--------|:-----------------------------------------------------|
|
|:------------|:--------|:-----------------------------------------------------|
|
||||||
|
|||||||
@@ -12,8 +12,8 @@ labels:
|
|||||||
|
|
||||||
_`fetch_info`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`fetch_info`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -49,15 +49,15 @@ rippled fetch_info
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------|:--------|:---------------------------------------------------------|
|
|:--------|:--------|:---------------------------------------------------------|
|
||||||
| `clear` | ブール値 | `true`の場合、現在のフェッチ操作がリセットされます。それ以外の場合、進行中のフェッチ操作のステータスのみが取得されます。 |
|
| `clear` | ブール値 | `true`の場合、現在のフェッチ操作がリセットされます。それ以外の場合、進行中のフェッチ操作のステータスのみが取得されます。 |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -142,7 +142,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------|:-------|:----------------------------------------------------------|
|
|:--------|:-------|:----------------------------------------------------------|
|
||||||
@@ -155,7 +155,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
| `hash` | 文字列 | フェッチ対象アイテムのハッシュ。 |
|
| `hash` | 文字列 | フェッチ対象アイテムのハッシュ。 |
|
||||||
| `have_header` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのヘッダーセクションを取得しているかどうか。 |
|
| `have_header` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのヘッダーセクションを取得しているかどうか。 |
|
||||||
| `have_transactions` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのトランザクションセクションを取得しているかどうか。 |
|
| `have_transactions` | ブール値 | レジャーの場合、このサーバーがすでにレジャーのトランザクションセクションを取得しているかどうか。 |
|
||||||
| `needed_state_hashes` | （ハッシュ）文字列の配列 | まだ必要とされる、このアイテムの状態オブジェクトのハッシュ値。必要なハッシュの数が16を超えている場合、応答には最初の16個のハッシュのみが含まれます。 |
|
| `needed_state_hashes` | （ハッシュ）文字列の配列 | まだ必要とされる、このアイテムの状態オブジェクトのハッシュ値。必要なハッシュの数が16を超えている場合、レスポンスには最初の16個のハッシュのみが含まれます。 |
|
||||||
| `peers` | 数値 | このアイテムが利用可能であるピアの数。 |
|
| `peers` | 数値 | このアイテムが利用可能であるピアの数。 |
|
||||||
| `timeouts` | 数値 | このアイテムをフェッチしようとしてタイムアウトになった（2.5秒）回数。 |
|
| `timeouts` | 数値 | このアイテムをフェッチしようとしてタイムアウトになった（2.5秒）回数。 |
|
||||||
|
|
||||||
|
|||||||
@@ -12,8 +12,8 @@ labels:
|
|||||||
|
|
||||||
_`get_counts`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
_`get_counts`メソッドは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。_
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -49,15 +49,15 @@ rippled get_counts 100
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:------------|:--------------------------|:-----------------------------------|
|
|:------------|:--------------------------|:-----------------------------------|
|
||||||
| `min_count` | 数値（符号なし整数） | この値以上の値を含むフィールドのみを返します。 |
|
| `min_count` | 数値（符号なし整数） | この値以上の値を含むフィールドのみを返します。 |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っています。結果に含まれるフィールドのリストは、予告なく変更される可能性がありますが、（特に）以下のいずれかが含まれます。
|
レスポンスは[標準フォーマット][]に従っています。結果に含まれるフィールドのリストは、予告なく変更される可能性がありますが、（特に）以下のいずれかが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------------|:-------|:----------------------------------------------------|
|
|:--------------|:-------|:----------------------------------------------------|
|
||||||
|
|||||||
@@ -10,10 +10,10 @@ labels:
|
|||||||
|
|
||||||
`print`コマンドは、さまざまな内部サブシステム（ピア、レジャークリーナー、リソースマネージャーなど）の現在の状況を返します。
|
`print`コマンドは、さまざまな内部サブシステム（ピア、レジャークリーナー、リソースマネージャーなど）の現在の状況を返します。
|
||||||
|
|
||||||
*`print`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
*`print`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -34,11 +34,11 @@ rippled print
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求にはパラメーターが含まれていません。
|
リクエストにはパラメーターが含まれていません。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -232,7 +232,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っています。結果に含まれる追加フィールドは、`rippled`サーバーの内部状態に応じて異なります。このコマンドの実行結果は、予告なく変更されることがあります。
|
レスポンスは[標準フォーマット][]に従っています。結果に含まれる追加フィールドは、`rippled`サーバーの内部状態に応じて異なります。このコマンドの実行結果は、予告なく変更されることがあります。
|
||||||
|
|
||||||
### 考えられるエラー
|
### 考えられるエラー
|
||||||
|
|
||||||
|
|||||||
@@ -11,10 +11,10 @@ labels:
|
|||||||
|
|
||||||
`validator_list_sites`コマンドは、バリデータリストを処理するサイトのステータス情報を返します。[新規: rippled 0.80.1][]
|
`validator_list_sites`コマンドは、バリデータリストを処理するサイトのステータス情報を返します。[新規: rippled 0.80.1][]
|
||||||
|
|
||||||
*`validator_list_sites`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
*`validator_list_sites`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -47,11 +47,11 @@ rippled validator_list_sites
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求にはパラメーターが含まれていません。
|
リクエストにはパラメーターが含まれていません。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -119,7 +119,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:------------------|:------|----------------------------------|
|
|:------------------|:------|----------------------------------|
|
||||||
|
|||||||
@@ -11,10 +11,10 @@ labels:
|
|||||||
|
|
||||||
`validators`コマンドは、サーバーが使用する公開済みの信頼できるバリデータの最新リストに関する情報を、人間が読み取れる形式で返します。[新規: rippled 0.80.1][]
|
`validators`コマンドは、サーバーが使用する公開済みの信頼できるバリデータの最新リストに関する情報を、人間が読み取れる形式で返します。[新規: rippled 0.80.1][]
|
||||||
|
|
||||||
*`validators`要求は、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
*`validators`リクエストは、権限のないユーザーは実行できない[管理メソッド](admin-api-methods.html)です。*
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -47,11 +47,11 @@ rippled validators
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求にはパラメーターが含まれていません。
|
リクエストにはパラメーターが含まれていません。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------------------|:-------|:-----------------------------------------|
|
|:-------------------------|:-------|:-----------------------------------------|
|
||||||
@@ -168,7 +168,7 @@ Connecting to 127.0.0.1:5005
|
|||||||
| `publisher_lists` | 配列 | パブリッシャーリストオブジェクトの配列。 |
|
| `publisher_lists` | 配列 | パブリッシャーリストオブジェクトの配列。 |
|
||||||
| `signing_keys` | オブジェクト | バリデータマニフェストを使用している登録済みバリデータのマスター公開鍵から、現在の署名キーへのマッピング。 |
|
| `signing_keys` | オブジェクト | バリデータマニフェストを使用している登録済みバリデータのマスター公開鍵から、現在の署名キーへのマッピング。 |
|
||||||
| `trusted_validator_keys` | 配列 | 現在信頼されているバリデータの公開鍵の配列。 |
|
| `trusted_validator_keys` | 配列 | 現在信頼されているバリデータの公開鍵の配列。 |
|
||||||
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバーがさらに検証を要求する場合があります。 |
|
| `validation_quorum` | 数値 | 1つのレジャーバージョンの検証に最低限必要となる信頼できる検証の数。状況によっては、サーバーがさらに検証をリクエストする場合があります。 |
|
||||||
| `validator_list_expires` | 文字列 | 人間が読み取れる形式での現在のバリデータリストの有効期限、文字列`unknown`（サーバーが公開済みバリデータリストを読み込む必要がある場合）、または文字列`never`（サーバーが静的なバリデータリストを使用している場合）のいずれか。 |
|
| `validator_list_expires` | 文字列 | 人間が読み取れる形式での現在のバリデータリストの有効期限、文字列`unknown`（サーバーが公開済みバリデータリストを読み込む必要がある場合）、または文字列`never`（サーバーが静的なバリデータリストを使用している場合）のいずれか。 |
|
||||||
|
|
||||||
`publisher_lists`配列の各メンバーは、以下のフィールドを有するオブジェクトです。
|
`publisher_lists`配列の各メンバーは、以下のフィールドを有するオブジェクトです。
|
||||||
|
|||||||
@@ -5,9 +5,9 @@ blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの
|
|||||||
---
|
---
|
||||||
# エラーのフォーマット
|
# エラーのフォーマット
|
||||||
|
|
||||||
エラーが発生する可能性のある状況をすべて挙げることは不可能です。トランスポートレイヤーで発生する場合（ネットワーク接続が失われる場合など）には、使用しているクライアントとトランスポートに応じてその結果は異なります。ただし、`rippled`サーバーが要求を正常に受信した場合、サーバーは標準のエラー形式での応答を試みます。
|
エラーが発生する可能性のある状況をすべて挙げることは不可能です。トランスポートレイヤーで発生する場合（ネットワーク接続が失われる場合など）には、使用しているクライアントとトランスポートに応じてその結果は異なります。ただし、`rippled`サーバーがリクエストを正常に受信した場合、サーバーは標準のエラー形式でのレスポンスを試みます。
|
||||||
|
|
||||||
**注意:** 要求の結果がエラーになった場合、応答の一部として要求全体がコピーされます。このため、エラーのデバッグに取り組むことができます。ただし、これには要求で渡した機密情報がすべて含まれます。エラーメッセージを共有するときには、アカウントの重要な機密情報を他のユーザーに誤って公開することがないように、十分に注意してください。
|
**注意:** リクエストの結果がエラーになった場合、レスポンスの一部としてリクエスト全体がコピーされます。このため、エラーのデバッグに取り組むことができます。ただし、これにはリクエストで渡した機密情報がすべて含まれます。エラーメッセージを共有するときには、アカウントの重要な機密情報を他のユーザーに誤って公開することがないように、十分に注意してください。
|
||||||
|
|
||||||
|
|
||||||
エラーの例:
|
エラーの例:
|
||||||
@@ -74,44 +74,44 @@ HTTP Status: 200 OK
|
|||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------|:---------|:------------------------------------------------------|
|
|:----------|:---------|:------------------------------------------------------|
|
||||||
| `id` | （場合により異なる） | この応答の要求元となったWeb Socket要求に指定されていたID |
|
| `id` | （場合により異なる） | このレスポンスのリクエスト元となったWeb Socketリクエストに指定されていたID |
|
||||||
| `status` | 文字列 | `"error"`: 要求が原因でエラーが発生した場合 |
|
| `status` | 文字列 | `"error"`: リクエストが原因でエラーが発生した場合 |
|
||||||
| `type` | 文字列 | 通常は`"response"`。これは、コマンドに対し正常に応答したことを示します。 |
|
| `type` | 文字列 | 通常は`"response"`。これは、コマンドに対し正常にレスポンスしたことを示します。 |
|
||||||
| `error` | 文字列 | 発生したエラータイプの一意のコード。 |
|
| `error` | 文字列 | 発生したエラータイプの一意のコード。 |
|
||||||
| `request` | オブジェクト | このエラーが発生した要求のコピー（JSONフォーマット）。**注意:** 要求にアカウントの機密情報が含まれている場合、ここにコピーされます。 |
|
| `request` | オブジェクト | このエラーが発生したリクエストのコピー（JSONフォーマット）。**注意:** リクエストにアカウントの機密情報が含まれている場合、ここにコピーされます。 |
|
||||||
|
|
||||||
|
|
||||||
## JSON-RPCフォーマット
|
## JSON-RPCフォーマット
|
||||||
|
|
||||||
一部のJSON-RPC要求は、HTTPレイヤーでエラーコードで応答します。この場合、応答は応答本文にプレーンテキストで記述されます。たとえば`method`パラメーターでコマンドを指定し忘れた場合、応答は次のようになります。
|
一部のJSON-RPCリクエストは、HTTPレイヤーでエラーコードでレスポンスします。この場合、レスポンスはレスポンス本文にプレーンテキストで記述されます。たとえば`method`パラメーターでコマンドを指定し忘れた場合、レスポンスは次のようになります。
|
||||||
|
|
||||||
```
|
```
|
||||||
HTTP Status: 400 Bad Request
|
HTTP Status: 400 Bad Request
|
||||||
Null method
|
Null method
|
||||||
```
|
```
|
||||||
|
|
||||||
HTTPステータスコード200 OKが返されるその他のエラーの場合、応答はJSONフォーマットで、以下のフィールドが使用されます。
|
HTTPステータスコード200 OKが返されるその他のエラーの場合、レスポンスはJSONフォーマットで、以下のフィールドが使用されます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------|:-------|:-------------------------------------------------|
|
|:-----------------|:-------|:-------------------------------------------------|
|
||||||
| `result` | オブジェクト | クエリーに対する応答が含まれているオブジェクト |
|
| `result` | オブジェクト | クエリーに対するレスポンスが含まれているオブジェクト |
|
||||||
| `result.error` | 文字列 | 発生したエラータイプの一意のコード。 |
|
| `result.error` | 文字列 | 発生したエラータイプの一意のコード。 |
|
||||||
| `result.status` | 文字列 | `"error"`: 要求が原因でエラーが発生した場合 |
|
| `result.status` | 文字列 | `"error"`: リクエストが原因でエラーが発生した場合 |
|
||||||
| `result.request` | オブジェクト | このエラーが発生した要求のコピー（JSONフォーマット）。**注意:** 要求にアカウントの機密情報が含まれている場合、ここにコピーされます。**注記:** 発行される要求にかかわらず、要求はWebSocketフォーマットに再設定されます。 |
|
| `result.request` | オブジェクト | このエラーが発生したリクエストのコピー（JSONフォーマット）。**注意:** リクエストにアカウントの機密情報が含まれている場合、ここにコピーされます。**注記:** 発行されるリクエストにかかわらず、リクエストはWebSocketフォーマットに再設定されます。 |
|
||||||
|
|
||||||
|
|
||||||
## 汎用エラー
|
## 汎用エラー
|
||||||
|
|
||||||
すべてのメソッドは、以下のいずれかの値の`error`コードを返す可能性があります。
|
すべてのメソッドは、以下のいずれかの値の`error`コードを返す可能性があります。
|
||||||
|
|
||||||
* `unknownCmd` - 要求に、`rippled`サーバーが認識する[コマンド](http-websocket-apis.html)が含まれていません。
|
* `unknownCmd` - リクエストに、`rippled`サーバーが認識する[コマンド](http-websocket-apis.html)が含まれていません。
|
||||||
* `jsonInvalid` -（WebSocketのみ）要求は適切なJSONオブジェクトではありません。
|
* `jsonInvalid` -（WebSocketのみ）リクエストは適切なJSONオブジェクトではありません。
|
||||||
* この場合JSON-RPCは、代わりに400 Bad Request HTTPエラーを返します。
|
* この場合JSON-RPCは、代わりに400 Bad Request HTTPエラーを返します。
|
||||||
* `missingCommand` -（WebSocketのみ）要求に`command`フィールドが指定されていませんでした。
|
* `missingCommand` -（WebSocketのみ）リクエストに`command`フィールドが指定されていませんでした。
|
||||||
* この場合JSON-RPCは、代わりに400 Bad Request HTTPエラーを返します。
|
* この場合JSON-RPCは、代わりに400 Bad Request HTTPエラーを返します。
|
||||||
* `tooBusy` - サーバーの負荷が高すぎるため、現在このコマンドを実行できません。管理者として接続している場合は、通常このエラーが返されることはありません。
|
* `tooBusy` - サーバーの負荷が高すぎるため、現在このコマンドを実行できません。管理者として接続している場合は、通常このエラーが返されることはありません。
|
||||||
* `noNetwork` - サーバーとXRP Ledgerピアツーピアネットワークのその他の部分との接続で問題が発生しています（サーバーがスタンドアロンモードで実行されていません）。
|
* `noNetwork` - サーバーとXRP Ledgerピアツーピアネットワークのその他の部分との接続で問題が発生しています（サーバーがスタンドアロンモードで実行されていません）。
|
||||||
* `noCurrent` - 高い負荷、ネットワークの問題、バリデータ障害、誤った構成、またはその他の問題が原因で、サーバーが現行のレジャーを認識できません。
|
* `noCurrent` - 高い負荷、ネットワークの問題、バリデータ障害、誤った構成、またはその他の問題が原因で、サーバーが現行のレジャーを認識できません。
|
||||||
* `noClosed` - サーバーに決済済みレジャーがありません。通常、このエラーは起動が完了していないことが原因で発生します。
|
* `noClosed` - サーバーに決済済みレジャーがありません。通常、このエラーは起動が完了していないことが原因で発生します。
|
||||||
* `wsTextRequired` -（WebSocketのみ）要求の[opcode](https://tools.ietf.org/html/rfc6455#section-5.2)がテキストではありません。
|
* `wsTextRequired` -（WebSocketのみ）リクエストの[opcode](https://tools.ietf.org/html/rfc6455#section-5.2)がテキストではありません。
|
||||||
* `amendmentBlocked` - サーバーの状態が[Amendment blocked](amendments.html#amendment-blocked)であるため、XRP Ledgerネットワークとの同期を維持するために最新バージョンに更新する必要があります。
|
* `amendmentBlocked` - サーバーの状態が[Amendment blocked](amendments.html#amendment-blocked)であるため、XRP Ledgerネットワークとの同期を維持するために最新バージョンに更新する必要があります。
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
html: markers-and-pagination.html
|
html: markers-and-pagination.html
|
||||||
parent: api-conventions.html
|
parent: api-conventions.html
|
||||||
blurb: 大きなクエリを複数の応答にページネーションする際の慣例です。
|
blurb: 大きなクエリを複数のレスポンスにページネーションする際の慣例です。
|
||||||
---
|
---
|
||||||
# マーカーとページネーション
|
# マーカーとページネーション
|
||||||
|
|
||||||
一部のメソッドから返されるデータは、1つの応答に実質的に収まらないことがあります。結果全体が収まらない場合、応答には`marker`フィールドが含まれます。このフィールドを使用することで、複数回の呼出しを通じてデータのページをさらに取得できます。各要求で直前の応答の`marker`値を渡して、終わったところから再開します。応答に`marker`が含まれていなければ、データセットの終わりに達しています。
|
一部のメソッドから返されるデータは、1つのレスポンスに実質的に収まらないことがあります。結果全体が収まらない場合、レスポンスには`marker`フィールドが含まれます。このフィールドを使用することで、複数回の呼出しを通じてデータのページをさらに取得できます。各リクエストで直前のレスポンスの`marker`値を渡して、終わったところから再開します。レスポンスに`marker`が含まれていなければ、データセットの終わりに達しています。
|
||||||
|
|
||||||
`marker`フィールドのフォーマットは意図的に未定義になっています。各サーバーで`marker`をそれぞれに合わせて定義できるので、このフィールドの形式は文字列、ネストオブジェクトなどさまざまです。異なるサーバー、または同じサーバーの異なるメソッドでは、異なる`marker`定義を使用できます。各`marker`は一時的であり、10分以上経過すると予期されているとおりに機能しなくなることがあります。
|
`marker`フィールドのフォーマットは意図的に未定義になっています。各サーバーで`marker`をそれぞれに合わせて定義できるので、このフィールドの形式は文字列、ネストオブジェクトなどさまざまです。異なるサーバー、または同じサーバーの異なるメソッドでは、異なる`marker`定義を使用できます。各`marker`は一時的であり、10分以上経過すると予期されているとおりに機能しなくなることがあります。
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ labels:
|
|||||||
|
|
||||||
クライアントがレート制限に近づいている場合、サーバーは[APIレスポンス](response-formatting.html)のトップレベルにフィールド`"warning"： "load"`というフィールドを[APIレスポンス](response-formatting.html)のトップレベルに追加します。この警告はすべてのレスポンスに追加されるわけではありませんが、サーバはクライアントを切断する前に何度かこのような警告を送ることがあります。
|
クライアントがレート制限に近づいている場合、サーバーは[APIレスポンス](response-formatting.html)のトップレベルにフィールド`"warning"： "load"`というフィールドを[APIレスポンス](response-formatting.html)のトップレベルに追加します。この警告はすべてのレスポンスに追加されるわけではありませんが、サーバはクライアントを切断する前に何度かこのような警告を送ることがあります。
|
||||||
|
|
||||||
クライアントがレート制限を超えると、サーバーはそのクライアントを切断し、しばらくの間、クライアントのAPIアドレスからの要求を受け付けません。WebSocket APIとJSON-RPC APIでは、異なる切断メッセージを使用します。
|
クライアントがレート制限を超えると、サーバーはそのクライアントを切断し、しばらくの間、クライアントのAPIアドレスからのリクエストを受け付けません。WebSocket APIとJSON-RPC APIでは、異なる切断メッセージを使用します。
|
||||||
|
|
||||||
## WebSocket APIの切断メッセージ
|
## WebSocket APIの切断メッセージ
|
||||||
|
|
||||||
@@ -47,7 +47,7 @@ Server is overloaded
|
|||||||
## リクエストあたりのレート
|
## リクエストあたりのレート
|
||||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/resource/Fees.h "ソース")
|
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/resource/Fees.h "ソース")
|
||||||
|
|
||||||
サーバは時間の経過とともに行われるリクエストの数に基づいてクライアントの使用率を計算し、サーバがリクエストに応答するためにどれだけの作業をしなければならないかに基づいて、異なるタイプのリクエストに重みをつけます。[subscribeメソッド][]と[path_findメソッド][]に対するサーバからの後続メッセージもクライアントの使用率にカウントされます。
|
サーバは時間の経過とともに行われるリクエストの数に基づいてクライアントの使用率を計算し、サーバがリクエストにレスポンスするためにどれだけの作業をしなければならないかに基づいて、異なるタイプのリクエストに重みをつけます。[subscribeメソッド][]と[path_findメソッド][]に対するサーバからの後続メッセージもクライアントの使用率にカウントされます。
|
||||||
|
|
||||||
使用率は時間とともに指数関数的に低下するため、リクエストを自動的に行わないクライアントは、数秒から数分後にアクセスが回復します。
|
使用率は時間とともに指数関数的に低下するため、リクエストを自動的に行わないクライアントは、数秒から数分後にアクセスが回復します。
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
---
|
---
|
||||||
html: request-formatting.html
|
html: request-formatting.html
|
||||||
parent: api-conventions.html
|
parent: api-conventions.html
|
||||||
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの標準の要求フォーマットと例です。
|
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの標準のリクエストのフォーマットと例です。
|
||||||
---
|
---
|
||||||
# 要求フォーマット
|
# リクエストのフォーマット
|
||||||
|
|
||||||
## WebSocketフォーマット
|
## WebSocketフォーマット
|
||||||
|
|
||||||
@@ -11,30 +11,30 @@ blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの
|
|||||||
|
|
||||||
* コマンド名を最上位の`"command"`フィールドに指定します。
|
* コマンド名を最上位の`"command"`フィールドに指定します。
|
||||||
* このコマンドのすべての関連パラメーターも最上位に指定します。
|
* このコマンドのすべての関連パラメーターも最上位に指定します。
|
||||||
* オプションで、任意の値を指定した`"id"`フィールドを指定します。この要求への応答では、同一の`"id"`フィールドを使用します。そうすることで、応答が順不同で到達した場合も、どの要求によってどの応答を得られたのかがわかります。
|
* オプションで、任意の値を指定した`"id"`フィールドを指定します。このリクエストへのレスポンスでは、同一の`"id"`フィールドを使用します。そうすることで、レスポンスが順不同で到達した場合も、どのリクエストによってどのレスポンスを得られたのかがわかります。
|
||||||
|
|
||||||
応答はJSONオブジェクトとして返されます。
|
レスポンスはJSONオブジェクトとして返されます。
|
||||||
|
|
||||||
## JSON-RPCフォーマット
|
## JSON-RPCフォーマット
|
||||||
|
|
||||||
JSON-RPC要求を実行するには、`rippled`サーバーがJSON-RPC接続をリッスンしているポートおよびIPで、HTTP **POST**要求をルートパス（`/`）に送信します。HTTP/1.0またはHTTP/1.1を使用できます。HTTPSを使用する場合は、TLS v1.2を使用してください。セキュリティ上の理由から、`rippled`ではSSL v3以前を _サポートしていません_ 。
|
JSON-RPCリクエストを実行するには、`rippled`サーバーがJSON-RPC接続をリッスンしているポートおよびIPで、HTTP **POST**リクエストをルートパス（`/`）に送信します。HTTP/1.0またはHTTP/1.1を使用できます。HTTPSを使用する場合は、TLS v1.2を使用してください。セキュリティ上の理由から、`rippled`ではSSL v3以前を _サポートしていません_ 。
|
||||||
|
|
||||||
常に`Content-Type`ヘッダー（値`application/json`）を指定してください。
|
常に`Content-Type`ヘッダー（値`application/json`）を指定してください。
|
||||||
|
|
||||||
複数の要求を実行する予定の場合は、要求間で接続を閉じてから開く操作を行わずに済むように、[Keep-Alives](http://tools.ietf.org/html/rfc7230#section-6.3)を使用してください。
|
複数のリクエストを実行する予定の場合は、リクエスト間で接続を閉じてから開く操作を行わずに済むように、[Keep-Alives](http://tools.ietf.org/html/rfc7230#section-6.3)を使用してください。
|
||||||
|
|
||||||
以下の属性を指定した要求本文を[JSON](https://en.wikipedia.org/wiki/JSON)オブジェクトとして送信します。
|
以下の属性を指定したリクエスト本文を[JSON](https://en.wikipedia.org/wiki/JSON)オブジェクトとして送信します。
|
||||||
|
|
||||||
* コマンドを最上位の`"method"` フィールドに指定します。
|
* コマンドを最上位の`"method"` フィールドに指定します。
|
||||||
* 最上位の`"params"`フィールドを指定します。このフィールドの内容は、コマンドのすべてのパラメーターが指定された1つの入れ子JSONオブジェクトのみを保持している**1要素配列**です。
|
* 最上位の`"params"`フィールドを指定します。このフィールドの内容は、コマンドのすべてのパラメーターが指定された1つの入れ子JSONオブジェクトのみを保持している**1要素配列**です。
|
||||||
|
|
||||||
応答もJSONオブジェクトです。
|
レスポンスもJSONオブジェクトです。
|
||||||
|
|
||||||
## コマンドライン形式
|
## コマンドライン形式
|
||||||
|
|
||||||
コマンドラインでは、通常の（ダッシュが先頭に付いた）コマンドラインオプションの後にコマンドを指定し、その後に一連の限定的なパラメーターをスペースで区切って指定します。スペースやその他の特殊文字が含まれている可能性のあるパラメーター値は、一重引用符で囲みます。
|
コマンドラインでは、通常の（ダッシュが先頭に付いた）コマンドラインオプションの後にコマンドを指定し、その後に一連の限定的なパラメーターをスペースで区切って指定します。スペースやその他の特殊文字が含まれている可能性のあるパラメーター値は、一重引用符で囲みます。
|
||||||
|
|
||||||
### 要求の例
|
### リクエストの例
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
|
|||||||
@@ -1,24 +1,24 @@
|
|||||||
---
|
---
|
||||||
html: response-formatting.html
|
html: response-formatting.html
|
||||||
parent: api-conventions.html
|
parent: api-conventions.html
|
||||||
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの応答のフォーマットとその応答に含まれるフィールド。
|
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスのレスポンスのフォーマットとそのレスポンスに含まれるフィールド。
|
||||||
---
|
---
|
||||||
# 応答フォーマット
|
# レスポンスのフォーマット
|
||||||
|
|
||||||
`rippled` APIからの応答のフォーマットは、メソッドが呼び出されたインターフェイス（WebSocket、JSON-RPC、コマンドライン）に応じて多少異なります。コマンドラインインターフェイスがJSON-RPCを呼び出すため、コマンドラインインターフェイスとJSON-RPCインターフェイスは同じフォーマットを使用します。
|
`rippled` APIからのレスポンスのフォーマットは、メソッドが呼び出されたインターフェイス（WebSocket、JSON-RPC、コマンドライン）に応じて多少異なります。コマンドラインインターフェイスがJSON-RPCを呼び出すため、コマンドラインインターフェイスとJSON-RPCインターフェイスは同じフォーマットを使用します。
|
||||||
|
|
||||||
成功した場合の応答に含まれるフィールドは、以下の通りです。
|
成功した場合のレスポンスに含まれるフィールドは、以下の通りです。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------------|:---------|:------------------------------------------------|
|
|:----------------|:---------|:------------------------------------------------|
|
||||||
| `id` | （場合により異なる） | （WebSocketのみ）この応答の要求元となった要求で指定されているID。 |
|
| `id` | （場合により異なる） | （WebSocketのみ）このレスポンスのリクエスト元となったリクエストで指定されているID。 |
|
||||||
| `status` | 文字列 | （WebSocketのみ）値が`success`である場合、要求がサーバーによって正常に受信され、理解されたことを示します。 |
|
| `status` | 文字列 | （WebSocketのみ）値が`success`である場合、リクエストがサーバーによって正常に受信され、理解されたことを示します。 |
|
||||||
| `result.status` | 文字列 | （JSON-RPCおよびコマンドライン）値が`success`である場合、要求がサーバーによって正常に受信され、理解されたことを示します。 |
|
| `result.status` | 文字列 | （JSON-RPCおよびコマンドライン）値が`success`である場合、リクエストがサーバーによって正常に受信され、理解されたことを示します。 |
|
||||||
| `type` | 文字列 | （WebSocketのみ）値が`response`の場合、コマンドに対する正常な応答であることを示します。[非同期の通知](subscribe.html)では、`ledgerClosed`や`transaction`など異なる値が使用されます。 |
|
| `type` | 文字列 | （WebSocketのみ）値が`response`の場合、コマンドに対する正常なレスポンスであることを示します。[非同期の通知](subscribe.html)では、`ledgerClosed`や`transaction`など異なる値が使用されます。 |
|
||||||
| `result` | オブジェクト | クエリーの結果。内容はコマンドによって異なります。 |
|
| `result` | オブジェクト | クエリーの結果。内容はコマンドによって異なります。 |
|
||||||
|
|
||||||
|
|
||||||
## 成功した場合の応答の例
|
## 成功した場合のレスポンスの例
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ labels:
|
|||||||
---
|
---
|
||||||
# rippledサーバーの状態
|
# rippledサーバーの状態
|
||||||
|
|
||||||
`rippled`サーバーの設定、稼働時間、その他の要素により、サーバーがグローバルなXRP Ledgerピアツーピアネットワークに参加する度合いは異なります。これは、[server_infoメソッド][]と[server_stateメソッド][]への応答内の`server_state`フィールドに示されます。応答は昇順のやり取りに従い、後の値は前の値より優先されます。これらの応答の定義を以下に示します（優先順位の高い順）。
|
`rippled`サーバーの設定、稼働時間、その他の要素により、サーバーがグローバルなXRP Ledgerピアツーピアネットワークに参加する度合いは異なります。これは、[server_infoメソッド][]と[server_stateメソッド][]へのレスポンス内の`server_state`フィールドに示されます。レスポンスは昇順のやり取りに従い、後の値は前の値より優先されます。これらのレスポンスの定義を以下に示します（優先順位の高い順）。
|
||||||
|
|
||||||
| `Value` | 説明 |
|
| `Value` | 説明 |
|
||||||
|:---------------|:------------------------------------------------------------|
|
|:---------------|:------------------------------------------------------------|
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ labels:
|
|||||||
- **ホスト:** (任意の`rippled`サーバ(ホスト名またはIPアドレスによる))
|
- **ホスト:** (任意の`rippled`サーバ(ホスト名またはIPアドレスによる))
|
||||||
- **ポート:** (`rippled`サーバがピアプロトコルを使用するポート番号、通常は51235です。)
|
- **ポート:** (`rippled`サーバがピアプロトコルを使用するポート番号、通常は51235です。)
|
||||||
- **パス:** `/health`
|
- **パス:** `/health`
|
||||||
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストに応答するために自己署名証明書を使います。デフォルトでは、(Webブラウザを含む)ほとんどのツールは、そのようなレスポンスは信頼できないとしてフラグを立てたりブロックしたりします。これらのサーバからの応答を表示するには、証明書のチェックを無視しなければなりません (たとえば、cURLを使用している場合は`--insecure`フラグを追加します)。
|
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストにレスポンスするために自己署名証明書を使います。デフォルトでは、(Webブラウザを含む)ほとんどのツールは、そのようなレスポンスは信頼できないとしてフラグを立てたりブロックしたりします。これらのサーバからのレスポンスを表示するには、証明書のチェックを無視しなければなりません (たとえば、cURLを使用している場合は`--insecure`フラグを追加します)。
|
||||||
|
|
||||||
<!-- TODO: link a tutorial for how to run rippled with a non-self-signed TLS cert -->
|
<!-- TODO: link a tutorial for how to run rippled with a non-self-signed TLS cert -->
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ labels:
|
|||||||
- **ホスト:** (任意の`rippled`サーバ(ホスト名またはIPアドレス))
|
- **ホスト:** (任意の`rippled`サーバ(ホスト名またはIPアドレス))
|
||||||
- **ポート:** (`rippled`サーバがピアプロトコルを使用するポート番号、通常は51235です。)
|
- **ポート:** (`rippled`サーバがピアプロトコルを使用するポート番号、通常は51235です。)
|
||||||
- **パス:** `/crawl`
|
- **パス:** `/crawl`
|
||||||
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストに応答するために自己署名証明書を使います。デフォルトでは、(ウェブブラウザを含む)ほとんどのツールは、そのようなレスポンスは信頼できないとしてフラグを立てたりブロックしたりします。これらのサーバからの応答を表示するには、証明書のチェックを無視しなければなりません(たとえば、cURLを使用している場合は`--insecure`フラグを追加します)。
|
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストにレスポンスするために自己署名証明書を使います。デフォルトでは、(ウェブブラウザを含む)ほとんどのツールは、そのようなレスポンスは信頼できないとしてフラグを立てたりブロックしたりします。これらのサーバからのレスポンスを表示するには、証明書のチェックを無視しなければなりません(たとえば、cURLを使用している場合は`--insecure`フラグを追加します)。
|
||||||
|
|
||||||
|
|
||||||
## レスポンスのフォーマット
|
## レスポンスのフォーマット
|
||||||
@@ -36,7 +36,7 @@ JSONオブジェクトは次のフィールドを含んでいます。
|
|||||||
| `overlay` | オブジェクト | _(省略可)_ [peersメソッド][]のレスポンスに似ています。`active`というフィールドがあり、これはオブジェクトの配列です(下記参照)。 |
|
| `overlay` | オブジェクト | _(省略可)_ [peersメソッド][]のレスポンスに似ています。`active`というフィールドがあり、これはオブジェクトの配列です(下記参照)。 |
|
||||||
| `server` | オブジェクト | _(省略可)_ このサーバに関する情報。[server_stateメソッド][]の公開フィールドを含みます。どの`rippled`バージョン(`build_version`)か、どの[レジャーバージョン](ledger-history.html)が利用可能か(`complete_ledgers`)、サーバーの負荷量などです。[更新: rippled 1.2.1][]. |
|
| `server` | オブジェクト | _(省略可)_ このサーバに関する情報。[server_stateメソッド][]の公開フィールドを含みます。どの`rippled`バージョン(`build_version`)か、どの[レジャーバージョン](ledger-history.html)が利用可能か(`complete_ledgers`)、サーバーの負荷量などです。[更新: rippled 1.2.1][]. |
|
||||||
| `unl` | オブジェクト | _(省略可)_ [validatorsメソッド][]や[validator_list_sitesメソッド][]のレスポンスと同様です。[更新: rippled 1.2.1][]. |
|
| `unl` | オブジェクト | _(省略可)_ [validatorsメソッド][]や[validator_list_sitesメソッド][]のレスポンスと同様です。[更新: rippled 1.2.1][]. |
|
||||||
| `version` | 数値 | このピアクローラのレスポンスフォーマットのバージョンを示します。現在のピアクローラのバージョン番号は`2`です。[更新: rippled 1.2.1][]. |
|
| `version` | 数値 | このピアクローラのレスポンスのフォーマットのバージョンを示します。現在のピアクローラのバージョン番号は`2`です。[更新: rippled 1.2.1][]. |
|
||||||
|
|
||||||
`overlay.active`配列の各メンバーは、次のフィールドを持つオブジェクトです。
|
`overlay.active`配列の各メンバーは、次のフィールドを持つオブジェクトです。
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ labels:
|
|||||||
|
|
||||||
[ピアクローラ](peer-crawler.html)と同様に、バリデータリストメソッドはデフォルトで非root権限で[ピアプロトコル](peer-protocol.html)ポートから利用できます。
|
[ピアクローラ](peer-crawler.html)と同様に、バリデータリストメソッドはデフォルトで非root権限で[ピアプロトコル](peer-protocol.html)ポートから利用できます。
|
||||||
|
|
||||||
## リクエストフォーマット
|
## リクエストのフォーマット
|
||||||
|
|
||||||
バリデータリストの情報をリクエストするには、以下のHTTPリクエストを実行します。
|
バリデータリストの情報をリクエストするには、以下のHTTPリクエストを実行します。
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ labels:
|
|||||||
|
|
||||||
`{public_key}`はリスト発行者の公開鍵で、16進数です。この鍵は発行者を識別し、リストの内容が真正で完全であることを確認するためにも使われます。
|
`{public_key}`はリスト発行者の公開鍵で、16進数です。この鍵は発行者を識別し、リストの内容が真正で完全であることを確認するためにも使われます。
|
||||||
|
|
||||||
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストに応答するために自己署名したTLS証明書を使います。デフォルトでは、(Webブラウザを含む)ほとんどのツールはそのようなレスポンスが信頼できないものであるとしてフラグを立てたりブロックしたりします。これらのサーバからの応答を表示するには、証明書のチェックを無視しなければなりません(たとえばcURLを使う場合は`--insecure`フラグを追加します)。
|
- **セキュリティ:** ほとんどの`rippled`サーバはリクエストにレスポンスするために自己署名したTLS証明書を使います。デフォルトでは、(Webブラウザを含む)ほとんどのツールはそのようなレスポンスが信頼できないものであるとしてフラグを立てたりブロックしたりします。これらのサーバからのレスポンスを表示するには、証明書のチェックを無視しなければなりません(たとえばcURLを使う場合は`--insecure`フラグを追加します)。
|
||||||
|
|
||||||
バリデータリストの内容は別の暗号鍵で署名されているので、使用するTLS証明書にかかわらずその完全性を検証できます。
|
バリデータリストの内容は別の暗号鍵で署名されているので、使用するTLS証明書にかかわらずその完全性を検証できます。
|
||||||
|
|
||||||
|
|||||||
@@ -12,8 +12,8 @@ _（[PayChan Amendment][]が有効になっている必要があります。[新
|
|||||||
|
|
||||||
`account_channels`メソッドは、アカウントのPayment Channelに関する情報を返します。指定されたアカウントがChannelの送金元であり、送金先ではないChannelのみが含まれます。（Channelの「送金元」と「所有者」は同一です。）取得された情報はすべて、特定バージョンのレジャーに関連付けられています。
|
`account_channels`メソッドは、アカウントのPayment Channelに関する情報を返します。指定されたアカウントがChannelの送金元であり、送金先ではないChannelのみが含まれます。（Channelの「送金元」と「所有者」は同一です。）取得された情報はすべて、特定バージョンのレジャーに関連付けられています。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -54,20 +54,20 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK
|
|||||||
[試してみる>](websocket-api-tool.html#account_channels)
|
[試してみる>](websocket-api-tool.html#account_channels)
|
||||||
|
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| フィールド | 型 | 説明 |
|
| フィールド | 型 | 説明 |
|
||||||
|:----------------------|:-------------------------------------------|:--------|
|
|:----------------------|:-------------------------------------------|:--------|
|
||||||
| `account` | 文字列 | アカウントの一意のID。通常はアカウントの[アドレス][]です。要求は、このアカウントがChannelの所有者/送金元であるChannelを返します。 |
|
| `account` | 文字列 | アカウントの一意のID。通常はアカウントの[アドレス][]です。リクエストは、このアカウントがChannelの所有者/送金元であるChannelを返します。 |
|
||||||
| `destination_account` | 文字列 | _（省略可）_ アカウントの一意のID。通常はアカウントの[アドレス][]です。指定されている場合、フィルタリングによりこのアカウントを送金先とするPayment Channelに絞り込まれます。 |
|
| `destination_account` | 文字列 | _（省略可）_ アカウントの一意のID。通常はアカウントの[アドレス][]です。指定されている場合、フィルタリングによりこのアカウントを送金先とするPayment Channelに絞り込まれます。 |
|
||||||
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
||||||
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用する[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用する[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
||||||
| `limit` | 整数 | _（省略可）_ 取得するトランザクション数を制限します。サーバーはこの値に従う必要はありません。10以上400以下の範囲で値を指定する必要があります。デフォルトでは200です。 |
|
| `limit` | 整数 | _（省略可）_ 取得するトランザクション数を制限します。サーバーはこの値に従う必要はありません。10以上400以下の範囲で値を指定する必要があります。デフォルトでは200です。 |
|
||||||
| `marker` | [マーカー][] | _（省略可）_ 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
|
| `marker` | [マーカー][] | _（省略可）_ 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -157,16 +157,16 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| フィールド | 型 | 説明 |
|
| フィールド | 型 | 説明 |
|
||||||
|:-----------|:-------------------------------------------|:-------------------|
|
|:-----------|:-------------------------------------------|:-------------------|
|
||||||
| `account` | 文字列 | Payment Channelの送金元/所有者のアドレス。これは要求の`account`フィールドに対応しています。 |
|
| `account` | 文字列 | Payment Channelの送金元/所有者のアドレス。これはリクエストの`account`フィールドに対応しています。 |
|
||||||
| `channels` | channelオブジェクトの配列 | この`account`が所有するPayment Channel。 |
|
| `channels` | channelオブジェクトの配列 | この`account`が所有するPayment Channel。 |
|
||||||
| `ledger_hash` | 文字列 | この応答の生成に使用されたレジャーバージョンの識別用[ハッシュ][]。[新規: rippled 0.90.0][] |
|
| `ledger_hash` | 文字列 | このレスポンスの生成に使用されたレジャーバージョンの識別用[ハッシュ][]。[新規: rippled 0.90.0][] |
|
||||||
| `ledger_index` | 数値 | この応答の生成に使用されたレジャーバージョンの[レジャーインデックス][]。[新規: rippled 0.90.0][] |
|
| `ledger_index` | 数値 | このレスポンスの生成に使用されたレジャーバージョンの[レジャーインデックス][]。[新規: rippled 0.90.0][] |
|
||||||
| `validated` | ブール値 | _（省略される場合があります）_`true`の場合、この応答の情報は検証済みレジャーバージョンから取り込まれます。trueでない場合、情報は変更されることがあります。[新規: rippled 0.90.0][] |
|
| `validated` | ブール値 | _（省略される場合があります）_`true`の場合、このレスポンスの情報は検証済みレジャーバージョンから取り込まれます。trueでない場合、情報は変更されることがあります。[新規: rippled 0.90.0][] |
|
||||||
| `limit` | 数値 | _（省略される場合があります）_ この要求から実際に返されるchannelオブジェクトの数の制限。 |
|
| `limit` | 数値 | _（省略される場合があります）_ このリクエストから実際に返されるchannelオブジェクトの数の制限。 |
|
||||||
| `marker` | [マーカー][] | _（省略される場合があります）_ ページネーションのサーバー定義の値。この値を次のコールに渡して、このコールで終わった箇所から結果の取得を再開します。この後に追加のページがない場合は省略されます。 |
|
| `marker` | [マーカー][] | _（省略される場合があります）_ ページネーションのサーバー定義の値。この値を次のコールに渡して、このコールで終わった箇所から結果の取得を再開します。この後に追加のページがない場合は省略されます。 |
|
||||||
|
|
||||||
各Channelオブジェクトのフィールドは次のとおりです。
|
各Channelオブジェクトのフィールドは次のとおりです。
|
||||||
@@ -190,7 +190,7 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK
|
|||||||
|
|
||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `actNotFound` - 要求の`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
|
* `actNotFound` - リクエストの`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ labels:
|
|||||||
|
|
||||||
`account_currencies`コマンドは、アカウントのトラストラインに基づいてそのアカウントが送金または受領できる通貨のリストを返します。（このリストは完全に確認されたリストではありませんが、ユーザーインターフェイスへの入力に使用できます。）
|
`account_currencies`コマンドは、アカウントのトラストラインに基づいてそのアカウントが送金または受領できる通貨のリストを返します。（このリストは完全に確認されたリストではありませんが、ユーザーインターフェイスへの入力に使用できます。）
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -46,7 +46,7 @@ labels:
|
|||||||
|
|
||||||
[試してみる>](websocket-api-tool.html#account_currencies)
|
[試してみる>](websocket-api-tool.html#account_currencies)
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:---------------------------|:-------------------------------|
|
|:---------------|:---------------------------|:-------------------------------|
|
||||||
@@ -57,9 +57,9 @@ labels:
|
|||||||
|
|
||||||
次のフィールドは廃止予定であるため、指定しないでください。`account_index`.
|
次のフィールドは廃止予定であるため、指定しないでください。`account_index`.
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -135,7 +135,7 @@ labels:
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------------|:---------------------------|:-------------------------|
|
|:---------------------|:---------------------------|:-------------------------|
|
||||||
@@ -151,7 +151,7 @@ labels:
|
|||||||
|
|
||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `actNotFound` - 要求の`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
|
* `actNotFound` - リクエストの`account`フィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -11,9 +11,9 @@ labels:
|
|||||||
|
|
||||||
`account_info`コマンドは、アカウントとそのアクティビティおよびXRP残高についての情報を取得します。取得されたすべての情報は、特定バージョンのレジャーに関連付けられています。
|
`account_info`コマンドは、アカウントとそのアクティビティおよびXRP残高についての情報を取得します。取得されたすべての情報は、特定バージョンのレジャーに関連付けられています。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
|
|
||||||
account_info要求の例:
|
account_infoリクエストの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
|
|||||||
|
|
||||||
[試してみる>](websocket-api-tool.html#account_info)
|
[試してみる>](websocket-api-tool.html#account_info)
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 必須? | 説明 |
|
| `Field` | 型 | 必須? | 説明 |
|
||||||
|:---------------|:---------------------------|:------|:-------------------------------|
|
|:---------------|:---------------------------|:------|:-------------------------------|
|
||||||
@@ -67,9 +67,9 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
|
|||||||
|
|
||||||
次のフィールドは廃止予定のため、指定しないでください。`ident`、`ledger`,`strict`
|
次のフィールドは廃止予定のため、指定しないでください。`ident`、`ledger`,`strict`
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -198,13 +198,13 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従い、要求されたアカウントとそのデータ、アカウントの適用先レジャーが結果として表示されます。以下のフィールドが含まれます。
|
レスポンスは[標準フォーマット][]に従い、リクエストされたアカウントとそのデータ、アカウントの適用先レジャーが結果として表示されます。以下のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:-----------|:------------------------------------------|
|
|:-----------------------|:-----------|:------------------------------------------|
|
||||||
| `account_data` | オブジェクト | このアカウントの情報を含む[AccountRootレジャーオブジェクト](accountroot.html)がレジャーに保管されているとおりに表示されます。 |
|
| `account_data` | オブジェクト | このアカウントの情報を含む[AccountRootレジャーオブジェクト](accountroot.html)がレジャーに保管されているとおりに表示されます。 |
|
||||||
| `account_flags` | オブジェクト | アカウントの`Flags`フィールドに基づく、アカウントのフラグ情報(下記参照)。 [新規: rippled 1.11.0][] |
|
| `account_flags` | オブジェクト | アカウントの`Flags`フィールドに基づく、アカウントのフラグ情報(下記参照)。 [新規: rippled 1.11.0][] |
|
||||||
| `signer_lists` | 配列 | (要求に`signer_lists`が指定されていて、少なくとも1つのSignerListがアカウントに関連する場合を除いて省略)[マルチシグ](multi-signing.html)用にアカウントに関連付けられた[SignerListレジャーオブジェクト](signerlist.html)の配列。アカウントが所有できるSignerListは最大1つであるため、この配列のメンバーは存在するとすれば、1メンバーのみです。 |
|
| `signer_lists` | 配列 | (リクエストに`signer_lists`が指定されていて、少なくとも1つのSignerListがアカウントに関連する場合を除いて省略)[マルチシグ](multi-signing.html)用にアカウントに関連付けられた[SignerListレジャーオブジェクト](signerlist.html)の配列。アカウントが所有できるSignerListは最大1つであるため、この配列のメンバーは存在するとすれば、1メンバーのみです。 |
|
||||||
| `ledger_current_index` | 整数 | (`ledger_index`が代わりに指定されている場合は省略) この情報を取得したときに使用されていた最新のレジャーのシーケンス番号。この情報には、これより新しいレジャーの変更は一切含まれません。 |
|
| `ledger_current_index` | 整数 | (`ledger_index`が代わりに指定されている場合は省略) この情報を取得したときに使用されていた最新のレジャーのシーケンス番号。この情報には、これより新しいレジャーの変更は一切含まれません。 |
|
||||||
| `ledger_index` | 整数 | (`ledger_current_index`が代わりに指定されている場合は省略) この情報を取得したときに使用されていたレジャーのシーケンス番号。この情報には、これより新しいレジャーの変更は一切含まれません。 |
|
| `ledger_index` | 整数 | (`ledger_current_index`が代わりに指定されている場合は省略) この情報を取得したときに使用されていたレジャーのシーケンス番号。この情報には、これより新しいレジャーの変更は一切含まれません。 |
|
||||||
| `queue_data` | オブジェクト | (`queue`が`true`と指定され、現在開いているレジャーを問い合わせている場合を除いて省略) このアカウントによって送信された[キューに入れられたトランザクション](transaction-cost.html#キューに入れられたトランザクション)についての情報。この情報にはローカル`rippled`サーバの状態が示されますが、コンセンサスネットワーク内の他のサーバとは異なる場合があります。示される値はキューメカニズムによって「大まかに」計算されるため、一部のフィールドは省略される場合があります。 |
|
| `queue_data` | オブジェクト | (`queue`が`true`と指定され、現在開いているレジャーを問い合わせている場合を除いて省略) このアカウントによって送信された[キューに入れられたトランザクション](transaction-cost.html#キューに入れられたトランザクション)についての情報。この情報にはローカル`rippled`サーバの状態が示されますが、コンセンサスネットワーク内の他のサーバとは異なる場合があります。示される値はキューメカニズムによって「大まかに」計算されるため、一部のフィールドは省略される場合があります。 |
|
||||||
@@ -226,7 +226,7 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
|
|||||||
| `noFreeze` | 真偽値 | `true`の場合、このアカウントは個々のトラストラインを凍結したり、グローバル凍結を行う機能を永久に放棄しています。詳細は[No Freeze](freezes.html#no-freeze)をご覧ください。 |
|
| `noFreeze` | 真偽値 | `true`の場合、このアカウントは個々のトラストラインを凍結したり、グローバル凍結を行う機能を永久に放棄しています。詳細は[No Freeze](freezes.html#no-freeze)をご覧ください。 |
|
||||||
| `passwordSpent` | 真偽値 | `false`の場合、このアカウントはトランザクションコスト0の特別な[キーリセットトランザクション](transaction-cost.html#key-resetトランザクション)を送信できます。プロトコルはこのフラグを自動的にオン/オフします。 |
|
| `passwordSpent` | 真偽値 | `false`の場合、このアカウントはトランザクションコスト0の特別な[キーリセットトランザクション](transaction-cost.html#key-resetトランザクション)を送信できます。プロトコルはこのフラグを自動的にオン/オフします。 |
|
||||||
| `requireAuthorization` | 真偽値 | `true`の場合、このアカウントは[認可トラストライン](authorized-trust-lines.html)を使って、発行するトークンを保持できる人を制限しています。 |
|
| `requireAuthorization` | 真偽値 | `true`の場合、このアカウントは[認可トラストライン](authorized-trust-lines.html)を使って、発行するトークンを保持できる人を制限しています。 |
|
||||||
| `requireDestinationTag` | 真偽値 | `true`の場合、このアカウントは受け取るすべての支払いに[宛先タグ](require-destination-tags.html)を要求しています。 |
|
| `requireDestinationTag` | 真偽値 | `true`の場合、このアカウントは受け取るすべての支払いに[宛先タグ](require-destination-tags.html)をリクエストしています。 |
|
||||||
|
|
||||||
`queue_data`パラメーターが存在する場合、以下のフィールドが含まれます。
|
`queue_data`パラメーターが存在する場合、以下のフィールドが含まれます。
|
||||||
|
|
||||||
@@ -252,8 +252,8 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
|
|||||||
## 考えられるエラー
|
## 考えられるエラー
|
||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。例えば、要求で`queue`を`true`と指定したが、現在開いているレジャーではない`ledger_index`を指定した場合です。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。例えば、リクエストで`queue`を`true`と指定したが、現在開いているレジャーではない`ledger_index`を指定した場合です。
|
||||||
* `actNotFound` - 要求の`account`フィールドに指定したアドレスが、レジャー内のアカウントに対応していません。
|
* `actNotFound` - リクエストの`account`フィールドに指定したアドレスが、レジャー内のアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
|
|
||||||
[手数料レベル]: transaction-cost.html#手数料レベル
|
[手数料レベル]: transaction-cost.html#手数料レベル
|
||||||
|
|||||||
@@ -10,9 +10,9 @@ labels:
|
|||||||
|
|
||||||
`account_lines`メソッドは、アカウントのトラストラインに関する情報（XRP以外のあらゆる通貨の残高と資産など）を返します。取得された情報はすべて、特定バージョンのレジャーに関連付けられています。
|
`account_lines`メソッドは、アカウントのトラストラインに関する情報（XRP以外のあらゆる通貨の残高と資産など）を返します。取得された情報はすべて、特定バージョンのレジャーに関連付けられています。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#account_lines)
|
[試してみる >](websocket-api-tool.html#account_lines)
|
||||||
|
|
||||||
要求には以下のパラメーターを指定できます。
|
リクエストには以下のパラメーターを指定できます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------------|:---------------|:---------------|
|
|:--------------|:---------------|:---------------|
|
||||||
@@ -59,13 +59,13 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
|
|||||||
| `ledger_index` | 文字列または整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]をご覧ください） |
|
| `ledger_index` | 文字列または整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]をご覧ください） |
|
||||||
| `peer` | 文字列 | _（省略可）_ 2番目のアカウントの[アドレス][]。指定されている場合は、2つのアカウントを結ぶトラストラインだけが出力されます。 |
|
| `peer` | 文字列 | _（省略可）_ 2番目のアカウントの[アドレス][]。指定されている場合は、2つのアカウントを結ぶトラストラインだけが出力されます。 |
|
||||||
| `limit` | 整数 | （省略可、デフォルト値は可変）取得するトラストラインの数を制限します。サーバはこの値を受け入れる必要はありません。10以上400以下の範囲で値を指定する必要があります。 |
|
| `limit` | 整数 | （省略可、デフォルト値は可変）取得するトラストラインの数を制限します。サーバはこの値を受け入れる必要はありません。10以上400以下の範囲で値を指定する必要があります。 |
|
||||||
| `marker` | [マーカー][] | _（省略可）_ 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
|
| `marker` | [マーカー][] | _（省略可）_ 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
|
||||||
|
|
||||||
以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。`ledger`および`peer_index`。
|
以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。`ledger`および`peer_index`。
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -407,16 +407,16 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合には、アカウントのアドレスとトラストラインオブジェクトの配列が含まれています。具体的には、結果オブジェクトには以下のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合には、アカウントのアドレスとトラストラインオブジェクトの配列が含まれています。具体的には、結果オブジェクトには以下のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:----------------------------|:-----------------------|
|
|:-----------------------|:----------------------------|:-----------------------|
|
||||||
| `account` | 文字列 | この要求に対応するアカウントの一意の[アドレス][]。トラストラインのための「パースペクティブアカウント」です。 |
|
| `account` | 文字列 | このリクエストに対応するアカウントの一意の[アドレス][]。トラストラインのための「パースペクティブアカウント」です。 |
|
||||||
| `lines` | 配列 | トラストラインオブジェクトからなる配列。以下で説明します。トラストラインの数が多い場合は、一度に`limit`の数までのトラストラインが返されます。 |
|
| `lines` | 配列 | トラストラインオブジェクトからなる配列。以下で説明します。トラストラインの数が多い場合は、一度に`limit`の数までのトラストラインが返されます。 |
|
||||||
| `ledger_current_index` | 整数 - [レジャーインデックス][] | _（`ledger_hash`または`ledger_index`が指定されている場合は省略）_ この情報の取得時に使用した、現行のオープンレジャーのレジャーインデックス。 |
|
| `ledger_current_index` | 整数 - [レジャーインデックス][] | _（`ledger_hash`または`ledger_index`が指定されている場合は省略）_ この情報の取得時に使用した、現行のオープンレジャーのレジャーインデックス。 |
|
||||||
| `ledger_index` | 整数 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略）_ このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
|
| `ledger_index` | 整数 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略）_ このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
|
||||||
| `ledger_hash` | 文字列 - [ハッシュ][] | _（省略される場合があります）_ このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
|
| `ledger_hash` | 文字列 - [ハッシュ][] | _（省略される場合があります）_ このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
|
||||||
| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます |
|
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます |
|
||||||
|
|
||||||
各トラストラインオブジェクトには以下のフィールドの組み合わせが含まれています。
|
各トラストラインオブジェクトには以下のフィールドの組み合わせが含まれています。
|
||||||
|
|
||||||
@@ -440,7 +440,7 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
|
|||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `actNotFound` - 要求の`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
* `actMalformed` - 指定されている`marker`フィールドが受け入れられない場合。
|
* `actMalformed` - 指定されている`marker`フィールドが受け入れられない場合。
|
||||||
|
|
||||||
|
|||||||
@@ -12,8 +12,8 @@ labels:
|
|||||||
|
|
||||||
_([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
_([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例
|
リクエストのフォーマットの例
|
||||||
|
|
||||||
{% include '_snippets/no-cli-syntax.ja.md' %}
|
{% include '_snippets/no-cli-syntax.ja.md' %}
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#account_nfts)
|
[試してみる >](websocket-api-tool.html#account_nfts)
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| フィールド | 型 | 説明 |
|
| フィールド | 型 | 説明 |
|
||||||
|:---------------|:-----------------|:-----------------------------------------|
|
|:---------------|:-----------------|:-----------------------------------------|
|
||||||
@@ -56,8 +56,8 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
|||||||
| `marker` | [マーカー][] | _(省略可)_ 以前のページ分割されたレスポンスの値。そのレスポンスが終了したところからデータの取得を再開します。 |
|
| `marker` | [マーカー][] | _(省略可)_ 以前のページ分割されたレスポンスの値。そのレスポンスが終了したところからデータの取得を再開します。 |
|
||||||
|
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -128,7 +128,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:----------------------------|:----------------------------------------|
|
|:-----------------------|:----------------------------|:----------------------------------------|
|
||||||
@@ -156,7 +156,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
|||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `actNotFound` - 要求の`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ labels:
|
|||||||
|
|
||||||
`account_objects`コマンドは、アカウントが所有するすべてのレジャーエントリの生[レジャーフォーマット][]を返します。アカウントのトラストラインと残高の概要については、[account_linesメソッド][]をご覧ください。
|
`account_objects`コマンドは、アカウントが所有するすべてのレジャーエントリの生[レジャーフォーマット][]を返します。アカウントのトラストラインと残高の概要については、[account_linesメソッド][]をご覧ください。
|
||||||
|
|
||||||
アカウントの`account_objects`応答に含まれる可能性のあるオブジェクトのタイプには以下のものがあります。
|
アカウントの`account_objects`レスポンスに含まれる可能性のあるオブジェクトのタイプには以下のものがあります。
|
||||||
|
|
||||||
- [Offerエントリ](offer.html): 現在処理中であり、資金化されていない、または有効期限切れで削除されていない注文情報。（詳細は、[オファーのライフサイクル](offers.html#オファーのライフサイクル)をご覧ください。）
|
- [Offerエントリ](offer.html): 現在処理中であり、資金化されていない、または有効期限切れで削除されていない注文情報。（詳細は、[オファーのライフサイクル](offers.html#オファーのライフサイクル)をご覧ください。）
|
||||||
- [RippleStateエントリ](ripplestate.html): このアカウント側がデフォルト状態にないトラストライン。
|
- [RippleStateエントリ](ripplestate.html): このアカウント側がデフォルト状態にないトラストライン。
|
||||||
@@ -25,8 +25,8 @@ labels:
|
|||||||
- [NFTokenPageエントリ](nftokenpage.html): NFTの集合。 [新規: rippled 1.11.0][]
|
- [NFTokenPageエントリ](nftokenpage.html): NFTの集合。 [新規: rippled 1.11.0][]
|
||||||
|
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -71,7 +71,7 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 必須? | 説明 |
|
| `Field` | 型 | 必須? | 説明 |
|
||||||
|:-------------------------|:----------------------|:-----|:---------------|
|
|:-------------------------|:----------------------|:-----|:---------------|
|
||||||
@@ -80,14 +80,14 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
|
|||||||
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]をご覧ください） |
|
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]をご覧ください） |
|
||||||
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]ををご覧ください） |
|
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]ををご覧ください） |
|
||||||
| `limit` | 符号なし整数 | いいえ | 結果に含めることができるオブジェクトの最大数。非管理者接続では10以上400以下の範囲で値を指定する必要があります。デフォルトでは200です。 |
|
| `limit` | 符号なし整数 | いいえ | 結果に含めることができるオブジェクトの最大数。非管理者接続では10以上400以下の範囲で値を指定する必要があります。デフォルトでは200です。 |
|
||||||
| `marker` | [マーカー][] | いいえ | 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
|
| `marker` | [マーカー][] | いいえ | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
|
||||||
| `type` | 文字列 | いいえ | 指定されている場合、結果をフィルタリングしてこのタイプのレジャーオブジェクトのみが含まれるようにします。有効なタイプは`check`、`deposit_preauth`、`escrow`、`offer`、`payment_channel`、`signer_list`、`state`（トラストライン）そして`ticket`です。 |
|
| `type` | 文字列 | いいえ | 指定されている場合、結果をフィルタリングしてこのタイプのレジャーオブジェクトのみが含まれるようにします。有効なタイプは`check`、`deposit_preauth`、`escrow`、`offer`、`payment_channel`、`signer_list`、`state`（トラストライン）そして`ticket`です。 |
|
||||||
|
|
||||||
**注記:** `account_objects`コマンドのコマンドラインインタフェースは`type`フィールドを受け付けません。代わりにコマンドラインでJSON-RPC形式のリクエストを送信するには[jsonメソッド][]を使用してください。
|
**注記:** `account_objects`コマンドのコマンドラインインタフェースは`type`フィールドを受け付けません。代わりにコマンドラインでJSON-RPC形式のリクエストを送信するには[jsonメソッド][]を使用してください。
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -1204,24 +1204,24 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:----------------------------|:------------------------|
|
|:-----------------------|:----------------------------|:------------------------|
|
||||||
| `account` | 文字列 | この要求に対応するアカウントの一意の[アドレス][]。 |
|
| `account` | 文字列 | このリクエストに対応するアカウントの一意の[アドレス][]。 |
|
||||||
| `account_objects` | 配列 | このアカウントが所有するオブジェクトの配列。各オブジェクトは、生[レジャーフォーマット][]です。 |
|
| `account_objects` | 配列 | このアカウントが所有するオブジェクトの配列。各オブジェクトは、生[レジャーフォーマット][]です。 |
|
||||||
| `ledger_hash` | 文字列 | （省略される場合があります）この応答の生成に使用されたレジャーの識別用ハッシュ。 |
|
| `ledger_hash` | 文字列 | （省略される場合があります）このレスポンスの生成に使用されたレジャーの識別用ハッシュ。 |
|
||||||
| `ledger_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ この応答の生成に使用されたレジャーバージョンのレジャーインデックス。 |
|
| `ledger_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 |
|
||||||
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ この応答の生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
|
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ このレスポンスの生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
|
||||||
| `limit` | 数値 | _（省略される場合があります）_ この要求で使用されていた制限（制限の使用がある場合）。 |
|
| `limit` | 数値 | _（省略される場合があります）_ このリクエストで使用されていた制限（制限の使用がある場合）。 |
|
||||||
| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます。 |
|
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます。 |
|
||||||
| `validated` | 真偽値 | このフィールドが含まれていて`true`に設定されている場合、この応答内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
|
| `validated` | 真偽値 | このフィールドが含まれていて`true`に設定されている場合、このレスポンス内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
|
||||||
|
|
||||||
## 考えられるエラー
|
## 考えられるエラー
|
||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `actNotFound` - 要求の`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -10,9 +10,9 @@ labels:
|
|||||||
|
|
||||||
`account_offers`メソッドは、特定の[アカウント](accounts.html)から出された[オファー](offers.html)のうち、特定の[レジャーバージョン](ledgers.html)で未処理であったオファーのリストを取得します。
|
`account_offers`メソッドは、特定の[アカウント](accounts.html)から出された[オファー](offers.html)のうち、特定の[レジャーバージョン](ledgers.html)で未処理であったオファーのリストを取得します。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#account_offers)
|
[試してみる >](websocket-api-tool.html#account_offers)
|
||||||
|
|
||||||
要求には以下のパラメーターを指定できます。
|
リクエストには以下のパラメーターを指定できます。
|
||||||
|
|
||||||
| `Field` | 型 | 必須? | 説明 |
|
| `Field` | 型 | 必須? | 説明 |
|
||||||
|:---------------|:----------------------|:-----|:------------------------------|
|
|:---------------|:----------------------|:-----|:------------------------------|
|
||||||
@@ -58,13 +58,13 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
|
|||||||
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンを識別する20バイトの16進文字列。 |
|
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンを識別する20バイトの16進文字列。 |
|
||||||
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、レジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]をご覧ください |
|
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、レジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]をご覧ください |
|
||||||
| `limit` | 整数 | いいえ | 取得するオファーの数を制限します。サーバはこの数より少ない結果を返すことがあります。10～400の範囲内でなければなりません。この範囲外の正の値は、最も近い有効なオプションに置き換えられます。デフォルトは200です。 |
|
| `limit` | 整数 | いいえ | 取得するオファーの数を制限します。サーバはこの数より少ない結果を返すことがあります。10～400の範囲内でなければなりません。この範囲外の正の値は、最も近い有効なオプションに置き換えられます。デフォルトは200です。 |
|
||||||
| `marker` | [マーカー][] | いいえ | 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
|
| `marker` | [マーカー][] | いいえ | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
|
||||||
|
|
||||||
以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。`ledger`,`strict`
|
以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。`ledger`,`strict`
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -186,16 +186,16 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:----------------------------|:------------------------|
|
|:-----------------------|:----------------------------|:------------------------|
|
||||||
| `account` | 文字列 | オファーを出したアカウントを識別する一意の[アドレス][] |
|
| `account` | 文字列 | オファーを出したアカウントを識別する一意の[アドレス][] |
|
||||||
| `offers` | 配列 | オブジェクトの配列。各オブジェクトは、このアカウントが出したオファーの中で、レジャーバージョンが要求された時点で未処理のオファーを表します。オファーの数が多い場合は、一度に`limit`の数までのオファーが返されます。 |
|
| `offers` | 配列 | オブジェクトの配列。各オブジェクトは、このアカウントが出したオファーの中で、レジャーバージョンがリクエストされた時点で未処理のオファーを表します。オファーの数が多い場合は、一度に`limit`の数までのオファーが返されます。 |
|
||||||
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（`ledger_hash`または`ledger_index`が指定されている場合は省略可）_ このデータの取得時に使用した、現在処理中のレジャーバージョンのレジャーインデックス。 |
|
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（`ledger_hash`または`ledger_index`が指定されている場合は省略可）_ このデータの取得時に使用した、現在処理中のレジャーバージョンのレジャーインデックス。 |
|
||||||
| `ledger_index` | 数値 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略可）_ 要求に従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
|
| `ledger_index` | 数値 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略可）_ リクエストに従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
|
||||||
| `ledger_hash` | 文字列 - [ハッシュ][] | _（省略される場合があります）_ このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
|
| `ledger_hash` | 文字列 - [ハッシュ][] | _（省略される場合があります）_ このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
|
||||||
| `marker` | [マーカー][] | _（省略される場合があります）_ 応答がページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
|
| `marker` | [マーカー][] | _（省略される場合があります）_ レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
|
||||||
|
|
||||||
|
|
||||||
各Offerオブジェクトのフィールドを次に示します。
|
各Offerオブジェクトのフィールドを次に示します。
|
||||||
@@ -213,7 +213,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
|
|||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `actNotFound` - 要求の`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
* `actMalformed` - 指定されている`marker`フィールドが受け入れられない場合。
|
* `actMalformed` - 指定されている`marker`フィールドが受け入れられない場合。
|
||||||
|
|
||||||
|
|||||||
@@ -11,9 +11,9 @@ labels:
|
|||||||
|
|
||||||
`account_tx`メソッドは、指定したアカウントに関連するトランザクションのリストを取得します。
|
`account_tx`メソッドは、指定したアカウントに関連するトランザクションのリストを取得します。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#account_tx)
|
[試してみる >](websocket-api-tool.html#account_tx)
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------------|:-------------------------------------------|:-----------|
|
|:-------------------|:-------------------------------------------|:-----------|
|
||||||
@@ -73,9 +73,9 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
|
|||||||
| `binary` | ブール値 | _（省略可能）_ デフォルトは`false`です。`true`に設定すると、JSONの代わりに16進文字列でトランザクションが返されます。 |
|
| `binary` | ブール値 | _（省略可能）_ デフォルトは`false`です。`true`に設定すると、JSONの代わりに16進文字列でトランザクションが返されます。 |
|
||||||
| `forward` | ブール値 | _（省略可能）_ デフォルトは`false`です。`true`に設定すると、最も古いレジャーを先頭としてインデックスが付けられた値が返されます。そうしない場合、最新のレジャーを先頭として結果にインデックスが付けられます。（結果を示した各ページの中身は順序よく整理されていない場合がありますが、ページ全体としては順序付けされています。） |
|
| `forward` | ブール値 | _（省略可能）_ デフォルトは`false`です。`true`に設定すると、最も古いレジャーを先頭としてインデックスが付けられた値が返されます。そうしない場合、最新のレジャーを先頭として結果にインデックスが付けられます。（結果を示した各ページの中身は順序よく整理されていない場合がありますが、ページ全体としては順序付けされています。） |
|
||||||
| `limit` | 整数 | _（省略可能）_ デフォルトは変化します。取得するトランザクションの数を制限します。サーバーはこの値を受け入れる必要はありません。 |
|
| `limit` | 整数 | _（省略可能）_ デフォルトは変化します。取得するトランザクションの数を制限します。サーバーはこの値を受け入れる必要はありません。 |
|
||||||
| `marker` | [マーカー][] | 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。サーバーが使用できるレジャーの範囲に変更があっても、この値は変わりません。 |
|
| `marker` | [マーカー][] | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。サーバーが使用できるレジャーの範囲に変更があっても、この値は変わりません。 |
|
||||||
|
|
||||||
次の各フィールドは省略可能とされていますが、要求内で**1つ以上は使用する必要があります**: `ledger_index`、`ledger_hash`、`ledger_index_min`、または`ledger_index_max`。
|
次の各フィールドは省略可能とされていますが、リクエスト内で**1つ以上は使用する必要があります**: `ledger_index`、`ledger_hash`、`ledger_index_min`、または`ledger_index_max`。
|
||||||
|
|
||||||
次のフィールドは廃止されました： `offset`、`count`、`descending`、`ledger_max`、`ledger_min`。 [削除: rippled 1.7.0][]
|
次のフィールドは廃止されました： `offset`、`count`、`descending`、`ledger_max`、`ledger_min`。 [削除: rippled 1.7.0][]
|
||||||
|
|
||||||
@@ -83,11 +83,11 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
|
|||||||
|
|
||||||
他のページネーションメソッドと同様に、`marker`フィールドを使用すると複数ページのデータが返されます。
|
他のページネーションメソッドと同様に、`marker`フィールドを使用すると複数ページのデータが返されます。
|
||||||
|
|
||||||
複数の要求の合間に、`"ledger_index_min": -1`と`"ledger_index_max": -1`が変更されて、以前とは異なるレジャーバージョンを参照する場合があります。`marker`フィールドを使用すると、要求からのレジャー範囲に変更がある場合でも、マーカーが示すポイントが要求で指定されたレジャーの範囲外でない限り、安全にページネーションできます。
|
複数のリクエストの合間に、`"ledger_index_min": -1`と`"ledger_index_max": -1`が変更されて、以前とは異なるレジャーバージョンを参照する場合があります。`marker`フィールドを使用すると、リクエストからのレジャー範囲に変更がある場合でも、マーカーが示すポイントがリクエストで指定されたレジャーの範囲外でない限り、安全にページネーションできます。
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -564,21 +564,21 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------------|:---------------------------|:---------------------------|
|
|:-------------------|:---------------------------|:---------------------------|
|
||||||
| `account` | 文字列 | 関連するアカウントを識別する一意の[アドレス][]。 |
|
| `account` | 文字列 | 関連するアカウントを識別する一意の[アドレス][]。 |
|
||||||
| `ledger_index_min` | 整数 - [レジャーインデックス][] | トランザクションで実際に検索された最古のレジャーのレジャーインデックス。 |
|
| `ledger_index_min` | 整数 - [レジャーインデックス][] | トランザクションで実際に検索された最古のレジャーのレジャーインデックス。 |
|
||||||
| `ledger_index_max` | 整数 - [レジャーインデックス][] | トランザクションで実際に検索された最新のレジャーのレジャーインデックス。 |
|
| `ledger_index_max` | 整数 - [レジャーインデックス][] | トランザクションで実際に検索された最新のレジャーのレジャーインデックス。 |
|
||||||
| `limit` | 整数 | 要求で使用される`limit`値。（サーバーによって強制される実際の制限値とは異なる場合があります。） |
|
| `limit` | 整数 | リクエストで使用される`limit`値。（サーバーによって強制される実際の制限値とは異なる場合があります。） |
|
||||||
| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
|
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
|
||||||
| `transactions` | 配列 | 以降で説明する、要求の基準を満たすトランザクションの配列。 |
|
| `transactions` | 配列 | 以降で説明する、リクエストの基準を満たすトランザクションの配列。 |
|
||||||
| `validated` | ブール値 | このフィールドが含まれていて`true`に設定されている場合、この応答内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
|
| `validated` | ブール値 | このフィールドが含まれていて`true`に設定されている場合、このレスポンス内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |
|
||||||
|
|
||||||
**注記:** サーバーから返される`ledger_index_min`および`ledger_index_max`の値が要求で指定したものとは異なる場合があります。例えば、サーバーに手元の指定したバージョンがない場合など。
|
**注記:** サーバーから返される`ledger_index_min`および`ledger_index_max`の値がリクエストで指定したものとは異なる場合があります。例えば、サーバーに手元の指定したバージョンがない場合など。
|
||||||
|
|
||||||
各トランザクションのオブジェクトには以下のフィールドが含まれます。含まれるフィールドは、JSONまたは16進文字列（`"binary":true`）フォーマットのどちらで要求されたかによって異なります。
|
各トランザクションのオブジェクトには以下のフィールドが含まれます。含まれるフィールドは、JSONまたは16進文字列（`"binary":true`）フォーマットのどちらでリクエストされたかによって異なります。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:---------------------------------|:-------------------------|
|
|:---------------|:---------------------------------|:-------------------------|
|
||||||
@@ -592,9 +592,9 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
|
|||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `actMalformed` - 要求の`account`フィールドに指定した[アドレス][]が、正しいフォーマットではありません。
|
* `actMalformed` - リクエストの`account`フィールドに指定した[アドレス][]が、正しいフォーマットではありません。
|
||||||
* `lgrIdxMalformed` - `ledger_index_min`または`ledger_index_max`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrIdxMalformed` - `ledger_index_min`または`ledger_index_max`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
* `lgrIdxsInvalid` - 要求で`ledger_index_min`の前にある`ledger_index_max`を指定したか、[ネットワークと同期](troubleshoot-the-rippled-server.html)されていないためにサーバーに検証済みレジャーの範囲が存在しません。
|
* `lgrIdxsInvalid` - リクエストで`ledger_index_min`の前にある`ledger_index_max`を指定したか、[ネットワークと同期](troubleshoot-the-rippled-server.html)されていないためにサーバーに検証済みレジャーの範囲が存在しません。
|
||||||
|
|
||||||
|
|
||||||
{% include '_snippets/rippled_versions.md' %}
|
{% include '_snippets/rippled_versions.md' %}
|
||||||
|
|||||||
@@ -11,8 +11,8 @@ labels:
|
|||||||
|
|
||||||
`gateway_balances`コマンドは、特定のアカウントから発行された残高の合計を計算します。オプションで、[運用アドレス](account-types.html)が保有する額を除外できます。[新規: rippled 0.28.2][]
|
`gateway_balances`コマンドは、特定のアカウントから発行された残高の合計を計算します。オプションで、[運用アドレス](account-types.html)が保有する額を除外できます。[新規: rippled 0.28.2][]
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@ labels:
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:---------------------------|:-------------------------------|
|
|:---------------|:---------------------------|:-------------------------------|
|
||||||
@@ -60,9 +60,9 @@ labels:
|
|||||||
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
||||||
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーバージョンの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーバージョンの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -205,24 +205,24 @@ labels:
|
|||||||
|
|
||||||
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
|
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:--------------------------|:------------------------|
|
|:-----------------------|:--------------------------|:------------------------|
|
||||||
| `account` | 文字列 - [アドレス][] | 残高を発行したアカウントのアドレス。 |
|
| `account` | 文字列 - [アドレス][] | 残高を発行したアカウントのアドレス。 |
|
||||||
| `obligations` | オブジェクト | （空の場合は省略）除外されていないアドレスに発行された額の合計。発行された価値の合計に対する通貨のマップとして示されます。 |
|
| `obligations` | オブジェクト | （空の場合は省略）除外されていないアドレスに発行された額の合計。発行された価値の合計に対する通貨のマップとして示されます。 |
|
||||||
| `balances` | オブジェク | _（空の場合は省略）_ 要求から`hotwallet`アドレスに発行された額。キーはアドレスであり、値はアドレスが保有する通貨額の配列です。 |
|
| `balances` | オブジェク | _（空の場合は省略）_ リクエストから`hotwallet`アドレスに発行された額。キーはアドレスであり、値はアドレスが保有する通貨額の配列です。 |
|
||||||
| `assets` | オブジェクト | _（空の場合は省略）_ 他から発行された保有額の合計。推奨される構成では、[発行アドレス](account-types.html)の保有額はありません。 |
|
| `assets` | オブジェクト | _（空の場合は省略）_ 他から発行された保有額の合計。推奨される構成では、[発行アドレス](account-types.html)の保有額はありません。 |
|
||||||
| `ledger_hash` | 文字列 - [ハッシュ][] | _（省略される場合があります）_ この応答の生成に使用されたレジャーバージョンの識別用ハッシュ。 |
|
| `ledger_hash` | 文字列 - [ハッシュ][] | _（省略される場合があります）_ このレスポンスの生成に使用されたレジャーバージョンの識別用ハッシュ。 |
|
||||||
| `ledger_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ この応答の生成に使用されたレジャーバージョンのレジャーインデックス。 | |
|
| `ledger_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 | |
|
||||||
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略）_ この情報の取得時に使用した、現在処理中のレジャーバージョンの[レジャーインデックス][]。 |
|
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略）_ この情報の取得時に使用した、現在処理中のレジャーバージョンの[レジャーインデックス][]。 |
|
||||||
|
|
||||||
## 考えられるエラー
|
## 考えられるエラー
|
||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `invalidHotWallet` - `hotwallet`フィールドに指定されている1つ以上のアドレスが、要求に指定されているアカウントが発行した通貨を保有しているアカウントの[アドレス][]ではありません。
|
* `invalidHotWallet` - `hotwallet`フィールドに指定されている1つ以上のアドレスが、リクエストに指定されているアカウントが発行した通貨を保有しているアカウントの[アドレス][]ではありません。
|
||||||
* `actNotFound` - 要求の`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ labels:
|
|||||||
|
|
||||||
`noripple_check`コマンドを使用すると、[アカウントのDefaultRippleフィールドとそのトラストラインのNoRippleフラグ](rippling.html)の状態を、推奨される設定と比較して迅速にチェックできます。
|
`noripple_check`コマンドを使用すると、[アカウントのDefaultRippleフィールドとそのトラストラインのNoRippleフラグ](rippling.html)の状態を、推奨される設定と比較して迅速にチェックできます。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@ labels:
|
|||||||
|
|
||||||
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
|
**注記:** このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:---------------------------|:-------------------------------|
|
|:---------------|:---------------------------|:-------------------------------|
|
||||||
@@ -61,9 +61,9 @@ labels:
|
|||||||
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進数文字列。（[レジャーの指定][]を参照してください。) |
|
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進数文字列。（[レジャーの指定][]を参照してください。) |
|
||||||
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください。) |
|
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください。) |
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -172,19 +172,19 @@ labels:
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:-------|:-------------------------------------------|
|
|:-----------------------|:-------|:-------------------------------------------|
|
||||||
| `ledger_current_index` | 数値 | これらの結果の計算に使用するレジャーのシーケンス番号。 |
|
| `ledger_current_index` | 数値 | これらの結果の計算に使用するレジャーのシーケンス番号。 |
|
||||||
| `problems` | 配列 | 人間が読み取ることができる形式の問題の記述が含まれている文字列の配列。アカウントのDefaultRipple設定が推奨に従っていない場合は、最大1つのエントリーが含まれます。加えて、NoRipple設定が推奨に従っていないトラストラインのエントリー（最大で`limit`に指定されている数）も含まれます。 |
|
| `problems` | 配列 | 人間が読み取ることができる形式の問題の記述が含まれている文字列の配列。アカウントのDefaultRipple設定が推奨に従っていない場合は、最大1つのエントリーが含まれます。加えて、NoRipple設定が推奨に従っていないトラストラインのエントリー（最大で`limit`に指定されている数）も含まれます。 |
|
||||||
| `transactions` | 配列 | （省略される場合があります）要求で`transactions`が`true`に指定されている場合、これはJSONオブジェクトの配列です。各JSONオブジェクトは、JSON形式の[トランザクション](transaction-formats.html)で、記述されている問題の1つを修正します。この配列の長さは`problems`配列と同じであり、各エントリーは、その配列の同じインデックスで記述されている問題の修正を目的としています。 |
|
| `transactions` | 配列 | （省略される場合があります）リクエストで`transactions`が`true`に指定されている場合、これはJSONオブジェクトの配列です。各JSONオブジェクトは、JSON形式の[トランザクション](transaction-formats.html)で、記述されている問題の1つを修正します。この配列の長さは`problems`配列と同じであり、各エントリーは、その配列の同じインデックスで記述されている問題の修正を目的としています。 |
|
||||||
|
|
||||||
## 考えられるエラー
|
## 考えられるエラー
|
||||||
|
|
||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `actNotFound` - 要求の`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
* `actNotFound` - リクエストの`account`フィールドに指定されている[アドレス][]が、レジャーのアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`に指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`に指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ labels:
|
|||||||
Clioサーバはデフォルトで検証済みのレジャーデータを返すことに注意してください。
|
Clioサーバはデフォルトで検証済みのレジャーデータを返すことに注意してください。
|
||||||
|
|
||||||
## リクエストのフォーマット
|
## リクエストのフォーマット
|
||||||
リクエストフォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -41,7 +41,7 @@ Clioサーバはデフォルトで検証済みのレジャーデータを返す
|
|||||||
| `ledger_index` | [レジャーインデックス][] | _(省略可)_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください) |
|
| `ledger_index` | [レジャーインデックス][] | _(省略可)_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください) |
|
||||||
| `transactions` | 真偽値 | _(省略可)_ `true`の場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトでは`false`です。レジャーバージョンを指定しない場合は無視されます。 |
|
| `transactions` | 真偽値 | _(省略可)_ `true`の場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトでは`false`です。レジャーバージョンを指定しない場合は無視されます。 |
|
||||||
| `expand` | 真偽値 | _(省略可)_ ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方をリクエストしない場合は無視されます。 |
|
| `expand` | 真偽値 | _(省略可)_ ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方をリクエストしない場合は無視されます。 |
|
||||||
| `owner_funds` | 真偽値 | _(省略可)_ `true`の場合、応答のOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
|
| `owner_funds` | 真偽値 | _(省略可)_ `true`の場合、レスポンスのOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
|
||||||
| `binary` | 真偽値 | _(省略可)_ `true`で、かつ`transactions`と`expand`が両方とも`true`の場合、JSONフォーマットではなくバイナリフォーマット（16進文字列）でトランザクション情報が返されます。 |
|
| `binary` | 真偽値 | _(省略可)_ `true`で、かつ`transactions`と`expand`が両方とも`true`の場合、JSONフォーマットではなくバイナリフォーマット（16進文字列）でトランザクション情報が返されます。 |
|
||||||
| `diff` | 真偽値 | _(省略可)_ `true`の場合、指定したレジャーのトランザクションの一部として追加、変更、または削除されたすべてのオブジェクトを返します。 |
|
| `diff` | 真偽値 | _(省略可)_ `true`の場合、指定したレジャーのトランザクションの一部として追加、変更、または削除されたすべてのオブジェクトを返します。 |
|
||||||
|
|
||||||
@@ -101,7 +101,7 @@ Clioサーバはデフォルトで検証済みのレジャーデータを返す
|
|||||||
| `validated` | 真偽値 | _(省略される場合があります)_ `true`の場合、このレジャーは最終バージョンです。省略または `false` の場合、このレジャーのデータは最終版ではありません。 |
|
| `validated` | 真偽値 | _(省略される場合があります)_ `true`の場合、このレジャーは最終バージョンです。省略または `false` の場合、このレジャーのデータは最終版ではありません。 |
|
||||||
| `diff` | オブジェクト | _(リクエストで`diff`パラメータの指定がない場合省略)_ レジャーのトランザクションの一部として追加、変更、または削除されたハッシュの配列を含むオブジェクト。 |
|
| `diff` | オブジェクト | _(リクエストで`diff`パラメータの指定がない場合省略)_ レジャーのトランザクションの一部として追加、変更、または削除されたハッシュの配列を含むオブジェクト。 |
|
||||||
|
|
||||||
リクエストに`"owner_funds": true`が指定されておりトランザクションが展開されている場合、応答には、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](offers.html#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](subscribe.html#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
|
リクエストに`"owner_funds": true`が指定されておりトランザクションが展開されている場合、レスポンスには、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](offers.html#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](subscribe.html#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
|
||||||
|
|
||||||
| `Field` | 値 | 説明 |
|
| `Field` | 値 | 説明 |
|
||||||
|:--------------|:------|:----------------------------------------------------|
|
|:--------------|:------|:----------------------------------------------------|
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ labels:
|
|||||||
**注記** `nft_history`はNFTに関連する成功したトランザクションのみを返します。
|
**注記** `nft_history`はNFTに関連する成功したトランザクションのみを返します。
|
||||||
|
|
||||||
## リクエストのフォーマット
|
## リクエストのフォーマット
|
||||||
リクエストフォーマットの例：
|
リクエストのフォーマットの例：
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ labels:
|
|||||||
`nft_info`コマンドはクエリ対象の[NFT](non-fungible-tokens.html)に関する情報をClioサーバに問い合わせます。[新規: Clio v1.1.0](https://github.com/XRPLF/clio/releases/tag/1.1.0 "BADGE_BLUE")
|
`nft_info`コマンドはクエリ対象の[NFT](non-fungible-tokens.html)に関する情報をClioサーバに問い合わせます。[新規: Clio v1.1.0](https://github.com/XRPLF/clio/releases/tag/1.1.0 "BADGE_BLUE")
|
||||||
|
|
||||||
## リクエストのフォーマット
|
## リクエストのフォーマット
|
||||||
リクエストフォーマットの例：
|
リクエストのフォーマットの例：
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
|
|||||||
@@ -589,7 +589,7 @@ labels:
|
|||||||
| `load_factor` | 数値 | サーバが現在実行中の、負荷スケーリングされたオープンレジャートランザクションコストを、基本トランザクションコストに適用される乗数として示したもの。例えば、負荷係数`1000`でリファレンストランザクションコストが10 dropである場合、負荷スケーリングされたトランザクションコストは10,000 drop（0.01 XRP）です。負荷係数は、[個々のサーバの負荷係数](transaction-cost.html#ローカル負荷コスト)の最高値、クラスターの負荷係数、[オープンレジャーコスト](transaction-cost.html#オープンレジャーコスト)、ネットワーク全体の負荷係数によって決まります。 |
|
| `load_factor` | 数値 | サーバが現在実行中の、負荷スケーリングされたオープンレジャートランザクションコストを、基本トランザクションコストに適用される乗数として示したもの。例えば、負荷係数`1000`でリファレンストランザクションコストが10 dropである場合、負荷スケーリングされたトランザクションコストは10,000 drop（0.01 XRP）です。負荷係数は、[個々のサーバの負荷係数](transaction-cost.html#ローカル負荷コスト)の最高値、クラスターの負荷係数、[オープンレジャーコスト](transaction-cost.html#オープンレジャーコスト)、ネットワーク全体の負荷係数によって決まります。 |
|
||||||
| `clio_version` | 文字列 | 実行中のClioサーバのバージョン番号。 |
|
| `clio_version` | 文字列 | 実行中のClioサーバのバージョン番号。 |
|
||||||
| `libxrpl_version` | 文字列 | このClioサーバがビルドされた`libxrpl`ライブラリのバージョン番号。[新規: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0.0 "BADGE_BLUE") |
|
| `libxrpl_version` | 文字列 | このClioサーバがビルドされた`libxrpl`ライブラリのバージョン番号。[新規: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0.0 "BADGE_BLUE") |
|
||||||
| `validation_quorum` | 数値 | _(省略される場合があります)_ レジャーバージョンを検証するために必要な、信頼できる検証の最小数。状況によっては、サーバがより多くの検証を要求することもあります。この値は`rippled`から取得します。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。 |
|
| `validation_quorum` | 数値 | _(省略される場合があります)_ レジャーバージョンを検証するために必要な、信頼できる検証の最小数。状況によっては、サーバがより多くの検証をリクエストすることもあります。この値は`rippled`から取得します。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。 |
|
||||||
| `rippled_version` | 文字列 | _(省略される場合があります)_ Clioサーバが接続している`rippled`サーバのバージョン番号。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。 |
|
| `rippled_version` | 文字列 | _(省略される場合があります)_ Clioサーバが接続している`rippled`サーバのバージョン番号。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。 |
|
||||||
| `network_id` | 文字列 | _(省略される場合があります)_ このClioサーバが接続している`rippled`が動作しているネットワークのネットワークID。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。[新規: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0.0 "BADGE_BLUE") |
|
| `network_id` | 文字列 | _(省略される場合があります)_ このClioサーバが接続している`rippled`が動作しているネットワークのネットワークID。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。[新規: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0.0 "BADGE_BLUE") |
|
||||||
| `validated_ledger` | オブジェクト | _(省略される場合があります)_ 完全に検証された最新のレジャーに関する情報。検証済みの最新のレジャーがない場合、レスポンスではこのフィールドは省略され、代わりに`closed_ledger`が含まれます。 |
|
| `validated_ledger` | オブジェクト | _(省略される場合があります)_ 完全に検証された最新のレジャーに関する情報。検証済みの最新のレジャーがない場合、レスポンスではこのフィールドは省略され、代わりに`closed_ledger`が含まれます。 |
|
||||||
@@ -600,7 +600,7 @@ labels:
|
|||||||
| `validated_ledger.reserve_base_xrp` | 数値 | すべてのアカウントで準備金として保有しておく必要があるXRPの最少額（drop数ではありません） |
|
| `validated_ledger.reserve_base_xrp` | 数値 | すべてのアカウントで準備金として保有しておく必要があるXRPの最少額（drop数ではありません） |
|
||||||
| `validated_ledger.reserve_inc_xrp` | 数値 | アカウントがレジャー内に保有するオブジェクトごとのアカウント準備金に追加するXRP額（drop数ではありません） |
|
| `validated_ledger.reserve_inc_xrp` | 数値 | アカウントがレジャー内に保有するオブジェクトごとのアカウント準備金に追加するXRP額（drop数ではありません） |
|
||||||
| `validated_ledger.seq` | 数値 | 最新の検証済みレジャーのレジャーインデックス |
|
| `validated_ledger.seq` | 数値 | 最新の検証済みレジャーのレジャーインデックス |
|
||||||
| `validation_quorum` | 数値 | レジャーバージョンの検証に、最低限必要となる信頼できる検証の数。場合によっては、サーバがさらに検証を要求する場合があります。 |
|
| `validation_quorum` | 数値 | レジャーバージョンの検証に、最低限必要となる信頼できる検証の数。場合によっては、サーバがさらに検証をリクエストする場合があります。 |
|
||||||
| `validator_list_expires` | 文字列 | _（管理者のみ）_ 現在のバリデータリストの有効期限が切れるタイミングを人間が読み取れる時間でを表示、または、サーバが発行済みのバリデータリストをロードしていない場合は文字列`unknown`、サーバが静的なバリデータリストを使用する場合は文字列`never`のいずれかを表示します。 |
|
| `validator_list_expires` | 文字列 | _（管理者のみ）_ 現在のバリデータリストの有効期限が切れるタイミングを人間が読み取れる時間でを表示、または、サーバが発行済みのバリデータリストをロードしていない場合は文字列`unknown`、サーバが静的なバリデータリストを使用する場合は文字列`never`のいずれかを表示します。 |
|
||||||
| `cache` | オブジェクト | Clioの状態データのキャッシュに関する情報。 |
|
| `cache` | オブジェクト | Clioの状態データのキャッシュに関する情報。 |
|
||||||
| `cache.size` | 数値 | 現在キャッシュ内にある状態データオブジェクトの数。 |
|
| `cache.size` | 数値 | 現在キャッシュ内にある状態データオブジェクトの数。 |
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ label:
|
|||||||
|
|
||||||
公開レジャーに関する情報を取得します。
|
公開レジャーに関する情報を取得します。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -57,24 +57,24 @@ rippled ledger current
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#ledger)
|
[試してみる >](websocket-api-tool.html#ledger)
|
||||||
|
|
||||||
要求には以下のパラメーターを含めることができます。
|
リクエストには以下のパラメーターを含めることができます。
|
||||||
|
|
||||||
| `Field` | 型 | 必須? | 説明 |
|
| `Field` | 型 | 必須? | 説明 |
|
||||||
|:---------------|:---------------------|:------|:-------------------------------|
|
|:---------------|:---------------------|:------|:-------------------------------|
|
||||||
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンの20バイトの16進文字列。([レジャーの指定][]ご覧ください。) |
|
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンの20バイトの16進文字列。([レジャーの指定][]ご覧ください。) |
|
||||||
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください) |
|
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください) |
|
||||||
| `transactions` | 真偽値 | いいえ | `true`の場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトでは`false`です。レジャーバージョンを指定しない場合は無視されます。 |
|
| `transactions` | 真偽値 | いいえ | `true`の場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトでは`false`です。レジャーバージョンを指定しない場合は無視されます。 |
|
||||||
| `expand` | 真偽値 | いいえ | ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方を要求しない場合は無視されます。 |
|
| `expand` | 真偽値 | いいえ | ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方をリクエストしない場合は無視されます。 |
|
||||||
| `owner_funds` | 真偽値 | いいえ | `true`の場合、応答のOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
|
| `owner_funds` | 真偽値 | いいえ | `true`の場合、レスポンスのOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
|
||||||
| `binary` | 真偽値 | いいえ | `true`で、かつ`transactions`と`expand`が両方とも`true`の場合、JSONフォーマットではなくバイナリフォーマット（16進文字列）でトランザクション情報が返されます。 |
|
| `binary` | 真偽値 | いいえ | `true`で、かつ`transactions`と`expand`が両方とも`true`の場合、JSONフォーマットではなくバイナリフォーマット（16進文字列）でトランザクション情報が返されます。 |
|
||||||
| `queue` | 真偽値 | いいえ | `true`で、かつコマンドが`current`レジャーを要求している場合、[キューに入れらているトランザクション](transaction-cost.html#キューに入れられたトランザクション)の配列が結果に含まれます。
|
| `queue` | 真偽値 | いいえ | `true`で、かつコマンドが`current`レジャーをリクエストしている場合、[キューに入れらているトランザクション](transaction-cost.html#キューに入れられたトランザクション)の配列が結果に含まれます。
|
||||||
|
|
||||||
|
|
||||||
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。`full`、`accounts`、`type`フィールド(管理者専用)も非推奨です。
|
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。`full`、`accounts`、`type`フィールド(管理者専用)も非推奨です。
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -103,7 +103,7 @@ Loading: "/etc/opt/ripple/rippled.cfg"
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果にレジャーに関する情報を表す次のフィールドが含まれています。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果にレジャーに関する情報を表す次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------------------------|:------------|:--------------------------|
|
|:-------------------------------|:------------|:--------------------------|
|
||||||
@@ -121,12 +121,12 @@ Loading: "/etc/opt/ripple/rippled.cfg"
|
|||||||
| `ledger.parent_hash` | 文字列 | このレジャーの直前のレジャーの一意の識別用ハッシュ。 |
|
| `ledger.parent_hash` | 文字列 | このレジャーの直前のレジャーの一意の識別用ハッシュ。 |
|
||||||
| `ledger.total_coins` | 文字列 | ネットワークのXRPの合計（drop数）。整数を引用符で囲んだ形式で示されます。（トランザクションコストによりXRPが焼却されると、この値は減少します。） |
|
| `ledger.total_coins` | 文字列 | ネットワークのXRPの合計（drop数）。整数を引用符で囲んだ形式で示されます。（トランザクションコストによりXRPが焼却されると、この値は減少します。） |
|
||||||
| `ledger.transaction_hash` | 文字列 | このレジャーに記録されているトランザクション情報のハッシュ（16進数） |
|
| `ledger.transaction_hash` | 文字列 | このレジャーに記録されているトランザクション情報のハッシュ（16進数） |
|
||||||
| `ledger.transactions` | 配列 | （要求されていない場合は省略）このレジャーバージョンで適用されたトランザクション。デフォルトでは、メンバーはトランザクションの識別用[ハッシュ][]文字列です。要求で`expand`がtrueとして指定されている場合は、メンバーはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現です。フォーマットは、要求で`binary`がtrueとして指定されていたかどうかに応じて決まります。 |
|
| `ledger.transactions` | 配列 | （リクエストされていない場合は省略）このレジャーバージョンで適用されたトランザクション。デフォルトでは、メンバーはトランザクションの識別用[ハッシュ][]文字列です。リクエストで`expand`がtrueとして指定されている場合は、メンバーはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現です。フォーマットは、リクエストで`binary`がtrueとして指定されていたかどうかに応じて決まります。 |
|
||||||
| `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
|
| `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
|
||||||
| `ledger_index` | 数値 | このレジャーの[レジャーインデックス][]。 |
|
| `ledger_index` | 数値 | このレジャーの[レジャーインデックス][]。 |
|
||||||
| `queue_data` | 配列 | （`queue`パラメーターで要求されている場合を除いて省略）キューに入れられたトランザクションをキューと同じ順序で記述するオブジェクトの配列。要求で`expand`がtrueに指定されている場合は、メンバーにはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現が含まれています。フォーマットは、要求で`binary`がtrueとして指定されていたかどうかによって決まります。 |
|
| `queue_data` | 配列 | （`queue`パラメーターでリクエストされている場合を除いて省略）キューに入れられたトランザクションをキューと同じ順序で記述するオブジェクトの配列。リクエストで`expand`がtrueに指定されている場合は、メンバーにはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現が含まれています。フォーマットは、リクエストで`binary`がtrueとして指定されていたかどうかによって決まります。 |
|
||||||
|
|
||||||
`ledger.accountState`フィールド（`"full": true`または`"accounts": true`で要求されない限り省略）は廃止予定です。
|
`ledger.accountState`フィールド（`"full": true`または`"accounts": true`でリクエストされない限り省略）は廃止予定です。
|
||||||
|
|
||||||
次のフィールドは廃止予定であり、今後予告なしに削除される可能性があります。`accepted`、`hash`（代わりに`ledger_hash`を使用）、`seqNum`（代わりに`ledger_index`を使用）、`totalCoins`（代わりに`total_coins`を使用）。[更新: rippled 1.12.0][]
|
次のフィールドは廃止予定であり、今後予告なしに削除される可能性があります。`accepted`、`hash`（代わりに`ledger_hash`を使用）、`seqNum`（代わりに`ledger_index`を使用）、`totalCoins`（代わりに`total_coins`を使用）。[更新: rippled 1.12.0][]
|
||||||
|
|
||||||
@@ -144,7 +144,7 @@ Loading: "/etc/opt/ripple/rippled.cfg"
|
|||||||
| `fee_level` | 文字列 | _（省略される場合があります）_ このタイプのトランザクションの最少コストと比較した、このトランザクションのトランザクションコスト（[手数料レベル][]）。 |
|
| `fee_level` | 文字列 | _（省略される場合があります）_ このタイプのトランザクションの最少コストと比較した、このトランザクションのトランザクションコスト（[手数料レベル][]）。 |
|
||||||
| `max_spend_drops` | 文字列 | _（省略される場合があります）_ このトランザクションで送信または消却できる[XRP、drop単位][]の最高額。 |
|
| `max_spend_drops` | 文字列 | _（省略される場合があります）_ このトランザクションで送信または消却できる[XRP、drop単位][]の最高額。 |
|
||||||
|
|
||||||
要求に`"owner_funds": true`が指定されておりトランザクションが展開されている場合、応答には、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](offers.html#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](subscribe.html#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
|
リクエストに`"owner_funds": true`が指定されておりトランザクションが展開されている場合、レスポンスには、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](offers.html#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](subscribe.html#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
|
||||||
|
|
||||||
| `Field` | 値 | 説明 |
|
| `Field` | 値 | 説明 |
|
||||||
|:--------------|:-------|:----------------------------------------------------|
|
|:--------------|:-------|:----------------------------------------------------|
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ label:
|
|||||||
|
|
||||||
`ledger_closed`メソッドは、最新の決済済みレジャーの一意のIDを返します。（このレジャーは必ずしも検証済みで変更不可能ではありません。）
|
`ledger_closed`メソッドは、最新の決済済みレジャーの一意のIDを返します。（このレジャーは必ずしも検証済みで変更不可能ではありません。）
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -48,8 +48,8 @@ rippled ledger_closed
|
|||||||
|
|
||||||
このメソッドはパラメーターを受け入れません。
|
このメソッドはパラメーターを受け入れません。
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -83,7 +83,7 @@ rippled ledger_closed
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:-----------------|:-----------------------------------------|
|
|:---------------|:-----------------|:-----------------------------------------|
|
||||||
|
|||||||
@@ -10,9 +10,9 @@ label:
|
|||||||
|
|
||||||
`ledger_current`メソッドは、現在進行中のレジャーの一意のIDを返します。このコマンドで返されるレジャーは確定されたものではないため、このコマンドは主にテストに有用です。
|
`ledger_current`メソッドは、現在進行中のレジャーの一意のIDを返します。このコマンドで返されるレジャーは確定されたものではないため、このコマンドは主にテストに有用です。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
|
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -47,11 +47,11 @@ rippled ledger_current
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#ledger_current)
|
[試してみる >](websocket-api-tool.html#ledger_current)
|
||||||
|
|
||||||
この要求にはパラメーターは含まれていません。
|
このリクエストにはパラメーターは含まれていません。
|
||||||
|
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -83,7 +83,7 @@ rippled ledger_current
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:-----------------|:-------------------------------|
|
|:-----------------------|:-----------------|:-------------------------------|
|
||||||
|
|||||||
@@ -11,8 +11,8 @@ label:
|
|||||||
|
|
||||||
`ledger_data`メソッドは指定されたレジャーの内容を取得します。1つのレジャーバージョンの内容全体を取得するため、複数のコールを繰り返し実行できます。
|
`ledger_data`メソッドは指定されたレジャーの内容を取得します。1つのレジャーバージョンの内容全体を取得するため、複数のコールを繰り返し実行できます。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -47,22 +47,22 @@ label:
|
|||||||
|
|
||||||
**注記:**`ledger_data`のコマンドライン構文はありません。代わりに[jsonメソッド][]を使用してコマンドラインからこのメソッドにアクセスできます。
|
**注記:**`ledger_data`のコマンドライン構文はありません。代わりに[jsonメソッド][]を使用してコマンドラインからこのメソッドにアクセスできます。
|
||||||
|
|
||||||
要求には以下のフィールドが含まれます。
|
リクエストには以下のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:-------------------------------------------|:---------------|
|
|:---------------|:-------------------------------------------|:---------------|
|
||||||
| `id` | （任意） | （WebSocketのみ）応答が遅延して順不同になる場合にこの要求を他の要求と区別するためのID。 |
|
| `id` | （任意） | （WebSocketのみ）レスポンスが遅延して順不同になる場合にこのリクエストを他のリクエストと区別するためのID。 |
|
||||||
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
||||||
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
||||||
| `binary` | ブール値 | （省略可、デフォルトではfalseです）trueに設定すると、レジャーオブジェクトがJSONではなくハッシュされた16進文字列として返されます。 |
|
| `binary` | ブール値 | （省略可、デフォルトではfalseです）trueに設定すると、レジャーオブジェクトがJSONではなくハッシュされた16進文字列として返されます。 |
|
||||||
| `limit` | 整数 | （省略可、デフォルト値は可変）取得するレジャーオブジェクトの数を制限します。サーバーはこの値に従う必要はありません。 |
|
| `limit` | 整数 | （省略可、デフォルト値は可変）取得するレジャーオブジェクトの数を制限します。サーバーはこの値に従う必要はありません。 |
|
||||||
| `marker` | [マーカー][] | 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
|
| `marker` | [マーカー][] | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
|
||||||
|
|
||||||
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。
|
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -241,20 +241,20 @@ label:
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:-------------------------------------------|:---------------|
|
|:---------------|:-------------------------------------------|:---------------|
|
||||||
| `ledger_index` | 符号なし整数 | このレジャーのシーケンス番号 |
|
| `ledger_index` | 符号なし整数 | このレジャーのシーケンス番号 |
|
||||||
| `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
|
| `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
|
||||||
| `state` | 配列 | ツリーのデータが含まれているJSONオブジェクトの配列。以下のように定義されています。 |
|
| `state` | 配列 | ツリーのデータが含まれているJSONオブジェクトの配列。以下のように定義されています。 |
|
||||||
| `marker` | [マーカー][] | 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
|
| `marker` | [マーカー][] | レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。 |
|
||||||
|
|
||||||
`state`配列の各オブジェクトのフォーマットは、要求で`binary`がtrueに設定されているかどうかによって異なります。各`state`オブジェクトには以下のフィールドが含まれます。
|
`state`配列の各オブジェクトのフォーマットは、リクエストで`binary`がtrueに設定されているかどうかによって異なります。各`state`オブジェクトには以下のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:--------------------|:----------|:-------------------------------------------|
|
|:--------------------|:----------|:-------------------------------------------|
|
||||||
| `data` | 文字列 | （`"binary":true`の場合にのみ含まれる）要求されたデータの16進表現。 |
|
| `data` | 文字列 | （`"binary":true`の場合にのみ含まれる）リクエストされたデータの16進表現。 |
|
||||||
| `LedgerEntryType` | 文字列 | （`"binary":false`の場合にのみ含まれる）このオブジェクトが表すレジャーオブジェクトの型を示す文字列。詳細なリストについては[レジャーデータフォーマット](ledger-data-formats.html)を参照してください。 |
|
| `LedgerEntryType` | 文字列 | （`"binary":false`の場合にのみ含まれる）このオブジェクトが表すレジャーオブジェクトの型を示す文字列。詳細なリストについては[レジャーデータフォーマット](ledger-data-formats.html)を参照してください。 |
|
||||||
| （追加のフィールド） | （各種） | （`"binary":false`の場合にのみ含まれる）このオブジェクトを記述する追加フィールド。オブジェクトのLedgerEntryTypeに応じて異なります。 |
|
| （追加のフィールド） | （各種） | （`"binary":false`の場合にのみ含まれる）このオブジェクトを記述する追加フィールド。オブジェクトのLedgerEntryTypeに応じて異なります。 |
|
||||||
| `index` | 文字列 | このレジャーエントリの一意のID（16進数） |
|
| `index` | 文字列 | このレジャーエントリの一意のID（16進数） |
|
||||||
|
|||||||
@@ -11,9 +11,9 @@ label:
|
|||||||
|
|
||||||
`ledger_entry`メソッドは、XRP Ledgerの1つのレジャーオブジェクトを生フォーマットで返します。取得可能な各種オブジェクトについては、[レジャーフォーマット][]をご覧ください。
|
`ledger_entry`メソッドは、XRP Ledgerの1つのレジャーオブジェクトを生フォーマットで返します。取得可能な各種オブジェクトについては、[レジャーフォーマット][]をご覧ください。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
|
|
||||||
このメソッドは複数の異なる種類のデータを取得することができます。以下に記載されている一般的なフィールドと特定のタイプのフィールドで構成される適切なパラメータを渡し、標準の[リクエストフォーマット](request-formatting.html)に従うことで、取得するアイテムの種類を選択できます。(例えば、WebSocketリクエストは常に`command`フィールドとオプションで`id`フィールドを持ち、JSON-RPCリクエストは`method`フィールドと`params`フィールドを使います)。
|
このメソッドは複数の異なる種類のデータを取得することができます。以下に記載されている一般的なフィールドと特定のタイプのフィールドで構成される適切なパラメータを渡し、標準の[リクエストのフォーマット](request-formatting.html)に従うことで、取得するアイテムの種類を選択できます。(例えば、WebSocketリクエストは常に`command`フィールドとオプションで`id`フィールドを持ち、JSON-RPCリクエストは`method`フィールドと`params`フィールドを使います)。
|
||||||
|
|
||||||
{% include '_snippets/no-cli-syntax.ja.md' %}
|
{% include '_snippets/no-cli-syntax.ja.md' %}
|
||||||
|
|
||||||
@@ -21,7 +21,7 @@ label:
|
|||||||
|
|
||||||
| フィールド | 型 | 説明 |
|
| フィールド | 型 | 説明 |
|
||||||
|:------------------------|:-----------------------|:----------------------|
|
|:------------------------|:-----------------------|:----------------------|
|
||||||
| `binary` | ブール値 | _（省略可）_ `true`の場合、要求したレジャーオブジェクトの内容がXRP Ledgerの[バイナリ形式](serialization.html)の16進数の文字列として返されます。それ以外の場合はデータがJSONフォーマットで返されます。デフォルトは`false`です。[更新: rippled 1.2.0][] |
|
| `binary` | ブール値 | _（省略可）_ `true`の場合、リクエストしたレジャーオブジェクトの内容がXRP Ledgerの[バイナリ形式](serialization.html)の16進数の文字列として返されます。それ以外の場合はデータがJSONフォーマットで返されます。デフォルトは`false`です。[更新: rippled 1.2.0][] |
|
||||||
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進数の文字列。（[レジャーの指定][]をご覧ください。 |
|
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進数の文字列。（[レジャーの指定][]をご覧ください。 |
|
||||||
| `ledger_index` | 文字列 または 符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列("validated"や"closed"、"current"など)。（[レジャーの指定][]をご覧ください。 |
|
| `ledger_index` | 文字列 または 符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列("validated"や"closed"、"current"など)。（[レジャーの指定][]をご覧ください。 |
|
||||||
|
|
||||||
@@ -671,7 +671,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#ledger_entry-nft-page)
|
[試してみる >](websocket-api-tool.html#ledger_entry-nft-page)
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
レスポンスは[標準フォーマット][]に従って、成功結果には以下のフィールドが含まれます。
|
レスポンスは[標準フォーマット][]に従って、成功結果には以下のフィールドが含まれます。
|
||||||
|
|
||||||
@@ -789,15 +789,15 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
|
|||||||
## 考えられるエラー
|
## 考えられるエラー
|
||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `deprecatedFeature` - 削除されたフィールド（`generator`など）が要求に指定されていました。
|
* `deprecatedFeature` - 削除されたフィールド（`generator`など）がリクエストに指定されていました。
|
||||||
* `entryNotFound` - 要求されたレジャーオブジェクトはレジャーに存在しません。
|
* `entryNotFound` - リクエストされたレジャーオブジェクトはレジャーに存在しません。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
* `malformedAddress` - 要求の[アドレス][]フィールドが誤って指定されています。
|
* `malformedAddress` - リクエストの[アドレス][]フィールドが誤って指定されています。
|
||||||
* `malformedCurrency` - 要求の[通貨コード][]フィールドが誤って指定されています。
|
* `malformedCurrency` - リクエストの[通貨コード][]フィールドが誤って指定されています。
|
||||||
* `malformedOwner` - 要求の`escrow.owner`サブフィールドが誤って指定されています。
|
* `malformedOwner` - リクエストの`escrow.owner`サブフィールドが誤って指定されています。
|
||||||
* `malformedRequest` - 要求にフィールドが無効な組み合わせで指定されているか、1つ以上のフィールドの型が誤っています。
|
* `malformedRequest` - リクエストにフィールドが無効な組み合わせで指定されているか、1つ以上のフィールドの型が誤っています。
|
||||||
* `unknownOption` - 要求に指定されたフィールドが、予期される要求フォーマットのいずれにも一致していません。
|
* `unknownOption` - リクエストに指定されたフィールドが、予期されるリクエストのフォーマットのいずれにも一致していません。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -9,10 +9,10 @@ labels:
|
|||||||
# book_offers
|
# book_offers
|
||||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/BookOffers.cpp "Source")
|
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/BookOffers.cpp "Source")
|
||||||
|
|
||||||
`book_offers`メソッドは、[オーダーブック](http://www.investopedia.com/terms/o/order-book.asp)と呼ばれる、2つの通貨間のオファーのリストを取得します。結果が非常に大きい場合、結果の一部がマーカー付きで返されます。これにより、その後の要求は前回の要求で終わった箇所から再開できます。
|
`book_offers`メソッドは、[オーダーブック](http://www.investopedia.com/terms/o/order-book.asp)と呼ばれる、2つの通貨間のオファーのリストを取得します。結果が非常に大きい場合、結果の一部がマーカー付きで返されます。これにより、その後のリクエストは前回のリクエストで終わった箇所から再開できます。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -66,21 +66,21 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#book_offers)
|
[試してみる >](websocket-api-tool.html#book_offers)
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------------|:-------------------------------------------|:-------------------------------|
|
|:---------------|:-------------------------------------------|:-------------------------------|
|
||||||
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
||||||
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
||||||
| `limit` | 符号なし整数 | _（省略可）_ 指定されている場合、サーバーはこの制限を超える数のオファーを結果に含めません。資金供給のないオファーはサーバーにより省略されるため、返される結果の総数はこの制限よりも少ないことがあります。 |
|
| `limit` | 符号なし整数 | _（省略可）_ 指定されている場合、サーバーはこの制限を超える数のオファーを結果に含めません。資金供給のないオファーはサーバーにより省略されるため、返される結果の総数はこの制限よりも少ないことがあります。 |
|
||||||
| `marker` | [マーカー][] | _（省略可）_ 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。 |
|
| `marker` | [マーカー][] | _（省略可）_ 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
|
||||||
| `taker` | 文字列 | _（省略可）_ パースペクティブとして使用するアカウントの[アドレス][]。このアカウントが発行した[資金供給のないオファー](offers.html#オファーのライフサイクル)は常に応答に含まれます。（これを使用して、キャンセルしたい各自のオーダーを検索できます。） |
|
| `taker` | 文字列 | _（省略可）_ パースペクティブとして使用するアカウントの[アドレス][]。このアカウントが発行した[資金供給のないオファー](offers.html#オファーのライフサイクル)は常にレスポンスに含まれます。（これを使用して、キャンセルしたい各自のオーダーを検索できます。） |
|
||||||
| `taker_gets` | オブジェクト | オファーを受諾するアカウントが受け取る通貨を、[通貨額][通貨額]と同様に、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定します（XRPの場合はissuerを省略）。 |
|
| `taker_gets` | オブジェクト | オファーを受諾するアカウントが受け取る通貨を、[通貨額][通貨額]と同様に、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定します（XRPの場合はissuerを省略）。 |
|
||||||
| `taker_pays` | オブジェクト | オファーを受諾するアカウントが支払う通貨を、[通貨額][通貨額]と同様に、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定します（XRPの場合はissuerを省略）。 |
|
| `taker_pays` | オブジェクト | オファーを受諾するアカウントが支払う通貨を、[通貨額][通貨額]と同様に、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定します（XRPの場合はissuerを省略）。 |
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -162,14 +162,14 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:--------------------------|:------------------------|
|
|:-----------------------|:--------------------------|:------------------------|
|
||||||
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略）_ この情報の取得時に使用した、現在処理中のレジャーバージョンの[レジャーインデックス][]。 |
|
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略）_ この情報の取得時に使用した、現在処理中のレジャーバージョンの[レジャーインデックス][]。 |
|
||||||
| `ledger_index` | 数値 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略可）_ 要求に従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
|
| `ledger_index` | 数値 - [レジャーインデックス][] | _（`ledger_current_index`が指定されている場合は省略可）_ リクエストに従って、このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
|
||||||
| `ledger_hash` | 文字列 - [ハッシュ][] | _（省略される場合があります）_ 要求に従って、このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
|
| `ledger_hash` | 文字列 - [ハッシュ][] | _（省略される場合があります）_ リクエストに従って、このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
|
||||||
| `marker` | [マーカー][] | _（省略される場合があります）_ 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
|
| `marker` | [マーカー][] | _（省略される場合があります）_ レスポンスがページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
|
||||||
| `offers` | 配列 | Offerオブジェクトの配列。各オブジェクトには[Offer オブジェクト](offer.html)のフィールドが含まれています。 |
|
| `offers` | 配列 | Offerオブジェクトの配列。各オブジェクトには[Offer オブジェクト](offer.html)のフィールドが含まれています。 |
|
||||||
|
|
||||||
`offers`配列の要素には、Offerの標準フィールドの他に以下のフィールドが含まれます。
|
`offers`配列の要素には、Offerの標準フィールドの他に以下のフィールドが含まれます。
|
||||||
@@ -186,10 +186,10 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
|
|||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
* `srcCurMalformed` - 要求の`taker_pays`フィールドのフォーマットが適切ではありません。
|
* `srcCurMalformed` - リクエストの`taker_pays`フィールドのフォーマットが適切ではありません。
|
||||||
* `dstAmtMalformed` - 要求の`taker_gets`フィールドのフォーマットが適切ではありません。
|
* `dstAmtMalformed` - リクエストの`taker_gets`フィールドのフォーマットが適切ではありません。
|
||||||
* `srcIsrMalformed` - 要求の`taker_pays`フィールドの`issuer`フィールドが無効です。
|
* `srcIsrMalformed` - リクエストの`taker_pays`フィールドの`issuer`フィールドが無効です。
|
||||||
* `dstIsrMalformed` - 要求の`taker_gets`フィールドの`issuer`フィールドが無効です。
|
* `dstIsrMalformed` - リクエストの`taker_gets`フィールドの`issuer`フィールドが無効です。
|
||||||
* `badMarket` - 必要なオーダーブックが存在していません（ある通貨をその通貨自体と交換するオファーなど）。
|
* `badMarket` - 必要なオーダーブックが存在していません（ある通貨をその通貨自体と交換するオファーなど）。
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -11,8 +11,8 @@ labels:
|
|||||||
|
|
||||||
`deposit_authorized`コマンドは、あるアカウントに別のアカウントへ支払を直接送金する権限があるかどうかを示します。アカウントへの送金に承認を義務付ける方法については、[Deposit Authorization](depositauth.html)を参照してください。
|
`deposit_authorized`コマンドは、あるアカウントに別のアカウントへ支払を直接送金する権限があるかどうかを示します。アカウントへの送金に承認を義務付ける方法については、[Deposit Authorization](depositauth.html)を参照してください。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ rippled deposit_authorized rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de rsUiUMpnrgxQp24dJY
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------------------|:---------------------------|:------------------------|
|
|:----------------------|:---------------------------|:------------------------|
|
||||||
@@ -62,9 +62,9 @@ rippled deposit_authorized rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de rsUiUMpnrgxQp24dJY
|
|||||||
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
||||||
|
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -123,16 +123,16 @@ Loading: "/etc/rippled.cfg"
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-----------------------|:--------------------------|:------------------------|
|
|:-----------------------|:--------------------------|:------------------------|
|
||||||
| `deposit_authorized` | ブール値 | 指定の支払元アカウントから支払先アカウントへの直接送金が承認されているかどうか。`true`の場合、支払先アカウントで[Deposit Authorization](depositauth.html)を必要としていないか、または支払元アカウントが事前承認されています。 |
|
| `deposit_authorized` | ブール値 | 指定の支払元アカウントから支払先アカウントへの直接送金が承認されているかどうか。`true`の場合、支払先アカウントで[Deposit Authorization](depositauth.html)を必要としていないか、または支払元アカウントが事前承認されています。 |
|
||||||
| `destination_account` | 文字列 - [アドレス][] | 要求に指定されている宛先アカウント。 |
|
| `destination_account` | 文字列 - [アドレス][] | リクエストに指定されている宛先アカウント。 |
|
||||||
| `ledger_hash` | 文字列 | _（省略される場合があります）_ この応答の生成に使用されたレジャーの識別用ハッシュ。 |
|
| `ledger_hash` | 文字列 | _（省略される場合があります）_ このレスポンスの生成に使用されたレジャーの識別用ハッシュ。 |
|
||||||
| `ledger_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ この応答の生成に使用されたレジャーバージョンのレジャーインデックス。 |
|
| `ledger_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 |
|
||||||
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ この応答の生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
|
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ このレスポンスの生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
|
||||||
| `source_account` | 文字列 - [アドレス][] | 要求に指定されている支払元アカウント。 |
|
| `source_account` | 文字列 - [アドレス][] | リクエストに指定されている支払元アカウント。 |
|
||||||
| `validated` | ブール値 | _（省略される場合があります）_`true`の場合、検証済みレジャーバージョンからの情報が取り込まれます。 |
|
| `validated` | ブール値 | _（省略される場合があります）_`true`の場合、検証済みレジャーバージョンからの情報が取り込まれます。 |
|
||||||
|
|
||||||
**注記:** `deposit_authorized`ステータスが`true`でも、指定の支払元から指定の支払先への送金が可能であるとは保証されません。たとえば、支払先アカウントに指定通貨の[トラストライン](trust-lines-and-issuing.html)がない場合や、送金に十分な流動性がない場合があります。
|
**注記:** `deposit_authorized`ステータスが`true`でも、指定の支払元から指定の支払先への送金が可能であるとは保証されません。たとえば、支払先アカウントに指定通貨の[トラストライン](trust-lines-and-issuing.html)がない場合や、送金に十分な流動性がない場合があります。
|
||||||
@@ -141,10 +141,10 @@ Loading: "/etc/rippled.cfg"
|
|||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `actMalformed` - 要求の`source_account`フィールドまたは`destination_account`フィールドに指定されている[アドレス][]のフォーマットが適切ではありません。（入力ミスが含まれていたり、長さが正しくない場合は、チェックサムは失敗します。）
|
* `actMalformed` - リクエストの`source_account`フィールドまたは`destination_account`フィールドに指定されている[アドレス][]のフォーマットが適切ではありません。（入力ミスが含まれていたり、長さが正しくない場合は、チェックサムは失敗します。）
|
||||||
* `dstActNotFound` - 要求の`destination_account`フィールドがレジャーのアカウントに対応していません。
|
* `dstActNotFound` - リクエストの`destination_account`フィールドがレジャーのアカウントに対応していません。
|
||||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
|
||||||
* `srcActNotFound` - 要求の`source_account`フィールドがレジャーのアカウントに対応していません。
|
* `srcActNotFound` - リクエストの`source_account`フィールドがレジャーのアカウントに対応していません。
|
||||||
|
|
||||||
|
|
||||||
{% include '_snippets/rippled_versions.md' %}
|
{% include '_snippets/rippled_versions.md' %}
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ labels:
|
|||||||
_([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
_([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
||||||
|
|
||||||
## リクエストのフォーマット
|
## リクエストのフォーマット
|
||||||
リクエストフォーマットの例：
|
リクエストのフォーマットの例：
|
||||||
|
|
||||||
{% include '_snippets/no-cli-syntax.ja.md' %}
|
{% include '_snippets/no-cli-syntax.ja.md' %}
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ labels:
|
|||||||
_([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
_([NonFungibleTokensV1_1 amendment][]により追加されました。)_
|
||||||
|
|
||||||
## リクエストのフォーマット
|
## リクエストのフォーマット
|
||||||
リクエストフォーマットの例：
|
リクエストのフォーマットの例：
|
||||||
|
|
||||||
{% include '_snippets/no-cli-syntax.ja.md' %}
|
{% include '_snippets/no-cli-syntax.ja.md' %}
|
||||||
|
|
||||||
|
|||||||
@@ -15,19 +15,19 @@ path_findコマンドには3種類のモード（サブコマンド）があり
|
|||||||
|
|
||||||
* `create` - Pathfinding情報の送信を開始します
|
* `create` - Pathfinding情報の送信を開始します
|
||||||
* `close` - Pathfinding情報の送信を停止します
|
* `close` - Pathfinding情報の送信を停止します
|
||||||
* `status` - 現在処理中のPathfinding要求に関する情報を取得します
|
* `status` - 現在処理中のPathfindingリクエストに関する情報を取得します
|
||||||
|
|
||||||
`rippled`サーバーは支払いを行うにあたり最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。サーバーの負荷が原因で、Pathfindingで最良のパスを検出できないことがあります。また、信頼できないサーバーからのPathfindingの結果には注意する必要があります。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。（**注記:** サーバーから最良ではない結果が返されても、必ずしも悪意のある振る舞いの証拠とはなりません。サーバーの負荷が高い場合の症状である可能性もあります。）
|
`rippled`サーバーは支払いを行うにあたり最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。サーバーの負荷が原因で、Pathfindingで最良のパスを検出できないことがあります。また、信頼できないサーバーからのPathfindingの結果には注意する必要があります。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。（**注記:** サーバーから最良ではない結果が返されても、必ずしも悪意のある振る舞いの証拠とはなりません。サーバーの負荷が高い場合の症状である可能性もあります。）
|
||||||
|
|
||||||
## path_find create
|
## path_find create
|
||||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L50-L56 "Source")
|
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L50-L56 "Source")
|
||||||
|
|
||||||
`path_find`の`create`サブコマンドは、指定された特定アカウントから支払トランザクションを実行できるパスを探索する継続的な要求を作成し、別のアカウントが何らかの通貨で希望する額を受領できるようにします。初期応答には2つのアドレス間で提案されるパスが含まれています。このパスにより、希望する額を受領できます。その後サーバーは、`"type": "path_find"`で有効なパスの更新を含む追加メッセージを送信します。更新の頻度はサーバーにより決定されますが、新しいレジャーバージョンがある場合には通常、数秒間に1回です。
|
`path_find`の`create`サブコマンドは、指定された特定アカウントから支払トランザクションを実行できるパスを探索する継続的なリクエストを作成し、別のアカウントが何らかの通貨で希望する額を受領できるようにします。初期レスポンスには2つのアドレス間で提案されるパスが含まれています。このパスにより、希望する額を受領できます。その後サーバーは、`"type": "path_find"`で有効なパスの更新を含む追加メッセージを送信します。更新の頻度はサーバーにより決定されますが、新しいレジャーバージョンがある場合には通常、数秒間に1回です。
|
||||||
|
|
||||||
クライアントは一度に1つのPathfinding要求のみ実行できます。同じ接続ですでに他のPathfinding要求が実行されている場合、古い要求が自動的にクローズされ、新しい要求に置き換えられます。
|
クライアントは一度に1つのPathfindingリクエストのみ実行できます。同じ接続ですでに他のPathfindingリクエストが実行されている場合、古いリクエストが自動的にクローズされ、新しいリクエストに置き換えられます。
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -52,22 +52,22 @@ path_findコマンドには3種類のモード（サブコマンド）があり
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#path_find)
|
[試してみる >](websocket-api-tool.html#path_find)
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------------------|:-----------------|:----------------------------------|
|
|:----------------------|:-----------------|:----------------------------------|
|
||||||
| `subcommand` | 文字列 | `"create"`を使用してcreateサブコマンドを送信します。 |
|
| `subcommand` | 文字列 | `"create"`を使用してcreateサブコマンドを送信します。 |
|
||||||
| `source_account` | 文字列 | 探索するパスの送金元アカウントの一意のアドレス。（つまり、支払いを送金するアカウントです。） |
|
| `source_account` | 文字列 | 探索するパスの送金元アカウントの一意のアドレス。（つまり、支払いを送金するアカウントです。） |
|
||||||
| `destination_account` | 文字列 | 探索するパスの送金先アカウントの一意のアドレス。（つまり、支払いを受領するアカウントです。） |
|
| `destination_account` | 文字列 | 探索するパスの送金先アカウントの一意のアドレス。（つまり、支払いを受領するアカウントです。） |
|
||||||
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:**[新規: rippled 0.30.0][]`value`フィールドには`"-1"`（XRPの場合）または-1（XRP以外の通貨の場合）を指定できます。これにより、最大限の額を送金できるパスが要求されます。ただし`send_max`が指定されている場合は、指定額を上回る額が支払われることはありません。 |
|
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:**[新規: rippled 0.30.0][]`value`フィールドには`"-1"`（XRPの場合）または-1（XRP以外の通貨の場合）を指定できます。これにより、最大限の額を送金できるパスがリクエストされます。ただし`send_max`が指定されている場合は、指定額を上回る額が支払われることはありません。 |
|
||||||
| `send_max` | 文字列またはオブジェクト | _（省略可）_ トランザクションに使用する[通貨額][]。`source_currencies`と同時に指定することはできません。[新規: rippled 0.30.0][] |
|
| `send_max` | 文字列またはオブジェクト | _（省略可）_ トランザクションに使用する[通貨額][]。`source_currencies`と同時に指定することはできません。[新規: rippled 0.30.0][] |
|
||||||
| `paths` | 配列 | _（省略可）_ チェックする[ペイメントパス](paths.html)を表すオブジェクトの配列。すでに判明している特定パスの変更内容を常に把握する場合や、特定パスに沿った支払いにかかる総コストを確認する場合にこのフィールドを使用できます。 |
|
| `paths` | 配列 | _（省略可）_ チェックする[ペイメントパス](paths.html)を表すオブジェクトの配列。すでに判明している特定パスの変更内容を常に把握する場合や、特定パスに沿った支払いにかかる総コストを確認する場合にこのフィールドを使用できます。 |
|
||||||
|
|
||||||
サーバーは`source_currencies`および`bridges`フィールドも認識しますが、これらのフィールドを使用した場合の結果は保証されません。これらのフィールドは将来のために予約されているものと考えてください。
|
サーバーは`source_currencies`および`bridges`フィールドも認識しますが、これらのフィールドを使用した場合の結果は保証されません。これらのフィールドは将来のために予約されているものと考えてください。
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -441,16 +441,16 @@ path_findコマンドには3種類のモード（サブコマンド）があり
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この初期応答は[標準フォーマット](response-formatting.html)に従っており、正常に完了した場合は次のフィールドが含まれています。
|
この初期レスポンスは[標準フォーマット](response-formatting.html)に従っており、正常に完了した場合は次のフィールドが含まれています。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------------------|:-----------------|:----------------------------------|
|
|:----------------------|:-----------------|:----------------------------------|
|
||||||
| `alternatives` | 配列 | 以下に説明する、提案される[パス](paths.html)のオブジェクトの配列。空の場合、送金元アカウントと送金先アカウントを結ぶパスが見つかりませんでした。 |
|
| `alternatives` | 配列 | 以下に説明する、提案される[パス](paths.html)のオブジェクトの配列。空の場合、送金元アカウントと送金先アカウントを結ぶパスが見つかりませんでした。 |
|
||||||
| `destination_account` | 文字列 | トランザクションを受信するアカウントの一意のアドレス。 |
|
| `destination_account` | 文字列 | トランザクションを受信するアカウントの一意のアドレス。 |
|
||||||
| `destination_amount` | 文字列またはオブジェクト | 送金先がトランザクションで受領する[通貨額][]。 |
|
| `destination_amount` | 文字列またはオブジェクト | 送金先がトランザクションで受領する[通貨額][]。 |
|
||||||
| `id` | （各種） | （WebSocketのみ）WebSocket要求に指定されているIDが再びこのレベルで含まれます。 |
|
| `id` | （各種） | （WebSocketのみ）WebSocketリクエストに指定されているIDが再びこのレベルで含まれます。 |
|
||||||
| `source_account` | 文字列 | トランザクションを送信するアカウントの一意のアドレス。 |
|
| `source_account` | 文字列 | トランザクションを送信するアカウントの一意のアドレス。 |
|
||||||
| `full_reply` | ブール値 | `false`の場合、これは不完全な検索の結果です。これ以降の応答に、より適切なパスが含まれている可能性があります。`true`の場合、これは検出された最良のパスです。（理論上、これよりも優れたパスが存在している可能性がありますが`rippled`では検出されません。）Pathfinding要求をクローズするまで、`rippled`は引き続き、新しいレジャーが閉鎖されるたびに更新を送信します。[新規: rippled 0.29.0][] |
|
| `full_reply` | ブール値 | `false`の場合、これは不完全な検索の結果です。これ以降のレスポンスに、より適切なパスが含まれている可能性があります。`true`の場合、これは検出された最良のパスです。（理論上、これよりも優れたパスが存在している可能性がありますが`rippled`では検出されません。）Pathfindingリクエストをクローズするまで、`rippled`は引き続き、新しいレジャーが閉鎖されるたびに更新を送信します。[新規: rippled 0.29.0][] |
|
||||||
|
|
||||||
`alternatives`配列の各要素は、1つの送金元通貨（開始アカウントが保有）から送金先アカウントへのパスと通貨を表すオブジェクトです。このオブジェクトのフィールドを次に示します。
|
`alternatives`配列の各要素は、1つの送金元通貨（開始アカウントが保有）から送金先アカウントへのパスと通貨を表すオブジェクトです。このオブジェクトのフィールドを次に示します。
|
||||||
|
|
||||||
@@ -467,11 +467,11 @@ path_findコマンドには3種類のモード（サブコマンド）があり
|
|||||||
|
|
||||||
### 非同期フォローアップ
|
### 非同期フォローアップ
|
||||||
|
|
||||||
サーバーからは初期応答の他に、時間の経過にともなう[ペイメントパス](paths.html)のステータスを更新するため類似したフォーマットでさらにメッセージが送信されます。これらのメッセージには、元のWebSocket要求の`id`が含まれているので、どの要求からメッセージが送信されたかを確認できます。また、最上位レベルの`"type": "path_find"`フィールドは、追加応答であることを示します。その他のフィールドは、初期応答と同じ方法で定義されます。
|
サーバーからは初期レスポンスの他に、時間の経過にともなう[ペイメントパス](paths.html)のステータスを更新するため類似したフォーマットでさらにメッセージが送信されます。これらのメッセージには、元のWebSocketリクエストの`id`が含まれているので、どのリクエストからメッセージが送信されたかを確認できます。また、最上位レベルの`"type": "path_find"`フィールドは、追加レスポンスであることを示します。その他のフィールドは、初期レスポンスと同じ方法で定義されます。
|
||||||
|
|
||||||
フォローアップに`"full_reply": true`が含まれている場合、これは現行レジャーの時点でrippledが検出できる最良のパスです。
|
フォローアップに`"full_reply": true`が含まれている場合、これは現行レジャーの時点でrippledが検出できる最良のパスです。
|
||||||
|
|
||||||
path_find create要求からの非同期フォローアップの例を次に示します。
|
path_find createリクエストからの非同期フォローアップの例を次に示します。
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -499,10 +499,10 @@ path_find create要求からの非同期フォローアップの例を次に示
|
|||||||
## path_find close
|
## path_find close
|
||||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L58-L67 "Source")
|
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L58-L67 "Source")
|
||||||
|
|
||||||
`path_find`の`close`サブコマンドは、サーバーに対して現在実行中のPathfinding要求に関する情報の送信を停止するように指示します。
|
`path_find`の`close`サブコマンドは、サーバーに対して現在実行中のPathfindingリクエストに関する情報の送信を停止するように指示します。
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -518,36 +518,36 @@ path_find create要求からの非同期フォローアップの例を次に示
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------|:-------|:-------------------------------------------|
|
|:-------------|:-------|:-------------------------------------------|
|
||||||
| `subcommand` | 文字列 | closeサブコマンドを送信するため`"close"`を使用します。 |
|
| `subcommand` | 文字列 | closeサブコマンドを送信するため`"close"`を使用します。 |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
Pathfinding要求が正常にクローズされた場合、応答は[`path_find create`](#path_find-create)に対する初期応答と同じフォーマットであり、されに以下のフィールドが含まれます。
|
Pathfindingリクエストが正常にクローズされた場合、レスポンスは[`path_find create`](#path_find-create)に対する初期レスポンスと同じフォーマットであり、されに以下のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------|:--------|:--------------------------------------------------------|
|
|:---------|:--------|:--------------------------------------------------------|
|
||||||
| `closed` | ブール値 | 値が`true`の場合、これは`path_find close`コマンドに対する応答です。 |
|
| `closed` | ブール値 | 値が`true`の場合、これは`path_find close`コマンドに対するレスポンスです。 |
|
||||||
|
|
||||||
未処理のPathfinding要求がない場合はエラーが返されます。
|
未処理のPathfindingリクエストがない場合はエラーが返されます。
|
||||||
|
|
||||||
### 考えられるエラー
|
### 考えられるエラー
|
||||||
|
|
||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `invalidParams` - フィールドの指定が正しくないか、必須フィールドが指定されていません。
|
* `invalidParams` - フィールドの指定が正しくないか、必須フィールドが指定されていません。
|
||||||
* `noEvents` - 非同期コールバックをサポートしていないプロトコル（JSON-RPCなど）でこのメソッドを使用しようとしました。（JSON-RPCと互換性が_ある_Pathfindingメソッドについては、[ripple_path_findメソッド][]を参照してください。）
|
* `noEvents` - 非同期コールバックをサポートしていないプロトコル（JSON-RPCなど）でこのメソッドを使用しようとしました。（JSON-RPCと互換性が_ある_Pathfindingメソッドについては、[ripple_path_findメソッド][]を参照してください。）
|
||||||
* `noPathRequest` - Pathfinding要求をクローズしようとしましたが、実行中の要求がありませんでした。
|
* `noPathRequest` - Pathfindingリクエストをクローズしようとしましたが、実行中のリクエストがありませんでした。
|
||||||
|
|
||||||
## path_find status
|
## path_find status
|
||||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L69-L77 "Source")
|
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L69-L77 "Source")
|
||||||
|
|
||||||
`path_find`の`status`サブコマンドは、現在実行中のクライアントのPathfinding要求の即時更新を要求します。
|
`path_find`の`status`サブコマンドは、現在実行中のクライアントのPathfindingリクエストの即時更新をリクエストします。
|
||||||
|
|
||||||
### 要求フォーマット
|
### リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -563,28 +563,28 @@ Pathfinding要求が正常にクローズされた場合、応答は[`path_find
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------|:-------|:---------------------------------------------|
|
|:-------------|:-------|:---------------------------------------------|
|
||||||
| `subcommand` | 文字列 | `"status"`を使用して、statusサブコマンドを送信します。 |
|
| `subcommand` | 文字列 | `"status"`を使用して、statusサブコマンドを送信します。 |
|
||||||
|
|
||||||
### 応答フォーマット
|
### レスポンスのフォーマット
|
||||||
|
|
||||||
Pathfinding要求が実行中の場合、応答は[`path_find create`](#path_find-create)に対する初期応答と同じフォーマットであるのに加えて、以下のフィールドがあります。
|
Pathfindingリクエストが実行中の場合、レスポンスは[`path_find create`](#path_find-create)に対する初期レスポンスと同じフォーマットであるのに加えて、以下のフィールドがあります。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:---------|:--------|:--------------------------------------------------------|
|
|:---------|:--------|:--------------------------------------------------------|
|
||||||
| `status` | ブール値 | 値が`true`の場合、これは`path_find status`コマンドに対する応答です。 |
|
| `status` | ブール値 | 値が`true`の場合、これは`path_find status`コマンドに対するレスポンスです。 |
|
||||||
|
|
||||||
未処理のPathfinding要求がない場合はエラーが返されます。
|
未処理のPathfindingリクエストがない場合はエラーが返されます。
|
||||||
|
|
||||||
### 考えられるエラー
|
### 考えられるエラー
|
||||||
|
|
||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `noEvents` - 非同期コールバックをサポートしていないプロトコル（JSON-RPCなど）を使用しています。（JSON-RPCと互換性が_ある_Pathfindingメソッドについては、[ripple_path_findメソッド][]を参照してください。）
|
* `noEvents` - 非同期コールバックをサポートしていないプロトコル（JSON-RPCなど）を使用しています。（JSON-RPCと互換性が_ある_Pathfindingメソッドについては、[ripple_path_findメソッド][]を参照してください。）
|
||||||
* `noPathRequest` - Pathfinding要求のステータスを確認しようとしましたが、処理中の要求がありませんでした。
|
* `noPathRequest` - Pathfindingリクエストのステータスを確認しようとしましたが、処理中のリクエストがありませんでした。
|
||||||
|
|
||||||
|
|
||||||
{% include '_snippets/rippled_versions.md' %}
|
{% include '_snippets/rippled_versions.md' %}
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
html: ripple_path_find.html
|
html: ripple_path_find.html
|
||||||
parent: path-and-order-book-methods.html
|
parent: path-and-order-book-methods.html
|
||||||
blurb: すぐに利用できるペイメントパスを含む1つの応答を返します。
|
blurb: すぐに利用できるペイメントパスを含む1つのレスポンスを返します。
|
||||||
labels:
|
labels:
|
||||||
- 複数通貨間
|
- 複数通貨間
|
||||||
- トークン
|
- トークン
|
||||||
@@ -9,14 +9,14 @@ labels:
|
|||||||
# ripple_path_find
|
# ripple_path_find
|
||||||
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/RipplePathFind.cpp "Source")
|
[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/RipplePathFind.cpp "Source")
|
||||||
|
|
||||||
`ripple_path_find`メソッドは、[path_findメソッド][]のシンプルなバージョンであり、すぐに利用できる[ペイメントパス](paths.html)を含む1つの応答を返します。WebSocket APIとJSON-RPC APIの両方で使用できます。ただし、結果は時間の経過とともに古くなる傾向にあります。最新の状態を維持するために複数のコールを実行する代わりに、可能な場合には[path_findメソッド][]を使用して、継続的な更新をサブスクライブします。
|
`ripple_path_find`メソッドは、[path_findメソッド][]のシンプルなバージョンであり、すぐに利用できる[ペイメントパス](paths.html)を含む1つのレスポンスを返します。WebSocket APIとJSON-RPC APIの両方で使用できます。ただし、結果は時間の経過とともに古くなる傾向にあります。最新の状態を維持するために複数のコールを実行する代わりに、可能な場合には[path_findメソッド][]を使用して、継続的な更新をサブスクライブします。
|
||||||
|
|
||||||
`rippled`サーバーは支払いを行うため最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。
|
`rippled`サーバーは支払いを行うため最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。
|
||||||
|
|
||||||
**注意:** 信頼できないサーバーからのPathfindingの結果には注意してください。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。サーバーの負荷が非常に高い場合にも不適切な結果が返される可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。
|
**注意:** 信頼できないサーバーからのPathfindingの結果には注意してください。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。サーバーの負荷が非常に高い場合にも不適切な結果が返される可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -82,21 +82,21 @@ rippled ripple_path_find '{"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
|
|||||||
|
|
||||||
[試してみる >](websocket-api-tool.html#ripple_path_find)
|
[試してみる >](websocket-api-tool.html#ripple_path_find)
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:----------------------|:---------------------------|:------------------------|
|
|:----------------------|:---------------------------|:------------------------|
|
||||||
| `source_account` | 文字列 | トランザクションで資金を送金するアカウントの一意のアドレス。 |
|
| `source_account` | 文字列 | トランザクションで資金を送金するアカウントの一意のアドレス。 |
|
||||||
| `destination_account` | 文字列 | トランザクションで資金を受領するアカウントの一意のアドレス。 |
|
| `destination_account` | 文字列 | トランザクションで資金を受領するアカウントの一意のアドレス。 |
|
||||||
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:** [新規: rippled 0.30.0][]`value`フィールドには`"-1"`（XRPの場合）または-1（XRP以外の通貨の場合）を指定できます。これにより、最大限の額を送金できるパスが要求されます。ただし`send_max`が指定されている場合は、指定されている額を上回る額が支払われることはありません。 |
|
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:** [新規: rippled 0.30.0][]`value`フィールドには`"-1"`（XRPの場合）または-1（XRP以外の通貨の場合）を指定できます。これにより、最大限の額を送金できるパスがリクエストされます。ただし`send_max`が指定されている場合は、指定されている額を上回る額が支払われることはありません。 |
|
||||||
| `send_max` | 文字列またはオブジェクト | _（省略可）_ トランザクションで使用する[通貨額][]。`source_currencies`と同時に使用することはできません。[新規: rippled 0.30.0][] |
|
| `send_max` | 文字列またはオブジェクト | _（省略可）_ トランザクションで使用する[通貨額][]。`source_currencies`と同時に使用することはできません。[新規: rippled 0.30.0][] |
|
||||||
| `source_currencies` | 配列 | _（省略可）_ 送信元アカウントが使用する通貨の配列。この配列の各エントリーは、必須の`currency`フィールドとオプションの`issuer`フィールドを有するJSONオブジェクトです（[通貨額][]の指定方法と同様）。指定できる送金元通貨は**18**種類以下です。デフォルトでは、あらゆる送金元通貨を使用し、最大で**88**の異なる通貨/イシュアーペアに使用できます。 |
|
| `source_currencies` | 配列 | _（省略可）_ 送信元アカウントが使用する通貨の配列。この配列の各エントリーは、必須の`currency`フィールドとオプションの`issuer`フィールドを有するJSONオブジェクトです（[通貨額][]の指定方法と同様）。指定できる送金元通貨は**18**種類以下です。デフォルトでは、あらゆる送金元通貨を使用し、最大で**88**の異なる通貨/イシュアーペアに使用できます。 |
|
||||||
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進文字列。（[レジャーの指定][]を参照してください） |
|
||||||
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]を参照してください） |
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -320,7 +320,7 @@ rippled ripple_path_find '{"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| `Field` | 型 | 説明 |
|
| `Field` | 型 | 説明 |
|
||||||
|:-------------------------|:-------|:-----------------------------------------|
|
|:-------------------------|:-------|:-----------------------------------------|
|
||||||
@@ -342,12 +342,12 @@ rippled ripple_path_find '{"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
|
|||||||
* [汎用エラータイプ][]のすべて。
|
* [汎用エラータイプ][]のすべて。
|
||||||
* `tooBusy` - サーバーの負荷が高すぎるため、パスを計算できません。管理者として接続している場合は、このエラーが返されることはありません。
|
* `tooBusy` - サーバーの負荷が高すぎるため、パスを計算できません。管理者として接続している場合は、このエラーが返されることはありません。
|
||||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||||
* `srcActMissing` - `source_account`フィールドが要求で省略されています。
|
* `srcActMissing` - `source_account`フィールドがリクエストで省略されています。
|
||||||
* `srcActMalformed` - 要求の`source_account`フィールドのフォーマットが適切ではありません。
|
* `srcActMalformed` - リクエストの`source_account`フィールドのフォーマットが適切ではありません。
|
||||||
* `dstActMissing` - `destination_account`フィールドが要求で省略されています。
|
* `dstActMissing` - `destination_account`フィールドがリクエストで省略されています。
|
||||||
* `dstActMalformed` - 要求の`destination_account`フィールドのフォーマットが適切ではありません。
|
* `dstActMalformed` - リクエストの`destination_account`フィールドのフォーマットが適切ではありません。
|
||||||
* `srcCurMalformed` - `source_currencies`フィールドのフォーマットが適切ではありません。
|
* `srcCurMalformed` - `source_currencies`フィールドのフォーマットが適切ではありません。
|
||||||
* `srcIsrMalformed` - 要求の1つ以上の通貨オブジェクトの`issuer`フィールドが有効ではありません。
|
* `srcIsrMalformed` - リクエストの1つ以上の通貨オブジェクトの`issuer`フィールドが有効ではありません。
|
||||||
|
|
||||||
|
|
||||||
{% include '_snippets/rippled_versions.md' %}
|
{% include '_snippets/rippled_versions.md' %}
|
||||||
|
|||||||
@@ -12,8 +12,8 @@ _（[PayChan Amendment][]が有効になっている必要があります。[新
|
|||||||
|
|
||||||
`channel_authorize`メソッドは、特定額のXRPをPayment Channelから清算するときに使用できる署名を作成します。
|
`channel_authorize`メソッドは、特定額のXRPをPayment Channelから清算するときに使用できる署名を作成します。
|
||||||
|
|
||||||
## 要求フォーマット
|
## リクエストのフォーマット
|
||||||
要求フォーマットの例:
|
リクエストのフォーマットの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ rippled channel_authorize s█████████████████
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
要求には以下のパラメーターが含まれます。
|
リクエストには以下のパラメーターが含まれます。
|
||||||
|
|
||||||
| フィールド | 型 | 説明 |
|
| フィールド | 型 | 説明 |
|
||||||
|-------|------|-------------|
|
|-------|------|-------------|
|
||||||
@@ -68,13 +68,13 @@ rippled channel_authorize s█████████████████
|
|||||||
| `key_type` | 文字列 | _（省略可）_ 指定された暗号化キーペアの[署名アルゴリズム](cryptographic-keys.html#署名アルゴリズム)。有効な種類は、`secp256k1`または`ed25519`です。デフォルトは`secp256k1`です。[新規: rippled 1.4.0][] |
|
| `key_type` | 文字列 | _（省略可）_ 指定された暗号化キーペアの[署名アルゴリズム](cryptographic-keys.html#署名アルゴリズム)。有効な種類は、`secp256k1`または`ed25519`です。デフォルトは`secp256k1`です。[新規: rippled 1.4.0][] |
|
||||||
| `amount` | 文字列 | 承認するXRPの累積額（drop数）送金先がこのChannelからすでに受領しているXRPの額がこのフィールドの額よりも少ない場合、このメソッドで作成される署名を使用して差額を清算できます。 |
|
| `amount` | 文字列 | 承認するXRPの累積額（drop数）送金先がこのChannelからすでに受領しているXRPの額がこのフィールドの額よりも少ない場合、このメソッドで作成される署名を使用して差額を清算できます。 |
|
||||||
|
|
||||||
要求では、`secret`、`seed`、`seed_hex`、`passphrase`のうち1つだけを指定する**必要があります**。
|
リクエストでは、`secret`、`seed`、`seed_hex`、`passphrase`のうち1つだけを指定する**必要があります**。
|
||||||
|
|
||||||
**警告:** 信頼できないサーバーに対して、またはセキュリティが確保されていないネットワーク接続を通じて秘密鍵を送信しないでください。（これには、この要求の`secret`、`seed`、`seed_hex`、または`passphrase`フィールドも含まれます）このメソッドは、自身が実行するサーバー、または資金を預けている十分に信頼できるサーバーへの、安全で暗号化されたネットワーク接続でのみ使用してください。そうでない場合、盗聴者があなたの秘密鍵を使用してクレームに署名し、同じキーペアを使用してこのPayment Channelなどから資金をすべて持ち出す可能性があります。手順については、[安全な署名の設定](secure-signing.html)を参照してください。
|
**警告:** 信頼できないサーバーに対して、またはセキュリティが確保されていないネットワーク接続を通じて秘密鍵を送信しないでください。（これには、このリクエストの`secret`、`seed`、`seed_hex`、または`passphrase`フィールドも含まれます）このメソッドは、自身が実行するサーバー、または資金を預けている十分に信頼できるサーバーへの、安全で暗号化されたネットワーク接続でのみ使用してください。そうでない場合、盗聴者があなたの秘密鍵を使用してクレームに署名し、同じキーペアを使用してこのPayment Channelなどから資金をすべて持ち出す可能性があります。手順については、[安全な署名の設定](secure-signing.html)を参照してください。
|
||||||
|
|
||||||
## 応答フォーマット
|
## レスポンスのフォーマット
|
||||||
|
|
||||||
処理が成功した応答の例:
|
処理が成功したレスポンスの例:
|
||||||
|
|
||||||
<!-- MULTICODE_BLOCK_START -->
|
<!-- MULTICODE_BLOCK_START -->
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ rippled channel_authorize s█████████████████
|
|||||||
|
|
||||||
<!-- MULTICODE_BLOCK_END -->
|
<!-- MULTICODE_BLOCK_END -->
|
||||||
|
|
||||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||||
|
|
||||||
| フィールド | 型 | 説明 |
|
| フィールド | 型 | 説明 |
|
||||||
|-------|------|-------------|
|
|-------|------|-------------|
|
||||||
@@ -125,10 +125,10 @@ rippled channel_authorize s█████████████████
|
|||||||
## 考えられるエラー
|
## 考えられるエラー
|
||||||
|
|
||||||
* いずれかの[汎用エラータイプ][]。
|
* いずれかの[汎用エラータイプ][]。
|
||||||
* `badKeyType` - 要求の`key_type`パラメーターは、有効なキータイプではありません。(有効なタイプは、`secp256k1`または`ed25519`です。)[新規: rippled 1.4.0][]
|
* `badKeyType` - リクエストの`key_type`パラメーターは、有効なキータイプではありません。(有効なタイプは、`secp256k1`または`ed25519`です。)[新規: rippled 1.4.0][]
|
||||||
* `badSeed` - 要求の`secret`が有効なシークレットキーではありません。
|
* `badSeed` - リクエストの`secret`が有効なシークレットキーではありません。
|
||||||
* `channelAmtMalformed` - 要求の`amount`が有効な[XRPの額][XRP、drop単位]ではありません。
|
* `channelAmtMalformed` - リクエストの`amount`が有効な[XRPの額][XRP、drop単位]ではありません。
|
||||||
* `channelMalformed` - 要求の`channel_id`が有効なChannel IDではありません。Channel IDは256ビット（64文字）の16進文字列です。
|
* `channelMalformed` - リクエストの`channel_id`が有効なChannel IDではありません。Channel IDは256ビット（64文字）の16進文字列です。
|
||||||
|
|
||||||
|
|
||||||
{% include '_snippets/rippled_versions.md' %}
|
{% include '_snippets/rippled_versions.md' %}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user