AppleSauce
    Preparing search index...

    Class NostrConnectSigner

    Implements

    Index

    Constructors

    constructor

    Properties

    auths isConnected listening log nip04? nip44? onAuth pubkey? publishMethod relays remote? req? requests secret signer subscriptionMethod verifyEvent pool publishMethod subscriptionMethod

    Accessors

    clientPubkey

    Methods

    close connect createAccount createRequestEvent getNostrConnectURI getPublicKey handleEvent nip04Decrypt nip04Encrypt nip44Decrypt nip44Encrypt open requireConnection signEvent waitForSigner buildSigningPermissions fromBunkerURI parseBunkerURI

    Constructors

    Properties

    auths: Set<string> = ...
    isConnected: boolean = false

    Whether the signer is connected to the remote signer

    listening: boolean = false

    Whether the signer is listening for events

    log: Debugger = ...
    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>> = ...
    secret: string

    A secret used when initiating a connection from the client side

    signer: SimpleSigner

    The local client signer

    subscriptionMethod: NostrSubscriptionMethod

    The active nostr subscription

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

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

    publishMethod: undefined | NostrPublishMethod = undefined

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

    subscriptionMethod: undefined | NostrSubscriptionMethod = undefined

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

    Accessors

    Methods

    • 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