Retrieve the error reason that occurs during bulk transfer

app/model/db/bulk_transfer.py

@@ -62,3 +62,7 @@ class BulkTransfer(Base):
     amount: Mapped[int] = mapped_column(BigInteger, nullable=False)
     # processing status (pending:0, succeeded:1, failed:2)
     status: Mapped[int] = mapped_column(Integer, nullable=False, index=True)
+    # transaction error code
+    transaction_error_code: Mapped[int | None] = mapped_column(Integer, nullable=True)
+    # transaction error message
+    transaction_error_message: Mapped[str | None] = mapped_column(String, nullable=True)

app/model/schema/bulk_transfer.py

@@ -59,28 +59,34 @@ class IbetShareBulkTransferRequest(BaseModel):
 class BulkTransferUploadIdResponse(BaseModel):
     """bulk transfer upload id"""
 
-    upload_id: str
+    upload_id: str = Field(..., description="Upload id")
 
 
 class BulkTransferUploadResponse(BaseModel):
     """bulk transfer upload"""
 
-    upload_id: str
-    issuer_address: str
-    token_type: TokenType
-    transaction_compression: bool
-    status: int
-    created: str
+    upload_id: str = Field(..., description="Upload id")
+    issuer_address: str = Field(..., description="Issuer account address")
+    token_type: TokenType = Field(..., description="Token type")
+    transaction_compression: bool = Field(
+        ..., description="Transaction compression mode"
+    )
+    status: int = Field(..., description="Processing status")
+    created: str = Field(..., description="Upload created datetime (ISO8601)")
 
 
 class BulkTransferResponse(BaseModel):
     """bulk transfer data"""
 
-    upload_id: str
-    issuer_address: str
-    token_address: str
-    token_type: TokenType
-    from_address: str
-    to_address: str
-    amount: int
-    status: int
+    upload_id: str = Field(..., description="Upload id")
+    issuer_address: str = Field(..., description="Issuer account address")
+    token_address: str = Field(..., description="Token address")
+    token_type: TokenType = Field(..., description="Token type")
+    from_address: str = Field(..., description="Transfer source address")
+    to_address: str = Field(..., description="Transfer destination address")
+    amount: int = Field(..., description="Transfer amount")
+    status: int = Field(..., description="Transfer status")
+    transaction_error_code: int | None = Field(..., description="Transfer error code")
+    transaction_error_message: str | None = Field(
+        ..., description="Transfer error message"
+    )

app/routers/bond.py

@@ -3799,6 +3799,8 @@ def retrieve_bulk_transfer(
                 "to_address": _bulk_transfer.to_address,
                 "amount": _bulk_transfer.amount,
                 "status": _bulk_transfer.status,
+                "transaction_error_code": _bulk_transfer.transaction_error_code,
+                "transaction_error_message": _bulk_transfer.transaction_error_message,
             }
         )
 

app/routers/share.py

@@ -3791,6 +3791,8 @@ def retrieve_bulk_transfer(
                 "to_address": _bulk_transfer.to_address,
                 "amount": _bulk_transfer.amount,
                 "status": _bulk_transfer.status,
+                "transaction_error_code": _bulk_transfer.transaction_error_code,
+                "transaction_error_message": _bulk_transfer.transaction_error_message,
             }
         )
 

batch/processor_bulk_transfer.py

@@ -203,6 +203,8 @@ def process(self):
                                     db_session=db_session,
                                     record_id=_transfer.id,
                                     status=2,
+                                    transaction_error_code=e.code,
+                                    transaction_error_message=e.message,
                                 )
                         except SendTransactionError:
                             LOG.warning(
@@ -251,7 +253,11 @@ def process(self):
                                 f"Transaction reverted: id=<{_transfer.id}> error_code:<{e.code}> error_msg:<{e.message}>"
                             )
                             self.__sink_on_finish_transfer_process(
-                                db_session=db_session, record_id=_transfer.id, status=2
+                                db_session=db_session,
+                                record_id=_transfer.id,
+                                status=2,
+                                transaction_error_code=e.code,
+                                transaction_error_message=e.message,
                             )
                         except SendTransactionError:
                             LOG.warning(
@@ -405,12 +411,20 @@ def __sink_on_finish_upload_process(
 
     @staticmethod
     def __sink_on_finish_transfer_process(
-        db_session: Session, record_id: int, status: int
+        db_session: Session,
+        record_id: int,
+        status: int,
+        transaction_error_code: int = None,
+        transaction_error_message: str = None,
     ):
         db_session.execute(
             update(BulkTransfer)
             .where(BulkTransfer.id == record_id)
-            .values(status=status)
+            .values(
+                status=status,
+                transaction_error_code=transaction_error_code,
+                transaction_error_message=transaction_error_message,
+            )
         )
 
     @staticmethod

migrations/versions/beb9a0e876f8_v24_3_0_feature_585.py

@@ -0,0 +1,36 @@
+"""v24_3_0_feature_585
+
+Revision ID: beb9a0e876f8
+Revises: bf92fad9e779
+Create Date: 2024-01-16 17:28:12.921265
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+from app.database import get_db_schema
+
+# revision identifiers, used by Alembic.
+revision = "beb9a0e876f8"
+down_revision = "bf92fad9e779"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.add_column(
+        "bulk_transfer",
+        sa.Column("transaction_error_code", sa.Integer(), nullable=True),
+        schema=get_db_schema(),
+    )
+    op.add_column(
+        "bulk_transfer",
+        sa.Column("transaction_error_message", sa.String(), nullable=True),
+        schema=get_db_schema(),
+    )
+
+
+def downgrade():
+    op.drop_column("bulk_transfer", "transaction_error_message", schema=get_db_schema())
+    op.drop_column("bulk_transfer", "transaction_error_code", schema=get_db_schema())

tests/test_app_routers_bond_bulk_transfer_{upload_id}_GET.py

@@ -52,6 +52,7 @@ class TestAppRoutersBondBulkTransferGET:
     ###########################################################################
 
     # <Normal_1>
+    # Header: issuer-address is set
     def test_normal_1(self, client, db):
         # prepare data : Account(Issuer)
         for _issuer in self.upload_issuer_list:
@@ -99,11 +100,14 @@ def test_normal_1(self, client, db):
                 "to_address": self.upload_issuer_list[2]["address"],
                 "amount": 11,
                 "status": 1,
+                "transaction_error_code": None,
+                "transaction_error_message": None,
             }
         ]
         assert resp.json() == assumed_response
 
     # <Normal_2>
+    # Header: issuer-address is not set
     def test_normal_2(self, client, db):
         for i in range(0, 3):
             # prepare data : BulkTransferUpload
@@ -143,6 +147,58 @@ def test_normal_2(self, client, db):
                 "to_address": self.upload_issuer_list[2]["address"],
                 "amount": 10,
                 "status": 0,
+                "transaction_error_code": None,
+                "transaction_error_message": None,
+            }
+        ]
+        assert resp.json() == assumed_response
+
+    # <Normal_3>
+    # Bulk transaction error record
+    def test_normal_3(self, client, db):
+        # prepare data : BulkTransferUpload
+        bulk_transfer_upload = BulkTransferUpload()
+        bulk_transfer_upload.issuer_address = self.upload_issuer_list[0]["address"]
+        bulk_transfer_upload.upload_id = self.upload_id_list[0]
+        bulk_transfer_upload.token_type = TokenType.IBET_STRAIGHT_BOND.value
+        bulk_transfer_upload.status = 2
+        db.add(bulk_transfer_upload)
+
+        # prepare data : BulkTransfer
+        bulk_transfer = BulkTransfer()
+        bulk_transfer.issuer_address = self.upload_issuer_list[0]["address"]
+        bulk_transfer.upload_id = self.upload_id_list[0]
+        bulk_transfer.token_type = TokenType.IBET_STRAIGHT_BOND.value
+        bulk_transfer.token_address = self.bulk_transfer_token
+        bulk_transfer.from_address = self.upload_issuer_list[1]["address"]
+        bulk_transfer.to_address = self.upload_issuer_list[2]["address"]
+        bulk_transfer.amount = 10
+        bulk_transfer.status = 2
+        bulk_transfer.transaction_error_code = 120601
+        bulk_transfer.transaction_error_message = (
+            "Transfer amount is greater than from address balance."
+        )
+        db.add(bulk_transfer)
+
+        # request target API
+        resp = client.get(
+            self.test_url.format(self.upload_id_list[0]),
+        )
+
+        # assertion
+        assert resp.status_code == 200
+        assumed_response = [
+            {
+                "issuer_address": self.upload_issuer_list[0]["address"],
+                "token_type": TokenType.IBET_STRAIGHT_BOND.value,
+                "upload_id": self.upload_id_list[0],
+                "token_address": self.bulk_transfer_token,
+                "from_address": self.upload_issuer_list[1]["address"],
+                "to_address": self.upload_issuer_list[2]["address"],
+                "amount": 10,
+                "status": 2,
+                "transaction_error_code": 120601,
+                "transaction_error_message": "Transfer amount is greater than from address balance.",
             }
         ]
         assert resp.json() == assumed_response

tests/test_app_routers_share_bulk_transfer_{upload_id}_GET.py

@@ -52,6 +52,7 @@ class TestAppRoutersShareBulkTransferGET:
     ###########################################################################
 
     # <Normal_1>
+    # Header: issuer-address is set
     def test_normal_1(self, client, db):
         # prepare data : Account(Issuer)
         for _issuer in self.upload_issuer_list:
@@ -99,11 +100,14 @@ def test_normal_1(self, client, db):
                 "to_address": self.upload_issuer_list[2]["address"],
                 "amount": 11,
                 "status": 1,
+                "transaction_error_code": None,
+                "transaction_error_message": None,
             }
         ]
         assert resp.json() == assumed_response
 
     # <Normal_2>
+    # Header: issuer-address is not set
     def test_normal_2(self, client, db):
         for i in range(0, 3):
             # prepare data : BulkTransferUpload
@@ -143,6 +147,58 @@ def test_normal_2(self, client, db):
                 "to_address": self.upload_issuer_list[2]["address"],
                 "amount": 10,
                 "status": 0,
+                "transaction_error_code": None,
+                "transaction_error_message": None,
+            }
+        ]
+        assert resp.json() == assumed_response
+
+    # <Normal_3>
+    # Bulk transaction error record
+    def test_normal_3(self, client, db):
+        # prepare data : BulkTransferUpload
+        bulk_transfer_upload = BulkTransferUpload()
+        bulk_transfer_upload.issuer_address = self.upload_issuer_list[0]["address"]
+        bulk_transfer_upload.upload_id = self.upload_id_list[0]
+        bulk_transfer_upload.token_type = TokenType.IBET_SHARE.value
+        bulk_transfer_upload.status = 2
+        db.add(bulk_transfer_upload)
+
+        # prepare data : BulkTransfer
+        bulk_transfer = BulkTransfer()
+        bulk_transfer.issuer_address = self.upload_issuer_list[0]["address"]
+        bulk_transfer.upload_id = self.upload_id_list[0]
+        bulk_transfer.token_type = TokenType.IBET_SHARE.value
+        bulk_transfer.token_address = self.bulk_transfer_token
+        bulk_transfer.from_address = self.upload_issuer_list[1]["address"]
+        bulk_transfer.to_address = self.upload_issuer_list[2]["address"]
+        bulk_transfer.amount = 10
+        bulk_transfer.status = 2
+        bulk_transfer.transaction_error_code = 110503
+        bulk_transfer.transaction_error_message = (
+            "Transfer amount is greater than from address balance."
+        )
+        db.add(bulk_transfer)
+
+        # request target API
+        resp = client.get(
+            self.test_url.format(self.upload_id_list[0]),
+        )
+
+        # assertion
+        assert resp.status_code == 200
+        assumed_response = [
+            {
+                "issuer_address": self.upload_issuer_list[0]["address"],
+                "token_type": TokenType.IBET_SHARE.value,
+                "upload_id": self.upload_id_list[0],
+                "token_address": self.bulk_transfer_token,
+                "from_address": self.upload_issuer_list[1]["address"],
+                "to_address": self.upload_issuer_list[2]["address"],
+                "amount": 10,
+                "status": 2,
+                "transaction_error_code": 110503,
+                "transaction_error_message": "Transfer amount is greater than from address balance.",
             }
         ]
         assert resp.json() == assumed_response