Skip to content

[nodes] Add instruction status such as deprecated or archived #263

@lorisleiva

Description

@lorisleiva

It is not uncommon for program developers to sunset their instructions by first, logging a deprecation warning and then removing it completely by throwing an error when the archived instruction is recognised by the program.

It would be nice for Codama to keep track of that information via a status attribute or even a dedicated InstructionStatusNode. The instruction status could be things like:

  • live if the instruction is accessible (the default state).
  • deprecated if the instruction is about to be archived.
  • archived if the instruction is no longer accessible. Note that this is better than simply removing the instruction from the Codama IDL as explorers would still need to parse old instruction for the program.

We could even imagine more advanced statuses like:

  • draft if the instruction is accessible but not fully implemented yet.
  • unaudited if the instruction is accessible and fully implemented but no audit was performed for it yet.

Additionally, an optional statusMessage attribute could be useful for program maintainers to provide more information about the current status to their consumers.

Metadata

Metadata

Assignees

No one assigned

    Labels

    proposalSuggesting a change / new feature

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions