Implement proper pagination for list-payments cli

Author: benthecarman

ldk-server-cli/src/main.rs

@@ -15,11 +15,14 @@ use ldk_server_client::ldk_server_protos::api::{
 	SpliceOutResponse, UpdateChannelConfigRequest, UpdateChannelConfigResponse,
 };
 use ldk_server_client::ldk_server_protos::types::{
-	bolt11_invoice_description, Bolt11InvoiceDescription, ChannelConfig, PageToken, Payment,
+	bolt11_invoice_description, Bolt11InvoiceDescription, ChannelConfig, PageToken,
 	RouteParametersConfig,
 };
 use serde::Serialize;
 
+mod types;
+use types::CliListPaymentsResponse;
+
 // Having these default values as constants in the Proto file and
 // importing/reusing them here might be better, but Proto3 removed
 // the ability to set default values.
@@ -169,9 +172,12 @@ enum Commands {
 	ListPayments {
 		#[arg(short, long)]
 		#[arg(
-			help = "Minimum number of payments to return. If not provided, only the first page of the paginated list is returned."
+			help = "Fetch at least this many payments by iterating through multiple pages. Returns combined results with the last page token. If not provided, returns only a single page."
 		)]
 		number_of_payments: Option<u64>,
+		#[arg(long)]
+		#[arg(help = "Page token to continue from a previous page (format: token:index)")]
+		page_token: Option<String>,
 	},
 	UpdateChannelConfig {
 		#[arg(short, long)]
@@ -407,12 +413,15 @@ async fn main() {
 				client.list_channels(ListChannelsRequest {}).await,
 			);
 		},
-		Commands::ListPayments { number_of_payments } => {
-			handle_response_result::<_, ListPaymentsResponse>(
-				list_n_payments(client, number_of_payments)
-					.await
-					// todo: handle pagination properly
-					.map(|payments| ListPaymentsResponse { payments, next_page_token: None }),
+		Commands::ListPayments { number_of_payments, page_token } => {
+			let page_token = if let Some(token_str) = page_token {
+				Some(parse_page_token(&token_str).unwrap_or_else(|e| handle_error(e)))
+			} else {
+				None
+			};
+
+			handle_response_result::<_, CliListPaymentsResponse>(
+				handle_list_payments(client, number_of_payments, page_token).await,
 			);
 		},
 		Commands::UpdateChannelConfig {
@@ -466,24 +475,37 @@ fn build_open_channel_config(
 	})
 }
 
+async fn handle_list_payments(
+	client: LdkServerClient, number_of_payments: Option<u64>, initial_page_token: Option<PageToken>,
+) -> Result<ListPaymentsResponse, LdkServerError> {
+	if let Some(count) = number_of_payments {
+		list_n_payments(client, count, initial_page_token).await
+	} else {
+		// Fetch single page
+		client.list_payments(ListPaymentsRequest { page_token: initial_page_token }).await
+	}
+}
+
 async fn list_n_payments(
-	client: LdkServerClient, number_of_payments: Option<u64>,
-) -> Result<Vec<Payment>, LdkServerError> {
-	let mut payments = Vec::new();
-	let mut page_token: Option<PageToken> = None;
-	// If no count is specified, just list the first page.
-	let target_count = number_of_payments.unwrap_or(0);
+	client: LdkServerClient, target_count: u64, initial_page_token: Option<PageToken>,
+) -> Result<ListPaymentsResponse, LdkServerError> {
+	let mut payments = Vec::with_capacity(target_count as usize);
+	let mut page_token = initial_page_token;
+	let mut next_page_token;
 
 	loop {
 		let response = client.list_payments(ListPaymentsRequest { page_token }).await?;
 
 		payments.extend(response.payments);
-		if payments.len() >= target_count as usize || response.next_page_token.is_none() {
+		next_page_token = response.next_page_token;
+
+		if payments.len() >= target_count as usize || next_page_token.is_none() {
 			break;
 		}
-		page_token = response.next_page_token;
+		page_token = next_page_token;
 	}
-	Ok(payments)
+
+	Ok(ListPaymentsResponse { payments, next_page_token })
 }
 
 fn handle_response_result<Rs, Js>(response: Result<Rs, LdkServerError>)
@@ -508,6 +530,20 @@ where
 	}
 }
 
+fn parse_page_token(token_str: &str) -> Result<PageToken, LdkServerError> {
+	let parts: Vec<&str> = token_str.split(':').collect();
+	if parts.len() != 2 {
+		return Err(LdkServerError::new(
+			InternalError,
+			"Page token must be in format 'token:index'".to_string(),
+		));
+	}
+	let index = parts[1]
+		.parse::<i64>()
+		.map_err(|_| LdkServerError::new(InternalError, "Invalid page token index".to_string()))?;
+	Ok(PageToken { token: parts[0].to_string(), index })
+}
+
 fn handle_error(e: LdkServerError) -> ! {
 	let error_type = match e.error_code {
 		InvalidRequestError => "Invalid Request",

ldk-server-cli/src/types.rs

@@ -0,0 +1,32 @@
+//! CLI-specific type wrappers for API responses.
+//!
+//! This file contains wrapper types that customize the serialization format
+//! of API responses for CLI output. These wrappers ensure that the CLI's output
+//! format matches what users expect and what the CLI can parse back as input.
+
+use ldk_server_client::ldk_server_protos::api::ListPaymentsResponse;
+use ldk_server_client::ldk_server_protos::types::{PageToken, Payment};
+use serde::Serialize;
+
+/// CLI-specific wrapper for ListPaymentsResponse that formats the page token
+/// as "token:idx" instead of a JSON object.
+#[derive(Debug, Clone, Serialize)]
+pub struct CliListPaymentsResponse {
+	/// List of payments.
+	pub payments: Vec<Payment>,
+	/// Next page token formatted as "token:idx", or None if no more pages.
+	#[serde(skip_serializing_if = "Option::is_none")]
+	pub next_page_token: Option<String>,
+}
+
+impl From<ListPaymentsResponse> for CliListPaymentsResponse {
+	fn from(response: ListPaymentsResponse) -> Self {
+		let next_page_token = response.next_page_token.map(format_page_token);
+
+		CliListPaymentsResponse { payments: response.payments, next_page_token }
+	}
+}
+
+fn format_page_token(token: PageToken) -> String {
+	format!("{}:{}", token.token, token.index)
+}