Class ReadonlyAccount<Metadata>

An account that cannot sign or encrypt anything

Type Parameters

Metadata extends unknown

Hierarchy (View Summary)

BaseAccount<ReadonlySigner, void, Metadata>
- ReadonlyAccount

Index

Constructors

constructor

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

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

`Static` `Readonly`type

type: "readonly"

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

nip44

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

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

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

`Protected`reduceQueue

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

`Protected`saveCommonFields

saveCommonFields(
    json: Omit<
        SerializedAccount<SignerData, Metadata>,
        "id" | "type" | "metadata" | "pubkey",
    >,
): SerializedAccount<void, 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<void, Metadata>
Inherited from BaseAccount.saveCommonFields
- Defined in packages/accounts/src/account.ts:93

signEvent

signEvent(template: EventTemplate): 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:122

toJSON

toJSON(): SerializedAccount<void, Metadata>
Returns SerializedAccount<void, Metadata>
Overrides BaseAccount.toJSON
- Defined in packages/accounts/src/accounts/readonly-account.ts:9

`Protected`waitForLock

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

`Static`fromJSON

fromJSON<Metadata extends unknown>(
json: SerializedAccount<void, Metadata>,
): ReadonlyAccount<Metadata>
Type Parameters
- Metadata extends unknown
Parameters
- json: SerializedAccount<void, Metadata>
Returns ReadonlyAccount<Metadata>
- Defined in packages/accounts/src/accounts/readonly-account.ts:15

`Static`fromPubkey

fromPubkey(pubkey: string): ReadonlyAccount<unknown>
Creates a ReadonlyAccount from a hex public key or NIP-19 npub
Parameters
- pubkey: string
Returns ReadonlyAccount<unknown>
- Defined in packages/accounts/src/accounts/readonly-account.ts:21

`Static`loadCommonFields

loadCommonFields<T extends IAccount<Nip07Interface, 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<Nip07Interface, any, any>
Parameters
- account: T
- json: SerializedAccount<any, any>
Returns T
Inherited from BaseAccount.loadCommonFields
- Defined in packages/accounts/src/account.ts:100

Class ReadonlyAccount<Metadata>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ReadonlyAccount<Metadata>

Properties

Protectedabort

OptionaldisableQueue

id

Protectedlock

metadata$

pubkey

ProtectedqueueLength

signer

Static Readonlytype

Accessors

metadata

Returns undefined | Metadata

Parameters

Returns void

nip04

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

nip44

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

type

Returns string

Methods

abortQueue

Parameters

Returns void

getPublicKey

Returns string | Promise<string>

ProtectedreduceQueue

Returns void

ProtectedsaveCommonFields

Parameters

Returns SerializedAccount<void, Metadata>

signEvent

Parameters

Returns Event | Promise<Event>

toJSON

Returns SerializedAccount<void, Metadata>

ProtectedwaitForLock

Type Parameters

Parameters

Returns T | Promise<T>

StaticfromJSON

Type Parameters

Parameters

Returns ReadonlyAccount<Metadata>

StaticfromPubkey

Parameters

Returns ReadonlyAccount<unknown>

StaticloadCommonFields

Type Parameters

Parameters

Returns T

Settings

On This Page

`Protected`abort

`Optional`disableQueue

`Protected`lock

`Protected`queueLength

`Static` `Readonly`type

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

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

`Protected`reduceQueue

`Protected`saveCommonFields

`Protected`waitForLock

`Static`fromJSON

`Static`fromPubkey

`Static`loadCommonFields