feat: add pallets/dispatchables endpoint (#1209)

* test pallet dispatch call

* update fetchDispatchables service

* add e2e tests for dispatchables endpoint
update docs

* update getDispatchablesItemMeta

* update dispatchables unit tests

* update abstractpalletservice

* update docs, fix mispells

* update docs and remove log

docs/src/openapi-v1.yaml

@@ -935,6 +935,113 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/PalletsAssetsInfo'
+  /pallets/{palletId}/consts:
+    get:
+      tags:
+      - pallets
+      summary: Get a list of constants for a pallet.
+      description: Returns a list of const item metadata for constant items of the
+        specified palletId.
+      parameters:
+      - name: palletId
+        in: path
+        description: 'Name or index of the pallet to read constant metadata for. Note: the pallet name must match what is
+          specified in the runtime metadata.'
+        required: true
+        schema:
+          type: string
+      - name: onlyIds
+        in: query
+        description: Only return the names (IDs) of the const items instead of every constant's metadata.
+        required: false
+        schema:
+          type: boolean
+      - name: at
+        in: query
+        description: Block at which to retrieve a list of
+          the pallet's constant items.
+        required: false
+        schema:
+          type: string
+          description: Block identifier, as the block height or block hash.
+          format: unsignedInteger or $hex
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                description: Pallet info and Array of constantItemIds.
+                items:
+                  $ref: '#/components/schemas/PalletConstants'
+        "400":
+          description: invalid blockId supplied for at query param
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        "404":
+          description: could not find pallet with palletId
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+  /pallets/{palletId}/consts/{constantItemId}:
+    get:
+      tags:
+      - pallets
+      summary: Get the value of a constant item.
+      description: Returns the value stored under the constantItemId.
+      parameters:
+      - name: palletId
+        in: path
+        description: 'Name or index of the pallet to read constant metadata for. Note: the pallet name must match what is
+          specified in the runtime metadata.'
+        required: true
+        schema:
+          type: string
+      - name: constantItemId
+        in: path
+        description: Id of the const item to query for.
+        required: true
+        schema:
+          type: string
+      - name: at
+        in: query
+        description: Block at which to query the const item at.
+        required: false
+        schema:
+          type: string
+          description: Block identifier, as the block height or block hash.
+          format: unsignedInteger or $hex
+      - name: metadata
+        in: query
+        description: Include the const items metadata (including documentation)
+          if set to true.
+        required: false
+        schema:
+          default: false
+          type: boolean
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PalletConstantsItem'
+        "400":
+          description: invalid blockId supplied for at query param
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        "404":
+          description: could not find resource with with id
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
   /pallets/nomination-pools/{poolId}:
     get:
       tags:
@@ -1052,46 +1159,37 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-  /pallets/{palletId}/consts:
+  /pallets/{palletId}/dispatchables:
     get:
       tags:
       - pallets
-      summary: Get a list of constants for a pallet.
-      description: Returns a list of const item metadata for constant items of the
+      summary: Get a list of dispatchables for a pallet.
+      description: Returns a list of dispatchable item metadata for distpachable items of the
         specified palletId.
       parameters:
       - name: palletId
         in: path
-        description: 'Name or index of the pallet to read constant metadata for. Note: the pallet name must match what is
+        description: 'Name or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is
           specified in the runtime metadata.'
         required: true
         schema:
           type: string
       - name: onlyIds
         in: query
-        description: Only return the names (IDs) of the const items instead of every constant's metadata.
+        description: Only return the names (IDs) of the dispatchable items instead of every dispatchable's metadata.
         required: false
         schema:
           type: boolean
-      - name: at
-        in: query
-        description: Block at which to retrieve a list of
-          the pallet's constant items.
-        required: false
-        schema:
-          type: string
-          description: Block identifier, as the block height or block hash.
-          format: unsignedInteger or $hex
       responses:
         "200":
           description: successful operation
           content:
             application/json:
               schema:
                 type: array
-                description: Pallet info and Array of constantItemIds.
+                description: Pallet info and Array of dispatchableItemIds.
                 items:
-                  $ref: '#/components/schemas/PalletConstants'
+                  $ref: '#/components/schemas/PalletDispatchables'
         "400":
           description: invalid blockId supplied for at query param
           content:
@@ -1104,37 +1202,29 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-  /pallets/{palletId}/consts/{constantItemId}:
+  /pallets/{palletId}/dispatchables/{dispatchableItemId}:
     get:
       tags:
       - pallets
-      summary: Get the value of a constant item.
-      description: Returns the value stored under the constantItemId.
+      summary: Get the value of a dispatchable item.
+      description: Returns the value stored under the dispatchableItemId.
       parameters:
       - name: palletId
         in: path
-        description: 'Name or index of the pallet to read constant metadata for. Note: the pallet name must match what is
+        description: 'Name or index of the pallet to read dispatchable metadata for. Note: the pallet name must match what is
           specified in the runtime metadata.'
         required: true
         schema:
           type: string
-      - name: constantItemId
+      - name: dispatchableItemId
         in: path
-        description: Id of the const item to query for.
+        description: Id of the dispatchable item to query for.
         required: true
         schema:
           type: string
-      - name: at
-        in: query
-        description: Block at which to query the const item at.
-        required: false
-        schema:
-          type: string
-          description: Block identifier, as the block height or block hash.
-          format: unsignedInteger or $hex
       - name: metadata
         in: query
-        description: Include the const items metadata (including documentation)
+        description: Include the dispatchable items metadata (including documentation)
           if set to true.
         required: false
         schema:
@@ -1146,7 +1236,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/PalletConstantsItem'
+                $ref: '#/components/schemas/PalletDispatchablesItem'
         "400":
           description: invalid blockId supplied for at query param
           content:
@@ -2810,6 +2900,64 @@ components:
           type: string
           example: "Information concerning any given constant.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control."
       description: Metadata of an constant item from a FRAME pallet.
+    PalletDispatchables:
+      type: object
+      properties:
+        at:
+          $ref: '#/components/schemas/BlockIdentifiers'
+        pallet:
+          type: string
+          description: Name of the pallet.
+          example: "democracy"
+        palletIndex:
+          type: string
+          description: Index of the pallet for looking up dispatchables.
+          example: "14"
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/PalletDispatchablesItemMetadata'
+          description: Array containing metadata for each dispatchable entry of the pallet.
+    PalletDispatchablesItem:
+      type: object
+      properties:
+        pallet:
+          type: string
+          description: Name of the pallet.
+          example: "democracy"
+        palletIndex:
+          type: string
+          description: Index of the pallet for looking up dispatchables.
+          example: "14"
+        dispatchableItem:
+          type: string
+          description: Name of the dispatchable item.
+          example: "vote"
+        metadata:
+          $ref: '#/components/schemas/PalletDispatchablesItemMetadata'
+    PalletDispatchablesItemMetadata:
+      type: object
+      properties:
+        name:
+          type: string
+          example: "propose"
+          description: The dispatchable item's name (which is the same as the dispatchable item's ID).
+        fields:
+          type: array
+          items:
+            type: string
+        index:
+         type: string
+         example: "0"
+         description: The index of the dispatchable item in the lists of pallet dispatchables.
+        docs:
+          type: string
+          example: "Information concerning any given dispatchable.\n\n TWOX-NOTE: SAFE as indexes are not under an attacker’s control."
+        args:
+          type: array
+          items:
+            type: string
+      description: Metadata of a dispatchable item from a FRAME pallet.
     PalletErrors:
       type: object
       properties:

e2e-tests/latest/endpoints/polkadot.ts

@@ -153,6 +153,23 @@ export const polkadot: IConfig = {
 		path: '/pallets/democracy/consts/EnactmentPeriod',
 		queryParams: ['at={blockId}'],
 	},
+	'/pallets/{palletId}/dispatchables': {
+		path: '/pallets/democracy/dispatchables',
+		queryParams: [],
+	},
+	'/pallets/{palletId}/dispatchables?onlyIds=true': {
+		path: '/pallets/14/dispatchables',
+		queryParams: [],
+	},
+	'/pallets/{palletId}/dispatchables/{dispatchableItemId}': {
+		path: '/pallets/democracy/dispatchables/vote',
+		queryParams: [],
+	},
+	'/pallets/{palletId}/dispatchables/{dispatchableItemIdWithMultipleWordName}':
+		{
+			path: '/pallets/fastUnstake/dispatchables/registerFastUnstake',
+			queryParams: [],
+		},
 	'/pallets/{palletId}/errors': {
 		path: '/pallets/balances/errors',
 		queryParams: ['at={blockId}'],

e2e-tests/latest/endpoints/statemint.ts

@@ -35,6 +35,14 @@ export const statemint = {
 		path: '/pallets/assets/consts/AssetDeposit',
 		queryParams: ['at={blockId}'],
 	},
+	'/pallets/{palletId}/dispatchables': {
+		path: '/pallets/assets/dispatchables',
+		queryParams: ['at={blockId}'],
+	},
+	'/pallets/{palletId}/dispatchables/{dispatchableItemId}': {
+		path: '/pallets/assets/dispatchables/create',
+		queryParams: ['at={blockId}'],
+	},
 	'/pallets/{palletId}/errors': {
 		path: '/pallets/assets/errors',
 		queryParams: ['at={blockId}'],

src/chains-config/defaultControllers.ts

@@ -36,6 +36,7 @@ export const defaultControllers: ControllerConfig = {
 		'NodeTransactionPool',
 		'NodeVersion',
 		'PalletsAssets',
+		'PalletsDispatchables',
 		'PalletsConsts',
 		'PalletsErrors',
 		'PalletsEvents',

src/chains-config/kusamaControllers.ts

@@ -34,6 +34,7 @@ export const kusamaControllers: ControllerConfig = {
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',
+		'PalletsDispatchables',
 		'PalletsConsts',
 		'PalletsErrors',
 		'PalletsEvents',

src/chains-config/polkadotControllers.ts

@@ -34,6 +34,7 @@ export const polkadotControllers: ControllerConfig = {
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',
+		'PalletsDispatchables',
 		'PalletsConsts',
 		'PalletsErrors',
 		'PalletsEvents',

src/chains-config/statemintControllers.ts

@@ -31,6 +31,7 @@ export const statemintControllers: ControllerConfig = {
 		'NodeTransactionPool',
 		'NodeVersion',
 		'PalletsAssets',
+		'PalletsDispatchables',
 		'PalletsConsts',
 		'PalletsEvents',
 		'PalletsErrors',

src/chains-config/westendControllers.ts

@@ -33,6 +33,7 @@ export const westendControllers: ControllerConfig = {
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',
+		'PalletsDispatchables',
 		'PalletsConsts',
 		'PalletsErrors',
 		'PalletsEvents',

src/controllers/index.ts

@@ -29,6 +29,7 @@ import { NodeNetwork, NodeTransactionPool, NodeVersion } from './node';
 import {
 	PalletsAssets,
 	PalletsConsts,
+	PalletsDispatchables,
 	PalletsErrors,
 	PalletsEvents,
 	PalletsNominationPools,
@@ -61,6 +62,7 @@ export const controllers = {
 	AccountsStakingPayouts,
 	ContractsInk,
 	PalletsAssets,
+	PalletsDispatchables,
 	PalletsConsts,
 	PalletsErrors,
 	PalletsEvents,