AppleSauce
    Preparing search index...

    Interface WalletServiceOptions<Methods>

    Options for creating a WalletService

    interface WalletServiceOptions<
        Methods extends TWalletMethod = CommonWalletMethods,
    > {
        client?: string;
        getInfo?: () => Promise<
            Partial<Omit<Helpers.WalletInfo, "methods" | "notifications">>,
        >;
        handlers: WalletServiceHandlers<Methods>;
        notifications?: NotificationType[];
        pool?: NostrPool;
        publishMethod?: NostrPublishMethod;
        relays: string[];
        secret?: Uint8Array<ArrayBufferLike>;
        signer: EventSigner;
        subscriptionMethod?: NostrSubscriptionMethod;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    client? getInfo? handlers notifications? pool? publishMethod? relays secret? signer subscriptionMethod?

    Properties

    client?: string

    The client's public key (used for restoring the service)

    getInfo?: () => Promise<
        Partial<Omit<Helpers.WalletInfo, "methods" | "notifications">>,
    >

    A method for getting the general wallet information (Can be overwritten if get_info is set in handlers)

    handlers: WalletServiceHandlers<Methods>

    Map of method handlers

    notifications?: NotificationType[]

    An array of notifications this wallet supports

    pool?: NostrPool

    An optional pool for connection methods

    publishMethod?: NostrPublishMethod

    An optional method for publishing events

    relays: string[]

    The relays to use for the service

    secret?: Uint8Array<ArrayBufferLike>

    The client's secret key

    signer: EventSigner

    The signer to use for creating and unlocking events

    subscriptionMethod?: NostrSubscriptionMethod

    An optional method for subscribing to relays

    Settings

    Member Visibility

    On This Page

    Properties