Add App Development module for dApp SDK and Wallet Gateway (#579)#629
Draft
8bitpal wants to merge 6 commits into
Draft
Add App Development module for dApp SDK and Wallet Gateway (#579)#6298bitpal wants to merge 6 commits into
8bitpal wants to merge 6 commits into
Conversation
Implements the curriculum module requested in issue #579 and refreshes the integrations mirror against the latest splice-wallet-kernel main (c85656f). New curriculum module pages (appdev/modules/, Module 4 group): - m4-dapp-sdk.mdx — Introduces the dApp SDK in an app-development context: where it fits, the high-level vs Provider API split, window.canton discovery, the typical init/connect/listAccounts/ prepareExecute flow. - m4-wallet-gateway.mdx — Introduces the Wallet Gateway: why a mediator exists, what it provides (dApp API + User API + UI), the discovery and connection flow, when a team needs to run one, signing provider options, and operational realities relevant to dApp developers. Refreshed mirrors from upstream c85656f: - integrations/wallet-gateway/apis.mdx (hash c581db48) - integrations/wallet-gateway/signing-providers.mdx (hash 0e02eba4) Newly ported upstream pages (not previously in our docs): - integrations/dapp-sdk/overview.mdx — dApp SDK landing/overview - integrations/dapp-sdk/api-reference.mdx — Method reference - integrations/wallet-gateway/overview.mdx — Wallet Gateway landing - integrations/wallet-gateway/configuration-schema.mdx — Full JSON schema for the wallet-gateway-remote config file - integrations/wallet-gateway/deployment.mdx — Production deployment guide - integrations/dapp-building-examples.mdx — Ping and Portfolio sample dApps Navigation: - Added the two new curriculum pages to Module 4: Full-Stack Application Development. - Added the six new integration pages to their respective groups (Overview, dApp SDK, Wallet Gateway) under Integrations. Notes: - The 9 previously mirrored integration pages (download/usage/ best-practices/wallet-provider-integration/adapters-and-discovery for dApp SDK; configuration/usage/troubleshooting/download for Wallet Gateway, plus dapp-building-overview) are already in sync with upstream c85656f — no refresh needed. - Relative `.md` links in the ported pages (e.g. `(configuration/index.md)`) were rewritten to absolute Mintlify slugs. - The upstream `> [!IMPORTANT]` GitHub-flavored callout in wallet-gateway/index.md was converted to a `<Warning>` block.
Editorial pass on the two new curriculum pages to match the project's writing style: - Removed em dashes throughout. Most became commas, colons, or sentence breaks; a few "X — Y" bullet pairs became "X: Y" or got rewritten as proper prose. - Replaced the "Term — definition" bullet pattern in "What it provides" (m4-wallet-gateway) and the "Signing providers" section with prose paragraphs that embed the terms inline. Bullets stay where they're genuinely list-shaped (arrow flows, next-steps). - Dropped the "This page covers..." meta intros from both files. The lead paragraph already names the topic; the second paragraph now goes straight to the "see also" pointer. - Replaced the "From the dApp's perspective" / "From the validator's perspective" parallel construction with "To the dApp" / "To the validator". - Removed minor marketing flourishes (e.g., "rather than being tied to a single vendor" → just describing the interoperability concretely). - Frontmatter description punctuation tightened (no em dashes). Content unchanged. The numbered "Typical flow" steps still have the same code samples and the same five-step structure.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Replaces the two box-drawing ASCII diagrams in the curriculum modules with mermaid flowcharts. m4-dapp-sdk: four-node LR flowchart (dApp <-> Wallet Gateway, Gateway <-> Canton Validator, Gateway <-> Signing Provider) with the dApp API (CIP-103) transport labels preserved. m4-wallet-gateway: same four-node skeleton plus a User node and a subgraph that shows the Gateway's internal pieces (dApp API, User API, User UI). The User node connects to User UI (browser) and User API (programmatic) separately, which is clearer than the ASCII version's single 'User interactions' arrow. Mermaid renders consistently with other diagrams in the project (m1-mental-models, ledger-model, pqs/operate).
The High-Level Architecture diagram in dapp-building-overview.mdx is
inside a COPIED block (mirrors splice-wallet-kernel:docs/dapp-building/
overview/index.md). Converting the ASCII box-drawing to mermaid means
deliberate divergence from upstream verbatim.
Added a LOCAL_MODIFICATION comment after the COPIED_END marker
explaining the deviation. The surrounding prose stays in sync with
upstream; only the diagram block was changed.
Mermaid form mirrors the m4-wallet-gateway diagram: dApp <-> Wallet
Gateway (subgraph containing dApp API, User API, User UI), User
connecting to UI (browser) and User API (programmatic) separately,
plus Gateway <-> Validator and Gateway <-> Signing Provider on the
backend. The dApp transport label keeps the upstream wording
('HTTP / WebSocket') rather than the m4 module's 'HTTP / postMessage'
to preserve upstream's framing.
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.
Closes #579.
Summary
Adds the App Development curriculum module requested in issue #579 and refreshes the integrations mirror against the latest splice-wallet-kernel
main(c85656f).New curriculum module pages
Under App Development > Module 4: Full-Stack Application Development:
appdev/modules/m4-dapp-sdk.mdx— Introduces the dApp SDK in an app-development context: where it fits in the architecture, the high-level vs Provider API split,window.cantondiscovery, and the typical init / connect / listAccounts / prepareExecute flow with code samples.appdev/modules/m4-wallet-gateway.mdx— Introduces the Wallet Gateway: why a mediator exists, what it provides (dApp API + User API + UI), the discovery and connection flow, when to run your own, signing-provider options, and the operational realities a dApp developer should know about even if they never operate one.Refreshed mirrors
Audited every existing
integrations/dapp-sdkandintegrations/wallet-gatewaypage against upstreamorigin/main. Two pages had content drift and have been refreshed:integrations/wallet-gateway/apis.mdx→ hashc581db48integrations/wallet-gateway/signing-providers.mdx→ hash0e02eba4The other 9 mirrored pages (
dapp-sdk/{download,usage,best-practices,wallet-provider-integration,adapters-and-discovery},wallet-gateway/{configuration,usage,troubleshooting,download}, anddapp-building-overview) are content-identical to upstream — only the@82ec39c9label in the COPIED marker is stale.Newly ported upstream pages
Six pages that exist upstream but weren't yet in our docs:
integrations/dapp-sdk/overview.mdx— dApp SDK landing/overviewintegrations/dapp-sdk/api-reference.mdx— Full method referenceintegrations/wallet-gateway/overview.mdx— Wallet Gateway landingintegrations/wallet-gateway/configuration-schema.mdx— Full JSON schema for thewallet-gateway-remoteconfig fileintegrations/wallet-gateway/deployment.mdx— Production deployment guideintegrations/dapp-building-examples.mdx— Ping and Portfolio sample dAppsNavigation
All 8 new slugs added to
docs.jsonin their appropriate groups:overview/api-referencepages added to the dApp SDK group; newoverview/configuration-schema/deploymentpages added to the Wallet Gateway group; newdapp-building-examplesadded to Integrations > Overview.JSON validated, every nav slug has a backing
.mdx, every/integrations/...and/appdev/...link in the changed files resolves against the nav slug set.