feat(express): migrate keychainlocal to typed routes

TICKET: WP-5414

Author: danielzhao122

modules/express/src/clientRoutes.ts

@@ -1617,12 +1617,7 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
   // API v2
 
   // create keychain
-  app.post(
-    '/api/v2/:coin/keychain/local',
-    parseBody,
-    prepareBitGo(config),
-    promiseWrapper(handleV2CreateLocalKeyChain)
-  );
+  router.post('express.keychain.local', [prepareBitGo(config), typedPromiseWrapper(handleV2CreateLocalKeyChain)]);
 
   // generate wallet
   app.post('/api/v2/:coin/wallet/generate', parseBody, prepareBitGo(config), promiseWrapper(handleV2GenerateWallet));

modules/express/src/typedRoutes/api/index.ts

@@ -12,6 +12,7 @@ import { PostAcceptShare } from './v1/acceptShare';
 import { PostSimpleCreate } from './v1/simpleCreate';
 import { PutPendingApproval } from './v1/pendingApproval';
 import { PostSignTransaction } from './v1/signTransaction';
+import { PostKeychainLocal } from './v2/keychainLocal';
 
 export const ExpressApi = apiSpec({
   'express.ping': {
@@ -44,6 +45,9 @@ export const ExpressApi = apiSpec({
   'express.v1.wallet.signTransaction': {
     post: PostSignTransaction,
   },
+  'express.keychain.local': {
+    post: PostKeychainLocal,
+  },
 });
 
 export type ExpressApi = typeof ExpressApi;

modules/express/src/typedRoutes/api/v2/keychainLocal.ts

@@ -0,0 +1,34 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+/**
+ * @property {string} coin - Coin identifier (e.g. btc, tbtc, eth)
+ */
+export const KeychainLocalRequestParams = {
+  coin: t.string,
+};
+
+/**
+ * Local client-side function to create a new keychain.
+ * Creating your keychains is a critical step for safely securing your Bitcoin. When generating new keychains, this API uses a random number generator that adheres to industry standards. If you provide your own seed, you must take extreme caution when creating it.
+ * Returns an object containing the xprv and xpub for the new chain. The created keychain is not known to the BitGo service. To use it with the BitGo service, use the ‘Store Keychain’ API call.
+ *
+ * For security reasons, it is highly recommended that you encrypt and destroy the original xprv immediately to prevent theft.
+ *
+ * @operationId express.keychain.local
+ */
+export const PostKeychainLocal = httpRoute({
+  path: '/api/v2/{coin}/keychain/local',
+  method: 'POST',
+  request: httpRequest({
+    params: KeychainLocalRequestParams,
+  }),
+  response: {
+    200: t.type({
+      prv: t.string,
+      pub: t.string,
+    }),
+    400: BitgoExpressError,
+  },
+});

modules/express/test/unit/typedRoutes/decode.ts

@@ -5,6 +5,7 @@ import { EncryptRequestBody } from '../../../src/typedRoutes/api/common/encrypt'
 import { LoginRequest } from '../../../src/typedRoutes/api/common/login';
 import { VerifyAddressBody } from '../../../src/typedRoutes/api/common/verifyAddress';
 import { SimpleCreateRequestBody } from '../../../src/typedRoutes/api/v1/simpleCreate';
+import { KeychainLocalRequestParams } from '../../../src/typedRoutes/api/v2/keychainLocal';
 
 export function assertDecode<T>(codec: t.Type<T, unknown>, input: unknown): T {
   const result = codec.decode(input);
@@ -100,4 +101,26 @@ describe('io-ts decode tests', function () {
       passphrase: 'pass',
     });
   });
+  it('express.keychain.local', function () {
+    // coin parameter is required
+    assert.throws(() => assertDecode(t.type(KeychainLocalRequestParams), {}));
+    // coin must be a string
+    assert.throws(() =>
+      assertDecode(t.type(KeychainLocalRequestParams), {
+        coin: 123,
+      })
+    );
+    // valid with coin parameter
+    assertDecode(t.type(KeychainLocalRequestParams), {
+      coin: 'btc',
+    });
+    // valid with different coin
+    assertDecode(t.type(KeychainLocalRequestParams), {
+      coin: 'eth',
+    });
+    // valid with testnet coin
+    assertDecode(t.type(KeychainLocalRequestParams), {
+      coin: 'tbtc',
+    });
+  });
 });