Extend the swap preview. Specify errors;

atomex-protocol · Aug 31, 2022 · 20ffdd9 · 20ffdd9
1 parent b8714dd
commit 20ffdd9
Show file tree

Hide file tree

Showing 10 changed files with 311 additions and 114 deletions.
diff --git a/src/atomex/atomexSwapPreviewManager.ts b/src/atomex/atomexSwapPreviewManager.ts
diff --git a/src/atomex/models/index.ts b/src/atomex/models/index.ts
@@ -7,6 +7,6 @@ export type { SwapPreviewParameters, NormalizedSwapPreviewParameters } from './s
 export type {
   SwapPreview, SwapPreviewDirectionData, SwapPreviewCurrencyData,
   SwapPreviewFee, SwapPreviewError, SwapPreviewWarning
-} from './swapPreview';
+} from './swapPreview/index';
 
 export { SwapOperationCompleteStage } from './swapOperationCompleteStage';
diff --git a/src/atomex/models/swapPreview/index.ts b/src/atomex/models/swapPreview/index.ts
@@ -0,0 +1,3 @@
+export type { SwapPreview, SwapPreviewCurrencyData, SwapPreviewDirectionData, SwapPreviewFee } from './swapPreview';
+export type { SwapPreviewError } from './swapPreviewError';
+export type { SwapPreviewWarning } from './swapPreviewWarning';
diff --git a/src/atomex/models/swapPreview.ts → src/atomex/models/swapPreview/swapPreview.ts b/src/atomex/models/swapPreview.ts → src/atomex/models/swapPreview/swapPreview.ts
@@ -1,7 +1,9 @@
 import type BigNumber from 'bignumber.js';
 
-import type { Currency, Side } from '../../common/index';
-import type { OrderType } from '../../exchange/index';
+import type { Currency, Side } from '../../../common/index';
+import type { OrderType } from '../../../exchange/index';
+import type { SwapPreviewError } from './swapPreviewError';
+import type { SwapPreviewWarning } from './swapPreviewWarning';
 
 export interface SwapPreview {
   readonly type: OrderType;
@@ -20,6 +22,7 @@ export interface SwapPreview {
 export interface SwapPreviewDirectionData {
   readonly address?: string;
   readonly currencyId: Currency['id'];
+  readonly price: BigNumber;
   readonly actual: SwapPreviewCurrencyData;
   readonly available: SwapPreviewCurrencyData;
   readonly max?: SwapPreviewCurrencyData;
@@ -30,16 +33,6 @@ export interface SwapPreviewCurrencyData {
   readonly price: BigNumber;
 }
 
-export interface SwapPreviewError<TErrorData = unknown> {
-  readonly id: string
-  readonly data?: TErrorData;
-}
-
-export interface SwapPreviewWarning<TWarningData = unknown> {
-  readonly id: string
-  readonly data: TWarningData;
-}
-
 export interface SwapPreviewFee {
   readonly name: string;
   readonly currencyId: Currency['id'];

diff --git a/src/atomex/models/swapPreview/swapPreviewError.ts b/src/atomex/models/swapPreview/swapPreviewError.ts
@@ -0,0 +1,48 @@
+import type BigNumber from 'bignumber.js';
+
+import type { Currency } from '../../../common/index';
+import type { Swap } from '../../../swaps';
+
+interface SwapPreviewErrorBase<TErrorId extends string = string, TErrorData = unknown> {
+  readonly id: TErrorId;
+  readonly data?: TErrorData;
+}
+
+type CheckErrorType<TErrorId extends string, TError extends SwapPreviewErrorBase<TErrorId>> = TError;
+
+type NotEnoughFundsSwapPreviewError = CheckErrorType<
+  'not-enough-funds',
+  | {
+    readonly id: 'not-enough-funds';
+    readonly data: {
+      readonly type: 'balance';
+      readonly currencyId: Currency['id'];
+      readonly requiredAmount: BigNumber;
+    };
+  }
+  | {
+    readonly id: 'not-enough-funds';
+    readonly data: {
+      readonly type: 'fees';
+      readonly currencyId: Currency['id'];
+      readonly requiredAmount: BigNumber;
+    };
+  }
+  | {
+    readonly id: 'not-enough-funds';
+    readonly data: {
+      readonly type: 'swaps';
+      readonly swapIds: ReadonlyArray<Swap['id']>;
+      readonly currencyId: Currency['id'];
+      readonly lockedAmount: BigNumber;
+    };
+  }
+>;
+
+export type SwapPreviewError = CheckErrorType<
+  string,
+  | NotEnoughFundsSwapPreviewError
+  | {
+    readonly id: 'not-enough-liquidity'
+  }
+>;
diff --git a/src/atomex/models/swapPreview/swapPreviewWarning.ts b/src/atomex/models/swapPreview/swapPreviewWarning.ts
@@ -0,0 +1,11 @@
+interface SwapPreviewWarningBase<TWarningId extends string = string, TWarningData = unknown> {
+  readonly id: TWarningId;
+  readonly data?: TWarningData;
+}
+
+type CheckWarningType<TWarningId extends string, TWarning extends SwapPreviewWarningBase<TWarningId>> = TWarning;
+
+export type SwapPreviewWarning = CheckWarningType<
+  string,
+  never
+>;
diff --git a/tests/atomex/swapPreview.test.ts b/tests/atomex/swapPreview.test.ts
@@ -62,6 +62,7 @@ describe('Atomex | Swap Preview', () => {
       });
       mockedAtomexContext.services.swapService.getSwaps.mockResolvedValue([]);
       mockPriceManagerByOrderBook(environment.orderBooks);
+      mockAccounts({ ethereum: {}, tezos: {} });
       mockAtomexProtocolMultiChainFees(environment.atomexProtocolFees);
       await atomex.start();
 
@@ -149,6 +150,21 @@ describe('Atomex | Swap Preview', () => {
         return Promise.resolve(wallet as any);
       }
     );
+    mockedAtomexContext.managers.authorizationManager.getAuthToken.mockImplementation(
+      address => ({
+        address,
+        expired: new Date(Date.now() + 60 * 60 * 1000),
+        userId: address,
+        value: address,
+        request: {
+          algorithm: 'test-algorithm',
+          message: 'test-message',
+          publicKey: address,
+          signature: `test-signature-${address}`,
+          timeStamp: Date.now(),
+        }
+      })
+    );
 
     mockedAtomexContext.managers.balanceManager.getBalance
       .mockImplementation((address, currency) => {
@@ -176,7 +192,6 @@ describe('Atomex | Swap Preview', () => {
       return buyPrice && sellPrice
         ? buyPrice.plus(sellPrice).div(2)
         : undefined;
-
     };
 
     mockedAtomexContext.managers.priceManager.getPrice.mockImplementation(async params => {

diff --git a/tests/atomex/testCases/swapPreviewWithAccountAndInvolvedSwapsTestCases.ts b/tests/atomex/testCases/swapPreviewWithAccountAndInvolvedSwapsTestCases.ts
@@ -140,6 +140,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         symbol: 'XTZ/ETH',
         from: {
           currencyId: 'XTZ',
+          price: new BigNumber('0.000948468'),
           address: 'tz101',
           actual: {
             amount: new BigNumber('10'),
@@ -156,6 +157,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         to: {
           currencyId: 'ETH',
+          price: new BigNumber('1054.331827747'),
           address: '0x01',
           actual: {
             amount: new BigNumber('0.00948468'),
@@ -248,6 +250,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         symbol: 'XTZ/ETH',
         from: {
           currencyId: 'XTZ',
+          price: new BigNumber('0.000948468'),
           address: 'tz101',
           actual: {
             amount: new BigNumber('35'),
@@ -264,6 +267,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         to: {
           currencyId: 'ETH',
+          price: new BigNumber('1054.331827747'),
           address: '0x01',
           actual: {
             amount: new BigNumber('0.03319638'),
@@ -321,7 +325,15 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
           ]
         },
         errors: [
-          { id: 'not-enough-funds' }
+          {
+            id: 'not-enough-funds',
+            data: {
+              type: 'swaps',
+              currencyId: 'XTZ',
+              lockedAmount: new BigNumber(68),
+              swapIds: [100, 89]
+            }
+          }
         ],
         warnings: []
       },
@@ -358,6 +370,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         symbol: 'XTZ/ETH',
         from: {
           currencyId: 'XTZ',
+          price: new BigNumber('0.000948468'),
           address: 'tz101',
           actual: {
             amount: new BigNumber('35'),
@@ -374,6 +387,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         to: {
           currencyId: 'ETH',
+          price: new BigNumber('1054.331827747'),
           address: '0x01',
           actual: {
             amount: new BigNumber('0.03319638'),
@@ -431,7 +445,15 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
           ]
         },
         errors: [
-          { id: 'not-enough-funds' }
+          {
+            id: 'not-enough-funds',
+            data: {
+              type: 'swaps',
+              currencyId: 'XTZ',
+              lockedAmount: new BigNumber(68),
+              swapIds: [100, 89]
+            }
+          }
         ],
         warnings: []
       },

diff --git a/tests/atomex/testCases/swapPreviewWithAccountTestCases.ts b/tests/atomex/testCases/swapPreviewWithAccountTestCases.ts
@@ -32,6 +32,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         symbol: 'XTZ/ETH',
         from: {
           currencyId: 'XTZ',
+          price: new BigNumber('0.000948468'),
           address: 'tz101',
           actual: {
             amount: new BigNumber('35'),
@@ -48,6 +49,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         to: {
           currencyId: 'ETH',
+          price: new BigNumber('1054.331827747'),
           address: '0x01',
           actual: {
             amount: new BigNumber('0.03319638'),
@@ -140,6 +142,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         symbol: 'XTZ/ETH',
         from: {
           currencyId: 'XTZ',
+          price: new BigNumber('0.000948468'),
           address: 'tz101',
           actual: {
             amount: new BigNumber('35'),
@@ -156,6 +159,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         to: {
           currencyId: 'ETH',
+          price: new BigNumber('1054.331827747'),
           address: '0x01',
           actual: {
             amount: new BigNumber('0.03319638'),
@@ -214,8 +218,10 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         errors: [
           {
-            id: 'not-enough-funds-network-fee',
+            id: 'not-enough-funds',
             data: {
+              type: 'fees',
+              currencyId: 'ETH',
               requiredAmount: new BigNumber('0.003')
             }
           }
@@ -254,6 +260,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         symbol: 'XTZ/ETH',
         from: {
           currencyId: 'XTZ',
+          price: new BigNumber('0.000948468'),
           address: 'tz101',
           actual: {
             amount: new BigNumber('3'),
@@ -267,6 +274,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         to: {
           currencyId: 'ETH',
+          price: new BigNumber('1054.331827747'),
           address: '0x01',
           actual: {
             amount: new BigNumber('0.002845404'),
@@ -322,8 +330,12 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         errors: [
           {
-            id: 'not-enough-funds-network-fee',
-            data: { requiredAmount: new BigNumber('9.554791') }
+            id: 'not-enough-funds',
+            data: {
+              type: 'fees',
+              currencyId: 'XTZ',
+              requiredAmount: new BigNumber('9.554791')
+            }
           }
         ],
         warnings: []
@@ -360,6 +372,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         symbol: 'ETH/USDT_XTZ',
         from: {
           currencyId: 'USDT_XTZ',
+          price: new BigNumber('0.000613034'),
           address: 'tz101',
           actual: {
             amount: new BigNumber('1217.234'),
@@ -376,6 +389,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         to: {
           currencyId: 'ETH',
+          price: new BigNumber('1631.22858'),
           address: '0x01',
           actual: {
             amount: new BigNumber('0.746206886'),
@@ -434,8 +448,12 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         errors: [
           {
-            id: 'not-enough-funds-network-fee',
-            data: { requiredAmount: new BigNumber(0.2) }
+            id: 'not-enough-funds',
+            data: {
+              type: 'fees',
+              currencyId: 'XTZ',
+              requiredAmount: new BigNumber(0.2)
+            }
           }
         ],
         warnings: []
@@ -476,6 +494,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         symbol: 'ETH/USDT_XTZ',
         from: {
           currencyId: 'USDT_XTZ',
+          price: new BigNumber('0.000613034'),
           address: 'tz101',
           actual: {
             amount: new BigNumber('1217.234'),
@@ -492,6 +511,7 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         },
         to: {
           currencyId: 'ETH',
+          price: new BigNumber('1631.22858'),
           address: '0x01',
           actual: {
             amount: new BigNumber('0.746206886'),
@@ -551,6 +571,11 @@ const swapPreviewWithoutAccountTestCases: ReadonlyArray<[
         errors: [
           {
             id: 'not-enough-funds',
+            data: {
+              type: 'balance',
+              currencyId: 'USDT_XTZ',
+              requiredAmount: new BigNumber(217.234)
+            }
           }
         ],
         warnings: []