Skip to content

[Request]: Smaller updates for Notarization smart contract comments #116

@wulfraem

Description

@wulfraem

Feature description

We should update the smart contract comments in regard to updatability.

Motivation

Some comments in the smart contracts could be improved a bit to reflect the different behaviors (locked / dynamic) a bit better.

Fond some confusing comments around the notarization::notarization::Notarization definition:

  • Notarization.state -> "The state of the Notarization that can be updated" (this only applies for dynamic notarizations, right?)
  • State.metadata: -> "Mutable metadata that can be updated together with the state data" (same, I assume)
    -Notarization.updatable_metadata: No mention about it being updatable or not, but the field name implies it, but again, this should only apply for dynamic notarizations, so maybe a short note about it being updatable under certain conditions would be helpful imo.

Requirements

Listed comments have been checked, as well as other possible related fields/functions.

Open questions

Maybe it's worth checking related fields and functions, but the ones mentioned above were the ones that I noticed.

Are you planning to do it yourself in a pull request?

No

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions