fix: error message for over available tokens to mint or melt

Author: alexruzenhack

__tests__/integration/hathorwallet_facade.test.ts

@@ -1981,7 +1981,8 @@ describe('mintTokens', () => {
     const { hash: tokenUid } = await createTokenHelper(hWallet, 'Token to Mint', 'TMINT', 100);
 
     // Should not mint more tokens than the HTR funds allow
-    await expect(hWallet.mintTokens(tokenUid, 9000)).rejects.toThrow('HTR tokens');
+    await expect(hWallet.mintTokens(tokenUid, 9000))
+      .rejects.toThrow(/^Not enough HTR tokens for deposit: 90 required, \d+ available$/);
 
     // Minting more of the tokens
     const mintAmount = getRandomInt(100, 50);
@@ -2183,7 +2184,8 @@ describe('meltTokens', () => {
     const { hash: tokenUid } = await createTokenHelper(hWallet, 'Token to Melt', 'TMELT', 500);
 
     // Should not melt more than there is available
-    await expect(hWallet.meltTokens(tokenUid, 999)).rejects.toThrow('Not enough tokens to melt');
+    await expect(hWallet.meltTokens(tokenUid, 999))
+      .rejects.toThrow('Not enough tokens to melt: 999 requested, 500 available');
 
     // Melting some tokens
     const meltAmount = getRandomInt(99, 10);

__tests__/new/hathorwallet.test.ts

@@ -1066,6 +1066,40 @@ describe('prepare transactions without signature', () => {
     );
   });
 
+  test('prepareMintTokensData with over available tokens amount', async () => {
+    const amountAvailable = 1;
+    const amountOverAvailable = 1000;
+    // fake stuff to support the test
+    const fakeMintAuthority = [
+      {
+        txId: '002abde4018935e1bbde9600ef79c637adf42385fb1816ec284d702b7bb9ef5f',
+        index: 0,
+        value: 1,
+        token: '01',
+        address: fakeAddress.base58,
+        authorities: TOKEN_MINT_MASK,
+        timelock: null,
+        locked: false,
+      },
+    ];
+
+    // wallet and mocks
+    const hWallet = new FakeHathorWallet();
+    hWallet.storage = getStorage({
+      readOnly: false,
+      currentAddress: fakeAddress.base58,
+      selectUtxos: generateSelectUtxos({ ...fakeTokenToDepositUtxo, value: amountAvailable }),
+    });
+    jest.spyOn(hWallet, 'getMintAuthority').mockReturnValue(fakeMintAuthority);
+
+    // prepare mint
+    await expect(hWallet.prepareMintTokensData('01', amountOverAvailable, {
+      address: fakeAddress.base58,
+      pinCode: '1234',
+      signTx: false, // skip the signature
+    })).rejects.toThrow('Not enough HTR tokens for deposit: 10 required, 1 available');
+  });
+
   test('prepareMeltTokensData', async () => {
     // fake stuff to support the test
     const fakeTokenToMeltUtxo = {
@@ -1279,6 +1313,50 @@ describe('prepare transactions without signature', () => {
       ])
     );
   });
+
+  test('prepareMeltTokensData with over available tokens amount', async () => {
+    const availableToken = 10;
+    const amountOverAvailable = 100;
+    // fake stuff to support the test
+    const fakeTokenToMeltUtxo = {
+      txId: '002abde4018935e1bbde9600ef79c637adf42385fb1816ec284d702b7bb9ef5f',
+      index: 0,
+      value: availableToken,
+      token: '01',
+      address: fakeAddress.base58,
+      authorities: 0,
+      timelock: null,
+      locked: false,
+    };
+    const fakeMeltAuthority = [
+      {
+        txId: '002abde4018935e1bbde9600ef79c637adf42385fb1816ec284d702b7bb9ef5f',
+        index: 0,
+        value: 1,
+        token: '01',
+        address: fakeAddress.base58,
+        authorities: TOKEN_MELT_MASK,
+        timelock: null,
+        locked: false,
+      },
+    ];
+
+    // wallet and mocks
+    const hWallet = new FakeHathorWallet();
+    hWallet.storage = getStorage({
+      readOnly: false,
+      currentAddress: fakeAddress.base58,
+      selectUtxos: generateSelectUtxos(fakeTokenToMeltUtxo),
+    });
+    jest.spyOn(hWallet, 'getMeltAuthority').mockReturnValue(fakeMeltAuthority);
+
+    // prepare melt
+    await expect(hWallet.prepareMeltTokensData('01', amountOverAvailable, {
+      address: fakeAddress.base58,
+      pinCode: '1234',
+      signTx: false, // skip the signature
+    })).rejects.toThrow('Not enough tokens to melt: 100 requested, 10 available');
+  });
 });
 
 test('setExternalTxSigningMethod', async () => {

src/types.ts

@@ -362,7 +362,7 @@ export type UtxoSelectionAlgorithm = (
   storage: IStorage,
   token: string,
   amount: OutputValueType
-) => Promise<{ utxos: IUtxo[]; amount: OutputValueType }>;
+) => Promise<{ utxos: IUtxo[]; amount: OutputValueType; available?: OutputValueType }>;
 
 export interface IUtxoSelectionOptions {
   token?: string;

src/utils/tokens.ts

@@ -360,8 +360,9 @@ const tokens = {
     }
 
     if (foundAmount < depositAmount) {
+      const availableAmount = selectedUtxos.available;
       throw new InsufficientFundsError(
-        `Not enough HTR tokens for deposit: ${depositAmount} required, ${foundAmount} available`
+        `Not enough HTR tokens for deposit: ${depositAmount} required, ${availableAmount} available`
       );
     }
 
@@ -510,8 +511,9 @@ const tokens = {
     }
 
     if (foundAmount < amount) {
+      const availableAmount = selectedUtxos.available;
       throw new InsufficientFundsError(
-        `Not enough tokens to melt: ${amount} requested, ${foundAmount} available`
+        `Not enough tokens to melt: ${amount} requested, ${availableAmount} available`
       );
     }
 

src/utils/utxo.ts

@@ -49,7 +49,7 @@ export async function fastUtxoSelection(
   storage: IStorage,
   token: string,
   amount: OutputValueType
-): Promise<{ utxos: IUtxo[]; amount: OutputValueType }> {
+): Promise<{ utxos: IUtxo[]; amount: OutputValueType; available?: OutputValueType }> {
   const utxos: IUtxo[] = [];
   let utxosAmount = 0;
 
@@ -72,6 +72,7 @@ export async function fastUtxoSelection(
     return {
       utxos: [],
       amount: 0,
+      available: utxosAmount,
     };
   }
 
@@ -93,7 +94,7 @@ export async function bestUtxoSelection(
   storage: IStorage,
   token: string,
   amount: OutputValueType
-): Promise<{ utxos: IUtxo[]; amount: OutputValueType }> {
+): Promise<{ utxos: IUtxo[]; amount: OutputValueType; available?: OutputValueType }> {
   const utxos: IUtxo[] = [];
   let utxosAmount = 0;
   let selectedUtxo: IUtxo | null = null;
@@ -150,6 +151,7 @@ export async function bestUtxoSelection(
     return {
       utxos: [],
       amount: 0,
+      available: utxosAmount,
     };
   }
   // We need to ensure we use the smallest number of utxos and avoid hitting the maximum number of inputs