@uswap/toolboxes 4.3.6 → 4.3.9

package/src/utxo/helpers/bchaddrjs.ts

@@ -1,4 +1,10 @@
-import { SwapKitError } from "@uswap/helpers";
+/**
+ * Based on code from SwapKit (https://github.com/swapkit/SwapKit),
+ * licensed under the Apache License 2.0.
+ * Modifications © 2025 Horizontal Systems.
+ */
+
+import { USwapError } from "@uswap/helpers";
 import base58check from "bs58check";
 // @ts-expect-error
 import cashaddr from "cashaddrjs";
@@ -73,7 +79,7 @@ function decodeAddress(address: string) {
   } catch {
     // Try to decode as bitpay if cashaddr decoding fails.
   }
-  throw new SwapKitError("toolbox_utxo_invalid_address", { address });
+  throw new USwapError("toolbox_utxo_invalid_address", { address });
 }
 
 function decodeBase58Address(address: string) {
@@ -81,7 +87,7 @@ function decodeBase58Address(address: string) {
     const payload = base58check.decode(address);
 
     // BASE_58_CHECK_PAYLOAD_LENGTH
-    if (payload.length !== 21) throw new SwapKitError("toolbox_utxo_invalid_address", { address });
+    if (payload.length !== 21) throw new USwapError("toolbox_utxo_invalid_address", { address });
     const versionByte = payload[0];
     const hash = Array.prototype.slice.call(payload, 1);
 

package/src/utxo/helpers/coinselect.ts

@@ -1,4 +1,10 @@
-import { Chain, SwapKitError, type UTXOChain } from "@uswap/helpers";
+/**
+ * Based on code from SwapKit (https://github.com/swapkit/SwapKit),
+ * licensed under the Apache License 2.0.
+ * Modifications © 2025 Horizontal Systems.
+ */
+
+import { Chain, USwapError, type UTXOChain } from "@uswap/helpers";
 
 import {
   calculateTxSize,
@@ -23,7 +29,7 @@ export function getDustThreshold(chain: UTXOChain) {
     case Chain.Zcash:
       return 546;
     default:
-      throw new SwapKitError("toolbox_utxo_not_supported", { chain });
+      throw new USwapError("toolbox_utxo_not_supported", { chain });
   }
 }
 

package/src/utxo/helpers/txSize.ts

@@ -1,4 +1,10 @@
-import { SwapKitError } from "@uswap/helpers";
+/**
+ * Based on code from SwapKit (https://github.com/swapkit/SwapKit),
+ * licensed under the Apache License 2.0.
+ * Modifications © 2025 Horizontal Systems.
+ */
+
+import { USwapError } from "@uswap/helpers";
 import { opcodes, script } from "bitcoinjs-lib";
 import type { TargetOutput, UTXOCalculateTxSizeParams, UTXOInputWithScriptType, UTXOType } from "../types";
 
@@ -99,7 +105,7 @@ export const getScriptTypeForAddress = (address: string) => {
     return UTXOScriptType.P2PKH;
   }
 
-  throw new SwapKitError("toolbox_utxo_invalid_address", { address });
+  throw new USwapError("toolbox_utxo_invalid_address", { address });
 };
 
 export const calculateTxSize = ({ inputs, outputs, feeRate }: UTXOCalculateTxSizeParams) => {

package/src/utxo/toolbox/bitcoinCash.ts

@@ -1,3 +1,9 @@
+/**
+ * Based on code from SwapKit (https://github.com/swapkit/SwapKit),
+ * licensed under the Apache License 2.0.
+ * Modifications © 2025 Horizontal Systems.
+ */
+
 import {
   address as bchAddress,
   Transaction,
@@ -11,7 +17,7 @@ import {
   derivationPathToString,
   FeeOption,
   NetworkDerivationPath,
-  SwapKitError,
+  USwapError,
   updateDerivationPath,
 } from "@uswap/helpers";
 import { Psbt } from "bitcoinjs-lib";
@@ -96,7 +102,7 @@ export async function createBCHToolbox<T extends typeof Chain.BitcoinCash>(
 }
 
 async function createTransaction({ assetValue, recipient, memo, feeRate, sender }: UTXOBuildTxParams) {
-  if (!bchValidateAddress(recipient)) throw new SwapKitError("toolbox_utxo_invalid_address", { address: recipient });
+  if (!bchValidateAddress(recipient)) throw new USwapError("toolbox_utxo_invalid_address", { address: recipient });
 
   // Overestimate by 7500 byte * feeRate to ensure we have enough UTXOs for fees and change
   const targetValue = Math.ceil(assetValue.getBaseValue("number") + feeRate * 7500);
@@ -115,7 +121,7 @@ async function createTransaction({ assetValue, recipient, memo, feeRate, sender
   const { inputs, outputs } = accumulative({ chain, feeRate, inputs: utxos, outputs: targetOutputs });
 
   // .inputs and .outputs will be undefined if no solution was found
-  if (!(inputs && outputs)) throw new SwapKitError("toolbox_utxo_insufficient_balance", { assetValue, sender });
+  if (!(inputs && outputs)) throw new USwapError("toolbox_utxo_insufficient_balance", { assetValue, sender });
   const getNetwork = await getUtxoNetwork();
   const builder = new TransactionBuilder(getNetwork(chain)) as TransactionBuilderType;
 
@@ -159,9 +165,9 @@ function transfer({
     ...rest
   }: UTXOTransferParams) {
     const from = await signer?.getAddress();
-    if (!(signer && from)) throw new SwapKitError("toolbox_utxo_no_signer");
+    if (!(signer && from)) throw new USwapError("toolbox_utxo_no_signer");
     if (!recipient)
-      throw new SwapKitError("toolbox_utxo_invalid_params", { error: "Recipient address must be provided" });
+      throw new USwapError("toolbox_utxo_invalid_params", { error: "Recipient address must be provided" });
 
     const feeRate = rest.feeRate || (await getFeeRates())[feeOptionKey];
 
@@ -185,7 +191,7 @@ async function buildTx({
 }: UTXOBuildTxParams & { setSigHashType?: boolean }) {
   const recipientCashAddress = toCashAddress(recipient);
   if (!bchValidateAddress(recipientCashAddress))
-    throw new SwapKitError("toolbox_utxo_invalid_address", { address: recipientCashAddress });
+    throw new USwapError("toolbox_utxo_invalid_address", { address: recipientCashAddress });
 
   // Overestimate by 7500 byte * feeRate to ensure we have enough UTXOs for fees and change
   const targetValue = Math.ceil(assetValue.getBaseValue("number") + feeRate * 7500);
@@ -212,7 +218,7 @@ async function buildTx({
   const { inputs, outputs } = accumulative({ chain, feeRate: feeRateWhole, inputs: utxos, outputs: targetOutputs });
 
   // .inputs and .outputs will be undefined if no solution was found
-  if (!(inputs && outputs)) throw new SwapKitError("toolbox_utxo_insufficient_balance", { assetValue, sender });
+  if (!(inputs && outputs)) throw new USwapError("toolbox_utxo_insufficient_balance", { assetValue, sender });
   const getNetwork = await getUtxoNetwork();
   const psbt = new Psbt({ network: getNetwork(chain) }); // Network-specific
 

package/src/utxo/toolbox/index.ts

@@ -1,4 +1,10 @@
-import { Chain, type DerivationPathArray, SwapKitError, type UTXOChain } from "@uswap/helpers";
+/**
+ * Based on code from SwapKit (https://github.com/swapkit/SwapKit),
+ * licensed under the Apache License 2.0.
+ * Modifications © 2025 Horizontal Systems.
+ */
+
+import { Chain, type DerivationPathArray, USwapError, type UTXOChain } from "@uswap/helpers";
 import { createBCHToolbox } from "./bitcoinCash";
 import type { UtxoToolboxParams } from "./params";
 import { createUTXOToolbox } from "./utxo";
@@ -50,7 +56,7 @@ export async function getUtxoToolbox<T extends keyof UTXOToolboxes>(
     }
 
     default:
-      throw new SwapKitError("toolbox_utxo_not_supported", { chain });
+      throw new USwapError("toolbox_utxo_not_supported", { chain });
   }
 }
 

package/src/utxo/toolbox/utxo.ts

@@ -1,3 +1,9 @@
+/**
+ * Based on code from SwapKit (https://github.com/swapkit/SwapKit),
+ * licensed under the Apache License 2.0.
+ * Modifications © 2025 Horizontal Systems.
+ */
+
 import secp256k1 from "@bitcoinerlab/secp256k1";
 // @ts-expect-error
 import { ECPair, HDNode } from "@psf/bitcoincashjs-lib";
@@ -13,8 +19,8 @@ import {
   derivationPathToString,
   FeeOption,
   NetworkDerivationPath,
-  SwapKitError,
   SwapKitNumber,
+  USwapError,
   type UTXOChain,
   updateDerivationPath,
 } from "@uswap/helpers";
@@ -98,7 +104,7 @@ async function createTransaction({
   const { inputs, outputs } = accumulative({ ...inputsAndOutputs, chain, feeRate });
 
   // .inputs and .outputs will be undefined if no solution was found
-  if (!(inputs && outputs)) throw new SwapKitError("toolbox_utxo_insufficient_balance", { assetValue, sender });
+  if (!(inputs && outputs)) throw new USwapError("toolbox_utxo_insufficient_balance", { assetValue, sender });
   const getNetwork = await getUtxoNetwork();
   const psbt = new Psbt({ network: getNetwork(chain) });
 
@@ -324,7 +330,7 @@ export async function getCreateKeysForPath<T extends keyof CreateKeysForPathRetu
         if (wif) {
           return ECPair.fromWIF(wif, network) as BchECPair;
         }
-        if (!phrase) throw new SwapKitError("toolbox_utxo_invalid_params", { error: "No phrase provided" });
+        if (!phrase) throw new USwapError("toolbox_utxo_invalid_params", { error: "No phrase provided" });
 
         const masterHDNode = HDNode.fromSeedBuffer(Buffer.from(mnemonicToSeedSync(phrase)), network);
         const keyPair = masterHDNode.derivePath(derivationPath).keyPair;
@@ -347,7 +353,7 @@ export async function getCreateKeysForPath<T extends keyof CreateKeysForPathRetu
         derivationPath: string;
       }) {
         if (!(wif || phrase))
-          throw new SwapKitError("toolbox_utxo_invalid_params", { error: "Either phrase or wif must be provided" });
+          throw new USwapError("toolbox_utxo_invalid_params", { error: "Either phrase or wif must be provided" });
 
         const factory = ECPairFactory(secp256k1);
         const network = getNetwork(chain);
@@ -357,13 +363,13 @@ export async function getCreateKeysForPath<T extends keyof CreateKeysForPathRetu
         const seed = mnemonicToSeedSync(phrase as string);
         const master = HDKey.fromMasterSeed(seed, network).derive(derivationPath);
         if (!master.privateKey)
-          throw new SwapKitError("toolbox_utxo_invalid_params", { error: "Could not get private key from phrase" });
+          throw new USwapError("toolbox_utxo_invalid_params", { error: "Could not get private key from phrase" });
 
         return factory.fromPrivateKey(Buffer.from(master.privateKey), { network });
       } as (params: { wif?: string; phrase?: string; derivationPath?: string }) => CreateKeysForPathReturnType[T];
     }
     default:
-      throw new SwapKitError("toolbox_utxo_not_supported", { chain });
+      throw new USwapError("toolbox_utxo_not_supported", { chain });
   }
 }
 
@@ -371,11 +377,11 @@ export function addressFromKeysGetter(chain: UTXOChain) {
   const getNetwork = getUtxoNetwork();
 
   return function getAddressFromKeys(keys: ECPairInterface | BchECPair) {
-    if (!keys) throw new SwapKitError("toolbox_utxo_invalid_params", { error: "Keys must be provided" });
+    if (!keys) throw new USwapError("toolbox_utxo_invalid_params", { error: "Keys must be provided" });
 
     const method = nonSegwitChains.includes(chain) ? payments.p2pkh : payments.p2wpkh;
     const { address } = method({ network: getNetwork(chain), pubkey: keys.publicKey as Buffer });
-    if (!address) throw new SwapKitError("toolbox_utxo_invalid_address", { error: "Address not defined" });
+    if (!address) throw new USwapError("toolbox_utxo_invalid_address", { error: "Address not defined" });
 
     return address;
   };
@@ -387,9 +393,9 @@ function transfer(signer?: ChainSigner<Psbt, Psbt>) {
 
     const chain = assetValue.chain as UTXOChain;
 
-    if (!(signer && from)) throw new SwapKitError("toolbox_utxo_no_signer");
+    if (!(signer && from)) throw new USwapError("toolbox_utxo_no_signer");
     if (!recipient)
-      throw new SwapKitError("toolbox_utxo_invalid_params", { error: "Recipient address must be provided" });
+      throw new USwapError("toolbox_utxo_invalid_params", { error: "Recipient address must be provided" });
     const txFeeRate = feeRate || (await getFeeRates(chain))[feeOptionKey || FeeOption.Fast];
 
     const { psbt } = await createTransaction({ assetValue, feeRate: txFeeRate, memo, recipient, sender: from });

package/src/utxo/toolbox/zcash.ts

@@ -1,5 +1,11 @@
+/**
+ * Based on code from SwapKit (https://github.com/swapkit/SwapKit),
+ * licensed under the Apache License 2.0.
+ * Modifications © 2025 Horizontal Systems.
+ */
+
 import { bitgo, crypto, ECPair, networks, address as zcashAddress } from "@bitgo/utxo-lib";
-import type { ZcashPsbt } from "@bitgo/utxo-lib/dist/src/bitgo";
+import { type ZcashPsbt, ZcashTransaction } from "@bitgo/utxo-lib/dist/src/bitgo";
 import { HDKey } from "@scure/bip32";
 import { mnemonicToSeedSync } from "@scure/bip39";
 import {
@@ -10,7 +16,7 @@ import {
   FeeOption,
   NetworkDerivationPath,
   SKConfig,
-  SwapKitError,
+  USwapError,
   updateDerivationPath,
 } from "@uswap/helpers";
 import bs58check from "bs58check";
@@ -49,7 +55,7 @@ function createZcashSignerFromPhrase({
   const node = root.derive(derivationPath);
 
   if (!node.privateKey) {
-    throw new SwapKitError("toolbox_utxo_invalid_params");
+    throw new USwapError("toolbox_utxo_invalid_params");
   }
 
   // Create key pair using BitGo's ECPair with ECPair-compatible network
@@ -140,23 +146,13 @@ async function createTransaction(buildTxParams: UTXOBuildTxParams) {
   });
 
   if (!(inputs && outputs)) {
-    throw new SwapKitError("toolbox_utxo_insufficient_balance", { assetValue, sender });
+    throw new USwapError("toolbox_utxo_insufficient_balance", { assetValue, sender });
   }
 
-  const psbt = bitgo.createPsbtForNetwork({ network: getZcashNetwork() }, { version: 455 }) as ZcashPsbt;
-
-  //   const NU6 = 0xc8e71055;
-  const NU5 = 0xc2d6d0b4;
-  //   const branchId = tipHeight >= 2726400 ? NU6 : tipHeight >= 1687104 ? NU5 : NU5;
-  const branchId = NU5;
-
-  const CONSENSUS_BRANCH_ID_KEY = Buffer.concat([Buffer.of(0xfc), Buffer.of(0x05), Buffer.from("BITGO"), Buffer.of(0)]);
-
-  // PSBT value must be 4-byte little-endian
-  const value = Buffer.allocUnsafe(4);
-  value.writeUInt32LE(branchId >>> 0, 0);
-
-  psbt.addUnknownKeyValToGlobal({ key: CONSENSUS_BRANCH_ID_KEY, value });
+  const psbt = bitgo.createPsbtForNetwork(
+    { network: getZcashNetwork() },
+    { version: ZcashTransaction.VERSION4_BRANCH_NU6_1 },
+  ) as ZcashPsbt;
 
   const { psbt: mappedPsbt, inputs: mappedInputs } = await addInputsAndOutputs({
     compiledMemo,
@@ -166,6 +162,8 @@ async function createTransaction(buildTxParams: UTXOBuildTxParams) {
     sender,
   });
 
+  mappedPsbt.setDefaultsForVersion(getZcashNetwork(), ZcashTransaction.VERSION4_BRANCH_NU6_1);
+
   return { inputs: mappedInputs, outputs, psbt: mappedPsbt };
 }
 
@@ -188,7 +186,7 @@ export async function createZcashToolbox(
   async function transfer({ recipient, assetValue, feeOptionKey = FeeOption.Fast, ...rest }: UTXOTransferParams) {
     const from = await signer?.getAddress();
     if (!(signer && from)) {
-      throw new SwapKitError("toolbox_utxo_no_signer");
+      throw new USwapError("toolbox_utxo_no_signer");
     }
 
     const feeRate = rest.feeRate || (await baseToolbox.getFeeRates())[feeOptionKey];
@@ -197,9 +195,14 @@ export async function createZcashToolbox(
 
     const signedPsbt = await signer.signTransaction(psbt);
 
+    signedPsbt.validateSignaturesOfAllInputs();
+
     signedPsbt.finalizeAllInputs();
 
-    return baseToolbox.broadcastTx(signedPsbt.extractTransaction().toHex());
+    const finalTx = signedPsbt.extractTransaction();
+    const txHex = finalTx.toHex();
+
+    return baseToolbox.broadcastTx(txHex);
   }
 
   function createKeysForPath({
@@ -214,7 +217,7 @@ export async function createZcashToolbox(
     const node = root.derive(derivationPath);
 
     if (!node.privateKey) {
-      throw new SwapKitError("toolbox_utxo_invalid_params");
+      throw new USwapError("toolbox_utxo_invalid_params");
     }
 
     const ecpairNetwork = getECPairNetwork();