Merge pull request #589 from EdgeApp/sam/failed-txs

Add `'failed'` variant to EdgeTransaction `confirmations` API

Author: samholmes

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- added: New `'failed'` value to confirmations field on `EdgeTransactions`
+
 ## 2.3.0 (2024-03-23)
 
 - added: `EdgeCorePluginOptions.infoPayload`, containing arbitrary JSON provided by the info server.

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

@@ -5,6 +5,7 @@ import { emit } from 'yaob'
 
 import { upgradeCurrencyCode } from '../../../types/type-helpers'
 import {
+  EdgeConfirmationState,
   EdgeCurrencyEngineCallbacks,
   EdgeStakingStatus,
   EdgeTokenId,
@@ -215,15 +216,12 @@ export function makeCurrencyWalletCallbacks(
           const { txs } = input.props.walletState
           for (const txid of Object.keys(txs)) {
             const reduxTx = txs[txid]
-            if (
-              reduxTx.confirmations !== 'confirmed' &&
-              reduxTx.confirmations !== 'dropped'
-            ) {
+            if (shouldCoreDetermineConfirmations(reduxTx.confirmations)) {
               const { requiredConfirmations } =
                 input.props.walletState.currencyInfo
               const { height } = input.props.walletState
 
-              reduxTx.confirmations = validateConfirmations(
+              reduxTx.confirmations = determineConfirmations(
                 reduxTx,
                 height,
                 requiredConfirmations
@@ -318,14 +316,11 @@ export function makeCurrencyWalletCallbacks(
         const { txid } = tx
 
         // DEPRECATE: After all currency plugins implement new Confirmations API
-        if (
-          tx.confirmations !== 'confirmed' &&
-          tx.confirmations !== 'dropped'
-        ) {
+        if (shouldCoreDetermineConfirmations(tx.confirmations)) {
           const { requiredConfirmations } = input.props.walletState.currencyInfo
           const { height } = input.props.walletState
 
-          tx.confirmations = validateConfirmations(
+          tx.confirmations = determineConfirmations(
             tx,
             height,
             requiredConfirmations
@@ -413,7 +408,23 @@ export function watchCurrencyWallet(input: CurrencyWalletInput): void {
   checkChangesLoop()
 }
 
-export const validateConfirmations = (
+/**
+ * Returns true if the core needs to calculate the transaction's confirmation state,
+ * because it still depends on the current block height.
+ *
+ * @deprecated Remove once all currency plugins support the new confirmations API.
+ */
+const shouldCoreDetermineConfirmations = (
+  confirmations: EdgeConfirmationState | undefined
+): boolean => {
+  return (
+    confirmations !== 'confirmed' &&
+    confirmations !== 'dropped' &&
+    confirmations !== 'failed'
+  )
+}
+
+export const determineConfirmations = (
   tx: { blockHeight: number }, // Either EdgeTransaction or MergedTransaction
   blockHeight: number,
   requiredConfirmations: number = 1 // Default confirmation rule is 1 block

src/types/types.ts

@@ -546,6 +546,9 @@ export type EdgeConfirmationState =
   | 'confirmed'
   // Dropped from the network without confirmations:
   | 'dropped'
+  // Confirmed, but failed on-chain execution (exceeded gas limit,
+  // smart-contract failure, etc):
+  | 'failed'
   // We don't know the chain height yet:
   | 'syncing'
   // No confirmations yet:

test/core/currency/confirmations.test.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai'
 import { describe, it } from 'mocha'
 
-import { validateConfirmations } from '../../../src/core/currency/wallet/currency-wallet-callbacks'
+import { determineConfirmations } from '../../../src/core/currency/wallet/currency-wallet-callbacks'
 
 describe('confirmations API', function () {
   const helper = (
@@ -12,7 +12,7 @@ describe('confirmations API', function () {
   ): void => {
     const tx = { blockHeight: txBlockHeight }
     expect(
-      validateConfirmations(tx, netBlockHeight, required),
+      determineConfirmations(tx, netBlockHeight, required),
       `Expected tx with blockHeight of ${txBlockHeight} to be ${expected} at network blockHeight ${netBlockHeight} with ${required} required confs`
     ).equals(expected)
   }