Refactor state handling and enhance caching in EthStateStorage #382
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
…eStorage - Removed unnecessary checks for genesis state in PubSignalsVerifier. - Enhanced error handling in EthStateStorage to cache genesis state correctly. - Updated StateInfo interface to enforce id as a required field. - Introduced getIsGenesisStateById utility function for better clarity. - Added tests for EthStateStorage to ensure proper caching behavior for genesis states.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors state handling in the Polygon ID SDK to streamline genesis state verification and improve caching behavior. The main changes move genesis state validation logic from PubSignalsVerifier into EthStateStorage, consolidate duplicate code into a utility function, and enforce stricter type requirements.
Key Changes
- Extracted
getIsGenesisStateByIdutility function to eliminate code duplication and improve maintainability - Enhanced
EthStateStorage.getStateInfoByIdAndStateto handle genesis states that don't exist in the smart contract by verifying if the state is a valid genesis state - Simplified
PubSignalsVerifier.resolveby delegating genesis state logic to the storage layer - Made
StateInfo.ida required field (was optional) to improve type safety
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/storage/eth-state-storage.test.ts | New test file validating genesis state caching behavior |
| tests/proofs/sig-onchain.test.ts | Added explicit type annotation for merklizeOpts |
| tests/handlers/auth.test.ts | Added explicit type annotation for merklizeOpts |
| tests/credentials/credential-validation.test.ts | Updated mock StateInfo to include required id field |
| src/utils/did-helper.ts | Extracted getIsGenesisStateById utility function |
| src/storage/entities/state.ts | Made id field required in StateInfo interface |
| src/storage/blockchain/state.ts | Enhanced genesis state handling with error checking and caching; introduced defaultStateInfo constant |
| src/proof/verifiers/pub-signals-verifier.ts | Simplified resolve method by removing genesis state logic |
| package.json | Version bumped to 1.38.8 |
| package-lock.json | Dependency tree updates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
volodymyr-basiuk
approved these changes
Dec 29, 2025
vmidyllic
approved these changes
Dec 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Streamline state handling in PubSignalsVerifier and EthStateStorage. Improve error handling and enforce required fields in StateInfo. Introduce a utility function for clarity and add tests to ensure proper caching behavior for genesis states. Update version to 1.38.8.