Skip to main content

Started

This is a tutorial for JavaScript developers to use the gs-ur-js. This SDK helps developers easily interact with GsWallet Hardware from a JavaScript environment.

Environment​

Make sure you have Node.js and npm (or yarn) installed.

# Check Node.js version
node -v

# Check npm version
npm -v

Install SDK​

npm install gs-ur-js

SDK Structure​

GS-UR-JS
|   package.json
|   package-lock.json
|   tsconfig.json
|   README.md
+---dist
+---src
|   +---cbor
|   +---decoder
|   +---chain
|   +---keyring
|   +---registry
|   +---utils
+---tests

dist​

The dist folder contains the compiled and ready-to-use SDK files for distribution.

src​

This folder contains core implementation of the sdk. Main subfolders include:

  • cbor: Cbor Protocol implementation
  • decoder: UR Registry Decoder
  • chain: Blockchains Configure
  • keyring: APIs implementation
  • registry: Various objects implementations based on the UR protocol
  • utils: a set of useful utilities

Tests​

Contains module test code