Class PasswordAccount<Metadata>

A base class for all accounts

Type Parameters

Metadata extends unknown = unknown

Hierarchy (View Summary)

BaseAccount<PasswordSigner, PasswordAccountSignerData, Metadata>
- PasswordAccount

Index

Constructors

constructor

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

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> = ...

pubkey

pubkey: string

`Protected`queueLength

queueLength: number = 0

internal queue

signer

signer: PasswordSigner

`Static` `Optional`requestUnlockPassword

requestUnlockPassword?: (account: PasswordAccount<any>) => Promise<string>

called when PasswordAccount.unlock is called without a password

`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:51
set metadata(metadata: Metadata): void
Parameters
- metadata: Metadata
Returns void
Inherited from BaseAccount.metadata
- Defined in packages/accounts/src/account.ts:54

nip04

get nip04(): | undefined
| {
decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
encrypt: (pubkey: string, plaintext: string) => Promise<string>;
}
Returns
    | undefined
    | {
        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
    }
Inherited from BaseAccount.nip04
- Defined in packages/accounts/src/account.ts:58

nip44

get nip44(): | undefined
| {
decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
encrypt: (pubkey: string, plaintext: string) => Promise<string>;
}
Returns
    | undefined
    | {
        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
    }
Inherited from BaseAccount.nip44
- Defined in packages/accounts/src/account.ts:66

type

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

unlocked

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

Methods

abortQueue

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

getPublicKey

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

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

`Protected`operation

operation<T extends unknown>(operation: () => Promise<T>): Promise<T>
A method that wraps any signer interaction, this allows the account to wait for unlock or queue requests
Type Parameters
- T extends unknown
Parameters
- operation: () => Promise<T>
Returns Promise<T>
Overrides BaseAccount.operation
- Defined in packages/accounts/src/accounts/password-account.ts:39

`Protected`reduceQueue

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

`Protected`saveCommonFields

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

signEvent

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

toJSON

toJSON(): SerializedAccount<PasswordAccountSignerData, Metadata>
Returns SerializedAccount<PasswordAccountSignerData, Metadata>
Overrides BaseAccount.toJSON
- Defined in packages/accounts/src/accounts/password-account.ts:49

unlock

unlock(password?: string): 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:27

`Protected`waitForQueue

waitForQueue<T extends unknown>(operation: () => Promise<T>): Promise<T>
Type Parameters
- T extends unknown
Parameters
- operation: () => Promise<T>
Returns Promise<T>
Inherited from BaseAccount.waitForQueue
- Defined in packages/accounts/src/account.ts:148

`Static`fromJSON

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

`Static`fromNcryptsec

fromNcryptsec<Metadata extends unknown>(
pubkey: string,
ncryptsec: string,
): 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:67

`Static`loadCommonFields

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

Class PasswordAccount<Metadata>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PasswordAccount<Metadata>

Properties

Protectedabort

OptionaldisableQueue

id

Protectedlock

metadata$

pubkey

ProtectedqueueLength

signer

Static OptionalrequestUnlockPassword

Static Readonlytype

Accessors

metadata

Returns undefined | Metadata

Parameters

Returns void

nip04

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

nip44

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

type

Returns string

unlocked

Returns boolean

Methods

abortQueue

Parameters

Returns void

getPublicKey

Returns Promise<string>

Protectedoperation

Type Parameters

Parameters

Returns Promise<T>

ProtectedreduceQueue

Returns void

ProtectedsaveCommonFields

Parameters

Returns SerializedAccount<PasswordAccountSignerData, Metadata>

signEvent

Parameters

Returns Promise<Event>

toJSON

Returns SerializedAccount<PasswordAccountSignerData, Metadata>

unlock

Parameters

Returns Promise<void>

Throws

ProtectedwaitForQueue

Type Parameters

Parameters

Returns Promise<T>

StaticfromJSON

Type Parameters

Parameters

Returns PasswordAccount<Metadata>

StaticfromNcryptsec

Type Parameters

Parameters

Returns PasswordAccount<Metadata>

StaticloadCommonFields

Type Parameters

Parameters

Returns T

Settings

On This Page

`Protected`abort

`Optional`disableQueue

`Protected`lock

`Protected`queueLength

`Static` `Optional`requestUnlockPassword

`Static` `Readonly`type

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

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

`Protected`operation

`Protected`reduceQueue

`Protected`saveCommonFields

`Protected`waitForQueue

`Static`fromJSON

`Static`fromNcryptsec

`Static`loadCommonFields