README.md

JavaScript Client Library

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

{% hint style="info" %} Note: this library and the network itself are currently in Alpha development phase. Please report any issues in the GitHub issue tracker. {% endhint %}

Introduction

For an overview of the main components of the library and how they fit together, read this blog post.

Table of contents

• Features
• Installation
• Example applications
• Code examples
• Build
• Known issues
• License

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 using your preferred package manager:

yarn add radixdlt or npm install radixdlt --save

Example applications

• Front-end example using Vue.js
• Express.js server example

Build

To build the library using your preferred package manager:

yarn install && yarn build or npm install && npm build

Test

Run tests with yarn test.

Known issues

Angular

Apparently on Angular 6+ versions, the node module polyfills from webpack are not bundled. To fix your issue with crypto, path, etc. go to node_modules/@angular-devkit/build-angular/src/angular-cli-files/models/webpack-configs/browser.js and do the following change:

node: { crypto: true, path: true }

{% hint style="warning" %} Note: this is not a reproducible fix. If you install your modules in a new location, you will lose this change. {% endhint %}

Join the Radix Community

• ​Telegram for general chat
• ​Discord for developer chat
• ​Reddit for general discussion
• ​Forum for technical discussion
• ​Twitter for announcements
• ​Email newsletter for weekly updates
• Mail to hello@radixdlt.com for general enquiries.