@dynamic-labs/wallet-book 0.0.0-exp20240808.0

package/src/schemas/walletSchema.d.ts

@@ -0,0 +1,614 @@
+import { z } from 'zod';
+declare const injectedConfigSchema: z.ZodObject<{
+    chain: z.ZodString;
+    extensionLocators: z.ZodArray<z.ZodObject<{
+        flag: z.ZodString;
+        value: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        value: boolean;
+        flag: string;
+    }, {
+        flag: string;
+        value?: boolean | undefined;
+    }>, "many">;
+    /**
+     * Allows declaring which interface, if any, this wallet's implementation follows
+     * ex. Leather with https://btckit.org/
+     */
+    providerInterface: z.ZodOptional<z.ZodString>;
+    /**
+     * Allows declaring that this wallet is discoverable through the the Wallet Standard
+     * See https://github.com/wallet-standard/wallet-standard
+     * Also allows ignoring wallets that don't support the provided features
+     */
+    walletStandard: z.ZodOptional<z.ZodObject<{
+        features: z.ZodArray<z.ZodString, "many">;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        features: string[];
+        name: string;
+    }, {
+        features: string[];
+        name: string;
+    }>>;
+    walletStandardLocators: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        locator: z.ZodString;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        locator: string;
+    }, {
+        name: string;
+        locator: string;
+    }>, "many">>;
+    windowLocations: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodString, "many">>, string[] | undefined, string[] | undefined>;
+}, "strip", z.ZodTypeAny, {
+    chain: string;
+    extensionLocators: {
+        value: boolean;
+        flag: string;
+    }[];
+    providerInterface?: string | undefined;
+    walletStandard?: {
+        features: string[];
+        name: string;
+    } | undefined;
+    walletStandardLocators?: {
+        name: string;
+        locator: string;
+    }[] | undefined;
+    windowLocations?: string[] | undefined;
+}, {
+    chain: string;
+    extensionLocators: {
+        flag: string;
+        value?: boolean | undefined;
+    }[];
+    providerInterface?: string | undefined;
+    walletStandard?: {
+        features: string[];
+        name: string;
+    } | undefined;
+    walletStandardLocators?: {
+        name: string;
+        locator: string;
+    }[] | undefined;
+    windowLocations?: string[] | undefined;
+}>;
+export declare const brandSchema: z.ZodObject<{
+    alt: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    primaryColor: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    spriteId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+}, "strip", z.ZodTypeAny, {
+    alt?: string | undefined;
+    primaryColor?: string | undefined;
+    spriteId?: string | undefined;
+}, {
+    alt?: unknown;
+    primaryColor?: unknown;
+    spriteId?: unknown;
+}>;
+export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
+    brand: z.ZodOptional<z.ZodObject<{
+        alt: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        primaryColor: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        spriteId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    }, "strip", z.ZodTypeAny, {
+        alt?: string | undefined;
+        primaryColor?: string | undefined;
+        spriteId?: string | undefined;
+    }, {
+        alt?: unknown;
+        primaryColor?: unknown;
+        spriteId?: unknown;
+    }>>;
+    chainGroup: z.ZodOptional<z.ZodString>;
+    chains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    desktop: z.ZodEffects<z.ZodOptional<z.ZodObject<{
+        chromeId: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>, string | undefined, unknown>;
+        edgeId: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>, string | undefined, unknown>;
+        firefoxId: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>, string | undefined, unknown>;
+        native: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        operaId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        safariId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        universal: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    }, "strip", z.ZodTypeAny, {
+        chromeId?: string | undefined;
+        edgeId?: string | undefined;
+        firefoxId?: string | undefined;
+        native?: string | undefined;
+        operaId?: string | undefined;
+        safariId?: string | undefined;
+        universal?: string | undefined;
+    }, {
+        chromeId?: unknown;
+        edgeId?: unknown;
+        firefoxId?: unknown;
+        native?: unknown;
+        operaId?: unknown;
+        safariId?: unknown;
+        universal?: unknown;
+    }>>, {
+        chromeId?: string | undefined;
+        edgeId?: string | undefined;
+        firefoxId?: string | undefined;
+        native?: string | undefined;
+        operaId?: string | undefined;
+        safariId?: string | undefined;
+        universal?: string | undefined;
+    } | undefined, {
+        chromeId?: unknown;
+        edgeId?: unknown;
+        firefoxId?: unknown;
+        native?: unknown;
+        operaId?: unknown;
+        safariId?: unknown;
+        universal?: unknown;
+    } | undefined>;
+    eip6963Config: z.ZodOptional<z.ZodObject<{
+        rdns: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        rdns: string;
+    }, {
+        rdns: string;
+    }>>;
+    filterFromWalletConnect: z.ZodOptional<z.ZodBoolean>;
+    group: z.ZodOptional<z.ZodString>;
+    /**
+     * Indicates which hardware wallets are enabled for this wallet
+     */
+    hardwareWallets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    injectedConfig: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        chain: z.ZodString;
+        extensionLocators: z.ZodArray<z.ZodObject<{
+            flag: z.ZodString;
+            value: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        }, "strip", z.ZodTypeAny, {
+            value: boolean;
+            flag: string;
+        }, {
+            flag: string;
+            value?: boolean | undefined;
+        }>, "many">;
+        /**
+         * Allows declaring which interface, if any, this wallet's implementation follows
+         * ex. Leather with https://btckit.org/
+         */
+        providerInterface: z.ZodOptional<z.ZodString>;
+        /**
+         * Allows declaring that this wallet is discoverable through the the Wallet Standard
+         * See https://github.com/wallet-standard/wallet-standard
+         * Also allows ignoring wallets that don't support the provided features
+         */
+        walletStandard: z.ZodOptional<z.ZodObject<{
+            features: z.ZodArray<z.ZodString, "many">;
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            features: string[];
+            name: string;
+        }, {
+            features: string[];
+            name: string;
+        }>>;
+        walletStandardLocators: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            locator: z.ZodString;
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            locator: string;
+        }, {
+            name: string;
+            locator: string;
+        }>, "many">>;
+        windowLocations: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodString, "many">>, string[] | undefined, string[] | undefined>;
+    }, "strip", z.ZodTypeAny, {
+        chain: string;
+        extensionLocators: {
+            value: boolean;
+            flag: string;
+        }[];
+        providerInterface?: string | undefined;
+        walletStandard?: {
+            features: string[];
+            name: string;
+        } | undefined;
+        walletStandardLocators?: {
+            name: string;
+            locator: string;
+        }[] | undefined;
+        windowLocations?: string[] | undefined;
+    }, {
+        chain: string;
+        extensionLocators: {
+            flag: string;
+            value?: boolean | undefined;
+        }[];
+        providerInterface?: string | undefined;
+        walletStandard?: {
+            features: string[];
+            name: string;
+        } | undefined;
+        walletStandardLocators?: {
+            name: string;
+            locator: string;
+        }[] | undefined;
+        windowLocations?: string[] | undefined;
+    }>, "many">>;
+    mobile: z.ZodEffects<z.ZodOptional<z.ZodObject<{
+        android: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        androidId: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>, string | undefined, unknown>;
+        inAppBrowser: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        ios: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        iosId: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>, string | undefined, unknown>;
+        native: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        universal: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    }, "strip", z.ZodTypeAny, {
+        android?: string | null | undefined;
+        androidId?: string | undefined;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: string | undefined;
+        native?: string | undefined;
+        universal?: string | undefined;
+    }, {
+        android?: string | null | undefined;
+        androidId?: unknown;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: unknown;
+        native?: unknown;
+        universal?: unknown;
+    }>>, {
+        android?: string | null | undefined;
+        androidId?: string | undefined;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: string | undefined;
+        native?: string | undefined;
+        universal?: string | undefined;
+    } | undefined, {
+        android?: string | null | undefined;
+        androidId?: unknown;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: unknown;
+        native?: unknown;
+        universal?: unknown;
+    } | undefined>;
+    mobileExperience: z.ZodOptional<z.ZodEnum<["in-app-browser", "redirect"]>>;
+    name: z.ZodString;
+    shortName: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    showOnlyIfInstalled: z.ZodOptional<z.ZodBoolean>;
+    switchNetworkOnlyFromWallet: z.ZodOptional<z.ZodBoolean>;
+    walletConnect: z.ZodEffects<z.ZodOptional<z.ZodObject<{
+        sdks: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodString, "many">>, string[] | undefined, unknown>;
+    }, "strip", z.ZodTypeAny, {
+        sdks?: string[] | undefined;
+    }, {
+        sdks?: unknown;
+    }>>, {
+        sdks?: string[] | undefined;
+    } | undefined, {
+        sdks?: unknown;
+    } | undefined>;
+    walletGroup: z.ZodOptional<z.ZodString>;
+    /**
+     * Indicates which connector methods/events are not supported, keyed by wallet type
+     */
+    walletLimitations: z.ZodOptional<z.ZodObject<{
+        browserExtension: z.ZodOptional<z.ZodObject<{
+            unsupportedEvents: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            unsupportedMethods: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        }, {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        }>>;
+        mobile: z.ZodOptional<z.ZodObject<{
+            unsupportedEvents: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            unsupportedMethods: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        }, {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        browserExtension?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+        mobile?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+    }, {
+        browserExtension?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+        mobile?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    brand?: {
+        alt?: string | undefined;
+        primaryColor?: string | undefined;
+        spriteId?: string | undefined;
+    } | undefined;
+    chainGroup?: string | undefined;
+    chains?: string[] | undefined;
+    desktop?: {
+        chromeId?: string | undefined;
+        edgeId?: string | undefined;
+        firefoxId?: string | undefined;
+        native?: string | undefined;
+        operaId?: string | undefined;
+        safariId?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    eip6963Config?: {
+        rdns: string;
+    } | undefined;
+    filterFromWalletConnect?: boolean | undefined;
+    group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
+    injectedConfig?: {
+        chain: string;
+        extensionLocators: {
+            value: boolean;
+            flag: string;
+        }[];
+        providerInterface?: string | undefined;
+        walletStandard?: {
+            features: string[];
+            name: string;
+        } | undefined;
+        walletStandardLocators?: {
+            name: string;
+            locator: string;
+        }[] | undefined;
+        windowLocations?: string[] | undefined;
+    }[] | undefined;
+    mobile?: {
+        android?: string | null | undefined;
+        androidId?: string | undefined;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: string | undefined;
+        native?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    mobileExperience?: "in-app-browser" | "redirect" | undefined;
+    shortName?: string | undefined;
+    showOnlyIfInstalled?: boolean | undefined;
+    switchNetworkOnlyFromWallet?: boolean | undefined;
+    walletConnect?: {
+        sdks?: string[] | undefined;
+    } | undefined;
+    walletGroup?: string | undefined;
+    walletLimitations?: {
+        browserExtension?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+        mobile?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+    } | undefined;
+}, {
+    name: string;
+    brand?: {
+        alt?: unknown;
+        primaryColor?: unknown;
+        spriteId?: unknown;
+    } | undefined;
+    chainGroup?: string | undefined;
+    chains?: string[] | undefined;
+    desktop?: {
+        chromeId?: unknown;
+        edgeId?: unknown;
+        firefoxId?: unknown;
+        native?: unknown;
+        operaId?: unknown;
+        safariId?: unknown;
+        universal?: unknown;
+    } | undefined;
+    eip6963Config?: {
+        rdns: string;
+    } | undefined;
+    filterFromWalletConnect?: boolean | undefined;
+    group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
+    injectedConfig?: {
+        chain: string;
+        extensionLocators: {
+            flag: string;
+            value?: boolean | undefined;
+        }[];
+        providerInterface?: string | undefined;
+        walletStandard?: {
+            features: string[];
+            name: string;
+        } | undefined;
+        walletStandardLocators?: {
+            name: string;
+            locator: string;
+        }[] | undefined;
+        windowLocations?: string[] | undefined;
+    }[] | undefined;
+    mobile?: {
+        android?: string | null | undefined;
+        androidId?: unknown;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: unknown;
+        native?: unknown;
+        universal?: unknown;
+    } | undefined;
+    mobileExperience?: "in-app-browser" | "redirect" | undefined;
+    shortName?: unknown;
+    showOnlyIfInstalled?: boolean | undefined;
+    switchNetworkOnlyFromWallet?: boolean | undefined;
+    walletConnect?: {
+        sdks?: unknown;
+    } | undefined;
+    walletGroup?: string | undefined;
+    walletLimitations?: {
+        browserExtension?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+        mobile?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+    } | undefined;
+}>, {
+    name: string;
+    brand?: {
+        alt?: string | undefined;
+        primaryColor?: string | undefined;
+        spriteId?: string | undefined;
+    } | undefined;
+    chainGroup?: string | undefined;
+    chains?: string[] | undefined;
+    desktop?: {
+        chromeId?: string | undefined;
+        edgeId?: string | undefined;
+        firefoxId?: string | undefined;
+        native?: string | undefined;
+        operaId?: string | undefined;
+        safariId?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    eip6963Config?: {
+        rdns: string;
+    } | undefined;
+    filterFromWalletConnect?: boolean | undefined;
+    group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
+    injectedConfig?: {
+        chain: string;
+        extensionLocators: {
+            value: boolean;
+            flag: string;
+        }[];
+        providerInterface?: string | undefined;
+        walletStandard?: {
+            features: string[];
+            name: string;
+        } | undefined;
+        walletStandardLocators?: {
+            name: string;
+            locator: string;
+        }[] | undefined;
+        windowLocations?: string[] | undefined;
+    }[] | undefined;
+    mobile?: {
+        android?: string | null | undefined;
+        androidId?: string | undefined;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: string | undefined;
+        native?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    mobileExperience?: "in-app-browser" | "redirect" | undefined;
+    shortName?: string | undefined;
+    showOnlyIfInstalled?: boolean | undefined;
+    switchNetworkOnlyFromWallet?: boolean | undefined;
+    walletConnect?: {
+        sdks?: string[] | undefined;
+    } | undefined;
+    walletGroup?: string | undefined;
+    walletLimitations?: {
+        browserExtension?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+        mobile?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+    } | undefined;
+}, unknown>, {
+    name: string;
+    brand?: {
+        alt?: string | undefined;
+        primaryColor?: string | undefined;
+        spriteId?: string | undefined;
+    } | undefined;
+    chainGroup?: string | undefined;
+    chains?: string[] | undefined;
+    desktop?: {
+        chromeId?: string | undefined;
+        edgeId?: string | undefined;
+        firefoxId?: string | undefined;
+        native?: string | undefined;
+        operaId?: string | undefined;
+        safariId?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    eip6963Config?: {
+        rdns: string;
+    } | undefined;
+    filterFromWalletConnect?: boolean | undefined;
+    group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
+    injectedConfig?: {
+        chain: string;
+        extensionLocators: {
+            value: boolean;
+            flag: string;
+        }[];
+        providerInterface?: string | undefined;
+        walletStandard?: {
+            features: string[];
+            name: string;
+        } | undefined;
+        walletStandardLocators?: {
+            name: string;
+            locator: string;
+        }[] | undefined;
+        windowLocations?: string[] | undefined;
+    }[] | undefined;
+    mobile?: {
+        android?: string | null | undefined;
+        androidId?: string | undefined;
+        inAppBrowser?: string | null | undefined;
+        ios?: string | null | undefined;
+        iosId?: string | undefined;
+        native?: string | undefined;
+        universal?: string | undefined;
+    } | undefined;
+    mobileExperience?: "in-app-browser" | "redirect" | undefined;
+    shortName?: string | undefined;
+    showOnlyIfInstalled?: boolean | undefined;
+    switchNetworkOnlyFromWallet?: boolean | undefined;
+    walletConnect?: {
+        sdks?: string[] | undefined;
+    } | undefined;
+    walletGroup?: string | undefined;
+    walletLimitations?: {
+        browserExtension?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+        mobile?: {
+            unsupportedEvents?: string[] | undefined;
+            unsupportedMethods?: string[] | undefined;
+        } | undefined;
+    } | undefined;
+}, unknown>;
+export type WalletSchema = z.infer<typeof walletSchema>;
+export type WalletInjectedConfigSchema = z.infer<typeof injectedConfigSchema>;
+export type WalletBrand = z.infer<typeof brandSchema>;
+export {};