voting

package
v0.10.2 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2025 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

package events is used to track events that need to be included in a Kwil block. It contains an event store that is outside of consensus. The event store's primary purpose is to store events that are heard from other chains, and delete them once the node can verify that their event vote has been included in a block.

Index

Constants

View Source 
const (

	// "migration" is the event type used for
	StartMigrationEventType = "migration"

	// "changeset_migration" is the event type used for replication of changesets from old chain to new chain during migration.
	ChangesetMigrationEventType = "changeset_migration"
)

registered resolution types

View Source 
const (
	ValidatorJoinEventType   = "validator_join"
	ValidatorRemoveEventType = "validator_remove"
)
View Source 
const (
	ValidatorVoteBodyBytePrice = 1000      // Per byte cost
	ValidatorVoteIDPrice       = 1000 * 16 // 16 bytes for the UUID
)

Variables

View Source 
var (
	ErrAlreadyProcessed         = errors.New("resolution already processed")
	ErrResolutionAlreadyHasBody = errors.New("resolution already has a body")
)

Functions

func ApproveResolution 

func ApproveResolution(ctx context.Context, db sql.TxMaker, resolutionID *types.UUID, approverPubKey []byte, approverKeyType crypto.KeyType) error

ApproveResolution approves a resolution from a voter. If the resolution does not yet exist, it will be errored, Validators should only vote on existing resolutions. If the voter does not exist, an error will be returned. If the voter has already approved the resolution, no error will be returned. This should not be used if the resolution has already been processed (see FilterNotProcessed)

func CreateResolution 

func CreateResolution(ctx context.Context, db sql.TxMaker, event *types.VotableEvent, expiration int64, voteBodyProposer []byte, proposerKeyType crypto.KeyType) error

CreateResolution creates a resolution for a votable event. The expiration is the UNIX epoch timestamp in secs. Resolution creation will fail if the resolution either already exists or has been processed.

func DecodePubKey 

func DecodePubKey(b []byte) ([]byte, crypto.KeyType, error)

DecodePubKey decodes a byte slice into a public key and key type.

func DeleteEvent 

func DeleteEvent(ctx context.Context, db sql.Executor, id *types.UUID) error

DeleteEvent deletes an event from the event store. It is idempotent. If the event does not exist, it will not return an error.

func DeleteEvents 

func DeleteEvents(ctx context.Context, db sql.DB, ids ...*types.UUID) error

DeleteEvents deletes a list of events from the event store. It is idempotent. If the event does not exist, it will not return an error.

func DeleteResolution 

func DeleteResolution(ctx context.Context, db sql.TxMaker, id *types.UUID) error

DeleteResolution deletes a resolution from the database by ID if it exists.

func DeleteResolutions 

func DeleteResolutions(ctx context.Context, db sql.Executor, ids ...*types.UUID) error

DeleteResolutions deletes a slice of resolution IDs from the database. It will mark the resolutions as processed in the processed table.

func DeleteResolutionsByType 

func DeleteResolutionsByType(ctx context.Context, db sql.Executor, resTypes []string) error

func FilterNotProcessed 

func FilterNotProcessed(ctx context.Context, db sql.Executor, ids []*types.UUID) ([]*types.UUID, error)

FilterNotProcessed takes a set of resolutions and returns the ones that have not been processed. If a resolution does not exist, it WILL be included in the result.

func GetEvents 

func GetEvents(ctx context.Context, db sql.Executor) ([]*types.VotableEvent, error)

GetEvents gets all events in the event store to which resolutions have not yet been created.

func GetExpired 

func GetExpired(ctx context.Context, db sql.Executor, currentTime int64) ([]*resolutions.Resolution, error)

GetExpired returns all resolutions with an expiration time less than the currentTime

func GetResolutionIDsByTypeAndProposer 

func GetResolutionIDsByTypeAndProposer(ctx context.Context, db sql.Executor, resType string, proposer []byte, proposerKeyType crypto.KeyType) ([]*types.UUID, error)

GetResolutionIDsByTypeAndProposer gets all resolution ids of a specific type and the body proposer.

func GetResolutionInfo 

func GetResolutionInfo(ctx context.Context, db sql.Executor, id *types.UUID) (*resolutions.Resolution, error)

GetResolutionInfo gets a resolution, identified by the ID.

func GetResolutionsByThresholdAndType 

func GetResolutionsByThresholdAndType(ctx context.Context, db sql.TxMaker, threshold *big.Rat, resType string, totalPower int64) ([]*resolutions.Resolution, error)

GetResolutionsByThresholdAndType gets all resolutions that have reached the threshold of votes and are of a specific type.

func GetResolutionsByType 

func GetResolutionsByType(ctx context.Context, db sql.Executor, resType string) ([]*resolutions.Resolution, error)

GetResolutionsByType gets all resolutions of a specific type.

func IsProcessed 

func IsProcessed(ctx context.Context, tx sql.Executor, resolutionID *types.UUID) (bool, error)

IsProcessed checks if a vote has been marked as processed.

func MarkProcessed 

func MarkProcessed(ctx context.Context, db sql.Executor, ids ...*types.UUID) error

MarkProcessed marks a set of resolutions as processed.

func NewResolutionStore 

func NewResolutionStore(ctx context.Context, eventWriterDB DB) (*EventStore, *VoteStore, error)

NewEventStore will initialize the event and vote store with the provided DB connection, which is retained by the EventStore. This must not be the writer connection used to update state by the consensus application. Updates that are to be performed in the same transaction that updates state are done in functions that are passed the consensus DB connection.

func RequiredPower 

func RequiredPower(ctx context.Context, db sql.Executor, threshold *big.Rat, totalPower int64) int64

RequiredPower gets the required power to meet the threshold requirements.

func ResolutionExists 

func ResolutionExists(ctx context.Context, db sql.Executor, id *types.UUID) (bool, error)

ResolutionExists checks if a resolution of the given ID exists.

Types

type DB 

type DB interface {
	sql.ReadTxMaker // i.e. outer! cannot be the consensus connection
	sql.DB          // make txns, and run bare execute
}

DB is a database connection.

type EventStore 

type EventStore struct {
	// contains filtered or unexported fields
}

EventStore stores events from external sources. Kwil uses the event store to track received events, and ensure that they are broadcasted to the network. It follows an at-least-once semantic, and so each event body should be unique. Events can be added idempotently; calling StoreEvent for an event that has already been stored or processed will incur some computational overhead, but will not cause any issues. Voters would then create resolutions for these events, and vote on them.

func (*EventStore) GetUnbroadcastedEvents 

func (e *EventStore) GetUnbroadcastedEvents(ctx context.Context) ([]*types.UUID, error)

GetUnbroadcastedEvents filters out the events observed by the validator that are not previously broadcasted.

func (*EventStore) HasEvents 

func (e *EventStore) HasEvents() bool

func (*EventStore) KV 

func (e *EventStore) KV(prefix []byte) *KV

KV returns a kv store that is scoped to the given prefix. It allows the user to define their own semantics for tracking committed data. For example, it can be used to track the latest block number of some other chain. This allows users to implement complex logic for efficient restart, to avoid re-processing events. Key uniqueness is scoped to the event type.

func (*EventStore) MarkBroadcasted 

func (e *EventStore) MarkBroadcasted(ctx context.Context, ids []*types.UUID) error

MarkBroadcasted marks the event as broadcasted.

func (*EventStore) MarkRebroadcast 

func (e *EventStore) MarkRebroadcast(ctx context.Context, ids []*types.UUID) error

MarkRebroadcast marks the event to be rebroadcasted. Usually in scenarios where the transaction was rejected by mempool due to invalid nonces.

func (*EventStore) Store 

func (e *EventStore) Store(ctx context.Context, data []byte, eventType string) error

Store stores an event in the event store. It uses the local connection to the event store, instead of the consensus connection. It only stores unprocessed events. If an event is already processed.

func (*EventStore) UpdateStats 

func (e *EventStore) UpdateStats(deletedEvts int64)

type KV 

type KV struct {
	// contains filtered or unexported fields
}

KV is a KVStore that is scoped to an event type.

func (*KV) Delete 

func (s *KV) Delete(ctx context.Context, key []byte) error

func (*KV) Get 

func (s *KV) Get(ctx context.Context, key []byte) ([]byte, error)

func (*KV) Set 

func (s *KV) Set(ctx context.Context, key, value []byte) error

type UpdatePowerRequest 

type UpdatePowerRequest struct {
	PubKey     []byte
	PubKeyType crypto.KeyType
	Power      int64
}

UpdatePowerRequest is a request to update a validator's power.

func (*UpdatePowerRequest) MarshalBinary 

func (j *UpdatePowerRequest) MarshalBinary() ([]byte, error)

MarshalBinary returns the binary representation of the join request It is deterministic

func (*UpdatePowerRequest) UnmarshalBinary 

func (j *UpdatePowerRequest) UnmarshalBinary(data []byte) error

UnmarshalBinary unmarshals the join request from its binary representation

type VoteStore 

type VoteStore struct {
	// contains filtered or unexported fields
}

VoteStore is a store that manages state required for processing resolutions. This currently tracks the validator set and any updates to the validator set.

func InitializeVoteStore 

func InitializeVoteStore(ctx context.Context, db sql.TxMaker) (*VoteStore, error)

InitializeVoteStore initializes the vote store with the required tables. It will also create any resolution types that have been registered. NOTE: the provided DB is used only for initialization. The store is stateless in the application, and this DB connection is not assumed as a dependency.

func (*VoteStore) Commit 

func (v *VoteStore) Commit() error

Commit applies the updates to the validator set cache.

func (*VoteStore) GetValidatorPower 

func (v *VoteStore) GetValidatorPower(ctx context.Context, pubKey []byte, keyType crypto.KeyType) (power int64, err error)

GetValidatorPower gets the power of a voter. If the voter does not exist, it will return 0.

func (*VoteStore) GetValidators 

func (v *VoteStore) GetValidators() []*types.Validator

func (*VoteStore) LoadValidatorSet 

func (v *VoteStore) LoadValidatorSet(ctx context.Context, db sql.Executor) error

LoadValidatorSet loads the validator set from the database. This should be used only in the initialization phases such as in the VoteStore constructor or right after the statesync.

func (*VoteStore) Rollback 

func (v *VoteStore) Rollback()

func (*VoteStore) SetValidatorPower 

func (v *VoteStore) SetValidatorPower(ctx context.Context, db sql.Executor, pubKey []byte, pubKeyType crypto.KeyType, power int64) error

SetValidatorPower sets the power of a voter. It will create the voter if it does not exist. It will return an error if a negative power is given. If set to 0, the voter will be deleted.

func (*VoteStore) ValidatorUpdates 

func (v *VoteStore) ValidatorUpdates() map[string]*types.Validator

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.