Skip to content

Define level of support provided for ABIReturnSubroutine #341

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
michaeldiamant merged 1 commit into from
May 17, 2022
Merged

Define level of support provided for ABIReturnSubroutine #341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion pyteal/ast/subroutine.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,12 @@ def has_return(self):


class ABIReturnSubroutine:
"""Used to create a PyTeal Subroutine (returning an ABI value) from a python function.
"""Used to create a PyTeal Subroutine (returning an ABI value) from a python function. It's primarily intended to define ARC-4 Application entry points though it can also be used more generally.

*Disclaimer*: ABIReturnSubroutine is still taking shape and is subject to backwards incompatible changes.

* For ARC-4 Application entry point definition, feel encouraged to use ABIReturnSubroutine. Expect a best-effort attempt to minimize backwards incompatible changes along with a migration path.
* For general purpose subroutine definition usage, use at your own risk. Based on feedback, the API and usage patterns will change more freely and with less effort to provide migration paths.

This class is meant to be used as a function decorator. For example:

Expand Down