Call Workflow
Click items to navigate. Pan and zoom to explore.
The Big Picture
Root network validators earn emissions for voting on subnet allocations. These emissions accumulate as 'pending' until claimed. claim_root converts pending emissions to liquid TAO in your wallet. If you have auto-stake configured, they go directly to stake instead.
Why This Matters
Pending emissions aren't liquid - you can't transfer or use them until claimed. For validators who want to withdraw earnings, claim_root is how you access your root network rewards. Some prefer claiming and restaking manually for control over auto-stake.
Example Scenario
You're a root validator who's earned 50 TAO in pending emissions over the past week. Call claim_root(). Your pending emissions (50 TAO) transfer to your free balance. Now you can transfer, sell, or manually stake it.
Common Questions
- Do I need to claim regularly?
- Not strictly - emissions accumulate indefinitely. But pending emissions don't earn more emissions. Claim and restake (or use auto-stake) for compounding.
- What if I have auto-stake enabled?
- Depends on claim_type setting. With auto-stake, emissions might bypass claim_root entirely. Check set_root_claim_type for your configuration.
- Is there a minimum to claim?
- Possibly - check RootClaimThreshold. Very small amounts might not be claimable to avoid dust transactions. Accumulate until threshold is met.
Use Cases
- Withdraw accumulated root validator earnings
- Convert pending emissions to liquid TAO
- Claim rewards before transferring or selling
- Regular earnings withdrawal for validators
From Chain Metadata
Claims the root emissions for a coldkey.
Input Parameters
| # | Name | Type | Description |
|---|---|---|---|
| 0 | subnets | BTreeSet | subnets (BTreeSet) |
Permissions
Permission data inferred from metadata. May be incomplete.
Requirements
- Coldkey has unclaimed root emissions
- Claim threshold met (if any)
Effects
Events Emitted
Storage Modified
Postconditions
- Emissions distributed to coldkey
- Pending emissions cleared
- Balance increased by emission amount
Side Effects
- May auto-stake if configured
- Resets claim accumulator
Code Examples
// ----------------------------------------------------------------------
// HEADS UP: 1 arg below has a complex type with no usable default.
// Look for `undefined as any` and replace it with real value
// before running — the snippet compiles, but will fail at runtime as-is.
// ----------------------------------------------------------------------
import { createClient, Binary } from "polkadot-api";
import { getWsProvider } from "polkadot-api/ws";
import { sub } from "@polkadot-api/descriptors"; // generated by: npx papi add sub -w wss://entrypoint-finney.opentensor.ai:443
const client = createClient(getWsProvider("wss://entrypoint-finney.opentensor.ai:443"));
const api = client.getTypedApi(sub);
// Build claim_root call (typed, named args)
const subnets = undefined as any /* BTreeSet — replace with real value */;
const tx = api.tx.SubtensorModule.claim_root({
subnets,
});Runtime Info
View Source- Pallet Index
- 7
- Call Index
- 121
- First Version
- v334
- Current Version
- v411