mirror of https://github.com/lightninglabs/loop
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
90 lines
2.8 KiB
Go
90 lines
2.8 KiB
Go
package client
|
|
|
|
// SwapState indicates the current state of a swap.
|
|
type SwapState uint8
|
|
|
|
const (
|
|
// StateInitiated is the initial state of a swap. At that point, the
|
|
// initiation call to the server has been made and the payment process
|
|
// has been started for the swap and prepayment invoices.
|
|
StateInitiated SwapState = iota
|
|
|
|
// StatePreimageRevealed is reached when the sweep tx publication is
|
|
// first attempted. From that point on, we should consider the preimage
|
|
// to no longer be secret and we need to do all we can to get the sweep
|
|
// confirmed. This state will mostly coalesce with StateHtlcConfirmed,
|
|
// except in the case where we wait for fees to come down before we
|
|
// sweep.
|
|
StatePreimageRevealed
|
|
|
|
// StateSuccess is the final swap state that is reached when the sweep
|
|
// tx has the required confirmation depth (SweepConfDepth) and the
|
|
// server pulled the off-chain htlc.
|
|
StateSuccess
|
|
|
|
// StateFailOffchainPayments indicates that it wasn't possible to find routes
|
|
// for one or both of the off-chain payments to the server that
|
|
// satisfied the payment restrictions (fee and timelock limits).
|
|
StateFailOffchainPayments
|
|
|
|
// StateFailTimeout indicates that the on-chain htlc wasn't confirmed before
|
|
// its expiry or confirmed too late (MinPreimageRevealDelta violated).
|
|
StateFailTimeout
|
|
|
|
// StateFailSweepTimeout indicates that the on-chain htlc wasn't swept before
|
|
// the server revoked the htlc. The server didn't pull the off-chain
|
|
// htlc (even though it could have) and we timed out the off-chain htlc
|
|
// ourselves. No funds lost.
|
|
StateFailSweepTimeout
|
|
|
|
// StateFailInsufficientValue indicates that the published on-chain htlc had
|
|
// a value lower than the requested amount.
|
|
StateFailInsufficientValue
|
|
|
|
// StateFailTemporary indicates that the swap cannot progress because
|
|
// of an internal error. This is not a final state. Manual intervention
|
|
// (like a restart) is required to solve this problem.
|
|
StateFailTemporary
|
|
|
|
// StateHtlcPublished means that the client published the on-chain htlc.
|
|
StateHtlcPublished
|
|
)
|
|
|
|
// Type returns the type of the SwapState it is called on.
|
|
func (s SwapState) Type() SwapStateType {
|
|
if s == StateInitiated || s == StateHtlcPublished ||
|
|
s == StatePreimageRevealed || s == StateFailTemporary {
|
|
|
|
return StateTypePending
|
|
}
|
|
|
|
if s == StateSuccess {
|
|
return StateTypeSuccess
|
|
}
|
|
|
|
return StateTypeFail
|
|
}
|
|
|
|
func (s SwapState) String() string {
|
|
switch s {
|
|
case StateInitiated:
|
|
return "Initiated"
|
|
case StatePreimageRevealed:
|
|
return "PreimageRevealed"
|
|
case StateSuccess:
|
|
return "Success"
|
|
case StateFailOffchainPayments:
|
|
return "FailOffchainPayments"
|
|
case StateFailTimeout:
|
|
return "FailTimeout"
|
|
case StateFailSweepTimeout:
|
|
return "FailSweepTimeout"
|
|
case StateFailInsufficientValue:
|
|
return "FailInsufficientValue"
|
|
case StateFailTemporary:
|
|
return "FailTemporary"
|
|
default:
|
|
return "Unknown"
|
|
}
|
|
}
|