Repository navigation
docs: keep the typewriter README to what app developers need - #119
Merged
Merged
Conversation
…ch it to the runtime Drops runtime internals (revm, storage proxies, slot rehydration, gas formula, scheduler ABI) and fixes what no longer matches the code: uint40 authorization expiration, no "enqueued" event or force-inclusion fields, no `close` on the handle, reorgs and unknown reverts stop the server, restart reconciliation is undecided, enqueues settle in the batch's transaction, `hardfork` and database timeouts, `execute()` rejections, batchOrder names, example links, and the library-form mutation and FORCE_INCLUSION_DELAY examples. The root README is again a copy of the package README. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
kyscott18
force-pushed
the
docs/readme-cleanup
branch
from
November 5, 2026 21:30
ca30528 to
7a2da08
Compare
Adds state, execute, and signing examples to Concepts, shortens accounts, local development, and sequencing, and renames submission to "Submitting transactions". Config details move to the createTypewriter() reference, and the expiration rules move next to authorization verification. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Summary
Rewrites the typewriter README so it documents what app developers use, and matches it to the runtime on main (after #131, #147).
Wrong behavior fixed
Authorization.expirationisuint40, in the struct and the EIP-712 type string (it saiduint256)."enqueued"mutation status,isForceInclusion,queueIndex, orforceIncludedMutations: force-included mutations emit no events and get no rows.close; the runtime stops on SIGINT/SIGTERM.SettlementReorgedError/EnqueueReorgedError). Recovery is feat(typewriter): follow settlements and enqueues through reorgs #132.executionIndex); any other revert stops the server.forceExecutewhile the server was down).Missing or stale
hardforkconfig (required off Monad mainnet/testnet, including a self-started Anvil), database timeouts, defaultbatchIntervalMs,batchOrdernames and ordering of built-in/unlisted mutations.execute()rejection errors and the expiration margin; all startup contract rules.FORCE_INCLUSION_DELAYconstructor that callsTypewriter(scheduler),batchOrderwith real mutation names, syncaccountsreads, repo links (monad-developers/typewriter).Internals removed: revm, storage proxies, slot rehydration, keccak preimages, Ponder reorg algorithm, settlement gas formula, scheduler
executeABI.Root README is again an exact copy of
packages/typewriter/README.md(it still documentedsafe,confirmations,onFatalError, numericid).🤖 Generated with Claude Code