@crossmint/client-sdk-smart-wallet 0.1.24 → 0.1.26

package/src/ABI/ERC721.json

@@ -1,320 +0,0 @@
-[
-    {
-        "inputs": [
-            {
-                "internalType": "string",
-                "name": "name_",
-                "type": "string"
-            },
-            {
-                "internalType": "string",
-                "name": "symbol_",
-                "type": "string"
-            }
-        ],
-        "stateMutability": "nonpayable",
-        "type": "constructor"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "owner",
-                "type": "address"
-            },
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "approved",
-                "type": "address"
-            },
-            {
-                "indexed": true,
-                "internalType": "uint256",
-                "name": "tokenId",
-                "type": "uint256"
-            }
-        ],
-        "name": "Approval",
-        "type": "event"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "owner",
-                "type": "address"
-            },
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "operator",
-                "type": "address"
-            },
-            {
-                "indexed": false,
-                "internalType": "bool",
-                "name": "approved",
-                "type": "bool"
-            }
-        ],
-        "name": "ApprovalForAll",
-        "type": "event"
-    },
-    {
-        "anonymous": false,
-        "inputs": [
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "from",
-                "type": "address"
-            },
-            {
-                "indexed": true,
-                "internalType": "address",
-                "name": "to",
-                "type": "address"
-            },
-            {
-                "indexed": true,
-                "internalType": "uint256",
-                "name": "tokenId",
-                "type": "uint256"
-            }
-        ],
-        "name": "Transfer",
-        "type": "event"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "to",
-                "type": "address"
-            },
-            {
-                "internalType": "uint256",
-                "name": "tokenId",
-                "type": "uint256"
-            }
-        ],
-        "name": "approve",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "owner",
-                "type": "address"
-            }
-        ],
-        "name": "balanceOf",
-        "outputs": [
-            {
-                "internalType": "uint256",
-                "name": "",
-                "type": "uint256"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "uint256",
-                "name": "tokenId",
-                "type": "uint256"
-            }
-        ],
-        "name": "getApproved",
-        "outputs": [
-            {
-                "internalType": "address",
-                "name": "",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "owner",
-                "type": "address"
-            },
-            {
-                "internalType": "address",
-                "name": "operator",
-                "type": "address"
-            }
-        ],
-        "name": "isApprovedForAll",
-        "outputs": [
-            {
-                "internalType": "bool",
-                "name": "",
-                "type": "bool"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [],
-        "name": "name",
-        "outputs": [
-            {
-                "internalType": "string",
-                "name": "",
-                "type": "string"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "uint256",
-                "name": "tokenId",
-                "type": "uint256"
-            }
-        ],
-        "name": "ownerOf",
-        "outputs": [
-            {
-                "internalType": "address",
-                "name": "",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "from",
-                "type": "address"
-            },
-            {
-                "internalType": "address",
-                "name": "to",
-                "type": "address"
-            },
-            {
-                "internalType": "uint256",
-                "name": "tokenId",
-                "type": "uint256"
-            }
-        ],
-        "name": "safeTransferFrom",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "operator",
-                "type": "address"
-            },
-            {
-                "internalType": "bool",
-                "name": "approved",
-                "type": "bool"
-            }
-        ],
-        "name": "setApprovalForAll",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "bytes4",
-                "name": "interfaceId",
-                "type": "bytes4"
-            }
-        ],
-        "name": "supportsInterface",
-        "outputs": [
-            {
-                "internalType": "bool",
-                "name": "",
-                "type": "bool"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [],
-        "name": "symbol",
-        "outputs": [
-            {
-                "internalType": "string",
-                "name": "",
-                "type": "string"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "uint256",
-                "name": "tokenId",
-                "type": "uint256"
-            }
-        ],
-        "name": "tokenURI",
-        "outputs": [
-            {
-                "internalType": "string",
-                "name": "",
-                "type": "string"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "from",
-                "type": "address"
-            },
-            {
-                "internalType": "address",
-                "name": "to",
-                "type": "address"
-            },
-            {
-                "internalType": "uint256",
-                "name": "tokenId",
-                "type": "uint256"
-            }
-        ],
-        "name": "transferFrom",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    }
-]

package/src/SmartWalletSDK.test.ts

@@ -1,31 +0,0 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
-
-import { SmartWalletSDK } from "./SmartWalletSDK";
-
-vi.mock("./services/logging");
-
-// Mock global window object
-vi.stubGlobal("window", {
-    location: {
-        origin: "http://localhost",
-    },
-});
-
-describe("SmartWalletSDK", () => {
-    let sdk: SmartWalletSDK;
-
-    beforeEach(() => {
-        // Reset mocks before each test
-        vi.clearAllMocks();
-        sdk = SmartWalletSDK.init({
-            clientApiKey:
-                "sk_staging_A4vDwAp4t5az6fVQMpQK6qapBnAqgpxrrD35TaFQnyKgxehNbd959uZeaHjNCadWDXrgLRAK1CxeasZjtYEq4TbFkKMBBvbQ9oinAxQf8LbHsSYW2DMzT8fBko3YGLq9t7ZiXZjmgkTioxGVUUjyLtWLeBKwNUDLgpshWjaoR7pKRnSE9SqhwjQbiK62VKiBTdA3KvHsyG9k8mLMcKrDyfXp",
-        });
-    });
-
-    describe("init", () => {
-        it("should initialize the SDK correctly", () => {
-            expect(sdk).toBeInstanceOf(SmartWalletSDK);
-        });
-    });
-});

package/src/SmartWalletSDK.ts

@@ -1,104 +0,0 @@
-import { stringify } from "viem";
-
-import { type APIKeyEnvironmentPrefix, validateAPIKey } from "@crossmint/common-sdk-base";
-
-import { CrossmintWalletService } from "./api/CrossmintWalletService";
-import { type SmartWalletChain, isMainnetChain, isTestnetChain } from "./blockchain/chains";
-import type { EVMSmartWallet } from "./blockchain/wallets";
-import { AccountConfigCache } from "./blockchain/wallets/account/cache";
-import { AccountConfigService } from "./blockchain/wallets/account/config";
-import { AccountCreator } from "./blockchain/wallets/account/creator";
-import { EOACreationStrategy } from "./blockchain/wallets/account/eoa";
-import { PasskeyCreationStrategy } from "./blockchain/wallets/account/passkey";
-import { ClientDecorator } from "./blockchain/wallets/clientDecorator";
-import { SmartWalletService } from "./blockchain/wallets/service";
-import { SmartWalletError } from "./error";
-import { ErrorProcessor } from "./error/processor";
-import { scwDatadogLogger, scwLogger } from "./services";
-import type { SmartWalletSDKInitParams, UserParams, WalletParams } from "./types/params";
-import { SDK_VERSION } from "./utils/constants";
-import { isClient } from "./utils/environment";
-
-export class SmartWalletSDK {
-    private constructor(
-        private readonly crossmintEnv: APIKeyEnvironmentPrefix,
-        private readonly smartWalletService: SmartWalletService,
-        private readonly errorProcessor: ErrorProcessor,
-        private readonly logger = scwLogger
-    ) {}
-
-    /**
-     * Initializes the SDK with the **client side** API key obtained from the Crossmint console.
-     * @throws error if the api key is not formatted correctly.
-     */
-    static init({ clientApiKey }: SmartWalletSDKInitParams): SmartWalletSDK {
-        const validationResult = validateAPIKey(clientApiKey);
-        if (!validationResult.isValid) {
-            throw new Error("API key invalid");
-        }
-
-        const crossmintService = new CrossmintWalletService(clientApiKey);
-        const errorProcessor = new ErrorProcessor(scwDatadogLogger);
-        const accountCreator = new AccountCreator(
-            new EOACreationStrategy(),
-            new PasskeyCreationStrategy(crossmintService.getPasskeyServerUrl(), clientApiKey)
-        );
-        const accountCache = new AccountConfigCache(`smart-wallet-${SDK_VERSION}`);
-
-        const smartWalletService = new SmartWalletService(
-            crossmintService,
-            new AccountConfigService(crossmintService, accountCache),
-            accountCreator,
-            new ClientDecorator(errorProcessor)
-        );
-
-        return new SmartWalletSDK(validationResult.environment, smartWalletService, errorProcessor);
-    }
-
-    /**
-     * Retrieves or creates a wallet for the specified user.
-     * The default configuration is a `PasskeySigner` with the name, which is displayed to the user during creation or signing prompts, derived from the provided jwt.
-     *
-     * Example using the default passkey signer:
-     * ```ts
-     * const wallet = await smartWalletSDK.getOrCreateWallet({ jwt: "xxx" }, "base");
-     * ```
-     */
-    async getOrCreateWallet(
-        user: UserParams,
-        chain: SmartWalletChain,
-        walletParams: WalletParams = { signer: { type: "PASSKEY" } }
-    ): Promise<EVMSmartWallet> {
-        if (!isClient()) {
-            throw new SmartWalletError("Smart Wallet SDK should only be used client side.");
-        }
-        this.assertValidChain(chain);
-
-        return await this.logger.logPerformance("GET_OR_CREATE_WALLET", async () => {
-            try {
-                return await this.smartWalletService.getOrCreate(user, chain, walletParams);
-            } catch (error: any) {
-                throw this.errorProcessor.map(
-                    error,
-                    new SmartWalletError(`Wallet creation failed: ${error.message}.`, stringify(error))
-                );
-            }
-        });
-    }
-
-    private assertValidChain(chain: SmartWalletChain) {
-        if (!this.validChain(chain)) {
-            throw new SmartWalletError(
-                `The selected chain "${chain}" is not available in "${this.crossmintEnv}". Either set a valid chain or check you're using an API key for the environment you're trying to target.`
-            );
-        }
-    }
-
-    private validChain(chain: SmartWalletChain): boolean {
-        if (this.crossmintEnv === "development" || this.crossmintEnv === "staging") {
-            return isTestnetChain(chain);
-        }
-
-        return isMainnetChain(chain);
-    }
-}

package/src/api/CrossmintWalletService.test.ts

@@ -1,43 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-
-import { CROSSMINT_STG_URL } from "@crossmint/common-sdk-base";
-
-import { CrossmintWalletService } from "./CrossmintWalletService";
-
-vi.mock("../services/logging", () => ({
-    logError: vi.fn(),
-    logInfo: vi.fn(),
-}));
-
-vi.mock("../utils/helpers", () => ({
-    isLocalhost: vi.fn().mockReturnValue(true),
-}));
-
-describe("CrossmintService", () => {
-    let crossmintService: CrossmintWalletService;
-    const apiKey =
-        "sk_staging_A4vDwAp4t5az6fVQMpQK6qapBnAqgpxrrD35TaFQnyKgxehNbd959uZeaHjNCadWDXrgLRAK1CxeasZjtYEq4TbFkKMBBvbQ9oinAxQf8LbHsSYW2DMzT8fBko3YGLq9t7ZiXZjmgkTioxGVUUjyLtWLeBKwNUDLgpshWjaoR7pKRnSE9SqhwjQbiK62VKiBTdA3KvHsyG9k8mLMcKrDyfXp";
-
-    beforeEach(() => {
-        crossmintService = new CrossmintWalletService(apiKey);
-    });
-
-    describe("constructor", () => {
-        it("should initialize with correct headers and base URL", () => {
-            expect(crossmintService).toBeDefined();
-
-            expect(crossmintService["crossmintAPIHeaders"]).toEqual({
-                accept: "application/json",
-                "content-type": "application/json",
-                "x-api-key": apiKey,
-            });
-
-            // Check if the base URL is correctly set to the staging URL
-            expect(crossmintService["crossmintBaseUrl"]).toBe(CROSSMINT_STG_URL);
-        });
-    });
-
-    afterEach(() => {
-        vi.clearAllMocks();
-    });
-});

package/src/api/CrossmintWalletService.ts

@@ -1,84 +0,0 @@
-import type { UserOperation } from "permissionless";
-import type { EntryPoint, GetEntryPointVersion } from "permissionless/types/entrypoint";
-
-import { APIErrorService, BaseCrossmintService, CrossmintServiceError } from "@crossmint/client-sdk-base";
-import { blockchainToChainId } from "@crossmint/common-sdk-base";
-
-import type { SmartWalletChain } from "../blockchain/chains";
-import { AdminAlreadyUsedError, SmartWalletsNotEnabledError, UserWalletAlreadyCreatedError } from "../error";
-import { scwLogger } from "../services";
-import type { UserParams } from "../types/params";
-import { SmartWalletConfigSchema } from "../types/schema";
-import type { SmartWalletConfig, StoreSmartWalletParams } from "../types/service";
-import { bigintsToHex, parseBigintAPIResponse } from "../utils/api";
-import { API_VERSION } from "../utils/constants";
-
-type WalletsAPIErrorCodes =
-    | "ERROR_USER_WALLET_ALREADY_CREATED"
-    | "ERROR_ADMIN_SIGNER_ALREADY_USED"
-    | "ERROR_PROJECT_NONCUSTODIAL_WALLETS_NOT_ENABLED";
-
-export class CrossmintWalletService extends BaseCrossmintService {
-    logger = scwLogger;
-    protected apiErrorService = new APIErrorService<WalletsAPIErrorCodes>({
-        ERROR_USER_WALLET_ALREADY_CREATED: ({ userId }: { userId: string }) =>
-            new UserWalletAlreadyCreatedError(userId),
-        ERROR_ADMIN_SIGNER_ALREADY_USED: () => new AdminAlreadyUsedError(),
-        ERROR_PROJECT_NONCUSTODIAL_WALLETS_NOT_ENABLED: () => new SmartWalletsNotEnabledError(),
-    });
-
-    async idempotentCreateSmartWallet(user: UserParams, input: StoreSmartWalletParams): Promise<void> {
-        await this.fetchCrossmintAPI(
-            `${API_VERSION}/sdk/smart-wallet`,
-            { method: "PUT", body: JSON.stringify(input) },
-            "Error creating abstract wallet. Please contact support",
-            user.jwt
-        );
-    }
-
-    async sponsorUserOperation<E extends EntryPoint>(
-        user: UserParams,
-        userOp: UserOperation<GetEntryPointVersion<E>>,
-        entryPoint: E,
-        chain: SmartWalletChain
-    ): Promise<{ sponsorUserOpParams: UserOperation<GetEntryPointVersion<E>> }> {
-        const chainId = blockchainToChainId(chain);
-        const result = await this.fetchCrossmintAPI(
-            `${API_VERSION}/sdk/paymaster`,
-            { method: "POST", body: JSON.stringify({ userOp: bigintsToHex(userOp), entryPoint, chainId }) },
-            "Error sponsoring user operation. Please contact support",
-            user.jwt
-        );
-        return parseBigintAPIResponse(result);
-    }
-
-    async getSmartWalletConfig(user: UserParams, chain: SmartWalletChain): Promise<SmartWalletConfig> {
-        const data: unknown = await this.fetchCrossmintAPI(
-            `${API_VERSION}/sdk/smart-wallet/config?chain=${chain}`,
-            { method: "GET" },
-            "Error getting smart wallet version configuration. Please contact support",
-            user.jwt
-        );
-
-        const result = SmartWalletConfigSchema.safeParse(data);
-        if (!result.success) {
-            throw new CrossmintServiceError(
-                `Invalid smart wallet config, please contact support. Details below:\n${result.error.toString()}`
-            );
-        }
-
-        return result.data;
-    }
-
-    async fetchNFTs(address: string, chain: SmartWalletChain) {
-        return this.fetchCrossmintAPI(
-            `v1-alpha1/wallets/${chain}:${address}/nfts`,
-            { method: "GET" },
-            `Error fetching NFTs for wallet: ${address}`
-        );
-    }
-
-    public getPasskeyServerUrl(): string {
-        return this.crossmintBaseUrl + "api/internal/passkeys";
-    }
-}

package/src/blockchain/chains.ts

@@ -1,57 +0,0 @@
-import {
-    type Chain,
-    arbitrum,
-    arbitrumSepolia,
-    base,
-    baseSepolia,
-    optimism,
-    optimismSepolia,
-    polygon,
-    polygonAmoy,
-} from "viem/chains";
-
-import { BlockchainIncludingTestnet as Blockchain, type ObjectValues, objectValues } from "@crossmint/common-sdk-base";
-
-export const SmartWalletTestnet = {
-    BASE_SEPOLIA: Blockchain.BASE_SEPOLIA,
-    POLYGON_AMOY: Blockchain.POLYGON_AMOY,
-    OPTIMISM_SEPOLIA: Blockchain.OPTIMISM_SEPOLIA,
-    ARBITRUM_SEPOLIA: Blockchain.ARBITRUM_SEPOLIA,
-} as const;
-export type SmartWalletTestnet = ObjectValues<typeof SmartWalletTestnet>;
-export const SMART_WALLET_TESTNETS = objectValues(SmartWalletTestnet);
-
-export const SmartWalletMainnet = {
-    BASE: Blockchain.BASE,
-    POLYGON: Blockchain.POLYGON,
-    OPTIMISM: Blockchain.OPTIMISM,
-    ARBITRUM: Blockchain.ARBITRUM,
-} as const;
-export type SmartWalletMainnet = ObjectValues<typeof SmartWalletMainnet>;
-export const SMART_WALLET_MAINNETS = objectValues(SmartWalletMainnet);
-
-export const SmartWalletChain = {
-    ...SmartWalletTestnet,
-    ...SmartWalletMainnet,
-} as const;
-export type SmartWalletChain = ObjectValues<typeof SmartWalletChain>;
-export const SMART_WALLET_CHAINS = objectValues(SmartWalletChain);
-
-export function isTestnetChain(chain: SmartWalletChain): chain is SmartWalletTestnet {
-    return (SMART_WALLET_TESTNETS as any).includes(chain);
-}
-
-export function isMainnetChain(chain: SmartWalletChain): chain is SmartWalletMainnet {
-    return (SMART_WALLET_MAINNETS as any).includes(chain);
-}
-
-export const viemNetworks: Record<SmartWalletChain, Chain> = {
-    polygon: polygon,
-    "polygon-amoy": polygonAmoy,
-    base: base,
-    "base-sepolia": baseSepolia,
-    optimism: optimism,
-    "optimism-sepolia": optimismSepolia,
-    arbitrum: arbitrum,
-    "arbitrum-sepolia": arbitrumSepolia,
-};

package/src/blockchain/rpc.ts

@@ -1,25 +0,0 @@
-import { blockchainToChainId } from "@crossmint/common-sdk-base";
-
-import type { SmartWalletChain } from "./chains";
-
-const ALCHEMY_API_KEY = "-7M6vRDBDknwvMxnqah_jbcieWg0qad9";
-const PIMLICO_API_KEY = "pim_9dKmQPxiTCvtbUNF7XFBbA";
-
-export const ALCHEMY_RPC_SUBDOMAIN: Record<SmartWalletChain, string> = {
-    polygon: "polygon-mainnet",
-    "polygon-amoy": "polygon-amoy",
-    base: "base-mainnet",
-    "base-sepolia": "base-sepolia",
-    optimism: "opt-mainnet",
-    "optimism-sepolia": "opt-sepolia",
-    arbitrum: "arb-mainnet",
-    "arbitrum-sepolia": "arb-sepolia",
-};
-
-export function getAlchemyRPC(chain: SmartWalletChain): string {
-    return `https://${ALCHEMY_RPC_SUBDOMAIN[chain]}.g.alchemy.com/v2/${ALCHEMY_API_KEY}`;
-}
-
-export function getPimlicoBundlerRPC(chain: SmartWalletChain): string {
-    return `https://api.pimlico.io/v2/${blockchainToChainId(chain)}/rpc?apikey=${PIMLICO_API_KEY}`;
-}