Skip to content

[BTC-3028] Add a JSDoc comment #8126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lcovar wants to merge 1 commit into from
+11 −0
Closed

[BTC-3028] Add a JSDoc comment #8126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<T extends VerifyAddressOptions | TssVerifyAddressOptions>(
params: T
): params is T & TssVerifyAddressOptions {
Expand Down