nqs_sdk.coding_envs.protocols.coding_protocol module

class nqs_sdk.coding_envs.protocols.coding_protocol.CodingProtocol(protocol)[source]

Bases: ABC

__init__(protocol)[source]
abstractmethod id()[source]

Returns the id of the protocol

Return type:

str

abstractmethod get_protocol_factory()[source]

Returns the protocol factory

Return type:

Optional[ProtocolMetaFactory]

abstractmethod get_protocol_description()[source]

Returns the description of the protocol, the market description and the coding interface

Return type:

tuple[str, str, list[str]]

abstractmethod get_tx_generators()[source]

Returns the list of all tx generators

Return type:

list[TxGenerator]

abstractmethod get_observables_names()[source]

Returns the list of all observables names

Return type:

list[str]

get_transactions()[source]
Return type:

dict[str, list[Transaction]]

clear_transactions()[source]
Return type:

None

register_transaction(agent_name, transaction)[source]
Return type:

None

set_all_agents(all_agents)[source]
Return type:

None

set_current_agent(agent)[source]
Return type:

None

set_current_block(block)[source]
Return type:

None

set_current_time(time)[source]
Return type:

None

update_observables(observables)[source]
Return type:

None