Opshin VSCode Extension

[Proposal setup] Proposal title

Please provide your proposal title

Opshin VSCode Extension

[Proposal Summary] Budget Information

Enter the amount of funding you are requesting in ADA

85000

[Proposal Summary] Time

Please specify how many months you expect your project to last

3

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

Opshin devs must constantly switch between VSCode and terminal for building, and testing. The lack of integrated tooling forces manual and disrupts development flow, slowing down Opshin development.

[Proposal Summary] Project Dependencies

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

Yes

Describe any dependencies or write 'No dependencies'

The project depends on the existing open-source Opshin CLI tool (Apache 2.0 licensed) and VSCode Extension APIs. Users need Python 3.8-3.11 and the Opshin package installed locally. No external services or proprietary dependencies are required.

[Proposal Summary] Project Open Source

Will your project's outputs be fully open source?

Yes

License and Additional Information

The project will be fully open-source, hosted on GitHub under the Apache 2.0 license. This permissive license allows unrestricted use, modification, and distribution, including in proprietary projects. The repository will be public from day one, accepting community contributions through pull requests and issue discussions.

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

Apache 2.0 license. This license ensures broad compatibility with the Cardano ecosystem while allowing both personal and commercial use. It provides patent protection and clear contribution guidelines, making it ideal for developer tooling that others may want to extend or integrate.

How do you make sure your source code is accessible to the public from project start, and people are informed?

I will create a public GitHub repository from day one with the initial project structure. All commits will be public, enabling community members to track progress in real-time. The repository README will clearly state the project goals, current status, and contribution guidelines. I will post updates in Cardano developer forums with links to the repository.

How will you provide high quality documentation?

It will include installation guides, feature documentation with screenshots, usage, troubleshooting guides, and example workflows. The documentation will be versioned alongside the code to ensure accuracy.

[Your Project and Solution] Solution

Please describe your proposed solution and how it addresses the problem

I perceive this problem as a critical friction point in the Cardano development workflow. My approach leverages VSCode's extension capabilities to create a seamless bridge between Opshin's powerful CLI and the developer's editor environment.

The extension will implement several core capabilities:

• Compilation integration will allow developers to trigger Opshin compilation directly from VSCode through commands or keyboard shortcuts. The extension will spawn the Opshin CLI process, capture output, and parse any errors to display them as inline diagnostics with precise file and line locations.
• Artifact generation through the build command will produce all necessary deployment files (Plutus scripts, addresses, policy IDs) with configurable output directories. After building, developers can immediately access these artifacts from within VSCode.
• Contract evaluation enables in-editor testing by running contracts with test parameters. Developers can provide inputs through JSON files or prompts, with results displayed in a dedicated output panel.
• Automatic file detection will identify Opshin files through shebang lines (#!opshin), automatically determining contract types (spending/minting) from file metadata. All operations will be available through VSCode's command palette, with status bar indicators showing CLI version and compilation status.

What makes this unique is the tight integration specifically designed for Opshin's workflow. Unlike generic Python tools, this extension understands Opshin's compilation model, error formats, and artifact structure. Cardano developers will benefit from reduced context switching, faster error resolution, and a more intuitive development experience.

[Your Project and Solution] Impact

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

This project will directly improve developer productivity for anyone building Cardano smart contracts with Opshin. By eliminating manual CLI operations and providing instant error feedback, developers can iterate faster and catch bugs earlier.

Impact will be measured through VSCode Marketplace download statistics and GitHub repository engagement (issues, pull requests). I will actively monitor user feedback through GitHub issues and Cardano developer forums to understand adoption and identify improvement areas.

The outputs—an open-source VSCode extension and comprehensive documentation—will be shared through the VSCode Marketplace for global distribution, GitHub for source code and collaboration, and Cardano developer channels for awareness.

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

I am an experienced software engineer with proven track record in developer tooling across multiple blockchain ecosystems including Solana, Arbitrum, Stellar, and Internet Computer. My expertise directly aligns with this project's requirements.

I have successfully delivered VS Code extensions specifically for blockchain development, including the Stylus VS Code Extension for Arbitrum (available on VS Code Marketplace) which provides similar IDE integration features for smart contract development. This gives me direct, relevant experience in parsing compiler outputs, integrating CLI tools, and creating intuitive developer workflows within VS Code.

My portfolio demonstrates consistent delivery of developer tools:

• Built interactive development environments (Wizard - Arbitrum Stylus Playground)

• Created GUI wrappers for CLI tools (Dfinity DFX GUI, Soroban CLI GUI)

• Published production VS Code extensions with active users

This combination of VS Code extension development experience and blockchain tooling expertise ensures I can deliver the Opshin CLI VS Code Extension efficiently and effectively. I understand both the technical implementation requirements and the developer experience needs.

[Milestones] Project Milestones

Milestone Title

Core Compilation Integration

Milestone Outputs

• Fully functional VSCode extension that provides seamless compilation commands for Opshin smart contracts, allowing developers to compile their code directly from the editor interface without switching to terminal
• Comprehensive error parser that intelligently processes Opshin CLI output to extract meaningful error information
• Integration with VSCode's Problems panel to display inline error diagnostics with precise file and line number references, making it easy for developers to quickly identify and fix issues in their code
• Complete command palette integration that enables developers to access all compilation operations through VSCode's native command system

Acceptance Criteria

• The extension must successfully compile various types of Opshin contracts through its command interface
• All compilation errors must be accurately displayed
• Complete source code must be publicly available on GitHub with proper licensing and contribution guidelines clearly documented
• A comprehensive README file must be included with detailed setup instructions, requirements, and initial usage guidelines for early adopters

Evidence of Completion

• Publicly accessible GitHub repository containing all source code, documentation
• Detailed demo video showcasing the compilation process, error handling in action
• Complete screenshot documentation demonstrating all implemented features and user interface elements

Delivery Month

1

Cost

25000

Progress

30 %

Milestone Title

Build and Evaluation Features

Milestone Outputs

• Complete artifact generation system via the build command that produces all necessary deployment files including Plutus scripts, contract addresses, and policy IDs, streamlining the deployment preparation process
• Interactive contract evaluation feature that allows developers to test their smart contracts with custom parameters directly from the editor, supporting both JSON file inputs and interactive prompts
• Flexible configuration system with customizable output directories that gives developers control over where build artifacts are stored and how the extension behaves in different project structures
• Informative status bar indicators that display the current Opshin CLI version and provide real-time feedback about compilation status, keeping developers informed without interrupting their workflow
• Intuitive settings interface that exposes all extension configuration options through VSCode's standard settings UI, making it easy for developers to customize the extension to their preferences

Acceptance Criteria

• The build command must reliably generate all required Opshin artifacts in the correct format and location as specified by user configuration
• Contract evaluation must successfully run with various test inputs and display results clearly in the output panel, supporting different parameter types and contract configurations
• All configuration settings must work correctly across different project structures and user environments, with sensible defaults for new users
• A beta version must be published to the VSCode Marketplace for community testing and feedback, accessible to early adopters

Evidence of Completion

• Updated GitHub repository with all new features implemented, documented, and tested
• Beta release available on VSCode Marketplace with installation instructions and feature descriptions
• Comprehensive progress report with detailed feature demonstrations and implementation notes
• Complete test suite results showing coverage and validation of all new functionality

Delivery Month

2

Cost

25000

Progress

60 %

Milestone Title

Polish and Documentation

Milestone Outputs

• Professional VitePress documentation website that provides comprehensive coverage of all extension features, including detailed tutorials, and troubleshooting guides
• Intelligent file detection system using shebang lines and file patterns to automatically identify Opshin contracts and activate relevant extension features, reducing manual configuration needs
• Helpful contract templates and code snippets that provide developers with quick starting points for common smart contract patterns

Acceptance Criteria

• Complete documentation must cover all features with practical examples, clear explanations, and visual aids to ensure developers can effectively use every aspect of the extension
• The extension must work reliably on all major operating systems with consistent behavior and performance across different environments
• Version 1.0 must be production-ready

Evidence of Completion

• Live documentation website accessible to the public with complete content and navigation
• Comprehensive code coverage reports demonstrating thorough testing of all functionality
• Version 1.0 can be installed successfully.

Delivery Month

3

Cost

20000

Progress

90 %

Milestone Title

Project Close-out and Final Report

Milestone Outputs

• Project Close-out Report
• Project Close-out Video
• Final documentation review and updates
• Community handover materials (contribution guide, future roadmap)
• Confirmation of all previous milestone completions

Acceptance Criteria

• v1.0 published on Visual Studio Marketplace
• All documentation finalized and accessible live
• Close-out report details achievements and learnings
• Video demonstrates complete extension functionality

Evidence of Completion

• Final VSCode Marketplace listing
• Close-out report document
• Demo video (3-5 minutes)
• GitHub repository with contribution guidelines
• Community announcement of release

Delivery Month

4

Cost

15000

Progress

100 %

[Final Pitch] Budget & Costs

Please provide a cost breakdown of the proposed work and resources

0.93 USD per ADA (currently)

(120 USD/hour × 8 hours/day × 5 days/week × 14 weeks) = 67,200 USD ~= 72,500 ADA + 12,500 ADA for volatility = 85,000 ADA

This covers ~3.5 months of full-time development by a single experienced developer, providing exceptional value for a tool that will serve the Opshin-Cardano ecosystem.

Breakdown:

Development (14 weeks): 72,500 ADA

Volatility buffer: 12,500 ADA - Protection against ADA/USD fluctuation

All funds are allocated to development work. No marketing or promotional costs included.

[Final Pitch] Value for Money

How does the cost of the project represent value for the Cardano ecosystem?

This project delivers exceptional value by addressing a specific pain point identified in Cardano developer surveys. The 85,000 ADA investment creates a permanent, open-source tool that will save countless developer hours.

The Apache 2.0 license ensures the community owns this tool permanently. Even if I cannot maintain it long-term, others can fork and extend it. This creates lasting value far beyond the initial investment.

By improving developer experience for Opshin—which itself makes Cardano development more accessible through Python—this project has a multiplier effect on ecosystem growth. Every developer who saves time debugging or testing can deliver their dApps faster, ultimately strengthening the entire Cardano platform.

[Required Acknowledgements] Consent & Confirmation

Terms and Conditions:

Yes