Wondering what’s next for npm?Check out our public roadmap! »

@kinecosystem/kin-base
TypeScript icon, indicating that this package has built-in type declarations

0.20.4 • Public • Published

js-kin-base

Build Status

Coverage Status

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

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

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

Quick start

Using npm to include js-kin-base in your own project:

npm install --save @kinecosystem/kin-base

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

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

Install

To use as a module in a Node.js project

  1. Install it using npm:
npm install --save @kinecosystem/kin-base
  1. require/import it in your JavaScript:
var KinBase = require('kin-base');

To self host for use in the browser

  1. Install it using bower:
bower install kin-base
  1. Include it in the browser:
<script src="./bower_components/kin-base/kin-base.js"></script>
<script>console.log(KinBase);</script> 

If you don't want to use install Bower, you can copy built JS files from the bower-js-kin-base repo.

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-kin-base itself

  1. Clone the repo
git clone https://github.com/kinecosystem/js-kin-base.git
  1. Install dependencies inside js-kin-base folder
cd js-kin-base
npm install

Usage

For information on how to use js-kin-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

Tests are also run on the Travis CI js-stellar-base project automatically.

Documentation

Documentation for this repo lives inside the docs folder.

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-kin-base is licensed under an Apache-2.0 license. See the LICENSE file for details.

Install

npm i @kinecosystem/kin-base

DownloadsWeekly Downloads

29

Version

0.20.4

License

Apache-2.0

Unpacked Size

2.15 MB

Total Files

131

Last publish

Collaborators

  • avatar