build docs

paritytech · Sep 15, 2023 · d57f728 · d57f728
1 parent fcf3197
commit d57f728
Show file tree

Hide file tree

Showing 31 changed files with 102 additions and 34 deletions.
diff --git a/docs/dist/app.bundle.js b/docs/dist/app.bundle.js
diff --git a/docs/src/openapi-v1.yaml b/docs/src/openapi-v1.yaml
@@ -679,6 +679,35 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+  /blocks/{blockId}/extrinsics-raw:
+    get:
+      tags:
+      - blocks
+      summary: Get a block by its height or hash.
+      description: Returns a single block. BlockId can either be a block hash or a
+        block height. Replaces `/block/{number}` from versions < v1.0.0.
+      operationId: getBlockRawExtrinsics
+      parameters:
+      - name: blockId
+        in: path
+        description: Block identifier, as the block height or block hash.
+        required: true
+        schema:
+          pattern: 'a-km-zA-HJ-NP-Z1-9{8,64}'
+          type: string
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/BlockRaw'
+        "400":
+          description: invalid Block identifier supplied
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'         
   /contracts/ink/{address}/query:
     post:
       tags:
@@ -2484,6 +2513,40 @@ components:
         Note: Block finalization does not correspond to consensus, i.e. whether
         the block is in the canonical chain. It denotes the finalization of block
         _construction._
+    BlockRaw:
+      type: object
+      properties:
+        hash:
+          type: string
+          description: The block's hash.
+          format: hex
+        number:
+          type: string
+          description: The block's height.
+          format: unsignedInteger
+        parentHash:
+          type: string
+          description: The hash of the parent block.
+          format: hex
+        stateRoot:
+          type: string
+          description: The state root after executing this block.
+          format: hex
+        extrinsicRoot:
+          type: string
+          description: The Merkle root of the extrinsics.
+          format: hex
+        logs:
+          type: array
+          items:
+            $ref: '#/components/schemas/DigestItem'
+          description: Array of `DigestItem`s associated with the block.
+        extrinsics:
+          type: array
+          description: Array of raw extrinsics (inherents and transactions) within the
+            block.
+          items:
+            type: string
     Blocks:
       type: array
       items: 

diff --git a/src/chains-config/acalaControllers.ts b/src/chains-config/acalaControllers.ts
@@ -26,7 +26,7 @@ export const acalaControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/assetHubKusamaControllers.ts b/src/chains-config/assetHubKusamaControllers.ts
@@ -27,7 +27,7 @@ export const assetHubKusamaControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/assetHubPolkadotControllers.ts b/src/chains-config/assetHubPolkadotControllers.ts
@@ -27,7 +27,7 @@ export const assetHubPolkadotControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/assetHubWestendControllers.ts b/src/chains-config/assetHubWestendControllers.ts
@@ -27,7 +27,7 @@ export const assetHubWestendControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/astarControllers.ts b/src/chains-config/astarControllers.ts
@@ -28,7 +28,7 @@ export const astarControllers: ControllerConfig = {
 		'Blocks',
 		'BlocksExtrinsics',
 		'BlocksTrace',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/bifrostControllers.ts b/src/chains-config/bifrostControllers.ts
@@ -26,7 +26,7 @@ export const bifrostControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/bifrostPolkadotControllers.ts b/src/chains-config/bifrostPolkadotControllers.ts
@@ -26,7 +26,7 @@ export const bifrostPolkadotControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/calamariControllers.ts b/src/chains-config/calamariControllers.ts
@@ -29,7 +29,7 @@ export const calamariControllers: ControllerConfig = {
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/crustControllers.ts b/src/chains-config/crustControllers.ts
@@ -26,7 +26,7 @@ export const crustControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/defaultControllers.ts b/src/chains-config/defaultControllers.ts
@@ -31,7 +31,7 @@ export const defaultControllers: ControllerConfig = {
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'ContractsInk',
 		'NodeNetwork',
 		'NodeTransactionPool',

diff --git a/src/chains-config/dockMainnetControllers.ts b/src/chains-config/dockMainnetControllers.ts
@@ -26,7 +26,7 @@ export const dockMainnetControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/dockPoSMainnetControllers.ts b/src/chains-config/dockPoSMainnetControllers.ts
@@ -28,7 +28,7 @@ export const dockPoSMainnetControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/dockPoSTestnetControllers.ts b/src/chains-config/dockPoSTestnetControllers.ts
@@ -28,7 +28,7 @@ export const dockTestnetControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/heikoControllers.ts b/src/chains-config/heikoControllers.ts
@@ -28,7 +28,7 @@ export const heikoControllers: ControllerConfig = {
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/karuraControllers.ts b/src/chains-config/karuraControllers.ts
@@ -26,7 +26,7 @@ export const karuraControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/kiltControllers.ts b/src/chains-config/kiltControllers.ts
@@ -27,7 +27,7 @@ export const kiltControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/kulupuControllers.ts b/src/chains-config/kulupuControllers.ts
@@ -23,7 +23,7 @@ export const kulupuControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/kusamaControllers.ts b/src/chains-config/kusamaControllers.ts
@@ -31,7 +31,7 @@ export const kusamaControllers: ControllerConfig = {
 		'Blocks',
 		'BlocksExtrinsics',
 		'BlocksTrace',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/mandalaControllers.ts b/src/chains-config/mandalaControllers.ts
@@ -29,7 +29,7 @@ export const mandalaControllers: ControllerConfig = {
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/mantaControllers.ts b/src/chains-config/mantaControllers.ts
@@ -29,7 +29,7 @@ export const mantaControllers: ControllerConfig = {
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/parallelControllers.ts b/src/chains-config/parallelControllers.ts
@@ -28,7 +28,7 @@ export const parallelControllers: ControllerConfig = {
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/polkadotControllers.ts b/src/chains-config/polkadotControllers.ts
@@ -31,7 +31,7 @@ export const polkadotControllers: ControllerConfig = {
 		'Blocks',
 		'BlocksExtrinsics',
 		'BlocksTrace',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/polymeshControllers.ts b/src/chains-config/polymeshControllers.ts
@@ -27,7 +27,7 @@ export const polymeshControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/shidenControllers.ts b/src/chains-config/shidenControllers.ts
@@ -28,7 +28,7 @@ export const shidenControllers: ControllerConfig = {
 		'Blocks',
 		'BlocksExtrinsics',
 		'BlocksTrace',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/soraControllers.ts b/src/chains-config/soraControllers.ts
@@ -28,7 +28,7 @@ export const soraControllers: ControllerConfig = {
 		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/src/chains-config/westendControllers.ts b/src/chains-config/westendControllers.ts
@@ -31,7 +31,7 @@ export const westendControllers: ControllerConfig = {
 		'Blocks',
 		'BlocksExtrinsics',
 		'BlocksTrace',
-		'BlocksRawTx',
+		'BlocksRawExtrinsics',
 		'NodeNetwork',
 		'NodeTransactionPool',
 		'NodeVersion',

diff --git a/...ntrollers/blocks/BlocksRawTxController.ts → ...s/blocks/BlocksRawExtrinsicsController.ts b/...ntrollers/blocks/BlocksRawTxController.ts → ...s/blocks/BlocksRawExtrinsicsController.ts
@@ -22,7 +22,7 @@ import { ControllerOptions } from '../../types/chains-config';
 import { INumberParam } from '../../types/requests';
 import AbstractController from '../AbstractController';
 
-export default class BlocksRawTxController extends AbstractController<BlocksService> {
+export default class BlocksRawExtrinsicsController extends AbstractController<BlocksService> {
 	constructor(api: ApiPromise, options: ControllerOptions) {
 		super(
 			api,
@@ -38,21 +38,21 @@ export default class BlocksRawTxController extends AbstractController<BlocksServ
 	}
 
 	protected initRoutes(): void {
-		this.safeMountAsyncGetHandlers([['', this.getRawTx]]);
+		this.safeMountAsyncGetHandlers([['', this.getBlockRawExtrinsics]]);
 	}
 
 	/**
 	 *
 	 * @param _req Express Request
 	 * @param res Express Response
 	 */
-	private getRawTx: RequestHandler<INumberParam> = async (
+	private getBlockRawExtrinsics: RequestHandler<INumberParam> = async (
 		{ params: { blockId } },
 		res
 	): Promise<void> => {
 		const hash = await this.getHashForBlock(blockId);
 
-		BlocksRawTxController.sanitizedSend(
+		BlocksRawExtrinsicsController.sanitizedSend(
 			res,
 			await this.service.fetchBlockRaw(hash)
 		);

diff --git a/src/controllers/blocks/index.ts b/src/controllers/blocks/index.ts
@@ -16,5 +16,5 @@
 
 export { default as Blocks } from './BlocksController';
 export { default as BlocksExtrinsics } from './BlocksExtrinsicsController';
-export { default as BlocksRawTx } from './BlocksRawTxController';
+export { default as BlocksRawExtrinsics } from './BlocksRawExtrinsicsController';
 export { default as BlocksTrace } from './BlocksTraceController';
diff --git a/src/controllers/index.ts b/src/controllers/index.ts
@@ -23,7 +23,12 @@ import {
 	AccountsValidate,
 	AccountsVestingInfo,
 } from './accounts';
-import { Blocks, BlocksExtrinsics, BlocksRawTx, BlocksTrace } from './blocks';
+import {
+	Blocks,
+	BlocksExtrinsics,
+	BlocksRawExtrinsics,
+	BlocksTrace,
+} from './blocks';
 import { ContractsInk } from './contracts';
 import { NodeNetwork, NodeTransactionPool, NodeVersion } from './node';
 import {
@@ -55,7 +60,7 @@ export const controllers = {
 	Blocks,
 	BlocksExtrinsics,
 	BlocksTrace,
-	BlocksRawTx,
+	BlocksRawExtrinsics,
 	AccountsAssets,
 	AccountsBalanceInfo,
 	AccountsConvert,