-
Notifications
You must be signed in to change notification settings - Fork 573
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make the Sapling parameters optional for documentation builds
This is to allow our documentation to build on platforms like docs.rs, which need to build the documentation for our crates, but don't have access to the Sapling parameters. This also slightly improves the experience for developers who use this crate for the first time: if they use the crate without the Sapling parameters, they'll now get a helpful warning instead of a panic.
- Loading branch information
Showing
3 changed files
with
97 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| use blstrs::Bls12; | ||
| use ironfish_bellperson::groth16; | ||
|
|
||
| #[cfg(not(doc))] | ||
| macro_rules! include_params { | ||
| ( $name:literal ) => { | ||
| include_bytes!(concat!(env!("OUT_DIR"), "/sapling_params/", $name)) | ||
| }; | ||
| } | ||
|
|
||
| // When building documentation (especially on docs.rs), it's quite possible that the parameter | ||
| // files won't be available, so don't even attempt to include them. This will also speed up | ||
| // documentation builds. | ||
| #[cfg(doc)] | ||
| macro_rules! include_params { | ||
| ( $name:literal ) => { | ||
| b"" | ||
| }; | ||
| } | ||
|
|
||
| static SAPLING_SPEND_PARAMS: &[u8] = include_params!("sapling-spend.params"); | ||
| static SAPLING_OUTPUT_PARAMS: &[u8] = include_params!("sapling-output.params"); | ||
| static SAPLING_MINT_PARAMS: &[u8] = include_params!("sapling-mint.params"); | ||
|
|
||
| // The main entry-point to the sapling API. Construct this with loaded parameters, and then call | ||
| // methods on it to do the actual work. | ||
| // | ||
| // spend and output are two arithmetic circuits for use in zksnark calculations provided by bellperson. | ||
| // Though the *_params have a verifying key on them, they are not the prepared verifying keys, | ||
| // so we store the prepared keys separately at the time of loading the params. | ||
| // | ||
| // The values are all loaded from a file in serialized form. | ||
| pub struct Sapling { | ||
| pub spend_params: groth16::Parameters<Bls12>, | ||
| pub output_params: groth16::Parameters<Bls12>, | ||
| pub mint_params: groth16::Parameters<Bls12>, | ||
| pub spend_verifying_key: groth16::PreparedVerifyingKey<Bls12>, | ||
| pub output_verifying_key: groth16::PreparedVerifyingKey<Bls12>, | ||
| pub mint_verifying_key: groth16::PreparedVerifyingKey<Bls12>, | ||
| } | ||
|
|
||
| impl Sapling { | ||
| /// Initialize a Sapling instance and prepare for proving. Load the parameters from files | ||
| /// at a known location (`$OUT_DIR/sapling_params`). | ||
| pub fn load() -> Self { | ||
| let spend_params = Sapling::load_params(SAPLING_SPEND_PARAMS); | ||
| let output_params = Sapling::load_params(SAPLING_OUTPUT_PARAMS); | ||
| let mint_params = Sapling::load_params(SAPLING_MINT_PARAMS); | ||
|
|
||
| let spend_verifying_key = groth16::prepare_verifying_key(&spend_params.vk); | ||
| let output_verifying_key = groth16::prepare_verifying_key(&output_params.vk); | ||
| let mint_verifying_key = groth16::prepare_verifying_key(&mint_params.vk); | ||
|
|
||
| Sapling { | ||
| spend_verifying_key, | ||
| output_verifying_key, | ||
| mint_verifying_key, | ||
| spend_params, | ||
| output_params, | ||
| mint_params, | ||
| } | ||
| } | ||
|
|
||
| /// Load sapling parameters from a provided filename. The parameters are huge and take a | ||
| /// couple seconds to load. They primarily contain the "toxic waste" for a specific sapling | ||
| /// curve. | ||
| /// | ||
| /// NOTE: If this is stupidly slow for you, try compiling in --release mode | ||
| fn load_params(bytes: &[u8]) -> groth16::Parameters<Bls12> { | ||
| groth16::Parameters::read(bytes, false).unwrap() | ||
| } | ||
| } |