api

package

v0.0.0-...-bda66fc Latest Latest Go to latest Published: Aug 27, 2019 License: ISC Imports: 22 Imported by: 1

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

View Source

const (
	// MaxLatest is the highest limit amount for getRandom
	MaxLatest = 100
)

This section is empty.

func DecodeHash(s string) (hash.Hash, error)

DecodeHash is a utility function, allowing the decoding of various formats

func JSONize(o *tangle.Object) jsonSite

JSONize converts an object into a jsonSite

type API struct {
	ListenInterface string
	Message         string
	// contains filtered or unexported fields
}

API is used as a container, allowing the REST API to access the node

func New(c config.Configuration, n *node.Node) *API

New returns a configured instance of the API server

func (a *API) Run() error

Run starts the API server as specified in the configuration

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

Error is returned when something has gone wrong