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: cli warp route checker #4667

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Conversation

xeno097
Copy link
Contributor

@xeno097 xeno097 commented Oct 10, 2024

Description

This PR implements the warp check command to compare on-chain warp deployments with provided configuration files

Drive-by changes

  • updated the inputFileCommandOption to be a function for defining cli input file args
  • defined the DEFAULT_WARP_ROUTE_DEPLOYMENT_CONFIG_PATH to avoid hardcoding the ./configs/warp-route-deployment.yaml file path
  • implemented the logCommandHeader function to format the command header and avoid always having to manually log the --- separator in command outputs
  • implements the getWarpCoreConfigOrExit to get the warp core configuration from either the registry or a user-defined path and exit early if no input value is provided
  • Updated the IsmConfigSchemas to include the BaseIsmConfigSchema because when parsing config files the address field was not included in the parsed object as it wasn't defined on the type

Example output
image

image

image

Related issues

Backward compatibility

  • Yes

Testing

  • Manual

Copy link

changeset-bot bot commented Oct 10, 2024

🦋 Changeset detected

Latest commit: aef7fd7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages
Name Type
@hyperlane-xyz/cli Minor
@hyperlane-xyz/sdk Minor
@hyperlane-xyz/helloworld Minor
@hyperlane-xyz/infra Minor
@hyperlane-xyz/widgets Minor
@hyperlane-xyz/ccip-server Minor
@hyperlane-xyz/github-proxy Minor
@hyperlane-xyz/utils Minor
@hyperlane-xyz/core Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

codecov bot commented Oct 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.85%. Comparing base (46044a2) to head (aef7fd7).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4667   +/-   ##
=======================================
  Coverage   73.85%   73.85%           
=======================================
  Files         100      100           
  Lines        1423     1423           
  Branches      181      181           
=======================================
  Hits         1051     1051           
  Misses        351      351           
  Partials       21       21           
Components Coverage Δ
core 84.61% <ø> (ø)
hooks 75.71% <ø> (ø)
isms 78.94% <ø> (ø)
token 88.23% <ø> (ø)
middlewares 77.39% <ø> (ø)

@xeno097 xeno097 changed the title feat/cli warp route checker feat: cli warp route checker Oct 10, 2024
Copy link
Member

@yorhodes yorhodes left a comment

Choose a reason for hiding this comment

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

quite cool
a little wary of the SDK schema changes

typescript/sdk/src/ism/schemas.ts Outdated Show resolved Hide resolved
typescript/sdk/src/ism/schemas.ts Outdated Show resolved Hide resolved
typescript/cli/src/utils/output.ts Outdated Show resolved Hide resolved
typescript/cli/src/utils/output.ts Outdated Show resolved Hide resolved
typescript/cli/src/utils/output.ts Outdated Show resolved Hide resolved
typescript/cli/src/utils/output.ts Outdated Show resolved Hide resolved
typescript/cli/src/utils/output.ts Outdated Show resolved Hide resolved
typescript/cli/src/utils/output.ts Outdated Show resolved Hide resolved
typescript/cli/src/utils/output.ts Show resolved Hide resolved
typescript/cli/src/check/warp.ts Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

Checker -> CLI
3 participants