SerializeOrders: Extract takerWallet to its own file

Author: inje

src/constants.ts

@@ -3,14 +3,14 @@ import { BigNumber } from 'bignumber.js';
 import { Constants } from './types';
 
 export const constants: Constants = {
-    EXCHANGES: {
-      ZERO_EX: 1,
-      KYBER: 2,
-      TAKER_WALLET: 3,
-    },
-    MAX_DIGITS_IN_UNSIGNED_256_INT: 78,
-    NULL_ADDRESS: '0x0000000000000000000000000000000000000000',
-    ZERO: new BigNumber(0),
-    ZERO_EX_SNAPSHOT_EXCHANGE_ADDRESS: '0x48bacb9266a570d521063ef5dd96e61686dbe788',
+  EXCHANGES: {
+    ZERO_EX: 1,
+    KYBER: 2,
+    TAKER_WALLET: 3,
+  },
+  MAX_DIGITS_IN_UNSIGNED_256_INT: 78,
+  NULL_ADDRESS: '0x0000000000000000000000000000000000000000',
+  ZERO: new BigNumber(0),
+  ZERO_EX_SNAPSHOT_EXCHANGE_ADDRESS: '0x48bacb9266a570d521063ef5dd96e61686dbe788',
   ZERO_EX_SNAPSHOT_ERC20_PROXY_ADDRESS: '0x1dc4c1cefef38a777b15aa20260a54e584b16c48',
 };

src/index.ts

@@ -54,6 +54,8 @@ export class SetProtocolUtils {
     this.web3 = web3 || new Web3();
   }
 
+  /* ============ Static SetProtocolUtils Functions ============ */
+
   /**
    * Converts an array of Buffers into Hex
    * @param   bufferArray   Array of buffers
@@ -183,6 +185,8 @@ export class SetProtocolUtils {
     return parseSignatureHexAsRSV(signature);
   }
 
+  /* ============ Non-Static SetProtocolUtils Functions ============ */
+
   /**
    * Generates a byte string representing serialized exchange orders across different exchanges.
    * @param  makerTokenAddress Address of the token used to pay for the order

src/orders.ts

@@ -22,7 +22,8 @@ import * as _ from 'lodash';
 import * as Web3 from 'web3';
 
 import { constants } from './constants';
-import { paddedBufferForPrimitive, bufferObjectWithProperties } from './encoding';
+import { bufferObjectWithProperties } from './encoding';
+import { generateTakerWalletOrdersBuffer } from './takerWallet';
 import { Address, Bytes32, Exchanges, IssuanceOrder, SolidityTypes, TakerWalletOrder } from './types';
 
 export function generateTimestamp(minutes: number): BigNumber {
@@ -91,67 +92,11 @@ export function generateSerializedOrders(
   });
   // Loop through all exchange orders and create buffers
   _.forEach(exchanges, (exchangeOrders, key) => {
-    const exchangeKey: number = constants.EXCHANGES[key];
-    if (exchangeKey === 1) {
-      // Handle Zero Ex
-    } else if (exchangeKey === 2) {
-      // Handle Kyber Network
-    } else if (exchangeKey === 3) {
+    if (key === 'ZERO_EX') {
+    } else if (key === 'KYBER') {
+    } else if (key === 'TAKER_WALLET') {
       orderBuffer.push(generateTakerWalletOrdersBuffer(makerTokenAddress, exchangeOrders, web3));
     }
   });
   return ethUtil.bufferToHex(Buffer.concat(orderBuffer));
 }
-
-/* ============ Taker Wallet Order Functions ============ */
-
-/**
- * Takes a taker wallet order object and turns it into a buffer.
- *
- * @param  takerTokenAddress Address of the token the taker will fill in the taker wallet order
- * @param  takerTokenAmount  Amount of tokens the taker will fill in the order
- * @param  web3              web3 instance instantiated with `new Web3(provider);`
- * @return                   Taker wallet order as a buffer
- */
-
-export function takerWalletOrderToBuffer(
-  takerTokenAddress: Address,
-  takerTokenAmount: BigNumber,
-  web3: Web3,
-): Buffer {
-  const takerWalletOrder: Buffer[] = [];
-  takerWalletOrder.push(paddedBufferForPrimitive(takerTokenAddress));
-  takerWalletOrder.push(paddedBufferForPrimitive(web3.toHex(takerTokenAmount)));
-  return Buffer.concat(takerWalletOrder);
-}
-
-/**
- * Takes taker wallet orders and generates a buffer representing all orders the
- * taker can fill directly from their wallet.
- *
- * @param  makerTokenAddress Address of the token used to pay for the order
- * @param  orders            Array of TakerWalletOrders
- * @param  web3              web3 instance instantiated with `new Web3(provider);`
- * @return                   Entire taker wallet orders data as a buffer
- */
-
-export function generateTakerWalletOrdersBuffer(
-  makerTokenAddress: Address,
-  orders: TakerWalletOrder[],
-  web3: Web3,
-): Buffer {
-  // Generate header for taker wallet order
-  const takerOrderHeader: Buffer[] = [
-    paddedBufferForPrimitive(constants.EXCHANGES.KYBER),
-    paddedBufferForPrimitive(orders.length), // Include the number of orders as part of header
-    paddedBufferForPrimitive(makerTokenAddress),
-    paddedBufferForPrimitive(0), // Taker wallet orders do not take any maker token to execute
-  ];
-  // Turn all taker wallet orders to buffers
-  const takerOrderBody: Buffer[] = _.map(orders, ({takerTokenAddress, takerTokenAmount}) =>
-    takerWalletOrderToBuffer(takerTokenAddress, takerTokenAmount, web3));
-  return Buffer.concat([
-    Buffer.concat(takerOrderHeader),
-    Buffer.concat(takerOrderBody),
-  ]);
-}

src/takerWallet.ts

@@ -0,0 +1,78 @@
+/*
+  Copyright 2018 Set Labs Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+'use strict';
+
+import { BigNumber } from 'bignumber.js';
+import * as _ from 'lodash';
+import * as Web3 from 'web3';
+
+import { constants } from './constants';
+import { paddedBufferForPrimitive } from './encoding';
+import { Address, TakerWalletOrder } from './types';
+
+/* ============ Taker Wallet Order Functions ============ */
+
+/**
+ * Takes taker wallet orders and generates a buffer representing all orders the
+ * taker can fill directly from their wallet.
+ *
+ * @param  makerTokenAddress Address of the token used to pay for the order
+ * @param  orders            Array of TakerWalletOrders
+ * @param  web3              web3 instance instantiated with `new Web3(provider);`
+ * @return                   Entire taker wallet orders data as a buffer
+ */
+
+export function generateTakerWalletOrdersBuffer(
+  makerTokenAddress: Address,
+  orders: TakerWalletOrder[],
+  web3: Web3,
+): Buffer {
+  // Generate header for taker wallet order
+  const takerOrderHeader: Buffer[] = [
+    paddedBufferForPrimitive(constants.EXCHANGES.KYBER),
+    paddedBufferForPrimitive(orders.length), // Include the number of orders as part of header
+    paddedBufferForPrimitive(makerTokenAddress),
+    paddedBufferForPrimitive(0), // Taker wallet orders do not take any maker token to execute
+  ];
+  // Turn all taker wallet orders to buffers
+  const takerOrderBody: Buffer[] = _.map(orders, ({takerTokenAddress, takerTokenAmount}) =>
+    takerWalletOrderToBuffer(takerTokenAddress, takerTokenAmount, web3));
+  return Buffer.concat([
+    Buffer.concat(takerOrderHeader),
+    Buffer.concat(takerOrderBody),
+  ]);
+}
+
+/**
+ * Takes a taker wallet order object and turns it into a buffer.
+ *
+ * @param  takerTokenAddress Address of the token the taker will fill in the taker wallet order
+ * @param  takerTokenAmount  Amount of tokens the taker will fill in the order
+ * @param  web3              web3 instance instantiated with `new Web3(provider);`
+ * @return                   Taker wallet order as a buffer
+ */
+
+export function takerWalletOrderToBuffer(
+  takerTokenAddress: Address,
+  takerTokenAmount: BigNumber,
+  web3: Web3,
+): Buffer {
+  const takerWalletOrder: Buffer[] = [];
+  takerWalletOrder.push(paddedBufferForPrimitive(takerTokenAddress));
+  takerWalletOrder.push(paddedBufferForPrimitive(web3.toHex(takerTokenAmount)));
+  return Buffer.concat(takerWalletOrder);
+}