Official Ren JavaScript SDK for bridging crypto assets cross-chain.
npm install @renproject/ren🛠️ ren-js
The official Javascript SDK for interacting with RenVM.
``sh`
yarn add @renproject/ren @renproject/chains
See Ren Client Docs
RenJS v3 is currently available as an alpha release:
`sh`
yarn add @renproject/ren @renproject/chains
RenJS v3 Docs (WIP)
See the Releases page.
- ren - Javascript SDK for interacting with RenVM.
- provider - JSON-RPC provider.
- utils - Helper functions used by the other packages.
- mock-provider - For testing locally with Ganache/Hardhat
- chains, for enabling support for blockchains and assets:
- - chains-bitcoin - Bitcoin and Bitcoin forks
- - chains-ethereum - Ethereum and other EVM chains
- - chains-terra - Terra/LUNA
- - chains-filecoin - Filecoin
- - chains-solana - Solana
- - chains - Combines all of the above chains into one package
Developer docs - click to expand
`shClone repository
git clone git@github.com:renproject/ren-js.git && cd ren-js
Linking
If you want to use your local version of RenJS in another repository, run
sh
In the ren-js repository
yarn run link:all
`You can now link it to any other local repository by running:
sh
In other local repositories
yarn link @renproject/ren @renproject/chains @renproject/utils @renproject/provider
`Running tests
You'll need to:
1. Generate a mnemonic and send ETH (goerli for testnet) (path:
).
- let w = require("ethers").Wallet.createRandom(); console.debug(w.address, w.mnemonic.phrase);
2. Generate a private key and send testnet crypto funds.
-
3. Optionally generate an Infura API key.Create a
file which contains the following exported variables:`sh
export MNEMONIC="your mnemonic here"
export TESTNET_PRIVATE_KEY="your bitcoin private key"Optional
export INFURA_KEY="your infura key"
`To run the tests:
sh
yarn run test
``