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

Add proposal id option #63

Merged
merged 29 commits into from
Jan 6, 2025
Merged

Conversation

nivcertora
Copy link
Collaborator

@nivcertora nivcertora commented Jan 2, 2025

https://certora.atlassian.net/browse/CERT-7885

PR Summary

This PR modernizes Quorum’s CLI architecture by consolidating the old standalone scripts (check_proposal.py, etc.) into a single entry point, Quorum, with multiple subcommands:

  • single-payload: Validate a single payload (chain + proposal address)
  • config: Process a JSON config for multiple proposals
  • proposal-id: Retrieve payload addresses by proposal ID and validate them
  • ipfs-validate: Compare IPFS content with the on-chain payload using LLM-based analysis
  • create-report: Generate a proposal report via Jinja2 templates
  • setup: Initialize Quorum environment and copy template files

Additionally, the README has been updated to reflect these subcommands and removed references to the old CheckProposal... scripts. The workflow files (CI.yml, publish-pypi.yml) and the packaging config (pyproject.toml, etc.) have also been updated accordingly, ensuring installation, publishing, and usage now align with this new unified CLI approach.

@nivcertora nivcertora requested a review from a team as a code owner January 2, 2025 13:54
@nivcertora nivcertora self-assigned this Jan 2, 2025
@nivcertora nivcertora marked this pull request as draft January 2, 2025 13:55
@nivcertora nivcertora marked this pull request as ready for review January 5, 2025 12:03
liav-certora

This comment was marked as outdated.

Copy link
Contributor

@liav-certora liav-certora left a comment

Choose a reason for hiding this comment

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

There are still comments from my previous review that you didn't address.

Quorum/entry_points/quorum_cli.py Show resolved Hide resolved
Quorum/entry_points/quorum_cli.py Outdated Show resolved Hide resolved
Quorum/tests/test_auto_report.py Show resolved Hide resolved
liav-certora
liav-certora previously approved these changes Jan 6, 2025
Copy link
Contributor

@liav-certora liav-certora left a comment

Choose a reason for hiding this comment

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

Yes now that's great!


To run the tool, use the command line:
**Purpose:** Generates a human-readable report of the proposal details, leveraging Jinja2 templates.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Quorum summary for proposal validation

Copy link
Collaborator

@yoav-el-certora yoav-el-certora left a comment

Choose a reason for hiding this comment

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

Only the create_report subcommand need a fine tuning

@nivcertora nivcertora merged commit 7fc44dd into main Jan 6, 2025
3 checks passed
@nivcertora nivcertora deleted the niv/CERT-7885-Add-Proposal-id-option branch January 6, 2025 19:10
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.

3 participants