feat(rfq-relayer): relayer supports active quoting #3198
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -211,6 +211,7 @@ func (r *QuoterAPIServer) Run(ctx context.Context) error { | |
| wsRoute := engine.Group(RFQStreamRoute) | ||
| wsRoute.Use(r.AuthMiddleware()) | ||
| wsRoute.GET("", func(c *gin.Context) { | ||
| fmt.Println("GET /rfq_stream") | ||
| r.GetActiveRFQWebsocket(ctx, c) | ||
| }) | ||
|
|
||
|
|
@@ -275,7 +276,9 @@ func (r *QuoterAPIServer) AuthMiddleware() gin.HandlerFunc { | |
| loggedRequest = &req | ||
| } | ||
| case RFQRoute, RFQStreamRoute: | ||
| fmt.Println("RFQRoute, RFQStreamRoute") | ||
| chainsHeader := c.GetHeader(ChainsHeader) | ||
| fmt.Printf("got chains header: %s\n", chainsHeader) | ||
|
There was a problem hiding this comment. 🛠️ Refactor suggestion Consider using a proper logging framework and removing debug logs. While adding logs can be helpful for debugging, using
Example using the existing if debugMode {
logger.Debug("RFQRoute or RFQStreamRoute hit")
logger.Debugf("Got chains header: %s", chainsHeader)
} |
||
| if chainsHeader != "" { | ||
| var chainIDs []int | ||
| err = json.Unmarshal([]byte(chainsHeader), &chainIDs) | ||
|
|
@@ -285,10 +288,12 @@ func (r *QuoterAPIServer) AuthMiddleware() gin.HandlerFunc { | |
| } | ||
| } | ||
| } | ||
| fmt.Printf("dest chain ids: %v\n", destChainIDs) | ||
| default: | ||
| err = fmt.Errorf("unexpected request path: %s", c.Request.URL.Path) | ||
| } | ||
| if err != nil { | ||
| fmt.Printf("error: %v\n", err) | ||
| c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) | ||
| c.Abort() | ||
| return | ||
|
|
@@ -299,13 +304,16 @@ func (r *QuoterAPIServer) AuthMiddleware() gin.HandlerFunc { | |
| for _, destChainID := range destChainIDs { | ||
| addr, err := r.checkRole(c, destChainID) | ||
| if err != nil { | ||
| fmt.Printf("error checking role: %v\n", err) | ||
| c.JSON(http.StatusBadRequest, gin.H{"msg": err.Error()}) | ||
| c.Abort() | ||
| return | ||
| } | ||
| if addressRecovered == nil { | ||
| fmt.Printf("no address recovered, setting to %s\n", addr.Hex()) | ||
| addressRecovered = &addr | ||
| } else if *addressRecovered != addr { | ||
| fmt.Printf("relayer address mismatch: %s != %s\n", addressRecovered.Hex(), addr.Hex()) | ||
| c.JSON(http.StatusBadRequest, gin.H{"msg": "relayer address mismatch"}) | ||
| c.Abort() | ||
| return | ||
|
|
@@ -316,6 +324,7 @@ func (r *QuoterAPIServer) AuthMiddleware() gin.HandlerFunc { | |
| // Store the request in context after binding and validation | ||
| c.Set("putRequest", loggedRequest) | ||
| c.Set("relayerAddr", addressRecovered.Hex()) | ||
| fmt.Println("auth succeeded") | ||
| c.Next() | ||
| } | ||
| } | ||
|
|
@@ -434,28 +443,34 @@ func (r *QuoterAPIServer) PutRelayAck(c *gin.Context) { | |
| // @Header 101 {string} X-Api-Version "API Version Number - See docs for more info" | ||
| // @Router /quote_requests [get]. | ||
| func (r *QuoterAPIServer) GetActiveRFQWebsocket(ctx context.Context, c *gin.Context) { | ||
| fmt.Println("GetActiveRFQWebsocket") | ||
|
There was a problem hiding this comment. 🛠️ Refactor suggestion Enhance logging with proper framework and more context. The current debug print statement can be improved for better logging practices:
Example improvement: logger.WithFields(log.Fields{
"relayerAddr": relayerAddr,
"remoteAddr": c.Request.RemoteAddr,
}).Debug("Handling WebSocket connection for active quote requests")Also, consider wrapping this log in a debug flag check to avoid unnecessary logging in production environments. |
||
| ctx, span := r.handler.Tracer().Start(ctx, "GetActiveRFQWebsocket") | ||
| defer func() { | ||
| metrics.EndSpan(span) | ||
| }() | ||
|
|
||
| fmt.Println("upgrading websocket") | ||
| ws, err := r.upgrader.Upgrade(c.Writer, c.Request, nil) | ||
| if err != nil { | ||
| logger.Error("Failed to set websocket upgrade", "error", err) | ||
| return | ||
| } | ||
| fmt.Println("upgraded websocket") | ||
|
|
||
| // use the relayer address as the ID for the connection | ||
| rawRelayerAddr, exists := c.Get("relayerAddr") | ||
| if !exists { | ||
| fmt.Println("no relayer address recovered from signature") | ||
| c.JSON(http.StatusBadRequest, gin.H{"error": "No relayer address recovered from signature"}) | ||
| return | ||
| } | ||
| relayerAddr, ok := rawRelayerAddr.(string) | ||
| if !ok { | ||
| fmt.Println("invalid relayer address type") | ||
| c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid relayer address type"}) | ||
| return | ||
| } | ||
| fmt.Printf("relayer address: %s\n", relayerAddr) | ||
|
|
||
| span.SetAttributes( | ||
| attribute.String("relayer_address", relayerAddr), | ||
|
|
@@ -464,6 +479,7 @@ func (r *QuoterAPIServer) GetActiveRFQWebsocket(ctx context.Context, c *gin.Cont | |
| // only one connection per relayer allowed | ||
| _, ok = r.wsClients.Load(relayerAddr) | ||
| if ok { | ||
| fmt.Println("relayer already connected") | ||
| c.JSON(http.StatusBadRequest, gin.H{"error": "relayer already connected"}) | ||
| return | ||
| } | ||
|
|
@@ -474,12 +490,16 @@ func (r *QuoterAPIServer) GetActiveRFQWebsocket(ctx context.Context, c *gin.Cont | |
| }() | ||
|
|
||
| client := newWsClient(relayerAddr, ws, r.pubSubManager, r.handler) | ||
| fmt.Println("registered ws client") | ||
| r.wsClients.Store(relayerAddr, client) | ||
| span.AddEvent("registered ws client") | ||
| fmt.Println("running ws client") | ||
| err = client.Run(ctx) | ||
| if err != nil { | ||
| fmt.Printf("error running ws client: %v\n", err) | ||
| logger.Error("Error running websocket client", "error", err) | ||
| } | ||
| fmt.Println("ws client done") | ||
| } | ||
|
|
||
| const ( | ||
|
|
@@ -533,16 +553,23 @@ func (r *QuoterAPIServer) PutRFQRequest(c *gin.Context) { | |
| var activeQuote *model.QuoteData | ||
| if isActiveRFQ { | ||
| activeQuote = r.handleActiveRFQ(ctx, &req, requestID) | ||
| if activeQuote != nil && activeQuote.DestAmount != nil { | ||
| span.SetAttributes(attribute.String("active_quote_dest_amount", *activeQuote.DestAmount)) | ||
| } | ||
| } | ||
| passiveQuote, err := r.handlePassiveRFQ(ctx, &req) | ||
| if err != nil { | ||
| logger.Error("Error handling passive RFQ", "error", err) | ||
| } | ||
| if passiveQuote != nil && passiveQuote.DestAmount != nil { | ||
| span.SetAttributes(attribute.String("passive_quote_dest_amount", *passiveQuote.DestAmount)) | ||
| } | ||
| quote, _ := getBestQuote(activeQuote, passiveQuote) | ||
|
|
||
| // construct the response | ||
| var resp model.PutUserQuoteResponse | ||
| if quote == nil { | ||
| span.AddEvent("no quotes found") | ||
| resp = model.PutUserQuoteResponse{ | ||
| Success: false, | ||
| Reason: "no quotes found", | ||
|
|
@@ -552,6 +579,10 @@ func (r *QuoterAPIServer) PutRFQRequest(c *gin.Context) { | |
| if activeQuote == nil { | ||
| quoteType = quoteTypePassive | ||
| } | ||
| span.SetAttributes( | ||
| attribute.String("quote_type", quoteType), | ||
| attribute.String("quote_dest_amount", *quote.DestAmount), | ||
| ) | ||
| resp = model.PutUserQuoteResponse{ | ||
| Success: true, | ||
| Data: *quote, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,7 +44,6 @@ type ServerSuite struct { | |
| handler metrics.Handler | ||
| QuoterAPIServer *rest.QuoterAPIServer | ||
| port uint16 | ||
| originChainID int | ||
| destChainID int | ||
| } | ||
|
|
@@ -75,8 +74,6 @@ func (c *ServerSuite) SetupTest() { | |
| c.True(ok) | ||
| port, err := freeport.GetFreePort() | ||
| c.port = uint16(port) | ||
| c.Require().NoError(err) | ||
|
|
||
| testConfig := config.Config{ | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Improve logging approach for WebSocket connection details
While the added print statements can be helpful for debugging, using
fmt.Printfdirectly is not ideal for production code. Consider the following improvements:loggervariable (which is an instance oflog.Logger) instead offmt.Printf. This allows for better log management and potential log level control.Here's a suggested refactor:
Also, consider adding a helper function to sanitize headers before logging to ensure sensitive information is not exposed.
📝 Committable suggestion