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

chore: prepare v1.5 #206

Merged
merged 8 commits into from
Jul 5, 2024
Merged

chore: prepare v1.5 #206

merged 8 commits into from
Jul 5, 2024

Conversation

mbreithecker
Copy link
Member

@mbreithecker mbreithecker commented Jul 3, 2024

Summary by CodeRabbit

  • New Features

    • Aligned naming of events for better clarity and consistency.
  • Improvements

    • Upgraded to the newest IAVL version to prevent pruning errors.
  • Bug Fixes

    • Fixed issues returning correct results for legacy RPC block_results requests.
  • Chores

    • Updated ownership wording in CONTRIBUTING.md.
    • Updated BUILD_TIME variable in Makefile for accurate build tracking.
  • Enhancements

    • Updated CoinWhitelist initialization for KYVE, Andromeda, and Source Protocol with refined coin details and weights.

Copy link

coderabbitai bot commented Jul 3, 2024

Walkthrough

In version v1.5.0 of the KYVENetwork/chain repository, the key updates include alignment of event naming conventions, upgrading to the latest IAVL version to fix pruning errors, and correcting legacy RPC block results. Contributions text saw minor wording tweaks, and the build time variable in the Makefile was updated. Additionally, the migrateFundersModule in the upgrade.go file now initializes CoinWhitelist with updated details for KYVE, Andromeda, and Source Protocol coins.

Changes

File/Directory Change Summary
CHANGELOG.md Documented summary of v1.5.0 changes.
CONTRIBUTING.md Minor wording correction in the license agreement section.
Makefile Updated BUILD_TIME variable to 202407040800.00.
.../upgrades/v1_5/upgrade.go Significant updates to migrateFundersModule function with new CoinWhitelist details for key coins.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant IAVL

    User->>App: Interact with blockchain events
    App->>IAVL: Use new IAVL version
    IAVL-->>App: Return data without pruning errors
    App-->>User: Receive correct responses for events

    User->>App: Request legacy RPC block results
    App->>App: Fetch correct legacy block results
    App-->>User: Return accurate results
Loading

Poem

In code we dance, events align,
With coins anew, updates refine,
Pruning errors set to pass,
As blocks return in perfect class.
🐰✨ Upgrades hum, improvements sing,
KYVE's magic in each string! 🛠️🔗


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.

@mbreithecker mbreithecker marked this pull request as ready for review July 4, 2024 14:21
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)
app/upgrades/v1_5/upgrade.go (1)

211-212: Remove the TODO comment.

The TODO comment indicating that prices were obtained on 03.07.2024 should be removed or converted into a proper comment.

- // Prices were obtained on 03.07.2024
+ // Prices for the coins were obtained on 03.07.2024
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 781bd00 and 6964ae1.

Files selected for processing (4)
  • CHANGELOG.md (3 hunks)
  • CONTRIBUTING.md (1 hunks)
  • Makefile (1 hunks)
  • app/upgrades/v1_5/upgrade.go (2 hunks)
Files skipped from review due to trivial changes (2)
  • CONTRIBUTING.md
  • Makefile
Additional comments not posted (6)
CHANGELOG.md (3)

17-17: Ensure the release date is accurate.

The release date for version v1.5.0 is set to 2024-07-05. Verify that this date is correct.


32-32: Review event naming alignment.

The improvement to align event naming is mentioned in the changelog. Ensure that all events in the codebase follow the new naming conventions.

Verification successful

Verification of Event Naming Alignment

The event names in the codebase generally follow the pattern Event<Verb><Noun>. Here are the event names found:

  • EventCreateTeamVestingAccount
  • EventClawback
  • EventClaimedUnlocked
  • EventClaimInflationRewards
  • EventClaimAuthorityRewards
  • EventUpdateParams
  • EventCreatePool
  • EventPoolEnabled
  • EventPoolDisabled
  • EventRuntimeUpgradeScheduled
  • EventRuntimeUpgradeCancelled
  • EventPoolUpdated
  • EventPoolFundsSlashed
  • EventCreateStaker
  • EventUpdateMetadata
  • EventUpdateCommission
  • EventClaimCommissionRewards
  • EventJoinPool
  • EventLeavePool
  • EventDefundPool
  • EventFundPool
  • EventPoolOutOfFunds
  • EventDelegate
  • EventStartUndelegation
  • EventUndelegate
  • EventRedelegate
  • EventWithdrawRewards
  • EventSlash
  • EventPointsReset
  • EventPointIncreased
  • EventBundleProposed
  • EventBundleVote
  • EventBundleFinalized
  • EventClaimedUploaderRole
  • EventSkippedUploaderRole

All these event names adhere to the pattern Event<Verb><Noun>, indicating that the event naming conventions are consistent with the new alignment.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that all events follow the new naming conventions.

# Test: Search for event names. Expect: Consistent naming conventions.
rg --type go 'Event'

Length of output: 181683


45-46: Verify the bug fixes.

The bug fixes for using the newest IAVL version to prevent pruning errors and returning correct results for legacy RPC block_results requests are mentioned. Ensure these fixes are correctly implemented and tested.

app/upgrades/v1_5/upgrade.go (3)

213-220: Ensure the accuracy of KYVE coin details.

The details for KYVE coin, including CoinWeight updated from 0.06 to 0.0358, should be verified for accuracy.


221-228: Ensure the accuracy of Andromeda coin details.

The details for Andromeda coin, including CoinWeight set to 0.1007, should be verified for accuracy.


229-235: Ensure the accuracy of Source Protocol coin details.

The details for Source Protocol coin, including CoinWeight set to 0.0207, should be verified for accuracy.

@mbreithecker mbreithecker merged commit 3910277 into main Jul 5, 2024
5 checks passed
@mbreithecker mbreithecker deleted the mbreithecker/prepare-v1.5 branch July 5, 2024 12: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