OpenViSTAI · Agents · Blockchain · Crypto
Submit a project
Menu
Explorers & Analytics

Etherfold

Etherfold is an open-source TypeScript system for indexing Ethereum and other RPC-compatible blockchains. Developers define entity schemas and event handlers as a processor, then run that processor in a browser or from a CLI and select a state store such as IndexedDB, SQLite, or a memory-only patch store.

Explore the practical guide ↓

Independent OpenViST project profile, based on linked sources.

Etherfold — OpenViST project profile in Explorers & Analytics.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use Etherfold when an application needs contract-event indexing and the team wants to keep processor logic separate from its storage backend and operating mode.

Who it is for

  • Developers building applications that need indexed smart-contract event data.
  • Teams comparing browser-based indexing with server-side indexing.
  • TypeScript developers creating modular indexers for Ethereum or other RPC-compatible chains.

Documented uses

  • Index ERC-721 collection events for an NFT application.
  • Turn contract events into entity state using declared fields and event handlers.
  • Reuse one processor across browser IndexedDB and server SQLite storage.
  • Build an index to the chain tip or keep following the chain with the CLI.
Before you choose

Requirements & limits

The repository is public and specifies the MIT license.

  • The engine is documented for EIP-1193 providers and a restricted set of chain-facing methods.
  • The documented storage choices include browser IndexedDB, server SQLite, and a memory-only patch store.
  • The CLI's build mode stops at the chain tip, while run continues following the chain and serves HTTP reads.
  • Historical reads are subject to an explicit retention window.
  • Repository example commands use pnpm; the package installation example uses npm.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Define an event processor for a contract event

Set up the documented entity-and-handler structure for indexing a contract event.

Before you start

  • A TypeScript project.
  • Install @etherfold/browser and @etherfold/processor-entities with npm.
  • The contract event ABI and its event fields.

Steps

  1. Install the packages with the command below.

    Documented command
    npm i @etherfold/browser @etherfold/processor-entities

  2. Declare the event ABI and create an EntityProcessor typed to that ABI.

  3. Define the entity name, identifier fields, and stored fields.

  4. Add an event handler that writes the event values to the entity state.

Expected outcome

A typed processor definition with entity declarations and an event handler, ready to be connected to a storage and indexing setup.

Guide limitations

  • This guide covers processor definition only; it does not configure a chain connection or demonstrate execution.
Documentation 1 ↗
Evidence and transparency

Sources & review

Official repository ↗Guide documentation ↗
Source record details
Source availability
Active
Sources checked
14 October 2026
Original website title
wighawag/etherfold · Official homepage title · retained in its source language
How we review sourcesSuggest a correction