Wormhole Connect is a project to facilitate integration with the Wormhole protocol. It is thus far comprised of 3 components: wormhole-connect, sdk and builder.

Below is a brief introduction on each, see the corresponding READMEs for more information.

Wormhole Connect

An app that brings all the functionality and utility of the Wormhole token bridge right into your application and removes all of the complexity. It is built to be embedded within any application, simply copy a script tag or install the npm package.

Optionally, configure a number of parameters such as supported chains/tokens and theme.

Read more here

Customizer

Customize and integrate via our no-code solution

SDK

The beginning of a refactor of the existing sdk. It is written in Typescript and is built with ease-of-use in mind. It is organized into different context classes (i.e. evm, solana, terra, etc) which each implement the same methods with standardized parameters.

Read more here

Builder

Initially this serves as a way to test integrating wormhole-connect.

In the future, this will become a playground where developers can come to customize their integration by selecting the chain and tokens they would like to support as well as edit theme variables to make it blend seamlessly within their application.

Read more here

Integration

Include the wormhole connect

<!-- include in <head> -->
<script type="module" src="https://www.unpkg.com/@wormhole-foundation/wormhole-connect@0.2.0/dist/main.js" defer></script>
<link rel="https://www.unpkg.com/@wormhole-foundation/wormhole-connect@0.2.0/dist/main.css" />

<!-- include in <body> -->
<div id="wormhole-connect"></div>

OR

import WormholeBridge from '@wormhole-foundation/wormhole-connect';
function App() {
  return (
    <WormholeBridge />
  );
}

Contributing

Contributions are welcome! To work on wormhole-connect locally you’ll want to use npm link to make the changes to the SDK immediately available.

Setup

  1. Link the sdk
cd ./sdk
npm i
npm run build
npm link
cd ../wormhole-connect
npm link @wormhole-foundation/wormhole-connect-sdk
  1. Install

Run npm i at the root of the repo

  1. Start

Start wormhole-connect UI and view in browser at localhost:3000

# in /wormhole-connect
npm run start # testnet

Start builder UI and view in browser at localhost:3000

# in /builder
npm run start

LEAVE A REPLY

Please enter your comment!
Please enter your name here