Fix: Ledger device minimum migratable amount (#71)

* fix: refactor software profile submiting offledger request for single and multiple bundles

* fix: add submitting multiple bundles for ledger devices

* fix: update submitting multiple modules for ledger devices

* fix: error "tx not added to the mempool"

* fix: add migration log for multiple  bundles

* fix: remove extra routing after migration

* fix: test hardcoding amount for ledger devices

* fix: address indexes in bundles

* fix: address indexes in bundles

* fix: remove log file

* fix: add warning messages to popup for ledger transfers less than 1 IOTA

* fix: update warning messages for ledger migrations

---------

Co-authored-by: cpl121 <[email protected]>

Author: brancoder

packages/shared/components/popups/LedgerLegacyTransaction.svelte

@@ -1,7 +1,7 @@
 <script lang="typescript" xmlns="http://www.w3.org/1999/html">
     import { Animation, Text } from 'shared/components'
     import { formatAddressForLedger } from 'shared/lib/ledger'
-    import { asyncGetAddressChecksum } from 'shared/lib/migration'
+    import { MINIMUM_MIGRATABLE_AMOUNT, asyncGetAddressChecksum } from 'shared/lib/migration'
     import { Input, Transfer } from 'shared/lib/typings/migration'
     import { formatUnitBestMatch } from 'shared/lib/units'
     import { Locale } from '@core/i18n'
@@ -11,6 +11,11 @@
     export let transfer: Transfer
     export let inputs: Input[]
 
+    const outputAmount: number = inputs.reduce(
+        (acc, input) => acc + (input.balance < MINIMUM_MIGRATABLE_AMOUNT ? MINIMUM_MIGRATABLE_AMOUNT : input.balance),
+        0
+    )
+
     // Hardcoded strings because Ledger does not translate them
     const checksumString = (checksum): string => `Chk: ${checksum}`
     const inputString = (index): string => `Input [${index}]`
@@ -19,6 +24,9 @@
 
 <Text type="h4" classes="mb-6">{locale('popups.ledgerTransaction.transaction.title')}</Text>
 <Text type="p" classes="mb-6" secondary>{locale('popups.ledgerTransaction.transaction.info')}</Text>
+{#if outputAmount !== transfer.value}
+    <Text type="p" error classes="mb-6" secondary>{locale('popups.ledgerTransaction.transaction.warning')}</Text>
+{/if}
 
 <div class="relative w-full h-1/2 bg-white dark:bg-gray-900 flex justify-center content-center">
     <Animation
@@ -32,7 +40,14 @@
 <div class="transaction flex flex-col space-y-4 scrollable-y">
     <div class="rounded-lg bg-gray-50 dark:bg-gray-800 p-5 text-center">
         <Text type="h5" highlighted classes="mb-2">{outputString}</Text>
-        <Text type="pre">{formatUnitBestMatch(transfer.value)}</Text>
+        <Text type="pre">{formatUnitBestMatch(outputAmount)}</Text>
+        {#if outputAmount !== transfer.value}
+            <Text error type="pre">
+                {locale('popups.ledgerTransaction.transaction.inputAmount', {
+                    values: { amount: formatUnitBestMatch(transfer.value) },
+                })}
+            </Text>
+        {/if}
         <Text type="pre">{formatAddressForLedger(transfer.address, true)}</Text>
         <Text type="pre">
             {#await asyncGetAddressChecksum(transfer.address)}...{:then checksum}{checksumString(checksum)}{/await}
@@ -41,7 +56,16 @@
     {#each inputs as { address, balance, index }}
         <div class="rounded-lg bg-gray-50 dark:bg-gray-800 p-5 text-center">
             <Text type="h5" highlighted classes="mb-2">{inputString(index)}</Text>
-            <Text type="pre">{formatUnitBestMatch(balance)}</Text>
+            <Text type="pre"
+                >{formatUnitBestMatch(balance < MINIMUM_MIGRATABLE_AMOUNT ? MINIMUM_MIGRATABLE_AMOUNT : balance)}</Text
+            >
+            {#if balance < MINIMUM_MIGRATABLE_AMOUNT}
+                <Text error type="pre"
+                    >{locale('popups.ledgerTransaction.transaction.inputAmount', {
+                        values: { amount: formatUnitBestMatch(balance) },
+                    })}
+                </Text>
+            {/if}
             <Text type="pre">{formatAddressForLedger(address)}</Text>
             <Text type="pre">
                 {#await asyncGetAddressChecksum(address, true)}...{:then checksum}{checksumString(checksum)}{/await}

packages/shared/lib/migration.ts

@@ -695,18 +695,39 @@ export const createLedgerMigrationBundle = (
 ): Promise<MigrationBundle> => {
     const bundle = findMigrationBundle(bundleIndex)
 
-    const transfer = {
+    const transferForConfirmation = {
         address: migrationAddress.trytes,
         value: bundle.inputs.reduce((acc, input) => acc + input.balance, 0),
         tag: 'U'.repeat(27),
     }
 
-    openLedgerLegacyTransactionPopup(transfer, bundle.inputs)
+    openLedgerLegacyTransactionPopup(transferForConfirmation, bundle.inputs)
 
-    return prepareTransfersFn(
-        [transfer],
-        bundle.inputs.map((input) => Object.assign({}, input, { keyIndex: input.index }))
-    ).then((trytes) => {
+    const transfers = [
+        {
+            address: migrationAddress.trytes,
+            value: bundle.inputs.reduce(
+                (acc, input) =>
+                    acc + (input.balance < MINIMUM_MIGRATABLE_AMOUNT ? MINIMUM_MIGRATABLE_AMOUNT : input.balance),
+                0
+            ),
+            tag: 'U'.repeat(27),
+        },
+    ]
+
+    // The correct amount for migration is tracked in totalBalance and is diplayed to the user.
+    // If the totalBalance is less than the Min required storage deposit on stardust the receipt will contain the error messgage
+    // ex. "not enough base tokens for storage deposit: available 211188 < required 239500 base tokens"
+    // Hardcode MINIMUM_MIGRATABLE_AMOUNT for every input so we bypass legacy validation tool in contract which doesnt allow migrating less than MINIMUM_MIGRATABLE_AMOUNT.
+    // The ISC only cares about the addresses in the bundle, it internaly resolves the balances and does NOT depend on the amounts hardcoded here.
+    const inputsForTransfer: any[] = bundle.inputs.map((input) => ({
+        address: input.address,
+        keyIndex: input.index,
+        security: input.securityLevel,
+        balance: input.balance < MINIMUM_MIGRATABLE_AMOUNT ? MINIMUM_MIGRATABLE_AMOUNT : input.balance, // hardcoded amount
+    }))
+
+    return prepareTransfersFn(transfers, inputsForTransfer).then((trytes) => {
         updateLedgerBundleState(bundleIndex, trytes, false)
         callback()
         return { trytes, bundleHash: asTransactionObject(trytes[0]).bundle }

packages/shared/locales/en.json

@@ -845,7 +845,9 @@
             },
             "transaction": {
                 "title": "Confirm transaction",
-                "info": "Confirm that the transaction information displayed on your Ledger device matches the information displayed below. If they match, press both buttons on your Ledger as prompted."
+                "info": "Confirm that the transaction information displayed on your Ledger device matches the information displayed below. If they match, press both buttons on your Ledger as prompted.",
+                "warning": "Due to constraints in the legacy network, addresses with amounts below the minimum migratable threshold will show 1 IOTA as the input amount.",
+                "inputAmount": "Amount that will be migrated: {amount}"
             }
         },
         "ledgerAddress": {