@chipi-stack/chipi-react 14.15.0 → 14.15.1

package/dist/{index-B8OIdrOX.d.mts → index-gNLTF6ix.d.mts}

@@ -14,13 +14,39 @@ type CreateWalletInput = {
 /**
  * Hook for creating a new wallet.
  *
- * Supports dual-key wrapping: when `usePasskey: true` AND `encryptKey` (PIN) provided,
- * the private key is encrypted twice — once with the passkey-derived key (primary) and
- * once with the PIN (backup). If passkey fails later, PIN recovers the wallet.
+ * With `usePasskey: true` the hook creates a WebAuthn passkey and uses its PRF
+ * output, derived on the device, as the key that encrypts the private key. It
+ * stores the passkey's `credentialId` and `prfSupported` on the wallet so any
+ * device with the synced passkey can unlock it later with
+ * `getWalletEncryptKey(wallet.credentialId, { prfSupported: wallet.prfSupported })`.
+ * On a device without WebAuthn PRF it throws with `code: "PRF_UNSUPPORTED"`
+ * (the original `PrfUnsupportedError` is the `cause`) instead of creating a
+ * custodial wallet.
+ *
+ * - Passkey only (`usePasskey: true`, no `encryptKey`): `authMethod: "passkey"`.
+ *   Recommended for self-custodial apps; the passkey's platform sync (iCloud
+ *   Keychain, Google Password Manager) is the recovery path.
+ * - Passkey + PIN (`usePasskey: true` and `encryptKey`): `authMethod: "passkey+pin"`.
+ *   The private key is encrypted twice, once with the passkey key (primary)
+ *   and once with the PIN (backup). The backup is only as strong as the PIN,
+ *   which can be brute-forced offline against the stored ciphertext.
+ * - PIN only (`encryptKey`, no `usePasskey`): `authMethod: "pin"`. Legacy.
+ *
+ * The passkey's user name (shown by the OS passkey picker) is `externalUserId`.
  *
  * @example
  * ```tsx
- * // Passkey + PIN (recommended)
+ * // Passkey only (recommended)
+ * await createWalletAsync({
+ *   params: {
+ *     externalUserId: userId,
+ *     chain: Chain.STARKNET,
+ *     usePasskey: true,       // Creates the passkey; its PRF output encrypts the key
+ *   },
+ *   bearerToken,
+ * });
+ *
+ * // Passkey + PIN backup
  * await createWalletAsync({
  *   params: {
  *     encryptKey: pin,        // PIN backup
@@ -31,7 +57,7 @@ type CreateWalletInput = {
  *   bearerToken,
  * });
  *
- * // PIN only (backward compatible)
+ * // PIN only (legacy)
  * await createWalletAsync({
  *   params: {
  *     encryptKey: pin,

package/dist/{index-B8OIdrOX.d.ts → index-gNLTF6ix.d.ts}

@@ -14,13 +14,39 @@ type CreateWalletInput = {
 /**
  * Hook for creating a new wallet.
  *
- * Supports dual-key wrapping: when `usePasskey: true` AND `encryptKey` (PIN) provided,
- * the private key is encrypted twice — once with the passkey-derived key (primary) and
- * once with the PIN (backup). If passkey fails later, PIN recovers the wallet.
+ * With `usePasskey: true` the hook creates a WebAuthn passkey and uses its PRF
+ * output, derived on the device, as the key that encrypts the private key. It
+ * stores the passkey's `credentialId` and `prfSupported` on the wallet so any
+ * device with the synced passkey can unlock it later with
+ * `getWalletEncryptKey(wallet.credentialId, { prfSupported: wallet.prfSupported })`.
+ * On a device without WebAuthn PRF it throws with `code: "PRF_UNSUPPORTED"`
+ * (the original `PrfUnsupportedError` is the `cause`) instead of creating a
+ * custodial wallet.
+ *
+ * - Passkey only (`usePasskey: true`, no `encryptKey`): `authMethod: "passkey"`.
+ *   Recommended for self-custodial apps; the passkey's platform sync (iCloud
+ *   Keychain, Google Password Manager) is the recovery path.
+ * - Passkey + PIN (`usePasskey: true` and `encryptKey`): `authMethod: "passkey+pin"`.
+ *   The private key is encrypted twice, once with the passkey key (primary)
+ *   and once with the PIN (backup). The backup is only as strong as the PIN,
+ *   which can be brute-forced offline against the stored ciphertext.
+ * - PIN only (`encryptKey`, no `usePasskey`): `authMethod: "pin"`. Legacy.
+ *
+ * The passkey's user name (shown by the OS passkey picker) is `externalUserId`.
  *
  * @example
  * ```tsx
- * // Passkey + PIN (recommended)
+ * // Passkey only (recommended)
+ * await createWalletAsync({
+ *   params: {
+ *     externalUserId: userId,
+ *     chain: Chain.STARKNET,
+ *     usePasskey: true,       // Creates the passkey; its PRF output encrypts the key
+ *   },
+ *   bearerToken,
+ * });
+ *
+ * // Passkey + PIN backup
  * await createWalletAsync({
  *   params: {
  *     encryptKey: pin,        // PIN backup
@@ -31,7 +57,7 @@ type CreateWalletInput = {
  *   bearerToken,
  * });
  *
- * // PIN only (backward compatible)
+ * // PIN only (legacy)
  * await createWalletAsync({
  *   params: {
  *     encryptKey: pin,

package/dist/index.d.mts

@@ -4,8 +4,8 @@ import { ChipiSDK, NewOwnerInput } from '@chipi-stack/backend';
 import { ChipiSDKConfig, WalletType } from '@chipi-stack/types';
 export * from '@chipi-stack/types';
 export { Chain, ChainToken } from '@chipi-stack/types';
-import { C as ChipiWindowObjectDeps, U as UseChipiWalletObjectConfig } from './index-B8OIdrOX.mjs';
-export { a as ChipiApprovalRequest, b as ChipiSessionPolicy, g as ChipiWalletData, a2 as PrivacyConfig, a3 as PrivacyKeys, a6 as PrivacyLedgerEvent, a4 as PrivacyStep, a7 as PrivateBalanceInput, R as RegisterSessionConfig, S as SessionState, k as SessionWallet, a5 as ShieldHookInput, Y as ThresholdSignState, i as UseChipiSessionConfig, j as UseChipiSessionReturn, e as UseChipiWalletConfig, f as UseChipiWalletReturn, T as UseGuardianRecoveryReturn, P as UseShhhSignerReturn, X as UseThresholdSignOptions, W as UseThresholdSignReturn, p as UseTransferConfig, M as UseX402PaymentConfig, N as UseX402PaymentReturn, a0 as derivePrivacyAccount, a1 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, Z as useShield, B as useSignTypedData, v as useSyncOnChainTransfers, V as useThresholdSign, o as useTransfer, _ as useUnshield, m as useUpdateWalletEncryption, L as useX402Payment } from './index-B8OIdrOX.mjs';
+import { C as ChipiWindowObjectDeps, U as UseChipiWalletObjectConfig } from './index-gNLTF6ix.mjs';
+export { a as ChipiApprovalRequest, b as ChipiSessionPolicy, g as ChipiWalletData, a2 as PrivacyConfig, a3 as PrivacyKeys, a6 as PrivacyLedgerEvent, a4 as PrivacyStep, a7 as PrivateBalanceInput, R as RegisterSessionConfig, S as SessionState, k as SessionWallet, a5 as ShieldHookInput, Y as ThresholdSignState, i as UseChipiSessionConfig, j as UseChipiSessionReturn, e as UseChipiWalletConfig, f as UseChipiWalletReturn, T as UseGuardianRecoveryReturn, P as UseShhhSignerReturn, X as UseThresholdSignOptions, W as UseThresholdSignReturn, p as UseTransferConfig, M as UseX402PaymentConfig, N as UseX402PaymentReturn, a0 as derivePrivacyAccount, a1 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, Z as useShield, B as useSignTypedData, v as useSyncOnChainTransfers, V as useThresholdSign, o as useTransfer, _ as useUnshield, m as useUpdateWalletEncryption, L as useX402Payment } from './index-gNLTF6ix.mjs';
 import { StarknetWindowObject } from '@starknet-io/types-js';
 import '@tanstack/react-query';
 import 'starknet';

package/dist/index.d.ts

@@ -4,8 +4,8 @@ import { ChipiSDK, NewOwnerInput } from '@chipi-stack/backend';
 import { ChipiSDKConfig, WalletType } from '@chipi-stack/types';
 export * from '@chipi-stack/types';
 export { Chain, ChainToken } from '@chipi-stack/types';
-import { C as ChipiWindowObjectDeps, U as UseChipiWalletObjectConfig } from './index-B8OIdrOX.js';
-export { a as ChipiApprovalRequest, b as ChipiSessionPolicy, g as ChipiWalletData, a2 as PrivacyConfig, a3 as PrivacyKeys, a6 as PrivacyLedgerEvent, a4 as PrivacyStep, a7 as PrivateBalanceInput, R as RegisterSessionConfig, S as SessionState, k as SessionWallet, a5 as ShieldHookInput, Y as ThresholdSignState, i as UseChipiSessionConfig, j as UseChipiSessionReturn, e as UseChipiWalletConfig, f as UseChipiWalletReturn, T as UseGuardianRecoveryReturn, P as UseShhhSignerReturn, X as UseThresholdSignOptions, W as UseThresholdSignReturn, p as UseTransferConfig, M as UseX402PaymentConfig, N as UseX402PaymentReturn, a0 as derivePrivacyAccount, a1 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, Z as useShield, B as useSignTypedData, v as useSyncOnChainTransfers, V as useThresholdSign, o as useTransfer, _ as useUnshield, m as useUpdateWalletEncryption, L as useX402Payment } from './index-B8OIdrOX.js';
+import { C as ChipiWindowObjectDeps, U as UseChipiWalletObjectConfig } from './index-gNLTF6ix.js';
+export { a as ChipiApprovalRequest, b as ChipiSessionPolicy, g as ChipiWalletData, a2 as PrivacyConfig, a3 as PrivacyKeys, a6 as PrivacyLedgerEvent, a4 as PrivacyStep, a7 as PrivateBalanceInput, R as RegisterSessionConfig, S as SessionState, k as SessionWallet, a5 as ShieldHookInput, Y as ThresholdSignState, i as UseChipiSessionConfig, j as UseChipiSessionReturn, e as UseChipiWalletConfig, f as UseChipiWalletReturn, T as UseGuardianRecoveryReturn, P as UseShhhSignerReturn, X as UseThresholdSignOptions, W as UseThresholdSignReturn, p as UseTransferConfig, M as UseX402PaymentConfig, N as UseX402PaymentReturn, a0 as derivePrivacyAccount, a1 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, Z as useShield, B as useSignTypedData, v as useSyncOnChainTransfers, V as useThresholdSign, o as useTransfer, _ as useUnshield, m as useUpdateWalletEncryption, L as useX402Payment } from './index-gNLTF6ix.js';
 import { StarknetWindowObject } from '@starknet-io/types-js';
 import '@tanstack/react-query';
 import 'starknet';