@settlemint/sdk-viem 2.5.7-main18dea300 → 2.5.7-main3cd08190

package/dist/viem.d.cts

@@ -4,50 +4,6 @@ import { Chain, Client, HttpTransportConfig, Transport } from "viem";
 import * as chains from "viem/chains";
 import { z } from "zod";
 
-//#region src/custom-actions/create-wallet.action.d.ts
-/**
- * Information about the wallet to be created.
- */
-interface WalletInfo {
-  /** The name of the wallet. */
-  name: string;
-}
-/**
- * Parameters for creating a wallet.
- */
-interface CreateWalletParameters {
-  /** The unique name of the key vault where the wallet will be created. */
-  keyVaultId: string;
-  /** Information about the wallet to be created. */
-  walletInfo: WalletInfo;
-}
-/**
- * Response from creating a wallet.
- */
-interface CreateWalletResponse {
-  /** The unique identifier of the wallet. */
-  id: string;
-  /** The name of the wallet. */
-  name: string;
-  /** The blockchain address of the wallet. */
-  address: string;
-  /** The HD derivation path used to create the wallet. */
-  derivationPath: string;
-}
-/**
- * Creates a wallet action for the given client.
- * @param client - The viem client to use for the request.
- * @returns An object with a createWallet method.
- */
-declare function createWallet(client: Client): {
-  /**
-   * Creates a new wallet in the specified key vault.
-   * @param args - The parameters for creating a wallet.
-   * @returns A promise that resolves to an array of created wallet responses.
-   */
-  createWallet(args: CreateWalletParameters): Promise<CreateWalletResponse[]>;
-};
-//#endregion
 //#region src/custom-actions/types/wallet-verification.enum.d.ts
 /**
  * Types of wallet verification methods supported by the system.
@@ -86,6 +42,87 @@ declare enum OTPAlgorithm {
   SHA3_512 = "SHA3-512",
 }
 //#endregion
+//#region src/custom-actions/verify-wallet-verification-challenge.action.d.ts
+/**
+ * Represents either a wallet address string or an object containing wallet address and optional verification ID.
+ */
+type AddressOrObject = string | {
+  userWalletAddress: string;
+  verificationId?: string;
+};
+/**
+ * Parameters for verifying a wallet verification challenge.
+ */
+interface VerifyWalletVerificationChallengeParameters {
+  /** The wallet address or object containing wallet address and optional verification ID. */
+  addressOrObject: AddressOrObject;
+  /** The response to the verification challenge. */
+  challengeResponse: string;
+}
+/**
+ * Result of a wallet verification challenge.
+ */
+interface VerificationResult {
+  /** Whether the verification was successful. */
+  verified: boolean;
+}
+/**
+ * Response from verifying a wallet verification challenge.
+ */
+type VerifyWalletVerificationChallengeResponse = VerificationResult[];
+/**
+ * Creates a wallet verification challenge verification action for the given client.
+ * @param client - The viem client to use for the request.
+ * @returns An object with a verifyWalletVerificationChallenge method.
+ */
+declare function verifyWalletVerificationChallenge(client: Client): {
+  /**
+   * Verifies a wallet verification challenge.
+   * @param args - The parameters for verifying the challenge.
+   * @returns A promise that resolves to an array of verification results.
+   */
+  verifyWalletVerificationChallenge(args: VerifyWalletVerificationChallengeParameters): Promise<VerifyWalletVerificationChallengeResponse>;
+};
+//#endregion
+//#region src/custom-actions/create-wallet-verification-challenges.action.d.ts
+/**
+ * Parameters for creating wallet verification challenges.
+ */
+interface CreateWalletVerificationChallengesParameters {
+  /** The wallet address or object containing wallet address and optional verification ID. */
+  addressOrObject: AddressOrObject;
+}
+/**
+ * Represents a wallet verification challenge.
+ */
+interface WalletVerificationChallenge {
+  /** The unique identifier of the challenge. */
+  id: string;
+  /** The name of the challenge. */
+  name: string;
+  /** The type of verification required. */
+  verificationType: WalletVerificationType;
+  /** The challenge parameters specific to the verification type. */
+  challenge: Record<string, string>;
+}
+/**
+ * Response from creating wallet verification challenges.
+ */
+type CreateWalletVerificationChallengesResponse = WalletVerificationChallenge[];
+/**
+ * Creates a wallet verification challenges action for the given client.
+ * @param client - The viem client to use for the request.
+ * @returns An object with a createWalletVerificationChallenges method.
+ */
+declare function createWalletVerificationChallenges(client: Client): {
+  /**
+   * Creates verification challenges for a wallet.
+   * @param args - The parameters for creating the challenges.
+   * @returns A promise that resolves to an array of wallet verification challenges.
+   */
+  createWalletVerificationChallenges(args: CreateWalletVerificationChallengesParameters): Promise<CreateWalletVerificationChallengesResponse>;
+};
+//#endregion
 //#region src/custom-actions/create-wallet-verification.action.d.ts
 /**
  * Base interface for wallet verification information.
@@ -167,85 +204,48 @@ declare function createWalletVerification(client: Client): {
   createWalletVerification(args: CreateWalletVerificationParameters): Promise<CreateWalletVerificationResponse[]>;
 };
 //#endregion
-//#region src/custom-actions/verify-wallet-verification-challenge.action.d.ts
-/**
- * Represents either a wallet address string or an object containing wallet address and optional verification ID.
- */
-type AddressOrObject = string | {
-  userWalletAddress: string;
-  verificationId?: string;
-};
-/**
- * Parameters for verifying a wallet verification challenge.
- */
-interface VerifyWalletVerificationChallengeParameters {
-  /** The wallet address or object containing wallet address and optional verification ID. */
-  addressOrObject: AddressOrObject;
-  /** The response to the verification challenge. */
-  challengeResponse: string;
-}
+//#region src/custom-actions/create-wallet.action.d.ts
 /**
- * Result of a wallet verification challenge.
+ * Information about the wallet to be created.
  */
-interface VerificationResult {
-  /** Whether the verification was successful. */
-  verified: boolean;
+interface WalletInfo {
+  /** The name of the wallet. */
+  name: string;
 }
 /**
- * Response from verifying a wallet verification challenge.
- */
-type VerifyWalletVerificationChallengeResponse = VerificationResult[];
-/**
- * Creates a wallet verification challenge verification action for the given client.
- * @param client - The viem client to use for the request.
- * @returns An object with a verifyWalletVerificationChallenge method.
- */
-declare function verifyWalletVerificationChallenge(client: Client): {
-  /**
-   * Verifies a wallet verification challenge.
-   * @param args - The parameters for verifying the challenge.
-   * @returns A promise that resolves to an array of verification results.
-   */
-  verifyWalletVerificationChallenge(args: VerifyWalletVerificationChallengeParameters): Promise<VerifyWalletVerificationChallengeResponse>;
-};
-//#endregion
-//#region src/custom-actions/create-wallet-verification-challenges.action.d.ts
-/**
- * Parameters for creating wallet verification challenges.
+ * Parameters for creating a wallet.
  */
-interface CreateWalletVerificationChallengesParameters {
-  /** The wallet address or object containing wallet address and optional verification ID. */
-  addressOrObject: AddressOrObject;
+interface CreateWalletParameters {
+  /** The unique name of the key vault where the wallet will be created. */
+  keyVaultId: string;
+  /** Information about the wallet to be created. */
+  walletInfo: WalletInfo;
 }
 /**
- * Represents a wallet verification challenge.
+ * Response from creating a wallet.
  */
-interface WalletVerificationChallenge {
-  /** The unique identifier of the challenge. */
+interface CreateWalletResponse {
+  /** The unique identifier of the wallet. */
   id: string;
-  /** The name of the challenge. */
+  /** The name of the wallet. */
   name: string;
-  /** The type of verification required. */
-  verificationType: WalletVerificationType;
-  /** The challenge parameters specific to the verification type. */
-  challenge: Record<string, string>;
+  /** The blockchain address of the wallet. */
+  address: string;
+  /** The HD derivation path used to create the wallet. */
+  derivationPath: string;
 }
 /**
- * Response from creating wallet verification challenges.
- */
-type CreateWalletVerificationChallengesResponse = WalletVerificationChallenge[];
-/**
- * Creates a wallet verification challenges action for the given client.
+ * Creates a wallet action for the given client.
  * @param client - The viem client to use for the request.
- * @returns An object with a createWalletVerificationChallenges method.
+ * @returns An object with a createWallet method.
  */
-declare function createWalletVerificationChallenges(client: Client): {
+declare function createWallet(client: Client): {
   /**
-   * Creates verification challenges for a wallet.
-   * @param args - The parameters for creating the challenges.
-   * @returns A promise that resolves to an array of wallet verification challenges.
+   * Creates a new wallet in the specified key vault.
+   * @param args - The parameters for creating a wallet.
+   * @returns A promise that resolves to an array of created wallet responses.
    */
-  createWalletVerificationChallenges(args: CreateWalletVerificationChallengesParameters): Promise<CreateWalletVerificationChallengesResponse>;
+  createWallet(args: CreateWalletParameters): Promise<CreateWalletResponse[]>;
 };
 //#endregion
 //#region src/custom-actions/delete-wallet-verification.action.d.ts
@@ -334,9 +334,23 @@ type ClientOptions = Omit<z.infer<typeof ClientOptionsSchema>, "httpTransportCon
   httpTransportConfig?: HttpTransportConfig;
 };
 /**
- * Get a public client. Use this if you need to read from the blockchain.
- * @param options - The options for the public client.
- * @returns The public client. see {@link https://viem.sh/docs/clients/public}
+ * Creates an optimized public client for blockchain read operations.
+ *
+ * @remarks
+ * PERFORMANCE: Implements intelligent caching to minimize client creation overhead.
+ * Cache hit rates of 80%+ typical in production workloads with repeated chain access.
+ *
+ * SECURITY: Each access token gets isolated cache entries to prevent cross-tenant data exposure.
+ * Client instances are immutable once cached to prevent credential pollution.
+ *
+ * RESOURCE MANAGEMENT: 500ms polling interval balances responsiveness with server load.
+ * 60-second timeout prevents hanging connections in unstable network conditions.
+ *
+ * @param options - Client configuration including chain details and authentication
+ * @returns Cached or newly created public client with read-only blockchain access
+ * @throws ValidationError when options don't match required schema
+ * @throws NetworkError when RPC endpoint is unreachable during client creation
+ *
  * @example
  * ```ts
  * import { getPublicClient } from '@settlemint/sdk-viem';
@@ -7631,15 +7645,40 @@ interface WalletVerificationOptions {
    * The verification id (used for HD wallets), if not provided, the challenge response will be validated against all active verifications.
    */
   verificationId?: string;
+  /**
+   * The challenge id (used for HD wallets)
+   */
+  challengeId?: string;
   /**
    * The challenge response (used for HD wallets)
    */
   challengeResponse: string;
 }
 /**
- * Get a wallet client. Use this if you need to write to the blockchain.
- * @param options - The options for the wallet client.
- * @returns A function that returns a wallet client. The function can be called with verification options for HD wallets. see {@link https://viem.sh/docs/clients/wallet}
+ * Creates a factory function for wallet clients with runtime verification support.
+ *
+ * @remarks
+ * DESIGN PATTERN: Returns a factory function rather than a client instance because
+ * wallet operations require runtime verification parameters (challenge responses, etc.)
+ * that cannot be known at factory creation time.
+ *
+ * SECURITY: Verification headers are injected per-operation to support:
+ * - HD wallet challenge/response flows
+ * - Multi-signature verification workflows
+ * - Time-sensitive authentication tokens
+ *
+ * PERFORMANCE: Factory caching amortizes expensive setup (chain resolution, transport config)
+ * while allowing runtime parameter injection for each wallet operation.
+ *
+ * FEATURE EXTENSIONS: Automatically extends client with SettleMint-specific wallet actions:
+ * - Wallet creation and management
+ * - Verification challenge handling
+ * - Multi-factor authentication flows
+ *
+ * @param options - Base client configuration (chain, RPC, auth)
+ * @returns Factory function that accepts runtime verification options
+ * @throws ValidationError when options don't match required schema
+ *
  * @example
  * ```ts
  * import { getWalletClient } from '@settlemint/sdk-viem';
@@ -7683,9 +7722,23 @@ type GetChainIdOptions = Omit<z.infer<typeof GetChainIdOptionsSchema>, "httpTran
   httpTransportConfig?: HttpTransportConfig;
 };
 /**
- * Get the chain id of a blockchain network.
- * @param options - The options for the public client.
- * @returns The chain id.
+ * Discovers the chain ID from an RPC endpoint without requiring prior knowledge.
+ *
+ * @remarks
+ * UTILITY: Enables chain discovery for dynamic network configuration scenarios.
+ * Unlike other client functions, this creates a minimal, non-cached client for one-time queries.
+ *
+ * USE CASE: Chain ID discovery during initial network setup or validation.
+ * Alternative to requiring users to know chain IDs in advance.
+ *
+ * PERFORMANCE: No caching because chain IDs are typically discovered once
+ * during setup rather than repeatedly during runtime operations.
+ *
+ * @param options - Minimal options with RPC URL and optional authentication
+ * @returns Promise resolving to the network's chain ID as a number
+ * @throws NetworkError when RPC endpoint is unreachable
+ * @throws AuthenticationError when access token is invalid
+ *
  * @example
  * ```ts
  * import { getChainId } from '@settlemint/sdk-viem';