server

Documentation

Overview

Package server Algod REST API.

Index

• Constants
• func NewRouter(logger logging.Logger, node APINodeInterface, shutdown <-chan struct{}, ...) *echo.Echo
• type APINode
  • func (n APINode) LedgerForAPI() v2.LedgerForAPI
• type APINodeInterface
• type FollowerNode
  • func (n FollowerNode) LedgerForAPI() v2.LedgerForAPI

Constants

const (

	// TokenHeader is the header where we put the token.
	TokenHeader = "X-Algo-API-Token"
	// MaxRequestBodyBytes is the maximum request body size that we allow in our APIs.
	MaxRequestBodyBytes = "10MB"
)

Functions

func NewRouter

func NewRouter(logger logging.Logger, node APINodeInterface, shutdown <-chan struct{}, apiToken string, adminAPIToken string, listener net.Listener, numConnectionsLimit uint64) *echo.Echo

NewRouter builds and returns a new router with our REST handlers registered.

Types

type APINode

type APINode struct{ *node.AlgorandFullNode }

APINode wraps the AlgorandFullNode to provide v2.NodeInterface.

func (APINode) LedgerForAPI

func (n APINode) LedgerForAPI() v2.LedgerForAPI

LedgerForAPI implements the v2.Handlers interface

type APINodeInterface

type APINodeInterface interface {
	lib.NodeInterface
	v2.NodeInterface
}

APINodeInterface describes all the node methods required by common and v2 APIs, and the server/router

type FollowerNode

type FollowerNode struct{ *node.AlgorandFollowerNode }

FollowerNode wraps the AlgorandFollowerNode to provide v2.NodeInterface.

func (FollowerNode) LedgerForAPI

func (n FollowerNode) LedgerForAPI() v2.LedgerForAPI

LedgerForAPI implements the v2.Handlers interface