js-stellar-sdk is a client-side Stellar Javascript library for communicating with a Stellar Horizon server. It is used for building Stellar apps either on Node.js or in the browser.
It provides:
- a networking layer API for Horizon endpoints.
- facilities for building and signing transactions, for communicating with a Stellar Horizon instance, and for submitting transactions or querying network history.
js-stellar-sdk is a high-level library that serves as client side API for Horizon. This library makes extensive use of the lower-level js-stellar-base and exposes js-stellar-base classes via its export object. js-stellar-base can be used as a standalone library for creating Stellar primitive constructs via XDR helpers and wrappers. js-stellar-base doesn't depend on connecting to Horizon.
js-stellar-sdk exposes all js-stellar-base classes so you don't have to install js-stellar-base along js-stellar-sdk.
Using npm to include js-stellar-sdk in your own project:
npm install --save stellar-sdk
For browsers, use Bower to install js-stellar-sdk. It exports a
variable StellarSdk
. The example below assumes you have stellar-sdk.js
relative to your html file.
<script src="stellar-sdk.js"></script>
<script>console.log(StellarSdk);</script>
- Install it using npm:
npm install --save stellar-sdk
- require/import it in your JavaScript:
var StellarSdk = require('stellar-sdk');
- Install it using bower:
bower install stellar-sdk
- Include it in the browser:
<script src="./bower_components/stellar-sdk/stellar-sdk.js"></script>
<script>console.log(StellarSdk);</script>
Note that, if you don't want to use Bower, you can also copy built JS files from bower-js-stellar-sdk repo.
- Clone the repo:
git clone https://github.com/stellar/js-stellar-sdk.git
- Install dependencies inside js-stellar-sdk folder:
cd js-stellar-sdk
npm install
For information on how to use js-stellar-sdk, take a look at the Developers site.
There is also API Documentation here.
To run all tests:
gulp test
To run a specific set of tests:
gulp test:node
gulp test:browser
Documentation for this repo lives in Developers site.
For information on how to contribute, please refer to our contribution guide.
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-sdk is licensed under an Apache-2.0 license. See the LICENSE file for details.