algod

package

v0.0.0-...-76c1feb Latest Latest Go to latest Published: Sep 1, 2021 License: AGPL-3.0 Imports: 25 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.

This section is empty.

type Server struct {
	RootPath string
	Genesis  bookkeeping.Genesis
	// contains filtered or unexported fields
}

Server represents an instance of the REST API HTTP server

func (s *Server) Initialize(cfg config.Local, phonebookAddresses []string, genesisText string) error

Initialize creates a Node instance with applicable network services

func (s *Server) Start()

Start starts a Node instance and its network services

func (s *Server) Stop()

Stop initiates a graceful shutdown of the node by shutting down the network server.

Path	Synopsis
api
client
server Package server Algod REST API.	Package server Algod REST API.
server/common
server/lib Code generated by bundle_swagger_json.sh, along with swagger.json.	Code generated by bundle_swagger_json.sh, along with swagger.json.
server/lib/middlewares
server/v1/handlers Package handlers handles and helps specify the algod/api Currently, server implementation annotations serve as the API ground truth.	Package handlers handles and helps specify the algod/api Currently, server implementation annotations serve as the API ground truth.
server/v1/routes
server/v2
server/v2/generated Package generated provides primitives to interact the openapi HTTP API.	Package generated provides primitives to interact the openapi HTTP API.
server/v2/generated/private Package private provides primitives to interact the openapi HTTP API.	Package private provides primitives to interact the openapi HTTP API.
server/v2/test
spec/common Package common defines models exposed by algod rest api	Package common defines models exposed by algod rest api
spec/v1 Package v1 defines models exposed by algod rest api	Package v1 defines models exposed by algod rest api