arm-sdk

js-arm-sdk

js-arm-sdk is a Javascript library for communicating with a ARM Network. 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-arm-sdk vs js-stellar-base

js-arm-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-arm-sdk exposes all js-stellar-base classes so you don't have to install js-stellar-base along js-arm-sdk.

Quick start

Using npm to include js-arm-sdk in your own project:

npm install --save arm-sdk

Install

To use as a module in a Node.js project

1. Install it using npm:

npm install --save arm-sdk

1. require/import it in your JavaScript:

var ArmSdk = require('arm-sdk');

To develop and test js-arm-sdk itself

1. Clone the repo:

git clone https://github.com/armnetwork/js-arm-sdk.git

1. Install dependencies inside js-arm-sdk folder:

cd js-arm-sdk
npm install

Testing

To run all tests:

gulp test

To run a specific set of tests:

gulp test:node
gulp test:browser

Documentation

Documentation for this repo lives in Developers site.

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

License

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