Update Nexus docs for v2 (Widgets, SDK v0.0.5, concepts)#91
Open
anirudhvenu wants to merge 4 commits into
Open
Update Nexus docs for v2 (Widgets, SDK v0.0.5, concepts)#91anirudhvenu wants to merge 4 commits into
anirudhvenu wants to merge 4 commits into
Conversation
…epts - Elements: restructure around the single Nexus Elements element; document the v2 API (config.deposit/executeDeposit, allowedSource/DestinationPairs, modal + wallet callbacks); deprecate the standalone Unified Balance page; align agent-skills list; unify naming to "Nexus Elements" - SDK reference: rewrite all pages to @avail-project/nexus-sdk-v2 v0.0.5 (createNexusClient, two-step init, typed event union, per-operation hooks, NexusError, TokenBalance); add calculate-max-for-bridge, swap-and-execute, calculate-max-for-swap, and list-intents pages - Concepts: reframe to the v2 intent model — solver fulfilment and settlement, Nexus/Mayan provider selection, aggregator-routed swaps, per-operation allowances with 'min' default - Remove create-liquid-apps quickstarts (templates still ship the v1 SDK); update explorer links to nexus-v2 hosts; use placeholder endpoints in custom NetworkConfig examples Element live-preview embeds render a registry placeholder until the nexus-one showcase components land separately. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Solver submits token deposits via signed intent + allowances; native-token deposits come from the user's wallet. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Section slug /docs/nexus/nexus-ui-elements -> /docs/nexus/widgets (+ your-first-widget, nexus-sdk/widgets); redirects added for all old paths including the removed quickstarts - Prose and nav renamed to "Widgets"; the single component is "the widget" - Package, registry, and skill identifiers unchanged (@nexus-elements/nexus-one, availproject/nexus-elements) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
… chain data to live deployment - Package renamed: @avail-project/nexus-sdk-v2 -> @avail-project/nexus-core (npm latest = 2.0.0) - Repo links: availproject/nexus-sdk-v2 -> availproject/nexus-sdk (paths verified on main) - Skill renamed to nexus-core; skills.sh links updated - Link MIGRATION.md from reference index and v1 field-rename notes - Sync chain/token matrix, vault + token addresses to live middleware deployment (drop Kaia and Flow Testnet, add MegaETH vault, Citrea USDC.e/USDT.e, current vault addresses, Avalanche swaps enabled, per-chain token corrections) - reference.json: nexus_elements -> nexus_widgets, /docs/nexus/widgets, nexus-one Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
anirudhvenu
force-pushed
the
docs/nexus-v2-updates
branch
from
df5a788 to
98bfe68
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.
Problem
The Nexus docs described the v1 stack —
@avail-project/nexus-core,new NexusSDK(), flatNEXUS_EVENTS, global hook setters, and the pre-rearchitecture Elements widgets. Code samples no longer worked against v2.Changes
Widgets (section renamed from "Nexus UI Elements")
config.deposit+executeDeposit(...),allowedSourcePairs/allowedDestinationPairs, modal and wallet callbacks/docs/nexus/widgetsslugs with redirects for all previous paths; npm/registry identifiers unchanged (@nexus-elements/nexus-one)nexus-one-*SDK reference (target:
nexus-sdk-v2v0.0.5)createNexusClient, two-step init, renamed params (toTokenSymbol/toAmountRaw/sources), typed event union, per-operation hooks, typedNexusErrorhierarchy,TokenBalancecalculate-max-for-bridge,swap-and-execute,calculate-max-for-swap,list-intentsConcepts
listIntents()statuses, solver fulfilment and settlement, Nexus/Mayan provider selection, aggregator-routed swaps (LiFi/Bebop/Fibrous/0x), per-operation allowances defaulting tominRemoved
create-liquid-appsquickstarts — the templates still ship the v1 SDK; they return once the templates are updated (redirects point to the manual installation guides)Verification
pnpm build(377 pages), Vitest 97/97, Jest redirects coverage — all green@avail-project/nexus-core2.0.0 (availproject/nexus-sdkmain) and thenexus-elementsv2 branch; deployment facts verified against live mainnet/testnet middlewareNotes
nexus-oneshowcase components land separately (in progress onfeat/nexus-elements-rearchitecture)availproject/nexus-sdkand shipped as@avail-project/nexus-core2.0.0 (npm latest) — docs reference the merged package/reponexus-elements#feat/upgrade-elements-to-v2lands and the widgets registry's SDK pin bumps fromnexus-core1.x to 2.x🤖 Generated with Claude Code