proposal

package
v0.45.13-ics Latest Latest
Warning

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

 Go to latest Published: Feb 9, 2023 License: Apache-2.0 Imports: 24 Imported by: 1,534

Documentation

Overview

Package proposal is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

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

	// RouterKey defines the routing key for a ParameterChangeProposal
	RouterKey = "params"
)
View Source 
const (
	// ProposalTypeChange defines the type for a ParameterChangeProposal
	ProposalTypeChange = "ParameterChange"
)

Variables

View Source 
var (
	ErrUnknownSubspace  = sdkerrors.Register(ModuleName, 2, "unknown subspace")
	ErrSettingParameter = sdkerrors.Register(ModuleName, 3, "failed to set parameter")
	ErrEmptyChanges     = sdkerrors.Register(ModuleName, 4, "submitted parameter changes are empty")
	ErrEmptySubspace    = sdkerrors.Register(ModuleName, 5, "parameter subspace is empty")
	ErrEmptyKey         = sdkerrors.Register(ModuleName, 6, "parameter key is empty")
	ErrEmptyValue       = sdkerrors.Register(ModuleName, 7, "parameter value is empty")
)

x/params module sentinel errors

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

Functions

func RegisterInterfaces added in v0.40.0 

func RegisterInterfaces(registry types.InterfaceRegistry)

func RegisterLegacyAminoCodec added in v0.40.0 

func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

RegisterLegacyAminoCodec registers all necessary param module types with a given LegacyAmino codec.

func RegisterQueryHandler added in v0.40.0 

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 added in v0.40.0 

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 added in v0.40.0 

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 added in v0.40.0 

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 (such as grpc.SendHeader, etc) to stop working. Consider using RegisterQueryHandlerFromEndpoint instead.

func RegisterQueryServer added in v0.40.0 

func RegisterQueryServer(s grpc1.Server, srv QueryServer)

func ValidateChanges 

func ValidateChanges(changes []ParamChange) error

ValidateChanges performs basic validation checks over a set of ParamChange. It returns an error if any ParamChange is invalid.

Types

type ParamChange 

type ParamChange struct {
	Subspace string `protobuf:"bytes,1,opt,name=subspace,proto3" json:"subspace,omitempty"`
	Key      string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	Value    string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
}

ParamChange defines an individual parameter change, for use in ParameterChangeProposal.

func NewParamChange 

func NewParamChange(subspace, key, value string) ParamChange

func (*ParamChange) Descriptor 

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

func (*ParamChange) Equal 

func (this *ParamChange) Equal(that interface{}) bool

func (*ParamChange) GetKey 

func (m *ParamChange) GetKey() string

func (*ParamChange) GetSubspace 

func (m *ParamChange) GetSubspace() string

func (*ParamChange) GetValue 

func (m *ParamChange) GetValue() string

func (*ParamChange) Marshal 

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

func (*ParamChange) MarshalTo 

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

func (*ParamChange) MarshalToSizedBuffer 

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

func (*ParamChange) ProtoMessage 

func (*ParamChange) ProtoMessage()

func (*ParamChange) Reset 

func (m *ParamChange) Reset()

func (*ParamChange) Size 

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

func (ParamChange) String 

func (pc ParamChange) String() string

String implements the Stringer interface.

func (*ParamChange) Unmarshal 

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

func (*ParamChange) XXX_DiscardUnknown 

func (m *ParamChange) XXX_DiscardUnknown()

func (*ParamChange) XXX_Marshal 

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

func (*ParamChange) XXX_Merge 

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

func (*ParamChange) XXX_Size 

func (m *ParamChange) XXX_Size() int

func (*ParamChange) XXX_Unmarshal 

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

type ParameterChangeProposal 

type ParameterChangeProposal struct {
	Title       string        `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	Description string        `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	Changes     []ParamChange `protobuf:"bytes,3,rep,name=changes,proto3" json:"changes"`
}

ParameterChangeProposal defines a proposal to change one or more parameters.

func NewParameterChangeProposal 

func NewParameterChangeProposal(title, description string, changes []ParamChange) *ParameterChangeProposal

func (*ParameterChangeProposal) Descriptor 

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

func (*ParameterChangeProposal) Equal 

func (this *ParameterChangeProposal) Equal(that interface{}) bool

func (*ParameterChangeProposal) GetDescription 

func (pcp *ParameterChangeProposal) GetDescription() string

GetDescription returns the description of a parameter change proposal.

func (*ParameterChangeProposal) GetTitle 

func (pcp *ParameterChangeProposal) GetTitle() string

GetTitle returns the title of a parameter change proposal.

func (*ParameterChangeProposal) Marshal 

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

func (*ParameterChangeProposal) MarshalTo 

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

func (*ParameterChangeProposal) MarshalToSizedBuffer 

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

func (*ParameterChangeProposal) ProposalRoute 

func (pcp *ParameterChangeProposal) ProposalRoute() string

ProposalRoute returns the routing key of a parameter change proposal.

func (*ParameterChangeProposal) ProposalType 

func (pcp *ParameterChangeProposal) ProposalType() string

ProposalType returns the type of a parameter change proposal.

func (*ParameterChangeProposal) ProtoMessage 

func (*ParameterChangeProposal) ProtoMessage()

func (*ParameterChangeProposal) Reset 

func (m *ParameterChangeProposal) Reset()

func (*ParameterChangeProposal) Size 

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

func (ParameterChangeProposal) String 

func (pcp ParameterChangeProposal) String() string

String implements the Stringer interface.

func (*ParameterChangeProposal) Unmarshal 

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

func (*ParameterChangeProposal) ValidateBasic 

func (pcp *ParameterChangeProposal) ValidateBasic() error

ValidateBasic validates the parameter change proposal

func (*ParameterChangeProposal) XXX_DiscardUnknown 

func (m *ParameterChangeProposal) XXX_DiscardUnknown()

func (*ParameterChangeProposal) XXX_Marshal 

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

func (*ParameterChangeProposal) XXX_Merge 

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

func (*ParameterChangeProposal) XXX_Size 

func (m *ParameterChangeProposal) XXX_Size() int

func (*ParameterChangeProposal) XXX_Unmarshal 

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

type QueryClient added in v0.40.0 

type QueryClient interface {
	// Params queries a specific parameter of a module, given its subspace and
	// key.
	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 added in v0.40.0 

func NewQueryClient(cc grpc1.ClientConn) QueryClient

type QueryParamsRequest added in v0.40.0 

type QueryParamsRequest struct {
	// subspace defines the module to query the parameter for.
	Subspace string `protobuf:"bytes,1,opt,name=subspace,proto3" json:"subspace,omitempty"`
	// key defines the key of the parameter in the subspace.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
}

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

func (*QueryParamsRequest) Descriptor added in v0.40.0 

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

func (*QueryParamsRequest) GetKey added in v0.40.0 

func (m *QueryParamsRequest) GetKey() string

func (*QueryParamsRequest) GetSubspace added in v0.40.0 

func (m *QueryParamsRequest) GetSubspace() string

func (*QueryParamsRequest) Marshal added in v0.40.0 

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

func (*QueryParamsRequest) MarshalTo added in v0.40.0 

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

func (*QueryParamsRequest) MarshalToSizedBuffer added in v0.40.0 

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

func (*QueryParamsRequest) ProtoMessage added in v0.40.0 

func (*QueryParamsRequest) ProtoMessage()

func (*QueryParamsRequest) Reset added in v0.40.0 

func (m *QueryParamsRequest) Reset()

func (*QueryParamsRequest) Size added in v0.40.0 

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

func (*QueryParamsRequest) String added in v0.40.0 

func (m *QueryParamsRequest) String() string

func (*QueryParamsRequest) Unmarshal added in v0.40.0 

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

func (*QueryParamsRequest) XXX_DiscardUnknown added in v0.40.0 

func (m *QueryParamsRequest) XXX_DiscardUnknown()

func (*QueryParamsRequest) XXX_Marshal added in v0.40.0 

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

func (*QueryParamsRequest) XXX_Merge added in v0.40.0 

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

func (*QueryParamsRequest) XXX_Size added in v0.40.0 

func (m *QueryParamsRequest) XXX_Size() int

func (*QueryParamsRequest) XXX_Unmarshal added in v0.40.0 

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

type QueryParamsResponse added in v0.40.0 

type QueryParamsResponse struct {
	// param defines the queried parameter.
	Param ParamChange `protobuf:"bytes,1,opt,name=param,proto3" json:"param"`
}

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

func (*QueryParamsResponse) Descriptor added in v0.40.0 

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

func (*QueryParamsResponse) GetParam added in v0.40.0 

func (m *QueryParamsResponse) GetParam() ParamChange

func (*QueryParamsResponse) Marshal added in v0.40.0 

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

func (*QueryParamsResponse) MarshalTo added in v0.40.0 

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

func (*QueryParamsResponse) MarshalToSizedBuffer added in v0.40.0 

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

func (*QueryParamsResponse) ProtoMessage added in v0.40.0 

func (*QueryParamsResponse) ProtoMessage()

func (*QueryParamsResponse) Reset added in v0.40.0 

func (m *QueryParamsResponse) Reset()

func (*QueryParamsResponse) Size added in v0.40.0 

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

func (*QueryParamsResponse) String added in v0.40.0 

func (m *QueryParamsResponse) String() string

func (*QueryParamsResponse) Unmarshal added in v0.40.0 

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

func (*QueryParamsResponse) XXX_DiscardUnknown added in v0.40.0 

func (m *QueryParamsResponse) XXX_DiscardUnknown()

func (*QueryParamsResponse) XXX_Marshal added in v0.40.0 

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

func (*QueryParamsResponse) XXX_Merge added in v0.40.0 

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

func (*QueryParamsResponse) XXX_Size added in v0.40.0 

func (m *QueryParamsResponse) XXX_Size() int

func (*QueryParamsResponse) XXX_Unmarshal added in v0.40.0 

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

type QueryServer added in v0.40.0 

type QueryServer interface {
	// Params queries a specific parameter of a module, given its subspace and
	// key.
	Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, error)
}

QueryServer is the server API for Query service.

type UnimplementedQueryServer added in v0.40.0 

type UnimplementedQueryServer struct {
}

UnimplementedQueryServer can be embedded to have forward compatible implementations.

func (*UnimplementedQueryServer) Params added in v0.40.0 

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.