@recoilpay/intent-react 0.1.0 → 0.3.0

package/README.md

@@ -50,6 +50,16 @@ import { RecoilIntent, viemWallet } from '@recoilpay/intent-react';
 | `apiUrl` | `string` | Defaults to production (`https://api.recoilpay.com`). |
 | `session` | `IntentSession` | Share one flow between components, or inject one in tests. |
 | `className` | `string` | Added to the root element. |
+| `onCashOutStarted` | `(tradeId) => void` | A cash-out opened. Store the id to bring the user back to it. |
+| `onCashOutEnded` | `(trade) => void` | A cash-out settled, was refunded or failed. |
+| `resumeCashOut` | `string \| null` | Show this cash-out on mount (an id from `onCashOutStarted`). |
+| `offrampSession` | `OfframpSession` | Share or inject the cash-out flow. |
+
+## Cash out (testnet)
+
+"cash out 50 USDC on Base Sepolia to NGN" shows the best offer and a form for the bank details. They are encrypted on the device for the solver who pays out, so neither RecoilPay nor your page's backend sees them. After the user signs, the component follows the payout and asks the user to confirm the money arrived, or to open a dispute. The USDC stays locked until they answer, so let users come back to it: save the id from `onCashOutStarted` and pass it as `resumeCashOut`. While a cash-out needs the user, the text field is disabled so a new sentence can't hide it.
+
+Confirming and disputing are signed messages, so the wallet must support `signMessage` (`viemWallet` and `useWagmiIntentWallet` do). `useOfframp()` gives you the same flow as state for your own UI.
 
 ## Styling
 
@@ -68,7 +78,7 @@ Variables: `--rp-surface`, `--rp-raised`, `--rp-sunken`, `--rp-ink`, `--rp-ink-2
 
 ## Your own UI
 
-`useRecoilIntent()` gives you the same flow as React state with no markup: `phase`, `preview`, `issues`, `status`, `explorerUrl` and so on, plus `run`, `confirm` and `reset`. See `@recoilpay/intent-core` for what each field means.
+`useRecoilIntent()` (and `useOfframp()` for cash-outs) gives you the same flow as React state with no markup: `phase`, `preview`, `issues`, `status`, `explorerUrl` and so on, plus `run`, `confirm` and `reset`. See `@recoilpay/intent-core` for what each field means.
 
 ```tsx
 const intent = useRecoilIntent({ wallet });