Skip to content

parseNEARAnnouncement()

SIP Protocol API Reference v0.15.1


SIP Protocol API Reference / parseNEARAnnouncement

parseNEARAnnouncement(memo): Partial<NEARAnnouncement> | null

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:18215

Parse an announcement from a NEAR memo string

Accepts SIP:1 (legacy swapped scheme) and SIP:2 (canonical EIP-5564); the detected version is returned. NEAR derives canonically regardless, so the version is recorded for consistency rather than to route the claim.

Format: SIP::<ephemeral_pubkey_hex>:<view_tag_hex>

string

The memo string to parse

Partial<NEARAnnouncement> | null

Parsed announcement or null if invalid

const memo = 'SIP:2:1234...abcd:0f'
const announcement = parseAnnouncement(memo)
if (announcement) {
console.log(announcement.version) // '2'
console.log(announcement.ephemeralPublicKey)
console.log(announcement.viewTag) // 15
}