24个版本 (2个稳定版)

1.0.1 2022年5月18日
1.0.0 2022年3月21日
0.5.3 2022年3月17日
0.4.20 2022年2月15日
0.4.0 2021年11月30日

#1650 in 神奇豆子

Download history 161/week @ 2024-03-13 120/week @ 2024-03-20 113/week @ 2024-03-27 125/week @ 2024-04-03 73/week @ 2024-04-10 101/week @ 2024-04-17 80/week @ 2024-04-24 97/week @ 2024-05-01 59/week @ 2024-05-08 47/week @ 2024-05-15 40/week @ 2024-05-22 95/week @ 2024-05-29 59/week @ 2024-06-05 67/week @ 2024-06-12 60/week @ 2024-06-19 41/week @ 2024-06-26

每月下载 238
5 个crate中使用了(4个直接使用)

Apache-2.0

430KB
6.5K SLoC

🚀 用于保护隐私的跨链应用中的零知识小工具和电路。🚀

GitHub Workflow Status License Apache 2.0 Twitter Telegram Discord

📖 目录

目录

构建

要构建项目,请运行

./scripts/build.sh

要为wasm目标构建,请运行

./scripts/build-wasm.sh

要运行单元测试,请运行

./scripts/test.sh

注意:所有命令都应该在根目录下运行。

发布到crates.io

对于版本管理,我们使用cargo-workspaces。我们使用以下流程

  1. 使用cargo-workspaces通过命令cargo ws version提升所有crate的版本。这将提升工作区中所有crate的版本,包括

    • arkworks/native-gadgets
    • arkworks/r1cs-gadgets
    • arkworks/r1cs-circuits
    • arkworks/setups
    • arkworks/utils
  2. 上一步只会更新crates本身,但不会更新它们的依赖项。例如,如果 arkworks/setups 依赖于 arkworks/utils,则依赖项版本将不会更新。 我们必须手动进行此操作。

  3. 提交所有更改。

  4. 使用以下命令发布crates: cargo ws publish --allow-branch [current_branch] --from-git

    --allow-branch 允许我们在任何分支上发布crates。默认情况下,它只能在 master 上发布。如果您希望从 master 发布,则不需要此选项。

    --from-git 标志指定crates应按原样发布,绕过 cargo ws publish 命令带来的额外版本增量。

概述

此仓库包含适用于不同终端应用(如混洗器和锚点)的零知识gadgets和电路,这些应用可以集成到兼容的区块链和智能合约协议中。仓库分为三个主要部分

  • 中间模块化gadgets
  • 消耗这些gadgets的电路
  • gadgets和电路使用的基礎工具(如Poseidon散列函数的参数)

小工具

您可以将gadgets视为中间计算和约束系统,您可以将它们组合起来构建更完整的零知识知识证明陈述。它们也可以通过扩展arkworks ConstraintSynthesizer直接使用。有关使用模拟计算的示例,请参阅 dummy circuit

在此仓库中,您将找到以下gadgets

Poseidon散列函数与 circom实现 匹配。根据此论文实现: https://eprint.iacr.org/2019/458.pdf

集合成员身份 - 用于以零知识方式证明某些值是否在集合中。这是通过首先计算从 target(我们检查其成员身份的值)到集合中每个值的差异(表示为 diffs)来完成的。然后我们计算目标和集合中每个元素乘积的总和。如果 diffs 中的一个值是0(意味着它等于 target),则乘积将为零,这意味着 target 在集合中。

电路

在此仓库中,您将找到以下电路

设置API

对于在此仓库中实现的各种电路,我们已经在设置目录中设置了各种设置。此文件夹包含为每个电路创建证明以及Poseidon、Merkle树、证明/验证密钥生成、验证器助手等的特定电路设置助手。

arkworks/setups/[r1cs | plonk] 中的每个特定应用的文件夹封装了该电路零知识证明的完整设置的API。目前存在以下特定应用的组件:

  • 混音器:R1CS,PLONK(待公布)
  • 锚点:R1CS,PLONK(待公布)
  • V锚点:R1CS,PLONK(待公布)

有关这些较大规模应用组件的测试和实例化所使用的组件,请参阅该目录中的test.rs文件。此仓库中的大多数测试和实现都使用Groth16证明和设置进行零知识组件。偶尔也会使用Marlin zkSNARK进行中间组件测试。但请注意,没有特定应用的Marlin实例化,欢迎通过拉取请求创建它们。

证明者

这些零知识组件的证明者旨在供客户端或服务器应用程序使用。这些证明者计算密集,需要访问随机数生成器。

验证者

这些零知识组件的验证器旨在供客户端、服务器或区块链应用程序使用。这些验证器与WASM兼容,并可以嵌入到支持智能合约(用Rust编写)的WASM友好环境(如区块链)中。API与特定的证明系统(如Groth16)保持一致,并且可以轻松集成到区块链运行时(如Substrate)中。

电路

混洗器

混音器组件旨在部署在基于Rust的区块链协议上。动机是在链上Merkle树和托管系统中,用户必须存入资产才能将叶子插入Merkle树。这被认为是混音器的存入。接下来,用户可以通过实例化混音器电路、在链上填充叶子、在本地向辅助实用程序提供私有和公共输入,然后生成零知识证明来生成Merkle树叶子成员的零知识证明。然后,他们可以将此证明提交到链上的验证器。这被认为是混音器的取出。下面提供混音器电路设置、证明过程和证明验证过程的示例实例。但是,首先,我们评论一下混音器的结构,以便阐明我们的设计决策。

任何零知识混音器电路的实例化都需要所有提供的数据都格式化成预期格式。这意味着必须提供特定结构的数据以供证明者使用。这甚至延伸到叶子的前像,如果数据不符合预期的格式或协议,则无法生成兼容的零知识证明,这些证明可以用于链上验证。

叶子结构

混合器叶片的结构是由来自一个域(BLS381或BN254)的两个随机域元素(秘密和nullifier)的哈希值构成的,这些元素基于您的电路实例。

公共输入结构

公共输入的结构必须是以下数据的有序数组,这些数据来自Tornado Cash的设计与架构。

  1. Nullifier哈希
  2. Merkle根
  3. 任意输入(不计入计算)

这些参数作为公共输入提供给零知识证明,并旨在实现链上的可定制性。

  • Nullifier哈希是随机生成的nullifier的哈希值。我们对其进行哈希处理,以便隐藏预像,防止提前攻击。
  • Merkle根是我们所证明的叶片成员资格的Merkle树的根哈希。
  • 对于链上的加密货币混合器,我们必须提供用户事先决定的私有交易中继服务,并为此服务支付费用。这些数据包含在任意输入中——通过对这些值(中继地址、费用、接收者等)进行哈希处理。

值得注意的是,包含在任意输入中的所有值都将绑定证明到这些值上。如果用户希望在证明生成后更改接收者,这有助于防止篡改。如果提交到链上的证明的公共输入发生变化,证明将因zkSNARK的底层安全性而失败。我们利用这种设计为最终应用的最终用户和中继提供适当的激励,这是一个链上的加密货币混合器。

锚点

Anchor协议与混合器非常相似。我们不是证明在单个Merkle树内的成员资格,而是在多个Merkle树中的一个中进行证明。这些树可以存在于许多不同的区块链上,如果Merkle树的状态在链之间同步,这将使我们能够进行跨链匿名交易。以下是Anchor工作的高级概述

  1. 我们使用Poseidon哈希函数计算叶片承诺,传递:secret(私有输入)、nullifier(私有输入)和chain id(公共输入)。
  2. 我们使用Poseidon哈希函数计算nullifier哈希,传递:nullifier(私有输入)
  3. 我们使用计算的叶片和路径(私有输入)计算根哈希
  4. 我们使用SetGadget检查计算出的根是否在集合(公共输入)中

叶子结构

叶片结构类似于混合器,除了我们还引入了chain id作为公共输入。chain id确保您只能在一个链上提款,从而防止双花。因此,Anchor叶片由一个secret(随机值)、nullifier(随机值)和chain_id组成。

公共输入结构

  1. Chain Id
  2. Nullifier哈希
  3. Merkle根集
  4. 任意输入
  • Chain Id - 确保您只在一个链上提款并防止双花。
  • Nullifier哈希与混合器中的相同,但它在多链环境中使用。这意味着它将注册在具有相同Id的链上(我们的公共输入)。
  • Merkle根集是一个根哈希数组。它由本地根(提款链上的根)和其他与本地链连接的链的根组成。
  • 任意输入与混合器的目的相同。它由:接收者、中继、费用、退款和承诺(承诺用于刷新您的叶片——这意味着如果承诺值非零,则插入新的叶片以替换旧的叶片)组成。

V锚点

VAnchor代表可变锚点,因为它引入了可变存款金额的概念。它支持匿名合并-分裂功能,允许将多个以前的存款合并成多个新的存款。VAnchor还支持跨链交易。以下是VAnchor工作的高级概述

  1. 使用输入Utxos和相应的Merkle路径,我们计算每个Utxo的根哈希。
  2. 我们正在检查每个Utxo的根哈希是否是根集的成员。我们使用SetGadget来完成这项工作。
  3. 使用输出Utxos,我们证明从传递的私入私钥创建叶节点。
  4. 我们确保输入金额的总和加上公金额等于输出金额的总和。

未经验证的输出

UTXOs代表未使用的交易输出。每个UTXO代表系统内可以使用的受保护余额。要创建新的UTXOs,必须证明对现有UTXOs的所有权,这些现有UTXOs的余额至少与新建的UTXOs一样多。

UTXOs包含一个值,表示UTXO中包含的金额、预期在UTXO中使用的链ID以及与创建所有权和成员资格的零知识证明相关的秘密数据。

UTXOs首先通过序列化其组件,然后通过在插入前对序列化数据进行哈希,存储在链上Merkle树中。每个哈希可以被认为是对UTXO的承诺。要从旧的UTXOs创建新的UTXOs,用户必须提交有效的零知识证明,这些证明满足关于值的一致性和在Merkle根集合中的成员资格约束。

公共输入

  1. 公共金额
  2. 任意输入
  3. 每个Utxo的Nullifier哈希数组
  4. 每个Utxo的叶承诺数组
  5. 进行交易时的链ID
  6. Merkle根集
  • 公共金额指定存款或提款金额。负值表示提款,正值表示存款。
  • 任意输入不计入计算。
  • Nullifier哈希数组与输入Utxos或要花费的Utxos相关
  • 叶承诺数组与输出Utxos或要存入的Utxos相关
  • 链ID和Merkle根集与Anchor中保持一致

API的示例用法

混合器 - 生成叶承诺和零知识证明

use arkworks_setups::{
	common::{Leaf, MixerProof},
	r1cs::mixer::MixerR1CSProver,
	Curve, MixerProver,
};

// Setting up the constants
// Default leaf in Merkle Tree
const DEFAULT_LEAF: [u8; 32] = [0u8; 32];
// Merkle tree heigth (or depth)
const TREE_HEIGHT: usize = 30;

// Setting up the types
type Bn254 = ark_bn254::Bn254;
type MixerR1CSProver_Bn254_30 = MixerR1CSProver<Bn254, TREE_HEIGHT>;

// Random leaf creating
let Leaf {
	secret_bytes,
	nullifier_bytes,
	leaf_bytes,
	nullifier_hash_bytes,
	..
} = MixerR1CSProver_Bn254_30::create_random_leaf(curve, rng)?

// Or in case you want to specify you own secret and nullifier
let Leaf {
	leaf_bytes,
	nullifier_hash_bytes,
	..
} = MixerR1CSProverBn254_30::create_leaf_with_privates(
	curve,
	secret_bytes,
	nullifier_bytes,
)?;

// Proof generation
let MixerProof {
	proof,
	..
} = MixerR1CSProver_Bn254_30::create_proof(
	curve,
	secret_bytes,
	nullifier_bytes,
	leaves,
	index,
	recipient_bytes,
	relayer_bytes,
	fee_value,
	refund_value,
	pk_bytes,
	DEFAULT_LEAF,
	rng,
)?;

锚点 - 生成叶承诺和零知识证明

use arkworks_native_gadgets::poseidon::Poseidon;
use arkworks_setups::{
	common::{
		setup_params,
		setup_tree_and_create_path,
		AnchorProof,
		Leaf,
	},
	r1cs::anchor::AnchorR1CSProver,
	AnchorProver, Curve,
};

// Setting up the constants
// Default leaf used in Merkle Tree
const DEFAULT_LEAF: [u8; 32] = [0u8; 32];
// Merkle tree depth (or height)
const TREE_DEPTH: usize = 30;
// Number of anchors (Merkle trees we are proving the membership in)
const ANCHOR_CT: usize = 2;

type Bn254 = ark_bn254::Bn254;
type AnchorR1CSProver_Bn254_30_2 = AnchorR1CSProver<
	Bn254,
	TREE_DEPTH,
	ANCHOR_CT
>;

// Creating a leaf
let Leaf {
	secret_bytes,
	nullifier_bytes,
	leaf_bytes,
	nullifier_hash_bytes,
	..
} = AnchorR1CSProver_Bn254_30_2::create_random_leaf(
	curve,
	chain_id,
	rng
)?;

// Or in case you want to specify you own secret and nullifier
let Leaf {
	leaf_bytes,
	nullifier_hash_bytes,
	..
} = AnchorR1CSProver_Bn254_30_2::create_leaf_with_privates(
	curve,
	chain_id,
	secret_bytes,
	nullifier_bytes,
)?;

// Creating the proof
let AnchorProof {
	proof,
	..
} = AnchorR1CSProver_Bn254_30_2::create_proof(
	curve,
	chain_id,
	secret_bytes,
	nullifier_bytes,
	leaves,
	index,
	roots_raw,
	recipient_bytes,
	relayer_bytes,
	fee_value,
	refund_value,
	commitment_bytes,
	pk_bytes,
	DEFAULT_LEAF,
	rng,
)?

虚拟锚点 - 生成Utxos和零知识证明

use arkworks_setups::{
	common::{
		prove_unchecked,
		setup_params,
		setup_tree_and_create_path
	},
	r1cs::vanchor::VAnchorR1CSProver,
	utxo::Utxo,
	Curve, VAnchorProver,
};

// Default leaf for the Merkle Tree
const DEFAULT_LEAF: [u8; 32] = [0u8; 32];
// Merkle tree depth (or heigth)
const TREE_DEPTH: usize = 30;
// Number of anchors (Merkle trees we are proving the membership in)
const ANCHOR_CT: usize = 2;
// Number of input transactions
const NUM_INS: usize = 2;
// Number of output transactions
const NUM_OUTS: usize = 2;

type Bn254 = ark_bn254::Bn254;

type VAnchorProver_Bn254_30_2x2 = VAnchorR1CSProver<
	Bn254,
	TREE_DEPTH,
	ANCHOR_CT,
	NUM_INS,
	NUM_OUTS
>;

// Input Utxo number 1
let in_utxo_1 = VAnchorProver_Bn254_30_2x2::create_random_utxo(
	curve,
	in_chain_id_1,
	in_amount_1,
	in_index_1,
	rng,
)?;

// Input Utxo number 2
let in_utxo_2 = VAnchorProver_Bn254_30_2x2::create_random_utxo(
	curve,
	in_chain_id_2,
	in_amount_2,
	in_index_2,
	rng,
)?;

// Output Utxo number 1
let out_utxo_1 = VAnchorProver_Bn254_30_2x2::create_random_utxo(
	curve,
	out_chain_id_1,
	out_amount_1,
	out_index_1,
	rng,
)?;

// Output Utxo number 2
let out_utxo_2 = VAnchorProver_Bn254_30_2x2::create_random_utxo(
	curve,
	out_chain_id_2,
	out_amount_2,
	out_index_2,
	rng,
)?;

// Making an array of Utxos
let in_utxos = [in_utxo_1, in_utxo_2];
let out_utxos = [out_utxo_1, out_utxo_2];

// Generating proof
let VAnchorProof {
	proof,
	..
} = VAnchorProver_Bn254_30_2x2::create_proof(
	curve,
	chain_id,
	public_amount,
	ext_data_hash,
	in_root_set,
	in_indices,
	in_leaves,
	in_utxos,
	out_utxos,
	pk_bytes,
	DEFAULT_LEAF,
	rng,
)?;

Merkle树 - 生成稀疏Merkle树和Merkle路径

// NOTE: This is optional and for tests only.
// There should be an on-chain mechanism for
// storing the roots of connected anchors,
// and way of fetching them before passing them
// into the circuits
let params3 = setup_params::<Bn254Fr>(curve, 5, 3);
let poseidon3 = Poseidon::new(params3);
let (tree, path) = setup_tree_and_create_path::<
	Bn254Fr,
	Poseidon<Bn254Fr>,
	TREE_DEPTH
>(
	&poseidon3,
	&leaves_f,
	index,
	&DEFAULT_LEAF,
)?;
let root = tree.root();
// or
let root = path.calculate_root(&leaf, &poseidon3)?

参数生成

用于Sage 脚本的参数。

在智能合约中的使用

在链上智能合约应用或类似应用中使用电路之前需要准备4件事情。

  1. 生成的证明和验证密钥。
  2. 将验证密钥存储在链上存储中。
  3. 链上Merkle树数据结构。
  4. 链上存储中使用的Nullifier哈希的数据结构。
  5. 用于长期存储包含叶承诺前像的加密笔记的功能。

一旦这些条件得到满足,我们就可以成功实现Mixer/Anchor/VAnchor应用程序。以混合器为例,事件发生的顺序如下

  1. 用户发送证明以及公共输入
    • Nullifier哈希
    • Merkle根
    • 任意数据
  2. 我们检查根是否与链上Merkle根相同。
  3. 我们使用链上验证密钥验证证明。
  4. 我们将Nullifier哈希注册为已使用,以防止双重花费攻击。

这些协议实现的示例

这些协议的转接服务链接

可信设置仪式示例链接

测试

  • 您可以通过运行以下命令来运行所有 arkworks/setups 测试:cargo test --features r1cs,plonk --release

  • 您可以通过指定要运行的测试名称来运行特定测试,命令如下:cargo test setup_and_prove_2_anchors --features r1cs,plonk --release

感谢

我们感谢arkworks社区对零知识基础设施开源第一方法的贡献。这里许多小工具都利用了其他仓库中的开源工具。特别是,我们从ivls项目中利用了稀疏Merkle树数据结构,该结构用于增量可验证计算。没有这些,这项工作将无法完成。

感谢以下人员在学习和实现这些小工具和电路方面的帮助和见解

依赖项

~2.6–3.5MB
~79K SLoC