SIDAN - Vodka - Complete Aiken Dev Utils & Testing Framework
Budget Requested
100,000 ADA
Duration
5 months
Theme
Developer Tools
Category
Cardano Open: Developers
Problem Statement
Aiken developers lack consistent, well-tested on-chain utilities and a complete mock transaction builder. Fragmented APIs slow audits, hinder unit tests, and risk inefficiency on mainnet, creating barriers for developers and increasing development time.
Key Deliverables
Cocktail API Coherence
Comprehensive revision of naming conventions, API updates with deprecation handling, and essential onchain utility functions
Mocktail Mock Transaction Builder
Feature-complete mock transaction builder with endpoints for all script purposes: spend, mint, withdraw, publish, vote, propose
Security & Performance Audit
Comprehensive security review and performance optimization of onchain utilities with detailed audit documentation
Developer Experience Enhancement
Improved documentation, examples, and developer tools to accelerate Aiken development and reduce integration time
Project Milestones
Milestone 1: Preparation and Organization Setup
Initial project setup with team organization, communications channels, and comprehensive project planning with GitHub roadmap.
Outputs
- Team setup with defined roles and responsibilities
- Public announcement and community channels
- GitHub Projects roadmap with milestones
- Contributor guidelines and project structure
Acceptance Criteria
- Maintainers/advisors listed with roles in documentation
- Public repository with LICENSE and CODE_OF_CONDUCT
- Community announcement published with links
- GitHub Projects board active with actionable issues
Evidence
- README/MAINTAINERS.md with team roles
- Repository tree showing legal documents
- Public announcement on social media
- GitHub Projects board with milestones
Milestone 2: Cocktail - Onchain Utilities Functions Revisit
Comprehensive revision of naming conventions, API updates with deprecation handling, and addition of essential utility functions.
Outputs
- Updated naming convention with deprecation handling
- Enhanced onchain utility functions
- Comprehensive migration documentation
- Refactored examples with new APIs
Acceptance Criteria
- Naming convention documented and APIs renamed
- Deprecation attributes and migration notes added
- New utilities implemented with documentation
- CI build/test/lint passes after refactor
Evidence
- Public GitHub repository with updates
- Twitter/X announcement post
- Discord release announcement
- Updated documentation on GitHub Pages
Milestone 3: Mocktail - Feature Complete Development
Development of complete Mocktail endpoints for all script purposes including spend, mint, withdraw, publish, vote, and propose.
Outputs
- Complete Mocktail endpoints for all script purposes
- Comprehensive documentation with examples
- Mock transaction builder functionality
- Published documentation on GitHub Pages
Acceptance Criteria
- Mocktail includes endpoints for spend, mint, withdraw, publish, vote, propose
- Each endpoint documented with arguments and usage examples
- README links to Mocktail documentation
- All examples compile and run successfully
Evidence
- Public GitHub repository with Mocktail code
- Twitter/X announcement of completion
- Discord release announcement
- Live documentation on GitHub Pages
Milestone 4: Auditing and Performance Optimization
Comprehensive security and efficiency auditing of onchain utilities with performance optimizations and quality assurance.
Outputs
- Security audit of onchain utility functions
- Performance optimization recommendations
- Audit documentation and findings
- Efficiency improvements implementation
Acceptance Criteria
- Security audit note merged with findings
- Efficiency audit completed with observations
- Documentation clarifications added where needed
- Performance optimizations implemented safely
Evidence
- AUDIT.md or audit documentation published
- GitHub repository with audit commits
- Twitter/X post on audit completion
- Discord announcement with audit results
Milestone 5: Documentation and Closeout Report
Comprehensive documentation publication, contribution materials creation, and project closeout with detailed reporting.
Outputs
- Complete Vodka documentation on GitHub Pages
- Contribution guidelines and community materials
- Comprehensive closeout report
- Project demonstration and summary video
Acceptance Criteria
- Documentation site live with Cocktail and Mocktail guides
- CONTRIBUTING.md and issue/PR templates committed
- Closeout report and video publicly accessible
- All documentation linked from README
Evidence
- Live documentation site with public access
- Published closeout report
- Public demonstration video
- Community announcements with links
Expected Impact
Faster & Safer Development
Consistent on-chain utilities and complete mock transaction builder reduce build/test cycles and catch bugs before mainnet deployment.
Shared Standards & Reuse
Clear naming conventions and well-documented helpers reduce reinventing the wheel, boosting interoperability across dApps.
Enhanced Security & Efficiency
Audit notes improve review quality, optimized encodings reduce execution budgets, making transactions cheaper for users.