radixdlt-js library
A JavaScript client library for interacting with a Radix Distributed Ledger.
⚠️ Compatible with Radix Core rc/1.0-beta.19
See Radix versions document releases.md for compatability table.
This library and the network itself are currently in Alpha development phase. Please report any issues in the GitHub issue tracker.
Introduction
For an overview of the main components of the library and how they fit together, read this blog post.
Table of contents
- Changelog
- Features
- Installation
- Development
- Example applications
- Code examples
- Known issues
- Contribute
- Links
- License
Features
- Full Typescript support
- Follow the reactive programming pattern using RxJS
- Cryptography using the elliptic library
- Automatically manage connection to the Radix Universe
- Communication with the Radix network using 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
Development
Build
To build the library using your preferred package manager:
yarn install && yarn build
Example applications
Code examples
You can find detailed documentation as well as a number of code examples covering main functions of the library in our Knowledge Base:
- Initializing a Universe
- Reading Atoms from a public address
- Reading and decrypting Atoms from an owned address
- Sending a Transaction
- Sending a Message
- Storing an application Payload
- Caching Atoms
- Storing private Keys
- Loading private Keys
- Setting a log level
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.
Contribute
Contributions are welcome, we simply ask to:
- Fork the codebase
- Make changes
- Submit a pull request for review
When contributing to this repository, we recommend discussing with the development team the change you wish to make using a GitHub issue before making changes.
Please follow our Code of Conduct in all your interactions with the project.
Links
| Link | Description |
|---|---|
| radixdlt.com | Radix DLT Homepage |
| documentation | Radix Knowledge Base |
| forum | Radix Technical Forum |
| @radixdlt | Follow Radix DLT on Twitter |
License
The radixdlt-js library is released under the MIT License.
