docs: add Sepolia ↔ Miden bridging tutorial via Epoch (+ examples/bridging-app)#199
Draft
Keinberger wants to merge 1 commit into
Draft
docs: add Sepolia ↔ Miden bridging tutorial via Epoch (+ examples/bridging-app)#199Keinberger wants to merge 1 commit into
Keinberger wants to merge 1 commit into
Conversation
…dging-app) Adds a single-page web-client tutorial covering Miden→EVM and EVM→Miden bridging through the Epoch protocol intent SDK, plus a runnable Vite + React reference app under examples/bridging-app/ that the tutorial's code blocks paste-verify against (a snippet check enforces byte-identity). The example app is forked from epochprotocol/miden-integration-example@efc3a690 with bridging-specific adaptations: the '1000' reclaim-height literal replaced with a runtime currentMidenBlock + 1000 computation, the dead wagmi Miden chain placeholder + no-op midenClient removed, the RainbowKit projectId made env-driven (with a setup screen instead of a blank-page crash when unset), the WithdrawForm token decimals corrected to 18, and the general-purpose Miden wallet UI stripped to keep the example focused on bridging. The tutorial covers wiring the SDK against a wagmi walletClient with the Miden virtual chain id override, the Miden→EVM four-stage pipeline (getTaskData → getIntentQuote → solveIntent → polling), the EVM→Miden reverse direction through Epoch's Compact contract on Sepolia, an 11-method API reference card, and the inherited Epoch integration pitfalls. It stays within the 2,000-2,500 word band and ships unit coverage for the epoch-bridge task-data builders.
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
1 participant
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
docs/src/web-client/bridging_with_epoch_tutorial.md— a single-page tutorial (~2,486 words) covering Miden→EVM and EVM→Miden bridging via the Epoch protocol intent SDK.examples/bridging-app/— a runnable Vite + React reference app the tutorial's code blocks paste-verify against, forked fromepochprotocol/miden-integration-example@efc3a690(bridging-specific adaptations are listed in the app's README "Forked from").0xMiden/docsadds the sidebar entry + Bridging DocCard: docs: add bridging tutorial sidebar entry + Bridging DocCard docs#297Verification
cd examples/bridging-app && yarn install && yarn build && yarn test→ all green (27 tests).wc -won the tutorial → 2,486 (within the 2,000–2,500 word band).<!-- source: examples/bridging-app/<file>:<lines> -->comment and is byte-identical to that range.status:successon Sepolia. EVM→Miden quote path verified; the full round-trip is pending an Epoch testnet-dev solver with liquidity for the route (external prerequisite, not a code defect).What's NOT in this PR
protocol/crates/miden-agglayer/SPEC.mdonly; no "coming soon" language.Reviewers
Brian (docs IA) · an Epoch team rep (technical accuracy) · Keinberger (DevRel voice).