@nexus-cross/dapp-ui 1.3.10-beta.4 → 1.3.10-beta.6

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/dist/index.d.cts CHANGED
@@ -1890,10 +1890,10 @@ interface DepositAddressResult {
1890
1890
  originCurrency: string;
1891
1891
  }
1892
1892
  /**
1893
- * One row of GET /v1/orders?user=...'s "orders" array -- the sweeper mints
1894
- * one order per deposit detected at a standing address, so a single (user,
1895
- * origin) pair can accumulate many of these over time. Amount fields are
1896
- * smallest-unit base-10 integer strings, "" when not yet known.
1893
+ * One row of GET /v1/orders?user=...'s "orders" array. A single order can
1894
+ * aggregate several deposits made to the same reusable forwarder; `deposits[]`
1895
+ * is the per-arrival identity. Amount fields are smallest-unit base-10 integer
1896
+ * strings, "" when not yet known.
1897
1897
  */
1898
1898
  interface OrderSummary {
1899
1899
  orderId: string;
@@ -2057,7 +2057,8 @@ interface RelayClient {
2057
2057
  * GET /v1/deposit-address -- resolves the stable, reusable deposit
2058
2058
  * address for (user, originChainId, originCurrency). No amount is
2059
2059
  * involved and no order is created; the same address can receive any
2060
- * number of deposits of any size (each swept into its own order).
2060
+ * number of deposits of any size. Several deposits can be aggregated into
2061
+ * one order when they jointly fund the same reusable forwarder.
2061
2062
  *
2062
2063
  * `target` (Task 8) is the delivery asset's symbol from
2063
2064
  * `Catalog.targets` -- sent as `&target=<symbol>` only when it's a
@@ -2229,22 +2230,16 @@ interface RelayDepositProps extends RelayWalletProps {
2229
2230
  * watch `depositState` (phase/txHash/reverted) for those. Safe to treat as
2230
2231
  * "the funds moved" (upstream 83845fb). */
2231
2232
  onDeposited?: (txHash: string) => void;
2232
- /**
2233
- * Called once per NEW order the backend mints while step 2 (the deposit
2234
- * address) is showing — i.e. a deposit reached the address and the sweeper
2235
- * picked it up. This is the only success signal that exists for a MANUAL
2236
- * (QR / copied-address) deposit, which the widget cannot observe as a tx:
2237
- * `onDeposited` above fires only for the one-click path, on confirmation.
2238
- * Fires after the sweep (that is when the order is created), not at
2239
- * on-chain arrival. One-click deposits also arrive here once swept.
2240
- */
2241
- onDepositDetected?: (order: OrderSummary) => void;
2242
2233
  onError?: (error: Error) => void;
2243
- /** Called by the connect prompt shown above the form while there is neither a connected
2244
- * wallet nor a usable recipient (host-supplied or typed). Omitted — the prompt renders as
2245
- * text only, with no button. The form itself stays usable either way: typing a valid
2246
- * recipient is a supported, wallet-free path to a deposit address. */
2234
+ /** Called by the `Connect Wallet` CTA under the locked card that stands in for the QR
2235
+ * while there is neither a connected wallet nor a usable recipient (host-supplied or
2236
+ * typed). Omitted — the locked card renders as text only, with no button. The rest of
2237
+ * the screen stays usable either way: typing a valid recipient is a supported,
2238
+ * wallet-free path to a deposit address. */
2247
2239
  onRequestConnect?: () => void;
2240
+ /** @deprecated The Deposit footer entry was removed. Retained as a no-op
2241
+ * compatibility prop so existing hosts do not need an immediate migration. */
2242
+ onOpenHistory?: () => void;
2248
2243
  /** Extra class name(s) for the modal/drawer content element. */
2249
2244
  className?: string;
2250
2245
  theme?: RelayTheme;
@@ -2364,7 +2359,7 @@ interface RelayDepositContentProps {
2364
2359
  className?: string;
2365
2360
  }
2366
2361
  /**
2367
- * `<RelayDeposit.Content>` — the modal/drawer surface. The wizard body is a
2362
+ * `<RelayDeposit.Content>` — the modal/drawer surface. The deposit body is a
2368
2363
  * child of `ShellContent`, i.e. of radix's `Dialog.Portal` / vaul's
2369
2364
  * `Drawer.Portal`, which render nothing while closed. The state it renders is
2370
2365
  * NOT its own any more: `<RelayDeposit>` mounts the wizard engine above the
package/dist/index.d.ts CHANGED
@@ -1890,10 +1890,10 @@ interface DepositAddressResult {
1890
1890
  originCurrency: string;
1891
1891
  }
1892
1892
  /**
1893
- * One row of GET /v1/orders?user=...'s "orders" array -- the sweeper mints
1894
- * one order per deposit detected at a standing address, so a single (user,
1895
- * origin) pair can accumulate many of these over time. Amount fields are
1896
- * smallest-unit base-10 integer strings, "" when not yet known.
1893
+ * One row of GET /v1/orders?user=...'s "orders" array. A single order can
1894
+ * aggregate several deposits made to the same reusable forwarder; `deposits[]`
1895
+ * is the per-arrival identity. Amount fields are smallest-unit base-10 integer
1896
+ * strings, "" when not yet known.
1897
1897
  */
1898
1898
  interface OrderSummary {
1899
1899
  orderId: string;
@@ -2057,7 +2057,8 @@ interface RelayClient {
2057
2057
  * GET /v1/deposit-address -- resolves the stable, reusable deposit
2058
2058
  * address for (user, originChainId, originCurrency). No amount is
2059
2059
  * involved and no order is created; the same address can receive any
2060
- * number of deposits of any size (each swept into its own order).
2060
+ * number of deposits of any size. Several deposits can be aggregated into
2061
+ * one order when they jointly fund the same reusable forwarder.
2061
2062
  *
2062
2063
  * `target` (Task 8) is the delivery asset's symbol from
2063
2064
  * `Catalog.targets` -- sent as `&target=<symbol>` only when it's a
@@ -2229,22 +2230,16 @@ interface RelayDepositProps extends RelayWalletProps {
2229
2230
  * watch `depositState` (phase/txHash/reverted) for those. Safe to treat as
2230
2231
  * "the funds moved" (upstream 83845fb). */
2231
2232
  onDeposited?: (txHash: string) => void;
2232
- /**
2233
- * Called once per NEW order the backend mints while step 2 (the deposit
2234
- * address) is showing — i.e. a deposit reached the address and the sweeper
2235
- * picked it up. This is the only success signal that exists for a MANUAL
2236
- * (QR / copied-address) deposit, which the widget cannot observe as a tx:
2237
- * `onDeposited` above fires only for the one-click path, on confirmation.
2238
- * Fires after the sweep (that is when the order is created), not at
2239
- * on-chain arrival. One-click deposits also arrive here once swept.
2240
- */
2241
- onDepositDetected?: (order: OrderSummary) => void;
2242
2233
  onError?: (error: Error) => void;
2243
- /** Called by the connect prompt shown above the form while there is neither a connected
2244
- * wallet nor a usable recipient (host-supplied or typed). Omitted — the prompt renders as
2245
- * text only, with no button. The form itself stays usable either way: typing a valid
2246
- * recipient is a supported, wallet-free path to a deposit address. */
2234
+ /** Called by the `Connect Wallet` CTA under the locked card that stands in for the QR
2235
+ * while there is neither a connected wallet nor a usable recipient (host-supplied or
2236
+ * typed). Omitted — the locked card renders as text only, with no button. The rest of
2237
+ * the screen stays usable either way: typing a valid recipient is a supported,
2238
+ * wallet-free path to a deposit address. */
2247
2239
  onRequestConnect?: () => void;
2240
+ /** @deprecated The Deposit footer entry was removed. Retained as a no-op
2241
+ * compatibility prop so existing hosts do not need an immediate migration. */
2242
+ onOpenHistory?: () => void;
2248
2243
  /** Extra class name(s) for the modal/drawer content element. */
2249
2244
  className?: string;
2250
2245
  theme?: RelayTheme;
@@ -2364,7 +2359,7 @@ interface RelayDepositContentProps {
2364
2359
  className?: string;
2365
2360
  }
2366
2361
  /**
2367
- * `<RelayDeposit.Content>` — the modal/drawer surface. The wizard body is a
2362
+ * `<RelayDeposit.Content>` — the modal/drawer surface. The deposit body is a
2368
2363
  * child of `ShellContent`, i.e. of radix's `Dialog.Portal` / vaul's
2369
2364
  * `Drawer.Portal`, which render nothing while closed. The state it renders is
2370
2365
  * NOT its own any more: `<RelayDeposit>` mounts the wizard engine above the