certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
cosmos-sdk/docs/spec/SPEC-SPEC.md

1.4 KiB
Raw Blame History

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