api

package

v0.0.0-...-782215f Latest Latest Go to latest Published: Dec 30, 2022 License: Apache-2.0 Imports: 4 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

Repository

github.com/858chain/token-shout

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func R(data interface{}) gin.H
type ApiServer
- func NewApiServer(addr string) *ApiServer

Constants ¶

This section is empty.

Variables ¶

View Source

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.

Source Files ¶

View all Source files

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