Helper function

Author: thewhaleking

bittensor/core/async_subtensor.py

@@ -98,6 +98,7 @@
     torch,
     u16_normalized_float,
     u64_normalized_float,
+    get_transfer_fn_params,
 )
 from bittensor.core.extrinsics.asyncex.liquidity import (
     add_liquidity_extrinsic,
@@ -3157,20 +3158,10 @@ async def get_transfer_fee(
         wallet has sufficient funds to cover both the transfer amount and the associated costs. This function provides
         a crucial tool for managing financial operations within the Bittensor network.
         """
-        call_params: dict[str, Union[int, str, bool]] = {"dest": dest}
-        if value is None:
-            call_function = "transfer_all"
-            if keep_alive:
-                call_params["keep_alive"] = True
-            else:
-                call_params["keep_alive"] = False
-        else:
+        if value is not None:
             value = check_and_convert_to_balance(value)
-            call_params["value"] = value.rao
-            if keep_alive:
-                call_function = "transfer_keep_alive"
-            else:
-                call_function = "transfer_allow_death"
+        call_params: dict[str, Union[int, str, bool]]
+        call_function, call_params = get_transfer_fn_params(value, dest, keep_alive)
 
         call = await self.substrate.compose_call(
             call_module="Balances",

bittensor/core/extrinsics/asyncex/transfer.py

@@ -6,6 +6,7 @@
     get_explorer_url_for_network,
     is_valid_bittensor_address_or_public_key,
     unlock_key,
+    get_transfer_fn_params,
 )
 from bittensor.utils.balance import Balance
 from bittensor.utils.btlogging import logging
@@ -45,19 +46,7 @@ async def _do_transfer(
     Returns:
         success, block hash, formatted error message
     """
-    call_params = {"dest": destination}
-    if amount is None:
-        call_function = "transfer_all"
-        if keep_alive:
-            call_params["keep_alive"] = True
-        else:
-            call_params["keep_alive"] = False
-    else:
-        call_params["value"] = amount.rao
-        if keep_alive:
-            call_function = "transfer_keep_alive"
-        else:
-            call_function = "transfer_allow_death"
+    call_function, call_params = get_transfer_fn_params(amount, destination, keep_alive)
 
     call = await subtensor.substrate.compose_call(
         call_module="Balances",

bittensor/core/extrinsics/transfer.py

@@ -5,6 +5,7 @@
     is_valid_bittensor_address_or_public_key,
     unlock_key,
     get_explorer_url_for_network,
+    get_transfer_fn_params,
 )
 from bittensor.utils.balance import Balance
 from bittensor.utils.btlogging import logging
@@ -44,19 +45,7 @@ def _do_transfer(
     Returns:
         success, block hash, formatted error message
     """
-    call_params = {"dest": destination}
-    if amount is None:
-        call_function = "transfer_all"
-        if keep_alive:
-            call_params["keep_alive"] = True
-        else:
-            call_params["keep_alive"] = False
-    else:
-        call_params["value"] = amount.rao
-        if keep_alive:
-            call_function = "transfer_keep_alive"
-        else:
-            call_function = "transfer_allow_death"
+    call_function, call_params = get_transfer_fn_params(amount, destination, keep_alive)
 
     call = subtensor.substrate.compose_call(
         call_module="Balances",

bittensor/core/subtensor.py

@@ -107,6 +107,7 @@
     u16_normalized_float,
     u64_normalized_float,
     deprecated_message,
+    get_transfer_fn_params,
 )
 from bittensor.utils.balance import (
     Balance,
@@ -2271,20 +2272,11 @@ def get_transfer_fee(
             has sufficient funds to cover both the transfer amount and the associated costs. This function provides a
             crucial tool for managing financial operations within the Bittensor network.
         """
-        call_params: dict[str, Union[int, str, bool]] = {"dest": dest}
-        if value is None:
-            call_function = "transfer_all"
-            if keep_alive:
-                call_params["keep_alive"] = True
-            else:
-                call_params["keep_alive"] = False
-        else:
+        if value is not None:
             value = check_and_convert_to_balance(value)
-            call_params["value"] = value.rao
-            if keep_alive:
-                call_function = "transfer_keep_alive"
-            else:
-                call_function = "transfer_allow_death"
+        call_params: dict[str, Union[int, str, bool]]
+        call_function, call_params = get_transfer_fn_params(value, dest, keep_alive)
+
         call = self.substrate.compose_call(
             call_module="Balances",
             call_function=call_function,

bittensor/utils/__init__.py

@@ -22,6 +22,7 @@
 
 if TYPE_CHECKING:
     from bittensor_wallet import Wallet
+    from bittensor.utils.balance import Balance
 
 BT_DOCS_LINK = "https://docs.bittensor.com"
 
@@ -445,3 +446,34 @@ def deprecated_message(message: str) -> None:
     """Shows a deprecation warning message with the given message."""
     warnings.simplefilter("default", DeprecationWarning)
     warnings.warn(message=message, category=DeprecationWarning, stacklevel=2)
+
+
+def get_transfer_fn_params(
+    amount: Optional["Balance"], destination: str, keep_alive: bool
+) -> tuple[str, dict[str, Union[str, int, bool]]]:
+    """
+    Helper function to get the transfer call function and call params, depending on the value and keep_alive flag
+        provided
+
+    Args:
+        amount: the amount of Tao to transfer. `None` if transferring all.
+        destination: the destination SS58 of the transfer
+        keep_alive: whether to enforce a retention of the existential deposit in the account after transfer.
+
+    Returns:
+        tuple[call function, call params]
+    """
+    call_params = {"dest": destination}
+    if amount is None:
+        call_function = "transfer_all"
+        if keep_alive:
+            call_params["keep_alive"] = True
+        else:
+            call_params["keep_alive"] = False
+    else:
+        call_params["value"] = amount.rao
+        if keep_alive:
+            call_function = "transfer_keep_alive"
+        else:
+            call_function = "transfer_allow_death"
+    return call_function, call_params