docs: clarify forward resolution checks for reverse resolution #387
+14
−4
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
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
|
Deploying ens-docs with
|
| Latest commit: |
9a158da
|
| Status: | ⚡️ Build in progress... |
Arachnid
requested changes
Jan 31, 2025
docs/registry/reverse.mdx
Outdated
| @@ -19,6 +19,8 @@ as well as a convenience function (`setName`) to configure the record as it's mo | |||
|
|
|||
| ## Lookup Primary Name | |||
|
|
|||
| > **Warning**: After setting or reading a primary name, always confirm via forward resolution that the resolved name maps back to the same address. If the addresses don't match, you must display the original address instead. | |||
There was a problem hiding this comment.
You can drop this, since it's covered in the linked section of the docs.
gskril
reviewed
Jan 31, 2025
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.
Clarify Forward Resolution Requirements for Reverse Resolution
This PR adds clear documentation about the requirement to perform forward resolution checks when implementing reverse resolution. The changes emphasize that implementers must verify the resolved name by performing a forward resolution to confirm it maps back to the original address.
Key changes:
These changes help prevent potential security issues by ensuring implementers understand the importance of verifying reverse resolution results.
Link to Devin run: https://app.devin.ai/sessions/eef283c53d724216b16b979a47f211aa