feat: implement claimKghReward function #348

sm-stack · 2024-07-18T07:51:01Z

Description

Implement claimKghReward function. Includes _claimBoostedReward which has isCompounding flag.

coderabbitai · 2024-07-18T07:51:09Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Base branches to auto review (2)

dev
main

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

packages/contracts/contracts/L1/interfaces/IAssetManager.sol

packages/contracts/contracts/L1/AssetManager.sol

0xHansLee · 2024-07-19T04:30:51Z

packages/contracts/contracts/L1/AssetManager.sol

+ if (isCompounding) {
+ _delegate(validator, delegator, totalBoostedReward);
+ }


It seems that this can be handled when calling _claimBoostedReward() since totalBoostedReward is returned.
If compounding is needed, caller can delegate the totalBoostedReward to validator. wdyt?

I didn't get what you mean. Could you elaborate it?

Ok. I suggest to remove isCompounding flag and just return totalBoostedReward in this function.
Then, caller can choose to delegate the totalBoostedReward or not.

At first, I thought the compounding delegation should be executed in this function, but it seems to be out of this function.

For example, in claimKghReward, just transfer the totalBoostedReward to the delegator. On the other hand, in delegateKgh (would be handled in #349), make delegate with the totalBoostedReward. Then we don't need the isCompounding flang here.

I agree it. Just return totalBoostedReward and handle auto compounding out of this function.

Additionally, I suggest to add internal view functions to calculate boosted reward and base reward of KGH delegator each, and use the two functions in getKghReward and claimKghReward. wdyt?
Then kghDelegator.rewardPerKghPaid = rewardPerKghStored; this part should be handled in claimKghReward and delegateKgh.

So you mean that the compounding process will be executed separately in delegateKgh? Make sense, I'll remove it!

Additionally, I suggest to add internal view functions to calculate boosted reward and base reward of KGH delegator each, and use the two functions in getKghReward and claimKghReward. wdyt?
Then kghDelegator.rewardPerKghPaid = rewardPerKghStored; this part should be handled in claimKghReward and delegateKgh.

I've also thought about this, but in terms of base reward, making an internal function is not desirable in terms of gas usage, since we have to check delegateAt inside the for loop in claimKghReward. Also for the boosted reward, _claimBoostedReward is also used in delegateKgh, which means an internal function to calculate the reward makes kghDelegator.rewardPerKghPaid = rewardPerKghStored; line repeated inside delegateKgh function, and I didn't see much differences in code readability imo. What do you think?

OK, it's not that critical thing and I just suggested it to reduce code redundancy between the getKghReward function and claimKghReward function.

packages/contracts/contracts/L1/interfaces/IAssetManager.sol

packages/contracts/contracts/L1/AssetManager.sol

seolaoh · 2024-07-19T05:07:31Z

packages/contracts/contracts/L1/AssetManager.sol

+ if (isCompounding) {
+ _delegate(validator, delegator, totalBoostedReward);
+ }


I agree it. Just return totalBoostedReward and handle auto compounding out of this function.

Additionally, I suggest to add internal view functions to calculate boosted reward and base reward of KGH delegator each, and use the two functions in getKghReward and claimKghReward. wdyt?
Then kghDelegator.rewardPerKghPaid = rewardPerKghStored; this part should be handled in claimKghReward and delegateKgh.

packages/contracts/contracts/L1/AssetManager.sol

seolaoh · 2024-07-19T06:04:02Z

packages/contracts/contracts/L1/AssetManager.sol

+ * @param validator Address of the validator.
+ * @param delegator Address of the delegator.
+ * @param isCompounding Flag to auto compound the boosted reward.


Suggested change

* @param validator Address of the validator.

* @param delegator Address of the delegator.

* @param isCompounding Flag to auto compound the boosted reward.

* @param validator Address of the validator.

* @param delegator Address of the delegator.

seolaoh · 2024-07-19T06:24:17Z

packages/contracts/contracts/L1/AssetManager.sol

+ * @param validator Address of the validator.
+ * @param delegator Address of the delegator.


Can you remove the spaces?

Suggested change

* @param validator Address of the validator.

* @param delegator Address of the delegator.

* @param validator Address of the validator.

* @param delegator Address of the delegator.

sm-stack requested a review from a team as a code owner July 18, 2024 07:51

sm-stack requested review from 0xHansLee and seolaoh and removed request for a team July 18, 2024 07:51

sm-stack self-assigned this Jul 18, 2024

0xHansLee mentioned this pull request Jul 18, 2024

feat: remove KGH share and modify KGH delegation func #349

Merged

seolaoh reviewed Jul 18, 2024

View reviewed changes

0xHansLee reviewed Jul 18, 2024

View reviewed changes

packages/contracts/contracts/L1/AssetManager.sol Outdated Show resolved Hide resolved

sm-stack added 2 commits July 19, 2024 13:10

feat: implement claimKghReward function

9b380e2

fix: revise type of kghNum to uint128

f9df342

sm-stack force-pushed the feat/implement-claim-kgh-reward branch 2 times, most recently from 7520f30 to edd6653 Compare July 19, 2024 04:14

sm-stack requested review from 0xHansLee and seolaoh July 19, 2024 04:16

0xHansLee reviewed Jul 19, 2024

View reviewed changes

sm-stack force-pushed the feat/implement-claim-kgh-reward branch from edd6653 to 86b9eaf Compare July 19, 2024 05:10

seolaoh reviewed Jul 19, 2024

View reviewed changes

packages/contracts/contracts/L1/AssetManager.sol Outdated Show resolved Hide resolved

sm-stack force-pushed the feat/implement-claim-kgh-reward branch 3 times, most recently from a90762a to 757bddf Compare July 19, 2024 05:57

seolaoh reviewed Jul 19, 2024

View reviewed changes

0xHansLee approved these changes Jul 19, 2024

View reviewed changes

sm-stack force-pushed the feat/implement-claim-kgh-reward branch from 757bddf to b12cae3 Compare July 19, 2024 06:22

sm-stack requested a review from seolaoh July 19, 2024 06:22

seolaoh approved these changes Jul 19, 2024

View reviewed changes

feat: apply PR reviews

103171a

sm-stack force-pushed the feat/implement-claim-kgh-reward branch from b12cae3 to 103171a Compare July 19, 2024 06:32

sm-stack merged commit 6e0ec89 into feat/implement-validator-system-v2 Jul 19, 2024
1 of 2 checks passed

sm-stack deleted the feat/implement-claim-kgh-reward branch July 19, 2024 06:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement claimKghReward function #348

feat: implement claimKghReward function #348

sm-stack commented Jul 18, 2024

coderabbitai bot commented Jul 18, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

0xHansLee Jul 19, 2024

sm-stack Jul 19, 2024

0xHansLee Jul 19, 2024

seolaoh Jul 19, 2024

sm-stack Jul 19, 2024

sm-stack Jul 19, 2024

seolaoh Jul 19, 2024

seolaoh Jul 19, 2024

seolaoh Jul 19, 2024

seolaoh Jul 19, 2024

		* @param validator Address of the validator.
		* @param delegator Address of the delegator.

feat: implement claimKghReward function #348

feat: implement claimKghReward function #348

Conversation

sm-stack commented Jul 18, 2024

Description

coderabbitai bot commented Jul 18, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CodeRabbit Configuration File (`.coderabbit.yaml`)