Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Update framework modules readme - Closes #3157 #3628

Merged
merged 5 commits into from
May 16, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions framework/src/modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- [Description](#description)
- [Core Modules](#core-modules)
- [Custom Modules](#custom-modules)
- [Module Configuration](#module-configuration)
- [Module Communication](#module-communication)
- [InMemory Channel](#inmemory-channel)
- [ChildProcess Channel](#childprocess-channel)
Expand All @@ -22,6 +23,7 @@ Core Modules are shipped along with the Lisk Core distribution itself. These mod

- **Chain Module:** handles all events and actions, that are related to the blockchain system.
- **HTTP API Module:** provides API endpoints, that enable users and other programs to communicate with the Lisk blockchain through the API.
- **Network Module:** handles peer-to-peer communication of nodes in the network.

### Custom Modules

Expand Down Expand Up @@ -120,6 +122,17 @@ export default class MyModule extends BaseModule {
};
```

## Module Configuration

Configuration options for each module are located in `framework/src/modules/<module-name>/defaults/config.js`.

Each `config.js` file consists of 2 parts:

1. JSON-schema specification for all available config options
2. Default values for the available config options for this specific module.

Please don't change the default values in these files directly as they will be overwritten on software updates, instead define the custom configuration options inside your blockchain application.

## Module Communication

Modules communicate with each other through event-based channels.
Expand Down Expand Up @@ -149,8 +162,3 @@ A modules' life cycle consists of following events in the right order:
- _module_:registeredToBus
- _module_:loading:started
- _module_:loading:finished

**Unloading**

- _module_:unloading:started
- _module_:unloading:finished