feat(solver): add quote endpoint and fee (#3120)

Add quote endpoint and a 30 bip fee.

issue: none

Author: kevinhalliday

lib/contracts/solvernet/types.go

@@ -60,7 +60,7 @@ func (s OrderStatus) Uint8() uint8 {
 	return uint8(s)
 }
 
-// Expense is a solver expense on the destination (matches bindings.SolverNetExpense).
+// Expense is a solver expense on the destination (matches bindings.SolverNetTokenExpense).
 type Expense struct {
 	Spender common.Address `json:"spender"`
 	Token   common.Address `json:"token"`

solver/app/app.go

@@ -115,6 +115,7 @@ func Run(ctx context.Context, cfg Config) error {
 
 	log.Info(ctx, "Serving API", "address", cfg.APIAddr)
 	apiChan := serveAPI(cfg.APIAddr, map[string]http.Handler{
+		"/api/v1/quote":     newQuoteHandler(quoter),
 		"/api/v1/check":     newCheckHandler(newChecker(backends, solverAddr, addrs.SolverNetInbox, addrs.SolverNetOutbox)),
 		"/api/v1/contracts": newContractsHandler(addrs),
 	})

solver/app/check.go

@@ -103,7 +103,7 @@ func getNextOrderID(ctx context.Context, client ethclient.Client, inboxAddr comm
 	return orderID, nil
 }
 
-// getFillOriginData returns packed fill origin data for a quote request.
+// getFillOriginData returns packed fill origin data for a check request.
 func getFillOriginData(req CheckRequest) ([]byte, error) {
 	fillOriginData := bindings.SolverNetFillOriginData{
 		FillDeadline: req.FillDeadline,
@@ -121,17 +121,17 @@ func getFillOriginData(req CheckRequest) ([]byte, error) {
 	return fillOriginDataBz, nil
 }
 
-// newCheckHandler returns a handler for the /quote endpoint.
-// It is responsible to http request / response handling, and delegates
-// logic to a quoteFunc.
+// newCheckHandler returns a handler for the /check endpoint.
+// It is responsible for http request / response handling, and delegates
+// logic to a checkFunc.
 func newCheckHandler(checkFunc checkFunc) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, rr *http.Request) {
 		ctx := rr.Context()
 
 		w.Header().Set("Content-Type", "application/json")
 
 		writeError := func(statusCode int, err error) {
-			log.DebugErr(ctx, "Error handling /quote request", err)
+			log.DebugErr(ctx, "Error handling /check request", err)
 
 			writeJSON(ctx, w, CheckResponse{
 				Error: &JSONErrorResponse{
@@ -163,42 +163,6 @@ func newCheckHandler(checkFunc checkFunc) http.Handler {
 	})
 }
 
-// getQuote returns payment in `depositTkns` required to pay for `expenses`.
-//
-// For now, this is a simple quote that requires a single expense, paid
-// for by an equal amount of an equivalent deposit token. Token equivalence is
-// determined by symbol (ex arbitrum "ETH" is equivalent to optimism "ETH").
-func getQuote(depositTkns []Token, expenses []Payment) ([]Payment, error) {
-	if len(depositTkns) != 1 {
-		return nil, newRejection(rejectInvalidDeposit, errors.New("only single deposit token supported"))
-	}
-
-	if len(expenses) != 1 {
-		return nil, newRejection(rejectInvalidExpense, errors.New("only single expense supported"))
-	}
-
-	expense := expenses[0]
-	depositTkn := depositTkns[0]
-
-	if expense.Token.Symbol != depositTkn.Symbol {
-		return nil, newRejection(rejectInvalidDeposit, errors.New("deposit token must match expense token"))
-	}
-
-	// make sure chain class (e.g. mainnet, testnet) matches
-	// we should reject with UnsupportedDestChain before this. the solver is
-	// initialized by network, which only includes chains of the same class
-	if expense.Token.ChainClass != depositTkn.ChainClass {
-		return nil, newRejection(rejectInvalidDeposit, errors.New("deposit and expense must be of the same chain class (e.g. mainnet, testnet)"))
-	}
-
-	return []Payment{
-		{
-			Token:  depositTkn,
-			Amount: expense.Amount,
-		},
-	}, nil
-}
-
 // coversQuote checks if `deposits` match or exceed a `quote` for expenses.
 func coversQuote(deposits, quote []Payment) error {
 	byTkn := func(ps []Payment) map[Token]*big.Int {

solver/app/check_internal_test.go

@@ -49,7 +49,7 @@ func TestCheck(t *testing.T) {
 			require.NoError(t, err)
 
 			ctx := context.Background()
-			req, err := http.NewRequestWithContext(ctx, http.MethodPost, "api/v1/quote", bytes.NewBuffer(body))
+			req, err := http.NewRequestWithContext(ctx, http.MethodPost, "api/v1/check", bytes.NewBuffer(body))
 			require.NoError(t, err)
 
 			rr := httptest.NewRecorder()

solver/app/internal_testutils.go

@@ -192,23 +192,7 @@ func rejectTestCases(t *testing.T, solver, outbox common.Address) []rejectTestCa
 		tests = append(tests, toRejectTestCase(t, tt, outbox))
 	}
 
-	// not shared with quote
-	additional := []rejectTestCase{
-		toRejectTestCase(t, orderTestCase{
-			name:   "insufficient deposit",
-			reason: rejectInsufficientDeposit,
-			reject: true,
-			order: testOrder{
-				srcChainID: evmchain.IDBaseSepolia,
-				dstChainID: evmchain.IDHolesky,
-				deposits:   []Deposit{{Amount: big.NewInt(1)}},
-				calls:      []Call{{Value: big.NewInt(2)}},
-				expenses:   []Expense{{Amount: big.NewInt(2)}},
-			},
-		}, outbox),
-	}
-
-	return append(tests, additional...)
+	return tests
 }
 
 func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
@@ -225,12 +209,12 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 				// request 1 native OMNI for 1 erc20 OMNI on omega
 				srcChainID: evmchain.IDHolesky,
 				dstChainID: evmchain.IDOmniOmega,
-				deposits:   []Deposit{{Amount: big.NewInt(1), Token: omegaOMNIAddr}},
-				calls:      []Call{{Value: big.NewInt(1)}},
-				expenses:   []Expense{{Amount: big.NewInt(1)}},
+				deposits:   []Deposit{{Amount: ether(1), Token: omegaOMNIAddr}},
+				calls:      []Call{{Value: ether(1)}},
+				expenses:   []Expense{{Amount: ether(1)}},
 			},
 			mock: func(clients MockClients) {
-				mockNativeBalance(t, clients.Client(t, evmchain.IDOmniOmega), solver, big.NewInt(0))
+				mockNativeBalance(t, clients.Client(t, evmchain.IDOmniOmega), solver, ether(0))
 			},
 		},
 		{
@@ -241,12 +225,13 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 				// request 1 native OMNI for 1 erc20 OMNI on omega
 				srcChainID: evmchain.IDHolesky,
 				dstChainID: evmchain.IDOmniOmega,
-				deposits:   []Deposit{{Amount: big.NewInt(1), Token: omegaOMNIAddr}},
-				calls:      []Call{{Value: big.NewInt(1)}},
-				expenses:   []Expense{{Amount: big.NewInt(1)}},
+				// OMNI does not require fee
+				deposits: []Deposit{{Amount: ether(1), Token: omegaOMNIAddr}},
+				calls:    []Call{{Value: ether(1)}},
+				expenses: []Expense{{Amount: ether(1)}},
 			},
 			mock: func(clients MockClients) {
-				mockNativeBalance(t, clients.Client(t, evmchain.IDOmniOmega), solver, big.NewInt(1))
+				mockNativeBalance(t, clients.Client(t, evmchain.IDOmniOmega), solver, ether(1))
 			},
 		},
 		{
@@ -257,11 +242,11 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 				// request 1 erc20 OMNI for 1 native OMNI on omega
 				srcChainID: evmchain.IDOmniOmega,
 				dstChainID: evmchain.IDHolesky,
-				deposits:   []Deposit{{Amount: big.NewInt(1)}},
-				expenses:   []Expense{{Amount: big.NewInt(1), Token: omegaOMNIAddr}},
+				deposits:   []Deposit{{Amount: ether(1)}},
+				expenses:   []Expense{{Amount: ether(1), Token: omegaOMNIAddr}},
 			},
 			mock: func(clients MockClients) {
-				mockERC20Balance(t, clients.Client(t, evmchain.IDHolesky), omegaOMNIAddr, big.NewInt(0))
+				mockERC20Balance(t, clients.Client(t, evmchain.IDHolesky), omegaOMNIAddr, ether(0))
 			},
 		},
 		{
@@ -272,11 +257,12 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 				// request 1 erc20 OMNI for 1 native OMNI on omega
 				srcChainID: evmchain.IDOmniOmega,
 				dstChainID: evmchain.IDHolesky,
-				deposits:   []Deposit{{Amount: big.NewInt(1)}},
-				expenses:   []Expense{{Amount: big.NewInt(1), Token: omegaOMNIAddr}},
+				// OMNI does not require fee
+				deposits: []Deposit{{Amount: ether(1)}},
+				expenses: []Expense{{Amount: ether(1), Token: omegaOMNIAddr}},
 			},
 			mock: func(clients MockClients) {
-				mockERC20Balance(t, clients.Client(t, evmchain.IDHolesky), omegaOMNIAddr, big.NewInt(1))
+				mockERC20Balance(t, clients.Client(t, evmchain.IDHolesky), omegaOMNIAddr, ether(1))
 				mockERC20Allowance(t, clients.Client(t, evmchain.IDHolesky), omegaOMNIAddr)
 			},
 		},
@@ -291,11 +277,11 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 				// request 1 erc20 OMNI for 1 native OMNI on omega
 				srcChainID: evmchain.IDOmniOmega,
 				dstChainID: evmchain.IDHolesky,
-				deposits:   []Deposit{{Amount: big.NewInt(1)}},
-				expenses:   []Expense{{Amount: big.NewInt(1), Token: omegaOMNIAddr}},
+				deposits:   []Deposit{{Amount: ether(1)}},
+				expenses:   []Expense{{Amount: ether(1), Token: omegaOMNIAddr}},
 			},
 			mock: func(clients MockClients) {
-				mockERC20Balance(t, clients.Client(t, evmchain.IDHolesky), omegaOMNIAddr, big.NewInt(1))
+				mockERC20Balance(t, clients.Client(t, evmchain.IDHolesky), omegaOMNIAddr, ether(1))
 				mockERC20Allowance(t, clients.Client(t, evmchain.IDHolesky), omegaOMNIAddr)
 			},
 		},
@@ -306,8 +292,8 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 			order: testOrder{
 				srcChainID: evmchain.IDOmniOmega,
 				dstChainID: evmchain.IDHolesky,
-				deposits:   []Deposit{{Amount: big.NewInt(1)}},
-				expenses:   []Expense{{Amount: big.NewInt(1), Token: common.HexToAddress("0x01")}},
+				deposits:   []Deposit{{Amount: ether(1)}},
+				expenses:   []Expense{{Amount: ether(1), Token: common.HexToAddress("0x01")}},
 			},
 		},
 		{
@@ -326,9 +312,9 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 			order: testOrder{
 				srcChainID: evmchain.IDHolesky,
 				dstChainID: evmchain.IDOmniOmega,
-				deposits:   []Deposit{{Amount: big.NewInt(1)}},
-				calls:      []Call{{Value: big.NewInt(1)}},
-				expenses:   []Expense{{Amount: big.NewInt(1)}},
+				deposits:   []Deposit{{Amount: ether(1)}},
+				calls:      []Call{{Value: ether(1)}},
+				expenses:   []Expense{{Amount: ether(1)}},
 			},
 		},
 		{
@@ -339,10 +325,10 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 				srcChainID: evmchain.IDHolesky,
 				dstChainID: evmchain.IDBaseSepolia,
 				// wstETH on holesky
-				deposits: []Deposit{{Amount: big.NewInt(1), Token: common.HexToAddress("0x8d09a4502cc8cf1547ad300e066060d043f6982d")}},
+				deposits: []Deposit{{Amount: ether(1), Token: common.HexToAddress("0x8d09a4502cc8cf1547ad300e066060d043f6982d")}},
 				// native eth on base
-				calls:    []Call{{Value: big.NewInt(1)}},
-				expenses: []Expense{{Amount: big.NewInt(1)}},
+				calls:    []Call{{Value: ether(1)}},
+				expenses: []Expense{{Amount: ether(1)}},
 			},
 		},
 		{
@@ -352,9 +338,9 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 			order: testOrder{
 				srcChainID: evmchain.IDHolesky,
 				dstChainID: evmchain.IDOmniOmega,
-				deposits:   []Deposit{{Amount: big.NewInt(1), Token: omegaOMNIAddr}, {Amount: big.NewInt(1)}},
-				calls:      []Call{{Value: big.NewInt(1)}},
-				expenses:   []Expense{{Amount: big.NewInt(1)}},
+				deposits:   []Deposit{{Amount: ether(1), Token: omegaOMNIAddr}, {Amount: ether(1)}},
+				calls:      []Call{{Value: ether(1)}},
+				expenses:   []Expense{{Amount: ether(1)}},
 			},
 		},
 		{
@@ -364,9 +350,9 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 			order: testOrder{
 				srcChainID: evmchain.IDHolesky,
 				dstChainID: evmchain.IDOptimism,
-				deposits:   []Deposit{{Amount: big.NewInt(1)}},
-				calls:      []Call{{Value: big.NewInt(1)}},
-				expenses:   []Expense{{Amount: big.NewInt(1)}},
+				deposits:   []Deposit{{Amount: ether(1)}},
+				calls:      []Call{{Value: ether(1)}},
+				expenses:   []Expense{{Amount: ether(1)}},
 			},
 		},
 		{
@@ -376,14 +362,59 @@ func orderTestCases(t *testing.T, solver common.Address) []orderTestCase {
 			order: testOrder{
 				srcChainID: evmchain.IDOmniOmega,
 				dstChainID: evmchain.IDHolesky,
-				deposits:   []Deposit{{Amount: big.NewInt(2)}},
-				calls:      []Call{{Value: big.NewInt(1)}},
+				deposits:   []Deposit{{Amount: ether(2)}},
+				calls:      []Call{{Value: ether(1)}},
 				expenses: []Expense{
-					{Amount: big.NewInt(1)},
-					{Amount: big.NewInt(1), Token: common.HexToAddress("0x8d09a4502cc8cf1547ad300e066060d043f6982d")},
+					{Amount: ether(1)},
+					{Amount: ether(1), Token: common.HexToAddress("0x8d09a4502cc8cf1547ad300e066060d043f6982d")},
 				},
 			},
 		},
+		{
+			name:   "insufficient deposit",
+			reason: rejectInsufficientDeposit,
+			reject: true,
+			order: testOrder{
+				srcChainID: evmchain.IDBaseSepolia,
+				dstChainID: evmchain.IDHolesky,
+				// does not include fee
+				deposits: []Deposit{{Amount: ether(1)}},
+				calls:    []Call{{Value: ether(1)}},
+				expenses: []Expense{{Amount: ether(1)}},
+			},
+		},
+		{
+			name: "sufficient deposit",
+			order: testOrder{
+				srcChainID: evmchain.IDBaseSepolia,
+				dstChainID: evmchain.IDHolesky,
+				// includes fee
+				deposits: []Deposit{{Amount: depositFor(ether(1), standardFeeBips)}},
+				calls:    []Call{{Value: ether(1)}},
+				expenses: []Expense{{Amount: ether(1)}},
+			},
+			mock: func(clients MockClients) {
+				mockNativeBalance(t, clients.Client(t, evmchain.IDHolesky), solver, ether(1))
+			},
+		},
+		{
+			name: "more than sufficient deposit",
+			order: testOrder{
+				srcChainID: evmchain.IDBaseSepolia,
+				dstChainID: evmchain.IDHolesky,
+				deposits: []Deposit{{
+					Amount: new(big.Int).Add(
+						depositFor(ether(1), standardFeeBips), // required deposit
+						gwei(1),                               // a little more
+					),
+				}},
+				calls:    []Call{{Value: ether(1)}},
+				expenses: []Expense{{Amount: ether(1)}},
+			},
+			mock: func(clients MockClients) {
+				mockNativeBalance(t, clients.Client(t, evmchain.IDHolesky), solver, ether(2))
+			},
+		},
 	}
 }
 
@@ -641,3 +672,11 @@ func mustGetABI(metadata *bind.MetaData) *abi.ABI {
 
 	return abi
 }
+
+func ether(x int64) *big.Int {
+	return new(big.Int).Mul(big.NewInt(x), big.NewInt(1e18))
+}
+
+func gwei(x int64) *big.Int {
+	return new(big.Int).Mul(big.NewInt(x), big.NewInt(1e9))
+}