fix: partitions refactorings

add Locked partition type, add new parse partitons, use in tests

Author: Victor Wiebe

src/contract_wrappers/tokens/__tests__/security_token_wrapper.test.ts

@@ -41,7 +41,7 @@ import {
   weiToValue,
   stringArrayToBytes32Array,
   bytes32ArrayToStringArray,
-  bigNumberToDate,
+  bigNumberToDate, parsePartitionBytes32Value,
 } from '../../../utils/convert';
 import { MockedCallMethod, MockedSendMethod, getMockedPolyResponse } from '../../../test_utils/mocked_methods';
 
@@ -148,7 +148,7 @@ describe('SecurityTokenWrapper', () => {
 
   describe('partitionsOf', () => {
     test('should call to partitionsOf', async () => {
-      const expectedResult = stringArrayToBytes32Array(['UNDEFINED', 'UNLOCKED']);
+      const expectedResult = stringArrayToBytes32Array(['0', 'UNLOCKED', 'LOCKED']);
       const mockedParams = {
         partition: 'UNLOCKED',
         operator: '0x5555555555555555555555555555555555555555',
@@ -164,7 +164,7 @@ describe('SecurityTokenWrapper', () => {
       // Real call
       const result = await target.partitionsOf(mockedParams);
       // Result expectation
-      expect(result).toEqual(bytes32ArrayToStringArray(expectedResult));
+      expect(result).toEqual(expectedResult.map(parsePartitionBytes32Value));
       // Verifications
       verify(mockedContract.partitionsOf).once();
       verify(mockedMethod.callAsync(mockedParams.tokenHolder)).once();

src/contract_wrappers/tokens/security_token_wrapper.ts

@@ -78,6 +78,7 @@ import {
   bytes32ToString,
   dateToBigNumber,
   numberToBigNumber,
+  parsePartitionBytes32Value,
   stringToBytes32,
   valueArrayToWeiArray,
   valueToWei,
@@ -912,8 +913,8 @@ export default class SecurityTokenWrapper extends ERC20TokenWrapper {
 
   public partitionsOf = async (params: PartitionsOfParams): Promise<Partition[]> => {
     const partitions = await (await this.contract).partitionsOf.callAsync(params.tokenHolder);
-    return bytes32ArrayToStringArray(partitions).map(element => {
-      return element === Partition.Unlocked ? Partition.Unlocked : Partition.Undefined;
+    return partitions.map(element => {
+      return parsePartitionBytes32Value(element);
     });
   };
 
@@ -1610,7 +1611,7 @@ export default class SecurityTokenWrapper extends ERC20TokenWrapper {
     const typedResult: CanTransferByPartitionData = {
       statusCode: result[0],
       reasonCode: bytes32ToString(result[1]),
-      partition: bytes32ToString(result[2]) === Partition.Unlocked ? Partition.Unlocked : Partition.Undefined,
+      partition: parsePartitionBytes32Value(result[2]),
     };
     return typedResult;
   };

src/types.ts

@@ -119,6 +119,7 @@ export enum Feature {
 
 export enum Partition {
   Unlocked = 'UNLOCKED',
+  Locked = 'LOCKED',
   Undefined = 'UNDEFINED',
 }
 

src/utils/convert.ts

@@ -1,5 +1,6 @@
 import { ethers } from 'ethers';
 import { BigNumber } from '@0x/utils';
+import { Partition } from '../types';
 
 const BASE = new BigNumber(10);
 
@@ -81,3 +82,15 @@ export function packVersion(major: string, minor: string, patch: string) {
 export function stringToKeccak256(value: string) {
   return ethers.utils.keccak256(value);
 }
+export function parsePartitionBytes32Value(value: string): Partition {
+  switch (bytes32ToString(value)) {
+    case 'UNLOCKED':
+      return Partition.Unlocked;
+    case 'LOCKED':
+      return Partition.Locked;
+    case '0':
+      return Partition.Undefined;
+    default:
+      throw new Error('Partition not recognized');
+  }
+}