Add networkFees to EdgeTransaction type

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- added: Added `networkFees` to `EdgeTransaction`.
+
 ## 2.20.3 (2024-11-25)
 
 - fixed: Accept `''` to select the default API key.

src/core/currency/wallet/currency-wallet-api.ts

@@ -8,7 +8,10 @@ import {
   InternalWalletStream,
   streamTransactions
 } from '../../../client-side'
-import { upgradeCurrencyCode } from '../../../types/type-helpers'
+import {
+  upgradeCurrencyCode,
+  upgradeTxNetworkFees
+} from '../../../types/type-helpers'
 import {
   EdgeBalanceMap,
   EdgeBalances,
@@ -324,6 +327,7 @@ export function makeCurrencyWalletApi(
 
             // Filter transactions based on search criteria:
             const edgeTx = combineTxWithFile(input, tx, file, tokenId)
+            upgradeTxNetworkFees(edgeTx)
             if (!searchStringFilter(ai, edgeTx, searchString)) continue
             if (!dateFilter(edgeTx, afterDate, beforeDate)) continue
             const isKnown =
@@ -513,6 +517,7 @@ export function makeCurrencyWalletApi(
         },
         { privateKeys }
       )
+      upgradeTxNetworkFees(tx)
       tx.networkFeeOption = networkFeeOption
       tx.requestedCustomFee = customNetworkFee
       tx.spendTargets = savedTargets
@@ -691,6 +696,7 @@ export function combineTxWithFile(
     metadata: {},
     nativeAmount: tx.nativeAmount.get(tokenId) ?? '0',
     networkFee: tx.networkFee.get(tokenId) ?? '0',
+    networkFees: [],
     otherParams: { ...tx.otherParams },
     ourReceiveAddresses: tx.ourReceiveAddresses,
     parentNetworkFee:

src/core/currency/wallet/currency-wallet-callbacks.ts

@@ -3,7 +3,10 @@ import { asMaybe } from 'cleaners'
 import { isPixieShutdownError } from 'redux-pixies'
 import { emit } from 'yaob'
 
-import { upgradeCurrencyCode } from '../../../types/type-helpers'
+import {
+  upgradeCurrencyCode,
+  upgradeTxNetworkFees
+} from '../../../types/type-helpers'
 import {
   EdgeConfirmationState,
   EdgeCurrencyEngineCallbacks,
@@ -280,6 +283,8 @@ export function makeCurrencyWalletCallbacks(
       // Sanity-check incoming transactions:
       if (txs == null) return
       for (const tx of txs) {
+        // Backwards/Forwards compatibility:
+        upgradeTxNetworkFees(tx)
         if (
           typeof tx.txid !== 'string' ||
           typeof tx.date !== 'number' ||

src/types/type-helpers.ts

@@ -2,7 +2,8 @@ import type {
   EdgeCurrencyInfo,
   EdgeSwapQuote,
   EdgeTokenId,
-  EdgeTokenMap
+  EdgeTokenMap,
+  EdgeTransaction
 } from './types'
 
 /**
@@ -41,3 +42,17 @@ export function upgradeSwapQuote(quote: EdgeSwapQuote): EdgeSwapQuote {
   }
   return quote
 }
+
+export const upgradeTxNetworkFees = (tx: EdgeTransaction): void => {
+  if (tx.networkFees == null || tx.networkFees.length === 0) {
+    tx.networkFees = [
+      {
+        tokenId: tx.tokenId,
+        nativeAmount: tx.networkFee
+      }
+    ]
+    if (tx.parentNetworkFee != null) {
+      tx.networkFees.push({ tokenId: null, nativeAmount: tx.parentNetworkFee })
+    }
+  }
+}

src/types/types.ts

@@ -572,6 +572,7 @@ export interface EdgeTransaction {
   // Amounts:
   nativeAmount: string
   networkFee: string
+  networkFees: EdgeTxAmount[]
   parentNetworkFee?: string
 
   // Confirmation status:

test/core/currency/wallet/currency-wallet.test.ts

@@ -423,6 +423,38 @@ describe('currency wallets', function () {
     expect(await wallet.nativeToDenomination('10', 'TOKEN')).equals('0.01')
   })
 
+  it('can make spend', async function () {
+    const { wallet, config } = await makeFakeCurrencyWallet()
+    await config.changeUserSettings({ balance: 100 }) // Spending balance
+    const tx = await wallet.makeSpend({
+      tokenId: null,
+      spendTargets: [
+        {
+          uniqueIdentifier: 'hello',
+          nativeAmount: '50',
+          publicAddress: 'somewhere'
+        }
+      ],
+      networkFeeOption: 'high'
+    })
+    expect(tx.nativeAmount).equals('50')
+    expect(tx.metadata).deep.equals(undefined)
+    expect(tx.networkFeeOption).equals('high')
+    expect(tx.networkFee).equals('23')
+    expect(tx.networkFees).deep.equals([{ tokenId: null, nativeAmount: '23' }])
+    expect(tx.feeRateUsed).deep.equals({ fakePrice: 0 })
+    expect(tx.spendTargets).deep.equals([
+      {
+        currencyCode: 'FAKE',
+        memo: 'hello',
+        nativeAmount: '50',
+        publicAddress: 'somewhere',
+        uniqueIdentifier: 'hello'
+      }
+    ])
+    expect(tx.deviceDescription).equals('iphone12')
+  })
+
   it('can save metadata at spend time', async function () {
     const log = makeAssertLog()
     const { wallet, config } = await makeFakeCurrencyWallet()
@@ -515,6 +547,9 @@ describe('currency wallets', function () {
     expect(txs[0].networkFeeOption).equals('high')
     expect(txs[0].networkFee).equals('23')
     expect(txs[0].parentNetworkFee).equals(undefined)
+    expect(txs[0].networkFees).deep.equals([
+      { tokenId: null, nativeAmount: '23' }
+    ])
     expect(txs[0].feeRateUsed).deep.equals({ fakePrice: 0 })
     expect(txs[0].spendTargets).deep.equals([
       {

test/fake/fake-currency-plugin.ts

@@ -163,6 +163,7 @@ class FakeCurrencyEngine implements EdgeCurrencyEngine {
           memos: [],
           nativeAmount: '0',
           networkFee: '0',
+          networkFees: [],
           ourReceiveAddresses: [],
           signedTx: '',
           tokenId,
@@ -291,6 +292,7 @@ class FakeCurrencyEngine implements EdgeCurrencyEngine {
       memos,
       nativeAmount: total,
       networkFee: '23',
+      networkFees: [],
       otherParams: {},
       ourReceiveAddresses: [],
       signedTx: '',

test/fake/fake-transactions.ts

@@ -395,6 +395,7 @@ export const moreTxs: { [txid: string]: EdgeTransaction } = {
     txid: '83137fa6212eff80a819c58bd3d500e240603a2bec25dbb96dd29fe5f4b7f69b',
     nativeAmount: '10',
     networkFee: '0',
+    networkFees: [],
     currencyCode: 'FAKE',
     tokenId: null,
     chainAssetAction: {