Detailed Developer Milestones

Cosmos Indexer Milestones

Milestone 1 – Cosmos SDK v0.47 Refactor + Probe Extension

Goal

Refactor the application to use Cosmos SDK v0.47 and the easier to maintain/extend DefiantLabs/Probe repository. The Probe repository provides the RPC querying functionality necessary for the application to query blockchain data and parse protobuf type implementations for Transaction Messages.

Objectives

1. Dependence on Cosmos SDK: Use version 0.47 for all base Cosmos module functionality.
2. Easy Extension: Support Transaction message types in the future by including protobuf type implementations for custom/non-base modules.
3. Custom Querying: Extend custom querying methodology for module-specific query commands for custom indexing capabilities.
4. Replace and Update Cosmos SDK: Move to the official v0.47 release of Cosmos SDK and update the codebase accordingly.
5. Probe Dependency: Depend on the simplified Probe repository for all RPC querying and Protobuf Message type definition support.
6. Extend and Validate Protobuf Definitions: Handle all supported Protobuf Message type definitions and validate the dependency on the latest definitions for Messages in base Cosmos modules and custom modules.

Milestone 2 – Generalized Indexer Implementation for Indexing Base Cosmos Data

Goal

Rework the application indexer loop to index all data in the lifecycle of a block and transaction. The indexer will index a blockchain with customizable configuration values to indicate the desired level of granularity for the generalized indexer implementation.

Ruleset

1. If Indexing Blocks Only, Then Index:
   1. Basic Block data
   2. All Block BeginBlocker events
   3. All Block EndBlocker events
   4. Events with all key/value pairs indexed
2. If Indexing Block Transactions, Then Index:
   1. Basic Block data
   2. For each Transaction in a block, index basic Transaction data
   3. For each Message in each Transaction, index:
      1. Basic Message data
      2. All events per Message
      3. Events with all key/value pairs indexed

Objectives

• Rework database models to extend indexed data for Blocks, Transactions, and Messages
• Extend models for Block and Transaction Message Events and Key/Value Attributes
• Add configuration values for fine-grained control over event indexing

Milestone 3 – Custom Block Event and Transaction Message Parser Interface Functionality

Goal

Implement generalized custom Block Event and Message parser interfaces for developer indexing extensions. Extend the indexer parsing loop for both Generalized Indexer implementations (from Milestone 1) and custom block event/message parser interfaces.

Objectives

1. Implement interface definitions for adding custom Block Event indexer parsers, handlers, and models
2. Implement interface definitions for custom Transaction Message indexer parsers, handlers, and models
3. Add pre-validation functionality
4. Manage custom models with database handling functionality
5. Include custom parsers and handlers for Block Event indexing
6. Include custom parsers and handlers for Transaction Message indexing
7. Index data returned from custom parsers and handlers
8. Add error handling methods for ease-of-development/debugging for custom implementation errors

Milestone 4 – Organize, Simplify and Extend Codebase to Create Cosmos Indexer SDK

Goal

Follow Go best practices in module implementation. Organize each repository package into discrete and useful sets of functionalities. Simplify and extend the codebase as needed to provide generic functions and interfaces across the application. Publish Cosmos Indexer as a well-formed Go module to allow developer usage as an Indexer SDK.

Technical Objectives

1. Modularity: Organize the codebase into clearly defined modules to enable easy integration and customization.
2. Documentation: Provide comprehensive documentation, including API references, tutorials, and examples to assist developers in using the SDK.
3. Performance Optimization: Optimize the code for performance and efficiency, ensuring that it runs smoothly and doesn't consume unnecessary resources.
4. Compatibility: Ensure that the SDK is compatible with different versions of Go and various platforms and environments.
5. Extensibility: Design the SDK to be extensible so that new features can be easily added in the future.
6. Error Handling: Implement robust error handling to allow developers to easily diagnose and correct issues.
7. Security: Incorporate security best practices to protect the integrity of the data and the overall system.
8. Testing: Implement comprehensive testing strategies including unit tests, integration tests, and end-to-end tests to ensure the stability and reliability of the SDK.
9. User-Friendly Interfaces: Develop intuitive and user-friendly interfaces to enhance developer experience and productivity.

These objectives outline the main areas of focus when building a robust and user-friendly SDK. By adhering to these principles, the Cosmos Indexer SDK aims to be a powerful tool for developers, providing flexibility, efficiency, and ease of use.