server.go 17.2 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
package api

import (
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"math/big"
	"net"
	"net/http"
	"os"
	"os/signal"
	"strconv"
	"sync"
	"syscall"
	"time"

	bsscore "github.com/ethereum-optimism/optimism/bss-core"
	"github.com/ethereum-optimism/optimism/bss-core/dial"
	"github.com/ethereum-optimism/optimism/bss-core/drivers"
	"github.com/ethereum-optimism/optimism/bss-core/metrics"
	"github.com/ethereum-optimism/optimism/bss-core/txmgr"
	"github.com/ethereum-optimism/optimism/teleportr/bindings/deposit"
	"github.com/ethereum-optimism/optimism/teleportr/bindings/disburse"
	"github.com/ethereum-optimism/optimism/teleportr/db"
	"github.com/ethereum-optimism/optimism/teleportr/flags"
	"github.com/ethereum/go-ethereum"
	"github.com/ethereum/go-ethereum/common"
	"github.com/ethereum/go-ethereum/ethclient"
	"github.com/ethereum/go-ethereum/log"
	"github.com/google/uuid"
	"github.com/gorilla/mux"
	"github.com/prometheus/client_golang/prometheus"
	"github.com/rs/cors"
	"github.com/urfave/cli"
)

type ContextKey string

const (
	ContextKeyReqID ContextKey = "req_id"

	MaxLagBeforeUnavailable = 10
)

func Main(gitVersion string) func(*cli.Context) error {
	return func(cliCtx *cli.Context) error {
		cfg, err := NewConfig(cliCtx)
		if err != nil {
			return err
		}

		ctx, cancel := context.WithCancel(context.Background())
		defer cancel()

		depositAddr, err := bsscore.ParseAddress(cfg.DepositAddress)
		if err != nil {
			return err
		}

		disburserWalletAddr, err := bsscore.ParseAddress(cfg.DisburserWalletAddress)
		if err != nil {
			return err
		}

		disburserAddr, err := bsscore.ParseAddress(cfg.DisburserAddress)
		if err != nil {
			return err
		}

		l1Client, err := dial.L1EthClientWithTimeout(
			ctx, cfg.L1EthRpc, cfg.DisableHTTP2,
		)
		if err != nil {
			return err
		}
		defer l1Client.Close()

		l2Client, err := dial.L1EthClientWithTimeout(
			ctx, cfg.L2EthRpc, cfg.DisableHTTP2,
		)
		if err != nil {
			return err
		}
		defer l2Client.Close()

		depositContract, err := deposit.NewTeleportrDeposit(
			depositAddr, l1Client,
		)
		if err != nil {
			return err
		}

		disburserContract, err := disburse.NewTeleportrDisburser(
			disburserAddr, l2Client,
		)
		if err != nil {
			return err
		}

		cdr := NewChainDataReader(
			l1Client,
			l2Client,
			depositAddr,
			disburserWalletAddr,
			depositContract,
			disburserContract,
		)

		// TODO(conner): make read-only
		database, err := db.Open(db.Config{
			Host:      cfg.PostgresHost,
			Port:      uint16(cfg.PostgresPort),
			User:      cfg.PostgresUser,
			Password:  cfg.PostgresPassword,
			DBName:    cfg.PostgresDBName,
			EnableSSL: cfg.PostgresEnableSSL,
		})
		if err != nil {
			return err
		}
		defer database.Close()

		if cfg.MetricsServerEnable {
			go metrics.RunServer(cfg.MetricsHostname, cfg.MetricsPort)
		}

		server := NewServer(
			ctx,
			l1Client,
			l2Client,
			database,
			NewCachingChainDataReader(cdr, time.Minute),
			depositAddr,
			cfg.NumConfirmations,
		)

		var wg sync.WaitGroup
		wg.Add(1)
		go func() {
			defer wg.Done()
			_ = server.ListenAndServe(cfg.Hostname, cfg.Port)
		}()

		interruptChannel := make(chan os.Signal, 1)
		signal.Notify(interruptChannel, []os.Signal{
			os.Interrupt,
			os.Kill,
			syscall.SIGTERM,
			syscall.SIGQUIT,
		}...)

		select {
		case <-interruptChannel:
			_ = server.httpServer.Shutdown(ctx)
			time.AfterFunc(defaultTimeout, func() {
				cancel()
				_ = server.httpServer.Close()
			})
			wg.Wait()
		case <-ctx.Done():
		}

		return nil
	}
}

type Config struct {
	Hostname               string
	Port                   uint16
	L1EthRpc               string
	L2EthRpc               string
	DepositAddress         string
	NumConfirmations       uint64
	DisburserWalletAddress string
	DisburserAddress       string
	PostgresHost           string
	PostgresPort           uint16
	PostgresUser           string
	PostgresPassword       string
	PostgresDBName         string
	PostgresEnableSSL      bool
	MetricsServerEnable    bool
	MetricsHostname        string
	MetricsPort            uint64
	DisableHTTP2           bool
}

func NewConfig(ctx *cli.Context) (Config, error) {
	return Config{
		Hostname:               ctx.GlobalString(flags.APIHostnameFlag.Name),
		Port:                   uint16(ctx.GlobalUint64(flags.APIPortFlag.Name)),
		L1EthRpc:               ctx.GlobalString(flags.L1EthRpcFlag.Name),
		L2EthRpc:               ctx.GlobalString(flags.L2EthRpcFlag.Name),
		DepositAddress:         ctx.GlobalString(flags.DepositAddressFlag.Name),
		NumConfirmations:       ctx.GlobalUint64(flags.NumDepositConfirmationsFlag.Name),
		DisburserWalletAddress: ctx.GlobalString(flags.DisburserWalletAddressFlag.Name),
		DisburserAddress:       ctx.GlobalString(flags.DisburserAddressFlag.Name),
		PostgresHost:           ctx.GlobalString(flags.PostgresHostFlag.Name),
		PostgresPort:           uint16(ctx.GlobalUint64(flags.PostgresPortFlag.Name)),
		PostgresUser:           ctx.GlobalString(flags.PostgresUserFlag.Name),
		PostgresPassword:       ctx.GlobalString(flags.PostgresPasswordFlag.Name),
		PostgresDBName:         ctx.GlobalString(flags.PostgresDBNameFlag.Name),
		PostgresEnableSSL:      ctx.GlobalBool(flags.PostgresEnableSSLFlag.Name),
		MetricsServerEnable:    ctx.GlobalBool(flags.MetricsServerEnableFlag.Name),
		MetricsHostname:        ctx.GlobalString(flags.MetricsHostnameFlag.Name),
		MetricsPort:            ctx.GlobalUint64(flags.MetricsPortFlag.Name),
		DisableHTTP2:           ctx.GlobalBool(flags.HTTP2DisableFlag.Name),
	}, nil
}

const (
	ContentTypeHeader = "Content-Type"
	ContentTypeJSON   = "application/json"

	defaultTimeout = 10 * time.Second
)

type Server struct {
	ctx              context.Context
	l1Client         *ethclient.Client
	l2Client         *ethclient.Client
	database         *db.Database
	chainDataReader  ChainDataReader
	depositAddr      common.Address
	numConfirmations uint64

	httpServer *http.Server
}

func NewServer(
	ctx context.Context,
	l1Client *ethclient.Client,
	l2Client *ethclient.Client,
	database *db.Database,
	chainDataReader ChainDataReader,
	depositAddr common.Address,
	numConfirmations uint64,
) *Server {
	if numConfirmations == 0 {
		panic("NumConfirmations cannot be zero")
	}

	return &Server{
		ctx:              ctx,
		l1Client:         l1Client,
		l2Client:         l2Client,
		database:         database,
		chainDataReader:  chainDataReader,
		depositAddr:      depositAddr,
		numConfirmations: numConfirmations,
	}
}

func (s *Server) ListenAndServe(host string, port uint16) error {
	handler := mux.NewRouter()
	handler.HandleFunc("/healthz", HandleHealthz).Methods("GET")
	handler.HandleFunc(
		"/status",
		instrumentedErrorHandler(s.HandleStatus),
	).Methods("GET")
	handler.HandleFunc(
		"/estimate/{addr:0x[0-9a-fA-F]{40}}/{amount:[0-9]{1,80}}",
		instrumentedErrorHandler(s.HandleEstimate),
	).Methods("GET")
	handler.HandleFunc(
		"/track/{txhash:0x[0-9a-fA-F]{64}}",
		instrumentedErrorHandler(s.HandleTrack),
	).Methods("GET")
	handler.HandleFunc(
		"/history/{addr:0x[0-9a-fA-F]{40}}",
		instrumentedErrorHandler(s.HandleHistory),
	).Methods("GET")
	c := cors.New(cors.Options{
		AllowedOrigins: []string{"*"},
	})
	addr := fmt.Sprintf("%s:%d", host, port)
	s.httpServer = &http.Server{
		Handler: c.Handler(handler),
		Addr:    addr,
		BaseContext: func(_ net.Listener) context.Context {
			return s.ctx
		},
	}
	log.Info("Starting HTTP server", "addr", addr)
	return s.httpServer.ListenAndServe()
}

func HandleHealthz(w http.ResponseWriter, r *http.Request) {
	_, _ = w.Write([]byte("OK"))
}

type StatusResponse struct {
	DisburserWalletBalanceWei string `json:"disburser_wallet_balance_wei"`
	DepositContractBalanceWei string `json:"deposit_contract_balance_wei"`
	MaximumBalanceWei         string `json:"maximum_balance_wei"`
	MinDepositAmountWei       string `json:"min_deposit_amount_wei"`
	MaxDepositAmountWei       string `json:"max_deposit_amount_wei"`
	DisbursementLag           uint64 `json:"disbursement_lag"`
	IsAvailable               bool   `json:"is_available"`
}

func (s *Server) HandleStatus(
	ctx context.Context,
	w http.ResponseWriter,
	r *http.Request,
) error {
	chainData, err := s.chainDataReader.Get(ctx)
	if err != nil {
		return err
	}

	balanceAfterMaxDeposit := new(big.Int).Add(
		chainData.DepositContractBalance, chainData.MaxDepositAmount,
	)
	disbursementLag := chainData.NextDepositID - chainData.NextDisbursementID
	isAvailable := chainData.MaxBalance.Cmp(balanceAfterMaxDeposit) >= 0 &&
		chainData.DisburserBalance.Cmp(chainData.MaxDepositAmount) > 0 &&
		disbursementLag < MaxLagBeforeUnavailable

	resp := StatusResponse{
		DisburserWalletBalanceWei: chainData.DisburserBalance.String(),
		DepositContractBalanceWei: chainData.DepositContractBalance.String(),
		MaximumBalanceWei:         chainData.MaxBalance.String(),
		MinDepositAmountWei:       chainData.MinDepositAmount.String(),
		MaxDepositAmountWei:       chainData.MaxDepositAmount.String(),
		DisbursementLag:           disbursementLag,
		IsAvailable:               isAvailable,
	}

	jsonResp, err := json.Marshal(resp)
	if err != nil {
		return err
	}

	w.Header().Set(ContentTypeHeader, ContentTypeJSON)
	_, err = w.Write(jsonResp)
	return err
}

type EstimateResponse struct {
	BaseFee     string `json:"base_fee"`
	GasTipCap   string `json:"gas_tip_cap"`
	GasFeeCap   string `json:"gas_fee_cap"`
	GasEstimate string `json:"gas_estimate"`
}

func (s *Server) HandleEstimate(
	ctx context.Context,
	w http.ResponseWriter,
	r *http.Request,
) error {

	vars := mux.Vars(r)
	addressStr, ok := vars["addr"]
	if !ok {
		return StatusError{
			Err:  errors.New("missing address parameter"),
			Code: http.StatusBadRequest,
		}
	}
	address, err := bsscore.ParseAddress(addressStr)
	if err != nil {
		return StatusError{
			Err:  err,
			Code: http.StatusBadRequest,
		}
	}

	amountStr, ok := vars["amount"]
	if !ok {
		return StatusError{
			Err:  errors.New("missing amount parameter"),
			Code: http.StatusBadRequest,
		}
	}
	amount, ok := new(big.Int).SetString(amountStr, 10)
	if !ok {
		return StatusError{
			Err:  errors.New("unable to parse amount"),
			Code: http.StatusBadRequest,
		}
	}

	gasTipCap, err := s.l1Client.SuggestGasTipCap(ctx)
	if err != nil {
		rpcErrorsTotal.WithLabelValues("suggest_gas_tip_cap").Inc()
		// If the request failed because the backend does not support
		// eth_maxPriorityFeePerGas, fallback to using the default constant.
		// Currently Alchemy is the only backend provider that exposes this
		// method, so in the event their API is unreachable we can fallback to a
		// degraded mode of operation. This also applies to our test
		// environments, as hardhat doesn't support the query either.
		if !drivers.IsMaxPriorityFeePerGasNotFoundError(err) {
			return err
		}
		gasTipCap = drivers.FallbackGasTipCap
	}

	header, err := s.l1Client.HeaderByNumber(ctx, nil)
	if err != nil {
		rpcErrorsTotal.WithLabelValues("header_by_number").Inc()
		return err
	}

	gasFeeCap := txmgr.CalcGasFeeCap(header.BaseFee, gasTipCap)

	gasUsed, err := s.l1Client.EstimateGas(ctx, ethereum.CallMsg{
		From:      address,
		To:        &s.depositAddr,
		Gas:       0,
		GasFeeCap: gasFeeCap,
		GasTipCap: gasTipCap,
		Value:     amount,
		Data:      nil,
	})
	if err != nil {
		rpcErrorsTotal.WithLabelValues("estimate_gas").Inc()
		return err
	}

	resp := EstimateResponse{
		BaseFee:     header.BaseFee.String(),
		GasTipCap:   gasTipCap.String(),
		GasFeeCap:   gasFeeCap.String(),
		GasEstimate: new(big.Int).SetUint64(gasUsed).String(),
	}

	jsonResp, err := json.Marshal(resp)
	if err != nil {
		return err
	}

	w.Header().Set(ContentTypeHeader, ContentTypeJSON)
	_, err = w.Write(jsonResp)
	return err
}

type RPCTeleport struct {
	ID             string           `json:"id"`
	Address        string           `json:"address"`
	AmountWei      string           `json:"amount_wei"`
	TxHash         string           `json:"tx_hash"`
	BlockNumber    string           `json:"block_number"`
	BlockTimestamp string           `json:"block_timestamp_unix"`
	Disbursement   *RPCDisbursement `json:"disbursement"`
}

func makeRPCTeleport(teleport *db.Teleport) RPCTeleport {
	rpcTeleport := RPCTeleport{
		ID:             strconv.FormatUint(teleport.ID, 10),
		Address:        teleport.Address.String(),
		AmountWei:      teleport.Amount.String(),
		TxHash:         teleport.Deposit.TxnHash.String(),
		BlockNumber:    strconv.FormatUint(teleport.Deposit.BlockNumber, 10),
		BlockTimestamp: strconv.FormatInt(teleport.Deposit.BlockTimestamp.Unix(), 10),
	}
	if teleport.Disbursement != nil {
		rpcTeleport.Disbursement = &RPCDisbursement{
			TxHash:         teleport.Disbursement.TxnHash.String(),
			BlockNumber:    strconv.FormatUint(teleport.Disbursement.BlockNumber, 10),
			BlockTimestamp: strconv.FormatInt(teleport.Disbursement.BlockTimestamp.Unix(), 10),
			Success:        teleport.Disbursement.Success,
		}
	}
	return rpcTeleport
}

type RPCDisbursement struct {
	TxHash         string `json:"tx_hash"`
	BlockNumber    string `json:"block_number"`
	BlockTimestamp string `json:"block_timestamp_unix"`
	Success        bool   `json:"success"`
}

type TrackResponse struct {
	CurrentBlockNumber     string      `json:"current_block_number"`
	ConfirmationsRequired  string      `json:"confirmations_required"`
	ConfirmationsRemaining string      `json:"confirmations_remaining"`
	Teleport               RPCTeleport `json:"teleport"`
}

func (s *Server) HandleTrack(
	ctx context.Context,
	w http.ResponseWriter,
	r *http.Request,
) error {

	vars := mux.Vars(r)
	txHashStr, ok := vars["txhash"]
	if !ok {
		return StatusError{
			Err:  errors.New("missing txhash parameter"),
			Code: http.StatusBadRequest,
		}
	}
	txHash := common.HexToHash(txHashStr)

	blockNumber, err := s.l1Client.BlockNumber(ctx)
	if err != nil {
		rpcErrorsTotal.WithLabelValues("block_number").Inc()
		return err
	}

	teleport, err := s.database.LoadTeleportByDepositHash(txHash)
	if err != nil {
		databaseErrorsTotal.WithLabelValues("load_teleport_by_deposit_hash").Inc()
		return err
	}

	if teleport == nil {
		return StatusError{
			Code: http.StatusNotFound,
		}
	}

	var confsRemaining uint64
	if teleport.Deposit.BlockNumber+s.numConfirmations > blockNumber+1 {
		confsRemaining = teleport.Deposit.BlockNumber + s.numConfirmations -
			(blockNumber + 1)
	}

	resp := TrackResponse{
		CurrentBlockNumber:     strconv.FormatUint(blockNumber, 10),
		ConfirmationsRequired:  strconv.FormatUint(s.numConfirmations, 10),
		ConfirmationsRemaining: strconv.FormatUint(confsRemaining, 10),
		Teleport:               makeRPCTeleport(teleport),
	}

	jsonResp, err := json.Marshal(resp)
	if err != nil {
		return err
	}

	w.Header().Set(ContentTypeHeader, ContentTypeJSON)
	_, err = w.Write(jsonResp)
	return err
}

type HistoryResponse struct {
	Teleports []RPCTeleport `json:"teleports"`
}

func (s *Server) HandleHistory(
	ctx context.Context,
	w http.ResponseWriter,
	r *http.Request,
) error {

	vars := mux.Vars(r)
	addrStr, ok := vars["addr"]
	if !ok {
		return StatusError{
			Err:  errors.New("missing addr parameter"),
			Code: http.StatusBadRequest,
		}
	}
	addr := common.HexToAddress(addrStr)

	teleports, err := s.database.LoadTeleportsByAddress(addr)
	if err != nil {
		databaseErrorsTotal.WithLabelValues("load_teleports_by_address").Inc()
		return err
	}

	rpcTeleports := make([]RPCTeleport, 0, len(teleports))
	for _, teleport := range teleports {
		rpcTeleports = append(rpcTeleports, makeRPCTeleport(&teleport))
	}

	resp := HistoryResponse{
		Teleports: rpcTeleports,
	}

	jsonResp, err := json.Marshal(resp)
	if err != nil {
		return err
	}

	w.Header().Set(ContentTypeHeader, ContentTypeJSON)
	_, err = w.Write(jsonResp)
	return err
}

type Error interface {
	error
	Status() int
}

type StatusError struct {
	Code int
	Err  error
}

func (se StatusError) Error() string {
	if se.Err != nil {
		msg := se.Err.Error()
		if msg != "" {
			return msg
		}
	}
	return http.StatusText(se.Code)
}

func (se StatusError) Status() int {
	return se.Code
}

func instrumentedErrorHandler(
	h func(context.Context, http.ResponseWriter, *http.Request) error,
) func(http.ResponseWriter, *http.Request) {
	return func(w http.ResponseWriter, r *http.Request) {
		rpcRequestsTotal.Inc()

		ctx, cancel := populateContext(w, r)
		defer cancel()

		reqID := GetReqID(ctx)

		log.Info("HTTP request",
			"req_id", reqID,
			"path", r.URL.Path,
			"user_agent", r.UserAgent())

		respTimer := prometheus.NewTimer(httpRequestDurationSumm)
		err := h(ctx, w, r)
		elapsed := respTimer.ObserveDuration()

		var statusCode int
		switch e := err.(type) {
		case nil:
			statusCode = 200
			log.Info("HTTP success",
				"req_id", reqID,
				"elapsed", elapsed)

		case Error:
			statusCode = e.Status()
			log.Warn("HTTP error",
				"req_id", reqID,
				"elapsed", elapsed,
				"status", statusCode,
				"err", e.Error())
			http.Error(w, e.Error(), statusCode)

		default:
			statusCode = http.StatusInternalServerError
			log.Warn("HTTP internal error",
				"req_id", reqID,
				"elapsed", elapsed,
				"status", statusCode,
				"err", err)
			http.Error(w, http.StatusText(statusCode), statusCode)
		}

		httpResponseCodesTotal.WithLabelValues(strconv.Itoa(statusCode)).Inc()
	}
}

func populateContext(
	w http.ResponseWriter,
	r *http.Request,
) (context.Context, func()) {

	ctx := context.WithValue(r.Context(), ContextKeyReqID, uuid.NewString())
	return context.WithTimeout(ctx, defaultTimeout)
}

func GetReqID(ctx context.Context) string {
	if reqID, ok := ctx.Value(ContextKeyReqID).(string); ok {
		return reqID
	}
	return ""
}