Skip to content

Latest commit

 

History

History
69 lines (52 loc) · 4.68 KB

README.md

File metadata and controls

69 lines (52 loc) · 4.68 KB

SKALE.js | The SKALE Network SDK

Code Coverage Twitter "Buy Me A Coffee"

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 npm (tag)
@skaleproject/skale.js npm (tag)
@skaleproject/config-controller npm (tag)
@skaleproject/etherbase npm (tag)
@skaleproject/context npm (tag)
@skaleproject/marionette npm (tag)
@skaleproject/multisig-wallet npm (tag)
@skaleproject/ima npm (tag)
@skaleproject/pow npm (tag)
@skaleproject/pow-ethers npm (tag)
@skaleproject/pow-web3 npm (tag)
@skaleproject/utils npm (tag)

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