Address
An Algorand address
Extended by
Constructors
new Address()
new Address():
Address
Returns
Properties
authAddr
readonlyauthAddr:Address
Signifies the public key for the keypair that has authority over this address
Source
balance
readonlybalance:uint64
The accounts current balance (in µALGO)
Source
incentiveEligible
incentiveEligible:
boolean
Had this account opted into block payouts
Source
isInLedger
readonlyisInLedger:uint64
Whether the account is in the ledger or not
Source
lastHeartbeat
lastHeartbeat:
uint64
The last block this account sent a heartbeat
Source
lastProposed
lastProposed:
uint64
The last block this account proposed
Source
minBalance
readonlyminBalance:uint64
The account’s current minimum balance require (MBR) (in µALGO)
Source
totalAppsCreated
readonlytotalAppsCreated:uint64
The total number of apps created by this address
Source
totalAppsOptedIn
readonlytotalAppsOptedIn:uint64
The total number of apps opted in to by this address
Source
totalAssets
readonlytotalAssets:uint64
The number of assets this address is opted in to
Source
totalAssetsCreated
readonlytotalAssetsCreated:uint64
The total number of assets created by this address
Source
totalBoxBytes
readonlytotalBoxBytes:uint64
The total number of box bytes funded by this address. Only applies to application addreses.
Source
totalBoxes
readonlytotalBoxes:uint64
The total number of boxes funded by this address. Only applies to application addreses.
Source
totalExtraAppPages
readonlytotalExtraAppPages:uint64
The total number of extra application pages reserved across all apps
Source
totalNumByteSlice
readonlytotalNumByteSlice:uint64
The total number of byte slices reserved in global and local state across all apps
Source
totalNumUint
readonlytotalNumUint:uint64
The total number of uint64 values reserved in global and local state across all apps
Source
voterBalance
voterBalance:
uint64
Online stake in microalgos
Source
zeroAddress
staticreadonlyzeroAddress:Address
The zero address: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ
Source
Methods
assetBalance()
assetBalance(
asa):uint64
The balance of the given asset for this address
Parameters
• asa: Asset
Returns
Source
assetFrozen()
assetFrozen(
asa):uint64
Whether the given asset is frozen in this address
Parameters
• asa: Asset
Returns
Source
isOptedInToApp()
isOptedInToApp(
app):boolean
Whether this address is opted into the given application
Parameters
• app: Application
Returns
boolean
Source
isOptedInToAsset()
isOptedInToAsset(
asa):boolean
Whether this address is opted into the given address
Parameters
• asa: Asset
Returns
boolean
Source
fromAddress()
staticfromAddress(address):Address
Create an Address instance from a literal base32 Algorand address
Parameters
• address: string
Returns
Source
fromBytes()
staticfromBytes(pubKey):Address
Create an Address instance from the given public key
Parameters
• pubKey: BytesLike