@renproject/rentx

XState Statemachines for tracking RenVM transactions reactively

Usage no npm install needed!

<script type="module">
  import renprojectRentx from 'https://cdn.skypack.dev/@renproject/rentx';
</script>

README

🛠️ ren-js

Version

The official Javascript SDK for interacting with RenVM.

Integration options

  1. RenBridge (bridge.renproject.io): Link out to RenBridge if you require users to have renBTC and other bridged assets.
  2. RenJS (RenJS repository): An SDK for integrating into your own user interface.
  3. RenTX (RenTX repository): A wrapper around RenJS to make handling transaction state easier.
  4. Multiwallet (Multiwallet UI repository): A library for handling user wallet connections for various blockchains.

Docs

See ./packages/lib/ren/README.md for basic usage, and the Getting Started Tutorial for a guide on bridging assets.

Changelog

See the Releases page.

Local development

Clone the repository, install the dependencies and build:

git clone git@github.com:renproject/ren-js.git && cd ren-js
yarn && yarn run link-all
yarn build

You can now use your local RenJS build by running the following in the target repository:

yarn link @renproject/ren

Package list

See ./packages/README.md.

Adding chains

See ./packages/lib/chains/chains/README.md.