Skip to content

Conversation

@twoeths
Copy link
Contributor

@twoeths twoeths commented Dec 29, 2025

Motivation

  • the reward apis tightly couple to state-transition functions like beforeProcessEpoch() processBlock() processAttestationAltair() so it needs to be moved there

Description

  • move api type definitions to types package so that it can be used everywhere
  • move reward apis implementation to state-transition package

Closes #8690

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @twoeths, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request undertakes a significant refactoring effort to improve the modularity and organization of reward-related logic within the project. It centralizes the definitions of reward types into a dedicated @lodestar/types package and relocates the actual reward computation functions into the @lodestar/state-transition package. This change ensures that components tightly coupled to state-transition functions, such as reward calculations, are appropriately grouped, enhancing maintainability and clarity of the codebase.

Highlights

  • Type Definition Centralization: Reward API type definitions (e.g., BlockRewards, AttestationsRewards) have been moved from the api package to the @lodestar/types package, centralizing them for broader use across the codebase.
  • Reward API Implementation Relocation: The core implementations of reward computation functions (e.g., computeAttestationsRewards, computeBlockRewards, computeSyncCommitteeRewards) have been refactored and moved from the beacon-node package to the @lodestar/state-transition package.
  • Dependency Updates: All relevant files in the api, beacon-node, and state-transition packages have been updated to reflect the new locations of reward types and computation functions, ensuring correct imports and module structure.
  • Test File Alignment: Associated test files for reward computations have been renamed and moved to align with the new state-transition package structure, maintaining test coverage for the refactored logic.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request is a well-executed refactoring that moves reward-related APIs and their implementations to the state-transition package, and the corresponding type definitions to the types package. This is a logical change as reward calculations are tightly coupled with state transitions. The changes are clean and consistent across the codebase. I have a couple of minor suggestions to improve maintainability by removing some commented-out code and avoiding code duplication.

@twoeths twoeths marked this pull request as ready for review December 29, 2025 12:38
@twoeths twoeths requested a review from a team as a code owner December 29, 2025 12:38
import {sszTypesFor} from "./sszTypes.js";
export {sszTypesFor, SSZTypesFor, ssz};

export * from "./rewards.js";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These should be somewhat consistent with how other types are exported. Or at least not just dumped in the top-level export.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refactor rewards api to prepare for lodestar-z integration

3 participants