diff --git a/content/references/client-libraries.ja.md b/content/references/client-libraries.ja.md new file mode 100644 index 0000000000..9af8241aee --- /dev/null +++ b/content/references/client-libraries.ja.md @@ -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` | [Get Started Using Python](get-started-using-python.html) | [API Reference](https://xrpl-py.readthedocs.io/) | [Repo](https://github.com/XRPLF/xrpl-py) | +| **JavaScript** / **TypeScript** | `xrpl.js` | [Get Started](get-started-using-javascript.html) | [API Reference](https://js.xrpl.org/) | [Repo](https://github.com/XRPLF/xrpl.js) | +| **C++** | `rippled` Signing Library | [Get Started](https://github.com/ripple/rippled/tree/develop/Builds/linux#signing-library) | | (Part of [`rippled`](https://github.com/ripple/rippled/)) | +| **Java** | `xrpl4j` | [Get Started Using Java](get-started-using-java.html) | [API Reference](https://javadoc.io/doc/org.xrpl/) | [Repo](https://github.com/XRPLF/xrpl4j) | +| **Ruby** | `xrbp` | | [API Reference](https://www.rubydoc.info/gems/xrbp) | [Repo](https://github.com/DevNullProd/xrbp) | + +**ヒント:** ここに掲載されていないクライアントライブラリを追加するには、[このページの変更を提案]({{target.github_forkurl}}/edit/{{target.github_branch}}/content/{{currentpage.md}})してください！ diff --git a/content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/node_to_shard.ja.md b/content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/node_to_shard.ja.md new file mode 100644 index 0000000000..e014fb6afb --- /dev/null +++ b/content/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/node_to_shard.ja.md @@ -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)です。_ + + +### リクエストフォーマット + +リクエストフォーマット例: + + + +*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 +``` + + + +リクエストは、以下のパラメータを含みます: + +| `項目` | 型 | 説明 +|:---------|:-------|:---------------------------------------------------------| +| `action` | String | どのような動作をさせるかによって、 `start`、`stop` または `status` のいずれかを指定します。 | + + +### レスポンスフォーマット + +正常レスポンス例: + + + +*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" + } +} + +``` + + + +レスポンスは、[標準フォーマット][]に従っており、成功した場合は、以下の項目を含みます: + +| `項目` | 型 | 説明 | +|:----------|:-------|:--------------------------------------------------------| +| `message` | String | コマンドに応答して実行されたアクションを示す、可読性の高いメッセージ。 | + + +### 起こり得るエラー + +- Any of the [汎用エラー][]. +- `internal` - コピーが実行されていない時にコピーの状態チェックをするといったような無効な操作の場合。 +- `notEnabled` - サーバが[履歴シャード](history-sharding.html)を保存するように環境設定されていない場合。 +- `invalidParams` - 1つ以上の項目が誤って定義されている、もしくは、1つ以上の必須項目が抜けている。 + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/references/xrp-api.ja.md b/content/references/xrp-api.ja.md new file mode 100644 index 0000000000..55abe1c004 --- /dev/null +++ b/content/references/xrp-api.ja.md @@ -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 ライクな代替インターフェースを提供しますが、現在安定したソフトウェアとは言えず、積極的なサポートは行っていません。 diff --git a/content/references/xrpljs2-migration-guide.jp.md b/content/references/xrpljs2-migration-guide.jp.md new file mode 100644 index 0000000000..8c06f87975 --- /dev/null +++ b/content/references/xrpljs2-migration-guide.jp.md @@ -0,0 +1,344 @@ +--- +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)の状態を調べる時のように、完了見込みの多数のトランザクション結果が保留中であるため、現時点のオープンレジャーを使用したい場合があります。また、完了したトランザクション結果を取り込んだ検証済みのレジャーを使用したい場合もあります。 + +When making API requests with xrpl.js 2.0 using `Client.request()`, you should explicitly [specify what ledger to use](basic-data-types.html#specifying-ledgers). For example, to look up trust lines using the latest _validated ledger_: + +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`インスタンス](#keys-and-wallets)をパスすることによって、署名済みトランザクションをメソッドに直接パス、もしくは、送信直前にトランザクションに署名することができます。 + +```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) +} +``` + +Alternatively, you can use the `sign` method of a wallet to sign a transaction and then use `submitAndWait(tx_blob)` to submit it. This can be useful for building [reliable transaction submission](reliable-transaction-submission.html) that can recover from power outages and other disasters. (The library does not handle disaster recovery on its own.) +もしくは、トランザクション署名のためにwalletの`sign`メソッドを、送信のために`submitAndWait(tx_blob)`を使用することができます。 +停電やその他災害から復旧させる[信頼できるトランザクションの送信](reliable-transaction-submission.html)のビルドに便利です。(ライブラリは単独でディザスタリカバリに対処しません。) + +### LastLedgerSequenceのコントロール + +In ripple-lib 1.x, you could specify a `instructions.maxLedgerVersionOffset` when preparing a transaction to define the `LastLedgerSequence` parameter of the prepared transaction as being some number of ledgers _after_ the latest validated one at the time. In 2.0, you can do this by looking up the latest validated ledger index, then specifying the `LastLedgerSequence` explicitly before auto-filling the transaction. +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 introduces a new [`Wallet` class](https://js.xrpl.org/classes/Wallet.html) for managing [cryptographic keys](cryptographic-keys.html) and signing transactions. This replaces functions that took seed or secret values in ripple-lib 1.x, and handles various address encoding and generation tasks as well. +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"]`で[サブスクリプションメソッド][]をコールします。イベントハンドラを追加するには、`Client.on(event_type, callback)`を使用します。これらのコールは任意の順で実行可能です。 + +1.xからのRippleAPI特有の`ledger`イベントタイプは削除され、代わりに、`ledgerClosed`イベントを使用します。これらのイベントメッセージは同じデータを含んでいますが、フォーマットはWebSocket APIの[レジャーストリーム](subscribe.html#ledger-stream)メッセージに対応しています。 + +例: + +**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) |