AccountInformation
AccountInformation =
object
Defined in: algokit-utils-ts/src/types/account.ts:129
Account information at a given round.
Properties
Section titled “Properties”address
Section titled “address”address:
Address
Defined in: algokit-utils-ts/src/types/account.ts:133
The account public key
amountWithoutPendingRewards
Section titled “amountWithoutPendingRewards”amountWithoutPendingRewards:
AlgoAmount
Defined in: algokit-utils-ts/src/types/account.ts:141
The amount of Algo in the account, without the pending rewards.
appsLocalState?
Section titled “appsLocalState?”
optionalappsLocalState?:ApplicationLocalState[]
Defined in: algokit-utils-ts/src/types/account.ts:198
Applications local data stored in this account.
appsTotalExtraPages?
Section titled “appsTotalExtraPages?”
optionalappsTotalExtraPages?:number
Defined in: algokit-utils-ts/src/types/account.ts:203
The sum of all extra application program pages for this account.
appsTotalSchema?
Section titled “appsTotalSchema?”
optionalappsTotalSchema?:ApplicationStateSchema
Defined in: algokit-utils-ts/src/types/account.ts:209
(tsch) stores the sum of all of the local schemas and global schemas in this
account.
Note: the raw account uses StateSchema for this type.
assets?
Section titled “assets?”
optionalassets?:AssetHolding[]
Defined in: algokit-utils-ts/src/types/account.ts:214
Assets held by this account.
authAddr?
Section titled “authAddr?”
optionalauthAddr?:Address
Defined in: algokit-utils-ts/src/types/account.ts:221
The address against which signing should be checked. If empty, the
address of the current account is used. This field can be updated in any
transaction by setting the RekeyTo field.
balance
Section titled “balance”balance:
AlgoAmount
Defined in: algokit-utils-ts/src/types/account.ts:136
The balance of Algo currently held by the account.
createdApps?
Section titled “createdApps?”
optionalcreatedApps?:Application[]
Defined in: algokit-utils-ts/src/types/account.ts:226
Parameters of applications created by this account including app global data.
createdAssets?
Section titled “createdAssets?”
optionalcreatedAssets?:Asset[]
Defined in: algokit-utils-ts/src/types/account.ts:232
(apar) parameters of assets created by this account.
Note: the raw account uses map[int] -> Asset for this type.
lastHeartbeatRound?
Section titled “lastHeartbeatRound?”
optionallastHeartbeatRound?:bigint
Defined in: algokit-utils-ts/src/types/account.ts:269
The round in which this account last went online, or explicitly renewed their online status.
lastProposedRound?
Section titled “lastProposedRound?”
optionallastProposedRound?:bigint
Defined in: algokit-utils-ts/src/types/account.ts:274
The round in which this account last proposed the block.
minBalance
Section titled “minBalance”minBalance:
AlgoAmount
Defined in: algokit-utils-ts/src/types/account.ts:148
Algo balance required to be held by the account.
The requirement grows based on asset and application usage.
participation?
Section titled “participation?”
optionalparticipation?:AccountParticipation
Defined in: algokit-utils-ts/src/types/account.ts:238
AccountParticipation describes the parameters used by this account in consensus protocol.
pendingRewards
Section titled “pendingRewards”pendingRewards:
AlgoAmount
Defined in: algokit-utils-ts/src/types/account.ts:152
Amount of Algo of pending rewards in this account.
rewardBase?
Section titled “rewardBase?”
optionalrewardBase?:number
Defined in: algokit-utils-ts/src/types/account.ts:244
Used as part of the rewards computation. Only applicable to accounts which are participating.
rewards
Section titled “rewards”rewards:
AlgoAmount
Defined in: algokit-utils-ts/src/types/account.ts:158
Total rewards of Algo the account has received, including pending rewards.
sigType?
Section titled “sigType?”
optionalsigType?:string
Defined in: algokit-utils-ts/src/types/account.ts:252
Indicates what type of signature is used by this account, must be one of:
- sig
- msig
- lsig
status
Section titled “status”status:
string
Defined in: algokit-utils-ts/src/types/account.ts:171
Delegation status of the account’s Algo:
- Offline - indicates that the associated account is delegated.
- Online - indicates that the associated account used as part of the delegation pool.
- NotParticipating - indicates that the associated account is neither a delegator nor a delegate.
totalAppsOptedIn
Section titled “totalAppsOptedIn”totalAppsOptedIn:
number
Defined in: algokit-utils-ts/src/types/account.ts:177
The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account.
totalAssetsOptedIn
Section titled “totalAssetsOptedIn”totalAssetsOptedIn:
number
Defined in: algokit-utils-ts/src/types/account.ts:183
The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account.
totalBoxBytes?
Section titled “totalBoxBytes?”
optionaltotalBoxBytes?:number
Defined in: algokit-utils-ts/src/types/account.ts:258
The total number of bytes used by this account’s app’s box keys and values.
totalBoxes?
Section titled “totalBoxes?”
optionaltotalBoxes?:number
Defined in: algokit-utils-ts/src/types/account.ts:263
The number of existing boxes created by this account’s app.
totalCreatedApps
Section titled “totalCreatedApps”totalCreatedApps:
number
Defined in: algokit-utils-ts/src/types/account.ts:188
The count of all apps (AppParams objects) created by this account.
totalCreatedAssets
Section titled “totalCreatedAssets”totalCreatedAssets:
number
Defined in: algokit-utils-ts/src/types/account.ts:193
The count of all assets (AssetParams objects) created by this account.
validAsOfRound
Section titled “validAsOfRound”validAsOfRound:
bigint
Defined in: algokit-utils-ts/src/types/account.ts:163
The round number for which this information is relevant.