Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add invariants to module specs #10344

Closed
tac0turtle opened this issue Oct 12, 2021 · 3 comments
Closed

docs: add invariants to module specs #10344

tac0turtle opened this issue Oct 12, 2021 · 3 comments
Labels
good first issue help wanted T:Docs Changes and features related to documentation.

Comments

@tac0turtle
Copy link
Member

Invariants are a key factor is using modules and modifying them, but its hard to know what the invariants are for a module. We should document them in the module level specs.

@tac0turtle tac0turtle added help wanted T:Docs Changes and features related to documentation. good first issue labels Oct 12, 2021
@ValarDragon
Copy link
Contributor

Should also include invariants that are assumed but not actually tested in simulation

@Wryhder
Copy link
Contributor

Wryhder commented Mar 28, 2023

@tac0turtle I'd like to work on this.

To confirm:

  1. This is the list of module specs?
  2. Could you let me know how much documentation is needed? For example, for the staking module, there seem to be four invariants (ModuleAccountInvariants, NonNegativePowerInvariant, PositiveDelegationInvariant, DelegatorSharesInvariant)?
    • Am I correct, and this is how to find the invariants for each module?
    • Is listing them and adding short descriptive comments enough, or would there be more detail?
  3. What does @ValarDragon mean by "invariants that are assumed but not actually tested in simulation"?

@tac0turtle
Copy link
Member Author

closing this as its getting reworked with the simulator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue help wanted T:Docs Changes and features related to documentation.
Projects
None yet
Development

No branches or pull requests

5 participants
@ValarDragon @barriebyron @Wryhder @tac0turtle and others