@tinycloud/web-sdk 1.7.2 → 2.0.1

package/dist/providers/types.d.ts

@@ -0,0 +1,657 @@
+/**
+ * RPC Provider types, enums, type guards, and Zod schemas.
+ *
+ * @packageDocumentation
+ */
+import { z } from "zod";
+import { providers } from "ethers";
+import { ConnectionInfo } from "ethers/lib/utils";
+import type { AxiosRequestConfig } from "axios";
+import type { ClientSession } from "@tinycloud/sdk-core";
+/** Enum of supported EthersJS providers. */
+export declare enum RPCProviders {
+    AlchemyProvider = "alchemy",
+    AnkrProvider = "ankr",
+    CloudflareProvider = "cloudflare",
+    CustomProvider = "custom",
+    EtherscanProvider = "etherscan",
+    InfuraProvider = "infura",
+    PocketProvider = "pocket"
+}
+/** Enum of supported networks for Etherscan. */
+export declare enum EtherscanProviderNetworks {
+    MAINNET = "homestead",
+    ROPSTEN = "ropsten",
+    RINKEBY = "rinkeby",
+    GOERLI = "goerli",
+    KOVAN = "kovan"
+}
+/** Enum of supported networks for Infura. */
+export declare enum InfuraProviderNetworks {
+    MAINNET = "homestead",
+    ROPSTEN = "ropsten",
+    RINKEBY = "rinkeby",
+    GOERLI = "goerli",
+    KOVAN = "kovan",
+    POLYGON = "matic",
+    POLYGON_MUMBAI = "maticmum",
+    OPTIMISM = "optimism",
+    OPTIMISM_KOVAN = "optimism-kovan",
+    ARBITRUM = "arbitrum",
+    ARBITRUM_RINKEBY = "arbitrum-rinkeby"
+}
+/** Enum of supported networks for Alchemy. */
+export declare enum AlchemyProviderNetworks {
+    MAINNET = "homestead",
+    ROPSTEN = "ropsten",
+    RINKEBY = "rinkeby",
+    GOERLI = "goerli",
+    KOVAN = "kovan",
+    POLYGON = "matic",
+    POLYGON_MUMBAI = "maticmum",
+    OPTIMISM = "optimism",
+    OPTIMISM_KOVAN = "optimism-kovan",
+    ARBITRUM = "arbitrum",
+    ARBITRUM_RINKEBY = "arbitrum-rinkeby"
+}
+/** Enum of supported networks for Pocket. */
+export declare enum PocketProviderNetworks {
+    MAINNET = "homestead",
+    ROPSTEN = "ropsten",
+    RINKEBY = "rinkeby",
+    GOERLI = "goerli"
+}
+/** Enum of supported networks for Ankr. */
+export declare enum AnkrProviderNetworks {
+    MAINNET = "homestead",
+    POLYGON = "matic",
+    ARBITRUM = "arbitrum"
+}
+/** Infura provider project settings. */
+export type InfuraProviderProjectSettings = {
+    projectId: string;
+    projectSecret: string;
+};
+/** Etherscan provider settings. */
+export type EtherscanProvider = {
+    service: RPCProviders.EtherscanProvider;
+    apiKey?: string;
+    network?: EtherscanProviderNetworks;
+};
+/** Infura provider settings. */
+export type InfuraProvider = {
+    service: RPCProviders.InfuraProvider;
+    apiKey: string | InfuraProviderProjectSettings;
+    network?: InfuraProviderNetworks;
+};
+/** Alchemy provider settings. */
+export type AlchemyProvider = {
+    service: RPCProviders.AlchemyProvider;
+    apiKey?: string;
+    network?: AlchemyProviderNetworks;
+};
+/** Cloudflare provider settings. */
+export type CloudflareProvider = {
+    service: RPCProviders.CloudflareProvider;
+};
+/** Pocket provider settings. */
+export type PocketProvider = {
+    service: RPCProviders.PocketProvider;
+    apiKey?: string;
+    network?: PocketProviderNetworks;
+};
+/** Ankr provider settings. */
+export type AnkrProvider = {
+    service: RPCProviders.AnkrProvider;
+    apiKey?: string;
+    network?: AnkrProviderNetworks;
+};
+/** Custom provider settings. */
+export type CustomProvider = {
+    service: RPCProviders.CustomProvider;
+    url?: string | ConnectionInfo;
+    network?: providers.Networkish;
+};
+/** Generic provider settings. */
+export type GenericProvider = {
+    service: RPCProviders;
+    url?: string | ConnectionInfo;
+    network?: providers.Networkish;
+    apiKey?: string | InfuraProviderProjectSettings;
+};
+/** Supported provider types. */
+export type RPCProvider = GenericProvider | EtherscanProvider | InfuraProvider | AlchemyProvider | CloudflareProvider | PocketProvider | AnkrProvider | CustomProvider;
+export declare const isEtherscanProvider: (provider: RPCProvider) => provider is EtherscanProvider;
+export declare const isInfuraProvider: (provider: RPCProvider) => provider is InfuraProvider;
+export declare const isAlchemyProvider: (provider: RPCProvider) => provider is AlchemyProvider;
+export declare const isCloudflareProvider: (provider: RPCProvider) => provider is CloudflareProvider;
+/** Type-Guard for PocketProvider. */
+export declare const isPocketProvider: (provider: RPCProvider) => provider is PocketProvider;
+/** Type-Guard for AnkrProvider. */
+export declare const isAnkrProvider: (provider: RPCProvider) => provider is AnkrProvider;
+/** Type-Guard for CustomProvider. */
+export declare const isCustomProvider: (provider: RPCProvider) => provider is CustomProvider;
+/** TCW Route Configuration.
+ *  This configuration is used to override the default endpoint paths.
+ * The config options here are a subset of the
+ * [AxiosRequestConfig](https://axios-http.com/docs/req_config).
+ * This type does not explicitly extend AxiosRequestConfig,
+ * but those options are supported by the client.
+ */
+export interface RouteConfig {
+    /** Endpoint path. */
+    url?: string;
+    /** Endpoint request method. */
+    method?: "get" | "post" | "put" | "delete";
+    /** Custom Operation.
+     * Replace the tcw function called with a function of your own
+     **/
+    customAPIOperation?(params: ClientSession | Record<string, any> | any): Promise<any>;
+}
+export interface ServerMiddlewareConfig {
+    path: string;
+    callback?: (req: any, body?: Record<string, any>) => Promise<void> | void;
+}
+/** Type-Guard for ServerMiddlewareConfig. */
+export declare const isServerMiddlewareConfig: (config: ServerRouteEndpointType) => config is ServerMiddlewareConfig;
+export type ServerRouteEndpointType = Partial<RouteConfig> | AxiosRequestConfig | string | ServerMiddlewareConfig;
+/** Server endpoints configuration. */
+export interface ServerRoutes {
+    /** Get nonce endpoint path. /tcw-nonce as default. */
+    nonce?: ServerRouteEndpointType;
+    /** Post login endpoint path. /tcw-login as default. */
+    login?: ServerRouteEndpointType;
+    /** Post logout endpoint path. /tcw-logout as default. */
+    logout?: ServerRouteEndpointType;
+}
+/** Server endpoints name configuration. */
+export interface ServerRouteNames {
+    /** Get nonce endpoint path. /tcw-nonce as default. */
+    nonce?: string;
+    /** Post login endpoint path. /tcw-login as default. */
+    login?: string;
+    /** Post logout endpoint path. /tcw-logout as default. */
+    logout?: string;
+}
+/** ENS data supported by TCW. */
+export interface EnsData {
+    /** ENS name/domain. */
+    domain?: string | null;
+    /** ENS avatar. */
+    avatarUrl?: string | null;
+}
+/** ENS data schema. */
+export declare const EnsDataSchema: z.ZodObject<{
+    /** ENS name/domain. */
+    domain: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    /** ENS avatar. */
+    avatarUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    domain?: string;
+    avatarUrl?: string;
+}, {
+    domain?: string;
+    avatarUrl?: string;
+}>;
+/** Enum of supported EthersJS providers (Zod schema). */
+export declare const RPCProvidersSchema: z.ZodEnum<["alchemy", "ankr", "cloudflare", "custom", "etherscan", "infura", "pocket"]>;
+/**
+ * Enum values for RPCProviders (const object form).
+ * Both the enum and const object exist and serve different purposes:
+ * the enum for type-level discrimination, the const for runtime factory constructors.
+ */
+export declare const RPCProvidersConst: {
+    readonly AlchemyProvider: "alchemy";
+    readonly AnkrProvider: "ankr";
+    readonly CloudflareProvider: "cloudflare";
+    readonly CustomProvider: "custom";
+    readonly EtherscanProvider: "etherscan";
+    readonly InfuraProvider: "infura";
+    readonly PocketProvider: "pocket";
+};
+export declare const EtherscanProviderNetworksSchema: z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli", "kovan"]>;
+export declare const EtherscanProviderNetworksConst: {
+    readonly MAINNET: "homestead";
+    readonly ROPSTEN: "ropsten";
+    readonly RINKEBY: "rinkeby";
+    readonly GOERLI: "goerli";
+    readonly KOVAN: "kovan";
+};
+export declare const InfuraProviderNetworksSchema: z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli", "kovan", "matic", "maticmum", "optimism", "optimism-kovan", "arbitrum", "arbitrum-rinkeby"]>;
+export declare const InfuraProviderNetworksConst: {
+    readonly MAINNET: "homestead";
+    readonly ROPSTEN: "ropsten";
+    readonly RINKEBY: "rinkeby";
+    readonly GOERLI: "goerli";
+    readonly KOVAN: "kovan";
+    readonly POLYGON: "matic";
+    readonly POLYGON_MUMBAI: "maticmum";
+    readonly OPTIMISM: "optimism";
+    readonly OPTIMISM_KOVAN: "optimism-kovan";
+    readonly ARBITRUM: "arbitrum";
+    readonly ARBITRUM_RINKEBY: "arbitrum-rinkeby";
+};
+export declare const AlchemyProviderNetworksSchema: z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli", "kovan", "matic", "maticmum", "optimism", "optimism-kovan", "arbitrum", "arbitrum-rinkeby"]>;
+export declare const AlchemyProviderNetworksConst: {
+    readonly MAINNET: "homestead";
+    readonly ROPSTEN: "ropsten";
+    readonly RINKEBY: "rinkeby";
+    readonly GOERLI: "goerli";
+    readonly KOVAN: "kovan";
+    readonly POLYGON: "matic";
+    readonly POLYGON_MUMBAI: "maticmum";
+    readonly OPTIMISM: "optimism";
+    readonly OPTIMISM_KOVAN: "optimism-kovan";
+    readonly ARBITRUM: "arbitrum";
+    readonly ARBITRUM_RINKEBY: "arbitrum-rinkeby";
+};
+export declare const PocketProviderNetworksSchema: z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli"]>;
+export declare const PocketProviderNetworksConst: {
+    readonly MAINNET: "homestead";
+    readonly ROPSTEN: "ropsten";
+    readonly RINKEBY: "rinkeby";
+    readonly GOERLI: "goerli";
+};
+export declare const AnkrProviderNetworksSchema: z.ZodEnum<["homestead", "matic", "arbitrum"]>;
+export declare const AnkrProviderNetworksConst: {
+    readonly MAINNET: "homestead";
+    readonly POLYGON: "matic";
+    readonly ARBITRUM: "arbitrum";
+};
+export declare const InfuraProviderProjectSettingsSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    projectSecret: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    projectId?: string;
+    projectSecret?: string;
+}, {
+    projectId?: string;
+    projectSecret?: string;
+}>;
+export declare const EtherscanProviderSchema: z.ZodObject<{
+    service: z.ZodLiteral<"etherscan">;
+    apiKey: z.ZodOptional<z.ZodString>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli", "kovan"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "etherscan";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan";
+}, {
+    service?: "etherscan";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan";
+}>;
+export declare const InfuraProviderSchema: z.ZodObject<{
+    service: z.ZodLiteral<"infura">;
+    apiKey: z.ZodUnion<[z.ZodString, z.ZodObject<{
+        projectId: z.ZodString;
+        projectSecret: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        projectId?: string;
+        projectSecret?: string;
+    }, {
+        projectId?: string;
+        projectSecret?: string;
+    }>]>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli", "kovan", "matic", "maticmum", "optimism", "optimism-kovan", "arbitrum", "arbitrum-rinkeby"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "infura";
+    apiKey?: string | {
+        projectId?: string;
+        projectSecret?: string;
+    };
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan" | "matic" | "maticmum" | "optimism" | "optimism-kovan" | "arbitrum" | "arbitrum-rinkeby";
+}, {
+    service?: "infura";
+    apiKey?: string | {
+        projectId?: string;
+        projectSecret?: string;
+    };
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan" | "matic" | "maticmum" | "optimism" | "optimism-kovan" | "arbitrum" | "arbitrum-rinkeby";
+}>;
+export declare const AlchemyProviderSchema: z.ZodObject<{
+    service: z.ZodLiteral<"alchemy">;
+    apiKey: z.ZodOptional<z.ZodString>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli", "kovan", "matic", "maticmum", "optimism", "optimism-kovan", "arbitrum", "arbitrum-rinkeby"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "alchemy";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan" | "matic" | "maticmum" | "optimism" | "optimism-kovan" | "arbitrum" | "arbitrum-rinkeby";
+}, {
+    service?: "alchemy";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan" | "matic" | "maticmum" | "optimism" | "optimism-kovan" | "arbitrum" | "arbitrum-rinkeby";
+}>;
+export declare const CloudflareProviderSchema: z.ZodObject<{
+    service: z.ZodLiteral<"cloudflare">;
+}, "strip", z.ZodTypeAny, {
+    service?: "cloudflare";
+}, {
+    service?: "cloudflare";
+}>;
+export declare const PocketProviderSchema: z.ZodObject<{
+    service: z.ZodLiteral<"pocket">;
+    apiKey: z.ZodOptional<z.ZodString>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "pocket";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli";
+}, {
+    service?: "pocket";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli";
+}>;
+export declare const AnkrProviderSchema: z.ZodObject<{
+    service: z.ZodLiteral<"ankr">;
+    apiKey: z.ZodOptional<z.ZodString>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "matic", "arbitrum"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "ankr";
+    apiKey?: string;
+    network?: "homestead" | "matic" | "arbitrum";
+}, {
+    service?: "ankr";
+    apiKey?: string;
+    network?: "homestead" | "matic" | "arbitrum";
+}>;
+/** Custom provider schema. url and network are ethers types, validated as unknown. */
+export declare const CustomProviderSchema: z.ZodObject<{
+    service: z.ZodLiteral<"custom">;
+    url: z.ZodOptional<z.ZodUnknown>;
+    network: z.ZodOptional<z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    service?: "custom";
+    network?: unknown;
+    url?: unknown;
+}, {
+    service?: "custom";
+    network?: unknown;
+    url?: unknown;
+}>;
+/** Generic provider schema. url and network are ethers types, validated as unknown. */
+export declare const GenericProviderSchema: z.ZodObject<{
+    service: z.ZodEnum<["alchemy", "ankr", "cloudflare", "custom", "etherscan", "infura", "pocket"]>;
+    url: z.ZodOptional<z.ZodUnknown>;
+    network: z.ZodOptional<z.ZodUnknown>;
+    apiKey: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+        projectId: z.ZodString;
+        projectSecret: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        projectId?: string;
+        projectSecret?: string;
+    }, {
+        projectId?: string;
+        projectSecret?: string;
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "alchemy" | "ankr" | "cloudflare" | "custom" | "etherscan" | "infura" | "pocket";
+    apiKey?: string | {
+        projectId?: string;
+        projectSecret?: string;
+    };
+    network?: unknown;
+    url?: unknown;
+}, {
+    service?: "alchemy" | "ankr" | "cloudflare" | "custom" | "etherscan" | "infura" | "pocket";
+    apiKey?: string | {
+        projectId?: string;
+        projectSecret?: string;
+    };
+    network?: unknown;
+    url?: unknown;
+}>;
+/** Supported provider types (discriminated union schema). */
+export declare const RPCProviderSchema: z.ZodDiscriminatedUnion<"service", [z.ZodObject<{
+    service: z.ZodLiteral<"etherscan">;
+    apiKey: z.ZodOptional<z.ZodString>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli", "kovan"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "etherscan";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan";
+}, {
+    service?: "etherscan";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan";
+}>, z.ZodObject<{
+    service: z.ZodLiteral<"infura">;
+    apiKey: z.ZodUnion<[z.ZodString, z.ZodObject<{
+        projectId: z.ZodString;
+        projectSecret: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        projectId?: string;
+        projectSecret?: string;
+    }, {
+        projectId?: string;
+        projectSecret?: string;
+    }>]>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli", "kovan", "matic", "maticmum", "optimism", "optimism-kovan", "arbitrum", "arbitrum-rinkeby"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "infura";
+    apiKey?: string | {
+        projectId?: string;
+        projectSecret?: string;
+    };
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan" | "matic" | "maticmum" | "optimism" | "optimism-kovan" | "arbitrum" | "arbitrum-rinkeby";
+}, {
+    service?: "infura";
+    apiKey?: string | {
+        projectId?: string;
+        projectSecret?: string;
+    };
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan" | "matic" | "maticmum" | "optimism" | "optimism-kovan" | "arbitrum" | "arbitrum-rinkeby";
+}>, z.ZodObject<{
+    service: z.ZodLiteral<"alchemy">;
+    apiKey: z.ZodOptional<z.ZodString>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli", "kovan", "matic", "maticmum", "optimism", "optimism-kovan", "arbitrum", "arbitrum-rinkeby"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "alchemy";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan" | "matic" | "maticmum" | "optimism" | "optimism-kovan" | "arbitrum" | "arbitrum-rinkeby";
+}, {
+    service?: "alchemy";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli" | "kovan" | "matic" | "maticmum" | "optimism" | "optimism-kovan" | "arbitrum" | "arbitrum-rinkeby";
+}>, z.ZodObject<{
+    service: z.ZodLiteral<"cloudflare">;
+}, "strip", z.ZodTypeAny, {
+    service?: "cloudflare";
+}, {
+    service?: "cloudflare";
+}>, z.ZodObject<{
+    service: z.ZodLiteral<"pocket">;
+    apiKey: z.ZodOptional<z.ZodString>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "ropsten", "rinkeby", "goerli"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "pocket";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli";
+}, {
+    service?: "pocket";
+    apiKey?: string;
+    network?: "homestead" | "ropsten" | "rinkeby" | "goerli";
+}>, z.ZodObject<{
+    service: z.ZodLiteral<"ankr">;
+    apiKey: z.ZodOptional<z.ZodString>;
+    network: z.ZodOptional<z.ZodEnum<["homestead", "matic", "arbitrum"]>>;
+}, "strip", z.ZodTypeAny, {
+    service?: "ankr";
+    apiKey?: string;
+    network?: "homestead" | "matic" | "arbitrum";
+}, {
+    service?: "ankr";
+    apiKey?: string;
+    network?: "homestead" | "matic" | "arbitrum";
+}>, z.ZodObject<{
+    service: z.ZodLiteral<"custom">;
+    url: z.ZodOptional<z.ZodUnknown>;
+    network: z.ZodOptional<z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    service?: "custom";
+    network?: unknown;
+    url?: unknown;
+}, {
+    service?: "custom";
+    network?: unknown;
+    url?: unknown;
+}>]>;
+export declare const RouteConfigSchema: z.ZodObject<{
+    /** Endpoint path. */
+    url: z.ZodOptional<z.ZodString>;
+    /** Endpoint request method. */
+    method: z.ZodOptional<z.ZodEnum<["get", "post", "put", "delete"]>>;
+    /** Custom Operation - Replace the tcw function called with a function of your own. */
+    customAPIOperation: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    url?: string;
+    method?: "delete" | "get" | "post" | "put";
+    customAPIOperation?: (...args: unknown[]) => unknown;
+}, {
+    url?: string;
+    method?: "delete" | "get" | "post" | "put";
+    customAPIOperation?: (...args: unknown[]) => unknown;
+}>;
+export declare const ServerMiddlewareConfigSchema: z.ZodObject<{
+    path: z.ZodString;
+    callback: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    path?: string;
+    callback?: (...args: unknown[]) => unknown;
+}, {
+    path?: string;
+    callback?: (...args: unknown[]) => unknown;
+}>;
+export declare const ServerRouteEndpointTypeSchema: z.ZodUnion<[z.ZodObject<{
+    url: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    method: z.ZodOptional<z.ZodOptional<z.ZodEnum<["get", "post", "put", "delete"]>>>;
+    customAPIOperation: z.ZodOptional<z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>>;
+}, "strip", z.ZodTypeAny, {
+    url?: string;
+    method?: "delete" | "get" | "post" | "put";
+    customAPIOperation?: (...args: unknown[]) => unknown;
+}, {
+    url?: string;
+    method?: "delete" | "get" | "post" | "put";
+    customAPIOperation?: (...args: unknown[]) => unknown;
+}>, z.ZodUnknown, z.ZodString, z.ZodObject<{
+    path: z.ZodString;
+    callback: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    path?: string;
+    callback?: (...args: unknown[]) => unknown;
+}, {
+    path?: string;
+    callback?: (...args: unknown[]) => unknown;
+}>]>;
+export declare const ServerRoutesSchema: z.ZodObject<{
+    /** Get nonce endpoint path. /tcw-nonce as default. */
+    nonce: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        url: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        method: z.ZodOptional<z.ZodOptional<z.ZodEnum<["get", "post", "put", "delete"]>>>;
+        customAPIOperation: z.ZodOptional<z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>>;
+    }, "strip", z.ZodTypeAny, {
+        url?: string;
+        method?: "delete" | "get" | "post" | "put";
+        customAPIOperation?: (...args: unknown[]) => unknown;
+    }, {
+        url?: string;
+        method?: "delete" | "get" | "post" | "put";
+        customAPIOperation?: (...args: unknown[]) => unknown;
+    }>, z.ZodUnknown, z.ZodString, z.ZodObject<{
+        path: z.ZodString;
+        callback: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        path?: string;
+        callback?: (...args: unknown[]) => unknown;
+    }, {
+        path?: string;
+        callback?: (...args: unknown[]) => unknown;
+    }>]>>;
+    /** Post login endpoint path. /tcw-login as default. */
+    login: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        url: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        method: z.ZodOptional<z.ZodOptional<z.ZodEnum<["get", "post", "put", "delete"]>>>;
+        customAPIOperation: z.ZodOptional<z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>>;
+    }, "strip", z.ZodTypeAny, {
+        url?: string;
+        method?: "delete" | "get" | "post" | "put";
+        customAPIOperation?: (...args: unknown[]) => unknown;
+    }, {
+        url?: string;
+        method?: "delete" | "get" | "post" | "put";
+        customAPIOperation?: (...args: unknown[]) => unknown;
+    }>, z.ZodUnknown, z.ZodString, z.ZodObject<{
+        path: z.ZodString;
+        callback: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        path?: string;
+        callback?: (...args: unknown[]) => unknown;
+    }, {
+        path?: string;
+        callback?: (...args: unknown[]) => unknown;
+    }>]>>;
+    /** Post logout endpoint path. /tcw-logout as default. */
+    logout: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        url: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        method: z.ZodOptional<z.ZodOptional<z.ZodEnum<["get", "post", "put", "delete"]>>>;
+        customAPIOperation: z.ZodOptional<z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>>;
+    }, "strip", z.ZodTypeAny, {
+        url?: string;
+        method?: "delete" | "get" | "post" | "put";
+        customAPIOperation?: (...args: unknown[]) => unknown;
+    }, {
+        url?: string;
+        method?: "delete" | "get" | "post" | "put";
+        customAPIOperation?: (...args: unknown[]) => unknown;
+    }>, z.ZodUnknown, z.ZodString, z.ZodObject<{
+        path: z.ZodString;
+        callback: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        path?: string;
+        callback?: (...args: unknown[]) => unknown;
+    }, {
+        path?: string;
+        callback?: (...args: unknown[]) => unknown;
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    nonce?: unknown;
+    login?: unknown;
+    logout?: unknown;
+}, {
+    nonce?: unknown;
+    login?: unknown;
+    logout?: unknown;
+}>;
+export declare const ServerRouteNamesSchema: z.ZodObject<{
+    /** Get nonce endpoint path. /tcw-nonce as default. */
+    nonce: z.ZodOptional<z.ZodString>;
+    /** Post login endpoint path. /tcw-login as default. */
+    login: z.ZodOptional<z.ZodString>;
+    /** Post logout endpoint path. /tcw-logout as default. */
+    logout: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    nonce?: string;
+    login?: string;
+    logout?: string;
+}, {
+    nonce?: string;
+    login?: string;
+    logout?: string;
+}>;
+export interface ValidationError {
+    code: string;
+    message: string;
+    issues?: unknown[];
+}
+export type ValidationResult<T> = {
+    ok: true;
+    data: T;
+} | {
+    ok: false;
+    error: ValidationError;
+};
+export declare function validateEnsData(data: unknown): ValidationResult<EnsData>;
+export declare function validateRPCProvider(data: unknown): ValidationResult<z.infer<typeof RPCProviderSchema>>;
+export declare function validateServerRoutes(data: unknown): ValidationResult<z.infer<typeof ServerRoutesSchema>>;
+//# sourceMappingURL=types.d.ts.map

package/dist/providers/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/providers/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIzD,4CAA4C;AAC5C,oBAAY,YAAY;IACtB,eAAe,YAAY;IAC3B,YAAY,SAAS;IACrB,kBAAkB,eAAe;IACjC,cAAc,WAAW;IACzB,iBAAiB,cAAc;IAC/B,cAAc,WAAW;IACzB,cAAc,WAAW;CAC1B;AAID,gDAAgD;AAChD,oBAAY,yBAAyB;IACnC,OAAO,cAAc;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;CAChB;AAED,6CAA6C;AAC7C,oBAAY,sBAAsB;IAChC,OAAO,cAAc;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,UAAU;IACjB,cAAc,aAAa;IAC3B,QAAQ,aAAa;IACrB,cAAc,mBAAmB;IACjC,QAAQ,aAAa;IACrB,gBAAgB,qBAAqB;CACtC;AAED,8CAA8C;AAC9C,oBAAY,uBAAuB;IACjC,OAAO,cAAc;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,UAAU;IACjB,cAAc,aAAa;IAC3B,QAAQ,aAAa;IACrB,cAAc,mBAAmB;IACjC,QAAQ,aAAa;IACrB,gBAAgB,qBAAqB;CACtC;AAED,6CAA6C;AAC7C,oBAAY,sBAAsB;IAChC,OAAO,cAAc;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;CAClB;AAED,2CAA2C;AAC3C,oBAAY,oBAAoB;IAC9B,OAAO,cAAc;IACrB,OAAO,UAAU;IACjB,QAAQ,aAAa;CACtB;AAID,wCAAwC;AACxC,MAAM,MAAM,6BAA6B,GAAG;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,mCAAmC;AACnC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,YAAY,CAAC,iBAAiB,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC,CAAC;AAEF,gCAAgC;AAChC,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC;IACrC,MAAM,EAAE,MAAM,GAAG,6BAA6B,CAAC;IAC/C,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC,CAAC;AAEF,iCAAiC;AACjC,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,YAAY,CAAC,eAAe,CAAC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,uBAAuB,CAAC;CACnC,CAAC;AAEF,oCAAoC;AACpC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,YAAY,CAAC,kBAAkB,CAAC;CAC1C,CAAC;AAEF,gCAAgC;AAChC,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC,CAAC;AAEF,8BAA8B;AAC9B,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,YAAY,CAAC,YAAY,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC,CAAC;AAEF,gCAAgC;AAChC,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC;IACrC,GAAG,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;IAC9B,OAAO,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC;CAChC,CAAC;AAEF,iCAAiC;AACjC,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,YAAY,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;IAC9B,OAAO,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,6BAA6B,CAAC;CACjD,CAAC;AAEF,gCAAgC;AAChC,MAAM,MAAM,WAAW,GACnB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,cAAc,GACd,YAAY,GACZ,cAAc,CAAC;AAInB,eAAO,MAAM,mBAAmB,aACpB,WAAW,KACpB,QAAQ,IAAI,iBACsC,CAAC;AAGtD,eAAO,MAAM,gBAAgB,aACjB,WAAW,KACpB,QAAQ,IAAI,cACmC,CAAC;AAGnD,eAAO,MAAM,iBAAiB,aAClB,WAAW,KACpB,QAAQ,IAAI,eACoC,CAAC;AAGpD,eAAO,MAAM,oBAAoB,aACrB,WAAW,KACpB,QAAQ,IAAI,kBACuC,CAAC;AAEvD,qCAAqC;AACrC,eAAO,MAAM,gBAAgB,aACjB,WAAW,KACpB,QAAQ,IAAI,cACmC,CAAC;AAEnD,mCAAmC;AACnC,eAAO,MAAM,cAAc,aACf,WAAW,KACpB,QAAQ,IAAI,YACiC,CAAC;AAEjD,qCAAqC;AACrC,eAAO,MAAM,gBAAgB,aACjB,WAAW,KACpB,QAAQ,IAAI,cACmC,CAAC;AAGnD;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,qBAAqB;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;IAC3C;;QAEI;IACJ,kBAAkB,CAAC,CACjB,MAAM,EAAE,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAChD,OAAO,CAAC,GAAG,CAAC,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CAC3E;AAED,6CAA6C;AAC7C,eAAO,MAAM,wBAAwB,WAC3B,uBAAuB,KAC9B,MAAM,IAAI,sBAC2C,CAAC;AAEzD,MAAM,MAAM,uBAAuB,GAC/B,OAAO,CAAC,WAAW,CAAC,GACpB,kBAAkB,GAClB,MAAM,GACN,sBAAsB,CAAC;AAE3B,sCAAsC;AACtC,MAAM,WAAW,YAAY;IAC3B,sDAAsD;IACtD,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,uDAAuD;IACvD,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,yDAAyD;IACzD,MAAM,CAAC,EAAE,uBAAuB,CAAC;CAClC;AAED,2CAA2C;AAC3C,MAAM,WAAW,gBAAgB;IAC/B,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAGD,iCAAiC;AACjC,MAAM,WAAW,OAAO;IACtB,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,kBAAkB;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAGD,uBAAuB;AACvB,eAAO,MAAM,aAAa;IACxB,uBAAuB;;IAEvB,kBAAkB;;;;;;;;EAElB,CAAC;AAEH,yDAAyD;AACzD,eAAO,MAAM,kBAAkB,yFAQ7B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;CAQpB,CAAC;AAIX,eAAO,MAAM,+BAA+B,mEAM1C,CAAC;AAEH,eAAO,MAAM,8BAA8B;;;;;;CAMjC,CAAC;AAEX,eAAO,MAAM,4BAA4B,sJAYvC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;CAY9B,CAAC;AAEX,eAAO,MAAM,6BAA6B,sJAYxC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;CAY/B,CAAC;AAEX,eAAO,MAAM,4BAA4B,0DAKvC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;CAK9B,CAAC;AAEX,eAAO,MAAM,0BAA0B,+CAIrC,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;CAI5B,CAAC;AAIX,eAAO,MAAM,mCAAmC;;;;;;;;;EAG9C,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;EAIlC,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;EAI/B,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;EAIhC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;EAEnC,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAI/B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAC;AAEH,sFAAsF;AACtF,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAI/B,CAAC;AAEH,uFAAuF;AACvF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKhC,CAAC;AAEH,6DAA6D;AAC7D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAQ5B,CAAC;AAIH,eAAO,MAAM,iBAAiB;IAC5B,qBAAqB;;IAErB,+BAA+B;;IAE/B,sFAAsF;;;;;;;;;;EAEtF,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;;;EAGvC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;IAKxC,CAAC;AAEH,eAAO,MAAM,kBAAkB;IAC7B,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;IAEtD,uDAAuD;;;;;;;;;;;;;;;;;;;;;;;IAEvD,yDAAyD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEzD,CAAC;AAEH,eAAO,MAAM,sBAAsB;IACjC,sDAAsD;;IAEtD,uDAAuD;;IAEvD,yDAAyD;;;;;;;;;;EAEzD,CAAC;AAGH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;CACpB;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC1B;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GACrB;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,eAAe,CAAA;CAAE,CAAC;AAE1C,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAaxE;AAED,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,OAAO,GACZ,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAarD;AAED,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,OAAO,GACZ,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAatD"}