Skip to content

docs: explain change-server engine contract#718

Open
samholmes wants to merge 1 commit intomasterfrom
docs/change-server-engine-contract
Open

docs: explain change-server engine contract#718
samholmes wants to merge 1 commit intomasterfrom
docs/change-server-engine-contract

Conversation

@samholmes
Copy link
Copy Markdown
Contributor

@samholmes samholmes commented Mar 19, 2026

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?

  • Yes
  • No

Dependencies

none

Description

none

Note

Low Risk
Low risk: documentation-only change with no runtime behavior modifications.

Overview
Adds docs/change-server-engine-contract.md, documenting the current edge-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 EthereumEngine behavior as the reference example.

Written by Cursor Bugbot for commit 47996ed. This will update automatically on new commits. Configure here.

Document the current core-to-engine change-server handshake so future
engine integrations can follow the existing protocol and checkpoint
semantics consistently.
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