tryorama.scenario.md

Home > @holochain/tryorama > Scenario

Scenario class

An abstraction of a test scenario to write tests against Holochain hApps, running on a local conductor.

Signature:

export declare class Scenario 

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Scenario constructor.

Properties

Property	Modifiers	Type	Description
bootstrapServerUrl		URL | undefined
conductors		Conductor[]
dpkiNetworkSeed		string
networkSeed		string
noDpki		boolean
serviceProcess		ChildProcessWithoutNullStreams | undefined
signalingServerUrl		URL | undefined

Methods

Method	Modifiers	Description
addConductor()		Create and add a conductor to the scenario.
addPlayersWithApps(playersApps)		Create and add multiple players to the scenario, with an app installed for each player.
addPlayerWithApp(appBundleSource, options)		Create and add a single player with an app installed to the scenario.
cleanUp()		Shut down and delete all conductors in the scenario.
shareAllAgents()		Register all agents of all passed in conductors to each other. This skips peer discovery through gossip and thus accelerates test runs.
shutDown()		Shut down all conductors in the scenario.