Class NostrConnectSigner

Implements

Nip07Interface

Constructors

constructor

new NostrConnectSigner(opts: NostrConnectSignerOptions): NostrConnectSigner
Parameters
- opts: NostrConnectSignerOptions
Returns NostrConnectSigner
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:165

Properties

`Protected`auths

auths: Set<string> = ...

`Protected`clientSecret

clientSecret: string = ...

A secret used when initiating a connection from the client side

isConnected

isConnected: boolean = false

Whether the signer is connected to the remote signer

`Protected`log

log: Debugger = ...

`Optional`nip04

nip04?: {
    decrypt: (
        pubkey: string,
        ciphertext: string,
    ) => string | Promise<string>;
    encrypt: (pubkey: string, plaintext: string) => string | Promise<string>;
}

`Optional`nip44

nip44?: {
    decrypt: (
        pubkey: string,
        ciphertext: string,
    ) => string | Promise<string>;
    encrypt: (pubkey: string, plaintext: string) => string | Promise<string>;
}

onAuth

onAuth: (url: string) => Promise<void> = defaultHandleAuth

A method for handling "auth" requests

`Protected` `Optional`pubkey

pubkey?: string

The users pubkey

`Protected`publishMethod

publishMethod: NostrPublishMethod

A method that is called when an event needs to be published

relays

relays: string[]

Relays to communicate over

`Optional`remote

remote?: string

The remote signer pubkey

`Protected` `Optional`req

req?: Unsubscribable

The currently active REQ subscription

`Protected`requests

requests: Map<string, Deferred<any>> = ...

signer

signer: SimpleSigner

The local client signer

`Protected`subscriptionMethod

subscriptionMethod: NostrSubscriptionMethod

The active nostr subscription

`Protected`subscriptionOpen

subscriptionOpen: boolean = false

verifyEvent

verifyEvent: (event: Event) => event is VerifiedEvent = verifyEvent

`Static`publishMethod

publishMethod: undefined | NostrPublishMethod = undefined

A fallback method to use for publishMethod if none is pass in when creating the signer

`Static`subscriptionMethod

subscriptionMethod: undefined | NostrSubscriptionMethod = undefined

A fallback method to use for subscriptionMethod if none is pass in when creating the signer

Accessors

clientPubkey

get clientPubkey(): string
Client pubkey

Returns string
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:135

Methods

close

close(): Promise<void>
Close the connection

Returns Promise<void>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:217

connect

connect(secret?: string, permissions?: string[]): Promise<"ack">
Connect to remote signer
Parameters
- Optionalsecret: string
- Optionalpermissions: string[]
Returns Promise<"ack">
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:309

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>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:343

`Protected`createRequestEvent

createRequestEvent(
    content: string,
    target?: undefined | string,
    kind?: number,
): Promise<VerifiedEvent>
Parameters
- content: string
- target: undefined | string = ...
- kind: number = kinds.NostrConnect
Returns Promise<VerifiedEvent>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:275

getNostrConnectURI

getNostrConnectURI(metadata?: NostrConnectAppMetadata): string
Returns the nostrconnect:// URI for this signer
Parameters
- Optionalmetadata: NostrConnectAppMetadata
Returns string
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:418

getPublicKey

getPublicKey(): Promise<string>
Get the users pubkey

Returns Promise<string>
Implementation of Nip07Interface.getPublicKey
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:372

handleEvent

handleEvent(event: Event): Promise<void>
Call this method with incoming events
Parameters
- event: Event
Returns Promise<void>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:228

nip04Decrypt

nip04Decrypt(pubkey: string, ciphertext: string): Promise<string>
Parameters
- pubkey: string
- ciphertext: string
Returns Promise<string>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:392

nip04Encrypt

nip04Encrypt(pubkey: string, plaintext: string): Promise<string>
Parameters
- pubkey: string
- plaintext: string
Returns Promise<string>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:388

nip44Decrypt

nip44Decrypt(pubkey: string, ciphertext: string): Promise<string>
Parameters
- pubkey: string
- ciphertext: string
Returns Promise<string>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:407

nip44Encrypt

nip44Encrypt(pubkey: string, plaintext: string): Promise<string>
Parameters
- pubkey: string
- plaintext: string
Returns Promise<string>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:403

open

open(): Promise<void>
Open the connection

Returns Promise<void>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:197

requireConnection

requireConnection(): Promise<void>
Ensure the signer is connected to the remote signer

Returns Promise<void>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:367

signEvent

signEvent(template: EventTemplate & { pubkey?: string }): Promise<VerifiedEvent>
Request to sign an event
Parameters
- template: EventTemplate & { pubkey?: string }
Returns Promise<VerifiedEvent>
Implementation of Nip07Interface.signEvent
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:379

waitForSigner

waitForSigner(): Promise<void>
Wait for a remote signer to connect

Returns Promise<void>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:334

`Static`buildSigningPermissions

buildSigningPermissions(kinds: number[]): string[]
Builds an array of signing permissions for event kinds
Parameters
- kinds: number[]
Returns string[]
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:448

`Static`fromBunkerURI

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>
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:453

`Static`parseBunkerURI

parseBunkerURI(
uri: string,
): { relays: string[]; remote: string; secret?: string }
Parses a bunker:// URI
Parameters
- uri: string
Returns { relays: string[]; remote: string; secret?: string }
- Defined in packages/signers/src/signers/nostr-connect-signer.ts:433

Class NostrConnectSigner

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NostrConnectSigner

Properties

Protectedauths

ProtectedclientSecret

isConnected

Protectedlog

Optionalnip04

Optionalnip44

onAuth

Protected Optionalpubkey

ProtectedpublishMethod

relays

Optionalremote

Protected Optionalreq

Protectedrequests

signer

ProtectedsubscriptionMethod

ProtectedsubscriptionOpen

verifyEvent

StaticpublishMethod

StaticsubscriptionMethod

Accessors

clientPubkey

Returns string

Methods

close

Returns Promise<void>

connect

Parameters

Returns Promise<"ack">

createAccount

Parameters

Returns Promise<string>

ProtectedcreateRequestEvent

Parameters

Returns Promise<VerifiedEvent>

getNostrConnectURI

Parameters

Returns string

getPublicKey

Returns Promise<string>

handleEvent

Parameters

Returns Promise<void>

nip04Decrypt

Parameters

Returns Promise<string>

nip04Encrypt

Parameters

Returns Promise<string>

nip44Decrypt

Parameters

Returns Promise<string>

nip44Encrypt

Parameters

Returns Promise<string>

open

Returns Promise<void>

requireConnection

Returns Promise<void>

signEvent

Parameters

Returns Promise<VerifiedEvent>

waitForSigner

Returns Promise<void>

StaticbuildSigningPermissions

Parameters

Returns string[]

StaticfromBunkerURI

Parameters

`Protected`auths

`Protected`clientSecret

`Protected`log

`Optional`nip04

`Optional`nip44

`Protected` `Optional`pubkey

`Protected`publishMethod

`Optional`remote

`Protected` `Optional`req

`Protected`requests

`Protected`subscriptionMethod

`Protected`subscriptionOpen

`Static`publishMethod

`Static`subscriptionMethod

`Protected`createRequestEvent

`Static`buildSigningPermissions

`Static`fromBunkerURI

`Static`parseBunkerURI