JS Stellar Base
Warning! The Node version of this package uses the
sodium-nativepackage, 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-basewill fallback to the much slower implementation contained in
If you'd explicitly prefer not to install the
sodium-nativepackage, pass the appropriate flag to skip optional dependencies when installing this package (e.g.
If you are using
stellar-basein a browser you can ignore this. However, for production backend deployments you should most likely be using
sodium-nativeis successfully installed and working,
StellarBase.FastSigningvariable will be equal
true. Otherwise it will be
Using yarn to include js-stellar-base in your own project:
yarn add @stellar/stellar-base
For browsers, use Bower to install it. It exports a
StellarBase. The example below assumes you have
relative to your html file.
To use as a module in a Node.js project
- Install it using yarn:
yarn add @stellar/stellar-base
var StellarBase = require('@stellar/stellar-base');
To self host for use in the browser
- Install it using bower:
bower install stellar-base
- 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-base 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:
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-base itself
- Install Node 18.x
We support the oldest LTS release of Node, which is currently 18.x. Please likewise install and develop on Node 16 so you don't get surprised when your code works locally but breaks in CI.
If you work on several projects that use different Node versions, you might find helpful to install a NodeJS version manager:
- Install Yarn
This project uses Yarn to manages its dependencies. To install Yarn, follow the project instructions available at https://yarnpkg.com/en/docs/install.
- Clone the repo
git clone https://github.com/stellar/js-stellar-base.git
- Install dependencies inside js-stellar-base folder
- Observe the project's code style
While you're making changes, make sure to regularly run the linter to catch any linting errors (in addition to making sure your text editor supports ESLint)
as well as fixing any formatting errors with
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/. (Our npm library must support
earlier versions of Node, so the tests need to run on those versions.)
Updating XDR definitions
- Make sure you have Docker installed and running.
For information on how to use js-stellar-base, take a look at the docs in the docs folder.
To run all tests:
To run a specific set of tests:
Tests are also run automatically in Github Actions for every master commit and pull request.
Documentation for this repo lives inside the docs folder.
Please see the CONTRIBUTING.md for details on how to contribute to this project.
Publishing to npm
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease]
A new version will be published to npm and Bower by GitHub Actions.
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.