diff --git a/btcpayserver-plugin.md b/btcpayserver-plugin.md index d1ee76b..94c42b3 100644 --- a/btcpayserver-plugin.md +++ b/btcpayserver-plugin.md @@ -1,16 +1,24 @@ --- layout: fr -title: -author: -date: -amount: +title: BTCPay Server Monero Plugin +author: Deverickapollo & Napoly +date: January 6, 2025 +amount: TBD milestones: - - name: + - name: Requirements analysis and core infrastructure + funds: TBD + done: + status: unfinished + - name: Creating PoC for Monero Plugin funds: done: status: unfinished - - name: - funds: + - name: Creating MVP for Monero Plugin + funds: TBD + done: + status: unfinished + - name: Final UI/UX Enhancements, Bug Fixing, Merchant Migration + funds: TBD done: status: unfinished payouts: @@ -19,3 +27,50 @@ payouts: - date: amount: --- + + +## Overview + +Hello everyone! + +We are excited to announce our plans to migrate and update the existing Monero implementation for BTCPay Server to align with version 2.0.0 and beyond. This process will involve restructuring the code into a plugin-based architecture that was introduces by BTCPay Server itself. + +How did we get here? While hunting bounties and addressing various issues in the codebase, we realized that as BTCPay Server's core has [evolved](https://github.com/btcpayserver/btcpayserver/pull/6239#issuecomment-2373319844), the Monero integration has lagged behind. With no formal ownership of Monero’s code in this ecosystem, we concluded that it’s up to us to take action. + +Thanks to partial funding from the Magic Grants, we were able to meet at a recent conference to analyze this challenge in greater depth. As a result, we created a [roadmap](https://github.com/users/deverickapollo/projects/5/views/1) and established an actual [plugin repository with CI/CD](https://github.com/napoly/btcpayserver-plugin-monero). + +Contributors: + + * [Deverickapollo](https://github.com/deverickapollo) + * [Napoly](https://github.com/napoly) + +## Milestones + +1. Requirements analysis and core infrastructure (mostly done) + - we have established a solid roadmap and build process, though a release has not yet been made + +2. Creating Proof of Concept (PoC) for the Monero Plugin (current focus) + - plugin installation + - enable starting a local Docker container or connecting to a remote node. + - node sync visualization + +3. Developing the Minimum Viable Product (MVP) for the Monero Plugin + - invoice creation + - payment verification + - wallet setup UI/UX + +4. Final UI/UX Enhancements, Bug Fixing, Merchant Migration + - plugin release + - bugfixing + - uninstallation + - node synchronization notification + - documentation + - overall support + +## Timeline + +The integration process is expected to take approximately 12-16 weeks. + +## Future Roadmap + +TBD \ No newline at end of file