api

Documentation

Index

• Constants
• type API
  • func NewApi(ctx context.Context, cfg *config.Config) (*API, error)
  • func (a *API) Start(ctx context.Context) error
  • func (a *API) Stop(ctx context.Context) error
  • func (a *API) Stopped() bool
• type APIConfig

Constants

const (
	HealthPath = "/healthz"

	StrategyV1Path     = "/api/v1/strategies/strategy"
	StrategyListV1Path = "/api/v1/strategies/strategy/list"

	OperatorGetV1Path                 = "/api/v1/operator/get"
	OperatorListV1Path                = "/api/v1/operator/list"
	OperatorRegisterV1Path            = "/api/v1/operator/register"
	OperatorRegisterListV1Path        = "/api/v1/operator/register/list"
	OperatorNodeUrlUpdateListV1Path   = "/api/v1/operator/node/url/update/list"
	OperatorReceiveStakerDelegateList = "/api/v1/operator/receiver/staker/delegate/list"
	OperatorSharesIncreasedListV1Path = "/api/v1/operator/shares/increased/list"
	OperatorSharesDecreasedListV1Path = "/api/v1/operator/shares/decreased/list"
	OperatorAndStakeRewardListV1Path  = "/api/v1/operator/stake/reward/list"
	OperatorClaimRewardListV1Path     = "/api/v1/operator/claim/reward/list"

	StakerGetV1Path                          = "/api/v1/staker/get"
	StakerListV1Path                         = "/api/v1/staker/list"
	StakerOperatorListV1Path                 = "/api/v1/staker/operator/list"
	StakerDepositStrategyListV1Path          = "/api/v1/staker/deposit/strategy/list"
	StakerDelegatedListV1Path                = "/api/v1/staker/delegated/list"
	StakerUndelegatedListV1Path              = "/api/v1/staker/undelegated/list"
	StakeHolderClaimRewardListV1Path         = "/api/v1/staker/claim/reward/list"
	StakeHolderWithdrawalQueuedListV1Path    = "/api/v1/staker/withdrawal/queued/list"
	StakeHolderWithdrawalCompletedListV1Path = "/api/v1/staker/withdrawal/completed/list"

	FinalityVerifiedV1Path = "/api/v1/finality/verified"
)

Types

type API

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

func NewApi

func NewApi(ctx context.Context, cfg *config.Config) (*API, error)

func (*API) Start

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

func (*API) Stop

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

func (*API) Stopped

func (a *API) Stopped() bool

type APIConfig

type APIConfig struct {
	HTTPServer    config.ServerConfig
	MetricsServer config.ServerConfig
}