Skip to content

fix: keep structs for storage layout compatability #31

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 1 commit into from
Aug 20, 2025
Merged

fix: keep structs for storage layout compatability #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 18 additions & 6 deletions src/optimistic-oracle-v2/implementation/ManagedOptimisticOracleV2.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ contract ManagedOptimisticOracleV2 is ManagedOptimisticOracleV2Interface, Optimi
BondRange range;
}

struct CustomBond {
uint256 amount;
// isSet is not used anymore as amount cannot be set to 0, but it is kept for storage layout compatibility.
bool isSet;
Copy link
Member

@mrice32 mrice32 Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we name it something distinct so it's clear it should not be used?

DEPRECATED_isSet;, for example.

See here as an example.

Copy link
Collaborator Author

@Reinis-FRP Reinis-FRP Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The upgrade verification check would fail and it is not possible to tag renamed struct member. The other alternative is to use @custom:oz-retyped-from, but that would forego storage layout checks for the whole struct.

}

struct CustomLiveness {
uint256 liveness;
// isSet is not used anymore as liveness cannot be set to 0, but it is kept for storage layout compatibility.
bool isSet;
}

// Config admin role is used to manage request managers and set other default parameters.
bytes32 public constant CONFIG_ADMIN_ROLE = keccak256("CONFIG_ADMIN_ROLE");

Expand All @@ -36,10 +48,10 @@ contract ManagedOptimisticOracleV2 is ManagedOptimisticOracleV2Interface, Optimi
AddressWhitelistInterface public requesterWhitelist;

// Custom bonds set by request managers for specific request and currency combinations.
mapping(bytes32 managedRequestId => mapping(IERC20 currency => uint256 customBond)) public customBonds;
mapping(bytes32 managedRequestId => mapping(IERC20 currency => CustomBond)) public customBonds;

// Custom liveness values set by request managers for specific requests.
mapping(bytes32 managedRequestId => uint256 customLiveness) public customLivenessValues;
mapping(bytes32 managedRequestId => CustomLiveness) public customLivenessValues;

// Custom proposer whitelists set by request managers for specific requests.
mapping(bytes32 managedRequestId => AddressWhitelistInterface) public customProposerWhitelists;
Expand Down Expand Up @@ -206,7 +218,7 @@ contract ManagedOptimisticOracleV2 is ManagedOptimisticOracleV2Interface, Optimi
require(_getCollateralWhitelist().isOnWhitelist(address(currency)), UnsupportedCurrency());
_validateBond(currency, bond);
bytes32 managedRequestId = getManagedRequestId(requester, identifier, ancillaryData);
customBonds[managedRequestId][currency] = bond;
customBonds[managedRequestId][currency].amount = bond;
emit CustomBondSet(managedRequestId, requester, identifier, ancillaryData, currency, bond);
}

Expand All @@ -227,7 +239,7 @@ contract ManagedOptimisticOracleV2 is ManagedOptimisticOracleV2Interface, Optimi
) external nonReentrant onlyRequestManager {
_validateLiveness(customLiveness);
bytes32 managedRequestId = getManagedRequestId(requester, identifier, ancillaryData);
customLivenessValues[managedRequestId] = customLiveness;
customLivenessValues[managedRequestId].liveness = customLiveness;
emit CustomLivenessSet(managedRequestId, requester, identifier, ancillaryData, customLiveness);
}

Expand Down Expand Up @@ -277,11 +289,11 @@ contract ManagedOptimisticOracleV2 is ManagedOptimisticOracleV2Interface, Optimi
// Apply the custom bond and liveness overrides if set.
Request storage request = _getRequest(requester, identifier, timestamp, ancillaryData);
bytes32 managedRequestId = getManagedRequestId(requester, identifier, ancillaryData);
uint256 customBond = customBonds[managedRequestId][request.currency];
uint256 customBond = customBonds[managedRequestId][request.currency].amount;
if (customBond != 0) {
request.requestSettings.bond = customBond;
}
uint256 customLiveness = customLivenessValues[managedRequestId];
uint256 customLiveness = customLivenessValues[managedRequestId].liveness;
if (customLiveness != 0) {
request.requestSettings.customLiveness = customLiveness;
}
Expand Down