Skip to content

Update state archival docs with auto-restoration information #1873

@dmkozh

Description

@dmkozh

Auto-restoration of the archived entries has been introduced in protocol 23. This needs to be reflected in the State Archival section (https://developers.stellar.org/docs/learn/fundamentals/contract-development/storage/state-archival).

Here are some changes that I can think of:

  • Add a new section about auto-restoration somewhere at the top to signify the fact that most of the time simulation will just add the archived entries to the list of entries to restore, so there is no need for manual restoration
  • Update both examples to make it clear that restoration operation is not required most of the time (I'm not sure if we need an auto-restoration example, as it wouldn't be different from just performing a contract invocation)
  • Behavior of transactions that try to access an archived Persistent entry - semantics of accessing an archived (and not auto-restored) entry remains the same, but we should make that clear. With auto-restoration accessing archived entries should be rather rare, so maybe we should rephrase this section from the security angle instead, i.e. answering the question like 'what if my entry is archived and someone tried to do something about it without performing [auto]restoration'.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions