zecale.core.dispatcher_contract.DispatcherContract Class Reference

Public Member Functions
def	__init__ (self, Any web3, InstanceDescription instance_desc, IZKSnarkProvider zksnark)
bytes	process_batch (self, PairingParameters pp, AggregatedTransaction batch, str application_contract_address, str eth_addr, Optional[bytes] eth_private_key)
None	dump_logs (self, Any tx_receipt)

Static Public Member Functions
Tuple[DispatcherContract, InstanceDescription]	deploy (Any web3, IZKSnarkProvider zksnark, PairingParameters pp, IVerificationKey vk, str eth_addr, Optional[bytes] eth_private_key)

Public Attributes
	web3
	instance
	zksnark

Detailed Description

Wrapper around operations on the zecale dispatcher contract.

Definition at line 23 of file dispatcher_contract.py.

Constructor & Destructor Documentation

__init__()

def zecale.core.dispatcher_contract.DispatcherContract.__init__	(		self,
		Any	web3,
		InstanceDescription	instance_desc,
		IZKSnarkProvider	zksnark
	)

Definition at line 28 of file dispatcher_contract.py.

    def __init__(
            self,
            web3: Any,
            instance_desc: InstanceDescription,
            zksnark: IZKSnarkProvider):
        self.web3 = web3
        self.instance = instance_desc.instantiate(web3)
        self.zksnark = zksnark
 

Member Function Documentation

deploy()

Tuple[DispatcherContract, InstanceDescription] zecale.core.dispatcher_contract.DispatcherContract.deploy ( Any  web3, IZKSnarkProvider  zksnark, PairingParameters  pp, IVerificationKey  vk, str  eth_addr, Optional[bytes]   eth_private_key  )

static

Deploy the contract, returning an instance of this wrapper, and a
description (which can be saved to a file to later instantiate).

Definition at line 38 of file dispatcher_contract.py.

    def deploy(
            web3: Any,
            zksnark: IZKSnarkProvider,
            pp: PairingParameters,
            vk: IVerificationKey,
            eth_addr: str,
            eth_private_key: Optional[bytes]
    ) -> Tuple[DispatcherContract, InstanceDescription]:
        """
        Deploy the contract, returning an instance of this wrapper, and a
        description (which can be saved to a file to later instantiate).
        """
        vk_evm = zksnark.verification_key_to_contract_parameters(vk, pp)
        instance_desc = InstanceDescription.deploy(
            web3,
            DISPATCHER_SOURCE_FILE,
            "ZecaleDispatcher",
            eth_addr,
            eth_private_key,
            DISPATCHER_DEPLOY_GAS,
            {"allow_paths": CONTRACTS_DIR},
            [vk_evm])
        return DispatcherContract(web3, instance_desc, zksnark), instance_desc
 

dump_logs()

None zecale.core.dispatcher_contract.DispatcherContract.dump_logs	(		self,
		Any	tx_receipt
	)

Print out debug log information from a dispatcher invocation

Definition at line 96 of file dispatcher_contract.py.

    def dump_logs(self, tx_receipt: Any) -> None:
        """
        Print out debug log information from a dispatcher invocation
        """
        logs = get_event_logs_from_tx_receipt(self.instance, "log", tx_receipt)
        for event_data in logs:
            print(f"{event_data.args['a']}: {event_data.args['v']}")

process_batch()

bytes zecale.core.dispatcher_contract.DispatcherContract.process_batch	(		self,
		PairingParameters	pp,
		AggregatedTransaction	batch,
		str	application_contract_address,
		str	eth_addr,
		Optional[bytes]	eth_private_key
	)

Send a batch to the contracts process_batch entry point. Returns the
transaction ID.

Definition at line 62 of file dispatcher_contract.py.

    def process_batch(
            self,
            pp: PairingParameters,
            batch: AggregatedTransaction,
            application_contract_address: str,
            eth_addr: str,
            eth_private_key: Optional[bytes]) -> bytes:
        """
        Send a batch to the contracts process_batch entry point. Returns the
        transaction ID.
        """
 
        # Encode the parameters of the entry point and create a local call
        # object. The proof and inputs are encoded into contract parameters,
        # and the nested_parameters are passed as raw bytes arrays.
        proof_evm = self.zksnark.proof_to_contract_parameters(
            batch.ext_proof.proof, pp)
        inputs_evm = hex_list_to_uint256_list(batch.ext_proof.inputs)
 
        contract_call = self.instance.functions.process_batch(
            proof_evm,
            inputs_evm,
            batch.nested_parameters,
            application_contract_address)
 
        # Broadcast the call
        return send_contract_call(
            self.web3,
            contract_call,
            eth_addr,
            eth_private_key,
            None,               # TODO: value (fee?)
            None)
 

Member Data Documentation

instance

zecale.core.dispatcher_contract.DispatcherContract.instance

Definition at line 30 of file dispatcher_contract.py.

web3

zecale.core.dispatcher_contract.DispatcherContract.web3

Definition at line 29 of file dispatcher_contract.py.

zksnark

zecale.core.dispatcher_contract.DispatcherContract.zksnark

Definition at line 31 of file dispatcher_contract.py.

---

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

• /home/runner/work/zecale/zecale/client/zecale/core/dispatcher_contract.py