A JavaScript client library for interacting with a Radix Distributed Ledger.
This library and the network itself are currently in Alpha development phase. Please report any issues in the GitHub issue tracker.
For an overview of the main components of the library and how they fit together, read this blog post.
- Features
- Installation
- Build
- Example applications
- Code examples
- Known issues
- Contribute
- Links
- License
- 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
To install the library using your preferred package manager:
yarn add radixdlt
or npm install radixdlt --save
To build the library using your preferred package manager:
yarn install && yarn build
or npm install && npm build
Run tests with yarn test
.
In our Knowledge Base you can find implementation examples to execute basic tasks with our JavaScript library:
- 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
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 }
NOTE: This is not a reproducible fix. If you install your modules in a new location, you will lose this change.
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 to discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please follow our Code of Conduct in all your interactions with the project.
Link | Description |
---|---|
radixdlt.com | Radix DLT Homepage |
documentation | Radix Knowledge Base |
forum | Radix Technical Forum |
@radixdlt | Follow Radix DLT on Twitter |
The radixdlt-js library is released under the MIT License.