Skip to content

Refactor DryRunExecutor #45

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
Merged
merged 82 commits into from
Jan 17, 2023
Merged

Refactor DryRunExecutor #45

merged 82 commits into from
Jan 17, 2023

Conversation

tzaffi
Copy link
Contributor

@tzaffi tzaffi commented Jan 3, 2023 •
edited
Loading

The diff in graviton/blackbox.py is difficult to read through. Instead of looking at the diff, I encourage looking at the actual code. Additionally, this is a testing library, and therefore (IMO) we can gain most of the confidence by looking at the test results both here and in the companion pyteal PR.

Former PR

#44

Issues Addressed

Summary of changes

  • graviton/blackbox.py:
    • Introducing class DryRunTransactionParams for better grouping of some variables
    • Trimming stale comments
    • class DryRunExecutor:
      • Removed all the static dryrun_* methods and consolidated functionality as follows:
      • It is now expected that the user will instantiate a DryRunExecutor object and call run() on it. Convenience methods run_one() and run_sequence() are also provided, and these have better type guarantees.
  • *_test.py and quadratic_factoring_game.ipynb - Migrating all the tests to use run_one() and run_sequence() methods (except for the usage of AbiContractExecutor.dry_run_on_sequence() which remains unaffected)
  • Adding unit tests in tests/unit/encode_test.py
    • test_executor_init
    • test_executor_prep

TODO's

Zeph Grunschlag and others added 30 commits December 22, 2022 17:37
with cost no longer coming back, and the coming need to support simul…
4b78ce2 
…ate, remove the deprecated dry run mixins
remove error prone method Invariant.inputs_and_invariants
d28308b
need to tranform via Invariant.as_invariants()
f6f301a
more control over validation and whether a method selector is provide…
026926f 
…d... but still need the multidispatcher
deprecate the majority of the original remaning dryrun.py
6ed2789
small typing fix + EncodingType
df452d5
type ignores
fa09d15
@tzaffi
Small type fix (algorand#43)
26d47e3 
* small typing fix + EncodingType

* type ignores
changelog
b92911c
good place to commit as passing tests (except one error in mypy)
9b18a63
another good place to stop
a573529
DryRunInspector typing
b3e2ce3
passing
9499253
green stop
34801b3
orphan execute_one_dryryrun while still passing
9dcc532
refactor orphans dryrun_logicsig()
9ea7247
DryRunTranaactionParams.for_app()
e312964
Refactor orphans DryRunExecution.dryrun_app()
dccdc74
Refactor orphans DryRunExecutor.dryrun_logicsig_on_sequence()
37c1e5b
refactor orphans DryRunExecutor.dryrun_app_on_sequence()
1cee24c
allow maps as well as list for multiple inputs
854089b
Refactor orphans dryrun_app_pair_on_sequence
ee89949
deprecated section
e67f692
deprecated_ prefix
faf824c
deprecated_ prefix
b015ec3
remove deprecated
e69ef17
convenience methods run_one and run_sequence
c032a16
v 0.7.0
96bb5fd
remove unused DryRunnable
1ec5213
trim stale comments
a6277fc
@tzaffi tzaffi mentioned this pull request Jan 13, 2023
Merged
1 task
Zeph Grunschlag added 2 commits January 13, 2023 14:02
tzaffi
tzaffi commented Jan 13, 2023
View reviewed changes
graviton/blackbox.py
CREATION_APP_CALL: Final[int] = 0
EXISTING_APP_CALL: Final[int] = 42
@dataclass(frozen=True)
class DryRunTransactionParams:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

New class

ahangsu
ahangsu reviewed Jan 13, 2023
View reviewed changes
@tzaffi tzaffi marked this pull request as ready for review January 17, 2023 03:53
tzaffi
tzaffi commented Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
ahangsu
ahangsu reviewed Jan 17, 2023
View reviewed changes
Copy link
Contributor

@ahangsu ahangsu left a comment

Choose a reason for hiding this comment

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

generally looks good, I am going to take a final pass, if there's nothing off I notice, I will approve.

ahangsu
ahangsu approved these changes Jan 17, 2023
View reviewed changes
Copy link
Contributor

@ahangsu ahangsu left a comment

Choose a reason for hiding this comment

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

the last comment still holds, but once that is done, let's ship it.

@tzaffi tzaffi merged commit 1291adb into algorand:main Jan 17, 2023
This was referenced Jan 19, 2023
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ahangsu ahangsu ahangsu approved these changes

@bbroder-algo bbroder-algo Awaiting requested review from bbroder-algo

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tzaffi @ahangsu @bbroder-algo