feat: validator tree traversal, primed column, prime-all command #270
Conversation
Shows raw unfiltered pending deposits/withdrawals and current epoch for debugging stake visibility issues.
- Traverse validatorsRoot tree to find ALL validators (including unprimed) - Add separate Primed column showing epoch and needs-priming status - Remove prime! from Status column (now in dedicated column)
Iterates through validator tree and attempts to prime each validator that needs priming. Continues on failure for max resilience.
WalkthroughThis PR adds validator priming capabilities to the staking CLI. New commands Changes
Sequence DiagramsequenceDiagram
participant User
participant CLI as CLI Handler
participant VAP as ValidatorPrimeAction
participant SA as StakingAction
participant Tree as Validator Tree Contract
participant Client as Staking Client
User->>CLI: prime-all
CLI->>VAP: primeAll(options)
activate VAP
VAP->>SA: getAllValidatorsFromTree(config)
activate SA
SA->>Tree: read validatorsRoot
loop Tree Traversal
SA->>Tree: read validatorView(node)
Tree-->>SA: left/right children
end
SA-->>VAP: all validator addresses
deactivate SA
loop For Each Validator
VAP->>Client: validatorPrime(address)
alt Success
Client-->>VAP: transactionHash
VAP->>User: ✓ Primed (green)
else Failure
Client-->>VAP: error
VAP->>User: ✗ Skipped (gray)
end
end
VAP-->>User: Summary (N primed, M skipped)
deactivate VAP
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
src/commands/staking/StakingAction.ts (1)
212-265: Consider adding error handling and potential batching for tree traversal.The tree traversal logic is correct, but there are a few considerations:
Sequential RPC calls: Each node requires an RPC call to fetch
validatorView. For large validator sets, this could be slow and may hit rate limits.No error handling for individual node reads: If a single
readContractcall fails (e.g., network hiccup), the entire traversal fails. Consider catching errors per-node to improve resilience.Potential memory consideration: The
visitedset andvalidatorsarray grow unbounded, though this is unlikely to be an issue for realistic validator counts.🔎 Optional: Add per-node error handling for resilience
while (stack.length > 0) { const addr = stack.pop()!; if (addr === ZeroAddress || visited.has(addr.toLowerCase())) continue; visited.add(addr.toLowerCase()); validators.push(addr as Address); + try { const info = await publicClient.readContract({ address: stakingAddress as `0x${string}`, abi: abi.STAKING_ABI, functionName: "validatorView", args: [addr as `0x${string}`], }) as {left: string; right: string}; if (info.left !== ZeroAddress) { stack.push(info.left); } if (info.right !== ZeroAddress) { stack.push(info.right); } + } catch (error) { + // Log warning but continue traversal - node is already added to validators + console.warn(`Warning: Failed to read validator tree node ${addr}`); + } }src/commands/staking/validatorPrime.ts (1)
53-65: Consider adding rate limiting for large validator sets.When priming many validators, rapid sequential RPC calls could potentially hit rate limits on the RPC endpoint. This might be worth considering for production use with large validator sets.
🔎 Optional: Add a small delay between calls
for (const addr of allValidators) { process.stdout.write(` ${addr} ... `); try { const result = await client.validatorPrime({validator: addr}); console.log(chalk.green(`primed ${result.transactionHash}`)); succeeded++; } catch (error: any) { const msg = error.message || String(error); const shortErr = msg.length > 60 ? msg.slice(0, 57) + "..." : msg; console.log(chalk.gray(`skipped: ${shortErr}`)); skipped++; } + // Optional: small delay to avoid rate limiting + // await new Promise(resolve => setTimeout(resolve, 100)); }src/commands/staking/stakingInfo.ts (1)
509-523: Minor: Missing semicolon on line 522.The pending deposits/withdrawals logic is correct. Note the missing semicolon on line 522, though ASI handles it.
🔎 Apply this diff to add the missing semicolon:
} else if (pendingWithdrawSum > 0n) { - pendingStr = chalk.red(`-${formatStake(`${Number(pendingWithdrawSum) / 1e18} GEN`)}`) + pendingStr = chalk.red(`-${formatStake(`${Number(pendingWithdrawSum) / 1e18} GEN`)}`); }
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
README.md(2 hunks)docs/validator-guide.md(2 hunks)src/commands/staking/StakingAction.ts(3 hunks)src/commands/staking/index.ts(2 hunks)src/commands/staking/stakingInfo.ts(9 hunks)src/commands/staking/validatorPrime.ts(2 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
src/commands/**/*.ts
📄 CodeRabbit inference engine (CLAUDE.md)
All CLI action classes must extend
BaseActionfromsrc/lib/actions/BaseAction.tswhich provides GenLayer client initialization, keystore management, spinner/logging utilities, and user prompts
Files:
src/commands/staking/stakingInfo.tssrc/commands/staking/validatorPrime.tssrc/commands/staking/StakingAction.tssrc/commands/staking/index.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (CLAUDE.md)
Use
@/*path alias to reference./src/*and@@/tests/*path alias to reference./tests/*in imports
Files:
src/commands/staking/stakingInfo.tssrc/commands/staking/validatorPrime.tssrc/commands/staking/StakingAction.tssrc/commands/staking/index.ts
src/commands/*/index.ts
📄 CodeRabbit inference engine (CLAUDE.md)
Commands must be organized in
src/commands/<domain>/index.tswith each file exporting aninitialize*Commands(program)function
Files:
src/commands/staking/index.ts
🧠 Learnings (1)
📚 Learning: 2025-12-03T23:03:32.323Z
Learnt from: CR
Repo: genlayerlabs/genlayer-cli PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-03T23:03:32.323Z
Learning: Applies to src/commands/**/*.ts : All CLI action classes must extend `BaseAction` from `src/lib/actions/BaseAction.ts` which provides GenLayer client initialization, keystore management, spinner/logging utilities, and user prompts
Applied to files:
src/commands/staking/StakingAction.ts
🧬 Code graph analysis (3)
src/commands/staking/validatorPrime.ts (1)
src/commands/staking/StakingAction.ts (1)
StakingConfig(23-28)
src/commands/staking/StakingAction.ts (1)
templates/default/tools/types.py (1)
Address(11-83)
src/commands/staking/index.ts (2)
src/commands/staking/StakingAction.ts (1)
StakingConfig(23-28)src/commands/staking/validatorPrime.ts (1)
ValidatorPrimeAction(9-73)
🔇 Additional comments (13)
src/commands/staking/StakingAction.ts (2)
9-18: LGTM on the extended ABI definition.The
STAKING_TREE_ABIconstant is correctly defined with proper TypeScript const assertion for type safety with viem's contract reads.
146-146: Minor UX improvement noted.The spinner text change from "Continuing..." to "Unlocking account..." provides clearer feedback to users about what's happening.
docs/validator-guide.md (2)
238-254: Documentation looks good.The priming section clearly explains the concept and provides practical examples with the new commands. The color-coded status indicators are well-documented.
267-275: LGTM on the View Validator Set section.Clear and concise documentation for the
validatorscommand with the--allflag option.README.md (2)
309-310: LGTM on new command documentation.The new
validator-primeandprime-allcommands are properly documented in the command list.
421-426: Examples are clear and helpful.The examples for the new priming commands follow the established documentation pattern.
src/commands/staking/index.ts (1)
243-243: LGTM on the --debug flag addition.The debug flag is properly added and follows the existing option pattern.
src/commands/staking/validatorPrime.ts (1)
37-72: Good implementation of batch priming with graceful error handling.The
primeAllmethod correctly:
- Fetches all validators from the tree
- Handles individual validator priming failures without stopping the entire operation
- Provides clear progress feedback with color-coded output
- Summarizes results at the end
One minor consideration: if
getStakingClientorgetAllValidatorsFromTreefails, the spinner is properly handled by the catch block. However, afterstopSpinner()on line 47, if any console operation fails before the loop, there's no cleanup needed since spinner is already stopped.src/commands/staking/stakingInfo.ts (5)
10-13: LGTM!The
debugoption is correctly added as an optional boolean field.
56-78: LGTM!The debug mode logic correctly differentiates between showing all deposits vs. only truly pending ones. The status indicators ("ACTIVATED" vs. pending epochs) provide useful context in debug mode.
372-393: LGTM!Good use of parallel fetching and
Setfor O(1) membership lookups. The tree traversal approach correctly discovers all validators including unprimed ones.
544-552: LGTM!The primed status color coding provides clear visual feedback: green for current, yellow for one epoch behind, and red with "!" for validators needing attention. The BigInt comparisons are handled correctly.
488-500: LGTM!The table structure is consistent with headers matching row data order. The new "Primed" column integrates well with the existing table layout.
Also applies to: 562-571
| staking | ||
| .command("prime-all") | ||
| .description("Prime all validators that need priming") | ||
| .option("--account <name>", "Account to use (pays gas)") | ||
| .option("--network <network>", "Network to use (localnet, testnet-asimov)") | ||
| .option("--rpc <rpcUrl>", "RPC URL for the network") | ||
| .option("--staking-address <address>", "Staking contract address (overrides chain config)") | ||
| .action(async (options: StakingConfig) => { | ||
| const action = new ValidatorPrimeAction(); | ||
| await action.primeAll(options); | ||
| }); |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check the imports and content of the staking index.ts file
echo "=== Checking imports in src/commands/staking/index.ts ==="
head -30 src/commands/staking/index.ts
echo -e "\n=== Checking lines 119-129 for prime-all action ==="
sed -n '119,129p' src/commands/staking/index.ts
echo -e "\n=== Checking if StakingConfig exists ==="
rg "StakingConfig" src/commands/staking/ -A 2 -B 2Repository: genlayerlabs/genlayer-cli
Length of output: 14314
Add missing import for StakingConfig type.
The prime-all action uses StakingConfig type annotation (line 126), but this type is not imported at the top of the file. Add the import from ./StakingAction:
import {Command} from "commander";
import {ValidatorJoinAction, ValidatorJoinOptions} from "./validatorJoin";
import {ValidatorDepositAction, ValidatorDepositOptions} from "./validatorDeposit";
import {ValidatorExitAction, ValidatorExitOptions} from "./validatorExit";
import {ValidatorClaimAction, ValidatorClaimOptions} from "./validatorClaim";
import {ValidatorPrimeAction, ValidatorPrimeOptions} from "./validatorPrime";
+import {StakingConfig} from "./StakingAction";
import {SetOperatorAction, SetOperatorOptions} from "./setOperator";Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In src/commands/staking/index.ts around lines 119 to 129, the StakingConfig type
used to type the options parameter in the prime-all action is not imported; add
an import for StakingConfig from ./StakingAction at the top of the file (e.g.
import { StakingConfig } from "./StakingAction") so the type reference is
resolved and TypeScript compiles cleanly.
Summary
--debugflag tovalidator-infoto show raw unfiltered pending depositsvalidatorscommandprime-allcommand to prime all validators that need primingChanges
validatorsRoottree traversal to find all validators, adds Primed columnTest plan
genlayer staking validator-info 0x... --debugshows currentEpoch and raw depositsgenlayer staking validatorsshows Primed column with correct colorsgenlayer staking prime-allprimes validators and shows resultsSummary by CodeRabbit
Release Notes
New Features
validator-primeandprime-allCLI commands to prime validators each epoch--debugflag tovalidator-infocommand to display raw unfiltered dataDocumentation
✏️ Tip: You can customize this high-level summary in your review settings.