Class PasswordAccount<Metadata>

Type Parameters

Metadata extends unknown

Hierarchy (view full)

BaseAccount<PasswordSigner, PasswordAccountSignerData, Metadata>
- PasswordAccount

Index

Constructors

constructor

new PasswordAccount<Metadata>(pubkey, signer): PasswordAccount<Metadata>
Type Parameters
- Metadata extends unknown
Parameters
- pubkey: string
- signer: PasswordSigner
Returns PasswordAccount<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: PasswordSigner

`Static` `Readonly`type

type = "ncryptsec"

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

unlocked

get unlocked(): boolean
Returns boolean
- Defined in packages/accounts/src/accounts/password-account.ts:16

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<PasswordAccountSignerData, Metadata>
Adds the common fields to the serialized output of a toJSON method
Parameters
- json: Omit<SerializedAccount<PasswordAccountSignerData, Metadata>,
      | "type"
      | "id"
      | "metadata"
      | "pubkey">
Returns SerializedAccount<PasswordAccountSignerData, 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<PasswordAccountSignerData, Metadata>
Returns SerializedAccount<PasswordAccountSignerData, Metadata>
Overrides BaseAccount.toJSON
- Defined in packages/accounts/src/accounts/password-account.ts:36

unlock

unlock(password?): Promise<void>
Attempt to unlock the signer with a password
Parameters
- Optionalpassword: string
Returns Promise<void>
Throws
- Defined in packages/accounts/src/accounts/password-account.ts:31

`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`fromJSON

fromJSON<Metadata>(json): PasswordAccount<Metadata>
Type Parameters
- Metadata extends unknown
Parameters
- json: SerializedAccount<PasswordAccountSignerData, Metadata>
Returns PasswordAccount<Metadata>
- Defined in packages/accounts/src/accounts/password-account.ts:44

`Static`fromNcryptsec

fromNcryptsec<Metadata>(pubkey, ncryptsec): PasswordAccount<Metadata>
Creates a new PasswordAccount from a ncryptsec string
Type Parameters
- Metadata extends unknown
Parameters
- pubkey: string
- ncryptsec: string
Returns PasswordAccount<Metadata>
- Defined in packages/accounts/src/accounts/password-account.ts:54

`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

`Static`requestUnlockPassword

requestUnlockPassword(_account): Promise<string>
called when PasswordAccount.unlock is called without a password
Parameters
- _account: PasswordAccount<any>
Returns Promise<string>
- Defined in packages/accounts/src/accounts/password-account.ts:21

Class PasswordAccount<Metadata>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PasswordAccount<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

unlocked

Returns boolean

Methods

abortQueue

Parameters

Returns void

getPublicKey

Returns string | Promise<string>

ProtectedreduceQueue

Returns void

ProtectedsaveCommonFields

Parameters

Returns SerializedAccount<PasswordAccountSignerData, Metadata>

signEvent

Parameters

Returns Event | Promise<Event>

toJSON

Returns SerializedAccount<PasswordAccountSignerData, Metadata>

unlock

Parameters

Returns Promise<void>

Throws

ProtectedwaitForLock

Type Parameters

Parameters

Returns T | Promise<T>

Returns T | Promise<T>

StaticfromJSON

Type Parameters

Parameters

Returns PasswordAccount<Metadata>

StaticfromNcryptsec

Type Parameters

Parameters

Returns PasswordAccount<Metadata>

StaticloadCommonFields

Type Parameters

Parameters

Returns T

StaticrequestUnlockPassword

Parameters

Returns Promise<string>

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`fromJSON

`Static`fromNcryptsec

`Static`loadCommonFields

`Static`requestUnlockPassword