Class NDKEvent

NDKEvent is the basic building block of NDK; most things you do with NDK will revolve around writing or consuming NDKEvents.

Hierarchy

EventEmitter
- NDKEvent

Constructors

constructor

new NDKEvent(ndk?: default, event?: NostrEvent): NDKEvent
Parameters
- Optional ndk: default
- Optional event: NostrEvent
Returns NDKEvent
Overrides EventEmitter.constructor
- Defined in ndk/src/events/index.ts:69

Properties

content

content: string = ""

`Optional` created_at

created_at?: number

decrypt

decrypt: ((...args: [sender?: NDKUser, signer?: NDKSigner]) => Promise<void>) = ...

Type declaration

- (...args: [sender?: NDKUser, signer?: NDKSigner]): Promise<void>
- Parameters
  - Rest ...args: [sender?: NDKUser, signer?: NDKSigner]
  Returns Promise<void>

encode

encode: ((...args: []) => string) = ...

Type declaration

- (...args: []): string
- Encodes a bech32 id.
  Parameters
  - Rest ...args: []
  Returns string
  - Encoded naddr, note or nevent.

encrypt

encrypt: ((...args: [recipient?: NDKUser, signer?: NDKSigner]) => Promise<void>) = ...

Type declaration

- (...args: [recipient?: NDKUser, signer?: NDKSigner]): Promise<void>
- Parameters
  - Rest ...args: [recipient?: NDKUser, signer?: NDKSigner]
  Returns Promise<void>

fetchReplyEvent

fetchReplyEvent: ((...args: [subOpts?: NDKSubscriptionOptions]) => Promise<undefined | null | NDKEvent>) = ...

Type declaration

- (...args: [subOpts?: NDKSubscriptionOptions]): Promise<undefined | null | NDKEvent>
- Fetch the event the current event is replying to.
  Parameters
  - Rest ...args: [subOpts?: NDKSubscriptionOptions]
  Returns Promise<undefined | null | NDKEvent>
  The fetched reply event or null if no event was found

fetchRootEvent

fetchRootEvent: ((...args: [subOpts?: NDKSubscriptionOptions]) => Promise<undefined | null | NDKEvent>) = ...

Type declaration

(...args: [subOpts?: NDKSubscriptionOptions]): Promise<undefined | null | NDKEvent>

Fetch the root event of the current event.

Parameters

Rest ...args: [subOpts?: NDKSubscriptionOptions]

Returns Promise<undefined | null | NDKEvent>

The fetched root event or null if no event was found

Example

const replyEvent = await ndk.fetchEvent("nevent1qqs8x8vnycyha73grv380gmvlury4wtmx0nr9a5ds2dngqwgu87wn6gpzemhxue69uhhyetvv9ujuurjd9kkzmpwdejhgq3ql2vyh47mk2p0qlsku7hg0vn29faehy9hy34ygaclpn66ukqp3afqz4cwjd")
const rootEvent = await replyEvent.fetchRootEvent();
console.log(replyEvent.encode() + " is a reply in the thread " + rootEvent?.encode());

fetchTaggedEvent

fetchTaggedEvent: ((...args: [tag: string, marker?: string]) => Promise<undefined | null | NDKEvent>) = ...

Type declaration

(...args: [tag: string, marker?: string]): Promise<undefined | null | NDKEvent>

Fetch an event tagged with the given tag following relay hints if provided.

Parameters

Rest ...args: [tag: string, marker?: string]

Returns Promise<undefined | null | NDKEvent>

The fetched event or null if no event was found, undefined if no matching tag was found in the event *

Example

const replyEvent = await ndk.fetchEvent("nevent1qqs8x8vnycyha73grv380gmvlury4wtmx0nr9a5ds2dngqwgu87wn6gpzemhxue69uhhyetvv9ujuurjd9kkzmpwdejhgq3ql2vyh47mk2p0qlsku7hg0vn29faehy9hy34ygaclpn66ukqp3afqz4cwjd")
const originalEvent = await replyEvent.fetchTaggedEvent("e", "reply");
console.log(replyEvent.encode() + " is a reply to event " + originalEvent?.encode());

getEventHash

getEventHash: ((...args: []) => string) = ...

Type declaration

- (...args: []): string
- Parameters
  - Rest ...args: []
  Returns string

id

id: string = ""

isEphemeral

isEphemeral: ((...args: []) => boolean) = ...

Type declaration

- (...args: []): boolean
- Parameters
  - Rest ...args: []
  Returns boolean

isParamReplaceable

isParamReplaceable: ((...args: []) => boolean) = ...

Type declaration

- (...args: []): boolean
- Parameters
  - Rest ...args: []
  Returns boolean

isReplaceable

isReplaceable: ((...args: []) => boolean) = ...

Type declaration

- (...args: []): boolean
- Parameters
  - Rest ...args: []
  Returns boolean

`Optional` kind

kind?: number

`Optional` ndk

ndk?: default

onRelays

onRelays: NDKRelay[] = []

The relays that this event was received from and/or successfully published to.

pubkey

pubkey: string = ""

`Optional` publishError

publishError?: Error

`Optional` publishStatus

publishStatus?: "pending" | "success" | "error" = "success"

The status of the publish operation.

relay

relay: undefined | NDKRelay

The relay that this event was first received from.

repost

repost: ((...args: [publish: boolean, signer?: NDKSigner]) => Promise<NDKEvent>) = ...

Type declaration

- (...args: [publish: boolean, signer?: NDKSigner]): Promise<NDKEvent>
- NIP-18 reposting event.
  Parameters
  - Rest ...args: [publish: boolean, signer?: NDKSigner]
  Returns Promise<NDKEvent>
  The reposted event
  Default
```
true
```
  Function

serialize

serialize: ((...args: [includeSig: boolean, includeId: boolean]) => string) = ...

Type declaration

- (...args: [includeSig: boolean, includeId: boolean]): string
- Parameters
  - Rest ...args: [includeSig: boolean, includeId: boolean]
  Returns string

`Optional` sig

sig?: string

`Optional` signatureVerified

signatureVerified?: boolean

validate

validate: ((...args: []) => boolean) = ...

Type declaration

- (...args: []): boolean
- Parameters
  - Rest ...args: []
  Returns boolean

verifySignature

verifySignature: ((...args: [persist: boolean]) => undefined | boolean) = ...

Type declaration

- (...args: [persist: boolean]): undefined | boolean
- Parameters
  - Rest ...args: [persist: boolean]
  Returns undefined | boolean

Accessors

alt

get alt(): undefined | string
Gets the NIP-31 "alt" tag of the event.

Returns undefined | string
- Defined in ndk/src/events/index.ts:263
set alt(alt: undefined | string): void
Sets the NIP-31 "alt" tag of the event. Use this to set an alt tag so clients that don't handle a particular event kind can display something useful for users.
Parameters
- alt: undefined | string
Returns void
- Defined in ndk/src/events/index.ts:272

author

get author(): NDKUser
Returns an NDKUser for the author of the event.

Returns NDKUser
- Defined in ndk/src/events/index.ts:115
set author(user: NDKUser): void
Parameters
- user: NDKUser
Returns void
- Defined in ndk/src/events/index.ts:106

dTag

get dTag(): undefined | string
Gets the NIP-33 "d" tag of the event.

Returns undefined | string
- Defined in ndk/src/events/index.ts:280
set dTag(value: undefined | string): void
Sets the NIP-33 "d" tag of the event.
Parameters
- value: undefined | string
Returns void
- Defined in ndk/src/events/index.ts:287

isValid

get isValid(): boolean
Checks whether the event is valid per underlying NIPs.

This method is meant to be overridden by subclasses that implement specific NIPs to allow the enforcement of NIP-specific validation rules.

Otherwise, it will only check for basic event properties.

Returns boolean
- Defined in ndk/src/events/index.ts:718

Methods

deduplicationKey

deduplicationKey(): string
Provides a deduplication key for the event.

For kinds 0, 3, 10k-20k this will be the event : For kinds 30k-40k this will be the event :: For all other kinds this will be the event id

Returns string
- Defined in ndk/src/events/index.ts:472

delete

delete(reason?: string, publish?: boolean): Promise<NDKEvent>
Generates a deletion event of the current event
Parameters
- Optional reason: string
  
  The reason for the deletion
- publish: boolean = true
  
  Whether to publish the deletion event automatically
Returns Promise<NDKEvent>
The deletion event
- Defined in ndk/src/events/index.ts:631

filter

filter(): NDKFilter

Provides the filter that will return matching events for this event.

Returns NDKFilter

The filter that will return matching events for this event

Example

event = new NDKEvent(ndk, { kind: 30000, pubkey: 'pubkey', tags: [ ["d", "d-code"] ] });
   event.filter(); // { "#a": ["30000:pubkey:d-code"] }

Example

event = new NDKEvent(ndk, { kind: 1, pubkey: 'pubkey', id: "eventid" });
   event.filter(); // { "#e": ["eventid"] }

generateTags

generateTags(): Promise<ContentTag>
Generates tags for users, notes, and other events tagged in content. Will also generate random "d" tag for parameterized replaceable events where needed.

Returns Promise<ContentTag>
The tags and content of the event.
- Defined in ndk/src/events/index.ts:399

getMatchingTags

getMatchingTags(tagName: string, marker?: string): NDKTag[]
Get all tags with the given name
Parameters
- tagName: string
  
  {string} The name of the tag to search for
- Optional marker: string
Returns NDKTag[]
An array of the matching tags
- Defined in ndk/src/events/index.ts:241

muted

muted(): null | string
Returns null | string
- Defined in ndk/src/events/index.ts:438

publish

publish(relaySet?: NDKRelaySet, timeoutMs?: number, requiredRelayCount?: number): Promise<Set<NDKRelay>>
Attempt to sign and then publish an NDKEvent to a given relaySet. If no relaySet is provided, the relaySet will be calculated by NDK.
Parameters
- Optional relaySet: NDKRelaySet
  
  {NDKRelaySet} The relaySet to publish the even to.
- Optional timeoutMs: number
- Optional requiredRelayCount: number
  
  The number of relays that must receive the event for the publish to be considered successful.
Returns Promise<Set<NDKRelay>>
A promise that resolves to the relays the event was published to.
- Defined in ndk/src/events/index.ts:351

publishReplaceable

publishReplaceable(relaySet?: NDKRelaySet, timeoutMs?: number, requiredRelayCount?: number): Promise<Set<NDKRelay>>
Parameters
- Optional relaySet: NDKRelaySet
- Optional timeoutMs: number
- Optional requiredRelayCount: number
Returns Promise<Set<NDKRelay>>
- Defined in ndk/src/events/index.ts:332

rawEvent

rawEvent(): NostrEvent
Returns the event as is.

Returns NostrEvent
- Defined in ndk/src/events/index.ts:94

react

react(content: string, publish?: boolean): Promise<NDKEvent>
React to an existing event
Parameters
- content: string
  
  The content of the reaction
- publish: boolean = true
Returns Promise<NDKEvent>
- Defined in ndk/src/events/index.ts:690

referenceTags

referenceTags(marker?: string, skipAuthorTag?: boolean, forceTag?: string): NDKTag[]
Get the tags that can be used to reference this event from another event
Parameters
- Optional marker: string
  
  The marker to use in the tag
- Optional skipAuthorTag: boolean
  
  Whether to explicitly skip adding the author tag of the event
- Optional forceTag: string
  
  Force a specific tag to be used instead of the default "e" or "a" tag
Returns NDKTag[]
The NDKTag object referencing this event
Example
```
event = new NDKEvent(ndk, { kind: 30000, pubkey: 'pubkey', tags: [ ["d", "d-code"] ] });
    event.referenceTags(); // [["a", "30000:pubkey:d-code"], ["e", "parent-id"]]

    event = new NDKEvent(ndk, { kind: 1, pubkey: 'pubkey', id: "eventid" });
    event.referenceTags(); // [["e", "parent-id"]]
```
- Defined in ndk/src/events/index.ts:569

removeTag

removeTag(tagName: string): void
Remove all tags with the given name (e.g. "d", "a", "p")
Parameters
- tagName: string
  
  Tag name to search for and remove
Returns void
- Defined in ndk/src/events/index.ts:297

replaceableDTag

replaceableDTag(): string
Returns the "d" tag of a parameterized replaceable event or throws an error if the event isn't a parameterized replaceable event.

Returns string
the "d" tag of the event.
- Defined in ndk/src/events/index.ts:454

sign

sign(signer?: NDKSigner): Promise<string>
Sign the event if a signer is present.

It will generate tags. Repleacable events will have their created_at field set to the current time.
Parameters
- Optional signer: NDKSigner
  
  {NDKSigner} The NDKSigner to use to sign the event
Returns Promise<string>
A Promise that resolves to the signature of the signed event.
- Defined in ndk/src/events/index.ts:309

tag

tag(user: NDKUser, marker?: string): void
Tag a user with an optional marker.
Parameters
- user: NDKUser
  
  The user to tag.
- Optional marker: string
  
  The marker to use in the tag.
Returns void
- Defined in ndk/src/events/index.ts:130
tag(user: NDKUser, marker?: string): void
Tag a user with an optional marker.
Parameters
- user: NDKUser
  
  The user to tag.
- Optional marker: string
  
  The marker to use in the tag.
Returns void
- Defined in ndk/src/events/index.ts:137
tag(event: NDKEvent, marker?: string, skipAuthorTag?: boolean, forceTag?: string): void
Tag a user with an optional marker.
Parameters
- event: NDKEvent
  
  The event to tag.
- Optional marker: string
  
  The marker to use in the tag.
- Optional skipAuthorTag: boolean
  
  Whether to explicitly skip adding the author tag of the event.
- Optional forceTag: string
  
  Force a specific tag to be used instead of the default "e" or "a" tag.
Returns void
Example
```
reply.tag(opEvent, "reply");
// reply.tags => [["e", <id>, <relay>, "reply"]]
```
- Defined in ndk/src/events/index.ts:151

tagAddress

tagAddress(): string
Returns the "reference" value ("::") for this replaceable event.

Returns string
The id
- Defined in ndk/src/events/index.ts:501

tagId

tagId(): string
Returns the id of the event or, if it's a parameterized event, the generated id of the event using "d" tag, pubkey, and kind.

Returns string
The id
- Defined in ndk/src/events/index.ts:488

tagReference

tagReference(marker?: string): NDKTag

Get the tag that can be used to reference this event from another event.

Consider using referenceTags() instead (unless you have a good reason to use this)

Parameters

Optional marker: string

Returns NDKTag

The NDKTag object referencing this event

Example

event = new NDKEvent(ndk, { kind: 30000, pubkey: 'pubkey', tags: [ ["d", "d-code"] ] });
    event.tagReference(); // ["a", "30000:pubkey:d-code"]

    event = new NDKEvent(ndk, { kind: 1, pubkey: 'pubkey', id: "eventid" });
    event.tagReference(); // ["e", "eventid"]

tagType

tagType(): "a" | "e"
Determines the type of tag that can be used to reference this event from another event.

Returns "a" | "e"
The tag type
Example
```
event = new NDKEvent(ndk, { kind: 30000, pubkey: 'pubkey', tags: [ ["d", "d-code"] ] });
event.tagType(); // "a"
```
- Defined in ndk/src/events/index.ts:516

tagValue

tagValue(tagName: string): undefined | string
Get the first tag with the given name
Parameters
- tagName: string
  
  Tag name to search for
Returns undefined | string
The value of the first tag with the given name, or undefined if no such tag exists
- Defined in ndk/src/events/index.ts:254

toNostrEvent

toNostrEvent(pubkey?: string): Promise<NostrEvent>
Return a NostrEvent object, trying to fill in missing fields when possible, adding tags when necessary.
Parameters
- Optional pubkey: string
  
  {string} The pubkey of the user who the event belongs to.
Returns Promise<NostrEvent>
A promise that resolves to a NostrEvent.
- Defined in ndk/src/events/index.ts:193

`Static` deserialize

deserialize(ndk: undefined | default, event: string): NDKEvent
Deserialize an NDKEvent from a serialized payload.
Parameters
- ndk: undefined | default
- event: string
Returns NDKEvent
- Defined in ndk/src/events/index.ts:87

Class NDKEvent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional ndk: default

Optional event: NostrEvent

Returns NDKEvent

Properties

content

Optional created_at

decrypt

Type declaration

Parameters

Rest ...args: [sender?: NDKUser, signer?: NDKSigner]

Returns Promise<void>

encode

Type declaration

Parameters

Rest ...args: []

Returns string

encrypt

Type declaration

Parameters

Rest ...args: [recipient?: NDKUser, signer?: NDKSigner]

Returns Promise<void>

fetchReplyEvent

Type declaration

Parameters

Rest ...args: [subOpts?: NDKSubscriptionOptions]

Returns Promise<undefined | null | NDKEvent>

fetchRootEvent

Type declaration

Parameters

Rest ...args: [subOpts?: NDKSubscriptionOptions]

Returns Promise<undefined | null | NDKEvent>

Example

fetchTaggedEvent

Type declaration

Parameters

Rest ...args: [tag: string, marker?: string]

Returns Promise<undefined | null | NDKEvent>

Example

getEventHash

Type declaration

Parameters

Rest ...args: []

Returns string

id

isEphemeral

Type declaration

Parameters

Rest ...args: []

Returns boolean

isParamReplaceable

Type declaration

Parameters

Rest ...args: []

Returns boolean

isReplaceable

Type declaration

Parameters

Rest ...args: []

Returns boolean

Optional kind

Optional ndk

onRelays

pubkey

Optional publishError

Optional publishStatus

relay

repost

Type declaration

Parameters

Rest ...args: [publish: boolean, signer?: NDKSigner]

`Optional` ndk: default

`Optional` event: NostrEvent

`Optional` created_at

`Rest` ...args: [sender?: NDKUser, signer?: NDKSigner]

`Rest` ...args: []

`Rest` ...args: [recipient?: NDKUser, signer?: NDKSigner]

`Rest` ...args: [subOpts?: NDKSubscriptionOptions]

`Rest` ...args: [subOpts?: NDKSubscriptionOptions]

`Rest` ...args: [tag: string, marker?: string]

`Rest` ...args: []

`Rest` ...args: []

`Rest` ...args: []

`Rest` ...args: []

`Optional` kind

`Optional` ndk

`Optional` publishError

`Optional` publishStatus

`Rest` ...args: [publish: boolean, signer?: NDKSigner]

`Rest` ...args: [includeSig: boolean, includeId: boolean]

`Optional` sig

`Optional` signatureVerified

`Rest` ...args: []

`Rest` ...args: [persist: boolean]

`Optional` reason: string

`Optional` marker: string

`Optional` relaySet: NDKRelaySet

`Optional` timeoutMs: number

`Optional` requiredRelayCount: number

`Optional` relaySet: NDKRelaySet

`Optional` timeoutMs: number