Class NDKUser

constructor

• new NDKUser(opts: NDKUserParams): NDKUser

• Parameters

  • opts: NDKUserParams

  Returns NDKUser

follows

ndk

Readonly nip46Urls

Optional profile

Readonly relayUrls

hexpubkey

• get hexpubkey(): string

• Get the user's hexpubkey

  Returns string

  The user's hexpubkey

  Deprecated

  Use pubkey instead

• set hexpubkey(pubkey: string): void

• Set the user's hexpubkey

  Parameters

  • pubkey: string

    {Hexpubkey} The user's hexpubkey

  Returns void

  Deprecated

  Use pubkey instead

npub

• get npub(): string

• Returns string

• set npub(npub: string): void

• Parameters

  • npub: string

  Returns void

pubkey

• get pubkey(): string

• Get the user's pubkey

  Returns string

  The user's pubkey
• set pubkey(pubkey: string): void

• Set the user's pubkey

  Parameters

  • pubkey: string

    {string} The user's pubkey

  Returns void

fetchProfile

• fetchProfile(opts?: NDKSubscriptionOptions): Promise<null | NDKUserProfile>

• Fetch a user's profile

  Parameters

  • Optional opts: NDKSubscriptionOptions

    {NDKSubscriptionOptions} A set of NDKSubscriptionOptions

  Returns Promise<null | NDKUserProfile>

  User Profile

follow

• follow(newFollow: NDKUser, currentFollowList?: Set<NDKUser>, kind?: NDKKind): Promise<boolean>

• Add a follow to this user's contact list

  Parameters

  • newFollow: NDKUser

    {NDKUser} The user to follow

  • Optional currentFollowList: Set<NDKUser>

    {Set} The current follow list

  • kind: NDKKind = NDKKind.Contacts

    {NDKKind} The kind to use for this contact list (defaults to 3)

  Returns Promise<boolean>

  True if the follow was added, false if the follow already exists

publish

• publish(): Promise<void>

• Publishes the current profile.

  Returns Promise<void>

referenceTags

• referenceTags(marker?: string): NDKTag[]

• Get the tags that can be used to reference this user in an event

  Parameters

  • Optional marker: string

  Returns NDKTag[]

  an array of NDKTag

tagReference

• tagReference(): NDKTag

• Get the tag that can be used to reference this user in an event

  Returns NDKTag

  an NDKTag

validateNip05

• validateNip05(nip05Id: string): Promise<null | boolean>

• Validate a user's NIP-05 identifier (usually fetched from their kind:0 profile data)

  Parameters

  • nip05Id: string

    The NIP-05 string to validate

  Returns Promise<null | boolean>

  True if the NIP-05 is found and matches this user's pubkey, False if the NIP-05 is found but doesn't match this user's pubkey, null if the NIP-05 isn't found on the domain or we're unable to verify (because of network issues, etc.)

zap

• zap(amount: number, comment?: string, extraTags?: NDKTag[], signer?: NDKSigner): Promise<null | string>

• Zap a user

  Parameters

  • amount: number

    The amount to zap in millisatoshis

  • Optional comment: string

    A comment to add to the zap request

  • Optional extraTags: NDKTag[]

    Extra tags to add to the zap request

  • Optional signer: NDKSigner

    The signer to use (will default to the NDK instance's signer)

  Returns Promise<null | string>

Static fromNip05

• fromNip05(nip05Id: string, ndk?: default, skipCache?: boolean): Promise<undefined | NDKUser>

• Instantiate an NDKUser from a NIP-05 string

  Parameters

  • nip05Id: string

    {string} The user's NIP-05

  • Optional ndk: default

    {NDK} An NDK instance

  • skipCache: boolean = false

    {boolean} Whether to skip the cache or not

  Returns Promise<undefined | NDKUser>

  An NDKUser if one is found for the given NIP-05, undefined otherwise.