algod

package
v0.0.0-...-ff2c966 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 30, 2024 License: AGPL-3.0 Imports: 29 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Server

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

Server represents an instance of the REST API HTTP server

func (*Server) Initialize

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

Initialize creates a Node instance with applicable network services

func (*Server) Start

func (s *Server) Start()

Start starts a Node instance and its network services

func (*Server) Stop

func (s *Server) Stop()

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

type ServerNode

type ServerNode interface {
	apiServer.APINodeInterface
	ListeningAddress() (string, bool)
	Start()
	Stop()
}

ServerNode is the required methods for any node the server fronts

Directories

Path Synopsis
api
server
Package server Algod REST API.
Package server Algod REST API.
server/v2/generated/data
Package data provides primitives to interact with the openapi HTTP API.
Package data provides primitives to interact with the openapi HTTP API.
server/v2/generated/experimental
Package experimental provides primitives to interact with the openapi HTTP API.
Package experimental provides primitives to interact with the openapi HTTP API.
server/v2/generated/model
Package model provides primitives to interact with the openapi HTTP API.
Package model provides primitives to interact with the openapi HTTP API.
server/v2/generated/nonparticipating/private
Package private provides primitives to interact with the openapi HTTP API.
Package private provides primitives to interact with the openapi HTTP API.
server/v2/generated/nonparticipating/public
Package public provides primitives to interact with the openapi HTTP API.
Package public provides primitives to interact with the openapi HTTP API.
server/v2/generated/participating/private
Package private provides primitives to interact with the openapi HTTP API.
Package private provides primitives to interact with the openapi HTTP API.
server/v2/generated/participating/public
Package public provides primitives to interact with the openapi HTTP API.
Package public provides primitives to interact with the openapi HTTP API.
spec/common
Package common defines models exposed by algod rest api
Package common defines models exposed by algod rest api
spec/v2
Package v2 defines models exposed by algod rest api
Package v2 defines models exposed by algod rest api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL