@chipi-stack/chipi-react 14.9.0 → 14.10.0

package/README.md

@@ -109,3 +109,36 @@ Full docs at [docs.chipipay.com](https://docs.chipipay.com)
 ## License
 
 MIT
+
+
+## Private balances (useShield / useUnshield / usePrivateBalance)
+
+```tsx
+import { useShield, usePrivateBalance, derivePrivacyAccount } from "@chipi-stack/chipi-react";
+
+const keys = await derivePrivacyAccount({
+  anchorSecret,
+  seedDomainTag: wallet.address,
+  classHash: COMPANION_CLASS_HASH,
+});
+const { shieldAsync } = useShield();
+await shieldAsync({
+  config: {
+    apiPublicKey,
+    getBearerToken: () => getToken(),
+    gatewaySubmitUrl: "/api/starknet-gateway", // browsers need this CORS proxy
+  },
+  keys,
+  token: USDC_ADDRESS,
+  amount: 1_000_000n,
+  fundDeposit: (companion, amount) => transferGasless(companion, amount),
+  onStep: setPhase, // prepare | fund | deposit | prove | finish
+});
+const { byToken } = usePrivateBalance({ mode: "ledger", events: recordedEvents });
+```
+
+Client-derived keys (cache the address, never the keys; the DELEGATED
+PROVER sees the pool key per op — privacy holds vs the public, not the
+proving operator: see the docs' trust-model section),
+gasless for the end user (Chipi fronts the STRK per allowlisted API key).
+Capture the StarkWare pool ToS at the first shield. Full guide in the docs.

package/dist/hooks.d.mts

@@ -1,6 +1,7 @@
-export { g as ChipiWalletData, S as SessionState, k as SessionWallet, X as ThresholdSignState, i as UseChipiSessionConfig, j as UseChipiSessionReturn, e as UseChipiWalletConfig, U as UseChipiWalletObjectConfig, f as UseChipiWalletReturn, R as UseGuardianRecoveryReturn, P as UseShhhSignerReturn, W as UseThresholdSignOptions, V as UseThresholdSignReturn, p as UseTransferConfig, M as UseX402PaymentConfig, N as UseX402PaymentReturn, H as useAddSessionKeyToContract, q as useApprove, A as useCallAnyContract, h as useChipiSession, d as useChipiWallet, D as useChipiWalletObject, G as useCreateSessionKey, u as useCreateWallet, K as useExecuteWithSession, J as useGetSessionData, z as useGetSku, y as useGetSkuList, x as useGetSkuPurchase, F as useGetTokenBalance, s as useGetTransaction, r as useGetTransactionList, t as useGetTransactionStatus, c as useGetWallet, Q as useGuardianRecovery, l as useMigrateWalletToPasskey, n as useMigrateWalletToShhh, w as usePurchaseSku, E as useRecordSendTransaction, I as useRevokeSessionKey, O as useShhhSigner, B as useSignTypedData, v as useSyncOnChainTransfers, T as useThresholdSign, o as useTransfer, m as useUpdateWalletEncryption, L as useX402Payment } from './index-B8e6TdyG.mjs';
+export { g as ChipiWalletData, a1 as PrivacyConfig, a2 as PrivacyKeys, a5 as PrivacyLedgerEvent, a3 as PrivacyStep, a6 as PrivateBalanceInput, S as SessionState, k as SessionWallet, a4 as ShieldHookInput, X as ThresholdSignState, i as UseChipiSessionConfig, j as UseChipiSessionReturn, e as UseChipiWalletConfig, U as UseChipiWalletObjectConfig, f as UseChipiWalletReturn, R as UseGuardianRecoveryReturn, P as UseShhhSignerReturn, W as UseThresholdSignOptions, V as UseThresholdSignReturn, p as UseTransferConfig, M as UseX402PaymentConfig, N as UseX402PaymentReturn, $ as derivePrivacyAccount, a0 as netPrivateBalance, H as useAddSessionKeyToContract, q as useApprove, A as useCallAnyContract, h as useChipiSession, d as useChipiWallet, D as useChipiWalletObject, G as useCreateSessionKey, u as useCreateWallet, K as useExecuteWithSession, J as useGetSessionData, z as useGetSku, y as useGetSkuList, x as useGetSkuPurchase, F as useGetTokenBalance, s as useGetTransaction, r as useGetTransactionList, t as useGetTransactionStatus, c as useGetWallet, Q as useGuardianRecovery, l as useMigrateWalletToPasskey, n as useMigrateWalletToShhh, _ as usePrivateBalance, w as usePurchaseSku, E as useRecordSendTransaction, I as useRevokeSessionKey, O as useShhhSigner, Y as useShield, B as useSignTypedData, v as useSyncOnChainTransfers, T as useThresholdSign, o as useTransfer, Z as useUnshield, m as useUpdateWalletEncryption, L as useX402Payment } from './index-D9-uVlda.mjs';
 import '@chipi-stack/types';
 import '@tanstack/react-query';
 import '@chipi-stack/backend';
 import 'starknet';
 import '@starknet-io/types-js';
+import '@chipi-stack/core';

package/dist/hooks.d.ts

@@ -1,6 +1,7 @@
-export { g as ChipiWalletData, S as SessionState, k as SessionWallet, X as ThresholdSignState, i as UseChipiSessionConfig, j as UseChipiSessionReturn, e as UseChipiWalletConfig, U as UseChipiWalletObjectConfig, f as UseChipiWalletReturn, R as UseGuardianRecoveryReturn, P as UseShhhSignerReturn, W as UseThresholdSignOptions, V as UseThresholdSignReturn, p as UseTransferConfig, M as UseX402PaymentConfig, N as UseX402PaymentReturn, H as useAddSessionKeyToContract, q as useApprove, A as useCallAnyContract, h as useChipiSession, d as useChipiWallet, D as useChipiWalletObject, G as useCreateSessionKey, u as useCreateWallet, K as useExecuteWithSession, J as useGetSessionData, z as useGetSku, y as useGetSkuList, x as useGetSkuPurchase, F as useGetTokenBalance, s as useGetTransaction, r as useGetTransactionList, t as useGetTransactionStatus, c as useGetWallet, Q as useGuardianRecovery, l as useMigrateWalletToPasskey, n as useMigrateWalletToShhh, w as usePurchaseSku, E as useRecordSendTransaction, I as useRevokeSessionKey, O as useShhhSigner, B as useSignTypedData, v as useSyncOnChainTransfers, T as useThresholdSign, o as useTransfer, m as useUpdateWalletEncryption, L as useX402Payment } from './index-B8e6TdyG.js';
+export { g as ChipiWalletData, a1 as PrivacyConfig, a2 as PrivacyKeys, a5 as PrivacyLedgerEvent, a3 as PrivacyStep, a6 as PrivateBalanceInput, S as SessionState, k as SessionWallet, a4 as ShieldHookInput, X as ThresholdSignState, i as UseChipiSessionConfig, j as UseChipiSessionReturn, e as UseChipiWalletConfig, U as UseChipiWalletObjectConfig, f as UseChipiWalletReturn, R as UseGuardianRecoveryReturn, P as UseShhhSignerReturn, W as UseThresholdSignOptions, V as UseThresholdSignReturn, p as UseTransferConfig, M as UseX402PaymentConfig, N as UseX402PaymentReturn, $ as derivePrivacyAccount, a0 as netPrivateBalance, H as useAddSessionKeyToContract, q as useApprove, A as useCallAnyContract, h as useChipiSession, d as useChipiWallet, D as useChipiWalletObject, G as useCreateSessionKey, u as useCreateWallet, K as useExecuteWithSession, J as useGetSessionData, z as useGetSku, y as useGetSkuList, x as useGetSkuPurchase, F as useGetTokenBalance, s as useGetTransaction, r as useGetTransactionList, t as useGetTransactionStatus, c as useGetWallet, Q as useGuardianRecovery, l as useMigrateWalletToPasskey, n as useMigrateWalletToShhh, _ as usePrivateBalance, w as usePurchaseSku, E as useRecordSendTransaction, I as useRevokeSessionKey, O as useShhhSigner, Y as useShield, B as useSignTypedData, v as useSyncOnChainTransfers, T as useThresholdSign, o as useTransfer, Z as useUnshield, m as useUpdateWalletEncryption, L as useX402Payment } from './index-D9-uVlda.js';
 import '@chipi-stack/types';
 import '@tanstack/react-query';
 import '@chipi-stack/backend';
 import 'starknet';
 import '@starknet-io/types-js';
+import '@chipi-stack/core';