@joule-finance/joule-bridge

Widget Documentation

1. Introduction

• Overview: The bridge widget enables users to swap any token on EVM networks for any token on the Aptos blockchain. This feature leverages top-tier liquidity aggregators, ensuring efficiency and cost-effectiveness for cross-chain token transfers.
• Supported Platforms: Aptos, EVM-compatible chains (e.g., Ethereum, BSC, etc.).

---

2. Installation & Setup

2.1. Requirements

💡

Note: API Key Support Coming Soon!

In the future, the bridge widget may introduce support for API keys to provide users with more control over their transaction limits, rate limiting, and advanced configuration options. Stay tuned for updates on this feature!

2.1. Installation

NPM:

npm install bridge-widget

PNPM:

pnpm install bridge-widget

Yarn:

yarn add bridge-widget

3. Usage

3.1. Integrating the Widget

To integrate the bridge widget into your project, follow these steps:

1. Import the Widget: Use the following code to import the Bridge component from the widget.

   import Bridge from "jbridge";
   
   export default function Component() {
     return <Bridge />;
   }

2. Embed in Your Application: You can directly use the <Bridge /> component within your React project to enable cross-chain token transfers..

---

4. Contact & Support

• Support Channels:
  • https://discord.com/invite/VuZMhy5w96
  • https://t.me/joulefinance