feat: Add remaining Accounts endpoints with /rc prefix (#1704)

TarikGul · web-flow · commit 1376c359d598 · 2025-07-22T08:45:51.000-04:00
diff --git a/docs/src/openapi-v1.yaml b/docs/src/openapi-v1.yaml
@@ -774,6 +774,50 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+  /rc/accounts/{address}/proxy-info:
+    get:
+      tags:
+      - rc
+      summary: Get proxy information for an account on the relay chain.
+      description: Returns information about an account's proxy configuration on the relay chain. This endpoint is specifically for Asset Hub and queries the relay chain (Polkadot/Kusama) for proxy information.
+      operationId: getRcAccountProxyInfo
+      parameters:
+      - name: address
+        in: path
+        description: SS58 address of the account.
+        required: true
+        schema:
+          type: string
+          format: SS58
+      - name: at
+        in: query
+        description: Block at which to query proxy info for the
+          specified account.
+        required: false
+        schema:
+          type: string
+          description: Block height (as a non-negative integer) or hash
+            (as a hex string).
+          format: unsignedInteger or $hex
+      responses:
+        "200":
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AccountProxyInfo'
+        "400":
+          description: Invalid Address
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        "404":
+          description: account not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
   /blocks:
     get:
       tags:
diff --git a/src/chains-config/assetHubKusamaControllers.ts b/src/chains-config/assetHubKusamaControllers.ts
@@ -39,6 +39,7 @@ export const assetHubKusamaControllers: ControllerConfig = {
 		'PalletsEvents',
 		'PalletsForeignAssets',
 		'RcAccountsBalanceInfo',
+		'RcAccountsProxyInfo',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',
diff --git a/src/chains-config/assetHubNextWestendControllers.ts b/src/chains-config/assetHubNextWestendControllers.ts
@@ -50,6 +50,7 @@ export const assetHubNextWestendControllers: ControllerConfig = {
 		'PalletsStorage',
 		'PalletsPoolAssets',
 		'RcAccountsBalanceInfo',
+		'RcAccountsProxyInfo',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',
diff --git a/src/chains-config/assetHubPolkadotControllers.ts b/src/chains-config/assetHubPolkadotControllers.ts
@@ -41,6 +41,7 @@ export const assetHubPolkadotControllers: ControllerConfig = {
 		'PalletsErrors',
 		'PalletsForeignAssets',
 		'RcAccountsBalanceInfo',
+		'RcAccountsProxyInfo',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',
diff --git a/src/chains-config/assetHubWestendControllers.ts b/src/chains-config/assetHubWestendControllers.ts
@@ -50,6 +50,7 @@ export const assetHubWestendControllers: ControllerConfig = {
 		'PalletsStorage',
 		'PalletsPoolAssets',
 		'RcAccountsBalanceInfo',
+		'RcAccountsProxyInfo',
 		'RuntimeCode',
 		'RuntimeMetadata',
 		'RuntimeSpec',
diff --git a/src/controllers/index.ts b/src/controllers/index.ts
@@ -46,7 +46,7 @@ import {
 	PalletsStorage,
 } from './pallets';
 import { Paras } from './paras';
-import { RcAccountsBalanceInfo } from './rc';
+import { RcAccountsBalanceInfo, RcAccountsProxyInfo } from './rc/accounts';
 import { RuntimeCode, RuntimeMetadata, RuntimeSpec } from './runtime';
 import { TransactionDryRun, TransactionFeeEstimate, TransactionMaterial, TransactionSubmit } from './transaction';
 
@@ -86,6 +86,7 @@ export const controllers = {
 	NodeTransactionPool,
 	NodeVersion,
 	RcAccountsBalanceInfo,
+	RcAccountsProxyInfo,
 	RuntimeCode,
 	RuntimeMetadata,
 	RuntimeSpec,
diff --git a/src/controllers/rc/accounts/RcAccountsBalanceInfoController.ts b/src/controllers/rc/accounts/RcAccountsBalanceInfoController.ts
@@ -17,10 +17,10 @@
 import { RequestHandler } from 'express';
 import { IAddressParam } from 'src/types/requests';
 
-import { ApiPromiseRegistry } from '../../apiRegistry';
-import { validateAddress, validateBoolean } from '../../middleware';
-import { RcAccountsBalanceInfoService } from '../../services';
-import AbstractController from '../AbstractController';
+import { ApiPromiseRegistry } from '../../../apiRegistry';
+import { validateAddress, validateBoolean } from '../../../middleware';
+import { RcAccountsBalanceInfoService } from '../../../services';
+import AbstractController from '../../AbstractController';
 
 export default class AccountsBalanceController extends AbstractController<RcAccountsBalanceInfoService> {
 	static controllerName = 'RcAccountsBalanceInfo';
diff --git a/src/controllers/rc/accounts/RcAccountsProxyInfoController.ts b/src/controllers/rc/accounts/RcAccountsProxyInfoController.ts
@@ -0,0 +1,63 @@
+// Copyright 2017-2025 Parity Technologies (UK) Ltd.
+// This file is part of Substrate API Sidecar.
+//
+// Substrate API Sidecar is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import { RequestHandler } from 'express';
+import { IAddressParam } from 'src/types/requests';
+
+import { ApiPromiseRegistry } from '../../../apiRegistry';
+import { validateAddress } from '../../../middleware';
+import { RcAccountsProxyInfoService } from '../../../services';
+import AbstractController from '../../AbstractController';
+
+export default class RcAccountsProxyInfoController extends AbstractController<RcAccountsProxyInfoService> {
+	static controllerName = 'RcAccountsProxyInfo';
+	static requiredPallets = [['Proxy']];
+	constructor(api: string) {
+		super(api, '/rc/accounts/:address/proxy-info', new RcAccountsProxyInfoService(api));
+		this.initRoutes();
+	}
+
+	protected initRoutes(): void {
+		this.router.use(this.path, validateAddress);
+
+		this.safeMountAsyncGetHandlers([['', this.getAccountProxyInfo]]);
+	}
+
+	/**
+	 * Get the latest account proxy info of `address` from the relay chain.
+	 *
+	 * @param req Express Request
+	 * @param res Express Response
+	 */
+	private getAccountProxyInfo: RequestHandler<IAddressParam> = async (
+		{ params: { address }, query: { at } },
+		res,
+	): Promise<void> => {
+		const rcApi = ApiPromiseRegistry.getApiByType('relay')[0]?.api;
+
+		if (!rcApi) {
+			throw new Error('Relay chain API not found, please use SAS_SUBSTRATE_MULTI_CHAIN_URL env variable');
+		}
+
+		const hash = await this.getHashFromAt(at, { api: rcApi });
+		const historicApi = await rcApi.at(hash);
+
+		RcAccountsProxyInfoController.sanitizedSend(
+			res,
+			await this.service.fetchAccountProxyInfo(hash, rcApi, historicApi, address),
+		);
+	};
+}
diff --git a/src/controllers/rc/accounts/index.ts b/src/controllers/rc/accounts/index.ts
@@ -0,0 +1,18 @@
+// Copyright 2017-2025 Parity Technologies (UK) Ltd.
+// This file is part of Substrate API Sidecar.
+//
+// Substrate API Sidecar is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+export { default as RcAccountsBalanceInfo } from './RcAccountsBalanceInfoController';
+export { default as RcAccountsProxyInfo } from './RcAccountsProxyInfoController';
diff --git a/src/controllers/rc/index.ts b/src/controllers/rc/index.ts
@@ -14,4 +14,4 @@
 // You should have received a copy of the GNU General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-export { default as RcAccountsBalanceInfo } from './RcAccountsBalanceInfoController';
+export * from './accounts';
diff --git a/src/services/rc/accounts/RcAccountsBalanceInfoService.spec.ts b/src/services/rc/accounts/RcAccountsBalanceInfoService.spec.ts
@@ -22,12 +22,12 @@ import { ApiPromise } from '@polkadot/api';
 import { ApiDecoration } from '@polkadot/api/types';
 import { AccountInfo, Address, Hash } from '@polkadot/types/interfaces';
 
-import { ApiPromiseRegistry } from '../../apiRegistry';
-import { sanitizeNumbers } from '../../sanitize/sanitizeNumbers';
-import { polkadotRegistry, polkadotRegistryV9370 } from '../../test-helpers/registries';
-import { blockHash789629, defaultMockApi, testAddress } from '../test-helpers/mock';
-import accountsBalanceInfo789629 from '../test-helpers/responses/accounts/balanceInfo789629.json';
-import accountsBalanceInfoFeeFrozen from '../test-helpers/responses/accounts/balanceInfoFeeFrozen.json';
+import { ApiPromiseRegistry } from '../../../apiRegistry';
+import { sanitizeNumbers } from '../../../sanitize/sanitizeNumbers';
+import { polkadotRegistry, polkadotRegistryV9370 } from '../../../test-helpers/registries';
+import { blockHash789629, defaultMockApi, testAddress } from '../../test-helpers/mock';
+import accountsBalanceInfo789629 from '../../test-helpers/responses/accounts/balanceInfo789629.json';
+import accountsBalanceInfoFeeFrozen from '../../test-helpers/responses/accounts/balanceInfoFeeFrozen.json';
 import { RcAccountsBalanceInfoService } from './RcAccountsBalanceInfoService';
 
 const locksAt = (_address: string) =>
diff --git a/src/services/rc/accounts/RcAccountsBalanceInfoService.ts b/src/services/rc/accounts/RcAccountsBalanceInfoService.ts
@@ -21,8 +21,8 @@ import type { AccountData, Balance, BalanceLock, BlockHash, Index } from '@polka
 import type { PalletBalancesAccountData } from '@polkadot/types/lookup';
 import { BadRequest } from 'http-errors';
 
-import { IAccountBalanceInfo, IBalanceLock } from '../../types/responses';
-import { AbstractService } from '../AbstractService';
+import { IAccountBalanceInfo, IBalanceLock } from '../../../types/responses';
+import { AbstractService } from '../../AbstractService';
 
 export class RcAccountsBalanceInfoService extends AbstractService {
 	/**
diff --git a/src/services/rc/accounts/RcAccountsProxyInfoService.ts b/src/services/rc/accounts/RcAccountsProxyInfoService.ts
@@ -0,0 +1,55 @@
+// Copyright 2017-2025 Parity Technologies (UK) Ltd.
+// This file is part of Substrate API Sidecar.
+//
+// Substrate API Sidecar is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import type { ApiPromise } from '@polkadot/api';
+import type { ApiDecoration } from '@polkadot/api/types';
+import type { BlockHash } from '@polkadot/types/interfaces';
+
+import type { AccountsProxyInfo } from '../../../types/responses';
+import { AbstractService } from '../../AbstractService';
+
+export class RcAccountsProxyInfoService extends AbstractService {
+	/**
+	 * Fetch proxy information for an account from the relay chain at a given block.
+	 *
+	 * @param hash `BlockHash` to make call at.
+	 * @param api Relay chain API instance.
+	 * @param historicApi Historic API instance for the relay chain.
+	 * @param address Address of the account to get the proxy info of.
+	 */
+	async fetchAccountProxyInfo(
+		hash: BlockHash,
+		api: ApiPromise,
+		historicApi: ApiDecoration<'promise'>,
+		address: string,
+	): Promise<AccountsProxyInfo> {
+		const [{ number }, proxyInfo] = await Promise.all([
+			api.rpc.chain.getHeader(hash),
+			historicApi.query.proxy.proxies(address),
+		]);
+
+		const at = {
+			hash,
+			height: number.unwrap().toString(10),
+		};
+
+		return {
+			at,
+			delegatedAccounts: proxyInfo[0],
+			depositHeld: proxyInfo[1],
+		};
+	}
+}
diff --git a/src/services/rc/accounts/index.ts b/src/services/rc/accounts/index.ts
@@ -0,0 +1,18 @@
+// Copyright 2017-2025 Parity Technologies (UK) Ltd.
+// This file is part of Substrate API Sidecar.
+//
+// Substrate API Sidecar is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+export * from './RcAccountsBalanceInfoService';
+export * from './RcAccountsProxyInfoService';
diff --git a/src/services/rc/index.ts b/src/services/rc/index.ts
@@ -14,4 +14,4 @@
 // You should have received a copy of the GNU General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-export * from './RcAccountsBalanceInfoService';
+export * from './accounts';
