feat: 🎸 allow for exempted identities to be removed

when a user does not pass exempted identities that are exempt when
calling setTransferRestrictions the procedure will unset those
permissions

BREAKING CHANGE: 🧨 non passed exempted identities are removed when calling
setTransferRestriction

src/api/entities/Asset/TransferRestrictions/ClaimCount.ts

@@ -36,6 +36,9 @@ export class ClaimCount extends TransferRestrictionBase<TransferRestrictionType.
   /**
    * Sets all Claim Count Transfer Restrictions on this Asset
    *
+   * @note this method set exempted Identities for restrictions as well. If an Identity is currently exempted from a Claim Count Transfer Restriction
+   * but not passed into this call then they will be removed
+   *
    * @note the result is the total amount of restrictions after the procedure has run
    */
   public declare setRestrictions: ProcedureMethod<

src/api/entities/Asset/TransferRestrictions/ClaimPercentage.ts

@@ -36,6 +36,9 @@ export class ClaimPercentage extends TransferRestrictionBase<TransferRestriction
   /**
    * Sets all Claim Percentage Transfer Restrictions on this Asset
    *
+   * @note this method set exempted Identities for restrictions as well. If an Identity is currently exempted from a Claim Percentage Transfer Restriction
+   * but not passed into this call then they will be removed
+   *
    * @note the result is the total amount of restrictions after the procedure has run
    */
   public declare setRestrictions: ProcedureMethod<

src/api/entities/Asset/TransferRestrictions/Count.ts

@@ -43,6 +43,9 @@ export class Count extends TransferRestrictionBase<TransferRestrictionType.Count
   /**
    * Sets all Count Transfer Restrictions on this Asset
    *
+   * @note this method set exempted Identities for restrictions as well. If an Identity is currently exempted from a Count Transfer Restriction
+   * but not passed into this call then they will be removed
+   *
    * @note the result is the total amount of restrictions after the procedure has run
    */
   public declare setRestrictions: ProcedureMethod<

src/api/entities/Asset/TransferRestrictions/Percentage.ts

@@ -33,6 +33,9 @@ export class Percentage extends TransferRestrictionBase<TransferRestrictionType.
   /**
    * Sets all Percentage Transfer Restrictions on this Asset
    *
+   * @note this method set exempted Identities for restrictions as well. If an Identity is currently exempted from a Percentage Transfer Restriction
+   * but not passed into this call then they will be removed
+   *
    * @note the result is the total amount of restrictions after the procedure has run
    */
   public declare setRestrictions: ProcedureMethod<

src/api/procedures/__tests__/addTransferRestriction.ts

@@ -82,10 +82,6 @@ describe('addTransferRestriction procedure', () => {
   let setExemptedEntitiesTransaction: PolymeshTx<
     [PolymeshPrimitivesTicker, PolymeshPrimitivesTransferComplianceTransferCondition, ScopeId[]]
   >;
-  let scopeIdsToBtreeSetIdentityIdStub: sinon.SinonStub<
-    [PolymeshPrimitivesIdentityId[], Context],
-    BTreeSet<PolymeshPrimitivesIdentityId>
-  >;
   let statisticsOpTypeToStatOpTypeStub: sinon.SinonStub<
     [StatisticsOpType, Context],
     PolymeshPrimitivesStatisticsStatOpType
@@ -145,10 +141,6 @@ describe('addTransferRestriction procedure', () => {
       'transferRestrictionToPolymeshTransferCondition'
     );
     stringToTickerKeyStub = sinon.stub(utilsConversionModule, 'stringToTickerKey');
-    scopeIdsToBtreeSetIdentityIdStub = sinon.stub(
-      utilsConversionModule,
-      'scopeIdsToBtreeSetIdentityId'
-    );
     transferConditionsToBtreeTransferConditionsStub = sinon.stub(
       utilsConversionModule,
       'transferConditionsToBtreeTransferConditions'
@@ -381,7 +373,10 @@ describe('addTransferRestriction procedure', () => {
     const rawIdentityBtree = dsMockUtils.createMockBTreeSet<PolymeshPrimitivesIdentityId>([
       rawIdentityScopeId,
     ]);
-    scopeIdsToBtreeSetIdentityIdStub.returns(rawIdentityBtree);
+
+    mockContext.createType
+      .withArgs('BTreeSet<PolymeshPrimitivesIdentityId>', [undefined])
+      .returns(rawIdentityBtree);
 
     entityMockUtils.configureMocks({
       identityOptions: { getScopeId: identityScopeId },
@@ -407,7 +402,11 @@ describe('addTransferRestriction procedure', () => {
         {
           transaction: setExemptedEntitiesTransaction,
           feeMultiplier: new BigNumber(1),
-          args: [true, { asset: { Ticker: rawTicker }, op: rawCountOp }, rawIdentityBtree],
+          args: [
+            true,
+            { asset: { Ticker: rawTicker }, op: undefined, claimType: undefined },
+            rawIdentityBtree,
+          ],
         },
       ],
     });
@@ -434,7 +433,11 @@ describe('addTransferRestriction procedure', () => {
         {
           transaction: setExemptedEntitiesTransaction,
           feeMultiplier: new BigNumber(1),
-          args: [true, { asset: { Ticker: rawTicker }, op: rawBalanceOp }, rawIdentityBtree],
+          args: [
+            true,
+            { asset: { Ticker: rawTicker }, op: undefined, claimType: undefined },
+            rawIdentityBtree,
+          ],
         },
       ],
     });
@@ -519,7 +522,7 @@ describe('addTransferRestriction procedure', () => {
     );
   });
 
-  it('should throw an error if exempted entities are repeated', async () => {
+  it('should throw an error if exempted entities are repeated', () => {
     args = {
       type: TransferRestrictionType.Count,
       exemptedIdentities: ['someScopeId', 'someScopeId'],
@@ -530,16 +533,14 @@ describe('addTransferRestriction procedure', () => {
       mockContext
     );
 
-    let err;
-
-    try {
-      await prepareAddTransferRestriction.call(proc, args);
-    } catch (error) {
-      err = error;
-    }
+    const expectedError = new PolymeshError({
+      code: ErrorCode.ValidationError,
+      message:
+        'One or more of the passed exempted Identities are repeated or have the same Scope ID',
+    });
 
-    expect(err.message).toBe(
-      'One or more of the passed exempted Identities are repeated or have the same Scope ID'
+    return expect(prepareAddTransferRestriction.call(proc, args)).rejects.toThrowError(
+      expectedError
     );
   });