server

README

Installation

1. go get github.com/rakyll/statik

Steps to follow

1. cd maticnetwork/heimdall/server
2. Update swagger.yaml file inside swagger-ui directory
3. cd maticnetwork/heimdall/server && statik -src=./swagger-ui
4. cd maticnetwork/heimdall && make build
5. cd maticnetwork/heimdall && make run-server

Visit http://localhost:1317/swagger-ui/

Reference

• https://github.com/rakyll/statik

Documentation

Index

• func DecorateWithRestFlags(cmd *cobra.Command)
• func RegisterRoutes(ctx client.CLIContext, mux *mux.Router)
• func ServeCommands(shutdownCtx ctx.Context, cdc *codec.Codec, ...) *cobra.Command
• func StartRestServer(mainCtx ctx.Context, cdc *codec.Codec, ...) error

Functions

func DecorateWithRestFlags

func DecorateWithRestFlags(cmd *cobra.Command)

function is called whenever is the reste server flags has to be added to command

func RegisterRoutes

func RegisterRoutes(ctx client.CLIContext, mux *mux.Router)

RegisterRoutes register routes of all modules

func ServeCommands

func ServeCommands(shutdownCtx ctx.Context, cdc *codec.Codec, registerRoutesFn func(ctx client.CLIContext, mux *mux.Router)) *cobra.Command

ServeCommands will generate a long-running rest server (aka Light Client Daemon) that exposes functionality similar to the cli, but over rest

func StartRestServer

func StartRestServer(mainCtx ctx.Context, cdc *codec.Codec, registerRoutesFn func(ctx client.CLIContext, mux *mux.Router), restCh chan struct{}) error