rest

Documentation

Index

• Constants
• func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router, queryRoute string)
• type CreateClientReq
• type SubmitMisbehaviourReq
• type UpdateClientReq

Constants

const (
	RestClientID   = "client-id"
	RestRootHeight = "height"
)

REST client flags

Functions

func RegisterRoutes

func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router, queryRoute string)

RegisterRoutes - Central function to define routes that get registered by the main application

Types

type CreateClientReq

type CreateClientReq struct {
	BaseReq         rest.BaseReq      `json:"base_req" yaml:"base_req"`
	ClientID        string            `json:"client_id" yaml:"client_id"`
	ChainID         string            `json:"chain_id" yaml:"chain_id"`
	Header          ibctmtypes.Header `json:"header" yaml:"header"`
	TrustLevel      tmmath.Fraction   `json:"trust_level" yaml:"trust_level"`
	TrustingPeriod  time.Duration     `json:"trusting_period" yaml:"trusting_period"`
	UnbondingPeriod time.Duration     `json:"unbonding_period" yaml:"unbonding_period"`
	MaxClockDrift   time.Duration     `json:"max_clock_drift" yaml:"max_clock_drift"`
}

CreateClientReq defines the properties of a create client request's body.

type SubmitMisbehaviourReq

type SubmitMisbehaviourReq struct {
	BaseReq  rest.BaseReq              `json:"base_req" yaml:"base_req"`
	Evidence evidenceexported.Evidence `json:"evidence" yaml:"evidence"`
}

SubmitMisbehaviourReq defines the properties of a submit misbehaviour request's body.

type UpdateClientReq

type UpdateClientReq struct {
	BaseReq rest.BaseReq      `json:"base_req" yaml:"base_req"`
	Header  ibctmtypes.Header `json:"header" yaml:"header"`
}

UpdateClientReq defines the properties of a update client request's body.