ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-22 04:35:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

IA: add links for tutorials

Browse Source 
IA: more tutorial links

IA: Tutorials stuff

- Move 'Cancel or Skip a Transaction' to 'About Canceling a Transaction'
  (Fixes #582)
- Add more 'See Also' links to Escrow & Payment Channel tutorials
This commit is contained in:
mDuo13
2019-09-03 14:39:28 -07:00
parent faff49afbd
commit d972643b6e
46 changed files with 774 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
content/tutorials/get-started/get-started-with-rippleapi-for-javascript.md
View File

@@ -1,4 +1,4 @@
# RippleAPI Beginners Guide
# Get Started with RippleAPI for JavaScript
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.
@@ -327,3 +327,16 @@ To use this example, you must first [build a browser-compatible version of Rippl
```
This demo HTML loads Lodash v4.17.11 from CDNJS on Cloudflare and then loads ripple-lib v1.1.2, but you could also download and load a variant of Lodash locally. <!--#{ no specific recommended or required version at this time. Update this once we have some guidance to provide here. }#-->
## See Also
- **Concepts:**
- [XRP Ledger Overview](xrp-ledger-overview.html)
- [Software Ecosystem](software-ecosystem.html)
- **Tutorials:**
- [Send XRP](send-xrp.html)
- **References:**
- [RippleAPI Reference](rippleapi-reference.html)
- [rippled API Conventions](api-conventions.html)
- [base58 Encodings](base58-encodings.html)
- [rippled Transaction Formats](transaction-formats.html)

19
content/tutorials/get-started/get-started-with-the-rippled-api.md
View File

@@ -6,6 +6,7 @@ Alternatively, you can [run your own local copy of `rippled`](install-rippled.ht
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.
## 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).
@@ -84,6 +85,7 @@ rippled --conf=/etc/rippled.cfg server_info
The commandline puts the command after any normal (dash-prefaced) commandline options, followed by a limited set of parameters, separated by spaces. For any parameter values that might contain spaces or other unusual characters, use single-quotes to encapsulate them.
## Example Request
<!-- MULTICODE_BLOCK_START -->
@@ -124,6 +126,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated true
<!-- MULTICODE_BLOCK_END -->
## Response Formatting
### Example Successful Response
@@ -176,6 +179,7 @@ HTTP Status: 200 OK
}
}
```
*Commandline*
```
@@ -211,4 +215,19 @@ The fields of a successful response include:
| `result` | Object | The result of the query; contents vary depending on the command. |
### Commandline
The response format for commandline methods is the same as JSON-RPC responses, because they use the same interface.
## See Also
- **Concepts:**
- [XRP Ledger Overview](xrp-ledger-overview.html)
- [Software Ecosystem](software-ecosystem.html)
- [Parallel Networks](parallel-networks.html)
- **Tutorials:**
- [Get Started with RippleAPI for JavaScript](get-started-with-rippleapi-for-javascript.html)
- [Reliable Transaction Submission](reliable-transaction-submission.html)
- [Manage the rippled Server](manage-the-rippled-server.html)
- **References:**
- [rippled API Reference](rippled-api.html)
- [Ripple Data API v2](data-api.html)

17
content/tutorials/get-started/look-up-transaction-results.md
View File

@@ -1,10 +1,10 @@
# Look Up Transaction Results
To use the XRP Ledger effectively, you need to be able to understand transaction outcomes: did the transaction succeed? What did it accomplish? If it failed, why?
To use the XRP Ledger effectively, you need to be able to understand [transaction](transaction-basics.html) outcomes: did the transaction succeed? What did it accomplish? If it failed, why?
The XRP Ledger is a shared system, with all data recorded publicly and carefully, securely updated with each new [ledger version](ledgers.html). Anyone can look up the exact outcome of any transaction and read the [transaction metadata](transaction-metadata.html) to see what it did.
This document describes, at a low level, how to know why a transaction reached the outcome it did. For an end-user, it is easier to look at a processed view of a transaction. For example, you can [use XRP Charts to get an English-language description of any recorded transaction](https://xrpcharts.ripple.com/#/transactions/).
This document describes, at a low level, how to know why a transaction reached the outcome it did. For an end-user, it is easier to look at a processed view of a transaction. For example, you can [use XRP Charts to get an English-language description of any recorded transaction](https://xrpcharts.ripple.com/#/transactions/).
## Prerequisites
@@ -427,9 +427,16 @@ Most other transactions create a specific type of ledger entry and [adjust the s
## See Also
- [Ledger Object Types Reference](ledger-object-types.html) - All possible fields of all types of ledger objects
- [Transaction Metadata](transaction-metadata.html) - Summary of the metadata format and fields that appear in metadata
- [Finality of Results](finality-of-results.html) - How to know when a transaction's success or failure is final. (Short version: if a transaction is in a validated ledger, its outcome and metadata are final.)
- **Concepts:**
- [Finality of Results](finality-of-results.html) - How to know when a transaction's success or failure is final. (Short version: if a transaction is in a validated ledger, its outcome and metadata are final.)
- **Tutorials:**
- [Reliable Transaction Submission](reliable-transaction-submission.html)
- [Monitor Incoming Payments with WebSocket](monitor-incoming-payments-with-websocket.html)
- **References:**
- [Ledger Object Types Reference](ledger-object-types.html) - All possible fields of all types of ledger objects
- [Transaction Metadata](transaction-metadata.html) - Summary of the metadata format and fields that appear in metadata
- [Transaction Results](transaction-results.html) - Tables of all possible result codes for transactions.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}

16
content/tutorials/get-started/monitor-incoming-payments-with-websocket.md
View File

@@ -1,10 +1,10 @@
# Monitor Incoming Payments with WebSocket
This tutorial shows how to monitor for incoming payments using the [WebSocket `rippled` API](rippled-api.html). Since all XRP Ledger transactions are public, anyone can monitor incoming payments to any address.
This tutorial shows how to monitor for incoming [payments](payment-types.html) using the [WebSocket `rippled` API](rippled-api.html). Since all XRP Ledger transactions are public, anyone can monitor incoming payments to any address.
WebSocket follows a model where the client and server establish one connection, then send messages both ways through the same connection, which remains open until explicitly closed (or until the connection fails). This is in contrast to the HTTP-based API model (including JSON-RPC and RESTful APIs), where the client opens and closes a new connection for each request.[¹](#footnote-1)<a id="from-footnote-1"></a>
**Tip:** The examples in this page use JavaScript so that the examples can run natively in a web browser. If you are developing in JavaScript, you can also use the [RippleAPI library for JavaScript](https://xrpl.org/rippleapi-reference.html) to simplify some tasks. This tutorial shows how to monitor for transactions _without_ using RippleAPI so that you can translate the steps to other programming languages that don't have RippleAPI.
**Tip:** The examples in this page use JavaScript so that the examples can run natively in a web browser. If you are developing in JavaScript, you can also use the [RippleAPI library for JavaScript](rippleapi-reference.html) to simplify some tasks. This tutorial shows how to monitor for transactions _without_ using RippleAPI so that you can translate the steps to other programming languages that don't have RippleAPI.
## Prerequisites
@@ -580,6 +580,18 @@ func main() {
[1.](#from-footnote-1) <a id="footnote-1"></a> In practice, when calling an HTTP-based API multiple times, the client and server may reuse the same connection for several requests and responses. This practice is called [HTTP persistent connection, or keep-alive](https://en.wikipedia.org/wiki/HTTP_persistent_connection). From a development standpoint, the code to use an HTTP-based API is the same regardless of whether the underlying connection is new or reused.
## See Also
- **Concepts:**
- [Transaction Basics](transaction-basics.html)
- [Finality of Results](finality-of-results.html) - How to know when a transaction's success or failure is final. (Short version: if a transaction is in a validated ledger, its outcome and metadata are final.)
- **Tutorials:**
- [Reliable Transaction Submission](reliable-transaction-submission.html)
- [Look Up Transaction Results](look-up-transaction-results.html)
- **References:**
- [Transaction Types](transaction-types.html)
- [Transaction Metadata](transaction-metadata.html) - Summary of the metadata format and fields that appear in metadata
- [Transaction Results](transaction-results.html) - Tables of all possible result codes for transactions.
<!--{# common link defs #}-->

18
content/tutorials/get-started/set-up-secure-signing.md
View File

@@ -1,6 +1,6 @@
# Set Up Secure Signing
To submit transactions to the XRP Ledger, you need a way to digitally sign them without compromising the security of your secret keys. (If others gain access to your secret keys, they have as much control over your accounts as you do, and can steal or destroy all your money.) This page summarizes how to set up such an environment so you can sign transactions securely.
To submit [transactions](transaction-basics.html) to the XRP Ledger, you need a way to digitally sign them without compromising the security of your [secret keys](cryptographic-keys.html). (If others gain access to your secret keys, they have as much control over your accounts as you do, and can steal or destroy all your money.) This page summarizes how to set up such an environment so you can sign transactions securely.
**Tip:** If you are not submitting transactions to the network, you can safely use a trustworthy public server, such as the ones run by Ripple, to monitor for incoming transactions or just to read other network activity. All transactions, balances, and data in the XRP Ledger are public.
@@ -103,6 +103,22 @@ This configuration uses a `rippled` server hosted remotely, such as in a colocat
To use this configuration, follow the steps for [running `rippled` on a private LAN](#run-rippled-on-the-same-lan), but use a VPN to connect to the LAN of the remote `rippled` server. Instructions for setting up the VPN are specific to your environment and are not described in this guide.
## See Also
- **Concepts:**
- [Cryptographic Keys](cryptographic-keys.html)
- [Multi-Signing](multi-signing.html)
- **Tutorials:**
- [Install rippled](install-rippled.html)
- [Assign a Regular Key Pair](assign-a-regular-key-pair.html)
- [Reliable Transaction Submission](reliable-transaction-submission.html)
- [Enable Public Signing](enable-public-signing.html)
- **References:**
- [sign method][]
- [submit method][]
- [RippleAPI Reference](rippleapi-reference.html)
<!--{# common link defs #}-->