@crossmint/client-sdk-smart-wallet 0.1.1 → 0.1.2

package/src/blockchain/wallets/passkey.ts

@@ -3,11 +3,17 @@ import { type PasskeySignerData, displayPasskey } from "@/types/API";
 import type { PasskeySigner, UserParams, WalletParams } from "@/types/Config";
 import type { AccountAndSigner, PasskeyValidatorSerializedData, WalletCreationParams } from "@/types/internal";
 import { PasskeyValidatorContractVersion, WebAuthnMode, toPasskeyValidator } from "@zerodev/passkey-validator";
-import { type KernelValidator, createKernelAccount } from "@zerodev/sdk";
-import { WebAuthnKey, toWebAuthnKey } from "@zerodev/webauthn-key";
+import { type KernelSmartAccount, type KernelValidator, createKernelAccount } from "@zerodev/sdk";
+import { type WebAuthnKey, toWebAuthnKey } from "@zerodev/webauthn-key";
+import type { SmartAccount } from "permissionless/accounts";
 import type { EntryPoint } from "permissionless/types/entrypoint";
 
-import { PasskeyMismatchError } from "../../error";
+import {
+    PasskeyIncompatibleAuthenticatorError,
+    PasskeyMismatchError,
+    PasskeyPromptError,
+    PasskeyRegistrationError,
+} from "../../error";
 
 export interface PasskeyWalletParams extends WalletCreationParams {
     walletParams: WalletParams & { signer: PasskeySigner };
@@ -20,7 +26,6 @@ export function isPasskeyParams(params: WalletCreationParams): params is Passkey
 type PasskeyValidator = KernelValidator<EntryPoint, "WebAuthnValidator"> & {
     getSerializedData: () => string;
 };
-
 export class PasskeyAccountService {
     constructor(private readonly crossmintService: CrossmintWalletService) {}
 
@@ -36,28 +41,32 @@ export class PasskeyAccountService {
             );
         }
 
-        const passkey = await this.getPasskey(user, inputPasskeyName, existingSignerConfig);
-
-        const latestValidatorVersion = PasskeyValidatorContractVersion.V0_0_2;
-        const validatorContractVersion =
-            existingSignerConfig == null ? latestValidatorVersion : existingSignerConfig.validatorContractVersion;
-        const validator = await toPasskeyValidator(publicClient, {
-            webAuthnKey: passkey,
-            entryPoint: entryPoint.address,
-            validatorContractVersion,
-            kernelVersion,
-        });
+        try {
+            const passkey = await this.getPasskey(user, inputPasskeyName, existingSignerConfig);
+
+            const latestValidatorVersion = PasskeyValidatorContractVersion.V0_0_2;
+            const validatorContractVersion =
+                existingSignerConfig == null ? latestValidatorVersion : existingSignerConfig.validatorContractVersion;
+            const validator = await toPasskeyValidator(publicClient, {
+                webAuthnKey: passkey,
+                entryPoint: entryPoint.address,
+                validatorContractVersion,
+                kernelVersion,
+            });
+
+            const kernelAccount = await createKernelAccount(publicClient, {
+                plugins: { sudo: validator },
+                entryPoint: entryPoint.address,
+                kernelVersion,
+            });
 
-        const kernelAccount = await createKernelAccount(publicClient, {
-            plugins: { sudo: validator },
-            entryPoint: entryPoint.address,
-            kernelVersion,
-        });
-
-        return {
-            signerData: this.getSignerData(validator, validatorContractVersion, inputPasskeyName),
-            account: kernelAccount,
-        };
+            return {
+                signerData: this.getSignerData(validator, validatorContractVersion, inputPasskeyName),
+                account: this.decorate(kernelAccount, inputPasskeyName),
+            };
+        } catch (error) {
+            throw this.mapError(error, inputPasskeyName);
+        }
     }
 
     private async getPasskey(
@@ -102,6 +111,52 @@ export class PasskeyAccountService {
             Authorization: `Bearer ${user.jwt}`,
         };
     }
+
+    private mapError(error: any, passkeyName: string) {
+        if (error.code === 0 && error.name === "DataError") {
+            return new PasskeyIncompatibleAuthenticatorError(passkeyName);
+        }
+
+        if (error.message === "Registration not verified") {
+            return new PasskeyRegistrationError(passkeyName);
+        }
+
+        if (error.code === "ERROR_PASSTHROUGH_SEE_CAUSE_PROPERTY" && error.name === "NotAllowedError") {
+            return new PasskeyPromptError(passkeyName);
+        }
+
+        return error;
+    }
+
+    private decorate<Account extends KernelSmartAccount<EntryPoint>>(account: Account, passkeyName: string): Account {
+        return new Proxy(account, {
+            get: (target, prop, receiver) => {
+                const original = Reflect.get(target, prop, receiver);
+                if (typeof original !== "function" || typeof prop !== "string" || !isAccountSigningMethod(prop)) {
+                    return original;
+                }
+
+                return async (...args: any[]) => {
+                    try {
+                        return await original.call(target, ...args);
+                    } catch (error) {
+                        throw this.mapError(error, passkeyName);
+                    }
+                };
+            },
+        });
+    }
+}
+
+const accountSigningMethods = [
+    "signMessage",
+    "signTypedData",
+    "signUserOperation",
+    "signTransaction",
+] as const satisfies readonly (keyof SmartAccount<EntryPoint>)[];
+
+function isAccountSigningMethod(method: string): method is (typeof accountSigningMethods)[number] {
+    return accountSigningMethods.includes(method as any);
 }
 
 const deserializePasskeyValidatorData = (params: string) => {

package/src/error/index.ts

@@ -13,6 +13,9 @@ export const SmartWalletErrors = {
     ERROR_WALLET_CONFIG: "smart-wallet:wallet-config.error",
     ERROR_ADMIN_MISMATCH: "smart-wallet:wallet-config.admin-mismatch",
     ERROR_PASSKEY_MISMATCH: "smart-wallet:wallet-config.passkey-mismatch",
+    ERROR_PASSKEY_PROMPT: "smart-wallet:passkey.prompt",
+    ERROR_PASSKEY_INCOMPATIBLE_AUTHENTICATOR: "smart-wallet.passkey.incompatible-authenticator",
+    ERROR_PASSKEY_REGISTRATION: "smart-wallet:passkey.registration",
     ERROR_ADMIN_SIGNER_ALREADY_USED: "smart-wallet:wallet-config.admin-signer-already-used",
     ERROR_PROJECT_NONCUSTODIAL_WALLETS_NOT_ENABLED: "smart-wallet:wallet-config.non-custodial-wallets-not-enabled",
     UNCATEGORIZED: "smart-wallet:uncategorized", // catch-all error code
@@ -119,6 +122,45 @@ export class UserWalletAlreadyCreatedError extends SmartWalletSDKError {
     }
 }
 
+export class PasskeyPromptError extends SmartWalletSDKError {
+    public passkeyName: string;
+
+    constructor(passkeyName: string) {
+        super(
+            `Prompt was either cancelled or timed out for passkey ${passkeyName}`,
+            undefined,
+            SmartWalletErrors.ERROR_PASSKEY_PROMPT
+        );
+        this.passkeyName = passkeyName;
+    }
+}
+
+export class PasskeyRegistrationError extends SmartWalletSDKError {
+    public passkeyName: string;
+
+    constructor(passkeyName: string) {
+        super(
+            `Registration for passkey ${passkeyName} failed, either the registration took too long, or passkey signature vaildation failed.`,
+            undefined,
+            SmartWalletErrors.ERROR_PASSKEY_REGISTRATION
+        );
+        this.passkeyName = passkeyName;
+    }
+}
+
+export class PasskeyIncompatibleAuthenticatorError extends SmartWalletSDKError {
+    public passkeyName: string;
+
+    constructor(passkeyName: string) {
+        super(
+            `User selected authenticator for passkey ${passkeyName} is not compatible with Crossmint's Smart Wallets.`,
+            undefined,
+            SmartWalletErrors.ERROR_PASSKEY_INCOMPATIBLE_AUTHENTICATOR
+        );
+        this.passkeyName = passkeyName;
+    }
+}
+
 export class OutOfCreditsError extends SmartWalletSDKError {
     constructor(message?: string) {
         super(

package/src/index.ts

@@ -1,4 +1,4 @@
-export { blockchainToChainId } from "@crossmint/common-sdk-base";
+export { blockchainToChainId, EVMBlockchainIncludingTestnet as Chain } from "@crossmint/common-sdk-base";
 
 export { EVMSmartWallet } from "./blockchain/wallets/EVMSmartWallet";
 
@@ -12,7 +12,6 @@ export type {
 } from "./types/Config";
 
 export type { TransferType, ERC20TransferType, NFTTransferType, SFTTransferType } from "./types/Tokens";
-export { SmartWalletChain } from "./blockchain/chains";
 
 export {
     TransferError,
@@ -28,6 +27,9 @@ export {
     AdminAlreadyUsedError,
     AdminMismatchError,
     PasskeyMismatchError,
+    PasskeyPromptError,
+    PasskeyRegistrationError,
+    PasskeyIncompatibleAuthenticatorError,
     ConfigError,
     NonCustodialWalletsNotEnabledError,
 } from "./error";

package/src/types/Tokens.ts

@@ -1,4 +1,4 @@
-import { SmartWalletChain } from "..";
+import type { SmartWalletChain } from "../blockchain/chains";
 
 export interface EVMToken {
     chain: SmartWalletChain;

package/src/types/internal.ts

@@ -4,7 +4,7 @@ import type { SmartAccount } from "permissionless/accounts";
 import type { EntryPoint } from "permissionless/types/entrypoint";
 import type { Chain, Hex, HttpTransport, PublicClient } from "viem";
 
-import { SmartWalletChain } from "..";
+import type { SmartWalletChain } from "../blockchain/chains";
 import type { SignerData } from "./API";
 import type { EntryPointDetails, UserParams, WalletParams } from "./Config";
 

package/src/utils/blockchain.ts

@@ -1,4 +1,4 @@
-import { SmartWalletChain } from "..";
+import { SmartWalletChain } from "../blockchain/chains";
 
 export function usesGelatoBundler(chain: SmartWalletChain) {
     return false;

package/src/utils/signer.ts

@@ -2,7 +2,7 @@ import { providerToSmartAccountSigner } from "permissionless";
 import type { SmartAccountSigner } from "permissionless/accounts";
 import { Address, EIP1193Provider } from "viem";
 
-import { SmartWalletChain } from "..";
+import { SmartWalletChain } from "../blockchain/chains";
 import { SmartWalletSDKError } from "../error";
 import { ViemAccount, WalletParams } from "../types/Config";
 import { logInputOutput } from "./log";

package/src/blockchain/token/index.ts

@@ -1 +0,0 @@
-export * from "./Tokens";