Primodium Indexer

Set of tools for reading data in MUD compliant projects.

Getting Started

Running a local indexer (via Docker):

Requirements

• Docker
• pnpm

To start a local indexer on foundry chain run:

pnpm indexer:local

To properly remove docker networks and volumes run:

pnpm indexer:clean

Note: Docker is required to easily create an instance of a local pg db, indexer writer, and our custom reader. Crtl+c will only send termination signal to containers. It is recommended to run this time to time

Packages

@primodiumxyz/pg-indexer-read

Modified MUD indexer reader that supports both encoded and decoded reads. Includes a new api to read decoded records with ORM-like syntax.

README for more info.

@primodiumxyz/sync-stack

Modularized sync-stack heavily based on Lattice's MUD sync-store to easily build reusable sync pipelines that require writing and reading from multiple sources.

README for more info.