@spicenet-io/spiceflow-ui 4.21.2 → 4.21.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,672 @@
1
+ # SpiceFlow UI SDK
2
+
3
+ A React component library for building DeFi swap interfaces with multi-chain support.
4
+
5
+ ## Version and migration
6
+
7
+ Release `4.11.0` includes quote prewarming, scoped fee-hint reuse, concurrent fee
8
+ checks, configurable fee-estimate tolerance, and faster execution-status polling.
9
+ It uses `@spicenet-io/spiceflow-core@0.7.3`. Source spend caps, destination minimums
10
+ and required destination receipts remain enforced. See the fee-estimate tolerance
11
+ section below for the default and configuration.
12
+
13
+ Check the actual registry tag and client pin before adopting it. See
14
+ [CONSISTENCY-MIGRATION.md](CONSISTENCY-MIGRATION.md) for the earlier inventory/action
15
+ migration. Publishing the SDK does not upgrade consuming apps automatically.
16
+
17
+ ## Installation and provider setup
18
+
19
+ Select an approved exact version, preserving the app's dependency-age and security policies:
20
+
21
+ ```bash
22
+ bun add --exact @spicenet-io/spiceflow-ui@4.11.0
23
+ ```
24
+
25
+ Reuse compatible host-owned Privy, wagmi and QueryClient providers. Read the exact
26
+ package's peer dependencies; do not replace the wallet stack as part of a version bump.
27
+
28
+ The SDK adds its stylesheet (spinner keyframes, focus ring, reduced-motion rule) to the
29
+ page when it loads, so no CSS import is needed. `@spicenet-io/spiceflow-ui/styles.css`
30
+ is still exported for a host whose Content Security Policy forbids inline styles;
31
+ importing it as well is harmless.
32
+
33
+ ```tsx
34
+ import { SpiceFlowProvider } from "@spicenet-io/spiceflow-ui";
35
+
36
+ // Inside the host's existing WagmiProvider → QueryClientProvider → PrivyProvider stack.
37
+ <SpiceFlowProvider
38
+ provider="privy"
39
+ network="mainnet"
40
+ nativeChainId={8453}
41
+ rpcOverrides={clientRpcUrls}
42
+ >
43
+ {children}
44
+ </SpiceFlowProvider>;
45
+ ```
46
+
47
+ Configure Privy credentials/policy on the host's `PrivyProvider`. Supply client RPCs
48
+ through `rpcOverrides` for the chains you exercise, and keep the SDK/wallet chain sets
49
+ aligned. An entry in `rpcOverrides` always wins; a chain without one uses the chain's
50
+ built-in endpoint, so an integration that passes none keeps working. Wallet-library
51
+ transports alone do not configure SDK reads. Rollup price lookups read only a
52
+ host-configured RPC. Keep private credentials out of browser bundles.
53
+
54
+ ## Integration ownership
55
+
56
+ - Use stock components when they fit the approved UI; use `useSpiceSupply` for custom
57
+ action forms. `useSpiceLock` and legacy `useSpiceAction` delegate to that controller.
58
+ - In this source (not yet published), `useSpiceSupply` defaults `enabled` to `true`.
59
+ Omit it for a mounted action form, or pass `enabled: isOpen` when a hidden form stays
60
+ mounted. Use `canExecute` for submit-button readiness; fee calculation does not
61
+ require toggling `enabled`. Published 4.10.0 still requires an explicit value.
62
+ - Declare the destination token by chain and address:
63
+ `destinationToken={{ chainId: 8453, address: USDC }}`. The SDK takes the symbol and
64
+ decimals from the chain's token registry, then from the token contract, and holds the
65
+ action until they are known. Decimals that cannot be read block the action; a symbol
66
+ that cannot be read falls back to the shortened address. Any field you pass wins, so a
67
+ full `{ address, symbol, decimals, chainId }` object behaves exactly as before.
68
+ - Supply destination metadata, protocol `buildActionCalls` or destination-only
69
+ `lockBatches`, beneficiary semantics, and awaited application updates. The SDK owns
70
+ inventory, routing, Max, fees, accepted plans, funding, execution and recovery.
71
+ - For the account, use `useSpiceAccount()` instead of reading `SpiceFlowProviderContext`:
72
+ `mode` (`"embedded"` or `"external"`), `setMode`, `ownerAddress` for the current mode,
73
+ both wallet addresses and the whitelist state. A provider with a fixed `mode` prop
74
+ ignores `setMode`.
75
+ - For custom holdings, use `useSpiceInventory` and `assetPositionId`. Keep raw balance,
76
+ default visibility and spend eligibility separate. Preserve rows during refresh;
77
+ stale/failed balances cannot authorize spending, and confirmed zero wins.
78
+ - In this unreleased source, eligible External-mode actions with a matching wallet token
79
+ and destination chain execute directly from the external signer, without embedded funding.
80
+ Other assets/chains still use embedded funding and the shared routed executor.
81
+ A controlled ERC20 action can opt into `actionExecution: { wallet: "external", recoveryKey: "my-action" }`
82
+ when its contract requires the external caller. The SDK routes funds to that wallet,
83
+ verifies delivery, then submits the captured host calls. This also permits a matching
84
+ external source to execute directly while the app remains in Embedded mode.
85
+ `onPayExecute` and `onLockExecute` remain blocked. Verify contract caller/beneficiary and NFT receiver behavior.
86
+ Published `.16` does not contain this restoration.
87
+ - Routed external execution now requires the API's `externalExecution` capability
88
+ before any source funding. The original action retains its positive ERC20 delivery,
89
+ accepted protocol calls and canonical receipt ownership. Native matching-token,
90
+ same-chain direct execution retains its existing behavior.
91
+ - Use the normal `submitSupply()`, `submitPay()` or `submit()` button after an
92
+ interrupted routed external action. `canExecute` includes its retry readiness;
93
+ render "Try again" when `status.canRetry` is true. The SDK refreshes wallet
94
+ inventory and reconciles the original calls before simulating and signing only
95
+ the remaining direct work. It never repeats delivery or a confirmed conversion,
96
+ mint or stake. A confirmed revert can be retried only after canonical proof and
97
+ fresh simulation; pending/unknown outcomes cannot authorize another send.
98
+ Do not apply the old source's quote/balance gates to this retry. Host ownership,
99
+ sale/receiver and protocol availability checks still apply. `refreshStatus()`
100
+ and `retrySupply()` remain read-only and never prompt automatically.
101
+ The earlier `resumeExternalAction()` alias is retained for compatibility; a
102
+ separate Continue control is unnecessary. This source requires the compatible
103
+ API146 retry preparation contract and is not a published SDK recommendation.
104
+ - Canonical nonce recovery covers direct top-level transactions from the accepted
105
+ external account. The provider must submit the requested call with its reserved
106
+ nonce; account bytecode alone does not prove every provider's execution model.
107
+ A deployed contract account without an EIP-7702 delegation designator keeps its
108
+ existing provider sends and local receipt success behavior. Its outer hashes are
109
+ explicitly unverified analytics observations, without inner-call volume attribution
110
+ or durable recovery after reload. An uncertain mounted operation is held and is
111
+ never automatically resent. Unsupported history does not forbid a distinct action
112
+ that the user explicitly reviews and submits.
113
+ - Supply `input` adds fees to principal; `input-inclusive` uses a total budget; Pay
114
+ `output` fixes the destination amount. Use controller readiness/Max/status instead of
115
+ constructing an executor context or duplicating fee arithmetic in the host.
116
+ - Use controller recovery for uncertain funding and `retryFinalization()` for failed
117
+ application updates after settlement. Preserve original host terms across reload.
118
+ - Deposit and rollup Withdraw retain distinct execution semantics while sharing
119
+ inventory/policy. Account wallet withdrawal uses the inclusive Supply controller and its fee hierarchy.
120
+
121
+ Inventory isolation does not establish support for simultaneous differently configured
122
+ providers: underlying quote/execution transports still have global state.
123
+
124
+ ## Liquidity venues
125
+
126
+ When a flow has to swap on the destination chain, the SDK quotes every liquidity
127
+ venue that covers that chain and takes the best fill: the most output on a
128
+ supply, the least input on a pay. Routing is decided here, on your RPC. The
129
+ solver only executes the calls the winning quote produced.
130
+
131
+ Leave `liquidityVenues` off and you get the built-in venues. Declare it once on
132
+ the provider to add your own, and every component picks them up.
133
+
134
+ ```tsx
135
+ <SpiceFlowProvider
136
+ network="mainnet"
137
+ nativeChainId={4663}
138
+ rpcOverrides={{ 4663: ROBINHOOD_RPC }}
139
+ liquidityVenues={{
140
+ venues: [
141
+ {
142
+ protocol: "uniswap-v3",
143
+ chainId: 4663,
144
+ swapRouter: "0x1e406484F1F204b23cE84B9901C0171a738fd406",
145
+ quoterV2: "0x3E290e5E01818002A0b672148BdC7514D861C7B3",
146
+ hubCurrencies: ["0x0bd7d308f8e1639fab988df18a8011f41eacad73"],
147
+ },
148
+ ],
149
+ }}
150
+ >
151
+ ```
152
+
153
+ Your venues race the built-ins on price; they do not override them. Set
154
+ `includeDefaults: false` to drop the built-ins and route only through what you
155
+ declared. On a chain with no venue at all, quoting fails with that chain named
156
+ rather than falling back to something you did not configure.
157
+
158
+ Every entry names one chain and one protocol family, and serves both swap
159
+ directions. Supply the **deployment's** addresses, not a pool address: a
160
+ v3-style pool calls back into `msg.sender`, so swaps go through the router and
161
+ quotes through the quoter. The SDK finds the pools from the fee tiers (or tick
162
+ spacings) and hub currencies.
163
+
164
+ | `protocol` | Required | Optional |
165
+ | ---------------------- | ------------------------------------------------- | -------------------------------------------------------- |
166
+ | `uniswap-v3` | `chainId`, `swapRouter`, `quoterV2` | `name`, `feeTiers`, `hubCurrencies`, `routerHasDeadline` |
167
+ | `uniswap-v4` | `chainId`, `quoter`, `universalRouter`, `permit2` | `name`, `hubCurrencies` |
168
+ | `aerodrome-slipstream` | `chainId`, `swapRouter`, `quoterV2` | `name`, `tickSpacings`, `hubCurrencies` |
169
+
170
+ `name` is the label shown to the user as "via <name>" once a swap is quoted, so
171
+ give it the name people know the venue by. It defaults to the protocol, which
172
+ means a swap always names something real rather than a family it does not belong
173
+ to.
174
+
175
+ `hubCurrencies` are the intermediate tokens tried for two-hop routes, usually
176
+ wrapped native and the chain's main stablecoin. Set `routerHasDeadline` when the
177
+ deployment forked the original Uniswap `SwapRouter`, whose exact-output structs
178
+ carry a deadline; SwapRouter02 forks do not.
179
+
180
+ Most DEXs are forks of one of these families, so adding one is addresses only.
181
+ A venue from a different family (a Uniswap v2 pair, Curve, Balancer) needs an
182
+ adapter in the SDK — send us the chain, router, quoter and one funded pool and
183
+ it becomes a `protocol` everyone can name.
184
+
185
+ ## Components
186
+
187
+ - **SwapWidget** - Main swap interface component
188
+ - **AssetSelector** - Token selection component
189
+ - **SpiceDeposit** - Deposit modal component
190
+ - **StatusDisplay** - Transaction status display
191
+ - **ProviderLogin** - Wallet connection component
192
+ - **DebugWidget** - Development debugging component
193
+ - **Button**, **Input**, **Modal** - UI primitives
194
+
195
+ ## Development
196
+
197
+ ### Rollup balance pricing
198
+
199
+ Rollup USD values use the host-configured RPC provider's pricing capability when the balance API has no valid value. The built-in account panel and withdrawal modal enable this while open; custom `useSpiceAssets` consumers can opt in with `priceEnabled`. Quantities arrive independently. Lookups follow receipt mappings, prefer `nativeChainId`, and fall back to other supported chains with a configured Alchemy endpoint. Explicit account `tokenPrices` overrides still take precedence over provider quotes.
200
+
201
+ Wallet discovery and rollup balances share a one-minute quote cache. Pricing polls only while the view is open and the page is visible. A failed refresh can retain a marked stale quote for up to five minutes; an unavailable quote displays `—`. No extra key, internal RPC, or symbol-based ERC-20 price fallback is used.
202
+
203
+ ### Host tokens
204
+
205
+ A token the SDK does not know (a protocol's own token, a receipt token) is declared
206
+ once on the provider. Every surface that lists balances then reads it: Supply, Pay,
207
+ Lock, the account panel and Withdraw.
208
+
209
+ ```tsx
210
+ <SpiceFlowProvider
211
+ additionalSourceTokens={[{ address: TOKEN, chainId: 8453, symbol: "TOKEN", decimals: 18 }]}
212
+ >
213
+ ```
214
+
215
+ A component's or hook's own `additionalSourceTokens` still works and is added to the
216
+ provider's list.
217
+
218
+ ### Host token prices
219
+
220
+ A host token usually has no price the SDK can find, so the account panel lists it
221
+ without a USD value. `AccountDisplay.tokenPrices` takes the host's own price for it,
222
+ keyed by `chainId:address`. The value counts toward the account total and the row
223
+ sorts with the rest.
224
+
225
+ ```tsx
226
+ <AccountDisplay tokenPrices={{ [`8453:${TOKEN}`]: tokenUsdPrice }} />
227
+ ```
228
+
229
+ The SDK's own price wins whenever it has one. A symbol key prices rollup balances
230
+ only: any wallet token can carry any symbol, so a wallet balance is matched by address
231
+ alone. The price is for display and never changes which balance an action spends.
232
+
233
+ ### Host-supplied token logos
234
+
235
+ `AccountDisplay.tokenLogos` maps a token symbol to a logo URL, the same key
236
+ shape `tokenPrices` uses. A discovered embedded-wallet balance falls back to
237
+ it when the RPC provider returns no logo, which is what happens for a token
238
+ that is not in the chain's configured token list. Provider metadata still
239
+ wins when it has a logo.
240
+
241
+ ```tsx
242
+ <AccountDisplay tokenLogos={{ TOKEN: tokenLogoUrl }} />
243
+ ```
244
+
245
+ For a host-rendered asset row, this source also exports the SDK's existing logo
246
+ resolver from the package root:
247
+
248
+ ```tsx
249
+ const logo = useTokenLogo(asset.logoURI, asset.chainId, asset.address);
250
+ ```
251
+
252
+ Import `useTokenLogo` from `@spicenet-io/spiceflow-ui`. It returns the supplied logo
253
+ immediately, otherwise resolves the shared chain/address token list asynchronously.
254
+ Until a logo is available, it returns `undefined`; keep the balance and selection
255
+ usable and render the host's usual fallback. This source export requires an SDK
256
+ release before a consuming app can adopt it.
257
+
258
+ ### Account with Deposit and Withdraw
259
+
260
+ `SpiceAccount` renders `AccountDisplay` together with `SpiceDeposit` and
261
+ `SpiceWithdraw`, and owns their open state. Withdraw on an idle rollup balance opens
262
+ the modal with that balance selected. It takes every `AccountDisplay` prop except the
263
+ two click handlers; `depositProps` and `withdrawProps` pass through to the modals.
264
+ `styles` and `onDepositSuccess` are shared with the modals unless those props set
265
+ their own.
266
+
267
+ ```tsx
268
+ <SpiceAccount appName="MyApp" onDepositSuccess={refresh} />
269
+ ```
270
+
271
+ Use `AccountDisplay` directly to hide one of the buttons or to open your own flow
272
+ from them.
273
+
274
+ ### Withdraw from an account balance
275
+
276
+ `AccountDisplay.onWithdrawClick` receives the rollup receipt-token ID when a
277
+ user clicks Withdraw on an idle rollup balance. The main Withdraw button calls
278
+ it without an ID. Pass the ID to `SpiceWithdraw.initialSourceAssetId` to open
279
+ the existing modal with that asset selected; the user chooses the destination
280
+ network inside the modal. Existing callbacks that take no arguments continue
281
+ to work.
282
+
283
+ ```tsx
284
+ const [withdrawOpen, setWithdrawOpen] = useState(false);
285
+ const [withdrawAssetId, setWithdrawAssetId] = useState<string>();
286
+
287
+ <AccountDisplay
288
+ onWithdrawClick={(receiptTokenId) => {
289
+ setWithdrawAssetId(receiptTokenId);
290
+ setWithdrawOpen(true);
291
+ }}
292
+ />
293
+ <SpiceWithdraw
294
+ isOpen={withdrawOpen}
295
+ onClose={() => setWithdrawOpen(false)}
296
+ initialSourceAssetId={withdrawAssetId}
297
+ />
298
+ ```
299
+
300
+ `buildSpicenetBatch` defaults to the SDK's `buildSpicenetWithdrawalBatch`. An
301
+ integration that already passes a builder keeps it as an override, and its
302
+ callbacks are unchanged.
303
+ `initialSourceAssetId` selects a current balance by ID; it does not supply a
304
+ cached balance or change the receipt's supported withdrawal routes.
305
+
306
+ Accepted, signed 7702 actions continue on the backend after the browser closes or
307
+ loses connectivity. This applies to Withdraw and shared Supply, Pay, Lock and
308
+ custom-action execution. The SDK discovers recent wallet activity on reopen and
309
+ reconnect; stock modals display it and controlled hooks expose `status.activity`.
310
+ Activity is read-only and never changes the current form, signs, funds, or invokes
311
+ a success callback for an unrelated action. No saved browser journal or Web Lock
312
+ is required. Existing wallet balances remain inventory.
313
+
314
+ Deploy the backend continuation companion (including its API #109 durable execution
315
+ dependency and database migration) before this SDK. The SDK detects
316
+ `GET /actions/capabilities`, requests automatic continuation in `POST /actions`,
317
+ and observes the original action. API #91 submission lookup resolves a lost POST
318
+ response by its original idempotency key without a second POST. An unresolved
319
+ lookup stays unknown; it does not prove failure. Older APIs without the capability
320
+ retain foreground execution and do not gain automatic continuation from this SDK
321
+ alone. Takeover must be enabled for the new capability.
322
+
323
+ The backend retains the accepted authorization and ordered steps. It reconciles
324
+ an ambiguous broadcast by its original relayer submission or receipt, waits for
325
+ source credit, and stops remaining work when authorization has expired or a fresh
326
+ wallet signature is required. Completed steps stay completed. Funding before
327
+ backend acceptance, direct external-wallet calls and host-owned non-7702 execution
328
+ cannot continue without their wallet/host; funds left behind appear in inventory.
329
+ Application finalization stays awaited in the current session, with callback-only
330
+ retry after confirmed execution. After reload the SDK exposes backend status and
331
+ balances; it does not reconstruct or replay host application callbacks.
332
+
333
+ ### Funding sources
334
+
335
+ Supply, Pay and Lock list every balance that can fund the action: the embedded wallet
336
+ and rollup balances, and the connected external wallet, in either wallet mode. To keep a
337
+ mode to its own wallet, pass `includeExternalWalletAssets={false}` (Embedded mode) or
338
+ `includeCrossChainEmbeddedAssets={false}` (External mode). A user who holds the same
339
+ token in both wallets sees one row per wallet; a host that preselects a source should
340
+ match on `assetPositionId`, not on symbol or address alone.
341
+
342
+ ### Routed external callers
343
+
344
+ The controlled hook supports positive ERC20 input, input-inclusive and fixed-output
345
+ actions with an explicit external caller. Configure `rpcOverrides` for the destination
346
+ and any wallet-source chain. Quotes bind the source spend cap, destination delivery,
347
+ external caller and host calls before funding. The SDK checks the destination receipt,
348
+ ERC20 transfer amount and caller balance before requesting the host transactions.
349
+ Only the final external transaction hash reaches awaited application finalization.
350
+
351
+ Below one destination transaction's native gas cost, the accepted route buys gas for
352
+ the pending external calls plus three later transactions. At or above that threshold
353
+ it adds no reserve; direct execution still pays its own native gas. Native destinations,
354
+ zero-principal, proceeds-funded and explicit source-escrow caller actions remain
355
+ unsupported capability gaps. This does not add a stock-component prop or a durable
356
+ execution journal: after signing fails, delivered tokens remain ordinary wallet assets
357
+ and retrying the original route can fund again. Use `retryFinalization()` to retry only
358
+ a failed application callback after the external action has confirmed.
359
+
360
+ ### Action Fee Readiness
361
+
362
+ - Routed Supply, Pay and Lock actions must surface fee estimation before enabling submission.
363
+ - Eligible direct external actions still require an accepted plan but charge no Spicenet fee. Network gas remains payable in the external wallet; native Max reserves gas.
364
+ - Deposit gas and rollup withdrawal semantics remain distinct from action intent fees. Preserve their existing quote/readiness requirements.
365
+ - Account wallet withdrawal uses the shared input-inclusive Supply controller and its fee-only planner for local fees. Do not bypass its fee/readiness gates based on the label "withdraw".
366
+ - Custom actions use the shared controller's `canExecute`; an available balance or old quote alone is insufficient.
367
+ - `onSubmit` on `SpiceSupply`, `SpiceLock`, `SpiceDeposit` and the shared controller fires once when the user submits and the SDK accepts it, before any wallet prompt. Use it for "transaction in progress" feedback instead of listening for clicks on SDK buttons.
368
+ - `max()` on the shared controller (`useSpiceSupply`, `useSpiceLock`) resolves the fee-aware Max for the selected source, or `null` when there is none or the action fixes its output. The host sets the result as the amount.
369
+
370
+ ### Combined Cash balance
371
+
372
+ `SpiceDeposit` opens a new Add cash flow by default, even when the embedded
373
+ wallet holds leftover funds. With combined Cash enabled, those funds remain
374
+ available to Cash actions.
375
+ Clients that still need the legacy incomplete-deposit prompt can set
376
+ `skipRecovery={false}`; it is no longer shown automatically from a wallet balance.
377
+
378
+ Set `combineSourceBalances: true` on `SpiceSupply`, `SpiceLock`, `useSpiceSupply`,
379
+ `useSpiceLock` or `useSpiceAction` to show a token in the embedded wallet and its
380
+ mapped escrow balance on the same chain as one row, and to fund an action from
381
+ both. It is off by default; without it, wallet and escrow balances stay separate
382
+ rows and each action spends only the selected row.
383
+
384
+ Routed actions use escrow first and deposit only the wallet shortfall. Actions
385
+ paid in place keep wallet funds where they are and withdraw only the escrow
386
+ shortfall. The reviewed quote fixes the amount taken from each balance, and both
387
+ are checked again before signing.
388
+
389
+ Custom presentations read `assets.selectable` and
390
+ `assets.getAvailableBalance(asset)`, which returns the combined amount in the
391
+ asset's raw units, or `undefined` while a balance cannot be verified. Pass the
392
+ same getter to `AssetSelector`. Each physical `Asset.balance` is unchanged.
393
+
394
+ Native limit orders include shortfall funding fees inside the reviewed budget.
395
+ Use `canPrepare`, `canPlace` and `status.pending` to honor original action
396
+ recovery. Automatic funding requires the backend continuation contract. Unknown
397
+ submissions are reconciled by their original key; no financial POST is retried.
398
+ Backend-owned funding remains pending until original processed credit is proven,
399
+ including across reloads. The SDK stores no browser transaction journal.
400
+
401
+ ### Native action review
402
+
403
+ `SpiceSupply` displays the actual fee total for `feeOnlyAction` even when no
404
+ source is selected and the principal payment is zero. It omits the zero-value
405
+ payment estimate. Pass `feeFundingReserve: { asset, amount }` when principal
406
+ already in the executor must remain unavailable for fee funding.
407
+
408
+ Use `onStateChange(state: SupplyModalState)` to review the native controller's
409
+ `feeQuote`, `feePreview`, selected asset, operation key, readiness, progress and
410
+ transaction hash. Do not create a second controller to approximate its fees.
411
+ `submitDisabled` vetoes a new confirmation while native quoting remains active.
412
+
413
+ `beforeSubmit(review: SupplySubmissionReview)` can await application checks such
414
+ as a fresh position read. The SDK captures the accepted quote and rejects changed
415
+ quotes, wallets, policies, closed forms and retired components before calling
416
+ the synchronous `onSubmit` callback or starting execution. Use `onSubmit` for
417
+ application feedback that the action was accepted. The controller
418
+ holds submission readiness while those checks run, including across rerenders.
419
+ After acceptance, `submitDisabled` may become true to reflect host busy state;
420
+ it does not cancel that accepted execution. Application checks
421
+ must still reject revoked consent in their `beforeSubmit` callback.
422
+
423
+ Return the application receipt-verification promise from `onSuccess`. A failed
424
+ application update uses the existing finalization retry without submitting the
425
+ financial action again.
426
+
427
+ ### Native limit order funding
428
+
429
+ Without `combineSourceBalances: true`, orders can register unfunded and the SDK
430
+ does not deposit wallet funds. The reviewed funding choice stays with that order
431
+ if the host changes its option later.
432
+
433
+ Use `useSpiceLimitOrders({ combineSourceBalances: true }).prepareOrder` to enable
434
+ wallet funding, review its result, then pass that exact result to `signOrder` and
435
+ its returned request to `placeOrder`. `grossAmount` in
436
+ the input is the total cash budget. Preparation deducts any automatic funding
437
+ fee before constructing the order. The prepared `grossAmount` includes the
438
+ order's execution fees, `amountIn` is the swap input, and `feeAmount` is the
439
+ order's execution fee total. The requested `minimumOutput` stays fixed.
440
+
441
+ When available escrow cash does not cover that budget, `funding` describes the
442
+ SDK's same-chain embedded-wallet deposit: `source` identifies its token, chain,
443
+ owner and location; `sourceSpendCap` caps its debit; `depositAmount` is the cash
444
+ credit; and `feeAmount` is the funding fee. All funding amounts use that source's
445
+ decimals. Review both fee totals in the same confirmation. The inclusive cash
446
+ budget is `prepared.grossAmount + (prepared.funding?.feeAmount ?? 0n)`.
447
+
448
+ `placeOrder` validates current cash and backend order reservations, executes the
449
+ accepted native deposit, awaits its successful destination receipt and usable
450
+ cash credit, then registers the captured signed order. Its `status` reports
451
+ funding, credit and placement progress. Use `status.message` for outcome text;
452
+ `status.error` retains the original diagnostic error. Funding is never repeated
453
+ for the same signed request, including after an ambiguous result. An interrupted
454
+ unregistered order leaves confirmed funding as ordinary cash inventory. Check
455
+ wallet activity and the backend order list before creating another order.
456
+ Changing wallets or provider policy retires prepared and signed requests. No
457
+ browser transaction journal or parallel recovery tracker is required.
458
+
459
+ ### Fee funding for funded actions
460
+
461
+ Set `feeFunding: ["input", "proceeds", "balance"]` on `useSpiceSupply`,
462
+ `SpiceSupply`, `useSpiceAction`, `useSpiceLock` or `SpiceLock` to use the shared
463
+ hierarchy for wallet-funded actions on the destination chain. This applies to
464
+ arbitrary protocol calls: swaps, deposits, staking, lending and repayments.
465
+ Direct payment precedes conversion **within each tier**. Existing defaults remain
466
+ unchanged; `feeFunding: []` retains the existing selected-source path.
467
+
468
+ - `amountDirection: "input-inclusive"` offers the selected budget as input.
469
+ Fees reduce that input and the SDK requotes the conversion before building
470
+ protocol calls. The builder must honour the amount passed to it.
471
+ - `"input"` preserves the selected principal; `"output"` preserves the exact
472
+ payment or repayment. Neither offers required principal to the input tier.
473
+ - `actionProceeds: { token, resolve }` declares an amount remaining in the
474
+ executor **after all protocol calls**. Conversion output that is deposited,
475
+ staked, used for repayment or sent away is not available for fees. The SDK
476
+ resolves proceeds only if it reaches that tier and rechecks them before signing.
477
+ The object declaration alone does not opt a funded action in: it requires a
478
+ nonempty `feeFunding` order, preserving existing callers' selected-source planning.
479
+ - Balance fallback reserves the selected principal. Only the remaining amount
480
+ of that exact position can pay fees. `fees.sourceSpendCap` includes fee spending
481
+ from the same position, and `fees.fundingSource` reports the chosen source.
482
+
483
+ For an input-inclusive swap whose output stays in the executor,
484
+ `actionProceeds: "output"` enables the same hierarchy and declares the output as
485
+ available proceeds. If proceeds pay fees, `fees.destinationAmount` and
486
+ `quote.estimatedOutput` show the net minimum and expected output respectively.
487
+ Do not use this shortcut for calls that consume or send away the conversion output.
488
+
489
+ Local external-wallet funding still transfers the principal to the executor
490
+ first. Direct external execution keeps its native-gas path. External native Max
491
+ reserves transfer gas, and fixed-principal Max reserves execution fees.
492
+ Cross-chain and rollup **principal** routes retain their existing funding planner;
493
+ this extension does not let destination proceeds pay earlier source or bridge
494
+ costs, or add balance fallback to those routes. Custom fee orders on those routes fail
495
+ explicitly instead of silently charging a different tier. Rollup balances can still fund
496
+ fees for a local action through the existing fee-funding withdrawal leg. Standalone
497
+ `SpiceDeposit` and rollup `SpiceWithdraw` retain their distinct transfer semantics;
498
+ protocol deposits/withdrawals through the action controller use the contract above.
499
+
500
+ All paths retain fee readiness and accepted-plan validation. This capability
501
+ requires an SDK release and explicit integration opt-in; it does not upgrade
502
+ published packages or deployed apps.
503
+
504
+ ### Supply fee-estimate tolerance
505
+
506
+ `SpiceFlowProvider` defaults `feeToleranceBps` to
507
+ `20000` (200%). Clients can override it, for example:
508
+
509
+ ```tsx
510
+ <SpiceFlowProvider {...config} feeToleranceBps={100}>
511
+ {children}
512
+ </SpiceFlowProvider>
513
+ ```
514
+
515
+ `100` is 1%; `0` disables the drift allowance. Existing conservative fixed-fee
516
+ retention still applies when estimates fall. Values must be non-negative safe
517
+ integers. The allowance is relative to each accepted fee component: a fee of 100
518
+ allows a fresh estimate up to 300 at the default. A zero fee cannot become positive.
519
+
520
+ This setting covers fee convergence and pre-sign validation for user-transfer
521
+ Supply plans, including signed-fee pricing, source gas checks, stock/controlled
522
+ Supply and input-mode Lock consumers.
523
+ Within tolerance, the SDK keeps the quoted fee amounts and transaction calls;
524
+ it does not add a 200% fee buffer, increase the source spend cap, or relax swap
525
+ slippage/minimum outputs. Changing the setting invalidates prepared plans.
526
+ Backend acceptance and funding checks still apply. Exact-output Pay, fee-only
527
+ funding, deposits and backend-transfer convergence retain their separate rules.
528
+
529
+ Routed embedded withdrawals quote a 1% gas/bridge reserve, rounded up in the fee
530
+ token's raw units. It is part of the displayed fee and deducted before the
531
+ displayed receive amount; the signed calls pay those exact amounts. It does not
532
+ compound on quote refresh. Submission checks estimate drift using the same
533
+ `feeToleranceBps`, while signed
534
+ fee amounts, source cap and receive amount stay fixed. If drift exceeds the
535
+ configured tolerance, use **Refresh quote** and review the new terms before
536
+ submitting again. Same-chain withdrawals keep their existing fee policy.
537
+
538
+ The open Supply controller retains fee construction hints for at most 30 seconds
539
+ across amount edits in the same wallet, route and configuration scope. These hints
540
+ do not enable submission: the SDK rebuilds the current calls, then checks source
541
+ gas and destination fees concurrently. User-transfer source gas uses the same
542
+ configured fee tolerance; accepted amounts and source caps stay unchanged. A hint
543
+ that no longer fits falls back to full preparation. Closing the form clears hints.
544
+ Servers advertising fee validation price the already constructed destination fee
545
+ calls; older servers retain the estimate path. Cold preparation still sizes fees
546
+ from scratch. Input route quotes debounce for 100 ms; routed fee preparation adds
547
+ no second debounce. These optimizations do not establish a latency SLA.
548
+
549
+ Fee-inclusive, user-transfer Supply also prewarms when an eligible source is
550
+ selected with an empty/zero amount. It constructs a provisional quote for at most
551
+ one token, capped by the available balance, and retains only fee hints. The amount,
552
+ fee preview and executable plan remain empty. Typing can await in-flight prewarming
553
+ before validating the real amount; closing or changing wallet/configuration
554
+ cancels it. Failed provisional preparation leaves normal quoting available.
555
+ This does not apply to direct external actions, exact-output Pay, fee-only actions
556
+ or actions with explicit funding inputs/proceeds. No signature or submission occurs
557
+ during prewarming. The time available before typing determines how much work it hides.
558
+
559
+ ### Fee funding for fee-only actions
560
+
561
+ - A fee-only action (`feeOnlyAction`) runs on what the executing wallet already holds; the SDK funds only the Spicenet fees, in the chain's fee token (`destinationToken`).
562
+ - With no `selectedAsset`, the SDK picks the fee source and the user is never asked. The action's input (`actionInput`) comes first, then its proceeds (`actionProceeds`), so the fee stays inside the action the user submitted; then other balances: same-chain embedded wallet before rollup, and within each, balances already in the fee token before balances that swap into it. The first source that simulates and covers the fee wins and is reported as `fees.fundingSource`; a source whose swap has no route, or that cannot cover the fee within slippage, is skipped for the next.
563
+ - Declare `actionInput` for every token the action consumes and honour the amount passed to `buildActionCalls`: when fees come from an input, the action is built for the remainder. Declare `actionProceeds` for a token the action leaves in the wallet. Both are optional; with neither, only balances can pay. Omit `actionProceeds` when the output is delivered to another owner.
564
+ - `feeFunding` overrides the level order per transaction, for example `["proceeds", "input", "balance"]`; the order inside the balance level is fixed. An empty list leaves the choice to the host's `selectedAsset`.
565
+ - A `selectedAsset` on a fee-only action is an explicit host choice and funds the fee from that balance as before.
566
+ - Account wallet withdrawals use this hierarchy automatically and display the chosen fee asset without a selector. Entered amounts and Max are total source-token budgets; applicable fees reduce the net received amount. Same-chain transfers retain the selected token. Choosing another supported chain routes through USDC escrow and delivers registered USDC, with the net output shown before submission. Withdraw discovers permitted embedded balances by default alongside escrow balances; `walletAssets` optionally supplies extra token metadata or an initial wallet selection. Custom `useSpiceSupply` actions that must preserve an exact principal can declare `feeFundingReserve: { asset, amount }` instead of offering that principal as `actionInput`.
567
+ - `feeOnlyAction` alone declares the action: `amountDirection` defaults to `"output"` and `paymentAmount` to `"0"`. Explicit values still win.
568
+ - `submit()` on the controller runs the executor that matches `amountDirection`. `submitSupply()` and `submitPay()` remain for existing callers.
569
+
570
+ ### Updating and releasing
571
+
572
+ Change the shared inventory/policy/controller owner and audit affected stock and custom
573
+ consumers. Use the central team's `workflow`, `ui-quality` and `shared/sdk.md` guidance;
574
+ keep skills in the skills repo rather than copying them here.
575
+
576
+ Read the central `shared/client-design-decisions.md` register before an upgrade. Map
577
+ applicable decision IDs to affected consumers and regression scenarios, and report each
578
+ result with exact candidate evidence. Preserve agreed behavior and ownership even when
579
+ types compile; a deliberate change needs an explicit product decision and migration plan.
580
+
581
+ Run focused regressions, `bun test`, `bun run typecheck` and `bun run build`, then validate
582
+ affected consumer builds and rendered/financial behavior on the exact candidate. Record
583
+ package identity, configuration, acceptance coverage and untested cases. Earlier candidate
584
+ results do not automatically apply to newer main or a new client.
585
+
586
+ If core/API changes are needed, resolve those dependencies before their UI/app consumers.
587
+ An inventory/controller-only change does not inherently require a core release. After
588
+ explicit release authorization, publish a prerelease with a non-`latest` tag, verify its
589
+ registry artifact, and pin/test that exact version in each adopting app. Stable promotion,
590
+ client deployment and docs targeting are separate release decisions. This refactor adds
591
+ no automatic npm publishing.
592
+
593
+ ### Building the Library
594
+
595
+ ```bash
596
+ bun run build
597
+ ```
598
+
599
+ ### Type Checking
600
+
601
+ ```bash
602
+ bun run typecheck
603
+ ```
604
+
605
+ CI runs this on every pull request, so a type error fails the build.
606
+
607
+ ### Formatting
608
+
609
+ ```bash
610
+ bun run format
611
+ ```
612
+
613
+ Prettier runs over staged files on commit via lint-staged. There is no ESLint
614
+ setup in this repository.
615
+
616
+ ## Component Playground
617
+
618
+ This repository includes a lightweight React playground app for viewing and testing all components without the complexity of Storybook.
619
+
620
+ ### Running the Playground
621
+
622
+ 1. Install dependencies (if not already done):
623
+
624
+ ```bash
625
+ bun install --frozen-lockfile
626
+ ```
627
+
628
+ 2. Navigate to the playground directory:
629
+
630
+ ```bash
631
+ cd playground
632
+ ```
633
+
634
+ 3. Install playground dependencies:
635
+
636
+ ```bash
637
+ bun install --frozen-lockfile
638
+ ```
639
+
640
+ 4. Start the development server:
641
+
642
+ ```bash
643
+ bun run dev
644
+ ```
645
+
646
+ The playground will open automatically at `http://localhost:3000`
647
+
648
+ ### Using the Playground
649
+
650
+ - **Left Sidebar**: Browse available components
651
+ - **Main Area**: View the selected component with different example variants
652
+ - **Example Tabs**: Switch between different states/examples for each component
653
+
654
+ ### Adding a New Component Example
655
+
656
+ To add a new example variant for a component:
657
+
658
+ 1. Open `playground/src/ComponentRegistry.tsx`
659
+ 2. Find the component's entry in the `examples` object
660
+ 3. Add a new entry to the array:
661
+ ```tsx
662
+ {
663
+ label: 'Your Example Name',
664
+ render: () => <YourComponent {...props} />,
665
+ }
666
+ ```
667
+
668
+ The playground will automatically pick up the new example and display it as a tab.
669
+
670
+ ## License
671
+
672
+ MIT