Skip to main content
Version: 2.0.0

custom_protocol

CustomProtocolInterface Objects​

class CustomProtocolInterface(ABC)

CustomProtocolInterface The CustomProtocolInterface is used to create a custom protocol for the simulation

__init__​

@abstractmethod
def __init__(contracts: list[ContractInterface], tokens: list[TokenInterface],
             settings: dict, metric_helper: MetricHelperInterface)

Initialize the custom protocol

Arguments:

  • contracts List[ContractInterface] - Contracts to be used in the protocol, specified in the configuration
  • tokens List[TokenInterface] - Tokens to be used in the protocol, all tokens for the environment will be passed
  • settings dict - Settings for the protocol, specified in the configuration
  • metric_helper MetricHelperInterface - MetricHelper to be used for the protocol to log metrics

initialize​

@abstractmethod
def initialize(agent_addresses: list[str])

Initialize the custom protocol

Arguments:

  • agent_addresses List[str] - List of agent addresses that will be using the protocol