@nomicfoundation/hardhat-chai-matchers/src/types.ts

Hardhat utils for testing

// eslint-disable-next-line @typescript-eslint/no-namespace, @typescript-eslint/no-unused-vars
declare namespace Chai {
  interface Assertion
    extends LanguageChains,
      NumericComparison,
      TypeComparison {
    emit(contract: any, eventName: string): EmitAssertion;
    reverted: AsyncAssertion;
    revertedWith(reason: string | RegExp): AsyncAssertion;
    revertedWithoutReason(): AsyncAssertion;
    revertedWithPanic(code?: any): AsyncAssertion;
    revertedWithCustomError(
      contract: { interface: any },
      customErrorName: string
    ): CustomErrorAssertion;
    hexEqual(other: string): void;
    properPrivateKey: void;
    properAddress: void;
    properHex(length: number): void;
    changeEtherBalance(
      account: any,
      balance: any,
      options?: any
    ): AsyncAssertion;
    changeEtherBalances(
      accounts: any[],
      balances: any[] | ((changes: bigint[]) => boolean),
      options?: any
    ): AsyncAssertion;
    changeTokenBalance(token: any, account: any, balance: any): AsyncAssertion;
    changeTokenBalances(
      token: any,
      account: any[],
      balance: any[] | ((changes: bigint[]) => boolean)
    ): AsyncAssertion;
  }

  interface NumericComparison {
    within(start: any, finish: any, message?: string): Assertion;
  }

  interface NumberComparer {
    // eslint-disable-next-line
    (value: any, message?: string): Assertion;
  }

  interface CloseTo {
    // eslint-disable-next-line
    (expected: any, delta: any, message?: string): Assertion;
  }

  interface Length extends Assertion {
    // eslint-disable-next-line
    (length: any, message?: string): Assertion;
  }

  interface AsyncAssertion extends Assertion, Promise<void> {}

  interface EmitAssertion extends AsyncAssertion {
    withArgs(...args: any[]): AsyncAssertion;
  }

  interface CustomErrorAssertion extends AsyncAssertion {
    withArgs(...args: any[]): AsyncAssertion;
  }
}