From e81c95ea31a1dc594f35102e812c9a95d23816ba Mon Sep 17 00:00:00 2001 From: Luis Covarrubias Date: Thu, 12 Feb 2026 23:08:08 -0800 Subject: [PATCH] docs: add JSDoc comment to isTssVerifyAddressOptions type guard Restore the JSDoc comment for the isTssVerifyAddressOptions function that documents its purpose as a type guard for TSS address verification options, including parameter and return value descriptions. BTC-3028 --- modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts b/modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts index 936d4edd3d..06ba6a9a29 100644 --- a/modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts +++ b/modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts @@ -189,6 +189,17 @@ export interface TssVerifyAddressOptions { derivedFromParentWithSeed?: string; } +/** + * Type guard that checks whether the given address verification options + * are TSS (Threshold Signature Scheme) verify address options. + * + * This determines if the params contain the required fields for TSS address + * verification: keychains, index, address, and at least one keychain with + * a commonKeychain property. + * + * @param params - The address verification options to check. + * @returns True if the params satisfy the {@link TssVerifyAddressOptions} interface. + */ export function isTssVerifyAddressOptions( params: T ): params is T & TssVerifyAddressOptions {