Skip to content

Account

Alias for Address that uses account encoding for ABI arguments

Extends

Constructors

new Account()

new Account(): Account

Returns

Account

Inherited from

Address.constructor

Properties

authAddr

readonly authAddr: Address

Signifies the public key for the keypair that has authority over this address

Inherited from

Address.authAddr

Source

types/global.d.ts:457


balance

readonly balance: uint64

The accounts current balance (in µALGO)

Inherited from

Address.balance

Source

types/global.d.ts:444


incentiveEligible

incentiveEligible: boolean

Had this account opted into block payouts

Inherited from

Address.incentiveEligible

Source

types/global.d.ts:499


isInLedger

readonly isInLedger: uint64

Whether the account is in the ledger or not

Inherited from

Address.isInLedger

Source

types/global.d.ts:447


lastHeartbeat

lastHeartbeat: uint64

The last block this account sent a heartbeat

Inherited from

Address.lastHeartbeat

Source

types/global.d.ts:505


lastProposed

lastProposed: uint64

The last block this account proposed

Inherited from

Address.lastProposed

Source

types/global.d.ts:502


minBalance

readonly minBalance: uint64

The account’s current minimum balance require (MBR) (in µALGO)

Inherited from

Address.minBalance

Source

types/global.d.ts:450


totalAppsCreated

readonly totalAppsCreated: uint64

The total number of apps created by this address

Inherited from

Address.totalAppsCreated

Source

types/global.d.ts:469


totalAppsOptedIn

readonly totalAppsOptedIn: uint64

The total number of apps opted in to by this address

Inherited from

Address.totalAppsOptedIn

Source

types/global.d.ts:472


totalAssets

readonly totalAssets: uint64

The number of assets this address is opted in to

Inherited from

Address.totalAssets

Source

types/global.d.ts:453


totalAssetsCreated

readonly totalAssetsCreated: uint64

The total number of assets created by this address

Inherited from

Address.totalAssetsCreated

Source

types/global.d.ts:475


totalBoxBytes

readonly totalBoxBytes: uint64

The total number of box bytes funded by this address. Only applies to application addreses.

Inherited from

Address.totalBoxBytes

Source

types/global.d.ts:481


totalBoxes

readonly totalBoxes: uint64

The total number of boxes funded by this address. Only applies to application addreses.

Inherited from

Address.totalBoxes

Source

types/global.d.ts:478


totalExtraAppPages

readonly totalExtraAppPages: uint64

The total number of extra application pages reserved across all apps

Inherited from

Address.totalExtraAppPages

Source

types/global.d.ts:466


totalNumByteSlice

readonly totalNumByteSlice: uint64

The total number of byte slices reserved in global and local state across all apps

Inherited from

Address.totalNumByteSlice

Source

types/global.d.ts:463


totalNumUint

readonly totalNumUint: uint64

The total number of uint64 values reserved in global and local state across all apps

Inherited from

Address.totalNumUint

Source

types/global.d.ts:460


voterBalance

voterBalance: uint64

Online stake in microalgos

Inherited from

Address.voterBalance

Source

types/global.d.ts:496


zeroAddress

static readonly zeroAddress: Address

The zero address: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ

Inherited from

Address.zeroAddress

Source

types/global.d.ts:441

Methods

assetBalance()

assetBalance(asa): uint64

The balance of the given asset for this address

Parameters

asa: Asset

Returns

uint64

Inherited from

Address.assetBalance

Source

types/global.d.ts:484


assetFrozen()

assetFrozen(asa): uint64

Whether the given asset is frozen in this address

Parameters

asa: Asset

Returns

uint64

Inherited from

Address.assetFrozen

Source

types/global.d.ts:490


isOptedInToApp()

isOptedInToApp(app): boolean

Whether this address is opted into the given application

Parameters

app: Application

Returns

boolean

Inherited from

Address.isOptedInToApp

Source

types/global.d.ts:493


isOptedInToAsset()

isOptedInToAsset(asa): boolean

Whether this address is opted into the given address

Parameters

asa: Asset

Returns

boolean

Inherited from

Address.isOptedInToAsset

Source

types/global.d.ts:487


fromAddress()

static fromAddress(address): Address

Create an Address instance from a literal base32 Algorand address

Parameters

address: string

Returns

Address

Inherited from

Address.fromAddress

Source

types/global.d.ts:438


fromBytes()

static fromBytes(pubKey): Address

Create an Address instance from the given public key

Parameters

pubKey: BytesLike

Returns

Address

Inherited from

Address.fromBytes

Source

types/global.d.ts:435