Fix the name of unlock data schema

BoostryJP · Oct 31, 2024 · d5509f1 · d5509f1
1 parent c6d0255
commit d5509f1
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 21 deletions.
diff --git a/app/model/db/__init__.py b/app/model/db/__init__.py
@@ -71,10 +71,10 @@
     IDXPositionShareBlockNumber,
 )
 from .idx_transfer import (
+    DataMessage,
     IDXTransfer,
     IDXTransferBlockNumber,
     IDXTransferSourceEventType,
-    UnlockData,
 )
 from .idx_transfer_approval import (
     IDXTransferApproval,

diff --git a/app/model/db/idx_transfer.py b/app/model/db/idx_transfer.py
@@ -35,7 +35,7 @@ class IDXTransferSourceEventType(StrEnum):
     UNLOCK = "Unlock"
 
 
-class UnlockData(BaseModel):
+class DataMessage(BaseModel):
     message: Literal[
         "garnishment",
         "inheritance",
@@ -65,7 +65,7 @@ class IDXTransfer(Base):
     #   source_event = "Transfer"
     #     => None
     #   source_event = "Unlock"
-    #     =>  UnlockData
+    #     =>  DataMessage
     data: Mapped[dict | None] = mapped_column(JSON)
     # Message
     #   source_event = "Transfer"

diff --git a/app/model/schema/transfer.py b/app/model/schema/transfer.py
@@ -69,7 +69,7 @@ class Transfer(TransferBase):
     data: None = Field(description="Event data")
 
 
-class UnlockData(BaseModel):
+class DataMessage(BaseModel):
     message: Literal[
         "garnishment",
         "inheritance",
@@ -81,7 +81,7 @@ class UnlockTransfer(TransferBase):
     source_event: Literal[TransferSourceEventType.Unlock] = Field(
         description="Source Event"
     )
-    data: UnlockData | dict = Field(description="Event data")
+    data: DataMessage | dict = Field(description="Event data")
 
 
 ############################

diff --git a/batch/indexer_transfer.py b/batch/indexer_transfer.py
@@ -35,11 +35,11 @@
 from app.exceptions import ServiceUnavailableError
 from app.model.db import (
     Account,
+    DataMessage,
     IDXTransfer,
     IDXTransferBlockNumber,
     IDXTransferSourceEventType,
     Token,
-    UnlockData,
 )
 from app.utils.contract_utils import AsyncContractUtils
 from app.utils.web3_utils import AsyncWeb3Wrapper
@@ -286,7 +286,7 @@ async def __sink_on_transfer(
         if data_str is not None:
             try:
                 data = json.loads(data_str)
-                validated_data = UnlockData(**data)
+                validated_data = DataMessage(**data)
                 message = validated_data.message
             except ValidationError:
                 data = {}

diff --git a/docs/ibet_prime.yaml b/docs/ibet_prime.yaml
@@ -11153,6 +11153,19 @@ components:
         - notice_type
         - metainfo
       title: DVPDeliveryInfoNotification
+    DataMessage:
+      properties:
+        message:
+          type: string
+          enum:
+            - garnishment
+            - inheritance
+            - force_unlock
+          title: Message
+      type: object
+      required:
+        - message
+      title: DataMessage
     DeliveryStatus:
       type: integer
       enum:
@@ -15422,19 +15435,6 @@ components:
       allOf:
         - $ref: '#/components/schemas/TxDataDetail'
       title: TxDataResponse
-    UnlockData:
-      properties:
-        message:
-          type: string
-          enum:
-            - garnishment
-            - inheritance
-            - force_unlock
-          title: Message
-      type: object
-      required:
-        - message
-      title: UnlockData
     UnlockInfoMetaInfo:
       properties:
         token_address:
@@ -15542,7 +15542,7 @@ components:
           description: Source Event
         data:
           anyOf:
-            - $ref: '#/components/schemas/UnlockData'
+            - $ref: '#/components/schemas/DataMessage'
             - type: object
           title: Data
           description: Event data