TestEnvironment
For the complete documentation index, see llms.txt
@midnight-ntwrk/testkit-js v4.0.4
Abstract base class for test environments. Provides common functionality for managing test wallets and environments.
Extended by
Constructors
Constructor
new TestEnvironment(
logger):TestEnvironment
Creates a new TestEnvironment instance.
Parameters
logger
Logger
Logger instance for recording operations
Returns
TestEnvironment
Methods
getEnvironmentConfiguration()
abstractgetEnvironmentConfiguration():EnvironmentConfiguration
Returns
getMidnightWalletProvider()
getMidnightWalletProvider():
Promise<MidnightWalletProvider>
Starts a single wallet instance.
Returns
Promise<MidnightWalletProvider>
A promise that resolves to the started wallet
Throws
If no wallet could be started
shutdown()
abstractshutdown(saveWalletState?):Promise<void>
Shuts down the test environment and cleans up resources.
Parameters
saveWalletState?
boolean
Optional flag to save the wallet state before shutdown
Returns
Promise<void>
A promise that resolves when shutdown is complete
start()
abstractstart(maybeProofServerContainer?):Promise<EnvironmentConfiguration>
Start the test environment.
Parameters
maybeProofServerContainer?
If defined, a container representing an already running proof server. If undefined, a proof server will be started automatically.
Returns
Promise<EnvironmentConfiguration>
A promise that resolves to the environment configuration
startMidnightWalletProviders()
abstractstartMidnightWalletProviders(amount?,seeds?):Promise<MidnightWalletProvider[]>
Starts multiple wallet instances.
Parameters
amount?
number
Optional number of wallet instances to start
seeds?
string[]
Optional array of seeds for the wallets
Returns
Promise<MidnightWalletProvider[]>
A promise that resolves to an array of started wallets