fixup! feat(input-selection): add large first input selection strategy

Author: AngelCastilloB

packages/input-selection/test/LargeFirstSelection/LargeFirstSelection.test.ts

@@ -12,7 +12,187 @@ import {
 import { TxTestUtil } from '@cardano-sdk/util-dev';
 
 describe('LargeFirstSelection', () => {
-  it('consumes just enough ADA UTXOs needed and leaves the remainder', async () => {
+  it('picks the largest ADA UTxOs first', async () => {
+    const selector = new LargeFirstSelector({
+      changeAddressResolver: new MockChangeAddressResolver()
+    });
+
+    const utxo = new Set([
+      TxTestUtil.createUnspentTxOutput({ coins: 3_000_000n }),
+      TxTestUtil.createUnspentTxOutput({ coins: 2_000_000n }),
+      TxTestUtil.createUnspentTxOutput({ coins: 5_000_000n }),
+      TxTestUtil.createUnspentTxOutput({ coins: 4_000_000n }),
+      TxTestUtil.createUnspentTxOutput({ coins: 1_000_000n })
+    ]);
+
+    const outputs = new Set([TxTestUtil.createOutput({ coins: 6_000_000n })]);
+
+    const constraints = mockConstraintsToConstraints({
+      ...MOCK_NO_CONSTRAINTS,
+      minimumCostCoefficient: 100n
+    });
+
+    const results = await selector.select({
+      constraints,
+      implicitValue: {},
+      outputs,
+      preSelectedUtxo: new Set(),
+      utxo
+    });
+
+    const { selection, remainingUTxO } = results;
+
+    expect(selection.inputs.size).toBe(2);
+    expect(remainingUTxO.size).toBe(3);
+
+    const inputValues = new Set([...selection.inputs.entries()].map(([[_, output]]) => output.value.coins));
+    expect(inputValues.has(5_000_000n)).toBe(true);
+    expect(inputValues.has(4_000_000n)).toBe(true);
+
+    const expectedFee = BigInt(selection.inputs.size) * 100n;
+    expect(selection.fee).toBe(expectedFee);
+
+    expect(getCoinValueForAddress(mockChangeAddress, selection.change)).toBe(2_999_800n);
+
+    assertInputSelectionProperties({
+      constraints: {
+        ...MOCK_NO_CONSTRAINTS,
+        minimumCostCoefficient: 100n
+      },
+      implicitValue: {},
+      outputs,
+      results,
+      utxo
+    });
+  });
+
+  it('picks the largest ADA UTxOs first as change', async () => {
+    const selector = new LargeFirstSelector({
+      changeAddressResolver: new MockChangeAddressResolver()
+    });
+
+    const utxo = new Set([
+      TxTestUtil.createUnspentTxOutput({ coins: 2_000_000n }),
+      TxTestUtil.createUnspentTxOutput({ coins: 5_000_000n }),
+      TxTestUtil.createUnspentTxOutput({ coins: 4_000_000n }),
+      TxTestUtil.createUnspentTxOutput({ coins: 1_000_000n }),
+      TxTestUtil.createUnspentTxOutput({ coins: 3_000_000n })
+    ]);
+
+    const outputs = new Set([TxTestUtil.createOutput({ coins: 9_000_000n })]);
+
+    const constraints = mockConstraintsToConstraints({
+      ...MOCK_NO_CONSTRAINTS,
+      minimumCostCoefficient: 1n
+    });
+
+    const results = await selector.select({
+      constraints,
+      implicitValue: {},
+      outputs,
+      preSelectedUtxo: new Set(),
+      utxo
+    });
+
+    const { selection, remainingUTxO } = results;
+
+    expect(selection.inputs.size).toBe(3);
+    expect(remainingUTxO.size).toBe(2);
+
+    const inputValues = new Set([...selection.inputs.entries()].map(([[_, output]]) => output.value.coins));
+    expect(inputValues.has(5_000_000n)).toBe(true);
+    expect(inputValues.has(4_000_000n)).toBe(true);
+
+    const expectedFee = BigInt(selection.inputs.size);
+    expect(selection.fee).toBe(expectedFee);
+
+    expect(getCoinValueForAddress(mockChangeAddress, selection.change)).toBe(2_999_997n);
+
+    assertInputSelectionProperties({
+      constraints: {
+        ...MOCK_NO_CONSTRAINTS,
+        minimumCostCoefficient: 100n
+      },
+      implicitValue: {},
+      outputs,
+      results,
+      utxo
+    });
+  });
+
+  it('picks the largest native asset UTxOs first', async () => {
+    const selector = new LargeFirstSelector({
+      changeAddressResolver: new MockChangeAddressResolver()
+    });
+
+    const assetX = asAssetId('X');
+
+    const utxo = new Set([
+      TxTestUtil.createUnspentTxOutput({
+        assets: asTokenMap([[assetX, 20n]]),
+        coins: 3_000_000n
+      }),
+      TxTestUtil.createUnspentTxOutput({
+        assets: asTokenMap([[assetX, 80n]]),
+        coins: 3_000_000n
+      }),
+      TxTestUtil.createUnspentTxOutput({
+        assets: asTokenMap([[assetX, 50n]]),
+        coins: 3_000_000n
+      }),
+      TxTestUtil.createUnspentTxOutput({
+        assets: asTokenMap([[assetX, 100n]]),
+        coins: 3_000_000n
+      }),
+      TxTestUtil.createUnspentTxOutput({ coins: 3_000_000n })
+    ]);
+
+    const outputs = new Set([
+      TxTestUtil.createOutput({
+        assets: asTokenMap([[assetX, 130n]]),
+        coins: 2_000_000n
+      })
+    ]);
+
+    const constraints = mockConstraintsToConstraints({
+      ...MOCK_NO_CONSTRAINTS,
+      minimumCostCoefficient: 100n
+    });
+
+    const results = await selector.select({
+      constraints,
+      implicitValue: {},
+      outputs,
+      preSelectedUtxo: new Set(),
+      utxo
+    });
+
+    const { selection, remainingUTxO } = results;
+
+    expect(selection.inputs.size).toBe(2);
+    const coinsPicked = new Set([...selection.inputs].map(([, o]) => o.value.assets?.get(assetX) ?? 0n));
+    expect(coinsPicked.has(100n)).toBe(true);
+    expect(coinsPicked.has(80n)).toBe(true);
+    expect(remainingUTxO.size).toBe(3);
+
+    const expectedFee = BigInt(selection.inputs.size) * 100n;
+    expect(selection.fee).toBe(expectedFee);
+
+    expect(selection.change.some((txOut) => txOut.value.assets?.get(assetX) === 50n)).toBe(true);
+
+    assertInputSelectionProperties({
+      constraints: {
+        ...MOCK_NO_CONSTRAINTS,
+        minimumCostCoefficient: 100n
+      },
+      implicitValue: {},
+      outputs,
+      results,
+      utxo
+    });
+  });
+
+  it('consumes just enough ADA UTxOs needed and leaves the remainder', async () => {
     const selector = new LargeFirstSelector({
       changeAddressResolver: new MockChangeAddressResolver()
     });
@@ -61,7 +241,7 @@ describe('LargeFirstSelection', () => {
     });
   });
 
-  it('picks the single largest UTXO for each required asset', async () => {
+  it('picks the single largest UTxO for each required asset', async () => {
     const selector = new LargeFirstSelector({
       changeAddressResolver: new MockChangeAddressResolver()
     });