Package org.ldk.structs

Class SignedRawBolt11Invoice

java.lang.Object

org.ldk.structs.SignedRawBolt11Invoice

public class SignedRawBolt11Invoice
extends Object

Represents a signed [`RawBolt11Invoice`] with cached hash. The signature is not checked and may be invalid. # Invariants The hash has to be either from the deserialized invoice or from the serialized [`RawBolt11Invoice`].

Method Summary

Modifier and Type	Method	Description
boolean	check_signature()	Checks if the signature is valid for the included payee public key or if none exists if it's valid for the recovered signature (which should always be true?).
SignedRawBolt11Invoice	clone()	Creates a copy of the SignedRawBolt11Invoice
boolean	eq(SignedRawBolt11Invoice b)	Checks if two SignedRawBolt11Invoices contain equal inner contents.
boolean	equals(Object o)
protected void	finalize()
static Result_SignedRawBolt11InvoiceBolt11ParseErrorZ	from_str(String s)	Read a SignedRawBolt11Invoice object from a string
long	hash()	Generates a non-cryptographic 64-bit hash of the SignedRawBolt11Invoice.
int	hashCode()
ThreeTuple_RawBolt11Invoice_u832Bolt11InvoiceSignatureZ	into_parts()	Disassembles the `SignedRawBolt11Invoice` into its three parts: 1.
RawBolt11Invoice	raw_invoice()	The [`RawBolt11Invoice`] which was signed.
Result_PayeePubKeySecp256k1ErrorZ	recover_payee_pub_key()	Recovers the public key used for signing the invoice from the recoverable signature.
byte[]	signable_hash()	The hash of the [`RawBolt11Invoice`] that was signed.
Bolt11InvoiceSignature	signature()	Signature for the invoice.
String	to_str()	Get the string representation of a SignedRawBolt11Invoice object

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

eq

public boolean eq(SignedRawBolt11Invoice b)

Checks if two SignedRawBolt11Invoices contain equal inner contents. This ignores pointers and is_owned flags and looks at the values in fields. Two objects with NULL inner values will be considered "equal" here.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

clone

public SignedRawBolt11Invoice clone()

Creates a copy of the SignedRawBolt11Invoice

Overrides:

clone in class Object

hash

public long hash()

Generates a non-cryptographic 64-bit hash of the SignedRawBolt11Invoice.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

into_parts

public ThreeTuple_RawBolt11Invoice_u832Bolt11InvoiceSignatureZ into_parts()

Disassembles the `SignedRawBolt11Invoice` into its three parts: 1. raw invoice 2. hash of the raw invoice 3. signature

raw_invoice

public RawBolt11Invoice raw_invoice()

The [`RawBolt11Invoice`] which was signed.

signable_hash

public byte[] signable_hash()

The hash of the [`RawBolt11Invoice`] that was signed.

signature

public Bolt11InvoiceSignature signature()

Signature for the invoice.

recover_payee_pub_key

public Result_PayeePubKeySecp256k1ErrorZ recover_payee_pub_key()

Recovers the public key used for signing the invoice from the recoverable signature.

check_signature

public boolean check_signature()

Checks if the signature is valid for the included payee public key or if none exists if it's valid for the recovered signature (which should always be true?).

from_str

public static Result_SignedRawBolt11InvoiceBolt11ParseErrorZ from_str(String s)

Read a SignedRawBolt11Invoice object from a string

to_str

public String to_str()

Get the string representation of a SignedRawBolt11Invoice object