Skip to content

feat: channel metadata, notification versioning, validation, and archive #530

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

Open
success-OG wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: channel metadata, notification versioning, validation, and archive #530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 15 additions & 2 deletions NOTIFICATION_PAYLOAD_SCHEMA.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ Arbitrary key-value object stored alongside the notification. Not sent to the re
| `eventId` | Optional. If provided, used for deduplication. ≤ 255 chars. |
| `contractAddress` | Optional. If provided, must be a valid Stellar strkey (56 chars). |
| `priority` | Integer between 0 and 100 (inclusive). Defaults to 0. |
| `metadata` | Optional. Must be a valid JSON object if provided. |
| `metadata` | Optional. Must be a valid JSON object if provided. When present, `source` (non-empty string) is required. Nested objects/arrays are rejected. |

### Channel-specific validation

Expand All @@ -224,8 +224,21 @@ If `eventId` is provided, the system checks for an existing `PENDING` or `COMPLE

## Versioning

Every notification payload carries a protocol `version` field so consumers can
gate parsing logic across future schema changes.

| Version | Date | Changes |
|---------|------------|-----------------------------------------------------------|
| v1 | 2026-07-26 | Initial versioned payloads (`version: 1` stamped by API) |
| v1.0 | 2025-12-01 | Initial schema — four channel types, priority, metadata |

Breaking changes to this schema (removing or renaming required fields) will be communicated with a major version bump and a minimum 30-day deprecation notice in the changelog.
**Current version:** `1` (`CURRENT_NOTIFICATION_VERSION` in
`listener/src/utils/notification-version.ts` and
`CURRENT_NOTIFICATION_VERSION` in the Soroban contract).

When scheduling via the REST API, if `payload.version` is omitted the listener
stamps the current version automatically. Explicit future versions are rejected.

Breaking changes to this schema (removing or renaming required fields) will be
communicated with a major version bump and a minimum 30-day deprecation notice
in the changelog.
Loading