[Proposal setup] Proposal title
Please provide your proposal title
SIDAN - Cardano Bar - Aiken Blueprint Parser for VSCode
[Proposal Summary] Budget Information
Enter the amount of funding you are requesting in ADA
100000
[Proposal Summary] Time
Please specify how many months you expect your project to last
5
[Proposal Summary] Translation Information
Please indicate if your proposal has been auto-translated
No
Original Language
en
[Proposal Summary] Problem Statement
What is the problem you want to solve?
Cardano devs hand-parse Aiken blueprints, remap types across TS/Rust, and rewrite boilerplate for tests and tx builders—slowing delivery and causing errors.
[Proposal Summary] Supporting Documentation
Supporting links
[Proposal Summary] Project Dependencies
Does your project have any dependencies on other organizations, technical or otherwise?
No
Describe any dependencies or write 'No dependencies'
No dependencies
[Proposal Summary] Project Open Source
Will your project's outputs be fully open source?
Yes
License and Additional Information
Apache-2.0 license
[Theme Selection] Theme
Please choose the most relevant theme and tag related to the outcomes of your proposal
Developer Tools
[Campaign Category] Category Questions
Mention your open source license and describe your open source license rationale.
We use Apache-2.0 due to below reasons:
- Permissive & enterprise-friendly: Allows commercial use, modification, and redistribution without copyleft—low friction for wallets/exchanges/dApps.
- Patent safety: Explicit patent grant in Apache-2.0 reduces legal risk for adopters and contributors.
- Ecosystem alignment: Matches licensing across other SIDAN Lab repos, simplifying reuse and contributions.
How do you make sure your source code is accessible to the public from project start, and people are informed?
- Day-0 public repo: github.com/sidan-lab/cardano-bar (Apache-2.0); no private phase.
- Quality & cadence: PR-only merges, weekly commits, CI (build/test/lint).
- Releases: CHANGELOG; docs/examples auto-published (GitHub Pages).
- Transparency: Public roadmap via GitHub Issues/Projects with milestones.
- Communications: Release notes + monthly updates on GitHub/Catalyst; announcements on X/Discord with repo link.
How will you provide high quality documentation?
- Where docs live: Repo README (quickstart) + versioned docs site for Cardano Bar (commands, settings).
- Structure: Getting Started in README; module-by-module API reference with constants/functions and examples on the docs pages.
- Standards & tooling: Markdown README; API reference auto-generated and published via GitHub Pages.
- Feedback & transparency: Issues enabled on GitHub for doc improvements.
[Your Project and Solution] Solution
Please describe your proposed solution and how it addresses the problem
Make blueprint parsing a one-click task
- Build two parsers—one for TypeScript and one for Rust—that read an Aiken blueprint and generate typed code for Mesh (TS) or whisky (Rust).
- In VSCode, a single command will create the right types, helpers, and starter files in your project.
- Prove reliability by running the tools on at least one open-source Cardano project and sharing the outcomes.
Start from working examples, not blank files
- Aiken snippets will scaffold validators for spend, mint, and withdraw so you can begin with safe, known patterns.
- vodka/mocktail snippets will spin up matching unit tests and mock transactions.
- Mesh (TS) and whisky (Rust) snippets will prefill TxBuilder flows for spend, mint, and withdraw.
All snippets will be easy to find and insert through Cardano Bar
- Smooth, safe, and well-documented developer experience
- Clear docs and examples will show how blueprints map to generated types and how to adjust when schemas change.
[Your Project and Solution] Impact
Please define the positive impact your project will have on the wider Cardano community
- Ship faster with fewer mistakes: One-click parsing and ready snippets cut setup from days to minutes and reduce type/encoding errors that reach mainnet.
- Unify TS & Rust workflows: The same Aiken blueprint yields consistent Mesh (TS) and whisky (Rust) code, letting mixed-language teams collaborate smoothly.
- Raise code quality & auditability: Standard scaffolds and test starters (vodka/mocktail) make reviews simpler and catch issues earlier.
- Lower the barrier for new devs: VSCode commands plus examples help newcomers build their first validator and tx flows quickly.
- Create reusable building blocks: Apache-2.0 tools and snippets become shared standards others can extend, strengthening ecosystem reuse.
[Your Project and Solution] Capabilities & 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?
Capability & accountability
- Open, shipped, and published: Cardano Bar is fully open-source with tagged releases (latest v0.0.8 on Aug 12, 2025) and a public VSCode Marketplace listing.
- Already useful in the wild: Our TypeScript blueprint parsing engine is the same one used by the Mesh CLI, ensuring consistent outputs across tools.
- Cross-stack maintainers: We actively maintain adjacent SDKs/tools—whisky (Rust), vodka (Aiken testing), and gin (Python)—demonstrating end-to-end capability from on-chain to off-chain.
- Ecosystem trust: The Cardano Foundation selected SIDAN Lab as one of seven DReps for 20M ₳ delegations to developer/builder representatives (May 21, 2025).
Feasibility & validation plan
- Standards-based correctness: We validate against the CIP-57 blueprint spec with golden fixtures and parity tests; CI runs cover spend/mint/withdraw flows.
- Real-project trials: We run the generators on at least one open-source Aiken project (and Mesh examples) to ensure the produced types/Tx builders compile and tests pass; results published in the repo.
- Release hygiene & rollback: Semantic versioning, CHANGELOGs, and GitHub releases; previous extension versions remain available on the Marketplace for quick rollback.
- Adoption signals: Marketplace installs, opt-in command success metrics, external PRs/issues, and continued alignment with Mesh CLI’s engine confirm utility and guide iterative improvements.
[Milestones] Project Milestones
Milestone Title
Preparation and Organization Setup
Milestone Outputs
- Team setup: maintainers/advisors confirmed with roles, responsibilities, and meeting/on-call cadence.
- Communications: public announcement, community channel (Discord/Telegram), X/Twitter post, contributor guidelines.
- Project planning: GitHub Projects roadmap with milestones, labeled issue/PR templates, initial delivery plan.
Acceptance Criteria
- Maintainers/advisors listed with GitHub handles, roles in README/MAINTAINERS.md.
- Repo: public repo live with LICENSE, CODE_OF_CONDUCT.md committed and visible.
- Communications: announcement post published (link in repo), community channel invite in README.
- Project planning: GitHub Projects board active with milestones and actionable issues linked to this milestone.
Evidence of Completion
- Legal entity established and operational
- Link to README/MAINTAINERS.md showing maintainers/advisors roles
- Link to repo tree on main showing LICENSE, CODE_OF_CONDUCT.md.
- Link to public announcement post on X/Twitter/Discord.
- Link to GitHub Projects board with visible milestones and issues for this milestone.
Delivery Month
1
Cost
20000
Progress
20 %
Milestone Title
Feature complete TypeScript Aiken blueprint parser
Milestone Outputs
- Provide VSCode command to quickly parse blueprint into corresponding Mesh blueprint and types code
- Provide documentation of the VSCode command with example on one open source project's Aiken blueprint
Acceptance Criteria
- Develop the feature complete TypeScript Aiken blueprint parser, which parse into Mesh types
- Test against at least 1 open source Cardano project's blueprint
- Document the usage of the TS parser command, with guide on example
Evidence of Completion
- Public link to the developed code on SIDAN Lab Github
- Public link to post on Twitter/X to inform the Public
- Link to SIDAN Lab discord on release announcement
Delivery Month
1
Cost
30000
Progress
50 %
Milestone Title
Feature complete Rust Aiken blueprint parser
Milestone Outputs
- Provide VSCode command to quickly parse blueprint into corresponding whisky blueprint and types code
- Provide documentation of the VSCode command with example on one open source project's Aiken blueprint
Acceptance Criteria
- Develop the feature complete Rust Aiken blueprint parser, which parse into whisky types
- Test against at least 1 open source Cardano project's blueprint
- Document the usage of the Rust parser command, with guide on example
Evidence of Completion
- Public link to the developed code on SIDAN Lab Github
- Public link to post on Twitter/X to inform the Public
- Link to SIDAN Lab discord on release announcement
Delivery Month
1
Cost
30000
Progress
80 %
Milestone Title
Basic code snippets in Aiken, vodka, Mesh and whisky
Milestone Outputs
- Provide basic code snippets for reducing redundant time needed in Cardano development
- The code snippets covering 4 aspects: Aiken validators, Vodka mocktail testing, Mesh transaction and whisky transaction snippets
Acceptance Criteria
- Develop the Aiken code snippets for quickly starting a validator in spend, mint and withdraw purposes
- Develop the vodka code snippets for quickly starting unit testing in mocktail against spend, mint and withdraw validator
- Develop the Mesh code snippets for quickly starting a txbuilder against spend, mint and withdrawal transaction
- Develop the whisky code snippets for quickly starting a txbuilder against spend, mint and withdrawal transaction
- Integrate code snippet with Cardano Bar
Evidence of Completion
- Public link to the developed code on SIDAN Lab Github
- Public link to post on Twitter/X to inform the Public
- Link to SIDAN Lab discord on release announcement
Delivery Month
1
Cost
10000
Progress
90 %
Milestone Title
Documentation and Closeout Report
Milestone Outputs
- Publish Cardano Bar docs: Documentation for install, quickstart, VSCode commands and snippets; include minimal runnable examples; link prominently from the README.
- Add contribution materials: CONTRIBUTING.md, CODE_OF_CONDUCT.md, issue/PR templates, and brief maintainer notes to support future collaboration.
- Close-out materials: Public close-out report (scope, KPIs/adoption signals, lessons, next steps) and a short close-out video (demo + summary); announce links via README/X/Discord.
Acceptance Criteria
- Docs site is live and linked from README; pages cover quickstart plus module references for VSCode commands and snippets; Pages deployment succeeds.
- CONTRIBUTING.md, CODE_OF_CONDUCT.md, and issue/PR templates are committed; CHANGELOG and a version tag updated to capture the documentation wrap-up.
- Close-out report and video are publicly accessible; links added to README and posted on X/Discord.
Evidence of Completion
- Documentation served at the public Github repository with link provided
- Publicly accessible closeout report
- Publicly accessible closeout video
Delivery Month
1
Cost
10000
Progress
100 %
[Final Pitch] Budget & Costs
Please provide a cost breakdown of the proposed work and resources
Engineering (Parsers, VSCode, Snippets) — 75,000 ₳ (~75%)
Build the TypeScript & Rust Aiken blueprint parsers; add VSCode commands for one-click generation of Mesh/whisky types and scaffolds; ship snippet packs (Aiken, vodka/mocktail, Mesh, whisky); integrate into Cardano Bar UI; set up CI, fixtures, integration tests, cross-platform builds, and light perf checks.
Project management & QA — 8,000 ₳ (~8%)
Roadmap & milestones, issue triage, release checklists; acceptance testing of parsers/snippets against at least one open-source project; maintain a compatibility matrix (Aiken ↔ parser ↔ Mesh/whisky).
Documentation & DevRel — 12,000 ₳ (~12%)
README/quickstarts; parser guides (Aiken→Mesh and Aiken→whisky); snippet catalog (spend/mint/withdraw) with runnable examples; troubleshooting/FAQ; release notes and polished VSCode Marketplace page; community support threads on X/Discord.
Reporting & Closeout — 5,000 ₳ (~5%)
Monthly Catalyst updates; final closeout report; short demo/overview video with captions; publish adoption metrics (installs, command runs, external PRs) and link clearly from repo and community channels.
[Final Pitch] Value for Money
How does the cost of the project represent value for the Cardano ecosystem?
- High public-good ROI: One-click TS/Rust parsers and ready snippets replace 2–4 weeks of setup per team (types, tx builders, tests). A handful of adopters repays the grant in saved engineering time.
- Cross-language leverage: The same Aiken blueprint yields Mesh (TS) and whisky (Rust) code. One project benefits two major stacks, cutting duplication and ecosystem fragmentation.
- Reusable & open: Apache-2.0, zero lock-in. Parsers, VSCode commands, and snippet packs become shared building blocks any wallet, dApp, or auditor can extend.
- Quality lowers downstream costs: Typed codegen + tested snippets reduce mainnet errors, review time, and audit rework across many projects—not just ours.
- Clear success signals: Public installs/usage of commands, external PRs/issues, number of open-source blueprints validated, and parser compatibility matrix updates—transparent, verifiable outcomes.
[Required Acknowledgements] Consent & Confirmation
Terms and Conditions:
Yes