Need help with js-stellar-sdk?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

stellar
460 Stars 235 Forks Apache License 2.0 748 Commits 32 Opened issues

Description

Main Stellar client library for the Javascript language

Services available

!
?

Need anything else?

Contributors list

Stellar
Creating equitable access to the global financial system

js-stellar-sdk

Build Status Coverage Status

js-stellar-sdk is a 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.

stellar-sdk vs stellar-base

stellar-sdk is a high-level library that serves as client-side API for Horizon. stellar-base is lower-level library for creating Stellar primitive constructs via XDR helpers and wrappers.

Most people will want stellar-sdk instead of stellar-base. You should only use stellar-base if you know what you're doing!

If you add

stellar-sdk
to a project, do not add
stellar-base
!
Mis-matching versions could cause weird, hard-to-find bugs.
stellar-sdk
automatically installs
stellar-base
and exposes all of its exports in case you need them.

Important! The Node.js version of the

stellar-base
(
stellar-sdk
dependency) package uses the
sodium-native
package as an optional dependency.
sodium-native
is a low level binding to libsodium, (an implementation of Ed25519 signatures). If installation of
sodium-native
fails, or it is unavailable,
stellar-base
(and
stellar-sdk
) will fallback to using the
tweetnacl
package implementation.

If you are using

stellar-sdk
/
stellar-base
in a browser you can ignore this. However, for production backend deployments you should be using
sodium-native
. If
sodium-native
is successfully installed and working the
StellarSdk.FastSigning
variable will return
true
.

Quick start

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

npm install --save stellar-sdk

Alternatively, you can use cdnjs in a browser:


Install

To use as a module in a Node.js project

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

To self host for use in the browser

  1. Install it using bower:
bower install stellar-sdk
  1. Include it in the browser:

If you don't want to use install Bower, you can copy built JS files from the bower-js-stellar-sdk 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:

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-sdk itself

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

Because we support earlier versions of Node, please install and develop on Node 10.16.3 so you don't get surprised when your code works locally but breaks in CI.

Here's out to install

nvm
if you haven't: https://github.com/creationix/nvm
nvm install

if you've never installed 10.16.3 before you'll want to re-install yarn

npm install -g yarn

If you work on several projects that use different Node versions, you might it helpful to install this automatic version manager: https://github.com/wbyoung/avn

  1. Observe the project's code style

While you're making changes, make sure to run the linter-watcher to catch any linting errors (in addition to making sure your text editor supports ESLint)

node_modules/.bin/gulp watch

If you're working on a file not in

src
, limit your code to Node 6.16 ES! See what's supported here: https://node.green/ (The reason is that our npm library must support earlier versions of Node, so the tests need to run on those versions.)

How to use with React-Native

  1. Add the following postinstall script:
    yarn rn-nodeify --install url,events,https,http,util,stream,crypto,vm,buffer --hack --yarn
    
  2. yarn add -D rn-nodeify
  3. Uncomment
    require('crypto')
    on shim.js
  4. react-native link react-native-randombytes
  5. Create file
    rn-cli.config.js
    module.exports = {
    resolver: {
    extraNodeModules: require("node-libs-react-native"),
    },
    };
    
  6. Add
    import "./shim";
    to the top of
    index.js
  7. yarn add stellar-sdk

There is also a sample that you can follow.

Usage

For information on how to use js-stellar-sdk, take a look at the Developers site.

There is also API Documentation here.

Testing

To run all tests:

gulp test

To run a specific set of tests:

gulp test:node
gulp test:browser

To generate and check the documentation site:

# install the `serve` command if you don't have it already
npm install -g serve

generate the docs files

npm run docs

get these files working in a browser

cd jsdoc && serve .

you'll be able to browse the docs at http://localhost:5000

Documentation

Documentation for this repo lives in Developers site.

Contributing

For information on how to contribute, please refer to our contribution guide.

Publishing to npm

npm version [ | 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-sdk is licensed under an Apache-2.0 license. See the LICENSE file for details.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.