Add hooks to register event types for decoding #227

ascjones · 2021-02-08T17:27:11Z

Fixes #201.

Provides hooks to register missing runtime type sizes either statically via the Runtime trait impl:

impl Runtime for MyCustomRuntime {
    type Signature = MultiSignature;
    type Extra = DefaultExtra<Self>;

    fn register_type_sizes(event_type_registry: &mut EventTypeRegistry<Self>) {
        event_type_registry.with_system();
        event_type_registry.with_balances();
        register_default_type_sizes(event_type_registry);
        // add more custom type registrations here:
        event_type_registry.register_type_size::<u32>("MyCustomType");
    }
}

Or dynamically via the ClientBuilder:

ClientBuilder::<NodeTemplateRuntime>::new()
    .register_type_size::<u32>("MyCustomRuntimeType")
    .build()

In addition, the build() method on the ClientBuilder will now check for missing type sizes by default, and return an Err if there are any missing. This can be disabled by skip_type_sizes_check:

ClientBuilder::<NodeTemplateRuntime>::new()
    .skip_type_sizes_check()
    .build()

Note

I consider this an intermediate solution, since all my efforts are currently focused towards the integrating scale-info with substrate which will provide richer type information for the runtimes. This would eventually remove the requirement to manually provide type information in the client.

todo

consider calling check_missing_type_sizes by default in ClientBuilder::build, which could be disabled by e.g. skip_type_size_check
Add examples/docs
Ensure no duplicate type size registrations

ascjones · 2021-02-10T16:05:48Z

src/runtimes.rs

+        event_type_registry.with_session();
+        event_type_registry.with_contracts();
+        event_type_registry.with_sudo();
+        register_default_type_sizes(event_type_registry);


Note that this implementation must be amended manually for new and removed pallets. It would be possible to rework the macros to do this but since this is a short term solution I think this is good enough.

# Conflicts: # .rustfmt.toml # Cargo.toml

src/events.rs

Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>

niklasad1 · 2021-02-17T17:18:42Z

src/events.rs

@@ -72,116 +76,118 @@ impl std::fmt::Debug for RawEvent {
    }
 }

-trait TypeSegmenter: Send {
+pub trait TypeSegmenter: DynClone + Send + Sync {


I don't really understand why the Sync bound is required, can you explain?

https://github.com/paritytech/substrate-subxt/pull/227/files#diff-b598fbef7e7017bd50ba2e1416836582326cec905b14d50bd5c6ac7904311aecL160

niklasad1 · 2021-02-17T17:21:48Z

src/events.rs

-                        data: event_data,
-                    };
+    /// Register a type.
+    pub fn register_type_size<U>(&mut self, name: &str)


document that it panics if the type is already registered

niklasad1 · 2021-02-17T17:33:05Z

src/runtimes.rs

@@ -162,6 +179,9 @@ pub trait Runtime: System + Sized + Send + Sync + 'static {
    type Signature: Verify + Encode + Send + Sync + 'static;
    /// Transaction extras.
    type Extra: SignedExtra<Self> + Send + Sync + 'static;
+
+    /// Register type sizes for this runtime
+    fn register_type_sizes(event_type_registry: &mut EventTypeRegistry<Self>);


ok now I see why Sync is required.

niklasad1

LGTM

jasl · 2021-02-23T13:35:23Z

src/lib.rs

+    ///
+    /// *WARNING* can lead to runtime errors if receiving events with unknown types.
+    pub fn skip_type_sizes_check(mut self) -> Self {
+        self.skip_type_sizes_check = false;


is this should be self.skip_type_sizes_check = true; ?

Indeed looks like it should be...

ascjones added 4 commits February 8, 2021 17:21

Global registration of type segmenters for event decoding

fd3fa99

Perform type sizes check when building client

ea5a9de

Introduce EventTypeRegistry for global runtime type sizes

8ac2e59

Fmt

1f2022d

ascjones commented Feb 10, 2021

View reviewed changes

ascjones added 7 commits February 10, 2021 16:30

Register runtime type sizes on creation of EventTypeRegistry

7095747

Register more default dispatch types

79edd3d

Add missing type sizes

6485427

fmt

c38312c

Fix up register_type_size builder method

a9e7c7d

Update doc comments

32bedb5

Make register_default_type_sizes public

7e1c137

ascjones marked this pull request as ready for review February 10, 2021 17:27

ascjones mentioned this pull request Feb 10, 2021

EventSubscription decodes all events in block #201

Closed

ascjones requested a review from dvdplm February 10, 2021 17:35

ascjones changed the title ~~Global registration of type segmenters for event decoding~~ Add hooks to register event types for decoding Feb 10, 2021

ascjones added 2 commits February 11, 2021 11:34

Don't allow duplicate registered types

9b31d98

Remove call to supertraits type registration, done manually in Runtime

c77d9e6

ascjones mentioned this pull request Feb 11, 2021

Multiple possible events within function #224

Closed

ascjones added 3 commits February 11, 2021 12:00

Fix tests and warnings

4e1f618

Fix duplicate type registration

d501164

Fmt

e31cfc8

niklasad1 self-requested a review February 16, 2021 13:07

Merge branch 'master' into aj-global-type-sizes

c156361

# Conflicts: # .rustfmt.toml # Cargo.toml

niklasad1 reviewed Feb 17, 2021

View reviewed changes

src/events.rs Outdated Show resolved Hide resolved

review: use is_empty()

cc0ae52

Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>

niklasad1 reviewed Feb 17, 2021

View reviewed changes

niklasad1 approved these changes Feb 17, 2021

View reviewed changes

Add panic docs

f1eda2a

ascjones merged commit de859e7 into master Feb 18, 2021

ascjones deleted the aj-global-type-sizes branch February 18, 2021 10:28

jasl reviewed Feb 23, 2021

View reviewed changes

ascjones mentioned this pull request Feb 23, 2021

Fix type sizes check #235

Merged

ascjones mentioned this pull request Mar 22, 2021

Release v0.15 #248

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add hooks to register event types for decoding #227

Add hooks to register event types for decoding #227

ascjones commented Feb 8, 2021 •

edited

Loading

ascjones Feb 10, 2021

niklasad1 Feb 17, 2021

niklasad1 Feb 17, 2021

niklasad1 Feb 17, 2021

niklasad1 Feb 17, 2021

niklasad1 left a comment

jasl Feb 23, 2021

ascjones Feb 23, 2021

ascjones Feb 23, 2021

Add hooks to register event types for decoding #227

Add hooks to register event types for decoding #227

Conversation

ascjones commented Feb 8, 2021 • edited Loading

Note

todo

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

niklasad1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ascjones commented Feb 8, 2021 •

edited

Loading