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

ABI methods' docstring #26

Merged
merged 1 commit into from
Sep 20, 2022
Merged

ABI methods' docstring #26

merged 1 commit into from
Sep 20, 2022

Conversation

cusma
Copy link
Contributor

@cusma cusma commented Sep 20, 2022

This PR addresses #14 and #24, by adding methods' docstring natively supported by PyTeal.

@cusma cusma requested a review from deanstef September 20, 2022 11:16
@cusma cusma changed the base branch from main to develop September 20, 2022 11:17
@cusma cusma changed the title Feature/docstings ABI methods' docstring Sep 20, 2022
@cusma cusma merged commit d94165b into develop Sep 20, 2022
@cusma cusma deleted the feature/docstings branch September 20, 2022 11:57
cusma added a commit that referenced this pull request Jan 4, 2023
* added getter for the whole config of an asa

* Note over Tuple limitation

* params normalizer utility

* tests for getters recovered

* minor changes to

* Better utils

* minor fixes in

* WIP: Rename CLI.

* last fixes in branch

* Better README for CLI

* Current directory

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Current path 2.

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* minor fixes

* Update README.md

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update account.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* named tuples in config getter normalizer

* Linting.

* better NamedTuple usage

* metadata hash encoding

* fix getters in readme (#7)

* Contract json (#8)

* fix getters in readme

* added contract interface to repo

* fix linter

* fix readme: getters and abi (#9)

* Add community credits to `README.md`

* Use of `abi.NamedTuple` struct in getter `get_asset_config` (#17)

* Use of  in getter

* removing irrelevant comment

* minor change

* `namedtuple` from `abi.NamedTuple`

* Getting annotation the right way.

Co-authored-by: cusma <cosimo.bassi@gmail.com>

* README: deployed App example

* Add TEAL programs. (#19)

* Aligning `main` to `develop` (#22)

* NamedTuple getter (#18)

* added getter for the whole config of an asa

* Note over Tuple limitation

* params normalizer utility

* tests for getters recovered

* minor changes to

* Better utils

* minor fixes in

* WIP: Rename CLI.

* last fixes in branch

* Better README for CLI

* Current directory

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Current path 2.

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* minor fixes

* Update README.md

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update account.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* named tuples in config getter normalizer

* Linting.

* better NamedTuple usage

* metadata hash encoding

* fix getters in readme (#7)

* Contract json (#8)

* fix getters in readme

* added contract interface to repo

* fix linter

* fix readme: getters and abi (#9)

* Add community credits to `README.md`

* Use of `abi.NamedTuple` struct in getter `get_asset_config` (#17)

* Use of  in getter

* removing irrelevant comment

* minor change

* `namedtuple` from `abi.NamedTuple`

* Getting annotation the right way.

Co-authored-by: cusma <cosimo.bassi@gmail.com>

* README: deployed App example

Co-authored-by: deanstef <stefano@algorand.com>
Co-authored-by: Matteo Almanza <matteojug@gmail.com>
Co-authored-by: Adriano Di Luzio <aldur@users.noreply.github.com>

* Publish TEAL programs (#21)

* added getter for the whole config of an asa

* Note over Tuple limitation

* params normalizer utility

* tests for getters recovered

* minor changes to

* Better utils

* minor fixes in

* WIP: Rename CLI.

* last fixes in branch

* Better README for CLI

* Current directory

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Current path 2.

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* minor fixes

* Update README.md

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update account.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* named tuples in config getter normalizer

* Linting.

* better NamedTuple usage

* metadata hash encoding

* fix getters in readme (#7)

* Contract json (#8)

* fix getters in readme

* added contract interface to repo

* fix linter

* fix readme: getters and abi (#9)

* Add community credits to `README.md`

* Use of `abi.NamedTuple` struct in getter `get_asset_config` (#17)

* Use of  in getter

* removing irrelevant comment

* minor change

* `namedtuple` from `abi.NamedTuple`

* Getting annotation the right way.

Co-authored-by: cusma <cosimo.bassi@gmail.com>

* README: deployed App example

* Add TEAL programs. (#19)

Co-authored-by: deanstef <stefano@algorand.com>
Co-authored-by: Matteo Almanza <matteojug@gmail.com>
Co-authored-by: Adriano Di Luzio <aldur@users.noreply.github.com>

Co-authored-by: deanstef <stefano@algorand.com>
Co-authored-by: Matteo Almanza <matteojug@gmail.com>
Co-authored-by: Adriano Di Luzio <aldur@users.noreply.github.com>

* Add methods' `docstring`. Update JSON with description. Bump PyTeal version. (#26)

* Bump TEAL version (#27)

* Bump TEAL version. Better methods' docstrings.

* Bump `algod` version in CI.

* Bump GH actions version. Stop running images.

* Update TEAL and ABI JSON. Fixed `algod` version in CI.

* Add App Example and TEAL references. (#29)

Co-authored-by: deanstef <stefano@algorand.com>
Co-authored-by: Matteo Almanza <matteojug@gmail.com>
Co-authored-by: Adriano Di Luzio <aldur@users.noreply.github.com>
cusma added a commit that referenced this pull request Jan 5, 2023
* added getter for the whole config of an asa

* Note over Tuple limitation

* params normalizer utility

* tests for getters recovered

* minor changes to

* Better utils

* minor fixes in

* WIP: Rename CLI.

* last fixes in branch

* Better README for CLI

* Current directory

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Current path 2.

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* minor fixes

* Update README.md

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update account.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* named tuples in config getter normalizer

* Linting.

* better NamedTuple usage

* metadata hash encoding

* fix getters in readme (#7)

* Contract json (#8)

* fix getters in readme

* added contract interface to repo

* fix linter

* fix readme: getters and abi (#9)

* Add community credits to `README.md`

* Use of `abi.NamedTuple` struct in getter `get_asset_config` (#17)

* Use of  in getter

* removing irrelevant comment

* minor change

* `namedtuple` from `abi.NamedTuple`

* Getting annotation the right way.

Co-authored-by: cusma <cosimo.bassi@gmail.com>

* README: deployed App example

* Add TEAL programs. (#19)

* Aligning `main` to `develop` (#22)

* NamedTuple getter (#18)

* added getter for the whole config of an asa

* Note over Tuple limitation

* params normalizer utility

* tests for getters recovered

* minor changes to

* Better utils

* minor fixes in

* WIP: Rename CLI.

* last fixes in branch

* Better README for CLI

* Current directory

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Current path 2.

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* minor fixes

* Update README.md

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update account.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* named tuples in config getter normalizer

* Linting.

* better NamedTuple usage

* metadata hash encoding

* fix getters in readme (#7)

* Contract json (#8)

* fix getters in readme

* added contract interface to repo

* fix linter

* fix readme: getters and abi (#9)

* Add community credits to `README.md`

* Use of `abi.NamedTuple` struct in getter `get_asset_config` (#17)

* Use of  in getter

* removing irrelevant comment

* minor change

* `namedtuple` from `abi.NamedTuple`

* Getting annotation the right way.

Co-authored-by: cusma <cosimo.bassi@gmail.com>

* README: deployed App example

Co-authored-by: deanstef <stefano@algorand.com>
Co-authored-by: Matteo Almanza <matteojug@gmail.com>
Co-authored-by: Adriano Di Luzio <aldur@users.noreply.github.com>

* Publish TEAL programs (#21)

* added getter for the whole config of an asa

* Note over Tuple limitation

* params normalizer utility

* tests for getters recovered

* minor changes to

* Better utils

* minor fixes in

* WIP: Rename CLI.

* last fixes in branch

* Better README for CLI

* Current directory

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Current path 2.

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* minor fixes

* Update README.md

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update account.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Update smart_asa_test.py

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* named tuples in config getter normalizer

* Linting.

* better NamedTuple usage

* metadata hash encoding

* fix getters in readme (#7)

* Contract json (#8)

* fix getters in readme

* added contract interface to repo

* fix linter

* fix readme: getters and abi (#9)

* Add community credits to `README.md`

* Use of `abi.NamedTuple` struct in getter `get_asset_config` (#17)

* Use of  in getter

* removing irrelevant comment

* minor change

* `namedtuple` from `abi.NamedTuple`

* Getting annotation the right way.

Co-authored-by: cusma <cosimo.bassi@gmail.com>

* README: deployed App example

* Add TEAL programs. (#19)

Co-authored-by: deanstef <stefano@algorand.com>
Co-authored-by: Matteo Almanza <matteojug@gmail.com>
Co-authored-by: Adriano Di Luzio <aldur@users.noreply.github.com>

Co-authored-by: deanstef <stefano@algorand.com>
Co-authored-by: Matteo Almanza <matteojug@gmail.com>
Co-authored-by: Adriano Di Luzio <aldur@users.noreply.github.com>

* Add methods' `docstring`. Update JSON with description. Bump PyTeal version. (#26)

* Bump TEAL version (#27)

* Bump TEAL version. Better methods' docstrings.

* Bump `algod` version in CI.

* Bump GH actions version. Stop running images.

* Update TEAL and ABI JSON. Fixed `algod` version in CI.

* Add App Example and TEAL references. (#29)

* Commented Asserts (#32)

* Switch to `InnerTxnBuilder.Execute`

* WIP: Split asserts with errors

* WIP: Split asserts with errors

* Commented asserts pt.2

* commented asserts complete

* Update TEAL

* Code review fix

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Code review fix

Co-authored-by: Matteo Almanza <matteojug@gmail.com>

* Code review suggestion

Co-authored-by: deanstef <stefano@algorand.com>
Co-authored-by: Matteo Almanza <matteojug@gmail.com>

Co-authored-by: deanstef <stefano@algorand.com>
Co-authored-by: Matteo Almanza <matteojug@gmail.com>
Co-authored-by: Adriano Di Luzio <aldur@users.noreply.github.com>
@cusma cusma mentioned this pull request Jan 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants