Introduction Tutorial

[binarybaron]

We want to ensure users have some knowledge about how the swap process will go before they initiate their first swap. This will (hopefully) alleviate some of the anxiety users experience when doing their first swap.

One of the more straight-forward ways to achieve this is by displaying a tutorial at startup which introduces the user to some of the core concepts. The tutorial should:

• Clarify some of the inner workings of the GUI
  • the existence of the internal Bitcoin wallet
  • the flow of your bitcoin wallet → internal bitcoin wallet → smart contract
• Explain how a swap normally goes (See the documentation)
  • deposit bitcoin
  • let the swap run → either 1. success 2. refund 3. punish / cooperative redeem
• Clarify what can go wrong and what to do about it
  • if the Bitcoin lock transaction is not confirmed → wait until confirmed, 12 hours later it can be refunded
  • if the Bitcoin lock transaction is confirmed but the maker does not lock their Monero → wait 12 hours and refund
  • if the Bitcoin lock transaction is not published despite the funds having been submitted → they are inside the internal Bitcoin wallet and can be withdrawn from the wallet tab
• Explain how to get help
  • submitting feedback
  • link to the documentation
  • link to the matrix chat

To ensure the tutorial is only displayed once we can add a new property to settingsSlice.ts to store a flag on whether we have shown the tutorial yet. The settings are persisted to disk (see storeRenderer.ts).

Here's a state transition diagram for the swap states. Not all of this needs to be incooperated into the tutorial but it can serve as a guide to the implementer.