Repository navigation
docs(architecture): correct create_lock signature, budget and coverage claims (#30) - #33
Open
jdjioe5-cpu wants to merge 1 commit into
Open
jdjioe5-cpu wants to merge 1 commit into
jdjioe5-cpu wants to merge 1 commit into
Conversation
…e claims Closes Kinlock-Org#30 - Update create_lock signature row in ARCHITECTURE.md with sender and Vec<TrancheInput> - Qualify budget assertions as target planned (M1-16) rather than implemented - Qualify README status quote to reflect actual property assertions (invariants 1, 2, 3, 4, 7, 9) and note M1-38 for remaining invariants - Update ROADMAP.md changelog and timestamp - Synchronized docs across canonical and repo copies with sync-docs.sh
Author
|
Hard rules / doc sections constraining this task: AGENTS.md §1 (code is truth / stop and say so), §3 (hard rules on contract scope & dependencies), §8 (contracts repo scope), §12 (roadmap update rule), ARCHITECTURE.md §4.3 (vault interface) & §4.6 (invariants), and README.md:8 (status qualification). |
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.
Closes #30
What and why
Reconciles documentation claims with the actual contract implementation: corrects the
create_locksignature table row inARCHITECTURE.md(addssenderargument andTrancheInputtype name), qualifies budget assertions as target planned (M1-16, blocked byM1-30) rather than enforced, and qualifies theREADME.mdproperty coverage status to reflect actual assertions (invariants 1, 2, 3, 4, 7, 9) withM1-38noted for remaining invariants.Changes
docs/ARCHITECTURE.md: addedsenderandVec<TrancheInput>tocreate_locksignature row; qualified budget assertions under §9 Testing strategy as target planned.docs/ARCHITECTURE_ESSENTIALS.md: qualified budget claim under §4 Stack.README.md: qualified status quote to statecheck_invariants()asserts invariants 1, 2, 3, 4, 7, 9, pointing atM1-38for 5, 6, 8.ROADMAP.md: updatedLast updateddate and added Changelog entry forF-18/F-19contracts portion.Hard rules / invariants touched
Invariants 1, 2, 3, 4, 5, 6, 7, 8, 9 (documentation qualification only, no invariant logic modified). Hard rules: AGENTS.md §1, §3, §8.
Tests
Documentation-only change. Verified canonical sync commands:
cargo test --workspaceon local Windows host was not executable due to missing Linux-onlystellar-clirequired to compiletarget/wasm32v1-none/release/kinlock.wasmforupgrade_tests.rs, and Windows PE DLL 65,535 export symbol limit. Test suite execution is delegated to the CI workflow which builds WASM first.Docs / ADR
Updated
docs/ARCHITECTURE.md,docs/ARCHITECTURE_ESSENTIALS.md,README.md. Canonical edits inKinlock-Org/.githubprepared in parallel. No ADR needed.Roadmap
Row IDs touched:
F-18,F-19(org-owned rows, status left unchanged; contracts portion completed); Changelog entry added: yes.Assumptions and open questions
None.