Release ink! 3.1.0 (#1240)

* Updated release notes * Bump versions to `3.1.0` * Update release notes * Update release notes * Remove `eth_compatibility/Cargo.toml` * Update links to releases
use-ink · May 18, 2022 · 07be64c · 07be64c
1 parent 3f6befa
commit 07be64c
Show file tree

Hide file tree

Showing 36 changed files with 128 additions and 71 deletions.
diff --git a/RELEASES.md b/RELEASES.md
@@ -1,5 +1,62 @@
 # [Unreleased]
 
+# Version 3.1.0
+
+## Compatibility
+We recommend using a version of the [`pallet-contracts`](https://github.com/paritytech/substrate/tree/master/frame/contracts)
+later than [7d233c2446b5a60662400a0a4bcfb78bb3b79ff7](https://github.com/paritytech/substrate/tree/7d233c2446b5a60662400a0a4bcfb78bb3b79ff7)
+(May 13, 2022) in your node.
+
+This is the case in the latest release of the [`substrate-contracts-node`](https://github.com/paritytech/substrate-contracts-node)
+[v0.15.1](https://github.com/paritytech/substrate-contracts-node/releases/tag/v0.15.1) and
+the latest Polkadot release [v0.9.22](https://github.com/paritytech/polkadot/releases/tag/v0.9.22).
+
+## Breaking Changes
+There are two breaking changes in this release:
+
+* As part of [#1235](https://github.com/paritytech/ink/pull/1235) the message selectors of
+  your contract may change. A change of selectors would affect your client, frontend, Dapp, etc..
+* As part of [#1233](https://github.com/paritytech/ink/pull/1235) we removed the `eth_compatibility`
+  crate.<br><br>
+  Its recovery functionality has been moved to `ink_env` now: [`ink_env::ecdsa_to_eth_address`]().
+  The reason for this change is that we moved the gas-expensive crypto operations into `pallet-contracts`.<br><br>
+  The crates `to_default_account_id` function has been removed; the reason for this change is that ink!
+  doesn't have knowledge about the specific Substrate types on the underlying chain.
+  If you want to retain the function in your contract and are just using standard Substrate types
+  you should add the prior functionality to your contract ‒ it was a simple
+  `<Blake2x256 as CryptoHash>::hash(&ecdsa_pubkey[u8; 33])`.
+
+## New API functions
+We added two new `Mapping` API functions:
+[`Mapping::contains`](https://paritytech.github.io/ink/ink_storage/struct.Mapping.html#method.contains) and
+[`Mapping::insert_return_size`](https://paritytech.github.io/ink/ink_storage/struct.Mapping.html#method.insert_return_size) ‒ [#1224](https://github.com/paritytech/ink/pull/1224)
+These are more gas-efficient than whatever you were using previously.
+
+Additionaly there are a couple new `ink_env` functions now:
+* [`ink_env::set_code_hash`](https://paritytech.github.io/ink/ink_env/fn.set_code_hash.html)
+* [`ink_env::own_code_hash`](https://paritytech.github.io/ink/ink_env/fn.own_code_hash.html)
+* [`ink_env::code_hash`](https://paritytech.github.io/ink/ink_env/fn.code_hash.html)
+* [`ink_env::ecdsa_to_eth_address`](https://paritytech.github.io/ink/ink_env/fn.ecdsa_to_eth_address.html)
+
+## New Upgradeable Contract Example
+
+We've added a new example: [`upgradeable-contracts/set-code-hash`](https://github.com/paritytech/ink/tree/master/examples/upgradeable-contracts#set-code-hash).
+
+It illustrates how the newly added [`ink_env::set_code_hash`](https://paritytech.github.io/ink/ink_env/fn.set_code_hash.html)
+can be used to implement an upgradeable contract that replaces its own code.
+
+## Added
+- Implement `seal_code_hash` and `seal_own_code_hash` ‒ [#1205](https://github.com/paritytech/ink/pull/1205)
+- Add `set_code_hash` function and example ‒ [#1203](https://github.com/paritytech/ink/pull/1203)
+- Implement [`ink_env::ecdsa_to_eth_address`](https://paritytech.github.io/ink/ink_env/fn.ecdsa_to_eth_address.html) ‒ [#1233](https://github.com/paritytech/ink/pull/1233)
+- Add [`Mapping::contains(key)`]() and [`Mapping::insert_return_size(key, val)`]() ‒ [#1224](https://github.com/paritytech/ink/pull/1224)
+
+## Fixed
+- Fix ordering of message ids if the trait is implemented before the inherent section ‒ [#1235](https://github.com/paritytech/ink/pull/1235)
+
+## Removed
+- Removed `eth_compatibility` crate and moved its functionality partly into `ink_env` ‒ [#1233](https://github.com/paritytech/ink/pull/1233)
+
 # Version 3.0.1
 
 ## Changed

diff --git a/crates/allocator/Cargo.toml b/crates/allocator/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_allocator"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 

diff --git a/crates/engine/Cargo.toml b/crates/engine/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_engine"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>", "Michael Müller <michi@parity.io>"]
 edition = "2021"
 

diff --git a/crates/env/Cargo.toml b/crates/env/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_env"
-version = "3.0.1"
+version = "3.1.0"
 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 = "3.0.1", path = "../metadata/", default-features = false, features = ["derive"], optional = true }
-ink_allocator = { version = "3.0.1", path = "../allocator/", default-features = false }
-ink_primitives = { version = "3.0.1", path = "../primitives/", default-features = false }
-ink_prelude = { version = "3.0.1", path = "../prelude/", default-features = false }
+ink_metadata = { version = "3.1.0", path = "../metadata/", default-features = false, features = ["derive"], optional = true }
+ink_allocator = { version = "3.1.0", path = "../allocator/", default-features = false }
+ink_primitives = { version = "3.1.0", path = "../primitives/", default-features = false }
+ink_prelude = { version = "3.1.0", 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 = "3.0.1", path = "../engine/", optional = true }
+ink_engine = { version = "3.1.0", path = "../engine/", optional = true }
 
 # Hashes for the off-chain environment.
 sha2 = { version = "0.10", optional = true }

diff --git a/crates/lang/Cargo.toml b/crates/lang/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_lang"
-version = "3.0.1"
+version = "3.1.0"
 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 = "3.0.1", path = "../env", default-features = false }
-ink_storage = { version = "3.0.1", path = "../storage", default-features = false }
-ink_primitives = { version = "3.0.1", path = "../primitives", default-features = false }
-ink_metadata = { version = "3.0.1", path = "../metadata", default-features = false, optional = true }
-ink_prelude = { version = "3.0.1", path = "../prelude", default-features = false }
-ink_lang_macro = { version = "3.0.1", path = "macro", default-features = false }
+ink_env = { version = "3.1.0", path = "../env", default-features = false }
+ink_storage = { version = "3.1.0", path = "../storage", default-features = false }
+ink_primitives = { version = "3.1.0", path = "../primitives", default-features = false }
+ink_metadata = { version = "3.1.0", path = "../metadata", default-features = false, optional = true }
+ink_prelude = { version = "3.1.0", path = "../prelude", default-features = false }
+ink_lang_macro = { version = "3.1.0", 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 = "3.0.1", path = "ir" }
-ink_metadata = { version = "3.0.1", default-features = false, path = "../metadata" }
+ink_lang_ir = { version = "3.1.0", path = "ir" }
+ink_metadata = { version = "3.1.0", default-features = false, path = "../metadata" }
 
 trybuild = { version = "1.0.60", features = ["diff"] }
 # Required for the doctest of `env_access::EnvAccess::instantiate_contract`

diff --git a/crates/lang/codegen/Cargo.toml b/crates/lang/codegen/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_lang_codegen"
-version = "3.0.1"
+version = "3.1.0"
 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 = "3.0.1", package = "ink_lang_ir", path = "../ir", default-features = false }
+ir = { version = "3.1.0", package = "ink_lang_ir", path = "../ir", default-features = false }
 quote = "1"
 syn = { version = "1.0", features = ["parsing", "full", "extra-traits"] }
 proc-macro2 = "1.0"

diff --git a/crates/lang/ir/Cargo.toml b/crates/lang/ir/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_lang_ir"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 

diff --git a/crates/lang/macro/Cargo.toml b/crates/lang/macro/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_lang_macro"
-version = "3.0.1"
+version = "3.1.0"
 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 = "3.0.1", path = "../ir", default-features = false }
-ink_lang_codegen = { version = "3.0.1", path = "../codegen", default-features = false }
-ink_primitives = { version = "3.0.1", path = "../../primitives/", default-features = false }
+ink_lang_ir = { version = "3.1.0", path = "../ir", default-features = false }
+ink_lang_codegen = { version = "3.1.0", path = "../codegen", default-features = false }
+ink_primitives = { version = "3.1.0", 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 = "3.0.1", path = "../../metadata/" }
-ink_env = { version = "3.0.1", path = "../../env/" }
-ink_storage = { version = "3.0.1", path = "../../storage/" }
-ink_lang = { version = "3.0.1", path = ".." }
+ink_metadata = { version = "3.1.0", path = "../../metadata/" }
+ink_env = { version = "3.1.0", path = "../../env/" }
+ink_storage = { version = "3.1.0", path = "../../storage/" }
+ink_lang = { version = "3.1.0", path = ".." }
 scale-info = { version = "2", default-features = false, features = ["derive"] }
 
 [lib]

diff --git a/crates/metadata/Cargo.toml b/crates/metadata/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_metadata"
-version = "3.0.1"
+version = "3.1.0"
 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 = "3.0.1", path = "../prelude/", default-features = false }
-ink_primitives = { version = "3.0.1", path = "../primitives/", default-features = false }
+ink_prelude = { version = "3.1.0", path = "../prelude/", default-features = false }
+ink_primitives = { version = "3.1.0", path = "../primitives/", default-features = false }
 
 serde = { version = "1.0", default-features = false, features = ["derive", "alloc"] }
 impl-serde = "0.3.1"

diff --git a/crates/prelude/Cargo.toml b/crates/prelude/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_prelude"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 

diff --git a/crates/primitives/Cargo.toml b/crates/primitives/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_primitives"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 
@@ -15,7 +15,7 @@ categories = ["no-std", "embedded"]
 include = ["/Cargo.toml", "src/**/*.rs", "/README.md", "/LICENSE"]
 
 [dependencies]
-ink_prelude = { version = "3.0.1", path = "../prelude/", default-features = false }
+ink_prelude = { version = "3.1.0", path = "../prelude/", default-features = false }
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive", "full"] }
 scale-info = { version = "2", default-features = false, features = ["derive"], optional = true }
 cfg-if = "1"

diff --git a/crates/storage/Cargo.toml b/crates/storage/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_storage"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 
@@ -15,11 +15,11 @@ categories = ["no-std", "embedded"]
 include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"]
 
 [dependencies]
-ink_env = { version = "3.0.1", path = "../env/", default-features = false }
-ink_metadata = { version = "3.0.1", path = "../metadata/", default-features = false, features = ["derive"], optional = true }
-ink_primitives = { version = "3.0.1", path = "../primitives/", default-features = false }
-ink_storage_derive = { version = "3.0.1", path = "derive", default-features = false }
-ink_prelude = { version = "3.0.1", path = "../prelude/", default-features = false }
+ink_env = { version = "3.1.0", path = "../env/", default-features = false }
+ink_metadata = { version = "3.1.0", path = "../metadata/", default-features = false, features = ["derive"], optional = true }
+ink_primitives = { version = "3.1.0", path = "../primitives/", default-features = false }
+ink_storage_derive = { version = "3.1.0", path = "derive", default-features = false }
+ink_prelude = { version = "3.1.0", 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"] }
@@ -33,7 +33,7 @@ quickcheck_macros = "1.0"
 itertools = "0.10"
 paste = "1.0"
 
-ink_lang = { version = "3.0.1", path = "../lang/", default-features = false }
+ink_lang = { version = "3.1.0", path = "../lang/", default-features = false }
 
 [features]
 default = ["std"]

diff --git a/crates/storage/derive/Cargo.toml b/crates/storage/derive/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ink_storage_derive"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>", "Robin Freyler <robin@parity.io>"]
 edition = "2021"
 
@@ -25,8 +25,8 @@ synstructure = "0.12.4"
 
 [dev-dependencies]
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive", "full"] }
-ink_env = { version = "3.0.1", path = "../../env" }
-ink_primitives = { version = "3.0.1", path = "../../primitives" }
-ink_metadata = { version = "3.0.1", path = "../../metadata" }
-ink_prelude = { version = "3.0.1", path = "../../prelude/" }
-ink_storage = { version = "3.0.1", path = ".." }
+ink_env = { version = "3.1.0", path = "../../env" }
+ink_primitives = { version = "3.1.0", path = "../../primitives" }
+ink_metadata = { version = "3.1.0", path = "../../metadata" }
+ink_prelude = { version = "3.1.0", path = "../../prelude/" }
+ink_storage = { version = "3.1.0", path = ".." }
diff --git a/examples/contract-terminate/Cargo.toml b/examples/contract-terminate/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "contract_terminate"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 publish = false

diff --git a/examples/contract-transfer/Cargo.toml b/examples/contract-transfer/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "contract_transfer"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 publish = false

diff --git a/examples/delegator/Cargo.toml b/examples/delegator/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "delegator"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 publish = false
@@ -13,11 +13,11 @@ ink_storage = { path = "../../crates/storage", default-features = false }
 ink_lang = { path = "../../crates/lang", default-features = false }
 
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive"] }
+scale-info = { version = "2", default-features = false, features = ["derive"], optional = true }
 
 adder = { path = "adder", default-features = false, features = ["ink-as-dependency"] }
 subber = { path = "subber", default-features = false, features = ["ink-as-dependency"] }
 accumulator = { path = "accumulator", default-features = false, features = ["ink-as-dependency"] }
-scale-info = { version = "2", default-features = false, features = ["derive"], optional = true }
 
 [lib]
 name = "delegator"

diff --git a/examples/delegator/accumulator/Cargo.toml b/examples/delegator/accumulator/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "accumulator"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 

diff --git a/examples/delegator/adder/Cargo.toml b/examples/delegator/adder/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "adder"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 

diff --git a/examples/delegator/subber/Cargo.toml b/examples/delegator/subber/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "subber"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 

diff --git a/examples/dns/Cargo.toml b/examples/dns/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "dns"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 publish = false

diff --git a/examples/erc1155/Cargo.toml b/examples/erc1155/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "erc1155"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 publish = false

diff --git a/examples/erc20/Cargo.toml b/examples/erc20/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "erc20"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 publish = false

diff --git a/examples/erc721/Cargo.toml b/examples/erc721/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "erc721"
-version = "3.0.1"
+version = "3.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2021"
 publish = false