fix: incorrect websocket/socket.io transaction updates (#1197)

* feat: draft listener class

* refactor: interface draft

* feat: socket.io channel

* docs: comments

* feat: ws-rpc channel

* refactor: rename metrics.ts

* fix: socket.io tests

* fix: websocket tests

* fix: unused exports

* fix: update on stale mempool tx drop

* feat: return complete objects in ws-rpc

* test: complete ws-rpc responses

* docs: update address tx example

* fix: also take client and docs pacakge.json

* test: try to fix socket flakyness

* test: expect tx status explicitly

* fix: notify gc mempool txs outside sql tx

Author: rafaelcr

client/README.md

@@ -287,61 +287,77 @@ Sent every time a transaction is sent or received by a specific Stacks address.
 Example message if subscribed to updates for an address `SP3C5SSYVKPAWTR8Y63CVYBR65GD3MG7K80526D1Q`:
 ```json
 {
-  "tx_id": "0x1f9e737dfbebcb57f0879a44518c1cc909be0ceb8ab0bc9b38ce63e3b6847917",
-  "nonce": 6,
-  "fee_rate": "277600",
-  "sender_address": "SP3C5SSYVKPAWTR8Y63CVYBR65GD3MG7K80526D1Q",
-  "sponsored": false,
-  "post_condition_mode": "deny",
-  "post_conditions": [
-    {
-      "type": "stx",
-      "condition_code": "sent_less_than_or_equal_to",
-      "amount": "25000000",
-      "principal": {
-        "type_id": "principal_standard",
-        "address": "SP3C5SSYVKPAWTR8Y63CVYBR65GD3MG7K80526D1Q"
-      }
-    },
-    {
-      "type": "non_fungible",
-      "condition_code": "not_sent",
-      "principal": {
-        "type_id": "principal_contract",
-        "contract_name": "stacks-skaters",
-        "address": "SPJW1XE278YMCEYMXB8ZFGJMH8ZVAAEDP2S2PJYG"
-      },
-      "asset": {
-        "contract_name": "stacks-skaters",
-        "asset_name": "stacks-skaters",
-        "contract_address": "SPJW1XE278YMCEYMXB8ZFGJMH8ZVAAEDP2S2PJYG"
-      },
-      "asset_value": {
-        "hex": "0x0100000000000000000000000000000000",
-        "repr": "u0"
+  "tx": {
+    "tx_id": "0x0c818b9af6356a2eb4d64ee1b2490193d97a82392c02e7264e006ae5979aa726",
+    "nonce": 32,
+    "fee_rate": "3000",
+    "sender_address": "SP3BK1NNSWN719Z6KDW05RBGVS940YCN6X84STYPR",
+    "sponsored": false,
+    "post_condition_mode": "deny",
+    "post_conditions": [
+      {
+        "type": "stx",
+        "condition_code": "sent_equal_to",
+        "amount": "4375722",
+        "principal": {
+          "type_id": "principal_contract",
+          "contract_name": "newyorkcitycoin-core-v1",
+          "address": "SP2H8PY27SEZ03MWRKS5XABZYQN17ETGQS3527SA5"
+        }
       }
+    ],
+    "anchor_mode": "any",
+    "is_unanchored": false,
+    "block_hash": "0xe2a811451fed35331cf462a9107e3453fdebba1682dfad83cbbcdc603f644ed3",
+    "parent_block_hash": "0x6d8653da23188d4d78ab9b6448229be68abe1bca001f8c574c094289107bce15",
+    "block_height": 58775,
+    "burn_block_time": 1651720813,
+    "burn_block_time_iso": "2022-05-05T03:20:13.000Z",
+    "parent_burn_block_time": 1651720368,
+    "parent_burn_block_time_iso": "2022-05-05T03:12:48.000Z",
+    "canonical": true,
+    "tx_index": 36,
+    "tx_status": "success",
+    "tx_result": {
+      "hex": "0x0703",
+      "repr": "(ok true)"
     },
+    "microblock_hash": "",
+    "microblock_sequence": 2147483647,
+    "microblock_canonical": true,
+    "event_count": 1,
+    "events": [],
+    "execution_cost_read_count": 15,
+    "execution_cost_read_length": 31147,
+    "execution_cost_runtime": 81975,
+    "execution_cost_write_count": 2,
+    "execution_cost_write_length": 123,
+    "tx_type": "contract_call",
+    "contract_call": {
+      "contract_id": "SP2H8PY27SEZ03MWRKS5XABZYQN17ETGQS3527SA5.newyorkcitycoin-core-v1",
+      "function_name": "claim-stacking-reward",
+      "function_signature": "(define-public (claim-stacking-reward (targetCycle uint)))",
+      "function_args": [
+        {
+          "hex": "0x0100000000000000000000000000000008",
+          "repr": "u8",
+          "name": "targetCycle",
+          "type": "uint"
+        }
+      ]
+    }
+  },
+  "stx_sent": "3000",
+  "stx_received": "4375722",
+  "stx_transfers": [
     {
-      "type": "stx",
-      "condition_code": "sent_less_than_or_equal_to",
-      "amount": "20000000",
-      "principal": {
-        "type_id": "principal_contract",
-        "contract_name": "stacks-skaters",
-        "address": "SPJW1XE278YMCEYMXB8ZFGJMH8ZVAAEDP2S2PJYG"
-      }
+      "amount": "4375722",
+      "sender": "SP2H8PY27SEZ03MWRKS5XABZYQN17ETGQS3527SA5.newyorkcitycoin-core-v1",
+      "recipient": "SP3BK1NNSWN719Z6KDW05RBGVS940YCN6X84STYPR"
     }
   ],
-  "anchor_mode": "any",
-  "tx_status": "pending",
-  "receipt_time": 1637172946,
-  "receipt_time_iso": "2021-11-17T18:15:46.000Z",
-  "tx_type": "contract_call",
-  "contract_call": {
-    "contract_id": "SPJW1XE278YMCEYMXB8ZFGJMH8ZVAAEDP2S2PJYG.stacks-skaters",
-    "function_name": "mint",
-    "function_signature": ""
-  }
+  "ft_transfers": [],
+  "nft_transfers": []
 }
 ```
 Subscribe via WebSockets:

client/src/ws/index.ts

@@ -2,18 +2,18 @@ import * as JsonRpcLite from 'jsonrpc-lite';
 import { EventEmitter } from 'eventemitter3';
 import {
   RpcTxUpdateSubscriptionParams,
-  RpcTxUpdateNotificationParams,
   RpcAddressTxSubscriptionParams,
-  RpcAddressTxNotificationParams,
   RpcAddressBalanceSubscriptionParams,
-  RpcAddressBalanceNotificationParams,
   RpcSubscriptionType,
   Block,
   RpcBlockSubscriptionParams,
   Microblock,
   Transaction,
   RpcMicroblockSubscriptionParams,
   RpcMempoolSubscriptionParams,
+  MempoolTransaction,
+  RpcAddressBalanceNotificationParams,
+  RpcAddressTxNotificationParams,
 } from '@stacks/stacks-blockchain-api-types';
 import { BASE_PATH } from '../generated/runtime';
 
@@ -35,7 +35,7 @@ export class StacksApiWebSocketClient {
     block: (event: Block) => void;
     microblock: (event: Microblock) => void;
     mempool: (event: Transaction) => void;
-    txUpdate: (event: RpcTxUpdateNotificationParams) => any;
+    txUpdate: (event: Transaction | MempoolTransaction) => any;
     addressTxUpdate: (event: RpcAddressTxNotificationParams) => void;
     addressBalanceUpdate: (event: RpcAddressBalanceNotificationParams) => void;
   }>();
@@ -93,10 +93,11 @@ export class StacksApiWebSocketClient {
     const method = data.method as RpcSubscriptionType;
     switch (method) {
       case 'tx_update':
-        this.eventEmitter.emit('txUpdate', data.params as RpcTxUpdateNotificationParams);
+        this.eventEmitter.emit('txUpdate', data.params as (Transaction | MempoolTransaction));
         break;
       case 'address_tx_update':
-        this.eventEmitter.emit('addressTxUpdate', data.params as RpcAddressTxNotificationParams);
+        this.eventEmitter.emit('addressTxUpdate',
+          data.params as RpcAddressTxNotificationParams);
         break;
       case 'address_balance_update':
         this.eventEmitter.emit(
@@ -171,11 +172,11 @@ export class StacksApiWebSocketClient {
 
   async subscribeTxUpdates(
     txId: string,
-    update: (event: RpcTxUpdateNotificationParams) => any
+    update: (event: Transaction | MempoolTransaction) => any
   ): Promise<Subscription> {
     const params: RpcTxUpdateSubscriptionParams = { event: 'tx_update', tx_id: txId };
     const subscribed = await this.rpcCall<{ tx_id: string }>('subscribe', params);
-    const listener = (event: RpcTxUpdateNotificationParams) => {
+    const listener = (event: Transaction | MempoolTransaction) => {
       if (event.tx_id === subscribed.tx_id) {
         update(event);
       }

docs/entities/ws-rpc/rpc-address-balance-notification-params.schema.json

@@ -18,7 +18,22 @@
       "enum": ["address_balance_update"]
     },
     "params": {
-      "$ref": "./rpc-address-balance-notification-params.schema.json"
+      "title": "RpcAddressBalanceNotificationParams",
+      "allOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["address"],
+          "properties": {
+            "address": {
+              "type": "string"
+            }
+          }
+        },
+        {
+          "$ref": "../../api/address/get-address-stx-balance.schema.json"
+        }
+      ]
     }
   }
 }

docs/entities/ws-rpc/rpc-address-balance-notification-response.schema.json

@@ -18,7 +18,31 @@
       "enum": ["address_tx_update"]
     },
     "params": {
-      "$ref": "./rpc-address-tx-notification-params.schema.json"
+      "title": "RpcAddressTxNotificationParams",
+      "allOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["address", "tx_id", "tx_type", "tx_status"],
+          "properties": {
+            "address": {
+              "type": "string"
+            },
+            "tx_id": {
+              "type": "string"
+            },
+            "tx_type": {
+              "$ref": "../transactions/transaction-type.schema.json"
+            },
+            "tx_status": {
+              "$ref": "../transactions/transaction-status.schema.json"
+            }
+          }
+        },
+        {
+          "$ref": "../../entities/address/transaction-with-transfers.schema.json"
+        }
+      ]
     }
   }
 }

docs/entities/ws-rpc/rpc-address-tx-notification-params.schema.json

@@ -18,7 +18,14 @@
       "enum": ["tx_update"]
     },
     "params": {
-      "$ref": "./rpc-tx-update-notification-params.schema.json"
+      "anyOf": [
+        {
+          "$ref": "../transactions/transaction.schema.json"
+        },
+        {
+          "$ref": "../mempool-transactions/transaction.schema.json"
+        }
+      ]
     }
   }
 }