Modules overview

Overview of all available modules for the Klayr SDK.

Name	Description
Base module	All other modules must extend from the Base module.
Auth module	Responsible for handling and verifying nonces and transaction signature validation, including transactions from multi-signature accounts. For more information, see: LIP 41.
Fee module	Responsible for handling the transaction fees. It allows chains to choose the token used to pay the fee and to define a minimum fee for transactions to be valid. For more information, see: LIP 48.
Mainchain Interoperability module	Provides basic functionalities for the mainchain to transmit information between interoperable chains in the Klayr ecosystem using cross-chain messages. For more information, see: LIP 45.
PoS module	Handles all aspects of the generator selection, this includes the registration of validator accounts, the staking process, and potential reports of misbehavior. For more information, see: LIP 57.
Sidechain Interoperability module	Provides basic functionalities for a sidechain to transmit information between interoperable chains in the Klayr ecosystem using cross-chain messages. For more information, see: LIP 45.
Random module	Handles the validation of the inputs and computation of outputs for the commit and reveal process of a Klayr blockchain. For more information, see: LIP 46.
Reward module	Provides the base reward system for a blockchain developed with the Klayr SDK. For more information, see: LIP 70.
Token module	Handles minting, burning, and transferring tokens inside the Klayr ecosystem. For more information, see: LIP 51.
Validators module	Responsible for validating the eligibility of a validator for generating a block and the block signature. Furthermore, it maintains information about the registered validators in its module store and provides the validator list. For more information, see: LIP 44.

Name

Description

All other modules must extend from the Base module.

Responsible for handling and verifying nonces and transaction signature validation, including transactions from multi-signature accounts. For more information, see: LIP 41.

Fee module

Responsible for handling the transaction fees. It allows chains to choose the token used to pay the fee and to define a minimum fee for transactions to be valid. For more information, see: LIP 48.

Mainchain Interoperability module

Provides basic functionalities for the mainchain to transmit information between interoperable chains in the Klayr ecosystem using cross-chain messages. For more information, see: LIP 45.

PoS module

Handles all aspects of the generator selection, this includes the registration of validator accounts, the staking process, and potential reports of misbehavior. For more information, see: LIP 57.

Sidechain Interoperability module

Provides basic functionalities for a sidechain to transmit information between interoperable chains in the Klayr ecosystem using cross-chain messages. For more information, see: LIP 45.

Random module

Handles the validation of the inputs and computation of outputs for the commit and reveal process of a Klayr blockchain. For more information, see: LIP 46.

Reward module

Provides the base reward system for a blockchain developed with the Klayr SDK. For more information, see: LIP 70.

Token module

Handles minting, burning, and transferring tokens inside the Klayr ecosystem. For more information, see: LIP 51.

Validators module

Responsible for validating the eligibility of a validator for generating a block and the block signature. Furthermore, it maintains information about the registered validators in its module store and provides the validator list. For more information, see: LIP 44.