Transactions

claim-root

Claim accumulated root dividends from one or more subnets.

View as Markdown

Pays out the signing coldkey's accrued root-stake dividends from the listed subnets. What the payout looks like depends on the coldkey's root claim type (see set_root_claim_type): swapped to TAO, kept as subnet alpha, or a per-subnet mix. At most 5 subnets per call — an empty or longer list fails with InvalidSubnetNumber. Subnets whose accrued dividends are below the per-subnet claim threshold (default 500,000 rao; adjustable by the subnet owner or root) are silently skipped while the transaction still succeeds. Unclaimed dividends simply keep accruing — there is no deadline — but each call pays out only the subnets listed.

SignerPalletWraps
coldkeySubtensorModuleSubtensorModule.claim_root

Parameters

ParameterTypeRequiredDescription
subnetsarray of integeryesNetuids to claim accumulated root dividends from; at most 5 per call.

Address parameters (--hotkey, --coldkey, --dest, ...) accept a raw ss58 address, an address-book or proxy-book name, or a local wallet/hotkey name.

CLI

Preview with --dry-run (shows fee, effects, and policy result without submitting), then submit:

btcli tx claim-root \
  --subnets <a,b,c> --dry-run
btcli tx claim-root \
  --subnets <a,b,c> -w my_coldkey

Python

import bittensor as sub
from bittensor.wallet import Wallet

wallet = Wallet(name="my_coldkey", hotkey="my_hotkey")
intent = sub.ClaimRoot(subnets=[...])

async with sub.Client("finney") as client:
    plan = await client.plan(intent, wallet)   # fee, effects, policy — no submission
    result = await client.execute(intent, wallet)
    if not result.success:
        print(result.error.code, result.error.remediation)

Or build it by op name, as an agent would:

await client.execute_tool("claim_root", {...}, wallet)