types

package
v7.5.0 Latest Latest
Warning

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

 Go to latest Published: May 14, 2024 License: MIT Imports: 27 Imported by: 301

Documentation

Overview

Package types is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	// SubModuleName defines the interchain accounts host module name
	SubModuleName = "icahost"

	// StoreKey is the store key string for the interchain accounts host module
	StoreKey = SubModuleName

	// AllowAllHostMsgs holds the string key that allows all message types on interchain accounts host module
	AllowAllHostMsgs = "*"
)
View Source 
const (
	// DefaultHostEnabled is the default value for the host param (set to true)
	DefaultHostEnabled = true
)

Variables

View Source 
var (
	ErrInvalidLengthHost        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowHost          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupHost = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	// KeyHostEnabled is the store key for HostEnabled Params
	KeyHostEnabled = []byte("HostEnabled")
	// KeyAllowMessages is the store key for the AllowMessages Params
	KeyAllowMessages = []byte("AllowMessages")
)
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 (
	ErrInvalidLengthTx        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTx          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupTx = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	ErrHostSubModuleDisabled = sdkerrors.Register(SubModuleName, 2, "host submodule is disabled")
)

ICA Host sentinel errors

Functions

func ContainsMsgType 

func ContainsMsgType(allowMsgs []string, msg sdk.Msg) bool

ContainsMsgType returns true if the sdk.Msg TypeURL is present in allowMsgs, otherwise false

func ParamKeyTable 

func ParamKeyTable() paramtypes.KeyTable

ParamKeyTable type declaration for parameters

func RegisterInterfaces added in v7.5.0 

func RegisterInterfaces(registry codectypes.InterfaceRegistry)

RegisterInterfaces registers the interchain accounts host message types using the provided InterfaceRegistry

func RegisterMsgServer added in v7.5.0 

func RegisterMsgServer(s grpc1.Server, srv MsgServer)

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)

Types

type MsgClient added in v7.5.0 

type MsgClient interface {
	// ModuleQuerySafe defines a rpc handler for MsgModuleQuerySafe.
	ModuleQuerySafe(ctx context.Context, in *MsgModuleQuerySafe, opts ...grpc.CallOption) (*MsgModuleQuerySafeResponse, error)
}

MsgClient is the client API for Msg service.

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

func NewMsgClient added in v7.5.0 

func NewMsgClient(cc grpc1.ClientConn) MsgClient

type MsgModuleQuerySafe added in v7.5.0 

type MsgModuleQuerySafe struct {
	// signer address
	Signer string `protobuf:"bytes,1,opt,name=signer,proto3" json:"signer,omitempty"`
	// requests defines the module safe queries to execute.
	Requests []*QueryRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
}

MsgModuleQuerySafe defines the payload for Msg/ModuleQuerySafe

func NewMsgModuleQuerySafe added in v7.5.0 

func NewMsgModuleQuerySafe(signer string, requests []*QueryRequest) *MsgModuleQuerySafe

NewMsgModuleQuerySafe creates a new MsgModuleQuerySafe instance

func (*MsgModuleQuerySafe) Descriptor added in v7.5.0 

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

func (MsgModuleQuerySafe) GetSigners added in v7.5.0 

func (msg MsgModuleQuerySafe) GetSigners() []sdk.AccAddress

GetSigners implements sdk.Msg

func (*MsgModuleQuerySafe) Marshal added in v7.5.0 

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

func (*MsgModuleQuerySafe) MarshalTo added in v7.5.0 

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

func (*MsgModuleQuerySafe) MarshalToSizedBuffer added in v7.5.0 

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

func (*MsgModuleQuerySafe) ProtoMessage added in v7.5.0 

func (*MsgModuleQuerySafe) ProtoMessage()

func (*MsgModuleQuerySafe) Reset added in v7.5.0 

func (m *MsgModuleQuerySafe) Reset()

func (*MsgModuleQuerySafe) Size added in v7.5.0 

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

func (*MsgModuleQuerySafe) String added in v7.5.0 

func (m *MsgModuleQuerySafe) String() string

func (*MsgModuleQuerySafe) Unmarshal added in v7.5.0 

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

func (MsgModuleQuerySafe) ValidateBasic added in v7.5.0 

func (msg MsgModuleQuerySafe) ValidateBasic() error

ValidateBasic implements sdk.HasValidateBasic

func (*MsgModuleQuerySafe) XXX_DiscardUnknown added in v7.5.0 

func (m *MsgModuleQuerySafe) XXX_DiscardUnknown()

func (*MsgModuleQuerySafe) XXX_Marshal added in v7.5.0 

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

func (*MsgModuleQuerySafe) XXX_Merge added in v7.5.0 

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

func (*MsgModuleQuerySafe) XXX_Size added in v7.5.0 

func (m *MsgModuleQuerySafe) XXX_Size() int

func (*MsgModuleQuerySafe) XXX_Unmarshal added in v7.5.0 

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

type MsgModuleQuerySafeResponse added in v7.5.0 

type MsgModuleQuerySafeResponse struct {
	// height at which the responses were queried
	Height uint64 `protobuf:"varint,1,opt,name=height,proto3" json:"height,omitempty"`
	// protobuf encoded responses for each query
	Responses [][]byte `protobuf:"bytes,2,rep,name=responses,proto3" json:"responses,omitempty"`
}

MsgModuleQuerySafeResponse defines the response for Msg/ModuleQuerySafe

func (*MsgModuleQuerySafeResponse) Descriptor added in v7.5.0 

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

func (*MsgModuleQuerySafeResponse) GetHeight added in v7.5.0 

func (m *MsgModuleQuerySafeResponse) GetHeight() uint64

func (*MsgModuleQuerySafeResponse) GetResponses added in v7.5.0 

func (m *MsgModuleQuerySafeResponse) GetResponses() [][]byte

func (*MsgModuleQuerySafeResponse) Marshal added in v7.5.0 

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

func (*MsgModuleQuerySafeResponse) MarshalTo added in v7.5.0 

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

func (*MsgModuleQuerySafeResponse) MarshalToSizedBuffer added in v7.5.0 

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

func (*MsgModuleQuerySafeResponse) ProtoMessage added in v7.5.0 

func (*MsgModuleQuerySafeResponse) ProtoMessage()

func (*MsgModuleQuerySafeResponse) Reset added in v7.5.0 

func (m *MsgModuleQuerySafeResponse) Reset()

func (*MsgModuleQuerySafeResponse) Size added in v7.5.0 

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

func (*MsgModuleQuerySafeResponse) String added in v7.5.0 

func (m *MsgModuleQuerySafeResponse) String() string

func (*MsgModuleQuerySafeResponse) Unmarshal added in v7.5.0 

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

func (*MsgModuleQuerySafeResponse) XXX_DiscardUnknown added in v7.5.0 

func (m *MsgModuleQuerySafeResponse) XXX_DiscardUnknown()

func (*MsgModuleQuerySafeResponse) XXX_Marshal added in v7.5.0 

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

func (*MsgModuleQuerySafeResponse) XXX_Merge added in v7.5.0 

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

func (*MsgModuleQuerySafeResponse) XXX_Size added in v7.5.0 

func (m *MsgModuleQuerySafeResponse) XXX_Size() int

func (*MsgModuleQuerySafeResponse) XXX_Unmarshal added in v7.5.0 

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

type MsgServer added in v7.5.0 

type MsgServer interface {
	// ModuleQuerySafe defines a rpc handler for MsgModuleQuerySafe.
	ModuleQuerySafe(context.Context, *MsgModuleQuerySafe) (*MsgModuleQuerySafeResponse, error)
}

MsgServer is the server API for Msg service.

type Params 

type Params struct {
	// host_enabled enables or disables the host submodule.
	HostEnabled bool `protobuf:"varint,1,opt,name=host_enabled,json=hostEnabled,proto3" json:"host_enabled,omitempty" yaml:"host_enabled"`
	// allow_messages defines a list of sdk message typeURLs allowed to be executed on a host chain.
	AllowMessages []string `protobuf:"bytes,2,rep,name=allow_messages,json=allowMessages,proto3" json:"allow_messages,omitempty" yaml:"allow_messages"`
}

Params defines the set of on-chain interchain accounts parameters. The following parameters may be used to disable the host submodule.

func DefaultParams 

func DefaultParams() Params

DefaultParams is the default parameter configuration for the host submodule

func NewParams 

func NewParams(enableHost bool, allowMsgs []string) Params

NewParams creates a new parameter configuration for the host submodule

func (*Params) Descriptor 

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

func (*Params) GetAllowMessages 

func (m *Params) GetAllowMessages() []string

func (*Params) GetHostEnabled 

func (m *Params) GetHostEnabled() 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 validates all host submodule 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 {
	// Params queries all parameters of the ICA host submodule.
	Params(ctx context.Context, in *QueryParamsRequest, opts ...grpc.CallOption) (*QueryParamsResponse, 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 QueryParamsRequest 

type QueryParamsRequest struct {
}

QueryParamsRequest is the request type for the Query/Params RPC method.

func (*QueryParamsRequest) Descriptor 

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

func (*QueryParamsRequest) Marshal 

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

func (*QueryParamsRequest) MarshalTo 

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

func (*QueryParamsRequest) MarshalToSizedBuffer 

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

func (*QueryParamsRequest) ProtoMessage 

func (*QueryParamsRequest) ProtoMessage()

func (*QueryParamsRequest) Reset 

func (m *QueryParamsRequest) Reset()

func (*QueryParamsRequest) Size 

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

func (*QueryParamsRequest) String 

func (m *QueryParamsRequest) String() string

func (*QueryParamsRequest) Unmarshal 

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

func (*QueryParamsRequest) XXX_DiscardUnknown 

func (m *QueryParamsRequest) XXX_DiscardUnknown()

func (*QueryParamsRequest) XXX_Marshal 

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

func (*QueryParamsRequest) XXX_Merge 

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

func (*QueryParamsRequest) XXX_Size 

func (m *QueryParamsRequest) XXX_Size() int

func (*QueryParamsRequest) XXX_Unmarshal 

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

type QueryParamsResponse 

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

QueryParamsResponse is the response type for the Query/Params RPC method.

func (*QueryParamsResponse) Descriptor 

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

func (*QueryParamsResponse) GetParams 

func (m *QueryParamsResponse) GetParams() *Params

func (*QueryParamsResponse) Marshal 

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

func (*QueryParamsResponse) MarshalTo 

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

func (*QueryParamsResponse) MarshalToSizedBuffer 

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

func (*QueryParamsResponse) ProtoMessage 

func (*QueryParamsResponse) ProtoMessage()

func (*QueryParamsResponse) Reset 

func (m *QueryParamsResponse) Reset()

func (*QueryParamsResponse) Size 

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

func (*QueryParamsResponse) String 

func (m *QueryParamsResponse) String() string

func (*QueryParamsResponse) Unmarshal 

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

func (*QueryParamsResponse) XXX_DiscardUnknown 

func (m *QueryParamsResponse) XXX_DiscardUnknown()

func (*QueryParamsResponse) XXX_Marshal 

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

func (*QueryParamsResponse) XXX_Merge 

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

func (*QueryParamsResponse) XXX_Size 

func (m *QueryParamsResponse) XXX_Size() int

func (*QueryParamsResponse) XXX_Unmarshal 

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

type QueryRequest added in v7.5.0 

type QueryRequest struct {
	// path defines the path of the query request as defined by ADR-021.
	// https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-021-protobuf-query-encoding.md#custom-query-registration-and-routing
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// data defines the payload of the query request as defined by ADR-021.
	// https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-021-protobuf-query-encoding.md#custom-query-registration-and-routing
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
}

QueryRequest defines the parameters for a particular query request by an interchain account.

func (*QueryRequest) Descriptor added in v7.5.0 

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

func (*QueryRequest) GetData added in v7.5.0 

func (m *QueryRequest) GetData() []byte

func (*QueryRequest) GetPath added in v7.5.0 

func (m *QueryRequest) GetPath() string

func (*QueryRequest) Marshal added in v7.5.0 

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

func (*QueryRequest) MarshalTo added in v7.5.0 

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

func (*QueryRequest) MarshalToSizedBuffer added in v7.5.0 

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

func (*QueryRequest) ProtoMessage added in v7.5.0 

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) Reset added in v7.5.0 

func (m *QueryRequest) Reset()

func (*QueryRequest) Size added in v7.5.0 

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

func (*QueryRequest) String added in v7.5.0 

func (m *QueryRequest) String() string

func (*QueryRequest) Unmarshal added in v7.5.0 

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

func (*QueryRequest) XXX_DiscardUnknown added in v7.5.0 

func (m *QueryRequest) XXX_DiscardUnknown()

func (*QueryRequest) XXX_Marshal added in v7.5.0 

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

func (*QueryRequest) XXX_Merge added in v7.5.0 

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

func (*QueryRequest) XXX_Size added in v7.5.0 

func (m *QueryRequest) XXX_Size() int

func (*QueryRequest) XXX_Unmarshal added in v7.5.0 

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

type QueryServer 

type QueryServer interface {
	// Params queries all parameters of the ICA host submodule.
	Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, error)
}

QueryServer is the server API for Query service.

type UnimplementedMsgServer added in v7.5.0 

type UnimplementedMsgServer struct {
}

UnimplementedMsgServer can be embedded to have forward compatible implementations.

func (*UnimplementedMsgServer) ModuleQuerySafe added in v7.5.0 

func (*UnimplementedMsgServer) ModuleQuerySafe(ctx context.Context, req *MsgModuleQuerySafe) (*MsgModuleQuerySafeResponse, error)

type UnimplementedQueryServer 

type UnimplementedQueryServer struct {
}

UnimplementedQueryServer can be embedded to have forward compatible implementations.

func (*UnimplementedQueryServer) Params 

func (*UnimplementedQueryServer) Params(ctx context.Context, req *QueryParamsRequest) (*QueryParamsResponse, 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.