Class WalletService<Methods>

NIP-47 Wallet Service implementation

Type Parameters

Methods extends TWalletMethod = CommonWalletMethods

Constructors

constructor

new WalletService<Methods extends TWalletMethod = CommonWalletMethods>(
options: WalletServiceOptions<Methods>,
): WalletService<Methods>
Type Parameters
- Methods extends TWalletMethod = CommonWalletMethods
Parameters
- options: WalletServiceOptions<Methods>
Returns WalletService<Methods>
- Defined in wallet-service.ts:121

Properties

client

client: string

The client's public key

`Protected`events$

events$: Observable<WalletRequestEvent> | null = null

Shared observable for all wallet request events

`Optional`getInfo

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

A special method for getting the generic wallet information

`Protected` `Readonly`handlers

handlers: WalletServiceHandlers<Methods>

Map of method handlers

`Protected`log

log: Debugger = ...

pubkey

pubkey: string | null = null

The service's public key

`Protected` `Readonly`publishMethod

publishMethod: NostrPublishMethod

A method for publishing events

`Readonly`relays

relays: string[]

The relays to use for the service

running

running: boolean = false

Whether the service is currently running

`Protected` `Optional`secret

secret?: Uint8Array<ArrayBufferLike>

The client's secret key

`Protected` `Readonly`signer

signer: EventSigner

The signer used for creating and unlocking events

`Protected`subscription

subscription: Subscription | null = null

Subscription to the events observable

`Protected` `Readonly`subscriptionMethod

subscriptionMethod: NostrSubscriptionMethod

A method for subscribing to relays

`Protected` `Readonly`support

support: WalletSupport<Methods>

Wallet support information

`Static`pool

pool: NostrPool | undefined = undefined

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

`Static`publishMethod

publishMethod: NostrPublishMethod | undefined = undefined

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

`Static`subscriptionMethod

subscriptionMethod: NostrSubscriptionMethod | undefined = undefined

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

Methods

getConnectURI

getConnectURI(): string
Get the connection URI for the service

Returns string
- Defined in wallet-service.ts:228

`Protected`handleRequestEvent

handleRequestEvent(requestEvent: WalletRequestEvent): Promise<void>
Handle a wallet request event
Parameters
- requestEvent: WalletRequestEvent
Returns Promise<void>
- Defined in wallet-service.ts:282

isRunning

isRunning(): boolean
Check if the service is running

Returns boolean
- Defined in wallet-service.ts:223

notify

notify<T extends WalletNotification>(
    type: T["notification_type"],
    notification: T["notification"],
    legacy?: boolean,
): Promise<void>
Send a notification to the client
Type Parameters
- T extends WalletNotification
Parameters
- type: T["notification_type"]
- notification: T["notification"]
- legacy: boolean = false
Returns Promise<void>
- Defined in wallet-service.ts:242

`Protected`processRequest

processRequest<Method extends TWalletMethod>(
requestEvent: WalletRequestEvent,
request: Method["request"],
): Promise<void>
Process a decrypted wallet request
Type Parameters
- Method extends TWalletMethod
Parameters
- requestEvent: WalletRequestEvent
- request: Method["request"]
Returns Promise<void>
- Defined in wallet-service.ts:301

`Protected`publishSupportEvent

publishSupportEvent(): Promise<void>
Publish the wallet support event

Returns Promise<void>
- Defined in wallet-service.ts:262

`Protected`sendErrorResponse

sendErrorResponse<Method extends TWalletMethod>(
    requestEvent: WalletRequestEvent,
    errorType: WalletErrorCode,
    errorMessage: string,
): Promise<void>
Send an error response
Type Parameters
- Method extends TWalletMethod
Parameters
- requestEvent: WalletRequestEvent
- errorType: WalletErrorCode
- errorMessage: string
Returns Promise<void>
- Defined in wallet-service.ts:363

`Protected`sendResponse

sendResponse<Method extends TWalletMethod>(
requestEvent: WalletRequestEvent,
response: Method["response"] | Method["error"],
): Promise<void>
Send a response event
Type Parameters
- Method extends TWalletMethod
Parameters
- requestEvent: WalletRequestEvent
- response: Method["response"] | Method["error"]
Returns Promise<void>
- Defined in wallet-service.ts:384

`Protected`sendSuccessResponse

sendSuccessResponse<Method extends TWalletMethod>(
    requestEvent: WalletRequestEvent,
    method: Method["response"]["result_type"],
    result: Method["response"]["result"],
): Promise<void>
Send a success response
Type Parameters
- Method extends TWalletMethod
Parameters
- requestEvent: WalletRequestEvent
- method: Method["response"]["result_type"]
- result: Method["response"]["result"]
Returns Promise<void>
- Defined in wallet-service.ts:348

start

start(): Promise<void>
Start the wallet service

Returns Promise<void>
- Defined in wallet-service.ts:163

stop

stop(): void
Stop the wallet service

Returns void
- Defined in wallet-service.ts:209

`Static`fromAuthURI

fromAuthURI<Methods extends TWalletMethod = CommonWalletMethods>(
    uri: string | WalletAuthURI<CommonWalletMethods>,
    options: Omit<WalletServiceOptions<Methods>, "relays"> & {
        overrideRelay?: string | ((relays: string[]) => string);
    },
): WalletService<Methods>
Creates a service for a nostr+walletauth URI
Type Parameters
- Methods extends TWalletMethod = CommonWalletMethods
Parameters
- uri: string | WalletAuthURI<CommonWalletMethods>
- options: Omit<WalletServiceOptions<Methods>, "relays"> & {
  overrideRelay?: string | ((relays: string[]) => string);
  }
  - OptionaloverrideRelay?: string | ((relays: string[]) => string)
    A relay or method to select a single relay for the client and service to communicate over
Returns WalletService<Methods>
- Defined in wallet-service.ts:399

Class WalletService<Methods>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WalletService<Methods>

Properties

client

Protectedevents$

OptionalgetInfo

Protected Readonlyhandlers

Protectedlog

pubkey

Protected ReadonlypublishMethod

Readonlyrelays

running

Protected Optionalsecret

Protected Readonlysigner

Protectedsubscription

Protected ReadonlysubscriptionMethod

Protected Readonlysupport

Staticpool

StaticpublishMethod

StaticsubscriptionMethod

Methods

getConnectURI

Returns string

ProtectedhandleRequestEvent

Parameters

Returns Promise<void>

isRunning

Returns boolean

notify

Type Parameters

Parameters

Returns Promise<void>

ProtectedprocessRequest

Type Parameters

Parameters

Returns Promise<void>

ProtectedpublishSupportEvent

Returns Promise<void>

ProtectedsendErrorResponse

Type Parameters

Parameters

Returns Promise<void>

ProtectedsendResponse

Type Parameters

Parameters

Returns Promise<void>

ProtectedsendSuccessResponse

Type Parameters

Parameters

Returns Promise<void>

start

Returns Promise<void>

stop

Returns void

StaticfromAuthURI

Type Parameters

Parameters

OptionaloverrideRelay?: string | ((relays: string[]) => string)

Returns WalletService<Methods>

Settings

On This Page

`Protected`events$

`Optional`getInfo

`Protected` `Readonly`handlers

`Protected`log

`Protected` `Readonly`publishMethod

`Readonly`relays

`Protected` `Optional`secret

`Protected` `Readonly`signer

`Protected`subscription

`Protected` `Readonly`subscriptionMethod

`Protected` `Readonly`support

`Static`pool

`Static`publishMethod

`Static`subscriptionMethod

`Protected`handleRequestEvent

`Protected`processRequest

`Protected`publishSupportEvent

`Protected`sendErrorResponse

`Protected`sendResponse

`Protected`sendSuccessResponse

`Static`fromAuthURI

`Optional`overrideRelay?: string | ((relays: string[]) => string)