Merge branch 'main' into update_decoder_constants

Author: gurjotd23

jest.config.js

@@ -3,6 +3,6 @@ module.exports = {
     preset: "ts-jest",
     testEnvironment: "node",
     coveragePathIgnorePatterns: ["./dist/*"],
-    maxWorkers: 5,
-    testTimeout: 30000,
+    maxWorkers: 10,
+    testTimeout: 60000,
 };

microservices/tx/tx.routes.ts

@@ -11,7 +11,7 @@ import {
     decodeTXHeadersSchema,
     type DecodeTXHeaders,
 } from "./tx.schema";
-import { decodeLogsfromTx, fetchTxFromHash } from "./tx.service";
+import { decodeLogsFromTx, fetchTxFromHash } from "./tx.service";
 import { type Chain } from "@covalenthq/client-sdk";
 
 export const txRouter = Router();
@@ -39,7 +39,7 @@ const handleDecode = async (
             safe_details,
             ...tx_metadata
         } = tx;
-        const events = await decodeLogsfromTx(
+        const events = await decodeLogsFromTx(
             chain_name as Chain,
             tx,
             covalentApiKey

microservices/tx/tx.service.ts

@@ -35,7 +35,7 @@ export const fetchTxFromHash = async (
     }
 };
 
-export const decodeLogsfromTx = async (
+export const decodeLogsFromTx = async (
     chain_name: Chain,
     tx: Transaction,
     covalentApiKey: string

package.json

@@ -14,7 +14,7 @@
     "author": "",
     "license": "ISC",
     "dependencies": {
-        "@covalenthq/client-sdk": "^0.8.7",
+        "@covalenthq/client-sdk": "^0.9.4",
         "cors": "^2.8.5",
         "dotenv": "^16.3.1",
         "enquirer": "^2.4.1",

scripts/add-config.ts

@@ -89,13 +89,13 @@ const chainNameSchema = yup
     const { address, is_factory, chain_name } = (await prompt([
         {
             type: "input",
-            name: "address",
-            message: "What is the Contract Address?",
-            format: (value) => value.toLowerCase(),
-            result: (value) => value.toLowerCase(),
+            name: "chain_name",
+            message: "What is the Chain on which the contract is deployed?",
+            format: (value) => slugify(value),
+            result: (value) => slugify(value),
             validate: async (value) => {
                 try {
-                    await addressSchema.validate(value, {
+                    await chainNameSchema.validate(value, {
                         abortEarly: false,
                     });
                     return true;
@@ -105,14 +105,14 @@ const chainNameSchema = yup
             },
         },
         {
-            type: "toggle",
-            name: "is_factory",
-            message: "Is it a Factory Address?",
-            enabled: "Yes",
-            disabled: "No",
+            type: "input",
+            name: "address",
+            message: "What is the Contract Address?",
+            format: (value) => value.toLowerCase(),
+            result: (value) => value.toLowerCase(),
             validate: async (value) => {
                 try {
-                    await isFactorySchema.validate(value, {
+                    await addressSchema.validate(value, {
                         abortEarly: false,
                     });
                     return true;
@@ -122,14 +122,14 @@ const chainNameSchema = yup
             },
         },
         {
-            type: "input",
-            name: "chain_name",
-            message: "What is the Chain on which this contract is deployed?",
-            format: (value) => slugify(value),
-            result: (value) => slugify(value),
+            type: "toggle",
+            name: "is_factory",
+            message: "Is it a Factory Address?",
+            enabled: "Yes",
+            disabled: "No",
             validate: async (value) => {
                 try {
-                    await chainNameSchema.validate(value, {
+                    await isFactorySchema.validate(value, {
                         abortEarly: false,
                     });
                     return true;

services/decoder/decoder.constants.ts

@@ -9,6 +9,7 @@ export enum DECODED_EVENT_CATEGORY {
     BRIDGE = "Bridge",
     GAMING = "Gaming",
     SOCIAL = "Social",
+    STAKING = "Staking",
     OTHERS = "Others",
     STAKING = "Staking",
 }

services/decoder/decoder.ts

@@ -13,33 +13,37 @@ import {
     type EventType,
     type DecoderConfig,
     type Fallbacks,
+    type NativeDecodingFunction,
 } from "./decoder.types";
 import { encodeEventTopics, type Abi } from "viem";
 
 export class GoldRushDecoder {
     private static configs: DecoderConfig = {};
     private static decoders: Decoders = {};
     private static fallbacks: Fallbacks = {};
+    private static native_decoder: NativeDecodingFunction;
     private static decoding_functions: DecodingFunctions = [];
+    private static fallback_functions: DecodingFunctions = [];
+    private static fileExtension: "js" | "ts" =
+        process.env.NODE_ENV !== "test" ? "js" : "ts";
 
     public static initDecoder = () => {
         console.info("Initializing GoldrushDecoder Service...");
 
         const protocolsDirectoryPath: string = join(__dirname, "/protocols");
         const protocols = readdirSync(protocolsDirectoryPath);
         let protocolsCount: number = 0;
+        let configsCount: number = 0;
         for (const protocol of protocols) {
             const protocolPath = join(protocolsDirectoryPath, protocol);
             const files = readdirSync(protocolPath);
             let configFile: string | null = null,
                 decodersFile: string | null = null;
             files.forEach((file) => {
-                const fileExtension =
-                    process.env.NODE_ENV !== "test" ? "js" : "ts";
-                if (file.endsWith(`.configs.${fileExtension}`)) {
+                if (file.endsWith(`.configs.${this.fileExtension}`)) {
                     configFile = file;
                 }
-                if (file.endsWith(`.decoders.${fileExtension}`)) {
+                if (file.endsWith(`.decoders.${this.fileExtension}`)) {
                     decodersFile = file;
                 }
             });
@@ -54,6 +58,7 @@ export class GoldRushDecoder {
                         this.configs[chain_name][protocol_name][address] = {
                             is_factory: is_factory,
                         };
+                        configsCount++;
                     }
                 );
                 require(join(protocolPath, decodersFile));
@@ -62,37 +67,31 @@ export class GoldRushDecoder {
 
         const fallbacksDirectoryPath: string = join(__dirname, "/fallbacks");
         const fallbacks = readdirSync(fallbacksDirectoryPath);
-        let fallbacksCount: number = 0;
         for (const fallback of fallbacks) {
             const fallbackPath = join(fallbacksDirectoryPath, fallback);
             const files = readdirSync(fallbackPath);
             let fallbackFile: string | null = null;
             files.forEach((file) => {
-                const fileExtension =
-                    process.env.NODE_ENV !== "test" ? "js" : "ts";
-                if (file.endsWith(`.fallback.${fileExtension}`)) {
+                if (file.endsWith(`.fallback.${this.fileExtension}`)) {
                     fallbackFile = file;
                 }
             });
             if (fallbackFile) {
-                fallbacksCount++;
                 require(join(fallbackPath, fallbackFile));
             }
         }
 
-        const decodersCount = Object.keys(this.decoding_functions).length;
-        const configsCount = Object.values(this.configs).reduce(
-            (chainCount, chain) => {
-                return (
-                    chainCount +
-                    Object.values(chain).reduce((addressCount, protocol) => {
-                        return addressCount + Object.keys(protocol).length;
-                    }, 0)
-                );
-            },
-            0
+        const nativeDecoderPath: string = join(
+            __dirname,
+            "native",
+            `native.decoder.${this.fileExtension}`
         );
+        require(join(nativeDecoderPath));
+
+        const decodersCount = this.decoding_functions.length;
+        const fallbacksCount = this.fallback_functions.length;
 
+        console.info("1 native decoder added");
         console.info(`${protocolsCount.toLocaleString()} protocols found`);
         console.info(`${configsCount.toLocaleString()} configs generated`);
         console.info(`${decodersCount.toLocaleString()} decoders generated`);
@@ -124,10 +123,16 @@ export class GoldRushDecoder {
             }
             Object.keys(this.configs[chain_name][protocol]).forEach(
                 (address) => {
-                    this.decoders[chain_name] ??= {};
-                    this.decoders[chain_name][address] ??= {};
-                    this.decoders[chain_name][address][topic0_hash] =
-                        decoding_function_index;
+                    const lowercaseChainName =
+                        chain_name.toLowerCase() as Chain;
+                    const lowercaseAddress = address.toLowerCase();
+                    const lowercaseTopic0Hash = topic0_hash.toLowerCase();
+
+                    this.decoders[lowercaseChainName] ??= {};
+                    this.decoders[lowercaseChainName][lowercaseAddress] ??= {};
+                    this.decoders[lowercaseChainName][lowercaseAddress][
+                        lowercaseTopic0Hash
+                    ] = decoding_function_index;
                 }
             );
         });
@@ -142,10 +147,15 @@ export class GoldRushDecoder {
             abi: abi,
             eventName: event_name,
         });
-        this.decoding_functions.push(decoding_function);
-        const decoding_function_index: number =
-            this.decoding_functions.length - 1;
-        this.fallbacks[topic0_hash] = decoding_function_index;
+        const lowercaseTopic0Hash = topic0_hash.toLowerCase();
+        this.fallback_functions.push(decoding_function);
+        const fallback_function_index: number =
+            this.fallback_functions.length - 1;
+        this.fallbacks[lowercaseTopic0Hash] = fallback_function_index;
+    };
+
+    public static native = (native_decoder: NativeDecodingFunction) => {
+        this.native_decoder = native_decoder;
     };
 
     public static decode = async (
@@ -155,26 +165,46 @@ export class GoldRushDecoder {
     ) => {
         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],
-                sender_address: contract_address,
-                // !ERROR: add factory_contract_address in the log_event(s)
-                // factory_contract_address,
-            } = log;
-            const decoding_index =
-                // !ERROR: add factory_contract_address in the log_event(s)
-                // factory_contract_address ||
-                this.decoders[chain_name][contract_address]?.[topic0_hash];
-            const fallback_index = this.fallbacks[topic0_hash];
-            if (decoding_index !== undefined || fallback_index !== undefined) {
-                const event = await this.decoding_functions[
-                    decoding_index ?? fallback_index
-                ](log, tx, chain_name, covalent_client);
-                events.push(event);
-            }
+        if (tx.value) {
+            const nativeEvent = this.native_decoder(tx);
+            events.push(nativeEvent);
         }
-        return events;
+
+        const decodedEvents = await Promise.all(
+            (tx.log_events ?? []).map((log) => {
+                const {
+                    raw_log_topics: [topic0_hash],
+                    sender_address,
+                    sender_factory_address,
+                } = log;
+                const lowercaseChainName = chain_name.toLowerCase() as Chain;
+                const lowercaseSenderAddress = sender_address?.toLowerCase();
+                const lowercaseSenderFactoryAddress =
+                    sender_factory_address?.toLowerCase();
+                const lowercaseTopic0Hash = topic0_hash?.toLowerCase();
+
+                const decoding_index =
+                    this.decoders[lowercaseChainName]?.[
+                        lowercaseSenderAddress
+                    ]?.[lowercaseTopic0Hash] ??
+                    this.decoders[lowercaseChainName]?.[
+                        lowercaseSenderFactoryAddress
+                    ]?.[lowercaseTopic0Hash];
+                const fallback_index = this.fallbacks[lowercaseTopic0Hash];
+
+                const logFunction =
+                    decoding_index !== undefined
+                        ? this.decoding_functions[decoding_index]
+                        : fallback_index !== undefined
+                        ? this.fallback_functions[fallback_index]
+                        : null;
+
+                return logFunction
+                    ? logFunction(log, tx, chain_name, covalent_client)
+                    : null;
+            })
+        );
+
+        return events.concat(decodedEvents.filter(Boolean) as EventType[]);
     };
 }

services/decoder/decoder.types.ts

@@ -64,6 +64,8 @@ export type DecodingFunction = (
     covalent_client: CovalentClient
 ) => Promise<EventType>;
 
+export type NativeDecodingFunction = (tx: Transaction) => EventType;
+
 export type DecoderConfig =
     | {
           [chain_name in Chain]: {

services/decoder/fallbacks/approval-for-all/abis/approval-for-all.abi.json

@@ -0,0 +1,27 @@
+[
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": true,
+                "internalType": "address",
+                "name": "owner",
+                "type": "address"
+            },
+            {
+                "indexed": true,
+                "internalType": "address",
+                "name": "operator",
+                "type": "address"
+            },
+            {
+                "indexed": false,
+                "internalType": "bool",
+                "name": "approved",
+                "type": "bool"
+            }
+        ],
+        "name": "ApprovalForAll",
+        "type": "event"
+    }
+]