Skip to content

Conversation

@0xClandestine
Copy link
Member

Motivation:

Audit report flagged that function selector-based permissions may break on upgrades. This PR documents the limitation and its implications while improving NatSpec for clarity. (EGSL-15)

Modifications:

  • Documented function selector upgrade invalidations.
  • Improved NatSpec comments in IPermissionController.

Result:

Clearer documentation on function selector limitations and enhanced NatSpec for better code clarity.

@0xClandestine 0xClandestine added the ⚖️ Audit Fix Audit-related fixes. label Feb 13, 2025
@0xClandestine 0xClandestine self-assigned this Feb 13, 2025
Comment on lines +142 to +143
* @dev Be mindful that upgrades to the contract may invalidate the appointee's permissions.
* This is only possible if a function's selector changes (e.g. if a function's parameters are modified).
Copy link
Member Author

Choose a reason for hiding this comment

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

bump

@0xClandestine 0xClandestine force-pushed the docs/upgrades-can-invalidate-permissions branch from 76e8591 to 2a86ec1 Compare February 14, 2025 16:41
@0xClandestine 0xClandestine merged commit 7b78901 into slashing-magnitudes-fixes Feb 14, 2025
10 of 11 checks passed
@0xClandestine 0xClandestine deleted the docs/upgrades-can-invalidate-permissions branch February 14, 2025 17:36
ypatil12 pushed a commit that referenced this pull request Feb 19, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**

- Documented function selector upgrade invalidations.
- Improved NatSpec comments in `IPermissionController`.

**Result:**

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**  

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**  

- Documented function selector upgrade invalidations.  
- Improved NatSpec comments in `IPermissionController`.  

**Result:**  

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**

- Documented function selector upgrade invalidations.
- Improved NatSpec comments in `IPermissionController`.

**Result:**

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
ypatil12 pushed a commit that referenced this pull request Feb 20, 2025
**Motivation:**

Audit report flagged that function selector-based permissions may break
on upgrades. This PR documents the limitation and its implications while
improving NatSpec for clarity. (EGSL-15)

**Modifications:**

- Documented function selector upgrade invalidations.
- Improved NatSpec comments in `IPermissionController`.

**Result:**

Clearer documentation on function selector limitations and enhanced
NatSpec for better code clarity.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

⚖️ Audit Fix Audit-related fixes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants