Class PrivateKeyAccount<Metadata>

A simple account that hold the private key in memory

Type Parameters

Metadata extends unknown

Hierarchy (View Summary)

BaseAccount<PrivateKeySigner, PrivateKeyAccountSignerData, Metadata>
- PrivateKeyAccount

Index

Constructors

constructor

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

Properties

`Protected`abort

abort: AbortController | null = null

`Optional`disableQueue

disableQueue?: boolean

Disable request queueing

id

id: string = ...

`Protected`lock

lock: Promise<any> | null = null

metadata$

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

pubkey

pubkey: string

`Protected`queueLength

queueLength: number = 0

internal queue

signer

signer: PrivateKeySigner

`Static` `Readonly`type

type: "nsec"

Accessors

metadata

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

nip44

get nip44(): | {
decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
encrypt: (pubkey: string, plaintext: string) => Promise<string>;
}
| undefined
Returns
    | {
        decrypt: (pubkey: string, ciphertext: string) => Promise<string>;
        encrypt: (pubkey: string, plaintext: string) => Promise<string>;
    }
    | undefined
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

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>
Inherited from BaseAccount.operation
- Defined in packages/accounts/src/account.ts:85

`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<PrivateKeyAccountSignerData, 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<PrivateKeyAccountSignerData, 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<PrivateKeyAccountSignerData, Metadata>
Returns SerializedAccount<PrivateKeyAccountSignerData, Metadata>
Overrides BaseAccount.toJSON
- Defined in packages/accounts/src/accounts/private-key-account.ts:20

`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<PrivateKeyAccountSignerData, Metadata>,
): PrivateKeyAccount<Metadata>
Type Parameters
- Metadata extends unknown
Parameters
- json: SerializedAccount<PrivateKeyAccountSignerData, Metadata>
Returns PrivateKeyAccount<Metadata>
- Defined in packages/accounts/src/accounts/private-key-account.ts:26

`Static`fromKey

fromKey<Metadata extends unknown>(
privateKey: string | Uint8Array<ArrayBufferLike>,
): PrivateKeyAccount<Metadata>
Creates a PrivateKeyAccount from a hex private key or NIP-19 nsec
Type Parameters
- Metadata extends unknown
Parameters
- privateKey: string | Uint8Array<ArrayBufferLike>
Returns PrivateKeyAccount<Metadata>
- Defined in packages/accounts/src/accounts/private-key-account.ts:35

`Static`generateNew

generateNew<Metadata extends unknown>(): PrivateKeyAccount<Metadata>
Creates a new PrivateKeyAccount with a random private key
Type Parameters
- Metadata extends unknown
Returns PrivateKeyAccount<Metadata>
- Defined in packages/accounts/src/accounts/private-key-account.ts:42

`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 PrivateKeyAccount<Metadata>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PrivateKeyAccount<Metadata>

Properties

Protectedabort

OptionaldisableQueue

id

Protectedlock

metadata$

pubkey

ProtectedqueueLength

signer

Static Readonlytype

Accessors

metadata

Returns Metadata | undefined

Parameters

Returns void

nip04

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

nip44

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

type

Returns string

Methods

abortQueue

Parameters

Returns void

getPublicKey

Returns Promise<string>

Protectedoperation

Type Parameters

Parameters

Returns Promise<T>

ProtectedreduceQueue

Returns void

ProtectedsaveCommonFields

Parameters

Returns SerializedAccount<PrivateKeyAccountSignerData, Metadata>

signEvent

Parameters

Returns Promise<Event>

toJSON

Returns SerializedAccount<PrivateKeyAccountSignerData, Metadata>

ProtectedwaitForQueue

Type Parameters

Parameters

Returns Promise<T>

StaticfromJSON

Type Parameters

Parameters

Returns PrivateKeyAccount<Metadata>

StaticfromKey

Type Parameters

Parameters

Returns PrivateKeyAccount<Metadata>

StaticgenerateNew

Type Parameters

Returns PrivateKeyAccount<Metadata>

StaticloadCommonFields

Type Parameters

Parameters

Returns T

Settings

On This Page

`Protected`abort

`Optional`disableQueue

`Protected`lock

`Protected`queueLength

`Static` `Readonly`type

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

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

`Protected`operation

`Protected`reduceQueue

`Protected`saveCommonFields

`Protected`waitForQueue

`Static`fromJSON

`Static`fromKey

`Static`generateNew

`Static`loadCommonFields