Skip to content

docs: add deprecation warnings to IEntropy.sol interface #3001

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 28, 2025
Merged

docs: add deprecation warnings to IEntropy.sol interface #3001

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3424c6
docs: add deprecation warnings to IEntropy.sol interface
devin-ai-integration[bot] Aug 28, 2025
0599ec7
fix: apply forge formatting to IEntropy.sol
devin-ai-integration[bot] Aug 28, 2025
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
8 changes: 8 additions & 0 deletions target_chains/ethereum/entropy_sdk/solidity/IEntropy.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import "./EntropyEventsV2.sol";
import "./EntropyStructsV2.sol";
import "./IEntropyV2.sol";

/// @notice DEPRECATED: This interface is deprecated. Please use IEntropyV2 instead for new implementations.
/// IEntropyV2 provides better callback handling and improved functionality.
interface IEntropy is EntropyEvents, EntropyEventsV2, IEntropyV2 {
// Register msg.sender as a randomness provider. The arguments are the provider's configuration parameters
// and initial commitment. Re-registering the same provider rotates the provider's commitment (and updates
Expand Down Expand Up @@ -38,6 +40,9 @@ interface IEntropy is EntropyEvents, EntropyEventsV2, IEntropyV2 {
// their chosen provider (the exact method for doing so will depend on the provider) to retrieve the provider's
// number. The user should then call fulfillRequest to construct the final random number.
//
// WARNING: This method does NOT invoke a user callback. If you need callback functionality,
// use requestV2 from the IEntropyV2 interface instead.
//
// This method will revert unless the caller provides a sufficient fee (at least getFee(provider)) as msg.value.
// Note that excess value is *not* refunded to the caller.
function request(
Expand All @@ -49,6 +54,9 @@ interface IEntropy is EntropyEvents, EntropyEventsV2, IEntropyV2 {
// Request a random number. The method expects the provider address and a secret random number
// in the arguments. It returns a sequence number.
//
// DEPRECATED: This method is deprecated. Please use requestV2 from the IEntropyV2 interface instead,
// which provides better callback handling and gas limit control.
//
// The address calling this function should be a contract that inherits from the IEntropyConsumer interface.
// The `entropyCallback` method on that interface will receive a callback with the generated random number.
// `entropyCallback` will be run with the provider's default gas limit (see `getProviderInfo(provider).defaultGasLimit`).
Expand Down
Loading