From f7cf44073cd9703ee42f3aa30c6b4a264de12bb2 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Fri, 7 May 2021 17:38:31 -0700 Subject: [PATCH 1/4] Get Started organization updates - Split off "Public Servers" page - Rename and reorder getting started pages by language --- content/_snippets/rippled-api-links.md | 2 + .../the-rippled-server/the-rippled-server.md | 2 +- content/references/client-libraries.md | 6 +- ...t-started-using-http-websocket-apis.ja.md} | 4 +- ... get-started-using-http-websocket-apis.md} | 35 +++++------- .../get-started/get-started-using-java.md | 56 +++++++++---------- ....ja.md => get-started-using-node-js.ja.md} | 4 +- ...script.md => get-started-using-node-js.md} | 8 +-- .../get-started/get-started-using-python.md | 2 +- .../tutorials/get-started/public-servers.md | 29 ++++++++++ ...onnect-your-rippled-to-the-xrp-test-net.md | 4 +- dactyl-config.yml | 35 ++++++++++-- 12 files changed, 118 insertions(+), 69 deletions(-) rename content/tutorials/get-started/{get-started-with-the-rippled-api.ja.md => get-started-using-http-websocket-apis.ja.md} (99%) rename content/tutorials/get-started/{get-started-with-the-rippled-api.md => get-started-using-http-websocket-apis.md} (55%) rename content/tutorials/get-started/{get-started-with-rippleapi-for-javascript.ja.md => get-started-using-node-js.ja.md} (98%) rename content/tutorials/get-started/{get-started-with-rippleapi-for-javascript.md => get-started-using-node-js.md} (97%) create mode 100644 content/tutorials/get-started/public-servers.md diff --git a/content/_snippets/rippled-api-links.md b/content/_snippets/rippled-api-links.md index 3c0f8a5850..cfdfbd0f25 100644 --- a/content/_snippets/rippled-api-links.md +++ b/content/_snippets/rippled-api-links.md @@ -32,6 +32,8 @@ [peer reservation]: peer-protocol.html#fixed-peers-and-peer-reservations [peer reservations]: peer-protocol.html#fixed-peers-and-peer-reservations [ピアリザベーション]: peer-protocol.html#固定ピアとピアリザベーション +[public servers]: public-servers.html +[公開サーバー]: public-servers.html [result code]: transaction-results.html [seconds since the Ripple Epoch]: basic-data-types.html#specifying-time [Reporting Mode]: rippled-server-modes.html#reporting-mode diff --git a/content/concepts/the-rippled-server/the-rippled-server.md b/content/concepts/the-rippled-server/the-rippled-server.md index ca39192f0b..dff58a3544 100644 --- a/content/concepts/the-rippled-server/the-rippled-server.md +++ b/content/concepts/the-rippled-server/the-rippled-server.md @@ -10,7 +10,7 @@ blurb: rippled is the core peer-to-peer server that manages the XRP Ledger. This ## Reasons to Run Your Own Server -For lighter use cases and individual servers, you can often rely on free [public servers](https://xrpl.org/get-started-with-the-rippled-api.html#public-servers). However, the more serious your use of the XRP Ledger becomes, the more important it becomes to have your own infrastructure. +For lighter use cases and individual servers, you can often rely on free [public servers][]. However, the more serious your use of the XRP Ledger becomes, the more important it becomes to have your own infrastructure. There are lots of reasons you might want to run your own `rippled` server, but most of them can be summarized as: you can trust your own server, you have control over its workload, and you're not at the mercy of others to decide when and how you can access it. Of course, you must practice good network security to protect your server from malicious hackers. diff --git a/content/references/client-libraries.md b/content/references/client-libraries.md index 33b969c407..0cb49bb383 100644 --- a/content/references/client-libraries.md +++ b/content/references/client-libraries.md @@ -11,9 +11,9 @@ For other programming languages, you can access the XRP Ledger through the [HTTP | Language | Library Name | Get Started | API Reference | Source Code | |----------|--------------|-------------|---------------|-------------| -| **Python** | `xrpl-py` | [Get Started](get-started-using-python.html) | [API Reference](https://xrpl-py.readthedocs.io/) | [Repo](https://github.com/XRPLF/xrpl-py) | -| **JavaScript** / **TypeScript** | `ripple-lib` | [Get Started](get-started-with-rippleapi-for-javascript.html) | [API Reference](rippleapi-reference.html) | [Repo](https://github.com/ripple/ripple-lib) | +| **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** | `ripple-lib` | [Get Started](get-started-using-node-js.html) | [API Reference](rippleapi-reference.html) | [Repo](https://github.com/ripple/ripple-lib) | | **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` | [README](https://github.com/XRPLF/xrpl4j#readme) | [API Reference](https://github.com/XRPLF/xrpl4j/tree/main/xrpl4j-integration-tests) | [Repo](https://github.com/XRPLF/xrpl4j) | +| **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) | **Tip:** To add a client library not listed here, please [suggest changes to this page]({{target.github_forkurl}}/edit/{{target.github_branch}}/content/{{currentpage.md}})! diff --git a/content/tutorials/get-started/get-started-with-the-rippled-api.ja.md b/content/tutorials/get-started/get-started-using-http-websocket-apis.ja.md similarity index 99% rename from content/tutorials/get-started/get-started-with-the-rippled-api.ja.md rename to content/tutorials/get-started/get-started-using-http-websocket-apis.ja.md index ae4127aa90..83151ad040 100644 --- a/content/tutorials/get-started/get-started-with-the-rippled-api.ja.md +++ b/content/tutorials/get-started/get-started-using-http-websocket-apis.ja.md @@ -1,10 +1,10 @@ --- -html: get-started-with-the-rippled-api.html +html: get-started-using-http-websocket-apis.html parent: get-started.html blurb: XRP Ledgerの操作に使用できるAPIとライブラリを使い始めましょう。 cta_text: 開始しよう --- -# XRP Ledger APIの使用開始 +# HTTP / WebSocket APIの使用開始 XRP Ledgerのコアサーバーソフトウェアは[`rippled`](the-rippled-server.html)です。XRP Ledgerでの開発に進むには、`rippled`サーバーのAPIにアクセスします。 diff --git a/content/tutorials/get-started/get-started-with-the-rippled-api.md b/content/tutorials/get-started/get-started-using-http-websocket-apis.md similarity index 55% rename from content/tutorials/get-started/get-started-with-the-rippled-api.md rename to content/tutorials/get-started/get-started-using-http-websocket-apis.md index 90a1c73aef..adf273fafb 100644 --- a/content/tutorials/get-started/get-started-with-the-rippled-api.md +++ b/content/tutorials/get-started/get-started-using-http-websocket-apis.md @@ -1,44 +1,35 @@ --- -html: get-started-with-the-rippled-api.html +html: get-started-using-http-websocket-apis.html parent: get-started.html blurb: Unleash the full power of the XRP Ledger's native APIs. cta_text: Get Started --- -# Get Started with XRP Ledger APIs +# Get Started Using HTTP / WebSocket APIs -The XRP Ledger's core server software is [`rippled`](the-rippled-server.html). You can jump straight into developing on the XRP Ledger by accessing the API of a `rippled` server. +If you don't have or don't want to use a [client library](client-libraries.html) in your preferred programming language, you can access the XRP Ledger directly through the APIs of its core server software, [`rippled`](the-rippled-server.html). The server provides APIs over JSON-RPC and WebSocket protocols. If you don't [run your own instance of `rippled`](install-rippled.html) you can still use a [public server][public servers]. -The quickest way to dive into the API is with the [**WebSocket API Tool**](websocket-api-tool.html), or use the [XRP Ledger Explorer](https://livenet.xrpl.org/) to watch the progress of the ledger live. +**Tip:** You can dive right into the API is with the [**WebSocket API Tool**](websocket-api-tool.html), or use the [XRP Ledger Explorer](https://livenet.xrpl.org/) to watch the progress of the ledger live. -You can also [run your own instance of `rippled`](install-rippled.html) or use a [public server](#public-servers). +## Differences Between JSON-RPC and WebSocket -## Public Servers +Both JSON-RPC and WebSocket are HTTP-based protocols, and for the most part the data provided over both protocols is the same. The major differences are as follows: -Ripple provides several public servers for the benefit of the XRP Ledger community: +- JSON-RPC uses individual HTTP requests and responses for each call, similar to a RESTful API. You can use any common HTTP client such as [curl](https://curl.haxx.se/), [Postman](https://www.postman.com/downloads/), or [Requests](https://docs.python-requests.org/) to access this API. +- WebSocket uses a persistent connection that allows the server to push data to the client. Functions that require push messages, like [event subscriptions](subscribe.html), are only available using WebSocket. -| Operator | [Network][] | JSON-RPC URL | WebSocket URL | Notes | -|:----------|:------------|:-------------|:--------------|:---------------------| -| XRP Ledger Foundation | **Mainnet** | `https://xrpl.ws/` | `wss://xrpl.ws/` | Full history server cluster. | -| Ripple¹ | **Mainnet** | `https://s1.ripple.com:51234/` | `wss://s1.ripple.com/` | General purpose server cluster | -| Ripple¹ | **Mainnet** | `https://s2.ripple.com:51234/` | `wss://s2.ripple.com/` | [Full-history server](ledger-history.html#full-history) cluster | -| Ripple¹ | Testnet | `https://s.altnet.rippletest.net:51234/` | `wss://s.altnet.rippletest.net/` | Testnet public server | -| Ripple¹ | Devnet | `https://s.devnet.rippletest.net:51234/` | `wss://s.devnet.rippletest.net/` | Devnet public server | - -[Network]: parallel-networks.html - -¹Ripple's public servers are not for sustained or business use, and they may become unavailable at any time. For regular use, you should run your own `rippled` server or contract someone you trust to do so. Ripple includes [Reporting Mode][] servers in its public clusters. +Both APIs can be served unencrypted (`http://` and `ws://`) or encrypted using TLS (`https://` and `wss://`). Unencrypted connections should not be served over open networks, but can be used when the client is on the same machine as the server. ## Admin Access -`rippled` API methods are divided into [Public Methods](public-rippled-methods.html) and [Admin Methods](admin-rippled-methods.html) so that organizations can offer public servers for the benefit of the community. To access admin methods, or admin functionality of public methods, you must connect to the API on a **port and IP address marked as admin** in the server's config file. +The API methods are divided into [Public Methods](public-rippled-methods.html) and [Admin Methods](admin-rippled-methods.html) so that organizations can offer public servers for the benefit of the community. To access admin methods, or admin functionality of public methods, you must connect to the API on a **port and IP address marked as admin** in the server's config file. The [example config file](https://github.com/ripple/rippled/blob/f00f263852c472938bf8e993e26c7f96f435935c/cfg/rippled-example.cfg#L1154-L1179) listens for connections on the local loopback network (127.0.0.1), with JSON-RPC (HTTP) on port 5005 and WebSocket (WS) on port 6006, and treats all connected clients as admin. ## WebSocket API -If you are looking to try out some methods on the XRP Ledger, you can skip writing your own WebSocket code and go straight to using the API at the [Ripple WebSocket API Tool](websocket-api-tool.html). Later on, when you want to connect to your own `rippled` server, you can [build your own client in the browser](monitor-incoming-payments-with-websocket.html) or [in Node.js](https://www.npmjs.com/package/ws). +If you are looking to try out some methods on the XRP Ledger, you can skip writing your own WebSocket code and go straight to using the API at the [WebSocket API Tool](websocket-api-tool.html). Later on, when you want to connect to your own `rippled` server, you can [build your own client](monitor-incoming-payments-with-websocket.html) or use a [client library](client-libraries.html) with WebSocket support. Example WebSocket API request: @@ -50,7 +41,9 @@ Example WebSocket API request: } ``` -The response to [this command][server_info method] shows you the current status of the server. Or, read more about [Request Formatting](request-formatting.html) and [Response Formatting](response-formatting.html). +The response to shows you the current status of the server. + +Read more: [Request Formatting >](request-formatting.html) [Response Formatting >](response-formatting.html) [About the server_info method >][server_info method] ## JSON-RPC diff --git a/content/tutorials/get-started/get-started-using-java.md b/content/tutorials/get-started/get-started-using-java.md index ec83b555b8..a74bc98fa7 100644 --- a/content/tutorials/get-started/get-started-using-java.md +++ b/content/tutorials/get-started/get-started-using-java.md @@ -38,10 +38,10 @@ In this tutorial, you'll learn: The [`xrpl4j` library](https://github.com/XRPLF/xrpl4j) is available on [Maven Central](https://search.maven.org/artifact/org.xrpl/xrpl4j-parent). `xrpl4j` is split into multiple artifacts, which can be imported as needed. -In this tutorial, you will need the [xrpl4j-client](https://javadoc.io/doc/org.xrpl/xrpl4j-client/latest/index.html), -[xrpl4j-address-codec](https://javadoc.io/doc/org.xrpl/xrpl4j-address-codec/latest/index.html), -[xrpl4j-keypairs](https://javadoc.io/doc/org.xrpl/xrpl4j-keypairs/latest/index.html), and -[xrpl4j-model](https://javadoc.io/doc/org.xrpl/xrpl4j-model/latest/index.html) modules. +In this tutorial, you will need the [xrpl4j-client](https://javadoc.io/doc/org.xrpl/xrpl4j-client/latest/index.html), +[xrpl4j-address-codec](https://javadoc.io/doc/org.xrpl/xrpl4j-address-codec/latest/index.html), +[xrpl4j-keypairs](https://javadoc.io/doc/org.xrpl/xrpl4j-keypairs/latest/index.html), and +[xrpl4j-model](https://javadoc.io/doc/org.xrpl/xrpl4j-model/latest/index.html) modules. To install with Maven, add the following to your project's `pom.xml` file and then run `mvn install`: @@ -86,7 +86,7 @@ Here are the basic steps you'll need to cover for almost any XRP Ledger project: ### {{n.next()}}. Connect to the XRP Ledger -To make queries and submit transactions, you need to establish a connection to the XRP Ledger. To do this with `xrpl4j`, +To make queries and submit transactions, you need to establish a connection to the XRP Ledger. To do this with `xrpl4j`, you can use an [`XrplClient`](https://javadoc.io/doc/org.xrpl/xrpl4j-client/latest/org/xrpl/xrpl4j/client/XrplClient.html): {{ include_code("_code-samples/xrpl4j/GetAccountInfo.java", start_with="// Construct a network client", end_before="// Create a Wallet using a WalletFactory", language="java") }} @@ -102,21 +102,21 @@ The sample code in the previous section shows you how to connect to the Testnet, See the example [core server config file](https://github.com/ripple/rippled/blob/c0a0b79d2d483b318ce1d82e526bd53df83a4a2c/cfg/rippled-example.cfg#L1562) for more information about default values. -* By using one of the [available public servers](get-started-with-the-rippled-api.html#public-servers): +* By using one of the available [public servers][]: final HttpUrl rippledUrl = HttpUrl.get("https://s2.ripple.com:51234/"); XrplClient xrplClient = new XrplClient(rippledUrl); ### {{n.next()}}. Generate wallet -To store value and execute transactions on the XRP Ledger, you need to create a wallet: -a [set of keys](cryptographic-keys.html#key-components) and an [address](accounts.html#addresses) that's -been [funded with enough XRP](accounts.html#creating-accounts) to meet the [account reserve](reserves.html). -The address is the identifier of your account and you use the [private key](cryptographic-keys.html#private-key) to -sign transactions that you submit to the XRP Ledger. For production purposes, you should take care to store your keys and set up +To store value and execute transactions on the XRP Ledger, you need to create a wallet: +a [set of keys](cryptographic-keys.html#key-components) and an [address](accounts.html#addresses) that's +been [funded with enough XRP](accounts.html#creating-accounts) to meet the [account reserve](reserves.html). +The address is the identifier of your account and you use the [private key](cryptographic-keys.html#private-key) to +sign transactions that you submit to the XRP Ledger. For production purposes, you should take care to store your keys and set up a [secure signing method](set-up-secure-signing.html). -For testing and development purposes, you can use the [XRP Faucets](xrp-testnet-faucet.html) to fund +For testing and development purposes, you can use the [XRP Faucets](xrp-testnet-faucet.html) to fund an account on the Testnet or Devnet. To make it easy to generate a new, random Wallet, `xrpl4j` provides the [`DefaultWalletFactory`](https://javadoc.io/doc/org.xrpl/xrpl4j-keypairs/latest/org/xrpl/xrpl4j/wallet/DefaultWalletFactory.html). @@ -131,10 +131,10 @@ System.out.println(testWallet); // print output Wallet { - privateKey= -HIDDEN-, - publicKey=ED90635A6F2A5905D3D5CD2C14905FFB2D838185993576CA4CEE24A920D0D6BD6B, - classicAddress=raj5eirfEpbN9YzG9FzB8ZPNyjpFvH6ycV, - xAddress=T76mQFr9zLGi2LCjVDgJ7mEQCk4767SdEL32mZFygpdGcFf, + privateKey= -HIDDEN-, + publicKey=ED90635A6F2A5905D3D5CD2C14905FFB2D838185993576CA4CEE24A920D0D6BD6B, + classicAddress=raj5eirfEpbN9YzG9FzB8ZPNyjpFvH6ycV, + xAddress=T76mQFr9zLGi2LCjVDgJ7mEQCk4767SdEL32mZFygpdGcFf, isTest=true } ``` @@ -184,20 +184,20 @@ Classic Address: rBXHGshqXu3Smy9FUsQTmo49bGpQUQEm3X X-Address: T7yMiiJJCmgY2yg5WB2davUedDeBFAG5B8r9KHjKCxDdvv3 Funded the account using the Testnet faucet. AccountInfoResult{ - status=success, + status=success, accountData=AccountRootObject{ - ledgerEntryType=ACCOUNT_ROOT, - account=rBXHGshqXu3Smy9FUsQTmo49bGpQUQEm3X, - balance=1000000000, - flags=0, - ownerCount=0, - previousTransactionId=0000000000000000000000000000000000000000000000000000000000000000, - previousTransactionLedgerSequence=0, - sequence=17178149, - signerLists=[], + ledgerEntryType=ACCOUNT_ROOT, + account=rBXHGshqXu3Smy9FUsQTmo49bGpQUQEm3X, + balance=1000000000, + flags=0, + ownerCount=0, + previousTransactionId=0000000000000000000000000000000000000000000000000000000000000000, + previousTransactionLedgerSequence=0, + sequence=17178149, + signerLists=[], index=0DC1B13C73A7F3D2D82446526D0C5D08E88F89BA442D54291117F1A08E447685 - }, - ledgerCurrentIndex=17178149, + }, + ledgerCurrentIndex=17178149, validated=false } ``` diff --git a/content/tutorials/get-started/get-started-with-rippleapi-for-javascript.ja.md b/content/tutorials/get-started/get-started-using-node-js.ja.md similarity index 98% rename from content/tutorials/get-started/get-started-with-rippleapi-for-javascript.ja.md rename to content/tutorials/get-started/get-started-using-node-js.ja.md index 43ff4ed32a..20c88724e2 100644 --- a/content/tutorials/get-started/get-started-with-rippleapi-for-javascript.ja.md +++ b/content/tutorials/get-started/get-started-using-node-js.ja.md @@ -1,5 +1,5 @@ --- -html: get-started-with-rippleapi-for-javascript.html +html: get-started-using-node-js.html parent: get-started.html blurb: XRP Ledgerに照会するエントリーレベルのJavaScriptアプリケーションを構築します。 --- @@ -7,7 +7,7 @@ blurb: XRP Ledgerに照会するエントリーレベルのJavaScriptアプリ このチュートリアルでは、[Node.js](http://nodejs.org/)と[RippleAPI](rippleapi-reference.html)（XRP LedgerにアクセスするためのJavaScript API）を使用して、XRP Ledgerに接続されるアプリケーションを開発するための基本事項を説明します。 -このガイドで使用しているスクリプトと構成ファイルは、[Ripple開発者ポータルのGitHubリポジトリで入手できます](https://github.com/ripple/ripple-dev-portal/tree/master/content/_code-samples/rippleapi_quickstart)。 +このガイドで使用しているスクリプトと構成ファイルは、[このサイトのGitHubリポジトリで入手できます](https://github.com/ripple/ripple-dev-portal/tree/master/content/_code-samples/rippleapi_quickstart)。 diff --git a/content/tutorials/get-started/get-started-with-rippleapi-for-javascript.md b/content/tutorials/get-started/get-started-using-node-js.md similarity index 97% rename from content/tutorials/get-started/get-started-with-rippleapi-for-javascript.md rename to content/tutorials/get-started/get-started-using-node-js.md index 25b3f94de5..9ef86a2b93 100644 --- a/content/tutorials/get-started/get-started-with-rippleapi-for-javascript.md +++ b/content/tutorials/get-started/get-started-using-node-js.md @@ -1,13 +1,13 @@ --- -html: get-started-with-rippleapi-for-javascript.html +html: get-started-using-node-js.html parent: get-started.html blurb: Build an entry-level JavaScript application for querying the XRP Ledger in Node.js. --- -# Get Started with RippleAPI for Node.js +# Get Started Using Node.js -This tutorial guides you through the basics of building an XRP Ledger-connected application using [Node.js](http://nodejs.org/) and [RippleAPI](rippleapi-reference.html), a JavaScript API for accessing the XRP Ledger. You can also use RippleAPI [straight from your browser](get-started.html). +This tutorial guides you through the basics of building an XRP Ledger-connected application using [Node.js](http://nodejs.org/) and [RippleAPI](rippleapi-reference.html), a JavaScript/TypeScript client library for accessing the XRP Ledger. You can also use RippleAPI [straight from your browser](get-started.html). -The scripts and config files used in this guide are [available in the Ripple Dev Portal GitHub Repository](https://github.com/ripple/ripple-dev-portal/tree/master/content/_code-samples/rippleapi_quickstart). +The scripts and config files used in this guide are [available in this website's GitHub Repository](https://github.com/ripple/ripple-dev-portal/tree/master/content/_code-samples/rippleapi_quickstart). diff --git a/content/tutorials/get-started/get-started-using-python.md b/content/tutorials/get-started/get-started-using-python.md index 38377e7ca0..c10e610bb0 100644 --- a/content/tutorials/get-started/get-started-using-python.md +++ b/content/tutorials/get-started/get-started-using-python.md @@ -69,7 +69,7 @@ The sample code in the previous section shows you how to connect to the Testnet, See the example [core server config file](https://github.com/ripple/rippled/blob/c0a0b79d2d483b318ce1d82e526bd53df83a4a2c/cfg/rippled-example.cfg#L1562) for more information about default values. -* By using one of the [available public servers](get-started-with-the-rippled-api.html#public-servers): +* By using one of the available [public servers][]: from xrpl.clients import JsonRpcClient JSON_RPC_URL = "https://s2.ripple.com:51234/" diff --git a/content/tutorials/get-started/public-servers.md b/content/tutorials/get-started/public-servers.md new file mode 100644 index 0000000000..f52af86c73 --- /dev/null +++ b/content/tutorials/get-started/public-servers.md @@ -0,0 +1,29 @@ +--- +html: public-servers.html +parent: get-started.html +blurb: Use these public servers to access the XRP Ledger without needing your own infrastructure. +--- +# Public Servers + +If you don't [run your own `rippled` server](install-rippled.html), you can use the following public servers to submit transactions or read data from the ledger. + +| Operator | [Network][] | JSON-RPC URL | WebSocket URL | Notes | +|:----------|:------------|:-------------|:--------------|:---------------------| +| XRP Ledger Foundation | **Mainnet** | `https://xrplcluster.com/`
`https://xrpl.ws/` [²][] | `wss://xrplcluster.com/`
`wss://xrpl.ws/` [²][] | Full history server cluster. | +| Ripple[¹][] | **Mainnet** | `https://s1.ripple.com:51234/` | `wss://s1.ripple.com/` | General purpose server cluster | +| Ripple[¹][] | **Mainnet** | `https://s2.ripple.com:51234/` | `wss://s2.ripple.com/` | [Full-history server](ledger-history.html#full-history) cluster | +| Ripple[¹][] | Testnet | `https://s.altnet.rippletest.net:51234/` | `wss://s.altnet.rippletest.net/` | Testnet public server | +| Ripple[¹][] | Devnet | `https://s.devnet.rippletest.net:51234/` | `wss://s.devnet.rippletest.net/` | Devnet public server | + +[Network]: parallel-networks.html +[¹]: #footnote-1 +[²]: #footnote-2 + +¹ Ripple's public servers are not for sustained or business use, and they may become unavailable at any time. For regular use, you should run your own `rippled` server or contract someone you trust to do so. Ripple includes [Reporting Mode][] servers in its public clusters. + +² `xrpl.ws` is an alias for `xrplcluster.com`. However, the `.ws` top-level domain's reliability may be unsuitable for production uses. + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/tutorials/manage-the-rippled-server/configuration/connect-your-rippled-to-the-xrp-test-net.md b/content/tutorials/manage-the-rippled-server/configuration/connect-your-rippled-to-the-xrp-test-net.md index a72500f380..241a48cadb 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/connect-your-rippled-to-the-xrp-test-net.md +++ b/content/tutorials/manage-the-rippled-server/configuration/connect-your-rippled-to-the-xrp-test-net.md @@ -122,7 +122,7 @@ $ sudo systemctl restart rippled It takes about 5 to 15 minutes to sync to the network after a restart. After your server is synced, the [server_info method][] shows the a `validated_ledger` object based on the network you are connected to. -To verify that your `rippled` is connected to the XRP Testnet or Devnet, compare the results from your server to [a public server](get-started-with-the-rippled-api.html#public-servers) on the Testnet or Devnet. The `seq` field of the `validated_ledger` object should be the same on both servers (possibly off by one or two, if it changed as you were checking). +To verify that your `rippled` is connected to the XRP Testnet or Devnet, compare the results from your server to [a public server][public servers] on the Testnet or Devnet. The `seq` field of the `validated_ledger` object should be the same on both servers (possibly off by one or two, if it changed as you were checking). The following example shows how to check the latest validated ledger from the commandline: @@ -158,7 +158,7 @@ $ rippled --rpc_ip 34.201.59.230:51234 server_info | grep seq -**Note:** The IP addresses in these examples are for public servers, and may change periodically. If you get no response, look up the IP address of a [public server](get-started-with-the-rippled-api.html#public-servers), for example using the `dig` command. +**Note:** The IP addresses in these examples are for public servers, and may change periodically. If you get no response, look up the IP address of a [public server][public servers], for example using the `dig` command. diff --git a/dactyl-config.yml b/dactyl-config.yml index 39bb673d4e..8a231e63d3 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -157,7 +157,6 @@ targets: "rippled-server-modes.html#reporting-mode": "rippled-server-modes.html#レポーティングモード" # Fix links for untranslated get-started-using-python.html: "the-rippled-server.html#reasons-to-run-your-own-server": "rippled-server-modes.html#ストックサーバーを運用する理由" - "get-started-with-the-rippled-api.html#public-servers": "get-started-with-the-rippled-api.html#公開サーバー" "cryptographic-keys.html#key-components": "cryptographic-keys.html#キーの生成" "accounts.html#addresses": "accounts.html#アドレス" "cryptographic-keys.html#private-key": "cryptographic-keys.html#キーの生成" @@ -1007,31 +1006,57 @@ pages: targets: - ja + - md: tutorials/get-started/public-servers.md + targets: + - en + - ja + - md: tutorials/get-started/get-started-using-python.md targets: - en - ja + - md: tutorials/get-started/get-started-using-java.md targets: - en - ja - - md: tutorials/get-started/get-started-with-the-rippled-api.md + - md: tutorials/get-started/get-started-using-node-js.md targets: - en - - md: tutorials/get-started/get-started-with-the-rippled-api.ja.md + - md: tutorials/get-started/get-started-using-node-js.ja.md targets: - ja - - md: tutorials/get-started/get-started-with-rippleapi-for-javascript.md + # Redirect for old JS Client Library URL + - name: Get Started Using Node.js + html: get-started-with-rippleapi-for-javascript.html + template: template-redirect.html + redirect_url: get-started-using-node-js.html + nav_omit: true + targets: + - en + - ja + + - md: tutorials/get-started/get-started-using-http-websocket-apis.md targets: - en - - md: tutorials/get-started/get-started-with-rippleapi-for-javascript.ja.md + - md: tutorials/get-started/get-started-using-http-websocket-apis.ja.md targets: - ja + # Redirect for old HTTP/WebSocket APIs URL + - name: Get Started Using HTTP / WebSocket APIs + html: get-started-with-the-rippled-api.html + template: template-redirect.html + redirect_url: get-started-using-http-websocket-apis.html + nav_omit: true + targets: + - en + - ja + - md: tutorials/use-simple-xrp-payments/send-xrp.md targets: - en From 41c70e7157f3b1978a5f841172864b0b01b92986 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Sat, 8 May 2021 01:10:29 -0700 Subject: [PATCH 2/4] HTTP/WS Get Started: consistent use of buttons --- .../get-started/get-started-using-http-websocket-apis.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/tutorials/get-started/get-started-using-http-websocket-apis.md b/content/tutorials/get-started/get-started-using-http-websocket-apis.md index adf273fafb..051d04d076 100644 --- a/content/tutorials/get-started/get-started-using-http-websocket-apis.md +++ b/content/tutorials/get-started/get-started-using-http-websocket-apis.md @@ -65,7 +65,9 @@ Content-Type: application/json } ``` -The response to this command shows you the current status of the server. For more information, see the [server_info method][]. +The response to shows you the current status of the server. + +Read more: [Request Formatting >](request-formatting.html#json-rpc-format) [Response Formatting >](response-formatting.html) [About the server_info method >][server_info method] ## Commandline @@ -77,7 +79,7 @@ Example commandline request: rippled --conf=/etc/opt/ripple/rippled.cfg server_info ``` -For more information on `rippled`'s commandline usage, see [Commandline Usage Reference](https://xrpl.org/commandline-usage.html). +Read more: [Commandline Usage Reference >](commandline-usage.html) **Caution:** The commandline interface is intended for administrative purposes only and is _not a supported API_. New versions of `rippled` may introduce breaking changes to the commandline API without warning! From 6d5689885d7a3581c3075085ea580f0aca70f4e4 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 10 May 2021 15:46:27 -0700 Subject: [PATCH 3/4] Get started reorg: fix typos, move some other files to match nav --- .../get-started-using-http-websocket-apis.md | 6 +- .../get-started/get-started-using-java.md | 5 +- .../get-started/get-started-using-python.md | 1 - .../send-xrp.ja.md | 0 .../send-xrp.md | 0 .../send-a-multi-signed-transaction.ja.md | 0 .../send-a-multi-signed-transaction.md | 0 .../look-up-transaction-results.ja.md | 0 .../look-up-transaction-results.md | 0 .../reliable-transaction-submission.ja.md | 0 .../reliable-transaction-submission.md | 0 .../set-up-secure-signing.ja.md | 0 .../set-up-secure-signing.md | 0 ...nel-to-enable-an-inter-exchange-network.md | 0 .../use-checks/cancel-a-check.ja.md | 0 .../use-checks/cancel-a-check.md | 0 .../cash-a-check-for-a-flexible-amount.ja.md | 0 .../cash-a-check-for-a-flexible-amount.md | 0 .../cash-a-check-for-an-exact-amount.ja.md | 0 .../cash-a-check-for-an-exact-amount.md | 0 .../look-up-checks-by-recipient.ja.md | 0 .../use-checks/look-up-checks-by-recipient.md | 0 .../use-checks/look-up-checks-by-sender.ja.md | 0 .../use-checks/look-up-checks-by-sender.md | 0 .../use-checks/send-a-check.ja.md | 0 .../use-checks/send-a-check.md | 0 .../use-checks/use-checks.ja.md | 0 .../use-checks/use-checks.md | 0 .../cancel-an-expired-escrow.ja.md | 0 .../use-escrows/cancel-an-expired-escrow.md | 0 .../use-escrows/look-up-escrows.ja.md | 0 .../use-escrows/look-up-escrows.md | 0 .../send-a-conditionally-held-escrow.ja.md | 0 .../send-a-conditionally-held-escrow.md | 0 .../use-escrows/send-a-time-held-escrow.ja.md | 0 .../use-escrows/send-a-time-held-escrow.md | 0 .../use-an-escrow-as-a-smart-contract.md | 0 .../use-payment-channels.ja.md | 0 .../use-payment-channels.md | 0 dactyl-config.yml | 72 +++++++++---------- 40 files changed, 41 insertions(+), 43 deletions(-) rename content/tutorials/{use-simple-xrp-payments => get-started}/send-xrp.ja.md (100%) rename content/tutorials/{use-simple-xrp-payments => get-started}/send-xrp.md (100%) rename content/tutorials/{use-simple-xrp-payments => manage-account-settings}/send-a-multi-signed-transaction.ja.md (100%) rename content/tutorials/{use-simple-xrp-payments => manage-account-settings}/send-a-multi-signed-transaction.md (100%) rename content/tutorials/{get-started => production-readiness}/look-up-transaction-results.ja.md (100%) rename content/tutorials/{get-started => production-readiness}/look-up-transaction-results.md (100%) rename content/tutorials/{use-simple-xrp-payments => production-readiness}/reliable-transaction-submission.ja.md (100%) rename content/tutorials/{use-simple-xrp-payments => production-readiness}/reliable-transaction-submission.md (100%) rename content/tutorials/{get-started => production-readiness}/set-up-secure-signing.ja.md (100%) rename content/tutorials/{get-started => production-readiness}/set-up-secure-signing.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/open-a-payment-channel-to-enable-an-inter-exchange-network.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/cancel-a-check.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/cancel-a-check.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/cash-a-check-for-a-flexible-amount.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/cash-a-check-for-a-flexible-amount.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/cash-a-check-for-an-exact-amount.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/cash-a-check-for-an-exact-amount.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/look-up-checks-by-recipient.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/look-up-checks-by-recipient.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/look-up-checks-by-sender.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/look-up-checks-by-sender.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/send-a-check.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/send-a-check.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/use-checks.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-checks/use-checks.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-escrows/cancel-an-expired-escrow.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-escrows/cancel-an-expired-escrow.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-escrows/look-up-escrows.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-escrows/look-up-escrows.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-escrows/send-a-conditionally-held-escrow.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-escrows/send-a-conditionally-held-escrow.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-escrows/send-a-time-held-escrow.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-escrows/send-a-time-held-escrow.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-escrows/use-an-escrow-as-a-smart-contract.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-payment-channels.ja.md (100%) rename content/tutorials/{use-complex-payment-types => use-specialized-payment-types}/use-payment-channels.md (100%) diff --git a/content/tutorials/get-started/get-started-using-http-websocket-apis.md b/content/tutorials/get-started/get-started-using-http-websocket-apis.md index 051d04d076..082796951f 100644 --- a/content/tutorials/get-started/get-started-using-http-websocket-apis.md +++ b/content/tutorials/get-started/get-started-using-http-websocket-apis.md @@ -8,7 +8,7 @@ cta_text: Get Started If you don't have or don't want to use a [client library](client-libraries.html) in your preferred programming language, you can access the XRP Ledger directly through the APIs of its core server software, [`rippled`](the-rippled-server.html). The server provides APIs over JSON-RPC and WebSocket protocols. If you don't [run your own instance of `rippled`](install-rippled.html) you can still use a [public server][public servers]. -**Tip:** You can dive right into the API is with the [**WebSocket API Tool**](websocket-api-tool.html), or use the [XRP Ledger Explorer](https://livenet.xrpl.org/) to watch the progress of the ledger live. +**Tip:** You can dive right into the API with the [**WebSocket API Tool**](websocket-api-tool.html), or use the [XRP Ledger Explorer](https://livenet.xrpl.org/) to watch the progress of the ledger live. ## Differences Between JSON-RPC and WebSocket @@ -41,7 +41,7 @@ Example WebSocket API request: } ``` -The response to shows you the current status of the server. +The response shows you the current status of the server. Read more: [Request Formatting >](request-formatting.html) [Response Formatting >](response-formatting.html) [About the server_info method >][server_info method] @@ -65,7 +65,7 @@ Content-Type: application/json } ``` -The response to shows you the current status of the server. +The response shows you the current status of the server. Read more: [Request Formatting >](request-formatting.html#json-rpc-format) [Response Formatting >](response-formatting.html) [About the server_info method >][server_info method] diff --git a/content/tutorials/get-started/get-started-using-java.md b/content/tutorials/get-started/get-started-using-java.md index a74bc98fa7..8ad10d3d2a 100644 --- a/content/tutorials/get-started/get-started-using-java.md +++ b/content/tutorials/get-started/get-started-using-java.md @@ -7,7 +7,6 @@ category: Get Started blurb: Build a simple Java app that interacts with the XRP Ledger. cta_text: Build an XRP Ledger-connected app filters: - - interactive_steps - include_code --- @@ -41,7 +40,7 @@ The [`xrpl4j` library](https://github.com/XRPLF/xrpl4j) is available on [Maven C In this tutorial, you will need the [xrpl4j-client](https://javadoc.io/doc/org.xrpl/xrpl4j-client/latest/index.html), [xrpl4j-address-codec](https://javadoc.io/doc/org.xrpl/xrpl4j-address-codec/latest/index.html), [xrpl4j-keypairs](https://javadoc.io/doc/org.xrpl/xrpl4j-keypairs/latest/index.html), and -[xrpl4j-model](https://javadoc.io/doc/org.xrpl/xrpl4j-model/latest/index.html) modules. +[xrpl4j-model](https://javadoc.io/doc/org.xrpl/xrpl4j-model/latest/index.html) modules. To install with Maven, add the following to your project's `pom.xml` file and then run `mvn install`: @@ -145,7 +144,7 @@ In order to fund the account on the XRP Ledger, you can use a `FaucetClient` con ### {{n.next()}}. Query the XRP Ledger -You can query the XRP Ledger to get information about [a specific account](account-methods.html), [a specific transaction](tx.html), the state of a [current or a historical ledger](ledger-methods.html), and [the XRP Ledger's decentralized exhange](path-and-order-book-methods.html). You need to make these queries, among other reasons, to look up account info to follow best practices for [reliable transaction submission](reliable-transaction-submission.html). +You can query the XRP Ledger to get information about [a specific account](account-methods.html), [a specific transaction](tx.html), the state of a [current or a historical ledger](ledger-methods.html), and [the XRP Ledger's decentralized exhange](path-and-order-book-methods.html). You need to make these queries, among other reasons, to look up account info to follow best practices for [reliable transaction submission](reliable-transaction-submission.html). Here, we'll use the [`XrplClient` we constructed](#1-connect-to-the-xrp-ledger) to look up information about the [wallet we generated](#2-generate-wallet) in the previous step. diff --git a/content/tutorials/get-started/get-started-using-python.md b/content/tutorials/get-started/get-started-using-python.md index c10e610bb0..12f85e436d 100644 --- a/content/tutorials/get-started/get-started-using-python.md +++ b/content/tutorials/get-started/get-started-using-python.md @@ -4,7 +4,6 @@ parent: get-started.html blurb: Build a simple Python app that interacts with the XRP Ledger. cta_text: Build an XRP Ledger-connected app filters: - - interactive_steps - include_code --- diff --git a/content/tutorials/use-simple-xrp-payments/send-xrp.ja.md b/content/tutorials/get-started/send-xrp.ja.md similarity index 100% rename from content/tutorials/use-simple-xrp-payments/send-xrp.ja.md rename to content/tutorials/get-started/send-xrp.ja.md diff --git a/content/tutorials/use-simple-xrp-payments/send-xrp.md b/content/tutorials/get-started/send-xrp.md similarity index 100% rename from content/tutorials/use-simple-xrp-payments/send-xrp.md rename to content/tutorials/get-started/send-xrp.md diff --git a/content/tutorials/use-simple-xrp-payments/send-a-multi-signed-transaction.ja.md b/content/tutorials/manage-account-settings/send-a-multi-signed-transaction.ja.md similarity index 100% rename from content/tutorials/use-simple-xrp-payments/send-a-multi-signed-transaction.ja.md rename to content/tutorials/manage-account-settings/send-a-multi-signed-transaction.ja.md diff --git a/content/tutorials/use-simple-xrp-payments/send-a-multi-signed-transaction.md b/content/tutorials/manage-account-settings/send-a-multi-signed-transaction.md similarity index 100% rename from content/tutorials/use-simple-xrp-payments/send-a-multi-signed-transaction.md rename to content/tutorials/manage-account-settings/send-a-multi-signed-transaction.md diff --git a/content/tutorials/get-started/look-up-transaction-results.ja.md b/content/tutorials/production-readiness/look-up-transaction-results.ja.md similarity index 100% rename from content/tutorials/get-started/look-up-transaction-results.ja.md rename to content/tutorials/production-readiness/look-up-transaction-results.ja.md diff --git a/content/tutorials/get-started/look-up-transaction-results.md b/content/tutorials/production-readiness/look-up-transaction-results.md similarity index 100% rename from content/tutorials/get-started/look-up-transaction-results.md rename to content/tutorials/production-readiness/look-up-transaction-results.md diff --git a/content/tutorials/use-simple-xrp-payments/reliable-transaction-submission.ja.md b/content/tutorials/production-readiness/reliable-transaction-submission.ja.md similarity index 100% rename from content/tutorials/use-simple-xrp-payments/reliable-transaction-submission.ja.md rename to content/tutorials/production-readiness/reliable-transaction-submission.ja.md diff --git a/content/tutorials/use-simple-xrp-payments/reliable-transaction-submission.md b/content/tutorials/production-readiness/reliable-transaction-submission.md similarity index 100% rename from content/tutorials/use-simple-xrp-payments/reliable-transaction-submission.md rename to content/tutorials/production-readiness/reliable-transaction-submission.md diff --git a/content/tutorials/get-started/set-up-secure-signing.ja.md b/content/tutorials/production-readiness/set-up-secure-signing.ja.md similarity index 100% rename from content/tutorials/get-started/set-up-secure-signing.ja.md rename to content/tutorials/production-readiness/set-up-secure-signing.ja.md diff --git a/content/tutorials/get-started/set-up-secure-signing.md b/content/tutorials/production-readiness/set-up-secure-signing.md similarity index 100% rename from content/tutorials/get-started/set-up-secure-signing.md rename to content/tutorials/production-readiness/set-up-secure-signing.md diff --git a/content/tutorials/use-complex-payment-types/open-a-payment-channel-to-enable-an-inter-exchange-network.md b/content/tutorials/use-specialized-payment-types/open-a-payment-channel-to-enable-an-inter-exchange-network.md similarity index 100% rename from content/tutorials/use-complex-payment-types/open-a-payment-channel-to-enable-an-inter-exchange-network.md rename to content/tutorials/use-specialized-payment-types/open-a-payment-channel-to-enable-an-inter-exchange-network.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/cancel-a-check.ja.md b/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/cancel-a-check.ja.md rename to content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/cancel-a-check.md b/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/cancel-a-check.md rename to content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.ja.md b/content/tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-a-flexible-amount.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.ja.md rename to content/tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-a-flexible-amount.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md b/content/tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md rename to content/tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.ja.md b/content/tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-an-exact-amount.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.ja.md rename to content/tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-an-exact-amount.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.md b/content/tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-an-exact-amount.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.md rename to content/tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-an-exact-amount.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.ja.md b/content/tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-recipient.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.ja.md rename to content/tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-recipient.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.md b/content/tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-recipient.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.md rename to content/tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-recipient.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.ja.md b/content/tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-sender.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.ja.md rename to content/tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-sender.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.md b/content/tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-sender.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.md rename to content/tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-sender.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/send-a-check.ja.md b/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/send-a-check.ja.md rename to content/tutorials/use-specialized-payment-types/use-checks/send-a-check.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/send-a-check.md b/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/send-a-check.md rename to content/tutorials/use-specialized-payment-types/use-checks/send-a-check.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/use-checks.ja.md b/content/tutorials/use-specialized-payment-types/use-checks/use-checks.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/use-checks.ja.md rename to content/tutorials/use-specialized-payment-types/use-checks/use-checks.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-checks/use-checks.md b/content/tutorials/use-specialized-payment-types/use-checks/use-checks.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-checks/use-checks.md rename to content/tutorials/use-specialized-payment-types/use-checks/use-checks.md diff --git a/content/tutorials/use-complex-payment-types/use-escrows/cancel-an-expired-escrow.ja.md b/content/tutorials/use-specialized-payment-types/use-escrows/cancel-an-expired-escrow.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-escrows/cancel-an-expired-escrow.ja.md rename to content/tutorials/use-specialized-payment-types/use-escrows/cancel-an-expired-escrow.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-escrows/cancel-an-expired-escrow.md b/content/tutorials/use-specialized-payment-types/use-escrows/cancel-an-expired-escrow.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-escrows/cancel-an-expired-escrow.md rename to content/tutorials/use-specialized-payment-types/use-escrows/cancel-an-expired-escrow.md diff --git a/content/tutorials/use-complex-payment-types/use-escrows/look-up-escrows.ja.md b/content/tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-escrows/look-up-escrows.ja.md rename to content/tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-escrows/look-up-escrows.md b/content/tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-escrows/look-up-escrows.md rename to content/tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.md diff --git a/content/tutorials/use-complex-payment-types/use-escrows/send-a-conditionally-held-escrow.ja.md b/content/tutorials/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-escrows/send-a-conditionally-held-escrow.ja.md rename to content/tutorials/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-escrows/send-a-conditionally-held-escrow.md b/content/tutorials/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-escrows/send-a-conditionally-held-escrow.md rename to content/tutorials/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.md diff --git a/content/tutorials/use-complex-payment-types/use-escrows/send-a-time-held-escrow.ja.md b/content/tutorials/use-specialized-payment-types/use-escrows/send-a-time-held-escrow.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-escrows/send-a-time-held-escrow.ja.md rename to content/tutorials/use-specialized-payment-types/use-escrows/send-a-time-held-escrow.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-escrows/send-a-time-held-escrow.md b/content/tutorials/use-specialized-payment-types/use-escrows/send-a-time-held-escrow.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-escrows/send-a-time-held-escrow.md rename to content/tutorials/use-specialized-payment-types/use-escrows/send-a-time-held-escrow.md diff --git a/content/tutorials/use-complex-payment-types/use-escrows/use-an-escrow-as-a-smart-contract.md b/content/tutorials/use-specialized-payment-types/use-escrows/use-an-escrow-as-a-smart-contract.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-escrows/use-an-escrow-as-a-smart-contract.md rename to content/tutorials/use-specialized-payment-types/use-escrows/use-an-escrow-as-a-smart-contract.md diff --git a/content/tutorials/use-complex-payment-types/use-payment-channels.ja.md b/content/tutorials/use-specialized-payment-types/use-payment-channels.ja.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-payment-channels.ja.md rename to content/tutorials/use-specialized-payment-types/use-payment-channels.ja.md diff --git a/content/tutorials/use-complex-payment-types/use-payment-channels.md b/content/tutorials/use-specialized-payment-types/use-payment-channels.md similarity index 100% rename from content/tutorials/use-complex-payment-types/use-payment-channels.md rename to content/tutorials/use-specialized-payment-types/use-payment-channels.md diff --git a/dactyl-config.yml b/dactyl-config.yml index 8a231e63d3..3719531ad1 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -1057,11 +1057,11 @@ pages: - en - ja - - md: tutorials/use-simple-xrp-payments/send-xrp.md + - md: tutorials/get-started/send-xrp.md targets: - en - - md: tutorials/use-simple-xrp-payments/send-xrp.ja.md + - md: tutorials/get-started/send-xrp.ja.md targets: - ja @@ -1093,27 +1093,27 @@ pages: - en - ja - - md: tutorials/get-started/set-up-secure-signing.md + - md: tutorials/production-readiness/set-up-secure-signing.md targets: - en - - md: tutorials/get-started/set-up-secure-signing.ja.md + - md: tutorials/production-readiness/set-up-secure-signing.ja.md targets: - ja - - md: tutorials/get-started/look-up-transaction-results.md + - md: tutorials/production-readiness/look-up-transaction-results.md targets: - en - - md: tutorials/get-started/look-up-transaction-results.ja.md + - md: tutorials/production-readiness/look-up-transaction-results.ja.md targets: - ja - - md: tutorials/use-simple-xrp-payments/reliable-transaction-submission.md + - md: tutorials/production-readiness/reliable-transaction-submission.md targets: - en - - md: tutorials/use-simple-xrp-payments/reliable-transaction-submission.ja.md + - md: tutorials/production-readiness/reliable-transaction-submission.ja.md targets: - ja @@ -1176,11 +1176,11 @@ pages: targets: - ja - - md: tutorials/use-simple-xrp-payments/send-a-multi-signed-transaction.md + - md: tutorials/manage-account-settings/send-a-multi-signed-transaction.md targets: - en - - md: tutorials/use-simple-xrp-payments/send-a-multi-signed-transaction.ja.md + - md: tutorials/manage-account-settings/send-a-multi-signed-transaction.ja.md targets: - ja @@ -1249,110 +1249,110 @@ pages: targets: - ja - - md: tutorials/use-complex-payment-types/use-escrows/send-a-time-held-escrow.md + - md: tutorials/use-specialized-payment-types/use-escrows/send-a-time-held-escrow.md targets: - en - - md: tutorials/use-complex-payment-types/use-escrows/send-a-time-held-escrow.ja.md + - md: tutorials/use-specialized-payment-types/use-escrows/send-a-time-held-escrow.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-escrows/send-a-conditionally-held-escrow.md + - md: tutorials/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.md targets: - en - - md: tutorials/use-complex-payment-types/use-escrows/send-a-conditionally-held-escrow.ja.md + - md: tutorials/use-specialized-payment-types/use-escrows/send-a-conditionally-held-escrow.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-escrows/cancel-an-expired-escrow.md + - md: tutorials/use-specialized-payment-types/use-escrows/cancel-an-expired-escrow.md targets: - en - - md: tutorials/use-complex-payment-types/use-escrows/cancel-an-expired-escrow.ja.md + - md: tutorials/use-specialized-payment-types/use-escrows/cancel-an-expired-escrow.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-escrows/look-up-escrows.md + - md: tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.md targets: - en - - md: tutorials/use-complex-payment-types/use-escrows/look-up-escrows.ja.md + - md: tutorials/use-specialized-payment-types/use-escrows/look-up-escrows.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-escrows/use-an-escrow-as-a-smart-contract.md + - md: tutorials/use-specialized-payment-types/use-escrows/use-an-escrow-as-a-smart-contract.md targets: - en - ja #TODO: split concept info off of the paychan tutorial - - md: tutorials/use-complex-payment-types/use-payment-channels.md + - md: tutorials/use-specialized-payment-types/use-payment-channels.md targets: - en - - md: tutorials/use-complex-payment-types/use-payment-channels.ja.md + - md: tutorials/use-specialized-payment-types/use-payment-channels.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/open-a-payment-channel-to-enable-an-inter-exchange-network.md + - md: tutorials/use-specialized-payment-types/open-a-payment-channel-to-enable-an-inter-exchange-network.md targets: - en - ja - - md: tutorials/use-complex-payment-types/use-checks/use-checks.md + - md: tutorials/use-specialized-payment-types/use-checks/use-checks.md targets: - en - - md: tutorials/use-complex-payment-types/use-checks/use-checks.ja.md + - md: tutorials/use-specialized-payment-types/use-checks/use-checks.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-checks/send-a-check.md + - md: tutorials/use-specialized-payment-types/use-checks/send-a-check.md targets: - en - - md: tutorials/use-complex-payment-types/use-checks/send-a-check.ja.md + - md: tutorials/use-specialized-payment-types/use-checks/send-a-check.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.md + - md: tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-an-exact-amount.md targets: - en - - md: tutorials/use-complex-payment-types/use-checks/cash-a-check-for-an-exact-amount.ja.md + - md: tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-an-exact-amount.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md + - md: tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-a-flexible-amount.md targets: - en - - md: tutorials/use-complex-payment-types/use-checks/cash-a-check-for-a-flexible-amount.ja.md + - md: tutorials/use-specialized-payment-types/use-checks/cash-a-check-for-a-flexible-amount.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-checks/cancel-a-check.md + - md: tutorials/use-specialized-payment-types/use-checks/cancel-a-check.md targets: - en - - md: tutorials/use-complex-payment-types/use-checks/cancel-a-check.ja.md + - md: tutorials/use-specialized-payment-types/use-checks/cancel-a-check.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.md + - md: tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-sender.md targets: - en - - md: tutorials/use-complex-payment-types/use-checks/look-up-checks-by-sender.ja.md + - md: tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-sender.ja.md targets: - ja - - md: tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.md + - md: tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-recipient.md targets: - en - - md: tutorials/use-complex-payment-types/use-checks/look-up-checks-by-recipient.ja.md + - md: tutorials/use-specialized-payment-types/use-checks/look-up-checks-by-recipient.ja.md targets: - ja From 7d16ea342902c501a721c46a0b380708a0cf4d7b Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 10 May 2021 16:27:21 -0700 Subject: [PATCH 4/4] Update links to HTTP/WS get started page --- content/_snippets/checkcash-prereqs.ja.md | 2 +- content/_snippets/checkcash-prereqs.md | 2 +- content/_snippets/post-rippled-install.ja.md | 2 +- content/_snippets/post-rippled-install.md | 2 +- content/concepts/issued-currencies/freezes.ja.md | 6 +++--- content/concepts/issued-currencies/freezes.md | 6 +++--- .../transaction-basics/transaction-cost.ja.md | 2 +- .../transaction-basics/transaction-cost.md | 2 +- .../concepts/the-rippled-server/rippled-server-modes.md | 6 +++--- content/concepts/the-rippled-server/the-rippled-server.md | 7 ++++++- .../admin-rippled-methods/admin-rippled-methods.ja.md | 2 +- .../admin-rippled-methods/admin-rippled-methods.md | 2 +- .../rippled-api/api-conventions/rate-limiting.md | 4 ++-- .../rippled-api/api-conventions/response-formatting.md | 4 ++-- .../manage-account-settings/offline-account-setup.ja.md | 2 +- .../manage-account-settings/offline-account-setup.md | 2 +- .../configuration/configure-advisory-deletion.ja.md | 2 +- .../configuration/configure-advisory-deletion.md | 2 +- .../configuration/configure-amendment-voting.md | 2 +- .../configuration/enable-public-signing.ja.md | 2 +- .../configuration/enable-public-signing.md | 4 ++-- .../installation/build-run-rippled-macos.ja.md | 2 +- .../installation/build-run-rippled-macos.md | 2 +- .../installation/build-run-rippled-ubuntu.ja.md | 2 +- .../installation/build-run-rippled-ubuntu.md | 2 +- .../install-rippled-on-centos-rhel-with-yum.ja.md | 2 +- .../install-rippled-on-centos-rhel-with-yum.md | 2 +- .../installation/install-rippled-on-ubuntu.ja.md | 2 +- .../installation/install-rippled-on-ubuntu.md | 2 +- .../installation/rippled-1-3-migration-instructions.ja.md | 2 +- .../installation/rippled-1-3-migration-instructions.md | 2 +- .../troubleshooting/fix-sqlite-tx-db-page-size-issue.ja.md | 2 +- .../troubleshooting/fix-sqlite-tx-db-page-size-issue.md | 2 +- .../troubleshooting/understanding-log-messages.md | 2 +- .../production-readiness/set-up-secure-signing.ja.md | 2 +- .../production-readiness/set-up-secure-signing.md | 2 +- .../use-checks/cancel-a-check.ja.md | 2 +- .../use-checks/cancel-a-check.md | 2 +- .../use-checks/send-a-check.ja.md | 2 +- .../use-checks/send-a-check.md | 2 +- dactyl-config.yml | 2 ++ 41 files changed, 56 insertions(+), 49 deletions(-) diff --git a/content/_snippets/checkcash-prereqs.ja.md b/content/_snippets/checkcash-prereqs.ja.md index bcde3dd253..3bc2ec8ff9 100644 --- a/content/_snippets/checkcash-prereqs.ja.md +++ b/content/_snippets/checkcash-prereqs.ja.md @@ -7,4 +7,4 @@ Checkを換金するための前提条件は、正確な金額を換金する場 - トラストラインと限度額について詳しくは、[発行済み通貨](issued-currencies.html)および[トラストラインと発行](trust-lines-and-issuing.html)を参照してください。 - トランザクションに安全に署名できる手段（[RippleAPI][]や各自の[`rippled`サーバー](install-rippled.html)など）。 - `rippled`サーバーに接続できるクライアントライブラリ（[RippleAPI][]、HTTPライブラリ、WebSocketライブラリなど）。 - - 詳細は、[`rippled` APIの使用開始](get-started-with-the-rippled-api.html)を参照してください。 + - 詳細は、[`rippled` APIの使用開始](get-started-using-http-websocket-apis.html)を参照してください。 diff --git a/content/_snippets/checkcash-prereqs.md b/content/_snippets/checkcash-prereqs.md index 2903647072..b839d564c2 100644 --- a/content/_snippets/checkcash-prereqs.md +++ b/content/_snippets/checkcash-prereqs.md @@ -7,4 +7,4 @@ The prerequisites for cashing a check are the same whether you are cashing it fo - For more information on trust lines and limits, see [Issued Currencies](issued-currencies.html) and [Trust Lines and Issuing](trust-lines-and-issuing.html). - A secure way to sign transactions, such as [RippleAPI][] or your own [`rippled` server](install-rippled.html). - A client library that can connect to a `rippled` server, such as [RippleAPI][] or any HTTP or WebSocket library. - - For more information, see [Get Started with the `rippled` API](get-started-with-the-rippled-api.html). + - For more information, see [Get Started with the `rippled` API](get-started-using-http-websocket-apis.html). diff --git a/content/_snippets/post-rippled-install.ja.md b/content/_snippets/post-rippled-install.ja.md index 7a7a05a0b6..ee11795cee 100644 --- a/content/_snippets/post-rippled-install.ja.md +++ b/content/_snippets/post-rippled-install.ja.md @@ -2,7 +2,7 @@ `rippled`ログメッセージの詳細は、[ログメッセージについて](understanding-log-messages.html)を参照してください。 -`rippled`が残りのネットワークと同期されたら、ストック`rippled`サーバーが完全に機能するようになります。このサーバーを、ローカル署名やXRP LedgerへのAPIアクセスに使用できます。`rippled`サーバーがネットワークと同期されているかどうかを判別するには、[`rippled`サーバーの状況](rippled-server-states.html)を使用します。[`rippled`のコマンドラインインターフェイス](get-started-with-the-rippled-api.html#コマンドライン)を使用すれば、これを迅速にテストできます。 +`rippled`が残りのネットワークと同期されたら、ストック`rippled`サーバーが完全に機能するようになります。このサーバーを、ローカル署名やXRP LedgerへのAPIアクセスに使用できます。`rippled`サーバーがネットワークと同期されているかどうかを判別するには、[`rippled`サーバーの状況](rippled-server-states.html)を使用します。[`rippled`のコマンドラインインターフェイス](get-started-using-http-websocket-apis.html#コマンドライン)を使用すれば、これを迅速にテストできます。 {% if currentpage.md == "tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md" or currentpage.md == "tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md" %} diff --git a/content/_snippets/post-rippled-install.md b/content/_snippets/post-rippled-install.md index 90fd661fe3..3080df74c9 100644 --- a/content/_snippets/post-rippled-install.md +++ b/content/_snippets/post-rippled-install.md @@ -2,7 +2,7 @@ It can take several minutes for `rippled` to sync with the rest of the network, For information about `rippled` log messages, see [Understanding Log Messages](understanding-log-messages.html). -After your `rippled` has synchronized with the rest of the network, you have a fully functional stock `rippled` server that you can use for local signing and API access to the XRP Ledger. Use [`rippled` server states](rippled-server-states.html) to tell whether your `rippled` server has synchronized with the network. You can use the [`rippled` commandline interface](get-started-with-the-rippled-api.html#commandline) to test this quickly: +After your `rippled` has synchronized with the rest of the network, you have a fully functional stock `rippled` server that you can use for local signing and API access to the XRP Ledger. Use [`rippled` server states](rippled-server-states.html) to tell whether your `rippled` server has synchronized with the network. You can use the [`rippled` commandline interface](get-started-using-http-websocket-apis.html#commandline) to test this quickly: {% if currentpage.md == "tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md" or currentpage.md == "tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md" %} diff --git a/content/concepts/issued-currencies/freezes.ja.md b/content/concepts/issued-currencies/freezes.ja.md index fbdc2ebf44..ba26e0daa6 100644 --- a/content/concepts/issued-currencies/freezes.ja.md +++ b/content/concepts/issued-currencies/freezes.ja.md @@ -101,7 +101,7 @@ No Freeze設定は、アドレスのマスターキーのシークレットキ `Fee`、`Sequence`、`LastLedgerSequence`パラメーターは[通常の方法で](transaction-basics.html#トランザクションへの署名とトランザクションの送信)設定します。 -[WebSocket API](get-started-with-the-rippled-api.html#websocket-api)を使用してIndividual Freezeを有効にするTrustSetトランザクションを送信する例: +[WebSocket API](get-started-using-http-websocket-apis.html#websocket-api)を使用してIndividual Freezeを有効にするTrustSetトランザクションを送信する例: ```json { @@ -155,7 +155,7 @@ No Freeze設定は、アドレスのマスターキーのシークレットキ アドレスに対してGlobal Freezeを有効にするには、`SetFlag`フィールドに[asfGlobalFreezeフラグ値](accountset.html#accountsetのフラグ)を指定した`AccountSet`トランザクションを送信します。Global Freezeを無効にするには、`ClearFlag`フィールドにasfGlobalFreezeフラグ値を指定します。 -[WebSocket API](get-started-with-the-rippled-api.html#websocket-api)を使用してGlobal Freezeを有効にするAccountSetトランザクションを送信する例: +[WebSocket API](get-started-using-http-websocket-apis.html#websocket-api)を使用してGlobal Freezeを有効にするAccountSetトランザクションを送信する例: ```json { @@ -203,7 +203,7 @@ No Freeze設定は、アドレスのマスターキーのシークレットキ アドレスに対してNo Freezeを有効にするには、`SetFlag`フィールドに[asfNoFreezeフラグ値](accountset.html#accountsetのフラグ)を指定した`AccountSet`トランザクションを送信します。このトランザクションをマスターキーで署名する必要があります。有効にしたNo Freezeを無効にすることはできません。 -[WebSocket API](get-started-with-the-rippled-api.html#websocket-api)を使用してNo Freezeを有効にするAccountSetトランザクションを送信する例: +[WebSocket API](get-started-using-http-websocket-apis.html#websocket-api)を使用してNo Freezeを有効にするAccountSetトランザクションを送信する例: WebSocket要求: diff --git a/content/concepts/issued-currencies/freezes.md b/content/concepts/issued-currencies/freezes.md index 0cb4d8a04a..cc12daff40 100644 --- a/content/concepts/issued-currencies/freezes.md +++ b/content/concepts/issued-currencies/freezes.md @@ -101,7 +101,7 @@ To enable or disable Individual Freeze on a specific trust line, send a `TrustSe Set the `Fee`, `Sequence`, and `LastLedgerSequence` parameters [in the typical way](transaction-basics.html#signing-and-submitting-transactions). -Example of submitting a TrustSet transaction to enable an individual freeze using the [WebSocket API](get-started-with-the-rippled-api.html#websocket-api): +Example of submitting a TrustSet transaction to enable an individual freeze using the [WebSocket API](get-started-using-http-websocket-apis.html#websocket-api): ```json { @@ -155,7 +155,7 @@ Example JavaScript (ECMAScript 6) code to enable Individual Freeze on a trust li To enable Global Freeze on an address, send an `AccountSet` transaction with the [`asfGlobalFreeze` flag value](accountset.html#accountset-flags) in the `SetFlag` field. To disable Global Freeze, put the `asfGlobalFreeze` flag value in the `ClearFlag` field instead. -Example of submitting an AccountSet transaction to enable Global Freeze using the [WebSocket API](get-started-with-the-rippled-api.html#websocket-api): +Example of submitting an AccountSet transaction to enable Global Freeze using the [WebSocket API](get-started-using-http-websocket-apis.html#websocket-api): ```json { @@ -203,7 +203,7 @@ Example JavaScript (ECMAScript 6) code to enable Global Freeze on an address: To enable No Freeze on an address, send an `AccountSet` transaction with the [`asfNoFreeze` flag value](accountset.html#accountset-flags) in the `SetFlag` field. You must sign this transaction using the master key. Once enabled, you cannot disable No Freeze. -Example of submitting an AccountSet transaction to enable No Freeze using the [WebSocket API](get-started-with-the-rippled-api.html#websocket-api): +Example of submitting an AccountSet transaction to enable No Freeze using the [WebSocket API](get-started-using-http-websocket-apis.html#websocket-api): WebSocket request: diff --git a/content/concepts/payment-system-basics/transaction-basics/transaction-cost.ja.md b/content/concepts/payment-system-basics/transaction-basics/transaction-cost.ja.md index e0ebbef7a2..74b4e710d3 100644 --- a/content/concepts/payment-system-basics/transaction-basics/transaction-cost.ja.md +++ b/content/concepts/payment-system-basics/transaction-basics/transaction-cost.ja.md @@ -50,7 +50,7 @@ XRP LedgerをスパムやDoS攻撃から守るため、各トランザクショ ## ローカル負荷コスト -各`rippled`サーバーには、現在の負荷に基づいてコストしきい値が保持されています。送信するトランザクションの`Fee`値が`rippled`サーバーの現在の負荷ベーストランザクションコストより低い場合、そのサーバーはトランザクションの適用も中継もしません。（**注記:** [管理者接続](get-started-with-the-rippled-api.html)を介してトランザクションを送信する場合、トランザクションがスケーリングされていない最低トランザクションコストを満たすかぎり、サーバーはそのトランザクションを適用し、中継します。）トランザクションの`Fee`値が大半のサーバーの要件を満たさないかぎり、そのトランザクションが[コンセンサスプロセス](consensus.html)を完了する可能性は極めて低くなります。 +各`rippled`サーバーには、現在の負荷に基づいてコストしきい値が保持されています。送信するトランザクションの`Fee`値が`rippled`サーバーの現在の負荷ベーストランザクションコストより低い場合、そのサーバーはトランザクションの適用も中継もしません。（**注記:** [管理者接続](get-started-using-http-websocket-apis.html)を介してトランザクションを送信する場合、トランザクションがスケーリングされていない最低トランザクションコストを満たすかぎり、サーバーはそのトランザクションを適用し、中継します。）トランザクションの`Fee`値が大半のサーバーの要件を満たさないかぎり、そのトランザクションが[コンセンサスプロセス](consensus.html)を完了する可能性は極めて低くなります。 ## オープンレジャーコスト diff --git a/content/concepts/payment-system-basics/transaction-basics/transaction-cost.md b/content/concepts/payment-system-basics/transaction-basics/transaction-cost.md index ba13386456..bde37c38d8 100644 --- a/content/concepts/payment-system-basics/transaction-basics/transaction-cost.md +++ b/content/concepts/payment-system-basics/transaction-basics/transaction-cost.md @@ -50,7 +50,7 @@ This divides transactions into roughly three categories: ## Local Load Cost -Each `rippled` server maintains a cost threshold based on its current load. If you submit a transaction with a `Fee` value that is lower than current load-based transaction cost of the `rippled` server, that server neither applies nor relays the transaction. (**Note:** If you submit a transaction through an [admin connection](get-started-with-the-rippled-api.html), the server applies and relays the transaction as long as the transaction meets the un-scaled minimum transaction cost.) A transaction is very unlikely to survive [the consensus process](consensus.html) unless its `Fee` value meets the requirements of a majority of servers. +Each `rippled` server maintains a cost threshold based on its current load. If you submit a transaction with a `Fee` value that is lower than current load-based transaction cost of the `rippled` server, that server neither applies nor relays the transaction. (**Note:** If you submit a transaction through an [admin connection](get-started-using-http-websocket-apis.html), the server applies and relays the transaction as long as the transaction meets the un-scaled minimum transaction cost.) A transaction is very unlikely to survive [the consensus process](consensus.html) unless its `Fee` value meets the requirements of a majority of servers. ## Open Ledger Cost diff --git a/content/concepts/the-rippled-server/rippled-server-modes.md b/content/concepts/the-rippled-server/rippled-server-modes.md index 67c8fe588b..4bfbc5dac7 100644 --- a/content/concepts/the-rippled-server/rippled-server-modes.md +++ b/content/concepts/the-rippled-server/rippled-server-modes.md @@ -9,7 +9,7 @@ The `rippled` server software can run in several modes depending on its configur - [**P2P Mode**](#p2p-mode) - This is the main mode of the server: it follows the peer-to-peer network, processes transactions, and maintains some amount of [ledger history](ledger-history.html). This mode can be configured to do any or all of the following roles: - [**Validator**](#validators) - Helps secure the network by participating in consensus - - [**API Server**](#api-servers) - Provides [API access](get-started-with-the-rippled-api.html) to read data from the shared ledger, submit transactions, and watch activity in the ledger. Optionally, this can be a [**Full History Server**](#full-history-servers), which keeps a complete record of transaction and ledger history. + - [**API Server**](#api-servers) - Provides [API access](get-started-using-http-websocket-apis.html) to read data from the shared ledger, submit transactions, and watch activity in the ledger. Optionally, this can be a [**Full History Server**](#full-history-servers), which keeps a complete record of transaction and ledger history. - [**Hub Server**](#public-hubs) - Relays messages between many other members of the peer-to-peer network. - [**Reporting mode**](#reporting-mode) - A specialized mode for serving API requests from a relational database. Since it does not participate in the peer-to-peer network, it requires a connection to a P2P Mode server. [New in: rippled 1.7.0][] - [**Stand-alone mode**](#stand-alone-mode) - An offline mode for testing. Does not connect to the peer-to-peer network or use consensus. @@ -104,6 +104,6 @@ In stand-alone mode, the server operates without attempting to connect to the pe -{% include '_snippets/rippled-api-links.md' %} -{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %} diff --git a/content/concepts/the-rippled-server/the-rippled-server.md b/content/concepts/the-rippled-server/the-rippled-server.md index dff58a3544..6226c961a2 100644 --- a/content/concepts/the-rippled-server/the-rippled-server.md +++ b/content/concepts/the-rippled-server/the-rippled-server.md @@ -20,10 +20,15 @@ You need to trust the `rippled` you use. If you connect to a malicious server, t * It could selectively show or hide payment paths and currency exchange offers to guarantee its own profit while not providing you the best deal. * If you sent it your address's secret key, it could make arbitrary transactions on your behalf, and even transfer or destroy all the money your address holds. -Additionally, running your own server gives you [admin access](get-started-with-the-rippled-api.html#admin-access), which allows you to run important admin-only and load-intensive commands. If you use a shared server, you have to worry about other users of the same server competing with you for the server's computing power. Many of the commands in the WebSocket API can put a lot of strain on the server, so `rippled` has the option to scale back its responses when it needs to. If you share a server with others, you may not always get the best results possible. +Additionally, running your own server gives you [admin access](get-started-using-http-websocket-apis.html#admin-access), which allows you to run important admin-only and load-intensive commands. If you use a shared server, you have to worry about other users of the same server competing with you for the server's computing power. Many of the commands in the WebSocket API can put a lot of strain on the server, so `rippled` has the option to scale back its responses when it needs to. If you share a server with others, you may not always get the best results possible. Finally, if you run a validating server, you can use a stock server as a proxy to the public network while keeping your validating server on a private network only accessible to the outside world through the stock server. This makes it more difficult to compromise the integrity of your validating server. ## rippled Server Features + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.ja.md b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.ja.md index d75f8f0fed..73e1f7e9f9 100644 --- a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.ja.md +++ b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.ja.md @@ -7,7 +7,7 @@ blurb: これらの管理APIメソッドを使用してrippledサーバーを管 `rippled`サーバーと直接通信する際には管理APIメソッドを使用します。管理メソッドは、信頼できるサーバー運用担当者のみを対象としています。管理メソッドには、サーバーの管理、監視、デバッグのためのコマンドが含まれています。 -管理コマンドを使用できるのは、管理者として、`rippled.cfg`ファイルに指定されているホストとポートで`rippled`サーバーに接続している場合に限られます。デフォルトでは、コマンドラインクライアントが管理接続を使用します。`rippled`への接続についての詳細は、[rippled API入門](get-started-with-the-rippled-api.html)を参照してください。 +管理コマンドを使用できるのは、管理者として、`rippled.cfg`ファイルに指定されているホストとポートで`rippled`サーバーに接続している場合に限られます。デフォルトでは、コマンドラインクライアントが管理接続を使用します。`rippled`への接続についての詳細は、[rippled API入門](get-started-using-http-websocket-apis.html)を参照してください。 ## [キー生成メソッド](key-generation-methods.html) diff --git a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md index e62eb74db4..d8d5bb9182 100644 --- a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md +++ b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md @@ -7,7 +7,7 @@ blurb: Administer a rippled server with these admin API methods. Communicate directly with a `rippled` server using these admin API methods. Admin methods are meant only for trusted personnel in charge of keeping the server operational. Admin methods include commands for managing, monitoring, and debugging the server. -Admin commands are available only if you connect to `rippled` on a host and port that the `rippled.cfg` file identifies as admin. By default, the commandline client uses an admin connection. For more information on connecting to `rippled`, see [Getting Started with the `rippled` API](get-started-with-the-rippled-api.html). +Admin commands are available only if you connect to `rippled` on a host and port that the `rippled.cfg` file identifies as admin. By default, the commandline client uses an admin connection. For more information on connecting to `rippled`, see [Getting Started with the `rippled` API](get-started-using-http-websocket-apis.html). ## [Key Generation Methods](key-generation-methods.html) diff --git a/content/references/rippled-api/api-conventions/rate-limiting.md b/content/references/rippled-api/api-conventions/rate-limiting.md index ab57c825a7..223effcd63 100644 --- a/content/references/rippled-api/api-conventions/rate-limiting.md +++ b/content/references/rippled-api/api-conventions/rate-limiting.md @@ -7,7 +7,7 @@ blurb: Information on how public APIs limit clients from making too many request 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. -**Tip:** Rate limiting does not apply when the client is connected [as an admin](get-started-with-the-rippled-api.html#admin-access). +**Tip:** Rate limiting does not apply when the client is connected [as an admin](get-started-using-http-websocket-apis.html#admin-access). When a client is approaching the rate limit, the server adds the field `"warning": "load"` at the top level of an [API response](response-formatting.html). This warning is not added to every response, but the server may send several such warnings before it disconnects a client. @@ -55,7 +55,7 @@ The usage rate drops off exponentially over time, so a client that does not make - [The `rippled` Server](the-rippled-server.html) - [Software Ecosystem](software-ecosystem.html) - **Tutorials:** - - [Getting Started with XRP Ledger APIs](get-started-with-the-rippled-api.html) + - [Getting Started with XRP Ledger APIs](get-started-using-http-websocket-apis.html) - [Troubleshooting rippled](troubleshoot-the-rippled-server.html) - **References:** - [rippled API Reference](rippled-api.html) diff --git a/content/references/rippled-api/api-conventions/response-formatting.md b/content/references/rippled-api/api-conventions/response-formatting.md index b60d85a28a..a34f3520e8 100644 --- a/content/references/rippled-api/api-conventions/response-formatting.md +++ b/content/references/rippled-api/api-conventions/response-formatting.md @@ -128,7 +128,7 @@ Example warning: This warning indicates that the one or more [amendments](amendments.html) to the XRP Ledger protocol are scheduled to become enabled, but the current server does not have an implementation for those amendments. If those amendments become enabled, the current server will become [amendment blocked](amendments.html#amendment-blocked), so you should [upgrade to the latest `rippled` version](install-rippled.html) as soon as possible. -The server only sends this warning if the client is [connected as an admin](get-started-with-the-rippled-api.html#admin-access). +The server only sends this warning if the client is [connected as an admin](get-started-using-http-websocket-apis.html#admin-access). This warning includes a `details` field with the following fields: @@ -186,7 +186,7 @@ It is generally safe to ignore this warning. - [Amendments](amendments.html) - [Known Amendments](known-amendments.html) - **Tutorials:** - - [Get Started with XRP Ledger APIs](get-started-with-the-rippled-api.html) + - [Get Started with XRP Ledger APIs](get-started-using-http-websocket-apis.html) - [Install and Update `rippled`](install-rippled.html) - **References:** - [feature method][] diff --git a/content/tutorials/manage-account-settings/offline-account-setup.ja.md b/content/tutorials/manage-account-settings/offline-account-setup.ja.md index 9af32794d5..ca8dfd2c1f 100644 --- a/content/tutorials/manage-account-settings/offline-account-setup.ja.md +++ b/content/tutorials/manage-account-settings/offline-account-setup.ja.md @@ -14,7 +14,7 @@ blurb: 物理的に隔離されたオフラインのマシンを使用して暗 オフライン署名を使用するには、次の前提条件を満たしている必要があります。 - オフラインマシンとして使用する1台のコンピューターを用意していること。このマシンは[サポートされているオペレーティングシステム](system-requirements.html)でセットアップされている必要があります。オフラインセットアップの手順については、使用するオペレーティングシステムのサポートを参照してください（例: [Red Hat Enterprise Linux DVD ISOインストール手順](https://access.redhat.com/solutions/7227)）。使用するソフトウェアと物理メディアがマルウェアに感染していないことを確認します。 -- オンラインマシンとして使用する別のコンピューターを用意していること。このマシンは`rippled`を実行する必要はありませんが、XRP Ledgerネットワークに接続し、共有レジャーの状態についての正確な情報を受信できる必要があります。例えば、[公開サーバーへのWebSocket接続](get-started-with-the-rippled-api.html)を使用できます。 +- オンラインマシンとして使用する別のコンピューターを用意していること。このマシンは`rippled`を実行する必要はありませんが、XRP Ledgerネットワークに接続し、共有レジャーの状態についての正確な情報を受信できる必要があります。例えば、[公開サーバーへのWebSocket接続](get-started-using-http-websocket-apis.html)を使用できます。 - 署名済みのトランザクションバイナリデータをオフラインマシンからオンラインマシンに転送する安全な方法を用意していること。 - その方法の1つは、オフラインマシンでQRコードジェネレーターを使用し、オンラインマシンでQRコードスキャナーを使用することです。（この場合、「オンラインマシン」はスマートフォンなどの携帯デバイスだとよいでしょう。） - 別の方法としては、物理メディアを使ってオフラインマシンからオンラインマシンにファイルをコピーします。この方法を使用する場合、オフラインマシンが悪意のあるソフトウェアに感染するおそれのある物理メディアは使用しないよう注意します。（例えば、オンラインマシンとオフラインマシンで同じUSBドライブを再利用しないようにします。） diff --git a/content/tutorials/manage-account-settings/offline-account-setup.md b/content/tutorials/manage-account-settings/offline-account-setup.md index f9d3c17055..fb683bbd8f 100644 --- a/content/tutorials/manage-account-settings/offline-account-setup.md +++ b/content/tutorials/manage-account-settings/offline-account-setup.md @@ -14,7 +14,7 @@ A highly secure [signing configuration](set-up-secure-signing.html) involves kee To use offline signing, you must meet the following prerequisites: - You must have one computer to use as an offline machine. This machine must be set up with a [supported operating system](system-requirements.html). See your operating system's support for offline setup instructions. (For example, [Red Hat Enterprise Linux DVD ISO installation instructions](https://access.redhat.com/solutions/7227).) Be sure that the software and physical media you use are not infected with malware. -- You must have a separate computer to use as an online machine. This machine does not need to run `rippled` but it must be able to connect to the XRP Ledger network and receive accurate information about the state of the shared ledger. For example, you can use a [WebSocket connection to a public server](get-started-with-the-rippled-api.html). +- You must have a separate computer to use as an online machine. This machine does not need to run `rippled` but it must be able to connect to the XRP Ledger network and receive accurate information about the state of the shared ledger. For example, you can use a [WebSocket connection to a public server](get-started-using-http-websocket-apis.html). - You must have a secure way to transfer signed transaction binary data from the offline machine to the online machine. - One way to do this is with a QR code generator on the offline machine, and a QR code scanner on the online machine. (In this case, your "online machine" could be a handheld device such as a smartphone.) - Another way is to copy files from the offline machine to an online machine using physical media. If you use this method, be sure not to use physical media that could infect your offline machine with malicious software. (For example, do not reuse the same USB drive on both online and offline machines.) diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.ja.md b/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.ja.md index 73d5adc781..57339efeb8 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.ja.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.ja.md @@ -49,7 +49,7 @@ blurb: 指示による削除を使用して、新しい履歴ができたとき 2. サーバーに対してオンライン削除を指示する[can_deleteメソッド][]の実行をテストします。 - このコマンドの実行には[`rippled`コマンドラインインターフェイス](get-started-with-the-rippled-api.html#コマンドライン)を使用できます。例: + このコマンドの実行には[`rippled`コマンドラインインターフェイス](get-started-using-http-websocket-apis.html#コマンドライン)を使用できます。例: $ rippled --conf=/etc/opt/ripple/rippled.cfg can_delete now diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.md b/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.md index a55e5f5369..0c98083286 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.md @@ -49,7 +49,7 @@ To configure advisory deletion with a daily schedule, perform the following step 2. Test running the [can_delete method][] to prompt the server to run online deletion. - You can use the [`rippled` commandline interface](get-started-with-the-rippled-api.html#commandline) to run this command. For example: + You can use the [`rippled` commandline interface](get-started-using-http-websocket-apis.html#commandline) to run this command. For example: $ rippled --conf=/etc/opt/ripple/rippled.cfg can_delete now diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-amendment-voting.md b/content/tutorials/manage-the-rippled-server/configuration/configure-amendment-voting.md index a28893755c..f9cbf69698 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-amendment-voting.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-amendment-voting.md @@ -5,7 +5,7 @@ blurb: Set your server's votes on protocol amendments. --- # Configure Amendment Voting -Servers configured as validators can vote on [amendments](amendments.html) to the XRP Ledger protocol using the [feature method][]. (This method requires [admin access](get-started-with-the-rippled-api.html#admin-access).) +Servers configured as validators can vote on [amendments](amendments.html) to the XRP Ledger protocol using the [feature method][]. (This method requires [admin access](get-started-using-http-websocket-apis.html#admin-access).) For example, to vote against the "SHAMapV2" amendment, run the following command: diff --git a/content/tutorials/manage-the-rippled-server/configuration/enable-public-signing.ja.md b/content/tutorials/manage-the-rippled-server/configuration/enable-public-signing.ja.md index a72ed4cc12..6d25af7456 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/enable-public-signing.ja.md +++ b/content/tutorials/manage-the-rippled-server/configuration/enable-public-signing.ja.md @@ -7,7 +7,7 @@ blurb: 他の人があなたのサーバーを使ってトランザクション [新規: rippled 1.1.0][]デフォルトでは、`rippled`の署名メソッドは管理者接続に限定されています。v1.1.0以前のバージョンの`rippled`のように、署名メソッドをパブリックAPIメソッドとして使用できるようにするには、構成を変更することで、これを使用できるようにします。 -これにより、サーバーが「パブリック」[JSON-RPC接続およびWebSocket接続](get-started-with-the-rippled-api.html)を受け入れる場合は、これらのパブリック接続で以下のメソッドが使用できるようになります。 +これにより、サーバーが「パブリック」[JSON-RPC接続およびWebSocket接続](get-started-using-http-websocket-apis.html)を受け入れる場合は、これらのパブリック接続で以下のメソッドが使用できるようになります。 - [sign][signメソッド] - [sign_for][sign_forメソッド] diff --git a/content/tutorials/manage-the-rippled-server/configuration/enable-public-signing.md b/content/tutorials/manage-the-rippled-server/configuration/enable-public-signing.md index 9a9b76e615..abf5596a94 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/enable-public-signing.md +++ b/content/tutorials/manage-the-rippled-server/configuration/enable-public-signing.md @@ -7,7 +7,7 @@ blurb: Allow others to use your server to sign transactions. (Not recommended) By default, the signing methods for [`rippled`](the-rippled-server.html) are limited to [administrative connections](admin-rippled-methods.html). If you want to allow signing methods to be used as public API methods (like with versions of `rippled` before v1.1.0), you can enable it with a configuration change. [New in: rippled 1.1.0][] -This enables the following methods to be used on "public" [JSON-RPC and WebSocket connections](get-started-with-the-rippled-api.html), if your server accepts them: +This enables the following methods to be used on "public" [JSON-RPC and WebSocket connections](get-started-using-http-websocket-apis.html), if your server accepts them: - [sign][sign method] - [sign_for][sign_for method] @@ -41,7 +41,7 @@ To enable public signing, perform the following steps: - [Cryptographic Keys](cryptographic-keys.html) - **Tutorials:** - [Set Up Secure Signing](set-up-secure-signing.html) - - [Get Started with the rippled API](get-started-with-the-rippled-api.html) + - [Get Started with the rippled API](get-started-using-http-websocket-apis.html) - [Get Started with RippleAPI for JavaScript](get-started-with-rippleapi-for-javascript.html) - **References:** - [sign method][] diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.ja.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.ja.md index 80a49db5e9..0c030d9934 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.ja.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.ja.md @@ -181,7 +181,7 @@ blurb: macOSでrippledを自分でコンパイルします。 - [Ubuntu Linuxでrippledをインストール](install-rippled-on-ubuntu.html)（本番環境用の、Ubuntu上の事前構築済みバイナリーをインストール） - [rippledの構成](configure-rippled.html) - [rippledのトラブルシューティング](troubleshoot-the-rippled-server.html) - - [rippled APIの使用開始](get-started-with-the-rippled-api.html) + - [rippled APIの使用開始](get-started-using-http-websocket-apis.html) - **リファレンス:** - [rippled APIリファレンス](rippled-api.html) - [`rippled`コマンドラインの使用](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md index 4161ded4ac..b04b17e260 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md @@ -195,7 +195,7 @@ For information about `rippled` log messages, see [Understanding Log Messages](u - [Install rippled on Ubuntu Linux](install-rippled-on-ubuntu.html) - Install a pre-built binary on Ubuntu for production use - [Configure rippled](configure-rippled.html) - [Troubleshoot rippled](troubleshoot-the-rippled-server.html) - - [Get Started with the rippled API](get-started-with-the-rippled-api.html) + - [Get Started with the rippled API](get-started-using-http-websocket-apis.html) - **References:** - [rippled API Reference](rippled-api.html) - [`rippled` Commandline Usage](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.ja.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.ja.md index 322cc9dcbe..dba0bceb6c 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.ja.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.ja.md @@ -223,7 +223,7 @@ Watchdog: Launching child 1 - **チュートリアル:** - [rippledの構成](configure-rippled.html) - [rippledのトラブルシューティング](troubleshoot-the-rippled-server.html) - - [rippled APIの使用開始](get-started-with-the-rippled-api.html) + - [rippled APIの使用開始](get-started-using-http-websocket-apis.html) - **リファレンス:** - [rippled APIリファレンス](rippled-api.html) - [`rippled`コマンドラインの使用](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md index d534351f6a..5b46d8623f 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md @@ -222,7 +222,7 @@ Watchdog: Launching child 1 - **Tutorials:** - [Configure rippled](configure-rippled.html) - [Troubleshoot rippled](troubleshoot-the-rippled-server.html) - - [Get Started with the rippled API](get-started-with-the-rippled-api.html) + - [Get Started with the rippled API](get-started-using-http-websocket-apis.html) - **References:** - [rippled API Reference](rippled-api.html) - [`rippled` Commandline Usage](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.ja.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.ja.md index 05972647b5..b1a037f11b 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.ja.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.ja.md @@ -65,7 +65,7 @@ blurb: プリコンパイル済みのrippledバイナリーをCentOSまたはRed - **チュートリアル:** - [rippledの構成](configure-rippled.html) - [rippledのトラブルシューティング](troubleshoot-the-rippled-server.html) - - [rippled APIの使用開始](get-started-with-the-rippled-api.html) + - [rippled APIの使用開始](get-started-using-http-websocket-apis.html) - **リファレンス:** - [rippled APIリファレンス](rippled-api.html) - [`rippled`コマンドラインの使用](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md index 9e84284785..ebef1720df 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md @@ -102,7 +102,7 @@ Before you install `rippled`, you must meet the [System Requirements](system-req - **Tutorials:** - [Configure rippled](configure-rippled.html) - [Troubleshoot rippled](troubleshoot-the-rippled-server.html) - - [Get Started with the rippled API](get-started-with-the-rippled-api.html) + - [Get Started with the rippled API](get-started-using-http-websocket-apis.html) - **References:** - [rippled API Reference](rippled-api.html) - [`rippled` Commandline Usage](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.ja.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.ja.md index c915f66f46..898d293982 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.ja.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.ja.md @@ -96,7 +96,7 @@ blurb: プリコンパイル済みのrippledバイナリーをUbuntu Linuxにイ - **チュートリアル:** - [rippledの構成](configure-rippled.html) - [rippledのトラブルシューティング](troubleshoot-the-rippled-server.html) - - [rippled APIの使用開始](get-started-with-the-rippled-api.html) + - [rippled APIの使用開始](get-started-using-http-websocket-apis.html) - **リファレンス:** - [rippled APIリファレンス](rippled-api.html) - [`rippled`コマンドラインの使用](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md index 5d7ec05548..ebd7983a7a 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md @@ -98,7 +98,7 @@ Before you install `rippled`, you must meet the [System Requirements](system-req - **Tutorials:** - [Configure rippled](configure-rippled.html) - [Troubleshoot rippled](troubleshoot-the-rippled-server.html) - - [Get Started with the rippled API](get-started-with-the-rippled-api.html) + - [Get Started with the rippled API](get-started-using-http-websocket-apis.html) - **References:** - [rippled API Reference](rippled-api.html) - [`rippled` Commandline Usage](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.ja.md b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.ja.md index 88a2d50575..68fd58a069 100644 --- a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.ja.md +++ b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.ja.md @@ -98,7 +98,7 @@ Rippleの公式RPMリポジトリとそれを使用するための手順が変 - **チュートリアル:** - [Linuxでの自動更新](update-rippled-automatically-on-linux.html) - [rippledのトラブルシューティング](troubleshoot-the-rippled-server.html) - - [rippled APIの使用開始](get-started-with-the-rippled-api.html) + - [rippled APIの使用開始](get-started-using-http-websocket-apis.html) - **リファレンス:** - [rippled APIリファレンス](rippled-api.html) - [`rippled`コマンドラインの使用](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.md b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.md index 14eeb93039..e97f4bbb2d 100644 --- a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.md +++ b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.md @@ -98,7 +98,7 @@ The `rippled` v1.3 package includes an updated auto-update script that works on - **Tutorials:** - [Update Automatically on Linux](update-rippled-automatically-on-linux.html) - [Troubleshoot rippled](troubleshoot-the-rippled-server.html) - - [Get Started with the rippled API](get-started-with-the-rippled-api.html) + - [Get Started with the rippled API](get-started-using-http-websocket-apis.html) - **References:** - [rippled API Reference](rippled-api.html) - [`rippled` Commandline Usage](commandline-usage.html) diff --git a/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.ja.md b/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.ja.md index 8ccf0b70c1..21634c0241 100644 --- a/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.ja.md +++ b/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.ja.md @@ -153,7 +153,7 @@ Terminating thread doJob:AcquisitionDone: unhandled 11. `rippled`サービスが正常に起動したかどうかを確認します。 - [コマンドラインインターフェイス](get-started-with-the-rippled-api.html#コマンドライン)を使用してサーバーの状況を確認できます（サーバーがJSON-RPC要求を受け入れないように設定している場合を除く）。次に例を示します。 + [コマンドラインインターフェイス](get-started-using-http-websocket-apis.html#コマンドライン)を使用してサーバーの状況を確認できます（サーバーがJSON-RPC要求を受け入れないように設定している場合を除く）。次に例を示します。 /opt/ripple/bin/rippled server_info diff --git a/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.md b/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.md index de91b4758d..5485472348 100644 --- a/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.md +++ b/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.md @@ -153,7 +153,7 @@ To migrate your transaction database to a larger page size, perform the followin 11. Confirm that the `rippled` service started successfully. - You can use the [commandline interface](get-started-with-the-rippled-api.html#commandline) to check the server status (unless you have configured your server not to accept JSON-RPC requests). For example: + You can use the [commandline interface](get-started-using-http-websocket-apis.html#commandline) to check the server status (unless you have configured your server not to accept JSON-RPC requests). For example: /opt/ripple/bin/rippled server_info diff --git a/content/tutorials/manage-the-rippled-server/troubleshooting/understanding-log-messages.md b/content/tutorials/manage-the-rippled-server/troubleshooting/understanding-log-messages.md index fa9bcefa6f..61aa5b9e1f 100644 --- a/content/tutorials/manage-the-rippled-server/troubleshooting/understanding-log-messages.md +++ b/content/tutorials/manage-the-rippled-server/troubleshooting/understanding-log-messages.md @@ -126,7 +126,7 @@ The entry contains the IP address of the client that exceeded its rate limit, an If you see frequent messages from the same IP address, you may want to block those IP addresses from your network to reduce the load on your server's public API. (For example, you may be able to configure your firewall to block those IP addresses.) -To avoid being dropped by rate limiting on your own server, [connect as an admin](get-started-with-the-rippled-api.html#admin-access). +To avoid being dropped by rate limiting on your own server, [connect as an admin](get-started-using-http-websocket-apis.html#admin-access). ## InboundLedger 11 timeouts for ledger diff --git a/content/tutorials/production-readiness/set-up-secure-signing.ja.md b/content/tutorials/production-readiness/set-up-secure-signing.ja.md index c0b8176073..c2944603a8 100644 --- a/content/tutorials/production-readiness/set-up-secure-signing.ja.md +++ b/content/tutorials/production-readiness/set-up-secure-signing.ja.md @@ -45,7 +45,7 @@ blurb: 安全にトランザクションを送信できる環境を設定しま [構成ファイルの例](https://github.com/ripple/rippled/blob/8429dd67e60ba360da591bfa905b58a35638fda1/cfg/rippled-example.cfg#L1050-L1073)では、ローカルループバックネットワーク上（127.0.0.1）のポート5005でJSON-RPC（HTTP）、ポート6006でWebSocket（WS）の接続をリッスンし、接続されるすべてのクライアントを管理者として扱っています。 - **注意:** 署名に[コマンドラインAPI](request-formatting.html#コマンドライン形式)を使用する場合は、コマンドラインでないクライアントで[Websocket APIやJSON-RPC APIを使用](get-started-with-the-rippled-api.html)する場合よりもセキュリティが弱くなります。コマンドライン構文を使用すると、秘密鍵がシステムのプロセスリストで他のユーザーに見える可能性があり、シェル履歴にプレーンテキスト形式でキーが保存される可能性があります。 + **注意:** 署名に[コマンドラインAPI](request-formatting.html#コマンドライン形式)を使用する場合は、コマンドラインでないクライアントで[Websocket APIやJSON-RPC APIを使用](get-started-using-http-websocket-apis.html)する場合よりもセキュリティが弱くなります。コマンドライン構文を使用すると、秘密鍵がシステムのプロセスリストで他のユーザーに見える可能性があり、シェル履歴にプレーンテキスト形式でキーが保存される可能性があります。 3. サーバーの使用中は、稼働状態と最新状態を維持して、ネットワークと同期されるようにしておく必要があります。 diff --git a/content/tutorials/production-readiness/set-up-secure-signing.md b/content/tutorials/production-readiness/set-up-secure-signing.md index d9532e0ba8..af1d994513 100644 --- a/content/tutorials/production-readiness/set-up-secure-signing.md +++ b/content/tutorials/production-readiness/set-up-secure-signing.md @@ -43,7 +43,7 @@ In this configuration, you run `rippled` on the machine that generates the trans The [example config file](https://github.com/ripple/rippled/blob/8429dd67e60ba360da591bfa905b58a35638fda1/cfg/rippled-example.cfg#L1050-L1073) listens for connections on the local loopback network (127.0.0.1), with JSON-RPC (HTTP) on port 5005 and WebSocket (WS) on port 6006, and treats all connected clients as admin. - **Caution:** Using the [commandline API](request-formatting.html#commandline-format) for signatures is less secure than [using the Websocket or JSON-RPC APIs](get-started-with-the-rippled-api.html) through non-commandline clients. When using the commandline syntax, your secret key may be visible to other users in the system's process listing, and your shell history may save the key in plain text. + **Caution:** Using the [commandline API](request-formatting.html#commandline-format) for signatures is less secure than [using the Websocket or JSON-RPC APIs](get-started-using-http-websocket-apis.html) through non-commandline clients. When using the commandline syntax, your secret key may be visible to other users in the system's process listing, and your shell history may save the key in plain text. 3. Maintain the server to keep it running, updated, and in sync with the network while you're using it. diff --git a/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.ja.md b/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.ja.md index 02039e0eb0..f8bd9a9824 100644 --- a/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.ja.md +++ b/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.ja.md @@ -22,7 +22,7 @@ _[Checks Amendment][]が必要です。_ - CheckCancelトランザクションを送信する資金供給のあるアカウントの**アドレス**と**シークレットキー**。Checkが有効期限切れでない限り、このアドレスは、Checkの送金元または受取人のいずれかでなければなりません。 - トランザクションに安全に署名できる手段（[RippleAPI][]や各自の[`rippled`サーバー](install-rippled.html)など）。 - `rippled`サーバーに接続できるクライアントライブラリ（[RippleAPI][]、HTTPライブラリ、またはWebSocketライブラリなど）。 - - 詳細は、[`rippled` APIの使用開始](get-started-with-the-rippled-api.html)を参照してください。 + - 詳細は、[`rippled` APIの使用開始](get-started-using-http-websocket-apis.html)を参照してください。 ## {{cancel_n.next()}}.CheckCancelトランザクションの準備 diff --git a/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.md b/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.md index 11e9e31e06..33df11f39c 100644 --- a/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.md +++ b/content/tutorials/use-specialized-payment-types/use-checks/cancel-a-check.md @@ -22,7 +22,7 @@ To cancel a Check with this tutorial, you need the following: - The **address** and **secret key** of a funded account to send the CheckCancel transaction. This address must be either the sender or the recipient of the Check, unless the Check is expired. - A secure way to sign transactions, such as [RippleAPI][] or your own [`rippled` server](install-rippled.html). - A client library that can connect to a `rippled` server, such as [RippleAPI][] or any HTTP or WebSocket library. - - For more information, see [Get Started with the `rippled` API](get-started-with-the-rippled-api.html). + - For more information, see [Get Started with the `rippled` API](get-started-using-http-websocket-apis.html). ## {{cancel_n.next()}}. Prepare the CheckCancel transaction diff --git a/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.ja.md b/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.ja.md index 0d3a83a640..09b9cacce8 100644 --- a/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.ja.md +++ b/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.ja.md @@ -26,7 +26,7 @@ XRP Ledgerの外部でGrand PaymentsはBoxSend SGに請求書（IDは`46060241FA - Checkを受領する資金供給のあるアカウントの**アドレス**。 - トランザクションに安全に署名できる手段（[RippleAPI][]や各自の[`rippled`サーバー](install-rippled.html)など）。 - `rippled`サーバーに接続できるクライアントライブラリ（[RippleAPI][]、HTTPライブラリ、またはWebSocketライブラリなど）。 - - 詳細は、[`rippled` APIの使用開始](get-started-with-the-rippled-api.html)を参照してください。 + - 詳細は、[`rippled` APIの使用開始](get-started-using-http-websocket-apis.html)を参照してください。 ## {{send_n.next()}}.CheckCreateトランザクションの準備 diff --git a/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.md b/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.md index a710f02298..45922a084e 100644 --- a/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.md +++ b/content/tutorials/use-specialized-payment-types/use-checks/send-a-check.md @@ -26,7 +26,7 @@ To send a Check with this tutorial, you need the following: - The **address** of a funded account to receive the Check. - A secure way to sign transactions, such as [RippleAPI][] or your own [`rippled` server](install-rippled.html). - A client library that can connect to a `rippled` server, such as [RippleAPI][] or any HTTP or WebSocket library. - - For more information, see [Get Started with the `rippled` API](get-started-with-the-rippled-api.html). + - For more information, see [Get Started with the `rippled` API](get-started-using-http-websocket-apis.html). ## {{send_n.next()}}. Prepare the CheckCreate transaction diff --git a/dactyl-config.yml b/dactyl-config.yml index 3719531ad1..0535c440ef 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -164,6 +164,8 @@ targets: "transaction-cost.html#current-transaction-cost": "transaction-cost.html#現在のトランザクションコスト" "ledgers.html#open-closed-and-validated-ledgers": "ledgers.html#ツリーの形式" "account_info.html#response-format": "account_info.html#応答フォーマット" + # Fix link from untranslated public-servers.html: + "ledger-history.html#full-history": "ledger-history.html#すべての履歴" - name: xrp-api-only