ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: revised introductory material

Browse Source
This commit is contained in:
Rome Reginelli
2015-11-20 12:43:33 -08:00
committed by mDuo13
parent a271b9e816
commit ef2515507d
3 changed files with 62 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/index.md
View File

@@ -63,17 +63,26 @@
# Introduction # Introduction
RippleAPI allows you to query and submit transactions to a node on the Ripple network. RippleAPI is the official client library to the Ripple Consensus Ledger. Currently, RippleAPI is only available in JavaScript.
Using RippleAPI, you can:
* [Query transactions from the network](#gettransaction)
* [Sign](#sign) transactions securely without connecting to any server
* [Submit](#submit) transactions to the Ripple Consensus Ledger, including [Payments](#payment), [Orders](#order), [Settings changes](#settings), and [other types](#transaction-types)
* [Generate a new Ripple Address](#generateaddress)
* ... and [much more](#api-methods).
RippleAPI only provides access to *validated*, *immutable* transaction data. RippleAPI only provides access to *validated*, *immutable* transaction data.
## Boilerplate ## Boilerplate
Use the following [boilerplate code](https://en.wikipedia.org/wiki/Boilerplate_code) to wrap your custom code using RippleAPI.
```javascript ```javascript
const {RippleAPI} = require('ripple-lib'); const {RippleAPI} = require('ripple-lib');
const api = new RippleAPI({ const api = new RippleAPI({
servers: ['wss://s1.ripple.com'] servers: ['wss://s1.ripple.com'] //Public rippled server hosted by Ripple, Inc.
}); });
api.connect().then(() => { api.connect().then(() => {
/* insert code here */ /* insert code here */
@@ -82,26 +91,35 @@ api.connect().then(() => {
}).catch(console.error); }).catch(console.error);
``` ```
To get started, first install [nodejs](https://nodejs.org) version `0.12.0` or greater, then: RippleAPI is designed to work in [NodeJS](https://nodejs.org) (version `0.12.0` or greater) using [Babel](https://babeljs.io/) for [ECMAScript 6](https://babeljs.io/docs/learn-es2015/) support.
`npm install -g babel` The code samples in this documentation are written in ES6, but `RippleAPI` will work with ES5 also. Regardless of whether you use ES5 or ES6, the methods that return promises will return [ES6-style promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise_).
`npm install ripple-lib`
Then create a script based on the boilerplate shown here and run with:
`babel-node script.js`
The code samples in this documentation are written in ES6, but `RippleAPI` will work with ES5 also. Regardless of whether you use ES5 or ES6, the methods that return promises will return ES6-style promises.
<aside class="notice"> <aside class="notice">
All the code snippets in this documentation assume that you have surrounded them with this boilerplate. All the code snippets in this documentation assume that you have surrounded them with this boilerplate.
</aside> </aside>
<aside class="notice"> <aside class="notice">
Dont forget the "catch" or errors may not be visible. If you omit the "catch" section, errors may not be visible.
</aside> </aside>
### Installation ###
1. Install [NodeJS](https://nodejs.org) and the Node Package Manager (npm). Most Linux distros have a package for NodeJS, but make sure you have version `0.12.0` or higher.
2. Use npm to install [Babel](https://babeljs.io/) globally:
npm install -g babel
3. Use npm to install RippleAPI:
npm install ripple-lib
After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using babel-node:
babel-node script.js
<aside class="notice">
Instead of using babel-node in production, we recommend using Babel to transpile to ECMAScript 5 first.
</aside>
# Basic Types # Basic Types
## Ripple Address ## Ripple Address

35
docs/src/boilerplate.md.ejs
View File

@@ -1,10 +1,12 @@
## Boilerplate ## Boilerplate
Use the following [boilerplate code](https://en.wikipedia.org/wiki/Boilerplate_code) to wrap your custom code using RippleAPI.
```javascript ```javascript
const {RippleAPI} = require('ripple-lib'); const {RippleAPI} = require('ripple-lib');
const api = new RippleAPI({ const api = new RippleAPI({
servers: ['wss://s1.ripple.com'] servers: ['wss://s1.ripple.com'] //Public rippled server hosted by Ripple, Inc.
}); });
api.connect().then(() => { api.connect().then(() => {
/* insert code here */ /* insert code here */
@@ -13,22 +15,31 @@ api.connect().then(() => {
}).catch(console.error); }).catch(console.error);
``` ```
To get started, first install [nodejs](https://nodejs.org) version `0.12.0` or greater, then: RippleAPI is designed to work in [NodeJS](https://nodejs.org) (version `0.12.0` or greater) using [Babel](https://babeljs.io/) for [ECMAScript 6](https://babeljs.io/docs/learn-es2015/) support.
`npm install -g babel` The code samples in this documentation are written in ES6, but `RippleAPI` will work with ES5 also. Regardless of whether you use ES5 or ES6, the methods that return promises will return [ES6-style promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise_).
`npm install ripple-lib`
Then create a script based on the boilerplate shown here and run with:
`babel-node script.js`
The code samples in this documentation are written in ES6, but `RippleAPI` will work with ES5 also. Regardless of whether you use ES5 or ES6, the methods that return promises will return ES6-style promises.
<aside class="notice"> <aside class="notice">
All the code snippets in this documentation assume that you have surrounded them with this boilerplate. All the code snippets in this documentation assume that you have surrounded them with this boilerplate.
</aside> </aside>
<aside class="notice"> <aside class="notice">
Dont forget the "catch" or errors may not be visible. If you omit the "catch" section, errors may not be visible.
</aside> </aside>
### Installation ###
1. Install [NodeJS](https://nodejs.org) and the Node Package Manager (npm). Most Linux distros have a package for NodeJS, but make sure you have version `0.12.0` or higher.
2. Use npm to install [Babel](https://babeljs.io/) globally:
npm install -g babel
3. Use npm to install RippleAPI:
npm install ripple-lib
After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using babel-node:
babel-node script.js
<aside class="notice">
Instead of using babel-node in production, we recommend using Babel to transpile to ECMAScript 5 first.
</aside>

9
docs/src/introduction.md.ejs
View File

@@ -1,5 +1,12 @@
# Introduction # Introduction
RippleAPI allows you to query and submit transactions to a node on the Ripple network. RippleAPI is the official client library to the Ripple Consensus Ledger. Currently, RippleAPI is only available in JavaScript.
Using RippleAPI, you can:
* [Query transactions from the network](#gettransaction)
* [Sign](#sign) transactions securely without connecting to any server
* [Submit](#submit) transactions to the Ripple Consensus Ledger, including [Payments](#payment), [Orders](#order), [Settings changes](#settings), and [other types](#transaction-types)
* [Generate a new Ripple Address](#generateaddress)
* ... and [much more](#api-methods).
RippleAPI only provides access to *validated*, *immutable* transaction data. RippleAPI only provides access to *validated*, *immutable* transaction data.