Skip to content

Add simulator package #247

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

Add simulator package #247

wants to merge 17 commits into from

Conversation

andrew-fleming
Copy link
Contributor

@andrew-fleming andrew-fleming commented Sep 15, 2025 •
edited
Loading

Types of changes

What types of changes does your code introduce to OpenZeppelin Midnight Contracts?
Put an x in the boxes that apply

  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
    • breaking current testing structure and empty witness format

Fixes #???

PR Checklist

  • I have read the Contributing Guide
  • I have added tests that prove my fix is effective or that my feature works
  • I have added documentation of new methods and any new behavior or changes to existing behavior
  • CI Workflows Are Passing

Overview

WIP

0xisk
0xisk reviewed Oct 9, 2025
View reviewed changes
Copy link
Member

@0xisk 0xisk left a comment

Choose a reason for hiding this comment

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

This PR really adds a lot of improvements for the testing framework. This is not a complete review. Wondering what is left for this PR to be open?

packages/simulator/package.json Outdated
@@ -0,0 +1,42 @@
{
"name": "@openzeppelin-compact/simulator",
Copy link
Member

@0xisk 0xisk Oct 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
"name": "@openzeppelin-compact/simulator",
"name": "@openzeppelin-compact/contracts-simulator",

I was thinking that should be more specific, as in the suggestion.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

+1 to contracts-simulator

Copy link
Member

Choose a reason for hiding this comment

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

Ah yes that is better, Compact is already there.

packages/simulator/src/core/ContractSimulator.ts
Comment on lines +23 to +24
/** Retrieves the current public ledger state */
abstract getPublicState(): L;
Copy link
Member

Choose a reason for hiding this comment

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

Why is it not part of the StateManager?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That would make sense haha nah "StateManager" wasn't a good name. I changed it to "CircuitContextManager" which I think provides more clarity

@andrew-fleming
Copy link
Contributor Author

This PR really adds a lot of improvements for the testing framework. This is not a complete review. Wondering what is left for this PR to be open?

@0xisk Thank you! I just needed to add some fixes so the CI would not fail. All good now

@andrew-fleming andrew-fleming marked this pull request as ready for review October 10, 2025 07:10
@andrew-fleming andrew-fleming requested a review from a team as a code owner October 10, 2025 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@0xisk 0xisk 0xisk left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@andrew-fleming @0xisk