refactor: 💡 use polkadot types from polymesh-types

jest.config.js

@@ -8,6 +8,5 @@ module.exports = {
   modulePathIgnorePatterns: ['dist'],
   moduleNameMapper: {
     '~/(.*)': '<rootDir>/src/$1',
-    'polymesh-types/(.*)': '<rootDir>/src/polkadot/$1',
   },
 };

package.json

@@ -31,7 +31,7 @@
     "update-readme": "cross-env node scripts/updateReadme.js",
     "generate:defs": "node --loader @polkadot/dev-ts node_modules/.bin/polkadot-types-from-defs --endpoint metadata.json --package polymesh-types --input ./src/polkadot/",
     "generate:meta": "node --loader @polkadot/dev-ts node_modules/.bin/polkadot-types-from-chain --endpoint metadata.json --package polymesh-types --output ./src/polkadot --strict",
-    "generate:consts": "cross-env node scripts/generateConsts.js",
+    "generate:consts": "ts-node scripts/generateConsts.ts",
     "generate:post-process": "cross-env node scripts/postProcessTypes.js",
     "test": "POLKADOTJS_DISABLE_ESM_CJS_WARNING=1 jest --coverage",
     "test:integration": "./scripts/integration-test.sh",
@@ -45,7 +45,8 @@
     "lint": "eslint src --ext .js,.jsx,.ts,.tsx",
     "format": "cross-env prettier-eslint $PWD\"/src/**/*.{ts,tsx,js,jsx}\" --write",
     "ts-node": "yarn build:ts && ts-node --",
-    "prepare": "is-ci || husky install"
+    "prepare": "is-ci || husky install",
+    "postinstall": "yarn generate:consts"
   },
   "devDependencies": {
     "@babel/core": "^7.22.11",
@@ -58,7 +59,7 @@
     "@polkadot/dev-ts": "^0.79.3",
     "@polkadot/typegen": "11.2.1",
     "@polymeshassociation/local-signing-manager": "^3.0.1",
-    "@polymeshassociation/polymesh-types": "^5.15.0",
+    "@polymeshassociation/polymesh-types": "^6.0.0",
     "@polymeshassociation/signing-manager-types": "^3.0.0",
     "@polymeshassociation/typedoc-theme": "^1.2.0",
     "@semantic-release/changelog": "^6.0.3",

scripts/generateConsts.ts

@@ -0,0 +1,62 @@
+/*
+ * This script generates the following :
+ *   - the `TxTags`, `TxTag` and `ModuleName` consts
+ *   - the `CountryCode` enum and the related conversion utility functions
+ *     (`countryCodeToMeshCountryCode` and `meshCountryCodeToCountryCode`) from the chain metadata.
+ *
+ * NOTE: it is assumed that the metadata has been previously fetched by the `fetchMetadata.js` script, and stored
+ *   in `metadata.json`
+ */
+
+/* eslint-disable */
+import { CountryCode } from '@polymeshassociation/polymesh-types/generated/types';
+import fs from 'fs';
+import path from 'path';
+
+function assembleCountryCodes() {
+  const countryCodes = Object.values(CountryCode);
+
+  let countryCodeFunctions = `/**
+ * @hidden
+ */
+export function countryCodeToMeshCountryCode(countryCode: CountryCode, context: Context): PolymeshPrimitivesJurisdictionCountryCode {
+  return context.createType('PolymeshPrimitivesJurisdictionCountryCode', countryCode);
+}
+
+/**
+ * @hidden
+ */
+export function meshCountryCodeToCountryCode(meshCountryCode: PolymeshPrimitivesJurisdictionCountryCode): CountryCode {`;
+
+  countryCodes.forEach((code, index) => {
+    const isLast = index === countryCodes.length - 1;
+
+    const returnStatement = `return CountryCode.${code}`;
+    if (isLast) {
+      countryCodeFunctions = `${countryCodeFunctions}\n  ${returnStatement};\n}`;
+    } else {
+      countryCodeFunctions = `${countryCodeFunctions}\n  if (meshCountryCode.is${code}) {\n    ${returnStatement};\n  }\n`;
+    }
+  });
+
+  return {
+    countryCodeFunctions,
+  };
+}
+
+const { countryCodeFunctions } = assembleCountryCodes();
+
+const istanbulIgnore = '/* istanbul ignore file */';
+
+const utilsFile = `${istanbulIgnore}
+
+import { PolymeshPrimitivesJurisdictionCountryCode } from '@polkadot/types/lookup';
+import { CountryCode } from '@polymeshassociation/polymesh-types/generated/types';
+
+import { Context } from '~/internal';
+
+${countryCodeFunctions}`;
+
+const generatedDir = path.resolve('src', 'generated');
+
+fs.writeFileSync(path.resolve(generatedDir, 'utils.ts'), utilsFile);

src/api/client/Claims.ts

@@ -1,4 +1,5 @@
 import { Vec } from '@polkadot/types';
+import { IdentityClaim } from '@polymeshassociation/polymesh-types/polkadot/polymesh';
 import BigNumber from 'bignumber.js';
 import { filter, flatten, isEqual, uniqBy, uniqWith } from 'lodash';
 
@@ -15,7 +16,6 @@ import {
   customClaimTypeQuery,
 } from '~/middleware/queries/claims';
 import { ClaimsOrderBy, ClaimTypeEnum, Query } from '~/middleware/types';
-import { IdentityClaim } from '~/polkadot/polymesh';
 import {
   CddClaim,
   ClaimData,
@@ -431,13 +431,7 @@ export class Claims {
     const data: ClaimData<CddClaim>[] = [];
 
     result.forEach(optClaim => {
-      const {
-        claim_issuer: claimIssuer,
-        issuance_date: issuanceDate,
-        last_update_date: lastUpdateDate,
-        expiry: rawExpiry,
-        claim,
-      } = optClaim;
+      const { claimIssuer, issuanceDate, lastUpdateDate, expiry: rawExpiry, claim } = optClaim;
 
       const expiry = !rawExpiry.isEmpty ? momentToDate(rawExpiry.unwrap()) : null;
 

src/api/client/Polymesh.ts

@@ -6,9 +6,9 @@ import {
 } from '@apollo/client/core';
 import { ApiPromise, HttpProvider, WsProvider } from '@polkadot/api';
 import { DefinitionsCall } from '@polkadot/types/types';
+import schema from '@polymeshassociation/polymesh-types/polkadot/schema';
 import { SigningManager } from '@polymeshassociation/signing-manager-types';
 import fetch from 'cross-fetch';
-import schema from 'polymesh-types/schema';
 
 import { Staking } from '~/api/client/Staking';
 import { Account, Context, createTransactionBatch, Identity, PolymeshError } from '~/internal';

src/api/client/__tests__/Claims.ts

@@ -452,17 +452,15 @@ describe('Claims Class', () => {
         id: 'someCddId',
       };
 
-      /* eslint-disable @typescript-eslint/naming-convention */
       const rawIdentityClaim = {
-        claim_issuer: dsMockUtils.createMockIdentityId(claimIssuer),
-        issuance_date: dsMockUtils.createMockMoment(new BigNumber(issuanceDate.getTime())),
-        last_update_date: dsMockUtils.createMockMoment(new BigNumber(lastUpdateDate.getTime())),
+        claimIssuer: dsMockUtils.createMockIdentityId(claimIssuer),
+        issuanceDate: dsMockUtils.createMockMoment(new BigNumber(issuanceDate.getTime())),
+        lastUpdateDate: dsMockUtils.createMockMoment(new BigNumber(lastUpdateDate.getTime())),
         expiry: dsMockUtils.createMockOption(),
         claim: dsMockUtils.createMockClaim({
           CustomerDueDiligence: dsMockUtils.createMockCddId(claim.id),
         }),
       };
-      /* eslint-enable @typescript-eslint/naming-convention */
 
       jest.spyOn(utilsConversionModule, 'identityIdToString').mockReturnValue(claimIssuer);
       dsMockUtils.createCallMock('identityApi', 'validCddClaims', {

src/api/entities/Asset/Base/Settlements/index.ts

@@ -1,5 +1,9 @@
 import { DispatchError } from '@polkadot/types/interfaces/system';
 import { Result, Vec } from '@polkadot/types-codec';
+import {
+  ComplianceReport,
+  TransferCondition,
+} from '@polymeshassociation/polymesh-types/polkadot/polymesh';
 import BigNumber from 'bignumber.js';
 
 import { assertPortfolioExists } from '~/api/procedures/utils';
@@ -11,7 +15,6 @@ import {
   Nft,
   toggleAssetPreApproval,
 } from '~/internal';
-import { ComplianceReport, TransferCondition } from '~/polkadot/polymesh';
 import { NftCollection, NoArgsProcedureMethod, PortfolioLike, TransferBreakdown } from '~/types';
 import { isFungibleAsset } from '~/utils';
 import {

src/api/entities/Asset/Fungible/Checkpoints/__tests__/Schedules.ts

@@ -1,3 +1,4 @@
+import { PolymeshMoment } from '@polymeshassociation/polymesh-types/polkadot/polymesh';
 import BigNumber from 'bignumber.js';
 import { when } from 'jest-when';
 
@@ -9,7 +10,6 @@ import {
   Namespace,
   PolymeshTransaction,
 } from '~/internal';
-import { Moment } from '~/polkadot';
 import { dsMockUtils, entityMockUtils, procedureMockUtils } from '~/testUtils/mocks';
 import { tuple } from '~/types/utils';
 import * as utilsConversionModule from '~/utils/conversion';
@@ -171,7 +171,7 @@ describe('Schedules class', () => {
             [dsMockUtils.createMockAssetId(rawAssetId), rawId],
             dsMockUtils.createMockOption(
               dsMockUtils.createMockCheckpointSchedule({
-                pending: dsMockUtils.createMockBTreeSet<Moment>([
+                pending: dsMockUtils.createMockBtreeSet<PolymeshMoment>([
                   dsMockUtils.createMockMoment(new BigNumber(start.getTime())),
                   dsMockUtils.createMockMoment(new BigNumber(nextCheckpointDate.getTime())),
                 ]),