feat: add /accounts/:address/validate endpoint

docs/src/openapi-v1.yaml

@@ -324,6 +324,30 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+  /accounts/{accountId}/validate:
+    get:
+      tags:
+      - accounts
+      summary: Validate a given address for the connected network.
+      description: Returns information regarding an address's validity for whichever network
+        sidecar is connected too. It will check if the address is valid, what the ss58 prefix is, 
+        and what the networkId for that address is.
+      operationId: getValidationByAccountId
+      parameters: 
+      - name: accountId
+        in: path
+        description: SS58 or Hex address of the account.
+        required: true
+        schema:
+          format: SS58 or Hex
+          type: string 
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AccountValidation'
   /blocks/{blockId}:
     get:
       tags:
@@ -1394,6 +1418,19 @@ components:
                   based on the portion of `totalEraRewardPoints` they have.
               payouts:
                 $ref: '#/components/schemas/Payouts'
+    AccountValidation:
+      type: object
+      properties:
+        isValid:
+          type: boolean
+          description: Whether the given address is valid for the given network.
+        networkId:
+          type: string
+          description: Name of the network the address is associated with
+        ss58:
+          type: string
+          description: SS58 prefix of the given address
+          format: unsignedInteger
     AccountVestingInfo:
       type: object
       description: Sidecar version's <= v10.0.0 have a`vesting` return value that defaults to an object for

src/chains-config/defaultControllers.ts

@@ -11,6 +11,7 @@ export const defaultControllers: ControllerConfig = {
 		'AccountsBalanceInfo',
 		'AccountsStakingInfo',
 		'AccountsStakingPayouts',
+		'AccountsValidate',
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',

src/chains-config/dockMainnetControllers.ts

@@ -8,6 +8,7 @@ import { getBlockWeight } from './metadata-consts';
 export const dockMainnetControllers: ControllerConfig = {
 	controllers: [
 		'AccountsBalanceInfo',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'NodeNetwork',

src/chains-config/dockPoSMainnetControllers.ts

@@ -10,6 +10,7 @@ export const dockPoSMainnetControllers: ControllerConfig = {
 		'AccountsBalanceInfo',
 		'AccountsStakingInfo',
 		'AccountsStakingPayouts',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'NodeNetwork',

src/chains-config/dockPoSTestnetControllers.ts

@@ -10,6 +10,7 @@ export const dockTestnetControllers: ControllerConfig = {
 		'AccountsBalanceInfo',
 		'AccountsStakingInfo',
 		'AccountsStakingPayouts',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'NodeNetwork',

src/chains-config/kiltControllers.ts

@@ -8,6 +8,7 @@ export const kiltControllers: ControllerConfig = {
 	controllers: [
 		'AccountsBalanceInfo',
 		'AccountsStakingInfo',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'NodeNetwork',

src/chains-config/kulupuControllers.ts

@@ -4,6 +4,7 @@ import { initLRUCache } from './cache/lruCache';
 export const kulupuControllers: ControllerConfig = {
 	controllers: [
 		'AccountsBalanceInfo',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'NodeNetwork',

src/chains-config/kusamaControllers.ts

@@ -10,6 +10,7 @@ export const kusamaControllers: ControllerConfig = {
 		'AccountsBalanceInfo',
 		'AccountsStakingInfo',
 		'AccountsStakingPayouts',
+		'AccountsValidate',
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',

src/chains-config/mandalaControllers.ts

@@ -9,6 +9,7 @@ export const mandalaControllers: ControllerConfig = {
 		'AccountsBalanceInfo',
 		'AccountsStakingInfo',
 		'AccountsStakingPayouts',
+		'AccountsValidate',
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',

src/chains-config/polkadotControllers.ts

@@ -10,6 +10,7 @@ export const polkadotControllers: ControllerConfig = {
 		'AccountsBalanceInfo',
 		'AccountsStakingInfo',
 		'AccountsStakingPayouts',
+		'AccountsValidate',
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',

src/chains-config/polymeshControllers.ts

@@ -9,6 +9,7 @@ export const polymeshControllers: ControllerConfig = {
 	controllers: [
 		'AccountsStakingPayouts',
 		'AccountsStakingInfo',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'NodeNetwork',

src/chains-config/shidenControllers.ts

@@ -9,6 +9,7 @@ export const shidenControllers: ControllerConfig = {
 	controllers: [
 		'AccountsBalanceInfo',
 		'AccountsVestingInfo',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'BlocksTrace',

src/chains-config/soraControllers.ts

@@ -9,6 +9,7 @@ export const soraControllers: ControllerConfig = {
 		'AccountsBalanceInfo',
 		'AccountsStakingInfo',
 		'AccountsStakingPayouts',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'NodeNetwork',

src/chains-config/statemineControllers.ts

@@ -7,6 +7,7 @@ import { initLRUCache } from './cache/lruCache';
 export const statemineControllers: ControllerConfig = {
 	controllers: [
 		'AccountsAssets',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'NodeNetwork',

src/chains-config/statemintControllers.ts

@@ -7,6 +7,7 @@ import { initLRUCache } from './cache/lruCache';
 export const statemintControllers: ControllerConfig = {
 	controllers: [
 		'AccountsAssets',
+		'AccountsValidate',
 		'Blocks',
 		'BlocksExtrinsics',
 		'NodeNetwork',

src/chains-config/westendControllers.ts

@@ -10,6 +10,7 @@ export const westendControllers: ControllerConfig = {
 		'AccountsBalanceInfo',
 		'AccountsStakingInfo',
 		'AccountsStakingPayouts',
+		'AccountsValidate',
 		'AccountsVestingInfo',
 		'Blocks',
 		'BlocksExtrinsics',

src/controllers/accounts/AccountsValidateController.ts

@@ -0,0 +1,23 @@
+import { ApiPromise } from '@polkadot/api';
+import { RequestHandler } from 'express';
+
+import { AccountsValidateService } from '../../services/accounts';
+import AbstractController from '../AbstractController';
+
+export default class ValidateAddressController extends AbstractController<AccountsValidateService> {
+	constructor(api: ApiPromise) {
+		super(api, '/accounts/:address/validate', new AccountsValidateService(api));
+		this.initRoutes();
+	}
+
+	protected initRoutes(): void {
+		this.safeMountAsyncGetHandlers([['', this.validateAddress]]);
+	}
+
+	private validateAddress: RequestHandler = ({ params: { address } }, res) => {
+		ValidateAddressController.sanitizedSend(
+			res,
+			this.service.validateAddress(address)
+		);
+	};
+}

src/controllers/accounts/index.ts

@@ -2,4 +2,5 @@ export { default as AccountsAssets } from './AccountsAssetsController';
 export { default as AccountsBalanceInfo } from './AccountsBalanceInfoController';
 export { default as AccountsStakingInfo } from './AccountsStakingInfoController';
 export { default as AccountsStakingPayouts } from './AccountsStakingPayoutsController';
+export { default as AccountsValidate } from './AccountsValidateController';
 export { default as AccountsVestingInfo } from './AccountsVestingInfoController';

src/controllers/index.ts

@@ -3,6 +3,7 @@ import {
 	AccountsBalanceInfo,
 	AccountsStakingInfo,
 	AccountsStakingPayouts,
+	AccountsValidate,
 	AccountsVestingInfo,
 } from './accounts';
 import { Blocks, BlocksExtrinsics, BlocksTrace } from './blocks';
@@ -31,6 +32,7 @@ export const controllers = {
 	AccountsAssets,
 	AccountsBalanceInfo,
 	AccountsStakingInfo,
+	AccountsValidate,
 	AccountsVestingInfo,
 	AccountsStakingPayouts,
 	PalletsAssets,

src/services/accounts/AccountsValidateService.spec.ts

@@ -0,0 +1,145 @@
+import { ApiPromise } from '@polkadot/api';
+
+import { sanitizeNumbers } from '../../sanitize';
+import { AccountsValidateService } from './AccountsValidateService';
+
+describe('Validate addresses', () => {
+	const mockApi = {
+		registry: {
+			chainSS58: 0,
+		},
+	} as unknown as ApiPromise;
+	const validateService = new AccountsValidateService(mockApi);
+
+	afterEach(() => {
+		// Reset the `mockApi.registry.chainSS58` to be 0  before each test
+		(mockApi.registry.chainSS58 as unknown) = 0;
+	});
+
+	it('Should verify a polkadot address when connected to polkadot', () => {
+		const expectedResponse = {
+			isValid: true,
+			networkId: 'polkadot',
+			ss58: '0',
+		};
+		const polkadotAddr = '1xN1Q5eKQmS5AzASdjt6R6sHF76611vKR4PFpFjy1kXau4m';
+
+		expect(
+			sanitizeNumbers(validateService.validateAddress(polkadotAddr))
+		).toStrictEqual(expectedResponse);
+	});
+
+	it('Should verify a kusama address when connected to kusama', () => {
+		const expectedResponse = {
+			isValid: true,
+			networkId: 'kusama',
+			ss58: '2',
+		};
+		const kusamaAddr = 'DXgXPAT5zWtPHo6FhVvrDdiaDPgCNGxhJAeVBYLtiwW9hAc';
+		(mockApi.registry.chainSS58 as unknown) = 2;
+
+		expect(
+			sanitizeNumbers(validateService.validateAddress(kusamaAddr))
+		).toStrictEqual(expectedResponse);
+	});
+
+	it('Should verify a kulupu address when connected to kulup', () => {
+		const expectedResponse = {
+			isValid: true,
+			networkId: 'kulupu',
+			ss58: '16',
+		};
+		const kulupuAddr = '2cYv9Gk6U4m4a7Taw9pG8qMfd1Pnxw6FLTvV6kYZNhGL6M9y';
+		(mockApi.registry.chainSS58 as unknown) = 16;
+
+		expect(
+			sanitizeNumbers(validateService.validateAddress(kulupuAddr))
+		).toStrictEqual(expectedResponse);
+	});
+
+	it('Should verify a valid default substrate address', () => {
+		const expectedResponse = {
+			isValid: true,
+			networkId: 'substrate',
+			ss58: '42',
+		};
+		const substrateAddr = '5EnxxUmEbw8DkENKiYuZ1DwQuMoB2UWEQJZZXrTsxoz7SpgG';
+		(mockApi.registry.chainSS58 as unknown) = 42;
+
+		expect(
+			sanitizeNumbers(validateService.validateAddress(substrateAddr))
+		).toStrictEqual(expectedResponse);
+	});
+
+	it('Should give the correct response with a valid ss58 addr on the wrong network', () => {
+		const expectedResponse = {
+			isValid: false,
+			networkId: 'polkadot',
+			ss58: '0',
+		};
+		const polkadotAddr = '1xN1Q5eKQmS5AzASdjt6R6sHF76611vKR4PFpFjy1kXau4m';
+		(mockApi.registry.chainSS58 as unknown) = 2;
+
+		expect(
+			sanitizeNumbers(validateService.validateAddress(polkadotAddr))
+		).toStrictEqual(expectedResponse);
+	});
+
+	it('Should give the correct response for a polkadot hex value', () => {
+		const expectedResponse = {
+			isValid: true,
+			networkId: 'polkadot',
+			ss58: '0',
+		};
+		const polkadotHex =
+			'0x002a39366f6620a6c2e2fed5990a3d419e6a19dd127fc7a50b515cf17e2dc5cc592312';
+
+		expect(
+			sanitizeNumbers(validateService.validateAddress(polkadotHex))
+		).toStrictEqual(expectedResponse);
+	});
+
+	it('Should give the correct response for a kusama hex value', () => {
+		const expectedResponse = {
+			isValid: true,
+			networkId: 'kusama',
+			ss58: '2',
+		};
+		const kusamaHex =
+			'0x02ce046d43fc4c0fb8b3b754028515e5020f5f1d8d620b4ef0f983c5df34b1952909e9';
+		(mockApi.registry.chainSS58 as unknown) = 2;
+
+		expect(
+			sanitizeNumbers(validateService.validateAddress(kusamaHex))
+		).toStrictEqual(expectedResponse);
+	});
+
+	it('Should give the correct response for a karura hex value', () => {
+		const expectedResponse = {
+			isValid: true,
+			networkId: 'karura',
+			ss58: '8',
+		};
+		const karuraHex =
+			'0x086d6f646c6163612f6364707400000000000000000000000000000000000000008333';
+		(mockApi.registry.chainSS58 as unknown) = 8;
+
+		expect(
+			sanitizeNumbers(validateService.validateAddress(karuraHex))
+		).toStrictEqual(expectedResponse);
+	});
+
+	it('Should return the correct response for an invalid hex value', () => {
+		const expectedResponse = {
+			isValid: false,
+			networkId: null,
+			ss58: null,
+		};
+		const invalidAddr =
+			'0x2a39366f6620a6c2e2fed5990a3d419e6a19dd127fc7a50b515cf17e2dc5cc59';
+
+		expect(
+			sanitizeNumbers(validateService.validateAddress(invalidAddr))
+		).toStrictEqual(expectedResponse);
+	});
+});