LogoLogo
  • Introduction
  • Quick Start
    • Developing Cross Chain Dapps
      • Standard Relayer
      • Specialized Relayer
    • Tutorials
      • Hello Wormhole
        • Hello Wormhole Explained
        • Beyond Hello Wormhole
      • Hello Token
      • CCTP
        • USDC Transfers With Connect SDK
      • Simple Relayer
        • Advanced Relayer Example
    • Demos
    • Wormhole Connect: Bridging Made Easy
  • Explore Wormhole
    • Architecture
    • Security
    • Core Contracts
    • Guardians
    • VAAs
    • Relayers
    • Spy
    • Gateway
      • Onboarding
  • Reference
    • Constants Reference
    • Development Environment
      • Tilt
      • Tooling
    • Blockchain Platforms
      • Algorand
      • Aptos
      • CosmWasm
      • EVM
        • Relayer
      • Near
      • Solana
      • Sui
    • API Docs
      • Wormholescan API
    • SDK Docs
      • Legacy SDK
    • CLI Docs
    • Glossary
  • Wormhole Connect
    • Overview
    • Routes
    • Features
    • Configuration
  • Native Token Transfers
    • Overview
      • System Components
      • Deployment Models
    • Deployment
      • Installation
      • Deploy to EVM
      • Deploy to Solana
      • Post Deployment
    • Configuration
      • Rate Limiting
      • Access Control
    • Security
    • Custom Transceivers
    • Architecture
      • EVM Message Lifecycle
      • Solana Message Lifecycle
  • Queries
    • Overview
    • Getting Started
    • FAQs
  • MultiGov
    • Overview
    • Getting Started
    • Deployment
      • Configuration
    • Upgrading
    • Architecture
    • Guides
    • FAQs
  • External Links
    • Explorer
    • Ecosystem
    • Guardian Dashboard
    • Portal Bridge Docs
    • Discord
    • Twitter
    • Github
Powered by GitBook
On this page
  • Summary
  • Features
  • Demo
  • Integrate Connect
  • Configuration

Was this helpful?

Edit on GitHub
  1. Wormhole Connect

Overview

Last updated 9 months ago

Was this helpful?

Summary

Wormhole Connect is a React widget that lets developers offer an easy to use interface to facilitate cross-chain asset transfers via Wormhole, directly in a web application.

Check out the !

Wormhole Connect Screenshot

Features

  • ability to configure any token to bridge via Wormhole

Demo

Wormhole Connect is deployed live in several production apps. Here are a few:

Integrate Connect

Option 1: import directly into a React app

First, install the npm package.

npm i @wormhole-foundation/wormhole-connect

Now you can import the React component:

import WormholeConnect from '@wormhole-foundation/wormhole-connect';

function App() {
  return (
    <WormholeConnect />
  );
}

Option 2: hosted version via CDN (for any website)

If you're not using React, you can still embed Connect on your website by using the hosted version. The sample code below uses the popular and free unpkg.com CDN from which your app will load the widget.

<!-- Mounting point. Include in <body> -->
<div id="wormhole-connect"></div>

<!-- Dependencies -->
<script type="module" src="https://www.unpkg.com/@wormhole-foundation/wormhole-connect@{WORMHOLE_CONNECT_VERSION}/dist/main.js" defer></script>
<link rel="https://www.unpkg.com/@wormhole-foundation/wormhole-connect@{WORMHOLE_CONNECT_VERSION}/dist/main.css" />
<!-- Mounting point. Include in <body> -->
<div id="wormhole-connect"></div>

<!-- Dependencies -->
<script type="module" src="https://www.unpkg.com/@wormhole-foundation/[email protected]/dist/main.js" defer></script>
<link rel="https://www.unpkg.com/@wormhole-foundation/[email protected]/dist/main.css" />

It is important to periodically update your Wormhole Connect instance to the latest version, as there are frequent functionality and security releases.

Configuration

The default configuration of Wormhole Connect may not be what you want to use. You may want to:

  • use custom styles

  • restrict the chains that you allow in your app

  • add support for your project's token, and eliminate tokens you don't want to reduce "noise"

  • configuring custom RPC URLs (do this - default public RPCs are heavily throttled)

The allows you to implement the same functionality as the Connect widget, but in your own UI. For more information on using the SDK instead of Connect .

This is just an overview of what features are available. For details about each, check .

multiple ways to bridge assets ("")

extensive ways to style the UI (also try the !)

ways to what feature set to offer

at the destination

Simply copy and paste the following into your HTML body, and replace the {WORMHOLE_CONNECT_VERSION} in the links with the most recent production version of Wormhole Connect. You can check what the most recent version is on .

For example, for :

This is just an overview of what's possible. For details about all the configuration options, check .

restrict the that are available

Check the and customize your widget however you like!

Wormhole Typescript SDK
check out the docs
here
routes
codeless styler interface
configure
Portal Bridge
Jupiter
Pancake Swap
NPM
0.3.13
here
routes
configuration options
Github repository
drop off some gas