AlgorandTestAutomationContext
@algorandfoundation/algokit-utils / types/testing / AlgorandTestAutomationContext
types/testing.AlgorandTestAutomationContext
Test automation context.
Table of contents
Section titled “Table of contents”Properties
Section titled “Properties”- algod
- algorand
- generateAccount
- indexer
- kmd
- testAccount
- transactionLogger
- waitForIndexer
- waitForIndexerTransaction
Properties
Section titled “Properties”• algod: AlgodClient
Algod client instance that will log transactions in transactionLogger
Defined in
Section titled “Defined in”algorand
Section titled “algorand”• algorand: AlgorandClient
An AlgorandClient instance loaded with the current context, including testAccount and any generated accounts loaded as signers
Defined in
Section titled “Defined in”generateAccount
Section titled “generateAccount”• generateAccount: (params: GetTestAccountParams) => Promise<Address & default & TransactionSignerAccount>
Generate and fund an additional ephemerally created account
Type declaration
Section titled “Type declaration”▸ (params): Promise<Address & default & TransactionSignerAccount>
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
params | GetTestAccountParams |
Returns
Section titled “Returns”Promise<Address & default & TransactionSignerAccount>
Defined in
Section titled “Defined in”indexer
Section titled “indexer”• indexer: IndexerClient
Indexer client instance
Defined in
Section titled “Defined in”• kmd: KmdClient
KMD client instance
Defined in
Section titled “Defined in”testAccount
Section titled “testAccount”• testAccount: Address & TransactionSignerAccount & default
Default, funded test account that is ephemerally created
Defined in
Section titled “Defined in”transactionLogger
Section titled “transactionLogger”• transactionLogger: TransactionLogger
Transaction logger that will log transaction IDs for all transactions issued by algod
Defined in
Section titled “Defined in”waitForIndexer
Section titled “waitForIndexer”• waitForIndexer: () => Promise<void>
Wait for the indexer to catch up with all transactions logged by transactionLogger
Type declaration
Section titled “Type declaration”▸ (): Promise<void>
Returns
Section titled “Returns”Promise<void>
Defined in
Section titled “Defined in”waitForIndexerTransaction
Section titled “waitForIndexerTransaction”• waitForIndexerTransaction: (transactionId: string) => Promise<TransactionResponse>
Wait for the indexer to catch up with the given transaction ID
Type declaration
Section titled “Type declaration”▸ (transactionId): Promise<TransactionResponse>
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
transactionId | string |
Returns
Section titled “Returns”Promise<TransactionResponse>