Applesauce
    Preparing search index...

    Class NostrConnectSigner

    Implements

    Index
    constructor
    auths autoSwitchRelays bunkerSecret? connectSecret isConnected listening log metadata? nip04? nip44? onAuth pubkey? publishMethod relays remote? req? requests signer subscriptionMethod switching timeout timers verifyEvent pool publishMethod subscriptionMethod
    clientPubkey secret
    close connect createAccount createRequestEvent getNbunksec getNostrConnectURI getPublicKey handleEvent logout nip04Decrypt nip04Encrypt nip44Decrypt nip44Encrypt open ping requireConnection signEvent startAutoSwitchRelays startRequestTimeout subscribe switchRelays waitForSigner buildSigningPermissions createNbunksec fromBunkerURI fromNbunksec parseBunkerURI parseNbunksec
    auths: Set<string> = ...
    autoSwitchRelays: boolean

    Whether to send a switch_relays request after connecting

    bunkerSecret?: string

    A secret used when connecting to a remote bunker (the secret in a bunker:// URI)

    connectSecret: string

    A secret used when initiating a connection from the client side (the secret in a nostrconnect:// URI)

    isConnected: boolean = false

    Whether the signer is connected to the remote signer

    listening: boolean = false

    Whether the signer is listening for events

    log: Debugger = ...
    metadata?: NostrConnectAppMetadata

    Client metadata sent with connect requests

    nip04?: {
        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
    }
    nip44?: {
        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
    }
    onAuth: (url: string) => Promise<void> = defaultHandleAuth

    A method for handling "auth" requests

    pubkey?: string

    The users pubkey

    publishMethod: NostrPublishMethod

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

    relays: string[]

    Relays to communicate over

    remote?: string

    The remote signer pubkey

    req?: Subscription

    The currently active REQ subscription

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

    The local client signer

    subscriptionMethod: NostrSubscriptionMethod

    The active nostr subscription

    switching: Promise<unknown> | null = null

    The in-flight automatic switch_relays request

    timeout: number

    Milliseconds to wait for a response before rejecting a request (0 to disable)

    timers: Map<string, number> = ...

    Timeout timers for pending requests

    verifyEvent: (event: NostrEvent) => event is VerifiedEvent = verifyEvent
    pool: NostrPool | undefined = undefined

    A fallback pool to use if none is pass in when creating the signer

    publishMethod: NostrPublishMethod | undefined = undefined

    A fallback method to use for publishMethod if none is pass in when creating the signer

    subscriptionMethod: NostrSubscriptionMethod | undefined = undefined

    A fallback method to use for subscriptionMethod if none is pass in when creating the signer

    • Request to create an account on the remote signer

      Parameters

      • username: string
      • domain: string
      • Optionalemail: string
      • Optionalpermissions: string[]

      Returns Promise<string>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods