@skalenetwork/skale.js NPM

Javascript API for SKALE manager

This is SKALE internal library which used SKALE manager

Installation

Requirements

- Node.js v8

- npm

Node

npm install @skalenetwork/skale.js

Usage

const skale = require('@skalenetwork/skale.js');

console.log(skale);
> {
    init: ... ,
    ...
    w3: {...},
    w3events: {...},
    helper: {...},
    rand: ... ,
    Listener: ... 
}

Examples

Examples can be found at the examples folder

Documentation

Documentation can be found here

Testing (mocha)

To run tests locally you need change the name .env_example to .env and save with yours environment variables:

IP: ip of test geth
PORT: port of test geth
ETH_ACCOUNT: test account address
ETH_PRIVATE_KEY: test account privatekey

Then:

npm run test

If you do not want to save them to a file, you can run tests like this:

env IP='IP' PORT='PORT' ETH_ACCOUNT='ETH_ACCOUNT' 
ETH_PRIVATE_KEY='ETH_PRIVATE_KEY' npm test

Lint

Conforming to linting rules is a prerequisite to commit to skale.js.

npm run lint

Contributing

Build

# build patch version
npm run build-patch

# build minor version
npm run build-minor

# build major version
npm run build-major

Build publish

npm publish

If you have any questions please ask our development community on Discord.

Versioning

The version format for this repo is {major}.{minor}.{patch} for stable, and {major}.{minor}.{patch}-{stage}.{devnum} for unstable (stage can be alpha or beta).

For more details see: https://semver.org/