SuperStarter

Python class corresponding to the GridWorks type super.starter.000 (VersionedTypeName).

class gridworks.types.SuperStarter(*, SupervisorContainer, GniList, AliasWithKeyList, KeyList, TypeName='super.starter', Version='000')

Used by world to seed a docker container with data needed to spawn and superviser GNodeInstances

Parameters:

  • SupervisorContainer (SupervisorContainerGt) –

  • GniList (List[GNodeInstanceGt]) –

  • AliasWithKeyList (List[str]) –

  • KeyList (List[str]) –

  • TypeName (Literal['super.starter']) –

  • Version (str) –

SupervisorContainer:

  • Description: Key data about the docker container

GniList:

  • Description: List of GNodeInstances (Gnis) run in the container

AliasWithKeyList:

  • Description: Aliases of Gnis that own Algorand secret keys

  • Format: LeftRightDot

KeyList:

  • Description: Algorand secret keys owned by Gnis

class gridworks.types.super_starter.check_is_left_right_dot(v)

LeftRightDot format: Lowercase alphanumeric words separated by periods, most significant word (on the left) starting with an alphabet character.

Raises:

ValueError – if not LeftRightDot format

Parameters:

v (str) –

class gridworks.types.SuperStarter_Maker(supervisor_container, gni_list, alias_with_key_list, key_list)
Parameters:
classmethod tuple_to_type(tuple)

Given a Python class object, returns the serialized JSON type object

Parameters:

tuple (SuperStarter) –

Return type:

str

classmethod type_to_tuple(t)

Given a serialized JSON type object, returns the Python class object

Parameters:

t (str) –

Return type:

SuperStarter