Helpers

applesauce-core and other packages export a bunch of helper methods for working with events bunch of methods to get data from events

WARNING

Some helper methods my throw errors. so make sure to have error handling and use the isValid* helpers to filter out invalid events

Core helpers

The applesauce-core package contains the majority of the helper methods

The helpers are broken into multiple categories based on what they can be used for, mailboxes, zaps, profiles, and a lot more

Events

• isEvent Checks if an object is a nostr event
• markFromCache Marks an event as being from the cache
• isFromCache Checks if an event is marked from cache
• getTagValue Gets the value of the first tag matching the name
• getIndexableTags Get a Set of all indexable tags on the event

Profiles

• getProfileContent Returns the parsed profile content for a kind 0 event
• isValidProfile Checks if the content of the kind 0 event is valid JSON

Mailboxes

• getInboxes Gets the inbox relays from a 10002 event
• getOutboxes Gets the outbox relays from a 10002 event

Comments

• getCommentRootPointer Get the root pointer for a NIP-22 comment
• getCommentReplyPointer Get the reply pointer for a NIP-22 comment

Event relays

• addSeenRelay Adds a relay to the list of relay the event was seen on
• getSeenRelays Get the list of relays this event was seen on

Zaps

• isValidZap Checks if an event is a valid zap and can be parsed
• getZapSender Gets the senders pubkey
• getZapRecipient Gets the pubkey of the user who received the zap
• getZapPayment Gets the parsed bolt11 invoice
• getZapAddressPointer Gets the address pointer of the zap
• getZapEventPointer Gets the event pointer of the zap
• getZapRequest Gets the zap request event inside the zap event

Lightning

• parseBolt11 Parses a bolt11 lightning invoice
• parseLNURLOrAddress Parses a LNURL or lightning address into a LNURLp

Pointers

• getEventPointerFromETag Creates an EventPointer from a standard "e" tag
• getEventPointerFromQTag Creates an EventPointer from a standard "q" tag
• getAddressPointerFromATag Creates an AddressPointer from a standard "a" tag
• getProfilePointerFromPTag Creates an ProfilePointer from a standard "p" tag
• getAddressPointerForEvent Returns an AddressPointer for a replaceable event

Delete events

• getDeleteIds Gets a list of referenced event ids
• getDeleteCoordinates Get the list of replaceable event coordinates the event is referencing

Emojis

• getPackName Gets the emoji pack name
• getEmojis Get all emojis in an emoji pack
• getEmojiTag CGets an "emoji" tag that matches an emoji code

URLs

• getURLFilename returns the filename part fo the path in a URL
• isAudioURL Checks if the URL ends with a audio file extension
• isVideoURL Checks if the URL ends with a video file extension
• isImageURL Checks if the URL ends with a image file extension
• isStreamURL Checks if the URL ends with a stream file extension

Tags

• isETag Checks if tag is an "e" tag and has at least one value
• isATag Checks if tag is an "a" tag and has at least one value
• isPTag Checks if tag is an "p" tag and has at least one value
• isDTag Checks if tag is an "d" tag and has at least one value
• isRTag Checks if tag is an "r" tag and has at least one value
• isTTag Checks if tag is an "t" tag and has at least one value

Hidden Tags

Hidden tags are used in NIP-51 lists and NIP-60 wallets

• canHaveHiddenTags Checks if a given event kind can have hidden tags
• hasHiddenTags Checks if an event has hidden tags
• getHiddenTags Returns the hidden tags for an event if they are unlocked
• isHiddenTagsLocked Checks if the hidden tags are locked
• unlockHiddenTags Unlocks the hidden tags using a signer
• overrideHiddenTags Replaces an events hidden tags
• modifyEventTags Modifies an events public or hidden tags

Filters

• isFilterEqual Check if two filters are equal

Time

• unixNow Returns the current unix timestamp

Factory Helpers

The applesauce-factory package exports some helpers for building events and tags

Some of the most useful ones are

• fillAndTrimTag Replaces undefined or null in tags with "" and trims to tag down to a set length if it ends with ""
• createQTagFromEventPointer Creates a "q" tag for from an EventPointer to tag quoted events
• createPTagFromProfilePointer Creates a "p" tag for from a ProfilePointer to tag mentioned pubkeys