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

Add a list of changes breaking backwards compatibility to RELEASES.md #1292

Merged
merged 2 commits into from
Jul 14, 2022
Merged

Add a list of changes breaking backwards compatibility to RELEASES.md #1292

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1a49fd
Add a list of changes breaking backwards compatibility to be released…
agryaznov Jun 15, 2022
0cca6ab
Add 3.3.0 release notes and mention unreleased breaking changes
HCastano Jul 14, 2022
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
40 changes: 40 additions & 0 deletions RELEASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# [Unreleased]

There are a number of backwards incompatible changes which are on the `master` branch
waiting to be released. These include:
- Add Mapping::contains(key) and Mapping::insert_return_size(key, val) - [#1224](https://github.com/paritytech/ink/pull/1224)
- Optimise deny_payment. Use everywhere semantic of deny. [#1267](https://github.com/paritytech/ink/pull/1267)
- Implement ecdsa_to_eth_address() and remove eth_compatibility crate [#1233](https://github.com/paritytech/ink/pull/1233)

# Version 3.3.0

This release restores SemVer compatibility in the `v3.x` series of releases, as well as
compatibility with the [`v0.13.0`](https://github.com/paritytech/substrate-contracts-node/releases/tag/v0.13.0)
release of the `substrate-contracts-node`.

## Compatibility
This version will work fine with *substrate-contracts-node* versions from
[0.13.0](https://github.com/paritytech/substrate-contracts-node/releases/tag/v0.13.0) up
to [0.16.0](https://github.com/paritytech/substrate-contracts-node/releases/tag/v0.16.0).

## Changed
*Context: user-reported issues on our SE unveiled backward incompatibility introduced in 3.1.0 release.*
1. [CodeRejected when using ink! v3.1.0](https://substrate.stackexchange.com/questions/2721/cargo-contract-3-0-1)
1. [Incompatibility between ink! v3.0.1 and v3.2.0 ](https://substrate.stackexchange.com/questions/2870/cargo-contract-throws-error-about-supplied-arguments-in-inkconstructor-f)

The following has been done to restore backward compatibility:
- Reverted backward-incompatible piece of [#1224](https://github.com/paritytech/ink/pull/1224).
- The return signature of `ink_env::set_contract_storage()` was changed to return an
`Option<u32>`. This could have broken existing code, so this should've been done in
a `MAJOR` release.
- Under the hood the PR also changed `Mapping::insert()` to use a new SEAL API
(`[seal1] seal_set_storage`), which resulted in `CodeRejected` errors in nodes which
did not have this API (e.g `substrate-contracts-node@0.13.0`).
- Reverted "Optimise deny_payment. Use everywhere semantic of deny ([#1267](https://github.com/paritytech/ink/pull/1267))"
- This one is to restore compatibility between minor versions of ink! crates; see
@HCastano's SE [answer](https://substrate.stackexchange.com/a/3000/472) in this
regard.
- Reverted backward-incompatible piece of [#1233](https://github.com/paritytech/ink/pull/1233).
- The removal of the `eth_compatibility` crate should have been done in a `MAJOR`
release.

All these breaking changes are subjects to the upcoming MAJOR *ink!* release 4.0.0.

# Version 3.2.0

## Compatibility
Expand Down