See below for a list of DryRunExecutor methods that allow executing dryruns. It is cumbersome and confusing to have so many methods that basically do the same thing. Ideally, it would be nice to have a single method with the following API:
class DryRunExecutor:
@singledispatch
@classmethod
def execute(
cls: self,
algod: AlgodClient,
program: str,
input: Any,
*,
mode: ExecutionMode = ExecutionMode.Application,
abi_method_signature: Optional[str] = None,
... several more params such as sender, sp, is_app_create, accounts ...
):
raise NotImplementedError("Implement execute method")
Currently, graviton's dry run execution are inconsistent in how abi-information is handled. Some allow abi_argument_types and abi_return_types to be provided while some also allow abi_method_signature to be provided. The last parameter includes all the information that abi_argument_types and abi_return_types provides and therefore it is confusing to provide all the parameters.
After an investigation into the usage of dry run execution in PyTeal, it became apparent that in all relevant situations, an ABIReturnSubroutine object is available for inspection, and it comes with a method method_signature() which could be used to populate an abi_method_signature parameter for dry run execution.
Action Items
Streamline the dry run execution API by refactoring the dry run executing methods as follows:
[x] remove parameter abi_argument_types
[x] remove parameter abi_return_type
[x] add parameter abi_method_signature
[x] ~make all the current dry run executing methods private~ these have been deleted
[x] ~unify into a single execute() function using @singledispatch and @process.register to dispatch via input's type (Further investigation is required here. It may not be possible given the nesting of possible inputs (list[tuple] ... etc .... We may also prefer a multipledispatch approach taking into account the mode parameter's type. It may also be infeasible to dispatch directly and therefore we might need to match directly and delegate.)~ This didn't totally work out. However, we've unified everything into a run() method, with 2 companion convenience methods run_one() and run_sequence()
tzaffi
commented
1 year ago
Problems Summary
Too many executing methods
See below for a list of
DryRunExecutormethods that allow executing dryruns. It is cumbersome and confusing to have so many methods that basically do the same thing. Ideally, it would be nice to have a single method with the following API:This makes use of
functoolssingledispatch decoratorInconsistent abi-type handling
Currently, graviton's dry run execution are inconsistent in how abi-information is handled. Some allow
abi_argument_typesandabi_return_typesto be provided while some also allowabi_method_signatureto be provided. The last parameter includes all the information thatabi_argument_typesandabi_return_typesprovides and therefore it is confusing to provide all the parameters.After an investigation into the usage of dry run execution in PyTeal, it became apparent that in all relevant situations, an
ABIReturnSubroutineobject is available for inspection, and it comes with a methodmethod_signature()which could be used to populate anabi_method_signatureparameter for dry run execution.Action Items
Streamline the dry run execution API by refactoring the dry run executing methods as follows:
abi_argument_typesabi_return_typeabi_method_signatureexecute()function using@singledispatchand@process.registerto dispatch viainput's type (Further investigation is required here. It may not be possible given the nesting of possible inputs (list[tuple]... etc .... We may also prefer a multipledispatch approach taking into account themodeparameter's type. It may also be infeasible to dispatch directly and therefore we might need to match directly and delegate.)~ This didn't totally work out. However, we've unified everything into arun()method, with 2 companion convenience methodsrun_one()andrun_sequence()supress_abi(not done)List of dry run executing methods for refactoring
DryRunExecutor.execute_one_dryrun()DryRunExecutor.dryrun_logicsig()DryRunExecutor.dryrun_app()DryRunExecutor.dryrun_logicsig_on_sequence()DryRunExecutor.dryrun_multiapps_on_sequence()DryRunExecutor.dryrun_app_pair_on_sequence()ABIContractExecutor.dryrun_app_on_sequence()