Skip to content

Commit

Permalink
Update SPEC-SPEC & documentation for x/{bank,evidence} (#7404)
Browse files Browse the repository at this point in the history
* Update documentation for x/bank

* Update ModuleAccounts

* Put contets on top

* Update comments

* Do x/evidence

* Add ValidatorEvidence

* Update SPEC-SPEC

* Update anchor
  • Loading branch information
amaury1093 committed Sep 28, 2020
1 parent be59020 commit e17dd4f
Show file tree
Hide file tree
Showing 14 changed files with 543 additions and 558 deletions.
43 changes: 24 additions & 19 deletions docs/spec/SPEC-SPEC.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,33 @@ element as a part of a larger description.

## Common Layout

The following generalized file structure should be used to breakdown
specifications for modules. With the exception of README.md, `XX` at the
beginning of the file name should be replaced with a number to indicate
document flow (ex. read `01_state.md` before `02_state_transitions.md`). The
following list is nonbinding and all files are optional.

- `README.md` - overview of the module
- `XX_concepts.md` - describe specialized concepts and definitions used throughout the spec
- `XX_state.md` - specify and describe structures expected to marshalled into the store, and their keys
- `XX_state_transitions.md` - standard state transition operations triggered by hooks, messages, etc.
- `XX_messages.md` - specify message structure(s) and expected state machine behaviour(s)
- `XX_begin_block.md` - specify any begin-block operations
- `XX_end_block.md` - specify any end-block operations
- `XX_hooks.md` - describe available hooks to be called by/from this module
- `XX_events.md` - list and describe event tags used
- `XX_params.md` - list all module parameters, their types (in JSON) and examples
- `XX_future_improvements.md` - describe future improvements of this module
- `XX_appendix.md` - supplementary details referenced elsewhere within the spec
The specifications should be contained in a single `README.md` file inside the
`spec/` folder of a given module.

The following generalized document structure should be used to breakdown
specifications for modules. Each bullet item corresponds to a new section in
the document, and should begin with a secondary heading (`## {HEADING}` in
Markdown). The `XX` at the beginning of the section name should be replaced
with a number to indicate document flow (ex. read `01. Concepts` before
`02. State Transitions`). The following list is nonbinding and all sections are
optional.

- `XX. Abstract` - overview of the module
- `XX. Concepts` - describe specialized concepts and definitions used throughout the spec
- `XX. State` - specify and describe structures expected to marshalled into the store, and their keys
- `XX. State Transitions` - standard state transition operations triggered by hooks, messages, etc.
- `XX. Messages` - specify message structure(s) and expected state machine behaviour(s)
- `XX. BeginBlock` - specify any begin-block operations
- `XX. EndBlock` - specify any end-block operations
- `XX. Hooks` - describe available hooks to be called by/from this module
- `XX. Events` - list and describe event tags used
- `XX. Params` - list all module parameters, their types (in JSON) and examples
- `XX. Future Improvements` - describe future improvements of this module
- `XX. Appendix` - supplementary details referenced elsewhere within the spec

### Notation for key-value mapping

Within `state.md` the following notation `->` should be used to describe key to
Within the `State` section, the following notation `->` should be used to describe key to
value mapping:

```
Expand Down
11 changes: 0 additions & 11 deletions x/bank/spec/01_state.md

This file was deleted.

135 changes: 0 additions & 135 deletions x/bank/spec/02_keepers.md

This file was deleted.

30 changes: 0 additions & 30 deletions x/bank/spec/03_messages.md

This file was deleted.

29 changes: 0 additions & 29 deletions x/bank/spec/04_events.md

This file was deleted.

25 changes: 0 additions & 25 deletions x/bank/spec/05_params.md

This file was deleted.

Loading

0 comments on commit e17dd4f

Please sign in to comment.