AppleSauce
    Preparing search index...
    Index

    Constructors

    Properties

    defaultTimeout: number

    Default timeout for requests

    encryption$: Observable<WalletConnectEncryptionMethod>

    The preferred encryption method for the wallet

    events$: Observable<Event>

    Shared observable for all wallet response events and notifications

    notifications$: Observable<WalletNotification>

    Shared observable for all wallet notifications

    publishMethod: NostrPublishMethod

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

    relays: string[]

    The relays to use for the connection

    secret: Uint8Array

    The local client signer

    service: string

    The wallet service public key

    signer: EventSigner
    subscriptionMethod: NostrSubscriptionMethod

    The active nostr subscription method

    support$: Observable<null | WalletSupport>

    Observable for wallet info updates

    publishMethod: undefined | NostrPublishMethod = undefined

    A fallback method to use for publishMethod if none is passed in when creating the client

    subscriptionMethod: undefined | NostrSubscriptionMethod = undefined

    A fallback method to use for subscriptionMethod if none is passed in when creating the client

    Methods

    • List transactions

      Parameters

      • Optionalparams: {
            from?: number;
            limit?: number;
            offset?: number;
            type?: "incoming" | "outgoing";
            unpaid?: boolean;
            until?: number;
        }

      Returns Promise<ListTransactionsResult>

    • Look up an invoice by payment hash or invoice string

      Parameters

      • Optionalpayment_hash: string
      • Optionalinvoice: string

      Returns Promise<Transaction>

    • Send a keysend payment

      Parameters

      • pubkey: string
      • amount: number
      • Optionalpreimage: string
      • Optionaltlv_records: { type: number; value: string }[]

      Returns Promise<PayKeysendResult>

    • Pay multiple lightning invoices

      Parameters

      • invoices: { amount?: number; id?: string; invoice: string }[]

      Returns Observable<PayInvoiceResult>

    • Send multiple keysend payments

      Parameters

      • keysends: {
            amount: number;
            id?: string;
            preimage?: string;
            pubkey: string;
            tlv_records?: { type: number; value: string }[];
        }[]

      Returns Promise<PayKeysendResult[]>