atbcoinjs-lib
Client-side atbcoin JavaScript library
Last updated 3 years ago by segwit .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install atbcoinjs-lib 
SYNC missed versions from official npm registry.

ATBCoinJS (atbcoinjs-lib)

The pure JavaScript ATBCoin library for node.js and browsers. Used by over a million wallet users and the backbone for almost all ATBCoin web wallets in production today.

Installation

npm install atbcoinjs-lib

Setup

Node.js

var atbcoin = require('atbcoinjs-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 necessary for your application.

Browserify is assumed to be installed for these steps.

From your repository, create an index.js file

module.exports = {
  base58: require('bs58'),
  atbcoin: require('atbcoinjs-lib'),
  ecurve: require('ecurve'),
  BigInteger: require('bigi')
}

Install each of the above packages locally

npm install bs58 atbcoinjs-lib ecurve bigi

After installation, use browserify to compile index.js for use in the browser:

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

You will now be able to use <script src="app.js" /> in your browser, with each of the above exports accessible via the global foo object (or whatever you chose for the --standalone parameter above).

NOTE: See our package.json for the currently supported version of browserify used by this repository.

NOTE: When uglifying the javascript, you must exclude the following variable names from being mangled: Array, BigInteger, Boolean, ECPair, Function, Number, Point and Script. This is because of the function-name-duck-typing used in typeforce. Example:

uglifyjs ... --mangle --reserved 'Array,BigInteger,Boolean,ECPair,Function,Number,Point'

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

Typescript or VSCode users

Type declarations for Typescript are available for version ^3.0.0 of the library.

npm install @types/atbcoinjs-lib

You can now use atbcoinjs-lib as a typescript compliant library.

import { HDNode, Transaction } from 'atbcoinjs-lib'

For VSCode (and other editors), users are advised to install the type declarations, as Intellisense uses that information to help you code (autocompletion, static analysis).

Report any typescript related bugs at @dlebrecht DefinitelyTyped fork, submit PRs to DefinitelyTyped

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!

Contributing

We are always accepting of pull requests, but we do adhere to specific standards in regards to coding style, test driven development and commit messages.

Please make your best effort to adhere to these when contributing to save on trivial corrections.

Running the test suite

npm test
npm run-script coverage

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 atbcoinjs-lib.
  • merkle-lib - A performance conscious library for merkle root and tree calculations.
  • minimaldata - A module to check atbcoin policy: SCRIPT_VERIFY_MINIMALDATA

LICENSE MIT

Current Tags

  • 3.1.3                                ...           latest (3 years ago)

1 Versions

  • 3.1.3                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 0
Dependencies (15)
Dev Dependencies (12)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |