Class NostrSigner

Class representing a Nostr signer that extends SignerNostr

Hierarchy (view full)

SignerNostr
- NostrSigner

Index

Constructors

Methods

connect disconnect isConnected getNostrPublicKey signNostrEvent

Constructors

constructor

new NostrSigner(client, name, icon, _appUri?, connectionsRepo?): NostrSigner
Creates an instance of NostrSigner.
Parameters
- client: Client
  The client instance.
- name: string
  The name of the signer.
- icon: string
  The icon URL of the signer.
- Optional_appUri: string
  The application URI.
- connectionsRepo: ConnectionsRepo = ...
  The connections repository.
Returns NostrSigner
Overrides SignerNostr.constructor
- Defined in nostr/index.ts:38

Methods

connect

connect(): Promise<void>
Connects to the provider by requesting authentication.

Returns Promise<void>
A promise that resolves when the connection is established.
Overrides SignerNostr.connect
- Defined in nostr/index.ts:70

disconnect

disconnect(): Promise<void>
Disconnects to the signer.

Returns Promise<void>
A promise that resolves when the signer is disconnected.
Overrides SignerNostr.disconnect
- Defined in nostr/index.ts:85

isConnected

isConnected(): Promise<boolean>
Checks if the signer is connected.

Returns Promise<boolean>
A promise that resolves to true if connected, false otherwise.
Overrides SignerNostr.isConnected
- Defined in nostr/index.ts:96

getNostrPublicKey

getNostrPublicKey(): Promise<`0x${string}`>
Gets the Nostr public key associated with the signer.

Returns Promise<`0x${string}`>
A promise that resolves to a string representing the Nostr public key.
Overrides SignerNostr.getNostrPublicKey
- Defined in nostr/index.ts:105

signNostrEvent

signNostrEvent(event): Promise<Required<NostrEvent>>
Sign a nostr event.
Parameters
- event: NostrEvent
Returns Promise<Required<NostrEvent>>
A promise that resolves to the signed event.
Overrides SignerNostr.signNostrEvent
- Defined in nostr/index.ts:109