locklift/src/chaiPlugin/matchers/withNamedArgs.ts

Node JS framework for working with Ever contracts. Inspired by Truffle and Hardhat. Helps you to build, test, run and maintain your smart contracts.

import { ViewTrace } from "src/internal/tracing/types";

import { mapAddressesToString, objectIntersection } from "../utils";
import _ from "lodash";

/**
 * Used for testing the arguments of events or custom errors, naming the arguments.
 * Can test the subset of all arguments.
 * Should be used after .emit or .call matcher.
 */
export function supportWithNamedArgs(Assertion: Chai.AssertionStatic, utils: Chai.ChaiUtils) {
  Assertion.addMethod("withNamedArgs", function (this: any, expectedArgs: Record<string, unknown>, message?: string) {
    const events = utils.flag(this, "messages") as ViewTrace<string, unknown>[];

    const expectedArgsWithUpdatedAddress = mapAddressesToString(expectedArgs);
    const matchedEvent = events
      .map(({ decodedMsg }) => {
        if (!decodedMsg?.params) {
          throw new Error(`Event ${decodedMsg?.method} doesn't have params`);
        }
        const eventParamsWithUpdatedAddress = mapAddressesToString(decodedMsg.params);
        return objectIntersection(eventParamsWithUpdatedAddress, expectedArgsWithUpdatedAddress);
      })
      .find(partialEventArgs => {
        return _.isEqual(partialEventArgs, expectedArgsWithUpdatedAddress);
      });
    if (matchedEvent) {
      new Assertion(matchedEvent).to.be.deep.equal(expectedArgsWithUpdatedAddress, message);
    } else {
      const firstEvent = events[0];
      if (!firstEvent.decodedMsg?.params) {
        throw new Error(`Event ${firstEvent.decodedMsg?.method} doesn't have params`);
      }
      const { eventParamsWithUpdatedAddress } = {
        eventParamsWithUpdatedAddress: mapAddressesToString(firstEvent.decodedMsg.params),
      };
      const partialEventArgs = objectIntersection(eventParamsWithUpdatedAddress, expectedArgsWithUpdatedAddress);
      new Assertion(partialEventArgs).to.be.deep.equal(expectedArgsWithUpdatedAddress, message);
    }
    return this;
  });
}