From a33ceafb7e08e76d53341ac0ffca785710a53c0f Mon Sep 17 00:00:00 2001 From: Luis Covarrubias Date: Thu, 12 Feb 2026 15:23:09 -0800 Subject: [PATCH] docs: add JSDoc comment to getNetwork function Add a JSDoc comment to the getNetwork function in modules/sdk-core/src/bitgo/bitcoin.ts describing its purpose, parameters, and return value. --- modules/sdk-core/src/bitgo/bitcoin.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/modules/sdk-core/src/bitgo/bitcoin.ts b/modules/sdk-core/src/bitgo/bitcoin.ts index da4687909b..da18103bde 100644 --- a/modules/sdk-core/src/bitgo/bitcoin.ts +++ b/modules/sdk-core/src/bitgo/bitcoin.ts @@ -7,6 +7,13 @@ import { BIP32Interface, ECPairInterface } from '@bitgo/utxo-lib'; import * as common from '../common'; import { V1Network } from './types'; +/** + * Returns the utxo-lib network object for the given V1 network name. + * If no network is provided, falls back to the globally configured network. + * + * @param {V1Network} [network] - The V1 network name ('bitcoin' or 'testnet'). Defaults to the current global network. + * @returns {utxolib.Network} The utxo-lib network parameters object. + */ export function getNetwork(network?: V1Network): utxolib.Network { network = network || common.getNetwork(); return utxolib.networks[network];