ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-26 14:45:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/JakeatRipple/xrpl-dev-portal into feat-funding

Browse Source 
# Conflicts:
#	assets/css/devportal2022-v6.css
This commit is contained in:
Jake
2022-08-29 15:10:15 -07:00
parent 894de101ee 644feaecc5
commit 17e05fcc34
24 changed files with 1924 additions and 345 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
assets/css/devportal2022-v6.css
View File

File diff suppressed because one or more lines are too long

BIN
assets/img/community/community-design-assets.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 107 KiB

BIN
content/XRPL_Logo_Kit.zip Normal file
View File

Binary file not shown.

20
content/references/client-libraries.ja.md Normal file
View File

@@ -0,0 +1,20 @@
---
html: client-libraries.html
parent: references.html
blurb: これらのライブラリを使用して、お好みのプログラミング言語からXRP Ledgerにアクセスします。
---
# クライアントライブラリ
これらのクライアントライブラリは、XRP Ledgerのデータにアクセスし処理するための一般的な作業の一部を簡素化し、それぞれのプログラミング言語のネイティブな規約に従った形でデータを表示します。
その他のプログラミング言語の場合、[HTTP APIs](http-websocket-apis.html) を通してXRP Ledgerにアクセスすることが可能です。
| 言語 | ライブラリ名 | Get Started | APIリファレンス | ソースコード |
|----------|--------------|-------------|---------------|-------------|
| **Python** | `xrpl-py` | [Pythonを使ってみよう](get-started-using-python.html) | [API リファレンス](https://xrpl-py.readthedocs.io/) | [リポジトリ](https://github.com/XRPLF/xrpl-py) |
| **JavaScript** / **TypeScript** | `xrpl.js` | [JavaScriptを使ってみよう](get-started-using-javascript.html) | [API リファレンス](https://js.xrpl.org/) | [リポジトリ](https://github.com/XRPLF/xrpl.js) |
| **C++** | `rippled` 署名ライブラリ | [署名ライブラリを使ってみよう](https://github.com/XRPLF/rippled/tree/develop/Builds/linux#signing-library) | | ([`rippled`](https://github.com/XRPLF/rippled/))の一部 |
| **Java** | `xrpl4j` | [Javaを使ってみよう](get-started-using-java.html) | [API リファレンス](https://javadoc.io/doc/org.xrpl/) | [リポジトリ](https://github.com/XRPLF/xrpl4j) |
| **Ruby** | `xrbp` | | [API リファレンス](https://www.rubydoc.info/gems/xrbp) | [リポジトリ](https://github.com/DevNullProd/xrbp) |
**ヒント:** ここに掲載されていないクライアントライブラリを追加するには、[このページの変更を提案]({{target.github_forkurl}}/edit/{{target.github_branch}}/content/{{currentpage.md}})してください！

122
content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/node_to_shard.ja.md Normal file
View File

@@ -0,0 +1,122 @@
---
html: node_to_shard.html
parent: logging-and-data-management-methods.html
blurb: レジャーストアからシャードストアにデータをコピーします。
labels:
- データ保持
---
# node_to_shard
[[ソース]](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/NodeToShard.cpp "Source")
`{{currentpage.name}}`メソッドは、レジャーストアから[シャードストア](history-sharding.html)へのデータコピーを管理します。データコピーの開始、停止、状態チェックが可能です。
_`{{currentpage.name}}`メソッドは、権限のないユーザーには実行できない[管理メソッド](admin-api-methods.html)です。_
### リクエストフォーマット
リクエストフォーマット例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"command": "{{currentpage.name}}",
"action": "start"
}
```
*JSON-RPC*
```json
{
"method": "{{currentpage.name}}",
"params": [{
"action": "start"
}]
}
```
*Commandline*
```sh
#Syntax: {{currentpage.name}} start|stop|status
rippled {{currentpage.name}} start
```
<!-- MULTICODE_BLOCK_END -->
リクエストは、以下のパラメータを含みます:
| `項目` | 型 | 説明
|:---------|:-------|:---------------------------------------------------------|
| `action` | String | どのような動作をさせるかによって、 `start`、`stop` または `status` のいずれかを指定します。 |
### レスポンスフォーマット
正常レスポンス例:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"result": {
"message": "Database import initiated..."
},
"status": "success",
"type": "response"
}
```
*JSON-RPC*
```json
{
"result" : {
"message" : "Database import initiated...",
"status" : "success"
}
}
```
*Commandline*
```json
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
{
"result" : {
"message" : "Database import initiated...",
"status" : "success"
}
}
```
<!-- MULTICODE_BLOCK_END -->
レスポンスは、[標準フォーマット][]に従っており、成功した場合は、以下の項目を含みます:
| `項目` | 型 | 説明 |
|:----------|:-------|:--------------------------------------------------------|
| `message` | 文字列 | コマンドに応答して実行されたアクションを示す、可読性の高いメッセージ。 |
### 起こり得るエラー
- いずれかの[汎用エラータイプ][]。
- `internal` - コピーが実行されていない時にコピーの状態チェックをするといったような無効な操作の場合。
- `notEnabled` - サーバが[履歴シャード](history-sharding.html)を保存するように環境設定されていない場合。
- `invalidParams` - 1つ以上の項目が誤って定義されている、もしくは、1つ以上の必須項目が抜けている。
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

544
content/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md Normal file
View File

@@ -0,0 +1,544 @@
---
html: ledger-clio.html # Watch carefully for clashes w/ this filename
parent: clio-methods.html
blurb: Get info about a ledger version.
labels:
- Blockchain
---
# ledger
[[Source]](https://github.com/XRPLF/clio/blob/master/src/rpc/handlers/Ledger.cpp "Source")
The `ledger` command retrieves information about the public [ledger](ledgers.html). [New in: Clio v1.0.0](https://github.com/XRPLF/clio/releases/tag/1.0.0 "BADGE_BLUE")
Note that the Clio server returns validated ledger data by default.
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 14,
"command": "ledger",
"ledger_index": "validated",
"full": false,
"accounts": false,
"transactions": false,
"expand": false,
"owner_funds": false,
"diff": false
}
```
*JSON-RPC*
```json
{
"method": "ledger",
"params": [
{
"ledger_index": "validated",
"accounts": false,
"full": false,
"transactions": false,
"expand": false,
"owner_funds": false,
"diff": false
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
<!-- [Try it! >](websocket-api-tool.html#ledger) -->
The request can contain the following parameters:
| `Field` | Type | Description |
|:---------------|:---------------------------|:-------------------------------|
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]). |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `transactions` | Boolean | _(Optional)_ If `true`, return information on transactions in the specified ledger version. Defaults to `false`. Ignored if you did not specify a ledger version. |
| `expand` | Boolean | _(Optional)_ Provide full JSON-formatted information for transaction/account information instead of only hashes. Defaults to `false`. Ignored unless you request transactions, accounts, or both. |
| `owner_funds` | Boolean | _(Optional)_ If `true`, include `owner_funds` field in the metadata of OfferCreate transactions in the response. Defaults to `false`. Ignored unless transactions are included and `expand` is true. |
| `binary` | Boolean | _(Optional)_ If `true`, and `transactions` and `expand` are both also `true`, return transaction information in binary format (hexadecimal string) instead of JSON format. [New in: rippled 0.28.0][] |
| `queue` | Boolean | _(Optional)_ If `true`, and the command is requesting the `current` ledger, includes an array of [queued transactions](transaction-cost.html#queued-transactions) in the results.
| `diff` | Boolean | _(Optional)_ If `true`, returns all objects that were added, modified, or deleted as part of applying transactions in the specified ledger.
The `ledger` field is deprecated and may be removed without further notice.
## Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"result": {
"ledger": {
"accepted": true,
"account_hash": "10EFE192F59B3DE2A2BE5BCE2CA5DC83D066105696FCFC24C055359AAEBD6941",
"close_flags": 0,
"close_time": 711134782,
"close_time_human": "2022-Jul-14 17:26:22.000000000 UTC",
"close_time_resolution": 10,
"closed": true,
"hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_index": "19977716",
"parent_close_time": 711134781,
"parent_hash": "D6DE54039FE5A22D86CD522F1A9B7794E487B74D9B6B8CBDE23F240F434B6749",
"seqNum": "19977716",
"totalCoins": "99987079398940307",
"total_coins": "99987079398940307",
"transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000"
},
"ledger_hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_index": 19977716,
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
*JSON-RPC*
```json
200 OK
{
"result": {
"ledger": {
"accepted": true,
"account_hash": "10EFE192F59B3DE2A2BE5BCE2CA5DC83D066105696FCFC24C055359AAEBD6941",
"close_flags": 0,
"close_time": 711134782,
"close_time_human": "2022-Jul-14 17:26:22.000000000 UTC",
"close_time_resolution": 10,
"closed": true,
"hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_index": "19977716",
"parent_close_time": 711134781,
"parent_hash": "D6DE54039FE5A22D86CD522F1A9B7794E487B74D9B6B8CBDE23F240F434B6749",
"seqNum": "19977716",
"totalCoins": "99987079398940307",
"total_coins": "99987079398940307",
"transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000"
},
"ledger_hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_index": 19977716,
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
The response follows the [standard format][], with a successful result containing information about the ledger, including the following fields:
| `Field` | Type | Description |
|:-------------------------------|:--------|:----------------------------------|
| `ledger` | Object | The complete header data of this ledger. |
| `ledger.account_hash` | String | Hash of all account state information in this ledger, as hex |
| `ledger.accountState` | Array | (Omitted unless requested) All the [account-state information](ledger-data-formats.html) in this ledger. |
| `ledger.close_flags` | Integer | A bit-map of flags relating to the closing of this ledger. Currently, the ledger has only one flag defined for `close_flags`: **`sLCF_NoConsensusTime`** (value 1). If this flag is enabled, it means that validators were in conflict regarding the correct close time for the ledger, but build otherwise the same ledger, so they declared consensus while "agreeing to disagree" on the close time. In this case, the consensus ledger contains a `close_time` that is 1 second after that of the previous ledger. (In this case, there is no official close time, but the actual real-world close time is probably 3-6 seconds later than the specified `close_time`.) |
| `ledger.close_time` | Integer | The time this ledger was closed, in [seconds since the Ripple Epoch][] |
| `ledger.close_time_human` | String | The time this ledger was closed, in human-readable format. Always uses the UTC time zone. [Updated in: rippled 1.5.0][] |
| `ledger.close_time_resolution` | Integer | Ledger close times are rounded to within this many seconds. |
| `ledger.closed` | Boolean | Whether or not this ledger has been closed |
| `ledger.ledger_hash` | String | Unique identifying hash of the entire ledger. |
| `ledger.ledger_index` | String | The [Ledger Index][] of this ledger, as a quoted integer |
| `ledger.parent_close_time` | Integer | The time at which the previous ledger was closed. |
| `ledger.parent_hash` | String | Unique identifying hash of the ledger that came immediately before this one. |
| `ledger.total_coins` | String | Total number of XRP drops in the network, as a quoted integer. (This decreases as transaction costs destroy XRP.) |
| `ledger.transaction_hash` | String | Hash of the transaction information included in this ledger, as hex |
| `ledger.transactions` | Array | (Omitted unless requested) Transactions applied in this ledger version. By default, members are the transactions' identifying [Hash][] strings. If the request specified `expand` as true, members are full representations of the transactions instead, in either JSON or binary depending on whether the request specified `binary` as true. |
| `ledger_hash` | String | Unique identifying hash of the entire ledger. |
| `ledger_index` | Number | The [Ledger Index][] of this ledger. |
| `validated` | Boolean | _(May be omitted)_ If `true`, this is a validated ledger version. If omitted or set to `false`, this ledger's data is not final. |
| `queue_data` | Array | _(Omitted unless requested with the `queue` parameter)_ Array of objects describing queued transactions, in the same order as the queue. If the request specified `expand` as true, members contain full representations of the transactions, in either JSON or binary depending on whether the request specified `binary` as true. Added by the [FeeEscalation amendment][]. [New in: rippled 0.70.0][] |
| `diff` | Object | _(Omitted unless requested with the `diff` parameter)_ Object containing an array of hashes that were added, modified, or deleted as part of applying transactions for the ledger.
The following fields are deprecated and may be removed without further notice: `accepted`, `hash` (use `ledger_hash` instead), `seqNum` (use `ledger_index` instead), `totalCoins` (use `total_coins` instead).
Each member of the `queue_data` array represents one transaction in the queue. Some fields of this object may be omitted because they have not yet been calculated. The fields of this object are as follows:
| Field | Value | Description |
|:--------------------|:-----------------|:------------------------------------|
| `account` | String | The [Address][] of the sender for this queued transaction. |
| `tx` | String or Object | By default, this is a String containing the [identifying hash](basic-data-types.html#hashes) of the transaction. If transactions are expanded in binary format, this is an object whose only field is `tx_blob`, containing the binary form of the transaction as a decimal string. If transactions are expanded in JSON format, this is an object containing the [transaction object](transaction-formats.html) including the transaction's identifying hash in the `hash` field. |
| `retries_remaining` | Number | How many times this transaction can be retried before being dropped. |
| `preflight_result` | String | The tentative result from preliminary transaction checking. This is always `tesSUCCESS`. |
| `last_result` | String | _(May be omitted)_ If this transaction was left in the queue after getting a [retriable (`ter`) result](ter-codes.html), this is the exact `ter` result code it got. |
| `auth_change` | Boolean | _(May be omitted)_ Whether this transaction changes this address's [ways of authorizing transactions](transaction-basics.html#authorizing-transactions). |
| `fee` | String | _(May be omitted)_ The [Transaction Cost](transaction-cost.html) of this transaction, in [drops of XRP][]. |
| `fee_level` | String | _(May be omitted)_ The transaction cost of this transaction, relative to the minimum cost for this type of transaction, in [fee levels][]. |
| `max_spend_drops` | String | _(May be omitted)_ The maximum amount of [XRP, in drops][], this transaction could potentially send or destroy. |
If the request specified `"owner_funds": true` and expanded transactions, the response has a field `owner_funds` in the `metaData` object of each [OfferCreate transaction][]. The purpose of this field is to make it easier to track the [funding status of offers](offers.html#lifecycle-of-an-offer) with each new validated ledger. This field is defined slightly differently than the version of this field in [Order Book subscription streams](subscribe.html#order-book-streams):
| `Field` | Value | Description |
|:--------------|:-------|:----------------------------------------------------|
| `owner_funds` | String | Numeric amount of the `TakerGets` currency that the `Account` sending this OfferCreate transaction has after the execution of all transactions in this ledger. This does not check whether the currency amount is [frozen](freezes.html). |
If the request specified `"diff: true`, the response has an object `diff`. The fields of this object are as follows:
| `Field` | Value | Description |
|:--------------|:-------|:----------------------------------------------------|
| `object_id` | String | The object identifier. |
| `Hashes` | Object or Hex String | Depending on whether the request set `binary` to true or false, this field returns the contents of the object that was created, the new value of an object that was modified, or an empty string if the object was deleted. |
### Response When `diff` is `true`
````json
{
"result": {
"ledger": {
"accepted": true,
"account_hash": "29E8799E80245DA68AE2D9C4A454DF3E8FEF5B66C520E644DE0756E548C6897B",
"close_flags": 0,
"close_time": 711135301,
"close_time_human": "2022-Jul-14 17:35:01.000000000 UTC",
"close_time_resolution": 10,
"closed": true,
"hash": "C769F00409D574A982DC0CC071A244C5507D9E2269404957B78081ED8F2FCB1C",
"ledger_hash": "C769F00409D574A982DC0CC071A244C5507D9E2269404957B78081ED8F2FCB1C",
"ledger_index": "19977887",
"parent_close_time": 711135300,
"parent_hash": "29BAC714E9BB7DFE9BE3C8B4AACFDB184389388340A4F3B09CC61A39BAFC3705",
"seqNum": "19977887",
"totalCoins": "99987079398939527",
"total_coins": "99987079398939527",
"transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000",
"diff": [
{
"object_id": "B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66B",
"object": {
"Flags": 0,
"Hashes": [
"A17FED77F200BF8FC66050BCFCC87241DB53C418B3B3C8794C857AAAB76C21EB",
"F991F764BA7B44B5B28F7AC8F03F2BC03B1647AD355CE0F0F91D3B500F862959",
"06523FF3694A078F2DD073A728145455EB451651180C6B0EED1557B657C6C07D",
"69D5C7A206A34CC4A1D21A9D2453E6D72526EA0DA712009F215AA614C259A333",
"94453F6FA048C153A7124C249A7C3393D1A3B4E34A508872A3AA4FE89021221C",
"406FABC4A1C9A30300C814F6B083C00F16568840BBFDCA04369A545CF248472C",
"9396907A543546ECF48C6417373705514653ACB4E585C009EEF525B51CE1F155",
"14082ABB45AFED62BFCDA3CD0465BD17545281C3D671DEC82A837CBEE36E470A",
"1D4D19B06024BE49333EA6C010F9721C5C1A36A5C08D22160945247D3FF9F552",
"91095028948A56A16D8E17488057C27BED696B8E359BAB0D7B8510BBD5F0CFB7",
"FC073AAF3B07260545DCAF0BA0FCFBF7673302D972A534CC8EAB1CD5C4CC73EE",
"4DB17A22F0857992E2BA75C4C15C39B0D420EA26AB6FA862B54E2D65C739117B",
"CB44073EB0A174C4757F453335A5A84848AD899AD09574883946F37DCDEA90B8",
"0B285623C693432532418BA783CF6D731CAFFC312566398B27B67C1B856AACE1",
"5024CD26CE82294E15656CCA0E350284ED6EF70DBD4E4791017F3E4B396D42F5",
"F0E4B4331D5B5B9BB1B43232C8B50E9EB17CD4F6817B04C3AC263C773B44E222",
"7CE5AA21BAEF20DCA4384D469451F6B9BA7AFBA265FCA83B48045C7D994E8BE8",
"91F8A45B27C8DC825157633ED5AE3435F51D5325D29F2F8547D3849F59812CDD",
"520B119EF4ECF9AC3F1B247621A04F0DC187CA6D756B6614E6BCE05A22839C8C",
"EE87D8EB08BCE989C87D530EE4497F5B59B82F859C687E49C6629F34623CF4AE",
"965933B82140D8BC04C324E075AB3758F82F17BE610D12306614A4B1F3695270",
"EA1EF4CECA2EBABBA5A09041C186352B3A57F4496676DF0E4E743794CF2D7ED5",
"A261123CFC1675958992C604778535208FE9C783AA77107393EC1E290D7D3ECF",
"5F3F22362E969A5E7479BB4A9FD31BCFBCCDB66741F49CB72755BC2B76A1D310",
"1BF9D357835E4D8FA82AE99FA13F389F502401E59600F2B72E4B1CB703A54363",
"59A17903D6C8FF3F36C327E207AB54293163A8AA4A3DD515F2C677B736396BAB",
"308905A9E623788DE1170B396AD379863D5492B490D6D56D68F3DDA41CED7F39",
"B686A8CBD0B5464C74B7D7E3AD04D055E59C7FB558B4F65D61FDC005AB91950D",
"81831141523FDEEEF91BA883B0B394D8D608C2353936123F88B4C27F823E5F32",
"DE2BE267BF14EBB26696070989BD229603985CDA105B186C2987C6CC9A0CB83E",
"E54358313465A1701F94806969E07D392AA5E9A6DE99A37E4328B9C9736630C1",
"02190060960D241F3182D4E8CC154D2DAA8224CE3CC1DCDB1E21CAC65B56D9B0",
"B02916AF6E46353828988E785C2F0A26F8CD6196F5905AB4DEDF7034432FBC3E",
"3E95827426FC91549A8E9A80D6CC99997646F6B26CD3F625D94064BA16DE97E1",
"1B83060E2DE91E889FFCE8D0DAEC810197C026EE0F037E612732639EDED3EBCD",
"A8EC7EE25A6B6C13AC6A006F3397EFC8FE38829EF273469186CABE5B529A40EC",
"B00AA09BC4A6180967DD6BA88BDB13F5F59EA4E9C074B752A04DF7C515DF8504",
"45CD713F10A5ECD06B32A2B15E63FEF211852E8BD56B813362D16C7413948785",
"A749FC031CC69E10476B7AD751B068F32DB9192C9CBCBD7CDB018FCF5C1B0934",
"28BC94EB8BC5A0A3313CD825FFC824454ED64C60988D530B334C3112621005AA",
"18DA83251BF498CEFDD189B7894E70ED2BDE832183C4C846B4D6E886B0749CD6",
"4DB4B88C5F4638816E06D880E55DD83C61747D0235C96E1CE1FD709777C20BEA",
"CED44414A9AA99BFD709B7A9072170CB2040EF31D5E84552A930E02CAAB2301C",
"9566A3A6E02FCA0648B67CDACE941BCA7D243D1E2F18742E50EE83C1C8950A19",
"0100F9B48D0999BEBBD18500036741B34E7FC395F155FFA81263EB772C2E1178",
"867719FDA972F549F2149341FE8089A09DFA590C55B7F682A4BDEAEC14A32EEC",
"12C96E5C7D29649AA86FF17969B13978DCBA004F691D476A8AA88EFDA318E5C1",
"8001BD1ED9A0772DA5C89144B56B2504F90329C06E05F4052862EA5560021448",
"D3F85FA0E6B948F05578B99306247B569548A976773DBD0A7811CC8FD62A5033",
"A2B15A5E7B8C3912C7FE9BB93B98333B00AB82322F9759CC43ED6D7BC25F48DF",
"3C7D539FB2D34B20B3BBFFBEA05738560A3811AC496BCB7D504041250D4C393B",
"D5B91302F8146E5BC0FAAF08BE2C228CCC17EF192A423CCEDE1A38A604D9E842",
"F4DBF016BA3836F3B6B5971D1308C04C531FADBD6E74EDB03822851D8C1D5A84",
"EDA6E3DE8138D6129B3A11EBE98F676F66943158E2ADB0E5E548EFCA124C7F7D",
"19EBC639A176F903A739C1C375C240ED5EB58B5D1FB6DF15B3CE4AD6B04689B8",
"E015FE6FCE6C587605A7918ABC25CB37BFABCD7D49A2C7EBDCABC490AEDD90AB",
"9684F16CA2DE7C8056F5125D2AF167E8D3CB5FD8F9A12D87D9D60CE46F098BB3",
"EA9160D3B05F0DFF835AE2AF054BA0FED3DE6A381E11AED991E0850EA1D28A7B",
"2483BA35393AA70856554220E0A3AF07C33C6DB03BE12611456E202A0549FE4D",
"FD0113CC43B968461C3F2747BAFD05878A406BFB77B2DC871CA38F437BF210AB",
"F0DACE2C90812B32803F5D5BEFBACA52CF2F356D7DABD617D9EBBA97328FA785",
"3A0AF0AD0C70DCA0133030A00AAB6B988C898B85A46280D8E76D276CA338424F",
"44EECEB56CD25464A250C2D1A6F8229A2764BBEF7D0055136BCEF30891C38EDA",
"877D98B96F97C3E60F2943D1B8549FE4AE5028404595E5BBB202944AC6F01A60",
"2D315749EF112D77ED3678AB490EF8A57DE306CA8FBACF92C488768A96A9BCFA",
"4369B3388623807E1FC6CDF6903B52603FE4CB6B9BF077C59F8B13B51977AA69",
"56B0C8A81165767A2ABBA57DFAE643EDF4939E90812357C57D771494BF53842B",
"6A6BC82CE98722D24EA37A5BD6147964B80EAB15FA92040ABBE5EDC2091926AB",
"49AF43F65FCA39766EE5A8E1A350728188EC7484415A08C99E1B5D20D3CCB02C",
"8EEB0C0B13C8F4AFC1290108A76A694657CBD88D386C01FAE14DDA3375500B2E",
"3B1005BDD07BD695EDD5E03F82B491D716E1385667403E71359CF4AD1E1A16A9",
"75D9C054146CA170317679319D5B4EABEB43A5BC54DC8C76436E3FDA419FFD02",
"28B85444D0F90113D9DCF445EE1988EE228980103F3E285ABEF1D74EA8D739F4",
"086064E478FE929117878CB7BFCDB615E3E9F2386DBA414922121C026B112A57",
"AD958731124D7ECCA778B9D5671C61E6D7F45FB9DFED3ED088A48BDC9549BF64",
"209D7728CBFA4071209906222B90EE625E4C2204FC26DDE4C07C23079AF75A9A",
"565907A56C26BD5A51CC030F43A06E3A147D468108115D5FA77E345A6E565F6F",
"1D1DE732390C20EDBDDAC5DFC6818A6F0E016C50DC376AD2CDD3F24EF1FA1855",
"A864A423696798807F2FB532F1708FA35C1DAF6C419E67E6E773A6BB129F8266",
"C47D3FFB2F918FA865597A668ECA393F9FC2E429CF0751E970A03C7F48554982",
"D033B2D1E8A2CC77FBE576D074294E80E6C6018802E62FF7BC56701E54A00BD9",
"25D569F5D84842FFEED3A05178B6B9E582E922B43A8CC29F1146E34FAEBBDDD4",
"C56A6197504AD536CFD9A0C26599F6D3E305CF77354CF2D7A33546DA24439B16",
"28F8DB51BED3DDD90194D1452B18C2612C65FC09D77FE31B271C59291C0C2E06",
"D6DE54039FE5A22D86CD522F1A9B7794E487B74D9B6B8CBDE23F240F434B6749",
"D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"6DF891006E4D4840263C561C54135BFE78FE766A5CC241DDC7A0563BCA4E4C5E",
"FE2D5BB3051F24F6114A7DA14CD393E4187219F52DB83CC0438E0F0B1B350874",
"39292A3C8E56BEA306D83441ADF3F0E65C02BE1DAF3F66F8B95EF46FF44D2487",
"506E1F0A25BE23A46C7483D23CC94583837411D79DD446219964DCE2C0807B0C",
"1D4327D8480B5EA7A61AFB1DBA977D2621372227D5FC55FC90081B3675082DC2",
"39A957F6982825A34ED12AD63BB1DB76BB6C9E725C28BCDA198F62876E0FEE44",
"64C05FA4D16991A613F13655474ABC52C49093334A1C844F5F0682560B0BEE70",
"A4E4AF4BC5B670F2726146233CCA99226EDE61468A26EC4378C919A1D0CC7162",
"6AD5D147ACBA2AA94D19AA4CF8FE8A92F11D57DB7AE21CE2226103CF1B4D49EE",
"7764C4EB977E2E40825593AAC2B51FF8D2DC6E29FD8F257C235D009D24238860",
"DECBDC6150DA4CA92272AE45CBAE9D8174E84FD2D0053707778A3FEA4FCE8961",
"BFED2884BB6E0DCD3BC0E91326CAF674A449D05C7AFAC95BDAB3D51FFBF369E9",
"ADF69FD7A3273D709B2FDD7FC4A2C43D6D0D6BCCC0AF65FDC584B543FEF68240",
"FF3667A56CD39221B8F2B22A479345CBAB9E7CDBA43A0356E694AF58D347D2C9",
"4DD651F3A6E1B3EAEFF384F21C04B2BC39EEEBBD016180781CC007842F5C9DC5",
"B7FF750CAB3F806DD13ED55CB54443BFBA616762DC32891CFF55885407844911",
"24CDF209FBCFA4F10D46CCD4B05C8A80E030A212C6F53FD2DEFE93A0E64A2848",
"E3EA5323ACA4611D84415B787CA74B0BFD9FFC37E1BD862498A8370CEBAF6AA8",
"8D1A5630B0871D4E27F5B13E73CE313C7D65E4694541877940E6D113CBE6D5C1",
"FADA7F6865EF29AF7C9485E170D25C03B96354E8E419532090A33FE11E5C536F",
"A13BFBD7E04AE200E7BF91159B63B8BB6B867B07905DE927515178DB786ABB10",
"0C7B5ECEF3C99096D29307EFCF2FF2C058EA8CAB8E8CE45602C877EE06C8E428",
"B58FF112CCAAAADBBE9CF2B986C84F6F9E63E21AED202DD6A8154287F1374540",
"0466E0A51610D718CCBEB76DD5375B8D19401F14F0D1FC43BADBDBB0CBC2E252",
"5D78C471A058971A621AAA03AC8B48629BBDCBA566729BFB9ABCD57F34C7431A",
"52154C4764859925DCEE21722E782B9661751CA5E12D5C6F20CB25329946FF42",
"D1157510A1F7E60DEEA252C1556D442529BB85FD663ABBE0AB50FDBEB2E6B102",
"AFD343935B0A415478B1B939F7F65B01ACE8697E600D2D4876C44322B4F1C7E5",
"7009160F2CEB809C9D3579471F2AA4375CB898AEE4D75610A1597A231DDCE48D",
"91908F58250C01130E5DCC2F4E27C7B1AC4F3DD2ED37D89903EA1C4814610215",
"F91F97F8B7ADC47DF97C57DBBD9172F6F474519BF98A3F191C36EDD5FED60FA1",
"681992EE99027FB7083F6801F4FC0C42342188D4C19977A723F922DCDD7D96C2",
"431EB9959F3D1FF3902BD92710E9A82D2F2FF2E21551A9A4704CC5D021612CB4",
"94AD216A9B3080BC850B1E4A2F3FDA73000806070FEF53A63EB993BCDC89C380",
"E1CA581E35FD56A476A09FB1FB69E0F756538FBFE8C7784C38042511AB9C98DE",
"11C388D35E712ADC97A3D0AE46FC0C0CAD8F4719255A19A3882194FB2DF5F7F2",
"68D34928D77FCB509A8A06B6EB7C674CDF21E53BC5BED834FEE948F2BE3234AC",
"451A0520DFAD303D5564D9E383C4335EC457C870D4BBC62C33F3B229C41599AF",
"183155CAC5C01A29209CD866BBCCDF2B50EA3D60450AB8E6B69B6F85509C60F2",
"02494D95424824D3F83C9916CDF0C1CA0FAAA1C22B8E7647D16CE84C15E9850D",
"4D140E49AE22792B21B6B96C7DF003954B34393BFB915C18AF1CA7B98C83DC45",
"21735614AFBBCF9D109DCD83424024EE8009292DD8D75715C3A6E1F96250B7DB",
"82EFBE40A7B810369E7C39C199D77061E129CAE36FE4A0A000811A23A7AD7E63",
"AF3CB3F6F3B9D086390BBFC6FD3F8FF2918D58E2B2032D89E83879174F480E3D",
"21848D2B5F50AAF2044662483386A629EA8162995E58A479625F9A1C617A01E7",
"BB8B7E9CAF46E29403C649613AF16FE8AF37478AFCE240BE6C0BC3F54A6EB4F1",
"F2874B80E64C57F8FD1DDA598FBEFFB4B2E6CECF3A984DAEC60F184ABFD2C03A",
"15CDBBDA11931E1D24D37218E65CB3CF08F0E539DD9AB942214C05B3E494B6F0",
"9C210C63F0679B59DA6F003A0C5D6F7E2DB4EA1406BE6EACF449D217C285E037",
"192C9D0C5A49989BCA788F1BBE63B58556BA0E433BBD8ADD4B863D1C0FC356AF",
"03F177E6517BB75C395B4E6A7AB45B8AFE0E974210828713AA02DD47ABD1408A",
"7DDEBAF7B185001AE2BBE964380753231869474CBDA1EC95600DA8E1A02646B7",
"A85AB657FAEDBEB7131FEACDC65347EE08B4ED13D1C72A49CC2B5F8508A5B0CB",
"9C6E9109DA0B5A513DF5E73392AADD7C6C0496C940BE60A9B8416C3D4B556EEB",
"99E68186022471A787D7A8CDA6F75F067925A374B8A429EDC7F36E064AEA4199",
"A4AE86CA5A78E2145856B3A1D3AB7C6F0907BA46978F50633E48049180D031C0",
"EBC6B139FB1EC3E9E24132689CA092C8672EDF356398D29100D9F56BEA81BABB",
"C595DF4DE3C2127C9A6AF2136E6179341D9DF5155A4AC514B2CDD2C29C4AA07D",
"29612714CE0AAAEB97B287F0C5ECD38782FF9BDB2B18D482679E64557223D380",
"DD025B92754F403EA9BCCC588CEE41F7AB64A7458757EAFED1025E193BAA8CFC",
"0E32604081E3D7349225F7F9379E291A69CD78D0C65D332DEA30FEE3795E0F4D",
"CA6F59B04FAE47133310217A832300402B947163AD630365E9BADBCB1F839634",
"1170E9481115804233BB48DECE4A40FC3822D90B304C1842FCF31185982C6A26",
"1F5C266D7C98931AE2FE24C540D62691534CE19D3E0705866F2BCB4A9A7DC96D",
"ED5EE281D36BFD1AF424C9893D81FC89A7B7904B46CBCC73878FDAB881D34104",
"126EFAA40EE6813C63D0C98776E3C1D367CDF082A1CD4BEAD9AEEA0F5B381BF6",
"41B9BAB0370A20827E8D982CBD998A9F3061DBF4E8D8D5FB9A94AB88ECDFA9E0",
"AD84AC38922A4F7419454303357C7F35694D428C4DBA055A73318647A28BBA22",
"F1E13F085E07E8B7B096A94046254D2C753F0A897228F82FA8E8E4470E8EBC84",
"E56D730E2A64F28B5D8F1F622224CA3DAFC9E8977C2D7F6916B668E6F5AC5FEA",
"5176BCD5B49F51EF0357BCDFA99393FF870C956548183C45CCABE3C45A6E0210",
"D0BAF08FBA5DBB1C56B962D799F5A540227A0A730DA01A29709F1069036C0E4C",
"4B6864224578CC821F3FDD8481C9898BE2D6F7AA57E0C088A4190F97361066EE",
"8C82AF844701C4A460E6977AC3138FCC0A16DEFB86C30A1DA5D850E79F4346EA",
"DC494D03BDC80BDB671DC34580C85101B4757C6FABE07B96CD50DCA08F870EF1",
"7E01B6E68F72C59B819D9FE3A427896EAF6976F54D11DBAF4E4B78AD0F4F94CE",
"65DB13E8EF98054BF5EB1B7B458B37D09F062F1ED5AD29CBCD655E082CFDF948",
"87377F31ECBB1BA1FC8D2B78EBDC3BC63F034C81490097C445A43B571C24CE41",
"895B2CD5B1F669A35FBDEF28224126F433758E4A95A5D2503D9058BB70ED676A",
"503D2DA830018B8F422A32409D71DEFFE1F4DA682236B8218607191EC01A3A7D",
"A86D61D03AAB6D516C93F90C80C227A137776B7FEBE3E7BA6F7DBCB18FA800B9",
"E0E88839EFBF8E78AD5981928FC6B75BF1B037534CB20D8A19B173183F726D96",
"1E64DCEF5EAD556D1243CD60AAC9DC8F5B6335ECDD3E2A606A2C504BDF24A752",
"4E3426C8BF92F0B713D59381A865EC646733BA6504907F43D3899E0437783D0F",
"47A43F68C85B560877398BF1F762B69517C43842EDF90D1869C5FFA3D334DFD2",
"1D2077E03065C4B1B893B09A1F9ACFAF4CEFB8EFA48110ECFA88BFC83EBDD02F",
"FA46B288FEAD5D7314855929BEE8E7E6FEED199B4A8EA45DCB026DE0A2F85DEB",
"CDEE9069327F829ECB476103E859033481B1ACA692527B2A117F5188259CB642",
"8C892E4EC406900DC3632A872849F2D58A248E8089EEA5F95B4650F2B8140037",
"9F5C5E1017556B907E60342E8D146556C41A8E125F62101F3E11023FCAB0FA0D",
"A97DFE953D243B9534C4CF446D58928B3DA526A52739C65C218D98E89AB8F154",
"EBF542E9C22DD349ECE2BC90BFA78412F97E45315349F7D6EC530F266A10874D",
"C20330EDC46B8C3DC3841AE2141BF523E5D82BA7453E7C80772EC545B8D74D68",
"5AF5470AD82C035CAEE8822AB8E23F86C87A9304069BF4DDB7B4329C9D99CC95",
"899D94ED8FCA53556E2B679F007298FAD93FC7E948337918154907E8AF44BF88",
"0CD167820E508D58E0EAA828C611BA83E483F31316262AF4DA215A6BC0E049F9",
"D7F686491E837A42A82CEB1209344EA906ABE1D5D2A88A09B3DAFAA41D174CEC",
"B2BD977BE83845585E5BF100DD8F1D074B97B863EF026E5B3E5CF58610A49B76",
"85ABA1F4F4EDC96E21491BDA3B0FBF9D24F85CA031C2CD7885F1EFA70D32B4DE",
"4F88CAC8248F7BDFFBC6FA84FF90041CEEB7E6F37480BFEE121CF3E56D3A79AE",
"5D2BDDB71EE422BDDC673E435121257D4A0603ECDD53A00FE2A5F7F2D0301173",
"198493B9CAAF02641DF7BC6C0F18B45C12E036EAE757F3465EF973924DF8C77D",
"E4AE4E3F8C34122B47E1D5B860911CDC767DAFB039C005961175E2439BF78DC5",
"B5BB5640A47DA626D65122018BD3C415DDBE2A1CAA4407B8B079CEF0C304AD95",
"BDB7AD110926AA63846409D5FD1A99AA1BE868AF245389ABEE31F14EDD15EBB1",
"D8495120CB075C928C72CD926B94C99F5254AAD2D6E244BAFA9A63BA52BD960E",
"D2557CD093DCBFBD3AFDB8EFD11FC1E6F413EEB2761749EB200A872A3D2694DE",
"571BC9B0877BBD6367B06671C27EAF34F816CCA2C21DCE5897B0EFCD0D43A2A3",
"04B1D993665ED4D933932058FD8FC2B94DCDFDE047548FCB3A01DBD14635D077",
"62C1D9B265994D0E7771EF89E862EA78DDD92393AFE0CE8AD8CA88CB6704D1E0",
"900D28DB3B3D291923AEF1D21A4C479C03351C5F8BAD5466B8342D7DA27D8CBC",
"1DE86AADC71CA909F70481703077EE060173D6A29793C310C580B98ECC874201",
"4E0370E993DD3582AF5E6E4305DEDDB827FD54CD724FB1D8C0C9D3233E47BE14",
"A3DB94469E15C3F6929B2D32F738175094927B5BBBB0B604C2D53CB06D346127",
"CAC99E91ED58500BDB307D5DE552CC8C47904475C80BBE11541E893BB1E12B4B",
"4765C07192C891F5241B66A30A97C97FBCC8F4CC69BCB1AF6E3300785623F3A6",
"45BF472F5B15A434F566CBB2FB47C5831D11E4B9B223541368E8548D4C55B59F",
"3FC3D33C9C4A183DA4637E4EF274E8FD33B875BA0FCC04C651FC7C4232B16FAA",
"A98C78E925763C6C1E5042C84A67D41F88270ED729D69A26201E07A5DDA5230F",
"50C0C03269F1F6F7A2D043E87D77E33C90A1DFA89D1ECDEAF4A60C58F35B5A88",
"DE165AA3966F0563450D0574E640299CE74F7F34DCC91B6611F28D5B4F4787C3",
"5991D443A65155D51146CDEB92B20DC6741F5DC69CF9BB09D2143B1FB6CA5DEB",
"7B277027ADA02DE4A2ED276DDFC25A24DC192C4621C690388214EA3A3702D160",
"6DF9246E01CCBB2EB84D45042759DE38626E31FF13C96B96D7B3D810B913C267",
"E57254EC7240FC6EDEDC06472720C85BA29D7767B558D80912153A9AC80B73C9",
"D82D0B64692718A90F92DEA9B86DD919CAC9D00E81D67016622D9EC45ED881A9",
"E7422CE9EEB7CC82B3D4DF2B269EEC0B1D4600DC6CEB4378331724D9B27E498A",
"D7B00E067380396A385C16E83B269DAA401D37983B88C2170F3F5868A8AB12E5",
"E5C8DB25AD8CA4227DD22B37A85ABC550CF10EB22107B9300ACA996CDE0FAD43",
"149EA8F908855BEC67176C2FDBEE3DF60A96996AFFC3CA29BCC19A0E2612A3ED",
"7D30BE677279B82584374E603FD195AA8141F2E7F4027178C86B7FB4489FC824",
"B3516D84A78F96AAE074D01FAA58711E79705D12164894B89A5C65FF8A459379",
"149E3515ACADD2514E3C452CC02A0043F064FC245E559A6F184F60E0B0910ECE",
"7D58A24F7D64BBE0B394F416F332363FEAF205B0094347C4EC036D3B3945103D",
"1433C2844DFB3910310FF1E1C33DFA6F6B687ACCC6D306B3D5EBEA4221B377EB",
"A1AB11FE6E3AF3610BBB0FD4294A6B0DEB8064FEEFC082AB3D02F7A9FC455715",
"E68A28C04129B4193082270FA2CCB8C5616EA265F43CDF3875C7FDB28D6E7FCD",
"05C99D4ED3F3817CC771B5C6C44A5C8D1DC12E104E2EE9D68FDED0A09AE04496",
"998D87EDA73CA171AAC58BFD81AF491655D35A56F39499808F0D615457DD15A3",
"DBB89E5A3DC843EBE9FD76D2900A5EAE13B1F0DD94C4ABD79419BDA49C0D198F",
"1B8CF3D3641353C5B542028D693EB48B234481EBBCDBFFBB4296E2F3F27EF73C",
"F4E458B405F45F4EEC826BE48C5C1DCAE63793D5BB9F594F92C67A3BADA0C22B",
"4C7E38C43A22C6B24060DCDC082F8A870A9B7F503863913AA231CB1464EDEBBA",
"BA1B4558AA11B62016A63D9A62C70D9F1F3D63596EA1FEB48B762C88E499A276",
"5008C69B9FFE9228582C1885E376DDB7F97A32F9D30320A3B6643703E9B36755",
"B8A8DF116E86B84732A2CDD730CB869783581CFF552EBE29B76D249BC03CFBCC",
"64CB6269F83A4E04B1484EFEEF680DF4FD53DEC015E04DAEC3B8A1AC320E64B9",
"15FB1B492A8F53CA3E3BA2DE62504586A895E3F1D9941A491CE44B5676355DA8",
"B815A256260EF5B646309EAF63057C70B83F82927D39E2E8869A4D4D9E4FFD21",
"5F559A5FE8A29C9959508AA33684F71BFD387395330988055C0062CA756DA44B",
"6A4E1C27AB06D35675648C9FC6609D55E778972F70FCD6F28852116BCE56DCB9",
"0390537EF63BF56857F6252E0CD6151C0321AC683AD91C5CBB59A1FE93285506",
"9717BEB3BF2DBFB82E7572458553D0E24C9DEA2B752711813AFA7E36235B6EEE",
"BAE3CFD5371A27B256970B4D94E104D65440EEA94EEF55FE2FB8063D0BA31776",
"21CA517FFA45C251FCD86ABCCBB906BE365B5A597BF6283BEEFF99F562ACA922",
"5336C2C2A8602FE29AA1E67F628CEDC3392B66320A995694176BA34D4CB17C38",
"70C73DC0C72B1D95821F0EA13D4473341BB470044662025D6A228D084DA3859B",
"93BFEB7E283134FB6D4DA2C8AF413CCA5E7EE8903ABA5F6D48BE9BA00798852E",
"3A4B964920627F66A11249A5EF68A9FAC468A2076FC12BE725A5C343E83BCE95",
"13C233A526E35A73DEE0AC36909CC7522C39AED9D42C59D4D7CF646B3F0A09DE",
"94F66D4C66295A3ABEC3D30279F1BD734E09407384B6845770AFBE24E2CA233F",
"C5F9578F580F0111C8728740A39D07957DB8611769676A2ED02E6648B847D865",
"D2BFD4D322A5F37CDCAD66952742943EA9D29D66D22EA0294781FFFF8DE8BD74",
"CF5B95D57193FDD94C3788BC9BED36762CD6B0231CAF5F38423BC7B9B8CCD625",
"FB311E71ED73477183EF1578D152626FCA7E7B2A93785AABF29C5A6267E46953",
"D00F187A37A8E4BBAF6E9041893D30B432CAAFC1B175A27B45C5344AFE3FE462",
"0E9E27E3AA04E9DD3F77146FBE4065CF877EB1DE0555D9FB9EE776EDD7F9B78C",
"7A9D5ED47D42269852BA4AFA373C8BED88F99BB7C4ED9CC4900D2585A3832DD6",
"D7F92889EEC05282AE1BB4375FAC645B968EC23B0AE47E2206496D3E12770BA6",
"29BAC714E9BB7DFE9BE3C8B4AACFDB184389388340A4F3B09CC61A39BAFC3705"
],
"LastLedgerSequence": 19977886,
"LedgerEntryType": "LedgerHashes",
"index": "B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66B"
}
}
]
},
"ledger_hash": "C769F00409D574A982DC0CC071A244C5507D9E2269404957B78081ED8F2FCB1C",
"ledger_index": 19977887,
"validated": true,
"status": "success",
"warnings": [
"This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
]
},
"warnings": [
"This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request",
"Too many requests"
]
}
````
## Possible Errors
* Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
* `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it.
* `noPermission` - If you specified `full` or `accounts` as true, but are not connected to the server as an admin (usually, admin requires connecting on a local port).
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

148
content/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md Normal file
View File

@@ -0,0 +1,148 @@
---
html: nft_info.html
parent: clio-methods.html
blurb: Retrieve information about the specified NFT using Clio server's `nft_info` API.
labels:
- Non-fungible Tokens, NFTs
---
# nft_info
[[Source]](https://github.com/XRPLF/clio/blob/4a5cb962b6971872d150777881801ce27ae9ed1a/src/rpc/handlers/NFTInfo.cpp "Source")
The `nft_info` command asks the Clio server for information about the [NFT](non-fungible-tokens.html) being queried. [New in: Clio v1.1.0](https://github.com/XRPLF/clio/releases/tag/1.1.0 "BADGE_BLUE")
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"command": "nft_info",
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
}
```
*JSON-RPC*
```json
{
"method": "nft_info",
"params": [
{
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
<!-- To DO: Add an example command to the assets/js/apitool-methods-ws.js file. The WebSocket Tool requires access to a publicly available Clio server.
[Try it! >](websocket-api-tool.html#nft_info)-->
The request contains the following parameters:
| `Field` | Type | Description |
|:---------------|:---------------------------|:-------------------------------|
| `nft_id` | String | A unique identifier for the non-fungible token (NFT). |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. If you do not specify this field, it defaults to `validated`. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. If you do not specify this field, it defaults to `validated`. Do not specify the `ledger_index` as `closed` or `current`; doing so forwards the request to the P2P `rippled` server and the `nft_info` API is not available on `rippled`. (See [Specifying Ledgers][]) |
## Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"result": {
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000",
"ledger_index": 270,
"owner": "rG9gdNygQ6npA9JvDFWBoeXbiUcTYJnEnk",
"is_burned": true,
"flags": 8,
"transfer_fee": 0,
"issuer": "rHVokeuSnjPjz718qdb47bGXBBHNMP3KDQ",
"nft_taxon": 0,
"nft_sequence": 0,
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
*JSON-RPC*
```json
{
"result": {
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000",
"ledger_index": 269,
"owner": "rG9gdNygQ6npA9JvDFWBoeXbiUcTYJnEnk",
"is_burned": false,
"flags": 8,
"transfer_fee": 0,
"issuer": "rHVokeuSnjPjz718qdb47bGXBBHNMP3KDQ",
"nft_taxon": 0,
"nft_sequence": 0,
"uri": "https://xrpl.org",
"validated": true,
"status": "success"
},
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
The response follows the [standard format][], with a successful result containing an `nft_info` response object with some arrangement of the following fields:
| `Field` | Type | Description |
|:----------------------------------|:----------------|:---------------------|
| `nft_id` | String | A unique identifier for the non-fungible token (NFT). |
| `ledger_index` | Integer | The [ledger index][] of the most recent ledger version where the state of this NFT was modified, as in the NFT was minted (created), changed ownership (traded), or burned (destroyed). The information returned contains whatever happened most recently compared to the requested ledger. |
| `owner` | String | The account ID of this NFT's owner at this ledger index. |
| `is_burned` | Boolean | Returns `true` if the NFT is burned at this ledger, or `false` otherwise. |
| `flags ` | Integer | The flag set of this NFT. |
| `transfer_fee` | Integer | The transfer fee of this NFT. See [NFTokenMint Fields](nftokenmint.html#nftokenmint-fields) for more information on transfer fees. |
| `issuer` | String | The account ID which denotes the issuer of this NFT. |
| `nft_taxon` | Integer | The NFT’s taxon. |
| `nft_sequence` | Integer | The NFT’s sequence number. |
| `uri` | String or `null` | _(Omitted if the NFT is burned at this ledger.)_. This field is `null` if the NFT is not burned at this ledger but does not have a URI. If the NFT is not burned at this ledger and it does have a URI, this field is a string containing the decoded URI of the NFT. NOTE: If you need to retrieve the URI of a burnt token, re-request `nft_info` for this token, specifying the `ledger_index` as the one previous to the index where this token was burned ({ledger_index-where-token-was-burned} - 1). |
## Possible Errors
* Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/rippled_versions.md' %}

625
content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md Normal file
View File

@@ -0,0 +1,625 @@
---
html: server_info-clio.html
parent: clio-methods.html
blurb: Retrieve status of the Clio server in human-readable format.
labels:
- Core Server
---
# server_info
[[Source]](https://github.com/XRPLF/clio/blob/master/src/rpc/handlers/ServerInfo.cpp "Source")
The `server_info` command asks the [Clio server](the-clio-server.html) for a human-readable version of various information about the Clio server being queried. For `rippled` servers, see [`server_info` (`rippled`)](server_info.html) instead. [New in: Clio v1.0.0](https://github.com/XRPLF/clio/releases/tag/1.0.0 "BADGE_BLUE")
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"command": "server_info"
}
```
*JSON-RPC*
```json
{
"method": "server_info",
"params": [
{}
]
}
```
<!-- MULTICODE_BLOCK_END -->
<!-- [Try it! >](websocket-api-tool.html#server_info) -->
The request does not take any parameters.
## Response Format
When a client connects to the `Clio` server over `localhost`, the response includes the `counters` and `etl` objects. These objects are omitted from the response when the client is not located on the same server, and hence does not connect over `localhost`.
An example of a successful response when client connects over localhost:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"result": {
"info": {
"complete_ledgers": "19499132-19977628",
"counters": {
"rpc": {
"account_objects": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "991"
},
"account_tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "91633"
},
"account_lines": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "4915159"
},
"submit_multisigned": {
"started": "2",
"finished": "2",
"errored": "0",
"forwarded": "2",
"duration_us": "4823"
},
"ledger_entry": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "17806"
},
"server_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "2375580"
},
"account_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "5",
"duration_us": "9256"
},
"account_currencies": {
"started": "4",
"finished": "4",
"errored": "0",
"forwarded": "0",
"duration_us": "517302"
},
"noripple_check": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2218"
},
"tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "562"
},
"gateway_balances": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "1395156"
},
"channel_authorize": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2017"
},
"manifest": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1707"
},
"subscribe": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "116"
},
"random": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "111"
},
"ledger_data": {
"started": "14",
"finished": "3",
"errored": "11",
"forwarded": "0",
"duration_us": "6179145"
},
"ripple_path_find": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1409563"
},
"account_channels": {
"started": "14",
"finished": "14",
"errored": "0",
"forwarded": "0",
"duration_us": "1062692"
},
"submit": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "6",
"duration_us": "11383"
},
"transaction_entry": {
"started": "8",
"finished": "5",
"errored": "3",
"forwarded": "0",
"duration_us": "494131"
}
},
"subscriptions": {
"ledger": 0,
"transactions": 0,
"transactions_proposed": 0,
"manifests": 2,
"validations": 2,
"account": 0,
"accounts_proposed": 0,
"books": 0
}
},
"load_factor": 1,
"clio_version": "0.3.0-b2",
"validation_quorum": 8,
"rippled_version": "1.9.1-rc1",
"validated_ledger": {
"age": 4,
"hash": "4CD25FB70D45646EE5822E76E58B66D39D5AE6BA0F70491FA803DA0DA218F434",
"seq": 19977628,
"base_fee_xrp": 1E-5,
"reserve_base_xrp": 1E1,
"reserve_inc_xrp": 2E0
}
},
"cache": {
"size": 8812733,
"is_full": true,
"latest_ledger_seq": 19977629
},
"etl": {
"etl_sources": [
{
"validated_range": "19405538-19977629",
"is_connected": "1",
"ip": "52.36.182.38",
"ws_port": "6005",
"grpc_port": "50051",
"last_msg_age_seconds": "0"
}
],
"is_writer": true,
"read_only": false,
"last_publish_age_seconds": "2"
},
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
*JSON-RPC*
```json
200 OK
{
"result": {
"info": {
"complete_ledgers": "19499132-19977628",
"counters": {
"rpc": {
"account_objects": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "991"
},
"account_tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "91633"
},
"account_lines": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "4915159"
},
"submit_multisigned": {
"started": "2",
"finished": "2",
"errored": "0",
"forwarded": "2",
"duration_us": "4823"
},
"ledger_entry": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "17806"
},
"server_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "2375580"
},
"account_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "5",
"duration_us": "9256"
},
"account_currencies": {
"started": "4",
"finished": "4",
"errored": "0",
"forwarded": "0",
"duration_us": "517302"
},
"noripple_check": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2218"
},
"tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "562"
},
"gateway_balances": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "1395156"
},
"channel_authorize": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2017"
},
"manifest": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1707"
},
"subscribe": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "116"
},
"random": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "111"
},
"ledger_data": {
"started": "14",
"finished": "3",
"errored": "11",
"forwarded": "0",
"duration_us": "6179145"
},
"ripple_path_find": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1409563"
},
"account_channels": {
"started": "14",
"finished": "14",
"errored": "0",
"forwarded": "0",
"duration_us": "1062692"
},
"submit": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "6",
"duration_us": "11383"
},
"transaction_entry": {
"started": "8",
"finished": "5",
"errored": "3",
"forwarded": "0",
"duration_us": "494131"
}
},
"subscriptions": {
"ledger": 0,
"transactions": 0,
"transactions_proposed": 0,
"manifests": 2,
"validations": 2,
"account": 0,
"accounts_proposed": 0,
"books": 0
}
},
"load_factor": 1,
"clio_version": "0.3.0-b2",
"validation_quorum": 8,
"rippled_version": "1.9.1-rc1",
"validated_ledger": {
"age": 4,
"hash": "4CD25FB70D45646EE5822E76E58B66D39D5AE6BA0F70491FA803DA0DA218F434",
"seq": 19977628,
"base_fee_xrp": 1E-5,
"reserve_base_xrp": 1E1,
"reserve_inc_xrp": 2E0
}
},
"cache": {
"size": 8812733,
"is_full": true,
"latest_ledger_seq": 19977629
},
"etl": {
"etl_sources": [
{
"validated_range": "19405538-19977629",
"is_connected": "1",
"ip": "52.36.182.38",
"ws_port": "6005",
"grpc_port": "50051",
"last_msg_age_seconds": "0"
}
],
"is_writer": true,
"read_only": false,
"last_publish_age_seconds": "2"
},
"validated": true,
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
An example of a successful response when client does not connect over localhost:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"result": {
"info": {
"complete_ledgers":"32570-73737719",
"load_factor":1,
"clio_version":"1.0.2",
"validation_quorum":28,
"rippled_version":"1.9.1",
"validated_ledger": {
"age":7,
"hash":"4ECDEAF9E6F8B37EFDE297953168AAB42DEED1082A565639EBB2D29E047341B4",
"seq":73737719,
"base_fee_xrp":1E-5,
"reserve_base_xrp":1E1,
"reserve_inc_xrp":2E0
},
"cache": {
"size":15258947,
"is_full":true,
"latest_ledger_seq":73737719
}
},
"validated":true,
"status":"success"
},
"warnings": [
{
"id":2001,
"message":"This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
}
]
}
```
*JSON-RPC*
```json
200 OK
{
"result": {
"info": {
"complete_ledgers":"32570-73737719",
"load_factor":1,
"clio_version":"1.0.2",
"validation_quorum":28,
"rippled_version":"1.9.1",
"validated_ledger": {
"age":7,
"hash":"4ECDEAF9E6F8B37EFDE297953168AAB42DEED1082A565639EBB2D29E047341B4",
"seq":73737719,
"base_fee_xrp":1E-5,
"reserve_base_xrp":1E1,
"reserve_inc_xrp":2E0
},
"cache": {
"size":15258947,
"is_full":true,
"latest_ledger_seq":73737719
}
},
"validated":true,
"status":"success"
},
"warnings": [
{
"id":2001,
"message":"This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
The response follows the [standard format][], with a successful result containing an `info` object as its only field.
The `info` object may have some arrangement of the following fields:
| `Field` | Type | Description |
|:------------------------------------|:----------------|:---------------------|
| `complete_ledgers` | String | Range expression indicating the sequence numbers of the ledger versions the local `rippled` has in its database. This may be a disjoint sequence such as `24900901-24900984,24901116-24901158`. If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string `empty`. |
| `counters` | Object | _(May be omitted)_ Stats on API calls handled since server startup. This is present only if the client connects to the `Clio` server over `localhost`.
| `rpc` | Object | _(May be omitted)_ Stats on each API call handled by the Clio server since startup. Since this is nested within the `counters` object, this is also present only if the client connects to the `Clio` server over `localhost`. |
| `rpc.*.started` | Number | Number of RPCs of this type that the Clio server has started processing since startup. |
| `rpc.*.finished` | Number | Number of RPCs of this type that the Clio server has finished processing since startup. |
| `rpc.*.errored` | Number | Number of RPCs of this type that have resulted in some sort of error since startup. |
| `rpc.*.forwarded` | Number | Number of RPCs of this type that the Clio server has forwarded to a `rippled` P2P server since startup. |
| `rpc.*.duration_us` | Number | The total number of microseconds spent processing RPCs of this type since startup. |
| `subscriptions` | Object | _(May be omitted)_ Number of current subscribers for each stream type. Since this is nested within the `counters` object, this is also present only if the client connects to the `Clio` server over `localhost`. |
| `subscriptions.ledger` | | |
| `subscriptions.transactions` | | |
| `subscriptions.transactions_proposed` | | |
| `subscriptions.manifests` | | |
| `subscriptions.validations` | | |
| `subscriptions.account` | | |
| `subscriptions.accounts_proposed` | | |
| `subscriptions.books` | | |
| `load_factor` | Number | The load-scaled open ledger transaction cost the server is currently enforcing, as a multiplier on the base transaction cost. For example, at `1000` load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP). The load factor is determined by the highest of the [individual server's load factor](transaction-cost.html#local-load-cost), the cluster's load factor, the [open ledger cost](transaction-cost.html#open-ledger-cost) and the overall network's load factor. [Updated in: rippled 0.33.0][] |
| `clio_version` | String | The version number of the running `Clio` server. |
| `validation_quorum` | Number | _(May be omitted)_ Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. This value is obtained from `rippled`. This field may be omitted from the response if the `Clio` server is unable to connect to `rippled` for some reason. |
| `rippled_version` | String | _(May be omitted)_ The version number of the running `rippled` server that the `Clio` server is connected to. This field may be omitted from the response if the `Clio` server is unable to connect to `rippled` for some reason. |
| `validated_ledger` | Object | _(May be omitted)_ Information about the most recent fully-validated ledger. If the most recent validated ledger is not available, the response omits this field and includes `closed_ledger` instead. |
| `validated_ledger.age` | Number | The time since the ledger was closed, in seconds. |
| `validated_ledger.base_fee_xrp` | Number | Base fee, in XRP. This may be represented in scientific notation such as `1e-05` for 0.00001. |
| `validated_ledger.hash` | String | Unique hash for the ledger, as hexadecimal. |
| `validated_ledger.reserve_base_xrp` | Number | Minimum amount of XRP (not drops) necessary for every account to keep in reserve. This may be represented in scientific notation such as `1e-05` for 0.00001. |
| `validated_ledger.reserve_inc_xrp` | Number | Amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger. This may be represented in scientific notation such as `1e-05` for 0.00001. |
| `validated_ledger.seq` | Number | The [ledger index][] of the latest validated ledger. |
| `validator_list_expires` | String | _(Admin only)_ Either the human readable time, in UTC, when the current validator list will expire, the string `unknown` if the server has yet to load a published validator list or the string `never` if the server uses a static validator list. [Updated in: rippled 1.5.0][] |
| `cache` | Object | Information on Clio's state data cache. |
| `cache.size` | Number | Number of state data objects currently in the cache. |
| `cache.is_full` | Boolean | True if cache contains all state data for a specific ledger, false otherwise. Some RPCs, such as book_offers, process much faster when the cache is full. |
| `cache.latest_ledger_seq` | Number | The [ledger index][] of the latest validated ledger stored in the cache. |
| `etl` | Object | The `rippled` sources (ETL sources) that the Clio server is connected to. This is present only if the client connects to the `Clio` server over `localhost`. |
| `etl.etl_sources` | Object Array | List the `rippled` sources (ETL sources) that the Clio server is connected to and extracts data from. |
| `etl.etl_sources.validated_range` | String | The validated ledger range retrieved by the P2P `rippled` server. |
| `etl.etl_sources.is_connected` | Boolean | True if Clio is connected to this source via websocket, false otherwise. A value of false here could indicate a networking issue, or that `rippled` is not running, amongst other things. |
| `etl.etl_sources.ip` | Number | IP of the `rippled` server. |
| `etl.etl_sources.ws_port` | Number | Websocket port of the `rippled` server. |
| `etl.etl_sources.grpc_port` | Number | The gRPC connection port of the P2P `rippled` server that the Clio server is connected to. |
| `etl.etl_sources.last_msg_age_seconds` | Number | Total seconds that have elapsed since Clio last heard anything from `rippled`. This should not be higher than 8. |
| `etl.is_writer` | Boolean | True if this Clio server is currently writing data to the database, false otherwise. |
| `etl.read_only` | Boolean | True if this Clio server is configured in read-only mode, false otherwise. |
| `etl.last_publish_age_seconds` | Number | Time in seconds that have elapsed since this Clio server last published a ledger. This should not be more than 8. |
| `validated` | Boolean | When true, this indicates that the response uses a ledger version that has been validated by consensus. In Clio, this is always true as Clio stores and returns validated ledger data. If a request was forwarded to `rippled` and the server returns current data, a missing or false value indicates that this ledger's data is not final. |
| `status` | String | Returns the status of the API request: `success` when the request completes successfully. |
## Possible Errors
* Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

8
content/references/http-websocket-apis/public-api-methods/public-api-methods.md
View File

@@ -92,6 +92,14 @@ Use these methods to retrieve information about the current state of the `ripple
* **[`server_state`](server_state.html)** - Retrieve status of the server in machine-readable format.
- **[`manifest`](manifest.html)** - Retrieve the latest ephemeral public key information about a known validator.
## [Clio Methods](clio-methods.html)
Use these methods to retrieve information using Clio server APIs.
* **[`server_info`](server_info-clio.html)** - Retrieve status of the Clio server.
* **[`ledger`](ledger-clio.html)** - Get info about a ledger version using Clio server's `ledger` API.
* **[`nft_info`](nft_info.html)** - Retrieve information about the specified NFT using Clio server's `nft_info` API.
## [Utility Methods](utility-methods.html)
Use these methods to perform convenient tasks, such as ping and random number generation.

306
content/references/http-websocket-apis/public-api-methods/server-info-methods/server_info-clio.md
View File

@@ -1,306 +0,0 @@
---
html: server_info-clio.html
parent: server-info-methods.html
blurb: Retrieve status of the Clio server in human-readable format.
labels:
- Core Server
---
# server_info (Clio)
[[Source]](https://github.com/XRPLF/clio/blob/master/src/rpc/handlers/ServerInfo.cpp "Source")
The `server_info` command asks the [Clio server](the-clio-server.html) for a human-readable version of various information about the Clio server being queried. For `rippled` servers, see [`server_info` (`rippled`)](server_info.html) instead.
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"command": "server_info"
}
```
*JSON-RPC*
```json
{
"method": "server_info",
"params": [
{}
]
}
```
*Commandline*
```sh
#Syntax: server_info
rippled server_info
```
<!-- MULTICODE_BLOCK_END -->
[Try it! >](websocket-api-tool.html#server_info)
The request does not take any parameters.
## Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"result": {
"info": {
"build_version": "1.7.2",
"complete_ledgers": "64572720-65887227",
"hostid": "LARD",
"io_latency_ms": 1,
"jq_trans_overflow": "0",
"last_close": {
"converge_time_s": 3.004,
"proposers": 41
},
"load_factor": 512.578125,
"load_factor_server": 1,
"peer_disconnects": "365016",
"peer_disconnects_resources": "336",
"peers": 211,
"pubkey_node": "n9MozjnGB3tpULewtTsVtuudg5JqYFyV3QFdAtVLzJaxHcBaxuXD",
"server_state": "full",
"server_state_duration_us": "3589068181859",
"state_accounting": {
"connected": {
"duration_us": "301410595",
"transitions": 2
},
"disconnected": {
"duration_us": "1207534",
"transitions": 2
},
"full": {
"duration_us": "3589270527034",
"transitions": 2
},
"syncing": {
"duration_us": "6182323",
"transitions": 2
},
"tracking": {
"duration_us": "43",
"transitions": 2
}
},
"time": "2021-Aug-24 20:46:22.194299 UTC",
"uptime": 3589579,
"validated_ledger": {
"age": 3,
"base_fee_xrp": 0.00001,
"hash": "F00F0E590242702B895BE378B6A6D365C094A047CFC8B11DD323D16F81CC67A5",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 65887227
},
"validation_quorum": 33
}
},
"status": "success",
"type": "response"
}
```
*JSON-RPC*
```json
200 OK
{
"result": {
"info": {
"build_version": "1.7.2",
"complete_ledgers": "64735538-65886965",
"hostid": "TOLL",
"io_latency_ms": 1,
"jq_trans_overflow": "3",
"last_close": {
"converge_time_s": 3,
"proposers": 41
},
"load_factor": 1,
"peer_disconnects": "467400",
"peer_disconnects_resources": "16316",
"peers": 85,
"pubkey_node": "n9Mdk7abYaVvded5zic9oDEY3NULv9RmeJ9Z5hgjXX1ycZqAGhTn",
"server_state": "full",
"server_state_duration_us": "627203282776",
"state_accounting": {
"connected": {
"duration_us": "600242389",
"transitions": 40
},
"disconnected": {
"duration_us": "112927",
"transitions": 1
},
"full": {
"duration_us": "3591757226163",
"transitions": 46
},
"syncing": {
"duration_us": "5304456",
"transitions": 7
},
"tracking": {
"duration_us": "13989631",
"transitions": 46
}
},
"time": "2021-Aug-24 20:29:53.291350 UTC",
"uptime": 3592376,
"validated_ledger": {
"age": 2,
"base_fee_xrp": 0.00001,
"hash": "B79D223A27F4EC214C9BA85665B12EE76C1EE2CB887BBCBAFB6484355C43FEFA",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 65886965
},
"validation_quorum": 33
},
"status": "success"
}
}
```
*Commandline*
```json
Loading: "/etc/opt/ripple/rippled.cfg"
2020-Mar-24 01:28:22.288484766 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005
{
"result": {
"info": {
"build_version": "1.7.2",
"complete_ledgers": "64735538-65886965",
"hostid": "TOLL",
"io_latency_ms": 1,
"jq_trans_overflow": "3",
"last_close": {
"converge_time_s": 3,
"proposers": 41
},
"load_factor": 1,
"peer_disconnects": "467400",
"peer_disconnects_resources": "16316",
"peers": 85,
"pubkey_node": "n9Mdk7abYaVvded5zic9oDEY3NULv9RmeJ9Z5hgjXX1ycZqAGhTn",
"server_state": "full",
"server_state_duration_us": "627203282776",
"state_accounting": {
"connected": {
"duration_us": "600242389",
"transitions": 40
},
"disconnected": {
"duration_us": "112927",
"transitions": 1
},
"full": {
"duration_us": "3591757226163",
"transitions": 46
},
"syncing": {
"duration_us": "5304456",
"transitions": 7
},
"tracking": {
"duration_us": "13989631",
"transitions": 46
}
},
"time": "2021-Aug-24 20:29:53.291350 UTC",
"uptime": 3592376,
"validated_ledger": {
"age": 2,
"base_fee_xrp": 0.00001,
"hash": "B79D223A27F4EC214C9BA85665B12EE76C1EE2CB887BBCBAFB6484355C43FEFA",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 65886965
},
"validation_quorum": 33
},
"status": "success"
}
}
```
<!-- MULTICODE_BLOCK_END -->
The response follows the [standard format][], with a successful result containing an `info` object as its only field.
The `info` object may have some arrangement of the following fields:
| `Field` | Type | Description |
|:------------------------------------|:----------------|:---------------------|
| `amendment_blocked` | Boolean | _(May be omitted)_ If `true`, this server is [amendment blocked](amendments.html#amendment-blocked). If the server is not amendment blocked, the response omits this field. [New in: rippled 0.80.0][] |
| `build_version` | String | The version number of the running `rippled` version. |
| `closed_ledger` | Object | _(May be omitted)_ Information on the most recently closed ledger that has not been validated by consensus. If the most recently validated ledger is available, the response omits this field and includes `validated_ledger` instead. The member fields are the same as the `validated_ledger` field. |
| `complete_ledgers` | String | Range expression indicating the sequence numbers of the ledger versions the local `rippled` has in its database. This may be a disjoint sequence such as `24900901-24900984,24901116-24901158`. If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string `empty`. |
| `hostid` | String | On an admin request, returns the hostname of the server running the `rippled` instance; otherwise, returns a single [RFC-1751][] word based on the [node public key](peer-protocol.html#node-key-pair). |
| `io_latency_ms` | Number | Amount of time spent waiting for I/O operations, in milliseconds. If this number is not very, very low, then the `rippled` server is probably having serious load issues. |
| `jq_trans_overflow` | String - Number | The number of times (since starting up) that this server has had over 250 transactions waiting to be processed at once. A large number here may mean that your server is unable to handle the transaction load of the XRP Ledger network. For detailed recommendations of future-proof server specifications, see [Capacity Planning](capacity-planning.html). [New in: rippled 0.90.0][] |
| `last_close` | Object | Information about the last time the server closed a ledger, including the amount of time it took to reach a consensus and the number of trusted validators participating. |
| `last_close.converge_time_s` | Number | The amount of time it took to reach a consensus on the most recently validated ledger version, in seconds. |
| `last_close.proposers` | Number | How many trusted validators the server considered (including itself, if configured as a validator) in the consensus process for the most recently validated ledger version. |
| `load` | Object | _(Admin only)_ Detailed information about the current load state of the server. |
| `load.job_types` | Array | _(Admin only)_ Information about the rate of different types of jobs the server is doing and how much time it spends on each. |
| `load.threads` | Number | _(Admin only)_ The number of threads in the server's main job pool. |
| `load_factor` | Number | The load-scaled open ledger transaction cost the server is currently enforcing, as a multiplier on the base transaction cost. For example, at `1000` load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP). The load factor is determined by the highest of the [individual server's load factor](transaction-cost.html#local-load-cost), the cluster's load factor, the [open ledger cost](transaction-cost.html#open-ledger-cost) and the overall network's load factor. [Updated in: rippled 0.33.0][] |
| `load_factor_local` | Number | _(May be omitted)_ Current multiplier to the [transaction cost][] based on load to this server. |
| `load_factor_net` | Number | _(May be omitted)_ Current multiplier to the [transaction cost][] being used by the rest of the network (estimated from other servers' reported load values). |
| `load_factor_cluster` | Number | _(May be omitted)_ Current multiplier to the [transaction cost][] based on load to servers in [this cluster](clustering.html). |
| `load_factor_fee_escalation` | Number | _(May be omitted)_ The current multiplier to the [transaction cost][] that a transaction must pay to get into the open ledger. [New in: rippled 0.32.0][] |
| `load_factor_fee_queue` | Number | _(May be omitted)_ The current multiplier to the [transaction cost][] that a transaction must pay to get into the queue, if the queue is full. [New in: rippled 0.32.0][] |
| `load_factor_server` | Number | _(May be omitted)_ The load factor the server is enforcing, not including the [open ledger cost](transaction-cost.html#open-ledger-cost). [New in: rippled 0.33.0][] |
| `peers` | Number | How many other `rippled` servers this one is currently connected to. |
| `pubkey_node` | String | Public key used to verify this server for peer-to-peer communications. This [_node key pair_](peer-protocol.html#node-key-pair) is automatically generated by the server the first time it starts up. (If deleted, the server can create a new pair of keys.) You can set a persistent value in the config file using the `[node_seed]` config option, which is useful for [clustering](clustering.html). |
| `pubkey_validator` | String | _(Admin only)_ Public key used by this node to sign ledger validations. This _validation key pair_ is derived from the `[validator_token]` or `[validation_seed]` config field. |
| `server_state` | String | A string indicating to what extent the server is participating in the network. See [Possible Server States](rippled-server-states.html) for more details. |
| `server_state_duration_us` | Number | The number of consecutive microseconds the server has been in the current state. [New in: rippled 1.2.0][] |
| `state_accounting` | Object | A map of various [server states](rippled-server-states.html) with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. [New in: rippled 0.30.1][] |
| `state_accounting.*.duration_us` | String | The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) [New in: rippled 0.30.1][] |
| `state_accounting.*.transitions` | Number | The number of times the server has changed into this state. [New in: rippled 0.30.1][] |
| `time` | String | The current time in UTC, according to the server's clock. [Updated in: rippled 1.5.0][] |
| `uptime` | Number | Number of consecutive seconds that the server has been operational. [New in: rippled 0.30.1][] |
| `validated_ledger` | Object | _(May be omitted)_ Information about the most recent fully-validated ledger. If the most recent validated ledger is not available, the response omits this field and includes `closed_ledger` instead. |
| `validated_ledger.age` | Number | The time since the ledger was closed, in seconds. |
| `validated_ledger.base_fee_xrp` | Number | Base fee, in XRP. This may be represented in scientific notation such as `1e-05` for 0.00001. |
| `validated_ledger.hash` | String | Unique hash for the ledger, as hexadecimal. |
| `validated_ledger.reserve_base_xrp` | Number | Minimum amount of XRP (not drops) necessary for every account to keep in reserve |
| `validated_ledger.reserve_inc_xrp` | Number | Amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger. |
| `validated_ledger.seq` | Number | The [ledger index][] of the latest validated ledger. |
| `validation_quorum` | Number | Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. |
| `validator_list_expires` | String | _(Admin only)_ Either the human readable time, in UTC, when the current validator list will expire, the string `unknown` if the server has yet to load a published validator list or the string `never` if the server uses a static validator list. [Updated in: rippled 1.5.0][] |
**Note:** If the `closed_ledger` field is present and has a small `seq` value (less than 8 digits), that indicates `rippled` does not currently have a copy of the validated ledger from the peer-to-peer network. This could mean your server is still syncing. Typically, it takes about 5 minutes to sync with the network, depending on your connection speed and hardware specs.
## Possible Errors
* Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

2
content/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md
View File

@@ -254,7 +254,7 @@ The `info` object may have some arrangement of the following fields:
| `Field` | Type | Description |
|:------------------------------------|:----------------|:---------------------|
| `amendment_blocked` | Boolean | _(May be omitted)_ If `true`, this server is [amendment blocked](amendments.html#amendment-blocked). If the server is not amendment blocked, the response omits this field. [New in: rippled 0.80.0][] |
| `build_version` | String | The version number of the running `rippled` version. |
| `build_version` | String | The version number of the running `rippled` server. |
| `closed_ledger` | Object | _(May be omitted)_ Information on the most recently closed ledger that has not been validated by consensus. If the most recently validated ledger is available, the response omits this field and includes `validated_ledger` instead. The member fields are the same as the `validated_ledger` field. |
| `complete_ledgers` | String | Range expression indicating the sequence numbers of the ledger versions the local `rippled` has in its database. This may be a disjoint sequence such as `24900901-24900984,24901116-24901158`. If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string `empty`. |
| `hostid` | String | On an admin request, returns the hostname of the server running the `rippled` instance; otherwise, returns a single [RFC-1751][] word based on the [node public key](peer-protocol.html#node-key-pair). |

1
content/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md
View File

@@ -442,6 +442,7 @@ The response follows the [standard format][], with a successful result containin
| `Field` | Type | Description |
|:---------------|:---------------------------------|:-------------------------|
| `date` | Number | A [number of seconds](basic-data-types.html#specifying-time) since January 1, 2000 (00:00 UTC) indicating the [close time](ledgers.html#ledger-close-times) of the ledger in which the transaction was applied. This value does not have a precise relationship with physical time, and is dependent on the close time resolution. |
| `hash` | String | The SHA-512 hash of the transaction |
| `inLedger` | Number | _(Deprecated)_ Alias for `ledger_index`. |
| `ledger_index` | Number | The [ledger index][] of the ledger that includes this transaction. |

2
content/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history.md
View File

@@ -47,8 +47,6 @@ rippled tx_history 0
<!-- MULTICODE_BLOCK_END -->
[Try it! >](websocket-api-tool.html#tx_history)
The request includes the following parameters:
| `Field` | Type | Description |

2
content/references/protocol-reference/ledger-data/ledger-object-types/ticket.ja.md
View File

@@ -11,7 +11,7 @@ labels:
_([TicketBatch amendment][]が必要です)_
`Ticket`オブジェクトタイプは、将来の使用のために確保されたアカウント[シーケンス番号][Sequence Number]を追跡する[Ticket](tickets.html)を表します。[TicketCreate トランザクション][]で新しいチケットを作成することができます。[New in: rippled 1.7.0][].
`Ticket`オブジェクトタイプは、将来の使用のために確保されたアカウント[シーケンス番号](basic-data-types.html#アカウントシーケンス)を追跡する[Ticket](tickets.html)を表します。[TicketCreate トランザクション][]で新しいチケットを作成することができます。[New in: rippled 1.7.0][].
## {{currentpage.name}} JSONの例

8
content/references/protocol-reference/serialization.md
View File

@@ -59,7 +59,7 @@ Both signed and unsigned transactions can be represented in both JSON and binary
The serialization processes described here are implemented in multiple places and programming languages:
- In C++ [in the `rippled` code base](https://github.com/ripple/rippled/blob/develop/src/ripple/protocol/impl/STObject.cpp).
- In JavaScript in the [`ripple-binary-codec`](https://github.com/ripple/ripple-binary-codec/) package.
- In JavaScript in the [`ripple-binary-codec`](https://github.com/XRPLF/xrpl.js/tree/main/packages/ripple-binary-codec) package.
- In Python 3 in [this repository's code samples section]({{target.github_forkurl}}/blob/{{target.github_branch}}/content/_code-samples/tx-serialization/).
Additionally, many [client libraries](client-libraries.html) provide serialization support under permissive open-source licenses, so you can import, use, or adapt the code for your needs.
@@ -76,7 +76,7 @@ For example, the `Flags` [common transaction field](transaction-common-fields.ht
The following JSON file defines the important constants you need for serializing XRP Ledger data to its binary format and deserializing it from binary:
**<https://github.com/ripple/ripple-binary-codec/blob/master/src/enums/definitions.json>**
**<https://github.com/XRPLF/xrpl.js/blob/main/packages/ripple-binary-codec/src/enums/definitions.json>**
The following table defines the top-level fields from the definitions file:
@@ -241,7 +241,7 @@ The following diagram shows the serialization formats for both XRP amounts and t
The XRP Ledger uses 64 bits to serialize the numeric amount of a (fungible) token. (In JSON format, the numeric amount is the `value` field of a currency amount object.) In binary format, the numeric amount consists of a "not XRP" bit, a sign bit, significant digits, and an exponent, in order:
1. The first (most significant) bit for an token amount is `1` to indicate that it is not an XRP amount. (XRP amounts always have the most significant bit set to `0` to distinguish them from this format.)
1. The first (most significant) bit for a token amount is `1` to indicate that it is not an XRP amount. (XRP amounts always have the most significant bit set to `0` to distinguish them from this format.)
2. The sign bit indicates whether the amount is positive or negative. Unlike standard [two's complement](https://en.wikipedia.org/wiki/Two%27s_complement) integers, `1` indicates **positive** in the XRP Ledger format, and `0` indicates negative.
3. The next 8 bits represent the exponent as an unsigned integer. The exponent indicates the scale (what power of 10 the significant digits should be multiplied by) in the range -96 to +80 (inclusive). However, when serializing, we add 97 to the exponent to make it possible to serialize as an unsigned integer. Thus, a serialized value of `1` indicates an exponent of `-96`, a serialized value of `177` indicates an exponent of 80, and so on.
4. The remaining 54 bits represent the significant digits (sometimes called a _mantissa_) as an unsigned integer. When serializing, this value is normalized to the range 10<sup>15</sup> (`1000000000000000`) to 10<sup>16</sup>-1 (`9999999999999999`) inclusive, except for the special case of the value 0. In the special case for 0, the sign bit, exponent, and significant digits are all zeroes, so the 64-bit value is serialized as `0x8000000000000000000000000000000000000000`.
@@ -338,7 +338,7 @@ Some combinations are invalid; see [Path Specifications](paths.html#path-specifi
The AccountIDs in the `account` and `issuer` fields are presented _without_ a length prefix. When the `currency` is XRP, the currency code is represented as 160 bits of zeroes.
Each step is followed directly by the next step of the path. As described above, last step of a path is followed by either `0xff` (if another path follows) or `0x00` (if this ends the last path).
Each step is followed directly by the next step of the path. As described above, the last step of a path is followed by either `0xff` (if another path follows) or `0x00` (if this ends the last path).
The following example shows the serialization format for a PathSet:

2
content/references/protocol-reference/transactions/transaction-types/ticketcreate.ja.md
View File

@@ -11,7 +11,7 @@ labels:
_([TicketBatch amendment][]が必要です)_
TicketCreateトランザクションは、1つまたは複数の[シーケンス番号][sequence numbers]を[Tickets](ticket.html)として確保します。
TicketCreateトランザクションは、1つまたは複数の[シーケンス番号](basic-data-types.html#アカウントシーケンス)を[Tickets](ticket.html)として確保します。
## {{currentpage.name}}JSONの例

13
content/references/xrp-api.ja.md Normal file
View File

@@ -0,0 +1,13 @@
---
html: xrp-api.html
parent: references.html
blurb: XRP LedgerにRESTライクのインターフェイスを提供するAPIサーバ
template: pagetype-redirect.html.jinja
redirect_url: https://xpring-eng.github.io/xrp-api/
nav_omit: true
filters:
- xrpapi_readme
---
# XRP-API
XRP-API サーバーは、XRP Ledger への REST ライクな代替インターフェースを提供しますが、現在安定したソフトウェアとは言えず、積極的なサポートは行っていません。

339
content/references/xrpljs2-migration-guide.ja.md Normal file
View File

@@ -0,0 +1,339 @@
---
html: xrpljs2-migration-guide.html
blurb: JavaScriptコードをより新しいクライアントライブラリに移行する方法を学びましょう。
parent: https://js.xrpl.org/
---
# ripple-lib 1.xからxrpl.js 2.xへの移行ガイド
**ripple-lib** (1.x)ライブラリからJavaScript / TypeScriptコードを移行し、代わりにXRP Ledger用**xrpl.js** (2.x)ライブラリーを使用するためには、以下の手順に従ってください。
**ヒント:** 必要な場合は、依然[legacy 1.x "RippleAPI"用ドキュメンテーション](https://github.com/XRPLF/xrpl.js/blob/1.x/docs/index.md)にアクセスできます。
## 差異の概略
xrpl.js v2.0では、多くのフィールドと機能に"新しい"名前があります。より正確には、xrpl.jsは現在、[HTTP / WebSocket APIs](http-websocket-apis.html)と同じ名前を使用しています。XRP Ledgerで実行可能な"OfferCancel"のような[トランザクションタイプ](transaction-types.html)をライブラリが使用する場所では、"orderCancellation"オブジェクトのようなripple-libに特有の構造はなくなりました。ripple-lib 1.xでこれらの構造をリターンする多くのAPIメソッドはなくなりました。2.0では、WebSocket APIと同じフォーマットでリクエスト、レスポンスを行います。
ripple-lib 1.xからの包括的な`RippleAPI`クラスもなくなりました。xrpl.js 2.xでは、ネットワーク運用のための`Client`クラスがあり、その他全ての運用は厳格にオフラインです。アドレスとキーのための新しい`Wallet`クラス、また、トップレベルの`xrpl`オブジェクトの下にその他のクラスとプロパティがあります。
## 定型文での比較
**ripple-lib 1.10.0:**
```js
const ripple = require('ripple-lib');
(async function() {
const api = new ripple.RippleAPI({
server: 'wss://xrplcluster.com'
});
await api.connect();
// Your code here
api.disconnect();
})();
```
**xrpl.js 2.0.0:**
```js
const xrpl = require("xrpl");
(async function() {
const client = new xrpl.Client('wss://xrplcluster.com');
await client.connect();
// Your code here
client.disconnect();
})();
```
## バリデーション結果
デフォルトでは、ripple-lib 1.xにおけるほとんどのメソッドは、[コンセンサスプロセス](consensus.html)によって検証された最終結果をリターンするのみでした。xrpl.jsと同等の多くのメソッドは、WebSocket APIをコールするために[`Client.request()`メソッド](https://js.xrpl.org/classes/Client.html#request)を使用します。WebSocket APIにおいて、XRP Ledgerサーバーのデフォルト設定では、検証済みデータだけはなく未検証のデータを含むことがあります。
[分散型取引所](decentralized-exchange.html)の状態を調べる時のように、完了見込みの多数のトランザクション結果が保留中であるため、現時点のオープンレジャーを使用したい場合があります。また、完了したトランザクション結果を取り込んだ検証済みのレジャーを使用したい場合もあります。
xrpl.js 2.0が`Client.request()`を使用してAPIリクエストをする際、明確に[使用するレジャー番号を指定する](basic-data-types.html#specifying-ledgers)必要があります。例えば、最新の_検証済みレジャー_を使用してトラストラインを調べるためには:
**ripple-lib 1.x:**
```js
const trustlines = await api.getTrustlines("rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn")
console.log(trustlines)
```
**xrpl.js 2.0:**
```js
const trustlines = await client.request({
"command": "account_lines",
"account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"ledger_index": "validated"
})
console.log(trustlines.result)
```
## トランザクションの送信
xrpl.jsには、トランザクションの署名および送信のための、また、XRP Ledgerブロックチェーンのトランザクション最終結果の確認を待機するための特有の補助機能があります:
- トランザクション送信および[最終結果](finality-of-results.html)の待機のために`submitAndWait()`を使用します。トランザクションが検証された場合、これは[txメソッド][]レスポンスにリゾルブし、そうでない場合、例外処理(exception)となります。例外処理(exception)は、トランザクションが検証されなかったことを保証しません。例えば、サーバーに[より大きなギャップ](reliable-transaction-submission.html#ledger-gaps)がある場合、トランザクションは、そのギャップの中で検証される可能性があります。
- 即時の送信およびリターンのために`submit()`を使用します。これは[submitメソッド][]レスポンスにリゾルブし、仮の(最終ではない)結果を表示します。もしXRP Ledgerサーバーへのトランザクション送信に問題があった場合、このメソッドは例外処理(exception)のみとなります。
どちらのメソッドに関しても、準備済みトランザクション説明と[`Wallet`インスタンス](#キーおよびウォレット)をパスすることによって、署名済みトランザクションをメソッドに直接パス、もしくは、送信直前にトランザクションに署名することができます。
```js
const tx_json = await client.autofill({
"TransactionType": "AccountSet",
"Account": wallet.address, // "wallet"はWalletクラスのインスタンス
"SetFlag": xrpl.AccountSetAsfFlags.asfRequireDest
})
try {
const submit_result = await client.submitAndWait(tx_json, wallet)
// submitAndWait() はトランザクションの結果が確定するまでreturnしません。
// トランザクションがネットワークに確認されなかった場合、XrplErrorが発生します。
// ディザスタリカバリには対応しません。
console.log("Transaction result:", submit_result)
} catch(err) {
console.log("Error submitting transaction:", err)
}
```
もしくは、トランザクション署名のためにwalletの`sign`メソッドを、送信のために`submitAndWait(tx_blob)`を使用することができます。
停電やその他災害から復旧させる[信頼できるトランザクションの送信](reliable-transaction-submission.html)のビルドに便利です。(ライブラリは単独でディザスタリカバリに対処しません。)
### LastLedgerSequenceのコントロール
ripple-lib 1.xでは、トランザクションを準備し、準備済みトランザクションの`LastLedgerSequence`パラメータを、その時点で最新の検証済みレジャー番号 _以降_ のレジャー番号を指定する際、`instructions.maxLedgerVersionOffset`を利用できました。2.0では、最新の検証済みレジャー番号を調べ、トランザクションのオートフィル前に`LastLedgerSequence`を明確に指定することが可能です。
**xrpl.js 2.0:**
```js
const vli = await client.getLedgerIndex()
const prepared = await client.autofill({
"TransactionType": "Payment",
"Account": sender,
"Amount": xrpl.xrpToDrops("50.2"),
"Destination": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
"LastLedgerSequence": vli+75 // デフォルトの1分以内ではなく5分以内
})
```
旧メソッド同様、デフォルトでは、`Client.autofill()`は合理的な`LastLedgerSequence`値を提示します。`LastLedgerSequence`フィールドが _ない_ トランザクションを準備するには、`null`値の`LastLedgerSequence`を提示します:
```js
const prepared = await client.autofill({
"TransactionType": "Payment",
"Account": sender,
"Amount": xrpl.xrpToDrops("50.2"),
"Destination": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
"LastLedgerSequence": null // トランザクションは有効期限切れになりません
})
```
## キーおよびウォレット
xrpl.js 2.0は、[暗号鍵](cryptographic-keys.html)の管理およびトランザクションの署名のために、新しい[`Wallet`クラス](https://js.xrpl.org/classes/Wallet.html)を採用します。
これは、ripple-lib 1.xにおいてシードや秘密鍵を取得していた機能に代わるもので、多様なアドレス符号化やタスク生成も処理します。
### キーの生成
**ripple-lib 1.x:**
```js
const api = new RippleAPI()
const {address, secret} = api.generateAddress({algorithm: "ed25519"})
console.log(address, secret)
// rJvMQ3cwtyrNpVJDTW4pZzLnGeovHcdE6E s████████████████████████████
```
**xrpl.js 2.0:**
```js
const wallet = xrpl.Wallet.generate("ed25519")
console.log(wallet)
// Wallet {
// publicKey: 'ED872A4099B61B0C187C6A27258F49B421AC384FBAD23F31330E666A5F50E0ED7E',
// privateKey: 'ED224D2BDCF6382030C7612654D2118C5CEE16344C81CB36EC7A01EC7D95C5F737',
// classicAddress: 'rMV3CPSXAdRpW96bvvnSu4zHTZ6ETBkQkd',
// seed: 's████████████████████████████'
// }
```
### シードおよび署名からの取得
**ripple-lib 1.x:**
```js
const api = new RippleAPI()
const seed = 's████████████████████████████';
const keypair = api.deriveKeypair(seed)
const address = api.deriveAddress(keypair.publicKey)
const tx_json = {
"Account": address,
"TransactionType":"Payment",
"Destination":"rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
"Amount":"13000000",
"Flags":2147483648,
"LastLedgerSequence":7835923,
"Fee":"13",
"Sequence":2
}
const signed = api.sign(JSON.stringify(tx_json), seed)
```
**xrpl.js 2.0:**
```js
const wallet = xrpl.Wallet.fromSeed('s████████████████████████████')
const tx_json = {
"Account": wallet.address,
"TransactionType":"Payment",
"Destination":"rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
"Amount":"13000000",
"Flags":2147483648,
"LastLedgerSequence":7835923,
"Fee":"13",
"Sequence":2
}
const signed = wallet.sign(tx_json)
```
## イベントおよびサブスクリプション
1.xでは、`RippleAPI`クラスの`.on()`メソッドを使用してレジャーイベントとAPIエラーにサブスクリプションできました。もしくは、`.connection.on()`を使用して特定のWebSocketメッセージタイプにサブスクリプションできました。これらは、[`Client.on()`メソッド](https://js.xrpl.org/classes/Client.html#on)に統合されました。さらに、XRP Ledgerサーバーに接続する際、クライアントライブラリは、自動的にレジャークローズイベントにサブスクリプションしなくなったため、ハンドラを追加するだけでなく、レジャークローズイベントを取得するために **明確に台帳ストリームにサブスクリプションする必要があります** 。
レジャークローズイベントにサブスクリプションするには、`Client.(method)`を使用し、`"streams": ["ledger"]`で[subscribeメソッド][]をコールします。イベントハンドラを追加するには、`Client.on(event_type, callback)`を使用します。これらのコールは任意の順で実行可能です。
1.xからのRippleAPI特有の`ledger`イベントタイプは削除され、代わりに、`ledgerClosed`イベントを使用します。これらのイベントメッセージは同じデータを含んでいますが、フォーマットはWebSocket APIの[レジャーストリーム](subscribe.html#レジャーストリーム)メッセージに対応しています。
例:
**ripple-lib 1.x:**
```js
api.on("ledger", (ledger) => {
console.log(`Ledger #${ledger.ledgerVersion} closed!
It contains ${ledger.transactionCount} transaction(s) and has
the ledger_hash ${ledger.ledgerHash}.`
)
})
// "ledger"イベントはAPI接続が確立後自動的に開始します。
```
**xrpl.js 2.0:**
```js
client.on("ledgerClosed", (ledger) => {
console.log(`Ledger #${ledger.ledger_index} closed!
It contains ${ledger.txn_count} transaction(s) and has
the ledger_hash ${ledger.ledger_hash}.`
)
})
// ”ledgerClosed "イベントを取得するには、"ledger "ストリームを明示的にサブスクライブする必要があります。
client.request({
"command": "subscribe",
"streams": ["ledger"]
})
```
## 比較対照
ripple-lib 1.xでは、全てのメソッドとプロパティは、`RippleAPI`クラスのインスタンスでした。xrpl.js 2.xでは、ライブラリの静的メソッドと特定のクラスに属するメソッドがあります。以下のテーブルにおいて、`Client.method()`という表記方法は、`method()`が`Client`クラスのインスタンスに属することを意味します。
**注記: 以下のテーブルには、3カラムあります。縦にスクロールすると、全ての情報を確認できます。**
| RippleAPIインスタンスメソッド/プロパティ | xrpl.jsメソッド/プロパティ | 注記 |
|-------------------|----------------|---|
| `new ripple.RippleAPI({server: url})` | [`new xrpl.Client(url)`](https://js.xrpl.org/classes/Client.html#constructor) | 複数のサーバに接続するには`xrpl.BroadcastClient([url1, url2, ..])` を使用してください。 |
| `request(command, options)` | [`Client.request(options)`](https://js.xrpl.org/classes/Client.html#request) | <ul><li>WebSocket API との一貫性を保つために `command` フィールドを `options` オブジェクトに移動しました。</li><li>1.x では、このメソッドの戻り値 (Promise がリゾルブしたとき) は `result` オブジェクトのみでした。現在は、[WebSocket 応答フォーマット](response-formatting.html) 全体が返されます。同様の値を得るには、戻り値の `result` フィールドを読み取ってください。 |
| `hasNextPage()` | [`xrpl.hasNextPage(response)`](https://js.xrpl.org/modules.html#hasNextPage) | こちらもご覧ください。 [`Client.requestNextPage()`](https://js.xrpl.org/classes/Client.html#requestNextPage) および [`Client.requestAll()`](https://js.xrpl.org/classes/Client.html#requestAll) |
| `requestNextPage()` | [`Client.requestNextPage()`](https://js.xrpl.org/classes/Client.html#requestNextPage) | |
| `computeBinaryTransactionHash()` | [`xrpl.hashes.hashTx()`](https://js.xrpl.org/modules.html#hashes) | |
| `classicAddressToXAddress()` | [`xrpl.classicAddressToXAddress()`](https://js.xrpl.org/modules.html#classicAddressToXAddress) | 現在は、モジュールの静的メソッドです。 |
| `xAddressToClassicAddress()` | [`xrpl.xAddressToClassicAddress()`](https://js.xrpl.org/modules.html#xAddressToClassicAddress) | 現在は、モジュールの静的メソッドです。 |
| `renameCounterpartyToIssuer(object)` | (削除済み - 注記カラムを参照) | xrpl.jsは常に`issuer`を既に使用しているので、今後は必要ありません。 |
| `formatBidsAndAsks()` | (削除済み - 注記カラムを参照) | No longer needed after changes to `getOrderbook()`. |
| `connect()` | [`Client.connect()`](https://js.xrpl.org/classes/Client.html#connect) | |
| `disconnect()` | [`Client.disconnect()`](https://js.xrpl.org/classes/Client.html#disconnect) | |
| `isConnected()` | [`Client.isConnected()`](https://js.xrpl.org/classes/Client.html#isConnected) | |
| `getServerInfo()` | (削除済み - 注記カラムを参照) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [server_info メソッド][] を呼び出してください。 |
| `getFee()` | (削除済み - 注記カラムを参照) | [トランザクションコスト][]を自動的に提供するには [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使ってください。または `Client.request({"command": "fee"})` を使って、現在のトランザクションコスト ( _XRPのdrops_ ) についての情報を調べることができます。 |
| `getLedgerVersion()` | [`Client.getLedgerIndex()`](https://js.xrpl.org/classes/Client.html#getLedgerIndex) | |
| `getTransaction()` | [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [tx メソッド][] を呼び出してください。**警告:** `getTransaction()` とは異なり、`tx` メソッドは [検証されていない最終結果](#バリデーション結果) を返すことがあります。トランザクションに対してアクションを起こす前に、レスポンスオブジェクトの中に `"validated": true` があるかどうかを必ず確認するようにしてください。 |
| `getTransactions()` | (削除済み - 注記カラムを参照) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [account_txメソッド][] を呼び出してください。 |
| `getTrustlines()` | (削除済み - 注記カラムを参照) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [account_lines メソッド][] を呼び出してください。**警告:** `getTrustlines()` とは異なり、`account_lines` は [検証されていない最終結果](#バリデーション結果) を返すことがあります。 |
| `getBalances()` | [`Client.getBalances()`](https://js.xrpl.org/classes/Client.html#getBalances) | |
| `getBalanceSheet()` | (削除済み - 注記カラムを参照) | 代わりに [`Client.getBalances()`](https://js.xrpl.org/classes/Client.html#getBalances) を使うか、 [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [gateway_balancesメソッド][] を呼び出してください。 |
| `getPaths()` | (削除済み - 注記カラムを参照) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [ripple_path_findメソッド][] を呼び出してください。 |
| `getOrders()` | (削除済み - 注記カラムを参照) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [account_offers メソッド][] を呼び出してください。 |
| `getOrderbook()` | [`Client.getOrderbook()`](https://js.xrpl.org/classes/Client.html#getOrderbook) | |
| `getSettings()` | (削除済み - 注記カラムを参照) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [account_info メソッド][] を呼び出してください。個々のフラグ設定のブール値を取得するには、 `Flags` フィールドで `xrpl.parseAccountRootFlags()` を使用します。**警告:** `getSettings()`とは異なり、`account_info` は [検証されていない最終結果](#バリデーション結果)を返すことがあります。 |
| `getAccountInfo(address, options)` | (削除済み - 注記カラムを参照) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [account_info メソッド][] を呼び出してください。**警告:** `getAccountInfo()` とは異なり、`account_info` は [検証されていない最終結果](#バリデーション結果) を返すことがあります。 |
| `getAccountObjects(address, options)` | (削除済み - 注記カラムを参照) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [account_objects メソッド][] を呼び出してください。**警告:** `getAccountObjects()` とは異なり、`account_objects` は [検証されていない最終結果](#バリデーション結果) を返すことがあります。 |
| `getPaymentChannel()` | (削除済み - 注記カラムを参照) | 代わりに [`Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って [ledger_entry method](ledger_entry.html#get-paychannel-object) を呼び出してください。**警告:** `getPaymentChannel()`とは異なり、`ledger_entry` は [検証されていない最終結果](#バリデーション結果)を返す可能性があります。|
| `getLedger()` | (削除済み - 注記カラムを参照) | `Client.request()`](https://js.xrpl.org/classes/Client.html#request) を使って、正確に [ledger メソッド][] を呼び出してください。**渓谷:** `getLedger()`とは異なり、`ledger` は [検証されていない最終的なレジャー](#バリデーション結果)を返すことがあります。 |
| `parseAccountFlags()` | [`xrpl.parseAccountRootFlags()`](https://js.xrpl.org/modules.html#parseAccountRootFlags) | 現在は、モジュールの静的メソッドです。 |
| `prepareTransaction()` | [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) | 詳しくは、[トランザクション送信](#トランザクションの送信)を参照してください。 |
| `preparePayment()` | (削除済み - 注記カラムを参照) | [Paymentトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareTrustline()` | (削除済み - 注記カラムを参照) | [TrustSetトランザクション][]を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareOrder()` | (削除済み - 注記カラムを参照) | [OfferCreateトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareOrderCancellation()` | (削除済み - 注記カラムを参照) | [OfferCancelトランザクション][]を構築し、[`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill)を代わりに使用することができます。 |
| `prepareSettings()` | (削除済み - 注記カラムを参照) | ほとんどの設定には、代わりに [AccountSetトランザクション][]を構築します。通常キーをローテート変更するには、[SetRegularKeyトランザクション][]を作成します。マルチシグの設定を追加または更新するには、代わりに[SignerListSetトランザクション][]を構築してください。これら3つの場合とも、トランザクションを準備するために [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareEscrowCreation()` | (削除済み - 注記カラムを参照) | [EscrowCreateトランザクション][]を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareEscrowCancellation()` | (削除済み - 注記カラムを参照) | [EscrowCancelトランザクション][]を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareEscrowExecution()` | (削除済み - 注記カラムを参照) | [EscrowFinishトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `preparePaymentChannelCreate()` | (削除済み - 注記カラムを参照) | [PaymentChannelCreateトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `preparePaymentChannelClaim()` | (削除済み - 注記カラムを参照) | [PaymentChannelClaimトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `preparePaymentChannelFund()` | (削除済み - 注記カラムを参照) | [PaymentChannelFundトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareCheckCreate()` | (削除済み - 注記カラムを参照) | [CheckCreateトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareCheckCancel()` | (削除済み - 注記カラムを参照) | [CheckCancelトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareCheckCash()` | (削除済み - 注記カラムを参照) | [CheckCashトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `prepareTicketCreate()` | (削除済み - 注記カラムを参照) | [TicketCreateトランザクション][] を構築し、代わりに [`Client.autofill()`](https://js.xrpl.org/classes/Client.html#autofill) を使用します。 |
| `sign()` | [`Wallet.sign()`](https://js.xrpl.org/classes/Wallet.html#sign) | 詳しくは、[キーおよびウォレット](#キーおよびウォレット)を参照してください。 |
| `combine()` | [`xrpl.multisign()`](https://js.xrpl.org/modules.html#multisign) | |
| `submit()` | [`Client.submit()`](https://js.xrpl.org/classes/Client.html#submit) | また、信頼性の高いトランザクション送信も可能になりました。詳細は、[トランザクション送信](#トランザクションの送信)を参照してください。 |
| `generateXAddress()` | [`xrpl.Wallet.generate()`](https://js.xrpl.org/classes/Wallet.html#generate) | `xrpl.Wallet.generate()` で [`Wallet` インスタンス](https://js.xrpl.org/classes/Wallet.html) を作成し、ウォレットのインスタンスで `.getXAddress()` を呼び出して X-address を取得します。 詳しくは、[キーおよびウォレット](#キーおよびウォレット)を参照してください。 |
| `generateAddress()` | [`xrpl.Wallet.generate()`](https://js.xrpl.org/classes/Wallet.html#generate) | [`Wallet`インスタンス](https://js.xrpl.org/classes/Wallet.html)を作成します。. 詳しくは、[キーおよびウォレット](#キーおよびウォレット)を参照してください。 |
| `isValidAddress()` | [`xrpl.isValidAddress()`](https://js.xrpl.org/modules.html#isValidAddress) | 現在は、モジュールの静的メソッドです。 |
| `isValidSecret()` | [`xrpl.isValidSecret()`](https://js.xrpl.org/modules.html#isValidSecret) | 現在は、モジュールの静的メソッドです。 |
| `deriveKeypair()` | [`xrpl.deriveKeypair()`](https://js.xrpl.org/modules.html#deriveKeypair) | 現在は、モジュールの静的メソッドです。 |
| `deriveAddress()` | (削除済み - 注記カラムを参照) | 公開鍵からX Addressを取得するために `xrpl.decodeXAddress()` を使用し、必要であれば `xAddressToClassicAddress()` を使用してクラシックアドレスを取得します。 |
| `generateFaucetWallet()` | [`Client.fundWallet()`](https://js.xrpl.org/classes/Client.html#fundWallet) | `on_testnet`ブール変数は削除されました。ライブラリは、接続しているネットワークに適したDevnetまたはTestnetのfaucetを自動的に選択します。オプションで [`Wallet` インスタンス](https://js.xrpl.org/classes/Wallet.html) を提供すると、faucetは関連するアドレスに資金を供給/補充します。そうでなければ、メソッドは新しいWalletインスタンスを作成します。そうでなければ、このメソッドは新しいウォレットインスタンスを作成します。戻り値は現在、`{wallet: <object: Wallet instance>, balance: <str: XRP of drops>}という形のオブジェクトになります。 |
| `signPaymentChannelClaim()` | [`xrpl.signPaymentChannelClaim()`](https://js.xrpl.org/modules.html#signPaymentChannelClaim) | 現在は、モジュールの静的メソッドです。 |
| `verifyPaymentChannelClaim()` | [`xrpl.verifyPaymentChannelClaim()`](https://js.xrpl.org/modules.html#verifyPaymentChannelClaim) | 現在は、モジュールの静的メソッドです。 |
| `computeLedgerHash()` | [`xrpl.hashes.hashLedger()`](https://js.xrpl.org/modules.html#hashes) | |
| `xrpToDrops()` | [`xrpl.xrpToDrops()`](https://js.xrpl.org/modules.html#xrpToDrops) | 現在は、モジュールの静的メソッドです。 |
| `dropsToXrp()` | [`xrpl.dropsToXrp()`](https://js.xrpl.org/modules.html#dropsToXrp) | 現在は、モジュールの静的メソッドです。 |
| `iso8601ToRippleTime()` | [`xrpl.isoTimeToRippleTime()`](https://js.xrpl.org/modules.html#isoTimeToRippleTime) | 現在は、モジュールの静的メソッドです。 |
| `rippleTimeToISO8601()` | [`xrpl.rippleTimeToISOTime()`](https://js.xrpl.org/modules.html#rippleTimeToISOTime) | 現在は、モジュールの静的メソッドです。 また、新しいメソッド [`rippleTimeToUnixTime()`](https://js.xrpl.org/modules.html#rippleTimeToUnixTime) を使うと、UNIXエポック 1970-01-01 00:00:00 UTC からのミリ秒単位のUNIXスタイルのタイムスタンプを取得することができます。 |
| `txFlags.Universal.FullyCanonicalSig` | (削除済み - 注記カラムを参照) | [RequireFullyCanonicalSig amendment][]に伴い、不要となりました。 |
| `txFlags.Payment.NoRippleDirect` | `xrpl.PaymentFlags.tfNoDirectRipple` | |
| `txFlags.Payment.PartialPayment` | `xrpl.PaymentFlags.tfPartialPayment` | |
| `txFlags.Payment.LimitQuality` | `xrpl.PaymentFlags.tfLimitQuality` | |
| `txFlags.OfferCreate.Passive` | `xrpl.OfferCreateFlags.tfPassive` | |
| `txFlags.OfferCreate.ImmediateOrCancel` | `xrpl.OfferCreateFlags.tfImmediateOrCancel` | |
| `txFlags.OfferCreate.FillOrKill` | `xrpl.OfferCreateFlags.tfFillOrKill` | |
| `txFlags.OfferCreate.Sell` | `xrpl.OfferCreateFlags.tfSell` | |
| `accountSetFlags` | `xrpl.AccountSetAsfFlags` | モジュールレベルでEnumになりました。 |
| `schemaValidator` | (削除済み - 注記カラムを参照) | TypeScriptを使用して、ほとんどの型を検証することができます。 |
| `schemaValidate()` | (削除済み - 注記カラムを参照) | TypeScriptを使用して、ほとんどの型を検証することができます。 トランザクションオブジェクトの検証を行うために `xrpl.validate(transaction)` を呼び出すこともできます。 |
| `.on("ledger", callback)` | [`Client.on("ledgerClosed", callback)`](https://js.xrpl.org/classes/Client.html#on) | **注意:** ledger streamもサブスクライブする必要があります。例と詳細については、[イベントとサブスクリプション](#イベントおよびサブスクリプション)を参照してください。 |
| `.on("error", callback)` | [`Client.on("error", callback)`](https://js.xrpl.org/classes/Client.html#on) | |
| `.on("connected", callback)` | [`Client.on("connected", callback)`](https://js.xrpl.org/classes/Client.html#on) | |
| `.on("disconnected", callback)` | [`Client.on("connected", callback)`](https://js.xrpl.org/classes/Client.html#on) | |
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

2
content/tutorials/get-started/public-servers.ja.md
View File

@@ -13,7 +13,7 @@ labels:
|:----------|:------------|:-------------|:--------------|:---------------------|
| XRP Ledger 財団 | **Mainnet** | `https://xrplcluster.com/` <br> `https://xrpl.ws/` [²][] | `wss://xrplcluster.com/` <br> `wss://xrpl.ws/` [²][] | 全履歴サーバークラスター |
| Ripple[¹][] | **Mainnet** | `https://s1.ripple.com:51234/` | `wss://s1.ripple.com/` | 汎用サーバークラスター |
| Ripple[¹][] | **Mainnet** | `https://s2.ripple.com:51234/` | `wss://s2.ripple.com/` | [全履歴サーバ](ledger-history.html#full-history) クラスタ |
| Ripple[¹][] | **Mainnet** | `https://s2.ripple.com:51234/` | `wss://s2.ripple.com/` | [全履歴サーバ](ledger-history.html#すべての履歴) クラスタ |
| Ripple[¹][] | Testnet | `https://s.altnet.rippletest.net:51234/` | `wss://s.altnet.rippletest.net/` | Testnet 公開サーバー |
| Ripple[¹][] | Devnet | `https://s.devnet.rippletest.net:51234/` | `wss://s.devnet.rippletest.net/` | Devnet 公開サーバー |

2
content/tutorials/manage-account-settings/disable-master-key-pair.ja.md
View File

@@ -10,7 +10,7 @@ labels:
このページでは、[アカウント](accounts.html)のアドレスに数学的に関連付けられた[マスターキーペア](cryptographic-keys.html)を無効化する方法について説明します。あなたのアカウントのマスターキーペアが漏洩した可能性がある場合、または[マルチ署名](multi-signing.html)をあなたのアカウントからトランザクションを送信する _唯一_ の方法としたい場合、これを行う必要があります。
**注意:** マスターキーペアを無効にすると、[トランザクションの承認](transaction-basics.html#authorizing-transactions)の方法の1つが削除されます。マスターキーペアを無効にする前に、レギュラーキーやマルチ・サインなど、他のトランザクションの承認方法のいずれかを使用できることを確認する必要があります。(例えば、[レギュラーキーペアを割り当てた場合](assign-a-regular-key-pair.html)は、そのレギュラーキーで正常にトランザクションを送信できることを確認してください)。XRP Ledgerは分散型であるため、残りの取引承認方法を使用できない場合、誰もあなたのアカウントへのアクセスを回復することができません。
**注意:** マスターキーペアを無効にすると、[トランザクションの承認](transaction-basics.html#トランザクションの承認)の方法の1つが削除されます。マスターキーペアを無効にする前に、レギュラーキーやマルチ・サインなど、他のトランザクションの承認方法のいずれかを使用できることを確認する必要があります。(例えば、[レギュラーキーペアを割り当てた場合](assign-a-regular-key-pair.html)は、そのレギュラーキーで正常にトランザクションを送信できることを確認してください)。XRP Ledgerは分散型であるため、残りの取引承認方法を使用できない場合、誰もあなたのアカウントへのアクセスを回復することができません。
**マスターキーペアを無効にするには、マスターキーペアを使用する必要があります。**
ただし、他のトランザクションの認証方法を使用してマスターキーペアを _再有効化_ することは可能です。

85
dactyl-config.yml
View File

@@ -103,6 +103,8 @@ targets:
"accountroot.html#accountroot-flags": "accountroot.html#accountrootのフラグ"
"trustset.html#trustset-flags": "trustset.html#trustsetのフラグ"
"basic-data-types.html#ledger-index": "basic-data-types.html#レジャーインデックス"
"partial-payments.html#the-delivered_amount-field": "partial-payments.html#delivered_amountフィールド"
"partial-payments.html#partial-payments-exploit": "partial-payments.html#partial-paymentの悪用"
# nearest approximation. this translation is also out of date
"rippled-server-modes.html#validators": "rippled-server-modes.html#バリデータを運用する理由"
# Fix links from untranslated open-a-payment-channel-to-enable-an-inter-exchange-network.html
@@ -115,11 +117,8 @@ targets:
"use-payment-channels.html#8-when-ready-the-payee-redeems-a-claim-for-the-authorized-amount": "use-payment-channels.html#8-準備が完了すれば受取人は承認された額のクレームを清算します"
"use-payment-channels.html#9-when-the-payer-and-payee-are-done-doing-business-the-payer-requests-for-the-channel-to-be-closed": "use-payment-channels.html#9-支払人と受取人の取引完了後支払人はchannelの閉鎖を要求します"
"reserves.html#owner-reserves": "reserves.html#所有者準備金"
# Fix links from untranslated disable-master-key-pair.html.
"transaction-basics.html#authorizing-transactions": "transaction-basics.html#トランザクションの承認"
# Fix links from untranslated issue-a-fungible-token.html:
"transaction-common-fields.html#auto-fillable-fields": "transaction-common-fields.html#自動入力可能なフィールド"
"set-up-secure-signing.html#use-a-dedicated-signing-device": "set-up-secure-signing.html#専用の署名デバイスを使用する"
"set-up-secure-signing.html#run-rippled-locally": "set-up-secure-signing.html#ローカルでrippledを実行する"
# Fix links from untranslated validator-list.html
"run-rippled-as-a-validator.html#3-enable-validation-on-your-rippled-server": "run-rippled-as-a-validator.html#3-rippledサーバーで検証を有効化"
"basic-data-types.html#specifying-time": "basic-data-types.html#時間の指定"
@@ -133,16 +132,11 @@ targets:
"transaction-metadata.html#affectednodes": "transaction-metadata.html"
# Fix link from untranslated peer-crawler.html:
"peer-protocol.html#private-peers": "peer-protocol.html#プライベートピア"
# Fix links from untranslated invariant-checking.html
"basic-data-types.html#account-sequence": "basic-data-types.html#アカウントシーケンス"
"xrp.html#xrp-properties": "xrp.html#xrpの特性"
# Fix links from untranslated health-check.html:
"rippled-server-modes.html#stand-alone-mode": "rippled-server-modes.html#rippledサーバーをスタンドアロンモードで実行する理由"
"server-doesnt-sync.html#normal-syncing-behavior": "server-doesnt-sync.html#通常の同期動作"
# Fix link from untranslated negativeunl.html and ledgers.html:
"consensus.html#validation": "consensus.html#検証"
# Fix link from untranslated tickets.html:
"consensus.html#calculate-and-share-validations": "consensus.html#検証の計算と共有"
# Fix link from untranslated manifest.html:
"rippled-server-modes.html#reporting-mode": "rippled-server-modes.html#レポーティングモード"
# Fix links for untranslated get-started-using-python.html:
@@ -154,27 +148,25 @@ targets:
"transaction-cost.html#current-transaction-cost": "transaction-cost.html#現在のトランザクションコスト"
"ledgers.html#open-closed-and-validated-ledgers": "ledgers.html#ツリーの形式"
"account_info.html#response-format": "account_info.html#応答フォーマット"
# Fix link from untranslated public-servers.html:
"ledger-history.html#full-history": "ledger-history.html#すべての履歴"
# Fix link from untranslated amendment-voting.html and rate-limiting.html:
# Fix link from untranslated rate-limiting.html:
"get-started-using-http-websocket-apis.html#admin-access": "get-started-using-http-websocket-apis.html#管理者アクセス権限"
# Fix links from untranslated issue-a-fungible-token.html
"xrp-ledger-toml.html#account-verification": "xrp-ledger-toml.html#アカウント検証"
"offers.html#offers-and-trust": "offers.html#オファーとトラスト"
"authorized-trust-lines.html#authorizing-trust-lines": "authorized-trust-lines.html#トラストラインの承認"
# Fix links from untranslated freeze tutorials:
"basic-data-types.html#account-sequence": "basic-data-types.html#アカウントシーケンス"
"accountset.html#accountset-flags": "accountset.html#accountsetのフラグ"
"ripplestate.html#ripplestate-flags": "ripplestate.html#ripplestateのフラグ"
# Fix links from untranslated xrpl.js 2.0 migration guide:
"basic-data-types.html#specifying-ledgers": "basic-data-types.html#レジャーの指定"
"subscribe.html#ledger-stream": "subscribe.html#レジャーストリーム"
# the updates to ledger_entry aren't translated either
"ledger_entry.html#get-paychannel-object": "ledger_entry.html"
"reliable-transaction-submission.html#ledger-gaps": "reliable-transaction-submission.html#レジャーのギャップ"
# Fix links from untranslated NFT transaction references:
"transaction-common-fields.html#flags-field": "transaction-common-fields.html#flagsフィールド"
"transaction-common-fields.html#memos-field": "transaction-common-fields.html#memosフィールド"
# Fix links from untranslated Python wallet tutorial:
"basic-data-types.html#specifying-ledgers": "basic-data-types.html#レジャーの指定"
# Fix links from untranslated build-a-desktop-wallet-in-python.html:
"subscribe.html#ledger-stream": "subscribe.html#レジャーストリーム"
"subscribe.html#transaction-streams": "subscribe.html#トランザクションストリーム"
# cryptographic-keys.html hasn't been updated in Japanese, so this is the
# next-nearest equivalent of the #seed anchor:
@@ -191,10 +183,12 @@ targets:
"peer-protocol.html#node-key-pair": "peer-protocol.html#ノードキーペア"
"transaction-cost.html#local-load-cost": "transaction-cost.html#ローカル負荷コスト"
"transaction-cost.html#open-ledger-cost": "transaction-cost.html#オープンレジャーコスト"
# Fix links from untranslated become-an-xrp-ledger-gateway.htm:
"partial-payments.html#the-delivered_amount-field": "partial-payments.html#delivered_amountフィールド"
"partial-payments.html#partial-payments-exploit": "partial-payments.html#partial-paymentの悪用"
# Fix links from untranslated ledger-clio.html
"basic-data-types.html#hashes": "basic-data-types.html#ハッシュ"
"transaction-cost.html#fee-levels": "transaction-cost.html#手数料レベル"
"offers.html#lifecycle-of-an-offer": "offers.html#オファーのライフサイクル"
"subscribe.html#order-book-streams": "subscribe.html#オーダーブックストリーム"
"transaction-basics.html#authorizing-transactions": "transaction-basics.html#トランザクションの識別"
pages:
@@ -553,6 +547,7 @@ pages:
targets:
- en
# TODO: update translation based on latest English version
- md: concepts/payment-system-basics/accounts/cryptographic-keys.ja.md
targets:
- ja
@@ -1000,6 +995,7 @@ pages:
targets:
- en
# TODO: Update this translation for the latest English version
- md: concepts/xrpl-servers/rippled-server-modes.ja.md
targets:
- ja
@@ -1795,6 +1791,7 @@ pages:
targets:
- en
# TODO: update this translation and rename the file like in the English version
- md: tutorials/manage-the-rippled-server/configuration/run-rippled-as-a-wallet-server.ja.md
targets:
- ja
@@ -2113,6 +2110,7 @@ pages:
targets:
- en
# TODO: update translation to add a table like in the English version
- md: references/protocol-reference/data-types/currency-formats.ja.md
targets:
- ja
@@ -2571,6 +2569,7 @@ pages:
targets:
- en
# TODO: update translation to latest English version
- md: references/protocol-reference/transactions/transaction-metadata.ja.md
targets:
- ja
@@ -2597,6 +2596,9 @@ pages:
- md: references/client-libraries.md
targets:
- en
- md: references/client-libraries.ja.md
targets:
- ja
# Redirect old ripple-lib docs.
@@ -2622,6 +2624,9 @@ pages:
- md: references/xrpljs2-migration-guide.md
targets:
- en
- md: references/xrpljs2-migration-guide.ja.md
targets:
- ja
- name: Python Client Library
@@ -3114,12 +3119,6 @@ pages:
targets:
- ja
# TODO: translate
- md: references/http-websocket-apis/public-api-methods/server-info-methods/server_info-clio.md
targets:
- en
- ja
- md: references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md
targets:
- en
@@ -3128,6 +3127,34 @@ pages:
targets:
- ja
# TODO: translate
- name: Clio Server Methods
html: clio-methods.html
parent: public-api-methods.html
blurb: Use these methods to retrieve information using Clio server APIs.
template: pagetype-category.html.jinja
targets:
- en
- ja
# TODO: translate
- md: references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md
targets:
- en
- ja
# TODO: translate
- md: references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md
targets:
- en
- ja
# TODO: translate
- md: references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md
targets:
- en
- ja
- name: Utility Methods
html: utility-methods.html
parent: public-api-methods.html
@@ -3287,6 +3314,9 @@ pages:
- md: references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/node_to_shard.md
targets:
- en
- md: references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/node_to_shard.ja.md
targets:
- ja
#TODO: translate title and blurb
@@ -3527,6 +3557,9 @@ pages:
- md: references/xrp-api.md
targets:
- en
- md: references/xrp-api.ja.md
targets:
- ja
# Deprecation warnings for old Data API docs

7
styles/_pages.scss
View File

@@ -1010,6 +1010,13 @@
}
}
#xrpl-design-assets {
padding-bottom: 5rem;
@include media-breakpoint-up(md) {
padding-top: 104px;
padding-bottom: 208px;
}
}
}

27
template/page-community.html.jinja
View File

@@ -233,6 +233,33 @@
</div>
</section>
<!-- XRPL Design Assets -->
<section class="container-new" id="xrpl-design-assets">
<div class="card-grid card-grid-2xN ">
<div class="col pt-5">
<div class="d-flex flex-column-reverse mb-lg-2 pl-0">
<h2 class="h4 h2-sm">{% trans %}Review guidelines for using XRPL design assets{% endtrans %}</h2>
<h6 class="eyebrow mb-3">{% trans %}XRPL Assets{% endtrans %}</h6>
</div>
<p class="mb-3 py-4">{% trans %}Just like the technology itself, XRPL assets are open source and available for anyone to use. Check out this helpful framework for using XRPL visuals. {% endtrans %}</p>
<div class="col pr-2 d-lg-none d-block mb-4 pb-3 mb-lg-3">
<div class=" pr-1 mr-3">
<img src="./assets/img/community/community-design-assets.png" class="w-100">
</div>
</div>
<div >
<a class="btn btn-primary btn-arrow" target="_blank" href="{{target.github_forkurl}}/raw/{{target.github_branch}}/content/XRPL_Logo_Kit.zip">{% trans %}Download the PDF and Assets{% endtrans %}</a>
</div>
</div>
<div class="col pr-2 d-lg-block d-none">
<div class=" pr-1 mr-3">
<img src="./assets/img/community/community-design-assets.png" class="w-100">
</div>
</div>
</div>
</section>
<section class="container-new">
<div class="col-md-6 offset-md-3 p-6-sm p-10-until-sm br-8 cta-card">

2
template/page-history.html.jinja
View File

@@ -100,7 +100,7 @@
<h2 class="mb-6 h5 h2-sm">{% trans %}XRPL Foundation Launched{% endtrans %}</h2>
<h6 class="h1 mb-3">2020</h6>
</div>
<p>{% trans %}<a href="https://xrplf.org/assets/XRP_Foundation_Release_24Sep2020.pdf" target="_blank">Founded</a> September 24, 2020, the XRPL Foundation is an independent and nonprofit entity with a mission to accelerate the development and adoption of the decentralized XRP Ledger. The Foundation received an initial donation of over $6.5M from Coil, Ripple, and Gatehub to fund the Foundation’s work in service of the growing number of developers and other community members building on the XRP Ledger.{% endtrans %}</p>
<p>{% trans %}<a href="https://foundation.xrpl.org/2020/09/24/xrp-ledger-foundation-launches-to-drive-growth-and-development-of-the-core-xrp-ledger-and-community/" target="_blank">Founded</a> September 24, 2020, the XRPL Foundation is an independent and nonprofit entity with a mission to accelerate the development and adoption of the decentralized XRP Ledger. The Foundation received an initial donation of over $6.5M from Coil, Ripple, and Gatehub to fund the Foundation’s work in service of the growing number of developers and other community members building on the XRP Ledger.{% endtrans %}</p>
</div>
</div>
</div>