caizchain-sdk v1.0.3

js-caizchain-sdk is a Javascript library for communicating with a Caizchain Caizconnect server. It is used for building Caizchain apps either on Node.js or in the browser.

It provides:

• a networking layer API for Caizconnect endpoints.
• facilities for building and signing transactions, for communicating with a Caizchain Caizconnect instance, and for submitting transactions or querying network history.

caizchain-sdk vs caizchain-base

caizchain-sdk is a high-level library that serves as client-side API for Caizconnect. caizchain-base is lower-level library for creating Caizchain primitive constructs via XDR helpers and wrappers.

Most people will want caizchain-sdk instead of caizchain-base. You should only use caizchain-base if you know what you're doing!

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

Important! The Node.js version of the caizchain-base (caizchain-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, caizchain-base (and caizchain-sdk) will fallback to using the tweetnacl package implementation.

If you are using caizchain-sdk/caizchain-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 CaizchainSdk.FastSigning variable will return true.

Quick start

Using npm to include js-caizchain-sdk in your own project:

npm install --save caizchain-sdk

Alternatively, you can use cdnjs in a browser:

<script src="https://cdnjs.cloudflare.com/ajax/libs/caizchain-sdk/{version}/caizchain-sdk.js"></script>

Install

To use as a module in a Node.js project

1. Install it using npm:

npm install --save caizchain-sdk

2. require/import it in your JavaScript:

var CaizchainSdk = require('caizchain-sdk');

To self host for use in the browser

1. Install it using bower:

bower install caizchain-sdk

2. Include it in the browser:

<script src="./bower_components/caizchain-sdk/caizchain-sdk.js"></script>
<script>
  console.log(CaizchainSdk);
</script>

If you don't want to use install Bower, you can copy built JS files from the bower-js-caizchain-sdk 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/caizchain-sdk/{version}/caizchain-sdk.js"></script>
<script>
  console.log(CaizchainSdk);
</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-caizchain-sdk itself

1. Clone the repo:

git clone https://git.caiz.com/caizcoin/caizchain-js-sdk.git

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

cd js-caizchain-sdk
npm install

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

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

nvm install

# if you've never installed 10.16.3 before you'll want to re-install yarn
npm install -g yarn

If you work on several projects that use different Node versions, you might it helpful to install this automatic version manager: https://github.com/wbyoung/avn

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

How to use with React-Native

1. Add the following postinstall script:

yarn rn-nodeify --install url,events,https,http,util,stream,crypto,vm,buffer --hack --yarn

2. yarn add -D rn-nodeify
3. Uncomment require('crypto') on shim.js
4. react-native link react-native-randombytes
5. Create file rn-cli.config.js

module.exports = {
  resolver: {
    extraNodeModules: require("node-libs-react-native"),
  },
};

6. Add import "./shim"; to the top of index.js
7. yarn add caizchain-sdk

There is also a sample that you can follow.

Usage

For information on how to use js-caizchain-sdk, take a look at the Developers site.

There is also API Documentation here.

Testing

To run all tests:

gulp test

To run a specific set of tests:

gulp test:node
gulp test:browser

To generate and check the documentation site:

# install the `serve` command if you don't have it already
npm install -g serve

# generate the docs files
npm run docs

# get these files working in a browser
cd jsdoc && serve .

# you'll be able to browse the docs at http://localhost:5000

Documentation

Documentation for this repo lives in Developers site.

Contributing

For information on how to contribute, please refer to our contribution guide.

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-caizchain-sdk is licensed under an --- license. See the LICENSE for details.