ripple-wallet-generator/README.md

A node.js library for generating a Ripple wallet.

## Ripple Wallet

This is a simple, lightweight tool to generate a new ripple wallet,
which consists of public and secret key components.

Beyond portability, the tool was created to isolate the cryptography
behind wallet generation in the ripple client and ripple-lib.

### Usage

  ```js
  var rippleLib = require('ripple-lib');
  var RippleWallet = require('ripple-wallet')({
    sjcl: rippleLib.sjcl
  });

  RippleWallet.generate();
  ```
    
will generate a random, unfunded Ripple address and secret.

  ```js
  { 
    address: 'r3sBHwjwAb6eFpHbCEbJmhC8scmDeqXZyZ',
    secret: 'snovmDoPbb5Y14JVA5wxtBtPgHNaP' 
  }
  ```

### Tests

Run the automated test suite, which uses test vectors from the wiki:

    npm test

### Algorithm Docs and Test Vectors

A description of the Cryptography can be found on the [Wiki](https://ripple.com/wiki/Account_Family).