accounts + native transfers

packages/core/src/config/config.test-d.ts

@@ -301,3 +301,24 @@ test("createConfig strict return type", () => {
     };
   }>(config.contracts);
 });
+
+test("createConfig accounts", () => {
+  createConfig({
+    networks: {
+      mainnet: {
+        chainId: 1,
+        transport: http(),
+      },
+      optimism: {
+        chainId: 10,
+        transport: http(),
+      },
+    },
+    accounts: {
+      me: {
+        network: "mainnet",
+        address: ["0x"],
+      },
+    },
+  });
+});

packages/core/src/config/config.ts

@@ -5,13 +5,39 @@ import type { GetAddress } from "./address.js";
 import type { GetEventFilter } from "./eventFilter.js";
 import type { NonStrictPick } from "./utilityTypes.js";
 
-export type BlockConfig = {
-  /** Block number at which to start indexing events (inclusive). If `undefined`, events will be processed from block 0. Default: `undefined`. */
-  startBlock?: number;
-  /** Block number at which to stop indexing events (inclusive). If `undefined`, events will be processed in real-time. Default: `undefined`. */
-  endBlock?: number;
+export type Config = {
+  networks: { [networkName: string]: NetworkConfig<unknown> };
+  contracts: { [contractName: string]: GetContract };
+  database?: DatabaseConfig;
+  blocks: {
+    [sourceName: string]: GetBlockFilter<unknown>;
+  };
 };
 
+export type CreateConfigReturnType<networks, contracts, blocks> = {
+  networks: networks;
+  contracts: contracts;
+  database?: DatabaseConfig;
+  blocks: blocks;
+};
+
+export const createConfig = <
+  const networks,
+  const contracts = {},
+  const accounts = {},
+  const blocks = {},
+>(config: {
+  database?: DatabaseConfig;
+  // TODO: add jsdoc to these properties.
+  networks: NetworksConfig<Narrow<networks>>;
+  contracts?: ContractsConfig<networks, Narrow<contracts>>;
+  accounts?: AccountsConfig<networks, Narrow<accounts>>;
+  blocks?: BlockFiltersConfig<networks, blocks>;
+}): CreateConfigReturnType<networks, contracts, blocks> =>
+  config as Prettify<CreateConfigReturnType<networks, contracts, blocks>>;
+
+// database
+
 type DatabaseConfig =
   | {
       kind: "pglite";
@@ -29,7 +55,32 @@ type DatabaseConfig =
       };
     };
 
-export type NetworkConfig<network> = {
+// base
+
+type BlockConfig = {
+  /** Block number at which to start indexing events (inclusive). If `undefined`, events will be processed from block 0. Default: `undefined`. */
+  startBlock?: number;
+  /** Block number at which to stop indexing events (inclusive). If `undefined`, events will be processed in real-time. Default: `undefined`. */
+  endBlock?: number;
+};
+
+type TransactionReceiptConfig = {
+  includeTransactionReceipts?: boolean;
+};
+
+type FunctionCallConfig = {
+  /*
+   * Enable call trace indexing for this contract.
+   *
+   * - Docs: https://ponder.sh/docs/indexing/call-traces
+   */
+
+  includeCallTraces?: boolean;
+};
+
+// network
+
+type NetworkConfig<network> = {
   /** Chain ID of the network. */
   chainId: network extends { chainId: infer chainId extends number }
     ? chainId | number
@@ -57,47 +108,6 @@ export type NetworkConfig<network> = {
   disableCache?: boolean;
 };
 
-export type BlockFilterConfig = {
-  /** Block number at which to start indexing events (inclusive). If `undefined`, events will be processed from block 0. Default: `undefined`. */
-  startBlock?: number;
-  /** Block number at which to stop indexing events (inclusive). If `undefined`, events will be processed in real-time. Default: `undefined`. */
-  endBlock?: number;
-  interval?: number;
-};
-
-type GetBlockFilter<
-  networks,
-  ///
-  allNetworkNames extends string = [keyof networks] extends [never]
-    ? string
-    : keyof networks & string,
-> = BlockFilterConfig & {
-  network:
-    | allNetworkNames
-    | {
-        [name in allNetworkNames]?: BlockFilterConfig;
-      };
-};
-
-type AbiConfig<abi extends Abi | readonly unknown[]> = {
-  /** Contract application byte interface. */
-  abi: abi;
-};
-
-type TransactionReceiptConfig = {
-  includeTransactionReceipts?: boolean;
-};
-
-type FunctionCallConfig = {
-  /*
-   * Enable call trace indexing for this contract.
-   *
-   * - Docs: https://ponder.sh/docs/indexing/call-traces
-   */
-
-  includeCallTraces?: boolean;
-};
-
 type GetNetwork<
   networks,
   contract,
@@ -144,6 +154,19 @@ type GetNetwork<
           };
     };
 
+type NetworksConfig<networks> = {} extends networks
+  ? {}
+  : {
+      [networkName in keyof networks]: NetworkConfig<networks[networkName]>;
+    };
+
+// contracts
+
+type AbiConfig<abi extends Abi | readonly unknown[]> = {
+  /** Contract application byte interface. */
+  abi: abi;
+};
+
 type ContractConfig<networks, contract, abi extends Abi> = Prettify<
   AbiConfig<abi> &
     GetNetwork<networks, NonStrictPick<contract, "network">, abi> &
@@ -169,12 +192,45 @@ type ContractsConfig<networks, contracts> = {} extends contracts
       [name in keyof contracts]: GetContract<networks, contracts[name]>;
     };
 
-type NetworksConfig<networks> = {} extends networks
+// accounts
+
+type AccountConfig<networks, account> = Prettify<
+  GetNetwork<networks, NonStrictPick<account, "network">, Abi> &
+    GetAddress<NonStrictPick<account, "address" | "factory">> &
+    TransactionReceiptConfig &
+    BlockConfig
+>;
+
+type AccountsConfig<networks, accounts> = {} extends accounts
   ? {}
   : {
-      [networkName in keyof networks]: NetworkConfig<networks[networkName]>;
+      [name in keyof accounts]: AccountConfig<networks, accounts[name]>;
     };
 
+// blocks
+
+type BlockFilterConfig = {
+  /** Block number at which to start indexing events (inclusive). If `undefined`, events will be processed from block 0. Default: `undefined`. */
+  startBlock?: number;
+  /** Block number at which to stop indexing events (inclusive). If `undefined`, events will be processed in real-time. Default: `undefined`. */
+  endBlock?: number;
+  interval?: number;
+};
+
+type GetBlockFilter<
+  networks,
+  ///
+  allNetworkNames extends string = [keyof networks] extends [never]
+    ? string
+    : keyof networks & string,
+> = BlockFilterConfig & {
+  network:
+    | allNetworkNames
+    | {
+        [name in allNetworkNames]?: BlockFilterConfig;
+      };
+};
+
 type BlockFiltersConfig<
   networks = unknown,
   blocks = unknown,
@@ -183,32 +239,3 @@ type BlockFiltersConfig<
   : {
       [name in keyof blocks]: GetBlockFilter<networks>;
     };
-
-export const createConfig = <
-  const networks,
-  const contracts = {},
-  const blocks = {},
->(config: {
-  // TODO: add jsdoc to these properties.
-  networks: NetworksConfig<Narrow<networks>>;
-  contracts?: ContractsConfig<networks, Narrow<contracts>>;
-  database?: DatabaseConfig;
-  blocks?: BlockFiltersConfig<networks, blocks>;
-}): CreateConfigReturnType<networks, contracts, blocks> =>
-  config as Prettify<CreateConfigReturnType<networks, contracts, blocks>>;
-
-export type Config = {
-  networks: { [networkName: string]: NetworkConfig<unknown> };
-  contracts: { [contractName: string]: GetContract };
-  database?: DatabaseConfig;
-  blocks: {
-    [sourceName: string]: GetBlockFilter<unknown>;
-  };
-};
-
-export type CreateConfigReturnType<networks, contracts, blocks> = {
-  networks: networks;
-  contracts: contracts;
-  database?: DatabaseConfig;
-  blocks: blocks;
-};