@axerunners/axecore-lib
    TypeScript icon, indicating that this package has built-in type declarations

    0.18.13 • Public • Published

    Axecore Library

    Build Status NPM Package

    A pure and powerful JavaScript Axe library.

    Axe is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Axe network allows for highly resilient Axe infrastructure, and the developer community needs reliable, open-source tools to implement Axe apps and services.

    Table of Contents

    Install

    NodeJS

    npm install @axerunners/axecore-lib
    

    Browser

    See the section below to generate your own bundle, or download the pre-generated minified file

    Building the Browser Bundle

    To build a axecore-lib full bundle for the browser:

    npm run build

    This will generate files named axecore-lib.js and axecore-lib.min.js in the dist/ folder.

    Usage

    Browser

    <script src='./dist/axecore-lib.min.js' type="text/javascript"></script>
    <script>
      const PrivateKey = axecore.PrivateKey;
      const privateKey = new PrivateKey();
      const address = privateKey.toAddress().toString();
    </script>
    

    Modules

    Some functionality is implemented as a module that can be installed separately:

    Development & Tests

    git clone https://github.com/axerunners/axecore-lib
    cd axecore-lib
    npm install

    Run all the tests:

    npm test

    You can also run just the Node.js tests with npm run test:node, just the browser tests with npm run test:browser or run a test coverage report with npm run coverage.

    Documentation

    Examples

    Some examples can be found here, below is a list of direct links for some of them.

    Contributing

    Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our CONTRIBUTING file.

    License

    Code released under the MIT license.

    Copyright 2013-2017 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.
    Copyright 2016-2017 The Axe Foundation, Inc.
    Copyright 2017-2018 Axe Core Group, Inc.

    Install

    npm i @axerunners/axecore-lib

    DownloadsWeekly Downloads

    45

    Version

    0.18.13

    License

    MIT

    Unpacked Size

    3.74 MB

    Total Files

    268

    Last publish

    Collaborators

    • charlie137
    • ddude1