Index Staking Rewards on All Chains and Publish Dashboard

[danbryan]

Title: Index Staking Rewards on All Chains and Publish Dashboard

Description:

Objective:
Create a system that indexes staking rewards and commissions across all Cosmos chains using the Cosmos-Indexer and public RPCs. The data will be stored in a database and made accessible via a user-friendly dashboard where users can connect their Keplr wallet or input an address to view staking rewards.

Background:
Tracking staking rewards and commissions is crucial for users who want to monitor their earnings and manage their taxes. By leveraging the Cosmos-Indexer and public RPCs from the Cosmos chain registry, we can create an indexer that saves staking rewards and commissions messages into a database. The front-end dashboard will provide a seamless experience similar to Sycamore Tax, allowing users to easily access their staking rewards.

Tasks:

1. Data Collection:

   • RPC Integration:
     • Use the Cosmos chain registry to gather all available public RPC endpoints for Cosmos chains.
     • Deploy Cosmos-Indexers using these RPCs to collect staking rewards and commissions messages.
   • Database Storage:
     • Set up a database to store the indexed staking rewards and commissions data efficiently.
     • Ensure that the database schema is optimized for quick retrieval and querying of staking rewards data.

2. Indexer Deployment:

   • Configure the Cosmos-Indexers to focus solely on staking rewards and commissions messages.
   • Deploy the indexers across all supported chains using the public RPCs.
   • Implement monitoring and alerting for the indexers to ensure consistent operation and data accuracy.

3. Front-End Development:

   • Dashboard Design:
     • Build a simple front-end dashboard that allows users to connect their Keplr wallet or input an address to view staking rewards.
     • Provide a clear and intuitive user interface, similar to Sycamore Tax, with a focus on usability and accessibility.
   • Integration with Database:
     • Ensure that the front-end can query the database for staking rewards and display the results to users in real-time.
     • Support multiple address inputs and display combined staking rewards if needed.

4. API Integration:

   • Leverage the existing open-source projects, Cosmos Tax CLI and Cosmos Tax CLI Web, to allow users to request staking rewards data in various formats (e.g., CSV).
   • Implement API endpoints that can handle requests for staking rewards data, allowing users to receive data in formats like cryptotaxcalculator.

5. Testing:

   • Perform thorough testing of the indexer deployments to ensure accurate data collection across all chains.
   • Test the front-end dashboard with various user inputs (e.g., different wallet addresses, multiple addresses) to ensure correct data display and user experience.
   • Validate the API responses to ensure they are accurate and in the correct format for different use cases.

6. Documentation:

   • Document the setup and deployment process for the indexers, including how to add new chains or update existing ones.
   • Provide user documentation for the front-end dashboard, including how to connect wallets, input addresses, and interpret the displayed data.
   • Include API documentation for developers who want to integrate with the staking rewards service.

Resources:

• Cosmos-Indexer GitHub Repository
• Cosmos Chain Registry GitHub Repository
• Sycamore Tax
• Cosmos Tax CLI GitHub Repository
• Cosmos Tax CLI Web GitHub Repository

Acceptance Criteria:

• The indexers are deployed and successfully collecting staking rewards and commissions data across all supported Cosmos chains.
• A user-friendly dashboard is available, allowing users to connect their Keplr wallet or input an address to view staking rewards.
• API endpoints are operational and provide accurate staking rewards data in multiple formats.
• The system is fully tested, documented, and ready for production use.