explorer

package

v0.5.8 Latest Latest Go to latest Published: Jan 15, 2021 License: GPL-3.0 Imports: 11 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.

This section is empty.

func NewHandler(store mock.GlobalStorer, corsOrigins []string) (handler http.Handler)

NewHandler constructs an http.Handler with router that servers requests required by chunk explorer.

/api/has-key/{node}/{key}
/api/keys?start={key}&node={node}&limit={int[0..1000]}
/api/nodes?start={node}&key={key}&limit={int[0..1000]}

Data from global store will be served and appropriate CORS headers will be sent if allowed origins are provided.

type KeysResponse struct {
	Keys []string `json:"keys"`
	Next string   `json:"next,omitempty"`
}

KeysResponse is a JSON-encoded response for global store Keys and NodeKeys methods.

type NodesResponse struct {
	Nodes []string `json:"nodes"`
	Next  string   `json:"next,omitempty"`
}

NodesResponse is a JSON-encoded response for global store Nodes and KeyNodes methods.

type StatusResponse struct {
	Message string `json:"message"`
	Code    int    `json:"code"`
}

StatusResponse is a standardized JSON-encoded response that contains information about HTTP response code for easier status identification.