An easy way to bridge cross-chain assets between blockchains.

Copy .env.example into .env and add missing environment variables. Bridge uses Infura internally, so you'll need to go to infura.io, create a key and set REACT_APP_INFURA_ID in the .env file.

Ensure the dependencies are installed by running yarn.

Available commands:

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Launches the test runner in the interactive watch mode.

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

The app was build on top of CRA, Material-UI with redux-toolkit for shared state management.

The core RenVM libraries on which the application is built are as follows:

@renproject/multiwallet-ui - provides extensible wallet selection, connection and management features for React apps. It comes together with default UI, but can be adapted to any React UI framework.

@renproject/rentx - RenTX is for managing transactions. Allows transactions state tracing and makes it easier to build UI for appropriate transaction stages.

@renproject/ren - RenJS is the core library for interacting with RenVM. RenTX uses it internally. Bridge uses it for things such as fees calculation.

You are free to fork this app and adapt/extend it to your needs.

git clone https://github.com/renproject/bridge-v2.git

RenBridge requires an Infura key provided as an environment variable. You can create one by going to infura.io. If another Ethereum provider is being used, it can be changed in Multiwallet.tsx.

Here are some common cases you can run into:

If you want to add a new asset, follow these steps:

• add asset source chain and appropriate mappings to rentx.ts
• add a new asset and its chain data in assetConfigs.ts. Ensure you covered following points:
  • add a new asset symbol to BridgeCurrency enum
  • add the newly installed chain to RenChain and BridgeChain enums
  • add a new BridgeCurrencyConfig entry in currenciesConfig. Should include labels, icons/coloring, source chain and network mappings.
  • add a new BridgeChainConfig entry in chainsConfig. Should include labels, icons, block time/confirmations data and native currency mapping
  • extend toMintedCurrency and toReleasedCurrency functions with new asset mappings
  • enable newly added asset in supportedLockCurrencies, supportedReleaseCurrencies

Most of the visual - related configuration lies in a theme folder. To find out how to style Material UI, check this link. Icons, logos and other images can be found in assets folder.

Any static hosting site can be used, such as GitHub pages, Netlify or Cloudflare pages, or on IPFS through a service like Fleek.

For GitHub pages, instructions can be found here: https://create-react-app.dev/docs/deployment#github-pages.