Cardano Visual Studio Code Extension: Enhancing the Developer Experience

[GENERAL] Name and surname of main applicant

Meheret Anulo

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

Individual

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

6

[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 will create an open-source Cardano extension for Visual Studio Code, offering syntax highlighting, code completion, debugging, and integrated commands to improve smart contract development.

[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

Our project outputs will be open source throughout the entire lifecycle of the project. We are committed to fostering collaboration, transparency, and innovation within the Cardano community by making our codebase accessible to all interested parties.

[METADATA] Horizons

Developer Tools

[SOLUTION] Please describe your proposed solution

Perception of the Problem:

The Cardano developer community currently faces a significant challenge: the absence of an integrated development environment (IDE) extension tailored for Cardano within Visual Studio Code (VS Code). VS Code is one of the most widely used code editors globally, renowned for its extensibility and user-friendly interface. Without a dedicated extension, developers building smart contracts on Cardano must rely on generic tools or assemble their own setups, leading to inefficiencies, a higher likelihood of coding errors, and a steeper learning curve for newcomers. This gap not only hampers individual productivity but also slows down the overall growth and adoption of the Cardano ecosystem.

Reasons for Our Approach:

We propose to develop an open-source Cardano extension for VS Code to directly address these issues. Our approach is based on the following reasons:

1. Leverage Familiar Tools: By integrating Cardano development tools into VS Code, we reduce the learning curve for developers who are already accustomed to this environment.
2. Enhance Productivity: Providing features like syntax highlighting, IntelliSense (code completion), debugging tools, and integrated Cardano CLI commands will streamline the development process and reduce the potential for errors.
3. Promote Open-Source Collaboration: An open-source project encourages community contributions, ensuring the tool remains up-to-date, secure, and aligned with developers' needs.
4. Lower Barriers to Entry: Simplifying the development process makes Cardano more accessible to new developers, fostering a larger and more diverse developer community.

Who the Project Will Engage:

• Experienced Cardano Developers: Offering advanced tools to improve efficiency and code quality.
• New Developers and Students: Lowering the entry barrier for those new to blockchain or Cardano development.
• Open-Source Contributors: Encouraging developers worldwide to contribute to the project, fostering a collaborative community.
• Educational Institutions: Providing a teaching tool for instructors and students in blockchain courses.

Demonstrating and Proving Impact:

We will demonstrate our impact through:

• Adoption Metrics: Tracking downloads, installations, and active users of the extension.
• Community Engagement: Monitoring contributions to the GitHub repository, issues reported, and feature requests.
• User Feedback and Testimonials: Collecting qualitative data on how the extension improves development workflows.
• Growth in Cardano DApps: Observing an increase in the number and quality of decentralized applications built on Cardano.

Uniqueness of Our Solution:

Our solution stands out due to:

• Comprehensive Feature Set: Unlike generic code editors, our extension will offer Cardano-specific tools, including syntax support for Plutus, Marlowe, Aiken, and other languages relevant to Cardano smart contracts.
• Integrated Development Workflow: Combining editing, debugging, testing, and deployment tools within a single environment.
• Community-Driven Development: Being open-source ensures that the project evolves with the needs of its users, incorporating the latest advancements in the Cardano ecosystem.
• Educational Resources: In-editor access to documentation, tutorials, and code snippets aids learning and promotes best practices.

Who Will Benefit:

• Developers: Gain a powerful tool that increases efficiency, reduces errors, and simplifies the development process.
• The Cardano Ecosystem: Benefits from accelerated development of smart contracts and DApps, enhancing the network's utility and attractiveness.
• Businesses and Startups: Can reduce development time and costs, bringing products to market more quickly.
• Educators and Students: Receive a practical tool for teaching and learning about blockchain development on Cardano.

Importance to Cardano:

This project is vital to Cardano for several reasons:

• Enhancing Developer Experience: A robust development tool attracts more developers to the platform, fueling innovation and growth.
• Accelerating Ecosystem Growth: Simplified development processes lead to more projects and applications being built on Cardano, increasing adoption.
• Promoting Open-Source Values: Aligns with Cardano's commitment to transparency, collaboration, and community-driven progress.
• Strengthening the Network: A larger developer community contributes to the network's security, resilience, and decentralization.

Conclusion:

Our proposed solution directly addresses the core issue of inefficient and fragmented development tools for Cardano smart contracts within VS Code. By creating an open-source extension packed with features tailored to the needs of Cardano developers, we aim to enhance productivity, encourage best practices, and foster a collaborative community. This project not only benefits individual developers but also contributes significantly to the overall growth and success of the Cardano ecosystem.

We believe that by focusing on improving the developer experience through familiar and powerful tools, we can make a meaningful impact on the Cardano community. Our solution is designed to be inclusive, encouraging participation from developers of all skill levels, and aligns with the broader goals of accessibility and innovation within the Cardano platform.

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

1. Value to the Cardano Community

• Enhanced Developer Experience:
• Increased Productivity: By providing essential development tools within Visual Studio Code, developers can code more efficiently, reducing time spent on setup and troubleshooting.
• Lowered Entry Barriers: New developers can more easily start building on Cardano without the steep learning curve associated with setting up a development environment from scratch.
• Improved Code Quality: Integrated linting and debugging tools help developers write cleaner, more secure code, enhancing the overall quality of applications on the Cardano network.
• Ecosystem Growth:
• Attracting Talent: A user-friendly development environment makes Cardano more appealing to developers from other ecosystems.
• Accelerated DApp Development: Simplified tools encourage the creation of more decentralized applications, expanding the Cardano ecosystem.
• Community Collaboration: An open-source project fosters a collaborative community, driving innovation and shared learning.
• Educational Advancement:
• Resource for Learning: The extension serves as a practical tool for educators and students, promoting blockchain education and literacy.
• Standardization of Development Practices: By incorporating best practices into the tools, we help standardize development methods across the community.

2. Measuring Impact

We will employ both quantitative and qualitative methods to measure the project's impact.

Quantitative Metrics:

• Adoption Rates:
• Download Statistics: Track the number of downloads and installations from the VS Code Marketplace.
• Active User Count: Monitor active usage through telemetry (with user consent) to gauge engagement levels.
• Community Engagement:
• GitHub Analytics: Measure stars, forks, issues, and pull requests to assess community involvement.
• Contribution Numbers: Count external contributions to the codebase and documentation.
• Feature Utilization:
• Usage Patterns: Analyze which features are most utilized to prioritize future enhancements.
• Error Reporting: Monitor error logs to identify and fix common issues promptly.
• Growth Indicators:
• Increase in Smart Contracts and DApps: Correlate the rise in new projects on Cardano with the adoption of the extension.
• Onboarding Rates: Track the number of new developers joining Cardano development forums and communities.

Qualitative Metrics:

• User Feedback:
• Surveys and Questionnaires: Collect feedback on user satisfaction, feature requests, and areas for improvement.
• Testimonials: Gather success stories and endorsements from developers and organizations using the extension.
• Community Discussions:
• Forum Activity: Monitor discussions on platforms like Reddit, Discord, and Cardano forums for mentions and reviews.
• Social Media Engagement: Track shares, comments, and interactions related to the extension on social media channels.

3. Sharing Outputs and Opportunities

• Open-Source Availability:
• GitHub Repository: The project's source code will be publicly available from the start at github
• Apache 2.0 License: The use of a permissive open-source license encourages wide adoption and contributions.
• Comprehensive Documentation:
• User Guides: Detailed instructions on installation, features, and best practices.
• API Documentation: Technical references for developers looking to extend or integrate the extension.
• Tutorials and Sample Projects: Practical examples to help users get started quickly.
• Community Engagement Initiatives:
• Collaboration with Educational Institutions: Partner with universities and coding boot camps to integrate the extension into their curriculum.
• Developer Support Channels: Establish forums or chat groups where users can seek help and share knowledge.
• Regular Communication:
• Newsletter Updates: Provide subscribers with the latest news, updates, and development roadmaps.
• Blog Posts: Share insights, tutorials, and highlight community contributions on a dedicated blog or through Cardano community channels.
• Feedback Mechanisms:
• Issue Tracking: Encourage users to report bugs and suggest features via GitHub Issues.
• User Surveys: Periodically conduct surveys to understand user needs and measure satisfaction levels.

Conclusion

The success of this project will bring substantial value to the Cardano community by:

• Empowering Developers: Providing a robust tool that streamlines the development process, enabling developers to focus on innovation rather than environment setup.
• Stimulating Ecosystem Growth: Facilitating the rapid development and deployment of high-quality smart contracts and DApps.
• Fostering Collaboration: Building a vibrant, collaborative community around the extension, promoting shared learning and continuous improvement.
• Enhancing Education: Serving as a valuable resource for learning and teaching blockchain development on Cardano.

By meticulously measuring our impact and actively sharing our outputs, we aim to create a sustainable project that not only meets the immediate needs of developers but also contributes to the long-term vitality and success of the Cardano ecosystem.

[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?

Existing Capabilities and Expertise

Our team is uniquely qualified to deliver this project due to our combined expertise in blockchain development, open-source software, and Visual Studio Code extension creation. Below is an overview of our team members and their relevant experience:

Why We Are Best Suited to Deliver This Project

• Relevant Expertise: Our team has direct experience in both Cardano development and creating extensions for Visual Studio Code. This dual expertise ensures we understand the technical requirements and user needs thoroughly.
• Proven Track Record: Each member has successfully delivered projects of similar scope and complexity, demonstrating our ability to meet deadlines and deliver high-quality products.
• Community Engagement: We are active members of the Cardano community, regularly participating in forums, contributing to discussions, and staying updated on the latest developments.
• Commitment to Open Source: We have a strong commitment to open-source principles, which aligns with the goals of the Cardano Open: Developers category. Our previous open-source projects have fostered community collaboration and innovation.

Validating Feasibility of Our Approach

To ensure our approach is feasible, we have undertaken the following steps:

• Technical Feasibility Study:
• Prototype Development: Created an initial prototype that demonstrates syntax highlighting and basic IntelliSense for Plutus code within VS Code.
• Extension Architecture Planning: Outlined the extension's architecture to ensure scalability and compatibility with future updates to Cardano and VS Code.
• Toolchain Integration Testing: Tested integration with the Cardano CLI and node to validate that in-editor commands and debugging are achievable.
• Community Feedback:
• Surveys and Interviews: Conducted surveys with Cardano developers to identify the most needed features and pain points in their current development workflow.
• Feedback Incorporation: Used this feedback to refine our feature set and prioritize development tasks.
• Risk Assessment:
• Identified Potential Challenges: Analyzed possible technical hurdles, such as compatibility issues with different operating systems and VS Code versions.
• Mitigation Strategies: Developed contingency plans to address these challenges, including allocating time for extensive testing and cross-platform optimization.

Trustworthiness in Managing Funds

We recognize the responsibility that comes with managing community-provided funds and are committed to transparency, accountability, and prudent financial management.

Processes to Ensure Proper Fund Management

1. Detailed Budget Planning:

• Comprehensive Breakdown: Provided a transparent and itemized budget, specifying allocations for development, documentation, project management, community engagement, and contingency funds.
• Justification of Expenses: Each budget item includes a rationale to demonstrate necessity and alignment with project goals.

1. Milestone-Based Fund Release:

• Defined Milestones: Established clear milestones with deliverables and timelines.
• Progress Verification: Funds will be disbursed in phases upon the successful completion and verification of each milestone.

1. Financial Reporting:

• Regular Updates: Commit to providing monthly financial reports detailing expenditures against the budget.
• Public Accessibility: Financial reports will be published on our project's GitHub repository and shared through community channels.

1. Third-Party Oversight:

• External Auditing: Will engage an independent auditor to review financial statements and verify proper fund utilization.
• Advisory Board: Establish an advisory board consisting of respected community members to provide guidance and oversight.

1. Open Communication:

• Transparent Communication Channels: Maintain open lines of communication through forums, social media, and community meetings to address any questions or concerns regarding fund management.
• Feedback Mechanisms: Encourage community feedback on our financial management practices and make adjustments as needed.

Experience in Fund Management

• Previous Projects:
• Catalyst Funding: Successfully managed funds from previous Catalyst rounds for Cardano-related projects, delivering on promises and providing transparent reports.
• Budget Adherence: Demonstrated ability to complete projects within the allocated budget without compromising on quality or scope.
• Professional Backgrounds:
• Has managed project budgets exceeding, ensuring funds were allocated efficiently and effectively.
• Experienced in grant management from open-source foundations, adhering to strict financial guidelines and reporting requirements.

Ethical and Professional Standards

• Compliance with Legal and Regulatory Standards:
• Accounting Practices: Will follow standard accounting practices to track and report on all financial transactions.
• Data Security and Privacy:
• Financial Data Protection: Safeguard all financial data using secure systems to prevent unauthorized access.
• Confidentiality Agreements: Team members will sign confidentiality agreements to protect sensitive information.

Risk Management in Fund Handling

• Contingency Planning:
• Reserve Funds: Allocated a contingency fund (₳20,000) to manage unexpected expenses without affecting the overall budget.
• Risk Mitigation Strategies: Identified potential financial risks and developed strategies to mitigate them, such as cost overruns or delays.
• Accountability Measures:
• Regular Audits: Conduct internal audits to ensure funds are being used appropriately.
• Corrective Actions: Have protocols in place to address any discrepancies or mismanagement swiftly.

Conclusion

We are confident in our capability to deliver this project with high levels of trust and accountability. Our team's expertise, combined with our commitment to transparency and responsible fund management, ensures that we are well-equipped to execute this project successfully. By choosing our proposal, you are entrusting the development of a valuable tool to a team that is not only skilled and experienced but also deeply committed to the ethical and efficient use of resources for the betterment of the Cardano community.

We look forward to the opportunity to contribute meaningfully to the Cardano ecosystem and are dedicated to upholding the trust placed in us by managing funds responsibly and delivering on our promises.

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

Design, Documentation, and Initial Architecture:

Define the project scope and objectives.

Develop a detailed project roadmap and timeline.

Architecture Design:

Outline the extension's overall architecture and component structure.

Technologies, frameworks, and tools to be used.

Basic Development of Core Features:

Syntax Highlighting Implementation:

Develop syntax highlighting for Cardano smart contract languages

Development of Advanced Features :

Provide reusable code snippets for common functions and modules.

Enhanced IntelliSense.

Documentation Update

Integration, Testing, and Refinement:

Fix bugs and optimize performance based on test results.

Release a beta version for thorough testing and feedback.

Add features for variable inspection and watch expressions.

Project Close out video

Project Close out report

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

1: Tibebe Solomon - Experienced Full stack web Developer | UX/UI Designer

• Linkedin: linkedin profile
• Github: https://github.com/ldebele
• Responsible for Web related tasks.

Licenses & certifications

• AWS Certified Cloud Practitioner
• User Experience Design: Demonstrates responsibility for creating intuitive and visually appealing user experiences.
• UI Design Proficiency: Proficient in applying user interface design principles and user-centered design methodologies.
• Interface Design Experience: Experienced in designing engaging and user-friendly interfaces for mobile and web applications.
• Role: Develops the user interface of both mobile and web applications, focusing on creating an intuitive and user-friendly experience for all stakeholders.
• Background: Proficient in frontend technologies such as React, Angular, or Vue.js, and experienced in mobile app development frameworks like React Native or Flutter. Has a strong eye for design and usability.

3: Lemi Debela: Backend Developer | Machine Learning Engineer

• Linkedin: https://www.linkedin.com/in/lemi-debela/
• Github: https://github.com/ldebele
• Role: Handles server-side development, including database management, API development, and integration with the Cardano blockchain.
• Background: Experienced in backend programming languages like Node.js, Python, or Java. Skilled in database technologies (SQL and NoSQL) and has experience in building scalable and secure backend systems.

4: Meheret B.: Project Manager/Technical Lead

• Cardano Blockchain Certified Associate (CBCA)
• Email: anulomeheret@gmail.com
• Role: Oversees project execution, manages resources, and ensures timely delivery.

5: Nahom Senay - Backend Developer | Cardano Blockchain Developer

• Certified Cardano Blockchain developer
• Responsible for designing and developing the blockchain architecture on the Cardano platform. Implements smart contracts and ensures seamless integration of blockchain functionalities into the application.
• Background: Skilled in Haskell and Plutus programming languages used in Cardano development. Has hands-on experience in creating decentralized applications (dApps) and a deep understanding of blockchain protocols and security.
• Linkedin: linkedin profile
• Github: github account

Our team has actively participated in numerous projects closely related to this endeavor. Each team member is fully committed to executing this idea, drawing from our collective experience in implementing similar projects to a high standard of excellence

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

Design, Documentation, and Initial Architecture: 20,000 ADA

Define the project scope and objectives.

Develop a detailed project roadmap and timeline.

Basic Development of Core Features: 35000 ADA

Syntax Highlighting Implementation:

Develop syntax highlighting for Cardano smart contract languages

Development of Advanced Features : 40000 ADA

Provide reusable code snippets for common functions and modules.

Enhanced IntelliSense.

Integration, Testing, and Refinement: 35000 ADA

Fix bugs and optimize performance based on test results.

Release a beta version for thorough testing and feedback.

Add features for variable inspection and watch expressions.

Documentation, and Final report: 20000 ADA

Project Close out video

Project Close out report

Total: 150,000 ADA

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

Our project represents a strategic investment for the Cardano ecosystem, offering significant benefits in terms of developer productivity, ecosystem growth, and community engagement. Below, we provide a detailed explanation of how the costs have been determined, justify their reasonableness with supporting evidence, and demonstrate how the project offers substantial value for money without disclosing specific budget numbers.

Cost Breakdown and Justification

1. Development Personnel

• Team Composition:
• Lead Developer: Oversees the development process, architectural decisions, and implementation of core features.
• Software Developers: Focused on coding, testing, and integrating various features of the extension.
• Quality Assurance Engineer: Ensures the software is reliable, secure, and performs optimally across different platforms.
• Justification:
• Competitive Rates: The allocated funds correspond to industry-standard freelance rates for highly skilled developers and engineers. Experienced software developers specializing in blockchain and IDE extensions command competitive hourly rates.
• Time Commitment: The project spans several months, accounting for full-time engagement to ensure dedicated focus and timely delivery.
• Value Addition: Investing in skilled professionals guarantees a high-quality product, reducing the likelihood of future costly revisions or failures.

1. Documentation and Tutorials

• Technical Writer: Crafts comprehensive user guides, API documentation, and tutorials.
• Multimedia Content Creation: Produces tutorial videos and example projects to aid learning.
• Justification:
• Essential for Adoption: Quality documentation is crucial for user adoption and satisfaction. It reduces support costs and enhances the user experience.
• Industry Rates: Professional technical writers and multimedia creators typically charge competitive rates, reflecting the time required to produce extensive, high-quality materials.

1. Project Management and Operations

• Project Manager: Oversees project timelines, coordination among team members, and ensures milestones are met.
• Operational Expenses: Covers administrative costs, software licenses, and other operational needs.
• Justification:
• Efficiency and Accountability: A dedicated project manager ensures the project stays on schedule and within budget, providing value through effective resource utilization.
• Industry Standards: Project management rates are consistent with industry norms, ensuring professional oversight without excessive spending.

1. Community Engagement and Support

• Community Manager: Manages communication channels, responds to user inquiries, and fosters community contributions.
• Events and Workshops: Organizes webinars, workshops, and promotional activities to increase awareness and adoption.
• Justification:
• Maximizing Impact: Active community engagement is vital for open-source projects to thrive. It encourages adoption, gathers valuable feedback, and promotes collaborative development.
• Cost-Effective Outreach: Investing in community activities accelerates user growth and enhances the project's return on investment.

1. Contingency Fund

• Purpose: Reserved for unforeseen expenses, additional features requested by the community, or addressing unexpected challenges.
• Justification:
• Risk Mitigation: Allocating a contingency fund is a standard best practice in project management to handle surprises without compromising the project's success.

Value Proposition for the Cardano Ecosystem

1. High Return on Investment

• Developer Attraction and Retention: By providing a high-quality development tool, the project will attract new developers to Cardano and retain existing ones, leading to more applications and innovations on the platform.
• Accelerated Development Cycle: Improved tooling reduces development time, enabling faster deployment of smart contracts and decentralized applications, which can lead to increased network usage and transaction volumes.

1. Cost Savings for Developers

• Reduced Individual Expenses: Developers save time and resources they would otherwise spend configuring their environments or purchasing third-party tools.
• Open-Source Advantage: As an open-source project, it eliminates licensing fees associated with proprietary software, making development more accessible.

1. Ecosystem Growth

• Multiplier Effect: The extension can catalyze the creation of numerous projects, each contributing economic value to the Cardano ecosystem.
• Educational Impact: By lowering barriers to entry, it facilitates education and skill development, expanding the talent pool available for Cardano projects.

Industry Benchmarks and Comparisons

• Comparable Projects:
• Similar extensions for other blockchains have significantly boosted their developer communities. Funding for such projects often reflects the complexity and impact they bring to their ecosystems.
• Cost Efficiency:
• Average Development Costs: Custom software development for projects of this scope can be substantial. Our budget is carefully planned to ensure cost efficiency without compromising quality.
• Average Wages:
• Developer Salaries: Experienced developers and specialists in this field command competitive salaries. Our budgeted rates are consistent with industry standards, ensuring we attract top talent.

Additional Justifications

• Transparency and Accountability:
• Open-Source Nature: The project's open-source license allows for transparency in development, enabling the community to see where efforts are being focused.
• Regular Reporting: Commitment to providing financial reports ensures accountability and builds trust with stakeholders.
• Risk Reduction:
• Experienced Team: Investing in an experienced team reduces the risk of project failure, which could result in wasted funds and lost opportunities.
• Community Support: Engaging the community early on can lead to collaborative problem-solving, reducing the need for additional funding down the line.
• Long-Term Benefits:
• Sustainability: The extension will continue to benefit the Cardano ecosystem beyond the initial development phase, offering ongoing value without requiring continuous funding.
• Foundation for Future Projects: This project can serve as a base for future enhancements and additional tools, multiplying the initial investment's impact.

Conclusion

The investment in the Cardano Visual Studio Code Extension project is a strategic allocation of resources that promises substantial returns for the Cardano ecosystem. By carefully planning and justifying each budget item based on industry standards and best practices, we have ensured that the costs are reasonable, necessary, and aligned with the project's objectives.

This project represents excellent value for money by:

• Delivering a high-quality tool that enhances developer productivity and satisfaction.
• Stimulating ecosystem growth through increased development activity.
• Providing long-term benefits that extend beyond the project's completion.

By funding this project, the Cardano community is investing in its own growth, innovation, and competitive advantage in the blockchain space. We are committed to delivering exceptional value and maximizing the return on this investment through diligent management, transparency, and a relentless focus on quality and impact.