Skip to content

docs: keep the typewriter README to what app developers need - #119

Open
kyscott18 wants to merge 2 commits into
mainfrom
docs/readme-cleanup
Open

kyscott18 wants to merge 2 commits into
mainfrom
docs/readme-cleanup

Conversation

@kyscott18

Copy link
Copy Markdown
Collaborator

Summary

Cleans up the typewriter README so it documents what app developers use, not how the runtime works internally.

Removed or rephrased internals

  • The embedded EVM (revm), storage proxies, and the "revm-backed storage mirror". typewriter.state and typewriter.accounts are now described by what they return.
  • Crash recovery internals (raw slot writes, rehydration). It now says accepted mutations survive a restart.
  • The keccak preimage mechanism behind Object.keys on mappings. Only the visible behavior is kept.
  • The Ponder-inspired reorg detection algorithm.
  • Startup internals (migrations, forge build, reading the AST). What's kept is what users need: a Foundry project, with forge on the PATH.
  • The scheduler-only execute(Batch[], …) ABI and how SCHEDULER/DOMAIN_SEPARATOR are declared. Force inclusion (enqueue, forceExecute, the event) stays, as the user-facing escape hatch.
  • The note that state's visibility is bypassed by direct slot reads.

Fixed stale examples

  • The Concepts mutation was a free executeTransfer function. It's now a TransferMutation library, like the Mutations section describes.
  • The FORCE_INCLUSION_DELAY constructor assigned SCHEDULER itself. It now passes scheduler to Typewriter(scheduler).

Root README. It had drifted from the package README and documented features that no longer exist: a safe status, confirmations.safeBlockDepth, onFatalError, and a numeric mutation id. It's now an exact copy of packages/typewriter/README.md.

Merges cleanly with #116 (checked with git merge-tree), and the merged root and package READMEs are identical.

🤖 Generated with Claude Code

kyscott18 and others added 2 commits November 2, 2026 20:20
Drop internals (revm, storage proxies, slot-write rehydration, preimages, the
reorg algorithm, forge/AST parsing, the scheduler-only execute ABI). Fix two
stale examples: the Concepts mutation now uses a mutation library like the
Mutations section describes, and the FORCE_INCLUSION_DELAY constructor passes
scheduler to Typewriter instead of assigning SCHEDULER. The root README had
drifted to document features that no longer exist (safe status,
onFatalError, mutation id); it is now a copy of the package README.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ct rules

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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.

1 participant