All files / kernel-errors/src/errors VatDeletedError.ts

100% Statements 6/6
100% Branches 0/0
100% Functions 2/2
100% Lines 6/6

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61                                          29x       29x           134x                                         2x 2x           134x  
import { assert, literal, object, string } from '@metamask/superstruct';
 
import { BaseError } from '../BaseError.ts';
import { marshaledErrorSchema, ErrorCode } from '../constants.ts';
import type { ErrorOptionsWithStack, MarshaledOcapError } from '../types.ts';
 
/**
 * Error indicating an operation was attempted on a vat that has been deleted.
 */
export class VatDeletedError extends BaseError {
  /**
   * Creates a new VatDeletedError.
   *
   * @param vatId - The identifier of the deleted vat.
   * @param options - Additional error options including cause and stack trace.
   * @param options.data - Additional data about the error.
   * @param options.data.vatId - The identifier of the deleted vat.
   * @param options.cause - The underlying error that caused the vat deleted error.
   * @param options.stack - The stack trace of the error.
   */
  constructor(vatId: string, options?: ErrorOptionsWithStack) {
    super(ErrorCode.VatDeleted, 'Vat was deleted.', {
      ...options,
      data: { vatId },
    });
    harden(this);
  }
 
  /**
   * A superstruct struct for validating marshaled {@link VatDeletedError} instances.
   */
  public static struct = object({
    ...marshaledErrorSchema,
    code: literal(ErrorCode.VatDeleted),
    data: object({
      vatId: string(),
    }),
  });
 
  /**
   * Unmarshals a {@link MarshaledError} into a {@link VatDeletedError}.
   *
   * @param marshaledError - The marshaled error to unmarshal.
   * @param unmarshalErrorOptions - The function to unmarshal the error options.
   * @returns The unmarshaled error.
   */
  public static unmarshal(
    marshaledError: MarshaledOcapError,
    unmarshalErrorOptions: (
      marshaledError: MarshaledOcapError,
    ) => ErrorOptionsWithStack,
  ): VatDeletedError {
    assert(marshaledError, this.struct);
    return new VatDeletedError(
      marshaledError.data.vatId,
      unmarshalErrorOptions(marshaledError),
    );
  }
}
harden(VatDeletedError);