JS Stellar Base
Warning! Node version of this package is using
ed25519package, 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 are using
stellar-basein a browser you can ignore this. However, for production backend deployments you should definitely be using
ed25519is successfully installed and working
StellarBase.FastSigningvariable will be equal
true. Otherwise it will be
Quick startUsing npm to include js-stellar-base in your own project:
npm install --save stellar-base
For browsers, use Bower to install it. It exports a variable
StellarBase. The example below assumes you have
stellar-base.jsrelative to your html file.
<script src="stellar-base.js"></script> <script>console.log(StellarBase);</script>
To use as a module in a Node.js project
- Install it using npm:
```shell npm install --save stellar-base ```
```js var StellarBase = require('stellar-base'); ```
To self host for use in the browser
- Install it using bower:
```shell 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
- Clone the repo
```shell git clone https://github.com/stellar/js-stellar-base.git ```
- Install dependencies inside js-stellar-base folder
```shell cd js-stellar-base npm install ```
UsageFor information on how to use js-stellar-base, take a look at the docs in the docs folder.
TestingTo run all tests:
To run a specific set of tests:
gulp test:node gulp test:browser
Tests are also run on the Travis CI js-stellar-base project automatically.
DocumentationDocumentation for this repo lives inside the docs folder.
ContributingPlease see the CONTRIBUTING.md for details on how to contribute to this project.
Publishing to npm
A new version will be published to npm and Bower by Travis CI.
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease]
npm >=2.13.0 required. Read more about npm version.