Class AccountStore

Hierarchy

AccountStore

Implements

AccountStoreI

Constructors

constructor

new AccountStore(balance: number | bigint, account?: string | default): AccountStore
Creates a new Algorand state account. @balance: initial Algo balance (in micro Algo) @account: algo-sdk Account type or string. If strirng is provided then it is used as an account name. If algo-sdk Account is not used than a random account is generated (with an associated private key)
Parameters
- balance: number | bigint
- Optional account: string | default
Returns AccountStore
- Defined in packages/runtime/src/account.ts:76

Properties

`Readonly` account

account: RuntimeAccountI

`Readonly` address

address: string

amount

amount: bigint

appsLocalState

appsLocalState: Map<number, AppLocalStateM>

appsTotalSchema

appsTotalSchema: ApplicationStateSchema

assets

assets: Map<number, AssetHoldingM>

createdApps

createdApps: Map<number, SSCAttributesM>

createdAssets

createdAssets: Map<number, AssetParams>

minBalance

minBalance: number

Methods

addApp

addApp(appID: number, appDefinition: AppDefinitionFromSource): CreatedAppM
Deploy application in account's state
Parameters
- appID: number
  
  application index
- appDefinition: AppDefinitionFromSource
  
  application definition metadata NOTE - approval and clear program must be the TEAL code as string
Returns CreatedAppM
Implementation of AccountStoreI.addApp
- Defined in packages/runtime/src/account.ts:327

addAsset

addAsset(assetId: number, name: string, asaDef: {
    clawback?: string;
    decimals: number | bigint;
    defaultFrozen?: boolean;
    freeze?: string;
    manager?: string;
    metadataHash?: string | Uint8Array | Buffer;
    name?: string;
    note?: string;
    noteb64?: string;
    optInAccNames?: string[];
    reserve?: string;
    total: string | number | bigint;
    unitName?: string;
    url?: string;
}): AssetParams
Deploy Asset in account's state
Parameters
- assetId: number
  
  Asset Index
- name: string
  
  Asset Name
- asaDef: {
      clawback?: string;
      decimals: number | bigint;
      defaultFrozen?: boolean;
      freeze?: string;
      manager?: string;
      metadataHash?: string | Uint8Array | Buffer;
      name?: string;
      note?: string;
      noteb64?: string;
      optInAccNames?: string[];
      reserve?: string;
      total: string | number | bigint;
      unitName?: string;
      url?: string;
  }
  
  Asset Definitions
  - Optional clawback?: string
  - decimals: number | bigint
  - Optional defaultFrozen?: boolean
  - Optional freeze?: string
  - Optional manager?: string
  - Optional metadataHash?: string | Uint8Array | Buffer
  - Optional name?: string
  - Optional note?: string
  - Optional noteb64?: string
  - Optional optInAccNames?: string[]
  - Optional reserve?: string
  - total: string | number | bigint
  - Optional unitName?: string
  - Optional url?: string
Returns AssetParams
Implementation of AccountStoreI.addAsset
- Defined in packages/runtime/src/account.ts:240

balance

balance(): bigint
Returns bigint
Implementation of AccountStoreI.balance
- Defined in packages/runtime/src/account.ts:99

closeApp

closeApp(appID: number): void
Parameters
- appID: number
Returns void
Implementation of AccountStoreI.closeApp
- Defined in packages/runtime/src/account.ts:391

closeAsset

closeAsset(assetId: number): void
removes asset holding from account
Parameters
- assetId: number
  
  asset index
Returns void
Implementation of AccountStoreI.closeAsset
- Defined in packages/runtime/src/account.ts:274

deleteApp

deleteApp(appID: number): void
Parameters
- appID: number
Returns void
Implementation of AccountStoreI.deleteApp
- Defined in packages/runtime/src/account.ts:373

destroyAsset

destroyAsset(assetId: number): void
Destroys asset
Parameters
- assetId: number
  
  Asset Index
Returns void
Implementation of AccountStoreI.destroyAsset
- Defined in packages/runtime/src/account.ts:307

getApp

getApp(appID: number): undefined | SSCAttributesM
Queries application by application index from account's global state. Returns undefined if app is not found.
Parameters
- appID: number
  
  application index
Returns undefined | SSCAttributesM
Implementation of AccountStoreI.getApp
- Defined in packages/runtime/src/account.ts:205

getAppFromLocal

getAppFromLocal(appID: number): undefined | AppLocalStateM
Queries application by application index from account's local state. Returns undefined if app is not found.
Parameters
- appID: number
  
  application index
Returns undefined | AppLocalStateM
Implementation of AccountStoreI.getAppFromLocal
- Defined in packages/runtime/src/account.ts:214

getAssetDef

getAssetDef(assetId: number): undefined | AssetParams
Queries asset definition by assetId
Parameters
- assetId: number
  
  asset index
Returns undefined | AssetParams
Implementation of AccountStoreI.getAssetDef
- Defined in packages/runtime/src/account.ts:222

getAssetHolding

getAssetHolding(assetId: number): undefined | AssetHoldingM
Queries asset holding by assetId
Parameters
- assetId: number
  
  asset index
Returns undefined | AssetHoldingM
Implementation of AccountStoreI.getAssetHolding
- Defined in packages/runtime/src/account.ts:230

getGlobalState

getGlobalState(appID: number, key: string | Uint8Array): undefined | StackElem
Queries app global state value. Returns undefined if the key is not present.
Parameters
- appID: number
- key: string | Uint8Array
Returns undefined | StackElem
Implementation of AccountStoreI.getGlobalState
- Defined in packages/runtime/src/account.ts:165

getLocalState

getLocalState(appID: number, key: string | Uint8Array): undefined | StackElem
Fetches local state value for key present in account returns undefined otherwise
Parameters
- appID: number
- key: string | Uint8Array
Returns undefined | StackElem
Implementation of AccountStoreI.getLocalState
- Defined in packages/runtime/src/account.ts:119

getSpendAddress

getSpendAddress(): string
Returns string
Implementation of AccountStoreI.getSpendAddress
- Defined in packages/runtime/src/account.ts:109

modifyAsset

modifyAsset(assetId: number, fields: AssetModFields): void
Modifies Asset fields
Parameters
- assetId: number
  
  Asset Index
- fields: AssetModFields
  
  Fields for modification
Returns void
Implementation of AccountStoreI.modifyAsset
- Defined in packages/runtime/src/account.ts:261

optInToASA

optInToASA(assetIndex: number, assetHolding: AssetHoldingM): void
Parameters
- assetIndex: number
- assetHolding: AssetHoldingM
Returns void
Implementation of AccountStoreI.optInToASA
- Defined in packages/runtime/src/account.ts:362

optInToApp

optInToApp(appID: number, appParams: SSCAttributesM): void
Parameters
- appID: number
- appParams: SSCAttributesM
Returns void
Implementation of AccountStoreI.optInToApp
- Defined in packages/runtime/src/account.ts:340

rekeyTo

rekeyTo(authAccountAddress: string): void
Parameters
- authAccountAddress: string
Returns void
Implementation of AccountStoreI.rekeyTo
- Defined in packages/runtime/src/account.ts:104

setFreezeState

setFreezeState(assetId: number, state: boolean): void
Freeze asset

State
new freeze state
Parameters
- assetId: number
  
  Asset Index
- state: boolean
Returns void
Implementation of AccountStoreI.setFreezeState
- Defined in packages/runtime/src/account.ts:292

setGlobalState

setGlobalState(appID: number, key: string | Uint8Array, value: StackElem, line?: number): void
Updates app global state. Throws error if app is not found.
Parameters
- appID: number
- key: string | Uint8Array
- value: StackElem
- Optional line: number
Returns void
Implementation of AccountStoreI.setGlobalState
- Defined in packages/runtime/src/account.ts:180

setLocalState

setLocalState(appID: number, key: string | Uint8Array, value: StackElem, line?: number): AppLocalStateM
Set new key-value pair or update pair with existing key in account for application id: appID, throw error otherwise
Parameters
- appID: number
- key: string | Uint8Array
- value: StackElem
- Optional line: number
  
  line number in TEAL file Note: if user is accessing this function directly through runtime, then line number is unknown
Returns AppLocalStateM
Implementation of AccountStoreI.setLocalState
- Defined in packages/runtime/src/account.ts:136

Class AccountStore

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

balance: number | bigint

Optional account: string | default

Returns AccountStore

Properties

Readonly account

Readonly address

amount

appsLocalState

appsTotalSchema

assets

createdApps

createdAssets

minBalance

Methods

addApp

Parameters

appID: number

appDefinition: AppDefinitionFromSource

Returns CreatedAppM

addAsset

Parameters

assetId: number

name: string

Optional clawback?: string

decimals: number | bigint

Optional defaultFrozen?: boolean

Optional freeze?: string

Optional manager?: string

Optional metadataHash?: string | Uint8Array | Buffer

Optional name?: string

Optional note?: string

Optional noteb64?: string

Optional optInAccNames?: string[]

Optional reserve?: string

total: string | number | bigint

Optional unitName?: string

Optional url?: string

Returns AssetParams

balance

Returns bigint

closeApp

Parameters

appID: number

Returns void

closeAsset

Parameters

assetId: number

Returns void

deleteApp

Parameters

appID: number

Returns void

destroyAsset

Parameters

assetId: number

Returns void

getApp

Parameters

appID: number

Returns undefined | SSCAttributesM

getAppFromLocal

Parameters

appID: number

Returns undefined | AppLocalStateM

getAssetDef

Parameters

assetId: number

Returns undefined | AssetParams

getAssetHolding

Parameters

`Optional` account: string | default

`Readonly` account

`Readonly` address

`Optional` clawback?: string

`Optional` defaultFrozen?: boolean

`Optional` freeze?: string

`Optional` manager?: string

`Optional` metadataHash?: string | Uint8Array | Buffer

`Optional` name?: string

`Optional` note?: string

`Optional` noteb64?: string

`Optional` optInAccNames?: string[]

`Optional` reserve?: string

`Optional` unitName?: string

`Optional` url?: string

`Optional` line: number

`Optional` line: number