Class WalletService

NIP-47 Wallet Service implementation

Index

Constructors

constructor

new WalletService(options: WalletServiceOptions): WalletService
Parameters
- options: WalletServiceOptions
Returns WalletService
- Defined in wallet-service.ts:158

Properties

`Protected`events$

events$: null | Observable<Event> = null

Shared observable for all wallet request events

`Protected` `Readonly`handlers

handlers: WalletServiceHandlers

Map of method handlers

`Protected`log

log: Debugger = ...

pubkey

pubkey: null | string = 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`secret

secret: Uint8Array

The client's secret key

`Protected` `Readonly`signer

signer: EventSigner

The signer used for creating and unlocking events

`Protected`subscription

subscription: null | Subscription = null

Subscription to the events observable

`Protected` `Readonly`subscriptionMethod

subscriptionMethod: NostrSubscriptionMethod

A method for subscribing to relays

`Protected` `Readonly`support

support: WalletSupport

Wallet support information

`Static`publishMethod

publishMethod: undefined | NostrPublishMethod = undefined

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

`Static`subscriptionMethod

subscriptionMethod: undefined | NostrSubscriptionMethod = undefined

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

Accessors

client

get client(): string
Get the clients public key

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

Methods

getConnectionString

getConnectionString(): string
Get the connection string for the service

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

`Protected`handleRequestEvent

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

isRunning

isRunning(): boolean
Check if the service is running

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

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:260

`Protected`processRequest

processRequest(requestEvent: Event, request: WalletRequest): Promise<void>
Process a decrypted wallet request
Parameters
- requestEvent: Event
- request: WalletRequest
Returns Promise<void>
- Defined in wallet-service.ts:317

`Protected`publishSupportEvent

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

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

`Protected`sendErrorResponse

sendErrorResponse(
    requestEvent: Event,
    errorType: WalletErrorCode,
    errorMessage: string,
): Promise<void>
Send an error response
Parameters
- requestEvent: Event
- errorType: WalletErrorCode
- errorMessage: string
Returns Promise<void>
- Defined in wallet-service.ts:395

`Protected`sendResponse

sendResponse(requestEvent: Event, response: WalletResponse): Promise<void>
Send a response event
Parameters
- requestEvent: Event
- response: WalletResponse
Returns Promise<void>
- Defined in wallet-service.ts:416

`Protected`sendSuccessResponse

sendSuccessResponse<T extends WalletResponse>(
    requestEvent: Event,
    method: T["result_type"],
    result: T["result"],
): Promise<void>
Send a success response
Type Parameters
- T extends WalletResponse
Parameters
- requestEvent: Event
- method: T["result_type"]
- result: T["result"]
Returns Promise<void>
- Defined in wallet-service.ts:380

start

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

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

stop

stop(): void
Stop the wallet service

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

Class WalletService

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WalletService

Properties

Protectedevents$

Protected Readonlyhandlers

Protectedlog

pubkey

Protected ReadonlypublishMethod

Readonlyrelays

running

Protectedsecret

Protected Readonlysigner

Protectedsubscription

Protected ReadonlysubscriptionMethod

Protected Readonlysupport

StaticpublishMethod

StaticsubscriptionMethod

Accessors

client

Returns string

Methods

getConnectionString

Returns string

ProtectedhandleRequestEvent

Parameters

Returns Promise<void>

isRunning

Returns boolean

notify

Type Parameters

Parameters

Returns Promise<void>

ProtectedprocessRequest

Parameters

Returns Promise<void>

ProtectedpublishSupportEvent

Returns Promise<void>

ProtectedsendErrorResponse

Parameters

Returns Promise<void>

ProtectedsendResponse

Parameters

Returns Promise<void>

ProtectedsendSuccessResponse

Type Parameters

Parameters

Returns Promise<void>

start

Returns Promise<void>

stop

Returns void

Settings

On This Page

`Protected`events$

`Protected` `Readonly`handlers

`Protected`log

`Protected` `Readonly`publishMethod

`Readonly`relays

`Protected`secret

`Protected` `Readonly`signer

`Protected`subscription

`Protected` `Readonly`subscriptionMethod

`Protected` `Readonly`support

`Static`publishMethod

`Static`subscriptionMethod

`Protected`handleRequestEvent

`Protected`processRequest

`Protected`publishSupportEvent

`Protected`sendErrorResponse

`Protected`sendResponse

`Protected`sendSuccessResponse