envio 3.0.0-alpha.19-main-node-pg-client → 3.0.0-alpha.20

package/README.md

@@ -1,45 +1,179 @@
-# HyperIndex: Ultra-Fast Multichain Indexer
+<div align="center">
+  <h1>HyperIndex: Ultra-Fast Multichain Indexer</h1>
+  <p><strong>The fastest independently benchmarked multichain blockchain indexer.</strong></p>
+  <p>
+    <a href="https://github.com/enviodev/hyperindex/releases"><img src="https://img.shields.io/github/release/enviodev/hyperindex.svg" alt="GitHub release" /></a>
+    <a href="https://github.com/enviodev/hyperindex/issues"><img src="https://img.shields.io/github/issues/enviodev/hyperindex.svg" alt="GitHub issues" /></a>
+    <a href="https://github.com/enviodev/hyperindex/graphs/contributors"><img src="https://img.shields.io/github/contributors/enviodev/hyperindex.svg" alt="GitHub contributors" /></a>
+    <a href="https://discord.gg/DhfFhzuJQh"><img src="https://img.shields.io/badge/Discord-Join%20Chat-7289da?logo=discord&logoColor=white" alt="Discord" /></a>
+    <a href="https://github.com/enviodev/hyperindex/stargazers"><img src="https://img.shields.io/github/stars/enviodev/hyperindex.svg" alt="GitHub stars" /></a>
+  </p>
+  <p>
+    <a href="https://docs.envio.dev">Documentation</a> ·
+    <a href="https://envio.dev">Hosted Service</a> ·
+    <a href="https://discord.gg/DhfFhzuJQh">Discord</a> ·
+    <a href="https://docs.envio.dev/blog/best-blockchain-indexers-2026">Benchmarks</a>
+  </p>
+</div>
 
-[![GitHub release](https://img.shields.io/github/release/enviodev/hyperindex.svg)](https://github.com/enviodev/hyperindex/releases) [![GitHub issues](https://img.shields.io/github/issues/enviodev/hyperindex.svg)](https://github.com/enviodev/hyperindex/issues) [![GitHub contributors](https://img.shields.io/github/contributors/enviodev/hyperindex.svg)](https://github.com/enviodev/hyperindex/graphs/contributors) [![Discord](https://img.shields.io/badge/Discord-Join%20Chat-7289da?logo=discord&logoColor=white)](https://discord.gg/DhfFhzuJQh) [![GitHub stars](https://img.shields.io/github/stars/enviodev/hyperindex.svg)](https://github.com/enviodev/hyperindex/stargazers)
+---
+## What is HyperIndex?
 
-HyperIndex is a fast, developer-friendly multichain indexer, optimized for both local development and reliable hosted deployment. It empowers developers to effortlessly build robust backends for blockchain applications.
+HyperIndex is Envio's full-featured blockchain indexing framework. It transforms onchain events into structured, queryable databases with GraphQL APIs, built for developers who care about performance and a clean local experience.
 
-> For comprehensive documentation, visit our [Documentation Portal](https://docs.envio.dev).
-> For hosted services and other solutions, visit [envio.dev](https://envio.dev).
+Powered by [HyperSync](https://docs.envio.dev/docs/HyperSync/overview), Envio's proprietary data engine, HyperIndex delivers up to 2000x faster data access than traditional RPC endpoints. That's the difference between syncing in minutes instead of days.
 
-![Envio Sync Gif](./sync.gif)
+![Envio Sync](sync.gif)
+
+---
+
+## Why HyperIndex?
+
+Most blockchain indexers are bottlenecked by RPC. HyperIndex isn't. HyperSync, the data engine underneath, is a purpose-built, Rust-based query layer that retrieves multiple blocks per round trip, cuts out the overhead, and makes historical backfills genuinely fast.
+
+Independent benchmarks run by Sentio confirm it:
+
+- **Uniswap V2 Factory** (May 2025): HyperIndex completed in 1 minute. 15x faster than the nearest competitor (Subsquid), 143x faster than The Graph, 158x faster than Ponder
+- **LBTC Token with RPC calls** (April 2025): HyperIndex completed in 3 minutes vs 3 hours 9 minutes for The Graph
+
+[View full benchmark results →](https://docs.envio.dev/docs/HyperIndex/benchmarks)
+
+---
+
+## What you can build?
+ 
+HyperIndex and HyperSync are the data layer for DeFi dashboards, protocol analytics, block explorers, stablecoin monitors, liquidation trackers, oracle comparisons, NFT explorers, and any application that needs fast, structured onchain data.
+ 
+A few things already running in production:
+ 
+- [v4.xyz](https://v4.xyz): the hub for Uniswap V4 data and analytics, indexing across 10 chains in real-time
+- [Stable Volume](https://www.stablevolume.com/): real-time stablecoin transaction monitoring across 10+ chains
+- [Stable Radar](https://stable-radar.com): real-time USDC transaction dashboard across multiple chains
+- [Liqo](https://liqo.xyz): multichain liquidation tracking for DeFi lending protocols
+- [Safe Stats](https://safe-stats.vercel.app/): real-time analytics for Safe multisig activity across all chains
+- [Oracle Wars](https://oraclewars.xyz/): real-time oracle price comparison across multiple oracles
+- [Chain Density](https://chaindensity.xyz/): transaction and event density analysis for any address across 70+ chains
+- [LogTUI](https://www.npmjs.com/package/logtui): terminal UI for monitoring blockchain events in real-time
+ 
+[See the full showcase →](https://docs.envio.dev/showcase)
+
+---
 
 ## Key Features
 
-- **[Indexer auto-generation](https://docs.envio.dev/docs/HyperIndex/contract-import)** – Generate Indexers directly from smart contract addresses
-- **High performance** – Historical backfills at over 25,000+ events per second ([fastest in market](https://docs.envio.dev/blog/indexer-benchmarking-results))
-- **Local development** – Full-featured local environment with Docker
-- **[Multichain indexing](https://docs.envio.dev/docs/HyperIndex/multichain-indexing)** – Index any EVM-, SVM-, or Fuel-compatible blockchain
-- **Real-time indexing** – Instantly track blockchain events
-- **[Reorg support](https://docs.envio.dev/docs/HyperIndex/reorgs-support)** – Graceful handling of blockchain reorganizations
-- **GraphQL API** – Easy-to-query indexed data
-- **Flexible language support** – TypeScript, JavaScript, and ReScript
-- **Factory contract support** – Index data from 1M+ dynamically registered contracts seamlessly
-- **On-chain & off-chain data integration** – Easily combine multiple data sources
-- **[Self-hosted & managed options](https://docs.envio.dev/docs/HyperIndex/hosted-service)** – Run your own setup or use HyperIndex hosted services
-- **Detailed logging & error reporting** – Debug and optimize with clarity
-- **External API actions** – Trigger external services based on blockchain events
-- **[Wildcard topic indexing](https://docs.envio.dev/docs/HyperIndex/wildcard-indexing)** – Flexible indexing based on event topics
-- **Fallback RPC data sources** – Enhanced reliability with RPC connections
+**Performance**
+- Historical backfills at 10,000+ events per second
+- Up to 2000x faster than traditional RPC via HyperSync (enabled by default, no config required)
+- Sync times reduced from days to minutes
+- Fallback RPC support for reliability without touching your indexer code
+
+**Multichain indexing**
+- Index EVM, SVM, and Fuel blockchains from a single indexer
+- 70+ EVM chains with native HyperSync support, plus any EVM chain via RPC
+- Unordered multichain mode for maximum throughput across chains
+- Real-time indexing with reorg handling built in
+
+**Developer experience**
+- Auto-generate an indexer directly from a smart contract address or ABI, no manual setup required
+- Write handlers in TypeScript, JavaScript, or ReScript
+- Full local development environment with Docker
+- GraphQL API generated automatically from your schema
+- Wildcard topic indexing: index by event signatures across any contract, not just specified addresses
+- Factory contract support for 1M+ dynamically registered contracts
+- Onchain and off-chain data integration
+- External API actions triggered by blockchain events
+- Detailed logging and error reporting
+
+**Deployment**
+- Managed [hosted service](https://docs.envio.dev/docs/HyperIndex/hosted-service) with static endpoints, built-in alerts, and production-ready infrastructure
+- Self-hosted via Docker
+- No vendor lock-in. Switch between HyperSync and RPC at any time
+
+**Agentic development**
+- HyperIndex is the default indexing framework for AI-assisted and agentic workflows via Envio's hosted service CLI (`envio-cloud`) and Claude skills
+- An agent can scaffold, configure, and deploy a production-ready indexer without touching a config file. [400,000 events indexed in ~20 seconds](https://docs.envio.dev/blog/agentic-blockchain-indexing-envio-hyperindex)
+
+---
+
+## Getting started
+
+**Requirements**: Node.js, Docker (only needed for local development)
+
+```bash
+npx envio init
+```
+
+This scaffolds your entire indexer project, config, schema, and handler functions, in seconds. You can generate from a contract address, choose from templates, or start from an existing example.
+
+From there, three files define your indexer:
+
+- `config.yaml` — networks, contracts, events, and indexing behaviour
+- `schema.graphql` — the shape of your indexed data
+- `src/EventHandlers.*` — your handler logic in TypeScript, JavaScript, or ReScript
+
+[Full getting started guide →](https://docs.envio.dev/docs/HyperIndex/getting-started)
 
-## Getting Started
+---
 
-Check out our [Getting Started Guide](https://docs.envio.dev/docs/HyperIndex/getting-started) to start querying your smart contract data with just a few clicks!
+## HyperSync
 
-## Performance
+HyperSync is the data engine that makes HyperIndex fast. It's active by default for all supported networks, no configuration needed.
 
-HyperIndex delivers industry-leading indexing speeds, with capability to process thousands of events per second while maintaining data integrity across multiple chains.
+Instead of making individual RPC calls per block, HyperSync retrieves multiple data points per round trip with advanced filtering. The result: sync speeds up to 2000x faster than standard RPC, dramatically lower infrastructure costs, and no rate limit headaches on supported networks.
 
-## Contribution & Support
+HyperSync can also be used directly for custom data pipelines in Python, Rust, Node.js, and Go, independent of HyperIndex.
+
+[HyperSync docs →](https://docs.envio.dev/docs/HyperSync/overview)
+
+---
+
+## Supported networks
+
+HyperIndex supports any EVM-compatible L1, L2, or L3, plus Fuel and Solana (experimental). 70+ chains have native HyperSync support for maximum speed. For any EVM chain not on the HyperSync list, RPC-based indexing works out of the box.
+
+[Full network list →](https://docs.envio.dev/docs/HyperIndex/supported-networks)
+
+---
+
+## Migrating from The Graph, Ponder, or Subsquid
+
+HyperIndex has a dedicated migration guide that covers config conversion, schema mapping, and query differences in 3 steps. Envio also offers white-glove migration support. Reach out on Discord and the team will help you get set up.
+
+Teams migrating from The Graph can access 2 months of free hosting and full migration support.
+
+[Migration guide →](https://docs.envio.dev/docs/HyperIndex/migration-guide)
+
+---
+
+## Documentation
+
+Full documentation lives at [docs.envio.dev](https://docs.envio.dev).
+
+Key sections:
+- [Getting Started](https://docs.envio.dev/docs/HyperIndex/getting-started)
+- [Contract Import / Auto-generation](https://docs.envio.dev/docs/HyperIndex/contract-import)
+- [Multichain Indexing](https://docs.envio.dev/docs/HyperIndex/multichain-indexing)
+- [Wildcard Indexing](https://docs.envio.dev/docs/HyperIndex/wildcard-indexing)
+- [Reorg Support](https://docs.envio.dev/docs/HyperIndex/reorgs-support)
+- [Hosted Service](https://docs.envio.dev/docs/HyperIndex/hosted-service)
+- [HyperSync as Data Source](https://docs.envio.dev/docs/HyperIndex/hypersync)
+- [Migration Guide](https://docs.envio.dev/docs/HyperIndex/migration-guide)
+
+---
+
+## Community and support
 
 - Follow us on [X](https://twitter.com/envio_indexer)
-- Join our [Discord community](https://discord.gg/DhfFhzuJQh)
-- Report issues on [GitHub](https://github.com/enviodev/hyperindex/issues/new/choose)
-- Check our [Common Issues](https://docs.envio.dev/docs/common-issues) page for troubleshooting
+- Join the [Discord](https://discord.gg/DhfFhzuJQh), fastest way to get help
+- Open an issue on [GitHub](https://github.com/enviodev/hyperindex/issues/new/choose)
+- Browse [common issues](https://docs.envio.dev/docs/common-issues) for quick troubleshooting
+
+If HyperIndex is useful to you, a ⭐ on this repo goes a long way.
+
+---
+
+<div align="center">
+
+Built by [Envio](https://envio.dev) · [Docs](https://docs.envio.dev)
 
-If you find HyperIndex useful, please consider giving us a ⭐ on this repo!
+</div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "envio",
-  "version": "3.0.0-alpha.19-main-node-pg-client",
+  "version": "3.0.0-alpha.20",
   "type": "module",
   "description": "A latency and sync speed optimized, developer friendly blockchain data indexer.",
   "bin": "./bin.mjs",
@@ -61,13 +61,13 @@
     "ink": "6.8.0",
     "ink-big-text": "2.0.0",
     "ink-spinner": "5.0.0",
-    "pg": "8.16.0",
+    "postgres": "3.4.8",
     "tsx": "4.21.0"
   },
   "optionalDependencies": {
-    "envio-linux-x64": "3.0.0-alpha.19-main-node-pg-client",
-    "envio-linux-arm64": "3.0.0-alpha.19-main-node-pg-client",
-    "envio-darwin-x64": "3.0.0-alpha.19-main-node-pg-client",
-    "envio-darwin-arm64": "3.0.0-alpha.19-main-node-pg-client"
+    "envio-linux-x64": "3.0.0-alpha.20",
+    "envio-linux-arm64": "3.0.0-alpha.20",
+    "envio-darwin-x64": "3.0.0-alpha.20",
+    "envio-darwin-arm64": "3.0.0-alpha.20"
   }
 }

package/src/ChainFetcher.res

@@ -245,6 +245,7 @@ let make = (
     sourceManager: SourceManager.make(
       ~sources,
       ~maxPartitionConcurrency=Env.maxPartitionConcurrency,
+      ~isLive=timestampCaughtUpToHeadOrEndblock->Option.isSome,
     ),
     reorgDetection: ReorgDetection.make(
       ~chainReorgCheckpoints,

package/src/ChainFetcher.res.mjs

@@ -152,7 +152,7 @@ function make(chainConfig, dynamicContracts, startBlock, endBlock, firstEventBlo
   return {
           logger: logger,
           fetchState: fetchState,
-          sourceManager: SourceManager.make(sources$1, Env.maxPartitionConcurrency, undefined, undefined, undefined),
+          sourceManager: SourceManager.make(sources$1, Env.maxPartitionConcurrency, Belt_Option.isSome(timestampCaughtUpToHeadOrEndblock), undefined, undefined, undefined, undefined, undefined),
           chainConfig: chainConfig,
           isProgressAtHead: false,
           timestampCaughtUpToHeadOrEndblock: timestampCaughtUpToHeadOrEndblock,

package/src/Config.res

@@ -385,7 +385,6 @@ let parseEntitiesFromJson = (
 
     let table = Table.mkTable(
       entityName,
-      ~stmtId=index->Belt.Int.toString,
       ~fields=Array.concat(fields, derivedFields),
       ~compositeIndices,
     )

package/src/Config.res.mjs

@@ -41,7 +41,7 @@ var schema = S$RescriptSchema.schema(function (s) {
 
 var rowsSchema = S$RescriptSchema.array(schema);
 
-var table = Table.mkTable(name, undefined, undefined, [
+var table = Table.mkTable(name, undefined, [
       Table.mkField("id", "String", S$RescriptSchema.string, undefined, undefined, undefined, true, undefined, undefined),
       Table.mkField("chain_id", "Int32", S$RescriptSchema.$$int, undefined, undefined, undefined, undefined, undefined, undefined),
       Table.mkField("registering_event_block_number", "Int32", S$RescriptSchema.$$int, undefined, undefined, undefined, undefined, undefined, undefined),
@@ -320,7 +320,7 @@ function parseEntitiesFromJson(entitiesJson, enumConfigsByName) {
                                             };
                                     }));
                       }));
-                var table = Table.mkTable(entityName, String(index), compositeIndices, Belt_Array.concat(fields, derivedFields));
+                var table = Table.mkTable(entityName, compositeIndices, Belt_Array.concat(fields, derivedFields));
                 var schema = S$RescriptSchema.schema(function (s) {
                       var dict = {};
                       Belt_Array.forEach(entityJson.properties, (function (prop) {

package/src/Env.res

@@ -109,7 +109,7 @@ module Db = {
   )
   let ssl = envSafe->EnvSafe.get(
     "ENVIO_PG_SSL_MODE",
-    Pg.sslOptionsSchema,
+    Postgres.sslOptionsSchema,
     //this is a dev fallback option for local deployments, shouldn't run in the prod env
     //the SSL modes should be provided as string otherwise as 'require' | 'allow' | 'prefer' | 'verify-full'
     ~devFallback=Bool(false),

package/src/Env.res.mjs

@@ -1,8 +1,8 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
-import * as Pg from "./bindings/Pg.res.mjs";
 import * as EnvSafe from "rescript-envsafe/src/EnvSafe.res.mjs";
 import * as Logging from "./Logging.res.mjs";
+import * as Postgres from "./bindings/Postgres.res.mjs";
 import * as Belt_Option from "rescript/lib/es6/belt_Option.js";
 import * as HyperSyncClient from "./sources/HyperSyncClient.res.mjs";
 import * as S$RescriptSchema from "rescript-schema/src/S.res.mjs";
@@ -82,7 +82,7 @@ var database = EnvSafe.get(envSafe, "ENVIO_PG_DATABASE", S$RescriptSchema.string
 
 var publicSchema = EnvSafe.get(envSafe, "ENVIO_PG_SCHEMA", S$RescriptSchema.string, undefined, EnvSafe.get(envSafe, "ENVIO_PG_PUBLIC_SCHEMA", S$RescriptSchema.string, undefined, "public", undefined, undefined), undefined, undefined);
 
-var ssl = EnvSafe.get(envSafe, "ENVIO_PG_SSL_MODE", Pg.sslOptionsSchema, undefined, undefined, false, undefined);
+var ssl = EnvSafe.get(envSafe, "ENVIO_PG_SSL_MODE", Postgres.sslOptionsSchema, undefined, undefined, false, undefined);
 
 var maxConnections = EnvSafe.get(envSafe, "ENVIO_PG_MAX_CONNECTIONS", S$RescriptSchema.$$int, undefined, 2, undefined, undefined);
 

package/src/GlobalState.res

@@ -791,7 +791,11 @@ let checkAndFetchForChain = (
 
     await chainFetcher.sourceManager->SourceManager.fetchNext(
       ~fetchState,
-      ~waitForNewBlock=(~knownHeight) => chainFetcher.sourceManager->waitForNewBlock(~knownHeight),
+      ~waitForNewBlock=(~knownHeight) =>
+        chainFetcher.sourceManager->waitForNewBlock(
+          ~knownHeight,
+          ~isLive=chainFetcher->ChainFetcher.isReady,
+        ),
       ~onNewBlock=(~knownHeight) => dispatchAction(FinishWaitingForNewBlock({chain, knownHeight})),
       ~executeQuery=async query => {
         try {
@@ -799,6 +803,7 @@ let checkAndFetchForChain = (
             await chainFetcher.sourceManager->executeQuery(
               ~query,
               ~knownHeight=fetchState.knownHeight,
+              ~isLive=chainFetcher->ChainFetcher.isReady,
             )
           dispatchAction(ValidatePartitionQueryResponse({chain, response, query}))
         } catch {

package/src/GlobalState.res.mjs

@@ -877,7 +877,7 @@ function checkAndFetchForChain(waitForNewBlock, executeQuery, state, dispatchAct
     var fetchState = chainFetcher.fetchState;
     return await SourceManager.fetchNext(chainFetcher.sourceManager, fetchState, (async function (query) {
                   try {
-                    var response = await executeQuery(chainFetcher.sourceManager, query, fetchState.knownHeight);
+                    var response = await executeQuery(chainFetcher.sourceManager, query, fetchState.knownHeight, ChainFetcher.isReady(chainFetcher));
                     return dispatchAction({
                                 TAG: "ValidatePartitionQueryResponse",
                                 _0: {
@@ -895,7 +895,7 @@ function checkAndFetchForChain(waitForNewBlock, executeQuery, state, dispatchAct
                               });
                   }
                 }), (function (knownHeight) {
-                  return waitForNewBlock(chainFetcher.sourceManager, knownHeight);
+                  return waitForNewBlock(chainFetcher.sourceManager, knownHeight, ChainFetcher.isReady(chainFetcher));
                 }), (function (knownHeight) {
                   dispatchAction({
                         TAG: "FinishWaitingForNewBlock",

package/src/Internal.res.mjs

@@ -148,7 +148,7 @@ var effectCacheItemRowsSchema = S$RescriptSchema.array(S$RescriptSchema.schema(f
         }));
 
 function makeCacheTable(effectName) {
-  return Table.mkTable(cacheTablePrefix + effectName, undefined, undefined, [
+  return Table.mkTable(cacheTablePrefix + effectName, undefined, [
               Table.mkField("id", "String", S$RescriptSchema.string, undefined, undefined, undefined, true, undefined, undefined),
               Table.mkField("output", "Json", cacheOutputSchema, undefined, undefined, true, undefined, undefined, undefined)
             ]);

package/src/PgStorage.gen.ts

@@ -0,0 +1,10 @@
+/* TypeScript file generated from PgStorage.res by genType. */
+
+/* eslint-disable */
+/* tslint:disable */
+
+import * as PgStorageJS from './PgStorage.res.mjs';
+
+import type {sql as Postgres_sql} from '../src/bindings/Postgres.gen.js';
+
+export const makeClient: () => Postgres_sql = PgStorageJS.makeClient as any;