README.md

SKALE.js | The SKALE Network SDK

A community run project designed to offer abstraction over the core SKALE network smart contracts.

Installation

# Install Individual Components
npm add @skaleproject/<component-name>

# The umbrella package
npm add @skaleproject/skale.js

Available Packages on NPM

The following are all of the SKALE.js packages available

Package Name	NPM Tag
@skaleproject/constants
@skaleproject/skale.js
@skaleproject/config-controller
@skaleproject/etherbase
@skaleproject/context
@skaleproject/marionette
@skaleproject/multisig-wallet
@skaleproject/ima
@skaleproject/pow
@skaleproject/pow-ethers
@skaleproject/pow-web3
@skaleproject/utils

Contribution

If you are interested in making contributions to this project you should should checkout the GitHub Issues. help wanted and good first issue are two tags you can filter by to find things to work on.

To start, fork the project, and checkout a new branch. Branch names should be in kebab-case and should start with one of the following:

• bug

  For bug fixes (Example: bug-fix-something)

• configuration

  For updates to the core configuration of the package suite (Example: configuration-update-esm)

• docs

  For new or updates to documentation (Example: docs-add-pow-functions)

• feature

  For new features (Example: feature-new-utility)

• package

  For new package creation (Example: package-skale-manager)

• test

  For adding or updating tests ONLY (Example: test-complete-pow)

---

Security & Liability

SKALE.js and all of its sub-packages and connected packages are WITHOUT ANY WARRANTY; without even the implied warranty for any user commerical or otherwise. The creators and contributors of this package may not be held liable for any damages, losses, issues, or problems caused resulting in the use of this package for any reason.

**EXPERIMENTAL NOTICE**
This package is under heavy development. Use at your own risk.

License

All contributions are made under the MIT License (including all sub projects). See License