Implement MVP for new off-chain testing engine

.gitlab-ci.yml

@@ -122,6 +122,26 @@ test:
   script:
     - cargo test --verbose --all-features --no-fail-fast --workspace
 
+# Just needed as long as we have the `ink-experimental-engine` feature.
+# This stage is the same as the above `test`, with the exception that
+# we do not invoke `--all-features` here -- this would imply the feature
+# `ink-experimental-engine`. So in order to still run the tests without the
+# experimental engine feature we have this test.
+test-default-features:
+    stage:                           workspace
+    <<:                              *docker-env
+    needs:
+        - job:                         check-std
+          artifacts:                   false
+    variables:
+        # Since we run the tests with `--all-features` this implies the feature
+        # `ink-fuzz-tests` as well -- i.e. the fuzz tests are run.
+        # There's no way to disable a single feature while enabling all features
+        # at the same time, hence we use this workaround.
+        QUICKCHECK_TESTS:            0
+    script:
+        - cargo test --verbose --no-fail-fast --workspace
+
 docs:
   stage:                           workspace
   <<:                              *docker-env
@@ -226,6 +246,15 @@ examples-test:
         cargo test --verbose --manifest-path ${example}/Cargo.toml;
       done
 
+examples-test-experimental-engine:
+    stage:                           examples
+    <<:                              *docker-env
+    needs:
+        - job:                         clippy-std
+          artifacts:                   false
+    script:
+        cargo test --features ink-experimental-engine --verbose --manifest-path erc20/Cargo.toml;
+
 examples-fmt:
   stage:                           examples
   <<:                              *docker-env

crates/engine/Cargo.toml

@@ -0,0 +1,45 @@
+[package]
+name = "ink_engine"
+version = "3.0.0-rc3"
+authors = ["Parity Technologies <admin@parity.io>", "Michael Müller <michi@parity.io>"]
+edition = "2018"
+
+license = "Apache-2.0"
+readme = "README.md"
+repository = "/~https://github.com/paritytech/ink"
+documentation = "https://docs.rs/ink_env/"
+homepage = "https://www.parity.io/"
+description = "[ink!] Experimental off-chain environment for testing."
+keywords = ["wasm", "parity", "webassembly", "blockchain", "edsl"]
+categories = ["no-std", "embedded"]
+include = ["Cargo.toml", "src/**/*.rs", "README.md", "LICENSE"]
+
+[dependencies]
+ink_env_types = { version = "3.0.0-rc3", path = "../env_types/", default-features = false }
+ink_primitives = { version = "3.0.0-rc3", path = "../primitives/", default-features = false }
+
+scale = { package = "parity-scale-codec", version = "2.0", default-features = false, features = ["derive", "full"] }
+derive_more = { version = "0.99", default-features = false, features = ["from", "display"] }
+num-traits = { version = "0.2", default-features = false, features = ["i128"] }
+paste = "1.0"
+
+sha2 = { version = "0.9" }
+sha3 = { version = "0.9" }
+blake2 = { version = "0.9" }
+
+rand = { version = "0.8", default-features = false, features = ["alloc"], optional = true }
+scale-info = { version = "0.6", default-features = false, features = ["derive"], optional = true }
+
+[features]
+default = ["std"]
+std = [
+    "ink_env_types/std",
+    "ink_primitives/std",
+    "scale/std",
+    "scale-info",
+    "scale-info/std",
+    "rand",
+    "rand/std",
+    "rand/std_rng",
+    "num-traits/std",
+]

crates/engine/LICENSE

@@ -0,0 +1 @@
+../../LICENSE

crates/engine/README.md

@@ -0,0 +1 @@
+../../README.md

crates/engine/src/accounts.rs

@@ -0,0 +1,45 @@
+// Copyright 2018-2021 Parity Technologies (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use crate::test_api::Error;
+
+use super::{
+    exec_context::OffChainError,
+    types::OffAccountId,
+};
+
+use derive_more::From;
+
+/// Errors encountered upon interacting with the accounts database.
+#[derive(Debug, From, PartialEq, Eq)]
+pub enum AccountError {
+    // TODO Decoding(scale::Error),
+    DecodingFailed,
+    #[from(ignore)]
+    UnexpectedUserAccount,
+    #[from(ignore)]
+    NoAccountForId(OffAccountId),
+}
+
+impl From<AccountError> for Error {
+    fn from(account_error: AccountError) -> Self {
+        Error::OffChain(OffChainError::Account(account_error))
+    }
+}
+
+impl From<scale::Error> for AccountError {
+    fn from(_err: scale::Error) -> Self {
+        AccountError::DecodingFailed
+    }
+}

crates/engine/src/exec_context.rs

@@ -0,0 +1,62 @@
+// Copyright 2018-2021 Parity Technologies (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use super::{
+    accounts::AccountError,
+    types::OffAccountId,
+    Environment,
+};
+
+use derive_more::From;
+
+#[derive(Debug, From, PartialEq, Eq)]
+pub enum OffChainError {
+    Account(AccountError),
+    #[from(ignore)]
+    UninitializedBlocks,
+    #[from(ignore)]
+    UninitializedExecutionContext,
+    #[from(ignore)]
+    UnregisteredChainExtension,
+}
+
+type Result<T> = core::result::Result<T, OffChainError>;
+
+/// The context of a contract execution.
+pub struct ExecContext {
+    /// The caller of the contract execution.
+    ///
+    /// Might be user or another contract.
+    pub caller: OffAccountId,
+    /// The callee of the contract execution.
+    pub callee: OffAccountId,
+}
+
+impl ExecContext {
+    /// Returns the callee.
+    pub fn callee<T>(&self) -> Result<T::AccountId>
+    where
+        T: Environment,
+    {
+        // TODO type hell
+        let callee: Vec<u8> = self.callee.clone();
+        let res: std::result::Result<T::AccountId, scale::Error> =
+            scale::Decode::decode(&mut &callee[..]);
+        let res: std::result::Result<T::AccountId, AccountError> =
+            res.map_err(AccountError::from);
+        let res: std::result::Result<T::AccountId, OffChainError> =
+            res.map_err(Into::into);
+        res
+    }
+}