OpenParable
Skip to content
← Back to skills

Mud Indexing

Development
mud-indexing

Mud Indexing is an Agent Skill for development published in the Nethereum/Nethereum repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Help users index MUD Store events, process on-chain table mutations, store in PostgreSQL or EF Core, normalise schemas, run continuous sync. Use when users mention MUD indexing, Store events, MUD PostgreSQL, MUD EF Core, StoreEventsLogProcessingService, or building an indexer for MUD World data.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Nethereum/Nethereum/blob/HEAD/plugins/nethereum-skills/skills/mud-indexing/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/mud-indexing, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

MUD Store Event Indexing with Nethereum

Every MUD table mutation emits a Store event. By processing these events, you can rebuild the complete state of any MUD World and store it in PostgreSQL with typed relational tables.

When to Use This Skill

  • User wants to index MUD World state off-chain
  • User needs to process Store events into a database
  • User wants PostgreSQL tables mirroring MUD schemas
  • User mentions StoreEventsLogProcessingService, MUD normalisation, or MUD repositories

Required Packages

dotnet add package Nethereum.Mud.Contracts

# For PostgreSQL normalisation:
dotnet add package Nethereum.Mud.Repositories.Postgres

# For EF Core (any database):
dotnet add package Nethereum.Mud.Repositories.EntityFramework

Quick Start: In-Memory

var storeEventsService = new StoreEventsLogProcessingService(web3, worldAddress);
var repository = new InMemoryTableRepository();
await storeEventsService.ProcessAllStoreChangesAsync(repository);
// repository now contains full current state

PostgreSQL Normalisation

var normaliser = new MudPostgresStoreRecordsNormaliser(connectionString, worldAddress);
await normaliser.UpsertAsync(repository);

Creates typed PostgreSQL tables: {namespace}__{tableName} with proper column types.

Query Normalised Tables

var queryService = new NormalisedTableQueryService(connectionString);
var tables = await queryService.GetAvailableTablesAsync();
var results = await queryService.QueryAsync("app__Player", limit: 100);
var count = await queryService.CountAsync("app__Player");

Continuous Sync

var processor = storeEventsService.CreateProcessor(
    repository,
    blockProgressRepository: new InMemoryBlockchainProgressRepository(),
    numberOfBlocksPerRequest: 1000);

await processor.ExecuteAsync(cancellationToken);

Processing from Transaction Receipt

var receipt = await playerService.SetRecordRequestAndWaitForReceiptAsync(key, value);
await StoreEventsLogProcessingService.ProcessAllStoreChangesFromLogs(repository, receipt);

Storage Decision Table

StrategyBest For
InMemoryTableRepositoryDevelopment, testing
MudEFCoreTableRepositoryAny EF Core database, simple persistence
PostgreSQL normalisationProduction, analytics, explorer UIs

For full documentation, see: https://docs.nethereum.com/docs/mud-framework/guide-mud-indexing