Added commnets throughtout unstaking script

Author: Josh Earlenbaugh

docs/staking-and-delegation/managing-stake-sdk.md

@@ -247,6 +247,47 @@ import bittensor as bt
 import bittensor_wallet
 from bittensor import tao
 
+<<<<<<< HEAD
+=======
+# Load environmental variables
+wallet_name = os.environ.get('WALLET')
+total_to_unstake = os.environ.get('TOTAL_TAO_TO_UNSTAKE')
+max_stakes_to_unstake = os.environ.get('MAX_STAKES_TO_UNSTAKE')
+
+# Basic input validation for wallet and TAO amount
+if wallet_name is None:
+    sys.exit("wallet name not specified. Usage: `TOTAL_TAO_TO_UNSTAKE=1 MAX_STAKES_TO_UNSTAKE=10 WALLET=my-wallet-name ./unstakerscript.py`")
+
+if total_to_unstake is None:
+    print("Unstaking total not specified, defaulting to 1 TAO.")
+    total_to_unstake = 1
+else:
+    try:
+        total_to_unstake = float(total_to_unstake)
+    except:
+        sys.exit("invalid TAO amount!")
+
+if max_stakes_to_unstake is None:
+    max_stakes_to_unstake = 10
+else:
+    try:
+        max_stakes_to_unstake = int(max_stakes_to_unstake)
+    except:
+        sys.exit("invalid number for MAX_STAKES_TO_UNSTAKE")
+
+# Print summary for configuration
+print(f"🔍 Using wallet: {wallet_name}")
+print(f"🧮 Unstaking a total of {total_to_unstake} TAO across up to {max_stakes_to_unstake} lowest-emission validators")
+
+# Initialize Bittensor wallet and balamce object
+total_to_unstake = bt.Balance.from_tao(total_to_unstake)
+wallet = bt.wallet(wallet_name)
+wallet_ck = wallet.coldkeypub.ss58_address
+
+unstake_minimum = 0.0005  # TAO
+
+# Async helper to perform the actual unstake call
+>>>>>>> 84a50fd (Added commnets throughtout unstaking script)
 async def perform_unstake(subtensor, stake, amount):
     try:
         print(f"⏳ Attempting to unstake {amount} from {stake.hotkey_ss58} on subnet {stake.netuid}")
@@ -255,6 +296,8 @@ async def perform_unstake(subtensor, stake, amount):
             wallet, hotkey_ss58=stake.hotkey_ss58, netuid=stake.netuid, amount=amount
         )
         elapsed = time.time() - start
+
+        # Check result object and log outcome
         if result:
             print(f"✅ Successfully unstaked {amount} from {stake.hotkey_ss58} on subnet {stake.netuid} in {elapsed:.2f}s")
             return True
@@ -265,38 +308,50 @@ async def perform_unstake(subtensor, stake, amount):
         print(f"❌ Error during unstake from {stake.hotkey_ss58} on subnet {stake.netuid}: {e}")
         return False
 
-
+# Main async workflow
 async def main():
+    # Use the async_subtensor context manager to interact with the chain
     async with bt.async_subtensor(network='test') as subtensor:
         try:
+            #Retrive all active active stakes asscociated with the coldkey
             stakes = await subtensor.get_stake_for_coldkey(wallet_ck)
         except Exception as e:
             sys.exit(f"❌ Failed to get stake info: {e}")
 
-        # Filter and sort
+        # Filter: Remove small stakes that are under the minimum threshold
         stakes = list(filter(lambda s: float(s.stake.tao) > unstake_minimum, stakes))
+
+        # Sort by emission rate (lowest emission first)
         stakes = sorted(stakes, key=lambda s: s.emission.tao)
+
+        # Limit to the N lowest emission validators
         stakes = stakes[:max_stakes_to_unstake]
 
         if not stakes:
             sys.exit("❌ No eligible stakes found to unstake.")
 
+        # Print a summary of selected stakes before executint
         print(f"\n📊 Preparing to unstake from {len(stakes)} validators:\n")
         for s in stakes:
             print(f"Validator: {s.hotkey_ss58}\n  NetUID: {s.netuid}\n  Stake: {s.stake}\n  Emission: {s.emission}\n-----------")
 
-        # Prepare concurrent unstake tasks
+        # Determine how much TAO to unstake per validator
         amount_per_stake = total_to_unstake / len(stakes)
+
+        # Prepare all unstake calls to run concurrently
         tasks = [
             perform_unstake(subtensor, stake, min(amount_per_stake, stake.stake))
             for stake in stakes
         ]
 
+        # Execute unstatke tasks concurrently using ayncio
         results = await asyncio.gather(*tasks)
-        success_count = sum(results)
 
+        # Count successes and print final report
+        success_count = sum(results)
         print(f"\n🎯 Unstake complete. Success: {success_count}/{len(stakes)}")
 
+<<<<<<< HEAD
 wallet_name = os.environ.get('WALLET')
 total_to_unstake = os.environ.get('TOTAL_TAO_TO_UNSTAKE')
 max_stakes_to_unstake = os.environ.get('MAX_STAKES_TO_UNSTAKE')
@@ -331,6 +386,9 @@ wallet_ck = wallet.coldkeypub.ss58_address
 # There is a global on-chain minimum balanced allowed for unstaking operations.
 unstake_minimum = 0.0005
 
+=======
+# Run the async workflow
+>>>>>>> 84a50fd (Added commnets throughtout unstaking script)
 asyncio.run(main())
 
 ```