docs: add x modules summary doc

x/README.md

@@ -0,0 +1,132 @@
+# Elys Network Modules
+
+This document provides a summary of each module available under the `x` folder of the Elys Network, along with links to the respective module specification documents. Each module is designed to enhance the functionalities of the Elys Network by adding specific capabilities like automated market making, staking, liquidity provisioning, asset management, and more. For detailed information, click on the links provided for each module.
+
+## Modules Overview
+
+### 1. [AccountedPool Module](x/accountedpool)
+
+The `accountedpool` module manages and maintains the state of accounted pools within the Elys Network. It ensures accurate accounting of pool balances, integrating with other modules like AMM and Perpetual pools.
+
+- **Features**: Accurate pool management, integration with AMM and Perpetual pools, query services.
+- **[Module Spec](x/accountedpool/spec/README.md)**
+
+### 2. [AMM Module](x/amm)
+
+The Automated Market Maker (AMM) module supports liquidity pools designed for assets with significant price variation and those with stable prices through AMM and Oracle pools.
+
+- **Features**: Liquidity provision, oracle integration, risk management.
+- **[Module Spec](x/amm/spec/README.md)**
+
+### 3. [Asset Profile Module](x/assetprofile)
+
+The `assetprofile` module manages asset properties, defining parameters and handling Inter-Blockchain Communication (IBC) integration.
+
+- **Features**: Asset management, IBC integration, parameter management.
+- **[Module Spec](x/assetprofile/spec/README.md)**
+
+### 4. [Burner Module](x/burner)
+
+The `burner` module allows for automatic burning of native tokens at regular intervals, depending on the Epochs module.
+
+- **Features**: Token burning, integration with the Epochs module.
+- **[Module Spec](x/burner/spec/README.md)**
+
+### 5. [Commitment Module](x/commitment)
+
+The `commitment` module manages token commitments, including staking, vesting, and locking of tokens.
+
+- **Features**: Token commitment, staking, vesting schedules, dynamic parameter updates.
+- **[Module Spec](x/commitment/spec/README.md)**
+
+### 6. [Epochs Module](x/epochs)
+
+The `epochs` module provides a generalized epoch interface, allowing other modules to execute tasks at specified time intervals.
+
+- **Features**: Time-based task execution, generalized epoch signaling.
+- **[Module Spec](x/epochs/spec/README.md)**
+
+### 7. [eStaking Module](x/estaking)
+
+The `estaking` module extends basic staking functionalities by adding advanced reward management, staking parameter updates, and Eden token mechanics.
+
+- **Features**: Advanced reward distribution, Eden token management, staking parameter updates.
+- **[Module Spec](x/estaking/spec/README.md)**
+
+### 8. [LeverageLP Module](x/leveragelp)
+
+The `leveragelp` module allows users to add liquidity in leverage in AMM pools to enhance their rewards while ensuring safety through health checks and liquidation mechanisms.
+
+- **Features**: Leveraged liquidity, health checks, dynamic parameter updates.
+- **[Module Spec](x/leveragelp/spec/README.md)**
+
+### 9. [Masterchef Module](x/masterchef)
+
+The `masterchef` module manages liquidity provider rewards, external incentives, and dynamically updates staking parameters.
+
+- **Features**: Reward management, external incentives, dynamic parameter updates.
+- **[Module Spec](x/masterchef/spec/README.md)**
+
+### 10. [Oracle Module](x/oracle)
+
+The `oracle` module provides decentralized price feeds and manages asset information by utilizing multiple sources to ensure reliability.
+
+- **Features**: Decentralized price feeds, asset information management, price feeder control.
+- **[Module Spec](x/oracle/spec/README.md)**
+
+### 11. [Parameter Module](x/parameter)
+
+The `parameter` module manages and maintains key configuration parameters within the Elys Network, allowing for dynamic and controlled adjustments.
+
+- **Features**: Dynamic parameter management, query services, controlled updates.
+- **[Module Spec](x/parameter/spec/README.md)**
+
+### 12. [Perpetual Module](x/perpetual)
+
+The `perpetual` module facilitates perpetual trading, allowing users to open and close leveraged positions without expiry dates, with various safety and health checks.
+
+- **Features**: Perpetual trading, leverage management, safety factor, liquidation mechanisms.
+- **[Module Spec](x/perpetual/spec/README.md)**
+
+### 13. [Stablestake Module](x/stablestake)
+
+The `stablestake` module manages stable staking functionalities, including borrowing and lending mechanisms, interest rate management, and debt handling.
+
+- **Features**: Borrowing and lending management, interest rate updates, debt management.
+- **[Module Spec](x/stablestake/spec/README.md)**
+
+### 14. [Tier Module](x/tier)
+
+The `tier` module manages the tier membership system, providing loyal users with discounts and benefits across all services available in the Elys Network.
+
+- **Features**: Tier membership management, user discounts, service-wide benefits.
+- **[Module Spec](x/tier/spec/README.md)**
+
+### 15. [Tokenomics Module](x/tokenomics)
+
+The `tokenomics` module manages the economic and incentive mechanisms of the network, including airdrops and inflation.
+
+- **Features**: Airdrop management, inflation handling, dynamic parameter updates.
+- **[Module Spec](x/tokenomics/spec/README.md)**
+
+### 16. [TradeShield Module](x/tradeshield)
+
+The `tradeshield` module provides functionalities for creating and managing various types of market orders, including spot and perpetual orders, and handles order execution through off-chain agents to optimize performance.
+
+- **Features**: Order creation and cancellation, off-chain execution agents, penalty and reward systems.
+- **[Module Spec](x/tradeshield/spec/README.md)**
+
+### 17. [Transferhook Module](x/transferhook)
+
+The `transferhook` module provides advanced functionality for handling IBC transfers, integrating AMM interactions for efficient token transfers.
+
+- **Features**: AMM integration, parameter management, query services.
+- **[Module Spec](x/transferhook/spec/README.md)**
+
+## References
+
+- [Elys Network Documentation](https://docs.elys.network)
+- [Cosmos SDK Documentation](https://docs.cosmos.network)
+- [GitHub Repository for Elys Network](https://github.com/elys-network/elys)
+
+For detailed information about each module, refer to their respective documentation linked above.

x/burner/spec/README.md

@@ -0,0 +1,27 @@
+# Burner Module
+
+## Contents
+
+1. **[Concepts](01_concepts.md)**
+2. **[State](02_state.md)**
+3. **[Events](03_events.md)**
+
+## References
+
+Resources:
+
+- [Elys Network Documentation](https://docs.elys.network)
+- [Cosmos SDK Documentation](https://docs.cosmos.network)
+- [GitHub Repository for Elys Network](https://github.com/elys-network/elys)
+
+## Overview
+
+The `burner` module in the Elys Network is designed to manage automatic burning of native tokens on a regular basis. It depends on the Epochs module, which triggers the burning mechanism at the specified interval (e.g., daily, weekly, etc.).
+
+## Key Features
+
+- **Token Burning**: Automatically burn native tokens at regular intervals.
+- **Integration with Epochs Module**: Depend on the Epochs module to trigger the burning mechanism.
+- **Customizable Burning Intervals**: Set the burning intervals based on the requirements of the network.
+
+For more detailed information, please refer to the individual sections listed in the contents above.

x/tier/spec/README.md

@@ -0,0 +1,21 @@
+# Tier Module
+
+## References
+
+Resources:
+
+- [Elys Network Documentation](https://docs.elys.network)
+- [Cosmos SDK Documentation](https://docs.cosmos.network)
+- [GitHub Repository for Elys Network](https://github.com/elys-network/elys)
+
+## Overview
+
+The `tier` module manages the tier membership system, providing loyal users with discounts and benefits across all services available in the Elys Network.
+
+## Key Features
+
+- **Tier Membership Management**: Manage the tier membership system for users.
+- **User Discounts**: Provide discounts to users based on their tier level.
+- **Service-Wide Benefits**: Offer benefits across all services in the Elys Network based on the user's tier level.
+
+For more detailed information, please refer to the individual sections listed in the contents above.