mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-28 23:55:49 +00:00
Merge pull request #2786 from XRPLF/oracle-fixes
clarify decimal input and hexadecimal api response
This commit is contained in:
oeggert
@@ -1,111 +0,0 @@
|
||||
---
|
||||
seo:
|
||||
description: APIバージョン情報を取得します。
|
||||
labels:
|
||||
- コアサーバ
|
||||
---
|
||||
# version
|
||||
[[ソース]](https://github.com/XRPLF/clio/blob/develop/src/rpc/handlers/VersionHandler.hpp "ソース")
|
||||
|
||||
`version`コマンドは、[Clioサーバ](../../../../concepts/networks-and-servers/the-clio-server.md)のAPIバージョン情報を取得します。`rippled`サーバーの場合は、代わりに[`version` (`rippled`)](../server-info-methods/version.md)をご覧ください。{% badge href="https://github.com/XRPLF/clio/releases/tag/1.0.0" %}新規: Clio v2.0.0{% /badge %}
|
||||
|
||||
|
||||
## リクエストのフォーマット
|
||||
リクエストフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"command": "version"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "version",
|
||||
"params": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
<!-- [Try it! >](websocket-api-tool.html#version) -->
|
||||
|
||||
リクエストはパラメーターを必要としません。
|
||||
|
||||
## レスポンスのフォーマット
|
||||
|
||||
成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"version": {
|
||||
"first": 1,
|
||||
"last": 2,
|
||||
"good": 1
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result": {
|
||||
"version": {
|
||||
"first": 1,
|
||||
"last": 2,
|
||||
"good": 1
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従い、成功した結果は`info`オブジェクトのみを含むものとなります。
|
||||
|
||||
`version`オブジェクトは、次のフィールドのいずれかを返します。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:-----------|:-------|:------------------------------|
|
||||
| `first` | 文字列 | サポートされる最低のAPIリリース |
|
||||
| `last` | 文字列 | サポートされる最高のAPIリリース |
|
||||
| `good` | 文字列 | 指定されていない場合のデフォルトのAPI |
|
||||
|
||||
## 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のいずれか。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -1,124 +0,0 @@
|
||||
---
|
||||
seo:
|
||||
description: APIバージョン情報を取得します。
|
||||
labels:
|
||||
- コアサーバ
|
||||
---
|
||||
# version
|
||||
|
||||
[[ソース]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/beast/core/SemanticVersion.cpp "ソース")
|
||||
|
||||
`version`コマンドは、rippledサーバーのAPIバージョン情報を取得します。`Clio`サーバーの場合は、代わりに[`version` (`clio`)](../clio-methods/version.md)をご覧ください。
|
||||
|
||||
|
||||
## リクエストのフォーマット
|
||||
リクエストフォーマットの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"command": "version"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
{
|
||||
"method": "version",
|
||||
"params": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```sh
|
||||
#Syntax: version
|
||||
rippled version
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
[試してみる >](/resources/dev-tools/websocket-api-tool#version)
|
||||
|
||||
リクエストはパラメーターを必要としません。
|
||||
|
||||
|
||||
## レスポンスのフォーマット
|
||||
|
||||
成功したレスポンスの例:
|
||||
|
||||
{% tabs %}
|
||||
|
||||
{% tab label="WebSocket" %}
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"version": {
|
||||
"first": "1.0.0",
|
||||
"good": "1.0.0",
|
||||
"last": "1.0.0"
|
||||
}
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="JSON-RPC" %}
|
||||
```json
|
||||
200 OK
|
||||
|
||||
{
|
||||
"result": {
|
||||
"version": {
|
||||
"first": "1.0.0",
|
||||
"good": "1.0.0",
|
||||
"last": "1.0.0"
|
||||
}
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% tab label="コマンドライン" %}
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"version": {
|
||||
"first": "1.0.0",
|
||||
"good": "1.0.0",
|
||||
"last": "1.0.0"
|
||||
}
|
||||
},
|
||||
"status": "success",
|
||||
"type": "response"
|
||||
}
|
||||
```
|
||||
{% /tab %}
|
||||
|
||||
{% /tabs %}
|
||||
|
||||
レスポンスは[標準フォーマット][]に従い、成功した結果は`version`オブジェクトのみを含むものとなります。
|
||||
|
||||
`version`オブジェクトは、次のフィールドのいずれかを返します。
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|:-----------|:-------|:------------------------------|
|
||||
| `first` | 文字列 | サポートされる最低のAPIリリース |
|
||||
| `last` | 文字列 | サポートされる最高のAPIリリース |
|
||||
| `good` | 文字列 | 指定されていない場合のデフォルトのAPI |
|
||||
|
||||
### 考えられるエラー
|
||||
|
||||
* [汎用エラータイプ][]のいずれか。
|
||||
|
||||
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|
||||
@@ -59,7 +59,7 @@ A price oracle object can store information for up to 10 token pairs.
|
||||
|---------------------|-----------|---------------|-----------|-------------|
|
||||
| `BaseAsset` | String | Currency | Yes | The primary asset in a trading pair. Any valid identifier, such as a stock symbol, bond CUSIP, or currency code is allowed. |
|
||||
| `QuoteAsset` | String | Currency | Yes | The quote asset in a trading pair. The quote asset denotes the price of one unit of the base asset. |
|
||||
| `AssetPrice` | Number | UInt64 | No | The asset price after applying the `Scale` precision level. It's not included if the last update transaction didn't include the `BaseAsset`/`QuoteAsset` pair. |
|
||||
| `AssetPrice` | String | UInt64 | No | The asset price after applying the `Scale` precision level. It's not included if the last update transaction didn't include the `BaseAsset`/`QuoteAsset` pair. Displayed in hexadecimal format. |
|
||||
| `Scale` | Number | UInt8 | No | The scaling factor to apply to an asset price. For example, if `Scale` is 6 and original price is 0.155, then the scaled price is 155000. Valid scale ranges are 0-10. It's not included if the last update transaction didn't include the `BaseAsset`/`QuoteAsset` pair. |
|
||||
|
||||
|
||||
|
||||
@@ -55,9 +55,9 @@ Creates a new `Oracle` ledger entry or updates the fields of an existing one, us
|
||||
| Field | JSON Type | Internal Type | Required? | Description |
|
||||
|---------------------|-----------|---------------|-----------|-------------|
|
||||
| `BaseAsset` | String | Currency | Yes | The primary asset in a trading pair. Any valid identifier, such as a stock symbol, bond CUSIP, or currency code is allowed. For example, in the BTC/USD pair, BTC is the base asset; in 912810RR9/BTC, 912810RR9 is the base asset. |
|
||||
| `QuoteAsset` | String | Currency | Yes | The quote asset in a trading pair. The quote asset denotes the price of one unit of the base asset. For example, in the BTC/USD pair, USD is the quote asset; in 912810RR9/BTC, BTC is the quote asset. |
|
||||
| `AssetPrice` | Number | UInt64 | No | The asset price after applying the `Scale` precision level. If it is not included, the PriceData object will be deleted. |
|
||||
| `Scale` | Number | UInt8 | No | The scaling factor to apply to an asset price. For example, if `Scale` is 6 and original price is 0.155, then the scaled price is 155000. Valid scale ranges are 0-10. The default value is 0. |
|
||||
| `QuoteAsset` | String | Currency | Yes | The quote asset in a trading pair. The quote asset denotes the price of one unit of the base asset. For example, in the BTC/USD pair, BTC is the base asset; in 912810RR9/BTC, 912810RR9 is the base asset. |
|
||||
| `AssetPrice` | String | UInt64 | No | The asset price after applying the `Scale` precision level. It's not included if the last update transaction didn't include the `BaseAsset`/`QuoteAsset` pair. It's recommended you provide this value as a hexadecimal, but [client libraries](https://xrpl.org/docs/references#client-libraries) will accept decimal numbers and convert to hexadecimal strings. |
|
||||
| `Scale` | Number | UInt8 | No | The scaling factor to apply to an asset price. For example, if `Scale` is 6 and original price is 0.155, then the scaled price is 155000. Valid scale ranges are 0-10. It's not included if the last update transaction didn't include the `BaseAsset`/`QuoteAsset` pair.|
|
||||
|
||||
`PriceData` is created or updated, following these rules:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user