@rhinestone/deposit-modal 0.13.0 → 0.14.1

package/README.md

@@ -18,18 +18,12 @@ docs.
 npm install @rhinestone/deposit-modal viem wagmi @tanstack/react-query
 ```
 
-Add Reown only if you want the modal to connect the wallet itself — these are
-optional peers, so skip them when you pass your own `walletClient` or run a flow
-with no wallet:
+Add the built-in Reown wallet stack only when you pass `reownAppId`. All five
+packages are optional peers, so skip them when you pass your own `walletClient`
+or run a flow with no wallet:
 
 ```bash
-npm install @reown/appkit @reown/appkit-adapter-wagmi
-```
-
-For Solana sources or destinations:
-
-```bash
-npm install @reown/appkit-adapter-solana @solana/web3.js @solana/spl-token
+npm install @reown/appkit @reown/appkit-adapter-wagmi @reown/appkit-adapter-solana @solana/web3.js @solana/spl-token
 ```
 
 ### Content Security Policy
@@ -50,6 +44,17 @@ console error pointing at the CSP. Hosts without an explicit `img-src` (or with
 > sufficient. They now come from the CDN, which drops ~20 kB (brotli) from the
 > bundle and gives every Rhinestone surface one source of truth.
 
+All three modals also post session analytics to Rhinestone (see
+[Analytics](#analytics)), so a host with an explicit `connect-src` must allow the
+orchestrator alongside its own proxy:
+
+```
+connect-src 'self' https://v1.orchestrator.rhinestone.dev;
+```
+
+A blocked origin is reported on `onEvent` as an `analytics_ingest_failure`, not
+surfaced to the user.
+
 ## Example
 
 ```tsx
@@ -296,10 +301,40 @@ Flow: user picks Fund from Exchange → backend returns supported exchanges + lo
 | ----------------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------------------------- |
 | `enableExchangeConnect` | `boolean` | `false` | Show the "Fund from Exchange" row. Requires backend Swapped keys. Needs no wallet. Can be combined with `enableFiatOnramp`. |
 
+## Analytics
+
+`onEvent` receives the deposit, withdraw and claim funnels as a session-scoped
+stream:
+every event carries the session id, the modal, the widget version and a snapshot
+of the session's configuration.
+
+The same events are also sent to Rhinestone, batched, in the background, and
+flushed when the modal closes or the page goes away. Delivery never affects the
+flow and never changes what `onEvent` receives. Sessions are attributed to your
+project through a short-lived token minted at `POST /analytics/ingest-token` on
+your proxy, once per session as the session starts; a proxy that does not
+forward that route still collects, just unattributed.
+
+| Prop                     | Type      | Default | Description                                                     |
+| ------------------------ | --------- | ------- | --------------------------------------------------------------- |
+| `enableAnalyticsIngest`  | `boolean` | `true`  | Set `false` to stop sending analytics to Rhinestone. `onEvent` is unaffected. |
+
+When a batch cannot be delivered, `onEvent` receives one
+`analytics_ingest_failure` per distinct reason per session, naming the reason
+(`network` — which includes a CSP block — `rejected`, `conflict`,
+`unauthorized`, `throttled`, `unavailable`, `token_unavailable`, `unsupported`),
+the HTTP status when there was one, and how many events the session has lost so
+far.
+
 ## Upgrading
 
-Upgrading from 0.8.x is a breaking change on both modals. See
-[`MIGRATION.md`](./MIGRATION.md), or the same guide
+Upgrading from 0.13.x changes what `onEvent` delivers: the deposit events are
+replaced by a method-aware taxonomy, the five flat claim events are replaced by
+a claim funnel, and every event gains a session envelope. A claim-only
+integration now posts analytics too, so it needs the `connect-src` above.
+Upgrading from 0.8.x is a breaking change on both modals.
+
+See [`MIGRATION.md`](./MIGRATION.md), or the same guide
 [in the docs](https://docs.rhinestone.dev/deposits/widget/migration).
 
 ## Contributing