chore: unify and cleanup script types

[kaladinlight]

Summary by CodeRabbit

• New Features

  • Unified Bitcoin script types: introduced BTCScriptType (Legacy, LegacyMultisig, Segwit, SegwitNative).

• Updates

  • Replaced BTCInputScriptType/BTCOutputScriptType with BTCScriptType across public APIs, tests, and examples.
  • Many method signatures and path-description outputs updated to use BTCScriptType.

• Improvements

  • Centralized UTXO path description/delegation and simplified network/script-type handling and naming across wallets and integrations.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@kaladinlight has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 3 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a1a7c01 and 9f63742.

📒 Files selected for processing (40)

• examples/sandbox/index.ts (33 hunks)
• integration/src/bitcoin/bitcoin.ts (8 hunks)
• integration/src/bitcoin/litecoin.ts (2 hunks)
• integration/src/bitcoin/testnet.ts (4 hunks)
• integration/src/wallets/keepkey.ts (12 hunks)
• integration/src/wallets/ledger.ts (5 hunks)
• integration/src/wallets/native.ts (9 hunks)
• integration/src/wallets/phantom.ts (4 hunks)
• integration/src/wallets/trezor.ts (5 hunks)
• integration/src/wallets/vultisig.ts (3 hunks)
• packages/hdwallet-core/src/bitcoin.ts (14 hunks)
• packages/hdwallet-core/src/networks.ts (2 hunks)
• packages/hdwallet-core/src/utxoUtils.ts (1 hunks)
• packages/hdwallet-core/src/wallet.ts (3 hunks)
• packages/hdwallet-gridplus/src/bitcoin.ts (3 hunks)
• packages/hdwallet-gridplus/src/constants.ts (0 hunks)
• packages/hdwallet-gridplus/src/gridplus.ts (2 hunks)
• packages/hdwallet-keepkey/src/bitcoin.ts (5 hunks)
• packages/hdwallet-keepkey/src/keepkey.ts (3 hunks)
• packages/hdwallet-keepkey/src/utils.ts (1 hunks)
• packages/hdwallet-ledger/src/bitcoin.ts (8 hunks)
• packages/hdwallet-ledger/src/ethereum.ts (1 hunks)
• packages/hdwallet-ledger/src/ledger.ts (2 hunks)
• packages/hdwallet-ledger/src/utils.ts (1 hunks)
• packages/hdwallet-metamask-multichain/src/shapeshift-multichain.ts (1 hunks)
• packages/hdwallet-metamask-multichain/src/utxo.ts (2 hunks)
• packages/hdwallet-native/src/bitcoin.test.ts (1 hunks)
• packages/hdwallet-native/src/bitcoin.ts (4 hunks)
• packages/hdwallet-native/src/native.test.ts (3 hunks)
• packages/hdwallet-native/src/native.ts (1 hunks)
• packages/hdwallet-native/src/util.ts (1 hunks)
• packages/hdwallet-phantom/src/bitcoin.ts (4 hunks)
• packages/hdwallet-phantom/src/phantom.ts (3 hunks)
• packages/hdwallet-portis/src/bitcoin.ts (3 hunks)
• packages/hdwallet-portis/src/portis.ts (2 hunks)
• packages/hdwallet-trezor/src/bitcoin.ts (4 hunks)
• packages/hdwallet-trezor/src/trezor.ts (4 hunks)
• packages/hdwallet-vultisig/src/bitcoin.ts (4 hunks)
• packages/hdwallet-vultisig/src/vultisig.test.ts (4 hunks)
• packages/hdwallet-vultisig/src/vultisig.ts (1 hunks)

📝 Walkthrough

Walkthrough

Consolidates Bitcoin script-type enums by replacing BTCInputScriptType/BTCOutputScriptType with a unified BTCScriptType across core, networks, utilities, wallet implementations, tests, and examples; updates signatures, mappings, describe/unknown UTXO path delegation, and network/bip32 handling accordingly.

Changes

Cohort / File(s)	Summary
Core: bitcoin packages/hdwallet-core/src/bitcoin.ts	Removed BTCInputScriptType/BTCOutputScriptType; added BTCScriptType (Legacy, LegacyMultisig, Segwit, SegwitNative). Updated all BTC public types, account constructors, createPayment, describe/unknown UTXO path signatures and logic.
Core: networks & utils packages/hdwallet-core/src/networks.ts, packages/hdwallet-core/src/utxoUtils.ts, packages/hdwallet-core/src/wallet.ts	Reworked BIP32 shape (public/private), switched BIP32 maps to BTCScriptType keys, updated getNetwork (default Legacy) and scriptType→account type mappings; updated wallet-related interfaces to use BTCScriptType.
Examples & Integration tests examples/sandbox/index.ts, integration/src/bitcoin/*, integration/src/wallets/*	Replaced all test/example usages and expectations to use core.BTCScriptType variants and updated verbose path strings accordingly.
Wallets: core adapters packages/hdwallet-*/src/* (KeepKey, Ledger, Trezor, Native, Phantom, GridPlus, Portis, Vultisig, GridPlus constants removal)	Replaced script-type enums/signatures with BTCScriptType, updated btcSupportsScriptType, btcGetAddress, btcSignTx, btcSignMessage, describeUTXOPath delegations, account path builders and internal mappings. Removed or delegated various in-file path parsing utilities to core. packages/hdwallet-gridplus/src/constants.ts removed.
Packages: native/gridplus/others tests packages/hdwallet-native/src/*, packages/hdwallet-gridplus/src/*, packages/hdwallet-*/src/*/*.test.ts	Adjusted tests and internal helpers to the new enum and changed some defaults (e.g., network resolution no longer defaults to PayToMultisig). Tests updated to expect BTCScriptType members.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant WalletImpl as Wallet Implementation
  participant Core as `@shapeshiftoss/hdwallet-core`
  participant Network as getNetwork / bip32

  Note over WalletImpl,Core: Old flow (prior to this diff)
  WalletImpl->>WalletImpl: describeUTXOPath (manual parsing)
  WalletImpl--xCore: sometimes used core.unknownUTXOPath
  WalletImpl->>Network: getNetwork(coin, BTCOutputScriptType.*)
  WalletImpl-->>WalletImpl: build verbose description

  Note over WalletImpl,Core: New flow (after this diff)
  WalletImpl->>Core: describeUTXOPath(path, coin, BTCScriptType)
  Core-->>WalletImpl: PathDescription (centralized)
  WalletImpl->>Network: getNetwork(coin, BTCScriptType?) 
  Network-->>WalletImpl: bip32 mapped by BTCScriptType

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~55 minutes

Areas requiring extra attention:

• packages/hdwallet-core/src/networks.ts — BIP32 shape and getNetwork lookup changes; verify mappings for all coins and error messages.
• packages/hdwallet-core/src/bitcoin.ts — many public type changes and Exclude/union updates; confirm type safety and account constructors.
• wallet adapters delegating describeUTXOPath (ledger/trezor/keepkey/portis/native) — ensure behavior parity after centralizing to core.describeUTXOPath.
• packages/hdwallet-gridplus/src/constants.ts removal — confirm no remaining references and PSBT/network assumptions.

Possibly related PRs

• feat: gridplus cleanup #741 — core enum/type refactor and BTCScriptType introduction; directly related to the enum consolidation applied here.
• feat: hdwallet-gridplus #731 — GridPlus adapter changes overlapping bitcoin utilities and signature updates referenced by this diff.
• feat: hdwallet-trezor #736 — Trezor/translateScriptType and related script-type translation changes overlap with this PR’s updates.

Suggested reviewers

• gomesalexandre
• NeOMakinG

Poem

🐇
I hopped through enums, tidy and spry,
One BTCScriptType beneath the sky,
Legacy, Segwit, Native—four in a row,
Tests and wallets now learn how to flow,
A rabbit's small cheer for a neater code show.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 8.33% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'chore: unify and cleanup script types' directly reflects the main change: replacing BTCInputScriptType and BTCOutputScriptType enums with a unified BTCScriptType enum throughout the codebase.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}