Interface NDKSigner

Interface for NDK signers.

Hierarchy

NDKSigner

Implemented by

Index

Methods

blockUntilReady decrypt encrypt relays? sign user

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.
- Defined in ndk/src/signers/index.ts:13

decrypt

decrypt(sender: NDKUser, value: string): Promise<string>
Decrypts the given value.
Parameters
- sender: NDKUser
- value: string
Returns Promise<string>
- Defined in ndk/src/signers/index.ts:45

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>
- Defined in ndk/src/signers/index.ts:39

`Optional` relays

relays(): Promise<NDKRelay[]>
Getter for the preferred relays.

Returns Promise<NDKRelay[]>
A promise containing a simple map of preferred relays and their read/write policies.
- Defined in ndk/src/signers/index.ts:32

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.
- Defined in ndk/src/signers/index.ts:26

user

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

Returns Promise<NDKUser>
A promise that resolves to the NDKUser instance.
- Defined in ndk/src/signers/index.ts:19

Generated using TypeDoc