@primodiumxyz/sync-stack is a modularized utility library based on Lattice's MUD sync-store to easily build reusable sync pipelines that require more granular control over reading and writing from/to multiple sources.
A sync stack is comprised of a number of readers and writers:
- Reader: Defines how records are retrieved from an external source (RPC, indexer, etc.)
- Write: Defines how these records are written to a store of choice. (recs, zustand, cache, etc.)
- Included: Recs (See examples)
- Sync: A helper function to create reusable sync stacks by passing in a number of readers and writers.
- Node.js (>=14.0.0)
- pnpm
- MUD V2
- viem (RPC reading)
Install with npm, yarn, or pnpm
npm:
npm install @primodiumxyz/sync-stackyarn:
yarn add @primodiumxyz/sync-stack
pnpm:
pnpm i @primodiumxyz/sync-stack
Let's setup a basic sync pipeline that reads for mud events on the rpc and prints the records to console:
// create viem client
const publicClient = createPublicClient({
transport: transportObserver(http()),
chain: localhost,
});
//create sync pipeline
const sync = Sync.withCustom({
reader: Read.fromRPC.subscribe({
address: WORLD_ADDRESS,
publicClient,
}),
writer: Write.toConsole,
});
//start the sync
sync.start();
// stop listening after 10 seconds
setTimeout(() => {
sync.unsubscribe();
}, 1000 * 10);See full example.
Sync stack also comes with pre-configured sync helpers for getting started with recs.
// create viem client
const publicClient = createPublicClient({
transport: transportObserver(http()),
chain: localhost,
});
// create recs world and components
const world = createWorld();
const tables = resolveConfig(config).tables;
recsStorage({
world,
tables,
});
//sync to recs components
const sync = Sync.withLiveRPCRecsSync({
address: WORLD_ADDRESS,
publicClient,
world,
tables,
});
//start the sync
sync.start();
// stop listening after 10 seconds
setTimeout(() => {
sync.unsubscribe();
}, 1000 * 10);See full example.
// create recs world and components
const world = createWorld();
const tables = resolveConfig(config).tables;
recsStorage({
world,
tables,
});
// sync recs from query results whre score is greater than 100k
const sync = Sync.withQueryDecodedIndexerRecsSync({
indexerUrl: INDEXER_URL,
world,
tables,
query: {
address: WORLD_ADDRESS,
queries: [
{
tableName: "Score",
where: {
column: "value",
operation: "gt",
value: 100_000,
},
},
],
},
});
//start the sync
sync.start();See full example.
To see all examples, including creating your own custom readers and writers, go here.
Pull requests and issues are welcome.
MIT