PolymeshAssociation · prashantasdeveloper · Dec 4, 2024 · Nov 19, 2024 · Nov 20, 2024 · Nov 20, 2024
diff --git a/.eslintrc b/.eslintrc
@@ -7,6 +7,7 @@
     "es6": true
   },
   "rules": {
+    "no-console": ["error", { "allow": ["warn", "error"] }],
     "no-useless-constructor": "off",
     "no-use-before-define": "off",
     "@typescript-eslint/explicit-function-return-type": ["warn"],

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -2,7 +2,7 @@ name: CI
 
 on:
   push:
-    branches: [master, beta, alpha]
+    branches: [master, beta, alpha, v26-patch]
   pull_request:
     types: [assigned, opened, synchronize, reopened]
 

diff --git a/README.md b/README.md
@@ -10,19 +10,15 @@
 
 ## \@polymeshassociation/polymesh-sdk
 
-<!--- This section is autogenerated, do not modify --->
-
 ## Polymesh version
 
-This release is compatible with Polymesh v6.3 and v7.0
-
-<!--- End of section --->
+This release is compatible with Polymesh v7
 
 ## Getting Started
 
 ### Purpose
 
-The Polymesh SDK's main goal is to provide external developers with a set of tools that will allow them to build powerful applications that interact with the Polymesh protocol. It focuses on abstracting away all the complexities of the Polymesh blockchain and expose a simple but complete interface. The result is a feature-rich, user-friendly node.js library.
+The Polymesh SDK's main goal is to provide external developers with a set of tools that will allow them to build powerful applications that interact with the Polymesh protocol. It focuses on abstracting away all the complexities of the Polymesh blockchain and expose a simple but complete interface. The result is a feature-rich, user-friendly JS library.
 
 ### Technical Pre-requisites
 

diff --git a/release.config.js b/release.config.js
@@ -10,6 +10,10 @@ module.exports = {
       name: 'alpha',
       prerelease: true,
     },
+    {
+      name: 'v26-patch',
+      range: '26.x',
+    },
   ],
   /*
    * In this order the **prepare** step of @semantic-release/npm will run first

diff --git a/sonar-project.properties b/sonar-project.properties
@@ -1,7 +1,7 @@
 sonar.organization=polymeshassociation
 sonar.projectKey=PolymeshAssociation_polymesh-sdk
 sonar.sources=src
-sonar.coverage.exclusions=**/testUtils/**,**/polkadot/**,**/__tests__/**,**/generated/**,src/utils/typeguards.ts,src/types/internal.ts,src/middleware/enums.ts
+sonar.coverage.exclusions=**/testUtils/**,**/polkadot/**,**/__tests__/**,**/generated/**,src/utils/typeguards.ts,src/types/internal.ts,src/middleware/enums.ts,src/middleware/queries/*.ts
 sonar.cpd.exclusions=**/__tests__/**,**/polkadot/**
 sonar.exclusions=**/polkadot/augment-**
 sonar.javascript.environments=node

diff --git a/src/api/client/Claims.ts b/src/api/client/Claims.ts
@@ -255,7 +255,7 @@ export class Claims {
         claims: { nodes },
       },
     } = await context.queryMiddleware<Ensured<Query, 'claims'>>(
-      claimsQuery({
+      claimsQuery(context.isSqIdPadded, {
         dids: targetIssuers,
         ...filters,
       })
@@ -555,7 +555,7 @@ export class Claims {
           claims: { nodes },
         },
       } = await context.queryMiddleware<Ensured<Query, 'claims'>>(
-        claimsQuery({
+        claimsQuery(context.isSqIdPadded, {
           trustedClaimIssuers: claimIssuers,
           ...filters,
         })

diff --git a/src/api/client/Network.ts b/src/api/client/Network.ts
@@ -179,6 +179,7 @@ export class Network {
       },
     } = await context.queryMiddleware<Ensured<Query, 'events'>>(
       eventsByArgs(
+        context.isSqIdPadded,
         {
           moduleId,
           eventId,
@@ -338,6 +339,7 @@ export class Network {
       },
     } = await context.queryMiddleware<Ensured<Query, 'events'>>(
       eventsByArgs(
+        context.isSqIdPadded,
         {
           moduleId,
           eventId,

diff --git a/src/api/client/Polymesh.ts b/src/api/client/Polymesh.ts
@@ -15,6 +15,7 @@ import {
   CreateTransactionBatchProcedureMethod,
   ErrorCode,
   MiddlewareConfig,
+  MiddlewareMetadata,
   PolkadotConfig,
   UnsubCallback,
 } from '~/types';
@@ -194,7 +195,7 @@ export class Polymesh {
     }
 
     if (middlewareV2) {
-      let middlewareMetadata = null;
+      let middlewareMetadata: MiddlewareMetadata | null = null;
 
       const checkMiddleware = async (): Promise<void> => {
         try {
@@ -215,6 +216,8 @@ export class Polymesh {
             message: 'Middleware V2 URL is for a different chain than the given node URL',
           });
         }
+
+        context.isSqIdPadded = middlewareMetadata.paddedIds;
       };
 
       await Promise.all([checkMiddleware(), warnUnexpectedSqVersion(context)]);

diff --git a/src/api/client/__tests__/Claims.ts b/src/api/client/__tests__/Claims.ts
@@ -167,7 +167,7 @@ describe('Claims Class', () => {
       dsMockUtils.configureMocks({ contextOptions: { withSigningManager: true } });
 
       dsMockUtils.createApolloQueryMock(
-        claimsQuery({
+        claimsQuery(false, {
           dids: [targetDid],
           scope: undefined,
           trustedClaimIssuers: [issuerDid],
@@ -211,7 +211,7 @@ describe('Claims Class', () => {
           },
         },
         {
-          query: claimsQuery({
+          query: claimsQuery(false, {
             dids: [targetDid],
             scope: undefined,
             trustedClaimIssuers: undefined,
@@ -304,7 +304,7 @@ describe('Claims Class', () => {
       dsMockUtils.configureMocks({ contextOptions: { withSigningManager: true } });
 
       dsMockUtils.createApolloQueryMock(
-        claimsQuery({
+        claimsQuery(false, {
           dids: [targetDid],
           scope: { type: 'Asset', value: '0x12341234123412341234123412341234' },
           trustedClaimIssuers: [issuerDid],
@@ -801,7 +801,7 @@ describe('Claims Class', () => {
         .mockReturnValue(fakeClaims);
 
       dsMockUtils.createApolloQueryMock(
-        claimsQuery({
+        claimsQuery(false, {
           dids: [did],
           scope,
           trustedClaimIssuers: [issuerDid],
@@ -847,7 +847,7 @@ describe('Claims Class', () => {
           },
         },
         {
-          query: claimsQuery({
+          query: claimsQuery(false, {
             dids: ['someDid'],
             scope: undefined,
             trustedClaimIssuers: [issuerDid],

diff --git a/src/api/client/__tests__/Network.ts b/src/api/client/__tests__/Network.ts
@@ -213,6 +213,7 @@ describe('Network Class', () => {
       dsMockUtils.configureMocks({ contextOptions: { withSigningManager: true } });
       dsMockUtils.createApolloQueryMock(
         eventsByArgs(
+          false,
           {
             ...variables,
             eventArg0: undefined,
@@ -244,6 +245,7 @@ describe('Network Class', () => {
     it('should return null if the query result is empty', async () => {
       dsMockUtils.createApolloQueryMock(
         eventsByArgs(
+          false,
           {
             ...variables,
             eventArg0: 'someDid',
@@ -282,6 +284,7 @@ describe('Network Class', () => {
 
       dsMockUtils.createApolloQueryMock(
         eventsByArgs(
+          false,
           {
             ...variables,
             eventArg0: undefined,
@@ -317,7 +320,7 @@ describe('Network Class', () => {
 
     it('should return null if the query result is empty', async () => {
       dsMockUtils.createApolloQueryMock(
-        eventsByArgs({
+        eventsByArgs(false, {
           ...variables,
           eventArg0: 'someDid',
           eventArg1: undefined,

diff --git a/src/api/client/__tests__/Polymesh.ts b/src/api/client/__tests__/Polymesh.ts
@@ -5,7 +5,6 @@ import { Polymesh } from '~/api/client/Polymesh';
 import { PolymeshError, PolymeshTransactionBatch } from '~/internal';
 import { dsMockUtils, entityMockUtils, procedureMockUtils } from '~/testUtils/mocks';
 import { ErrorCode, TransactionArray } from '~/types';
-import { SUPPORTED_NODE_VERSION_RANGE } from '~/utils/constants';
 import * as internalUtils from '~/utils/internal';
 
 jest.mock(
@@ -44,9 +43,9 @@ jest.mock(
 );
 
 describe('Polymesh Class', () => {
-  let versionSpy: jest.SpyInstance;
+  let assertExpectedChainVersionSpy: jest.SpyInstance;
   beforeEach(() => {
-    versionSpy = jest
+    assertExpectedChainVersionSpy = jest
       .spyOn(internalUtils, 'assertExpectedChainVersion')
       .mockClear()
       .mockImplementation()
@@ -154,10 +153,9 @@ describe('Polymesh Class', () => {
     it('should throw if the Polymesh version does not satisfy the supported version range', async () => {
       const error = new PolymeshError({
         code: ErrorCode.FatalError,
-        message: 'Unsupported Polymesh RPC node version. Please upgrade the SDK',
-        data: { supportedVersionRange: SUPPORTED_NODE_VERSION_RANGE },
+        message: 'Unsupported Polymesh spec version. Please upgrade the SDK',
       });
-      versionSpy.mockImplementation(() => {
+      assertExpectedChainVersionSpy.mockImplementation(() => {
         throw error;
       });
 
@@ -173,7 +171,7 @@ describe('Polymesh Class', () => {
         code: ErrorCode.FatalError,
         message: 'Unable to connect',
       });
-      versionSpy.mockImplementation(() => {
+      assertExpectedChainVersionSpy.mockImplementation(() => {
         throw error;
       });
 
@@ -398,6 +396,7 @@ describe('Polymesh Class', () => {
         },
       });
       const context = dsMockUtils.getContextInstance();
+      context.isSqIdPadded = false;
 
       const expectedTransaction = 'someTransaction' as unknown as PolymeshTransactionBatch<
         [void, void]

diff --git a/src/api/client/types.ts b/src/api/client/types.ts
@@ -44,6 +44,7 @@ export interface MiddlewareMetadata {
   specName: string;
   targetHeight: BigNumber;
   sqVersion: string;
+  paddedIds: boolean;
 }
 
 export interface SubmissionDetails {

diff --git a/src/api/entities/Asset/Base/BaseAsset.ts b/src/api/entities/Asset/Base/BaseAsset.ts
@@ -131,6 +131,8 @@ export class BaseAsset extends Entity<UniqueIdentifiers, string> {
    * Modify some properties of the Asset
    *
    * @throws if the passed values result in no changes being made to the Asset
+   * @throws if the passed assetType is not a known asset type or a custom type that has not been created on the chain
+   * @throws if trying to modify an NftCollection's assetType
    */
   public modify: ProcedureMethod<ModifyAssetParams, Asset>;
 

diff --git a/src/api/entities/Asset/Fungible/index.ts b/src/api/entities/Asset/Fungible/index.ts
@@ -155,7 +155,7 @@ export class FungibleAsset extends BaseAsset {
         tickerExternalAgentHistories: { nodes },
       },
     } = await context.queryMiddleware<Ensured<Query, 'tickerExternalAgentHistories'>>(
-      tickerExternalAgentHistoryQuery({
+      tickerExternalAgentHistoryQuery(context.isSqIdPadded, {
         assetId: middlewareAssetId,
       })
     );
@@ -191,6 +191,7 @@ export class FungibleAsset extends BaseAsset {
       },
     } = await context.queryMiddleware<Ensured<Query, 'assetTransactions'>>(
       assetTransactionQuery(
+        context.isSqIdPadded,
         {
           assetId: middlewareAssetId,
         },

diff --git a/src/api/entities/Asset/NonFungible/NftCollection.ts b/src/api/entities/Asset/NonFungible/NftCollection.ts
@@ -345,6 +345,7 @@ export class NftCollection extends BaseAsset {
       },
     } = await context.queryMiddleware<Ensured<Query, 'assetTransactions'>>(
       assetTransactionQuery(
+        context.isSqIdPadded,
         {
           assetId: id,
         },

diff --git a/src/api/entities/Asset/__tests__/Fungible/index.ts b/src/api/entities/Asset/__tests__/Fungible/index.ts
@@ -742,7 +742,7 @@ describe('Fungible class', () => {
       const datetime = '2020-10-10';
 
       dsMockUtils.createApolloQueryMock(
-        tickerExternalAgentHistoryQuery({
+        tickerExternalAgentHistoryQuery(false, {
           assetId,
         }),
         {
@@ -775,7 +775,7 @@ describe('Fungible class', () => {
       });
 
       dsMockUtils.createApolloQueryMock(
-        tickerExternalAgentHistoryQuery({
+        tickerExternalAgentHistoryQuery(false, {
           assetId,
         }),
         {
@@ -857,7 +857,7 @@ describe('Fungible class', () => {
         .mockReturnValue(assetId);
 
       dsMockUtils.createApolloQueryMock(
-        assetTransactionQuery({ assetId }, new BigNumber(3), new BigNumber(0)),
+        assetTransactionQuery(false, { assetId }, new BigNumber(3), new BigNumber(0)),
         {
           assetTransactions: transactionResponse,
         }

diff --git a/src/api/entities/Asset/__tests__/NonFungible/NftCollection.ts b/src/api/entities/Asset/__tests__/NonFungible/NftCollection.ts
@@ -631,7 +631,7 @@ describe('NftCollection class', () => {
       };
 
       dsMockUtils.createApolloQueryMock(
-        assetTransactionQuery({ assetId }, new BigNumber(3), new BigNumber(0)),
+        assetTransactionQuery(false, { assetId }, new BigNumber(3), new BigNumber(0)),
         {
           assetTransactions: transactionResponse,
         }

diff --git a/src/api/entities/DefaultTrustedClaimIssuer.ts b/src/api/entities/DefaultTrustedClaimIssuer.ts
@@ -66,7 +66,7 @@ export class DefaultTrustedClaimIssuer extends Identity {
         },
       },
     } = await context.queryMiddleware<Ensured<Query, 'trustedClaimIssuers'>>(
-      trustedClaimIssuerQuery({
+      trustedClaimIssuerQuery(context.isSqIdPadded, {
         assetId: middlewareAssetId,
         issuer,
       })

diff --git a/src/api/entities/Identity/AssetPermissions.ts b/src/api/entities/Identity/AssetPermissions.ts
@@ -333,7 +333,7 @@ export class AssetPermissions extends Namespace<Identity> {
         },
       },
     } = await context.queryMiddleware<Ensured<Query, 'tickerExternalAgents'>>(
-      tickerExternalAgentsQuery({
+      tickerExternalAgentsQuery(context.isSqIdPadded, {
         assetId: middlewareAssetId,
       })
     );
@@ -387,6 +387,7 @@ export class AssetPermissions extends Namespace<Identity> {
       },
     } = await context.queryMiddleware<Ensured<Query, 'tickerExternalAgentActions'>>(
       tickerExternalAgentActionsQuery(
+        context.isSqIdPadded,
         {
           assetId: middlewareAssetId,
           callerId: did,

diff --git a/src/api/entities/Identity/Portfolios.ts b/src/api/entities/Identity/Portfolios.ts
@@ -241,15 +241,15 @@ export class Portfolios extends Namespace<Identity> {
     }
 
     const settlementsPromise = context.queryMiddleware<Ensured<Query, 'legs'>>(
-      settlementsForAllPortfoliosQuery({
+      settlementsForAllPortfoliosQuery(context.isSqIdPadded, {
         identityId,
         address: account,
         assetId: middlewareAssetId,
       })
     );
 
     const portfolioMovementsPromise = context.queryMiddleware<Ensured<Query, 'portfolioMovements'>>(
-      portfoliosMovementsQuery({
+      portfoliosMovementsQuery(context.isSqIdPadded, {
         identityId,
         address: account,
         assetId: middlewareAssetId,