Skip to content

adjust page sizes #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mononaut merged 3 commits into from
Oct 14, 2026
Merged

adjust page sizes #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2dc61f5
adjust page sizes
mononaut Aug 13, 2026
129bd2a
align max page sizes
mononaut Oct 14, 2026
0df80ca
Merge branch 'mempool' into mononaut/page-sizes
mononaut Oct 14, 2026
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
10 changes: 5 additions & 5 deletions src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,31 +246,31 @@ impl Config {
.arg(
Arg::with_name("rest_default_chain_txs_per_page")
.long("rest-default-chain-txs-per-page")
.help("The default number of on-chain transactions returned by the txs endpoints.")
.help("The default and maximum number of on-chain transactions returned by the txs endpoints.")
.default_value("25")
)
.arg(
Arg::with_name("rest_default_max_mempool_txs")
.long("rest-default-max-mempool-txs")
.help("The default number of mempool transactions returned by the txs endpoints.")
.help("The default and maximum number of mempool transactions returned by the txs endpoints.")
.default_value("50")
)
.arg(
Arg::with_name("rest_default_max_address_summary_txs")
.long("rest-default-max-address-summary-txs")
.help("The default number of transactions returned by the address summary endpoints.")
.help("The default and maximum number of transactions returned by the address summary endpoints.")
.default_value("5000")
)
.arg(
Arg::with_name("rest_max_mempool_page_size")
.long("rest-max-mempool-page-size")
.help("The maximum number of transactions returned by the paginated /internal/mempool/txs endpoint.")
.help("The default and maximum number of transactions returned by the paginated /internal/mempool/txs endpoint.")
.default_value("1000")
)
.arg(
Arg::with_name("rest_max_mempool_txid_page_size")
.long("rest-max-mempool-txid-page-size")
.help("The maximum number of transactions returned by the paginated /mempool/txids/page endpoint.")
.help("The default and maximum number of transactions returned by the paginated /mempool/txids/page endpoint.")
.default_value("10000")
)
.arg(
Expand Down
78 changes: 38 additions & 40 deletions src/rest.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ use rayon::iter::ParallelIterator;
use tokio::sync::oneshot;

use hyperlocal::UnixServerExt;
use std::{cmp, fs};
use std::fs;
#[cfg(feature = "liquid")]
use {
crate::elements::{peg::PegoutValue, AssetMeta, AssetSorting, IssuanceValue},
Expand Down Expand Up @@ -74,6 +74,13 @@ const CONF_FINAL: usize = 10; // reorgs deeper than this are considered unlikely
// internal api prefix
const INTERNAL_PREFIX: &str = "internal";

fn capped_max_txs(query_params: &HashMap<String, String>, page_size: usize) -> usize {
query_params
.get("max_txs")
.and_then(|value| value.parse::<usize>().ok())
.map_or(page_size, |max_txs| max_txs.min(page_size))
}

#[derive(Serialize, Deserialize)]
struct BlockValue {
id: String,
Expand Down Expand Up @@ -968,10 +975,7 @@ fn handle_request(
None,
) => {
let script_hash = to_scripthash(script_type, script_str, config.network_type)?;
let max_txs = query_params
.get("max_txs")
.and_then(|s| s.parse::<usize>().ok())
.unwrap_or(config.rest_default_max_mempool_txs);
let max_txs = capped_max_txs(&query_params, config.rest_default_max_mempool_txs);
let after_txid = query_params
.get("after_txid")
.and_then(|s| s.parse::<Txid>().ok());
Expand Down Expand Up @@ -1070,10 +1074,7 @@ fn handle_request(
})
.collect();

let max_txs = query_params
.get("max_txs")
.and_then(|s| s.parse::<usize>().ok())
.unwrap_or(config.rest_default_max_mempool_txs);
let max_txs = capped_max_txs(&query_params, config.rest_default_max_mempool_txs);
let after_txid = query_params
.get("after_txid")
.and_then(|s| s.parse::<Txid>().ok());
Expand Down Expand Up @@ -1158,10 +1159,7 @@ fn handle_request(
) => {
let script_hash = to_scripthash(script_type, script_str, config.network_type)?;
let last_seen_txid = last_seen_txid.and_then(|txid| txid.parse::<Txid>().ok());
let max_txs = query_params
.get("max_txs")
.and_then(|s| s.parse::<usize>().ok())
.unwrap_or(config.rest_default_chain_txs_per_page);
let max_txs = capped_max_txs(&query_params, config.rest_default_chain_txs_per_page);

let mut txs = query
.chain()
Expand Down Expand Up @@ -1204,13 +1202,8 @@ fn handle_request(
) => {
let script_hash = to_scripthash(script_type, script_str, config.network_type)?;
let last_seen_txid = last_seen_txid.and_then(|txid| txid.parse::<Txid>().ok());
let max_txs = cmp::min(
config.rest_default_max_address_summary_txs,
query_params
.get("max_txs")
.and_then(|s| s.parse::<usize>().ok())
.unwrap_or(config.rest_default_max_address_summary_txs),
);
let max_txs =
capped_max_txs(&query_params, config.rest_default_max_address_summary_txs);

let last_seen_txid_location = if let Some(txid) = &last_seen_txid {
find_txid(txid, &query.mempool(), query.chain())
Expand Down Expand Up @@ -1285,13 +1278,8 @@ fn handle_request(
.collect();

let last_seen_txid = last_seen_txid.and_then(|txid| txid.parse::<Txid>().ok());
let max_txs = cmp::min(
config.rest_default_max_address_summary_txs,
query_params
.get("max_txs")
.and_then(|s| s.parse::<usize>().ok())
.unwrap_or(config.rest_default_max_address_summary_txs),
);
let max_txs =
capped_max_txs(&query_params, config.rest_default_max_address_summary_txs);

let last_seen_txid_location = if let Some(txid) = &last_seen_txid {
find_txid(txid, &query.mempool(), query.chain())
Expand Down Expand Up @@ -1336,10 +1324,7 @@ fn handle_request(
None,
) => {
let script_hash = to_scripthash(script_type, script_str, config.network_type)?;
let max_txs = query_params
.get("max_txs")
.and_then(|s| s.parse::<usize>().ok())
.unwrap_or(config.rest_default_max_mempool_txs);
let max_txs = capped_max_txs(&query_params, config.rest_default_max_mempool_txs);

let txs = query
.mempool()
Expand Down Expand Up @@ -1729,10 +1714,7 @@ fn handle_request(
}
(&Method::GET, Some(&"mempool"), Some(&"txids"), Some(&"page"), last_seen_txid, None) => {
let last_seen_txid = last_seen_txid.and_then(|txid| txid.parse::<Txid>().ok());
let max_txs = query_params
.get("max_txs")
.and_then(|s| s.parse::<usize>().ok())
.unwrap_or(config.rest_max_mempool_txid_page_size);
let max_txs = capped_max_txs(&query_params, config.rest_max_mempool_txid_page_size);
json_response(
query.mempool().txids_page(max_txs, last_seen_txid),
TTL_SHORT,
Expand Down Expand Up @@ -1787,10 +1769,7 @@ fn handle_request(
None,
) => {
let last_seen_txid = last_seen_txid.and_then(|txid| txid.parse::<Txid>().ok());
let max_txs = query_params
.get("max_txs")
.and_then(|s| s.parse::<usize>().ok())
.unwrap_or(config.rest_max_mempool_page_size);
let max_txs = capped_max_txs(&query_params, config.rest_max_mempool_page_size);
let txs = query
.mempool()
.txs_page(max_txs, last_seen_txid)
Expand Down Expand Up @@ -2234,12 +2213,31 @@ impl From<address::AddressError> for HttpError {

#[cfg(test)]
mod tests {
use super::{confirmed_after_txid, TxidLocation};
use super::{capped_max_txs, confirmed_after_txid, TxidLocation};
use crate::chain::Txid;
use crate::rest::HttpError;
use serde_json::Value;
use std::collections::HashMap;

#[test]
fn test_capped_max_txs() {
let mut query_params = HashMap::new();

assert_eq!(capped_max_txs(&query_params, 25), 25);

query_params.insert("max_txs".to_string(), "20".to_string());
assert_eq!(capped_max_txs(&query_params, 25), 20);

query_params.insert("max_txs".to_string(), "26".to_string());
assert_eq!(capped_max_txs(&query_params, 25), 25);

query_params.insert("max_txs".to_string(), usize::MAX.to_string());
assert_eq!(capped_max_txs(&query_params, 25), 25);

query_params.insert("max_txs".to_string(), "invalid".to_string());
assert_eq!(capped_max_txs(&query_params, 25), 25);
}

#[test]
fn test_parse_query_param() {
let mut query_params = HashMap::new();
Expand Down
Loading