SignumJS
  • 👋Welcome to SignumJS
  • Getting Started
    • Installation
    • Modules
    • Usage
  • 👩‍💻Reference
    • API Reference
      • Core Module
      • Util Module
      • Crypto Module
      • Http Module
      • Contracts Module
      • Monitor Module
  • 🧾Recipes
    • Basics
      • Getting Accounts Balance
      • List Transactions
      • Show attached messages
      • Send Signa
    • Advanced
Powered by GitBook
On this page
  1. Getting Started

Modules

PreviousInstallationNextUsage

Last updated 3 years ago

SignumJS is maintained in a and splitted in several modules.

  • The main module providing an extense API for blockchain interaction

  • The module especifically relevant for smart contracts

  • The cryptographic functions

  • This is the tool belt around SignumJS providing most useful functions, e.g. conversions

  • A thin Http wrapper, with consistent response types, and exception handling. It wraps the famous library.

  • A module providing a class to execute recurring async operations with de/serialization feature, good for listening to blockchain transactions. This is still experimental and the only one that is not used by @signumjs/core.

Install packages

The installation of the packages always follows the same pattern

npm i @signumjs/core
npm i @signumjs/contracts
npm i @signumjs/crypto
npm i @signumjs/util
npm i @signumjs/http
npm i @signumjs/monitor

yarn add @signumjs/core
yarn add @signumjs/contracts
yarn add @signumjs/crypto
yarn add @signumjs/util
yarn add @signumjs/http
yarn add @signumjs/monitor
<script src='https://cdn.jsdelivr.net/npm/@signumjs/core/dist/signumjs.min.js'></script>
<script src='https://cdn.jsdelivr.net/npm/@signumjs/contracts/dist/signumjs.contracts.min.js'></script>
<script src='https://cdn.jsdelivr.net/npm/@signumjs/crypto/dist/signumjs.crypto.min.js'></script>
<script src='https://cdn.jsdelivr.net/npm/@signumjs/http/dist/signumjs.http.min.js'></script>
<script src='https://cdn.jsdelivr.net/npm/@signumjs/util/dist/signumjs.util.min.js'></script>
<script src='https://cdn.jsdelivr.net/npm/@signumjs/monitor/dist/signumjs.monitor.min.js'></script>
monorepo
@signumjs/core
@signumjs/contracts
@signumjs/crypto
@signumjs/util
@signumjs/http
axios
@signumjs/monitor
The available modules and their dependencies in relation to @signumjs/core