Merge remote-tracking branch 'upstream/master' into ja-credentials

This commit is contained in:
tequ
2025-04-09 18:17:48 +09:00
102 changed files with 5548 additions and 113 deletions

View File

@@ -25,6 +25,7 @@ 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 %} |
| `ledger_hash` | 文字列 | _省略可_ 使用するレジャーバージョンの20バイトの16進数の文字列。[レジャーの指定][]をご覧ください。 |
| `ledger_index` | 文字列 または 符号なし整数 | _省略可_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列("validated"や"closed"、"current"など)。([レジャーの指定][]をご覧ください。 |
| `include_deleted` | 真偽値 | _(省略可, Clioサーバのみ)_ クエリされたオブジェクトが削除されている場合、その完全なデータを削除前の状態で返します。`false`または提供されていない場合、クエリされたオブジェクトが削除されている場合は`objectNotFound`を返します。 |
`generator``ledger`パラメータは非推奨であり、予告なく削除される可能性があります。
@@ -40,6 +41,7 @@ label:
- [Credentialエントリを取得する](#credentialエントリを取得する)
- [Directorynodeエントリを取得する](#directorynodeエントリを取得する)
- [Offerエントリを取得する](#offerエントリを取得する)
- [Oracleエントリを取得する](#oracleエントリを取得する)
- [RippleStateエントリを取得する](#ripplestateエントリを取得する)
- [Checkエントリを取得する](#checkエントリを取得する)
- [Escrowエントリを取得する](#escrowエントリを取得する)
@@ -47,6 +49,8 @@ label:
- [DepositPreauthエントリを取得する](#depositpreauthエントリを取得する)
- [Ticketエントリを取得する](#ticketエントリを取得する)
- [Nft Pageを取得する](#nft-pageを取得する)
- [MPT Issuanceオブジェクトを取得する](#mpt-issuanceオブジェクトを取得する)
- [MPTokenオブジェクトを取得する](#mptokenオブジェクトを取得する)
- [レスポンスのフォーマット](#レスポンスのフォーマット)
- [考えられるエラー](#考えられるエラー)
@@ -459,6 +463,60 @@ rippled json ledger_entry '{ "offer": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJY
{% try-it method="ledger_entry-offer" /%}
### Oracleエントリを取得する
_([PriceOracle amendment][]が必要です)_
[Oracleエントリ](../../../protocol/ledger-data/ledger-entry-types/oracle.md)を取得します。これは、トークン価格を保存できる単一の価格オラクルを表します。
| フィールド | 型 | 必須? | 説明 |
|-----------------------------|----------------------|-------|------|
| `oracle` | Object | はい | オラクルの識別子。 |
| `oracle.account` | String - [Address][] | はい | `Oracle`オブジェクトを制御するアカウント。 |
| `oracle.oracle_document_id` | Number | はい | `Account`のオラクルの一意の識別子。 |
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "example_get_oracle",
"command": "ledger_entry",
"oracle" : {
"account": "rNZ9m6AP9K7z3EVg6GhPMx36V4QmZKeWds",
"oracle_document_id": 34
},
"ledger_index": "validated"
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
{
"method": "ledger_entry",
"params" : [
{
"oracle" : {
"account": "rNZ9m6AP9K7z3EVg6GhPMx36V4QmZKeWds",
"oracle_document_id": 34
},
"ledger_index": "validated"
}
]
}
```
{% /tab %}
{% tab label="Commandline" %}
```sh
rippled json ledger_entry '{ "oracle": { "account": "rNZ9m6AP9K7z3EVg6GhPMx36V4QmZKeWds", "oracle_document_id": 34 }, "ledger_index": "validated" }'
```
{% /tab %}
{% /tabs %}
[試してみる >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#ledger_entry-oracle)
### RippleStateエントリを取得する
@@ -823,18 +881,121 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
{% try-it method="ledger_entry-nft-page" /%}
## レスポンスのフォーマット
### MPT Issuanceオブジェクトを取得する
レスポンスは[標準フォーマット][]に従って、成功結果には以下のフィールドが含まれます。
_([MPTokensV1 amendment][]が必要です。 {% not-enabled /%})_
| フィールド | 型 | 説明 |
`MPTokenIssuance`オブジェクトを返します。
| フィールド | 型 | 説明 |
|:------------------------|:-------|:---------------|
| `mpt_issuance` | 文字列 | 192ビットの`MPTokenIssuanceID`を16進文字列で指定。 |
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "example_get_mpt_issuance",
"command": "ledger_entry",
"mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E",
"ledger_index": "validated"
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
{
"method": "ledger_entry",
"params": [{
"mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E",
"ledger_index": "validated"
}]
}
```
{% /tab %}
{% tab label="Commandline" %}
```sh
rippled json ledger_entry '{ "mpt_issuance": "000004C463C52827307480341125DA0577DEFC38405B0E3E", "ledger_index": "validated" }'
```
{% /tab %}
{% /tabs %}
<!-- TODO: add try-it for MPT issuance
[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-mpt_issuance)
-->
### MPTokenオブジェクトを取得する
_([MPTokensV1 amendment][]が必要です。 {% not-enabled /%})_
`MPToken`オブジェクトを返します。
| フィールド | 型 | 説明 |
|:------------------------|:-------------------------|:----------------------|
| `mptoken` | オブジェクトまたは文字列 | 文字列の場合、取得するMPTokenのレジャーエントリIDとして解釈します。オブジェクトの場合、`MPToken`を一意に識別するために、`account``mpt_issuance_id`のサブフィールドが必要です。 |
| mptoken.mpt_issuance_id | 文字列 | (`MPToken`がオブジェクトの場合必須) MPTokenIssuanceに紐づく192ビットのMPTokenIssuanceID。 |
| mptoken.account | 文字列 | (`MPToken`がオブジェクトの場合必須) MPTokenの所有者のアカウント。 |
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": "example_get_mpt_issuance",
"command": "ledger_entry",
"mptoken": {
"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D",
"account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"
}
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
{
"method": "ledger_entry",
"params": [
{
"mptoken":{
"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D",
"account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"
}
}
]
}
```
{% /tab %}
{% tab label="Commandline" %}
```sh
rippled json ledger_entry '{ "mptoken": {"mpt_issuance_id": "000002DFA4D893CFBC4DC6AE877EB585F90A3B47528B958D", "account":"r33kves44ksufkHSGg3M6GPPAsoVHEN8C1"} }'
```
{% /tab %}
{% /tabs %}
<!-- TODO: make a try-it link for MPT object
[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-mptoken)
-->
## レスポンスフォーマット
レスポンスは[標準フォーマット][]に従い、成功した結果には次のフィールドが含まれます。
| フィールド | 型 | 説明 |
|:---------------|:-----------------|:-----------------------------------------|
| `index` | 文字列 | [レジャーエントリ](../../../protocol/ledger-data/ledger-entry-types/index.md)の一意のID。 |
| `ledger_index` | 符号なし整数 | このデータを取得する際に使用したレジャーの [レジャーインデックス][]。 |
| `node` | オブジェクト | _(`"binary": true`が指定されている場合、省略)_ [レジャーフォーマット][]に基づいた、このレジャーエントリのデータを含むエントリ。 |
| `node_binary` | 文字列 | _(`"binary": true`が指定されていない場合、省略)_ レジャーエントリの[バイナリ形式](../../../protocol/binary-format.md)を16進数で表したもの。 |
| `deleted_ledger_index` | 文字列 | _(Clioサーバのみ, `include_deleted`パラメータが設定されている場合のみ)_ レジャーエントリオブジェクトが削除された[レジャーインデックス][]。 |
処理が成功したレスポンスの例:
成功したレスポンスの例:
{% tabs %}
@@ -904,7 +1065,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0
```
{% /tab %}
{% tab label="コマンドライン" %}
{% tab label="Commandline" %}
```json
{
"result": {

View File

@@ -0,0 +1,160 @@
---
blurb: 指定された`MPTokenIssuanceID`とledgerシーケンスに対する所有者の情報を取得します。
labels:
- アカウント
- XRP
---
# mpt_holders
{% partial file="/@l10n/ja/docs/_snippets/mpts-disclaimer.md" /%}
指定された`MPTokenIssuanceID`とレジャーシーケンスに対して、`mpt_holders`はそのMPTの全所有者とその残高を返します。このメソッドは非常に大きなデータセットを返す可能性があるため、`marker`フィールドを使用したページングの実装が必要になると考えられます。このAPIはClioでのみ利用可能で、rippledでは利用できません。
## リクエストのフォーマット
*Websocket*
```json
{
"command": "mpt_holders",
"mpt_issuance_id": "00070C4495F14B0E44F78A264E41713C64B5F89242540EE255534400000000000000",
"ledger_index": "validated"
}
```
*JSON-RPC*
```json
{
"method": "mpt_holders",
"params": [
{
"mpt_issuance_id": "00070C4495F14B0E44F78A264E41713C64B5F89242540EE255534400000000000000",
"ledger_index": "validated"
}
]
}
```
リクエストには以下のパラメータが含まれます。
| フィールド | 型 | 必須? | 説明 |
|:------------------|:----------------------|:----------|-------------|
| `mpt_issuance_id` | 文字列 | はい | クエリ対象の`MPTokenIssuance`。 |
| `ledger_index` | 文字列または数値(正の整数) | いいえ | 使用する最大のレジャーインデックス、または自動的にレジャーを選択するためのショートカット文字列。ledger_indexまたはledger_hashのいずれかを指定する必要があります。 |
| `ledger_hash` | 文字列 | いいえ | 使用する32バイトのレジャーハッシュ。ledger_indexまたはledger_hashのいずれかを指定する必要があります。 |
| `marker` | 文字列 | いいえ | ページングで中断したクエリを続けるために使用します。 |
| `limit` | 数値(正の整数) | いいえ | 返されるMPTの数の制限を指定します。 |
## レスポンスのフォーマット
```json
{
"mpt_issuance_id": "000004C463C52827307480341125DA0577DEFC38405B0E3E",
"limit":50,
"ledger_index": 2,
"mptokens": [{
"account": "rEiNkzogdHEzUxPfsri5XSMqtXUixf2Yx",
"flags": 0,
"mpt_amount": "20",
"mptoken_index": "36D91DEE5EFE4A93119A8B84C944A528F2B444329F3846E49FE921040DE17E65"
},
{
"account": "rrnAZCqMahreZrKMcZU3t2DZ6yUndT4ubN",
"flags": 0,
"mpt_amount": "1",
"mptoken_index": "D137F2E5A5767A06CB7A8F060ADE442A30CFF95028E1AF4B8767E3A56877205A"
}],
"validated": true
}
```
### レスポンスのフィールド
レスポンスは[標準フォーマット][]に従い、結果に以下のフィールドが含まれます。
| フィールド | 型 | 説明 |
|:--------------------|:--------|:----------------------------------------|
| `mpt_issuance_id` | 文字列 | クエリされた`MPTokenIssuance` |
| `mptokens` | 配列 | mptokenの配列。基礎となるMPTokenオブジェクトの全ての関連フィールドを含みます。 |
| `marker` | 文字列 | ページング時に次のクエリを続けるために使用します。この結果の後にエントリがない場合は省略されます。 |
| `limit` | 数値 | リクエストで指定された制限値 |
| `ledger_index` | 数値 | 使用されたレジャーインデックス。 |
`mptoken`オブジェクトには以下のパラメータがあります。
| フィールド | 型 | 説明 |
|:--------------------|:--------|:----------------------------------------|
| `account` | 文字列 | `MPToken`を所有するホルダーのアカウントアドレス。 |
| `flags` | 数値 | `MPToken`オブジェクトに割り当てられたフラグ。 |
| `mpt_amount` | 文字列 | ホルダーの残高を10進数でエンコードした量。 |
| `mptoken_index` | 文字列 | `MPToken`オブジェクトのキー。 |
##### 例
`tx`レスポンスの例:
```json
{
"result": {
"Account": "rBT9cUqK6UvpvZhPFNQ2qpUTin8rDokBeL",
"AssetScale": 2,
"Fee": "10",
"Flags": 64,
"Sequence": 303,
"SigningPubKey": "ED39955DEA2D083C6CBE459951A0A84DB337925389ACA057645EE6E6BA99D4B2AE",
"TransactionType": "MPTokenIssuanceCreate",
"TxnSignature": "80D7B7409980BE9854F7217BB8E836C8A2A191E766F24B5EF2EA7609E1420AABE6A1FDB3038468679081A45563B4D0B49C08F4F70F64E41B578F288A208E4206",
"ctid": "C000013100000000",
"date": 760643692,
"hash": "E563D7942E3E4A79AD73EC12E9E4C44B7C9950DF7BF5FDB75FAD0F5CE0554DB3",
"inLedger": 305,
"ledger_index": 305,
"meta": {
"AffectedNodes": [...],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS",
"mpt_issuance_id": "0000012F72A341F09A988CDAEA4FF5BE31F25B402C550ABE"
},
"status": "success",
"validated": true
}
}
```
##### オブジェクト
`mpt_issuance_id`フィールドはJSON MPTokenIssuanceオブジェクトで提供されます(バイナリでは利用できません)。次ののAPIが影響を受けます、`ledger_data`および`account_objects`
##### 例
`account_objects`のレスポンス例
```json
{
"result": {
"account": "rBT9cUqK6UvpvZhPFNQ2qpUTin8rDokBeL",
"account_objects": [
{
"AssetScale": 2,
"Flags": 64,
"Issuer": "rBT9cUqK6UvpvZhPFNQ2qpUTin8rDokBeL",
"LedgerEntryType": "MPTokenIssuance",
"OutstandingAmount": "100",
"OwnerNode": "0",
"PreviousTxnID": "BDC5ECA6B115C74BF4DA83E36325A2F55DF9E2C968A5CC15EB4D009D87D5C7CA",
"PreviousTxnLgrSeq": 308,
"Sequence": 303,
"index": "75EC6F2939ED6C5798A5F369A0221BC4F6DDC50F8614ECF72E3B976351057A63",
"mpt_issuance_id": "0000012F72A341F09A988CDAEA4FF5BE31F25B402C550ABE"
}
],
"ledger_current_index": 309,
"status": "success",
"validated": false
}
}
```