rest

package

v1.0.5 Latest Latest Go to latest Published: Mar 18, 2024 License: GPL-3.0 Imports: 10 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/maticnetwork/heimdall

Links

Open Source Insights

Documentation ¶

Overview ¶

nolint

Index ¶

func QueryBalancesRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc
func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)
func SendRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc
type Address
type BaseReq
type SendReq
type SendReqInput

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func QueryBalancesRequestHandlerFn ¶

func QueryBalancesRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc

swagger:route GET /bank/balances/{address} bank bankBalanceByAddress It returns the matic balance of particular address responses:

200: bankBalanceByAddressResponse

QueryBalancesRequestHandlerFn query accountREST Handler

func RegisterRoutes ¶

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

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

func SendRequestHandlerFn ¶

func SendRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc

swagger:route POST /bank/accounts/{address}/transfers bank bankBalanceTransfer It returns the prepared msg for the transfer of balance from one account to another. responses:

200: bankBalanceTransferResponse

SendRequestHandlerFn - http request handler to send coins to a address.

Types ¶

type Address ¶ added in v0.3.2

type Address struct {

	//Address of the account
	//required:true
	//in:path
	Address string `json:"address"`

	//Address of the account
	//in:query
	Height string `json:"height"`
}

type BaseReq ¶ added in v0.3.2

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 SendReq ¶

type SendReq struct {
	BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"`

	Amount sdk.Coins `json:"amount" yaml:"amount"`
}

SendReq defines the properties of a send request's body.

type SendReqInput ¶ added in v0.3.2

type SendReqInput struct {

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

	//required:true
	//in:body
	Amount []coin `json:"amount"`
}

Source Files ¶

View all Source files

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