xahau.js

mirror of https://github.com/Xahau/xahau.js.git synced 2026-04-29 15:37:50 +00:00

Go to file

Stefan Thomas a003d261ea Log: New logging system.

Right now, all I've done is move the logging function from utils to its own
file. I've also refactored it and created some classes.

Next step would be to somehow get rid of the trace setting. The Remote class
should have nothing to do with logging settings. Perhaps we can keep the setting
for backwards compatibility only, but the main way to turn logging on/off or
filter logging messages should be through the Log class.

2014-02-27 23:38:45 -08:00

bench

Added a benchmark for Montgomery exponentiation.

2013-09-21 16:49:34 -07:00

bin

Fix usage in decode_binary.js

2014-01-22 12:49:36 +07:00

deploy

update deploy

2013-04-26 08:59:48 +02:00

docs

Docs: Add an example for request_book_offers

2013-09-28 07:56:27 -07:00

scripts

Add SHAMaps, metadata serialization and transaction hash calculation.

2013-11-07 22:36:06 -08:00

src

Log: New logging system.

2014-02-27 23:38:45 -08:00

test

Update serializedtypes-test.js

2014-02-15 09:31:59 +07:00

web_modules

Disable ripple-lib in Safari iOS < 5 and Safari Mac < 6.

2013-12-23 10:35:28 -08:00

.gitignore

JSBN and coverage tests cleanup.

2013-09-21 05:41:19 -07:00

.npmignore

Update npmignore

2013-09-24 13:02:35 -07:00

.travis.yml

add .travis.yml to silence e-mail notices

2013-11-04 17:26:50 -08:00

Gruntfile.js

Fix grunt watch. Enable caching, only compile debug version.

2014-01-25 11:25:21 -08:00

LICENSE

Update license

2014-01-07 03:14:07 -08:00

Makefile

JSBN and coverage tests cleanup.

2013-09-21 05:41:19 -07:00

package.json

Bump version

2014-02-20 15:49:13 -08:00

README.md

Remove a single space

2013-12-03 12:01:01 -08:00

README.md

#The Ripple JavaScript Library

ripple-lib connects to the Ripple network via the WebSocket protocol and runs in Node.js as well as in the browser.

Use ripple-lib for

Connecting to a local or remote rippled in JavaScript (Node.js or browser)
Issuing rippled API requests
Listening to events on the Ripple network (transaction, ledger, etc.)
Signing and submitting transactions to the Ripple network

###In this file:

###For additional documentation see:

###Also see:

##Getting ripple-lib

Via npm for Node.js

  $ npm install ripple-lib

Build from the source using grunt

  $ git clone https://github.com/ripple/ripple-lib
  $ npm install
  $ grunt

Then use the minified build/ripple-*-min.js in your webpage

##Quickstart

Remote (remote.js) is the module responsible for managing connections to rippled servers:

/* Loading ripple-lib with Node.js */
var Remote = require('ripple-lib').Remote;

/* Loading ripple-lib in a webpage */
// var Remote = ripple.Remote;

var remote = new Remote({
  // see the API Reference for available options
  trusted:        true,
  local_signing:  true,
  local_fee:      true,
  fee_cushion:     1.5,
  servers: [
    {
        host:    's1.ripple.com'
      , port:    443
      , secure:  true
    }
  ]
});

remote.connect(function() {
  /* remote connected */

  // see the API Reference for available functions
});

See The ripple-lib Guides and The ripple-lib API Reference for walkthroughs and details about all of the available functions and options.

##Running tests

Clone the repository
cd into the repository and install dependencies with npm install
npm test or make test or node_modules\.bin\mocha test\*-test.js

Generating code coverage

ripple-lib uses jscoverage to generate code coverage. To generate a file coverage.html, run make coverage