@apibara/indexer 0.1.0 → 0.1.2

package/dist/config.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=config.js.map

package/dist/index.js

@@ -1,18 +1,2 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./config"), exports);
+export * from './config';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA"}

package/dist/sink/console.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=console.js.map

package/dist/sink/mongo.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=mongo.js.map

package/dist/sink/parquet.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=parquet.js.map

package/dist/sink/postgres.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=postgres.js.map

package/dist/sink/webhook.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=webhook.js.map

package/dist/starknet/block.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=block.js.map

package/dist/starknet/filter.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=filter.js.map

package/dist/starknet/index.js

@@ -1,19 +1,3 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./filter"), exports);
-__exportStar(require("./block"), exports);
+export * from './filter';
+export * from './block';
 //# 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,2CAAwB;AACxB,0CAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/starknet/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA"}

package/package.json

@@ -1,17 +1,48 @@
 {
   "name": "@apibara/indexer",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "type": "module",
   "exports": {
-    ".": "./dist/index.js",
-    "./sink/console": "./dist/sink/console.js",
-    "./sink/mongo": "./dist/sink/mongo.js",
-    "./sink/parquet": "./dist/sink/parquet.js",
-    "./sink/postgres": "./dist/sink/postgres.js",
-    "./sink/webhook": "./dist/sink/webhook.js",
-    "./starknet": "./dist/starknet/index.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./sink/console": {
+      "types": "./dist/sink/console.d.ts",
+      "import": "./dist/sink/console.js",
+      "default": "./dist/sink/console.js"
+    },
+    "./sink/mongo": {
+      "types": "./dist/sink/mongo.d.ts",
+      "import": "./dist/sink/mongo.js",
+      "default": "./dist/sink/mongo.js"
+    },
+    "./sink/parquet": {
+      "types": "./dist/sink/parquet.d.ts",
+      "import": "./dist/sink/parquet.js",
+      "default": "./dist/sink/parquet.js"
+    },
+    "./sink/postgres": {
+      "types": "./dist/sink/postgres.d.ts",
+      "import": "./dist/sink/postgres.js",
+      "default": "./dist/sink/postgres.js"
+    },
+    "./sink/webhook": {
+      "types": "./dist/sink/webhook.d.ts",
+      "import": "./dist/sink/webhook.js",
+      "default": "./dist/sink/webhook.js"
+    },
+    "./starknet": {
+      "types": "./dist/starknet/index.d.ts",
+      "import": "./dist/starknet/index.js",
+      "default": "./dist/starknet/index.js"
+    }
   },
   "files": [
-    "dist"
+    "dist",
+    "src",
+    "README.md"
   ],
   "scripts": {
     "build": "tsc"

package/src/config.ts

@@ -0,0 +1,40 @@
+/** Sink-related options. */
+export type SinkOptions = {
+  /** Sink type. */
+  sinkType: string;
+  /** Sink options. */
+  sinkOptions: object;
+}
+
+/** Network-specific options. */
+export type NetworkOptions = {
+  /** Network name. */
+  network: string;
+  /** Data filter. */
+  filter: object;
+}
+
+/** Data finality. */
+export type Finality = 'DATA_STATUS_FINALIZED' | 'DATA_STATUS_ACCEPTED' | 'DATA_STATUS_PENDING';
+
+/** Stream-related options. */
+export type StreamOptions = {
+  /** The Apibara DNA stream url, e.g. `mainnet.starknet.a5a.ch`. */
+  streamUrl?: string;
+  /** Maximum message size, e.g. `50Mb` */
+  maxMessageSize?: string;
+  /** Additional metadata to send when connecting to the stream, in `key: value` form. */
+  metadata?: string[];
+  /** The Apibara DNA stream auth token. */
+  authToken?: string;
+}
+
+export type Config<TNetworkOptions extends NetworkOptions, TSink extends SinkOptions> = TSink & TNetworkOptions & StreamOptions & {
+  /** How many historical blocks to process in a single batch. */
+  batchSize?: number;
+  /** Finality of the data to process. */
+  finality?: Finality;
+  /** Start streaming data from this block. */
+  startingBlock?: number;
+}
+

package/src/index.ts

@@ -0,0 +1 @@
+export * from './config'

package/src/sink/console.ts

@@ -0,0 +1,11 @@
+/** Console sink type. */
+export type Console = {
+  sinkType: 'console';
+
+  /** Accept any options.
+   *
+   * @remarks We do this so that users can quickly switch to the console sink to debug,
+   * without having to remove the options from the config file.
+   */
+  sinkOptions: object;
+}

package/src/sink/mongo.ts

@@ -0,0 +1,12 @@
+/** MongoDB sink options */
+export type Mongo = {
+  sinkType: 'mongo';
+  sinkOptions: {
+    /** MongoDB connection string. */
+    connectionString?: string;
+    /** Target database name. */
+    database?: string;
+    /** Target collection name. */
+    collectionName?: string;
+  }
+}

package/src/sink/parquet.ts

@@ -0,0 +1,9 @@
+export type Parquet = {
+  sinkType: 'parquet';
+  sinkOptions: {
+    /** Target output directory. */
+    outputDir?: string;
+    /** How many blocks to include in each file. */
+    batchSize?: number;
+  }
+}

package/src/sink/postgres.ts

@@ -0,0 +1,10 @@
+/** PostgreSQL sink options. */
+export type Postgres = {
+  sinkType: 'postgres';
+  sinkOptions: {
+    /** Postgres connection string. */
+    connectionString?: string;
+    /** Target table name. */
+    tableName?: string;
+  }
+}

package/src/sink/webhook.ts

@@ -0,0 +1,13 @@
+/** Webhook sink options */
+export type Webhook = {
+  sinkType: 'webhook';
+  sinkOptions: {
+    /** Target URL. */
+    targetUrl?: string;
+    /** Additional headers to send with the request, `key: value` format. */
+    header?: string[];
+    /** Send the data returned from the transform function as the request body. */
+    raw?: boolean;
+  }
+}
+

package/src/starknet/block.ts

@@ -0,0 +1,172 @@
+export type FieldElement = `0x${string}`
+
+export type Block = {
+  header?: BlockHeader;
+  transactions: TransactionWithReceipt[];
+  events: EventWithTransaction[];
+  l2ToL1Messages: L2ToL1MessageWithTransaction[];
+  stateUpdate: StateUpdate;
+}
+
+export type BlockHeader = {
+  blockHash: FieldElement;
+  parentBlockHash: FieldElement;
+  blockNumber: string;
+  sequencerAddress: FieldElement;
+  newRoot: FieldElement;
+  timestamp: string;
+}
+
+export type TransactionWithReceipt = {
+  transaction: Transaction;
+  receipt: TransactionReceipt;
+}
+
+export type EventWithTransaction = {
+  transaction: Transaction;
+  receipt: TransactionReceipt;
+  event: Event;
+}
+
+export type L2ToL1MessageWithTransaction = {
+  transaction: Transaction;
+  message: L2ToL1Message;
+}
+
+export type Transaction = {
+  meta: TransactionMeta;
+} & TransactionBody
+
+export type TransactionBody = {
+  invokeV0: InvokeTransactionV0
+} | {
+  invokeV1: InvokeTransactionV1
+} | {
+  deploy: DeployTransaction
+} | {
+  declare: DeclareTransaction
+} | {
+  deployAccount: DeployAccountTransaction
+} | {
+  l1Handler: L1HandlerTransaction
+}
+
+export type TransactionMeta = {
+  hash: FieldElement;
+  maxFee: FieldElement;
+  signature: FieldElement[];
+  nonce: FieldElement;
+  version: string;
+}
+
+export type InvokeTransactionV0 = {
+  contractAddress: FieldElement;
+  entryPointSelector: FieldElement;
+  calldata: FieldElement[];
+}
+
+export type InvokeTransactionV1 = {
+  contractAddress: FieldElement;
+  entryPointSelector: FieldElement;
+  calldata: FieldElement[];
+}
+
+export type DeployTransaction = {
+  constructorCalldata: FieldElement[];
+  contractAddressSalt: FieldElement;
+  classHash: FieldElement;
+}
+
+export type DeclareTransaction = {
+  classHash: FieldElement;
+  senderAddress: FieldElement;
+  compiledClassHash: FieldElement;
+}
+
+export type DeployAccountTransaction = {
+  constructorCalldata: FieldElement[];
+  contractAddressSalt: FieldElement;
+  classHash: FieldElement;
+}
+
+export type L1HandlerTransaction = {
+  contractAddress: FieldElement;
+  entryPointSelector: FieldElement;
+  calldata: FieldElement[];
+}
+
+export type TransactionReceipt = {
+  executionStatus: ExecutionStatus;
+  transactionHash: FieldElement;
+  transactionIndex: string;
+  actualFee: FieldElement;
+  contractAddress: FieldElement;
+  l2ToL1Messages: L2ToL1Message[];
+  events: Event[];
+  revertReason?: string;
+}
+
+export type ExecutionStatus = "EXECUTION_STATUS_UNSPECIFIED" | "EXECUTION_STATUS_SUCCEEDED" | "EXECUTION_STATUS_REVERTED"
+
+export type Event = {
+  index: number;
+  fromAddress: FieldElement;
+  keys: FieldElement[];
+  data: FieldElement[];
+}
+
+export type L2ToL1Message = {
+  index: number;
+  fromAddress: FieldElement;
+  toAddress: FieldElement;
+  payload: FieldElement[];
+}
+
+export type StateUpdate = {
+  newRoot: FieldElement;
+  oldRoot: FieldElement;
+  stateDiff: StateDiff;
+}
+
+export type StateDiff = {
+  storageDiffs: StorageDiff[];
+  declaredContracts: DeclaredContract[];
+  deployedContracts: DeployedContract[];
+  nonces: NonceUpdate[];
+  declaredClasses: DeclaredClass[];
+  replacedClasses: ReplacedClass[];
+}
+
+export type StorageDiff = {
+  contractAddress: FieldElement;
+  storageEntries: StorageEntry[];
+}
+
+export type StorageEntry = {
+  key: FieldElement;
+  value: FieldElement;
+}
+
+export type DeclaredContract = {
+  classHash: FieldElement;
+}
+
+export type DeclaredClass = {
+  classHash: FieldElement;
+  compiledClassHash: FieldElement;
+}
+
+export type ReplacedClass = {
+  contractAddress: FieldElement;
+  classHash: FieldElement;
+}
+
+export type DeployedContract = {
+  contractAddress: FieldElement;
+  classHash: FieldElement;
+}
+
+export type NonceUpdate = {
+  contractAddress: FieldElement;
+  nonce: FieldElement;
+}

package/src/starknet/filter.ts

@@ -0,0 +1,2 @@
+export type Filter = {
+}

package/src/starknet/index.ts

@@ -0,0 +1,10 @@
+export * from './filter'
+export * from './block'
+
+import { Filter } from './filter'
+
+/** Starknet network type and data filter. */
+export type Starknet = {
+  network: 'starknet';
+  filter: Filter;
+}