docs: add deprecation warnings to IEntropy.sol interface #3001
Conversation
This file contains hidden or 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
- Add deprecation warning at top of interface directing users to IEntropyV2 - Warn that request() method does NOT invoke callbacks, recommend requestV2 - Mark requestWithCallback() as deprecated, recommend requestV2 from IEntropyV2 This addresses user confusion where calling request() instead of requestWithCallback() results in no callback being invoked, helping users understand the correct methods to use. Co-Authored-By: Jayant <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
6 Skipped Deployments
|
jayantk
approved these changes
Aug 28, 2025
Apply Solidity formatting rules to fix CI test failure Co-Authored-By: Jayant <[email protected]>
tejasbadadare
approved these changes
Aug 28, 2025
tejasbadadare
deleted the
devin/1756401883-deprecate-ientropy-interface
branch
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.
Summary
Adds deprecation warnings to the
IEntropy.solinterface to help users understand the correct methods to use and prevent confusion around callback functionality.Rationale
A user recently called
request()instead ofrequestWithCallback()and was confused why their callback wasn't being invoked. To prevent this issue in the future, this PR adds clear warnings:IEntropyis deprecated and they should useIEntropyV2insteadrequest()method warning: Explicitly states this method does NOT invoke callbacks and recommendsrequestV2requestWithCallback()deprecation: Marks the method as deprecated and recommendsrequestV2fromIEntropyV2How has this been tested?
pnpm turbo fix)The changes are documentation-only additions that don't affect contract functionality. Linting and formatting checks pass successfully.
Link to Devin run: https://app.devin.ai/sessions/a7070651e6cd4396aaf26d3830979970
Requested by: Jayant Krishnamurthy ([email protected])
Human Review Checklist
IEntropyV2andrequestV2are the correct recommendations