From b99bcd3dfed5efc71c51f76bc21239d230fd317e Mon Sep 17 00:00:00 2001 From: tequ Date: Mon, 28 Oct 2024 14:58:24 +0900 Subject: [PATCH 1/3] [JA] translate version rpcs --- .../clio-methods/version.md | 111 +++++++++++++++ .../server-info-methods/version.md | 126 ++++++++++++++++++ 2 files changed, 237 insertions(+) create mode 100644 @i18n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/version.md create mode 100644 @i18n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md diff --git a/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/version.md b/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/version.md new file mode 100644 index 0000000000..79e12a6a6d --- /dev/null +++ b/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/version.md @@ -0,0 +1,111 @@ +--- +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 %} + + + +リクエストはパラメーターを必要としません。 + +## レスポンスのフォーマット + +成功したレスポンスの例: + +{% 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" /%} diff --git a/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md b/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md new file mode 100644 index 0000000000..43123ceb7d --- /dev/null +++ b/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md @@ -0,0 +1,126 @@ +--- +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 + +Headers + +{ + "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" /%} From 07011d9dd5046cda116cf66c224a5851a0d24525 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Wed, 30 Oct 2024 17:21:30 -0700 Subject: [PATCH 2/3] version API method: fix stray Headers in example --- .../public-api-methods/server-info-methods/version.md | 2 -- .../public-api-methods/server-info-methods/version.md | 2 -- 2 files changed, 4 deletions(-) diff --git a/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md b/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md index 43123ceb7d..76b5741109 100644 --- a/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md +++ b/@i18n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md @@ -75,8 +75,6 @@ rippled version ```json 200 OK -Headers - { "result": { "version": { diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md index 2ced20f5ef..e1277840d9 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md @@ -74,8 +74,6 @@ An example of a successful response: ```json 200 OK -Headers - { "result": { "version": { From d23a7a9b40f2a68ccd271617be08a97f6d1d330b Mon Sep 17 00:00:00 2001 From: amarantha-k Date: Tue, 5 Nov 2024 10:59:55 -0800 Subject: [PATCH 3/3] Update status now that Price Oracle amendment has been enabled --- @l10n/ja/docs/concepts/xrpl-sidechains/price-oracles.md | 2 +- .../protocol/ledger-data/ledger-entry-types/oracle.md | 2 +- .../references/protocol/transactions/types/oracledelete.md | 3 +-- .../docs/references/protocol/transactions/types/oracleset.md | 3 +-- @l10n/ja/resources/known-amendments.md | 4 ++-- docs/concepts/xrpl-sidechains/price-oracles.md | 2 +- .../public-api-methods/ledger-methods/ledger_entry.md | 2 +- .../path-and-order-book-methods/get_aggregate_price.md | 3 +-- .../protocol/ledger-data/ledger-entry-types/oracle.md | 2 +- docs/references/protocol/transactions/types/oracledelete.md | 3 +-- docs/references/protocol/transactions/types/oracleset.md | 3 +-- resources/known-amendments.md | 4 ++-- 12 files changed, 14 insertions(+), 19 deletions(-) diff --git a/@l10n/ja/docs/concepts/xrpl-sidechains/price-oracles.md b/@l10n/ja/docs/concepts/xrpl-sidechains/price-oracles.md index 48551a5ca0..b8d5847772 100644 --- a/@l10n/ja/docs/concepts/xrpl-sidechains/price-oracles.md +++ b/@l10n/ja/docs/concepts/xrpl-sidechains/price-oracles.md @@ -1,6 +1,6 @@ # 価格オラクル -_([PriceOracle Amendment][] {% not-enabled /%} が必要です。)_ +_([PriceOracle Amendment][])_ ブロックチェーンは、本質的にネットワーク外で何が起こっているのかを把握することはできませんが、分散型金融における多くのユースケースでは、この情報が必要となります。 diff --git a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md index b19319725a..0c65400870 100644 --- a/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md +++ b/@l10n/ja/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md @@ -1,6 +1,6 @@ # Oracle -_([PriceOracle Amendment][] {% not-enabled /%} が必要です。)_ +_([PriceOracle Amendment][])_ [[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/LedgerFormats.cpp#L353-L366 "ソース") diff --git a/@l10n/ja/docs/references/protocol/transactions/types/oracledelete.md b/@l10n/ja/docs/references/protocol/transactions/types/oracledelete.md index 1588bfd982..daefd4beb5 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/oracledelete.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/oracledelete.md @@ -4,10 +4,9 @@ parent: transaction-types.html blurb: 既存の価格オラクルを削除します。 labels: - オラクル -status: not_enabled --- # OracleDelete -_([PriceOracle Amendment][] {% not-enabled /%} が必要です。)_ +_([PriceOracle Amendment][])_ [[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/DeleteOracle.cpp "ソース") diff --git a/@l10n/ja/docs/references/protocol/transactions/types/oracleset.md b/@l10n/ja/docs/references/protocol/transactions/types/oracleset.md index 8a56387528..e1ca96aa02 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/oracleset.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/oracleset.md @@ -4,10 +4,9 @@ parent: transaction-types.html blurb: 価格オラクルを作成または更新します。 labels: - オラクル -status: not_enabled --- # OracleSet -_([PriceOracle Amendment][] {% not-enabled /%} が必要です。)_ +_([PriceOracle Amendment][])_ [[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/SetOracle.cpp "ソース") diff --git a/@l10n/ja/resources/known-amendments.md b/@l10n/ja/resources/known-amendments.md index 4bf2e447e7..ae28db65e7 100644 --- a/@l10n/ja/resources/known-amendments.md +++ b/@l10n/ja/resources/known-amendments.md @@ -18,7 +18,7 @@ labels: | 名前 | 登場 | ステータス | |:----------------------------------|:-----------|:------------------------------------| | [fixXChainRewardRounding][] | v2.2.0 | {% badge href="https://xrpl.org/blog/2024/rippled-2.2.0" %}投票中: 2024-06-04{% /badge %} | -| [PriceOracle][] | v2.2.0 | {% badge href="https://xrpl.org/blog/2024/rippled-2.2.0" %}投票中: 2024-06-04{% /badge %} | +| [PriceOracle][] | v2.2.0 | {% badge href="https://livenet.xrpl.org/transactions/05D03F7BF08BF4A915483F7B10EAC7016034656A54A8A6AD4A49A9AD362764A1" %}有効: 2024-11-02{% /badge %} | | [DID][] | v2.0.0 | {% badge href="https://xrpl.org/blog/2024/rippled-2.0.0.html" %}投票中: 2024-01-09{% /badge %} | | [XChainBridge][] | v2.0.0 | {% badge href="https://xrpl.org/blog/2024/rippled-2.0.0.html" %}投票中: 2024-01-09{% /badge %} | | [fixEmptyDID][] | v2.2.0 | {% badge href="https://livenet.xrpl.org/transactions/A858AE8832981D77A4C5038D633CC9CBD54C9764BD2A3F8CA174E02D1736F472" %}有効: 2024-09-27{% /badge %} | @@ -1308,7 +1308,7 @@ XRPの「Payment Channel」を作成します。Payment Channelは、2名の当 | Amendment | PriceOracle | |:-------------|:------------| | Amendment ID | 96FD2F293A519AE1DB6F8BED23E4AD9119342DA7CB6BAFD00953D16C54205D8B | -| ステータス | 投票中 | +| ステータス | 有効 | | デフォルトの投票(最新の安定版) | いいえ | | Amendment前の機能は廃止? | いいえ | diff --git a/docs/concepts/xrpl-sidechains/price-oracles.md b/docs/concepts/xrpl-sidechains/price-oracles.md index 72b1728002..93261d1476 100644 --- a/docs/concepts/xrpl-sidechains/price-oracles.md +++ b/docs/concepts/xrpl-sidechains/price-oracles.md @@ -1,6 +1,6 @@ # Price Oracles -_(Requires the [PriceOracle amendment][] {% not-enabled /%})_ +_(Requires the [PriceOracle amendment][])_ Blockchains can't inherently interact with and "know" what's happening off the network, but many of its use cases in decentralized finance require this information. diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md index cd1b916c8e..acd60ac26b 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md @@ -404,7 +404,7 @@ rippled json ledger_entry '{ "offer": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJY ### Get Oracle Object -_(Requires the [PriceOracle amendment][] {% not-enabled /%})_ +_(Requires the [PriceOracle amendment][])_ Retrieve an [Oracle entry](../../../protocol/ledger-data/ledger-entry-types/oracle.md), which represents a single price oracle that can store token prices. diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md index 5015a3f94b..95222a4727 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md @@ -2,13 +2,12 @@ html: get_aggregate_price.html parent: ledger-methods.html blurb: Calculates the aggregate price of specified Oracle instances. -status: not_enabled labels: - Oracle --- # get_aggregate_price -_(Requires the [PriceOracle amendment][] {% not-enabled /%})_ +_(Requires the [PriceOracle amendment][])_ [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/GetAggregatePrice.cpp "Source") diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md b/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md index 1213e90e98..0a9ee2ea30 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/oracle.md @@ -1,6 +1,6 @@ # Oracle -_(Requires the [PriceOracle amendment][] {% not-enabled /%})_ +_(Requires the [PriceOracle amendment][])_ [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/LedgerFormats.cpp#L353-L366 "Source") diff --git a/docs/references/protocol/transactions/types/oracledelete.md b/docs/references/protocol/transactions/types/oracledelete.md index ac1f6afef3..4ba7be51e9 100644 --- a/docs/references/protocol/transactions/types/oracledelete.md +++ b/docs/references/protocol/transactions/types/oracledelete.md @@ -4,10 +4,9 @@ parent: transaction-types.html blurb: Delete an existing price oracle. labels: - Oracle -status: not_enabled --- # OracleDelete -_(Requires the [PriceOracle amendment][] {% not-enabled /%})_ +_(Requires the [PriceOracle amendment][])_ [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/DeleteOracle.cpp "Source") diff --git a/docs/references/protocol/transactions/types/oracleset.md b/docs/references/protocol/transactions/types/oracleset.md index 0ebe260903..19c4812e49 100644 --- a/docs/references/protocol/transactions/types/oracleset.md +++ b/docs/references/protocol/transactions/types/oracleset.md @@ -4,10 +4,9 @@ parent: transaction-types.html blurb: Create or update an existing price oracle. labels: - Oracle -status: not_enabled --- # OracleSet -_(Requires the [PriceOracle amendment][] {% not-enabled /%})_ +_(Requires the [PriceOracle amendment][])_ [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/SetOracle.cpp "Source") diff --git a/resources/known-amendments.md b/resources/known-amendments.md index ad1d93ac8f..91b5db85b8 100644 --- a/resources/known-amendments.md +++ b/resources/known-amendments.md @@ -18,7 +18,7 @@ This list is updated manually. For a live view of amendment voting, see the Amen | Name | Introduced | Status | |:----------------------------------|:-----------|:------------------------------| | [fixXChainRewardRounding][] | v2.2.0 | {% badge href="https://xrpl.org/blog/2024/rippled-2.2.0" %}Open for Voting: 2024-06-04{% /badge %} | -| [PriceOracle][] | v2.2.0 | {% badge href="https://xrpl.org/blog/2024/rippled-2.2.0" %}Open for Voting: 2024-06-04{% /badge %} | +| [PriceOracle][] | v2.2.0 | {% badge href="https://livenet.xrpl.org/transactions/05D03F7BF08BF4A915483F7B10EAC7016034656A54A8A6AD4A49A9AD362764A1" %}Enabled: 2024-11-02{% /badge %} | | [DID][] | v2.0.0 | {% badge href="https://xrpl.org/blog/2024/rippled-2.0.0.html" %}Open for Voting: 2024-01-09{% /badge %} | | [XChainBridge][] | v2.0.0 | {% badge href="https://xrpl.org/blog/2024/rippled-2.0.0.html" %}Open for Voting: 2024-01-09{% /badge %} | | [fixEmptyDID][] | v2.2.0 | {% badge href="https://livenet.xrpl.org/transactions/A858AE8832981D77A4C5038D633CC9CBD54C9764BD2A3F8CA174E02D1736F472" %}Enabled: 2024-09-27{% /badge %} | @@ -1308,7 +1308,7 @@ For more information, see the [Payment Channels Tutorial](../docs/tutorials/how- | Amendment | PriceOracle | |:-------------|:------------| | Amendment ID | 96FD2F293A519AE1DB6F8BED23E4AD9119342DA7CB6BAFD00953D16C54205D8B | -| Status | Open for Voting | +| Status | Enabled | | Default Vote (Latest stable release) | No | | Pre-amendment functionality retired? | No |