fix(cip2): add fee to selection skeleton

Author: mkazlauskas

Diff for: packages/cip2/src/RoundRobinRandomImprove/index.ts

@@ -1,7 +1,7 @@
 import { CardanoSerializationLib } from '@cardano-sdk/core';
 import { InputSelectionError, InputSelectionFailure } from '../InputSelectionError';
 import { InputSelectionParameters, InputSelector, SelectionResult } from '../types';
-import { transactionOutputsToArray } from '../util';
+import { maxBigNum, transactionOutputsToArray } from '../util';
 import { computeChangeAndAdjustForFee } from './change';
 import { roundRobinSelection } from './roundRobin';
 import { assertIsBalanceSufficient, preprocessArgs } from './util';
@@ -21,6 +21,7 @@ export const roundRobinRandomImprove = (csl: CardanoSerializationLib): InputSele
           fee: await computeMinimumCost({
             change: [],
             utxo,
+            fee: maxBigNum(csl),
             outputs
           }),
           change: [],
@@ -45,11 +46,12 @@ export const roundRobinRandomImprove = (csl: CardanoSerializationLib): InputSele
         computeMinimumCost({
           utxo: utxos,
           change: changeValues,
+          fee: maxBigNum(csl),
           outputs
         })
     });
 
-    if (inputs.length > (await computeSelectionLimit({ utxo: inputs, change, outputs }))) {
+    if (inputs.length > (await computeSelectionLimit({ utxo: inputs, change, fee: maxBigNum(csl), outputs }))) {
       throw new InputSelectionError(InputSelectionFailure.MaximumInputCountExceeded);
     }
 

Diff for: packages/cip2/src/selectionConstraints.ts

@@ -1,6 +1,7 @@
 import { CardanoSerializationLib, CSL, ProtocolParametersRequiredByWallet } from '@cardano-sdk/core';
 import { ComputeSelectionLimit, SelectionConstraints, TokenBundleSizeExceedsLimit } from '.';
 import { ComputeMinimumCoinQuantity, EstimateTxFee, SelectionSkeleton } from './types';
+import { MAX_U64 } from './util';
 
 export type BuildTx = (selection: SelectionSkeleton) => Promise<CSL.Transaction>;
 export interface DefaultSelectionConstraintsProps {
@@ -36,7 +37,7 @@ export const computeMinimumCoinQuantity =
     { coinsPerUtxoWord }: ProtocolParametersRequiredByWallet
   ): ComputeMinimumCoinQuantity =>
   (multiasset) => {
-    const minUTxOValue = CSL.BigNum.from_str((coinsPerUtxoWord * 29).toString());
+    const minUTxOValue = csl.BigNum.from_str((coinsPerUtxoWord * 29).toString());
     const value = csl.Value.new(csl.BigNum.from_str('0'));
     if (multiasset) {
       value.set_multiasset(multiasset);
@@ -50,8 +51,7 @@ export const tokenBundleSizeExceedsLimit =
     if (!tokenBundle) {
       return false;
     }
-    // Review: assuming coin serializes to the same size regardless of quantity
-    const value = csl.Value.new(csl.BigNum.from_str('0'));
+    const value = csl.Value.new(csl.BigNum.from_str(MAX_U64.toString()));
     value.set_multiasset(tokenBundle);
     return value.to_bytes().length > maxValueSize;
   };

Diff for: packages/cip2/src/types.ts

@@ -39,6 +39,7 @@ export interface SelectionSkeleton {
   utxo: CSL.TransactionUnspentOutput[];
   outputs: CSL.TransactionOutputs;
   change: CSL.Value[];
+  fee: CSL.BigNum;
 }
 
 /**

Diff for: packages/cip2/src/util.ts

@@ -6,6 +6,9 @@ import { CardanoSerializationLib, CSL, Asset, Ogmios } from '@cardano-sdk/core';
 export type AssetQuantities = Ogmios.util.AssetQuantities;
 export type ValueQuantities = Ogmios.util.ValueQuantities;
 
+export const MAX_U64 = 18_446_744_073_709_551_615n;
+export const maxBigNum = (csl: CardanoSerializationLib) => csl.BigNum.from_str(MAX_U64.toString());
+
 export const transactionOutputsToArray = (outputs: CSL.TransactionOutputs): CSL.TransactionOutput[] => {
   const result: CSL.TransactionOutput[] = [];
   for (let outputIdx = 0; outputIdx < outputs.len(); outputIdx++) {

Diff for: packages/cip2/test/util/properties.ts

@@ -2,7 +2,7 @@ import { AllAssets, containsUtxo, TestUtils } from './util';
 import { SelectionResult } from '../../src/types';
 import { CSL, Ogmios } from '@cardano-sdk/core';
 import { InputSelectionError, InputSelectionFailure } from '../../src/InputSelectionError';
-import { AssetQuantities, ValueQuantities, valueToValueQuantities } from '../../src/util';
+import { AssetQuantities, MAX_U64, ValueQuantities, valueToValueQuantities } from '../../src/util';
 import fc, { Arbitrary } from 'fast-check';
 import { MockSelectionConstraints } from './constraints';
 
@@ -116,8 +116,6 @@ export const assertFailureProperties = ({
  * @returns {Arbitrary} fast-check arbitrary that generates valid sets of UTxO and outputs for input selection.
  */
 export const generateSelectionParams = (() => {
-  const MAX_U64 = 18_446_744_073_709_551_615n;
-
   /**
    * Generate random amount of coin and assets.
    */