api

package

v1.7.7 Latest Latest Go to latest Published: Jun 5, 2024 License: MIT Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ethereum-optimism/optimism

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type APIService
- func NewApi(ctx context.Context, log log.Logger, cfg *Config) (*APIService, error)
type Client
- func NewClient(cfg *ClientConfig, opts ...Option) (*Client, error)
type ClientConfig
type Config
type DB
type DBConfigConnector
- func (cfg *DBConfigConnector) OpenDB(ctx context.Context, log log.Logger) (*DB, error)
type DBConnector
type Option
- func WithMetrics(m metrics.RPCClientMetricer) Option
- func WithTimeout(t time.Duration) Option
type TestDBConnector
- func (tdb *TestDBConnector) OpenDB(ctx context.Context, log log.Logger) (*DB, error)

Constants ¶

View Source

const (
	MetricsNamespace = "op_indexer_api"

	// Endpoint paths
	DocsPath        = "/docs"
	HealthPath      = "/healthz"
	DepositsPath    = "/api/v0/deposits/"
	WithdrawalsPath = "/api/v0/withdrawals/"

	SupplyPath = "/api/v0/supply"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type APIService ¶ added in v1.4.2

type APIService struct {
	// contains filtered or unexported fields
}

Api ... Indexer API struct TODO : Structured error responses

func NewApi ¶

func NewApi(ctx context.Context, log log.Logger, cfg *Config) (*APIService, error)

NewApi ... Construct a new api instance

func (*APIService) Addr ¶ added in v1.4.2

func (a *APIService) Addr() string

Addr ... returns the address that the HTTP server is listening on (excl. http:// prefix, just the host and port)

func (*APIService) Start ¶ added in v1.4.2

func (a *APIService) Start(ctx context.Context) error

func (*APIService) Stop ¶ added in v1.4.2

func (a *APIService) Stop(ctx context.Context) error

func (*APIService) Stopped ¶ added in v1.4.2

func (a *APIService) Stopped() bool

type Client ¶ added in v1.7.6

type Client struct {
	// contains filtered or unexported fields
}

Client ... Indexer client struct

func NewClient ¶ added in v1.7.6

func NewClient(cfg *ClientConfig, opts ...Option) (*Client, error)

NewClient ... Construct a new indexer client

func (*Client) GetAllDepositsByAddress ¶ added in v1.7.6

func (c *Client) GetAllDepositsByAddress(l1Address common.Address) ([]models.DepositItem, error)

GetAllDepositsByAddress ... Gets all deposits provided a L1 address

func (*Client) GetAllWithdrawalsByAddress ¶ added in v1.7.6

func (c *Client) GetAllWithdrawalsByAddress(l2Address common.Address) ([]models.WithdrawalItem, error)

GetAllWithdrawalsByAddress ... Gets all withdrawals provided a L2 address

func (*Client) GetDepositsByAddress ¶ added in v1.7.6

func (c *Client) GetDepositsByAddress(l1Address common.Address, cursor string) (*models.DepositResponse, error)

GetDepositsByAddress ... Gets a deposit response object provided an L1 address and cursor

func (*Client) GetSupplyAssessment ¶ added in v1.7.6

func (c *Client) GetSupplyAssessment() (*models.BridgeSupplyView, error)

GetSupplyAssessment ... Returns an assessment of the current supply on both L1 and L2. This includes the individual sums of (L1/L2) deposits and withdrawals

func (*Client) GetWithdrawalsByAddress ¶ added in v1.7.6

func (c *Client) GetWithdrawalsByAddress(l2Address common.Address, cursor string) (*models.WithdrawalResponse, error)

GetWithdrawalsByAddress ... Gets a withdrawal response object provided an L2 address and cursor

func (*Client) HealthCheck ¶ added in v1.7.6

func (c *Client) HealthCheck() error

HealthCheck ... Checks the health of the indexer API

type ClientConfig ¶ added in v1.7.6

type ClientConfig struct {
	PaginationLimit int
	BaseURL         string
}

Config ... Indexer client config struct

type Config ¶ added in v1.4.2

type Config struct {
	DB            DBConnector
	HTTPServer    config.ServerConfig
	MetricsServer config.ServerConfig
}

Config for the API service

type DB ¶ added in v1.4.2

type DB struct {
	BridgeTransfers database.BridgeTransfersView
	Closer          func() error
}

DB represents the abstract DB access the API has.

type DBConfigConnector ¶ added in v1.4.2

type DBConfigConnector struct {
	config.DBConfig
}

DBConfigConnector implements a fully config based DBConnector

func (*DBConfigConnector) OpenDB ¶ added in v1.4.2

func (cfg *DBConfigConnector) OpenDB(ctx context.Context, log log.Logger) (*DB, error)

type DBConnector ¶ added in v1.4.2

type DBConnector interface {
	OpenDB(ctx context.Context, log log.Logger) (*DB, error)
}

DBConnector is an interface: the config may provide different ways to access the DB. This is implemented in tests to provide custom DB views, or share the DB with other services.

type Option ¶ added in v1.7.6

type Option func(*Client) error

Option ... Provides configuration through callback injection

func WithMetrics ¶ added in v1.7.6

func WithMetrics(m metrics.RPCClientMetricer) Option

WithMetrics ... Triggers metric optionality

func WithTimeout ¶ added in v1.7.6

func WithTimeout(t time.Duration) Option

WithTimeout ... Embeds a timeout limit to request

type TestDBConnector ¶ added in v1.4.2

type TestDBConnector struct {
	BridgeTransfers database.BridgeTransfersView
}

func (*TestDBConnector) OpenDB ¶ added in v1.4.2

func (tdb *TestDBConnector) OpenDB(ctx context.Context, log log.Logger) (*DB, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
models
routes
service

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL