feat(#3): implement tree-based nonce cancellation #55

re1ro · 2025-10-31T19:18:42Z

Summary

Implement tree-based nonce invalidation system with UI transparency and gas-efficient on-chain verification using TreeNodeLib.

Users sign a complete NonceNode tree structure showing all nonces being cancelled across chains, while the contract receives a compact proof.

Dependencies

⚠️ Depends on PR #53 (feat/tree-lib) - merge that first!
✅ Independent of PR #54 - can be reviewed/merged in parallel

Core Changes

New Structures

NonceNode - Tree structure for batch nonce cancellation
NonceTree - Compact on-chain structure (proofStructure + proof)
NonceSignature - Simplified signature struct (no salt/timestamp needed)

Leaf Structure Change

OLD: bytes32[] nonces (raw salts)
NEW: NoncesToInvalidate[] (structured with chainId)
Why: Better UI transparency - users see which chain each nonce belongs to

New Typehashes

INVALIDATE_NONCES_TYPEHASH - Single-chain nonce invalidation
MULTICHAIN_INVALIDATE_NONCES_TYPEHASH - Multi-chain tree invalidation
NONCE_NODE_TYPEHASH - Internal tree node hashing

Updated Files

src/NonceManager.sol - Tree reconstruction using TreeNodeLib
src/interfaces/INonceManager.sol - New structs and signatures

Test Coverage

New Tests:

test/TreeCancellation.t.sol (899 lines) - Comprehensive nonce cancellation tests
test/TreeCancellationExtended.t.sol (219 lines) - Extended scenarios
test/utils/NonceNodeLibTester.sol (79 lines) - Test helper

Updated Tests:

test/NonceManager.t.sol - Updated for new API

JavaScript Utilities

Complete toolkit for nonce tree construction:

utils/demo-nonceNode.js (144 lines) - Interactive demo
utils/test-nonceNode.js (247 lines) - JS test suite
utils/verify-nonceNode-solidity-match.js (220 lines) - Cross-validation between JS and Solidity

Key Benefits

✅ UI Transparency: Users see all nonces being cancelled in wallet
✅ Batch Operations: Single signature for multiple nonce cancellations
✅ Gas Efficient: O(log n) proof size with linear gas scaling
✅ API Consistency: Matches Permit3 patterns (structs, tree encoding)

API Example

Before (single-chain):

invalidateNonces(owner, deadline, invalidations, proof, signature);

After (single-chain):

NonceSignature memory sig = NonceSignature({owner, deadline, signature});
invalidateNonces(salts, sig);

After (multi-chain):

NonceTree memory tree = NonceTree({
    currentNonces: NoncesToInvalidate({chainId, salts}),
    proofStructure: proofStructure,
    proof: proof
});
invalidateNonces(tree, sig);

API Pattern Alignment

The new nonce API mirrors the permit API from PR #54:

Both use tree structures (PermitTree / NonceTree)
Both use signature structs (Signature / NonceSignature)
Both use proofStructure + proof encoding
Both support simple (single-chain) and tree-based (multi-chain) operations

Note

Some tests reference permit-tree structures (expected cross-dependency). These will be resolved naturally when both PRs are merged to main.

🤖 Generated with Claude Code

Tree-based nonce invalidation with NonceNode structure. Note: Some tests have dependencies on permit-tree structures. Core changes: - src/NonceManager.sol with tree-based invalidation - src/interfaces/INonceManager.sol with new structures - test/TreeCancellation.t.sol and TreeCancellationExtended.t.sol - JavaScript utilities for nonce trees 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

Copilot

Pull Request Overview

This PR introduces tree-based nonce cancellation functionality to the Permit3 system, enabling efficient batch nonce invalidation across multiple chains with UI transparency. The implementation uses a generic TreeNodeLib library for EIP-712 tree reconstruction and adds NonceNode structures parallel to existing PermitNode functionality.

Key Changes:

Generic TreeNodeLib for tree hash reconstruction shared between PermitNode and NonceNode
NonceNode/NonceTree structs and multi-chain nonce invalidation support
Helper utilities for tree construction and proof generation (JavaScript)
Comprehensive test coverage for tree operations and edge cases

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/lib/TreeNodeLib.sol	Generic library for EIP-712 tree node reconstruction with parameterized typehash
src/NonceManager.sol	Adds tree-based nonce invalidation with MULTICHAIN_INVALIDATE_NONCES_TYPEHASH
src/interfaces/INonceManager.sol	Adds NonceNode, NonceTree, NonceSignature structs for tree-based operations
test/utils/NonceNodeLibTester.sol	Test wrapper delegating to TreeNodeLib with NONCE_NODE_TYPEHASH
test/utils/TreeNodeLibTester.sol	Exposes TreeNodeLib functions for testing
test/utils/TestBase.sol	Adds helper functions for NonceNode hashing, proof generation, and tree operations
test/TreeNodeLib.t.sol	Comprehensive tests for generic TreeNodeLib with multiple typehashes
test/TreeCancellation.t.sol	Integration tests for tree-based nonce cancellation flow
test/TreeCancellationExtended.t.sol	Extended edge case tests for tree cancellation scenarios
test/NonceManager.t.sol	Updates existing tests to use new NonceTree/NonceSignature structs
test/ZeroAddressValidation.t.sol	Updates function signatures to match new struct-based API
utils/verify-nonceNode-solidity-match.js	Verification script ensuring JS and Solidity produce matching hashes
utils/test-nonceNode.js	Test suite for NonceNode utility functions
utils/demo-nonceNode.js	Usage demonstration for NonceNode utilities

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-31T19:20:49Z

src/NonceManager.sol

+     * @notice Generate EIP-712 hash for NoncesToInvalidate struct
+     * @dev Hashes the struct for use as a leaf in tree reconstruction
+     * @dev Uses single-nonce optimization for gas efficiency
+     * @dev Sorts salts before hashing for consistency


The documentation claims that salts are sorted before hashing, but the implementation in hashNoncesToInvalidate does not sort the salts array. The salts are hashed in the order they are provided via keccak256(abi.encodePacked(invalidations.salts)). This inconsistency between documentation and implementation could lead to confusion.

Copilot · 2025-10-31T19:20:49Z

src/NonceManager.sol

+                if (nonceNode.nonces[i].salts.length == 1) {
+                    nonceInvalidationHashes[i] = nonceNode.nonces[i].salts[0];
+                } else {
+                    // Multiple nonces - hash as NoncesToInvalidate struct (no sorting, preserve order)


Comment states 'no sorting, preserve order' but this contradicts the function-level documentation on line 189 which claims salts are sorted. The implementation correctly preserves order (no sorting), but the function-level documentation needs to be corrected.

Copilot · 2025-10-31T19:20:49Z

test/utils/TestBase.sol

+                    _sortBytes32Array(sortedSalts);
+


The test helper _hashNonceNode sorts salts within a NoncesToInvalidate struct before hashing (lines 272-276), but the production code in NonceManager.hashNoncesToInvalidate and NonceManager.hashNonceNode does NOT sort salts. This mismatch will cause test hashes to differ from production hashes when NoncesToInvalidate contains multiple nonces in non-sorted order.

Suggested change

_sortBytes32Array(sortedSalts);

# Conflicts: # test/utils/TestBase.sol

# Conflicts: # test/ZeroAddressValidation.t.sol

…tests

Remove salt sorting from test helper _hashNonceNode to match production NonceManager.hashNoncesToInvalidate behavior. Update documentation to clarify that salt order is preserved (not sorted). This fixes the test-production mismatch identified by GitHub Copilot: - Test was sorting salts before hashing - Production was preserving order - Different inputs could produce different hashes between test and prod Now both test and production preserve salt order for consistent hashing. Addresses: GitHub Copilot review comment on PR #55

fish-sammy · 2025-11-10T17:15:05Z

utils/demo-nonceNode.js

Don't think any of these JS files are supposed to be comitted.

fish-sammy · 2025-11-10T17:21:45Z

src/interfaces/INonceManager.sol

-     * @param signature EIP-712 signature authorizing the invalidation
+     * @param sig Signature data (owner, deadline, signature)
     */
    function invalidateNonces(


Same question here. Can't we just treat single-chain cancellation as a sing-node tree?

fish-sammy · 2025-11-10T17:43:19Z

src/NonceManager.sol

+        if (tree.currentChainInvalidations.salts.length == 0) {
+            revert EmptyArray();
+        }


You are not checking emptyness in the other invalidateNonces above, and also not checking in the Permit3 corresponding function, so why bother here? Also, hashNoncesToInvalidate expectes empty salts and handles it no problem.

fish-sammy · 2025-11-10T17:45:20Z

src/NonceManager.sol

+     * @param nonceNode The nonce node tree structure to hash
+     * @return bytes32 The EIP-712 hash of the complete nonce node structure
+     */
+    function hashNonceNode(


internal function but never used?!

Address PR feedback: - Remove unused hashNonceNode internal function - Remove redundant emptiness check (handled by hashNoncesToInvalidate) - Remove unused _sortBytes32Array helper function Changes: - Removed hashNonceNode function (only used tests via _hashNonceNode) - Removed redundant empty array check at line 164-166 - Removed orphaned _sortBytes32Array function after hashNonceNode removal - Simplified code by trusting hashNoncesToInvalidate to handle edge cases

…me7mv5nn2QUpN6XQ refactor: remove unused code and redundant check in NonceManager

Copilot AI review requested due to automatic review settings October 31, 2025 19:18

Copilot AI reviewed Oct 31, 2025

View reviewed changes

re1ro added 3 commits October 31, 2025 15:26

style: run forge fmt

14850aa

Merge branch 'feat/permit-tree' into feat/nonce-tree

775112c

# Conflicts: # test/utils/TestBase.sol

Merge branch 'feat/permit-tree' into feat/nonce-tree

c6fb850

# Conflicts: # test/utils/TestBase.sol

re1ro changed the base branch from main to feat/permit-tree October 31, 2025 19:37

re1ro changed the title ~~feat: implement tree-based nonce cancellation~~ feat(#3): implement tree-based nonce cancellation Oct 31, 2025

re1ro added 4 commits October 31, 2025 15:40

Merge branch 'feat/permit-tree' into feat/nonce-tree

b91054d

# Conflicts: # test/ZeroAddressValidation.t.sol

refactor: streamline witness initialization in ZeroAddressValidation …

d2f5dbe

…tests

Merge branch 'feat/permit-tree' into feat/nonce-tree

e20631d

fish-sammy requested changes Nov 10, 2025

View reviewed changes

claude and others added 3 commits November 21, 2025 22:29

fix: correct indentation in test comment

ae16ef1

Merge pull request #58 from eco/claude/pr55-address-feedback-01Mu5xjL…

d9ebe10

…me7mv5nn2QUpN6XQ refactor: remove unused code and redundant check in NonceManager

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(#3): implement tree-based nonce cancellation #55

feat(#3): implement tree-based nonce cancellation #55

Uh oh!

re1ro commented Oct 31, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 31, 2025

Uh oh!

Copilot AI Oct 31, 2025

Uh oh!

Copilot AI Oct 31, 2025

Uh oh!

fish-sammy Nov 10, 2025

Uh oh!

fish-sammy Nov 10, 2025

Uh oh!

fish-sammy Nov 10, 2025

Uh oh!

fish-sammy Nov 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat(#3): implement tree-based nonce cancellation #55

Are you sure you want to change the base?

feat(#3): implement tree-based nonce cancellation #55

Uh oh!

Conversation

re1ro commented Oct 31, 2025

Summary

Dependencies

Core Changes

New Structures

Leaf Structure Change

New Typehashes

Updated Files

Test Coverage

JavaScript Utilities

Key Benefits

API Example

API Pattern Alignment

Note

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

fish-sammy Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

fish-sammy Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

fish-sammy Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

fish-sammy Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants