fix: Correct IInterchainSecurityModule interface usage #284
Conversation
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
## Description This PR corrects the usage of the `IInterchainSecurityModule` interface in the documentation. The original implementation incorrectly referred to the interface as `IInterchainSecurityModule()` (with parentheses), which is not valid Solidity syntax for an interface name. After verifying the official repository [here](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/solidity/contracts/interfaces/IInterchainSecurityModule.sol), it was confirmed that the correct interface name is `IInterchainSecurityModule`. ### Key Updates: - Replaced `IInterchainSecurityModule()` with the correct `IInterchainSecurityModule` throughout the documentation. - Updated related references to ensure accuracy and consistency, such as examples and links to the Hyperlane `verify` and `moduleType` methods. - Verified compatibility with the original interface definition in the Hyperlane repository. ## Test Plan 1. Verify that the documentation correctly uses the interface name `IInterchainSecurityModule`. 2. Confirm that the Hyperlane official interface link is accurate and leads to the correct definition. 3. Cross-check examples and function references for consistency with the updated interface name. ## Related Issue No specific issue was linked to this fix, but it aligns with maintaining accurate and developer-friendly documentation. ## Notes - This update ensures developers referencing this documentation have accurate guidance aligned with the official Hyperlane interface definition. - The correction avoids potential confusion or errors when implementing custom ISM contracts based on this documentation.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR corrects the usage of the
IInterchainSecurityModuleinterface in the documentation. The original implementation incorrectly referred to the interface asIInterchainSecurityModule()(with parentheses), which is not valid Solidity syntax for an interface name. After verifying the official repository here, it was confirmed that the correct interface name isIInterchainSecurityModule.Key Updates:
IInterchainSecurityModule()with the correctIInterchainSecurityModulethroughout the documentation.verifyandmoduleTypemethods.Test Plan
IInterchainSecurityModule.Related Issue
No specific issue was linked to this fix, but it aligns with maintaining accurate and developer-friendly documentation.
Notes