OP-4308: cross-chain swap

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orionprotocol/sdk",
-  "version": "0.22.14",
+  "version": "0.23.1-rc0",
   "description": "Orion Protocol SDK",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
@@ -86,9 +86,8 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.21.0",
-    "@ethersproject/abstract-signer": "^5.7.0",
     "@ethersproject/providers": "^5.7.2",
-    "@orionprotocol/contracts": "^1.23.9",
+    "@orionprotocol/contracts": "1.23.9",
     "@types/lodash.clonedeep": "^4.5.9",
     "bignumber.js": "^9.1.1",
     "bson-objectid": "^2.0.4",
@@ -102,7 +101,7 @@
     "merge-anything": "^5.1.7",
     "neverthrow": "^6.0.0",
     "patch-package": "^8.0.0",
-    "simple-typed-fetch": "0.2.3",
+    "simple-typed-fetch": "0.2.5",
     "stream-browserify": "^3.0.0",
     "tiny-invariant": "^1.3.1",
     "ts-is-present": "^1.2.2",

src/Orion/bridge/swap.ts

@@ -10,7 +10,7 @@ import {
   LOCKATOMIC_GAS_LIMIT,
   REDEEMATOMIC_GAS_LIMIT,
   WITHDRAW_GAS_LIMIT
-} from '../../constants/index.js';
+} from '../../constants';
 import getNativeCryptocurrencyName from '../../utils/getNativeCryptocurrencyName.js';
 import { denormalizeNumber, generateSecret, normalizeNumber, toUpperCase } from '../../utils/index.js';
 import type { SupportedChainId } from '../../types.js';

src/Unit/Exchange/swapLimit.ts

@@ -5,10 +5,14 @@ import getBalances from '../../utils/getBalances.js';
 import BalanceGuard from '../../BalanceGuard.js';
 import getAvailableSources from '../../utils/getAvailableFundsSources.js';
 import type Unit from '../index.js';
-import { INTERNAL_PROTOCOL_PRECISION, NATIVE_CURRENCY_PRECISION, SWAP_THROUGH_ORION_POOL_GAS_LIMIT } from '../../constants/index.js';
+import {
+  INTERNAL_PROTOCOL_PRECISION,
+  NATIVE_CURRENCY_PRECISION,
+  SWAP_THROUGH_ORION_POOL_GAS_LIMIT
+} from '../../constants';
 import getNativeCryptocurrencyName from '../../utils/getNativeCryptocurrencyName.js';
 import { calculateFeeInFeeAsset, denormalizeNumber, normalizeNumber } from '../../utils/index.js';
-import { signOrder } from '../../crypt/index.js';
+import { signOrder } from '../../crypt';
 import type orderSchema from '../../services/Aggregator/schemas/orderSchema.js';
 import type { z } from 'zod';
 import { simpleFetch } from 'simple-typed-fetch';
@@ -212,7 +216,7 @@ export default async function swapLimit({
     if (options.developer.route === 'pool' && !priceIsBTEMP) {
       throw new Error(
         'CONFLICT: Pool execution is not available for this swap.' +
-        ' Price is worse than market price. Please unset "route" option or set it to "aggregator"'
+                ' Price is worse than market price. Please unset "route" option or set it to "aggregator"'
       );
     }
     route = options.developer.route;
@@ -221,17 +225,17 @@ export default async function swapLimit({
     if (!priceIsBTEMP) {
       throw new Error(
         'CONFLICT: Pool execution is not available for this swap.' +
-        ' Price is worse than market price. Please disable "poolOnly" option'
+                ' Price is worse than market price. Please disable "poolOnly" option'
       );
     }
     options.logger?.('Swap is through pool (because "poolOnly" option is true)');
     route = 'pool';
   } else if (
     poolExchangesList.length > 0 &&
-    swapExchanges.length === 1 &&
-    firstSwapExchange !== undefined &&
-    poolExchangesList.some((poolExchange) => poolExchange === firstSwapExchange) &&
-    priceIsBTEMP
+        swapExchanges.length === 1 &&
+        firstSwapExchange !== undefined &&
+        poolExchangesList.some((poolExchange) => poolExchange === firstSwapExchange) &&
+        priceIsBTEMP
   ) {
     options?.logger?.(`Swap is through pool [via ${firstSwapExchange}] (detected by "exchanges" field)`);
     route = 'pool';
@@ -439,19 +443,19 @@ export default async function swapLimit({
 
   await balanceGuard.check(options?.autoApprove);
 
-  const signedOrder = await signOrder(
+  const signedOrder = await signOrder({
     baseAssetAddress,
     quoteAssetAddress,
-    swapInfo.orderInfo.side,
-    safePriceWithAppliedPrecision.toString(),
-    swapInfo.orderInfo.amount,
-    totalFeeInFeeAsset,
-    walletAddress,
+    side: swapInfo.orderInfo.side,
+    price: safePriceWithAppliedPrecision.toString(),
+    amount: swapInfo.orderInfo.amount,
+    matcherFee: totalFeeInFeeAsset,
+    senderAddress: walletAddress,
     matcherAddress,
-    feeAssetAddress,
+    serviceFeeAssetAddress: feeAssetAddress,
     signer,
     chainId,
-  );
+  });
   const orderIsOk = await exchangeContract.validateOrder(signedOrder);
   if (!orderIsOk) throw new Error('Order is not valid');
 

src/Unit/Exchange/swapMarket.ts

@@ -4,10 +4,14 @@ import { Exchange__factory } from '@orionprotocol/contracts/lib/ethers-v6/index.
 import getBalances from '../../utils/getBalances.js';
 import BalanceGuard from '../../BalanceGuard.js';
 import getAvailableSources from '../../utils/getAvailableFundsSources.js';
-import { INTERNAL_PROTOCOL_PRECISION, NATIVE_CURRENCY_PRECISION, SWAP_THROUGH_ORION_POOL_GAS_LIMIT } from '../../constants/index.js';
+import {
+  INTERNAL_PROTOCOL_PRECISION,
+  NATIVE_CURRENCY_PRECISION,
+  SWAP_THROUGH_ORION_POOL_GAS_LIMIT
+} from '../../constants';
 import getNativeCryptocurrencyName from '../../utils/getNativeCryptocurrencyName.js';
 import { calculateFeeInFeeAsset, denormalizeNumber, normalizeNumber } from '../../utils/index.js';
-import { signOrder } from '../../crypt/index.js';
+import { signOrder } from '../../crypt';
 import type orderSchema from '../../services/Aggregator/schemas/orderSchema.js';
 import type { z } from 'zod';
 import type { SwapLimitParams } from './swapLimit.js';
@@ -178,9 +182,9 @@ export default async function swapMarket({
     route = 'pool';
   } else if (
     poolExchangesList.length > 0 &&
-    swapExchanges.length === 1 &&
-    firstSwapExchange !== undefined &&
-    poolExchangesList.some((poolExchange) => poolExchange === firstSwapExchange)
+        swapExchanges.length === 1 &&
+        firstSwapExchange !== undefined &&
+        poolExchangesList.some((poolExchange) => poolExchange === firstSwapExchange)
   ) {
     options?.logger?.(`Swap is through pool [via ${firstSwapExchange}] (detected by "exchanges" field)`);
     route = 'pool';
@@ -398,19 +402,19 @@ export default async function swapMarket({
 
   await balanceGuard.check(options?.autoApprove);
 
-  const signedOrder = await signOrder(
+  const signedOrder = await signOrder({
     baseAssetAddress,
     quoteAssetAddress,
-    swapInfo.orderInfo.side,
-    safePriceWithAppliedPrecision.toString(),
-    swapInfo.orderInfo.amount,
-    totalFeeInFeeAsset,
-    walletAddress,
+    side: swapInfo.orderInfo.side,
+    price: safePriceWithAppliedPrecision.toString(),
+    amount: swapInfo.orderInfo.amount,
+    matcherFee: totalFeeInFeeAsset,
+    senderAddress: walletAddress,
     matcherAddress,
-    feeAssetAddress,
+    serviceFeeAssetAddress: feeAssetAddress,
     signer,
     chainId,
-  );
+  });
   const orderIsOk = await exchangeContract.validateOrder(signedOrder);
   if (!orderIsOk) throw new Error('Order is not valid');
 

src/constants/index.ts

@@ -1,11 +1,11 @@
 export { default as cancelOrderTypes } from './cancelOrderTypes.js';
 export { default as orderStatuses } from './orderStatuses.js';
-export { default as orderTypes } from './orderTypes.js';
 export { default as subOrderStatuses } from './subOrderStatuses.js';
 export { default as networkCodes } from './networkCodes.js';
 export { default as exchanges } from './exchanges.js';
 export { default as exchangesMap } from './exchangesMap.js';
 
+export * from './orderTypes';
 export * from './chains.js';
 export * from './precisions.js';
 export * from './gasLimits.js';

src/constants/orderStatuses.ts

@@ -3,6 +3,8 @@ import subOrderStatuses from './subOrderStatuses.js';
 const orderStatuses = [
   ...subOrderStatuses,
   'ROUTING', // order got sub orders, but not all of them have status ACCEPTED
+  'TRANSFER', // TX_PENDING > TRANSFER > SETTLED
+  'REFUNDED' // TX_PENDING > TRANSFER > CANCELED > REFUNDED
 ] as const;
 
 export default orderStatuses;

src/constants/orderTypes/crossChainOrderTypes.ts

@@ -0,0 +1,11 @@
+import {ORDER_TYPE} from './orderTypes';
+
+export const CROSS_CHAIN_ORDER_TYPES = {
+    Order: ORDER_TYPE,
+    CrossChainOrder: [
+        {name: 'limitOrder', type: 'Order'},
+        {name: 'chainId', type: 'uint24'},
+        {name: 'secretHash', type: 'bytes32'},
+        {name: 'lockOrderExpiration', type: 'uint64'},
+    ]
+}

src/constants/orderTypes/index.ts

@@ -0,0 +1,3 @@
+export * from './crossChainOrderTypes';
+export * from './lockOrderTypes';
+export { ORDER_TYPES } from './orderTypes';

src/constants/orderTypes/lockOrderTypes.ts

@@ -0,0 +1,10 @@
+export const LOCK_ORDER_TYPES = {
+  LockOrder: [
+    { name: 'sender', type: 'address' },
+    { name: 'expiration', type: 'uint64' },
+    { name: 'asset', type: 'address' },
+    { name: 'amount', type: 'uint64' },
+    { name: 'targetChainId', type: 'uint24' },
+    { name: 'secretHash', type: 'bytes32' },
+  ],
+};

src/constants/orderTypes/orderTypes.ts

@@ -0,0 +1,27 @@
+export const ORDER_TYPE = [
+  { name: 'senderAddress', type: 'address' },
+  { name: 'matcherAddress', type: 'address' },
+  { name: 'baseAsset', type: 'address' },
+  { name: 'quoteAsset', type: 'address' },
+  { name: 'matcherFeeAsset', type: 'address' },
+  { name: 'amount', type: 'uint64' },
+  { name: 'price', type: 'uint64' },
+  { name: 'matcherFee', type: 'uint64' },
+  { name: 'nonce', type: 'uint64' },
+  { name: 'expiration', type: 'uint64' },
+  { name: 'buySide', type: 'uint8' },
+];
+
+export const ORDER_TYPES = {
+  Order: ORDER_TYPE
+}
+
+export const CROSS_CHAIN_ORDER_TYPES = {
+  Order: ORDER_TYPE,
+  CrossChainOrder: [
+    { name: 'limitOrder', type: 'Order' },
+    { name: 'targetChainId', type: 'uint24' },
+    { name: 'secretHash', type: 'bytes32' },
+    { name: 'lockOrderExpiration', type: 'uint64' },
+  ]
+}

src/crypt/getDomainData.ts

@@ -1,5 +1,5 @@
 import type { SupportedChainId } from '../types.js';
-import eip712DomainData from '../config/eip712DomainData.json' assert { type: 'json' };
+import eip712DomainData from '../config/eip712DomainData.json' assert {type: 'json'};
 import eip712DomainSchema from '../config/schemas/eip712DomainSchema.js';
 
 const EIP712Domain = eip712DomainSchema.parse(eip712DomainData);
@@ -19,7 +19,7 @@ function removeUndefined<T>(obj: Record<string, T | undefined>) {
  */
 const getDomainData = (chainId: SupportedChainId) => ({
   ...removeUndefined(EIP712Domain),
-  chainId,
+  chainId: Number(chainId),
 });
 
 export default getDomainData;