Skip to content

DX-085: Document the DataStore contract #597

Description

@IbrahimIjai

Context

DataStore holds protocol state and its key layout is what an integrator needs in
order to read anything directly rather than through the indexer. Key schemes are
notoriously undocumented and notoriously necessary.

Scope

  • The contract's role and storage model, following the DX-084 template.
  • Every public read and write function with parameters, units, authorisation,
    and errors.
  • The key derivation scheme, with worked examples showing how to construct keys
    for the most commonly read values.
  • Which storage type each value uses — instance, persistent, or temporary — and
    what that implies for archival and rent.
  • A worked example reading a real value from testnet.

Acceptance criteria

  • Function coverage asserted against the generated bindings.
  • Key derivation examples were executed and returned the expected values.
  • Storage types and their archival implications are stated per value.
  • Uses <ParamTable> from DX-084 with no divergence.

Out of scope

  • Contract internals not reachable through the public interface.

Spec: docs/dx_1/003_content_map.md §2 · Depends on: DX-084

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions