Merge branch 'master' into addcall

Author: Demi-Marie

.travis.yml

@@ -7,7 +7,7 @@ rust:
   # - stable
   # - beta
   - nightly
-  - nightly-2019-07-19
+  - nightly-2019-08-13
 
 matrix:
   allow_failures:
@@ -35,6 +35,7 @@ install:
   # Print rustc and cargo versions
   - rustc -vV
   - cargo -vV
+  - bash --version
   # Install cargo-kcov Cargo plugin
   - cargo install --force cargo-kcov
   - cargo kcov -vV
@@ -61,91 +62,21 @@ before_script:
 
 script:
 - |
-  cargo check --verbose --all --all-features
-  check_all_features=$?
+  ./scripts/check-workspace.sh
+  check_workspace=$?
 
-  cargo check --verbose --all --no-default-features
-  check_no_default=$?
-
-  cargo fmt --verbose --all -- --check
-  fmt=$?
-
-  cargo clippy --verbose --all --all-features -- -D warnings
-  clippy_all_features=$?
-
-  cargo clippy --verbose --all --no-default-features -- -D warnings
-  clippy_no_default=$?
-
-  cargo test --verbose --all --all-features
-  test=$?
-
-  cargo kcov --verbose --coveralls --all --no-clean-rebuild
-  kcov=$?
-  bash <(curl -s https://codecov.io/bash)
-
-  cargo build --verbose --all --no-default-features --release --target=wasm32-unknown-unknown
-  build_wasm=$?
-
-  echo "CI Summary"
-  echo "=========="
-  echo ""
-  if [ $check_all_features -eq 0 ]
-  then
-    echo "compile (all-features):        ok"
-  else
-    echo "compile (all-features):        ERROR"
-  fi
-
-  if [ $check_no_default -eq 0 ]
+  if [ $check_workspace -eq 0 ]
   then
-    echo "compile (no-default-features): ok"
-  else
-    echo "compile (no-default-features): ERROR"
+    # Execute and upload kcov results
+    cargo kcov --verbose --coveralls --all --no-clean-rebuild
+    kcov=$?
+    bash <(curl -s https://codecov.io/bash)
   fi
 
-  if [ $fmt -eq 0 ]
-  then
-    echo "formatting:                    ok"
-  else
-    echo "formatting:                    ERROR"
-  fi
-
-  if [ $clippy_all_features -eq 0 ]
-  then
-    echo "clippy (all-features):         ok"
-  else
-    echo "clippy (all-features):         ERROR"
-  fi
-
-  if [ $clippy_no_default -eq 0 ]
-  then
-    echo "clippy (no-default-features):  ok"
-  else
-    echo "clippy (no-default-features):  ERROR"
-  fi
-
-  if [ $test -eq 0 ]
-  then
-    echo "test (all-features):           ok"
-  else
-    echo "test (all-features):           ERROR"
-  fi
-
-  if [ $build_wasm -eq 0 ]
-  then
-    echo "build Wasm:                    ok"
-  else
-    echo "build Wasm:                    ERROR"
-  fi
-
-  if [ $kcov -eq 0 ]
-  then
-    echo "coverage analysis:             ok"
-  else
-    echo "coverage analysis:             ERROR"
-  fi
+  ./scripts/check-examples.sh
+  check_examples=$?
 
-  if [ $check_all_features -eq 0 ] && [ $check_no_default -eq 0 ] && [ $fmt -eq 0 ] && [ $clippy_all_features -eq 0 ] && [ $clippy_no_default -eq 0 ] && [ $test -eq 0 ] && [ $build_wasm -eq 0 ]
+  if [ $check_examples -eq 0 ] && [ $check_workspace -eq 0 ]
   then
     echo "All checks have passed!"
     exit 0

Cargo.toml

@@ -6,9 +6,11 @@ members = [
     "model",
     "lang",
     "cli",
+    "abi",
 ]
 exclude = [
     "examples/",
+    "cli/template/",
 ]
 
 [profile.release]

README.md

@@ -1,8 +1,8 @@
 # ink! - Parity's ink to write smart contracts
 
-| Linux              | Codecov              | Coveralls              | LoC              | Docs (Core)       | Docs (Model)      |
-|:------------------:|:--------------------:|:----------------------:|:----------------:|:-----------------:|:-----------------:|
-| [![linux][A1]][A2] | [![codecov][C1]][C2] | [![coveralls][D1]][D2] | [![loc][E1]][E2] | [![docs][F1]][F2] | [![docs][G1]][G2] |
+| Linux              | Codecov              | Coveralls              | LoC              |
+|:------------------:|:--------------------:|:----------------------:|:----------------:|
+| [![linux][A1]][A2] | [![codecov][C1]][C2] | [![coveralls][D1]][D2] | [![loc][E1]][E2] |
 
 [A1]: https://travis-ci.org/paritytech/ink.svg?branch=master
 [A2]: https://travis-ci.org/paritytech/ink
@@ -16,26 +16,44 @@
 [E1]: https://tokei.rs/b1/github/paritytech/ink?category=code
 [E2]: https://github.com/Aaronepower/tokei#badges
 
-[F1]: https://img.shields.io/badge/docs-nightly-black.svg
-[F2]: https://paritytech.github.io/ink/ink_core/index.html
+[F1]: https://img.shields.io/badge/docs-core-blue.svg
+[F2]: https://paritytech.github.io/ink/ink_core
 
-[G1]: https://img.shields.io/badge/docs-nightly-purple.svg
-[G2]: https://paritytech.github.io/ink/ink_model/index.html
+[G1]: https://img.shields.io/badge/docs-model-blue.svg
+[G2]: https://paritytech.github.io/ink/ink_model
+
+[H1]: https://img.shields.io/badge/docs-abi-blue.svg
+[H2]: https://paritytech.github.io/ink/ink_abi
 
 **IMPORTANT NOTE:** WORK IN PROGRESS! Do not expect this to be working.
 
-ink is an [eDSL](https://wiki.haskell.org/Embedded_domain_specific_language) to write WebAssembly based smart contracts using the Rust programming language.
+ink! is an [eDSL](https://wiki.haskell.org/Embedded_domain_specific_language) to write WebAssembly based smart contracts using the Rust programming language targeting Substrate blockchains.
+
+## Developer Documentation
+
+| `ink_abi` | `ink_core` | `ink_model` |
+|-----------|------------|-------------|
+| [![][H1]][H2] | [![][F1]][F2] | [![][G1]][G2] |
+
+### Scripts
+
+Use the scripts provided under `scripts` directory in order to run checks on either the workspace or all examples. Please do this before pushing work in a PR.
+
+### Testing
+
+Off-chain testing is done by `cargo test`.
+If you want to test all workspace crates, do `cargo test --all`.
 
 ## Example
 
-Below is an example using the eDSL demonstrating a simple Flipper smart contract
+Below is an example using ink! demonstrating a simple Flipper smart contract
 that has a boolean state that can be flipped or returned.
 
 ```rust
 contract! {
     /// Specify concrete implementation of contract environment types
     #![env = ink_core::env::DefaultSrmlTypes]
- 
+
     /// Flips its state between `true` and `false`.
     struct Flipper {
         /// The current state of our flag.

abi/Cargo.toml

@@ -0,0 +1,34 @@
+[package]
+name = "ink_abi"
+version = "0.1.0"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2018"
+
+license = "GPL-3.0"
+readme = "README.md"
+
+description = "Rust based eDSL for writing smart contracts for Substrate"
+keywords = ["wasm", "parity", "webassembly", "blockchain", "edsl"]
+categories = ["no-std", "embedded"]
+
+include = ["/Cargo.toml", "src/**/*.rs", "/README.md", "/LICENSE"]
+
+[dependencies]
+serde = { version = "1.0", default-features = false, features = ["derive", "alloc"] }
+derive_more = { version = "0.14", features = ["no_std"] }
+ink_abi_derive = { version = "0.1.0", path = "derive", default-features = false, optional = true }
+type-metadata = { git = "https://github.com/type-metadata/type-metadata.git", default-features = false, features = ["derive"] }
+
+[features]
+default = [
+    "std",
+    "derive",
+]
+derive = [
+    "ink_abi_derive"
+]
+std = [
+    "ink_abi_derive/std",
+    "serde/std",
+    "type-metadata/std",
+]

abi/LICENSE

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

abi/README.md

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

abi/derive/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "ink_abi_derive"
+version = "0.1.0"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2018"
+
+license = "Apache-2.0"
+readme = "../README.md"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+quote = "0.6"
+syn = { version = "0.15", features = ["full"] }
+proc-macro2 = "0.4"
+
+[features]
+default = ["std"]
+std = []

abi/derive/src/error.rs

@@ -0,0 +1,31 @@
+// Copyright 2018-2019 Parity Technologies (UK) Ltd.
+// This file is part of ink!.
+//
+// ink! is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// ink! is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with ink!.  If not, see <http://www.gnu.org/licenses/>.
+
+macro_rules! bail {
+    ($($args:tt)*) => {
+        return Err(format_err!($($args)*).into())
+    }
+}
+
+macro_rules! format_err {
+    ($tokens:expr, $($msg:tt)*) => {
+        match &$tokens {
+            t => {
+                syn::parse::Error::new_spanned(t, format_args!($($msg)*))
+            }
+        }
+    }
+}

abi/derive/src/has_layout.rs

@@ -0,0 +1,105 @@
+// Copyright 2018-2019 Parity Technologies (UK) Ltd.
+// This file is part of ink!.
+//
+// ink! is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// ink! is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with ink!.  If not, see <http://www.gnu.org/licenses/>.
+
+use crate::impl_wrapper::wrap;
+use proc_macro2::TokenStream as TokenStream2;
+use quote::quote;
+use syn::{
+    self,
+    parse::Result,
+    parse_quote,
+    punctuated::Punctuated,
+    Data,
+    DataStruct,
+    DeriveInput,
+    Field,
+    Fields,
+    Token,
+};
+
+pub fn generate(input: TokenStream2) -> TokenStream2 {
+    match generate_impl(input.into()) {
+        Ok(output) => output.into(),
+        Err(err) => err.to_compile_error().into(),
+    }
+}
+
+pub fn generate_impl(input: TokenStream2) -> Result<TokenStream2> {
+    let mut ast: DeriveInput = syn::parse2(input)?;
+
+    ast.generics.type_params_mut().for_each(|p| {
+        p.bounds.push(parse_quote!(_ink_abi::HasLayout));
+    });
+
+    let ident = &ast.ident;
+    let (impl_generics, ty_generics, where_clause) = ast.generics.split_for_impl();
+
+    let layout = match &ast.data {
+        Data::Struct(ref s) => generate_struct_layout(s),
+        Data::Enum(ref _e) => bail!(&ast, "enums are not supported"),
+        Data::Union(ref _u) => bail!(&ast, "unions are not supported"),
+    };
+
+    let has_layout_impl = quote! {
+        impl #impl_generics _ink_abi::HasLayout for #ident #ty_generics #where_clause {
+            fn layout(&self) -> _ink_abi::StorageLayout {
+                #layout.into()
+            }
+        }
+    };
+
+    Ok(wrap(ident, "HAS_LAYOUT", has_layout_impl).into())
+}
+
+fn generate_fields_layout<'a>(
+    fields: &'a Punctuated<Field, Token![,]>,
+) -> impl Iterator<Item = TokenStream2> + 'a {
+    fields.iter().enumerate().map(|(n, field)| {
+        let ident = &field.ident;
+        if let Some(ident) = ident {
+            quote! {
+                _ink_abi::LayoutField::new(stringify!(#ident), self.#ident.layout())
+            }
+        } else {
+            quote! {
+                _ink_abi::LayoutField::new(stringify!(#n), self.#n.layout())
+            }
+        }
+    })
+}
+
+fn generate_struct_fields_layout(fields: &Punctuated<Field, Token![,]>) -> TokenStream2 {
+    let fields_layout = generate_fields_layout(fields);
+    quote! {
+        use type_metadata::Metadata as _;
+        _ink_abi::LayoutStruct::new(Self::meta_type(), __core::vec![
+            #( #fields_layout, )*
+        ])
+    }
+}
+
+fn generate_struct_layout(data_struct: &DataStruct) -> TokenStream2 {
+    match data_struct.fields {
+        Fields::Named(ref fs) => generate_struct_fields_layout(&fs.named),
+        Fields::Unnamed(ref fs) => generate_struct_fields_layout(&fs.unnamed),
+        Fields::Unit => {
+            quote! {
+                use type_metadata::Metadata as _;
+                _ink_abi::LayoutStruct::new(Self::meta_type(), __core::vec![])
+            }
+        }
+    }
+}