Install
| Product | Versions |
|---|---|
| .NET |
README
Crdt
High-performance, NativeAOT-ready Conflict-free Replicated Data Types (CRDTs) for modern .NET.
Crdt implements the full catalogue of CRDTs β counters, registers, sets, maps, flags, graphs, and sequence/text types β in state-based, delta-state, and operation-based flavours, with compact binary and System.Text.Json source-generated serialization.
Status: pre-release (
0.9.x). APIs may change before1.0.
β¨ Why Crdt
- Strong eventual consistency without coordination: replicas converge after exchanging state, deltas, or operations.
- Fast:
readonly structbuilding blocks,Span<T>/IBufferWriter<byte>serialization,BinaryPrimitives/Unsafefast paths, no LINQ on hot paths. - NativeAOT & trimming clean on .NET 8/9/10 β the library is annotated
IsAotCompatible, and the test suite itself is verified running as a NativeAOT binary. - Broad reach: targets
netstandard2.1,net8.0,net9.0,net10.0(polyfilled on older runtimes).
Supported target frameworks
| TFM | Notes |
|---|---|
net10.0, net9.0, net8.0 |
Full feature set; NativeAOT supported. |
netstandard2.1 |
Compatibility target (Unity / Mono / .NET Core 3.x) via polyfills; not itself AOT-published. |
π¦ Install
dotnet add package Crdt
The optional replication/transport layer β in-memory, TCP (with optional TLS), and UDP anti-entropy gossip, in state-based, delta-state, and operation-based modes β ships as a separate package:
dotnet add package Crdt.Transport
DTLS-secured datagram gossip (built on DtlsSharp) lives in a further opt-in package:
dotnet add package Crdt.Transport.Dtls
π§© CRDT catalogue
| Family | Types |
|---|---|
| Counters | GCounter, PNCounter |
| Registers | LWWRegister<T>, MVRegister<T> |
| Sets | GSet<T>, TwoPhaseSet<T>, LWWElementSet<T>, ORSet<T> |
| Maps | ORMap<TKey,TValue>, LWWMap<TKey,TValue> |
| Flags | EnableWinsFlag, DisableWinsFlag, GFlag |
| Graphs | TwoPTwoPGraph, AddOnlyDag |
| Sequences / Text | Rga<T>, LogootSequence<T>, LSeqSequence<T>, TreedocSequence<T>, YataSequence<T>, WootSequence<T>, Text |
π Replication models
- State-based (CvRDT) β exchange and
Mergefull states. Robust to reordering and duplication. - Delta-state β propagate small deltas of the same lattice; converges with a causal delta protocol.
- Operation-based (CmRDT) β propagate operations carrying their causal context; effects are idempotent / de-duplicated.
Crdt provides the data structures, merge/delta/operation logic, and serialization. Wiring replicas to a network (gossip, anti-entropy, broadcast) is left to the application.
π Documentation
The full developer guide lives in docs/:
- Getting started β install, your first counter, merging replicas.
- Data types β the full catalogue with usage examples for every CRDT.
- Replication models β state-based, delta-state, and operation-based, and when to use each.
- Serialization β the binary and JSON formats, value serializers, and hostile-input limits.
- Architecture β semilattices, dots, the causal kernel (ORSWOT), and the Hybrid Logical Clock.
- Performance & NativeAOT β AOT compliance, trimming, and benchmarking notes.
- Transports β the optional
Crdt.Transportpackage: in-memory and TCP gossip replication.
π οΈ Building from source
dotnet build Crdt.slnx -c Release
dotnet test Crdt.slnx -c Release
Linting / formatting:
dotnet format Crdt.slnx --verify-no-changes
pwsh -NoProfile -File eng/check-line-length.ps1
NativeAOT test gate (publishes and runs the suite as a native binary):
dotnet publish tests/Crdt.Tests/Crdt.Tests.csproj -c Release -f net10.0 -r <rid> -p:AotTest=true
π License
Adoption Assessment
Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.
Related Guides & Workflows
Learn how to evaluate, integrate, or audit this package in your .NET project.