Skip to content

Commit e308584

Browse files
authored
Merge pull request #2881 from tequdev/ja-api-v2
[JA] translate API v2 Updates
2 parents d0bac94 + d017546 commit e308584

File tree

14 files changed

+1541
-884
lines changed

14 files changed

+1541
-884
lines changed

@l10n/ja/docs/concepts/payment-types/partial-payments.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ labels:
99
---
1010
# Partial Payment
1111

12+
{% admonition type="warning" name="警告" %}このページでは、`Payment`トランザクションおよび各種APIメソッドに表示される`Amount`フィールドの詳細について説明します。`Amount`とPartial Paymentに関するコンテキスト情報は依然として関連性がありますが、`rippled` [API v2](../../references/http-websocket-apis/api-versions.md)においてフィールド名が`DeliverMax`に変更されました。これは、フィールド名をその動作に特化させ、以下に説明する誤解や悪用を防ぐためです。{% /admonition %}
13+
1214
デフォルトのケースでは、XRP Ledgerの[Paymentトランザクション][]`Amount`フィールドに、為替レートと[送金手数料](../tokens/transfer-fees.md)を差し引いた実際の送金額が指定されます。「Partial Payment」フラグ([**tfPartialPayment**](../../references/protocol/transactions/types/payment.md#paymentのフラグ))を使うと、送金額を増額する代わりに受取金額を減額して、支払を正常に実行できます。Partial Paymentは、追加コストなしで[支払を返金](bouncing-payments.md)したい場合に便利です。
1315

1416
[トランザクションコスト](../transactions/transaction-cost.md)に使用されるXRPの額は、トランザクションタイプに関わらず常に送金元のアカウントから差し引かれます。

@l10n/ja/docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,13 @@ labels:
2525
```json
2626
{
2727
"id": 2,
28+
"api_version": 2,
2829
"command": "sign",
2930
"tx_json" : {
3031
"TransactionType" : "Payment",
3132
"Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
3233
"Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
33-
"Amount" : {
34+
"DeliverMax" : {
3435
"currency" : "USD",
3536
"value" : "1",
3637
"issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
@@ -50,10 +51,11 @@ labels:
5051
"params": [
5152
{
5253
"offline": false,
54+
"api_version": 2,
5355
"secret": "s████████████████████████████",
5456
"tx_json": {
5557
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
56-
"Amount": {
58+
"DeliverMax": {
5759
"currency": "USD",
5860
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
5961
"value": "1"
@@ -71,7 +73,7 @@ labels:
7173
{% tab label="コマンドライン" %}
7274
```sh
7375
#Syntax: sign secret tx_json [offline]
74-
rippled sign s████████████████████████████ '{"TransactionType": "Payment", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "Amount": { "currency": "USD", "value": "1", "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" }, "Sequence": 360, "Fee": "10000"}' offline
76+
rippled sign s████████████████████████████ '{"TransactionType": "Payment", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "DeliverMax": { "currency": "USD", "value": "1", "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" }, "Sequence": 360, "Fee": "10000"}' offline
7577
```
7678
{% /tab %}
7779

@@ -119,13 +121,14 @@ rippled sign s██████████████████████
119121
```json
120122
{
121123
"id": 2,
124+
"api_version": 2,
122125
"status": "success",
123126
"type": "response",
124127
"result": {
125128
"tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
126129
"tx_json": {
127130
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
128-
"Amount": {
131+
"DeliverMax": {
129132
"currency": "USD",
130133
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
131134
"value": "1"
@@ -154,7 +157,7 @@ rippled sign s██████████████████████
154157
"tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
155158
"tx_json": {
156159
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
157-
"Amount": {
160+
"DeliverMax": {
158161
"currency": "USD",
159162
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
160163
"value": "1"
@@ -184,7 +187,7 @@ Connecting to 127.0.0.1:5005
184187
"tx_blob" : "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7447304502210094D24C795CFFA8E46FE338AF63421DA5CE5E171ED56F8E4CE70FFABA15D3CFA2022063994C52BF0393C8157EBFFCDE6A7E7EDC7B16A462CA53214F64CC8FCBB5E54A81144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
185188
"tx_json" : {
186189
"Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
187-
"Amount" : {
190+
"DeliverMax" : {
188191
"currency" : "USD",
189192
"issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
190193
"value" : "1"

@l10n/ja/docs/references/http-websocket-apis/api-conventions/request-formatting.md

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -99,42 +99,4 @@ APIのメソッド名は、通常の(ダッシュで始まる)コマンドライ
9999

100100
{% admonition type="warning" name="注意" %}コマンドラインインターフェイスは管理目的でのみ使用することを意図しており、_サポートされているAPIではありません_です。新しいバージョンの`rippled`では、警告なしにコマンドラインAPIに破壊的な変更が導入される可能性があります!{% /admonition %}
101101

102-
103-
## APIのバージョン管理
104-
105-
`rippled`サーバは、使用するAPIバージョンを識別するために単一の整数を使用します。現在、`1``2`{% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}新規: rippled 2.0.0{% /badge %}の2つのAPIバージョンがあります。サーバは`version`APIメソッドでサポートされるAPIバージョンの範囲を報告します。<!-- TODO: add a link when `version` method is documented. -->
106-
107-
それぞれのAPIバージョンは、破壊的な変更が導入されるときに新しいAPIバージョン番号を導入します。プレリリースやベータ、開発バージョンでは、同じAPIバージョン番号で破壊的な変更を導入することがあり、`account_tx`リクエストを使用してAPIバージョン2を使用し、同じ接続でAPIバージョン1を使用して別の`account_tx`リクエストを行うことができます。
108-
109-
将来の`rippled`のバージョンで破壊的な変更が導入されると、新しいAPIバージョン3が導入されます。
110-
111-
112-
### 破壊的変更
113-
114-
次の種類の変更は**破壊的変更**です。
115-
116-
- リクエストやレスポンスのフィールドの削除や名前の変更
117-
- リクエストやレスポンスのフィールドの型の変更
118-
- リクエストやレスポンスのフィールドの意味の変更
119-
- リクエストやレスポンスのフィールドの位置の変更、または他のリクエストやレスポンスのフィールドの前への新しいフィールドの追加
120-
- APIメソッドの削除や名前の変更
121-
- 既存のクライアントから確認できるAPI関数の動作の変更
122-
- 次の種類の変更は、gRPC APIにのみ適用されます。
123-
- `proto`フィールド番号の変更
124-
- 列挙型または列挙型値の削除または名前の変更
125-
- `oneof`からのフィールドの追加または削除
126-
- `oneof`の分割または統合
127-
- メッセージフィールドが`optional``repeated`、または`required`であるかの変更
128-
- リクエストまたはレスポンスのストリーム値の変更
129-
- パッケージまたはサービスの削除または名前の変更
130-
131-
フルリリースで破壊的変更が加えられると、新しいAPIバージョン番号が導入されます。プレリリース版、ベータ版、開発版では、同じAPIバージョン番号に変更を加えることがあります。
132-
133-
### 非破壊的変更
134-
135-
次の種類の変更は**非破壊的変更**であり、APIバージョン番号の変更なしに発生する可能性があります。
136-
137-
- パラメータの位置の変更を含まない、新しいフィールドの追加
138-
- 新しいAPIメソッドの追加
139-
140102
{% raw-partial file="/docs/_snippets/common-links.md" /%}

@l10n/ja/docs/references/http-websocket-apis/index.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,60 @@ metadata:
66
---
77
# HTTP / WebSocket API リファレンス
88

9-
XRP Ledgerを管理するコアのピアツーピアサーバであるrippledと直接通信します
9+
rippledサーバの公開APIを通じて、XRP Ledgerと通信することができます
1010

1111

12+
現在、APIにはバージョン1とバージョン2の2種類があります{% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}新規: rippled 2.0.0{% /badge %}。 サーバは、[`version` APIメソッド](public-api-methods/server-info-methods/version.md)を通じてサポートされているAPIバージョンの範囲を通知します。APIリクエストで使用するバージョンを指定できます。
13+
14+
同じ持続的な接続で、異なるAPIリクエストで異なるAPIバージョンを使用できます。例えば、WebSocketを通じて、APIバージョン1と2をサポートするサーバに接続した場合、同じ接続からAPIバージョン2を使用して`account_tx`リクエストを行い、その後、APIバージョン1を使用してもう1つの`account_tx`リクエストを行うことができます。
15+
16+
17+
## デフォルトのAPIバージョン
18+
19+
以下の表は、リクエストでAPIバージョンを指定しない場合に使用される`rippled` APIのバージョンを示しています。
20+
21+
| リクエスト方式 | APIバージョン | 追加の注意事項 |
22+
|----------------|---------------|------------------|
23+
| Websocket | 1 | |
24+
| JSON-RPC | 1 | |
25+
| Commandline | 2 | コマンドラインでは、最新のAPIバージョンのみが使用されます。 |
26+
| [xrpl.js](https://github.com/XRPLF/xrpl.js) | 2 | v4.0.0以降では、[API v2][]がデフォルトで使用されます。 |
27+
| [xrpl-py](https://github.com/XRPLF/xrpl-py) | 2 | v3.0.0以降では、[API v2][]がデフォルトで使用されます。 |
28+
29+
{% admonition type="info" name="注記" %}
30+
Clioは、[API v1][]をデフォルトで使用しますが、[API v2][]のリクエストもサポートしています。
31+
{% /admonition %}
32+
33+
`rippled`の将来のバージョンでは、破壊的な変更を導入すると、APIバージョン3が導入されます。
34+
35+
### 破壊的な変更
36+
37+
以下のタイプの変更は、**破壊的な変更**です。
38+
39+
- リクエストまたはレスポンスのフィールドを削除または変更する。
40+
- リクエストまたはレスポンスのフィールドの型を変更する。
41+
- リクエストまたはレスポンスのフィールドの意味を変更する。
42+
- 位置パラメータの順序を変更する、または他の位置パラメータの前に新しいフィールドを追加する。
43+
- APIメソッドを削除または変更する。
44+
- 既存のクライアントからアクセス可能なAPI関数の動作を変更する。
45+
- 以下のタイプの破壊的な変更は、gRPC APIにのみ適用されます。
46+
- `proto`フィールド番号を変更する。
47+
- 列挙型または列挙型の値を削除または変更する。
48+
- `oneof`にフィールドを追加または削除する。
49+
- `oneof`を分割またはマージする。
50+
- メッセージフィールドが`optional``repeated`、または`required`であるかどうかを変更する。
51+
- リクエストまたはレスポンスのストリーム値を変更する。
52+
- パッケージまたはサービスを削除または変更する。
53+
54+
いずれかのリリースで破壊的な変更が導入されると、新しいAPIバージョン番号が導入されます。プレリリース、ベータ、開発バージョンは、同じAPIバージョン番号に対して破壊的な変更を導入する場合があります。
55+
56+
### 非破壊的な変更
57+
58+
以下のタイプの変更は、**非破壊的な変更**です。APIバージョン番号の変更なしに発生する可能性があります。
59+
60+
- リクエストまたはレスポンスに新しいフィールドを追加する(位置パラメータを除く)。
61+
- APIメソッドを追加する。
62+
63+
{% raw-partial file="/docs/_snippets/common-links.md" /%}
64+
1265
{% child-pages /%}

@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated
253253
## 考えられるエラー
254254

255255
* いずれかの[汎用エラータイプ][]
256-
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。例えば、リクエストで`queue``true`と指定したが、現在開いているレジャーではない`ledger_index`を指定した場合です。
256+
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。例えば、リクエストで`queue``true`と指定したが、現在開いているレジャーではない`ledger_index`を指定した場合です。[API v1][]では、`signer_lists`に非真偽値を指定した場合にこのエラーが発生します。
257257
* `actNotFound` - リクエストの`account`フィールドに指定したアドレスが、レジャー内のアカウントに対応していません。
258258
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
259259

0 commit comments

Comments
 (0)