docs(cache): document contract-cache layer and add-a-reader recipe#489
Open
Tobi-8 wants to merge 1 commit into
Open
docs(cache): document contract-cache layer and add-a-reader recipe#489Tobi-8 wants to merge 1 commit into
Tobi-8 wants to merge 1 commit into
Conversation
Adds TSDoc to cache/registry plus docs/contract-cache.md covering TTL, invalidation, and a step-by-step new cached read recipe.
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
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.
Description
The frontend's contract cache layer (
lib/cache/contract-cache.ts) and registry required clear documentation to prevent misuse (e.g., caching write operations or post-transfer balances, or setting improper TTLs) and help contributors confidently add new cached reads.This PR introduces comprehensive documentation for the caching subsystem without altering its core behavior.
Changes Made
lib/cache/contract-cache.tsandlib/cache/registry.tsdetailing parameters, invalidation, safety protocols, and TTL semantics.docs/contract-cache.mdwhich thoroughly explains:README.md.tests/unit/cached-wrappers.test.tswhere mock Stellar addresses were 58 characters long. They have been updated to 56 characters so they validate seamlessly against theSTELLAR_ADDRESS_REGEX.Verification
npm run test:unit).npm run lint).closes #477