Mud Indexing

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

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