Class NDKUser

constructor

• new NDKUser(opts: NDKUserParams): NDKUser

• Parameters

  • opts: NDKUserParams

  Returns NDKUser

follows

ndk

Readonlynip46Urls

Optionalprofile

ReadonlyrelayUrls

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, storeProfileEvent?: boolean): Promise<null | NDKUserProfile>

• Fetch a user's profile

  Parameters

  • Optionalopts: NDKSubscriptionOptions

    {NDKSubscriptionOptions} A set of NDKSubscriptionOptions
  • storeProfileEvent: boolean = false

    {boolean} Whether to store the profile event or not

  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
  • OptionalcurrentFollowList: 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

getZapConfiguration

• getZapConfiguration(ndk?: default): Promise<undefined | NDKLnUrlData>

• Retrieves the zapper this pubkey has designated as an issuer of zap receipts

  Parameters

  • Optionalndk: default

  Returns Promise<undefined | NDKLnUrlData>

getZapInfo

• getZapInfo(getAll?: boolean, methods?: NDKZapMethod[]): Promise<NDKZapMethodInfo[]>

• Gets NIP-57 and NIP-61 information that this user has signaled

  Parameters

  • getAll: boolean = true

    {boolean} Whether to get all zap info or just the first one
  • methods: NDKZapMethod[] = ...

  Returns Promise<NDKZapMethodInfo[]>

getZapperPubkey

• getZapperPubkey(): Promise<undefined | string>

• Fetches the zapper's pubkey for the zapped user

  Returns Promise<undefined | string>

  The zapper's pubkey if one can be found

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

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

unfollow

• unfollow(user: NDKUser, currentFollowList?: Set<NDKUser>, kind?: NDKKind): Promise<boolean | Set<NDKRelay>>

• Remove a follow from this user's contact list

  Parameters

  • user: NDKUser

    {NDKUser} The user to unfollow
  • OptionalcurrentFollowList: 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 | Set<NDKRelay>>

  The relays were the follow list was published or false if the user wasn't found

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, tags?: NDKTag[], signer?: NDKSigner): Promise<unknown>

• Zap a user

  Parameters

  • amount: number

    The amount to zap in millisatoshis
  • Optionalcomment: string

    A comment to add to the zap request
  • Optionaltags: NDKTag[]
  • Optionalsigner: NDKSigner

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

  Returns Promise<unknown>

StaticfromNip05

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