Class NostrConnectSigner

constructor

• new NostrConnectSigner(opts: NostrConnectSignerOptions): NostrConnectSigner

  Parameters

  • opts: NostrConnectSignerOptions

  Returns NostrConnectSigner

isConnected

listening

Optionalnip04

Optionalnip44

onAuth

relays

Optionalremote

signer

verifyEvent

StaticpublishMethod

StaticsubscriptionMethod

clientPubkey

• get clientPubkey(): string

  Client pubkey

  Returns string

close

• close(): Promise<void>

  Close the connection

  Returns Promise<void>

connect

• connect(secret?: string, permissions?: string[]): Promise<"ack">

  Connect to remote signer

  Parameters

  • Optionalsecret: string
  • Optionalpermissions: string[]

  Returns Promise<"ack">

createAccount

• createAccount(
      username: string,
      domain: string,
      email?: string,
      permissions?: string[],
  ): Promise<string>

  Request to create an account on the remote signer

  Parameters

  • username: string
  • domain: string
  • Optionalemail: string
  • Optionalpermissions: string[]

  Returns Promise<string>

getNostrConnectURI

• getNostrConnectURI(metadata?: NostrConnectAppMetadata): string

  Returns the nostrconnect:// URI for this signer

  Parameters

  • Optionalmetadata: NostrConnectAppMetadata

  Returns string

getPublicKey

• getPublicKey(): Promise<string>

  Get the users pubkey

  Returns Promise<string>

handleEvent

• handleEvent(event: Event): Promise<void>

  Call this method with incoming events

  Parameters

  • event: Event

  Returns Promise<void>

nip04Decrypt

• nip04Decrypt(pubkey: string, ciphertext: string): Promise<string>

  Parameters

  • pubkey: string
  • ciphertext: string

  Returns Promise<string>

nip04Encrypt

• nip04Encrypt(pubkey: string, plaintext: string): Promise<string>

  Parameters

  • pubkey: string
  • plaintext: string

  Returns Promise<string>

nip44Decrypt

• nip44Decrypt(pubkey: string, ciphertext: string): Promise<string>

  Parameters

  • pubkey: string
  • ciphertext: string

  Returns Promise<string>

nip44Encrypt

• nip44Encrypt(pubkey: string, plaintext: string): Promise<string>

  Parameters

  • pubkey: string
  • plaintext: string

  Returns Promise<string>

open

• open(): Promise<void>

  Open the connection

  Returns Promise<void>

requireConnection

• requireConnection(): Promise<void>

  Ensure the signer is connected to the remote signer

  Returns Promise<void>

signEvent

• signEvent(template: EventTemplate & { pubkey?: string }): Promise<VerifiedEvent>

  Request to sign an event

  Parameters

  • template: EventTemplate & { pubkey?: string }

  Returns Promise<VerifiedEvent>

waitForSigner

• waitForSigner(abort?: AbortSignal): Promise<void>

  Wait for a remote signer to connect

  Parameters

  • Optionalabort: AbortSignal

  Returns Promise<void>

StaticbuildSigningPermissions

• buildSigningPermissions(kinds: number[]): string[]

  Builds an array of signing permissions for event kinds

  Parameters

  • kinds: number[]

  Returns string[]

StaticfromBunkerURI

• fromBunkerURI(
      uri: string,
      options?: Omit<NostrConnectSignerOptions, "relays"> & {
          permissions?: string[];
          signer?: SimpleSigner;
      },
  ): Promise<NostrConnectSigner>

  Create a NostrConnectSigner from a bunker:// URI

  Parameters

  • uri: string
  • Optionaloptions: Omit<NostrConnectSignerOptions, "relays"> & {
        permissions?: string[];
        signer?: SimpleSigner;
    }

  Returns Promise<NostrConnectSigner>

StaticparseBunkerURI

• parseBunkerURI(
      uri: string,
  ): { relays: string[]; remote: string; secret?: string }

  Parses a bunker:// URI

  Parameters

  • uri: string

  Returns { relays: string[]; remote: string; secret?: string }