EZKL Python Bindings

https://pythonbindings.ezkl.xyz/en/stable/
Admin
EZKL Python Bindings provide Python interfaces for zero-knowledge machine learning circuits,...
Tokens:4,632
Snippets:40
Trust Score:7.2
Update:7 months ago
Show doc for...
Tokens:
Raw
### ezkl.setup

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Runs the setup process to generate verification and proving keys.

```APIDOC
## POST /ezkl/setup

### Description
Runs the setup process to generate verification and proving keys.

### Method
POST

### Endpoint
/ezkl/setup

### Parameters
#### Query Parameters
- **model** (str) - Required - Path to the compiled model file
- **vk_path** (str) - Required - Path to create the verification key file
- **pk_path** (str) - Required - Path to create the proving key file
- **srs_path** (str) - Optional - Path to the SRS file
- **witness_path** (str) - Optional - Path to the witness file
- **disable_selector_compression** (bool) - Optional - Whether to compress the selectors or not

### Response
#### Success Response (200)
- **result** (bool) - Indicates if the setup process was successful.
```

--------------------------------

### Create EVM Verifier for ezkl

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Generates an EVM-compatible verifier contract in Solidity. This allows for on-chain verification of ezkl proofs. The function requires paths to the verification key, settings file, and output paths for the Solidity code and ABI. The 'solc' compiler must be installed in the environment.

```python
ezkl.create_evm_verifier(_vk_path: str = Ellipsis, _settings_path: str = Ellipsis, _sol_code_path: str = Ellipsis, _abi_path: str = Ellipsis, _srs_path: str = None, _reusable: bool = Ellipsis)
```

--------------------------------

### Deploy EVM Verifier (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Deploys the Solidity verifier contract to an Ethereum-compatible network. It requires the address path, RPC URL, and optionally paths to the Solidity code, contract type, optimizer runs, and private key.

```python
ezkl.deploy_evm(_addr_path_, _rpc_url_, _sol_code_path = Ellipsis, _contract_type = Ellipsis, _optimizer_runs = Ellipsis, _private_key = None)
```

--------------------------------

### Generate Verification Key from Proving Key (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Generates a verification key (vk) from a proving key (pk) for a model circuit and saves it to a file. It requires paths to the proving key, circuit settings, and the desired output path for the vk file.

```python
ezkl.gen_vk_from_pk_single(_path_to_pk = Ellipsis, _circuit_settings_path = Ellipsis, _vk_output_path = Ellipsis)
```

--------------------------------

### ezkl.prove

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Runs the prover to generate a proof for a given model and witness.

```APIDOC
## POST /ezkl/prove

### Description
Runs the prover on a set of inputs to generate a proof.

### Method
POST

### Endpoint
/ezkl/prove

### Parameters
#### Query Parameters
- **witness** (str) - Required - Path to the witness file
- **model** (str) - Required - Path to the compiled model file
- **pk_path** (str) - Required - Path to the proving key file
- **proof_path** (str) - Optional - Path to create the proof file
- **srs_path** (str) - Optional - Path to the SRS file

### Response
#### Success Response (200)
- **result** (bool) - Indicates if the proof generation was successful.
```

--------------------------------

### ezkl.swap_proof_commitments

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Swaps the commitments within a proof file.

```APIDOC
## POST /ezkl/swap_proof_commitments

### Description
Swap the commitments in a proof.

### Method
POST

### Endpoint
/ezkl/swap_proof_commitments

### Parameters
#### Query Parameters
- **proof_path** (str) - Required - Path to the proof file
- **witness_path** (str) - Required - Path to the witness file

### Response
#### Success Response (200)
- **result** (bool) - Indicates if the swap operation was successful.
```

--------------------------------

### ezkl.verify_evm

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Verifies an EVM-compatible proof.

```APIDOC
## POST /ezkl/verify_evm

### Description
Verifies an EVM-compatible proof. Requires `solc` to be installed.

### Method
POST

### Endpoint
/ezkl/verify_evm

### Parameters
#### Query Parameters
- **addr_verifier** (str) - Required - The verifier contract’s address as a hex string
- **proof_path** (str) - Required - The path to the proof file (generated using the prove command)
- **rpc_url** (str) - Required - RPC URL for an Ethereum node, if None will use Anvil but WON’T persist state
- **vka_path** (str) - Optional - The path to the VKA calldata bytes file (generated using the create_evm_vka command)
- **encoded_calldata** (str) - Optional - The path to the encoded calldata bytes file (generated using the encode calldata command)

### Response
#### Success Response (200)
- **result** (bool) - Indicates if the EVM proof verification was successful.
```

--------------------------------

### Create EVM Verifier Artifact (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Generates an EVM Verification Key (VK) artifact with circuit-specific metadata. This is useful for deploying verifiers that are too large to fit on-chain. It requires paths to the verification key, settings, and SRS files, along with the number of decimals for rescaling.

```python
ezkl.create_evm_vka(_vk_path = Ellipsis, _settings_path = Ellipsis, _vka_path = Ellipsis, _srs_path = None, _decimals = Ellipsis)
```

--------------------------------

### ezkl.mock

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Mocks the prover for testing purposes.

```APIDOC
## POST /ezkl/mock

### Description
Mocks the prover.

### Method
POST

### Endpoint
/ezkl/mock

### Parameters
#### Query Parameters
- **witness** (str) - Optional - Path to the witness file
- **model** (str) - Optional - Path to the compiled model file

### Response
#### Success Response (200)
- **result** (bool) - Indicates if the mock operation was successful.
```

--------------------------------

### ezkl.verify

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Verifies a given proof against the settings and verification key.

```APIDOC
## POST /ezkl/verify

### Description
Verifies a given proof.

### Method
POST

### Endpoint
/ezkl/verify

### Parameters
#### Query Parameters
- **proof_path** (str) - Required - Path to the proof file
- **settings_path** (str) - Required - Path to the settings file
- **vk_path** (str) - Required - Path to the verification key file
- **srs_path** (str) - Optional - Path to the SRS file
- **non_reduced_srs** (bool) - Optional - Whether to use non-reduced SRS. (only works if the srs were generated in the same ceremony)

### Response
#### Success Response (200)
- **result** (bool) - Indicates if the proof verification was successful.
```

--------------------------------

### Compile ezkl Circuit

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Compiles an ONNX model into a circuit format suitable for further processing within ezkl. This is a prerequisite step before generating proofs or verifiers. It requires paths to the ONNX model, the desired output path for the compiled circuit, and the settings file.

```python
ezkl.compile_circuit(_model: str = Ellipsis, _compiled_circuit: str = Ellipsis, _settings_path: str = Ellipsis) -> bool
```

--------------------------------

### Generate Circuit Settings (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Generates the circuit settings required for model execution. This function takes the path to the ONNX model and an output path for the settings file. It can also be initialized with PyRunArgs.

```python
ezkl.gen_settings(_model = Ellipsis, _output = Ellipsis, _py_run_args = None)
```

--------------------------------

### Generate Witness (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Runs the forward pass operation to generate a witness file. This function requires paths to the data file, compiled model, and an output path for the witness. It can also utilize verification key and SRS paths.

```python
ezkl.gen_witness(_data = Ellipsis, _model = Ellipsis, _output = Ellipsis, _vk_path = None, _srs_path = None)
```

--------------------------------

### ezkl.table

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Displays the table of nodes in an ONNX model as a string.

```APIDOC
## GET /ezkl/table

### Description
Displays the table of nodes in the ONNX model as a string.

### Method
GET

### Endpoint
/ezkl/table

### Parameters
#### Query Parameters
- **model** (str) - Required - Path to the ONNX file
- **py_run_args** (dict) - Optional - Arguments for running the Python model.

### Response
#### Success Response (200)
- **table_string** (str) - A string representation of the table of nodes in the ONNX file.
```

--------------------------------

### ezkl.poseidon_hash

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Generates a Poseidon hash for a list of field elements.

```APIDOC
## POST /ezkl/poseidon_hash

### Description
Generate a Poseidon hash.

### Method
POST

### Endpoint
/ezkl/poseidon_hash

### Parameters
#### Query Parameters
- **message** (list[str]) - Required - List of field elements represented as strings

### Response
#### Success Response (200)
- **hashes** (list[str]) - List of field elements represented as strings (the hashes).

### Request Example
```json
{
  "message": ["1", "2", "3"]
}
```

### Response Example
```json
{
  "hashes": ["hash1", "hash2"]
}
```
```

--------------------------------

### Generate SRS (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Generates the Structured Reference String (SRS) file. This function is primarily for testing purposes and requires the output path for the SRS file and the number of logrows.

```python
ezkl.gen_srs(_srs_path_, _logrows_)
```

--------------------------------

### Encode EVM Calldata (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Creates encoded EVM calldata from a proof file. This function takes the path to the proof file, the calldata output path, and optionally the address of the verification key contract. It returns the encoded calldata as a byte vector.

```python
ezkl.encode_evm_calldata(_proof = Ellipsis, _calldata = Ellipsis, _vka_path = None)
```

--------------------------------

### Calibrate ezkl Circuit Settings

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Calibrates the circuit settings based on provided data, model, and existing settings. This function helps optimize the circuit's performance and resource usage. Optional parameters allow for specifying lookup safety margins, specific scales, scale rebase multipliers, and maximum logrows.

```python
ezkl.calibrate_settings(_data: str = Ellipsis, _model: str = Ellipsis, _settings: str = Ellipsis, _target: str = Ellipsis, _lookup_safety_margin: int = Ellipsis, _scales: list[int] = None, _scale_rebase_multiplier: list[int] = Ellipsis, _max_logrows: int = None) -> bool
```

--------------------------------

### ezkl.get_srs

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Retrieves a public SRS (Structured Reference String).

```APIDOC
## GET /ezkl/get_srs

### Description
Gets a public SRS (Structured Reference String).

### Method
GET

### Endpoint
/ezkl/get_srs

### Parameters
#### Query Parameters
- **settings_path** (str) - Required - Path to the settings file
- **logrows** (int) - Optional - The number of logrows for the SRS file
- **srs_path** (str) - Optional - Path to the create the SRS file

### Response
#### Success Response (200)
- **result** (bool) - Indicates if the SRS was successfully retrieved.
```

--------------------------------

### Generate Random Data (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Generates random data for a given ONNX model. This function requires the path to the model, an output path for the data file, and optionally a seed, minimum, and maximum values for the data generation. It returns a boolean indicating success.

```python
ezkl.gen_random_data(_model = Ellipsis, _output = Ellipsis, _variables = Ellipsis, _seed = Ellipsis, _min = None, _max = None)
```

--------------------------------

### Convert Buffer to Field Elements

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Converts a list of integers representing a buffer into a vector of field elements. This utility function is essential for preparing data before it can be processed by ezkl circuits. The output is a list of strings, where each string represents a field element.

```python
ezkl.buffer_to_felts(_buffer_: list[int]) -> list[str]
```

--------------------------------

### ezkl Data Structures

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Defines key data structures used within the ezkl Python bindings. These include classes for representing G1 points (PyG1, PyG1Affine), input types (PyInputType), run arguments (PyRunArgs), and test data sources (PyTestDataSource). These structures are fundamental for interacting with ezkl's functionalities.

```python
class ezkl.PyG1:
    """pyclass containing the struct used for G1, this is mostly a helper class"""
    x
    y
    z

class ezkl.PyG1Affine:
    """pyclass containing the struct used for G1"""
    x
    y

class ezkl.PyInputType:
    """
    Bool = PyInputType.Bool
    F16 = PyInputType.F16
    F32 = PyInputType.F32
    F64 = PyInputType.F64
    Int = PyInputType.Int
    TDim = PyInputType.TDim
    Unknown = PyInputType.Unknown

class ezkl.PyRunArgs:
    """Python class containing the struct used for run_args"""
    bounded_log_lookup: bool
    check_mode: str
    decomp_base: int
    decomp_legs: int
    disable_freivalds: bool
    epsilon: float
    ignore_range_check_inputs_outputs: bool
    input_scale: int
    input_visibility: str
    logrows: int
    lookup_range: list[int]
    num_inner_cols: int
    output_visibility: str
    param_scale: int
    param_visibility: str
    rebase_frac_zero_constants: bool
    scale_rebase_multiplier: int
    variables: list[tuple[str, int]]

class ezkl.PyTestDataSource:
    """pyclass representing an enum"""
    File = PyTestDataSource.File
    OnChain = PyTestDataSource.OnChain

```

--------------------------------

### ezkl.kzg_commit

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Generates a KZG (Kzg10) commitment from a list of field elements.

```APIDOC
## POST /ezkl/kzg_commit

### Description
Generate a KZG commitment.

### Method
POST

### Endpoint
/ezkl/kzg_commit

### Parameters
#### Query Parameters
- **message** (list[str]) - Required - List of field elements represented as strings
- **vk_path** (str) - Optional - Path to the verification key
- **settings_path** (str) - Optional - Path to the settings file
- **srs_path** (str) - Optional - Path to the Structure Reference String (SRS) file

### Response
#### Success Response (200)
- **commitments** (list[PyG1Affine]) - A list of KZG commitments.

### Request Example
```json
{
  "message": ["1", "2", "3"],
  "vk_path": "/path/to/vk.key",
  "settings_path": "/path/to/settings.json",
  "srs_path": "/path/to/srs.key"
}
```

### Response Example
```json
{
  "commitments": [
    {"x": "...", "y": "..."},
    {"x": "...", "y": "..."}
  ]
}
```
```

--------------------------------

### Float to Field Element Conversion (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Converts a floating-point number to a field element hex string using a specified scale and input type. The scale parameter quantizes the float into a field element, and input_type specifies the nature of the input.

```python
ezkl.float_to_felt(_input_, _scale_, _input_type = Ellipsis)
```

--------------------------------

### ezkl.register_vka

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Registers a VKA (Verifier Key Artifact) on the EZKL reusable verifier contract.

```APIDOC
## POST /ezkl/register_vka

### Description
Registers a VKA on the EZKL reusable verifier contract.

### Method
POST

### Endpoint
/ezkl/register_vka

### Parameters
#### Query Parameters
- **addr_verifier** (str) - Required - The reusable verifier contract’s address as a hex string
- **rpc_url** (str) - Required - RPC URL for an Ethereum node, if None will use Anvil but WON’T persist state
- **vka_path** (str) - Optional - The path to the VKA calldata bytes file (generated using the create_evm_vka command)
- **vka_digest_path** (str) - Optional - The path to the VKA digest file, aka hash of the VKA calldata bytes file
- **private_key** (str) - Optional - The private key to use for signing the transaction. If None, will use the default private key

### Response
#### Success Response (200)
- **result** (bool) - Indicates if the VKA registration was successful.
```

--------------------------------

### Field Element to Integer Conversion (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Converts a field element hex string to its integer representation. This function is useful for numerical processing of field elements.

```python
ezkl.felt_to_int(_felt_)
```

--------------------------------

### Field Element to Float Conversion (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Converts a field element hex string to a floating-point number using a specified scaling factor. The scale parameter determines how the field element is interpreted as a float.

```python
ezkl.felt_to_float(_felt_, _scale_)
```

--------------------------------

### Field Element to Big Endian Conversion (ezkl)

Source: https://pythonbindings.ezkl.xyz/en/stable/index

Converts a field element represented as a hex string to its big-endian string representation. This is a utility function for handling field element formats.

```python
ezkl.felt_to_big_endian(_felt_)
```
Tokens:
Raw