CB-2Q23-05.1 : Stacks Nakamoto Block Simulator UI

[will-corcoran]

Discussed in https://github.com/stacksgov/Stacks-Grant-Launchpad/discussions/859

^{Originally posted by will-at-stacks March 18, 2023}

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. Activation of sBTC will require adoption of a consensus-changing hard-fork called Nakamoto Release (links below). The upcoming Nakamoto fork rules will change the finality guarantees provided by the Stacks blockchain. These rules are complex for Stacks blockchain users to understand. In order to clearly demonstrate the implications of the Nakamoto Release a Block Simulator was conceived of to help developers and users understand the resulting changes. The development of an initial prototype for the Nakamoto Block Simulator has been led by @radicleart , links to the repo and the current app are below.

Critical Bounty Mission Statement:

The purpose of this Critical Bounty is to take the Nakamoto Block Simulator prototype through its next development cycle, resulting in a more polished tool that demonstrates the subtleties of the Stacks Nakamoto rules. Additionally, the grantee will be expected to provide documentation, and iterate on initial rollout user feedback.

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

• Take the existing prototype and develop a production-level, accessible tool with the needs of Stacks Blockchain users in mind.
• The final deliverable is a prototype refinement that accurately reflects the new Stacks 3.0 Nakamoto fork rules provided by the Stacks Core Devs.
• Note that written documentation on Nakamoto fork rules may be stale and may need to be updated by the Stacks Core Devs.
• The tool aims to educate the Stacks community on the proposed Stacks 3.0 Nakamoto fork rules to ensure a smooth SIP process.
• Address user feedback from the initial rollout.
• Written documentation and 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:

• Familiarity with block production or mining fork rules in Stacks and Bitcoin.
• Front end web development experience.
• Tools: sveltejs, typescript, fabric bootstrap, popper

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. Nakamoto Block Simulator Design Doc
7. Nakamoto Block Simulator Prototype Repo
8. Nakamoto Block Simulator Live App
9. Stacks Nakamoto Rules Whitepaper
10. SIP-021: Trustless Two-way Peg to Bitcoin - Fork Rules

Critical Bounty Fee:

• Maximum Fee: $20,000

Reviewers / Advisors:

Igor Sylvester, Core Engineering Lead, Trust Machines Mike Cohen, EcosystemDAO Andre Serrano, sBTC Resident and sBTC Go To Market Working Group Lead 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.

[stacks-foundation]

👋 @will-at-stacks Thanks for your application! We will do a pre-review and let you know if we have any immediate questions. In the mean time please refer to our review schedule here for a detailed timeline and response dates. Best, Will

[will-corcoran]

Congrats on being awarded this Critical Bounty @vicnicius for $12.6k

Supplementary funding is also going to @macxim for UX/UI services for $4,480

Congrats to you both.

More information on this Critical Bounty can be found here

[will-corcoran]

@vicnicius please post your original application for the Critical Bounty here for public awareness.

Thanks, Will

[vini-btc]

Sure! Here it is: https://www.notion.so/Bounty-Proposal-Stacks-Nakamoto-Block-Simulator-UI-4c914ce8ddfd4f61b0693794846de3fb

[joberding]

Hi Vinicius,

Your notion requires a password to access. Please make it publicly accessible for community review.

On Wed, Apr 19, 2023 at 9:05 AM Vinícius Andrade @.***> wrote:

Sure! Here it is: https://www.notion.so/Bounty-Proposal-Stacks-Nakamoto-Block-Simulator-UI-4c914ce8ddfd4f61b0693794846de3fb

— Reply to this email directly, view it on GitHub https://github.com/stacksgov/Stacks-Grant-Launchpad/issues/878#issuecomment-1514993936, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABDW2SFN6I2W7CC7BZEX5CLXCAENBANCNFSM6AAAAAAWC6I6LQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

[igorsyl]

Sure! Here it is: https://www.notion.so/Bounty-Proposal-Stacks-Nakamoto-Block-Simulator-UI-4c914ce8ddfd4f61b0693794846de3fb

Thank you @vicnicius , would it be possible to convert to a gitbook, to follow what appears to be the standard here in terms of documentation?

[vini-btc]

I published it here: https://vini-btc.gitbook.io/stacks-nakamoto-ui-simulator/. I'll use it to document the whole project. Code will live here for now: https://github.com/vicnicius/stacks-blocks

[vini-btc]

I'll be publishing the updates here: https://vini-btc.gitbook.io/stacks-nakamoto-ui-simulator/updates

[vini-btc]

I just pushed the first release of the simulator here: https://github.com/vicnicius/stacks-nakamoto-block-simulator/tags. It's still a pre-alpha release, there are a few open issues https://github.com/vicnicius/stacks-nakamoto-block-simulator/issues but the ground work is mostly done. I want to welcome everyone to help with feedback, asking questions, opening issues, PRs, sharing ideas, suggesting changes, helping prioritize, or however they think they can help.

You can view and interact with this first version of the project here: https://stacks-nakamoto-block-simulator.vercel.app/