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.

Sign up for GitHub

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

Jump to bottom

tips for custom chains in warp routes #54

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

tips for custom chains in warp routes #54

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
495af90
tips for custom chains in warp routes
armanthepythonguy Feb 4, 2024
e1dc3ef
Update docs/guides/deploy-warp-route.mdx
armanthepythonguy Feb 5, 2024
7f82a28
Update docs/guides/deploy-warp-route.mdx
armanthepythonguy Feb 5, 2024
c83af29
Update deploy-warp-route.mdx
armanthepythonguy Feb 5, 2024
ecaff2d
Update deploy-warp-route.mdx
armanthepythonguy Feb 16, 2024
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
16 changes: 15 additions & 1 deletion docs/guides/deploy-warp-route.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To deploy the route, you will need a Warp Route config file. A valid config will
* _Optional:_ Hyperlane connection details including contract addresses for the [mailbox](../reference/messaging/messaging-interface.mdx), [interchain gas](../reference/hooks/interchain-gas.mdx), and [interchain security modules](../reference/ISM/specify-your-ISM.mdx).
* _Optional:_ The token standard - fungible tokens using ERC20 or NFTs using ERC721. Defaults to ERC20.

The easiest way to create one is with the CLI's config comamnd:
The easiest way to create one is with the CLI's config command:

```bash
hyperlane config create warp
Expand All @@ -35,6 +35,11 @@ hyperlane config create warp
If your config looks correct, you can now skip to [Step 2: Deployment](#2-deployment).
Or see below for details on how to define your config manually.

If you want to use custom chains(To use custom chains, first you need to [deploy Hyperlane](../deploy-hyperlane.mdx) onto your chain) in your Warp Route config, use the `--chains` flag.
```bash
hyperlane config create warp --chains <PATH-TO-CHAINS-FILE>
```

:::

#### Base
Expand Down Expand Up @@ -90,6 +95,15 @@ Run the following command to initiate the Warp Route deployment:
hyperlane deploy warp
```

:::tip

If you are using custom chains(To use custom chains, first you need to [deploy Hyperlane](../deploy-hyperlane.mdx) onto your chain) in your Warp Route config, don't forget to use the `--chains` flag.
```bash
hyperlane deploy warp --chains <PATH-TO-CHAINS-FILE>
```

:::

Once finished, the CLI will create two new JSON artifact files: `warp-deployment` and `warp-ui-token-config`. The first contains just addresses for the newly deployed Warp router contracts. The second is a config file for the Warp UI, which you can use for the next optional step.

## 3. Testing
Expand Down