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

Gateway Onboarding Refactor #196

Open
wants to merge 2 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
3 changes: 2 additions & 1 deletion .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ ignore:
redirects:
blockchain-environments/constants: reference/constants.md
quick-start/connect: tutorials/quick-start/wh-connect.md
explore-wormhole/gateway/onboard: governance/gateway-onboard.md
blockchain-environments/blockchain-environments: blockchain-environments/README.md
blockchain-environments/evm: blockchain-environments/evm/README.md
blockchain-environments/evm/relayer: blockchain-environments/evm/relayer.md
blockchain-environments/solana: blockchain-environments/solana/README.md
blockchain-environments/cosmwasm: blockchain-environments/cosmwasm/README.md
blockchain-environments/aptos: blockchain-environments/aptos/README.md
blockchain-environments/sui: blockchain-environments/sui/README.md
blockchain-environments/algorand: blockchain-environments/algorand/README.md
blockchain-environments/algorand: blockchain-environments/algorand/README.md
10 changes: 9 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
- [Relayers](reference/components/relayer.md)
- [Spy](reference/components/spy.md)
- [Gateway](reference/components/gateway/README.md)
- [Onboarding](reference/components/gateway/onboard.md)

## Reference

Expand Down Expand Up @@ -85,6 +84,15 @@
- [Getting Started](queries/getting-started.md)
- [FAQs](queries/faqs.md)

## Governance

- [Gateway Onboarding](governance/gateway/README.md)
- [New Chain Proposal](governance/gateway/proposal.md)
- [IBC Connection](governance/gateway/ibc-connection.md)
- [Connect Integration](governance/gateway/connect.md)
- [Register assets](governance/gateway/registry.md)
- [Goveror Limits](governance/governor-limit.md)

## External Links

- [Explorer](https://wormholescan.io/)
Expand Down
8 changes: 8 additions & 0 deletions docs/governance/gateway/connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### Subpage 3: UI Integration with Wormhole Connect

[Wormhole Connect](https://wormhole.com/connect/) is a seamless way to embed bridging directly to your app with 3 lines of code. [Integrating Connect](https://wormhole-connect-builder.netlify.app/) is fast, customizable, and brings all the functionality and utility of Wormhole right into your own application.

Please refer to these reference PRs to add your Cosmos chain into Wormhole Connect. Your PRs will need to be reviewed and merged by Wormhole Core Contributors.

1. Add your Cosmos chain ID to the Wormhole SDK: [[sdk/js] Add Kujira chain id by M-Picco · Pull Request #3381 · wormhole-foundation/wormhole (github.com)](https://github.com/wormhole-foundation/wormhole/pull/3381/files)
2. Add your Cosmos chain to Wormhole Connect: [Add kujira chain by M-Picco · Pull Request #1009 · wormhole-foundation/wormhole-connect (github.com)](https://github.com/wormhole-foundation/wormhole-connect/pull/1009/files)
22 changes: 22 additions & 0 deletions docs/governance/gateway/ibc-connection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
### Subpage 2: For Relayers- Establish an IBC Connection

### I. Generate Gateway Address

The IBC relayer should generate an address via the `wormchaind` CLI - [here](https://github.com/wormhole-foundation/wormhole/tree/main/wormchain).

```jsx
wormchaind keys add <key-name> --keyring-backend <your-keyring-backend>
```

### II. Allowlist your Gateway Address

Fill out the [IBC relayer allowlist request template](https://www.notion.so/wormhole/explore-wormhole/gateway/onboard#ibc-relayer-allowlist-request-template). Post the request in the `#guardian-cosmos` channel.

### III. Establish the IBC Connection

Please ensure that the `trusting_period` and `trust_threshold` parameters are set to the safest values. E.g. `trust_threshold` should be 2/3 and `trusting_period` should be 2/3 the unbonding period of your chain.

See an example IBC relayer config for Wormhole Gateway [below](https://www.notion.so/wormhole/explore-wormhole/gateway/onboard#wormhole-gateway-ibc-relayer-config).

Please see docs [here](https://github.com/wormhole-foundation/wormhole/blob/main/wormchain/syncing.md) on how to set up your own Wormhole Gateway node to connect your IBC relayer to. Or, you can see available public nodes on the [cosmos chain registry](https://github.com/cosmos/chain-registry/blob/master/gateway/chain.json).
Share the IBC connection details in the `#guardian-cosmos` channel along with a request to the Wormhole Contributors to prepare governance for the IBC connection.
8 changes: 8 additions & 0 deletions docs/governance/gateway/proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### Gateway Onboarding

Subpage 1: Propose Adding Your Chain to the Wormhole Guardians

1. Open a new GitHub governance discussion under Wormhole Gateway by filling out the Cosmos Chain Governance Proposal Template - [here](https://github.com/wormhole-foundation/wormhole/discussions/new?category=gateway).
2. Join the wormhole discord ([link](https://discord.gg/wormholecrypto)).
3. Ping the Admin, Cody (`Kilo_wormhole`), to get added to the `#guardian-cosmos` channel.
4. A Contributor will be in touch when your proposal passes governance, or, when we have further questions.
5 changes: 5 additions & 0 deletions docs/governance/gateway/registry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### Subpage 4: Add bridged assets to the Cosmos Chain Registry and other relevant wallet and frontend registries

1. Permissionlessly attest the assets you would like to bridge into your chain (if not already attested) to Wormhole Gateway.
2. Raise relevant PRs to ensure that explorers, wallets, and other UIs recognize the Wormhole assets when they are bridged to your chain.
1. Example PR adding Wormhole assets to Osmosis Mintscan ([example](https://github.com/cosmostation/chainlist/pull/865)).
1 change: 1 addition & 0 deletions docs/governance/governor-limit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# TODO