Document Reason enum

This commit is contained in:
Lucas Soriano del Pino 2020-10-16 11:31:16 +11:00
parent 7d307e581a
commit 369770488f

View file

@ -122,8 +122,11 @@ where
AfterBtcLock(Reason), AfterBtcLock(Reason),
} }
/// Reason why the swap has failed.
enum Reason { enum Reason {
/// The refund timelock has been reached.
BtcExpired, BtcExpired,
/// Alice did not lock up enough monero in the shared output.
InsufficientXMR(monero::InsufficientFunds), InsufficientXMR(monero::InsufficientFunds),
} }