package
4.0.2-stable+incompatible
Repository: https://github.com/algorand/go-algorand.git
Documentation: pkg.go.dev

# Functions

MaxSize returns a maximum valid message size for this message type.
FormatBlockQuery formats a block request query for the given network and round number.
MakeBlockService creates a BlockService around the provider Ledger and registers it for HTTP callback on the block serving path.
MakeHealthService creates a new HealthService and registers it with the provided network if enabled.
MakeLedgerService creates a LedgerService around the provider Ledger and registers it with the HTTP router.
MakeTxSyncer returns a TxSyncer.
RawBlockBytes return the msgpack bytes for a block.
RegisterTxService creates a TxService around the provider transaction pool and registers it for RPC with the provided Registrar.
ResponseBytes reads the content of the response object and return the body content while obeying the read size limits.

# Constants

block+cert request data (as the value of requestDataTypeKey).
Block-data topic-key in the response.
BlockResponseContentType is the HTTP Content-Type header for a raw binary block.
BlockResponseLatestRoundHeader is returned in the response header when the requested block is not available.
BlockServiceBlockPath is the path to register BlockService as a handler for when using gorilla/mux e.g.
Cert-data topic-key in the response.
Constant strings used as keys for topics.
LedgerResponseContentType is the HTTP Content-Type header for a raw ledger block.
LedgerServiceLedgerPath is the path to register LedgerService as a handler for when using gorilla/mux e.g.
Data-type topic-key in the request (e.g.
Block round-number topic-key in the request.
TxServiceHTTPPath is the URL path to sync pending transactions from.

# Structs

BlockService represents the Block RPC API.
EncodedBlockCert defines how GetBlockBytes encodes a block and its certificate.
HealthService is a service that provides health information endpoints for the node.
HTTPTxSync implements the TxSyncClient interface over HTTP.
LedgerService represents the Ledger RPC API.
PreEncodedBlockCert defines how GetBlockBytes encodes a block and its certificate, using a pre-encoded Block and Certificate in msgpack format.
TxService provides a service that allows a remote caller to retrieve missing pending transactions.
TxSyncer fetches pending transactions that are missing from its pool, and feeds them to the handler.

# Interfaces

LedgerForBlockService describes the Ledger methods used by BlockService.
LedgerForService defines the ledger interface required for the LedgerService.
PendingTxAggregate is a container of pending transactions.
Registrar is subset of network.GossipNode.
TxSyncClient abstracts sync-ing pending transactions from a peer.