refactor: cleaner code

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_metadata): Promise<EventType> => {
+            async (log_event, tx, chain_name, covalent_client): Promise<EventType> => {
                 <!-- decoding logic -->
             }
         );
@@ -52,10 +52,10 @@ This repository contains the logic for decoding a `raw_log_event` of a transacti
         1. **Event Id**: A case-sensitive string concatenation of the `protocol name` with the `event name` by a `:`.
         2. **Networks**: An array of all the networks the defined decoding function will run for
         3. **Decoding Function**: The actual decoding function, it has 3 arguments passed to it:
-            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_metadata`: The transaction object that generated this log.
+            1. `log_event`: The raw log event that is being decoded.
+            2. `tx`: The transaction object that generated this log.
+            3. `chain_name`: Network to which the log belongs to.
+            4. `covalent_client`: The covalent client created with your covalent API key.
 
     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 { fetchEventsFromLogs, fetchDataFromTx } from "./tx.service";
+import { fetchEventsFromLogs, fetchTxFromHash } from "./tx.service";
 import { type Chain } from "@covalenthq/client-sdk";
 
 export const txRouter = Router();
@@ -26,15 +26,22 @@ const handleDecode = async (
             "x-covalent-api-key"
         ];
         const { network, tx_hash } = req.body as DecodeTXRequest;
-        const { log_events, metadata } = await fetchDataFromTx(
+        const tx = await fetchTxFromHash(
             network as Chain,
             tx_hash,
             covalentApiKey
         );
+        const {
+            log_events,
+            dex_details,
+            nft_sale_details,
+            lending_details,
+            safe_details,
+            ...metadata
+        } = tx;
         const events = await fetchEventsFromLogs(
             network as Chain,
-            log_events,
-            metadata,
+            tx,
             covalentApiKey
         );
         const parsedMetadata = JSON.parse(

microservices/tx/tx.service.ts

@@ -3,17 +3,14 @@ import {
     CovalentClient,
     type Chain,
     type LogEvent,
+    type Transaction,
 } from "@covalenthq/client-sdk";
-import { type TransactionMetadata } from "../../services/decoder/decoder.types";
 
-export const fetchDataFromTx = async (
+export const fetchTxFromHash = async (
     network: Chain,
     tx_hash: string,
     covalentApiKey: string
-): Promise<{
-    log_events: LogEvent[];
-    metadata: TransactionMetadata;
-}> => {
+): Promise<Transaction> => {
     const covalentClient = new CovalentClient(covalentApiKey);
     const { data, error_code, error_message } =
         await covalentClient.TransactionService.getTransaction(
@@ -30,18 +27,7 @@ export const fetchDataFromTx = async (
         );
     const tx = data?.items?.[0];
     if (tx) {
-        const {
-            log_events,
-            dex_details,
-            nft_sale_details,
-            lending_details,
-            safe_details,
-            ...metadata
-        } = tx;
-        return {
-            log_events: log_events,
-            metadata: metadata,
-        };
+        return tx;
     } else {
         throw {
             errorCode: error_code,
@@ -52,15 +38,9 @@ export const fetchDataFromTx = async (
 
 export const fetchEventsFromLogs = async (
     network: Chain,
-    logs: LogEvent[],
-    metadata: TransactionMetadata,
+    tx: Transaction,
     covalentApiKey: string
 ) => {
-    const events = await GoldRushDecoder.decode(
-        network,
-        logs.reverse(),
-        metadata,
-        covalentApiKey
-    );
+    const events = await GoldRushDecoder.decode(network, tx, covalentApiKey);
     return events;
 };

services/decoder/decoder.ts

@@ -3,7 +3,7 @@ import { join } from "path";
 import {
     CovalentClient,
     type Chain,
-    type LogEvent,
+    type Transaction,
 } from "@covalenthq/client-sdk";
 import {
     type Configs,
@@ -12,7 +12,6 @@ import {
     type DecodingFunctions,
     type EventType,
     type DecoderConfig,
-    type TransactionMetadata,
 } from "./decoder.types";
 import { encodeEventTopics, type Abi } from "viem";
 
@@ -110,13 +109,13 @@ export class GoldRushDecoder {
 
     public static decode = async (
         network: Chain,
-        logs: LogEvent[],
-        metadata: TransactionMetadata,
+        tx: Transaction,
         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],
@@ -131,9 +130,9 @@ export class GoldRushDecoder {
                 if (function_index !== undefined) {
                     const event = await this.decoding_functions[function_index](
                         log,
+                        tx,
                         network,
-                        covalent_client,
-                        metadata
+                        covalent_client
                     );
                     events.push(event);
                 }

services/decoder/decoder.types.ts

@@ -57,20 +57,11 @@ 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,
+    log_event: LogEvent,
+    tx: Transaction,
     chain_name: Chain,
-    covalent_client: CovalentClient,
-    tx: TransactionMetadata
+    covalent_client: CovalentClient
 ) => Promise<EventType>;
 
 export type DecoderConfig =

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

@@ -11,13 +11,9 @@ GoldRushDecoder.on(
     "4337-entry-point:UserOperationEvent",
     ["matic-mainnet"],
     ABI as Abi,
-    async (
-        log,
-        chain_name,
-        covalent_client,
-        tx_metadata
-    ): Promise<EventType> => {
-        const { raw_log_data, raw_log_topics, sender_contract_decimals } = log;
+    async (log_event, tx, chain_name, covalent_client): Promise<EventType> => {
+        const { raw_log_data, raw_log_topics, sender_contract_decimals } =
+            log_event;
 
         const { args: decoded } = decodeEventLog({
             abi: ABI,
@@ -42,7 +38,7 @@ GoldRushDecoder.on(
             category: DECODED_EVENT_CATEGORY.OTHERS,
             name: "User Operation Event",
             protocol: {
-                logo: log.sender_logo_url as string,
+                logo: log_event.sender_logo_url as string,
                 name: "4337 Entry Point",
             },
             details: [

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

@@ -11,13 +11,8 @@ GoldRushDecoder.on(
     "covalent-network:BlockSpecimenProductionProofSubmitted",
     ["moonbeam-mainnet"],
     TransparentUpgradeableProxyABI as Abi,
-    async (
-        log,
-        chain_name,
-        covalent_client,
-        tx_metadata
-    ): Promise<EventType> => {
-        const { raw_log_data, raw_log_topics } = log;
+    async (log_event, tx, chain_name, covalent_client): Promise<EventType> => {
+        const { raw_log_data, raw_log_topics } = log_event;
 
         const { args: decoded } = decodeEventLog({
             abi: TransparentUpgradeableProxyABI,
@@ -41,7 +36,7 @@ GoldRushDecoder.on(
             category: DECODED_EVENT_CATEGORY.OTHERS,
             name: "Block Specimen Production Proof Submitted",
             protocol: {
-                logo: log.sender_logo_url as string,
+                logo: log_event.sender_logo_url as string,
                 name: "Covalent Network",
             },
             details: [

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

@@ -11,13 +11,8 @@ GoldRushDecoder.on(
     "grindery-one:Transfer",
     ["matic-mainnet"],
     ABI as Abi,
-    async (
-        log,
-        chain_name,
-        covalent_client,
-        tx_metadata
-    ): Promise<EventType> => {
-        const { raw_log_data, raw_log_topics } = log;
+    async (log_event, tx, chain_name, covalent_client): Promise<EventType> => {
+        const { raw_log_data, raw_log_topics } = log_event;
 
         const { args: decoded } = decodeEventLog({
             abi: ABI,
@@ -38,8 +33,8 @@ GoldRushDecoder.on(
             category: DECODED_EVENT_CATEGORY.DEX,
             name: "Transfer",
             protocol: {
-                logo: log.sender_logo_url as string,
-                name: log.sender_name as string,
+                logo: log_event.sender_logo_url as string,
+                name: log_event.sender_name as string,
             },
             details: [
                 {
@@ -55,11 +50,11 @@ GoldRushDecoder.on(
             ],
             tokens: [
                 {
-                    decimals: log.sender_contract_decimals,
+                    decimals: log_event.sender_contract_decimals,
                     heading: "Token Amount",
                     pretty_quote: "",
-                    ticker_logo: log.sender_logo_url,
-                    ticker_symbol: log.sender_contract_ticker_symbol,
+                    ticker_logo: log_event.sender_logo_url,
+                    ticker_symbol: log_event.sender_contract_ticker_symbol,
                     value: decoded.value.toString(),
                 },
             ],

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

@@ -18,13 +18,8 @@ GoldRushDecoder.on(
     "opensea:OrderFulfilled",
     ["eth-mainnet", "matic-mainnet"],
     Seaport as Abi,
-    async (
-        log,
-        chain_name,
-        covalent_client,
-        tx_metadata
-    ): Promise<EventType> => {
-        const { block_signed_at, raw_log_data, raw_log_topics } = log;
+    async (log_event, tx, chain_name, covalent_client): Promise<EventType> => {
+        const { block_signed_at, raw_log_data, raw_log_topics } = log_event;
 
         enum ITEM_TYPE {
             "NATIVE" = 0,
@@ -188,7 +183,7 @@ GoldRushDecoder.on(
             category: DECODED_EVENT_CATEGORY.DEX,
             name: "Basic Order Fulfilled",
             protocol: {
-                logo: log.sender_logo_url as string,
+                logo: log_event.sender_logo_url as string,
                 name: "Opensea",
             },
             details: details,

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

@@ -19,13 +19,8 @@ GoldRushDecoder.on(
     "paraswap-v5:SwappedV3",
     ["eth-mainnet", "matic-mainnet"],
     SimpleSwapABI as Abi,
-    async (
-        log,
-        chain_name,
-        covalent_client,
-        tx_metadata
-    ): Promise<EventType> => {
-        const { raw_log_data, raw_log_topics } = log;
+    async (log_event, tx, chain_name, covalent_client): Promise<EventType> => {
+        const { raw_log_data, raw_log_topics } = log_event;
 
         const { args: decoded } = decodeEventLog({
             abi: SimpleSwapABI,
@@ -119,7 +114,7 @@ GoldRushDecoder.on(
             category: DECODED_EVENT_CATEGORY.DEX,
             name: "Swap V3",
             protocol: {
-                logo: log.sender_logo_url as string,
+                logo: log_event.sender_logo_url as string,
                 name: "Paraswap V5",
             },
             details: details,

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

@@ -11,13 +11,8 @@ GoldRushDecoder.on(
     "source-zorb:Transfer",
     ["zora-mainnet"],
     SourceZorbABI as Abi,
-    async (
-        log,
-        chain_name,
-        covalent_client,
-        tx_metadata
-    ): Promise<EventType> => {
-        const { raw_log_data, raw_log_topics, sender_address } = log;
+    async (log_event, tx, chain_name, covalent_client): Promise<EventType> => {
+        const { raw_log_data, raw_log_topics, sender_address } = log_event;
 
         const { args: decoded } = decodeEventLog({
             abi: SourceZorbABI,
@@ -45,7 +40,7 @@ GoldRushDecoder.on(
             category: DECODED_EVENT_CATEGORY.DEX,
             name: "Transfer",
             protocol: {
-                logo: log.sender_logo_url as string,
+                logo: log_event.sender_logo_url as string,
                 name: "SOURCE ZORB",
             },
             nfts: [