Merge 5fe94c1 into fb55d90

synapsecns · Dec 14, 2024 · 770d6d9 · 770d6d9
2 parents fb55d90 + 5fe94c1
commit 770d6d9
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 17 deletions.
diff --git a/docs/bridge/docs/02-Bridge/02-REST-API.md b/docs/bridge/docs/02-Bridge/02-REST-API.md
@@ -26,7 +26,8 @@ The API is available at [`https://api.synapseprotocol.com/`](https://api.synapse
 | Date                   | Description                                                                                                                                                        |
 | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | 2024&#8209;10&#8209;01 | [https://synapse-rest-api-v2.herokuapp.com/](https://synapse-rest-api-v2.herokuapp.com/) is no longer maintained and has been fully deprecated as of October 2024. |
-| 2024&#8209;11&#8209;19 | [https://api.synapseprotocol.com/](https://api.synapseprotocol.com/) the /bridgeTxInfo endpoint has been consolidated into the /bridge endpoint, which now returns call data                   |
+| 2024&#8209;11&#8209;19 | [https://api.synapseprotocol.com/](https://api.synapseprotocol.com/) the /bridgeTxInfo endpoint has been consolidated into the /bridge endpoint, which now returns call data                 |
+| 2024&#8209;12&#8209;12 | [https://api.synapseprotocol.com/](https://api.synapseprotocol.com/bridge) the /bridge endpoint now requires both `originUserAddress` and `destAddress` to generate call data.                   |
 
 ## Support
 

diff --git a/packages/rest-api/src/controllers/bridgeController.ts b/packages/rest-api/src/controllers/bridgeController.ts
@@ -53,18 +53,19 @@ export const bridgeController = async (req, res) => {
           quote.originQuery.tokenOut
         )
 
-        const callData = destAddress
-          ? await Synapse.bridge(
-              destAddress,
-              quote.routerAddress,
-              Number(fromChain),
-              Number(toChain),
-              fromToken,
-              amountInWei,
-              quote.originQuery,
-              quote.destQuery
-            )
-          : null
+        const callData =
+          destAddress && originUserAddress
+            ? await Synapse.bridge(
+                destAddress,
+                quote.routerAddress,
+                Number(fromChain),
+                Number(toChain),
+                fromToken,
+                amountInWei,
+                quote.originQuery,
+                quote.destQuery
+              )
+            : null
 
         return {
           ...quote,

diff --git a/packages/rest-api/src/routes/bridgeRoute.ts b/packages/rest-api/src/routes/bridgeRoute.ts
@@ -56,13 +56,13 @@ const router: express.Router = express.Router()
  *         required: false
  *         schema:
  *           type: string
- *         description: The address of the user on the origin chain
+ *         description: The address of the user on the origin chain (required to generate callData)
  *       - in: query
  *         name: destAddress
  *         required: false
  *         schema:
  *           type: string
- *         description: The destination address for the bridge transaction
+ *         description: The destination address for the bridge transaction (required to generate callData)
  *     responses:
  *       200:
  *         description: Successful response

diff --git a/packages/rest-api/src/tests/bridgeRoute.test.ts b/packages/rest-api/src/tests/bridgeRoute.test.ts
@@ -174,14 +174,15 @@ describe('Bridge Route with Real Synapse Service', () => {
     expect(response.body.error).toHaveProperty('field', 'amount')
   })
 
-  it('should return bridge quotes with callData when destAddress is provided', async () => {
+  it('should return bridge quotes with callData when originUserAddress and destAddress are provided', async () => {
     const response = await request(app).get('/bridge').query({
       fromChain: '1',
       toChain: '10',
       fromToken: USDC.addresses[1],
       toToken: USDC.addresses[10],
       amount: '1000',
       destAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
+      originUserAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
     })
 
     expect(response.status).toBe(200)
@@ -200,6 +201,23 @@ describe('Bridge Route with Real Synapse Service', () => {
       fromToken: USDC.addresses[1],
       toToken: USDC.addresses[10],
       amount: '1000',
+      originUserAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
+    })
+
+    expect(response.status).toBe(200)
+    expect(Array.isArray(response.body)).toBe(true)
+    expect(response.body.length).toBeGreaterThan(0)
+    expect(response.body[0].callData).toBeNull()
+  }, 15000)
+
+  it('should return bridge quotes without callData when originUserAddress is not provided', async () => {
+    const response = await request(app).get('/bridge').query({
+      fromChain: '1',
+      toChain: '10',
+      fromToken: USDC.addresses[1],
+      toToken: USDC.addresses[10],
+      amount: '1000',
+      destAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
     })
 
     expect(response.status).toBe(200)

diff --git a/packages/rest-api/swagger.json b/packages/rest-api/swagger.json
@@ -201,7 +201,7 @@
           {
             "in": "query",
             "name": "destAddress",
-            "required": true,
+            "required": false,
             "schema": {
               "type": "string"
             },