Class NostrConnectSigner

Implements

Nip07Interface

Constructors

constructor

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

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

`Optional`onPublishEvent

onPublishEvent?: ((event: Event, relays: string[]) => Promise<void>)

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

`Optional`onSubClose

onSubClose?: (() => Promise<void>)

A method called when the subscription should be closed

`Optional`onSubOpen

onSubOpen?: ((filters: Filter[], relays: string[], onEvent: ((event: Event) => void)) => Promise<void>)

A method that is called when the subscription needs to be updated

`Protected` `Optional`pubkey

pubkey?: string

The users pubkey

relays

relays: string[]

Relays to communicate over

`Optional`remote

remote?: string

The remote signer pubkey

`Protected`requests

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

signer

signer: SimpleSigner

The local client signer

`Protected`subscriptionOpen

subscriptionOpen: boolean = false

verifyEvent

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

Accessors

clientPubkey

get clientPubkey(): string
Client pubkey

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

Methods

close

close(): Promise<void>
Close the connection

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

connect

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

createAccount

createAccount(username, domain, email?, permissions?): 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/signer/src/signers/nostr-connect-signer.ts:324

`Protected`createRequestEvent

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

getNostrConnectURI

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

getPublicKey

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

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

handleEvent

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

nip04Decrypt

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

nip04Encrypt

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

nip44Decrypt

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

nip44Encrypt

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

open

open(): Promise<void>
Open the connection

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

requireConnection

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

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

signEvent

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

waitForSigner

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

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

`Static`buildSigningPermissions

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

`Static`fromBunkerURI

fromBunkerURI(uri, options): Promise<NostrConnectSigner>
Create a NostrConnectSigner from a bunker:// URI
Parameters
- uri: string
- options: NostrConnectConnectionMethods & {
  permissions?: string[];
  signer?: SimpleSigner;
  }
Returns Promise<NostrConnectSigner>
- Defined in packages/signer/src/signers/nostr-connect-signer.ts:434

`Static`parseBunkerURI

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

Class NostrConnectSigner

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NostrConnectSigner

Properties

Protectedauths

ProtectedclientSecret

isConnected

Protectedlog

Optionalnip04

Optionalnip44

onAuth

OptionalonPublishEvent

OptionalonSubClose

OptionalonSubOpen

Protected Optionalpubkey

relays

Optionalremote

Protectedrequests

signer

ProtectedsubscriptionOpen

verifyEvent

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

Returns Promise<NostrConnectSigner>

StaticparseBunkerURI

`Protected`auths

`Protected`clientSecret

`Protected`log

`Optional`nip04

`Optional`nip44

`Optional`onPublishEvent

`Optional`onSubClose

`Optional`onSubOpen

`Protected` `Optional`pubkey

`Optional`remote

`Protected`requests

`Protected`subscriptionOpen

`Protected`createRequestEvent

`Static`buildSigningPermissions

`Static`fromBunkerURI

`Static`parseBunkerURI

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

`Optional`secret?: string