@apibara/indexer 0.2.1 → 0.2.3

package/dist/config.d.ts

@@ -1,21 +1,21 @@
 /** Sink-related options. */
-export declare type SinkOptions = {
+export type SinkOptions = {
     /** Sink type. */
     sinkType: string;
     /** Sink options. */
     sinkOptions: object;
 };
 /** Network-specific options. */
-export declare type NetworkOptions = {
+export type NetworkOptions = {
     /** Network name. */
     network: string;
     /** Data filter. */
     filter: object;
 };
 /** Data finality. */
-export declare type Finality = "DATA_STATUS_FINALIZED" | "DATA_STATUS_ACCEPTED" | "DATA_STATUS_PENDING";
+export type Finality = "DATA_STATUS_FINALIZED" | "DATA_STATUS_ACCEPTED" | "DATA_STATUS_PENDING";
 /** Stream-related options. */
-export declare type StreamOptions = {
+export type StreamOptions = {
     /** The Apibara DNA stream url, e.g. `mainnet.starknet.a5a.ch`. */
     streamUrl?: string;
     /** Maximum message size, e.g. `50Mb` */
@@ -25,7 +25,7 @@ export declare type StreamOptions = {
     /** The Apibara DNA stream auth token. */
     authToken?: string;
 };
-export declare type Config<TNetworkOptions extends NetworkOptions = NetworkOptions, TSink extends SinkOptions = SinkOptions> = TSink & TNetworkOptions & StreamOptions & {
+export type Config<TNetworkOptions extends NetworkOptions = NetworkOptions, TSink extends SinkOptions = SinkOptions> = TSink & TNetworkOptions & StreamOptions & {
     /** How many historical blocks to process in a single batch. */
     batchSize?: number;
     /** Finality of the data to process. */

package/dist/sink/console.d.ts

@@ -1,5 +1,5 @@
 /** Console sink type. */
-export declare type Console = {
+export type Console = {
     sinkType: "console";
     /** Accept any options.
      *

package/dist/sink/mongo.d.ts

@@ -1,5 +1,5 @@
 /** MongoDB sink options */
-export declare type Mongo = {
+export type Mongo = {
     sinkType: "mongo";
     sinkOptions: {
         /** MongoDB connection string. */

package/dist/sink/parquet.d.ts

@@ -1,4 +1,4 @@
-export declare type Parquet = {
+export type Parquet = {
     sinkType: "parquet";
     sinkOptions: {
         /** Target output directory. */

package/dist/sink/postgres.d.ts

@@ -1,5 +1,5 @@
 /** PostgreSQL sink options. */
-export declare type Postgres = {
+export type Postgres = {
     sinkType: "postgres";
     sinkOptions: {
         /** Postgres connection string. */

package/dist/sink/webhook.d.ts

@@ -1,5 +1,5 @@
 /** Webhook sink options */
-export declare type Webhook = {
+export type Webhook = {
     sinkType: "webhook";
     sinkOptions: {
         /** Target URL. */

package/dist/starknet/block.d.ts

@@ -1,5 +1,5 @@
 import { FieldElement } from "./felt";
-export declare type Block = {
+export type Block = {
     /** Block header. */
     header?: BlockHeader;
     /** Transactions. */
@@ -11,7 +11,7 @@ export declare type Block = {
     /** State update. */
     stateUpdate?: StateUpdate;
 };
-export declare type BlockHeader = {
+export type BlockHeader = {
     /** Block hash. */
     blockHash: FieldElement;
     /** Parent block hash. */
@@ -25,13 +25,13 @@ export declare type BlockHeader = {
     /** Block production timestamp. */
     timestamp: string;
 };
-export declare type TransactionWithReceipt = {
+export type TransactionWithReceipt = {
     /** Transaction. */
     transaction: Transaction;
     /** Transaction receipt. */
     receipt: TransactionReceipt;
 };
-export declare type EventWithTransaction = {
+export type EventWithTransaction = {
     /** Transaction. */
     transaction: Transaction;
     /** Transaction receipt. */
@@ -39,17 +39,17 @@ export declare type EventWithTransaction = {
     /** Event. */
     event: Event;
 };
-export declare type L2ToL1MessageWithTransaction = {
+export type L2ToL1MessageWithTransaction = {
     /** Transaction. */
     transaction: Transaction;
     /** Message from L2 to L1. */
     message: L2ToL1Message;
 };
-export declare type Transaction = TransactionCommon & (InvokeTransactionV0 | InvokeTransactionV1 | DeployTransaction | DeclareTransaction | DeployAccountTransaction | L1HandlerTransaction);
-export declare type TransactionCommon = {
+export type Transaction = TransactionCommon & (InvokeTransactionV0 | InvokeTransactionV1 | DeployTransaction | DeclareTransaction | DeployAccountTransaction | L1HandlerTransaction);
+export type TransactionCommon = {
     meta: TransactionMeta;
 };
-export declare type TransactionMeta = {
+export type TransactionMeta = {
     /** Transaction hash. */
     hash: FieldElement;
     /** Maximum fee. */
@@ -61,7 +61,7 @@ export declare type TransactionMeta = {
     /** Transaction version. */
     version: string;
 };
-export declare type InvokeTransactionV0 = {
+export type InvokeTransactionV0 = {
     invokeV0?: {
         /** Target contract address. */
         contractAddress: FieldElement;
@@ -76,7 +76,7 @@ export declare type InvokeTransactionV0 = {
     l1Handler?: never;
     deployAccount?: never;
 };
-export declare type InvokeTransactionV1 = {
+export type InvokeTransactionV1 = {
     invokeV1?: {
         /** Address of the account sending the transaction. */
         senderAddress: FieldElement;
@@ -89,7 +89,7 @@ export declare type InvokeTransactionV1 = {
     l1Handler?: never;
     deployAccount?: never;
 };
-export declare type DeployTransaction = {
+export type DeployTransaction = {
     deploy?: {
         /** Constructor calldata. */
         constructorCalldata: FieldElement[];
@@ -104,7 +104,7 @@ export declare type DeployTransaction = {
     l1Handler?: never;
     deployAccount?: never;
 };
-export declare type DeclareTransaction = {
+export type DeclareTransaction = {
     declare?: {
         /** Class hash. */
         classHash: FieldElement;
@@ -119,7 +119,7 @@ export declare type DeclareTransaction = {
     l1Handler?: never;
     deployAccount?: never;
 };
-export declare type DeployAccountTransaction = {
+export type DeployAccountTransaction = {
     deployAccount?: {
         /** Constructor calldata. */
         constructorCalldata: FieldElement[];
@@ -134,7 +134,7 @@ export declare type DeployAccountTransaction = {
     declare?: never;
     l1Handler?: never;
 };
-export declare type L1HandlerTransaction = {
+export type L1HandlerTransaction = {
     l1Handler?: {
         /** Target contract address. */
         contractAddress: FieldElement;
@@ -149,7 +149,7 @@ export declare type L1HandlerTransaction = {
     declare?: never;
     deployAccount?: never;
 };
-export declare type TransactionReceipt = {
+export type TransactionReceipt = {
     /** Transaction status. */
     executionStatus: ExecutionStatus;
     /** Transaction hash. */
@@ -167,8 +167,8 @@ export declare type TransactionReceipt = {
     /** Revert reason. */
     revertReason?: string;
 };
-export declare type ExecutionStatus = "EXECUTION_STATUS_UNSPECIFIED" | "EXECUTION_STATUS_SUCCEEDED" | "EXECUTION_STATUS_REVERTED";
-export declare type Event = {
+export type ExecutionStatus = "EXECUTION_STATUS_UNSPECIFIED" | "EXECUTION_STATUS_SUCCEEDED" | "EXECUTION_STATUS_REVERTED";
+export type Event = {
     /** Event index. */
     index: number;
     /** Contract address. */
@@ -178,7 +178,7 @@ export declare type Event = {
     /** Event data. */
     data: FieldElement[];
 };
-export declare type L2ToL1Message = {
+export type L2ToL1Message = {
     /** Message index. */
     index: number;
     /** L2 sender address. */
@@ -188,7 +188,7 @@ export declare type L2ToL1Message = {
     /** Calldata. */
     payload: FieldElement[];
 };
-export declare type StateUpdate = {
+export type StateUpdate = {
     /** New state root. */
     newRoot: FieldElement;
     /** Old state root. */
@@ -196,7 +196,7 @@ export declare type StateUpdate = {
     /** State diff. */
     stateDiff: StateDiff;
 };
-export declare type StateDiff = {
+export type StateDiff = {
     /** Changes in storage. */
     storageDiffs: StorageDiff[];
     /** Declared contracts. */
@@ -210,41 +210,41 @@ export declare type StateDiff = {
     /** Classes replaced. */
     replacedClasses: ReplacedClass[];
 };
-export declare type StorageDiff = {
+export type StorageDiff = {
     /** Contract address. */
     contractAddress: FieldElement;
     /** Changes in storage. */
     storageEntries: StorageEntry[];
 };
-export declare type StorageEntry = {
+export type StorageEntry = {
     /** Storage key. */
     key: FieldElement;
     /** New storage value. */
     value: FieldElement;
 };
-export declare type DeclaredContract = {
+export type DeclaredContract = {
     /** Class hash. */
     classHash: FieldElement;
 };
-export declare type DeclaredClass = {
+export type DeclaredClass = {
     /** Class hash. */
     classHash: FieldElement;
     /** Compiled class hash. */
     compiledClassHash: FieldElement;
 };
-export declare type ReplacedClass = {
+export type ReplacedClass = {
     /** Contract address. */
     contractAddress: FieldElement;
     /** Class hash. */
     classHash: FieldElement;
 };
-export declare type DeployedContract = {
+export type DeployedContract = {
     /** Contract address. */
     contractAddress: FieldElement;
     /** Class hash. */
     classHash: FieldElement;
 };
-export declare type NonceUpdate = {
+export type NonceUpdate = {
     /** Contract address. */
     contractAddress: FieldElement;
     /** New nonce. */

package/dist/starknet/felt.d.ts

@@ -1,3 +1,3 @@
 import { z } from "zod";
-export declare type FieldElement = `0x${string}`;
+export type FieldElement = `0x${string}`;
 export declare const FieldElement: z.ZodEffects<z.ZodString, `0x${string}`, string>;

package/dist/starknet/filter.d.ts

@@ -1,5 +1,5 @@
 import { FieldElement } from "./felt";
-export declare type Filter = {
+export type Filter = {
     /** Header information. */
     header?: HeaderFilter;
     /** Include transactions. */
@@ -11,14 +11,14 @@ export declare type Filter = {
     /** Include state updates. */
     stateUpdate?: StateUpdateFilter;
 };
-export declare type HeaderFilter = {
+export type HeaderFilter = {
     weak?: boolean;
 };
-export declare type TransactionFilterCommon = {
+export type TransactionFilterCommon = {
     /*** Include reverted transactions. */
     includeReverted?: boolean;
 };
-export declare type InvokeTransactionV0Filter = {
+export type InvokeTransactionV0Filter = {
     invokeV0?: {
         /** Filter by contract address. */
         contractAddress?: FieldElement;
@@ -33,7 +33,7 @@ export declare type InvokeTransactionV0Filter = {
     l1Handler?: never;
     deployAccount?: never;
 };
-export declare type InvokeTransactionV1Filter = {
+export type InvokeTransactionV1Filter = {
     invokeV1?: {
         /** Filter by sender address. */
         senderAddress?: FieldElement;
@@ -46,7 +46,7 @@ export declare type InvokeTransactionV1Filter = {
     l1Handler?: never;
     deployAccount?: never;
 };
-export declare type DeployTransactionFilter = {
+export type DeployTransactionFilter = {
     deploy?: {
         /** Filter by contract address salt. */
         contractAddressSalt?: FieldElement;
@@ -61,7 +61,7 @@ export declare type DeployTransactionFilter = {
     l1Handler?: never;
     deployAccount?: never;
 };
-export declare type DeclareTransactionFilter = {
+export type DeclareTransactionFilter = {
     declare?: {
         /** Filter by class hash. */
         classHash?: FieldElement;
@@ -74,7 +74,7 @@ export declare type DeclareTransactionFilter = {
     l1Handler?: never;
     deployAccount?: never;
 };
-export declare type L1HandlerTransactionFilter = {
+export type L1HandlerTransactionFilter = {
     l1Handler?: {
         /** Filter by contract address. */
         contractAddress?: FieldElement;
@@ -89,7 +89,7 @@ export declare type L1HandlerTransactionFilter = {
     declare?: never;
     deployAccount?: never;
 };
-export declare type DeployAccountTransactionFilter = {
+export type DeployAccountTransactionFilter = {
     deployAccount?: {
         /** Filter by contract address salt. */
         contractAddressSalt?: FieldElement;
@@ -104,8 +104,8 @@ export declare type DeployAccountTransactionFilter = {
     declare?: never;
     l1Handler?: never;
 };
-export declare type TransactionFilter = TransactionFilterCommon & (InvokeTransactionV0Filter | InvokeTransactionV1Filter | DeployTransactionFilter | DeclareTransactionFilter | L1HandlerTransactionFilter | DeployAccountTransactionFilter);
-export declare type EventFilter = {
+export type TransactionFilter = TransactionFilterCommon & (InvokeTransactionV0Filter | InvokeTransactionV1Filter | DeployTransactionFilter | DeclareTransactionFilter | L1HandlerTransactionFilter | DeployAccountTransactionFilter);
+export type EventFilter = {
     /** Filter by contract address. */
     fromAddress?: FieldElement;
     /** Filter by event keys (selector). */
@@ -114,8 +114,12 @@ export declare type EventFilter = {
     data?: FieldElement[];
     /** Include events from reverted transactions. */
     includeReverted?: boolean;
+    /** Include the transaction that emitted the event. Defaults to true. */
+    includeTransaction?: boolean;
+    /** Include the receipt of the transaction that emitted the event. Defaults to true. */
+    includeReceipt?: boolean;
 };
-export declare type L2ToL1MessageFilter = {
+export type L2ToL1MessageFilter = {
     /** Filter by destination address. */
     toAddress?: FieldElement;
     /** Filter by payload. */
@@ -123,7 +127,7 @@ export declare type L2ToL1MessageFilter = {
     /** Include messages from reverted transactions. */
     includeReverted?: boolean;
 };
-export declare type StateUpdateFilter = {
+export type StateUpdateFilter = {
     /** Filter storage diffs. */
     storageDiffs?: StorageDiffFilter[];
     /** Filter declared contracts. */
@@ -137,33 +141,33 @@ export declare type StateUpdateFilter = {
     /** Filter replaced classes. */
     replacedClasses?: ReplacedClassFilter[];
 };
-export declare type StorageDiffFilter = {
+export type StorageDiffFilter = {
     /** Filter by contract address. */
     contractAddress?: FieldElement;
 };
-export declare type DeclaredContractFilter = {
+export type DeclaredContractFilter = {
     /** Filter by class hash. */
     classHash?: FieldElement;
 };
-export declare type DeployedContractFilter = {
+export type DeployedContractFilter = {
     /** Filter by contract address. */
     contractAddress?: FieldElement;
     /** Filter by class hash. */
     classHash?: FieldElement;
 };
-export declare type NonceUpdateFilter = {
+export type NonceUpdateFilter = {
     /** Filter by contract address. */
     contractAddress?: FieldElement;
     /** Filter by nonce value. */
     nonce?: FieldElement;
 };
-export declare type DeclaredClassFilter = {
+export type DeclaredClassFilter = {
     /** Filter by class hash. */
     classHash?: FieldElement;
     /** Filter by compiled class hash. */
     compiledClassHash?: FieldElement;
 };
-export declare type ReplacedClassFilter = {
+export type ReplacedClassFilter = {
     /** Filter by contract address. */
     contractAddress?: FieldElement;
     /** Filter by class hash. */

package/dist/starknet/index.d.ts

@@ -1,8 +1,9 @@
 export * from "./filter";
 export * from "./block";
+export { Contract } from "./parser";
 import { Filter } from "./filter";
 /** Starknet network type and data filter. */
-export declare type Starknet = {
+export type Starknet = {
     network: "starknet";
     filter: Filter;
 };

package/dist/starknet/index.js

@@ -1,3 +1,4 @@
 export * from "./filter";
 export * from "./block";
+export { Contract } from "./parser";
 //# sourceMappingURL=index.js.map

package/dist/starknet/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/starknet/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/starknet/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC"}

package/dist/starknet/parser.d.ts

@@ -0,0 +1,12 @@
+import { FieldElement } from "./felt";
+import { EventFilter } from "./filter";
+import { type Abi } from "starknet";
+/** Build a stream filter from a contract ABI. */
+export declare class Contract {
+    readonly contractAddress: FieldElement;
+    readonly contractAbi: Abi;
+    constructor(contractAddress: FieldElement, contractAbi: Abi);
+    private _findEvent;
+    /** Filter events based on their name from the contract's ABI. */
+    eventFilter(name: string, opts?: Pick<EventFilter, "includeReceipt" | "includeTransaction" | "includeReverted">): EventFilter;
+}

package/dist/starknet/parser.js

@@ -0,0 +1,33 @@
+import { hash } from "starknet";
+/** Build a stream filter from a contract ABI. */
+export class Contract {
+    // Read-only properties for the contract's address and its ABI.
+    contractAddress;
+    contractAbi;
+    constructor(contractAddress, contractAbi) {
+        this.contractAddress = contractAddress;
+        this.contractAbi = contractAbi;
+    }
+    _findEvent(name) {
+        // Find the event in the ABI matching the provided name.
+        const event = this.contractAbi.find((item) => item.type === "event" && item.name === name);
+        return event;
+    }
+    /** Filter events based on their name from the contract's ABI. */
+    eventFilter(name, opts = {}) {
+        const event = this._findEvent(name);
+        // Throw an error if the event is not found in the ABI
+        if (!event) {
+            throw new Error(`Event ${name} not found in contract ABI`);
+        }
+        // Return the found event.
+        return {
+            fromAddress: this.contractAddress,
+            keys: [hash.getSelectorFromName(event.name)],
+            includeTransaction: opts.includeTransaction ?? false,
+            includeReceipt: opts.includeReceipt ?? false,
+            includeReverted: opts.includeReverted ?? false,
+        };
+    }
+}
+//# sourceMappingURL=parser.js.map

package/dist/starknet/parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/starknet/parser.ts"],"names":[],"mappings":"AAGA,OAAO,EAAsB,IAAI,EAAE,MAAM,UAAU,CAAC;AAEpD,iDAAiD;AACjD,MAAM,OAAO,QAAQ;IACnB,+DAA+D;IACtD,eAAe,CAAe;IAC9B,WAAW,CAAM;IAE1B,YAAY,eAA6B,EAAE,WAAgB;QACzD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAEO,UAAU,CAAC,IAAY;QAC7B,wDAAwD;QACxD,MAAM,KAAK,GAAyB,IAAI,CAAC,WAAW,CAAC,IAAI,CACvD,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CACtD,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,iEAAiE;IACjE,WAAW,CACT,IAAY,EACZ,OAGI,EAAE;QAEN,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEpC,sDAAsD;QACtD,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,4BAA4B,CAAC,CAAC;SAC5D;QAED,0BAA0B;QAC1B,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,eAAe;YACjC,IAAI,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAkB,CAAC;YAC7D,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,IAAI,KAAK;YACpD,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,KAAK;YAC5C,eAAe,EAAE,IAAI,CAAC,eAAe,IAAI,KAAK;SAC/C,CAAC;IACJ,CAAC;CACF"}

package/dist/starknet/parser.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/starknet/parser.test.js

@@ -0,0 +1,32 @@
+import { Contract } from "./parser";
+import { describe, expect, it } from "vitest";
+describe("Contract class tests", () => {
+    const mockContractAddress = "0x0";
+    const mockEventAbi = {
+        type: "event",
+        name: "MockEvent",
+        kind: "struct",
+        members: [{ name: "param1", type: "felt", kind: "key" }],
+    };
+    const mockContractAbi = [mockEventAbi];
+    it("should create an EventFilter for a valid event name", () => {
+        const contract = new Contract(mockContractAddress, mockContractAbi);
+        const filter = contract.eventFilter("MockEvent");
+        expect(filter).toBeDefined();
+        expect(filter.fromAddress).toBe(mockContractAddress);
+        expect(filter.includeReceipt).toBeFalsy();
+    });
+    it("overrides some arguments", () => {
+        const contract = new Contract(mockContractAddress, mockContractAbi);
+        const filter = contract.eventFilter("MockEvent", { includeReceipt: true });
+        expect(filter).toBeDefined();
+        expect(filter.includeReceipt).toBeTruthy();
+    });
+    it("should throw an error for an invalid event name", () => {
+        const contract = new Contract(mockContractAddress, mockContractAbi);
+        expect(() => {
+            contract.eventFilter("InvalidEvent");
+        }).toThrow("Event InvalidEvent not found in contract ABI");
+    });
+});
+//# sourceMappingURL=parser.test.js.map

package/dist/starknet/parser.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.test.js","sourceRoot":"","sources":["../../src/starknet/parser.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAI9C,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,MAAM,mBAAmB,GAAiB,KAAK,CAAC;IAChD,MAAM,YAAY,GAAa;QAC7B,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;KACzD,CAAC;IAEF,MAAM,eAAe,GAAG,CAAC,YAAY,CAAC,CAAC;IAEvC,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,EAAE,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,WAAW,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;QAE3E,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,UAAU,EAAE,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;QAEpE,MAAM,CAAC,GAAG,EAAE;YACV,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC,OAAO,CAAC,8CAA8C,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apibara/indexer",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "type": "module",
   "exports": {
     ".": {
@@ -48,6 +48,7 @@
     "vitest": "^0.34.3"
   },
   "dependencies": {
+    "starknet": "^5.24.3",
     "zod": "^3.22.2"
   },
   "scripts": {

package/src/starknet/filter.ts

@@ -136,6 +136,10 @@ export type EventFilter = {
   data?: FieldElement[];
   /** Include events from reverted transactions. */
   includeReverted?: boolean;
+  /** Include the transaction that emitted the event. Defaults to true. */
+  includeTransaction?: boolean;
+  /** Include the receipt of the transaction that emitted the event. Defaults to true. */
+  includeReceipt?: boolean;
 };
 
 export type L2ToL1MessageFilter = {

package/src/starknet/index.ts

@@ -1,5 +1,6 @@
 export * from "./filter";
 export * from "./block";
+export { Contract } from "./parser";
 
 import { Filter } from "./filter";
 

package/src/starknet/parser.test.ts

@@ -0,0 +1,41 @@
+import { Contract } from "./parser";
+import { describe, expect, it } from "vitest";
+import { FieldElement } from "./felt";
+import { EventAbi } from "starknet";
+
+describe("Contract class tests", () => {
+  const mockContractAddress: FieldElement = "0x0";
+  const mockEventAbi: EventAbi = {
+    type: "event",
+    name: "MockEvent",
+    kind: "struct",
+    members: [{ name: "param1", type: "felt", kind: "key" }],
+  };
+
+  const mockContractAbi = [mockEventAbi];
+
+  it("should create an EventFilter for a valid event name", () => {
+    const contract = new Contract(mockContractAddress, mockContractAbi);
+    const filter = contract.eventFilter("MockEvent");
+
+    expect(filter).toBeDefined();
+    expect(filter.fromAddress).toBe(mockContractAddress);
+    expect(filter.includeReceipt).toBeFalsy();
+  });
+
+  it("overrides some arguments", () => {
+    const contract = new Contract(mockContractAddress, mockContractAbi);
+    const filter = contract.eventFilter("MockEvent", { includeReceipt: true });
+
+    expect(filter).toBeDefined();
+    expect(filter.includeReceipt).toBeTruthy();
+  });
+
+  it("should throw an error for an invalid event name", () => {
+    const contract = new Contract(mockContractAddress, mockContractAbi);
+
+    expect(() => {
+      contract.eventFilter("InvalidEvent");
+    }).toThrow("Event InvalidEvent not found in contract ABI");
+  });
+});

package/src/starknet/parser.ts

@@ -0,0 +1,50 @@
+import { FieldElement } from "./felt";
+import { EventFilter } from "./filter";
+
+import { type Abi, EventAbi, hash } from "starknet";
+
+/** Build a stream filter from a contract ABI. */
+export class Contract {
+  // Read-only properties for the contract's address and its ABI.
+  readonly contractAddress: FieldElement;
+  readonly contractAbi: Abi;
+
+  constructor(contractAddress: FieldElement, contractAbi: Abi) {
+    this.contractAddress = contractAddress;
+    this.contractAbi = contractAbi;
+  }
+
+  private _findEvent(name: string): EventAbi | undefined {
+    // Find the event in the ABI matching the provided name.
+    const event: EventAbi | undefined = this.contractAbi.find(
+      (item) => item.type === "event" && item.name === name,
+    );
+
+    return event;
+  }
+
+  /** Filter events based on their name from the contract's ABI. */
+  eventFilter(
+    name: string,
+    opts: Pick<
+      EventFilter,
+      "includeReceipt" | "includeTransaction" | "includeReverted"
+    > = {},
+  ): EventFilter {
+    const event = this._findEvent(name);
+
+    // Throw an error if the event is not found in the ABI
+    if (!event) {
+      throw new Error(`Event ${name} not found in contract ABI`);
+    }
+
+    // Return the found event.
+    return {
+      fromAddress: this.contractAddress,
+      keys: [hash.getSelectorFromName(event.name) as `0x${string}`],
+      includeTransaction: opts.includeTransaction ?? false,
+      includeReceipt: opts.includeReceipt ?? false,
+      includeReverted: opts.includeReverted ?? false,
+    };
+  }
+}