Namely, Pickled Meatballs

    js-kinesis-base

    0.9.0 • Public • Published

    JS Stellar Base

    Build Status Code Climate Coverage Status Dependency Status

    The stellar-base library is the lowest-level stellar helper library. It consists of classes to read, write, hash, and sign the xdr structures that are used in stellar-core. This is an implementation in JavaScript that can be used on either Node.js or web browsers.

    Warning! Node version of this package is using ed25519 package, a native implementation of Ed25519 in Node.js, as an optional dependency. This means that if for any reason installation of this package fails, stellar-base will fallback to the much slower implementation contained in tweetnacl.

    If you are using stellar-base in a browser you can ignore this. However, for production backend deployments you should definitely be using ed25519. If ed25519 is successfully installed and working StellarBase.FastSigning variable will be equal true. Otherwise it will be false.

    Quick start

    Using npm to include js-stellar-base in your own project:

    npm install --save stellar-base

    For browsers, use Bower to install it. It exports a variable StellarBase. The example below assumes you have stellar-base.js relative to your html file.

    <script src="stellar-base.js"></script>
    <script>console.log(StellarBase);</script> 

    Install

    To use as a module in a Node.js project

    1. Install it using npm:
    npm install --save stellar-base
    1. require/import it in your JavaScript:
    var StellarBase = require('stellar-base');

    To self host for use in the browser

    1. Install it using bower:
    bower install stellar-base
    1. Include it in the browser:
    <script src="./bower_components/stellar-base/stellar-base.js"></script>
    <script>console.log(StellarBase);</script> 

    If you don't want to use install Bower, you can copy built JS files from the bower-js-stellar-base repo.

    To use the cdnjs hosted script in the browser

    1. Instruct the browser to fetch the library from cdnjs, a 3rd party service that hosts js libraries:
    <script src="https://cdnjs.cloudflare.com/ajax/libs/stellar-base/{version}/stellar-base.js"></script>
    <script>console.log(StellarBase);</script> 

    Note that this method relies using a third party to host the JS library. This may not be entirely secure.

    Make sure that you are using the latest version number. They can be found on the releases page in Github.

    To develop and test js-stellar-base itself

    1. Clone the repo
    git clone https://github.com/stellar/js-stellar-base.git
    1. Install dependencies inside js-stellar-base folder
    cd js-stellar-base
    npm install

    Usage

    For information on how to use js-stellar-base, take a look at the docs in the docs folder.

    Testing

    To run all tests:

    gulp test

    To run a specific set of tests:

    gulp test:node
    gulp test:browser

    Tests are also run on the Travis CI js-stellar-base project automatically.

    Documentation

    Documentation for this repo lives inside the docs folder.

    Contributing

    Please see the CONTRIBUTING.md for details on how to contribute to this project.

    Publishing to npm

    npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease]
    

    A new version will be published to npm and Bower by Travis CI.

    npm >=2.13.0 required. Read more about npm version.

    License

    js-stellar-base is licensed under an Apache-2.0 license. See the LICENSE file for details.

    Keywords

    Install

    npm i js-kinesis-base

    DownloadsWeekly Downloads

    179

    Version

    0.9.0

    License

    Apache-2.0

    Unpacked Size

    2.32 MB

    Total Files

    90

    Last publish

    Collaborators

    • kinesisit