feat: 🎸 Add Claim typeguards (#668)

* feat: 🎸 Add Claim typeguards Add typeguard functions to cast Claims into specific types BREAKING CHANGE: 🧨 isSingleClaimCondition and isMultiClaimCondition moved from `src/types/index.ts` to `src/utils/typeguards.ts` BREAKING CHANGE: 🧨 Moved isPortfolioCustodianRole, isVenueOwnerRole, isCddProviderRole, isTickerOwnerRole, isIdentityRole from `src/types/index.ts` to `src/utils/typeguards.ts` BREAKING CHANGE: 🧨 InvestorUniqueness, InvestorUniqunessV2, CddClaim converted from type to interface
PolymeshAssociation · Feb 3, 2022 · dd86024 · dd86024
1 parent ac96bc1
commit dd86024
Show file tree

Hide file tree

Showing 7 changed files with 254 additions and 113 deletions.
diff --git a/src/api/entities/Identity/index.ts b/src/api/entities/Identity/index.ts
@@ -22,11 +22,6 @@ import {
   DistributionWithDetails,
   ErrorCode,
   GroupedInstructions,
-  isCddProviderRole,
-  isIdentityRole,
-  isPortfolioCustodianRole,
-  isTickerOwnerRole,
-  isVenueOwnerRole,
   Order,
   PermissionedAccount,
   ResultSet,
@@ -35,6 +30,13 @@ import {
   UnsubCallback,
 } from '~/types';
 import { Ensured, QueryReturnType, tuple } from '~/types/utils';
+import {
+  isCddProviderRole,
+  isIdentityRole,
+  isPortfolioCustodianRole,
+  isTickerOwnerRole,
+  isVenueOwnerRole,
+} from '~/utils';
 import { MAX_CONCURRENT_REQUESTS, MAX_PAGE_SIZE } from '~/utils/constants';
 import {
   accountIdToString,

diff --git a/src/api/procedures/__tests__/modifyComplianceRequirement.ts b/src/api/procedures/__tests__/modifyComplianceRequirement.ts
@@ -133,7 +133,7 @@ describe('modifyComplianceRequirement procedure', () => {
   });
 
   test('should add a modify compliance requirement transaction to the queue', async () => {
-    const fakeConditions = ['condition'] as unknown as Condition[];
+    const fakeConditions = [{ claim: '' }] as unknown as Condition[];
     const fakeSenderConditions = 'senderConditions' as unknown as MeshCondition[];
     const fakeReceiverConditions = 'receiverConditions' as unknown as MeshCondition[];
 

diff --git a/src/api/procedures/modifyClaims.ts b/src/api/procedures/modifyClaims.ts
@@ -6,16 +6,7 @@ import { Claim as MeshClaim, IdentityId, TxTags } from 'polymesh-types/types';
 import { Context, Identity, PolymeshError, Procedure } from '~/internal';
 import { didsWithClaims } from '~/middleware/queries';
 import { Claim as MiddlewareClaim, Query } from '~/middleware/types';
-import {
-  CddClaim,
-  Claim,
-  ClaimTarget,
-  ClaimType,
-  ErrorCode,
-  isInvestorUniquenessClaim,
-  isScopedClaim,
-  RoleType,
-} from '~/types';
+import { CddClaim, Claim, ClaimTarget, ClaimType, ErrorCode, RoleType } from '~/types';
 import {
   ClaimOperation,
   Extrinsics,
@@ -35,6 +26,7 @@ import {
   stringToTicker,
 } from '~/utils/conversion';
 import { assembleBatchTransactions } from '~/utils/internal';
+import { isInvestorUniquenessClaim, isScopedClaim } from '~/utils/typeguards';
 
 interface AddClaimsParams {
   /**

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -126,41 +126,6 @@ export type Role =
   | PortfolioCustodianRole
   | IdentityRole;
 
-/**
- * @hidden
- */
-export function isPortfolioCustodianRole(role: Role): role is PortfolioCustodianRole {
-  return role.type === RoleType.PortfolioCustodian;
-}
-
-/**
- * @hidden
- */
-export function isVenueOwnerRole(role: Role): role is VenueOwnerRole {
-  return role.type === RoleType.VenueOwner;
-}
-
-/**
- * @hidden
- */
-export function isCddProviderRole(role: Role): role is CddProviderRole {
-  return role.type === RoleType.CddProvider;
-}
-
-/**
- * @hidden
- */
-export function isTickerOwnerRole(role: Role): role is TickerOwnerRole {
-  return role.type === RoleType.TickerOwner;
-}
-
-/**
- * @hidden
- */
-export function isIdentityRole(role: Role): role is IdentityRole {
-  return role.type === RoleType.Identity;
-}
-
 export enum KnownAssetType {
   EquityCommon = 'EquityCommon',
   EquityPreferred = 'EquityPreferred',
@@ -254,58 +219,82 @@ export enum ClaimType {
   InvestorUniquenessV2 = 'InvestorUniquenessV2',
 }
 
-export type CddClaim = { type: ClaimType.CustomerDueDiligence; id: string };
+export interface AccreditedClaim {
+  type: ClaimType.Accredited;
+  scope: Scope;
+}
+
+export interface AffiliateClaim {
+  type: ClaimType.Affiliate;
+  scope: Scope;
+}
+
+export interface BuyLockupClaim {
+  type: ClaimType.BuyLockup;
+  scope: Scope;
+}
+
+export interface SellLockupClaim {
+  type: ClaimType.SellLockup;
+  scope: Scope;
+}
+
+export interface CddClaim {
+  type: ClaimType.CustomerDueDiligence;
+  id: string;
+}
+
+export interface KycClaim {
+  type: ClaimType.KnowYourCustomer;
+  scope: Scope;
+}
+
+export interface JurisdictionClaim {
+  type: ClaimType.Jurisdiction;
+  code: CountryCode;
+  scope: Scope;
+}
+
+export interface ExemptedClaim {
+  type: ClaimType.Exempted;
+  scope: Scope;
+}
+
+export interface BlockedClaim {
+  type: ClaimType.Blocked;
+  scope: Scope;
+}
 
-export type InvestorUniquenessClaim = {
+export interface InvestorUniquenessClaim {
   type: ClaimType.InvestorUniqueness;
   scope: Scope;
   cddId: string;
   scopeId: string;
-};
+}
+
+export interface NoDataClaim {
+  type: ClaimType.NoData;
+}
 
-export type InvestorUniquenessV2Claim = {
+export interface InvestorUniquenessV2Claim {
   type: ClaimType.InvestorUniquenessV2;
   cddId: string;
-};
+}
 
 export type ScopedClaim =
-  | { type: ClaimType.Jurisdiction; code: CountryCode; scope: Scope }
+  | JurisdictionClaim
   | InvestorUniquenessClaim
-  | {
-      type: Exclude<
-        ClaimType,
-        | ClaimType.NoData
-        | ClaimType.Jurisdiction
-        | ClaimType.CustomerDueDiligence
-        | ClaimType.InvestorUniqueness
-        | ClaimType.InvestorUniquenessV2
-      >;
-      scope: Scope;
-    };
-
-export type UnscopedClaim = { type: ClaimType.NoData } | CddClaim | InvestorUniquenessV2Claim;
+  | AccreditedClaim
+  | AffiliateClaim
+  | BuyLockupClaim
+  | SellLockupClaim
+  | KycClaim
+  | ExemptedClaim
+  | BlockedClaim;
 
-export type Claim = ScopedClaim | UnscopedClaim;
+export type UnscopedClaim = NoDataClaim | CddClaim | InvestorUniquenessV2Claim;
 
-/**
- * @hidden
- */
-export function isScopedClaim(claim: Claim): claim is ScopedClaim {
-  const { type } = claim;
-
-  return ![
-    ClaimType.NoData,
-    ClaimType.CustomerDueDiligence,
-    ClaimType.InvestorUniquenessV2,
-  ].includes(type);
-}
-
-/**
- * @hidden
- */
-export function isInvestorUniquenessClaim(claim: Claim): claim is InvestorUniquenessClaim {
-  return claim.type === ClaimType.InvestorUniqueness;
-}
+export type Claim = ScopedClaim | UnscopedClaim;
 
 export interface ClaimData<ClaimType = Claim> {
   target: Identity;
@@ -420,24 +409,6 @@ export type InputCondition = (
 ) &
   InputConditionBase;
 
-/**
- * @hidden
- */
-export function isSingleClaimCondition(
-  condition: InputCondition
-): condition is InputConditionBase & SingleClaimCondition {
-  return [ConditionType.IsPresent, ConditionType.IsAbsent].includes(condition.type);
-}
-
-/**
- * @hidden
- */
-export function isMultiClaimCondition(
-  condition: InputCondition
-): condition is InputConditionBase & MultiClaimCondition {
-  return [ConditionType.IsAnyOf, ConditionType.IsNoneOf].includes(condition.type);
-}
-
 export interface Requirement {
   id: number;
   conditions: Condition[];

diff --git a/src/utils/conversion.ts b/src/utils/conversion.ts
@@ -151,8 +151,6 @@ import {
   InputRequirement,
   InputTrustedClaimIssuer,
   InstructionType,
-  isMultiClaimCondition,
-  isSingleClaimCondition,
   KnownAssetType,
   MultiClaimCondition,
   OfferingBalanceStatus,
@@ -224,6 +222,7 @@ import {
   padString,
   removePadding,
 } from '~/utils/internal';
+import { isMultiClaimCondition, isSingleClaimCondition } from '~/utils/typeguards';
 
 export * from '~/generated/utils';
 

diff --git a/src/utils/internal.ts b/src/utils/internal.ts
@@ -39,8 +39,6 @@ import {
   ErrorCode,
   InputCaCheckpoint,
   InputCondition,
-  isMultiClaimCondition,
-  isSingleClaimCondition,
   NextKey,
   NoArgsProcedureMethod,
   PaginationOptions,
@@ -65,7 +63,7 @@ import {
   MAX_BATCH_ELEMENTS,
 } from '~/utils/constants';
 import { middlewareScopeToScope, signerToString, u64ToBigNumber } from '~/utils/conversion';
-import { isEntity } from '~/utils/typeguards';
+import { isEntity, isMultiClaimCondition, isSingleClaimCondition } from '~/utils/typeguards';
 
 export * from '~/generated/utils';