feat: add token enablement support in express

joeybaibg · joeybaibg · commit 4bd5f9ef2388 · 2022-10-20T16:40:30.000-07:00
adds token enablement support in express. also adds examples for enabling tokens for SOL. Ticket: BG-60201
diff --git a/modules/bitgo/example/js/sol/enableTokens.js b/modules/bitgo/example/js/sol/enableTokens.js
@@ -0,0 +1,43 @@
+/**
+ * Enables tokens for a Solana wallet.
+ *
+ * This will create associated token addresses that belong to your wallet's root address.
+ *
+ * Copyright 2022, BitGo, Inc.  All Rights Reserved.
+ */
+const BitGo = require('bitgo');
+const bitgo = new BitGo.BitGo({
+  env: 'custom',
+  customRootURI: '',
+});
+
+// TODO: set your access token here
+// You can get this from User Settings > Developer Options > Add Access Token
+const accessToken = '';
+
+// TODO: set the id of your wallet
+const walletId = '';
+
+// TODO: set your passphrase for your new wallet here
+const passphrase = 'test_wallet_passphrase';
+
+const coin = 'tsol';
+
+// Enable tokens for your root wallet
+async function main() {
+  bitgo.authenticateWithAccessToken({ accessToken });
+  const wallet = await bitgo.coin(coin).wallets().get({ id: walletId });
+
+  const enableTokens = await wallet.sendTokenEnablements({
+    enableTokens: [
+      // TODO: provide name of tokens you want to enable
+      { name: 'tsol:usdc' },
+      { name: 'tsol:usdt' },
+    ],
+    walletPassphrase: passphrase,
+  });
+
+  console.log(JSON.stringify(enableTokens, undefined, 2));
+}
+
+main().catch((e) => console.error(e));
diff --git a/modules/bitgo/example/js/sol/enableTokensForAddress.js b/modules/bitgo/example/js/sol/enableTokensForAddress.js
@@ -0,0 +1,46 @@
+/**
+ * Enables tokens for a Solana wallet.
+ *
+ * This will create associated token addresses that belong to one of your wallet's receive addresses.
+ *
+ * Copyright 2022, BitGo, Inc.  All Rights Reserved.
+ */
+const BitGo = require('bitgo');
+const bitgo = new BitGo.BitGo({
+  env: 'custom',
+  customRootURI: '',
+});
+
+// TODO: set your access token here
+// You can get this from User Settings > Developer Options > Add Access Token
+const accessToken = '';
+
+// TODO: set the id of your wallet
+const walletId = '';
+
+// TODO: set the receive address (actual address, not the id) to enable tokens for
+const receiveAddress = '';
+
+// TODO: set your passphrase for your new wallet here
+const passphrase = 'test_wallet_passphrase';
+
+const coin = 'tsol';
+
+// Enable tokens for a receive address
+async function main() {
+  bitgo.authenticateWithAccessToken({ accessToken });
+  const wallet = await bitgo.coin(coin).wallets().get({ id: walletId });
+
+  const enableTokens = await wallet.sendTokenEnablements({
+    enableTokens: [
+      // TODO: provide name of tokens you want to enable
+      { name: 'tsol:usdc', address: receiveAddress },
+      { name: 'tsol:usdt', address: receiveAddress },
+    ],
+    walletPassphrase: passphrase,
+  });
+
+  console.log(JSON.stringify(enableTokens, undefined, 2));
+}
+
+main().catch((e) => console.error(e));
diff --git a/modules/express/src/clientRoutes.ts b/modules/express/src/clientRoutes.ts
@@ -762,6 +762,24 @@ export async function handleV2PrebuildAndSignTransaction(req: express.Request):
   return result;
 }
 
+/**
+ * Enables tokens on a wallet
+ * @param req
+ */
+export async function handleV2EnableTokens(req: express.Request) {
+  const bitgo = req.bitgo;
+  const coin = bitgo.coin(req.params.coin);
+  const reqId = new RequestTracer();
+  const wallet = await coin.wallets().get({ id: req.params.id, reqId });
+  req.body.reqId = reqId;
+  try {
+    return wallet.sendTokenEnablements(createSendParams(req));
+  } catch (err) {
+    err.status = 400;
+    throw err;
+  }
+}
+
 /**
  * handle any other API call
  * @param req
@@ -1121,6 +1139,14 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
     promiseWrapper(handleV2PrebuildAndSignTransaction)
   );
 
+  // token enablement
+  app.post(
+    '/api/v2/:coin/wallet/:id/enableTokens',
+    parseBody,
+    prepareBitGo(config),
+    promiseWrapper(handleV2EnableTokens)
+  );
+
   // unspent changes
   app.post(
     '/api/v2/:coin/wallet/:id/consolidateunspents',
diff --git a/modules/express/test/unit/clientRoutes/enableTokens.ts b/modules/express/test/unit/clientRoutes/enableTokens.ts
@@ -0,0 +1,37 @@
+import * as sinon from 'sinon';
+
+import 'should-http';
+import 'should-sinon';
+import '../../lib/asserts';
+
+import * as express from 'express';
+
+import { handleV2EnableTokens } from '../../../src/clientRoutes';
+
+import { BitGo } from 'bitgo';
+
+describe('Enable tokens', () => {
+  it('should enable tokens', async () => {
+    const walletStub = { sendTokenEnablements: async () => Promise.resolve('success') };
+    const coinStub = {
+      wallets: () => ({ get: () => Promise.resolve(walletStub) }),
+    };
+    const stubBitgo = sinon.createStubInstance(BitGo as any, { coin: coinStub });
+
+    const mockRequest = {
+      bitgo: stubBitgo,
+      params: {
+        coin: 'tbtc',
+        id: '23423423423423',
+      },
+      body: {
+        enableTokens: [
+          { name: 'tsol:usdc' },
+          { name: 'tsol:usdt' },
+        ],
+      },
+    } as unknown as express.Request;
+
+    await handleV2EnableTokens(mockRequest).should.be.resolvedWith('success');
+  });
+});
