-
Notifications
You must be signed in to change notification settings - Fork 151
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
44 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
### Description | ||
|
||
#### Type: <New | Updated> <Network | Warp Route> | ||
|
||
#### Network(s): <Network Name(s)> | ||
|
||
#### Other notes | ||
|
||
### Backward compatibility | ||
|
||
<!-- | ||
Are these changes backward compatible? Note, additions are backwards compatible. | ||
Yes/No | ||
--> | ||
|
||
### Testing | ||
|
||
<!-- | ||
Have any new metadata configs and deployment addresses been used with any Hyperlane tooling, such as the CLI? | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Contributing | ||
|
||
This registry is maintained by the core Hyperlane team, but community members are encouraged to add chain and deployment information here! | ||
|
||
## Benefits | ||
|
||
By adding chain metadata, deployment addresses, and other information here, you make it easier to use with Hyperlane tooling, such as the [Explorer](https://explorer.hyperlane.xyz) and the [CLI](https://docs.hyperlane.xyz/docs/reference/cli). For example, users will be able to search for messages to chains using [Permissionless Interoperability](https://docs.hyperlane.xyz/docs/reference/glossary#permissionless-interoperability) without having to specify the metadata themselves. | ||
|
||
## Process | ||
|
||
1. Fork and clone the registry repository | ||
2. Use the CLI and set the `--registry` flag to the local path of the cloned repository | ||
3. Execute your commands as needed, such as `hyperlane deploy core --registry <YOUR_URI>` | ||
4. Push your changes to your fork and create a pull request | ||
|
||
Once you've opened a PR, the Hyperlane team will review it. If it meets the requirements, it will be merged into the registry. | ||
|
||
## Documentation | ||
|
||
For more information about Hyperlane Registries see the [documentation](https://docs.hyperlane.xyz/docs/reference/registries). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters