bark: Document the exit-module

Erik De Smedtrequested to merge
gh-8d0098b3/1018/unknown/refs/pull/1018/head into master

Depends on: #1055

When performing an exit there is a phase where the user has to wait for sufficient confirmations before they can access their money.

We currently have two objects

  • [Vtxo] which has [VtxoState::Spendable]. Here [Spendable] means you can use the [Vtxo] within the ark for eg a lightning payment
  • [ExitVtxo] which has [ExitState::Spendable]. Here [Spendable] means that your exit has sufficient confirmations to be spent onchain

Having both states with the same name on a similar struct was quite confusing. Things, like get_spendable_vtxos in the exit-module is quite misleading.

I also propose a rename because I got very confused a couple of times.

Merge request reports