# xrp-provider

> makes it easy to work with a ripple wallet

Latest version **0.0.5** (published 2018-09-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install xrp-provider
pnpm add xrp-provider
yarn add xrp-provider
bun add xrp-provider
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2018-09-21 |
| First published | 2018-09-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 13.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | vlad88vlad |
| Maintainers | vlad88vlad |
| Keywords | xrp, ripple, provider, ripple provider, ripple wallet, wallet |

## Links

- npm: https://www.npmjs.com/package/xrp-provider
- Repository: https://github.com/rescrypto/xrp-provider
- Homepage: https://github.com/rescrypto/xrp-provider#readme
- Issues: https://github.com/rescrypto/xrp-provider/issues
- npm.io page: https://npm.io/package/xrp-provider

## Dependencies (5)

- [bip39](https://npm.io/package/bip39.md) ^2.5.0
- [ripplelib](https://npm.io/package/ripplelib.md) ^1.2.5
- [ripple-lib](https://npm.io/package/ripple-lib.md) ^1.0.0-beta.3
- [ripple-bip32](https://npm.io/package/ripple-bip32.md) 0.0.3
- [ripple-keypairs](https://npm.io/package/ripple-keypairs.md) ^0.10.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2018-09-21
- 0.0.4 — 2018-09-18
- 0.0.3 — 2018-09-10
- 0.0.2 — 2018-09-06
- 0.0.1 — 2018-09-06

## README

## Ripple provider ##

Makes it easy to work with a ripple wallet.

## Install ##
``` bash
npm i --save xrp-provider
```
## Include ##
```
var RippleProvider = require("xrp-provider").default;
```
or for ES-2015
```
import RippleProvider from 'xrp-provider'
```

## Initialize ##
```javascript
const rippleProvider = new RippleProvider('testnet'); // or mainnet
```
## Usage ##

#### Create private key ####
```javascript
const privateKey = rippleProvider.createPrivateKey();
```

#### Create private key from mnemonic ####
```javascript
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 ####
```javascript
const privateKey = rippleProvider.createPrivateKeyFromSecret(secret);

let secret = rippleProvider.generateSecret()

```
#### Create public key ####
```javascript
const publicKey = rippleProvider.createPublicKey(privateKey);
```
#### Create address ####
```javascript
const address = rippleProvider.getAddress(publicKey);
```
#### Create address from secret ####
```javascript
const address = rippleProvider.getAddressFromSecret(secret);
```
#### Get balance ####
```javascript
const balance = rippleProvider.getBalance(address);
```
#### Create transaction using key pair ####
```javascript
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 ####
```javascript
rippleProvider.sendXrpUsingSecret(addressTo, amount, secret).then(transaction=>{
    console.log(transaction);
});
```

```
addressTo - address of the recipient
amount - amount in xrp
secret - your secret
```

---
_Source: https://npm.io/package/xrp-provider · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._