api

Documentation

Index

• Variables
• func R(data interface{}) gin.H
• type ApiServer
  • func NewApiServer(addr string) *ApiServer
  • func (api *ApiServer) HealthCheck() (err error)
  • func (api *ApiServer) HttpListen() error
  • func (api *ApiServer) InitAndStartEthClient(cfg *ethclient.Config) (err error)

Variables

var METHODS_SUPPORTED = map[string]string{

	"/ping":   "check if api service valid and backend bitcoin service healthy",
	"/health": "check system status",
	"/help":   "display this message",

	"/install":   "install receiver",
	"/uninstall": "uninstall/remove receiver",
	"/list":      "list all avaliable receivers",
}

http api list

Functions

func R

func R(data interface{}) gin.H

Types

type ApiServer

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

func NewApiServer

func NewApiServer(addr string) *ApiServer

Hook all HTTP routes and start listen on `addr`

func (*ApiServer) HealthCheck

func (api *ApiServer) HealthCheck() (err error)

Check eth rpc server connectivity.

func (*ApiServer) HttpListen

func (api *ApiServer) HttpListen() error

func (*ApiServer) InitAndStartEthClient

func (api *ApiServer) InitAndStartEthClient(cfg *ethclient.Config) (err error)

InitEthClient do the config validation for make initial call to eth backend. Error return if malformat config or rpc server unreachable.