chore: rename bnb to branchAndBound to be more explicit & remove conl…

…lision with BNB token
trezor · Oct 30, 2024 · 2223463 · 2223463
1 parent aeab689
commit 2223463
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/packages/utxo-lib/src/coinselect/index.ts b/packages/utxo-lib/src/coinselect/index.ts
@@ -1,5 +1,5 @@
 import { accumulative } from './inputs/accumulative';
-import { bnb } from './inputs/bnb';
+import { branchAndBound } from './inputs/branchAndBound';
 import { split } from './outputs/split';
 import { sortByScore, anyOf } from './coinselectUtils';
 import { tryConfirmed } from './tryconfirmed';
@@ -13,7 +13,7 @@ export function coinselect({ inputs, outputs, feeRate, ...options }: CoinSelectR
     const sortedInputs =
         options.sortingStrategy === 'none' ? inputs : inputs.sort(sortByScore(feeRate));
 
-    const algorithm = tryConfirmed(anyOf([bnb, accumulative]), options);
+    const algorithm = tryConfirmed(anyOf([branchAndBound, accumulative]), options);
 
     return algorithm(sortedInputs, outputs, feeRate, options);
 }
diff --git a/...ges/utxo-lib/src/coinselect/inputs/bnb.ts → ...b/src/coinselect/inputs/branchAndBound.ts b/...ges/utxo-lib/src/coinselect/inputs/bnb.ts → ...b/src/coinselect/inputs/branchAndBound.ts
@@ -127,7 +127,12 @@ function search(
  * https://github.com/bitcoin/bitcoin/blob/b2ec0326fd76e64a6d0d7e4745506b29f60d0be5/src/wallet/coinselection.cpp
  */
 
-export const bnb: CoinSelectAlgorithm = (utxos, outputs, feeRate, options): CoinSelectResult => {
+export const branchAndBound: CoinSelectAlgorithm = (
+    utxos,
+    outputs,
+    feeRate,
+    options,
+): CoinSelectResult => {
     if (options.baseFee) return { fee: 0 }; // TEMP: disable bnb algorithm for DOGE
     if (utxos.find(u => u.required)) return { fee: 0 }; // TODO: enable bnb algorithm if required utxos are defined
 

diff --git a/...ges/utxo-lib/tests/coinselect/bnb.test.ts → ...b/tests/coinselect/branchAndBound.test.ts b/...ges/utxo-lib/tests/coinselect/bnb.test.ts → ...b/tests/coinselect/branchAndBound.test.ts
@@ -1,4 +1,4 @@
-import { bnb } from '../../src/coinselect/inputs/bnb';
+import { branchAndBound } from '../../src/coinselect/inputs/branchAndBound';
 import fixtures from '../__fixtures__/coinselect/bnb';
 import * as utils from './test.utils';
 import { CoinSelectOptions } from '../../src/types';
@@ -14,11 +14,11 @@ describe('coinselect: branchAndBound (bnb)', () => {
                 dustThreshold: f.dustThreshold,
             } as CoinSelectOptions;
 
-            const actual = bnb(inputs, outputs, f.feeRate, options);
+            const actual = branchAndBound(inputs, outputs, f.feeRate, options);
             expect(utils.serialize(actual)).toEqual(expected);
 
             if (actual.inputs) {
-                const feedback = bnb(actual.inputs, actual.outputs, f.feeRate, options);
+                const feedback = branchAndBound(actual.inputs, actual.outputs, f.feeRate, options);
                 expect(utils.serialize(feedback)).toEqual(expected);
             }
         });