Class NostrConnector

Class for Bitcoin wallet connections and operations

Hierarchy

EventEmitter
- NostrConnector

Constructors

constructor

new NostrConnector(config?: Partial<NostrConnectorConfig>): NostrConnector
Parameters
- config: Partial<NostrConnectorConfig> = {}
Returns NostrConnector
Overrides EventEmitter.constructor

Properties

`Private` `Readonly`config

config: NostrConnectorConfig

`Private`connectedAddress

connectedAddress: null | string = null

`Private`connectedType

connectedType: null | "nostr" | "alby" | "manual" = null

`Private` `Readonly`DEFAULT_CONFIG

DEFAULT_CONFIG: NostrConnectorConfig = ...

`Private`manualKeyPair

manualKeyPair: null | NostrConnectorKeyPair = null

`Private` `Readonly`MESSAGE_TO_SIGN

MESSAGE_TO_SIGN: "I Love Shogun!"

`Private` `Readonly`signatureCache

signatureCache: Map<string, SignatureCache> = ...

Methods

`Private`cacheSignature

cacheSignature(address: string, signature: string): void
Cache signature
Parameters
- address: string
- signature: string
Returns void

cleanup

cleanup(): void
Cleanup event listeners

Returns void

clearSignatureCache

clearSignatureCache(address?: string): void
Clear signature cache for a specific address or all addresses
Parameters
- Optionaladdress: string
Returns void

`Private`connectManual

connectManual(): Promise<ConnectionResult>
Set up manual key pair for connection

Returns Promise<ConnectionResult>

`Private`connectNostr

connectNostr(): Promise<ConnectionResult>
Connect to Nostr extension

Returns Promise<ConnectionResult>

connectWallet

connectWallet(type?: "nostr" | "alby" | "manual"): Promise<ConnectionResult>
Connect to a wallet type
Parameters
- type: "nostr" | "alby" | "manual" = "nostr"
Returns Promise<ConnectionResult>

emit

emit(event: EventType, data?: unknown): boolean
Emits an event with arguments
Parameters
- event: EventType
- Optionaldata: unknown
Returns boolean
Inherited from EventEmitter.emit

generateCredentials

generateCredentials(address: string): Promise<NostrConnectorCredentials>
Generate credentials using the connected wallet
Parameters
- address: string
Returns Promise<NostrConnectorCredentials>

`Private`generateCredentialsFromSignature

generateCredentialsFromSignature(
address: string,
signature: string,
): Promise<NostrConnectorCredentials>
Generate credentials from an existing signature
Parameters
- address: string
- signature: string
Returns Promise<NostrConnectorCredentials>

`Private`generateDeterministicSignature

generateDeterministicSignature(address: string): Promise<string>
Generate a deterministic signature for consistent authentication
Parameters
- address: string
Returns Promise<string>

generatePassword

generatePassword(signature: string): Promise<string>
Generate a password from a signature
Parameters
- signature: string
Returns Promise<string>

`Private`getCachedSignature

getCachedSignature(address: string): null | string
Get cached signature if valid
Parameters
- address: string
Returns null | string

getConnectedAddress

getConnectedAddress(): null | string
Get the currently connected address

Returns null | string

getConnectedType

getConnectedType(): null | "nostr" | "alby" | "manual"
Get the currently connected wallet type

Returns null | "nostr" | "alby" | "manual"

isAvailable

isAvailable(): boolean
Check if any Bitcoin wallet is available

Returns boolean

isNostrExtensionAvailable

isNostrExtensionAvailable(): boolean
Check if Nostr extension is available

Returns boolean

off

off(event: EventType, listener: (data: unknown) => void): void
Removes an event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from EventEmitter.off

on

on(event: EventType, listener: (data: unknown) => void): void
Registers an event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from EventEmitter.on

once

once(event: EventType, listener: (data: unknown) => void): void
Registers a one-time event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from EventEmitter.once

removeAllListeners

removeAllListeners(event?: EventType): void
Removes all listeners for an event or all events
Parameters
- Optionalevent: EventType
Returns void
Inherited from EventEmitter.removeAllListeners

`Private`requestSignature

requestSignature(address: string, message: string): Promise<string>
Request a signature from the connected wallet
Parameters
- address: string
- message: string
Returns Promise<string>

`Private`requestSignatureWithTimeout

requestSignatureWithTimeout(
    address: string,
    message: string,
    timeout?: number,
): Promise<string>
Request signature with timeout
Parameters
- address: string
- message: string
- timeout: number = 30000
Returns Promise<string>

setKeyPair

setKeyPair(keyPair: NostrConnectorKeyPair): void
Set a manual key pair for use
Parameters
- keyPair: NostrConnectorKeyPair
Returns void

`Private`setupEventListeners

setupEventListeners(): void
Setup event listeners

Returns void

`Private`validateAddress

validateAddress(address: undefined | null | string): string
Validates that the address is valid
Parameters
- address: undefined | null | string
Returns string

verifySignature

verifySignature(
    message: string,
    signature: string,
    address: any,
): Promise<boolean>
Verify a signature
Parameters
- message: string
- signature: string
- address: any
Returns Promise<boolean>