@reyaxyz/common 0.46.1 → 0.48.0

package/src/utils/consts.ts

@@ -1,92 +1,2 @@
-import { Address } from '../types';
-
 export const MAX_UINT128 = 2 ** 128 - 1;
-
 export const API_TIMEOUT: number = 2500;
-
-// todo-token must add addresses of all tokens from all chains below (reya and source chains)
-
-// @todo update values for mainnet
-export const tokenDetails: {
-  [address: Address]: {
-    tokenName: Uppercase<string>;
-    tokenDecimals: number;
-  };
-} = {
-  // ====== USDC ======
-  // mumbai
-  '0xd9edcc943ed9729b08e52bb1e110fe43d1930773': {
-    tokenName: 'USDC',
-    tokenDecimals: 6,
-  },
-  // arbitrum sepolia
-  '0x8537307810fc40f4073a12a38554d4ff78efff41': {
-    tokenName: 'USDC',
-    tokenDecimals: 6,
-  },
-  // op sepolia
-  '0x6d290609b3f5f02d52f28d97c75a443ed8564cbf': {
-    tokenName: 'USDC',
-    tokenDecimals: 6,
-  },
-  // ethereum sepolia
-  '0x565810cbfa3cf1390963e5afa2fb953795686339': {
-    tokenName: 'USDC',
-    tokenDecimals: 6,
-  },
-  // reya cronos
-  '0x1b700a40a0707dd5f0bc31cbc57d730558e5714d': {
-    tokenName: 'USDC',
-    tokenDecimals: 6,
-  },
-
-  // ====== wETH ======
-  // mumbai
-  '0xc199807af4fedb02ee567ed0feb814a077de4802': {
-    tokenName: 'WETH',
-    tokenDecimals: 18,
-  },
-  // reya cronos
-  '0xc123b7aeb9d2b2e8a035217d5c29e317c91842e2': {
-    tokenName: 'WETH',
-    tokenDecimals: 18,
-  },
-
-  // ====== wBTC ======
-  // mumbai
-  '0x2fa2e7a6deb7bb51b625336dbe1da23511914a8a': {
-    tokenName: 'WBTC',
-    tokenDecimals: 8,
-  },
-  // mainnet
-  '0xaf21abab55a7c0ab143e0379a3c01054e4ebb514': {
-    tokenName: 'WBTC',
-    tokenDecimals: 8,
-  },
-  // reya orbit testnet
-  '0xd382e2f0df859ff9e82f963dcad1aaee939c5e4f': {
-    tokenName: 'WBTC',
-    tokenDecimals: 8,
-  },
-
-  // ====== USDT ======
-  // reya cronos
-  '0x9ade781dacbd220f0161d98f496a2982b231a9d6': {
-    tokenName: 'USDT',
-    tokenDecimals: 6,
-  },
-
-  // ====== dai ======
-  // reya cronos
-  '0x733299259c45726ee1bfc9bd0deeba58e48a1853': {
-    tokenName: 'DAI',
-    tokenDecimals: 18,
-  },
-
-  // ====== rUSD ======
-  // reya cronos
-  '0xcfbb14b2a2acb5779b6365a260e4a9d63a12100b': {
-    tokenName: 'RUSD',
-    tokenDecimals: 6,
-  },
-};

package/src/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './consts';
+export * from './network';
 export * from './number';
 export * from './retry';
 export * from './timestamp';

package/src/utils/network.ts

@@ -0,0 +1,23 @@
+import { MoneyInOutChainId, ReyaChainId } from '../types';
+
+export function getReyaNetwork(env: 'production' | 'test'): ReyaChainId {
+  if (env === 'production') return ReyaChainId.reyaNetwork;
+  if (env === 'test') return ReyaChainId.reyaCronos;
+
+  throw new Error('Unknown error passed');
+}
+
+export function getReyaNetworkFromMoneyInOutChainId(
+  moneyInOutChainId: MoneyInOutChainId,
+): ReyaChainId {
+  switch (moneyInOutChainId) {
+    case MoneyInOutChainId.polygonMumbai:
+    case MoneyInOutChainId.arbitrumSepolia:
+    case MoneyInOutChainId.opSepolia:
+    case MoneyInOutChainId.ethereumSepolia:
+      return getReyaNetwork('test');
+
+    default:
+      throw new Error('getReyaNetwork: unexpected moneyInOutChainId');
+  }
+}

package/src/utils/socket/reyaCronos.json

@@ -0,0 +1,77 @@
+{
+  "80001": {
+    "USDC": {
+      "isAppChain": false,
+      "NonMintableToken": "0xD9edcC943ed9729B08E52Bb1e110FE43d1930773",
+      "Vault": "0xEC5b7075F581D46983EBe2Be6baB0f58Bf1E8C4b",
+      "connectors": {
+        "89346161": {
+          "FAST": "0xF5541Ea3ee034D8f7C397bf77556f07e7562dF9A"
+        }
+      },
+      "ExecutionHelper": "0xA858f95c50240A6a28E5cd323869cE77ee7677Bd"
+    }
+  },
+  "421614": {
+    "USDC": {
+      "isAppChain": false,
+      "NonMintableToken": "0x8537307810fC40F4073A12a38554D4Ff78EfFf41",
+      "Vault": "0x85314b664cB2e443C93F09EDb51088f76b048212",
+      "connectors": {
+        "89346161": {
+          "FAST": "0x7dE4937420935c7C8767b06eCd7F7dC54e2D7C9b"
+        }
+      },
+      "ExecutionHelper": "0x4caE6101A2645AE58038Aeb04079621458b00753"
+    }
+  },
+  "11155111": {
+    "USDC": {
+      "isAppChain": false,
+      "NonMintableToken": "0x565810cbfa3Cf1390963E5aFa2fB953795686339",
+      "Vault": "0x8487daa5864a5cE18E5a89406c11EC748da33fbB",
+      "connectors": {
+        "89346161": {
+          "FAST": "0x42229a5DDC5E32149311265F6F4BC016EaB778FC"
+        }
+      },
+      "ExecutionHelper": "0x4F3e01e8f7d0224b5988Cb0FBf7f6D156B9255cD"
+    }
+  },
+  "11155420": {
+    "USDC": {
+      "isAppChain": false,
+      "NonMintableToken": "0x6D290609b3F5F02D52F28d97C75a443ED8564cBf",
+      "Vault": "0x1019958C2BD43B882a4e1349337a32Ef9563FC4D",
+      "connectors": {
+        "89346161": {
+          "FAST": "0x805Dc5ac616bCB1A59a446eb1777C0Cc3Aa0c3Fe"
+        }
+      },
+      "ExecutionHelper": "0xD664eF6159562190ea6D1AFa3f0Ea1C0D77D14E3"
+    }
+  },
+  "89346161": {
+    "USDC": {
+      "isAppChain": true,
+      "MintableToken": "0x1b700A40A0707Dd5f0BC31cbc57D730558E5714d",
+      "ExchangeRate": "0x1Aba89fC7ff67D27ccaa51893c46FD1e5fEE924B",
+      "Controller": "0x663dc7E91157c58079f55C1BF5ee1BdB6401Ca7a",
+      "connectors": {
+        "80001": {
+          "FAST": "0x54CAA0946dA179425e1abB169C020004284d64D3"
+        },
+        "421614": {
+          "FAST": "0xd7627d03dEA4006cBe8E701F6932dBF75d3269B3"
+        },
+        "11155111": {
+          "FAST": "0xdA089249ccE9d9726Fa6b755c5ec3d9C260C90C2"
+        },
+        "11155420": {
+          "FAST": "0x11695Ff9EE5E600b90BcbD651D1758A9B240A2d8"
+        }
+      },
+      "ExecutionHelper": "0xB6fb3062405985F700fa23758A3053162ddBeFb9"
+    }
+  }
+}

package/src/utils/token-info.ts

@@ -0,0 +1,75 @@
+import { MoneyInOutChainId, ReyaChainId, TokenInfo } from '../types';
+
+export const TOKEN_INFO: Record<ReyaChainId | MoneyInOutChainId, TokenInfo[]> =
+  {
+    /* ------------------------------------------------------ */
+    /*                        MAINNET                         */
+    /* ------------------------------------------------------ */
+    [ReyaChainId.reyaNetwork]: [
+      // todo
+    ],
+
+    /* ------------------------------------------------------ */
+    /*                        TESTNET                         */
+    /* ------------------------------------------------------ */
+    [ReyaChainId.reyaCronos]: [
+      {
+        name: 'RUSD',
+        address: '0xcfbb14b2a2acb5779b6365a260e4a9d63a12100b',
+        decimals: 6,
+      },
+      {
+        name: 'USDC',
+        address: '0x1b700a40a0707dd5f0bc31cbc57d730558e5714d',
+        decimals: 6,
+      },
+      {
+        name: 'USDT',
+        address: '0x9ade781dacbd220f0161d98f496a2982b231a9d6',
+        decimals: 6,
+      },
+      {
+        name: 'DAI',
+        address: '0x733299259c45726ee1bfc9bd0deeba58e48a1853',
+        decimals: 18,
+      },
+      {
+        name: 'WETH',
+        address: '0xc123b7aeb9d2b2e8a035217d5c29e317c91842e2',
+        decimals: 18,
+      },
+      {
+        name: 'WBTC',
+        address: '0xd382e2f0df859ff9e82f963dcad1aaee939c5e4f',
+        decimals: 8,
+      },
+    ],
+    [MoneyInOutChainId.polygonMumbai]: [
+      {
+        name: 'USDC',
+        address: '0xd9edcc943ed9729b08e52bb1e110fe43d1930773',
+        decimals: 6,
+      },
+    ],
+    [MoneyInOutChainId.arbitrumSepolia]: [
+      {
+        name: 'USDC',
+        address: '0x8537307810fc40f4073a12a38554d4ff78efff41',
+        decimals: 6,
+      },
+    ],
+    [MoneyInOutChainId.opSepolia]: [
+      {
+        name: 'USDC',
+        address: '0x6d290609b3f5f02d52f28d97c75a443ed8564cbf',
+        decimals: 6,
+      },
+    ],
+    [MoneyInOutChainId.ethereumSepolia]: [
+      {
+        name: 'USDC',
+        address: '0x565810cbfa3cf1390963e5afa2fb953795686339',
+        decimals: 6,
+      },
+    ],
+  };

package/src/utils/token.ts

@@ -1,9 +1,16 @@
 import { ethers } from 'ethers';
 
 import { Contract, Signer } from 'ethers';
-import { tokenDetails } from './consts';
+import { TOKEN_INFO } from './token-info';
 import { exponentialBackoff } from './retry';
-import { Address, GetERC20AllowanceParams } from '../types';
+import {
+  Address,
+  GetERC20AllowanceParams,
+  MoneyInOutChainId,
+  ReyaChainId,
+  TokenInfo,
+  TokenName,
+} from '../types';
 
 export const descale = (tokenDecimals: number) => {
   const f = (value: bigint) => {
@@ -43,26 +50,57 @@ export const convertToAddress = (str: string): Address => {
   return str.toLowerCase() as Address;
 };
 
-export const getTokenDetails = (
-  caseSensitiveAddress: string,
-): {
-  tokenName: Uppercase<string>;
-  tokenDecimals: number;
-  tokenDescaler: (value: bigint) => number;
-} => {
-  const address = convertToAddress(caseSensitiveAddress);
-
-  if (!Object.keys(tokenDetails).includes(address)) {
-    throw new Error(`Token details not found for ${address}.`);
+export const getTokenInfoByAddress = (
+  tokenAddressParam: Address | string,
+  chainId?: ReyaChainId | MoneyInOutChainId,
+): TokenInfo => {
+  const tokenAddress =
+    typeof tokenAddressParam === 'string'
+      ? convertToAddress(tokenAddressParam)
+      : tokenAddressParam;
+
+  if (chainId) {
+    const tokenInfo = TOKEN_INFO[chainId].find(
+      (tokenInfo) => tokenInfo.address === tokenAddress,
+    );
+    if (!tokenInfo) {
+      throw new Error(
+        `getTokenInfoByAddress: no token info found [chainId ${chainId}, token address ${tokenAddress}]`,
+      );
+    }
+    return tokenInfo;
+  } else {
+    for (const chainId in TOKEN_INFO) {
+      const tokenInfos =
+        TOKEN_INFO[chainId as unknown as keyof typeof TOKEN_INFO];
+      const tokenInfo = tokenInfos.find(
+        (tokenInfo) => tokenInfo.address === tokenAddress,
+      );
+      if (tokenInfo) {
+        return tokenInfo;
+      }
+    }
+    throw new Error(
+      `getTokenInfoByAddress: no token info found [token address ${tokenAddress}]`,
+    );
   }
+};
+
+export const getTokenInfoByName = (
+  tokenName: TokenName,
+  chainId: ReyaChainId | MoneyInOutChainId,
+): TokenInfo => {
+  const tokenInfo = TOKEN_INFO[chainId].find(
+    (tokenInfo) => tokenInfo.name === tokenName,
+  );
 
-  const { tokenName, tokenDecimals } = tokenDetails[address];
+  if (!tokenInfo) {
+    throw new Error(
+      `getTokenInfoByName: no token info found [chain id ${chainId}, token name ${tokenName}]`,
+    );
+  }
 
-  return {
-    tokenName,
-    tokenDecimals,
-    tokenDescaler: descale(tokenDecimals),
-  };
+  return tokenInfo;
 };
 
 export const getERC20Allowance = async ({
@@ -72,15 +110,15 @@ export const getERC20Allowance = async ({
   subject,
 }: GetERC20AllowanceParams): Promise<number> => {
   const tokenContract = getERC20TokenContract(tokenAddress, subject);
-  const { tokenDecimals } = getTokenDetails(tokenAddress);
+  const tokenInfo = getTokenInfoByAddress(tokenAddress);
 
   const allowance = await exponentialBackoff(() =>
     tokenContract.allowance(walletAddress, spenderAddress),
   );
 
-  return BigInt(allowance) > scale(tokenDecimals)(Number.MAX_SAFE_INTEGER)
+  return BigInt(allowance) > scale(tokenInfo.decimals)(Number.MAX_SAFE_INTEGER)
     ? Number.MAX_SAFE_INTEGER
-    : descale(tokenDecimals)(allowance);
+    : descale(tokenInfo.decimals)(allowance);
 };
 
 export type GetERC20BalanceArgs = {
@@ -96,11 +134,11 @@ export const getERC20Balance = async ({
 }: GetERC20BalanceArgs): Promise<number> => {
   const token = getERC20TokenContract(tokenAddress, subject);
 
-  const { tokenDescaler } = getTokenDetails(tokenAddress);
+  const tokenInfo = getTokenInfoByAddress(convertToAddress(tokenAddress));
 
   const currentBalance = await exponentialBackoff(() =>
     token.balanceOf(walletAddress),
   );
 
-  return tokenDescaler(currentBalance);
+  return descale(tokenInfo.decimals)(currentBalance);
 };