KERI Coding Style Guide

Overview

The KERI coding style is a Domain-Specific Linguistic Programming (DSLP) approach that creates a 1:1 mapping between the KERI specification terminology and code structure. This style makes code self-documenting and enables implementers in other languages to translate patterns while maintaining conceptual fidelity.

Core Philosophy: Every naming convention reinforces KERI/CESR concepts. The code reads like the KERI spec itself.

Quick Reference

Five Primary Patterns

1. Modules: Use gerunds with -ing suffix (e.g., coring.py, eventing.py, signing.py)
2. Classes: Use agent nouns with -er suffix (e.g., Verfer, Diger, Siger, Salter)
3. Code Tables: Use frozen dataclasses with -Dex suffix (e.g., DigDex, PreDex, NumDex)
4. Transformations: Use verbs with -ify suffix (e.g., sizeify(), versify(), saidify())
5. Data Structures: Use namedtuples with -age suffix (e.g., Versionage, Smellage)