Class NDKPrivateKeySigner

constructor

• new NDKPrivateKeySigner(privateKey?: string | Uint8Array): NDKPrivateKeySigner

• Parameters

  • Optional privateKey: string | Uint8Array

  Returns NDKPrivateKeySigner

Optional _privateKey

privateKey

• get privateKey(): undefined | string

• Returns undefined | string

blockUntilReady

• blockUntilReady(): Promise<NDKUser>

• Blocks until the signer is ready and returns the associated NDKUser.

  Returns Promise<NDKUser>

  A promise that resolves to the NDKUser instance.

decrypt

• decrypt(sender: NDKUser, value: string): Promise<string>

• Decrypts the given value.

  Parameters

  • sender: NDKUser

  • value: string

  Returns Promise<string>

encrypt

• encrypt(recipient: NDKUser, value: string): Promise<string>

• Encrypts the given Nostr event for the given recipient.

  Parameters

  • recipient: NDKUser

    The recipient of the encrypted value.

  • value: string

    The value to be encrypted.

  Returns Promise<string>

sign

• sign(event: NostrEvent): Promise<string>

• Signs the given Nostr event.

  Parameters

  • event: NostrEvent

    The Nostr event to be signed.

  Returns Promise<string>

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

user

• user(): Promise<NDKUser>

• Getter for the user property.

  Returns Promise<NDKUser>

  A promise that resolves to the NDKUser instance.

Static generate

• generate(): NDKPrivateKeySigner

• Returns NDKPrivateKeySigner