Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ldk-server-protos/build.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,30 @@ fn generate_protos() {
"#[cfg_attr(feature = \"serde\", derive(serde::Serialize, serde::Deserialize))]",
)
.type_attribute(".", "#[cfg_attr(feature = \"serde\", serde(rename_all = \"snake_case\"))]")
.field_attribute(
"types.Bolt11.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt11Jit.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Offer.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Refund.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Payment.direction",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_direction\"))]",
)
.field_attribute(
"types.Payment.status",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_status\"))]",
)
.compile_protos(
&[
"src/proto/api.proto",
Expand Down
2 changes: 2 additions & 0 deletions ldk-server-protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,6 @@ pub mod api;
pub mod endpoints;
pub mod error;
pub mod events;
#[cfg(feature = "serde")]
pub mod serde_utils;
pub mod types;
57 changes: 57 additions & 0 deletions ldk-server-protos/src/serde_utils.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! Custom serde serializers for proto types.
//!
//! These are used via `#[serde(serialize_with = "...")]` attributes on generated
//! proto fields to produce human-readable output (hex strings for bytes, enum
//! names for integer enum fields).

use std::fmt::Write;

use serde::Serializer;

/// Generates a serde serializer that converts an `i32` proto enum field to its
/// string name via `from_i32()` and `as_str_name()`.
macro_rules! stringify_enum_serializer {
($fn_name:ident, $enum_type:ty) => {
pub fn $fn_name<S>(value: &i32, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let name = match <$enum_type>::from_i32(*value) {
Some(v) => v.as_str_name(),
None => "UNKNOWN",
};
serializer.serialize_str(name)
}
};
}

stringify_enum_serializer!(serialize_payment_direction, crate::types::PaymentDirection);
stringify_enum_serializer!(serialize_payment_status, crate::types::PaymentStatus);

/// Serializes `Option<prost::bytes::Bytes>` as a hex string (or null).
pub fn serialize_opt_bytes_hex<S>(
value: &Option<bytes::Bytes>, serializer: S,
) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
match value {
Some(bytes) => {
let hex = bytes.iter().fold(String::with_capacity(bytes.len() * 2), |mut acc, b| {
let _ = write!(acc, "{b:02x}");
acc
});
serializer.serialize_some(&hex)
},
None => serializer.serialize_none(),
}
}
24 changes: 24 additions & 0 deletions ldk-server-protos/src/types.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,17 @@ pub struct Payment {
pub fee_paid_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_direction")
)]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_status")
)]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
Expand DownExpand Up@@ -138,6 +146,10 @@ pub struct Bolt11 {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
Expand All@@ -154,6 +166,10 @@ pub struct Bolt11Jit {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
Expand DownExpand Up@@ -184,6 +200,10 @@ pub struct Bolt12Offer {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
Expand DownExpand Up@@ -213,6 +233,10 @@ pub struct Bolt12Refund {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The payer's note for the payment.
/// Truncated to \[PAYER_NOTE_LIMIT\](<https://docs.rs/lightning/latest/lightning/offers/invoice_request/constant.PAYER_NOTE_LIMIT.html>).
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add serde serializers for Bytes and Enums in protos by benthecarman · Pull Request #122 · lightningdevkit/ldk-server · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ldk-server-protos/build.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,30 @@ fn generate_protos() {
"#[cfg_attr(feature = \"serde\", derive(serde::Serialize, serde::Deserialize))]",
)
.type_attribute(".", "#[cfg_attr(feature = \"serde\", serde(rename_all = \"snake_case\"))]")
.field_attribute(
"types.Bolt11.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt11Jit.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Offer.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Refund.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Payment.direction",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_direction\"))]",
)
.field_attribute(
"types.Payment.status",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_status\"))]",
)
.compile_protos(
&[
"src/proto/api.proto",
Expand Down
2 changes: 2 additions & 0 deletions ldk-server-protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,6 @@ pub mod api;
pub mod endpoints;
pub mod error;
pub mod events;
#[cfg(feature = "serde")]
pub mod serde_utils;
pub mod types;
57 changes: 57 additions & 0 deletions ldk-server-protos/src/serde_utils.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! Custom serde serializers for proto types.
//!
//! These are used via `#[serde(serialize_with = "...")]` attributes on generated
//! proto fields to produce human-readable output (hex strings for bytes, enum
//! names for integer enum fields).

use std::fmt::Write;

use serde::Serializer;

/// Generates a serde serializer that converts an `i32` proto enum field to its
/// string name via `from_i32()` and `as_str_name()`.
macro_rules! stringify_enum_serializer {
($fn_name:ident, $enum_type:ty) => {
pub fn $fn_name<S>(value: &i32, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let name = match <$enum_type>::from_i32(*value) {
Some(v) => v.as_str_name(),
None => "UNKNOWN",
};
serializer.serialize_str(name)
}
};
}

stringify_enum_serializer!(serialize_payment_direction, crate::types::PaymentDirection);
stringify_enum_serializer!(serialize_payment_status, crate::types::PaymentStatus);

/// Serializes `Option<prost::bytes::Bytes>` as a hex string (or null).
pub fn serialize_opt_bytes_hex<S>(
value: &Option<bytes::Bytes>, serializer: S,
) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
match value {
Some(bytes) => {
let hex = bytes.iter().fold(String::with_capacity(bytes.len() * 2), |mut acc, b| {
let _ = write!(acc, "{b:02x}");
acc
});
serializer.serialize_some(&hex)
},
None => serializer.serialize_none(),
}
}
24 changes: 24 additions & 0 deletions ldk-server-protos/src/types.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,17 @@ pub struct Payment {
pub fee_paid_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_direction")
)]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_status")
)]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
Expand DownExpand Up@@ -138,6 +146,10 @@ pub struct Bolt11 {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
Expand All@@ -154,6 +166,10 @@ pub struct Bolt11Jit {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
Expand DownExpand Up@@ -184,6 +200,10 @@ pub struct Bolt12Offer {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
Expand DownExpand Up@@ -213,6 +233,10 @@ pub struct Bolt12Refund {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The payer's note for the payment.
/// Truncated to \[PAYER_NOTE_LIMIT\](<https://docs.rs/lightning/latest/lightning/offers/invoice_request/constant.PAYER_NOTE_LIMIT.html>).
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add serde serializers for Bytes and Enums in protos by benthecarman · Pull Request #122 · lightningdevkit/ldk-server · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ldk-server-protos/build.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,30 @@ fn generate_protos() {
"#[cfg_attr(feature = \"serde\", derive(serde::Serialize, serde::Deserialize))]",
)
.type_attribute(".", "#[cfg_attr(feature = \"serde\", serde(rename_all = \"snake_case\"))]")
.field_attribute(
"types.Bolt11.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt11Jit.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Offer.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Refund.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Payment.direction",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_direction\"))]",
)
.field_attribute(
"types.Payment.status",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_status\"))]",
)
.compile_protos(
&[
"src/proto/api.proto",
Expand Down
2 changes: 2 additions & 0 deletions ldk-server-protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,6 @@ pub mod api;
pub mod endpoints;
pub mod error;
pub mod events;
#[cfg(feature = "serde")]
pub mod serde_utils;
pub mod types;
57 changes: 57 additions & 0 deletions ldk-server-protos/src/serde_utils.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! Custom serde serializers for proto types.
//!
//! These are used via `#[serde(serialize_with = "...")]` attributes on generated
//! proto fields to produce human-readable output (hex strings for bytes, enum
//! names for integer enum fields).

use std::fmt::Write;

use serde::Serializer;

/// Generates a serde serializer that converts an `i32` proto enum field to its
/// string name via `from_i32()` and `as_str_name()`.
macro_rules! stringify_enum_serializer {
($fn_name:ident, $enum_type:ty) => {
pub fn $fn_name<S>(value: &i32, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let name = match <$enum_type>::from_i32(*value) {
Some(v) => v.as_str_name(),
None => "UNKNOWN",
};
serializer.serialize_str(name)
}
};
}

stringify_enum_serializer!(serialize_payment_direction, crate::types::PaymentDirection);
stringify_enum_serializer!(serialize_payment_status, crate::types::PaymentStatus);

/// Serializes `Option<prost::bytes::Bytes>` as a hex string (or null).
pub fn serialize_opt_bytes_hex<S>(
value: &Option<bytes::Bytes>, serializer: S,
) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
match value {
Some(bytes) => {
let hex = bytes.iter().fold(String::with_capacity(bytes.len() * 2), |mut acc, b| {
let _ = write!(acc, "{b:02x}");
acc
});
serializer.serialize_some(&hex)
},
None => serializer.serialize_none(),
}
}
24 changes: 24 additions & 0 deletions ldk-server-protos/src/types.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,17 @@ pub struct Payment {
pub fee_paid_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_direction")
)]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_status")
)]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
Expand DownExpand Up@@ -138,6 +146,10 @@ pub struct Bolt11 {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
Expand All@@ -154,6 +166,10 @@ pub struct Bolt11Jit {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
Expand DownExpand Up@@ -184,6 +200,10 @@ pub struct Bolt12Offer {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
Expand DownExpand Up@@ -213,6 +233,10 @@ pub struct Bolt12Refund {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The payer's note for the payment.
/// Truncated to \[PAYER_NOTE_LIMIT\](<https://docs.rs/lightning/latest/lightning/offers/invoice_request/constant.PAYER_NOTE_LIMIT.html>).
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add serde serializers for Bytes and Enums in protos by benthecarman · Pull Request #122 · lightningdevkit/ldk-server · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ldk-server-protos/build.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,30 @@ fn generate_protos() {
"#[cfg_attr(feature = \"serde\", derive(serde::Serialize, serde::Deserialize))]",
)
.type_attribute(".", "#[cfg_attr(feature = \"serde\", serde(rename_all = \"snake_case\"))]")
.field_attribute(
"types.Bolt11.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt11Jit.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Offer.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Refund.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Payment.direction",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_direction\"))]",
)
.field_attribute(
"types.Payment.status",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_status\"))]",
)
.compile_protos(
&[
"src/proto/api.proto",
Expand Down
2 changes: 2 additions & 0 deletions ldk-server-protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,6 @@ pub mod api;
pub mod endpoints;
pub mod error;
pub mod events;
#[cfg(feature = "serde")]
pub mod serde_utils;
pub mod types;
57 changes: 57 additions & 0 deletions ldk-server-protos/src/serde_utils.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! Custom serde serializers for proto types.
//!
//! These are used via `#[serde(serialize_with = "...")]` attributes on generated
//! proto fields to produce human-readable output (hex strings for bytes, enum
//! names for integer enum fields).

use std::fmt::Write;

use serde::Serializer;

/// Generates a serde serializer that converts an `i32` proto enum field to its
/// string name via `from_i32()` and `as_str_name()`.
macro_rules! stringify_enum_serializer {
($fn_name:ident, $enum_type:ty) => {
pub fn $fn_name<S>(value: &i32, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let name = match <$enum_type>::from_i32(*value) {
Some(v) => v.as_str_name(),
None => "UNKNOWN",
};
serializer.serialize_str(name)
}
};
}

stringify_enum_serializer!(serialize_payment_direction, crate::types::PaymentDirection);
stringify_enum_serializer!(serialize_payment_status, crate::types::PaymentStatus);

/// Serializes `Option<prost::bytes::Bytes>` as a hex string (or null).
pub fn serialize_opt_bytes_hex<S>(
value: &Option<bytes::Bytes>, serializer: S,
) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
match value {
Some(bytes) => {
let hex = bytes.iter().fold(String::with_capacity(bytes.len() * 2), |mut acc, b| {
let _ = write!(acc, "{b:02x}");
acc
});
serializer.serialize_some(&hex)
},
None => serializer.serialize_none(),
}
}
24 changes: 24 additions & 0 deletions ldk-server-protos/src/types.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,17 @@ pub struct Payment {
pub fee_paid_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_direction")
)]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_status")
)]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
Expand DownExpand Up@@ -138,6 +146,10 @@ pub struct Bolt11 {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
Expand All@@ -154,6 +166,10 @@ pub struct Bolt11Jit {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
Expand DownExpand Up@@ -184,6 +200,10 @@ pub struct Bolt12Offer {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
Expand DownExpand Up@@ -213,6 +233,10 @@ pub struct Bolt12Refund {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The payer's note for the payment.
/// Truncated to \[PAYER_NOTE_LIMIT\](<https://docs.rs/lightning/latest/lightning/offers/invoice_request/constant.PAYER_NOTE_LIMIT.html>).
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Add serde serializers for Bytes and Enums in protos by benthecarman · Pull Request #122 · lightningdevkit/ldk-server · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ldk-server-protos/build.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,30 @@ fn generate_protos() {
"#[cfg_attr(feature = \"serde\", derive(serde::Serialize, serde::Deserialize))]",
)
.type_attribute(".", "#[cfg_attr(feature = \"serde\", serde(rename_all = \"snake_case\"))]")
.field_attribute(
"types.Bolt11.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt11Jit.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Offer.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Refund.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Payment.direction",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_direction\"))]",
)
.field_attribute(
"types.Payment.status",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_status\"))]",
)
.compile_protos(
&[
"src/proto/api.proto",
Expand Down
2 changes: 2 additions & 0 deletions ldk-server-protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,6 @@ pub mod api;
pub mod endpoints;
pub mod error;
pub mod events;
#[cfg(feature = "serde")]
pub mod serde_utils;
pub mod types;
57 changes: 57 additions & 0 deletions ldk-server-protos/src/serde_utils.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! Custom serde serializers for proto types.
//!
//! These are used via `#[serde(serialize_with = "...")]` attributes on generated
//! proto fields to produce human-readable output (hex strings for bytes, enum
//! names for integer enum fields).

use std::fmt::Write;

use serde::Serializer;

/// Generates a serde serializer that converts an `i32` proto enum field to its
/// string name via `from_i32()` and `as_str_name()`.
macro_rules! stringify_enum_serializer {
($fn_name:ident, $enum_type:ty) => {
pub fn $fn_name<S>(value: &i32, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let name = match <$enum_type>::from_i32(*value) {
Some(v) => v.as_str_name(),
None => "UNKNOWN",
};
serializer.serialize_str(name)
}
};
}

stringify_enum_serializer!(serialize_payment_direction, crate::types::PaymentDirection);
stringify_enum_serializer!(serialize_payment_status, crate::types::PaymentStatus);

/// Serializes `Option<prost::bytes::Bytes>` as a hex string (or null).
pub fn serialize_opt_bytes_hex<S>(
value: &Option<bytes::Bytes>, serializer: S,
) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
match value {
Some(bytes) => {
let hex = bytes.iter().fold(String::with_capacity(bytes.len() * 2), |mut acc, b| {
let _ = write!(acc, "{b:02x}");
acc
});
serializer.serialize_some(&hex)
},
None => serializer.serialize_none(),
}
}
24 changes: 24 additions & 0 deletions ldk-server-protos/src/types.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,17 @@ pub struct Payment {
pub fee_paid_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_direction")
)]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_status")
)]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
Expand DownExpand Up@@ -138,6 +146,10 @@ pub struct Bolt11 {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
Expand All@@ -154,6 +166,10 @@ pub struct Bolt11Jit {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
Expand DownExpand Up@@ -184,6 +200,10 @@ pub struct Bolt12Offer {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
Expand DownExpand Up@@ -213,6 +233,10 @@ pub struct Bolt12Refund {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The payer's note for the payment.
/// Truncated to \[PAYER_NOTE_LIMIT\](<https://docs.rs/lightning/latest/lightning/offers/invoice_request/constant.PAYER_NOTE_LIMIT.html>).
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add serde serializers for Bytes and Enums in protos by benthecarman · Pull Request #122 · lightningdevkit/ldk-server · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ldk-server-protos/build.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,30 @@ fn generate_protos() {
"#[cfg_attr(feature = \"serde\", derive(serde::Serialize, serde::Deserialize))]",
)
.type_attribute(".", "#[cfg_attr(feature = \"serde\", serde(rename_all = \"snake_case\"))]")
.field_attribute(
"types.Bolt11.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt11Jit.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Offer.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Refund.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Payment.direction",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_direction\"))]",
)
.field_attribute(
"types.Payment.status",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_status\"))]",
)
.compile_protos(
&[
"src/proto/api.proto",
Expand Down
2 changes: 2 additions & 0 deletions ldk-server-protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,6 @@ pub mod api;
pub mod endpoints;
pub mod error;
pub mod events;
#[cfg(feature = "serde")]
pub mod serde_utils;
pub mod types;
57 changes: 57 additions & 0 deletions ldk-server-protos/src/serde_utils.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! Custom serde serializers for proto types.
//!
//! These are used via `#[serde(serialize_with = "...")]` attributes on generated
//! proto fields to produce human-readable output (hex strings for bytes, enum
//! names for integer enum fields).

use std::fmt::Write;

use serde::Serializer;

/// Generates a serde serializer that converts an `i32` proto enum field to its
/// string name via `from_i32()` and `as_str_name()`.
macro_rules! stringify_enum_serializer {
($fn_name:ident, $enum_type:ty) => {
pub fn $fn_name<S>(value: &i32, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let name = match <$enum_type>::from_i32(*value) {
Some(v) => v.as_str_name(),
None => "UNKNOWN",
};
serializer.serialize_str(name)
}
};
}

stringify_enum_serializer!(serialize_payment_direction, crate::types::PaymentDirection);
stringify_enum_serializer!(serialize_payment_status, crate::types::PaymentStatus);

/// Serializes `Option<prost::bytes::Bytes>` as a hex string (or null).
pub fn serialize_opt_bytes_hex<S>(
value: &Option<bytes::Bytes>, serializer: S,
) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
match value {
Some(bytes) => {
let hex = bytes.iter().fold(String::with_capacity(bytes.len() * 2), |mut acc, b| {
let _ = write!(acc, "{b:02x}");
acc
});
serializer.serialize_some(&hex)
},
None => serializer.serialize_none(),
}
}
24 changes: 24 additions & 0 deletions ldk-server-protos/src/types.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,17 @@ pub struct Payment {
pub fee_paid_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_direction")
)]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_status")
)]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
Expand DownExpand Up@@ -138,6 +146,10 @@ pub struct Bolt11 {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
Expand All@@ -154,6 +166,10 @@ pub struct Bolt11Jit {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
Expand DownExpand Up@@ -184,6 +200,10 @@ pub struct Bolt12Offer {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
Expand DownExpand Up@@ -213,6 +233,10 @@ pub struct Bolt12Refund {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The payer's note for the payment.
/// Truncated to \[PAYER_NOTE_LIMIT\](<https://docs.rs/lightning/latest/lightning/offers/invoice_request/constant.PAYER_NOTE_LIMIT.html>).
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add serde serializers for Bytes and Enums in protos by benthecarman · Pull Request #122 · lightningdevkit/ldk-server · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ldk-server-protos/build.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,30 @@ fn generate_protos() {
"#[cfg_attr(feature = \"serde\", derive(serde::Serialize, serde::Deserialize))]",
)
.type_attribute(".", "#[cfg_attr(feature = \"serde\", serde(rename_all = \"snake_case\"))]")
.field_attribute(
"types.Bolt11.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt11Jit.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Offer.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Refund.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Payment.direction",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_direction\"))]",
)
.field_attribute(
"types.Payment.status",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_status\"))]",
)
.compile_protos(
&[
"src/proto/api.proto",
Expand Down
2 changes: 2 additions & 0 deletions ldk-server-protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,6 @@ pub mod api;
pub mod endpoints;
pub mod error;
pub mod events;
#[cfg(feature = "serde")]
pub mod serde_utils;
pub mod types;
57 changes: 57 additions & 0 deletions ldk-server-protos/src/serde_utils.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! Custom serde serializers for proto types.
//!
//! These are used via `#[serde(serialize_with = "...")]` attributes on generated
//! proto fields to produce human-readable output (hex strings for bytes, enum
//! names for integer enum fields).

use std::fmt::Write;

use serde::Serializer;

/// Generates a serde serializer that converts an `i32` proto enum field to its
/// string name via `from_i32()` and `as_str_name()`.
macro_rules! stringify_enum_serializer {
($fn_name:ident, $enum_type:ty) => {
pub fn $fn_name<S>(value: &i32, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let name = match <$enum_type>::from_i32(*value) {
Some(v) => v.as_str_name(),
None => "UNKNOWN",
};
serializer.serialize_str(name)
}
};
}

stringify_enum_serializer!(serialize_payment_direction, crate::types::PaymentDirection);
stringify_enum_serializer!(serialize_payment_status, crate::types::PaymentStatus);

/// Serializes `Option<prost::bytes::Bytes>` as a hex string (or null).
pub fn serialize_opt_bytes_hex<S>(
value: &Option<bytes::Bytes>, serializer: S,
) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
match value {
Some(bytes) => {
let hex = bytes.iter().fold(String::with_capacity(bytes.len() * 2), |mut acc, b| {
let _ = write!(acc, "{b:02x}");
acc
});
serializer.serialize_some(&hex)
},
None => serializer.serialize_none(),
}
}
24 changes: 24 additions & 0 deletions ldk-server-protos/src/types.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,17 @@ pub struct Payment {
pub fee_paid_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_direction")
)]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_status")
)]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
Expand DownExpand Up@@ -138,6 +146,10 @@ pub struct Bolt11 {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
Expand All@@ -154,6 +166,10 @@ pub struct Bolt11Jit {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
Expand DownExpand Up@@ -184,6 +200,10 @@ pub struct Bolt12Offer {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
Expand DownExpand Up@@ -213,6 +233,10 @@ pub struct Bolt12Refund {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The payer's note for the payment.
/// Truncated to \[PAYER_NOTE_LIMIT\](<https://docs.rs/lightning/latest/lightning/offers/invoice_request/constant.PAYER_NOTE_LIMIT.html>).
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Add serde serializers for Bytes and Enums in protos by benthecarman · Pull Request #122 · lightningdevkit/ldk-server · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ldk-server-protos/build.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,30 @@ fn generate_protos() {
"#[cfg_attr(feature = \"serde\", derive(serde::Serialize, serde::Deserialize))]",
)
.type_attribute(".", "#[cfg_attr(feature = \"serde\", serde(rename_all = \"snake_case\"))]")
.field_attribute(
"types.Bolt11.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt11Jit.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Offer.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Bolt12Refund.secret",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_opt_bytes_hex\"))]",
)
.field_attribute(
"types.Payment.direction",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_direction\"))]",
)
.field_attribute(
"types.Payment.status",
"#[cfg_attr(feature = \"serde\", serde(serialize_with = \"crate::serde_utils::serialize_payment_status\"))]",
)
.compile_protos(
&[
"src/proto/api.proto",
Expand Down
2 changes: 2 additions & 0 deletions ldk-server-protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,6 @@ pub mod api;
pub mod endpoints;
pub mod error;
pub mod events;
#[cfg(feature = "serde")]
pub mod serde_utils;
pub mod types;
57 changes: 57 additions & 0 deletions ldk-server-protos/src/serde_utils.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! Custom serde serializers for proto types.
//!
//! These are used via `#[serde(serialize_with = "...")]` attributes on generated
//! proto fields to produce human-readable output (hex strings for bytes, enum
//! names for integer enum fields).

use std::fmt::Write;

use serde::Serializer;

/// Generates a serde serializer that converts an `i32` proto enum field to its
/// string name via `from_i32()` and `as_str_name()`.
macro_rules! stringify_enum_serializer {
($fn_name:ident, $enum_type:ty) => {
pub fn $fn_name<S>(value: &i32, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
let name = match <$enum_type>::from_i32(*value) {
Some(v) => v.as_str_name(),
None => "UNKNOWN",
};
serializer.serialize_str(name)
}
};
}

stringify_enum_serializer!(serialize_payment_direction, crate::types::PaymentDirection);
stringify_enum_serializer!(serialize_payment_status, crate::types::PaymentStatus);

/// Serializes `Option<prost::bytes::Bytes>` as a hex string (or null).
pub fn serialize_opt_bytes_hex<S>(
value: &Option<bytes::Bytes>, serializer: S,
) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
match value {
Some(bytes) => {
let hex = bytes.iter().fold(String::with_capacity(bytes.len() * 2), |mut acc, b| {
let _ = write!(acc, "{b:02x}");
acc
});
serializer.serialize_some(&hex)
},
None => serializer.serialize_none(),
}
}
24 changes: 24 additions & 0 deletions ldk-server-protos/src/types.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,9 +31,17 @@ pub struct Payment {
pub fee_paid_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_direction")
)]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_payment_status")
)]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
Expand DownExpand Up@@ -138,6 +146,10 @@ pub struct Bolt11 {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
Expand All@@ -154,6 +166,10 @@ pub struct Bolt11Jit {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
Expand DownExpand Up@@ -184,6 +200,10 @@ pub struct Bolt12Offer {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
Expand DownExpand Up@@ -213,6 +233,10 @@ pub struct Bolt12Refund {
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
#[cfg_attr(
feature = "serde",
serde(serialize_with = "crate::serde_utils::serialize_opt_bytes_hex")
)]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The payer's note for the payment.
/// Truncated to \[PAYER_NOTE_LIMIT\](<https://docs.rs/lightning/latest/lightning/offers/invoice_request/constant.PAYER_NOTE_LIMIT.html>).
Expand Down