Class Runtime

Hierarchy

Runtime

Index

Constructors

constructor

new Runtime(accounts: AccountStoreI[]): Runtime
Parameters
- accounts: AccountStoreI[]
Returns Runtime
- Defined in packages/runtime/src/runtime.ts:79

Properties

ctx

ctx: Context

loadedAssetsDefs

loadedAssetsDefs: Record<string, {
    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;
}>

`Optional` parentCtx

parentCtx?: Context

Accessors

defaultBalance

get defaultBalance(): number
Returns number
- Defined in packages/runtime/src/runtime.ts:110

Methods

_setupDefaultAccounts

_setupDefaultAccounts(): AccountStore[]
Returns a list of initialized default accounts created using static accountSDK from account.ts and funded with default balance (100 ALGO)

Returns
list of AccountStore

Returns AccountStore[]
- Defined in packages/runtime/src/runtime.ts:119

addCtxAppCreateTxn

addCtxAppCreateTxn(creator: default, appDef: AppDefinition, payFlags: TxParams): void
Parameters
- creator: default
- appDef: AppDefinition
- payFlags: TxParams
Returns void
- Defined in packages/runtime/src/runtime.ts:608

addCtxAppUpdateTx

addCtxAppUpdateTx(senderAddr: string, appID: number, payFlags: TxParams, flags: AppOptionalFlags): void
Parameters
- senderAddr: string
- appID: number
- payFlags: TxParams
- flags: AppOptionalFlags
Returns void
- Defined in packages/runtime/src/runtime.ts:713

addCtxOptInTx

addCtxOptInTx(senderAddr: string, appID: number, payFlags: TxParams, flags: AppOptionalFlags): void
Parameters
- senderAddr: string
- appID: number
- payFlags: TxParams
- flags: AppOptionalFlags
Returns void
- Defined in packages/runtime/src/runtime.ts:663

assertAccountDefined

assertAccountDefined(address: string, a?: AccountStoreI, line?: number): AccountStoreI
asserts if account is defined.
Parameters
- address: string
  
  address
- Optional a: AccountStoreI
  
  account
- Optional line: number
  
  line number in TEAL file Note: if user is accessing this function directly through runtime, the line number is unknown
Returns AccountStoreI
- Defined in packages/runtime/src/runtime.ts:159

assertAddressDefined

assertAddressDefined(addr: undefined | string, line?: number): string
asserts if account address is defined
Parameters
- addr: undefined | string
  
  account address
- Optional line: number
  
  line number in TEAL file Note: if user is accessing this function directly through runtime, the line number is unknown
Returns string
- Defined in packages/runtime/src/runtime.ts:183

assertAppDefined

assertAppDefined(appID: number, app?: SSCAttributesM, line?: number): SSCAttributesM
asserts if application exists in state
Parameters
- appID: number
  
  application index
- Optional app: SSCAttributesM
  
  application
- Optional line: number
  
  line number in TEAL file Note: if user is accessing this function directly through runtime, the line number is unknown
Returns SSCAttributesM
- Defined in packages/runtime/src/runtime.ts:202

assertAssetDefined

assertAssetDefined(assetId: number, assetDef?: AssetParams, line?: number): AssetParams
asserts if asset exists in state
Parameters
- assetId: number
  
  asset index
- Optional assetDef: AssetParams
  
  asset definitions
- Optional line: number
  
  line number Note: if user is accessing this function directly through runtime, the line number is unknown
Returns AssetParams
- Defined in packages/runtime/src/runtime.ts:221

assertMinBalance

assertMinBalance(amt: bigint, address: string): void
Parameters
- amt: bigint
- address: string
Returns void
- Defined in packages/runtime/src/runtime.ts:772

assertNoDuplicateTransaction

assertNoDuplicateTransaction(gtxns: EncTx[]): void
Ensure no duplicate transaction in group txn
Parameters
- gtxns: EncTx[]
  
  group transaction
Returns void
- Defined in packages/runtime/src/runtime.ts:257

createLsigAccount

createLsigAccount(program: string, args: Uint8Array[]): LogicSigAccount
Creates a new account with logic signature and smart contract arguments in the runtime store. The arguments are used when we send a transaction with this account and verify it.

Returns
logic signature with arguments.
Parameters
- program: string
  
  TEAL code
- args: Uint8Array[]
  
  arguments passed
Returns LogicSigAccount
- Defined in packages/runtime/src/runtime.ts:829

createTxnContext

createTxnContext(txnParams: ExecParams[]): [SignedTransaction, SignedTransaction[]]
Creates new transaction object (tx, gtxs) from given txnParams and signes it
Parameters
- txnParams: ExecParams[]
  
  : Transaction parameters for current txn or txn Group @returns: [current SignedTransaction, SignedTransaction group]
Returns [SignedTransaction, SignedTransaction[]]
- Defined in packages/runtime/src/runtime.ts:467

defaultAccounts

defaultAccounts(): AccountStore[]
Getter for _defaultAccounts, returns a synced version of the accounts list

Returns
list of AccountStore

Returns AccountStore[]
- Defined in packages/runtime/src/runtime.ts:139

deployASA

deployASA(asa: string, flags: ASADeploymentFlags): ASAInfo
Deploy Asset in Runtime using asa.yaml
Parameters
- asa: string
  
  ASA name
- flags: ASADeploymentFlags
  
  ASA Deployment Flags
Returns ASAInfo
- Defined in packages/runtime/src/runtime.ts:539

deployASADef

deployASADef(asa: 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;
}, flags: ASADeploymentFlags): ASAInfo
Deploy Asset in Runtime without using asa.yaml
Parameters
- asa: string
  
  ASA 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;
  }
  - 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
- flags: ASADeploymentFlags
  
  ASA Deployment Flags
Returns ASAInfo
- Defined in packages/runtime/src/runtime.ts:552

deployApp

deployApp(sender: default, appDefinition: AppDefinition, payFlags: TxParams, scTmplParams?: SCParams, debugStack?: number): AppInfo
deploy a new application and returns application id
Parameters
- sender: default
- appDefinition: AppDefinition
  
  app definition
- payFlags: TxParams
  
  Transaction parameters
- Optional scTmplParams: SCParams
  
  Smart Contract template parameters
- Optional debugStack: number
Returns AppInfo
- Defined in packages/runtime/src/runtime.ts:646

executeTx

executeTx(txnParams: SignedTransaction[] | ExecParams[], debugStack?: number): TxnReceipt[]
This function executes a transaction based on a smart contract logic and updates state afterwards Check out https://algobuilder.dev/guide/execute-transaction.html#execute-transaction|execute-transaction for more info.
Parameters
- txnParams: SignedTransaction[] | ExecParams[]
  
  : Transaction parameters
- Optional debugStack: number
Returns TxnReceipt[]
- Defined in packages/runtime/src/runtime.ts:913

fundLsig

fundLsig(from: RuntimeAccountI, to: string, amount: number): TxnReceipt
Transfers amount of microAlgos from from address to to address
Parameters
- from: RuntimeAccountI
  
  From account
- to: string
  
  to address
- amount: number
  
  amount of algo in microalgos
Returns TxnReceipt
- Defined in packages/runtime/src/runtime.ts:847

getAccount

getAccount(address: string): AccountStoreI
Fetches account from this.store
Parameters
- address: string
  
  account address
Returns AccountStoreI
- Defined in packages/runtime/src/runtime.ts:310

getApp

getApp(appID: number): SSCAttributesM
Fetches app from this.store
Parameters
- appID: number
  
  Application Index
Returns SSCAttributesM
- Defined in packages/runtime/src/runtime.ts:294

getAppByName

getAppByName(appName: string): undefined | AppInfo
Queries app id by app name from global state. Returns undefined if app is not found.
Parameters
- appName: string
Returns undefined | AppInfo
- Defined in packages/runtime/src/runtime.ts:399

getAppInfoFromName

getAppInfoFromName(approval: string, clear: string): undefined | AppInfo
Queries app id by app name from global state. Returns undefined if app is not found. https://www.pivotaltracker.com/story/show/180142720
Parameters
- approval: string
- clear: string
Returns undefined | AppInfo
- Defined in packages/runtime/src/runtime.ts:390

getAssetAccount

getAssetAccount(assetId: number): AccountStoreI
Returns asset creator account or throws error is it doesn't exist
Parameters
- assetId: number
  
  Index
Returns AccountStoreI
- Defined in packages/runtime/src/runtime.ts:356

getAssetDef

getAssetDef(assetId: number): AssetParams
Returns Asset Definitions
Parameters
- assetId: number
  
  Asset Index
Returns AssetParams
- Defined in packages/runtime/src/runtime.ts:368

getAssetHolding

getAssetHolding(assetIndex: number, address: string): AssetHoldingM
Returns Asset Holding from an account
Parameters
- assetIndex: number
  
  Asset Index
- address: string
  
  address of account to get holding from
Returns AssetHoldingM
- Defined in packages/runtime/src/runtime.ts:595

getAssetInfoFromName

getAssetInfoFromName(name: string): undefined | ASAInfo
Queries asset id by asset name from global state. Returns undefined if asset is not found.
Parameters
- name: string
  
  Asset name
Returns undefined | ASAInfo
- Defined in packages/runtime/src/runtime.ts:379

getBlock

getBlock(round: number): Block
Returns a requested Block object. If it does not exist on chain throws an error

Returns
Block
Parameters
- round: number
  
  block number
Returns Block
- Defined in packages/runtime/src/runtime.ts:1276

getEncodedGroupTxns

getEncodedGroupTxns(signedTransactions: SignedTransaction[]): EncTx[]
Creates a group transaction array

Returns
groupTransactions array of EncTx type
Parameters
- signedTransactions: SignedTransaction[]
  
  : teal code as string
Returns EncTx[]
- Defined in packages/runtime/src/runtime.ts:1044

getGlobalState

getGlobalState(appID: number, key: string | Uint8Array): undefined | StackElem
Fetches global state value for key present in creator's global state for given appID, returns undefined otherwise
Parameters
- appID: number
- key: string | Uint8Array
Returns undefined | StackElem
- Defined in packages/runtime/src/runtime.ts:321

getLocalState

getLocalState(appID: number, accountAddr: string, key: string | Uint8Array): undefined | StackElem
Fetches local state for account address and application index
Parameters
- appID: number
  
  application index
- accountAddr: string
  
  address for which local state needs to be retrieved
- key: string | Uint8Array
Returns undefined | StackElem
- Defined in packages/runtime/src/runtime.ts:339

getRound

getRound(): number
Return current round

Returns number
- Defined in packages/runtime/src/runtime.ts:279

getTimestamp

getTimestamp(): number
Return current timestamp

Returns number
- Defined in packages/runtime/src/runtime.ts:286

getTxReceipt

getTxReceipt(txID: string): undefined | TxReceipt
Returns transaction receipt for a particular transaction
Parameters
- txID: string
  
  transaction ID
Returns undefined | TxReceipt
- Defined in packages/runtime/src/runtime.ts:147

initializeAccounts

initializeAccounts(accounts: AccountStoreI[]): void
Setup initial accounts as {address: SDKAccount}. This should be called only when initializing Runtime.
Parameters
- accounts: AccountStoreI[]
Returns void
- Defined in packages/runtime/src/runtime.ts:407

loadAccountsFromConfig

loadAccountsFromConfig(network?: string, balance?: number): void
Add accounts from config file to the Store
Parameters
- network: string = NETWORK_DEFAULT
- Optional balance: number
Returns void
- Defined in packages/runtime/src/runtime.ts:435

loadLogic

loadLogic(fileName: string, scTmplParams?: SCParams, logs?: boolean): LogicSigAccount
Loads logic signature for contract mode, creates a new runtime account associated with lsig

Returns
loaded logic signature from assets/.teal
Parameters
- fileName: string
  
  ASC filename
- Optional scTmplParams: SCParams
- logs: boolean = true
  
  only show logs on console when set as true. By default this value is true
Returns LogicSigAccount
- Defined in packages/runtime/src/runtime.ts:816

makeAndSignTx

makeAndSignTx(execParams: ExecParams[], txParams: SuggestedParams, signer: default): SignedTransaction[]
Creates an algosdk.Transaction object based on execParams and suggestedParams and signs it using provided signer account

Returns
array of algosdk.SignedTransaction objects
Parameters
- execParams: ExecParams[]
  
  execParams containing all txn info
- txParams: SuggestedParams
  
  suggestedParams object
- signer: default
  
  account object that signes the transaction
Returns SignedTransaction[]
- Defined in packages/runtime/src/runtime.ts:1212

makeTx

makeTx(execParams: ExecParams[], txParams: SuggestedParams): Transaction[]
Creates an algosdk.Transaction object based on execParams and suggestedParams

Returns
array of algosdk.Transaction objects
Parameters
- execParams: ExecParams[]
  
  execParams containing all txn info
- txParams: SuggestedParams
  
  suggestedParams object
Returns Transaction[]
- Defined in packages/runtime/src/runtime.ts:1185

mkAssetCreateTx

mkAssetCreateTx(name: string, flags: ASADeploymentFlags, asaDef: AssetParams): void
Creates new asset creation transaction object.
Parameters
- name: string
  
  : asset name
- flags: ASADeploymentFlags
- asaDef: AssetParams
Returns void
- Defined in packages/runtime/src/runtime.ts:505

optInToASA

optInToASA(assetIndex: number, address: string, flags: TxParams): TxReceipt
Asset Opt-In for account in Runtime
Parameters
- assetIndex: number
  
  Asset Index
- address: string
  
  Account address to opt-into asset
- flags: TxParams
  
  Transaction Parameters
Returns TxReceipt
- Defined in packages/runtime/src/runtime.ts:583

optInToASAMultiple

optInToASAMultiple(assetID: number, accounts?: string[]): void
Opt-In to all accounts given in asa.yaml to a specific asset.
Parameters
- assetID: number
  
  Asset Index
- Optional accounts: string[]
  
  list account opt to asa
Returns void
- Defined in packages/runtime/src/runtime.ts:565

optInToApp

optInToApp(accountAddr: string, appID: number, flags: AppOptionalFlags, payFlags: TxParams, debugStack?: number): TxReceipt
Account address opt-in for application Id
Parameters
- accountAddr: string
  
  Account address
- appID: number
  
  Application Id
- flags: AppOptionalFlags
  
  Stateful smart contract transaction optional parameters (accounts, args..)
- payFlags: TxParams
  
  Transaction Parameters
- Optional debugStack: number
Returns TxReceipt
- Defined in packages/runtime/src/runtime.ts:696

parseABIContractFile

parseABIContractFile(pathToFile: string): ABIContract
Parses the file and return the ABIContract. If the appID for runtime is specified it will be added to the returned object

Retun
parsed file
Parameters
- pathToFile: string
  
  string
Returns ABIContract
- Defined in packages/runtime/src/runtime.ts:1238

produceBlocks

produceBlocks(numberOfBlocks?: number): void
Produces N new blocks. If not arguments passed N = 1 by default
Parameters
- numberOfBlocks: number = 1
  
  current round number
Returns void
- Defined in packages/runtime/src/runtime.ts:1288

resetDefaultAccounts

resetDefaultAccounts(): void
Resets the state of the default accounts

Returns void
- Defined in packages/runtime/src/runtime.ts:131

run

run(program: string, executionMode: ExecutionMode, indexInGroup: number, debugStack?: number): TxReceipt
This function executes TEAL code line by line
Parameters
- program: string
  
  : teal code as string
- executionMode: ExecutionMode
  
  : execution Mode (Stateless or Stateful)
- indexInGroup: number
- Optional debugStack: number
Returns TxReceipt
- Defined in packages/runtime/src/runtime.ts:1013

sendSignedTransaction

sendSignedTransaction(signedTransaction: SignedTransaction): TxReceipt[]
Sends a SignedTransaction object

Returns
const txReceipts = this.ctx.processTransactions(signedTransactions, appDefMap, lsigMap);
Parameters
- signedTransaction: SignedTransaction
Returns TxReceipt[]
- Defined in packages/runtime/src/runtime.ts:1059

sendTxAndWait

sendTxAndWait(transactions: SignedTransaction[]): TxnReceipt[]
Sends signedTransaction and waits for the response

Returns
TxnReceipt which includes confirmed txn response along with txID
Parameters
- transactions: SignedTransaction[]
  
  array of signedTransaction objects.
Returns TxnReceipt[]
- Defined in packages/runtime/src/runtime.ts:1228

setRoundAndTimestamp

setRoundAndTimestamp(r: number, timestamp: number): void
set current round with timestamp for a block
Parameters
- r: number
  
  current round
- timestamp: number
  
  block's timestamp
Returns void
- Defined in packages/runtime/src/runtime.ts:271

signTx

signTx(transaction: Transaction, signer: default): SignedTransaction
Signes a Transaction object with the provided account

Returns
SignedTransaction
Parameters
- transaction: Transaction
  
  transaction object.
- signer: default
  
  account object that signes the transaction
Returns SignedTransaction
- Defined in packages/runtime/src/runtime.ts:1199

updateApp

updateApp(appName: string, senderAddr: string, appID: number, newAppCode: SmartContract, payFlags: TxParams, flags: AppOptionalFlags, scTmplParams?: SCParams, debugStack?: number): TxReceipt
Update application
Parameters
- appName: string
  
  application Name. Note in runtime application name just placeholder params
- senderAddr: string
  
  sender address
- appID: number
  
  application Id
- newAppCode: SmartContract
  
  new application source code
- payFlags: TxParams
  
  Transaction parameters
- flags: AppOptionalFlags
  
  Stateful smart contract transaction optional parameters (accounts, args..)
- Optional scTmplParams: SCParams
- Optional debugStack: number
Returns TxReceipt
- Defined in packages/runtime/src/runtime.ts:750

validateAccountSignature

validateAccountSignature(txParam: ExecParams): void
Validate signature for Algorand account on transaction params. Include check spending account when creating a transaction from Algorand account Throw RuntimeError if signature is invalid.
Parameters
- txParam: ExecParams
  
  transaction parameters.
Returns void
- Defined in packages/runtime/src/runtime.ts:788

validateExtraPages

validateExtraPages(extraPages?: number): void
Verifies extra pages do not exceed the limit
Parameters
- extraPages: number = 0
  
  extra pages for program. Default value is 0
Returns void
- Defined in packages/runtime/src/runtime.ts:1116

validateLsigAndRun

validateLsigAndRun(txnParam: SignWithLsig, debugStack?: number): TxReceipt
validate logic signature and teal logic
Parameters
- txnParam: SignWithLsig
  
  Transaction Parameters
- Optional debugStack: number
Returns TxReceipt
- Defined in packages/runtime/src/runtime.ts:865

validateMultisignature

validateMultisignature(signedTransaction: SignedTransaction): void
Verifies multi-signature and throws an error if signatures are not valid
Parameters
- signedTransaction: SignedTransaction
  
  signedTransaction object
Returns void
- Defined in packages/runtime/src/runtime.ts:1105

validateSecretKeySignature

validateSecretKeySignature(signedTransaction: SignedTransaction): void
Validate signature for Algorand account on transaction params. Include check spending account when creating a transaction from Algorand account Throw RuntimeError if signature is invalid.
Parameters
- signedTransaction: SignedTransaction
  
  signedTransaction object.
Returns void
- Defined in packages/runtime/src/runtime.ts:1077

validateTxRound

validateTxRound(gtxns: EncTx[]): void
Validate first and last rounds of transaction using current round
Parameters
- gtxns: EncTx[]
  
  transactions
Returns void
- Defined in packages/runtime/src/runtime.ts:240

verifyMultisig

verifyMultisig(signedTxn: SignedTransaction): boolean
Verify multi-signature
Parameters
- signedTxn: SignedTransaction
  
  signedTransaction object
Returns boolean
- Defined in packages/runtime/src/runtime.ts:1130

Class Runtime

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

accounts: AccountStoreI[]

Returns Runtime

Properties

ctx

loadedAssetsDefs

Optional parentCtx

Accessors

defaultBalance

Returns number

Methods

_setupDefaultAccounts

Returns

Returns AccountStore[]

addCtxAppCreateTxn

Parameters

creator: default

appDef: AppDefinition

payFlags: TxParams

Returns void

addCtxAppUpdateTx

Parameters

senderAddr: string

appID: number

payFlags: TxParams

flags: AppOptionalFlags

Returns void

addCtxOptInTx

Parameters

senderAddr: string

appID: number

payFlags: TxParams

flags: AppOptionalFlags

Returns void

assertAccountDefined

Parameters

address: string

Optional a: AccountStoreI

Optional line: number

Returns AccountStoreI

assertAddressDefined

Parameters

addr: undefined | string

Optional line: number

Returns string

assertAppDefined

Parameters

appID: number

Optional app: SSCAttributesM

Optional line: number

Returns SSCAttributesM

assertAssetDefined

Parameters

assetId: number

Optional assetDef: AssetParams

Optional line: number

Returns AssetParams

assertMinBalance

Parameters

amt: bigint

address: string

Returns void

assertNoDuplicateTransaction

Parameters

gtxns: EncTx[]

Returns void

createLsigAccount

Returns

Parameters

program: string

args: Uint8Array[]

`Optional` parentCtx

`Optional` a: AccountStoreI

`Optional` line: number

`Optional` line: number

`Optional` app: SSCAttributesM

`Optional` line: number

`Optional` assetDef: AssetParams

`Optional` line: number

`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` scTmplParams: SCParams

`Optional` debugStack: number

`Optional` debugStack: number