zeth.core.prover_client.ProverClient Class Reference

Public Member Functions
def	__init__ (self, str endpoint, Optional[str] prover_config_file=None)
ProverConfiguration	get_configuration (self)
IZKSnarkProvider	get_zksnark_provider (self)
IVerificationKey	get_verification_key (self)
Tuple[ExtendedProof, List[int]]	get_proof (self, ProofInputs proof_inputs)

Public Attributes
	endpoint
	prover_config_file
	prover_config

Detailed Description

Definition at line 53 of file prover_client.py.

Constructor & Destructor Documentation

__init__()

def zeth.core.prover_client.ProverClient.__init__	(		self,
		str	endpoint,
		Optional[str]	prover_config_file = None
	)

If config_file is not None, the ProverConfiguration will be cached in the
given file.

Definition at line 54 of file prover_client.py.

    def __init__(
            self,
            endpoint: str,
            prover_config_file: Optional[str] = None):
        """
        If config_file is not None, the ProverConfiguration will be cached in the
        given file.
        """
        self.endpoint = endpoint
        self.prover_config_file = prover_config_file
        self.prover_config: Optional[ProverConfiguration] = None
 

Member Function Documentation

get_configuration()

ProverConfiguration zeth.core.prover_client.ProverClient.get_configuration

(

self

)

Get the ProverConfiguration for the connected server, caching in memory
and in `config_file` if given.

Definition at line 66 of file prover_client.py.

    def get_configuration(self) -> ProverConfiguration:
        """
        Get the ProverConfiguration for the connected server, caching in memory
        and in `config_file` if given.
        """
        if self.prover_config is not None:
            return self.prover_config
 
        if (self.prover_config_file is not None) and \
           exists(self.prover_config_file):
            try:
                with open(self.prover_config_file, "r") as prover_config_f:
                    self.prover_config = ProverConfiguration.from_json_dict(
                        json.load(prover_config_f))
                    return self.prover_config
            except Exception as ex:
                print(
                    f"prover config error '{self.prover_config_file}': {str(ex)}")
                unlink(self.prover_config_file)
 
        with grpc.insecure_channel(self.endpoint) as channel:
            stub = prover_pb2_grpc.ProverStub(channel)  # type: ignore
            prover_config_proto = stub.GetConfiguration(_make_empty_message())
            self.prover_config = prover_configuration_from_proto(
                prover_config_proto)
 
        if self.prover_config_file is not None:
            with open(self.prover_config_file, "w") as prover_config_f:
                json.dump(self.prover_config.to_json_dict(), prover_config_f)
 
        return self.prover_config
 

Here is the caller graph for this function:

get_proof()

Tuple[ExtendedProof, List[int]] zeth.core.prover_client.ProverClient.get_proof	(		self,
		ProofInputs	proof_inputs
	)

Request a proof generation to the proving service

Definition at line 115 of file prover_client.py.

    def get_proof(
            self,
            proof_inputs: ProofInputs) -> Tuple[ExtendedProof, List[int]]:
        """
        Request a proof generation to the proving service
        """
        assert len(proof_inputs.js_inputs) == JS_INPUTS
        with grpc.insecure_channel(self.endpoint) as channel:
            stub = prover_pb2_grpc.ProverStub(channel)  # type: ignore
            extproof_and_pub_data = stub.Prove(proof_inputs)
            zksnark = self.get_zksnark_provider()
            extproof = zksnark.extended_proof_from_proto(
                extproof_and_pub_data.extended_proof)
            public_data = [int(x, 16) for x in extproof_and_pub_data.public_data]
            return extproof, public_data
 
 

Here is the call graph for this function:

get_verification_key()

IVerificationKey zeth.core.prover_client.ProverClient.get_verification_key

(

self

)

Fetch the verification key from the proving service

Definition at line 105 of file prover_client.py.

    def get_verification_key(self) -> IVerificationKey:
        """
        Fetch the verification key from the proving service
        """
        with grpc.insecure_channel(self.endpoint) as channel:
            stub = prover_pb2_grpc.ProverStub(channel)  # type: ignore
            vk_proto = stub.GetVerificationKey(_make_empty_message())
            zksnark = self.get_zksnark_provider()
            return zksnark.verification_key_from_proto(vk_proto)
 

Here is the call graph for this function:

get_zksnark_provider()

IZKSnarkProvider zeth.core.prover_client.ProverClient.get_zksnark_provider

(

self

)

Get the appropriate zksnark provider, based on the server configuration.

Definition at line 98 of file prover_client.py.

    def get_zksnark_provider(self) -> IZKSnarkProvider:
        """
        Get the appropriate zksnark provider, based on the server configuration.
        """
        config = self.get_configuration()
        return get_zksnark_provider(config.zksnark_name)
 

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

endpoint

zeth.core.prover_client.ProverClient.endpoint

Definition at line 59 of file prover_client.py.

prover_config

zeth.core.prover_client.ProverClient.prover_config

Definition at line 78 of file prover_client.py.

prover_config_file

zeth.core.prover_client.ProverClient.prover_config_file

Definition at line 60 of file prover_client.py.

---

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

• /home/runner/work/zeth/zeth/client/zeth/core/prover_client.py