import re
from typing import final, override
from erc7730.common.abi import compute_paths, function_to_selector, reduce_signature, signature_to_selector
from erc7730.common.output import OutputAdder
from erc7730.lint import ERC7730Linter
from erc7730.lint.common.paths import compute_eip712_paths, compute_format_paths
from erc7730.model.resolved.context import EIP712JsonSchema, ResolvedContractContext, ResolvedEIP712Context
from erc7730.model.resolved.descriptor import ResolvedERC7730Descriptor
AUTHORIZED_MISSING_DISPLAY_FIELDS_REGEX = {r"(.+\.)?nonce"}
[docs]
@final
class ValidateDisplayFieldsLinter(ERC7730Linter):
"""
- for each field of schema/ABI, check that there is a display field
- for each field, check that display configuration is relevant with field type
"""
[docs]
@override
def lint(self, descriptor: ResolvedERC7730Descriptor, out: OutputAdder) -> None:
self._validate_eip712_paths(descriptor, out)
self._validate_abi_paths(descriptor, out)
@classmethod
def _validate_eip712_paths(cls, descriptor: ResolvedERC7730Descriptor, out: OutputAdder) -> None:
if isinstance(descriptor.context, ResolvedEIP712Context) and descriptor.context.eip712.schemas is not None:
primary_types: set[str] = set()
for schema in descriptor.context.eip712.schemas:
if isinstance(schema, EIP712JsonSchema):
primary_types.add(schema.primaryType)
if schema.primaryType not in schema.types:
out.error(
title="Invalid EIP712 Schema",
message=f"Primary type `{schema.primaryType}` is not present in schema types. Please make "
f"sure the EIP-712 includes a definition for the primary type.",
)
continue
if schema.primaryType not in descriptor.display.formats:
out.error(
title="Missing Display field",
message=f"Schema primary type `{schema.primaryType}` must have a display format defined.",
)
continue
eip712_paths = compute_eip712_paths(schema)
primary_type_format = descriptor.display.formats[schema.primaryType]
format_paths = compute_format_paths(primary_type_format).data_paths
excluded = primary_type_format.excluded or []
for path in eip712_paths - format_paths:
allowed = False
for excluded_path in excluded:
if path.startswith(excluded_path):
allowed = True
break
if allowed:
continue
if any(re.fullmatch(regex, path) for regex in AUTHORIZED_MISSING_DISPLAY_FIELDS_REGEX):
out.debug(
title="Optional Display field missing",
message=f"Display field for path `{path}` is missing for message {schema.primaryType}. "
f"If intentionally excluded, please add it to `excluded` list to avoid this "
f"warning.",
)
else:
out.warning(
title="Missing Display field",
message=f"Display field for path `{path}` is missing for message {schema.primaryType}. "
f"If intentionally excluded, please add it to `excluded` list to avoid this "
f"warning.",
)
for path in format_paths - eip712_paths:
out.error(
title="Extra Display field",
message=f"Display field for path `{path}` is not in message {schema.primaryType}. Please "
f"check the field path is valid according to the EIP-712 schema.",
)
else:
out.error(
title="Missing EIP712 Schema",
message=f"EIP712 Schema is missing (found {schema})",
)
for fmt in descriptor.display.formats:
if fmt not in primary_types:
out.error(
title="Invalid Display field",
message=f"Format message `{fmt}` is not in EIP712 schemas. Please check the field path is "
f"valid according to the EIP-712 schema.",
)
@classmethod
def _display(cls, selector: str, keccak: str) -> str:
return selector if selector == keccak else f"`{keccak}/{selector}`"
@classmethod
def _validate_abi_paths(cls, descriptor: ResolvedERC7730Descriptor, out: OutputAdder) -> None:
if isinstance(descriptor.context, ResolvedContractContext):
abi_paths_by_selector: dict[str, set[str]] = {}
for abi in descriptor.context.contract.abi:
if abi.type == "function":
abi_paths_by_selector[function_to_selector(abi)] = compute_paths(abi)
for selector, fmt in descriptor.display.formats.items():
keccak = selector
if not selector.startswith("0x"):
if (reduced_signature := reduce_signature(selector)) is not None:
keccak = signature_to_selector(reduced_signature)
else:
out.error(
title="Invalid selector",
message=f"Selector {cls._display(selector, keccak)} is not a valid function signature.",
)
continue
if keccak not in abi_paths_by_selector:
out.error(
title="Invalid selector",
message=f"Selector {cls._display(selector, keccak)} not found in ABI.",
)
continue
format_paths = compute_format_paths(fmt).data_paths
abi_paths = abi_paths_by_selector[keccak]
excluded = fmt.excluded or []
function = cls._display(selector, keccak)
for path in abi_paths - format_paths:
allowed = False
for excluded_path in excluded:
if path.startswith(excluded_path):
allowed = True
break
if allowed:
continue
if not any(re.fullmatch(regex, path) for regex in AUTHORIZED_MISSING_DISPLAY_FIELDS_REGEX):
out.debug(
title="Optional Display field missing",
message=f"Display field for path `{path}` is missing for selector {function}. If "
f"intentionally excluded, please add it to `excluded` list to avoid this warning.",
)
else:
out.warning(
title="Missing Display field",
message=f"Display field for path `{path}` is missing for selector {function}. If "
f"intentionally excluded, please add it to `excluded` list to avoid this warning.",
)
for path in format_paths - abi_paths:
out.error(
title="Invalid Display field",
message=f"Display field for path `{path}` is not in selector {function}.",
)
