Add sample API usage for getting balances and making a payment

This commit is contained in:
Chris Clark
2015-07-23 15:51:15 -07:00
parent a05cb39ab0
commit e48df2c1fd
3 changed files with 53 additions and 0 deletions

3
docs/samples/README Normal file
View File

@@ -0,0 +1,3 @@
Usage:
babel-node balances.js
babel-node payment.js (requires setting address and secret in source file first)

12
docs/samples/balances.js Normal file
View File

@@ -0,0 +1,12 @@
'use strict';
const RippleAPI = require('../../src').RippleAPI; // require('ripple-lib')
const api = new RippleAPI({servers: ['wss://s1.ripple.com:443']});
const address = 'r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV';
api.connect(() => {
api.getBalances(address, {}, (error, balances) => {
console.log(JSON.stringify(balances, null, 2));
process.exit();
});
});

38
docs/samples/payment.js Normal file
View File

@@ -0,0 +1,38 @@
'use strict';
const RippleAPI = require('../../src').RippleAPI; // require('ripple-lib')
const address = 'ENTER ADDRESS HERE';
const secret = 'ENTER SECRET HERE';
const api = new RippleAPI({servers: ['wss://s1.ripple.com:443']});
const instructions = {maxLedgerVersionOffset: 5};
const payment = {
source: {
address: address,
amount: {
value: '0.01',
currency: 'XRP'
}
},
destination: {
address: 'rKmBGxocj9Abgy25J51Mk1iqFzW9aVF9Tc',
amount: {
value: '0.01',
currency: 'XRP'
}
}
};
api.connect(() => {
console.log('Connected...');
api.preparePayment(address, payment, instructions, (error, txJSON) => {
console.log('Payment transaction prepared...');
const signedTransaction = api.sign(txJSON, secret).signedTransaction;
console.log('Payment transaction signed...');
api.submit(signedTransaction, (submitError, response) => {
console.log(submitError ? submitError : response);
process.exit(submitError ? 1 : 0);
});
});
});