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.0.0

Oct 2, 2023

Changes in this version

+ const StorePrefixHealth

+ type Manager struct

+ func (pm *Manager) AddressRewards(address iotago.Address, msIndex ...iotago.MilestoneIndex) (*AddressRewards, error)

+ func (pm *Manager) AnswersForTrackedParticipation(trackedParticipation *TrackedParticipation) ([]byte, error)

+ func (pm *Manager) ApplyNewLedgerUpdate(index iotago.MilestoneIndex, created []*ParticipationOutput, ...) error

+ func (pm *Manager) BlockForEventAndBlockID(eventID EventID, blockID iotago.BlockID) (*ParticipationBlock, error)

+ func (pm *Manager) CloseDatabase() error

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

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

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

+ func (pm *Manager) EventRewards(eventID EventID, msIndex ...iotago.MilestoneIndex) (*EventRewards, error)

+ func (pm *Manager) EventStatus(eventID EventID, milestone ...iotago.MilestoneIndex) (*EventStatus, error)

+ func (pm *Manager) EventWithoutLocking(eventID EventID) *Event

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

+ func (pm *Manager) EventsAcceptingParticipation(index iotago.MilestoneIndex) map[EventID]*Event

+ func (pm *Manager) EventsCountingParticipation(index iotago.MilestoneIndex) map[EventID]*Event

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

+ func (pm *Manager) ForEachAddressStakingParticipation(eventID EventID, msIndex iotago.MilestoneIndex, ...) error

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

+ func (pm *Manager) LedgerIndex() iotago.MilestoneIndex

+ func (pm *Manager) ParticipationForOutputIDWithoutLocking(eventID EventID, outputID iotago.OutputID) (*TrackedParticipation, error)

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

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

+ func (pm *Manager) ParticipationsForOutputID(outputID iotago.OutputID) ([]*TrackedParticipation, error)

+ func (pm *Manager) ParticipationsFromBlock(block *ParticipationBlock, _ iotago.MilestoneIndex) (*ParticipationOutput, []*Participation, error)

+ func (pm *Manager) RewardsForTrackedParticipationWithoutLocking(trackedParticipation *TrackedParticipation, atIndex iotago.MilestoneIndex) (uint64, error)

+ func (pm *Manager) StakingRewardForAddressWithoutLocking(eventID EventID, address iotago.Address, msIndex iotago.MilestoneIndex) (uint64, error)

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

v1.0.0-rc.3

Mar 15, 2023

v1.0.0-rc.2

Dec 21, 2022

v1.0.0-rc.1

Sep 26, 2022

v1.0.0-beta.8

Sep 16, 2022

v1.0.0-beta.7

Sep 9, 2022

v1.0.0-beta.6

Aug 30, 2022

v1.0.0-beta.5

Aug 9, 2022

v1.0.0-beta.4

Aug 4, 2022

v1.0.0-beta.3

Jul 26, 2022

v1.0.0-beta.2

Jul 21, 2022

v1.0.0-beta.1

Jul 15, 2022

v0

v0.7.0

Jul 13, 2022

v0.6.0

Jun 21, 2022

v0.5.0

May 31, 2022

Changes in this version

+ const AnswerAdditionalInfoMaxLength

+ const AnswerTextMaxLength

+ const AnswerValueInvalid

+ const AnswerValueSkipped

+ const BallotDenominator

+ const BallotMaxQuestionsCount

+ const BallotMinQuestionsCount

+ const BallotPayloadTypeID

+ const DBVersionParticipation

+ const EventAdditionalInfoMaxLength

+ const EventIDLength

+ const EventNameMaxLength

+ const ParticipationStoreKeyPrefixBallotAccululatedVoteBalanceForQuestionAndAnswer

+ const ParticipationStoreKeyPrefixBallotCurrentVoteBalanceForQuestionAndAnswer

+ const ParticipationStoreKeyPrefixBlocks

+ const ParticipationStoreKeyPrefixEvents

+ const ParticipationStoreKeyPrefixStakingAddress

+ const ParticipationStoreKeyPrefixStakingCurrentRewards

+ const ParticipationStoreKeyPrefixStakingTotalParticipation

+ const ParticipationStoreKeyPrefixStatus

+ const ParticipationStoreKeyPrefixTrackedOutputByAddress

+ 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 ErrEventNotFound = errors.New("referenced event does not exist")

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

+ var ErrInvalidCurrentRewardsAmount = errors.New("current rewards amount 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 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 ErrSerializationUnknownType = errors.New("invalid type")

+ 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 AddressReward struct

+ Amount uint64

+ MinimumReached bool

+ Symbol string

+ type AddressRewards struct

+ MilestoneIndex milestone.Index

+ Rewards map[string]*AddressReward

+ type Answer struct

+ AdditionalInfo string

+ Text string

+ Value uint8

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

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

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

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

+ type AnswerStatus struct

+ Accumulated uint64

+ Current uint64

+ Value uint8

+ type Answers []*Answer

+ func (a *Answers) FromSerializables(seris serializer.Serializables)

+ func (a Answers) ToSerializables() serializer.Serializables

+ type Ballot struct

+ Questions Questions

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

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

+ func (q *Ballot) Serialize(deSeriMode serializer.DeSerializationMode, deSeriCtx interface{}) ([]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 BlockForBlockIDProvider func(blockID iotago.BlockID) (*ParticipationBlock, 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(protoParas *iotago.ProtocolParameters) bool

+ func (e *Event) BallotQuestions() Questions

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

+ func (e *Event) Deserialize(data []byte, deSeriMode serializer.DeSerializationMode, deSeriCtx interface{}) (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, deSeriCtx interface{}) ([]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(protoParas *iotago.ProtocolParameters) 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 (eventID EventID) ToHex() string

+ type EventRewards struct

+ Checksum string

+ MilestoneIndex milestone.Index

+ Rewards map[string]uint64

+ Symbol string

+ TotalRewards uint64

+ type EventStatus struct

+ Checksum string

+ MilestoneIndex milestone.Index

+ Questions []*QuestionStatus

+ Staking *StakingStatus

+ Status string

+ type LedgerUpdatesProvider func(ctx context.Context, startIndex milestone.Index, endIndex milestone.Index, ...) error

+ type NodeStatusProvider func() (confirmedIndex milestone.Index, pruningIndex milestone.Index)

+ type Option func(opts *Options)

+ func WithTagMessage(tagMessage string) Option

+ type Options struct

+ type OutputForOutputIDProvider func(outputID iotago.OutputID) (*ParticipationOutput, error)

+ type Participation struct

+ Answers []byte

+ EventID EventID

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

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

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

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

+ type ParticipationBlock struct

+ Block *iotago.Block

+ BlockID iotago.BlockID

+ Data []byte

+ func (msg *ParticipationBlock) Transaction() *iotago.Transaction

+ func (msg *ParticipationBlock) TransactionEssence() *iotago.TransactionEssence

+ func (msg *ParticipationBlock) TransactionEssenceTaggedData() *iotago.TaggedData

+ func (msg *ParticipationBlock) TransactionEssenceUTXOInputs() iotago.OutputIDs

+ type ParticipationManager struct

+ func NewManager(participationStore kvstore.KVStore, ...) (*ParticipationManager, error)

+ func (pm *ParticipationManager) AddressRewards(address iotago.Address, msIndex ...milestone.Index) (*AddressRewards, error)

+ func (pm *ParticipationManager) ApplyNewLedgerUpdate(index milestone.Index, created []*ParticipationOutput, ...) error

+ func (pm *ParticipationManager) BlockForEventAndBlockID(eventID EventID, blockID iotago.BlockID) (*ParticipationBlock, error)

+ func (pm *ParticipationManager) CloseDatabase() 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) EventRewards(eventID EventID, msIndex ...milestone.Index) (*EventRewards, error)

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

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

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

+ func (pm *ParticipationManager) EventsAcceptingParticipation(index milestone.Index) map[EventID]*Event

+ func (pm *ParticipationManager) EventsCountingParticipation(index milestone.Index) map[EventID]*Event

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

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

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

+ func (pm *ParticipationManager) LedgerIndex() milestone.Index

+ func (pm *ParticipationManager) ParticipationForOutputIDWithoutLocking(eventID EventID, outputID iotago.OutputID) (*TrackedParticipation, error)

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

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

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

+ func (pm *ParticipationManager) ParticipationsFromBlock(msg *ParticipationBlock, msIndex milestone.Index) (*ParticipationOutput, []*Participation, error)

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

+ func (pm *ParticipationManager) StakingRewardForAddressWithoutLocking(eventID EventID, address iotago.Address, msIndex milestone.Index) (uint64, error)

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

+ type ParticipationOutput struct

+ Address iotago.Address

+ BlockID iotago.BlockID

+ Deposit uint64

+ OutputID iotago.OutputID

+ type ParticipationPayload struct

+ Participations Participations

+ func (p *ParticipationPayload) Deserialize(data []byte, deSeriMode serializer.DeSerializationMode, deSeriCtx interface{}) (int, error)

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

+ func (p *ParticipationPayload) Serialize(deSeriMode serializer.DeSerializationMode, deSeriCtx interface{}) ([]byte, error)

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

+ type Participations []*Participation

+ func (s *Participations) FromSerializables(seris serializer.Serializables)

+ func (s Participations) ToSerializables() serializer.Serializables

+ type ParticipationsBuilder struct

+ func NewParticipationsBuilder() *ParticipationsBuilder

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

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

+ type ProtocolParametersProvider func() *iotago.ProtocolParameters

+ type Question struct

+ AdditionalInfo string

+ Answers Answers

+ Text string

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

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

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

+ func (q *Question) Serialize(deSeriMode serializer.DeSerializationMode, deSeriCtx interface{}) ([]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 Questions []*Question

+ func (q *Questions) FromSerializables(seris serializer.Serializables)

+ func (q Questions) ToSerializables() serializer.Serializables

+ type Staking struct

+ AdditionalInfo string

+ Denominator uint32

+ Numerator uint32

+ RequiredMinimumRewards uint64

+ Symbol string

+ Text string

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

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

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

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

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

+ type StakingStatus struct

+ Rewarded uint64

+ Staked uint64

+ Symbol string

+ type TrackedParticipation struct

+ Amount uint64

+ BlockID iotago.BlockID

+ EndIndex milestone.Index

+ EventID EventID

+ OutputID iotago.OutputID

+ StartIndex milestone.Index

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

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

+ type TrackedParticipationConsumer func(trackedParticipation *TrackedParticipation) bool