FIX: Unify UniFFI welcomes pagination API by mubarakcoded · Pull Request #119 · marmot-protocol/mdk

mubarakcoded · 2026-01-06T13:59:40Z

Summary by CodeRabbit

Refactor
- Consolidated the pending-welcomes API into a single call that accepts optional pagination (limit and offset); the separate paginated endpoint was removed and call sites/tests updated accordingly.
Breaking Changes
- Public API now requires callers to provide pagination parameters (or None/empty values) when pagination is needed; changelogs updated to reflect this change.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-06T13:59:51Z

Walkthrough

Replaced the separate paginated function with a single get_pending_welcomes that accepts optional limit: Option<u32> and offset: Option<u32>; removed get_pending_welcomes_paginated; updated call sites, tests, storage-traits API, and changelogs accordingly; removed MAX_PENDING_WELCOMES_OFFSET.

Changes

Cohort / File(s)	Summary
API: mdk-uniffi `crates/mdk-uniffi/src/lib.rs`	Replaced `get_pending_welcomes_paginated(...)` with unified `get_pending_welcomes(&self, limit: Option<u32>, offset: Option<u32>)`; updated internal calls to pass `None`/pagination as appropriate.
Storage traits `crates/mdk-storage-traits/...`	`WelcomeStorage::pending_welcomes()` signature changed to accept `Option<Pagination>`; removed `MAX_PENDING_WELCOMES_OFFSET` constant and related validation.
Tests & Utilities `crates/mdk-uniffi/tests/...`	Updated tests to call the new `get_pending_welcomes(limit, offset)` signature; added/imported `JsonUtil` in nostr-related tests.
Changelogs `crates/mdk-uniffi/CHANGELOG.md`, `crates/mdk-storage-traits/CHANGELOG.md`	Updated breaking-change notes to reflect the signature changes and removal of the paginated API/constant.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

fix: add pagination to prevent memory exhaustion in pending_welcomes #110: Changes the same mdk-uniffi get_pending_welcomes API to use optional pagination and remove/alter the paginated helper.

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main change: unifying the welcomes pagination API by consolidating get_pending_welcomes_paginated into get_pending_welcomes with optional parameters.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c37cb40 and 4951adc.

📒 Files selected for processing (1)

crates/mdk-storage-traits/CHANGELOG.md

🧰 Additional context used

📓 Path-based instructions (2)

**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

Never use bare URLs in markdown files; all URLs must be properly formatted using [link text](url), <url>, or ([#123](url)) for PR/issue references

Files:

crates/mdk-storage-traits/CHANGELOG.md

crates/*/CHANGELOG.md

📄 CodeRabbit inference engine (AGENTS.md)

Every crate CHANGELOG entry must include a PR reference using the format ([#123](https://github.com/marmot-protocol/mdk/pull/123))

Files:

crates/mdk-storage-traits/CHANGELOG.md

🧠 Learnings (3)

📚 Learning: 2026-01-03T08:39:39.799Z

Learnt from: CR
Repo: marmot-protocol/mdk PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-03T08:39:39.799Z
Learning: Every change that modifies functionality must update the CHANGELOG in the affected crate

Applied to files:

crates/mdk-storage-traits/CHANGELOG.md

📚 Learning: 2026-01-03T08:39:39.799Z

Learnt from: CR
Repo: marmot-protocol/mdk PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-03T08:39:39.799Z
Learning: Applies to crates/*/CHANGELOG.md : Every crate CHANGELOG entry must include a PR reference using the format `([#123](https://github.com/marmot-protocol/mdk/pull/123))`

Applied to files:

crates/mdk-storage-traits/CHANGELOG.md

📚 Learning: 2026-01-01T15:51:58.505Z

Learnt from: dannym-arx
Repo: marmot-protocol/mdk PR: 98
File: crates/mdk-core/CHANGELOG.md:46-46
Timestamp: 2026-01-01T15:51:58.505Z
Learning: In CHANGELOG.md files, keep the GitHub issue references (e.g., #61) as-is; do not convert '#61' (with no space) into an MD heading '# 61'. The hash without a space is intentional for GitHub auto-linking. This guideline applies to all CHANGELOG.md files in the repo.

Applied to files:

crates/mdk-storage-traits/CHANGELOG.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Test Coverage

🔇 Additional comments (1)

crates/mdk-storage-traits/CHANGELOG.md (1)

30-30: Verify PR reference in modified CHANGELOG entry.

Line 30 is marked as modified (has ~) but references PR #110, while this change is part of PR #119. Confirm whether the PR reference should be updated to #119 or if this entry was intentionally attributed to a prior PR.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-01-06T14:01:38Z

✅ Coverage: 86.85% → 87.01% (+0.16%)

github-actions · 2026-01-06T14:04:35Z

✅ Coverage: 86.85% → 87.01% (+0.16%)

dannym-arx

LGTM!

github-actions · 2026-01-06T14:30:52Z

✅ Coverage: 86.85% → 87.01% (+0.16%)

jgmontoya

Just a question

crates/mdk-uniffi/src/lib.rs

unify uniffi welcomes pagination api

fd162a2

update changelog for uniffi pagination

c37cb40

mubarakcoded requested review from dannym-arx, erskingardner and jgmontoya January 6, 2026 14:06

dannym-arx approved these changes Jan 6, 2026

View reviewed changes

update changelog

4951adc

jgmontoya reviewed Jan 6, 2026

View reviewed changes

crates/mdk-uniffi/src/lib.rs Show resolved Hide resolved

jgmontoya approved these changes Jan 6, 2026

View reviewed changes

mubarakcoded merged commit d8462bd into master Jan 6, 2026
12 checks passed

mubarakcoded deleted the fix-uniffi-welcomes-pagination-consistency branch January 6, 2026 17:11

coderabbitai bot mentioned this pull request Jan 6, 2026

fix: add pagination and validation to messages query to prevent memory exhaustion #111

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FIX: Unify UniFFI welcomes pagination API#119

FIX: Unify UniFFI welcomes pagination API#119
mubarakcoded merged 3 commits intomasterfrom
fix-uniffi-welcomes-pagination-consistency

mubarakcoded commented Jan 6, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 6, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

dannym-arx left a comment

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

jgmontoya left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

mubarakcoded commented Jan 6, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Pre-merge checks

Uh oh!

github-actions bot commented Jan 6, 2026

✅ Coverage: 86.85% → 87.01% (+0.16%)

Uh oh!

github-actions bot commented Jan 6, 2026

✅ Coverage: 86.85% → 87.01% (+0.16%)

Uh oh!

dannym-arx left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 6, 2026

✅ Coverage: 86.85% → 87.01% (+0.16%)

Uh oh!

jgmontoya left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mubarakcoded commented Jan 6, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 6, 2026 •

edited

Loading