Skip to content
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.

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

Add methods descriptions to ABI JSON #24

Closed
cusma opened this issue Aug 29, 2022 · 0 comments
Closed

Add methods descriptions to ABI JSON #24

cusma opened this issue Aug 29, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@cusma
Copy link
Contributor

cusma commented Aug 29, 2022

Currently the Smart ASA ABI JSON, automatically generated by PyTeal, does not include methods descriptions.

Would be very useful to improve the JSON ABI once this improvement is merged into PyTeal.

Example:

def asset_transfer(
    xfer_asset: abi.Asset,
    asset_amount: abi.Uint64,
    asset_sender: abi.Account,
    asset_receiver: abi.Account,
) -> Expr:
    """
    Smart ASA Transfer: regular, mint, burn, clawback.
    
    Args:
        xfer_asset: Smart ASA ID.
        asset_amount: Smart ASA amount.
        asset_sender: Account to transfer Smart ASA from.
        asset_receiver: Account to transfer Smart ASA to.
    """
    ...
@cusma cusma added the enhancement New feature or request label Aug 29, 2022
@cusma cusma closed this as completed Sep 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant