types

package
v3.2.1-near-experimental Latest Latest
Warning

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

 Go to latest Published: Oct 17, 2024 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Overview

Package types is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	// ModuleName defines the module name
	ModuleName = "protocol"

	// StoreKey defines the primary module store key
	StoreKey = ModuleName

	// RouterKey is the message route for slashing
	RouterKey = ModuleName

	// QuerierRoute defines the module's query routing key
	QuerierRoute = ModuleName

	// MemStoreKey defines the in-memory store key
	MemStoreKey = "mem_protocol"
)
View Source 
const (
	TARGET_VERSION = "3.2.1"
	MIN_VERSION    = "3.1.0"
)
View Source 
const (
	MAX_MINOR    = 10000
	MAX_REVISION = 10000
)
View Source 
const DefaultIndex uint64 = 1

DefaultIndex is the default capability global index

View Source 
const TypeMsgSetVersion = "set_version"

Variables

View Source 
var (
	Amino     = codec.NewLegacyAmino()
	ModuleCdc = codec.NewAminoCodec(Amino)
)
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 (
	KeyVersion     = []byte("Version")
	DefaultVersion = Version{
		ProviderTarget: TARGET_VERSION,
		ProviderMin:    MIN_VERSION,
		ConsumerTarget: TARGET_VERSION,
		ConsumerMin:    MIN_VERSION,
	}
)
View Source 
var (
	ErrInvalidLengthParams        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowParams          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupParams = 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 (
	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 (
	ErrSample = sdkerrors.Register(ModuleName, 1100, "sample error")
)

x/protocol module sentinel errors

Functions

func KeyPrefix 

func KeyPrefix(p string) []byte

func ParamKeyTable 

func ParamKeyTable() paramtypes.KeyTable

ParamKeyTable the param key table for launch module

func RegisterCodec 

func RegisterCodec(cdc *codec.LegacyAmino)

func RegisterInterfaces 

func RegisterInterfaces(registry cdctypes.InterfaceRegistry)

func RegisterMsgServer 

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 AccountKeeper 

type AccountKeeper interface {
	GetAccount(ctx sdk.Context, addr sdk.AccAddress) types.AccountI
}

AccountKeeper defines the expected account keeper used for simulations (noalias)

type BankKeeper 

type BankKeeper interface {
	SpendableCoins(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
}

BankKeeper defines the expected interface needed to retrieve account balances.

type GenesisState 

type GenesisState struct {
	Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params"`
}

GenesisState defines the protocol module's genesis state.

func DefaultGenesis 

func DefaultGenesis() *GenesisState

DefaultGenesis returns the default Capability genesis state

func (*GenesisState) Descriptor 

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

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) 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 MsgClient 

type MsgClient interface {
	SetVersion(ctx context.Context, in *MsgSetVersion, opts ...grpc.CallOption) (*MsgSetVersionResponse, 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 

func NewMsgClient(cc grpc1.ClientConn) MsgClient

type MsgServer 

type MsgServer interface {
	SetVersion(context.Context, *MsgSetVersion) (*MsgSetVersionResponse, error)
}

MsgServer is the server API for Msg service.

type MsgSetVersion 

type MsgSetVersion struct {
	Authority string   `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"`
	Version   *Version `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
}

this line is used by starport scaffolding # proto/tx/message

func NewMsgSetVersion 

func NewMsgSetVersion(authority string, version Version) *MsgSetVersion

func (*MsgSetVersion) Descriptor 

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

func (*MsgSetVersion) GetAuthority 

func (m *MsgSetVersion) GetAuthority() string

func (*MsgSetVersion) GetSignBytes 

func (msg *MsgSetVersion) GetSignBytes() []byte

func (*MsgSetVersion) GetSigners 

func (msg *MsgSetVersion) GetSigners() []sdk.AccAddress

func (*MsgSetVersion) GetVersion 

func (m *MsgSetVersion) GetVersion() *Version

func (*MsgSetVersion) Marshal 

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

func (*MsgSetVersion) MarshalTo 

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

func (*MsgSetVersion) MarshalToSizedBuffer 

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

func (*MsgSetVersion) ProtoMessage 

func (*MsgSetVersion) ProtoMessage()

func (*MsgSetVersion) Reset 

func (m *MsgSetVersion) Reset()

func (*MsgSetVersion) Route 

func (msg *MsgSetVersion) Route() string

func (*MsgSetVersion) Size 

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

func (*MsgSetVersion) String 

func (m *MsgSetVersion) String() string

func (*MsgSetVersion) Type 

func (msg *MsgSetVersion) Type() string

func (*MsgSetVersion) Unmarshal 

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

func (*MsgSetVersion) ValidateBasic 

func (msg *MsgSetVersion) ValidateBasic() error

func (*MsgSetVersion) XXX_DiscardUnknown 

func (m *MsgSetVersion) XXX_DiscardUnknown()

func (*MsgSetVersion) XXX_Marshal 

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

func (*MsgSetVersion) XXX_Merge 

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

func (*MsgSetVersion) XXX_Size 

func (m *MsgSetVersion) XXX_Size() int

func (*MsgSetVersion) XXX_Unmarshal 

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

type MsgSetVersionResponse 

type MsgSetVersionResponse struct {
}

func (*MsgSetVersionResponse) Descriptor 

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

func (*MsgSetVersionResponse) Marshal 

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

func (*MsgSetVersionResponse) MarshalTo 

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

func (*MsgSetVersionResponse) MarshalToSizedBuffer 

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

func (*MsgSetVersionResponse) ProtoMessage 

func (*MsgSetVersionResponse) ProtoMessage()

func (*MsgSetVersionResponse) Reset 

func (m *MsgSetVersionResponse) Reset()

func (*MsgSetVersionResponse) Size 

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

func (*MsgSetVersionResponse) String 

func (m *MsgSetVersionResponse) String() string

func (*MsgSetVersionResponse) Unmarshal 

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

func (*MsgSetVersionResponse) XXX_DiscardUnknown 

func (m *MsgSetVersionResponse) XXX_DiscardUnknown()

func (*MsgSetVersionResponse) XXX_Marshal 

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

func (*MsgSetVersionResponse) XXX_Merge 

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

func (*MsgSetVersionResponse) XXX_Size 

func (m *MsgSetVersionResponse) XXX_Size() int

func (*MsgSetVersionResponse) XXX_Unmarshal 

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

type Params 

type Params struct {
	Version Version `protobuf:"bytes,1,opt,name=version,proto3" json:"version"`
}

func DefaultParams 

func DefaultParams() Params

DefaultParams returns a default set of parameters

func NewParams 

func NewParams(
	version Version,
) Params

NewParams creates a new Params instance

func (*Params) Descriptor 

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

func (*Params) GetVersion 

func (m *Params) GetVersion() Version

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 get the 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 (p Params) String() string

String implements the Stringer interface.

func (*Params) Unmarshal 

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

func (Params) Validate 

func (p Params) Validate() error

Validate validates the set of params

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 {
	// Parameters queries the parameters of the module.
	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 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 holds all the parameters of this module.
	Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params"`
}

QueryParamsResponse is 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 QueryServer 

type QueryServer interface {
	// Parameters queries the parameters of the module.
	Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, error)
}

QueryServer is the server API for Query service.

type UnimplementedMsgServer 

type UnimplementedMsgServer struct {
}

UnimplementedMsgServer can be embedded to have forward compatible implementations.

func (*UnimplementedMsgServer) SetVersion 

func (*UnimplementedMsgServer) SetVersion(ctx context.Context, req *MsgSetVersion) (*MsgSetVersionResponse, 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)

type Version 

type Version struct {
	ProviderTarget string `` /* 126-byte string literal not displayed */
	ProviderMin    string `protobuf:"bytes,2,opt,name=provider_min,json=providerMin,proto3" json:"provider_min,omitempty" yaml:"provider_min"`
	ConsumerTarget string `` /* 126-byte string literal not displayed */
	ConsumerMin    string `protobuf:"bytes,4,opt,name=consumer_min,json=consumerMin,proto3" json:"consumer_min,omitempty" yaml:"consumer_min"`
}

Params defines the parameters for the module.

func (*Version) Descriptor 

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

func (*Version) GetConsumerMin 

func (m *Version) GetConsumerMin() string

func (*Version) GetConsumerTarget 

func (m *Version) GetConsumerTarget() string

func (*Version) GetProviderMin 

func (m *Version) GetProviderMin() string

func (*Version) GetProviderTarget 

func (m *Version) GetProviderTarget() string

func (*Version) Marshal 

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

func (*Version) MarshalTo 

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

func (*Version) MarshalToSizedBuffer 

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

func (*Version) ProtoMessage 

func (*Version) ProtoMessage()

func (*Version) Reset 

func (m *Version) Reset()

func (*Version) Size 

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

func (*Version) String 

func (m *Version) String() string

func (*Version) Unmarshal 

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

func (*Version) XXX_DiscardUnknown 

func (m *Version) XXX_DiscardUnknown()

func (*Version) XXX_Marshal 

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

func (*Version) XXX_Merge 

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

func (*Version) XXX_Size 

func (m *Version) XXX_Size() int

func (*Version) XXX_Unmarshal 

func (m *Version) XXX_Unmarshal(b []byte) 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.