CB-23Q2-03.3 : Integration of sBTC into Electrum

[will-corcoran]

Introduction:

sBTC is a SIP-010 fungible token on the Stacks blockchain that can be used in DeFi protocols, NFT marketplaces, DAOs, governance, and several other use-cases. The sBTC Bridge is a trustless two-way mechanism that allows users to wrap and unwrap BTC as sBTC.
In its current state, users of Electrum (the popular, open-source, "lightweight" Bitcoin wallet) who wish to use sBTC would need to use the sBTC Bridge web app, thereby leaving the Electrum app which hurts user experience.

Critical Bounty Mission Statement:

The purpose of this Critical Bounty is to develop an Electrum plugin that allows Electrum users to use sBTC without leaving the Electrum app. The plugin, if successfully merged upstream, would be deployed to all Electrum users which would fuel user growth of sBTC. Please note, the grantee will not be held accountable for the risk of not being able to merge the plugin upstream due to political or ideological reasons only.

Functionality / Deliverables (shall include, but not be limited to):

• Develop an Electrum Plugin for sBTC users.
• Plug-in provides equivalent user stories to the OG sBTC Bridge web app.
• User stories include:
  • wrap in and wrap out sBTC,
  • track and display transaction bundle of Bitcoin sBTC request and fulfillment transactions and associated Stacks mint/burn operations.
• Bitcoin transaction signing is performed using Electrum’s wallet.
• Contribution successfully merged into Electrum’s plugin repository.
• Write written documentation and prepare a video user guide.
• Product 'roadshow', feedback, and improvements: All recipients will be responsible for demonstrating functionality, championing early adoption, gathering feedback, and making one to two rounds of high-impact, feedback-based improvements.

Required Knowledge / Skills:

• Experience developing Desktop GUIs in Python using PyQT.
• Experience with Bitcoin transaction construction and signing, ideally using Python.

References:

1. sBTC Whitepaper
2. Stacks Nakamoto Release Whitepaper
3. sBTC project dashboard
4. Clarinet Docs (reference for design system req’d for Typescript applications wrapped within a Rust application)
5. TM Repo (code & documentation standard)
6. Electrum Website
7. Electrum Plugins
8. Electrum GitHub Repo

Critical Bounty Fee:

• Maximum Fee: $20,000

Reviewers / Advisors:

Igor Sylvester, Core Engineering Lead, Trust Machines
Rena Shah, Head of Operations & Strategy, Trust Machines
Stjepan Golemac, Core Engineer, Trust Machines
Mårten Blankfors, Core Engineer, Trust Machines
Jesse Wiley, Integration and Security Lead, Stacks Foundation
Kenny Rogers, Developer Advocate, Stacks Foundation
Will Corcoran, Grants Lead, Stacks Foundation

Additional Comments:

Recipient will be expected to attend sBTC Core Engineering Working Group calls while the bounty is in development and provide weekly updates.

APPLY HERE

---

NOTES ABOUT CRITICAL BOUNTIES:

If you have thoughts, questions, or comments on the rough outline for this Critical Bounty above, please comments below.

Please note, all 2023 Q2 Critical Bounties that have funding approved for them will be moved to the Issues page (here) on Tuesday 03/21/2023.

Some procedural items to keep in mind with 2023 Q2 Critical Bounties:

1. Each Critical Bounty will have a pre-approved minimum and maximum budget listed within the issue.
2. All applications will be submitted via a BlockSurvey which will be linked within the Issue.
3. Applications will be open from 03/21/2023 to 04/03/2023.
4. Critical Bounty applications will be reviewed by relevant members of the sBTC Core Engineering Team and technical staff from the Stacks Foundation.
5. The selected recipient will be the low, qualified bidder (in the eyes of the reviewers).
6. Selected Critical Bounty recipients will be announced on 04/07/2023 and will be expected to start work immediately and attend sBTC Core Engineering meetings to provide weekly updates on their work.

[will-corcoran]

Congrats on being awarded this Critical Bounty @Patotking12

This discussion thread should be used for all payment requests for your grant. Please follow these steps:

• Create a Gitbook for your project (watch this video for details on how)
• Once you complete a milestone, update your Gitbook and post a message below summarizing which milestone was completed and the updates you made to your Gitbook.
• When you post your request please tag @will-at-stacks
• Once I have a chance to review your deliverables I will begin the process of disbursing the associated payment.

Your CB fee of $20k will be paid out in (2) $10k payments at the following milestones:

1. At contract signing
2. Substantial Completion

[will-corcoran]

@patoking12 just a reminder to request payments here. let me know when you are ready for the next disbursement.

[Patotking12]

I am writing to formally request the release of completion disbursement. While the pegin - pegout process is still under development and not yet completed, I would like to highlight that the entire front end has been implemented with functional mock data. The following user stories are currently operational with mock data:

Completed Tasks:

• Deposit/Commit BTC to pegin for sBTC
• Reclaiming Deposits if they weren't revealed
• Withdraw/Commit sBTC to pegout for BTC
• Reclaiming Withdrawals if they weren't revealed

Fully operational:

• Fetching and Displaying Pegin transactions along with their respective statuses
• Fetching and Displaying Pegout transactions with their associated statuses
• Fetching and Displaying Stacks and sBTC balances
• Depositing BTC to any BTC address

Tasks that still need attention and the reasons why:

• Generation of P2TR address/script: This task cannot be completed as there is currently no endpoint available on the sBTC Bridge API. Already reached out to the people working on this and it will implemented.
• Reclaiming Deposits: The sBTC Bridge API does not have an endpoint for this functionality, and there is also no STX python library available to sign messages. Already reached out to the people working on this and it will implemented.
• Withdraw/pegout: Similar to the previous tasks, there is no endpoint on the sBTC Bridge API for withdrawing or pegging out, and no STX python library is available for signing messages. Already reached out to the people working on this and it will implemented.
• Reclaiming Withdrawals: Again, the sBTC Bridge API lacks an endpoint for reclaiming withdrawals, and there is no STX python library for message signing. Already reached out to the people working on this and it will implemented.

Please refer to the attached videos, which demonstrate the current user experience and provides a view of the backend processes on the terminal. It is important to note that my work will continue until sBTC is in production and we have production APIs to integrate with. I am committed to iterating based on client feedback and any changes in the scope of the sBTC project. Even if the grant has concluded, I am willing to continue production.

For reference, the current repository can be found at:
https://github.com/Patotking12/sBTC-Bridge

You can also view demo videos at the following links:
https://youtu.be/twWs_r54Y9Y
https://youtu.be/8HNGzfTbTB4
https://youtu.be/YUoQsYxdPJ8
https://youtu.be/mYYxNw86gpU
https://youtu.be/a6ZoGDgo9J0