Class: BitcoinNetworkConnection

Defined in: packages/bitcoin/src/bitcoin.ts:26

The BitcoinNetworkConnection class contains relevant data and methods for interacting with different Bitcoin network.

Name

BitcoinNetworkConnection

Constructors

Constructor

new BitcoinNetworkConnection(configs?): BitcoinNetworkConnection

Defined in: packages/bitcoin/src/bitcoin.ts:41

Creates an instance of the Bitcoin class.

Parameters

configs?

BitcoinNetworkConfigMap

Optional configuration object for the Bitcoin client. If not provided, it will be loaded from the BITCOIN_CLIENT_CONFIG environment variables.

Returns

BitcoinNetworkConnection

Throws

If no configs is passed and BITCOIN_NETWORK_CONFIG is missing or invalid.

Properties

bitcoin?

optional bitcoin: BitcoinNetworkConfig

Defined in: packages/bitcoin/src/bitcoin.ts:28

---

mutinynet?

optional mutinynet: BitcoinNetworkConfig

Defined in: packages/bitcoin/src/bitcoin.ts:32

---

network

network: BitcoinNetworkConfig

Defined in: packages/bitcoin/src/bitcoin.ts:27

---

regtest?

optional regtest: BitcoinNetworkConfig

Defined in: packages/bitcoin/src/bitcoin.ts:33

---

signet?

optional signet: BitcoinNetworkConfig

Defined in: packages/bitcoin/src/bitcoin.ts:31

---

testnet3?

optional testnet3: BitcoinNetworkConfig

Defined in: packages/bitcoin/src/bitcoin.ts:29

---

testnet4?

optional testnet4: BitcoinNetworkConfig

Defined in: packages/bitcoin/src/bitcoin.ts:30

Methods

getNetworkConnection()

getNetworkConnection(network): BitcoinNetworkConnection

Defined in: packages/bitcoin/src/bitcoin.ts:103

Get the Bitcoin network configuration for a specific network.

Parameters

network

string

The Bitcoin network (e.g., 'bitcoin', 'testnet3', 'signet', 'regtest').

Returns

BitcoinNetworkConnection

The Bitcoin object.

---

setActiveNetwork()

setActiveNetwork(active): void

Defined in: packages/bitcoin/src/bitcoin.ts:119

Sets the active Bitcoin network.

Parameters

active

string

The Bitcoin network to set as active (e.g., 'bitcoin', 'testnet3', 'signet', 'regtest').

Returns

void

Throws

If no configuration is found for the specified network.

---

btcToSats()

static btcToSats(btc): number

Defined in: packages/bitcoin/src/bitcoin.ts:135

Converts Bitcoin (BTC) to satoshis (SAT).

Parameters

btc

number

The amount in BTC.

Returns

number

The amount in SAT.

---

satsToBtc()

static satsToBtc(sats): number

Defined in: packages/bitcoin/src/bitcoin.ts:144

Converts satoshis (SAT) to Bitcoin (BTC).

Parameters

sats

number

The amount in SAT.

Returns

number

The amount in BTC.