Skip to content

Commit

Permalink
docs: add state transaction.lockupFailed (#513)
Browse files Browse the repository at this point in the history
* docs: No subject

* docs: add state transaction.lockupFailed

---------

Co-authored-by: Kilian <kilian.rausch@gmail.com>
  • Loading branch information
kilrau and Kilian committed Mar 20, 2024
1 parent 0d89dd2 commit 1e4a86a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/lifecycle.md
Expand Up @@ -32,7 +32,7 @@ When a Normal Submarine Swap is created, it passes through the following states:
6. `transaction.claim.pending`: This status indicates that Boltz is ready for the creation of a cooperative signature for a keypath spend. Taproot Swaps are not claimed immediately by Boltz after the invoice has been paid, but instead Boltz waits for the API client to post a signature for a key path spend. If the API client does not cooperate in a key path spend, Boltz will eventually claim via the script path.
7. `transaction.claimed`: indicates that after the invoice was successfully paid, the chain Bitcoin were successfully claimed _by Boltz_. This is the final status of a successful Normal Submarine Swap.

If the user doesn't send chain bitcoin and the swap expires (approximately 24h), Boltz will set the state of the swap to `swap.expired` , which means that it was cancelled and chain bitcoin shouldn't be sent anymore. In case of `invoice.failedToPay` or `swap.expired` but bitcoin were sent, the user needs to submit a refund transaction to reclaim their locked chain bitcoin. For more information about how Boltz API clients can construct & submit refund transactions for users, check the [Claiming Swaps & Refunds](claiming-swaps.md) section. The states `invoice.failedToPay` and `swap.expired` are final since Boltz is _not_ monitoring refund transactions on the chain.
If the user doesn't send chain bitcoin and the swap expires (approximately 24h), Boltz will set the state of the swap to `swap.expired` , which means that it was cancelled and chain bitcoin shouldn't be sent anymore. In case of the states `invoice.failedToPay` or `swap.expired` but bitcoin were sent or `transaction.lockupFailed` , which usually is set if the user sent too little, the user needs to submit a refund transaction to reclaim their locked chain bitcoin. For more information about how Boltz API clients can construct & submit refund transactions for users, check the [Claiming Swaps & Refunds](claiming-swaps.md) section. The states `invoice.failedToPay` and `swap.expired` are final since Boltz is _not_ monitoring refund transactions on the chain.

### Reverse Submarine Swaps

Expand Down

0 comments on commit 1e4a86a

Please sign in to comment.