stellar-base

JS Stellar Base

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.

Quick start

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

npm install --save stellar-base

For browsers, use the webpacked version in the dist folder. 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

Node.js prerequisite

Node.js version 0.10 is required. If you don't have version 0.10, use nvm to easily switch between versions.

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 use in the browser

1. Save the stellar-base.js or stellar-base.min.js accessible to your html file
2. Include it in the browser:

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

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:

./node_modules/.bin/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.

License

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