Open
Conversation
Document the current core-to-engine change-server handshake so future engine integrations can follow the existing protocol and checkpoint semantics consistently.
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.
Document the current core-to-engine change-server handshake so future engine integrations can follow the existing protocol and checkpoint semantics consistently.
CHANGELOG
Does this branch warrant an entry to the CHANGELOG?
Dependencies
noneDescription
noneNote
Low Risk
Low risk: documentation-only change with no runtime behavior modifications.
Overview
Adds
docs/change-server-engine-contract.md, documenting the currentedge-core-js��currency engine handshake for change-server integration (startup state inputs, engine callbacks,syncNetwork()wakeup vs polling behavior, and checkpoint semantics).Also captures the change-server websocket JSON-RPC subscribe/update protocol, the core-side subscription state machine and fallback cases, and provides an engine-author checklist plus current
EthereumEnginebehavior as the reference example.Written by Cursor Bugbot for commit 47996ed. This will update automatically on new commits. Configure here.