mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 11:45:50 +00:00
[JA] credentials
This commit is contained in:
tequ
@@ -2,7 +2,7 @@
|
||||
html: ledger_entry.html
|
||||
parent: ledger-methods.html
|
||||
seo:
|
||||
description: XRP Ledgerの1つのレジャーオブジェクトを生フォーマットで返します。
|
||||
description: XRP Ledgerの1つのレジャーエントリを生フォーマットで返します。
|
||||
label:
|
||||
- ブロックチェーン
|
||||
- データ保持
|
||||
@@ -10,7 +10,7 @@ label:
|
||||
# ledger_entry
|
||||
[[ソース]](https://github.com/xrplf/rippled/blob/master/src/ripple/rpc/handlers/LedgerEntry.cpp "Source")
|
||||
|
||||
`ledger_entry`メソッドは、XRP Ledgerの1つのレジャーオブジェクトを生フォーマットで返します。取得可能な各種オブジェクトについては、[レジャーフォーマット][]をご覧ください。
|
||||
`ledger_entry`メソッドは、XRP Ledgerの1つのレジャーエントリを生フォーマットで返します。取得可能な各種エントリについては、[レジャーフォーマット][]をご覧ください。
|
||||
|
||||
## リクエストのフォーマット
|
||||
|
||||
@@ -22,29 +22,30 @@ label:
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:------------------------|:-----------------------|:----------------------|
|
||||
| `binary` | ブール値 | _（省略可）_ `true`の場合、リクエストしたレジャーオブジェクトの内容がXRP Ledgerの[バイナリ形式](../../../protocol/binary-format.md)の16進数の文字列として返されます。それ以外の場合はデータがJSONフォーマットで返されます。デフォルトは`false`です。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.0" %}更新: rippled 1.2.0{% /badge %} |
|
||||
| `binary` | ブール値 | _（省略可）_ `true`の場合、リクエストしたレジャーエントリの内容がXRP Ledgerの[バイナリ形式](../../../protocol/binary-format.md)の16進数の文字列として返されます。それ以外の場合はデータがJSONフォーマットで返されます。デフォルトは`false`です。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.0" %}更新: rippled 1.2.0{% /badge %} |
|
||||
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの20バイトの16進数の文字列。（[レジャーの指定][]をご覧ください。 |
|
||||
| `ledger_index` | 文字列 または 符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列("validated"や"closed"、"current"など)。（[レジャーの指定][]をご覧ください。 |
|
||||
|
||||
`generator`と`ledger`パラメータは非推奨であり、予告なく削除される可能性があります。
|
||||
|
||||
上記の一般的なフィールドに加えて、オブジェクトを取得するタイプを示すために、以下のフィールドのうち *正確に1つ* を指定する必要があります。有効なフィールドは以下のとおりです。
|
||||
上記の一般的なフィールドに加えて、エントリを取得するタイプを示すために、以下のフィールドのうち *正確に1つ* を指定する必要があります。有効なフィールドは以下のとおりです。
|
||||
|
||||
- [ledger\_entry](#ledger_entry)
|
||||
- [リクエストのフォーマット](#リクエストのフォーマット)
|
||||
- [一般的なフィールド](#一般的なフィールド)
|
||||
- [IDからレジャーオブジェクトを取得する](#idからレジャーオブジェクトを取得する)
|
||||
- [AccountRootオブジェクトを取得する](#accountrootオブジェクトを取得する)
|
||||
- [AMMオブジェクトを取得する](#ammオブジェクトを取得する)
|
||||
- [Bridgeオブジェクトを取得する](#bridgeオブジェクトを取得する)
|
||||
- [Directorynodeオブジェクトを取得する](#directorynodeオブジェクトを取得する)
|
||||
- [Offerオブジェクトを取得する](#offerオブジェクトを取得する)
|
||||
- [RippleStateオブジェクトを取得する](#ripplestateオブジェクトを取得する)
|
||||
- [Checkオブジェクトを取得する](#checkオブジェクトを取得する)
|
||||
- [Escrowオブジェクトを取得する](#escrowオブジェクトを取得する)
|
||||
- [Paychannelオブジェクトを取得する](#paychannelオブジェクトを取得する)
|
||||
- [DepositPreauthオブジェクトを取得する](#depositpreauthオブジェクトを取得する)
|
||||
- [Ticketオブジェクトを取得する](#ticketオブジェクトを取得する)
|
||||
- [IDからレジャーエントリを取得する](#idからレジャーオントリを取得する)
|
||||
- [AccountRootエントリを取得する](#accountrootエントリを取得する)
|
||||
- [AMMエントリを取得する](#ammエントリを取得する)
|
||||
- [Bridgeエントリを取得する](#bridgeエントリを取得する)
|
||||
- [Credentialエントリを取得する](#credentialエントリを取得する)
|
||||
- [Directorynodeエントリを取得する](#directorynodeエントリを取得する)
|
||||
- [Offerエントリを取得する](#offerエントリを取得する)
|
||||
- [RippleStateエントリを取得する](#ripplestateエントリを取得する)
|
||||
- [Checkエントリを取得する](#checkエントリを取得する)
|
||||
- [Escrowエントリを取得する](#escrowエントリを取得する)
|
||||
- [Paychannelエントリを取得する](#paychannelエントリを取得する)
|
||||
- [DepositPreauthエントリを取得する](#depositpreauthエントリを取得する)
|
||||
- [Ticketエントリを取得する](#ticketエントリを取得する)
|
||||
- [Nft Pageを取得する](#nft-pageを取得する)
|
||||
- [レスポンスのフォーマット](#レスポンスのフォーマット)
|
||||
- [考えられるエラー](#考えられるエラー)
|
||||
@@ -52,13 +53,14 @@ label:
|
||||
{% admonition type="warning" name="注意" %}リクエストでこれらの型固有のフィールドを1つ以上指定した場合、サーバはそのうちの1つだけの結果を取得します。サーバがどれを選択するかは定義されていないため、こうした指定方法は避けるべきです。{% /admonition %}
|
||||
|
||||
|
||||
### IDからレジャーオブジェクトを取得する
|
||||
### IDからレジャーエントリを取得する
|
||||
<a id="idからレジャーオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
ユニークな ID を使用して、任意のタイプのレジャーオブジェクトを取得します。
|
||||
ユニークな ID を使用して、任意のタイプのレジャーエントリを取得します。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:---------|:-------|:----------------------------------------------------------|
|
||||
| `index` | 文字列 | レジャーから取得する1オブジェクトの[オブジェクトID](../../../protocol/ledger-data/common-fields.md)を、64文字(256ビット)の16進数の文字列。 |
|
||||
| `index` | 文字列 | レジャーから取得する1エントリの[レジャーエントリID](../../../protocol/ledger-data/common-fields.md)を、64文字(256ビット)の16進数の文字列。 |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -97,7 +99,7 @@ rippled json ledger_entry '{ "index": "7DB0788C020F02780A673DC74757F23823FA3014C
|
||||
[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-by-object-id)
|
||||
|
||||
{% admonition type="success" name="ヒント" %}
|
||||
このタイプのリクエストは、レジャーデータにシングルトンオブジェクトが存在する場合、そのIDは常に同一であるため、任意のシングルトンオブジェクトを取得するために使用できます。たとえば
|
||||
このタイプのリクエストは、レジャーデータにシングルトンエントリが存在する場合、そのIDは常に同一であるため、任意のシングルトンエントリを取得するために使用できます。たとえば
|
||||
|
||||
- [`Amendments`](../../../protocol/ledger-data/ledger-entry-types/amendments.md) - `7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4`
|
||||
- [`FeeSettings`](../../../protocol/ledger-data/ledger-entry-types/feesettings.md) - `4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651`
|
||||
@@ -107,13 +109,14 @@ rippled json ledger_entry '{ "index": "7DB0788C020F02780A673DC74757F23823FA3014C
|
||||
|
||||
|
||||
|
||||
### AccountRootオブジェクトを取得する
|
||||
### AccountRootエントリを取得する
|
||||
<a id="accountrootオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
アドレスから[AccountRootオブジェクト](../../../protocol/ledger-data/ledger-entry-types/accountroot.md)を取得します。これは[account_infoメソッド][]とほぼ同じです。
|
||||
アドレスから[AccountRootエントリ](../../../protocol/ledger-data/ledger-entry-types/accountroot.md)を取得します。これは[account_infoメソッド][]とほぼ同じです。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:----------- ---|:--------------------|:----------------------|
|
||||
| `account_root` | 文字列 - [アドレス][] | 取得する[AccountRootオブジェクト](../../../protocol/ledger-data/ledger-entry-types/accountroot.md)の標準アドレス。 |
|
||||
| `account_root` | 文字列 - [アドレス][] | 取得する[AccountRootエントリ](../../../protocol/ledger-data/ledger-entry-types/accountroot.md)の標準アドレス。 |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -154,17 +157,18 @@ rippled json ledger_entry '{ "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
|
||||
|
||||
|
||||
|
||||
### AMMオブジェクトを取得する
|
||||
### AMMエントリを取得する
|
||||
<a id="ammオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
_([AMM amendment][]により追加されました。)_
|
||||
|
||||
レジャーからAutomated Market-Maker(AMM)オブジェクトを取得します。これは[amm_infoメソッド][]と似ていますが、`ledger_entry`は保存されているレジャーエントリのみを返します。
|
||||
レジャーからAutomated Market-Maker(AMM)エントリを取得します。これは[amm_infoメソッド][]と似ていますが、`ledger_entry`は保存されているレジャーエントリのみを返します。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:-------------|:---------------------|:----------------------|
|
||||
| `amm` | オブジェクトまたは文字列 | 取得する[AMM](../../../protocol/ledger-data/ledger-entry-types/amm.md)。文字列を指定する場合は、AMMの[オブジェクトID](../../../protocol/ledger-data/common-fields.md)を16進数で指定しなければなりません。オブジェクトを指定する場合は、`asset`と`asset2`のサブフィールドを含む必要があります。 |
|
||||
| `amm.asset` | オブジェクト | このAMMのプールにある2つの資産のうちのひとつを、[金額なしの通貨オブジェクト](../../../protocol/data-types/currency-formats.md#金額なしでの通貨の指定)として指定します。 |
|
||||
| `amm.asset2` | オブジェクト | このAMMのプールにある2つの資産のうちのもうひとつを、[金額なしの通貨オブジェクト](../../../protocol/data-types/currency-formats.md#金額なしでの通貨の指定)として指定します。 |
|
||||
| `amm` | オブジェクトまたは文字列 | 取得する[AMM](../../../protocol/ledger-data/ledger-entry-types/amm.md)。文字列を指定する場合は、AMMの[レジャーエントリID](../../../protocol/ledger-data/common-fields.md)を16進数で指定しなければなりません。エントリを指定する場合は、`asset`と`asset2`のサブフィールドを含む必要があります。 |
|
||||
| `amm.asset` | オブジェクト | このAMMのプールにある2つの資産のうちのひとつを、[金額なしの通貨エントリ](../../../protocol/data-types/currency-formats.md#金額なしでの通貨の指定)として指定します。 |
|
||||
| `amm.asset2` | オブジェクト | このAMMのプールにある2つの資産のうちのもうひとつを、[金額なしの通貨エントリ](../../../protocol/data-types/currency-formats.md#金額なしでの通貨の指定)として指定します。 |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -220,7 +224,8 @@ rippled json ledger_entry '{ "amm": { "asset": { "currency": "XRP" }, "asset2":
|
||||
[試してみる >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#ledger_entry-amm)
|
||||
|
||||
|
||||
### Bridgeオブジェクトを取得する
|
||||
### Bridgeエントリを取得する
|
||||
<a id="bridgeオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
_([XChainBridge amendment][]が必要です {% not-enabled /%})_
|
||||
|
||||
@@ -290,14 +295,67 @@ rippled json ledger_entry '{ "bridge_account": "rnQAXXWoFNN6PEqwqsdTngCtFPCrmfuq
|
||||
[試してみよう! >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#ledger_entry-bridge)
|
||||
|
||||
|
||||
### Credentialエントリを取得する
|
||||
|
||||
### DirectoryNodeオブジェクトを取得する
|
||||
[Credentialエントリ](../../../protocol/ledger-data/ledger-entry-types/credential.md)を取得します。
|
||||
|
||||
他のレジャーオブジェクトのリストを含む[DirectoryNode](../../../protocol/ledger-data/ledger-entry-types/directorynode.md)を取得します。文字列(DirectoryのオブジェクトID)またはオブジェクトを指定します。
|
||||
| フィールド | 型 | 必須? | 説明 |
|
||||
| :--------------------------- | :------------------------- | :---- | ---- |
|
||||
| `credential` | オブジェクト または 文字列 | はい | 取得する[Credentialエントリ](../../../protocol/ledger-data/ledger-entry-types/credential.md)を指定します。文字列の場合は、エントリの[レジャーエントリID](../../../protocol/ledger-data/common-fields.md)を16進数で指定します。オブジェクトの場合は、`subject`, `issuer`, `credential_type`のサブフィールドが必要です。 |
|
||||
| `credential.subject` | 文字列 - [Address][] | はい | 資格情報の対象となるアカウント。 |
|
||||
| `credential.issuer` | 文字列 - [Address][] | はい | 資格情報を発行したアカウント。 |
|
||||
| `credential.credential_type` | 文字列 - 16進数文字列 | はい | 資格情報の種類。 |
|
||||
|
||||
WebSocket:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "example_get_credential",
|
||||
"command": "ledger_entry",
|
||||
"credential": {
|
||||
"subject": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"issuer": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"credential_type": "6D795F63726564656E7469616C"
|
||||
},
|
||||
"ledger_index": "validated"
|
||||
}
|
||||
```
|
||||
|
||||
JSON-RPC:
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "ledger_entry",
|
||||
"params": [{
|
||||
"credential": {
|
||||
"subject": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"issuer": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"credential_type": "6D795F63726564656E7469616C"
|
||||
},
|
||||
"ledger_index": "validated"
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
Commandline:
|
||||
|
||||
```bash
|
||||
rippled json ledger_entry '{ "credential": {"subject": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8", "issuer": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX","credential_type": "6D795F63726564656E7469616C"}, "ledger_index": "validated" }'
|
||||
```
|
||||
|
||||
<!-- TODO: create working example in tool
|
||||
[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-credential)
|
||||
-->
|
||||
|
||||
|
||||
### DirectoryNodeエントリを取得する
|
||||
<a id="directorynodeオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
他のレジャーエントリのリストを含む[DirectoryNode](../../../protocol/ledger-data/ledger-entry-types/directorynode.md)を取得します。文字列(DirectoryのレジャーエントリID)またはオブジェクトを指定します。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:------------------------|:---------------------------|:----------------------|
|
||||
| `directory` | オブジェクト または 文字列 | 取得する[DirectoryNode](../../../protocol/ledger-data/ledger-entry-types/directorynode.md)。文字列の場合は、ディレクトリの[オブジェクトID](../../../protocol/ledger-data/common-fields.md)を16進数で指定します。オブジェクトの場合は、サブフィールドとして`dir_root`または`owner`が必要で、オプションとして`sub_index`サブフィールドを指定可能です。 |
|
||||
| `directory` | オブジェクト または 文字列 | 取得する[DirectoryNode](../../../protocol/ledger-data/ledger-entry-types/directorynode.md)。文字列の場合は、ディレクトリの[レジャーエントリID](../../../protocol/ledger-data/common-fields.md)を16進数で指定します。オブジェクトの場合は、サブフィールドとして`dir_root`または`owner`が必要で、オプションとして`sub_index`サブフィールドを指定可能です。 |
|
||||
| `directory.sub_index` | 符号なし整数 | _(省略可)_ 指定された場合、その"ページ"以降の[DirectoryNode](../../../protocol/ledger-data/ledger-entry-types/directorynode.md)にジャンプします。 |
|
||||
| `directory.dir_root` | 文字列 | _(省略可)_ 取得するディレクトリを表す一意のインデックス。 |
|
||||
| `directory.owner` | 文字列 | _(省略可)_ このディレクトリに関連付けられているアカウントの一意のアドレス。 |
|
||||
@@ -347,15 +405,16 @@ rippled json ledger_entry '{ "directory": { "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwu
|
||||
|
||||
|
||||
|
||||
### Offerオブジェクトを取得する
|
||||
### Offerエントリを取得する
|
||||
<a id="offerオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
通貨交換のオファーを定義した [Offer オブジェクト](../../../protocol/ledger-data/ledger-entry-types/offer.md) を取得します。文字列 (オファーの一意なインデックス) あるいはオブジェクトを指定します。
|
||||
通貨交換のオファーを定義した [Offer エントリ](../../../protocol/ledger-data/ledger-entry-types/offer.md) を取得します。文字列 (オファーの一意なインデックス) あるいはオブジェクトを指定します。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:------------------------|:---------------------------|:----------------------|
|
||||
| `offer` | オブジェクトまたは 文字列 | 取得する[オファーオブジェクト](../../../protocol/ledger-data/ledger-entry-types/offer.md)。文字列の場合、オファーに対する[一意のオブジェクトID](../../../protocol/ledger-data/common-fields.md)を指定します。オブジェクトの場合、オファーを一意に識別するためのサブフィールド`account`と`seq`を指定します。 |
|
||||
| `offer` | オブジェクトまたは 文字列 | 取得する[オファーエントリ](../../../protocol/ledger-data/ledger-entry-types/offer.md)。文字列の場合、オファーに対する[一意のレジャーエントリID](../../../protocol/ledger-data/common-fields.md)を指定します。レジャーエントリの場合、オファーを一意に識別するためのサブフィールド`account`と`seq`を指定します。 |
|
||||
| `offer.account` | 文字列 - [アドレス][] | _(`offer`がオブジェクト形式で指定されている場合、必須)_ オファーを作成したアカウント。 |
|
||||
| `offer.seq` | 符号なし整数 | _(`offer`がオブジェクト形式で指定されている場合、必須)_ オファーオブジェクトを作成したトランザクションの[シーケンス番号][]。 |
|
||||
| `offer.seq` | 符号なし整数 | _(`offer`がオブジェクト形式で指定されている場合、必須)_ オファーエントリを作成したトランザクションの[シーケンス番号][]。 |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -402,15 +461,16 @@ rippled json ledger_entry '{ "offer": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJY
|
||||
|
||||
|
||||
|
||||
### RippleStateオブジェクトを取得する
|
||||
### RippleStateエントリを取得する
|
||||
<a id="ripplestateオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
2つのアカウント間の（XRP以外の）通貨残高を追跡する[RippleStateオブジェクト](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md)を取得します。
|
||||
2つのアカウント間の（XRP以外の）通貨残高を追跡する[RippleStateエントリ](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md)を取得します。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:------------------------|:---------------------------|:----------------------|
|
||||
| `ripple_state` | オブジェクト | 取得するRippleState(trust line)オブジェクトを指定するオブジェクト。取得するRippleStateエントリを一意に指定するには、`accounts`と`currency`のサブフィールドが必要です。 |
|
||||
| `ripple_state.accounts` | 配列 | _(`ripple_state`が指定されている場合、必須)_ この[RippleStateオブジェクト](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md)によってリンクされた2つのアカウントを長さ2の配列で指定します。 |
|
||||
| `ripple_state.currency` | 文字列 | _(`ripple_state`が指定されている場合、必須)_ 取得する[RippleStateオブジェクト](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md)の[通貨コード][]を指定します。 |
|
||||
| `ripple_state` | オブジェクト | 取得するRippleState(trust line)エントリを指定するレジャーエントリ。取得するRippleStateエントリを一意に指定するには、`accounts`と`currency`のサブフィールドが必要です。 |
|
||||
| `ripple_state.accounts` | 配列 | _(`ripple_state`が指定されている場合、必須)_ この[RippleStateエントリ](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md)によってリンクされた2つのアカウントを長さ2の配列で指定します。 |
|
||||
| `ripple_state.currency` | 文字列 | _(`ripple_state`が指定されている場合、必須)_ 取得する[RippleStateエントリ](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md)の[通貨コード][]を指定します。 |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -461,13 +521,14 @@ rippled json ledger_entry '{ "ripple_state": { "accounts": ["rf1BiGeXwwQoi8Z2ueF
|
||||
|
||||
|
||||
|
||||
### Checkオブジェクトを取得する
|
||||
### Checkエントリを取得する
|
||||
<a id="checkオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
[Checkオブジェクト](../../../protocol/ledger-data/ledger-entry-types/check.md)を取得します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.0.0" %}新規: rippled 1.0.0{% /badge %}.
|
||||
[Checkエントリ](../../../protocol/ledger-data/ledger-entry-types/check.md)を取得します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.0.0" %}新規: rippled 1.0.0{% /badge %}.
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:---------|:------|:----------------------|
|
||||
| `check` | 文字列 | 取得する[Checkオブジェクト](../../../protocol/ledger-data/ledger-entry-types/check.md)の[オブジェクトID](../../../protocol/ledger-data/common-fields.md)。 |
|
||||
| `check` | 文字列 | 取得する[Checkエントリ](../../../protocol/ledger-data/ledger-entry-types/check.md)の[レジャーエントリID](../../../protocol/ledger-data/common-fields.md)。 |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -506,15 +567,16 @@ rippled json ledger_entry '{ "check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D79
|
||||
|
||||
|
||||
|
||||
### Escrowオブジェクトを取得する
|
||||
### Escrowエントリを取得する
|
||||
<a id="escrowオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
[Escrowオブジェクト](../../../protocol/ledger-data/ledger-entry-types/escrow.md)を取得します。文字列(エスクローのオブジェクトID)またはオブジェクトとして指定します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.0.0" %}新規: rippled 1.0.0{% /badge %}
|
||||
[Escrowエントリ](../../../protocol/ledger-data/ledger-entry-types/escrow.md)を取得します。文字列(エスクローのエントリID)またはオブジェクトとして指定します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.0.0" %}新規: rippled 1.0.0{% /badge %}
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:------------------------|:---------------------------|:----------------------|
|
||||
| `escrow` | オブジェクト または 文字列 | 取得する[Escrowオブジェクト](../../../protocol/ledger-data/ledger-entry-types/escrow.md)を指定します。文字列の場合は、エスクローの[オブジェクトID](../../../protocol/ledger-data/common-fields.md)を16進数で指定します。オブジェクトの場合、`owner`と`seq`サブフィールドを指定します。. |
|
||||
| `escrow.owner` | 文字列 - [アドレス][] | _(`escrow`がオブジェクト形式で指定されている場合、必須)_ Escrowオブジェクトの所有者（送信者）。 |
|
||||
| `escrow.seq` | 符号なし整数 | _(`escrow`がオブジェクト形式で指定されている場合、必須)_ エスクローオブジェクトを作成したトランザクションの[シーケンス番号][]。 |
|
||||
| `escrow` | オブジェクト または 文字列 | 取得する[Escrowエントリ](../../../protocol/ledger-data/ledger-entry-types/escrow.md)を指定します。文字列の場合は、エスクローの[レジャーエントリID](../../../protocol/ledger-data/common-fields.md)を16進数で指定します。オブジェクトの場合、`owner`と`seq`サブフィールドを指定します。. |
|
||||
| `escrow.owner` | 文字列 - [アドレス][] | _(`escrow`がオブジェクト形式で指定されている場合、必須)_ Escrowエントリの所有者（送信者）。 |
|
||||
| `escrow.seq` | 符号なし整数 | _(`escrow`がオブジェクト形式で指定されている場合、必須)_ エスクローエントリを作成したトランザクションの[シーケンス番号][]。 |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -559,13 +621,13 @@ rippled json ledger_entry '{ "escrow": { "owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9
|
||||
|
||||
|
||||
|
||||
### PayChannelオブジェクトを取得する
|
||||
|
||||
非同期決済用のXRPを保持する[PayChannelオブジェクト](../../../protocol/ledger-data/ledger-entry-types/paychannel.md)を取得します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.0.0" %}新規: rippled 1.0.0{% /badge %}.
|
||||
### PayChannelエントリを取得する
|
||||
<a id="paychannelオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
非同期決済用のXRPを保持する[PayChannelエントリ](../../../protocol/ledger-data/ledger-entry-types/paychannel.md)を取得します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.0.0" %}新規: rippled 1.0.0{% /badge %}.
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:------------------|:-------|:------------------------------------------------|
|
||||
| `payment_channel` | 文字列 | 取得する[PayChannelオブジェクト](../../../protocol/ledger-data/ledger-entry-types/paychannel.md)の[オブジェクトID](../../../protocol/ledger-data/common-fields.md)。 |
|
||||
| `payment_channel` | 文字列 | 取得する[PayChannelエントリ](../../../protocol/ledger-data/ledger-entry-types/paychannel.md)の[エントリID](../../../protocol/ledger-data/common-fields.md)。 |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -603,15 +665,24 @@ rippled json ledger_entry '{ "payment_channel": "C7F634794B79DB40E87179A9D1BF05D
|
||||
[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-paychannel)
|
||||
|
||||
|
||||
### DepositPreauthオブジェクトを取得する
|
||||
### DepositPreauthエントリを取得する
|
||||
<a id="depositpreauthオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
[DepositPreauthオブジェクト](../../../protocol/ledger-data/ledger-entry-types/depositpreauth.md)を取得します。このオブジェクトは、[Deposit Authorization](../../../../concepts/accounts/depositauth.md)を必要とする口座への支払いの事前承認を記録します。文字列（DepositPreauthのオブジェクトID）またはオブジェクトとして指定します。{% badge href="https://github.com/XRPLF/rippled/releases/tag/1.1.0" %}新規: rippled 1.1.0{% /badge %}.
|
||||
[DepositPreauthエントリ](../../../protocol/ledger-data/ledger-entry-types/depositpreauth.md)を取得します。このエントリは、[Deposit Authorization](../../../../concepts/accounts/depositauth.md)を必要とする口座への支払いの事前承認を記録します。文字列（DepositPreauthのエントリID）またはオブジェクトとして指定します。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:-----------------------------|:-----------------------|:-----------------------|
|
||||
| `deposit_preauth` | オブジェクト または 文字列 | 取得する[DepositPreauthオブジェクト](../../../protocol/ledger-data/ledger-entry-types/depositpreauth.md)を指定します。文字列の場合、DepositPreauthオブジェクトの[オブジェクトID](../../../protocol/ledger-data/common-fields.md)を16進数で指定します。オブジェクトの場合、`owner`と`authorized`のサブフィールドを指定します。 |
|
||||
| `deposit_preauth.owner` | 文字列 - [アドレス][] | _(`deposit_preauth`がオブジェクト形式で指定されている場合、必須)_ 事前承認を行ったアカウント。 |
|
||||
| `deposit_preauth.authorized` | 文字列 - [アドレス][] | _(`deposit_preauth`がオブジェクト形式で指定されている場合、必須)_ 事前承認を受けたアカウント。 |
|
||||
| フィールド | 型 | 必須? | 説明 |
|
||||
| :--------------------------------------- | :------------------------- | :----- | ---- |
|
||||
| `deposit_preauth` | オブジェクト または 文字列 | はい | 取得するDepositPreauthを指定します。文字列の場合は、DepositPreauthエントリの[レジャーエントリID][]を16進数で指定する必要があります。オブジェクトの場合は、`owner`サブフィールドと、`authorized`または`authorize_credentials`サブフィールドのいずれかが必要です。 |
|
||||
| `deposit_preauth.owner` | 文字列 - [アドレス][] | はい | 事前承認を行ったアカウント |
|
||||
| `deposit_preauth.authorized` | 文字列 - [アドレス][] | いいえ | 事前承認を受けたアカウント。 |
|
||||
| `deposit_preauth.authorized_credentials` | 配列 | いいえ | 事前承認を受けた資格情報のセット |
|
||||
|
||||
`deposit_preauth.authorized_credentials`配列の各メンバは、提供されている場合、次のネストされたフィールドを含める必要があります。
|
||||
|
||||
| フィールド | 型 | 必須? | 説明 |
|
||||
| :---------------- | :-------------------- | :---- | :--------------------------------- |
|
||||
| `issuer` | 文字列 - [アドレス][] | はい | 資格情報の発行アカウントのアドレス |
|
||||
| `credential_type` | 文字列 - 16進数 | はい | 発行された資格情報のタイプ |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -655,14 +726,15 @@ rippled json ledger_entry '{ "deposit_preauth": { "owner": "rf1BiGeXwwQoi8Z2ueFY
|
||||
[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-depositpreauth)
|
||||
|
||||
|
||||
### Ticketオブジェクトを取得する
|
||||
### Ticketエントリを取得する
|
||||
<a id="ticketオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
将来の使用のために確保された[シーケンス番号][]を表す[Ticketオブジェクト](../../../protocol/ledger-data/ledger-entry-types/ticket.md)を取得します。文字列(TicketのオブジェクトID)またはオブジェクトを指定します。 _([TicketBatch amendment][]により追加されました。)_
|
||||
将来の使用のために確保された[シーケンス番号][]を表す[Ticketエントリ](../../../protocol/ledger-data/ledger-entry-types/ticket.md)を取得します。文字列(TicketのエントリID)またはオブジェクトを指定します。 _([TicketBatch amendment][]により追加されました。)_
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:--------------------|:-----------------------|:----------------------|
|
||||
| `ticket` | オブジェクト または 文字列 | 取得する[Ticketオブジェクト](../../../protocol/ledger-data/ledger-entry-types/ticket.md)。文字列の場合、チケットの[オブジェクトID](../../../protocol/ledger-data/common-fields.md)を16進数で指定します。オブジェクトの場合、チケットエントリを一意に指定するために`account`と`ticket_seq`サブフィールドを指定します。 |
|
||||
| `ticket.account` | 文字列 - [アドレス][] | _(`ticket`がオブジェクト形式で指定されている場合、必須)_ Ticketオブジェクトの所有者を指定します。 |
|
||||
| `ticket` | エントリ または 文字列 | 取得する[Ticketエントリ](../../../protocol/ledger-data/ledger-entry-types/ticket.md)。文字列の場合、チケットの[レジャーエントリID](../../../protocol/ledger-data/common-fields.md)を16進数で指定します。オブジェクトの場合、チケットエントリを一意に指定するために`account`と`ticket_seq`サブフィールドを指定します。 |
|
||||
| `ticket.account` | 文字列 - [アドレス][] | _(`ticket`がオブジェクト形式で指定されている場合、必須)_ Ticketエントリの所有者を指定します。 |
|
||||
| `ticket.ticket_seq` | 数値 | _(`ticket`がオブジェクト形式で指定されている場合、必須)_ 取得するTicketのTicketシーケンス番号を指定します。 |
|
||||
|
||||
{% tabs %}
|
||||
@@ -708,12 +780,13 @@ rippled json ledger_entry '{ "ticket": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJ
|
||||
|
||||
|
||||
### NFT Pageを取得する
|
||||
<a id="nft-pageオブジェクトを取得する"></a><!-- legacy ID -->
|
||||
|
||||
NFT ページを生のレジャー形式で取得します。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:------------------------|:-------|:----------------------|
|
||||
| `nft_page` | 文字列 | 取得する[NFTページ](../../../protocol/ledger-data/ledger-entry-types/nftokenpage.md)の[オブジェクトID](../../../protocol/ledger-data/common-fields.md)。 |
|
||||
| `nft_page` | 文字列 | 取得する[NFTページ](../../../protocol/ledger-data/ledger-entry-types/nftokenpage.md)の[レジャーエントリID](../../../protocol/ledger-data/common-fields.md)。 |
|
||||
|
||||
{% tabs %}
|
||||
|
||||
@@ -756,10 +829,10 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:---------------|:-----------------|:-----------------------------------------|
|
||||
| `index` | 文字列 | [レジャーオブジェクト](../../../protocol/ledger-data/ledger-entry-types/index.md)の一意のID。 |
|
||||
| `index` | 文字列 | [レジャーエントリ](../../../protocol/ledger-data/ledger-entry-types/index.md)の一意のID。 |
|
||||
| `ledger_index` | 符号なし整数 | このデータを取得する際に使用したレジャーの [レジャーインデックス][]。 |
|
||||
| `node` | オブジェクト | _(`"binary": true`が指定されている場合、省略)_ [レジャーフォーマット][]に基づいた、この元帳オブジェクトのデータを含むオブジェクト。 |
|
||||
| `node_binary` | 文字列 | _(`"binary": true`が指定されていない場合、省略)_ レジャーオブジェクトの[バイナリ形式](../../../protocol/binary-format.md)を16進数で表したもの。 |
|
||||
| `node` | オブジェクト | _(`"binary": true`が指定されている場合、省略)_ [レジャーフォーマット][]に基づいた、このレジャーエントリのデータを含むエントリ。 |
|
||||
| `node_binary` | 文字列 | _(`"binary": true`が指定されていない場合、省略)_ レジャーエントリの[バイナリ形式](../../../protocol/binary-format.md)を16進数で表したもの。 |
|
||||
|
||||
処理が成功したレスポンスの例:
|
||||
|
||||
@@ -869,7 +942,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
|
||||
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `deprecatedFeature` - 削除されたフィールド（`generator`など）がリクエストに指定されていました。
|
||||
* `entryNotFound` - リクエストされたレジャーオブジェクトはレジャーに存在しません。
|
||||
* `entryNotFound` - リクエストされたレジャーエントリはレジャーに存在しません。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `malformedAddress` - リクエストの[アドレス][]フィールドが誤って指定されています。
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
---
|
||||
html: deposit_authorized.html
|
||||
parent: path-and-order-book-methods.html
|
||||
seo:
|
||||
description: あるアカウントに別のアカウントへ支払を直接送金する権限があるかどうかを示します。
|
||||
labels:
|
||||
@@ -24,6 +22,10 @@ labels:
|
||||
"command": "deposit_authorized",
|
||||
"source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
|
||||
"destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"credentials": [
|
||||
"A182EFBD154C9E80195082F86C1C8952FC0760A654B886F61BB0A59803B4387B",
|
||||
"383D269D6C7417D0A8716B09F5DB329FB17B45A5EFDBAFB82FF04BC420DCF7D5"
|
||||
],
|
||||
"ledger_index": "validated"
|
||||
}
|
||||
```
|
||||
@@ -37,6 +39,10 @@ labels:
|
||||
{
|
||||
"source_account": "rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de",
|
||||
"destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"credentials": [
|
||||
"A182EFBD154C9E80195082F86C1C8952FC0760A654B886F61BB0A59803B4387B",
|
||||
"383D269D6C7417D0A8716B09F5DB329FB17B45A5EFDBAFB82FF04BC420DCF7D5"
|
||||
],
|
||||
"ledger_index": "validated"
|
||||
}
|
||||
]
|
||||
@@ -45,23 +51,27 @@ labels:
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
|
||||
```bash
|
||||
#Syntax: deposit_authorized <source_account> <destination_account> [<ledger>]
|
||||
rippled deposit_authorized rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8 validated
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
リクエストには以下のパラメーターが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:----------------------|:---------------------------|:------------------------|
|
||||
| `source_account` | 文字列 - [アドレス][] | 発生し得る支払の送金元。 |
|
||||
| `destination_account` | 文字列 - [アドレス][] | 発生し得る支払の送金先。 |
|
||||
| `ledger_hash` | 文字列 | _（省略可）_ 使用するレジャーバージョンの32バイトの16進文字列。（[レジャーの指定][]をご覧ください） |
|
||||
| `ledger_index` | 文字列または符号なし整数 | _（省略可）_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。（[レジャーの指定][]をご覧ください） |
|
||||
| フィールド | 型 | 必須? | 説明 |
|
||||
| :-------------------- | :----------------------- | :----- | ---- |
|
||||
| `source_account` | 文字列 - [アドレス][] | はい | 発生し得る支払いの送金元。 |
|
||||
| `destination_account` | 文字列 - [アドレス][] | はい | 発生し得る支払いの送金先。 |
|
||||
| `ledger_hash` | [ハッシュ][] | いいえ | 使用するレジャーバージョンの32バイトの16進文字列。([レジャーの指定][]をご覧ください) |
|
||||
| `ledger_index` | [レジャーインデックス][] | いいえ | 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください) |
|
||||
| `credentials` | 配列 | いいえ | 送金元が送金先に送金できるかどうかを確認する際に考慮する資格情報のセット。配列の各メンバは、レジャーの[Credentialエントリ][]の一意のIDでなければなりません。空の配列は許可されません。 |
|
||||
|
||||
{% admonition type="info" name="注記" %}
|
||||
送金元が送金先に送金できるかどうかを確認する際に、送金先が事前承認した資格情報のセットと完全に一致しない資格情報のセットを提供した場合、送金は承認されません。この動作はトランザクション処理の動作と一致しています。
|
||||
{% /admonition %}
|
||||
|
||||
## レスポンスのフォーマット
|
||||
|
||||
@@ -74,6 +84,10 @@ rippled deposit_authorized rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de rsUiUMpnrgxQp24dJY
|
||||
{
|
||||
"id": 1,
|
||||
"result": {
|
||||
"credentials": [
|
||||
"A182EFBD154C9E80195082F86C1C8952FC0760A654B886F61BB0A59803B4387B",
|
||||
"383D269D6C7417D0A8716B09F5DB329FB17B45A5EFDBAFB82FF04BC420DCF7D5"
|
||||
],
|
||||
"deposit_authorized": true,
|
||||
"destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"ledger_hash": "BD03A10653ED9D77DCA859B7A735BF0580088A8F287FA2C5403E0A19C58EF322",
|
||||
@@ -91,6 +105,10 @@ rippled deposit_authorized rEhxGqkqPPSxQ3P25J66ft5TwpzV14k2de rsUiUMpnrgxQp24dJY
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"credentials": [
|
||||
"A182EFBD154C9E80195082F86C1C8952FC0760A654B886F61BB0A59803B4387B",
|
||||
"383D269D6C7417D0A8716B09F5DB329FB17B45A5EFDBAFB82FF04BC420DCF7D5"
|
||||
],
|
||||
"deposit_authorized": true,
|
||||
"destination_account": "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"ledger_hash": "BD03A10653ED9D77DCA859B7A735BF0580088A8F287FA2C5403E0A19C58EF322",
|
||||
@@ -110,6 +128,10 @@ Loading: "/etc/rippled.cfg"
|
||||
|
||||
{
|
||||
"result" : {
|
||||
"credentials": [
|
||||
"A182EFBD154C9E80195082F86C1C8952FC0760A654B886F61BB0A59803B4387B",
|
||||
"383D269D6C7417D0A8716B09F5DB329FB17B45A5EFDBAFB82FF04BC420DCF7D5"
|
||||
],
|
||||
"deposit_authorized" : true,
|
||||
"destination_account" : "rsUiUMpnrgxQp24dJYZDhmV4bE3aBtQyt8",
|
||||
"ledger_hash" : "BD03A10653ED9D77DCA859B7A735BF0580088A8F287FA2C5403E0A19C58EF322",
|
||||
@@ -121,30 +143,34 @@ Loading: "/etc/rippled.cfg"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
|
||||
|
||||
| `Field` | 型 | 説明 |
|
||||
|:-----------------------|:--------------------------|:------------------------|
|
||||
| `deposit_authorized` | ブール値 | 指定の支払元アカウントから支払先アカウントへの直接送金が承認されているかどうか。`true`の場合、支払先アカウントで[Deposit Authorization](../../../../concepts/accounts/depositauth.md)を必要としていないか、または支払元アカウントが事前承認されています。 |
|
||||
| `destination_account` | 文字列 - [アドレス][] | リクエストに指定されている宛先アカウント。 |
|
||||
| `ledger_hash` | 文字列 | _（省略される場合があります）_ このレスポンスの生成に使用されたレジャーの識別用ハッシュ。 |
|
||||
| `ledger_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 |
|
||||
| `ledger_current_index` | 数値 - [レジャーインデックス][] | _（省略される場合があります）_ このレスポンスの生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
|
||||
| `source_account` | 文字列 - [アドレス][] | リクエストに指定されている支払元アカウント。 |
|
||||
| `validated` | ブール値 | _（省略される場合があります）_`true`の場合、検証済みレジャーバージョンからの情報が取り込まれます。 |
|
||||
| フィールド | 型 | 必須? | 説明 |
|
||||
| :--------------------- | :------------------------------ | :---- | ---- |
|
||||
| `credentials` | [ハッシュ][]の配列 | No | リクエストに指定されている資格情報のセット。 |
|
||||
| `deposit_authorized` | 真偽値 | Yes | 指定の支払元アカウントが指定の支払先アカウントへの直接送金を承認されているかどうか。`true`の場合、支払先アカウントで[Deposit Authorization](../../../../concepts/accounts/depositauth.md)を必要としていないか、または支払元アカウントが事前承認されています。 |
|
||||
| `destination_account` | 文字列 - [アドレス][] | Yes | リクエストに指定されている宛先アカウント。 |
|
||||
| `ledger_hash` | 文字列 | No | このレスポンスの生成に使用されたレジャーの識別用ハッシュ。 |
|
||||
| `ledger_index` | 数値 - [レジャーインデックス][] | No | このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 |
|
||||
| `ledger_current_index` | 数値 - [レジャーインデックス][] | No | このレスポンスの生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
|
||||
| `source_account` | 文字列 - [アドレス][] | Yes | リクエストに指定されている支払元アカウント。 |
|
||||
| `validated` | 真偽値 | No | 検証済みレジャーバージョンからの情報が取り込まれます。 |
|
||||
|
||||
{% admonition type="info" name="注記" %}`deposit_authorized`ステータスが`true`でも、指定の支払元から指定の支払先への送金が可能であるとは保証されません。たとえば、支払先アカウントに指定通貨の[トラストライン](../../../../concepts/tokens/fungible-tokens/index.md)がない場合や、送金に十分な流動性がない場合があります。{% /admonition %}
|
||||
{% admonition type="info" name="注記" %}
|
||||
`deposit_authorized`ステータスが`true`でも、指定の支払元から指定の支払先への送金が可能であるとは保証されません。たとえば、支払先アカウントに指定通貨の[トラストライン](../../../../concepts/tokens/fungible-tokens/index.md)がない場合や、送金に十分な流動性がない場合があります。
|
||||
{% /admonition %}
|
||||
|
||||
## 考えられるエラー
|
||||
|
||||
* いずれかの[汎用エラータイプ][]。
|
||||
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
|
||||
* `actMalformed` - リクエストの`source_account`フィールドまたは`destination_account`フィールドに指定されている[アドレス][]のフォーマットが適切ではありません。（入力ミスが含まれていたり、長さが正しくない場合は、チェックサムは失敗します。）
|
||||
* `badCredentials` - 提供された資格情報の少なくとも1つが存在しない、期限切れである、または受け入れられていません。
|
||||
* `dstActNotFound` - リクエストの`destination_account`フィールドがレジャーのアカウントに対応していません。
|
||||
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
|
||||
* `srcActNotFound` - リクエストの`source_account`フィールドがレジャーのアカウントに対応していません。
|
||||
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
|
||||
Reference in New Issue
Block a user