0.0.3 • Published 4 months ago

joule-cc-swap v0.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

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

2.1. Installation

NPM:

npm install joule-cc-swap

PNPM:

pnpm install joule-cc-swap

Yarn:

yarn add joule-cc-swap

Add/Update your .npmrc

auto-install-peers=true
legacy-peers-deps=true

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.

    ```jsx
    import { ProviderWrapper, Bridge } from "joule-cc-swap";
    import "joule-cc-swap/styles.css"
    
    export default function Component() {
      return (
        <ProviderWrapper>
          <Bridge />
        </ProviderWrapper>
      )
    }
    
    ```

4. Contact & Support