SIDAN - Cardano Devkit - Blueprint Parser & VSCode Plugin

[GENERAL] Name and surname of main applicant

SIDAN Lab

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

Entity (Incorporated)

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

5

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

Develop a VSCode extension featuring Aiken, Vodka, Mesh, and Whisky code snippets, along with a blueprint parser to streamline Cardano development and enhance developer productivity.

[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

All materials would be on (an) open source Github repo(s) with Apache-2.0 license.

[METADATA] Horizons

Developer Tools

[SOLUTION] Please describe your proposed solution

The proposed solution aims to develop a comprehensive Cardano Devkit VSCode Extension that helps developers write on-chain and off-chain code efficiently using Aiken, Vodka, Mesh, and Whisky code snippets, along with CIP57-compliant blueprint parsing functionality.

• The code snippet would reference to the common design patterns as suggested by all the open source libraries involved, making sure get the users or developers up-to-speed developing on Cardano with ease and accuracy.
• Setting up the groundwork for Cardano Devkit VSCode extension. An extensive part of the delivery of this proposal is to set up the VSCode extension of Cardano Devkit. In the future when there is more open-source libraries collaborating with Cardano Devkit, they could enjoy all the groundworks done by these proposals, i.e. they could for example add code snippets with other libraries with minimal efforts, setting ground for future easier open-source collaboration.
• Contributing to a larger community open source software - Cardano Devkit. The development effort of this proposal will be built on the community-maintained repository but not an own version of the tool, to avoid scattered community contribution.

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

Boosting Developer Productivity

The Cardano Devkit VSCode extension will significantly improve developer efficiency, providing tools to streamline both on-chain and off-chain coding processes. This will result in faster project delivery and an overall increase in the quality of Cardano-based dApps.

Fostering Innovation

By providing easy-to-use code snippets and a blueprint parser, this project lowers the technical barriers for developers. This encourages more participation from both seasoned developers and newcomers, fostering innovation across the Cardano ecosystem.

Strengthening Open-Source Collaboration

As an open-source initiative, the project invites the global Cardano community to contribute and improve the tools, ensuring long-term sustainability and continuous development. This collaboration strengthens the overall infrastructure of the Cardano developer 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?

Trust and Accountability

SIDAN Lab is dedicated to advancing the Cardano ecosystem through active contributions to open-source projects. Our team plays a key role in developing and maintaining projects such as Vodka, Whisky, and MeshJS, ensuring tools are accessible and adaptable for the community. Collaborating with leading projects like Andamio and Maestro, we are deeply committed to fostering transparency, education, and community-driven innovation in blockchain development.

Approach Validation

Our contributions to Vodka and Whisky, used across Cardano, validate our approach to building reliable, community-oriented tools. These projects demonstrate our commitment to creating robust and scalable open-source solutions.

Technical Approach Feasibility Research

SIDAN Lab’s technical feasibility is grounded in its open-source ethos, with all major projects being publicly available for review, testing, and collaboration. This ensures continuous improvement and security, backed by transparency and public audits.

Feasibility:

• The project will be implemented in a phased approach, with each phase focusing on delivering practical developer tools, such as code snippets and blueprint parsing, which will be validated through community feedback.
• Our team is composed of skilled developers and educators who understand the nuances of blockchain development, ensuring the project stays on track.
• All source code will be publicly available, allowing for continuous feedback and improvement from the wider Cardano community.
• The scope of the development of this proposal is identified as an area that needs collaborative contribution by the engineers at the engineering department of Cardano Foundation, who will provide necessary support but not engineering efforts in delivering the milestone. As a declaration in the potential conflict of interests, the Cardano Foundation or the engineers of Cardano Foundation will not share any of the funds granted by this proposal.

Open Source Project Contribution:

https://github.com/sidan-lab/vodka

https://github.com/sidan-lab/whisky

https://github.com/MeshJS/mesh

https://x.com/HinsonSIDAN/status/1829091343186178293

https://x.com/AndamioPlatform/status/1827010443346399423

https://x.com/GoMaestroOrg/status/1770853383559106806

Apart from open source contribution, we organise educational workshops and networking events below:

Cardano Summit 2024 - Cardano Community Events Organiser

https://x.com/Cardano_CF/status/1830996737093431760

Workshop:

https://x.com/sidan_lab/status/1832435052892057756

https://x.com/sidan_lab/status/1843283766162415690

https://x.com/HinsonSIDAN/status/1835544062465884523

https://x.com/sidan_lab/status/1834428644158320887

https://x.com/sidan_lab/status/1833882298711945280

https://x.com/sidan_lab/status/1829148308163686807

https://x.com/Waffle_Capital/status/1839140102163018208

https://x.com/Waffle_Capital/status/1762664453911216621

https://x.com/Waffle_Capital/status/1778647348010508759

Community meetup:

https://x.com/sidan_lab/status/1803831962878251360

https://x.com/sidan_lab/status/1777377206274249038

https://x.com/cwpaulm/status/1786026712880304437

https://x.com/sidan_lab/status/1829148308163686807

https://x.com/SIDANWhatever/status/1768592384185811205

Builder meetup:

https://x.com/HinsonSIDAN/status/1838258467423035643

https://x.com/jinglescode/status/1835974464879972526

Interviews:

https://x.com/astroboysoup/status/1753419416275124324

https://x.com/astroboysoup/status/1802673542485712951

https://x.com/cwpaulm/status/1788962110656971173

https://x.com/dapp_central/status/1754504114321436829

https://x.com/_MrHunt_/status/1777370848673902929

https://x.com/_MrHunt_/status/1783875170718925187/photo/1

https://x.com/_MrHunt_/status/1788228931591540959

IdeaFest:

https://x.com/sidan_lab/status/1808817394514866510

AMA:

https://x.com/sidan_lab/status/1810361746797801919

https://x.com/SociousDAO/status/1808305281694327019

https://x.com/monsterblockhk/status/1787733450528530752

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

Milestone 1: Preparation and Organization Setup (1 Month)

Objective:

• Establish a solid foundation for the project by setting up the necessary infrastructure, assembling the team, and defining project management practices.

Activities:

• Set up legal and administrative frameworks.
• Confirm core team members and advisors.
• Establish project management tools.

Acceptance Criteria:

• Legal entity established and operational.
• Public announcement on core team members and advisors.
• Project management tools and systems set up.

Milestone 2: VSCode Extension Phase 1 - Aiken & Vodka Code Snippet (1 month)

Objective:

• To start the Cardano Devkit VSCode extension development with Aiken & Vodka code snippet as the first feature, assisting Cardano developers to build onchain code efficiently.

Activities:

• Configure and publish the VSCode extension
• Build the feature for Aiken & Vodka code snippets in the VSCode extension

Acceptance Criteria & Evidence:

• A published Cardano Devkit VSCode extension with Aiken validator and vodka code snippet supports
• Source code provided by public Github link

Milestone 3: VSCode Extension Phase 2 - Mesh & Whisky Code Snippet (1 month)

Objective:

• To continue developing the Cardano Devkit VSCode extension with Mesh & Whisky code snippet supports, assisting Cardano developers to build offchain code efficiently.

Activities:

• Build the feature for Mesh & Whisky code snippets in the VSCode extension

Acceptance Criteria & Evidence:

• A published Cardano Devkit VSCode extension with Mesh and Whisky code snippet supports covering basic patterns like unlocking from validators.
• Source code provided by public Github link

Milestone 4: VSCode Extension Phase 3 - Blueprint Parser (1 month)

Objective:

• To continue developing the Cardano Devkit VSCode extension with blueprint supports, assisting Cardano developers to parse CIP57-compliant blueprints.

Activities:

• Enhance the Cardano Devkit VSCode extension with blueprint parsing command supports, into code file with Mesh and Whisky types.

Acceptance Criteria & Evidence:

• A published Cardano Devkit VSCode extension with blueprint parser supports in Mesh and Whisky.
• Source code provided by public Github link

Final Milestone: Documentation and Closeout Report (1 month)

Objective:

• To wrap the proposal delivery and provide guidance on others whoever want to deploy the whole set of development to its respected community

Activities:

• Provide documentation on the Cardano Devkit VSCode extension. Also setup contribution guidelines for further collaboration across the community
• Prepare the close-out report

Acceptance Criteria & Evidence:

• Documentation served at the public Github repository with link provided
• Publicly accessible closeout report

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

SIDAN Lab

A Hong Kong based technical solution provider, specializing in Cardano development. SIDAN Lab builds open-source toolings for the Cardano community, and operates the SIDAN stake pool.

• F12 Team Introduction Video: https://x.com/sidan_lab/status/1806306004902277397
• A Hong Kong based technical solution provider, specializing in Cardano development. SIDAN Lab builds open-source toolings for the Cardano community, and operates the SIDAN stake pool.
• The team is assembled of mixed skills and Interdisciplinary experts.
• SIDAN Lab would provide technical support, local network, and execution.
• DRep ID: drep1vkg4qhqt6pyzmtxpvvtjkueak4d7pydsmxz5lwllr53nwezunhg
• DRep Github: https://github.com/sidan-lab/DRep
• Intersect Enterprise Founding Member 

Hinson Wong - Cardano Software Engineer

• Co-founder of DeltaDeFi - https://x.com/deltadefi
• Co-founder of SIDAN Lab - https://x.com/sidan_lab
• Team member of Gimbalabs, driving Hong Kong community
• Key contributor to MeshJS, a Cardano SDK for DApp development
• Lead developer at Cardano Name Service (CNS)
• Ex-Citi, Chartered Financial Analyst (CFA)
• LinkedIn: https://www.linkedin.com/in/hinsonwong/
• Github: https://github.com/hinsonsidan
• Twitter: https://x.com/hinsonsidan

Tsz Wai - Cardano Software Engineer

• Software Engineer of SIDAN Lab - https://x.com/sidan_lab
• Key contributor to MeshJS, a Cardano SDK for DApp development
• Github: https://github.com/twwu123

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

Milestone 1: Preparation and Organization Setup (1 Month)

Activities:

• ADA 20,000 - Set up legal and administrative frameworks.
• ADA 5,000 - Confirm core team members and advisors.
• ADA 15,000 - Establish project management tools.

Total budget: ADA 40,000

Milestone 2: VSCode Extension Phase 1 - Aiken & Vodka Code Snippet (1 month)

Activities:

• ADA 20,000 - Configure and publish the VSCode extension
• ADA 20,000 - Build the feature for Aiken & Vodka code snippets in the VSCode extension

Total budget: ADA 40,000

Milestone 3: VSCode Extension Phase 2 - Mesh & Whisky Code Snippet (1 month)

Activities:

• ADA 40,000 - Build the feature for Mesh & Whisky code snippets in the VSCode extension

Total budget: ADA 40,000

Milestone 4: VSCode Extension Phase 3 - Blueprint Parser (1 month)

Activities:

• ADA 40,000 - Enhance the Cardano Devkit VSCode extension with blueprint parsing command supports, into code file with Mesh and Whisky types.

Total budget: ADA 40,000

Milestone 5: Documentation and Closeout Report (1 month)

Activities:

• ADA 35,000 - Provide documentation on the Cardano Devkit VSCode extension. Also setup contribution guidelines for further collaboration across the community
• ADA 5,000 - Prepare the close-out report

Total budget: ADA 40,000

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

This project represents strong value for money by creating essential tools that streamline Cardano development. By providing a comprehensive VSCode extension with code snippets and a blueprint parser, we are giving developers efficient solutions that reduce coding complexity and time, allowing for faster development within the ecosystem.

The project is also open-source, meaning that once developed, it will continue providing value to the community without additional costs. Developers across the ecosystem can contribute and extend the functionality, ensuring long-term sustainability and usage.

Leveraging SIDAN Lab’s experience with community-driven development and our history of successful open-source contributions, we minimize the risk of project mismanagement. Our extensive collaborations with established Cardano projects like Mesh and Whisky ensure that the tools we build are aligned with community needs, making the investment impactful.

By integrating the latest development frameworks like Aiken, Vodka, Mesh, and Whisky, the project addresses critical needs in both on-chain and off-chain development. This maximizes the return on investment by offering solutions that are essential for a broad range of developers.

Overall, the requested funds will deliver high-impact tools that accelerate the adoption and expansion of Cardano’s developer ecosystem, fostering growth and innovation in a scalable and sustainable way.