+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API Reference · Groth.jl</title><meta name="title" content="API Reference · Groth.jl"/><meta property="og:title" content="API Reference · Groth.jl"/><meta property="twitter:title" content="API Reference · Groth.jl"/><meta name="description" content="Documentation for Groth.jl."/><meta property="og:description" content="Documentation for Groth.jl."/><meta property="twitter:description" content="Documentation for Groth.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Groth.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">Start Here</span><ul><li><a class="tocitem" href="../getting-started/">Getting Started</a></li><li><a class="tocitem" href="../groth16-e2e/">Groth16 End-to-End</a></li></ul></li><li><span class="tocitem">Learning Path</span><ul><li><a class="tocitem" href="../rareskills-map/">RareSkills ZK Book Map</a></li><li><a class="tocitem" href="../textbook-to-optimized/">Textbook To Optimized Code</a></li><li><a class="tocitem" href="../architecture/">Architecture Map</a></li></ul></li><li><span class="tocitem">Packages</span><ul><li><a class="tocitem" href="../algebra/">Groth Algebra</a></li><li><a class="tocitem" href="../curves/">Groth Curves</a></li><li><a class="tocitem" href="../proofs/">Groth Proofs</a></li></ul></li><li><span class="tocitem">Engineering</span><ul><li><a class="tocitem" href="../benchmarks/">Benchmarks</a></li><li><a class="tocitem" href="../benchmark-snapshots/">Benchmark Snapshots</a></li><li><a class="tocitem" href="../implementation-vs-arkworks/">Implementation vs Arkworks</a></li><li><a class="tocitem" href="../implementation-notes/">Implementation Notes</a></li></ul></li><li class="is-active"><a class="tocitem" href>API Reference</a><ul class="internal"><li><a class="tocitem" href="#Symbol-Index"><span>Symbol Index</span></a></li><li><a class="tocitem" href="#Package-API-Pages"><span>Package API Pages</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/0xpantera/Groth.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/0xpantera/Groth.jl/blob/master/docs/src/api.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="api-reference"><a class="docs-heading-anchor" href="#api-reference">API Reference</a><a id="api-reference-1"></a><a class="docs-heading-anchor-permalink" href="#api-reference" title="Permalink"></a></h1><p>This page collects exported symbols. For docstrings and package-specific examples, use the package pages linked below.</p><ul><li><a href="#api-reference">API Reference</a></li><li class="no-marker"><ul><li><a href="#Symbol-Index">Symbol Index</a></li><li><a href="#Package-API-Pages">Package API Pages</a></li></ul></li></ul><h2 id="Symbol-Index"><a class="docs-heading-anchor" href="#Symbol-Index">Symbol Index</a><a id="Symbol-Index-1"></a><a class="docs-heading-anchor-permalink" href="#Symbol-Index" title="Permalink"></a></h2><ul><li><a href="../algebra/#GrothAlgebra.BN254Fq"><code>GrothAlgebra.BN254Fq</code></a></li><li><a href="../algebra/#GrothAlgebra.BN254Fr"><code>GrothAlgebra.BN254Fr</code></a></li><li><a href="../algebra/#GrothAlgebra.FiniteFieldElement"><code>GrothAlgebra.FiniteFieldElement</code></a></li><li><a href="../algebra/#GrothAlgebra.FixedBaseTable"><code>GrothAlgebra.FixedBaseTable</code></a></li><li><a href="../algebra/#GrothAlgebra.GroupElem"><code>GrothAlgebra.GroupElem</code></a></li><li><a href="../algebra/#GrothAlgebra.Polynomial"><code>GrothAlgebra.Polynomial</code></a></li><li><a href="../algebra/#GrothAlgebra.Secp256k1Field"><code>GrothAlgebra.Secp256k1Field</code></a></li><li><a href="../curves/#GrothCurves.BN254Engine"><code>GrothCurves.BN254Engine</code></a></li><li><a href="../curves/#GrothCurves.Fp12Element"><code>GrothCurves.Fp12Element</code></a></li><li><a href="../curves/#GrothCurves.Fp2Element"><code>GrothCurves.Fp2Element</code></a></li><li><a href="../curves/#GrothCurves.Fp6Element"><code>GrothCurves.Fp6Element</code></a></li><li><a href="../curves/#GrothCurves.ProjectivePoint"><code>GrothCurves.ProjectivePoint</code></a></li><li><a href="../proofs/#GrothProofs.Groth16Proof"><code>GrothProofs.Groth16Proof</code></a></li><li><a href="../proofs/#GrothProofs.PreparedVerificationKey"><code>GrothProofs.PreparedVerificationKey</code></a></li><li><a href="../proofs/#GrothProofs.ProvingKey"><code>GrothProofs.ProvingKey</code></a></li><li><a href="../proofs/#GrothProofs.QAP"><code>GrothProofs.QAP</code></a></li><li><a href="../proofs/#GrothProofs.R1CS"><code>GrothProofs.R1CS</code></a></li><li><a href="../proofs/#GrothProofs.VerificationKey"><code>GrothProofs.VerificationKey</code></a></li><li><a href="../proofs/#GrothProofs.Witness"><code>GrothProofs.Witness</code></a></li><li><a href="../algebra/#GrothAlgebra.build_fixed_table"><code>GrothAlgebra.build_fixed_table</code></a></li><li><a href="../algebra/#GrothAlgebra.degree"><code>GrothAlgebra.degree</code></a></li><li><a href="../algebra/#GrothAlgebra.evaluate"><code>GrothAlgebra.evaluate</code></a></li><li><a href="../algebra/#GrothAlgebra.fft_polynomial_multiply"><code>GrothAlgebra.fft_polynomial_multiply</code></a></li><li><a href="../algebra/#GrothAlgebra.leading_coefficient"><code>GrothAlgebra.leading_coefficient</code></a></li><li><a href="../algebra/#GrothAlgebra.mul_fixed"><code>GrothAlgebra.mul_fixed</code></a></li><li><a href="../algebra/#GrothAlgebra.multi_scalar_mul"><code>GrothAlgebra.multi_scalar_mul</code></a></li><li><a href="../algebra/#GrothAlgebra.roots_of_unity"><code>GrothAlgebra.roots_of_unity</code></a></li><li><a href="../algebra/#GrothAlgebra.scalar_mul"><code>GrothAlgebra.scalar_mul</code></a></li><li><a href="../algebra/#GrothAlgebra.scalar_mul_wnaf"><code>GrothAlgebra.scalar_mul_wnaf</code></a></li><li><a href="../curves/#GrothCurves.addition_step"><code>GrothCurves.addition_step</code></a></li><li><a href="../curves/#GrothCurves.conjugate"><code>GrothCurves.conjugate</code></a></li><li><a href="../curves/#GrothCurves.doubling_step"><code>GrothCurves.doubling_step</code></a></li><li><a href="../curves/#GrothCurves.evaluate_line"><code>GrothCurves.evaluate_line</code></a></li><li><a href="../curves/#GrothCurves.final_exponentiation"><code>GrothCurves.final_exponentiation</code></a></li><li><a href="../curves/#GrothCurves.g1_subgroup_multi_scalar_mul"><code>GrothCurves.g1_subgroup_multi_scalar_mul</code></a></li><li><a href="../curves/#GrothCurves.g1_subgroup_multi_scalar_mul_pair"><code>GrothCurves.g1_subgroup_multi_scalar_mul_pair</code></a></li><li><a href="../curves/#GrothCurves.g2_subgroup_scalar_mul"><code>GrothCurves.g2_subgroup_scalar_mul</code></a></li><li><a href="../curves/#GrothCurves.miller_loop"><code>GrothCurves.miller_loop</code></a></li><li><a href="../curves/#GrothCurves.norm"><code>GrothCurves.norm</code></a></li><li><a href="../curves/#GrothCurves.optimal_ate_pairing"><code>GrothCurves.optimal_ate_pairing</code></a></li><li><a href="../curves/#GrothCurves.pairing"><code>GrothCurves.pairing</code></a></li><li><a href="../curves/#GrothCurves.pairing_batch"><code>GrothCurves.pairing_batch</code></a></li><li><a href="../proofs/#GrothProofs.compute_h_polynomial"><code>GrothProofs.compute_h_polynomial</code></a></li><li><a href="../proofs/#GrothProofs.evaluate_qap"><code>GrothProofs.evaluate_qap</code></a></li><li><a href="../proofs/#GrothProofs.polynomial_division"><code>GrothProofs.polynomial_division</code></a></li><li><a href="../proofs/#GrothProofs.prepare_inputs"><code>GrothProofs.prepare_inputs</code></a></li><li><a href="../proofs/#GrothProofs.prepare_verifying_key"><code>GrothProofs.prepare_verifying_key</code></a></li><li><a href="../proofs/#GrothProofs.process_vk"><code>GrothProofs.process_vk</code></a></li><li><a href="../proofs/#GrothProofs.prove"><code>GrothProofs.prove</code></a></li><li><a href="../proofs/#GrothProofs.prove_full"><code>GrothProofs.prove_full</code></a></li><li><a href="../proofs/#GrothProofs.public_inputs_from_witness"><code>GrothProofs.public_inputs_from_witness</code></a></li><li><a href="../proofs/#GrothProofs.r1cs_to_qap"><code>GrothProofs.r1cs_to_qap</code></a></li><li><a href="../proofs/#GrothProofs.setup"><code>GrothProofs.setup</code></a></li><li><a href="../proofs/#GrothProofs.setup_full"><code>GrothProofs.setup_full</code></a></li><li><a href="../proofs/#GrothProofs.validate_witness_shape"><code>GrothProofs.validate_witness_shape</code></a></li><li><a href="../proofs/#GrothProofs.verify"><code>GrothProofs.verify</code></a></li><li><a href="../proofs/#GrothProofs.verify_full"><code>GrothProofs.verify_full</code></a></li><li><a href="../proofs/#GrothProofs.verify_prepared"><code>GrothProofs.verify_prepared</code></a></li><li><a href="../proofs/#GrothProofs.verify_with_prepared"><code>GrothProofs.verify_with_prepared</code></a></li></ul><h2 id="Package-API-Pages"><a class="docs-heading-anchor" href="#Package-API-Pages">Package API Pages</a><a id="Package-API-Pages-1"></a><a class="docs-heading-anchor-permalink" href="#Package-API-Pages" title="Permalink"></a></h2><ul><li><a href="../algebra/#Groth-Algebra">Groth Algebra</a> covers fields, polynomials, group operations, and MSM helpers.</li><li><a href="../curves/#Groth-Curves">Groth Curves</a> covers BN254 extension fields, G1/G2 operations, pairings, and subgroup-specialized helpers.</li><li><a href="../proofs/#Groth-Proofs">Groth Proofs</a> covers R1CS, QAP, Groth16 setup/proving/verification, and prepared verifier APIs.</li></ul><script type="module">import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
0 commit comments