Standardize all properties #83
Open
Conversation
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
added 5 commits
November 27, 2025 18:24
…ausable, IncreaseAllowance) Applied comprehensive documentation standards to all ERC20 Internal property files: - ERC20BurnableProperties.sol (3 properties) - ERC20MintableProperties.sol (1 property) - ERC20PausableProperties.sol (2 properties) - ERC20IncreaseAllowanceProperties.sol (2 properties) Changes per file: - Added comprehensive contract-level NatSpec documentation - Organized properties into logical sections with standardized headers - Added full NatSpec to all properties (@title, @notice, @dev tags) - Documented testing mode (INTERNAL) for each property - Added plain English invariant descriptions - Assigned unique property IDs (ERC20-BURN-001 through ERC20-ALLOWANCE-MODIFY-002) - Added detailed explanations of why each property matters This is part 1 of standardizing all 23 property files in the repository. Remaining: 19 files (ERC20 External, ERC721, ERC4626, Math)
Applied comprehensive documentation standards to all ERC20 External property files: - ERC20ExternalBasicProperties.sol (18 properties) - ERC20ExternalBurnableProperties.sol (3 properties) - ERC20ExternalMintableProperties.sol (1 property) - ERC20ExternalPausableProperties.sol (2 properties) - ERC20ExternalIncreaseAllowanceProperties.sol (2 properties) Key differences from Internal properties: - Testing Mode: EXTERNAL (tests through interface, not inheritance) - Property IDs use 051+ range to distinguish from internal - Usage examples show external testing pattern All files now have: - Comprehensive contract-level NatSpec - Organized sections with standardized headers - Full NatSpec on every property - Plain English invariant descriptions - Unique property IDs (ERC20-EXTERNAL-*) Progress: 9/23 files complete (34 properties standardized)
Applied comprehensive documentation standards to all ERC721 property files: Internal (19 properties): - ERC721BasicProperties.sol (11 properties) - ERC721BurnableProperties.sol (6 properties) - ERC721MintableProperties.sol (2 properties) External (19 properties): - ERC721ExternalBasicProperties.sol (11 properties) - ERC721ExternalBurnableProperties.sol (6 properties) - ERC721ExternalMintableProperties.sol (2 properties) Property categories: OWNERSHIP, APPROVAL, TRANSFER, BURN, MINT Property IDs: - Internal: ERC721-[CATEGORY]-001 through 019 - External: ERC721-EXTERNAL-[CATEGORY]-051 through 069 All files now have comprehensive NatSpec, organized sections, plain English invariants, and unique property IDs. Progress: 15/23 files complete (72 properties standardized)
Applied comprehensive documentation standards to all ERC4626 vault property files: - FunctionalAccountingProps.sol (4 properties) - MustNotRevertProps.sol (9 properties) - RedeemUsingApprovalProps.sol (4 properties) - RoundingProps.sol (14 properties) - SecurityProps.sol (2 properties) - SenderIndependentProps.sol (6 properties) - VaultProxy.sol (9 utility functions) Property categories: ACCOUNTING, AVAILABILITY, APPROVAL, ROUNDING, SECURITY, INDEPENDENCE, PROXY Property IDs: ERC4626-[CATEGORY]-001 through 045 These properties test critical vault mechanics including: - Deposit/mint/redeem/withdraw accounting - Rounding direction (always favor the vault) - Economic attack prevention (inflation attacks) - View function reliability - Approval mechanisms All files now have comprehensive NatSpec, organized sections, plain English invariants, and unique property IDs. Progress: 22/23 files complete (114 properties standardized)
Applied comprehensive documentation standards to ABDKMath64x64PropertyTests.sol, the largest property file with 106 mathematical properties for fixed-point arithmetic. Property breakdown by operation: - Addition (9): MATH-ADD-001 through 009 - Subtraction (9): MATH-SUB-001 through 009 - Multiplication (7): MATH-MUL-001 through 007 - Division (8): MATH-DIV-001 through 008 - Negation (5): MATH-NEG-001 through 005 - Absolute Value (6): MATH-ABS-001 through 006 - Inverse (9): MATH-INV-001 through 009 - Average (5): MATH-AVG-001 through 005 - Geometric Average (5): MATH-GAVG-001 through 005 - Power (11): MATH-POW-001 through 011 - Square Root (7): MATH-SQRT-001 through 007 - Logarithms (12): MATH-LOG-001 through 012 - Exponentials (9): MATH-EXP-001 through 009 Testing Mode: ISOLATED (pure math functions, no state) Properties test: - Fundamental arithmetic laws (commutativity, associativity) - Edge cases (overflow, underflow, zero, max values) - Inverse relationships (log-exp, sqrt-pow) - Precision and rounding behavior - Domain constraints All 106 properties now have comprehensive NatSpec, plain English invariants, and unique property IDs. 🎉 COMPLETE: All 23/23 property files standardized (220 properties total)!
omarinuwa
requested review from
bsamuels453 and
glarregay-tob
as code owners
|
Omar Inuwa seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.