Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

participation

package

Go to main page

Versions in this module

v1

v1.2.1

Apr 29, 2022

v1.2.0

Apr 13, 2022

Changes in this version

+ const ParticipationStoreKeyPrefixStakingCurrentRewards

+ const ParticipationStoreKeyPrefixTrackedOutputByAddress

+ var ErrInvalidCurrentRewardsAmount = errors.New("current rewards amount invalid")

type ParticipationManager

+ func (pm *ParticipationManager) ApplyNewLedgerUpdate(index milestone.Index, created utxo.Outputs, consumed utxo.Spents) error

+ func (pm *ParticipationManager) ForEachAddressStakingParticipation(eventID EventID, msIndex milestone.Index, consumer StakingRewardsConsumer) error

+ func (pm *ParticipationManager) ParticipationsForAddress(eventID EventID, address iotago.Address) ([]*TrackedParticipation, error)

+ func (pm *ParticipationManager) RewardsForTrackedParticipation(trackedParticipation *TrackedParticipation, atIndex milestone.Index) (uint64, error)

v1.2.0-rc4

Apr 11, 2022

v1.2.0-rc3

Apr 6, 2022

v1.2.0-rc2

Apr 4, 2022

v1.2.0-rc1

Mar 30, 2022

v1.1.3

Dec 29, 2021

v1.1.2

Dec 22, 2021

v1.1.1

Dec 22, 2021

v1.1.0

Dec 10, 2021

Changes in this version

+ const AnswerAdditionalInfoMaxLength

+ const AnswerTextMaxLength

+ const AnswerValueInvalid

+ const AnswerValueSkipped

+ const BallotDenominator

+ const BallotMaxQuestionsCount

+ const BallotMinQuestionsCount

+ const BallotPayloadTypeID

+ const EventAdditionalInfoMaxLength

+ const EventIDLength

+ const EventNameMaxLength

+ const ParticipationStoreKeyPrefixBallotAccululatedVoteBalanceForQuestionAndAnswer

+ const ParticipationStoreKeyPrefixBallotCurrentVoteBalanceForQuestionAndAnswer

+ const ParticipationStoreKeyPrefixEvents

+ const ParticipationStoreKeyPrefixMessages

+ const ParticipationStoreKeyPrefixStakingAddress

+ const ParticipationStoreKeyPrefixStakingTotalParticipation

+ const ParticipationStoreKeyPrefixTrackedOutputs

+ const ParticipationStoreKeyPrefixTrackedSpentOutputs

+ const ParticipationsMaxParticipationCount

+ const ParticipationsMinParticipationCount

+ const QuestionAdditionalInfoMaxLength

+ const QuestionMaxAnswersCount

+ const QuestionMinAnswersCount

+ const QuestionTextMaxLength

+ const StakingAdditionalInfoMaxLength

+ const StakingPayloadTypeID

+ const StakingSymbolMaxLength

+ const StakingSymbolMinLength

+ const StakingTextMaxLength

+ var ErrDuplicateAnswerValue = errors.New("duplicate answer value found")

+ var ErrEventNotFound = errors.New("referenced event does not exist")

+ var ErrInvalidCurrentBallotVoteBalance = errors.New("current ballot vote balance invalid")

+ var ErrInvalidCurrentStakedAmount = errors.New("current staked amount invalid")

+ var ErrInvalidEvent = errors.New("invalid event")

+ var ErrInvalidMilestoneSequence = errors.New("milestone are not monotonically increasing")

+ var ErrInvalidNumeratorOrDenominator = errors.New("numerator and denominator need to be greater than zero")

+ var ErrInvalidPreviouslyTrackedParticipation = errors.New("a previously tracked participation changed and is now invalid")

+ var ErrMultipleEventParticipation = errors.New("multiple participations for the same event")

+ var ErrParticipationCorruptedStorage = errors.New("the participation database was not shutdown properly")

+ var ErrParticipationEventAlreadyExists = errors.New("the given participation event already exists")

+ var ErrParticipationEventBallotCanOverflow = errors.New(...)

+ var ErrParticipationEventStakingCanOverflow = errors.New(...)

+ var ErrParticipationEventStartedBeforePruningIndex = errors.New("the given participation event started before the pruning index of this node")

+ var ErrParticipationTooManyAnswers = errors.New("participation contains more answers than what a ballot can hold")

+ var ErrPayloadEmpty = errors.New("payload cannot be empty")

+ var ErrSerializationReservedValue = errors.New("reserved value used")

+ var ErrSerializationStringLengthInvalid = errors.New("invalid string length")

+ var ErrUnknownParticipation = errors.New("no participation found")

+ var ErrUnknownPayloadType = errors.New("unknown payload type")

+ var NullEventID = EventID

+ func PayloadSelector(payloadType uint32) (serializer.Serializable, error)

+ type Answer struct

+ AdditionalInfo string

+ Text string

+ Value uint8

+ func (a *Answer) Deserialize(data []byte, deSeriMode serializer.DeSerializationMode) (int, error)

+ func (a *Answer) MarshalJSON() ([]byte, error)

+ func (a *Answer) Serialize(deSeriMode serializer.DeSerializationMode) ([]byte, error)

+ func (a *Answer) UnmarshalJSON(bytes []byte) error

+ type AnswerStatus struct

+ Accumulated uint64

+ Current uint64

+ Value uint8

+ type Ballot struct

+ Questions serializer.Serializables

+ func (q *Ballot) Deserialize(data []byte, deSeriMode serializer.DeSerializationMode) (int, error)

+ func (q *Ballot) MarshalJSON() ([]byte, error)

+ func (q *Ballot) Serialize(deSeriMode serializer.DeSerializationMode) ([]byte, error)

+ func (q *Ballot) UnmarshalJSON(bytes []byte) error

+ type BallotBuilder struct

+ func NewBallotBuilder() *BallotBuilder

+ func (qb *BallotBuilder) AddQuestion(entry *Question) *BallotBuilder

+ func (qb *BallotBuilder) Build() (*Ballot, error)

+ type Event struct

+ AdditionalInfo string

+ MilestoneIndexCommence uint32

+ MilestoneIndexEnd uint32

+ MilestoneIndexStart uint32

+ Name string

+ Payload serializer.Serializable

+ func (e *Event) Ballot() *Ballot

+ func (e *Event) BallotCanOverflow() bool

+ func (e *Event) BallotQuestions() []*Question

+ func (e *Event) CommenceMilestoneIndex() milestone.Index

+ func (e *Event) Deserialize(data []byte, deSeriMode serializer.DeSerializationMode) (int, error)

+ func (e *Event) EndMilestoneIndex() milestone.Index

+ func (e *Event) ID() (EventID, error)

+ func (e *Event) IsAcceptingParticipation(atIndex milestone.Index) bool

+ func (e *Event) IsCountingParticipation(atIndex milestone.Index) bool

+ func (e *Event) MarshalJSON() ([]byte, error)

+ func (e *Event) Serialize(deSeriMode serializer.DeSerializationMode) ([]byte, error)

+ func (e *Event) ShouldAcceptParticipation(forIndex milestone.Index) bool

+ func (e *Event) ShouldCountParticipation(forIndex milestone.Index) bool

+ func (e *Event) Staking() *Staking

+ func (e *Event) StakingCanOverflow() bool

+ func (e *Event) StartMilestoneIndex() milestone.Index

+ func (e *Event) Status(atIndex milestone.Index) string

+ func (e *Event) UnmarshalJSON(bytes []byte) error

+ type EventBuilder struct

+ func NewEventBuilder(name string, milestoneCommence milestone.Index, ...) *EventBuilder

+ func (rb *EventBuilder) Build() (*Event, error)

+ func (rb *EventBuilder) Payload(seri serializer.Serializable) *EventBuilder

+ type EventID = [EventIDLength]byte

+ func ParseEventID(ms *marshalutil.MarshalUtil) (EventID, error)

+ type EventStatus struct

+ Checksum string

+ MilestoneIndex milestone.Index

+ Questions []*QuestionStatus

+ Staking *StakingStatus

+ Status string

+ type IterateOption func(*IterateOptions)

+ func FilterRequiredMinimumRewards(filter bool) IterateOption

+ func MaxResultCount(count int) IterateOption

+ type IterateOptions struct

+ type Option func(opts *Options)

+ func WithIndexationMessage(indexationMessage string) Option

+ type Options struct

+ type Participation struct

+ Answers []byte

+ EventID EventID

+ func (p *Participation) Deserialize(data []byte, deSeriMode serializer.DeSerializationMode) (int, error)

+ func (p *Participation) MarshalJSON() ([]byte, error)

+ func (p *Participation) Serialize(deSeriMode serializer.DeSerializationMode) ([]byte, error)

+ func (p *Participation) UnmarshalJSON(bytes []byte) error

+ type ParticipationManager struct

+ func NewManager(dbStorage *storage.Storage, syncManager *syncmanager.SyncManager, ...) (*ParticipationManager, error)

+ func (pm *ParticipationManager) AccumulatedBallotVoteBalanceForQuestionAndAnswer(eventID EventID, milestone milestone.Index, questionIdx uint8, answerIdx uint8) (uint64, error)

+ func (pm *ParticipationManager) ApplyNewConfirmedMilestoneIndex(index milestone.Index) error

+ func (pm *ParticipationManager) ApplyNewUTXO(index milestone.Index, newOutput *utxo.Output) error

+ func (pm *ParticipationManager) ApplySpentUTXO(index milestone.Index, spent *utxo.Spent) error

+ func (pm *ParticipationManager) CloseDatabase() error

+ func (pm *ParticipationManager) CurrentBallotVoteBalanceForQuestionAndAnswer(eventID EventID, milestone milestone.Index, questionIdx uint8, answerIdx uint8) (uint64, error)

+ func (pm *ParticipationManager) DeleteEvent(eventID EventID) error

+ func (pm *ParticipationManager) Event(eventID EventID) *Event

+ func (pm *ParticipationManager) EventIDs(eventPayloadType ...uint32) []EventID

+ func (pm *ParticipationManager) EventStatus(eventID EventID, milestone ...milestone.Index) (*EventStatus, error)

+ func (pm *ParticipationManager) Events() map[EventID]*Event

+ func (pm *ParticipationManager) EventsAcceptingParticipation() map[EventID]*Event

+ func (pm *ParticipationManager) EventsCountingParticipation() map[EventID]*Event

+ func (pm *ParticipationManager) ForEachActiveParticipation(eventID EventID, consumer TrackedParticipationConsumer, ...) error

+ func (pm *ParticipationManager) ForEachPastParticipation(eventID EventID, consumer TrackedParticipationConsumer, ...) error

+ func (pm *ParticipationManager) ForEachStakingAddress(eventID EventID, consumer StakingRewardsConsumer, options ...IterateOption) error

+ func (pm *ParticipationManager) MessageForEventAndMessageID(eventID EventID, messageId hornet.MessageID) (*storage.Message, error)

+ func (pm *ParticipationManager) ParticipationForOutputID(eventID EventID, outputID *iotago.UTXOInputID) (*TrackedParticipation, error)

+ func (pm *ParticipationManager) ParticipationsForOutputID(outputID *iotago.UTXOInputID) ([]*TrackedParticipation, error)

+ func (pm *ParticipationManager) ParticipationsFromMessage(msg *storage.Message) (*utxo.Output, []*Participation, error)

+ func (pm *ParticipationManager) StakingRewardForAddress(eventID EventID, address iotago.Address) (uint64, error)

+ func (pm *ParticipationManager) StoreEvent(event *Event) (EventID, error)

+ type Participations struct

+ Participations serializer.Serializables

+ func (p *Participations) Deserialize(data []byte, deSeriMode serializer.DeSerializationMode) (int, error)

+ func (p *Participations) MarshalJSON() ([]byte, error)

+ func (p *Participations) Serialize(deSeriMode serializer.DeSerializationMode) ([]byte, error)

+ func (p *Participations) UnmarshalJSON(bytes []byte) error

+ type ParticipationsBuilder struct

+ func NewParticipationsBuilder() *ParticipationsBuilder

+ func (b *ParticipationsBuilder) AddParticipation(entry *Participation) *ParticipationsBuilder

+ func (b *ParticipationsBuilder) Build() (*Participations, error)

+ type Question struct

+ AdditionalInfo string

+ Answers serializer.Serializables

+ Text string

+ func (q *Question) Deserialize(data []byte, deSeriMode serializer.DeSerializationMode) (int, error)

+ func (q *Question) MarshalJSON() ([]byte, error)

+ func (q *Question) QuestionAnswers() []*Answer

+ func (q *Question) Serialize(deSeriMode serializer.DeSerializationMode) ([]byte, error)

+ func (q *Question) UnmarshalJSON(bytes []byte) error

+ type QuestionBuilder struct

+ func NewQuestionBuilder(text string, additionalInfo string) *QuestionBuilder

+ func (qb *QuestionBuilder) AddAnswer(entry *Answer) *QuestionBuilder

+ func (qb *QuestionBuilder) Build() (*Question, error)

+ type QuestionStatus struct

+ Answers []*AnswerStatus

+ func (q *QuestionStatus) StatusForAnswerValue(answerValue uint8) *AnswerStatus

+ type Staking struct

+ AdditionalInfo string

+ Denominator uint32

+ Numerator uint32

+ RequiredMinimumRewards uint64

+ Symbol string

+ Text string

+ func (s *Staking) Deserialize(data []byte, deSeriMode serializer.DeSerializationMode) (int, error)

+ func (s *Staking) MarshalJSON() ([]byte, error)

+ func (s *Staking) Serialize(deSeriMode serializer.DeSerializationMode) ([]byte, error)

+ func (s *Staking) UnmarshalJSON(bytes []byte) error

+ type StakingRewardsConsumer func(address iotago.Address, rewards uint64) bool

+ type StakingStatus struct

+ Rewarded uint64

+ Staked uint64

+ Symbol string

+ type TrackedParticipation struct

+ Amount uint64

+ EndIndex milestone.Index

+ EventID EventID

+ MessageID hornet.MessageID

+ OutputID *iotago.UTXOInputID

+ StartIndex milestone.Index

+ func TrackedParticipationFromBytes(key []byte, value []byte) (*TrackedParticipation, error)

+ func (t *TrackedParticipation) ValueBytes() []byte

+ type TrackedParticipationConsumer func(trackedParticipation *TrackedParticipation) bool

v1.1.0-rc1

Dec 3, 2021