[DNM] swagger bump [SLT-453]

packages/rest-api/generate-swagger.js

@@ -0,0 +1,18 @@
+const swaggerJsdoc = require('swagger-jsdoc');
+const fs = require('fs');
+
+const options = {
+  definition: {
+    openapi: '3.0.0',
+    info: {
+      title: 'Synapse REST API',
+      version: '1.8.4',
+      description: 'A node.js project exposing a rest api for synapse sdk quotes',
+    }
+  },
+  apis: ['./src/routes/*.ts']
+};
+
+const swaggerSpec = swaggerJsdoc(options);
+fs.writeFileSync('swagger.json', JSON.stringify(swaggerSpec, null, 2));
+console.log('Swagger JSON generated!');

packages/rest-api/package.json

@@ -15,9 +15,11 @@
     "lint:check": "eslint . --max-warnings=0",
     "ci:lint": "npm run lint:check",
     "test": "jest",
-    "test:coverage": "jest --collect-coverage"
+    "test:coverage": "jest --collect-coverage",
+    "generate-swagger": "swagger-jsdoc -d swagger.config.js -o swagger.json"
   },
   "dependencies": {
+    "@ethersproject/abi": "^5.7.0",
     "@ethersproject/address": "^5.7.0",
     "@ethersproject/bignumber": "^5.7.0",
     "@ethersproject/providers": "^5.7.2",

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

@@ -1,11 +1,16 @@
 import { validationResult } from 'express-validator'
 import { parseUnits } from '@ethersproject/units'
+import { defaultAbiCoder, Interface } from '@ethersproject/abi'
 
 import { formatBNToString } from '../utils/formatBNToString'
 import { Synapse } from '../services/synapseService'
 import { tokenAddressToToken } from '../utils/tokenAddressToToken'
 import { logger } from '../middleware/logger'
 
+const BRIDGE_INTERFACE = new Interface([
+  'function bridge(address to, uint256 chainId, address token, uint256 amount, tuple(address routerAdapter, address tokenOut, uint256 minAmountOut, uint256 deadline, bytes rawParams) originQuery, tuple(address routerAdapter, address tokenOut, uint256 minAmountOut, uint256 deadline, bytes rawParams) destQuery) external payable',
+])
+
 export const bridgeController = async (req, res) => {
   const errors = validationResult(req)
   if (!errors.isEmpty()) {
@@ -42,6 +47,28 @@
         fromChain.toString(),
         quote.originQuery.tokenOut
       )
+
+      const txData = BRIDGE_INTERFACE.encodeFunctionData('bridge', [
+        originUserAddress,
+        Number(toChain),
+        fromToken,
+        amountInWei,
+        [
+          quote.originQuery.routerAdapter,
+          quote.originQuery.tokenOut,
+          quote.originQuery.minAmountOut,
+          quote.originQuery.deadline,
+          quote.originQuery.rawParams
+        ],
+        [
+          quote.destQuery.routerAdapter,
+          quote.destQuery.tokenOut,
+          quote.destQuery.minAmountOut,
+          quote.destQuery.deadline,
+          quote.destQuery.rawParams
+        ]
+      ])
+
       return {
         ...quote,
         maxAmountOutStr: formatBNToString(
@@ -52,6 +79,7 @@
           quote.feeAmount,
           originQueryTokenOutInfo.decimals
         ),
+        txData,
       }
     })
 

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

@@ -101,6 +101,9 @@ const router: express.Router = express.Router()
  *                     type: string
  *                   bridgeFeeFormatted:
  *                     type: string
+ *                   txData:
+ *                     type: string
+ *                     description: Encoded transaction calldata for the bridge function
  *             example:
  *               - id: "01920c87-7f14-7cdf-90e1-e13b2d4af55f"
  *                 feeAmount:
@@ -147,6 +150,7 @@ const router: express.Router = express.Router()
  *                 destChainId: 42161
  *                 maxAmountOutStr: "999046.695719"
  *                 bridgeFeeFormatted: "400"
+ *                 txData: "0x3f4c16de000000000000000000000000..."
  *       400:
  *         description: Invalid input
  *         content:

packages/rest-api/swagger.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  definition: {
+    openapi: '3.0.0',
+    info: {
+      title: 'Synapse REST API',
+      version: '1.8.4',
+      description: 'A node.js project exposing a rest api for synapse sdk quotes',
+    }
+  },
+  apis: ['./src/routes/*.ts']  // This will look in all .ts files in src directory
+};