api

Documentation

Index

• type FormattedTx
• type GetTxArgs
• type JSONAddress
• type JSONAddresses
• type JSONChangeAddr
• type JSONFromAddrs
• type JSONSpendHeader
• type JSONTxID
• type JSONTxIDChangeAddr
• type Server
  • func (s *Server) AddAliases(endpoint string, aliases ...string) error
  • func (s *Server) AddAliasesWithReadLock(endpoint string, aliases ...string) error
  • func (s *Server) AddChainRoute(handler *common.HTTPHandler, ctx *snow.Context, base, endpoint string, ...) error
  • func (s *Server) AddRoute(handler *common.HTTPHandler, lock *sync.RWMutex, base, endpoint string, ...) error
  • func (s *Server) Call(writer http.ResponseWriter, method, base, endpoint string, body io.Reader, ...) error
  • func (s *Server) Dispatch() error
  • func (s *Server) DispatchTLS(certFile, keyFile string) error
  • func (s *Server) Initialize(log logging.Logger, factory logging.Factory, host string, port uint16, ...) error
  • func (s *Server) RegisterChain(ctx *snow.Context, vmIntf interface{})
• type SuccessResponse
• type UserPass

Types

type FormattedTx

type FormattedTx struct {
	Tx       string `json:"tx"`
	Encoding string `json:"encoding"`
}

FormattedTx defines a JSON formatted struct containing a Tx in CB58 format

type GetTxArgs

type GetTxArgs struct {
	TxID     ids.ID `json:"txID"`
	Encoding string `json:"encoding"`
}

GetTxArgs ...

type JSONAddress

type JSONAddress struct {
	Address string `json:"address"`
}

JSONAddress contains an address

type JSONAddresses

type JSONAddresses struct {
	Addresses []string `json:"addresses"`
}

JSONAddresses contains a list of address

type JSONChangeAddr

type JSONChangeAddr struct {
	ChangeAddr string `json:"changeAddr"`
}

JSONChangeAddr is the address change is sent to, if any

type JSONFromAddrs

type JSONFromAddrs struct {
	From []string `json:"from"`
}

JSONFromAddrs is a list of addresses to send funds from

type JSONSpendHeader

type JSONSpendHeader struct {
	UserPass
	JSONFromAddrs
	JSONChangeAddr
}

JSONSpendHeader is 3 arguments to a method that spends (including those with tx fees) 1) The username/password 2) The addresses used in the method 3) The address to send change to

type JSONTxID

type JSONTxID struct {
	TxID ids.ID `json:"txID"`
}

JSONTxID contains the ID of a transaction

type JSONTxIDChangeAddr

type JSONTxIDChangeAddr struct {
	JSONTxID
	JSONChangeAddr
}

JSONTxIDChangeAddr is a tx ID and change address

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server maintains the HTTP router

func (*Server) AddAliases

func (s *Server) AddAliases(endpoint string, aliases ...string) error

AddAliases registers aliases to the server

func (*Server) AddAliasesWithReadLock

func (s *Server) AddAliasesWithReadLock(endpoint string, aliases ...string) error

AddAliasesWithReadLock registers aliases to the server assuming the http read lock is currently held.

func (*Server) AddChainRoute

func (s *Server) AddChainRoute(handler *common.HTTPHandler, ctx *snow.Context, base, endpoint string, loggingWriter io.Writer) error

AddChainRoute registers a route to a chain's handler

func (*Server) AddRoute

func (s *Server) AddRoute(handler *common.HTTPHandler, lock *sync.RWMutex, base, endpoint string, loggingWriter io.Writer) error

AddRoute registers a route to a handler.

func (*Server) Call

func (s *Server) Call(
	writer http.ResponseWriter,
	method,
	base,
	endpoint string,
	body io.Reader,
	headers map[string]string,
) error

Call ...

func (*Server) Dispatch

func (s *Server) Dispatch() error

Dispatch starts the API server

func (*Server) DispatchTLS

func (s *Server) DispatchTLS(certFile, keyFile string) error

DispatchTLS starts the API server with the provided TLS certificate

func (*Server) Initialize

func (s *Server) Initialize(
	log logging.Logger,
	factory logging.Factory,
	host string,
	port uint16,
	authEnabled bool,
	authPassword string,
) error

Initialize creates the API server at the provided host and port

func (*Server) RegisterChain

func (s *Server) RegisterChain(ctx *snow.Context, vmIntf interface{})

RegisterChain registers the API endpoints associated with this chain That is, add <route, handler> pairs to server so that http calls can be made to the vm

type SuccessResponse

type SuccessResponse struct {
	Success bool `json:"success"`
}

SuccessResponse indicates success of an API call

type UserPass

type UserPass struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

UserPass contains a username and a password