Skip to content

docs(architecture): correct create_lock signature, budget and coverage claims (#30) - #33

Open
jdjioe5-cpu wants to merge 1 commit into
Kinlock-Org:mainfrom
jdjioe5-cpu:docs/reconcile-architecture-claims
Open

jdjioe5-cpu wants to merge 1 commit into
Kinlock-Org:mainfrom
jdjioe5-cpu:docs/reconcile-architecture-claims

Conversation

@jdjioe5-cpu

Copy link
Copy Markdown

Closes #30

What and why

Reconciles documentation claims with the actual contract implementation: corrects the create_lock signature table row in ARCHITECTURE.md (adds sender argument and TrancheInput type name), qualifies budget assertions as target planned (M1-16, blocked by M1-30) rather than enforced, and qualifies the README.md property coverage status to reflect actual assertions (invariants 1, 2, 3, 4, 7, 9) with M1-38 noted for remaining invariants.

Changes

  • docs/ARCHITECTURE.md: added sender and Vec<TrancheInput> to create_lock signature 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 state check_invariants() asserts invariants 1, 2, 3, 4, 7, 9, pointing at M1-38 for 5, 6, 8.
  • ROADMAP.md: updated Last updated date and added Changelog entry for F-18/F-19 contracts 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:

$ bash ../.github/scripts/sync-docs.sh .
(exit code 0)
$ bash ../.github/scripts/sync-docs.sh --check .
(exit code 0, no drift)

cargo test --workspace on local Windows host was not executable due to missing Linux-only stellar-cli required to compile target/wasm32v1-none/release/kinlock.wasm for upgrade_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 in Kinlock-Org/.github prepared 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.

…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
@jdjioe5-cpu
jdjioe5-cpu requested a review from a team as a code owner October 17, 2026 09:36
@jdjioe5-cpu

Copy link
Copy Markdown
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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Three doc statements contradict the code: create_lock signature, budget tests, property coverage

2 participants