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.
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>
Node.js version 0.10 is required. If you don't have version 0.10, use nvm to easily switch between versions.
- Install it using npm:
npm install --save stellar-base
- require/import it in your JavaScript:
var StellarBase = require('stellar-base');
- Install it using bower:
bower install stellar-base
- Include it in the browser:
<script src="./bower_components/stellar-base/stellar-base.js"></script>
<script>console.log(StellarBase);</script>
Note that you can also copy built JS files from bower-js-stellar-base repo if you don't want to use Bower.
- Clone the repo
git clone https://github.com/stellar/js-stellar-base.git
- Install dependencies inside js-stellar-base folder
cd js-stellar-base
npm install
For information on how to use js-stellar-base, take a look at the docs in the docs folder.
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 for this repo lives inside the docs folder.
Please see the CONTRIBUTING.md for details on how to contribute to this project.
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.
js-stellar-base is licensed under an Apache-2.0 license. See the LICENSE file for details.