Merge c32b70b 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,12 @@ module.exports = {
         'prettier/prettier': 'off',
       },
     },
+    {
+      files: ['**/*.ts'],
+      rules: {
+        'guard-for-in': 'off',
+        'jsdoc/check-indentation': 'off',
+      },
+    },
   ],
 }

packages/rest-api/CHANGELOG.md

@@ -3,6 +3,52 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.1.1](https://github.com/synapsecns/sanguine/compare/@synapsecns/[email protected]...@synapsecns/[email protected]) (2024-09-20)
+
+**Note:** Version bump only for package @synapsecns/rest-api
+
+
+
+
+
+# [1.1.0](https://github.com/synapsecns/sanguine/compare/@synapsecns/[email protected]...@synapsecns/[email protected]) (2024-09-20)
+
+
+### Features
+
+* **rest-api:** Adds Swagger for api docs [SLT-205] ([#3159](https://github.com/synapsecns/sanguine/issues/3159)) ([01ec2d4](https://github.com/synapsecns/sanguine/commit/01ec2d47a91ba3e190216608ec626d85dbd19d3b))
+
+
+
+
+
+## [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
+
+
+
+
+
 ## [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.1.1",
   "private": "true",
   "engines": {
     "node": ">=18.17.0"
@@ -9,13 +9,13 @@
     "build": "tsc",
     "build:go": " ",
     "build:slither": " ",
-    "dev": "nodemon --watch src --exec ts-node src/app.ts",
+    "dev": "NODE_ENV=development nodemon --watch src --exec ts-node src/app.ts",
     "start": "node dist/app.js",
     "lint:fix": "eslint src/**/*.ts --fix",
     "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"
@@ -37,10 +38,14 @@
     "@babel/preset-typescript": "^7.24.7",
     "@types/jest": "^29.5.13",
     "@types/supertest": "^6.0.2",
+    "@types/swagger-jsdoc": "^6.0.4",
+    "@types/swagger-ui-express": "^4.1.6",
     "concurrently": "^8.2.0",
     "jest": "^29.7.0",
     "lodash": "^4.17.21",
     "nodemon": "^3.0.1",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.1",
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2"
   }

packages/rest-api/src/app.ts

@@ -1,11 +1,16 @@
 import express from 'express'
+import swaggerUi from 'swagger-ui-express'
 
+import { specs } from './swagger'
 import routes from './routes'
 
 const app = express()
 const port = process.env.PORT || 3000
 
 app.use(express.json())
+
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs))
+
 app.use('/', routes)
 
 export const server = app.listen(port, () => {

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/getBridgeTxStatusController.ts → packages/rest-api/src/controllers/bridgeTxStatusController.ts

@@ -4,7 +4,7 @@ import { ethers } from 'ethers'
 import { Synapse } from '../services/synapseService'
 import { getTokenDecimals } from '../utils/getTokenDecimals'
 
-export const getBridgeTxStatusController = async (req, res) => {
+export const bridgeTxStatusController = async (req, res) => {
   const errors = validationResult(req)
   if (!errors.isEmpty()) {
     return res.status(400).json({ errors: errors.array() })
@@ -72,7 +72,7 @@ export const getBridgeTxStatusController = async (req, res) => {
   } catch (err) {
     res.status(500).json({
       error:
-        'An unexpected error occurred in /getBridgeTxStatus. Please try again later.',
+        'An unexpected error occurred in /bridgeTxStatus. Please try again later.',
       details: err.message,
     })
   }

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/getDestinationTxController.ts → packages/rest-api/src/controllers/destinationTxController.ts

@@ -3,7 +3,7 @@ import { ethers } from 'ethers'
 
 import { getTokenDecimals } from '../utils/getTokenDecimals'
 
-export const getDestinationTxController = async (req, res) => {
+export const destinationTxController = async (req, res) => {
   const errors = validationResult(req)
   if (!errors.isEmpty()) {
     return res.status(400).json({ errors: errors.array() })
@@ -65,7 +65,7 @@ export const getDestinationTxController = async (req, res) => {
   } catch (err) {
     res.status(500).json({
       error:
-        'An unexpected error occurred in /getDestinationTx. Please try again later.',
+        'An unexpected error occurred in /destinationTx. 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({