From 11132a6ad4203c93eb058ee963c5c5779b28833e Mon Sep 17 00:00:00 2001 From: Nathan_akin <85641756+akintewe@users.noreply.github.com> Date: Mon, 25 Nov 2024 11:42:47 +0100 Subject: [PATCH] style: format serializer files with black --- .../data_parser/serializers/__init__.py | 36 ++++ .../data_parser/serializers/nostra.py | 199 ++++++++++++++++++ .../data_parser/serializers/zklend.py | 189 +++++++++++++++++ 3 files changed, 424 insertions(+) create mode 100644 apps/data_handler/handler_tools/data_parser/serializers/__init__.py create mode 100644 apps/data_handler/handler_tools/data_parser/serializers/nostra.py create mode 100644 apps/data_handler/handler_tools/data_parser/serializers/zklend.py diff --git a/apps/data_handler/handler_tools/data_parser/serializers/__init__.py b/apps/data_handler/handler_tools/data_parser/serializers/__init__.py new file mode 100644 index 00000000..3c32798e --- /dev/null +++ b/apps/data_handler/handler_tools/data_parser/serializers/__init__.py @@ -0,0 +1,36 @@ +from .nostra import ( + DebtMintEventData, + DebtBurnEventData, + InterestRateModelEventData, + DebtTransferEventData, + BearingCollateralMintEventData, + BearingCollateralBurnEventData, +) + +from .zklend import ( + AccumulatorsSyncEventData, + BorrowingEventData, + RepaymentEventData, + DepositEventData, + LiquidationEventData, + WithdrawalEventData, + CollateralEnabledDisabledEventData, +) + +__all__ = [ + # Nostra serializers + "DebtMintEventData", + "DebtBurnEventData", + "InterestRateModelEventData", + "DebtTransferEventData", + "BearingCollateralMintEventData", + "BearingCollateralBurnEventData", + # zkLend serializers + "AccumulatorsSyncEventData", + "BorrowingEventData", + "RepaymentEventData", + "DepositEventData", + "LiquidationEventData", + "WithdrawalEventData", + "CollateralEnabledDisabledEventData", +] diff --git a/apps/data_handler/handler_tools/data_parser/serializers/nostra.py b/apps/data_handler/handler_tools/data_parser/serializers/nostra.py new file mode 100644 index 00000000..86fc349a --- /dev/null +++ b/apps/data_handler/handler_tools/data_parser/serializers/nostra.py @@ -0,0 +1,199 @@ +from decimal import Decimal +from pydantic import BaseModel, ValidationInfo, field_validator +from shared.helpers import add_leading_zeros + + +class DebtMintEventData(BaseModel): + """ + Data model representing a debt mint event in the system. + + Attributes: + user: The user address for whom debt is being minted. + amount: The amount of debt being minted as a Decimal. + """ + + user: str + amount: Decimal + + @field_validator("user") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + if not value.startswith("0x"): + raise ValueError(f"Invalid address provided for {info.field_name}") + return add_leading_zeros(value) + + +class DebtBurnEventData(BaseModel): + """ + Data model representing a debt burn event in the system. + + Attributes: + user: The user address for whom debt is being burned. + amount: The amount of debt being burned as a Decimal. + """ + + user: str + amount: Decimal + + @field_validator("user") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + if not value.startswith("0x"): + raise ValueError(f"Invalid address provided for {info.field_name}") + return add_leading_zeros(value) + + +class InterestRateModelEventData(BaseModel): + """ + Data model representing an interest rate model event in the system. + + Attributes: + debt_token: The debt token address. + lending_index: The lending index value as a Decimal. + borrow_index: The borrowing index value as a Decimal. + """ + + debt_token: str + lending_index: Decimal + borrow_index: Decimal + + @field_validator("debt_token") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + if not value.startswith("0x"): + raise ValueError(f"Invalid address provided for {info.field_name}") + return add_leading_zeros(value) + + +class DebtTransferEventData(BaseModel): + """ + Data model representing a debt transfer event in the system. + + Attributes: + sender: The address of the sender. + recipient: The address of the recipient. + amount: The amount being transferred as a Decimal. + """ + + sender: str + recipient: str + amount: Decimal + + @field_validator("sender", "recipient") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + if not value.startswith("0x"): + raise ValueError(f"Invalid address provided for {info.field_name}") + return add_leading_zeros(value) + + +class BearingCollateralMintEventData(BaseModel): + """ + Data model representing a bearing collateral mint event in the system. + + Attributes: + user: The user address for whom collateral is being minted. + amount: The amount of collateral being minted as a Decimal. + """ + + user: str + amount: Decimal + + @field_validator("user") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + if not value.startswith("0x"): + raise ValueError(f"Invalid address provided for {info.field_name}") + return add_leading_zeros(value) + + +class BearingCollateralBurnEventData(BaseModel): + """ + Data model representing a bearing collateral burn event in the system. + + Attributes: + user: The user address for whom collateral is being burned. + amount: The amount of collateral being burned as a Decimal. + """ + + user: str + amount: Decimal + + @field_validator("user") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + if not value.startswith("0x"): + raise ValueError(f"Invalid address provided for {info.field_name}") + return add_leading_zeros(value) diff --git a/apps/data_handler/handler_tools/data_parser/serializers/zklend.py b/apps/data_handler/handler_tools/data_parser/serializers/zklend.py new file mode 100644 index 00000000..9a732991 --- /dev/null +++ b/apps/data_handler/handler_tools/data_parser/serializers/zklend.py @@ -0,0 +1,189 @@ +from decimal import Decimal +from pydantic import BaseModel, ValidationInfo, field_validator +from shared.helpers import add_leading_zeros + + +class AccumulatorsSyncEventData(BaseModel): + """ + Data model representing an accumulators sync event in the system. + + Attributes: + token: The token address involved in the sync. + lending_accumulator: The lending accumulator value as a string. + debt_accumulator: The debt accumulator value as a string. + """ + + token: str + lending_accumulator: str + debt_accumulator: str + + @field_validator("token") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + + +class LiquidationEventData(BaseModel): + """ + Data model representing a liquidation event in the system. + + Attributes: + liquidator: The address of the liquidator. + user: The address of the user being liquidated. + debt_token: The address of the debt token. + debt_raw_amount: The raw amount of debt as a string. + debt_face_amount: The face amount of debt as a string. + collateral_token: The address of the collateral token. + collateral_amount: The amount of collateral as a string. + """ + + liquidator: str + user: str + debt_token: str + debt_raw_amount: str + debt_face_amount: str + collateral_token: str + collateral_amount: str + + @field_validator("liquidator", "user", "debt_token", "collateral_token") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + + +class WithdrawalEventData(BaseModel): + """ + Data model representing a withdrawal event in the system. + + Attributes: + user: The user address making the withdrawal. + token: The token address being withdrawn. + amount: The amount being withdrawn as a string. + """ + + user: str + token: str + amount: str + + @field_validator("user", "token") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + + +class BorrowingEventData(BaseModel): + """ + Data model representing a borrowing event in the system. + + Attributes: + user: The user address making the borrowing. + token: The token address being borrowed. + raw_amount: The raw amount being borrowed as a string. + face_amount: The face amount being borrowed as a string. + """ + + user: str + token: str + raw_amount: str + face_amount: str + + @field_validator("user", "token") + def validate_address(cls, value: str, info: ValidationInfo) -> str: + """ + Validates if the value is a valid address and formats it to have leading zeros. + + Args: + value (str): The address string to validate. + info (ValidationInfo): Validation context information. + + Raises: + ValueError: If the provided address is invalid. + + Returns: + str: Formatted address with leading zeros. + """ + if not value.startswith("0x"): + raise ValueError(f"Invalid address provided for {info.field_name}") + return add_leading_zeros(value) + + +class RepaymentEventData(BaseModel): + """ + Data model representing a repayment event in the system. + + Attributes: + repayer: The address of the repayer. + beneficiary: The address of the beneficiary. + token: The token address being repaid. + raw_amount: The raw amount being repaid as a string. + face_amount: The face amount being repaid as a string. + """ + + repayer: str + beneficiary: str + token: str + raw_amount: str + face_amount: str + + +class DepositEventData(BaseModel): + """ + Data model representing a deposit event in the system. + + Attributes: + user: The user address making the deposit. + token: The token address being deposited. + face_amount: The face amount being deposited as a string. + """ + + user: str + token: str + face_amount: str + + +class CollateralEnabledDisabledEventData(BaseModel): + """ + Data model representing a collateral enabled/disabled event in the system. + + Attributes: + user: The user address for whom collateral is being enabled/disabled. + token: The token address being enabled/disabled as collateral. + enabled: Boolean indicating if collateral is being enabled (True) or disabled (False). + """ + + user: str + token: str + enabled: bool