DispatchContractConfirmed

Python pydantic class corresponding to json type `dispatch.contract.confirmed`.

class gwatn.types.DispatchContractConfirmed(*, FromGNodeAlias, FromGNodeInstanceId, AtnParamsTypeName, SignedProof, Params, TypeName='dispatch.contract.confirmed', Version='000')

Message sent from AtomicTNode back to SCADA via Rabbit .

Paired with join.dispatch.contract. Sent from AtomicTNode back to SCADA once the AtomicTNode has successfully finished bootstrapping the Dispatch Contract and opted in. Once it has done this, the Dispatch Contract is ready

to collect audit information about heartbeats, dispatch, energy and power.

https://gridworks.readthedocs.io/en/latest/dispatch-contract.html

Parameters:

  • FromGNodeAlias (str) –

  • FromGNodeInstanceId (str) –

  • AtnParamsTypeName (str) –

  • SignedProof (str) –

  • Params (AtnParams) –

  • TypeName (Literal['dispatch.contract.confirmed']) –

  • Version (str) –

classmethod check_axiom_1(v)

Axiom 1: AtnParamsTypeName matches AtnParams. AtnParams must have

Parameters:

v (dict) –

Return type:

dict

FromGNodeAlias:

  • Description:

  • Format: LeftRightDot

FromGNodeInstanceId:

  • Description:

  • Format: UuidCanonicalTextual

AtnParamsTypeName:

  • Description:

  • Format: LeftRightDot

SignedProof:

  • Description:

  • Format: AlgoMsgPackEncoded

Params:

  • Description:

class gwatn.types.dispatch_contract_confirmed.check_is_uuid_canonical_textual(v)

UuidCanonicalTextual format: A string of hex words separated by hyphens of length 8-4-4-4-12.

Raises:

ValueError – if not UuidCanonicalTextual format

Parameters:

v (str) –

class gwatn.types.dispatch_contract_confirmed.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 gwatn.types.dispatch_contract_confirmed.check_is_algo_msg_pack_encoded(v)

AlgoMSgPackEncoded format: the format of an transaction sent to the Algorand blockchain.

Raises:

ValueError – if not AlgoMSgPackEncoded format

Parameters:

v (str) –

class gwatn.types.DispatchContractConfirmed_Maker(from_g_node_alias, from_g_node_instance_id, atn_params_type_name, signed_proof, params)
Parameters:

  • from_g_node_alias (str) –

  • from_g_node_instance_id (str) –

  • atn_params_type_name (str) –

  • signed_proof (str) –

  • params (AtnParams) –

classmethod tuple_to_type(tuple)

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

Parameters:

tuple (DispatchContractConfirmed) –

Return type:

str

classmethod type_to_tuple(t)

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

Parameters:

t (str) –

Return type:

DispatchContractConfirmed