@solarity/hardhat-migrate/src/types/migrations.ts

The simplest way to deploy smart contracts

// Grouped configuration interfaces
export interface MigrationFilterConfig {
  /** The migration number from which the migration will be applied */
  from: number;
  /** The migration number up to which the migration will be applied */
  to: number;
  /** The number of the migrations that will be applied. Overrides from and to parameters */
  only: number;
  /** The number of migrations to skip. Overrides only parameter */
  skip: number;
}

export interface VerificationConfig {
  /** The flag indicating whether the contract should be verified */
  verify: boolean;
  /** The time in milliseconds to wait before the verification process starts */
  verificationDelay: number;
  /** The size of the batch for verification */
  verifyParallel: number;
  /** The number of attempts to verify the contract */
  verifyAttempts: number;
}

export interface PathConfig {
  /** The path to the folder with the specified migrations */
  pathToMigrations: string;
  /**
   * The path to the folder where the migration should be done.
   * This parameter is used together with the `pathToMigrations` parameter.
   * If the following parameter specified, the migrations will be retrieved from:
   * `{hardhat.config.paths.root}/{pathToMigrations}/{namespace}`
   */
  namespace: string;
  /** The path to directory where the migration report should be saved */
  reportPath: string;
  /** The format of the migration report (json or md) */
  reportFormat: string;
}

export interface ExecutionConfig {
  /** The flag indicating whether the compilation is forced */
  force: boolean;
  /** The flag indicating whether the previous deployment should be continued */
  continue: boolean;
  /** The number defining how many confirmations each transaction should have */
  wait: number;
  /** The interval in milliseconds between transaction status checks */
  transactionStatusCheckInterval: number;
  /** The flag indicating whether the CLI reporting should be disabled */
  withoutCLIReporting: boolean;
}

export interface CastWalletConfig {
  /** File path to the keystore password */
  passwordFile?: string;
  /** Use a keystore file or directory */
  keystore?: string;
  /** The account name (when using the default keystore directory) */
  account?: string;
}

export interface TrezorWalletConfig {
  /** Specifies that the trezor wallet should be used */
  enabled: boolean;
  /** The mnemonic index */
  mnemonicIndex: number;
}

export interface MigrateConfig {
  filter: MigrationFilterConfig;
  verification: VerificationConfig;
  paths: PathConfig;
  execution: ExecutionConfig;
  castWallet: CastWalletConfig;
  trezorWallet: TrezorWalletConfig;
}

export type MigrateUserConfig = DeepPartial<MigrateConfig>;

export interface VerifyConfig {
  /** The size of the batch for verification */
  parallel: number;
  /** The number of attempts to verify the contract */
  attempts: number;
}

export interface MigrateVerifyConfig extends VerifyConfig {
  /** The path to the file with the verification input */
  inputFile: string | undefined;
}

export interface MigrateConfigArgs {
  from?: number;
  to?: number;
  only?: number;
  skip?: number;

  verify?: boolean;
  verificationDelay?: number;
  verifyParallel?: number;
  verifyAttempts?: number;

  pathToMigrations?: string;
  namespace?: string;

  force?: boolean;
  continue?: boolean;
  wait?: number;
  transactionStatusCheckInterval?: number;

  passwordFile?: string;
  keystore?: string;
  account?: string;

  trezorEnabled?: boolean;
  trezorMnemonicIndex?: number;

  reportPath?: string;
  reportFormat?: string;
}

export type DeepPartial<T> = T extends object
  ? {
      [P in keyof T]?: DeepPartial<T[P]>;
    }
  : T;