Skip to content

creating docs -- dev-tools/wormhole-messaging#494

Open
swarnasn29 wants to merge 1 commit into
rsksmart:mainfrom
swarnasn29:feature/wormhole-messaging
Open

creating docs -- dev-tools/wormhole-messaging#494
swarnasn29 wants to merge 1 commit into
rsksmart:mainfrom
swarnasn29:feature/wormhole-messaging

Conversation

@swarnasn29
Copy link
Copy Markdown
Contributor


Title

Docs: Add Wormhole Cross-Chain Messaging Integration Guide

Description

Purpose: Close the documentation gap for developers who want to use Wormhole's arbitrary message passing on Rootstock. The existing Wormhole page only covers the SDK tooling overview (Connect, Queries,
TypeScript SDK). There was no guide explaining how to receive and verify cross-chain messages on-chain.

Context: New builders targeting Rootstock with Wormhole had no clear integration path for Verified Action Approvals (VAAs). This guide solves that cold-start problem end-to-end.

Changes:

  • Added docs/05-dev-tools/cross-chain-bridges/wormhole-messaging.md — a full developer guide covering:
    • Architecture overview of the Emitter-Guardian-Receiver model in the Rootstock context, including the Guardian Network's ZK proof validation
    • IWormhole interface and a complete WormholeReceiver Solidity contract with replay protection, trusted emitter validation, and checks-effects-interactions ordering
    • Security best practices section with four subsections: replay protection, trusted emitter validation, checks-effects-interactions order, and consistency level considerations for Rootstock's block time
    • TypeScript integration snippet using @wormhole-foundation/sdk v2 with the UniversalAddress chain-context pattern
    • Accurate contract address for Rootstock Mainnet (0xbebdb6C8ddC678FfA9f8748f85C815C556Dd8ac6) sourced from Wormhole's read-only deployments list, with an explicit note that Rootstock Testnet has no public
      Core Contract deployment
  • Updated docs/05-dev-tools/cross-chain-bridges/index.md — added a CardsGridItem for the new guide in the cross-chain bridges landing page grid

Screenshots/GIFs

N/A — text and code documentation only. Verified visually via local Docusaurus dev server at http://localhost:3000/dev-tools/cross-chain-bridges/wormhole-messaging/.

Testing

Verification: Started the local Docusaurus dev server to confirm the page renders correctly and appears in the sidebar.

npm start -- --no-open

Output:
[INFO] Starting the development server...
[SUCCESS] Docusaurus website is running at: http://localhost:3000/

Confirmed:

  • New guide appears under Dev Tools → Cross Chain Bridges → Wormhole Messaging in the sidebar
  • Wormhole Messaging card appears on the Cross Chain Bridges index page
  • No broken internal links

Quality Checklist

  • Please confirm the following standards have been met:

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