chore: utils refactor

BREAKING CHANGE:

Reorganize utils
Moved to `utils/internal.ts`:
- batchArguments
- calculateNextKey
- createClaim
- delay
- findEventRecord
- getDid
- padString
- removePadding
- requestAtBlock
- requestPaginated
- serialize
- unserialize
- unwrapValue
- unwrapValues
Moved to `utils/conversion.ts`:
- accdountIdToString
- addressToKey
- assetComplianceResultToRequirementCompliance
- assetIdentifierToTokenIdentifier
- assetNameToString
- assetTypeToString
- authIdentifierToAuthTarget
- authorizationDataToAuthorization
- authorizationToAuthorizationData
- authorizationTypeToMeshAuthorizationType
- authTargetToAuthIdentifier
- balanceToBigNumber
- booleanToBool
- boolToBoolean
- bytesToString
- canTransferResultToTransferStatus
- cddIdToString
- cddStatusToBoolean
- claimToMeshClaim
- complianceRequirementToRequirement
- dateToMoment
- documentHashToString
- documentNameToString
- documentToTokenDocumentData
- documentUriToString
- endConditionToSettlementType
- extrinsicIdentifierToTxTag
- fundingRoundNameToString
- identityIdToString
- isCusipValid
- isIsinValid
- isLeiValid
- keyToAddress
- meshAuthorizationStatusToAuthorizationStatus
- meshClaimToClaim
- meshInstructionStatusToInstructionStatus
- meshPermissionToPermission
- meshScopeToScope
- meshVenueTypeToVenueType
- middlewareScopeToScope
- moduleAddressToString
- momentToDate
- numberToBalance
- numberToPipId
- numberToU32
- numberToU64
- permissionToMeshPermission
- portfolioIdToMeshPortfolioId
- portfolioLikeToPortfolioId
- posRatioToBigNumber
- requirementToComplianceRequirement
- scopeToMeshScope
- scopeToMiddlewareScope
- secondaryKeyToMeshSecondaryKey
- signatoryToSignerValue
- signerToSignerValue
- signerToString
- signerValueToSignatory
- signerValueToSigner
- stringToAccountId
- stringToAssetName
- stringToBytes
- stringToCddId
- stringToDocumentHash
- stringToDocumentName
- stringToDocumentUri
- stringToFundingRoundName
- stringToIdentityId
- stringToMemo
- stringToText
- stringToTicker
- stringToVenueDetails
- textToString
- tickerToDid
- tickerToString
- toIdentityWithClaimsArray
- tokenDocumentDataToDocument
- tokenIdentifierToAssetIdentifier
- tokenTypeToAssetType
- transactionHexToTxTag
- txTagToExtrinsicIdentifier
- txTagToProtocolOp
- u8ToTransferStatus
- u64ToBigNumber
- venueDetailsToString
- venueTypeToMeshVenueType

src/Claims.ts

@@ -18,14 +18,12 @@ import {
 } from '~/types';
 import { ClaimOperation } from '~/types/internal';
 import {
-  calculateNextKey,
-  getDid,
   middlewareScopeToScope,
-  removePadding,
   scopeToMiddlewareScope,
   signerToString,
   toIdentityWithClaimsArray,
-} from '~/utils';
+} from '~/utils/conversion';
+import { calculateNextKey, getDid, removePadding } from '~/utils/internal';
 
 /**
  * Handles all Claims related functionality

src/Polymesh.ts

@@ -35,15 +35,15 @@ import {
   UnsubCallback,
 } from '~/types';
 import {
-  getDid,
   moduleAddressToString,
   signerToString,
   stringToIdentityId,
   stringToTicker,
   textToString,
   tickerToString,
   u32ToBigNumber,
-} from '~/utils';
+} from '~/utils/conversion';
+import { getDid } from '~/utils/internal';
 
 import { Claims } from './Claims';
 // import { Governance } from './Governance';

src/__tests__/Claims.ts

@@ -22,7 +22,7 @@ import {
   ScopeType,
 } from '~/types';
 import { ClaimOperation } from '~/types/internal';
-import * as utilsModule from '~/utils';
+import * as utilsConversionModule from '~/utils/conversion';
 
 describe('Claims Class', () => {
   let context: Mocked<Context>;
@@ -518,7 +518,7 @@ describe('Claims Class', () => {
       dsMockUtils.configureMocks({ contextOptions: { withSeed: true } });
 
       sinon
-        .stub(utilsModule, 'toIdentityWithClaimsArray')
+        .stub(utilsConversionModule, 'toIdentityWithClaimsArray')
         .withArgs(issuerDidsWithClaimsByTargetQueryResponse.items, context)
         .returns(fakeClaims);
 
@@ -622,7 +622,7 @@ describe('Claims Class', () => {
     dsMockUtils.configureMocks({ contextOptions: { withSeed: true } });
 
     sinon
-      .stub(utilsModule, 'toIdentityWithClaimsArray')
+      .stub(utilsConversionModule, 'toIdentityWithClaimsArray')
       .withArgs(issuerDidsWithClaimsByTargetQueryResponse.items, context)
       .returns(fakeClaims);
 

src/__tests__/Polymesh.ts

@@ -14,7 +14,7 @@ import { Polymesh } from '~/Polymesh';
 import { dsMockUtils, entityMockUtils } from '~/testUtils/mocks';
 import { AccountBalance, SubCallback, TickerReservationStatus } from '~/types';
 import { tuple } from '~/types/utils';
-import * as utilsModule from '~/utils';
+import * as utilsConversionModule from '~/utils/conversion';
 
 jest.mock(
   '@polkadot/api',
@@ -443,7 +443,7 @@ describe('Polymesh Class', () => {
 
   describe('method: getTickerReservations', () => {
     beforeAll(() => {
-      sinon.stub(utilsModule, 'signerValueToSignatory');
+      sinon.stub(utilsConversionModule, 'signerValueToSignatory');
     });
 
     afterAll(() => {
@@ -664,7 +664,7 @@ describe('Polymesh Class', () => {
 
   describe('method: getSecurityTokens', () => {
     beforeAll(() => {
-      sinon.stub(utilsModule, 'signerValueToSignatory');
+      sinon.stub(utilsConversionModule, 'signerValueToSignatory');
     });
 
     afterAll(() => {

src/api/entities/Account.ts

@@ -16,12 +16,12 @@ import {
 } from '~/types';
 import {
   addressToKey,
-  calculateNextKey,
   extrinsicIdentifierToTxTag,
   identityIdToString,
   stringToAccountId,
   txTagToExtrinsicIdentifier,
-} from '~/utils';
+} from '~/utils/conversion';
+import { calculateNextKey } from '~/utils/internal';
 
 export interface UniqueIdentifiers {
   address: string;

src/api/entities/CurrentIdentity.ts

@@ -14,8 +14,8 @@ import {
 import { TransactionQueue } from '~/base';
 import { SecondaryKey, Signer, SubCallback, UnsubCallback } from '~/types';
 import { PortfolioId } from '~/types/internal';
-import { portfolioIdToMeshPortfolioId, u64ToBigNumber } from '~/utils';
 import { MAX_CONCURRENT_REQUESTS } from '~/utils/constants';
+import { portfolioIdToMeshPortfolioId, u64ToBigNumber } from '~/utils/conversion';
 
 /**
  * Represents the Identity associated to the current [[Account]]

src/api/entities/Entity.ts

@@ -1,6 +1,6 @@
 import { Context, PolymeshError } from '~/base';
 import { ErrorCode } from '~/types';
-import { serialize, unserialize } from '~/utils';
+import { serialize, unserialize } from '~/utils/internal';
 
 /**
  * Represents an object or resource in the Polymesh Ecosystem with its own set of properties and functionality

src/api/entities/Identity/IdentityAuthorizations.ts

@@ -4,7 +4,8 @@ import { Authorization } from 'polymesh-types/types';
 import { AuthorizationRequest, Identity } from '~/api/entities';
 import { PaginationOptions, ResultSet } from '~/types';
 import { tuple } from '~/types/utils';
-import { requestPaginated, signatoryToSignerValue, stringToIdentityId } from '~/utils';
+import { signatoryToSignerValue, stringToIdentityId } from '~/utils/conversion';
+import { requestPaginated } from '~/utils/internal';
 
 import { Authorizations } from '../common/namespaces/Authorizations';
 

src/api/entities/Identity/Portfolios.ts

@@ -6,7 +6,12 @@ import { createPortfolio, deletePortfolio } from '~/api/procedures';
 import { PolymeshError, TransactionQueue } from '~/base';
 import { PortfolioNumber } from '~/polkadot';
 import { ErrorCode } from '~/types';
-import { identityIdToString, numberToU64, stringToIdentityId, u64ToBigNumber } from '~/utils';
+import {
+  identityIdToString,
+  numberToU64,
+  stringToIdentityId,
+  u64ToBigNumber,
+} from '~/utils/conversion';
 
 /**
  * Handles all Portfolio related functionality on the Identity side

src/api/entities/Identity/__tests__/IdentityAuthorizations.ts

@@ -6,7 +6,8 @@ import { AuthorizationRequest, Identity, Namespace } from '~/api/entities';
 import { dsMockUtils, entityMockUtils } from '~/testUtils/mocks';
 import { AuthorizationType } from '~/types';
 import { tuple } from '~/types/utils';
-import * as utilsModule from '~/utils';
+import * as utilsConversionModule from '~/utils/conversion';
+import * as utilsInternalModule from '~/utils/internal';
 
 import { IdentityAuthorizations } from '../IdentityAuthorizations';
 
@@ -41,10 +42,10 @@ describe('IdentityAuthorizations class', () => {
     });
 
     test('should retrieve all pending authorizations sent by the Identity', async () => {
-      sinon.stub(utilsModule, 'signerValueToSignatory');
+      sinon.stub(utilsConversionModule, 'signerValueToSignatory');
       dsMockUtils.createQueryStub('identity', 'authorizationsGiven');
 
-      const requestPaginatedStub = sinon.stub(utilsModule, 'requestPaginated');
+      const requestPaginatedStub = sinon.stub(utilsInternalModule, 'requestPaginated');
 
       const did = 'someDid';
 

src/api/entities/Identity/__tests__/Portfolios.ts

@@ -9,7 +9,7 @@ import { Context, TransactionQueue } from '~/base';
 import { dsMockUtils, entityMockUtils } from '~/testUtils/mocks';
 import { Mocked } from '~/testUtils/types';
 import { tuple } from '~/types/utils';
-import * as utilsModule from '~/utils';
+import * as utilsConversionModule from '~/utils/conversion';
 
 import { Portfolios } from '../Portfolios';
 
@@ -28,9 +28,9 @@ describe('Portfolios class', () => {
   beforeAll(() => {
     dsMockUtils.initMocks();
     entityMockUtils.initMocks();
-    stringToIdentityIdStub = sinon.stub(utilsModule, 'stringToIdentityId');
-    u64ToBigNumberStub = sinon.stub(utilsModule, 'u64ToBigNumber');
-    numberToU64Stub = sinon.stub(utilsModule, 'numberToU64');
+    stringToIdentityIdStub = sinon.stub(utilsConversionModule, 'stringToIdentityId');
+    u64ToBigNumberStub = sinon.stub(utilsConversionModule, 'u64ToBigNumber');
+    numberToU64Stub = sinon.stub(utilsConversionModule, 'numberToU64');
   });
 
   beforeEach(() => {

src/api/entities/Identity/__tests__/index.ts

@@ -9,7 +9,7 @@ import { Context } from '~/base';
 import { tokensByTrustedClaimIssuer, tokensHeldByDid } from '~/middleware/queries';
 import { dsMockUtils, entityMockUtils } from '~/testUtils/mocks';
 import { Order, Role, RoleType, TickerOwnerRole, TokenOwnerRole, VenueOwnerRole } from '~/types';
-import * as utilsModule from '~/utils';
+import * as utilsConversionModule from '~/utils/conversion';
 
 jest.mock(
   '~/api/entities/TickerReservation',
@@ -33,8 +33,8 @@ describe('Identity class', () => {
 
   beforeAll(() => {
     dsMockUtils.initMocks();
-    stringToIdentityIdStub = sinon.stub(utilsModule, 'stringToIdentityId');
-    identityIdToStringStub = sinon.stub(utilsModule, 'identityIdToString');
+    stringToIdentityIdStub = sinon.stub(utilsConversionModule, 'stringToIdentityId');
+    identityIdToStringStub = sinon.stub(utilsConversionModule, 'identityIdToString');
   });
 
   beforeEach(() => {
@@ -224,12 +224,12 @@ describe('Identity class', () => {
       identity = new Identity({ did }, mockContext);
 
       sinon
-        .stub(utilsModule, 'stringToTicker')
+        .stub(utilsConversionModule, 'stringToTicker')
         .withArgs(ticker, mockContext)
         .returns(rawTicker);
 
       sinon
-        .stub(utilsModule, 'balanceToBigNumber')
+        .stub(utilsConversionModule, 'balanceToBigNumber')
         .withArgs(fakeBalance)
         .returns(fakeValue);
     });
@@ -305,7 +305,7 @@ describe('Identity class', () => {
         .resolves(fakeHasValidCdd);
 
       sinon
-        .stub(utilsModule, 'cddStatusToBoolean')
+        .stub(utilsConversionModule, 'cddStatusToBoolean')
         .withArgs(fakeHasValidCdd)
         .returns(statusResponse);
 
@@ -363,7 +363,7 @@ describe('Identity class', () => {
     let rawDidRecord: DidRecord;
 
     beforeAll(() => {
-      accountIdToStringStub = sinon.stub(utilsModule, 'accountIdToString');
+      accountIdToStringStub = sinon.stub(utilsConversionModule, 'accountIdToString');
       accountIdToStringStub.returns(accountId);
     });
 

src/api/entities/Identity/index.ts

@@ -22,14 +22,13 @@ import {
 import {
   accountIdToString,
   balanceToBigNumber,
-  calculateNextKey,
   cddStatusToBoolean,
   identityIdToString,
-  removePadding,
   stringToIdentityId,
   stringToTicker,
   u64ToBigNumber,
-} from '~/utils';
+} from '~/utils/conversion';
+import { calculateNextKey, removePadding } from '~/utils/internal';
 
 import { IdentityAuthorizations } from './IdentityAuthorizations';
 import { Portfolios } from './Portfolios';

src/api/entities/Instruction/__tests__/index.ts

@@ -14,7 +14,7 @@ import { Mocked } from '~/testUtils/types';
 import { AuthorizationStatus, InstructionStatus, InstructionType } from '~/types';
 import { InstructionAuthorizationOperation } from '~/types/internal';
 import { tuple } from '~/types/utils';
-import * as utilsModule from '~/utils';
+import * as utilsConversionModule from '~/utils/conversion';
 
 jest.mock(
   '~/api/entities/Identity',
@@ -83,7 +83,7 @@ describe('Instruction class', () => {
 
       entityMockUtils.configureMocks({ identityOptions: { did: owner } });
       sinon
-        .stub(utilsModule, 'numberToU64')
+        .stub(utilsConversionModule, 'numberToU64')
         .withArgs(id, context)
         .returns(rawId);
 
@@ -167,8 +167,10 @@ describe('Instruction class', () => {
       dsMockUtils.createQueryStub('settlement', 'authsReceived', {
         entries: [authsReceivedEntries[0]],
       });
-      sinon.stub(utilsModule, 'identityIdToString').returns(did);
-      sinon.stub(utilsModule, 'meshAuthorizationStatusToAuthorizationStatus').returns(status);
+      sinon.stub(utilsConversionModule, 'identityIdToString').returns(did);
+      sinon
+        .stub(utilsConversionModule, 'meshAuthorizationStatusToAuthorizationStatus')
+        .returns(status);
     });
 
     test('should return a list of Authorization Statuses', async () => {
@@ -194,7 +196,7 @@ describe('Instruction class', () => {
 
       entityMockUtils.configureMocks({ securityTokenOptions: { ticker } });
       sinon
-        .stub(utilsModule, 'numberToU64')
+        .stub(utilsConversionModule, 'numberToU64')
         .withArgs(id, context)
         .returns(rawId);
       dsMockUtils.createQueryStub('settlement', 'instructionLegs', {

src/api/entities/Instruction/index.ts

@@ -16,7 +16,7 @@ import {
   tickerToString,
   u32ToBigNumber,
   u64ToBigNumber,
-} from '~/utils';
+} from '~/utils/conversion';
 
 import { InstructionAuthorization, InstructionDetails, InstructionType, Leg } from './types';
 

src/api/entities/NumberedPortfolio.ts

@@ -6,7 +6,7 @@ import { Context, TransactionQueue } from '~/base';
 import { eventByIndexedArgs } from '~/middleware/queries';
 import { EventIdEnum, ModuleIdEnum, Query } from '~/middleware/types';
 import { Ensured, EventIdentifier } from '~/types';
-import { bytesToString, numberToU64 } from '~/utils';
+import { bytesToString, numberToU64 } from '~/utils/conversion';
 
 export interface UniqueIdentifiers {
   did: string;

src/api/entities/Portfolio/__tests__/index.ts

@@ -7,7 +7,7 @@ import { Entity, Identity, Portfolio, SecurityToken } from '~/api/entities';
 import { Context } from '~/base';
 import { dsMockUtils } from '~/testUtils/mocks';
 import { tuple } from '~/types/utils';
-import * as utilsModule from '~/utils';
+import * as utilsConversionModule from '~/utils/conversion';
 
 describe('Portfolio class', () => {
   let context: Context;
@@ -113,7 +113,7 @@ describe('Portfolio class', () => {
           User: dsMockUtils.createMockU64(id.toNumber()),
         }),
       });
-      sinon.stub(utilsModule, 'portfolioIdToMeshPortfolioId');
+      sinon.stub(utilsConversionModule, 'portfolioIdToMeshPortfolioId');
       dsMockUtils.configureMocks({ contextOptions: { did } });
     });
 
@@ -174,7 +174,7 @@ describe('Portfolio class', () => {
     beforeAll(() => {
       did = 'someDid';
       id = new BigNumber(1);
-      sinon.stub(utilsModule, 'portfolioIdToMeshPortfolioId');
+      sinon.stub(utilsConversionModule, 'portfolioIdToMeshPortfolioId');
     });
 
     afterAll(() => {
@@ -183,7 +183,7 @@ describe('Portfolio class', () => {
 
     test('should return the custodian of the portfolio', async () => {
       const custodianDid = 'custodianDid';
-      const identityIdToStringStub = sinon.stub(utilsModule, 'identityIdToString');
+      const identityIdToStringStub = sinon.stub(utilsConversionModule, 'identityIdToString');
 
       dsMockUtils
         .createQueryStub('portfolio', 'portfolioCustodian')

src/api/entities/Portfolio/index.ts

@@ -6,11 +6,11 @@ import { Entity, Identity, SecurityToken } from '~/api/entities';
 import { Context } from '~/base';
 import {
   balanceToBigNumber,
-  getDid,
   identityIdToString,
   portfolioIdToMeshPortfolioId,
   tickerToString,
-} from '~/utils';
+} from '~/utils/conversion';
+import { getDid } from '~/utils/internal';
 
 import { PortfolioBalance } from './types';
 

src/api/entities/SecurityToken/Compliance/Requirements.ts

@@ -18,7 +18,7 @@ import {
   signerToString,
   stringToIdentityId,
   stringToTicker,
-} from '~/utils';
+} from '~/utils/conversion';
 
 /**
  * Handles all Security Token Compliance Requirements related functionality

src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts

@@ -8,7 +8,7 @@ import {
 import { TransactionQueue } from '~/base';
 import { SubCallback, UnsubCallback } from '~/types';
 import { TrustedClaimIssuerOperation } from '~/types/internal';
-import { identityIdToString, stringToTicker } from '~/utils';
+import { identityIdToString, stringToTicker } from '~/utils/conversion';
 
 /**
  * Handles all Security Token Default Trusted Claim Issuers related functionality