@apibara/indexer 0.2.0 → 0.2.2

package/dist/starknet/block.d.ts

@@ -1,145 +1,252 @@
 import { FieldElement } from "./felt";
 export declare type Block = {
+    /** Block header. */
     header?: BlockHeader;
-    transactions: TransactionWithReceipt[];
-    events: EventWithTransaction[];
-    l2ToL1Messages: L2ToL1MessageWithTransaction[];
-    stateUpdate: StateUpdate;
+    /** Transactions. */
+    transactions?: TransactionWithReceipt[];
+    /** Events. */
+    events?: EventWithTransaction[];
+    /** Messages from L2 to L1. */
+    l2ToL1Messages?: L2ToL1MessageWithTransaction[];
+    /** State update. */
+    stateUpdate?: StateUpdate;
 };
 export declare type BlockHeader = {
+    /** Block hash. */
     blockHash: FieldElement;
+    /** Parent block hash. */
     parentBlockHash: FieldElement;
+    /** Block number. */
     blockNumber: string;
+    /** Sequencer address. */
     sequencerAddress: FieldElement;
+    /** New state root. */
     newRoot: FieldElement;
+    /** Block production timestamp. */
     timestamp: string;
 };
 export declare type TransactionWithReceipt = {
+    /** Transaction. */
     transaction: Transaction;
+    /** Transaction receipt. */
     receipt: TransactionReceipt;
 };
 export declare type EventWithTransaction = {
+    /** Transaction. */
     transaction: Transaction;
+    /** Transaction receipt. */
     receipt: TransactionReceipt;
+    /** Event. */
     event: Event;
 };
 export declare type L2ToL1MessageWithTransaction = {
+    /** Transaction. */
     transaction: Transaction;
+    /** Message from L2 to L1. */
     message: L2ToL1Message;
 };
-export declare type Transaction = {
+export declare type Transaction = TransactionCommon & (InvokeTransactionV0 | InvokeTransactionV1 | DeployTransaction | DeclareTransaction | DeployAccountTransaction | L1HandlerTransaction);
+export declare type TransactionCommon = {
     meta: TransactionMeta;
-} & TransactionBody;
-export declare type TransactionBody = {
-    invokeV0: InvokeTransactionV0;
-} | {
-    invokeV1: InvokeTransactionV1;
-} | {
-    deploy: DeployTransaction;
-} | {
-    declare: DeclareTransaction;
-} | {
-    deployAccount: DeployAccountTransaction;
-} | {
-    l1Handler: L1HandlerTransaction;
 };
 export declare type TransactionMeta = {
+    /** Transaction hash. */
     hash: FieldElement;
+    /** Maximum fee. */
     maxFee: FieldElement;
+    /** Signature. */
     signature: FieldElement[];
+    /** Nonce. */
     nonce: FieldElement;
+    /** Transaction version. */
     version: string;
 };
 export declare type InvokeTransactionV0 = {
-    contractAddress: FieldElement;
-    entryPointSelector: FieldElement;
-    calldata: FieldElement[];
+    invokeV0?: {
+        /** Target contract address. */
+        contractAddress: FieldElement;
+        /** Selector of the function being invoked. */
+        entryPointSelector: FieldElement;
+        /** Calldata. */
+        calldata: FieldElement[];
+    };
+    invokeV1?: never;
+    deploy?: never;
+    declare?: never;
+    l1Handler?: never;
+    deployAccount?: never;
 };
 export declare type InvokeTransactionV1 = {
-    contractAddress: FieldElement;
-    entryPointSelector: FieldElement;
-    calldata: FieldElement[];
+    invokeV1?: {
+        /** Address of the account sending the transaction. */
+        senderAddress: FieldElement;
+        /** Calldata. */
+        calldata: FieldElement[];
+    };
+    invokeV0?: never;
+    deploy?: never;
+    declare?: never;
+    l1Handler?: never;
+    deployAccount?: never;
 };
 export declare type DeployTransaction = {
-    constructorCalldata: FieldElement[];
-    contractAddressSalt: FieldElement;
-    classHash: FieldElement;
+    deploy?: {
+        /** Constructor calldata. */
+        constructorCalldata: FieldElement[];
+        /** Salt used when computing the contract's address. */
+        contractAddressSalt: FieldElement;
+        /** Hash of the class being deployed. */
+        classHash: FieldElement;
+    };
+    invokeV0?: never;
+    invokeV1?: never;
+    declare?: never;
+    l1Handler?: never;
+    deployAccount?: never;
 };
 export declare type DeclareTransaction = {
-    classHash: FieldElement;
-    senderAddress: FieldElement;
-    compiledClassHash: FieldElement;
+    declare?: {
+        /** Class hash. */
+        classHash: FieldElement;
+        /** Address of the account sending the transaction. */
+        senderAddress: FieldElement;
+        /** Hash of the cairo assembly resulting from the sierra compilation. */
+        compiledClassHash: FieldElement;
+    };
+    invokeV0?: never;
+    invokeV1?: never;
+    deploy?: never;
+    l1Handler?: never;
+    deployAccount?: never;
 };
 export declare type DeployAccountTransaction = {
-    constructorCalldata: FieldElement[];
-    contractAddressSalt: FieldElement;
-    classHash: FieldElement;
+    deployAccount?: {
+        /** Constructor calldata. */
+        constructorCalldata: FieldElement[];
+        /** Salt used when computing the contract's address. */
+        contractAddressSalt: FieldElement;
+        /** Hash of the class being deployed. */
+        classHash: FieldElement;
+    };
+    invokeV0?: never;
+    invokeV1?: never;
+    deploy?: never;
+    declare?: never;
+    l1Handler?: never;
 };
 export declare type L1HandlerTransaction = {
-    contractAddress: FieldElement;
-    entryPointSelector: FieldElement;
-    calldata: FieldElement[];
+    l1Handler?: {
+        /** Target contract address. */
+        contractAddress: FieldElement;
+        /** Selector of the function being invoked. */
+        entryPointSelector: FieldElement;
+        /** Calldata. */
+        calldata: FieldElement[];
+    };
+    invokeV0?: never;
+    invokeV1?: never;
+    deploy?: never;
+    declare?: never;
+    deployAccount?: never;
 };
 export declare type TransactionReceipt = {
+    /** Transaction status. */
     executionStatus: ExecutionStatus;
+    /** Transaction hash. */
     transactionHash: FieldElement;
+    /** Transaction index. */
     transactionIndex: string;
+    /** Actual fee paid by the account. */
     actualFee: FieldElement;
+    /** Address of the contract created by the transaction. */
     contractAddress: FieldElement;
+    /** Messages from L2 to L1. */
     l2ToL1Messages: L2ToL1Message[];
+    /** Events. */
     events: Event[];
+    /** Revert reason. */
     revertReason?: string;
 };
 export declare type ExecutionStatus = "EXECUTION_STATUS_UNSPECIFIED" | "EXECUTION_STATUS_SUCCEEDED" | "EXECUTION_STATUS_REVERTED";
 export declare type Event = {
+    /** Event index. */
     index: number;
+    /** Contract address. */
     fromAddress: FieldElement;
+    /** Event selector. */
     keys: FieldElement[];
+    /** Event data. */
     data: FieldElement[];
 };
 export declare type L2ToL1Message = {
+    /** Message index. */
     index: number;
+    /** L2 sender address. */
     fromAddress: FieldElement;
+    /** L1 target address. */
     toAddress: FieldElement;
+    /** Calldata. */
     payload: FieldElement[];
 };
 export declare type StateUpdate = {
+    /** New state root. */
     newRoot: FieldElement;
+    /** Old state root. */
     oldRoot: FieldElement;
+    /** State diff. */
     stateDiff: StateDiff;
 };
 export declare type StateDiff = {
+    /** Changes in storage. */
     storageDiffs: StorageDiff[];
+    /** Declared contracts. */
     declaredContracts: DeclaredContract[];
+    /** Deployed contracts. */
     deployedContracts: DeployedContract[];
+    /** Nonce updates. */
     nonces: NonceUpdate[];
+    /** Classes declared. */
     declaredClasses: DeclaredClass[];
+    /** Classes replaced. */
     replacedClasses: ReplacedClass[];
 };
 export declare type StorageDiff = {
+    /** Contract address. */
     contractAddress: FieldElement;
+    /** Changes in storage. */
     storageEntries: StorageEntry[];
 };
 export declare type StorageEntry = {
+    /** Storage key. */
     key: FieldElement;
+    /** New storage value. */
     value: FieldElement;
 };
 export declare type DeclaredContract = {
+    /** Class hash. */
     classHash: FieldElement;
 };
 export declare type DeclaredClass = {
+    /** Class hash. */
     classHash: FieldElement;
+    /** Compiled class hash. */
     compiledClassHash: FieldElement;
 };
 export declare type ReplacedClass = {
+    /** Contract address. */
     contractAddress: FieldElement;
+    /** Class hash. */
     classHash: FieldElement;
 };
 export declare type DeployedContract = {
+    /** Contract address. */
     contractAddress: FieldElement;
+    /** Class hash. */
     classHash: FieldElement;
 };
 export declare type NonceUpdate = {
+    /** Contract address. */
     contractAddress: FieldElement;
+    /** New nonce. */
     nonce: FieldElement;
 };

package/dist/starknet/block.test-d.d.ts

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

package/dist/starknet/block.test-d.js

@@ -0,0 +1,95 @@
+import { assertType, describe, test } from "vitest";
+import { FieldElement } from "./felt";
+const address = "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7";
+const entryPointSelector = "0x03943907ef0ef6f9d2e2408b05e520a66daaf74293dbf665e5a20b117676170e";
+const calldata = [FieldElement.parse("0x01"), FieldElement.parse("0x02")];
+const meta = {
+    hash: FieldElement.parse("0x01"),
+    maxFee: FieldElement.parse("0x02"),
+    signature: [FieldElement.parse("0x03")],
+    nonce: FieldElement.parse("0x04"),
+    version: "0",
+};
+const invokeV0 = {
+    contractAddress: FieldElement.parse(address),
+    entryPointSelector: FieldElement.parse(entryPointSelector),
+    calldata,
+};
+const invokeV1 = {
+    senderAddress: FieldElement.parse(address),
+    calldata,
+};
+const deploy = {
+    constructorCalldata: calldata,
+    contractAddressSalt: FieldElement.parse("0x01"),
+    classHash: FieldElement.parse("0x02"),
+};
+const declare = {
+    classHash: FieldElement.parse("0x01"),
+    senderAddress: FieldElement.parse(address),
+    compiledClassHash: FieldElement.parse("0x02"),
+};
+describe("Block", () => {
+    test("all optional", () => {
+        assertType({});
+    });
+});
+describe("BlockHeader", () => {
+    test("all fields", () => {
+        assertType({
+            blockHash: FieldElement.parse("0x01"),
+            parentBlockHash: FieldElement.parse("0x00"),
+            blockNumber: "1",
+            sequencerAddress: FieldElement.parse(address),
+            newRoot: FieldElement.parse("0x02"),
+            timestamp: "1",
+        });
+    });
+});
+describe("Transaction", () => {
+    test("only one type", () => {
+        // @ts-expect-error - should be one of the types
+        assertType({
+            meta,
+            invokeV0,
+            invokeV1,
+        });
+    });
+    test("invokeV0", () => {
+        assertType({
+            meta,
+            invokeV0,
+        });
+    });
+    test("invokeV1", () => {
+        assertType({
+            meta,
+            invokeV1,
+        });
+    });
+    test("deploy", () => {
+        assertType({
+            meta,
+            deploy,
+        });
+    });
+    test("declare", () => {
+        assertType({
+            meta,
+            declare,
+        });
+    });
+    test("l1Handler", () => {
+        assertType({
+            meta,
+            l1Handler: invokeV0,
+        });
+    });
+    test("deployAccount", () => {
+        assertType({
+            meta,
+            deployAccount: deploy,
+        });
+    });
+});
+//# sourceMappingURL=block.test-d.js.map

package/dist/starknet/block.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"block.test-d.js","sourceRoot":"","sources":["../../src/starknet/block.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAGpD,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,MAAM,OAAO,GACX,oEAAoE,CAAC;AACvE,MAAM,kBAAkB,GACtB,oEAAoE,CAAC;AACvE,MAAM,QAAQ,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;AAC1E,MAAM,IAAI,GAAG;IACX,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;IAClC,SAAS,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACvC,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;IACjC,OAAO,EAAE,GAAG;CACb,CAAC;AAEF,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC;IAC5C,kBAAkB,EAAE,YAAY,CAAC,KAAK,CAAC,kBAAkB,CAAC;IAC1D,QAAQ;CACT,CAAC;AAEF,MAAM,QAAQ,GAAG;IACf,aAAa,EAAE,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC;IAC1C,QAAQ;CACT,CAAC;AAEF,MAAM,MAAM,GAAG;IACb,mBAAmB,EAAE,QAAQ;IAC7B,mBAAmB,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;IAC/C,SAAS,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;CACtC,CAAC;AAEF,MAAM,OAAO,GAAG;IACd,SAAS,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;IACrC,aAAa,EAAE,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC;IAC1C,iBAAiB,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;CAC9C,CAAC;AAEF,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,IAAI,CAAC,cAAc,EAAE,GAAG,EAAE;QACxB,UAAU,CAAQ,EAAE,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE;QACtB,UAAU,CAAc;YACtB,SAAS,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;YACrC,eAAe,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;YAC3C,WAAW,EAAE,GAAG;YAChB,gBAAgB,EAAE,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC;YAC7C,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;YACnC,SAAS,EAAE,GAAG;SACf,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE;QACzB,gDAAgD;QAChD,UAAU,CAAc;YACtB,IAAI;YACJ,QAAQ;YACR,QAAQ;SACT,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE;QACpB,UAAU,CAAc;YACtB,IAAI;YACJ,QAAQ;SACT,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE;QACpB,UAAU,CAAc;YACtB,IAAI;YACJ,QAAQ;SACT,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE;QAClB,UAAU,CAAc;YACtB,IAAI;YACJ,MAAM;SACP,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;QACnB,UAAU,CAAc;YACtB,IAAI;YACJ,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;QACrB,UAAU,CAAc;YACtB,IAAI;YACJ,SAAS,EAAE,QAAQ;SACpB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE;QACzB,UAAU,CAAc;YACtB,IAAI;YACJ,aAAa,EAAE,MAAM;SACtB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/starknet/filter.d.ts

@@ -114,6 +114,10 @@ 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 = {
     /** Filter by destination address. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apibara/indexer",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "type": "module",
   "exports": {
     ".": {

package/src/starknet/block.test-d.ts

@@ -0,0 +1,112 @@
+import { assertType, describe, test } from "vitest";
+
+import { Block, BlockHeader, Transaction } from "./block";
+import { FieldElement } from "./felt";
+
+const address =
+  "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7";
+const entryPointSelector =
+  "0x03943907ef0ef6f9d2e2408b05e520a66daaf74293dbf665e5a20b117676170e";
+const calldata = [FieldElement.parse("0x01"), FieldElement.parse("0x02")];
+const meta = {
+  hash: FieldElement.parse("0x01"),
+  maxFee: FieldElement.parse("0x02"),
+  signature: [FieldElement.parse("0x03")],
+  nonce: FieldElement.parse("0x04"),
+  version: "0",
+};
+
+const invokeV0 = {
+  contractAddress: FieldElement.parse(address),
+  entryPointSelector: FieldElement.parse(entryPointSelector),
+  calldata,
+};
+
+const invokeV1 = {
+  senderAddress: FieldElement.parse(address),
+  calldata,
+};
+
+const deploy = {
+  constructorCalldata: calldata,
+  contractAddressSalt: FieldElement.parse("0x01"),
+  classHash: FieldElement.parse("0x02"),
+};
+
+const declare = {
+  classHash: FieldElement.parse("0x01"),
+  senderAddress: FieldElement.parse(address),
+  compiledClassHash: FieldElement.parse("0x02"),
+};
+
+describe("Block", () => {
+  test("all optional", () => {
+    assertType<Block>({});
+  });
+});
+
+describe("BlockHeader", () => {
+  test("all fields", () => {
+    assertType<BlockHeader>({
+      blockHash: FieldElement.parse("0x01"),
+      parentBlockHash: FieldElement.parse("0x00"),
+      blockNumber: "1",
+      sequencerAddress: FieldElement.parse(address),
+      newRoot: FieldElement.parse("0x02"),
+      timestamp: "1",
+    });
+  });
+});
+
+describe("Transaction", () => {
+  test("only one type", () => {
+    // @ts-expect-error - should be one of the types
+    assertType<Transaction>({
+      meta,
+      invokeV0,
+      invokeV1,
+    });
+  });
+
+  test("invokeV0", () => {
+    assertType<Transaction>({
+      meta,
+      invokeV0,
+    });
+  });
+
+  test("invokeV1", () => {
+    assertType<Transaction>({
+      meta,
+      invokeV1,
+    });
+  });
+
+  test("deploy", () => {
+    assertType<Transaction>({
+      meta,
+      deploy,
+    });
+  });
+
+  test("declare", () => {
+    assertType<Transaction>({
+      meta,
+      declare,
+    });
+  });
+
+  test("l1Handler", () => {
+    assertType<Transaction>({
+      meta,
+      l1Handler: invokeV0,
+    });
+  });
+
+  test("deployAccount", () => {
+    assertType<Transaction>({
+      meta,
+      deployAccount: deploy,
+    });
+  });
+});

package/src/starknet/block.ts

@@ -1,114 +1,193 @@
 import { FieldElement } from "./felt";
 
 export type Block = {
+  /** Block header. */
   header?: BlockHeader;
-  transactions: TransactionWithReceipt[];
-  events: EventWithTransaction[];
-  l2ToL1Messages: L2ToL1MessageWithTransaction[];
-  stateUpdate: StateUpdate;
+  /** Transactions. */
+  transactions?: TransactionWithReceipt[];
+  /** Events. */
+  events?: EventWithTransaction[];
+  /** Messages from L2 to L1. */
+  l2ToL1Messages?: L2ToL1MessageWithTransaction[];
+  /** State update. */
+  stateUpdate?: StateUpdate;
 };
 
 export type BlockHeader = {
+  /** Block hash. */
   blockHash: FieldElement;
+  /** Parent block hash. */
   parentBlockHash: FieldElement;
+  /** Block number. */
   blockNumber: string;
+  /** Sequencer address. */
   sequencerAddress: FieldElement;
+  /** New state root. */
   newRoot: FieldElement;
+  /** Block production timestamp. */
   timestamp: string;
 };
 
 export type TransactionWithReceipt = {
+  /** Transaction. */
   transaction: Transaction;
+  /** Transaction receipt. */
   receipt: TransactionReceipt;
 };
 
 export type EventWithTransaction = {
+  /** Transaction. */
   transaction: Transaction;
+  /** Transaction receipt. */
   receipt: TransactionReceipt;
+  /** Event. */
   event: Event;
 };
 
 export type L2ToL1MessageWithTransaction = {
+  /** Transaction. */
   transaction: Transaction;
+  /** Message from L2 to L1. */
   message: L2ToL1Message;
 };
 
-export type Transaction = {
+export type Transaction = TransactionCommon &
+  (
+    | InvokeTransactionV0
+    | InvokeTransactionV1
+    | DeployTransaction
+    | DeclareTransaction
+    | DeployAccountTransaction
+    | L1HandlerTransaction
+  );
+
+export type TransactionCommon = {
   meta: TransactionMeta;
-} & TransactionBody;
-
-export type TransactionBody =
-  | {
-      invokeV0: InvokeTransactionV0;
-    }
-  | {
-      invokeV1: InvokeTransactionV1;
-    }
-  | {
-      deploy: DeployTransaction;
-    }
-  | {
-      declare: DeclareTransaction;
-    }
-  | {
-      deployAccount: DeployAccountTransaction;
-    }
-  | {
-      l1Handler: L1HandlerTransaction;
-    };
+};
 
 export type TransactionMeta = {
+  /** Transaction hash. */
   hash: FieldElement;
+  /** Maximum fee. */
   maxFee: FieldElement;
+  /** Signature. */
   signature: FieldElement[];
+  /** Nonce. */
   nonce: FieldElement;
+  /** Transaction version. */
   version: string;
 };
 
 export type InvokeTransactionV0 = {
-  contractAddress: FieldElement;
-  entryPointSelector: FieldElement;
-  calldata: FieldElement[];
+  invokeV0?: {
+    /** Target contract address. */
+    contractAddress: FieldElement;
+    /** Selector of the function being invoked. */
+    entryPointSelector: FieldElement;
+    /** Calldata. */
+    calldata: FieldElement[];
+  };
+  invokeV1?: never;
+  deploy?: never;
+  declare?: never;
+  l1Handler?: never;
+  deployAccount?: never;
 };
 
 export type InvokeTransactionV1 = {
-  contractAddress: FieldElement;
-  entryPointSelector: FieldElement;
-  calldata: FieldElement[];
+  invokeV1?: {
+    /** Address of the account sending the transaction. */
+    senderAddress: FieldElement;
+    /** Calldata. */
+    calldata: FieldElement[];
+  };
+  invokeV0?: never;
+  deploy?: never;
+  declare?: never;
+  l1Handler?: never;
+  deployAccount?: never;
 };
 
 export type DeployTransaction = {
-  constructorCalldata: FieldElement[];
-  contractAddressSalt: FieldElement;
-  classHash: FieldElement;
+  deploy?: {
+    /** Constructor calldata. */
+    constructorCalldata: FieldElement[];
+    /** Salt used when computing the contract's address. */
+    contractAddressSalt: FieldElement;
+    /** Hash of the class being deployed. */
+    classHash: FieldElement;
+  };
+  invokeV0?: never;
+  invokeV1?: never;
+  declare?: never;
+  l1Handler?: never;
+  deployAccount?: never;
 };
 
 export type DeclareTransaction = {
-  classHash: FieldElement;
-  senderAddress: FieldElement;
-  compiledClassHash: FieldElement;
+  declare?: {
+    /** Class hash. */
+    classHash: FieldElement;
+    /** Address of the account sending the transaction. */
+    senderAddress: FieldElement;
+    /** Hash of the cairo assembly resulting from the sierra compilation. */
+    compiledClassHash: FieldElement;
+  };
+  invokeV0?: never;
+  invokeV1?: never;
+  deploy?: never;
+  l1Handler?: never;
+  deployAccount?: never;
 };
 
 export type DeployAccountTransaction = {
-  constructorCalldata: FieldElement[];
-  contractAddressSalt: FieldElement;
-  classHash: FieldElement;
+  deployAccount?: {
+    /** Constructor calldata. */
+    constructorCalldata: FieldElement[];
+    /** Salt used when computing the contract's address. */
+    contractAddressSalt: FieldElement;
+    /** Hash of the class being deployed. */
+    classHash: FieldElement;
+  };
+  invokeV0?: never;
+  invokeV1?: never;
+  deploy?: never;
+  declare?: never;
+  l1Handler?: never;
 };
 
 export type L1HandlerTransaction = {
-  contractAddress: FieldElement;
-  entryPointSelector: FieldElement;
-  calldata: FieldElement[];
+  l1Handler?: {
+    /** Target contract address. */
+    contractAddress: FieldElement;
+    /** Selector of the function being invoked. */
+    entryPointSelector: FieldElement;
+    /** Calldata. */
+    calldata: FieldElement[];
+  };
+  invokeV0?: never;
+  invokeV1?: never;
+  deploy?: never;
+  declare?: never;
+  deployAccount?: never;
 };
 
 export type TransactionReceipt = {
+  /** Transaction status. */
   executionStatus: ExecutionStatus;
+  /** Transaction hash. */
   transactionHash: FieldElement;
+  /** Transaction index. */
   transactionIndex: string;
+  /** Actual fee paid by the account. */
   actualFee: FieldElement;
+  /** Address of the contract created by the transaction. */
   contractAddress: FieldElement;
+  /** Messages from L2 to L1. */
   l2ToL1Messages: L2ToL1Message[];
+  /** Events. */
   events: Event[];
+  /** Revert reason. */
   revertReason?: string;
 };
 
@@ -118,64 +197,94 @@ export type ExecutionStatus =
   | "EXECUTION_STATUS_REVERTED";
 
 export type Event = {
+  /** Event index. */
   index: number;
+  /** Contract address. */
   fromAddress: FieldElement;
+  /** Event selector. */
   keys: FieldElement[];
+  /** Event data. */
   data: FieldElement[];
 };
 
 export type L2ToL1Message = {
+  /** Message index. */
   index: number;
+  /** L2 sender address. */
   fromAddress: FieldElement;
+  /** L1 target address. */
   toAddress: FieldElement;
+  /** Calldata. */
   payload: FieldElement[];
 };
 
 export type StateUpdate = {
+  /** New state root. */
   newRoot: FieldElement;
+  /** Old state root. */
   oldRoot: FieldElement;
+  /** State diff. */
   stateDiff: StateDiff;
 };
 
 export type StateDiff = {
+  /** Changes in storage. */
   storageDiffs: StorageDiff[];
+  /** Declared contracts. */
   declaredContracts: DeclaredContract[];
+  /** Deployed contracts. */
   deployedContracts: DeployedContract[];
+  /** Nonce updates. */
   nonces: NonceUpdate[];
+  /** Classes declared. */
   declaredClasses: DeclaredClass[];
+  /** Classes replaced. */
   replacedClasses: ReplacedClass[];
 };
 
 export type StorageDiff = {
+  /** Contract address. */
   contractAddress: FieldElement;
+  /** Changes in storage. */
   storageEntries: StorageEntry[];
 };
 
 export type StorageEntry = {
+  /** Storage key. */
   key: FieldElement;
+  /** New storage value. */
   value: FieldElement;
 };
 
 export type DeclaredContract = {
+  /** Class hash. */
   classHash: FieldElement;
 };
 
 export type DeclaredClass = {
+  /** Class hash. */
   classHash: FieldElement;
+  /** Compiled class hash. */
   compiledClassHash: FieldElement;
 };
 
 export type ReplacedClass = {
+  /** Contract address. */
   contractAddress: FieldElement;
+  /** Class hash. */
   classHash: FieldElement;
 };
 
 export type DeployedContract = {
+  /** Contract address. */
   contractAddress: FieldElement;
+  /** Class hash. */
   classHash: FieldElement;
 };
 
 export type NonceUpdate = {
+  /** Contract address. */
   contractAddress: FieldElement;
+  /** New nonce. */
   nonce: FieldElement;
 };

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 = {