zecale.core.aggregator_client.AggregatorClient Class Reference

Public Member Functions
def	__init__ (self, str endpoint)
AggregatorConfiguration	get_configuration (self)
IVerificationKey	get_verification_key (self, IZKSnarkProvider wrapper_zksnark)
str	get_nested_verification_key_hash (self, IZKSnarkProvider nested_zksnark, IVerificationKey vk)
None	register_application (self, IZKSnarkProvider nested_zksnark, IVerificationKey vk, str app_name)
None	submit_nested_transaction (self, IZKSnarkProvider nested_zksnark, NestedTransaction nested_tx)
AggregatedTransaction	get_aggregated_transaction (self, IZKSnarkProvider wrapper_zksnark, str name)

Public Attributes
	endpoint

Detailed Description

Interface to Aggregator RPC calls. Interface uses the in-memory version of
objects, internally converting to the protobuf versions.

Definition at line 18 of file aggregator_client.py.

Constructor & Destructor Documentation

__init__()

def zecale.core.aggregator_client.AggregatorClient.__init__	(		self,
		str	endpoint
	)

Definition at line 23 of file aggregator_client.py.

    def __init__(self, endpoint: str):
        self.endpoint = endpoint
 

Member Function Documentation

get_aggregated_transaction()

AggregatedTransaction zecale.core.aggregator_client.AggregatorClient.get_aggregated_transaction	(		self,
		IZKSnarkProvider	wrapper_zksnark,
		str	name
	)

Request an aggregated transaction.

Definition at line 78 of file aggregator_client.py.

    def get_aggregated_transaction(
            self,
            wrapper_zksnark: IZKSnarkProvider,
            name: str) -> AggregatedTransaction:
        """
        Request an aggregated transaction.
        """
        agg_tx_request = aggregator_pb2.AggregatedTransactionRequest()
        agg_tx_request.application_name = name
        with grpc.insecure_channel(self.endpoint) as channel:
            stub = aggregator_pb2_grpc.AggregatorStub(channel)  # type: ignore
            agg_tx_proto = stub.GenerateAggregatedTransaction(agg_tx_request)
        return aggregated_transaction_from_proto(wrapper_zksnark, agg_tx_proto)

Here is the call graph for this function:

get_configuration()

AggregatorConfiguration zecale.core.aggregator_client.AggregatorClient.get_configuration

(

self

)

Definition at line 26 of file aggregator_client.py.

    def get_configuration(self) -> AggregatorConfiguration:
        with grpc.insecure_channel(self.endpoint) as channel:
            stub = aggregator_pb2_grpc.AggregatorStub(channel)  # type: ignore
            config_proto = stub.GetConfiguration(empty_pb2.Empty())
            return aggregator_configuration_from_proto(config_proto)
 

Here is the call graph for this function:

get_nested_verification_key_hash()

str zecale.core.aggregator_client.AggregatorClient.get_nested_verification_key_hash	(		self,
		IZKSnarkProvider	nested_zksnark,
		IVerificationKey	vk
	)

Definition at line 39 of file aggregator_client.py.

    def get_nested_verification_key_hash(
            self, nested_zksnark: IZKSnarkProvider, vk: IVerificationKey) -> str:
        with grpc.insecure_channel(self.endpoint) as channel:
            stub = aggregator_pb2_grpc.AggregatorStub(channel)  # type: ignore
            vk_proto = nested_zksnark.verification_key_to_proto(vk)
            vk_hash_json = stub.GetNestedVerificationKeyHash(vk_proto).hash
            return json.loads(vk_hash_json)
 

get_verification_key()

IVerificationKey zecale.core.aggregator_client.AggregatorClient.get_verification_key	(		self,
		IZKSnarkProvider	wrapper_zksnark
	)

Definition at line 32 of file aggregator_client.py.

    def get_verification_key(
            self, wrapper_zksnark: IZKSnarkProvider) -> IVerificationKey:
        with grpc.insecure_channel(self.endpoint) as channel:
            stub = aggregator_pb2_grpc.AggregatorStub(channel)  # type: ignore
            vk_proto = stub.GetVerificationKey(empty_pb2.Empty())
            return wrapper_zksnark.verification_key_from_proto(vk_proto)
 

register_application()

None zecale.core.aggregator_client.AggregatorClient.register_application	(		self,
		IZKSnarkProvider	nested_zksnark,
		IVerificationKey	vk,
		str	app_name
	)

Register an application. Throw an error with message if this fails for any
reason.

Definition at line 47 of file aggregator_client.py.

    def register_application(
            self,
            nested_zksnark: IZKSnarkProvider,
            vk: IVerificationKey,
            app_name: str) -> None:
        """
        Register an application. Throw an error with message if this fails for any
        reason.
        """
        app_desc = aggregator_pb2.ApplicationDescription()
        app_desc.application_name = app_name
        app_desc.vk.CopyFrom(nested_zksnark.verification_key_to_proto(vk)) \
            # pylint: disable=no-member
        with grpc.insecure_channel(self.endpoint) as channel:
            stub = aggregator_pb2_grpc.AggregatorStub(channel)  # type: ignore
            stub.RegisterApplication(app_desc)
 

submit_nested_transaction()

None zecale.core.aggregator_client.AggregatorClient.submit_nested_transaction	(		self,
		IZKSnarkProvider	nested_zksnark,
		NestedTransaction	nested_tx
	)

Submit a nested transaction to the aggregator.

Definition at line 64 of file aggregator_client.py.

    def submit_nested_transaction(
            self,
            nested_zksnark: IZKSnarkProvider,
            nested_tx: NestedTransaction) -> None:
        """
        Submit a nested transaction to the aggregator.
        """
        assert isinstance(nested_zksnark, IZKSnarkProvider)
        assert isinstance(nested_tx, NestedTransaction)
        nested_tx_proto = nested_transaction_to_proto(nested_zksnark, nested_tx)
        with grpc.insecure_channel(self.endpoint) as channel:
            stub = aggregator_pb2_grpc.AggregatorStub(channel)  # type: ignore
            stub.SubmitNestedTransaction(nested_tx_proto)
 

Here is the call graph for this function:

Member Data Documentation

endpoint

zecale.core.aggregator_client.AggregatorClient.endpoint

Definition at line 24 of file aggregator_client.py.

---

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

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