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: make PrepareFactory public so chilliass can re-use it #228

Merged

Conversation

kakysha
Copy link
Contributor

@kakysha kakysha commented Jul 12, 2024

Summary by CodeRabbit

  • Improvements

    • Enhanced external access by making the PrepareFactory method in the chainClient struct public.
    • Modified the return order of values in the GetBalanceHoldAndMarginDenom and GetUnfilledMarginHoldAndMarginDenom functions for SpotOrder and SpotLimitOrder types.
  • Bug Fixes

    • Added a default case to the IsAllowed function to handle unexpected inputs, improving robustness.

@kakysha kakysha requested a review from aarmoa July 12, 2024 18:02
Copy link

coderabbitai bot commented Jul 12, 2024

Walkthrough

The recent changes include making the prepareFactory function public in the chainClient struct, which impacts its visibility and usage. Additionally, function signatures in SpotOrder and SpotLimitOrder types were modified to change the order of return values. Lastly, a default case was added to the IsAllowed function in the chain/wasmx/types package to ensure it returns false by default.

Changes

File Path Summary
client/chain/chain.go Renamed prepareFactory to PrepareFactory and made it public.
chain/exchange/types/spot_orders.go Modified function signatures for GetBalanceHoldAndMarginDenom and GetUnfilledMarginHoldAndMarginDenom.
chain/wasmx/types/util.go Added a default case to the IsAllowed function, returning false in that case.

Poem

In the codebase where changes thrive,
Functions renamed and made alive.
Public now, PrepareFactory stands tall,
Balance and denom, we re-call.
A default case in IsAllowed we've penned,
Our code, more robust, no loose ends.
Hail to progress, our journey ascends! 🚀


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.

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d7aa99d and e12052b.

Files selected for processing (1)
  • client/chain/chain.go (3 hunks)
Additional comments not posted (2)
client/chain/chain.go (2)

484-488: LGTM! The function is now public.

The PrepareFactory function is now public, and the comment is clear and concise. The code changes are approved.


706-706: LGTM! The usage of PrepareFactory is updated.

The PrepareFactory function call is correctly updated to use the public PrepareFactory in the SimulateMsg and buildSignedTx methods. The code changes are approved.

Also applies to: 788-788

Copy link
Collaborator

@aarmoa aarmoa left a comment

Choose a reason for hiding this comment

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

The change looks good to me

@aarmoa
Copy link
Collaborator

aarmoa commented Jul 15, 2024

@kakysha please fix the pre-commit issues before merging the PR

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e12052b and 50dedaa.

Files selected for processing (2)
  • chain/exchange/types/spot_orders.go (2 hunks)
  • chain/wasmx/types/util.go (1 hunks)
Additional comments not posted (3)
chain/wasmx/types/util.go (1)

17-18: Good addition of the default case.

The default case ensures a fallback behavior, improving the control flow.

chain/exchange/types/spot_orders.go (2)

Line range hint 146-166:
LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to GetBalanceHoldAndMarginDenom match the new return order.

Verification successful

No issues found with the changes.

The function GetBalanceHoldAndMarginDenom is not called elsewhere in the codebase, so the change in return order does not affect any other part of the code.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `GetBalanceHoldAndMarginDenom` match the new return order.

# Test: Search for the function usage. Expect: Only occurances of the new return order.
rg --type go -A 5 $'GetBalanceHoldAndMarginDenom'

Length of output: 613


Script:

#!/bin/bash
# Description: Find all call sites of the function `GetBalanceHoldAndMarginDenom` to verify the new return order.

# Test: Search for the function calls. Expect: Occurrences of the function call with the new return order.
rg --type go 'GetBalanceHoldAndMarginDenom'

Length of output: 193


Script:

#!/bin/bash
# Description: Find all call sites of the function `GetBalanceHoldAndMarginDenom` to verify the new return order.

# Test: Search for the function calls with more context lines. Expect: Occurrences of the function call with the new return order.
rg --type go -A 10 'GetBalanceHoldAndMarginDenom'

Length of output: 1052


Script:

#!/bin/bash
# Description: Find all call sites of the function `GetBalanceHoldAndMarginDenom` to verify the new return order.

# Test: Search for the function calls with more context lines. Expect: Occurrences of the function call with the new return order.
rg --type go -A 10 'GetBalanceHoldAndMarginDenom'

Length of output: 1052


Line range hint 168-188:
LGTM! But verify the function usage in the codebase.

The code changes are approved.

However, ensure that all function calls to GetUnfilledMarginHoldAndMarginDenom match the new return order.

@kakysha kakysha merged commit 58aee14 into feat/update_dependencies_chain_v1_13 Jul 15, 2024
4 checks passed
@kakysha kakysha deleted the fix-PrepareFactory-public branch July 15, 2024 13:38
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