Simulation docs (#5033)

* simulation docs

* update docs with the latest simulation changes

* minor imporvments

* clean up of simulation.md

* expand section on weights

* minor reword

* minor wording fix

Co-authored-by: Marko <marbar3778@yahoo.com>
This commit is contained in:
Federico Kunze
2020-01-31 16:06:05 +01:00
committed by GitHub
co-authored by Marko
parent 6890feb3d2
commit c7a6299eb2
6 changed files with 1386 additions and 991 deletions
+12 -5
View File
@@ -37,13 +37,18 @@ x/{module}
│   ├── params.go
│   ├── ...
│   └── querier.go
├── simulation
│   ├── decoder.go
│   ├── genesis.go
│   ├── operations.go
│   ├── params.go
│   └── proposals.go
├── abci.go
├── alias.go
├── genesis.go
├── handler.go
├── module.go
├── ...
└── simulation.go
└── module.go
```
- `abci.go`: The module's `BeginBlocker` and `EndBlocker` implementations (if any).
@@ -53,7 +58,7 @@ there is nothing preventing developers from importing other packages from the mo
(excluding`internal/`) but it is recommended that `alias.go` have everything
exposed that other modules may need. The majority of the exported values here will
typically come from `internal/` (see below).
- `client/`: The module's CLI and REST client functionality implementation and
- `client/`: The module's CLI and REST client functionality implementation and
testing.
- `exported/`: The module's exported types -- typically type interfaces. If a module
relies on other module keepers, it is expected to receive them as interface
@@ -79,8 +84,10 @@ allows for greater freedom of development while maintaining API stability.
implementations such as the querier and invariants.
- `module.go`: The module's implementation of the `AppModule` and `AppModuleBasic`
interfaces.
- `simulation.go`: The module's simulation messages and related types (if any).
- `simulation/`: The module's simulation package defines all the required functions
used on the blockchain simulator: randomized genesis state, parameters, weigthed
operations, proposal contents and types decoders.
## Next {hide}
Learn about [interfaces](../interfaces/interfaces-intro.md) {hide}
Learn about [interfaces](../interfaces/interfaces-intro.md) {hide}