Skip to content

feat: allow broader types when specifying methods and app_spec in ApplicationClient #7

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 2 commits into from
Mar 28, 2023
Merged

feat: allow broader types when specifying methods and app_spec in ApplicationClient #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f702d4a
feat: allow broader types when specifying methods and app_spec in App…
daniel-makerx Mar 28, 2023
5235c68
test: add tests for new types on app client
daniel-makerx Mar 28, 2023
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
90 changes: 53 additions & 37 deletions src/algokit_utils/application_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
import dataclasses
import logging
import re
import typing
from collections.abc import Sequence
from math import ceil
from pathlib import Path
from typing import Any, Literal, TypedDict, cast, overload

import algosdk
Expand Down Expand Up @@ -56,6 +58,14 @@
]


class ABIReturnSubroutine(typing.Protocol):
def method_spec(self) -> Method:
...


ABIMethod: typing.TypeAlias = ABIReturnSubroutine | Method | str


class Program:
"""A compiled TEAL program"""

Expand Down Expand Up @@ -117,7 +127,7 @@ class CreateCallParametersDict(TypedDict, OnCompleteCallParametersDict, total=Fa

@dataclasses.dataclass(kw_only=True)
class ABICallArgs:
method: Method | str | bool | None = None
method: ABIMethod | bool | None = None
args: ABIArgsDict = dataclasses.field(default_factory=dict)
suggested_params: transaction.SuggestedParams | None = None
lease: bytes | str | None = None
Expand All @@ -135,7 +145,7 @@ class ABICreateCallArgs(ABICallArgs):


class ABICallArgsDict(TypedDict, total=False):
method: Method | str | bool
method: ABIMethod | bool
args: ABIArgsDict
suggested_params: transaction.SuggestedParams
lease: bytes | str
Expand All @@ -156,7 +166,7 @@ class ApplicationClient:
def __init__(
self,
algod_client: AlgodClient,
app_spec: au_spec.ApplicationSpecification,
app_spec: au_spec.ApplicationSpecification | Path,
*,
app_id: int = 0,
signer: TransactionSigner | Account | None = None,
Expand All @@ -170,7 +180,7 @@ def __init__(
def __init__(
self,
algod_client: AlgodClient,
app_spec: au_spec.ApplicationSpecification,
app_spec: au_spec.ApplicationSpecification | Path,
*,
creator: str | Account,
indexer_client: IndexerClient | None = None,
Expand All @@ -185,7 +195,7 @@ def __init__(
def __init__(
self,
algod_client: AlgodClient,
app_spec: au_spec.ApplicationSpecification,
app_spec: au_spec.ApplicationSpecification | Path,
*,
app_id: int = 0,
creator: str | Account | None = None,
Expand All @@ -197,15 +207,17 @@ def __init__(
template_values: au_deploy.TemplateValueDict | None = None,
):
self.algod_client = algod_client
self.app_spec = app_spec
self.app_spec = (
au_spec.ApplicationSpecification.from_json(app_spec.read_text()) if isinstance(app_spec, Path) else app_spec
)
self._approval_program: Program | None
self._clear_program: Program | None

if template_values:
self._approval_program, self._clear_program = substitute_template_and_compile(
self.algod_client, app_spec, template_values
self.algod_client, self.app_spec, template_values
)
elif not au_deploy.has_template_vars(app_spec):
elif not au_deploy.has_template_vars(self.app_spec):
self._approval_program = Program(self.app_spec.approval_program, self.algod_client)
self._clear_program = Program(self.app_spec.clear_program, self.algod_client)
else: # can't compile programs yet
Expand Down Expand Up @@ -503,7 +515,7 @@ def compose_create(
self,
atc: AtomicTransactionComposer,
/,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CreateCallParameters | CreateCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> None:
Expand Down Expand Up @@ -541,7 +553,7 @@ def create(
@overload
def create(
self,
call_abi_method: Method | str | Literal[True],
call_abi_method: ABIMethod | Literal[True],
transaction_parameters: CreateCallParameters | CreateCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> ABITransactionResponse:
Expand All @@ -550,15 +562,15 @@ def create(
@overload
def create(
self,
call_abi_method: Method | str | bool | None = ...,
call_abi_method: ABIMethod | bool | None = ...,
transaction_parameters: CreateCallParameters | CreateCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
...

def create(
self,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CreateCallParameters | CreateCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
Expand All @@ -580,7 +592,7 @@ def compose_update(
self,
atc: AtomicTransactionComposer,
/,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> None:
Expand All @@ -600,7 +612,7 @@ def compose_update(
@overload
def update(
self,
call_abi_method: Method | str | Literal[True],
call_abi_method: ABIMethod | Literal[True],
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> ABITransactionResponse:
Expand All @@ -617,15 +629,15 @@ def update(
@overload
def update(
self,
call_abi_method: Method | str | bool | None = ...,
call_abi_method: ABIMethod | bool | None = ...,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
...

def update(
self,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
Expand All @@ -644,7 +656,7 @@ def compose_delete(
self,
atc: AtomicTransactionComposer,
/,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> None:
Expand All @@ -661,7 +673,7 @@ def compose_delete(
@overload
def delete(
self,
call_abi_method: Method | str | Literal[True],
call_abi_method: ABIMethod | Literal[True],
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> ABITransactionResponse:
Expand All @@ -678,15 +690,15 @@ def delete(
@overload
def delete(
self,
call_abi_method: Method | str | bool | None = ...,
call_abi_method: ABIMethod | bool | None = ...,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
...

def delete(
self,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
Expand All @@ -705,7 +717,7 @@ def compose_call(
self,
atc: AtomicTransactionComposer,
/,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: OnCompleteCallParameters | OnCompleteCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> None:
Expand All @@ -722,7 +734,7 @@ def compose_call(
@overload
def call(
self,
call_abi_method: Method | str | Literal[True],
call_abi_method: ABIMethod | Literal[True],
transaction_parameters: OnCompleteCallParameters | OnCompleteCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> ABITransactionResponse:
Expand All @@ -739,15 +751,15 @@ def call(
@overload
def call(
self,
call_abi_method: Method | str | bool | None = ...,
call_abi_method: ABIMethod | bool | None = ...,
transaction_parameters: OnCompleteCallParameters | OnCompleteCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
...

def call(
self,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: OnCompleteCallParameters | OnCompleteCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
Expand Down Expand Up @@ -776,7 +788,7 @@ def compose_opt_in(
self,
atc: AtomicTransactionComposer,
/,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> None:
Expand All @@ -792,7 +804,7 @@ def compose_opt_in(
@overload
def opt_in(
self,
call_abi_method: Method | str | Literal[True] = ...,
call_abi_method: ABIMethod | Literal[True] = ...,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> ABITransactionResponse:
Expand All @@ -809,15 +821,15 @@ def opt_in(
@overload
def opt_in(
self,
call_abi_method: Method | str | bool | None = ...,
call_abi_method: ABIMethod | bool | None = ...,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
...

def opt_in(
self,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
Expand All @@ -835,7 +847,7 @@ def compose_close_out(
self,
atc: AtomicTransactionComposer,
/,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> None:
Expand All @@ -851,7 +863,7 @@ def compose_close_out(
@overload
def close_out(
self,
call_abi_method: Method | str | Literal[True],
call_abi_method: ABIMethod | Literal[True],
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> ABITransactionResponse:
Expand All @@ -868,15 +880,15 @@ def close_out(
@overload
def close_out(
self,
call_abi_method: Method | str | bool | None = ...,
call_abi_method: ABIMethod | bool | None = ...,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = ...,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
...

def close_out(
self,
call_abi_method: Method | str | bool | None = None,
call_abi_method: ABIMethod | bool | None = None,
transaction_parameters: CommonCallParameters | CommonCallParametersDict | None = None,
**abi_kwargs: ABIArgType,
) -> TransactionResponse | ABITransactionResponse:
Expand Down Expand Up @@ -943,7 +955,7 @@ def get_local_state(self, account: str | None = None, *, raw: bool = False) -> d

def resolve(self, to_resolve: au_spec.DefaultArgumentDict) -> int | str | bytes:
def _data_check(value: Any) -> int | str | bytes:
if isinstance(value, (int, str, bytes)):
if isinstance(value, int | str | bytes):
return value
raise ValueError(f"Unexpected type for constant data: {value}")

Expand Down Expand Up @@ -1017,7 +1029,7 @@ def _check_app_id(self) -> None:

def _resolve_method(
self,
abi_method: Method | str | bool | None,
abi_method: ABIMethod | bool | None,
args: ABIArgsDict | None,
on_complete: transaction.OnComplete,
call_config: au_spec.CallConfig = au_spec.CallConfig.CALL,
Expand All @@ -1036,6 +1048,8 @@ def _resolve_method(
matches += abi_methods
if has_bare_config and abi_method is not True:
matches += [None]
case _:
return abi_method.method_spec()

if len(matches) == 1: # exact match
return matches[0]
Expand All @@ -1059,7 +1073,7 @@ def _get_approval_source_map(self) -> SourceMap | None:
def add_method_call(
self,
atc: AtomicTransactionComposer,
abi_method: Method | str | bool | None = None,
abi_method: ABIMethod | bool | None = None,
abi_args: ABIArgsDict | None = None,
app_id: int | None = None,
parameters: CommonCallParameters | CommonCallParametersDict | None = None,
Expand Down Expand Up @@ -1191,13 +1205,15 @@ def _find_abi_methods(
if self._method_matches(method, args, on_complete, call_config)
]

def _resolve_abi_method(self, method: Method | str) -> Method:
def _resolve_abi_method(self, method: ABIMethod) -> Method:
if isinstance(method, str):
try:
return next(iter(m for m in self.app_spec.contract.methods if m.get_signature() == method))
except StopIteration:
pass
return self.app_spec.contract.get_method_by_name(method)
elif hasattr(method, "method_spec"):
return method.method_spec()
else:
return method

Expand Down Expand Up @@ -1326,7 +1342,7 @@ def _convert_deploy_args(
note: au_deploy.AppDeployMetaData,
signer: TransactionSigner | None,
sender: str | None,
) -> tuple[Method | str | bool | None, ABIArgsDict, CreateCallParameters]:
) -> tuple[ABIMethod | bool | None, ABIArgsDict, CreateCallParameters]:
args = dataclasses.asdict(_args) if isinstance(_args, ABICallArgs) else (_args or {})

# return most derived type, unused parameters are ignored
Expand Down
Loading