Skip to content

STORAGE_KEYS.md

Latest commit

 

History

History
71 lines (56 loc) · 2.23 KB

STORAGE_KEYS.md

File metadata and controls

71 lines (56 loc) · 2.23 KB
Raw

Storage Key Naming Convention

This document describes the canonical naming scheme for storage keys in Credence Soroban contracts. Following this convention ensures consistency across the codebase and helps reviewers verify behavior against documented intent.

Convention

Storage key enums and their variants must follow these rules:

  • Enum names: Use snake_case (e.g., DataKey, SlashStorageKey, EmergencyDataKey)
  • Variant names: Use snake_case with singular nouns (e.g., Admin, Token, Bond, AttestationCounter)
  • Parameterized variants: Use descriptive singular names with type parameters (e.g., Bond(Address), Attestation(u64), SlashRecord(Address, u32))

Examples

Basic storage key enum

#[contracttype]
#[derive(Clone)]
pub enum DataKey {
    /// Contract administrator
    Admin,
    /// Token address for bond deposits
    Token,
    /// Bond data for a specific identity
    Bond(Address),
    /// Individual attestation record
    Attestation(u64),
    /// Monotonic counter for attestation IDs
    AttestationCounter,
}

Namespace-specific storage keys

#[contracttype]
#[derive(Clone)]
pub enum SlashStorageKey {
    /// Number of slashes for an identity
    SlashCount(Address),
    /// Individual slash record by (identity, index)
    SlashRecord(Address, u32),
}

Emergency audit storage keys

#[contracttype]
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum EmergencyDataKey {
    /// Emergency record by ID
    Record(u64),
    /// State transition record by ID
    Transition(u64),
    /// Monotonic sequence counter
    RecordSeq,
}

Rationale

  • Singular nouns: Bond not Bonds, Admin not Admins. This matches the conceptual model where each key represents a single storage entry or namespace.
  • snake_case: Consistent with Rust naming conventions for enum variants in this codebase.
  • Descriptive parameterized variants: Bond(Address) clearly indicates the key is indexed by address, making the storage layout self-documenting.

Related Documentation