Merge fd1540d into 599006b

lerna.json

@@ -3,6 +3,7 @@
   "useWorkspaces": true,
   "packages": [
     "packages/*",
+    "packages/rfq-indexer/*",
     "docs/*"
   ],
   "version": "independent"

package.json

@@ -6,6 +6,7 @@
   "workspaces": {
     "packages": [
       "packages/*",
+      "packages/rfq-indexer/*",
       "docs/*"
     ],
     "nohoist": [
@@ -73,7 +74,8 @@
     "ts-mocha": "^10.0.0",
     "typedoc": "^0.23.24",
     "typedoc-plugin-markdown": "^3.14.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.0.4",
+    "wagmi": "^2.12.12"
   },
   "dependencies": {
     "@changesets/cli": "2.22.0",

packages/rest-api/.eslintrc.js

@@ -7,5 +7,11 @@ module.exports = {
         'prettier/prettier': 'off',
       },
     },
+    {
+      files: ['**/*.ts'],
+      rules: {
+        'guard-for-in': 'off',
+      },
+    },
   ],
 }

packages/rest-api/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.76](https://github.com/synapsecns/sanguine/compare/@synapsecns/[email protected]...@synapsecns/[email protected]) (2024-09-19)
+
+**Note:** Version bump only for package @synapsecns/rest-api
+
+
+
+
+
+## [1.0.75](https://github.com/synapsecns/sanguine/compare/@synapsecns/[email protected]...@synapsecns/[email protected]) (2024-09-18)
+
+**Note:** Version bump only for package @synapsecns/rest-api
+
+
+
+
+
 ## [1.0.74](https://github.com/synapsecns/sanguine/compare/@synapsecns/[email protected]...@synapsecns/[email protected]) (2024-09-16)
 
 **Note:** Version bump only for package @synapsecns/rest-api

packages/rest-api/jest.config.js

@@ -6,5 +6,5 @@ module.exports = {
     '^.+\\.(ts|tsx)$': 'babel-jest',
   },
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
-  moduleDirectories: ['node_modules', 'src'],
+  moduleDirectories: ['node_modules', '<rootDir>'],
 }

packages/rest-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synapsecns/rest-api",
-  "version": "1.0.74",
+  "version": "1.0.76",
   "private": "true",
   "engines": {
     "node": ">=18.17.0"
@@ -15,7 +15,7 @@
     "lint:check": "eslint . --max-warnings=0",
     "ci:lint": "npm run lint:check",
     "test": "jest",
-    "test:coverage": "echo 'No tests defined.'"
+    "test:coverage": "jest --collect-coverage"
   },
   "dependencies": {
     "@ethersproject/bignumber": "^5.7.0",
@@ -26,6 +26,7 @@
     "ethers": "5.7.2",
     "express": "^4.18.2",
     "express-validator": "^7.2.0",
+    "jest": "^29.7.0",
     "lodash": "^4.17.21",
     "supertest": "^6.3.3",
     "typescript": "^4.8.3"

packages/rest-api/src/constants/bridgeable.ts

@@ -1,7 +1,6 @@
 import { BridgeableToken } from '../types'
 import { CHAINS } from './chains'
-
-const ZeroAddress = '0x0000000000000000000000000000000000000000'
+import { ZeroAddress } from '.'
 
 export const GOHM: BridgeableToken = {
   addresses: {

packages/rest-api/src/constants/index.ts

@@ -3,3 +3,6 @@ export const VALID_BRIDGE_MODULES = [
   'SynapseCCTP',
   'SynapseRFQ',
 ]
+
+export const ZeroAddress = '0x0000000000000000000000000000000000000000'
+export const NativeGasAddress = '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE'

packages/rest-api/src/controllers/bridgeController.ts

@@ -3,24 +3,26 @@ import { parseUnits } from '@ethersproject/units'
 
 import { formatBNToString } from '../utils/formatBNToString'
 import { Synapse } from '../services/synapseService'
+import { tokenAddressToToken } from '../utils/tokenAddressToToken'
 
 export const bridgeController = async (req, res) => {
   const errors = validationResult(req)
   if (!errors.isEmpty()) {
     return res.status(400).json({ errors: errors.array() })
   }
   try {
-    const { fromChain, toChain, amount } = req.query
-    const fromTokenInfo = res.locals.tokenInfo.fromToken
-    const toTokenInfo = res.locals.tokenInfo.toToken
+    const { fromChain, toChain, amount, fromToken, toToken } = req.query
+
+    const fromTokenInfo = tokenAddressToToken(fromChain.toString(), fromToken)
+    const toTokenInfo = tokenAddressToToken(toChain.toString(), toToken)
 
     const amountInWei = parseUnits(amount.toString(), fromTokenInfo.decimals)
 
     const resp = await Synapse.allBridgeQuotes(
       Number(fromChain),
       Number(toChain),
-      fromTokenInfo.address,
-      toTokenInfo.address,
+      fromToken,
+      toToken,
       amountInWei
     )
     const payload = resp.map((quote) => ({

packages/rest-api/src/controllers/bridgeTxInfoController.ts

@@ -2,6 +2,7 @@ import { validationResult } from 'express-validator'
 import { parseUnits } from '@ethersproject/units'
 
 import { Synapse } from '../services/synapseService'
+import { tokenAddressToToken } from '../utils/tokenAddressToToken'
 
 export const bridgeTxInfoController = async (req, res) => {
   const errors = validationResult(req)
@@ -10,17 +11,18 @@ export const bridgeTxInfoController = async (req, res) => {
   }
 
   try {
-    const { fromChain, toChain, amount, destAddress } = req.query
-    const fromTokenInfo = res.locals.tokenInfo.fromToken
-    const toTokenInfo = res.locals.tokenInfo.toToken
+    const { fromChain, toChain, amount, destAddress, fromToken, toToken } =
+      req.query
+
+    const fromTokenInfo = tokenAddressToToken(fromChain.toString(), fromToken)
 
     const amountInWei = parseUnits(amount.toString(), fromTokenInfo.decimals)
 
     const quotes = await Synapse.allBridgeQuotes(
       Number(fromChain),
       Number(toChain),
-      fromTokenInfo.address,
-      toTokenInfo.address,
+      fromToken,
+      toToken,
       amountInWei
     )
 
@@ -31,7 +33,7 @@ export const bridgeTxInfoController = async (req, res) => {
           quote.routerAddress,
           Number(fromChain),
           Number(toChain),
-          fromTokenInfo.address,
+          fromToken,
           amountInWei,
           quote.originQuery,
           quote.destQuery

packages/rest-api/src/controllers/destinationTokensController.ts

@@ -0,0 +1,29 @@
+import { validationResult } from 'express-validator'
+
+import { tokenAddressToToken } from '../utils/tokenAddressToToken'
+import { BRIDGE_ROUTE_MAPPING } from '../utils/bridgeRouteMapping'
+
+export const destinationTokensController = async (req, res) => {
+  const errors = validationResult(req)
+  if (!errors.isEmpty()) {
+    return res.status(400).json({ errors: errors.array() })
+  }
+
+  try {
+    const { fromChain, fromToken } = req.query
+
+    const fromTokenInfo = tokenAddressToToken(fromChain.toString(), fromToken)
+
+    const constructedKey = `${fromTokenInfo.symbol}-${fromChain}`
+
+    const options = BRIDGE_ROUTE_MAPPING[constructedKey]
+
+    res.json(options)
+  } catch (err) {
+    res.status(500).json({
+      error:
+        'An unexpected error occurred in /destinationTokens. Please try again later.',
+      details: err.message,
+    })
+  }
+}

packages/rest-api/src/controllers/swapController.ts

@@ -1,28 +1,37 @@
 import { validationResult } from 'express-validator'
 import { formatUnits, parseUnits } from '@ethersproject/units'
+import { BigNumber } from '@ethersproject/bignumber'
 
 import { Synapse } from '../services/synapseService'
+import { tokenAddressToToken } from '../utils/tokenAddressToToken'
 
 export const swapController = async (req, res) => {
   const errors = validationResult(req)
   if (!errors.isEmpty()) {
     return res.status(400).json({ errors: errors.array() })
   }
   try {
-    const { chain, amount } = req.query
-    const fromTokenInfo = res.locals.tokenInfo.fromToken
-    const toTokenInfo = res.locals.tokenInfo.toToken
+    const { chain, amount, fromToken, toToken } = req.query
+
+    const fromTokenInfo = tokenAddressToToken(chain.toString(), fromToken)
+    const toTokenInfo = tokenAddressToToken(chain.toString(), toToken)
 
     const amountInWei = parseUnits(amount.toString(), fromTokenInfo.decimals)
     const quote = await Synapse.swapQuote(
       Number(chain),
-      fromTokenInfo.address,
-      toTokenInfo.address,
+      fromToken,
+      toToken,
       amountInWei
     )
+
+    const formattedMaxAmountOut = formatUnits(
+      BigNumber.from(quote.maxAmountOut),
+      toTokenInfo.decimals
+    )
+
     res.json({
-      maxAmountOut: formatUnits(quote.maxAmountOut, toTokenInfo.decimals),
       ...quote,
+      maxAmountOut: formattedMaxAmountOut,
     })
   } catch (err) {
     res.status(500).json({

packages/rest-api/src/controllers/swapTxInfoController.ts

@@ -2,6 +2,7 @@ import { validationResult } from 'express-validator'
 import { parseUnits } from '@ethersproject/units'
 
 import { Synapse } from '../services/synapseService'
+import { tokenAddressToToken } from '../utils/tokenAddressToToken'
 
 export const swapTxInfoController = async (req, res) => {
   const errors = validationResult(req)
@@ -10,23 +11,23 @@ export const swapTxInfoController = async (req, res) => {
   }
 
   try {
-    const { chain, amount } = req.query
-    const fromTokenInfo = res.locals.tokenInfo.fromToken
-    const toTokenInfo = res.locals.tokenInfo.toToken
+    const { chain, amount, address, fromToken, toToken } = req.query
+
+    const fromTokenInfo = tokenAddressToToken(chain.toString(), fromToken)
 
     const amountInWei = parseUnits(amount.toString(), fromTokenInfo.decimals)
 
     const quote = await Synapse.swapQuote(
       Number(chain),
-      fromTokenInfo.address,
-      toTokenInfo.address,
+      fromToken,
+      toToken,
       amountInWei
     )
 
     const txInfo = await Synapse.swap(
       Number(chain),
-      fromTokenInfo.address,
-      toTokenInfo.address,
+      address,
+      fromToken,
       amountInWei,
       quote.query
     )

packages/rest-api/src/middleware/checksumAddresses.ts

@@ -0,0 +1,14 @@
+import { Request, Response, NextFunction } from 'express'
+import { getAddress, isAddress } from 'ethers/lib/utils'
+
+export const checksumAddresses = (addressFields: string[]) => {
+  return (req: Request, _res: Response, next: NextFunction) => {
+    for (const field of addressFields) {
+      const address = req.query[field]
+      if (typeof address === 'string' && isAddress(address)) {
+        req.query[field] = getAddress(address)
+      }
+    }
+    next()
+  }
+}

packages/rest-api/src/routes/bridgeRoute.ts

@@ -1,31 +1,50 @@
 import express from 'express'
 import { check } from 'express-validator'
 
+import { isTokenAddress } from '../utils/isTokenAddress'
 import { CHAINS_ARRAY } from '../constants/chains'
-import { validateTokens } from '../validations/validateTokens'
 import { showFirstValidationError } from '../middleware/showFirstValidationError'
 import { bridgeController } from '../controllers/bridgeController'
+import { isTokenSupportedOnChain } from '../utils/isTokenSupportedOnChain'
+import { checksumAddresses } from '../middleware/checksumAddresses'
 
 const router = express.Router()
 
 router.get(
   '/',
+  checksumAddresses(['fromToken', 'toToken']),
   [
     check('fromChain')
+      .exists()
+      .withMessage('fromChain is required')
       .isNumeric()
       .custom((value) => CHAINS_ARRAY.some((c) => c.id === Number(value)))
-      .withMessage('Unsupported fromChain')
-      .exists()
-      .withMessage('fromChain is required'),
+      .withMessage('Unsupported fromChain'),
     check('toChain')
+      .exists()
+      .withMessage('toChain is required')
       .isNumeric()
       .custom((value) => CHAINS_ARRAY.some((c) => c.id === Number(value)))
-      .withMessage('Unsupported toChain')
+      .withMessage('Unsupported toChain'),
+    check('fromToken')
+      .exists()
+      .withMessage('fromToken is required')
+      .custom((value) => isTokenAddress(value))
+      .withMessage('Invalid fromToken address')
+      .custom((value, { req }) =>
+        isTokenSupportedOnChain(value, req.query.fromChain as string)
+      )
+      .withMessage('Token not supported on specified chain'),
+    check('toToken')
       .exists()
-      .withMessage('toChain is required'),
-    validateTokens('fromChain', 'fromToken', 'fromToken'),
-    validateTokens('toChain', 'toToken', 'toToken'),
-    check('amount').isNumeric(),
+      .withMessage('toToken is required')
+      .custom((value) => isTokenAddress(value))
+      .withMessage('Invalid toToken address')
+      .custom((value, { req }) =>
+        isTokenSupportedOnChain(value, req.query.toChain as string)
+      )
+      .withMessage('Token not supported on specified chain'),
+    check('amount').isNumeric().exists().withMessage('amount is required'),
   ],
   showFirstValidationError,
   bridgeController