client

Documentation

Index

• type Client
  • func NewClient(cfg *Config, opts ...Option) (*Client, error)
  • func (c *Client) GetAllDepositsByAddress(l1Address common.Address) ([]models.DepositItem, error)
  • func (c *Client) GetAllWithdrawalsByAddress(l2Address common.Address) ([]models.WithdrawalItem, error)
  • func (c *Client) GetDepositsByAddress(l1Address common.Address, cursor string) (*models.DepositResponse, error)
  • func (c *Client) GetSupplyAssessment() (*models.BridgeSupplyView, error)
  • func (c *Client) GetWithdrawalsByAddress(l2Address common.Address, cursor string) (*models.WithdrawalResponse, error)
  • func (c *Client) HealthCheck() error
• type Config
• type Option
  • func WithMetrics(m node.Metricer) Option
  • func WithTimeout(t time.Duration) Option

Types

type Client

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

Client ... Indexer client struct

func NewClient

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

NewClient ... Construct a new indexer client

func (*Client) GetAllDepositsByAddress

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

GetAllDepositsByAddress ... Gets all deposits provided a L1 address

func (*Client) GetAllWithdrawalsByAddress

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

GetAllWithdrawalsByAddress ... Gets all withdrawals provided a L2 address

func (*Client) GetDepositsByAddress

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

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

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

func (c *Client) HealthCheck() error

HealthCheck ... Checks the health of the indexer API

type Config

type Config struct {
	PaginationLimit int
	BaseURL         string
}

Config ... Indexer client config struct

type Option

type Option func(*Client) error

Option ... Provides configuration through callback injection

func WithMetrics

func WithMetrics(m node.Metricer) Option

WithMetrics ... Triggers metric optionality

func WithTimeout

func WithTimeout(t time.Duration) Option

WithTimeout ... Embeds a timeout limit to request