WIP: add base api-ts types

Author: mohammadalfaiyazbitgo

cert.key

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCf49KqlyCwSPuS
+9g1lgarBY3yVAkeBdHxaoRHbdWSe3gq7OgkUD9bUnJyg8nZzXyYT3Dx+59J6kS4U
+i5eM/JcPMI6LHUWiwQWGg+LoFg+JY5DyRkiMrZrjbKt0N/nn7+MBIMMrZAJ8pWy+
+VmZBQ+LbKlnTQT6jdNh14MnSRc03QSfCjKnFPCuQ6elvuD2FT7syzegO5daZM1Bi
+F+omMSn9vb2wrGt3RxzJDNwIbx5SuBGqyiA0bWuPRYDVO/1caWbD4t17L0dqwwWP
+qLlOFv2xcTmGdB+PRcXM4ec4XgbTD8bcDxqtC4EzMnwnQ63fSrztYSUJ1AeFMEvN
+Afs/HkQVAgMBAAECggEAByEfOmSRPFMQxqmKiOFqhgOD4VgP7K2PQvJGK9E0+qF/
+fIA2ueqH44SVNlcBYZ0XQ1DxcJ4xJC53jcp4qDx2FuMNJBZazcpKDwiv9DXRnQhv
+xOHN59nw212z2nOJhOZNKrZ1hWiI9Npiei07k4LtqWSeyzzwSFUUNtNeZG4g26sN
+v5IDqKyIr+pKIQXGP9k2swqoMLKJeQR6ugjIpRERugJ4EJo92Bt5KmE/B5KcYX8g
+NvpsQAVlaPYit9sIKrupEsgSQW6/Y/Tt1KNagyd9ruabkmVOzC9Is8FRjPSc6WGg
+C31ZYPLDmzFSX1oPfRFkZchNS/NQttn2XreOvc4J+QKBgQDYfaF+6IagYFMAXuyh
+H4VI7VkrRxITcosDo2Q3nfVgvoKrZe2fuoL6VTetDKHQRXysZRoJetjnNt3dbe9g
+WTiZsGbGQIjoI1SS1I3QOGbUjP9VufEpkuRsj1CgnzVg8lQlfqK7SChG3aMrJmYF
++ELtKqm5xUyjY0NJ3SzYLH+mTQKBgQC9EdKYrcfMol3rmcWyHNH0Rlg5WAv9Lwcc
+A5+OA7bSX24M4E1EHj3FNg7Vr/2UIBD0eSo11EO7ACl3u9vX7Lanljh6s+pCOHHy
+9HgsYraivu4zsXParRHhSSEdwDzUkjcBNxsht4d65uaV/33w3XhiqCIXbkMiJv3J
+Q29NInOI6QKBgDMADZ6HCsgXSRZqRlaCxXRzrbD7Ui/QqR0XTdGoXZkH6GKWZY9e
+ceKlVrNmqWwWIpO+UY7wKM73Zvb2IhFRk3rpSpzjsRz2zcK1Xh8yWk8yVCiO4FhJ
+6ZQFgxoDx6BqFharKYzzJ8HiDsFoj1pSrPmQNmG0MCTBiqWI/DqE6SF1AoGAM+oP
+5GJbKSIwHb/0W6q0L5mdIem+KP/fuN550hnM+ki/xANW0+xl05+7RQt02lZPsYEP
+iQZGrrMlr73CaLCTmsKRsYdzPEmZaDeeQ7m7IkbAyyrff9zjuvNEh5HAYjHfrpK9
+/W0SYznBeNBVeWymYJh/++UHw/nm13uPtSNPi/kCgYEAlRS9eEp+Y4Gx8mh/Dg3k
+mmrPvk+Fofxm52+BBmhPMREi3Xu/nc+oGoB2fe+1DLm4rg529ka4GfmjErsYJ1ip
+fg+TBM6j4D+W1pyPmPFTXjL16MGg0zYFcIcuaZBmD1WP1Ojz2uZt5WaPsapuXTi/
+rkA/bbzrGAE65dSaZDx58k0=
+-----END PRIVATE KEY-----

src/api.ts

@@ -209,7 +209,7 @@ function masterExpressEnvConfig(): Partial<MasterExpressConfig> {
     timeout: Number(readEnvVar('BITGO_TIMEOUT')),
     keepAliveTimeout: Number(readEnvVar('BITGO_KEEP_ALIVE_TIMEOUT')),
     headersTimeout: Number(readEnvVar('BITGO_HEADERS_TIMEOUT')),
-    // BitGo API settings
+    // BitGo MasterExpressApi settings
     env: readEnvVar('BITGO_ENV') as EnvironmentName,
     customRootUri: readEnvVar('BITGO_CUSTOM_ROOT_URI'),
     enableSSL: readEnvVar('BITGO_ENABLE_SSL') !== 'false', // Default to true unless explicitly set to false

src/config.ts

@@ -17,7 +17,7 @@ export class EnclavedError extends Error {
 }
 
 /**
- * Error for API responses
+ * Error for MasterExpressApi responses
  */
 export class ApiResponseError extends EnclavedError {
   public result: any;

src/errors.ts

@@ -1,5 +1,4 @@
 import {
-  GenerateWalletOptions,
   promiseProps,
   RequestTracer,
   SupplementGenerateWalletOptions,
@@ -8,42 +7,49 @@ import {
   Wallet,
   WalletWithKeychains,
   AddKeychainOptions,
+  BitGoBase,
+  WalletData,
 } from '@bitgo/sdk-core';
 import { createEnclavedExpressClient } from './enclavedExpressClient';
-import _ from 'lodash';
-import { BitGoRequest } from '../types/request';
+import { BitGo } from 'bitgo';
+
+export type GenerateWalletOnPremParams = {
+  coin: string;
+  label: string;
+  enterprise?: string;
+  multisigType?: string;
+  isDistributedCustody?: boolean;
+};
 
 /**
  * This route is used to generate a multisig wallet when enclaved express is enabled
  */
-export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
-  const bitgo = req.bitgo;
-  const baseCoin = bitgo.coin(req.params.coin);
-
-  const enclavedExpressClient = createEnclavedExpressClient(req.params.coin);
+export async function handleGenerateWalletOnPrem({
+  bitGo,
+  params,
+}: {
+  bitGo: BitGo;
+  params: GenerateWalletOnPremParams;
+}): Promise<WalletWithKeychains> {
+  const baseCoin = bitGo.coin(params.coin);
+
+  const enclavedExpressClient = createEnclavedExpressClient(params.coin);
   if (!enclavedExpressClient) {
     throw new Error(
       'Enclaved express client not configured - enclaved express features will be disabled',
     );
   }
 
-  const params = req.body as GenerateWalletOptions;
   const reqId = new RequestTracer();
 
   // Assign the default multiSig type value based on the coin
   if (!params.multisigType) {
     params.multisigType = baseCoin.getDefaultMultisigType();
   }
 
-  if (typeof params.label !== 'string') {
-    throw new Error('missing required string parameter label');
-  }
-
-  const { label, enterprise } = params;
-
   // Create wallet parameters with type assertion to allow 'onprem' subtype
   const walletParams = {
-    label: label,
+    label: params.label,
     m: 2,
     n: 3,
     keys: [],
@@ -52,17 +58,10 @@ export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
     multisigType: 'onchain',
   } as unknown as SupplementGenerateWalletOptions; // TODO: Add onprem to the SDK subType and remove "unknown" type casting
 
-  if (!_.isUndefined(enterprise)) {
-    if (!_.isString(enterprise)) {
-      throw new Error('invalid enterprise argument, expecting string');
-    }
-    walletParams.enterprise = enterprise;
-  }
-
   const userKeychainPromise = async (): Promise<Keychain> => {
     const userKeychain = await enclavedExpressClient.createIndependentKeychain({
       source: 'user',
-      coin: req.params.coin,
+      coin: params.coin,
       type: 'independent',
     });
     const userKeychainParams: AddKeychainOptions = {
@@ -73,13 +72,13 @@ export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
     };
 
     const newUserKeychain = await baseCoin.keychains().add(userKeychainParams);
-    return _.extend({}, newUserKeychain, userKeychain);
+    return { ...newUserKeychain, ...userKeychain };
   };
 
   const backupKeychainPromise = async (): Promise<Keychain> => {
     const backupKeychain = await enclavedExpressClient.createIndependentKeychain({
       source: 'backup',
-      coin: req.params.coin,
+      coin: params.coin,
       type: 'independent',
     });
     const backupKeychainParams: AddKeychainOptions = {
@@ -90,7 +89,7 @@ export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
     };
 
     const newBackupKeychain = await baseCoin.keychains().add(backupKeychainParams);
-    return _.extend({}, newBackupKeychain, backupKeychain);
+    return { ...newBackupKeychain, ...backupKeychain };
   };
 
   const { userKeychain, backupKeychain, bitgoKeychain }: KeychainsTriplet = await promiseProps({
@@ -113,16 +112,21 @@ export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
 
   const finalWalletParams = await baseCoin.supplementGenerateWallet(walletParams, keychains);
 
-  bitgo.setRequestTracer(reqId);
-  const newWallet = await bitgo.post(baseCoin.url('/wallet/add')).send(finalWalletParams).result();
+  bitGo.setRequestTracer(reqId);
+  const wallet = await baseCoin.wallets().add({
+    ...finalWalletParams,
+    enterprise: params.enterprise,
+    reqId,
+    isDistributedCustody: params.isDistributedCustody,
+  });
 
-  const result: WalletWithKeychains = {
-    wallet: new Wallet(bitgo, baseCoin, newWallet),
+  const result = {
+    wallet: wallet as WalletData,
     userKeychain: userKeychain,
     backupKeychain: backupKeychain,
     bitgoKeychain: bitgoKeychain,
     responseType: 'WalletWithKeychains',
   };
 
-  return { ...result, wallet: result.wallet.toJSON() };
+  return result as unknown as WalletWithKeychains;
 }

src/masterBitgoExpress/generateWallet.ts

@@ -0,0 +1,69 @@
+import * as t from 'io-ts';
+import * as h from '@api-ts/io-ts-http';
+
+export const InternalErrorResponse = t.type({
+  error: t.string,
+  details: t.string,
+});
+
+export const enclavedPingResponse = t.type({
+  status: t.string,
+  timeStamp: t.string,
+});
+export type EnclavedPingResponse = t.TypeOf<typeof enclavedPingResponse>;
+
+export const PingEnclavedExpressRequest = h.httpRoute({
+  path: '/ping/enclavedExpress',
+  method: 'POST',
+  request: h.httpRequest({}),
+  response: {
+    200: t.type({
+      status: t.string,
+      enclavedResponse: enclavedPingResponse,
+    }),
+    500: InternalErrorResponse,
+  },
+});
+
+// TODO: Fill out full response type
+export const WalletGenerateRequest = {
+  label: t.string,
+  enterprise: t.string,
+};
+
+// TODO: Update response type
+export const WalletGenerateResponse = t.type({
+  wallet: t.any,
+  userKeychain: t.any,
+  backupKeychain: t.any,
+  bitgoKeychain: t.any,
+});
+
+export const GenerateWalletRequest = h.httpRoute({
+  path: '/api/{coin}/wallet/generate',
+  method: 'POST',
+  request: h.httpRequest({
+    params: {
+      coin: t.string,
+    },
+    headers: {
+      authorization: t.union([t.string, t.undefined]),
+      'user-agent': t.union([t.string, t.undefined]),
+    },
+    body: WalletGenerateRequest,
+  }),
+  response: {
+    200: WalletGenerateResponse,
+    400: InternalErrorResponse,
+    500: InternalErrorResponse,
+  },
+});
+
+export const MasterExpressApi = h.apiSpec({
+  'api.v1.pingEnclavedExpress': {
+    post: PingEnclavedExpressRequest,
+  },
+  'api.v1.generateWallet': {
+    post: GenerateWalletRequest,
+  },
+});