Release v4.0.0-alpha.1 (#1363)

* Add release notes for `v4.0.0-alpha.1`

* Mention breaking changes in changelog

* Bump version to `4.0.0-alpha.1`

* Fix header levels after merge

* Fix some formatting

* Add some notes about the breaking changes

* Add links to PRs

* Add note about linting move

* Bump `ink_linting` crate to `4.0.0-alpha.1`

* Remove `nightly` usage from delegator build script

* Use dashes instead of minus signs

Co-authored-by: Michael Müller <mich@elmueller.net>

* Beef up description of linter PR

Co-authored-by: Michael Müller <mich@elmueller.net>

* Move compatibility section to top of release notes

* Explicitly use `stable` channel

Our Docker images still default to `nightly`

* Build contracts with `stable` toolchain

* Install `rust-src` component before building examples

* Run the rest of the CI stages again

Co-authored-by: Michael Müller <mich@elmueller.net>

Author: HCastano

.gitlab-ci.yml

@@ -354,19 +354,20 @@ examples-contract-build:
   <<:                              *docker-env
   <<:                              *test-refs
   script:
+    - rustup component add rust-src --toolchain stable
     - cargo install --git https://github.com/paritytech/cargo-contract.git --branch hc-versioned-metadata --force
     - cargo contract -V
     - for example in examples/*/; do
         if [ "$example" = "examples/upgradeable-contracts/" ]; then continue; fi;
         pushd $example &&
-        cargo contract build &&
+        cargo +stable contract build &&
         popd;
       done
     - pushd ./examples/delegator/ && ./build-all.sh && popd
     - for contract in ${UPGRADEABLE_CONTRACTS}; do
-        cargo contract build --manifest-path ./examples/upgradeable-contracts/${contract}/Cargo.toml;
+        cargo +stable contract build --manifest-path ./examples/upgradeable-contracts/${contract}/Cargo.toml;
       done
-    - cargo contract build --manifest-path ./examples/upgradeable-contracts/delegate-calls/upgradeable-flipper/Cargo.toml
+    - cargo +stable contract build --manifest-path ./examples/upgradeable-contracts/delegate-calls/upgradeable-flipper/Cargo.toml
 
 examples-docs:
   stage:                           examples

CHANGELOG.md

@@ -6,22 +6,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-There are a number of backwards incompatible changes which are on the `master` branch
-waiting to be released. These are:
-
-- 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)
-- The `rand-extension` example has been adapted to an updated version of the `ChainExtension` API ‒ [#1356](https://github.com/paritytech/ink/pull/1356)
+## Version 4.0.0-alpha.1
 
 ### Compatibility
-
 We recommend using a version of the [`pallet-contracts`](https://github.com/paritytech/substrate/tree/master/frame/contracts)
 later than [6b85535](https://github.com/paritytech/substrate/tree/6b8553511112afd5ae7e8e6877dc2f467850f155)
 (Aug 12, 2022) in your node.
 
 The compatibility issues will be with `ChainExtension`'s and the functions mentioned above.
 
+### Breaking Changes
+This release contains a few breaking changes. These are indicated with the :x: emoji.
+Most of these were intitially introduced in `v3.1.0` and `v3.2.0` releases but
+compatibility was restored in `v3.3.0`.
+
+- As part of [#1224](https://github.com/paritytech/ink/pull/1224) the return type of `ink_env::set_contract_storage()` was changed to
+return an `Option<u32>` instead of `()`.
+- As part of [#1233](https://github.com/paritytech/ink/pull/1233) the `eth_compatibility` crate was removed. The
+  `ecdsa_to_eth_address()` function from it can now be found in the `ink_env` crate.
+- As part of [#1267](https://github.com/paritytech/ink/pull/1267) an argument to `ink_lang::codegen::execute_constructor()` (which is
+  used internally by the ink! macros) was removed.
+- As part of [#1313](https://github.com/paritytech/ink/pull/1313) the ink! ABI was changed so that the version was specified using a
+  dedicated `version` key instead of an implicit key which wrapped the entire ABI.
+
+### Added
+- :x: Add `Mapping::contains(key)` and `Mapping::insert_return_size(key, val)` ‒ [#1224](https://github.com/paritytech/ink/pull/1224)
+- Add [`payment-channel`](https://github.com/paritytech/ink/tree/master/examples/payment-channel) example ‒ [#1248](https://github.com/paritytech/ink/pull/1248)
+- :x: Add `version` field to ink! metadata ‒ [#1313](https://github.com/paritytech/ink/pull/1313)
+- The `rand-extension` example has been adapted to an updated version of the `ChainExtension` API ‒ [#1356](https://github.com/paritytech/ink/pull/1356)
+
+### Changed
+- :x: Contract size optimization in case contract doesn't accept payment ‒ [#1267](https://github.com/paritytech/ink/pull/1267) (thanks [@xgreenx](https://github.com/xgreenx)).
+- Move ink! linter into `ink` repository ‒ [#1361](https://github.com/paritytech/ink/pull/1267)
+
+### Removed
+- :x: Implement ecdsa_to_eth_address() and remove eth_compatibility crate ‒ [#1233](https://github.com/paritytech/ink/pull/1233)
+
 ## Version 3.3.1
 
 At the moment teams which use both Substrate and ink! in the same codebase are

crates/allocator/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_allocator"
-version = "4.0.0"
+version = "4.0.0-alpha.1"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 

crates/engine/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_engine"
-version = "4.0.0"
+version = "4.0.0-alpha.1"
 authors = ["Parity Technologies <admin@parity.io>", "Michael Müller <michi@parity.io>"]
 edition = "2021"
 

crates/env/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_env"
-version = "4.0.0"
+version = "4.0.0-alpha.1"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 
@@ -15,10 +15,10 @@ categories = ["no-std", "embedded"]
 include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"]
 
 [dependencies]
-ink_metadata = { version = "4.0.0", path = "../metadata/", default-features = false, features = ["derive"], optional = true }
-ink_allocator = { version = "4.0.0", path = "../allocator/", default-features = false }
-ink_primitives = { version = "4.0.0", path = "../primitives/", default-features = false }
-ink_prelude = { version = "4.0.0", path = "../prelude/", default-features = false }
+ink_metadata = { version = "4.0.0-alpha.1", path = "../metadata/", default-features = false, features = ["derive"], optional = true }
+ink_allocator = { version = "4.0.0-alpha.1", path = "../allocator/", default-features = false }
+ink_primitives = { version = "4.0.0-alpha.1", path = "../primitives/", default-features = false }
+ink_prelude = { version = "4.0.0-alpha.1", path = "../prelude/", default-features = false }
 
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive", "full"] }
 derive_more = { version = "0.99", default-features = false, features = ["from", "display"] }
@@ -32,7 +32,7 @@ static_assertions = "1.1"
 rlibc = "1"
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
-ink_engine = { version = "4.0.0", path = "../engine/", optional = true }
+ink_engine = { version = "4.0.0-alpha.1", path = "../engine/", optional = true }
 
 # Hashes for the off-chain environment.
 sha2 = { version = "0.10", optional = true }

crates/lang/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_lang"
-version = "4.0.0"
+version = "4.0.0-alpha.1"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 
@@ -15,19 +15,19 @@ categories = ["no-std", "embedded"]
 include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"]
 
 [dependencies]
-ink_env = { version = "4.0.0", path = "../env", default-features = false }
-ink_storage = { version = "4.0.0", path = "../storage", default-features = false }
-ink_primitives = { version = "4.0.0", path = "../primitives", default-features = false }
-ink_metadata = { version = "4.0.0", path = "../metadata", default-features = false, optional = true }
-ink_prelude = { version = "4.0.0", path = "../prelude", default-features = false }
-ink_lang_macro = { version = "4.0.0", path = "macro", default-features = false }
+ink_env = { version = "4.0.0-alpha.1", path = "../env", default-features = false }
+ink_storage = { version = "4.0.0-alpha.1", path = "../storage", default-features = false }
+ink_primitives = { version = "4.0.0-alpha.1", path = "../primitives", default-features = false }
+ink_metadata = { version = "4.0.0-alpha.1", path = "../metadata", default-features = false, optional = true }
+ink_prelude = { version = "4.0.0-alpha.1", path = "../prelude", default-features = false }
+ink_lang_macro = { version = "4.0.0-alpha.1", path = "macro", default-features = false }
 
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive", "full"] }
 derive_more = { version = "0.99", default-features = false, features = ["from"] }
 
 [dev-dependencies]
-ink_lang_ir = { version = "4.0.0", path = "ir" }
-ink_metadata = { version = "4.0.0", default-features = false, path = "../metadata" }
+ink_lang_ir = { version = "4.0.0-alpha.1", path = "ir" }
+ink_metadata = { version = "4.0.0-alpha.1", default-features = false, path = "../metadata" }
 
 trybuild = { version = "1.0.60", features = ["diff"] }
 # Required for the doctest of `env_access::EnvAccess::instantiate_contract`

crates/lang/codegen/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_lang_codegen"
-version = "4.0.0"
+version = "4.0.0-alpha.1"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 
@@ -18,7 +18,7 @@ include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"]
 name = "ink_lang_codegen"
 
 [dependencies]
-ir = { version = "4.0.0", package = "ink_lang_ir", path = "../ir", default-features = false }
+ir = { version = "4.0.0-alpha.1", package = "ink_lang_ir", path = "../ir", default-features = false }
 quote = "1"
 syn = { version = "1.0", features = ["parsing", "full", "extra-traits"] }
 proc-macro2 = "1.0"

crates/lang/ir/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_lang_ir"
-version = "4.0.0"
+version = "4.0.0-alpha.1"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 

crates/lang/macro/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_lang_macro"
-version = "4.0.0"
+version = "4.0.0-alpha.1"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 
@@ -15,19 +15,19 @@ categories = ["no-std", "embedded"]
 include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"]
 
 [dependencies]
-ink_lang_ir = { version = "4.0.0", path = "../ir", default-features = false }
-ink_lang_codegen = { version = "4.0.0", path = "../codegen", default-features = false }
-ink_primitives = { version = "4.0.0", path = "../../primitives/", default-features = false }
+ink_lang_ir = { version = "4.0.0-alpha.1", path = "../ir", default-features = false }
+ink_lang_codegen = { version = "4.0.0-alpha.1", path = "../codegen", default-features = false }
+ink_primitives = { version = "4.0.0-alpha.1", path = "../../primitives/", default-features = false }
 
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive"] }
 syn = "1"
 proc-macro2 = "1"
 
 [dev-dependencies]
-ink_metadata = { version = "4.0.0", path = "../../metadata/" }
-ink_env = { version = "4.0.0", path = "../../env/" }
-ink_storage = { version = "4.0.0", path = "../../storage/" }
-ink_lang = { version = "4.0.0", path = ".." }
+ink_metadata = { version = "4.0.0-alpha.1", path = "../../metadata/" }
+ink_env = { version = "4.0.0-alpha.1", path = "../../env/" }
+ink_storage = { version = "4.0.0-alpha.1", path = "../../storage/" }
+ink_lang = { version = "4.0.0-alpha.1", path = ".." }
 scale-info = { version = "2", default-features = false, features = ["derive"] }
 
 [lib]

crates/metadata/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_metadata"
-version = "4.0.0"
+version = "4.0.0-alpha.1"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 
@@ -15,8 +15,8 @@ categories = ["no-std", "embedded"]
 include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"]
 
 [dependencies]
-ink_prelude = { version = "4.0.0", path = "../prelude/", default-features = false }
-ink_primitives = { version = "4.0.0", path = "../primitives/", default-features = false }
+ink_prelude = { version = "4.0.0-alpha.1", path = "../prelude/", default-features = false }
+ink_primitives = { version = "4.0.0-alpha.1", path = "../primitives/", default-features = false }
 
 serde = { version = "1.0", default-features = false, features = ["derive", "alloc"] }
 impl-serde = "0.3.1"