chore: tsdoc - createBicoPaymasterClient

src/sdk/clients/createBicoPaymasterClient.ts

@@ -5,6 +5,14 @@ import {
   createPaymasterClient
 } from "viem/account-abstraction"
 
+/**
+ * Configuration options for creating a Bico Paymaster Client.
+ * @typedef {Object} BicoPaymasterClientConfig
+ * @property {Transport} [transport] - Optional custom transport.
+ * @property {string} [paymasterUrl] - URL of the paymaster service.
+ * @property {number} [chainId] - Chain ID for the network.
+ * @property {string} [apiKey] - API key for authentication.
+ */
 type BicoPaymasterClientConfig = Omit<PaymasterClientConfig, "transport"> &
   OneOf<
     | {
@@ -19,6 +27,27 @@ type BicoPaymasterClientConfig = Omit<PaymasterClientConfig, "transport"> &
       }
   >
 
+/**
+ * Creates a Bico Paymaster Client.
+ *
+ * This function sets up a client for interacting with Biconomy's paymaster service.
+ * It can be configured with a custom transport, a specific paymaster URL, or with a chain ID and API key.
+ *
+ * @param {BicoPaymasterClientConfig} parameters - Configuration options for the client.
+ * @returns {PaymasterClient} A configured Paymaster Client instance.
+ *
+ * @example
+ * // Create a client with a custom transport
+ * const client1 = createBicoPaymasterClient({ transport: customTransport })
+ *
+ * @example
+ * // Create a client with a specific paymaster URL
+ * const client2 = createBicoPaymasterClient({ paymasterUrl: 'https://example.com/paymaster' })
+ *
+ * @example
+ * // Create a client with chain ID and API key
+ * const client3 = createBicoPaymasterClient({ chainId: 1, apiKey: 'your-api-key' })
+ */
 export const createBicoPaymasterClient = (
   parameters: BicoPaymasterClientConfig
 ): PaymasterClient =>