Skip to content

Commit

Permalink
Tech Debt PR Including Release Version Bump (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
tzaffi authored Jan 3, 2023
1 parent a8f78f8 commit 5c1eeda
Show file tree
Hide file tree
Showing 12 changed files with 343 additions and 1,573 deletions.
30 changes: 30 additions & 0 deletions CHANGELOG.md
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()`
* 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
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
Loading

0 comments on commit 5c1eeda

Please sign in to comment.