SKALE IMA-JS

IMA-JS is a Typescript/Javascript library which implements client for SKALE Interchain Messaging Agent (IMA).

ℹ️ IMA-JS v2 is based on ethers.js, while v1 was built on top of web3js

Installation

Node

npm install --save @skalenetwork/ima-js

Yarn

yarn add @skalenetwork/ima-js

Usage

Full usage documentation with examples can be found on our docs portal: https://docs.skale.network/ima/1.3.x/

Development

Git clone with submodules

git clone --recurse-submodules --remote-submodules https://github.com/skalenetwork/ima-js

IMA-SDK

Version 0.3.0 is compatible with ima-sdk 0.2.1

Testing

Check out GA test workflow in .github/workflows/test.yml to see all steps.

Deploy test tokens:

INSTALL_PACKAGES=True yarn deploy-tokens

Run tests:

yarn test

Linter

Used linter: https://palantir.github.io/tslint/

Install the global CLI and its peer dependency:

yarn global add tslint typescript

Linter git hook

Be sure to add pre-commit git hook:

echo 'yarn lint' > .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

License

All contributions are made under the GNU Lesser General Public License v3. See LICENSE.