From 385bff589dd191d8fd5ebed84a37964605032873 Mon Sep 17 00:00:00 2001 From: Adam Moser <63419657+toteki@users.noreply.github.com> Date: Sun, 20 Nov 2022 07:05:28 -0800 Subject: [PATCH] docs: relocate abci.go in docs/building-modules (#13934) --- docs/docs/building-modules/10-structure.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/building-modules/10-structure.md b/docs/docs/building-modules/10-structure.md index 78c39daa1931..68102ec3e365 100644 --- a/docs/docs/building-modules/10-structure.md +++ b/docs/docs/building-modules/10-structure.md @@ -52,13 +52,13 @@ x/{module_name} │   └── querier.go ├── module │   └── module.go +│   └── abci.go ├── simulation │   ├── decoder.go │   ├── genesis.go │   ├── operations.go │   └── params.go ├── {module_name}.pb.go -├── abci.go ├── codec.go ├── errors.go ├── events.go @@ -78,10 +78,10 @@ x/{module_name} * `exported/`: The module's exported types - typically interface types. If a module relies on keepers from another module, it is expected to receive the keepers as interface contracts through the `expected_keepers.go` file (see below) in order to avoid a direct dependency on the module implementing the keepers. However, these interface contracts can define methods that operate on and/or return types that are specific to the module that is implementing the keepers and this is where `exported/` comes into play. The interface types that are defined in `exported/` use canonical types, allowing for the module to receive the keepers as interface contracts through the `expected_keepers.go` file. This pattern allows for code to remain DRY and also alleviates import cycle chaos. * `keeper/`: The module's `Keeper` and `MsgServer` implementation. * `module/`: The module's `AppModule` and `AppModuleBasic` implementation. + * `abci.go`: The module's `BeginBlocker` and `EndBlocker` implementations (this file is only required if `BeginBlocker` and/or `EndBlocker` need to be defined). * `simulation/`: The module's [simulation](./13-simulator.md) package defines functions used by the blockchain simulator application (`simapp`). * `REAMDE.md`: The module's specification documents outlining important concepts, state storage structure, and message and event type definitions. Learn more how to write module specs in the [spec guidelines](../spec/SPEC-SPEC.md). * The root directory includes type definitions for messages, events, and genesis state, including the type definitions generated by Protocol Buffers. - * `abci.go`: The module's `BeginBlocker` and `EndBlocker` implementations (this file is only required if `BeginBlocker` and/or `EndBlocker` need to be defined). * `codec.go`: The module's registry methods for interface types. * `errors.go`: The module's sentinel errors. * `events.go`: The module's event types and constructors.