Class NostrConnector

Class for Bitcoin wallet connections and operations

Hierarchy

  • EventEmitter
    • NostrConnector

Constructors

constructor

Properties

config connectedAddress connectedType DEFAULT_CONFIG manualKeyPair signatureCache

Methods

cleanup clearSignatureCache connectManual connectNostr connectWallet emit generateCredentials generatePassword getConnectedAddress getConnectedType isAvailable isNostrExtensionAvailable off on once removeAllListeners requestSignature setKeyPair setupEventListeners verifySignature

Constructors

constructor

Properties

Private Readonlyconfig

config: NostrConnectorConfig

PrivateconnectedAddress

connectedAddress: null | string = null

PrivateconnectedType

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

Private ReadonlyDEFAULT_CONFIG

DEFAULT_CONFIG: NostrConnectorConfig = ...

PrivatemanualKeyPair

manualKeyPair: null | NostrConnectorKeyPair = null

Private ReadonlysignatureCache

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

Methods

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

PrivateconnectManual

  • connectManual(): Promise<ConnectionResult>

    Set up manual key pair for connection

    Returns Promise<ConnectionResult>

PrivateconnectNostr

  • 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

generateCredentials

  • generateCredentials(
        address: string,
        signature: string,
        message: string,
    ): Promise<
        {
            key: {
                epriv: string;
                epub: string;
                priv: string;
                pub: string;
                secp256k1Bitcoin: {
                    address: string;
                    privateKey: string;
                    publicKey: string;
                };
                secp256k1Ethereum: {
                    address: string;
                    privateKey: string;
                    publicKey: string;
                };
            };
            message: string;
            signature: string;
            username: string;
        },
    >

    Generate credentials using Nostr: username deterministico e chiave GunDB derivata dall'address

    Parameters

    • address: string
    • signature: string
    • message: string

    Returns Promise<
        {
            key: {
                epriv: string;
                epub: string;
                priv: string;
                pub: string;
                secp256k1Bitcoin: {
                    address: string;
                    privateKey: string;
                    publicKey: string;
                };
                secp256k1Ethereum: {
                    address: string;
                    privateKey: string;
                    publicKey: string;
                };
            };
            message: string;
            signature: string;
            username: string;
        },
    >

generatePassword

  • generatePassword(signature: string): Promise<string>

    Generate a password from a signature

    Parameters

    • signature: string

    Returns Promise<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

on

  • on(event: EventType, listener: (data: unknown) => void): void

    Registers an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

once

  • once(event: EventType, listener: (data: unknown) => void): void

    Registers a one-time event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

removeAllListeners

  • removeAllListeners(event?: EventType): void

    Removes all listeners for an event or all events

    Parameters

    • Optionalevent: EventType

    Returns void

requestSignature

  • requestSignature(address: string, message: string): Promise<string>

    Request a signature from the connected wallet

    Parameters

    • address: string
    • message: string

    Returns Promise<string>

setKeyPair

PrivatesetupEventListeners

  • setupEventListeners(): void

    Setup event listeners

    Returns void

verifySignature

  • verifySignature(
        message: string,
        signature: string,
        address: any,
    ): Promise<boolean>

    Verify a signature

    Parameters

    • message: string
    • signature: string
    • address: any

    Returns Promise<boolean>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods