Help us shape the future of Go! Take the 2026 Go Developer Survey

apiproxy

package
v0.36.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 9, 2024 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	LocalApiService    = "local"
	UpstreamApiService = "upstream"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type FlowAccessAPIForwarder 

type FlowAccessAPIForwarder struct {
	*forwarder.Forwarder
}

FlowAccessAPIForwarder forwards all requests to a set of upstream access nodes or observers

func NewFlowAccessAPIForwarder 

func NewFlowAccessAPIForwarder(identities flow.IdentitySkeletonList, connectionFactory connection.ConnectionFactory) (*FlowAccessAPIForwarder, error)

func (*FlowAccessAPIForwarder) ExecuteScriptAtBlockHeight 

func (h *FlowAccessAPIForwarder) ExecuteScriptAtBlockHeight(context context.Context, req *access.ExecuteScriptAtBlockHeightRequest) (*access.ExecuteScriptResponse, error)

func (*FlowAccessAPIForwarder) ExecuteScriptAtBlockID 

func (h *FlowAccessAPIForwarder) ExecuteScriptAtBlockID(context context.Context, req *access.ExecuteScriptAtBlockIDRequest) (*access.ExecuteScriptResponse, error)

func (*FlowAccessAPIForwarder) ExecuteScriptAtLatestBlock 

func (h *FlowAccessAPIForwarder) ExecuteScriptAtLatestBlock(context context.Context, req *access.ExecuteScriptAtLatestBlockRequest) (*access.ExecuteScriptResponse, error)

func (*FlowAccessAPIForwarder) GetAccount 

func (h *FlowAccessAPIForwarder) GetAccount(context context.Context, req *access.GetAccountRequest) (*access.GetAccountResponse, error)

func (*FlowAccessAPIForwarder) GetAccountAtBlockHeight 

func (h *FlowAccessAPIForwarder) GetAccountAtBlockHeight(context context.Context, req *access.GetAccountAtBlockHeightRequest) (*access.AccountResponse, error)

func (*FlowAccessAPIForwarder) GetAccountAtLatestBlock 

func (h *FlowAccessAPIForwarder) GetAccountAtLatestBlock(context context.Context, req *access.GetAccountAtLatestBlockRequest) (*access.AccountResponse, error)

func (*FlowAccessAPIForwarder) GetBlockByHeight 

func (h *FlowAccessAPIForwarder) GetBlockByHeight(context context.Context, req *access.GetBlockByHeightRequest) (*access.BlockResponse, error)

func (*FlowAccessAPIForwarder) GetBlockByID 

func (h *FlowAccessAPIForwarder) GetBlockByID(context context.Context, req *access.GetBlockByIDRequest) (*access.BlockResponse, error)

func (*FlowAccessAPIForwarder) GetBlockHeaderByHeight 

func (h *FlowAccessAPIForwarder) GetBlockHeaderByHeight(context context.Context, req *access.GetBlockHeaderByHeightRequest) (*access.BlockHeaderResponse, error)

func (*FlowAccessAPIForwarder) GetBlockHeaderByID 

func (h *FlowAccessAPIForwarder) GetBlockHeaderByID(context context.Context, req *access.GetBlockHeaderByIDRequest) (*access.BlockHeaderResponse, error)

func (*FlowAccessAPIForwarder) GetCollectionByID 

func (h *FlowAccessAPIForwarder) GetCollectionByID(context context.Context, req *access.GetCollectionByIDRequest) (*access.CollectionResponse, error)

func (*FlowAccessAPIForwarder) GetEventsForBlockIDs 

func (h *FlowAccessAPIForwarder) GetEventsForBlockIDs(context context.Context, req *access.GetEventsForBlockIDsRequest) (*access.EventsResponse, error)

func (*FlowAccessAPIForwarder) GetEventsForHeightRange 

func (h *FlowAccessAPIForwarder) GetEventsForHeightRange(context context.Context, req *access.GetEventsForHeightRangeRequest) (*access.EventsResponse, error)

func (*FlowAccessAPIForwarder) GetExecutionResultByID added in v0.32.0 

func (h *FlowAccessAPIForwarder) GetExecutionResultByID(context context.Context, req *access.GetExecutionResultByIDRequest) (*access.ExecutionResultByIDResponse, error)

func (*FlowAccessAPIForwarder) GetExecutionResultForBlockID 

func (h *FlowAccessAPIForwarder) GetExecutionResultForBlockID(context context.Context, req *access.GetExecutionResultForBlockIDRequest) (*access.ExecutionResultForBlockIDResponse, error)

func (*FlowAccessAPIForwarder) GetFullCollectionByID added in v0.33.26 

func (h *FlowAccessAPIForwarder) GetFullCollectionByID(context context.Context, req *access.GetFullCollectionByIDRequest) (*access.FullCollectionResponse, error)

func (*FlowAccessAPIForwarder) GetLatestBlock 

func (h *FlowAccessAPIForwarder) GetLatestBlock(context context.Context, req *access.GetLatestBlockRequest) (*access.BlockResponse, error)

func (*FlowAccessAPIForwarder) GetLatestBlockHeader 

func (h *FlowAccessAPIForwarder) GetLatestBlockHeader(context context.Context, req *access.GetLatestBlockHeaderRequest) (*access.BlockHeaderResponse, error)

func (*FlowAccessAPIForwarder) GetLatestProtocolStateSnapshot 

func (h *FlowAccessAPIForwarder) GetLatestProtocolStateSnapshot(context context.Context, req *access.GetLatestProtocolStateSnapshotRequest) (*access.ProtocolStateSnapshotResponse, error)

func (*FlowAccessAPIForwarder) GetNetworkParameters 

func (h *FlowAccessAPIForwarder) GetNetworkParameters(context context.Context, req *access.GetNetworkParametersRequest) (*access.GetNetworkParametersResponse, error)

func (*FlowAccessAPIForwarder) GetNodeVersionInfo added in v0.31.0 

func (h *FlowAccessAPIForwarder) GetNodeVersionInfo(context context.Context, req *access.GetNodeVersionInfoRequest) (*access.GetNodeVersionInfoResponse, error)

func (*FlowAccessAPIForwarder) GetSystemTransaction added in v0.33.1 

func (h *FlowAccessAPIForwarder) GetSystemTransaction(context context.Context, req *access.GetSystemTransactionRequest) (*access.TransactionResponse, error)

func (*FlowAccessAPIForwarder) GetSystemTransactionResult added in v0.33.1 

func (h *FlowAccessAPIForwarder) GetSystemTransactionResult(context context.Context, req *access.GetSystemTransactionResultRequest) (*access.TransactionResultResponse, error)

func (*FlowAccessAPIForwarder) GetTransaction 

func (h *FlowAccessAPIForwarder) GetTransaction(context context.Context, req *access.GetTransactionRequest) (*access.TransactionResponse, error)

func (*FlowAccessAPIForwarder) GetTransactionResult 

func (h *FlowAccessAPIForwarder) GetTransactionResult(context context.Context, req *access.GetTransactionRequest) (*access.TransactionResultResponse, error)

func (*FlowAccessAPIForwarder) GetTransactionResultByIndex 

func (h *FlowAccessAPIForwarder) GetTransactionResultByIndex(context context.Context, req *access.GetTransactionByIndexRequest) (*access.TransactionResultResponse, error)

func (*FlowAccessAPIForwarder) GetTransactionResultsByBlockID 

func (h *FlowAccessAPIForwarder) GetTransactionResultsByBlockID(context context.Context, req *access.GetTransactionsByBlockIDRequest) (*access.TransactionResultsResponse, error)

func (*FlowAccessAPIForwarder) GetTransactionsByBlockID 

func (h *FlowAccessAPIForwarder) GetTransactionsByBlockID(context context.Context, req *access.GetTransactionsByBlockIDRequest) (*access.TransactionsResponse, error)

func (*FlowAccessAPIForwarder) Ping 

func (h *FlowAccessAPIForwarder) Ping(context context.Context, req *access.PingRequest) (*access.PingResponse, error)

Ping pings the service. It is special in the sense that it responds successful, only if all underlying services are ready.

func (*FlowAccessAPIForwarder) SendTransaction 

func (h *FlowAccessAPIForwarder) SendTransaction(context context.Context, req *access.SendTransactionRequest) (*access.SendTransactionResponse, error)

type FlowAccessAPIRouter 

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

FlowAccessAPIRouter is a structure that represents the routing proxy algorithm. It splits requests between a local and a remote API service.

func NewFlowAccessAPIRouter added in v0.33.30 

func NewFlowAccessAPIRouter(params Params) *FlowAccessAPIRouter

NewFlowAccessAPIRouter creates FlowAccessAPIRouter instance

func (*FlowAccessAPIRouter) ExecuteScriptAtBlockHeight 

func (h *FlowAccessAPIRouter) ExecuteScriptAtBlockHeight(context context.Context, req *access.ExecuteScriptAtBlockHeightRequest) (*access.ExecuteScriptResponse, error)

func (*FlowAccessAPIRouter) ExecuteScriptAtBlockID 

func (h *FlowAccessAPIRouter) ExecuteScriptAtBlockID(context context.Context, req *access.ExecuteScriptAtBlockIDRequest) (*access.ExecuteScriptResponse, error)

func (*FlowAccessAPIRouter) ExecuteScriptAtLatestBlock 

func (h *FlowAccessAPIRouter) ExecuteScriptAtLatestBlock(context context.Context, req *access.ExecuteScriptAtLatestBlockRequest) (*access.ExecuteScriptResponse, error)

func (*FlowAccessAPIRouter) GetAccount 

func (h *FlowAccessAPIRouter) GetAccount(context context.Context, req *access.GetAccountRequest) (*access.GetAccountResponse, error)

func (*FlowAccessAPIRouter) GetAccountAtBlockHeight 

func (h *FlowAccessAPIRouter) GetAccountAtBlockHeight(context context.Context, req *access.GetAccountAtBlockHeightRequest) (*access.AccountResponse, error)

func (*FlowAccessAPIRouter) GetAccountAtLatestBlock 

func (h *FlowAccessAPIRouter) GetAccountAtLatestBlock(context context.Context, req *access.GetAccountAtLatestBlockRequest) (*access.AccountResponse, error)

func (*FlowAccessAPIRouter) GetBlockByHeight 

func (h *FlowAccessAPIRouter) GetBlockByHeight(context context.Context, req *access.GetBlockByHeightRequest) (*access.BlockResponse, error)

func (*FlowAccessAPIRouter) GetBlockByID 

func (h *FlowAccessAPIRouter) GetBlockByID(context context.Context, req *access.GetBlockByIDRequest) (*access.BlockResponse, error)

func (*FlowAccessAPIRouter) GetBlockHeaderByHeight 

func (h *FlowAccessAPIRouter) GetBlockHeaderByHeight(context context.Context, req *access.GetBlockHeaderByHeightRequest) (*access.BlockHeaderResponse, error)

func (*FlowAccessAPIRouter) GetBlockHeaderByID 

func (h *FlowAccessAPIRouter) GetBlockHeaderByID(context context.Context, req *access.GetBlockHeaderByIDRequest) (*access.BlockHeaderResponse, error)

func (*FlowAccessAPIRouter) GetCollectionByID 

func (h *FlowAccessAPIRouter) GetCollectionByID(context context.Context, req *access.GetCollectionByIDRequest) (*access.CollectionResponse, error)

func (*FlowAccessAPIRouter) GetEventsForBlockIDs 

func (h *FlowAccessAPIRouter) GetEventsForBlockIDs(context context.Context, req *access.GetEventsForBlockIDsRequest) (*access.EventsResponse, error)

func (*FlowAccessAPIRouter) GetEventsForHeightRange 

func (h *FlowAccessAPIRouter) GetEventsForHeightRange(context context.Context, req *access.GetEventsForHeightRangeRequest) (*access.EventsResponse, error)

func (*FlowAccessAPIRouter) GetExecutionResultByID added in v0.32.0 

func (h *FlowAccessAPIRouter) GetExecutionResultByID(context context.Context, req *access.GetExecutionResultByIDRequest) (*access.ExecutionResultByIDResponse, error)

func (*FlowAccessAPIRouter) GetExecutionResultForBlockID 

func (h *FlowAccessAPIRouter) GetExecutionResultForBlockID(context context.Context, req *access.GetExecutionResultForBlockIDRequest) (*access.ExecutionResultForBlockIDResponse, error)

func (*FlowAccessAPIRouter) GetFullCollectionByID added in v0.33.26 

func (h *FlowAccessAPIRouter) GetFullCollectionByID(context context.Context, req *access.GetFullCollectionByIDRequest) (*access.FullCollectionResponse, error)

func (*FlowAccessAPIRouter) GetLatestBlock 

func (h *FlowAccessAPIRouter) GetLatestBlock(context context.Context, req *access.GetLatestBlockRequest) (*access.BlockResponse, error)

func (*FlowAccessAPIRouter) GetLatestBlockHeader 

func (h *FlowAccessAPIRouter) GetLatestBlockHeader(context context.Context, req *access.GetLatestBlockHeaderRequest) (*access.BlockHeaderResponse, error)

func (*FlowAccessAPIRouter) GetLatestProtocolStateSnapshot 

func (h *FlowAccessAPIRouter) GetLatestProtocolStateSnapshot(context context.Context, req *access.GetLatestProtocolStateSnapshotRequest) (*access.ProtocolStateSnapshotResponse, error)

func (*FlowAccessAPIRouter) GetNetworkParameters 

func (h *FlowAccessAPIRouter) GetNetworkParameters(context context.Context, req *access.GetNetworkParametersRequest) (*access.GetNetworkParametersResponse, error)

func (*FlowAccessAPIRouter) GetNodeVersionInfo added in v0.31.0 

func (h *FlowAccessAPIRouter) GetNodeVersionInfo(ctx context.Context, request *access.GetNodeVersionInfoRequest) (*access.GetNodeVersionInfoResponse, error)

func (*FlowAccessAPIRouter) GetProtocolStateSnapshotByBlockID added in v0.33.1 

func (h *FlowAccessAPIRouter) GetProtocolStateSnapshotByBlockID(context context.Context, req *access.GetProtocolStateSnapshotByBlockIDRequest) (*access.ProtocolStateSnapshotResponse, error)

func (*FlowAccessAPIRouter) GetProtocolStateSnapshotByHeight added in v0.33.1 

func (h *FlowAccessAPIRouter) GetProtocolStateSnapshotByHeight(context context.Context, req *access.GetProtocolStateSnapshotByHeightRequest) (*access.ProtocolStateSnapshotResponse, error)

func (*FlowAccessAPIRouter) GetSystemTransaction added in v0.33.1 

func (h *FlowAccessAPIRouter) GetSystemTransaction(context context.Context, req *access.GetSystemTransactionRequest) (*access.TransactionResponse, error)

func (*FlowAccessAPIRouter) GetSystemTransactionResult added in v0.33.1 

func (h *FlowAccessAPIRouter) GetSystemTransactionResult(context context.Context, req *access.GetSystemTransactionResultRequest) (*access.TransactionResultResponse, error)

func (*FlowAccessAPIRouter) GetTransaction 

func (h *FlowAccessAPIRouter) GetTransaction(context context.Context, req *access.GetTransactionRequest) (*access.TransactionResponse, error)

func (*FlowAccessAPIRouter) GetTransactionResult 

func (h *FlowAccessAPIRouter) GetTransactionResult(context context.Context, req *access.GetTransactionRequest) (*access.TransactionResultResponse, error)

func (*FlowAccessAPIRouter) GetTransactionResultByIndex 

func (h *FlowAccessAPIRouter) GetTransactionResultByIndex(context context.Context, req *access.GetTransactionByIndexRequest) (*access.TransactionResultResponse, error)

func (*FlowAccessAPIRouter) GetTransactionResultsByBlockID 

func (h *FlowAccessAPIRouter) GetTransactionResultsByBlockID(context context.Context, req *access.GetTransactionsByBlockIDRequest) (*access.TransactionResultsResponse, error)

func (*FlowAccessAPIRouter) GetTransactionsByBlockID 

func (h *FlowAccessAPIRouter) GetTransactionsByBlockID(context context.Context, req *access.GetTransactionsByBlockIDRequest) (*access.TransactionsResponse, error)

func (*FlowAccessAPIRouter) Ping 

func (h *FlowAccessAPIRouter) Ping(context context.Context, req *access.PingRequest) (*access.PingResponse, error)

Ping pings the service. It is special in the sense that it responds successful, only if all underlying services are ready.

func (*FlowAccessAPIRouter) SendAndSubscribeTransactionStatuses added in v0.33.30 

func (h *FlowAccessAPIRouter) SendAndSubscribeTransactionStatuses(req *access.SendAndSubscribeTransactionStatusesRequest, server access.AccessAPI_SendAndSubscribeTransactionStatusesServer) error

func (*FlowAccessAPIRouter) SendTransaction 

func (h *FlowAccessAPIRouter) SendTransaction(context context.Context, req *access.SendTransactionRequest) (*access.SendTransactionResponse, error)

func (*FlowAccessAPIRouter) SubscribeBlockDigestsFromLatest added in v0.33.30 

func (h *FlowAccessAPIRouter) SubscribeBlockDigestsFromLatest(req *access.SubscribeBlockDigestsFromLatestRequest, server access.AccessAPI_SubscribeBlockDigestsFromLatestServer) error

func (*FlowAccessAPIRouter) SubscribeBlockDigestsFromStartBlockID added in v0.33.30 

func (h *FlowAccessAPIRouter) SubscribeBlockDigestsFromStartBlockID(req *access.SubscribeBlockDigestsFromStartBlockIDRequest, server access.AccessAPI_SubscribeBlockDigestsFromStartBlockIDServer) error

func (*FlowAccessAPIRouter) SubscribeBlockDigestsFromStartHeight added in v0.33.30 

func (h *FlowAccessAPIRouter) SubscribeBlockDigestsFromStartHeight(req *access.SubscribeBlockDigestsFromStartHeightRequest, server access.AccessAPI_SubscribeBlockDigestsFromStartHeightServer) error

func (*FlowAccessAPIRouter) SubscribeBlockHeadersFromLatest added in v0.33.30 

func (h *FlowAccessAPIRouter) SubscribeBlockHeadersFromLatest(req *access.SubscribeBlockHeadersFromLatestRequest, server access.AccessAPI_SubscribeBlockHeadersFromLatestServer) error

func (*FlowAccessAPIRouter) SubscribeBlockHeadersFromStartBlockID added in v0.33.30 

func (h *FlowAccessAPIRouter) SubscribeBlockHeadersFromStartBlockID(req *access.SubscribeBlockHeadersFromStartBlockIDRequest, server access.AccessAPI_SubscribeBlockHeadersFromStartBlockIDServer) error

func (*FlowAccessAPIRouter) SubscribeBlockHeadersFromStartHeight added in v0.33.30 

func (h *FlowAccessAPIRouter) SubscribeBlockHeadersFromStartHeight(req *access.SubscribeBlockHeadersFromStartHeightRequest, server access.AccessAPI_SubscribeBlockHeadersFromStartHeightServer) error

func (*FlowAccessAPIRouter) SubscribeBlocksFromLatest added in v0.33.30 

func (h *FlowAccessAPIRouter) SubscribeBlocksFromLatest(req *access.SubscribeBlocksFromLatestRequest, server access.AccessAPI_SubscribeBlocksFromLatestServer) error

func (*FlowAccessAPIRouter) SubscribeBlocksFromStartBlockID added in v0.33.30 

func (h *FlowAccessAPIRouter) SubscribeBlocksFromStartBlockID(req *access.SubscribeBlocksFromStartBlockIDRequest, server access.AccessAPI_SubscribeBlocksFromStartBlockIDServer) error

func (*FlowAccessAPIRouter) SubscribeBlocksFromStartHeight added in v0.33.30 

func (h *FlowAccessAPIRouter) SubscribeBlocksFromStartHeight(req *access.SubscribeBlocksFromStartHeightRequest, server access.AccessAPI_SubscribeBlocksFromStartHeightServer) error

type Params added in v0.33.30 

type Params struct {
	Log      zerolog.Logger
	Metrics  *metrics.ObserverCollector
	Upstream *FlowAccessAPIForwarder
	Local    *accessflow.Handler
	UseIndex bool
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.