@chipi-stack/types 14.15.0 → 14.15.1

package/dist/index.d.mts

@@ -87,9 +87,15 @@ type WalletType = "CHIPI" | "READY" | "SHHH" | (string & {});
 type ShhhSignerKind = "STARK" | "ED25519" | "SECP256K1" | "EIP191_SECP256K1" | "EIP712_SECP256K1" | "P256" | "WEBAUTHN_P256" | "JWT_ES256" | "JWT_ES256_APPLE_SUB" | "BLS12_381";
 /**
  * Authentication method used for wallet encryption.
- * - "passkey": passkey only (no PIN backup — legacy, not recommended)
- * - "pin": PIN only (current default)
- * - "passkey+pin": passkey primary + PIN backup (recommended default)
+ * - "passkey": passkey only. On the web the wrap key is the WebAuthn PRF
+ *   output, derived on the device; the passkey's platform sync (iCloud
+ *   Keychain, Google Password Manager) is the recovery path. The recommended
+ *   choice for self-custodial web apps. On Expo the key is a random key kept
+ *   in this device's secure storage only, so pair it with a PIN backup there.
+ * - "pin": PIN only (legacy). A short PIN can be brute-forced offline against
+ *   the stored ciphertext.
+ * - "passkey+pin": passkey primary + PIN backup. The backup is only as strong
+ *   as the PIN (same offline brute-force exposure as "pin").
  */
 type AuthMethod = "passkey" | "pin" | "passkey+pin";
 interface WalletData {
@@ -114,6 +120,12 @@ interface DeploymentData {
     calldata: string[];
 }
 interface CreateWalletParams {
+    /**
+     * Key that encrypts the private key. A PIN, or a passkey-derived key.
+     * With `useCreateWallet` and `usePasskey: true` it is optional: omit it for a
+     * passkey-only wallet, or pass a PIN to keep it as a backup.
+     * Required on the server SDK.
+     */
     encryptKey?: string;
     externalUserId: string;
     userId?: string;
@@ -155,10 +167,18 @@ interface CreateWalletParams {
      * itself.
      */
     ownerPubkeyFelts?: string[];
+    /**
+     * Browser/Expo hooks only (`useCreateWallet`): create a passkey and use the
+     * key it yields as `encryptKey`. The server SDK does not create passkeys.
+     */
     usePasskey?: boolean;
-    /** PIN for backup encryption (dual-key wrapping). Required when usePasskey: true. */
+    /**
+     * Optional PIN for a backup copy of the private key (dual-key wrapping).
+     * `useCreateWallet` fills it from `encryptKey` when `usePasskey: true` and a
+     * PIN is given; omit both for a passkey-only wallet.
+     */
     encryptKeyBackup?: string;
-    /** Auth method: "passkey+pin" for dual-key, "pin" for PIN-only */
+    /** Auth method: "passkey" (passkey only), "passkey+pin" (dual-key) or "pin" (PIN only) */
     authMethod?: AuthMethod;
     /** WebAuthn credential ID stored in backend for recovery */
     credentialId?: string;

package/dist/index.d.ts

@@ -87,9 +87,15 @@ type WalletType = "CHIPI" | "READY" | "SHHH" | (string & {});
 type ShhhSignerKind = "STARK" | "ED25519" | "SECP256K1" | "EIP191_SECP256K1" | "EIP712_SECP256K1" | "P256" | "WEBAUTHN_P256" | "JWT_ES256" | "JWT_ES256_APPLE_SUB" | "BLS12_381";
 /**
  * Authentication method used for wallet encryption.
- * - "passkey": passkey only (no PIN backup — legacy, not recommended)
- * - "pin": PIN only (current default)
- * - "passkey+pin": passkey primary + PIN backup (recommended default)
+ * - "passkey": passkey only. On the web the wrap key is the WebAuthn PRF
+ *   output, derived on the device; the passkey's platform sync (iCloud
+ *   Keychain, Google Password Manager) is the recovery path. The recommended
+ *   choice for self-custodial web apps. On Expo the key is a random key kept
+ *   in this device's secure storage only, so pair it with a PIN backup there.
+ * - "pin": PIN only (legacy). A short PIN can be brute-forced offline against
+ *   the stored ciphertext.
+ * - "passkey+pin": passkey primary + PIN backup. The backup is only as strong
+ *   as the PIN (same offline brute-force exposure as "pin").
  */
 type AuthMethod = "passkey" | "pin" | "passkey+pin";
 interface WalletData {
@@ -114,6 +120,12 @@ interface DeploymentData {
     calldata: string[];
 }
 interface CreateWalletParams {
+    /**
+     * Key that encrypts the private key. A PIN, or a passkey-derived key.
+     * With `useCreateWallet` and `usePasskey: true` it is optional: omit it for a
+     * passkey-only wallet, or pass a PIN to keep it as a backup.
+     * Required on the server SDK.
+     */
     encryptKey?: string;
     externalUserId: string;
     userId?: string;
@@ -155,10 +167,18 @@ interface CreateWalletParams {
      * itself.
      */
     ownerPubkeyFelts?: string[];
+    /**
+     * Browser/Expo hooks only (`useCreateWallet`): create a passkey and use the
+     * key it yields as `encryptKey`. The server SDK does not create passkeys.
+     */
     usePasskey?: boolean;
-    /** PIN for backup encryption (dual-key wrapping). Required when usePasskey: true. */
+    /**
+     * Optional PIN for a backup copy of the private key (dual-key wrapping).
+     * `useCreateWallet` fills it from `encryptKey` when `usePasskey: true` and a
+     * PIN is given; omit both for a passkey-only wallet.
+     */
     encryptKeyBackup?: string;
-    /** Auth method: "passkey+pin" for dual-key, "pin" for PIN-only */
+    /** Auth method: "passkey" (passkey only), "passkey+pin" (dual-key) or "pin" (PIN only) */
     authMethod?: AuthMethod;
     /** WebAuthn credential ID stored in backend for recovery */
     credentialId?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chipi-stack/types",
-  "version": "14.15.0",
+  "version": "14.15.1",
   "description": "Type definitions for Chipi SDK packages",
   "keywords": [
     "chipi",