Creating equitable access to the global financial system

@abx/js-kinesis-sdk

@abx/js-kinesis-sdk is a Javascript library for communicating with a
Stellar Horizon server.
It is used for building Stellar apps either on Node.js or in the browser.

It provides:

- a networking layer API for Horizon endpoints.
- facilities for building and signing transactions, for communicating with a
Stellar Horizon instance, and for submitting transactions or querying network
history.

$3

@abx/js-kinesis-sdk is a high-level library that serves as client-side API for Horizon.
@abx/js-kinesis-base is lower-level
library for creating Stellar primitive constructs via XDR helpers and wrappers.

Most people will want @abx/js-kinesis-sdk instead of @abx/js-kinesis-base. You should only
use stellar-base if you know what you're doing!

If you add stellar-sdk to a project, do not add stellar-base! Mis-matching
versions could cause weird, hard-to-find bugs. stellar-sdk automatically
installs stellar-base and exposes all of its exports in case you need them.

> Important! The Node.js version of the @abx/js-kinesis-base (@abx/js-kinesis-sdk dependency) package
> uses the sodium-native package as
> an optional dependency. sodium-native is
> a low level binding to libsodium,
> (an implementation of Ed25519 signatures).
> If installation of sodium-native fails, or it is unavailable, stellar-base (and stellar-sdk) will
> fallback to using the tweetnacl package implementation.
>
> If you are using @abx/js-kinesis-sdk/@abx/js-kinesis-base in a browser you can ignore
> this. However, for production backend deployments you should be
> using sodium-native. If sodium-native is successfully installed and working the
> StellarSdk.FastSigning variable will return true.

Installation

$3

Using npm or yarn to include @abx/js-kinesis-sdk in your own project

``shell
npm install --save @abx/js-kinesis-sdk


or

`shell
git clone https://github.com/bullioncapital/js-kinesis-sdk.git
`

2. Install dependencies inside js-stellar-sdk folder:

`shell
cd js-kinesis-sdk
yarn
`

3. Install Node 18

Because we support the latest maintenance version of Node, please install and develop on Node 18 so you don't get surprised when your code works locally but breaks in CI.

Here's how to install nvm if you haven't: https://github.com/creationix/nvm

`shell
nvm install

if you've never installed 18 before you'll want to re-install yarn

`shell
yarn fmt
`

Testing

To run all tests:

`shell
yarn test
`

To run a specific set of tests:

`shell
yarn test:node
yarn test:browser
yarn test:integration
`

To generate and check the documentation site:

`shell


install the serve command if you don't have it already

- Update package.json` version
- Publish new release via GitHub release

License

@abx/js-stellar-sdk is licensed under an Apache-2.0 license. See the
LICENSE file
for details.