chore(checkout): Deprecate risk functions (#2703)

Author: keithbro-imx

packages/checkout/sdk/src/index.ts

@@ -158,7 +158,6 @@ export type {
 
 export {
   fetchRiskAssessment,
-  fetchRiskAssessmentV2,
   isAddressSanctioned,
   isSingleAddressSanctioned,
   resultHasSanctionedWallets,

packages/checkout/sdk/src/riskAssessment/common.ts

@@ -1,39 +1,38 @@
-export type RiskAssessmentResponse = {
-  address: string;
-  risk: RiskAssessmentLevel;
-  risk_reason: string;
-};
-
-export enum RiskAssessmentLevel {
-  LOW = 'Low',
-  MEDIUM = 'Medium',
-  HIGH = 'High',
-  SEVERE = 'Severe',
-}
+/* eslint-disable @typescript-eslint/no-unused-vars */
 
 export type AssessmentResult = {
   [address: string]: {
     sanctioned: boolean;
   };
 };
 
-// deprecated  - please use isSingleAddressSanctioned or resultHasSanctionedWallets
+/**
+ * @deprecated This function is deprecated and will be removed.
+ * @param riskAssessment
+ * @param address
+ * @returns
+ */
 export const isAddressSanctioned = (
   riskAssessment: AssessmentResult,
   address?: string,
-): boolean => {
-  if (address) {
-    return riskAssessment[address.toLowerCase()].sanctioned;
-  }
-
-  return Object.values(riskAssessment).some((assessment) => assessment.sanctioned);
-};
+): boolean => false;
 
+/**
+ * @deprecated This function is deprecated and will be removed.
+ * @param riskAssessment
+ * @param address
+ * @returns
+ */
 export const isSingleAddressSanctioned = (
   riskAssessment: AssessmentResult,
   address: string,
-): boolean => riskAssessment[address.toLowerCase()].sanctioned;
+): boolean => false;
 
+/**
+ * @deprecated This function is deprecated and will be removed.
+ * @param riskAssessment
+ * @returns
+ */
 export const resultHasSanctionedWallets = (
   riskAssessment: AssessmentResult,
-): boolean => Object.values(riskAssessment).some((assessment) => assessment.sanctioned);
+): boolean => false;

packages/checkout/sdk/src/riskAssessment/index.ts

@@ -1,3 +1,2 @@
 export * from './riskAssessment';
-export * from './riskAssessmentV2';
 export * from './common';

packages/checkout/sdk/src/riskAssessment/riskAssessment.test.ts

@@ -1,45 +1,16 @@
-import axios from 'axios';
-import { IMMUTABLE_API_BASE_URL } from '../env';
-import { RiskAssessmentConfig } from '../types';
+/* eslint-disable @typescript-eslint/no-unused-vars */
 import { CheckoutConfiguration } from '../config';
-import { AssessmentResult, RiskAssessmentResponse } from './common';
+import { AssessmentResult } from './common';
 
+/**
+ * @deprecated This function is deprecated and will be removed.
+ * @param addresses
+ * @param config
+ * @returns
+ */
 export const fetchRiskAssessment = async (
   addresses: string[],
   config: CheckoutConfiguration,
-): Promise<AssessmentResult> => {
-  const result = Object.fromEntries(
-    addresses.map((address) => [address.toLowerCase(), { sanctioned: false }]),
-  );
-
-  const riskConfig = (await config.remote.getConfig('riskAssessment')) as
-    | RiskAssessmentConfig
-    | undefined;
-
-  if (!riskConfig?.enabled) {
-    return result;
-  }
-
-  try {
-    const riskLevels = riskConfig?.levels.map((l) => l.toLowerCase()) ?? [];
-
-    const response = await axios.post<RiskAssessmentResponse[]>(
-      `${IMMUTABLE_API_BASE_URL[config.environment]}/v1/sanctions/check`,
-      {
-        addresses,
-      },
-    );
-
-    for (const assessment of response.data) {
-      result[assessment.address.toLowerCase()].sanctioned = riskLevels.includes(
-        assessment.risk.toLowerCase(),
-      );
-    }
-
-    return result;
-  } catch (error) {
-    // eslint-disable-next-line no-console
-    console.error('Error fetching risk assessment', error);
-    return result;
-  }
-};
+): Promise<AssessmentResult> => Object.fromEntries(
+  addresses.map((address) => [address.toLowerCase(), { sanctioned: false }]),
+);

packages/checkout/sdk/src/riskAssessment/riskAssessment.ts

@@ -227,6 +227,7 @@ export class Checkout {
 
   /**
    * Fetches the risk assessment for the given addresses.
+   * @deprecated This function is deprecated and will be removed.
    * @param {string[]} addresses - The addresses to assess.
    * @returns {Promise<AssessmentResult>} - A promise that resolves to the risk assessment result.
    */
@@ -236,6 +237,7 @@ export class Checkout {
 
   /**
    * Helper method that checks if given risk assessment results contain sanctioned addresses.
+   * @deprecated This function is deprecated and will be removed.
    * @param {AssessmentResult} assessment - Risk assessment to analyse.
    * @param {string} [address] - If defined, only sanctions for the given address will be checked.
    * @returns {boolean} - Result of the check.

packages/checkout/sdk/src/sdk.ts

@@ -1,8 +1,7 @@
 import {
   CheckoutConfiguration,
-  fetchRiskAssessmentV2,
-  resultHasSanctionedWallets,
 } from '@imtbl/checkout-sdk';
+import { fetchRiskAssessmentV2, resultHasSanctionedWallets } from '../lib/riskAssessment';
 
 type TokenAmount = {
   address: string;

packages/checkout/widgets-lib/src/functions/checkSanctionedAddresses.ts

@@ -0,0 +1,28 @@
+export type RiskAssessmentResponse = {
+  address: string;
+  risk: RiskAssessmentLevel;
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  risk_reason: string;
+};
+
+export enum RiskAssessmentLevel {
+  LOW = 'Low',
+  MEDIUM = 'Medium',
+  HIGH = 'High',
+  SEVERE = 'Severe',
+}
+
+export type AssessmentResult = {
+  [address: string]: {
+    sanctioned: boolean;
+  };
+};
+
+export const isSingleAddressSanctioned = (
+  riskAssessment: AssessmentResult,
+  address: string,
+): boolean => riskAssessment[address.toLowerCase()].sanctioned;
+
+export const resultHasSanctionedWallets = (
+  riskAssessment: AssessmentResult,
+): boolean => Object.values(riskAssessment).some((assessment) => assessment.sanctioned);

packages/checkout/widgets-lib/src/lib/riskAssessment/common.ts

@@ -0,0 +1,2 @@
+export * from './riskAssessmentV2';
+export * from './common';

packages/checkout/widgets-lib/src/lib/riskAssessment/index.ts

@@ -1,7 +1,7 @@
+/* eslint-disable @typescript-eslint/naming-convention */
 import axios, { AxiosResponse } from 'axios';
+import { CheckoutConfiguration } from '@imtbl/checkout-sdk';
 import { fetchRiskAssessmentV2 } from './riskAssessmentV2';
-import { isAddressSanctioned } from './common';
-import { CheckoutConfiguration } from '../config';
 
 jest.mock('axios');
 
@@ -95,41 +95,4 @@ describe('riskAssessmentV2', () => {
       expect(sanctions[address1.toLowerCase()]).toEqual({ sanctioned: false });
     });
   });
-
-  describe('isAddressSanctioned', () => {
-    it('should return true if any address is sanctioned', () => {
-      const assessment = {
-        '0x9999999123123123': {
-          sanctioned: false,
-        },
-        '0xabcdef1234567890': {
-          sanctioned: true,
-        },
-      };
-
-      expect(isAddressSanctioned(assessment)).toBe(true);
-    });
-
-    it('should return true if single address is sanctioned', () => {
-      const address = '0x1234567890ABCdef';
-      const assessment = {
-        [address.toLowerCase()]: {
-          sanctioned: true,
-        },
-      };
-
-      expect(isAddressSanctioned(assessment, address)).toBe(true);
-    });
-
-    it('should return false if single address is not sanctioned', () => {
-      const address = '0x1234567890ABCdef';
-      const assessment = {
-        [address.toLowerCase()]: {
-          sanctioned: false,
-        },
-      };
-
-      expect(isAddressSanctioned(assessment, address)).toBe(false);
-    });
-  });
 });