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/update_gas_estimator_base_values #344

Merged
merged 3 commits into from
Aug 8, 2024

Conversation

aarmoa
Copy link
Collaborator

@aarmoa aarmoa commented Aug 8, 2024

  • Updated reference gas cost for messages in the gas limit estimator after chain upgrade v1.13

Solves CHAIN-172

Summary by CodeRabbit

  • New Features

    • Increased gas limits for various order types, improving transaction handling and costs.
  • Bug Fixes

    • Addressed gas cost estimation issues following a recent upgrade.
  • Documentation

    • Updated CHANGELOG to reflect the latest changes and improvements.
    • Enhanced clarity in test case definitions by replacing hardcoded values with named constants for gas limits.
  • Chores

    • Incremented project version to 1.6.3 in preparation for the next release cycle.

Copy link
Contributor

coderabbitai bot commented Aug 8, 2024

Walkthrough

The recent changes improve gas limit estimation in the pyinjective trading system by increasing various gas limits for order types and optimizing test cases to utilize defined constants instead of hardcoded values. This enhances maintainability, clarity, and accuracy across the codebase and tests, ensuring alignment with the latest definitions.

Changes

Files Change Summary
pyinjective/core/gas_limit_estimator.py Increased gas limits for spot and derivative orders, modified multipliers, and adjusted constants in multiple estimator classes, indicating an overall increase.
tests/core/test_gas_limit_estimator.py, tests/core/test_message_based_transaction_fee_calculator.py Replaced hardcoded gas limit values with constants from respective estimator classes to enhance maintainability and accuracy of test cases.
CHANGELOG.md, pyproject.toml Updated version information and documented changes related to gas cost estimation and the transition to version 1.6.3.

Poem

🐰 In the land of gas limits, oh so bright,
We’ve tweaked the numbers, made them just right.
Orders and messages dance with such grace,
Constants now guide them, keeping up pace.
Hops of improvement, a joyous new day,
Let’s celebrate changes, hip-hip-hooray! 🌼✨


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.

Copy link
Contributor

@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, codebase verification and nitpick comments (1)
tests/core/test_gas_limit_estimator.py (1)

Line range hint 26-26: Consider using a constant for expected message gas limit.

The test case uses a hardcoded value 150,000. Consider replacing it with a relevant constant for consistency and maintainability.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b57aba9 and 281936b.

Files selected for processing (3)
  • pyinjective/core/gas_limit_estimator.py (3 hunks)
  • tests/core/test_gas_limit_estimator.py (15 hunks)
  • tests/core/test_message_based_transaction_fee_calculator.py (8 hunks)
Additional comments not posted (29)
tests/core/test_message_based_transaction_fee_calculator.py (7)

40-43: LGTM: Use of constants enhances maintainability.

The use of MessageBasedTransactionFeeCalculator.TRANSACTION_GAS_LIMIT and PrivilegedExecuteContractGasLimitEstimator.BASIC_REFERENCE_GAS_LIMIT improves clarity and reduces hardcoding.


68-68: LGTM: Consistent use of transaction gas limit constant.

The transition to using MessageBasedTransactionFeeCalculator.TRANSACTION_GAS_LIMIT supports the goal of reducing hardcoded values.


90-90: LGTM: Use of transaction gas limit constant is appropriate.

Replacing hardcoded values with MessageBasedTransactionFeeCalculator.TRANSACTION_GAS_LIMIT improves maintainability.


112-112: LGTM: Consistent use of transaction gas limit constant.

The change to use MessageBasedTransactionFeeCalculator.TRANSACTION_GAS_LIMIT supports the goal of reducing hardcoded values.


142-142: LGTM: Use of transaction gas limit constant is appropriate.

The transition to using MessageBasedTransactionFeeCalculator.TRANSACTION_GAS_LIMIT improves maintainability.


173-175: LGTM: Use of multiple gas limit constants improves clarity.

The use of MessageBasedTransactionFeeCalculator.TRANSACTION_GAS_LIMIT, GenericExchangeGasLimitEstimator.BASIC_REFERENCE_GAS_LIMIT, and ExecGasLimitEstimator.DEFAULT_GAS_LIMIT enhances maintainability and accuracy.


211-214: LGTM: Consistent use of gas limit constants.

The transition to using constants for gas limits enhances clarity and reduces hardcoding.

pyinjective/core/gas_limit_estimator.py (8)

15-15: LGTM: Updated SPOT_ORDER_CREATION_GAS_LIMIT to 52,000.

The change aligns with the intended update to reflect new gas costs.


16-16: LGTM: Updated DERIVATIVE_ORDER_CREATION_GAS_LIMIT to 84,000.

The change aligns with the intended update to reflect new gas costs.


18-18: LGTM: Updated DERIVATIVE_ORDER_CANCELATION_GAS_LIMIT to 68,000.

The change aligns with the intended update to reflect new gas costs.


20-20: LGTM: Updated SPOT_POST_ONLY_ORDER_MULTIPLIER to 0.62.

The change aligns with the intended update to reflect new multiplier values.


21-21: LGTM: Updated DERIVATIVE_POST_ONLY_ORDER_MULTIPLIER to 0.35.

The change aligns with the intended update to reflect new multiplier values.


25-25: LGTM: Updated GENERAL_MESSAGE_GAS_LIMIT to 25,000.

The change aligns with the intended update to reflect new gas limits.


186-186: LGTM: Updated MESSAGE_GAS_LIMIT to 30,000.

The change aligns with the intended update to reflect new gas limits.


249-249: LGTM: Updated DEFAULT_GAS_LIMIT to 20,000.

The change aligns with the intended update to reflect new gas limits.

tests/core/test_gas_limit_estimator.py (14)

59-60: LGTM: Consistent use of gas limit constants.

The transition to using SPOT_ORDER_CREATION_GAS_LIMIT and BatchCreateSpotLimitOrdersGasLimitEstimator.GENERAL_MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


87-88: LGTM: Consistent use of gas limit constants.

The transition to using SPOT_ORDER_CANCELATION_GAS_LIMIT and BatchCancelSpotOrdersGasLimitEstimator.GENERAL_MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


118-119: LGTM: Consistent use of gas limit constants.

The transition to using DERIVATIVE_ORDER_CREATION_GAS_LIMIT and BatchCreateDerivativeLimitOrdersGasLimitEstimator.GENERAL_MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


146-147: LGTM: Consistent use of gas limit constants.

The transition to using DERIVATIVE_ORDER_CANCELATION_GAS_LIMIT and BatchCancelDerivativeOrdersGasLimitEstimator.GENERAL_MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


181-182: LGTM: Consistent use of gas limit constants.

The transition to using SPOT_ORDER_CREATION_GAS_LIMIT and BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


218-219: LGTM: Consistent use of gas limit constants.

The transition to using DERIVATIVE_ORDER_CREATION_GAS_LIMIT and BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


275-276: LGTM: Consistent use of gas limit constants.

The transition to using DERIVATIVE_ORDER_CREATION_GAS_LIMIT and BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


309-310: LGTM: Consistent use of gas limit constants.

The transition to using SPOT_ORDER_CANCELATION_GAS_LIMIT and BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


343-344: LGTM: Consistent use of gas limit constants.

The transition to using DERIVATIVE_ORDER_CANCELATION_GAS_LIMIT and BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


378-379: LGTM: Consistent use of gas limit constants.

The transition to using DERIVATIVE_ORDER_CANCELATION_GAS_LIMIT and BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


398-399: LGTM: Consistent use of gas limit constants.

The transition to using BatchUpdateOrdersGasLimitEstimator.CANCEL_ALL_SPOT_MARKET_GAS_LIMIT and BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


418-419: LGTM: Consistent use of gas limit constants.

The transition to using BatchUpdateOrdersGasLimitEstimator.CANCEL_ALL_DERIVATIVE_MARKET_GAS_LIMIT and BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


438-439: LGTM: Consistent use of gas limit constants.

The transition to using BatchUpdateOrdersGasLimitEstimator.CANCEL_ALL_DERIVATIVE_MARKET_GAS_LIMIT and BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT enhances clarity and reduces hardcoding.


467-469: LGTM: Consistent use of gas limit constants.

The transition to using SPOT_ORDER_CREATION_GAS_LIMIT, BatchUpdateOrdersGasLimitEstimator.MESSAGE_GAS_LIMIT, and ExecGasLimitEstimator.DEFAULT_GAS_LIMIT enhances clarity and reduces hardcoding.

Copy link
Contributor

@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 281936b and 546e428.

Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • pyproject.toml (1 hunks)
Files skipped from review due to trivial changes (2)
  • CHANGELOG.md
  • pyproject.toml

Copy link
Contributor

@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 546e428 and b0141f3.

Files selected for processing (1)
  • pyproject.toml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • pyproject.toml

@aarmoa aarmoa merged commit 5541211 into master Aug 8, 2024
12 checks passed
@aarmoa aarmoa deleted the feat/update_gas_estimator_base_values branch August 8, 2024 18:06
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.

1 participant