Skip to content

Account

Account: object

Account information at a given round.

Definition: data/basics/userBalance.go : AccountData

Type declaration

address

address: string

the account public key

amount

amount: number

[algo] total number of MicroAlgos in the account

amount-without-pending-rewards

amount-without-pending-rewards: number

specifies the amount of MicroAlgos in the account, without the pending rewards.

apps-local-state?

optional apps-local-state: ApplicationLocalState[]

[appl] applications local data stored in this account.

Note the raw object uses map[int] -> AppLocalState for this type.

apps-total-extra-pages?

optional apps-total-extra-pages: number

[teap] the sum of all extra application program pages for this account.

apps-total-schema?

optional apps-total-schema: ApplicationStateSchema

assets?

optional assets: AssetHolding[]

[asset] assets held by this account.

Note the raw object uses map[int] -> AssetHolding for this type.

auth-addr?

optional auth-addr: string

[spend] 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.

created-apps?

optional created-apps: Application[]

[appp] parameters of applications created by this account including app global data.

Note: the raw account uses map[int] -> AppParams for this type.

created-assets?

optional created-assets: Asset[]

[apar] parameters of assets created by this account.

Note: the raw account uses map[int] -> Asset for this type.

incentive-eligible?

optional incentive-eligible: boolean

Whether or not the account can receive block incentives if its balance is in range at proposal time.

last-heartbeat?

optional last-heartbeat: number

The round in which this account last went online, or explicitly renewed their online status.

last-proposed?

optional last-proposed: number

The round in which this account last proposed the block.

min-balance

min-balance: number

MicroAlgo balance required by the account.

The requirement grows based on asset and application usage.

participation?

optional participation: AccountParticipation

pending-rewards

pending-rewards: number

amount of MicroAlgos of pending rewards in this account.

reward-base?

optional reward-base: number

[ebase] used as part of the rewards computation. Only applicable to accounts which are participating.

rewards

rewards: number

[ern] total rewards of MicroAlgos the account has received, including pending rewards.

round

round: number

The round for which this information is relevant.

sig-type?

optional sig-type: "sig" | "msig" | "lsig"

Indicates what type of signature is used by this account, must be one of:

  • sig
  • msig
  • lsig

status

status: string

[onl] delegation status of the account’s MicroAlgos

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

total-apps-opted-in

total-apps-opted-in: number

The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account.

total-assets-opted-in

total-assets-opted-in: number

The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account.

total-box-bytes?

optional total-box-bytes: number

[tbxb] The total number of bytes used by this account’s app’s box keys and values.

total-boxes?

optional total-boxes: number

[tbx] The number of existing boxes created by this account’s app.

total-created-apps

total-created-apps: number

The count of all apps (AppParams objects) created by this account.

total-created-assets

total-created-assets: number

The count of all assets (AssetParams objects) created by this account.

Defined in

types.gen.ts:10