Struct CreatePayerProofRequest

pub struct CreatePayerProofRequest {
    pub index: PaymentCreatedIndex,
    pub disclosures: PayerProofDisclosures,
    pub proof_note: Option<String>,
}

A request to prove that an offer was paid. Specifically, it proves that a BOLT 12 invoice was paid.

Fields

index: PaymentCreatedIndex

The index of the payment to create a proof for. Must be a completed outbound offer payment.

disclosures: PayerProofDisclosures

Which of the paid invoice’s optional fields the proof discloses. Defaults to disclosing offer_description, invreq_payer_note, invoice_amount, and invoice_created_at; use PayerProofDisclosures::EMPTY to disclose nothing.

proof_note: Option<String>

An optional note bound to the proof, readable by anyone the proof is shown to. If provided, it must be non-empty and no longer than 200 chars / 512 UTF-8 bytes.

Trait Implementations

impl<'de> Deserialize<'de> for CreatePayerProofRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreatePayerProofRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreatePayerProofRequest> for CreatePayerProofRequest

type Error = Error

The type returned in the event of a conversion error.

fn try_from(req: CreatePayerProofRequest) -> Result<Self>

Performs the conversion.