Merge pull request #39 from input-output-hk/etcm-205-use-checkpoints-…

…in-history

[ETCM-205] Add information about checkpointed transactions in history

src/common/wallet-state.test.ts

@@ -26,10 +26,10 @@ const createTestTx = (
 
 it('calculates next nonce from transactions', () => {
   const transactions: Transaction[] = [
-    createTestTx('outgoing', 'persisted', 100, 1),
+    createTestTx('outgoing', 'persisted_checkpoint', 100, 1),
     createTestTx('outgoing', 'confirmed', 100, 1),
     createTestTx('outgoing', 'pending', 100, 1),
-    createTestTx('incoming', 'persisted', 100, 1),
+    createTestTx('incoming', 'persisted_depth', 100, 1),
     createTestTx('incoming', 'confirmed', 100, 1),
     createTestTx('incoming', 'pending', 100, 1),
   ]
@@ -44,9 +44,9 @@ it('calculates next nonce from transactions', () => {
 
 const pendingTestBaseTransactions: Transaction[] = [
   createTestTx('incoming', 'confirmed', 100, 1),
-  createTestTx('incoming', 'persisted', 100, 1),
+  createTestTx('incoming', 'persisted_depth', 100, 1),
   createTestTx('outgoing', 'confirmed', 100, 1),
-  createTestTx('outgoing', 'persisted', 100, 1),
+  createTestTx('outgoing', 'persisted_checkpoint', 100, 1),
 ]
 const pending1 = createTestTx('outgoing', 'pending', 100, 10)
 const pending2 = createTestTx('outgoing', 'pending', 200, 10)

src/common/wallet-state.ts

@@ -67,7 +67,7 @@ export interface Transaction {
   fee: Wei
   gas: number
   direction: 'outgoing' | 'incoming'
-  status: 'pending' | 'confirmed' | 'persisted' | 'failed'
+  status: 'pending' | 'confirmed' | 'persisted_depth' | 'persisted_checkpoint' | 'failed'
   contractAddress: string | null
 }
 
@@ -205,13 +205,11 @@ export const canResetWallet = (
   walletState.walletStatus === 'ERROR' ||
   walletState.walletStatus === 'NO_WALLET'
 
-const getStatus = (
-  currentBlock: number,
-  txBlock: number | null,
-  isPending: boolean,
-): Transaction['status'] => {
-  if (isPending || txBlock === null) return 'pending'
-  return currentBlock - txBlock >= DEPTH_FOR_PERSISTENCE ? 'persisted' : 'confirmed'
+const getStatus = (tx: AccountTransaction, currentBlock: number): Transaction['status'] => {
+  if (tx.isPending || tx.blockNumber === null) return 'pending'
+  else if (tx.isCheckpointed) return 'persisted_checkpoint'
+  else if (currentBlock - tx.blockNumber >= DEPTH_FOR_PERSISTENCE) return 'persisted_depth'
+  else return 'confirmed'
 }
 
 function useWalletState(initialState?: Partial<WalletStateParams>): WalletData {
@@ -453,7 +451,7 @@ function useWalletState(initialState?: Partial<WalletStateParams>): WalletData {
               ? asWei(new BigNumber(tx.gasPrice).times(tx.gasUsed || tx.gas))
               : asWei(0),
             direction: tx.isOutgoing ? 'outgoing' : 'incoming',
-            status: getStatus(currentBlock, tx.blockNumber, tx.isPending || false),
+            status: getStatus(tx, currentBlock),
             contractAddress:
               tx.to == null
                 ? (await web3.eth.getTransactionReceipt(tx.hash))?.contractAddress || null

src/storybook-util/dummies.ts

@@ -19,7 +19,7 @@ export const dummyTransactions: Transaction[] = [
     gasUsed: 21000,
     fee: asWei(0),
     direction: 'incoming',
-    status: 'persisted',
+    status: 'persisted_depth',
     contractAddress: null,
   },
   {
@@ -67,6 +67,21 @@ export const dummyTransactions: Transaction[] = [
     status: 'failed',
     contractAddress: null,
   },
+  {
+    hash: '5',
+    from: address1,
+    to: address2,
+    blockNumber: 1,
+    timestamp: new Date(1585118001),
+    value: asEther(123),
+    gasPrice: asWei(1e9),
+    gas: 21000,
+    gasUsed: 21000,
+    fee: asWei(0),
+    direction: 'incoming',
+    status: 'persisted_checkpoint',
+    contractAddress: null,
+  },
 ]
 
 export const estimateFeesWithRandomDelay = (amount?: BigNumber): Promise<FeeEstimates> =>

src/translations/en/renderer.json

@@ -160,11 +160,13 @@
     "transactionStatus": {
       "pending": "Pending",
       "confirmed": "Confirmed",
-      "persisted": "Persisted",
+      "persisted_depth": "Persisted (Depth)",
+      "persisted_checkpoint": "Persisted (Checkpoint)",
       "failed": "Failed",
       "pendingDescription": "Transaction waiting to be added to a block in the chain",
       "confirmedDescription": "Transaction has been added to a block in the chain",
-      "persistedDescription": "Transaction cannot be rolled back",
+      "persistedDepthDescription": "Transaction cannot be rolled back - sufficient number of confirmations",
+      "persistedCheckpointDescription": "Transaction cannot be rolled back - block containing it has been checkpointed",
       "failedDescription": "Transaction has failed to reach the chain and wallet doesn’t expect it to proceed",
       "notPersistedDescription": "This transaction is not yet persisted"
     },

src/wallets/TransactionHistory.stories.tsx

@@ -64,7 +64,7 @@ export const interactive = (): JSX.Element => {
           gasUsed: 21000,
           fee: asWei(0),
           direction: 'incoming',
-          status: 'persisted',
+          status: 'persisted_depth',
           contractAddress: null,
         }),
         object<Transaction>('Transaction 2', {
@@ -97,6 +97,21 @@ export const interactive = (): JSX.Element => {
           status: 'pending',
           contractAddress: null,
         }),
+        object<Transaction>('Transaction 1', {
+          hash: '4',
+          from: '0x00112233445566778899aabbccddeeff00112233',
+          to: '0xffeeddccbbaa0011223344556677889988776655',
+          blockNumber: 1,
+          timestamp: new Date(1585118001),
+          value: asEther(123),
+          gasPrice: asWei(1e9),
+          gas: 21000,
+          gasUsed: 21000,
+          fee: asWei(0),
+          direction: 'incoming',
+          status: 'persisted_checkpoint',
+          contractAddress: null,
+        }),
       ]}
       accounts={dummyAccounts}
       availableBalance={some(ether('Available Balance', 1000))}

src/wallets/TransactionList.tsx

@@ -103,7 +103,8 @@ const TX_STATUS_ORDER: Record<Transaction['status'], number> = {
   failed: 0,
   pending: 1,
   confirmed: 2,
-  persisted: 3,
+  persisted_depth: 3,
+  persisted_checkpoint: 4,
 } as const
 
 const orderConfigs: Record<SortableProperty, Ord<Transaction>> = {

src/wallets/TransactionRow.scss

@@ -30,7 +30,8 @@
         }
       }
 
-      &.persisted {
+      &.persisted_depth,
+      &.persisted_checkpoint {
         @include themify($themes) {
           fill: themed('success-color');
         }

src/wallets/TransactionRow.tsx

@@ -28,21 +28,24 @@ export interface TransactionCellProps {
 const ICON_PER_TX_STATUS: Record<Transaction['status'], string> = {
   pending: clockIcon,
   confirmed: checkIcon,
-  persisted: checkDoubleIcon,
+  persisted_depth: checkDoubleIcon,
+  persisted_checkpoint: checkDoubleIcon,
   failed: crossIcon,
 }
 
 const DESCRIPTION_PER_TX_STATUS: Record<Transaction['status'], TKeyRenderer> = {
   pending: ['wallet', 'transactionStatus', 'pendingDescription'],
   confirmed: ['wallet', 'transactionStatus', 'confirmedDescription'],
-  persisted: ['wallet', 'transactionStatus', 'persistedDescription'],
+  persisted_depth: ['wallet', 'transactionStatus', 'persistedDepthDescription'],
+  persisted_checkpoint: ['wallet', 'transactionStatus', 'persistedCheckpointDescription'],
   failed: ['wallet', 'transactionStatus', 'failedDescription'],
 }
 
 const TX_STATUS_TRANSLATION: Record<Transaction['status'], TKeyRenderer> = {
   pending: ['wallet', 'transactionStatus', 'pending'],
   confirmed: ['wallet', 'transactionStatus', 'confirmed'],
-  persisted: ['wallet', 'transactionStatus', 'persisted'],
+  persisted_depth: ['wallet', 'transactionStatus', 'persisted_depth'],
+  persisted_checkpoint: ['wallet', 'transactionStatus', 'persisted_checkpoint'],
   failed: ['wallet', 'transactionStatus', 'failed'],
 }
 

src/web3.ts

@@ -42,6 +42,7 @@ export const CustomErrors = T.readonlyArray(CustomError)
 
 export interface AccountTransaction extends Transaction {
   isOutgoing: boolean
+  isCheckpointed: boolean | null
   isPending: boolean
   timestamp: Date | null
   gasUsed: number | null