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

Update large cap params in genesis #2431

Merged
merged 1 commit into from
Oct 2, 2024

Conversation

chenyaoy
Copy link
Contributor

@chenyaoy chenyaoy commented Oct 2, 2024

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features

    • Adjusted liquidity tier parameters, including a reduction in the initial margin requirement for large-cap assets.
    • Enhanced initialization script for local development, improving token and account management, as well as market parameters.
  • Bug Fixes

    • Corrected various parameters related to governance and staking to ensure optimal blockchain performance.
  • Documentation

    • Updated comments and structure within the genesis configuration script for clarity on new functionalities.

@chenyaoy chenyaoy requested a review from a team as a code owner October 2, 2024 17:09
Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

Walkthrough

The pull request introduces significant updates to the sample_pregenesis.json and genesis.sh files within the dydxprotocold application. The sample_pregenesis.json file sees a reduction in the initial_margin_ppm for the first liquidity tier, along with updates to various parameters across multiple sections. The genesis.sh script undergoes extensive modifications to initialize blockchain parameters, including token addresses, consensus parameters, and liquidity tiers, as well as the addition of several functions to enhance its modularity.

Changes

File Path Change Summary
protocol/scripts/genesis/sample_pregenesis.json Updated initial_margin_ppm from 50000 to 20000 for the first liquidity tier; maintained JSON structure with no deletions.
protocol/testing/genesis.sh Comprehensive overhaul including initialization of token addresses, consensus parameters, liquidity tiers, and addition of multiple functions for modularity.

Possibly related PRs

  • fix TEST-USD marketmap genesis #2066: The changes in sample_pregenesis.json regarding the provider_configs array are related to the main PR's updates to the same JSON file, indicating a focus on configuration adjustments within the same context of liquidity and trading parameters.

Suggested labels

protocol

Suggested reviewers

  • BrendanChou
  • vincentwschau

Poem

In the land of code where rabbits play,
Changes hop in, brightening the day.
Margins adjusted, tiers align,
Genesis scripts now finely twine.
With each new function, we leap and bound,
In the world of trading, joy is found! 🐇✨


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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: 1

🧹 Outside diff range and nitpick comments (7)
protocol/testing/genesis.sh (7)

Line range hint 140-145: Inconsistency in 'maintenance_fraction_ppm' for 'Large-Cap' Liquidity Tier

The maintenance_fraction_ppm is set to 600,000 ppm (60%), but the comment states it's "60% of IM". Given that the initial_margin_ppm is 20,000 ppm (2%), 60% of IM would be 12,000 ppm (1.2%). Please verify if maintenance_fraction_ppm should be 12,000 ppm instead of 600,000 ppm.


Line range hint 158-159: Mismatch in 'maintenance_fraction_ppm' for 'Small-Cap' Liquidity Tier

The maintenance_fraction_ppm is set to 500,000 ppm (50%), but the comment indicates "50% of IM". With an initial_margin_ppm of 100,000 ppm (10%), 50% of IM should be 50,000 ppm (5%). Consider correcting the maintenance_fraction_ppm value or updating the comment for accuracy.


Line range hint 176-177: Discrepancy in 'maintenance_fraction_ppm' for 'Long-Tail' Liquidity Tier

The maintenance_fraction_ppm is 500,000 ppm (50%), yet the comment notes "50% of IM". As initial_margin_ppm is 200,000 ppm (20%), 50% of IM equates to 100,000 ppm (10%). Please confirm whether maintenance_fraction_ppm should be 100,000 ppm.


Line range hint 200-201: Clarification on 'maintenance_fraction_ppm' in 'Isolated' Liquidity Tier

The maintenance_fraction_ppm is set to 600,000 ppm (60%), with a comment stating "60% of IM". Since initial_margin_ppm is 50,000 ppm (5%), 60% of IM is 30,000 ppm (3%). Verify if the maintenance_fraction_ppm should be 30,000 ppm instead of 600,000 ppm.


Line range hint 34-37: Ensure Proper Quoting of Variables in 'edit_genesis' Function

In the edit_genesis function, variables like ${2}, ${3}, ${4}, and ${5} may contain spaces or special characters. To prevent word splitting or globbing issues, consider quoting these variables when using them.


Line range hint 218-223: Refactoring Suggestion for Exchange Configuration Updates

The function update_all_markets_with_fixed_price_exchange uses a loop to update each market's exchange configuration individually. Since the operation is similar for all markets, consider abstracting the repeated dasel commands into a separate function or using arrays to handle the updates more efficiently.


Line range hint 689-691: Potential for Unquoted Variables in Loops

In the loops within functions like update_genesis_use_test_exchange, variables such as $market_idx are used without quotes. While numeric variables are generally safe, it's good practice to quote variables to prevent issues if the script is modified in the future.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 672169b and 119218c.

📒 Files selected for processing (2)
  • protocol/scripts/genesis/sample_pregenesis.json (1 hunks)
  • protocol/testing/genesis.sh (1 hunks)
🔇 Additional comments (2)
protocol/testing/genesis.sh (2)

Line range hint 738-754: Variable 'vault_owner_address' May Be Unset

In the edit_genesis function, when setting vault_owner_address, if INPUT_TEST_ACCOUNTS[0] is empty or unset, the default address is used. Ensure that INPUT_TEST_ACCOUNTS is properly initialized or handle the case where it might be empty to prevent unexpected behavior.


Line range hint 226-228: Possible Missing Error Handling for 'jq' Command

The NUM_MARKETS variable is set using jq. If jq fails or is not installed, the script may proceed with an empty or incorrect value, leading to errors. Consider adding error handling to ensure jq executes successfully before proceeding.

@@ -2985,7 +2985,7 @@
{
"id": 0,
"impact_notional": 10000000000,
"initial_margin_ppm": 50000,
"initial_margin_ppm": 20000,
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Significant reduction in initial margin for Large-Cap tier

The initial_margin_ppm for the "Large-Cap" liquidity tier (id: 0) has been reduced from 50000 to 20000. This represents a 60% decrease in the initial margin requirement for this tier.

Implications:

  1. Increased leverage: Users will be able to open larger positions with the same amount of collateral.
  2. Potential risk: Lower margin requirements could lead to increased volatility and higher liquidation risks.
  3. Market competitiveness: This change might make the platform more attractive to traders seeking higher leverage.

Please ensure that:

  1. This change aligns with the overall risk management strategy.
  2. Other risk parameters (e.g., liquidation thresholds) have been adjusted accordingly.
  3. The impact on the system's stability has been thoroughly assessed.
  4. Clear communication is prepared for users about this change in margin requirements.

Consider adding a comment in the configuration file explaining the rationale behind this significant change to aid future maintenance and audits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants