scoin/scoin/PaymentOnion

PaymentOnion

object PaymentOnion
Source:
PaymentOnion.scala
class Object
trait Matchable
class Any

Type members

Classlikes

sealed trait ChannelRelayPayload extends RelayPayload with PaymentPacket
case class ChannelRelayTlvPayload(records: TlvStream[OnionPaymentPayloadTlv]) extends ChannelRelayPayload with TlvFormat
Companion:
object
Source:
PaymentOnion.scala
object ChannelRelayTlvPayload
Companion:
class
Source:
PaymentOnion.scala
sealed trait FinalPayload extends PerHopPayload with PerHopPayloadFormat with TrampolinePacket with PaymentPacket

Per-hop payload for a final node.

Per-hop payload for a final node.

Source:
PaymentOnion.scala
case class FinalTlvPayload(records: TlvStream[OnionPaymentPayloadTlv]) extends FinalPayload with TlvFormat
sealed trait LegacyFormat extends PerHopPayloadFormat

Legacy fixed-size 65-bytes onion payload.

Legacy fixed-size 65-bytes onion payload.

Source:
PaymentOnion.scala
case class NodeRelayPayload(records: TlvStream[OnionPaymentPayloadTlv]) extends RelayPayload with TlvFormat with TrampolinePacket
sealed trait PacketType

Payment onion packet type.

Payment onion packet type.

Source:
PaymentOnion.scala
sealed trait PaymentPacket extends PacketType

A payment onion packet is used when offering an HTLC to a remote node.

A payment onion packet is used when offering an HTLC to a remote node.

Source:
PaymentOnion.scala
sealed trait PerHopPayload

Per-hop payload from an HTLC's payment onion (after decryption and decoding).

Per-hop payload from an HTLC's payment onion (after decryption and decoding).

Source:
PaymentOnion.scala
sealed trait PerHopPayloadFormat
case class RelayLegacyPayload(outgoingChannelId: ShortChannelId, amountToForward: MilliSatoshi, outgoingCltv: CltvExpiry) extends ChannelRelayPayload with LegacyFormat
sealed trait RelayPayload extends PerHopPayload with PerHopPayloadFormat

Per-hop payload for an intermediate node.

Per-hop payload for an intermediate node.

Source:
PaymentOnion.scala
sealed trait TlvFormat extends PerHopPayloadFormat

Variable-length onion payload with optional additional tlv records.

Variable-length onion payload with optional additional tlv records.

Source:
PaymentOnion.scala
sealed trait TrampolinePacket extends PacketType

A trampoline onion packet is used to defer route construction to trampoline nodes. It is usually embedded inside a PaymentPacket in the final node's payload.

A trampoline onion packet is used to defer route construction to trampoline nodes. It is usually embedded inside a PaymentPacket in the final node's payload.

Source:
PaymentOnion.scala

Value members

Concrete methods

def createMultiPartPayload(amount: MilliSatoshi, totalAmount: MilliSatoshi, expiry: CltvExpiry, paymentSecret: ByteVector32, paymentMetadata: Option[ByteVector], additionalTlvs: Seq[OnionPaymentPayloadTlv], userCustomTlvs: Seq[GenericTlv]): FinalPayload
def createNodeRelayToNonTrampolinePayload(amount: MilliSatoshi, totalAmount: MilliSatoshi, expiry: CltvExpiry, targetNodeId: PublicKey, invoice: Bolt11Invoice): NodeRelayPayload

Create a trampoline inner payload instructing the trampoline node to relay via a non-trampoline payment.

Create a trampoline inner payload instructing the trampoline node to relay via a non-trampoline payment.

Source:
PaymentOnion.scala
def createSinglePartPayload(amount: MilliSatoshi, expiry: CltvExpiry, paymentSecret: ByteVector32, paymentMetadata: Option[ByteVector], userCustomTlvs: Seq[GenericTlv]): FinalPayload
def createTrampolinePayload(amount: MilliSatoshi, totalAmount: MilliSatoshi, expiry: CltvExpiry, paymentSecret: ByteVector32, trampolinePacket: OnionRoutingPacket): FinalPayload

Create a trampoline outer payload.

Create a trampoline outer payload.

Source:
PaymentOnion.scala