types

package
v0.18.0 Latest Latest
Warning

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

Go to latest
Published: May 18, 2022 License: Apache-2.0 Imports: 34 Imported by: 0

Documentation

Overview

Package types is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	AttributeKeyPoll      = "poll"
	AttributeKeyVoter     = "voter"
	AttributeKeyPollState = "state"
)

Event attribute keys

View Source
const (
	// ModuleName is the name of the module
	ModuleName = "vote"

	// StoreKey to be used when creating the KVStore
	StoreKey = ModuleName

	// RouterKey to be used for routing msgs
	RouterKey = ModuleName

	// QuerierRoute to be used for legacy query routing
	QuerierRoute = ModuleName
)
View Source
const (
	AttributeValueVote = "vote"
)

Event attribute values

View Source
const (
	EventType = "vote"
)

Event types

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 (
	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 (
	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 (
	ErrInvalidLengthTypes        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTypes          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupTypes = fmt.Errorf("proto: unexpected end of group")
)
View Source
var (
	ErrVote = sdkerrors.Register(ModuleName, 2, "vote error")
)

module errors

View Source
var (
	KeyDefaultVotingThreshold = []byte("DefaultVotingThreshold")
)

Parameter store keys

View Source
var ModuleCdc = codec.NewAminoCodec(amino)

ModuleCdc defines the module codec

Functions

func KeyTable added in v0.9.0

func KeyTable() paramtypes.KeyTable

KeyTable retrieves a subspace table for the module

func NewPollMetaData

func NewPollMetaData(key exported.PollKey, threshold utils.Threshold, voters []exported.Voter) exported.PollMetadata

NewPollMetaData is the constructor for PollMetadata. It is not in the exported package to make it clear that only the vote module is supposed to use it.

func RegisterInterfaces

func RegisterInterfaces(registry cdctypes.InterfaceRegistry)

RegisterInterfaces registers types and interfaces with the given registry

func RegisterLegacyAminoCodec

func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

RegisterLegacyAminoCodec registers concrete types on codec

func RegisterMsgServiceHandler added in v0.17.0

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

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

func RegisterMsgServiceHandlerClient added in v0.17.0

func RegisterMsgServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MsgServiceClient) error

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

func RegisterMsgServiceHandlerFromEndpoint added in v0.17.0

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

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

func RegisterMsgServiceHandlerServer added in v0.17.0

func RegisterMsgServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MsgServiceServer) error

RegisterMsgServiceHandlerServer registers the http handlers for service MsgService to "mux". UnaryRPC :call MsgServiceServer 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 RegisterMsgServiceHandlerFromEndpoint instead.

func RegisterMsgServiceServer added in v0.17.0

func RegisterMsgServiceServer(s grpc1.Server, srv MsgServiceServer)

Types

type GenesisState

type GenesisState struct {
	Params        Params                  `protobuf:"bytes,1,opt,name=params,proto3" json:"params"`
	PollMetadatas []exported.PollMetadata `protobuf:"bytes,2,rep,name=poll_metadatas,json=pollMetadatas,proto3" json:"poll_metadatas"`
}

func DefaultGenesisState

func DefaultGenesisState() *GenesisState

DefaultGenesisState represents the default genesis state

func NewGenesisState added in v0.9.0

func NewGenesisState(params Params, pollMetadatas []exported.PollMetadata) *GenesisState

NewGenesisState is the constructor for GenesisState

func (*GenesisState) Descriptor

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

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 (m GenesisState) Validate() error

Validate validates the genesis state

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

type MsgServiceClient interface {
	Vote(ctx context.Context, in *VoteRequest, opts ...grpc.CallOption) (*VoteResponse, error)
}

MsgServiceClient is the client API for MsgService service.

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

func NewMsgServiceClient added in v0.17.0

func NewMsgServiceClient(cc grpc1.ClientConn) MsgServiceClient

type MsgServiceServer added in v0.17.0

type MsgServiceServer interface {
	Vote(context.Context, *VoteRequest) (*VoteResponse, error)
}

MsgServiceServer is the server API for MsgService service.

type Params added in v0.9.0

type Params struct {
	DefaultVotingThreshold utils.Threshold `protobuf:"bytes,1,opt,name=default_voting_threshold,json=defaultVotingThreshold,proto3" json:"default_voting_threshold"`
}

Params represent the genesis parameters for the module

func DefaultParams added in v0.9.0

func DefaultParams() Params

DefaultParams - the module's default parameters

func (*Params) Descriptor added in v0.9.0

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

func (*Params) Marshal added in v0.9.0

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

func (*Params) MarshalTo added in v0.9.0

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

func (*Params) MarshalToSizedBuffer added in v0.9.0

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

func (*Params) ParamSetPairs added in v0.9.0

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

ParamSetPairs implements the ParamSet interface and returns all the key/value pairs pairs of vote module's parameters.

func (*Params) ProtoMessage added in v0.9.0

func (*Params) ProtoMessage()

func (*Params) Reset added in v0.9.0

func (m *Params) Reset()

func (*Params) Size added in v0.9.0

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

func (*Params) String added in v0.9.0

func (m *Params) String() string

func (*Params) Unmarshal added in v0.9.0

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

func (Params) Validate added in v0.9.0

func (m Params) Validate() error

Validate performs a validation check on the parameters

func (*Params) XXX_DiscardUnknown added in v0.9.0

func (m *Params) XXX_DiscardUnknown()

func (*Params) XXX_Marshal added in v0.9.0

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

func (*Params) XXX_Merge added in v0.9.0

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

func (*Params) XXX_Size added in v0.9.0

func (m *Params) XXX_Size() int

func (*Params) XXX_Unmarshal added in v0.9.0

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

type Poll

type Poll struct {
	exported.PollMetadata
	Store
	// contains filtered or unexported fields
}

Poll represents a poll with write-in voting

func NewPoll

func NewPoll(meta exported.PollMetadata, store Store) *Poll

NewPoll creates a new poll

func (Poll) AllowOverride

func (p Poll) AllowOverride()

AllowOverride makes it possible to delete the poll, regardless of which state it is in

func (Poll) Delete

func (p Poll) Delete() error

Delete deletes the poll. Returns error if the poll is in a state that does not allow deletion

func (Poll) GetKey

func (p Poll) GetKey() exported.PollKey

GetKey returns the poll's key

func (Poll) GetResult

func (p Poll) GetResult() codec.ProtoMarshaler

GetResult returns the result of the poll. Returns nil if the poll is not completed.

func (Poll) GetRewardPoolName added in v0.18.0

func (p Poll) GetRewardPoolName() (string, bool)

GetRewardPoolName returns the name of the attached reward pool, if any

func (Poll) GetTotalVotingPower

func (p Poll) GetTotalVotingPower() sdk.Int

GetTotalVotingPower returns the total voting power of the poll

func (Poll) GetVoters

func (p Poll) GetVoters() []exported.Voter

GetVoters returns the poll's voters

func (Poll) HasVotedCorrectly added in v0.18.0

func (p Poll) HasVotedCorrectly(voter sdk.ValAddress) bool

HasVotedCorrectly returns true if the give voter has voted correctly for the poll, false otherwise

func (Poll) Initialize

func (p Poll) Initialize(blockHeight int64) error

Initialize initializes the poll

func (Poll) Is

func (p Poll) Is(state exported.PollState) bool

Is checks if the poll is in the given state

func (Poll) SetExpired added in v0.18.0

func (p Poll) SetExpired()

SetExpired sets the poll to be expired

func (*Poll) Vote

func (p *Poll) Vote(voter sdk.ValAddress, blockHeight int64, data codec.ProtoMarshaler) (codec.ProtoMarshaler, bool, error)

Vote records the given vote

func (*Poll) WithLogger

func (p *Poll) WithLogger(logger log.Logger) *Poll

WithLogger sets a logger for the poll

type Rewarder

type Rewarder interface {
	GetPool(ctx sdk.Context, name string) reward.RewardPool
}

Rewarder provides reward functionality

type Snapshotter

type Snapshotter interface {
	GetSnapshot(sdk.Context, int64) (snapshot.Snapshot, bool)
	GetOperator(ctx sdk.Context, proxy sdk.AccAddress) sdk.ValAddress
}

Snapshotter provides snapshot functionality

type StakingKeeper

type StakingKeeper interface {
	Validator(ctx sdk.Context, addr sdk.ValAddress) stakingtypes.ValidatorI
	PowerReduction(sdk.Context) sdk.Int
	GetLastTotalPower(sdk.Context) sdk.Int
}

StakingKeeper provides functionality of the staking module

type Store

type Store interface {
	SetVote(voter sdk.ValAddress, data codec.ProtoMarshaler, votingPower int64, isLate bool)
	GetVote(hash string) (TalliedVote, bool)
	HasVoted(voter sdk.ValAddress) bool
	HasVotedLate(voter sdk.ValAddress) bool
	GetVotes() []TalliedVote
	SetMetadata(metadata exported.PollMetadata)
	EnqueuePoll(metadata exported.PollMetadata)
	GetPoll(key exported.PollKey) exported.Poll
	DeletePoll()
}

Store enables a poll to communicate with the keeper

type TalliedVote

type TalliedVote struct {
	Tally  github_com_cosmos_cosmos_sdk_types.Int `protobuf:"bytes,1,opt,name=tally,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Int" json:"tally"`
	Voters Voters                                 `protobuf:"bytes,2,rep,name=voters,proto3,castrepeated=Voters" json:"voters,omitempty"`
	Data   *types.Any                             `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
}

TalliedVote represents a vote for a poll with the accumulated stake of all validators voting for the same data

func NewTalliedVote

func NewTalliedVote(voter sdk.ValAddress, votingPower int64, data codec.ProtoMarshaler) TalliedVote

NewTalliedVote is the constructor for TalliedVote

func (*TalliedVote) Descriptor

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

func (*TalliedVote) Marshal

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

func (*TalliedVote) MarshalTo

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

func (*TalliedVote) MarshalToSizedBuffer

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

func (*TalliedVote) ProtoMessage

func (*TalliedVote) ProtoMessage()

func (*TalliedVote) Reset

func (m *TalliedVote) Reset()

func (*TalliedVote) Size

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

func (*TalliedVote) String

func (m *TalliedVote) String() string

func (*TalliedVote) Unmarshal

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

func (TalliedVote) UnpackInterfaces

func (m TalliedVote) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error

UnpackInterfaces implements UnpackInterfacesMessage

func (*TalliedVote) XXX_DiscardUnknown

func (m *TalliedVote) XXX_DiscardUnknown()

func (*TalliedVote) XXX_Marshal

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

func (*TalliedVote) XXX_Merge

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

func (*TalliedVote) XXX_Size

func (m *TalliedVote) XXX_Size() int

func (*TalliedVote) XXX_Unmarshal

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

type UnimplementedMsgServiceServer added in v0.17.0

type UnimplementedMsgServiceServer struct {
}

UnimplementedMsgServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedMsgServiceServer) Vote added in v0.17.0

type VoteRecord added in v0.18.0

type VoteRecord struct {
	Voter  github_com_cosmos_cosmos_sdk_types.ValAddress `protobuf:"bytes,1,opt,name=voter,proto3,casttype=github.com/cosmos/cosmos-sdk/types.ValAddress" json:"voter,omitempty"`
	IsLate bool                                          `protobuf:"varint,2,opt,name=is_late,json=isLate,proto3" json:"is_late,omitempty"`
}

func (*VoteRecord) Descriptor added in v0.18.0

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

func (*VoteRecord) Marshal added in v0.18.0

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

func (*VoteRecord) MarshalTo added in v0.18.0

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

func (*VoteRecord) MarshalToSizedBuffer added in v0.18.0

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

func (*VoteRecord) ProtoMessage added in v0.18.0

func (*VoteRecord) ProtoMessage()

func (*VoteRecord) Reset added in v0.18.0

func (m *VoteRecord) Reset()

func (*VoteRecord) Size added in v0.18.0

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

func (*VoteRecord) String added in v0.18.0

func (m *VoteRecord) String() string

func (*VoteRecord) Unmarshal added in v0.18.0

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

func (*VoteRecord) XXX_DiscardUnknown added in v0.18.0

func (m *VoteRecord) XXX_DiscardUnknown()

func (*VoteRecord) XXX_Marshal added in v0.18.0

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

func (*VoteRecord) XXX_Merge added in v0.18.0

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

func (*VoteRecord) XXX_Size added in v0.18.0

func (m *VoteRecord) XXX_Size() int

func (*VoteRecord) XXX_Unmarshal added in v0.18.0

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

type VoteRequest added in v0.17.0

type VoteRequest struct {
	Sender  github_com_cosmos_cosmos_sdk_types.AccAddress `protobuf:"bytes,1,opt,name=sender,proto3,casttype=github.com/cosmos/cosmos-sdk/types.AccAddress" json:"sender,omitempty"`
	PollKey exported.PollKey                              `protobuf:"bytes,2,opt,name=poll_key,json=pollKey,proto3" json:"poll_key"`
	Vote    exported.Vote                                 `protobuf:"bytes,3,opt,name=vote,proto3" json:"vote"`
}

func NewVoteRequest added in v0.17.0

func NewVoteRequest(sender sdk.AccAddress, pollKey vote.PollKey, vote vote.Vote) *VoteRequest

NewVoteRequest creates a message of type VoteMsgRequest

func (*VoteRequest) Descriptor added in v0.17.0

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

func (VoteRequest) GetSignBytes added in v0.17.0

func (m VoteRequest) GetSignBytes() []byte

GetSignBytes implements sdk.Msg

func (VoteRequest) GetSigners added in v0.17.0

func (m VoteRequest) GetSigners() []sdk.AccAddress

GetSigners implements sdk.Msg

func (*VoteRequest) Marshal added in v0.17.0

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

func (*VoteRequest) MarshalTo added in v0.17.0

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

func (*VoteRequest) MarshalToSizedBuffer added in v0.17.0

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

func (*VoteRequest) ProtoMessage added in v0.17.0

func (*VoteRequest) ProtoMessage()

func (*VoteRequest) Reset added in v0.17.0

func (m *VoteRequest) Reset()

func (VoteRequest) Route added in v0.17.0

func (m VoteRequest) Route() string

Route implements sdk.Msg

func (*VoteRequest) Size added in v0.17.0

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

func (*VoteRequest) String added in v0.17.0

func (m *VoteRequest) String() string

func (VoteRequest) Type added in v0.17.0

func (m VoteRequest) Type() string

Type implements sdk.Msg

func (*VoteRequest) Unmarshal added in v0.17.0

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

func (VoteRequest) ValidateBasic added in v0.17.0

func (m VoteRequest) ValidateBasic() error

ValidateBasic implements sdk.Msg

func (*VoteRequest) XXX_DiscardUnknown added in v0.17.0

func (m *VoteRequest) XXX_DiscardUnknown()

func (*VoteRequest) XXX_Marshal added in v0.17.0

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

func (*VoteRequest) XXX_Merge added in v0.17.0

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

func (*VoteRequest) XXX_Size added in v0.17.0

func (m *VoteRequest) XXX_Size() int

func (*VoteRequest) XXX_Unmarshal added in v0.17.0

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

type VoteResponse added in v0.17.0

type VoteResponse struct {
	Log string `protobuf:"bytes,1,opt,name=log,proto3" json:"log,omitempty"`
}

func (*VoteResponse) Descriptor added in v0.17.0

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

func (*VoteResponse) Marshal added in v0.17.0

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

func (*VoteResponse) MarshalTo added in v0.17.0

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

func (*VoteResponse) MarshalToSizedBuffer added in v0.17.0

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

func (*VoteResponse) ProtoMessage added in v0.17.0

func (*VoteResponse) ProtoMessage()

func (*VoteResponse) Reset added in v0.17.0

func (m *VoteResponse) Reset()

func (*VoteResponse) Size added in v0.17.0

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

func (*VoteResponse) String added in v0.17.0

func (m *VoteResponse) String() string

func (*VoteResponse) Unmarshal added in v0.17.0

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

func (*VoteResponse) XXX_DiscardUnknown added in v0.17.0

func (m *VoteResponse) XXX_DiscardUnknown()

func (*VoteResponse) XXX_Marshal added in v0.17.0

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

func (*VoteResponse) XXX_Merge added in v0.17.0

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

func (*VoteResponse) XXX_Size added in v0.17.0

func (m *VoteResponse) XXX_Size() int

func (*VoteResponse) XXX_Unmarshal added in v0.17.0

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

type VoteRouter added in v0.17.0

type VoteRouter interface {
	AddHandler(module string, handler exported.VoteHandler) VoteRouter
	HasHandler(module string) bool
	GetHandler(module string) exported.VoteHandler
	Seal()
}

VoteRouter implements a Vote router based on module name.

func NewRouter added in v0.17.0

func NewRouter() VoteRouter

NewRouter creates a new Router interface instance

type Voter added in v0.18.0

type Voter interface {
	Logger(ctx sdk.Context) log.Logger
	GetVoteRouter() VoteRouter
	GetPoll(ctx sdk.Context, key exported.PollKey) exported.Poll
	GetPollQueue(ctx sdk.Context) utils.KVQueue
}

Voter provides vote keeper functionality

type Voters

type Voters []sdk.ValAddress

Voters is a type alias necessary to unmarshal TalliedVote

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL