Merge pull request #6723 from BitGo/WP-5403-express-migrate-api-v-1-wallets-simplecreate-to-typed-routes

feat(express): migrate v1 wallet create to typed routes

Author: kaustubhbitgo

modules/express/src/clientRoutes.ts

@@ -132,7 +132,7 @@ function handleDeriveLocalKeyChain(req: express.Request) {
  * @deprecated
  * @param req
  */
-function handleCreateWalletWithKeychains(req: express.Request) {
+function handleCreateWalletWithKeychains(req: ExpressApiRouteRequest<'express.v1.wallet.simplecreate', 'post'>) {
   return req.bitgo.wallets().createWalletWithKeychains(req.body);
 }
 
@@ -1575,12 +1575,10 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
 
   app.post('/api/v1/keychain/local', parseBody, prepareBitGo(config), promiseWrapper(handleCreateLocalKeyChain));
   app.post('/api/v1/keychain/derive', parseBody, prepareBitGo(config), promiseWrapper(handleDeriveLocalKeyChain));
-  app.post(
-    '/api/v1/wallets/simplecreate',
-    parseBody,
+  router.post('express.v1.wallet.simplecreate', [
     prepareBitGo(config),
-    promiseWrapper(handleCreateWalletWithKeychains)
-  );
+    typedPromiseWrapper(handleCreateWalletWithKeychains),
+  ]);
 
   app.post('/api/v1/wallet/:id/sendcoins', parseBody, prepareBitGo(config), promiseWrapper(handleSendCoins));
   app.post('/api/v1/wallet/:id/sendmany', parseBody, prepareBitGo(config), promiseWrapper(handleSendMany));

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

@@ -8,6 +8,7 @@ import { PostLogin } from './common/login';
 import { PostDecrypt } from './common/decrypt';
 import { PostVerifyAddress } from './common/verifyAddress';
 import { PostAcceptShare } from './common/acceptShare';
+import { PostSimpleCreate } from './v1/simpleCreate';
 
 export const ExpressApi = apiSpec({
   'express.ping': {
@@ -28,6 +29,9 @@ export const ExpressApi = apiSpec({
   'express.v1.wallet.acceptShare': {
     post: PostAcceptShare,
   },
+  'express.v1.wallet.simplecreate': {
+    post: PostSimpleCreate,
+  },
 });
 
 export type ExpressApi = typeof ExpressApi;

modules/express/src/typedRoutes/api/v1/simpleCreate.ts

@@ -0,0 +1,53 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest, optional } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+export const SimpleCreateRequestBody = {
+  /** wallet passphrase to encrypt user and backup keys with */
+  passphrase: t.string,
+  /** wallet label, is shown in BitGo UI */
+  label: optional(t.string),
+  /** backup keychain xpub, it is HIGHLY RECOMMENDED you generate this on a separate machine!
+   * BITGO DOES NOT GUARANTEE SAFETY OF WALLETS WITH MULTIPLE KEYS CREATED ON THE SAME MACHINE */
+  backupXpub: optional(t.string),
+  /* Provision backup key from this provider (KRS), e.g. "keyternal". Setting this value will create an instant-capable wallet. */
+  backupXpubProvider: optional(t.string),
+  enterprise: optional(t.string),
+  /** the code used to encrypt the wallet passcode used in the recovery process */
+  passcodeEncryptionCode: optional(t.string),
+  disableTransactionNotifications: optional(t.boolean),
+  disableKRSEmail: optional(t.boolean),
+};
+
+/**
+ * Create Wallet with Keychain
+ * Create a new 2-of-3 wallet and it's associated keychains.
+ * Returns the locally created keys with their encrypted xprvs.
+ * **WARNING: BE SURE TO BACKUP! NOT DOING SO CAN RESULT IN LOSS OF FUNDS!**
+ *
+ * 1. Creates the user keychain locally on the client, and encrypts it with the provided passphrase
+ * 2. If no xpub was provided, creates the backup keychain locally on the client, and encrypts it with the provided passphrase
+ * 3. Uploads the encrypted user and backup keychains to BitGo
+ * 4. Creates the BitGo key on the service
+ * 5. Creates the wallet on BitGo with the 3 public keys above
+ *
+ * @operationId express.v1.wallet.simplecreate
+ */
+export const PostSimpleCreate = httpRoute({
+  path: '/api/v1/wallets/simplecreate',
+  method: 'POST',
+  request: httpRequest({
+    body: SimpleCreateRequestBody,
+  }),
+  response: {
+    200: t.type({
+      /** newly created wallet model object */
+      wallet: t.string,
+      /** the newly created user keychain, which has an encrypted xprv stored on BitGo */
+      userKeychain: t.string,
+      /** the newly created backup keychain */
+      backupKeychain: t.string,
+    }),
+    400: BitgoExpressError,
+  },
+});

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

@@ -3,6 +3,7 @@ import * as t from 'io-ts';
 import { DecryptRequestBody } from '../../../src/typedRoutes/api/common/decrypt';
 import { LoginRequest } from '../../../src/typedRoutes/api/common/login';
 import { VerifyAddressBody } from '../../../src/typedRoutes/api/common/verifyAddress';
+import { SimpleCreateRequestBody } from '../../../src/typedRoutes/api/v1/simpleCreate';
 
 export function assertDecode<T>(codec: t.Type<T, unknown>, input: unknown): T {
   const result = codec.decode(input);
@@ -50,4 +51,12 @@ describe('io-ts decode tests', function () {
       address: 'some-address',
     });
   });
+  it('express.v1.wallet.simplecreate', function () {
+    // passphrase is required
+    assert.throws(() => assertDecode(t.type(SimpleCreateRequestBody), {}));
+
+    assertDecode(t.type(SimpleCreateRequestBody), {
+      passphrase: 'pass',
+    });
+  });
 });