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
258 changes: 258 additions & 0 deletions protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,6 +322,202 @@ pub struct ListChannelsResponse {
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<Channel>,
}
/// Returns payment details for a given payment_id.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.payment>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsRequest {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub payment_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsResponse {
/// Represents a payment.
/// Will be `None` if payment doesn't exist.
#[prost(message, optional, tag = "1")]
pub payment: ::core::option::Option<Payment>,
}
/// Retrieves list of all payments.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsResponse {
/// List of payments.
#[prost(message, repeated, tag = "1")]
pub payments: ::prost::alloc::vec::Vec<Payment>,
}
/// Represents a payment.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.PaymentDetails.html>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payment {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The kind of the payment.
#[prost(message, optional, tag = "2")]
pub kind: ::core::option::Option<PaymentKind>,
/// The amount transferred.
#[prost(uint64, optional, tag = "3")]
pub amount_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
pub latest_update_timestamp: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PaymentKind {
#[prost(oneof = "payment_kind::Kind", tags = "1, 2, 3, 4, 5, 6")]
pub kind: ::core::option::Option<payment_kind::Kind>,
}
/// Nested message and enum types in `PaymentKind`.
pub mod payment_kind {
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
#[prost(message, tag = "1")]
Onchain(super::Onchain),
#[prost(message, tag = "2")]
Bolt11(super::Bolt11),
#[prost(message, tag = "3")]
Bolt11Jit(super::Bolt11Jit),
#[prost(message, tag = "4")]
Bolt12Offer(super::Bolt12Offer),
#[prost(message, tag = "5")]
Bolt12Refund(super::Bolt12Refund),
#[prost(message, tag = "6")]
Spontaneous(super::Spontaneous),
}
}
/// Represents an on-chain payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Onchain {}
/// Represents a BOLT 11 payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11 {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11Jit {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
/// Allowing them to deduct this fee from the first inbound payment will pay for the LSP’s channel opening fees.
///
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\](<https://docs.rs/lightning/latest/lightning/util/config/struct.ChannelConfig.html#structfield.accept_underpaying_htlcs>)
/// for more information.
#[prost(message, optional, tag = "4")]
pub lsp_fee_limits: ::core::option::Option<LspFeeLimits>,
}
/// Represents a BOLT 12 ‘offer’ payment, i.e., a payment for an Offer.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Offer {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
pub offer_id: ::prost::alloc::string::String,
/// 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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a BOLT 12 ‘refund’ payment, i.e., a payment for a Refund.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Refund {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a spontaneous (“keysend”) payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Spontaneous {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
}
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\] for more information.
///
/// \[`LdkChannelConfig::accept_underpaying_htlcs`\]: lightning::util::config::ChannelConfig::accept_underpaying_htlcs
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LspFeeLimits {
/// The maximal total amount we allow any configured LSP withhold from us when forwarding the
/// payment.
#[prost(uint64, optional, tag = "1")]
pub max_total_opening_fee_msat: ::core::option::Option<u64>,
/// The maximal proportional fee, in parts-per-million millisatoshi, we allow any configured
/// LSP withhold from us when forwarding the payment.
#[prost(uint64, optional, tag = "2")]
pub max_proportional_opening_fee_ppm_msat: ::core::option::Option<u64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Channel {
Expand DownExpand Up@@ -473,3 +669,65 @@ pub struct BestBlock {
#[prost(uint32, tag = "2")]
pub height: u32,
}
/// Represents the direction of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentDirection {
/// The payment is inbound.
Inbound = 0,
/// The payment is outbound.
Outbound = 1,
}
impl PaymentDirection {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentDirection::Inbound => "INBOUND",
PaymentDirection::Outbound => "OUTBOUND",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INBOUND" => Some(Self::Inbound),
"OUTBOUND" => Some(Self::Outbound),
_ => None,
}
}
}
/// Represents the current status of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentStatus {
/// The payment is still pending.
Pending = 0,
/// The payment succeeded.
Succeeded = 1,
/// The payment failed.
Failed = 2,
}
impl PaymentStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentStatus::Pending => "PENDING",
PaymentStatus::Succeeded => "SUCCEEDED",
PaymentStatus::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PENDING" => Some(Self::Pending),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
Loading
, '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" + '
Implement GetPaymentDetails and ListPayments Api. by G8XSU · Pull Request #15 · 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
258 changes: 258 additions & 0 deletions protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,6 +322,202 @@ pub struct ListChannelsResponse {
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<Channel>,
}
/// Returns payment details for a given payment_id.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.payment>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsRequest {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub payment_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsResponse {
/// Represents a payment.
/// Will be `None` if payment doesn't exist.
#[prost(message, optional, tag = "1")]
pub payment: ::core::option::Option<Payment>,
}
/// Retrieves list of all payments.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsResponse {
/// List of payments.
#[prost(message, repeated, tag = "1")]
pub payments: ::prost::alloc::vec::Vec<Payment>,
}
/// Represents a payment.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.PaymentDetails.html>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payment {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The kind of the payment.
#[prost(message, optional, tag = "2")]
pub kind: ::core::option::Option<PaymentKind>,
/// The amount transferred.
#[prost(uint64, optional, tag = "3")]
pub amount_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
pub latest_update_timestamp: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PaymentKind {
#[prost(oneof = "payment_kind::Kind", tags = "1, 2, 3, 4, 5, 6")]
pub kind: ::core::option::Option<payment_kind::Kind>,
}
/// Nested message and enum types in `PaymentKind`.
pub mod payment_kind {
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
#[prost(message, tag = "1")]
Onchain(super::Onchain),
#[prost(message, tag = "2")]
Bolt11(super::Bolt11),
#[prost(message, tag = "3")]
Bolt11Jit(super::Bolt11Jit),
#[prost(message, tag = "4")]
Bolt12Offer(super::Bolt12Offer),
#[prost(message, tag = "5")]
Bolt12Refund(super::Bolt12Refund),
#[prost(message, tag = "6")]
Spontaneous(super::Spontaneous),
}
}
/// Represents an on-chain payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Onchain {}
/// Represents a BOLT 11 payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11 {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11Jit {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
/// Allowing them to deduct this fee from the first inbound payment will pay for the LSP’s channel opening fees.
///
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\](<https://docs.rs/lightning/latest/lightning/util/config/struct.ChannelConfig.html#structfield.accept_underpaying_htlcs>)
/// for more information.
#[prost(message, optional, tag = "4")]
pub lsp_fee_limits: ::core::option::Option<LspFeeLimits>,
}
/// Represents a BOLT 12 ‘offer’ payment, i.e., a payment for an Offer.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Offer {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
pub offer_id: ::prost::alloc::string::String,
/// 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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a BOLT 12 ‘refund’ payment, i.e., a payment for a Refund.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Refund {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a spontaneous (“keysend”) payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Spontaneous {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
}
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\] for more information.
///
/// \[`LdkChannelConfig::accept_underpaying_htlcs`\]: lightning::util::config::ChannelConfig::accept_underpaying_htlcs
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LspFeeLimits {
/// The maximal total amount we allow any configured LSP withhold from us when forwarding the
/// payment.
#[prost(uint64, optional, tag = "1")]
pub max_total_opening_fee_msat: ::core::option::Option<u64>,
/// The maximal proportional fee, in parts-per-million millisatoshi, we allow any configured
/// LSP withhold from us when forwarding the payment.
#[prost(uint64, optional, tag = "2")]
pub max_proportional_opening_fee_ppm_msat: ::core::option::Option<u64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Channel {
Expand DownExpand Up@@ -473,3 +669,65 @@ pub struct BestBlock {
#[prost(uint32, tag = "2")]
pub height: u32,
}
/// Represents the direction of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentDirection {
/// The payment is inbound.
Inbound = 0,
/// The payment is outbound.
Outbound = 1,
}
impl PaymentDirection {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentDirection::Inbound => "INBOUND",
PaymentDirection::Outbound => "OUTBOUND",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INBOUND" => Some(Self::Inbound),
"OUTBOUND" => Some(Self::Outbound),
_ => None,
}
}
}
/// Represents the current status of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentStatus {
/// The payment is still pending.
Pending = 0,
/// The payment succeeded.
Succeeded = 1,
/// The payment failed.
Failed = 2,
}
impl PaymentStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentStatus::Pending => "PENDING",
PaymentStatus::Succeeded => "SUCCEEDED",
PaymentStatus::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PENDING" => Some(Self::Pending),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
Loading
, '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('^' + ".*" + ' Implement GetPaymentDetails and ListPayments Api. by G8XSU · Pull Request #15 · 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
258 changes: 258 additions & 0 deletions protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,6 +322,202 @@ pub struct ListChannelsResponse {
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<Channel>,
}
/// Returns payment details for a given payment_id.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.payment>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsRequest {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub payment_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsResponse {
/// Represents a payment.
/// Will be `None` if payment doesn't exist.
#[prost(message, optional, tag = "1")]
pub payment: ::core::option::Option<Payment>,
}
/// Retrieves list of all payments.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsResponse {
/// List of payments.
#[prost(message, repeated, tag = "1")]
pub payments: ::prost::alloc::vec::Vec<Payment>,
}
/// Represents a payment.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.PaymentDetails.html>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payment {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The kind of the payment.
#[prost(message, optional, tag = "2")]
pub kind: ::core::option::Option<PaymentKind>,
/// The amount transferred.
#[prost(uint64, optional, tag = "3")]
pub amount_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
pub latest_update_timestamp: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PaymentKind {
#[prost(oneof = "payment_kind::Kind", tags = "1, 2, 3, 4, 5, 6")]
pub kind: ::core::option::Option<payment_kind::Kind>,
}
/// Nested message and enum types in `PaymentKind`.
pub mod payment_kind {
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
#[prost(message, tag = "1")]
Onchain(super::Onchain),
#[prost(message, tag = "2")]
Bolt11(super::Bolt11),
#[prost(message, tag = "3")]
Bolt11Jit(super::Bolt11Jit),
#[prost(message, tag = "4")]
Bolt12Offer(super::Bolt12Offer),
#[prost(message, tag = "5")]
Bolt12Refund(super::Bolt12Refund),
#[prost(message, tag = "6")]
Spontaneous(super::Spontaneous),
}
}
/// Represents an on-chain payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Onchain {}
/// Represents a BOLT 11 payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11 {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11Jit {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
/// Allowing them to deduct this fee from the first inbound payment will pay for the LSP’s channel opening fees.
///
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\](<https://docs.rs/lightning/latest/lightning/util/config/struct.ChannelConfig.html#structfield.accept_underpaying_htlcs>)
/// for more information.
#[prost(message, optional, tag = "4")]
pub lsp_fee_limits: ::core::option::Option<LspFeeLimits>,
}
/// Represents a BOLT 12 ‘offer’ payment, i.e., a payment for an Offer.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Offer {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
pub offer_id: ::prost::alloc::string::String,
/// 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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a BOLT 12 ‘refund’ payment, i.e., a payment for a Refund.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Refund {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a spontaneous (“keysend”) payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Spontaneous {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
}
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\] for more information.
///
/// \[`LdkChannelConfig::accept_underpaying_htlcs`\]: lightning::util::config::ChannelConfig::accept_underpaying_htlcs
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LspFeeLimits {
/// The maximal total amount we allow any configured LSP withhold from us when forwarding the
/// payment.
#[prost(uint64, optional, tag = "1")]
pub max_total_opening_fee_msat: ::core::option::Option<u64>,
/// The maximal proportional fee, in parts-per-million millisatoshi, we allow any configured
/// LSP withhold from us when forwarding the payment.
#[prost(uint64, optional, tag = "2")]
pub max_proportional_opening_fee_ppm_msat: ::core::option::Option<u64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Channel {
Expand DownExpand Up@@ -473,3 +669,65 @@ pub struct BestBlock {
#[prost(uint32, tag = "2")]
pub height: u32,
}
/// Represents the direction of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentDirection {
/// The payment is inbound.
Inbound = 0,
/// The payment is outbound.
Outbound = 1,
}
impl PaymentDirection {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentDirection::Inbound => "INBOUND",
PaymentDirection::Outbound => "OUTBOUND",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INBOUND" => Some(Self::Inbound),
"OUTBOUND" => Some(Self::Outbound),
_ => None,
}
}
}
/// Represents the current status of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentStatus {
/// The payment is still pending.
Pending = 0,
/// The payment succeeded.
Succeeded = 1,
/// The payment failed.
Failed = 2,
}
impl PaymentStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentStatus::Pending => "PENDING",
PaymentStatus::Succeeded => "SUCCEEDED",
PaymentStatus::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PENDING" => Some(Self::Pending),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
Loading
, '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('^' + ".*" + ' Implement GetPaymentDetails and ListPayments Api. by G8XSU · Pull Request #15 · 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
258 changes: 258 additions & 0 deletions protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,6 +322,202 @@ pub struct ListChannelsResponse {
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<Channel>,
}
/// Returns payment details for a given payment_id.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.payment>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsRequest {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub payment_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsResponse {
/// Represents a payment.
/// Will be `None` if payment doesn't exist.
#[prost(message, optional, tag = "1")]
pub payment: ::core::option::Option<Payment>,
}
/// Retrieves list of all payments.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsResponse {
/// List of payments.
#[prost(message, repeated, tag = "1")]
pub payments: ::prost::alloc::vec::Vec<Payment>,
}
/// Represents a payment.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.PaymentDetails.html>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payment {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The kind of the payment.
#[prost(message, optional, tag = "2")]
pub kind: ::core::option::Option<PaymentKind>,
/// The amount transferred.
#[prost(uint64, optional, tag = "3")]
pub amount_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
pub latest_update_timestamp: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PaymentKind {
#[prost(oneof = "payment_kind::Kind", tags = "1, 2, 3, 4, 5, 6")]
pub kind: ::core::option::Option<payment_kind::Kind>,
}
/// Nested message and enum types in `PaymentKind`.
pub mod payment_kind {
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
#[prost(message, tag = "1")]
Onchain(super::Onchain),
#[prost(message, tag = "2")]
Bolt11(super::Bolt11),
#[prost(message, tag = "3")]
Bolt11Jit(super::Bolt11Jit),
#[prost(message, tag = "4")]
Bolt12Offer(super::Bolt12Offer),
#[prost(message, tag = "5")]
Bolt12Refund(super::Bolt12Refund),
#[prost(message, tag = "6")]
Spontaneous(super::Spontaneous),
}
}
/// Represents an on-chain payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Onchain {}
/// Represents a BOLT 11 payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11 {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11Jit {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
/// Allowing them to deduct this fee from the first inbound payment will pay for the LSP’s channel opening fees.
///
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\](<https://docs.rs/lightning/latest/lightning/util/config/struct.ChannelConfig.html#structfield.accept_underpaying_htlcs>)
/// for more information.
#[prost(message, optional, tag = "4")]
pub lsp_fee_limits: ::core::option::Option<LspFeeLimits>,
}
/// Represents a BOLT 12 ‘offer’ payment, i.e., a payment for an Offer.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Offer {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
pub offer_id: ::prost::alloc::string::String,
/// 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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a BOLT 12 ‘refund’ payment, i.e., a payment for a Refund.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Refund {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a spontaneous (“keysend”) payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Spontaneous {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
}
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\] for more information.
///
/// \[`LdkChannelConfig::accept_underpaying_htlcs`\]: lightning::util::config::ChannelConfig::accept_underpaying_htlcs
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LspFeeLimits {
/// The maximal total amount we allow any configured LSP withhold from us when forwarding the
/// payment.
#[prost(uint64, optional, tag = "1")]
pub max_total_opening_fee_msat: ::core::option::Option<u64>,
/// The maximal proportional fee, in parts-per-million millisatoshi, we allow any configured
/// LSP withhold from us when forwarding the payment.
#[prost(uint64, optional, tag = "2")]
pub max_proportional_opening_fee_ppm_msat: ::core::option::Option<u64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Channel {
Expand DownExpand Up@@ -473,3 +669,65 @@ pub struct BestBlock {
#[prost(uint32, tag = "2")]
pub height: u32,
}
/// Represents the direction of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentDirection {
/// The payment is inbound.
Inbound = 0,
/// The payment is outbound.
Outbound = 1,
}
impl PaymentDirection {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentDirection::Inbound => "INBOUND",
PaymentDirection::Outbound => "OUTBOUND",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INBOUND" => Some(Self::Inbound),
"OUTBOUND" => Some(Self::Outbound),
_ => None,
}
}
}
/// Represents the current status of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentStatus {
/// The payment is still pending.
Pending = 0,
/// The payment succeeded.
Succeeded = 1,
/// The payment failed.
Failed = 2,
}
impl PaymentStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentStatus::Pending => "PENDING",
PaymentStatus::Succeeded => "SUCCEEDED",
PaymentStatus::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PENDING" => Some(Self::Pending),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
Loading
, '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" + ' Implement GetPaymentDetails and ListPayments Api. by G8XSU · Pull Request #15 · 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
258 changes: 258 additions & 0 deletions protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,6 +322,202 @@ pub struct ListChannelsResponse {
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<Channel>,
}
/// Returns payment details for a given payment_id.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.payment>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsRequest {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub payment_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsResponse {
/// Represents a payment.
/// Will be `None` if payment doesn't exist.
#[prost(message, optional, tag = "1")]
pub payment: ::core::option::Option<Payment>,
}
/// Retrieves list of all payments.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsResponse {
/// List of payments.
#[prost(message, repeated, tag = "1")]
pub payments: ::prost::alloc::vec::Vec<Payment>,
}
/// Represents a payment.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.PaymentDetails.html>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payment {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The kind of the payment.
#[prost(message, optional, tag = "2")]
pub kind: ::core::option::Option<PaymentKind>,
/// The amount transferred.
#[prost(uint64, optional, tag = "3")]
pub amount_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
pub latest_update_timestamp: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PaymentKind {
#[prost(oneof = "payment_kind::Kind", tags = "1, 2, 3, 4, 5, 6")]
pub kind: ::core::option::Option<payment_kind::Kind>,
}
/// Nested message and enum types in `PaymentKind`.
pub mod payment_kind {
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
#[prost(message, tag = "1")]
Onchain(super::Onchain),
#[prost(message, tag = "2")]
Bolt11(super::Bolt11),
#[prost(message, tag = "3")]
Bolt11Jit(super::Bolt11Jit),
#[prost(message, tag = "4")]
Bolt12Offer(super::Bolt12Offer),
#[prost(message, tag = "5")]
Bolt12Refund(super::Bolt12Refund),
#[prost(message, tag = "6")]
Spontaneous(super::Spontaneous),
}
}
/// Represents an on-chain payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Onchain {}
/// Represents a BOLT 11 payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11 {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11Jit {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
/// Allowing them to deduct this fee from the first inbound payment will pay for the LSP’s channel opening fees.
///
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\](<https://docs.rs/lightning/latest/lightning/util/config/struct.ChannelConfig.html#structfield.accept_underpaying_htlcs>)
/// for more information.
#[prost(message, optional, tag = "4")]
pub lsp_fee_limits: ::core::option::Option<LspFeeLimits>,
}
/// Represents a BOLT 12 ‘offer’ payment, i.e., a payment for an Offer.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Offer {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
pub offer_id: ::prost::alloc::string::String,
/// 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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a BOLT 12 ‘refund’ payment, i.e., a payment for a Refund.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Refund {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a spontaneous (“keysend”) payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Spontaneous {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
}
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\] for more information.
///
/// \[`LdkChannelConfig::accept_underpaying_htlcs`\]: lightning::util::config::ChannelConfig::accept_underpaying_htlcs
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LspFeeLimits {
/// The maximal total amount we allow any configured LSP withhold from us when forwarding the
/// payment.
#[prost(uint64, optional, tag = "1")]
pub max_total_opening_fee_msat: ::core::option::Option<u64>,
/// The maximal proportional fee, in parts-per-million millisatoshi, we allow any configured
/// LSP withhold from us when forwarding the payment.
#[prost(uint64, optional, tag = "2")]
pub max_proportional_opening_fee_ppm_msat: ::core::option::Option<u64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Channel {
Expand DownExpand Up@@ -473,3 +669,65 @@ pub struct BestBlock {
#[prost(uint32, tag = "2")]
pub height: u32,
}
/// Represents the direction of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentDirection {
/// The payment is inbound.
Inbound = 0,
/// The payment is outbound.
Outbound = 1,
}
impl PaymentDirection {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentDirection::Inbound => "INBOUND",
PaymentDirection::Outbound => "OUTBOUND",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INBOUND" => Some(Self::Inbound),
"OUTBOUND" => Some(Self::Outbound),
_ => None,
}
}
}
/// Represents the current status of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentStatus {
/// The payment is still pending.
Pending = 0,
/// The payment succeeded.
Succeeded = 1,
/// The payment failed.
Failed = 2,
}
impl PaymentStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentStatus::Pending => "PENDING",
PaymentStatus::Succeeded => "SUCCEEDED",
PaymentStatus::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PENDING" => Some(Self::Pending),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
Loading
, '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('^' + ".*" + ' Implement GetPaymentDetails and ListPayments Api. by G8XSU · Pull Request #15 · 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
258 changes: 258 additions & 0 deletions protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,6 +322,202 @@ pub struct ListChannelsResponse {
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<Channel>,
}
/// Returns payment details for a given payment_id.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.payment>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsRequest {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub payment_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsResponse {
/// Represents a payment.
/// Will be `None` if payment doesn't exist.
#[prost(message, optional, tag = "1")]
pub payment: ::core::option::Option<Payment>,
}
/// Retrieves list of all payments.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsResponse {
/// List of payments.
#[prost(message, repeated, tag = "1")]
pub payments: ::prost::alloc::vec::Vec<Payment>,
}
/// Represents a payment.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.PaymentDetails.html>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payment {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The kind of the payment.
#[prost(message, optional, tag = "2")]
pub kind: ::core::option::Option<PaymentKind>,
/// The amount transferred.
#[prost(uint64, optional, tag = "3")]
pub amount_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
pub latest_update_timestamp: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PaymentKind {
#[prost(oneof = "payment_kind::Kind", tags = "1, 2, 3, 4, 5, 6")]
pub kind: ::core::option::Option<payment_kind::Kind>,
}
/// Nested message and enum types in `PaymentKind`.
pub mod payment_kind {
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
#[prost(message, tag = "1")]
Onchain(super::Onchain),
#[prost(message, tag = "2")]
Bolt11(super::Bolt11),
#[prost(message, tag = "3")]
Bolt11Jit(super::Bolt11Jit),
#[prost(message, tag = "4")]
Bolt12Offer(super::Bolt12Offer),
#[prost(message, tag = "5")]
Bolt12Refund(super::Bolt12Refund),
#[prost(message, tag = "6")]
Spontaneous(super::Spontaneous),
}
}
/// Represents an on-chain payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Onchain {}
/// Represents a BOLT 11 payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11 {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11Jit {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
/// Allowing them to deduct this fee from the first inbound payment will pay for the LSP’s channel opening fees.
///
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\](<https://docs.rs/lightning/latest/lightning/util/config/struct.ChannelConfig.html#structfield.accept_underpaying_htlcs>)
/// for more information.
#[prost(message, optional, tag = "4")]
pub lsp_fee_limits: ::core::option::Option<LspFeeLimits>,
}
/// Represents a BOLT 12 ‘offer’ payment, i.e., a payment for an Offer.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Offer {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
pub offer_id: ::prost::alloc::string::String,
/// 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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a BOLT 12 ‘refund’ payment, i.e., a payment for a Refund.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Refund {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a spontaneous (“keysend”) payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Spontaneous {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
}
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\] for more information.
///
/// \[`LdkChannelConfig::accept_underpaying_htlcs`\]: lightning::util::config::ChannelConfig::accept_underpaying_htlcs
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LspFeeLimits {
/// The maximal total amount we allow any configured LSP withhold from us when forwarding the
/// payment.
#[prost(uint64, optional, tag = "1")]
pub max_total_opening_fee_msat: ::core::option::Option<u64>,
/// The maximal proportional fee, in parts-per-million millisatoshi, we allow any configured
/// LSP withhold from us when forwarding the payment.
#[prost(uint64, optional, tag = "2")]
pub max_proportional_opening_fee_ppm_msat: ::core::option::Option<u64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Channel {
Expand DownExpand Up@@ -473,3 +669,65 @@ pub struct BestBlock {
#[prost(uint32, tag = "2")]
pub height: u32,
}
/// Represents the direction of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentDirection {
/// The payment is inbound.
Inbound = 0,
/// The payment is outbound.
Outbound = 1,
}
impl PaymentDirection {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentDirection::Inbound => "INBOUND",
PaymentDirection::Outbound => "OUTBOUND",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INBOUND" => Some(Self::Inbound),
"OUTBOUND" => Some(Self::Outbound),
_ => None,
}
}
}
/// Represents the current status of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentStatus {
/// The payment is still pending.
Pending = 0,
/// The payment succeeded.
Succeeded = 1,
/// The payment failed.
Failed = 2,
}
impl PaymentStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentStatus::Pending => "PENDING",
PaymentStatus::Succeeded => "SUCCEEDED",
PaymentStatus::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PENDING" => Some(Self::Pending),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
Loading
, '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('^' + ".*" + ' Implement GetPaymentDetails and ListPayments Api. by G8XSU · Pull Request #15 · 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
258 changes: 258 additions & 0 deletions protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,6 +322,202 @@ pub struct ListChannelsResponse {
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<Channel>,
}
/// Returns payment details for a given payment_id.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.payment>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsRequest {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub payment_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsResponse {
/// Represents a payment.
/// Will be `None` if payment doesn't exist.
#[prost(message, optional, tag = "1")]
pub payment: ::core::option::Option<Payment>,
}
/// Retrieves list of all payments.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsResponse {
/// List of payments.
#[prost(message, repeated, tag = "1")]
pub payments: ::prost::alloc::vec::Vec<Payment>,
}
/// Represents a payment.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.PaymentDetails.html>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payment {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The kind of the payment.
#[prost(message, optional, tag = "2")]
pub kind: ::core::option::Option<PaymentKind>,
/// The amount transferred.
#[prost(uint64, optional, tag = "3")]
pub amount_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
pub latest_update_timestamp: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PaymentKind {
#[prost(oneof = "payment_kind::Kind", tags = "1, 2, 3, 4, 5, 6")]
pub kind: ::core::option::Option<payment_kind::Kind>,
}
/// Nested message and enum types in `PaymentKind`.
pub mod payment_kind {
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
#[prost(message, tag = "1")]
Onchain(super::Onchain),
#[prost(message, tag = "2")]
Bolt11(super::Bolt11),
#[prost(message, tag = "3")]
Bolt11Jit(super::Bolt11Jit),
#[prost(message, tag = "4")]
Bolt12Offer(super::Bolt12Offer),
#[prost(message, tag = "5")]
Bolt12Refund(super::Bolt12Refund),
#[prost(message, tag = "6")]
Spontaneous(super::Spontaneous),
}
}
/// Represents an on-chain payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Onchain {}
/// Represents a BOLT 11 payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11 {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11Jit {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
/// Allowing them to deduct this fee from the first inbound payment will pay for the LSP’s channel opening fees.
///
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\](<https://docs.rs/lightning/latest/lightning/util/config/struct.ChannelConfig.html#structfield.accept_underpaying_htlcs>)
/// for more information.
#[prost(message, optional, tag = "4")]
pub lsp_fee_limits: ::core::option::Option<LspFeeLimits>,
}
/// Represents a BOLT 12 ‘offer’ payment, i.e., a payment for an Offer.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Offer {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
pub offer_id: ::prost::alloc::string::String,
/// 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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a BOLT 12 ‘refund’ payment, i.e., a payment for a Refund.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Refund {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a spontaneous (“keysend”) payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Spontaneous {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
}
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\] for more information.
///
/// \[`LdkChannelConfig::accept_underpaying_htlcs`\]: lightning::util::config::ChannelConfig::accept_underpaying_htlcs
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LspFeeLimits {
/// The maximal total amount we allow any configured LSP withhold from us when forwarding the
/// payment.
#[prost(uint64, optional, tag = "1")]
pub max_total_opening_fee_msat: ::core::option::Option<u64>,
/// The maximal proportional fee, in parts-per-million millisatoshi, we allow any configured
/// LSP withhold from us when forwarding the payment.
#[prost(uint64, optional, tag = "2")]
pub max_proportional_opening_fee_ppm_msat: ::core::option::Option<u64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Channel {
Expand DownExpand Up@@ -473,3 +669,65 @@ pub struct BestBlock {
#[prost(uint32, tag = "2")]
pub height: u32,
}
/// Represents the direction of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentDirection {
/// The payment is inbound.
Inbound = 0,
/// The payment is outbound.
Outbound = 1,
}
impl PaymentDirection {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentDirection::Inbound => "INBOUND",
PaymentDirection::Outbound => "OUTBOUND",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INBOUND" => Some(Self::Inbound),
"OUTBOUND" => Some(Self::Outbound),
_ => None,
}
}
}
/// Represents the current status of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentStatus {
/// The payment is still pending.
Pending = 0,
/// The payment succeeded.
Succeeded = 1,
/// The payment failed.
Failed = 2,
}
impl PaymentStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentStatus::Pending => "PENDING",
PaymentStatus::Succeeded => "SUCCEEDED",
PaymentStatus::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PENDING" => Some(Self::Pending),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
Loading
, '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); } })(); })(); Implement GetPaymentDetails and ListPayments Api. by G8XSU · Pull Request #15 · 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
258 changes: 258 additions & 0 deletions protos/src/lib.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,6 +322,202 @@ pub struct ListChannelsResponse {
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<Channel>,
}
/// Returns payment details for a given payment_id.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.payment>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsRequest {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub payment_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPaymentDetailsResponse {
/// Represents a payment.
/// Will be `None` if payment doesn't exist.
#[prost(message, optional, tag = "1")]
pub payment: ::core::option::Option<Payment>,
}
/// Retrieves list of all payments.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsRequest {}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsResponse {
/// List of payments.
#[prost(message, repeated, tag = "1")]
pub payments: ::prost::alloc::vec::Vec<Payment>,
}
/// Represents a payment.
/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.PaymentDetails.html>
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payment {
/// An identifier used to uniquely identify a payment in hex-encoded form.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The kind of the payment.
#[prost(message, optional, tag = "2")]
pub kind: ::core::option::Option<PaymentKind>,
/// The amount transferred.
#[prost(uint64, optional, tag = "3")]
pub amount_msat: ::core::option::Option<u64>,
/// The direction of the payment.
#[prost(enumeration = "PaymentDirection", tag = "4")]
pub direction: i32,
/// The status of the payment.
#[prost(enumeration = "PaymentStatus", tag = "5")]
pub status: i32,
/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
#[prost(uint64, tag = "6")]
pub latest_update_timestamp: u64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PaymentKind {
#[prost(oneof = "payment_kind::Kind", tags = "1, 2, 3, 4, 5, 6")]
pub kind: ::core::option::Option<payment_kind::Kind>,
}
/// Nested message and enum types in `PaymentKind`.
pub mod payment_kind {
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
#[prost(message, tag = "1")]
Onchain(super::Onchain),
#[prost(message, tag = "2")]
Bolt11(super::Bolt11),
#[prost(message, tag = "3")]
Bolt11Jit(super::Bolt11Jit),
#[prost(message, tag = "4")]
Bolt12Offer(super::Bolt12Offer),
#[prost(message, tag = "5")]
Bolt12Refund(super::Bolt12Refund),
#[prost(message, tag = "6")]
Spontaneous(super::Spontaneous),
}
}
/// Represents an on-chain payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Onchain {}
/// Represents a BOLT 11 payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11 {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
}
/// Represents a BOLT 11 payment intended to open an LSPS 2 just-in-time channel.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt11Jit {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
///
/// Allowing them to deduct this fee from the first inbound payment will pay for the LSP’s channel opening fees.
///
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\](<https://docs.rs/lightning/latest/lightning/util/config/struct.ChannelConfig.html#structfield.accept_underpaying_htlcs>)
/// for more information.
#[prost(message, optional, tag = "4")]
pub lsp_fee_limits: ::core::option::Option<LspFeeLimits>,
}
/// Represents a BOLT 12 ‘offer’ payment, i.e., a payment for an Offer.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Offer {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
pub secret: ::core::option::Option<::prost::bytes::Bytes>,
/// The hex-encoded ID of the offer this payment is for.
#[prost(string, tag = "4")]
pub offer_id: ::prost::alloc::string::String,
/// 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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a BOLT 12 ‘refund’ payment, i.e., a payment for a Refund.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Bolt12Refund {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, optional, tag = "1")]
pub hash: ::core::option::Option<::prost::alloc::string::String>,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
/// The secret used by the payment.
#[prost(bytes = "bytes", optional, tag = "3")]
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>).
///
/// **Caution**: The `payer_note` field may come from an untrusted source. To prevent potential misuse,
/// all non-printable characters will be sanitized and replaced with safe characters.
#[prost(string, optional, tag = "5")]
pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
/// The quantity of an item requested in the offer.
#[prost(uint64, optional, tag = "6")]
pub quantity: ::core::option::Option<u64>,
}
/// Represents a spontaneous (“keysend”) payment.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Spontaneous {
/// The payment hash, i.e., the hash of the preimage.
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The pre-image used by the payment.
#[prost(string, optional, tag = "2")]
pub preimage: ::core::option::Option<::prost::alloc::string::String>,
}
/// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
/// See \[`LdkChannelConfig::accept_underpaying_htlcs`\] for more information.
///
/// \[`LdkChannelConfig::accept_underpaying_htlcs`\]: lightning::util::config::ChannelConfig::accept_underpaying_htlcs
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LspFeeLimits {
/// The maximal total amount we allow any configured LSP withhold from us when forwarding the
/// payment.
#[prost(uint64, optional, tag = "1")]
pub max_total_opening_fee_msat: ::core::option::Option<u64>,
/// The maximal proportional fee, in parts-per-million millisatoshi, we allow any configured
/// LSP withhold from us when forwarding the payment.
#[prost(uint64, optional, tag = "2")]
pub max_proportional_opening_fee_ppm_msat: ::core::option::Option<u64>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Channel {
Expand DownExpand Up@@ -473,3 +669,65 @@ pub struct BestBlock {
#[prost(uint32, tag = "2")]
pub height: u32,
}
/// Represents the direction of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentDirection {
/// The payment is inbound.
Inbound = 0,
/// The payment is outbound.
Outbound = 1,
}
impl PaymentDirection {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentDirection::Inbound => "INBOUND",
PaymentDirection::Outbound => "OUTBOUND",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INBOUND" => Some(Self::Inbound),
"OUTBOUND" => Some(Self::Outbound),
_ => None,
}
}
}
/// Represents the current status of a payment.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentStatus {
/// The payment is still pending.
Pending = 0,
/// The payment succeeded.
Succeeded = 1,
/// The payment failed.
Failed = 2,
}
impl PaymentStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PaymentStatus::Pending => "PENDING",
PaymentStatus::Succeeded => "SUCCEEDED",
PaymentStatus::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PENDING" => Some(Self::Pending),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
Loading