@apibara/indexer 0.4.1 → 2.0.0-beta.3

package/src/starknet/filter.ts

@@ -1,205 +0,0 @@
-import type { FieldElement } from "./felt";
-
-export type Filter = {
-  /** Header information. */
-  header?: HeaderFilter;
-  /** Include transactions. */
-  transactions?: TransactionFilter[];
-  /** Include events. */
-  events?: EventFilter[];
-  /** Include messages from L2 to L1. */
-  messages?: L2ToL1MessageFilter[];
-  /** Include state updates. */
-  stateUpdate?: StateUpdateFilter;
-};
-
-export type HeaderFilter = {
-  /* If true, only include headers if any other filter matches. */
-  weak?: boolean;
-};
-
-export type TransactionFilterCommon = {
-  /*** Include reverted transactions. */
-  includeReverted?: boolean;
-};
-
-// TODO: add a `OneOf<T1, T2, T3, ..>` to enforce this pattern.
-
-export type InvokeTransactionV0Filter = {
-  invokeV0?: {
-    /** Filter by contract address. */
-    contractAddress?: FieldElement;
-    /** Filter by function selector. */
-    entryPointSelector?: FieldElement;
-    /** Filter by function arguments. */
-    calldata?: FieldElement[];
-  };
-  invokeV1?: never;
-  deploy?: never;
-  declare?: never;
-  l1Handler?: never;
-  deployAccount?: never;
-};
-
-export type InvokeTransactionV1Filter = {
-  invokeV1?: {
-    /** Filter by sender address. */
-    senderAddress?: FieldElement;
-    /** Filter by function arguments. */
-    calldata?: FieldElement[];
-  };
-  invokeV0?: never;
-  deploy?: never;
-  declare?: never;
-  l1Handler?: never;
-  deployAccount?: never;
-};
-
-export type DeployTransactionFilter = {
-  deploy?: {
-    /** Filter by contract address salt. */
-    contractAddressSalt?: FieldElement;
-    /** Filter by class hash. */
-    classHash?: FieldElement;
-    /** Filter by constructor arguments. */
-    constructorCalldata?: FieldElement[];
-  };
-  invokeV0?: never;
-  invokeV1?: never;
-  declare?: never;
-  l1Handler?: never;
-  deployAccount?: never;
-};
-
-export type DeclareTransactionFilter = {
-  declare?: {
-    /** Filter by class hash. */
-    classHash?: FieldElement;
-    /** Filter by sender address. */
-    senderAddress?: FieldElement;
-  };
-  invokeV0?: never;
-  invokeV1?: never;
-  deploy?: never;
-  l1Handler?: never;
-  deployAccount?: never;
-};
-
-export type L1HandlerTransactionFilter = {
-  l1Handler?: {
-    /** Filter by contract address. */
-    contractAddress?: FieldElement;
-    /** Filter by function selector. */
-    entryPointSelector?: FieldElement;
-    /** Filter by function arguments. */
-    calldata?: FieldElement[];
-  };
-  invokeV0?: never;
-  invokeV1?: never;
-  deploy?: never;
-  declare?: never;
-  deployAccount?: never;
-};
-
-export type DeployAccountTransactionFilter = {
-  deployAccount?: {
-    /** Filter by contract address salt. */
-    contractAddressSalt?: FieldElement;
-    /** Filter by class hash. */
-    classHash?: FieldElement;
-    /** Filter by constructor arguments. */
-    constructorCalldata?: FieldElement[];
-  };
-  invokeV0?: never;
-  invokeV1?: never;
-  deploy?: never;
-  declare?: never;
-  l1Handler?: never;
-};
-
-export type TransactionFilter = TransactionFilterCommon &
-  (
-    | InvokeTransactionV0Filter
-    | InvokeTransactionV1Filter
-    | DeployTransactionFilter
-    | DeclareTransactionFilter
-    | L1HandlerTransactionFilter
-    | DeployAccountTransactionFilter
-  );
-
-export type EventFilter = {
-  /** Filter by contract address. */
-  fromAddress?: FieldElement;
-  /** Filter by event keys (selector). */
-  keys?: FieldElement[];
-  /** Filter by event data. */
-  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 = {
-  /** Filter by destination address. */
-  toAddress?: FieldElement;
-  /** Filter by payload. */
-  payload?: FieldElement[];
-  /** Include messages from reverted transactions. */
-  includeReverted?: boolean;
-};
-
-export type StateUpdateFilter = {
-  /** Filter storage diffs. */
-  storageDiffs?: StorageDiffFilter[];
-  /** Filter declared contracts. */
-  declaredContracts?: DeclaredContractFilter[];
-  /** Filter deployed contracts. */
-  deployedContracts?: DeployedContractFilter[];
-  /** Filter nonce updates. */
-  nonces?: NonceUpdateFilter[];
-  /** Filter declared classes. */
-  declaredClasses?: DeclaredClassFilter[];
-  /** Filter replaced classes. */
-  replacedClasses?: ReplacedClassFilter[];
-};
-
-export type StorageDiffFilter = {
-  /** Filter by contract address. */
-  contractAddress?: FieldElement;
-};
-
-export type DeclaredContractFilter = {
-  /** Filter by class hash. */
-  classHash?: FieldElement;
-};
-
-export type DeployedContractFilter = {
-  /** Filter by contract address. */
-  contractAddress?: FieldElement;
-  /** Filter by class hash. */
-  classHash?: FieldElement;
-};
-
-export type NonceUpdateFilter = {
-  /** Filter by contract address. */
-  contractAddress?: FieldElement;
-  /** Filter by nonce value. */
-  nonce?: FieldElement;
-};
-
-export type DeclaredClassFilter = {
-  /** Filter by class hash. */
-  classHash?: FieldElement;
-  /** Filter by compiled class hash. */
-  compiledClassHash?: FieldElement;
-};
-
-export type ReplacedClassFilter = {
-  /** Filter by contract address. */
-  contractAddress?: FieldElement;
-  /** Filter by class hash. */
-  classHash?: FieldElement;
-};

package/src/starknet/index.ts

@@ -1,12 +0,0 @@
-export * from "./filter";
-export * from "./block";
-export { FieldElement, getSelector } from "./felt";
-export { Contract } from "./parser";
-
-import type { Filter } from "./filter";
-
-/** Starknet network type and data filter. */
-export type Starknet = {
-  network: "starknet";
-  filter: Filter;
-};

package/src/starknet/parser.test.ts

@@ -1,67 +0,0 @@
-import { Contract } from "./parser";
-import { describe, expect, it } from "vitest";
-import type { FieldElement } from "./felt";
-import { EventAbi } from "starknet";
-
-describe("Contract", () => {
-  const mockContractAddress: FieldElement = "0x0";
-
-  const mockContractAbi = [
-    {
-      type: "event",
-      name: "MockEvent",
-      kind: "struct",
-      members: [{ name: "param1", type: "felt", kind: "key" }],
-    },
-    {
-      type: "event",
-      name: "AnotherEvent",
-      kind: "struct",
-      members: [{ name: "param1", type: "felt", kind: "key" }],
-    },
-  ];
-
-  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("can lookup an event name by its selector", () => {
-    const contract = new Contract(mockContractAddress, mockContractAbi);
-    const filter = contract.eventFilter("AnotherEvent");
-    const eventName = contract.lookupEventFromSelector(
-      filter.keys?.[0] ?? "0x00",
-    );
-
-    expect(eventName).toEqual("AnotherEvent");
-  });
-
-  it("returns undefined if no event matches", () => {
-    const contract = new Contract(mockContractAddress, mockContractAbi);
-    const eventName = contract.lookupEventFromSelector(
-      "0x1234567890123456789012345678901234567890123456789012345678901234",
-    );
-
-    expect(eventName).toBeUndefined();
-  });
-
-  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

@@ -1,69 +0,0 @@
-import type { Abi, EventAbi } from "starknet";
-
-import { type FieldElement, getSelector } from "./felt";
-import type { EventFilter } from "./filter";
-
-/** Build a stream filter from a contract ABI. */
-export class Contract {
-  // Read-only properties for the contract's address and its ABI.
-  readonly address: FieldElement;
-  readonly abi: Abi;
-
-  private selectorToEvent: Record<FieldElement, string>;
-
-  constructor(contractAddress: FieldElement, contractAbi: Abi) {
-    this.address = contractAddress;
-    this.abi = contractAbi;
-    this.selectorToEvent = {};
-    this._populateSelectorToEvent();
-  }
-
-  private _findEvent(name: string): EventAbi | undefined {
-    // Find the event in the ABI matching the provided name.
-    const event: EventAbi | undefined = this.abi.find(
-      (item) => item.type === "event" && item.name === name,
-    );
-
-    return event;
-  }
-
-  private _populateSelectorToEvent(): void {
-    this.selectorToEvent = {};
-    for (const event of this.abi) {
-      if (event.type !== "event") {
-        continue;
-      }
-      this.selectorToEvent[getSelector(event.name)] = event.name;
-    }
-  }
-
-  /** 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.address,
-      keys: [getSelector(event.name)],
-      includeTransaction: opts.includeTransaction ?? false,
-      includeReceipt: opts.includeReceipt ?? false,
-      includeReverted: opts.includeReverted ?? false,
-    };
-  }
-
-  /** Returns the event name based on its selector. */
-  lookupEventFromSelector(selector: FieldElement): string | undefined {
-    return this.selectorToEvent[selector];
-  }
-}