rest

Documentation

Index

• Constants
• func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router, queryRoute string)
• type ChannelCloseConfirmReq
• type ChannelCloseInitReq
• type ChannelOpenAckReq
• type ChannelOpenConfirmReq
• type ChannelOpenInitReq
• type ChannelOpenTryReq
• type RecvPacketReq

Constants

const (
	RestChannelID = "channel-id"
	RestPortID    = "port-id"
)

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 ChannelCloseConfirmReq

type ChannelCloseConfirmReq struct {
	BaseReq     rest.BaseReq                `json:"base_req" yaml:"base_req"`
	ProofInit   commitmenttypes.MerkleProof `json:"proof_init" yaml:"proof_init"`
	ProofHeight uint64                      `json:"proof_height" yaml:"proof_height"`
}

ChannelCloseConfirmReq defines the properties of a channel close confirm request's body.

type ChannelCloseInitReq

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

ConnectionOpenInitReq defines the properties of a channel close init request's body.

type ChannelOpenAckReq

type ChannelOpenAckReq struct {
	BaseReq             rest.BaseReq                `json:"base_req" yaml:"base_req"`
	CounterpartyVersion string                      `json:"counterparty_version" yaml:"counterparty_version"`
	ProofTry            commitmenttypes.MerkleProof `json:"proof_try" yaml:"proof_try"`
	ProofHeight         uint64                      `json:"proof_height" yaml:"proof_height"`
}

ChannelOpenAckReq defines the properties of a channel open ack request's body.

type ChannelOpenConfirmReq

type ChannelOpenConfirmReq struct {
	BaseReq     rest.BaseReq                `json:"base_req" yaml:"base_req"`
	ProofAck    commitmenttypes.MerkleProof `json:"proof_ack" yaml:"proof_ack"`
	ProofHeight uint64                      `json:"proof_height" yaml:"proof_height"`
}

ChannelOpenConfirmReq defines the properties of a channel open confirm request's body.

type ChannelOpenInitReq

type ChannelOpenInitReq struct {
	BaseReq               rest.BaseReq `json:"base_req" yaml:"base_req"`
	PortID                string       `json:"port_id" yaml:"port_id"`
	ChannelID             string       `json:"channel_id" yaml:"channel_id"`
	Version               string       `json:"version" yaml:"version"`
	ChannelOrder          types.Order  `json:"channel_order" yaml:"channel_order"`
	ConnectionHops        []string     `json:"connection_hops" yaml:"connection_hops"`
	CounterpartyPortID    string       `json:"counterparty_port_id" yaml:"counterparty_port_id"`
	CounterpartyChannelID string       `json:"counterparty_channel_id" yaml:"counterparty_channel_id"`
}

ChannelOpenInitReq defines the properties of a channel open init request's body.

type ChannelOpenTryReq

type ChannelOpenTryReq struct {
	BaseReq               rest.BaseReq                `json:"base_req" yaml:"base_req"`
	PortID                string                      `json:"port_id" yaml:"port_id"`
	ChannelID             string                      `json:"channel_id" yaml:"channel_id"`
	Version               string                      `json:"version" yaml:"version"`
	ChannelOrder          types.Order                 `json:"channel_order" yaml:"channel_order"`
	ConnectionHops        []string                    `json:"connection_hops" yaml:"connection_hops"`
	CounterpartyPortID    string                      `json:"counterparty_port_id" yaml:"counterparty_port_id"`
	CounterpartyChannelID string                      `json:"counterparty_channel_id" yaml:"counterparty_channel_id"`
	CounterpartyVersion   string                      `json:"counterparty_version" yaml:"counterparty_version"`
	ProofInit             commitmenttypes.MerkleProof `json:"proof_init" yaml:"proof_init"`
	ProofHeight           uint64                      `json:"proof_height" yaml:"proof_height"`
}

ChannelOpenTryReq defines the properties of a channel open try request's body.

type RecvPacketReq

type RecvPacketReq struct {
	BaseReq rest.BaseReq                `json:"base_req" yaml:"base_req"`
	Packet  types.Packet                `json:"packet" yaml:"packet"`
	Proofs  commitmenttypes.MerkleProof `json:"proofs" yaml:"proofs"`
	Height  uint64                      `json:"height" yaml:"height"`
}

RecvPacketReq defines the properties of a receive packet request's body.