OpenZeppelin / OpenZeppelin/compact-contracts
dev: move the concurrency harness rationale into a design doc
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
The module doc of contracts/test-utils/concurrency/backend.ts carries the reasoning behind the dry replay harness: why a conflict is reproduced by building two calls on one snapshot, why classification replays against the build state, and how the live backend maps onto the same contract. It is good material in the wrong place; a reader of the harness API has to scroll past it, and a reader looking for the design has no reason to open that file.
Move it to docs/design/ as a concurrency-harness design doc and leave backend.ts with a one-paragraph summary and a link.
Raised in #743 review: https://github.com/OpenZeppelin/compact-contracts/pull/743#discussion_r3875930622
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the module documentation in contracts/test-utils/concurrency/backend.ts and review the related concurrency harness context from #743. Move the rationale into a design document under docs/design/, then leave a one-paragraph summary and link in backend.ts; done when both the API module and design-document readers can find the appropriate explanation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 86/100