Sphinx

Type Members

case class DecryptedFailurePacket(originNode: PublicKey, failureMessage: FailureMessage) extends Product with Serializable

A properly decrypted failure from a node in the route.
A properly decrypted failure from a node in the route.
originNode
public key of the node that generated the failure.
failureMessage
friendly failure message.
case class DecryptedPacket(payload: ByteVector, nextPacket: wire.OnionRoutingPacket, sharedSecret: ByteVector32) extends Product with Serializable

Decrypting an onion packet yields a payload for the current node and the encrypted packet for the next node.
Decrypting an onion packet yields a payload for the current node and the encrypted packet for the next node.
payload
decrypted payload for this node.
nextPacket
packet for the next node.
sharedSecret
shared secret for the sending node, which we will need to return failure messages.
sealed trait OnionRoutingPacket[T <: PacketType] extends AnyRef
case class PacketAndSecrets(packet: wire.OnionRoutingPacket, sharedSecrets: Seq[(ByteVector32, PublicKey)]) extends Product with Serializable

A encrypted onion packet with all the associated shared secrets.
A encrypted onion packet with all the associated shared secrets.
packet
encrypted onion packet.
sharedSecrets
shared secrets (one per node in the route). Known (and needed) only if you're creating the packet. Empty if you're just forwarding the packet to the next node.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object FailurePacket
val MacLength: Int
object PaymentPacket extends OnionRoutingPacket[PaymentPacket]

A payment onion packet is used when offering an HTLC to a remote node.
object TrampolinePacket extends OnionRoutingPacket[TrampolinePacket]

A trampoline onion packet is used to defer route construction to trampoline nodes.
A trampoline onion packet is used to defer route construction to trampoline nodes. It is usually embedded inside a payment onion packet in the final node's payload.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def blind(pub: PublicKey, blindingFactors: Seq[ByteVector32]): PublicKey
def blind(pub: PublicKey, blindingFactor: ByteVector32): PublicKey
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def computeBlindingFactor(pub: PublicKey, secret: ByteVector): ByteVector32
def computeEphemeralPublicKeysAndSharedSecrets(sessionKey: PrivateKey, publicKeys: Seq[PublicKey]): (Seq[PublicKey], Seq[ByteVector32])

Compute the ephemeral public keys and shared secrets for all nodes on the route.
Compute the ephemeral public keys and shared secrets for all nodes on the route.
sessionKey
this node's session key.
publicKeys
public keys of each node on the route.
returns
a tuple (ephemeral public keys, shared secrets).
def computeSharedSecret(pub: PublicKey, secret: PrivateKey): ByteVector32
def debug(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def debug(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def error(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def error(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging
def generateKey(keyType: String, secret: ByteVector32): ByteVector32
def generateKey(keyType: ByteVector, secret: ByteVector32): ByteVector32
def generateStream(key: ByteVector, length: Int): ByteVector
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def info(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def info(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging
def isDebugEnabled: Boolean

Attributes
protected
Definition Classes
Logging
def isErrorEnabled: Boolean

Attributes
protected
Definition Classes
Logging
def isInfoEnabled: Boolean

Attributes
protected
Definition Classes
Logging
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isTraceEnabled: Boolean

Attributes
protected
Definition Classes
Logging
def isWarnEnabled: Boolean

Attributes
protected
Definition Classes
Logging
def logger: Logger

Attributes
protected
Definition Classes
Logging
def loggerName: String

Attributes
protected
Definition Classes
Logging
def mac(key: ByteVector, message: ByteVector): ByteVector32
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def peekPayloadLength(payload: ByteVector): Int

Peek at the first bytes of the per-hop payload to extract its length.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def trace(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def trace(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def warn(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def warn(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging
def zeroes(length: Int): ByteVector

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package crypto

object Sphinx extends Logging

Type Members

case class DecryptedFailurePacket(originNode: PublicKey, failureMessage: FailureMessage) extends Product with Serializable

case class DecryptedPacket(payload: ByteVector, nextPacket: wire.OnionRoutingPacket, sharedSecret: ByteVector32) extends Product with Serializable

sealed trait OnionRoutingPacket[T <: PacketType] extends AnyRef

case class PacketAndSecrets(packet: wire.OnionRoutingPacket, sharedSecrets: Seq[(ByteVector32, PublicKey)]) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object FailurePacket

val MacLength: Int

object PaymentPacket extends OnionRoutingPacket[PaymentPacket]

object TrampolinePacket extends OnionRoutingPacket[TrampolinePacket]

final def asInstanceOf[T0]: T0

def blind(pub: PublicKey, blindingFactors: Seq[ByteVector32]): PublicKey

def blind(pub: PublicKey, blindingFactor: ByteVector32): PublicKey

def clone(): AnyRef

def computeBlindingFactor(pub: PublicKey, secret: ByteVector): ByteVector32

def computeEphemeralPublicKeysAndSharedSecrets(sessionKey: PrivateKey, publicKeys: Seq[PublicKey]): (Seq[PublicKey], Seq[ByteVector32])

def computeSharedSecret(pub: PublicKey, secret: PrivateKey): ByteVector32

def debug(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

def debug(msg: ⇒ Any): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

def error(msg: ⇒ Any): Unit

def generateKey(keyType: String, secret: ByteVector32): ByteVector32

def generateKey(keyType: ByteVector, secret: ByteVector32): ByteVector32

def generateStream(key: ByteVector, length: Int): ByteVector

final def getClass(): Class[_]

def hashCode(): Int

def info(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

def info(msg: ⇒ Any): Unit

def isDebugEnabled: Boolean

def isErrorEnabled: Boolean

def isInfoEnabled: Boolean

final def isInstanceOf[T0]: Boolean

def isTraceEnabled: Boolean

def isWarnEnabled: Boolean

def logger: Logger

def loggerName: String

def mac(key: ByteVector, message: ByteVector): ByteVector32

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def peekPayloadLength(payload: ByteVector): Int

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def trace(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

def trace(msg: ⇒ Any): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

def warn(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

def warn(msg: ⇒ Any): Unit

def zeroes(length: Int): ByteVector

Deprecated Value Members

def finalize(): Unit

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped