7201 receipt vault

Author: thedavidmeister

src/abstract/OwnerFreezable.sol

@@ -5,7 +5,7 @@ pragma solidity ^0.8.25;
 import {OwnableUpgradeable} from "openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol";
 import {IOwnerFreezableV1, IERC5313} from "../interface/IOwnerFreezableV1.sol";
 
-/// @dev String ID for the OwnerFreezableV1 storage location.
+/// @dev String ID for the OwnerFreezableV1 storage location v1.
 string constant OWNER_FREEZABLE_V1_STORAGE_ID = "rain.storage.owner-freezable.1";
 
 /// @dev "rain.storage.owner-freezable.1" with the erc7201 formula.
@@ -65,8 +65,9 @@ abstract contract OwnerFreezable is IOwnerFreezableV1, OwnableUpgradeable {
         mapping(address to => uint256 protectedUntil) alwaysAllowedTos;
     }
 
-    function getStorage() private pure returns (OwnerFreezableV17201Storage storage s) {
-        assembly {
+    /// @dev Accessor for the owner freezable storage.
+    function getStorageOwnerFreezable() private pure returns (OwnerFreezableV17201Storage storage s) {
+        assembly ("memory-safe") {
             s.slot := OWNER_FREEZABLE_V1_STORAGE_LOCATION
         }
     }
@@ -78,25 +79,25 @@ abstract contract OwnerFreezable is IOwnerFreezableV1, OwnableUpgradeable {
 
     /// @inheritdoc IOwnerFreezableV1
     function ownerFrozenUntil() external view returns (uint256) {
-        OwnerFreezableV17201Storage storage s = getStorage();
+        OwnerFreezableV17201Storage storage s = getStorageOwnerFreezable();
         return s.ownerFrozenUntil;
     }
 
     /// @inheritdoc IOwnerFreezableV1
     function ownerFreezeAlwaysAllowedFrom(address from) external view returns (uint256) {
-        OwnerFreezableV17201Storage storage s = getStorage();
+        OwnerFreezableV17201Storage storage s = getStorageOwnerFreezable();
         return s.alwaysAllowedFroms[from];
     }
 
     /// @inheritdoc IOwnerFreezableV1
     function ownerFreezeAlwaysAllowedTo(address to) external view returns (uint256) {
-        OwnerFreezableV17201Storage storage s = getStorage();
+        OwnerFreezableV17201Storage storage s = getStorageOwnerFreezable();
         return s.alwaysAllowedTos[to];
     }
 
     /// @inheritdoc IOwnerFreezableV1
     function ownerFreezeUntil(uint256 freezeUntil) external onlyOwner {
-        OwnerFreezableV17201Storage storage s = getStorage();
+        OwnerFreezableV17201Storage storage s = getStorageOwnerFreezable();
         // Freezing is additive so we can only increase the freeze time.
         // It is a no-op on the state if the new freeze time is less than the
         // current one.
@@ -118,7 +119,7 @@ abstract contract OwnerFreezable is IOwnerFreezableV1, OwnableUpgradeable {
             revert OwnerFreezeAlwaysAllowedFromZero(from);
         }
 
-        OwnerFreezableV17201Storage storage s = getStorage();
+        OwnerFreezableV17201Storage storage s = getStorageOwnerFreezable();
 
         // Adding a `from` is additive so we can only increase the protected
         // time. It is a no-op on the state if the new protected time is less
@@ -134,7 +135,7 @@ abstract contract OwnerFreezable is IOwnerFreezableV1, OwnableUpgradeable {
 
     /// @inheritdoc IOwnerFreezableV1
     function ownerFreezeStopAlwaysAllowingFrom(address from) external onlyOwner {
-        OwnerFreezableV17201Storage storage s = getStorage();
+        OwnerFreezableV17201Storage storage s = getStorageOwnerFreezable();
 
         // If the current time is after the protection for this `from` then
         // we can remove it. Otherwise we revert to respect the protection.
@@ -154,7 +155,7 @@ abstract contract OwnerFreezable is IOwnerFreezableV1, OwnableUpgradeable {
             revert IOwnerFreezableV1.OwnerFreezeAlwaysAllowedToZero(to);
         }
 
-        OwnerFreezableV17201Storage storage s = getStorage();
+        OwnerFreezableV17201Storage storage s = getStorageOwnerFreezable();
 
         // Adding a `to` is additive so we can only increase the protected time.
         // It is a no-op on the state if the new protected time is less than the
@@ -170,7 +171,7 @@ abstract contract OwnerFreezable is IOwnerFreezableV1, OwnableUpgradeable {
 
     /// @inheritdoc IOwnerFreezableV1
     function ownerFreezeStopAlwaysAllowingTo(address to) external onlyOwner {
-        OwnerFreezableV17201Storage storage s = getStorage();
+        OwnerFreezableV17201Storage storage s = getStorageOwnerFreezable();
 
         // If the current time is after the protection for this `to` then
         // we can remove it. Otherwise we revert to respect the protection.
@@ -187,7 +188,7 @@ abstract contract OwnerFreezable is IOwnerFreezableV1, OwnableUpgradeable {
     /// @param from The address that tokens are being sent from.
     /// @param to The address that tokens are being sent to.
     function ownerFreezeCheckTransaction(address from, address to) internal view {
-        OwnerFreezableV17201Storage storage s = getStorage();
+        OwnerFreezableV17201Storage storage s = getStorageOwnerFreezable();
 
         // We either simply revert or no-op for this check.
         // Revert if the contract is frozen and neither the `from` nor `to` are

src/abstract/ReceiptVault.sol

@@ -32,6 +32,12 @@ import {ERC165Upgradeable as ERC165} from
     "openzeppelin-contracts-upgradeable/contracts/utils/introspection/ERC165Upgradeable.sol";
 import {IERC20Metadata} from "openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+/// @dev String ID for the ReceiptVault storage location v1.
+string constant RECEIPT_VAULT_V1_STORAGE_ID = "rain.storage.receipt-vault.1";
+
+/// @dev "rain.storage.receipt-vault.1" with the erc7201 formula.
+bytes32 constant RECEIPT_VAULT_V1_STORAGE_LOCATION = 0x04485615b1da6633eec3daf54aadca2a89ef8b155744e223a046f4a6e38be700;
+
 /// Represents the action being taken on shares, ostensibly for calculating a
 /// ratio.
 enum ShareAction {
@@ -108,11 +114,11 @@ struct ReceiptVaultConfig {
 /// free market layer.
 abstract contract ReceiptVault is
     IReceiptManagerV2,
+    IReceiptVaultV3,
+    ICloneableV2,
     Multicall,
     ReentrancyGuard,
     ERC20,
-    IReceiptVaultV3,
-    ICloneableV2,
     ERC165
 {
     using LibFixedPointDecimalArithmeticOpenZeppelin for uint256;
@@ -123,11 +129,21 @@ abstract contract ReceiptVault is
     //slither-disable-next-line naming-convention
     IReceiptV3 internal immutable I_RECEIPT_IMPLEMENTATION;
 
-    /// Underlying ERC4626 asset.
-    IERC20 internal sAsset;
-    /// ERC1155 Receipt owned by this receipt vault for the purpose of tracking
-    /// mints and enforcing integrity of subsequent burns.
-    IReceiptV3 internal sReceipt;
+    /// @param asset Underlying ERC4626 asset.
+    /// @param receipt ERC1155 Receipt owned by this receipt vault for the
+    /// purpose of tracking mints and enforcing integrity of subsequent burns.
+    /// @custom:storage-location erc7201:rain.storage.receipt-vault.1
+    struct ReceiptVaultV17201Storage {
+        IERC20 asset;
+        IReceiptV3 receipt;
+    }
+
+    /// @dev Accessor to the receipt vault storage.
+    function getStorageReceiptVault() private pure returns (ReceiptVaultV17201Storage storage s) {
+        assembly ("memory-safe") {
+            s.slot := RECEIPT_VAULT_V1_STORAGE_LOCATION
+        }
+    }
 
     /// `ReceiptVault` is intended to be cloned and initialized by a
     /// `ReceiptVaultFactory` so is an implementation contract that can't itself
@@ -153,14 +169,16 @@ abstract contract ReceiptVault is
     function __ReceiptVault_init(VaultConfig memory config) internal virtual {
         __Multicall_init();
         __ERC20_init(config.name, config.symbol);
-        sAsset = IERC20(config.asset);
 
         // Slither false positive here due to it being impossible to set the
         // receipt before it has been deployed.
         // slither-disable-next-line reentrancy-benign
         IReceiptV3 managedReceipt =
             IReceiptV3(I_FACTORY.clone(address(I_RECEIPT_IMPLEMENTATION), abi.encode(address(this))));
-        sReceipt = managedReceipt;
+
+        ReceiptVaultV17201Storage storage s = getStorageReceiptVault();
+        s.asset = IERC20(config.asset);
+        s.receipt = managedReceipt;
 
         // Sanity check here. Should always be true as we cloned the receipt
         // from the factory ourselves just above.
@@ -179,12 +197,14 @@ abstract contract ReceiptVault is
 
     /// @inheritdoc IReceiptVaultV1
     function asset() public view virtual returns (address) {
-        return address(sAsset);
+        ReceiptVaultV17201Storage storage s = getStorageReceiptVault();
+        return address(s.asset);
     }
 
     /// @inheritdoc IERC20Metadata
     function decimals() public view virtual override returns (uint8) {
-        address lAsset = address(sAsset);
+        ReceiptVaultV17201Storage storage s = getStorageReceiptVault();
+        address lAsset = address(s.asset);
         uint256 lAssetCodeSize;
         assembly ("memory-safe") {
             lAssetCodeSize := extcodesize(lAsset)
@@ -365,7 +385,8 @@ abstract contract ReceiptVault is
 
     /// @inheritdoc IReceiptVaultV3
     function receipt() public view virtual returns (IReceiptV3) {
-        return sReceipt;
+        ReceiptVaultV17201Storage storage s = getStorageReceiptVault();
+        return s.receipt;
     }
 
     /// Similar to `receiptInformation` on the underlying receipt but for this