docs: update readme (#10)

Author: jagnani73

README.md

@@ -1,4 +1,20 @@
-# Goldrush Decoder
+<div align="center">
+    <img alt="GoldRush Kit Logo" src="assets/goldrush-decoder-banner.png" style="max-width: 100%;"/>
+</div>
+
+<p align="center">
+  <img src="https://img.shields.io/github/license/covalenthq/goldrush-decoder" alt="MIT">
+</p>
+
+<h1 align="center">
+Decode unstructured, raw event logs into structured data with a simple API.
+</h1>
+
+<div align="center">
+Open-source. Public Good. 200+ Chains.
+</div>
+
+<br>
 
 This repository contains the logic for decoding a `raw_log_event` of a transaction to meaningful, human-readable, structured data.
 
@@ -15,13 +31,13 @@ This repository contains the logic for decoding a `raw_log_event` of a transacti
     }[];
     ```
 
-2.  **Decoder**: The `Decoder` class has different methods that enable the decoding logic to run. The various methods are
+2.  **GoldRushDecoder**: The `GoldRushDecoder` class has different methods that enable the decoding logic to run. The various methods are
 
     1.  `initDecoder`: Scans the `./services/decoder/protocols` directory for all the protocols, extracts the `configs` from them and creates a mapping to the respective decoding function. It is run when the server starts.
     2.  `on`: Creates a decoding function for the specified protocol name on the specified networks. Its declaration is:
 
         ```ts
-        Decoder.on(
+        GoldRushDecoder.on(
             "<protocol-name>:<EventName>",
             ["<network_1>", "<network_2>"],
             ABI as Abi,
@@ -42,7 +58,7 @@ This repository contains the logic for decoding a `raw_log_event` of a transacti
 
     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.
 
-## 1. Running the Development Server
+### 1. Running the Development Server
 
 Follow the following steps to start the development server of the **GoldRush Decoder**.
 
@@ -62,7 +78,7 @@ Follow the following steps to start the development server of the **GoldRush Dec
 
     The development server will start on the URL - `http://localhost:8080` (port number may change based on the `.env`, 8080 is default).
 
-## 2. API Endpoints
+### 2. API Endpoints
 
 1.  `/api/v1`: The default endpoint for the v1 of the server. A header of the key `x-covalent-api-key` with the value as the [Covalent API key](https://www.covalenthq.com/platform/apikey/) is **mandatory** for the Decoder to work.
 
@@ -83,7 +99,7 @@ Follow the following steps to start the development server of the **GoldRush Dec
         }'
         ```
 
-## 3. Adding a Decoder
+### 3. Adding a Decoder
 
 Follow the following steps to add a Decoding logic for an event from a contract of a chain.
 
@@ -138,4 +154,15 @@ Follow the following steps to add a Decoding logic for an event from a contract
     }
     ```
 
+## Contributing
+
+Contributions, issues and feature requests are welcome!
+Feel free to check [issues](https://github.com/covalenthq/goldrush-decoder/issues) page.
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## License
 
+This project is [MIT](LICENSE) licensed.

api/index.ts

@@ -6,7 +6,7 @@ import express, {
 } from "express";
 import cors from "cors";
 import { config as dotenvConfig } from "dotenv";
-import { Decoder } from "../services";
+import { GoldRushDecoder } from "../services";
 import { txRouter } from "../microservices/tx/tx.routes";
 import { TimestampParser } from "../utils/functions";
 
@@ -56,7 +56,7 @@ app.use(
 
 (async () => {
     try {
-        await Promise.all([Decoder.initDecoder()]);
+        await Promise.all([GoldRushDecoder.initDecoder()]);
         const env: string = process.env.NODE_ENV || "development";
         if (env !== "test") {
             const port: number = +(process.env.PORT || 8080);

assets/goldrush-decoder-banner.png

@@ -1,4 +1,4 @@
-import { Decoder } from "../../services";
+import { GoldRushDecoder } from "../../services";
 import {
     CovalentClient,
     type Chain,
@@ -50,7 +50,7 @@ export const fetchEventsFromLogs = async (
     logs: LogEvent[],
     covalentApiKey: string
 ) => {
-    const events = await Decoder.decode(
+    const events = await GoldRushDecoder.decode(
         network,
         logs.reverse(),
         covalentApiKey

microservices/tx/tx.service.ts

@@ -15,7 +15,7 @@ import {
 } from "./decoder.types";
 import { encodeEventTopics, type Abi } from "viem";
 
-export class Decoder {
+export class GoldRushDecoder {
     private static configs: DecoderConfig = {};
     private static decoders: Decoders = {};
     private static decoding_functions: DecodingFunctions = [];

services/decoder/decoder.ts

@@ -1,4 +1,4 @@
-import { Decoder } from "../../decoder";
+import { GoldRushDecoder } from "../../decoder";
 import { type EventType } from "../../decoder.types";
 import {
     DECODED_ACTION,
@@ -7,7 +7,7 @@ import {
 import { decodeEventLog, type Abi } from "viem";
 import ABI from "./abis/4337-entry-point.abi.json";
 
-Decoder.on(
+GoldRushDecoder.on(
     "4337-entry-point:UserOperationEvent",
     ["matic-mainnet"],
     ABI as Abi,

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

@@ -1,4 +1,4 @@
-import { Decoder } from "../../decoder";
+import { GoldRushDecoder } from "../../decoder";
 import { type EventType } from "../../decoder.types";
 import {
     DECODED_ACTION,
@@ -7,7 +7,7 @@ import {
 import { decodeEventLog, type Abi } from "viem";
 import TransparentUpgradeableProxyABI from "./abis/transparent-upgradeable-proxy.abi.json";
 
-Decoder.on(
+GoldRushDecoder.on(
     "covalent-network:BlockSpecimenProductionProofSubmitted",
     ["moonbeam-mainnet"],
     TransparentUpgradeableProxyABI as Abi,

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

@@ -1,4 +1,4 @@
-import { Decoder } from "../../decoder";
+import { GoldRushDecoder } from "../../decoder";
 import { type EventType } from "../../decoder.types";
 import {
     DECODED_ACTION,
@@ -7,7 +7,7 @@ import {
 import { decodeEventLog, type Abi } from "viem";
 import ABI from "./abis/grindery-one.abi.json";
 
-Decoder.on(
+GoldRushDecoder.on(
     "grindery-one:Transfer",
     ["matic-mainnet"],
     ABI as Abi,

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

@@ -1,4 +1,4 @@
-import { Decoder } from "../../decoder";
+import { GoldRushDecoder } from "../../decoder";
 import {
     type EventDetails,
     type EventNFTs,
@@ -14,7 +14,7 @@ import Seaport from "./abis/seaport-1.1.abi.json";
 import { TimestampParser } from "../../../../utils/functions";
 import { prettifyCurrency } from "@covalenthq/client-sdk";
 
-Decoder.on(
+GoldRushDecoder.on(
     "opensea:OrderFulfilled",
     ["eth-mainnet", "matic-mainnet"],
     Seaport as Abi,

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

@@ -1,4 +1,4 @@
-import { Decoder } from "../../decoder";
+import { GoldRushDecoder } from "../../decoder";
 import {
     type EventTokens,
     type EventDetails,
@@ -15,7 +15,7 @@ import {
     prettifyCurrency,
 } from "@covalenthq/client-sdk";
 
-Decoder.on(
+GoldRushDecoder.on(
     "paraswap-v5:SwappedV3",
     ["eth-mainnet", "matic-mainnet"],
     SimpleSwapABI as Abi,

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

@@ -1,4 +1,4 @@
-import { Decoder } from "../../decoder";
+import { GoldRushDecoder } from "../../decoder";
 import { type EventType } from "../../decoder.types";
 import {
     DECODED_ACTION,
@@ -7,7 +7,7 @@ import {
 import SourceZorbABI from "./abis/source-zorb.abi.json";
 import { type Abi, decodeEventLog } from "viem";
 
-Decoder.on(
+GoldRushDecoder.on(
     "source-zorb:Transfer",
     ["zora-mainnet"],
     SourceZorbABI as Abi,

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

@@ -1,6 +1,6 @@
 import { prettifyCurrency, type Token } from "@covalenthq/client-sdk";
 import { type Abi, decodeEventLog } from "viem";
-import { Decoder } from "../../decoder";
+import { GoldRushDecoder } from "../../decoder";
 import { TimestampParser } from "../../../../utils/functions";
 import { type EventType } from "../../decoder.types";
 import PairABI from "./abis/uniswap-v2.pair.abi.json";
@@ -9,7 +9,7 @@ import {
     DECODED_EVENT_CATEGORY,
 } from "../../decoder.constants";
 
-Decoder.on(
+GoldRushDecoder.on(
     "uniswap-v2:Swap",
     ["eth-mainnet"],
     PairABI as Abi,
@@ -139,7 +139,7 @@ Decoder.on(
     }
 );
 
-Decoder.on(
+GoldRushDecoder.on(
     "uniswap-v2:Mint",
     ["eth-mainnet"],
     PairABI as Abi,

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

@@ -1 +1 @@
-export { Decoder } from "./decoder/decoder";
+export { GoldRushDecoder } from "./decoder/decoder";