Merge branch 'master' into aj/shared-events

Author: ascjones

.github/workflows/examples.yml

@@ -28,7 +28,7 @@ jobs:
         toolchain:
           - stable
         job:
-          - build
+          - contract build
           - test
     runs-on: ${{ matrix.platform }}
     env:
@@ -102,19 +102,19 @@ jobs:
            $delegator_subcontracts = "accumulator","adder","subber"
            foreach ($contract in $delegator_subcontracts) {
                echo "Processing delegator contract: $contract";
-               cargo contract ${{ matrix.job }} --verbose --manifest-path examples/delegator/${contract}/Cargo.toml;
+               cargo ${{ matrix.job }} --verbose --manifest-path examples/delegator/${contract}/Cargo.toml;
            }
            $upgradeable_contracts = "forward-calls","set-code-hash"
            foreach ($contract in $upgradeable_contracts) {
                echo "Processing upgradeable contract: $contract";
-               cargo contract ${{ matrix.job }} --verbose --manifest-path examples/upgradeable-contracts/${contract}/Cargo.toml;
+               cargo ${{ matrix.job }} --verbose --manifest-path examples/upgradeable-contracts/${contract}/Cargo.toml;
            }
-           cargo contract ${{ matrix.job }} --verbose --manifest-path examples/upgradeable-contracts/set-code-hash/updated-incrementer/Cargo.toml;
+           cargo ${{ matrix.job }} --verbose --manifest-path examples/upgradeable-contracts/set-code-hash/updated-incrementer/Cargo.toml;
            foreach ($example in Get-ChildItem  -Directory "examples\*") {
                if ($example -Match 'upgradeable-contracts') { continue }
                if ($example -Match 'lang-err-integration-tests') { continue }
                echo "Processing example: $example";
-               cargo contract ${{ matrix.job }} --verbose --manifest-path=$example/Cargo.toml;
+               cargo ${{ matrix.job }} --verbose --manifest-path=$example/Cargo.toml;
                cargo clean --manifest-path=$example/Cargo.toml;
            }
 
@@ -123,16 +123,16 @@ jobs:
         run: |
            for contract in ${DELEGATOR_SUBCONTRACTS}; do
                echo "Processing delegator contract: $contract";
-               cargo contract ${{ matrix.job }} --verbose --manifest-path examples/delegator/${contract}/Cargo.toml;
+               cargo ${{ matrix.job }} --verbose --manifest-path examples/delegator/${contract}/Cargo.toml;
            done
            for contract in ${UPGRADEABLE_CONTRACTS}; do
                 echo "Processing upgradeable contract: $contract";
-                cargo contract ${{ matrix.job }} --verbose --manifest-path=examples/upgradeable-contracts/$contract/Cargo.toml;
+                cargo ${{ matrix.job }} --verbose --manifest-path=examples/upgradeable-contracts/$contract/Cargo.toml;
            done
-           cargo contract ${{ matrix.job }} --verbose --manifest-path=examples/upgradeable-contracts/set-code-hash/updated-incrementer/Cargo.toml;
+           cargo ${{ matrix.job }} --verbose --manifest-path=examples/upgradeable-contracts/set-code-hash/updated-incrementer/Cargo.toml;
            for example in examples/*/; do
                if [ "$example" = "examples/upgradeable-contracts/" ]; then continue; fi;
                if [ "$example" = "examples/lang-err-integration-tests/" ]; then continue; fi;
                echo "Processing example: $example";
-               cargo contract ${{ matrix.job }} --verbose --manifest-path=$example/Cargo.toml;
+               cargo ${{ matrix.job }} --verbose --manifest-path=$example/Cargo.toml;
            done

.images/inkternals.png

@@ -4,10 +4,98 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## Version 4.0.0
+
+The latest stable release of ink! is here 🥳
+
+This version brings a lot of usability improvements, making the language better suited
+for the needs of production parachains.
+
+A couple of highlights include:
+- Changes to how contract storage works, which significantly reduced the sizes of
+  contract binaries
+- A new end-to-end testing framework, letting you easily write integration tests
+- Changes to the metadata format, which (in part) makes error handling more expressive
+
+There's a lot more to dig through, so take some time to poke around the `CHANGELOG`
+(including the `4.0.0-alpha` and `4.0.0-beta` releases).
+
+You may notice there have been a few breaking changes. No need to be scared though, we
+wrote up a [migration guide](https://use.ink/faq/migrating-from-ink-3-to-4) covering all
+of the breaking changes and how to update your ink! 3.x contract accordingly.
+
+Thanks to everyone that helped make this release possible ❤️
+
+### Compatibility
+
+In order to build contracts which use ink! `v4.0.0` you need to use
+`cargo-contract`
+[`v2.0.0`](https://github.com/paritytech/cargo-contract/releases/tag/v2.0.0).
+You can install it as follows:
+
+`cargo install cargo-contract --forced --locked`
+
+You will also need to use a version of [`pallet-contracts`](https://github.com/paritytech/substrate/tree/master/frame/contracts)
+later than [polkadot-v0.9.37](https://github.com/paritytech/substrate/tree/polkadot-v0.9.37)
+in your node.
+
+The [`v0.24.0`](https://github.com/paritytech/substrate-contracts-node/releases/tag/v0.24.0)
+release of the [`substrate-contracts-node`](https://github.com/paritytech/substrate-contracts-node) is
+compatible with the ink! `4.0.0` release.
+
+For full compatibility requirements see the [migration guide](https://use.ink/faq/migrating-from-ink-3-to-4/#compatibility).
+
+### Added
+- 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) (thanks [@kanishkatn](https://github.com/kanishkatn)!)
+- 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)
+- Add `ink_env::pay_with_call!` helper macro for off-chain emulation of sending payments with contract message calls ‒ [#1379](https://github.com/paritytech/ink/pull/1379)
+- Allow using `Result<Self, Error>` as a return type in constructors ‒ [#1446](https://github.com/paritytech/ink/pull/1446)
+- Add `Mapping::take()` function allowing to get a value removing it from storage ‒ [#1461](https://github.com/paritytech/ink/pull/1461)
+- Add E2E testing framework MVP ‒ [#1395](https://github.com/paritytech/ink/pull/1395)
+- Add E2E tests for `Mapping` functions - [#1492](https://github.com/paritytech/ink/pull/1492)
+- E2E: expose call dry-run method ‒ [#1624](https://github.com/paritytech/ink/pull/1624)
+- Make cross-contract callee non-optional ‒ [#1636](https://github.com/paritytech/ink/pull/1636)
+- Support custom environment in E2E tests - [#1645](https://github.com/paritytech/ink/pull/1645) (thanks [@pmikolajczyk41](https://github.com/pmikolajczyk41)!)
+
 ### Changed
+- 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)
+- Introduce `ink` entrance crate ‒ [#1223](https://github.com/paritytech/ink/pull/1223)
+- Use `XXH32` instead of `sha256` for calculating storage keys ‒ [#1393](https://github.com/paritytech/ink/pull/1393)
+- Storage Refactoring ‒ [#1331](https://github.com/paritytech/ink/pull/1331)
+- Add support for language level errors (`LangError`) ‒ [#1450](https://github.com/paritytech/ink/pull/1450)
+- Return `LangError`s from constructors ‒ [#1504](https://github.com/paritytech/ink/pull/1504)
+- Update `scale-info` requirement to `2.3` ‒ [#1467](https://github.com/paritytech/ink/pull/1467)
+- Merge `Mapping::insert(key, val)` and `Mapping::insert_return_size(key, val)` into one method - [#1463](https://github.com/paritytech/ink/pull/1463)
+- FFI: no more `__unstable__` wasm import module ‒ [#1522](https://github.com/paritytech/ink/pull/1522)
+- Clean up CallBuilder `return()` type ‒ [#1525](https://github.com/paritytech/ink/pull/1525)
+- Fix trait message return type metadata ‒ [#1531](https://github.com/paritytech/ink/pull/1531)
+- Bump Dylint dependencies ‒ [#1551](https://github.com/paritytech/ink/pull/1551)
+- Stabilize `take_storage` ‒ [#1568](https://github.com/paritytech/ink/pull/1568)
+- Chain Extension: Evaluation of method return type at compile time ‒ [#1569](https://github.com/paritytech/ink/pull/1569)
+- Make more functions be const ‒ [#1574](https://github.com/paritytech/ink/pull/1574) (thanks [@yjhmelody](https://github.com/yjhmelody)!)
+- Unify fallible and non fallible `instantiate` methods ‒ [#1591](https://github.com/paritytech/ink/pull/1591)
+- Make `CallBuilder` and `CreateBuilder` error handling optional ‒ [#1602](https://github.com/paritytech/ink/pull/1602)
+- Rename `CallBuilder::fire()` method to `invoke()` ‒ [#1604](https://github.com/paritytech/ink/pull/1604)
+- chore: add minimum rust version to the ink crate ‒ [#1609](https://github.com/paritytech/ink/pull/1609) (thanks [@Kurtsley](https://github.com/Kurtsley)!)
+- Rename `_checked` codegen call methods with `try_` ‒ [#1621](https://github.com/paritytech/ink/pull/1621)
+- Bump Substrate and `subxt` dependencies ‒ [#1549](https://github.com/paritytech/ink/pull/1549)
 - E2E: spawn a separate contracts node instance per test ‒ [#1642](https://github.com/paritytech/ink/pull/1642)
 
+### Fixed
+- Trim single whitespace prefix in the metadata `docs` field ‒ [#1385](https://github.com/paritytech/ink/pull/1385)
+- Allow pay_with_call to take multiple arguments ‒ [#1401](https://github.com/paritytech/ink/pull/1401)
+- Add Determinism enum from pallet-contracts ‒ [#1547](https://github.com/paritytech/ink/pull/1547)
+- Added missed `WhereClosure` for the generics into `storage_item` ‒ [#1536](https://github.com/paritytech/ink/pull/1536) (thanks [@xgreenx](https://github.com/xgreenx)!)
+
+### Removed
+- Implement `ecdsa_to_eth_address()` and remove `eth_compatibility` crate ‒ [#1233](https://github.com/paritytech/ink/pull/1233)
+- Remove `wee-alloc` ‒ [#1403](https://github.com/paritytech/ink/pull/1403)
+- Remove `ink_env::random` function ‒ [#1442](https://github.com/paritytech/ink/pull/1442)
+- Remove `Default` implementation for AccountId ‒ [#1255](https://github.com/paritytech/ink/pull/1255)
+
 ## Version 4.0.0-rc
 
 The first release candidate is here! This is the first release which could become the final
@@ -37,7 +125,7 @@ breaking or otherwise.
 - Remove `Default` implementation for AccountId ‒ [#1255](https://github.com/paritytech/ink/pull/1255)
 
 ## Version 4.0.0-beta.1
-The coolest feature included in this release is the first first published version of
+The coolest feature included in this release is the first published version of
 ink!'s native ["end-to-end" (E2E) testing framework](https://github.com/paritytech/ink/issues/1234).
 
 This enables testing of a contract by deploying and calling it on a Substrate node with
@@ -200,6 +288,7 @@ through a feature flag. `wee-alloc` is no longer maintained and we removed suppo
 ### Changed
 - Introduce `ink` entrance crate ‒ [#1223](https://github.com/paritytech/ink/pull/1223)
 - Use `XXH32` instead of `sha256` for calculating storage keys ‒ [#1393](https://github.com/paritytech/ink/pull/1393)
+- Storage Refactoring ‒ [#1331](https://github.com/paritytech/ink/pull/1331)
 
 ### Fixed
 - Trim single whitespace prefix in the metadata `docs` field ‒ [#1385](https://github.com/paritytech/ink/pull/1385)

.images/pallet-contracts.png

@@ -135,8 +135,22 @@ It's totally fine to extract changes made in one pull request to multiple pull r
 
 If you've already opened a pull request, avoid force-pushing any new changes.
 
+If your pull request is a work-in-progress, create it as a Draft pull request.
+
 For a nice list of hints visit this [link][GitHub Perfect Pull Reqest].
 
+### Reviews
+
+We have GitHub set up in a way that core developers will automatically
+be assigned to review your pull request. If you feel there is somebody
+missing you're always free to add more people for a review.
+
+For small changes one approval is typically enough to merge code, for
+significant or critical changes there should be at least two ✅.
+
+If you made major changes to your pull request since the last approval,
+ping them for another approval please.
+
 ## I don't want to contribute, I just have some questions
 
 For technical questions about the ink! and all other Polkadot projects, please post your questions to our [Stack Exchange community][Stack-Exchange-Link]. You can also stay tuned by joining our [Element channel][Riot-Smart-Contracts-ink] to be among first ones who gets our announcements.

CHANGELOG.md

@@ -71,16 +71,19 @@ More relevant links:
 
 ## Play with It
 
+The best way to start is to check out the [Getting Started](https://use.ink/getting-started/setup)
+page in our documentation.
+
 If you want to have a local setup you can use our [`substrate-contracts-node`](https://github.com/paritytech/substrate-contracts-node) for a quickstart.
 It's a simple Substrate blockchain which includes the Substrate module for smart contract functionality ‒ the `contracts` pallet (see [How it Works](#how-it-works) for more).
 
-We also have a live testnet on [Rococo](https://github.com/paritytech/cumulus/#rococo-). Rococo is a Substrate based
+We also have a live testnet named "Contracts" on Rococo. Rococo is a Substrate based
 parachain which supports ink! smart contracts. For further instructions on using this
 testnet, follow the instructions in
 [our documentation](https://use.ink/testnet).
 
-For both types of chains the [Contracts UI](https://contracts-ui.substrate.io/)
-can be used to instantiate your contract to a chain and interact with it.
+The [Contracts UI](https://contracts-ui.substrate.io/) can be used to instantiate your
+contract to a chain and interact with it.
 
 ## Usage
 
@@ -111,7 +114,7 @@ In order to build the contract just execute this command in the `flipper` folder
 cargo contract build
 ```
 
-As a result you'll get a `target/flipper.wasm` file, a `metadata.json` file and a `<contract-name>.contract` file in the `target` folder of your contract.
+As a result you'll get a `target/flipper.wasm` file, a `flipper.json` file and a `<contract-name>.contract` file in the `target` folder of your contract.
 The `.contract` file combines the Wasm and metadata into one file and needs to be used when instantiating the contract.
 
 
@@ -210,7 +213,7 @@ This module is called the `contracts` pallet,
 * The `contracts` pallet requires smart contracts to be uploaded to the blockchain as a Wasm blob.
 * ink! is a smart contract language which targets the API exposed by `contracts`.
 Hence ink! contracts are compiled to Wasm.
-* When executing `cargo contract build` an additional file `metadata.json` is created.
+* When executing `cargo contract build` an additional file `<contract-name>.json` is created.
 It contains information about e.g. what methods the contract provides for others to call.
 
 ## ink! Macros & Attributes Overview

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 [package]
 name = "ink_allocator"
-version = "4.0.0-rc"
+version = "4.0.0"
 authors = ["Parity Technologies <[email protected]>", "Robin Freyler <[email protected]>"]
 edition = "2021"
 

README.md

@@ -1,6 +1,6 @@
 [package]
 name = "ink_e2e"
-version = "4.0.0-rc"
+version = "4.0.0"
 authors = ["Parity Technologies <[email protected]>"]
 edition = "2021"
 
@@ -15,10 +15,10 @@ categories = ["no-std", "embedded"]
 include = ["/Cargo.toml", "src/**/*.rs", "/README.md", "/LICENSE"]
 
 [dependencies]
-ink_e2e_macro = { version = "4.0.0-rc", path = "./macro" }
-ink = { version = "4.0.0-rc", path = "../ink" }
-ink_env = { version = "4.0.0-rc", path = "../env" }
-ink_primitives = { version = "4.0.0-rc", path = "../primitives" }
+ink_e2e_macro = { version = "4.0.0", path = "./macro" }
+ink = { version = "4.0.0", path = "../ink" }
+ink_env = { version = "4.0.0", path = "../env" }
+ink_primitives = { version = "4.0.0", path = "../primitives" }
 
 contract-metadata = { version = "2.0.0-rc.1" }
 funty = "2.0.0"
@@ -30,14 +30,14 @@ tokio = { version = "1.18.2", features = ["rt-multi-thread"] }
 log = { version = "0.4" }
 env_logger = { version = "0.10" }
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive", "full"] }
-subxt = "0.26.0"
+subxt = "0.27.0"
 
 # Substrate
-pallet-contracts-primitives = "12.0.0"
-sp-core = "11.0.0"
-sp-keyring = "12.0.0"
-sp-runtime = "12.0.0"
-sp-weights = "8.0.0"
+pallet-contracts-primitives = "18.0.0"
+sp-core = "16.0.0"
+sp-keyring = "18.0.0"
+sp-runtime = "18.0.0"
+sp-weights = "14.0.0"
 
 [dev-dependencies]
 # Required for the doctest of `MessageBuilder::call`

crates/allocator/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ink_e2e_macro"
-version = "4.0.0-rc"
+version = "4.0.0"
 authors = ["Parity Technologies <[email protected]>"]
 edition = "2021"
 
@@ -19,7 +19,7 @@ name = "ink_e2e_macro"
 proc-macro = true
 
 [dependencies]
-ink_ir = { version = "4.0.0-beta.1", path = "../../ink/ir" }
+ink_ir = { version = "4.0.0", path = "../../ink/ir" }
 contract-build = { git = "https://github.com/paritytech/cargo-contract", branch = "aj/shared-events-metadata", package = "contract-build" }
 derive_more = "0.99.17"
 env_logger = "0.10.0"

crates/e2e/Cargo.toml

@@ -72,6 +72,12 @@ impl InkE2ETest {
             syn::ReturnType::Type(rarrow, ret_type) => quote! { #rarrow #ret_type },
         };
 
+        let environment = self
+            .test
+            .config
+            .environment()
+            .unwrap_or_else(|| syn::parse_quote! { ::ink::env::DefaultEnvironment });
+
         let mut additional_contracts: Vec<String> =
             self.test.config.additional_contracts();
         let default_main_contract_manifest_path = String::from("Cargo.toml");
@@ -158,7 +164,7 @@ impl InkE2ETest {
 
                     let mut client = ::ink_e2e::Client::<
                         ::ink_e2e::PolkadotConfig,
-                        ink::env::DefaultEnvironment
+                        #environment
                     >::new(
                         node_proc.client(),
                         [ #( #contracts ),* ]