Merge branch 'master' of https://github.com/synapsecns/sanguine

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,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.77](https://github.com/synapsecns/sanguine/compare/@synapsecns/[email protected]...@synapsecns/[email protected]) (2024-09-19)
+
+
+### Bug Fixes
+
+* **synapse-interface:** Reorders validation to check existence first ([#3156](https://github.com/synapsecns/sanguine/issues/3156)) ([fd1540d](https://github.com/synapsecns/sanguine/commit/fd1540d21d142e38d16428d172cb182168a62b6e))
+
+
+
+
+
+## [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

packages/rest-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synapsecns/rest-api",
-  "version": "1.0.75",
+  "version": "1.0.77",
   "private": "true",
   "engines": {
     "node": ">=18.17.0"

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/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/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

@@ -6,24 +6,26 @@ import { CHAINS_ARRAY } from '../constants/chains'
 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')
-      .exists()
-      .withMessage('toChain is required'),
+      .withMessage('Unsupported toChain'),
     check('fromToken')
       .exists()
       .withMessage('fromToken is required')

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

@@ -7,24 +7,26 @@ import { showFirstValidationError } from '../middleware/showFirstValidationError
 import { bridgeTxInfoController } from '../controllers/bridgeTxInfoController'
 import { isTokenAddress } from '../utils/isTokenAddress'
 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')
-      .exists()
-      .withMessage('toChain is required'),
+      .withMessage('Unsupported toChain'),
     check('fromToken')
       .exists()
       .withMessage('fromToken is required')
@@ -43,7 +45,7 @@ router.get(
         isTokenSupportedOnChain(value, req.query.toChain as string)
       )
       .withMessage('Token not supported on specified chain'),
-    check('amount').isNumeric().exists().withMessage('amount is required'),
+    check('amount').exists().withMessage('amount is required').isNumeric(),
     check('destAddress')
       .exists()
       .withMessage('destAddress is required')

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

@@ -0,0 +1,40 @@
+import express from 'express'
+import { check } from 'express-validator'
+import { isAddress } from 'ethers/lib/utils'
+
+import { CHAINS_ARRAY } from '../constants/chains'
+import { showFirstValidationError } from '../middleware/showFirstValidationError'
+import { destinationTokensController } from '../controllers/destinationTokensController'
+import { isTokenAddress } from '../utils/isTokenAddress'
+import { isTokenSupportedOnChain } from '../utils/isTokenSupportedOnChain'
+import { checksumAddresses } from '../middleware/checksumAddresses'
+
+const router = express.Router()
+
+router.get(
+  '/',
+  checksumAddresses(['fromToken']),
+  [
+    check('fromChain')
+      .exists()
+      .withMessage('fromChain is required')
+      .isNumeric()
+      .custom((value) => CHAINS_ARRAY.some((c) => c.id === Number(value)))
+      .withMessage('Unsupported fromChain'),
+    check('fromToken')
+      .exists()
+      .withMessage('fromToken is required')
+      .custom((value) => isAddress(value))
+      .withMessage('Invalid fromToken address')
+      .custom((value) => isTokenAddress(value))
+      .withMessage('Unsupported fromToken address')
+      .custom((value, { req }) =>
+        isTokenSupportedOnChain(value, req.query.fromChain as string)
+      )
+      .withMessage('Token not supported on specified chain'),
+  ],
+  showFirstValidationError,
+  destinationTokensController
+)
+
+export default router

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

@@ -12,24 +12,24 @@ router.get(
   '/',
   [
     check('destChainId')
+      .exists()
+      .withMessage('destChainId is required')
       .isNumeric()
       .custom((value) => CHAINS_ARRAY.some((c) => c.id === Number(value)))
-      .withMessage('Unsupported destChainId')
-      .exists()
-      .withMessage('destChainId is required'),
+      .withMessage('Unsupported destChainId'),
     check('bridgeModule')
+      .exists()
+      .withMessage('bridgeModule is required')
       .isString()
       .isIn(VALID_BRIDGE_MODULES)
       .withMessage(
         'Invalid bridge module. Must be one of: ' +
           VALID_BRIDGE_MODULES.join(', ')
-      )
-      .exists()
-      .withMessage('bridgeModule is required'),
+      ),
     check('synapseTxId')
-      .isString()
       .exists()
-      .withMessage('synapseTxId is required'),
+      .withMessage('synapseTxId is required')
+      .isString(),
   ],
   showFirstValidationError,
   getBridgeTxStatusController

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

@@ -10,10 +10,10 @@ router.get(
   '/',
   [
     check('originChainId')
-      .isNumeric()
       .exists()
-      .withMessage('originChainId is required'),
-    check('txHash').isString().exists().withMessage('txHash is required'),
+      .withMessage('originChainId is required')
+      .isNumeric(),
+    check('txHash').exists().withMessage('txHash is required').isString(),
   ],
   showFirstValidationError,
   getDestinationTxController

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

@@ -11,19 +11,19 @@ router.get(
   '/',
   [
     check('originChainId')
-      .isNumeric()
       .exists()
-      .withMessage('originChainId is required'),
+      .withMessage('originChainId is required')
+      .isNumeric(),
     check('bridgeModule')
+      .exists()
+      .withMessage('bridgeModule is required')
       .isString()
       .isIn(VALID_BRIDGE_MODULES)
       .withMessage(
         'Invalid bridge module. Must be one of: ' +
           VALID_BRIDGE_MODULES.join(', ')
-      )
-      .exists()
-      .withMessage('bridgeModule is required'),
-    check('txHash').isString().exists().withMessage('txHash is required'),
+      ),
+    check('txHash').exists().withMessage('txHash is required').isString(),
   ],
   showFirstValidationError,
   getSynapseTxIdController

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

@@ -9,6 +9,7 @@ import getSynapseTxIdRoute from './getSynapseTxIdRoute'
 import getBridgeTxStatusRoute from './getBridgeTxStatusRoute'
 import getDestinationTxRoute from './getDestinationTxRoute'
 import tokenListRoute from './tokenListRoute'
+import destinationTokensRoute from './destinationTokensRoute'
 
 const router = express.Router()
 
@@ -21,5 +22,6 @@ router.use('/getSynapseTxId', getSynapseTxIdRoute)
 router.use('/getBridgeTxStatus', getBridgeTxStatusRoute)
 router.use('/getDestinationTx', getDestinationTxRoute)
 router.use('/tokenList', tokenListRoute)
+router.use('/destinationTokens', destinationTokensRoute)
 
 export default router

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

@@ -6,18 +6,20 @@ import { swapController } from '../controllers/swapController'
 import { CHAINS_ARRAY } from '../constants/chains'
 import { isTokenAddress } from '../utils/isTokenAddress'
 import { isTokenSupportedOnChain } from '../utils/isTokenSupportedOnChain'
+import { checksumAddresses } from '../middleware/checksumAddresses'
 
 const router = express.Router()
 
 router.get(
   '/',
+  checksumAddresses(['fromToken', 'toToken']),
   [
     check('chain')
+      .exists()
+      .withMessage('chain is required')
       .isNumeric()
       .custom((value) => CHAINS_ARRAY.some((c) => c.id === Number(value)))
-      .withMessage('Unsupported chain')
-      .exists()
-      .withMessage('chain is required'),
+      .withMessage('Unsupported chain'),
     check('fromToken')
       .exists()
       .withMessage('fromToken is required')
@@ -36,7 +38,7 @@ router.get(
         isTokenSupportedOnChain(value, req.query.chain as string)
       )
       .withMessage('Token not supported on specified chain'),
-    check('amount').isNumeric().exists().withMessage('amount is required'),
+    check('amount').exists().withMessage('amount is required').isNumeric(),
   ],
   showFirstValidationError,
   swapController

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

@@ -7,18 +7,20 @@ import { showFirstValidationError } from '../middleware/showFirstValidationError
 import { swapTxInfoController } from '../controllers/swapTxInfoController'
 import { isTokenAddress } from '../utils/isTokenAddress'
 import { isTokenSupportedOnChain } from '../utils/isTokenSupportedOnChain'
+import { checksumAddresses } from '../middleware/checksumAddresses'
 
 const router = express.Router()
 
 router.get(
   '/',
+  checksumAddresses(['fromToken', 'toToken']),
   [
     check('chain')
+      .exists()
+      .withMessage('chain is required')
       .isNumeric()
       .custom((value) => CHAINS_ARRAY.some((c) => c.id === Number(value)))
-      .withMessage('Unsupported chain')
-      .exists()
-      .withMessage('chain is required'),
+      .withMessage('Unsupported chain'),
     check('fromToken')
       .exists()
       .withMessage('fromToken is required')