Open-source Hydra Head L2 Web based Explorer and API

[GENERAL] Name and surname of main applicant

Catalyst Rider

[GENERAL] Are you delivering this project as an individual or as an entity (whether formally incorporated or not)

Entity (Incorporated)

[GENERAL] Requested funds in ada

180000

[GENERAL] Please specify how many months you expect your project to last (from 2-12 months)

4

[GENERAL] Please indicate if your proposal has been auto-translated into English from another language

No

[GENERAL] Summarize your solution to the problem (200-character limit including spaces)

We propose a web-interface with API showing the ledger state, transactions and more. Developers will not need to parse the text output, but will be able to see the data in a Web UI or using API calls.

[GENERAL] Does your project have any dependencies on other organizations, technical or otherwise?

No

[GENERAL] If YES, please describe what the dependency is and why you believe it is essential for your project’s delivery. If NO, please write “No dependencies.”

No dependencies

[GENERAL] Will your project’s output/s be fully open source?

Yes

[GENERAL] Please provide here more information on the open source status of your project outputs

The Hydra Head L2 Web Explorer will be in an open-source GitHub repository making it freely accessible to all developers.

Type of license: MIT

[SOLUTION] Please describe your proposed solution

Our proposed solution addresses the issue of limited user-friendliness in monitoring the Hydra Head’s inner state and its transactions. Currently, developers using Hydra have to rely on a CLI output when connecting to a Hydra node via WebSocket, which may be harder to read and more complicated to understand.

What makes the proposed solution unique is its simple usage and readability. The solution offers an opportunity to reduce the entry barrier for leveraging Cardano's Hydra Heads solution. By simplifying the onboarding process and streamlining the development environment, we empower a broader spectrum of developers to harness the potential of Hydra Heads. The increased utilization of Hydra Heads on the L1 network enhances scalability and amplifies its visibility and credibility within the blockchain community.

We’ll approach this problem by creating an open-source light-weight Web Explorer that Hydra node hosts can run alongside their node. This Web Explorer lists all the necessary data related to the Hydra node it is connected to, like carried-out transactions inside the head, parties involved, balances, network metrics, and more in an easily readable conventional format normalized in blockchain explorers. This makes it easier to visualize what is happening inside a Hydra Head, thus making it easier to debug your dApp leveraging Hydra and work with Hydra overall. We also propose including API endpoints, for programmatic access to the explorer data.

The primary beneficiaries of this project are dApp developers wanting to leverage Cardano's Hydra Heads. Developers will be able to run this tool effortlessly, without a complex setup to harness the power of Hydra 🐉. Users will benefit from the more widespread use of scalability solutions on Cardano, moving some transactions to L2. Also, users interacting with projects using L2 may save on transaction fees when making many transactions, given the Hydra operators can set transaction fees to zero inside the Head.

Our impact will be demonstrated through the explorer's adoption and positive feedback from the Cardano community. We plan to track metrics related to the tool's usage, like the number of repository visitors, stars, and most importantly feedback from developers.

[IMPACT] Please define the positive impact your project will have on the wider Cardano community

The positive impact of our project on the Cardano community will manifest through the increased accessibility to develop on Hydra and potentially increase the utilization of such scalability solutions, lowering the strain on the Cardano L1.

Value to the Cardano Community:

• Increased Adoption: Tools making development on Hydra more convenient attract more developers increasing the Hydra Head's utilization. Also, the existing developers will have it easier to navigate through the current L2 state.
• Cardano Scalability: With more projects looking into using scalability solutions like Hydra Head, the strain on the main L1 chain will be lower.
• Increased Transparency: Hydra Head operators can host the explorer publicly, so everyone can see what is happening in the said Hydra Head.

Measuring Impact:

• Quantitative Measures: We will track the number of visitors, stars, and clones of the project, and collect developer feedback.
• Qualitative Measures: Developer testimonials will provide insights into how the web explorer improves developer experience. Developer feedback will also guide further refinements.

Sharing Outputs and Opportunities:

• Community Engagement: We will maintain an active presence in Cardano community forums and social media platforms, sharing updates and engaging with users and developers.
• Documentation and Tutorials: Comprehensive documentation will be published to facilitate easy use of the Hydra Head L2 Web Explorer.
• Collaborative Development: The GitHub repository will be open for contributions.

By adopting these strategies, our project aims to deliver tangible benefits to the Cardano community, ensuring our outputs are effectively utilized and contribute positively to the ecosystem's growth.

[CAPABILITY & FEASIBILITY] What is your capability to deliver your project with high levels of trust and accountability? How do you intend to validate if your approach is feasible?

As WingRiders, we have a track-proven record of developing within the Cardano ecosystem. Over the years we’ve shown to be at the forefront of technological advancements when it comes to DEXes and Cardano in general. We were the first ones to bring support for Stableswaps, have a fully on-chain DAO governance, and recently launched the first trustless non-custodial launchpad. Created a lot of open source tooling and continues to push the edge of what is possible with the Cardano chain evolving. Regarding fund management, we adhere to rigorous protocols ensuring robust financial stewardship and accountability. Our practices encompass the maintenance of transparent financial records, periodic internal audits, and strict compliance with financial reporting standards. We understand the imperative nature of prudent fund management and commit to upholding the highest standards of fiscal responsibility throughout the project's lifecycle.

As an evidence, we have 2 Catalyst proposals from F10 and F11 in progress. Both are being delivered according to the milestone schedule and budget , with Proof of Achievement submitted and approved for all completed milestones.

[PROJECT MILESTONES] What are the key milestones you need to achieve in order to complete your project successfully?

 Additional Hydra Research

• Description: Additional research on the individual scenarios that may happen in the Hydra Head - so nothing important is missed in the UI.
• Expected Timeline: 1 month
• Outputs: Detailed initial design documentation for the Hydra Head L2 Web Explorer available in an open-source GitHub repository.
• Acceptance Criteria: Documentation is well-structured describing all planned inner workings in detail.

API development

• Description: Implementation of the API, enabling programmatic access to data.
• Expected Timeline: 1 month
• Outputs: Functional L2 Explorer API code available in the open-source GitHub repository.
• Acceptance Criteria: L2 Explorer API works without any major issues and is available to be used by any Hydra developer.

Explorer Web App development

• Description: Implementation of the Hydra Head L2 Web Explorer, ensuring developer friendliness and ease of use.
• Expected Timeline: 1 month
• Outputs: Functional L2 Web Explorer code available in the open-source GitHub repository.
• Acceptance Criteria: L2 Web Explorer works without any major issues and is available to be used by any Hydra developer.

Documentation

• Description: Create comprehensive documentation and resources to assist developers in using the tool. This will include setup guides, FAQs, and troubleshooting information.
• Expected Timeline: 2 weeks
• Outputs: Developer guides and API documentation available in the open-source GitHub repository.
• Acceptance Criteria: Documentation covers all aspects of the tool's setup, configuration, troubleshooting, and manual for developers using this tool.

Final Project Completion Report and Video

• Description: This milestone focuses on the creation of a final report and a video showcasing the project.
• Expected Timeline: 2 weeks
• Outputs: A detailed final report documenting the project's journey, challenges, solutions, and benefits. A professionally produced video showcasing the Hydra Head L2 Web Explorer usage, complete with voiceover narration.
• Acceptance Criteria: Completion of a thorough and reflective final report. Video that effectively showcases the project is easy to set up and handy.

[RESOURCES] Who is in the project team and what are their roles?

WingRiders engineering team is composed of experienced professionals in blockchain technology and software development. Our team members stand behind projects like Adalite, Yoroi wallet, Emurgo’s first blockchain explorer/indexer, firmware for hardware wallets Trezor and Ledger (bringing them to Cardano), and a whole plethora of FinTech products.

Having done significant innovation explorations on Hydra we are excited to deliver this for other developers to join or just explore the power of hydra far easier than we had to chew through.

[BUDGET & COSTS] Please provide a cost breakdown of the proposed work and resources

Milestone 1: Additional Hydra Research

• Milestone Budget: ₳ 40,000
• Resource MDs: 
• Software engineer (senior & junior):  28
• Project manager: 3

Milestone 2: API development

• Milestone Budget: ₳ 60,000
• Resource MDs: 
• Software engineer (senior & junior): 43
• Project manager: 4

Milestone 3: Explorer Web App development

• Milestone Budget: ₳ 53,000
• Resource MDs: 
• Software engineer (senior & junior): 39
• Project manager: 3

Milestone 4: Documentation

• Milestone Budget: ₳ 20,000
• Resource MDs: 
• Software engineer (senior & junior): 27
• Project manager: 3

Final Milestone: Documentation and Release Preparation, Final Project Completion Report and Video

• Milestone Budget: ₳ 7,000
• Resource MDs: 
• Software engineer: 4
• Marketing: 2
• Project manager: 0,5

[VALUE FOR MONEY] How does the cost of the project represent value for money for the Cardano ecosystem?

The cost of the project is carefully calculated to ensure value for money for the Cardano ecosystem, considering the significant benefits it brings in terms of accessibility, ease of use, and developer experience across the Hydra Head ecosystem. Here’s how we justify the cost:

• Engineering Costs: The costs are based on competitive rates in the software development industry, which are proportional to the average wage for skilled developers in most of developed countries while still not being at the upper quartile. For instance, the rates we've set are aligned with typical freelance rates for developers with blockchain experience.
• Operational and Overhead Costs: These include server costs for testing, project management, and other miscellaneous items necessary for a smooth operation. These costs are in line with standard rates for such services.
• Documentation and Educational Materials: Producing high-quality, comprehensive documentation and tutorials ensures that developers can easily use the tool. This fosters a more inclusive and accessible ecosystem, thereby enhancing the overall value of the project.

By balancing these costs with the projected benefits, the project promises not only to enhance the developer experience with Hydra, but also to promote broader adoption and development. The allocation of funds is structured to maximize return on investment through increased developer satisfaction and participation, making it a worthwhile expenditure for the Cardano community.