package
4.0.2-stable+incompatible
Repository: https://github.com/algorand/go-algorand.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
AddSaturate adds 2 values with saturation on overflow.
Algos is a convenience function so that whole Algos can be written easily.
Annotate adds additional attributes to an existing error, even if the error is deep in the error chain.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
Attributes returns the attributes of a structured error, or nil/empty.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
DivCeil provides `math.Ceil` semantics using integer division.
MicroAlgosMaxSize returns maximum possible msgp encoded size of MicroAlgos in bytes.
MinA returns the smaller of 2 MicroAlgos values.
MinBalance computes the minimum balance requirements for an account based on some consensus parameters.
MulAIntSaturate uses MulSaturate to multiply b (int) with a (MicroAlgos).
Muldiv computes a*b/c.
MulSaturate multiplies 2 values with saturation on overflow.
New creates a new structured error object using the supplied message and attributes.
NewFraction creates the obvious Fraction, and checks that is not improper, nor divides by zero.
NewPercent creates a fraction reflecting the given percentage.
NormalizedOnlineAccountBalance returns a “normalized” balance for an account with the given parameters.
OAdd adds 2 values with overflow detection.
OAddA adds 2 MicroAlgos values with overflow tracking.
OMul multiplies 2 values with overflow detection.
OneTimeIDForRound maps a round to the identifier for which ephemeral key should be used for that round.
OSub subtracts b from a with overflow detection.
OSubA subtracts b from a with overflow tracking.
MaxSize returns a maximum valid message size for this message type.
PendingRewards computes the amount of rewards (in microalgos) that have yet to be added to the account balance.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
SubSaturate subtracts 2 values with saturation on underflow.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
MaxSize returns a maximum valid message size for this message type.
UnmarshalChecksumAddress tries to unmarshal the checksummed address string.
UnmarshalStatus decodes string status value back to Status constant.
MaxSize returns a maximum valid message size for this message type.
WithUpdatedRewards returns an updated number of algos, total rewards and new rewards base to reflect rewards up to some rewards level.
Wrap is used to "demote" an existing error to a field in a new structured error.
# Constants
AppCreatable is the CreatableType corresponds to apps.
AssetCreatable is the CreatableType corresponding to assets This value must be 0 to align with the applications database upgrade.
DeleteAction indicates that the value for a particular key should be deleted.
EncodedMaxAppLocalStates is the decoder limit for number of opted-in apps in a single account.
EncodedMaxAppParams is the decoder limit for number of created apps in a single account.
EncodedMaxKeyValueEntries is the decoder limit for the length of a key/value store.
ErrIndexOutOfBound returned when an index is out of the array's bound.
NotParticipating indicates that the associated account neither participates in the consensus, nor receives rewards.
Offline indicates that the associated account receives rewards but does not participate in the consensus.
Online indicates that the associated account participates in the consensus and receive rewards.
SetBytesAction indicates that a TEAL byte slice should be stored at a key.
SetUintAction indicates that a Uint should be stored at a key.
TealBytesType represents the type of byte slice in a TEAL program.
TealUintType represents the type of uint in a TEAL program.
# Structs
AccountData contains the data associated with a given address.
AccountDetail encapsulates meaningful details about a given account, for external consumption.
AppLocalState stores the LocalState associated with an application.
AppParams stores the global information associated with an application.
AssetHolding describes an asset held by an account.
AssetParams describes the parameters of an asset.
BalanceDetail encapsulates meaningful details about the current balances of the ledger, for external consumption.
BalanceRecord pairs an account's address with its associated data.
CreatableLocator stores both the creator, whose balance record contains the asset/app parameters, and the creatable index, which is the key into those parameters.
Fraction represents the mathematical notion of rational number, but is much simpler than `big.Rat`.
MicroAlgos is our unit of currency.
OnlineAccountData contains the voting information for a single account.
OverflowTracker is used to track when an operation causes an overflow.
A Participant corresponds to an account whose AccountData.Status is Online, and for which the expected sigRound satisfies AccountData.VoteFirstValid <= sigRound <= AccountData.VoteLastValid.
SError is a structured error object.
StateSchema sets maximums on the number of each type that may be stored.
StateSchemas is a thin wrapper around the LocalStateSchema and the GlobalStateSchema, since they are often needed together.
SupplyDetail encapsulates meaningful details about the ledger's current token supply.
TealValue contains type information and a value, representing a value in a TEAL program.
ValueDelta links a DeltaAction with a value to be set.
VotingData holds voting-related data.
# Type aliases
No description provided by the author
AppIndex is the unique integer index of an application that can be used to look up the creator of the application, whose balance record contains the AppParams.
AssetIndex is the unique integer index of an asset that can be used to look up the creator of the asset, whose balance record contains the AssetParams.
CreatableIndex represents either an AssetIndex or AppIndex, which come from the same namespace of indices as each other (both assets and apps are "creatables").
CreatableType is an enum representing whether or not a given creatable is an application or an asset.
DeltaAction is an enum of actions that may be performed when applying a delta to a TEAL key/value store.
ParticipantsArray implements merklearray.Array and is used to commit to a Merkle tree of online accounts.
Round represents a protocol round index.
RoundInterval is a number of rounds.
SortAddress implements sorting by Address keys for canonical encoding of maps in msgpack format.
SortAppIndex implements sorting by AppIndex keys for canonical encoding of maps in msgpack format.
SortAssetIndex implements sorting by AssetIndex keys for canonical encoding of maps in msgpack format.
SortString implements sorting by string keys for canonical encoding of maps in msgpack format.
SortUint64 implements sorting by uint64 keys for canonical encoding of maps in msgpack format.
StateDelta is a map from key/value store keys to ValueDeltas, indicating what should happen for that key
msgp:allocbound StateDelta config.MaxStateDeltaKeys,config.MaxAppBytesKeyLen.
Status is the delegation status of an account's MicroAlgos.
TealKeyValue represents a key/value store for use in an application's LocalState or GlobalState
msgp:allocbound TealKeyValue EncodedMaxKeyValueEntries,config.MaxAppBytesKeyLen.
TealType is an enum of the types in a TEAL program: Bytes and Uint.