YNU-864: Compat layer correctness + cookbooks#148
Open
ihsraham wants to merge 8 commits intodocs/reorg-for-v1from
Open
YNU-864: Compat layer correctness + cookbooks#148ihsraham wants to merge 8 commits intodocs/reorg-for-v1from
ihsraham wants to merge 8 commits intodocs/reorg-for-v1from
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
- Fix compat codemod guidance to use @yellow-org/nitrolite-codemod package commands. - Document raw-unit transfer semantics, app-session decimal strings, and raw bigint token helpers. - Add EventPoller and compat errors cookbooks for migrated apps. - Keep Nitronode WS URLs as coming-soon placeholders until the canonical sandbox host is pinned. Resolves: F-006, F-007, F-008 (compat slice), F-009 (compat slice), F-031, F-032, F-033, F-048, F-049, F-050.
Use the public yellow-sdk-codemod GitHub workflow instead of an unpublished npm package command. Add a manual migration review checklist for the remaining import, client, auth, event, amount, error, and SSR checks after the codemod runs.
Document the planned @yellow-org/sdk-mcp workflow as coming soon and show how to use its migration prompt and lookup tools after publication.
Add coming-soon setup examples for Claude Code, Claude Desktop, Codex, Cursor, and VS Code from the planned @yellow-org/sdk-mcp package workflow.
Add a top-level Build sidebar page with card summaries for Co-Sign Checkout, Nitrolite Store, and Nexus P2P Transfer, including live demos, source repos, functionality, stack, and SDK usage.
Convert the Build examples page to horizontal screenshot cards, remove version/vendor wording from SDK lists, and add captured front-page screenshots for each deployed example.
ihsraham
force-pushed
the
feat/ynu-864-compat-correctness-cookbooks
branch
from
67ef9f2 to
d6ddb4c
Compare
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
This PR updates the TypeScript compat SDK docs for apps migrating from
@erc7824/nitrolite@0.5.3to the v1 runtime through@yellow-org/sdk-compat. It also adds a Build examples page with deployed apps, screenshots, source links, and stack/SDK notes.Intent
@yellow-org/sdk-compatand native@yellow-org/sdksurfaces.layer-3/yellow-sdk-codemodsource workflow.@yellow-org/sdk-mcpis published.Files Touched
docs/nitrolite/build/sdk/typescript-compat/overview.mdx: compat package purpose, installation, quick start, amount units, supported surface, and limits.docs/nitrolite/build/sdk/typescript-compat/migration-overview.mdx: codemod flow, MCP coming-soon note, client construction, migration matrix, and manual migration review areas.docs/nitrolite/build/sdk/typescript-compat/migration-onchain.mdx: deposits, withdrawals, channel operations, native fallback guidance, and amount handling.docs/nitrolite/build/sdk/typescript-compat/migration-offchain.mdx: auth helpers, app sessions, transfers, ledger queries, EventPoller, and typed error handling.docs/nitrolite/build/sdk/typescript-compat/event-poller.mdx: polling bridge for migrated server-push event handlers.docs/nitrolite/build/sdk/typescript-compat/errors.mdx: typed compat errors and recovery recipes.docs/nitrolite/build/examples.mdx: new Build examples index for Co-Sign Checkout, Nitrolite Store, and Nexus P2P Transfer.static/img/nitrolite/examples/*.png: captured front-page screenshots for the examples cards.src/css/custom.css: horizontal examples-card layout and centered screenshot media frames.What Changed
git clone,npm install,npm run build, andnode dist/cli.jsbecause the npm package is not published yet.bigint, transfers use raw asset-unit strings, app-session allocations use human-readable decimal strings, and direct native SDK calls useDecimal.checkpointChannel(...).Validation
git diff --checknpm run build/nitrolite/build/examplesin dark mode.npm view @yellow-org/sdk-mcp versioncurrently returns 404, so the MCP flow remains labeled coming soon.The docs build still reports existing warnings from versioned 0.5.x and Clearnet contract docs. This PR does not add compat-page broken links or anchors.