cryptokat / semux-js

Semux Javascript SDK

Semux Javascript SDK

This library aims to providing javascript utilities for Semux client-side applications, such as web wallet.

Visit issues page to see planned features or propose a feature request.

Table of Contents

• Install
• Usage
• Example Applications
• Development
• Maintainers
• License

Install

npm install --save semux-js

Getting Started

Node.js

// import semux module
const {SemuxApi, SemuxApiConfiguration} = require("semux-js");

// create an API client
const api = new SemuxApi(new SemuxApiConfiguration({
    username: "user",
    password: "pass",
    basePath: "http://localhost:5171/v2.1.0"
}));

// call GET /info API
api
  .getInfo({ mode: 'cors', credentials: 'include' })
  .then(response => console.log(response))
  .catch(err => console.error(err));

Usage

• Hash
• Key & Signature
• Transaction Signing, Encoding or Decoding
• Byte Encoder / Byte Decoder
• API Client

Example Applications

• Web Wallets
  • https://github.com/witoldsz/semux-light

Browser Compatibility

• Chrome >= 65
• Firefox >= 59
• IE >= 11
• Edge >= 16
• Safari >= 6

Development

Install Modules

npm install

Run Unit Tests

npm test

Run Browser Tests

Browser testing requires Chrome and Firefox installed.

npm run-script test:browser

Format Source Code

npm run format

Check Source Code Formatting

npm run format:check

Maintainers

@cryptokat.

License

MIT © The Semux Developers