Skip to content

docs: fix documentation formatting in IPermit3 #57

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
re1ro merged 2 commits into from
Nov 22, 2025
Merged

docs: fix documentation formatting in IPermit3 #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14076a1
docs: fix documentation formatting in IPermit3
claude Nov 21, 2025
21c3316
fix: correct indentation in test comment
claude Nov 21, 2025
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
4 changes: 2 additions & 2 deletions src/interfaces/IPermit3.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ interface IPermit3 is IPermit, INonceManager {
* @dev Used in EIP-712 signatures to provide transparency to users about what they're signing
* @dev Can represent either leaf nodes (ChainPermits) or internal tree nodes (nested levels)
* @dev Both arrays should be ordered by hash value as merkle tree construction requires
* @param levels Child tree nodes for internal nodes (ordered by hash value)
* @param nodes Child tree nodes for internal nodes (ordered by hash value)
* @param permits Leaf nodes showing actual chain permits for user visibility (ordered by hash value)
*/
struct PermitNode {
Expand All @@ -94,8 +94,8 @@ interface IPermit3 is IPermit, INonceManager {

/**
* @notice Input struct for tree-based permits containing tree structure data
* @param proofStructure Compact tree encoding
* @param currentChainPermits Permit operations for the current chain
* @param proofStructure Compact tree encoding
* @param proof Array of hashes for proof reconstruction
*/
struct PermitTree {
Expand Down
2 changes: 1 addition & 1 deletion test/Permit3Edge.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,7 +734,7 @@ contract Permit3EdgeTest is Test {
(amount, expiration, ts) = permit3.allowance(owner, address(token), spender);
assertEq(amount, 0); // Amount remains unchanged by unlock operation
assertEq(expiration, 0); // No expiration (unlocked)
// Note: timestamp should remain from lock operation since unlock only changes expiration
// Note: timestamp should remain from lock operation since unlock only changes expiration
assertEq(ts, uint48(block.timestamp)); // Timestamp remains from lock operation
}

Expand Down