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

feat(types): Add a ValueCodec for Uint complex type #19164

Merged
merged 6 commits into from
Jan 30, 2024

Conversation

relyt29
Copy link
Contributor

@relyt29 relyt29 commented Jan 22, 2024

Description

I am working on a cosmos module that wanted to use sdk.Uint value types in a collections.Map in our module's keeper. There appears to be a value type for Ints in collections.go but not for Uints. Rather than filing an issue about it, I decided to just offer this PR.


Author Checklist

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
    • Not sure if any unit tests needed, since I didn't see any for IntValue
  • added a changelog entry to CHANGELOG.md
    • will do this after I make the PR, not sure how you're supposed to know ahead of time
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed
    • don't know how to do this, I assume github actions will just do this...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

@relyt29 relyt29 requested a review from a team as a code owner January 22, 2024 16:45
Copy link
Contributor

coderabbitai bot commented Jan 22, 2024

Warning

Rate Limit Exceeded

@julienrbrt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 20 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 6b19e66 and 1707a1e.

Walkthrough

The update introduces a new UintValue to the collections package, enhancing it with the capability to handle unsigned integers. This involves adding methods for encoding and decoding Uint values, as well as functions for JSON processing and converting Uint into strings. The change broadens the scope of the collections package, allowing for better handling of numeric data types without sign restrictions.

Changes

File Path Change Summary
types/.../collections.go Addition of UintValue representing a collections ValueCodec to work with Uint, along with its associated methods for encoding, decoding, JSON encoding/decoding, stringifying, and obtaining the value type. This addition expands the functionality of the collections package to support unsigned integers.
CHANGELOG.md
types/codec_test.go
Addition of a ValueCodec for the math.Uint type that can be utilized in collections maps.
Added a new test function TestUintValue to test the encoding and decoding of unsigned integer values using the colltest.TestValueCodec function.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

types/collections.go Outdated Show resolved Hide resolved
types/collections.go Outdated Show resolved Hide resolved
Co-authored-by: Likhita Polavarapu <78951027+likhita-809@users.noreply.github.com>
@relyt29
Copy link
Contributor Author

relyt29 commented Jan 30, 2024

let me know if there's anything else I need to do to get this merged @tac0turtle, happy to do the legwork

@julienrbrt julienrbrt changed the title Add a ValueCodec for Uint complex type feat(types): Add a ValueCodec for Uint complex type Jan 30, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Jan 30, 2024
Merged via the queue into cosmos:main with commit 3f15c4b Jan 30, 2024
47 of 55 checks passed
@relyt29 relyt29 deleted the relyt29-UintValue2 branch January 31, 2024 17:55
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.

6 participants