The Kurtosis Engine server
This documentation describes how to interact with the Kurtosis API from within a testnet. It includes information about starting services, stopping services, repartitioning the network, etc. These objects are particularly useful for writing tests, where pre-test setup involves creating an enclave. Note that any comments specific to a language implementation will be found in the code comments.
Found a bug? File it on the repo!
A connection to a Kurtosis engine, used for manipulating enclaves.
Creates a new Kurtosis enclave using the given parameters.
Args
enclaveId
: The ID to give the new enclave.isPartitioningEnabled
: If set to true, the enclave will be set up to allow for repartitioning. This will make service addition & removal take slightly longer, but allow for calls to EnclaveContext.repartitionNetwork.Returns
enclaveContext
: An EnclaveContext object representing the new enclave.Gets the EnclaveContext object for the given enclave ID.
Args
enclaveId
: The ID of the enclave to retrieve the context for.Returns
enclaveContext
: The EnclaveContext representation of the enclave.Gets the IDs of the enclaves that the Kurtosis engine knows about.
Returns
enclaveIds
: A set of the enclave IDs that the Kurtosis is aware of.Stops the enclave with the given ID, but doesn’t destroy the enclave objects (containers, networks, etc.) so they can be further examined.
NOTE: Any EnclaveContext objects representing the stopped enclave will become unusable.
Args
enclaveId
: ID of the enclave to stop.Stops the enclave with the given ID and destroys the enclave objects (containers, networks, etc.).
NOTE: Any EnclaveContext objects representing the stopped enclave will become unusable.
Args
enclaveId
: ID of the enclave to destroy.Destroys enclaves in the Kurtosis engine.
Args
shouldCleanAll
: If set to true, destroys running enclaves in addition to stopped ones.Returns
RemovedEnclaveIds
: A set of the removed enclave IDs.Found a bug? File it on the repo!