Official Paloma Protocol Documentation

# Paloma Core Modules

Paloma Core is the official Golang reference implementation of the Paloma protocol. Paloma Core is dbuilt using the Cosmos SDK, which provides a robust framework for blockchains that run atop the Tendermint consensus protocol.

Before diving into the core modules, it may be useful to familiarize yourself with the Cosmos (opens new window) and Tendermint (opens new window) documentation.

# How to use the Paloma Core module specifications

Each module specification begins with a short description of the module’s main function within the architecture of the system and an explanation of how it contributes to implementing Paloma’s features.

The body of each module specification provides a more detailed description of its main processes and algorithms alongside any concepts you might need to know. The body of each module specification also contains links to more granular information, such as specific state variables, message handlers, and other functions.

These specifications are not an exhaustive reference and are provided as a companion guide for users who need to work directly with the Paloma Core codebase or understand it. Though all the important functions in each module are described, more trivial functions, such as getters and setters, are omitted for clarity. Module logic is also located in either the message handler or block transitions, such as begin-blocker and end-blocker.

The end of each module specification includes lists of various module parameters alongside their default values with a brief explanation of their purpose, associated events / tags, and errors issued by the module.

# Module architecture

The Paloma Core is organized into the following individual modules that implement different parts of the Paloma protocol. They are listed in the order in which they are initialized during genesis:

  1. genaccounts - import & export genesis account

  2. distribution: distribute rewards between validators and delegators

    • reward distribution
    • community pool

  3. staking: validators

  4. auth: ante handler

    • vesting accounts

  5. bank - sending funds from account to account

  6. slashing - low-level Tendermint slashing (double-signing, etc)

  7. gov: on-chain governance

    • proposals
    • parameter updating

  8. crisis - reports consensus failure state with proof to halt the chain

  9. genutil - handles gentx commands

    • filter and handle MsgCreateValidator messages

# Inherited modules

Many of the modules in Paloma Core inherit from the Cosmos SDK and are configured to work with Paloma through customization in either genesis parameters or by augmenting their functionality with additional code.

# Block lifecycle

The following processes are executed during each block transition:

# Begin block

  1. Distribution: Issuance of rewards for the previous block.

  2. Slashing: Checking of infraction evidence or downtime of validators for double-signing and downtime penalties.

# Process messages

  1. Messages are routed to their appropriate modules and then processed by the appropriate message handlers.

# End block

  1. Crisis: Check all registered invariants and assert that they remain true.

  2. Governance: Remove inactive proposals, check active proposals whose voting periods have ended for passes, and run the registered proposal handler of the passed proposal.

  3. Staking: The new set of active validators is determined from the top 175 GRAIN stakers. Validators that lose their spot within the set start the unbonding process.

← Auth →