rest

Documentation

Index

• Constants
• func BroadcastTxRequest(clientCtx client.Context) http.HandlerFunc
• func RegisterRoutes(cliCtx client.Context, r *mux.Router)
• type BroadcastReq
• type PostClaimSwapReq
• type PostCreateSwapReq
• type PostRefundSwapReq

Constants

const (
	RestExpiration = "expiration"
	RestInvolve    = "involve"
	RestStatus     = "status"
	RestDirection  = "direction"
)

REST Variable names nolint

Functions

func BroadcastTxRequest

func BroadcastTxRequest(clientCtx client.Context) http.HandlerFunc

BroadcastTxRequest implements a tx broadcasting handler that is responsible for broadcasting a valid and signed tx to a tendermint RCP port. The tx can be broadcasted via a sync|async|block mechanism via the tendermint RPC Api.

func RegisterRoutes

func RegisterRoutes(cliCtx client.Context, r *mux.Router)

RegisterRoutes registers bep3-related REST handlers to a router

Types

type BroadcastReq

type BroadcastReq struct {
	Tx   legacytx.StdTx `json:"tx" yaml:"tx"`
	Mode string         `json:"mode" yaml:"mode"`
}

BroadcastReq defines a tx broadcasting request.

type PostClaimSwapReq

type PostClaimSwapReq struct {
	BaseReq      rest.BaseReq     `json:"base_req" yaml:"base_req"`
	From         sdk.AccAddress   `json:"from" yaml:"from"`
	SwapID       tmbytes.HexBytes `json:"swap_id" yaml:"swap_id"`
	RandomNumber tmbytes.HexBytes `json:"random_number" yaml:"random_number"`
}

PostClaimSwapReq defines the properties of a swap claim request's body

type PostCreateSwapReq

type PostCreateSwapReq struct {
	BaseReq             rest.BaseReq     `json:"base_req" yaml:"base_req"`
	From                string           `json:"from" yaml:"from"`
	To                  string           `json:"to" yaml:"to"`
	RecipientOtherChain string           `json:"recipient_other_chain" yaml:"recipient_other_chain"`
	SenderOtherChain    string           `json:"sender_other_chain" yaml:"sender_other_chain"`
	RandomNumberHash    tmbytes.HexBytes `json:"random_number_hash" yaml:"random_number_hash"`
	Timestamp           int64            `json:"timestamp" yaml:"timestamp"`
	Amount              sdk.Coins        `json:"amount" yaml:"amount"`
	TimeSpan            int64            `json:"time_span" yaml:"time_span"`
	CrossChain          bool             `json:"cross_chain" yaml:"cross_chain"`
}

PostCreateSwapReq defines the properties of a swap create request's body

type PostRefundSwapReq

type PostRefundSwapReq struct {
	BaseReq rest.BaseReq     `json:"base_req" yaml:"base_req"`
	From    sdk.AccAddress   `json:"from" yaml:"from"`
	SwapID  tmbytes.HexBytes `json:"swap_id" yaml:"swap_id"`
}

PostRefundSwapReq defines the properties of swap refund request's body