Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DO NOT MERGE] feat: Add a reference page for the new Deploy App #315

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/reference/deploy-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Hyperlane Deploy App

## Overview

The [Hyperlane Deploy App](https://deploy.hyperlane.xyz) is a simpler but less flexible alternative to the [Hyperlane CLI](/docs/reference/cli.mdx). It currently supports the deployment of new Warp Routes using a basic, default configuration for the route's ISM and Hooks.

![](/img/deploy-app/landing.png)

## Warp Deployments

### Configuring a Warp Route

For each chain you'd like to connect your route to, the app will need to the token 'type' and, if applicable, the collateralized token address.

The type refers to what kind of token contract will be deployed. If you intend to bridge a native asset, like ETH on Ethereum, then select the 'native' type. If you intend to bridge an ERC20 token, like USDC, then select the 'collateral' type. Typically, a route has one chain with a collateral or native type and then one or more chains with synthetic types. The synthetic types mean their assets on that chain will be minted as assets as locked into the collateral/native type. Routes with more than one collateralized type are called 'multi-collateral' routes. These routes are more complex to manage as the locked assets must be kept in balance across the route's chains.

Here's an example of a simple route for USDC on Sepolia. The USDC token's address has been inputted into the collateral field: `0xf08A50178dfcDe18524640EA6618a1f965821715`

<img src="/img/deploy-app/configure.png" alt="Configure Warp Route" style={{ maxWidth: '500px', height: 'auto' }} />

### Reviewing the deployment

The next step will display a summary of the route's configuration, including metadata for for route's tokens. Some fields, such as the name and/or symbol of the synthetic tokens, can be modified at this step.

The contract owner will be set to the connected wallet's address. If a different account should own the newly deployed contracts, that can also be changed here.

<img src="/img/deploy-app/review.png" alt="Review Warp Route" style={{ maxWidth: '500px', height: 'auto' }} />

### Executing the deployment

To begin the deployment, some gas fees will be required for each chain in the route. The app will automatically create a temporary deployer wallet. Use the 'Fund' button to transfer gas fees to the deployer accounts. Once each account is funded, the deployment will automatically begin.

<img src="/img/deploy-app/fund.png" alt="Fund Warp Route" style={{ maxWidth: '500px', height: 'auto' }} />

Finally, once the deployment is complete, the app will offer for you to copy the new Warp Route config for use in other places like the Warp UI or the CLI. A history deployments can be seen by clicking the clock icon above the form.
5 changes: 5 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,11 @@ const sidebars = {
id: "reference/cli",
label: "CLI",
},
{
type: "doc",
id: "reference/deploy-app",
label: "Deploy App",
},
{
type: "category",
label: "Libraries",
Expand Down
Binary file added static/img/deploy-app/configure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/deploy-app/fund.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/deploy-app/landing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/deploy-app/review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.