Skip to main content
Home
Browse packagesDocsSign in

@nostr/tools@2.15.1

latest
nbd-wtf/nostr-tools

Tools for developing Nostr clients.

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
70%
Published
2 days ago (2.15.1)
T
EventTemplate
No documentation available
T
Filter
No documentation available
v
finalizeEvent
No documentation available
N
fj
No documentation available
v
generateSecretKey
No documentation available
f
getEventHash
No documentation available
f
getFilterLimit

Calculate the intrinsic limit of a filter. This function returns a positive integer, or Infinity if there is no intrinsic limit.

v
getPublicKey
No documentation available
N
kinds
No documentation available
f
matchFilter
No documentation available
f
matchFilters
No documentation available
f
mergeFilters
No documentation available
N
nip04
No documentation available
N
nip05
No documentation available
N
nip10
No documentation available
N
nip11
No documentation available
N
nip13
No documentation available
N
nip17
No documentation available
N
nip18
No documentation available
N
nip19
No documentation available
N
nip21
No documentation available
N
nip25
No documentation available
N
nip27
No documentation available
N
nip28
No documentation available
N
nip30
No documentation available
N
nip39
No documentation available
N
nip42
No documentation available
N
nip44
No documentation available
N
nip47
No documentation available
f
nip47.makeNwcRequestEvent
No documentation available
f
nip47.parseConnectionString
No documentation available
N
nip54
No documentation available
N
nip57
No documentation available
N
nip59
No documentation available
N
nip98
No documentation available
T
NostrEvent
No documentation available
f
parseReferences
No documentation available
f
serializeEvent
No documentation available
f
sortEvents

Sort events in reverse-chronological order by the created_at timestamp, and then by the event id (lexicographically) in case of ties. This mutates the array.

T
UnsignedEvent
No documentation available
N
utils
No documentation available
f
validateEvent
No documentation available
I
VerifiedEvent

An event whose signature has been verified.

v
verifiedSymbol

Designates a verified event signature.

v
verifyEvent
No documentation available
T
AbstractPoolConstructorOptions
No documentation available
T
SubCloser
No documentation available
T
SubscribeManyParams
No documentation available
T
CountResolver
No documentation available
T
EventPublishResolver
No documentation available
c
SendingOnClosedConnection
No documentation available
T
EventTemplate
No documentation available
T
NostrEvent
No documentation available
f
sortEvents

Sort events in reverse-chronological order by the created_at timestamp, and then by the event id (lexicographically) in case of ties. This mutates the array.

T
UnsignedEvent
No documentation available
f
validateEvent
No documentation available
I
VerifiedEvent

An event whose signature has been verified.

v
verifiedSymbol

Designates a verified event signature.

f
fj.getHex64
No documentation available
f
fj.getInt
No documentation available
f
fj.getSubscriptionId
No documentation available
f
fj.matchEventId
No documentation available
f
fj.matchEventKind
No documentation available
f
fj.matchEventPubkey
No documentation available
f
getHex64
No documentation available
f
getInt
No documentation available
f
getSubscriptionId
No documentation available
f
matchEventId
No documentation available
f
matchEventKind
No documentation available
f
matchEventPubkey
No documentation available
T
Filter
No documentation available
f
getFilterLimit

Calculate the intrinsic limit of a filter. This function returns a positive integer, or Infinity if there is no intrinsic limit.

f
matchFilter
No documentation available
f
matchFilters
No documentation available
f
mergeFilters
No documentation available
T
v
Application
No documentation available
T
v
BadgeAward
No documentation available
T
v
BadgeDefinition
No documentation available
T
v
BlockedRelaysList
No documentation available
T
v
BookmarkList
No documentation available
T
v
Bookmarksets
No documentation available
T
v
Calendar
No documentation available
T
v
CalendarEventRSVP
No documentation available
T
v
ChannelCreation
No documentation available
T
v
ChannelHideMessage
No documentation available
T
v
ChannelMessage
No documentation available
T
v
ChannelMetadata
No documentation available
T
v
ChannelMuteUser
No documentation available
T
v
ClassifiedListing
No documentation available
f
classifyKind

Determine the classification of this kind of event if known, or unknown.

T
v
ClientAuth
No documentation available
T
v
CommunitiesList
No documentation available
T
v
CommunityDefinition
No documentation available
T
v
CommunityPostApproval
No documentation available
T
v
Contacts
No documentation available
T
v
CreateOrUpdateProduct
No documentation available
T
v
CreateOrUpdateStall
No documentation available
T
v
Curationsets
No documentation available
T
v
Date
No documentation available
T
v
DirectMessageRelaysList
No documentation available
T
v
DraftClassifiedListing
No documentation available
T
v
DraftLong
No documentation available
T
v
Emojisets
No documentation available
T
v
EncryptedDirectMessage
No documentation available
T
v
EventDeletion
No documentation available
T
v
FileMetadata
No documentation available
T
v
FileServerPreference
No documentation available
T
v
Followsets
No documentation available
T
v
Genericlists
No documentation available
T
v
GenericRepost
No documentation available
T
v
GiftWrap
No documentation available
T
v
Handlerinformation
No documentation available
T
v
Handlerrecommendation
No documentation available
T
v
Highlights
No documentation available
T
v
HTTPAuth
No documentation available
T
v
Interestsets
No documentation available
T
v
InterestsList
No documentation available
f
isAddressableKind

Events are addressable, which means that, for each combination of pubkey, kind and the d tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded.

f
isEphemeralKind

Events are ephemeral, which means they are not expected to be stored by relays.

f
isKind
No documentation available
f
isRegularKind

Events are regular, which means they're all expected to be stored by relays.

f
isReplaceableKind

Events are replaceable, which means that, for each combination of pubkey and kind, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded.

T
v
JobFeedback
No documentation available
T
v
JobRequest
No documentation available
T
v
JobResult
No documentation available
T
KindClassification

Classification of the event kind.

T
v
kinds.Application
No documentation available
T
v
kinds.BadgeAward
No documentation available
T
v
kinds.BadgeDefinition
No documentation available
T
v
kinds.BlockedRelaysList
No documentation available
T
v
kinds.BookmarkList
No documentation available
T
v
kinds.Bookmarksets
No documentation available
T
v
kinds.Calendar
No documentation available
T
v
kinds.CalendarEventRSVP
No documentation available
T
v
kinds.ChannelCreation
No documentation available
T
v
kinds.ChannelHideMessage
No documentation available
T
v
kinds.ChannelMessage
No documentation available
T
v
kinds.ChannelMetadata
No documentation available
T
v
kinds.ChannelMuteUser
No documentation available
T
v
kinds.ClassifiedListing
No documentation available
f
kinds.classifyKind

Determine the classification of this kind of event if known, or unknown.

T
v
kinds.ClientAuth
No documentation available
T
v
kinds.CommunitiesList
No documentation available
T
v
kinds.CommunityDefinition
No documentation available
T
v
kinds.CommunityPostApproval
No documentation available
T
v
kinds.Contacts
No documentation available
T
v
kinds.CreateOrUpdateProduct
No documentation available
T
v
kinds.CreateOrUpdateStall
No documentation available
T
v
kinds.Curationsets
No documentation available
T
v
kinds.Date
No documentation available
T
v
kinds.DirectMessageRelaysList
No documentation available
T
v
kinds.DraftClassifiedListing
No documentation available
T
v
kinds.DraftLong
No documentation available
T
v
kinds.Emojisets
No documentation available
T
v
kinds.EncryptedDirectMessage
No documentation available
T
v
kinds.EventDeletion
No documentation available
T
v
kinds.FileMetadata
No documentation available
T
v
kinds.FileServerPreference
No documentation available
T
v
kinds.Followsets
No documentation available
T
v
kinds.Genericlists
No documentation available
T
v
kinds.GenericRepost
No documentation available
T
v
kinds.GiftWrap
No documentation available
T
v
kinds.Handlerinformation
No documentation available
T
v
kinds.Handlerrecommendation
No documentation available
T
v
kinds.Highlights
No documentation available
T
v
kinds.HTTPAuth
No documentation available
T
v
kinds.Interestsets
No documentation available
T
v
kinds.InterestsList
No documentation available
f
kinds.isAddressableKind

Events are addressable, which means that, for each combination of pubkey, kind and the d tag, only the latest event is expected to be stored by relays, older versions are expected to be discarded.

f
kinds.isEphemeralKind

Events are ephemeral, which means they are not expected to be stored by relays.

f
kinds.isKind
No documentation available
f
kinds.isRegularKind

Events are regular, which means they're all expected to be stored by relays.

f
kinds.isReplaceableKind

Events are replaceable, which means that, for each combination of pubkey and kind, only the latest event is expected to (SHOULD) be stored by relays, older versions are expected to be discarded.

T
v
kinds.JobFeedback
No documentation available
T
v
kinds.JobRequest
No documentation available
T
v
kinds.JobResult
No documentation available
T
kinds.KindClassification

Classification of the event kind.

T
v
kinds.Label
No documentation available
T
v
kinds.LightningPubRPC
No documentation available
T
v
kinds.LiveChatMessage
No documentation available
T
v
kinds.LiveEvent
No documentation available
T
v
kinds.LongFormArticle
No documentation available
T
v
kinds.Metadata
No documentation available
T
v
kinds.Mutelist
No documentation available
T
v
kinds.NostrConnect
No documentation available
T
v
kinds.NWCWalletInfo
No documentation available
T
v
kinds.NWCWalletRequest
No documentation available
T
v
kinds.NWCWalletResponse
No documentation available
T
v
kinds.OpenTimestamps
No documentation available
T
v
kinds.Pinlist
No documentation available
T
v
kinds.PrivateDirectMessage
No documentation available
T
v
kinds.ProblemTracker
No documentation available
T
v
kinds.ProfileBadges
No documentation available
T
v
kinds.PublicChatsList
No documentation available
T
v
kinds.Reaction
No documentation available
T
v
kinds.RecommendRelay
No documentation available
T
v
kinds.RelayList
No documentation available
T
v
kinds.Relaysets
No documentation available
T
v
kinds.Report
No documentation available
T
v
kinds.Reporting
No documentation available
T
v
kinds.Repost
No documentation available
T
v
kinds.Seal
No documentation available
T
v
kinds.SearchRelaysList
No documentation available
T
v
kinds.ShortTextNote
No documentation available
T
v
kinds.Time
No documentation available
T
v
kinds.UserEmojiList
No documentation available
T
v
kinds.UserStatuses
No documentation available
T
v
kinds.Zap
No documentation available
T
v
kinds.ZapGoal
No documentation available
T
v
kinds.ZapRequest
No documentation available
T
v
Label
No documentation available
T
v
LightningPubRPC
No documentation available
T
v
LiveChatMessage
No documentation available
T
v
LiveEvent
No documentation available
T
v
LongFormArticle
No documentation available
T
v
Metadata
No documentation available
T
v
Mutelist
No documentation available
T
v
NostrConnect
No documentation available
T
v
NWCWalletInfo
No documentation available
T
v
NWCWalletRequest
No documentation available
T
v
NWCWalletResponse
No documentation available
T
v
OpenTimestamps
No documentation available
T
v
Pinlist
No documentation available
T
v
PrivateDirectMessage
No documentation available
T
v
ProblemTracker
No documentation available
T
v
ProfileBadges
No documentation available
T
v
PublicChatsList
No documentation available
T
v
Reaction
No documentation available
T
v
RecommendRelay
No documentation available
T
v
RelayList
No documentation available
T
v
Relaysets
No documentation available
T
v
Report
No documentation available
T
v
Reporting
No documentation available
T
v
Repost
No documentation available
T
v
Seal
No documentation available
T
v
SearchRelaysList
No documentation available
T
v
ShortTextNote
No documentation available
T
v
Time
No documentation available
T
v
UserEmojiList
No documentation available
T
v
UserStatuses
No documentation available
T
v
Zap
No documentation available
T
v
ZapGoal
No documentation available
T
v
ZapRequest
No documentation available
f
decrypt
No documentation available
f
encrypt
No documentation available
f
nip04.decrypt
No documentation available
f
nip04.encrypt
No documentation available
f
isNip05
No documentation available
f
isValid
No documentation available
T
Nip05
No documentation available
f
nip05.isNip05
No documentation available
f
nip05.isValid
No documentation available
T
nip05.Nip05
No documentation available
v
nip05.NIP05_REGEX

NIP-05 regex. The localpart is optional, and should be assumed to be _ otherwise.

f
nip05.queryProfile
No documentation available
f
nip05.searchDomain
No documentation available
f
nip05.useFetchImplementation
No documentation available
v
NIP05_REGEX

NIP-05 regex. The localpart is optional, and should be assumed to be _ otherwise.

f
queryProfile
No documentation available
f
searchDomain
No documentation available
f
useFetchImplementation
No documentation available
f
accountFromExtendedKey
No documentation available
f
accountFromSeedWords
No documentation available
f
extendedKeysFromSeedWords
No documentation available
f
generateSeedWords
No documentation available
f
privateKeyFromSeedWords
No documentation available
f
validateWords
No documentation available
I
WindowNostr
No documentation available
f
nip10.parse
No documentation available
f
parse
No documentation available
I
Amount
No documentation available
I
ContentLimitations

Some relays may be governed by the arbitrary laws of a nation state. This may limit what content can be stored in cleartext on those relays. All clients are encouraged to use encryption to work around this limitation.

I
Fees
No documentation available
f
fetchRelayInformation
No documentation available
I
Icon

A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape.

I
Limitations

These are limitations imposed by the relay on clients. Your client should expect that requests which exceed these practical_ limitations are rejected or fail immediately.

I
nip11.Amount
No documentation available
I
nip11.ContentLimitations

Some relays may be governed by the arbitrary laws of a nation state. This may limit what content can be stored in cleartext on those relays. All clients are encouraged to use encryption to work around this limitation.

I
nip11.Fees
No documentation available
f
nip11.fetchRelayInformation
No documentation available
I
nip11.Icon

A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape.

I
nip11.Limitations

These are limitations imposed by the relay on clients. Your client should expect that requests which exceed these practical_ limitations are rejected or fail immediately.

I
nip11.PayToRelay

Relays that require payments may want to expose their fee schedules.

I
nip11.PublicationAmount
No documentation available
T
nip11.RelayInformation
No documentation available
I
nip11.Retention

Event Retention

I
nip11.RetentionDetails
No documentation available
I
nip11.Subscription
No documentation available
f
nip11.useFetchImplementation
No documentation available
I
PayToRelay

Relays that require payments may want to expose their fee schedules.

I
PublicationAmount
No documentation available
T
RelayInformation
No documentation available
I
Retention

Event Retention

I
RetentionDetails
No documentation available
I
Subscription
No documentation available
f
useFetchImplementation
No documentation available
f
fastEventHash
No documentation available
f
getPow

Get POW difficulty from a Nostr hex ID.

f
minePow

Mine an event with the desired POW. This function mutates the event. Note that this operation is synchronous and should be run in a worker context to avoid blocking the main thread.

f
nip13.fastEventHash
No documentation available
f
nip13.getPow

Get POW difficulty from a Nostr hex ID.

f
nip13.minePow

Mine an event with the desired POW. This function mutates the event. Note that this operation is synchronous and should be run in a worker context to avoid blocking the main thread.

v
nip17.unwrapEvent
No documentation available
v
nip17.unwrapManyEvents
No documentation available
f
nip17.wrapEvent
No documentation available
f
nip17.wrapManyEvents
No documentation available
v
unwrapEvent
No documentation available
v
unwrapManyEvents
No documentation available
f
wrapEvent
No documentation available
f
wrapManyEvents
No documentation available
f
finishRepostEvent
No documentation available
f
getRepostedEvent
No documentation available
T
GetRepostedEventOptions
No documentation available
f
getRepostedEventPointer
No documentation available
f
nip18.finishRepostEvent
No documentation available
f
nip18.getRepostedEvent
No documentation available
T
nip18.GetRepostedEventOptions
No documentation available
f
nip18.getRepostedEventPointer
No documentation available
T
RepostEventTemplate
No documentation available
T
AddressPointer
No documentation available
v
BECH32_REGEX

Bech32 regex.

v
Bech32MaxSize
No documentation available
f
decode
No documentation available
T
DecodedNaddr
No documentation available
T
DecodedNevent
No documentation available
T
DecodedNote
No documentation available
T
DecodedNprofile
No documentation available
T
DecodedNpub
No documentation available
T
DecodedNsec
No documentation available
T
DecodedResult
No documentation available
f
decodeNostrURI
No documentation available
f
encodeBytes
No documentation available
T
EventPointer
No documentation available
T
NAddr
No documentation available
f
naddrEncode
No documentation available
T
Ncryptsec
No documentation available
T
NEvent
No documentation available
f
neventEncode
No documentation available
v
nip19.BECH32_REGEX

Bech32 regex.

v
nip19.Bech32MaxSize
No documentation available
f
nip19.decode
No documentation available
T
nip19.DecodedNaddr
No documentation available
T
nip19.DecodedNevent
No documentation available
T
nip19.DecodedNote
No documentation available
T
nip19.DecodedNprofile
No documentation available
T
nip19.DecodedNpub
No documentation available
T
nip19.DecodedNsec
No documentation available
T
nip19.DecodedResult
No documentation available
f
nip19.decodeNostrURI
No documentation available
f
nip19.encodeBytes
No documentation available
T
nip19.EventPointer
No documentation available
T
nip19.NAddr
No documentation available
f
nip19.naddrEncode
No documentation available
T
nip19.Ncryptsec
No documentation available
T
nip19.NEvent
No documentation available
f
nip19.neventEncode
No documentation available
T
nip19.Note
No documentation available
f
nip19.noteEncode
No documentation available
T
nip19.NProfile
No documentation available
f
nip19.nprofileEncode
No documentation available
T
nip19.NPub
No documentation available
f
nip19.npubEncode
No documentation available
T
nip19.NSec
No documentation available
f
nip19.nsecEncode
No documentation available
T
nip19.ProfilePointer
No documentation available
T
Note
No documentation available
f
noteEncode
No documentation available
T
NProfile
No documentation available
f
nprofileEncode
No documentation available
T
NPub
No documentation available
f
npubEncode
No documentation available
T
NSec
No documentation available
f
nsecEncode
No documentation available
T
ProfilePointer
No documentation available
v
nip21.NOSTR_URI_REGEX

Nostr URI regex, eg nostr:npub1...

I
nip21.NostrURI

Parsed Nostr URI data.

f
nip21.parse

Parse and decode a Nostr URI.

f
nip21.test

Test whether the value is a Nostr URI.

v
NOSTR_URI_REGEX

Nostr URI regex, eg nostr:npub1...

I
NostrURI

Parsed Nostr URI data.

f
parse

Parse and decode a Nostr URI.

f
test

Test whether the value is a Nostr URI.

f
finishReactionEvent
No documentation available
f
getReactedEventPointer
No documentation available
f
nip25.finishReactionEvent
No documentation available
f
nip25.getReactedEventPointer
No documentation available
T
ReactionEventTemplate
No documentation available
T
Block
No documentation available
T
nip27.Block
No documentation available
f
nip27.parse
No documentation available
f
parse
No documentation available
f
channelCreateEvent
No documentation available
f
channelHideMessageEvent
No documentation available
f
channelMessageEvent
No documentation available
I
ChannelMetadata
No documentation available
f
channelMetadataEvent
No documentation available
f
channelMuteUserEvent
No documentation available
f
nip28.channelCreateEvent
No documentation available
f
nip28.channelHideMessageEvent
No documentation available
f
nip28.channelMessageEvent
No documentation available
I
nip28.ChannelMetadata
No documentation available
f
nip28.channelMetadataEvent
No documentation available
f
nip28.channelMuteUserEvent
No documentation available
f
encodeGroupReference

Encodes a group reference into a string.

f
fetchGroupAdminsEvent

Fetches the group admins event from the specified pool. If the normalizedRelayURL is not provided, it will be obtained from the groupReference. If the relayInformation is not provided, it will be fetched using the normalizedRelayURL.

f
fetchGroupMembersEvent

Fetches the group members event from the specified relay. If the normalizedRelayURL is not provided, it will be obtained using the groupReference. If the relayInformation is not provided, it will be fetched using the normalizedRelayURL.

f
fetchGroupMetadataEvent

Fetches the group metadata event from the specified pool. If the normalizedRelayURL is not provided, it will be obtained using the groupReference. If the relayInformation is not provided, it will be fetched using the normalizedRelayURL.

f
fetchRelayInformationByGroupReference

Fetches relay information by group reference.

f
generateGroupAdminsEventTemplate

Generates an event template for group admins.

f
generateGroupMembersEventTemplate

Generates an event template for a group with its members.

f
generateGroupMetadataEventTemplate

Generates a group metadata event template.

f
getNormalizedRelayURLByGroupReference

Returns the normalized relay URL based on the provided group reference.

T
Group

Represents a NIP29 group.

T
GroupAdmin

Represents a NIP29 group admin.

E
GroupAdminPermission

Represents the permissions that a NIP29 group admin can have.

T
GroupMember

Represents a NIP29 group member.

T
GroupMetadata

Represents the metadata for a NIP29 group.

T
GroupReference

Represents a NIP29 group reference.

f
loadGroup

Fetches and parses the group metadata event, group admins event, and group members event from the specified pool. If the normalized relay URL is not provided, it will be obtained using the group reference. If the relay information is not provided, it will be fetched using the normalized relay URL.

f
loadGroupFromCode

Loads a group from the specified pool using the provided group code.

f
parseGroupAdminsEvent

Parses a group admins event and returns an array of GroupAdmin objects.

f
parseGroupCode

Parses a group code and returns a GroupReference object.

f
parseGroupMembersEvent

Parses a group members event and returns an array of GroupMember objects.

f
parseGroupMetadataEvent

Parses a group metadata event and returns the corresponding GroupMetadata object.

f
subscribeRelayGroupsMetadataEvents

Subscribes to relay groups metadata events and calls the provided event handler function when an event is received.

f
validateGroupAdminsEvent

Validates a group admins event.

f
validateGroupMembersEvent

Validates a group members event.

f
validateGroupMetadataEvent

Validates a group metadata event.

I
CustomEmoji

Represents a Nostr custom emoji.

I
CustomEmojiMatch

Match result for a custom emoji in text content.

v
EMOJI_SHORTCODE_REGEX

Regex for a single emoji shortcode.

f
matchAll

Find all custom emoji shortcodes.

I
nip30.CustomEmoji

Represents a Nostr custom emoji.

I
nip30.CustomEmojiMatch

Match result for a custom emoji in text content.

v
nip30.EMOJI_SHORTCODE_REGEX

Regex for a single emoji shortcode.

f
nip30.matchAll

Find all custom emoji shortcodes.

f
nip30.regex

Regex to find emoji shortcodes in content.

f
nip30.replaceAll

Replace all emoji shortcodes in the content.

f
regex

Regex to find emoji shortcodes in content.

f
replaceAll

Replace all emoji shortcodes in the content.

f
nip39.useFetchImplementation
No documentation available
f
nip39.validateGithub
No documentation available
f
useFetchImplementation
No documentation available
f
validateGithub
No documentation available
f
makeAuthEvent

creates an EventTemplate for an AUTH event to be signed.

f
nip42.makeAuthEvent

creates an EventTemplate for an AUTH event to be signed.

f
decrypt
No documentation available
f
encrypt
No documentation available
f
getConversationKey
No documentation available
f
nip44.decrypt
No documentation available
f
nip44.encrypt
No documentation available
f
nip44.getConversationKey
No documentation available
v
nip44.v2
No documentation available
v
v2
No documentation available
v
BUNKER_REGEX
No documentation available
T
BunkerPointer
No documentation available
T
BunkerSignerParams
No documentation available
f
createAccount

Creates an account with the specified username, domain, and optional email.

f
fetchBunkerProviders

Fetches info on available providers that announce themselves using NIP-89 events.

f
parseBunkerInput

This takes either a bunker:// URL or a name@domain.com NIP-05 identifier and returns a BunkerPointer -- or null in case of error

f
queryBunkerProfile
No documentation available
f
toBunkerURL
No documentation available
f
useFetchImplementation
No documentation available
f
decrypt
No documentation available
f
encrypt
No documentation available
f
nip54.normalizeIdentifier
No documentation available
f
normalizeIdentifier
No documentation available
f
getSatoshisAmountFromBolt11
No documentation available
f
getZapEndpoint
No documentation available
f
makeZapReceipt
No documentation available
f
makeZapRequest
No documentation available
f
nip57.getSatoshisAmountFromBolt11
No documentation available
f
nip57.getZapEndpoint
No documentation available
f
nip57.makeZapReceipt
No documentation available
f
nip57.makeZapRequest
No documentation available
f
nip57.useFetchImplementation
No documentation available
f
nip57.validateZapRequest
No documentation available
f
useFetchImplementation
No documentation available
f
validateZapRequest
No documentation available
T
BadgeAward

Represents the structure for awarding a badge to one or more recipients within the Nostr network. This structure is used to create templates for badge award events, which are immutable and signify the recognition of individuals' achievements or contributions.

T
BadgeDefinition

Represents the structure for defining a badge within the Nostr network. This structure is used to create templates for badge definition events, facilitating the recognition and awarding of badges to users for various achievements.

f
generateBadgeAwardEventTemplate

Generates an EventTemplate based on the provided BadgeAward.

f
generateBadgeDefinitionEventTemplate

Generates an EventTemplate based on the provided BadgeDefinition.

f
generateProfileBadgesEventTemplate

Generates an EventTemplate based on the provided ProfileBadges.

T
ProfileBadges

Represents the collection of badges a user chooses to display on their profile. This structure is crucial for applications that allow users to showcase achievements or recognitions in the form of badges, following the specifications of NIP-58.

f
validateBadgeAwardEvent

Validates a badge award event.

f
validateBadgeDefinitionEvent

Validates a badge definition event.

f
validateProfileBadgesEvent

Validates a profile badges event.

f
createRumor
No documentation available
f
createSeal
No documentation available
f
createWrap
No documentation available
f
nip59.createRumor
No documentation available
f
nip59.createSeal
No documentation available
f
nip59.createWrap
No documentation available
f
nip59.unwrapEvent
No documentation available
f
nip59.unwrapManyEvents
No documentation available
f
nip59.wrapEvent
No documentation available
f
nip59.wrapManyEvents
No documentation available
f
unwrapEvent
No documentation available
f
unwrapManyEvents
No documentation available
f
wrapEvent
No documentation available
f
wrapManyEvents
No documentation available
f
generateGoalEventTemplate

Generates an EventTemplate for a fundraising goal based on the provided ZapGoal object. This function is tailored to fit the structure of EventTemplate as defined in the library.

T
Goal

Represents a fundraising goal in the Nostr network as defined by NIP-75. This type is used to structure the information needed to create a goal event (kind:9041).

f
validateZapGoalEvent
No documentation available
T
FileMetadataObject

Type definition for File Metadata as specified in NIP-94. This type is used to represent the metadata associated with a file sharing event (kind: 1063).

f
generateEventTemplate

Generates an event template based on a file metadata object.

f
parseEvent

Parses an event and returns a file metadata object.

f
validateEvent

Validates an event to ensure it is a valid file metadata event.

f
getToken

Generate token for NIP-98 flow.

f
hashPayload

Calculates the hash of a payload.

f
nip98.getToken

Generate token for NIP-98 flow.

f
nip98.hashPayload

Calculates the hash of a payload.

f
nip98.unpackEventFromToken

Unpacks an event from a token.

f
nip98.validateEvent

Validates a Nostr event for the NIP-98 flow.

f
nip98.validateEventKind

Validates the kind of an event.

f
nip98.validateEventMethodTag

Validates if the given event has a method tag that matches the specified method.

f
nip98.validateEventPayloadTag

Validates the event payload tag against the provided payload.

f
nip98.validateEventTimestamp

Validates the timestamp of an event.

f
nip98.validateEventUrlTag

Validates if the given URL matches the URL tag of the event.

f
nip98.validateToken

Validate token for NIP-98 flow.

f
unpackEventFromToken

Unpacks an event from a token.

f
validateEvent

Validates a Nostr event for the NIP-98 flow.

f
validateEventKind

Validates the kind of an event.

f
validateEventMethodTag

Validates if the given event has a method tag that matches the specified method.

f
validateEventPayloadTag

Validates the event payload tag against the provided payload.

f
validateEventTimestamp

Validates the timestamp of an event.

f
validateEventUrlTag

Validates if the given URL matches the URL tag of the event.

f
validateToken

Validate token for NIP-98 flow.

f
generateEventTemplate

Generates an event template based on a classified listing object.

f
parseEvent

Parses an event and returns a classified listing object.

T
PriceDetails

Represents the details of a price.

f
validateEvent

Validates an event to ensure it is a valid classified listing event.

T
BlobDescriptor
No documentation available
T
AbstractPoolConstructorOptions
No documentation available
c
SimplePool
No documentation available
T
SubCloser
No documentation available
T
SubscribeManyParams
No documentation available
f
useWebSocketImplementation
No documentation available
T
EventTemplate
No documentation available
v
finalizeEvent
No documentation available
v
generateSecretKey
No documentation available
f
getEventHash
No documentation available
v
getPublicKey
No documentation available
T
NostrEvent
No documentation available
f
serializeEvent
No documentation available
f
sortEvents

Sort events in reverse-chronological order by the created_at timestamp, and then by the event id (lexicographically) in case of ties. This mutates the array.

T
UnsignedEvent
No documentation available
f
validateEvent
No documentation available
I
VerifiedEvent

An event whose signature has been verified.

v
verifiedSymbol

Designates a verified event signature.

v
verifyEvent
No documentation available
f
parseReferences
No documentation available
T
CountResolver
No documentation available
T
EventPublishResolver
No documentation available
c
Relay
No documentation available
T
RelayRecord
No documentation available
c
SendingOnClosedConnection
No documentation available
f
useWebSocketImplementation
No documentation available
c
PlainKeySigner
No documentation available
I
Signer
No documentation available
f
binarySearch
No documentation available
f
insertEventIntoAscendingList
No documentation available
f
insertEventIntoDescendingList
No documentation available
f
normalizeURL
No documentation available
c
Queue
No documentation available
c
QueueNode
No documentation available
v
utf8Decoder
No documentation available
v
utf8Encoder
No documentation available
f
utils.binarySearch
No documentation available
f
utils.insertEventIntoAscendingList
No documentation available
f
utils.insertEventIntoDescendingList
No documentation available
f
utils.normalizeURL
No documentation available
c
utils.Queue
No documentation available
c
utils.QueueNode
No documentation available
v
utils.utf8Decoder
No documentation available
v
utils.utf8Encoder
No documentation available
T
EventTemplate
No documentation available
v
finalizeEvent
No documentation available
v
generateSecretKey
No documentation available
v
getPublicKey
No documentation available
T
NostrEvent
No documentation available
f
setNostrWasm
No documentation available
f
sortEvents

Sort events in reverse-chronological order by the created_at timestamp, and then by the event id (lexicographically) in case of ties. This mutates the array.

T
UnsignedEvent
No documentation available
f
validateEvent
No documentation available
I
VerifiedEvent

An event whose signature has been verified.

v
verifiedSymbol

Designates a verified event signature.

v
verifyEvent
No documentation available

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.