@nomicfoundation/hardhat-keystore/src/internal/loaders/keystore-file-loader.ts

A module for managing keystore files that store a map from IDs to encrypted string values.

import type { FileManager, KeystoreLoader } from "../types.js";

import { assertHardhatInvariant } from "@nomicfoundation/hardhat-errors";

import { createEmptyEncryptedKeystore } from "../keystores/encryption.js";
import { Keystore } from "../keystores/keystore.js";

export class KeystoreFileLoader implements KeystoreLoader {
  readonly #keystoreFilePath: string;
  readonly #keystoreDevPasswordFilePath: string;
  readonly #fileManager: FileManager;
  #keystoreCache: Keystore | null;

  constructor(
    keystoreFilePath: string,
    keystoreDevPasswordFilePath: string,
    fileManger: FileManager,
  ) {
    this.#keystoreFilePath = keystoreFilePath;
    this.#keystoreDevPasswordFilePath = keystoreDevPasswordFilePath;
    this.#fileManager = fileManger;

    this.#keystoreCache = null;
  }

  public getKeystoreFilePath(): string {
    return this.#keystoreFilePath;
  }

  public getKeystoreDevPasswordFilePath(): string {
    return this.#keystoreDevPasswordFilePath;
  }

  public async isKeystoreInitialized(): Promise<boolean> {
    if (this.#keystoreCache !== null) {
      return true;
    }

    return await this.#fileManager.fileExists(this.#keystoreFilePath);
  }

  public async loadKeystore(): Promise<Keystore> {
    if (this.#keystoreCache !== null) {
      return this.#keystoreCache;
    }

    const keystoreFile = await this.#fileManager.readJsonFile(
      this.#keystoreFilePath,
    );

    const keystore = new Keystore(keystoreFile);
    this.#keystoreCache = keystore;

    return keystore;
  }

  public async createUnsavedKeystore({
    masterKey,
    salt,
  }: {
    masterKey: Uint8Array;
    salt: Uint8Array;
  }): Promise<Keystore> {
    assertHardhatInvariant(
      this.#keystoreCache === null,
      "Cannot create a new Keystore when one is already loaded",
    );

    const keystore = new Keystore(
      createEmptyEncryptedKeystore({ masterKey, salt }),
    );

    this.#keystoreCache = keystore;

    return keystore;
  }

  public async saveKeystoreToFile(): Promise<void> {
    assertHardhatInvariant(
      this.#keystoreCache !== null,
      "Cannot save a keystore that has not been loaded or created",
    );

    const keystoreFile = this.#keystoreCache.toJSON();

    await this.#fileManager.writeJsonFile(this.#keystoreFilePath, keystoreFile);
  }
}