Package detail

@bitgo/sdk-coin-btc

BitGo12.7kMIT2.6.4

BitGo SDK coin library for Bitcoin

readme

BitGo sdk-coin-btc

SDK coins provide a modular approach to a monolithic architecture. This and all BitGoJS SDK coins allow developers to use only the coins needed for a given project.

Installation

All coins are loaded traditionally through the bitgo package. If you are using coins individually, you will be accessing the coin via the @bitgo/sdk-api package.

In your project install both @bitgo/sdk-api and @bitgo/sdk-coin-btc.

npm i @bitgo/sdk-api @bitgo/sdk-coin-btc

Next, you will be able to initialize an instance of "bitgo" through @bitgo/sdk-api instead of via bitgo.

import { BitGoAPI } from '@bitgo/sdk-api';
import { Btc } from '@bitgo/sdk-coin-btc';

const sdk = new BitGoAPI();

sdk.register('btc', Btc.createInstance);

Development

Most of the coin implementations are derived from @bitgo/sdk-core, @bitgo/statics, and coin specific packages. These implementations are used to interact with the BitGo API and BitGo platform services.

You will notice that the basic version of common class extensions have been provided to you and must be resolved before the package build will succeed. Upon initiation of a given SDK coin, you will need to verify that your coin has been included in the root tsconfig.packages.json and that the linting, formatting, and testing succeeds when run both within the coin and from the root of BitGoJS.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.6.4 (2025-06-25)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.6.3 (2025-06-24)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.6.2 (2025-06-18)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.6.1 (2025-06-10)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.6.0 (2025-06-05)

Features

2.5.0 (2025-06-02)

Features

  • rename audit function naming and signature (1a885ab)
  • root: add new audit key baseCoin method (57c1778)

2.4.32 (2025-05-28)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.31 (2025-05-22)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.30 (2025-05-20)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.29 (2025-05-07)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.28 (2025-04-29)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.27 (2025-04-25)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.26 (2025-04-15)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.25 (2025-04-04)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.24 (2025-04-02)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.23 (2025-03-28)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.22 (2025-03-20)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.21 (2025-03-18)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.20 (2025-03-06)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.19 (2025-03-04)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.18 (2025-02-26)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.17 (2025-02-20)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.16 (2025-02-19)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.15 (2025-02-11)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.14 (2025-02-05)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.13 (2025-01-28)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.12 (2025-01-23)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.11 (2025-01-23)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.10 (2025-01-20)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.9 (2025-01-15)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.8 (2025-01-09)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.7 (2025-01-03)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.6 (2024-12-24)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.5 (2024-12-19)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.4 (2024-12-17)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.3 (2024-12-17)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.2 (2024-12-12)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.1 (2024-12-11)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.4.0 (2024-12-03)

Features

  • abstract-utxo: make AbstractUtxoCoin less abstract (e456e04)

2.3.10 (2024-11-26)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.9 (2024-11-21)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.8 (2024-11-19)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.7 (2024-11-14)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.6 (2024-11-08)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.5 (2024-11-07)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.4 (2024-11-01)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.3 (2024-10-22)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.2 (2024-10-15)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.1 (2024-10-08)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.3.0 (2024-10-04)

Features

  • add btc testnet4 to sdk (8edfa40)
  • sdk-coin-btc: pass txformat for transfer ordinals (6827315)

2.2.9 (2024-09-24)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.2.8 (2024-09-19)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.2.7 (2024-09-16)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.2.6 (2024-09-10)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.2.5 (2024-09-03)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.2.4 (2024-08-29)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.2.3 (2024-08-27)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.2.2 (2024-08-20)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.2.1 (2024-08-13)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.2.0 (2024-08-07)

Features

  • add bitgo signet for btc (a1912b9)

2.1.3 (2024-07-30)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.1.2 (2024-07-24)

Bug Fixes

2.1.1 (2024-07-16)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.1.0 (2024-07-04)

Bug Fixes

  • make public signet tests work with bitgo module (fe32ae3)

Features

  • add btc public signet network and coin (c26cc8d)

2.0.24 (2024-07-02)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.23 (2024-06-27)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.22 (2024-06-26)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.21 (2024-06-21)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.20 (2024-06-20)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.19 (2024-06-14)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.18 (2024-06-11)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.17 (2024-06-05)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.16 (2024-05-31)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.15 (2024-05-28)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.14 (2024-05-22)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.13 (2024-05-17)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.12 (2024-05-13)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.11 (2024-05-08)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.10 (2024-05-01)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.9 (2024-04-25)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.8 (2024-04-24)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.7 (2024-04-22)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.6 (2024-04-17)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.5 (2024-04-12)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.4 (2024-04-10)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.3 (2024-04-09)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.2 (2024-04-08)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.1 (2024-04-05)

Note: Version bump only for package @bitgo/sdk-coin-btc

2.0.0 (2024-03-28)

Features

  • root: deprecate node 16 (d3ec624)

BREAKING CHANGES

  • root: Node 16 is no longer supported in bitgojs. TICKET: WP-1100

1.8.5 (2024-03-19)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.8.4 (2024-03-11)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.8.3 (2024-02-28)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.8.2 (2024-02-22)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.8.1 (2024-02-19)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.30 (2024-01-30)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.29 (2024-01-26)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.28 (2024-01-26)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.27 (2024-01-25)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.26 (2024-01-22)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.25 (2024-01-09)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.24 (2024-01-03)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.23 (2023-12-18)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.22 (2023-12-12)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.21 (2023-12-09)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.20 (2023-12-05)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.19 (2023-11-28)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.18 (2023-11-24)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.17 (2023-11-17)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.16 (2023-11-13)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.15 (2023-11-13)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.14 (2023-11-13)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.13 (2023-10-20)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.12 (2023-10-18)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.11 (2023-09-25)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.10 (2023-09-09)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.9 (2023-09-09)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.8 (2023-09-07)

Bug Fixes

  • abstract-utxo: upper case address should return false (f0b6c46)

1.7.7 (2023-09-05)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.7.6 (2023-09-01)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.7.5 (2023-08-29)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.7.4 (2023-08-25)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.7.3 (2023-08-24)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.7.2 (2023-08-16)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.7.1 (2023-08-16)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.7.0 (2023-08-04)

Features

  • root: add node 18 to engines and CI (9cc6a70)
  • root: remove node 14 from engines (6ec47cb)

1.6.0 (2023-07-28)

Features

  • root: add node 18 to engines and CI (9cc6a70)
  • root: remove node 14 from engines (6ec47cb)

1.5.8 (2023-07-18)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.5.7 (2023-06-21)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.5.6 (2023-06-14)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.5.5 (2023-06-13)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.5.4 (2023-06-07)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.5.3 (2023-06-05)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.5.2 (2023-05-25)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.5.1 (2023-05-17)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.5.0 (2023-05-10)

Features

  • sdk-coin-btc: find & use supplementary unspents in case (fc321ee)

1.4.3 (2023-05-03)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.4.2 (2023-04-25)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.4.1 (2023-04-20)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.4.0 (2023-04-13)

Bug Fixes

  • fix error when using feeOutput (4fb6214)
  • sdk-coin-btc: convert unspent value to BigInt (ed7d967)
  • sdk-coin-btc: get rootwalletkeys for inscription transfer (b160186)
  • use half signed commit txn when signing reveal (c0fb50b)
  • use p2wsh and internalChainCode for changeAddress creation (4a5b79c)
  • used derived keys and use xonly public key for script (382ce07)

Features

  • add inscription builder class (214eafe)
  • sdk-coin-btc: transfer an inscription (bc2eda8)

1.3.6 (2023-02-17)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.3.5 (2023-02-16)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.3.4 (2023-02-08)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.3.3 (2023-01-30)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.3.2 (2023-01-25)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.3.1 (2022-12-23)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.3.0 (2022-12-20)

Features

  • core: add register to base interface (2c08793)

1.2.8 (2022-12-09)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.2.7 (2022-12-06)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.2.6 (2022-12-01)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.2.5 (2022-11-29)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.2.4 (2022-11-04)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.2.2 (2022-10-27)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.2.1 (2022-10-25)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.2.0 (2022-10-18)

Features

  • sdk-core: create ILightning interface (6a2f347)

1.0.1 (2022-07-19)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.10 (2022-07-19)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.9 (2022-07-18)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.8 (2022-07-15)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.7 (2022-07-15)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.6 (2022-07-14)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.5 (2022-07-12)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.4 (2022-07-11)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.3 (2022-07-07)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.2 (2022-07-05)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.1 (2022-07-01)

Note: Version bump only for package @bitgo/sdk-coin-btc

1.0.1-rc.0 (2022-06-30)

Note: Version bump only for package @bitgo/sdk-coin-btc