docsReference LibraryInconsistencies Resolved

Dogenals Repository Inconsistencies Analysis & Resolution

This document summarizes inconsistencies found during repository-wide analysis and their resolution status.

Version Field Inconsistencies

Issue: Version field format varies between protocols

  • ÐMaps and Koinu Relics use "v": "1" (string “1”)
  • Most other protocols use "v": "1.0" (string “1.0”)

Resolution: Intentional Design Choice ✅

After reviewing protocol specifications:

  • ÐMaps explicitly documents | v | 1 (string) | in its design summary
  • Koinu Relics uses | v | 1 | in its design summary
  • This appears to be an intentional design choice for these protocols
  • No changes needed - this is documented protocol behavior

Terminology Consistency ✅

Analysis Results:

  • “koinu” vs “sat”: Repository correctly uses “koinu” throughout (245 instances found)
  • “Dogenals” vs **“Ordinals”: Correctly uses “Dogenals” throughout
  • Protocol markers: All "p" fields are consistent with documented values
  • Field names: JSON structures follow consistent patterns

No Issues Found:

  • All protocol markers match their specifications
  • Terminology is consistent across specs and documentation
  • JSON field naming follows established patterns

JSON Structure Consistency ✅

Envelope Patterns:

  • All protocols follow consistent envelope structure: {"p": "...", "v": "...", "op": "..."}
  • Optional fields are properly documented
  • Error handling patterns are consistent

Recommendation

The repository maintains high consistency. The version field differences are intentional protocol design choices and should be preserved. No changes required.

Future Monitoring

When adding new protocols or updating existing ones:

  • Ensure version field format aligns with protocol design intent
  • Maintain consistent terminology usage
  • Follow established JSON structure patterns
  • Document any intentional deviations in protocol specs