Skip to content

Add docs for contract storage layout and persistent key naming conventions #583

Description

@Chucks1093

Summary

The contract's persistent storage layout is undocumented, making it difficult for new contributors to understand what is stored, under which keys, and for how long. A reference document should describe the full storage layout and the key naming conventions used.

Scope

  • List every persistent storage key used by the contract
  • For each key: key format, data type stored, TTL policy, and which functions read and write it
  • Document the naming convention used for composite keys (e.g. creator + holder balance keys)
  • Include a note on TTL extension triggers and the minimum ledger threshold that triggers extension

Acceptance Criteria

  • All persistent storage keys documented
  • Each entry includes key format, data type, TTL policy, and read/write functions
  • Composite key naming convention explained with an example
  • TTL extension behaviour and threshold documented
  • Document lives in docs/ in the contracts repo

ETA: 12 hours


Coordinate on Telegram

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions