7f789d2ed3
* remove kv seperation for marshalling * pending * cleanup * cleanup x2 * pending * working * minor refactors * entry structs defined * uncompiled mechanism written * add many compile fixes * code compiles * fix test compile errors * test cover passes * ... * multiple entries fix * ... * more design fix * working * fix test cover bug * Update PENDING.md * update comment around queue completion for redelegations/ubds * basic spec updates * spec folder cleanup * cleanup docs folder cont. * ... * find-replace and folder rename * supplimentary find/replace * pending * supplimentary * pending * few undos, stakingd -> staked * to staking -> to stake * undos * most staking -> most stake * ... * undos * simplestake->simplestaking * ... * pending update * capital letter replacements * ... * working * staking doc updates from rigel/delegation-index branch * spec-spec * spec-spec * LooseTokens -> NotBondedTokens * staking state.md updates * updates to hook and endblock spec * Update docs/gaia/gaiacli.md Co-Authored-By: rigelrozanski <rigel.rozanski@gmail.com> * Update docs/gaia/validators/validator-setup.md Co-Authored-By: rigelrozanski <rigel.rozanski@gmail.com> * Update docs/gaia/validators/validator-setup.md Co-Authored-By: rigelrozanski <rigel.rozanski@gmail.com> * comment undo * remove ErrConflictingRedelegation * @cwgoes comments are resolved * further updates to endblock and state * msg json update * working transaction updates * working * complete transaction rewrite * PENDING.md * typo * add todo * address @jackzampolin @cwgoes comments * couple leftover comments, rename * Update x/staking/types/pool.go Co-Authored-By: rigelrozanski <rigel.rozanski@gmail.com> * cwgoes additions * cwgoes suggestions x2
46 lines
1.4 KiB
Markdown
46 lines
1.4 KiB
Markdown
# Specification of Specifications
|
|
|
|
This file intends to outline the common structure for specifications within
|
|
this directory.
|
|
|
|
## Tense
|
|
|
|
For consistency, specs should be written in passive present tense.
|
|
|
|
## Common Layout
|
|
|
|
The following generalized structure should be used to breakdown specifications
|
|
for modules. Note that not all files may be required depending on the modules
|
|
function
|
|
|
|
- `overview.md` - describe module
|
|
- `state.md` - specify and describe structures expected to marshalled into the store, and their keys
|
|
- `state_transitions.md` - standard state transition operations triggered by by hooks, messages, etc.
|
|
- `end_block.md` - specify any end-block operations
|
|
- `begin_block.md` - specify any begin-block operations
|
|
- `messages.md` - specify message structure and expected state machine behaviour
|
|
- `hooks.md` - describe available hooks to be called by/from this module
|
|
- `tags.md` - list and describe event tags used
|
|
|
|
### Notation for key-value mapping
|
|
|
|
Within `state.md` the following notation `->` should be used to describe key to
|
|
value mapping:
|
|
|
|
```
|
|
key -> value
|
|
```
|
|
|
|
to represent byte concatenation the `|` may be used. In addition, encoding
|
|
type may be specified, for example:
|
|
|
|
```
|
|
0x00 | addressBytes | address2Bytes -> amino(value_object)
|
|
```
|
|
|
|
Additionally, index mappings may be specified by mapping to the `nil` value, for example:
|
|
|
|
```
|
|
0x01 | address2Bytes | addressBytes -> nil
|
|
```
|