Annotations for pallets and their storages #13

vnabiev · 2022-04-14T13:24:11Z

Added annotations Pallet and Storage and related entities: StorageKey, StorageHasher.
Added PalletInterfaceProccessor which generates proxies for pallets to the blockchain by their annotations.
Added corresponding and auxiliary classes.

kalaninja · 2022-04-18T16:35:13Z

pallet/src/main/java/com/strategyobject/substrateclient/pallet/GeneratedPalletResolver.java

+            val ctor = implClazz.getConstructor(Rpc.class);
+
+            return interfaceClass.cast(ctor.newInstance(rpc));
+        } catch (ClassCastException | ClassNotFoundException | NoSuchMethodException | InstantiationException | IllegalAccessException | InvocationTargetException e) {


ClassCastException is already a RuntimeException
also all the rest exceptions are subtypes of ReflectiveOperationException, so can be reduced to
catch (ReflectiveOperationException e) if you want

kalaninja · 2022-04-19T02:07:15Z

api/src/main/java/com/strategyobject/substrateclient/api/DefaultApi.java

+
+    @Override
+    public <T> T pallet(@NonNull Class<T> clazz) {
+        return palletResolver.resolve(clazz);


pallet can be memoized to not instantiate it each time

kalaninja · 2022-04-19T02:25:48Z

pallet/src/main/java/com/strategyobject/substrateclient/pallet/annotations/Pallet.java

+@Retention(RetentionPolicy.RUNTIME)
+public @interface Pallet {
+    @NonNull
+    String name();


isn't it better to call this field value instead of name so that an enduser can write @Pallet("System") instead of @Pallet(name = "System")

kalaninja · 2022-04-19T03:35:29Z

...pallet-codegen/src/main/java/com.strategyobject.substrateclient.pallet/StorageProcessor.java

+                .build();
+    }
+
+    private MethodSpec privateMethod(String palletName,


this name is a bit misleading. I expected it to generate some internal method that it triggered by the public method defined later. But it turned out to be a some sort of initializer

renamed to backFieldInitializer

kalaninja · 2022-04-19T03:40:51Z

...pallet-codegen/src/main/java/com.strategyobject.substrateclient.pallet/StorageProcessor.java

+                        .addAnnotation(suppressWarnings("unchecked", "rawtypes"))
+                        .returns(TypeName.get(returnType));
+
+        declareReaderAndWriterRegistries(methodSpecBuilder);


cannot it be moved upper to a class level? registries are threadsafe and needed by multiple implementations.

I think it's not necessary because there are just variables which refer to singletons.

Ishinka · 2022-04-26T13:04:49Z

pallet/src/main/java/com/strategyobject/substrateclient/pallet/annotations/Pallet.java

+
+/**
+ * Indicates the pallet which represents a proxy to the blockchain's pallet.
+ * For interfaces annotated with it processor will generate proper implementations.


The processor will generate proper implementations for the interfaces annotated with this method.

Ishinka · 2022-04-26T13:21:48Z

pallet/src/main/java/com/strategyobject/substrateclient/pallet/GeneratedPalletResolver.java

+    public <T> T resolve(Class<T> interfaceClass) {
+        if (interfaceClass.getDeclaredAnnotationsByType(Pallet.class).length == 0) {
+            throw new IllegalArgumentException(
+                    String.format("`%s` can't be constructed because isn't annotated with `@%s`.",


String.format("%s can't be constructed because it is not annotated with @%s.",

Ishinka · 2022-04-26T13:26:05Z

...n/src/test/java/com/strategyobject/substrateclient/pallet/PalletInterfaceProcessorTests.java

+
+        assertThat(compilation).failed();
+        assertThat(compilation)
+                .hadErrorContaining("Must be set `type` or `generic` of `@StorageKey`");


.hadErrorContaining("Please set either type or generic parameter of @StorageKey");

Ishinka · 2022-04-26T13:30:18Z

api/src/main/java/com/strategyobject/substrateclient/api/Api.java


+/**
+ * Provides the ability to query a node and interact with the Polkadot or Substrate chains.
+ * It allows interacting with blockchain in different ways: using RPC's queries directly or


It allows interacting with blockchain in two different ways: using RPC's queries directly or
OR
It allows interacting with blockchain in various ways: using RPC's queries directly or

Ishinka · 2022-04-26T13:31:06Z

api/src/main/java/com/strategyobject/substrateclient/api/Api.java

+/**
+ * Provides the ability to query a node and interact with the Polkadot or Substrate chains.
+ * It allows interacting with blockchain in different ways: using RPC's queries directly or
+ * accessing Pallets and its APIs such storages, transactions, etc.


accessing Pallets and its APIs, such as storages, transactions, etc.

Ishinka · 2022-04-26T13:34:31Z

api/src/main/java/com/strategyobject/substrateclient/api/Api.java

+    }
+
+    /**
+     * @return the instance that provides proper API for querying RPC's methods.


@return the instance that provides a proper API for querying the RPC's methods.

Ishinka · 2022-04-26T13:36:03Z

api/src/main/java/com/strategyobject/substrateclient/api/Api.java

    Rpc rpc();
+
+    /**
+     * Resolves the instance of pallet by its definition.


Resolves the instance of a pallet by its definition.
OR
Resolves a pallet instance by its definition.

Ishinka · 2022-04-26T13:39:00Z

...n/src/test/java/com/strategyobject/substrateclient/pallet/PalletInterfaceProcessorTests.java

+
+        assertThat(compilation).failed();
+        assertThat(compilation)
+                .hadErrorContaining("Must be set only one of both parameters of `@StorageKey`: `type` or `generic`.");


.hadErrorContaining("Please set only one parameter of @StorageKey: type or generic.");

Ishinka · 2022-04-26T13:41:28Z

...pallet-codegen/src/main/java/com.strategyobject.substrateclient.pallet/StorageProcessor.java

+                throw new ProcessingException(
+                        palletElement,
+                        "`@%s` of `%s.%s` isn't adjusted correctly. " +
+                                "Must be set `type` or `generic` of `@StorageKey`.",


"Please set either type or generic parameter of @StorageKey.",

Ishinka · 2022-04-26T13:42:07Z

...pallet-codegen/src/main/java/com.strategyobject.substrateclient.pallet/StorageProcessor.java

+                        palletElement,
+                        "`@%s` of `%s.%s` isn't adjusted correctly. " +
+                                "Ambiguous scale type of key. " +
+                                "Must be set only one of both parameters of `@StorageKey`: `type` or `generic`.",


"Please set only one parameter of @StorageKey: type or generic.",

Added annotations `Pallet` and `Storage` and related entities: `StorageKey`, `StorageHasher`. Added `PalletInterfaceProccessor` which generates proxies for pallets to the blockchain by their annotations. Added corresponding and auxiliary classes.

vnabiev force-pushed the feature/pallet-query-api branch 2 times, most recently from 0967419 to eb7bb80 Compare April 15, 2022 14:37

vnabiev changed the base branch from develop to feature/storage-api April 15, 2022 14:38

vnabiev force-pushed the feature/pallet-query-api branch 2 times, most recently from 748dd45 to 59105ba Compare April 15, 2022 17:02

kalaninja reviewed Apr 19, 2022

View reviewed changes

kalaninja mentioned this pull request Apr 19, 2022

Abstractions and API for querying to storages #12

Merged

vnabiev force-pushed the feature/storage-api branch 2 times, most recently from 871ff7b to d2811c1 Compare April 22, 2022 13:49

vnabiev force-pushed the feature/pallet-query-api branch 2 times, most recently from 996ae0b to 280c558 Compare April 25, 2022 12:18

vnabiev changed the title ~~Feature/pallet query api~~ Annotations for pallets and their storages Apr 25, 2022

vnabiev changed the base branch from feature/storage-api to develop April 25, 2022 12:28

vnabiev force-pushed the feature/pallet-query-api branch from 280c558 to 7243809 Compare April 25, 2022 12:54

kalaninja approved these changes Apr 26, 2022

View reviewed changes

Ishinka reviewed Apr 26, 2022

View reviewed changes

vnabiev force-pushed the feature/pallet-query-api branch from 7243809 to 8b5fe92 Compare April 26, 2022 14:37

vnabiev merged commit 942bf3c into develop Apr 26, 2022

vnabiev deleted the feature/pallet-query-api branch April 26, 2022 15:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Annotations for pallets and their storages #13

Annotations for pallets and their storages #13

vnabiev commented Apr 14, 2022 •

edited

Loading

kalaninja Apr 18, 2022

kalaninja Apr 19, 2022

kalaninja Apr 19, 2022

kalaninja Apr 19, 2022

vnabiev Apr 25, 2022

kalaninja Apr 19, 2022

vnabiev Apr 25, 2022

Ishinka Apr 26, 2022

Ishinka Apr 26, 2022

Ishinka Apr 26, 2022

Ishinka Apr 26, 2022

Ishinka Apr 26, 2022

Ishinka Apr 26, 2022

Ishinka Apr 26, 2022

Ishinka Apr 26, 2022

Ishinka Apr 26, 2022

Ishinka Apr 26, 2022

Annotations for pallets and their storages #13

Annotations for pallets and their storages #13

Conversation

vnabiev commented Apr 14, 2022 • edited Loading

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vnabiev commented Apr 14, 2022 •

edited

Loading