Class NDKNip46Signer

This NDKSigner implements NIP-46, which allows remote signing of events. This class is meant to be used client-side, paired with the NDKNip46Backend or a NIP-46 backend (like Nostr-Connect)

Emits

authUrl -- Emitted when the user should take an action in certain URL. When a client receives this event, it should direct the user to go to that URL to authorize the application.

Example

const ndk = new NDK()
const nip05 = await prompt("enter your nip-05") // Get a NIP-05 the user wants to login with
const privateKey = localStorage.getItem("nip46-local-key") // If we have a private key previously saved, use it
const signer = new NDKNip46Signer(ndk, nip05, privateKey) // Create a signer with (or without) a private key

// Save generated private key for future use
localStorage.setItem("nip46-local-key", signer.localSigner.privateKey)

// If the backend sends an auth_url event, open that URL as a popup so the user can authorize the app
signer.on("authUrl", (url) => { window.open(url, "auth", "width=600,height=600") })

// wait until the signer is ready
const loggedinUser = await signer.blockUntilReady()

alert("You are now logged in as " + loggedinUser.npub)

Hierarchy

EventEmitter
- NDKNip46Signer

Implements

NDKSigner

Index

Constructors

constructor

new NDKNip46Signer(ndk: default, token: string, localSigner?: NDKSigner): NDKNip46Signer
Parameters
- ndk: default
  
  The NDK instance to use
- token: string
  
  connection token, in the form "npub#otp"
- Optional localSigner: NDKSigner
  
  The signer that will be used to request events to be signed
Returns NDKNip46Signer
Overrides EventEmitter.constructor
- Defined in ndk/src/signers/nip46/index.ts:52
new NDKNip46Signer(ndk: default, remoteNpub: string, localSigner?: NDKSigner): NDKNip46Signer
Parameters
- ndk: default
  
  The NDK instance to use
- remoteNpub: string
  
  The npub that wants to be published as
- Optional localSigner: NDKSigner
  
  The signer that will be used to request events to be signed
Returns NDKNip46Signer
Overrides EventEmitter.constructor
- Defined in ndk/src/signers/nip46/index.ts:59
new NDKNip46Signer(ndk: default, remoteNip05: string, localSigner?: NDKSigner): NDKNip46Signer
Parameters
- ndk: default
  
  The NDK instance to use
- remoteNip05: string
  
  The nip05 that wants to be published as
- Optional localSigner: NDKSigner
  
  The signer that will be used to request events to be signed
Returns NDKNip46Signer
Overrides EventEmitter.constructor
- Defined in ndk/src/signers/nip46/index.ts:66
new NDKNip46Signer(ndk: default, remotePubkey: string, localSigner?: NDKSigner): NDKNip46Signer
Parameters
- ndk: default
  
  The NDK instance to use
- remotePubkey: string
  
  The public key of the npub that wants to be published as
- Optional localSigner: NDKSigner
  
  The signer that will be used to request events to be signed
Returns NDKNip46Signer
Overrides EventEmitter.constructor
- Defined in ndk/src/signers/nip46/index.ts:73

Properties

localSigner

localSigner: NDKSigner

relayUrls

relayUrls: string[] = []

remotePubkey

remotePubkey: undefined | string

remoteUser

remoteUser: NDKUser

rpc

rpc: NDKNostrRpc

token

token: undefined | string

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/nip46/index.ts:134

createAccount

createAccount(username?: string, domain?: string, email?: string): Promise<string>
Allows creating a new account on the remote server.
Parameters
- Optional username: string
  
  Desired username for the NIP-05
- Optional domain: string
  
  Desired domain for the NIP-05
- Optional email: string
  
  Email address to associate with this account -- Remote servers may use this for recovery
Returns Promise<string>
The public key of the newly created account
- Defined in ndk/src/signers/nip46/index.ts:256

decrypt

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

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>
Implementation of NDKSigner.encrypt
- Defined in ndk/src/signers/nip46/index.ts:180

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/nip46/index.ts:225

user

user(): Promise<NDKUser>
Get the user that is being published as

Returns Promise<NDKUser>
Implementation of NDKSigner.user
- Defined in ndk/src/signers/nip46/index.ts:130

Class NDKNip46Signer

Emits

Example

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ndk: default

token: string

Optional localSigner: NDKSigner

Returns NDKNip46Signer

Parameters

ndk: default

remoteNpub: string

Optional localSigner: NDKSigner

Returns NDKNip46Signer

Parameters

ndk: default

remoteNip05: string

Optional localSigner: NDKSigner

Returns NDKNip46Signer

Parameters

ndk: default

remotePubkey: string

Optional localSigner: NDKSigner

Returns NDKNip46Signer

Properties

localSigner

relayUrls

remotePubkey

remoteUser

rpc

token

Methods

blockUntilReady

Returns Promise<NDKUser>

createAccount

Parameters

Optional username: string

Optional domain: string

Optional email: string

Returns Promise<string>

decrypt

Parameters

sender: NDKUser

value: string

Returns Promise<string>

encrypt

Parameters

recipient: NDKUser

value: string

Returns Promise<string>

sign

Parameters

event: NostrEvent

Returns Promise<string>

user

Returns Promise<NDKUser>

Settings

Member Visibility

Theme

On This Page

`Optional` localSigner: NDKSigner

`Optional` localSigner: NDKSigner

`Optional` localSigner: NDKSigner

`Optional` localSigner: NDKSigner

`Optional` username: string

`Optional` domain: string

`Optional` email: string