-
Notifications
You must be signed in to change notification settings - Fork 9
update signal service documentation #154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
It has some major and minor differences with the current code base. I think it will be easier to create a fresh document
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe documentation for SignalService is rewritten to present a contract-centric cross-chain signaling model based on immutable commitments and Merkle proofs, detailing deployment across chains, proof sourcing via providers, and integration with ETH and token bridges. Prior fast/slow pathways are removed in favor of a consolidated verification flow. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant SrcApp as Source App
participant SrcSig as SignalService (Source)
participant Provider as Provider (CheckpointTracker/Anchor)
participant DstSig as SignalService (Destination)
participant DstApp as Destination App
rect rgb(235, 245, 255)
note over SrcApp,SrCSig: Emit signal as immutable commitment
SrcApp->>SrcSig: signal(bytes32 payload)
SrcSig-->>SrcSig: store commitment slot = true
end
rect rgb(245, 235, 255)
note over Provider: Publish source state root / block commitment
SrcSig-->>Provider: included in stateRoot
end
rect rgb(235, 255, 245)
note over DstApp,DstSig: Verify cross-chain signal via proof
DstApp->>DstSig: verifySignal(srcChainId, srcSigAddr, slot, proof, stateRoot)
Provider-->>DstSig: stateRoot (imported/available)
DstSig-->>DstApp: true/false (Merkle proof of slot==true)
end
sequenceDiagram
autonumber
participant User as User
participant Bridge as ETH/Token Bridge (Dst)
participant DstSig as SignalService (Destination)
participant SrcSig as SignalService (Source)
participant Provider as Provider
rect rgb(250, 250, 230)
note over SrcSig,Provider: Bridge wraps SignalService flow
User->>SrcSig: lock/mint triggers signal(commitment)
SrcSig-->>Provider: commitment included in stateRoot
end
User->>Bridge: claim/redeem(params, proof)
Bridge->>DstSig: verifySignal(..., proof, stateRoot)
DstSig-->>Bridge: verification result
alt verified
Bridge-->>User: release/mint assets
else failed
Bridge-->>User: revert/error
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
documentation/signal-service.md (1)
34-34: Align sub-list indentation with Markdown style.Line 34’s sub-bullet is indented with four spaces; markdownlint (MD007) expects two. Please dedent by two spaces to satisfy the style check.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
documentation/Fast.pngis excluded by!**/*.pngdocumentation/Taiko Messaging.pngis excluded by!**/*.pngdocumentation/fast_signaling.svgis excluded by!**/*.svg
📒 Files selected for processing (1)
documentation/signal-service.md(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: check
documentation/signal-service.md
[error] 27-27: typos: identifer should be identifier
[warning] 27-27: typos: identifer should be identifier
🪛 GitHub Check: typos
documentation/signal-service.md
[warning] 27-27:
"identifer" should be "identifier".
🪛 markdownlint-cli2 (0.18.1)
documentation/signal-service.md
34-34: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
This in unrelated to the PR but it is blocking the CI
Changes to gas cost
🧾 Summary (10% most significant diffs)
Full diff report 👇
|
The existing documentation is a mixture of Taiko's design and previous versions of the signal service.
This PR simplifies it so it matches the current code base
Summary by CodeRabbit