mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-12-06 17:27:57 +00:00
Japanese translation: add remaining files
This commit is contained in:
@@ -0,0 +1,190 @@
|
||||
# book_offers
|
||||
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/BookOffers.cpp "Source")
|
||||
|
||||
`book_offers`メソッドは、[オーダーブック](http://www.investopedia.com/terms/o/order-book.asp)と呼ばれる、2つの通貨間のオファーのリストを取得します。結果が非常に大きい場合、結果の一部がマーカー付きで返されます。これにより、その後の要求は前回の要求で終わった箇所から再開できます。
|
||||
|
||||
## 要求フォーマット
|
||||
要求フォーマットの例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```
|
||||
{
|
||||
"id": 4,
|
||||
"command": "book_offers",
|
||||
"taker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"taker_gets": {
|
||||
"currency": "XRP"
|
||||
},
|
||||
"taker_pays": {
|
||||
"currency": "USD",
|
||||
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
|
||||
},
|
||||
"limit": 10
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```
|
||||
{
|
||||
"method": "book_offers",
|
||||
"params": [
|
||||
{
|
||||
"taker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"taker_gets": {
|
||||
"currency": "XRP"
|
||||
},
|
||||
"taker_pays": {
|
||||
"currency": "USD",
|
||||
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
},
|
||||
"limit": 10
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
*コマンドライン*
|
||||
|
||||
```
|
||||
#Syntax: book_offers taker_pays taker_gets [taker [ledger [limit] ] ]
|
||||
rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
[試してみる>](websocket-api-tool.html#book_offers)
|
||||
|
||||
要求には以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------------|:-------------------------------------------|:-------------------------------|
|
||||
| `ledger_hash` | 文字列 | _(省略可)_ 使用するレジャーバージョンの20バイトの16進数文字列。([レジャーの指定][]を参照してください。) |
|
||||
| `ledger_index` | 文字列または符号なし整数 | _(省略可)_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください。) |
|
||||
| `limit` | 符号なし整数 | _(省略可)_ 指定されている場合、サーバーはこの制限を超える数のオファーを結果に含めません。資金供給のないオファーはサーバーにより省略されるため、返される結果の総数はこの制限よりも少ないことがあります。 |
|
||||
| `marker` | [マーカー][] | _(省略可)_ 以前にページネーションされた応答の値。その応答で終わった箇所からデータの取得を再開します。 |
|
||||
| `taker` | 文字列 | _(省略可)_ パースペクティブとして使用するアカウントの[アドレス][]。このアカウントが発行した[資金供給のないオファー](offers.html#オファーのライフサイクル)は常に応答に含まれます。(これを使用して、キャンセルしたい各自のオーダーを検索できます。) |
|
||||
| `taker_gets` | オブジェクト | オファーを受諾するアカウントが受け取る通貨を、[通貨額][Currency Amount]と同様に、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定します(XRPの場合はissuerを省略)。 |
|
||||
| `taker_pays` | オブジェクト | オファーを受諾するアカウントが支払う通貨を、[通貨額][Currency Amount]と同様に、`currency`フィールドと`issuer`フィールドを持つオブジェクトとして指定します(XRPの場合はissuerを省略)。 |
|
||||
|
||||
## 応答フォーマット
|
||||
|
||||
処理が成功した応答の例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```
|
||||
{
|
||||
"id": 11,
|
||||
"status": "success",
|
||||
"type": "response",
|
||||
"result": {
|
||||
"ledger_current_index": 7035305,
|
||||
"offers": [
|
||||
{
|
||||
"Account": "rM3X3QSr8icjTGpaF52dozhbT2BZSXJQYM",
|
||||
"BookDirectory": "7E5F614417C2D0A7CEFEB73C4AA773ED5B078DE2B5771F6D55055E4C405218EB",
|
||||
"BookNode": "0000000000000000",
|
||||
"Flags": 0,
|
||||
"LedgerEntryType": "Offer",
|
||||
"OwnerNode": "0000000000000AE0",
|
||||
"PreviousTxnID": "6956221794397C25A53647182E5C78A439766D600724074C99D78982E37599F1",
|
||||
"PreviousTxnLgrSeq": 7022646,
|
||||
"Sequence": 264542,
|
||||
"TakerGets": {
|
||||
"currency": "EUR",
|
||||
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"value": "17.90363633316433"
|
||||
},
|
||||
"TakerPays": {
|
||||
"currency": "USD",
|
||||
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"value": "27.05340557506234"
|
||||
},
|
||||
"index": "96A9104BF3137131FF8310B9174F3B37170E2144C813CA2A1695DF2C5677E811",
|
||||
"quality": "1.511056473200875"
|
||||
},
|
||||
{
|
||||
"Account": "rhsxKNyN99q6vyYCTHNTC1TqWCeHr7PNgp",
|
||||
"BookDirectory": "7E5F614417C2D0A7CEFEB73C4AA773ED5B078DE2B5771F6D5505DCAA8FE12000",
|
||||
"BookNode": "0000000000000000",
|
||||
"Flags": 131072,
|
||||
"LedgerEntryType": "Offer",
|
||||
"OwnerNode": "0000000000000001",
|
||||
"PreviousTxnID": "8AD748CD489F7FF34FCD4FB73F77F1901E27A6EFA52CCBB0CCDAAB934E5E754D",
|
||||
"PreviousTxnLgrSeq": 7007546,
|
||||
"Sequence": 265,
|
||||
"TakerGets": {
|
||||
"currency": "EUR",
|
||||
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"value": "2.542743233917848"
|
||||
},
|
||||
"TakerPays": {
|
||||
"currency": "USD",
|
||||
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"value": "4.19552633596446"
|
||||
},
|
||||
"index": "7001797678E886E22D6DE11AF90DF1E08F4ADC21D763FAFB36AF66894D695235",
|
||||
"quality": "1.65"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```
|
||||
200 OK
|
||||
{
|
||||
"result": {
|
||||
"ledger_current_index": 8696243,
|
||||
"offers": [],
|
||||
"status": "success",
|
||||
"validated": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------------------|:-------------------------------------------|:------------------------------------------|
|
||||
| `ledger_current_index` | 整数 | (レジャーバージョンが指定されている場合は省略)このデータの取得時に使用したレジャーバージョンのシーケンス番号。 |
|
||||
| `ledger_index` | 整数 | (ledger\_current\_indexが代わりに指定されている場合は省略)要求で指定される、このデータの取得時に使用されたレジャーバージョンのシーケンス番号。 |
|
||||
| `ledger_hash` | 文字列 | (省略される場合があります)要求で指定される、このデータの取得時に使用されたレジャーバージョンの16進数ハッシュ。 |
|
||||
| `marker` | [マーカー][] | (省略される場合があります)応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に情報ページがない場合は省略されます。 |
|
||||
| `offers` | 配列 | Offerオブジェクトの配列。各オブジェクトには[Offer オブジェクト](offer.html)のフィールドが含まれています。 |
|
||||
|
||||
`offers`配列の要素には、Offerの標準フィールドの他に以下のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:--------------------|:---------------------------------|:--------------------|
|
||||
| `owner_funds` | 文字列 | オファーの発行元が保有する取引可能なTakerGets通貨の金額。(XRPはdrop単位で表されます。その他のすべての通貨は10進数値として表されます。)1人のトレーダーの複数のオファーが同一のブックに含まれている場合、このフィールドは最高順位のオファーにのみ含まれます。 |
|
||||
| `taker_gets_funded` | 文字列(XRP)またはオブジェクト(XRP以外) | (部分的に資金供給されているオファーのみに含まれます)オファーの資金供給ステータスが指定されている場合に、受取人が受領できる最大通貨額。 |
|
||||
| `taker_pays_funded` | 文字列(XRP)またはオブジェクト(XRP以外) | (部分的に資金供給されているオファーのみに含まれます)オファーの資金供給ステータスが指定されている場合に、受取人が支払う最大通貨額。 |
|
||||
| `quality` | 文字列 | 為替レート(`taker_pays`を`taker_gets`で割った比率)。公正を期すため、同じクオリティのオファーは先入れ先出しで自動的に受諾されます。(つまり、複数の人々が通貨を同じレートで取引するオファーを出した場合、最も古いオファーが最初に受諾されます。) |
|
||||
|
||||
## 考えられるエラー
|
||||
|
||||
* [一般的なエラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`に指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
||||
* `srcCurMalformed` - 要求の`taker_pays`フィールドのフォーマットが適切ではありません。
|
||||
* `dstAmtMalformed` - 要求の`taker_gets`フィールドのフォーマットが適切ではありません。
|
||||
* `srcIsrMalformed` - 要求の`taker_pays`フィールドの`issuer`フィールドが無効です。
|
||||
* `dstIsrMalformed` - 要求の`taker_gets`フィールドの`issuer`フィールドが無効です。
|
||||
* `badMarket` - 必要なオーダーブックが存在していません(ある通貨をその通貨自体と交換するオファーなど)。
|
||||
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
@@ -0,0 +1,143 @@
|
||||
# deposit_authorized
|
||||
[[ソース]<br>](https://github.com/ripple/rippled/blob/817d2339b8632cb2f97d3edd6f7af33aa7631744/src/ripple/rpc/handlers/DepositAuthorized.cpp "Source")
|
||||
|
||||
`deposit_authorized`コマンドは、あるアカウントに別のアカウントへ支払を直接送金する権限があるかどうかを示します。アカウントへの送金に承認を義務付ける方法については、[Deposit Authorization](depositauth.html)を参照してください。
|
||||
|
||||
## 要求フォーマット
|
||||
要求フォーマットの例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"command": "deposit_authorized",
|
||||
"source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
|
||||
"destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"ledger_index": "validated"
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "deposit_authorized",
|
||||
"params": [
|
||||
{
|
||||
"source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
|
||||
"destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"ledger_index": "validated"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
*コマンドライン*
|
||||
|
||||
```bash
|
||||
#Syntax: deposit_authorized <source_account> <destination_account> [<ledger>]
|
||||
rippled deposit_authorized rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8 validated
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
要求には以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------------|:---------------------------|:------------------------|
|
||||
| `source_account` | 文字列 - [アドレス][] | 発生し得る支払の送金元。 |
|
||||
| `destination_account` | 文字列 - [アドレス][] | 発生し得る支払の送金先。 |
|
||||
| `ledger_hash` | 文字列 | _(省略可)_ 使用するレジャーバージョンの20バイトの16進数文字列。([レジャーの指定][]を参照してください。) |
|
||||
| `ledger_index` | 文字列または符号なし整数 | _(省略可)_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください。) |
|
||||
|
||||
|
||||
## 応答フォーマット
|
||||
|
||||
処理が成功した応答の例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"result": {
|
||||
"deposit_authorized": true,
|
||||
"destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"ledger_hash": "BD03A10653ED9D77DCA859B7A735BF0580088A8F287FA2C5403E0A19C58EF322",
|
||||
"ledger_index": 8,
|
||||
"source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
|
||||
"validated": true
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"deposit_authorized": true,
|
||||
"destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"ledger_hash": "BD03A10653ED9D77DCA859B7A735BF0580088A8F287FA2C5403E0A19C58EF322",
|
||||
"ledger_index": 8,
|
||||
"source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
|
||||
"status": "success",
|
||||
"validated": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
*コマンドライン*
|
||||
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
2018-Jul-30 20:07:38.771658157 HTTPClient:NFO Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"deposit_authorized" : true,
|
||||
"destination_account" : "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"ledger_hash" : "BD03A10653ED9D77DCA859B7A735BF0580088A8F287FA2C5403E0A19C58EF322",
|
||||
"ledger_index" : 8,
|
||||
"source_account" : "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
|
||||
"status" : "success",
|
||||
"validated" : true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------------------|:---------------------|:-----------------------------|
|
||||
| `deposit_authorized` | ブール値 | 指定の支払元アカウントから支払先アカウントへの直接送金が承認されているかどうか。`true`の場合、支払先アカウントで[Deposit Authorization](depositauth.html)を必要としていないか、または支払元アカウントが事前承認されています。 |
|
||||
| `destination_account` | 文字列 - [アドレス][] | 要求に指定されている宛先アカウント。 |
|
||||
| `ledger_hash` | 文字列 | _(省略される場合があります)_ この応答の生成に使用されたレジャーの識別用ハッシュ。 |
|
||||
| `ledger_index` | 数値 | _(省略される場合があります)_ この応答の生成に使用されたレジャーバージョンのシーケンス番号。 |
|
||||
| `ledger_current_index` | 数値 | _(省略される場合があります)_ この応答の生成に使用された現在処理中のレジャーバージョンのシーケンス番号。 |
|
||||
| `source_account` | 文字列 - [アドレス][] | 要求に指定されている支払元アカウント。 |
|
||||
| `validated` | ブール値 | _(省略される場合があります)_ `true`の場合、検証済みレジャーバージョンからの情報が取り込まれます。 |
|
||||
|
||||
**注記:** `deposit_authorized`ステータスが`true`でも、指定の支払元から指定の支払先への送金が可能であるとは保証されません。たとえば、支払先アカウントに指定通貨の[トラストライン](trust-lines-and-issuing.html)がない場合や、送金に十分な流動性がない場合があります。
|
||||
|
||||
## 考えられるエラー
|
||||
|
||||
* [一般的なエラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actMalformed` - 要求の`source_account`フィールドまたは`destination_account`フィールドに指定されている[アドレス][]のフォーマットが適切ではありません。(入力ミスが含まれていたり、長さが正しくない場合は、チェックサムは失敗します。)
|
||||
* `dstActNotFound` - 要求の`destination_account`フィールドがレジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`に指定されているレジャーが存在しないか、存在しているがサーバーにはありません。
|
||||
* `srcActNotFound` - 要求の`source_account`フィールドがレジャーのアカウントに対応していません。
|
||||
|
||||
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
@@ -0,0 +1,583 @@
|
||||
# path_find
|
||||
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp "Source")
|
||||
|
||||
*WebSocket APIのみ。*`path_find`メソッドは、トランザクションが実行される可能性のある[パス](paths.html)を探索し、時間の経過とともにパスが変化する場合に更新を定期的に送信します。JSON-RPCでサポートされているシンプルなバージョンについては、[ripple_path_findメソッド][]を参照してください。完全にXRPで行われる支払いの場合、XRPはどのアカウントにも直接送金できるためパスを探索する必要はありません。
|
||||
|
||||
path_findコマンドには3種類のモード(サブコマンド)があります。使用するモードを`subcommand`パラメーターに指定します。
|
||||
|
||||
* `create` - Pathfinding情報の送信を開始します
|
||||
* `close` - Pathfinding情報の送信を停止します
|
||||
* `status` - 現在処理中のPathfinding要求に関する情報を取得します
|
||||
|
||||
`rippled`サーバーは支払いを行うにあたり最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。サーバーの負荷が原因で、Pathfindingで最良のパスを検出できないことがあります。また、信頼できないサーバーからのPathfindingの結果には注意する必要があります。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。(**注記:** サーバーから最良ではない結果が返されても、必ずしも悪意のある振る舞いの証拠とはなりません。サーバーの負荷が高い場合の症状である可能性もあります。)
|
||||
|
||||
## path_find create
|
||||
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L50-L56 "Source")
|
||||
|
||||
`path_find`の`create`サブコマンドは、指定された特定アカウントから支払トランザクションを実行できるパスを探索する継続的な要求を作成し、別のアカウントが何らかの通貨で希望する額を受領できるようにします。初期応答には2つのアドレス間で提案されるパスが含まれています。このパスにより、希望する額を受領できます。その後サーバーは、`"type": "path_find"`で有効なパスの更新を含む追加メッセージを送信します。更新の頻度はサーバーにより決定されますが、新しいレジャーバージョンがある場合には通常、数秒間に1回です。
|
||||
|
||||
クライアントは一度に1つのPathfinding要求のみ実行できます。同じ接続ですでに他のPathfinding要求が実行されている場合、古い要求が自動的にクローズされ、新しい要求に置き換えられます。
|
||||
|
||||
### 要求フォーマット
|
||||
要求フォーマットの例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```
|
||||
{
|
||||
"id":8,
|
||||
"command":"path_find",
|
||||
"subcommand":"create",
|
||||
"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"destination_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"destination_amount":{
|
||||
"value":"0.001",
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
[試してみる >](websocket-api-tool.html#path_find)
|
||||
|
||||
要求には以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------------|:-----------------|:----------------------------------|
|
||||
| `subcommand` | 文字列 | `"create"`を使用してcreateサブコマンドを送信します。 |
|
||||
| `source_account` | 文字列 | 探索するパスの送金元アカウントの一意のアドレス。(つまり、支払いを送金するアカウントです。) |
|
||||
| `destination_account` | 文字列 | 探索するパスの送金先アカウントの一意のアドレス。(つまり、支払いを受領するアカウントです。) |
|
||||
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:**[新規: rippled 0.30.0][]`value`フィールドには`"-1"`(XRPの場合)または-1(XRP以外の通貨の場合)を指定できます。これにより、最大限の額を送金できるパスが要求されます。ただし`send_max`が指定されている場合は、指定額を上回る額が支払われることはありません。 |
|
||||
| `send_max` | 文字列またはオブジェクト | _(省略可)_ トランザクションに使用する[通貨額][]。`source_currencies`と同時に指定することはできません。[新規: rippled 0.30.0][] |
|
||||
| `paths` | 配列 | _(省略可)_ チェックする[ペイメントパス](paths.html)を表すオブジェクトの配列。すでに判明している特定パスの変更内容を常に把握する場合や、特定パスに沿った支払いにかかる総コストを確認する場合にこのフィールドを使用できます。 |
|
||||
|
||||
サーバーは`source_currencies`および`bridges`フィールドも認識しますが、これらのフィールドを使用した場合の結果は保証されません。これらのフィールドは将来のために予約されているものと考えてください。
|
||||
|
||||
### 応答フォーマット
|
||||
|
||||
処理が成功した応答の例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```
|
||||
{
|
||||
"id":1,
|
||||
"status":"success",
|
||||
"type":"response",
|
||||
"result":{
|
||||
"alternatives":[
|
||||
{
|
||||
"paths_computed":[
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
]
|
||||
],
|
||||
"source_amount":"251686"
|
||||
},
|
||||
{
|
||||
"paths_computed":[
|
||||
[
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
]
|
||||
],
|
||||
"source_amount":{
|
||||
"currency":"BTC",
|
||||
"issuer":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"value":"0.000001541291269274307"
|
||||
}
|
||||
},
|
||||
{
|
||||
"paths_computed":[
|
||||
[
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
]
|
||||
],
|
||||
"source_amount":{
|
||||
"currency":"CHF",
|
||||
"issuer":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"value":"0.0009211546262510451"
|
||||
}
|
||||
},
|
||||
{
|
||||
"paths_computed":[
|
||||
[
|
||||
{
|
||||
"account":"razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"account":"razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
]
|
||||
],
|
||||
"source_amount":{
|
||||
"currency":"CNY",
|
||||
"issuer":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"value":"0.006293562"
|
||||
}
|
||||
},
|
||||
{
|
||||
"paths_computed":[
|
||||
[
|
||||
{
|
||||
"account":"rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"account":"rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"account":"rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
]
|
||||
],
|
||||
"source_amount":{
|
||||
"currency":"DYM",
|
||||
"issuer":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"value":"0.0007157142857142858"
|
||||
}
|
||||
},
|
||||
{
|
||||
"paths_computed":[
|
||||
[
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"account":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"account":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
]
|
||||
],
|
||||
"source_amount":{
|
||||
"currency":"EUR",
|
||||
"issuer":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"value":"0.0007409623616236163"
|
||||
}
|
||||
},
|
||||
{
|
||||
"paths_computed":[
|
||||
[
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
]
|
||||
],
|
||||
"source_amount":{
|
||||
"currency":"JPY",
|
||||
"issuer":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"value":"0.103412412"
|
||||
}
|
||||
}
|
||||
],
|
||||
"destination_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"destination_amount":{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"value":"0.001"
|
||||
},
|
||||
"id":1,
|
||||
"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"full_reply": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
この初期応答は[標準フォーマット](response-formatting.html)に従っており、正常に完了した場合は次のフィールドが含まれています。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------------|:-----------------|:----------------------------------|
|
||||
| `alternatives` | 配列 | 以下に説明する、提案される[パス](paths.html)のオブジェクトの配列。空の場合、送金元アカウントと送金先アカウントを結ぶパスが見つかりませんでした。 |
|
||||
| `destination_account` | 文字列 | トランザクションを受信するアカウントの一意のアドレス。 |
|
||||
| `destination_amount` | 文字列またはオブジェクト | 送金先がトランザクションで受領する[通貨額][]。 |
|
||||
| `id` | (各種) | (WebSocketのみ)WebSocket要求に指定されているIDが再びこのレベルで含まれます。 |
|
||||
| `source_account` | 文字列 | トランザクションを送信するアカウントの一意のアドレス。 |
|
||||
| `full_reply` | ブール値 | `false`の場合、これは不完全な検索の結果です。これ以降の応答に、より適切なパスが含まれている可能性があります。`true`の場合、これは検出された最良のパスです。(理論上、これよりも優れたパスが存在している可能性がありますが`rippled`では検出されません。)Pathfinding要求をクローズするまで、`rippled`は引き続き、新しいレジャーが閉鎖されるたびに更新を送信します。[新規: rippled 0.29.0][] |
|
||||
|
||||
`alternatives`配列の各要素は、1つの送金元通貨(開始アカウントが保有)から送金先アカウントへのパスと通貨を表すオブジェクトです。このオブジェクトのフィールドを次に示します。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------------|:-----------------|:---------------------------------------|
|
||||
| `paths_computed` | 配列 | [ペイメントパス](paths.html)を定義するオブジェクトの配列。 |
|
||||
| `source_amount` | 文字列またはオブジェクト | 送金先が必要な額を受領するために、送金元がこのパスで送金する必要がある[通貨額][]。 |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [一般的なエラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `noEvents` - 非同期コールバックをサポートしていないプロトコル(JSON-RPCなど)を使用しています。(JSON-RPCと互換性が_ある_Pathfindingメソッドについては、[ripple_path_findメソッド][]を参照してください。)
|
||||
|
||||
### 非同期フォローアップ
|
||||
|
||||
サーバーからは初期応答の他に、時間の経過にともなう[ペイメントパス](paths.html)のステータスを更新するため類似したフォーマットでさらにメッセージが送信されます。これらのメッセージには、元のWebSocket要求の`id`が含まれているので、どの要求からメッセージが送信されたかを確認できます。また、最上位レベルの`"type": "path_find"`フィールドは、追加応答であることを示します。その他のフィールドは、初期応答と同じ方法で定義されます。
|
||||
|
||||
フォローアップに`"full_reply": true`が含まれている場合、これは現行レジャーの時点でrippledが検出できる最良のパスです。
|
||||
|
||||
path_find create要求からの非同期フォローアップの例を次に示します。
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```
|
||||
{
|
||||
"id":1,
|
||||
"type":"path_find",
|
||||
"alternatives":[
|
||||
/* paths omitted from this example; same format as the initial response */
|
||||
],
|
||||
"destination_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"destination_amount":{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"value":"0.001"
|
||||
},
|
||||
"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
## path_find close
|
||||
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L58-L67 "Source")
|
||||
|
||||
`path_find`の`close`サブコマンドは、サーバーに対して現在実行中のPathfinding要求に関する情報の送信を停止するように指示します。
|
||||
|
||||
### 要求フォーマット
|
||||
要求フォーマットの例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```
|
||||
{
|
||||
"id":57,
|
||||
"command":"path_find",
|
||||
"subcommand":"close"
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
要求には以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------|:-------|:-------------------------------------------|
|
||||
| `subcommand` | 文字列 | closeサブコマンドを送信するため`"close"`を使用します。 |
|
||||
|
||||
### 応答フォーマット
|
||||
|
||||
Pathfinding要求が正常にクローズされた場合、応答は[`path_find create`](#path_find-create)に対する初期応答と同じフォーマットであり、されに以下のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------|:--------|:--------------------------------------------------------|
|
||||
| `closed` | ブール値 | 値が`true`の場合、これは`path_find close`コマンドに対する応答です。 |
|
||||
|
||||
未処理のPathfinding要求がない場合はエラーが返されます。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [一般的なエラータイプ][]のすべて。
|
||||
* `invalidParams` - フィールドの指定が正しくないか、必須フィールドが指定されていません。
|
||||
* `noEvents` - 非同期コールバックをサポートしていないプロトコル(JSON-RPCなど)でこのメソッドを使用しようとしました。(JSON-RPCと互換性が_ある_Pathfindingメソッドについては、[ripple_path_findメソッド][]を参照してください。)
|
||||
* `noPathRequest` - Pathfinding要求をクローズしようとしましたが、実行中の要求がありませんでした。
|
||||
|
||||
## path_find status
|
||||
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/PathFind.cpp#L69-L77 "Source")
|
||||
|
||||
`path_find`の`status`サブコマンドは、現在実行中のクライアントのPathfinding要求の即時更新を要求します。
|
||||
|
||||
### 要求フォーマット
|
||||
要求フォーマットの例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```
|
||||
{
|
||||
"id":58,
|
||||
"command":"path_find",
|
||||
"subcommand":"status"
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
要求には以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------|:-------|:---------------------------------------------|
|
||||
| `subcommand` | 文字列 | `"status"`を使用して、statusサブコマンドを送信します。 |
|
||||
|
||||
### 応答フォーマット
|
||||
|
||||
Pathfinding要求が実行中の場合、応答は[`path_find create`](#path_find-create)に対する初期応答と同じフォーマットであるのに加えて、以下のフィールドがあります。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:---------|:--------|:--------------------------------------------------------|
|
||||
| `status` | ブール値 | 値が`true`の場合、これは`path_find status`コマンドに対する応答です。 |
|
||||
|
||||
未処理のPathfinding要求がない場合はエラーが返されます。
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [一般的なエラータイプ][]のすべて。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `noEvents` - 非同期コールバックをサポートしていないプロトコル(JSON-RPCなど)を使用しています。(JSON-RPCと互換性が_ある_Pathfindingメソッドについては、[ripple_path_findメソッド][]を参照してください。)
|
||||
* `noPathRequest` - Pathfinding要求のステータスを確認しようとしましたが、処理中の要求がありませんでした。
|
||||
|
||||
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
@@ -0,0 +1,345 @@
|
||||
# ripple_path_find
|
||||
[[ソース]<br>](https://github.com/ripple/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メソッド][]を使用して、継続的な更新をサブスクライブします。
|
||||
|
||||
`rippled`サーバーは支払いを行うため最も安価なパスまたはパスの組み合わせを探索しますが、このメソッドで返されるパスが最良のパスであることは保証されません。
|
||||
|
||||
**注意:** 信頼できないサーバーからのPathfindingの結果には注意してください。オペレーターの収益となるように、最良ではないパスを返すようにサーバーが改ざんされる可能性があります。サーバーの負荷が非常に高い場合にも不適切な結果が返される可能性があります。Pathfindingについて信頼できる独自サーバーがない場合は、1つのサーバーから不適切な結果が返されるリスクを最小限に抑えるため、異なる当事者が実行する複数のサーバーからのPathfindingの結果を比較してください。
|
||||
|
||||
## 要求フォーマット
|
||||
要求フォーマットの例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```
|
||||
{
|
||||
"id":8,
|
||||
"command":"ripple_path_find",
|
||||
"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"source_currencies":[
|
||||
{
|
||||
"currency":"XRP"
|
||||
},
|
||||
{
|
||||
"currency":"USD"
|
||||
}
|
||||
],
|
||||
"destination_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"destination_amount":{
|
||||
"value":"0.001",
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```
|
||||
{
|
||||
"method":"ripple_path_find",
|
||||
"params":[
|
||||
{
|
||||
"destination_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"destination_amount":{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"value":"0.001"
|
||||
},
|
||||
"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"source_currencies":[
|
||||
{
|
||||
"currency":"XRP"
|
||||
},
|
||||
{
|
||||
"currency":"USD"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
*コマンドライン*
|
||||
|
||||
```
|
||||
#Syntax ripple_path_find json ledger_index|ledger_hash
|
||||
rippled ripple_path_find '{"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "source_currencies":[ { "currency":"XRP" }, { "currency":"USD" } ], "destination_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "destination_amount":{ "value":"0.001", "currency":"USD", "issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" } }'
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
[試してみる >](websocket-api-tool.html#ripple_path_find)
|
||||
|
||||
要求には以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------------|:---------------------------|:------------------------|
|
||||
| `source_account` | 文字列 | トランザクションで資金を送金するアカウントの一意のアドレス。 |
|
||||
| `destination_account` | 文字列 | トランザクションで資金を受領するアカウントの一意のアドレス。 |
|
||||
| `destination_amount` | 文字列またはオブジェクト | 送金先アカウントがトランザクションで受領する[通貨額][]。**特殊なケース:** [新規: rippled 0.30.0][]`value`フィールドには`"-1"`(XRPの場合)または-1(XRP以外の通貨の場合)を指定できます。これにより、最大限の額を送金できるパスが要求されます。ただし`send_max`が指定されている場合は、指定されている額を上回る額が支払われることはありません。 |
|
||||
| `send_max` | 文字列またはオブジェクト | _(省略可)_ トランザクションで使用する[通貨額][]。`source_currencies`と同時に使用することはできません。[新規: rippled 0.30.0][] |
|
||||
| `source_currencies` | 配列 | _(省略可)_ 送信元アカウントが使用する通貨の配列。この配列の各エントリーは、必須の`currency`フィールドとオプションの`issuer`フィールドを有するJSONオブジェクトです([通貨額][Currency Amount]の指定方法と同様)。指定できる送金元通貨は**18**種類以下です。デフォルトでは、あらゆる送金元通貨を使用し、最大で**88**の異なる通貨/イシュアーペアに使用できます。 |
|
||||
| `ledger_hash` | 文字列 | _(省略可)_ 使用するレジャーバージョンの20バイトの16進文字列。([レジャーの指定][]を参照してください) |
|
||||
| `ledger_index` | 文字列または符号なし整数 | _(省略可)_ 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]を参照してください) |
|
||||
|
||||
## 応答フォーマット
|
||||
|
||||
処理が成功した応答の例:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```
|
||||
{
|
||||
"id":8,
|
||||
"status":"success",
|
||||
"type":"response",
|
||||
"result":{
|
||||
"alternatives":[
|
||||
{
|
||||
"paths_canonical":[],
|
||||
"paths_computed":[
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"rLpq4LgabRfm1xEX5dpWfJovYBH6g7z99q",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"rPuBoajMjFoDjweJBrtZEBwUMkyruxpwwV",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
]
|
||||
],
|
||||
"source_amount":"256987"
|
||||
}
|
||||
],
|
||||
"destination_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"destination_currencies":[
|
||||
"015841551A748AD2C1F76FF6ECB0CCCD00000000",
|
||||
"JOE",
|
||||
"DYM",
|
||||
"EUR",
|
||||
"CNY",
|
||||
"MXN",
|
||||
"BTC",
|
||||
"USD",
|
||||
"XRP"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```
|
||||
200 OK
|
||||
{
|
||||
"result":{
|
||||
"alternatives":[
|
||||
{
|
||||
"paths_canonical":[],
|
||||
"paths_computed":[
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rpDMez6pm6dBve2TJsmDpv7Yae6V5Pyvy2",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rpDMez6pm6dBve2TJsmDpv7Yae6V5Pyvy2",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"rfDeu7TPUmyvUrffexjMjq3mMcSQHZSYyA",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"raspZSGNiTKi5jmvFxUYCuYXPv1V8WhL5g",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
],
|
||||
[
|
||||
{
|
||||
"currency":"USD",
|
||||
"issuer":"rpHgehzdpfWRXKvSv6duKvVuo1aZVimdaT",
|
||||
"type":48,
|
||||
"type_hex":"0000000000000030"
|
||||
},
|
||||
{
|
||||
"account":"rpHgehzdpfWRXKvSv6duKvVuo1aZVimdaT",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
},
|
||||
{
|
||||
"account":"rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"type":1,
|
||||
"type_hex":"0000000000000001"
|
||||
}
|
||||
]
|
||||
],
|
||||
"source_amount":"207414"
|
||||
}
|
||||
],
|
||||
"destination_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"destination_currencies":[
|
||||
"USD",
|
||||
"JOE",
|
||||
"BTC",
|
||||
"DYM",
|
||||
"CNY",
|
||||
"EUR",
|
||||
"015841551A748AD2C1F76FF6ECB0CCCD00000000",
|
||||
"MXN",
|
||||
"XRP"
|
||||
],
|
||||
"status":"success"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
この応答は[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-------------------------|:-------|:-----------------------------------------|
|
||||
| `alternatives` | 配列 | 使用可能なパスを持つオブジェクトの配列。以下に説明します。空の場合、送金元アカウントと送金先アカウントを結ぶパスがありません。 |
|
||||
| `destination_account` | 文字列 | 支払トランザクションを受信するアカウントの一意のアドレス。 |
|
||||
| `destination_currencies` | 配列 | 送金先が受領する通貨を表す文字列の配列。この文字列は、3文字コード(`"USD"`など)または40文字の16進文字列(`"015841551A748AD2C1F76FF6ECB0CCCD00000000"`など)です。 |
|
||||
|
||||
`alternatives`配列の各要素は、1つの送金元通貨(開始アカウントが保有)から送金先アカウントへのパスと通貨を表すオブジェクトです。このオブジェクトのフィールドを次に示します。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------------|:-----------------|:---------------------------------------|
|
||||
| `paths_computed` | 配列 | (省略可)[ペイメントパス](paths.html)を定義するオブジェクトの配列。 |
|
||||
| `source_amount` | 文字列またはオブジェクト | 送金先が希望額を受領できるよう、送金元がこのパスで送金する必要のある[通貨額][]。 |
|
||||
|
||||
次のフィールドは廃止予定のため、省略される可能性があります。`paths_canonical`および`paths_expanded`。出力される場合は無視してください。
|
||||
|
||||
## 考えられるエラー
|
||||
|
||||
* [一般的なエラータイプ][]のすべて。
|
||||
* `tooBusy` - サーバーの負荷が高すぎるため、パスを計算できません。管理者として接続している場合は、このエラーが返されることはありません。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `srcActMissing` - `source_account`フィールドが要求で省略されています。
|
||||
* `srcActMalformed` - 要求の`source_account`フィールドのフォーマットが適切ではありません。
|
||||
* `dstActMissing` - `destination_account`フィールドが要求で省略されています。
|
||||
* `dstActMalformed` - 要求の`destination_account`フィールドのフォーマットが適切ではありません。
|
||||
* `srcCurMalformed` - `source_currencies`フィールドのフォーマットが適切ではありません。
|
||||
* `srcIsrMalformed` - 要求の1つ以上の通貨オブジェクトの`issuer`フィールドが有効ではありません。
|
||||
|
||||
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
Reference in New Issue
Block a user