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

feat: go to production guides #240

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: go to production guides #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions docs/guides/remove-trusted-relayer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import PrerequisitesPartial from '/docs/partials/warp-routes/_prerequisites-config-symbol.mdx'
import WarpReadSymbolChainPartial from '/docs/partials/warp-routes/commands/_warp-read-symbol-chain.mdx'
import WarpApplySymbolConfigDefaultPartial from '/docs/partials/warp-routes/commands/_warp-apply-symbol-config-default.mdx'
import PrerequisitesPartial from "/docs/partials/warp-routes/_prerequisites-config-symbol.mdx";
import WarpReadSymbolChainPartial from "/docs/partials/warp-routes/commands/_warp-read-symbol-chain.mdx";
import WarpApplySymbolConfigDefaultPartial from "/docs/partials/warp-routes/commands/_warp-apply-symbol-config-default.mdx";

# How to Remove Trusted Relayer ISM from Warp Route

This guide explains how to remove the default Trusted Relayer ISM from your Warp Route using the Hyperlane CLI. Removing the Trusted Relayer ISM is a crucial step when preparing your Warp Route for production.

# Using the Hyperlane CLI

When first deploying with the CLI, new warp routes use a Trusted Relayer ISM out of the box so you don't need to run a relayer or validator.
Expand Down Expand Up @@ -40,13 +42,15 @@ yourchain:
domains: {}
threshold: 1
```

This particular config has a `trustedRelayerIsm` as part of the `staticAggregationIsm`.

This means that the `relayer` address will be allowed to call the Warp Route’s `handle()` function. In other words, the `relayer` can execute arbitrary messages on the Warp Route. This may be undesirable in cases outside of the self-relaying feature.

By default, `warp read` will save the output to `CURRENT_DIR/configs/warp-route-deployment.yaml`. Follow these steps using the CLI to transfer the existing ownership to another address.

## Step 1: Configuration

Update the `warp-route-deployment.yaml` by **removing** the `trustedRelayerIsm` block from `modules`. Alternatively, you can configure the entire `modules` block as desired.

```diff title="warp-route-deployment.yaml"
Expand Down Expand Up @@ -87,7 +91,6 @@ To confirm that the trusted relayer was successfully removed using the Hyperlane

<WarpReadSymbolChainPartial />


After running `warp read`, confirm that the trusted relayer ISM has been removed from your warp route (In this example, it should only contain the remaining `defaultFallbackRoutingIsm`). You should see a similar config under `interchainSecurityModule`:

```yaml {8-11}
Expand Down
12 changes: 8 additions & 4 deletions docs/guides/transfer-mailbox-ownership.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
import PrerequisitesPartial from '/docs/partials/core/_prerequisites-config-artifacts.mdx'
import CoreReadChainPartial from '/docs/partials/core/commands/_core-read-chain.mdx'
import CoreApplyChainPartial from '/docs/partials/core/commands/_core-apply-chain.mdx'
import PrerequisitesPartial from "/docs/partials/core/_prerequisites-config-artifacts.mdx";
import CoreReadChainPartial from "/docs/partials/core/commands/_core-read-chain.mdx";
import CoreApplyChainPartial from "/docs/partials/core/commands/_core-apply-chain.mdx";

# How to Transfer Ownership from Hyperlane Mailbox
# How to Transfer Ownership from Hyperlane Mailbox

This guide explains how to change the owner of your Hyperlane Mailbox using the Hyperlane CLI. Transferring ownership is necessary when you want to give control to a different address, such as for security reasons or when making changes to who manages the Mailbox.

As the new owner, you will have full control over the Mailbox settings, including managing hooks, ISM configurations, and permissions for message handling. We’ll guide you through updating the owner address, applying the change, and confirming everything is set correctly.

# Using the Hyperlane CLI

Expand Down