8000 activeQuote depositAmount [SLT-464] by parodime · Pull Request #3372 · synapsecns/sanguine · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

activeQuote depositAmount [SLT-464] #3372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 12, 2024
Merged

activeQuote depositAmount [SLT-464] #3372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6808eb0
add DepositAmount to QuoteInput, incorporate into getOriginAmount
parodime Nov 6, 2024
1908780
fix redundant declaration
parodime Nov 6, 2024
1e3bac6
activequote tests. extended/revised comments
parodime Nov 8, 2024
77ffbd2
lint
parodime Nov 11, 2024
02e893b
relabel activeRFQ OriginAmount/DepositAmount to OriginAmountExact
parodime Nov 11, 2024
1a32365
docs & json field label
parodime Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions services/rfq/api/db/api_db.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,39 +142,39 @@

// ActiveQuoteRequest is the database model for an active quote request.
type ActiveQuoteRequest struct {
RequestID string `gorm:"column:request_id;primaryKey"`
IntegratorID string `gorm:"column:integrator_id"`
UserAddress string `gorm:"column:user_address"`
OriginChainID uint64 `gorm:"column:origin_chain_id"`
OriginTokenAddr string `gorm:"column:origin_token"`
DestChainID uint64 `gorm:"column:dest_chain_id"`
DestTokenAddr string `gorm:"column:dest_token"`
OriginAmount decimal.Decimal `gorm:"column:origin_amount"`
ExpirationWindow time.Duration `gorm:"column:expiration_window"`
CreatedAt time.Time `gorm:"column:created_at"`
Status ActiveQuoteRequestStatus `gorm:"column:status"`
ClosedAt *time.Time `gorm:"column:closed_at"`
ClosedQuoteID *string `gorm:"column:closed_quote_id"`
RequestID string `gorm:"column:request_id;primaryKey"`
IntegratorID string `gorm:"column:integrator_id"`
UserAddress string `gorm:"column:user_address"`
OriginChainID uint64 `gorm:"column:origin_chain_id"`
OriginTokenAddr string `gorm:"column:origin_token"`
DestChainID uint64 `gorm:"column:dest_chain_id"`
DestTokenAddr string `gorm:"column:dest_token"`
OriginAmountExact decimal.Decimal `gorm:"column:origin_amount_exact"`
ExpirationWindow time.Duration `gorm:"column:expiration_window"`
CreatedAt time.Time `gorm:"column:created_at"`
Status ActiveQuoteRequestStatus `gorm:"column:status"`
ClosedAt *time.Time `gorm:"column:closed_at"`
ClosedQuoteID *string `gorm:"column:closed_quote_id"`
}

// FromUserRequest converts a model.PutRFQRequest to an ActiveQuoteRequest.
func FromUserRequest(req *model.PutRFQRequest, requestID string) (*ActiveQuoteRequest, error) {
originAmount, err := decimal.NewFromString(req.Data.OriginAmount)
originAmountExact, err := decimal.NewFromString(req.Data.OriginAmountExact)

Check warning on line 162 in services/rfq/api/db/api_db.go

View check run for this annotation

Codecov / codecov/patch

services/rfq/api/db/api_db.go#L162 

Added line #L162 was not covered by tests
if err != nil {
return nil, fmt.Errorf("invalid origin amount: %w", err)
}
return &ActiveQuoteRequest{
RequestID: requestID,
IntegratorID: req.IntegratorID,
UserAddress: req.UserAddress,
OriginChainID: uint64(req.Data.OriginChainID),
OriginTokenAddr: req.Data.OriginTokenAddr,
DestChainID: uint64(req.Data.DestChainID),
DestTokenAddr: req.Data.DestTokenAddr,
OriginAmount: originAmount,
ExpirationWindow: time.Duration(req.Data.ExpirationWindow),
CreatedAt: time.Now(),
Status: Received,
RequestID: requestID,
IntegratorID: req.IntegratorID,
UserAddress: req.UserAddress,
OriginChainID: uint64(req.Data.OriginChainID),
OriginTokenAddr: req.Data.OriginTokenAddr,
DestChainID: uint64(req.Data.DestChainID),
DestTokenAddr: req.Data.DestTokenAddr,
OriginAmountExact: originAmountExact,
ExpirationWindow: time.Duration(req.Data.ExpirationWindow),
CreatedAt: time.Now(),
Status: Received,

Check warning on line 177 in services/rfq/api/db/api_db.go

View check run for this annotation

Codecov / codecov/patch

services/rfq/api/db/api_db.go#L167-L177 

Added lines #L167 - L177 were not covered by tests
}, nil
}

Expand Down
4 changes: 2 additions & 2 deletions services/rfq/api/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ const docTemplate = `{
"expiration_window": {
"type": "integer"
},
"origin_amount": {
"origin_amount_exact": {
"type": "string"
},
"origin_chain_id": {
Expand Down Expand Up @@ -511,7 +511,7 @@ const docTemplate = `{
"expiration_window": {
"type": "integer"
},
"origin_amount": {
"origin_amount_exact": {
"type": "string"
},
"origin_chain_id": {
Expand Down
18 changes: 9 additions & 9 deletions services/rfq/api/model/request.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ type QuoteRequest struct {

// QuoteData represents the data within a quote request.
type QuoteData struct {
OriginChainID int `json:"origin_chain_id"`
DestChainID int `json:"dest_chain_id"`
OriginTokenAddr string `json:"origin_token_addr"`
DestTokenAddr string `json:"dest_token_addr"`
OriginAmount string `json:"origin_amount"`
ExpirationWindow int64 `json:"expiration_window"`
DestAmount *string `json:"dest_amount"`
RelayerAddress *string `json:"relayer_address"`
QuoteID *string `json:"quote_id"`
OriginChainID int `json:"origin_chain_id"`
DestChainID int `json:"dest_chain_id"`
OriginTokenAddr string `json:"origin_token_addr"`
DestTokenAddr string `json:"dest_token_addr"`
OriginAmountExact string `json:"origin_amount_exact"`
ExpirationWindow int64 `json:"expiration_window"`
DestAmount *string `json:"dest_amount"`
RelayerAddress *string `json:"relayer_address"`
QuoteID *string `json:"quote_id"`
}

// WsRFQRequest represents a request for a quote to a relayer.
Expand Down
16 changes: 8 additions & 8 deletions services/rfq/api/model/response.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,12 @@ type SubscriptionParams struct {

// GetOpenQuoteRequestsResponse represents a response to a GET /open_quote_requests request.
type GetOpenQuoteRequestsResponse struct {
UserAddress string `json:"user_address"`
OriginChainID uint64 `json:"origin_chain_id"`
OriginTokenAddr string `json:"origin_token"`
DestChainID uint64 `json:"dest_chain_id"`
DestTokenAddr string `json:"dest_token"`
OriginAmount string `json:"origin_amount"`
ExpirationWindow int `json:"expiration_window"`
CreatedAt time.Time `json:"created_at"`
UserAddress string `json:"user_address"`
OriginChainID uint64 `json:"origin_chain_id"`
OriginTokenAddr string `json:"origin_token"`
DestChainID uint64 `json:"dest_chain_id"`
DestTokenAddr string `json:"dest_token"`
OriginAmountExact string `json:"origin_amount_exact"`
ExpirationWindow int `json:"expiration_window"`
CreatedAt time.Time `json:"created_at"`
Comment on lines +82 to +89
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Breaking change detected in API response field

The field OriginAmountExact in GetOpenQuoteRequestsResponse struct is using json:"origin_amount_exact" while the client code and existing implementations are using "origin_amount". This mismatch will break API compatibility.

  • services/rfq/api/model/response.go: Change the JSON tag from origin_amount_exact to origin_amount to maintain backward compatibility
  • contrib/restclient/client.gen.go: Client code expects origin_amount in the response
  • Multiple services are using origin_amount in their logging and processing: services/rfq/util/util.go, services/rfq/relayer/quoter/quoter.go, etc.
🔗 Analysis chain

Semantic improvement but potential breaking change

The renaming from OriginAmount to OriginAmountExact better reflects the precise nature of deposit amounts in the ActiveQuoting system. However, this change might affect existing API clients.

Let's verify the impact on API clients:

Let me gather more context about the JSON field usage to understand the full impact.

Let me check the RFQ API swagger documentation to understand the API contract.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for direct references to the old JSON field name
rg -l 'origin_amount"' --type go

# Search for struct field usage
ast-grep --pattern 'OriginAmount'

Length of output: 2794

Script:

#!/bin/bash
# Check the actual JSON field usage in the codebase
rg '"origin_amount"' -A 2 -B 2 --type go

# Check for any API documentation or OpenAPI specs
fd swagger.json
fd openapi.yaml

Length of output: 2919

Script:

#!/bin/bash
# Check the RFQ API swagger documentation
cat services/rfq/api/docs/swagger.json | jq '.paths[][] | select(.description != null) | .description'

# Look for the field in the actual response struct implementation
rg -A 5 -B 5 'GetOpenQuoteRequestsResponse struct' --type go

Length of output: 2899

}
16 changes: 8 additions & 8 deletions services/rfq/api/rest/handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,14 +278,14 @@ func (h *Handler) GetOpenQuoteRequests(c *gin.Context) {

func dbActiveQuoteRequestToModel(dbQuote *db.ActiveQuoteRequest) *model.GetOpenQuoteRequestsResponse {
return &model.GetOpenQuoteRequestsResponse{
UserAddress: dbQuote.UserAddress,
OriginChainID: dbQuote.OriginChainID,
OriginTokenAddr: dbQuote.OriginTokenAddr,
DestChainID: dbQuote.DestChainID,
DestTokenAddr: dbQuote.DestTokenAddr,
OriginAmount: dbQuote.OriginAmount.String(),
ExpirationWindow: int(dbQuote.ExpirationWindow.Milliseconds()),
CreatedAt: dbQuote.CreatedAt,
UserAddress: dbQuote.UserAddress,
OriginChainID: dbQuote.OriginChainID,
OriginTokenAddr: dbQuote.OriginTokenAddr,
DestChainID: dbQuote.DestChainID,
DestTokenAddr: dbQuote.DestTokenAddr,
OriginAmountExact: dbQuote.OriginAmountExact.String(),
ExpirationWindow: int(dbQuote.ExpirationWindow.Milliseconds()),
CreatedAt: dbQuote.CreatedAt,
}
}

Expand Down
32 changes: 16 additions & 16 deletions services/rfq/api/rest/rfq.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,13 @@

func getRelayerQuoteData(request *model.PutRFQRequest, resp *model.WsRFQResponse) *model.QuoteData {
return &model.QuoteData{
OriginChainID: request.Data.OriginChainID,
DestChainID: request.Data.DestChainID,
OriginTokenAddr: request.Data.OriginTokenAddr,
DestTokenAddr: request.Data.DestTokenAddr,
OriginAmount: request.Data.OriginAmount,
DestAmount: &resp.DestAmount,
QuoteID: &resp.QuoteID,
OriginChainID: request.Data.OriginChainID,
DestChainID: request.Data.DestChainID,
OriginTokenAddr: request.Data.OriginTokenAddr,
DestTokenAddr: request.Data.DestTokenAddr,
OriginAmountExact: request.Data.OriginAmountExact,
DestAmount: &resp.DestAmount,
QuoteID: &resp.QuoteID,
}
}

Expand Down Expand Up @@ -226,9 +226,9 @@
return nil, fmt.Errorf("failed to get quotes: %w", err)
}

originAmount, ok := new(big.Int).SetString(request.Data.OriginAmount, 10)
originAmount, ok := new(big.Int).SetString(request.Data.OriginAmountExact, 10)
if !ok {
return nil, errors.New("invalid origin amount")
return nil, errors.New("invalid origin amount exact")

Check warning on line 231 in services/rfq/api/rest/rfq.go

View check run for this annotation

Codecov / codecov/patch

services/rfq/api/rest/rfq.go#L231 

Added line #L231 was not covered by tests
}

var bestQuote *model.QuoteData
Expand Down Expand Up @@ -257,13 +257,13 @@
destAmount := new(big.Int).Sub(rawDestAmountInt, quote.FixedFee.BigInt()).String()
//nolint:gosec
quoteData := &model.QuoteData{
OriginChainID: int(quote.OriginChainID),
DestChainID: int(quote.DestChainID),
OriginTokenAddr: quote.OriginTokenAddr,
DestTokenAddr: quote.DestTokenAddr,
OriginAmount: quote.MaxOriginAmount.String(),
DestAmount: &destAmount,
RelayerAddress: &quote.RelayerAddr,
OriginChainID: int(quote.OriginChainID),
DestChainID: int(quote.DestChainID),
OriginTokenAddr: quote.OriginTokenAddr,
DestTokenAddr: quote.DestTokenAddr,
OriginAmountExact: quote.MaxOriginAmount.String(),
DestAmount: &destAmount,
RelayerAddress: &quote.RelayerAddr,
}
bestQuote = getBestQuote(bestQuote, quoteData)
}
Expand Down
62 changes: 31 additions & 31 deletions services/rfq/api/rest/rfq_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ func verifyActiveQuoteRequest(c *ServerSuite, userReq *model.PutRFQRequest, acti
c.Assert().Equal(userReq.Data.OriginTokenAddr, activeQuoteRequest.OriginTokenAddr)
c.Assert().Equal(uint64(userReq.Data.DestChainID), activeQuoteRequest.DestChainID)
c.Assert().Equal(userReq.Data.DestTokenAddr, activeQuoteRequest.DestTokenAddr)
c.Assert().Equal(userReq.Data.OriginAmount, activeQuoteRequest.OriginAmount.String())
c.Assert().Equal(userReq.Data.OriginAmountExact, activeQuoteRequest.OriginAmountExact.String())
c.Assert().Equal(status, activeQuoteRequest.Status)
}

Expand All @@ -92,12 +92,12 @@ func (c *ServerSuite) TestActiveRFQSingleRelayer() {
userRequestAmount := big.NewInt(1_000_000)
userQuoteReq := &model.PutRFQRequest{
Data: model.QuoteData{
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmount: userRequestAmount.String(),
ExpirationWindow: 10_000,
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmountExact: userRequestAmount.String(),
ExpirationWindow: 10_000,
},
QuoteTypes: []string{"active"},
}
Expand Down Expand Up @@ -143,12 +143,12 @@ func (c *ServerSuite) TestActiveRFQExpiredRequest() {
userRequestAmount := big.NewInt(1_000_000)
userQuoteReq := &model.PutRFQRequest{
Data: model.QuoteData{
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmount: userRequestAmount.String(),
ExpirationWindow: 0,
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmountExact: userRequestAmount.String(),
ExpirationWindow: 0,
},
QuoteTypes: []string{"active"},
}
Expand Down Expand Up @@ -193,12 +193,12 @@ func (c *ServerSuite) TestActiveRFQMultipleRelayers() {
userRequestAmount := big.NewInt(1_000_000)
userQuoteReq := &model.PutRFQRequest{
Data: model.QuoteData{
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmount: userRequestAmount.String(),
ExpirationWindow: 10_000,
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmountExact: userRequestAmount.String(),
ExpirationWindow: 10_000,
},
QuoteTypes: []string{"active"},
}
Expand Down Expand Up @@ -276,12 +276,12 @@ func (c *ServerSuite) TestActiveRFQFallbackToPassive() {
// Prepare user quote request with 0 expiration window
userQuoteReq := &model.PutRFQRequest{
Data: model.QuoteData{
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmount: userRequestAmount.String(),
ExpirationWindow: 0,
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmountExact: userRequestAmount.String(),
ExpirationWindow: 0,
},
QuoteTypes: []string{"active", "passive"},
}
Expand Down Expand Up @@ -346,12 +346,12 @@ func (c *ServerSuite) TestActiveRFQPassiveBestQuote() {
// Prepare user quote request with 0 expiration window
userQuoteReq := &model.PutRFQRequest{
Data: model.QuoteData{
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmount: userRequestAmount.String(),
ExpirationWindow: 0,
OriginChainID: c.originChainID,
OriginTokenAddr: originTokenAddr,
DestChainID: c.destChainID,
DestTokenAddr: destTokenAddr,
OriginAmountExact: userRequestAmount.String(),
ExpirationWindow: 0,
},
QuoteTypes: []string{"active", "passive"},
}
Expand Down
36 changes: 18 additions & 18 deletions services/rfq/api/rest/server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,32 +209,32 @@ func (c *ServerSuite) TestGetOpenQuoteRequests() {
testRequests := []*model.PutRFQRequest{
{
Data: model.QuoteData{
OriginChainID: 1,
DestChainID: 42161,
OriginTokenAddr: "0xOriginTokenAddr",
DestTokenAddr: "0xDestTokenAddr",
OriginAmount: "100.0",
ExpirationWindow: 100,
OriginChainID: 1,
DestChainID: 42161,
OriginTokenAddr: "0xOriginTokenAddr",
DestTokenAddr: "0xDestTokenAddr",
OriginAmountExact: "100.0",
ExpirationWindow: 100,
},
},
{
Data: model.QuoteData{
OriginChainID: 1,
DestChainID: 42161,
OriginTokenAddr: "0xOriginTokenAddr",
DestTokenAddr: "0xDestTokenAddr",
OriginAmount: "100.0",
ExpirationWindow: 100,
OriginChainID: 1,
DestChainID: 42161,
OriginTokenAddr: "0xOriginTokenAddr",
DestTokenAddr: "0xDestTokenAddr",
OriginAmountExact: "100.0",
ExpirationWindow: 100,
},
},
{
Data: model.QuoteData{
OriginChainID: 1,
DestChainID: 42161,
OriginTokenAddr: "0xOriginTokenAddr",
DestTokenAddr: "0xDestTokenAddr",
OriginAmount: "100.0",
ExpirationWindow: 100,
OriginChainID: 1,
DestChainID: 42161,
OriginTokenAddr: "0xOriginTokenAddr",
DestTokenAddr: "0xDestTokenAddr",
OriginAmountExact: "100.0",
ExpirationWindow: 100,
},
},
}
Expand Down
Loading
Loading
0