Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fixed eror with claimable reward, add mul 100 for bounded tokens #38

Merged
merged 1 commit into from
Jun 20, 2024

Conversation

yevhen-burkovskyi
Copy link
Contributor

No description provided.

Copy link

coderabbitai bot commented Jun 19, 2024

Walkthrough

The modification to the StakingService class introduces two primary enhancements. First, it adds flexibility to the filter method, allowing it to handle cases where validatorAddress may be undefined. Second, it adjusts the calculation for bondedTokens to represent the value as a percentage by multiplying the result by 100.

Changes

File Path Change Summary
src/.../staking.service.ts Enhanced the filter method to handle optional validatorAddress and modified the bondedTokens calculation to output a percentage value.

Sequence Diagrams

sequenceDiagram
  participant Client
  participant StakingService
  participant Validator

  Client->>StakingService: requestValidatorData(validatorAddress)
  alt validatorAddress is defined
    StakingService->>Validator: retrieveValidatorData(validatorAddress)
    Validator-->>StakingService: data
    StakingService->>Client: filteredData
  else validatorAddress is not defined
    StakingService->>Validator: retrieveAllValidatorData()
    Validator-->>StakingService: data
    StakingService->>Client: allData
  end

  Client->>StakingService: requestBondedTokens()
  StakingService->>Validator: retrieveBondedTokensData()
  Validator-->>StakingService: bondedTokensData
  StakingService->>StakingService: calculatePercentage(bondedTokensData)
  StakingService-->>Client: bondedTokensPercentage
Loading

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 Configration 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.

@yevhen-burkovskyi yevhen-burkovskyi self-assigned this Jun 19, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (1)
src/modules/staking/services/staking.service.ts (1)

Line range hint 479-479: Consider using optional chaining to improve code safety and readability.

- let pubkey = this.okp4Service.wssPubkeyToAddr(validator.consensus_pubkey.key).toUpperCase();
+ let pubkey = this.okp4Service.wssPubkeyToAddr(validator.consensus_pubkey?.key)?.toUpperCase();

This change guards against potential runtime errors if consensus_pubkey or key are null or undefined, making the code more robust and easier to maintain.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 656d0f0 and 032ea90.

Files selected for processing (1)
  • src/modules/staking/services/staking.service.ts (2 hunks)
Additional context used
Biome
src/modules/staking/services/staking.service.ts

[error] 479-479: Change to an optional chain. (lint/complexity/useOptionalChain)

Unsafe fix: Change to an optional chain.

Additional comments not posted (2)
src/modules/staking/services/staking.service.ts (2)

123-125: Refactored filter logic to include all entries when validatorAddress is not provided.

This change enhances the flexibility of the method by conditionally applying the filter based on whether validatorAddress is provided. It's a good practice to handle optional parameters this way, ensuring that the function remains versatile.


169-172: Updated calculation for bondedTokens to scale the result by 100.

This adjustment is crucial for presenting the bondedTokens in a more appropriate scale. Multiplying by 100 as per the PR’s objective correctly adjusts the value representation, aligning with the expected frontend or external system requirements.

@yevhen-burkovskyi yevhen-burkovskyi requested review from DraugS and removed request for DraugS June 19, 2024 13:56
@yevhen-burkovskyi yevhen-burkovskyi merged commit e458959 into main Jun 20, 2024
11 checks passed
@yevhen-burkovskyi yevhen-burkovskyi deleted the fix/claimable-reward branch June 20, 2024 16:43
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.

2 participants