Skip to content

allow passing router description to Contract constructor #448

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
barnjamin merged 4 commits into from
Jul 18, 2022
Merged

allow passing router description to Contract constructor #448

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb01065
allow passing router description to Contract constructor
barnjamin Jul 18, 2022
3db8ea5
update docstrings
barnjamin Jul 18, 2022
c578c98
dont declare type on optional type
barnjamin Jul 18, 2022
8441003
move descr to the end to prevent overriding with bare_calls
barnjamin Jul 18, 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
8 changes: 6 additions & 2 deletions pyteal/ast/router.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,14 +505,18 @@ def __init__(
self,
name: str,
bare_calls: BareCallActions = None,
descr: str = None,
) -> None:
"""
Args:
name: the name of the smart contract, used in the JSON object.
bare_calls: the bare app call registered for each on_completion.
descr: a description of the smart contract, used in the JSON object.
"""

self.name: str = name
self.descr = descr

self.approval_ast = ASTBuilder()
self.clear_state_ast = ASTBuilder()

Expand Down Expand Up @@ -662,10 +666,10 @@ def contract_construct(self) -> sdk_abi.Contract:

Returns:
contract: a dictified `Contract` object constructed from
approval program's method specs and `self.name`.
approval program's method specs, `self.name`, and `self.descr`.
"""

return sdk_abi.Contract(self.name, self.methods)
return sdk_abi.Contract(self.name, self.methods, self.descr)

def build_program(self) -> tuple[Expr, Expr, sdk_abi.Contract]:
"""
Expand Down