Class NostrConnectSigner

Implements

Nip07Interface

Index

Constructors

constructor

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

Properties

`Protected`auths

auths: Set<string> = ...

handleAuth

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

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>);
}

`Protected`pool

pool: IConnectionPool

`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>> = ...

`Protected`signer

signer: SimpleSigner

The local client signer

`Protected`sub

sub: MultiSubscription

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:103

Methods

close

close(): void
Close the connection

Returns void
- Defined in packages/signer/src/signers/nostr-connect-signer.ts:162

connect

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

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:279

`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:216

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:308

`Protected`handleEvent

handleEvent(event): Promise<void>
Parameters
- event: Event
Returns Promise<void>
- Defined in packages/signer/src/signers/nostr-connect-signer.ts:170

nip04Decrypt

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

nip04Encrypt

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

nip44Decrypt

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

nip44Encrypt

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

open

open(): Promise<void>
Open the connection

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

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:303

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:315

toJSON

toJSON(): {
    client: string;
    pubkey: undefined | string;
    relays: string[];
    remote: undefined | string;
}
Returns {
    client: string;
    pubkey: undefined | string;
    relays: string[];
    remote: undefined | string;
}
- client: string
- pubkey: undefined | string
- relays: string[]
- remote: undefined | string
- Defined in packages/signer/src/signers/nostr-connect-signer.ts:375

waitForSigner

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

Returns Promise<"ack">
- Defined in packages/signer/src/signers/nostr-connect-signer.ts:271

`Static`buildSigningPermissions

buildSigningPermissions(kinds): string[]
Parameters
- kinds: number[]
Returns string[]
- Defined in packages/signer/src/signers/nostr-connect-signer.ts:353

`Static`fromBunkerURI

fromBunkerURI(uri, pool, permissions?): Promise<NostrConnectSigner>
Parameters
- uri: string
- pool: IConnectionPool
- Optionalpermissions: string[]
Returns Promise<NostrConnectSigner>
- Defined in packages/signer/src/signers/nostr-connect-signer.ts:357

`Static`fromJSON

fromJSON(pool, data): NostrConnectSigner
Parameters
- pool: IConnectionPool
- data: {
      client: string;
      pubkey: undefined | string;
      relays: string[];
      remote: undefined | string;
  }
  - client: string
  - pubkey: undefined | string
  - relays: string[]
  - remote: undefined | string
Returns NostrConnectSigner
- Defined in packages/signer/src/signers/nostr-connect-signer.ts:383

Class NostrConnectSigner

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NostrConnectSigner

Properties

Protectedauths

handleAuth

isConnected

Protectedlog

Optionalnip04

Optionalnip44

Protectedpool

Optionalpubkey

relays

Optionalremote

Protectedrequests

Protectedsigner

Protectedsub

verifyEvent

Accessors

clientPubkey

Returns string

Methods

close

Returns void

connect

Parameters

Returns Promise<"ack">

createAccount

Parameters

Returns Promise<string>

ProtectedcreateRequestEvent

Parameters

Returns Promise<VerifiedEvent>

getPublicKey

Returns Promise<string>

ProtectedhandleEvent

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>

toJSON

Returns { client: string; pubkey: undefined | string; relays: string[]; remote: undefined | string; }

client: string

pubkey: undefined | string

relays: string[]

remote: undefined | string

waitForSigner

Returns Promise<"ack">

StaticbuildSigningPermissions

Parameters

Returns string[]

StaticfromBunkerURI

Parameters

Returns Promise<NostrConnectSigner>

StaticfromJSON

`Protected`auths

`Protected`log

`Optional`nip04

`Optional`nip44

`Protected`pool

`Optional`pubkey

`Optional`remote

`Protected`requests

`Protected`signer

`Protected`sub

`Protected`createRequestEvent

`Protected`handleEvent

Returns {
client: string;
pubkey: undefined | string;
relays: string[];
remote: undefined | string;
}

`Static`buildSigningPermissions

`Static`fromBunkerURI

`Static`fromJSON