rest

Documentation

Overview

Package classification HiemdallRest API

    Schemes: http
    BasePath: /
    Version: 0.0.1
    title: Heimdall APIs
    Consumes:
    - application/json
	   Host:localhost:1317
    - application/json

nolint

nolint

Index

• Variables
• func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)
• type BaseReq
• type Height
• type HeimdallSpanResultWithHeight
• type ProposeSpanReq
• type ResponseWithHeight
• type SendReqInput

Variables

var RestLogger tmLog.Logger

RestLogger for bor module logger

var SPAN_OVERRIDES = map[string][]byte{
	"heimdall-137": mainnetSpanJSON,
}

Functions

func RegisterRoutes

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

RegisterRoutes registers bor-related REST handlers to a router

Types

type BaseReq

type BaseReq struct {

	//Address of the sender
	//required:true
	//in:body
	From string `json:"address"`

	//Chain ID of Heimdall
	//required:true
	//in:body
	ChainID string `json:"chain_id"`
}

type Height

type Height struct {

	//Block Height
	//in:query
	Height string `json:"height"`
}

type HeimdallSpanResultWithHeight

type HeimdallSpanResultWithHeight struct {
	Height int64
	Result []byte
}

type ProposeSpanReq

type ProposeSpanReq struct {
	BaseReq rest.BaseReq `json:"base_req"`

	ID         uint64 `json:"span_id"`
	StartBlock uint64 `json:"start_block"`
	BorChainID string `json:"bor_chain_id"`
}

ProposeSpanReq struct for proposing new span

type ResponseWithHeight

type ResponseWithHeight struct {
	Height string              `json:"height"`
	Result jsoniter.RawMessage `json:"result"`
}

ResponseWithHeight defines a response object type that wraps an original response with a height. TODO:Link it with bor

type SendReqInput

type SendReqInput struct {

	//required:true
	//in:body
	BaseReq BaseReq `json:"base_req"`

	//required:true
	//in:body
	ID uint64 `json:"span_id"`

	//required:true
	//in:body
	StartBlock uint64 `json:"start_block"`

	//required:true
	//in:body
	BorChainID string `json:"bor_chain_id"`
}