lib

package

v0.0.2 Latest Latest Go to latest Published: Nov 24, 2019 License: AGPL-3.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var SwaggerSpecJSON string

SwaggerSpecJSON is autogenerated from swagger.json, and bundled in with a script on build.

func ErrorResponse(w http.ResponseWriter, status int, internalErr error, publicErr string, logger logging.Logger)

ErrorResponse sets the specified status code (should != 200), and fills in the a human readable error.

type HandlerFunc func(ReqContext, http.ResponseWriter, *http.Request)

HandlerFunc defines a wrapper for http.HandlerFunc that includes a context

type ReqContext struct {
	Node *node.AlgorandFullNode
	Log  logging.Logger
}

ReqContext is passed to each of the handlers below via wrapCtx, allowing handlers to interact with the node

type Route struct {
	Name        string
	Method      string
	Path        string
	HandlerFunc HandlerFunc
}

Route type description

type Routes []Route

Routes contains all routes

Path	Synopsis
middlewares