Class BaseAccount<Signer, SignerData, Metadata>

constructor

• new BaseAccount<
      Signer extends Nip07Interface,
      SignerData,
      Metadata extends unknown,
  >(
      pubkey: string,
      signer: Signer,
  ): BaseAccount<Signer, SignerData, Metadata>

  Type Parameters

  • Signer extends Nip07Interface
  • SignerData
  • Metadata extends unknown

  Parameters

  • pubkey: string
  • signer: Signer

  Returns BaseAccount<Signer, SignerData, Metadata>

OptionaldisableQueue

id

metadata$

pubkey

signer

metadata

• get metadata(): undefined | Metadata

  Returns undefined | Metadata

• set metadata(metadata: Metadata): void

  Parameters

  • metadata: Metadata

  Returns void

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>;
      }

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>;
      }

type

• get type(): string

  Returns string

abortQueue

• abortQueue(reason: Error): void

  Aborts all pending requests in the queue

  Parameters

  • reason: Error

  Returns void

getPublicKey

• getPublicKey(): string | Promise<string>

  Gets the pubkey from the signer

  Returns string | Promise<string>

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>

toJSON

• toJSON(): SerializedAccount<SignerData, Metadata>

  Returns SerializedAccount<SignerData, Metadata>

StaticloadCommonFields

• 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