Skip to content

Commit a28c90a

Browse files
committed
Qualify the BOLT 11 invoice signature type
A previous commit qualified the BOLT 11 invoice type, so any related types should be similarly qualified, if public.
1 parent 8c4a85b commit a28c90a

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

lightning-invoice/src/de.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ use num_traits::{CheckedAdd, CheckedMul};
2323
use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
2424
use secp256k1::PublicKey;
2525

26-
use super::{Bolt11Invoice, Sha256, TaggedField, ExpiryTime, MinFinalCltvExpiryDelta, Fallback, PayeePubKey, InvoiceSignature, PositiveTimestamp,
26+
use super::{Bolt11Invoice, Sha256, TaggedField, ExpiryTime, MinFinalCltvExpiryDelta, Fallback, PayeePubKey, Bolt11InvoiceSignature, PositiveTimestamp,
2727
Bolt11SemanticError, PrivateRoute, Bolt11ParseError, ParseOrSemanticError, Description, RawTaggedField, Currency, RawHrp, SiPrefix, RawBolt11Invoice,
2828
constants, SignedRawBolt11Invoice, RawDataPart, Bolt11InvoiceFeatures};
2929

@@ -292,7 +292,7 @@ impl FromStr for SignedRawBolt11Invoice {
292292
hrp.as_bytes(),
293293
&data[..data.len()-104]
294294
),
295-
signature: InvoiceSignature::from_base32(&data[data.len()-104..])?,
295+
signature: Bolt11InvoiceSignature::from_base32(&data[data.len()-104..])?,
296296
})
297297
}
298298
}
@@ -365,17 +365,17 @@ impl FromBase32 for PositiveTimestamp {
365365
}
366366
}
367367

368-
impl FromBase32 for InvoiceSignature {
368+
impl FromBase32 for Bolt11InvoiceSignature {
369369
type Err = Bolt11ParseError;
370370
fn from_base32(signature: &[u5]) -> Result<Self, Self::Err> {
371371
if signature.len() != 104 {
372-
return Err(Bolt11ParseError::InvalidSliceLength("InvoiceSignature::from_base32()".into()));
372+
return Err(Bolt11ParseError::InvalidSliceLength("Bolt11InvoiceSignature::from_base32()".into()));
373373
}
374374
let recoverable_signature_bytes = Vec::<u8>::from_base32(signature)?;
375375
let signature = &recoverable_signature_bytes[0..64];
376376
let recovery_id = RecoveryId::from_i32(recoverable_signature_bytes[64] as i32)?;
377377

378-
Ok(InvoiceSignature(RecoverableSignature::from_compact(
378+
Ok(Bolt11InvoiceSignature(RecoverableSignature::from_compact(
379379
signature,
380380
recovery_id
381381
)?))
@@ -972,7 +972,7 @@ mod test {
972972
use lightning::ln::features::Bolt11InvoiceFeatures;
973973
use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
974974
use crate::TaggedField::*;
975-
use crate::{SiPrefix, SignedRawBolt11Invoice, InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart,
975+
use crate::{SiPrefix, SignedRawBolt11Invoice, Bolt11InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart,
976976
Currency, Sha256, PositiveTimestamp};
977977

978978
// Feature bits 9, 15, and 99 are set.
@@ -998,7 +998,7 @@ mod test {
998998
hash: [0xb1, 0x96, 0x46, 0xc3, 0xbc, 0x56, 0x76, 0x1d, 0x20, 0x65, 0x6e, 0x0e, 0x32,
999999
0xec, 0xd2, 0x69, 0x27, 0xb7, 0x62, 0x6e, 0x2a, 0x8b, 0xe6, 0x97, 0x71, 0x9f,
10001000
0xf8, 0x7e, 0x44, 0x54, 0x55, 0xb9],
1001-
signature: InvoiceSignature(RecoverableSignature::from_compact(
1001+
signature: Bolt11InvoiceSignature(RecoverableSignature::from_compact(
10021002
&[0xd7, 0x90, 0x4c, 0xc4, 0xb7, 0x4a, 0x22, 0x26, 0x9c, 0x68, 0xc1, 0xdf, 0x68,
10031003
0xa9, 0x6c, 0x21, 0x4d, 0x65, 0x1b, 0x93, 0x76, 0xe9, 0xf1, 0x64, 0xd3, 0x60,
10041004
0x4d, 0xa4, 0xb7, 0xde, 0xcc, 0xce, 0x0e, 0x82, 0xaa, 0xab, 0x4c, 0x85, 0xd3,
@@ -1018,7 +1018,7 @@ mod test {
10181018
fn test_raw_signed_invoice_deserialization() {
10191019
use crate::TaggedField::*;
10201020
use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
1021-
use crate::{SignedRawBolt11Invoice, InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256,
1021+
use crate::{SignedRawBolt11Invoice, Bolt11InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256,
10221022
PositiveTimestamp};
10231023

10241024
assert_eq!(
@@ -1051,7 +1051,7 @@ mod test {
10511051
0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
10521052
0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
10531053
],
1054-
signature: InvoiceSignature(RecoverableSignature::from_compact(
1054+
signature: Bolt11InvoiceSignature(RecoverableSignature::from_compact(
10551055
& [
10561056
0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
10571057
0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,

lightning-invoice/src/lib.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ pub struct SignedRawBolt11Invoice {
288288
hash: [u8; 32],
289289

290290
/// signature of the payment request
291-
signature: InvoiceSignature,
291+
signature: Bolt11InvoiceSignature,
292292
}
293293

294294
/// Represents an syntactically correct [`Bolt11Invoice`] for a payment on the lightning network,
@@ -499,15 +499,15 @@ pub enum Fallback {
499499

500500
/// Recoverable signature
501501
#[derive(Clone, Debug, Hash, Eq, PartialEq)]
502-
pub struct InvoiceSignature(pub RecoverableSignature);
502+
pub struct Bolt11InvoiceSignature(pub RecoverableSignature);
503503

504-
impl PartialOrd for InvoiceSignature {
504+
impl PartialOrd for Bolt11InvoiceSignature {
505505
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
506506
self.0.serialize_compact().1.partial_cmp(&other.0.serialize_compact().1)
507507
}
508508
}
509509

510-
impl Ord for InvoiceSignature {
510+
impl Ord for Bolt11InvoiceSignature {
511511
fn cmp(&self, other: &Self) -> Ordering {
512512
self.0.serialize_compact().1.cmp(&other.0.serialize_compact().1)
513513
}
@@ -855,7 +855,7 @@ impl SignedRawBolt11Invoice {
855855
/// 1. raw invoice
856856
/// 2. hash of the raw invoice
857857
/// 3. signature
858-
pub fn into_parts(self) -> (RawBolt11Invoice, [u8; 32], InvoiceSignature) {
858+
pub fn into_parts(self) -> (RawBolt11Invoice, [u8; 32], Bolt11InvoiceSignature) {
859859
(self.raw_invoice, self.hash, self.signature)
860860
}
861861

@@ -870,7 +870,7 @@ impl SignedRawBolt11Invoice {
870870
}
871871

872872
/// Signature for the invoice.
873-
pub fn signature(&self) -> &InvoiceSignature {
873+
pub fn signature(&self) -> &Bolt11InvoiceSignature {
874874
&self.signature
875875
}
876876

@@ -1004,7 +1004,7 @@ impl RawBolt11Invoice {
10041004
Ok(SignedRawBolt11Invoice {
10051005
raw_invoice: self,
10061006
hash: raw_hash,
1007-
signature: InvoiceSignature(signature),
1007+
signature: Bolt11InvoiceSignature(signature),
10081008
})
10091009
}
10101010

@@ -1591,7 +1591,7 @@ impl Deref for PrivateRoute {
15911591
}
15921592
}
15931593

1594-
impl Deref for InvoiceSignature {
1594+
impl Deref for Bolt11InvoiceSignature {
15951595
type Target = RecoverableSignature;
15961596

15971597
fn deref(&self) -> &RecoverableSignature {
@@ -1797,7 +1797,7 @@ mod test {
17971797
use secp256k1::Secp256k1;
17981798
use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
17991799
use secp256k1::{SecretKey, PublicKey};
1800-
use crate::{SignedRawBolt11Invoice, InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256,
1800+
use crate::{SignedRawBolt11Invoice, Bolt11InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256,
18011801
PositiveTimestamp};
18021802

18031803
let invoice = SignedRawBolt11Invoice {
@@ -1826,7 +1826,7 @@ mod test {
18261826
0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
18271827
0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
18281828
],
1829-
signature: InvoiceSignature(RecoverableSignature::from_compact(
1829+
signature: Bolt11InvoiceSignature(RecoverableSignature::from_compact(
18301830
& [
18311831
0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
18321832
0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,

lightning-invoice/src/ser.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use core::fmt::{Display, Formatter};
33
use bech32::{ToBase32, u5, WriteBase32, Base32Len};
44
use crate::prelude::*;
55

6-
use super::{Bolt11Invoice, Sha256, TaggedField, ExpiryTime, MinFinalCltvExpiryDelta, Fallback, PayeePubKey, InvoiceSignature, PositiveTimestamp,
6+
use super::{Bolt11Invoice, Sha256, TaggedField, ExpiryTime, MinFinalCltvExpiryDelta, Fallback, PayeePubKey, Bolt11InvoiceSignature, PositiveTimestamp,
77
PrivateRoute, Description, RawTaggedField, Currency, RawHrp, SiPrefix, constants, SignedRawBolt11Invoice, RawDataPart};
88

99
/// Converts a stream of bytes written to it to base32. On finalization the according padding will
@@ -456,7 +456,7 @@ impl ToBase32 for TaggedField {
456456
}
457457
}
458458

459-
impl ToBase32 for InvoiceSignature {
459+
impl ToBase32 for Bolt11InvoiceSignature {
460460
fn write_base32<W: WriteBase32>(&self, writer: &mut W) -> Result<(), <W as WriteBase32>::Err> {
461461
let mut converter = BytesToBase32::new(writer);
462462
let (recovery_id, signature) = self.0.serialize_compact();

0 commit comments

Comments
 (0)