refactor(host-contracts): rename ACL delegation methods and events #1079
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,25 +44,25 @@ contract ACL is | |
| */ | ||
| error DelegateCannotBeContractAddress(address contractAddress); | ||
|
|
||
| /** | ||
| * @notice Returned if the requested expiration date was already set to same expiration for (delegate,contractAddress). | ||
| * @param delegator The address of the account that delegates access to its handles. | ||
| * @param delegate The address of the account that receives the delegation. | ||
| * @param contractAddress The contract address to delegate access to. | ||
| * @param expirationDate The expiration date for the intended delegation. | ||
| */ | ||
| error ExpirationDateAlreadySetToSameValue( | ||
| address delegator, | ||
| address delegate, | ||
| address contractAddress, | ||
| uint256 expirationDate | ||
| ); | ||
|
|
||
| /// @notice Returned if the requested expiration date for user decryption delegation is before the next hour. | ||
| error ExpirationDateBeforeOneHour(); | ||
|
|
||
| /// @notice Returned if the requested expiration date for user decryption delegation is after the next year. | ||
| error ExpirationDateAfterOneYear(); | ||
|
|
||
| /// @notice Returned if the handlesList array is empty. | ||
| error HandlesListIsEmpty(); | ||
|
|
@@ -97,13 +97,13 @@ contract ACL is | |
| error SenderNotAllowed(address sender); | ||
|
|
||
| /** | ||
| * @notice Struct that represents a user decryption delegation. | ||
| * @dev The `delegationCounter` is incremented at each delegation or revocation | ||
| * to allow off-chain clients to track changes. | ||
| */ | ||
| struct UserDecryptionDelegation { | ||
| /// @notice Date when the user decryption delegation expires. | ||
| uint64 expirationDate; | ||
| /// @notice The last block number when a delegation or revocation happened. | ||
| uint64 lastBlockDelegateOrRevoke; | ||
| /// @notice Counter that tracks the order of each delegation or revocation. | ||
|
|
@@ -114,7 +114,10 @@ contract ACL is | |
| struct ACLStorage { | ||
| mapping(bytes32 handle => mapping(address account => bool isAllowed)) persistedAllowedPairs; | ||
| mapping(bytes32 handle => bool isAllowedForDecryption) allowedForDecryption; | ||
| // prettier-ignore | ||
| mapping(address account => | ||
| mapping(address delegate => mapping(address contractAddress => UserDecryptionDelegation delegation))) | ||
| userDecryptionDelegations; | ||
| } | ||
|
|
||
| /// @notice Name of the contract. | ||
|
|
@@ -224,34 +227,36 @@ contract ACL is | |
| } | ||
|
|
||
| /** | ||
| * @notice Delegates an account the access to handles for user decryption, for instance, in the context of account | ||
| * abstraction for issuing user decryption requests from a smart contract account. | ||
| * @param delegate The address of the account that receives the delegation. | ||
| * @param contractAddress The contract address to delegate access to. | ||
| * @param expirationDate Expiration date in seconds, between 1 hour and 1 year in the future. | ||
| */ | ||
| function delegateForUserDecryption( | ||
| address delegate, | ||
| address contractAddress, | ||
| uint64 expirationDate | ||
| ) public virtual whenNotPaused { | ||
| if (expirationDate < block.timestamp + 1 hours) { | ||
| revert ExpirationDateBeforeOneHour(); | ||
| } | ||
| if (expirationDate > block.timestamp + 365 days) { | ||
|
There was a problem hiding this comment. I thought this check needed to be deleted, after the OZ requirement... |
||
| revert ExpirationDateAfterOneYear(); | ||
| } | ||
|
|
||
| ACLStorage storage $ = _getACLStorage(); | ||
| UserDecryptionDelegation storage userDecryptionDelegation = $.userDecryptionDelegations[msg.sender][delegate][ | ||
| contractAddress | ||
| ]; | ||
| uint256 blockNumber = block.number; | ||
|
|
||
| if (userDecryptionDelegation.lastBlockDelegateOrRevoke == blockNumber) { | ||
| revert AlreadyDelegatedOrRevokedInSameBlock(msg.sender, delegate, contractAddress, blockNumber); | ||
| } | ||
|
|
||
| // Set the last block where the delegation happened. | ||
| userDecryptionDelegation.lastBlockDelegateOrRevoke = uint64(blockNumber); | ||
|
|
||
| if (contractAddress == msg.sender) { | ||
| revert SenderCannotBeContractAddress(contractAddress); | ||
|
|
@@ -263,51 +268,59 @@ contract ACL is | |
| revert DelegateCannotBeContractAddress(contractAddress); | ||
| } | ||
|
|
||
| uint64 oldExpirationDate = userDecryptionDelegation.expirationDate; | ||
| uint64 newExpirationDate = expirationDate; | ||
| if (oldExpirationDate == newExpirationDate) { | ||
| revert ExpirationDateAlreadySetToSameValue(msg.sender, delegate, contractAddress, oldExpirationDate); | ||
| } | ||
|
|
||
| // Set the delegation expiration date. | ||
| userDecryptionDelegation.expirationDate = newExpirationDate; | ||
|
|
||
| emit DelegatedForUserDecryption( | ||
| msg.sender, | ||
| delegate, | ||
| contractAddress, | ||
| ++userDecryptionDelegation.delegationCounter, | ||
| oldExpirationDate, | ||
| newExpirationDate | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Revokes the access to handles for user decryption delegated to an account. | ||
| * @param delegate The address of the account that receives the delegation. | ||
| * @param contractAddress The contract address to delegate access to. | ||
| */ | ||
| function revokeDelegationForUserDecryption(address delegate, address contractAddress) public virtual whenNotPaused { | ||
| ACLStorage storage $ = _getACLStorage(); | ||
| UserDecryptionDelegation storage userDecryptionDelegation = $.userDecryptionDelegations[msg.sender][delegate][ | ||
| contractAddress | ||
| ]; | ||
| uint256 blockNumber = block.number; | ||
|
|
||
| if (userDecryptionDelegation.lastBlockDelegateOrRevoke == blockNumber) { | ||
| revert AlreadyDelegatedOrRevokedInSameBlock(msg.sender, delegate, contractAddress, blockNumber); | ||
| } | ||
|
|
||
| // Set the last block where the revocation happened. | ||
| userDecryptionDelegation.lastBlockDelegateOrRevoke = uint64(blockNumber); | ||
|
|
||
| uint64 oldExpirationDate = userDecryptionDelegation.expirationDate; | ||
| if (oldExpirationDate == 0) { | ||
| revert NotDelegatedYet(msg.sender, delegate, contractAddress); | ||
| } | ||
|
|
||
| // Reset the delegation expiration date. | ||
| userDecryptionDelegation.expirationDate = 0; | ||
|
|
||
| emit RevokedDelegationForUserDecryption( | ||
| msg.sender, | ||
| delegate, | ||
| contractAddress, | ||
| ++userDecryptionDelegation.delegationCounter, | ||
| oldExpirationDate | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -332,43 +345,22 @@ contract ACL is | |
| } | ||
|
|
||
| /** | ||
| * @notice Get the expiration date of a delegation for user decryption. | ||
| * @param delegate The address of the account that receives the delegation. | ||
| * @param delegator The address of the account that delegates access to its handles. | ||
| * @param contractAddress The contract address to delegate access to. | ||
| * @return expirationDate The expiration date for the user decryption delegation (0 means delegation is inactive). | ||
| */ | ||
| function getUserDecryptionDelegationExpirationDate( | ||
| address delegate, | ||
| address delegator, | ||
| address contractAddress | ||
| ) public view virtual returns (uint64) { | ||
| ACLStorage storage $ = _getACLStorage(); | ||
| UserDecryptionDelegation storage userDecryptionDelegation = $.userDecryptionDelegations[delegator][delegate][ | ||
| contractAddress | ||
| ]; | ||
| return userDecryptionDelegation.expirationDate; | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -424,6 +416,30 @@ contract ACL is | |
| return $.allowedForDecryption[handle]; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Returns whether an account is delegated to access the handle for user decryption. | ||
| * @param delegate The address of the account that receives the delegation. | ||
| * @param delegator The address of the account that delegates access to its handles. | ||
| * @param handle The handle to check for delegated user decryption. | ||
| * @param contractAddress The contract address to delegate access to. | ||
| * @return isDelegatedForUserDecryption Whether the handle can be accessed for delegated user decryption. | ||
| */ | ||
| function isHandleDelegatedForUserDecryption( | ||
| address delegator, | ||
| address delegate, | ||
| address contractAddress, | ||
| bytes32 handle | ||
| ) public view virtual returns (bool) { | ||
| ACLStorage storage $ = _getACLStorage(); | ||
| UserDecryptionDelegation storage userDecryptionDelegation = $.userDecryptionDelegations[delegator][delegate][ | ||
| contractAddress | ||
| ]; | ||
| return | ||
| $.persistedAllowedPairs[handle][delegator] && | ||
| $.persistedAllowedPairs[handle][contractAddress] && | ||
| userDecryptionDelegation.expirationDate >= block.timestamp; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Returns `true` if address `a` is allowed to use `c` and `false` otherwise. | ||
| * @param handle Handle. | ||
|
|
||
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.