stellar
Creating equitable access to the global financial system
js-stellar-sdk
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.
Warning! Node version of
stellar-base(stellar-sdkdependency) package is usinged25519package, a native implementation of Ed25519 in Node.js, as an optional dependency. This means that if for any reason installation of this package fails,stellar-base(andstellar-sdk) will fallback to the much slower implementation contained intweetnacl.If you are using
stellar-sdk/stellar-basein a browser you can ignore this. However, for production backend deployments you should definitely be usinged25519. Ifed25519is successfully installed and workingStellarSdk.FastSigningvariable will be equaltrue. Otherwise it will befalse.
Quick start
Using npm to include js-stellar-sdk in your own project:
npm install --save stellar-sdkAlternatively, you can use jsDelivr or cdnjs in a browser
<script src="https://cdn.jsdelivr.net/npm/stellar-sdk@latest/lib/index.min.js"></script>
`Install
To use as a module in a Node.js project
- Install it using npm:
npm install --save stellar-sdk- require/import it in your JavaScript:
var StellarSdk = require('stellar-sdk');Help! I'm having trouble installing the SDK on Windows
Unfortunately, the Stellar platform development team mostly works on OS X and Linux, and so sometimes bugs creep through that are specific to windows. When installing stellar-sdk on windows, you might see an error that looks similar to the following:
error MSB8020: The build tools for v120 (Platform Toolset = 'v120 ') cannot be found. To build using the v120 build tools, please install v120 build tools. Alternatively, you may upgrade to the current Visual Studio tools by selecting the Project menu or right-click the solution, and then selecting "Retarget solution"To resolve this issue, you should upgrade your version of nodejs, node-gyp and
then re-attempt to install the offending package using
npm install -g --msvs_version=2015 ed25519. Afterwards, retry installing
stellar-sdk as normal.
If you encounter the error: "failed to find C:\OpenSSL-Win64", You need to install OpenSSL. More information about this issue can be found here.
In the event the above does not work, please join us on our community slack to get help resolving your issue.
To self host for use in the browser
- 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>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
- Instruct the browser to fetch the library from cdnjs, a 3rd party service that hosts js libraries:
<script src="https://cdnjs.cloudflare.com/ajax/libs/stellar-sdk/{version}/stellar-sdk.js"></script>
<script>
console.log(StellarSdk);
</script>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
- 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- 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 yarnIf 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
- 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
- Add the following postinstall script:
yarn rn-nodeify --install url,events,https,http,util,stream,crypto,vm,buffer --hack --yarn yarn add -D rn-nodeify- Uncomment
require('crypto')on shim.js react-native link react-native-randombytes- Create file
rn-cli.config.jsmodule.exports = { resolver: { extraNodeModules: require("node-libs-react-native"), }, }; - Add
import "./shim";to the top ofindex.js 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 testTo run a specific set of tests:
gulp test:node
gulp test:browserTo 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:5000Documentation
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 [<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.
License
js-stellar-sdk is licensed under an Apache-2.0 license. See the LICENSE file for details.