audaxjs-lib
Client-side Audax JavaScript library
Last updated a year ago by audax .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install audaxjs-lib 
SYNC missed versions from official npm registry.

AudaxJS (audaxjs-lib)

NPM

The pure JavaScript Audax library for node.js and browsers.

Features

  • Clean: Pure JavaScript, concise code, easy to read.
  • Compatible: Works on Node.js and all modern browsers.
  • Powerful: Support for advanced features, such as multi-sig, HD Wallets.
  • Secure: Strong random number generation, trusted developers.
  • Principled: No support for browsers with crap RNG (IE < 11)
  • Standardized: Node community coding style, Browserify, Node's stdlib and Buffers.
  • Fast: Optimized code, uses typed arrays instead of byte arrays for performance.
  • Experiment-friendly: Audax Mainnet and Testnet support.

Should I use this in production?

If you are thinking of using the master branch of this library in production, stop. Master is not stable; it is our development branch, and only tagged releases may be classified as stable.

Installation

npm install audaxjs-lib

Setup

Node.js

var audaxjs = require('audaxjs-lib')

Browser

If you're familiar with how to use browserify, ignore this and proceed normally. These steps are advisory only, and may not be suitable for your application.

Browserify is assumed to be installed for these steps.

For your project, create an index.js file

let audaxjs = require('audaxjs-lib')

// your code here
function myFunction () {
	return audaxjs.ECPair.makeRandom().toWIF()
}

module.exports = {
	myFunction
}

Now, to compile for the browser:

browserify index.js --standalone foo > app.js

You can now put <script src="app.js" /> in your web page, using foo.myFunction to create a new Audax private key.

NOTE: If you uglify the javascript, you must exclude the following variable names from being mangled: BigInteger, ECPair, Point. This is because of the function-name-duck-typing used in typeforce.

Example:

uglifyjs ... --mangle --reserved 'BigInteger,ECPair,Point'

NOTE: This library tracks Node LTS features, if you need strict ES5, use --transform babelify in conjunction with your browserify step (using an es2015 preset).

NOTE: If you expect this library to run on an iOS 10 device, ensure that you are using buffer@5.0.5 or greater.

Examples

The below examples are implemented as integration tests, they should be very easy to understand. Otherwise, pull requests are appreciated. Some examples interact (via HTTPS) with a 3rd Party Blockchain Provider (3PBP).

If you have a use case that you feel could be listed here, please ask for it!

Complementing Libraries

  • BIP21 - A BIP21 compatible URL encoding utility library
  • BIP38 - Passphrase-protected private keys
  • BIP39 - Mnemonic generation for deterministic keys
  • BIP32-Utils - A set of utilities for working with BIP32
  • BIP66 - Strict DER signature decoding
  • BIP69 - Lexicographical Indexing of Transaction Inputs and Outputs
  • Base58 - Base58 encoding/decoding
  • Base58 Check - Base58 check encoding/decoding
  • Bech32 - A BIP173 compliant Bech32 encoding library
  • coinselect - A fee-optimizing, transaction input selection module for audaxjs-lib.
  • merkle-lib - A performance conscious library for merkle root and tree calculations.
  • minimaldata - A module to check audaxjs policy: SCRIPT_VERIFY_MINIMALDATA

LICENSE MIT

Current Tags

  • 3.0.0                                ...           latest (a year ago)

1 Versions

  • 3.0.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (15)
Dev Dependencies (10)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |