Class NativeCoinControl

tests/helpers/NativeCoinControl.ts:26–70

export const ERR_BLOCKED_ADDRESS = /Blocked address/

export class NativeCoinControl {
  static readonly address: Address = nativeCoinControlAddress

  static readonly abi = parseAbi([
    'function blocklist(address account) external returns (bool success)',
    'function isBlocklisted(address account) external view returns (bool _isBlocklisted)',
    'function unBlocklist(address account) external returns (bool success)',
    'event Blocklisted(address indexed account)',
    'event UnBlocklisted(address indexed account)',
  ])

  /**
   * State override that clears the blocklist entry for `address` in
   * NativeCoinControl's `isBlocklisted` mapping. Needed for simulations where
   * a blocklisted address (e.g. the NativeFiatToken contract, per genesis)
   * appears as the tx caller; the EVM handler's pre-execution sender check
   * would otherwise reject the tx.
   */
  static unblockStateOverride = (address: Address) => ({
    address: NativeCoinControl.address,
    stateDiff: [
      {
        slot: slotForAddressMap(BLOCKLIST_MAPPING_SLOT, address),
        value: UNBLOCKLISTED_STATUS,
      },
    ],
  })

  static isBlocklisted = async <
    T extends Transport,
    C extends Chain | undefined,
    A extends Account | undefined,
    R extends RpcSchema | undefined,
  >(
    client: PublicClient<T, C, A, R>,
    account: Address,
  ): Promise<boolean> => {
    return await client.readContract({
      address: NativeCoinControl.address,
      abi: NativeCoinControl.abi,
      functionName: 'isBlocklisted',
      args: [account],
    })
  }
}