Add shared lib and handle native currency

libs/repositories/src/Erc20Repository/Erc20Repository.ts

@@ -1,4 +1,4 @@
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 
 export const erc20RepositorySymbol = Symbol.for('Erc20Repository');
 

libs/repositories/src/Erc20Repository/Erc20RepositoryCache.spec.ts

@@ -1,7 +1,7 @@
 import { Erc20RepositoryCache } from './Erc20RepositoryCache';
 import { Erc20, Erc20Repository } from './Erc20Repository';
 import { CacheRepository } from '../CacheRepository/CacheRepository';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 
 describe('Erc20RepositoryCache', () => {
   let erc20RepositoryCache: Erc20RepositoryCache;

libs/repositories/src/Erc20Repository/Erc20RepositoryCache.ts

@@ -2,7 +2,7 @@ import { inject, injectable } from 'inversify';
 import NodeCache from 'node-cache';
 import { Erc20, Erc20Repository } from './Erc20Repository';
 import { CacheRepository } from '../CacheRepository/CacheRepository';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import { getCacheKey, PartialCacheKey } from '../utils/cache';
 
 const NULL_VALUE = 'null';

libs/repositories/src/Erc20Repository/Erc20RepositoryViem.spec.ts

@@ -1,5 +1,5 @@
 import { Erc20RepositoryViem } from './Erc20RepositoryViem';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import { PublicClient } from 'viem';
 import { erc20Abi } from 'viem';
 import { Erc20 } from './Erc20Repository';

libs/repositories/src/Erc20Repository/Erc20RepositoryViem.ts

@@ -1,6 +1,6 @@
 import { injectable } from 'inversify';
 import { Erc20, Erc20Repository } from './Erc20Repository';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import { erc20Abi, getAddress, PublicClient } from 'viem';
 
 @injectable()

libs/repositories/src/UsdRepository/UsdRepository.ts

@@ -1,4 +1,4 @@
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 
 export const usdRepositorySymbol = Symbol.for('UsdRepository');
 

libs/repositories/src/UsdRepository/UsdRepositoryCache.spec.ts

@@ -2,7 +2,7 @@ import { UsdRepositoryCache } from './UsdRepositoryCache';
 import IORedis from 'ioredis';
 import { UsdRepository } from './UsdRepository';
 import { CacheRepositoryRedis } from '../CacheRepository/CacheRepositoryRedis';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import { WETH } from '../../test/mock';
 import type { PricePoint } from './UsdRepository';
 

libs/repositories/src/UsdRepository/UsdRepositoryCache.ts

@@ -6,7 +6,7 @@ import {
   deserializePricePoints,
   serializePricePoints,
 } from './UsdRepository';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import ms from 'ms';
 import { CacheRepository } from '../CacheRepository/CacheRepository';
 import { getCacheKey, PartialCacheKey } from '../utils/cache';

libs/repositories/src/UsdRepository/UsdRepositoryCoingecko.test.ts

@@ -1,6 +1,6 @@
 import { Container } from 'inversify';
 import { UsdRepositoryCoingecko } from './UsdRepositoryCoingecko';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import { WETH, DEFINITELY_NOT_A_TOKEN } from '../../test/mock';
 import ms from 'ms';
 

libs/repositories/src/UsdRepository/UsdRepositoryCoingecko.ts

@@ -5,7 +5,7 @@ import {
   SimplePriceResponse,
   coingeckoProClient,
 } from '../datasources/coingecko';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import { throwIfUnsuccessful } from '../utils/throwIfUnsuccessful';
 
 /**

libs/repositories/src/UsdRepository/UsdRepositoryCow.spec.ts

@@ -1,4 +1,4 @@
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import { UsdRepositoryCow } from './UsdRepositoryCow';
 
 import {

libs/repositories/src/UsdRepository/UsdRepositoryCow.ts

@@ -1,7 +1,7 @@
 import { injectable } from 'inversify';
 import { UsdRepositoryNoop } from './UsdRepository';
 import { OneBigNumber, TenBigNumber, USDC, ZeroBigNumber } from '../const';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import { BigNumber } from 'bignumber.js';
 import { throwIfUnsuccessful } from '../utils/throwIfUnsuccessful';
 import { Erc20Repository } from '../Erc20Repository/Erc20Repository';

libs/repositories/src/UsdRepository/UsdRepositoryFallback.spec.ts

@@ -1,4 +1,4 @@
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 import { PricePoint, UsdRepository } from './UsdRepository';
 import { UsdRepositoryFallback } from './UsdRepositoryFallback';
 import { WETH } from '../../test/mock';

libs/repositories/src/UsdRepository/UsdRepositoryFallback.ts

@@ -1,6 +1,6 @@
 import { injectable } from 'inversify';
 import { PricePoint, PriceStrategy, UsdRepository } from './UsdRepository';
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 
 @injectable()
 export class UsdRepositoryFallback implements UsdRepository {

libs/repositories/src/const.ts

@@ -1,5 +1,5 @@
 import BigNumber from 'bignumber.js';
-import { SupportedChainId } from './types';
+import { SupportedChainId } from '../../shared/src/types';
 
 interface TokenAddressAndDecimals {
   address: string;

libs/repositories/src/datasources/coingecko.ts

@@ -1,4 +1,4 @@
-import { SupportedChainId } from '../types';
+import { SupportedChainId } from '@cowprotocol/shared';
 
 import createClient from 'openapi-fetch';
 

libs/repositories/src/datasources/cowApi.ts

@@ -3,7 +3,7 @@ import createClient from 'openapi-fetch';
 const COW_API_BASE_URL = process.env.COW_API_BASE_URL || 'https://api.cow.fi';
 
 import type { paths } from '../gen/cow/cow-api-types';
-import { ALL_CHAIN_IDS, SupportedChainId } from '../types';
+import { ALL_CHAIN_IDS, SupportedChainId } from '@cowprotocol/shared';
 
 export type CowApiClient = ReturnType<typeof createClient<paths>>;
 

libs/repositories/src/datasources/viem.ts

@@ -7,7 +7,7 @@ import {
   webSocket,
 } from 'viem';
 import { arbitrum, gnosis, mainnet, sepolia } from 'viem/chains';
-import { ALL_CHAIN_IDS, SupportedChainId } from '../types';
+import { ALL_CHAIN_IDS, SupportedChainId } from '@cowprotocol/shared';
 
 const NETWORKS: Record<SupportedChainId, Chain> = {
   [SupportedChainId.MAINNET]: mainnet,

libs/repositories/src/index.ts

@@ -1,4 +1,4 @@
-export * from './types';
+export * from '../../shared/src/types';
 
 // Utils
 export * from './utils/cache';

libs/repositories/tsconfig.lib.json

@@ -7,5 +7,5 @@
     "types": ["node"]
   },
   "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
-  "include": ["src/**/*.ts"]
+  "include": ["src/**/*.ts", "../shared/src/types.ts"]
 }

libs/services/src/SlippageService/SlippageService.ts

@@ -1,4 +1,5 @@
 import { PricePoint, SupportedChainId } from '@cowprotocol/repositories';
+import { Address } from 'viem';
 
 /**
  * BPS (Basis Points)
@@ -23,6 +24,7 @@ export interface OrderForSlippageCalculation {
 }
 
 export interface VolatilityDetails {
+  tokenAddress: string;
   usdPrice: number;
   prices: PricePoint[] | null;
   volatilityInUsd: number;

libs/services/src/SlippageService/SlippageServiceMain.ts

@@ -12,6 +12,7 @@ import {
   VolatilityDetails,
 } from './SlippageService';
 import ms from 'ms';
+import { toTokenAddress } from '@cowprotocol/shared';
 
 export const MIN_SLIPPAGE_BPS = 50;
 export const MAX_SLIPPAGE_BPS = 200;
@@ -56,15 +57,16 @@ export class SlippageServiceMain implements SlippageService {
    * Get the volatility of the asset in some time (enough for a solver to execute a solvable order)
    *
    * @param chainId
-   * @param tokenAddress
+   * @param tokenAddressString
    *
    * @returns volatility in decimal format
    */
   async getVolatilityDetails(
     chainId: SupportedChainId,
-    tokenAddress: string,
+    tokenAddressString: string,
     order?: OrderForSlippageCalculation
   ): Promise<VolatilityDetails | null> {
+    const tokenAddress = toTokenAddress(tokenAddressString, chainId);
     const prices = await this.usdRepository.getUsdPrices(
       chainId,
       tokenAddress,
@@ -122,6 +124,7 @@ export class SlippageServiceMain implements SlippageService {
     const normalizedVolatility = volatilityForFairSettlement / usdPrice;
 
     return {
+      tokenAddress,
       prices,
       usdPrice,
       volatilityInUsd: volatilityForFairSettlement,

libs/shared/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

libs/shared/README.md

@@ -0,0 +1,7 @@
+# shared
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test shared` to execute the unit tests via [Jest](https://jestjs.io).

libs/shared/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'shared',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/libs/shared',
+};

libs/shared/project.json

@@ -0,0 +1,30 @@
+{
+  "name": "shared",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/shared/src",
+  "projectType": "library",
+  "targets": {
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["libs/shared/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/shared/jest.config.ts",
+        "passWithNoTests": true
+      },
+      "configurations": {
+        "ci": {
+          "ci": true,
+          "codeCoverage": true
+        }
+      }
+    }
+  },
+  "tags": []
+}

libs/shared/src/const.ts

@@ -0,0 +1,18 @@
+import { Address } from 'viem';
+import { SupportedChainId } from './types';
+
+/**
+ * Native currency address. For example, represents Ether in Mainnet and Arbitrum, and xDAI in Gnosis chain.
+ */
+export const NativeCurrencyAddress =
+  '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee';
+
+/**
+ * Wrapped native token address. For example, represents WETH in Mainnet and Arbitrum, and wxDAI in Gnosis chain.
+ */
+export const WrappedNativeTokenAddress: Record<SupportedChainId, Address> = {
+  [SupportedChainId.MAINNET]: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+  [SupportedChainId.GNOSIS_CHAIN]: '0xe91D153E0b41518A2Ce8Dd3D7944Fa863463a97d',
+  [SupportedChainId.ARBITRUM_ONE]: '0x82aF49447D8a07e3bd95BD0d56f35241523fBab1',
+  [SupportedChainId.SEPOLIA]: '0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14',
+};

libs/shared/src/index.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './const';
+export * from './utils';

libs/shared/src/utils.ts

@@ -0,0 +1,19 @@
+import { Address, getAddress } from 'viem';
+import { NativeCurrencyAddress, WrappedNativeTokenAddress } from './const';
+import { SupportedChainId } from './types';
+
+/**
+ * Returns the token address. This function will throw if the address passed is not an Ethereum address.
+ * It will also convert the address representing the native currency (0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) into
+ * its wrapped version.
+ */
+export function toTokenAddress(
+  address: string,
+  chainId: SupportedChainId
+): Address {
+  if (address.toLocaleLowerCase() === NativeCurrencyAddress) {
+    return WrappedNativeTokenAddress[chainId];
+  }
+
+  return getAddress(address.toLowerCase());
+}

libs/shared/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs"
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/shared/tsconfig.lib.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
+  "include": ["src/**/*.ts"]
+}

libs/shared/tsconfig.spec.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}

tsconfig.base.json

@@ -25,7 +25,8 @@
       "@cowprotocol/cms-api": ["libs/cms-api/src/index.ts"],
       "@cowprotocol/notifications": ["libs/notifications/src/index.ts"],
       "@cowprotocol/repositories": ["libs/repositories/src/index.ts"],
-      "@cowprotocol/services": ["libs/services/src/index.ts"]
+      "@cowprotocol/services": ["libs/services/src/index.ts"],
+      "@cowprotocol/shared": ["libs/shared/src/index.ts"]
     }
   },
   "exclude": ["node_modules", "tmp"]