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: Remove outdated chains on protocol contracts types #276

Merged

Conversation

andresaiello
Copy link
Collaborator

@andresaiello andresaiello commented Jul 31, 2024

Summary

  • Remove old chains

Summary by CodeRabbit

  • New Features

    • Updated types and constants for Zeta Protocol's network configurations, enhancing clarity and maintainability.
    • Added "btc_mainnet" to the main networks available, expanding options for users.
  • Bug Fixes

    • Corrected the spelling of "Enviroment" to "Environment" for improved accuracy.
  • Refactor

    • Improved the structure and readability of type definitions, making them easier to understand and manage.

Copy link
Contributor

coderabbitai bot commented Jul 31, 2024

Walkthrough

The recent changes enhance the type definitions and constants related to the Zeta Protocol's network configurations, streamlining test and main network declarations. Notably, several test networks were removed, while a new main network was added. Function signatures were modified for greater flexibility, and typographical errors were corrected. Overall, these updates improve clarity and maintainability across the codebase.

Changes

Files Change Summary
lib/address.tools.ts Updated type declarations for ZetaProtocolTestNetwork and ZetaProtocolMainNetwork, modified constants, corrected spelling in ZetaProtocolEnvironment, and altered function signatures for flexibility.
lib/types.ts Reformatted ParamSymbol for readability, transitioned ParamChainName to reference ZetaProtocolNetwork, and improved formatting of ParamType.

Poem

🐇 In a world of codes and lines,
Changes hop like bunnies in designs.
Testnets slimmed, mainnets grow,
Clarity blooms where logic flows.
With each new type, our paths align,
Celebrating changes, oh how they shine! ✨


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 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.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.10%. Comparing base (161a0d4) to head (888daad).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #276   +/-   ##
=======================================
  Coverage   58.10%   58.10%           
=======================================
  Files          16       16           
  Lines         401      401           
  Branches       28       28           
=======================================
  Hits          233      233           
  Misses        165      165           
  Partials        3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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 161a0d4 and 888daad.

Files selected for processing (2)
  • lib/address.tools.ts (2 hunks)
  • lib/types.ts (1 hunks)
Additional comments not posted (11)
lib/types.ts (3)

3-22: Reordering and restructuring improve readability.

The reordering and restructuring of ParamSymbol values enhance readability and maintainability. The explicit listing of USDC.SEPOLIA is noted.


24-24: Transition to structured type improves type safety.

The transition of ParamChainName to reference ZetaProtocolNetwork enhances type safety and clarity.


26-41: Improved formatting enhances readability.

The improved formatting of ParamType enhances readability and maintainability.

lib/address.tools.ts (8)

41-41: Streamlined test networks improve clarity.

The removal of outdated test networks from ZetaProtocolTestNetwork streamlines the type definition and reflects current usage.


41-41: Constant array aligns with updated type definition.

The zetaProtocolTestNetworks constant array has been updated to reflect the changes in the ZetaProtocolTestNetwork type, ensuring consistency.


63-68: Addition of btc_mainnet broadens scope.

The inclusion of "btc_mainnet" in the ZetaProtocolMainNetwork type broadens the scope of available main networks.


70-76: Constant array aligns with updated type definition.

The zetaProtocolMainNetworks constant array has been updated to include "btc_mainnet", ensuring consistency with the type definition.


78-78: Type definition reflects current state of networks.

The ZetaProtocolNetwork type now encompasses both the updated ZetaProtocolMainNetwork and ZetaProtocolTestNetwork, reflecting the current state of networks.


81-81: Typographical correction improves clarity.

The correction of "Enviroment" to "Environment" improves clarity and accuracy.


86-88: Signature modification allows greater flexibility.

The modification of isTestnetNetwork to accept a string type allows for greater flexibility in input, with explicit type assertions ensuring type safety.


90-92: Signature modification allows greater flexibility.

The modification of isMainnetNetwork to accept a string type allows for greater flexibility in input, with explicit type assertions ensuring type safety.

@lumtis lumtis merged commit 9157fd7 into main Aug 1, 2024
11 checks passed
@lumtis lumtis deleted the andy/pd-6428-remove-outdated-chains-on-protocol-contracts-types branch August 1, 2024 08:28
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.

5 participants