feat: notification pagination

[chris13524]

Requirements

This PR adds new methods to the authentication page, rather than splitting these out on the RPC methods page since this is easier to understand in one spot. A subsequent PR will consolidate both pages into one.

• Adds missing id field from notification
• Adds methods for getting a page of notifications, which clients should call on start just like watchSubscriptions and use to overwrite local state
• Adds method for getting a specific notification by ID
• Adds method for marking a notification as read
• Adds method for receiving updates when a notification changes (i.e. read status changing)
• Adds method for counting how many unread notifications there are

Remaining work:

• Add to RPC methods
• Dapp key vs notify key, and topic?
• Update client SDKs
• Flag to getNotifications to order unread notifications first
• Create docs PR with updates & migration guide and share with beta testers for feedback

Open questions:

• Fix: Get by ID: URL doesn't include this ID
  • Solution: getByUrl method or getByNotificationId method (the notification_id the app provided when sending the notification)?
• Do we need a flag to only paginate over e.g. read or unread notifications, or a way to put read notifications first in the response?
  • No, there is not currently a desire to show unread notifications first, and getUnreadNotificationCount solves the need of counting these.
• Assumption right now is we will remove delete methods from client SDKs, and we do not need an archived or deleted state. Is read/unread sufficient?
  • No current desire I am aware of
• Should unread notification count be part of watchSubscriptions instead of its own method in order to improve the performance of app.web3inbox.com? Or do we need a batch method?

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
walletconnect-specs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 5, 2024 7:51pm

[chris13524]

Let's break this into 3 PRs with the first to be prioritized:

• Get notification history/pagination & removal of delete notifications
• Read/unread state, notification change events, unread notification count
• Get notification by ID

[chris13524]

This PR has been updated to only include the details required for notification history/pagination which has been successfully implemented. Remaining details have been broken out into separate PRs for future discussion:

• feat: read/unread states #191
• feat: get single notification #192

[devceline]

LGTM