Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.49 KB

README.md

File metadata and controls

35 lines (28 loc) · 1.49 KB

JS Base SDK For Kuknos Network Developement

This library is the lowest-level kukos helper library. It consists of classes to read, write, hash, and sign the xdr structures that are used in kuknos-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 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, JS SDK will fallback to the much slower implementation contained in tweetnacl.

If you are using JS SDK 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 npm to include kuknos-public-sdk-js in your own project:

npm install --save kuknos-public-sdk-js

License

kuknos-public-sdk-js is a modified version of js-stellar-base which is licensed under an Apache-2.0 license. See the LICENSE file for details.