zecale.cli.command_context.CommandContext Class Reference

Public Member Functions
def	__init__ (self, str aggregator_server=AGGREGATOR_SERVER_ENDPOINT_DEFAULT, str aggregator_config_file=AGGREGATOR_CONFIG_FILE_DEFAULT, str instance_file=INSTANCE_FILE_DEFAULT, Optional[str] eth_network=None, Optional[str] eth_addr=None, Optional[str] eth_private_key=None)
Tuple[str, Optional[bytes]]	get_eth_key_and_address (self)
Any	get_web3 (self)
AggregatorClient	get_aggregator_client (self)
AggregatorConfiguration	get_aggregator_configuration (self)
IZKSnarkProvider	get_nested_snark (self)
IZKSnarkProvider	get_wrapper_snark (self)
Any	get_dispatcher_contract (self)

Public Attributes
	aggregator_server
	aggregator_config_file
	instance_file
	eth_network
	eth_addr
	eth_private_key

Detailed Description

Carries command-independent parameters from top-level command to
sub-commands. Performs some basic operations common to commands, based on
the current context and configuration.

Definition at line 22 of file command_context.py.

Constructor & Destructor Documentation

__init__()

def zecale.cli.command_context.CommandContext.__init__	(		self,
		str	aggregator_server = AGGREGATOR_SERVER_ENDPOINT_DEFAULT,
		str	aggregator_config_file = AGGREGATOR_CONFIG_FILE_DEFAULT,
		str	instance_file = INSTANCE_FILE_DEFAULT,
		Optional[str]	eth_network = None,
		Optional[str]	eth_addr = None,
		Optional[str]	eth_private_key = None
	)

Definition at line 29 of file command_context.py.

    def __init__(
            self,
            aggregator_server: str = AGGREGATOR_SERVER_ENDPOINT_DEFAULT,
            aggregator_config_file: str = AGGREGATOR_CONFIG_FILE_DEFAULT,
            instance_file: str = INSTANCE_FILE_DEFAULT,
            eth_network: Optional[str] = None,
            eth_addr: Optional[str] = None,
            eth_private_key: Optional[str] = None):
        # TODO: Separate nested and wrapper snarks
        self.aggregator_server = aggregator_server
        self.aggregator_config_file = aggregator_config_file
        self.instance_file = instance_file
        self.eth_network = eth_network
        self.eth_addr = eth_addr
        self.eth_private_key = eth_private_key
        self._web3: Optional[Any] = None
        self._aggregator_client: Optional[AggregatorClient] = None
        self._aggregator_config: Optional[AggregatorConfiguration] = None
        self._dispatcher_contract: Optional[DispatcherContract] = None
 

Member Function Documentation

get_aggregator_client()

AggregatorClient zecale.cli.command_context.CommandContext.get_aggregator_client

(

self

)

Return an aggregator client for the appropriate endpoint. Created and
cached when this function is first called.

Definition at line 62 of file command_context.py.

    def get_aggregator_client(self) -> AggregatorClient:
        """
        Return an aggregator client for the appropriate endpoint. Created and
        cached when this function is first called.
        """
        if not self._aggregator_client:
            self._aggregator_client = AggregatorClient(self.aggregator_server)
        return self._aggregator_client
 

Here is the caller graph for this function:

get_aggregator_configuration()

AggregatorConfiguration zecale.cli.command_context.CommandContext.get_aggregator_configuration

(

self

)

Load the AggregatorConfiguration from a file, or request it from the
aggregator server.

Definition at line 71 of file command_context.py.

    def get_aggregator_configuration(self) -> AggregatorConfiguration:
        """
        Load the AggregatorConfiguration from a file, or request it from the
        aggregator server.
        """
        if self._aggregator_config is not None:
            return self._aggregator_config
 
        if exists(self.aggregator_config_file):
            with open(self.aggregator_config_file, "r") as aggregator_config_f:
                try:
                    self._aggregator_config = \
                        AggregatorConfiguration.from_json_dict(
                            json.load(aggregator_config_f))
                    return self._aggregator_config
                except Exception as ex:
                    print(f"removing `{self.aggregator_config_file}`: {ex}.")
                    unlink(self.aggregator_config_file)
 
        aggregator_client = self.get_aggregator_client()
        self._aggregator_config = aggregator_client.get_configuration()
 
        with open(self.aggregator_config_file, "w") as aggregator_config_f:
            json.dump(self._aggregator_config.to_json_dict(), aggregator_config_f)
 
        return self._aggregator_config
 

Here is the call graph for this function:

Here is the caller graph for this function:

get_dispatcher_contract()

Any zecale.cli.command_context.CommandContext.get_dispatcher_contract

(

self

)

Load (and cache) the dispatcher contract instance.

Definition at line 104 of file command_context.py.

    def get_dispatcher_contract(self) -> Any:
        """
        Load (and cache) the dispatcher contract instance.
        """
        if not self._dispatcher_contract:
            with open(self.instance_file, "r") as instance_f:
                instance_dict = json.load(instance_f)
                instance = InstanceDescription.from_json_dict(instance_dict)
            self._dispatcher_contract = DispatcherContract(
                self.get_web3(), instance, self.get_wrapper_snark())
        return self._dispatcher_contract

Here is the call graph for this function:

get_eth_key_and_address()

Tuple[str, Optional[bytes]] zecale.cli.command_context.CommandContext.get_eth_key_and_address

(

self

)

Definition at line 49 of file command_context.py.

    def get_eth_key_and_address(self) -> Tuple[str, Optional[bytes]]:
        return (
            load_eth_address(self.eth_addr),
            load_eth_private_key(self.eth_private_key))
 

get_nested_snark()

IZKSnarkProvider zecale.cli.command_context.CommandContext.get_nested_snark

(

self

)

Definition at line 98 of file command_context.py.

    def get_nested_snark(self) -> IZKSnarkProvider:
        return self.get_aggregator_configuration().nested_snark
 

Here is the call graph for this function:

get_web3()

Any zecale.cli.command_context.CommandContext.get_web3

(

self

)

Create and cache web3 connection.

Definition at line 54 of file command_context.py.

    def get_web3(self) -> Any:
        """
        Create and cache web3 connection.
        """
        if not self._web3:
            self._web3 = open_web3_from_network(get_eth_network(self.eth_network))
        return self._web3
 

Here is the caller graph for this function:

get_wrapper_snark()

IZKSnarkProvider zecale.cli.command_context.CommandContext.get_wrapper_snark

(

self

)

Definition at line 101 of file command_context.py.

    def get_wrapper_snark(self) -> IZKSnarkProvider:
        return self.get_aggregator_configuration().wrapper_snark
 

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

aggregator_config_file

zecale.cli.command_context.CommandContext.aggregator_config_file

Definition at line 32 of file command_context.py.

aggregator_server

zecale.cli.command_context.CommandContext.aggregator_server

Definition at line 31 of file command_context.py.

eth_addr

zecale.cli.command_context.CommandContext.eth_addr

Definition at line 35 of file command_context.py.

eth_network

zecale.cli.command_context.CommandContext.eth_network

Definition at line 34 of file command_context.py.

eth_private_key

zecale.cli.command_context.CommandContext.eth_private_key

Definition at line 36 of file command_context.py.

instance_file

zecale.cli.command_context.CommandContext.instance_file

Definition at line 33 of file command_context.py.

---

The documentation for this class was generated from the following file:

• /home/runner/work/zecale/zecale/client/zecale/cli/command_context.py