Skip to content
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.

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

Feat: bip32 package with blinded xpub support #126

Merged
merged 19 commits into from
Sep 9, 2024

Conversation

bucko13
Copy link
Contributor

@bucko13 bucko13 commented Sep 6, 2024

New package for working with bip32 objects. Starting with various utilities for getting blinded xpubs and paths.

Eventually I think it would make sense for a lot of the @caravan/bitcoin keys and paths code to be moved here too.

Diff looks pretty big, but important changes are in packages/bip32 and apps/coordinator

Implemented a proof of concept for support in Caravan Coordinator

Screenshot 2024-09-05 at 10 35 56 PM

Copy link

changeset-bot bot commented Sep 6, 2024

⚠️ No Changeset found

Latest commit: 6eff96c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Sep 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
caravan-coordinator ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 9, 2024 4:23pm

nk1tz
nk1tz previously approved these changes Sep 6, 2024
Copy link
Contributor

@nk1tz nk1tz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, nothing to say

Copy link
Contributor

@chadchapnick chadchapnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Educational read through for me—thank you! An excellent feature and have tested building a wallet, signing+broadcasting. Some minor nits and questions 1

Footnotes

  1. possibly irrelevant q's

import { Buffer } from "buffer";
import crypto from "crypto";
const DEFAULT_MAX = 2 ** 31 - 1;
export const secureRandomInt = (min = 0, max = DEFAULT_MAX): number => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can enrich types? min: number= 0 etc

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the type system infers this so intellisense should pick this up just fine (but it is important to be more specific if you want it narrowed down more).

@bucko13 bucko13 merged commit 83c3f28 into caravan-bitcoin:main Sep 9, 2024
3 checks passed
@bucko13 bucko13 deleted the bip32 branch September 9, 2024 19:04
bucko13 added a commit that referenced this pull request Mar 11, 2025
* fix: multisig support for indirect keystore interactions (#120)

* Version Packages (#121)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Caravan Health Package (beta) (#112)

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>
Co-authored-by: buck <buck@unchained.com>

* Version Packages (#123)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Tweaks to SegWit PSBT Inputs/Outputs (#124)

* fix: supply witness script when generating multisig

* fix: include non witness utxo in segwit inputs

* fix: add unsignedPSBT to state on finalizeOutputs

* fix: variable names and pass psbt to direct sig importer

* update fixture shape and psbts to include non witness utxos

* tweak fixture shape and add non witness utxos to psbts

* hackish injection of non witness utxos for tests

* include nonwitness utxo for segwit in caravan bitcoin; update base64 encoded psbts in fixtures for less testing hackery

* include multisig obj in caravan bitcoin fixtures

---------

Co-authored-by: buck <buck@unchained.com>

* Feat: bip32 package with blinded xpub support (#126)

* cleanup and fix generator templates

* init bip32 package with paths utils

* fix: eslint and add import ordering

* split up key and path modules and add tests

* custom util for getting random ints in node or browser

* use custom random int for blinded paths

* util for getting blinded xpub from source

* feat: blind xpub support for text input

* make new bip32 package publishable

* feat: reused functionality extracted to a utility for getting relative child sequence

* Fix hermit selection (#127)

* convert HermitReader and SignatureImporter to typescript

* adding height on hermit reader

* convert HermitReader to functional and use new QrReader api

* fix falsey bug

* styling cleanup

---------

Co-authored-by: Justin Moore <11jmoore@pm.me>

* caravan/bip32 publish access public (#129)

* tweak to package.json (#130)

* Version Packages (#128)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* unsignedPsbt in redux store should include global xpubs (#132)

* bump for coordinator (#138)

* Version Packages (#139)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Fee bumping Package (#114)

* feat: Initialize @caravan/feebumping package

Create a new package for fee bumping functionality in Caravan. This package
provides modular and reusable utilities for implementing RBF (Replace-By-Fee)
and CPFP (Child-Pays-For-Parent) fee bumping strategies.

Key additions:
- Basic package structure and configuration files
- Core modules for RBF and CPFP implementations
- Fee estimation utilities
- Type definitions for fee bumping operations
- Constants and utility functions

This package aims to enhance Caravan's transaction management capabilities
by providing a flexible and extensible fee bumping solution that can be
easily integrated into the Caravan coordinator wallet and other Bitcoin
projects.

* update package-lock (#143)

* Version Packages (#144)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* add support for the BitBox02 hardware wallet (#117)

* add support for the BitBox02 hardware wallet

Using the `bitbox-api` NPM package, which loads a WASM module.

Note about CJS:
Currently the `bitbox-api` package is an ESM package with a `module:
...` entrypoint, so it is not compatible with the `cjs` target of
caravan-wallets. The only workaround that I could find where
compilation succeeds and the package works in the browser is to mark
bitbox-api as external in tsup.config.ts.

Note about signing tests:

- The BitBox02 requires the previous transaction of each input to be
present in the PSBT (`PSBT_IN_NON_WITNESS_UTXO`), so it can verify the
input amount and avoid fee attacks. The signing test fixtures are
missing these, so they fail.

- The BitBox02 uses the anti-klepto (anti-exfil) protocol to mitigate
covert nonce exfil attacks. This results in random signatures. The
unit test fixtures hardcode the expected signatures, assuming they are
always the same. As a result, also here the tests fail. To fix this,
the tests should rather verify the ECDSA signatures against the
transaction sighash for each input.

* hide BitBox02 menu item for P2SH

BitBox02 does not support legacy P2SH.

* bitbox: display pairing code

The BitBox, if not paired yet, will show a pairing code for
confirmation. This can happen in any BitBox interaction.

This commit adds a `showPairingCode` param to all BitBox
interactions. If not provided, a default implementation is used which
shows the pairing code in a browser popup.

The current `messages()` system is not a good fit, as the client does
not know when to call `messagesFor()` to display it. Having a separate
UI button to pair the BitBox is not good UX (why should the user be
bothered to click a "pair" button first? What if the user doesn't) and
also fragile (a re-pairing could be needed at any time).

* add regtest support for BitBox02

---------

Co-authored-by: buck <buck@unchained.com>

* Version Packages (#145)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: fees package private (#146)

* Translate segwit psbt (#147)

* chore: fix turbo.json for test runner

* update deps

* feat: dds support for translatePSBT for segwit PSBTs

* pass key details to sig interaction just in case

* Version Packages (#148)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: move bitbox to normal dependency (#149)

* Version Packages (#150)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix(wallets): bundle internal dependencies with production bundle (#151)

* Version Packages (#152)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: @caravan/bitcoin shouldn't be noExternal (#153)

* Version Packages (#154)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: unknown network error for regtest (#156)

* support regtest network in coldcard and custom interactions

* add changeset

* Version Packages (#157)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* include addressType for valid PSBT translation in SignMultisigTransaction (#159)

* Version Packages (#160)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore(deps-dev): bump gh-pages from 3.2.3 to 5.0.0

Bumps [gh-pages](https://github.com/tschaub/gh-pages) from 3.2.3 to 5.0.0.
- [Release notes](https://github.com/tschaub/gh-pages/releases)
- [Changelog](https://github.com/tschaub/gh-pages/blob/main/changelog.md)
- [Commits](tschaub/gh-pages@v3.2.3...v5.0.0)

---
updated-dependencies:
- dependency-name: gh-pages
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>

* fix: turbo dev depends on build w/ esbuild noExternal (#164)

* Add sparrow to allowed method of importing pubkeys (#166)

Signed-off-by: Harshil Jani <harshiljani2002@gmail.com>

* bump @trezor/connect-web from 9.1.12 to 9.4.7 (#163)

Co-authored-by: dylan-thompson <141655089+dylan-thompson@users.noreply.github.com>

* Version Packages (#169)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore(deps): bump axios from 1.6.7 to 1.7.4 in /packages/caravan-wallets

Bumps [axios](https://github.com/axios/axios) from 1.6.7 to 1.7.4.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](axios/axios@v1.6.7...v1.7.4)

---
updated-dependencies:
- dependency-name: axios
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

* PsbtV2.toV0(): Convert a PsbtV2 class to its serialized PSBTv0 counterpart (#158)

* feat: PsbtV2.toV0()

* chore: changeset

* fix: remove log

* test: add more tests for PsbtV2.toV0

* chore: update package-lock to match package.json (#171)

* Version Packages (#173)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: replace npm install with npm ci in CI workflows (#175)

* fix(psbt): lock dependency of caravan-bitcoin (#174)

* Version Packages

* chore(deps): bump axios from 1.6.7 to 1.7.4

Bumps [axios](https://github.com/axios/axios) from 1.6.7 to 1.7.4.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/v1.x/CHANGELOG.md)
- [Commits](axios/axios@v1.6.7...v1.7.4)

---
updated-dependencies:
- dependency-name: axios
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

* chore(deps-dev): bump vite from 4.5.5 to 4.5.6

Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 4.5.5 to 4.5.6.
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/v4.5.6/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v4.5.6/packages/vite)

---
updated-dependencies:
- dependency-name: vite
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>

* chore(turbo): add build as lint task dependency (#178)

* chore(wallets): bump trezor connect dependency (#183)

* Version Packages (#184)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Fix/docker updates (#185)

* fix(docker): add multi-platform support for coordinator Dockerfile

* chore(changeset): changeset for multi-platform Dockerfile change

* docs(dockerfile): clarify platform-agnostic comment for coordinator app

* feat: Add getTransaction method to BlockchainClient (#134)

* feat: Add getTransaction method to BlockchainClient

This commit adds a getTransaction method to the BlockchainClient class,
which provides a consistent structure for fetching transaction details across different data providers (Bitcoin Core, Blockstream, Mempool).

Changes:
 - Add `TransactionDetails` interface for unified transaction data
 - Implement `getTransaction` method
 - Add `normalizeTransactionData` to standardize response

* REVIEW-CHANGES : changes in bitcoind.js and tests

* refactor: move transaction normalization to standalone utility

* refactor: update TransactionDetails to use camelCase naming

* refactor(bitcoind): convert bitcoind.js to TypeScript

* feat(bitcoind): update ListTransactionsItem interface to match RPC spec

* fix(client): handle different transaction response formats properly for the getTransaction method

* fix: update test mocks to match RPC response types

* changes to fix broken tests

* refactor(block-explorer): Convert to TypeScript with improved type safety

* refactor(blockchain): Migrate to TypeScript and enhance error handling

* revert: revert: undo recent changes to bitcoind.ts

* fixes: Type fixes in bitcoind

* fix: remove async promise executor in callBitcoind

* doc-strings: added doc strings to callBitcoind method

* refactor: add TypeScript type annotations to bitcoindParams function

* Added detailed docstrings to the `bitcoindListUnspent` method

* Added detailed docstrings to the `bitcoindGetAddressStatus` method

* Added detailed docstrings to the `bitcoindEstimateSmartFee` method

* refactor: improve typing and error handling in bitcoindSendRawTransaction

* refactor: improve typing and added doc-strings in bitcoindRawTxData

* revert: undo recent changes to block_explorer.ts

* fixes-types: Partial type fixes in block_explorer.ts to pass type errors

* fixes-type-block_explorer: Fixed blockExplorerGetAddresesUTXOs function

* fixes-type-block_explorer: Fixed blockExplorerGetAddressStatus function

* fixes-type-block_explorer: Fixed blockExplorerGetFeeEstimate function

* fixes-type-block_explorer: Fixed blockExplorerBroadcastTransaction function

* revert: undo recent changes to blockchain.ts

* fixes-types: Partial type fixes in blockchain.ts to pass type errors

* fixes-type-blockchain: Fixed fetchAddressUTXOsUnsorted function

* fixes-type-blockchain: Fixed fetchAddressUTXOs function

* fixes-type-blockchain: Fixed getAddressStatus function

* fixes-type-blockchain: Fixed fetchFeeEstimate function

* fixes-type-blockchain: Fixed broadcastTransaction function

* TO-DO: any error eslint disable to-do

* chore(changeset): Update changeset to include TypeScript migration

* refactor(bitcoind): standardize Bitcoin RPC parameters by introducing `BaseBitcoindArgs`, updating function signatures

* refactor(bitcoind): `bitcoindRawTxData` to use standardize Bitcoin RPC function parameters

* chore: rename block_explorer.ts to blockExplorer.ts for consistency

---------

Co-authored-by: buck <buck@unchained.com>

* Version Packages (#186)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Allow a PsbtV2 to be constructed with a psbtv2 which has been forceably set to have PSBT_GLOBAL_TX_VERSION === 1 (#188)

* feat: allowTxnVersion1 on instantiation

* chore: changeset

* Version Packages (#189)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* fix: workflow failure

* removing unused dependencies from caravan-bitcoin package

---------

Signed-off-by: Harshil-Jani <harshiljani2002@gmail.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Harshil Jani <harshiljani2002@gmail.com>
Co-authored-by: chadchapnick <143517546+chadchapnick@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Harshil Jani <harshiljani2002@gmail.com>
Co-authored-by: buck <buck@unchained.com>
Co-authored-by: Justin Moore <11jmoore@pm.me>
Co-authored-by: Mrigesh Thakur <96632943+Legend101Zz@users.noreply.github.com>
Co-authored-by: benma <m@mben.ch>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Robert Shuford <75178461+robertshuford@users.noreply.github.com>
Co-authored-by: kimlwh <kimlwh@proton.me>
Co-authored-by: dylan-thompson <141655089+dylan-thompson@users.noreply.github.com>
Co-authored-by: Jack D <shadouts@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants