Class NDKPrivateKeySigner

Interface for NDK signers.

Implements

NDKSigner

Index

Constructors

Properties

Accessors

Methods

blockUntilReady decrypt encrypt nip04Decrypt nip04Encrypt nip44Decrypt nip44Encrypt sign user generate

Constructors

constructor

new NDKPrivateKeySigner(privateKey?: string | Uint8Array): NDKPrivateKeySigner
Parameters
- OptionalprivateKey: string | Uint8Array
Returns NDKPrivateKeySigner
- Defined in ndk/src/signers/private-key/index.ts:14

Properties

`Optional`_privateKey

_privateKey?: Uint8Array

Accessors

privateKey

get privateKey(): undefined | string
Returns undefined | string
- Defined in ndk/src/signers/private-key/index.ts:41

Methods

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.
Implementation of NDKSigner.blockUntilReady
- Defined in ndk/src/signers/private-key/index.ts:51

decrypt

decrypt(sender: NDKUser, value: string, type?: ENCRYPTION_SCHEMES): Promise<string>
This method is deprecated and will be removed in a future release, for compatibility this function calls nip04Decrypt.
Parameters
- sender: NDKUser
- value: string
- type: ENCRYPTION_SCHEMES = DEFAULT_ENCRYPTION_SCHEME
Returns Promise<string>
Implementation of NDKSigner.decrypt
- Defined in ndk/src/signers/private-key/index.ts:110

encrypt

encrypt(recipient: NDKUser, value: string, type?: ENCRYPTION_SCHEMES): Promise<string>
This method is deprecated and will be removed in a future release, for compatibility this function calls nip04Encrypt.
Parameters
- recipient: NDKUser
- value: string
- type: ENCRYPTION_SCHEMES = DEFAULT_ENCRYPTION_SCHEME
Returns Promise<string>
Implementation of NDKSigner.encrypt
- Defined in ndk/src/signers/private-key/index.ts:94

nip04Decrypt

nip04Decrypt(sender: NDKUser, value: string): Promise<string>
Parameters
- sender: NDKUser
- value: string
Returns Promise<string>
Deprecated
use nip44Decrypt instead
Implementation of NDKSigner.nip04Decrypt
- Defined in ndk/src/signers/private-key/index.ts:131

nip04Encrypt

nip04Encrypt(recipient: NDKUser, value: string): Promise<string>
Parameters
- recipient: NDKUser
- value: string
Returns Promise<string>
Deprecated
use nip44Encrypt instead
Implementation of NDKSigner.nip04Encrypt
- Defined in ndk/src/signers/private-key/index.ts:122

nip44Decrypt

nip44Decrypt(sender: NDKUser, value: string): Promise<string>
Parameters
- sender: NDKUser
- value: string
Returns Promise<string>
Deprecated
use nip44Decrypt instead
Implementation of NDKSigner.nip44Decrypt
- Defined in ndk/src/signers/private-key/index.ts:85

nip44Encrypt

nip44Encrypt(recipient: NDKUser, value: string): Promise<string>
Parameters
- recipient: NDKUser
- value: string
Returns Promise<string>
Deprecated
use nip44Encrypt instead
Implementation of NDKSigner.nip44Encrypt
- Defined in ndk/src/signers/private-key/index.ts:80

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.
Implementation of NDKSigner.sign
- Defined in ndk/src/signers/private-key/index.ts:63

user

user(): Promise<NDKUser>
Getter for the user property.

Returns Promise<NDKUser>
A promise that resolves to the NDKUser instance.
Implementation of NDKSigner.user
- Defined in ndk/src/signers/private-key/index.ts:58

`Static`generate

generate(): NDKPrivateKeySigner
Returns NDKPrivateKeySigner
- Defined in ndk/src/signers/private-key/index.ts:46