docs(escrow): authoritative DataKey storage reference#296
Open
Vvictor-commits wants to merge 1 commit into
Open
docs(escrow): authoritative DataKey storage reference#296Vvictor-commits wants to merge 1 commit into
Vvictor-commits wants to merge 1 commit into
Conversation
- Rewrite docs/escrow-data-model.md with complete DataKey table: storage tier, value type, default-on-absence, schema version added - Add DistributedPrincipal, MaxPerInvestorCap, PendingAdmin, AllowlistActive, InvestorRefunded — all missing from previous doc - Document status == 4 (cancelled) in the state machine table - Add persistent vs instance TTL mismatch warning for allowlist keys - Add two tests in escrow/src/tests/init.rs: datakey_defaults_on_fresh_init: verifies every absent-default key datakey_distributed_principal_starts_at_zero_and_increments_on_refund
|
@Vvictor-commits Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Closes #273
Summary
Rewrites
docs/escrow-data-model.mdinto a complete, code-aligned reference for everyDataKeyvariant. Adds two tests that verify documented defaults hold at runtime.What was missing from the previous doc
MaxPerInvestorCap,PendingAdmin,AllowlistActive,InvestorRefunded,DistributedPrincipalstatus == 4(cancelled) not documented in the state machine tableInvestorAllowlistedChanges
docs/escrow-data-model.mdDataKeytable: storage tier, value type, default when absent, schema version added, mutabilitylib.rsDistributedPrincipalliability floor, double-refund guard,InvestorClaimedevent-only semantics, TTL mismatch warningescrow/src/tests/init.rsdatakey_defaults_on_fresh_init— verifies every key documented as absent-default actually returns its default on a fresh deploymentdatakey_distributed_principal_starts_at_zero_and_increments_on_refund— verifies the counter introduced in the liability floor PR