jerry/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-10-27 12:40:30 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0f5acd42cb68f282eadca7553f7cfc695f6b1c1d
buzz/docs/buzz-push.md
Tom Brow 0f5acd42cb fix(push): accept canonical channel UUIDs across versions 
Signed-off-by: Tom Brow <tomb@block.xyz>
2026-10-26 11:49:56 -07:00

2.1 KiB
Raw Blame History

Buzz push notes

Push is experimental. These notes capture current decisions; we will write a stable specification after validating the design through launch and use. NIP-PL is background, not the current Buzz contract.

  • Relays advertise buzz-push-v1, never nip-pl. Updated clients require it.
  • Compatible changes keep the capability name. Incompatible behavior that clients must distinguish gets a new version.
  • Each gateway serves one server-configured Apple application and APNs transport. Enrollment, transcripts, grants, leases and discovery have no application-profile selector. The relay advertises transport classes in class_support.
  • Existing grants and pending enrollment records are not migrated. The new client uses separate Keychain records and enrolls again. Keep old production push disabled so released clients never acquire legacy push authority.
  • Stop old gateway replicas before cutover. The gateway migration requires an empty authority store because endpoint fingerprints changed. The relay migration requires no active legacy leases. Neither migration deletes that state.
  • Publish the matching gateway image and chart, update deployment configuration, then enable the new relay capability. Verify enrollment, delivery, renewal and revocation on a physical device before production activation.

Channel identifier grammar

Push filters use the same UUID identifiers as Buzz channels, including UUIDv5 starter channels. The relay advertises h_grammar: "uuid-lowercase": exactly 36 lowercase ASCII characters in hyphenated 8-4-4-4-12 hexadecimal form, without a version or variant restriction. Canonical text is required because filters match event tags exactly. Array and string limits, community scoping, and channel membership checks still apply.

Mobile accepts both this descriptor and the older uuid-v4-lowercase descriptor. Older relays continue to reject non-v4 channel filters. Deploy mobile support for uuid-lowercase before changing the relay advertisement: older mobile clients reject that descriptor and cannot renew their push leases. The new grammar does not alter existing UUIDv4 subscriptions.