Merge pull request #5 from LedgerHQ/doc

chore: classifier doc/cleanup

src/erc7730/linter/common/display_format_checker.py → src/erc7730/display_format_checker/__init__.py

@@ -14,6 +14,12 @@ def _fields_contain(word: str, fields: set[str]) -> bool:
 
 
 class DisplayFormatChecker:
+    """
+    Given a transaction class and a display formats, check if all the required fields of a given
+    transaction class are being displayed.
+    If a field is missing emit an error.
+    """
+
     def __init__(self, c: TxClass, d: Display):
         self.c = c
         self.d = d

src/erc7730/linter/classifier/__init__.py

@@ -16,6 +16,11 @@ class TxClass(StrEnum):
 
 
 class Classifier(ABC, Generic[Schema]):
+    """
+    Given a schema (which is an EIP712 schema or an ABI schema), classify the transaction type
+    with some predefined ruleset.
+    """
+
     @abstractmethod
     def classify(self, schema: Schema) -> TxClass | None:
         raise NotImplementedError()

src/erc7730/linter/classifier/abi_classifier.py

@@ -6,6 +6,11 @@
 
 
 class ABIClassifier(Classifier[AbiJsonSchema]):
+    """
+    Given an EIP712 schema, classify the transaction type with some predefined ruleset.
+    (not implemented)
+    """
+
     @override
     def classify(self, schema: AbiJsonSchema) -> TxClass | None:
         pass

src/erc7730/linter/classifier/eip712_classifier.py

@@ -6,6 +6,11 @@
 
 
 class EIP712Classifier(Classifier[EIP712JsonSchema]):
+    """
+    Given an EIP712 schema, classify the transaction type with some predefined ruleset.
+    (implemented a basic detection of a permit)
+    """
+
     @override
     def classify(self, schema: EIP712JsonSchema) -> TxClass | None:
         if "permit" in schema.primaryType.lower():

src/erc7730/linter/linter_transaction_type_classifier_ai.py

@@ -1,6 +1,6 @@
 from erc7730.linter.classifier.abi_classifier import ABIClassifier
 from erc7730.linter.classifier.eip712_classifier import EIP712Classifier
-from erc7730.linter.common.display_format_checker import DisplayFormatChecker
+from erc7730.display_format_checker import DisplayFormatChecker
 from erc7730.linter import ERC7730Linter
 from erc7730.model.context import EIP712Context, ContractContext, EIP712JsonSchema
 from erc7730.model.display import Display