Class NDKSubscriptionTier

Description

Implements NIP-88 (TBD)'s subscription tiers

This class will validate that incoming events are valid subscription tiers. Incomplete or invalid amounts will be ignored.

Example

const tier = new NDKSubscriptionTier;
tier.title = "Tier 1";
tier.addAmount(100000, "msat", "monthly"); // 100 sats per month
tier.addAmount(499, "usd", "monthly"); // $4.99 per month
tier.relayUrl = "wss://relay.highlighter.com/";
tier.relayUrl = "wss://relay.creator.com/";
tier.verifierPubkey = "<pubkey>";
tier.addPerk("Access to my private content");

Hierarchy (view full)

Constructors

constructor

Properties

content created_at? decrypt encode encrypt fetchReplyEvent fetchRootEvent fetchTaggedEvent getEventHash id isEphemeral isParamReplaceable isReplaceable kind? ndk? pubkey publishError? publishStatus? relay repost serialize sig? signatureVerified? tags validate verifySignature kind kinds

Accessors

alt amounts author dTag image isValid onRelays perks published_at relayUrl relayUrls summary title url verifierPubkey

Methods

addAmount addPerk deduplicationKey delete filter generateTags getMatchingTags hasTag muted publish publishReplaceable rawEvent react referenceTags removeTag replaceableDTag sign tag tagAddress tagExternal tagId tagReference tagType tagValue toNostrEvent deserialize from

Constructors

constructor

Properties

content

content: string = ""

Optionalcreated_at

created_at?: number

decrypt

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

encode

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

Encodes a bech32 id.

Type declaration

    • (...args: [maxRelayCount: number]): string

    • Parameters

      • Rest...args: [maxRelayCount: number]

      Returns string

      • Encoded naddr, note or nevent.

encrypt

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

fetchReplyEvent

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

Fetch the event the current event is replying to.

Type declaration

fetchRootEvent

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

Fetch the root event of the current event.

Type declaration

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>) = ...

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

Type declaration

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

    • 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) = ...

id

id: string = ""

isEphemeral

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

isParamReplaceable

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

isReplaceable

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

Optionalkind

kind?: number

Optionalndk

ndk?: default

pubkey

pubkey: string = ""

OptionalpublishError

publishError?: Error

OptionalpublishStatus

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>) = ...

NIP-18 reposting event.

Type declaration

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

    • Parameters

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

      Returns Promise<NDKEvent>

      The reposted event

Default

true

Function

serialize

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

Optionalsig

sig?: string

OptionalsignatureVerified

signatureVerified?: boolean

tags

tags: NDKTag[] = []

validate

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

verifySignature

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

Statickind

kind: NDKKind = NDKKind.SubscriptionTier

Statickinds

kinds: NDKKind[] = ...

Accessors

alt

  • get alt(): undefined | string

  • Gets the NIP-31 "alt" tag of the event.

    Returns undefined | string

  • 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

amounts

author

dTag

  • get dTag(): undefined | string

  • Gets the NIP-33 "d" tag of the event.

    Returns undefined | string

  • set dTag(value: undefined | string): void

  • Sets the NIP-33 "d" tag of the event.

    Parameters

    • value: undefined | string

    Returns void

image

  • get image(): undefined | string

  • Getter for the article image.

    Returns undefined | string

    • The article image if available, otherwise undefined.
  • set image(image: undefined | string): void

  • Setter for the article image.

    Parameters

    • image: undefined | string

      The image to set for the article.

    Returns void

isValid

onRelays

perks

published_at

  • get published_at(): undefined | number

  • Getter for the article's publication timestamp.

    Returns undefined | number

    • The Unix timestamp of when the article was published or undefined.
  • set published_at(timestamp: undefined | number): void

  • Setter for the article's publication timestamp.

    Parameters

    • timestamp: undefined | number

      The Unix timestamp to set for the article's publication date.

    Returns void

relayUrl

relayUrls

summary

title

  • get title(): undefined | string

  • Getter for the article title.

    Returns undefined | string

    • The article title if available, otherwise undefined.
  • set title(title: undefined | string): void

  • Setter for the article title.

    Parameters

    • title: undefined | string

      The title to set for the article.

    Returns void

url

  • get url(): undefined | string

  • Getter for the article's URL.

    Returns undefined | string

    • The article's URL if available, otherwise undefined.
  • set url(url: undefined | string): void

  • Setter for the article's URL.

    Parameters

    • url: undefined | string

      The URL to set for the article.

    Returns void

verifierPubkey

Methods

addAmount

addPerk

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

delete

  • delete(reason?: string, publish?: boolean): Promise<NDKEvent>

  • Generates a deletion event of the current event

    Parameters

    • Optionalreason: string

      The reason for the deletion

    • publish: boolean = true

      Whether to publish the deletion event automatically

    Returns Promise<NDKEvent>

    The deletion event

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 content tags for the article.

    This method first checks and sets the publication date if not available, and then generates content tags based on the base NDKEvent class.

    Returns Promise<ContentTag>

    • The generated content tags.

getMatchingTags

hasTag

  • hasTag(tagName: string, marker?: string): boolean

  • Check if the event has a tag with the given name

    Parameters

    • tagName: string
    • Optionalmarker: string

    Returns boolean

muted

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

    • OptionalrelaySet: NDKRelaySet

      {NDKRelaySet} The relaySet to publish the even to.

    • OptionaltimeoutMs: number
    • OptionalrequiredRelayCount: 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.

publishReplaceable

rawEvent

react

referenceTags

  • referenceTags(marker?: string, skipAuthorTag?: boolean, forceTag?: string): NDKTag[]

  • Get the tags that can be used to reference this event from another event

    Parameters

    • Optionalmarker: string

      The marker to use in the tag

    • OptionalskipAuthorTag: boolean

      Whether to explicitly skip adding the author tag of the event

    • OptionalforceTag: 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"]]

removeTag

  • removeTag(tagName: string | string[]): void

  • Remove all tags with the given name (e.g. "d", "a", "p")

    Parameters

    • tagName: string | string[]

      Tag name(s) to search for and remove

    Returns void

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.

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

    • Optionalsigner: NDKSigner

      {NDKSigner} The NDKSigner to use to sign the event

    Returns Promise<string>

    A Promise that resolves to the signature of the signed event.

tag

  • tag(target: NDKEvent | NDKUser | NDKTag, marker?: string, skipAuthorTag?: boolean, forceTag?: string): void

  • Tag a user with an optional marker.

    Parameters

    • target: NDKEvent | NDKUser | NDKTag

      What is to be tagged. Can be an NDKUser, NDKEvent, or an NDKTag.

    • Optionalmarker: string

      The marker to use in the tag.

    • OptionalskipAuthorTag: boolean

      Whether to explicitly skip adding the author tag of the event.

    • OptionalforceTag: 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"]]

tagAddress

tagExternal

  • tagExternal(entity: string, type: NIP73EntityType, markerUrl?: string): void

  • NIP-73 tagging of external entities

    Parameters

    • entity: string

      to be tagged

    • type: NIP73EntityType

      of the entity

    • OptionalmarkerUrl: string

      to be used as the marker URL

    Returns void

    Example

    event.tagExternal("https://example.com/article/123#nostr", "url");
    event.tags => [["i", "https://example.com/123"], ["k", "https://example.com"]]

    Example: tag a podcast:item:guid

    event.tagExternal("e32b4890-b9ea-4aef-a0bf-54b787833dc5", "podcast:item:guid");
    event.tags => [["i", "podcast:item:guid:e32b4890-b9ea-4aef-a0bf-54b787833dc5"], ["k", "podcast:item:guid"]]

    See

    https://github.com/nostr-protocol/nips/blob/master/73.md

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

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

    • Optionalmarker: 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"

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

toNostrEvent

  • toNostrEvent(pubkey?: string): Promise<NostrEvent>

  • Return a NostrEvent object, trying to fill in missing fields when possible, adding tags when necessary.

    Parameters

    • Optionalpubkey: string

      {string} The pubkey of the user who the event belongs to.

    Returns Promise<NostrEvent>

    A promise that resolves to a NostrEvent.

Staticdeserialize

Staticfrom

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods