Skip to content

Add ability to assert identical functionality for teal programs/methods #36

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

Merged
merged 12 commits into from
Dec 7, 2022
Merged

Add ability to assert identical functionality for teal programs/methods #36

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2b606a6
Add ability to assert identical functionality for teal programs/methods
Nov 12, 2022
e53597b
remove commented out code
Nov 14, 2022
93f1b58
tweks
Nov 14, 2022
04ba074
segniore it's inspector not inspectore
Nov 14, 2022
f6e9dfa
fix improve typing and commentary after CR poked holes
Nov 15, 2022
a7630c1
bad alias
Nov 15, 2022
680e9b5
changelog
Nov 15, 2022
0b4130f
better handling when None is the external_expected
Nov 15, 2022
19959cc
report as well
Nov 15, 2022
91fe1f6
Invariant.expected() as well
Nov 15, 2022
62b78c3
black invariant.py
Nov 16, 2022
ce04a9f
Update graviton/blackbox.py
tzaffi Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 90 additions & 5 deletions graviton/blackbox.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
from enum import Enum, auto
import io

from graviton.models import ExecutionMode

from tabulate import tabulate
from typing import (
Any,
Expand All @@ -12,6 +14,7 @@
List,
Optional,
Sequence,
Tuple,
Type,
Union,
cast,
Expand All @@ -36,15 +39,11 @@
)
from graviton.models import ZERO_ADDRESS, ArgType, DryRunAccountType

TealAndMaybeMethod = Union[Tuple[str], Tuple[str, str]]

MAX_APP_ARG_LIMIT = atc.AtomicTransactionComposer.MAX_APP_ARG_LIMIT


class ExecutionMode(Enum):
Signature = auto()
Application = auto()


class DryRunProperty(Enum):
cost = auto()
budgetAdded = auto()
Expand Down Expand Up @@ -420,6 +419,7 @@ def dryrun_app(
is_app_create: bool = False,
on_complete: OnComplete = OnComplete.NoOpOC,
*,
abi_method_signature: Optional[str] = None,
sender: Optional[str] = None,
sp: Optional[SuggestedParams] = None,
index: Optional[int] = None,
Expand Down Expand Up @@ -455,6 +455,7 @@ def dryrun_app(
teal,
args,
ExecutionMode.Application,
abi_method_signature=abi_method_signature,
abi_argument_types=abi_argument_types,
abi_return_type=abi_return_type,
txn_params=cls.transaction_params(
Expand Down Expand Up @@ -519,12 +520,71 @@ def dryrun_logicsig(
),
)

@classmethod
def dryrun_app_pair_on_sequence(
cls,
algod: AlgodClient,
teal_and_method1: TealAndMaybeMethod,
teal_and_method2: TealAndMaybeMethod,
inputs: List[Sequence[PyTypes]],
abi_argument_types: Optional[List[Optional[abi.ABIType]]] = None,
abi_return_type: Optional[abi.ABIType] = None,
is_app_create: bool = False,
on_complete: OnComplete = OnComplete.NoOpOC,
dryrun_accounts: List[DryRunAccountType] = [],
) -> Tuple[Sequence["DryRunInspector"], Sequence["DryRunInspector"]]:
return tuple( # type: ignore
Copy link
Contributor Author

Choose a reason for hiding this comment

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

to the best of my current understand, to fix this type-hints issue would require an upgrade to python 3.11

cls.dryrun_multiapps_on_sequence(
algod=algod,
multi_teal_method_pairs=[teal_and_method1, teal_and_method2],
inputs=inputs,
abi_argument_types=abi_argument_types,
abi_return_type=abi_return_type,
is_app_create=is_app_create,
on_complete=on_complete,
dryrun_accounts=dryrun_accounts,
)
)

@classmethod
def dryrun_multiapps_on_sequence(
cls,
algod: AlgodClient,
multi_teal_method_pairs: List[TealAndMaybeMethod],
inputs: List[Sequence[PyTypes]],
abi_argument_types: Optional[List[Optional[abi.ABIType]]] = None,
abi_return_type: Optional[abi.ABIType] = None,
is_app_create: bool = False,
on_complete: OnComplete = OnComplete.NoOpOC,
dryrun_accounts: List[DryRunAccountType] = [],
) -> List[Sequence["DryRunInspector"]]:
def runner(teal_method_pair):
teal = teal_method_pair[0]
abi_method = None
if len(teal_method_pair) > 1:
abi_method = teal_method_pair[1]

return cls.dryrun_app_on_sequence(
algod=algod,
teal=teal,
inputs=inputs,
abi_method=abi_method,
abi_argument_types=abi_argument_types,
abi_return_type=abi_return_type,
is_app_create=is_app_create,
on_complete=on_complete,
dryrun_accounts=dryrun_accounts,
)

return list(map(runner, multi_teal_method_pairs))

@classmethod
def dryrun_app_on_sequence(
cls,
algod: AlgodClient,
teal: str,
inputs: List[Sequence[PyTypes]],
abi_method: Optional[str] = None,
abi_argument_types: Optional[List[Optional[abi.ABIType]]] = None,
abi_return_type: Optional[abi.ABIType] = None,
is_app_create: bool = False,
Expand All @@ -538,6 +598,7 @@ def dryrun_app_on_sequence(
algod=algod,
teal=teal,
args=args,
abi_method_signature=abi_method,
abi_argument_types=abi_argument_types,
abi_return_type=abi_return_type,
is_app_create=is_app_create,
Expand Down Expand Up @@ -578,16 +639,30 @@ def execute_one_dryrun(
teal: str,
args: Sequence[PyTypes],
mode: ExecutionMode,
abi_method_signature: Optional[str] = None,
abi_argument_types: Optional[List[Optional[abi.ABIType]]] = None,
abi_return_type: Optional[abi.ABIType] = None,
txn_params: dict = {},
accounts: List[DryRunAccountType] = [],
verbose: bool = False,
) -> "DryRunInspector":
assert (
len(ExecutionMode) == 2
), f"assuming only 2 ExecutionMode's but have {len(ExecutionMode)}"
assert mode in ExecutionMode, f"unknown mode {mode} of type {type(mode)}"
is_app = mode == ExecutionMode.Application

if abi_method_signature:
assert not (
abi_argument_types or abi_return_type
), f"provided method {abi_method_signature}, so should not have provided argument types {abi_argument_types} not return type {abi_return_type}"
method = abi.Method.from_signature(abi_method_signature)
selector = method.get_selector()
# the method selector is not abi-encoded, hence its abi-type is set to None
abi_argument_types = [None] + [a.type for a in method.args]
args = tuple([selector] + list(args))
abi_return_type = method.returns.type

encoded_args = DryRunEncoder.encode_args(args, abi_types=abi_argument_types)

dryrun_req: DryrunRequest
Expand All @@ -599,7 +674,11 @@ def execute_one_dryrun(
dryrun_req = DryRunHelper.singleton_logicsig_request(
teal, encoded_args, txn_params
)
if verbose:
print(f"{cls}::execute_one_dryrun(): {dryrun_req=}")
dryrun_resp = algod.dryrun(dryrun_req)
if verbose:
print(f"{cls}::execute_one_dryrun(): {dryrun_resp=}")
return DryRunInspector.from_single_response(
dryrun_resp, args, encoded_args, abi_type=abi_return_type
)
Expand Down Expand Up @@ -896,6 +975,12 @@ def __init__(
show_internal_errors_on_log=True,
)

def method_selector_param(self) -> Optional[str]:
return cast(str, self.args[0]) if self.abi_type else None

def abi_params_or_args(self) -> Tuple[PyTypes, ...]:
return tuple(self.args[1:] if self.abi_type else self.args)

def config(self, **kwargs: bool):
bad_keys = set(kwargs.keys()) - self.CONFIG_OPTIONS
if bad_keys:
Expand Down
Loading