feat: 🎸 Identities:rotatePrimaryKeyToSecondary

Author: sansan

src/api/client/Identities.ts

@@ -14,13 +14,15 @@ import {
   revokeIdentityToCreatePortfolios,
   RevokeIdentityToCreatePortfoliosParams,
   rotatePrimaryKey,
+  rotatePrimaryKeyToSecondary,
 } from '~/internal';
 import {
   AttestPrimaryKeyRotationParams,
   CreateChildIdentityParams,
   ProcedureMethod,
   RegisterIdentityParams,
   RotatePrimaryKeyParams,
+  RotatePrimaryKeyToSecondaryParams,
 } from '~/types';
 import { identityIdToString } from '~/utils/conversion';
 import { asIdentity, assertIdentityExists, createProcedureMethod } from '~/utils/internal';
@@ -52,6 +54,11 @@ export class Identities {
       context
     );
 
+    this.rotatePrimaryKeyToSecondary = createProcedureMethod(
+      { getProcedureAndArgs: args => [rotatePrimaryKeyToSecondary, args] },
+      context
+    );
+
     this.createPortfolio = createProcedureMethod(
       {
         getProcedureAndArgs: args => [
@@ -131,6 +138,22 @@ export class Identities {
    */
   public rotatePrimaryKey: ProcedureMethod<RotatePrimaryKeyParams, AuthorizationRequest>;
 
+  /**
+   * Creates an Authorization to rotate primary key of the signing Identity to an existing secondary key identified by the `targetAccount`
+   *
+   * @note the given `targetAccount` must be an existing secondaryKey or unlinked to any other Identity
+   * @note this creates an {@link api/entities/AuthorizationRequest!AuthorizationRequest | Authorization Requests} which have to be accepted by the `targetAccount` along with the optional CDD authorization generated by CDD provider attesting the rotation of primary key
+   *   An {@link api/entities/Account!Account} or {@link api/entities/Identity!Identity} can fetch its pending Authorization Requests by calling {@link api/entities/common/namespaces/Authorizations!Authorizations.getReceived | authorizations.getReceived}.
+   *   Also, an Account or Identity can directly fetch the details of an Authorization Request by calling {@link api/entities/common/namespaces/Authorizations!Authorizations.getOne | authorizations.getOne}
+   * @throws if the given `targetAccount` is linked with another Identity
+   * @throws if the given `targetAccount` is already the primary key of the signing Identity
+   * @throws if the given `targetAccount` already has a pending invitation to become the primary key of the signing Identity
+   */
+  public rotatePrimaryKeyToSecondary: ProcedureMethod<
+    RotatePrimaryKeyToSecondaryParams,
+    AuthorizationRequest
+  >;
+
   /**
    * Create a new Portfolio under the ownership of the signing Identity
    * @note the `ownerDid` is optional. If provided portfolios will be created as Custody Portfolios under the `ownerDid`

src/api/client/__tests__/Identities.ts

@@ -11,6 +11,7 @@ import {
 } from '~/internal';
 import { dsMockUtils, entityMockUtils, procedureMockUtils } from '~/testUtils/mocks';
 import { Mocked } from '~/testUtils/types';
+import { RotatePrimaryKeyToSecondaryParams } from '~/types';
 import { tuple } from '~/types/utils';
 import * as utilsConversionModule from '~/utils/conversion';
 
@@ -255,6 +256,31 @@ describe('Identities Class', () => {
     });
   });
 
+  describe('method: rotatePrimaryKeyToSecondary', () => {
+    it('should prepare the procedure with the correct arguments and context, and return the resulting transaction', async () => {
+      const args: RotatePrimaryKeyToSecondaryParams = {
+        targetAccount: 'someAccount',
+        expiry: new Date('01/01/2050'),
+        permissions: {
+          assets: null,
+          transactions: null,
+          transactionGroups: [],
+          portfolios: null,
+        },
+      };
+
+      const expectedTransaction = 'someTransaction' as unknown as PolymeshTransaction<void>;
+
+      when(procedureMockUtils.getPrepareMock())
+        .calledWith({ args, transformer: undefined }, context, {})
+        .mockResolvedValue(expectedTransaction);
+
+      const tx = await identities.rotatePrimaryKeyToSecondary(args);
+
+      expect(tx).toBe(expectedTransaction);
+    });
+  });
+
   describe('method: allowIdentityToCreatePortfolios', () => {
     it('should prepare the procedure with the correct arguments and context, and return the resulting transaction', async () => {
       const args = {