Files
concrete/docs/dev/api/concrete.compiler.client_parameters.md
Benoit Chevallier-Mames e37a840e7e docs(compiler): adding API doc
2024-03-13 17:10:00 +01:00

3.3 KiB

module concrete.compiler.client_parameters

Client parameters.


class ClientParameters

ClientParameters are public parameters used for key generation.

It's a compilation artifact that describes which and how public and private keys should be generated, and used to encrypt arguments of the compiled function.

method __init__

__init__(client_parameters: ClientParameters)

Wrap the native Cpp object.

Args:

  • client_parameters (_ClientParameters): object to wrap

Raises:

  • TypeError: if client_parameters is not of type _ClientParameters

method deserialize

deserialize(serialized_params: bytes)  ClientParameters

Unserialize ClientParameters from bytes of serialized_params.

Args:

  • serialized_params (bytes): previously serialized ClientParameters

Raises:

  • TypeError: if serialized_params is not of type bytes

Returns:

  • ClientParameters: deserialized object

method input_signs

input_signs()  List[bool]

Return the sign information of inputs.

Returns:

  • List[bool]: list of booleans to indicate whether the inputs are signed or not

method output_signs

output_signs()  List[bool]

Return the sign information of outputs.

Returns:

  • List[bool]: list of booleans to indicate whether the outputs are signed or not

method serialize

serialize()  bytes

Serialize the ClientParameters.

Returns:

  • bytes: serialized object