mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-25 14:15:50 +00:00
Use frontmatter in references
This commit is contained in:
mDuo13
@@ -1,5 +1,11 @@
|
||||
---
|
||||
html: api-conventions.html
|
||||
parent: rippled-api.html
|
||||
blurb: rippled APIのデータ型とフォーマットについて説明します。
|
||||
template: template-landing-children.html
|
||||
---
|
||||
# APIの規則
|
||||
|
||||
このセクションでは、JSON-RPCおよびWebSocketインターフェイスを含む`rippled` APIのデータ型とフォーマットについて説明します。
|
||||
|
||||
これらのデータ型の一部は、[Data API](data-api.html)を含む、より高度なAPIにも使用されます。
|
||||
これらのデータ型の一部は、[Data API](data-api.html)を含む、より高度なAPIにも使用されます。
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
html: api-conventions.html
|
||||
parent: rippled-api.html
|
||||
blurb: Common conventions used across the rippled API.
|
||||
template: template-landing-children.html
|
||||
---
|
||||
# API Conventions
|
||||
|
||||
This section describes data types and formats of the `rippled` APIs, including JSON-RPC and WebSocket interfaces.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: base58-encodings.html
|
||||
parent: api-conventions.html
|
||||
blurb: 暗号鍵と関連データをbase58形式で表すフォーマットです。
|
||||
---
|
||||
# base58エンコード
|
||||
|
||||
`rippled` APIでは、チェックサムを含む**base58**エンコード（「Base58Check」とも呼ばれます）を使用して[アカウントアドレス](accounts.html#アドレス)や暗号鍵に関連するその他のタイプの値が表現されることがよくあります。このエンコードは、[Bitcoinのアドレスに使用されているエンコード](https://en.bitcoin.it/wiki/Base58Check_encoding)と同じですが、XRP Ledgerでは以下のディクショナリが使用される点が異なります。`rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz`。
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: base58-encodings.html
|
||||
parent: api-conventions.html
|
||||
blurb: Formats for representing cryptographic keys and related data in base58 format.
|
||||
---
|
||||
# base58 Encodings
|
||||
|
||||
The `rippled` APIs often use a "base58" encoding with a checksum (sometimes called "Base58Check") to represent [account addresses](accounts.html#addresses) and other types of values related to cryptographic keys. This encoding is the same as [the one used for Bitcoin addresses](https://en.bitcoin.it/wiki/Base58Check_encoding), except that the XRP Ledger uses the following dictionary: `rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz`.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: basic-data-types.html
|
||||
parent: api-conventions.html
|
||||
blurb: さまざまなタイプのオブジェクトがそれぞれ異なる方法で一意に識別されます。
|
||||
---
|
||||
# 基本的なデータ型
|
||||
|
||||
さまざまなタイプのオブジェクトがそれぞれ異なる方法で一意に識別されます。
|
||||
@@ -22,7 +27,7 @@
|
||||
<!--{#_ #}-->
|
||||
|
||||
### ハッシュプレフィクス
|
||||
[[ソース]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/protocol/HashPrefix.h "Source")
|
||||
[[ソース]](https://github.com/ripple/rippled/blob/master/src/ripple/protocol/HashPrefix.h "Source")
|
||||
|
||||
多くの場合、XRP Ledgerではオブジェクトのバイナリデータに4バイトのプレフィクスを付けてからハッシュを計算するため、異なるタイプのオブジェクトが同じバイナリフォーマットである場合でも、異なるハッシュが設定されます。既存の4バイトコードは、ASCIIでエンコードされた英字3文字の後に0バイトが続く構成となっています。
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: basic-data-types.html
|
||||
parent: api-conventions.html
|
||||
blurb: Format and meaning of fundamental data types like addresses, ledger index, and currency codes.
|
||||
---
|
||||
# Basic Data Types
|
||||
|
||||
Different types of objects are uniquely identified in different ways:
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: currency-formats.html
|
||||
parent: api-conventions.html
|
||||
blurb: 通貨番号の精度と範囲、カスタム通貨コードのフォーマットです。
|
||||
---
|
||||
# 通貨フォーマット
|
||||
|
||||
XRP Ledgerには2種類の通貨（[XRP](xrp.html)と[発行済み通貨](issued-currencies.html)）があります。XRP Ledgerでは、これらの通貨のフォーマットは異なりますが、いずれの通貨も高精度です。
|
||||
@@ -27,7 +32,7 @@ XRP Ledgerの発行済み通貨は、以下の精度のカスタムフォーマ
|
||||
* 10進15桁の精度
|
||||
|
||||
## 発行済み通貨の計算
|
||||
[[ソース]<br>](https://github.com/ripple/rippled/blob/35fa20a110e3d43ffc1e9e664fc9017b6f2747ae/src/ripple/protocol/impl/STAmount.cpp "Source")
|
||||
[[ソース]](https://github.com/ripple/rippled/blob/35fa20a110e3d43ffc1e9e664fc9017b6f2747ae/src/ripple/protocol/impl/STAmount.cpp "Source")
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: currency-formats.html
|
||||
parent: api-conventions.html
|
||||
blurb: Precision and range for currency numbers, plus formats of custom currency codes.
|
||||
---
|
||||
# Currency Formats
|
||||
|
||||
The XRP Ledger has two kinds of money: [XRP](xrp.html), and [issued currencies](issued-currencies.html). Both types have high precision, although their formats are different.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: error-formatting.html
|
||||
parent: api-conventions.html
|
||||
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスのエラーフォーマットと汎用エラーコードです。
|
||||
---
|
||||
# エラーのフォーマット
|
||||
|
||||
エラーが発生する可能性のある状況をすべて挙げることは不可能です。トランスポートレイヤーで発生する場合（ネットワーク接続が失われる場合など）には、使用しているクライアントとトランスポートに応じてその結果は異なります。ただし、`rippled`サーバーが要求を正常に受信した場合、サーバーは標準のエラー形式での応答を試みます。
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: error-formatting.html
|
||||
parent: api-conventions.html
|
||||
blurb: Error formats and common error codes for WebSocket, JSON-RPC, and Commandline interfaces.
|
||||
---
|
||||
# Error Formatting
|
||||
|
||||
It is impossible to list all the possible ways an error can occur. Some may occur in the transport layer (for example, loss of network connectivity), in which case the results vary depending on what client and transport you are using. However, if the `rippled` server successfully receives your request, it tries to respond in a standardized error format.
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
---
|
||||
html: markers-and-pagination.html
|
||||
parent: api-conventions.html
|
||||
blurb: 大きなクエリを複数の応答にページネーションする際の慣例です。
|
||||
---
|
||||
# マーカーとページネーション
|
||||
|
||||
一部のメソッドから返されるデータは、1つの応答に実質的に収まらないことがあります。結果全体が収まらない場合、応答には`marker`フィールドが含まれます。このフィールドを使用することで、複数回の呼出しを通じてデータのページをさらに取得できます。各要求で直前の応答の`marker`値を渡して、終わったところから再開します。応答に`marker`が含まれていなければ、データセットの終わりに達しています。
|
||||
|
||||
`marker`フィールドのフォーマットは意図的に未定義になっています。各サーバーで`marker`をそれぞれに合わせて定義できるので、このフィールドの形式は文字列、ネストオブジェクトなどさまざまです。異なるサーバー、または同じサーバーの異なるメソッドでは、異なる`marker`定義を使用できます。各`marker`は一時的であり、10分以上経過すると予期されているとおりに機能しなくなることがあります。
|
||||
`marker`フィールドのフォーマットは意図的に未定義になっています。各サーバーで`marker`をそれぞれに合わせて定義できるので、このフィールドの形式は文字列、ネストオブジェクトなどさまざまです。異なるサーバー、または同じサーバーの異なるメソッドでは、異なる`marker`定義を使用できます。各`marker`は一時的であり、10分以上経過すると予期されているとおりに機能しなくなることがあります。
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: markers-and-pagination.html
|
||||
parent: api-conventions.html
|
||||
blurb: Convention for paginating large queries into multiple responses.
|
||||
---
|
||||
# Markers and Pagination
|
||||
|
||||
Some methods return more data than can efficiently fit into one response. When there are more results than contained, the response includes a `marker` field. You can use this to retrieve more pages of data across multiple calls. In each request, pass the `marker` value from the previous response to resume from the point where you left off. If the `marker` is omitted from a response, then you have reached the end of the data set.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: modifying-the-ledger.html
|
||||
parent: api-conventions.html
|
||||
blurb: トランザクションだけがレジャーを変更できる理由とその方法です。
|
||||
---
|
||||
# レジャーの変更
|
||||
|
||||
XRP Ledgerに対する変更はすべて、トランザクションの結果として行われます。XRP Ledgerの内容を変更できるAPIメソッドは、トランザクションを送信するコマンドだけです。Ledgerの内容が変更されても、その変更が永続的に適用されるのは、トランザクションが[コンセンサスプロセス](consensus.html)により承認されている場合に限られます。その他のほとんどのパブリックメソッドでは、異なる方法でXRP Ledgerに表示されるデータを閲覧し、サーバーの状態に関する情報を要求します。
|
||||
@@ -12,4 +17,4 @@ XRP Ledgerに対する変更はすべて、トランザクションの結果と
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: modifying-the-ledger.html
|
||||
parent: api-conventions.html
|
||||
blurb: Why and how only transactions can modify the ledger.
|
||||
---
|
||||
# Modifying the Ledger
|
||||
|
||||
All changes to the XRP Ledger happen as the result of transactions. The only API methods that can change the contents of the XRP Ledger are the commands that submit transactions. Even then, changes only apply permanently if the transactions are approved by the [consensus process](consensus.html). Most other public methods represent different ways to view the data represented in the XRP Ledger, or request information about the state of the server.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: rate-limiting.html
|
||||
parent: api-conventions.html
|
||||
blurb: Information on how public APIs limit clients from making too many requests.
|
||||
---
|
||||
# Rate Limiting
|
||||
|
||||
The `rippled` server limits the rate at which API clients can make requests on public APIs. Rate limiting is based on the IP address of the client, so clients behind [network address translation](https://en.wikipedia.org/wiki/Network_address_translation) share a limit based on their public IP address.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: request-formatting.html
|
||||
parent: api-conventions.html
|
||||
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの標準の要求フォーマットと例です。
|
||||
---
|
||||
# 要求フォーマット
|
||||
|
||||
## WebSocketフォーマット
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: request-formatting.html
|
||||
parent: api-conventions.html
|
||||
blurb: Standard request format, with examples, for the WebSocket, JSON-RPC, and Commandline interfaces.
|
||||
---
|
||||
# Request Formatting
|
||||
|
||||
## Example Request
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: response-formatting.html
|
||||
parent: api-conventions.html
|
||||
blurb: WebSocket、JSON-RPC、コマンドラインインターフェイスの応答のフォーマットとその応答に含まれるフィールド。
|
||||
---
|
||||
# 応答フォーマット
|
||||
|
||||
`rippled` APIからの応答のフォーマットは、メソッドが呼び出されたインターフェイス（WebSocket、JSON-RPC、コマンドライン）に応じて多少異なります。コマンドラインインターフェイスがJSON-RPCを呼び出すため、コマンドラインインターフェイスとJSON-RPCインターフェイスは同じフォーマットを使用します。
|
||||
@@ -85,4 +90,4 @@ HTTP Status: 200 OK
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: response-formatting.html
|
||||
parent: api-conventions.html
|
||||
blurb: Standard response format, with examples, for the WebSocket, JSON-RPC, and Commandline interfaces.
|
||||
---
|
||||
# Response Formatting
|
||||
|
||||
Responses from the `rippled` APIs is formatted slightly differently based on whether the method is called with the WebSocket, JSON-RPC, or Commandline interfaces. The Commandline and JSON-RPC interfaces use the same format because the Commandline interface calls JSON-RPC.
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: rippled-server-states.html
|
||||
parent: api-conventions.html
|
||||
blurb: 一部のAPIメソッドで報告される状態情報の定義です。
|
||||
---
|
||||
# rippledサーバーの状態
|
||||
|
||||
`rippled`サーバーの設定、稼働時間、その他の要素により、サーバーがグローバルなXRP Ledgerピアツーピアネットワークに参加する度合いは異なります。これは、[server_infoメソッド][]と[server_stateメソッド][]への応答内の`server_state`フィールドに示されます。応答は昇順のやり取りに従い、後の値は前の値より優先されます。これらの応答の定義を以下に示します（優先順位の高い順）。
|
||||
@@ -17,4 +22,4 @@
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
{% include '_snippets/tx-type-links.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
{% include '_snippets/rippled_versions.md' %}
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: rippled-server-states.html
|
||||
parent: api-conventions.html
|
||||
blurb: Definitions of state information reported in some API methods.
|
||||
---
|
||||
# rippled Server States
|
||||
|
||||
Depending on how the `rippled` server is configured, how long it has been running, and other factors, a server may be participating in the global XRP Ledger peer-to-peer network to different degrees. This is represented as the `server_state` field in the responses to the [server_info method][] and [server_state method][]. The possible responses follow a range of ascending interaction, with each later value superseding the previous one. Their definitions are as follows (in order of increasing priority):
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: serialization.html
|
||||
parent: api-conventions.html
|
||||
blurb: XRP Ledgerトランザクションやその他のオブジェクトの場合のJSONフォーマットと正規バイナリーフォーマットとの変換です。
|
||||
---
|
||||
# シリアル化フォーマット
|
||||
[[ソース]](https://github.com/ripple/rippled/blob/develop/src/ripple/protocol/impl/STObject.cpp#L696-L718 "Source")
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
html: serialization.html
|
||||
parent: api-conventions.html
|
||||
blurb: Conversion between JSON and canonical binary format for XRP Ledger transactions and other objects.
|
||||
---
|
||||
# Serialization Format
|
||||
[[Source]](https://github.com/ripple/rippled/blob/develop/src/ripple/protocol/impl/STObject.cpp#L696-L718 "Source")
|
||||
|
||||
|
||||
Reference in New Issue
Block a user