client

Documentation

Overview

Package client provides a client for the RFQ quoting API. nolint:,wrapcheck

Index

• type AuthenticatedClient
  • func NewAuthenticatedClient(metrics metrics.Handler, rfqURL string, reqSigner signer.Signer) (AuthenticatedClient, error)
• type UnauthenticatedClient
  • func NewUnauthenticatedClient(metricHandler metrics.Handler, rfqURL string) (UnauthenticatedClient, error)

Types

type AuthenticatedClient

type AuthenticatedClient interface {
	PutQuote(ctx context.Context, q *model.PutRelayerQuoteRequest) error
	PutBulkQuotes(ctx context.Context, q *model.PutBulkQuotesRequest) error
	PutRelayAck(ctx context.Context, req *model.PutAckRequest) (*model.PutRelayAckResponse, error)
	SubscribeActiveQuotes(ctx context.Context, req *model.SubscribeActiveRFQRequest, reqChan chan *model.ActiveRFQMessage) (respChan chan *model.ActiveRFQMessage, err error)
	UnauthenticatedClient
}

AuthenticatedClient is an interface for the RFQ API. It provides methods for creating, retrieving and updating quotes.

func NewAuthenticatedClient

func NewAuthenticatedClient(metrics metrics.Handler, rfqURL string, reqSigner signer.Signer) (AuthenticatedClient, error)

NewAuthenticatedClient creates a new client for the RFQ quoting API. TODO: @aurelius, you don't actually need to be authed for GET Requests.

type UnauthenticatedClient

type UnauthenticatedClient interface {
	GetAllQuotes(ctx context.Context) ([]*model.GetQuoteResponse, error)
	GetSpecificQuote(ctx context.Context, q *model.GetQuoteSpecificRequest) ([]*model.GetQuoteResponse, error)
	GetQuoteByRelayerAddress(ctx context.Context, relayerAddr string) ([]*model.GetQuoteResponse, error)
	GetRFQContracts(ctx context.Context) (*model.GetContractsResponse, error)
	PutRFQRequest(ctx context.Context, q *model.PutRFQRequest) (*model.PutRFQResponse, error)
	// contains filtered or unexported methods
}

UnauthenticatedClient is an interface for the RFQ API.

func NewUnauthenticatedClient

func NewUnauthenticatedClient(metricHandler metrics.Handler, rfqURL string) (UnauthenticatedClient, error)

NewUnauthenticatedClient creates a new client for the RFQ quoting API.