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.

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

Jump to bottom

Tech Debt PR Including Release Version Bump #42

Merged
merged 12 commits into from
Jan 3, 2023
Merged

Tech Debt PR Including Release Version Bump #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4b78ce2
with cost no longer coming back, and the coming need to support simul…
Dec 22, 2022
d28308b
remove error prone method Invariant.inputs_and_invariants
Dec 22, 2022
f6f301a
need to tranform via `Invariant.as_invariants()`
Dec 22, 2022
026926f
more control over validation and whether a method selector is provide…
Dec 24, 2022
6ed2789
deprecate the majority of the original remaning dryrun.py
Dec 24, 2022
26d47e3
Small type fix (#43)
tzaffi Dec 26, 2022
b92911c
changelog
Dec 27, 2022
44af893
remove deprecated functions and dependent imports
Jan 3, 2023
5ac666e
add comment about `validation` param in the dosctring for `encode_args`
Jan 3, 2023
bf245dd
remove deprecated methods as well
Jan 3, 2023
0412b0d
and migration pathway to CHANGELOG
Jan 3, 2023
56c9b1f
get ready for v0.7.0
Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 30 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,36 @@
<!-- markdownlint-disable MD024 -->
# Changelog

## `v0.7.0` (_aka_ 🦒)

### Breaking changes

In [#42](https://github.com/algorand/graviton/pull/42):

* Inside `graviton/blackbox.py`: Removing the parameters `abi_argument_types` and `abi_return_type` from dry run execution methods, in favor of the unified `abi_method_signature` parameter. Also adding `omit_method_selector` and `validation` parameters to allow running non-ARC-4 compliant teal code that use ABI types.
* Deleting orphaned code mostly brought over from original py-algorand-sdk code:
* Entire file: `graviton/deprecated_dryrun.py`
* Entire file: `graviton/deprecated_dryrun_mixin.py`
* Entire file: `tests/integration/dryrun_mixin_docs_test.py`
* The following functions and methods in `graviton/dryrun.py`:
* `_fail()`
* `assert_pass()`
* `assert_reject()`
* `assert_status()`
* `assert_global_state_contains()`
* `assert_local_state_contains()`
* `DryRunHelper._guess()`
* `DryRunHelper.format_stack()`
* `DryRunHelper.find_delta_value()`
* `DryRunHelper.save_dryrun_request()`
* Recommended actions in case you are currently using the above:
* Consider opening an issue alerting us of the impact
* The original code is mostly available [in py-algorand v1.20.2](https://github.com/algorand/py-algorand-sdk/blob/v1.20.2/algosdk/testing/dryrun.py)
* Deleting method `Invariant.inputs_and_invariants()`
michaeldiamant marked this conversation as resolved.
Show resolved Hide resolved
* Recommended migration path: It is recommended that inputs and invariants be accessed directly from the
dictionary that contains them (e.g. [this example](https://github.com/algorand/graviton/blob/7aed927405d8c7fc27ee34cfd05caa001b89ea36/tests/integration/blackbox_test.py#L463)) or that
`Invariant.full_validation()` be employed instead (e.g. [this example](https://github.com/algorand/graviton/blob/d84fc612a0ad9ec23a6ec14a167fa9f2c898bd2e/tests/integration/identical_test.py#L123)).

## `v0.6.0` (_aka_ 🐸)

### Added
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ flake8:
flake8 graviton tests

mypy:
mypy --show-error-codes .
mypy .

lint: black flake8 mypy

Expand Down