Skip to content

Btcpayserver plugin

napoly requested to merge napoly/ccs-proposals:btcpayserver-plugin into master

Overview

Hello everyone!

We are thrilled to announce our plans to refactor the Monero integration for BTCPay Server. With the release of BTCPay Server 2.0, the platform has undergone a major update, introducing breaking changes to the Monero integration. This redesign transitions non-core features, such as Monero support, into a plugin-based architecture. This shift provides an excellent opportunity for the Monero community to take ownership of the integration and ensure its long-term development. The BTCPay team has expressed their support for this initiative, and we are fully committed to making it a success. To prepare for this work, the Monero codebase has already been migrated into its own repository, paving the way for its transition into a standalone plugin.

How did we get here?

The initial integration was developed by @Kukks of the BTCPay team and funded through a CCS proposal by an anonymous donor. While this implementation successfully introduced Monero support to BTCPay Server, there is an opportunity to expand its functionality by adding features such as multi-wallet support and enhanced wallet management tools. During our work on open bounties and 2 for the Monero community, we identified the need to realign our efforts on the plugin migration to ensure continued support for Monero within BTCPay Server.

Thanks to funding from the Magic Grants, we had the opportunity to meet at Monerotopia 2024 and analyze this challenge in depth. During this collaboration, we established a comprehensive roadmap and a plugin repository with CI/CD support for stable releases and development. The plugin is currently in the proof-of-concept stage, with a focus on establishing a solid foundation for the plugin.

What's next?

We are seeking funding to support the development of this plugin and ensure its continued success. The funds will be used to support the development of the plugin, including the creation of a proof of concept and a minimum viable product. We are also seeking additional funding to support the final stages of development, including UI/UX enhancements, bug fixing, and merchant migration.

Additionally, there are several open bounties currently available for the Monero integration. We propose incorporating these funds into the broader plugin development effort, ensuring that all outstanding tasks align with our overarching goals.

Contributors:

Milestones

Milestone 1: Requirements Analysis and Core Infrastructure

  • Deliverables:
    • Finalized and published roadmap.
    • Operational CI/CD pipeline for plugin development and releases.
    • Plugin repository established and accessible.
  • Funds: 15% of funds
  • Timeline: Week 1-2
  • Status: Mostly done

Milestone 2: Proof of Concept (PoC) for Monero Plugin

  • Deliverables:
    • Plugin installation mechanism functional.
    • Docker integration for local node or remote node connections.
    • Initial UI for node synchronization visualization.
    • Basic monero-lws support tested and integrated.
  • Funds: 25%
  • Timeline: Week 3-6
  • Status: Current focus

Milestone 3: Minimum Viable Product (MVP)

  • Deliverables:
    • Functional wallet setup interface (create, import, export, backup, recover).
    • Invoice creation and payment verification.
    • UI for Monero daemon configuration.
    • Integration for wallet recovery and backup functionality.
  • Funds: 35%
  • Timeline: Week 7-12
  • Status: Not started

Milestone 4: Final Release (Polishing and Merchant Migration)

  • Deliverables:
    • UI/UX enhancements for seamless user experience.
    • Comprehensive documentation (installation, usage, troubleshooting, migration).
    • Bug fixing and testing.
    • Migration support for existing Monero merchants.
    • Final release of the plugin.
    • Post-release support and maintenance plan.
    • Community engagement and feedback collection.
    • Ongoing support for the plugin.
  • Funds: 25%
  • Timeline: Week 13-16
  • Status: Not started

Timeline

The integration process is expected to take approximately 16-20 weeks.

Future Roadmap

  • Plans for ongoing maintanance and support for the plugin.
  • Community feedback for future improvements and features.
  • Expanding wallet features and functionality.
Edited by napoly

Merge request reports