PaymentSucceeded

data class PaymentSucceeded(request: SendPayment, preimage: ByteVector32, parts: List<OutgoingPayment.Part>, pending: Map<UUID, Pair<OutgoingPayment.Part, SharedSecrets>>) : OutgoingPaymentHandler.PaymentAttempt

Once we receive a first fulfill for a child payment, we can consider that the whole payment succeeded (because we received the payment preimage that we can use as a proof of payment). Once we're in that state, we wait for all the pending child payments to fulfill.

Parameters

request

payment request containing the total amount to send.

preimage

payment preimage.

parts

fulfilled child payments.

pending

pending child payments (we are waiting for them to be fulfilled downstream).

Constructors

PaymentSucceeded

common

fun PaymentSucceeded(request: SendPayment, preimage: ByteVector32, parts: List<OutgoingPayment.Part>, pending: Map<UUID, Pair<OutgoingPayment.Part, SharedSecrets>>)

Functions

failChild

common

suspend fun failChild(childId: UUID, db: OutgoingPaymentsDb, logger: Logger): Pair<OutgoingPaymentHandler.PaymentAttempt.PaymentSucceeded, OutgoingPaymentHandler.Success?>

isComplete

common

fun isComplete(): Boolean

Properties

fees

common

open override val fees: MilliSatoshi

parts

common

val parts: List<OutgoingPayment.Part>

pending

common

open override val pending: Map<UUID, Pair<OutgoingPayment.Part, SharedSecrets>>

preimage

common

val preimage: ByteVector32

request

common

open override val request: SendPayment