Class NostrConnectAccount<Metadata>

An account type for NIP-46 signers

Type Parameters

Metadata extends unknown

Hierarchy (view full)

BaseAccount<NostrConnectSigner, NostrConnectAccountSignerData, Metadata>
- NostrConnectAccount

Index

Constructors

constructor

new NostrConnectAccount<Metadata>(pubkey, signer): NostrConnectAccount<Metadata>
Type Parameters
- Metadata extends unknown
Parameters
- pubkey: string
- signer: NostrConnectSigner
Returns NostrConnectAccount<Metadata>
Inherited from BaseAccount.constructor
- Defined in packages/accounts/src/account.ts:69

Properties

`Protected`abort

abort: null | AbortController = null

`Optional`disableQueue

disableQueue?: boolean

Disable request queueing

id

id: string = ...

`Protected`lock

lock: null | Promise<any> = null

metadata$

metadata$: BehaviorSubject<undefined | Metadata> = ...

`Optional`nip04

nip04?: {
decrypt: ((pubkey: string, ciphertext: string) => string | Promise<string>);
encrypt: ((pubkey: string, plaintext: string) => string | Promise<string>);
}

`Optional`nip44

nip44?: {
decrypt: ((pubkey: string, ciphertext: string) => string | Promise<string>);
encrypt: ((pubkey: string, plaintext: string) => string | Promise<string>);
}

pubkey

pubkey: string

`Protected`queueLength

queueLength: number = 0

internal queue

signer

signer: NostrConnectSigner

`Static` `Readonly`type

type = "nostr-connect"

Accessors

metadata

get metadata(): undefined | Metadata
Returns undefined | Metadata
Inherited from BaseAccount.metadata
- Defined in packages/accounts/src/account.ts:48
set metadata(metadata): void
Parameters
- metadata: Metadata
Returns void
Inherited from BaseAccount.metadata
- Defined in packages/accounts/src/account.ts:51

type

get type(): string
Returns string
Inherited from BaseAccount.type
- Defined in packages/accounts/src/account.ts:39

Methods

abortQueue

abortQueue(reason): void
Aborts all pending requests in the queue
Parameters
- reason: Error
Returns void
Inherited from BaseAccount.abortQueue
- Defined in packages/accounts/src/account.ts:152

getPublicKey

getPublicKey(): string | Promise<string>
Gets the pubkey from the signer

Returns string | Promise<string>
Inherited from BaseAccount.getPublicKey
- Defined in packages/accounts/src/account.ts:117

`Protected`reduceQueue

reduceQueue(): void
Returns void
Inherited from BaseAccount.reduceQueue
- Defined in packages/accounts/src/account.ts:160

`Protected`saveCommonFields

saveCommonFields(json): SerializedAccount<NostrConnectAccountSignerData, Metadata>
Adds the common fields to the serialized output of a toJSON method
Parameters
- json: Omit<SerializedAccount<NostrConnectAccountSignerData, Metadata>,
      | "type"
      | "id"
      | "metadata"
      | "pubkey">
Returns SerializedAccount<NostrConnectAccountSignerData, Metadata>
Inherited from BaseAccount.saveCommonFields
- Defined in packages/accounts/src/account.ts:103

signEvent

signEvent(template): Event | Promise<Event>
sign the event and make sure its signed with the correct pubkey
Parameters
- template: EventTemplate
Returns Event | Promise<Event>
Inherited from BaseAccount.signEvent
- Defined in packages/accounts/src/account.ts:132

toJSON

toJSON(): SerializedAccount<NostrConnectAccountSignerData, Metadata>
Returns SerializedAccount<NostrConnectAccountSignerData, Metadata>
Overrides BaseAccount.toJSON
- Defined in packages/accounts/src/accounts/nostr-connect-account.ts:21

`Protected`waitForLock

waitForLock<T>(fn): T | Promise<T>
Type Parameters
- T
Parameters
- fn: (() => T | Promise<T>)
  - - (): T | Promise<T>
    - Returns T | Promise<T>
Returns T | Promise<T>
Inherited from BaseAccount.waitForLock
- Defined in packages/accounts/src/account.ts:170

`Static`createConnectionMethods

createConnectionMethods(): NostrConnectConnectionMethods
This is called when NostrConnectAccount.fromJSON needs new connection methods for NostrConnectSigner

Returns NostrConnectConnectionMethods
- Defined in packages/accounts/src/accounts/nostr-connect-account.ts:34

`Static`fromJSON

fromJSON<Metadata>(json, connection?): NostrConnectAccount<Metadata>
Type Parameters
- Metadata extends unknown
Parameters
- json: SerializedAccount<NostrConnectAccountSignerData, Metadata>
- Optionalconnection: NostrConnectConnectionMethods
Returns NostrConnectAccount<Metadata>
- Defined in packages/accounts/src/accounts/nostr-connect-account.ts:40

`Static`loadCommonFields

loadCommonFields<T>(account, json): T
Sets an accounts id and metadata. NOTE: This should only be used in fromJSON methods
Type Parameters
- T extends IAccount<Nip07Interface, any, any>
Parameters
- account: T
- json: SerializedAccount<any, any>
Returns T
Inherited from BaseAccount.loadCommonFields
- Defined in packages/accounts/src/account.ts:110

Class NostrConnectAccount<Metadata>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NostrConnectAccount<Metadata>

Properties

Protectedabort

OptionaldisableQueue

id

Protectedlock

metadata$

Optionalnip04

Optionalnip44

pubkey

ProtectedqueueLength

signer

Static Readonlytype

Accessors

metadata

Returns undefined | Metadata

Parameters

Returns void

type

Returns string

Methods

abortQueue

Parameters

Returns void

getPublicKey

Returns string | Promise<string>

ProtectedreduceQueue

Returns void

ProtectedsaveCommonFields

Parameters

Returns SerializedAccount<NostrConnectAccountSignerData, Metadata>

signEvent

Parameters

Returns Event | Promise<Event>

toJSON

Returns SerializedAccount<NostrConnectAccountSignerData, Metadata>

ProtectedwaitForLock

Type Parameters

Parameters

Returns T | Promise<T>

Returns T | Promise<T>

StaticcreateConnectionMethods

Returns NostrConnectConnectionMethods

StaticfromJSON

Type Parameters

Parameters

Returns NostrConnectAccount<Metadata>

StaticloadCommonFields

Type Parameters

Parameters

Returns T

Settings

On This Page

`Protected`abort

`Optional`disableQueue

`Protected`lock

`Optional`nip04

`Optional`nip44

`Protected`queueLength

`Static` `Readonly`type

`Protected`reduceQueue

`Protected`saveCommonFields

`Protected`waitForLock

`Static`createConnectionMethods

`Static`fromJSON

`Static`loadCommonFields