Implement `ext_dispatch_call` #124

ascjones · 2019-06-18T17:18:09Z

Resolves #42.

Adds dispatch_call function
Introduces a new EnvType Call which must implement Encode
~~Introduces pre-baked Call types for srml modules~~. edit: this part has been moved to Initial Call implementation paritytech/ink-types-node-runtime#3

Here is an example of dispatching a Balances::transfer from a contract:

pub(external) fn balance_transfer(&mut self, dest: u32, value: Balance) {
    let transfer_call = calls::Balances::<DefaultSrmlTypes>::transfer(dest, value);
    env.dispatch_call(transfer_call);
}

The pre-baked Call types are "copies" of the srml module Call enums e.g. Balances. Importing the actual types from substrate is possible but it results in a very large wasm blob size. To ensure compatibility with the equivalent substrate types, tests are required for each Call which encode the local type and decode as the substrate type.

Note: This PR only includes a single predefined Call type for Balances. I think we should consider which additional calls/modules we should add in a follow up PR.

The final piece is the definition of the top level Call enum to compose the modules to match the substrate runtime. This can be user defined for custom runtimes by defining the Call type in EnvTypes e.g.

#[derive(Encode, Decode)]
#[cfg_attr(feature = "test-env", derive(Debug, Clone, PartialEq, Eq))]
pub enum Call {
    #[codec(index = "5")]
    Balances(super::calls::Balances<DefaultSrmlTypes>),
}

Because of how parity-scale-codec encodes enums, chain authors can define only the srml module calls they want to support, so long as the index matches up with the the relevant Call variant in the target chain's substrate runtime declaration.

# Conflicts: # core/src/env/srml/srml_only/impls.rs # core/src/env/srml/types.rs # core/src/env/test_env.rs # core/src/env/traits.rs

lang/src/gen/build.rs

# Conflicts: # examples/core/incrementer/Cargo.toml # examples/core/noop/Cargo.toml # examples/core/subpeep/Cargo.toml # examples/model/incrementer/Cargo.toml

cli/template/Cargo.toml

core/src/env/api.rs

core/src/env/srml/types.rs

Robbepop · 2019-07-29T16:27:59Z

core/src/env/srml/types.rs

-    impl Decode for Call {
-        fn decode<I: Input>(_value: &mut I) -> Option<Self> {
+    impl parity_codec::Decode for Call {
+        fn decode<I: parity_codec::Input>(_value: &mut I) -> Option<Self> {


Then better put it behind test-env feature instead of std feature and also provide a rational (comment) why it is there.

core/src/env/traits.rs

Robbepop · 2019-07-29T16:43:21Z

examples/lang/calls/Cargo.toml

+name = "calls"
+crate-type = ["cdylib"]
+
+[features]


Still needs adjustment

Robbepop · 2019-07-29T16:44:01Z

examples/lang/calls/rust-toolchain

@@ -0,0 +1 @@
+nightly-2019-05-21


Please delete rust-toolchain file.

model/src/exec_env.rs

core/src/env/srml/types.rs

Robbepop

LGTM 🌠

* [core] Add AccountId to EnvTypes * [core] Add calls mod, plus WIP tests * [core] Balance transfer call roundtrip works * [core] Add ext_dispatch_call * [core] Implement ext_dispatch_call * [examples] Add example lang contract for ext_dispatch_call * [examples] WIP: implement example lang contract for ext_dispatch_call * [examples] complete basic implementation of dispatching Balances Call * srml-contracts -> srml-contract * [core] remove unsafe from dispatch_call api fn * [core] Add docs to dispatch_call * [core] Add missing trait bound to account index * [core] Some todos * [core] Rename dispatch_call to dispatch_raw_call on Env trait * [lang] Add AccountIndex type alias * [model] add strongly type dispatch call to EnvHandler * [*] specify latest parity-codec version, same as substrate * [core] fix call roundtrip tests * [lang] fix tests * [core] fix wasm build * [core] fix std build * [core] move call type serialization tests * [core] test Call serialization roundtrip * [core] use node_runtime for Call serialization roundtrip * [core] remove unused dependencies * [core] remove unused substrate dependencies * [core] change default Balance to u128, matching substrate * [core] introduce Address type for balance calls * [core] fix Balances transfer serialization test * [core] add Address serialization tests * [ci] install wasm-gc for building substrate dev deps * [ci] move wasm-gc installation after wasm target added * [examples] get the calls example compiling * [CI] add temporary check for debugging ci build * [CI] restore wasm-gc to install section and remove temp version check * [CI] temporarily depend on substrate branch to test build fix * [CI] remove temp substrate branch, build issue fixed * [core] use std feature instead of test-env for EnvTypes * [core] remove Call types, moved to ink-types-node-runtime * [core] remove AccountIndex from EnvTypes * [core] remove AccountIndex from lang codegen * [core] fix unused for std * [CI] remove wasm-gc from travis build * [CI] remove AccountIndex type alias from codegen * parity-codec version 4.1.1 -> 4.1 * [core] ext_dispatch_call docs * [core] describe in comment what will happen if decoding fails * [model] implement suggestion of Into<Call> * rustfmt * rustfmt again * rustfmt again again * [examples] deleted calls example - moved to ink_types_node_runtime * [core] use into in api::dispatch_call * [core] make Call empty enum and use test-env feature for EnvTypes * [core] remove unused Call enum * [core] add comments explaining rationale for test-env * [core] missing period * [core] add comments * [core] add space in comment * [core] add comment to Call decode impl * [core] make dispatched_calls a DoubleEndedIterator * [core] add missing doc comment * [core] add comment explaining Decode requirement * [core] doc comment and DoubleEndedIterator

ascjones added the E-in-progress A task that is already being worked on. label Jun 18, 2019

ascjones mentioned this pull request Jun 20, 2019

Better api for ContractEnv<EnvTypes> #125

Closed

ascjones added 7 commits June 25, 2019 16:22

[core] Add AccountId to EnvTypes

cd77d1f

[core] Add calls mod, plus WIP tests

3b755b1

[core] Balance transfer call roundtrip works

5047ae6

[core] Add ext_dispatch_call

a1a154f

[core] Implement ext_dispatch_call

0653897

[examples] Add example lang contract for ext_dispatch_call

675e4a7

[examples] WIP: implement example lang contract for ext_dispatch_call

5dfe4b4

ascjones force-pushed the aj-dispatch-call branch from 9f13807 to 5dfe4b4 Compare June 25, 2019 15:24

ascjones mentioned this pull request Jun 28, 2019

[cli] deploy command #131

Merged

6 tasks

ascjones added 9 commits July 11, 2019 14:50

Merge branch 'master' into aj-dispatch-call

6dba3b7

# Conflicts: # core/src/env/srml/srml_only/impls.rs # core/src/env/srml/types.rs # core/src/env/test_env.rs # core/src/env/traits.rs

[examples] complete basic implementation of dispatching Balances Call

a44e1fc

srml-contracts -> srml-contract

1f16526

[core] remove unsafe from dispatch_call api fn

105ea46

[core] Add docs to dispatch_call

02fe1d1

[core] Add missing trait bound to account index

385cc05

[core] Some todos

f47fd92

[core] Rename dispatch_call to dispatch_raw_call on Env trait

48f17c8

[lang] Add AccountIndex type alias

e9e220b

Robbepop reviewed Jul 12, 2019

View reviewed changes

lang/src/gen/build.rs Outdated Show resolved Hide resolved

ascjones added B-enhancement New feature or request and removed E-in-progress A task that is already being worked on. labels Jul 12, 2019

ascjones marked this pull request as ready for review July 12, 2019 16:59

ascjones added 6 commits July 12, 2019 19:34

[model] add strongly type dispatch call to EnvHandler

0c8a7f6

[*] specify latest parity-codec version, same as substrate

671a4c3

[core] fix call roundtrip tests

3d9f828

[lang] fix tests

f2243d0

Merge branch 'master' into aj-dispatch-call

b0ec13a

# Conflicts: # examples/core/incrementer/Cargo.toml # examples/core/noop/Cargo.toml # examples/core/subpeep/Cargo.toml # examples/model/incrementer/Cargo.toml

[core] fix wasm build

d2ed6b9

parity-codec version 4.1.1 -> 4.1

cabcfd0

ascjones mentioned this pull request Jul 29, 2019

Initial Call implementation paritytech/ink-types-node-runtime#3

Merged

ascjones added 7 commits July 29, 2019 15:51

[core] ext_dispatch_call docs

c0c0cde

[core] describe in comment what will happen if decoding fails

415c42e

[model] implement suggestion of Into<Call>

a77a901

Merge branch 'master' into aj-dispatch-call

49c4e19

rustfmt

82b0938

rustfmt again

dd36c64

rustfmt again again

76f052d

Robbepop requested changes Jul 29, 2019

View reviewed changes

ascjones added 7 commits July 29, 2019 17:55

[examples] deleted calls example - moved to ink_types_node_runtime

bcb11b1

[core] use into in api::dispatch_call

50c1f59

[core] make Call empty enum and use test-env feature for EnvTypes

821b257

[core] remove unused Call enum

e0fed13

[core] add comments explaining rationale for test-env

e9ab0e7

[core] missing period

4272988

[core] add comments

b5eb6ce

Robbepop reviewed Jul 29, 2019

View reviewed changes

core/src/env/srml/types.rs Show resolved Hide resolved

core/src/env/srml/types.rs Outdated Show resolved Hide resolved

ascjones added 7 commits July 30, 2019 07:51

[core] add space in comment

e452d31

[core] add comment to Call decode impl

c82ddf4

Merge branch 'master' into aj-dispatch-call

e21e3bd

[core] make dispatched_calls a DoubleEndedIterator

f42f7a6

[core] add missing doc comment

219c851

[core] add comment explaining Decode requirement

89d0e88

[core] doc comment and DoubleEndedIterator

5d742f9

Robbepop approved these changes Jul 30, 2019

View reviewed changes

Robbepop merged commit 49f221b into master Jul 30, 2019

ascjones mentioned this pull request Jul 30, 2019

Document ext_dispatch_call and custom Call type substrate-developer-hub/substrate-developer-hub.github.io#198

Closed

ascjones deleted the aj-dispatch-call branch November 25, 2019 11:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement `ext_dispatch_call` #124

Implement `ext_dispatch_call` #124

ascjones commented Jun 18, 2019 •

edited by Robbepop

Robbepop Jul 29, 2019

Robbepop Jul 29, 2019

Robbepop Jul 29, 2019

Robbepop left a comment

		@@ -0,0 +1 @@
		nightly-2019-05-21

Implement ext_dispatch_call #124

Implement ext_dispatch_call #124

Conversation

ascjones commented Jun 18, 2019 • edited by Robbepop

Robbepop Jul 29, 2019

Choose a reason for hiding this comment

Robbepop Jul 29, 2019

Choose a reason for hiding this comment

Robbepop Jul 29, 2019

Choose a reason for hiding this comment

Robbepop left a comment

Choose a reason for hiding this comment

Implement `ext_dispatch_call` #124

Implement `ext_dispatch_call` #124

ascjones commented Jun 18, 2019 •

edited by Robbepop