https://github.com/lit-protocol/hyperlane-warp-ui
https://github.com/lit-protocol/hyperlane-warp-ui
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/lit-protocol/hyperlane-warp-ui
- Owner: LIT-Protocol
- License: apache-2.0
- Created: 2025-02-05T19:42:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-05T23:42:16.000Z (over 1 year ago)
- Last Synced: 2025-02-06T00:27:44.885Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://hyperlane-warp-ui-gray.vercel.app
- Size: 4.62 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Lit Protocol Bridge UI
Deployed at https://bridge.litprotocol.com
This repo is a customized version of an example web interface for interchain tokens built with [Hyperlane Warp Route](https://docs.hyperlane.xyz/docs/reference/applications/warp-routes). Warp is a framework to permissionlessly bridge tokens to any chain. This uses the [Hyperlane Warp Route UI Template](https://github.com/hyperlane-xyz/hyperlane-warp-ui-template) project.
## Architecture
This app is built with Next & React, Wagmi, RainbowKit, and the Hyperlane SDK.
- Constants that you may want to change are in `./src/consts/`, see the following Customization section for details.
- The index page is located at `./src/pages/index.tsx`
- The primary features are implemented in `./src/features/`
## Customization
See [CUSTOMIZE.md](./CUSTOMIZE.md) for details about adjusting the tokens and branding of this app.
## Development
### Setup
#### Configure
You need a `projectId` from the WalletConnect Cloud to run the Hyperlane Warp Route UI. Sign up to [WalletConnect Cloud](https://cloud.walletconnect.com) to create a new project.
#### Build
```sh
# Install dependencies
yarn
# Build Next project
yarn build
```
### Run
You can add `.env.local` file next to `.env.example` where you set `projectId` copied from WalletConnect Cloud.
```sh
# Start the Next dev server
yarn dev
# Or with a custom projectId
NEXT_PUBLIC_WALLET_CONNECT_ID= yarn dev
```
### Test
```sh
# Lint check code
yarn lint
# Check code types
yarn typecheck
```
### Format
```sh
# Format code using Prettier
yarn prettier
```
### Clean / Reset
```sh
# Delete build artifacts to start fresh
yarn clean
```
## Deployment
The easiest hosting solution for this Next.JS app is to create a project on Vercel.
## Learn more
For more information, see the [Hyperlane documentation](https://docs.hyperlane.xyz/docs/reference/applications/warp-routes).