stellar-base

JS Stellar Base

The stellar-base library is the lowest-level stellar helper library. It consists of classes to read, write, hash, and sign the xdr structures that are used in stellar-core. This is an implementation in JavaScript that can be used on either Node.js or web browsers.

• API Reference

Warning! Node version of this package is using sodium-native package, 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 will fallback to the much slower implementation contained in tweetnacl.

If you are using stellar-base in a browser you can ignore this. However, for production backend deployments you should definitely be using sodium-native. If sodium-native is successfully installed and working StellarBase.FastSigning variable will be equal true. Otherwise it will be false.

Quick start

Using yarn to include js-stellar-base in your own project:

yarn add stellar-base

For browsers, use Bower to install it. It exports a variable StellarBase. The example below assumes you have stellar-base.js relative to your html file.

<script src="stellar-base.js"></script>
<script>
  console.log(StellarBase);
</script>

Install

To use as a module in a Node.js project

1. Install it using yarn:

yarn add stellar-base

1. require/import it in your JavaScript:

var StellarBase = require('stellar-base');

To self host for use in the browser

1. Install it using bower:

bower install stellar-base

1. Include it in the browser:

<script src="./bower_components/stellar-base/stellar-base.js"></script>
<script>
  console.log(StellarBase);
</script>

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

1. 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-base/{version}/stellar-base.js"></script>
<script>
  console.log(StellarBase);
</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-base itself

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.

If you work on several projects that use different Node versions, you might find helpful to install a nodejs version manager.

• https://github.com/creationix/nvm
• https://github.com/wbyoung/avn
• https://github.com/asdf-vm/asdf

1. 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.

1. Clone the repo

git clone https://github.com/stellar/js-stellar-base.git

1. Install dependencies inside js-stellar-base folder

cd js-stellar-base
yarn

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.)

Updating XDR definitions

1. Make sure you have Ruby installed. You can either use a global installation, or use a version manager.

• https://www.ruby-lang.org/en/downloads/
• https://github.com/rbenv/rbenv
• https://rvm.io
• https://github.com/asdf-vm/asdf

1. Install Bundler.
2. Install all dependencies.
3. Copy xdr files from https://github.com/stellar/stellar-core/tree/master/src/xdr to ./xdr.
4. Run yarn xdr from the js-stellar-base folder.
5. Transform the newly-generated JS into TypeScript using dts-xdr:

To "scriptify" the above instructions, here are the steps one by one:

git clone https://github.com/stellar/js-stellar-base
cd js-stellar-base
bundle install
yarn
yarn xdr

# If src/generated/stellar-xdr_generated.js changed, then:
git clone https://github.com/stellar/dts-xdr
cd dts-xdr
npm install
OUT=stellar-xdr_generated.d.ts npx jscodeshift -t src/transform.js ../src/generated/stellar-xdr_generated.js
cp stellar-xdr_generated.d.ts ../types/xdr.d.ts
cd .. && rm -rf dts-xdr
yarn run prettier --write types/xdr.d.ts

Usage

For information on how to use js-stellar-base, take a look at the docs in the docs folder.

Testing

To run all tests:

gulp test

To run a specific set of tests:

gulp test:node
gulp test:browser

You can also run yarn test for a simpler subset of the test cases.

Tests are also run automatically in Github Actions for every master commit and pull request.

Documentation

Documentation for this repo lives inside the docs folder.

Contributing

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 Travis CI.

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

License

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

Changelog

v7.0.0

This release introduces unconditional support for muxed accounts (#485).

Breaking Changes

In v5.2.0, we introduced opt-in support for muxed accounts, where you would need to explicitly pass a true flag if you wanted to interpret muxed account objects as muxed addresses (in the form M..., see SEP-23). We stated that this would become the default in the future. That is now the case.

The following fields will now always support muxed properties:

• FeeBumpTransaction.feeSource
• Transaction.sourceAccount
• Operation.sourceAccount
• Payment.destination
• PathPaymentStrictReceive.destination
• PathPaymentStrictSend.destination
• AccountMerge.destination
• Clawback.from

The following functions had a withMuxing parameter removed:

• Operation.fromXDRObject
• Transaction.constructor
• FeeBumpTransaction.constructor
• TransactionBuilder.fromXDR
• TransactionBuilder.buildFeeBumpTransaction

The following functions will no longer check the opts object for a withMuxing field:

• TransactionBuilder.constructor
• Operation.setSourceAccount

There are several other breaking changes:

• TransactionBuilder.enableMuxedAccounts() is removed
• decodeAddressToMuxedAccount() and encodeMuxedAccountToAddress() no longer accept a second boolean parameter
• Account.createSubaccount() and MuxedAccount.createSubaccount() are removed (#487). You should prefer to create them manually:

  let mux1 = new MuxedAccount(someAccount, '1');

  // before:
  let mux2 = mux1.createSubaccount('2');

  // now:
  let mux2 = new MuxedAccount(mux1.baseAccount(), '2');

• Introduced a new helper method to help convert from muxed account addresses to their underlying Stellar addresses (#485):

function extractBaseAddess(address: string): string;

• The following muxed account validation functions are now available from Typescript (#483):

namespace StrKey {
  function encodeMed25519PublicKey(data: Buffer): string;
  function decodeMed25519PublicKey(data: string): Buffer;
  function isValidMed25519PublicKey(publicKey: string): boolean;
}

function decodeAddressToMuxedAccount(address: string, supportMuxing: boolean): xdr.MuxedAccount;
function encodeMuxedAccountToAddress(account: xdr.MuxedAccount, supportMuxing: boolean): string;
function encodeMuxedAccount(gAddress: string, id: string): xdr.MuxedAccount;

• Added a helper function Transaction.getClaimableBalanceId(int) which lets you pre-determine the hex claimable balance ID of a createClaimableBalance operation prior to submission to the network (#482).

Fix

• Add Buffer as a parameter type option for the Keypair constructor in Typescript (#484).