TestExecutionContext
Defined in: src/test-execution-context.ts:22
The TestExecutionContext class provides a context for executing tests in an Algorand environment.
It manages various contexts such as contract, ledger, and transaction contexts, and provides utilities
for generating values, managing accounts, and handling logic signatures.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TestExecutionContext(
defaultSenderAddress?):TestExecutionContext
Defined in: src/test-execution-context.ts:39
Creates an instance of TestExecutionContext.
Parameters
Section titled “Parameters”defaultSenderAddress?
Section titled “defaultSenderAddress?”bytes
The default sender address.
Returns
Section titled “Returns”TestExecutionContext
Accessors
Section titled “Accessors”activeLogicSigArgs
Section titled “activeLogicSigArgs”Get Signature
Section titled “Get Signature”get activeLogicSigArgs():
bytes[]
Defined in: src/test-execution-context.ts:120
Returns the active logic signature arguments.
Returns
Section titled “Returns”bytes[]
Get Signature
Section titled “Get Signature”get any():
ValueGenerator
Defined in: src/test-execution-context.ts:93
Returns the value generator.
Returns
Section titled “Returns”contract
Section titled “contract”Get Signature
Section titled “Get Signature”get contract():
ContractContext
Defined in: src/test-execution-context.ts:66
Returns the contract context.
Returns
Section titled “Returns”ContractContext
defaultSender
Section titled “defaultSender”Get Signature
Section titled “Get Signature”get defaultSender():
Account
Defined in: src/test-execution-context.ts:102
Returns the default sender account.
Returns
Section titled “Returns”Account
Set Signature
Section titled “Set Signature”set defaultSender(
val):void
Defined in: src/test-execution-context.ts:111
Sets the default sender account.
Parameters
Section titled “Parameters”The default sender account.
bytes | Account
Returns
Section titled “Returns”void
ledger
Section titled “ledger”Get Signature
Section titled “Get Signature”get ledger():
LedgerContext
Defined in: src/test-execution-context.ts:75
Returns the ledger context.
Returns
Section titled “Returns”LedgerContext
templateVars
Section titled “templateVars”Get Signature
Section titled “Get Signature”get templateVars():
Record<string,DeliberateAny>
Defined in: src/test-execution-context.ts:129
Returns the template variables.
Returns
Section titled “Returns”Record<string, DeliberateAny>
Get Signature
Section titled “Get Signature”get txn():
TransactionContext
Defined in: src/test-execution-context.ts:84
Returns the transaction context.
Returns
Section titled “Returns”TransactionContext
Methods
Section titled “Methods”addApplicationSpy()
Section titled “addApplicationSpy()”addApplicationSpy<
TContract>(spy):void
Defined in: src/test-execution-context.ts:197
Adds an application spy to the context.
Type Parameters
Section titled “Type Parameters”TContract
Section titled “TContract”TContract extends Contract
Parameters
Section titled “Parameters”ApplicationSpy<TContract>
The application spy to add.
Returns
Section titled “Returns”void
executeLogicSig()
Section titled “executeLogicSig()”executeLogicSig(
logicSig, …args):boolean|uint64
Defined in: src/test-execution-context.ts:140
Executes a logic signature with the given arguments.
Parameters
Section titled “Parameters”logicSig
Section titled “logicSig”LogicSig
The logic signature to execute.
…bytes[]
The arguments for the logic signature.
Returns
Section titled “Returns”boolean | uint64
exportLogs()
Section titled “exportLogs()”exportLogs<
T>(appId, …decoding):DecodedLogs<T>
Defined in: src/test-execution-context.ts:57
Exports logs for a given application ID and decoding.
Type Parameters
Section titled “Type Parameters”T extends LogDecoding[]
Parameters
Section titled “Parameters”uint64
The application ID.
decoding
Section titled “decoding”…T
The log decoding.
Returns
Section titled “Returns”DecodedLogs<T>
getCompiledAppEntry()
Section titled “getCompiledAppEntry()”getCompiledAppEntry(
contract): {key:ConstructorFor<BaseContract>;value:uint64; } |undefined
Defined in: src/test-execution-context.ts:166
Gets a compiled application by contract.
Parameters
Section titled “Parameters”contract
Section titled “contract”ConstructorFor<BaseContract>
The contract class.
Returns
Section titled “Returns”{ key: ConstructorFor<BaseContract>; value: uint64; } | undefined
getCompiledLogicSigEntry()
Section titled “getCompiledLogicSigEntry()”getCompiledLogicSigEntry(
logicsig): {key:ConstructorFor<LogicSig>;value:Account; } |undefined
Defined in: src/test-execution-context.ts:207
Gets a compiled logic signature.
Parameters
Section titled “Parameters”logicsig
Section titled “logicsig”ConstructorFor<LogicSig>
The logic signature class.
Returns
Section titled “Returns”{ key: ConstructorFor<LogicSig>; value: Account; } | undefined
reset()
Section titled “reset()”reset():
void
Defined in: src/test-execution-context.ts:230
Reinitializes the execution context, clearing all state variables and resetting internal components. Invoked between test cases to ensure isolation.
Returns
Section titled “Returns”void
setCompiledApp()
Section titled “setCompiledApp()”setCompiledApp(
c,appId):void
Defined in: src/test-execution-context.ts:176
Sets a compiled application.
Parameters
Section titled “Parameters”ConstructorFor<BaseContract>
The contract class.
uint64
The application ID.
Returns
Section titled “Returns”void
setCompiledLogicSig()
Section titled “setCompiledLogicSig()”setCompiledLogicSig(
c,account):void
Defined in: src/test-execution-context.ts:217
Sets a compiled logic signature.
Parameters
Section titled “Parameters”ConstructorFor<LogicSig>
The logic signature class.
account
Section titled “account”Account
The account associated with the logic signature.
Returns
Section titled “Returns”void
setTemplateVar()
Section titled “setTemplateVar()”setTemplateVar(
name,value,prefix?):void
Defined in: src/test-execution-context.ts:156
Sets a template variable.
Parameters
Section titled “Parameters”string
The name of the template variable.
any
The value of the template variable.
prefix?
Section titled “prefix?”string
The prefix for the template variable.
Returns
Section titled “Returns”void