types

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 6, 2023 License: Apache-2.0 Imports: 40 Imported by: 0

Documentation

Overview

Package types is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	// SubModuleName defines the IBC client name
	SubModuleName string = "client"

	// RouterKey is the message route for IBC client
	RouterKey string = SubModuleName

	// QuerierRoute is the querier route for IBC client
	QuerierRoute string = SubModuleName

	// KeyNextClientSequence is the key used to store the next client sequence in
	// the keeper.
	KeyNextClientSequence = "nextClientSequence"
)
View Source 
const DefaultIbcEnabled = true

DefaultIbcEnabled enabled

Variables

View Source 
var (
	ErrInvalidLengthGenesis        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenesis          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupGenesis = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	ErrInvalidLengthQuery        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowQuery          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupQuery = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var ErrIbcDisabled = sdkerrors.Register(host.ModuleName, 1, "IBC are disabled")
View Source 
var IsClientIDFormat = regexp.MustCompile(`^.*[^-]-[0-9]{1,20}$`).MatchString

IsClientIDFormat checks if a clientID is in the format required on the SDK for parsing client identifiers. The client identifier must be in the form: `{client-type}-{N}

View Source 
var KeyIbcEnabled = []byte("IbcEnabled")

KeyIbcEnabled is store's key for IbcEnabled Params

View Source 
var ModuleCdc *codec.Codec

Functions

func FormatClientIdentifier 

func FormatClientIdentifier(clientType string, sequence uint64) string

FormatClientIdentifier returns the client identifier with the sequence appended. This is a SDK specific format not enforced by IBC protocol.

func IsValidClientID 

func IsValidClientID(clientID string) bool

IsValidClientID checks if the clientID is valid and can be parsed into the client identifier format.

func ParamKeyTable 

func ParamKeyTable() paramtypes.KeyTable

ParamKeyTable type declaration for parameters

func ParseClientIdentifier 

func ParseClientIdentifier(clientID string) (string, uint64, error)

ParseClientIdentifier parses the client type and sequence from the client identifier.

func RegisterCodec 

func RegisterCodec(cdc *codec.Codec)

func RegisterInterfaces 

func RegisterInterfaces(registry codectypes.InterfaceRegistry)

RegisterInterfaces registers x/ibc interfaces into protobuf Any.

func RegisterQueryHandler 

func RegisterQueryHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterQueryHandler registers the http handlers for service Query to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterQueryHandlerClient 

func RegisterQueryHandlerClient(ctx context.Context, mux *runtime.ServeMux, client QueryClient) error

RegisterQueryHandlerClient registers the http handlers for service Query to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "QueryClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "QueryClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "QueryClient" to call the correct interceptors.

func RegisterQueryHandlerFromEndpoint 

func RegisterQueryHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterQueryHandlerServer 

func RegisterQueryHandlerServer(ctx context.Context, mux *runtime.ServeMux, server QueryServer) error

RegisterQueryHandlerServer registers the http handlers for service Query to "mux". UnaryRPC :call QueryServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterQueryHandlerFromEndpoint instead.

func RegisterQueryServer 

func RegisterQueryServer(s grpc1.Server, srv QueryServer)

func RegisterQueryService 

func RegisterQueryService(server grpc.Server, queryService QueryService)

RegisterQueryService registers each individual IBC submodule query service

Types

type GenesisState 

type GenesisState struct {
	// ICS002 - Clients genesis state
	ClientGenesis clienttypes.GenesisState `protobuf:"bytes,1,opt,name=client_genesis,json=clientGenesis,proto3" json:"client_genesis" yaml:"client_genesis"`
	// ICS003 - Connections genesis state
	ConnectionGenesis conntypes.GenesisState `` /* 128-byte string literal not displayed */
	// ICS004 - Channel genesis state
	ChannelGenesis channeltyeps.GenesisState `protobuf:"bytes,3,opt,name=channel_genesis,json=channelGenesis,proto3" json:"channel_genesis" yaml:"channel_genesis"`
	Params         Params                    `protobuf:"bytes,4,opt,name=params,proto3" json:"params"`
}

GenesisState defines the ibc module's genesis state.

func DefaultGenesisState 

func DefaultGenesisState() *GenesisState

DefaultGenesisState returns the ibc module's default genesis state.

func (*GenesisState) Descriptor 

func (*GenesisState) Descriptor() ([]byte, []int)

func (*GenesisState) GetChannelGenesis 

func (m *GenesisState) GetChannelGenesis() channeltyeps.GenesisState

func (*GenesisState) GetClientGenesis 

func (m *GenesisState) GetClientGenesis() clienttypes.GenesisState

func (*GenesisState) GetConnectionGenesis 

func (m *GenesisState) GetConnectionGenesis() conntypes.GenesisState

func (*GenesisState) GetParams 

func (m *GenesisState) GetParams() Params

func (*GenesisState) Marshal 

func (m *GenesisState) Marshal() (dAtA []byte, err error)

func (*GenesisState) MarshalTo 

func (m *GenesisState) MarshalTo(dAtA []byte) (int, error)

func (*GenesisState) MarshalToSizedBuffer 

func (m *GenesisState) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GenesisState) ProtoMessage 

func (*GenesisState) ProtoMessage()

func (*GenesisState) Reset 

func (m *GenesisState) Reset()

func (*GenesisState) Size 

func (m *GenesisState) Size() (n int)

func (*GenesisState) String 

func (m *GenesisState) String() string

func (*GenesisState) Unmarshal 

func (m *GenesisState) Unmarshal(dAtA []byte) error

func (GenesisState) UnpackInterfaces 

func (gs GenesisState) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error

UnpackInterfaces implements UnpackInterfacesMessage.UnpackInterfaces

func (*GenesisState) Validate 

func (gs *GenesisState) Validate() error

Validate performs basic genesis state validation returning an error upon any failure.

func (*GenesisState) XXX_DiscardUnknown 

func (m *GenesisState) XXX_DiscardUnknown()

func (*GenesisState) XXX_Marshal 

func (m *GenesisState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GenesisState) XXX_Merge 

func (m *GenesisState) XXX_Merge(src proto.Message)

func (*GenesisState) XXX_Size 

func (m *GenesisState) XXX_Size() int

func (*GenesisState) XXX_Unmarshal 

func (m *GenesisState) XXX_Unmarshal(b []byte) error

type Params 

type Params struct {
	EnableIbc bool `protobuf:"varint,1,opt,name=enable_ibc,json=enableIbc,proto3" json:"enable_ibc,omitempty" yaml:"enable_ibc"`
}

Params defines the set of IBC module parameters.

func DefaultParams 

func DefaultParams() Params

DefaultParams is the default parameter configuration for the ibc module

func NewParams 

func NewParams(enableIbc bool) Params

NewParams creates a new parameter configuration for the ibc module

func (*Params) Descriptor 

func (*Params) Descriptor() ([]byte, []int)

func (*Params) GetEnableIbc 

func (m *Params) GetEnableIbc() bool

func (*Params) Marshal 

func (m *Params) Marshal() (dAtA []byte, err error)

func (*Params) MarshalTo 

func (m *Params) MarshalTo(dAtA []byte) (int, error)

func (*Params) MarshalToSizedBuffer 

func (m *Params) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Params) ParamSetPairs 

func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs

ParamSetPairs implements params.ParamSet

func (*Params) ProtoMessage 

func (*Params) ProtoMessage()

func (*Params) Reset 

func (m *Params) Reset()

func (*Params) Size 

func (m *Params) Size() (n int)

func (*Params) String 

func (m *Params) String() string

func (*Params) Unmarshal 

func (m *Params) Unmarshal(dAtA []byte) error

func (Params) Validate 

func (p Params) Validate() error

Validate all ibc module parameters

func (*Params) XXX_DiscardUnknown 

func (m *Params) XXX_DiscardUnknown()

func (*Params) XXX_Marshal 

func (m *Params) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Params) XXX_Merge 

func (m *Params) XXX_Merge(src proto.Message)

func (*Params) XXX_Size 

func (m *Params) XXX_Size() int

func (*Params) XXX_Unmarshal 

func (m *Params) XXX_Unmarshal(b []byte) error

type QueryClient 

type QueryClient interface {
	// ClientParams queries all parameters of the ibc module.
	IbcParams(ctx context.Context, in *QueryIbcParamsRequest, opts ...grpc.CallOption) (*QueryIbcParamsResponse, error)
}

QueryClient is the client API for Query service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewQueryClient 

func NewQueryClient(cc grpc1.ClientConn) QueryClient

type QueryIbcParamsRequest 

type QueryIbcParamsRequest struct {
}

QueryIbcParamsRequest is the request type for the Query/IbcParams RPC method.

func (*QueryIbcParamsRequest) Descriptor 

func (*QueryIbcParamsRequest) Descriptor() ([]byte, []int)

func (*QueryIbcParamsRequest) Marshal 

func (m *QueryIbcParamsRequest) Marshal() (dAtA []byte, err error)

func (*QueryIbcParamsRequest) MarshalTo 

func (m *QueryIbcParamsRequest) MarshalTo(dAtA []byte) (int, error)

func (*QueryIbcParamsRequest) MarshalToSizedBuffer 

func (m *QueryIbcParamsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryIbcParamsRequest) ProtoMessage 

func (*QueryIbcParamsRequest) ProtoMessage()

func (*QueryIbcParamsRequest) Reset 

func (m *QueryIbcParamsRequest) Reset()

func (*QueryIbcParamsRequest) Size 

func (m *QueryIbcParamsRequest) Size() (n int)

func (*QueryIbcParamsRequest) String 

func (m *QueryIbcParamsRequest) String() string

func (*QueryIbcParamsRequest) Unmarshal 

func (m *QueryIbcParamsRequest) Unmarshal(dAtA []byte) error

func (*QueryIbcParamsRequest) XXX_DiscardUnknown 

func (m *QueryIbcParamsRequest) XXX_DiscardUnknown()

func (*QueryIbcParamsRequest) XXX_Marshal 

func (m *QueryIbcParamsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryIbcParamsRequest) XXX_Merge 

func (m *QueryIbcParamsRequest) XXX_Merge(src proto.Message)

func (*QueryIbcParamsRequest) XXX_Size 

func (m *QueryIbcParamsRequest) XXX_Size() int

func (*QueryIbcParamsRequest) XXX_Unmarshal 

func (m *QueryIbcParamsRequest) XXX_Unmarshal(b []byte) error

type QueryIbcParamsResponse 

type QueryIbcParamsResponse struct {
	// params defines the parameters of the module.
	Params *Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params,omitempty"`
}

QueryIbcParamsResponse is the response type for the Query/IbcParams RPC method.

func (*QueryIbcParamsResponse) Descriptor 

func (*QueryIbcParamsResponse) Descriptor() ([]byte, []int)

func (*QueryIbcParamsResponse) GetParams 

func (m *QueryIbcParamsResponse) GetParams() *Params

func (*QueryIbcParamsResponse) Marshal 

func (m *QueryIbcParamsResponse) Marshal() (dAtA []byte, err error)

func (*QueryIbcParamsResponse) MarshalTo 

func (m *QueryIbcParamsResponse) MarshalTo(dAtA []byte) (int, error)

func (*QueryIbcParamsResponse) MarshalToSizedBuffer 

func (m *QueryIbcParamsResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryIbcParamsResponse) ProtoMessage 

func (*QueryIbcParamsResponse) ProtoMessage()

func (*QueryIbcParamsResponse) Reset 

func (m *QueryIbcParamsResponse) Reset()

func (*QueryIbcParamsResponse) Size 

func (m *QueryIbcParamsResponse) Size() (n int)

func (*QueryIbcParamsResponse) String 

func (m *QueryIbcParamsResponse) String() string

func (*QueryIbcParamsResponse) Unmarshal 

func (m *QueryIbcParamsResponse) Unmarshal(dAtA []byte) error

func (*QueryIbcParamsResponse) XXX_DiscardUnknown 

func (m *QueryIbcParamsResponse) XXX_DiscardUnknown()

func (*QueryIbcParamsResponse) XXX_Marshal 

func (m *QueryIbcParamsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryIbcParamsResponse) XXX_Merge 

func (m *QueryIbcParamsResponse) XXX_Merge(src proto.Message)

func (*QueryIbcParamsResponse) XXX_Size 

func (m *QueryIbcParamsResponse) XXX_Size() int

func (*QueryIbcParamsResponse) XXX_Unmarshal 

func (m *QueryIbcParamsResponse) XXX_Unmarshal(b []byte) error

type QueryServer 

type QueryServer interface {
	// ClientParams queries all parameters of the ibc module.
	IbcParams(context.Context, *QueryIbcParamsRequest) (*QueryIbcParamsResponse, error)
}

QueryServer is the server API for Query service.

type QueryService 

type QueryService interface {
	clienttypes.QueryServer
	connectiontypes.QueryServer
	channeltypes.QueryServer
	porttypes.QueryServer
	QueryServer
}

QueryService defines the IBC interfaces that the gRPC query server must implement

type UnimplementedQueryServer 

type UnimplementedQueryServer struct {
}

UnimplementedQueryServer can be embedded to have forward compatible implementations.

func (*UnimplementedQueryServer) IbcParams 

func (*UnimplementedQueryServer) IbcParams(ctx context.Context, req *QueryIbcParamsRequest) (*QueryIbcParamsResponse, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.