It generates the docker-compose.yaml file from the previously generated configuration.
The config method/command needs to be called before this method
the params of the compose command.
the created preset if you know it, otherwise will load the latest one resolved from the target folder.
the created addresses if you know if, otherwise will load the latest one resolved form the target folder.
It generates the configuration and nemesis for the provided preset
the params of the config command.
It checks if the health of the running services is ok.
the params of the clean command.
It calls a running server announcing all the node transactions like VRF and Voting.
This command is useful to link the nodes keys to an existing running network like testnet.
the params passed
the created preset if you know it, otherwise will load the latest one resolved from the target folder.
the created addresses if you know it, otherwise will load the latest one resolved from the target folder.
It converts main account into multisig account or modifies multisig structure
the params passed
the created preset if you know it, otherwise will load the latest one resolved from the target folder.
the created addresses if you know it, otherwise will load the latest one resolved from the target folder.
It generates reStructuredText (.rst) reports describing the configuration of each node.
The config method/command needs to be called before this method
the params of the report command.
the created preset if you know if, otherwise will load the latest one resolved from the target folder.
the paths of the created reports.
It resets the data keeping generated configuration, block 1, certificates and keys.
the params of the clean command.
It resolves the preset used for preventive configuration.
the params of the config command.
It boots the network via docker using the generated docker-compose.yml file and configuration
The config and compose methods/commands need to be called before this method.
This is just a wrapper for docker-compose up bash call.
the params of the run command.
This method aggregates config, compose and run all in one.
the aggregated params in order to run all the sub commands.
It stops the docker-compose network if running.
This is just a wrapper for docker-compose down bash call.
the params necessary to detect and stop the network.
Generated using TypeDoc
Main entry point for API integration.