feat(types): define types for height and round (#57)

Author: b00f

examples/example_transfer_transaction_bls.py

@@ -3,12 +3,13 @@
 from pactus.crypto.bls import PrivateKey
 from pactus.transaction import Transaction
 from pactus.types.amount import Amount
+from pactus.types.height import Height
 
 
 def main() -> None:
     HRP.use_testnet()
 
-    lock_time = 1_735_096
+    lock_time = Height(1_735_096)
     memo = "This is a test transaction"
     amount = Amount.from_string("1.5")
     fee = Amount.from_string("0.01")

examples/example_transfer_transaction_ed25519.py

@@ -3,12 +3,13 @@
 from pactus.crypto.ed25519 import PrivateKey
 from pactus.transaction import Transaction
 from pactus.types.amount import Amount
+from pactus.types.height import Height
 
 
 def main() -> None:
     HRP.use_testnet()
 
-    lock_time = 1_735_096
+    lock_time = Height(1_735_096)
     memo = "This is a test transaction"
     amount = Amount.from_string("1.5")
     fee = Amount.from_string("0.01")

pactus/transaction/transaction.py

@@ -95,7 +95,7 @@ def _get_unsigned_bytes(self, buf: bytes) -> bytes:
         """
         encoding.append_uint8(buf, self.flags)
         encoding.append_uint8(buf, self.version)
-        encoding.append_uint32(buf, self.lock_time)
+        encoding.append_uint32(buf, self.lock_time.value)
         encoding.append_var_int(buf, self.fee.value)
         encoding.append_str(buf, self.memo)
         encoding.append_uint8(buf, self.payload.get_type().value)

pactus/types/__init__.py

@@ -1,3 +1,5 @@
 from .amount import Amount
+from .height import Height
+from .round import Round
 
-__all__ = ["Amount"]
+__all__ = ["Amount", "Height", "Round"]

pactus/types/height.py

@@ -0,0 +1,22 @@
+class Height:
+    """
+    Height represents a block height in the Pactus blockchain.
+
+    It encapsulates a raw integer value representing a block height.
+    It can be used for transaction lock times.
+    """
+
+    def __init__(self, value: int = 0) -> None:
+        self.value = value
+
+    def __eq__(self, other: "Height") -> bool:
+        if isinstance(other, Height):
+            return self.value == other.value
+
+        return False
+
+    def __hash__(self) -> int:
+        return hash(self.value)
+
+    def __str__(self) -> str:
+        return str(self.value)

pactus/types/round.py

@@ -0,0 +1,21 @@
+class Round:
+    """
+    Round represents a consensus round in the Pactus blockchain.
+
+    It encapsulates a raw integer value representing a round number.
+    """
+
+    def __init__(self, value: int = 0) -> None:
+        self.value = value
+
+    def __eq__(self, other: "Round") -> bool:
+        if isinstance(other, Round):
+            return self.value == other.value
+
+        return False
+
+    def __hash__(self) -> int:
+        return hash(self.value)
+
+    def __str__(self) -> str:
+        return str(self.value)

tests/test_transaction.py

@@ -4,6 +4,7 @@
 from pactus.crypto.bls import PrivateKey
 from pactus.transaction import Transaction
 from pactus.types.amount import Amount
+from pactus.types.height import Height
 
 
 class TestTransaction(unittest.TestCase):
@@ -14,7 +15,7 @@ def test_sign_transfer(self):
         receiver = Address.from_string("pc1zt6qcdymkk48c5ds0fzfsaf6puwu8w8djn3ffpn")
         amount = Amount.from_pac(1.0)  # 1 PAC
         fee = Amount.from_pac(0.001)  # 0.001 PAC
-        lock_time = 0x123456
+        lock_time = Height(0x123456)
         memo = "test"
 
         tx = Transaction.create_transfer_tx(