Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify account status meaning in code-comment #1921

Merged
merged 6 commits into from
Feb 22, 2021
Merged

Clarify account status meaning in code-comment #1921

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3be7345
Merge pull request #1685 from algorand/master
algojohnlee Nov 11, 2020
bff97e3
Merge remote-tracking branch 'origin/master' into feature/teal3
jannotti Jan 27, 2021
ce372a6
Merge pull request #1905 from algorand/master
algojohnlee Feb 11, 2021
2e639b7
Merge branch 'feature/teal3' of github.com:algorand/go-algorand
tsachiherman Feb 18, 2021
114feac
clarify account status
tsachiherman Feb 22, 2021
ce38c9a
typo
tsachiherman Feb 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions data/basics/userBalance.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,14 @@ import (
type Status byte

const (
// Offline indicates that the associated account is delegated.
// Offline indicates that the associated account receives rewards but does not participate in the consensus.
Offline Status = iota
// Online indicates that the associated account used as part of the delegation pool.
// Online indicates that the associated account participates in the consensus and receive rewards.
Online
// NotParticipating indicates that the associated account is neither a delegator nor a delegate. Currently it is reserved for the incentive pool.
// NotParticipating indicates that the associated account neither participates in the consensus, nor recieves rewards.
// Accounts that are marked as NotParticipating cannot change their status, but can receive and send Algos to other accounts.
// Two special accounts that are defined as NotParticipating are the incentive pool (also know as rewards pool) and the fee sink.
// ( these two accounts also have additional Algo transfer restrictions )
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could just be another sentence

Suggested change
// ( these two accounts also have additional Algo transfer restrictions )
// These two accounts also have additional Algo transfer restrictions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll update that in the next PR.

NotParticipating

// MaxEncodedAccountDataSize is a rough estimate for the worst-case scenario we're going to have of the account data and address serialized.
Expand Down