Add tx info to GetSubscription stream message

Author: altafan

api-spec/openapi/swagger/ark/v1/indexer.swagger.json

@@ -793,6 +793,15 @@
             "type": "object",
             "$ref": "#/definitions/v1IndexerVtxo"
           }
+        },
+        "tx": {
+          "type": "string"
+        },
+        "checkpointTxs": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/v1IndexerTxData"
+          }
         }
       }
     },
@@ -1006,6 +1015,17 @@
         }
       }
     },
+    "v1IndexerTxData": {
+      "type": "object",
+      "properties": {
+        "txid": {
+          "type": "string"
+        },
+        "tx": {
+          "type": "string"
+        }
+      }
+    },
     "v1IndexerTxHistoryRecord": {
       "type": "object",
       "properties": {

api-spec/protobuf/ark/v1/indexer.proto

@@ -355,4 +355,11 @@ message GetSubscriptionResponse {
   repeated string scripts = 2;
   repeated IndexerVtxo new_vtxos = 3;
   repeated IndexerVtxo spent_vtxos = 4;
+  string tx = 5;
+  map<string, IndexerTxData> checkpoint_txs = 6;
+}
+
+message IndexerTxData {
+  string txid = 1;
+  string tx = 2;
 }

api-spec/protobuf/gen/ark/v1/indexer.pb.go

@@ -525,11 +525,24 @@ func (a *grpcClient) GetSubscription(ctx context.Context, subscriptionId string)
 				return
 			}
 
+			var checkpointTxs map[string]indexer.TxData
+			if len(resp.GetCheckpointTxs()) > 0 {
+				checkpointTxs = make(map[string]indexer.TxData)
+				for k, v := range resp.GetCheckpointTxs() {
+					checkpointTxs[k] = indexer.TxData{
+						Txid: v.GetTxid(),
+						Tx:   v.GetTx(),
+					}
+				}
+			}
+
 			eventsCh <- &indexer.ScriptEvent{
-				Txid:       resp.GetTxid(),
-				Scripts:    resp.GetScripts(),
-				NewVtxos:   newIndexerVtxos(resp.GetNewVtxos()),
-				SpentVtxos: newIndexerVtxos(resp.GetSpentVtxos()),
+				Txid:          resp.GetTxid(),
+				Tx:            resp.GetTx(),
+				Scripts:       resp.GetScripts(),
+				NewVtxos:      newIndexerVtxos(resp.GetNewVtxos()),
+				SpentVtxos:    newIndexerVtxos(resp.GetSpentVtxos()),
+				CheckpointTxs: checkpointTxs,
 			}
 		}
 	}()

pkg/client-sdk/indexer/grpc/client.go

@@ -555,6 +555,17 @@ func (a *restClient) GetSubscription(ctx context.Context, subscriptionId string)
 					return
 				}
 
+				var checkpointTxs map[string]indexer.TxData
+				if len(resp.Result.CheckpointTxs) > 0 {
+					checkpointTxs = make(map[string]indexer.TxData)
+					for k, v := range resp.Result.CheckpointTxs {
+						checkpointTxs[k] = indexer.TxData{
+							Txid: v.Txid,
+							Tx:   v.Tx,
+						}
+					}
+				}
+
 				eventsCh <- &indexer.ScriptEvent{
 					Txid:       resp.Result.Txid,
 					Scripts:    resp.Result.Scripts,

pkg/client-sdk/indexer/rest/client.go

@@ -72,12 +72,19 @@ type VirtualTxsResponse struct {
 	Page *PageResponse
 }
 
+type TxData struct {
+	Txid string
+	Tx   string
+}
+
 type ScriptEvent struct {
-	Txid       string
-	Scripts    []string
-	NewVtxos   []types.Vtxo
-	SpentVtxos []types.Vtxo
-	Err        error
+	Txid          string
+	Tx            string
+	Scripts       []string
+	NewVtxos      []types.Vtxo
+	SpentVtxos    []types.Vtxo
+	CheckpointTxs map[string]TxData
+	Err           error
 }
 
 type PageRequest struct {

pkg/client-sdk/indexer/rest/service/models/v1_get_subscription_response.go

@@ -496,7 +496,16 @@ func (h *indexerService) listenToTxEvents() {
 			vtxoScript := toP2TR(vtxo.PubKey)
 			allSpentVtxos[vtxoScript] = append(allSpentVtxos[vtxoScript], newIndexerVtxo(vtxo))
 		}
-
+		var checkpointTxs map[string]*arkv1.IndexerTxData
+		if len(event.CheckpointTxs) > 0 {
+			checkpointTxs = make(map[string]*arkv1.IndexerTxData)
+			for k, v := range event.CheckpointTxs {
+				checkpointTxs[k] = &arkv1.IndexerTxData{
+					Txid: v.Txid,
+					Tx:   v.Tx,
+				}
+			}
+		}
 		for _, l := range h.scriptSubsHandler.listeners {
 			spendableVtxos := make([]*arkv1.IndexerVtxo, 0)
 			spentVtxos := make([]*arkv1.IndexerVtxo, 0)
@@ -515,10 +524,12 @@ func (h *indexerService) listenToTxEvents() {
 			if len(spendableVtxos) > 0 || len(spentVtxos) > 0 {
 				go func() {
 					l.ch <- &arkv1.GetSubscriptionResponse{
-						Txid:       event.Txid,
-						Scripts:    involvedScripts,
-						NewVtxos:   spendableVtxos,
-						SpentVtxos: spentVtxos,
+						Txid:          event.Txid,
+						Scripts:       involvedScripts,
+						NewVtxos:      spendableVtxos,
+						SpentVtxos:    spentVtxos,
+						Tx:            event.Tx,
+						CheckpointTxs: checkpointTxs,
 					}
 				}()
 			}