Skip to content

add a JSDoc comment to the getNetwork function in modules/sdk-core/src/bitgo/bitcoin.ts #8122

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
+7 −0
Closed

add a JSDoc comment to the getNetwork function in modules/sdk-core/src/bitgo/bitcoin.ts #8122

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
7 changes: 7 additions & 0 deletions modules/sdk-core/src/bitgo/bitcoin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down
Loading