JavaScript client library

The developers guide to building on the Radix Network with the JavaScript client library

License MIT Build Status Quality Gate Reliability Security Code Corevage

Introduction

A JavaScript client library for interacting with a Radix Distributed Ledger.

Note: this library and the network itself are currently in Beta development phase. Please report any issues in the GitHub issue tracker.

Features

  • Full TypeScript support

  • Follow the reactive programming pattern using RxJS

  • Cryptography using the elliptic library

  • Automatically manage connection to the Radix Universe in a sharded environment

  • Communication with the Radix network usign RPC over WebSockets

  • Read Atoms in any address

  • Write Atoms to the ledger

  • End-to-end data encryption using ECIES

Installation

To install the library in your own project using yarn package manager:

yarn add radixdlt

Example applications

Build

To build the library using your preferred package manager, run:

yarn install && yarn build

Test

Run tests with yarn test.

Known issues

Angular 6+

Error: Can't resolve 'crypto'

On Angular 6+ versions, the node module polyfills from webpack are not bundled. To fix your issue with crypto, path, etc. use the fix described in this answer.

License

The radixdlt-js library is released under the MIT License.

Join the Radix Community