BucketList state consistency invariant #5043
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
There was a problem hiding this comment.
Pull request overview
This PR introduces a new BucketListStateConsistency invariant that validates the consistency between the in-memory Soroban state cache and the live BucketList. The invariant performs comprehensive checks to ensure data integrity across multiple dimensions:
- Validates cache-BucketList synchronization for CONTRACT_DATA and CONTRACT_CODE entries
- Ensures every live Soroban entry has an associated TTL entry
- Verifies no live entry exists in both the live and hot archive BucketLists (refactored from
ArchivedStateConsistency)
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
src/invariant/BucketListStateConsistency.h |
Defines the new snapshot invariant interface |
src/invariant/BucketListStateConsistency.cpp |
Implements the 5 key consistency checks between cache and BucketList |
src/invariant/ArchivedStateConsistency.h |
Removes checkSnapshot method declaration (refactored to new invariant) |
src/invariant/ArchivedStateConsistency.cpp |
Changes from snapshot to non-snapshot invariant, removes hot archive overlap check |
src/ledger/InMemorySorobanState.h |
Adds methods to query CONTRACT_DATA and CONTRACT_CODE entry counts |
src/ledger/InMemorySorobanState.cpp |
Implements entry count accessors |
src/invariant/test/InvariantTests.cpp |
Adds comprehensive test suite with 10 test sections covering all invariant properties |
src/main/ApplicationImpl.cpp |
Registers the new invariant during application initialization |
SirTyson
force-pushed
the
in-memory-state-invariant
branch
2 times, most recently
from
3c8cb7b to
ceeb145
Compare
SirTyson
force-pushed
the
in-memory-state-invariant
branch
from
ceeb145 to
d67fb41
Compare
SirTyson
force-pushed
the
in-memory-state-invariant
branch
from
d67fb41 to
6d03a13
Compare
dmkozh
reviewed
Dec 19, 2025
| app->getInvariantManager().runStateSnapshotInvariant( | ||
| getLedgerState(), lm.getInMemorySorobanStateForTesting()), | ||
| InvariantDoesNotHold); | ||
| } |
Contributor
There was a problem hiding this comment.
Would it make sense to also verify that only contract data and code entries exist in the hot archive?
| // BucketList, along with other important properties. We check these properties: | ||
| // 1. Every live entry in the BL is reflected in the in-memory cache | ||
| // 2. No entry exists in the cache, but not the BL | ||
| // 3. Each live soroban entry also has a live TTL entry associated with it |
Contributor
There was a problem hiding this comment.
nit: We should mention somewhere that we also verify that TTLs in cache match TTLs in BL (currently that's done in step 3)
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.
Description
Resolves #5004
This PR adds the BucketListStateConsistency invariant. This is a snapshot invariant that checks the following properties:
ArchivedStateConsistency, but it has been refactored over to the new invariant).Checklist
clang-formatv8.0.0 (viamake formator the Visual Studio extension)