npm.io
0.0.5 • Published 7 years ago

xrp-provider

Licence
ISC
Version
0.0.5
Deps
5
Size
14 kB
Vulns
0
Weekly
0

Ripple provider

Makes it easy to work with a ripple wallet.

Install

npm i --save xrp-provider

Include

var RippleProvider = require("xrp-provider").default;

or for ES-2015

import RippleProvider from 'xrp-provider'

Initialize

const rippleProvider = new RippleProvider('testnet'); // or mainnet

Usage

Create private key
const privateKey = rippleProvider.createPrivateKey();
Create private key from mnemonic
const privateKey = rippleProvider.createPrivateKeyFromMnemonic(mnemonic);

let mnemonic = 'absurd green cannon quarter call spray upper diet defense convince live assist'
or 
let mnemonic = rippleProvider.generateMnemonic()
Create private key secret
const privateKey = rippleProvider.createPrivateKeyFromSecret(secret);

let secret = rippleProvider.generateSecret()
Create public key
const publicKey = rippleProvider.createPublicKey(privateKey);
Create address
const address = rippleProvider.getAddress(publicKey);
Create address from secret
const address = rippleProvider.getAddressFromSecret(secret);
Get balance
const balance = rippleProvider.getBalance(address);
Create transaction using key pair
rippleProvider.sendXrp(publicKey, addressTo, amount, privateKey).then(transaction=>{
    console.log(transaction);
});
publicKey - your public key 
addressTo - address of the recipient
amount - amount in xrp
privateKey - your private key
Create transaction using secret
rippleProvider.sendXrpUsingSecret(addressTo, amount, secret).then(transaction=>{
    console.log(transaction);
});
addressTo - address of the recipient
amount - amount in xrp
secret - your secret

Keywords