Merge pull request #5833 from ethereum-optimism/willc/go-chi

feat(indexer): Add go-chi api

indexer/api/api.go

+package api
+
+import (
+	"encoding/json"
+	"log"
+	"net/http"
+
+	"github.com/ethereum-optimism/optimism/indexer/database"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/go-chi/chi"
+)
+
+type PaginationResponse struct {
+	// TODO type this better
+	Data        interface{} `json:"data"`
+	Cursor      string      `json:"cursor"`
+	HasNextPage bool        `json:"hasNextPage"`
+}
+
+func (a *Api) DepositsHandler(w http.ResponseWriter, r *http.Request) {
+	bv := a.bridgeView
+
+	address := common.HexToAddress(chi.URLParam(r, "address"))
+
+	// limit := getIntFromQuery(r, "limit", 10)
+	// cursor := r.URL.Query().Get("cursor")
+	// sortDirection := r.URL.Query().Get("sortDirection")
+
+	deposits, err := bv.DepositsByAddress(address)
+
+	if err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+
+	// This is not the shape of the response we want!!!
+	// will add in the individual features in future prs 1 by 1
+	response := PaginationResponse{
+		Data: deposits,
+		// Cursor:      nextCursor,
+		HasNextPage: false,
+	}
+
+	jsonResponse(w, response, http.StatusOK)
+}
+
+func (a *Api) WithdrawalsHandler(w http.ResponseWriter, r *http.Request) {
+	bv := a.bridgeView
+
+	address := common.HexToAddress(chi.URLParam(r, "address"))
+
+	// limit := getIntFromQuery(r, "limit", 10)
+	// cursor := r.URL.Query().Get("cursor")
+	// sortDirection := r.URL.Query().Get("sortDirection")
+
+	withdrawals, err := bv.WithdrawalsByAddress(address)
+
+	if err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+
+	// This is not the shape of the response we want!!!
+	// will add in the individual features in future prs 1 by 1
+	response := PaginationResponse{
+		Data: withdrawals,
+		// Cursor:      nextCursor,
+		HasNextPage: false,
+	}
+
+	jsonResponse(w, response, http.StatusOK)
+}
+
+func jsonResponse(w http.ResponseWriter, data interface{}, statusCode int) {
+	w.Header().Set("Content-Type", "application/json")
+	w.WriteHeader(statusCode)
+	if err := json.NewEncoder(w).Encode(data); err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+	}
+}
+
+type Api struct {
+	Router     *chi.Mux
+	bridgeView database.BridgeView
+}
+
+func NewApi(bv database.BridgeView) *Api {
+	r := chi.NewRouter()
+
+	api := &Api{
+		Router:     r,
+		bridgeView: bv,
+	}
+	// these regex are .+ because I wasn't sure what they should be
+	// don't want a regex for addresses because would prefer to validate the address
+	// with go-ethereum and throw a friendly error message
+	r.Get("/api/v0/deposits/{address:.+}", api.DepositsHandler)
+	r.Get("/api/v0/withdrawals/{address:.+}", api.WithdrawalsHandler)
+
+	return api
+
+}
+
+func (a *Api) Listen(port string) {
+	err := http.ListenAndServe(port, a.Router)
+	if err != nil {
+		log.Fatal("Http server failed to start listening", err)
+	}
+}

indexer/api/api_test.go

+package api
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/ethereum-optimism/optimism/indexer/database"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/stretchr/testify/assert"
+)
+
+// MockBridgeView mocks the BridgeView interface
+type MockBridgeView struct{}
+
+// DepositsByAddress mocks returning deposits by an address
+func (mbv *MockBridgeView) DepositsByAddress(address common.Address) ([]*database.DepositWithTransactionHash, error) {
+	return []*database.DepositWithTransactionHash{
+		{
+			Deposit: database.Deposit{
+				GUID:                 "mockGUID1",
+				InitiatedL1EventGUID: "mockEventGUID1",
+				Tx:                   database.Transaction{},
+				TokenPair:            database.TokenPair{},
+			},
+			L1TransactionHash: common.HexToHash("0x123"),
+		},
+	}, nil
+}
+
+// WithdrawalsByAddress mocks returning withdrawals by an address
+func (mbv *MockBridgeView) WithdrawalsByAddress(address common.Address) ([]*database.WithdrawalWithTransactionHashes, error) {
+	return []*database.WithdrawalWithTransactionHashes{
+		{
+			Withdrawal: database.Withdrawal{
+				GUID:                 "mockGUID2",
+				InitiatedL2EventGUID: "mockEventGUID2",
+				WithdrawalHash:       common.HexToHash("0x456"),
+				Tx:                   database.Transaction{},
+				TokenPair:            database.TokenPair{},
+			},
+			L2TransactionHash: common.HexToHash("0x789"),
+		},
+	}, nil
+}
+
+func TestDepositsHandler(t *testing.T) {
+	api := NewApi(&MockBridgeView{})
+	request, err := http.NewRequest("GET", "/api/v0/deposits/0x123", nil)
+	assert.Nil(t, err)
+
+	responseRecorder := httptest.NewRecorder()
+	api.Router.ServeHTTP(responseRecorder, request)
+
+	assert.Equal(t, http.StatusOK, responseRecorder.Code)
+}
+
+func TestWithdrawalsHandler(t *testing.T) {
+	api := NewApi(&MockBridgeView{})
+	request, err := http.NewRequest("GET", "/api/v0/withdrawals/0x123", nil)
+	assert.Nil(t, err)
+
+	responseRecorder := httptest.NewRecorder()
+	api.Router.ServeHTTP(responseRecorder, request)
+
+	assert.Equal(t, http.StatusOK, responseRecorder.Code)
+}

indexer/go.mod

@@ -5,8 +5,10 @@ go 1.19
 replace github.com/ethereum/go-ethereum v1.11.4 => github.com/ethereum-optimism/op-geth v1.11.2-de8c5df46.0.20230321002540-11f0554a4313
 
 require (
+	github.com/BurntSushi/toml v1.3.0
 	github.com/ethereum-optimism/optimism v0.2.1-0.20230326215719-b8e2fa58359a
 	github.com/ethereum/go-ethereum v1.11.4
+	github.com/go-chi/chi v1.5.4
 	github.com/google/uuid v1.3.0
 	github.com/gorilla/mux v1.8.0
 	github.com/lib/pq v1.10.4
@@ -17,7 +19,6 @@ require (
 )
 
 require (
-	github.com/BurntSushi/toml v1.3.0 // indirect
 	github.com/DataDog/zstd v1.5.2 // indirect
 	github.com/VictoriaMetrics/fastcache v1.10.0 // indirect
 	github.com/benbjohnson/clock v1.3.0 // indirect

indexer/go.sum

@@ -221,6 +221,8 @@ github.com/gliderlabs/ssh v0.1.1/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aev
 github.com/glycerine/go-unsnap-stream v0.0.0-20180323001048-9f0cb55181dd/go.mod h1:/20jfyN9Y5QPEAprSgKAUr+glWDY39ZiUEAYOEv5dsE=
 github.com/glycerine/goconvey v0.0.0-20190410193231-58a59202ab31/go.mod h1:Ogl1Tioa0aV7gstGFO7KhffUsb9M4ydbEbbxpcEDc24=
 github.com/go-check/check v0.0.0-20180628173108-788fd7840127/go.mod h1:9ES+weclKsC9YodN5RgxqK/VD9HM9JsCSh7rNhMZE98=
+github.com/go-chi/chi v1.5.4 h1:QHdzF2szwjqVV4wmByUnTcsbIg7UGaQ0tPF2t5GcAIs=
+github.com/go-chi/chi v1.5.4/go.mod h1:uaf8YgoFazUOkPBG7fxPftUylNumIev9awIWOENIuEg=
 github.com/go-chi/chi/v5 v5.0.0/go.mod h1:BBug9lr0cqtdAhsu6R4AAdvufI0/XBzAQSsUqJpoZOs=
 github.com/go-errors/errors v1.0.1/go.mod h1:f4zRHt4oKfwPJE5k8C9vpYG+aDHdBFUsgrm6/TyX73Q=
 github.com/go-errors/errors v1.4.2 h1:J6MZopCL4uSllY1OfXM374weqZFFItUbrImctkmUxIA=