feat(decoders): add tx to decoding function

Author: jagnani73

README.md

@@ -41,7 +41,7 @@ This repository contains the logic for decoding a `raw_log_event` of a transacti
             "<protocol-name>:<EventName>",
             ["<network_1>", "<network_2>"],
             ABI as Abi,
-            async (log, chain_name, covalent_client, tx): Promise<EventType> => {
+            async (log, chain_name, covalent_client, tx_metadata): Promise<EventType> => {
                 <!-- decoding logic -->
             }
         );
@@ -55,7 +55,7 @@ This repository contains the logic for decoding a `raw_log_event` of a transacti
             1. `log`: The raw log event that is being decoded.
             2. `chain_name`: Network to which the log belongs to.
             3. `covalent_client`: The covalent client created with your covalent API key.
-            4. `tx`: The transaction object that generated this log.
+            4. `tx_metadata`: The transaction object that generated this log.
 
     3.  `decode`: The function that chooses which decoding function needs to be called for which log event. It collects all the decoded events for a transaction and returns them in an array of structured data. It is run when the API server receives a request.
 

microservices/tx/tx.routes.ts

@@ -11,7 +11,7 @@ import {
     decodeTXHeadersSchema,
     type DecodeTXHeaders,
 } from "./tx.schema";
-import { fetchEventsFromTx, fetchTxDataFromHash } from "./tx.service";
+import { fetchEventsFromLogs, fetchTxDataFromHash } from "./tx.service";
 import { type Chain } from "@covalenthq/client-sdk";
 
 export const txRouter = Router();
@@ -31,19 +31,20 @@ const handleDecode = async (
             tx_hash,
             covalentApiKey
         );
-        const events = await fetchEventsFromTx(
-            network as Chain,
-            tx,
-            covalentApiKey
-        );
         const {
-            log_events,
             dex_details,
             nft_sale_details,
             lending_details,
             safe_details,
+            log_events,
             ...metadata
         } = tx;
+        const events = await fetchEventsFromLogs(
+            network as Chain,
+            log_events,
+            metadata,
+            covalentApiKey
+        );
         const parsedMetadata = JSON.parse(
             JSON.stringify(metadata, (_key, value) => {
                 return typeof value === "bigint" ? value.toString() : value;

microservices/tx/tx.service.ts

@@ -2,8 +2,9 @@ import { GoldRushDecoder } from "../../services";
 import {
     CovalentClient,
     type Chain,
-    type Transaction,
+    type LogEvent,
 } from "@covalenthq/client-sdk";
+import { type TransactionMetadata } from "../../services/decoder/decoder.types";
 
 export const fetchTxDataFromHash = async (
     network: Chain,
@@ -35,11 +36,17 @@ export const fetchTxDataFromHash = async (
     }
 };
 
-export const fetchEventsFromTx = async (
+export const fetchEventsFromLogs = async (
     network: Chain,
-    tx: Transaction,
+    logs: LogEvent[],
+    metadata: TransactionMetadata,
     covalentApiKey: string
 ) => {
-    const events = await GoldRushDecoder.decode(network, tx, covalentApiKey);
+    const events = await GoldRushDecoder.decode(
+        network,
+        logs.reverse(),
+        metadata,
+        covalentApiKey
+    );
     return events;
 };

services/decoder/decoder.ts

@@ -3,7 +3,7 @@ import { join } from "path";
 import {
     CovalentClient,
     type Chain,
-    type Transaction,
+    type LogEvent,
 } from "@covalenthq/client-sdk";
 import {
     type Configs,
@@ -12,6 +12,7 @@ import {
     type DecodingFunctions,
     type EventType,
     type DecoderConfig,
+    type TransactionMetadata,
 } from "./decoder.types";
 import { encodeEventTopics, type Abi } from "viem";
 
@@ -109,13 +110,13 @@ export class GoldRushDecoder {
 
     public static decode = async (
         network: Chain,
-        tx: Transaction,
+        logs: LogEvent[],
+        metadata: TransactionMetadata,
         covalent_api_key: string
     ) => {
         try {
             const covalent_client = new CovalentClient(covalent_api_key);
             const events: EventType[] = [];
-            const logs = tx.log_events.reverse();
             for (const log of logs) {
                 const {
                     raw_log_topics: [topic0_hash],
@@ -132,7 +133,7 @@ export class GoldRushDecoder {
                         log,
                         network,
                         covalent_client,
-                        tx
+                        metadata
                     );
                     events.push(event);
                 }

services/decoder/decoder.types.ts

@@ -57,11 +57,20 @@ export interface EventType {
     details?: EventDetails;
 }
 
+export type TransactionMetadata = Omit<
+    Transaction,
+    | "log_events"
+    | "dex_details"
+    | "nft_sale_details"
+    | "lending_details"
+    | "safe_details"
+>;
+
 export type DecodingFunction = (
     log: LogEvent,
     chain_name: Chain,
     covalent_client: CovalentClient,
-    tx: Transaction
+    tx: TransactionMetadata
 ) => Promise<EventType>;
 
 export type DecoderConfig =

services/decoder/protocols/4337-entry-point/4337-entry-point.decoders.ts

@@ -11,7 +11,12 @@ GoldRushDecoder.on(
     "4337-entry-point:UserOperationEvent",
     ["matic-mainnet"],
     ABI as Abi,
-    async (log, chain_name, covalent_client, tx): Promise<EventType> => {
+    async (
+        log,
+        chain_name,
+        covalent_client,
+        tx_metadata
+    ): Promise<EventType> => {
         const { raw_log_data, raw_log_topics, sender_contract_decimals } = log;
 
         const { args: decoded } = decodeEventLog({

services/decoder/protocols/covalent-network/covalent-network.decoders.ts

@@ -11,7 +11,12 @@ GoldRushDecoder.on(
     "covalent-network:BlockSpecimenProductionProofSubmitted",
     ["moonbeam-mainnet"],
     TransparentUpgradeableProxyABI as Abi,
-    async (log, chain_name, covalent_client, tx): Promise<EventType> => {
+    async (
+        log,
+        chain_name,
+        covalent_client,
+        tx_metadata
+    ): Promise<EventType> => {
         const { raw_log_data, raw_log_topics } = log;
 
         const { args: decoded } = decodeEventLog({

services/decoder/protocols/grindery-one/grindery-one.decoders.ts

@@ -11,7 +11,12 @@ GoldRushDecoder.on(
     "grindery-one:Transfer",
     ["matic-mainnet"],
     ABI as Abi,
-    async (log, chain_name, covalent_client, tx): Promise<EventType> => {
+    async (
+        log,
+        chain_name,
+        covalent_client,
+        tx_metadata
+    ): Promise<EventType> => {
         const { raw_log_data, raw_log_topics } = log;
 
         const { args: decoded } = decodeEventLog({

services/decoder/protocols/opensea/opensea.decoders.ts

@@ -18,7 +18,12 @@ GoldRushDecoder.on(
     "opensea:OrderFulfilled",
     ["eth-mainnet", "matic-mainnet"],
     Seaport as Abi,
-    async (log, chain_name, covalent_client, tx): Promise<EventType> => {
+    async (
+        log,
+        chain_name,
+        covalent_client,
+        tx_metadata
+    ): Promise<EventType> => {
         const { block_signed_at, raw_log_data, raw_log_topics } = log;
 
         enum ITEM_TYPE {

services/decoder/protocols/paraswap-v5/paraswap-v5.decoders.ts

@@ -19,7 +19,12 @@ GoldRushDecoder.on(
     "paraswap-v5:SwappedV3",
     ["eth-mainnet", "matic-mainnet"],
     SimpleSwapABI as Abi,
-    async (log, chain_name, covalent_client, tx): Promise<EventType> => {
+    async (
+        log,
+        chain_name,
+        covalent_client,
+        tx_metadata
+    ): Promise<EventType> => {
         const { raw_log_data, raw_log_topics } = log;
 
         const { args: decoded } = decodeEventLog({

services/decoder/protocols/source-zorb/source-zorb.decoders.ts

@@ -11,7 +11,12 @@ GoldRushDecoder.on(
     "source-zorb:Transfer",
     ["zora-mainnet"],
     SourceZorbABI as Abi,
-    async (log, chain_name, covalent_client, tx): Promise<EventType> => {
+    async (
+        log,
+        chain_name,
+        covalent_client,
+        tx_metadata
+    ): Promise<EventType> => {
         const { raw_log_data, raw_log_topics, sender_address } = log;
 
         const { args: decoded } = decodeEventLog({

services/decoder/protocols/uniswap-v2/uniswap-v2.decoders.ts

@@ -13,7 +13,12 @@ GoldRushDecoder.on(
     "uniswap-v2:Swap",
     ["eth-mainnet"],
     PairABI as Abi,
-    async (log, chain_name, covalent_client, tx): Promise<EventType> => {
+    async (
+        log,
+        chain_name,
+        covalent_client,
+        tx_metadata
+    ): Promise<EventType> => {
         const {
             sender_address: exchange_contract,
             block_signed_at,
@@ -143,7 +148,12 @@ GoldRushDecoder.on(
     "uniswap-v2:Mint",
     ["eth-mainnet"],
     PairABI as Abi,
-    async (log, chain_name, covalent_client, tx): Promise<EventType> => {
+    async (
+        log,
+        chain_name,
+        covalent_client,
+        tx_metadata
+    ): Promise<EventType> => {
         const {
             sender_address: exchange_contract,
             raw_log_data,