envio 3.0.0-alpha-main-clickhouse-sink → 3.0.0-alpha.1

package/bin.js

@@ -1,8 +1,10 @@
 #!/usr/bin/env node
 //@ts-check
-"use strict";
 
-const { spawnSync } = require("child_process");
+import { spawnSync } from "child_process";
+import { createRequire } from "module";
+
+const require = createRequire(import.meta.url);
 
 /**
  * Returns the executable path for envio located inside node_modules
@@ -15,7 +17,7 @@ const { spawnSync } = require("child_process");
 function getExePath() {
   const arch = process.arch;
   /**
-   * @type string
+   * @type {string}
    */
   let os = process.platform;
   let extension = "";

package/evm.schema.json

@@ -124,6 +124,13 @@
           "type": "null"
         }
       ]
+    },
+    "handlers": {
+      "description": "Optional relative path to handlers directory for auto-loading. Defaults to 'src/handlers' if not specified.",
+      "type": [
+        "string",
+        "null"
+      ]
     }
   },
   "additionalProperties": false,
@@ -153,8 +160,11 @@
           ]
         },
         "handler": {
-          "description": "The relative path to a file where handlers are registered for the given contract",
-          "type": "string"
+          "description": "Optional relative path to a file where handlers are registered for the given contract. If not provided, handlers can be auto-loaded from src directory.",
+          "type": [
+            "string",
+            "null"
+          ]
         },
         "events": {
           "description": "A list of events that should be indexed on this contract",
@@ -167,7 +177,6 @@
       "additionalProperties": false,
       "required": [
         "name",
-        "handler",
         "events"
       ]
     },
@@ -257,7 +266,7 @@
         "accessList",
         "maxFeePerBlobGas",
         "blobVersionedHashes",
-        "kind",
+        "type",
         "l1Fee",
         "l1GasPrice",
         "l1GasUsed",
@@ -567,6 +576,11 @@
           "description": "Use RPC as a backup for the main data-source. Currently, it acts as a fallback when real-time indexing stalls, with potential for more cases in the future.",
           "type": "string",
           "const": "fallback"
+        },
+        {
+          "description": "Use RPC for real-time indexing only. HyperSync will be used for historical sync, then automatically switch to this RPC once synced for lower latency.",
+          "type": "string",
+          "const": "live"
         }
       ]
     },
@@ -611,8 +625,11 @@
           ]
         },
         "handler": {
-          "description": "The relative path to a file where handlers are registered for the given contract",
-          "type": "string"
+          "description": "Optional relative path to a file where handlers are registered for the given contract. If not provided, handlers can be auto-loaded from src directory.",
+          "type": [
+            "string",
+            "null"
+          ]
         },
         "events": {
           "description": "A list of events that should be indexed on this contract",

package/fuel.schema.json

@@ -63,6 +63,13 @@
         "boolean",
         "null"
       ]
+    },
+    "handlers": {
+      "description": "Optional relative path to handlers directory for auto-loading. Defaults to 'src/handlers' if not specified.",
+      "type": [
+        "string",
+        "null"
+      ]
     }
   },
   "additionalProperties": false,
@@ -90,8 +97,11 @@
           "type": "string"
         },
         "handler": {
-          "description": "The relative path to a file where handlers are registered for the given contract",
-          "type": "string"
+          "description": "Optional relative path to a file where handlers are registered for the given contract. If not provided, handlers can be auto-loaded from src directory.",
+          "type": [
+            "string",
+            "null"
+          ]
         },
         "events": {
           "description": "A list of events that should be indexed on this contract",
@@ -105,7 +115,6 @@
       "required": [
         "name",
         "abi_file_path",
-        "handler",
         "events"
       ]
     },
@@ -238,8 +247,11 @@
           "type": "string"
         },
         "handler": {
-          "description": "The relative path to a file where handlers are registered for the given contract",
-          "type": "string"
+          "description": "Optional relative path to a file where handlers are registered for the given contract. If not provided, handlers can be auto-loaded from src directory.",
+          "type": [
+            "string",
+            "null"
+          ]
         },
         "events": {
           "description": "A list of events that should be indexed on this contract",

package/index.d.ts

@@ -101,33 +101,6 @@ export function createEffect<
   handler: (args: EffectArgs<I>) => Promise<R>
 ): Effect<I, O>;
 
-/**
- * @deprecated Use createEffect instead. The only difference is that rateLimit option becomes required. Set it to false to keep the same behaviour.
- */
-export function experimental_createEffect<
-  IS,
-  OS,
-  I = UnknownToOutput<IS>,
-  O = UnknownToOutput<OS>,
-  // A hack to enforce that the inferred return type
-  // matches the output schema type
-  R extends O = O
->(
-  options: {
-    /** The name of the effect. Used for logging and debugging. */
-    readonly name: string;
-    /** The input schema of the effect. */
-    readonly input: IS;
-    /** The output schema of the effect. */
-    readonly output: OS;
-    /** Rate limit for the effect. Set to false to disable or provide {calls: number, per: "second" | "minute"} to enable. */
-    readonly rateLimit?: RateLimit;
-    /** Whether the effect should be cached. */
-    readonly cache?: boolean;
-  },
-  handler: (args: EffectArgs<I>) => Promise<R>
-): Effect<I, O>;
-
 // Important! Should match the index.js file
 export declare namespace S {
   export type Output<T> = Sury.Output<T>;

package/index.js

@@ -2,18 +2,21 @@
 // Some parts like Sury reexport are impossible to implement
 // on the JS side, so we need to do it here
 
-const envioGen = require("./src/Envio.res.js");
-Object.assign(exports, envioGen);
+import * as Sury from "rescript-schema";
+import { schema as bigintSchema } from "./src/bindings/BigInt.res.mjs";
+import { schema as bigDecimalSchema } from "./src/bindings/BigDecimal.res.mjs";
+
+// Re-export everything from envioGen
+export * from "./src/Envio.res.mjs";
 
-const Sury = require("rescript-schema");
 // Important! Should match the index.d.ts file
-exports.S = {
+export const S = {
   string: Sury.string,
   jsonString: Sury.jsonString,
   boolean: Sury.boolean,
   int32: Sury.int32,
   number: Sury.number,
-  bigint: require("./src/bindings/BigInt.res.js").schema,
+  bigint: bigintSchema,
   never: Sury.never,
   union: Sury.union,
   object: Sury.object,
@@ -31,7 +34,7 @@ exports.S = {
   merge: Sury.merge,
   optional: Sury.optional,
   nullable: Sury.nullable,
-  bigDecimal: require("./src/bindings/BigDecimal.res.js").schema,
+  bigDecimal: bigDecimalSchema,
   // Nullish type will change in "sury@10"
   // nullish: Sury.nullish,
   assertOrThrow: Sury.assertOrThrow,

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "envio",
-  "version": "v3.0.0-alpha-main-clickhouse-sink",
+  "version": "v3.0.0-alpha.1",
+  "type": "module",
   "description": "A latency and sync speed optimized, developer friendly blockchain data indexer.",
   "bin": "./bin.js",
   "main": "./index.js",
@@ -24,18 +25,21 @@
     "url": "https://github.com/enviodev/hyperindex/issues"
   },
   "homepage": "https://envio.dev",
+  "engines": {
+    "node": ">=22.0.0"
+  },
   "optionalDependencies": {
-    "envio-linux-x64": "v3.0.0-alpha-main-clickhouse-sink",
-    "envio-linux-arm64": "v3.0.0-alpha-main-clickhouse-sink",
-    "envio-darwin-x64": "v3.0.0-alpha-main-clickhouse-sink",
-    "envio-darwin-arm64": "v3.0.0-alpha-main-clickhouse-sink"
+    "envio-linux-x64": "v3.0.0-alpha.1",
+    "envio-linux-arm64": "v3.0.0-alpha.1",
+    "envio-darwin-x64": "v3.0.0-alpha.1",
+    "envio-darwin-arm64": "v3.0.0-alpha.1"
   },
   "dependencies": {
     "@clickhouse/client": "1.12.1",
-    "@envio-dev/hypersync-client": "0.6.6",
+    "@envio-dev/hypersync-client": "0.7.0",
     "@envio-dev/hyperfuel-client": "1.2.2",
     "rescript": "11.1.3",
-    "rescript-schema": "9.3.0",
+    "rescript-schema": "9.3.4",
     "viem": "2.21.0",
     "bignumber.js": "9.1.2",
     "pino": "8.16.1",

package/rescript.json

@@ -7,16 +7,17 @@
       "subdirs": true
     }
   ],
-  "suffix": ".res.js",
+  "suffix": ".res.mjs",
   "package-specs": {
-    "module": "commonjs",
+    "module": "esmodule",
     "in-source": true
   },
   "gentypeconfig": {
     "shims": {
       "Js": "Js"
     },
-    "generatedFileExtension": ".gen.ts"
+    "generatedFileExtension": ".gen.ts",
+    "moduleResolution": "node16"
   },
   "bs-dependencies": ["rescript-schema"],
   "bsc-flags": ["-open RescriptSchema"]

package/src/{Address.res.js → Address.res.mjs}

@@ -1,9 +1,8 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
-'use strict';
 
-var Viem = require("viem");
-var Js_exn = require("rescript/lib/js/js_exn.js");
-var S$RescriptSchema = require("rescript-schema/src/S.res.js");
+import * as Viem from "viem";
+import * as Js_exn from "rescript/lib/es6/js_exn.js";
+import * as S$RescriptSchema from "rescript-schema/src/S.res.mjs";
 
 var schema = S$RescriptSchema.setName(S$RescriptSchema.string, "Address");
 
@@ -39,6 +38,8 @@ var Evm = {
   fromAddressOrThrow: fromAddressOrThrow
 };
 
-exports.schema = schema;
-exports.Evm = Evm;
+export {
+  schema ,
+  Evm ,
+}
 /* schema Not a pure module */

package/src/{Batch.res.js → Batch.res.mjs}

@@ -1,11 +1,10 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
-'use strict';
 
-var Utils = require("./Utils.res.js");
-var ChainMap = require("./ChainMap.res.js");
-var Belt_Array = require("rescript/lib/js/belt_Array.js");
-var FetchState = require("./FetchState.res.js");
-var ReorgDetection = require("./ReorgDetection.res.js");
+import * as Utils from "./Utils.res.mjs";
+import * as ChainMap from "./ChainMap.res.mjs";
+import * as Belt_Array from "rescript/lib/es6/belt_Array.js";
+import * as FetchState from "./FetchState.res.mjs";
+import * as ReorgDetection from "./ReorgDetection.res.mjs";
 
 function getOrderedNextChain(fetchStates, batchSizePerChain) {
   var earliestChain;
@@ -375,16 +374,18 @@ function findLastEventItem(batch, chainId) {
   return result;
 }
 
-exports.getOrderedNextChain = getOrderedNextChain;
-exports.immutableEmptyBatchSizePerChain = immutableEmptyBatchSizePerChain;
-exports.hasOrderedReadyItem = hasOrderedReadyItem;
-exports.hasUnorderedReadyItem = hasUnorderedReadyItem;
-exports.hasMultichainReadyItem = hasMultichainReadyItem;
-exports.getProgressedChainsById = getProgressedChainsById;
-exports.addReorgCheckpoints = addReorgCheckpoints;
-exports.prepareOrderedBatch = prepareOrderedBatch;
-exports.prepareUnorderedBatch = prepareUnorderedBatch;
-exports.make = make;
-exports.findFirstEventBlockNumber = findFirstEventBlockNumber;
-exports.findLastEventItem = findLastEventItem;
+export {
+  getOrderedNextChain ,
+  immutableEmptyBatchSizePerChain ,
+  hasOrderedReadyItem ,
+  hasUnorderedReadyItem ,
+  hasMultichainReadyItem ,
+  getProgressedChainsById ,
+  addReorgCheckpoints ,
+  prepareOrderedBatch ,
+  prepareUnorderedBatch ,
+  make ,
+  findFirstEventBlockNumber ,
+  findLastEventItem ,
+}
 /* Utils Not a pure module */

package/src/{ChainMap.res.js → ChainMap.res.mjs}

@@ -1,12 +1,11 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
-'use strict';
 
-var Caml = require("rescript/lib/js/caml.js");
-var Js_exn = require("rescript/lib/js/js_exn.js");
-var Belt_Id = require("rescript/lib/js/belt_Id.js");
-var Belt_Map = require("rescript/lib/js/belt_Map.js");
-var Belt_Option = require("rescript/lib/js/belt_Option.js");
-var Caml_option = require("rescript/lib/js/caml_option.js");
+import * as Caml from "rescript/lib/es6/caml.js";
+import * as Js_exn from "rescript/lib/es6/js_exn.js";
+import * as Belt_Id from "rescript/lib/es6/belt_Id.js";
+import * as Belt_Map from "rescript/lib/es6/belt_Map.js";
+import * as Belt_Option from "rescript/lib/es6/belt_Option.js";
+import * as Caml_option from "rescript/lib/es6/caml_option.js";
 
 function toString(chainId) {
   return String(chainId);
@@ -62,16 +61,18 @@ function update(map, chain, updateFn) {
               }));
 }
 
-exports.Chain = Chain;
-exports.fromArrayUnsafe = fromArrayUnsafe;
-exports.get = get;
-exports.set = set;
-exports.values = values;
-exports.keys = keys;
-exports.entries = entries;
-exports.has = has;
-exports.map = map;
-exports.mapWithKey = mapWithKey;
-exports.size = size;
-exports.update = update;
+export {
+  Chain ,
+  fromArrayUnsafe ,
+  get ,
+  set ,
+  values ,
+  keys ,
+  entries ,
+  has ,
+  map ,
+  mapWithKey ,
+  size ,
+  update ,
+}
 /* ChainIdCmp Not a pure module */

package/src/{Config.res.js → Config.res.mjs}

@@ -1,11 +1,10 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
-'use strict';
 
-var Utils = require("./Utils.res.js");
-var Js_exn = require("rescript/lib/js/js_exn.js");
-var ChainMap = require("./ChainMap.res.js");
-var Platform = require("./Platform.res.js");
-var Belt_Array = require("rescript/lib/js/belt_Array.js");
+import * as Utils from "./Utils.res.mjs";
+import * as Js_exn from "rescript/lib/es6/js_exn.js";
+import * as ChainMap from "./ChainMap.res.mjs";
+import * as Platform from "./Platform.res.mjs";
+import * as Belt_Array from "rescript/lib/es6/belt_Array.js";
 
 function make(shouldRollbackOnReorgOpt, shouldSaveFullHistoryOpt, chainsOpt, enableRawEventsOpt, preloadHandlersOpt, ecosystemOpt, batchSizeOpt, lowercaseAddressesOpt, multichainOpt, shouldUseHypersyncClientDecoderOpt, maxAddrInPartitionOpt) {
   var shouldRollbackOnReorg = shouldRollbackOnReorgOpt !== undefined ? shouldRollbackOnReorgOpt : true;
@@ -79,8 +78,10 @@ function getChain(config, chainId) {
   }
 }
 
-exports.make = make;
-exports.shouldSaveHistory = shouldSaveHistory;
-exports.shouldPruneHistory = shouldPruneHistory;
-exports.getChain = getChain;
+export {
+  make ,
+  shouldSaveHistory ,
+  shouldPruneHistory ,
+  getChain ,
+}
 /* Utils Not a pure module */

package/src/Envio.gen.ts

@@ -9,9 +9,9 @@ import type {Effect as $$effect} from './Types.ts';
 
 import type {Logger as $$logger} from './Types.ts';
 
-import type {S_t as RescriptSchema_S_t} from 'rescript-schema/RescriptSchema.gen';
+import type {S_t as RescriptSchema_S_t} from 'rescript-schema/RescriptSchema.gen.js';
 
-export type blockEvent = { readonly number: number; readonly chainId: number };
+export type blockEvent = { readonly number: number };
 
 export type fuelBlockEvent = { readonly height: number; readonly chainId: number };
 
@@ -35,19 +35,6 @@ export type rateLimit =
     false
   | { readonly calls: number; readonly per: rateLimitDuration };
 
-export type experimental_effectOptions<input,output> = {
-  /** The name of the effect. Used for logging and debugging. */
-  readonly name: string; 
-  /** The input schema of the effect. */
-  readonly input: RescriptSchema_S_t<input>; 
-  /** The output schema of the effect. */
-  readonly output: RescriptSchema_S_t<output>; 
-  /** Rate limit for the effect. Set to false to disable or provide {calls: number, per: "second" | "minute"} to enable. */
-  readonly rateLimit?: rateLimit; 
-  /** Whether the effect should be cached. */
-  readonly cache?: boolean
-};
-
 export type effectOptions<input,output> = {
   /** The name of the effect. Used for logging and debugging. */
   readonly name: string; 

package/src/Envio.res

@@ -6,7 +6,6 @@
 @genType
 type blockEvent = {
   number: int,
-  chainId: int,
 }
 
 // Fuel block event with 'height' field
@@ -53,19 +52,6 @@ and rateLimit =
   | @as(false) Disable
   | Enable({calls: int, per: rateLimitDuration})
 @genType
-and experimental_effectOptions<'input, 'output> = {
-  /** The name of the effect. Used for logging and debugging. */
-  name: string,
-  /** The input schema of the effect. */
-  input: S.t<'input>,
-  /** The output schema of the effect. */
-  output: S.t<'output>,
-  /** Rate limit for the effect. Set to false to disable or provide {calls: number, per: "second" | "minute"} to enable. */
-  rateLimit?: rateLimit,
-  /** Whether the effect should be cached. */
-  cache?: bool,
-}
-@genType
 and effectOptions<'input, 'output> = {
   /** The name of the effect. Used for logging and debugging. */
   name: string,
@@ -148,25 +134,3 @@ let createEffect = (
     },
   }->(Utils.magic: Internal.effect => effect<'input, 'output>)
 }
-
-@deprecated(
-  "Use createEffect instead. The only difference is that rateLimit option becomes required. Set it to false to keep the same behaviour."
-)
-let experimental_createEffect = (
-  options: experimental_effectOptions<'input, 'output>,
-  handler: effectArgs<'input> => promise<'output>,
-) => {
-  createEffect(
-    {
-      name: options.name,
-      input: options.input,
-      output: options.output,
-      rateLimit: switch options.rateLimit {
-      | Some(rateLimit) => rateLimit
-      | None => Disable
-      },
-      cache: ?options.cache,
-    },
-    handler,
-  )
-}

package/src/{Envio.res.js → Envio.res.mjs}

@@ -1,8 +1,7 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
-'use strict';
 
-var Internal = require("./Internal.res.js");
-var S$RescriptSchema = require("rescript-schema/src/S.res.js");
+import * as Internal from "./Internal.res.mjs";
+import * as S$RescriptSchema from "rescript-schema/src/S.res.mjs";
 
 function durationToMs(duration) {
   if (typeof duration !== "number") {
@@ -61,18 +60,8 @@ function createEffect(options, handler) {
         };
 }
 
-function experimental_createEffect(options, handler) {
-  var rateLimit = options.rateLimit;
-  return createEffect({
-              name: options.name,
-              input: options.input,
-              output: options.output,
-              rateLimit: rateLimit !== undefined ? rateLimit : false,
-              cache: options.cache
-            }, handler);
+export {
+  durationToMs ,
+  createEffect ,
 }
-
-exports.durationToMs = durationToMs;
-exports.createEffect = createEffect;
-exports.experimental_createEffect = experimental_createEffect;
 /* Internal Not a pure module */

package/src/{ErrorHandling.res.js → ErrorHandling.res.mjs}

@@ -1,8 +1,7 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
-'use strict';
 
-var Utils = require("./Utils.res.js");
-var Logging = require("./Logging.res.js");
+import * as Utils from "./Utils.res.mjs";
+import * as Logging from "./Logging.res.mjs";
 
 function make(exn, loggerOpt, msg) {
   var logger = loggerOpt !== undefined ? loggerOpt : Logging.getLogger();
@@ -47,10 +46,12 @@ function logAndRaise(self) {
   throw Utils.prettifyExn(self.exn);
 }
 
-exports.make = make;
-exports.log = log;
-exports.raiseExn = raiseExn;
-exports.mkLogAndRaise = mkLogAndRaise;
-exports.unwrapLogAndRaise = unwrapLogAndRaise;
-exports.logAndRaise = logAndRaise;
+export {
+  make ,
+  log ,
+  raiseExn ,
+  mkLogAndRaise ,
+  unwrapLogAndRaise ,
+  logAndRaise ,
+}
 /* Utils Not a pure module */

package/src/EventRegister.res

@@ -68,6 +68,13 @@ let finishRegistration = () => {
   }
 }
 
+let isPendingRegistration = () => {
+  switch activeRegistration.contents {
+  | Some(r) => !r.finished
+  | None => false
+  }
+}
+
 let onBlockOptionsSchema = S.schema(s =>
   {
     "name": s.matches(S.string),

package/src/{EventRegister.res.js → EventRegister.res.mjs}

@@ -1,12 +1,11 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
-'use strict';
 
-var Js_exn = require("rescript/lib/js/js_exn.js");
-var Logging = require("./Logging.res.js");
-var Belt_Option = require("rescript/lib/js/belt_Option.js");
-var ErrorHandling = require("./ErrorHandling.res.js");
-var Caml_exceptions = require("rescript/lib/js/caml_exceptions.js");
-var S$RescriptSchema = require("rescript-schema/src/S.res.js");
+import * as Js_exn from "rescript/lib/es6/js_exn.js";
+import * as Logging from "./Logging.res.mjs";
+import * as Belt_Option from "rescript/lib/es6/belt_Option.js";
+import * as ErrorHandling from "./ErrorHandling.res.mjs";
+import * as Caml_exceptions from "rescript/lib/es6/caml_exceptions.js";
+import * as S$RescriptSchema from "rescript-schema/src/S.res.mjs";
 
 var activeRegistration = {
   contents: undefined
@@ -59,6 +58,15 @@ function finishRegistration() {
   }
 }
 
+function isPendingRegistration() {
+  var r = activeRegistration.contents;
+  if (r !== undefined) {
+    return !r.finished;
+  } else {
+    return false;
+  }
+}
+
 var onBlockOptionsSchema = S$RescriptSchema.schema(function (s) {
       return {
               name: s.m(S$RescriptSchema.string),
@@ -221,15 +229,18 @@ function setContractRegister(t, contractRegister, eventOptions, loggerOpt) {
       });
 }
 
-exports.startRegistration = startRegistration;
-exports.finishRegistration = finishRegistration;
-exports.make = make;
-exports.setHandler = setHandler;
-exports.setContractRegister = setContractRegister;
-exports.getHandler = getHandler;
-exports.getContractRegister = getContractRegister;
-exports.getEventFilters = getEventFilters;
-exports.isWildcard = isWildcard;
-exports.hasRegistration = hasRegistration;
-exports.onBlock = onBlock;
+export {
+  startRegistration ,
+  isPendingRegistration ,
+  finishRegistration ,
+  make ,
+  setHandler ,
+  setContractRegister ,
+  getHandler ,
+  getContractRegister ,
+  getEventFilters ,
+  isWildcard ,
+  hasRegistration ,
+  onBlock ,
+}
 /* onBlockOptionsSchema Not a pure module */