Table of Contents

1. Overview
2. Getting started
3. Modules
4. Runtime Environment

Overview

The repository contains QURAS Light Wallet's JS SDK for the QURAS blockchain platform.

It is currently in use by QURAS.

Visit the docs to learn how to use this library.

Getting started

Installation

Install the package using:

npm i quras-js

Build

npm run build:dev

Tests

npm run test

Docs

The docs are stores in quras.io while the main website and its configuration is in ./website.

cd website
npm install
npm run start

Typescript

The typescript declaration files are included (no need of any @types/...).

Future Features

"basic_sendasset" "basic_claimgas" "basic_createscript" "basic_invoke" "basic_privnet" "adv_multitx" "adv_apicore"

Modules

api

The api module contains code that interfaces with external APIs as well as providing a high level abstraction.

wallet

The wallet module deals with key manipulating as well as importing and exporting of wallet files.

tx

The tx module deals with transaction creation, serialization and deserialization.

sc

The sc module deals with smart contract script construction. It is used primarily to construct scripts that can be carried by InvocationTransaction.

rpc

The rpc module deals with the RPC interface exposed by the QURAS node.

u

The u module is the utilities module containing methods handling the various data transformation aspects within QURAS.

CONST

The CONST module is a collection of constants and defaults used across all modules.

Runtime Environment

OS Type	Version
Windows	any
linux	any
other	any OS that supports 'npm' environment